Commit | Line | Data |
---|---|---|
c0274f38 ER |
1 | ;;; files.el --- file input and output commands for Emacs |
2 | ||
9596811a | 3 | ;; Copyright (C) 1985, 86, 87, 92, 93, |
ffc0e1ca | 4 | ;; 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc. |
b4da00e9 | 5 | |
3a801d0c ER |
6 | ;; Maintainer: FSF |
7 | ||
b4da00e9 RM |
8 | ;; This file is part of GNU Emacs. |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 12 | ;; the Free Software Foundation; either version 2, or (at your option) |
b4da00e9 RM |
13 | ;; any later version. |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
693f800d RS |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
b4da00e9 | 24 | |
e41b2db1 ER |
25 | ;;; Commentary: |
26 | ||
27 | ;; Defines most of Emacs's file- and directory-handling functions, | |
28 | ;; including basic file visiting, backup generation, link handling, | |
29 | ;; ITS-id version control, load- and write-hook handling, and the like. | |
30 | ||
e5167999 ER |
31 | ;;; Code: |
32 | ||
21540597 RS |
33 | (defgroup backup nil |
34 | "Backups of edited data files." | |
2a9fe1e2 | 35 | :group 'files) |
b4da00e9 | 36 | |
21540597 | 37 | (defgroup find-file nil |
2a9fe1e2 RS |
38 | "Finding files." |
39 | :group 'files) | |
21540597 RS |
40 | |
41 | ||
42 | (defcustom delete-auto-save-files t | |
92631216 EZ |
43 | "*Non-nil means delete auto-save file when a buffer is saved or killed. |
44 | ||
45 | Note that auto-save file will not be deleted if the buffer is killed | |
46 | when it has unsaved changes." | |
21540597 RS |
47 | :type 'boolean |
48 | :group 'auto-save) | |
49 | ||
50 | (defcustom directory-abbrev-alist | |
b4da00e9 RM |
51 | nil |
52 | "*Alist of abbreviations for file directories. | |
53 | A list of elements of the form (FROM . TO), each meaning to replace | |
54 | FROM with TO when it appears in a directory name. This replacement is | |
55 | done when setting up the default directory of a newly visited file. | |
56 | *Every* FROM string should start with `^'. | |
57 | ||
65151a1b RS |
58 | Do not use `~' in the TO strings. |
59 | They should be ordinary absolute directory names. | |
60 | ||
b4da00e9 RM |
61 | Use this feature when you have directories which you normally refer to |
62 | via absolute symbolic links. Make TO the name of the link, and FROM | |
21540597 RS |
63 | the name it is linked to." |
64 | :type '(repeat (cons :format "%v" | |
65 | :value ("" . "") | |
66 | (regexp :tag "From") | |
67 | (regexp :tag "To"))) | |
68 | :group 'abbrev | |
69 | :group 'find-file) | |
b4da00e9 RM |
70 | |
71 | ;;; Turn off backup files on VMS since it has version numbers. | |
21540597 | 72 | (defcustom make-backup-files (not (eq system-type 'vax-vms)) |
4ea836c1 | 73 | "*Non-nil means make a backup of a file the first time it is saved. |
b4da00e9 RM |
74 | This can be done by renaming the file or by copying. |
75 | ||
76 | Renaming means that Emacs renames the existing file so that it is a | |
77 | backup file, then writes the buffer into a new file. Any other names | |
78 | that the old file had will now refer to the backup file. The new file | |
79 | is owned by you and its group is defaulted. | |
80 | ||
81 | Copying means that Emacs copies the existing file into the backup | |
82 | file, then writes the buffer on top of the existing file. Any other | |
83 | names that the old file had will now refer to the new (edited) file. | |
84 | The file's owner and group are unchanged. | |
85 | ||
86 | The choice of renaming or copying is controlled by the variables | |
ffc0e1ca AS |
87 | `backup-by-copying', `backup-by-copying-when-linked', |
88 | `backup-by-copying-when-mismatch' and | |
89 | `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'." | |
21540597 RS |
90 | :type 'boolean |
91 | :group 'backup) | |
b4da00e9 RM |
92 | |
93 | ;; Do this so that local variables based on the file name | |
94 | ;; are not overridden by the major mode. | |
95 | (defvar backup-inhibited nil | |
f862241d RS |
96 | "Non-nil means don't make a backup, regardless of the other parameters. |
97 | This variable is intended for use by making it local to a buffer. | |
98 | But it is local only if you make it local.") | |
b4da00e9 RM |
99 | (put 'backup-inhibited 'permanent-local t) |
100 | ||
21540597 | 101 | (defcustom backup-by-copying nil |
b4da00e9 | 102 | "*Non-nil means always use copying to create backup files. |
21540597 RS |
103 | See documentation of variable `make-backup-files'." |
104 | :type 'boolean | |
105 | :group 'backup) | |
b4da00e9 | 106 | |
21540597 | 107 | (defcustom backup-by-copying-when-linked nil |
b4da00e9 RM |
108 | "*Non-nil means use copying to create backups for files with multiple names. |
109 | This causes the alternate names to refer to the latest version as edited. | |
21540597 RS |
110 | This variable is relevant only if `backup-by-copying' is nil." |
111 | :type 'boolean | |
112 | :group 'backup) | |
b4da00e9 | 113 | |
21540597 | 114 | (defcustom backup-by-copying-when-mismatch nil |
b4da00e9 RM |
115 | "*Non-nil means create backups by copying if this preserves owner or group. |
116 | Renaming may still be used (subject to control of other variables) | |
117 | when it would not result in changing the owner or group of the file; | |
118 | that is, for files which are owned by you and whose group matches | |
119 | the default for a new file created there by you. | |
21540597 RS |
120 | This variable is relevant only if `backup-by-copying' is nil." |
121 | :type 'boolean | |
122 | :group 'backup) | |
b4da00e9 | 123 | |
ffc0e1ca AS |
124 | (defcustom backup-by-copying-when-privileged-mismatch 200 |
125 | "*Non-nil means create backups by copying to preserve a privileged owner. | |
126 | Renaming may still be used (subject to control of other variables) | |
127 | when it would not result in changing the owner of the file or if the owner | |
128 | has a user id greater than the value of this variable. This is useful | |
129 | when low-numbered uid's are used for special system users (such as root) | |
130 | that must maintain ownership of certain files. | |
131 | This variable is relevant only if `backup-by-copying' and | |
132 | `backup-by-copying-when-mismatch' are nil." | |
133 | :type '(choice (const nil) integer) | |
134 | :group 'backup) | |
135 | ||
136 | (defun normal-backup-enable-predicate (name) | |
137 | "Default `backup-enable-predicate' function. | |
138 | Checks for files in `temporary-file-directory' or | |
139 | `small-temporary-file-directory'." | |
140 | (not (or (let ((comp (compare-strings temporary-file-directory 0 nil | |
141 | name 0 nil))) | |
142 | ;; Directory is under temporary-file-directory. | |
143 | (and (not (eq comp t)) | |
144 | (< comp (- (length temporary-file-directory))))) | |
145 | (if small-temporary-file-directory | |
146 | (let ((comp (compare-strings small-temporary-file-directory | |
147 | 0 nil | |
148 | name 0 nil))) | |
149 | ;; Directory is under small-temporary-file-directory. | |
150 | (and (not (eq comp t)) | |
151 | (< comp (- (length small-temporary-file-directory))))))))) | |
152 | ||
153 | (defvar backup-enable-predicate 'normal-backup-enable-predicate | |
b4da00e9 | 154 | "Predicate that looks at a file name and decides whether to make backups. |
37193ee6 | 155 | Called with an absolute file name as argument, it returns t to enable backup.") |
b4da00e9 | 156 | |
21540597 | 157 | (defcustom buffer-offer-save nil |
ffc0e1ca AS |
158 | "*Non-nil in a buffer means always offer to save buffer on exit. |
159 | Do so even if the buffer is not visiting a file. | |
21540597 RS |
160 | Automatically local in all buffers." |
161 | :type 'boolean | |
162 | :group 'backup) | |
b4da00e9 RM |
163 | (make-variable-buffer-local 'buffer-offer-save) |
164 | ||
21540597 | 165 | (defcustom find-file-existing-other-name t |
f3e23606 RS |
166 | "*Non-nil means find a file under alternative names, in existing buffers. |
167 | This means if any existing buffer is visiting the file you want | |
21540597 RS |
168 | under another name, you get the existing buffer instead of a new buffer." |
169 | :type 'boolean | |
170 | :group 'find-file) | |
f3e23606 | 171 | |
21540597 | 172 | (defcustom find-file-visit-truename nil |
f3e23606 RS |
173 | "*Non-nil means visit a file under its truename. |
174 | The truename of a file is found by chasing all links | |
21540597 RS |
175 | both at the file level and at the levels of the containing directories." |
176 | :type 'boolean | |
177 | :group 'find-file) | |
f3e23606 | 178 | |
db8c4866 | 179 | (defcustom revert-without-query |
d7fa5aa2 | 180 | nil |
ebeb898f RS |
181 | "*Specify which files should be reverted without query. |
182 | The value is a list of regular expressions. | |
183 | If the file name matches one of these regular expressions, | |
db8c4866 | 184 | then `revert-buffer' reverts the file without querying |
21540597 | 185 | if the file has changed on disk and you have not edited the buffer." |
a0d809f2 | 186 | :type '(repeat regexp) |
21540597 | 187 | :group 'find-file) |
ebeb898f | 188 | |
f3e23606 RS |
189 | (defvar buffer-file-number nil |
190 | "The device number and file number of the file visited in the current buffer. | |
191 | The value is a list of the form (FILENUM DEVNUM). | |
192 | This pair of numbers uniquely identifies the file. | |
193 | If the buffer is visiting a new file, the value is nil.") | |
194 | (make-variable-buffer-local 'buffer-file-number) | |
195 | (put 'buffer-file-number 'permanent-local t) | |
196 | ||
de88363f RS |
197 | (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt))) |
198 | "Non-nil means that buffer-file-number uniquely identifies files.") | |
199 | ||
30966847 EZ |
200 | (defvar file-name-invalid-regexp |
201 | (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names))) | |
9959c16e | 202 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
30966847 | 203 | "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters |
edfc7f25 | 204 | "[\000-\031]\\|" ; control characters |
30966847 EZ |
205 | "\\(/\\.\\.?[^/]\\)\\|" ; leading dots |
206 | "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot | |
207 | ((memq system-type '(ms-dos windows-nt)) | |
9959c16e | 208 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
106a57a4 | 209 | "[|<>\"?*\000-\031]")) ; invalid characters |
30966847 EZ |
210 | (t "[\000]")) |
211 | "Regexp recognizing file names which aren't allowed by the filesystem.") | |
212 | ||
21540597 | 213 | (defcustom file-precious-flag nil |
b4da00e9 | 214 | "*Non-nil means protect against I/O errors while saving files. |
560f4415 | 215 | Some modes set this non-nil in particular buffers. |
4b7271c1 KH |
216 | |
217 | This feature works by writing the new contents into a temporary file | |
218 | and then renaming the temporary file to replace the original. | |
219 | In this way, any I/O error in writing leaves the original untouched, | |
220 | and there is never any instant where the file is nonexistent. | |
221 | ||
222 | Note that this feature forces backups to be made by copying. | |
560f4415 | 223 | Yet, at the same time, saving a precious file |
21540597 RS |
224 | breaks any hard links between it and other files." |
225 | :type 'boolean | |
226 | :group 'backup) | |
b4da00e9 | 227 | |
21540597 | 228 | (defcustom version-control nil |
b4da00e9 RM |
229 | "*Control use of version numbers for backup files. |
230 | t means make numeric backup versions unconditionally. | |
231 | nil means make them for files that have some already. | |
21540597 | 232 | `never' means do not make them." |
e48807d1 AS |
233 | :type '(choice (const :tag "Never" never) |
234 | (const :tag "If existing" nil) | |
235 | (other :tag "Always" t)) | |
21540597 RS |
236 | :group 'backup |
237 | :group 'vc) | |
238 | ||
239 | (defcustom dired-kept-versions 2 | |
240 | "*When cleaning directory, number of versions to keep." | |
241 | :type 'integer | |
242 | :group 'backup | |
243 | :group 'dired) | |
244 | ||
245 | (defcustom delete-old-versions nil | |
de7d5e1b | 246 | "*If t, delete excess backup versions silently. |
21540597 RS |
247 | If nil, ask confirmation. Any other value prevents any trimming." |
248 | :type '(choice (const :tag "Delete" t) | |
249 | (const :tag "Ask" nil) | |
e48807d1 | 250 | (other :tag "Leave" other)) |
21540597 RS |
251 | :group 'backup) |
252 | ||
253 | (defcustom kept-old-versions 2 | |
254 | "*Number of oldest versions to keep when a new numbered backup is made." | |
255 | :type 'integer | |
256 | :group 'backup) | |
257 | ||
258 | (defcustom kept-new-versions 2 | |
b4da00e9 | 259 | "*Number of newest versions to keep when a new numbered backup is made. |
21540597 RS |
260 | Includes the new backup. Must be > 0" |
261 | :type 'integer | |
262 | :group 'backup) | |
b4da00e9 | 263 | |
21540597 | 264 | (defcustom require-final-newline nil |
b4da00e9 RM |
265 | "*Value of t says silently ensure a file ends in a newline when it is saved. |
266 | Non-nil but not t says ask user whether to add a newline when there isn't one. | |
21540597 | 267 | nil means don't add newlines." |
ad375092 RS |
268 | :type '(choice (const :tag "Off" nil) |
269 | (const :tag "Add" t) | |
e48807d1 | 270 | (other :tag "Ask" ask)) |
21540597 | 271 | :group 'editing-basics) |
b4da00e9 | 272 | |
21540597 RS |
273 | (defcustom auto-save-default t |
274 | "*Non-nil says by default do auto-saving of every file-visiting buffer." | |
275 | :type 'boolean | |
276 | :group 'auto-save) | |
b4da00e9 | 277 | |
21540597 | 278 | (defcustom auto-save-visited-file-name nil |
b4da00e9 | 279 | "*Non-nil says auto-save a buffer in the file it is visiting, when practical. |
21540597 RS |
280 | Normally auto-save files are written under other names." |
281 | :type 'boolean | |
282 | :group 'auto-save) | |
b4da00e9 | 283 | |
ffc0e1ca AS |
284 | (defcustom auto-save-file-name-transforms |
285 | '(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)" "/tmp/\\2")) | |
286 | "*Transforms to apply to buffer file name before making auto-save file name. | |
287 | Each transform is a list (REGEXP REPLACEMENT): | |
288 | REGEXP is a regular expression to match against the file name. | |
289 | If it matches, `replace-match' is used to replace the | |
290 | matching part with REPLACEMENT. | |
291 | All the transforms in the list are tried, in the order they are listed. | |
292 | When one transform applies, its result is final; | |
293 | no further transforms are tried. | |
294 | ||
295 | The default value is set up to put the auto-save file into `/tmp' | |
296 | for editing a remote file." | |
297 | :group 'auto-save | |
298 | :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement"))) | |
299 | :version "21.1") | |
300 | ||
21540597 | 301 | (defcustom save-abbrevs nil |
b4da00e9 | 302 | "*Non-nil means save word abbrevs too when files are saved. |
21540597 RS |
303 | Loading an abbrev file sets this to t." |
304 | :type 'boolean | |
305 | :group 'abbrev) | |
b4da00e9 | 306 | |
21540597 | 307 | (defcustom find-file-run-dired t |
ffc0e1ca AS |
308 | "*Non-nil means allow `find-file' to visit directories. |
309 | To visit the directory, `find-file' runs `find-directory-functions'." | |
21540597 RS |
310 | :type 'boolean |
311 | :group 'find-file) | |
b4da00e9 | 312 | |
ffc0e1ca AS |
313 | (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect) |
314 | "*List of functions to try in sequence to visit a directory. | |
315 | Each function is called with the directory name as the sole argument | |
316 | and should return either a buffer or nil." | |
317 | :type '(hook :options (cvs-dired-noselect dired-noselect)) | |
318 | :group 'find-file) | |
319 | ||
92966e6f RS |
320 | ;;;It is not useful to make this a local variable. |
321 | ;;;(put 'find-file-not-found-hooks 'permanent-local t) | |
b4da00e9 RM |
322 | (defvar find-file-not-found-hooks nil |
323 | "List of functions to be called for `find-file' on nonexistent file. | |
324 | These functions are called as soon as the error is detected. | |
ffc0e1ca | 325 | Variable `buffer-file-name' is already set up. |
b4da00e9 RM |
326 | The functions are called in the order given until one of them returns non-nil.") |
327 | ||
92966e6f RS |
328 | ;;;It is not useful to make this a local variable. |
329 | ;;;(put 'find-file-hooks 'permanent-local t) | |
b4da00e9 RM |
330 | (defvar find-file-hooks nil |
331 | "List of functions to be called after a buffer is loaded from a file. | |
332 | The buffer's local variables (if any) will have been processed before the | |
333 | functions are called.") | |
334 | ||
b4da00e9 RM |
335 | (defvar write-file-hooks nil |
336 | "List of functions to be called before writing out a buffer to a file. | |
337 | If one of them returns non-nil, the file is considered already written | |
8c0e7b73 JB |
338 | and the rest are not called. |
339 | These hooks are considered to pertain to the visited file. | |
ffc0e1ca AS |
340 | So any buffer-local binding of `write-file-hooks' is |
341 | discarded if you change the visited file name with \\[set-visited-file-name]. | |
f82966e4 KH |
342 | |
343 | Don't make this variable buffer-local; instead, use `local-write-file-hooks'. | |
344 | See also `write-contents-hooks'.") | |
b19f1da4 BF |
345 | ;;; However, in case someone does make it local... |
346 | (put 'write-file-hooks 'permanent-local t) | |
c9dca4e0 | 347 | |
c9dca4e0 RS |
348 | (defvar local-write-file-hooks nil |
349 | "Just like `write-file-hooks', except intended for per-buffer use. | |
350 | The functions in this list are called before the ones in | |
f82966e4 KH |
351 | `write-file-hooks'. |
352 | ||
353 | This variable is meant to be used for hooks that have to do with a | |
354 | particular visited file. Therefore, it is a permanent local, so that | |
355 | changing the major mode does not clear it. However, calling | |
356 | `set-visited-file-name' does clear it.") | |
b19f1da4 BF |
357 | (make-variable-buffer-local 'local-write-file-hooks) |
358 | (put 'local-write-file-hooks 'permanent-local t) | |
8c0e7b73 JB |
359 | |
360 | (defvar write-contents-hooks nil | |
361 | "List of functions to be called before writing out a buffer to a file. | |
362 | If one of them returns non-nil, the file is considered already written | |
363 | and the rest are not called. | |
f82966e4 KH |
364 | |
365 | This variable is meant to be used for hooks that pertain to the | |
366 | buffer's contents, not to the particular visited file; thus, | |
367 | `set-visited-file-name' does not clear this variable; but changing the | |
693f800d RS |
368 | major mode does clear it. |
369 | ||
370 | This variable automatically becomes buffer-local whenever it is set. | |
659ebcc6 | 371 | If you use `add-hook' to add elements to the list, use nil for the |
693f800d | 372 | LOCAL argument. |
f82966e4 | 373 | |
8c0e7b73 | 374 | See also `write-file-hooks'.") |
f82966e4 | 375 | (make-variable-buffer-local 'write-contents-hooks) |
b4da00e9 | 376 | |
21540597 | 377 | (defcustom enable-local-variables t |
93a2702d | 378 | "*Control use of local variables in files you visit. |
b4da00e9 | 379 | The value can be t, nil or something else. |
93a2702d | 380 | A value of t means file local variables specifications are obeyed; |
b4da00e9 | 381 | nil means they are ignored; anything else means query. |
aa5fcebf KH |
382 | This variable also controls use of major modes specified in |
383 | a -*- line. | |
b4da00e9 | 384 | |
aa5fcebf KH |
385 | The command \\[normal-mode], when used interactively, |
386 | always obeys file local variable specifications and the -*- line, | |
387 | and ignores this variable." | |
21540597 RS |
388 | :type '(choice (const :tag "Obey" t) |
389 | (const :tag "Ignore" nil) | |
e48807d1 | 390 | (other :tag "Query" other)) |
21540597 | 391 | :group 'find-file) |
b4da00e9 | 392 | |
da09b92b RS |
393 | (defvar local-enable-local-variables t |
394 | "Like `enable-local-variables' but meant for buffer-local bindings. | |
aa5fcebf | 395 | The meaningful values are nil and non-nil. The default is non-nil. |
da09b92b | 396 | If a major mode sets this to nil, buffer-locally, then any local |
aa5fcebf KH |
397 | variables list in the file will be ignored. |
398 | ||
399 | This variable does not affect the use of major modes | |
400 | specified in a -*- line.") | |
da09b92b | 401 | |
21540597 | 402 | (defcustom enable-local-eval 'maybe |
d207b766 RS |
403 | "*Control processing of the \"variable\" `eval' in a file's local variables. |
404 | The value can be t, nil or something else. | |
405 | A value of t means obey `eval' variables; | |
406 | nil means ignore them; anything else means query. | |
407 | ||
408 | The command \\[normal-mode] always obeys local-variables lists | |
21540597 RS |
409 | and ignores this variable." |
410 | :type '(choice (const :tag "Obey" t) | |
411 | (const :tag "Ignore" nil) | |
e48807d1 | 412 | (other :tag "Query" other)) |
21540597 | 413 | :group 'find-file) |
b4da00e9 RM |
414 | |
415 | ;; Avoid losing in versions where CLASH_DETECTION is disabled. | |
416 | (or (fboundp 'lock-buffer) | |
231c4e10 | 417 | (defalias 'lock-buffer 'ignore)) |
b4da00e9 | 418 | (or (fboundp 'unlock-buffer) |
231c4e10 | 419 | (defalias 'unlock-buffer 'ignore)) |
a7305f6e RS |
420 | (or (fboundp 'file-locked-p) |
421 | (defalias 'file-locked-p 'ignore)) | |
93fe0a35 | 422 | |
2a9fe1e2 RS |
423 | (defvar view-read-only nil |
424 | "*Non-nil means buffers visiting files read-only, do it in view mode.") | |
425 | ||
cdda8f47 RS |
426 | (defvar temporary-file-directory |
427 | (file-name-as-directory | |
c11032b9 RS |
428 | (cond ((memq system-type '(ms-dos windows-nt)) |
429 | (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp")) | |
430 | ((memq system-type '(vax-vms axp-vms)) | |
431 | (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:")) | |
432 | (t | |
433 | (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp")))) | |
cdda8f47 | 434 | "The directory for writing temporary files.") |
c11032b9 | 435 | |
ffc0e1ca AS |
436 | (defvar small-temporary-file-directory |
437 | (if (eq system-type 'ms-dos) (getenv "TMPDIR")) | |
438 | "The directory for writing small temporary files. | |
439 | If non-nil, this directory is used instead of `temporary-file-directory' | |
440 | by programs that create small temporary files. This is for systems that | |
441 | have fast storage with limited space, such as a RAM disk.") | |
442 | ||
03511cfd RS |
443 | ;; The system null device. (Should reference NULL_DEVICE from C.) |
444 | (defvar null-device "/dev/null" "The system null device.") | |
445 | ||
93fe0a35 | 446 | (defun ange-ftp-completion-hook-function (op &rest args) |
ffc0e1ca AS |
447 | "Provides support for ange-ftp host name completion. |
448 | Runs the usual ange-ftp hook, but only for completion operations." | |
449 | ;; Having this here avoids the need to load ange-ftp when it's not | |
450 | ;; really in use. | |
93fe0a35 RS |
451 | (if (memq op '(file-name-completion file-name-all-completions)) |
452 | (apply 'ange-ftp-hook-function op args) | |
57e81f57 RS |
453 | (let ((inhibit-file-name-handlers |
454 | (cons 'ange-ftp-completion-hook-function | |
455 | (and (eq inhibit-file-name-operation op) | |
456 | inhibit-file-name-handlers))) | |
457 | (inhibit-file-name-operation op)) | |
93fe0a35 | 458 | (apply op args)))) |
567c1ca9 RS |
459 | |
460 | (defun convert-standard-filename (filename) | |
461 | "Convert a standard file's name to something suitable for the current OS. | |
462 | This function's standard definition is trivial; it just returns the argument. | |
ffc0e1ca AS |
463 | However, on some systems, the function is redefined with a definition |
464 | that really does change some file names to canonicalize certain | |
465 | patterns and to guarantee valid names." | |
567c1ca9 | 466 | filename) |
b4da00e9 RM |
467 | \f |
468 | (defun pwd () | |
469 | "Show the current default directory." | |
470 | (interactive nil) | |
471 | (message "Directory %s" default-directory)) | |
472 | ||
231c4e10 ER |
473 | (defvar cd-path nil |
474 | "Value of the CDPATH environment variable, as a list. | |
9ee45b2c | 475 | Not actually set up until the first time you use it.") |
231c4e10 ER |
476 | |
477 | (defun parse-colon-path (cd-path) | |
ffc0e1ca AS |
478 | "Explode a colon-separated search path into a list of directory names. |
479 | \(For values of `colon' equal to `path-separator'.)" | |
480 | ;; We could use split-string here. | |
231c4e10 ER |
481 | (and cd-path |
482 | (let (cd-prefix cd-list (cd-start 0) cd-colon) | |
306faa42 RS |
483 | (setq cd-path (concat cd-path path-separator)) |
484 | (while (setq cd-colon (string-match path-separator cd-path cd-start)) | |
231c4e10 | 485 | (setq cd-list |
9daefb36 | 486 | (nconc cd-list |
c52e4104 RS |
487 | (list (if (= cd-start cd-colon) |
488 | nil | |
489 | (substitute-in-file-name | |
e33e80e4 RS |
490 | (file-name-as-directory |
491 | (substring cd-path cd-start cd-colon))))))) | |
231c4e10 ER |
492 | (setq cd-start (+ cd-colon 1))) |
493 | cd-list))) | |
494 | ||
495 | (defun cd-absolute (dir) | |
30c5ce9c | 496 | "Change current directory to given absolute file name DIR." |
f4a0f59b RS |
497 | ;; Put the name into directory syntax now, |
498 | ;; because otherwise expand-file-name may give some bad results. | |
b4da00e9 RM |
499 | (if (not (eq system-type 'vax-vms)) |
500 | (setq dir (file-name-as-directory dir))) | |
f4a0f59b | 501 | (setq dir (abbreviate-file-name (expand-file-name dir))) |
b4da00e9 | 502 | (if (not (file-directory-p dir)) |
83c6f446 RS |
503 | (if (file-exists-p dir) |
504 | (error "%s is not a directory" dir) | |
31c691c1 | 505 | (error "%s: no such directory" dir)) |
b4da00e9 RM |
506 | (if (file-executable-p dir) |
507 | (setq default-directory dir) | |
9daefb36 | 508 | (error "Cannot cd to %s: Permission denied" dir)))) |
b4da00e9 | 509 | |
231c4e10 ER |
510 | (defun cd (dir) |
511 | "Make DIR become the current buffer's default directory. | |
30c5ce9c RS |
512 | If your environment includes a `CDPATH' variable, try each one of that |
513 | colon-separated list of directories when resolving a relative directory name." | |
dac4ea74 RS |
514 | (interactive |
515 | (list (read-file-name "Change default directory: " | |
2121cd9c RM |
516 | default-directory default-directory |
517 | (and (member cd-path '(nil ("./"))) | |
518 | (null (getenv "CDPATH")))))) | |
30c5ce9c RS |
519 | (if (file-name-absolute-p dir) |
520 | (cd-absolute (expand-file-name dir)) | |
521 | (if (null cd-path) | |
522 | (let ((trypath (parse-colon-path (getenv "CDPATH")))) | |
523 | (setq cd-path (or trypath (list "./"))))) | |
524 | (if (not (catch 'found | |
525 | (mapcar | |
526 | (function (lambda (x) | |
527 | (let ((f (expand-file-name (concat x dir)))) | |
528 | (if (file-directory-p f) | |
529 | (progn | |
530 | (cd-absolute f) | |
531 | (throw 'found t)))))) | |
532 | cd-path) | |
533 | nil)) | |
534 | (error "No such directory found via CDPATH environment variable")))) | |
231c4e10 | 535 | |
b4da00e9 RM |
536 | (defun load-file (file) |
537 | "Load the Lisp file named FILE." | |
538 | (interactive "fLoad file: ") | |
ffc0e1ca AS |
539 | (let ((completion-ignored-extensions |
540 | (delete ".elc" completion-ignored-extensions))) | |
541 | (load (expand-file-name file) nil nil t))) | |
b4da00e9 RM |
542 | |
543 | (defun load-library (library) | |
544 | "Load the library named LIBRARY. | |
545 | This is an interface to the function `load'." | |
546 | (interactive "sLoad library: ") | |
547 | (load library)) | |
5d68c2c2 | 548 | |
ffc0e1ca | 549 | (defun file-local-copy (file) |
5d68c2c2 RS |
550 | "Copy the file FILE into a temporary file on this machine. |
551 | Returns the name of the local copy, or nil, if FILE is directly | |
552 | accessible." | |
ffc0e1ca AS |
553 | ;; This formerly had an optional BUFFER argument that wasn't used by |
554 | ;; anything. | |
6eaebaa2 | 555 | (let ((handler (find-file-name-handler file 'file-local-copy))) |
5d68c2c2 RS |
556 | (if handler |
557 | (funcall handler 'file-local-copy file) | |
558 | nil))) | |
f3e23606 | 559 | |
05ef1cda | 560 | (defun file-truename (filename &optional counter prev-dirs) |
f3e23606 RS |
561 | "Return the truename of FILENAME, which should be absolute. |
562 | The truename of a file name is found by chasing symbolic links | |
563 | both at the level of the file and at the level of the directories | |
05ef1cda RS |
564 | containing it, until no links are left at any level. |
565 | ||
566 | The arguments COUNTER and PREV-DIRS are used only in recursive calls. | |
567 | Do not specify them in other calls." | |
568 | ;; COUNTER can be a cons cell whose car is the count of how many more links | |
569 | ;; to chase before getting an error. | |
570 | ;; PREV-DIRS can be a cons cell whose car is an alist | |
571 | ;; of truenames we've just recently computed. | |
cc37a58c | 572 | |
cc37a58c SM |
573 | ;; The last test looks dubious, maybe `+' is meant here? --simon. |
574 | (if (or (string= filename "") (string= filename "~") | |
7a5a26a6 RS |
575 | (and (string= (substring filename 0 1) "~") |
576 | (string-match "~[^/]*" filename))) | |
1cc2fbeb RS |
577 | (progn |
578 | (setq filename (expand-file-name filename)) | |
579 | (if (string= filename "") | |
580 | (setq filename "/")))) | |
05ef1cda | 581 | (or counter (setq counter (list 100))) |
b505828b RS |
582 | (let (done |
583 | ;; For speed, remove the ange-ftp completion handler from the list. | |
584 | ;; We know it's not needed here. | |
585 | ;; For even more speed, do this only on the outermost call. | |
586 | (file-name-handler-alist | |
587 | (if prev-dirs file-name-handler-alist | |
588 | (let ((tem (copy-sequence file-name-handler-alist))) | |
589 | (delq (rassq 'ange-ftp-completion-hook-function tem) tem))))) | |
590 | (or prev-dirs (setq prev-dirs (list nil))) | |
b1667e6c GV |
591 | |
592 | ;; andrewi@harlequin.co.uk - none of the following code (except for | |
593 | ;; invoking the file-name handler) currently applies on Windows | |
594 | ;; (ie. there are no native symlinks), but there is an issue with | |
595 | ;; case differences being ignored by the OS, and short "8.3 DOS" | |
596 | ;; name aliases existing for all files. (The short names are not | |
597 | ;; reported by directory-files, but can be used to refer to files.) | |
598 | ;; It seems appropriate for file-truename to resolve these issues in | |
599 | ;; the most natural way, which on Windows is to call the function | |
600 | ;; `w32-long-file-name' - this returns the exact name of a file as | |
601 | ;; it is stored on disk (expanding short name aliases with the full | |
602 | ;; name in the process). | |
603 | (if (eq system-type 'windows-nt) | |
604 | (let ((handler (find-file-name-handler filename 'file-truename)) | |
605 | newname) | |
606 | ;; For file name that has a special handler, call handler. | |
607 | ;; This is so that ange-ftp can save time by doing a no-op. | |
608 | (if handler | |
609 | (setq filename (funcall handler 'file-truename filename)) | |
610 | ;; If filename contains a wildcard, newname will be the old name. | |
ffc0e1ca | 611 | (if (string-match "[[*?]" filename) |
b1667e6c GV |
612 | (setq newname filename) |
613 | ;; If filename doesn't exist, newname will be nil. | |
614 | (setq newname (w32-long-file-name filename))) | |
615 | (setq filename (or newname filename))) | |
616 | (setq done t))) | |
617 | ||
05ef1cda RS |
618 | ;; If this file directly leads to a link, process that iteratively |
619 | ;; so that we don't use lots of stack. | |
620 | (while (not done) | |
621 | (setcar counter (1- (car counter))) | |
622 | (if (< (car counter) 0) | |
623 | (error "Apparent cycle of symbolic links for %s" filename)) | |
624 | (let ((handler (find-file-name-handler filename 'file-truename))) | |
625 | ;; For file name that has a special handler, call handler. | |
626 | ;; This is so that ange-ftp can save time by doing a no-op. | |
627 | (if handler | |
628 | (setq filename (funcall handler 'file-truename filename) | |
629 | done t) | |
fb145562 | 630 | (let ((dir (or (file-name-directory filename) default-directory)) |
05ef1cda RS |
631 | target dirfile) |
632 | ;; Get the truename of the directory. | |
633 | (setq dirfile (directory-file-name dir)) | |
634 | ;; If these are equal, we have the (or a) root directory. | |
635 | (or (string= dir dirfile) | |
636 | ;; If this is the same dir we last got the truename for, | |
637 | ;; save time--don't recalculate. | |
638 | (if (assoc dir (car prev-dirs)) | |
639 | (setq dir (cdr (assoc dir (car prev-dirs)))) | |
640 | (let ((old dir) | |
641 | (new (file-name-as-directory (file-truename dirfile counter prev-dirs)))) | |
642 | (setcar prev-dirs (cons (cons old new) (car prev-dirs))) | |
643 | (setq dir new)))) | |
644 | (if (equal ".." (file-name-nondirectory filename)) | |
645 | (setq filename | |
646 | (directory-file-name (file-name-directory (directory-file-name dir))) | |
647 | done t) | |
648 | (if (equal "." (file-name-nondirectory filename)) | |
649 | (setq filename (directory-file-name dir) | |
650 | done t) | |
651 | ;; Put it back on the file name. | |
652 | (setq filename (concat dir (file-name-nondirectory filename))) | |
653 | ;; Is the file name the name of a link? | |
654 | (setq target (file-symlink-p filename)) | |
655 | (if target | |
656 | ;; Yes => chase that link, then start all over | |
657 | ;; since the link may point to a directory name that uses links. | |
658 | ;; We can't safely use expand-file-name here | |
659 | ;; since target might look like foo/../bar where foo | |
660 | ;; is itself a link. Instead, we handle . and .. above. | |
661 | (setq filename | |
662 | (if (file-name-absolute-p target) | |
663 | target | |
664 | (concat dir target)) | |
665 | done nil) | |
666 | ;; No, we are done! | |
667 | (setq done t)))))))) | |
668 | filename)) | |
5dbfdacd | 669 | |
5dadeb29 RS |
670 | (defun file-chase-links (filename) |
671 | "Chase links in FILENAME until a name that is not a link. | |
672 | Does not examine containing directories for links, | |
673 | unlike `file-truename'." | |
674 | (let (tem (count 100) (newname filename)) | |
675 | (while (setq tem (file-symlink-p newname)) | |
9695aac6 RS |
676 | (save-match-data |
677 | (if (= count 0) | |
678 | (error "Apparent cycle of symbolic links for %s" filename)) | |
679 | ;; In the context of a link, `//' doesn't mean what Emacs thinks. | |
680 | (while (string-match "//+" tem) | |
681 | (setq tem (replace-match "/" nil nil tem))) | |
682 | ;; Handle `..' by hand, since it needs to work in the | |
683 | ;; target of any directory symlink. | |
684 | ;; This code is not quite complete; it does not handle | |
685 | ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose. | |
686 | (while (string-match "\\`\\.\\./" tem) | |
687 | (setq tem (substring tem 3)) | |
688 | (setq newname (expand-file-name newname)) | |
689 | ;; Chase links in the default dir of the symlink. | |
690 | (setq newname | |
691 | (file-chase-links | |
692 | (directory-file-name (file-name-directory newname)))) | |
693 | ;; Now find the parent of that dir. | |
694 | (setq newname (file-name-directory newname))) | |
695 | (setq newname (expand-file-name tem (file-name-directory newname))) | |
696 | (setq count (1- count)))) | |
5dadeb29 | 697 | newname)) |
b4da00e9 | 698 | \f |
467ff692 RS |
699 | (defun switch-to-buffer-other-window (buffer &optional norecord) |
700 | "Select buffer BUFFER in another window. | |
701 | Optional second arg NORECORD non-nil means | |
702 | do not put this buffer at the front of the list of recently selected ones." | |
b4da00e9 RM |
703 | (interactive "BSwitch to buffer in other window: ") |
704 | (let ((pop-up-windows t)) | |
467ff692 | 705 | (pop-to-buffer buffer t norecord))) |
b4da00e9 | 706 | |
467ff692 RS |
707 | (defun switch-to-buffer-other-frame (buffer &optional norecord) |
708 | "Switch to buffer BUFFER in another frame. | |
709 | Optional second arg NORECORD non-nil means | |
710 | do not put this buffer at the front of the list of recently selected ones." | |
f98955ea JB |
711 | (interactive "BSwitch to buffer in other frame: ") |
712 | (let ((pop-up-frames t)) | |
467ff692 | 713 | (pop-to-buffer buffer t norecord) |
336b7f41 | 714 | (raise-frame (window-frame (selected-window))))) |
5bbbceb1 | 715 | |
243ce842 | 716 | (defun find-file (filename &optional wildcards) |
b4da00e9 RM |
717 | "Edit file FILENAME. |
718 | Switch to a buffer visiting file FILENAME, | |
243ce842 RS |
719 | creating one if none already exists. |
720 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, | |
ffc0e1ca AS |
721 | expand wildcards (if any) and visit multiple files. Wildcard expansion |
722 | can be suppressed by setting `find-file-wildcards'." | |
243ce842 | 723 | (interactive "FFind file: \np") |
5b8ed07b RS |
724 | (let ((value (find-file-noselect filename nil nil wildcards))) |
725 | (if (listp value) | |
726 | (mapcar 'switch-to-buffer (nreverse value)) | |
727 | (switch-to-buffer value)))) | |
82d0954a | 728 | |
243ce842 | 729 | (defun find-file-other-window (filename &optional wildcards) |
b4da00e9 RM |
730 | "Edit file FILENAME, in another window. |
731 | May create a new window, or reuse an existing one. | |
243ce842 RS |
732 | See the function `display-buffer'. |
733 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, | |
734 | expand wildcards (if any) and visit multiple files." | |
735 | (interactive "FFind file in other window: \np") | |
5b8ed07b RS |
736 | (let ((value (find-file-noselect filename nil nil wildcards))) |
737 | (if (listp value) | |
738 | (progn | |
739 | (setq value (nreverse value)) | |
740 | (switch-to-buffer-other-window (car value)) | |
741 | (mapcar 'switch-to-buffer (cdr value))) | |
742 | (switch-to-buffer-other-window value)))) | |
243ce842 RS |
743 | |
744 | (defun find-file-other-frame (filename &optional wildcards) | |
f98955ea JB |
745 | "Edit file FILENAME, in another frame. |
746 | May create a new frame, or reuse an existing one. | |
243ce842 RS |
747 | See the function `display-buffer'. |
748 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, | |
749 | expand wildcards (if any) and visit multiple files." | |
750 | (interactive "FFind file in other frame: \np") | |
5b8ed07b RS |
751 | (let ((value (find-file-noselect filename nil nil wildcards))) |
752 | (if (listp value) | |
753 | (progn | |
754 | (setq value (nreverse value)) | |
755 | (switch-to-buffer-other-frame (car value)) | |
756 | (mapcar 'switch-to-buffer (cdr value))) | |
757 | (switch-to-buffer-other-frame value)))) | |
243ce842 RS |
758 | |
759 | (defun find-file-read-only (filename &optional wildcards) | |
b4da00e9 | 760 | "Edit file FILENAME but don't allow changes. |
ffc0e1ca | 761 | Like `find-file' but marks buffer as read-only. |
b4da00e9 | 762 | Use \\[toggle-read-only] to permit editing." |
243ce842 RS |
763 | (interactive "fFind file read-only: \np") |
764 | (find-file filename wildcards) | |
2a9fe1e2 | 765 | (toggle-read-only 1) |
320b4233 | 766 | (current-buffer)) |
b4da00e9 | 767 | |
243ce842 | 768 | (defun find-file-read-only-other-window (filename &optional wildcards) |
b4da00e9 RM |
769 | "Edit file FILENAME in another window but don't allow changes. |
770 | Like \\[find-file-other-window] but marks buffer as read-only. | |
771 | Use \\[toggle-read-only] to permit editing." | |
243ce842 RS |
772 | (interactive "fFind file read-only other window: \np") |
773 | (find-file-other-window filename wildcards) | |
2a9fe1e2 | 774 | (toggle-read-only 1) |
320b4233 | 775 | (current-buffer)) |
b4da00e9 | 776 | |
243ce842 | 777 | (defun find-file-read-only-other-frame (filename &optional wildcards) |
f98955ea JB |
778 | "Edit file FILENAME in another frame but don't allow changes. |
779 | Like \\[find-file-other-frame] but marks buffer as read-only. | |
5bbbceb1 | 780 | Use \\[toggle-read-only] to permit editing." |
243ce842 RS |
781 | (interactive "fFind file read-only other frame: \np") |
782 | (find-file-other-frame filename wildcards) | |
2a9fe1e2 | 783 | (toggle-read-only 1) |
320b4233 | 784 | (current-buffer)) |
5bbbceb1 | 785 | |
912192d1 | 786 | (defun find-alternate-file-other-window (filename) |
60eaf370 | 787 | "Find file FILENAME as a replacement for the file in the next window. |
912192d1 | 788 | This command does not select that window." |
60eaf370 RS |
789 | (interactive |
790 | (save-selected-window | |
791 | (other-window 1) | |
792 | (let ((file buffer-file-name) | |
793 | (file-name nil) | |
794 | (file-dir nil)) | |
795 | (and file | |
796 | (setq file-name (file-name-nondirectory file) | |
797 | file-dir (file-name-directory file))) | |
798 | (list (read-file-name | |
912192d1 | 799 | "Find alternate file: " file-dir nil nil file-name))))) |
60eaf370 | 800 | (if (one-window-p) |
912192d1 | 801 | (find-file-other-window filename) |
60eaf370 RS |
802 | (save-selected-window |
803 | (other-window 1) | |
912192d1 | 804 | (find-alternate-file filename)))) |
60eaf370 | 805 | |
912192d1 | 806 | (defun find-alternate-file (filename) |
b4da00e9 RM |
807 | "Find file FILENAME, select its buffer, kill previous buffer. |
808 | If the current buffer now contains an empty file that you just visited | |
912192d1 | 809 | \(presumably by mistake), use this command to visit the file you really want." |
b4da00e9 RM |
810 | (interactive |
811 | (let ((file buffer-file-name) | |
812 | (file-name nil) | |
813 | (file-dir nil)) | |
814 | (and file | |
815 | (setq file-name (file-name-nondirectory file) | |
816 | file-dir (file-name-directory file))) | |
a61f59b4 | 817 | (list (read-file-name |
912192d1 | 818 | "Find alternate file: " file-dir nil nil file-name)))) |
2aa8cc2d | 819 | (and (buffer-modified-p) (buffer-file-name) |
b4da00e9 RM |
820 | ;; (not buffer-read-only) |
821 | (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? " | |
822 | (buffer-name)))) | |
823 | (error "Aborted")) | |
824 | (let ((obuf (current-buffer)) | |
825 | (ofile buffer-file-name) | |
8bb27285 RS |
826 | (onum buffer-file-number) |
827 | (otrue buffer-file-truename) | |
b4da00e9 | 828 | (oname (buffer-name))) |
baf9b8c4 RS |
829 | (if (get-buffer " **lose**") |
830 | (kill-buffer " **lose**")) | |
b4da00e9 | 831 | (rename-buffer " **lose**") |
b4da00e9 RM |
832 | (unwind-protect |
833 | (progn | |
834 | (unlock-buffer) | |
a4ad4d96 RS |
835 | (setq buffer-file-name nil) |
836 | (setq buffer-file-number nil) | |
837 | (setq buffer-file-truename nil) | |
912192d1 | 838 | (find-file filename)) |
b4da00e9 RM |
839 | (cond ((eq obuf (current-buffer)) |
840 | (setq buffer-file-name ofile) | |
8bb27285 RS |
841 | (setq buffer-file-number onum) |
842 | (setq buffer-file-truename otrue) | |
b4da00e9 RM |
843 | (lock-buffer) |
844 | (rename-buffer oname)))) | |
845 | (or (eq (current-buffer) obuf) | |
846 | (kill-buffer obuf)))) | |
9b8ef27d | 847 | \f |
b4da00e9 RM |
848 | (defun create-file-buffer (filename) |
849 | "Create a suitably named buffer for visiting FILENAME, and return it. | |
850 | FILENAME (sans directory) is used unchanged if that name is free; | |
851 | otherwise a string <2> or <3> or ... is appended to get an unused name." | |
852 | (let ((lastname (file-name-nondirectory filename))) | |
853 | (if (string= lastname "") | |
854 | (setq lastname filename)) | |
855 | (generate-new-buffer lastname))) | |
856 | ||
5bbbceb1 JB |
857 | (defun generate-new-buffer (name) |
858 | "Create and return a buffer with a name based on NAME. | |
29165787 | 859 | Choose the buffer's name using `generate-new-buffer-name'." |
5bbbceb1 JB |
860 | (get-buffer-create (generate-new-buffer-name name))) |
861 | ||
ffc0e1ca AS |
862 | (defcustom automount-dir-prefix "^/tmp_mnt/" |
863 | "Regexp to match the automounter prefix in a directory name." | |
864 | :group 'files | |
865 | :type 'regexp) | |
e373f201 | 866 | |
ffb3a4db | 867 | (defvar abbreviated-home-dir nil |
ffc0e1ca | 868 | "The user's homedir abbreviated according to `directory-abbrev-alist'.") |
ffb3a4db | 869 | |
5bbbceb1 | 870 | (defun abbreviate-file-name (filename) |
29165787 | 871 | "Return a version of FILENAME shortened using `directory-abbrev-alist'. |
5bbbceb1 | 872 | This also substitutes \"~\" for the user's home directory. |
29165787 | 873 | Type \\[describe-variable] directory-abbrev-alist RET for more information." |
e373f201 | 874 | ;; Get rid of the prefixes added by the automounter. |
a8f34fc0 RS |
875 | (if (and automount-dir-prefix |
876 | (string-match automount-dir-prefix filename) | |
e373f201 JB |
877 | (file-exists-p (file-name-directory |
878 | (substring filename (1- (match-end 0)))))) | |
879 | (setq filename (substring filename (1- (match-end 0))))) | |
5bbbceb1 | 880 | (let ((tail directory-abbrev-alist)) |
ffb3a4db RS |
881 | ;; If any elt of directory-abbrev-alist matches this name, |
882 | ;; abbreviate accordingly. | |
5bbbceb1 JB |
883 | (while tail |
884 | (if (string-match (car (car tail)) filename) | |
885 | (setq filename | |
886 | (concat (cdr (car tail)) (substring filename (match-end 0))))) | |
887 | (setq tail (cdr tail))) | |
ffb3a4db RS |
888 | ;; Compute and save the abbreviated homedir name. |
889 | ;; We defer computing this until the first time it's needed, to | |
890 | ;; give time for directory-abbrev-alist to be set properly. | |
e98dda89 RS |
891 | ;; We include a slash at the end, to avoid spurious matches |
892 | ;; such as `/usr/foobar' when the home dir is `/usr/foo'. | |
ffb3a4db RS |
893 | (or abbreviated-home-dir |
894 | (setq abbreviated-home-dir | |
895 | (let ((abbreviated-home-dir "$foo")) | |
3a8a836d RS |
896 | (concat "^" (abbreviate-file-name (expand-file-name "~")) |
897 | "\\(/\\|$\\)")))) | |
76d5492b | 898 | |
ffb3a4db RS |
899 | ;; If FILENAME starts with the abbreviated homedir, |
900 | ;; make it start with `~' instead. | |
ca33ccb5 RS |
901 | (if (and (string-match abbreviated-home-dir filename) |
902 | ;; If the home dir is just /, don't change it. | |
903 | (not (and (= (match-end 0) 1) | |
288201bd | 904 | (= (aref filename 0) ?/))) |
567c1ca9 RS |
905 | ;; MS-DOS root directories can come with a drive letter; |
906 | ;; Novell Netware allows drive letters beyond `Z:'. | |
76d5492b | 907 | (not (and (or (eq system-type 'ms-dos) |
c32d49e8 | 908 | (eq system-type 'windows-nt)) |
288201bd | 909 | (save-match-data |
567c1ca9 | 910 | (string-match "^[a-zA-`]:/$" filename))))) |
5bbbceb1 | 911 | (setq filename |
28dbf501 | 912 | (concat "~" |
3a8a836d | 913 | (substring filename (match-beginning 1) (match-end 1)) |
28dbf501 | 914 | (substring filename (match-end 0))))) |
5bbbceb1 JB |
915 | filename)) |
916 | ||
21540597 | 917 | (defcustom find-file-not-true-dirname-list nil |
1770543d RS |
918 | "*List of logical names for which visiting shouldn't save the true dirname. |
919 | On VMS, when you visit a file using a logical name that searches a path, | |
920 | you may or may not want the visited file name to record the specific | |
921 | directory where the file was found. If you *do not* want that, add the logical | |
21540597 RS |
922 | name to this list as a string." |
923 | :type '(repeat (string :tag "Name")) | |
924 | :group 'find-file) | |
1770543d | 925 | |
138c44f6 KH |
926 | (defun find-buffer-visiting (filename) |
927 | "Return the buffer visiting file FILENAME (a string). | |
928 | This is like `get-file-buffer', except that it checks for any buffer | |
929 | visiting the same file, possibly under a different name. | |
930 | If there is no such live buffer, return nil." | |
931 | (let ((buf (get-file-buffer filename)) | |
932 | (truename (abbreviate-file-name (file-truename filename)))) | |
933 | (or buf | |
934 | (let ((list (buffer-list)) found) | |
935 | (while (and (not found) list) | |
936 | (save-excursion | |
937 | (set-buffer (car list)) | |
938 | (if (and buffer-file-name | |
939 | (string= buffer-file-truename truename)) | |
940 | (setq found (car list)))) | |
941 | (setq list (cdr list))) | |
942 | found) | |
0f933cf6 | 943 | (let ((number (nthcdr 10 (file-attributes truename))) |
138c44f6 | 944 | (list (buffer-list)) found) |
de88363f RS |
945 | (and buffer-file-numbers-unique |
946 | number | |
181c830f RS |
947 | (while (and (not found) list) |
948 | (save-excursion | |
949 | (set-buffer (car list)) | |
d49ab5a0 RS |
950 | (if (and buffer-file-name |
951 | (equal buffer-file-number number) | |
181c830f RS |
952 | ;; Verify this buffer's file number |
953 | ;; still belongs to its file. | |
954 | (file-exists-p buffer-file-name) | |
955 | (equal (nthcdr 10 (file-attributes buffer-file-name)) | |
956 | number)) | |
957 | (setq found (car list)))) | |
958 | (setq list (cdr list)))) | |
138c44f6 | 959 | found)))) |
9b8ef27d | 960 | \f |
5de148a2 RS |
961 | (defcustom find-file-wildcards t |
962 | "*Non-nil means file-visiting commands should handle wildcards. | |
963 | For example, if you specify `*.c', that would visit all the files | |
964 | whose names match the pattern." | |
965 | :group 'files | |
3957c982 | 966 | :version "20.4" |
5de148a2 RS |
967 | :type 'boolean) |
968 | ||
ffc0e1ca AS |
969 | (defcustom find-file-suppress-same-file-warnings nil |
970 | "*Non-nil means suppress warning messages for symlinked files. | |
971 | When nil, Emacs prints a warning when visiting a file that is already | |
972 | visited, but with a different name. Setting this option to t | |
973 | suppresses this warning." | |
974 | :group 'files | |
975 | :version "21.1" | |
976 | :type 'boolean) | |
977 | ||
243ce842 | 978 | (defun find-file-noselect (filename &optional nowarn rawfile wildcards) |
b4da00e9 RM |
979 | "Read file FILENAME into a buffer and return the buffer. |
980 | If a buffer exists visiting FILENAME, return that one, but | |
981 | verify that the file has not changed since visited or saved. | |
82d0954a KH |
982 | The buffer is not selected, just returned to the caller. |
983 | Optional first arg NOWARN non-nil means suppress any warning messages. | |
243ce842 RS |
984 | Optional second arg RAWFILE non-nil means the file is read literally. |
985 | Optional third arg WILDCARDS non-nil means do wildcard processing | |
5b8ed07b RS |
986 | and visit all the matching files. When wildcards are actually |
987 | used and expanded, the value is a list of buffers | |
988 | that are visiting the various files." | |
e373f201 JB |
989 | (setq filename |
990 | (abbreviate-file-name | |
991 | (expand-file-name filename))) | |
b4da00e9 | 992 | (if (file-directory-p filename) |
ffc0e1ca AS |
993 | (or (and find-file-run-dired |
994 | (run-hook-with-args-until-success | |
995 | 'find-directory-functions | |
996 | (if find-file-visit-truename | |
997 | (abbreviate-file-name (file-truename filename)) | |
998 | filename))) | |
999 | (error "%s is a directory" filename)) | |
243ce842 RS |
1000 | (if (and wildcards |
1001 | find-file-wildcards | |
f91fe604 | 1002 | (not (string-match "\\`/:" filename)) |
5de148a2 | 1003 | (string-match "[[*?]" filename)) |
ffc0e1ca AS |
1004 | (let ((files (condition-case nil |
1005 | (file-expand-wildcards filename t) | |
1006 | (error (list filename)))) | |
5de148a2 | 1007 | (find-file-wildcards nil)) |
f91fe604 | 1008 | (if (null files) |
ffc0e1ca | 1009 | (find-file-noselect filename) |
648ec2ff | 1010 | (mapcar #'find-file-noselect files))) |
5de148a2 RS |
1011 | (let* ((buf (get-file-buffer filename)) |
1012 | (truename (abbreviate-file-name (file-truename filename))) | |
1013 | (number (nthcdr 10 (file-attributes truename))) | |
1014 | ;; Find any buffer for a file which has same truename. | |
1015 | (other (and (not buf) (find-buffer-visiting filename)))) | |
1016 | ;; Let user know if there is a buffer with the same truename. | |
1017 | (if other | |
1018 | (progn | |
1019 | (or nowarn | |
ffc0e1ca | 1020 | find-file-suppress-same-file-warnings |
5de148a2 RS |
1021 | (string-equal filename (buffer-file-name other)) |
1022 | (message "%s and %s are the same file" | |
1023 | filename (buffer-file-name other))) | |
1024 | ;; Optionally also find that buffer. | |
1025 | (if (or find-file-existing-other-name find-file-visit-truename) | |
1026 | (setq buf other)))) | |
1027 | (if buf | |
1028 | ;; We are using an existing buffer. | |
1029 | (progn | |
1030 | (or nowarn | |
1031 | (verify-visited-file-modtime buf) | |
1032 | (cond ((not (file-exists-p filename)) | |
1033 | (error "File %s no longer exists!" filename)) | |
1034 | ;; Certain files should be reverted automatically | |
1035 | ;; if they have changed on disk and not in the buffer. | |
1036 | ((and (not (buffer-modified-p buf)) | |
1037 | (let ((tail revert-without-query) | |
1038 | (found nil)) | |
1039 | (while tail | |
1040 | (if (string-match (car tail) filename) | |
1041 | (setq found t)) | |
1042 | (setq tail (cdr tail))) | |
1043 | found)) | |
1044 | (with-current-buffer buf | |
1045 | (message "Reverting file %s..." filename) | |
1046 | (revert-buffer t t) | |
1047 | (message "Reverting file %s...done" filename))) | |
1048 | ((yes-or-no-p | |
1049 | (if (string= (file-name-nondirectory filename) | |
1050 | (buffer-name buf)) | |
1051 | (format | |
1052 | (if (buffer-modified-p buf) | |
1053 | "File %s changed on disk. Discard your edits? " | |
1054 | "File %s changed on disk. Reread from disk? ") | |
1055 | (file-name-nondirectory filename)) | |
ddd64da9 RS |
1056 | (format |
1057 | (if (buffer-modified-p buf) | |
5de148a2 RS |
1058 | "File %s changed on disk. Discard your edits in %s? " |
1059 | "File %s changed on disk. Reread from disk into %s? ") | |
1060 | (file-name-nondirectory filename) | |
1061 | (buffer-name buf)))) | |
1062 | (with-current-buffer buf | |
1063 | (revert-buffer t t))))) | |
1064 | (with-current-buffer buf | |
1065 | (when (not (eq (not (null rawfile)) | |
1066 | (not (null find-file-literally)))) | |
1067 | (if (buffer-modified-p) | |
ddd64da9 | 1068 | (if (y-or-n-p (if rawfile |
5de148a2 RS |
1069 | "Save file and revisit literally? " |
1070 | "Save file and revisit non-literally? ")) | |
1071 | (progn | |
1072 | (save-buffer) | |
1073 | (find-file-noselect-1 buf filename nowarn | |
1074 | rawfile truename number)) | |
1075 | (if (y-or-n-p (if rawfile | |
1076 | "Discard your edits and revisit file literally? " | |
1077 | "Discard your edits and revisit file non-literally? ")) | |
1078 | (find-file-noselect-1 buf filename nowarn | |
1079 | rawfile truename number) | |
1080 | (error (if rawfile "File already visited non-literally" | |
1081 | "File already visited literally")))) | |
1082 | (if (y-or-n-p (if rawfile | |
1083 | "Revisit file literally? " | |
1084 | "Revisit file non-literally? ")) | |
1085 | (find-file-noselect-1 buf filename nowarn | |
1086 | rawfile truename number) | |
1087 | (error (if rawfile "File already visited non-literally" | |
1088 | "File already visited literally")))))) | |
1089 | ;; Return the buffer we are using. | |
1090 | buf) | |
1091 | ;; Create a new buffer. | |
1092 | (setq buf (create-file-buffer filename)) | |
1093 | (set-buffer-major-mode buf) | |
1094 | ;; find-file-noselect-1 may use a different buffer. | |
1095 | (find-file-noselect-1 buf filename nowarn | |
1096 | rawfile truename number)))))) | |
ddd64da9 RS |
1097 | |
1098 | (defun find-file-noselect-1 (buf filename nowarn rawfile truename number) | |
666c1d8b RS |
1099 | (let ((inhibit-read-only t) |
1100 | error) | |
ddd64da9 RS |
1101 | (with-current-buffer buf |
1102 | (kill-local-variable 'find-file-literally) | |
b296cbd4 RS |
1103 | ;; Needed in case we are re-visiting the file with a different |
1104 | ;; text representation. | |
e73ec04b | 1105 | (kill-local-variable 'buffer-file-coding-system) |
ddd64da9 RS |
1106 | (erase-buffer) |
1107 | (and (default-value 'enable-multibyte-characters) | |
1108 | (not rawfile) | |
1109 | (set-buffer-multibyte t)) | |
1110 | (if rawfile | |
1111 | (condition-case () | |
1112 | (insert-file-contents-literally filename t) | |
1113 | (file-error | |
1114 | (when (and (file-exists-p filename) | |
1115 | (not (file-readable-p filename))) | |
1116 | (kill-buffer buf) | |
1117 | (signal 'file-error (list "File is not readable" | |
1118 | filename))) | |
1119 | ;; Unconditionally set error | |
1120 | (setq error t))) | |
1121 | (condition-case () | |
1122 | (insert-file-contents filename t) | |
1123 | (file-error | |
1124 | (when (and (file-exists-p filename) | |
1125 | (not (file-readable-p filename))) | |
1126 | (kill-buffer buf) | |
1127 | (signal 'file-error (list "File is not readable" | |
1128 | filename))) | |
1129 | ;; Run find-file-not-found-hooks until one returns non-nil. | |
1130 | (or (run-hook-with-args-until-success 'find-file-not-found-hooks) | |
1131 | ;; If they fail too, set error. | |
1132 | (setq error t))))) | |
b120e713 KH |
1133 | ;; Record the file's truename, and maybe use that as visited name. |
1134 | (if (equal filename buffer-file-name) | |
1135 | (setq buffer-file-truename truename) | |
9ab19105 DL |
1136 | (setq buffer-file-truename |
1137 | (abbreviate-file-name (file-truename buffer-file-name)))) | |
ddd64da9 RS |
1138 | (setq buffer-file-number number) |
1139 | ;; On VMS, we may want to remember which directory in a search list | |
1140 | ;; the file was found in. | |
1141 | (and (eq system-type 'vax-vms) | |
1142 | (let (logical) | |
1143 | (if (string-match ":" (file-name-directory filename)) | |
1144 | (setq logical (substring (file-name-directory filename) | |
1145 | 0 (match-beginning 0)))) | |
1146 | (not (member logical find-file-not-true-dirname-list))) | |
1147 | (setq buffer-file-name buffer-file-truename)) | |
1148 | (if find-file-visit-truename | |
1149 | (setq buffer-file-name | |
1150 | (setq filename | |
1151 | (expand-file-name buffer-file-truename)))) | |
1152 | ;; Set buffer's default directory to that of the file. | |
b120e713 | 1153 | (setq default-directory (file-name-directory buffer-file-name)) |
ddd64da9 RS |
1154 | ;; Turn off backup files for certain file names. Since |
1155 | ;; this is a permanent local, the major mode won't eliminate it. | |
1156 | (and (not (funcall backup-enable-predicate buffer-file-name)) | |
1157 | (progn | |
1158 | (make-local-variable 'backup-inhibited) | |
1159 | (setq backup-inhibited t))) | |
1160 | (if rawfile | |
1161 | (progn | |
1162 | (set-buffer-multibyte nil) | |
1163 | (setq buffer-file-coding-system 'no-conversion) | |
1164 | (make-local-variable 'find-file-literally) | |
1165 | (setq find-file-literally t)) | |
b296cbd4 RS |
1166 | (after-find-file error (not nowarn))) |
1167 | (current-buffer)))) | |
9b8ef27d RS |
1168 | \f |
1169 | (defun insert-file-contents-literally (filename &optional visit beg end replace) | |
1170 | "Like `insert-file-contents', but only reads in the file literally. | |
1171 | A buffer may be modified in several ways after reading into the buffer, | |
1172 | to Emacs features such as format decoding, character code | |
1173 | conversion, find-file-hooks, automatic uncompression, etc. | |
1174 | ||
1175 | This function ensures that none of these modifications will take place." | |
1176 | (let ((format-alist nil) | |
1177 | (after-insert-file-functions nil) | |
1178 | (coding-system-for-read 'no-conversion) | |
1179 | (coding-system-for-write 'no-conversion) | |
1180 | (jka-compr-compression-info-list nil) | |
1181 | (find-buffer-file-type-function | |
1182 | (if (fboundp 'find-buffer-file-type) | |
1183 | (symbol-function 'find-buffer-file-type) | |
1184 | nil))) | |
1185 | (unwind-protect | |
1186 | (progn | |
1187 | (fset 'find-buffer-file-type (lambda (filename) t)) | |
1188 | (insert-file-contents filename visit beg end replace)) | |
1189 | (if find-buffer-file-type-function | |
1190 | (fset 'find-buffer-file-type find-buffer-file-type-function) | |
1191 | (fmakunbound 'find-buffer-file-type))))) | |
1192 | ||
1193 | (defun insert-file-literally (filename) | |
1194 | "Insert contents of file FILENAME into buffer after point with no conversion. | |
1195 | ||
1196 | This function is meant for the user to run interactively. | |
1197 | Don't call it from programs! Use `insert-file-contents-literally' instead. | |
1198 | \(Its calling sequence is different; see its documentation)." | |
1199 | (interactive "*fInsert file literally: ") | |
1200 | (if (file-directory-p filename) | |
1201 | (signal 'file-error (list "Opening input file" "file is a directory" | |
1202 | filename))) | |
1203 | (let ((tem (insert-file-contents-literally filename))) | |
1204 | (push-mark (+ (point) (car (cdr tem)))))) | |
1205 | ||
1206 | (defvar find-file-literally nil | |
1207 | "Non-nil if this buffer was made by `find-file-literally' or equivalent. | |
1208 | This is a permanent local.") | |
1209 | (put 'find-file-literally 'permanent-local t) | |
5fc196af | 1210 | |
ffc0e1ca | 1211 | (defun find-file-literally (filename) |
5fc196af RS |
1212 | "Visit file FILENAME with no conversion of any kind. |
1213 | Format conversion and character code conversion are both disabled, | |
1214 | and multibyte characters are disabled in the resulting buffer. | |
e65db7b8 RS |
1215 | The major mode used is Fundamental mode regardless of the file name, |
1216 | and local variable specifications in the file are ignored. | |
9b8ef27d RS |
1217 | Automatic uncompression is also disabled. |
1218 | ||
1219 | You cannot absolutely rely on this function to result in | |
b9aa9537 | 1220 | visiting the file literally. If Emacs already has a buffer |
9b8ef27d RS |
1221 | which is visiting the file, you get the existing buffer, |
1222 | regardless of whether it was created literally or not. | |
1223 | ||
1224 | In a Lisp program, if you want to be sure of accessing a file's | |
1225 | contents literally, you should create a temporary buffer and then read | |
1226 | the file contents into it using `insert-file-contents-literally'." | |
5fc196af | 1227 | (interactive "FFind file literally: ") |
9b8ef27d | 1228 | (switch-to-buffer (find-file-noselect filename nil t))) |
b4da00e9 | 1229 | \f |
f7d786d0 RS |
1230 | (defvar after-find-file-from-revert-buffer nil) |
1231 | ||
e0ab8879 | 1232 | (defun after-find-file (&optional error warn noauto |
9a30563f RS |
1233 | after-find-file-from-revert-buffer |
1234 | nomodes) | |
b4da00e9 RM |
1235 | "Called after finding a file and by the default revert function. |
1236 | Sets buffer mode, parses local variables. | |
8cfb9d46 | 1237 | Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an |
b4da00e9 RM |
1238 | error in reading the file. WARN non-nil means warn if there |
1239 | exists an auto-save file more recent than the visited file. | |
8cfb9d46 | 1240 | NOAUTO means don't mess with auto-save mode. |
e0ab8879 RS |
1241 | Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil |
1242 | means this call was from `revert-buffer'. | |
9a30563f RS |
1243 | Fifth arg NOMODES non-nil means don't alter the file's modes. |
1244 | Finishes by calling the functions in `find-file-hooks' | |
1245 | unless NOMODES is non-nil." | |
b4da00e9 RM |
1246 | (setq buffer-read-only (not (file-writable-p buffer-file-name))) |
1247 | (if noninteractive | |
1248 | nil | |
1249 | (let* (not-serious | |
1250 | (msg | |
fe50b6ab GM |
1251 | (cond |
1252 | ((not warn) nil) | |
1253 | ((and error (file-attributes buffer-file-name)) | |
1254 | (setq buffer-read-only t) | |
1255 | "File exists, but cannot be read") | |
1256 | ((not buffer-read-only) | |
1257 | (if (and warn | |
1258 | ;; No need to warn if buffer is auto-saved | |
1259 | ;; under the name of the visited file. | |
1260 | (not (and buffer-file-name | |
1261 | auto-save-visited-file-name)) | |
1262 | (file-newer-than-file-p (or buffer-auto-save-file-name | |
1263 | (make-auto-save-file-name)) | |
1264 | buffer-file-name)) | |
1265 | (format "%s has auto save data; consider M-x recover-file" | |
1266 | (file-name-nondirectory buffer-file-name)) | |
1267 | (setq not-serious t) | |
1268 | (if error "(New file)" nil))) | |
1269 | ((not error) | |
1270 | (setq not-serious t) | |
1271 | "Note: file is write protected") | |
1272 | ((file-attributes (directory-file-name default-directory)) | |
1273 | "File not found and directory write-protected") | |
1274 | ((file-exists-p (file-name-directory buffer-file-name)) | |
1275 | (setq buffer-read-only nil)) | |
1276 | (t | |
1277 | (setq buffer-read-only nil) | |
1278 | (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name)))) | |
1279 | "Use M-x make-directory RET RET to create the directory" | |
1280 | "Use C-u M-x make-directory RET RET to create directory and its parents"))))) | |
1281 | (when msg | |
1282 | (message msg) | |
1283 | (or not-serious (sit-for 1 nil t)))) | |
1284 | (when (and auto-save-default (not noauto)) | |
1285 | (auto-save-mode t))) | |
ffc0e1ca AS |
1286 | ;; Make people do a little extra work (C-x C-q) |
1287 | ;; before altering a backup file. | |
fe50b6ab GM |
1288 | (when (backup-file-name-p buffer-file-name) |
1289 | (setq buffer-read-only t)) | |
1290 | (unless nomodes | |
1291 | (when (and view-read-only view-mode) | |
1292 | (view-mode-disable)) | |
9a30563f | 1293 | (normal-mode t) |
fe50b6ab GM |
1294 | (when (and buffer-read-only |
1295 | view-read-only | |
1296 | (not (eq (get major-mode 'mode-class) 'special))) | |
1297 | (view-mode-enter)) | |
9a30563f | 1298 | (run-hooks 'find-file-hooks))) |
b4da00e9 RM |
1299 | |
1300 | (defun normal-mode (&optional find-file) | |
1301 | "Choose the major mode for this buffer automatically. | |
1302 | Also sets up any specified local variables of the file. | |
1303 | Uses the visited file name, the -*- line, and the local variables spec. | |
1304 | ||
1305 | This function is called automatically from `find-file'. In that case, | |
aa5fcebf KH |
1306 | we may set up the file-specified mode and local variables, |
1307 | depending on the value of `enable-local-variables': if it is t, we do; | |
1308 | if it is nil, we don't; otherwise, we query. | |
1309 | In addition, if `local-enable-local-variables' is nil, we do | |
1310 | not set local variables (though we do notice a mode specified with -*-.) | |
1311 | ||
1312 | `enable-local-variables' is ignored if you run `normal-mode' interactively, | |
1313 | or from Lisp without specifying the optional argument FIND-FILE; | |
1314 | in that case, this function acts as if `enable-local-variables' were t." | |
b4da00e9 RM |
1315 | (interactive) |
1316 | (or find-file (funcall (or default-major-mode 'fundamental-mode))) | |
1317 | (condition-case err | |
1318 | (set-auto-mode) | |
1319 | (error (message "File mode specification error: %s" | |
1320 | (prin1-to-string err)))) | |
1321 | (condition-case err | |
7b3f3dc2 JB |
1322 | (let ((enable-local-variables (or (not find-file) |
1323 | enable-local-variables))) | |
1324 | (hack-local-variables)) | |
b4da00e9 RM |
1325 | (error (message "File local-variables error: %s" |
1326 | (prin1-to-string err))))) | |
1327 | ||
f76e0cd0 | 1328 | (defvar auto-mode-alist |
ffc0e1ca AS |
1329 | (mapc |
1330 | (lambda (elt) | |
1331 | (cons (purecopy (car elt)) (cdr elt))) | |
1332 | '(("\\.te?xt\\'" . text-mode) | |
1333 | ("\\.c\\'" . c-mode) | |
1334 | ("\\.h\\'" . c-mode) | |
1335 | ("\\.tex\\'" . tex-mode) | |
1336 | ("\\.ltx\\'" . latex-mode) | |
1337 | ("\\.el\\'" . emacs-lisp-mode) | |
1338 | ("\\.scm\\'" . scheme-mode) | |
1339 | ("\\.l\\'" . lisp-mode) | |
1340 | ("\\.lisp\\'" . lisp-mode) | |
1341 | ("\\.f\\'" . fortran-mode) | |
1342 | ("\\.F\\'" . fortran-mode) | |
1343 | ("\\.for\\'" . fortran-mode) | |
1344 | ("\\.p\\'" . pascal-mode) | |
1345 | ("\\.pas\\'" . pascal-mode) | |
1346 | ("\\.ad[abs]\\'" . ada-mode) | |
1347 | ("\\.\\([pP][Llm]\\|al\\)\\'" . perl-mode) | |
1348 | ("\\.s?html?\\'" . html-mode) | |
1349 | ("\\.cc\\'" . c++-mode) | |
1350 | ("\\.hh\\'" . c++-mode) | |
1351 | ("\\.hpp\\'" . c++-mode) | |
1352 | ("\\.C\\'" . c++-mode) | |
1353 | ("\\.H\\'" . c++-mode) | |
1354 | ("\\.cpp\\'" . c++-mode) | |
1355 | ("\\.cxx\\'" . c++-mode) | |
1356 | ("\\.hxx\\'" . c++-mode) | |
1357 | ("\\.c\\+\\+\\'" . c++-mode) | |
1358 | ("\\.h\\+\\+\\'" . c++-mode) | |
1359 | ("\\.m\\'" . objc-mode) | |
1360 | ("\\.java\\'" . java-mode) | |
1361 | ("\\.mk\\'" . makefile-mode) | |
1362 | ("\\(M\\|m\\|GNUm\\)akefile\\(\\.in\\)?\\'" . makefile-mode) | |
1363 | ("\\.am\\'" . makefile-mode) ;For Automake. | |
7b3f3dc2 JB |
1364 | ;;; Less common extensions come here |
1365 | ;;; so more common ones above are found faster. | |
ffc0e1ca AS |
1366 | ("\\.texinfo\\'" . texinfo-mode) |
1367 | ("\\.te?xi\\'" . texinfo-mode) | |
1368 | ("\\.s\\'" . asm-mode) | |
1369 | ("\\.S\\'" . asm-mode) | |
1370 | ("\\.asm\\'" . asm-mode) | |
1371 | ("ChangeLog\\'" . change-log-mode) | |
1372 | ("change\\.log\\'" . change-log-mode) | |
1373 | ("changelo\\'" . change-log-mode) | |
1374 | ("ChangeLog\\.[0-9]+\\'" . change-log-mode) | |
1375 | ;; for MSDOS and MS-Windows (which are case-insensitive) | |
1376 | ("changelog\\'" . change-log-mode) | |
1377 | ("changelog\\.[0-9]+\\'" . change-log-mode) | |
1378 | ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode) | |
1379 | ("\\.scm\\.[0-9]*\\'" . scheme-mode) | |
1380 | ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode) | |
1381 | ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode) | |
1382 | ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode) | |
1383 | ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode) | |
1384 | ("\\.m?spec$" . sh-mode) | |
1385 | ("\\.mm\\'" . nroff-mode) | |
1386 | ("\\.me\\'" . nroff-mode) | |
1387 | ("\\.ms\\'" . nroff-mode) | |
1388 | ("\\.man\\'" . nroff-mode) | |
1389 | ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode) | |
ffc0e1ca AS |
1390 | ("\\.TeX\\'" . tex-mode) |
1391 | ("\\.sty\\'" . latex-mode) | |
1392 | ("\\.cls\\'" . latex-mode) ;LaTeX 2e class | |
1393 | ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option | |
1394 | ("\\.bbl\\'" . latex-mode) | |
1395 | ("\\.bib\\'" . bibtex-mode) | |
1396 | ("\\.sql\\'" . sql-mode) | |
1397 | ("\\.m4\\'" . m4-mode) | |
1398 | ("\\.mc\\'" . m4-mode) | |
1399 | ("\\.mf\\'" . metafont-mode) | |
1400 | ("\\.mp\\'" . metapost-mode) | |
1401 | ("\\.vhdl?\\'" . vhdl-mode) | |
1402 | ("\\.article\\'" . text-mode) | |
1403 | ("\\.letter\\'" . text-mode) | |
1404 | ("\\.tcl\\'" . tcl-mode) | |
1405 | ("\\.exp\\'" . tcl-mode) | |
1406 | ("\\.itcl\\'" . tcl-mode) | |
1407 | ("\\.itk\\'" . tcl-mode) | |
1408 | ("\\.icn\\'" . icon-mode) | |
1409 | ("\\.sim\\'" . simula-mode) | |
1410 | ("\\.mss\\'" . scribe-mode) | |
1411 | ("\\.f90\\'" . f90-mode) | |
1412 | ("\\.pro\\'" . idlwave-mode) | |
1413 | ("\\.lsp\\'" . lisp-mode) | |
1414 | ("\\.awk\\'" . awk-mode) | |
1415 | ("\\.prolog\\'" . prolog-mode) | |
1416 | ("\\.tar\\'" . tar-mode) | |
1417 | ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode) | |
1418 | ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode) | |
1419 | ;; Mailer puts message to be edited in | |
1420 | ;; /tmp/Re.... or Message | |
1421 | ("\\`/tmp/Re" . text-mode) | |
1422 | ("/Message[0-9]*\\'" . text-mode) | |
1423 | ("/drafts/[0-9]+\\'" . mh-letter-mode) | |
1424 | ("\\.zone\\'" . zone-mode) | |
1425 | ;; some news reader is reported to use this | |
1426 | ("\\`/tmp/fol/" . text-mode) | |
1427 | ("\\.y\\'" . c-mode) | |
1428 | ("\\.lex\\'" . c-mode) | |
1429 | ("\\.oak\\'" . scheme-mode) | |
1430 | ("\\.sgml?\\'" . sgml-mode) | |
1431 | ("\\.xml\\'" . sgml-mode) | |
1432 | ("\\.dtd\\'" . sgml-mode) | |
1433 | ("\\.ds\\(ss\\)?l\\'" . dsssl-mode) | |
1434 | ("\\.idl\\'" . idl-mode) | |
1435 | ;; .emacs following a directory delimiter | |
1436 | ;; in Unix, MSDOG or VMS syntax. | |
1437 | ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode) | |
1438 | ("\\`\\..*emacs\\'" . emacs-lisp-mode) | |
1439 | ;; _emacs following a directory delimiter | |
1440 | ;; in MsDos syntax | |
1441 | ("[:/]_emacs\\'" . emacs-lisp-mode) | |
1442 | ("/crontab\\.X*[0-9]+\\'" . shell-script-mode) | |
1443 | ("\\.ml\\'" . lisp-mode) | |
1444 | ("\\.asn$" . snmp-mode) | |
1445 | ("\\.mib$" . snmp-mode) | |
1446 | ("\\.smi$" . snmp-mode) | |
1447 | ("\\.as2$" . snmpv2-mode) | |
1448 | ("\\.mi2$" . snmpv2-mode) | |
1449 | ("\\.sm2$" . snmpv2-mode) | |
1450 | ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode) | |
e854cc22 | 1451 | ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG |
ffc0e1ca AS |
1452 | ("\\.[eE]?[pP][sS]$" . ps-mode) |
1453 | ("configure\\.in\\'" . autoconf-mode) | |
1454 | ("BROWSE\\'" . ebrowse-tree-mode) | |
1455 | ("\\.ebrowse\\'" . ebrowse-tree-mode) | |
9ee45b2c SM |
1456 | ("#\\*mail\\*" . mail-mode) |
1457 | ;; Get rid of any trailing .n.m and try again. | |
1458 | ;; This is for files saved by cvs-merge that look like .#<file>.<rev> | |
1459 | ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~ | |
1460 | ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t) | |
1461 | ;;; The following should come after the ChangeLog pattern | |
1462 | ;;; for the sake of ChangeLog.1, etc. | |
1463 | ;;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too. | |
1464 | ("\\.[12345678]\\'" . nroff-mode))) | |
ffc0e1ca | 1465 | "Alist of filename patterns vs corresponding major mode functions. |
116987ba RS |
1466 | Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL). |
1467 | \(NON-NIL stands for anything that is not nil; the value does not matter.) | |
1468 | Visiting a file whose name matches REGEXP specifies FUNCTION as the | |
1469 | mode function to use. FUNCTION will be called, unless it is nil. | |
1470 | ||
1471 | If the element has the form (REGEXP FUNCTION NON-NIL), then after | |
1472 | calling FUNCTION (if it's not nil), we delete the suffix that matched | |
1473 | REGEXP and search the list again for another match.") | |
7b3f3dc2 | 1474 | |
e13322a0 | 1475 | |
d7fa5aa2 | 1476 | (defvar interpreter-mode-alist |
ffc0e1ca AS |
1477 | (mapc |
1478 | (lambda (l) | |
1479 | (cons (purecopy (car l)) (cdr l))) | |
1480 | '(("perl" . perl-mode) | |
1481 | ("perl5" . perl-mode) | |
1482 | ("miniperl" . perl-mode) | |
1483 | ("wish" . tcl-mode) | |
1484 | ("wishx" . tcl-mode) | |
1485 | ("tcl" . tcl-mode) | |
1486 | ("tclsh" . tcl-mode) | |
1487 | ("awk" . awk-mode) | |
1488 | ("mawk" . awk-mode) | |
1489 | ("nawk" . awk-mode) | |
1490 | ("gawk" . awk-mode) | |
1491 | ("scm" . scheme-mode) | |
1492 | ("ash" . sh-mode) | |
1493 | ("bash" . sh-mode) | |
1494 | ("bash2" . sh-mode) | |
1495 | ("csh" . sh-mode) | |
1496 | ("dtksh" . sh-mode) | |
1497 | ("es" . sh-mode) | |
1498 | ("itcsh" . sh-mode) | |
1499 | ("jsh" . sh-mode) | |
1500 | ("ksh" . sh-mode) | |
1501 | ("oash" . sh-mode) | |
1502 | ("pdksh" . sh-mode) | |
1503 | ("rc" . sh-mode) | |
1504 | ("rpm" . sh-mode) | |
1505 | ("sh" . sh-mode) | |
1506 | ("sh5" . sh-mode) | |
1507 | ("tcsh" . sh-mode) | |
1508 | ("wksh" . sh-mode) | |
1509 | ("wsh" . sh-mode) | |
1510 | ("zsh" . sh-mode) | |
1511 | ("tail" . text-mode) | |
1512 | ("more" . text-mode) | |
1513 | ("less" . text-mode) | |
1514 | ("pg" . text-mode) | |
1515 | ("make" . makefile-mode) ; Debian uses this | |
1516 | ("guile" . scheme-mode) | |
1517 | ("clisp" . lisp-mode))) | |
c907d156 RS |
1518 | "Alist mapping interpreter names to major modes. |
1519 | This alist applies to files whose first line starts with `#!'. | |
1520 | Each element looks like (INTERPRETER . MODE). | |
1521 | The car of each element is compared with | |
1522 | the name of the interpreter specified in the first line. | |
1523 | If it matches, mode MODE is selected.") | |
1524 | ||
d7fa5aa2 | 1525 | (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'") |
45fb3bb8 | 1526 | "List of regexps; if one matches a file name, don't look for `-*-'.") |
a0c9f21b | 1527 | |
d7fa5aa2 | 1528 | (defvar inhibit-first-line-modes-suffixes nil |
b20ff6d0 RS |
1529 | "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'. |
1530 | When checking `inhibit-first-line-modes-regexps', we first discard | |
1531 | from the end of the file name anything that matches one of these regexps.") | |
1532 | ||
ffc0e1ca AS |
1533 | (defvar auto-mode-interpreter-regexp |
1534 | "#![ \t]?\\([^ \t\n]*\ | |
1535 | /bin/env[ \t]\\)?\\([^ \t\n]+\\)" | |
1536 | "Regular expression matching interpreters, for file mode determination. | |
1537 | This regular expression is matched against the first line of a file | |
1538 | to determine the file's mode in `set-auto-mode' when Emacs can't deduce | |
1539 | a mode from the file's name. If it matches, the file is assumed to | |
1540 | be interpreted by the interpreter matched by the second group of the | |
1541 | regular expression. The mode is then determined as the mode associated | |
1542 | with that interpreter in `interpreter-mode-alist'.") | |
0720b68b | 1543 | |
9de9b6a2 | 1544 | (defun set-auto-mode (&optional just-from-file-name) |
b4da00e9 | 1545 | "Select major mode appropriate for current buffer. |
e3998da1 RS |
1546 | This checks for a -*- mode tag in the buffer's text, |
1547 | compares the filename against the entries in `auto-mode-alist', | |
1548 | or checks the interpreter that runs this file against | |
1549 | `interpreter-mode-alist'. | |
1550 | ||
1551 | It does not check for the `mode:' local variable in the | |
1552 | Local Variables section of the file; for that, use `hack-local-variables'. | |
7b3f3dc2 | 1553 | |
f3e23606 | 1554 | If `enable-local-variables' is nil, this function does not check for a |
9de9b6a2 RS |
1555 | -*- mode tag. |
1556 | ||
1557 | If the optional argument JUST-FROM-FILE-NAME is non-nil, | |
1558 | then we do not set anything but the major mode, | |
1559 | and we don't even do that unless it would come from the file name." | |
b4da00e9 | 1560 | ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*- |
d0fc03ef | 1561 | (let (beg end done modes) |
b4da00e9 RM |
1562 | (save-excursion |
1563 | (goto-char (point-min)) | |
1564 | (skip-chars-forward " \t\n") | |
9fa7bfe5 RS |
1565 | (and enable-local-variables |
1566 | ;; Don't look for -*- if this file name matches any | |
45fb3bb8 | 1567 | ;; of the regexps in inhibit-first-line-modes-regexps. |
cae111fa | 1568 | (let ((temp inhibit-first-line-modes-regexps) |
4bc3d240 RS |
1569 | (name (if buffer-file-name |
1570 | (file-name-sans-versions buffer-file-name) | |
1571 | (buffer-name)))) | |
38832b4c KH |
1572 | (while (let ((sufs inhibit-first-line-modes-suffixes)) |
1573 | (while (and sufs (not (string-match (car sufs) name))) | |
1574 | (setq sufs (cdr sufs))) | |
1575 | sufs) | |
1576 | (setq name (substring name 0 (match-beginning 0)))) | |
9fa7bfe5 | 1577 | (while (and temp |
b20ff6d0 | 1578 | (not (string-match (car temp) name))) |
9fa7bfe5 RS |
1579 | (setq temp (cdr temp))) |
1580 | (not temp)) | |
1581 | (search-forward "-*-" (save-excursion | |
1582 | ;; If the file begins with "#!" | |
1583 | ;; (exec interpreter magic), look | |
1584 | ;; for mode frobs in the first two | |
1585 | ;; lines. You cannot necessarily | |
1586 | ;; put them in the first line of | |
1587 | ;; such a file without screwing up | |
1588 | ;; the interpreter invocation. | |
1589 | (end-of-line (and (looking-at "^#!") 2)) | |
1590 | (point)) t) | |
1591 | (progn | |
1592 | (skip-chars-forward " \t") | |
1593 | (setq beg (point)) | |
1594 | (search-forward "-*-" | |
1595 | (save-excursion (end-of-line) (point)) | |
1596 | t)) | |
1597 | (progn | |
1598 | (forward-char -3) | |
1599 | (skip-chars-backward " \t") | |
1600 | (setq end (point)) | |
1601 | (goto-char beg) | |
1602 | (if (save-excursion (search-forward ":" end t)) | |
1603 | ;; Find all specifications for the `mode:' variable | |
57a0155c | 1604 | ;; and execute them left to right. |
9fa7bfe5 | 1605 | (while (let ((case-fold-search t)) |
6054fcc6 KH |
1606 | (or (and (looking-at "mode:") |
1607 | (goto-char (match-end 0))) | |
1608 | (re-search-forward "[ \t;]mode:" end t))) | |
9fa7bfe5 RS |
1609 | (skip-chars-forward " \t") |
1610 | (setq beg (point)) | |
1611 | (if (search-forward ";" end t) | |
1612 | (forward-char -1) | |
1613 | (goto-char end)) | |
1614 | (skip-chars-backward " \t") | |
9ee45b2c SM |
1615 | (push (intern (concat (downcase (buffer-substring beg (point))) "-mode")) |
1616 | modes)) | |
9fa7bfe5 | 1617 | ;; Simple -*-MODE-*- case. |
9ee45b2c SM |
1618 | (push (intern (concat (downcase (buffer-substring beg end)) |
1619 | "-mode")) | |
1620 | modes))))) | |
d0fc03ef RS |
1621 | ;; If we found modes to use, invoke them now, |
1622 | ;; outside the save-excursion. | |
9ee45b2c SM |
1623 | (unless just-from-file-name |
1624 | (dolist (mode (nreverse modes)) | |
1625 | (if (not (functionp mode)) | |
1626 | (message "Ignoring unknown mode `%s'" mode) | |
1627 | (setq done t) | |
1628 | (funcall mode)))) | |
d0fc03ef RS |
1629 | ;; If we didn't find a mode from a -*- line, try using the file name. |
1630 | (if (and (not done) buffer-file-name) | |
1631 | (let ((name buffer-file-name) | |
1632 | (keep-going t)) | |
1633 | ;; Remove backup-suffixes from file name. | |
1634 | (setq name (file-name-sans-versions name)) | |
1635 | (while keep-going | |
1636 | (setq keep-going nil) | |
1637 | (let ((alist auto-mode-alist) | |
1638 | (mode nil)) | |
1639 | ;; Find first matching alist entry. | |
76d5492b | 1640 | (let ((case-fold-search |
d0fc03ef RS |
1641 | (memq system-type '(vax-vms windows-nt)))) |
1642 | (while (and (not mode) alist) | |
1643 | (if (string-match (car (car alist)) name) | |
1644 | (if (and (consp (cdr (car alist))) | |
1645 | (nth 2 (car alist))) | |
ffc0e1ca AS |
1646 | (setq mode (car (cdr (car alist))) |
1647 | name (substring name 0 (match-beginning 0)) | |
1648 | keep-going t) | |
d0fc03ef RS |
1649 | (setq mode (cdr (car alist)) |
1650 | keep-going nil))) | |
1651 | (setq alist (cdr alist)))) | |
1652 | (if mode | |
3b9ffb77 RS |
1653 | ;; When JUST-FROM-FILE-NAME is set, |
1654 | ;; we are working on behalf of set-visited-file-name. | |
1655 | ;; In that case, if the major mode specified is the | |
1656 | ;; same one we already have, don't actually reset it. | |
1657 | ;; We don't want to lose minor modes such as Font Lock. | |
1658 | (unless (and just-from-file-name (eq mode major-mode)) | |
1659 | (funcall mode)) | |
d0fc03ef RS |
1660 | ;; If we can't deduce a mode from the file name, |
1661 | ;; look for an interpreter specified in the first line. | |
1540e4e9 KH |
1662 | ;; As a special case, allow for things like "#!/bin/env perl", |
1663 | ;; which finds the interpreter anywhere in $PATH. | |
d0fc03ef RS |
1664 | (let ((interpreter |
1665 | (save-excursion | |
1666 | (goto-char (point-min)) | |
ffc0e1ca AS |
1667 | (if (looking-at auto-mode-interpreter-regexp) |
1668 | (match-string 2) | |
d0fc03ef RS |
1669 | ""))) |
1670 | elt) | |
1671 | ;; Map interpreter name to a mode. | |
1672 | (setq elt (assoc (file-name-nondirectory interpreter) | |
1673 | interpreter-mode-alist)) | |
9de9b6a2 RS |
1674 | (unless just-from-file-name |
1675 | (if elt | |
1676 | (funcall (cdr elt)))))))))))) | |
b4da00e9 | 1677 | |
f3e23606 | 1678 | (defun hack-local-variables-prop-line () |
ffc0e1ca AS |
1679 | "Set local variables specified in the -*- line. |
1680 | Ignore any specification for `mode:' and `coding:'; | |
1681 | `set-auto-mode' should already have handled `mode:', | |
1682 | `set-auto-coding' should already have handled `coding:'." | |
f3e23606 RS |
1683 | (save-excursion |
1684 | (goto-char (point-min)) | |
13a66180 | 1685 | (let ((result nil) |
aa5fcebf KH |
1686 | (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))) |
1687 | (enable-local-variables | |
1688 | (and local-enable-local-variables enable-local-variables))) | |
f3e23606 RS |
1689 | ;; Parse the -*- line into the `result' alist. |
1690 | (cond ((not (search-forward "-*-" end t)) | |
1691 | ;; doesn't have one. | |
1692 | nil) | |
1693 | ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)") | |
13a66180 KH |
1694 | ;; Simple form: "-*- MODENAME -*-". Already handled. |
1695 | nil) | |
f3e23606 RS |
1696 | (t |
1697 | ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-' | |
1698 | ;; (last ";" is optional). | |
1699 | (save-excursion | |
1700 | (if (search-forward "-*-" end t) | |
1701 | (setq end (- (point) 3)) | |
1702 | (error "-*- not terminated before end of line"))) | |
1703 | (while (< (point) end) | |
1704 | (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*") | |
ffc0e1ca | 1705 | (error "Malformed -*- line")) |
f3e23606 | 1706 | (goto-char (match-end 0)) |
1c26a6f3 KH |
1707 | ;; There used to be a downcase here, |
1708 | ;; but the manual didn't say so, | |
1709 | ;; and people want to set var names that aren't all lc. | |
1710 | (let ((key (intern (buffer-substring | |
1711 | (match-beginning 1) | |
1712 | (match-end 1)))) | |
f3e23606 RS |
1713 | (val (save-restriction |
1714 | (narrow-to-region (point) end) | |
1715 | (read (current-buffer))))) | |
93a2702d RS |
1716 | ;; It is traditional to ignore |
1717 | ;; case when checking for `mode' in set-auto-mode, | |
1718 | ;; so we must do that here as well. | |
1719 | ;; That is inconsistent, but we're stuck with it. | |
3fa0a9aa | 1720 | ;; The same can be said for `coding' in set-auto-coding. |
93a2702d | 1721 | (or (equal (downcase (symbol-name key)) "mode") |
3fa0a9aa | 1722 | (equal (downcase (symbol-name key)) "coding") |
13a66180 | 1723 | (setq result (cons (cons key val) result))) |
f3e23606 RS |
1724 | (skip-chars-forward " \t;"))) |
1725 | (setq result (nreverse result)))) | |
76d5492b | 1726 | |
f3e23606 RS |
1727 | (if (and result |
1728 | (or (eq enable-local-variables t) | |
1729 | (and enable-local-variables | |
1730 | (save-window-excursion | |
6f931919 RS |
1731 | (condition-case nil |
1732 | (switch-to-buffer (current-buffer)) | |
1733 | (error | |
1734 | ;; If we fail to switch in the selected window, | |
1735 | ;; it is probably a minibuffer. | |
1736 | ;; So try another window. | |
1737 | (condition-case nil | |
1738 | (switch-to-buffer-other-window (current-buffer)) | |
1739 | (error | |
1740 | (switch-to-buffer-other-frame (current-buffer)))))) | |
f3e23606 RS |
1741 | (y-or-n-p (format "Set local variables as specified in -*- line of %s? " |
1742 | (file-name-nondirectory buffer-file-name))))))) | |
2837b9df RS |
1743 | (let ((enable-local-eval enable-local-eval)) |
1744 | (while result | |
1745 | (hack-one-local-variable (car (car result)) (cdr (car result))) | |
1746 | (setq result (cdr result)))))))) | |
f3e23606 | 1747 | |
1d517019 RS |
1748 | (defvar hack-local-variables-hook nil |
1749 | "Normal hook run after processing a file's local variables specs. | |
1750 | Major modes can use this to examine user-specified local variables | |
1751 | in order to initialize other data structure based on them.") | |
1752 | ||
9de9b6a2 RS |
1753 | (defun hack-local-variables (&optional mode-only) |
1754 | "Parse and put into effect this buffer's local variables spec. | |
1755 | If MODE-ONLY is non-nil, all we do is check whether the major mode | |
1756 | is specified, returning t if it is specified." | |
1757 | (unless mode-only | |
1758 | (hack-local-variables-prop-line)) | |
b4da00e9 | 1759 | ;; Look for "Local variables:" line in last page. |
aa5fcebf KH |
1760 | (let (mode-specified |
1761 | (enable-local-variables | |
1762 | (and local-enable-local-variables enable-local-variables))) | |
9de9b6a2 RS |
1763 | (save-excursion |
1764 | (goto-char (point-max)) | |
1765 | (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move) | |
1766 | (if (let ((case-fold-search t)) | |
1767 | (and (search-forward "Local Variables:" nil t) | |
1768 | (or (eq enable-local-variables t) | |
1769 | mode-only | |
1770 | (and enable-local-variables | |
1771 | (save-window-excursion | |
1772 | (switch-to-buffer (current-buffer)) | |
1773 | (save-excursion | |
1774 | (beginning-of-line) | |
1775 | (set-window-start (selected-window) (point))) | |
1776 | (y-or-n-p (format "Set local variables as specified at end of %s? " | |
1777 | (if buffer-file-name | |
1778 | (file-name-nondirectory | |
1779 | buffer-file-name) | |
1780 | (concat "buffer " | |
1781 | (buffer-name)))))))))) | |
1782 | (let ((continue t) | |
1783 | prefix prefixlen suffix beg | |
1784 | mode-specified | |
1785 | (enable-local-eval enable-local-eval)) | |
1786 | ;; The prefix is what comes before "local variables:" in its line. | |
1787 | ;; The suffix is what comes after "local variables:" in its line. | |
b4da00e9 | 1788 | (skip-chars-forward " \t") |
9de9b6a2 RS |
1789 | (or (eolp) |
1790 | (setq suffix (buffer-substring (point) | |
1791 | (progn (end-of-line) (point))))) | |
1792 | (goto-char (match-beginning 0)) | |
1793 | (or (bolp) | |
1794 | (setq prefix | |
1795 | (buffer-substring (point) | |
1796 | (progn (beginning-of-line) (point))))) | |
1797 | ||
1798 | (if prefix (setq prefixlen (length prefix) | |
1799 | prefix (regexp-quote prefix))) | |
1800 | (if suffix (setq suffix (concat (regexp-quote suffix) "$"))) | |
1801 | (while continue | |
1802 | ;; Look at next local variable spec. | |
1803 | (if selective-display (re-search-forward "[\n\C-m]") | |
1804 | (forward-line 1)) | |
1805 | ;; Skip the prefix, if any. | |
1806 | (if prefix | |
1807 | (if (looking-at prefix) | |
1808 | (forward-char prefixlen) | |
1809 | (error "Local variables entry is missing the prefix"))) | |
1810 | ;; Find the variable name; strip whitespace. | |
1811 | (skip-chars-forward " \t") | |
1812 | (setq beg (point)) | |
1813 | (skip-chars-forward "^:\n") | |
1814 | (if (eolp) (error "Missing colon in local variables entry")) | |
1815 | (skip-chars-backward " \t") | |
1816 | (let* ((str (buffer-substring beg (point))) | |
1817 | (var (read str)) | |
1818 | val) | |
1819 | ;; Setting variable named "end" means end of list. | |
1820 | (if (string-equal (downcase str) "end") | |
1821 | (setq continue nil) | |
1822 | ;; Otherwise read the variable value. | |
1823 | (skip-chars-forward "^:") | |
1824 | (forward-char 1) | |
1825 | (setq val (read (current-buffer))) | |
1826 | (skip-chars-backward "\n") | |
1827 | (skip-chars-forward " \t") | |
1828 | (or (if suffix (looking-at suffix) (eolp)) | |
1829 | (error "Local variables entry is terminated incorrectly")) | |
1830 | (if mode-only | |
1831 | (if (eq var 'mode) | |
1832 | (setq mode-specified t)) | |
1833 | ;; Set the variable. "Variables" mode and eval are funny. | |
1834 | (hack-one-local-variable var val)))))))) | |
1835 | (unless mode-only | |
1836 | (run-hooks 'hack-local-variables-hook)) | |
1837 | mode-specified)) | |
f3e23606 | 1838 | |
d7fa5aa2 | 1839 | (defvar ignored-local-variables |
f3e23606 RS |
1840 | '(enable-local-eval) |
1841 | "Variables to be ignored in a file's local variable spec.") | |
1842 | ||
be0218a8 | 1843 | ;; Get confirmation before setting these variables as locals in a file. |
05ef1cda | 1844 | (put 'debugger 'risky-local-variable t) |
f6fa3ee3 | 1845 | (put 'enable-local-eval 'risky-local-variable t) |
fce47eea | 1846 | (put 'ignored-local-variables 'risky-local-variable t) |
be0218a8 RS |
1847 | (put 'eval 'risky-local-variable t) |
1848 | (put 'file-name-handler-alist 'risky-local-variable t) | |
1849 | (put 'minor-mode-map-alist 'risky-local-variable t) | |
1850 | (put 'after-load-alist 'risky-local-variable t) | |
f6fa3ee3 RS |
1851 | (put 'buffer-file-name 'risky-local-variable t) |
1852 | (put 'buffer-auto-save-file-name 'risky-local-variable t) | |
1853 | (put 'buffer-file-truename 'risky-local-variable t) | |
b0ffcc0d RS |
1854 | (put 'exec-path 'risky-local-variable t) |
1855 | (put 'load-path 'risky-local-variable t) | |
1856 | (put 'exec-directory 'risky-local-variable t) | |
1857 | (put 'process-environment 'risky-local-variable t) | |
eba1c87a RS |
1858 | (put 'dabbrev-case-fold-search 'risky-local-variable t) |
1859 | (put 'dabbrev-case-replace 'risky-local-variable t) | |
9afa8bf7 RS |
1860 | ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode. |
1861 | (put 'outline-level 'risky-local-variable t) | |
d98b741d | 1862 | (put 'rmail-output-file-alist 'risky-local-variable t) |
f6fa3ee3 | 1863 | |
6672c42b RS |
1864 | ;; This one is safe because the user gets to check it before it is used. |
1865 | (put 'compile-command 'safe-local-variable t) | |
1866 | ||
d0bd3513 RS |
1867 | (defun hack-one-local-variable-quotep (exp) |
1868 | (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp)))) | |
1869 | ||
f3e23606 | 1870 | (defun hack-one-local-variable (var val) |
ffc0e1ca AS |
1871 | "\"Set\" one variable in a local variables spec. |
1872 | A few variable names are treated specially." | |
f3e23606 RS |
1873 | (cond ((eq var 'mode) |
1874 | (funcall (intern (concat (downcase (symbol-name val)) | |
1875 | "-mode")))) | |
3fa0a9aa KH |
1876 | ((eq var 'coding) |
1877 | ;; We have already handled coding: tag in set-auto-coding. | |
1878 | nil) | |
f3e23606 RS |
1879 | ((memq var ignored-local-variables) |
1880 | nil) | |
1881 | ;; "Setting" eval means either eval it or do nothing. | |
7d3221d7 | 1882 | ;; Likewise for setting hook variables. |
be0218a8 | 1883 | ((or (get var 'risky-local-variable) |
6672c42b | 1884 | (and |
04d807e6 | 1885 | (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$" |
6672c42b RS |
1886 | (symbol-name var)) |
1887 | (not (get var 'safe-local-variable)))) | |
0225ae5e | 1888 | ;; Permit evalling a put of a harmless property. |
d0bd3513 RS |
1889 | ;; if the args do nothing tricky. |
1890 | (if (or (and (eq var 'eval) | |
1891 | (consp val) | |
1892 | (eq (car val) 'put) | |
1893 | (hack-one-local-variable-quotep (nth 1 val)) | |
1894 | (hack-one-local-variable-quotep (nth 2 val)) | |
1895 | ;; Only allow safe values of lisp-indent-hook; | |
1896 | ;; not functions. | |
1897 | (or (numberp (nth 3 val)) | |
dc417415 | 1898 | (equal (nth 3 val) ''defun)) |
d0bd3513 RS |
1899 | (memq (nth 1 (nth 2 val)) |
1900 | '(lisp-indent-hook))) | |
1901 | ;; Permit eval if not root and user says ok. | |
c7e62660 | 1902 | (and (not (zerop (user-uid))) |
d0bd3513 RS |
1903 | (or (eq enable-local-eval t) |
1904 | (and enable-local-eval | |
1905 | (save-window-excursion | |
1906 | (switch-to-buffer (current-buffer)) | |
1907 | (save-excursion | |
1908 | (beginning-of-line) | |
1909 | (set-window-start (selected-window) (point))) | |
1910 | (setq enable-local-eval | |
abf16d5e RS |
1911 | (y-or-n-p (format "Process `eval' or hook local variables in %s? " |
1912 | (if buffer-file-name | |
1913 | (concat "file " (file-name-nondirectory buffer-file-name)) | |
1914 | (concat "buffer " (buffer-name))))))))))) | |
7d3221d7 RS |
1915 | (if (eq var 'eval) |
1916 | (save-excursion (eval val)) | |
1917 | (make-local-variable var) | |
1918 | (set var val)) | |
abf16d5e | 1919 | (message "Ignoring `eval:' in the local variables list"))) |
f3e23606 RS |
1920 | ;; Ordinary variable, really set it. |
1921 | (t (make-local-variable var) | |
1922 | (set var val)))) | |
1923 | ||
b4da00e9 | 1924 | \f |
21540597 | 1925 | (defcustom change-major-mode-with-file-name t |
9de9b6a2 RS |
1926 | "*Non-nil means \\[write-file] should set the major mode from the file name. |
1927 | However, the mode will not be changed if | |
1928 | \(1) a local variables list or the `-*-' line specifies a major mode, or | |
1929 | \(2) the current major mode is a \"special\" mode, | |
8609911b | 1930 | \ not suitable for ordinary files, or |
21540597 RS |
1931 | \(3) the new file name does not particularly specify any mode." |
1932 | :type 'boolean | |
1933 | :group 'editing-basics) | |
9de9b6a2 | 1934 | |
f36012a6 | 1935 | (defun set-visited-file-name (filename &optional no-query along-with-file) |
b4da00e9 RM |
1936 | "Change name of file visited in current buffer to FILENAME. |
1937 | The next time the buffer is saved it will go in the newly specified file. | |
1938 | nil or empty string as argument means make buffer not be visiting any file. | |
1939 | Remember to delete the initial contents of the minibuffer | |
6a6b62f8 RS |
1940 | if you wish to pass an empty string as the argument. |
1941 | ||
1942 | The optional second argument NO-QUERY, if non-nil, inhibits asking for | |
f36012a6 RS |
1943 | confirmation in the case where another buffer is already visiting FILENAME. |
1944 | ||
1945 | The optional third argument ALONG-WITH-FILE, if non-nil, means that | |
1946 | the old visited file has been renamed to the new name FILENAME." | |
b4da00e9 | 1947 | (interactive "FSet visited file name: ") |
c11a94fe RS |
1948 | (if (buffer-base-buffer) |
1949 | (error "An indirect buffer cannot visit a file")) | |
a522e5bf RS |
1950 | (let (truename) |
1951 | (if filename | |
1952 | (setq filename | |
1953 | (if (string-equal filename "") | |
1954 | nil | |
1955 | (expand-file-name filename)))) | |
1956 | (if filename | |
1957 | (progn | |
1958 | (setq truename (file-truename filename)) | |
1959 | (if find-file-visit-truename | |
a522e5bf | 1960 | (setq filename truename)))) |
11e314fa | 1961 | (let ((buffer (and filename (find-buffer-visiting filename)))) |
7b89d38e | 1962 | (and buffer (not (eq buffer (current-buffer))) |
6a6b62f8 | 1963 | (not no-query) |
7b89d38e RS |
1964 | (not (y-or-n-p (message "A buffer is visiting %s; proceed? " |
1965 | filename))) | |
1966 | (error "Aborted"))) | |
a522e5bf RS |
1967 | (or (equal filename buffer-file-name) |
1968 | (progn | |
1969 | (and filename (lock-buffer filename)) | |
1970 | (unlock-buffer))) | |
1971 | (setq buffer-file-name filename) | |
1972 | (if filename ; make buffer name reflect filename. | |
1973 | (let ((new-name (file-name-nondirectory buffer-file-name))) | |
1974 | (if (string= new-name "") | |
1975 | (error "Empty file name")) | |
1976 | (if (eq system-type 'vax-vms) | |
1977 | (setq new-name (downcase new-name))) | |
1978 | (setq default-directory (file-name-directory buffer-file-name)) | |
1979 | (or (string= new-name (buffer-name)) | |
1980 | (rename-buffer new-name t)))) | |
1981 | (setq buffer-backed-up nil) | |
f36012a6 RS |
1982 | (or along-with-file |
1983 | (clear-visited-file-modtime)) | |
8ccdc29e | 1984 | ;; Abbreviate the file names of the buffer. |
4826e97f | 1985 | (if truename |
8ccdc29e RS |
1986 | (progn |
1987 | (setq buffer-file-truename (abbreviate-file-name truename)) | |
1988 | (if find-file-visit-truename | |
1989 | (setq buffer-file-name buffer-file-truename)))) | |
a522e5bf RS |
1990 | (setq buffer-file-number |
1991 | (if filename | |
2a47b4f5 | 1992 | (nthcdr 10 (file-attributes buffer-file-name)) |
a522e5bf | 1993 | nil))) |
b4da00e9 RM |
1994 | ;; write-file-hooks is normally used for things like ftp-find-file |
1995 | ;; that visit things that are not local files as if they were files. | |
1996 | ;; Changing to visit an ordinary local file instead should flush the hook. | |
1997 | (kill-local-variable 'write-file-hooks) | |
c9dca4e0 | 1998 | (kill-local-variable 'local-write-file-hooks) |
b4da00e9 RM |
1999 | (kill-local-variable 'revert-buffer-function) |
2000 | (kill-local-variable 'backup-inhibited) | |
ee81c959 RS |
2001 | ;; If buffer was read-only because of version control, |
2002 | ;; that reason is gone now, so make it writable. | |
2003 | (if vc-mode | |
2004 | (setq buffer-read-only nil)) | |
2005 | (kill-local-variable 'vc-mode) | |
b4da00e9 RM |
2006 | ;; Turn off backup files for certain file names. |
2007 | ;; Since this is a permanent local, the major mode won't eliminate it. | |
4d49551a KH |
2008 | (and buffer-file-name |
2009 | (not (funcall backup-enable-predicate buffer-file-name)) | |
b4da00e9 RM |
2010 | (progn |
2011 | (make-local-variable 'backup-inhibited) | |
2012 | (setq backup-inhibited t))) | |
c77a81cf RS |
2013 | (let ((oauto buffer-auto-save-file-name)) |
2014 | ;; If auto-save was not already on, turn it on if appropriate. | |
2015 | (if (not buffer-auto-save-file-name) | |
2016 | (and buffer-file-name auto-save-default | |
2017 | (auto-save-mode t)) | |
2018 | ;; If auto save is on, start using a new name. | |
2019 | ;; We deliberately don't rename or delete the old auto save | |
2020 | ;; for the old visited file name. This is because perhaps | |
2021 | ;; the user wants to save the new state and then compare with the | |
2022 | ;; previous state from the auto save file. | |
2023 | (setq buffer-auto-save-file-name | |
2024 | (make-auto-save-file-name))) | |
2025 | ;; Rename the old auto save file if any. | |
2026 | (and oauto buffer-auto-save-file-name | |
e6f0e76c | 2027 | (file-exists-p oauto) |
c77a81cf | 2028 | (rename-file oauto buffer-auto-save-file-name t))) |
f36012a6 RS |
2029 | (and buffer-file-name |
2030 | (not along-with-file) | |
9de9b6a2 RS |
2031 | (set-buffer-modified-p t)) |
2032 | ;; Update the major mode, if the file name determines it. | |
2033 | (condition-case nil | |
2034 | ;; Don't change the mode if it is special. | |
2035 | (or (not change-major-mode-with-file-name) | |
2036 | (get major-mode 'mode-class) | |
2037 | ;; Don't change the mode if the local variable list specifies it. | |
2038 | (hack-local-variables t) | |
2039 | (set-auto-mode t)) | |
2040 | (error nil))) | |
b4da00e9 | 2041 | |
912192d1 | 2042 | (defun write-file (filename &optional confirm) |
b4da00e9 | 2043 | "Write current buffer into file FILENAME. |
7f99999a | 2044 | This makes the buffer visit that file, and marks it as not modified. |
7458cc35 | 2045 | |
7f99999a KH |
2046 | If you specify just a directory name as FILENAME, that means to use |
2047 | the default file name but in that directory. You can also yank | |
2048 | the default file name into the minibuffer to edit it, using M-n. | |
2049 | ||
2050 | If the buffer is not already visiting a file, the default file name | |
2051 | for the output file is the buffer name. | |
2052 | ||
2053 | If optional second arg CONFIRM is non-nil, this function | |
2054 | asks for confirmation before overwriting an existing file. | |
912192d1 | 2055 | Interactively, confirmation is required unless you supply a prefix argument." |
b4da00e9 RM |
2056 | ;; (interactive "FWrite file: ") |
2057 | (interactive | |
2058 | (list (if buffer-file-name | |
2059 | (read-file-name "Write file: " | |
2060 | nil nil nil nil) | |
7f99999a KH |
2061 | (read-file-name "Write file: " default-directory |
2062 | (expand-file-name | |
2063 | (file-name-nondirectory (buffer-name)) | |
2064 | default-directory) | |
2065 | nil nil)) | |
912192d1 | 2066 | (not current-prefix-arg))) |
b4da00e9 | 2067 | (or (null filename) (string-equal filename "") |
41f48cb1 RS |
2068 | (progn |
2069 | ;; If arg is just a directory, | |
7f99999a KH |
2070 | ;; use the default file name, but in that directory. |
2071 | (if (file-directory-p filename) | |
41f48cb1 | 2072 | (setq filename (concat (file-name-as-directory filename) |
7f99999a KH |
2073 | (file-name-nondirectory |
2074 | (or buffer-file-name (buffer-name)))))) | |
c2fb8488 RS |
2075 | (and confirm |
2076 | (file-exists-p filename) | |
2077 | (or (y-or-n-p (format "File `%s' exists; overwrite? " filename)) | |
2078 | (error "Canceled"))) | |
5f65549e | 2079 | (set-visited-file-name filename (not confirm)))) |
b4da00e9 | 2080 | (set-buffer-modified-p t) |
6492b55d KH |
2081 | ;; Make buffer writable if file is writable. |
2082 | (and buffer-file-name | |
2083 | (file-writable-p buffer-file-name) | |
2084 | (setq buffer-read-only nil)) | |
912192d1 | 2085 | (save-buffer)) |
b4da00e9 RM |
2086 | \f |
2087 | (defun backup-buffer () | |
2088 | "Make a backup of the disk file visited by the current buffer, if appropriate. | |
2089 | This is normally done before saving the buffer the first time. | |
2090 | If the value is non-nil, it is the result of `file-modes' on the original | |
2091 | file; this means that the caller, after saving the buffer, should change | |
27ab6944 KH |
2092 | the modes of the new file to agree with the old modes. |
2093 | ||
2094 | A backup may be done by renaming or by copying; see documentation of | |
2095 | variable `make-backup-files'. If it's done by renaming, then the file is | |
2096 | no longer accessible under its old name." | |
b4da00e9 RM |
2097 | (if (and make-backup-files (not backup-inhibited) |
2098 | (not buffer-backed-up) | |
2099 | (file-exists-p buffer-file-name) | |
2100 | (memq (aref (elt (file-attributes buffer-file-name) 8) 0) | |
2101 | '(?- ?l))) | |
2102 | (let ((real-file-name buffer-file-name) | |
2103 | backup-info backupname targets setmodes) | |
2104 | ;; If specified name is a symbolic link, chase it to the target. | |
2105 | ;; Thus we make the backups in the directory where the real file is. | |
5dadeb29 | 2106 | (setq real-file-name (file-chase-links real-file-name)) |
b4da00e9 RM |
2107 | (setq backup-info (find-backup-file-name real-file-name) |
2108 | backupname (car backup-info) | |
2109 | targets (cdr backup-info)) | |
2110 | ;;; (if (file-directory-p buffer-file-name) | |
2111 | ;;; (error "Cannot save buffer in directory %s" buffer-file-name)) | |
eb650569 RS |
2112 | (if backup-info |
2113 | (condition-case () | |
2114 | (let ((delete-old-versions | |
2115 | ;; If have old versions to maybe delete, | |
2116 | ;; ask the user to confirm now, before doing anything. | |
2117 | ;; But don't actually delete til later. | |
2118 | (and targets | |
2119 | (or (eq delete-old-versions t) (eq delete-old-versions nil)) | |
2120 | (or delete-old-versions | |
2121 | (y-or-n-p (format "Delete excess backup versions of %s? " | |
2122 | real-file-name)))))) | |
2123 | ;; Actually write the back up file. | |
2124 | (condition-case () | |
2125 | (if (or file-precious-flag | |
ffc0e1ca | 2126 | ; (file-symlink-p buffer-file-name) |
eb650569 RS |
2127 | backup-by-copying |
2128 | (and backup-by-copying-when-linked | |
2129 | (> (file-nlinks real-file-name) 1)) | |
ffc0e1ca AS |
2130 | (and (or backup-by-copying-when-mismatch |
2131 | (integerp backup-by-copying-when-privileged-mismatch)) | |
eb650569 | 2132 | (let ((attr (file-attributes real-file-name))) |
ffc0e1ca AS |
2133 | (and (or backup-by-copying-when-mismatch |
2134 | (and (integerp (nth 2 attr)) | |
2135 | (integerp backup-by-copying-when-privileged-mismatch) | |
2136 | (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch))) | |
2137 | (or (nth 9 attr) | |
2138 | (not (file-ownership-preserved-p real-file-name))))))) | |
eb650569 RS |
2139 | (condition-case () |
2140 | (copy-file real-file-name backupname t t) | |
2141 | (file-error | |
2142 | ;; If copying fails because file BACKUPNAME | |
2143 | ;; is not writable, delete that file and try again. | |
2144 | (if (and (file-exists-p backupname) | |
2145 | (not (file-writable-p backupname))) | |
2146 | (delete-file backupname)) | |
2147 | (copy-file real-file-name backupname t t))) | |
2148 | ;; rename-file should delete old backup. | |
2149 | (rename-file real-file-name backupname t) | |
2150 | (setq setmodes (file-modes backupname))) | |
2151 | (file-error | |
2152 | ;; If trouble writing the backup, write it in ~. | |
567c1ca9 RS |
2153 | (setq backupname (expand-file-name |
2154 | (convert-standard-filename | |
2155 | "~/%backup%~"))) | |
2156 | (message "Cannot write backup file; backing up in %s" | |
2157 | (file-name-nondirectory backupname)) | |
eb650569 RS |
2158 | (sleep-for 1) |
2159 | (condition-case () | |
2160 | (copy-file real-file-name backupname t t) | |
2161 | (file-error | |
2162 | ;; If copying fails because file BACKUPNAME | |
2163 | ;; is not writable, delete that file and try again. | |
2164 | (if (and (file-exists-p backupname) | |
2165 | (not (file-writable-p backupname))) | |
2166 | (delete-file backupname)) | |
2167 | (copy-file real-file-name backupname t t))))) | |
2168 | (setq buffer-backed-up t) | |
2169 | ;; Now delete the old versions, if desired. | |
2170 | (if delete-old-versions | |
2171 | (while targets | |
2172 | (condition-case () | |
2173 | (delete-file (car targets)) | |
2174 | (file-error nil)) | |
2175 | (setq targets (cdr targets)))) | |
2176 | setmodes) | |
2177 | (file-error nil)))))) | |
b4da00e9 | 2178 | |
c3554e95 | 2179 | (defun file-name-sans-versions (name &optional keep-backup-version) |
ffc0e1ca | 2180 | "Return file NAME sans backup versions or strings. |
b4da00e9 | 2181 | This is a separate procedure so your site-init or startup file can |
c3554e95 RS |
2182 | redefine it. |
2183 | If the optional argument KEEP-BACKUP-VERSION is non-nil, | |
2184 | we do not remove backup version numbers, only true file version numbers." | |
6eaebaa2 | 2185 | (let ((handler (find-file-name-handler name 'file-name-sans-versions))) |
c3554e95 RS |
2186 | (if handler |
2187 | (funcall handler 'file-name-sans-versions name keep-backup-version) | |
2188 | (substring name 0 | |
2189 | (if (eq system-type 'vax-vms) | |
2190 | ;; VMS version number is (a) semicolon, optional | |
2191 | ;; sign, zero or more digits or (b) period, option | |
2192 | ;; sign, zero or more digits, provided this is the | |
2193 | ;; second period encountered outside of the | |
2194 | ;; device/directory part of the file name. | |
26add1bf KH |
2195 | (or (string-match ";[-+]?[0-9]*\\'" name) |
2196 | (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'" | |
c3554e95 RS |
2197 | name) |
2198 | (match-beginning 1)) | |
2199 | (length name)) | |
2200 | (if keep-backup-version | |
2201 | (length name) | |
dbb12f2c | 2202 | (or (string-match "\\.~[0-9.]+~\\'" name) |
c3554e95 RS |
2203 | (string-match "~\\'" name) |
2204 | (length name)))))))) | |
b4da00e9 | 2205 | |
cb0cd911 | 2206 | (defun file-ownership-preserved-p (file) |
ffc0e1ca | 2207 | "Return t if deleting FILE and rewriting it would preserve the owner." |
cb0cd911 RS |
2208 | (let ((handler (find-file-name-handler file 'file-ownership-preserved-p))) |
2209 | (if handler | |
2210 | (funcall handler 'file-ownership-preserved-p file) | |
ec5533be | 2211 | (let ((attributes (file-attributes file))) |
306faa42 RS |
2212 | ;; Return t if the file doesn't exist, since it's true that no |
2213 | ;; information would be lost by an (attempted) delete and create. | |
2214 | (or (null attributes) | |
2215 | (= (nth 2 attributes) (user-uid))))))) | |
cb0cd911 | 2216 | |
20b5d24c RS |
2217 | (defun file-name-sans-extension (filename) |
2218 | "Return FILENAME sans final \"extension\". | |
2219 | The extension, in a file name, is the part that follows the last `.'." | |
2220 | (save-match-data | |
2221 | (let ((file (file-name-sans-versions (file-name-nondirectory filename))) | |
2222 | directory) | |
2223 | (if (string-match "\\.[^.]*\\'" file) | |
2224 | (if (setq directory (file-name-directory filename)) | |
2225 | (expand-file-name (substring file 0 (match-beginning 0)) | |
2226 | directory) | |
2227 | (substring file 0 (match-beginning 0))) | |
2228 | filename)))) | |
2229 | ||
93a2702d RS |
2230 | (defun file-name-extension (filename &optional period) |
2231 | "Return FILENAME's final \"extension\". | |
2232 | The extension, in a file name, is the part that follows the last `.'. | |
2233 | Return nil for extensionless file names such as `foo'. | |
2234 | Return the empty string for file names such as `foo.'. | |
2235 | ||
2236 | If PERIOD is non-nil, then the returned value includes the period | |
2237 | that delimits the extension, and if FILENAME has no extension, | |
2238 | the value is \"\"." | |
2239 | (save-match-data | |
2240 | (let ((file (file-name-sans-versions (file-name-nondirectory filename)))) | |
2241 | (if (string-match "\\.[^.]*\\'" file) | |
2242 | (substring file (+ (match-beginning 0) (if period 0 1))) | |
2243 | (if period | |
2244 | ""))))) | |
2245 | ||
ffc0e1ca AS |
2246 | (defcustom make-backup-file-name-function nil |
2247 | "A function to use instead of the default `make-backup-file-name'. | |
2248 | A value of nil gives the default `make-backup-file-name' behaviour. | |
2249 | ||
2250 | This could be buffer-local to do something special for for specific | |
2251 | files. If you define it, you may need to change `backup-file-name-p' | |
2252 | and `file-name-sans-versions' too. | |
2253 | ||
2254 | See also `backup-directory-alist'." | |
2255 | :group 'backup | |
2256 | :type '(choice (const :tag "Default" nil) | |
2257 | (function :tag "Your function"))) | |
2258 | ||
2259 | (defcustom backup-directory-alist nil | |
2260 | "Alist of filename patterns and backup directory names. | |
2261 | Each element looks like (REGEXP . DIRECTORY). Backups of files with | |
2262 | names matching REGEXP will be made in DIRECTORY. DIRECTORY may be | |
2263 | relative or absolute. If it is absolute, so that all matching files | |
2264 | are backed up into the same directory, the file names in this | |
2265 | directory will be the full name of the file backed up with all | |
2266 | directory separators changed to `!' to prevent clashes. This will not | |
2267 | work correctly if your filesystem truncates the resulting name. | |
2268 | ||
2269 | For the common case of all backups going into one directory, the alist | |
2270 | should contain a single element pairing \".\" with the appropriate | |
2271 | directory name. | |
2272 | ||
2273 | If this variable is nil, or it fails to match a filename, the backup | |
2274 | is made in the original file's directory. | |
2275 | ||
2276 | On MS-DOS filesystems without long names this variable is always | |
2277 | ignored." | |
2278 | :group 'backup | |
2279 | :type '(repeat (cons (regexp :tag "Regexp macthing filename") | |
2280 | (directory :tag "Backup directory name")))) | |
2281 | ||
b4da00e9 RM |
2282 | (defun make-backup-file-name (file) |
2283 | "Create the non-numeric backup file name for FILE. | |
ffc0e1ca AS |
2284 | Normally this will just be the file's name with `~' appended. |
2285 | Customization hooks are provided as follows. | |
2286 | ||
2287 | If the variable `make-backup-file-name-function' is non-nil, its value | |
2288 | should be a function which will be called with FILE as its argument; | |
2289 | the resulting name is used. | |
2290 | ||
2291 | Otherwise a match for FILE is sought in `backup-directory-alist'; see | |
2292 | the documentation of that variable. If the directory for the backup | |
2293 | doesn't exist, it is created." | |
2294 | (if make-backup-file-name-function | |
2295 | (funcall make-backup-file-name-function file) | |
2296 | (if (and (eq system-type 'ms-dos) | |
2297 | (not (msdos-long-file-names))) | |
2298 | (let ((fn (file-name-nondirectory file))) | |
2299 | (concat (file-name-directory file) | |
2300 | (or (and (string-match "\\`[^.]+\\'" fn) | |
2301 | (concat (match-string 0 fn) ".~")) | |
2302 | (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn) | |
2303 | (concat (match-string 0 fn) "~"))))) | |
2304 | (concat (make-backup-file-name-1 file) "~")))) | |
2305 | ||
2306 | (defun make-backup-file-name-1 (file) | |
2307 | "Subroutine of `make-backup-file-name' and `find-backup-file-name'." | |
2308 | (let ((alist backup-directory-alist) | |
2309 | elt backup-directory dir-sep-string) | |
2310 | (while alist | |
2311 | (setq elt (pop alist)) | |
2312 | (if (string-match (car elt) file) | |
2313 | (setq backup-directory (cdr elt) | |
2314 | alist nil))) | |
2315 | (if (null backup-directory) | |
2316 | file | |
2317 | (unless (file-exists-p backup-directory) | |
2318 | (condition-case nil | |
2319 | (make-directory backup-directory 'parents) | |
2320 | (file-error file))) | |
2321 | (if (file-name-absolute-p backup-directory) | |
2322 | (progn | |
2323 | (when (memq system-type '(windows-nt ms-dos)) | |
2324 | ;; Normalize DOSish file names: convert all slashes to | |
2325 | ;; directory-sep-char, downcase the drive letter, if any, | |
2326 | ;; and replace the leading "x:" with "/drive_x". | |
2327 | (or (file-name-absolute-p file) | |
2328 | (setq file (expand-file-name file))) ; make defaults explicit | |
2329 | ;; Replace any invalid file-name characters (for the | |
2330 | ;; case of backing up remote files). | |
446c097e | 2331 | (setq file (expand-file-name (convert-standard-filename file))) |
ffc0e1ca | 2332 | (setq dir-sep-string (char-to-string directory-sep-char)) |
ffc0e1ca AS |
2333 | (if (eq (aref file 1) ?:) |
2334 | (setq file (concat dir-sep-string | |
2335 | "drive_" | |
2336 | (char-to-string (downcase (aref file 0))) | |
2337 | (if (eq (aref file 2) directory-sep-char) | |
2338 | "" | |
2339 | dir-sep-string) | |
2340 | (substring file 2))))) | |
2341 | ;; Make the name unique by substituting directory | |
2342 | ;; separators. It may not really be worth bothering about | |
2343 | ;; doubling `!'s in the original name... | |
2344 | (expand-file-name | |
2345 | (subst-char-in-string | |
2346 | directory-sep-char ?! | |
2347 | (replace-regexp-in-string "!" "!!" file)) | |
2348 | backup-directory)) | |
2349 | (expand-file-name (file-name-nondirectory file) | |
2350 | (file-name-as-directory | |
2351 | (expand-file-name backup-directory | |
2352 | (file-name-directory file)))))))) | |
b4da00e9 RM |
2353 | |
2354 | (defun backup-file-name-p (file) | |
2355 | "Return non-nil if FILE is a backup file name (numeric or not). | |
2356 | This is a separate function so you can redefine it for customization. | |
2357 | You may need to redefine `file-name-sans-versions' as well." | |
066327ae | 2358 | (string-match "~\\'" file)) |
b4da00e9 | 2359 | |
e2b30772 RS |
2360 | (defvar backup-extract-version-start) |
2361 | ||
2d051399 | 2362 | ;; This is used in various files. |
a7aa942a KH |
2363 | ;; The usage of backup-extract-version-start is not very clean, |
2364 | ;; but I can't see a good alternative, so as of now I am leaving it alone. | |
2d051399 | 2365 | (defun backup-extract-version (fn) |
ffc0e1ca | 2366 | "Given the name of a numeric backup file, FN, return the backup number. |
e2b30772 | 2367 | Uses the free variable `backup-extract-version-start', whose value should be |
2d051399 | 2368 | the index in the name where the version number begins." |
e2b30772 RS |
2369 | (if (and (string-match "[0-9]+~$" fn backup-extract-version-start) |
2370 | (= (match-beginning 0) backup-extract-version-start)) | |
2371 | (string-to-int (substring fn backup-extract-version-start -1)) | |
2d051399 RS |
2372 | 0)) |
2373 | ||
b4da00e9 RM |
2374 | ;; I believe there is no need to alter this behavior for VMS; |
2375 | ;; since backup files are not made on VMS, it should not get called. | |
2376 | (defun find-backup-file-name (fn) | |
ffc0e1ca | 2377 | "Find a file name for a backup file FN, and suggestions for deletions. |
b4da00e9 | 2378 | Value is a list whose car is the name for the backup file |
ffc0e1ca AS |
2379 | and whose cdr is a list of old versions to consider deleting now. |
2380 | If the value is nil, don't make a backup. | |
2381 | Uses `backup-directory-alist' in the same way as does | |
2382 | `make-backup-file-name'." | |
eb650569 RS |
2383 | (let ((handler (find-file-name-handler fn 'find-backup-file-name))) |
2384 | ;; Run a handler for this function so that ange-ftp can refuse to do it. | |
2385 | (if handler | |
2386 | (funcall handler 'find-backup-file-name fn) | |
f26d858e EZ |
2387 | (if (or (eq version-control 'never) |
2388 | ;; We don't support numbered backups on plain MS-DOS | |
2389 | ;; when long file names are unavailable. | |
2390 | (and (eq system-type 'ms-dos) | |
2391 | (not (msdos-long-file-names)))) | |
b4da00e9 | 2392 | (list (make-backup-file-name fn)) |
ffc0e1ca AS |
2393 | (let* ((basic-name (make-backup-file-name-1 fn)) |
2394 | (base-versions (concat (file-name-nondirectory basic-name) | |
2395 | ".~")) | |
e2b30772 | 2396 | (backup-extract-version-start (length base-versions)) |
eb650569 | 2397 | (high-water-mark 0) |
ffc0e1ca AS |
2398 | (number-to-delete 0) |
2399 | possibilities deserve-versions-p versions) | |
eb650569 RS |
2400 | (condition-case () |
2401 | (setq possibilities (file-name-all-completions | |
2402 | base-versions | |
ffc0e1ca AS |
2403 | (file-name-directory basic-name)) |
2404 | versions (sort (mapcar #'backup-extract-version | |
2405 | possibilities) | |
2406 | #'<) | |
eb650569 RS |
2407 | high-water-mark (apply 'max 0 versions) |
2408 | deserve-versions-p (or version-control | |
2409 | (> high-water-mark 0)) | |
2410 | number-to-delete (- (length versions) | |
ffc0e1ca AS |
2411 | kept-old-versions |
2412 | kept-new-versions | |
2413 | -1)) | |
2414 | (file-error (setq possibilities nil))) | |
eb650569 | 2415 | (if (not deserve-versions-p) |
ffc0e1ca AS |
2416 | (list (concat basic-name "~")) |
2417 | (cons (format "%s.~%d~" basic-name (1+ high-water-mark)) | |
eb650569 RS |
2418 | (if (and (> number-to-delete 0) |
2419 | ;; Delete nothing if there is overflow | |
2420 | ;; in the number of versions to keep. | |
2421 | (>= (+ kept-new-versions kept-old-versions -1) 0)) | |
ffc0e1ca AS |
2422 | (mapcar (lambda (n) |
2423 | (format "%s.~%d~" basic-name n)) | |
eb650569 RS |
2424 | (let ((v (nthcdr kept-old-versions versions))) |
2425 | (rplacd (nthcdr (1- number-to-delete) v) ()) | |
2426 | v)))))))))) | |
b4da00e9 | 2427 | |
b4da00e9 RM |
2428 | (defun file-nlinks (filename) |
2429 | "Return number of names file FILENAME has." | |
2430 | (car (cdr (file-attributes filename)))) | |
6c636af9 RM |
2431 | |
2432 | (defun file-relative-name (filename &optional directory) | |
ffc0e1ca | 2433 | "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). |
2d6562a5 RS |
2434 | This function returns a relative file name which is equivalent to FILENAME |
2435 | when used with that default directory as the default. | |
2436 | If this is impossible (which can happen on MSDOS and Windows | |
2437 | when the file name and directory use different drive names) | |
2438 | then it returns FILENAME." | |
96c188b0 | 2439 | (save-match-data |
e2b30772 RS |
2440 | (let ((fname (expand-file-name filename))) |
2441 | (setq directory (file-name-as-directory | |
2442 | (expand-file-name (or directory default-directory)))) | |
2443 | ;; On Microsoft OSes, if FILENAME and DIRECTORY have different | |
2444 | ;; drive names, they can't be relative, so return the absolute name. | |
2445 | (if (and (or (eq system-type 'ms-dos) | |
2446 | (eq system-type 'windows-nt)) | |
2447 | (not (string-equal (substring fname 0 2) | |
2448 | (substring directory 0 2)))) | |
2449 | filename | |
9695aac6 RS |
2450 | (let ((ancestor ".") |
2451 | (fname-dir (file-name-as-directory fname))) | |
2452 | (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir)) | |
2453 | (not (string-match (concat "^" (regexp-quote directory)) fname))) | |
e2b30772 | 2454 | (setq directory (file-name-directory (substring directory 0 -1)) |
9695aac6 RS |
2455 | ancestor (if (equal ancestor ".") |
2456 | ".." | |
2457 | (concat "../" ancestor)))) | |
2458 | ;; Now ancestor is empty, or .., or ../.., etc. | |
2459 | (if (string-match (concat "^" (regexp-quote directory)) fname) | |
2460 | ;; We matched within FNAME's directory part. | |
2461 | ;; Add the rest of FNAME onto ANCESTOR. | |
2462 | (let ((rest (substring fname (match-end 0)))) | |
2463 | (if (and (equal ancestor ".") | |
2464 | (not (equal rest ""))) | |
2465 | ;; But don't bother with ANCESTOR if it would give us `./'. | |
2466 | rest | |
2467 | (concat (file-name-as-directory ancestor) rest))) | |
2468 | ;; We matched FNAME's directory equivalent. | |
2469 | ancestor)))))) | |
b4da00e9 RM |
2470 | \f |
2471 | (defun save-buffer (&optional args) | |
2472 | "Save current buffer in visited file if modified. Versions described below. | |
2473 | By default, makes the previous version into a backup file | |
2474 | if previously requested or if this is the first save. | |
ac9650be | 2475 | With 1 \\[universal-argument], marks this version |
b4da00e9 | 2476 | to become a backup when the next save is done. |
ac9650be | 2477 | With 2 \\[universal-argument]'s, |
b4da00e9 | 2478 | unconditionally makes the previous version into a backup file. |
ac9650be RS |
2479 | With 3 \\[universal-argument]'s, marks this version |
2480 | to become a backup when the next save is done, | |
2481 | and unconditionally makes the previous version into a backup file. | |
2482 | ||
749d2ee6 | 2483 | With argument of 0, never make the previous version into a backup file. |
b4da00e9 RM |
2484 | |
2485 | If a file's name is FOO, the names of its numbered backup versions are | |
2486 | FOO.~i~ for various integers i. A non-numbered backup file is called FOO~. | |
2487 | Numeric backups (rather than FOO~) will be made if value of | |
2488 | `version-control' is not the atom `never' and either there are already | |
2489 | numeric versions of the file being backed up, or `version-control' is | |
2490 | non-nil. | |
2491 | We don't want excessive versions piling up, so there are variables | |
2492 | `kept-old-versions', which tells Emacs how many oldest versions to keep, | |
2493 | and `kept-new-versions', which tells how many newest versions to keep. | |
2494 | Defaults are 2 old versions and 2 new. | |
2495 | `dired-kept-versions' controls dired's clean-directory (.) command. | |
de7d5e1b | 2496 | If `delete-old-versions' is nil, system will query user |
e73ec04b RS |
2497 | before trimming versions. Otherwise it does it silently. |
2498 | ||
749d2ee6 RS |
2499 | If `vc-make-backup-files' is nil, which is the default, |
2500 | no backup files are made for files managed by version control. | |
2501 | (This is because the version control system itself records previous versions.) | |
2502 | ||
e73ec04b | 2503 | See the subroutine `basic-save-buffer' for more information." |
b4da00e9 RM |
2504 | (interactive "p") |
2505 | (let ((modp (buffer-modified-p)) | |
2506 | (large (> (buffer-size) 50000)) | |
b5a8e0fc RS |
2507 | (make-backup-files (or (and make-backup-files (not (eq args 0))) |
2508 | (memq args '(16 64))))) | |
b4da00e9 RM |
2509 | (and modp (memq args '(16 64)) (setq buffer-backed-up nil)) |
2510 | (if (and modp large) (message "Saving file %s..." (buffer-file-name))) | |
2511 | (basic-save-buffer) | |
2512 | (and modp (memq args '(4 64)) (setq buffer-backed-up nil)))) | |
2513 | ||
2514 | (defun delete-auto-save-file-if-necessary (&optional force) | |
2515 | "Delete auto-save file for current buffer if `delete-auto-save-files' is t. | |
2516 | Normally delete only if the file was written by this Emacs since | |
2517 | the last real save, but optional arg FORCE non-nil means delete anyway." | |
2518 | (and buffer-auto-save-file-name delete-auto-save-files | |
2519 | (not (string= buffer-file-name buffer-auto-save-file-name)) | |
2520 | (or force (recent-auto-save-p)) | |
2521 | (progn | |
2522 | (condition-case () | |
2523 | (delete-file buffer-auto-save-file-name) | |
2524 | (file-error nil)) | |
2525 | (set-buffer-auto-saved)))) | |
2526 | ||
481f215b KH |
2527 | (defvar auto-save-hook nil |
2528 | "Normal hook run just before auto-saving.") | |
2529 | ||
ffc0e1ca AS |
2530 | (defcustom after-save-hook nil |
2531 | "Normal hook that is run after a buffer is saved to its file." | |
2532 | :options '(executable-make-buffer-file-executable-if-script-p) | |
2533 | :type 'hook | |
2534 | :group 'files) | |
1cc852cc | 2535 | |
0516edee RS |
2536 | (defvar save-buffer-coding-system nil |
2537 | "If non-nil, use this coding system for saving the buffer. | |
2538 | More precisely, use this coding system in place of the | |
2539 | value of `buffer-file-coding-system', when saving the buffer. | |
2540 | Calling `write-region' for any purpose other than saving the buffer | |
2541 | will still use `buffer-file-coding-system'; this variable has no effect | |
2542 | in such cases.") | |
2543 | ||
d5fe94cc RS |
2544 | (make-variable-buffer-local 'save-buffer-coding-system) |
2545 | (put 'save-buffer-coding-system 'permanent-local t) | |
2546 | ||
b4da00e9 | 2547 | (defun basic-save-buffer () |
1cc852cc | 2548 | "Save the current buffer in its visited file, if it has been modified. |
e73ec04b RS |
2549 | The hooks `write-contents-hooks', `local-write-file-hooks' and |
2550 | `write-file-hooks' get a chance to do the job of saving; if they do not, | |
2551 | then the buffer is saved in the visited file file in the usual way. | |
2552 | After saving the buffer, this function runs `after-save-hook'." | |
b4da00e9 | 2553 | (interactive) |
19618231 | 2554 | (save-current-buffer |
c11a94fe RS |
2555 | ;; In an indirect buffer, save its base buffer instead. |
2556 | (if (buffer-base-buffer) | |
2557 | (set-buffer (buffer-base-buffer))) | |
2558 | (if (buffer-modified-p) | |
2559 | (let ((recent-save (recent-auto-save-p)) | |
2560 | setmodes tempsetmodes) | |
2561 | ;; On VMS, rename file and buffer to get rid of version number. | |
2562 | (if (and (eq system-type 'vax-vms) | |
2563 | (not (string= buffer-file-name | |
2564 | (file-name-sans-versions buffer-file-name)))) | |
2565 | (let (buffer-new-name) | |
2566 | ;; Strip VMS version number before save. | |
2567 | (setq buffer-file-name | |
2568 | (file-name-sans-versions buffer-file-name)) | |
2569 | ;; Construct a (unique) buffer name to correspond. | |
2570 | (let ((buf (create-file-buffer (downcase buffer-file-name)))) | |
2571 | (setq buffer-new-name (buffer-name buf)) | |
2572 | (kill-buffer buf)) | |
2573 | (rename-buffer buffer-new-name))) | |
2574 | ;; If buffer has no file name, ask user for one. | |
2575 | (or buffer-file-name | |
182891ef RS |
2576 | (let ((filename |
2577 | (expand-file-name | |
2578 | (read-file-name "File to save in: ") nil))) | |
2579 | (and (file-exists-p filename) | |
2580 | (or (y-or-n-p (format "File `%s' exists; overwrite? " | |
2581 | filename)) | |
2582 | (error "Canceled"))) | |
2583 | (set-visited-file-name filename))) | |
c11a94fe RS |
2584 | (or (verify-visited-file-modtime (current-buffer)) |
2585 | (not (file-exists-p buffer-file-name)) | |
2586 | (yes-or-no-p | |
2587 | (format "%s has changed since visited or saved. Save anyway? " | |
2588 | (file-name-nondirectory buffer-file-name))) | |
2589 | (error "Save not confirmed")) | |
2590 | (save-restriction | |
2591 | (widen) | |
19618231 RS |
2592 | (save-excursion |
2593 | (and (> (point-max) 1) | |
2594 | (/= (char-after (1- (point-max))) ?\n) | |
2595 | (not (and (eq selective-display t) | |
2596 | (= (char-after (1- (point-max))) ?\r))) | |
2597 | (or (eq require-final-newline t) | |
2598 | (and require-final-newline | |
2599 | (y-or-n-p | |
2600 | (format "Buffer %s does not end in newline. Add one? " | |
2601 | (buffer-name))))) | |
2602 | (save-excursion | |
2603 | (goto-char (point-max)) | |
2604 | (insert ?\n)))) | |
fa5867f6 AS |
2605 | ;; Support VC version backups. |
2606 | (vc-before-save) | |
c11a94fe RS |
2607 | (or (run-hook-with-args-until-success 'write-contents-hooks) |
2608 | (run-hook-with-args-until-success 'local-write-file-hooks) | |
2609 | (run-hook-with-args-until-success 'write-file-hooks) | |
2610 | ;; If a hook returned t, file is already "written". | |
2611 | ;; Otherwise, write it the usual way now. | |
2612 | (setq setmodes (basic-save-buffer-1))) | |
d6e8ea6f KH |
2613 | ;; Now we have saved the current buffer. Let's make sure |
2614 | ;; that buffer-file-coding-system is fixed to what | |
2615 | ;; actually used for saving by binding it locally. | |
0516edee RS |
2616 | (if save-buffer-coding-system |
2617 | (setq save-buffer-coding-system last-coding-system-used) | |
2618 | (setq buffer-file-coding-system last-coding-system-used)) | |
2a47b4f5 RS |
2619 | (setq buffer-file-number |
2620 | (nthcdr 10 (file-attributes buffer-file-name))) | |
c11a94fe RS |
2621 | (if setmodes |
2622 | (condition-case () | |
2623 | (set-file-modes buffer-file-name setmodes) | |
2624 | (error nil)))) | |
2625 | ;; If the auto-save file was recent before this command, | |
2626 | ;; delete it now. | |
2627 | (delete-auto-save-file-if-necessary recent-save) | |
49530862 RS |
2628 | ;; Support VC `implicit' locking. |
2629 | (vc-after-save) | |
c11a94fe RS |
2630 | (run-hooks 'after-save-hook)) |
2631 | (message "(No changes need to be saved)")))) | |
b4da00e9 | 2632 | |
87d26afc RS |
2633 | ;; This does the "real job" of writing a buffer into its visited file |
2634 | ;; and making a backup file. This is what is normally done | |
2635 | ;; but inhibited if one of write-file-hooks returns non-nil. | |
2636 | ;; It returns a value to store in setmodes. | |
2637 | (defun basic-save-buffer-1 () | |
d5fe94cc RS |
2638 | (if save-buffer-coding-system |
2639 | (let ((coding-system-for-write save-buffer-coding-system)) | |
2640 | (basic-save-buffer-2)) | |
2641 | (basic-save-buffer-2))) | |
2642 | ||
2643 | (defun basic-save-buffer-2 () | |
2644 | (let (tempsetmodes setmodes) | |
87d26afc RS |
2645 | (if (not (file-writable-p buffer-file-name)) |
2646 | (let ((dir (file-name-directory buffer-file-name))) | |
2647 | (if (not (file-directory-p dir)) | |
83c6f446 RS |
2648 | (if (file-exists-p dir) |
2649 | (error "%s is not a directory" dir) | |
cb2fdcfa | 2650 | (error "%s: no such directory" buffer-file-name)) |
87d26afc RS |
2651 | (if (not (file-exists-p buffer-file-name)) |
2652 | (error "Directory %s write-protected" dir) | |
2653 | (if (yes-or-no-p | |
2654 | (format "File %s is write-protected; try to save anyway? " | |
2655 | (file-name-nondirectory | |
2656 | buffer-file-name))) | |
2657 | (setq tempsetmodes t) | |
2658 | (error "Attempt to save to a file which you aren't allowed to write")))))) | |
2659 | (or buffer-backed-up | |
2660 | (setq setmodes (backup-buffer))) | |
76d5492b | 2661 | (let ((dir (file-name-directory buffer-file-name))) |
f4a0f59b RS |
2662 | (if (and file-precious-flag |
2663 | (file-writable-p dir)) | |
2664 | ;; If file is precious, write temp name, then rename it. | |
2665 | ;; This requires write access to the containing dir, | |
2666 | ;; which is why we don't try it if we don't have that access. | |
2667 | (let ((realname buffer-file-name) | |
6782610c RS |
2668 | tempname temp nogood i succeed |
2669 | (old-modtime (visited-file-modtime))) | |
f4a0f59b RS |
2670 | (setq i 0) |
2671 | (setq nogood t) | |
2672 | ;; Find the temporary name to write under. | |
2673 | (while nogood | |
567c1ca9 | 2674 | (setq tempname (format |
28ee503c KH |
2675 | (if (and (eq system-type 'ms-dos) |
2676 | (not (msdos-long-file-names))) | |
567c1ca9 | 2677 | "%s#%d.tm#" ; MSDOS limits files to 8+3 |
ffc0e1ca AS |
2678 | (if (memq system-type '(vax-vms axp-vms)) |
2679 | "%s$tmp$%d" | |
2680 | "%s#tmp#%d")) | |
567c1ca9 | 2681 | dir i)) |
f4a0f59b RS |
2682 | (setq nogood (file-exists-p tempname)) |
2683 | (setq i (1+ i))) | |
2684 | (unwind-protect | |
2685 | (progn (clear-visited-file-modtime) | |
2686 | (write-region (point-min) (point-max) | |
89095962 RS |
2687 | tempname nil realname |
2688 | buffer-file-truename) | |
f4a0f59b RS |
2689 | (setq succeed t)) |
2690 | ;; If writing the temp file fails, | |
2691 | ;; delete the temp file. | |
76d5492b | 2692 | (or succeed |
6782610c RS |
2693 | (progn |
2694 | (delete-file tempname) | |
2695 | (set-visited-file-modtime old-modtime)))) | |
f4a0f59b RS |
2696 | ;; Since we have created an entirely new file |
2697 | ;; and renamed it, make sure it gets the | |
2698 | ;; right permission bits set. | |
2699 | (setq setmodes (file-modes buffer-file-name)) | |
2700 | ;; We succeeded in writing the temp file, | |
2701 | ;; so rename it. | |
2702 | (rename-file tempname buffer-file-name t)) | |
2703 | ;; If file not writable, see if we can make it writable | |
2704 | ;; temporarily while we write it. | |
2705 | ;; But no need to do so if we have just backed it up | |
2706 | ;; (setmodes is set) because that says we're superseding. | |
2707 | (cond ((and tempsetmodes (not setmodes)) | |
2708 | ;; Change the mode back, after writing. | |
2709 | (setq setmodes (file-modes buffer-file-name)) | |
ffc0e1ca | 2710 | (set-file-modes buffer-file-name (logior setmodes 128)))) |
f4a0f59b | 2711 | (write-region (point-min) (point-max) |
89095962 | 2712 | buffer-file-name nil t buffer-file-truename))) |
87d26afc RS |
2713 | setmodes)) |
2714 | ||
ffc0e1ca | 2715 | (defun save-some-buffers (&optional arg pred) |
b4da00e9 | 2716 | "Save some modified file-visiting buffers. Asks user about each one. |
5bbbceb1 | 2717 | Optional argument (the prefix) non-nil means save all with no questions. |
ffc0e1ca AS |
2718 | Optional second argument PRED determines which buffers are considered: |
2719 | If PRED is nil, all the file-visiting buffers are considered. | |
2720 | If PRED is t, then certain non-file buffers will also be considered. | |
2721 | If PRED is a zero-argument function, it indicates for each buffer whether | |
2722 | to consider it or not when called with that buffer current." | |
b4da00e9 | 2723 | (interactive "P") |
907482b9 | 2724 | (save-window-excursion |
76d5492b RM |
2725 | (let* ((queried nil) |
2726 | (files-done | |
2727 | (map-y-or-n-p | |
2728 | (function | |
2729 | (lambda (buffer) | |
2730 | (and (buffer-modified-p buffer) | |
2731 | (not (buffer-base-buffer buffer)) | |
2732 | (or | |
2733 | (buffer-file-name buffer) | |
ffc0e1ca | 2734 | (and pred |
76d5492b RM |
2735 | (progn |
2736 | (set-buffer buffer) | |
2737 | (and buffer-offer-save (> (buffer-size) 0))))) | |
ffc0e1ca AS |
2738 | (or (not (functionp pred)) |
2739 | (with-current-buffer buffer (funcall pred))) | |
76d5492b RM |
2740 | (if arg |
2741 | t | |
2742 | (setq queried t) | |
2743 | (if (buffer-file-name buffer) | |
2744 | (format "Save file %s? " | |
2745 | (buffer-file-name buffer)) | |
2746 | (format "Save buffer %s? " | |
2747 | (buffer-name buffer))))))) | |
2748 | (function | |
2749 | (lambda (buffer) | |
2750 | (set-buffer buffer) | |
2751 | (save-buffer))) | |
2752 | (buffer-list) | |
2753 | '("buffer" "buffers" "save") | |
2754 | (list (list ?\C-r (lambda (buf) | |
2a9fe1e2 RS |
2755 | (view-buffer buf |
2756 | (function | |
2757 | (lambda (ignore) | |
2758 | (exit-recursive-edit)))) | |
76d5492b RM |
2759 | (recursive-edit) |
2760 | ;; Return nil to ask about BUF again. | |
2761 | nil) | |
2762 | "display the current buffer")))) | |
2763 | (abbrevs-done | |
2764 | (and save-abbrevs abbrevs-changed | |
2765 | (progn | |
2766 | (if (or arg | |
2767 | (y-or-n-p (format "Save abbrevs in %s? " | |
2768 | abbrev-file-name))) | |
2769 | (write-abbrev-file nil)) | |
2770 | ;; Don't keep bothering user if he says no. | |
2771 | (setq abbrevs-changed nil) | |
2772 | t)))) | |
2773 | (or queried (> files-done 0) abbrevs-done | |
5625c2fc | 2774 | (message "(No files need saving)"))))) |
b4da00e9 RM |
2775 | \f |
2776 | (defun not-modified (&optional arg) | |
2777 | "Mark current buffer as unmodified, not needing to be saved. | |
a641f9a1 RM |
2778 | With prefix arg, mark buffer as modified, so \\[save-buffer] will save. |
2779 | ||
2780 | It is not a good idea to use this function in Lisp programs, because it | |
2781 | prints a message in the minibuffer. Instead, use `set-buffer-modified-p'." | |
b4da00e9 RM |
2782 | (interactive "P") |
2783 | (message (if arg "Modification-flag set" | |
2784 | "Modification-flag cleared")) | |
2785 | (set-buffer-modified-p arg)) | |
2786 | ||
2787 | (defun toggle-read-only (&optional arg) | |
2788 | "Change whether this buffer is visiting its file read-only. | |
2a9fe1e2 RS |
2789 | With arg, set read-only iff arg is positive. |
2790 | If visiting file read-only and `view-read-only' is non-nil, enter view mode." | |
b4da00e9 | 2791 | (interactive "P") |
2a9fe1e2 RS |
2792 | (cond |
2793 | ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only | |
2794 | (not buffer-read-only))) ; If buffer-read-only is set correctly, | |
2795 | nil) ; do nothing. | |
2796 | ;; Toggle. | |
2797 | ((and buffer-read-only view-mode) | |
ca597f41 KH |
2798 | (View-exit-and-edit) |
2799 | (make-local-variable 'view-read-only) | |
2800 | (setq view-read-only t)) ; Must leave view mode. | |
2a9fe1e2 RS |
2801 | ((and (not buffer-read-only) view-read-only |
2802 | (not (eq (get major-mode 'mode-class) 'special))) | |
2803 | (view-mode-enter)) | |
2804 | (t (setq buffer-read-only (not buffer-read-only)) | |
2805 | (force-mode-line-update)))) | |
b4da00e9 | 2806 | |
912192d1 | 2807 | (defun insert-file (filename) |
b4da00e9 RM |
2808 | "Insert contents of file FILENAME into buffer after point. |
2809 | Set mark after the inserted text. | |
2810 | ||
2811 | This function is meant for the user to run interactively. | |
2812 | Don't call it from programs! Use `insert-file-contents' instead. | |
2813 | \(Its calling sequence is different; see its documentation)." | |
912192d1 | 2814 | (interactive "*fInsert file: ") |
3be6243a RS |
2815 | (if (file-directory-p filename) |
2816 | (signal 'file-error (list "Opening input file" "file is a directory" | |
2817 | filename))) | |
912192d1 | 2818 | (let ((tem (insert-file-contents filename))) |
b4da00e9 RM |
2819 | (push-mark (+ (point) (car (cdr tem)))))) |
2820 | ||
912192d1 | 2821 | (defun append-to-file (start end filename) |
b4da00e9 RM |
2822 | "Append the contents of the region to the end of file FILENAME. |
2823 | When called from a function, expects three arguments, | |
2824 | START, END and FILENAME. START and END are buffer positions | |
da30bf98 | 2825 | saying what text to write." |
912192d1 KH |
2826 | (interactive "r\nFAppend to file: ") |
2827 | (write-region start end filename t)) | |
b4da00e9 RM |
2828 | |
2829 | (defun file-newest-backup (filename) | |
2830 | "Return most recent backup file for FILENAME or nil if no backups exist." | |
ffc0e1ca AS |
2831 | ;; `make-backup-file-name' will get us the right directory for |
2832 | ;; ordinary or numeric backups. It might create a directory for | |
2833 | ;; backups as a side-effect, according to `backup-directory-alist'. | |
2834 | (let* ((filename (file-name-sans-versions | |
2835 | (make-backup-file-name filename))) | |
b4da00e9 RM |
2836 | (file (file-name-nondirectory filename)) |
2837 | (dir (file-name-directory filename)) | |
2838 | (comp (file-name-all-completions file dir)) | |
cf7e94a0 RS |
2839 | (newest nil) |
2840 | tem) | |
b4da00e9 | 2841 | (while comp |
ffc0e1ca | 2842 | (setq tem (pop comp)) |
cf7e94a0 RS |
2843 | (cond ((and (backup-file-name-p tem) |
2844 | (string= (file-name-sans-versions tem) file)) | |
2845 | (setq tem (concat dir tem)) | |
2846 | (if (or (null newest) | |
2847 | (file-newer-than-file-p tem newest)) | |
2848 | (setq newest tem))))) | |
b4da00e9 RM |
2849 | newest)) |
2850 | ||
2851 | (defun rename-uniquely () | |
2852 | "Rename current buffer to a similar name not already taken. | |
2853 | This function is useful for creating multiple shell process buffers | |
2854 | or multiple mail buffers, etc." | |
2855 | (interactive) | |
40eb8038 | 2856 | (save-match-data |
e0df3aef KH |
2857 | (let ((base-name (buffer-name))) |
2858 | (and (string-match "<[0-9]+>\\'" base-name) | |
2859 | (not (and buffer-file-name | |
2860 | (string= base-name | |
2861 | (file-name-nondirectory buffer-file-name)))) | |
2862 | ;; If the existing buffer name has a <NNN>, | |
2863 | ;; which isn't part of the file name (if any), | |
2864 | ;; then get rid of that. | |
2865 | (setq base-name (substring base-name 0 (match-beginning 0)))) | |
2866 | (rename-buffer (generate-new-buffer-name base-name)) | |
3941fe2c | 2867 | (force-mode-line-update)))) |
5bbbceb1 | 2868 | |
4e43240a | 2869 | (defun make-directory (dir &optional parents) |
5ce8bb89 RS |
2870 | "Create the directory DIR and any nonexistent parent dirs. |
2871 | Interactively, the default choice of directory to create | |
2872 | is the current default directory for file names. | |
0225ae5e | 2873 | That is useful when you have visited a file in a nonexistent directory. |
5ce8bb89 RS |
2874 | |
2875 | Noninteractively, the second (optional) argument PARENTS says whether | |
2876 | to create parent directories if they don't exist." | |
2877 | (interactive | |
2878 | (list (read-file-name "Make directory: " default-directory default-directory | |
2879 | nil nil) | |
2880 | t)) | |
6eaebaa2 | 2881 | (let ((handler (find-file-name-handler dir 'make-directory))) |
4e43240a RS |
2882 | (if handler |
2883 | (funcall handler 'make-directory dir parents) | |
2884 | (if (not parents) | |
2885 | (make-directory-internal dir) | |
2886 | (let ((dir (directory-file-name (expand-file-name dir))) | |
2887 | create-list) | |
2888 | (while (not (file-exists-p dir)) | |
76d5492b | 2889 | (setq create-list (cons dir create-list) |
4e43240a RS |
2890 | dir (directory-file-name (file-name-directory dir)))) |
2891 | (while create-list | |
2892 | (make-directory-internal (car create-list)) | |
2893 | (setq create-list (cdr create-list)))))))) | |
b4da00e9 RM |
2894 | \f |
2895 | (put 'revert-buffer-function 'permanent-local t) | |
2896 | (defvar revert-buffer-function nil | |
0973d78b RS |
2897 | "Function to use to revert this buffer, or nil to do the default. |
2898 | The function receives two arguments IGNORE-AUTO and NOCONFIRM, | |
2899 | which are the arguments that `revert-buffer' received.") | |
b4da00e9 RM |
2900 | |
2901 | (put 'revert-buffer-insert-file-contents-function 'permanent-local t) | |
2902 | (defvar revert-buffer-insert-file-contents-function nil | |
2903 | "Function to use to insert contents when reverting this buffer. | |
2904 | Gets two args, first the nominal file name to use, | |
2df32500 RS |
2905 | and second, t if reading the auto-save file. |
2906 | ||
2907 | The function you specify is responsible for updating (or preserving) point.") | |
b4da00e9 | 2908 | |
5f76e7d4 KH |
2909 | (defvar before-revert-hook nil |
2910 | "Normal hook for `revert-buffer' to run before reverting. | |
2911 | If `revert-buffer-function' is used to override the normal revert | |
2912 | mechanism, this hook is not used.") | |
2913 | ||
2914 | (defvar after-revert-hook nil | |
2915 | "Normal hook for `revert-buffer' to run after reverting. | |
2916 | Note that the hook value that it runs is the value that was in effect | |
2917 | before reverting; that makes a difference if you have buffer-local | |
2918 | hook functions. | |
2919 | ||
2920 | If `revert-buffer-function' is used to override the normal revert | |
2921 | mechanism, this hook is not used.") | |
2922 | ||
1554c03b RS |
2923 | (defvar revert-buffer-internal-hook) |
2924 | ||
9a30563f | 2925 | (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes) |
7e7c9c4e | 2926 | "Replace current buffer text with the text of the visited file on disk. |
b4da00e9 | 2927 | This undoes all changes since the file was visited or saved. |
8c0e7b73 JB |
2928 | With a prefix argument, offer to revert from latest auto-save file, if |
2929 | that is more recent than the visited file. | |
1ab31687 | 2930 | |
7e7c9c4e RS |
2931 | This command also works for special buffers that contain text which |
2932 | doesn't come from a file, but reflects some other data base instead: | |
2933 | for example, Dired buffers and buffer-list buffers. In these cases, | |
2934 | it reconstructs the buffer contents from the appropriate data base. | |
2935 | ||
65ee6096 | 2936 | When called from Lisp, the first argument is IGNORE-AUTO; only offer |
1ab31687 JB |
2937 | to revert from the auto-save file when this is nil. Note that the |
2938 | sense of this argument is the reverse of the prefix argument, for the | |
2939 | sake of backward compatibility. IGNORE-AUTO is optional, defaulting | |
2940 | to nil. | |
2941 | ||
2942 | Optional second argument NOCONFIRM means don't ask for confirmation at | |
ffc0e1ca | 2943 | all. (The local variable `revert-without-query', if non-nil, prevents |
d1f04130 | 2944 | confirmation.) |
b4da00e9 | 2945 | |
5b2b26d5 RS |
2946 | Optional third argument PRESERVE-MODES non-nil means don't alter |
2947 | the files modes. Normally we reinitialize them using `normal-mode'. | |
2948 | ||
8c0e7b73 | 2949 | If the value of `revert-buffer-function' is non-nil, it is called to |
7e7c9c4e RS |
2950 | do all the work for this command. Otherwise, the hooks |
2951 | `before-revert-hook' and `after-revert-hook' are run at the beginning | |
2952 | and the end, and if `revert-buffer-insert-file-contents-function' is | |
2953 | non-nil, it is called instead of rereading visited file contents." | |
fb6208a6 | 2954 | |
1ab31687 JB |
2955 | ;; I admit it's odd to reverse the sense of the prefix argument, but |
2956 | ;; there is a lot of code out there which assumes that the first | |
2957 | ;; argument should be t to avoid consulting the auto-save file, and | |
2958 | ;; there's no straightforward way to encourage authors to notice a | |
2959 | ;; reversal of the argument sense. So I'm just changing the user | |
2960 | ;; interface, but leaving the programmatic interface the same. | |
e0867e99 | 2961 | (interactive (list (not current-prefix-arg))) |
b4da00e9 | 2962 | (if revert-buffer-function |
1ab31687 | 2963 | (funcall revert-buffer-function ignore-auto noconfirm) |
2df32500 | 2964 | (let* ((auto-save-p (and (not ignore-auto) |
1ab31687 | 2965 | (recent-auto-save-p) |
b4da00e9 RM |
2966 | buffer-auto-save-file-name |
2967 | (file-readable-p buffer-auto-save-file-name) | |
2968 | (y-or-n-p | |
2969 | "Buffer has been auto-saved recently. Revert from auto-save file? "))) | |
2970 | (file-name (if auto-save-p | |
2971 | buffer-auto-save-file-name | |
2972 | buffer-file-name))) | |
2973 | (cond ((null file-name) | |
2974 | (error "Buffer does not seem to be associated with any file")) | |
2975 | ((or noconfirm | |
db8c4866 RS |
2976 | (and (not (buffer-modified-p)) |
2977 | (let ((tail revert-without-query) | |
2978 | (found nil)) | |
2979 | (while tail | |
2980 | (if (string-match (car tail) file-name) | |
2981 | (setq found t)) | |
2982 | (setq tail (cdr tail))) | |
2983 | found)) | |
b4da00e9 RM |
2984 | (yes-or-no-p (format "Revert buffer from file %s? " |
2985 | file-name))) | |
4fbf62ee | 2986 | (run-hooks 'before-revert-hook) |
b4da00e9 RM |
2987 | ;; If file was backed up but has changed since, |
2988 | ;; we shd make another backup. | |
2989 | (and (not auto-save-p) | |
5bbbceb1 | 2990 | (not (verify-visited-file-modtime (current-buffer))) |
b4da00e9 RM |
2991 | (setq buffer-backed-up nil)) |
2992 | ;; Get rid of all undo records for this buffer. | |
2993 | (or (eq buffer-undo-list t) | |
2994 | (setq buffer-undo-list nil)) | |
ba5c8c93 KH |
2995 | ;; Effectively copy the after-revert-hook status, |
2996 | ;; since after-find-file will clobber it. | |
2997 | (let ((global-hook (default-value 'after-revert-hook)) | |
2998 | (local-hook-p (local-variable-p 'after-revert-hook)) | |
2999 | (local-hook (and (local-variable-p 'after-revert-hook) | |
3000 | after-revert-hook))) | |
3001 | (let (buffer-read-only | |
3002 | ;; Don't make undo records for the reversion. | |
3003 | (buffer-undo-list t)) | |
3004 | (if revert-buffer-insert-file-contents-function | |
3005 | (funcall revert-buffer-insert-file-contents-function | |
3006 | file-name auto-save-p) | |
3007 | (if (not (file-exists-p file-name)) | |
3008 | (error "File %s no longer exists!" file-name)) | |
3009 | ;; Bind buffer-file-name to nil | |
3010 | ;; so that we don't try to lock the file. | |
3011 | (let ((buffer-file-name nil)) | |
3012 | (or auto-save-p | |
3013 | (unlock-buffer))) | |
3014 | (widen) | |
b77d8211 KH |
3015 | (let ((coding-system-for-read |
3016 | ;; Auto-saved file shoule be read without | |
3017 | ;; any code conversion. | |
3018 | (if auto-save-p 'no-conversion | |
3019 | coding-system-for-read))) | |
2df32500 | 3020 | ;; Note that this preserves point in an intelligent way. |
b77d8211 KH |
3021 | (insert-file-contents file-name (not auto-save-p) |
3022 | nil nil t)))) | |
ba5c8c93 KH |
3023 | ;; Recompute the truename in case changes in symlinks |
3024 | ;; have changed the truename. | |
3025 | (setq buffer-file-truename | |
3026 | (abbreviate-file-name (file-truename buffer-file-name))) | |
9a30563f | 3027 | (after-find-file nil nil t t preserve-modes) |
ba5c8c93 KH |
3028 | ;; Run after-revert-hook as it was before we reverted. |
3029 | (setq-default revert-buffer-internal-hook global-hook) | |
3030 | (if local-hook-p | |
3031 | (progn | |
3032 | (make-local-variable 'revert-buffer-internal-hook) | |
3033 | (setq revert-buffer-internal-hook local-hook)) | |
3034 | (kill-local-variable 'revert-buffer-internal-hook)) | |
3035 | (run-hooks 'revert-buffer-internal-hook)) | |
4fbf62ee | 3036 | t))))) |
b4da00e9 RM |
3037 | |
3038 | (defun recover-file (file) | |
3039 | "Visit file FILE, but get contents from its last auto-save file." | |
10f7c7fc RS |
3040 | ;; Actually putting the file name in the minibuffer should be used |
3041 | ;; only rarely. | |
3042 | ;; Not just because users often use the default. | |
e1dadc17 | 3043 | (interactive "FRecover file: ") |
b4da00e9 | 3044 | (setq file (expand-file-name file)) |
f7da6740 RS |
3045 | (if (auto-save-file-name-p (file-name-nondirectory file)) |
3046 | (error "%s is an auto-save file" file)) | |
b4da00e9 RM |
3047 | (let ((file-name (let ((buffer-file-name file)) |
3048 | (make-auto-save-file-name)))) | |
945e1965 RS |
3049 | (cond ((if (file-exists-p file) |
3050 | (not (file-newer-than-file-p file-name file)) | |
3051 | (not (file-exists-p file-name))) | |
b4da00e9 RM |
3052 | (error "Auto-save file %s not current" file-name)) |
3053 | ((save-window-excursion | |
ffc0e1ca AS |
3054 | (with-output-to-temp-buffer "*Directory*" |
3055 | (buffer-disable-undo standard-output) | |
3056 | (save-excursion | |
3057 | (let ((switches dired-listing-switches)) | |
3058 | (if (file-symlink-p file) | |
3059 | (setq switches (concat switches "L"))) | |
3060 | (set-buffer standard-output) | |
3061 | (insert-directory file switches) | |
3062 | (insert-directory file-name switches)))) | |
b4da00e9 RM |
3063 | (yes-or-no-p (format "Recover auto save file %s? " file-name))) |
3064 | (switch-to-buffer (find-file-noselect file t)) | |
82d0954a | 3065 | (let ((buffer-read-only nil) |
1e87edf5 KH |
3066 | ;; Keep the current buffer-file-coding-system. |
3067 | (coding-system buffer-file-coding-system) | |
82d0954a KH |
3068 | ;; Auto-saved file shoule be read without any code conversion. |
3069 | (coding-system-for-read 'no-conversion)) | |
b4da00e9 | 3070 | (erase-buffer) |
1e87edf5 KH |
3071 | (insert-file-contents file-name nil) |
3072 | (set-buffer-file-coding-system coding-system)) | |
8cfb9d46 | 3073 | (after-find-file nil nil t)) |
ffa7ab70 | 3074 | (t (error "Recover-file cancelled"))))) |
b4da00e9 | 3075 | |
6598027d | 3076 | (defun recover-session () |
9aee5392 RS |
3077 | "Recover auto save files from a previous Emacs session. |
3078 | This command first displays a Dired buffer showing you the | |
3079 | previous sessions that you could recover from. | |
3080 | To choose one, move point to the proper line and then type C-c C-c. | |
3081 | Then you'll be asked about a number of files to recover." | |
3082 | (interactive) | |
363a5030 RS |
3083 | (if (null auto-save-list-file-prefix) |
3084 | (error "You set `auto-save-list-file-prefix' to disable making session files")) | |
ffc0e1ca AS |
3085 | (let ((dir (file-name-directory auto-save-list-file-prefix))) |
3086 | (unless (file-directory-p dir) | |
3087 | (make-directory dir t))) | |
6f4983e6 | 3088 | (let ((ls-lisp-support-shell-wildcards t)) |
7b3478a5 RS |
3089 | (dired (concat auto-save-list-file-prefix "*") |
3090 | (concat dired-listing-switches "t"))) | |
05e076c7 AS |
3091 | (save-excursion |
3092 | (goto-char (point-min)) | |
3093 | (or (looking-at " Move to the session you want to recover,") | |
3094 | (let ((inhibit-read-only t)) | |
3095 | ;; Each line starts with a space | |
3096 | ;; so that Font Lock mode won't highlight the first character. | |
3097 | (insert " Move to the session you want to recover,\n" | |
3098 | " then type C-c C-c to select it.\n\n" | |
3099 | " You can also delete some of these files;\n" | |
3100 | " type d on a line to mark that file for deletion.\n\n")))) | |
9aee5392 | 3101 | (use-local-map (nconc (make-sparse-keymap) (current-local-map))) |
80280bb7 | 3102 | (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish)) |
9aee5392 | 3103 | |
80280bb7 | 3104 | (defun recover-session-finish () |
9aee5392 RS |
3105 | "Choose one saved session to recover auto-save files from. |
3106 | This command is used in the special Dired buffer created by | |
80280bb7 | 3107 | \\[recover-session]." |
9aee5392 RS |
3108 | (interactive) |
3109 | ;; Get the name of the session file to recover from. | |
3110 | (let ((file (dired-get-filename)) | |
953a03b2 | 3111 | files |
9aee5392 | 3112 | (buffer (get-buffer-create " *recover*"))) |
c11032b9 | 3113 | (dired-unmark 1) |
033ef863 | 3114 | (dired-do-flagged-delete t) |
9aee5392 RS |
3115 | (unwind-protect |
3116 | (save-excursion | |
3117 | ;; Read in the auto-save-list file. | |
3118 | (set-buffer buffer) | |
3119 | (erase-buffer) | |
3120 | (insert-file-contents file) | |
953a03b2 RS |
3121 | ;; Loop thru the text of that file |
3122 | ;; and get out the names of the files to recover. | |
3123 | (while (not (eobp)) | |
3124 | (let (thisfile autofile) | |
3125 | (if (eolp) | |
3126 | ;; This is a pair of lines for a non-file-visiting buffer. | |
3127 | ;; Get the auto-save file name and manufacture | |
3128 | ;; a "visited file name" from that. | |
3129 | (progn | |
3130 | (forward-line 1) | |
3131 | (setq autofile | |
3132 | (buffer-substring-no-properties | |
3133 | (point) | |
3134 | (save-excursion | |
3135 | (end-of-line) | |
3136 | (point)))) | |
3137 | (setq thisfile | |
3138 | (expand-file-name | |
3139 | (substring | |
3140 | (file-name-nondirectory autofile) | |
3141 | 1 -1) | |
3142 | (file-name-directory autofile))) | |
3143 | (forward-line 1)) | |
3144 | ;; This pair of lines is a file-visiting | |
3145 | ;; buffer. Use the visited file name. | |
3146 | (progn | |
3147 | (setq thisfile | |
3148 | (buffer-substring-no-properties | |
3149 | (point) (progn (end-of-line) (point)))) | |
3150 | (forward-line 1) | |
3151 | (setq autofile | |
3152 | (buffer-substring-no-properties | |
3153 | (point) (progn (end-of-line) (point)))) | |
3154 | (forward-line 1))) | |
3155 | ;; Ignore a file if its auto-save file does not exist now. | |
3156 | (if (file-exists-p autofile) | |
3157 | (setq files (cons thisfile files))))) | |
3158 | (setq files (nreverse files)) | |
945e1965 RS |
3159 | ;; The file contains a pair of line for each auto-saved buffer. |
3160 | ;; The first line of the pair contains the visited file name | |
3161 | ;; or is empty if the buffer was not visiting a file. | |
3162 | ;; The second line is the auto-save file name. | |
953a03b2 RS |
3163 | (if files |
3164 | (map-y-or-n-p "Recover %s? " | |
3165 | (lambda (file) | |
3166 | (condition-case nil | |
3167 | (save-excursion (recover-file file)) | |
76d5492b | 3168 | (error |
953a03b2 RS |
3169 | "Failed to recover `%s'" file))) |
3170 | files | |
3171 | '("file" "files" "recover")) | |
3172 | (message "No files can be recovered from this session now"))) | |
9aee5392 RS |
3173 | (kill-buffer buffer)))) |
3174 | ||
73ba610a RS |
3175 | (defun kill-some-buffers (&optional list) |
3176 | "For each buffer in LIST, ask whether to kill it. | |
3177 | LIST defaults to all existing live buffers." | |
b4da00e9 | 3178 | (interactive) |
73ba610a RS |
3179 | (if (null list) |
3180 | (setq list (buffer-list))) | |
3181 | (while list | |
3182 | (let* ((buffer (car list)) | |
3183 | (name (buffer-name buffer))) | |
3184 | (and (not (string-equal name "")) | |
3185 | (/= (aref name 0) ? ) | |
3186 | (yes-or-no-p | |
3187 | (format "Buffer %s %s. Kill? " | |
3188 | name | |
3189 | (if (buffer-modified-p buffer) | |
3190 | "HAS BEEN EDITED" "is unmodified"))) | |
3191 | (kill-buffer buffer))) | |
3192 | (setq list (cdr list)))) | |
b4da00e9 RM |
3193 | \f |
3194 | (defun auto-save-mode (arg) | |
3195 | "Toggle auto-saving of contents of current buffer. | |
f3e23606 | 3196 | With prefix argument ARG, turn auto-saving on if positive, else off." |
b4da00e9 RM |
3197 | (interactive "P") |
3198 | (setq buffer-auto-save-file-name | |
3199 | (and (if (null arg) | |
74b9c2af | 3200 | (or (not buffer-auto-save-file-name) |
4e0c8650 | 3201 | ;; If auto-save is off because buffer has shrunk, |
74b9c2af RS |
3202 | ;; then toggling should turn it on. |
3203 | (< buffer-saved-size 0)) | |
b4da00e9 RM |
3204 | (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0)))) |
3205 | (if (and buffer-file-name auto-save-visited-file-name | |
3206 | (not buffer-read-only)) | |
3207 | buffer-file-name | |
3208 | (make-auto-save-file-name)))) | |
0b7f1ef2 RS |
3209 | ;; If -1 was stored here, to temporarily turn off saving, |
3210 | ;; turn it back on. | |
3211 | (and (< buffer-saved-size 0) | |
3212 | (setq buffer-saved-size 0)) | |
b4da00e9 RM |
3213 | (if (interactive-p) |
3214 | (message "Auto-save %s (in this buffer)" | |
3215 | (if buffer-auto-save-file-name "on" "off"))) | |
3216 | buffer-auto-save-file-name) | |
3217 | ||
3218 | (defun rename-auto-save-file () | |
3219 | "Adjust current buffer's auto save file name for current conditions. | |
3220 | Also rename any existing auto save file, if it was made in this session." | |
3221 | (let ((osave buffer-auto-save-file-name)) | |
3222 | (setq buffer-auto-save-file-name | |
3223 | (make-auto-save-file-name)) | |
3224 | (if (and osave buffer-auto-save-file-name | |
3225 | (not (string= buffer-auto-save-file-name buffer-file-name)) | |
3226 | (not (string= buffer-auto-save-file-name osave)) | |
3227 | (file-exists-p osave) | |
3228 | (recent-auto-save-p)) | |
3229 | (rename-file osave buffer-auto-save-file-name t)))) | |
3230 | ||
3231 | (defun make-auto-save-file-name () | |
3232 | "Return file name to use for auto-saves of current buffer. | |
3233 | Does not consider `auto-save-visited-file-name' as that variable is checked | |
3234 | before calling this function. You can redefine this for customization. | |
3235 | See also `auto-save-file-name-p'." | |
3236 | (if buffer-file-name | |
ffc0e1ca AS |
3237 | (let ((list auto-save-file-name-transforms) |
3238 | (filename buffer-file-name) | |
3239 | result) | |
3240 | ;; Apply user-specified translations | |
3241 | ;; to the file name. | |
3242 | (while (and list (not result)) | |
3243 | (if (string-match (car (car list)) filename) | |
3244 | (setq result (replace-match (cadr (car list)) t nil | |
3245 | filename))) | |
3246 | (setq list (cdr list))) | |
3247 | (if result (setq filename result)) | |
3248 | ||
3249 | (if (and (eq system-type 'ms-dos) | |
3250 | (not (msdos-long-file-names))) | |
3251 | (let ((fn (file-name-nondirectory buffer-file-name))) | |
3252 | (string-match "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" fn) | |
3253 | (concat (file-name-directory buffer-file-name) | |
3254 | "#" (match-string 1 fn) | |
3255 | "." (match-string 3 fn) "#")) | |
3256 | (concat (file-name-directory filename) | |
3257 | "#" | |
3258 | (file-name-nondirectory filename) | |
3259 | "#"))) | |
0a1763b4 RS |
3260 | |
3261 | ;; Deal with buffers that don't have any associated files. (Mail | |
3262 | ;; mode tends to create a good number of these.) | |
3263 | ||
7d483e8c | 3264 | (let ((buffer-name (buffer-name)) |
0a1763b4 | 3265 | (limit 0)) |
c3348e10 RS |
3266 | ;; Eliminate all slashes and backslashes by |
3267 | ;; replacing them with sequences that start with %. | |
3268 | ;; Quote % also, to keep distinct names distinct. | |
3269 | (while (string-match "[/\\%]" buffer-name limit) | |
3270 | (let* ((character (aref buffer-name (match-beginning 0))) | |
3271 | (replacement | |
3272 | (cond ((eq character ?%) "%%") | |
3273 | ((eq character ?/) "%+") | |
3274 | ((eq character ?\\) "%-")))) | |
3275 | (setq buffer-name (replace-match replacement t t buffer-name)) | |
3276 | (setq limit (1+ (match-end 0))))) | |
a8abaf83 RS |
3277 | ;; Generate the file name. |
3278 | (expand-file-name | |
3279 | (format "#%s#%s#" buffer-name (make-temp-name "")) | |
3280 | ;; Try a few alternative directories, to get one we can write it. | |
3281 | (cond | |
3282 | ((file-writable-p default-directory) default-directory) | |
3283 | ((file-writable-p "/var/tmp/") "/var/tmp/") | |
3284 | ("~/")))))) | |
b4da00e9 RM |
3285 | |
3286 | (defun auto-save-file-name-p (filename) | |
3287 | "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'. | |
3288 | FILENAME should lack slashes. You can redefine this for customization." | |
3289 | (string-match "^#.*#$" filename)) | |
3290 | \f | |
6f4983e6 RS |
3291 | (defun wildcard-to-regexp (wildcard) |
3292 | "Given a shell file name pattern WILDCARD, return an equivalent regexp. | |
3293 | The generated regexp will match a filename iff the filename | |
3294 | matches that wildcard according to shell rules. Only wildcards known | |
3295 | by `sh' are supported." | |
3296 | (let* ((i (string-match "[[.*+\\^$?]" wildcard)) | |
3297 | ;; Copy the initial run of non-special characters. | |
3298 | (result (substring wildcard 0 i)) | |
3299 | (len (length wildcard))) | |
3300 | ;; If no special characters, we're almost done. | |
3301 | (if i | |
3302 | (while (< i len) | |
3303 | (let ((ch (aref wildcard i)) | |
3304 | j) | |
3305 | (setq | |
3306 | result | |
3307 | (concat result | |
3308 | (cond | |
7e7c9c4e RS |
3309 | ((and (eq ch ?\[) |
3310 | (< (1+ i) len) | |
3311 | (eq (aref wildcard (1+ i)) ?\])) | |
3312 | "\\[") | |
6f4983e6 RS |
3313 | ((eq ch ?\[) ; [...] maps to regexp char class |
3314 | (progn | |
3315 | (setq i (1+ i)) | |
3316 | (concat | |
3317 | (cond | |
3318 | ((eq (aref wildcard i) ?!) ; [!...] -> [^...] | |
3319 | (progn | |
3320 | (setq i (1+ i)) | |
3321 | (if (eq (aref wildcard i) ?\]) | |
3322 | (progn | |
3323 | (setq i (1+ i)) | |
3324 | "[^]") | |
3325 | "[^"))) | |
3326 | ((eq (aref wildcard i) ?^) | |
3327 | ;; Found "[^". Insert a `\0' character | |
3328 | ;; (which cannot happen in a filename) | |
3329 | ;; into the character class, so that `^' | |
3330 | ;; is not the first character after `[', | |
3331 | ;; and thus non-special in a regexp. | |
3332 | (progn | |
3333 | (setq i (1+ i)) | |
3334 | "[\000^")) | |
3335 | ((eq (aref wildcard i) ?\]) | |
3336 | ;; I don't think `]' can appear in a | |
3337 | ;; character class in a wildcard, but | |
3338 | ;; let's be general here. | |
3339 | (progn | |
3340 | (setq i (1+ i)) | |
3341 | "[]")) | |
3342 | (t "[")) | |
3343 | (prog1 ; copy everything upto next `]'. | |
3344 | (substring wildcard | |
3345 | i | |
3346 | (setq j (string-match | |
3347 | "]" wildcard i))) | |
3348 | (setq i (if j (1- j) (1- len))))))) | |
3349 | ((eq ch ?.) "\\.") | |
3350 | ((eq ch ?*) "[^\000]*") | |
3351 | ((eq ch ?+) "\\+") | |
3352 | ((eq ch ?^) "\\^") | |
3353 | ((eq ch ?$) "\\$") | |
3354 | ((eq ch ?\\) "\\\\") ; probably cannot happen... | |
3355 | ((eq ch ??) "[^\000]") | |
3356 | (t (char-to-string ch))))) | |
3357 | (setq i (1+ i))))) | |
3358 | ;; Shell wildcards should match the entire filename, | |
3359 | ;; not its part. Make the regexp say so. | |
3360 | (concat "\\`" result "\\'"))) | |
3361 | \f | |
21540597 | 3362 | (defcustom list-directory-brief-switches |
b4da00e9 | 3363 | (if (eq system-type 'vax-vms) "" "-CF") |
ffc0e1ca | 3364 | "*Switches for `list-directory' to pass to `ls' for brief listing." |
21540597 RS |
3365 | :type 'string |
3366 | :group 'dired) | |
b4da00e9 | 3367 | |
21540597 | 3368 | (defcustom list-directory-verbose-switches |
b4da00e9 RM |
3369 | (if (eq system-type 'vax-vms) |
3370 | "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)" | |
3371 | "-l") | |
ffc0e1ca | 3372 | "*Switches for `list-directory' to pass to `ls' for verbose listing." |
21540597 RS |
3373 | :type 'string |
3374 | :group 'dired) | |
b4da00e9 | 3375 | |
5de148a2 RS |
3376 | (defun file-expand-wildcards (pattern &optional full) |
3377 | "Expand wildcard pattern PATTERN. | |
4db2a7de RS |
3378 | This returns a list of file names which match the pattern. |
3379 | ||
3380 | If PATTERN is written as an absolute relative file name, | |
3381 | the values are absolute also. | |
3382 | ||
3383 | If PATTERN is written as a relative file name, it is interpreted | |
3384 | relative to the current default directory, `default-directory'. | |
3385 | The file names returned are normally also relative to the current | |
3386 | default directory. However, if FULL is non-nil, they are absolute." | |
3387 | (let* ((nondir (file-name-nondirectory pattern)) | |
3388 | (dirpart (file-name-directory pattern)) | |
3389 | ;; A list of all dirs that DIRPART specifies. | |
3390 | ;; This can be more than one dir | |
3391 | ;; if DIRPART contains wildcards. | |
18b0f8cf | 3392 | (dirs (if (and dirpart (string-match "[[*?]" dirpart)) |
4db2a7de RS |
3393 | (mapcar 'file-name-as-directory |
3394 | (file-expand-wildcards (directory-file-name dirpart))) | |
3395 | (list dirpart))) | |
3396 | contents) | |
3397 | (while dirs | |
3398 | (when (or (null (car dirs)) ; Possible if DIRPART is not wild. | |
3399 | (file-directory-p (directory-file-name (car dirs)))) | |
3400 | (let ((this-dir-contents | |
18b0f8cf AS |
3401 | ;; Filter out "." and ".." |
3402 | (delq nil | |
3403 | (mapcar #'(lambda (name) | |
3404 | (unless (string-match "\\`\\.\\.?\\'" | |
3405 | (file-name-nondirectory name)) | |
3406 | name)) | |
3407 | (directory-files (or (car dirs) ".") full | |
3408 | (wildcard-to-regexp nondir)))))) | |
4db2a7de RS |
3409 | (setq contents |
3410 | (nconc | |
3411 | (if (and (car dirs) (not full)) | |
3412 | (mapcar (function (lambda (name) (concat (car dirs) name))) | |
3413 | this-dir-contents) | |
3414 | this-dir-contents) | |
3415 | contents)))) | |
3416 | (setq dirs (cdr dirs))) | |
3417 | contents)) | |
5de148a2 | 3418 | |
b4da00e9 RM |
3419 | (defun list-directory (dirname &optional verbose) |
3420 | "Display a list of files in or matching DIRNAME, a la `ls'. | |
3421 | DIRNAME is globbed by the shell if necessary. | |
3422 | Prefix arg (second arg if noninteractive) means supply -l switch to `ls'. | |
3423 | Actions controlled by variables `list-directory-brief-switches' | |
3424 | and `list-directory-verbose-switches'." | |
3425 | (interactive (let ((pfx current-prefix-arg)) | |
3426 | (list (read-file-name (if pfx "List directory (verbose): " | |
3427 | "List directory (brief): ") | |
3428 | nil default-directory nil) | |
3429 | pfx))) | |
3430 | (let ((switches (if verbose list-directory-verbose-switches | |
3431 | list-directory-brief-switches))) | |
3432 | (or dirname (setq dirname default-directory)) | |
3433 | (setq dirname (expand-file-name dirname)) | |
3434 | (with-output-to-temp-buffer "*Directory*" | |
3435 | (buffer-disable-undo standard-output) | |
3436 | (princ "Directory ") | |
3437 | (princ dirname) | |
3438 | (terpri) | |
c3554e95 RS |
3439 | (save-excursion |
3440 | (set-buffer "*Directory*") | |
5a8a160e RS |
3441 | (setq default-directory |
3442 | (if (file-directory-p dirname) | |
3443 | (file-name-as-directory dirname) | |
3444 | (file-name-directory dirname))) | |
c3554e95 RS |
3445 | (let ((wildcard (not (file-directory-p dirname)))) |
3446 | (insert-directory dirname switches wildcard (not wildcard))))))) | |
3447 | ||
ffc0e1ca AS |
3448 | (defun shell-quote-wildcard-pattern (pattern) |
3449 | "Quote characters special to the shell in PATTERN, leave wildcards alone. | |
3450 | ||
3451 | PATTERN is assumed to represent a file-name wildcard suitable for the | |
3452 | underlying filesystem. For Unix and GNU/Linux, the characters from the | |
3453 | set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all | |
3454 | the parts of the pattern which don't include wildcard characters are | |
3455 | quoted with double quotes. | |
3456 | Existing quote characters in PATTERN are left alone, so you can pass | |
3457 | PATTERN that already quotes some of the special characters." | |
3458 | (save-match-data | |
3459 | (cond | |
3460 | ((memq system-type '(ms-dos windows-nt)) | |
3461 | ;; DOS/Windows don't allow `"' in file names. So if the | |
3462 | ;; argument has quotes, we can safely assume it is already | |
3463 | ;; quoted by the caller. | |
3464 | (if (or (string-match "[\"]" pattern) | |
3465 | ;; We quote [&()#$'] in case their shell is a port of a | |
3466 | ;; Unixy shell. We quote [,=+] because stock DOS and | |
3467 | ;; Windows shells require that in some cases, such as | |
3468 | ;; passing arguments to batch files that use positional | |
3469 | ;; arguments like %1. | |
3470 | (not (string-match "[ \t;&()#$',=+]" pattern))) | |
3471 | pattern | |
3472 | (let ((result "\"") | |
3473 | (beg 0) | |
3474 | end) | |
3475 | (while (string-match "[*?]+" pattern beg) | |
3476 | (setq end (match-beginning 0) | |
3477 | result (concat result (substring pattern beg end) | |
3478 | "\"" | |
3479 | (substring pattern end (match-end 0)) | |
3480 | "\"") | |
3481 | beg (match-end 0))) | |
3482 | (concat result (substring pattern beg) "\"")))) | |
3483 | (t | |
3484 | (let ((beg 0)) | |
3485 | (while (string-match "[ \t\n;<>&|()#$]" pattern beg) | |
3486 | (setq pattern | |
3487 | (concat (substring pattern 0 (match-beginning 0)) | |
3488 | "\\" | |
3489 | (substring pattern (match-beginning 0))) | |
3490 | beg (1+ (match-end 0))))) | |
3491 | pattern)))) | |
3492 | ||
3493 | ||
c3554e95 RS |
3494 | (defvar insert-directory-program "ls" |
3495 | "Absolute or relative name of the `ls' program used by `insert-directory'.") | |
3496 | ||
3497 | ;; insert-directory | |
3498 | ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and | |
3499 | ;; FULL-DIRECTORY-P is nil. | |
3500 | ;; The single line of output must display FILE's name as it was | |
3501 | ;; given, namely, an absolute path name. | |
3502 | ;; - must insert exactly one line for each file if WILDCARD or | |
3503 | ;; FULL-DIRECTORY-P is t, plus one optional "total" line | |
3504 | ;; before the file lines, plus optional text after the file lines. | |
3505 | ;; Lines are delimited by "\n", so filenames containing "\n" are not | |
3506 | ;; allowed. | |
3507 | ;; File lines should display the basename. | |
3508 | ;; - must be consistent with | |
3509 | ;; - functions dired-move-to-filename, (these two define what a file line is) | |
3510 | ;; dired-move-to-end-of-filename, | |
3511 | ;; dired-between-files, (shortcut for (not (dired-move-to-filename))) | |
3512 | ;; dired-insert-headerline | |
3513 | ;; dired-after-subdir-garbage (defines what a "total" line is) | |
3514 | ;; - variable dired-subdir-regexp | |
3515 | (defun insert-directory (file switches &optional wildcard full-directory-p) | |
a18b7c81 | 3516 | "Insert directory listing for FILE, formatted according to SWITCHES. |
c3554e95 | 3517 | Leaves point after the inserted text. |
727d277d | 3518 | SWITCHES may be a string of options, or a list of strings. |
c3554e95 RS |
3519 | Optional third arg WILDCARD means treat FILE as shell wildcard. |
3520 | Optional fourth arg FULL-DIRECTORY-P means file is a directory and | |
3521 | switches do not contain `d', so that a full listing is expected. | |
3522 | ||
3523 | This works by running a directory listing program | |
406e12d9 | 3524 | whose name is in the variable `insert-directory-program'. |
c3554e95 | 3525 | If WILDCARD, it also runs the shell specified by `shell-file-name'." |
c870ab8e | 3526 | ;; We need the directory in order to find the right handler. |
d2473540 AS |
3527 | (let ((handler (find-file-name-handler (expand-file-name file) |
3528 | 'insert-directory))) | |
ffc0e1ca | 3529 | (if handler |
c3554e95 RS |
3530 | (funcall handler 'insert-directory file switches |
3531 | wildcard full-directory-p) | |
b4da00e9 | 3532 | (if (eq system-type 'vax-vms) |
c3554e95 | 3533 | (vms-read-directory file switches (current-buffer)) |
73ba53dc KH |
3534 | (let* ((coding-system-for-read |
3535 | (and enable-multibyte-characters | |
3536 | (or file-name-coding-system | |
3537 | default-file-name-coding-system))) | |
6a97049b | 3538 | ;; This is to control encoding the arguments in call-process. |
a9173359 | 3539 | (coding-system-for-write coding-system-for-read) |
73ba53dc KH |
3540 | (result |
3541 | (if wildcard | |
ffc0e1ca | 3542 | ;; Run ls in the directory of the file pattern we asked for |
d2473540 AS |
3543 | (let ((default-directory |
3544 | (if (file-name-absolute-p file) | |
3545 | (file-name-directory file) | |
3546 | (file-name-directory (expand-file-name file)))) | |
ffc0e1ca AS |
3547 | (pattern (file-name-nondirectory file))) |
3548 | (call-process | |
3549 | shell-file-name nil t nil | |
3550 | "-c" (concat (if (memq system-type '(ms-dos windows-nt)) | |
3551 | "" | |
3552 | "\\") ; Disregard Unix shell aliases! | |
3553 | insert-directory-program | |
3554 | " -d " | |
3555 | (if (stringp switches) | |
3556 | switches | |
3557 | (mapconcat 'identity switches " ")) | |
3558 | " -- " | |
3559 | ;; Quote some characters that have | |
3560 | ;; special meanings in shells; but | |
3561 | ;; don't quote the wildcards--we | |
3562 | ;; want them to be special. We | |
3563 | ;; also currently don't quote the | |
3564 | ;; quoting characters in case | |
3565 | ;; people want to use them | |
3566 | ;; explicitly to quote wildcard | |
3567 | ;; characters. | |
3568 | (shell-quote-wildcard-pattern pattern)))) | |
73ba53dc KH |
3569 | ;; SunOS 4.1.3, SVr4 and others need the "." to list the |
3570 | ;; directory if FILE is a symbolic link. | |
3571 | (apply 'call-process | |
ffc0e1ca AS |
3572 | insert-directory-program nil t nil |
3573 | (append | |
3574 | (if (listp switches) switches | |
3575 | (unless (equal switches "") | |
3576 | ;; Split the switches at any spaces so we can | |
3577 | ;; pass separate options as separate args. | |
3578 | (split-string switches))) | |
3579 | ;; Avoid lossage if FILE starts with `-'. | |
3580 | '("--") | |
3581 | (progn | |
3582 | (if (string-match "\\`~" file) | |
3583 | (setq file (expand-file-name file))) | |
3584 | (list | |
3585 | (if full-directory-p | |
3586 | (concat (file-name-as-directory file) ".") | |
3587 | file)))))))) | |
73ba53dc | 3588 | (if (/= result 0) |
ffc0e1ca AS |
3589 | ;; We get here if `insert-directory-program' failed. |
3590 | ;; On non-Posix systems, we cannot open a directory, so | |
3591 | ;; don't even try, because that will always result in | |
3592 | ;; the ubiquitous "Access denied". Instead, show them | |
3593 | ;; the `ls' command line and let them guess what went | |
3594 | ;; wrong. | |
3595 | (if (and (file-directory-p file) | |
3596 | (memq system-type '(ms-dos windows-nt))) | |
3597 | (error | |
3598 | "Reading directory: \"%s %s -- %s\" exited with status %s" | |
3599 | insert-directory-program | |
3600 | (if (listp switches) (concat switches) switches) | |
3601 | file result) | |
3602 | ;; Unix. Access the file to get a suitable error. | |
3603 | (access-file file "Reading directory")) | |
3604 | ;; Replace "total" with "used", to avoid confusion. | |
3605 | ;; Add in the amount of free space. | |
3606 | (save-excursion | |
3607 | (goto-char (point-min)) | |
3608 | (when (re-search-forward "^total" nil t) | |
3609 | (replace-match "used") | |
3610 | (end-of-line) | |
3611 | (let (available) | |
3612 | (with-temp-buffer | |
3613 | (call-process "df" nil t nil ".") | |
3614 | (goto-char (point-min)) | |
3615 | (forward-line 1) | |
3616 | (skip-chars-forward "^ \t") | |
3617 | (forward-word 3) | |
3618 | (let ((end (point))) | |
3619 | (forward-word -1) | |
3620 | (setq available (buffer-substring (point) end)))) | |
3621 | (insert " available " available)))))))))) | |
34342a07 | 3622 | |
88902b35 | 3623 | (defvar kill-emacs-query-functions nil |
65d5c6de | 3624 | "Functions to call with no arguments to query about killing Emacs. |
78c793d1 RS |
3625 | If any of these functions returns nil, killing Emacs is cancelled. |
3626 | `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions, | |
3627 | but `kill-emacs', the low level primitive, does not. | |
3628 | See also `kill-emacs-hook'.") | |
88902b35 | 3629 | |
b4da00e9 RM |
3630 | (defun save-buffers-kill-emacs (&optional arg) |
3631 | "Offer to save each buffer, then kill this Emacs process. | |
3632 | With prefix arg, silently save all file-visiting buffers, then kill." | |
3633 | (interactive "P") | |
3634 | (save-some-buffers arg t) | |
3635 | (and (or (not (memq t (mapcar (function | |
3636 | (lambda (buf) (and (buffer-file-name buf) | |
3637 | (buffer-modified-p buf)))) | |
3638 | (buffer-list)))) | |
3639 | (yes-or-no-p "Modified buffers exist; exit anyway? ")) | |
3640 | (or (not (fboundp 'process-list)) | |
3641 | ;; process-list is not defined on VMS. | |
3642 | (let ((processes (process-list)) | |
3643 | active) | |
3644 | (while processes | |
528415e7 | 3645 | (and (memq (process-status (car processes)) '(run stop open)) |
b4da00e9 RM |
3646 | (let ((val (process-kill-without-query (car processes)))) |
3647 | (process-kill-without-query (car processes) val) | |
3648 | val) | |
3649 | (setq active t)) | |
3650 | (setq processes (cdr processes))) | |
3651 | (or (not active) | |
71a3bb4b | 3652 | (list-processes) |
b4da00e9 | 3653 | (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))) |
88902b35 | 3654 | ;; Query the user for other things, perhaps. |
fb15c113 | 3655 | (run-hook-with-args-until-failure 'kill-emacs-query-functions) |
b4da00e9 RM |
3656 | (kill-emacs))) |
3657 | \f | |
ffc0e1ca | 3658 | ;; We use /: as a prefix to "quote" a file name |
47afc068 RS |
3659 | ;; so that magic file name handlers will not apply to it. |
3660 | ||
3661 | (setq file-name-handler-alist | |
3662 | (cons '("\\`/:" . file-name-non-special) | |
3663 | file-name-handler-alist)) | |
3664 | ||
3665 | ;; We depend on being the last handler on the list, | |
3666 | ;; so that anything else which does need handling | |
3667 | ;; has been handled already. | |
3668 | ;; So it is safe for us to inhibit *all* magic file name handlers. | |
3669 | ||
3670 | (defun file-name-non-special (operation &rest arguments) | |
3671 | (let ((file-name-handler-alist nil) | |
5cb1f728 KH |
3672 | (default-directory |
3673 | (if (eq operation 'insert-directory) | |
3674 | (directory-file-name | |
ffc0e1ca | 3675 | (expand-file-name |
5cb1f728 KH |
3676 | (unhandled-file-name-directory default-directory))) |
3677 | default-directory)) | |
47afc068 RS |
3678 | ;; Get a list of the indices of the args which are file names. |
3679 | (file-arg-indices | |
3680 | (cdr (or (assq operation | |
3681 | ;; The first four are special because they | |
3682 | ;; return a file name. We want to include the /: | |
3683 | ;; in the return value. | |
3684 | ;; So just avoid stripping it in the first place. | |
3685 | '((expand-file-name . nil) | |
18b9dced RS |
3686 | ;; `identity' means just return the first arg |
3687 | ;; as stripped of its quoting. | |
3688 | (substitute-in-file-name . identity) | |
47afc068 RS |
3689 | (file-name-directory . nil) |
3690 | (file-name-as-directory . nil) | |
3691 | (directory-file-name . nil) | |
feaec97d RS |
3692 | (file-name-completion 0 1) |
3693 | (file-name-all-completions 0 1) | |
47afc068 RS |
3694 | (rename-file 0 1) |
3695 | (copy-file 0 1) | |
3696 | (make-symbolic-link 0 1) | |
3697 | (add-name-to-file 0 1))) | |
3698 | ;; For all other operations, treat the first argument only | |
3699 | ;; as the file name. | |
3700 | '(nil 0)))) | |
3701 | ;; Copy ARGUMENTS so we can replace elements in it. | |
3702 | (arguments (copy-sequence arguments))) | |
3703 | ;; Strip off the /: from the file names that have this handler. | |
3704 | (save-match-data | |
18b9dced | 3705 | (while (consp file-arg-indices) |
fe4d9852 KH |
3706 | (let ((pair (nthcdr (car file-arg-indices) arguments))) |
3707 | (and (car pair) | |
3708 | (string-match "\\`/:" (car pair)) | |
3709 | (setcar pair | |
3710 | (if (= (length (car pair)) 2) | |
3711 | "/" | |
3712 | (substring (car pair) 2))))) | |
47afc068 | 3713 | (setq file-arg-indices (cdr file-arg-indices)))) |
18b9dced RS |
3714 | (if (eq file-arg-indices 'identity) |
3715 | (car arguments) | |
3716 | (apply operation arguments)))) | |
47afc068 | 3717 | \f |
b4da00e9 | 3718 | (define-key ctl-x-map "\C-f" 'find-file) |
b4da00e9 RM |
3719 | (define-key ctl-x-map "\C-r" 'find-file-read-only) |
3720 | (define-key ctl-x-map "\C-v" 'find-alternate-file) | |
3721 | (define-key ctl-x-map "\C-s" 'save-buffer) | |
3722 | (define-key ctl-x-map "s" 'save-some-buffers) | |
3723 | (define-key ctl-x-map "\C-w" 'write-file) | |
3724 | (define-key ctl-x-map "i" 'insert-file) | |
3725 | (define-key esc-map "~" 'not-modified) | |
3726 | (define-key ctl-x-map "\C-d" 'list-directory) | |
3727 | (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs) | |
3728 | ||
3729 | (define-key ctl-x-4-map "f" 'find-file-other-window) | |
3730 | (define-key ctl-x-4-map "r" 'find-file-read-only-other-window) | |
3731 | (define-key ctl-x-4-map "\C-f" 'find-file-other-window) | |
3732 | (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window) | |
924f0a24 | 3733 | (define-key ctl-x-4-map "\C-o" 'display-buffer) |
5bbbceb1 | 3734 | |
f98955ea JB |
3735 | (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame) |
3736 | (define-key ctl-x-5-map "f" 'find-file-other-frame) | |
3737 | (define-key ctl-x-5-map "\C-f" 'find-file-other-frame) | |
3738 | (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame) | |
c0274f38 ER |
3739 | |
3740 | ;;; files.el ends here |