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