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