* frame.el (msdos-mouse-p):
[emacs.git] / lisp / files.el
blob276366a796f269d7ef834847fa869e6dcef0e92a
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
34 (defvar font-lock-keywords)
37 (defgroup backup nil
38 "Backups of edited data files."
39 :group 'files)
41 (defgroup find-file nil
42 "Finding files."
43 :group 'files)
46 (defcustom delete-auto-save-files t
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
51 :type 'boolean
52 :group 'auto-save)
54 (defcustom directory-abbrev-alist
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 the name it is linked to."
69 :type '(repeat (cons :format "%v"
70 :value ("" . "")
71 (regexp :tag "From")
72 (regexp :tag "To")))
73 :group 'abbrev
74 :group 'find-file)
76 ;; Turn off backup files on VMS since it has version numbers.
77 (defcustom make-backup-files (not (eq system-type 'vax-vms))
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
95 :type 'boolean
96 :group 'backup)
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
100 (defvar backup-inhibited nil
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
103 But it is local only if you make it local.")
104 (put 'backup-inhibited 'permanent-local t)
106 (defcustom backup-by-copying nil
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
109 :type 'boolean
110 :group 'backup)
112 (defcustom backup-by-copying-when-linked nil
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
116 :type 'boolean
117 :group 'backup)
119 (defcustom backup-by-copying-when-mismatch nil
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
126 :type 'boolean
127 :group 'backup)
129 (defcustom backup-by-copying-when-privileged-mismatch 200
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
138 :type '(choice (const nil) integer)
139 :group 'backup)
141 (defvar backup-enable-predicate 'normal-backup-enable-predicate
142 "Predicate that looks at a file name and decides whether to make backups.
143 Called with an absolute file name as argument, it returns t to enable backup.")
145 (defcustom buffer-offer-save nil
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
149 :type 'boolean
150 :group 'backup)
151 (make-variable-buffer-local 'buffer-offer-save)
153 (defcustom find-file-existing-other-name t
154 "Non-nil means find a file under alternative names, in existing buffers.
155 This means if any existing buffer is visiting the file you want
156 under another name, you get the existing buffer instead of a new buffer."
157 :type 'boolean
158 :group 'find-file)
160 (defcustom find-file-visit-truename nil
161 "*Non-nil means visit a file under its truename.
162 The truename of a file is found by chasing all links
163 both at the file level and at the levels of the containing directories."
164 :type 'boolean
165 :group 'find-file)
166 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
168 (defcustom revert-without-query nil
169 "Specify which files should be reverted without query.
170 The value is a list of regular expressions.
171 If the file name matches one of these regular expressions,
172 then `revert-buffer' reverts the file without querying
173 if the file has changed on disk and you have not edited the buffer."
174 :type '(repeat regexp)
175 :group 'find-file)
177 (defvar buffer-file-number nil
178 "The device number and file number of the file visited in the current buffer.
179 The value is a list of the form (FILENUM DEVNUM).
180 This pair of numbers uniquely identifies the file.
181 If the buffer is visiting a new file, the value is nil.")
182 (make-variable-buffer-local 'buffer-file-number)
183 (put 'buffer-file-number 'permanent-local t)
185 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
186 "Non-nil means that `buffer-file-number' uniquely identifies files.")
188 (defvar buffer-file-read-only nil
189 "Non-nil if visited file was read-only when visited.")
190 (make-variable-buffer-local 'buffer-file-read-only)
192 (defcustom temporary-file-directory
193 (file-name-as-directory
194 (cond ((memq system-type '(ms-dos windows-nt))
195 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
196 ((memq system-type '(vax-vms axp-vms))
197 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
199 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
200 "The directory for writing temporary files."
201 :group 'files
202 :type 'directory)
204 (defcustom small-temporary-file-directory
205 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
206 "The directory for writing small temporary files.
207 If non-nil, this directory is used instead of `temporary-file-directory'
208 by programs that create small temporary files. This is for systems that
209 have fast storage with limited space, such as a RAM disk."
210 :group 'files
211 :type '(choice (const nil) directory))
213 ;; The system null device. (Should reference NULL_DEVICE from C.)
214 (defvar null-device "/dev/null" "The system null device.")
216 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
217 (declare-function dired-unmark "dired" (arg))
218 (declare-function dired-do-flagged-delete "dired" (&optional nomessage))
219 (declare-function dos-8+3-filename "dos-fns" (filename))
220 (declare-function vms-read-directory "vms-patch" (dirname switches buffer))
221 (declare-function view-mode-disable "view" ())
223 (defvar file-name-invalid-regexp
224 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
225 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
226 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
227 "[\000-\031]\\|" ; control characters
228 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
229 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
230 ((memq system-type '(ms-dos windows-nt cygwin))
231 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
232 "[|<>\"?*\000-\031]")) ; invalid characters
233 (t "[\000]"))
234 "Regexp recognizing file names which aren't allowed by the filesystem.")
236 (defcustom file-precious-flag nil
237 "Non-nil means protect against I/O errors while saving files.
238 Some modes set this non-nil in particular buffers.
240 This feature works by writing the new contents into a temporary file
241 and then renaming the temporary file to replace the original.
242 In this way, any I/O error in writing leaves the original untouched,
243 and there is never any instant where the file is nonexistent.
245 Note that this feature forces backups to be made by copying.
246 Yet, at the same time, saving a precious file
247 breaks any hard links between it and other files."
248 :type 'boolean
249 :group 'backup)
251 (defcustom version-control nil
252 "Control use of version numbers for backup files.
253 When t, make numeric backup versions unconditionally.
254 When nil, make them for files that have some already.
255 The value `never' means do not make them."
256 :type '(choice (const :tag "Never" never)
257 (const :tag "If existing" nil)
258 (other :tag "Always" t))
259 :group 'backup
260 :group 'vc)
261 (put 'version-control 'safe-local-variable
262 '(lambda (x) (or (booleanp x) (equal x 'never))))
264 (defcustom dired-kept-versions 2
265 "When cleaning directory, number of versions to keep."
266 :type 'integer
267 :group 'backup
268 :group 'dired)
270 (defcustom delete-old-versions nil
271 "If t, delete excess backup versions silently.
272 If nil, ask confirmation. Any other value prevents any trimming."
273 :type '(choice (const :tag "Delete" t)
274 (const :tag "Ask" nil)
275 (other :tag "Leave" other))
276 :group 'backup)
278 (defcustom kept-old-versions 2
279 "Number of oldest versions to keep when a new numbered backup is made."
280 :type 'integer
281 :group 'backup)
282 (put 'kept-old-versions 'safe-local-variable 'integerp)
284 (defcustom kept-new-versions 2
285 "Number of newest versions to keep when a new numbered backup is made.
286 Includes the new backup. Must be > 0"
287 :type 'integer
288 :group 'backup)
289 (put 'kept-new-versions 'safe-local-variable 'integerp)
291 (defcustom require-final-newline nil
292 "Whether to add a newline automatically at the end of the file.
294 A value of t means do this only when the file is about to be saved.
295 A value of `visit' means do this right after the file is visited.
296 A value of `visit-save' means do it at both of those times.
297 Any other non-nil value means ask user whether to add a newline, when saving.
298 A value of nil means don't add newlines.
300 Certain major modes set this locally to the value obtained
301 from `mode-require-final-newline'."
302 :type '(choice (const :tag "When visiting" visit)
303 (const :tag "When saving" t)
304 (const :tag "When visiting or saving" visit-save)
305 (const :tag "Don't add newlines" nil)
306 (other :tag "Ask each time" ask))
307 :group 'editing-basics)
309 (defcustom mode-require-final-newline t
310 "Whether to add a newline at end of file, in certain major modes.
311 Those modes set `require-final-newline' to this value when you enable them.
312 They do so because they are often used for files that are supposed
313 to end in newlines, and the question is how to arrange that.
315 A value of t means do this only when the file is about to be saved.
316 A value of `visit' means do this right after the file is visited.
317 A value of `visit-save' means do it at both of those times.
318 Any other non-nil value means ask user whether to add a newline, when saving.
320 A value of nil means do not add newlines. That is a risky choice in this
321 variable since this value is used for modes for files that ought to have
322 final newlines. So if you set this to nil, you must explicitly check and
323 add a final newline, whenever you save a file that really needs one."
324 :type '(choice (const :tag "When visiting" visit)
325 (const :tag "When saving" t)
326 (const :tag "When visiting or saving" visit-save)
327 (const :tag "Don't add newlines" nil)
328 (other :tag "Ask each time" ask))
329 :group 'editing-basics
330 :version "22.1")
332 (defcustom auto-save-default t
333 "Non-nil says by default do auto-saving of every file-visiting buffer."
334 :type 'boolean
335 :group 'auto-save)
337 (defcustom auto-save-visited-file-name nil
338 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
339 Normally auto-save files are written under other names."
340 :type 'boolean
341 :group 'auto-save)
343 (defcustom auto-save-file-name-transforms
344 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
345 ;; Don't put "\\2" inside expand-file-name, since it will be
346 ;; transformed to "/2" on DOS/Windows.
347 ,(concat temporary-file-directory "\\2") t))
348 "Transforms to apply to buffer file name before making auto-save file name.
349 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
350 REGEXP is a regular expression to match against the file name.
351 If it matches, `replace-match' is used to replace the
352 matching part with REPLACEMENT.
353 If the optional element UNIQUIFY is non-nil, the auto-save file name is
354 constructed by taking the directory part of the replaced file-name,
355 concatenated with the buffer file name with all directory separators
356 changed to `!' to prevent clashes. This will not work
357 correctly if your filesystem truncates the resulting name.
359 All the transforms in the list are tried, in the order they are listed.
360 When one transform applies, its result is final;
361 no further transforms are tried.
363 The default value is set up to put the auto-save file into the
364 temporary directory (see the variable `temporary-file-directory') for
365 editing a remote file.
367 On MS-DOS filesystems without long names this variable is always
368 ignored."
369 :group 'auto-save
370 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
371 (boolean :tag "Uniquify")))
372 :version "21.1")
374 (defcustom save-abbrevs t
375 "Non-nil means save word abbrevs too when files are saved.
376 If `silently', don't ask the user before saving."
377 :type '(choice (const t) (const nil) (const silently))
378 :group 'abbrev)
380 (defcustom find-file-run-dired t
381 "Non-nil means allow `find-file' to visit directories.
382 To visit the directory, `find-file' runs `find-directory-functions'."
383 :type 'boolean
384 :group 'find-file)
386 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
387 "List of functions to try in sequence to visit a directory.
388 Each function is called with the directory name as the sole argument
389 and should return either a buffer or nil."
390 :type '(hook :options (cvs-dired-noselect dired-noselect))
391 :group 'find-file)
393 ;;;It is not useful to make this a local variable.
394 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
395 (defvar find-file-not-found-functions nil
396 "List of functions to be called for `find-file' on nonexistent file.
397 These functions are called as soon as the error is detected.
398 Variable `buffer-file-name' is already set up.
399 The functions are called in the order given until one of them returns non-nil.")
400 (define-obsolete-variable-alias 'find-file-not-found-hooks
401 'find-file-not-found-functions "22.1")
403 ;;;It is not useful to make this a local variable.
404 ;;;(put 'find-file-hooks 'permanent-local t)
405 (defcustom find-file-hook nil
406 "List of functions to be called after a buffer is loaded from a file.
407 The buffer's local variables (if any) will have been processed before the
408 functions are called."
409 :group 'find-file
410 :type 'hook
411 :options '(auto-insert)
412 :version "22.1")
413 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
415 (defvar write-file-functions nil
416 "List of functions to be called before writing out a buffer to a file.
417 If one of them returns non-nil, the file is considered already written
418 and the rest are not called.
419 These hooks are considered to pertain to the visited file.
420 So any buffer-local binding of this variable is discarded if you change
421 the visited file name with \\[set-visited-file-name], but not when you
422 change the major mode.
424 This hook is not run if any of the functions in
425 `write-contents-functions' returns non-nil. Both hooks pertain
426 to how to save a buffer to file, for instance, choosing a suitable
427 coding system and setting mode bits. (See Info
428 node `(elisp)Saving Buffers'.) To perform various checks or
429 updates before the buffer is saved, use `before-save-hook'.")
430 (put 'write-file-functions 'permanent-local t)
431 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
433 (defvar local-write-file-hooks nil)
434 (make-variable-buffer-local 'local-write-file-hooks)
435 (put 'local-write-file-hooks 'permanent-local t)
436 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
438 (defvar write-contents-functions nil
439 "List of functions to be called before writing out a buffer to a file.
440 If one of them returns non-nil, the file is considered already written
441 and the rest are not called and neither are the functions in
442 `write-file-functions'.
444 This variable is meant to be used for hooks that pertain to the
445 buffer's contents, not to the particular visited file; thus,
446 `set-visited-file-name' does not clear this variable; but changing the
447 major mode does clear it.
449 For hooks that _do_ pertain to the particular visited file, use
450 `write-file-functions'. Both this variable and
451 `write-file-functions' relate to how a buffer is saved to file.
452 To perform various checks or updates before the buffer is saved,
453 use `before-save-hook'.")
454 (make-variable-buffer-local 'write-contents-functions)
455 (define-obsolete-variable-alias 'write-contents-hooks
456 'write-contents-functions "22.1")
458 (defcustom enable-local-variables t
459 "Control use of local variables in files you visit.
460 The value can be t, nil, :safe, :all, or something else.
462 A value of t means file local variables specifications are obeyed
463 if all the specified variable values are safe; if any values are
464 not safe, Emacs queries you, once, whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe.)
467 :safe means set the safe variables, and ignore the rest.
468 :all means set all variables, whether safe or not.
469 (Don't set it permanently to :all.)
470 A value of nil means always ignore the file local variables.
472 Any other value means always query you once whether to set them all.
473 \(When you say yes to certain values, they are remembered as safe, but
474 this has no effect when `enable-local-variables' is \"something else\".)
476 This variable also controls use of major modes specified in
477 a -*- line.
479 The command \\[normal-mode], when used interactively,
480 always obeys file local variable specifications and the -*- line,
481 and ignores this variable."
482 :type '(choice (const :tag "Query Unsafe" t)
483 (const :tag "Safe Only" :safe)
484 (const :tag "Do all" :all)
485 (const :tag "Ignore" nil)
486 (other :tag "Query" other))
487 :group 'find-file)
489 (defvar local-enable-local-variables t
490 "Like `enable-local-variables' but meant for buffer-local bindings.
491 The meaningful values are nil and non-nil. The default is non-nil.
492 If a major mode sets this to nil, buffer-locally, then any local
493 variables list in the file will be ignored.
495 This variable does not affect the use of major modes
496 specified in a -*- line.")
498 (defcustom enable-local-eval 'maybe
499 "Control processing of the \"variable\" `eval' in a file's local variables.
500 The value can be t, nil or something else.
501 A value of t means obey `eval' variables;
502 A value of nil means ignore them; anything else means query."
503 :type '(choice (const :tag "Obey" t)
504 (const :tag "Ignore" nil)
505 (other :tag "Query" other))
506 :group 'find-file)
508 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
509 (or (fboundp 'lock-buffer)
510 (defalias 'lock-buffer 'ignore))
511 (or (fboundp 'unlock-buffer)
512 (defalias 'unlock-buffer 'ignore))
513 (or (fboundp 'file-locked-p)
514 (defalias 'file-locked-p 'ignore))
516 (defcustom view-read-only nil
517 "Non-nil means buffers visiting files read-only do so in view mode.
518 In fact, this means that all read-only buffers normally have
519 View mode enabled, including buffers that are read-only because
520 you visit a file you cannot alter, and buffers you make read-only
521 using \\[toggle-read-only]."
522 :type 'boolean
523 :group 'view)
525 (defvar file-name-history nil
526 "History list of file names entered in the minibuffer.")
528 (put 'ange-ftp-completion-hook-function 'safe-magic t)
529 (defun ange-ftp-completion-hook-function (op &rest args)
530 "Provides support for ange-ftp host name completion.
531 Runs the usual ange-ftp hook, but only for completion operations."
532 ;; Having this here avoids the need to load ange-ftp when it's not
533 ;; really in use.
534 (if (memq op '(file-name-completion file-name-all-completions))
535 (apply 'ange-ftp-hook-function op args)
536 (let ((inhibit-file-name-handlers
537 (cons 'ange-ftp-completion-hook-function
538 (and (eq inhibit-file-name-operation op)
539 inhibit-file-name-handlers)))
540 (inhibit-file-name-operation op))
541 (apply op args))))
543 (defun convert-standard-filename (filename)
544 "Convert a standard file's name to something suitable for the OS.
545 This means to guarantee valid names and perhaps to canonicalize
546 certain patterns.
548 FILENAME should be an absolute file name since the conversion rules
549 sometimes vary depending on the position in the file name. E.g. c:/foo
550 is a valid DOS file name, but c:/bar/c:/foo is not.
552 This function's standard definition is trivial; it just returns
553 the argument. However, on Windows and DOS, replace invalid
554 characters. On DOS, make sure to obey the 8.3 limitations.
555 In the native Windows build, turn Cygwin names into native names,
556 and also turn slashes into backslashes if the shell requires it (see
557 `w32-shell-dos-semantics').
559 See Info node `(elisp)Standard File Names' for more details."
560 (if (eq system-type 'cygwin)
561 (let ((name (copy-sequence filename))
562 (start 0))
563 ;; Replace invalid filename characters with !
564 (while (string-match "[?*:<>|\"\000-\037]" name start)
565 (aset name (match-beginning 0) ?!)
566 (setq start (match-end 0)))
567 name)
568 filename))
570 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
571 "Read directory name, prompting with PROMPT and completing in directory DIR.
572 Value is not expanded---you must call `expand-file-name' yourself.
573 Default name to DEFAULT-DIRNAME if user exits with the same
574 non-empty string that was inserted by this function.
575 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
576 or just DIR if INITIAL is nil.)
577 If the user exits with an empty minibuffer, this function returns
578 an empty string. (This can only happen if the user erased the
579 pre-inserted contents or if `insert-default-directory' is nil.)
580 Fourth arg MUSTMATCH non-nil means require existing directory's name.
581 Non-nil and non-t means also require confirmation after completion.
582 Fifth arg INITIAL specifies text to start with.
583 DIR should be an absolute directory name. It defaults to
584 the value of `default-directory'."
585 (unless dir
586 (setq dir default-directory))
587 (read-file-name prompt dir (or default-dirname
588 (if initial (expand-file-name initial dir)
589 dir))
590 mustmatch initial
591 'file-directory-p))
594 (defun pwd ()
595 "Show the current default directory."
596 (interactive nil)
597 (message "Directory %s" default-directory))
599 (defvar cd-path nil
600 "Value of the CDPATH environment variable, as a list.
601 Not actually set up until the first time you use it.")
603 (defun parse-colon-path (cd-path)
604 "Explode a search path into a list of directory names.
605 Directories are separated by occurrences of `path-separator'
606 \(which is colon in GNU and GNU-like systems)."
607 ;; We could use split-string here.
608 (and cd-path
609 (let (cd-list (cd-start 0) cd-colon)
610 (setq cd-path (concat cd-path path-separator))
611 (while (setq cd-colon (string-match path-separator cd-path cd-start))
612 (setq cd-list
613 (nconc cd-list
614 (list (if (= cd-start cd-colon)
616 (substitute-in-file-name
617 (file-name-as-directory
618 (substring cd-path cd-start cd-colon)))))))
619 (setq cd-start (+ cd-colon 1)))
620 cd-list)))
622 (defun cd-absolute (dir)
623 "Change current directory to given absolute file name DIR."
624 ;; Put the name into directory syntax now,
625 ;; because otherwise expand-file-name may give some bad results.
626 (if (not (eq system-type 'vax-vms))
627 (setq dir (file-name-as-directory dir)))
628 (setq dir (abbreviate-file-name (expand-file-name dir)))
629 (if (not (file-directory-p dir))
630 (if (file-exists-p dir)
631 (error "%s is not a directory" dir)
632 (error "%s: no such directory" dir))
633 (if (file-executable-p dir)
634 (setq default-directory dir)
635 (error "Cannot cd to %s: Permission denied" dir))))
637 (defun cd (dir)
638 "Make DIR become the current buffer's default directory.
639 If your environment includes a `CDPATH' variable, try each one of
640 that list of directories (separated by occurrences of
641 `path-separator') when resolving a relative directory name.
642 The path separator is colon in GNU and GNU-like systems."
643 (interactive
644 (list (read-directory-name "Change default directory: "
645 default-directory default-directory
646 (and (member cd-path '(nil ("./")))
647 (null (getenv "CDPATH"))))))
648 (if (file-name-absolute-p dir)
649 (cd-absolute (expand-file-name dir))
650 (if (null cd-path)
651 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
652 (setq cd-path (or trypath (list "./")))))
653 (if (not (catch 'found
654 (mapc
655 (function (lambda (x)
656 (let ((f (expand-file-name (concat x dir))))
657 (if (file-directory-p f)
658 (progn
659 (cd-absolute f)
660 (throw 'found t))))))
661 cd-path)
662 nil))
663 (error "No such directory found via CDPATH environment variable"))))
665 (defun load-file (file)
666 "Load the Lisp file named FILE."
667 ;; This is a case where .elc makes a lot of sense.
668 (interactive (list (let ((completion-ignored-extensions
669 (remove ".elc" completion-ignored-extensions)))
670 (read-file-name "Load file: "))))
671 (load (expand-file-name file) nil nil t))
673 (defun locate-file (filename path &optional suffixes predicate)
674 "Search for FILENAME through PATH.
675 If found, return the absolute file name of FILENAME, with its suffixes;
676 otherwise return nil.
677 PATH should be a list of directories to look in, like the lists in
678 `exec-path' or `load-path'.
679 If SUFFIXES is non-nil, it should be a list of suffixes to append to
680 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
681 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
682 If non-nil, PREDICATE is used instead of `file-readable-p'.
683 PREDICATE can also be an integer to pass to the `access' system call,
684 in which case file-name handlers are ignored. This usage is deprecated.
686 For compatibility, PREDICATE can also be one of the symbols
687 `executable', `readable', `writable', or `exists', or a list of
688 one or more of those symbols."
689 (if (and predicate (symbolp predicate) (not (functionp predicate)))
690 (setq predicate (list predicate)))
691 (when (and (consp predicate) (not (functionp predicate)))
692 (setq predicate
693 (logior (if (memq 'executable predicate) 1 0)
694 (if (memq 'writable predicate) 2 0)
695 (if (memq 'readable predicate) 4 0))))
696 (locate-file-internal filename path suffixes predicate))
698 (defun locate-file-completion (string path-and-suffixes action)
699 "Do completion for file names passed to `locate-file'.
700 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
701 (if (file-name-absolute-p string)
702 (read-file-name-internal string nil action)
703 (let ((names nil)
704 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
705 (string-dir (file-name-directory string)))
706 (dolist (dir (car path-and-suffixes))
707 (unless dir
708 (setq dir default-directory))
709 (if string-dir (setq dir (expand-file-name string-dir dir)))
710 (when (file-directory-p dir)
711 (dolist (file (file-name-all-completions
712 (file-name-nondirectory string) dir))
713 (add-to-list 'names (if string-dir (concat string-dir file) file))
714 (when (string-match suffix file)
715 (setq file (substring file 0 (match-beginning 0)))
716 (push (if string-dir (concat string-dir file) file) names)))))
717 (cond
718 ((eq action t) (all-completions string names))
719 ((null action) (try-completion string names))
720 (t (test-completion string names))))))
722 (defun locate-dominating-file (file regexp)
723 "Look up the directory hierarchy from FILE for a file matching REGEXP."
724 (while (and file (not (file-directory-p file)))
725 (setq file (file-name-directory (directory-file-name file))))
726 (catch 'found
727 (let ((user (nth 2 (file-attributes file)))
728 ;; Abbreviate, so as to stop when we cross ~/.
729 (dir (abbreviate-file-name (file-name-as-directory file)))
730 files)
731 ;; As a heuristic, we stop looking up the hierarchy of directories as
732 ;; soon as we find a directory belonging to another user. This should
733 ;; save us from looking in things like /net and /afs. This assumes
734 ;; that all the files inside a project belong to the same user.
735 (while (and dir (equal user (nth 2 (file-attributes dir))))
736 (if (setq files (directory-files dir 'full regexp))
737 (throw 'found (car files))
738 (if (equal dir
739 (setq dir (file-name-directory
740 (directory-file-name dir))))
741 (setq dir nil))))
742 nil)))
744 (defun executable-find (command)
745 "Search for COMMAND in `exec-path' and return the absolute file name.
746 Return nil if COMMAND is not found anywhere in `exec-path'."
747 ;; Use 1 rather than file-executable-p to better match the behavior of
748 ;; call-process.
749 (locate-file command exec-path exec-suffixes 1))
751 (defun load-library (library)
752 "Load the library named LIBRARY.
753 This is an interface to the function `load'."
754 (interactive
755 (list (completing-read "Load library: "
756 'locate-file-completion
757 (cons load-path (get-load-suffixes)))))
758 (load library))
760 (defun file-remote-p (file &optional identification connected)
761 "Test whether FILE specifies a location on a remote system.
762 Return an identification of the system if the location is indeed
763 remote. The identification of the system may comprise a method
764 to access the system and its hostname, amongst other things.
766 For example, the filename \"/user@host:/foo\" specifies a location
767 on the system \"/user@host:\".
769 IDENTIFICATION specifies which part of the identification shall
770 be returned as string. IDENTIFICATION can be the symbol
771 `method', `user' or `host'; any other value is handled like nil
772 and means to return the complete identification string.
774 If CONNECTED is non-nil, the function returns an identification only
775 if FILE is located on a remote system, and a connection is established
776 to that remote system.
778 `file-remote-p' will never open a connection on its own."
779 (let ((handler (find-file-name-handler file 'file-remote-p)))
780 (if handler
781 (funcall handler 'file-remote-p file identification connected)
782 nil)))
784 (defun file-local-copy (file)
785 "Copy the file FILE into a temporary file on this machine.
786 Returns the name of the local copy, or nil, if FILE is directly
787 accessible."
788 ;; This formerly had an optional BUFFER argument that wasn't used by
789 ;; anything.
790 (let ((handler (find-file-name-handler file 'file-local-copy)))
791 (if handler
792 (funcall handler 'file-local-copy file)
793 nil)))
795 (defun file-truename (filename &optional counter prev-dirs)
796 "Return the truename of FILENAME, which should be absolute.
797 The truename of a file name is found by chasing symbolic links
798 both at the level of the file and at the level of the directories
799 containing it, until no links are left at any level.
801 \(fn FILENAME)" ;; Don't document the optional arguments.
802 ;; COUNTER and PREV-DIRS are only used in recursive calls.
803 ;; COUNTER can be a cons cell whose car is the count of how many
804 ;; more links to chase before getting an error.
805 ;; PREV-DIRS can be a cons cell whose car is an alist
806 ;; of truenames we've just recently computed.
807 (cond ((or (string= filename "") (string= filename "~"))
808 (setq filename (expand-file-name filename))
809 (if (string= filename "")
810 (setq filename "/")))
811 ((and (string= (substring filename 0 1) "~")
812 (string-match "~[^/]*/?" filename))
813 (let ((first-part
814 (substring filename 0 (match-end 0)))
815 (rest (substring filename (match-end 0))))
816 (setq filename (concat (expand-file-name first-part) rest)))))
818 (or counter (setq counter (list 100)))
819 (let (done
820 ;; For speed, remove the ange-ftp completion handler from the list.
821 ;; We know it's not needed here.
822 ;; For even more speed, do this only on the outermost call.
823 (file-name-handler-alist
824 (if prev-dirs file-name-handler-alist
825 (let ((tem (copy-sequence file-name-handler-alist)))
826 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
827 (or prev-dirs (setq prev-dirs (list nil)))
829 ;; andrewi@harlequin.co.uk - none of the following code (except for
830 ;; invoking the file-name handler) currently applies on Windows
831 ;; (ie. there are no native symlinks), but there is an issue with
832 ;; case differences being ignored by the OS, and short "8.3 DOS"
833 ;; name aliases existing for all files. (The short names are not
834 ;; reported by directory-files, but can be used to refer to files.)
835 ;; It seems appropriate for file-truename to resolve these issues in
836 ;; the most natural way, which on Windows is to call the function
837 ;; `w32-long-file-name' - this returns the exact name of a file as
838 ;; it is stored on disk (expanding short name aliases with the full
839 ;; name in the process).
840 (if (eq system-type 'windows-nt)
841 (let ((handler (find-file-name-handler filename 'file-truename)))
842 ;; For file name that has a special handler, call handler.
843 ;; This is so that ange-ftp can save time by doing a no-op.
844 (if handler
845 (setq filename (funcall handler 'file-truename filename))
846 ;; If filename contains a wildcard, newname will be the old name.
847 (unless (string-match "[[*?]" filename)
848 ;; If filename exists, use the long name
849 (setq filename (or (w32-long-file-name filename) filename))))
850 (setq done t)))
852 ;; If this file directly leads to a link, process that iteratively
853 ;; so that we don't use lots of stack.
854 (while (not done)
855 (setcar counter (1- (car counter)))
856 (if (< (car counter) 0)
857 (error "Apparent cycle of symbolic links for %s" filename))
858 (let ((handler (find-file-name-handler filename 'file-truename)))
859 ;; For file name that has a special handler, call handler.
860 ;; This is so that ange-ftp can save time by doing a no-op.
861 (if handler
862 (setq filename (funcall handler 'file-truename filename)
863 done t)
864 (let ((dir (or (file-name-directory filename) default-directory))
865 target dirfile)
866 ;; Get the truename of the directory.
867 (setq dirfile (directory-file-name dir))
868 ;; If these are equal, we have the (or a) root directory.
869 (or (string= dir dirfile)
870 ;; If this is the same dir we last got the truename for,
871 ;; save time--don't recalculate.
872 (if (assoc dir (car prev-dirs))
873 (setq dir (cdr (assoc dir (car prev-dirs))))
874 (let ((old dir)
875 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
876 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
877 (setq dir new))))
878 (if (equal ".." (file-name-nondirectory filename))
879 (setq filename
880 (directory-file-name (file-name-directory (directory-file-name dir)))
881 done t)
882 (if (equal "." (file-name-nondirectory filename))
883 (setq filename (directory-file-name dir)
884 done t)
885 ;; Put it back on the file name.
886 (setq filename (concat dir (file-name-nondirectory filename)))
887 ;; Is the file name the name of a link?
888 (setq target (file-symlink-p filename))
889 (if target
890 ;; Yes => chase that link, then start all over
891 ;; since the link may point to a directory name that uses links.
892 ;; We can't safely use expand-file-name here
893 ;; since target might look like foo/../bar where foo
894 ;; is itself a link. Instead, we handle . and .. above.
895 (setq filename
896 (if (file-name-absolute-p target)
897 target
898 (concat dir target))
899 done nil)
900 ;; No, we are done!
901 (setq done t))))))))
902 filename))
904 (defun file-chase-links (filename &optional limit)
905 "Chase links in FILENAME until a name that is not a link.
906 Unlike `file-truename', this does not check whether a parent
907 directory name is a symbolic link.
908 If the optional argument LIMIT is a number,
909 it means chase no more than that many links and then stop."
910 (let (tem (newname filename)
911 (count 0))
912 (while (and (or (null limit) (< count limit))
913 (setq tem (file-symlink-p newname)))
914 (save-match-data
915 (if (and (null limit) (= count 100))
916 (error "Apparent cycle of symbolic links for %s" filename))
917 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
918 (while (string-match "//+" tem)
919 (setq tem (replace-match "/" nil nil tem)))
920 ;; Handle `..' by hand, since it needs to work in the
921 ;; target of any directory symlink.
922 ;; This code is not quite complete; it does not handle
923 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
924 (while (string-match "\\`\\.\\./" tem)
925 (setq tem (substring tem 3))
926 (setq newname (expand-file-name newname))
927 ;; Chase links in the default dir of the symlink.
928 (setq newname
929 (file-chase-links
930 (directory-file-name (file-name-directory newname))))
931 ;; Now find the parent of that dir.
932 (setq newname (file-name-directory newname)))
933 (setq newname (expand-file-name tem (file-name-directory newname)))
934 (setq count (1+ count))))
935 newname))
937 (defun make-temp-file (prefix &optional dir-flag suffix)
938 "Create a temporary file.
939 The returned file name (created by appending some random characters at the end
940 of PREFIX, and expanding against `temporary-file-directory' if necessary),
941 is guaranteed to point to a newly created empty file.
942 You can then use `write-region' to write new data into the file.
944 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
946 If SUFFIX is non-nil, add that at the end of the file name."
947 (let ((umask (default-file-modes))
948 file)
949 (unwind-protect
950 (progn
951 ;; Create temp files with strict access rights. It's easy to
952 ;; loosen them later, whereas it's impossible to close the
953 ;; time-window of loose permissions otherwise.
954 (set-default-file-modes ?\700)
955 (while (condition-case ()
956 (progn
957 (setq file
958 (make-temp-name
959 (expand-file-name prefix temporary-file-directory)))
960 (if suffix
961 (setq file (concat file suffix)))
962 (if dir-flag
963 (make-directory file)
964 (write-region "" nil file nil 'silent nil 'excl))
965 nil)
966 (file-already-exists t))
967 ;; the file was somehow created by someone else between
968 ;; `make-temp-name' and `write-region', let's try again.
969 nil)
970 file)
971 ;; Reset the umask.
972 (set-default-file-modes umask))))
974 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
975 "Change the encoding of FILE's name from CODING to NEW-CODING.
976 The value is a new name of FILE.
977 Signals a `file-already-exists' error if a file of the new name
978 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
979 is non-nil. A number as fourth arg means request confirmation if
980 the new name already exists. This is what happens in interactive
981 use with M-x."
982 (interactive
983 (let ((default-coding (or file-name-coding-system
984 default-file-name-coding-system))
985 (filename (read-file-name "Recode filename: " nil nil t))
986 from-coding to-coding)
987 (if (and default-coding
988 ;; We provide the default coding only when it seems that
989 ;; the filename is correctly decoded by the default
990 ;; coding.
991 (let ((charsets (find-charset-string filename)))
992 (and (not (memq 'eight-bit-control charsets))
993 (not (memq 'eight-bit-graphic charsets)))))
994 (setq from-coding (read-coding-system
995 (format "Recode filename %s from (default %s): "
996 filename default-coding)
997 default-coding))
998 (setq from-coding (read-coding-system
999 (format "Recode filename %s from: " filename))))
1001 ;; We provide the default coding only when a user is going to
1002 ;; change the encoding not from the default coding.
1003 (if (eq from-coding default-coding)
1004 (setq to-coding (read-coding-system
1005 (format "Recode filename %s from %s to: "
1006 filename from-coding)))
1007 (setq to-coding (read-coding-system
1008 (format "Recode filename %s from %s to (default %s): "
1009 filename from-coding default-coding)
1010 default-coding)))
1011 (list filename from-coding to-coding)))
1013 (let* ((default-coding (or file-name-coding-system
1014 default-file-name-coding-system))
1015 ;; FILE should have been decoded by DEFAULT-CODING.
1016 (encoded (encode-coding-string file default-coding))
1017 (newname (decode-coding-string encoded coding))
1018 (new-encoded (encode-coding-string newname new-coding))
1019 ;; Suppress further encoding.
1020 (file-name-coding-system nil)
1021 (default-file-name-coding-system nil)
1022 (locale-coding-system nil))
1023 (rename-file encoded new-encoded ok-if-already-exists)
1024 newname))
1026 (defun switch-to-buffer-other-window (buffer &optional norecord)
1027 "Select buffer BUFFER in another window.
1028 If BUFFER does not identify an existing buffer, then this function
1029 creates a buffer with that name.
1031 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1032 or nil. If BUFFER is nil, then this function chooses a buffer
1033 using `other-buffer'.
1034 Optional second arg NORECORD non-nil means
1035 do not put this buffer at the front of the list of recently selected ones.
1036 This function returns the buffer it switched to.
1038 This uses the function `display-buffer' as a subroutine; see its
1039 documentation for additional customization information."
1040 (interactive "BSwitch to buffer in other window: ")
1041 (let ((pop-up-windows t)
1042 ;; Don't let these interfere.
1043 same-window-buffer-names same-window-regexps)
1044 (pop-to-buffer buffer t norecord)))
1046 (defun switch-to-buffer-other-frame (buffer &optional norecord)
1047 "Switch to buffer BUFFER in another frame.
1048 Optional second arg NORECORD non-nil means
1049 do not put this buffer at the front of the list of recently selected ones.
1051 This uses the function `display-buffer' as a subroutine; see its
1052 documentation for additional customization information."
1053 (interactive "BSwitch to buffer in other frame: ")
1054 (let ((pop-up-frames t)
1055 same-window-buffer-names same-window-regexps)
1056 (pop-to-buffer buffer t norecord)
1057 (raise-frame (window-frame (selected-window)))))
1059 (defun display-buffer-other-frame (buffer)
1060 "Switch to buffer BUFFER in another frame.
1061 This uses the function `display-buffer' as a subroutine; see its
1062 documentation for additional customization information."
1063 (interactive "BDisplay buffer in other frame: ")
1064 (let ((pop-up-frames t)
1065 same-window-buffer-names same-window-regexps
1066 (old-window (selected-window))
1067 new-window)
1068 (setq new-window (display-buffer buffer t))
1069 (lower-frame (window-frame new-window))
1070 (make-frame-invisible (window-frame old-window))
1071 (make-frame-visible (window-frame old-window))))
1073 (defvar find-file-default nil
1074 "Used within `find-file-read-args'.")
1076 (defmacro minibuffer-with-setup-hook (fun &rest body)
1077 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1078 BODY should use the minibuffer at most once.
1079 Recursive uses of the minibuffer will not be affected."
1080 (declare (indent 1) (debug t))
1081 (let ((hook (make-symbol "setup-hook")))
1082 `(let (,hook)
1083 (setq ,hook
1084 (lambda ()
1085 ;; Clear out this hook so it does not interfere
1086 ;; with any recursive minibuffer usage.
1087 (remove-hook 'minibuffer-setup-hook ,hook)
1088 (,fun)))
1089 (unwind-protect
1090 (progn
1091 (add-hook 'minibuffer-setup-hook ,hook)
1092 ,@body)
1093 (remove-hook 'minibuffer-setup-hook ,hook)))))
1095 (defcustom find-file-confirm-nonexistent-file nil
1096 "If non-nil, `find-file' requires confirmation before visiting a new file."
1097 :group 'find-file
1098 :version "23.1"
1099 :type 'boolean)
1101 (defun find-file-read-args (prompt mustmatch)
1102 (list (let ((find-file-default
1103 (and buffer-file-name
1104 (abbreviate-file-name buffer-file-name))))
1105 (minibuffer-with-setup-hook
1106 (lambda () (setq minibuffer-default find-file-default))
1107 (read-file-name prompt nil default-directory mustmatch)))
1110 (defun find-file (filename &optional wildcards)
1111 "Edit file FILENAME.
1112 Switch to a buffer visiting file FILENAME,
1113 creating one if none already exists.
1114 Interactively, the default if you just type RET is the current directory,
1115 but the visited file name is available through the minibuffer history:
1116 type M-n to pull it into the minibuffer.
1118 You can visit files on remote machines by specifying something
1119 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1120 also visit local files as a different user by specifying
1121 /sudo::FILE for the file name.
1122 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1123 manual, for more about this.
1125 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1126 expand wildcards (if any) and visit multiple files. You can
1127 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1129 To visit a file without any kind of conversion and without
1130 automatically choosing a major mode, use \\[find-file-literally]."
1131 (interactive
1132 (find-file-read-args "Find file: "
1133 (if find-file-confirm-nonexistent-file 'confirm-only)))
1134 (let ((value (find-file-noselect filename nil nil wildcards)))
1135 (if (listp value)
1136 (mapcar 'switch-to-buffer (nreverse value))
1137 (switch-to-buffer value))))
1139 (defun find-file-other-window (filename &optional wildcards)
1140 "Edit file FILENAME, in another window.
1142 Like \\[find-file] (which see), but creates a new window or reuses
1143 an existing one. See the function `display-buffer'.
1145 Interactively, the default if you just type RET is the current directory,
1146 but the visited file name is available through the minibuffer history:
1147 type M-n to pull it into the minibuffer.
1149 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1150 expand wildcards (if any) and visit multiple files."
1151 (interactive
1152 (find-file-read-args "Find file in other window: "
1153 (if find-file-confirm-nonexistent-file 'confirm-only)))
1154 (let ((value (find-file-noselect filename nil nil wildcards)))
1155 (if (listp value)
1156 (progn
1157 (setq value (nreverse value))
1158 (cons (switch-to-buffer-other-window (car value))
1159 (mapcar 'switch-to-buffer (cdr value))))
1160 (switch-to-buffer-other-window value))))
1162 (defun find-file-other-frame (filename &optional wildcards)
1163 "Edit file FILENAME, in another frame.
1165 Like \\[find-file] (which see), but creates a new frame or reuses
1166 an existing one. See the function `display-buffer'.
1168 Interactively, the default if you just type RET is the current directory,
1169 but the visited file name is available through the minibuffer history:
1170 type M-n to pull it into the minibuffer.
1172 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1173 expand wildcards (if any) and visit multiple files."
1174 (interactive
1175 (find-file-read-args "Find file in other frame: "
1176 (if find-file-confirm-nonexistent-file 'confirm-only)))
1177 (let ((value (find-file-noselect filename nil nil wildcards)))
1178 (if (listp value)
1179 (progn
1180 (setq value (nreverse value))
1181 (cons (switch-to-buffer-other-frame (car value))
1182 (mapcar 'switch-to-buffer (cdr value))))
1183 (switch-to-buffer-other-frame value))))
1185 (defun find-file-existing (filename)
1186 "Edit the existing file FILENAME.
1187 Like \\[find-file], but only allow a file that exists, and do not allow
1188 file names with wildcards."
1189 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1190 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1191 (error "%s does not exist" filename)
1192 (find-file filename)
1193 (current-buffer)))
1195 (defun find-file-read-only (filename &optional wildcards)
1196 "Edit file FILENAME but don't allow changes.
1197 Like \\[find-file], but marks buffer as read-only.
1198 Use \\[toggle-read-only] to permit editing."
1199 (interactive
1200 (find-file-read-args "Find file read-only: "
1201 (if find-file-confirm-nonexistent-file 'confirm-only)))
1202 (unless (or (and wildcards find-file-wildcards
1203 (not (string-match "\\`/:" filename))
1204 (string-match "[[*?]" filename))
1205 (file-exists-p filename))
1206 (error "%s does not exist" filename))
1207 (let ((value (find-file filename wildcards)))
1208 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1209 (if (listp value) value (list value)))
1210 value))
1212 (defun find-file-read-only-other-window (filename &optional wildcards)
1213 "Edit file FILENAME in another window but don't allow changes.
1214 Like \\[find-file-other-window], but marks buffer as read-only.
1215 Use \\[toggle-read-only] to permit editing."
1216 (interactive
1217 (find-file-read-args "Find file read-only other window: "
1218 (if find-file-confirm-nonexistent-file 'confirm-only)))
1219 (unless (or (and wildcards find-file-wildcards
1220 (not (string-match "\\`/:" filename))
1221 (string-match "[[*?]" filename))
1222 (file-exists-p filename))
1223 (error "%s does not exist" filename))
1224 (let ((value (find-file-other-window filename wildcards)))
1225 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1226 (if (listp value) value (list value)))
1227 value))
1229 (defun find-file-read-only-other-frame (filename &optional wildcards)
1230 "Edit file FILENAME in another frame but don't allow changes.
1231 Like \\[find-file-other-frame], but marks buffer as read-only.
1232 Use \\[toggle-read-only] to permit editing."
1233 (interactive
1234 (find-file-read-args "Find file read-only other frame: "
1235 (if find-file-confirm-nonexistent-file 'confirm-only)))
1236 (unless (or (and wildcards find-file-wildcards
1237 (not (string-match "\\`/:" filename))
1238 (string-match "[[*?]" filename))
1239 (file-exists-p filename))
1240 (error "%s does not exist" filename))
1241 (let ((value (find-file-other-frame filename wildcards)))
1242 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1243 (if (listp value) value (list value)))
1244 value))
1246 (defun find-alternate-file-other-window (filename &optional wildcards)
1247 "Find file FILENAME as a replacement for the file in the next window.
1248 This command does not select that window.
1250 See \\[find-file] for the possible forms of the FILENAME argument.
1252 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1253 expand wildcards (if any) and replace the file with multiple files."
1254 (interactive
1255 (save-selected-window
1256 (other-window 1)
1257 (let ((file buffer-file-name)
1258 (file-name nil)
1259 (file-dir nil))
1260 (and file
1261 (setq file-name (file-name-nondirectory file)
1262 file-dir (file-name-directory file)))
1263 (list (read-file-name
1264 "Find alternate file: " file-dir nil nil file-name)
1265 t))))
1266 (if (one-window-p)
1267 (find-file-other-window filename wildcards)
1268 (save-selected-window
1269 (other-window 1)
1270 (find-alternate-file filename wildcards))))
1272 (defun find-alternate-file (filename &optional wildcards)
1273 "Find file FILENAME, select its buffer, kill previous buffer.
1274 If the current buffer now contains an empty file that you just visited
1275 \(presumably by mistake), use this command to visit the file you really want.
1277 See \\[find-file] for the possible forms of the FILENAME argument.
1279 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1280 expand wildcards (if any) and replace the file with multiple files.
1282 If the current buffer is an indirect buffer, or the base buffer
1283 for one or more indirect buffers, the other buffer(s) are not
1284 killed."
1285 (interactive
1286 (let ((file buffer-file-name)
1287 (file-name nil)
1288 (file-dir nil))
1289 (and file
1290 (setq file-name (file-name-nondirectory file)
1291 file-dir (file-name-directory file)))
1292 (list (read-file-name
1293 "Find alternate file: " file-dir nil nil file-name)
1294 t)))
1295 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1296 (error "Aborted"))
1297 (when (and (buffer-modified-p) (buffer-file-name))
1298 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1299 (buffer-name)))
1300 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1301 (error "Aborted"))
1302 (save-buffer)))
1303 (let ((obuf (current-buffer))
1304 (ofile buffer-file-name)
1305 (onum buffer-file-number)
1306 (odir dired-directory)
1307 (otrue buffer-file-truename)
1308 (oname (buffer-name)))
1309 (if (get-buffer " **lose**")
1310 (kill-buffer " **lose**"))
1311 (rename-buffer " **lose**")
1312 (unwind-protect
1313 (progn
1314 (unlock-buffer)
1315 ;; This prevents us from finding the same buffer
1316 ;; if we specified the same file again.
1317 (setq buffer-file-name nil)
1318 (setq buffer-file-number nil)
1319 (setq buffer-file-truename nil)
1320 ;; Likewise for dired buffers.
1321 (setq dired-directory nil)
1322 (find-file filename wildcards))
1323 (when (eq obuf (current-buffer))
1324 ;; This executes if find-file gets an error
1325 ;; and does not really find anything.
1326 ;; We put things back as they were.
1327 ;; If find-file actually finds something, we kill obuf below.
1328 (setq buffer-file-name ofile)
1329 (setq buffer-file-number onum)
1330 (setq buffer-file-truename otrue)
1331 (setq dired-directory odir)
1332 (lock-buffer)
1333 (rename-buffer oname)))
1334 (unless (eq (current-buffer) obuf)
1335 (with-current-buffer obuf
1336 ;; We already asked; don't ask again.
1337 (let ((kill-buffer-query-functions))
1338 (kill-buffer obuf))))))
1340 (defun create-file-buffer (filename)
1341 "Create a suitably named buffer for visiting FILENAME, and return it.
1342 FILENAME (sans directory) is used unchanged if that name is free;
1343 otherwise a string <2> or <3> or ... is appended to get an unused name.
1344 Spaces at the start of FILENAME (sans directory) are removed."
1345 (let ((lastname (file-name-nondirectory filename)))
1346 (if (string= lastname "")
1347 (setq lastname filename))
1348 (save-match-data
1349 (string-match "^ *\\(.*\\)" lastname)
1350 (generate-new-buffer (match-string 1 lastname)))))
1352 (defun generate-new-buffer (name)
1353 "Create and return a buffer with a name based on NAME.
1354 Choose the buffer's name using `generate-new-buffer-name'."
1355 (get-buffer-create (generate-new-buffer-name name)))
1357 (defcustom automount-dir-prefix "^/tmp_mnt/"
1358 "Regexp to match the automounter prefix in a directory name."
1359 :group 'files
1360 :type 'regexp)
1362 (defvar abbreviated-home-dir nil
1363 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1365 (defun abbreviate-file-name (filename)
1366 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1367 This also substitutes \"~\" for the user's home directory (unless the
1368 home directory is a root directory) and removes automounter prefixes
1369 \(see the variable `automount-dir-prefix')."
1370 ;; Get rid of the prefixes added by the automounter.
1371 (save-match-data
1372 (if (and automount-dir-prefix
1373 (string-match automount-dir-prefix filename)
1374 (file-exists-p (file-name-directory
1375 (substring filename (1- (match-end 0))))))
1376 (setq filename (substring filename (1- (match-end 0)))))
1377 (let ((tail directory-abbrev-alist))
1378 ;; If any elt of directory-abbrev-alist matches this name,
1379 ;; abbreviate accordingly.
1380 (while tail
1381 (if (string-match (car (car tail)) filename)
1382 (setq filename
1383 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1384 (setq tail (cdr tail)))
1385 ;; Compute and save the abbreviated homedir name.
1386 ;; We defer computing this until the first time it's needed, to
1387 ;; give time for directory-abbrev-alist to be set properly.
1388 ;; We include a slash at the end, to avoid spurious matches
1389 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1390 (or abbreviated-home-dir
1391 (setq abbreviated-home-dir
1392 (let ((abbreviated-home-dir "$foo"))
1393 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1394 "\\(/\\|\\'\\)"))))
1396 ;; If FILENAME starts with the abbreviated homedir,
1397 ;; make it start with `~' instead.
1398 (if (and (string-match abbreviated-home-dir filename)
1399 ;; If the home dir is just /, don't change it.
1400 (not (and (= (match-end 0) 1)
1401 (= (aref filename 0) ?/)))
1402 ;; MS-DOS root directories can come with a drive letter;
1403 ;; Novell Netware allows drive letters beyond `Z:'.
1404 (not (and (or (eq system-type 'ms-dos)
1405 (eq system-type 'cygwin)
1406 (eq system-type 'windows-nt))
1407 (save-match-data
1408 (string-match "^[a-zA-`]:/$" filename)))))
1409 (setq filename
1410 (concat "~"
1411 (match-string 1 filename)
1412 (substring filename (match-end 0)))))
1413 filename)))
1415 (defcustom find-file-not-true-dirname-list nil
1416 "List of logical names for which visiting shouldn't save the true dirname.
1417 On VMS, when you visit a file using a logical name that searches a path,
1418 you may or may not want the visited file name to record the specific
1419 directory where the file was found. If you *do not* want that, add the logical
1420 name to this list as a string."
1421 :type '(repeat (string :tag "Name"))
1422 :group 'find-file)
1424 (defun find-buffer-visiting (filename &optional predicate)
1425 "Return the buffer visiting file FILENAME (a string).
1426 This is like `get-file-buffer', except that it checks for any buffer
1427 visiting the same file, possibly under a different name.
1428 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1429 and others are ignored.
1430 If there is no such live buffer, return nil."
1431 (let ((predicate (or predicate #'identity))
1432 (truename (abbreviate-file-name (file-truename filename))))
1433 (or (let ((buf (get-file-buffer filename)))
1434 (when (and buf (funcall predicate buf)) buf))
1435 (let ((list (buffer-list)) found)
1436 (while (and (not found) list)
1437 (save-excursion
1438 (set-buffer (car list))
1439 (if (and buffer-file-name
1440 (string= buffer-file-truename truename)
1441 (funcall predicate (current-buffer)))
1442 (setq found (car list))))
1443 (setq list (cdr list)))
1444 found)
1445 (let* ((attributes (file-attributes truename))
1446 (number (nthcdr 10 attributes))
1447 (list (buffer-list)) found)
1448 (and buffer-file-numbers-unique
1449 (car-safe number) ;Make sure the inode is not just nil.
1450 (while (and (not found) list)
1451 (with-current-buffer (car list)
1452 (if (and buffer-file-name
1453 (equal buffer-file-number number)
1454 ;; Verify this buffer's file number
1455 ;; still belongs to its file.
1456 (file-exists-p buffer-file-name)
1457 (equal (file-attributes buffer-file-truename)
1458 attributes)
1459 (funcall predicate (current-buffer)))
1460 (setq found (car list))))
1461 (setq list (cdr list))))
1462 found))))
1464 (defcustom find-file-wildcards t
1465 "Non-nil means file-visiting commands should handle wildcards.
1466 For example, if you specify `*.c', that would visit all the files
1467 whose names match the pattern."
1468 :group 'files
1469 :version "20.4"
1470 :type 'boolean)
1472 (defcustom find-file-suppress-same-file-warnings nil
1473 "Non-nil means suppress warning messages for symlinked files.
1474 When nil, Emacs prints a warning when visiting a file that is already
1475 visited, but with a different name. Setting this option to t
1476 suppresses this warning."
1477 :group 'files
1478 :version "21.1"
1479 :type 'boolean)
1481 (defcustom large-file-warning-threshold 10000000
1482 "Maximum size of file above which a confirmation is requested.
1483 When nil, never request confirmation."
1484 :group 'files
1485 :group 'find-file
1486 :version "22.1"
1487 :type '(choice integer (const :tag "Never request confirmation" nil)))
1489 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1490 "Read file FILENAME into a buffer and return the buffer.
1491 If a buffer exists visiting FILENAME, return that one, but
1492 verify that the file has not changed since visited or saved.
1493 The buffer is not selected, just returned to the caller.
1494 Optional second arg NOWARN non-nil means suppress any warning messages.
1495 Optional third arg RAWFILE non-nil means the file is read literally.
1496 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1497 and visit all the matching files. When wildcards are actually
1498 used and expanded, return a list of buffers that are visiting
1499 the various files."
1500 (setq filename
1501 (abbreviate-file-name
1502 (expand-file-name filename)))
1503 (if (file-directory-p filename)
1504 (or (and find-file-run-dired
1505 (run-hook-with-args-until-success
1506 'find-directory-functions
1507 (if find-file-visit-truename
1508 (abbreviate-file-name (file-truename filename))
1509 filename)))
1510 (error "%s is a directory" filename))
1511 (if (and wildcards
1512 find-file-wildcards
1513 (not (string-match "\\`/:" filename))
1514 (string-match "[[*?]" filename))
1515 (let ((files (condition-case nil
1516 (file-expand-wildcards filename t)
1517 (error (list filename))))
1518 (find-file-wildcards nil))
1519 (if (null files)
1520 (find-file-noselect filename)
1521 (mapcar #'find-file-noselect files)))
1522 (let* ((buf (get-file-buffer filename))
1523 (truename (abbreviate-file-name (file-truename filename)))
1524 (attributes (file-attributes truename))
1525 (number (nthcdr 10 attributes))
1526 ;; Find any buffer for a file which has same truename.
1527 (other (and (not buf) (find-buffer-visiting filename))))
1528 ;; Let user know if there is a buffer with the same truename.
1529 (if other
1530 (progn
1531 (or nowarn
1532 find-file-suppress-same-file-warnings
1533 (string-equal filename (buffer-file-name other))
1534 (message "%s and %s are the same file"
1535 filename (buffer-file-name other)))
1536 ;; Optionally also find that buffer.
1537 (if (or find-file-existing-other-name find-file-visit-truename)
1538 (setq buf other))))
1539 ;; Check to see if the file looks uncommonly large.
1540 (when (and large-file-warning-threshold (nth 7 attributes)
1541 ;; Don't ask again if we already have the file or
1542 ;; if we're asked to be quiet.
1543 (not (or buf nowarn))
1544 (> (nth 7 attributes) large-file-warning-threshold)
1545 (not (y-or-n-p
1546 (format "File %s is large (%dMB), really open? "
1547 (file-name-nondirectory filename)
1548 (/ (nth 7 attributes) 1048576)))))
1549 (error "Aborted"))
1550 (if buf
1551 ;; We are using an existing buffer.
1552 (let (nonexistent)
1553 (or nowarn
1554 (verify-visited-file-modtime buf)
1555 (cond ((not (file-exists-p filename))
1556 (setq nonexistent t)
1557 (message "File %s no longer exists!" filename))
1558 ;; Certain files should be reverted automatically
1559 ;; if they have changed on disk and not in the buffer.
1560 ((and (not (buffer-modified-p buf))
1561 (let ((tail revert-without-query)
1562 (found nil))
1563 (while tail
1564 (if (string-match (car tail) filename)
1565 (setq found t))
1566 (setq tail (cdr tail)))
1567 found))
1568 (with-current-buffer buf
1569 (message "Reverting file %s..." filename)
1570 (revert-buffer t t)
1571 (message "Reverting file %s...done" filename)))
1572 ((yes-or-no-p
1573 (if (string= (file-name-nondirectory filename)
1574 (buffer-name buf))
1575 (format
1576 (if (buffer-modified-p buf)
1577 "File %s changed on disk. Discard your edits? "
1578 "File %s changed on disk. Reread from disk? ")
1579 (file-name-nondirectory filename))
1580 (format
1581 (if (buffer-modified-p buf)
1582 "File %s changed on disk. Discard your edits in %s? "
1583 "File %s changed on disk. Reread from disk into %s? ")
1584 (file-name-nondirectory filename)
1585 (buffer-name buf))))
1586 (with-current-buffer buf
1587 (revert-buffer t t)))))
1588 (with-current-buffer buf
1590 ;; Check if a formerly read-only file has become
1591 ;; writable and vice versa, but if the buffer agrees
1592 ;; with the new state of the file, that is ok too.
1593 (let ((read-only (not (file-writable-p buffer-file-name))))
1594 (unless (or nonexistent
1595 (eq read-only buffer-file-read-only)
1596 (eq read-only buffer-read-only))
1597 (when (or nowarn
1598 (let ((question
1599 (format "File %s is %s on disk. Change buffer mode? "
1600 buffer-file-name
1601 (if read-only "read-only" "writable"))))
1602 (y-or-n-p question)))
1603 (setq buffer-read-only read-only)))
1604 (setq buffer-file-read-only read-only))
1606 (when (and (not (eq (not (null rawfile))
1607 (not (null find-file-literally))))
1608 (not nonexistent)
1609 ;; It is confusing to ask whether to visit
1610 ;; non-literally if they have the file in
1611 ;; hexl-mode.
1612 (not (eq major-mode 'hexl-mode)))
1613 (if (buffer-modified-p)
1614 (if (y-or-n-p
1615 (format
1616 (if rawfile
1617 "The file %s is already visited normally,
1618 and you have edited the buffer. Now you have asked to visit it literally,
1619 meaning no coding system handling, format conversion, or local variables.
1620 Emacs can only visit a file in one way at a time.
1622 Do you want to save the file, and visit it literally instead? "
1623 "The file %s is already visited literally,
1624 meaning no coding system handling, format conversion, or local variables.
1625 You have edited the buffer. Now you have asked to visit the file normally,
1626 but Emacs can only visit a file in one way at a time.
1628 Do you want to save the file, and visit it normally instead? ")
1629 (file-name-nondirectory filename)))
1630 (progn
1631 (save-buffer)
1632 (find-file-noselect-1 buf filename nowarn
1633 rawfile truename number))
1634 (if (y-or-n-p
1635 (format
1636 (if rawfile
1638 Do you want to discard your changes, and visit the file literally now? "
1640 Do you want to discard your changes, and visit the file normally now? ")))
1641 (find-file-noselect-1 buf filename nowarn
1642 rawfile truename number)
1643 (error (if rawfile "File already visited non-literally"
1644 "File already visited literally"))))
1645 (if (y-or-n-p
1646 (format
1647 (if rawfile
1648 "The file %s is already visited normally.
1649 You have asked to visit it literally,
1650 meaning no coding system decoding, format conversion, or local variables.
1651 But Emacs can only visit a file in one way at a time.
1653 Do you want to revisit the file literally now? "
1654 "The file %s is already visited literally,
1655 meaning no coding system decoding, format conversion, or local variables.
1656 You have asked to visit it normally,
1657 but Emacs can only visit a file in one way at a time.
1659 Do you want to revisit the file normally now? ")
1660 (file-name-nondirectory filename)))
1661 (find-file-noselect-1 buf filename nowarn
1662 rawfile truename number)
1663 (error (if rawfile "File already visited non-literally"
1664 "File already visited literally"))))))
1665 ;; Return the buffer we are using.
1666 buf)
1667 ;; Create a new buffer.
1668 (setq buf (create-file-buffer filename))
1669 ;; find-file-noselect-1 may use a different buffer.
1670 (find-file-noselect-1 buf filename nowarn
1671 rawfile truename number))))))
1673 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1674 (let (error)
1675 (with-current-buffer buf
1676 (kill-local-variable 'find-file-literally)
1677 ;; Needed in case we are re-visiting the file with a different
1678 ;; text representation.
1679 (kill-local-variable 'buffer-file-coding-system)
1680 (kill-local-variable 'cursor-type)
1681 (let ((inhibit-read-only t))
1682 (erase-buffer))
1683 (and (default-value 'enable-multibyte-characters)
1684 (not rawfile)
1685 (set-buffer-multibyte t))
1686 (if rawfile
1687 (condition-case ()
1688 (let ((inhibit-read-only t))
1689 (insert-file-contents-literally filename t))
1690 (file-error
1691 (when (and (file-exists-p filename)
1692 (not (file-readable-p filename)))
1693 (kill-buffer buf)
1694 (signal 'file-error (list "File is not readable"
1695 filename)))
1696 ;; Unconditionally set error
1697 (setq error t)))
1698 (condition-case ()
1699 (let ((inhibit-read-only t))
1700 (insert-file-contents filename t))
1701 (file-error
1702 (when (and (file-exists-p filename)
1703 (not (file-readable-p filename)))
1704 (kill-buffer buf)
1705 (signal 'file-error (list "File is not readable"
1706 filename)))
1707 ;; Run find-file-not-found-functions until one returns non-nil.
1708 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1709 ;; If they fail too, set error.
1710 (setq error t)))))
1711 ;; Record the file's truename, and maybe use that as visited name.
1712 (if (equal filename buffer-file-name)
1713 (setq buffer-file-truename truename)
1714 (setq buffer-file-truename
1715 (abbreviate-file-name (file-truename buffer-file-name))))
1716 (setq buffer-file-number number)
1717 ;; On VMS, we may want to remember which directory in a search list
1718 ;; the file was found in.
1719 (and (eq system-type 'vax-vms)
1720 (let (logical)
1721 (if (string-match ":" (file-name-directory filename))
1722 (setq logical (substring (file-name-directory filename)
1723 0 (match-beginning 0))))
1724 (not (member logical find-file-not-true-dirname-list)))
1725 (setq buffer-file-name buffer-file-truename))
1726 (if find-file-visit-truename
1727 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1728 ;; Set buffer's default directory to that of the file.
1729 (setq default-directory (file-name-directory buffer-file-name))
1730 ;; Turn off backup files for certain file names. Since
1731 ;; this is a permanent local, the major mode won't eliminate it.
1732 (and backup-enable-predicate
1733 (not (funcall backup-enable-predicate buffer-file-name))
1734 (progn
1735 (make-local-variable 'backup-inhibited)
1736 (setq backup-inhibited t)))
1737 (if rawfile
1738 (progn
1739 (set-buffer-multibyte nil)
1740 (setq buffer-file-coding-system 'no-conversion)
1741 (set-buffer-major-mode buf)
1742 (make-local-variable 'find-file-literally)
1743 (setq find-file-literally t))
1744 (after-find-file error (not nowarn)))
1745 (current-buffer))))
1747 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1748 "Like `insert-file-contents', but only reads in the file literally.
1749 A buffer may be modified in several ways after reading into the buffer,
1750 to Emacs features such as format decoding, character code
1751 conversion, `find-file-hook', automatic uncompression, etc.
1753 This function ensures that none of these modifications will take place."
1754 (let ((format-alist nil)
1755 (after-insert-file-functions nil)
1756 (coding-system-for-read 'no-conversion)
1757 (coding-system-for-write 'no-conversion)
1758 (find-buffer-file-type-function
1759 (if (fboundp 'find-buffer-file-type)
1760 (symbol-function 'find-buffer-file-type)
1761 nil))
1762 (inhibit-file-name-handlers
1763 (append '(jka-compr-handler image-file-handler)
1764 inhibit-file-name-handlers))
1765 (inhibit-file-name-operation 'insert-file-contents))
1766 (unwind-protect
1767 (progn
1768 (fset 'find-buffer-file-type (lambda (filename) t))
1769 (insert-file-contents filename visit beg end replace))
1770 (if find-buffer-file-type-function
1771 (fset 'find-buffer-file-type find-buffer-file-type-function)
1772 (fmakunbound 'find-buffer-file-type)))))
1774 (defun insert-file-1 (filename insert-func)
1775 (if (file-directory-p filename)
1776 (signal 'file-error (list "Opening input file" "file is a directory"
1777 filename)))
1778 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1779 #'buffer-modified-p))
1780 (tem (funcall insert-func filename)))
1781 (push-mark (+ (point) (car (cdr tem))))
1782 (when buffer
1783 (message "File %s already visited and modified in buffer %s"
1784 filename (buffer-name buffer)))))
1786 (defun insert-file-literally (filename)
1787 "Insert contents of file FILENAME into buffer after point with no conversion.
1789 This function is meant for the user to run interactively.
1790 Don't call it from programs! Use `insert-file-contents-literally' instead.
1791 \(Its calling sequence is different; see its documentation)."
1792 (interactive "*fInsert file literally: ")
1793 (insert-file-1 filename #'insert-file-contents-literally))
1795 (defvar find-file-literally nil
1796 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1797 This is a permanent local.")
1798 (put 'find-file-literally 'permanent-local t)
1800 (defun find-file-literally (filename)
1801 "Visit file FILENAME with no conversion of any kind.
1802 Format conversion and character code conversion are both disabled,
1803 and multibyte characters are disabled in the resulting buffer.
1804 The major mode used is Fundamental mode regardless of the file name,
1805 and local variable specifications in the file are ignored.
1806 Automatic uncompression and adding a newline at the end of the
1807 file due to `require-final-newline' is also disabled.
1809 You cannot absolutely rely on this function to result in
1810 visiting the file literally. If Emacs already has a buffer
1811 which is visiting the file, you get the existing buffer,
1812 regardless of whether it was created literally or not.
1814 In a Lisp program, if you want to be sure of accessing a file's
1815 contents literally, you should create a temporary buffer and then read
1816 the file contents into it using `insert-file-contents-literally'."
1817 (interactive "FFind file literally: ")
1818 (switch-to-buffer (find-file-noselect filename nil t)))
1820 (defvar after-find-file-from-revert-buffer nil)
1822 (defun after-find-file (&optional error warn noauto
1823 after-find-file-from-revert-buffer
1824 nomodes)
1825 "Called after finding a file and by the default revert function.
1826 Sets buffer mode, parses local variables.
1827 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1828 error in reading the file. WARN non-nil means warn if there
1829 exists an auto-save file more recent than the visited file.
1830 NOAUTO means don't mess with auto-save mode.
1831 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1832 means this call was from `revert-buffer'.
1833 Fifth arg NOMODES non-nil means don't alter the file's modes.
1834 Finishes by calling the functions in `find-file-hook'
1835 unless NOMODES is non-nil."
1836 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1837 (if noninteractive
1839 (let* (not-serious
1840 (msg
1841 (cond
1842 ((not warn) nil)
1843 ((and error (file-attributes buffer-file-name))
1844 (setq buffer-read-only t)
1845 "File exists, but cannot be read")
1846 ((not buffer-read-only)
1847 (if (and warn
1848 ;; No need to warn if buffer is auto-saved
1849 ;; under the name of the visited file.
1850 (not (and buffer-file-name
1851 auto-save-visited-file-name))
1852 (file-newer-than-file-p (or buffer-auto-save-file-name
1853 (make-auto-save-file-name))
1854 buffer-file-name))
1855 (format "%s has auto save data; consider M-x recover-this-file"
1856 (file-name-nondirectory buffer-file-name))
1857 (setq not-serious t)
1858 (if error "(New file)" nil)))
1859 ((not error)
1860 (setq not-serious t)
1861 "Note: file is write protected")
1862 ((file-attributes (directory-file-name default-directory))
1863 "File not found and directory write-protected")
1864 ((file-exists-p (file-name-directory buffer-file-name))
1865 (setq buffer-read-only nil))
1867 (setq buffer-read-only nil)
1868 "Use M-x make-directory RET RET to create the directory and its parents"))))
1869 (when msg
1870 (message "%s" msg)
1871 (or not-serious (sit-for 1 t))))
1872 (when (and auto-save-default (not noauto))
1873 (auto-save-mode t)))
1874 ;; Make people do a little extra work (C-x C-q)
1875 ;; before altering a backup file.
1876 (when (backup-file-name-p buffer-file-name)
1877 (setq buffer-read-only t))
1878 ;; When a file is marked read-only,
1879 ;; make the buffer read-only even if root is looking at it.
1880 (when (and (file-modes (buffer-file-name))
1881 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1882 (setq buffer-read-only t))
1883 (unless nomodes
1884 (when (and view-read-only view-mode)
1885 (view-mode-disable))
1886 (normal-mode t)
1887 ;; If requested, add a newline at the end of the file.
1888 (and (memq require-final-newline '(visit visit-save))
1889 (> (point-max) (point-min))
1890 (/= (char-after (1- (point-max))) ?\n)
1891 (not (and (eq selective-display t)
1892 (= (char-after (1- (point-max))) ?\r)))
1893 (save-excursion
1894 (goto-char (point-max))
1895 (insert "\n")))
1896 (when (and buffer-read-only
1897 view-read-only
1898 (not (eq (get major-mode 'mode-class) 'special)))
1899 (view-mode-enter))
1900 (run-hooks 'find-file-hook)))
1902 (defmacro report-errors (format &rest body)
1903 "Eval BODY and turn any error into a FORMAT message.
1904 FORMAT can have a %s escape which will be replaced with the actual error.
1905 If `debug-on-error' is set, errors are not caught, so that you can
1906 debug them.
1907 Avoid using a large BODY since it is duplicated."
1908 (declare (debug t) (indent 1))
1909 `(if debug-on-error
1910 (progn . ,body)
1911 (condition-case err
1912 (progn . ,body)
1913 (error (message ,format (prin1-to-string err))))))
1915 (defun normal-mode (&optional find-file)
1916 "Choose the major mode for this buffer automatically.
1917 Also sets up any specified local variables of the file.
1918 Uses the visited file name, the -*- line, and the local variables spec.
1920 This function is called automatically from `find-file'. In that case,
1921 we may set up the file-specified mode and local variables,
1922 depending on the value of `enable-local-variables'.
1923 In addition, if `local-enable-local-variables' is nil, we do
1924 not set local variables (though we do notice a mode specified with -*-.)
1926 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1927 or from Lisp without specifying the optional argument FIND-FILE;
1928 in that case, this function acts as if `enable-local-variables' were t."
1929 (interactive)
1930 (funcall (or default-major-mode 'fundamental-mode))
1931 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1932 (report-errors "File mode specification error: %s"
1933 (set-auto-mode))
1934 (report-errors "File local-variables error: %s"
1935 (hack-local-variables)))
1936 ;; Turn font lock off and on, to make sure it takes account of
1937 ;; whatever file local variables are relevant to it.
1938 (when (and font-lock-mode
1939 ;; Font-lock-mode (now in font-core.el) can be ON when
1940 ;; font-lock.el still hasn't been loaded.
1941 (boundp 'font-lock-keywords)
1942 (eq (car font-lock-keywords) t))
1943 (setq font-lock-keywords (cadr font-lock-keywords))
1944 (font-lock-mode 1))
1946 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1947 (ucs-set-table-for-input)))
1949 (defcustom auto-mode-case-fold nil
1950 "Non-nil means to try second pass through `auto-mode-alist'.
1951 This means that if the first case-sensitive search through the alist fails
1952 to find a matching major mode, a second case-insensitive search is made.
1953 On systems with case-insensitive file names, this variable is ignored,
1954 since only a single case-insensitive search through the alist is made."
1955 :group 'files
1956 :version "22.1"
1957 :type 'boolean)
1959 (defvar auto-mode-alist
1960 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1961 ;; c++-mode, java-mode and more) are added through autoload
1962 ;; directives in that file. That way is discouraged since it
1963 ;; spreads out the definition of the initial value.
1964 (mapcar
1965 (lambda (elt)
1966 (cons (purecopy (car elt)) (cdr elt)))
1967 `(;; do this first, so that .html.pl is Polish html, not Perl
1968 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1969 ("\\.te?xt\\'" . text-mode)
1970 ("\\.[tT]e[xX]\\'" . tex-mode)
1971 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1972 ("\\.ltx\\'" . latex-mode)
1973 ("\\.dtx\\'" . doctex-mode)
1974 ("\\.org\\'" . org-mode)
1975 ("\\.el\\'" . emacs-lisp-mode)
1976 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
1977 ("\\.l\\'" . lisp-mode)
1978 ("\\.li?sp\\'" . lisp-mode)
1979 ("\\.[fF]\\'" . fortran-mode)
1980 ("\\.for\\'" . fortran-mode)
1981 ("\\.p\\'" . pascal-mode)
1982 ("\\.pas\\'" . pascal-mode)
1983 ("\\.ad[abs]\\'" . ada-mode)
1984 ("\\.ad[bs].dg\\'" . ada-mode)
1985 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
1986 ("Imakefile\\'" . makefile-imake-mode)
1987 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
1988 ("\\.makepp\\'" . makefile-makepp-mode)
1989 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
1990 '(("\\.mk\\'" . makefile-bsdmake-mode)
1991 ("GNUmakefile\\'" . makefile-gmake-mode)
1992 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
1993 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
1994 ("[Mm]akefile\\'" . makefile-gmake-mode)))
1995 ("\\.am\\'" . makefile-automake-mode)
1996 ;; Less common extensions come here
1997 ;; so more common ones above are found faster.
1998 ("\\.texinfo\\'" . texinfo-mode)
1999 ("\\.te?xi\\'" . texinfo-mode)
2000 ("\\.[sS]\\'" . asm-mode)
2001 ("\\.asm\\'" . asm-mode)
2002 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2003 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2004 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2005 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2006 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2007 ("\\.bash\\'" . sh-mode)
2008 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2009 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2010 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2011 ("\\.m?spec\\'" . sh-mode)
2012 ("\\.m[mes]\\'" . nroff-mode)
2013 ("\\.man\\'" . nroff-mode)
2014 ("\\.sty\\'" . latex-mode)
2015 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2016 ("\\.bbl\\'" . latex-mode)
2017 ("\\.bib\\'" . bibtex-mode)
2018 ("\\.sql\\'" . sql-mode)
2019 ("\\.m[4c]\\'" . m4-mode)
2020 ("\\.mf\\'" . metafont-mode)
2021 ("\\.mp\\'" . metapost-mode)
2022 ("\\.vhdl?\\'" . vhdl-mode)
2023 ("\\.article\\'" . text-mode)
2024 ("\\.letter\\'" . text-mode)
2025 ("\\.i?tcl\\'" . tcl-mode)
2026 ("\\.exp\\'" . tcl-mode)
2027 ("\\.itk\\'" . tcl-mode)
2028 ("\\.icn\\'" . icon-mode)
2029 ("\\.sim\\'" . simula-mode)
2030 ("\\.mss\\'" . scribe-mode)
2031 ("\\.f9[05]\\'" . f90-mode)
2032 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2033 ("\\.pro\\'" . idlwave-mode)
2034 ("\\.prolog\\'" . prolog-mode)
2035 ("\\.tar\\'" . tar-mode)
2036 ;; The list of archive file extensions should be in sync with
2037 ;; `auto-coding-alist' with `no-conversion' coding system.
2038 ("\\.\\(\
2039 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2040 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2041 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
2042 ;; Mailer puts message to be edited in
2043 ;; /tmp/Re.... or Message
2044 ("\\`/tmp/Re" . text-mode)
2045 ("/Message[0-9]*\\'" . text-mode)
2046 ("\\.zone\\'" . zone-mode)
2047 ;; some news reader is reported to use this
2048 ("\\`/tmp/fol/" . text-mode)
2049 ("\\.oak\\'" . scheme-mode)
2050 ("\\.sgml?\\'" . sgml-mode)
2051 ("\\.x[ms]l\\'" . xml-mode)
2052 ("\\.dtd\\'" . sgml-mode)
2053 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2054 ("\\.js\\'" . java-mode) ; javascript-mode would be better
2055 ;; .emacs or .gnus or .viper following a directory delimiter in
2056 ;; Unix, MSDOG or VMS syntax.
2057 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2058 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2059 ;; _emacs following a directory delimiter
2060 ;; in MsDos syntax
2061 ("[:/]_emacs\\'" . emacs-lisp-mode)
2062 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2063 ("\\.ml\\'" . lisp-mode)
2064 ;; Common Lisp ASDF package system.
2065 ("\\.asd\\'" . lisp-mode)
2066 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2067 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2068 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2069 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2070 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2071 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)" . doc-view-mode)
2072 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2073 ("BROWSE\\'" . ebrowse-tree-mode)
2074 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2075 ("#\\*mail\\*" . mail-mode)
2076 ("\\.g\\'" . antlr-mode)
2077 ("\\.ses\\'" . ses-mode)
2078 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2079 ("\\.docbook\\'" . sgml-mode)
2080 ("\\.com\\'" . dcl-mode)
2081 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2082 ;; Windows candidates may be opened case sensitively on Unix
2083 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2084 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2085 ("\\.ppd\\'" . conf-ppd-mode)
2086 ("java.+\\.conf\\'" . conf-javaprop-mode)
2087 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2088 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2089 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
2090 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2091 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2092 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2093 ;; this has lower priority to avoid matching changelog.sgml etc.
2094 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2095 ;; either user's dot-files or under /etc or some such
2096 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2097 ;; alas not all ~/.*rc files are like this
2098 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2099 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2100 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2101 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2102 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2103 ;; this contains everything twice, with space and with colon :-(
2104 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2105 ;; Get rid of any trailing .n.m and try again.
2106 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2107 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2108 ;; Using mode nil rather than `ignore' would let the search continue
2109 ;; through this list (with the shortened name) rather than start over.
2110 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2111 ;; The following should come after the ChangeLog pattern
2112 ;; for the sake of ChangeLog.1, etc.
2113 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2114 ("\\.[1-9]\\'" . nroff-mode)
2115 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2116 "Alist of filename patterns vs corresponding major mode functions.
2117 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2118 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2119 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2120 mode function to use. FUNCTION will be called, unless it is nil.
2122 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2123 calling FUNCTION (if it's not nil), we delete the suffix that matched
2124 REGEXP and search the list again for another match.
2126 If the file name matches `inhibit-first-line-modes-regexps',
2127 then `auto-mode-alist' is not processed.
2129 The extensions whose FUNCTION is `archive-mode' should also
2130 appear in `auto-coding-alist' with `no-conversion' coding system.
2132 See also `interpreter-mode-alist', which detects executable script modes
2133 based on the interpreters they specify to run,
2134 and `magic-mode-alist', which determines modes based on file contents.")
2136 (defvar interpreter-mode-alist
2137 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2138 ;; and pike-mode) are added through autoload directives in that
2139 ;; file. That way is discouraged since it spreads out the
2140 ;; definition of the initial value.
2141 (mapc
2142 (lambda (l)
2143 (cons (purecopy (car l)) (cdr l)))
2144 '(("perl" . perl-mode)
2145 ("perl5" . perl-mode)
2146 ("miniperl" . perl-mode)
2147 ("wish" . tcl-mode)
2148 ("wishx" . tcl-mode)
2149 ("tcl" . tcl-mode)
2150 ("tclsh" . tcl-mode)
2151 ("scm" . scheme-mode)
2152 ("ash" . sh-mode)
2153 ("bash" . sh-mode)
2154 ("bash2" . sh-mode)
2155 ("csh" . sh-mode)
2156 ("dtksh" . sh-mode)
2157 ("es" . sh-mode)
2158 ("itcsh" . sh-mode)
2159 ("jsh" . sh-mode)
2160 ("ksh" . sh-mode)
2161 ("oash" . sh-mode)
2162 ("pdksh" . sh-mode)
2163 ("rc" . sh-mode)
2164 ("rpm" . sh-mode)
2165 ("sh" . sh-mode)
2166 ("sh5" . sh-mode)
2167 ("tcsh" . sh-mode)
2168 ("wksh" . sh-mode)
2169 ("wsh" . sh-mode)
2170 ("zsh" . sh-mode)
2171 ("tail" . text-mode)
2172 ("more" . text-mode)
2173 ("less" . text-mode)
2174 ("pg" . text-mode)
2175 ("make" . makefile-gmake-mode) ; Debian uses this
2176 ("guile" . scheme-mode)
2177 ("clisp" . lisp-mode)))
2178 "Alist mapping interpreter names to major modes.
2179 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2180 Each element looks like (INTERPRETER . MODE).
2181 If INTERPRETER matches the name of the interpreter specified in the first line
2182 of a script, mode MODE is enabled.
2184 See also `auto-mode-alist'.")
2186 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2187 "List of regexps; if one matches a file name, don't look for `-*-'.")
2189 (defvar inhibit-first-line-modes-suffixes nil
2190 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2191 When checking `inhibit-first-line-modes-regexps', we first discard
2192 from the end of the file name anything that matches one of these regexps.")
2194 (defvar auto-mode-interpreter-regexp
2195 "#![ \t]?\\([^ \t\n]*\
2196 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2197 "Regexp matching interpreters, for file mode determination.
2198 This regular expression is matched against the first line of a file
2199 to determine the file's mode in `set-auto-mode'. If it matches, the file
2200 is assumed to be interpreted by the interpreter matched by the second group
2201 of the regular expression. The mode is then determined as the mode
2202 associated with that interpreter in `interpreter-mode-alist'.")
2204 (defvar magic-mode-alist nil
2205 "Alist of buffer beginnings vs. corresponding major mode functions.
2206 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2207 After visiting a file, if REGEXP matches the text at the beginning of the
2208 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2209 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2210 major mode.
2212 If FUNCTION is nil, then it is not called. (That is a way of saying
2213 \"allow `auto-mode-alist' to decide for these files.\")")
2214 (put 'magic-mode-alist 'risky-local-variable t)
2216 (defvar magic-fallback-mode-alist
2217 `((image-type-auto-detected-p . image-mode)
2218 ;; The < comes before the groups (but the first) to reduce backtracking.
2219 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2220 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2221 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2222 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2223 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2224 comment-re "*"
2225 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2226 "[Hh][Tt][Mm][Ll]"))
2227 . html-mode)
2228 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2229 ;; These two must come after html, because they are more general:
2230 ("<\\?xml " . xml-mode)
2231 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2232 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2233 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2234 . sgml-mode)
2235 ("%!PS" . ps-mode)
2236 ("# xmcd " . conf-unix-mode))
2237 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2238 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2239 After visiting a file, if REGEXP matches the text at the beginning of the
2240 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2241 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2242 have not specified a mode for this file.
2244 If FUNCTION is nil, then it is not called.")
2245 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2247 (defvar magic-mode-regexp-match-limit 4000
2248 "Upper limit on `magic-mode-alist' regexp matches.
2249 Also applies to `magic-fallback-mode-alist'.")
2251 (defun set-auto-mode (&optional keep-mode-if-same)
2252 "Select major mode appropriate for current buffer.
2254 To find the right major mode, this function checks for a -*- mode tag,
2255 checks if it uses an interpreter listed in `interpreter-mode-alist',
2256 matches the buffer beginning against `magic-mode-alist',
2257 compares the filename against the entries in `auto-mode-alist',
2258 then matches the buffer beginning against `magic-fallback-mode-alist'.
2260 It does not check for the `mode:' local variable in the
2261 Local Variables section of the file; for that, use `hack-local-variables'.
2263 If `enable-local-variables' is nil, this function does not check for a
2264 -*- mode tag.
2266 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2267 set the major mode only if that would change it. In other words
2268 we don't actually set it to the same mode the buffer already has."
2269 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2270 (let (end done mode modes)
2271 ;; Find a -*- mode tag
2272 (save-excursion
2273 (goto-char (point-min))
2274 (skip-chars-forward " \t\n")
2275 (and enable-local-variables
2276 (setq end (set-auto-mode-1))
2277 (if (save-excursion (search-forward ":" end t))
2278 ;; Find all specifications for the `mode:' variable
2279 ;; and execute them left to right.
2280 (while (let ((case-fold-search t))
2281 (or (and (looking-at "mode:")
2282 (goto-char (match-end 0)))
2283 (re-search-forward "[ \t;]mode:" end t)))
2284 (skip-chars-forward " \t")
2285 (let ((beg (point)))
2286 (if (search-forward ";" end t)
2287 (forward-char -1)
2288 (goto-char end))
2289 (skip-chars-backward " \t")
2290 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2291 modes)))
2292 ;; Simple -*-MODE-*- case.
2293 (push (intern (concat (downcase (buffer-substring (point) end))
2294 "-mode"))
2295 modes))))
2296 ;; If we found modes to use, invoke them now, outside the save-excursion.
2297 (if modes
2298 (catch 'nop
2299 (dolist (mode (nreverse modes))
2300 (if (not (functionp mode))
2301 (message "Ignoring unknown mode `%s'" mode)
2302 (setq done t)
2303 (or (set-auto-mode-0 mode keep-mode-if-same)
2304 ;; continuing would call minor modes again, toggling them off
2305 (throw 'nop nil))))))
2306 ;; If we didn't, look for an interpreter specified in the first line.
2307 ;; As a special case, allow for things like "#!/bin/env perl", which
2308 ;; finds the interpreter anywhere in $PATH.
2309 (unless done
2310 (setq mode (save-excursion
2311 (goto-char (point-min))
2312 (if (looking-at auto-mode-interpreter-regexp)
2313 (match-string 2)
2314 ""))
2315 ;; Map interpreter name to a mode, signalling we're done at the
2316 ;; same time.
2317 done (assoc (file-name-nondirectory mode)
2318 interpreter-mode-alist))
2319 ;; If we found an interpreter mode to use, invoke it now.
2320 (if done
2321 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2322 ;; Next try matching the buffer beginning against magic-mode-alist.
2323 (unless done
2324 (if (setq done (save-excursion
2325 (goto-char (point-min))
2326 (save-restriction
2327 (narrow-to-region (point-min)
2328 (min (point-max)
2329 (+ (point-min) magic-mode-regexp-match-limit)))
2330 (assoc-default nil magic-mode-alist
2331 (lambda (re dummy)
2332 (if (functionp re)
2333 (funcall re)
2334 (looking-at re)))))))
2335 (set-auto-mode-0 done keep-mode-if-same)))
2336 ;; Next compare the filename against the entries in auto-mode-alist.
2337 (unless done
2338 (if buffer-file-name
2339 (let ((name buffer-file-name)
2340 (remote-id (file-remote-p buffer-file-name)))
2341 ;; Remove remote file name identification.
2342 (when (and (stringp remote-id)
2343 (string-match (regexp-quote remote-id) name))
2344 (setq name (substring name (match-end 0))))
2345 ;; Remove backup-suffixes from file name.
2346 (setq name (file-name-sans-versions name))
2347 (while name
2348 ;; Find first matching alist entry.
2349 (setq mode
2350 (if (memq system-type '(vax-vms windows-nt cygwin))
2351 ;; System is case-insensitive.
2352 (let ((case-fold-search t))
2353 (assoc-default name auto-mode-alist
2354 'string-match))
2355 ;; System is case-sensitive.
2357 ;; First match case-sensitively.
2358 (let ((case-fold-search nil))
2359 (assoc-default name auto-mode-alist
2360 'string-match))
2361 ;; Fallback to case-insensitive match.
2362 (and auto-mode-case-fold
2363 (let ((case-fold-search t))
2364 (assoc-default name auto-mode-alist
2365 'string-match))))))
2366 (if (and mode
2367 (consp mode)
2368 (cadr mode))
2369 (setq mode (car mode)
2370 name (substring name 0 (match-beginning 0)))
2371 (setq name))
2372 (when mode
2373 (set-auto-mode-0 mode keep-mode-if-same)
2374 (setq done t))))))
2375 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2376 (unless done
2377 (if (setq done (save-excursion
2378 (goto-char (point-min))
2379 (save-restriction
2380 (narrow-to-region (point-min)
2381 (min (point-max)
2382 (+ (point-min) magic-mode-regexp-match-limit)))
2383 (assoc-default nil magic-fallback-mode-alist
2384 (lambda (re dummy)
2385 (if (functionp re)
2386 (funcall re)
2387 (looking-at re)))))))
2388 (set-auto-mode-0 done keep-mode-if-same)))))
2390 ;; When `keep-mode-if-same' is set, we are working on behalf of
2391 ;; set-visited-file-name. In that case, if the major mode specified is the
2392 ;; same one we already have, don't actually reset it. We don't want to lose
2393 ;; minor modes such as Font Lock.
2394 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2395 "Apply MODE and return it.
2396 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2397 any aliases and compared to current major mode. If they are the
2398 same, do nothing and return nil."
2399 (unless (and keep-mode-if-same
2400 (eq (indirect-function mode)
2401 (indirect-function major-mode)))
2402 (when mode
2403 (funcall mode)
2404 mode)))
2406 (defun set-auto-mode-1 ()
2407 "Find the -*- spec in the buffer.
2408 Call with point at the place to start searching from.
2409 If one is found, set point to the beginning
2410 and return the position of the end.
2411 Otherwise, return nil; point may be changed."
2412 (let (beg end)
2413 (and
2414 ;; Don't look for -*- if this file name matches any
2415 ;; of the regexps in inhibit-first-line-modes-regexps.
2416 (let ((temp inhibit-first-line-modes-regexps)
2417 (name (if buffer-file-name
2418 (file-name-sans-versions buffer-file-name)
2419 (buffer-name))))
2420 (while (let ((sufs inhibit-first-line-modes-suffixes))
2421 (while (and sufs (not (string-match (car sufs) name)))
2422 (setq sufs (cdr sufs)))
2423 sufs)
2424 (setq name (substring name 0 (match-beginning 0))))
2425 (while (and temp
2426 (not (string-match (car temp) name)))
2427 (setq temp (cdr temp)))
2428 (not temp))
2430 (search-forward "-*-" (line-end-position
2431 ;; If the file begins with "#!"
2432 ;; (exec interpreter magic), look
2433 ;; for mode frobs in the first two
2434 ;; lines. You cannot necessarily
2435 ;; put them in the first line of
2436 ;; such a file without screwing up
2437 ;; the interpreter invocation.
2438 ;; The same holds for
2439 ;; '\"
2440 ;; in man pages (preprocessor
2441 ;; magic for the `man' program).
2442 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2443 (progn
2444 (skip-chars-forward " \t")
2445 (setq beg (point))
2446 (search-forward "-*-" (line-end-position) t))
2447 (progn
2448 (forward-char -3)
2449 (skip-chars-backward " \t")
2450 (setq end (point))
2451 (goto-char beg)
2452 end))))
2454 ;;; Handling file local variables
2456 (defvar ignored-local-variables
2457 '(ignored-local-variables safe-local-variable-values)
2458 "Variables to be ignored in a file's local variable spec.")
2460 (defvar hack-local-variables-hook nil
2461 "Normal hook run after processing a file's local variables specs.
2462 Major modes can use this to examine user-specified local variables
2463 in order to initialize other data structure based on them.")
2465 (defcustom safe-local-variable-values nil
2466 "List variable-value pairs that are considered safe.
2467 Each element is a cons cell (VAR . VAL), where VAR is a variable
2468 symbol and VAL is a value that is considered safe."
2469 :group 'find-file
2470 :type 'alist)
2472 (defcustom safe-local-eval-forms nil
2473 "Expressions that are considered safe in an `eval:' local variable.
2474 Add expressions to this list if you want Emacs to evaluate them, when
2475 they appear in an `eval' local variable specification, without first
2476 asking you for confirmation."
2477 :group 'find-file
2478 :version "22.1"
2479 :type '(repeat sexp))
2481 ;; Risky local variables:
2482 (mapc (lambda (var) (put var 'risky-local-variable t))
2483 '(after-load-alist
2484 auto-mode-alist
2485 buffer-auto-save-file-name
2486 buffer-file-name
2487 buffer-file-truename
2488 buffer-undo-list
2489 dabbrev-case-fold-search
2490 dabbrev-case-replace
2491 debugger
2492 default-text-properties
2493 display-time-string
2494 enable-local-eval
2495 enable-local-variables
2496 eval
2497 exec-directory
2498 exec-path
2499 file-name-handler-alist
2500 font-lock-defaults
2501 format-alist
2502 frame-title-format
2503 global-mode-string
2504 header-line-format
2505 icon-title-format
2506 ignored-local-variables
2507 imenu--index-alist
2508 imenu-generic-expression
2509 inhibit-quit
2510 input-method-alist
2511 load-path
2512 max-lisp-eval-depth
2513 max-specpdl-size
2514 minor-mode-alist
2515 minor-mode-map-alist
2516 minor-mode-overriding-map-alist
2517 mode-line-buffer-identification
2518 mode-line-format
2519 mode-line-client
2520 mode-line-modes
2521 mode-line-modified
2522 mode-line-mule-info
2523 mode-line-position
2524 mode-line-process
2525 mode-line-remote
2526 mode-name
2527 outline-level
2528 overriding-local-map
2529 overriding-terminal-local-map
2530 parse-time-rules
2531 process-environment
2532 rmail-output-file-alist
2533 safe-local-variable-values
2534 safe-local-eval-forms
2535 save-some-buffers-action-alist
2536 special-display-buffer-names
2537 standard-input
2538 standard-output
2539 unread-command-events
2540 vc-mode))
2542 ;; Safe local variables:
2544 ;; For variables defined by major modes, the safety declarations can go into
2545 ;; the major mode's file, since that will be loaded before file variables are
2546 ;; processed.
2548 ;; For variables defined by minor modes, put the safety declarations in the
2549 ;; file defining the minor mode after the defcustom/defvar using an autoload
2550 ;; cookie, e.g.:
2552 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2554 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2555 ;; minor mode file may not be loaded yet.
2557 ;; For variables defined in the C source code the declaration should go here:
2559 (mapc (lambda (pair)
2560 (put (car pair) 'safe-local-variable (cdr pair)))
2561 '((buffer-read-only . booleanp) ;; C source code
2562 (default-directory . stringp) ;; C source code
2563 (fill-column . integerp) ;; C source code
2564 (indent-tabs-mode . booleanp) ;; C source code
2565 (left-margin . integerp) ;; C source code
2566 (no-update-autoloads . booleanp)
2567 (tab-width . integerp) ;; C source code
2568 (truncate-lines . booleanp))) ;; C source code
2570 (put 'c-set-style 'safe-local-eval-function t)
2572 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars)
2573 "Get confirmation before setting up local variable values.
2574 ALL-VARS is the list of all variables to be set up.
2575 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2576 RISKY-VARS is the list of those that are marked as risky."
2577 (if noninteractive
2579 (let ((name (if buffer-file-name
2580 (file-name-nondirectory buffer-file-name)
2581 (concat "buffer " (buffer-name))))
2582 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2583 prompt char)
2584 (save-window-excursion
2585 (let ((buf (get-buffer-create "*Local Variables*")))
2586 (pop-to-buffer buf)
2587 (set (make-local-variable 'cursor-type) nil)
2588 (erase-buffer)
2589 (if unsafe-vars
2590 (insert "The local variables list in " name
2591 "\ncontains values that may not be safe (*)"
2592 (if risky-vars
2593 ", and variables that are risky (**)."
2594 "."))
2595 (if risky-vars
2596 (insert "The local variables list in " name
2597 "\ncontains variables that are risky (**).")
2598 (insert "A local variables list is specified in " name ".")))
2599 (insert "\n\nDo you want to apply it? You can type
2600 y -- to apply the local variables list.
2601 n -- to ignore the local variables list.")
2602 (if offer-save
2603 (insert "
2604 ! -- to apply the local variables list, and permanently mark these
2605 values (*) as safe (in the future, they will be set automatically.)\n\n")
2606 (insert "\n\n"))
2607 (dolist (elt all-vars)
2608 (cond ((member elt unsafe-vars)
2609 (insert " * "))
2610 ((member elt risky-vars)
2611 (insert " ** "))
2613 (insert " ")))
2614 (princ (car elt) buf)
2615 (insert " : ")
2616 ;; Make strings with embedded whitespace easier to read.
2617 (let ((print-escape-newlines t))
2618 (prin1 (cdr elt) buf))
2619 (insert "\n"))
2620 (setq prompt
2621 (format "Please type %s%s: "
2622 (if offer-save "y, n, or !" "y or n")
2623 (if (< (line-number-at-pos) (window-body-height))
2625 ", or C-v to scroll")))
2626 (goto-char (point-min))
2627 (let ((cursor-in-echo-area t)
2628 (executing-kbd-macro executing-kbd-macro)
2629 (exit-chars
2630 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2631 done)
2632 (while (not done)
2633 (message prompt)
2634 (setq char (read-event))
2635 (if (numberp char)
2636 (cond ((eq char ?\C-v)
2637 (condition-case nil
2638 (scroll-up)
2639 (error (goto-char (point-min)))))
2640 ;; read-event returns -1 if we are in a kbd
2641 ;; macro and there are no more events in the
2642 ;; macro. In that case, attempt to get an
2643 ;; event interactively.
2644 ((and executing-kbd-macro (= char -1))
2645 (setq executing-kbd-macro nil))
2646 (t (setq done (memq (downcase char) exit-chars)))))))
2647 (setq char (downcase char))
2648 (when (and offer-save (= char ?!) unsafe-vars)
2649 (dolist (elt unsafe-vars)
2650 (add-to-list 'safe-local-variable-values elt))
2651 ;; When this is called from desktop-restore-file-buffer,
2652 ;; coding-system-for-read may be non-nil. Reset it before
2653 ;; writing to .emacs.
2654 (if (or custom-file user-init-file)
2655 (let ((coding-system-for-read nil))
2656 (customize-save-variable
2657 'safe-local-variable-values
2658 safe-local-variable-values))))
2659 (kill-buffer buf)
2660 (or (= char ?!)
2661 (= char ?\s)
2662 (= char ?y)))))))
2664 (defun hack-local-variables-prop-line (&optional mode-only)
2665 "Return local variables specified in the -*- line.
2666 Ignore any specification for `mode:' and `coding:';
2667 `set-auto-mode' should already have handled `mode:',
2668 `set-auto-coding' should already have handled `coding:'.
2670 If MODE-ONLY is non-nil, all we do is check whether the major
2671 mode is specified, returning t if it is specified. Otherwise,
2672 return an alist of elements (VAR . VAL), where VAR is a variable
2673 and VAL is the specified value."
2674 (save-excursion
2675 (goto-char (point-min))
2676 (let ((end (set-auto-mode-1))
2677 result mode-specified)
2678 ;; Parse the -*- line into the RESULT alist.
2679 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2680 (cond ((not end)
2681 nil)
2682 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2683 ;; Simple form: "-*- MODENAME -*-". Already handled.
2684 (setq mode-specified t)
2685 nil)
2687 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2688 ;; (last ";" is optional).
2689 (while (< (point) end)
2690 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2691 (error "Malformed -*- line"))
2692 (goto-char (match-end 0))
2693 ;; There used to be a downcase here,
2694 ;; but the manual didn't say so,
2695 ;; and people want to set var names that aren't all lc.
2696 (let ((key (intern (match-string 1)))
2697 (val (save-restriction
2698 (narrow-to-region (point) end)
2699 (read (current-buffer)))))
2700 ;; It is traditional to ignore
2701 ;; case when checking for `mode' in set-auto-mode,
2702 ;; so we must do that here as well.
2703 ;; That is inconsistent, but we're stuck with it.
2704 ;; The same can be said for `coding' in set-auto-coding.
2705 (or (and (equal (downcase (symbol-name key)) "mode")
2706 (setq mode-specified t))
2707 (equal (downcase (symbol-name key)) "coding")
2708 (condition-case nil
2709 (push (cons (if (eq key 'eval)
2710 'eval
2711 (indirect-variable key))
2712 val) result)
2713 (error nil)))
2714 (skip-chars-forward " \t;")))))
2716 (if mode-only
2717 mode-specified
2718 result))))
2720 (defun hack-local-variables (&optional mode-only)
2721 "Parse and put into effect this buffer's local variables spec.
2722 If MODE-ONLY is non-nil, all we do is check whether the major mode
2723 is specified, returning t if it is specified."
2724 (let ((enable-local-variables
2725 (and local-enable-local-variables enable-local-variables))
2726 result)
2727 (when (or mode-only enable-local-variables)
2728 (setq result (hack-local-variables-prop-line mode-only))
2729 ;; Look for "Local variables:" line in last page.
2730 (save-excursion
2731 (goto-char (point-max))
2732 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2733 'move)
2734 (when (let ((case-fold-search t))
2735 (search-forward "Local Variables:" nil t))
2736 (skip-chars-forward " \t")
2737 ;; suffix is what comes after "local variables:" in its line.
2738 ;; prefix is what comes before "local variables:" in its line.
2739 (let ((suffix
2740 (concat
2741 (regexp-quote (buffer-substring (point)
2742 (line-end-position)))
2743 "$"))
2744 (prefix
2745 (concat "^" (regexp-quote
2746 (buffer-substring (line-beginning-position)
2747 (match-beginning 0)))))
2748 beg)
2750 (forward-line 1)
2751 (let ((startpos (point))
2752 endpos
2753 (thisbuf (current-buffer)))
2754 (save-excursion
2755 (unless (let ((case-fold-search t))
2756 (re-search-forward
2757 (concat prefix "[ \t]*End:[ \t]*" suffix)
2758 nil t))
2759 (error "Local variables list is not properly terminated"))
2760 (beginning-of-line)
2761 (setq endpos (point)))
2763 (with-temp-buffer
2764 (insert-buffer-substring thisbuf startpos endpos)
2765 (goto-char (point-min))
2766 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2767 (while (not (eobp))
2768 ;; Discard the prefix.
2769 (if (looking-at prefix)
2770 (delete-region (point) (match-end 0))
2771 (error "Local variables entry is missing the prefix"))
2772 (end-of-line)
2773 ;; Discard the suffix.
2774 (if (looking-back suffix)
2775 (delete-region (match-beginning 0) (point))
2776 (error "Local variables entry is missing the suffix"))
2777 (forward-line 1))
2778 (goto-char (point-min))
2780 (while (not (eobp))
2781 ;; Find the variable name; strip whitespace.
2782 (skip-chars-forward " \t")
2783 (setq beg (point))
2784 (skip-chars-forward "^:\n")
2785 (if (eolp) (error "Missing colon in local variables entry"))
2786 (skip-chars-backward " \t")
2787 (let* ((str (buffer-substring beg (point)))
2788 (var (read str))
2789 val)
2790 ;; Read the variable value.
2791 (skip-chars-forward "^:")
2792 (forward-char 1)
2793 (setq val (read (current-buffer)))
2794 (if mode-only
2795 (if (eq var 'mode)
2796 (setq result t))
2797 (unless (eq var 'coding)
2798 (condition-case nil
2799 (push (cons (if (eq var 'eval)
2800 'eval
2801 (indirect-variable var))
2802 val) result)
2803 (error nil)))))
2804 (forward-line 1)))))))
2806 ;; We've read all the local variables. Now, return whether the
2807 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2808 ;; variables (if MODE-ONLY is nil.)
2809 (if mode-only
2810 result
2811 (dolist (ignored ignored-local-variables)
2812 (setq result (assq-delete-all ignored result)))
2813 (if (null enable-local-eval)
2814 (setq result (assq-delete-all 'eval result)))
2815 (when result
2816 (setq result (nreverse result))
2817 ;; Find those variables that we may want to save to
2818 ;; `safe-local-variable-values'.
2819 (let (risky-vars unsafe-vars)
2820 (dolist (elt result)
2821 (let ((var (car elt))
2822 (val (cdr elt)))
2823 (or (eq var 'mode)
2824 (and (eq var 'eval)
2825 (or (eq enable-local-eval t)
2826 (hack-one-local-variable-eval-safep
2827 (eval (quote val)))))
2828 (safe-local-variable-p var val)
2829 (and (risky-local-variable-p var val)
2830 (push elt risky-vars))
2831 (push elt unsafe-vars))))
2832 (if (eq enable-local-variables :safe)
2833 ;; If caller wants only the safe variables,
2834 ;; install only them.
2835 (dolist (elt result)
2836 (unless (or (member elt unsafe-vars)
2837 (member elt risky-vars))
2838 (hack-one-local-variable (car elt) (cdr elt))))
2839 ;; Query, except in the case where all are known safe
2840 ;; if the user wants no quuery in that case.
2841 (if (or (and (eq enable-local-variables t)
2842 (null unsafe-vars)
2843 (null risky-vars))
2844 (eq enable-local-variables :all)
2845 (hack-local-variables-confirm
2846 result unsafe-vars risky-vars))
2847 (dolist (elt result)
2848 (hack-one-local-variable (car elt) (cdr elt)))))))
2849 (run-hooks 'hack-local-variables-hook)))))
2851 (defun safe-local-variable-p (sym val)
2852 "Non-nil if SYM is safe as a file-local variable with value VAL.
2853 It is safe if any of these conditions are met:
2855 * There is a matching entry (SYM . VAL) in the
2856 `safe-local-variable-values' user option.
2858 * The `safe-local-variable' property of SYM is a function that
2859 evaluates to a non-nil value with VAL as an argument."
2860 (or (member (cons sym val) safe-local-variable-values)
2861 (let ((safep (get sym 'safe-local-variable)))
2862 (and (functionp safep) (funcall safep val)))))
2864 (defun risky-local-variable-p (sym &optional ignored)
2865 "Non-nil if SYM could be dangerous as a file-local variable.
2866 It is dangerous if either of these conditions are met:
2868 * Its `risky-local-variable' property is non-nil.
2870 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2871 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
2872 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2873 \"map-alist\", or \"bindat-spec\"."
2874 ;; If this is an alias, check the base name.
2875 (condition-case nil
2876 (setq sym (indirect-variable sym))
2877 (error nil))
2878 (or (get sym 'risky-local-variable)
2879 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2880 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2881 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
2882 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
2884 (defun hack-one-local-variable-quotep (exp)
2885 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2887 (defun hack-one-local-variable-constantp (exp)
2888 (or (and (not (symbolp exp)) (not (consp exp)))
2889 (memq exp '(t nil))
2890 (keywordp exp)
2891 (hack-one-local-variable-quotep exp)))
2893 (defun hack-one-local-variable-eval-safep (exp)
2894 "Return t if it is safe to eval EXP when it is found in a file."
2895 (or (not (consp exp))
2896 ;; Detect certain `put' expressions.
2897 (and (eq (car exp) 'put)
2898 (hack-one-local-variable-quotep (nth 1 exp))
2899 (hack-one-local-variable-quotep (nth 2 exp))
2900 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2901 (cond ((eq prop 'lisp-indent-hook)
2902 ;; Only allow safe values of lisp-indent-hook;
2903 ;; not functions.
2904 (or (numberp val) (equal val ''defun)))
2905 ((eq prop 'edebug-form-spec)
2906 ;; Only allow indirect form specs.
2907 ;; During bootstrapping, edebug-basic-spec might not be
2908 ;; defined yet.
2909 (and (fboundp 'edebug-basic-spec)
2910 (hack-one-local-variable-quotep val)
2911 (edebug-basic-spec (nth 1 val)))))))
2912 ;; Allow expressions that the user requested.
2913 (member exp safe-local-eval-forms)
2914 ;; Certain functions can be allowed with safe arguments
2915 ;; or can specify verification functions to try.
2916 (and (symbolp (car exp))
2917 (let ((prop (get (car exp) 'safe-local-eval-function)))
2918 (cond ((eq prop t)
2919 (let ((ok t))
2920 (dolist (arg (cdr exp))
2921 (unless (hack-one-local-variable-constantp arg)
2922 (setq ok nil)))
2923 ok))
2924 ((functionp prop)
2925 (funcall prop exp))
2926 ((listp prop)
2927 (let ((ok nil))
2928 (dolist (function prop)
2929 (if (funcall function exp)
2930 (setq ok t)))
2931 ok)))))))
2933 (defun hack-one-local-variable (var val)
2934 "Set local variable VAR with value VAL.
2935 If VAR is `mode', call `VAL-mode' as a function unless it's
2936 already the major mode."
2937 (cond ((eq var 'mode)
2938 (let ((mode (intern (concat (downcase (symbol-name val))
2939 "-mode"))))
2940 (unless (eq (indirect-function mode)
2941 (indirect-function major-mode))
2942 (funcall mode))))
2943 ((eq var 'eval)
2944 (save-excursion (eval val)))
2946 ;; Make sure the string has no text properties.
2947 ;; Some text properties can get evaluated in various ways,
2948 ;; so it is risky to put them on with a local variable list.
2949 (if (stringp val)
2950 (set-text-properties 0 (length val) nil val))
2951 (set (make-local-variable var) val))))
2954 (defcustom change-major-mode-with-file-name t
2955 "Non-nil means \\[write-file] should set the major mode from the file name.
2956 However, the mode will not be changed if
2957 \(1) a local variables list or the `-*-' line specifies a major mode, or
2958 \(2) the current major mode is a \"special\" mode,
2959 \ not suitable for ordinary files, or
2960 \(3) the new file name does not particularly specify any mode."
2961 :type 'boolean
2962 :group 'editing-basics)
2964 (defun set-visited-file-name (filename &optional no-query along-with-file)
2965 "Change name of file visited in current buffer to FILENAME.
2966 This also renames the buffer to correspond to the new file.
2967 The next time the buffer is saved it will go in the newly specified file.
2968 FILENAME nil or an empty string means mark buffer as not visiting any file.
2969 Remember to delete the initial contents of the minibuffer
2970 if you wish to pass an empty string as the argument.
2972 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2973 confirmation in the case where another buffer is already visiting FILENAME.
2975 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2976 the old visited file has been renamed to the new name FILENAME."
2977 (interactive "FSet visited file name: ")
2978 (if (buffer-base-buffer)
2979 (error "An indirect buffer cannot visit a file"))
2980 (let (truename)
2981 (if filename
2982 (setq filename
2983 (if (string-equal filename "")
2985 (expand-file-name filename))))
2986 (if filename
2987 (progn
2988 (setq truename (file-truename filename))
2989 (if find-file-visit-truename
2990 (setq filename truename))))
2991 (if filename
2992 (let ((new-name (file-name-nondirectory filename)))
2993 (if (string= new-name "")
2994 (error "Empty file name"))))
2995 (let ((buffer (and filename (find-buffer-visiting filename))))
2996 (and buffer (not (eq buffer (current-buffer)))
2997 (not no-query)
2998 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
2999 filename)))
3000 (error "Aborted")))
3001 (or (equal filename buffer-file-name)
3002 (progn
3003 (and filename (lock-buffer filename))
3004 (unlock-buffer)))
3005 (setq buffer-file-name filename)
3006 (if filename ; make buffer name reflect filename.
3007 (let ((new-name (file-name-nondirectory buffer-file-name)))
3008 (if (eq system-type 'vax-vms)
3009 (setq new-name (downcase new-name)))
3010 (setq default-directory (file-name-directory buffer-file-name))
3011 ;; If new-name == old-name, renaming would add a spurious <2>
3012 ;; and it's considered as a feature in rename-buffer.
3013 (or (string= new-name (buffer-name))
3014 (rename-buffer new-name t))))
3015 (setq buffer-backed-up nil)
3016 (or along-with-file
3017 (clear-visited-file-modtime))
3018 ;; Abbreviate the file names of the buffer.
3019 (if truename
3020 (progn
3021 (setq buffer-file-truename (abbreviate-file-name truename))
3022 (if find-file-visit-truename
3023 (setq buffer-file-name truename))))
3024 (setq buffer-file-number
3025 (if filename
3026 (nthcdr 10 (file-attributes buffer-file-name))
3027 nil)))
3028 ;; write-file-functions is normally used for things like ftp-find-file
3029 ;; that visit things that are not local files as if they were files.
3030 ;; Changing to visit an ordinary local file instead should flush the hook.
3031 (kill-local-variable 'write-file-functions)
3032 (kill-local-variable 'local-write-file-hooks)
3033 (kill-local-variable 'revert-buffer-function)
3034 (kill-local-variable 'backup-inhibited)
3035 ;; If buffer was read-only because of version control,
3036 ;; that reason is gone now, so make it writable.
3037 (if vc-mode
3038 (setq buffer-read-only nil))
3039 (kill-local-variable 'vc-mode)
3040 ;; Turn off backup files for certain file names.
3041 ;; Since this is a permanent local, the major mode won't eliminate it.
3042 (and buffer-file-name
3043 backup-enable-predicate
3044 (not (funcall backup-enable-predicate buffer-file-name))
3045 (progn
3046 (make-local-variable 'backup-inhibited)
3047 (setq backup-inhibited t)))
3048 (let ((oauto buffer-auto-save-file-name))
3049 ;; If auto-save was not already on, turn it on if appropriate.
3050 (if (not buffer-auto-save-file-name)
3051 (and buffer-file-name auto-save-default
3052 (auto-save-mode t))
3053 ;; If auto save is on, start using a new name.
3054 ;; We deliberately don't rename or delete the old auto save
3055 ;; for the old visited file name. This is because perhaps
3056 ;; the user wants to save the new state and then compare with the
3057 ;; previous state from the auto save file.
3058 (setq buffer-auto-save-file-name
3059 (make-auto-save-file-name)))
3060 ;; Rename the old auto save file if any.
3061 (and oauto buffer-auto-save-file-name
3062 (file-exists-p oauto)
3063 (rename-file oauto buffer-auto-save-file-name t)))
3064 (and buffer-file-name
3065 (not along-with-file)
3066 (set-buffer-modified-p t))
3067 ;; Update the major mode, if the file name determines it.
3068 (condition-case nil
3069 ;; Don't change the mode if it is special.
3070 (or (not change-major-mode-with-file-name)
3071 (get major-mode 'mode-class)
3072 ;; Don't change the mode if the local variable list specifies it.
3073 (hack-local-variables t)
3074 (set-auto-mode t))
3075 (error nil)))
3077 (defun write-file (filename &optional confirm)
3078 "Write current buffer into file FILENAME.
3079 This makes the buffer visit that file, and marks it as not modified.
3081 If you specify just a directory name as FILENAME, that means to use
3082 the default file name but in that directory. You can also yank
3083 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3085 If the buffer is not already visiting a file, the default file name
3086 for the output file is the buffer name.
3088 If optional second arg CONFIRM is non-nil, this function
3089 asks for confirmation before overwriting an existing file.
3090 Interactively, confirmation is required unless you supply a prefix argument."
3091 ;; (interactive "FWrite file: ")
3092 (interactive
3093 (list (if buffer-file-name
3094 (read-file-name "Write file: "
3095 nil nil nil nil)
3096 (read-file-name "Write file: " default-directory
3097 (expand-file-name
3098 (file-name-nondirectory (buffer-name))
3099 default-directory)
3100 nil nil))
3101 (not current-prefix-arg)))
3102 (or (null filename) (string-equal filename "")
3103 (progn
3104 ;; If arg is just a directory,
3105 ;; use the default file name, but in that directory.
3106 (if (file-directory-p filename)
3107 (setq filename (concat (file-name-as-directory filename)
3108 (file-name-nondirectory
3109 (or buffer-file-name (buffer-name))))))
3110 (and confirm
3111 (file-exists-p filename)
3112 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3113 (error "Canceled")))
3114 (set-visited-file-name filename (not confirm))))
3115 (set-buffer-modified-p t)
3116 ;; Make buffer writable if file is writable.
3117 (and buffer-file-name
3118 (file-writable-p buffer-file-name)
3119 (setq buffer-read-only nil))
3120 (save-buffer)
3121 ;; It's likely that the VC status at the new location is different from
3122 ;; the one at the old location.
3123 (vc-find-file-hook))
3125 (defun backup-buffer ()
3126 "Make a backup of the disk file visited by the current buffer, if appropriate.
3127 This is normally done before saving the buffer the first time.
3129 A backup may be done by renaming or by copying; see documentation of
3130 variable `make-backup-files'. If it's done by renaming, then the file is
3131 no longer accessible under its old name.
3133 The value is non-nil after a backup was made by renaming.
3134 It has the form (MODES . BACKUPNAME).
3135 MODES is the result of `file-modes' on the original
3136 file; this means that the caller, after saving the buffer, should change
3137 the modes of the new file to agree with the old modes.
3138 BACKUPNAME is the backup file name, which is the old file renamed."
3139 (if (and make-backup-files (not backup-inhibited)
3140 (not buffer-backed-up)
3141 (file-exists-p buffer-file-name)
3142 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3143 '(?- ?l)))
3144 (let ((real-file-name buffer-file-name)
3145 backup-info backupname targets setmodes)
3146 ;; If specified name is a symbolic link, chase it to the target.
3147 ;; Thus we make the backups in the directory where the real file is.
3148 (setq real-file-name (file-chase-links real-file-name))
3149 (setq backup-info (find-backup-file-name real-file-name)
3150 backupname (car backup-info)
3151 targets (cdr backup-info))
3152 ;; (if (file-directory-p buffer-file-name)
3153 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3154 (if backup-info
3155 (condition-case ()
3156 (let ((delete-old-versions
3157 ;; If have old versions to maybe delete,
3158 ;; ask the user to confirm now, before doing anything.
3159 ;; But don't actually delete til later.
3160 (and targets
3161 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3162 (or delete-old-versions
3163 (y-or-n-p (format "Delete excess backup versions of %s? "
3164 real-file-name)))))
3165 (modes (file-modes buffer-file-name)))
3166 ;; Actually write the back up file.
3167 (condition-case ()
3168 (if (or file-precious-flag
3169 ; (file-symlink-p buffer-file-name)
3170 backup-by-copying
3171 ;; Don't rename a suid or sgid file.
3172 (and modes (< 0 (logand modes #o6000)))
3173 (not (file-writable-p (file-name-directory real-file-name)))
3174 (and backup-by-copying-when-linked
3175 (> (file-nlinks real-file-name) 1))
3176 (and (or backup-by-copying-when-mismatch
3177 (integerp backup-by-copying-when-privileged-mismatch))
3178 (let ((attr (file-attributes real-file-name)))
3179 (and (or backup-by-copying-when-mismatch
3180 (and (integerp (nth 2 attr))
3181 (integerp backup-by-copying-when-privileged-mismatch)
3182 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3183 (or (nth 9 attr)
3184 (not (file-ownership-preserved-p real-file-name)))))))
3185 (backup-buffer-copy real-file-name backupname modes)
3186 ;; rename-file should delete old backup.
3187 (rename-file real-file-name backupname t)
3188 (setq setmodes (cons modes backupname)))
3189 (file-error
3190 ;; If trouble writing the backup, write it in ~.
3191 (setq backupname (expand-file-name
3192 (convert-standard-filename
3193 "~/%backup%~")))
3194 (message "Cannot write backup file; backing up in %s"
3195 backupname)
3196 (sleep-for 1)
3197 (backup-buffer-copy real-file-name backupname modes)))
3198 (setq buffer-backed-up t)
3199 ;; Now delete the old versions, if desired.
3200 (if delete-old-versions
3201 (while targets
3202 (condition-case ()
3203 (delete-file (car targets))
3204 (file-error nil))
3205 (setq targets (cdr targets))))
3206 setmodes)
3207 (file-error nil))))))
3209 (defun backup-buffer-copy (from-name to-name modes)
3210 (let ((umask (default-file-modes)))
3211 (unwind-protect
3212 (progn
3213 ;; Create temp files with strict access rights. It's easy to
3214 ;; loosen them later, whereas it's impossible to close the
3215 ;; time-window of loose permissions otherwise.
3216 (set-default-file-modes ?\700)
3217 (when (condition-case nil
3218 ;; Try to overwrite old backup first.
3219 (copy-file from-name to-name t t t)
3220 (error t))
3221 (while (condition-case nil
3222 (progn
3223 (when (file-exists-p to-name)
3224 (delete-file to-name))
3225 (copy-file from-name to-name nil t t)
3226 nil)
3227 (file-already-exists t))
3228 ;; The file was somehow created by someone else between
3229 ;; `delete-file' and `copy-file', so let's try again.
3230 ;; rms says "I think there is also a possible race
3231 ;; condition for making backup files" (emacs-devel 20070821).
3232 nil)))
3233 ;; Reset the umask.
3234 (set-default-file-modes umask)))
3235 (and modes
3236 (set-file-modes to-name (logand modes #o1777))))
3238 (defun file-name-sans-versions (name &optional keep-backup-version)
3239 "Return file NAME sans backup versions or strings.
3240 This is a separate procedure so your site-init or startup file can
3241 redefine it.
3242 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3243 we do not remove backup version numbers, only true file version numbers."
3244 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3245 (if handler
3246 (funcall handler 'file-name-sans-versions name keep-backup-version)
3247 (substring name 0
3248 (if (eq system-type 'vax-vms)
3249 ;; VMS version number is (a) semicolon, optional
3250 ;; sign, zero or more digits or (b) period, option
3251 ;; sign, zero or more digits, provided this is the
3252 ;; second period encountered outside of the
3253 ;; device/directory part of the file name.
3254 (or (string-match ";[-+]?[0-9]*\\'" name)
3255 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
3256 name)
3257 (match-beginning 1))
3258 (length name))
3259 (if keep-backup-version
3260 (length name)
3261 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3262 (string-match "~\\'" name)
3263 (length name))))))))
3265 (defun file-ownership-preserved-p (file)
3266 "Return t if deleting FILE and rewriting it would preserve the owner."
3267 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3268 (if handler
3269 (funcall handler 'file-ownership-preserved-p file)
3270 (let ((attributes (file-attributes file)))
3271 ;; Return t if the file doesn't exist, since it's true that no
3272 ;; information would be lost by an (attempted) delete and create.
3273 (or (null attributes)
3274 (= (nth 2 attributes) (user-uid)))))))
3276 (defun file-name-sans-extension (filename)
3277 "Return FILENAME sans final \"extension\".
3278 The extension, in a file name, is the part that follows the last `.',
3279 except that a leading `.', if any, doesn't count."
3280 (save-match-data
3281 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3282 directory)
3283 (if (and (string-match "\\.[^.]*\\'" file)
3284 (not (eq 0 (match-beginning 0))))
3285 (if (setq directory (file-name-directory filename))
3286 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3287 ;; we don't want to expand it.
3288 (concat directory (substring file 0 (match-beginning 0)))
3289 (substring file 0 (match-beginning 0)))
3290 filename))))
3292 (defun file-name-extension (filename &optional period)
3293 "Return FILENAME's final \"extension\".
3294 The extension, in a file name, is the part that follows the last `.',
3295 excluding version numbers and backup suffixes,
3296 except that a leading `.', if any, doesn't count.
3297 Return nil for extensionless file names such as `foo'.
3298 Return the empty string for file names such as `foo.'.
3300 If PERIOD is non-nil, then the returned value includes the period
3301 that delimits the extension, and if FILENAME has no extension,
3302 the value is \"\"."
3303 (save-match-data
3304 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3305 (if (and (string-match "\\.[^.]*\\'" file)
3306 (not (eq 0 (match-beginning 0))))
3307 (substring file (+ (match-beginning 0) (if period 0 1)))
3308 (if period
3309 "")))))
3311 (defcustom make-backup-file-name-function nil
3312 "A function to use instead of the default `make-backup-file-name'.
3313 A value of nil gives the default `make-backup-file-name' behavior.
3315 This could be buffer-local to do something special for specific
3316 files. If you define it, you may need to change `backup-file-name-p'
3317 and `file-name-sans-versions' too.
3319 See also `backup-directory-alist'."
3320 :group 'backup
3321 :type '(choice (const :tag "Default" nil)
3322 (function :tag "Your function")))
3324 (defcustom backup-directory-alist nil
3325 "Alist of filename patterns and backup directory names.
3326 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3327 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3328 relative or absolute. If it is absolute, so that all matching files
3329 are backed up into the same directory, the file names in this
3330 directory will be the full name of the file backed up with all
3331 directory separators changed to `!' to prevent clashes. This will not
3332 work correctly if your filesystem truncates the resulting name.
3334 For the common case of all backups going into one directory, the alist
3335 should contain a single element pairing \".\" with the appropriate
3336 directory name.
3338 If this variable is nil, or it fails to match a filename, the backup
3339 is made in the original file's directory.
3341 On MS-DOS filesystems without long names this variable is always
3342 ignored."
3343 :group 'backup
3344 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3345 (directory :tag "Backup directory name"))))
3347 (defun normal-backup-enable-predicate (name)
3348 "Default `backup-enable-predicate' function.
3349 Checks for files in `temporary-file-directory',
3350 `small-temporary-file-directory', and /tmp."
3351 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3352 name 0 nil)))
3353 ;; Directory is under temporary-file-directory.
3354 (and (not (eq comp t))
3355 (< comp (- (length temporary-file-directory)))))
3356 (let ((comp (compare-strings "/tmp" 0 nil
3357 name 0 nil)))
3358 ;; Directory is under /tmp.
3359 (and (not (eq comp t))
3360 (< comp (- (length "/tmp")))))
3361 (if small-temporary-file-directory
3362 (let ((comp (compare-strings small-temporary-file-directory
3363 0 nil
3364 name 0 nil)))
3365 ;; Directory is under small-temporary-file-directory.
3366 (and (not (eq comp t))
3367 (< comp (- (length small-temporary-file-directory)))))))))
3369 (defun make-backup-file-name (file)
3370 "Create the non-numeric backup file name for FILE.
3371 Normally this will just be the file's name with `~' appended.
3372 Customization hooks are provided as follows.
3374 If the variable `make-backup-file-name-function' is non-nil, its value
3375 should be a function which will be called with FILE as its argument;
3376 the resulting name is used.
3378 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3379 the documentation of that variable. If the directory for the backup
3380 doesn't exist, it is created."
3381 (if make-backup-file-name-function
3382 (funcall make-backup-file-name-function file)
3383 (if (and (eq system-type 'ms-dos)
3384 (not (msdos-long-file-names)))
3385 (let ((fn (file-name-nondirectory file)))
3386 (concat (file-name-directory file)
3387 (or (and (string-match "\\`[^.]+\\'" fn)
3388 (concat (match-string 0 fn) ".~"))
3389 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3390 (concat (match-string 0 fn) "~")))))
3391 (concat (make-backup-file-name-1 file) "~"))))
3393 (defun make-backup-file-name-1 (file)
3394 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3395 (let ((alist backup-directory-alist)
3396 elt backup-directory abs-backup-directory)
3397 (while alist
3398 (setq elt (pop alist))
3399 (if (string-match (car elt) file)
3400 (setq backup-directory (cdr elt)
3401 alist nil)))
3402 ;; If backup-directory is relative, it should be relative to the
3403 ;; file's directory. By expanding explicitly here, we avoid
3404 ;; depending on default-directory.
3405 (if backup-directory
3406 (setq abs-backup-directory
3407 (expand-file-name backup-directory
3408 (file-name-directory file))))
3409 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3410 (condition-case nil
3411 (make-directory abs-backup-directory 'parents)
3412 (file-error (setq backup-directory nil
3413 abs-backup-directory nil))))
3414 (if (null backup-directory)
3415 file
3416 (if (file-name-absolute-p backup-directory)
3417 (progn
3418 (when (memq system-type '(windows-nt ms-dos cygwin))
3419 ;; Normalize DOSish file names: downcase the drive
3420 ;; letter, if any, and replace the leading "x:" with
3421 ;; "/drive_x".
3422 (or (file-name-absolute-p file)
3423 (setq file (expand-file-name file))) ; make defaults explicit
3424 ;; Replace any invalid file-name characters (for the
3425 ;; case of backing up remote files).
3426 (setq file (expand-file-name (convert-standard-filename file)))
3427 (if (eq (aref file 1) ?:)
3428 (setq file (concat "/"
3429 "drive_"
3430 (char-to-string (downcase (aref file 0)))
3431 (if (eq (aref file 2) ?/)
3433 "/")
3434 (substring file 2)))))
3435 ;; Make the name unique by substituting directory
3436 ;; separators. It may not really be worth bothering about
3437 ;; doubling `!'s in the original name...
3438 (expand-file-name
3439 (subst-char-in-string
3440 ?/ ?!
3441 (replace-regexp-in-string "!" "!!" file))
3442 backup-directory))
3443 (expand-file-name (file-name-nondirectory file)
3444 (file-name-as-directory abs-backup-directory))))))
3446 (defun backup-file-name-p (file)
3447 "Return non-nil if FILE is a backup file name (numeric or not).
3448 This is a separate function so you can redefine it for customization.
3449 You may need to redefine `file-name-sans-versions' as well."
3450 (string-match "~\\'" file))
3452 (defvar backup-extract-version-start)
3454 ;; This is used in various files.
3455 ;; The usage of backup-extract-version-start is not very clean,
3456 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3457 (defun backup-extract-version (fn)
3458 "Given the name of a numeric backup file, FN, return the backup number.
3459 Uses the free variable `backup-extract-version-start', whose value should be
3460 the index in the name where the version number begins."
3461 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3462 (= (match-beginning 0) backup-extract-version-start))
3463 (string-to-number (substring fn backup-extract-version-start -1))
3466 ;; I believe there is no need to alter this behavior for VMS;
3467 ;; since backup files are not made on VMS, it should not get called.
3468 (defun find-backup-file-name (fn)
3469 "Find a file name for a backup file FN, and suggestions for deletions.
3470 Value is a list whose car is the name for the backup file
3471 and whose cdr is a list of old versions to consider deleting now.
3472 If the value is nil, don't make a backup.
3473 Uses `backup-directory-alist' in the same way as does
3474 `make-backup-file-name'."
3475 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3476 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3477 (if handler
3478 (funcall handler 'find-backup-file-name fn)
3479 (if (or (eq version-control 'never)
3480 ;; We don't support numbered backups on plain MS-DOS
3481 ;; when long file names are unavailable.
3482 (and (eq system-type 'ms-dos)
3483 (not (msdos-long-file-names))))
3484 (list (make-backup-file-name fn))
3485 (let* ((basic-name (make-backup-file-name-1 fn))
3486 (base-versions (concat (file-name-nondirectory basic-name)
3487 ".~"))
3488 (backup-extract-version-start (length base-versions))
3489 (high-water-mark 0)
3490 (number-to-delete 0)
3491 possibilities deserve-versions-p versions)
3492 (condition-case ()
3493 (setq possibilities (file-name-all-completions
3494 base-versions
3495 (file-name-directory basic-name))
3496 versions (sort (mapcar #'backup-extract-version
3497 possibilities)
3498 #'<)
3499 high-water-mark (apply 'max 0 versions)
3500 deserve-versions-p (or version-control
3501 (> high-water-mark 0))
3502 number-to-delete (- (length versions)
3503 kept-old-versions
3504 kept-new-versions
3505 -1))
3506 (file-error (setq possibilities nil)))
3507 (if (not deserve-versions-p)
3508 (list (make-backup-file-name fn))
3509 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3510 (if (and (> number-to-delete 0)
3511 ;; Delete nothing if there is overflow
3512 ;; in the number of versions to keep.
3513 (>= (+ kept-new-versions kept-old-versions -1) 0))
3514 (mapcar (lambda (n)
3515 (format "%s.~%d~" basic-name n))
3516 (let ((v (nthcdr kept-old-versions versions)))
3517 (rplacd (nthcdr (1- number-to-delete) v) ())
3518 v))))))))))
3520 (defun file-nlinks (filename)
3521 "Return number of names file FILENAME has."
3522 (car (cdr (file-attributes filename))))
3524 ;; (defun file-relative-name (filename &optional directory)
3525 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3526 ;; This function returns a relative file name which is equivalent to FILENAME
3527 ;; when used with that default directory as the default.
3528 ;; If this is impossible (which can happen on MSDOS and Windows
3529 ;; when the file name and directory use different drive names)
3530 ;; then it returns FILENAME."
3531 ;; (save-match-data
3532 ;; (let ((fname (expand-file-name filename)))
3533 ;; (setq directory (file-name-as-directory
3534 ;; (expand-file-name (or directory default-directory))))
3535 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3536 ;; ;; drive names, they can't be relative, so return the absolute name.
3537 ;; (if (and (or (eq system-type 'ms-dos)
3538 ;; (eq system-type 'cygwin)
3539 ;; (eq system-type 'windows-nt))
3540 ;; (not (string-equal (substring fname 0 2)
3541 ;; (substring directory 0 2))))
3542 ;; filename
3543 ;; (let ((ancestor ".")
3544 ;; (fname-dir (file-name-as-directory fname)))
3545 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3546 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3547 ;; (setq directory (file-name-directory (substring directory 0 -1))
3548 ;; ancestor (if (equal ancestor ".")
3549 ;; ".."
3550 ;; (concat "../" ancestor))))
3551 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3552 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3553 ;; ;; We matched within FNAME's directory part.
3554 ;; ;; Add the rest of FNAME onto ANCESTOR.
3555 ;; (let ((rest (substring fname (match-end 0))))
3556 ;; (if (and (equal ancestor ".")
3557 ;; (not (equal rest "")))
3558 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3559 ;; rest
3560 ;; (concat (file-name-as-directory ancestor) rest)))
3561 ;; ;; We matched FNAME's directory equivalent.
3562 ;; ancestor))))))
3564 (defun file-relative-name (filename &optional directory)
3565 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3566 This function returns a relative file name which is equivalent to FILENAME
3567 when used with that default directory as the default.
3568 If FILENAME and DIRECTORY lie on different machines or on different drives
3569 on a DOS/Windows machine, it returns FILENAME in expanded form."
3570 (save-match-data
3571 (setq directory
3572 (file-name-as-directory (expand-file-name (or directory
3573 default-directory))))
3574 (setq filename (expand-file-name filename))
3575 (let ((fremote (file-remote-p filename))
3576 (dremote (file-remote-p directory)))
3577 (if ;; Conditions for separate trees
3579 ;; Test for different drives on DOS/Windows
3580 (and
3581 ;; Should `cygwin' really be included here? --stef
3582 (memq system-type '(ms-dos cygwin windows-nt))
3583 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3584 ;; Test for different remote file system identification
3585 (not (equal fremote dremote)))
3586 filename
3587 (let ((ancestor ".")
3588 (filename-dir (file-name-as-directory filename)))
3589 (while (not
3591 (eq t (compare-strings filename-dir nil (length directory)
3592 directory nil nil case-fold-search))
3593 (eq t (compare-strings filename nil (length directory)
3594 directory nil nil case-fold-search))))
3595 (setq directory (file-name-directory (substring directory 0 -1))
3596 ancestor (if (equal ancestor ".")
3597 ".."
3598 (concat "../" ancestor))))
3599 ;; Now ancestor is empty, or .., or ../.., etc.
3600 (if (eq t (compare-strings filename nil (length directory)
3601 directory nil nil case-fold-search))
3602 ;; We matched within FILENAME's directory part.
3603 ;; Add the rest of FILENAME onto ANCESTOR.
3604 (let ((rest (substring filename (length directory))))
3605 (if (and (equal ancestor ".") (not (equal rest "")))
3606 ;; But don't bother with ANCESTOR if it would give us `./'.
3607 rest
3608 (concat (file-name-as-directory ancestor) rest)))
3609 ;; We matched FILENAME's directory equivalent.
3610 ancestor))))))
3612 (defun save-buffer (&optional args)
3613 "Save current buffer in visited file if modified.
3614 Variations are described below.
3616 By default, makes the previous version into a backup file
3617 if previously requested or if this is the first save.
3618 Prefixed with one \\[universal-argument], marks this version
3619 to become a backup when the next save is done.
3620 Prefixed with two \\[universal-argument]'s,
3621 unconditionally makes the previous version into a backup file.
3622 Prefixed with three \\[universal-argument]'s, marks this version
3623 to become a backup when the next save is done,
3624 and unconditionally makes the previous version into a backup file.
3626 With a numeric argument of 0, never make the previous version
3627 into a backup file.
3629 If a file's name is FOO, the names of its numbered backup versions are
3630 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3631 Numeric backups (rather than FOO~) will be made if value of
3632 `version-control' is not the atom `never' and either there are already
3633 numeric versions of the file being backed up, or `version-control' is
3634 non-nil.
3635 We don't want excessive versions piling up, so there are variables
3636 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3637 and `kept-new-versions', which tells how many newest versions to keep.
3638 Defaults are 2 old versions and 2 new.
3639 `dired-kept-versions' controls dired's clean-directory (.) command.
3640 If `delete-old-versions' is nil, system will query user
3641 before trimming versions. Otherwise it does it silently.
3643 If `vc-make-backup-files' is nil, which is the default,
3644 no backup files are made for files managed by version control.
3645 (This is because the version control system itself records previous versions.)
3647 See the subroutine `basic-save-buffer' for more information."
3648 (interactive "p")
3649 (let ((modp (buffer-modified-p))
3650 (large (> (buffer-size) 50000))
3651 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3652 (memq args '(16 64)))))
3653 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3654 (if (and modp large (buffer-file-name))
3655 (message "Saving file %s..." (buffer-file-name)))
3656 (basic-save-buffer)
3657 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3659 (defun delete-auto-save-file-if-necessary (&optional force)
3660 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3661 Normally delete only if the file was written by this Emacs since
3662 the last real save, but optional arg FORCE non-nil means delete anyway."
3663 (and buffer-auto-save-file-name delete-auto-save-files
3664 (not (string= buffer-file-name buffer-auto-save-file-name))
3665 (or force (recent-auto-save-p))
3666 (progn
3667 (condition-case ()
3668 (delete-file buffer-auto-save-file-name)
3669 (file-error nil))
3670 (set-buffer-auto-saved))))
3672 (defvar auto-save-hook nil
3673 "Normal hook run just before auto-saving.")
3675 (defcustom before-save-hook nil
3676 "Normal hook that is run before a buffer is saved to its file."
3677 :options '(copyright-update time-stamp)
3678 :type 'hook
3679 :group 'files)
3681 (defcustom after-save-hook nil
3682 "Normal hook that is run after a buffer is saved to its file."
3683 :options '(executable-make-buffer-file-executable-if-script-p)
3684 :type 'hook
3685 :group 'files)
3687 (defvar save-buffer-coding-system nil
3688 "If non-nil, use this coding system for saving the buffer.
3689 More precisely, use this coding system in place of the
3690 value of `buffer-file-coding-system', when saving the buffer.
3691 Calling `write-region' for any purpose other than saving the buffer
3692 will still use `buffer-file-coding-system'; this variable has no effect
3693 in such cases.")
3695 (make-variable-buffer-local 'save-buffer-coding-system)
3696 (put 'save-buffer-coding-system 'permanent-local t)
3698 (defun basic-save-buffer ()
3699 "Save the current buffer in its visited file, if it has been modified.
3700 The hooks `write-contents-functions' and `write-file-functions' get a chance
3701 to do the job of saving; if they do not, then the buffer is saved in
3702 the visited file in the usual way.
3703 Before and after saving the buffer, this function runs
3704 `before-save-hook' and `after-save-hook', respectively."
3705 (interactive)
3706 (save-current-buffer
3707 ;; In an indirect buffer, save its base buffer instead.
3708 (if (buffer-base-buffer)
3709 (set-buffer (buffer-base-buffer)))
3710 (if (buffer-modified-p)
3711 (let ((recent-save (recent-auto-save-p))
3712 setmodes)
3713 ;; On VMS, rename file and buffer to get rid of version number.
3714 (if (and (eq system-type 'vax-vms)
3715 (not (string= buffer-file-name
3716 (file-name-sans-versions buffer-file-name))))
3717 (let (buffer-new-name)
3718 ;; Strip VMS version number before save.
3719 (setq buffer-file-name
3720 (file-name-sans-versions buffer-file-name))
3721 ;; Construct a (unique) buffer name to correspond.
3722 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3723 (setq buffer-new-name (buffer-name buf))
3724 (kill-buffer buf))
3725 (rename-buffer buffer-new-name)))
3726 ;; If buffer has no file name, ask user for one.
3727 (or buffer-file-name
3728 (let ((filename
3729 (expand-file-name
3730 (read-file-name "File to save in: ") nil)))
3731 (if (file-exists-p filename)
3732 (if (file-directory-p filename)
3733 ;; Signal an error if the user specified the name of an
3734 ;; existing directory.
3735 (error "%s is a directory" filename)
3736 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3737 filename))
3738 (error "Canceled")))
3739 ;; Signal an error if the specified name refers to a
3740 ;; non-existing directory.
3741 (let ((dir (file-name-directory filename)))
3742 (unless (file-directory-p dir)
3743 (if (file-exists-p dir)
3744 (error "%s is not a directory" dir)
3745 (error "%s: no such directory" dir)))))
3746 (set-visited-file-name filename)))
3747 (or (verify-visited-file-modtime (current-buffer))
3748 (not (file-exists-p buffer-file-name))
3749 (yes-or-no-p
3750 (format "%s has changed since visited or saved. Save anyway? "
3751 (file-name-nondirectory buffer-file-name)))
3752 (error "Save not confirmed"))
3753 (save-restriction
3754 (widen)
3755 (save-excursion
3756 (and (> (point-max) (point-min))
3757 (not find-file-literally)
3758 (/= (char-after (1- (point-max))) ?\n)
3759 (not (and (eq selective-display t)
3760 (= (char-after (1- (point-max))) ?\r)))
3761 (or (eq require-final-newline t)
3762 (eq require-final-newline 'visit-save)
3763 (and require-final-newline
3764 (y-or-n-p
3765 (format "Buffer %s does not end in newline. Add one? "
3766 (buffer-name)))))
3767 (save-excursion
3768 (goto-char (point-max))
3769 (insert ?\n))))
3770 ;; Support VC version backups.
3771 (vc-before-save)
3772 (run-hooks 'before-save-hook)
3773 (or (run-hook-with-args-until-success 'write-contents-functions)
3774 (run-hook-with-args-until-success 'local-write-file-hooks)
3775 (run-hook-with-args-until-success 'write-file-functions)
3776 ;; If a hook returned t, file is already "written".
3777 ;; Otherwise, write it the usual way now.
3778 (setq setmodes (basic-save-buffer-1)))
3779 ;; Now we have saved the current buffer. Let's make sure
3780 ;; that buffer-file-coding-system is fixed to what
3781 ;; actually used for saving by binding it locally.
3782 (if save-buffer-coding-system
3783 (setq save-buffer-coding-system last-coding-system-used)
3784 (setq buffer-file-coding-system last-coding-system-used))
3785 (setq buffer-file-number
3786 (nthcdr 10 (file-attributes buffer-file-name)))
3787 (if setmodes
3788 (condition-case ()
3789 (set-file-modes buffer-file-name (car setmodes))
3790 (error nil))))
3791 ;; If the auto-save file was recent before this command,
3792 ;; delete it now.
3793 (delete-auto-save-file-if-necessary recent-save)
3794 ;; Support VC `implicit' locking.
3795 (vc-after-save)
3796 (run-hooks 'after-save-hook))
3797 (message "(No changes need to be saved)"))))
3799 ;; This does the "real job" of writing a buffer into its visited file
3800 ;; and making a backup file. This is what is normally done
3801 ;; but inhibited if one of write-file-functions returns non-nil.
3802 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3803 (defun basic-save-buffer-1 ()
3804 (prog1
3805 (if save-buffer-coding-system
3806 (let ((coding-system-for-write save-buffer-coding-system))
3807 (basic-save-buffer-2))
3808 (basic-save-buffer-2))
3809 (setq buffer-file-coding-system-explicit last-coding-system-used)))
3811 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3812 (defun basic-save-buffer-2 ()
3813 (let (tempsetmodes setmodes)
3814 (if (not (file-writable-p buffer-file-name))
3815 (let ((dir (file-name-directory buffer-file-name)))
3816 (if (not (file-directory-p dir))
3817 (if (file-exists-p dir)
3818 (error "%s is not a directory" dir)
3819 (error "%s: no such directory" dir))
3820 (if (not (file-exists-p buffer-file-name))
3821 (error "Directory %s write-protected" dir)
3822 (if (yes-or-no-p
3823 (format "File %s is write-protected; try to save anyway? "
3824 (file-name-nondirectory
3825 buffer-file-name)))
3826 (setq tempsetmodes t)
3827 (error "Attempt to save to a file which you aren't allowed to write"))))))
3828 (or buffer-backed-up
3829 (setq setmodes (backup-buffer)))
3830 (let ((dir (file-name-directory buffer-file-name)))
3831 (if (and file-precious-flag
3832 (file-writable-p dir))
3833 ;; If file is precious, write temp name, then rename it.
3834 ;; This requires write access to the containing dir,
3835 ;; which is why we don't try it if we don't have that access.
3836 (let ((realname buffer-file-name)
3837 tempname succeed
3838 (umask (default-file-modes))
3839 (old-modtime (visited-file-modtime)))
3840 ;; Create temp files with strict access rights. It's easy to
3841 ;; loosen them later, whereas it's impossible to close the
3842 ;; time-window of loose permissions otherwise.
3843 (unwind-protect
3844 (progn
3845 (clear-visited-file-modtime)
3846 (set-default-file-modes ?\700)
3847 ;; Try various temporary names.
3848 ;; This code follows the example of make-temp-file,
3849 ;; but it calls write-region in the appropriate way
3850 ;; for saving the buffer.
3851 (while (condition-case ()
3852 (progn
3853 (setq tempname
3854 (make-temp-name
3855 (expand-file-name "tmp" dir)))
3856 (write-region (point-min) (point-max)
3857 tempname nil realname
3858 buffer-file-truename 'excl)
3859 nil)
3860 (file-already-exists t))
3861 ;; The file was somehow created by someone else between
3862 ;; `make-temp-name' and `write-region', let's try again.
3863 nil)
3864 (setq succeed t))
3865 ;; Reset the umask.
3866 (set-default-file-modes umask)
3867 ;; If we failed, restore the buffer's modtime.
3868 (unless succeed
3869 (set-visited-file-modtime old-modtime)))
3870 ;; Since we have created an entirely new file,
3871 ;; make sure it gets the right permission bits set.
3872 (setq setmodes (or setmodes
3873 (cons (or (file-modes buffer-file-name)
3874 (logand ?\666 umask))
3875 buffer-file-name)))
3876 ;; We succeeded in writing the temp file,
3877 ;; so rename it.
3878 (rename-file tempname buffer-file-name t))
3879 ;; If file not writable, see if we can make it writable
3880 ;; temporarily while we write it.
3881 ;; But no need to do so if we have just backed it up
3882 ;; (setmodes is set) because that says we're superseding.
3883 (cond ((and tempsetmodes (not setmodes))
3884 ;; Change the mode back, after writing.
3885 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3886 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3887 (let (success)
3888 (unwind-protect
3889 (progn
3890 (write-region (point-min) (point-max)
3891 buffer-file-name nil t buffer-file-truename)
3892 (setq success t))
3893 ;; If we get an error writing the new file, and we made
3894 ;; the backup by renaming, undo the backing-up.
3895 (and setmodes (not success)
3896 (progn
3897 (rename-file (cdr setmodes) buffer-file-name t)
3898 (setq buffer-backed-up nil)))))))
3899 setmodes))
3901 (defun diff-buffer-with-file (&optional buffer)
3902 "View the differences between BUFFER and its associated file.
3903 This requires the external program `diff' to be in your `exec-path'."
3904 (interactive "bBuffer: ")
3905 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3906 (if (and buffer-file-name
3907 (file-exists-p buffer-file-name))
3908 (let ((tempfile (make-temp-file "buffer-content-")))
3909 (unwind-protect
3910 (save-restriction
3911 (widen)
3912 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3913 (diff buffer-file-name tempfile nil t)
3914 (sit-for 0))
3915 (when (file-exists-p tempfile)
3916 (delete-file tempfile))))
3917 (message "Buffer %s has no associated file on disc" (buffer-name))
3918 ;; Display that message for 1 second so that user can read it
3919 ;; in the minibuffer.
3920 (sit-for 1)))
3921 ;; return always nil, so that save-buffers-kill-emacs will not move
3922 ;; over to the next unsaved buffer when calling `d'.
3923 nil)
3925 (defvar save-some-buffers-action-alist
3926 '((?\C-r
3927 (lambda (buf)
3928 (view-buffer buf
3929 (lambda (ignore)
3930 (exit-recursive-edit)))
3931 (recursive-edit)
3932 ;; Return nil to ask about BUF again.
3933 nil)
3934 "view this buffer")
3935 (?d (lambda (buf)
3936 (save-window-excursion
3937 (diff-buffer-with-file buf))
3938 (view-buffer (get-buffer-create "*Diff*")
3939 (lambda (ignore) (exit-recursive-edit)))
3940 (recursive-edit)
3941 nil)
3942 "view changes in this buffer"))
3943 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3945 (defvar buffer-save-without-query nil
3946 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3947 (make-variable-buffer-local 'buffer-save-without-query)
3949 (defun save-some-buffers (&optional arg pred)
3950 "Save some modified file-visiting buffers. Asks user about each one.
3951 You can answer `y' to save, `n' not to save, `C-r' to look at the
3952 buffer in question with `view-buffer' before deciding or `d' to
3953 view the differences using `diff-buffer-with-file'.
3955 Optional argument (the prefix) non-nil means save all with no questions.
3956 Optional second argument PRED determines which buffers are considered:
3957 If PRED is nil, all the file-visiting buffers are considered.
3958 If PRED is t, then certain non-file buffers will also be considered.
3959 If PRED is a zero-argument function, it indicates for each buffer whether
3960 to consider it or not when called with that buffer current.
3962 See `save-some-buffers-action-alist' if you want to
3963 change the additional actions you can take on files."
3964 (interactive "P")
3965 (save-window-excursion
3966 (let* (queried some-automatic
3967 files-done abbrevs-done)
3968 (dolist (buffer (buffer-list))
3969 ;; First save any buffers that we're supposed to save unconditionally.
3970 ;; That way the following code won't ask about them.
3971 (with-current-buffer buffer
3972 (when (and buffer-save-without-query (buffer-modified-p))
3973 (setq some-automatic t)
3974 (save-buffer))))
3975 ;; Ask about those buffers that merit it,
3976 ;; and record the number thus saved.
3977 (setq files-done
3978 (map-y-or-n-p
3979 (function
3980 (lambda (buffer)
3981 (and (buffer-modified-p buffer)
3982 (not (buffer-base-buffer buffer))
3984 (buffer-file-name buffer)
3985 (and pred
3986 (progn
3987 (set-buffer buffer)
3988 (and buffer-offer-save (> (buffer-size) 0)))))
3989 (or (not (functionp pred))
3990 (with-current-buffer buffer (funcall pred)))
3991 (if arg
3993 (setq queried t)
3994 (if (buffer-file-name buffer)
3995 (format "Save file %s? "
3996 (buffer-file-name buffer))
3997 (format "Save buffer %s? "
3998 (buffer-name buffer)))))))
3999 (function
4000 (lambda (buffer)
4001 (set-buffer buffer)
4002 (save-buffer)))
4003 (buffer-list)
4004 '("buffer" "buffers" "save")
4005 save-some-buffers-action-alist))
4006 ;; Maybe to save abbrevs, and record whether
4007 ;; we either saved them or asked to.
4008 (and save-abbrevs abbrevs-changed
4009 (progn
4010 (if (or arg
4011 (eq save-abbrevs 'silently)
4012 (y-or-n-p (format "Save abbrevs in %s? "
4013 abbrev-file-name)))
4014 (write-abbrev-file nil))
4015 ;; Don't keep bothering user if he says no.
4016 (setq abbrevs-changed nil)
4017 (setq abbrevs-done t)))
4018 (or queried (> files-done 0) abbrevs-done
4019 (message (if some-automatic
4020 "(Some special files were saved without asking)"
4021 "(No files need saving)"))))))
4023 (defun not-modified (&optional arg)
4024 "Mark current buffer as unmodified, not needing to be saved.
4025 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
4027 It is not a good idea to use this function in Lisp programs, because it
4028 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4029 (interactive "P")
4030 (message (if arg "Modification-flag set"
4031 "Modification-flag cleared"))
4032 (set-buffer-modified-p arg))
4034 (defun toggle-read-only (&optional arg)
4035 "Change whether this buffer is visiting its file read-only.
4036 With prefix argument ARG, make the buffer read-only if ARG is
4037 positive, otherwise make it writable. If visiting file read-only
4038 and `view-read-only' is non-nil, enter view mode."
4039 (interactive "P")
4040 (if (and arg
4041 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4042 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4043 nil ; do nothing.
4044 ;; Toggle.
4045 (cond
4046 ((and buffer-read-only view-mode)
4047 (View-exit-and-edit)
4048 (make-local-variable 'view-read-only)
4049 (setq view-read-only t)) ; Must leave view mode.
4050 ((and (not buffer-read-only) view-read-only
4051 ;; If view-mode is already active, `view-mode-enter' is a nop.
4052 (not view-mode)
4053 (not (eq (get major-mode 'mode-class) 'special)))
4054 (view-mode-enter))
4055 (t (setq buffer-read-only (not buffer-read-only))
4056 (force-mode-line-update)))
4057 (if (vc-backend buffer-file-name)
4058 (message "%s" (substitute-command-keys
4059 (concat "File is under version-control; "
4060 "use \\[vc-next-action] to check in/out"))))))
4062 (defun insert-file (filename)
4063 "Insert contents of file FILENAME into buffer after point.
4064 Set mark after the inserted text.
4066 This function is meant for the user to run interactively.
4067 Don't call it from programs! Use `insert-file-contents' instead.
4068 \(Its calling sequence is different; see its documentation)."
4069 (interactive "*fInsert file: ")
4070 (insert-file-1 filename #'insert-file-contents))
4072 (defun append-to-file (start end filename)
4073 "Append the contents of the region to the end of file FILENAME.
4074 When called from a function, expects three arguments,
4075 START, END and FILENAME. START and END are buffer positions
4076 saying what text to write."
4077 (interactive "r\nFAppend to file: ")
4078 (write-region start end filename t))
4080 (defun file-newest-backup (filename)
4081 "Return most recent backup file for FILENAME or nil if no backups exist."
4082 ;; `make-backup-file-name' will get us the right directory for
4083 ;; ordinary or numeric backups. It might create a directory for
4084 ;; backups as a side-effect, according to `backup-directory-alist'.
4085 (let* ((filename (file-name-sans-versions
4086 (make-backup-file-name (expand-file-name filename))))
4087 (file (file-name-nondirectory filename))
4088 (dir (file-name-directory filename))
4089 (comp (file-name-all-completions file dir))
4090 (newest nil)
4091 tem)
4092 (while comp
4093 (setq tem (pop comp))
4094 (cond ((and (backup-file-name-p tem)
4095 (string= (file-name-sans-versions tem) file))
4096 (setq tem (concat dir tem))
4097 (if (or (null newest)
4098 (file-newer-than-file-p tem newest))
4099 (setq newest tem)))))
4100 newest))
4102 (defun rename-uniquely ()
4103 "Rename current buffer to a similar name not already taken.
4104 This function is useful for creating multiple shell process buffers
4105 or multiple mail buffers, etc."
4106 (interactive)
4107 (save-match-data
4108 (let ((base-name (buffer-name)))
4109 (and (string-match "<[0-9]+>\\'" base-name)
4110 (not (and buffer-file-name
4111 (string= base-name
4112 (file-name-nondirectory buffer-file-name))))
4113 ;; If the existing buffer name has a <NNN>,
4114 ;; which isn't part of the file name (if any),
4115 ;; then get rid of that.
4116 (setq base-name (substring base-name 0 (match-beginning 0))))
4117 (rename-buffer (generate-new-buffer-name base-name))
4118 (force-mode-line-update))))
4120 (defun make-directory (dir &optional parents)
4121 "Create the directory DIR and any nonexistent parent dirs.
4122 If DIR already exists as a directory, do nothing.
4124 Interactively, the default choice of directory to create
4125 is the current default directory for file names.
4126 That is useful when you have visited a file in a nonexistent directory.
4128 Noninteractively, the second (optional) argument PARENTS says whether
4129 to create parent directories if they don't exist. Interactively,
4130 this happens by default."
4131 (interactive
4132 (list (read-file-name "Make directory: " default-directory default-directory
4133 nil nil)
4135 ;; If default-directory is a remote directory,
4136 ;; make sure we find its make-directory handler.
4137 (setq dir (expand-file-name dir))
4138 (let ((handler (find-file-name-handler dir 'make-directory)))
4139 (if handler
4140 (funcall handler 'make-directory dir parents)
4141 (if (not parents)
4142 (make-directory-internal dir)
4143 (let ((dir (directory-file-name (expand-file-name dir)))
4144 create-list)
4145 (while (not (file-exists-p dir))
4146 (setq create-list (cons dir create-list)
4147 dir (directory-file-name (file-name-directory dir))))
4148 (while create-list
4149 (make-directory-internal (car create-list))
4150 (setq create-list (cdr create-list))))))))
4152 (put 'revert-buffer-function 'permanent-local t)
4153 (defvar revert-buffer-function nil
4154 "Function to use to revert this buffer, or nil to do the default.
4155 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4156 which are the arguments that `revert-buffer' received.")
4158 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4159 (defvar revert-buffer-insert-file-contents-function nil
4160 "Function to use to insert contents when reverting this buffer.
4161 Gets two args, first the nominal file name to use,
4162 and second, t if reading the auto-save file.
4164 The function you specify is responsible for updating (or preserving) point.")
4166 (defvar buffer-stale-function nil
4167 "Function to check whether a non-file buffer needs reverting.
4168 This should be a function with one optional argument NOCONFIRM.
4169 Auto Revert Mode passes t for NOCONFIRM. The function should return
4170 non-nil if the buffer should be reverted. A return value of
4171 `fast' means that the need for reverting was not checked, but
4172 that reverting the buffer is fast. The buffer is current when
4173 this function is called.
4175 The idea behind the NOCONFIRM argument is that it should be
4176 non-nil if the buffer is going to be reverted without asking the
4177 user. In such situations, one has to be careful with potentially
4178 time consuming operations.
4180 For more information on how this variable is used by Auto Revert mode,
4181 see Info node `(emacs)Supporting additional buffers'.")
4183 (defvar before-revert-hook nil
4184 "Normal hook for `revert-buffer' to run before reverting.
4185 If `revert-buffer-function' is used to override the normal revert
4186 mechanism, this hook is not used.")
4188 (defvar after-revert-hook nil
4189 "Normal hook for `revert-buffer' to run after reverting.
4190 Note that the hook value that it runs is the value that was in effect
4191 before reverting; that makes a difference if you have buffer-local
4192 hook functions.
4194 If `revert-buffer-function' is used to override the normal revert
4195 mechanism, this hook is not used.")
4197 (defvar revert-buffer-internal-hook)
4199 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4200 "Replace current buffer text with the text of the visited file on disk.
4201 This undoes all changes since the file was visited or saved.
4202 With a prefix argument, offer to revert from latest auto-save file, if
4203 that is more recent than the visited file.
4205 This command also works for special buffers that contain text which
4206 doesn't come from a file, but reflects some other data base instead:
4207 for example, Dired buffers and `buffer-list' buffers. In these cases,
4208 it reconstructs the buffer contents from the appropriate data base.
4210 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4211 to revert from the auto-save file when this is nil. Note that the
4212 sense of this argument is the reverse of the prefix argument, for the
4213 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4214 to nil.
4216 Optional second argument NOCONFIRM means don't ask for confirmation at
4217 all. \(The variable `revert-without-query' offers another way to
4218 revert buffers without querying for confirmation.)
4220 Optional third argument PRESERVE-MODES non-nil means don't alter
4221 the files modes. Normally we reinitialize them using `normal-mode'.
4223 If the value of `revert-buffer-function' is non-nil, it is called to
4224 do all the work for this command. Otherwise, the hooks
4225 `before-revert-hook' and `after-revert-hook' are run at the beginning
4226 and the end, and if `revert-buffer-insert-file-contents-function' is
4227 non-nil, it is called instead of rereading visited file contents."
4229 ;; I admit it's odd to reverse the sense of the prefix argument, but
4230 ;; there is a lot of code out there which assumes that the first
4231 ;; argument should be t to avoid consulting the auto-save file, and
4232 ;; there's no straightforward way to encourage authors to notice a
4233 ;; reversal of the argument sense. So I'm just changing the user
4234 ;; interface, but leaving the programmatic interface the same.
4235 (interactive (list (not current-prefix-arg)))
4236 (if revert-buffer-function
4237 (funcall revert-buffer-function ignore-auto noconfirm)
4238 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4239 (current-buffer))
4240 (let* ((auto-save-p (and (not ignore-auto)
4241 (recent-auto-save-p)
4242 buffer-auto-save-file-name
4243 (file-readable-p buffer-auto-save-file-name)
4244 (y-or-n-p
4245 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4246 (file-name (if auto-save-p
4247 buffer-auto-save-file-name
4248 buffer-file-name)))
4249 (cond ((null file-name)
4250 (error "Buffer does not seem to be associated with any file"))
4251 ((or noconfirm
4252 (and (not (buffer-modified-p))
4253 (catch 'found
4254 (dolist (regexp revert-without-query)
4255 (when (string-match regexp file-name)
4256 (throw 'found t)))))
4257 (yes-or-no-p (format "Revert buffer from file %s? "
4258 file-name)))
4259 (run-hooks 'before-revert-hook)
4260 ;; If file was backed up but has changed since,
4261 ;; we shd make another backup.
4262 (and (not auto-save-p)
4263 (not (verify-visited-file-modtime (current-buffer)))
4264 (setq buffer-backed-up nil))
4265 ;; Effectively copy the after-revert-hook status,
4266 ;; since after-find-file will clobber it.
4267 (let ((global-hook (default-value 'after-revert-hook))
4268 (local-hook (when (local-variable-p 'after-revert-hook)
4269 after-revert-hook))
4270 (inhibit-read-only t))
4271 (cond
4272 (revert-buffer-insert-file-contents-function
4273 (unless (eq buffer-undo-list t)
4274 ;; Get rid of all undo records for this buffer.
4275 (setq buffer-undo-list nil))
4276 ;; Don't make undo records for the reversion.
4277 (let ((buffer-undo-list t))
4278 (funcall revert-buffer-insert-file-contents-function
4279 file-name auto-save-p)))
4280 ((not (file-exists-p file-name))
4281 (error (if buffer-file-number
4282 "File %s no longer exists!"
4283 "Cannot revert nonexistent file %s")
4284 file-name))
4285 ((not (file-readable-p file-name))
4286 (error (if buffer-file-number
4287 "File %s no longer readable!"
4288 "Cannot revert unreadable file %s")
4289 file-name))
4291 ;; Bind buffer-file-name to nil
4292 ;; so that we don't try to lock the file.
4293 (let ((buffer-file-name nil))
4294 (or auto-save-p
4295 (unlock-buffer)))
4296 (widen)
4297 (let ((coding-system-for-read
4298 ;; Auto-saved file should be read by Emacs'
4299 ;; internal coding.
4300 (if auto-save-p 'auto-save-coding
4301 (or coding-system-for-read
4302 buffer-file-coding-system-explicit))))
4303 (if (and (not enable-multibyte-characters)
4304 coding-system-for-read
4305 (not (memq (coding-system-base
4306 coding-system-for-read)
4307 '(no-conversion raw-text))))
4308 ;; As a coding system suitable for multibyte
4309 ;; buffer is specified, make the current
4310 ;; buffer multibyte.
4311 (set-buffer-multibyte t))
4313 ;; This force after-insert-file-set-coding
4314 ;; (called from insert-file-contents) to set
4315 ;; buffer-file-coding-system to a proper value.
4316 (kill-local-variable 'buffer-file-coding-system)
4318 ;; Note that this preserves point in an intelligent way.
4319 (if preserve-modes
4320 (let ((buffer-file-format buffer-file-format))
4321 (insert-file-contents file-name (not auto-save-p)
4322 nil nil t))
4323 (insert-file-contents file-name (not auto-save-p)
4324 nil nil t)))))
4325 ;; Recompute the truename in case changes in symlinks
4326 ;; have changed the truename.
4327 (setq buffer-file-truename
4328 (abbreviate-file-name (file-truename buffer-file-name)))
4329 (after-find-file nil nil t t preserve-modes)
4330 ;; Run after-revert-hook as it was before we reverted.
4331 (setq-default revert-buffer-internal-hook global-hook)
4332 (if local-hook
4333 (set (make-local-variable 'revert-buffer-internal-hook)
4334 local-hook)
4335 (kill-local-variable 'revert-buffer-internal-hook))
4336 (run-hooks 'revert-buffer-internal-hook))
4337 t))))))
4339 (defun recover-this-file ()
4340 "Recover the visited file--get contents from its last auto-save file."
4341 (interactive)
4342 (recover-file buffer-file-name))
4344 (defun recover-file (file)
4345 "Visit file FILE, but get contents from its last auto-save file."
4346 ;; Actually putting the file name in the minibuffer should be used
4347 ;; only rarely.
4348 ;; Not just because users often use the default.
4349 (interactive "FRecover file: ")
4350 (setq file (expand-file-name file))
4351 (if (auto-save-file-name-p (file-name-nondirectory file))
4352 (error "%s is an auto-save file" (abbreviate-file-name file)))
4353 (let ((file-name (let ((buffer-file-name file))
4354 (make-auto-save-file-name))))
4355 (cond ((if (file-exists-p file)
4356 (not (file-newer-than-file-p file-name file))
4357 (not (file-exists-p file-name)))
4358 (error "Auto-save file %s not current"
4359 (abbreviate-file-name file-name)))
4360 ((save-window-excursion
4361 (with-output-to-temp-buffer "*Directory*"
4362 (buffer-disable-undo standard-output)
4363 (save-excursion
4364 (let ((switches dired-listing-switches))
4365 (if (file-symlink-p file)
4366 (setq switches (concat switches "L")))
4367 (set-buffer standard-output)
4368 ;; Use insert-directory-safely, not insert-directory,
4369 ;; because these files might not exist. In particular,
4370 ;; FILE might not exist if the auto-save file was for
4371 ;; a buffer that didn't visit a file, such as "*mail*".
4372 ;; The code in v20.x called `ls' directly, so we need
4373 ;; to emulate what `ls' did in that case.
4374 (insert-directory-safely file switches)
4375 (insert-directory-safely file-name switches))))
4376 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4377 (switch-to-buffer (find-file-noselect file t))
4378 (let ((inhibit-read-only t)
4379 ;; Keep the current buffer-file-coding-system.
4380 (coding-system buffer-file-coding-system)
4381 ;; Auto-saved file should be read with special coding.
4382 (coding-system-for-read 'auto-save-coding))
4383 (erase-buffer)
4384 (insert-file-contents file-name nil)
4385 (set-buffer-file-coding-system coding-system))
4386 (after-find-file nil nil t))
4387 (t (error "Recover-file cancelled")))))
4389 (defun recover-session ()
4390 "Recover auto save files from a previous Emacs session.
4391 This command first displays a Dired buffer showing you the
4392 previous sessions that you could recover from.
4393 To choose one, move point to the proper line and then type C-c C-c.
4394 Then you'll be asked about a number of files to recover."
4395 (interactive)
4396 (if (null auto-save-list-file-prefix)
4397 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4398 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4399 (unless (file-directory-p dir)
4400 (make-directory dir t))
4401 (unless (directory-files dir nil
4402 (concat "\\`" (regexp-quote
4403 (file-name-nondirectory
4404 auto-save-list-file-prefix)))
4406 (error "No previous sessions to recover")))
4407 (let ((ls-lisp-support-shell-wildcards t))
4408 (dired (concat auto-save-list-file-prefix "*")
4409 (concat dired-listing-switches "t")))
4410 (save-excursion
4411 (goto-char (point-min))
4412 (or (looking-at " Move to the session you want to recover,")
4413 (let ((inhibit-read-only t))
4414 ;; Each line starts with a space
4415 ;; so that Font Lock mode won't highlight the first character.
4416 (insert " Move to the session you want to recover,\n"
4417 " then type C-c C-c to select it.\n\n"
4418 " You can also delete some of these files;\n"
4419 " type d on a line to mark that file for deletion.\n\n"))))
4420 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4421 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4423 (defun recover-session-finish ()
4424 "Choose one saved session to recover auto-save files from.
4425 This command is used in the special Dired buffer created by
4426 \\[recover-session]."
4427 (interactive)
4428 ;; Get the name of the session file to recover from.
4429 (let ((file (dired-get-filename))
4430 files
4431 (buffer (get-buffer-create " *recover*")))
4432 (dired-unmark 1)
4433 (dired-do-flagged-delete t)
4434 (unwind-protect
4435 (save-excursion
4436 ;; Read in the auto-save-list file.
4437 (set-buffer buffer)
4438 (erase-buffer)
4439 (insert-file-contents file)
4440 ;; Loop thru the text of that file
4441 ;; and get out the names of the files to recover.
4442 (while (not (eobp))
4443 (let (thisfile autofile)
4444 (if (eolp)
4445 ;; This is a pair of lines for a non-file-visiting buffer.
4446 ;; Get the auto-save file name and manufacture
4447 ;; a "visited file name" from that.
4448 (progn
4449 (forward-line 1)
4450 ;; If there is no auto-save file name, the
4451 ;; auto-save-list file is probably corrupted.
4452 (unless (eolp)
4453 (setq autofile
4454 (buffer-substring-no-properties
4455 (point)
4456 (line-end-position)))
4457 (setq thisfile
4458 (expand-file-name
4459 (substring
4460 (file-name-nondirectory autofile)
4461 1 -1)
4462 (file-name-directory autofile))))
4463 (forward-line 1))
4464 ;; This pair of lines is a file-visiting
4465 ;; buffer. Use the visited file name.
4466 (progn
4467 (setq thisfile
4468 (buffer-substring-no-properties
4469 (point) (progn (end-of-line) (point))))
4470 (forward-line 1)
4471 (setq autofile
4472 (buffer-substring-no-properties
4473 (point) (progn (end-of-line) (point))))
4474 (forward-line 1)))
4475 ;; Ignore a file if its auto-save file does not exist now.
4476 (if (and autofile (file-exists-p autofile))
4477 (setq files (cons thisfile files)))))
4478 (setq files (nreverse files))
4479 ;; The file contains a pair of line for each auto-saved buffer.
4480 ;; The first line of the pair contains the visited file name
4481 ;; or is empty if the buffer was not visiting a file.
4482 ;; The second line is the auto-save file name.
4483 (if files
4484 (map-y-or-n-p "Recover %s? "
4485 (lambda (file)
4486 (condition-case nil
4487 (save-excursion (recover-file file))
4488 (error
4489 "Failed to recover `%s'" file)))
4490 files
4491 '("file" "files" "recover"))
4492 (message "No files can be recovered from this session now")))
4493 (kill-buffer buffer))))
4495 (defun kill-buffer-ask (buffer)
4496 "Kill buffer if confirmed."
4497 (when (yes-or-no-p
4498 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4499 (if (buffer-modified-p buffer)
4500 "HAS BEEN EDITED" "is unmodified")))
4501 (kill-buffer buffer)))
4503 (defun kill-some-buffers (&optional list)
4504 "Kill some buffers. Asks the user whether to kill each one of them.
4505 Non-interactively, if optional argument LIST is non-nil, it
4506 specifies the list of buffers to kill, asking for approval for each one."
4507 (interactive)
4508 (if (null list)
4509 (setq list (buffer-list)))
4510 (while list
4511 (let* ((buffer (car list))
4512 (name (buffer-name buffer)))
4513 (and name ; Can be nil for an indirect buffer
4514 ; if we killed the base buffer.
4515 (not (string-equal name ""))
4516 (/= (aref name 0) ?\s)
4517 (kill-buffer-ask buffer)))
4518 (setq list (cdr list))))
4520 (defun kill-matching-buffers (regexp &optional internal-too)
4521 "Kill buffers whose name matches the specified regexp.
4522 The optional second argument indicates whether to kill internal buffers too."
4523 (interactive "sKill buffers matching this regular expression: \nP")
4524 (dolist (buffer (buffer-list))
4525 (let ((name (buffer-name buffer)))
4526 (when (and name (not (string-equal name ""))
4527 (or internal-too (/= (aref name 0) ?\s))
4528 (string-match regexp name))
4529 (kill-buffer-ask buffer)))))
4532 (defun auto-save-mode (arg)
4533 "Toggle auto-saving of contents of current buffer.
4534 With prefix argument ARG, turn auto-saving on if positive, else off."
4535 (interactive "P")
4536 (setq buffer-auto-save-file-name
4537 (and (if (null arg)
4538 (or (not buffer-auto-save-file-name)
4539 ;; If auto-save is off because buffer has shrunk,
4540 ;; then toggling should turn it on.
4541 (< buffer-saved-size 0))
4542 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4543 (if (and buffer-file-name auto-save-visited-file-name
4544 (not buffer-read-only))
4545 buffer-file-name
4546 (make-auto-save-file-name))))
4547 ;; If -1 was stored here, to temporarily turn off saving,
4548 ;; turn it back on.
4549 (and (< buffer-saved-size 0)
4550 (setq buffer-saved-size 0))
4551 (if (interactive-p)
4552 (message "Auto-save %s (in this buffer)"
4553 (if buffer-auto-save-file-name "on" "off")))
4554 buffer-auto-save-file-name)
4556 (defun rename-auto-save-file ()
4557 "Adjust current buffer's auto save file name for current conditions.
4558 Also rename any existing auto save file, if it was made in this session."
4559 (let ((osave buffer-auto-save-file-name))
4560 (setq buffer-auto-save-file-name
4561 (make-auto-save-file-name))
4562 (if (and osave buffer-auto-save-file-name
4563 (not (string= buffer-auto-save-file-name buffer-file-name))
4564 (not (string= buffer-auto-save-file-name osave))
4565 (file-exists-p osave)
4566 (recent-auto-save-p))
4567 (rename-file osave buffer-auto-save-file-name t))))
4569 (defun make-auto-save-file-name ()
4570 "Return file name to use for auto-saves of current buffer.
4571 Does not consider `auto-save-visited-file-name' as that variable is checked
4572 before calling this function. You can redefine this for customization.
4573 See also `auto-save-file-name-p'."
4574 (if buffer-file-name
4575 (let ((handler (find-file-name-handler buffer-file-name
4576 'make-auto-save-file-name)))
4577 (if handler
4578 (funcall handler 'make-auto-save-file-name)
4579 (let ((list auto-save-file-name-transforms)
4580 (filename buffer-file-name)
4581 result uniq)
4582 ;; Apply user-specified translations
4583 ;; to the file name.
4584 (while (and list (not result))
4585 (if (string-match (car (car list)) filename)
4586 (setq result (replace-match (cadr (car list)) t nil
4587 filename)
4588 uniq (car (cddr (car list)))))
4589 (setq list (cdr list)))
4590 (if result
4591 (if uniq
4592 (setq filename (concat
4593 (file-name-directory result)
4594 (subst-char-in-string
4595 ?/ ?!
4596 (replace-regexp-in-string "!" "!!"
4597 filename))))
4598 (setq filename result)))
4599 (setq result
4600 (if (and (eq system-type 'ms-dos)
4601 (not (msdos-long-file-names)))
4602 ;; We truncate the file name to DOS 8+3 limits
4603 ;; before doing anything else, because the regexp
4604 ;; passed to string-match below cannot handle
4605 ;; extensions longer than 3 characters, multiple
4606 ;; dots, and other atrocities.
4607 (let ((fn (dos-8+3-filename
4608 (file-name-nondirectory buffer-file-name))))
4609 (string-match
4610 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4612 (concat (file-name-directory buffer-file-name)
4613 "#" (match-string 1 fn)
4614 "." (match-string 3 fn) "#"))
4615 (concat (file-name-directory filename)
4617 (file-name-nondirectory filename)
4618 "#")))
4619 ;; Make sure auto-save file names don't contain characters
4620 ;; invalid for the underlying filesystem.
4621 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4622 ;; Don't modify remote (ange-ftp) filenames
4623 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4624 (convert-standard-filename result)
4625 result))))
4627 ;; Deal with buffers that don't have any associated files. (Mail
4628 ;; mode tends to create a good number of these.)
4630 (let ((buffer-name (buffer-name))
4631 (limit 0)
4632 file-name)
4633 ;; Eliminate all slashes and backslashes by
4634 ;; replacing them with sequences that start with %.
4635 ;; Quote % also, to keep distinct names distinct.
4636 (while (string-match "[/\\%]" buffer-name limit)
4637 (let* ((character (aref buffer-name (match-beginning 0)))
4638 (replacement
4639 (cond ((eq character ?%) "%%")
4640 ((eq character ?/) "%+")
4641 ((eq character ?\\) "%-"))))
4642 (setq buffer-name (replace-match replacement t t buffer-name))
4643 (setq limit (1+ (match-end 0)))))
4644 ;; Generate the file name.
4645 (setq file-name
4646 (make-temp-file
4647 (let ((fname
4648 (expand-file-name
4649 (format "#%s#" buffer-name)
4650 ;; Try a few alternative directories, to get one we can
4651 ;; write it.
4652 (cond
4653 ((file-writable-p default-directory) default-directory)
4654 ((file-writable-p "/var/tmp/") "/var/tmp/")
4655 ("~/")))))
4656 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4657 ;; Don't modify remote (ange-ftp) filenames
4658 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4659 ;; The call to convert-standard-filename is in case
4660 ;; buffer-name includes characters not allowed by the
4661 ;; DOS/Windows filesystems. make-temp-file writes to the
4662 ;; file it creates, so we must fix the file name _before_
4663 ;; make-temp-file is called.
4664 (convert-standard-filename fname)
4665 fname))
4666 nil "#"))
4667 ;; make-temp-file creates the file,
4668 ;; but we don't want it to exist until we do an auto-save.
4669 (condition-case ()
4670 (delete-file file-name)
4671 (file-error nil))
4672 file-name)))
4674 (defun auto-save-file-name-p (filename)
4675 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4676 FILENAME should lack slashes. You can redefine this for customization."
4677 (string-match "^#.*#$" filename))
4679 (defun wildcard-to-regexp (wildcard)
4680 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4681 The generated regexp will match a filename only if the filename
4682 matches that wildcard according to shell rules. Only wildcards known
4683 by `sh' are supported."
4684 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4685 ;; Copy the initial run of non-special characters.
4686 (result (substring wildcard 0 i))
4687 (len (length wildcard)))
4688 ;; If no special characters, we're almost done.
4689 (if i
4690 (while (< i len)
4691 (let ((ch (aref wildcard i))
4693 (setq
4694 result
4695 (concat result
4696 (cond
4697 ((and (eq ch ?\[)
4698 (< (1+ i) len)
4699 (eq (aref wildcard (1+ i)) ?\]))
4700 "\\[")
4701 ((eq ch ?\[) ; [...] maps to regexp char class
4702 (progn
4703 (setq i (1+ i))
4704 (concat
4705 (cond
4706 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4707 (progn
4708 (setq i (1+ i))
4709 (if (eq (aref wildcard i) ?\])
4710 (progn
4711 (setq i (1+ i))
4712 "[^]")
4713 "[^")))
4714 ((eq (aref wildcard i) ?^)
4715 ;; Found "[^". Insert a `\0' character
4716 ;; (which cannot happen in a filename)
4717 ;; into the character class, so that `^'
4718 ;; is not the first character after `[',
4719 ;; and thus non-special in a regexp.
4720 (progn
4721 (setq i (1+ i))
4722 "[\000^"))
4723 ((eq (aref wildcard i) ?\])
4724 ;; I don't think `]' can appear in a
4725 ;; character class in a wildcard, but
4726 ;; let's be general here.
4727 (progn
4728 (setq i (1+ i))
4729 "[]"))
4730 (t "["))
4731 (prog1 ; copy everything upto next `]'.
4732 (substring wildcard
4734 (setq j (string-match
4735 "]" wildcard i)))
4736 (setq i (if j (1- j) (1- len)))))))
4737 ((eq ch ?.) "\\.")
4738 ((eq ch ?*) "[^\000]*")
4739 ((eq ch ?+) "\\+")
4740 ((eq ch ?^) "\\^")
4741 ((eq ch ?$) "\\$")
4742 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4743 ((eq ch ??) "[^\000]")
4744 (t (char-to-string ch)))))
4745 (setq i (1+ i)))))
4746 ;; Shell wildcards should match the entire filename,
4747 ;; not its part. Make the regexp say so.
4748 (concat "\\`" result "\\'")))
4750 (defcustom list-directory-brief-switches
4751 (if (eq system-type 'vax-vms) "" "-CF")
4752 "Switches for `list-directory' to pass to `ls' for brief listing."
4753 :type 'string
4754 :group 'dired)
4756 (defcustom list-directory-verbose-switches
4757 (if (eq system-type 'vax-vms)
4758 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4759 "-l")
4760 "Switches for `list-directory' to pass to `ls' for verbose listing."
4761 :type 'string
4762 :group 'dired)
4764 (defun file-expand-wildcards (pattern &optional full)
4765 "Expand wildcard pattern PATTERN.
4766 This returns a list of file names which match the pattern.
4768 If PATTERN is written as an absolute file name,
4769 the values are absolute also.
4771 If PATTERN is written as a relative file name, it is interpreted
4772 relative to the current default directory, `default-directory'.
4773 The file names returned are normally also relative to the current
4774 default directory. However, if FULL is non-nil, they are absolute."
4775 (save-match-data
4776 (let* ((nondir (file-name-nondirectory pattern))
4777 (dirpart (file-name-directory pattern))
4778 ;; A list of all dirs that DIRPART specifies.
4779 ;; This can be more than one dir
4780 ;; if DIRPART contains wildcards.
4781 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4782 (mapcar 'file-name-as-directory
4783 (file-expand-wildcards (directory-file-name dirpart)))
4784 (list dirpart)))
4785 contents)
4786 (while dirs
4787 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4788 (file-directory-p (directory-file-name (car dirs))))
4789 (let ((this-dir-contents
4790 ;; Filter out "." and ".."
4791 (delq nil
4792 (mapcar #'(lambda (name)
4793 (unless (string-match "\\`\\.\\.?\\'"
4794 (file-name-nondirectory name))
4795 name))
4796 (directory-files (or (car dirs) ".") full
4797 (wildcard-to-regexp nondir))))))
4798 (setq contents
4799 (nconc
4800 (if (and (car dirs) (not full))
4801 (mapcar (function (lambda (name) (concat (car dirs) name)))
4802 this-dir-contents)
4803 this-dir-contents)
4804 contents))))
4805 (setq dirs (cdr dirs)))
4806 contents)))
4808 (defun list-directory (dirname &optional verbose)
4809 "Display a list of files in or matching DIRNAME, a la `ls'.
4810 DIRNAME is globbed by the shell if necessary.
4811 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4812 Actions controlled by variables `list-directory-brief-switches'
4813 and `list-directory-verbose-switches'."
4814 (interactive (let ((pfx current-prefix-arg))
4815 (list (read-file-name (if pfx "List directory (verbose): "
4816 "List directory (brief): ")
4817 nil default-directory nil)
4818 pfx)))
4819 (let ((switches (if verbose list-directory-verbose-switches
4820 list-directory-brief-switches))
4821 buffer)
4822 (or dirname (setq dirname default-directory))
4823 (setq dirname (expand-file-name dirname))
4824 (with-output-to-temp-buffer "*Directory*"
4825 (setq buffer standard-output)
4826 (buffer-disable-undo standard-output)
4827 (princ "Directory ")
4828 (princ dirname)
4829 (terpri)
4830 (save-excursion
4831 (set-buffer "*Directory*")
4832 (let ((wildcard (not (file-directory-p dirname))))
4833 (insert-directory dirname switches wildcard (not wildcard)))))
4834 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4835 (with-current-buffer buffer
4836 (setq default-directory
4837 (if (file-directory-p dirname)
4838 (file-name-as-directory dirname)
4839 (file-name-directory dirname))))))
4841 (defun shell-quote-wildcard-pattern (pattern)
4842 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4844 PATTERN is assumed to represent a file-name wildcard suitable for the
4845 underlying filesystem. For Unix and GNU/Linux, the characters from the
4846 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4847 the parts of the pattern which don't include wildcard characters are
4848 quoted with double quotes.
4849 Existing quote characters in PATTERN are left alone, so you can pass
4850 PATTERN that already quotes some of the special characters."
4851 (save-match-data
4852 (cond
4853 ((memq system-type '(ms-dos windows-nt cygwin))
4854 ;; DOS/Windows don't allow `"' in file names. So if the
4855 ;; argument has quotes, we can safely assume it is already
4856 ;; quoted by the caller.
4857 (if (or (string-match "[\"]" pattern)
4858 ;; We quote [&()#$'] in case their shell is a port of a
4859 ;; Unixy shell. We quote [,=+] because stock DOS and
4860 ;; Windows shells require that in some cases, such as
4861 ;; passing arguments to batch files that use positional
4862 ;; arguments like %1.
4863 (not (string-match "[ \t;&()#$',=+]" pattern)))
4864 pattern
4865 (let ((result "\"")
4866 (beg 0)
4867 end)
4868 (while (string-match "[*?]+" pattern beg)
4869 (setq end (match-beginning 0)
4870 result (concat result (substring pattern beg end)
4871 "\""
4872 (substring pattern end (match-end 0))
4873 "\"")
4874 beg (match-end 0)))
4875 (concat result (substring pattern beg) "\""))))
4877 (let ((beg 0))
4878 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4879 (setq pattern
4880 (concat (substring pattern 0 (match-beginning 0))
4881 "\\"
4882 (substring pattern (match-beginning 0)))
4883 beg (1+ (match-end 0)))))
4884 pattern))))
4887 (defvar insert-directory-program "ls"
4888 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4890 (defcustom directory-free-space-program "df"
4891 "Program to get the amount of free space on a file system.
4892 We assume the output has the format of `df'.
4893 The value of this variable must be just a command name or file name;
4894 if you want to specify options, use `directory-free-space-args'.
4896 A value of nil disables this feature.
4898 If the function `file-system-info' is defined, it is always used in
4899 preference to the program given by this variable."
4900 :type '(choice (string :tag "Program") (const :tag "None" nil))
4901 :group 'dired)
4903 (defcustom directory-free-space-args
4904 (if (eq system-type 'darwin) "-k" "-Pk")
4905 "Options to use when running `directory-free-space-program'."
4906 :type 'string
4907 :group 'dired)
4909 (defun get-free-disk-space (dir)
4910 "Return the amount of free space on directory DIR's file system.
4911 The result is a string that gives the number of free 1KB blocks,
4912 or nil if the system call or the program which retrieve the information
4913 fail. It returns also nil when DIR is a remote directory.
4915 This function calls `file-system-info' if it is available, or invokes the
4916 program specified by `directory-free-space-program' if that is non-nil."
4917 (when (not (file-remote-p dir))
4918 ;; Try to find the number of free blocks. Non-Posix systems don't
4919 ;; always have df, but might have an equivalent system call.
4920 (if (fboundp 'file-system-info)
4921 (let ((fsinfo (file-system-info dir)))
4922 (if fsinfo
4923 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4924 (save-match-data
4925 (with-temp-buffer
4926 (when (and directory-free-space-program
4927 (eq 0 (call-process directory-free-space-program
4928 nil t nil
4929 directory-free-space-args
4930 dir)))
4931 ;; Usual format is a header line followed by a line of
4932 ;; numbers.
4933 (goto-char (point-min))
4934 (forward-line 1)
4935 (if (not (eobp))
4936 (progn
4937 ;; Move to the end of the "available blocks" number.
4938 (skip-chars-forward "^ \t")
4939 (forward-word 3)
4940 ;; Copy it into AVAILABLE.
4941 (let ((end (point)))
4942 (forward-word -1)
4943 (buffer-substring (point) end))))))))))
4945 ;; The following expression replaces `dired-move-to-filename-regexp'.
4946 (defvar directory-listing-before-filename-regexp
4947 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
4948 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
4949 ;; In some locales, month abbreviations are as short as 2 letters,
4950 ;; and they can be followed by ".".
4951 ;; In Breton, a month name can include a quote character.
4952 (month (concat l-or-quote l-or-quote "+\\.?"))
4953 (s " ")
4954 (yyyy "[0-9][0-9][0-9][0-9]")
4955 (dd "[ 0-3][0-9]")
4956 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
4957 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
4958 (zone "[-+][0-2][0-9][0-5][0-9]")
4959 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
4960 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
4961 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
4962 "\\|" yyyy "-" iso-mm-dd "\\)"))
4963 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
4964 s "+"
4965 "\\(" HH:MM "\\|" yyyy "\\)"))
4966 (western-comma (concat month s "+" dd "," s "+" yyyy))
4967 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4968 ;; omits the Kanji characters after month and day-of-month.
4969 ;; On Mac OS X 10.3, the date format in East Asian locales is
4970 ;; day-of-month digits followed by month digits.
4971 (mm "[ 0-1]?[0-9]")
4972 (east-asian
4973 (concat "\\(" mm l "?" s dd l "?" s "+"
4974 "\\|" dd s mm s "+" "\\)"
4975 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
4976 ;; The "[0-9]" below requires the previous column to end in a digit.
4977 ;; This avoids recognizing `1 may 1997' as a date in the line:
4978 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4980 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4981 ;; The ".*" below finds the last match if there are multiple matches.
4982 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4983 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4985 ;; vc dired listings provide the state or blanks between file
4986 ;; permissions and date. The state is always surrounded by
4987 ;; parantheses:
4988 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4989 ;; This is not supported yet.
4990 (concat ".*[0-9][BkKMGTPEZY]?" s
4991 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
4992 s "+"))
4993 "Regular expression to match up to the file name in a directory listing.
4994 The default value is designed to recognize dates and times
4995 regardless of the language.")
4997 (defvar insert-directory-ls-version 'unknown)
4999 ;; insert-directory
5000 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5001 ;; FULL-DIRECTORY-P is nil.
5002 ;; The single line of output must display FILE's name as it was
5003 ;; given, namely, an absolute path name.
5004 ;; - must insert exactly one line for each file if WILDCARD or
5005 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5006 ;; before the file lines, plus optional text after the file lines.
5007 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5008 ;; allowed.
5009 ;; File lines should display the basename.
5010 ;; - must be consistent with
5011 ;; - functions dired-move-to-filename, (these two define what a file line is)
5012 ;; dired-move-to-end-of-filename,
5013 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5014 ;; dired-insert-headerline
5015 ;; dired-after-subdir-garbage (defines what a "total" line is)
5016 ;; - variable dired-subdir-regexp
5017 ;; - may be passed "--dired" as the first argument in SWITCHES.
5018 ;; Filename handlers might have to remove this switch if their
5019 ;; "ls" command does not support it.
5020 (defun insert-directory (file switches &optional wildcard full-directory-p)
5021 "Insert directory listing for FILE, formatted according to SWITCHES.
5022 Leaves point after the inserted text.
5023 SWITCHES may be a string of options, or a list of strings
5024 representing individual options.
5025 Optional third arg WILDCARD means treat FILE as shell wildcard.
5026 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5027 switches do not contain `d', so that a full listing is expected.
5029 This works by running a directory listing program
5030 whose name is in the variable `insert-directory-program'.
5031 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5033 When SWITCHES contains the long `--dired' option, this function
5034 treats it specially, for the sake of dired. However, the
5035 normally equivalent short `-D' option is just passed on to
5036 `insert-directory-program', as any other option."
5037 ;; We need the directory in order to find the right handler.
5038 (let ((handler (find-file-name-handler (expand-file-name file)
5039 'insert-directory)))
5040 (if handler
5041 (funcall handler 'insert-directory file switches
5042 wildcard full-directory-p)
5043 (if (eq system-type 'vax-vms)
5044 (vms-read-directory file switches (current-buffer))
5045 (let (result (beg (point)))
5047 ;; Read the actual directory using `insert-directory-program'.
5048 ;; RESULT gets the status code.
5049 (let* (;; We at first read by no-conversion, then after
5050 ;; putting text property `dired-filename, decode one
5051 ;; bunch by one to preserve that property.
5052 (coding-system-for-read 'no-conversion)
5053 ;; This is to control encoding the arguments in call-process.
5054 (coding-system-for-write
5055 (and enable-multibyte-characters
5056 (or file-name-coding-system
5057 default-file-name-coding-system))))
5058 (setq result
5059 (if wildcard
5060 ;; Run ls in the directory part of the file pattern
5061 ;; using the last component as argument.
5062 (let ((default-directory
5063 (if (file-name-absolute-p file)
5064 (file-name-directory file)
5065 (file-name-directory (expand-file-name file))))
5066 (pattern (file-name-nondirectory file)))
5067 (call-process
5068 shell-file-name nil t nil
5069 "-c"
5070 (concat (if (memq system-type '(ms-dos windows-nt))
5072 "\\") ; Disregard Unix shell aliases!
5073 insert-directory-program
5074 " -d "
5075 (if (stringp switches)
5076 switches
5077 (mapconcat 'identity switches " "))
5078 " -- "
5079 ;; Quote some characters that have
5080 ;; special meanings in shells; but
5081 ;; don't quote the wildcards--we want
5082 ;; them to be special. We also
5083 ;; currently don't quote the quoting
5084 ;; characters in case people want to
5085 ;; use them explicitly to quote
5086 ;; wildcard characters.
5087 (shell-quote-wildcard-pattern pattern))))
5088 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5089 ;; directory if FILE is a symbolic link.
5090 (apply 'call-process
5091 insert-directory-program nil t nil
5092 (append
5093 (if (listp switches) switches
5094 (unless (equal switches "")
5095 ;; Split the switches at any spaces so we can
5096 ;; pass separate options as separate args.
5097 (split-string switches)))
5098 ;; Avoid lossage if FILE starts with `-'.
5099 '("--")
5100 (progn
5101 (if (string-match "\\`~" file)
5102 (setq file (expand-file-name file)))
5103 (list
5104 (if full-directory-p
5105 (concat (file-name-as-directory file) ".")
5106 file))))))))
5108 ;; If we got "//DIRED//" in the output, it means we got a real
5109 ;; directory listing, even if `ls' returned nonzero.
5110 ;; So ignore any errors.
5111 (when (if (stringp switches)
5112 (string-match "--dired\\>" switches)
5113 (member "--dired" switches))
5114 (save-excursion
5115 (forward-line -2)
5116 (when (looking-at "//SUBDIRED//")
5117 (forward-line -1))
5118 (if (looking-at "//DIRED//")
5119 (setq result 0))))
5121 (when (and (not (eq 0 result))
5122 (eq insert-directory-ls-version 'unknown))
5123 ;; The first time ls returns an error,
5124 ;; find the version numbers of ls,
5125 ;; and set insert-directory-ls-version
5126 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5127 ;; is equal or if the info cannot be obtained.
5128 ;; (That can mean it isn't GNU ls.)
5129 (let ((version-out
5130 (with-temp-buffer
5131 (call-process "ls" nil t nil "--version")
5132 (buffer-string))))
5133 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5134 (let* ((version (match-string 1 version-out))
5135 (split (split-string version "[.]"))
5136 (numbers (mapcar 'string-to-number split))
5137 (min '(5 2 1))
5138 comparison)
5139 (while (and (not comparison) (or numbers min))
5140 (cond ((null min)
5141 (setq comparison '>))
5142 ((null numbers)
5143 (setq comparison '<))
5144 ((> (car numbers) (car min))
5145 (setq comparison '>))
5146 ((< (car numbers) (car min))
5147 (setq comparison '<))
5149 (setq numbers (cdr numbers)
5150 min (cdr min)))))
5151 (setq insert-directory-ls-version (or comparison '=)))
5152 (setq insert-directory-ls-version nil))))
5154 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5155 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5156 (setq result 0))
5158 ;; If `insert-directory-program' failed, signal an error.
5159 (unless (eq 0 result)
5160 ;; Delete the error message it may have output.
5161 (delete-region beg (point))
5162 ;; On non-Posix systems, we cannot open a directory, so
5163 ;; don't even try, because that will always result in
5164 ;; the ubiquitous "Access denied". Instead, show the
5165 ;; command line so the user can try to guess what went wrong.
5166 (if (and (file-directory-p file)
5167 (memq system-type '(ms-dos windows-nt)))
5168 (error
5169 "Reading directory: \"%s %s -- %s\" exited with status %s"
5170 insert-directory-program
5171 (if (listp switches) (concat switches) switches)
5172 file result)
5173 ;; Unix. Access the file to get a suitable error.
5174 (access-file file "Reading directory")
5175 (error "Listing directory failed but `access-file' worked")))
5177 (when (if (stringp switches)
5178 (string-match "--dired\\>" switches)
5179 (member "--dired" switches))
5180 ;; The following overshoots by one line for an empty
5181 ;; directory listed with "--dired", but without "-a"
5182 ;; switch, where the ls output contains a
5183 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5184 ;; We take care of that case later.
5185 (forward-line -2)
5186 (when (looking-at "//SUBDIRED//")
5187 (delete-region (point) (progn (forward-line 1) (point)))
5188 (forward-line -1))
5189 (if (looking-at "//DIRED//")
5190 (let ((end (line-end-position))
5191 (linebeg (point))
5192 error-lines)
5193 ;; Find all the lines that are error messages,
5194 ;; and record the bounds of each one.
5195 (goto-char beg)
5196 (while (< (point) linebeg)
5197 (or (eql (following-char) ?\s)
5198 (push (list (point) (line-end-position)) error-lines))
5199 (forward-line 1))
5200 (setq error-lines (nreverse error-lines))
5201 ;; Now read the numeric positions of file names.
5202 (goto-char linebeg)
5203 (forward-word 1)
5204 (forward-char 3)
5205 (while (< (point) end)
5206 (let ((start (insert-directory-adj-pos
5207 (+ beg (read (current-buffer)))
5208 error-lines))
5209 (end (insert-directory-adj-pos
5210 (+ beg (read (current-buffer)))
5211 error-lines)))
5212 (if (memq (char-after end) '(?\n ?\s))
5213 ;; End is followed by \n or by " -> ".
5214 (put-text-property start end 'dired-filename t)
5215 ;; It seems that we can't trust ls's output as to
5216 ;; byte positions of filenames.
5217 (put-text-property beg (point) 'dired-filename nil)
5218 (end-of-line))))
5219 (goto-char end)
5220 (beginning-of-line)
5221 (delete-region (point) (progn (forward-line 1) (point))))
5222 ;; Take care of the case where the ls output contains a
5223 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5224 ;; and we went one line too far back (see above).
5225 (forward-line 1))
5226 (if (looking-at "//DIRED-OPTIONS//")
5227 (delete-region (point) (progn (forward-line 1) (point)))))
5229 ;; Now decode what read if necessary.
5230 (let ((coding (or coding-system-for-read
5231 file-name-coding-system
5232 default-file-name-coding-system
5233 'undecided))
5234 coding-no-eol
5235 val pos)
5236 (when (and enable-multibyte-characters
5237 (not (memq (coding-system-base coding)
5238 '(raw-text no-conversion))))
5239 ;; If no coding system is specified or detection is
5240 ;; requested, detect the coding.
5241 (if (eq (coding-system-base coding) 'undecided)
5242 (setq coding (detect-coding-region beg (point) t)))
5243 (if (not (eq (coding-system-base coding) 'undecided))
5244 (save-restriction
5245 (setq coding-no-eol
5246 (coding-system-change-eol-conversion coding 'unix))
5247 (narrow-to-region beg (point))
5248 (goto-char (point-min))
5249 (while (not (eobp))
5250 (setq pos (point)
5251 val (get-text-property (point) 'dired-filename))
5252 (goto-char (next-single-property-change
5253 (point) 'dired-filename nil (point-max)))
5254 ;; Force no eol conversion on a file name, so
5255 ;; that CR is preserved.
5256 (decode-coding-region pos (point)
5257 (if val coding-no-eol coding))
5258 (if val
5259 (put-text-property pos (point)
5260 'dired-filename t)))))))
5262 (if full-directory-p
5263 ;; Try to insert the amount of free space.
5264 (save-excursion
5265 (goto-char beg)
5266 ;; First find the line to put it on.
5267 (when (re-search-forward "^ *\\(total\\)" nil t)
5268 (let ((available (get-free-disk-space ".")))
5269 (when available
5270 ;; Replace "total" with "used", to avoid confusion.
5271 (replace-match "total used in directory" nil nil nil 1)
5272 (end-of-line)
5273 (insert " available " available)))))))))))
5275 (defun insert-directory-adj-pos (pos error-lines)
5276 "Convert `ls --dired' file name position value POS to a buffer position.
5277 File name position values returned in ls --dired output
5278 count only stdout; they don't count the error messages sent to stderr.
5279 So this function converts to them to real buffer positions.
5280 ERROR-LINES is a list of buffer positions of error message lines,
5281 of the form (START END)."
5282 (while (and error-lines (< (caar error-lines) pos))
5283 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5284 (pop error-lines))
5285 pos)
5287 (defun insert-directory-safely (file switches
5288 &optional wildcard full-directory-p)
5289 "Insert directory listing for FILE, formatted according to SWITCHES.
5291 Like `insert-directory', but if FILE does not exist, it inserts a
5292 message to that effect instead of signaling an error."
5293 (if (file-exists-p file)
5294 (insert-directory file switches wildcard full-directory-p)
5295 ;; Simulate the message printed by `ls'.
5296 (insert (format "%s: No such file or directory\n" file))))
5298 (defvar kill-emacs-query-functions nil
5299 "Functions to call with no arguments to query about killing Emacs.
5300 If any of these functions returns nil, killing Emacs is cancelled.
5301 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5302 the low level primitive, does not. See also `kill-emacs-hook'.")
5304 (defcustom confirm-kill-emacs nil
5305 "How to ask for confirmation when leaving Emacs.
5306 If nil, the default, don't ask at all. If the value is non-nil, it should
5307 be a predicate function such as `yes-or-no-p'."
5308 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5309 (const :tag "Ask with y-or-n-p" y-or-n-p)
5310 (const :tag "Don't confirm" nil))
5311 :group 'convenience
5312 :version "21.1")
5314 (defun save-buffers-kill-emacs (&optional arg)
5315 "Offer to save each buffer, then kill this Emacs process.
5316 With prefix arg, silently save all file-visiting buffers, then kill."
5317 (interactive "P")
5318 (save-some-buffers arg t)
5319 (and (or (not (memq t (mapcar (function
5320 (lambda (buf) (and (buffer-file-name buf)
5321 (buffer-modified-p buf))))
5322 (buffer-list))))
5323 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5324 (or (not (fboundp 'process-list))
5325 ;; process-list is not defined on VMS.
5326 (let ((processes (process-list))
5327 active)
5328 (while processes
5329 (and (memq (process-status (car processes)) '(run stop open listen))
5330 (process-query-on-exit-flag (car processes))
5331 (setq active t))
5332 (setq processes (cdr processes)))
5333 (or (not active)
5334 (list-processes t)
5335 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5336 ;; Query the user for other things, perhaps.
5337 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5338 (or (null confirm-kill-emacs)
5339 (funcall confirm-kill-emacs "Really exit Emacs? "))
5340 (kill-emacs)))
5342 (defun save-buffers-kill-terminal (&optional arg)
5343 "Offer to save each buffer, then kill the current connection.
5344 If the current frame has no client, kill Emacs itself.
5346 With prefix arg, silently save all file-visiting buffers, then kill.
5348 If emacsclient was started with a list of filenames to edit, then
5349 only these files will be asked to be saved."
5350 (interactive "P")
5351 (let ((proc (frame-parameter (selected-frame) 'client))
5352 (frame (selected-frame)))
5353 (if (null proc)
5354 (save-buffers-kill-emacs)
5355 (server-save-buffers-kill-terminal proc arg))))
5358 ;; We use /: as a prefix to "quote" a file name
5359 ;; so that magic file name handlers will not apply to it.
5361 (setq file-name-handler-alist
5362 (cons '("\\`/:" . file-name-non-special)
5363 file-name-handler-alist))
5365 ;; We depend on being the last handler on the list,
5366 ;; so that anything else which does need handling
5367 ;; has been handled already.
5368 ;; So it is safe for us to inhibit *all* magic file name handlers.
5370 (defun file-name-non-special (operation &rest arguments)
5371 (let ((file-name-handler-alist nil)
5372 (default-directory
5373 (if (eq operation 'insert-directory)
5374 (directory-file-name
5375 (expand-file-name
5376 (unhandled-file-name-directory default-directory)))
5377 default-directory))
5378 ;; Get a list of the indices of the args which are file names.
5379 (file-arg-indices
5380 (cdr (or (assq operation
5381 ;; The first six are special because they
5382 ;; return a file name. We want to include the /:
5383 ;; in the return value.
5384 ;; So just avoid stripping it in the first place.
5385 '((expand-file-name . nil)
5386 (file-name-directory . nil)
5387 (file-name-as-directory . nil)
5388 (directory-file-name . nil)
5389 (file-name-sans-versions . nil)
5390 (find-backup-file-name . nil)
5391 ;; `identity' means just return the first arg
5392 ;; not stripped of its quoting.
5393 (substitute-in-file-name identity)
5394 ;; `add' means add "/:" to the result.
5395 (file-truename add 0)
5396 ;; `quote' means add "/:" to buffer-file-name.
5397 (insert-file-contents quote 0)
5398 ;; `unquote-then-quote' means set buffer-file-name
5399 ;; temporarily to unquoted filename.
5400 (verify-visited-file-modtime unquote-then-quote)
5401 ;; List the arguments which are filenames.
5402 (file-name-completion 1)
5403 (file-name-all-completions 1)
5404 (write-region 2 5)
5405 (rename-file 0 1)
5406 (copy-file 0 1)
5407 (make-symbolic-link 0 1)
5408 (add-name-to-file 0 1)))
5409 ;; For all other operations, treat the first argument only
5410 ;; as the file name.
5411 '(nil 0))))
5412 method
5413 ;; Copy ARGUMENTS so we can replace elements in it.
5414 (arguments (copy-sequence arguments)))
5415 (if (symbolp (car file-arg-indices))
5416 (setq method (pop file-arg-indices)))
5417 ;; Strip off the /: from the file names that have it.
5418 (save-match-data
5419 (while (consp file-arg-indices)
5420 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5421 (and (car pair)
5422 (string-match "\\`/:" (car pair))
5423 (setcar pair
5424 (if (= (length (car pair)) 2)
5426 (substring (car pair) 2)))))
5427 (setq file-arg-indices (cdr file-arg-indices))))
5428 (cond ((eq method 'identity)
5429 (car arguments))
5430 ((eq method 'add)
5431 (concat "/:" (apply operation arguments)))
5432 ((eq method 'quote)
5433 (unwind-protect
5434 (apply operation arguments)
5435 (setq buffer-file-name (concat "/:" buffer-file-name))))
5436 ((eq method 'unquote-then-quote)
5437 (let (res)
5438 (setq buffer-file-name (substring buffer-file-name 2))
5439 (setq res (apply operation arguments))
5440 (setq buffer-file-name (concat "/:" buffer-file-name))
5441 res))
5443 (apply operation arguments)))))
5445 ;; Symbolic modes and read-file-modes.
5447 (defun file-modes-char-to-who (char)
5448 "Convert CHAR to a who-mask from a symbolic mode notation.
5449 CHAR is in [ugoa] and represents the users on which rights are applied."
5450 (cond ((= char ?u) #o4700)
5451 ((= char ?g) #o2070)
5452 ((= char ?o) #o1007)
5453 ((= char ?a) #o7777)
5454 (t (error "%c: bad `who' character" char))))
5456 (defun file-modes-char-to-right (char &optional from)
5457 "Convert CHAR to a right-mask from a symbolic mode notation.
5458 CHAR is in [rwxXstugo] and represents a right.
5459 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5460 (or from (setq from 0))
5461 (cond ((= char ?r) #o0444)
5462 ((= char ?w) #o0222)
5463 ((= char ?x) #o0111)
5464 ((= char ?s) #o1000)
5465 ((= char ?t) #o6000)
5466 ;; Rights relative to the previous file modes.
5467 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5468 ((= char ?u) (let ((uright (logand #o4700 from)))
5469 (+ uright (/ uright #o10) (/ uright #o100))))
5470 ((= char ?g) (let ((gright (logand #o2070 from)))
5471 (+ gright (/ gright #o10) (* gright #o10))))
5472 ((= char ?o) (let ((oright (logand #o1007 from)))
5473 (+ oright (* oright #o10) (* oright #o100))))
5474 (t (error "%c: bad right character" char))))
5476 (defun file-modes-rights-to-number (rights who-mask &optional from)
5477 "Convert a right string to a right-mask from a symbolic modes notation.
5478 RIGHTS is the right string, it should match \"([+=-][rwxXstugo]+)+\".
5479 WHO-MASK is the mask number of the users on which the rights are to be applied.
5480 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5481 (let* ((num-rights (or from 0))
5482 (list-rights (string-to-list rights))
5483 (op (pop list-rights)))
5484 (while (memq op '(?+ ?- ?=))
5485 (let ((num-right 0)
5486 char-right)
5487 (while (memq (setq char-right (pop list-rights))
5488 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5489 (setq num-right
5490 (logior num-right
5491 (file-modes-char-to-right char-right num-rights))))
5492 (setq num-right (logand who-mask num-right)
5493 num-rights
5494 (cond ((= op ?+) (logior num-rights num-right))
5495 ((= op ?-) (logand num-rights (lognot num-right)))
5496 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5497 op char-right)))
5498 num-rights))
5500 (defun file-modes-symbolic-to-number (modes &optional from)
5501 "Convert symbolic file modes to numeric file modes.
5502 MODES is the string to convert, it should match
5503 \"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5504 See (info \"(coreutils)File permissions\") for more information on this
5505 notation.
5506 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5507 (save-match-data
5508 (let ((case-fold-search nil)
5509 (num-modes (or from 0)))
5510 (while (/= (string-to-char modes) 0)
5511 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5512 (let ((num-who (apply 'logior 0
5513 (mapcar 'file-modes-char-to-who
5514 (match-string 1 modes)))))
5515 (when (= num-who 0)
5516 (setq num-who (default-file-modes)))
5517 (setq num-modes
5518 (file-modes-rights-to-number (substring modes (match-end 1))
5519 num-who num-modes)
5520 modes (substring modes (match-end 3))))
5521 (error "Parse error in modes near `%s'" (substring modes 0))))
5522 num-modes)))
5524 (defun read-file-modes (&optional prompt orig-file)
5525 "Read file modes in octal or symbolic notation.
5526 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5527 ORIG-FILE is the original file of which modes will be change."
5528 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5529 (error "File not found")))
5530 (value (read-string (or prompt "File modes (octal or symbolic): "))))
5531 (save-match-data
5532 (if (string-match "^[0-7]+" value)
5533 (string-to-number value 8)
5534 (file-modes-symbolic-to-number value modes)))))
5537 (define-key ctl-x-map "\C-f" 'find-file)
5538 (define-key ctl-x-map "\C-r" 'find-file-read-only)
5539 (define-key ctl-x-map "\C-v" 'find-alternate-file)
5540 (define-key ctl-x-map "\C-s" 'save-buffer)
5541 (define-key ctl-x-map "s" 'save-some-buffers)
5542 (define-key ctl-x-map "\C-w" 'write-file)
5543 (define-key ctl-x-map "i" 'insert-file)
5544 (define-key esc-map "~" 'not-modified)
5545 (define-key ctl-x-map "\C-d" 'list-directory)
5546 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
5547 (define-key ctl-x-map "\C-q" 'toggle-read-only)
5549 (define-key ctl-x-4-map "f" 'find-file-other-window)
5550 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5551 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5552 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
5553 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5555 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5556 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5557 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5558 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5559 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
5561 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5562 ;;; files.el ends here