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