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