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