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