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