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