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