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