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