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