Commit | Line | Data |
---|---|---|
c0274f38 ER |
1 | ;;; files.el --- file input and output commands for Emacs |
2 | ||
ab422c4d | 3 | ;; Copyright (C) 1985-1987, 1992-2013 Free Software Foundation, Inc. |
b4da00e9 | 4 | |
3a801d0c | 5 | ;; Maintainer: FSF |
bd78fa1d | 6 | ;; Package: emacs |
3a801d0c | 7 | |
b4da00e9 RM |
8 | ;; This file is part of GNU Emacs. |
9 | ||
eb3fa2cf | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
b4da00e9 | 11 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
b4da00e9 RM |
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 | |
eb3fa2cf | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
b4da00e9 | 22 | |
e41b2db1 ER |
23 | ;;; Commentary: |
24 | ||
677c1109 | 25 | ;; Defines most of Emacs's file- and directory-handling functions, |
e41b2db1 ER |
26 | ;; including basic file visiting, backup generation, link handling, |
27 | ;; ITS-id version control, load- and write-hook handling, and the like. | |
28 | ||
e5167999 ER |
29 | ;;; Code: |
30 | ||
26138670 JB |
31 | (defvar font-lock-keywords) |
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 | |
ba83982b | 43 | "Non-nil means delete auto-save file when a buffer is saved or killed. |
92631216 | 44 | |
564af258 | 45 | Note that the auto-save file will not be deleted if the buffer is killed |
92631216 | 46 | when it has unsaved changes." |
21540597 RS |
47 | :type 'boolean |
48 | :group 'auto-save) | |
49 | ||
50 | (defcustom directory-abbrev-alist | |
b4da00e9 | 51 | nil |
ba83982b | 52 | "Alist of abbreviations for file directories. |
b4da00e9 RM |
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. | |
362b9d48 GM |
56 | |
57 | FROM is matched against directory names anchored at the first | |
58 | character, so it should start with a \"\\\\`\", or, if directory | |
59 | names cannot have embedded newlines, with a \"^\". | |
b4da00e9 | 60 | |
4b690a83 RS |
61 | FROM and TO should be equivalent names, which refer to the |
62 | same directory. Do not use `~' in the TO strings; | |
63 | they should be ordinary absolute directory names. | |
65151a1b | 64 | |
b4da00e9 RM |
65 | Use this feature when you have directories which you normally refer to |
66 | via absolute symbolic links. Make TO the name of the link, and FROM | |
21540597 RS |
67 | the name it is linked to." |
68 | :type '(repeat (cons :format "%v" | |
3fa0dc8f | 69 | :value ("\\`" . "") |
21540597 | 70 | (regexp :tag "From") |
3fa0dc8f | 71 | (string :tag "To"))) |
21540597 RS |
72 | :group 'abbrev |
73 | :group 'find-file) | |
b4da00e9 | 74 | |
7c2fb837 | 75 | (defcustom make-backup-files t |
ba83982b | 76 | "Non-nil means make a backup of a file the first time it is saved. |
b4da00e9 RM |
77 | This can be done by renaming the file or by copying. |
78 | ||
79 | Renaming means that Emacs renames the existing file so that it is a | |
80 | backup file, then writes the buffer into a new file. Any other names | |
81 | that the old file had will now refer to the backup file. The new file | |
82 | is owned by you and its group is defaulted. | |
83 | ||
84 | Copying means that Emacs copies the existing file into the backup | |
85 | file, then writes the buffer on top of the existing file. Any other | |
86 | names that the old file had will now refer to the new (edited) file. | |
87 | The file's owner and group are unchanged. | |
88 | ||
89 | The choice of renaming or copying is controlled by the variables | |
ffc0e1ca AS |
90 | `backup-by-copying', `backup-by-copying-when-linked', |
91 | `backup-by-copying-when-mismatch' and | |
92 | `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'." | |
21540597 RS |
93 | :type 'boolean |
94 | :group 'backup) | |
b4da00e9 RM |
95 | |
96 | ;; Do this so that local variables based on the file name | |
97 | ;; are not overridden by the major mode. | |
98 | (defvar backup-inhibited nil | |
f862241d RS |
99 | "Non-nil means don't make a backup, regardless of the other parameters. |
100 | This variable is intended for use by making it local to a buffer. | |
101 | But it is local only if you make it local.") | |
b4da00e9 RM |
102 | (put 'backup-inhibited 'permanent-local t) |
103 | ||
21540597 | 104 | (defcustom backup-by-copying nil |
ba83982b | 105 | "Non-nil means always use copying to create backup files. |
21540597 | 106 | See documentation of variable `make-backup-files'." |
094eabe4 JB |
107 | :type 'boolean |
108 | :group 'backup) | |
b4da00e9 | 109 | |
21540597 | 110 | (defcustom backup-by-copying-when-linked nil |
ba83982b | 111 | "Non-nil means use copying to create backups for files with multiple names. |
b4da00e9 | 112 | This causes the alternate names to refer to the latest version as edited. |
21540597 | 113 | This variable is relevant only if `backup-by-copying' is nil." |
094eabe4 JB |
114 | :type 'boolean |
115 | :group 'backup) | |
b4da00e9 | 116 | |
e274eb13 | 117 | (defcustom backup-by-copying-when-mismatch t |
ba83982b | 118 | "Non-nil means create backups by copying if this preserves owner or group. |
b4da00e9 RM |
119 | Renaming may still be used (subject to control of other variables) |
120 | when it would not result in changing the owner or group of the file; | |
121 | that is, for files which are owned by you and whose group matches | |
122 | the default for a new file created there by you. | |
21540597 | 123 | This variable is relevant only if `backup-by-copying' is nil." |
e274eb13 | 124 | :version "24.1" |
21540597 RS |
125 | :type 'boolean |
126 | :group 'backup) | |
6ce78fdc | 127 | (put 'backup-by-copying-when-mismatch 'permanent-local t) |
b4da00e9 | 128 | |
ffc0e1ca | 129 | (defcustom backup-by-copying-when-privileged-mismatch 200 |
ba83982b | 130 | "Non-nil means create backups by copying to preserve a privileged owner. |
ffc0e1ca AS |
131 | Renaming may still be used (subject to control of other variables) |
132 | when it would not result in changing the owner of the file or if the owner | |
133 | has a user id greater than the value of this variable. This is useful | |
134 | when low-numbered uid's are used for special system users (such as root) | |
135 | that must maintain ownership of certain files. | |
136 | This variable is relevant only if `backup-by-copying' and | |
137 | `backup-by-copying-when-mismatch' are nil." | |
138 | :type '(choice (const nil) integer) | |
139 | :group 'backup) | |
140 | ||
ffc0e1ca | 141 | (defvar backup-enable-predicate 'normal-backup-enable-predicate |
b4da00e9 | 142 | "Predicate that looks at a file name and decides whether to make backups. |
37193ee6 | 143 | Called with an absolute file name as argument, it returns t to enable backup.") |
b4da00e9 | 144 | |
21540597 | 145 | (defcustom buffer-offer-save nil |
ba83982b | 146 | "Non-nil in a buffer means always offer to save buffer on exit. |
ffc0e1ca | 147 | Do so even if the buffer is not visiting a file. |
21540597 RS |
148 | Automatically local in all buffers." |
149 | :type 'boolean | |
150 | :group 'backup) | |
b4da00e9 | 151 | (make-variable-buffer-local 'buffer-offer-save) |
3ee3a1b5 | 152 | (put 'buffer-offer-save 'permanent-local t) |
b4da00e9 | 153 | |
21540597 | 154 | (defcustom find-file-existing-other-name t |
ba83982b | 155 | "Non-nil means find a file under alternative names, in existing buffers. |
f3e23606 | 156 | This means if any existing buffer is visiting the file you want |
21540597 RS |
157 | under another name, you get the existing buffer instead of a new buffer." |
158 | :type 'boolean | |
159 | :group 'find-file) | |
f3e23606 | 160 | |
21540597 | 161 | (defcustom find-file-visit-truename nil |
09949b83 | 162 | "Non-nil means visit a file under its truename. |
f3e23606 | 163 | The truename of a file is found by chasing all links |
21540597 RS |
164 | both at the file level and at the levels of the containing directories." |
165 | :type 'boolean | |
166 | :group 'find-file) | |
290c2be5 | 167 | (put 'find-file-visit-truename 'safe-local-variable 'booleanp) |
f3e23606 | 168 | |
26b9ecbc | 169 | (defcustom revert-without-query nil |
ba83982b | 170 | "Specify which files should be reverted without query. |
ebeb898f RS |
171 | The value is a list of regular expressions. |
172 | If the file name matches one of these regular expressions, | |
db8c4866 | 173 | then `revert-buffer' reverts the file without querying |
21540597 | 174 | if the file has changed on disk and you have not edited the buffer." |
a0d809f2 | 175 | :type '(repeat regexp) |
21540597 | 176 | :group 'find-file) |
ebeb898f | 177 | |
f3e23606 RS |
178 | (defvar buffer-file-number nil |
179 | "The device number and file number of the file visited in the current buffer. | |
180 | The value is a list of the form (FILENUM DEVNUM). | |
181 | This pair of numbers uniquely identifies the file. | |
182 | If the buffer is visiting a new file, the value is nil.") | |
183 | (make-variable-buffer-local 'buffer-file-number) | |
184 | (put 'buffer-file-number 'permanent-local t) | |
185 | ||
de88363f | 186 | (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt))) |
26b9ecbc | 187 | "Non-nil means that `buffer-file-number' uniquely identifies files.") |
de88363f | 188 | |
e554eeb7 RS |
189 | (defvar buffer-file-read-only nil |
190 | "Non-nil if visited file was read-only when visited.") | |
191 | (make-variable-buffer-local 'buffer-file-read-only) | |
192 | ||
388d6ab5 | 193 | (defcustom small-temporary-file-directory |
eb61b61b RS |
194 | (if (eq system-type 'ms-dos) (getenv "TMPDIR")) |
195 | "The directory for writing small temporary files. | |
196 | If non-nil, this directory is used instead of `temporary-file-directory' | |
197 | by programs that create small temporary files. This is for systems that | |
388d6ab5 RS |
198 | have fast storage with limited space, such as a RAM disk." |
199 | :group 'files | |
adba8116 | 200 | :initialize 'custom-initialize-delay |
bab6eadb | 201 | :type '(choice (const nil) directory)) |
eb61b61b RS |
202 | |
203 | ;; The system null device. (Should reference NULL_DEVICE from C.) | |
a7610c52 | 204 | (defvar null-device (purecopy "/dev/null") "The system null device.") |
eb61b61b | 205 | |
73e6adaa DN |
206 | (declare-function msdos-long-file-names "msdos.c") |
207 | (declare-function w32-long-file-name "w32proc.c") | |
e8ffb999 DN |
208 | (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep)) |
209 | (declare-function dired-unmark "dired" (arg)) | |
210 | (declare-function dired-do-flagged-delete "dired" (&optional nomessage)) | |
211 | (declare-function dos-8+3-filename "dos-fns" (filename)) | |
7533b418 | 212 | (declare-function dosified-file-name "dos-fns" (file-name)) |
e8ffb999 | 213 | |
30966847 EZ |
214 | (defvar file-name-invalid-regexp |
215 | (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names))) | |
a7610c52 | 216 | (purecopy |
9959c16e | 217 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
30966847 | 218 | "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters |
12f68d3f | 219 | "[\000-\037]\\|" ; control characters |
30966847 | 220 | "\\(/\\.\\.?[^/]\\)\\|" ; leading dots |
a7610c52 | 221 | "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot |
c60ee5e7 | 222 | ((memq system-type '(ms-dos windows-nt cygwin)) |
a7610c52 | 223 | (purecopy |
9959c16e | 224 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
a7610c52 DN |
225 | "[|<>\"?*\000-\037]"))) ; invalid characters |
226 | (t (purecopy "[\000]"))) | |
30966847 EZ |
227 | "Regexp recognizing file names which aren't allowed by the filesystem.") |
228 | ||
21540597 | 229 | (defcustom file-precious-flag nil |
ba83982b | 230 | "Non-nil means protect against I/O errors while saving files. |
560f4415 | 231 | Some modes set this non-nil in particular buffers. |
4b7271c1 KH |
232 | |
233 | This feature works by writing the new contents into a temporary file | |
234 | and then renaming the temporary file to replace the original. | |
235 | In this way, any I/O error in writing leaves the original untouched, | |
236 | and there is never any instant where the file is nonexistent. | |
237 | ||
238 | Note that this feature forces backups to be made by copying. | |
560f4415 | 239 | Yet, at the same time, saving a precious file |
dab71b2c KF |
240 | breaks any hard links between it and other files. |
241 | ||
242 | This feature is advisory: for example, if the directory in which the | |
622bdb51 | 243 | file is being saved is not writable, Emacs may ignore a non-nil value |
1d367309 KF |
244 | of `file-precious-flag' and write directly into the file. |
245 | ||
246 | See also: `break-hardlink-on-save'." | |
21540597 RS |
247 | :type 'boolean |
248 | :group 'backup) | |
b4da00e9 | 249 | |
1d367309 KF |
250 | (defcustom break-hardlink-on-save nil |
251 | "Non-nil means when saving a file that exists under several names | |
76e7a7f0 | 252 | \(i.e., has multiple hardlinks), break the hardlink associated with |
1d367309 KF |
253 | `buffer-file-name' and write to a new file, so that the other |
254 | instances of the file are not affected by the save. | |
255 | ||
256 | If `buffer-file-name' refers to a symlink, do not break the symlink. | |
257 | ||
258 | Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory. | |
259 | For example, if the directory in which a file is being saved is not | |
622bdb51 | 260 | itself writable, then error instead of saving in some |
1d367309 KF |
261 | hardlink-nonbreaking way. |
262 | ||
263 | See also `backup-by-copying' and `backup-by-copying-when-linked'." | |
264 | :type 'boolean | |
76e7a7f0 JB |
265 | :group 'files |
266 | :version "23.1") | |
1d367309 | 267 | |
21540597 | 268 | (defcustom version-control nil |
ba83982b | 269 | "Control use of version numbers for backup files. |
93e7eeb4 JB |
270 | When t, make numeric backup versions unconditionally. |
271 | When nil, make them for files that have some already. | |
272 | The value `never' means do not make them." | |
e48807d1 AS |
273 | :type '(choice (const :tag "Never" never) |
274 | (const :tag "If existing" nil) | |
275 | (other :tag "Always" t)) | |
21540597 RS |
276 | :group 'backup |
277 | :group 'vc) | |
e48335de | 278 | (put 'version-control 'safe-local-variable |
4f91a816 | 279 | (lambda (x) (or (booleanp x) (equal x 'never)))) |
21540597 RS |
280 | |
281 | (defcustom dired-kept-versions 2 | |
ba83982b | 282 | "When cleaning directory, number of versions to keep." |
21540597 RS |
283 | :type 'integer |
284 | :group 'backup | |
285 | :group 'dired) | |
286 | ||
287 | (defcustom delete-old-versions nil | |
ba83982b | 288 | "If t, delete excess backup versions silently. |
21540597 RS |
289 | If nil, ask confirmation. Any other value prevents any trimming." |
290 | :type '(choice (const :tag "Delete" t) | |
291 | (const :tag "Ask" nil) | |
e48807d1 | 292 | (other :tag "Leave" other)) |
21540597 RS |
293 | :group 'backup) |
294 | ||
295 | (defcustom kept-old-versions 2 | |
ba83982b | 296 | "Number of oldest versions to keep when a new numbered backup is made." |
21540597 RS |
297 | :type 'integer |
298 | :group 'backup) | |
631c8020 | 299 | (put 'kept-old-versions 'safe-local-variable 'integerp) |
21540597 RS |
300 | |
301 | (defcustom kept-new-versions 2 | |
ba83982b | 302 | "Number of newest versions to keep when a new numbered backup is made. |
21540597 RS |
303 | Includes the new backup. Must be > 0" |
304 | :type 'integer | |
305 | :group 'backup) | |
631c8020 | 306 | (put 'kept-new-versions 'safe-local-variable 'integerp) |
b4da00e9 | 307 | |
21540597 | 308 | (defcustom require-final-newline nil |
ba83982b | 309 | "Whether to add a newline automatically at the end of the file. |
f4206092 RS |
310 | |
311 | A value of t means do this only when the file is about to be saved. | |
312 | A value of `visit' means do this right after the file is visited. | |
313 | A value of `visit-save' means do it at both of those times. | |
314 | Any other non-nil value means ask user whether to add a newline, when saving. | |
756c496f | 315 | A value of nil means don't add newlines. |
f4206092 RS |
316 | |
317 | Certain major modes set this locally to the value obtained | |
318 | from `mode-require-final-newline'." | |
319 | :type '(choice (const :tag "When visiting" visit) | |
320 | (const :tag "When saving" t) | |
321 | (const :tag "When visiting or saving" visit-save) | |
93d1963d | 322 | (const :tag "Don't add newlines" nil) |
0776da52 | 323 | (other :tag "Ask each time" ask)) |
21540597 | 324 | :group 'editing-basics) |
b4da00e9 | 325 | |
f4206092 | 326 | (defcustom mode-require-final-newline t |
ba83982b | 327 | "Whether to add a newline at end of file, in certain major modes. |
f4206092 | 328 | Those modes set `require-final-newline' to this value when you enable them. |
0776da52 | 329 | They do so because they are often used for files that are supposed |
f4206092 RS |
330 | to end in newlines, and the question is how to arrange that. |
331 | ||
332 | A value of t means do this only when the file is about to be saved. | |
333 | A value of `visit' means do this right after the file is visited. | |
334 | A value of `visit-save' means do it at both of those times. | |
5e9961be | 335 | Any other non-nil value means ask user whether to add a newline, when saving. |
5e9961be | 336 | |
756c496f JB |
337 | A value of nil means do not add newlines. That is a risky choice in this |
338 | variable since this value is used for modes for files that ought to have | |
339 | final newlines. So if you set this to nil, you must explicitly check and | |
340 | add a final newline, whenever you save a file that really needs one." | |
f4206092 RS |
341 | :type '(choice (const :tag "When visiting" visit) |
342 | (const :tag "When saving" t) | |
343 | (const :tag "When visiting or saving" visit-save) | |
93d1963d RS |
344 | (const :tag "Don't add newlines" nil) |
345 | (other :tag "Ask each time" ask)) | |
f4206092 | 346 | :group 'editing-basics |
bf247b6e | 347 | :version "22.1") |
f4206092 | 348 | |
21540597 | 349 | (defcustom auto-save-default t |
ba83982b | 350 | "Non-nil says by default do auto-saving of every file-visiting buffer." |
21540597 RS |
351 | :type 'boolean |
352 | :group 'auto-save) | |
b4da00e9 | 353 | |
ffc0e1ca | 354 | (defcustom auto-save-file-name-transforms |
b1e5937c | 355 | `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'" |
747981b0 EZ |
356 | ;; Don't put "\\2" inside expand-file-name, since it will be |
357 | ;; transformed to "/2" on DOS/Windows. | |
a0b60c33 | 358 | ,(concat temporary-file-directory "\\2") t)) |
ba83982b | 359 | "Transforms to apply to buffer file name before making auto-save file name. |
a0b60c33 | 360 | Each transform is a list (REGEXP REPLACEMENT UNIQUIFY): |
ffc0e1ca AS |
361 | REGEXP is a regular expression to match against the file name. |
362 | If it matches, `replace-match' is used to replace the | |
363 | matching part with REPLACEMENT. | |
a0b60c33 | 364 | If the optional element UNIQUIFY is non-nil, the auto-save file name is |
36236b72 | 365 | constructed by taking the directory part of the replaced file-name, |
a0b60c33 GM |
366 | concatenated with the buffer file name with all directory separators |
367 | changed to `!' to prevent clashes. This will not work | |
368 | correctly if your filesystem truncates the resulting name. | |
369 | ||
ffc0e1ca AS |
370 | All the transforms in the list are tried, in the order they are listed. |
371 | When one transform applies, its result is final; | |
372 | no further transforms are tried. | |
373 | ||
a2899d6c KG |
374 | The default value is set up to put the auto-save file into the |
375 | temporary directory (see the variable `temporary-file-directory') for | |
a0b60c33 GM |
376 | editing a remote file. |
377 | ||
378 | On MS-DOS filesystems without long names this variable is always | |
379 | ignored." | |
ffc0e1ca | 380 | :group 'auto-save |
a0b60c33 GM |
381 | :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement") |
382 | (boolean :tag "Uniquify"))) | |
adba8116 | 383 | :initialize 'custom-initialize-delay |
ffc0e1ca AS |
384 | :version "21.1") |
385 | ||
88b36776 | 386 | (defcustom save-abbrevs t |
ba83982b | 387 | "Non-nil means save word abbrevs too when files are saved. |
02c6a1cc EZ |
388 | If `silently', don't ask the user before saving." |
389 | :type '(choice (const t) (const nil) (const silently)) | |
21540597 | 390 | :group 'abbrev) |
b4da00e9 | 391 | |
21540597 | 392 | (defcustom find-file-run-dired t |
ba83982b | 393 | "Non-nil means allow `find-file' to visit directories. |
ffc0e1ca | 394 | To visit the directory, `find-file' runs `find-directory-functions'." |
21540597 RS |
395 | :type 'boolean |
396 | :group 'find-file) | |
b4da00e9 | 397 | |
ffc0e1ca | 398 | (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect) |
ba83982b | 399 | "List of functions to try in sequence to visit a directory. |
ffc0e1ca AS |
400 | Each function is called with the directory name as the sole argument |
401 | and should return either a buffer or nil." | |
402 | :type '(hook :options (cvs-dired-noselect dired-noselect)) | |
403 | :group 'find-file) | |
404 | ||
7d371eac JL |
405 | ;; FIXME: also add a hook for `(thing-at-point 'filename)' |
406 | (defcustom file-name-at-point-functions '(ffap-guess-file-name-at-point) | |
407 | "List of functions to try in sequence to get a file name at point. | |
408 | Each function should return either nil or a file name found at the | |
409 | location of point in the current buffer." | |
410 | :type '(hook :options (ffap-guess-file-name-at-point)) | |
411 | :group 'find-file) | |
412 | ||
92966e6f RS |
413 | ;;;It is not useful to make this a local variable. |
414 | ;;;(put 'find-file-not-found-hooks 'permanent-local t) | |
e5bd0a28 SM |
415 | (define-obsolete-variable-alias 'find-file-not-found-hooks |
416 | 'find-file-not-found-functions "22.1") | |
0370fe77 | 417 | (defvar find-file-not-found-functions nil |
b4da00e9 RM |
418 | "List of functions to be called for `find-file' on nonexistent file. |
419 | These functions are called as soon as the error is detected. | |
ffc0e1ca | 420 | Variable `buffer-file-name' is already set up. |
b4da00e9 RM |
421 | The functions are called in the order given until one of them returns non-nil.") |
422 | ||
92966e6f RS |
423 | ;;;It is not useful to make this a local variable. |
424 | ;;;(put 'find-file-hooks 'permanent-local t) | |
cd6ef82d | 425 | (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1") |
564af258 | 426 | (defcustom find-file-hook nil |
b4da00e9 RM |
427 | "List of functions to be called after a buffer is loaded from a file. |
428 | The buffer's local variables (if any) will have been processed before the | |
564af258 DL |
429 | functions are called." |
430 | :group 'find-file | |
431 | :type 'hook | |
432 | :options '(auto-insert) | |
bf247b6e | 433 | :version "22.1") |
b4da00e9 | 434 | |
e5bd0a28 | 435 | (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1") |
0370fe77 | 436 | (defvar write-file-functions nil |
b4da00e9 RM |
437 | "List of functions to be called before writing out a buffer to a file. |
438 | If one of them returns non-nil, the file is considered already written | |
8c0e7b73 JB |
439 | and the rest are not called. |
440 | These hooks are considered to pertain to the visited file. | |
0370fe77 SM |
441 | So any buffer-local binding of this variable is discarded if you change |
442 | the visited file name with \\[set-visited-file-name], but not when you | |
443 | change the major mode. | |
444 | ||
0eb0202f LT |
445 | This hook is not run if any of the functions in |
446 | `write-contents-functions' returns non-nil. Both hooks pertain | |
447 | to how to save a buffer to file, for instance, choosing a suitable | |
448 | coding system and setting mode bits. (See Info | |
449 | node `(elisp)Saving Buffers'.) To perform various checks or | |
26b9ecbc | 450 | updates before the buffer is saved, use `before-save-hook'.") |
0370fe77 | 451 | (put 'write-file-functions 'permanent-local t) |
0370fe77 SM |
452 | |
453 | (defvar local-write-file-hooks nil) | |
b19f1da4 BF |
454 | (make-variable-buffer-local 'local-write-file-hooks) |
455 | (put 'local-write-file-hooks 'permanent-local t) | |
bf247b6e | 456 | (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1") |
8c0e7b73 | 457 | |
e5bd0a28 SM |
458 | (define-obsolete-variable-alias 'write-contents-hooks |
459 | 'write-contents-functions "22.1") | |
0370fe77 | 460 | (defvar write-contents-functions nil |
8c0e7b73 JB |
461 | "List of functions to be called before writing out a buffer to a file. |
462 | If one of them returns non-nil, the file is considered already written | |
7dd11b37 LH |
463 | and the rest are not called and neither are the functions in |
464 | `write-file-functions'. | |
f82966e4 KH |
465 | |
466 | This variable is meant to be used for hooks that pertain to the | |
467 | buffer's contents, not to the particular visited file; thus, | |
468 | `set-visited-file-name' does not clear this variable; but changing the | |
693f800d RS |
469 | major mode does clear it. |
470 | ||
0eb0202f LT |
471 | For hooks that _do_ pertain to the particular visited file, use |
472 | `write-file-functions'. Both this variable and | |
473 | `write-file-functions' relate to how a buffer is saved to file. | |
474 | To perform various checks or updates before the buffer is saved, | |
475 | use `before-save-hook'.") | |
0370fe77 | 476 | (make-variable-buffer-local 'write-contents-functions) |
b4da00e9 | 477 | |
21540597 | 478 | (defcustom enable-local-variables t |
ba83982b | 479 | "Control use of local variables in files you visit. |
d355b270 | 480 | The value can be t, nil, :safe, :all, or something else. |
5a6c1d87 CY |
481 | |
482 | A value of t means file local variables specifications are obeyed | |
a251756e RS |
483 | if all the specified variable values are safe; if any values are |
484 | not safe, Emacs queries you, once, whether to set them all. | |
a5ce12c3 RS |
485 | \(When you say yes to certain values, they are remembered as safe.) |
486 | ||
487 | :safe means set the safe variables, and ignore the rest. | |
e58cec15 RS |
488 | :all means set all variables, whether safe or not. |
489 | (Don't set it permanently to :all.) | |
756c496f | 490 | A value of nil means always ignore the file local variables. |
a251756e | 491 | |
a251756e | 492 | Any other value means always query you once whether to set them all. |
a5ce12c3 RS |
493 | \(When you say yes to certain values, they are remembered as safe, but |
494 | this has no effect when `enable-local-variables' is \"something else\".) | |
5a6c1d87 | 495 | |
aa5fcebf KH |
496 | This variable also controls use of major modes specified in |
497 | a -*- line. | |
b4da00e9 | 498 | |
aa5fcebf KH |
499 | The command \\[normal-mode], when used interactively, |
500 | always obeys file local variable specifications and the -*- line, | |
501 | and ignores this variable." | |
3029e594 | 502 | :risky t |
e58cec15 | 503 | :type '(choice (const :tag "Query Unsafe" t) |
a5ce12c3 | 504 | (const :tag "Safe Only" :safe) |
e58cec15 | 505 | (const :tag "Do all" :all) |
21540597 | 506 | (const :tag "Ignore" nil) |
e48807d1 | 507 | (other :tag "Query" other)) |
21540597 | 508 | :group 'find-file) |
b4da00e9 | 509 | |
97a1cd9d GM |
510 | (defvar enable-dir-local-variables t |
511 | "Non-nil means enable use of directory-local variables. | |
512 | Some modes may wish to set this to nil to prevent directory-local | |
513 | settings being applied, but still respect file-local ones.") | |
514 | ||
7b447e9b GM |
515 | ;; This is an odd variable IMO. |
516 | ;; You might wonder why it is needed, when we could just do: | |
517 | ;; (set (make-local-variable 'enable-local-variables) nil) | |
518 | ;; These two are not precisely the same. | |
519 | ;; Setting this variable does not cause -*- mode settings to be | |
520 | ;; ignored, whereas setting enable-local-variables does. | |
521 | ;; Only three places in Emacs use this variable: tar and arc modes, | |
522 | ;; and rmail. The first two don't need it. They already use | |
523 | ;; inhibit-local-variables-regexps, which is probably enough, and | |
524 | ;; could also just set enable-local-variables locally to nil. | |
525 | ;; Them setting it has the side-effect that dir-locals cannot apply to | |
526 | ;; eg tar files (?). FIXME Is this appropriate? | |
527 | ;; AFAICS, rmail is the only thing that needs this, and the only | |
528 | ;; reason it uses it is for BABYL files (which are obsolete). | |
529 | ;; These contain "-*- rmail -*-" in the first line, which rmail wants | |
530 | ;; to respect, so that find-file on a BABYL file will switch to | |
531 | ;; rmail-mode automatically (this is nice, but hardly essential, | |
532 | ;; since most people are used to explicitly running a command to | |
533 | ;; access their mail; M-x gnus etc). Rmail files may happen to | |
534 | ;; contain Local Variables sections in messages, which Rmail wants to | |
535 | ;; ignore. So AFAICS the only reason this variable exists is for a | |
536 | ;; minor convenience feature for handling of an obsolete Rmail file format. | |
da09b92b RS |
537 | (defvar local-enable-local-variables t |
538 | "Like `enable-local-variables' but meant for buffer-local bindings. | |
aa5fcebf | 539 | The meaningful values are nil and non-nil. The default is non-nil. |
da09b92b | 540 | If a major mode sets this to nil, buffer-locally, then any local |
7b447e9b | 541 | variables list in a file visited in that mode will be ignored. |
aa5fcebf | 542 | |
7b447e9b GM |
543 | This variable does not affect the use of major modes specified |
544 | in a -*- line.") | |
da09b92b | 545 | |
21540597 | 546 | (defcustom enable-local-eval 'maybe |
e442c62b | 547 | "Control processing of the \"variable\" `eval' in a file's local variables. |
d207b766 | 548 | The value can be t, nil or something else. |
8fc29035 | 549 | A value of t means obey `eval' variables. |
756c496f | 550 | A value of nil means ignore them; anything else means query." |
3029e594 | 551 | :risky t |
21540597 RS |
552 | :type '(choice (const :tag "Obey" t) |
553 | (const :tag "Ignore" nil) | |
e48807d1 | 554 | (other :tag "Query" other)) |
21540597 | 555 | :group 'find-file) |
b4da00e9 RM |
556 | |
557 | ;; Avoid losing in versions where CLASH_DETECTION is disabled. | |
558 | (or (fboundp 'lock-buffer) | |
231c4e10 | 559 | (defalias 'lock-buffer 'ignore)) |
b4da00e9 | 560 | (or (fboundp 'unlock-buffer) |
231c4e10 | 561 | (defalias 'unlock-buffer 'ignore)) |
a7305f6e RS |
562 | (or (fboundp 'file-locked-p) |
563 | (defalias 'file-locked-p 'ignore)) | |
93fe0a35 | 564 | |
cb211eb2 | 565 | (defcustom view-read-only nil |
ba83982b | 566 | "Non-nil means buffers visiting files read-only do so in view mode. |
4c91443d RS |
567 | In fact, this means that all read-only buffers normally have |
568 | View mode enabled, including buffers that are read-only because | |
569 | you visit a file you cannot alter, and buffers you make read-only | |
570 | using \\[toggle-read-only]." | |
cb211eb2 SM |
571 | :type 'boolean |
572 | :group 'view) | |
2a9fe1e2 | 573 | |
5c471b12 | 574 | (defvar file-name-history nil |
426aa4f0 EZ |
575 | "History list of file names entered in the minibuffer. |
576 | ||
577 | Maximum length of the history list is determined by the value | |
578 | of `history-length', which see.") | |
5c471b12 | 579 | \f |
1aa8fe46 | 580 | (put 'ange-ftp-completion-hook-function 'safe-magic t) |
93fe0a35 | 581 | (defun ange-ftp-completion-hook-function (op &rest args) |
ffc0e1ca AS |
582 | "Provides support for ange-ftp host name completion. |
583 | Runs the usual ange-ftp hook, but only for completion operations." | |
584 | ;; Having this here avoids the need to load ange-ftp when it's not | |
585 | ;; really in use. | |
93fe0a35 RS |
586 | (if (memq op '(file-name-completion file-name-all-completions)) |
587 | (apply 'ange-ftp-hook-function op args) | |
57e81f57 RS |
588 | (let ((inhibit-file-name-handlers |
589 | (cons 'ange-ftp-completion-hook-function | |
590 | (and (eq inhibit-file-name-operation op) | |
591 | inhibit-file-name-handlers))) | |
592 | (inhibit-file-name-operation op)) | |
93fe0a35 | 593 | (apply op args)))) |
567c1ca9 | 594 | |
98d8b17e EZ |
595 | (declare-function dos-convert-standard-filename "dos-fns.el" (filename)) |
596 | (declare-function w32-convert-standard-filename "w32-fns.el" (filename)) | |
597 | ||
567c1ca9 | 598 | (defun convert-standard-filename (filename) |
a576d8e2 | 599 | "Convert a standard file's name to something suitable for the OS. |
915b0bf0 JB |
600 | This means to guarantee valid names and perhaps to canonicalize |
601 | certain patterns. | |
602 | ||
f2430a0d SM |
603 | FILENAME should be an absolute file name since the conversion rules |
604 | sometimes vary depending on the position in the file name. E.g. c:/foo | |
605 | is a valid DOS file name, but c:/bar/c:/foo is not. | |
606 | ||
915b0bf0 JB |
607 | This function's standard definition is trivial; it just returns |
608 | the argument. However, on Windows and DOS, replace invalid | |
18b28ef1 EZ |
609 | characters. On DOS, make sure to obey the 8.3 limitations. |
610 | In the native Windows build, turn Cygwin names into native names, | |
611 | and also turn slashes into backslashes if the shell requires it (see | |
a576d8e2 LT |
612 | `w32-shell-dos-semantics'). |
613 | ||
614 | See Info node `(elisp)Standard File Names' for more details." | |
98d8b17e EZ |
615 | (cond |
616 | ((eq system-type 'cygwin) | |
617 | (let ((name (copy-sequence filename)) | |
618 | (start 0)) | |
619 | ;; Replace invalid filename characters with ! | |
620 | (while (string-match "[?*:<>|\"\000-\037]" name start) | |
621 | (aset name (match-beginning 0) ?!) | |
622 | (setq start (match-end 0))) | |
623 | name)) | |
624 | ((eq system-type 'windows-nt) | |
625 | (w32-convert-standard-filename filename)) | |
626 | ((eq system-type 'ms-dos) | |
627 | (dos-convert-standard-filename filename)) | |
628 | (t filename))) | |
5d4d17b8 KS |
629 | |
630 | (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial) | |
631 | "Read directory name, prompting with PROMPT and completing in directory DIR. | |
632 | Value is not expanded---you must call `expand-file-name' yourself. | |
25802eac LT |
633 | Default name to DEFAULT-DIRNAME if user exits with the same |
634 | non-empty string that was inserted by this function. | |
44dce0fb RS |
635 | (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used, |
636 | or just DIR if INITIAL is nil.) | |
25802eac LT |
637 | If the user exits with an empty minibuffer, this function returns |
638 | an empty string. (This can only happen if the user erased the | |
639 | pre-inserted contents or if `insert-default-directory' is nil.) | |
5d4d17b8 KS |
640 | Fourth arg MUSTMATCH non-nil means require existing directory's name. |
641 | Non-nil and non-t means also require confirmation after completion. | |
642 | Fifth arg INITIAL specifies text to start with. | |
25802eac LT |
643 | DIR should be an absolute directory name. It defaults to |
644 | the value of `default-directory'." | |
5d4d17b8 KS |
645 | (unless dir |
646 | (setq dir default-directory)) | |
54005870 | 647 | (read-file-name prompt dir (or default-dirname |
44dce0fb RS |
648 | (if initial (expand-file-name initial dir) |
649 | dir)) | |
650 | mustmatch initial | |
5d4d17b8 KS |
651 | 'file-directory-p)) |
652 | ||
b4da00e9 RM |
653 | \f |
654 | (defun pwd () | |
655 | "Show the current default directory." | |
656 | (interactive nil) | |
657 | (message "Directory %s" default-directory)) | |
658 | ||
231c4e10 ER |
659 | (defvar cd-path nil |
660 | "Value of the CDPATH environment variable, as a list. | |
9ee45b2c | 661 | Not actually set up until the first time you use it.") |
231c4e10 | 662 | |
06b60517 | 663 | (defun parse-colon-path (search-path) |
ae135939 | 664 | "Explode a search path into a list of directory names. |
1667e065 CY |
665 | Directories are separated by `path-separator' (which is colon in |
666 | GNU and Unix systems). Substitute environment variables into the | |
4cddca30 GM |
667 | resulting list of directory names. For an empty path element (i.e., |
668 | a leading or trailing separator, or two adjacent separators), return | |
669 | nil (meaning `default-directory') as the associated list element." | |
1667e065 CY |
670 | (when (stringp search-path) |
671 | (mapcar (lambda (f) | |
4cddca30 GM |
672 | (if (equal "" f) nil |
673 | (substitute-in-file-name (file-name-as-directory f)))) | |
674 | (split-string search-path path-separator)))) | |
231c4e10 ER |
675 | |
676 | (defun cd-absolute (dir) | |
30c5ce9c | 677 | "Change current directory to given absolute file name DIR." |
f4a0f59b RS |
678 | ;; Put the name into directory syntax now, |
679 | ;; because otherwise expand-file-name may give some bad results. | |
7c2fb837 | 680 | (setq dir (file-name-as-directory dir)) |
7201bfbb SM |
681 | ;; We used to additionally call abbreviate-file-name here, for an |
682 | ;; unknown reason. Problem is that most buffers are setup | |
683 | ;; without going through cd-absolute and don't call | |
684 | ;; abbreviate-file-name on their default-directory, so the few that | |
685 | ;; do end up using a superficially different directory. | |
686 | (setq dir (expand-file-name dir)) | |
b4da00e9 | 687 | (if (not (file-directory-p dir)) |
83c6f446 RS |
688 | (if (file-exists-p dir) |
689 | (error "%s is not a directory" dir) | |
31c691c1 | 690 | (error "%s: no such directory" dir)) |
cfef87ad TTN |
691 | (unless (file-executable-p dir) |
692 | (error "Cannot cd to %s: Permission denied" dir)) | |
693 | (setq default-directory dir) | |
11ee8d90 | 694 | (setq list-buffers-directory dir))) |
b4da00e9 | 695 | |
231c4e10 ER |
696 | (defun cd (dir) |
697 | "Make DIR become the current buffer's default directory. | |
ae135939 JB |
698 | If your environment includes a `CDPATH' variable, try each one of |
699 | that list of directories (separated by occurrences of | |
c5994cfa JB |
700 | `path-separator') when resolving a relative directory name. |
701 | The path separator is colon in GNU and GNU-like systems." | |
dac4ea74 | 702 | (interactive |
aa56f361 SM |
703 | (list |
704 | ;; FIXME: There's a subtle bug in the completion below. Seems linked | |
705 | ;; to a fundamental difficulty of implementing `predicate' correctly. | |
706 | ;; The manifestation is that TAB may list non-directories in the case where | |
707 | ;; those files also correspond to valid directories (if your cd-path is (A/ | |
708 | ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/' | |
709 | ;; will be listed as valid completions). | |
710 | ;; This is because `a' (listed because of A/a) is indeed a valid choice | |
711 | ;; (which will lead to the use of B/a). | |
712 | (minibuffer-with-setup-hook | |
713 | (lambda () | |
714 | (setq minibuffer-completion-table | |
715 | (apply-partially #'locate-file-completion-table | |
716 | cd-path nil)) | |
717 | (setq minibuffer-completion-predicate | |
718 | (lambda (dir) | |
719 | (locate-file dir cd-path nil | |
720 | (lambda (f) (and (file-directory-p f) 'dir-ok)))))) | |
721 | (unless cd-path | |
722 | (setq cd-path (or (parse-colon-path (getenv "CDPATH")) | |
723 | (list "./")))) | |
724 | (read-directory-name "Change default directory: " | |
725 | default-directory default-directory | |
726 | t)))) | |
727 | (unless cd-path | |
728 | (setq cd-path (or (parse-colon-path (getenv "CDPATH")) | |
729 | (list "./")))) | |
730 | (cd-absolute | |
731 | (or (locate-file dir cd-path nil | |
732 | (lambda (f) (and (file-directory-p f) 'dir-ok))) | |
733 | (error "No such directory found via CDPATH environment variable")))) | |
231c4e10 | 734 | |
b4da00e9 RM |
735 | (defun load-file (file) |
736 | "Load the Lisp file named FILE." | |
58195faa DL |
737 | ;; This is a case where .elc makes a lot of sense. |
738 | (interactive (list (let ((completion-ignored-extensions | |
9ab80679 | 739 | (remove ".elc" completion-ignored-extensions))) |
ac5392dc | 740 | (read-file-name "Load file: " nil nil 'lambda)))) |
58195faa | 741 | (load (expand-file-name file) nil nil t)) |
b4da00e9 | 742 | |
38eea7c7 SM |
743 | (defun locate-file (filename path &optional suffixes predicate) |
744 | "Search for FILENAME through PATH. | |
c7c4bc11 EZ |
745 | If found, return the absolute file name of FILENAME, with its suffixes; |
746 | otherwise return nil. | |
747 | PATH should be a list of directories to look in, like the lists in | |
748 | `exec-path' or `load-path'. | |
38eea7c7 SM |
749 | If SUFFIXES is non-nil, it should be a list of suffixes to append to |
750 | file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). | |
c7c4bc11 | 751 | Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. |
38eea7c7 | 752 | If non-nil, PREDICATE is used instead of `file-readable-p'. |
aa56f361 SM |
753 | |
754 | This function will normally skip directories, so if you want it to find | |
755 | directories, make sure the PREDICATE function returns `dir-ok' for them. | |
756 | ||
e6f0ff92 RS |
757 | PREDICATE can also be an integer to pass to the `access' system call, |
758 | in which case file-name handlers are ignored. This usage is deprecated. | |
e6f0ff92 RS |
759 | For compatibility, PREDICATE can also be one of the symbols |
760 | `executable', `readable', `writable', or `exists', or a list of | |
761 | one or more of those symbols." | |
38eea7c7 SM |
762 | (if (and predicate (symbolp predicate) (not (functionp predicate))) |
763 | (setq predicate (list predicate))) | |
764 | (when (and (consp predicate) (not (functionp predicate))) | |
765 | (setq predicate | |
766 | (logior (if (memq 'executable predicate) 1 0) | |
767 | (if (memq 'writable predicate) 2 0) | |
768 | (if (memq 'readable predicate) 4 0)))) | |
769 | (locate-file-internal filename path suffixes predicate)) | |
770 | ||
e8dab975 SM |
771 | (defun locate-file-completion-table (dirs suffixes string pred action) |
772 | "Do completion for file names passed to `locate-file'." | |
df120481 SM |
773 | (cond |
774 | ((file-name-absolute-p string) | |
528c56e2 SM |
775 | ;; FIXME: maybe we should use completion-file-name-table instead, |
776 | ;; tho at least for `load', the arg is passed through | |
777 | ;; substitute-in-file-name for historical reasons. | |
778 | (read-file-name-internal string pred action)) | |
df120481 SM |
779 | ((eq (car-safe action) 'boundaries) |
780 | (let ((suffix (cdr action))) | |
2ee3d7f0 SM |
781 | `(boundaries |
782 | ,(length (file-name-directory string)) | |
783 | ,@(let ((x (file-name-directory suffix))) | |
784 | (if x (1- (length x)) (length suffix)))))) | |
df120481 | 785 | (t |
118cf454 SM |
786 | (let ((names '()) |
787 | ;; If we have files like "foo.el" and "foo.elc", we could load one of | |
788 | ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the | |
789 | ;; preferred way. So if we list all 3, that gives a lot of redundant | |
790 | ;; entries for the poor soul looking just for "foo". OTOH, sometimes | |
791 | ;; the user does want to pay attention to the extension. We try to | |
792 | ;; diffuse this tension by stripping the suffix, except when the | |
793 | ;; result is a single element (i.e. usually we only list "foo" unless | |
794 | ;; it's the only remaining element in the list, in which case we do | |
795 | ;; list "foo", "foo.elc" and "foo.el"). | |
796 | (fullnames '()) | |
e8dab975 | 797 | (suffix (concat (regexp-opt suffixes t) "\\'")) |
df120481 SM |
798 | (string-dir (file-name-directory string)) |
799 | (string-file (file-name-nondirectory string))) | |
e8dab975 | 800 | (dolist (dir dirs) |
118cf454 SM |
801 | (unless dir |
802 | (setq dir default-directory)) | |
803 | (if string-dir (setq dir (expand-file-name string-dir dir))) | |
804 | (when (file-directory-p dir) | |
805 | (dolist (file (file-name-all-completions | |
806 | string-file dir)) | |
807 | (if (not (string-match suffix file)) | |
808 | (push file names) | |
809 | (push file fullnames) | |
810 | (push (substring file 0 (match-beginning 0)) names))))) | |
811 | ;; Switching from names to names+fullnames creates a non-monotonicity | |
812 | ;; which can cause problems with things like partial-completion. | |
813 | ;; To minimize the problem, filter out completion-regexp-list, so that | |
43f964fc SM |
814 | ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements |
815 | ;; from `names' which only matched `string' when they still had | |
816 | ;; their suffix. | |
817 | (setq names (all-completions string names)) | |
118cf454 SM |
818 | ;; Remove duplicates of the first element, so that we can easily check |
819 | ;; if `names' really only contains a single element. | |
820 | (when (cdr names) (setcdr names (delete (car names) (cdr names)))) | |
821 | (unless (cdr names) | |
822 | ;; There's no more than one matching non-suffixed element, so expand | |
823 | ;; the list by adding the suffixed elements as well. | |
824 | (setq names (nconc names fullnames))) | |
df120481 SM |
825 | (completion-table-with-context |
826 | string-dir names string-file pred action))))) | |
e8dab975 SM |
827 | |
828 | (defun locate-file-completion (string path-and-suffixes action) | |
829 | "Do completion for file names passed to `locate-file'. | |
830 | PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)." | |
59f7af81 | 831 | (declare (obsolete locate-file-completion-table "23.1")) |
e8dab975 SM |
832 | (locate-file-completion-table (car path-and-suffixes) |
833 | (cdr path-and-suffixes) | |
834 | string nil action)) | |
2c3d8820 | 835 | |
8cd56959 | 836 | (defvar locate-dominating-stop-dir-regexp |
a7610c52 | 837 | (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'") |
8cd56959 SM |
838 | "Regexp of directory names which stop the search in `locate-dominating-file'. |
839 | Any directory whose name matches this regexp will be treated like | |
840 | a kind of root directory by `locate-dominating-file' which will stop its search | |
841 | when it bumps into it. | |
842 | The default regexp prevents fruitless and time-consuming attempts to find | |
48981b8b JR |
843 | special files in directories in which filenames are interpreted as hostnames, |
844 | or mount points potentially requiring authentication as a different user.") | |
8cd56959 SM |
845 | |
846 | ;; (defun locate-dominating-files (file regexp) | |
847 | ;; "Look up the directory hierarchy from FILE for a file matching REGEXP. | |
848 | ;; Stop at the first parent where a matching file is found and return the list | |
849 | ;; of files that that match in this directory." | |
850 | ;; (catch 'found | |
851 | ;; ;; `user' is not initialized yet because `file' may not exist, so we may | |
852 | ;; ;; have to walk up part of the hierarchy before we find the "initial UID". | |
853 | ;; (let ((user nil) | |
854 | ;; ;; Abbreviate, so as to stop when we cross ~/. | |
855 | ;; (dir (abbreviate-file-name (file-name-as-directory file))) | |
856 | ;; files) | |
857 | ;; (while (and dir | |
858 | ;; ;; As a heuristic, we stop looking up the hierarchy of | |
859 | ;; ;; directories as soon as we find a directory belonging to | |
860 | ;; ;; another user. This should save us from looking in | |
861 | ;; ;; things like /net and /afs. This assumes that all the | |
862 | ;; ;; files inside a project belong to the same user. | |
863 | ;; (let ((prev-user user)) | |
864 | ;; (setq user (nth 2 (file-attributes dir))) | |
865 | ;; (or (null prev-user) (equal user prev-user)))) | |
866 | ;; (if (setq files (condition-case nil | |
867 | ;; (directory-files dir 'full regexp 'nosort) | |
868 | ;; (error nil))) | |
869 | ;; (throw 'found files) | |
870 | ;; (if (equal dir | |
871 | ;; (setq dir (file-name-directory | |
872 | ;; (directory-file-name dir)))) | |
873 | ;; (setq dir nil)))) | |
874 | ;; nil))) | |
875 | ||
9a40b8d4 | 876 | (defun locate-dominating-file (file name) |
0781098a | 877 | "Look up the directory hierarchy from FILE for a directory containing NAME. |
09949b83 | 878 | Stop at the first parent directory containing a file NAME, |
eb182446 | 879 | and return the directory. Return nil if not found. |
0781098a SM |
880 | Instead of a string, NAME can also be a predicate taking one argument |
881 | \(a directory) and returning a non-nil value if that directory is the one for | |
882 | which we're looking." | |
8cd56959 SM |
883 | ;; We used to use the above locate-dominating-files code, but the |
884 | ;; directory-files call is very costly, so we're much better off doing | |
885 | ;; multiple calls using the code in here. | |
09949b83 | 886 | ;; |
8cd56959 SM |
887 | ;; Represent /home/luser/foo as ~/foo so that we don't try to look for |
888 | ;; `name' in /home or in /. | |
889 | (setq file (abbreviate-file-name file)) | |
890 | (let ((root nil) | |
8cd56959 SM |
891 | ;; `user' is not initialized outside the loop because |
892 | ;; `file' may not exist, so we may have to walk up part of the | |
06b60517 JB |
893 | ;; hierarchy before we find the "initial UID". Note: currently unused |
894 | ;; (user nil) | |
8cd56959 SM |
895 | try) |
896 | (while (not (or root | |
897 | (null file) | |
898 | ;; FIXME: Disabled this heuristic because it is sometimes | |
899 | ;; inappropriate. | |
900 | ;; As a heuristic, we stop looking up the hierarchy of | |
901 | ;; directories as soon as we find a directory belonging | |
902 | ;; to another user. This should save us from looking in | |
903 | ;; things like /net and /afs. This assumes that all the | |
904 | ;; files inside a project belong to the same user. | |
905 | ;; (let ((prev-user user)) | |
906 | ;; (setq user (nth 2 (file-attributes file))) | |
907 | ;; (and prev-user (not (equal user prev-user)))) | |
908 | (string-match locate-dominating-stop-dir-regexp file))) | |
0781098a SM |
909 | (setq try (if (stringp name) |
910 | (file-exists-p (expand-file-name name file)) | |
911 | (funcall name file))) | |
8cd56959 | 912 | (cond (try (setq root file)) |
06b60517 | 913 | ((equal file (setq file (file-name-directory |
8cd56959 SM |
914 | (directory-file-name file)))) |
915 | (setq file nil)))) | |
0781098a | 916 | (if root (file-name-as-directory root)))) |
8cd56959 | 917 | |
418fd375 | 918 | |
c3f6aa20 SM |
919 | (defun executable-find (command) |
920 | "Search for COMMAND in `exec-path' and return the absolute file name. | |
921 | Return nil if COMMAND is not found anywhere in `exec-path'." | |
922 | ;; Use 1 rather than file-executable-p to better match the behavior of | |
923 | ;; call-process. | |
924 | (locate-file command exec-path exec-suffixes 1)) | |
925 | ||
b4da00e9 | 926 | (defun load-library (library) |
0a56bf8c | 927 | "Load the Emacs Lisp library named LIBRARY. |
9d73a99e CY |
928 | This is an interface to the function `load'. LIBRARY is searched |
929 | for in `load-path', both with and without `load-suffixes' (as | |
930 | well as `load-file-rep-suffixes'). | |
931 | ||
932 | See Info node `(emacs)Lisp Libraries' for more details. | |
933 | See `load-file' for a different interface to `load'." | |
38eea7c7 SM |
934 | (interactive |
935 | (list (completing-read "Load library: " | |
e8dab975 SM |
936 | (apply-partially 'locate-file-completion-table |
937 | load-path | |
938 | (get-load-suffixes))))) | |
b4da00e9 | 939 | (load library)) |
5d68c2c2 | 940 | |
ac25542d | 941 | (defun file-remote-p (file &optional identification connected) |
3f788773 | 942 | "Test whether FILE specifies a location on a remote system. |
bace743a DA |
943 | A file is considered remote if accessing it is likely to |
944 | be slower or less reliable than accessing local files. | |
945 | ||
946 | `file-remote-p' never opens a new remote connection. It can | |
947 | only reuse a connection that is already open. | |
948 | ||
949 | Return nil or a string identifying the remote connection | |
950 | \(ideally a prefix of FILE). Return nil if FILE is a relative | |
951 | file name. | |
952 | ||
953 | When IDENTIFICATION is nil, the returned string is a complete | |
954 | remote identifier: with components method, user, and host. The | |
955 | components are those present in FILE, with defaults filled in for | |
956 | any that are missing. | |
957 | ||
958 | IDENTIFICATION can specify which part of the identification to | |
959 | return. IDENTIFICATION can be the symbol `method', `user', | |
960 | `host', or `localname'. Any other value is handled like nil and | |
961 | means to return the complete identification. The string returned | |
962 | for IDENTIFICATION `localname' can differ depending on whether | |
963 | there is an existing connection. | |
964 | ||
965 | If CONNECTED is non-nil, return an identification only if FILE is | |
966 | located on a remote system and a connection is established to | |
967 | that remote system. | |
968 | ||
969 | Tip: You can use this expansion of remote identifier components | |
970 | to derive a new remote file name from an existing one. For | |
971 | example, if FILE is \"/sudo::/path/to/file\" then | |
972 | ||
973 | \(concat \(file-remote-p FILE) \"/bin/sh\") | |
974 | ||
975 | returns a remote file name for file \"/bin/sh\" that has the | |
976 | same remote identifier as FILE but expanded; a name such as | |
977 | \"/sudo:root@myhost:/bin/sh\"." | |
04621aaa | 978 | (let ((handler (find-file-name-handler file 'file-remote-p))) |
ff7affeb | 979 | (if handler |
ac25542d | 980 | (funcall handler 'file-remote-p file identification connected) |
04621aaa | 981 | nil))) |
ff7affeb | 982 | |
ead5edc0 GM |
983 | ;; Probably this entire variable should be obsolete now, in favor of |
984 | ;; something Tramp-related (?). It is not used in many places. | |
985 | ;; It's not clear what the best file for this to be in is, but given | |
986 | ;; it uses custom-initialize-delay, it is easier if it is preloaded | |
987 | ;; rather than autoloaded. | |
988 | (defcustom remote-shell-program | |
989 | ;; This used to try various hard-coded places for remsh, rsh, and | |
990 | ;; rcmd, trying to guess based on location whether "rsh" was | |
991 | ;; "restricted shell" or "remote shell", but I don't see the point | |
992 | ;; in this day and age. Almost everyone will use ssh, and have | |
993 | ;; whatever command they want to use in PATH. | |
994 | (purecopy | |
532f361c | 995 | (let ((list '("ssh" "remsh" "rcmd" "rsh"))) |
ead5edc0 GM |
996 | (while (and list |
997 | (not (executable-find (car list))) | |
998 | (setq list (cdr list)))) | |
999 | (or (car list) "ssh"))) | |
1000 | "Program to use to execute commands on a remote host (e.g. ssh or rsh)." | |
2a1e2476 | 1001 | :version "24.3" ; ssh rather than rsh, etc |
ead5edc0 GM |
1002 | :initialize 'custom-initialize-delay |
1003 | :group 'environment | |
1004 | :type 'file) | |
1005 | ||
4bc3c53d MA |
1006 | (defcustom remote-file-name-inhibit-cache 10 |
1007 | "Whether to use the remote file-name cache for read access. | |
b011fbfe GM |
1008 | When `nil', never expire cached values (caution) |
1009 | When `t', never use the cache (safe, but may be slow) | |
1010 | A number means use cached values for that amount of seconds since caching. | |
1011 | ||
1012 | The attributes of remote files are cached for better performance. | |
1013 | If they are changed outside of Emacs's control, the cached values | |
1014 | become invalid, and must be reread. If you are sure that nothing | |
1015 | other than Emacs changes the files, you can set this variable to `nil'. | |
1016 | ||
1017 | If a remote file is checked regularly, it might be a good idea to | |
1018 | let-bind this variable to a value less than the interval between | |
1019 | consecutive checks. For example: | |
4bc3c53d | 1020 | |
06b60517 JB |
1021 | (defun display-time-file-nonempty-p (file) |
1022 | (let ((remote-file-name-inhibit-cache (- display-time-interval 5))) | |
1023 | (and (file-exists-p file) | |
86ec63ba | 1024 | (< 0 (nth 7 (file-attributes (file-chase-links file)))))))" |
4bc3c53d MA |
1025 | :group 'files |
1026 | :version "24.1" | |
1027 | :type `(choice | |
1028 | (const :tag "Do not inhibit file name cache" nil) | |
1029 | (const :tag "Do not use file name cache" t) | |
1030 | (integer :tag "Do not use file name cache" | |
1031 | :format "Do not use file name cache older then %v seconds" | |
1032 | :value 10))) | |
1033 | ||
ffc0e1ca | 1034 | (defun file-local-copy (file) |
5d68c2c2 RS |
1035 | "Copy the file FILE into a temporary file on this machine. |
1036 | Returns the name of the local copy, or nil, if FILE is directly | |
1037 | accessible." | |
ffc0e1ca AS |
1038 | ;; This formerly had an optional BUFFER argument that wasn't used by |
1039 | ;; anything. | |
6eaebaa2 | 1040 | (let ((handler (find-file-name-handler file 'file-local-copy))) |
5d68c2c2 RS |
1041 | (if handler |
1042 | (funcall handler 'file-local-copy file) | |
1043 | nil))) | |
f3e23606 | 1044 | |
05ef1cda | 1045 | (defun file-truename (filename &optional counter prev-dirs) |
06083aa1 GM |
1046 | "Return the truename of FILENAME. |
1047 | If FILENAME is not absolute, first expands it against `default-directory'. | |
f3e23606 RS |
1048 | The truename of a file name is found by chasing symbolic links |
1049 | both at the level of the file and at the level of the directories | |
05ef1cda RS |
1050 | containing it, until no links are left at any level. |
1051 | ||
89bf74f8 | 1052 | \(fn FILENAME)" ;; Don't document the optional arguments. |
b9963e32 JB |
1053 | ;; COUNTER and PREV-DIRS are only used in recursive calls. |
1054 | ;; COUNTER can be a cons cell whose car is the count of how many | |
1055 | ;; more links to chase before getting an error. | |
05ef1cda RS |
1056 | ;; PREV-DIRS can be a cons cell whose car is an alist |
1057 | ;; of truenames we've just recently computed. | |
f2440e42 RS |
1058 | (cond ((or (string= filename "") (string= filename "~")) |
1059 | (setq filename (expand-file-name filename)) | |
1060 | (if (string= filename "") | |
1061 | (setq filename "/"))) | |
1062 | ((and (string= (substring filename 0 1) "~") | |
1063 | (string-match "~[^/]*/?" filename)) | |
1064 | (let ((first-part | |
1065 | (substring filename 0 (match-end 0))) | |
1066 | (rest (substring filename (match-end 0)))) | |
1067 | (setq filename (concat (expand-file-name first-part) rest))))) | |
1068 | ||
05ef1cda | 1069 | (or counter (setq counter (list 100))) |
b505828b RS |
1070 | (let (done |
1071 | ;; For speed, remove the ange-ftp completion handler from the list. | |
1072 | ;; We know it's not needed here. | |
1073 | ;; For even more speed, do this only on the outermost call. | |
1074 | (file-name-handler-alist | |
1075 | (if prev-dirs file-name-handler-alist | |
1076 | (let ((tem (copy-sequence file-name-handler-alist))) | |
1077 | (delq (rassq 'ange-ftp-completion-hook-function tem) tem))))) | |
1078 | (or prev-dirs (setq prev-dirs (list nil))) | |
b1667e6c | 1079 | |
6dad7178 | 1080 | ;; andrewi@harlequin.co.uk - on Windows, there is an issue with |
b1667e6c GV |
1081 | ;; case differences being ignored by the OS, and short "8.3 DOS" |
1082 | ;; name aliases existing for all files. (The short names are not | |
1083 | ;; reported by directory-files, but can be used to refer to files.) | |
1084 | ;; It seems appropriate for file-truename to resolve these issues in | |
1085 | ;; the most natural way, which on Windows is to call the function | |
1086 | ;; `w32-long-file-name' - this returns the exact name of a file as | |
1087 | ;; it is stored on disk (expanding short name aliases with the full | |
1088 | ;; name in the process). | |
1089 | (if (eq system-type 'windows-nt) | |
6dad7178 EZ |
1090 | (unless (string-match "[[*?]" filename) |
1091 | ;; If filename exists, use its long name. If it doesn't | |
1092 | ;; exist, the recursion below on the directory of filename | |
1093 | ;; will drill down until we find a directory that exists, | |
1094 | ;; and use the long name of that, with the extra | |
1095 | ;; non-existent path components concatenated. | |
1096 | (let ((longname (w32-long-file-name filename))) | |
1097 | (if longname | |
1098 | (setq filename longname))))) | |
b1667e6c | 1099 | |
05ef1cda RS |
1100 | ;; If this file directly leads to a link, process that iteratively |
1101 | ;; so that we don't use lots of stack. | |
1102 | (while (not done) | |
1103 | (setcar counter (1- (car counter))) | |
1104 | (if (< (car counter) 0) | |
1105 | (error "Apparent cycle of symbolic links for %s" filename)) | |
1106 | (let ((handler (find-file-name-handler filename 'file-truename))) | |
1107 | ;; For file name that has a special handler, call handler. | |
1108 | ;; This is so that ange-ftp can save time by doing a no-op. | |
1109 | (if handler | |
1110 | (setq filename (funcall handler 'file-truename filename) | |
1111 | done t) | |
fb145562 | 1112 | (let ((dir (or (file-name-directory filename) default-directory)) |
05ef1cda RS |
1113 | target dirfile) |
1114 | ;; Get the truename of the directory. | |
1115 | (setq dirfile (directory-file-name dir)) | |
1116 | ;; If these are equal, we have the (or a) root directory. | |
1117 | (or (string= dir dirfile) | |
6dad7178 EZ |
1118 | (and (memq system-type '(windows-nt ms-dos cygwin)) |
1119 | (eq (compare-strings dir 0 nil dirfile 0 nil t) t)) | |
05ef1cda RS |
1120 | ;; If this is the same dir we last got the truename for, |
1121 | ;; save time--don't recalculate. | |
1122 | (if (assoc dir (car prev-dirs)) | |
1123 | (setq dir (cdr (assoc dir (car prev-dirs)))) | |
1124 | (let ((old dir) | |
1125 | (new (file-name-as-directory (file-truename dirfile counter prev-dirs)))) | |
1126 | (setcar prev-dirs (cons (cons old new) (car prev-dirs))) | |
1127 | (setq dir new)))) | |
1128 | (if (equal ".." (file-name-nondirectory filename)) | |
1129 | (setq filename | |
1130 | (directory-file-name (file-name-directory (directory-file-name dir))) | |
1131 | done t) | |
1132 | (if (equal "." (file-name-nondirectory filename)) | |
1133 | (setq filename (directory-file-name dir) | |
1134 | done t) | |
1135 | ;; Put it back on the file name. | |
1136 | (setq filename (concat dir (file-name-nondirectory filename))) | |
1137 | ;; Is the file name the name of a link? | |
1138 | (setq target (file-symlink-p filename)) | |
1139 | (if target | |
1140 | ;; Yes => chase that link, then start all over | |
1141 | ;; since the link may point to a directory name that uses links. | |
1142 | ;; We can't safely use expand-file-name here | |
1143 | ;; since target might look like foo/../bar where foo | |
1144 | ;; is itself a link. Instead, we handle . and .. above. | |
1145 | (setq filename | |
1146 | (if (file-name-absolute-p target) | |
1147 | target | |
1148 | (concat dir target)) | |
1149 | done nil) | |
1150 | ;; No, we are done! | |
1151 | (setq done t)))))))) | |
1152 | filename)) | |
5dbfdacd | 1153 | |
302fcc98 | 1154 | (defun file-chase-links (filename &optional limit) |
5dadeb29 | 1155 | "Chase links in FILENAME until a name that is not a link. |
302fcc98 RS |
1156 | Unlike `file-truename', this does not check whether a parent |
1157 | directory name is a symbolic link. | |
1158 | If the optional argument LIMIT is a number, | |
1159 | it means chase no more than that many links and then stop." | |
1160 | (let (tem (newname filename) | |
92464ae6 | 1161 | (count 0)) |
302fcc98 RS |
1162 | (while (and (or (null limit) (< count limit)) |
1163 | (setq tem (file-symlink-p newname))) | |
9695aac6 | 1164 | (save-match-data |
92464ae6 | 1165 | (if (and (null limit) (= count 100)) |
9695aac6 RS |
1166 | (error "Apparent cycle of symbolic links for %s" filename)) |
1167 | ;; In the context of a link, `//' doesn't mean what Emacs thinks. | |
1168 | (while (string-match "//+" tem) | |
1169 | (setq tem (replace-match "/" nil nil tem))) | |
1170 | ;; Handle `..' by hand, since it needs to work in the | |
1171 | ;; target of any directory symlink. | |
1172 | ;; This code is not quite complete; it does not handle | |
1173 | ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose. | |
1174 | (while (string-match "\\`\\.\\./" tem) | |
1175 | (setq tem (substring tem 3)) | |
1176 | (setq newname (expand-file-name newname)) | |
1177 | ;; Chase links in the default dir of the symlink. | |
1178 | (setq newname | |
1179 | (file-chase-links | |
1180 | (directory-file-name (file-name-directory newname)))) | |
1181 | ;; Now find the parent of that dir. | |
1182 | (setq newname (file-name-directory newname))) | |
1183 | (setq newname (expand-file-name tem (file-name-directory newname))) | |
92464ae6 | 1184 | (setq count (1+ count)))) |
5dadeb29 | 1185 | newname)) |
9bdbd98e | 1186 | |
e3971c44 EZ |
1187 | ;; A handy function to display file sizes in human-readable form. |
1188 | ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference. | |
1189 | (defun file-size-human-readable (file-size &optional flavor) | |
1190 | "Produce a string showing FILE-SIZE in human-readable form. | |
1191 | ||
1192 | Optional second argument FLAVOR controls the units and the display format: | |
1193 | ||
1194 | If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced | |
1195 | suffixes are \"k\", \"M\", \"G\", \"T\", etc. | |
1196 | If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes | |
1197 | are \"k\", \"M\", \"G\", \"T\", etc. | |
1198 | If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes | |
1199 | are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc." | |
1200 | (let ((power (if (or (null flavor) (eq flavor 'iec)) | |
1201 | 1024.0 | |
1202 | 1000.0)) | |
1203 | (post-fixes | |
1204 | ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta | |
1205 | (list "" "k" "M" "G" "T" "P" "E" "Z" "Y"))) | |
1206 | (while (and (>= file-size power) (cdr post-fixes)) | |
1207 | (setq file-size (/ file-size power) | |
1208 | post-fixes (cdr post-fixes))) | |
04f33f1e EZ |
1209 | (format (if (> (mod file-size 1.0) 0.05) |
1210 | "%.1f%s%s" | |
1211 | "%.0f%s%s") | |
1212 | file-size | |
e3971c44 EZ |
1213 | (if (and (eq flavor 'iec) (string= (car post-fixes) "k")) |
1214 | "K" | |
1215 | (car post-fixes)) | |
1216 | (if (eq flavor 'iec) "iB" "")))) | |
1217 | ||
9e8bb7f7 RS |
1218 | (defun make-temp-file (prefix &optional dir-flag suffix) |
1219 | "Create a temporary file. | |
1220 | The returned file name (created by appending some random characters at the end | |
1221 | of PREFIX, and expanding against `temporary-file-directory' if necessary), | |
1222 | is guaranteed to point to a newly created empty file. | |
1223 | You can then use `write-region' to write new data into the file. | |
1224 | ||
1225 | If DIR-FLAG is non-nil, create a new empty directory instead of a file. | |
1226 | ||
1227 | If SUFFIX is non-nil, add that at the end of the file name." | |
1228 | (let ((umask (default-file-modes)) | |
1229 | file) | |
1230 | (unwind-protect | |
1231 | (progn | |
1232 | ;; Create temp files with strict access rights. It's easy to | |
1233 | ;; loosen them later, whereas it's impossible to close the | |
1234 | ;; time-window of loose permissions otherwise. | |
1235 | (set-default-file-modes ?\700) | |
1236 | (while (condition-case () | |
1237 | (progn | |
1238 | (setq file | |
1239 | (make-temp-name | |
f8dce815 GM |
1240 | (if (zerop (length prefix)) |
1241 | (file-name-as-directory | |
1242 | temporary-file-directory) | |
1243 | (expand-file-name prefix | |
1244 | temporary-file-directory)))) | |
9e8bb7f7 RS |
1245 | (if suffix |
1246 | (setq file (concat file suffix))) | |
1247 | (if dir-flag | |
1248 | (make-directory file) | |
1249 | (write-region "" nil file nil 'silent nil 'excl)) | |
1250 | nil) | |
1251 | (file-already-exists t)) | |
1252 | ;; the file was somehow created by someone else between | |
1253 | ;; `make-temp-name' and `write-region', let's try again. | |
1254 | nil) | |
1255 | file) | |
1256 | ;; Reset the umask. | |
1257 | (set-default-file-modes umask)))) | |
1258 | ||
9bdbd98e KH |
1259 | (defun recode-file-name (file coding new-coding &optional ok-if-already-exists) |
1260 | "Change the encoding of FILE's name from CODING to NEW-CODING. | |
1261 | The value is a new name of FILE. | |
1262 | Signals a `file-already-exists' error if a file of the new name | |
26b9ecbc JB |
1263 | already exists unless optional fourth argument OK-IF-ALREADY-EXISTS |
1264 | is non-nil. A number as fourth arg means request confirmation if | |
9bdbd98e KH |
1265 | the new name already exists. This is what happens in interactive |
1266 | use with M-x." | |
1267 | (interactive | |
1268 | (let ((default-coding (or file-name-coding-system | |
1269 | default-file-name-coding-system)) | |
1270 | (filename (read-file-name "Recode filename: " nil nil t)) | |
1271 | from-coding to-coding) | |
1272 | (if (and default-coding | |
1273 | ;; We provide the default coding only when it seems that | |
1274 | ;; the filename is correctly decoded by the default | |
1275 | ;; coding. | |
1276 | (let ((charsets (find-charset-string filename))) | |
1277 | (and (not (memq 'eight-bit-control charsets)) | |
1278 | (not (memq 'eight-bit-graphic charsets))))) | |
1279 | (setq from-coding (read-coding-system | |
1280 | (format "Recode filename %s from (default %s): " | |
1281 | filename default-coding) | |
1282 | default-coding)) | |
1283 | (setq from-coding (read-coding-system | |
1284 | (format "Recode filename %s from: " filename)))) | |
cdec2ad7 | 1285 | |
9bdbd98e KH |
1286 | ;; We provide the default coding only when a user is going to |
1287 | ;; change the encoding not from the default coding. | |
1288 | (if (eq from-coding default-coding) | |
1289 | (setq to-coding (read-coding-system | |
1290 | (format "Recode filename %s from %s to: " | |
1291 | filename from-coding))) | |
1292 | (setq to-coding (read-coding-system | |
1293 | (format "Recode filename %s from %s to (default %s): " | |
1294 | filename from-coding default-coding) | |
1295 | default-coding))) | |
1296 | (list filename from-coding to-coding))) | |
1297 | ||
1298 | (let* ((default-coding (or file-name-coding-system | |
1299 | default-file-name-coding-system)) | |
1300 | ;; FILE should have been decoded by DEFAULT-CODING. | |
1301 | (encoded (encode-coding-string file default-coding)) | |
1302 | (newname (decode-coding-string encoded coding)) | |
1303 | (new-encoded (encode-coding-string newname new-coding)) | |
1304 | ;; Suppress further encoding. | |
1305 | (file-name-coding-system nil) | |
1306 | (default-file-name-coding-system nil) | |
1307 | (locale-coding-system nil)) | |
1308 | (rename-file encoded new-encoded ok-if-already-exists) | |
1309 | newname)) | |
b4da00e9 | 1310 | \f |
4a977e20 CY |
1311 | (defcustom confirm-nonexistent-file-or-buffer 'after-completion |
1312 | "Whether confirmation is requested before visiting a new file or buffer. | |
1313 | If nil, confirmation is not requested. | |
1314 | If the value is `after-completion', confirmation is only | |
1315 | requested if the user called `minibuffer-complete' right before | |
1316 | `minibuffer-complete-and-exit'. | |
1317 | Any other non-nil value means to request confirmation. | |
1318 | ||
35b05a77 SM |
1319 | This affects commands like `switch-to-buffer' and `find-file'." |
1320 | :group 'find-file | |
1321 | :version "23.1" | |
b61324c3 GM |
1322 | :type '(choice (const :tag "After completion" after-completion) |
1323 | (const :tag "Never" nil) | |
1324 | (other :tag "Always" t))) | |
4a977e20 CY |
1325 | |
1326 | (defun confirm-nonexistent-file-or-buffer () | |
1327 | "Whether to request confirmation before visiting a new file or buffer. | |
1328 | The variable `confirm-nonexistent-file-or-buffer' determines the | |
1329 | return value, which may be passed as the REQUIRE-MATCH arg to | |
1330 | `read-buffer' or `find-file-read-args'." | |
1331 | (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion) | |
1332 | 'confirm-after-completion) | |
1333 | (confirm-nonexistent-file-or-buffer | |
1334 | 'confirm) | |
1335 | (t nil))) | |
35b05a77 | 1336 | |
a42e7db0 | 1337 | (defmacro minibuffer-with-setup-hook (fun &rest body) |
9bbe0828 | 1338 | "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY. |
a42e7db0 | 1339 | BODY should use the minibuffer at most once. |
9bbe0828 CY |
1340 | Recursive uses of the minibuffer are unaffected (FUN is not |
1341 | called additional times). | |
1342 | ||
4963739e | 1343 | This macro actually adds an auxiliary function that calls FUN, |
9bbe0828 | 1344 | rather than FUN itself, to `minibuffer-setup-hook'." |
a42e7db0 SM |
1345 | (declare (indent 1) (debug t)) |
1346 | (let ((hook (make-symbol "setup-hook"))) | |
44dce0fb RS |
1347 | `(let (,hook) |
1348 | (setq ,hook | |
1349 | (lambda () | |
1350 | ;; Clear out this hook so it does not interfere | |
1351 | ;; with any recursive minibuffer usage. | |
1352 | (remove-hook 'minibuffer-setup-hook ,hook) | |
2bd49e46 | 1353 | (funcall ,fun))) |
a42e7db0 SM |
1354 | (unwind-protect |
1355 | (progn | |
1356 | (add-hook 'minibuffer-setup-hook ,hook) | |
1357 | ,@body) | |
1358 | (remove-hook 'minibuffer-setup-hook ,hook))))) | |
1359 | ||
05a7cb3d | 1360 | (defun find-file-read-args (prompt mustmatch) |
7d371eac | 1361 | (list (read-file-name prompt nil default-directory mustmatch) |
b2a26f4e | 1362 | t)) |
e6f0ff92 | 1363 | |
243ce842 | 1364 | (defun find-file (filename &optional wildcards) |
b4da00e9 RM |
1365 | "Edit file FILENAME. |
1366 | Switch to a buffer visiting file FILENAME, | |
243ce842 | 1367 | creating one if none already exists. |
e6f0ff92 RS |
1368 | Interactively, the default if you just type RET is the current directory, |
1369 | but the visited file name is available through the minibuffer history: | |
1370 | type M-n to pull it into the minibuffer. | |
1371 | ||
4d4efd30 EZ |
1372 | You can visit files on remote machines by specifying something |
1373 | like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can | |
1374 | also visit local files as a different user by specifying | |
6f174d77 EZ |
1375 | /sudo::FILE for the file name. |
1376 | See the Info node `(tramp)Filename Syntax' in the Tramp Info | |
1377 | manual, for more about this. | |
4d4efd30 | 1378 | |
243ce842 | 1379 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
91174d63 | 1380 | expand wildcards (if any) and visit multiple files. You can |
518dc5be | 1381 | suppress wildcard expansion by setting `find-file-wildcards' to nil. |
91174d63 RS |
1382 | |
1383 | To visit a file without any kind of conversion and without | |
1384 | automatically choosing a major mode, use \\[find-file-literally]." | |
14fd09e5 SM |
1385 | (interactive |
1386 | (find-file-read-args "Find file: " | |
4a977e20 | 1387 | (confirm-nonexistent-file-or-buffer))) |
5b8ed07b RS |
1388 | (let ((value (find-file-noselect filename nil nil wildcards))) |
1389 | (if (listp value) | |
c3313451 | 1390 | (mapcar 'switch-to-buffer (nreverse value)) |
24510c22 | 1391 | (switch-to-buffer value)))) |
82d0954a | 1392 | |
243ce842 | 1393 | (defun find-file-other-window (filename &optional wildcards) |
b4da00e9 | 1394 | "Edit file FILENAME, in another window. |
4d4efd30 EZ |
1395 | |
1396 | Like \\[find-file] (which see), but creates a new window or reuses | |
1397 | an existing one. See the function `display-buffer'. | |
e6f0ff92 RS |
1398 | |
1399 | Interactively, the default if you just type RET is the current directory, | |
1400 | but the visited file name is available through the minibuffer history: | |
1401 | type M-n to pull it into the minibuffer. | |
1402 | ||
243ce842 RS |
1403 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
1404 | expand wildcards (if any) and visit multiple files." | |
14fd09e5 SM |
1405 | (interactive |
1406 | (find-file-read-args "Find file in other window: " | |
4a977e20 | 1407 | (confirm-nonexistent-file-or-buffer))) |
5b8ed07b RS |
1408 | (let ((value (find-file-noselect filename nil nil wildcards))) |
1409 | (if (listp value) | |
1410 | (progn | |
1411 | (setq value (nreverse value)) | |
a9d6a617 JL |
1412 | (cons (switch-to-buffer-other-window (car value)) |
1413 | (mapcar 'switch-to-buffer (cdr value)))) | |
5b8ed07b | 1414 | (switch-to-buffer-other-window value)))) |
243ce842 RS |
1415 | |
1416 | (defun find-file-other-frame (filename &optional wildcards) | |
f98955ea | 1417 | "Edit file FILENAME, in another frame. |
4d4efd30 EZ |
1418 | |
1419 | Like \\[find-file] (which see), but creates a new frame or reuses | |
1420 | an existing one. See the function `display-buffer'. | |
e6f0ff92 RS |
1421 | |
1422 | Interactively, the default if you just type RET is the current directory, | |
1423 | but the visited file name is available through the minibuffer history: | |
1424 | type M-n to pull it into the minibuffer. | |
1425 | ||
243ce842 RS |
1426 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
1427 | expand wildcards (if any) and visit multiple files." | |
14fd09e5 SM |
1428 | (interactive |
1429 | (find-file-read-args "Find file in other frame: " | |
4a977e20 | 1430 | (confirm-nonexistent-file-or-buffer))) |
5b8ed07b RS |
1431 | (let ((value (find-file-noselect filename nil nil wildcards))) |
1432 | (if (listp value) | |
1433 | (progn | |
1434 | (setq value (nreverse value)) | |
a9d6a617 JL |
1435 | (cons (switch-to-buffer-other-frame (car value)) |
1436 | (mapcar 'switch-to-buffer (cdr value)))) | |
5b8ed07b | 1437 | (switch-to-buffer-other-frame value)))) |
243ce842 | 1438 | |
63c8abc4 EZ |
1439 | (defun find-file-existing (filename) |
1440 | "Edit the existing file FILENAME. | |
4d4efd30 | 1441 | Like \\[find-file], but only allow a file that exists, and do not allow |
63c8abc4 EZ |
1442 | file names with wildcards." |
1443 | (interactive (nbutlast (find-file-read-args "Find existing file: " t))) | |
32226619 JB |
1444 | (if (and (not (called-interactively-p 'interactive)) |
1445 | (not (file-exists-p filename))) | |
63c8abc4 EZ |
1446 | (error "%s does not exist" filename) |
1447 | (find-file filename) | |
1448 | (current-buffer))) | |
46bfc73b | 1449 | |
0781098a | 1450 | (defun find-file--read-only (fun filename wildcards) |
a9d6a617 JL |
1451 | (unless (or (and wildcards find-file-wildcards |
1452 | (not (string-match "\\`/:" filename)) | |
1453 | (string-match "[[*?]" filename)) | |
1454 | (file-exists-p filename)) | |
1455 | (error "%s does not exist" filename)) | |
0781098a | 1456 | (let ((value (funcall fun filename wildcards))) |
35e62fc9 | 1457 | (mapc (lambda (b) (with-current-buffer b (read-only-mode 1))) |
a9d6a617 JL |
1458 | (if (listp value) value (list value))) |
1459 | value)) | |
b4da00e9 | 1460 | |
0781098a SM |
1461 | (defun find-file-read-only (filename &optional wildcards) |
1462 | "Edit file FILENAME but don't allow changes. | |
1463 | Like \\[find-file], but marks buffer as read-only. | |
1464 | Use \\[toggle-read-only] to permit editing." | |
1465 | (interactive | |
1466 | (find-file-read-args "Find file read-only: " | |
1467 | (confirm-nonexistent-file-or-buffer))) | |
1468 | (find-file--read-only #'find-file filename wildcards)) | |
1469 | ||
243ce842 | 1470 | (defun find-file-read-only-other-window (filename &optional wildcards) |
b4da00e9 | 1471 | "Edit file FILENAME in another window but don't allow changes. |
4d4efd30 | 1472 | Like \\[find-file-other-window], but marks buffer as read-only. |
b4da00e9 | 1473 | Use \\[toggle-read-only] to permit editing." |
14fd09e5 SM |
1474 | (interactive |
1475 | (find-file-read-args "Find file read-only other window: " | |
4a977e20 | 1476 | (confirm-nonexistent-file-or-buffer))) |
0781098a | 1477 | (find-file--read-only #'find-file-other-window filename wildcards)) |
b4da00e9 | 1478 | |
243ce842 | 1479 | (defun find-file-read-only-other-frame (filename &optional wildcards) |
f98955ea | 1480 | "Edit file FILENAME in another frame but don't allow changes. |
4d4efd30 | 1481 | Like \\[find-file-other-frame], but marks buffer as read-only. |
5bbbceb1 | 1482 | Use \\[toggle-read-only] to permit editing." |
14fd09e5 SM |
1483 | (interactive |
1484 | (find-file-read-args "Find file read-only other frame: " | |
4a977e20 | 1485 | (confirm-nonexistent-file-or-buffer))) |
0781098a | 1486 | (find-file--read-only #'find-file-other-frame filename wildcards)) |
a9d6a617 JL |
1487 | |
1488 | (defun find-alternate-file-other-window (filename &optional wildcards) | |
60eaf370 | 1489 | "Find file FILENAME as a replacement for the file in the next window. |
a9d6a617 JL |
1490 | This command does not select that window. |
1491 | ||
4d4efd30 EZ |
1492 | See \\[find-file] for the possible forms of the FILENAME argument. |
1493 | ||
a9d6a617 JL |
1494 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
1495 | expand wildcards (if any) and replace the file with multiple files." | |
60eaf370 RS |
1496 | (interactive |
1497 | (save-selected-window | |
1498 | (other-window 1) | |
1499 | (let ((file buffer-file-name) | |
1500 | (file-name nil) | |
1501 | (file-dir nil)) | |
1502 | (and file | |
1503 | (setq file-name (file-name-nondirectory file) | |
1504 | file-dir (file-name-directory file))) | |
1505 | (list (read-file-name | |
4b8b1ec5 SM |
1506 | "Find alternate file: " file-dir nil |
1507 | (confirm-nonexistent-file-or-buffer) file-name) | |
a9d6a617 | 1508 | t)))) |
60eaf370 | 1509 | (if (one-window-p) |
a9d6a617 | 1510 | (find-file-other-window filename wildcards) |
60eaf370 RS |
1511 | (save-selected-window |
1512 | (other-window 1) | |
a9d6a617 | 1513 | (find-alternate-file filename wildcards)))) |
60eaf370 | 1514 | |
e5d9c0d1 CY |
1515 | ;; Defined and used in buffer.c, but not as a DEFVAR_LISP. |
1516 | (defvar kill-buffer-hook nil | |
1517 | "Hook run when a buffer is killed. | |
1518 | The buffer being killed is current while the hook is running. | |
1519 | See `kill-buffer'.") | |
06b60517 | 1520 | |
a9d6a617 | 1521 | (defun find-alternate-file (filename &optional wildcards) |
b4da00e9 RM |
1522 | "Find file FILENAME, select its buffer, kill previous buffer. |
1523 | If the current buffer now contains an empty file that you just visited | |
a9d6a617 JL |
1524 | \(presumably by mistake), use this command to visit the file you really want. |
1525 | ||
4d4efd30 EZ |
1526 | See \\[find-file] for the possible forms of the FILENAME argument. |
1527 | ||
a9d6a617 | 1528 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
077f47e2 CY |
1529 | expand wildcards (if any) and replace the file with multiple files. |
1530 | ||
1531 | If the current buffer is an indirect buffer, or the base buffer | |
1532 | for one or more indirect buffers, the other buffer(s) are not | |
1533 | killed." | |
b4da00e9 RM |
1534 | (interactive |
1535 | (let ((file buffer-file-name) | |
1536 | (file-name nil) | |
1537 | (file-dir nil)) | |
1538 | (and file | |
1539 | (setq file-name (file-name-nondirectory file) | |
1540 | file-dir (file-name-directory file))) | |
a61f59b4 | 1541 | (list (read-file-name |
4b8b1ec5 SM |
1542 | "Find alternate file: " file-dir nil |
1543 | (confirm-nonexistent-file-or-buffer) file-name) | |
a9d6a617 | 1544 | t))) |
63fabbb4 RS |
1545 | (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions) |
1546 | (error "Aborted")) | |
e07fcbdc SM |
1547 | (and (buffer-modified-p) buffer-file-name |
1548 | (not (yes-or-no-p "Kill and replace the buffer without saving it? ")) | |
1549 | (error "Aborted")) | |
b4da00e9 RM |
1550 | (let ((obuf (current-buffer)) |
1551 | (ofile buffer-file-name) | |
8bb27285 | 1552 | (onum buffer-file-number) |
37c58ca6 | 1553 | (odir dired-directory) |
8bb27285 | 1554 | (otrue buffer-file-truename) |
b4da00e9 | 1555 | (oname (buffer-name))) |
049a231b KF |
1556 | ;; Run `kill-buffer-hook' here. It needs to happen before |
1557 | ;; variables like `buffer-file-name' etc are set to nil below, | |
1558 | ;; because some of the hooks that could be invoked | |
1559 | ;; (e.g., `save-place-to-alist') depend on those variables. | |
1560 | ;; | |
1561 | ;; Note that `kill-buffer-hook' is not what queries whether to | |
1562 | ;; save a modified buffer visiting a file. Rather, `kill-buffer' | |
1563 | ;; asks that itself. Thus, there's no need to temporarily do | |
1564 | ;; `(set-buffer-modified-p nil)' before running this hook. | |
1565 | (run-hooks 'kill-buffer-hook) | |
1566 | ;; Okay, now we can end-of-life the old buffer. | |
baf9b8c4 RS |
1567 | (if (get-buffer " **lose**") |
1568 | (kill-buffer " **lose**")) | |
b4da00e9 | 1569 | (rename-buffer " **lose**") |
b4da00e9 RM |
1570 | (unwind-protect |
1571 | (progn | |
1572 | (unlock-buffer) | |
7906c044 RS |
1573 | ;; This prevents us from finding the same buffer |
1574 | ;; if we specified the same file again. | |
a4ad4d96 RS |
1575 | (setq buffer-file-name nil) |
1576 | (setq buffer-file-number nil) | |
1577 | (setq buffer-file-truename nil) | |
7906c044 RS |
1578 | ;; Likewise for dired buffers. |
1579 | (setq dired-directory nil) | |
a9d6a617 | 1580 | (find-file filename wildcards)) |
63fabbb4 RS |
1581 | (when (eq obuf (current-buffer)) |
1582 | ;; This executes if find-file gets an error | |
1583 | ;; and does not really find anything. | |
1584 | ;; We put things back as they were. | |
1585 | ;; If find-file actually finds something, we kill obuf below. | |
1586 | (setq buffer-file-name ofile) | |
1587 | (setq buffer-file-number onum) | |
1588 | (setq buffer-file-truename otrue) | |
7906c044 | 1589 | (setq dired-directory odir) |
63fabbb4 RS |
1590 | (lock-buffer) |
1591 | (rename-buffer oname))) | |
1592 | (unless (eq (current-buffer) obuf) | |
d97a9ff3 | 1593 | (with-current-buffer obuf |
049a231b KF |
1594 | ;; We already ran these; don't run them again. |
1595 | (let (kill-buffer-query-functions kill-buffer-hook) | |
d97a9ff3 | 1596 | (kill-buffer obuf)))))) |
9b8ef27d | 1597 | \f |
b4da00e9 RM |
1598 | (defun create-file-buffer (filename) |
1599 | "Create a suitably named buffer for visiting FILENAME, and return it. | |
1600 | FILENAME (sans directory) is used unchanged if that name is free; | |
661e8cd1 MC |
1601 | otherwise a string <2> or <3> or ... is appended to get an unused name. |
1602 | Spaces at the start of FILENAME (sans directory) are removed." | |
b4da00e9 RM |
1603 | (let ((lastname (file-name-nondirectory filename))) |
1604 | (if (string= lastname "") | |
1605 | (setq lastname filename)) | |
661e8cd1 MC |
1606 | (save-match-data |
1607 | (string-match "^ *\\(.*\\)" lastname) | |
1608 | (generate-new-buffer (match-string 1 lastname))))) | |
b4da00e9 | 1609 | |
5bbbceb1 JB |
1610 | (defun generate-new-buffer (name) |
1611 | "Create and return a buffer with a name based on NAME. | |
29165787 | 1612 | Choose the buffer's name using `generate-new-buffer-name'." |
5bbbceb1 JB |
1613 | (get-buffer-create (generate-new-buffer-name name))) |
1614 | ||
1e8780b1 | 1615 | (defcustom automount-dir-prefix (purecopy "^/tmp_mnt/") |
ffc0e1ca AS |
1616 | "Regexp to match the automounter prefix in a directory name." |
1617 | :group 'files | |
1618 | :type 'regexp) | |
2a1e2476 | 1619 | (make-obsolete-variable 'automount-dir-prefix 'directory-abbrev-alist "24.3") |
e373f201 | 1620 | |
ffb3a4db | 1621 | (defvar abbreviated-home-dir nil |
ffc0e1ca | 1622 | "The user's homedir abbreviated according to `directory-abbrev-alist'.") |
ffb3a4db | 1623 | |
5bbbceb1 | 1624 | (defun abbreviate-file-name (filename) |
29165787 | 1625 | "Return a version of FILENAME shortened using `directory-abbrev-alist'. |
fe4e58ec EZ |
1626 | This also substitutes \"~\" for the user's home directory (unless the |
1627 | home directory is a root directory) and removes automounter prefixes | |
1628 | \(see the variable `automount-dir-prefix')." | |
e373f201 | 1629 | ;; Get rid of the prefixes added by the automounter. |
f663a1ce RS |
1630 | (save-match-data |
1631 | (if (and automount-dir-prefix | |
1632 | (string-match automount-dir-prefix filename) | |
1633 | (file-exists-p (file-name-directory | |
1634 | (substring filename (1- (match-end 0)))))) | |
1635 | (setq filename (substring filename (1- (match-end 0))))) | |
20431da9 CY |
1636 | ;; Avoid treating /home/foo as /home/Foo during `~' substitution. |
1637 | ;; To fix this right, we need a `file-name-case-sensitive-p' | |
1638 | ;; function, but we don't have that yet, so just guess. | |
9f2f6ad8 | 1639 | (let ((case-fold-search |
20431da9 | 1640 | (memq system-type '(ms-dos windows-nt darwin cygwin)))) |
f663a1ce RS |
1641 | ;; If any elt of directory-abbrev-alist matches this name, |
1642 | ;; abbreviate accordingly. | |
20431da9 CY |
1643 | (dolist (dir-abbrev directory-abbrev-alist) |
1644 | (if (string-match (car dir-abbrev) filename) | |
f663a1ce | 1645 | (setq filename |
20431da9 CY |
1646 | (concat (cdr dir-abbrev) |
1647 | (substring filename (match-end 0)))))) | |
f663a1ce RS |
1648 | ;; Compute and save the abbreviated homedir name. |
1649 | ;; We defer computing this until the first time it's needed, to | |
1650 | ;; give time for directory-abbrev-alist to be set properly. | |
1651 | ;; We include a slash at the end, to avoid spurious matches | |
1652 | ;; such as `/usr/foobar' when the home dir is `/usr/foo'. | |
1653 | (or abbreviated-home-dir | |
1654 | (setq abbreviated-home-dir | |
1655 | (let ((abbreviated-home-dir "$foo")) | |
528c56e2 | 1656 | (concat "\\`" (abbreviate-file-name (expand-file-name "~")) |
e959542d | 1657 | "\\(/\\|\\'\\)")))) |
f663a1ce RS |
1658 | |
1659 | ;; If FILENAME starts with the abbreviated homedir, | |
1660 | ;; make it start with `~' instead. | |
1661 | (if (and (string-match abbreviated-home-dir filename) | |
1662 | ;; If the home dir is just /, don't change it. | |
1663 | (not (and (= (match-end 0) 1) | |
1664 | (= (aref filename 0) ?/))) | |
1665 | ;; MS-DOS root directories can come with a drive letter; | |
1666 | ;; Novell Netware allows drive letters beyond `Z:'. | |
528c56e2 | 1667 | (not (and (memq system-type '(ms-dos windows-nt cygwin)) |
f663a1ce RS |
1668 | (save-match-data |
1669 | (string-match "^[a-zA-`]:/$" filename))))) | |
5bbbceb1 | 1670 | (setq filename |
f663a1ce RS |
1671 | (concat "~" |
1672 | (match-string 1 filename) | |
1673 | (substring filename (match-end 0))))) | |
1674 | filename))) | |
5bbbceb1 | 1675 | |
3a64a3cf | 1676 | (defun find-buffer-visiting (filename &optional predicate) |
138c44f6 KH |
1677 | "Return the buffer visiting file FILENAME (a string). |
1678 | This is like `get-file-buffer', except that it checks for any buffer | |
1679 | visiting the same file, possibly under a different name. | |
a1b0c2a7 RS |
1680 | If PREDICATE is non-nil, only buffers satisfying it are eligible, |
1681 | and others are ignored. | |
138c44f6 | 1682 | If there is no such live buffer, return nil." |
3a64a3cf JB |
1683 | (let ((predicate (or predicate #'identity)) |
1684 | (truename (abbreviate-file-name (file-truename filename)))) | |
1685 | (or (let ((buf (get-file-buffer filename))) | |
1686 | (when (and buf (funcall predicate buf)) buf)) | |
1687 | (let ((list (buffer-list)) found) | |
1688 | (while (and (not found) list) | |
528c56e2 | 1689 | (with-current-buffer (car list) |
3a64a3cf JB |
1690 | (if (and buffer-file-name |
1691 | (string= buffer-file-truename truename) | |
1692 | (funcall predicate (current-buffer))) | |
1693 | (setq found (car list)))) | |
1694 | (setq list (cdr list))) | |
1695 | found) | |
1696 | (let* ((attributes (file-attributes truename)) | |
1697 | (number (nthcdr 10 attributes)) | |
1698 | (list (buffer-list)) found) | |
1699 | (and buffer-file-numbers-unique | |
02bb2aab | 1700 | (car-safe number) ;Make sure the inode is not just nil. |
3a64a3cf JB |
1701 | (while (and (not found) list) |
1702 | (with-current-buffer (car list) | |
1703 | (if (and buffer-file-name | |
1704 | (equal buffer-file-number number) | |
1705 | ;; Verify this buffer's file number | |
1706 | ;; still belongs to its file. | |
1707 | (file-exists-p buffer-file-name) | |
1708 | (equal (file-attributes buffer-file-truename) | |
1709 | attributes) | |
1710 | (funcall predicate (current-buffer))) | |
1711 | (setq found (car list)))) | |
1712 | (setq list (cdr list)))) | |
1713 | found)))) | |
9b8ef27d | 1714 | \f |
5de148a2 | 1715 | (defcustom find-file-wildcards t |
ba83982b | 1716 | "Non-nil means file-visiting commands should handle wildcards. |
5de148a2 RS |
1717 | For example, if you specify `*.c', that would visit all the files |
1718 | whose names match the pattern." | |
1719 | :group 'files | |
3957c982 | 1720 | :version "20.4" |
5de148a2 RS |
1721 | :type 'boolean) |
1722 | ||
ffc0e1ca | 1723 | (defcustom find-file-suppress-same-file-warnings nil |
ba83982b | 1724 | "Non-nil means suppress warning messages for symlinked files. |
ffc0e1ca AS |
1725 | When nil, Emacs prints a warning when visiting a file that is already |
1726 | visited, but with a different name. Setting this option to t | |
1727 | suppresses this warning." | |
1728 | :group 'files | |
1729 | :version "21.1" | |
1730 | :type 'boolean) | |
1731 | ||
818286f4 | 1732 | (defcustom large-file-warning-threshold 10000000 |
5d648479 JPW |
1733 | "Maximum size of file above which a confirmation is requested. |
1734 | When nil, never request confirmation." | |
1735 | :group 'files | |
1736 | :group 'find-file | |
bf247b6e | 1737 | :version "22.1" |
5d648479 | 1738 | :type '(choice integer (const :tag "Never request confirmation" nil))) |
818286f4 | 1739 | |
26ede5d3 | 1740 | (defun abort-if-file-too-large (size op-type filename) |
afe9998d | 1741 | "If file SIZE larger than `large-file-warning-threshold', allow user to abort. |
4954b81b AR |
1742 | OP-TYPE specifies the file operation being performed (for message to user)." |
1743 | (when (and large-file-warning-threshold size | |
3ef01959 | 1744 | (> size large-file-warning-threshold) |
54c5ba1a | 1745 | (not (y-or-n-p (format "File %s is large (%s), really %s? " |
9aea757b | 1746 | (file-name-nondirectory filename) |
54c5ba1a | 1747 | (file-size-human-readable size) op-type)))) |
3ef01959 | 1748 | (error "Aborted"))) |
4954b81b | 1749 | |
243ce842 | 1750 | (defun find-file-noselect (filename &optional nowarn rawfile wildcards) |
b4da00e9 RM |
1751 | "Read file FILENAME into a buffer and return the buffer. |
1752 | If a buffer exists visiting FILENAME, return that one, but | |
1753 | verify that the file has not changed since visited or saved. | |
82d0954a | 1754 | The buffer is not selected, just returned to the caller. |
26b9ecbc JB |
1755 | Optional second arg NOWARN non-nil means suppress any warning messages. |
1756 | Optional third arg RAWFILE non-nil means the file is read literally. | |
1757 | Optional fourth arg WILDCARDS non-nil means do wildcard processing | |
5b8ed07b | 1758 | and visit all the matching files. When wildcards are actually |
a9d6a617 JL |
1759 | used and expanded, return a list of buffers that are visiting |
1760 | the various files." | |
e373f201 JB |
1761 | (setq filename |
1762 | (abbreviate-file-name | |
1763 | (expand-file-name filename))) | |
b4da00e9 | 1764 | (if (file-directory-p filename) |
ffc0e1ca AS |
1765 | (or (and find-file-run-dired |
1766 | (run-hook-with-args-until-success | |
1767 | 'find-directory-functions | |
1768 | (if find-file-visit-truename | |
1769 | (abbreviate-file-name (file-truename filename)) | |
1770 | filename))) | |
1771 | (error "%s is a directory" filename)) | |
243ce842 RS |
1772 | (if (and wildcards |
1773 | find-file-wildcards | |
f91fe604 | 1774 | (not (string-match "\\`/:" filename)) |
5de148a2 | 1775 | (string-match "[[*?]" filename)) |
ffc0e1ca AS |
1776 | (let ((files (condition-case nil |
1777 | (file-expand-wildcards filename t) | |
1778 | (error (list filename)))) | |
5de148a2 | 1779 | (find-file-wildcards nil)) |
f91fe604 | 1780 | (if (null files) |
ffc0e1ca | 1781 | (find-file-noselect filename) |
648ec2ff | 1782 | (mapcar #'find-file-noselect files))) |
5de148a2 RS |
1783 | (let* ((buf (get-file-buffer filename)) |
1784 | (truename (abbreviate-file-name (file-truename filename))) | |
818286f4 SM |
1785 | (attributes (file-attributes truename)) |
1786 | (number (nthcdr 10 attributes)) | |
5de148a2 RS |
1787 | ;; Find any buffer for a file which has same truename. |
1788 | (other (and (not buf) (find-buffer-visiting filename)))) | |
1789 | ;; Let user know if there is a buffer with the same truename. | |
1790 | (if other | |
1791 | (progn | |
1792 | (or nowarn | |
ffc0e1ca | 1793 | find-file-suppress-same-file-warnings |
5de148a2 RS |
1794 | (string-equal filename (buffer-file-name other)) |
1795 | (message "%s and %s are the same file" | |
1796 | filename (buffer-file-name other))) | |
1797 | ;; Optionally also find that buffer. | |
1798 | (if (or find-file-existing-other-name find-file-visit-truename) | |
1799 | (setq buf other)))) | |
818286f4 | 1800 | ;; Check to see if the file looks uncommonly large. |
4954b81b | 1801 | (when (not (or buf nowarn)) |
26ede5d3 | 1802 | (abort-if-file-too-large (nth 7 attributes) "open" filename)) |
5de148a2 RS |
1803 | (if buf |
1804 | ;; We are using an existing buffer. | |
2c5b1db7 | 1805 | (let (nonexistent) |
5de148a2 RS |
1806 | (or nowarn |
1807 | (verify-visited-file-modtime buf) | |
1808 | (cond ((not (file-exists-p filename)) | |
2c5b1db7 RS |
1809 | (setq nonexistent t) |
1810 | (message "File %s no longer exists!" filename)) | |
5de148a2 RS |
1811 | ;; Certain files should be reverted automatically |
1812 | ;; if they have changed on disk and not in the buffer. | |
1813 | ((and (not (buffer-modified-p buf)) | |
1814 | (let ((tail revert-without-query) | |
1815 | (found nil)) | |
1816 | (while tail | |
1817 | (if (string-match (car tail) filename) | |
1818 | (setq found t)) | |
1819 | (setq tail (cdr tail))) | |
1820 | found)) | |
1821 | (with-current-buffer buf | |
1822 | (message "Reverting file %s..." filename) | |
1823 | (revert-buffer t t) | |
1824 | (message "Reverting file %s...done" filename))) | |
1825 | ((yes-or-no-p | |
1826 | (if (string= (file-name-nondirectory filename) | |
1827 | (buffer-name buf)) | |
1828 | (format | |
1829 | (if (buffer-modified-p buf) | |
1830 | "File %s changed on disk. Discard your edits? " | |
1831 | "File %s changed on disk. Reread from disk? ") | |
1832 | (file-name-nondirectory filename)) | |
ddd64da9 RS |
1833 | (format |
1834 | (if (buffer-modified-p buf) | |
5de148a2 RS |
1835 | "File %s changed on disk. Discard your edits in %s? " |
1836 | "File %s changed on disk. Reread from disk into %s? ") | |
1837 | (file-name-nondirectory filename) | |
1838 | (buffer-name buf)))) | |
1839 | (with-current-buffer buf | |
1840 | (revert-buffer t t))))) | |
1841 | (with-current-buffer buf | |
a8d002d2 GM |
1842 | |
1843 | ;; Check if a formerly read-only file has become | |
e554eeb7 RS |
1844 | ;; writable and vice versa, but if the buffer agrees |
1845 | ;; with the new state of the file, that is ok too. | |
a8d002d2 | 1846 | (let ((read-only (not (file-writable-p buffer-file-name)))) |
2c5b1db7 RS |
1847 | (unless (or nonexistent |
1848 | (eq read-only buffer-file-read-only) | |
e554eeb7 | 1849 | (eq read-only buffer-read-only)) |
a8d002d2 | 1850 | (when (or nowarn |
36236b72 | 1851 | (let ((question |
a8d002d2 GM |
1852 | (format "File %s is %s on disk. Change buffer mode? " |
1853 | buffer-file-name | |
1854 | (if read-only "read-only" "writable")))) | |
1855 | (y-or-n-p question))) | |
e554eeb7 RS |
1856 | (setq buffer-read-only read-only))) |
1857 | (setq buffer-file-read-only read-only)) | |
a8d002d2 | 1858 | |
ef59dd3b EZ |
1859 | (when (and (not (eq (not (null rawfile)) |
1860 | (not (null find-file-literally)))) | |
2c5b1db7 | 1861 | (not nonexistent) |
ef59dd3b EZ |
1862 | ;; It is confusing to ask whether to visit |
1863 | ;; non-literally if they have the file in | |
3ae59fff EZ |
1864 | ;; hexl-mode or image-mode. |
1865 | (not (memq major-mode '(hexl-mode image-mode)))) | |
5de148a2 | 1866 | (if (buffer-modified-p) |
562ca538 | 1867 | (if (y-or-n-p |
674b7bae | 1868 | (format |
562ca538 RS |
1869 | (if rawfile |
1870 | "The file %s is already visited normally, | |
1871 | and you have edited the buffer. Now you have asked to visit it literally, | |
1872 | meaning no coding system handling, format conversion, or local variables. | |
1873 | Emacs can only visit a file in one way at a time. | |
1874 | ||
1875 | Do you want to save the file, and visit it literally instead? " | |
1876 | "The file %s is already visited literally, | |
1877 | meaning no coding system handling, format conversion, or local variables. | |
1878 | You have edited the buffer. Now you have asked to visit the file normally, | |
1879 | but Emacs can only visit a file in one way at a time. | |
1880 | ||
1881 | Do you want to save the file, and visit it normally instead? ") | |
1882 | (file-name-nondirectory filename))) | |
5de148a2 RS |
1883 | (progn |
1884 | (save-buffer) | |
1885 | (find-file-noselect-1 buf filename nowarn | |
1886 | rawfile truename number)) | |
562ca538 | 1887 | (if (y-or-n-p |
674b7bae | 1888 | (format |
562ca538 RS |
1889 | (if rawfile |
1890 | "\ | |
1891 | Do you want to discard your changes, and visit the file literally now? " | |
1892 | "\ | |
1893 | Do you want to discard your changes, and visit the file normally now? "))) | |
5de148a2 RS |
1894 | (find-file-noselect-1 buf filename nowarn |
1895 | rawfile truename number) | |
1896 | (error (if rawfile "File already visited non-literally" | |
1897 | "File already visited literally")))) | |
674b7bae JB |
1898 | (if (y-or-n-p |
1899 | (format | |
562ca538 RS |
1900 | (if rawfile |
1901 | "The file %s is already visited normally. | |
1902 | You have asked to visit it literally, | |
1903 | meaning no coding system decoding, format conversion, or local variables. | |
1904 | But Emacs can only visit a file in one way at a time. | |
1905 | ||
1906 | Do you want to revisit the file literally now? " | |
1907 | "The file %s is already visited literally, | |
1908 | meaning no coding system decoding, format conversion, or local variables. | |
1909 | You have asked to visit it normally, | |
1910 | but Emacs can only visit a file in one way at a time. | |
1911 | ||
1912 | Do you want to revisit the file normally now? ") | |
1913 | (file-name-nondirectory filename))) | |
5de148a2 RS |
1914 | (find-file-noselect-1 buf filename nowarn |
1915 | rawfile truename number) | |
1916 | (error (if rawfile "File already visited non-literally" | |
1917 | "File already visited literally")))))) | |
1918 | ;; Return the buffer we are using. | |
1919 | buf) | |
1920 | ;; Create a new buffer. | |
1921 | (setq buf (create-file-buffer filename)) | |
5de148a2 RS |
1922 | ;; find-file-noselect-1 may use a different buffer. |
1923 | (find-file-noselect-1 buf filename nowarn | |
1924 | rawfile truename number)))))) | |
ddd64da9 RS |
1925 | |
1926 | (defun find-file-noselect-1 (buf filename nowarn rawfile truename number) | |
4edcfd17 | 1927 | (let (error) |
ddd64da9 RS |
1928 | (with-current-buffer buf |
1929 | (kill-local-variable 'find-file-literally) | |
b296cbd4 RS |
1930 | ;; Needed in case we are re-visiting the file with a different |
1931 | ;; text representation. | |
e73ec04b | 1932 | (kill-local-variable 'buffer-file-coding-system) |
4ad1689f | 1933 | (kill-local-variable 'cursor-type) |
4edcfd17 | 1934 | (let ((inhibit-read-only t)) |
0a11c70b LT |
1935 | (erase-buffer)) |
1936 | (and (default-value 'enable-multibyte-characters) | |
1937 | (not rawfile) | |
1938 | (set-buffer-multibyte t)) | |
1939 | (if rawfile | |
74dca654 | 1940 | (condition-case () |
0a11c70b LT |
1941 | (let ((inhibit-read-only t)) |
1942 | (insert-file-contents-literally filename t)) | |
74dca654 LT |
1943 | (file-error |
1944 | (when (and (file-exists-p filename) | |
1945 | (not (file-readable-p filename))) | |
1946 | (kill-buffer buf) | |
1947 | (signal 'file-error (list "File is not readable" | |
1948 | filename))) | |
0a11c70b LT |
1949 | ;; Unconditionally set error |
1950 | (setq error t))) | |
1951 | (condition-case () | |
1952 | (let ((inhibit-read-only t)) | |
1953 | (insert-file-contents filename t)) | |
1954 | (file-error | |
1955 | (when (and (file-exists-p filename) | |
1956 | (not (file-readable-p filename))) | |
1957 | (kill-buffer buf) | |
1958 | (signal 'file-error (list "File is not readable" | |
1959 | filename))) | |
e0d8fc91 | 1960 | ;; Run find-file-not-found-functions until one returns non-nil. |
0a11c70b LT |
1961 | (or (run-hook-with-args-until-success 'find-file-not-found-functions) |
1962 | ;; If they fail too, set error. | |
1963 | (setq error t))))) | |
b120e713 KH |
1964 | ;; Record the file's truename, and maybe use that as visited name. |
1965 | (if (equal filename buffer-file-name) | |
1966 | (setq buffer-file-truename truename) | |
9ab19105 DL |
1967 | (setq buffer-file-truename |
1968 | (abbreviate-file-name (file-truename buffer-file-name)))) | |
ddd64da9 | 1969 | (setq buffer-file-number number) |
ddd64da9 | 1970 | (if find-file-visit-truename |
e442c62b | 1971 | (setq buffer-file-name (expand-file-name buffer-file-truename))) |
ddd64da9 | 1972 | ;; Set buffer's default directory to that of the file. |
b120e713 | 1973 | (setq default-directory (file-name-directory buffer-file-name)) |
ddd64da9 RS |
1974 | ;; Turn off backup files for certain file names. Since |
1975 | ;; this is a permanent local, the major mode won't eliminate it. | |
b98a8e06 RS |
1976 | (and backup-enable-predicate |
1977 | (not (funcall backup-enable-predicate buffer-file-name)) | |
ddd64da9 RS |
1978 | (progn |
1979 | (make-local-variable 'backup-inhibited) | |
1980 | (setq backup-inhibited t))) | |
f402ba38 RS |
1981 | (if rawfile |
1982 | (progn | |
1983 | (set-buffer-multibyte nil) | |
1984 | (setq buffer-file-coding-system 'no-conversion) | |
e8f30180 | 1985 | (set-buffer-major-mode buf) |
f402ba38 RS |
1986 | (make-local-variable 'find-file-literally) |
1987 | (setq find-file-literally t)) | |
1988 | (after-find-file error (not nowarn))) | |
1989 | (current-buffer)))) | |
9b8ef27d RS |
1990 | \f |
1991 | (defun insert-file-contents-literally (filename &optional visit beg end replace) | |
1992 | "Like `insert-file-contents', but only reads in the file literally. | |
1993 | A buffer may be modified in several ways after reading into the buffer, | |
1994 | to Emacs features such as format decoding, character code | |
0370fe77 | 1995 | conversion, `find-file-hook', automatic uncompression, etc. |
9b8ef27d RS |
1996 | |
1997 | This function ensures that none of these modifications will take place." | |
1998 | (let ((format-alist nil) | |
1999 | (after-insert-file-functions nil) | |
2000 | (coding-system-for-read 'no-conversion) | |
2001 | (coding-system-for-write 'no-conversion) | |
cdec2ad7 | 2002 | (inhibit-file-name-handlers |
0781098a SM |
2003 | ;; FIXME: Yuck!! We should turn insert-file-contents-literally |
2004 | ;; into a file operation instead! | |
bfeee9d1 | 2005 | (append '(jka-compr-handler image-file-handler epa-file-handler) |
cdec2ad7 JB |
2006 | inhibit-file-name-handlers)) |
2007 | (inhibit-file-name-operation 'insert-file-contents)) | |
0781098a | 2008 | (insert-file-contents filename visit beg end replace))) |
9b8ef27d | 2009 | |
3a64a3cf JB |
2010 | (defun insert-file-1 (filename insert-func) |
2011 | (if (file-directory-p filename) | |
2012 | (signal 'file-error (list "Opening input file" "file is a directory" | |
2013 | filename))) | |
4954b81b | 2014 | ;; Check whether the file is uncommonly large |
26ede5d3 | 2015 | (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename) |
3a64a3cf JB |
2016 | (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename)) |
2017 | #'buffer-modified-p)) | |
2018 | (tem (funcall insert-func filename))) | |
2019 | (push-mark (+ (point) (car (cdr tem)))) | |
2020 | (when buffer | |
2021 | (message "File %s already visited and modified in buffer %s" | |
2022 | filename (buffer-name buffer))))) | |
2023 | ||
9b8ef27d RS |
2024 | (defun insert-file-literally (filename) |
2025 | "Insert contents of file FILENAME into buffer after point with no conversion. | |
2026 | ||
2027 | This function is meant for the user to run interactively. | |
2028 | Don't call it from programs! Use `insert-file-contents-literally' instead. | |
2029 | \(Its calling sequence is different; see its documentation)." | |
2030 | (interactive "*fInsert file literally: ") | |
3a64a3cf | 2031 | (insert-file-1 filename #'insert-file-contents-literally)) |
9b8ef27d RS |
2032 | |
2033 | (defvar find-file-literally nil | |
2034 | "Non-nil if this buffer was made by `find-file-literally' or equivalent. | |
72d6685c GM |
2035 | This has the `permanent-local' property, which takes effect if you |
2036 | make the variable buffer-local.") | |
9b8ef27d | 2037 | (put 'find-file-literally 'permanent-local t) |
5fc196af | 2038 | |
ffc0e1ca | 2039 | (defun find-file-literally (filename) |
5fc196af RS |
2040 | "Visit file FILENAME with no conversion of any kind. |
2041 | Format conversion and character code conversion are both disabled, | |
2042 | and multibyte characters are disabled in the resulting buffer. | |
e65db7b8 RS |
2043 | The major mode used is Fundamental mode regardless of the file name, |
2044 | and local variable specifications in the file are ignored. | |
407b4328 GM |
2045 | Automatic uncompression and adding a newline at the end of the |
2046 | file due to `require-final-newline' is also disabled. | |
9b8ef27d RS |
2047 | |
2048 | You cannot absolutely rely on this function to result in | |
b9aa9537 | 2049 | visiting the file literally. If Emacs already has a buffer |
9b8ef27d RS |
2050 | which is visiting the file, you get the existing buffer, |
2051 | regardless of whether it was created literally or not. | |
2052 | ||
2053 | In a Lisp program, if you want to be sure of accessing a file's | |
2054 | contents literally, you should create a temporary buffer and then read | |
2055 | the file contents into it using `insert-file-contents-literally'." | |
7d371eac JL |
2056 | (interactive |
2057 | (list (read-file-name | |
2058 | "Find file literally: " nil default-directory | |
2059 | (confirm-nonexistent-file-or-buffer)))) | |
9b8ef27d | 2060 | (switch-to-buffer (find-file-noselect filename nil t))) |
b4da00e9 | 2061 | \f |
e0ab8879 | 2062 | (defun after-find-file (&optional error warn noauto |
3e214b50 | 2063 | _after-find-file-from-revert-buffer |
9a30563f | 2064 | nomodes) |
b4da00e9 RM |
2065 | "Called after finding a file and by the default revert function. |
2066 | Sets buffer mode, parses local variables. | |
8cfb9d46 | 2067 | Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an |
b4da00e9 RM |
2068 | error in reading the file. WARN non-nil means warn if there |
2069 | exists an auto-save file more recent than the visited file. | |
8cfb9d46 | 2070 | NOAUTO means don't mess with auto-save mode. |
3e214b50 JB |
2071 | Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored |
2072 | \(see `revert-buffer-in-progress-p' for similar functionality). | |
9a30563f | 2073 | Fifth arg NOMODES non-nil means don't alter the file's modes. |
0370fe77 | 2074 | Finishes by calling the functions in `find-file-hook' |
9a30563f | 2075 | unless NOMODES is non-nil." |
b4da00e9 RM |
2076 | (setq buffer-read-only (not (file-writable-p buffer-file-name))) |
2077 | (if noninteractive | |
2078 | nil | |
2079 | (let* (not-serious | |
2080 | (msg | |
fe50b6ab GM |
2081 | (cond |
2082 | ((not warn) nil) | |
2083 | ((and error (file-attributes buffer-file-name)) | |
2084 | (setq buffer-read-only t) | |
7152b011 | 2085 | (if (and (file-symlink-p buffer-file-name) |
86ec63ba PE |
2086 | (not (file-exists-p |
2087 | (file-chase-links buffer-file-name)))) | |
7152b011 LMI |
2088 | "Symbolic link that points to nonexistent file" |
2089 | "File exists, but cannot be read")) | |
fe50b6ab GM |
2090 | ((not buffer-read-only) |
2091 | (if (and warn | |
2092 | ;; No need to warn if buffer is auto-saved | |
2093 | ;; under the name of the visited file. | |
2094 | (not (and buffer-file-name | |
2095 | auto-save-visited-file-name)) | |
2096 | (file-newer-than-file-p (or buffer-auto-save-file-name | |
2097 | (make-auto-save-file-name)) | |
2098 | buffer-file-name)) | |
64d18e8f | 2099 | (format "%s has auto save data; consider M-x recover-this-file" |
fe50b6ab GM |
2100 | (file-name-nondirectory buffer-file-name)) |
2101 | (setq not-serious t) | |
2102 | (if error "(New file)" nil))) | |
2103 | ((not error) | |
2104 | (setq not-serious t) | |
2105 | "Note: file is write protected") | |
2106 | ((file-attributes (directory-file-name default-directory)) | |
2107 | "File not found and directory write-protected") | |
2108 | ((file-exists-p (file-name-directory buffer-file-name)) | |
2109 | (setq buffer-read-only nil)) | |
2110 | (t | |
2111 | (setq buffer-read-only nil) | |
07703430 | 2112 | "Use M-x make-directory RET RET to create the directory and its parents")))) |
fe50b6ab | 2113 | (when msg |
a74357d4 | 2114 | (message "%s" msg) |
e09f3bff | 2115 | (or not-serious (sit-for 1 t)))) |
fe50b6ab | 2116 | (when (and auto-save-default (not noauto)) |
06b60517 | 2117 | (auto-save-mode 1))) |
ffc0e1ca AS |
2118 | ;; Make people do a little extra work (C-x C-q) |
2119 | ;; before altering a backup file. | |
fe50b6ab GM |
2120 | (when (backup-file-name-p buffer-file-name) |
2121 | (setq buffer-read-only t)) | |
8fd9c174 RS |
2122 | ;; When a file is marked read-only, |
2123 | ;; make the buffer read-only even if root is looking at it. | |
879365c6 KS |
2124 | (when (and (file-modes (buffer-file-name)) |
2125 | (zerop (logand (file-modes (buffer-file-name)) #o222))) | |
8fd9c174 | 2126 | (setq buffer-read-only t)) |
fe50b6ab GM |
2127 | (unless nomodes |
2128 | (when (and view-read-only view-mode) | |
4a74c818 | 2129 | (view-mode -1)) |
9a30563f | 2130 | (normal-mode t) |
f4206092 RS |
2131 | ;; If requested, add a newline at the end of the file. |
2132 | (and (memq require-final-newline '(visit visit-save)) | |
2133 | (> (point-max) (point-min)) | |
2134 | (/= (char-after (1- (point-max))) ?\n) | |
2135 | (not (and (eq selective-display t) | |
2136 | (= (char-after (1- (point-max))) ?\r))) | |
c09c46b2 | 2137 | (not buffer-read-only) |
f4206092 RS |
2138 | (save-excursion |
2139 | (goto-char (point-max)) | |
0d7eb2ea | 2140 | (ignore-errors (insert "\n")))) |
fe50b6ab GM |
2141 | (when (and buffer-read-only |
2142 | view-read-only | |
2143 | (not (eq (get major-mode 'mode-class) 'special))) | |
2144 | (view-mode-enter)) | |
0370fe77 | 2145 | (run-hooks 'find-file-hook))) |
b4da00e9 | 2146 | |
818286f4 SM |
2147 | (defmacro report-errors (format &rest body) |
2148 | "Eval BODY and turn any error into a FORMAT message. | |
2149 | FORMAT can have a %s escape which will be replaced with the actual error. | |
2150 | If `debug-on-error' is set, errors are not caught, so that you can | |
2151 | debug them. | |
2152 | Avoid using a large BODY since it is duplicated." | |
2153 | (declare (debug t) (indent 1)) | |
2154 | `(if debug-on-error | |
2155 | (progn . ,body) | |
2156 | (condition-case err | |
2157 | (progn . ,body) | |
2158 | (error (message ,format (prin1-to-string err)))))) | |
2159 | ||
b4da00e9 RM |
2160 | (defun normal-mode (&optional find-file) |
2161 | "Choose the major mode for this buffer automatically. | |
2162 | Also sets up any specified local variables of the file. | |
2163 | Uses the visited file name, the -*- line, and the local variables spec. | |
2164 | ||
2165 | This function is called automatically from `find-file'. In that case, | |
aa5fcebf | 2166 | we may set up the file-specified mode and local variables, |
a5ce12c3 | 2167 | depending on the value of `enable-local-variables'. |
aa5fcebf KH |
2168 | In addition, if `local-enable-local-variables' is nil, we do |
2169 | not set local variables (though we do notice a mode specified with -*-.) | |
2170 | ||
2171 | `enable-local-variables' is ignored if you run `normal-mode' interactively, | |
2172 | or from Lisp without specifying the optional argument FIND-FILE; | |
2173 | in that case, this function acts as if `enable-local-variables' were t." | |
b4da00e9 | 2174 | (interactive) |
14acf2f5 | 2175 | (funcall (or (default-value 'major-mode) 'fundamental-mode)) |
0fc205c6 | 2176 | (let ((enable-local-variables (or (not find-file) enable-local-variables))) |
e145f188 GM |
2177 | ;; FIXME this is less efficient than it could be, since both |
2178 | ;; s-a-m and h-l-v may parse the same regions, looking for "mode:". | |
0fc205c6 LT |
2179 | (report-errors "File mode specification error: %s" |
2180 | (set-auto-mode)) | |
2181 | (report-errors "File local-variables error: %s" | |
818286f4 | 2182 | (hack-local-variables))) |
6e86be0b RS |
2183 | ;; Turn font lock off and on, to make sure it takes account of |
2184 | ;; whatever file local variables are relevant to it. | |
344f1111 SM |
2185 | (when (and font-lock-mode |
2186 | ;; Font-lock-mode (now in font-core.el) can be ON when | |
2187 | ;; font-lock.el still hasn't been loaded. | |
2188 | (boundp 'font-lock-keywords) | |
2189 | (eq (car font-lock-keywords) t)) | |
6e86be0b | 2190 | (setq font-lock-keywords (cadr font-lock-keywords)) |
fd06db5d | 2191 | (font-lock-mode 1))) |
b4da00e9 | 2192 | |
2372f278 | 2193 | (defcustom auto-mode-case-fold t |
94495713 KS |
2194 | "Non-nil means to try second pass through `auto-mode-alist'. |
2195 | This means that if the first case-sensitive search through the alist fails | |
2196 | to find a matching major mode, a second case-insensitive search is made. | |
2197 | On systems with case-insensitive file names, this variable is ignored, | |
bb178aaa | 2198 | since only a single case-insensitive search through the alist is made." |
94495713 KS |
2199 | :group 'files |
2200 | :version "22.1" | |
2201 | :type 'boolean) | |
2202 | ||
f76e0cd0 | 2203 | (defvar auto-mode-alist |
f209c999 MS |
2204 | ;; Note: The entries for the modes defined in cc-mode.el (c-mode, |
2205 | ;; c++-mode, java-mode and more) are added through autoload | |
2206 | ;; directives in that file. That way is discouraged since it | |
2207 | ;; spreads out the definition of the initial value. | |
4aaffda1 | 2208 | (mapcar |
e8e4d5c8 SS |
2209 | (lambda (elt) |
2210 | (cons (purecopy (car elt)) (cdr elt))) | |
813731b3 | 2211 | `(;; do this first, so that .html.pl is Polish html, not Perl |
1e5d2a04 | 2212 | ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode) |
5e339ee2 GM |
2213 | ("\\.svgz?\\'" . image-mode) |
2214 | ("\\.svgz?\\'" . xml-mode) | |
2215 | ("\\.x[bp]m\\'" . image-mode) | |
2216 | ("\\.x[bp]m\\'" . c-mode) | |
2217 | ("\\.p[bpgn]m\\'" . image-mode) | |
2218 | ("\\.tiff?\\'" . image-mode) | |
2219 | ("\\.gif\\'" . image-mode) | |
2220 | ("\\.png\\'" . image-mode) | |
2221 | ("\\.jpe?g\\'" . image-mode) | |
9e6f5419 | 2222 | ("\\.te?xt\\'" . text-mode) |
bbc67516 | 2223 | ("\\.[tT]e[xX]\\'" . tex-mode) |
4e163715 | 2224 | ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages. |
ffc0e1ca | 2225 | ("\\.ltx\\'" . latex-mode) |
4e163715 | 2226 | ("\\.dtx\\'" . doctex-mode) |
18d8cb81 | 2227 | ("\\.org\\'" . org-mode) |
ffc0e1ca | 2228 | ("\\.el\\'" . emacs-lisp-mode) |
e6e267fc | 2229 | ("Project\\.ede\\'" . emacs-lisp-mode) |
21575d92 | 2230 | ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode) |
ffc0e1ca | 2231 | ("\\.l\\'" . lisp-mode) |
bbc67516 DP |
2232 | ("\\.li?sp\\'" . lisp-mode) |
2233 | ("\\.[fF]\\'" . fortran-mode) | |
ffc0e1ca AS |
2234 | ("\\.for\\'" . fortran-mode) |
2235 | ("\\.p\\'" . pascal-mode) | |
2236 | ("\\.pas\\'" . pascal-mode) | |
448ecec3 | 2237 | ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode) |
ffc0e1ca | 2238 | ("\\.ad[abs]\\'" . ada-mode) |
7defe888 | 2239 | ("\\.ad[bs].dg\\'" . ada-mode) |
bbc67516 | 2240 | ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode) |
3968c89f | 2241 | ("Imakefile\\'" . makefile-imake-mode) |
8088bb2c DP |
2242 | ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk |
2243 | ("\\.makepp\\'" . makefile-makepp-mode) | |
2ddf2ea6 | 2244 | ,@(if (memq system-type '(berkeley-unix darwin)) |
813731b3 | 2245 | '(("\\.mk\\'" . makefile-bsdmake-mode) |
ad89bb83 | 2246 | ("\\.make\\'" . makefile-bsdmake-mode) |
47d4e709 | 2247 | ("GNUmakefile\\'" . makefile-gmake-mode) |
813731b3 DP |
2248 | ("[Mm]akefile\\'" . makefile-bsdmake-mode)) |
2249 | '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage | |
ad89bb83 | 2250 | ("\\.make\\'" . makefile-gmake-mode) |
47d4e709 | 2251 | ("[Mm]akefile\\'" . makefile-gmake-mode))) |
27a7c83f | 2252 | ("\\.am\\'" . makefile-automake-mode) |
5c6d31a4 SM |
2253 | ;; Less common extensions come here |
2254 | ;; so more common ones above are found faster. | |
ffc0e1ca AS |
2255 | ("\\.texinfo\\'" . texinfo-mode) |
2256 | ("\\.te?xi\\'" . texinfo-mode) | |
bbc67516 | 2257 | ("\\.[sS]\\'" . asm-mode) |
ffc0e1ca | 2258 | ("\\.asm\\'" . asm-mode) |
5e339ee2 GM |
2259 | ("\\.css\\'" . css-mode) |
2260 | ("\\.mixal\\'" . mixal-mode) | |
2261 | ("\\.gcov\\'" . compilation-mode) | |
2262 | ;; Besides .gdbinit, gdb documents other names to be usable for init | |
2263 | ;; files, cross-debuggers can use something like | |
2264 | ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files | |
2265 | ;; don't interfere with each other. | |
2266 | ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode) | |
bbc67516 | 2267 | ("[cC]hange\\.?[lL]og?\\'" . change-log-mode) |
40656849 | 2268 | ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode) |
ffc0e1ca AS |
2269 | ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode) |
2270 | ("\\.scm\\.[0-9]*\\'" . scheme-mode) | |
2271 | ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode) | |
b921b596 | 2272 | ("\\.bash\\'" . sh-mode) |
ffc0e1ca AS |
2273 | ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode) |
2274 | ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode) | |
2275 | ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode) | |
d5798fa7 | 2276 | ("\\.m?spec\\'" . sh-mode) |
bbc67516 | 2277 | ("\\.m[mes]\\'" . nroff-mode) |
ffc0e1ca | 2278 | ("\\.man\\'" . nroff-mode) |
ffc0e1ca | 2279 | ("\\.sty\\'" . latex-mode) |
bbc67516 | 2280 | ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option |
ffc0e1ca AS |
2281 | ("\\.bbl\\'" . latex-mode) |
2282 | ("\\.bib\\'" . bibtex-mode) | |
5e339ee2 | 2283 | ("\\.bst\\'" . bibtex-style-mode) |
ffc0e1ca | 2284 | ("\\.sql\\'" . sql-mode) |
bbc67516 | 2285 | ("\\.m[4c]\\'" . m4-mode) |
ffc0e1ca AS |
2286 | ("\\.mf\\'" . metafont-mode) |
2287 | ("\\.mp\\'" . metapost-mode) | |
2288 | ("\\.vhdl?\\'" . vhdl-mode) | |
2289 | ("\\.article\\'" . text-mode) | |
2290 | ("\\.letter\\'" . text-mode) | |
bbc67516 | 2291 | ("\\.i?tcl\\'" . tcl-mode) |
ffc0e1ca | 2292 | ("\\.exp\\'" . tcl-mode) |
ffc0e1ca AS |
2293 | ("\\.itk\\'" . tcl-mode) |
2294 | ("\\.icn\\'" . icon-mode) | |
2295 | ("\\.sim\\'" . simula-mode) | |
2296 | ("\\.mss\\'" . scribe-mode) | |
faf2a174 GM |
2297 | ;; The Fortran standard does not say anything about file extensions. |
2298 | ;; .f90 was widely used for F90, now we seem to be trapped into | |
2299 | ;; using a different extension for each language revision. | |
2300 | ;; Anyway, the following extensions are supported by gfortran. | |
bbc67516 | 2301 | ("\\.f9[05]\\'" . f90-mode) |
faf2a174 | 2302 | ("\\.f0[38]\\'" . f90-mode) |
8f9495e7 | 2303 | ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode |
4998f839 | 2304 | ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode) |
e6e267fc | 2305 | ("\\.srt\\'" . srecode-template-mode) |
ffc0e1ca AS |
2306 | ("\\.prolog\\'" . prolog-mode) |
2307 | ("\\.tar\\'" . tar-mode) | |
0ee6e7b7 JL |
2308 | ;; The list of archive file extensions should be in sync with |
2309 | ;; `auto-coding-alist' with `no-conversion' coding system. | |
e7988f09 | 2310 | ("\\.\\(\ |
b3671a51 JL |
2311 | arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\ |
2312 | ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode) | |
ccb012c5 SM |
2313 | ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org |
2314 | ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages. | |
ffc0e1ca AS |
2315 | ;; Mailer puts message to be edited in |
2316 | ;; /tmp/Re.... or Message | |
2317 | ("\\`/tmp/Re" . text-mode) | |
2318 | ("/Message[0-9]*\\'" . text-mode) | |
ffc0e1ca AS |
2319 | ;; some news reader is reported to use this |
2320 | ("\\`/tmp/fol/" . text-mode) | |
ffc0e1ca AS |
2321 | ("\\.oak\\'" . scheme-mode) |
2322 | ("\\.sgml?\\'" . sgml-mode) | |
e477ca84 | 2323 | ("\\.x[ms]l\\'" . xml-mode) |
11cb1e35 | 2324 | ("\\.dbk\\'" . xml-mode) |
ffc0e1ca AS |
2325 | ("\\.dtd\\'" . sgml-mode) |
2326 | ("\\.ds\\(ss\\)?l\\'" . dsssl-mode) | |
5055880d LL |
2327 | ("\\.js\\'" . javascript-mode) |
2328 | ("\\.json\\'" . javascript-mode) | |
855a2294 | 2329 | ("\\.[ds]?vh?\\'" . verilog-mode) |
9414dd8d CY |
2330 | ("\\.by\\'" . bovine-grammar-mode) |
2331 | ("\\.wy\\'" . wisent-grammar-mode) | |
709d45e1 KG |
2332 | ;; .emacs or .gnus or .viper following a directory delimiter in |
2333 | ;; Unix, MSDOG or VMS syntax. | |
2334 | ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode) | |
ffc0e1ca AS |
2335 | ("\\`\\..*emacs\\'" . emacs-lisp-mode) |
2336 | ;; _emacs following a directory delimiter | |
2337 | ;; in MsDos syntax | |
2338 | ("[:/]_emacs\\'" . emacs-lisp-mode) | |
2339 | ("/crontab\\.X*[0-9]+\\'" . shell-script-mode) | |
2340 | ("\\.ml\\'" . lisp-mode) | |
ce009d0b GM |
2341 | ;; Linux-2.6.9 uses some different suffix for linker scripts: |
2342 | ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo". | |
2343 | ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*". | |
2344 | ("\\.ld[si]?\\'" . ld-script-mode) | |
2345 | ("ld\\.?script\\'" . ld-script-mode) | |
54238e6d GM |
2346 | ;; .xs is also used for ld scripts, but seems to be more commonly |
2347 | ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071) | |
2348 | ("\\.xs\\'" . c-mode) | |
19543b17 GM |
2349 | ;; Explained in binutils ld/genscripts.sh. Eg: |
2350 | ;; A .x script file is the default script. | |
2351 | ;; A .xr script is for linking without relocation (-r flag). Etc. | |
2352 | ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode) | |
5e339ee2 GM |
2353 | ("\\.zone\\'" . dns-mode) |
2354 | ("\\.soa\\'" . dns-mode) | |
ebbcece3 GM |
2355 | ;; Common Lisp ASDF package system. |
2356 | ("\\.asd\\'" . lisp-mode) | |
d5798fa7 SM |
2357 | ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode) |
2358 | ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode) | |
ffc0e1ca | 2359 | ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode) |
e854cc22 | 2360 | ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG |
9a905782 | 2361 | ("\\.[eE]?[pP][sS]\\'" . ps-mode) |
72781fef | 2362 | ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe) |
e55c4863 | 2363 | ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode) |
8a28dd0b | 2364 | ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode) |
ffc0e1ca AS |
2365 | ("BROWSE\\'" . ebrowse-tree-mode) |
2366 | ("\\.ebrowse\\'" . ebrowse-tree-mode) | |
9ee45b2c | 2367 | ("#\\*mail\\*" . mail-mode) |
80174d35 | 2368 | ("\\.g\\'" . antlr-mode) |
56f9dcc9 | 2369 | ("\\.mod\\'" . m2-mode) |
80174d35 | 2370 | ("\\.ses\\'" . ses-mode) |
80174d35 | 2371 | ("\\.docbook\\'" . sgml-mode) |
00daa381 | 2372 | ("\\.com\\'" . dcl-mode) |
80174d35 DP |
2373 | ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode) |
2374 | ;; Windows candidates may be opened case sensitively on Unix | |
2375 | ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode) | |
2376 | ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode) | |
08adf84e | 2377 | ("\\.ppd\\'" . conf-ppd-mode) |
80174d35 DP |
2378 | ("java.+\\.conf\\'" . conf-javaprop-mode) |
2379 | ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode) | |
a35d9075 AS |
2380 | ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode) |
2381 | ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode) | |
40656849 CY |
2382 | ;; ChangeLog.old etc. Other change-log-mode entries are above; |
2383 | ;; this has lower priority to avoid matching changelog.sgml etc. | |
2384 | ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode) | |
80174d35 DP |
2385 | ;; either user's dot-files or under /etc or some such |
2386 | ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode) | |
2387 | ;; alas not all ~/.*rc files are like this | |
b14f1885 | 2388 | ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode) |
80174d35 DP |
2389 | ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode) |
2390 | ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode) | |
2391 | ("/X11.+app-defaults/" . conf-xdefaults-mode) | |
2392 | ("/X11.+locale/.+/Compose\\'" . conf-colon-mode) | |
2393 | ;; this contains everything twice, with space and with colon :-( | |
2394 | ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode) | |
9ee45b2c SM |
2395 | ;; Get rid of any trailing .n.m and try again. |
2396 | ;; This is for files saved by cvs-merge that look like .#<file>.<rev> | |
5c6d31a4 SM |
2397 | ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~. |
2398 | ;; Using mode nil rather than `ignore' would let the search continue | |
2399 | ;; through this list (with the shortened name) rather than start over. | |
bbc67516 | 2400 | ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t) |
5d344e88 CY |
2401 | ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t) |
2402 | ;; This should come after "in" stripping (e.g. config.h.in). | |
2403 | ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config | |
2404 | ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe) | |
5c6d31a4 SM |
2405 | ;; The following should come after the ChangeLog pattern |
2406 | ;; for the sake of ChangeLog.1, etc. | |
2407 | ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too. | |
5d344e88 | 2408 | ("\\.[1-9]\\'" . nroff-mode))) |
ffc0e1ca | 2409 | "Alist of filename patterns vs corresponding major mode functions. |
116987ba RS |
2410 | Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL). |
2411 | \(NON-NIL stands for anything that is not nil; the value does not matter.) | |
2412 | Visiting a file whose name matches REGEXP specifies FUNCTION as the | |
2413 | mode function to use. FUNCTION will be called, unless it is nil. | |
2414 | ||
2415 | If the element has the form (REGEXP FUNCTION NON-NIL), then after | |
2416 | calling FUNCTION (if it's not nil), we delete the suffix that matched | |
969be033 | 2417 | REGEXP and search the list again for another match. |
7b3f3dc2 | 2418 | |
d5040404 EZ |
2419 | The extensions whose FUNCTION is `archive-mode' should also |
2420 | appear in `auto-coding-alist' with `no-conversion' coding system. | |
2421 | ||
969be033 RS |
2422 | See also `interpreter-mode-alist', which detects executable script modes |
2423 | based on the interpreters they specify to run, | |
2424 | and `magic-mode-alist', which determines modes based on file contents.") | |
3029e594 | 2425 | (put 'auto-mode-alist 'risky-local-variable t) |
e13322a0 | 2426 | |
73936494 RS |
2427 | (defun conf-mode-maybe () |
2428 | "Select Conf mode or XML mode according to start of file." | |
2429 | (if (save-excursion | |
2430 | (save-restriction | |
2431 | (widen) | |
2432 | (goto-char (point-min)) | |
2433 | (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE "))) | |
e477ca84 | 2434 | (xml-mode) |
73936494 RS |
2435 | (conf-mode))) |
2436 | ||
d7fa5aa2 | 2437 | (defvar interpreter-mode-alist |
f209c999 MS |
2438 | ;; Note: The entries for the modes defined in cc-mode.el (awk-mode |
2439 | ;; and pike-mode) are added through autoload directives in that | |
2440 | ;; file. That way is discouraged since it spreads out the | |
2441 | ;; definition of the initial value. | |
a7610c52 | 2442 | (mapcar |
e8e4d5c8 SS |
2443 | (lambda (l) |
2444 | (cons (purecopy (car l)) (cdr l))) | |
ffc0e1ca AS |
2445 | '(("perl" . perl-mode) |
2446 | ("perl5" . perl-mode) | |
2447 | ("miniperl" . perl-mode) | |
2448 | ("wish" . tcl-mode) | |
2449 | ("wishx" . tcl-mode) | |
2450 | ("tcl" . tcl-mode) | |
2451 | ("tclsh" . tcl-mode) | |
ffc0e1ca AS |
2452 | ("scm" . scheme-mode) |
2453 | ("ash" . sh-mode) | |
2454 | ("bash" . sh-mode) | |
2455 | ("bash2" . sh-mode) | |
2456 | ("csh" . sh-mode) | |
2457 | ("dtksh" . sh-mode) | |
2458 | ("es" . sh-mode) | |
2459 | ("itcsh" . sh-mode) | |
2460 | ("jsh" . sh-mode) | |
2461 | ("ksh" . sh-mode) | |
2462 | ("oash" . sh-mode) | |
2463 | ("pdksh" . sh-mode) | |
7a6b1aef | 2464 | ("rbash" . sh-mode) |
ffc0e1ca AS |
2465 | ("rc" . sh-mode) |
2466 | ("rpm" . sh-mode) | |
2467 | ("sh" . sh-mode) | |
2468 | ("sh5" . sh-mode) | |
2469 | ("tcsh" . sh-mode) | |
2470 | ("wksh" . sh-mode) | |
2471 | ("wsh" . sh-mode) | |
2472 | ("zsh" . sh-mode) | |
2473 | ("tail" . text-mode) | |
2474 | ("more" . text-mode) | |
2475 | ("less" . text-mode) | |
2476 | ("pg" . text-mode) | |
27a7c83f | 2477 | ("make" . makefile-gmake-mode) ; Debian uses this |
ffc0e1ca | 2478 | ("guile" . scheme-mode) |
04525749 GM |
2479 | ("clisp" . lisp-mode) |
2480 | ("emacs" . emacs-lisp-mode))) | |
c907d156 | 2481 | "Alist mapping interpreter names to major modes. |
969be033 | 2482 | This is used for files whose first lines match `auto-mode-interpreter-regexp'. |
c907d156 | 2483 | Each element looks like (INTERPRETER . MODE). |
9f01a773 RS |
2484 | If INTERPRETER matches the name of the interpreter specified in the first line |
2485 | of a script, mode MODE is enabled. | |
969be033 RS |
2486 | |
2487 | See also `auto-mode-alist'.") | |
c907d156 | 2488 | |
7b447e9b GM |
2489 | (define-obsolete-variable-alias 'inhibit-first-line-modes-regexps |
2490 | 'inhibit-file-local-variables-regexps "24.1") | |
2491 | ||
2492 | ;; TODO really this should be a list of modes (eg tar-mode), not regexps, | |
2493 | ;; because we are duplicating info from auto-mode-alist. | |
2494 | ;; TODO many elements of this list are also in auto-coding-alist. | |
2495 | (defvar inhibit-local-variables-regexps | |
2496 | (mapcar 'purecopy '("\\.tar\\'" "\\.t[bg]z\\'" | |
2497 | "\\.arc\\'" "\\.zip\\'" "\\.lzh\\'" "\\.lha\\'" | |
2498 | "\\.zoo\\'" "\\.[jew]ar\\'" "\\.xpi\\'" "\\.rar\\'" | |
2499 | "\\.7z\\'" | |
2500 | "\\.sx[dmicw]\\'" "\\.odt\\'" | |
2501 | "\\.tiff?\\'" "\\.gif\\'" "\\.png\\'" "\\.jpe?g\\'")) | |
2502 | "List of regexps matching file names in which to ignore local variables. | |
2503 | This includes `-*-' lines as well as trailing \"Local Variables\" sections. | |
2504 | Files matching this list are typically binary file formats. | |
2505 | They may happen to contain sequences that look like local variable | |
2506 | specifications, but are not really, or they may be containers for | |
2507 | member files with their own local variable sections, which are | |
2508 | not appropriate for the containing file. | |
e9df8f87 | 2509 | The function `inhibit-local-variables-p' uses this.") |
7b447e9b GM |
2510 | |
2511 | (define-obsolete-variable-alias 'inhibit-first-line-modes-suffixes | |
2512 | 'inhibit-local-variables-suffixes "24.1") | |
2513 | ||
2514 | (defvar inhibit-local-variables-suffixes nil | |
2515 | "List of regexps matching suffixes to remove from file names. | |
e9df8f87 GM |
2516 | The function `inhibit-local-variables-p' uses this: when checking |
2517 | a file name, it first discards from the end of the name anything that | |
2518 | matches one of these regexps.") | |
2519 | ||
2520 | ;; Can't think of any situation in which you'd want this to be nil... | |
2521 | (defvar inhibit-local-variables-ignore-case t | |
2522 | "Non-nil means `inhibit-local-variables-p' ignores case.") | |
b20ff6d0 | 2523 | |
7b447e9b GM |
2524 | (defun inhibit-local-variables-p () |
2525 | "Return non-nil if file local variables should be ignored. | |
2526 | This checks the file (or buffer) name against `inhibit-local-variables-regexps' | |
e9df8f87 GM |
2527 | and `inhibit-local-variables-suffixes'. If |
2528 | `inhibit-local-variables-ignore-case' is non-nil, this ignores case." | |
7b447e9b GM |
2529 | (let ((temp inhibit-local-variables-regexps) |
2530 | (name (if buffer-file-name | |
2531 | (file-name-sans-versions buffer-file-name) | |
e9df8f87 GM |
2532 | (buffer-name))) |
2533 | (case-fold-search inhibit-local-variables-ignore-case)) | |
7b447e9b GM |
2534 | (while (let ((sufs inhibit-local-variables-suffixes)) |
2535 | (while (and sufs (not (string-match (car sufs) name))) | |
2536 | (setq sufs (cdr sufs))) | |
2537 | sufs) | |
2538 | (setq name (substring name 0 (match-beginning 0)))) | |
2539 | (while (and temp | |
2540 | (not (string-match (car temp) name))) | |
2541 | (setq temp (cdr temp))) | |
2542 | temp)) | |
2543 | ||
ffc0e1ca | 2544 | (defvar auto-mode-interpreter-regexp |
1e8780b1 DN |
2545 | (purecopy "#![ \t]?\\([^ \t\n]*\ |
2546 | /bin/env[ \t]\\)?\\([^ \t\n]+\\)") | |
54005870 | 2547 | "Regexp matching interpreters, for file mode determination. |
ffc0e1ca | 2548 | This regular expression is matched against the first line of a file |
54005870 LT |
2549 | to determine the file's mode in `set-auto-mode'. If it matches, the file |
2550 | is assumed to be interpreted by the interpreter matched by the second group | |
2551 | of the regular expression. The mode is then determined as the mode | |
2552 | associated with that interpreter in `interpreter-mode-alist'.") | |
0720b68b | 2553 | |
1a5bfb0e | 2554 | (defvar magic-mode-alist nil |
c11781de SM |
2555 | "Alist of buffer beginnings vs. corresponding major mode functions. |
2556 | Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION). | |
2557 | After visiting a file, if REGEXP matches the text at the beginning of the | |
2558 | buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will | |
2559 | call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's | |
2560 | major mode. | |
2561 | ||
2562 | If FUNCTION is nil, then it is not called. (That is a way of saying | |
2563 | \"allow `auto-mode-alist' to decide for these files.\")") | |
2564 | (put 'magic-mode-alist 'risky-local-variable t) | |
2565 | ||
2566 | (defvar magic-fallback-mode-alist | |
1e8780b1 | 2567 | (purecopy |
1a5bfb0e | 2568 | `((image-type-auto-detected-p . image-mode) |
e15f58f8 | 2569 | ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip |
1a5bfb0e | 2570 | ;; The < comes before the groups (but the first) to reduce backtracking. |
4ac1d37a | 2571 | ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff. |
efaa82ff | 2572 | ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely. |
32a0479a | 2573 | (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
efaa82ff GM |
2574 | (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
2575 | (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<" | |
32a0479a | 2576 | comment-re "*" |
efaa82ff | 2577 | "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?" |
969be033 RS |
2578 | "[Hh][Tt][Mm][Ll]")) |
2579 | . html-mode) | |
815fde34 | 2580 | ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode) |
4ac1d37a | 2581 | ;; These two must come after html, because they are more general: |
e477ca84 | 2582 | ("<\\?xml " . xml-mode) |
811cab86 | 2583 | (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
e7d313a0 GM |
2584 | (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
2585 | (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE ")) | |
969be033 | 2586 | . sgml-mode) |
12333e2b | 2587 | ("%!PS" . ps-mode) |
1e8780b1 | 2588 | ("# xmcd " . conf-unix-mode))) |
14774875 RS |
2589 | "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'. |
2590 | Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION). | |
2591 | After visiting a file, if REGEXP matches the text at the beginning of the | |
2592 | buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will | |
2593 | call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist' | |
2594 | have not specified a mode for this file. | |
2595 | ||
2596 | If FUNCTION is nil, then it is not called.") | |
92228a10 | 2597 | (put 'magic-fallback-mode-alist 'risky-local-variable t) |
14774875 | 2598 | |
5cce080e | 2599 | (defvar magic-mode-regexp-match-limit 4000 |
14774875 | 2600 | "Upper limit on `magic-mode-alist' regexp matches. |
92228a10 | 2601 | Also applies to `magic-fallback-mode-alist'.") |
5cce080e | 2602 | |
9e6f5419 | 2603 | (defun set-auto-mode (&optional keep-mode-if-same) |
b4da00e9 | 2604 | "Select major mode appropriate for current buffer. |
4ac1d37a | 2605 | |
f3860cea | 2606 | To find the right major mode, this function checks for a -*- mode tag |
e145f188 | 2607 | checks for a `mode:' entry in the Local Variables section of the file, |
c022c4c4 RS |
2608 | checks if it uses an interpreter listed in `interpreter-mode-alist', |
2609 | matches the buffer beginning against `magic-mode-alist', | |
2610 | compares the filename against the entries in `auto-mode-alist', | |
2611 | then matches the buffer beginning against `magic-fallback-mode-alist'. | |
e3998da1 | 2612 | |
7b447e9b GM |
2613 | If `enable-local-variables' is nil, or if the file name matches |
2614 | `inhibit-local-variables-regexps', this function does not check | |
2615 | for any mode: tag anywhere in the file. If `local-enable-local-variables' | |
2616 | is nil, then the only mode: tag that can be relevant is a -*- one. | |
9de9b6a2 | 2617 | |
521cf174 | 2618 | If the optional argument KEEP-MODE-IF-SAME is non-nil, then we |
c022c4c4 RS |
2619 | set the major mode only if that would change it. In other words |
2620 | we don't actually set it to the same mode the buffer already has." | |
b4da00e9 | 2621 | ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*- |
7b447e9b GM |
2622 | (let ((try-locals (not (inhibit-local-variables-p))) |
2623 | end done mode modes) | |
e145f188 | 2624 | ;; Once we drop the deprecated feature where mode: is also allowed to |
f0da764a | 2625 | ;; specify minor-modes (ie, there can be more than one "mode:"), we can |
e145f188 GM |
2626 | ;; remove this section and just let (hack-local-variables t) handle it. |
2627 | ;; Find a -*- mode tag. | |
b4da00e9 RM |
2628 | (save-excursion |
2629 | (goto-char (point-min)) | |
2630 | (skip-chars-forward " \t\n") | |
7b447e9b | 2631 | ;; Note by design local-enable-local-variables does not matter here. |
9fa7bfe5 | 2632 | (and enable-local-variables |
7b447e9b | 2633 | try-locals |
e3f9b9c0 | 2634 | (setq end (set-auto-mode-1)) |
2d2ab9da RS |
2635 | (if (save-excursion (search-forward ":" end t)) |
2636 | ;; Find all specifications for the `mode:' variable | |
2637 | ;; and execute them left to right. | |
2638 | (while (let ((case-fold-search t)) | |
2639 | (or (and (looking-at "mode:") | |
2640 | (goto-char (match-end 0))) | |
2641 | (re-search-forward "[ \t;]mode:" end t))) | |
2642 | (skip-chars-forward " \t") | |
2643 | (let ((beg (point))) | |
9fa7bfe5 RS |
2644 | (if (search-forward ";" end t) |
2645 | (forward-char -1) | |
2646 | (goto-char end)) | |
2647 | (skip-chars-backward " \t") | |
9ee45b2c | 2648 | (push (intern (concat (downcase (buffer-substring beg (point))) "-mode")) |
2d2ab9da RS |
2649 | modes))) |
2650 | ;; Simple -*-MODE-*- case. | |
2651 | (push (intern (concat (downcase (buffer-substring (point) end)) | |
2652 | "-mode")) | |
2653 | modes)))) | |
9e6f5419 DP |
2654 | ;; If we found modes to use, invoke them now, outside the save-excursion. |
2655 | (if modes | |
521cf174 DP |
2656 | (catch 'nop |
2657 | (dolist (mode (nreverse modes)) | |
2658 | (if (not (functionp mode)) | |
2659 | (message "Ignoring unknown mode `%s'" mode) | |
2660 | (setq done t) | |
3467488e | 2661 | (or (set-auto-mode-0 mode keep-mode-if-same) |
df4d0613 | 2662 | ;; continuing would call minor modes again, toggling them off |
ec6328a2 | 2663 | (throw 'nop nil)))))) |
7b447e9b GM |
2664 | ;; hack-local-variables checks local-enable-local-variables etc, but |
2665 | ;; we might as well be explicit here for the sake of clarity. | |
e145f188 GM |
2666 | (and (not done) |
2667 | enable-local-variables | |
7b447e9b GM |
2668 | local-enable-local-variables |
2669 | try-locals | |
e145f188 GM |
2670 | (setq mode (hack-local-variables t)) |
2671 | (not (memq mode modes)) ; already tried and failed | |
2672 | (if (not (functionp mode)) | |
2673 | (message "Ignoring unknown mode `%s'" mode) | |
2674 | (setq done t) | |
2675 | (set-auto-mode-0 mode keep-mode-if-same))) | |
14774875 RS |
2676 | ;; If we didn't, look for an interpreter specified in the first line. |
2677 | ;; As a special case, allow for things like "#!/bin/env perl", which | |
2678 | ;; finds the interpreter anywhere in $PATH. | |
ec6328a2 | 2679 | (unless done |
9e6f5419 DP |
2680 | (setq mode (save-excursion |
2681 | (goto-char (point-min)) | |
2682 | (if (looking-at auto-mode-interpreter-regexp) | |
2683 | (match-string 2) | |
2684 | "")) | |
8350f087 | 2685 | ;; Map interpreter name to a mode, signaling we're done at the |
9e6f5419 DP |
2686 | ;; same time. |
2687 | done (assoc (file-name-nondirectory mode) | |
2688 | interpreter-mode-alist)) | |
811cab86 | 2689 | ;; If we found an interpreter mode to use, invoke it now. |
df4d0613 DP |
2690 | (if done |
2691 | (set-auto-mode-0 (cdr done) keep-mode-if-same))) | |
14774875 | 2692 | ;; Next try matching the buffer beginning against magic-mode-alist. |
df4d0613 | 2693 | (unless done |
4ac1d37a DP |
2694 | (if (setq done (save-excursion |
2695 | (goto-char (point-min)) | |
5cce080e KS |
2696 | (save-restriction |
2697 | (narrow-to-region (point-min) | |
2698 | (min (point-max) | |
2699 | (+ (point-min) magic-mode-regexp-match-limit))) | |
2700 | (assoc-default nil magic-mode-alist | |
06b60517 | 2701 | (lambda (re _dummy) |
10ffa2a1 KS |
2702 | (if (functionp re) |
2703 | (funcall re) | |
2704 | (looking-at re))))))) | |
14774875 RS |
2705 | (set-auto-mode-0 done keep-mode-if-same))) |
2706 | ;; Next compare the filename against the entries in auto-mode-alist. | |
2707 | (unless done | |
2708 | (if buffer-file-name | |
f1fa5062 MA |
2709 | (let ((name buffer-file-name) |
2710 | (remote-id (file-remote-p buffer-file-name))) | |
28dbc92f MA |
2711 | ;; Remove backup-suffixes from file name. |
2712 | (setq name (file-name-sans-versions name)) | |
f1fa5062 MA |
2713 | ;; Remove remote file name identification. |
2714 | (when (and (stringp remote-id) | |
32650100 | 2715 | (string-match (regexp-quote remote-id) name)) |
f1fa5062 | 2716 | (setq name (substring name (match-end 0)))) |
14774875 RS |
2717 | (while name |
2718 | ;; Find first matching alist entry. | |
2719 | (setq mode | |
7c2fb837 | 2720 | (if (memq system-type '(windows-nt cygwin)) |
14774875 RS |
2721 | ;; System is case-insensitive. |
2722 | (let ((case-fold-search t)) | |
2723 | (assoc-default name auto-mode-alist | |
2724 | 'string-match)) | |
2725 | ;; System is case-sensitive. | |
2726 | (or | |
2727 | ;; First match case-sensitively. | |
2728 | (let ((case-fold-search nil)) | |
2729 | (assoc-default name auto-mode-alist | |
2730 | 'string-match)) | |
2731 | ;; Fallback to case-insensitive match. | |
2732 | (and auto-mode-case-fold | |
2733 | (let ((case-fold-search t)) | |
2734 | (assoc-default name auto-mode-alist | |
2735 | 'string-match)))))) | |
2736 | (if (and mode | |
2737 | (consp mode) | |
2738 | (cadr mode)) | |
2739 | (setq mode (car mode) | |
2740 | name (substring name 0 (match-beginning 0))) | |
a9dd5754 | 2741 | (setq name nil)) |
14774875 RS |
2742 | (when mode |
2743 | (set-auto-mode-0 mode keep-mode-if-same) | |
2744 | (setq done t)))))) | |
92228a10 | 2745 | ;; Next try matching the buffer beginning against magic-fallback-mode-alist. |
14774875 RS |
2746 | (unless done |
2747 | (if (setq done (save-excursion | |
2748 | (goto-char (point-min)) | |
2749 | (save-restriction | |
2750 | (narrow-to-region (point-min) | |
2751 | (min (point-max) | |
2752 | (+ (point-min) magic-mode-regexp-match-limit))) | |
92228a10 | 2753 | (assoc-default nil magic-fallback-mode-alist |
06b60517 | 2754 | (lambda (re _dummy) |
14774875 RS |
2755 | (if (functionp re) |
2756 | (funcall re) | |
2757 | (looking-at re))))))) | |
2758 | (set-auto-mode-0 done keep-mode-if-same))))) | |
521cf174 | 2759 | |
521cf174 DP |
2760 | ;; When `keep-mode-if-same' is set, we are working on behalf of |
2761 | ;; set-visited-file-name. In that case, if the major mode specified is the | |
2762 | ;; same one we already have, don't actually reset it. We don't want to lose | |
2763 | ;; minor modes such as Font Lock. | |
3467488e | 2764 | (defun set-auto-mode-0 (mode &optional keep-mode-if-same) |
521cf174 | 2765 | "Apply MODE and return it. |
3467488e KS |
2766 | If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of |
2767 | any aliases and compared to current major mode. If they are the | |
2768 | same, do nothing and return nil." | |
0c7c413c CY |
2769 | (unless (and keep-mode-if-same |
2770 | (eq (indirect-function mode) | |
2771 | (indirect-function major-mode))) | |
2772 | (when mode | |
2773 | (funcall mode) | |
2774 | mode))) | |
b4da00e9 | 2775 | |
248da2f4 RW |
2776 | (defvar file-auto-mode-skip "^\\(#!\\|'\\\\\"\\)" |
2777 | "Regexp of lines to skip when looking for file-local settings. | |
2778 | If the first line matches this regular expression, then the -*-...-*- file- | |
2779 | local settings will be consulted on the second line instead of the first.") | |
2780 | ||
e3f9b9c0 RS |
2781 | (defun set-auto-mode-1 () |
2782 | "Find the -*- spec in the buffer. | |
2783 | Call with point at the place to start searching from. | |
7b447e9b GM |
2784 | If one is found, set point to the beginning and return the position |
2785 | of the end. Otherwise, return nil; may change point. | |
2786 | The variable `inhibit-local-variables-regexps' can cause a -*- spec to | |
2787 | be ignored; but `enable-local-variables' and `local-enable-local-variables' | |
2788 | have no effect." | |
e3f9b9c0 RS |
2789 | (let (beg end) |
2790 | (and | |
2791 | ;; Don't look for -*- if this file name matches any | |
7b447e9b GM |
2792 | ;; of the regexps in inhibit-local-variables-regexps. |
2793 | (not (inhibit-local-variables-p)) | |
f587e30b | 2794 | (search-forward "-*-" (line-end-position |
7b447e9b GM |
2795 | ;; If the file begins with "#!" (exec |
2796 | ;; interpreter magic), look for mode frobs | |
2797 | ;; in the first two lines. You cannot | |
2798 | ;; necessarily put them in the first line | |
2799 | ;; of such a file without screwing up the | |
2800 | ;; interpreter invocation. The same holds | |
2801 | ;; for '\" in man pages (preprocessor | |
dddb4597 | 2802 | ;; magic for the `man' program). |
248da2f4 | 2803 | (and (looking-at file-auto-mode-skip) 2)) t) |
e3f9b9c0 RS |
2804 | (progn |
2805 | (skip-chars-forward " \t") | |
2806 | (setq beg (point)) | |
f587e30b | 2807 | (search-forward "-*-" (line-end-position) t)) |
e3f9b9c0 RS |
2808 | (progn |
2809 | (forward-char -3) | |
2810 | (skip-chars-backward " \t") | |
2811 | (setq end (point)) | |
2812 | (goto-char beg) | |
2813 | end)))) | |
b9e1451a CY |
2814 | \f |
2815 | ;;; Handling file local variables | |
2816 | ||
2817 | (defvar ignored-local-variables | |
2b8ac025 | 2818 | '(ignored-local-variables safe-local-variable-values |
8c8b0185 | 2819 | file-local-variables-alist dir-local-variables-alist) |
b9e1451a | 2820 | "Variables to be ignored in a file's local variable spec.") |
3029e594 | 2821 | (put 'ignored-local-variables 'risky-local-variable t) |
b9e1451a CY |
2822 | |
2823 | (defvar hack-local-variables-hook nil | |
2824 | "Normal hook run after processing a file's local variables specs. | |
2825 | Major modes can use this to examine user-specified local variables | |
2826 | in order to initialize other data structure based on them.") | |
2827 | ||
2828 | (defcustom safe-local-variable-values nil | |
2829 | "List variable-value pairs that are considered safe. | |
2830 | Each element is a cons cell (VAR . VAL), where VAR is a variable | |
2831 | symbol and VAL is a value that is considered safe." | |
3029e594 | 2832 | :risky t |
b9e1451a | 2833 | :group 'find-file |
094eabe4 | 2834 | :type 'alist) |
b9e1451a | 2835 | |
182b3bec | 2836 | (defcustom safe-local-eval-forms |
5582c670 GM |
2837 | ;; This should be here at least as long as Emacs supports write-file-hooks. |
2838 | '((add-hook 'write-file-hooks 'time-stamp) | |
2839 | (add-hook 'write-file-functions 'time-stamp) | |
db148c21 SM |
2840 | (add-hook 'before-save-hook 'time-stamp nil t) |
2841 | (add-hook 'before-save-hook 'delete-trailing-whitespace nil t)) | |
ba83982b | 2842 | "Expressions that are considered safe in an `eval:' local variable. |
b9e1451a CY |
2843 | Add expressions to this list if you want Emacs to evaluate them, when |
2844 | they appear in an `eval' local variable specification, without first | |
2845 | asking you for confirmation." | |
3029e594 | 2846 | :risky t |
b9e1451a | 2847 | :group 'find-file |
5582c670 | 2848 | :version "24.1" ; added write-file-hooks |
b9e1451a CY |
2849 | :type '(repeat sexp)) |
2850 | ||
2851 | ;; Risky local variables: | |
2852 | (mapc (lambda (var) (put var 'risky-local-variable t)) | |
2853 | '(after-load-alist | |
b9e1451a CY |
2854 | buffer-auto-save-file-name |
2855 | buffer-file-name | |
2856 | buffer-file-truename | |
2857 | buffer-undo-list | |
b9e1451a CY |
2858 | debugger |
2859 | default-text-properties | |
b9e1451a CY |
2860 | eval |
2861 | exec-directory | |
2862 | exec-path | |
2863 | file-name-handler-alist | |
b9e1451a CY |
2864 | frame-title-format |
2865 | global-mode-string | |
2866 | header-line-format | |
2867 | icon-title-format | |
b9e1451a | 2868 | inhibit-quit |
b9e1451a CY |
2869 | load-path |
2870 | max-lisp-eval-depth | |
2871 | max-specpdl-size | |
b9e1451a CY |
2872 | minor-mode-map-alist |
2873 | minor-mode-overriding-map-alist | |
b9e1451a | 2874 | mode-line-format |
b9e1451a | 2875 | mode-name |
b9e1451a CY |
2876 | overriding-local-map |
2877 | overriding-terminal-local-map | |
b9e1451a | 2878 | process-environment |
b9e1451a CY |
2879 | standard-input |
2880 | standard-output | |
3029e594 | 2881 | unread-command-events)) |
b9e1451a CY |
2882 | |
2883 | ;; Safe local variables: | |
2884 | ;; | |
3e457225 RS |
2885 | ;; For variables defined by major modes, the safety declarations can go into |
2886 | ;; the major mode's file, since that will be loaded before file variables are | |
2887 | ;; processed. | |
2888 | ;; | |
2889 | ;; For variables defined by minor modes, put the safety declarations in the | |
2890 | ;; file defining the minor mode after the defcustom/defvar using an autoload | |
2891 | ;; cookie, e.g.: | |
2892 | ;; | |
2893 | ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp) | |
2894 | ;; | |
2895 | ;; Otherwise, when Emacs visits a file specifying that local variable, the | |
2896 | ;; minor mode file may not be loaded yet. | |
2897 | ;; | |
2898 | ;; For variables defined in the C source code the declaration should go here: | |
b9e1451a | 2899 | |
b38b1ec0 SM |
2900 | (dolist (pair |
2901 | '((buffer-read-only . booleanp) ;; C source code | |
2902 | (default-directory . stringp) ;; C source code | |
2903 | (fill-column . integerp) ;; C source code | |
2904 | (indent-tabs-mode . booleanp) ;; C source code | |
2905 | (left-margin . integerp) ;; C source code | |
2906 | (no-update-autoloads . booleanp) | |
2907 | (lexical-binding . booleanp) ;; C source code | |
2908 | (tab-width . integerp) ;; C source code | |
2909 | (truncate-lines . booleanp) ;; C source code | |
2910 | (word-wrap . booleanp) ;; C source code | |
2911 | (bidi-display-reordering . booleanp))) ;; C source code | |
2912 | (put (car pair) 'safe-local-variable (cdr pair))) | |
b9e1451a | 2913 | |
cd83d522 EZ |
2914 | (put 'bidi-paragraph-direction 'safe-local-variable |
2915 | (lambda (v) (memq v '(nil right-to-left left-to-right)))) | |
2916 | ||
b9e1451a | 2917 | (put 'c-set-style 'safe-local-eval-function t) |
e3f9b9c0 | 2918 | |
2b8ac025 CY |
2919 | (defvar file-local-variables-alist nil |
2920 | "Alist of file-local variable settings in the current buffer. | |
2921 | Each element in this list has the form (VAR . VALUE), where VAR | |
2922 | is a file-local variable (a symbol) and VALUE is the value | |
2923 | specified. The actual value in the buffer may differ from VALUE, | |
2924 | if it is changed by the major or minor modes, or by the user.") | |
2925 | (make-variable-buffer-local 'file-local-variables-alist) | |
2a8a455e | 2926 | (put 'file-local-variables-alist 'permanent-local t) |
2b8ac025 | 2927 | |
8c8b0185 JL |
2928 | (defvar dir-local-variables-alist nil |
2929 | "Alist of directory-local variable settings in the current buffer. | |
2930 | Each element in this list has the form (VAR . VALUE), where VAR | |
2931 | is a directory-local variable (a symbol) and VALUE is the value | |
2932 | specified in .dir-locals.el. The actual value in the buffer | |
2933 | may differ from VALUE, if it is changed by the major or minor modes, | |
2934 | or by the user.") | |
2935 | (make-variable-buffer-local 'dir-local-variables-alist) | |
2936 | ||
2b8ac025 CY |
2937 | (defvar before-hack-local-variables-hook nil |
2938 | "Normal hook run before setting file-local variables. | |
2939 | It is called after checking for unsafe/risky variables and | |
2940 | setting `file-local-variables-alist', and before applying the | |
2941 | variables stored in `file-local-variables-alist'. A hook | |
2942 | function is allowed to change the contents of this alist. | |
2943 | ||
2944 | This hook is called only if there is at least one file-local | |
2945 | variable to set.") | |
2946 | ||
75fd7f12 | 2947 | (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name) |
70b49e57 RS |
2948 | "Get confirmation before setting up local variable values. |
2949 | ALL-VARS is the list of all variables to be set up. | |
2950 | UNSAFE-VARS is the list of those that aren't marked as safe or risky. | |
1b21ee06 | 2951 | RISKY-VARS is the list of those that are marked as risky. |
07915ed9 GM |
2952 | If these settings come from directory-local variables, then |
2953 | DIR-NAME is the name of the associated directory. Otherwise it is nil." | |
a8b7cd8d CY |
2954 | (unless noninteractive |
2955 | (let ((name (cond (dir-name) | |
2956 | (buffer-file-name | |
2957 | (file-name-nondirectory buffer-file-name)) | |
2958 | ((concat "buffer " (buffer-name))))) | |
2959 | (offer-save (and (eq enable-local-variables t) | |
2960 | unsafe-vars)) | |
2961 | (buf (get-buffer-create "*Local Variables*"))) | |
2962 | ;; Set up the contents of the *Local Variables* buffer. | |
2963 | (with-current-buffer buf | |
3ef01959 CY |
2964 | (erase-buffer) |
2965 | (cond | |
2966 | (unsafe-vars | |
2967 | (insert "The local variables list in " name | |
2968 | "\ncontains values that may not be safe (*)" | |
2969 | (if risky-vars | |
2970 | ", and variables that are risky (**)." | |
2971 | "."))) | |
2972 | (risky-vars | |
2973 | (insert "The local variables list in " name | |
2974 | "\ncontains variables that are risky (**).")) | |
2975 | (t | |
2976 | (insert "A local variables list is specified in " name "."))) | |
2977 | (insert "\n\nDo you want to apply it? You can type | |
5a6c1d87 | 2978 | y -- to apply the local variables list. |
af467e28 | 2979 | n -- to ignore the local variables list.") |
3ef01959 CY |
2980 | (if offer-save |
2981 | (insert " | |
dbcd3ce0 EZ |
2982 | ! -- to apply the local variables list, and permanently mark these |
2983 | values (*) as safe (in the future, they will be set automatically.)\n\n") | |
3ef01959 CY |
2984 | (insert "\n\n")) |
2985 | (dolist (elt all-vars) | |
2986 | (cond ((member elt unsafe-vars) | |
2987 | (insert " * ")) | |
2988 | ((member elt risky-vars) | |
2989 | (insert " ** ")) | |
2990 | (t | |
2991 | (insert " "))) | |
2992 | (princ (car elt) buf) | |
2993 | (insert " : ") | |
2994 | ;; Make strings with embedded whitespace easier to read. | |
2995 | (let ((print-escape-newlines t)) | |
2996 | (prin1 (cdr elt) buf)) | |
2997 | (insert "\n")) | |
a8b7cd8d CY |
2998 | (set (make-local-variable 'cursor-type) nil) |
2999 | (set-buffer-modified-p nil) | |
3000 | (goto-char (point-min))) | |
3001 | ||
3002 | ;; Display the buffer and read a choice. | |
3003 | (save-window-excursion | |
3004 | (pop-to-buffer buf) | |
3005 | (let* ((exit-chars '(?y ?n ?\s ?\C-g ?\C-v)) | |
3006 | (prompt (format "Please type %s%s: " | |
3007 | (if offer-save "y, n, or !" "y or n") | |
3008 | (if (< (line-number-at-pos (point-max)) | |
3009 | (window-body-height)) | |
3010 | "" | |
3011 | (push ?\C-v exit-chars) | |
3012 | ", or C-v to scroll"))) | |
3013 | char) | |
3014 | (if offer-save (push ?! exit-chars)) | |
3015 | (while (null char) | |
3016 | (setq char (read-char-choice prompt exit-chars t)) | |
3017 | (when (eq char ?\C-v) | |
3018 | (condition-case nil | |
3019 | (scroll-up) | |
3020 | (error (goto-char (point-min)) | |
3021 | (recenter 1))) | |
3022 | (setq char nil))) | |
3023 | (when (and offer-save (= char ?!) unsafe-vars) | |
3024 | (customize-push-and-save 'safe-local-variable-values unsafe-vars)) | |
3025 | (prog1 (memq char '(?! ?\s ?y)) | |
3026 | (quit-window t))))))) | |
cc45837e | 3027 | |
a0e74e72 | 3028 | (defun hack-local-variables-prop-line (&optional mode-only) |
5a6c1d87 | 3029 | "Return local variables specified in the -*- line. |
88dfa756 GM |
3030 | Returns an alist of elements (VAR . VAL), where VAR is a variable |
3031 | and VAL is the specified value. Ignores any specification for | |
3032 | `mode:' and `coding:' (which should have already been handled | |
3033 | by `set-auto-mode' and `set-auto-coding', respectively). | |
3aace4e4 | 3034 | Return nil if the -*- line is malformed. |
88dfa756 GM |
3035 | |
3036 | If MODE-ONLY is non-nil, just returns the symbol specifying the | |
3037 | mode, if there is one, otherwise nil." | |
3aace4e4 CY |
3038 | (catch 'malformed-line |
3039 | (save-excursion | |
3040 | (goto-char (point-min)) | |
3041 | (let ((end (set-auto-mode-1)) | |
3042 | result) | |
3043 | (cond ((not end) | |
3044 | nil) | |
3045 | ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)") | |
3046 | ;; Simple form: "-*- MODENAME -*-". | |
3047 | (if mode-only | |
3048 | (intern (concat (match-string 1) "-mode")))) | |
3049 | (t | |
3050 | ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-' | |
3051 | ;; (last ";" is optional). | |
3052 | ;; If MODE-ONLY, just check for `mode'. | |
3053 | ;; Otherwise, parse the -*- line into the RESULT alist. | |
3054 | (while (and (or (not mode-only) | |
3055 | (not result)) | |
3056 | (< (point) end)) | |
3057 | (unless (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*") | |
3058 | (message "Malformed mode-line") | |
3059 | (throw 'malformed-line nil)) | |
3060 | (goto-char (match-end 0)) | |
3061 | ;; There used to be a downcase here, | |
3062 | ;; but the manual didn't say so, | |
3063 | ;; and people want to set var names that aren't all lc. | |
3064 | (let* ((key (intern (match-string 1))) | |
3065 | (val (save-restriction | |
3066 | (narrow-to-region (point) end) | |
3067 | (let ((read-circle nil)) | |
3068 | (read (current-buffer))))) | |
3069 | ;; It is traditional to ignore | |
3070 | ;; case when checking for `mode' in set-auto-mode, | |
3071 | ;; so we must do that here as well. | |
3072 | ;; That is inconsistent, but we're stuck with it. | |
3073 | ;; The same can be said for `coding' in set-auto-coding. | |
3074 | (keyname (downcase (symbol-name key)))) | |
3075 | (if mode-only | |
3076 | (and (equal keyname "mode") | |
3077 | (setq result | |
3078 | (intern (concat (downcase (symbol-name val)) | |
3079 | "-mode")))) | |
3080 | (or (equal keyname "coding") | |
3081 | (condition-case nil | |
3082 | (push (cons (cond ((eq key 'eval) 'eval) | |
3083 | ;; Downcase "Mode:". | |
3084 | ((equal keyname "mode") 'mode) | |
3085 | (t (indirect-variable key))) | |
3086 | val) result) | |
3087 | (error nil)))) | |
3088 | (skip-chars-forward " \t;"))) | |
3089 | result)))))) | |
f3e23606 | 3090 | |
75fd7f12 | 3091 | (defun hack-local-variables-filter (variables dir-name) |
2b8ac025 CY |
3092 | "Filter local variable settings, querying the user if necessary. |
3093 | VARIABLES is the alist of variable-value settings. This alist is | |
3094 | filtered based on the values of `ignored-local-variables', | |
3095 | `enable-local-eval', `enable-local-variables', and (if necessary) | |
3096 | user interaction. The results are added to | |
3097 | `file-local-variables-alist', without applying them. | |
07915ed9 GM |
3098 | If these settings come from directory-local variables, then |
3099 | DIR-NAME is the name of the associated directory. Otherwise it is nil." | |
89bf83cd CY |
3100 | ;; Find those variables that we may want to save to |
3101 | ;; `safe-local-variable-values'. | |
3102 | (let (all-vars risky-vars unsafe-vars) | |
3103 | (dolist (elt variables) | |
3104 | (let ((var (car elt)) | |
3105 | (val (cdr elt))) | |
3106 | (cond ((memq var ignored-local-variables) | |
3107 | ;; Ignore any variable in `ignored-local-variables'. | |
3108 | nil) | |
3109 | ;; Obey `enable-local-eval'. | |
3110 | ((eq var 'eval) | |
3111 | (when enable-local-eval | |
1b15d8ad | 3112 | (let ((safe (or (hack-one-local-variable-eval-safep val) |
f40b9f10 GM |
3113 | ;; In case previously marked safe (bug#5636). |
3114 | (safe-local-variable-p var val)))) | |
3115 | ;; If not safe and e-l-v = :safe, ignore totally. | |
3116 | (when (or safe (not (eq enable-local-variables :safe))) | |
3117 | (push elt all-vars) | |
3118 | (or (eq enable-local-eval t) | |
3119 | safe | |
3120 | (push elt unsafe-vars)))))) | |
cfb54897 JL |
3121 | ;; Ignore duplicates (except `mode') in the present list. |
3122 | ((and (assq var all-vars) (not (eq var 'mode))) nil) | |
89bf83cd CY |
3123 | ;; Accept known-safe variables. |
3124 | ((or (memq var '(mode unibyte coding)) | |
3125 | (safe-local-variable-p var val)) | |
3126 | (push elt all-vars)) | |
3127 | ;; The variable is either risky or unsafe: | |
3128 | ((not (eq enable-local-variables :safe)) | |
3129 | (push elt all-vars) | |
3130 | (if (risky-local-variable-p var val) | |
3131 | (push elt risky-vars) | |
3132 | (push elt unsafe-vars)))))) | |
3133 | (and all-vars | |
3134 | ;; Query, unless all vars are safe or user wants no querying. | |
3135 | (or (and (eq enable-local-variables t) | |
3136 | (null unsafe-vars) | |
3137 | (null risky-vars)) | |
42e0a725 | 3138 | (memq enable-local-variables '(:all :safe)) |
89bf83cd CY |
3139 | (hack-local-variables-confirm all-vars unsafe-vars |
3140 | risky-vars dir-name)) | |
3141 | (dolist (elt all-vars) | |
cfb54897 | 3142 | (unless (memq (car elt) '(eval mode)) |
8c8b0185 JL |
3143 | (unless dir-name |
3144 | (setq dir-local-variables-alist | |
3145 | (assq-delete-all (car elt) dir-local-variables-alist))) | |
89bf83cd CY |
3146 | (setq file-local-variables-alist |
3147 | (assq-delete-all (car elt) file-local-variables-alist))) | |
3148 | (push elt file-local-variables-alist))))) | |
1b21ee06 | 3149 | |
9de9b6a2 RS |
3150 | (defun hack-local-variables (&optional mode-only) |
3151 | "Parse and put into effect this buffer's local variables spec. | |
27b48e63 GM |
3152 | Uses `hack-local-variables-apply' to apply the variables. |
3153 | ||
88dfa756 | 3154 | If MODE-ONLY is non-nil, all we do is check whether a \"mode:\" |
162d78a1 GM |
3155 | is specified, and return the corresponding mode symbol, or nil. |
3156 | In this case, we try to ignore minor-modes, and only return a | |
7b447e9b GM |
3157 | major-mode. |
3158 | ||
3159 | If `enable-local-variables' or `local-enable-local-variables' is nil, | |
3160 | this function does nothing. If `inhibit-local-variables-regexps' | |
3161 | applies to the file in question, the file is not scanned for | |
3162 | local variables, but directory-local variables may still be applied." | |
3163 | ;; We don't let inhibit-local-variables-p influence the value of | |
3164 | ;; enable-local-variables, because then it would affect dir-local | |
3165 | ;; variables. We don't want to search eg tar files for file local | |
3166 | ;; variable sections, but there is no reason dir-locals cannot apply | |
3167 | ;; to them. The real meaning of inhibit-local-variables-p is "do | |
3168 | ;; not scan this file for local variables". | |
5a6c1d87 CY |
3169 | (let ((enable-local-variables |
3170 | (and local-enable-local-variables enable-local-variables)) | |
3171 | result) | |
2b8ac025 CY |
3172 | (unless mode-only |
3173 | (setq file-local-variables-alist nil) | |
75fd7f12 | 3174 | (report-errors "Directory-local variables error: %s" |
7b447e9b | 3175 | ;; Note this is a no-op if enable-local-variables is nil. |
75fd7f12 | 3176 | (hack-dir-local-variables))) |
7b447e9b GM |
3177 | ;; This entire function is basically a no-op if enable-local-variables |
3178 | ;; is nil. All it does is set file-local-variables-alist to nil. | |
3179 | (when enable-local-variables | |
3180 | ;; This part used to ignore enable-local-variables when mode-only | |
3181 | ;; was non-nil. That was inappropriate, eg consider the | |
3182 | ;; (artificial) example of: | |
3183 | ;; (setq local-enable-local-variables nil) | |
3184 | ;; Open a file foo.txt that contains "mode: sh". | |
3185 | ;; It correctly opens in text-mode. | |
3186 | ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode. | |
3187 | (unless (or (inhibit-local-variables-p) | |
3188 | ;; If MODE-ONLY is non-nil, and the prop line specifies a | |
3189 | ;; mode, then we're done, and have no need to scan further. | |
3190 | (and (setq result (hack-local-variables-prop-line mode-only)) | |
3191 | mode-only)) | |
7e4ccca3 GM |
3192 | ;; Look for "Local variables:" line in last page. |
3193 | (save-excursion | |
3194 | (goto-char (point-max)) | |
3195 | (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) | |
3196 | 'move) | |
3197 | (when (let ((case-fold-search t)) | |
3198 | (search-forward "Local Variables:" nil t)) | |
3199 | (skip-chars-forward " \t") | |
3200 | ;; suffix is what comes after "local variables:" in its line. | |
3201 | ;; prefix is what comes before "local variables:" in its line. | |
3202 | (let ((suffix | |
3203 | (concat | |
3204 | (regexp-quote (buffer-substring (point) | |
3205 | (line-end-position))) | |
3206 | "$")) | |
3207 | (prefix | |
3208 | (concat "^" (regexp-quote | |
3209 | (buffer-substring (line-beginning-position) | |
3210 | (match-beginning 0))))) | |
3211 | beg) | |
3212 | ||
3213 | (forward-line 1) | |
3214 | (let ((startpos (point)) | |
3215 | endpos | |
3216 | (thisbuf (current-buffer))) | |
3217 | (save-excursion | |
3218 | (unless (let ((case-fold-search t)) | |
3219 | (re-search-forward | |
3220 | (concat prefix "[ \t]*End:[ \t]*" suffix) | |
3221 | nil t)) | |
3222 | ;; This used to be an error, but really all it means is | |
3223 | ;; that this may simply not be a local-variables section, | |
3224 | ;; so just ignore it. | |
3225 | (message "Local variables list is not properly terminated")) | |
3226 | (beginning-of-line) | |
3227 | (setq endpos (point))) | |
3228 | ||
3229 | (with-temp-buffer | |
3230 | (insert-buffer-substring thisbuf startpos endpos) | |
3231 | (goto-char (point-min)) | |
3232 | (subst-char-in-region (point) (point-max) ?\^m ?\n) | |
3233 | (while (not (eobp)) | |
3234 | ;; Discard the prefix. | |
3235 | (if (looking-at prefix) | |
3236 | (delete-region (point) (match-end 0)) | |
3237 | (error "Local variables entry is missing the prefix")) | |
3238 | (end-of-line) | |
3239 | ;; Discard the suffix. | |
3240 | (if (looking-back suffix) | |
3241 | (delete-region (match-beginning 0) (point)) | |
3242 | (error "Local variables entry is missing the suffix")) | |
3243 | (forward-line 1)) | |
3244 | (goto-char (point-min)) | |
3245 | ||
3246 | (while (and (not (eobp)) | |
3247 | (or (not mode-only) | |
3248 | (not result))) | |
3249 | ;; Find the variable name; strip whitespace. | |
3250 | (skip-chars-forward " \t") | |
3251 | (setq beg (point)) | |
3252 | (skip-chars-forward "^:\n") | |
3253 | (if (eolp) (error "Missing colon in local variables entry")) | |
3254 | (skip-chars-backward " \t") | |
3255 | (let* ((str (buffer-substring beg (point))) | |
3256 | (var (let ((read-circle nil)) | |
3257 | (read str))) | |
162d78a1 | 3258 | val val2) |
8e999f70 GM |
3259 | (and (equal (downcase (symbol-name var)) "mode") |
3260 | (setq var 'mode)) | |
7e4ccca3 GM |
3261 | ;; Read the variable value. |
3262 | (skip-chars-forward "^:") | |
3263 | (forward-char 1) | |
3264 | (let ((read-circle nil)) | |
3265 | (setq val (read (current-buffer)))) | |
3266 | (if mode-only | |
162d78a1 GM |
3267 | (and (eq var 'mode) |
3268 | ;; Specifying minor-modes via mode: is | |
3269 | ;; deprecated, but try to reject them anyway. | |
3270 | (not (string-match | |
3271 | "-minor\\'" | |
98f593b8 | 3272 | (setq val2 (downcase (symbol-name val))))) |
162d78a1 | 3273 | (setq result (intern (concat val2 "-mode")))) |
7e4ccca3 GM |
3274 | (unless (eq var 'coding) |
3275 | (condition-case nil | |
3276 | (push (cons (if (eq var 'eval) | |
3277 | 'eval | |
3278 | (indirect-variable var)) | |
3279 | val) result) | |
3280 | (error nil))))) | |
7b447e9b GM |
3281 | (forward-line 1)))))))) |
3282 | ;; Now we've read all the local variables. | |
3283 | ;; If MODE-ONLY is non-nil, return whether the mode was specified. | |
3284 | (if mode-only result | |
3285 | ;; Otherwise, set the variables. | |
3286 | (hack-local-variables-filter result nil) | |
3287 | (hack-local-variables-apply))))) | |
8117868f DN |
3288 | |
3289 | (defun hack-local-variables-apply () | |
27b48e63 GM |
3290 | "Apply the elements of `file-local-variables-alist'. |
3291 | If there are any elements, runs `before-hack-local-variables-hook', | |
3292 | then calls `hack-one-local-variable' to apply the alist elements one by one. | |
3293 | Finishes by running `hack-local-variables-hook', regardless of whether | |
3294 | the alist is empty or not. | |
3295 | ||
3296 | Note that this function ignores a `mode' entry if it specifies the same | |
3297 | major mode as the buffer already has." | |
8117868f DN |
3298 | (when file-local-variables-alist |
3299 | ;; Any 'evals must run in the Right sequence. | |
3300 | (setq file-local-variables-alist | |
3301 | (nreverse file-local-variables-alist)) | |
3302 | (run-hooks 'before-hack-local-variables-hook) | |
3303 | (dolist (elt file-local-variables-alist) | |
3304 | (hack-one-local-variable (car elt) (cdr elt)))) | |
3305 | (run-hooks 'hack-local-variables-hook)) | |
5a6c1d87 | 3306 | |
5a6c1d87 CY |
3307 | (defun safe-local-variable-p (sym val) |
3308 | "Non-nil if SYM is safe as a file-local variable with value VAL. | |
3309 | It is safe if any of these conditions are met: | |
3310 | ||
3311 | * There is a matching entry (SYM . VAL) in the | |
3312 | `safe-local-variable-values' user option. | |
3313 | ||
5a6c1d87 CY |
3314 | * The `safe-local-variable' property of SYM is a function that |
3315 | evaluates to a non-nil value with VAL as an argument." | |
3316 | (or (member (cons sym val) safe-local-variable-values) | |
3317 | (let ((safep (get sym 'safe-local-variable))) | |
acef0722 SM |
3318 | (and (functionp safep) |
3319 | ;; If the function signals an error, that means it | |
3320 | ;; can't assure us that the value is safe. | |
3321 | (with-demoted-errors (funcall safep val)))))) | |
5a6c1d87 | 3322 | |
06b60517 | 3323 | (defun risky-local-variable-p (sym &optional _ignored) |
5a6c1d87 CY |
3324 | "Non-nil if SYM could be dangerous as a file-local variable. |
3325 | It is dangerous if either of these conditions are met: | |
3326 | ||
3327 | * Its `risky-local-variable' property is non-nil. | |
3328 | ||
3329 | * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\", | |
3330 | \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\", | |
cc5a104d RS |
3331 | \"mode-alist\", \"font-lock-(syntactic-)keyword*\", |
3332 | \"map-alist\", or \"bindat-spec\"." | |
f36d46ca RS |
3333 | ;; If this is an alias, check the base name. |
3334 | (condition-case nil | |
3335 | (setq sym (indirect-variable sym)) | |
3336 | (error nil)) | |
5a6c1d87 CY |
3337 | (or (get sym 'risky-local-variable) |
3338 | (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\ | |
3339 | -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\ | |
3340 | -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\ | |
cc5a104d | 3341 | -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym)))) |
7ed9159a | 3342 | |
d0bd3513 RS |
3343 | (defun hack-one-local-variable-quotep (exp) |
3344 | (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp)))) | |
3345 | ||
ff7affeb RS |
3346 | (defun hack-one-local-variable-constantp (exp) |
3347 | (or (and (not (symbolp exp)) (not (consp exp))) | |
3348 | (memq exp '(t nil)) | |
3349 | (keywordp exp) | |
3350 | (hack-one-local-variable-quotep exp))) | |
3351 | ||
3352 | (defun hack-one-local-variable-eval-safep (exp) | |
3353 | "Return t if it is safe to eval EXP when it is found in a file." | |
8fd9c174 RS |
3354 | (or (not (consp exp)) |
3355 | ;; Detect certain `put' expressions. | |
3356 | (and (eq (car exp) 'put) | |
3357 | (hack-one-local-variable-quotep (nth 1 exp)) | |
3358 | (hack-one-local-variable-quotep (nth 2 exp)) | |
9b3e8086 CY |
3359 | (let ((prop (nth 1 (nth 2 exp))) |
3360 | (val (nth 3 exp))) | |
3361 | (cond ((memq prop '(lisp-indent-hook | |
3362 | lisp-indent-function | |
3363 | scheme-indent-function)) | |
3364 | ;; Only allow safe values (not functions). | |
3365 | (or (numberp val) | |
3366 | (and (hack-one-local-variable-quotep val) | |
3367 | (eq (nth 1 val) 'defun)))) | |
bc5d1dfb EZ |
3368 | ((eq prop 'edebug-form-spec) |
3369 | ;; Only allow indirect form specs. | |
b486a098 SM |
3370 | ;; During bootstrapping, edebug-basic-spec might not be |
3371 | ;; defined yet. | |
3372 | (and (fboundp 'edebug-basic-spec) | |
f215a02f AS |
3373 | (hack-one-local-variable-quotep val) |
3374 | (edebug-basic-spec (nth 1 val))))))) | |
8fd9c174 RS |
3375 | ;; Allow expressions that the user requested. |
3376 | (member exp safe-local-eval-forms) | |
3377 | ;; Certain functions can be allowed with safe arguments | |
3378 | ;; or can specify verification functions to try. | |
3379 | (and (symbolp (car exp)) | |
b8f82dc1 GM |
3380 | ;; Allow (minor)-modes calls with no arguments. |
3381 | ;; This obsoletes the use of "mode:" for such things. (Bug#8613) | |
89bd9ccd | 3382 | (or (and (member (cdr exp) '(nil (1) (0) (-1))) |
b8f82dc1 GM |
3383 | (string-match "-mode\\'" (symbol-name (car exp)))) |
3384 | (let ((prop (get (car exp) 'safe-local-eval-function))) | |
3385 | (cond ((eq prop t) | |
3386 | (let ((ok t)) | |
3387 | (dolist (arg (cdr exp)) | |
3388 | (unless (hack-one-local-variable-constantp arg) | |
3389 | (setq ok nil))) | |
3390 | ok)) | |
3391 | ((functionp prop) | |
3392 | (funcall prop exp)) | |
3393 | ((listp prop) | |
3394 | (let ((ok nil)) | |
3395 | (dolist (function prop) | |
3396 | (if (funcall function exp) | |
3397 | (setq ok t))) | |
3398 | ok)))))))) | |
ff7affeb | 3399 | |
d41706aa SM |
3400 | (defun hack-one-local-variable--obsolete (var) |
3401 | (let ((o (get var 'byte-obsolete-variable))) | |
3402 | (when o | |
3403 | (let ((instead (nth 0 o)) | |
3404 | (since (nth 2 o))) | |
3405 | (message "%s is obsolete%s; %s" | |
3406 | var (if since (format " (since %s)" since)) | |
3407 | (if (stringp instead) instead | |
3408 | (format "use `%s' instead" instead))))))) | |
3409 | ||
f3e23606 | 3410 | (defun hack-one-local-variable (var val) |
0c7c413c CY |
3411 | "Set local variable VAR with value VAL. |
3412 | If VAR is `mode', call `VAL-mode' as a function unless it's | |
3413 | already the major mode." | |
d41706aa SM |
3414 | (pcase var |
3415 | (`mode | |
3416 | (let ((mode (intern (concat (downcase (symbol-name val)) | |
3417 | "-mode")))) | |
3418 | (unless (eq (indirect-function mode) | |
3419 | (indirect-function major-mode)) | |
3420 | (funcall mode)))) | |
3421 | (`eval | |
3422 | (pcase val | |
3423 | (`(add-hook ',hook . ,_) (hack-one-local-variable--obsolete hook))) | |
3424 | (save-excursion (eval val))) | |
3425 | (_ | |
3426 | (hack-one-local-variable--obsolete var) | |
3427 | ;; Make sure the string has no text properties. | |
3428 | ;; Some text properties can get evaluated in various ways, | |
3429 | ;; so it is risky to put them on with a local variable list. | |
3430 | (if (stringp val) | |
3431 | (set-text-properties 0 (length val) nil val)) | |
3432 | (set (make-local-variable var) val)))) | |
1b21ee06 | 3433 | \f |
75fd7f12 | 3434 | ;;; Handling directory-local variables, aka project settings. |
1b21ee06 | 3435 | |
75fd7f12 | 3436 | (defvar dir-locals-class-alist '() |
25760acb CY |
3437 | "Alist mapping directory-local variable classes (symbols) to variable lists.") |
3438 | ||
3439 | (defvar dir-locals-directory-cache '() | |
3440 | "List of cached directory roots for directory-local variable classes. | |
3441 | Each element in this list has the form (DIR CLASS MTIME). | |
3442 | DIR is the name of the directory. | |
3443 | CLASS is the name of a variable class (a symbol). | |
3444 | MTIME is the recorded modification time of the directory-local | |
ebe401f6 | 3445 | variables file associated with this entry. This time is a list |
0c93aa38 | 3446 | of integers (the same format as `file-attributes'), and is |
ebe401f6 GM |
3447 | used to test whether the cache entry is still valid. |
3448 | Alternatively, MTIME can be nil, which means the entry is always | |
3449 | considered valid.") | |
1b21ee06 | 3450 | |
75fd7f12 JL |
3451 | (defsubst dir-locals-get-class-variables (class) |
3452 | "Return the variable list for CLASS." | |
3453 | (cdr (assq class dir-locals-class-alist))) | |
1b21ee06 | 3454 | |
75fd7f12 JL |
3455 | (defun dir-locals-collect-mode-variables (mode-variables variables) |
3456 | "Collect directory-local variables from MODE-VARIABLES. | |
3457 | VARIABLES is the initial list of variables. | |
1b21ee06 | 3458 | Returns the new list." |
75fd7f12 | 3459 | (dolist (pair mode-variables variables) |
1b21ee06 MO |
3460 | (let* ((variable (car pair)) |
3461 | (value (cdr pair)) | |
75fd7f12 | 3462 | (slot (assq variable variables))) |
46253b34 GM |
3463 | ;; If variables are specified more than once, only use the last. (Why?) |
3464 | ;; The pseudo-variables mode and eval are different (bug#3430). | |
3465 | (if (and slot (not (memq variable '(mode eval)))) | |
1b21ee06 MO |
3466 | (setcdr slot value) |
3467 | ;; Need a new cons in case we setcdr later. | |
75fd7f12 | 3468 | (push (cons variable value) variables))))) |
1b21ee06 | 3469 | |
75fd7f12 JL |
3470 | (defun dir-locals-collect-variables (class-variables root variables) |
3471 | "Collect entries from CLASS-VARIABLES into VARIABLES. | |
1b21ee06 | 3472 | ROOT is the root directory of the project. |
75fd7f12 | 3473 | Return the new variables list." |
1b21ee06 MO |
3474 | (let* ((file-name (buffer-file-name)) |
3475 | (sub-file-name (if file-name | |
33cf0fb2 | 3476 | ;; FIXME: Why not use file-relative-name? |
1b21ee06 | 3477 | (substring file-name (length root))))) |
33cf0fb2 SM |
3478 | (condition-case err |
3479 | (dolist (entry class-variables variables) | |
3480 | (let ((key (car entry))) | |
3481 | (cond | |
3482 | ((stringp key) | |
3483 | ;; Don't include this in the previous condition, because we | |
3484 | ;; want to filter all strings before the next condition. | |
3485 | (when (and sub-file-name | |
3486 | (>= (length sub-file-name) (length key)) | |
3487 | (string-prefix-p key sub-file-name)) | |
3488 | (setq variables (dir-locals-collect-variables | |
3489 | (cdr entry) root variables)))) | |
3490 | ((or (not key) | |
3491 | (derived-mode-p key)) | |
6640b281 GM |
3492 | (let* ((alist (cdr entry)) |
3493 | (subdirs (assq 'subdirs alist))) | |
3494 | (if (or (not subdirs) | |
3495 | (progn | |
3496 | (setq alist (delq subdirs alist)) | |
3497 | (cdr-safe subdirs)) | |
0e0b2989 | 3498 | ;; TODO someone might want to extend this to allow |
6640b281 GM |
3499 | ;; integer values for subdir, where N means |
3500 | ;; variables apply to this directory and N levels | |
3501 | ;; below it (0 == nil). | |
3502 | (equal root default-directory)) | |
3503 | (setq variables (dir-locals-collect-mode-variables | |
3504 | alist variables)))))))) | |
33cf0fb2 SM |
3505 | (error |
3506 | ;; The file's content might be invalid (e.g. have a merge conflict), but | |
3507 | ;; that shouldn't prevent the user from opening the file. | |
3508 | (message ".dir-locals error: %s" (error-message-string err)) | |
3509 | nil)))) | |
1b21ee06 | 3510 | |
c1a70892 | 3511 | (defun dir-locals-set-directory-class (directory class &optional mtime) |
75fd7f12 | 3512 | "Declare that the DIRECTORY root is an instance of CLASS. |
1b21ee06 MO |
3513 | DIRECTORY is the name of a directory, a string. |
3514 | CLASS is the name of a project class, a symbol. | |
25760acb | 3515 | MTIME is either the modification time of the directory-local |
cf66a343 | 3516 | variables file that defined this class, or nil. |
1b21ee06 MO |
3517 | |
3518 | When a file beneath DIRECTORY is visited, the mode-specific | |
25760acb | 3519 | variables from CLASS are applied to the buffer. The variables |
75fd7f12 | 3520 | for a class are defined using `dir-locals-set-class-variables'." |
1b21ee06 | 3521 | (setq directory (file-name-as-directory (expand-file-name directory))) |
75fd7f12 JL |
3522 | (unless (assq class dir-locals-class-alist) |
3523 | (error "No such class `%s'" (symbol-name class))) | |
25760acb | 3524 | (push (list directory class mtime) dir-locals-directory-cache)) |
75fd7f12 JL |
3525 | |
3526 | (defun dir-locals-set-class-variables (class variables) | |
3527 | "Map the type CLASS to a list of variable settings. | |
3528 | CLASS is the project class, a symbol. VARIABLES is a list | |
3529 | that declares directory-local variables for the class. | |
3530 | An element in VARIABLES is either of the form: | |
1b21ee06 MO |
3531 | (MAJOR-MODE . ALIST) |
3532 | or | |
3533 | (DIRECTORY . LIST) | |
3534 | ||
3535 | In the first form, MAJOR-MODE is a symbol, and ALIST is an alist | |
3536 | whose elements are of the form (VARIABLE . VALUE). | |
3537 | ||
3538 | In the second form, DIRECTORY is a directory name (a string), and | |
3539 | LIST is a list of the form accepted by the function. | |
3540 | ||
3541 | When a file is visited, the file's class is found. A directory | |
75fd7f12 JL |
3542 | may be assigned a class using `dir-locals-set-directory-class'. |
3543 | Then variables are set in the file's buffer according to the | |
4a427f58 | 3544 | VARIABLES list of the class. The list is processed in order. |
1b21ee06 MO |
3545 | |
3546 | * If the element is of the form (MAJOR-MODE . ALIST), and the | |
3547 | buffer's major mode is derived from MAJOR-MODE (as determined | |
75fd7f12 | 3548 | by `derived-mode-p'), then all the variables in ALIST are |
1b21ee06 MO |
3549 | applied. A MAJOR-MODE of nil may be used to match any buffer. |
3550 | `make-local-variable' is called for each variable before it is | |
3551 | set. | |
3552 | ||
3553 | * If the element is of the form (DIRECTORY . LIST), and DIRECTORY | |
3554 | is an initial substring of the file's directory, then LIST is | |
3555 | applied by recursively following these rules." | |
75fd7f12 | 3556 | (let ((elt (assq class dir-locals-class-alist))) |
1b21ee06 | 3557 | (if elt |
75fd7f12 JL |
3558 | (setcdr elt variables) |
3559 | (push (cons class variables) dir-locals-class-alist)))) | |
1b21ee06 | 3560 | |
75fd7f12 JL |
3561 | (defconst dir-locals-file ".dir-locals.el" |
3562 | "File that contains directory-local variables. | |
3563 | It has to be constant to enforce uniform values | |
3564 | across different environments and users.") | |
3565 | ||
3566 | (defun dir-locals-find-file (file) | |
25760acb CY |
3567 | "Find the directory-local variables for FILE. |
3568 | This searches upward in the directory tree from FILE. | |
ebe401f6 | 3569 | It stops at the first directory that has been registered in |
9a40b8d4 | 3570 | `dir-locals-directory-cache' or contains a `dir-locals-file'. |
ebe401f6 GM |
3571 | If it finds an entry in the cache, it checks that it is valid. |
3572 | A cache entry with no modification time element (normally, one that | |
3573 | has been assigned directly using `dir-locals-set-directory-class', not | |
3574 | set from a file) is always valid. | |
3575 | A cache entry based on a `dir-locals-file' is valid if the modification | |
3576 | time stored in the cache matches the current file modification time. | |
3577 | If not, the cache entry is cleared so that the file will be re-read. | |
3578 | ||
3579 | This function returns either nil (no directory local variables found), | |
3580 | or the matching entry from `dir-locals-directory-cache' (a list), | |
3581 | or the full path to the `dir-locals-file' (a string) in the case | |
3582 | of no valid cache entry." | |
35f0d8ce | 3583 | (setq file (expand-file-name file)) |
8245c361 EZ |
3584 | (let* ((dir-locals-file-name |
3585 | (if (eq system-type 'ms-dos) | |
3586 | (dosified-file-name dir-locals-file) | |
3587 | dir-locals-file)) | |
9a40b8d4 | 3588 | (locals-file (locate-dominating-file file dir-locals-file-name)) |
8245c361 | 3589 | (dir-elt nil)) |
35f0d8ce | 3590 | ;; `locate-dominating-file' may have abbreviated the name. |
9a40b8d4 | 3591 | (and locals-file |
f7fd3d79 GM |
3592 | (setq locals-file (expand-file-name dir-locals-file-name locals-file))) |
3593 | ;; Let dir-locals-read-from-file inform us via demoted-errors | |
3594 | ;; about unreadable files, etc. | |
3595 | ;; Maybe we'd want to keep searching though - that is | |
3596 | ;; a locate-dominating-file issue. | |
3597 | ;;; (or (not (file-readable-p locals-file)) | |
3598 | ;;; (not (file-regular-p locals-file))) | |
3599 | ;;; (setq locals-file nil)) | |
25760acb CY |
3600 | ;; Find the best cached value in `dir-locals-directory-cache'. |
3601 | (dolist (elt dir-locals-directory-cache) | |
75fd7f12 | 3602 | (when (and (eq t (compare-strings file nil (length (car elt)) |
8245c361 EZ |
3603 | (car elt) nil nil |
3604 | (memq system-type | |
3605 | '(windows-nt cygwin ms-dos)))) | |
75fd7f12 JL |
3606 | (> (length (car elt)) (length (car dir-elt)))) |
3607 | (setq dir-elt elt))) | |
ebe401f6 GM |
3608 | (if (and dir-elt |
3609 | (or (null locals-file) | |
3610 | (<= (length (file-name-directory locals-file)) | |
3611 | (length (car dir-elt))))) | |
3612 | ;; Found a potential cache entry. Check validity. | |
3613 | ;; A cache entry with no MTIME is assumed to always be valid | |
3614 | ;; (ie, set directly, not from a dir-locals file). | |
3615 | ;; Note, we don't bother to check that there is a matching class | |
3616 | ;; element in dir-locals-class-alist, since that's done by | |
3617 | ;; dir-locals-set-directory-class. | |
3618 | (if (or (null (nth 2 dir-elt)) | |
3619 | (let ((cached-file (expand-file-name dir-locals-file-name | |
3620 | (car dir-elt)))) | |
3621 | (and (file-readable-p cached-file) | |
25760acb | 3622 | (equal (nth 2 dir-elt) |
ebe401f6 GM |
3623 | (nth 5 (file-attributes cached-file)))))) |
3624 | ;; This cache entry is OK. | |
3625 | dir-elt | |
3626 | ;; This cache entry is invalid; clear it. | |
3627 | (setq dir-locals-directory-cache | |
3628 | (delq dir-elt dir-locals-directory-cache)) | |
3629 | ;; Return the first existing dir-locals file. Might be the same | |
3630 | ;; as dir-elt's, might not (eg latter might have been deleted). | |
3631 | locals-file) | |
3632 | ;; No cache entry. | |
3633 | locals-file))) | |
75fd7f12 JL |
3634 | |
3635 | (defun dir-locals-read-from-file (file) | |
3636 | "Load a variables FILE and register a new class and instance. | |
3637 | FILE is the name of the file holding the variables to apply. | |
3638 | The new class name is the same as the directory in which FILE | |
1b21ee06 MO |
3639 | is found. Returns the new class name." |
3640 | (with-temp-buffer | |
fd075e7b GM |
3641 | ;; This is with-demoted-errors, but we want to mention dir-locals |
3642 | ;; in any error message. | |
188d2701 | 3643 | (let (err) |
fd075e7b GM |
3644 | (condition-case err |
3645 | (progn | |
3646 | (insert-file-contents file) | |
ff3d86d0 LL |
3647 | (unless (zerop (buffer-size)) |
3648 | (let* ((dir-name (file-name-directory file)) | |
3649 | (class-name (intern dir-name)) | |
3650 | (variables (let ((read-circle nil)) | |
3651 | (read (current-buffer))))) | |
3652 | (dir-locals-set-class-variables class-name variables) | |
3653 | (dir-locals-set-directory-class dir-name class-name | |
3654 | (nth 5 (file-attributes file))) | |
3655 | class-name))) | |
fd075e7b | 3656 | (error (message "Error reading dir-locals: %S" err) nil))))) |
1b21ee06 | 3657 | |
dfb308ba MA |
3658 | (defcustom enable-remote-dir-locals nil |
3659 | "Non-nil means dir-local variables will be applied to remote files." | |
2a1e2476 | 3660 | :version "24.3" |
dfb308ba MA |
3661 | :type 'boolean |
3662 | :group 'find-file) | |
3663 | ||
75fd7f12 JL |
3664 | (defun hack-dir-local-variables () |
3665 | "Read per-directory local variables for the current buffer. | |
8c8b0185 | 3666 | Store the directory-local variables in `dir-local-variables-alist' |
97a1cd9d GM |
3667 | and `file-local-variables-alist', without applying them. |
3668 | ||
3669 | This does nothing if either `enable-local-variables' or | |
3670 | `enable-dir-local-variables' are nil." | |
2b8ac025 | 3671 | (when (and enable-local-variables |
97a1cd9d | 3672 | enable-dir-local-variables |
dfb308ba MA |
3673 | (or enable-remote-dir-locals |
3674 | (not (file-remote-p (or (buffer-file-name) | |
3675 | default-directory))))) | |
75fd7f12 | 3676 | ;; Find the variables file. |
0d42eb3e SM |
3677 | (let ((variables-file (dir-locals-find-file |
3678 | (or (buffer-file-name) default-directory))) | |
1b21ee06 | 3679 | (class nil) |
75fd7f12 | 3680 | (dir-name nil)) |
1b21ee06 | 3681 | (cond |
75fd7f12 | 3682 | ((stringp variables-file) |
07915ed9 GM |
3683 | (setq dir-name (file-name-directory variables-file) |
3684 | class (dir-locals-read-from-file variables-file))) | |
75fd7f12 | 3685 | ((consp variables-file) |
25760acb CY |
3686 | (setq dir-name (nth 0 variables-file)) |
3687 | (setq class (nth 1 variables-file)))) | |
1b21ee06 | 3688 | (when class |
75fd7f12 JL |
3689 | (let ((variables |
3690 | (dir-locals-collect-variables | |
3691 | (dir-locals-get-class-variables class) dir-name nil))) | |
3692 | (when variables | |
8c8b0185 | 3693 | (dolist (elt variables) |
824eefe4 GM |
3694 | (if (eq (car elt) 'coding) |
3695 | (display-warning :warning | |
3696 | "Coding cannot be specified by dir-locals") | |
3697 | (unless (memq (car elt) '(eval mode)) | |
3698 | (setq dir-local-variables-alist | |
3699 | (assq-delete-all (car elt) dir-local-variables-alist))) | |
3700 | (push elt dir-local-variables-alist))) | |
75fd7f12 | 3701 | (hack-local-variables-filter variables dir-name))))))) |
f3e23606 | 3702 | |
8117868f | 3703 | (defun hack-dir-local-variables-non-file-buffer () |
89bd9ccd CY |
3704 | "Apply directory-local variables to a non-file buffer. |
3705 | For non-file buffers, such as Dired buffers, directory-local | |
3706 | variables are looked for in `default-directory' and its parent | |
3707 | directories." | |
8117868f DN |
3708 | (hack-dir-local-variables) |
3709 | (hack-local-variables-apply)) | |
3710 | ||
b4da00e9 | 3711 | \f |
21540597 | 3712 | (defcustom change-major-mode-with-file-name t |
ba83982b | 3713 | "Non-nil means \\[write-file] should set the major mode from the file name. |
9de9b6a2 RS |
3714 | However, the mode will not be changed if |
3715 | \(1) a local variables list or the `-*-' line specifies a major mode, or | |
3716 | \(2) the current major mode is a \"special\" mode, | |
96e777e1 | 3717 | \ not suitable for ordinary files, or |
21540597 RS |
3718 | \(3) the new file name does not particularly specify any mode." |
3719 | :type 'boolean | |
3720 | :group 'editing-basics) | |
9de9b6a2 | 3721 | |
f36012a6 | 3722 | (defun set-visited-file-name (filename &optional no-query along-with-file) |
b4da00e9 | 3723 | "Change name of file visited in current buffer to FILENAME. |
1af57101 | 3724 | This also renames the buffer to correspond to the new file. |
b4da00e9 | 3725 | The next time the buffer is saved it will go in the newly specified file. |
1af57101 | 3726 | FILENAME nil or an empty string means mark buffer as not visiting any file. |
b4da00e9 | 3727 | Remember to delete the initial contents of the minibuffer |
6a6b62f8 RS |
3728 | if you wish to pass an empty string as the argument. |
3729 | ||
3730 | The optional second argument NO-QUERY, if non-nil, inhibits asking for | |
f36012a6 RS |
3731 | confirmation in the case where another buffer is already visiting FILENAME. |
3732 | ||
3733 | The optional third argument ALONG-WITH-FILE, if non-nil, means that | |
3734 | the old visited file has been renamed to the new name FILENAME." | |
b4da00e9 | 3735 | (interactive "FSet visited file name: ") |
c11a94fe RS |
3736 | (if (buffer-base-buffer) |
3737 | (error "An indirect buffer cannot visit a file")) | |
7b447e9b | 3738 | (let (truename old-try-locals) |
a522e5bf RS |
3739 | (if filename |
3740 | (setq filename | |
3741 | (if (string-equal filename "") | |
3742 | nil | |
3743 | (expand-file-name filename)))) | |
3744 | (if filename | |
3745 | (progn | |
3746 | (setq truename (file-truename filename)) | |
3747 | (if find-file-visit-truename | |
a522e5bf | 3748 | (setq filename truename)))) |
cbca0a4b | 3749 | (if filename |
e6d0b67a | 3750 | (let ((new-name (file-name-nondirectory filename))) |
cbca0a4b RS |
3751 | (if (string= new-name "") |
3752 | (error "Empty file name")))) | |
11e314fa | 3753 | (let ((buffer (and filename (find-buffer-visiting filename)))) |
7b89d38e | 3754 | (and buffer (not (eq buffer (current-buffer))) |
6a6b62f8 | 3755 | (not no-query) |
9aea757b CY |
3756 | (not (y-or-n-p (format "A buffer is visiting %s; proceed? " |
3757 | filename))) | |
7b89d38e | 3758 | (error "Aborted"))) |
a522e5bf RS |
3759 | (or (equal filename buffer-file-name) |
3760 | (progn | |
3761 | (and filename (lock-buffer filename)) | |
3762 | (unlock-buffer))) | |
7b447e9b GM |
3763 | (setq old-try-locals (not (inhibit-local-variables-p)) |
3764 | buffer-file-name filename) | |
a522e5bf RS |
3765 | (if filename ; make buffer name reflect filename. |
3766 | (let ((new-name (file-name-nondirectory buffer-file-name))) | |
a522e5bf | 3767 | (setq default-directory (file-name-directory buffer-file-name)) |
67b6fd1c SM |
3768 | ;; If new-name == old-name, renaming would add a spurious <2> |
3769 | ;; and it's considered as a feature in rename-buffer. | |
a522e5bf RS |
3770 | (or (string= new-name (buffer-name)) |
3771 | (rename-buffer new-name t)))) | |
3772 | (setq buffer-backed-up nil) | |
f36012a6 RS |
3773 | (or along-with-file |
3774 | (clear-visited-file-modtime)) | |
8ccdc29e | 3775 | ;; Abbreviate the file names of the buffer. |
4826e97f | 3776 | (if truename |
8ccdc29e RS |
3777 | (progn |
3778 | (setq buffer-file-truename (abbreviate-file-name truename)) | |
3779 | (if find-file-visit-truename | |
b1f1ceb8 | 3780 | (setq buffer-file-name truename)))) |
a522e5bf RS |
3781 | (setq buffer-file-number |
3782 | (if filename | |
2a47b4f5 | 3783 | (nthcdr 10 (file-attributes buffer-file-name)) |
7b447e9b GM |
3784 | nil)) |
3785 | ;; write-file-functions is normally used for things like ftp-find-file | |
3786 | ;; that visit things that are not local files as if they were files. | |
3787 | ;; Changing to visit an ordinary local file instead should flush the hook. | |
3788 | (kill-local-variable 'write-file-functions) | |
3789 | (kill-local-variable 'local-write-file-hooks) | |
3790 | (kill-local-variable 'revert-buffer-function) | |
3791 | (kill-local-variable 'backup-inhibited) | |
3792 | ;; If buffer was read-only because of version control, | |
3793 | ;; that reason is gone now, so make it writable. | |
3794 | (if vc-mode | |
3795 | (setq buffer-read-only nil)) | |
3796 | (kill-local-variable 'vc-mode) | |
3797 | ;; Turn off backup files for certain file names. | |
3798 | ;; Since this is a permanent local, the major mode won't eliminate it. | |
3799 | (and buffer-file-name | |
3800 | backup-enable-predicate | |
3801 | (not (funcall backup-enable-predicate buffer-file-name)) | |
3802 | (progn | |
3803 | (make-local-variable 'backup-inhibited) | |
3804 | (setq backup-inhibited t))) | |
3805 | (let ((oauto buffer-auto-save-file-name)) | |
3806 | ;; If auto-save was not already on, turn it on if appropriate. | |
3807 | (if (not buffer-auto-save-file-name) | |
3808 | (and buffer-file-name auto-save-default | |
3809 | (auto-save-mode t)) | |
3810 | ;; If auto save is on, start using a new name. | |
3811 | ;; We deliberately don't rename or delete the old auto save | |
3812 | ;; for the old visited file name. This is because perhaps | |
3813 | ;; the user wants to save the new state and then compare with the | |
3814 | ;; previous state from the auto save file. | |
3815 | (setq buffer-auto-save-file-name | |
3816 | (make-auto-save-file-name))) | |
3817 | ;; Rename the old auto save file if any. | |
3818 | (and oauto buffer-auto-save-file-name | |
3819 | (file-exists-p oauto) | |
3820 | (rename-file oauto buffer-auto-save-file-name t))) | |
3821 | (and buffer-file-name | |
3822 | (not along-with-file) | |
3823 | (set-buffer-modified-p t)) | |
3824 | ;; Update the major mode, if the file name determines it. | |
3825 | (condition-case nil | |
3826 | ;; Don't change the mode if it is special. | |
3827 | (or (not change-major-mode-with-file-name) | |
3828 | (get major-mode 'mode-class) | |
3829 | ;; Don't change the mode if the local variable list specifies it. | |
3830 | ;; The file name can influence whether the local variables apply. | |
3831 | (and old-try-locals | |
b13f806e | 3832 | ;; h-l-v also checks it, but might as well be explicit. |
7b447e9b GM |
3833 | (not (inhibit-local-variables-p)) |
3834 | (hack-local-variables t)) | |
3835 | ;; TODO consider making normal-mode handle this case. | |
3836 | (let ((old major-mode)) | |
3837 | (set-auto-mode t) | |
3838 | (or (eq old major-mode) | |
3839 | (hack-local-variables)))) | |
3840 | (error nil)))) | |
b4da00e9 | 3841 | |
912192d1 | 3842 | (defun write-file (filename &optional confirm) |
b4da00e9 | 3843 | "Write current buffer into file FILENAME. |
7f99999a | 3844 | This makes the buffer visit that file, and marks it as not modified. |
7458cc35 | 3845 | |
7f99999a KH |
3846 | If you specify just a directory name as FILENAME, that means to use |
3847 | the default file name but in that directory. You can also yank | |
074eb6ac | 3848 | the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element]. |
7f99999a KH |
3849 | |
3850 | If the buffer is not already visiting a file, the default file name | |
3851 | for the output file is the buffer name. | |
3852 | ||
3853 | If optional second arg CONFIRM is non-nil, this function | |
3854 | asks for confirmation before overwriting an existing file. | |
912192d1 | 3855 | Interactively, confirmation is required unless you supply a prefix argument." |
b4da00e9 RM |
3856 | ;; (interactive "FWrite file: ") |
3857 | (interactive | |
3858 | (list (if buffer-file-name | |
3859 | (read-file-name "Write file: " | |
f3684505 | 3860 | nil nil nil nil) |
7f99999a KH |
3861 | (read-file-name "Write file: " default-directory |
3862 | (expand-file-name | |
3863 | (file-name-nondirectory (buffer-name)) | |
3864 | default-directory) | |
3865 | nil nil)) | |
912192d1 | 3866 | (not current-prefix-arg))) |
b4da00e9 | 3867 | (or (null filename) (string-equal filename "") |
41f48cb1 RS |
3868 | (progn |
3869 | ;; If arg is just a directory, | |
7f99999a KH |
3870 | ;; use the default file name, but in that directory. |
3871 | (if (file-directory-p filename) | |
41f48cb1 | 3872 | (setq filename (concat (file-name-as-directory filename) |
7f99999a KH |
3873 | (file-name-nondirectory |
3874 | (or buffer-file-name (buffer-name)))))) | |
c2fb8488 RS |
3875 | (and confirm |
3876 | (file-exists-p filename) | |
9aea757b | 3877 | (or (y-or-n-p (format "File `%s' exists; overwrite? " filename)) |
c2fb8488 | 3878 | (error "Canceled"))) |
5f65549e | 3879 | (set-visited-file-name filename (not confirm)))) |
b4da00e9 | 3880 | (set-buffer-modified-p t) |
6492b55d KH |
3881 | ;; Make buffer writable if file is writable. |
3882 | (and buffer-file-name | |
3883 | (file-writable-p buffer-file-name) | |
3884 | (setq buffer-read-only nil)) | |
8e5c7b90 SM |
3885 | (save-buffer) |
3886 | ;; It's likely that the VC status at the new location is different from | |
3887 | ;; the one at the old location. | |
3888 | (vc-find-file-hook)) | |
b4da00e9 | 3889 | \f |
7c3d167f RF |
3890 | (defun file-extended-attributes (filename) |
3891 | "Return an alist of extended attributes of file FILENAME. | |
3892 | ||
3893 | Extended attributes are platform-specific metadata about the file, | |
3894 | such as SELinux context, list of ACL entries, etc." | |
3895 | `((acl . ,(file-acl filename)) | |
3896 | (selinux-context . ,(file-selinux-context filename)))) | |
3897 | ||
3898 | (defun set-file-extended-attributes (filename attributes) | |
3899 | "Set extended attributes of file FILENAME to ATTRIBUTES. | |
3900 | ||
3901 | ATTRIBUTES must be an alist of file attributes as returned by | |
3902 | `file-extended-attributes'." | |
3903 | (dolist (elt attributes) | |
3904 | (let ((attr (car elt)) | |
3905 | (val (cdr elt))) | |
3906 | (cond ((eq attr 'acl) | |
3907 | (set-file-acl filename val)) | |
3908 | ((eq attr 'selinux-context) | |
3909 | (set-file-selinux-context filename val)))))) | |
3910 | \f | |
b4da00e9 RM |
3911 | (defun backup-buffer () |
3912 | "Make a backup of the disk file visited by the current buffer, if appropriate. | |
3913 | This is normally done before saving the buffer the first time. | |
27ab6944 KH |
3914 | |
3915 | A backup may be done by renaming or by copying; see documentation of | |
3916 | variable `make-backup-files'. If it's done by renaming, then the file is | |
f3f9e207 RS |
3917 | no longer accessible under its old name. |
3918 | ||
3919 | The value is non-nil after a backup was made by renaming. | |
7c3d167f | 3920 | It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME). |
f3f9e207 RS |
3921 | MODES is the result of `file-modes' on the original |
3922 | file; this means that the caller, after saving the buffer, should change | |
3923 | the modes of the new file to agree with the old modes. | |
7c3d167f RF |
3924 | EXTENDED-ATTRIBUTES is the result of `file-extended-attributes' |
3925 | on the original file; this means that the caller, after saving | |
3926 | the buffer, should change the extended attributes of the new file | |
3927 | to agree with the old attributes. | |
f3f9e207 | 3928 | BACKUPNAME is the backup file name, which is the old file renamed." |
b4da00e9 RM |
3929 | (if (and make-backup-files (not backup-inhibited) |
3930 | (not buffer-backed-up) | |
3931 | (file-exists-p buffer-file-name) | |
3932 | (memq (aref (elt (file-attributes buffer-file-name) 8) 0) | |
3933 | '(?- ?l))) | |
3934 | (let ((real-file-name buffer-file-name) | |
3935 | backup-info backupname targets setmodes) | |
3936 | ;; If specified name is a symbolic link, chase it to the target. | |
3937 | ;; Thus we make the backups in the directory where the real file is. | |
5dadeb29 | 3938 | (setq real-file-name (file-chase-links real-file-name)) |
b4da00e9 RM |
3939 | (setq backup-info (find-backup-file-name real-file-name) |
3940 | backupname (car backup-info) | |
3941 | targets (cdr backup-info)) | |
5c6d31a4 SM |
3942 | ;; (if (file-directory-p buffer-file-name) |
3943 | ;; (error "Cannot save buffer in directory %s" buffer-file-name)) | |
eb650569 RS |
3944 | (if backup-info |
3945 | (condition-case () | |
3946 | (let ((delete-old-versions | |
3947 | ;; If have old versions to maybe delete, | |
3948 | ;; ask the user to confirm now, before doing anything. | |
3949 | ;; But don't actually delete til later. | |
3950 | (and targets | |
3951 | (or (eq delete-old-versions t) (eq delete-old-versions nil)) | |
3952 | (or delete-old-versions | |
9aea757b CY |
3953 | (y-or-n-p (format "Delete excess backup versions of %s? " |
3954 | real-file-name))))) | |
574c05e2 | 3955 | (modes (file-modes buffer-file-name)) |
7c3d167f RF |
3956 | (extended-attributes |
3957 | (file-extended-attributes buffer-file-name))) | |
eb650569 RS |
3958 | ;; Actually write the back up file. |
3959 | (condition-case () | |
3960 | (if (or file-precious-flag | |
ffc0e1ca | 3961 | ; (file-symlink-p buffer-file-name) |
eb650569 | 3962 | backup-by-copying |
446c63b0 | 3963 | ;; Don't rename a suid or sgid file. |
7da6bf00 | 3964 | (and modes (< 0 (logand modes #o6000))) |
79d2d279 | 3965 | (not (file-writable-p (file-name-directory real-file-name))) |
eb650569 RS |
3966 | (and backup-by-copying-when-linked |
3967 | (> (file-nlinks real-file-name) 1)) | |
ffc0e1ca AS |
3968 | (and (or backup-by-copying-when-mismatch |
3969 | (integerp backup-by-copying-when-privileged-mismatch)) | |
eb650569 | 3970 | (let ((attr (file-attributes real-file-name))) |
ffc0e1ca AS |
3971 | (and (or backup-by-copying-when-mismatch |
3972 | (and (integerp (nth 2 attr)) | |
3973 | (integerp backup-by-copying-when-privileged-mismatch) | |
3974 | (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch))) | |
97976f9f PE |
3975 | (not (file-ownership-preserved-p |
3976 | real-file-name t)))))) | |
7c3d167f RF |
3977 | (backup-buffer-copy real-file-name |
3978 | backupname modes | |
3979 | extended-attributes) | |
eb650569 RS |
3980 | ;; rename-file should delete old backup. |
3981 | (rename-file real-file-name backupname t) | |
7c3d167f RF |
3982 | (setq setmodes (list modes extended-attributes |
3983 | backupname))) | |
eb650569 | 3984 | (file-error |
b024d9f0 MD |
3985 | ;; If trouble writing the backup, write it in |
3986 | ;; .emacs.d/%backup%. | |
3987 | (setq backupname (locate-user-emacs-file "%backup%~")) | |
567c1ca9 | 3988 | (message "Cannot write backup file; backing up in %s" |
6ba7756e | 3989 | backupname) |
eb650569 | 3990 | (sleep-for 1) |
7c3d167f RF |
3991 | (backup-buffer-copy real-file-name backupname |
3992 | modes extended-attributes))) | |
eb650569 RS |
3993 | (setq buffer-backed-up t) |
3994 | ;; Now delete the old versions, if desired. | |
3995 | (if delete-old-versions | |
3996 | (while targets | |
3997 | (condition-case () | |
3998 | (delete-file (car targets)) | |
3999 | (file-error nil)) | |
4000 | (setq targets (cdr targets)))) | |
4001 | setmodes) | |
4002 | (file-error nil)))))) | |
b4da00e9 | 4003 | |
7c3d167f | 4004 | (defun backup-buffer-copy (from-name to-name modes extended-attributes) |
44dce0fb RS |
4005 | (let ((umask (default-file-modes))) |
4006 | (unwind-protect | |
4007 | (progn | |
4008 | ;; Create temp files with strict access rights. It's easy to | |
4009 | ;; loosen them later, whereas it's impossible to close the | |
4010 | ;; time-window of loose permissions otherwise. | |
4011 | (set-default-file-modes ?\700) | |
0f39d2c9 MR |
4012 | (when (condition-case nil |
4013 | ;; Try to overwrite old backup first. | |
5b2e628f | 4014 | (copy-file from-name to-name t t t) |
0f39d2c9 MR |
4015 | (error t)) |
4016 | (while (condition-case nil | |
4017 | (progn | |
4018 | (when (file-exists-p to-name) | |
4019 | (delete-file to-name)) | |
5b2e628f | 4020 | (copy-file from-name to-name nil t t) |
0f39d2c9 MR |
4021 | nil) |
4022 | (file-already-exists t)) | |
4023 | ;; The file was somehow created by someone else between | |
4024 | ;; `delete-file' and `copy-file', so let's try again. | |
4025 | ;; rms says "I think there is also a possible race | |
4026 | ;; condition for making backup files" (emacs-devel 20070821). | |
4027 | nil))) | |
44dce0fb RS |
4028 | ;; Reset the umask. |
4029 | (set-default-file-modes umask))) | |
ccad023b EZ |
4030 | ;; If set-file-extended-attributes fails, fall back on set-file-modes. |
4031 | (unless (and extended-attributes | |
4032 | (with-demoted-errors | |
4033 | (set-file-extended-attributes to-name extended-attributes))) | |
4034 | (and modes | |
4035 | (set-file-modes to-name (logand modes #o1777))))) | |
446c63b0 | 4036 | |
33cf0fb2 | 4037 | (defvar file-name-version-regexp |
2de9cc1a RT |
4038 | "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)" |
4039 | ;; The last ~[[:digit]]+ matches relative versions in git, | |
4040 | ;; e.g. `foo.js.~HEAD~1~'. | |
33cf0fb2 SM |
4041 | "Regular expression matching the backup/version part of a file name. |
4042 | Used by `file-name-sans-versions'.") | |
4043 | ||
c3554e95 | 4044 | (defun file-name-sans-versions (name &optional keep-backup-version) |
ffc0e1ca | 4045 | "Return file NAME sans backup versions or strings. |
b4da00e9 | 4046 | This is a separate procedure so your site-init or startup file can |
c3554e95 RS |
4047 | redefine it. |
4048 | If the optional argument KEEP-BACKUP-VERSION is non-nil, | |
33cf0fb2 SM |
4049 | we do not remove backup version numbers, only true file version numbers. |
4050 | See also `file-name-version-regexp'." | |
6eaebaa2 | 4051 | (let ((handler (find-file-name-handler name 'file-name-sans-versions))) |
c3554e95 RS |
4052 | (if handler |
4053 | (funcall handler 'file-name-sans-versions name keep-backup-version) | |
4054 | (substring name 0 | |
33cf0fb2 SM |
4055 | (unless keep-backup-version |
4056 | (string-match (concat file-name-version-regexp "\\'") | |
4057 | name)))))) | |
b4da00e9 | 4058 | |
97976f9f PE |
4059 | (defun file-ownership-preserved-p (file &optional group) |
4060 | "Return t if deleting FILE and rewriting it would preserve the owner. | |
4061 | Return nil if FILE does not exist, or if deleting and recreating it | |
4062 | might not preserve the owner. If GROUP is non-nil, check whether | |
4063 | the group would be preserved too." | |
cb0cd911 RS |
4064 | (let ((handler (find-file-name-handler file 'file-ownership-preserved-p))) |
4065 | (if handler | |
97976f9f | 4066 | (funcall handler 'file-ownership-preserved-p file group) |
2920e68d | 4067 | (let ((attributes (file-attributes file 'integer))) |
306faa42 RS |
4068 | ;; Return t if the file doesn't exist, since it's true that no |
4069 | ;; information would be lost by an (attempted) delete and create. | |
4070 | (or (null attributes) | |
97976f9f PE |
4071 | (and (or (= (nth 2 attributes) (user-uid)) |
4072 | ;; Files created on Windows by Administrator (RID=500) | |
4073 | ;; have the Administrators group (RID=544) recorded as | |
4074 | ;; their owner. Rewriting them will still preserve the | |
4075 | ;; owner. | |
4076 | (and (eq system-type 'windows-nt) | |
4077 | (= (user-uid) 500) (= (nth 2 attributes) 544))) | |
4078 | (or (not group) | |
4079 | ;; On BSD-derived systems files always inherit the parent | |
4080 | ;; directory's group, so skip the group-gid test. | |
4081 | (memq system-type '(berkeley-unix darwin gnu/kfreebsd)) | |
4082 | (= (nth 3 attributes) (group-gid))) | |
4083 | (let* ((parent (or (file-name-directory file) ".")) | |
4084 | (parent-attributes (file-attributes parent 'integer))) | |
4085 | (and parent-attributes | |
4086 | ;; On some systems, a file created in a setuid directory | |
4087 | ;; inherits that directory's owner. | |
4088 | (or | |
4089 | (= (nth 2 parent-attributes) (user-uid)) | |
4090 | (string-match "^...[^sS]" (nth 8 parent-attributes))) | |
4091 | ;; On many systems, a file created in a setgid directory | |
4092 | ;; inherits that directory's group. On some systems | |
4093 | ;; this happens even if the setgid bit is not set. | |
4094 | (or (not group) | |
4095 | (= (nth 3 parent-attributes) | |
4096 | (nth 3 attributes))))))))))) | |
cb0cd911 | 4097 | |
20b5d24c RS |
4098 | (defun file-name-sans-extension (filename) |
4099 | "Return FILENAME sans final \"extension\". | |
2531b0c3 EZ |
4100 | The extension, in a file name, is the part that follows the last `.', |
4101 | except that a leading `.', if any, doesn't count." | |
20b5d24c RS |
4102 | (save-match-data |
4103 | (let ((file (file-name-sans-versions (file-name-nondirectory filename))) | |
4104 | directory) | |
2531b0c3 EZ |
4105 | (if (and (string-match "\\.[^.]*\\'" file) |
4106 | (not (eq 0 (match-beginning 0)))) | |
20b5d24c | 4107 | (if (setq directory (file-name-directory filename)) |
6ee24f1e RS |
4108 | ;; Don't use expand-file-name here; if DIRECTORY is relative, |
4109 | ;; we don't want to expand it. | |
4110 | (concat directory (substring file 0 (match-beginning 0))) | |
20b5d24c RS |
4111 | (substring file 0 (match-beginning 0))) |
4112 | filename)))) | |
4113 | ||
93a2702d RS |
4114 | (defun file-name-extension (filename &optional period) |
4115 | "Return FILENAME's final \"extension\". | |
2531b0c3 | 4116 | The extension, in a file name, is the part that follows the last `.', |
32483280 | 4117 | excluding version numbers and backup suffixes, |
2531b0c3 | 4118 | except that a leading `.', if any, doesn't count. |
93a2702d RS |
4119 | Return nil for extensionless file names such as `foo'. |
4120 | Return the empty string for file names such as `foo.'. | |
4121 | ||
4122 | If PERIOD is non-nil, then the returned value includes the period | |
4123 | that delimits the extension, and if FILENAME has no extension, | |
4124 | the value is \"\"." | |
4125 | (save-match-data | |
4126 | (let ((file (file-name-sans-versions (file-name-nondirectory filename)))) | |
2531b0c3 EZ |
4127 | (if (and (string-match "\\.[^.]*\\'" file) |
4128 | (not (eq 0 (match-beginning 0)))) | |
93a2702d RS |
4129 | (substring file (+ (match-beginning 0) (if period 0 1))) |
4130 | (if period | |
4131 | ""))))) | |
4132 | ||
d2c32364 SS |
4133 | (defun file-name-base (&optional filename) |
4134 | "Return the base name of the FILENAME: no directory, no extension. | |
4135 | FILENAME defaults to `buffer-file-name'." | |
4136 | (file-name-sans-extension | |
4137 | (file-name-nondirectory (or filename (buffer-file-name))))) | |
4138 | ||
ffc0e1ca AS |
4139 | (defcustom make-backup-file-name-function nil |
4140 | "A function to use instead of the default `make-backup-file-name'. | |
643c985d | 4141 | A value of nil gives the default `make-backup-file-name' behavior. |
ffc0e1ca | 4142 | |
d5798fa7 | 4143 | This could be buffer-local to do something special for specific |
ffc0e1ca AS |
4144 | files. If you define it, you may need to change `backup-file-name-p' |
4145 | and `file-name-sans-versions' too. | |
4146 | ||
4147 | See also `backup-directory-alist'." | |
4148 | :group 'backup | |
4149 | :type '(choice (const :tag "Default" nil) | |
4150 | (function :tag "Your function"))) | |
4151 | ||
4152 | (defcustom backup-directory-alist nil | |
4153 | "Alist of filename patterns and backup directory names. | |
4154 | Each element looks like (REGEXP . DIRECTORY). Backups of files with | |
4155 | names matching REGEXP will be made in DIRECTORY. DIRECTORY may be | |
4156 | relative or absolute. If it is absolute, so that all matching files | |
4157 | are backed up into the same directory, the file names in this | |
4158 | directory will be the full name of the file backed up with all | |
4159 | directory separators changed to `!' to prevent clashes. This will not | |
4160 | work correctly if your filesystem truncates the resulting name. | |
4161 | ||
4162 | For the common case of all backups going into one directory, the alist | |
4163 | should contain a single element pairing \".\" with the appropriate | |
4164 | directory name. | |
4165 | ||
4166 | If this variable is nil, or it fails to match a filename, the backup | |
4167 | is made in the original file's directory. | |
4168 | ||
4169 | On MS-DOS filesystems without long names this variable is always | |
4170 | ignored." | |
4171 | :group 'backup | |
dca5e71d | 4172 | :type '(repeat (cons (regexp :tag "Regexp matching filename") |
ffc0e1ca AS |
4173 | (directory :tag "Backup directory name")))) |
4174 | ||
388d6ab5 RS |
4175 | (defun normal-backup-enable-predicate (name) |
4176 | "Default `backup-enable-predicate' function. | |
0c2f6dda RS |
4177 | Checks for files in `temporary-file-directory', |
4178 | `small-temporary-file-directory', and /tmp." | |
388d6ab5 RS |
4179 | (not (or (let ((comp (compare-strings temporary-file-directory 0 nil |
4180 | name 0 nil))) | |
4181 | ;; Directory is under temporary-file-directory. | |
4182 | (and (not (eq comp t)) | |
4183 | (< comp (- (length temporary-file-directory))))) | |
0c2f6dda RS |
4184 | (let ((comp (compare-strings "/tmp" 0 nil |
4185 | name 0 nil))) | |
4186 | ;; Directory is under /tmp. | |
4187 | (and (not (eq comp t)) | |
4188 | (< comp (- (length "/tmp"))))) | |
388d6ab5 RS |
4189 | (if small-temporary-file-directory |
4190 | (let ((comp (compare-strings small-temporary-file-directory | |
4191 | 0 nil | |
4192 | name 0 nil))) | |
4193 | ;; Directory is under small-temporary-file-directory. | |
4194 | (and (not (eq comp t)) | |
4195 | (< comp (- (length small-temporary-file-directory))))))))) | |
4196 | ||
b4da00e9 RM |
4197 | (defun make-backup-file-name (file) |
4198 | "Create the non-numeric backup file name for FILE. | |
ffc0e1ca AS |
4199 | Normally this will just be the file's name with `~' appended. |
4200 | Customization hooks are provided as follows. | |
4201 | ||
4202 | If the variable `make-backup-file-name-function' is non-nil, its value | |
4203 | should be a function which will be called with FILE as its argument; | |
4204 | the resulting name is used. | |
4205 | ||
4206 | Otherwise a match for FILE is sought in `backup-directory-alist'; see | |
4207 | the documentation of that variable. If the directory for the backup | |
4208 | doesn't exist, it is created." | |
4209 | (if make-backup-file-name-function | |
4210 | (funcall make-backup-file-name-function file) | |
4211 | (if (and (eq system-type 'ms-dos) | |
4212 | (not (msdos-long-file-names))) | |
4213 | (let ((fn (file-name-nondirectory file))) | |
4214 | (concat (file-name-directory file) | |
4215 | (or (and (string-match "\\`[^.]+\\'" fn) | |
4216 | (concat (match-string 0 fn) ".~")) | |
4217 | (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn) | |
4218 | (concat (match-string 0 fn) "~"))))) | |
4219 | (concat (make-backup-file-name-1 file) "~")))) | |
4220 | ||
4221 | (defun make-backup-file-name-1 (file) | |
4222 | "Subroutine of `make-backup-file-name' and `find-backup-file-name'." | |
4223 | (let ((alist backup-directory-alist) | |
6ba7756e | 4224 | elt backup-directory abs-backup-directory) |
ffc0e1ca AS |
4225 | (while alist |
4226 | (setq elt (pop alist)) | |
4227 | (if (string-match (car elt) file) | |
4228 | (setq backup-directory (cdr elt) | |
4229 | alist nil))) | |
eb0455ab RS |
4230 | ;; If backup-directory is relative, it should be relative to the |
4231 | ;; file's directory. By expanding explicitly here, we avoid | |
4232 | ;; depending on default-directory. | |
4233 | (if backup-directory | |
6ba7756e RS |
4234 | (setq abs-backup-directory |
4235 | (expand-file-name backup-directory | |
4236 | (file-name-directory file)))) | |
4237 | (if (and abs-backup-directory (not (file-exists-p abs-backup-directory))) | |
ffc0e1ca | 4238 | (condition-case nil |
6ba7756e RS |
4239 | (make-directory abs-backup-directory 'parents) |
4240 | (file-error (setq backup-directory nil | |
4241 | abs-backup-directory nil)))) | |
ee291b46 RS |
4242 | (if (null backup-directory) |
4243 | file | |
ffc0e1ca AS |
4244 | (if (file-name-absolute-p backup-directory) |
4245 | (progn | |
c60ee5e7 | 4246 | (when (memq system-type '(windows-nt ms-dos cygwin)) |
d7b6ca4a RS |
4247 | ;; Normalize DOSish file names: downcase the drive |
4248 | ;; letter, if any, and replace the leading "x:" with | |
4249 | ;; "/drive_x". | |
ffc0e1ca AS |
4250 | (or (file-name-absolute-p file) |
4251 | (setq file (expand-file-name file))) ; make defaults explicit | |
4252 | ;; Replace any invalid file-name characters (for the | |
4253 | ;; case of backing up remote files). | |
446c097e | 4254 | (setq file (expand-file-name (convert-standard-filename file))) |
ffc0e1ca | 4255 | (if (eq (aref file 1) ?:) |
d7b6ca4a | 4256 | (setq file (concat "/" |
ffc0e1ca AS |
4257 | "drive_" |
4258 | (char-to-string (downcase (aref file 0))) | |
d7b6ca4a | 4259 | (if (eq (aref file 2) ?/) |
ffc0e1ca | 4260 | "" |
d7b6ca4a | 4261 | "/") |
ffc0e1ca AS |
4262 | (substring file 2))))) |
4263 | ;; Make the name unique by substituting directory | |
4264 | ;; separators. It may not really be worth bothering about | |
4265 | ;; doubling `!'s in the original name... | |
4266 | (expand-file-name | |
4267 | (subst-char-in-string | |
d7b6ca4a | 4268 | ?/ ?! |
ffc0e1ca AS |
4269 | (replace-regexp-in-string "!" "!!" file)) |
4270 | backup-directory)) | |
4271 | (expand-file-name (file-name-nondirectory file) | |
6ba7756e | 4272 | (file-name-as-directory abs-backup-directory)))))) |
b4da00e9 RM |
4273 | |
4274 | (defun backup-file-name-p (file) | |
4275 | "Return non-nil if FILE is a backup file name (numeric or not). | |
4276 | This is a separate function so you can redefine it for customization. | |
4277 | You may need to redefine `file-name-sans-versions' as well." | |
066327ae | 4278 | (string-match "~\\'" file)) |
b4da00e9 | 4279 | |
e2b30772 RS |
4280 | (defvar backup-extract-version-start) |
4281 | ||
2d051399 | 4282 | ;; This is used in various files. |
a7aa942a KH |
4283 | ;; The usage of backup-extract-version-start is not very clean, |
4284 | ;; but I can't see a good alternative, so as of now I am leaving it alone. | |
2d051399 | 4285 | (defun backup-extract-version (fn) |
ffc0e1ca | 4286 | "Given the name of a numeric backup file, FN, return the backup number. |
e2b30772 | 4287 | Uses the free variable `backup-extract-version-start', whose value should be |
2d051399 | 4288 | the index in the name where the version number begins." |
6cf29fe8 | 4289 | (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start) |
e2b30772 | 4290 | (= (match-beginning 0) backup-extract-version-start)) |
027a4b6b | 4291 | (string-to-number (substring fn backup-extract-version-start -1)) |
2d051399 RS |
4292 | 0)) |
4293 | ||
b4da00e9 | 4294 | (defun find-backup-file-name (fn) |
ffc0e1ca | 4295 | "Find a file name for a backup file FN, and suggestions for deletions. |
b4da00e9 | 4296 | Value is a list whose car is the name for the backup file |
ffc0e1ca AS |
4297 | and whose cdr is a list of old versions to consider deleting now. |
4298 | If the value is nil, don't make a backup. | |
4299 | Uses `backup-directory-alist' in the same way as does | |
4300 | `make-backup-file-name'." | |
eb650569 RS |
4301 | (let ((handler (find-file-name-handler fn 'find-backup-file-name))) |
4302 | ;; Run a handler for this function so that ange-ftp can refuse to do it. | |
4303 | (if handler | |
4304 | (funcall handler 'find-backup-file-name fn) | |
f26d858e EZ |
4305 | (if (or (eq version-control 'never) |
4306 | ;; We don't support numbered backups on plain MS-DOS | |
4307 | ;; when long file names are unavailable. | |
4308 | (and (eq system-type 'ms-dos) | |
4309 | (not (msdos-long-file-names)))) | |
b4da00e9 | 4310 | (list (make-backup-file-name fn)) |
ffc0e1ca AS |
4311 | (let* ((basic-name (make-backup-file-name-1 fn)) |
4312 | (base-versions (concat (file-name-nondirectory basic-name) | |
4313 | ".~")) | |
e2b30772 | 4314 | (backup-extract-version-start (length base-versions)) |
eb650569 | 4315 | (high-water-mark 0) |
ffc0e1ca AS |
4316 | (number-to-delete 0) |
4317 | possibilities deserve-versions-p versions) | |
eb650569 RS |
4318 | (condition-case () |
4319 | (setq possibilities (file-name-all-completions | |
4320 | base-versions | |
ffc0e1ca AS |
4321 | (file-name-directory basic-name)) |
4322 | versions (sort (mapcar #'backup-extract-version | |
4323 | possibilities) | |
4324 | #'<) | |
eb650569 RS |
4325 | high-water-mark (apply 'max 0 versions) |
4326 | deserve-versions-p (or version-control | |
4327 | (> high-water-mark 0)) | |
4328 | number-to-delete (- (length versions) | |
ffc0e1ca AS |
4329 | kept-old-versions |
4330 | kept-new-versions | |
4331 | -1)) | |
4332 | (file-error (setq possibilities nil))) | |
eb650569 | 4333 | (if (not deserve-versions-p) |
8767d866 | 4334 | (list (make-backup-file-name fn)) |
ffc0e1ca | 4335 | (cons (format "%s.~%d~" basic-name (1+ high-water-mark)) |
eb650569 RS |
4336 | (if (and (> number-to-delete 0) |
4337 | ;; Delete nothing if there is overflow | |
4338 | ;; in the number of versions to keep. | |
4339 | (>= (+ kept-new-versions kept-old-versions -1) 0)) | |
ffc0e1ca AS |
4340 | (mapcar (lambda (n) |
4341 | (format "%s.~%d~" basic-name n)) | |
eb650569 RS |
4342 | (let ((v (nthcdr kept-old-versions versions))) |
4343 | (rplacd (nthcdr (1- number-to-delete) v) ()) | |
4344 | v)))))))))) | |
b4da00e9 | 4345 | |
b4da00e9 RM |
4346 | (defun file-nlinks (filename) |
4347 | "Return number of names file FILENAME has." | |
4348 | (car (cdr (file-attributes filename)))) | |
6c636af9 | 4349 | |
753ad988 KG |
4350 | ;; (defun file-relative-name (filename &optional directory) |
4351 | ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). | |
4352 | ;; This function returns a relative file name which is equivalent to FILENAME | |
4353 | ;; when used with that default directory as the default. | |
4354 | ;; If this is impossible (which can happen on MSDOS and Windows | |
4355 | ;; when the file name and directory use different drive names) | |
4356 | ;; then it returns FILENAME." | |
4357 | ;; (save-match-data | |
4358 | ;; (let ((fname (expand-file-name filename))) | |
4359 | ;; (setq directory (file-name-as-directory | |
4360 | ;; (expand-file-name (or directory default-directory)))) | |
4361 | ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different | |
4362 | ;; ;; drive names, they can't be relative, so return the absolute name. | |
4363 | ;; (if (and (or (eq system-type 'ms-dos) | |
4364 | ;; (eq system-type 'cygwin) | |
4365 | ;; (eq system-type 'windows-nt)) | |
4366 | ;; (not (string-equal (substring fname 0 2) | |
4367 | ;; (substring directory 0 2)))) | |
4368 | ;; filename | |
4369 | ;; (let ((ancestor ".") | |
4370 | ;; (fname-dir (file-name-as-directory fname))) | |
4371 | ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir)) | |
4372 | ;; (not (string-match (concat "^" (regexp-quote directory)) fname))) | |
4373 | ;; (setq directory (file-name-directory (substring directory 0 -1)) | |
4374 | ;; ancestor (if (equal ancestor ".") | |
4375 | ;; ".." | |
4376 | ;; (concat "../" ancestor)))) | |
4377 | ;; ;; Now ancestor is empty, or .., or ../.., etc. | |
4378 | ;; (if (string-match (concat "^" (regexp-quote directory)) fname) | |
4379 | ;; ;; We matched within FNAME's directory part. | |
4380 | ;; ;; Add the rest of FNAME onto ANCESTOR. | |
4381 | ;; (let ((rest (substring fname (match-end 0)))) | |
4382 | ;; (if (and (equal ancestor ".") | |
4383 | ;; (not (equal rest ""))) | |
4384 | ;; ;; But don't bother with ANCESTOR if it would give us `./'. | |
4385 | ;; rest | |
4386 | ;; (concat (file-name-as-directory ancestor) rest))) | |
4387 | ;; ;; We matched FNAME's directory equivalent. | |
4388 | ;; ancestor)))))) | |
4389 | ||
6c636af9 | 4390 | (defun file-relative-name (filename &optional directory) |
ffc0e1ca | 4391 | "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). |
2d6562a5 RS |
4392 | This function returns a relative file name which is equivalent to FILENAME |
4393 | when used with that default directory as the default. | |
753ad988 | 4394 | If FILENAME and DIRECTORY lie on different machines or on different drives |
1be0210d | 4395 | on a DOS/Windows machine, it returns FILENAME in expanded form." |
96c188b0 | 4396 | (save-match-data |
753ad988 KG |
4397 | (setq directory |
4398 | (file-name-as-directory (expand-file-name (or directory | |
4399 | default-directory)))) | |
4400 | (setq filename (expand-file-name filename)) | |
3f788773 | 4401 | (let ((fremote (file-remote-p filename)) |
93842198 EZ |
4402 | (dremote (file-remote-p directory)) |
4403 | (fold-case (or (memq system-type '(ms-dos cygwin windows-nt)) | |
4404 | read-file-name-completion-ignore-case))) | |
493c98af KG |
4405 | (if ;; Conditions for separate trees |
4406 | (or | |
2472c214 | 4407 | ;; Test for different filesystems on DOS/Windows |
493c98af | 4408 | (and |
7c64272b | 4409 | ;; Should `cygwin' really be included here? --stef |
493c98af | 4410 | (memq system-type '(ms-dos cygwin windows-nt)) |
2472c214 EZ |
4411 | (or |
4412 | ;; Test for different drive letters | |
93842198 | 4413 | (not (eq t (compare-strings filename 0 2 directory 0 2 fold-case))) |
2472c214 EZ |
4414 | ;; Test for UNCs on different servers |
4415 | (not (eq t (compare-strings | |
4416 | (progn | |
4417 | (if (string-match "\\`//\\([^:/]+\\)/" filename) | |
4418 | (match-string 1 filename) | |
4419 | ;; Windows file names cannot have ? in | |
4420 | ;; them, so use that to detect when | |
4421 | ;; neither FILENAME nor DIRECTORY is a | |
4422 | ;; UNC. | |
4423 | "?")) | |
4424 | 0 nil | |
4425 | (progn | |
4426 | (if (string-match "\\`//\\([^:/]+\\)/" directory) | |
4427 | (match-string 1 directory) | |
4428 | "?")) | |
4429 | 0 nil t))))) | |
493c98af | 4430 | ;; Test for different remote file system identification |
3f788773 | 4431 | (not (equal fremote dremote))) |
e2b30772 | 4432 | filename |
753ad988 KG |
4433 | (let ((ancestor ".") |
4434 | (filename-dir (file-name-as-directory filename))) | |
7c64272b SM |
4435 | (while (not |
4436 | (or | |
4437 | (eq t (compare-strings filename-dir nil (length directory) | |
93842198 | 4438 | directory nil nil fold-case)) |
7c64272b | 4439 | (eq t (compare-strings filename nil (length directory) |
93842198 | 4440 | directory nil nil fold-case)))) |
753ad988 | 4441 | (setq directory (file-name-directory (substring directory 0 -1)) |
9695aac6 RS |
4442 | ancestor (if (equal ancestor ".") |
4443 | ".." | |
4444 | (concat "../" ancestor)))) | |
753ad988 | 4445 | ;; Now ancestor is empty, or .., or ../.., etc. |
7c64272b | 4446 | (if (eq t (compare-strings filename nil (length directory) |
93842198 | 4447 | directory nil nil fold-case)) |
753ad988 KG |
4448 | ;; We matched within FILENAME's directory part. |
4449 | ;; Add the rest of FILENAME onto ANCESTOR. | |
3f7d6528 | 4450 | (let ((rest (substring filename (length directory)))) |
753ad988 | 4451 | (if (and (equal ancestor ".") (not (equal rest ""))) |
9695aac6 RS |
4452 | ;; But don't bother with ANCESTOR if it would give us `./'. |
4453 | rest | |
4454 | (concat (file-name-as-directory ancestor) rest))) | |
753ad988 KG |
4455 | ;; We matched FILENAME's directory equivalent. |
4456 | ancestor)))))) | |
b4da00e9 RM |
4457 | \f |
4458 | (defun save-buffer (&optional args) | |
e8f4db18 RS |
4459 | "Save current buffer in visited file if modified. |
4460 | Variations are described below. | |
4461 | ||
b4da00e9 RM |
4462 | By default, makes the previous version into a backup file |
4463 | if previously requested or if this is the first save. | |
dc2ab26e | 4464 | Prefixed with one \\[universal-argument], marks this version |
b4da00e9 | 4465 | to become a backup when the next save is done. |
dc2ab26e | 4466 | Prefixed with two \\[universal-argument]'s, |
b4da00e9 | 4467 | unconditionally makes the previous version into a backup file. |
dc2ab26e | 4468 | Prefixed with three \\[universal-argument]'s, marks this version |
ac9650be RS |
4469 | to become a backup when the next save is done, |
4470 | and unconditionally makes the previous version into a backup file. | |
4471 | ||
dc2ab26e EZ |
4472 | With a numeric argument of 0, never make the previous version |
4473 | into a backup file. | |
b4da00e9 RM |
4474 | |
4475 | If a file's name is FOO, the names of its numbered backup versions are | |
4476 | FOO.~i~ for various integers i. A non-numbered backup file is called FOO~. | |
4477 | Numeric backups (rather than FOO~) will be made if value of | |
4478 | `version-control' is not the atom `never' and either there are already | |
4479 | numeric versions of the file being backed up, or `version-control' is | |
4480 | non-nil. | |
4481 | We don't want excessive versions piling up, so there are variables | |
4482 | `kept-old-versions', which tells Emacs how many oldest versions to keep, | |
4483 | and `kept-new-versions', which tells how many newest versions to keep. | |
4484 | Defaults are 2 old versions and 2 new. | |
4485 | `dired-kept-versions' controls dired's clean-directory (.) command. | |
de7d5e1b | 4486 | If `delete-old-versions' is nil, system will query user |
e73ec04b RS |
4487 | before trimming versions. Otherwise it does it silently. |
4488 | ||
749d2ee6 RS |
4489 | If `vc-make-backup-files' is nil, which is the default, |
4490 | no backup files are made for files managed by version control. | |
4491 | (This is because the version control system itself records previous versions.) | |
4492 | ||
e73ec04b | 4493 | See the subroutine `basic-save-buffer' for more information." |
b4da00e9 RM |
4494 | (interactive "p") |
4495 | (let ((modp (buffer-modified-p)) | |
b5a8e0fc RS |
4496 | (make-backup-files (or (and make-backup-files (not (eq args 0))) |
4497 | (memq args '(16 64))))) | |
b4da00e9 | 4498 | (and modp (memq args '(16 64)) (setq buffer-backed-up nil)) |
86a30352 EZ |
4499 | ;; We used to display the message below only for files > 50KB, but |
4500 | ;; then Rmail-mbox never displays it due to buffer swapping. If | |
4501 | ;; the test is ever re-introduced, be sure to handle saving of | |
4502 | ;; Rmail files. | |
4503 | (if (and modp (buffer-file-name)) | |
b4990dde | 4504 | (message "Saving file %s..." (buffer-file-name))) |
b4da00e9 RM |
4505 | (basic-save-buffer) |
4506 | (and modp (memq args '(4 64)) (setq buffer-backed-up nil)))) | |
4507 | ||
4508 | (defun delete-auto-save-file-if-necessary (&optional force) | |
4509 | "Delete auto-save file for current buffer if `delete-auto-save-files' is t. | |
4510 | Normally delete only if the file was written by this Emacs since | |
4511 | the last real save, but optional arg FORCE non-nil means delete anyway." | |
4512 | (and buffer-auto-save-file-name delete-auto-save-files | |
4513 | (not (string= buffer-file-name buffer-auto-save-file-name)) | |
4514 | (or force (recent-auto-save-p)) | |
4515 | (progn | |
4516 | (condition-case () | |
4517 | (delete-file buffer-auto-save-file-name) | |
4518 | (file-error nil)) | |
4519 | (set-buffer-auto-saved)))) | |
4520 | ||
481f215b KH |
4521 | (defvar auto-save-hook nil |
4522 | "Normal hook run just before auto-saving.") | |
4523 | ||
3c3b81d1 SJ |
4524 | (defcustom before-save-hook nil |
4525 | "Normal hook that is run before a buffer is saved to its file." | |
25f6295e | 4526 | :options '(copyright-update time-stamp) |
3c3b81d1 SJ |
4527 | :type 'hook |
4528 | :group 'files) | |
4529 | ||
ffc0e1ca AS |
4530 | (defcustom after-save-hook nil |
4531 | "Normal hook that is run after a buffer is saved to its file." | |
4532 | :options '(executable-make-buffer-file-executable-if-script-p) | |
4533 | :type 'hook | |
4534 | :group 'files) | |
1cc852cc | 4535 | |
0516edee RS |
4536 | (defvar save-buffer-coding-system nil |
4537 | "If non-nil, use this coding system for saving the buffer. | |
4538 | More precisely, use this coding system in place of the | |
4539 | value of `buffer-file-coding-system', when saving the buffer. | |
4540 | Calling `write-region' for any purpose other than saving the buffer | |
4541 | will still use `buffer-file-coding-system'; this variable has no effect | |
4542 | in such cases.") | |
4543 | ||
d5fe94cc RS |
4544 | (make-variable-buffer-local 'save-buffer-coding-system) |
4545 | (put 'save-buffer-coding-system 'permanent-local t) | |
4546 | ||
b4da00e9 | 4547 | (defun basic-save-buffer () |
1cc852cc | 4548 | "Save the current buffer in its visited file, if it has been modified. |
0370fe77 SM |
4549 | The hooks `write-contents-functions' and `write-file-functions' get a chance |
4550 | to do the job of saving; if they do not, then the buffer is saved in | |
222cf381 | 4551 | the visited file in the usual way. |
3c3b81d1 SJ |
4552 | Before and after saving the buffer, this function runs |
4553 | `before-save-hook' and `after-save-hook', respectively." | |
b4da00e9 | 4554 | (interactive) |
19618231 | 4555 | (save-current-buffer |
c11a94fe RS |
4556 | ;; In an indirect buffer, save its base buffer instead. |
4557 | (if (buffer-base-buffer) | |
4558 | (set-buffer (buffer-base-buffer))) | |
75d1d833 BG |
4559 | (if (or (buffer-modified-p) |
4560 | ;; handle the case when no modification has been made but | |
4561 | ;; the file disappeared since visited | |
4562 | (and buffer-file-name | |
4563 | (not (file-exists-p buffer-file-name)))) | |
c11a94fe | 4564 | (let ((recent-save (recent-auto-save-p)) |
818286f4 | 4565 | setmodes) |
c11a94fe RS |
4566 | ;; If buffer has no file name, ask user for one. |
4567 | (or buffer-file-name | |
182891ef RS |
4568 | (let ((filename |
4569 | (expand-file-name | |
53fa8652 JL |
4570 | (read-file-name "File to save in: " |
4571 | nil (expand-file-name (buffer-name)))))) | |
8400146f MR |
4572 | (if (file-exists-p filename) |
4573 | (if (file-directory-p filename) | |
4574 | ;; Signal an error if the user specified the name of an | |
4575 | ;; existing directory. | |
4576 | (error "%s is a directory" filename) | |
9aea757b CY |
4577 | (unless (y-or-n-p (format "File `%s' exists; overwrite? " |
4578 | filename)) | |
8400146f MR |
4579 | (error "Canceled"))) |
4580 | ;; Signal an error if the specified name refers to a | |
4581 | ;; non-existing directory. | |
4582 | (let ((dir (file-name-directory filename))) | |
4583 | (unless (file-directory-p dir) | |
4584 | (if (file-exists-p dir) | |
4585 | (error "%s is not a directory" dir) | |
4586 | (error "%s: no such directory" dir))))) | |
182891ef | 4587 | (set-visited-file-name filename))) |
c11a94fe RS |
4588 | (or (verify-visited-file-modtime (current-buffer)) |
4589 | (not (file-exists-p buffer-file-name)) | |
4590 | (yes-or-no-p | |
9aea757b CY |
4591 | (format |
4592 | "%s has changed since visited or saved. Save anyway? " | |
4593 | (file-name-nondirectory buffer-file-name))) | |
71873e2b | 4594 | (user-error "Save not confirmed")) |
c11a94fe RS |
4595 | (save-restriction |
4596 | (widen) | |
19618231 | 4597 | (save-excursion |
0370fe77 | 4598 | (and (> (point-max) (point-min)) |
407b4328 | 4599 | (not find-file-literally) |
19618231 RS |
4600 | (/= (char-after (1- (point-max))) ?\n) |
4601 | (not (and (eq selective-display t) | |
4602 | (= (char-after (1- (point-max))) ?\r))) | |
4603 | (or (eq require-final-newline t) | |
f4206092 | 4604 | (eq require-final-newline 'visit-save) |
19618231 RS |
4605 | (and require-final-newline |
4606 | (y-or-n-p | |
9aea757b CY |
4607 | (format "Buffer %s does not end in newline. Add one? " |
4608 | (buffer-name))))) | |
19618231 RS |
4609 | (save-excursion |
4610 | (goto-char (point-max)) | |
4611 | (insert ?\n)))) | |
fa5867f6 AS |
4612 | ;; Support VC version backups. |
4613 | (vc-before-save) | |
3c3b81d1 | 4614 | (run-hooks 'before-save-hook) |
0370fe77 | 4615 | (or (run-hook-with-args-until-success 'write-contents-functions) |
c11a94fe | 4616 | (run-hook-with-args-until-success 'local-write-file-hooks) |
0370fe77 | 4617 | (run-hook-with-args-until-success 'write-file-functions) |
0ba5894b RS |
4618 | ;; If a hook returned t, file is already "written". |
4619 | ;; Otherwise, write it the usual way now. | |
4620 | (setq setmodes (basic-save-buffer-1))) | |
d6e8ea6f KH |
4621 | ;; Now we have saved the current buffer. Let's make sure |
4622 | ;; that buffer-file-coding-system is fixed to what | |
4623 | ;; actually used for saving by binding it locally. | |
0516edee RS |
4624 | (if save-buffer-coding-system |
4625 | (setq save-buffer-coding-system last-coding-system-used) | |
4626 | (setq buffer-file-coding-system last-coding-system-used)) | |
2a47b4f5 RS |
4627 | (setq buffer-file-number |
4628 | (nthcdr 10 (file-attributes buffer-file-name))) | |
c11a94fe RS |
4629 | (if setmodes |
4630 | (condition-case () | |
574c05e2 | 4631 | (progn |
7e56b103 EZ |
4632 | (unless |
4633 | (with-demoted-errors | |
4634 | (set-file-modes buffer-file-name (car setmodes))) | |
4635 | (set-file-extended-attributes buffer-file-name | |
4636 | (nth 1 setmodes)))) | |
c11a94fe RS |
4637 | (error nil)))) |
4638 | ;; If the auto-save file was recent before this command, | |
4639 | ;; delete it now. | |
4640 | (delete-auto-save-file-if-necessary recent-save) | |
49530862 RS |
4641 | ;; Support VC `implicit' locking. |
4642 | (vc-after-save) | |
c11a94fe RS |
4643 | (run-hooks 'after-save-hook)) |
4644 | (message "(No changes need to be saved)")))) | |
b4da00e9 | 4645 | |
87d26afc RS |
4646 | ;; This does the "real job" of writing a buffer into its visited file |
4647 | ;; and making a backup file. This is what is normally done | |
0370fe77 | 4648 | ;; but inhibited if one of write-file-functions returns non-nil. |
7c3d167f RF |
4649 | ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like |
4650 | ;; backup-buffer. | |
87d26afc | 4651 | (defun basic-save-buffer-1 () |
969be033 RS |
4652 | (prog1 |
4653 | (if save-buffer-coding-system | |
4654 | (let ((coding-system-for-write save-buffer-coding-system)) | |
4655 | (basic-save-buffer-2)) | |
d5fe94cc | 4656 | (basic-save-buffer-2)) |
86c507f7 | 4657 | (if buffer-file-coding-system-explicit |
0ccdf61e | 4658 | (setcar buffer-file-coding-system-explicit last-coding-system-used)))) |
d5fe94cc | 4659 | |
7c3d167f RF |
4660 | ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like |
4661 | ;; backup-buffer. | |
d5fe94cc | 4662 | (defun basic-save-buffer-2 () |
9dbda100 | 4663 | (let (tempsetmodes setmodes writecoding) |
87d26afc RS |
4664 | (if (not (file-writable-p buffer-file-name)) |
4665 | (let ((dir (file-name-directory buffer-file-name))) | |
4666 | (if (not (file-directory-p dir)) | |
83c6f446 RS |
4667 | (if (file-exists-p dir) |
4668 | (error "%s is not a directory" dir) | |
87c60260 | 4669 | (error "%s: no such directory" dir)) |
87d26afc RS |
4670 | (if (not (file-exists-p buffer-file-name)) |
4671 | (error "Directory %s write-protected" dir) | |
4672 | (if (yes-or-no-p | |
9aea757b CY |
4673 | (format |
4674 | "File %s is write-protected; try to save anyway? " | |
4675 | (file-name-nondirectory | |
4676 | buffer-file-name))) | |
87d26afc RS |
4677 | (setq tempsetmodes t) |
4678 | (error "Attempt to save to a file which you aren't allowed to write")))))) | |
9dbda100 GM |
4679 | ;; This may involve prompting, so do it now before backing up the file. |
4680 | ;; Otherwise there can be a delay while the user answers the | |
4681 | ;; prompt during which the original file has been renamed. (Bug#13522) | |
4682 | (setq writecoding | |
4683 | ;; Args here should match write-region call below around | |
4684 | ;; which we use writecoding. | |
4685 | (choose-write-coding-system nil nil buffer-file-name nil t | |
4686 | buffer-file-truename)) | |
87d26afc RS |
4687 | (or buffer-backed-up |
4688 | (setq setmodes (backup-buffer))) | |
1d367309 KF |
4689 | (let* ((dir (file-name-directory buffer-file-name)) |
4690 | (dir-writable (file-writable-p dir))) | |
4691 | (if (or (and file-precious-flag dir-writable) | |
4692 | (and break-hardlink-on-save | |
35fd0881 | 4693 | (file-exists-p buffer-file-name) |
1d367309 KF |
4694 | (> (file-nlinks buffer-file-name) 1) |
4695 | (or dir-writable | |
4696 | (error (concat (format | |
4697 | "Directory %s write-protected; " dir) | |
4698 | "cannot break hardlink when saving"))))) | |
4699 | ;; Write temp name, then rename it. | |
f4a0f59b RS |
4700 | ;; This requires write access to the containing dir, |
4701 | ;; which is why we don't try it if we don't have that access. | |
4702 | (let ((realname buffer-file-name) | |
44dce0fb RS |
4703 | tempname succeed |
4704 | (umask (default-file-modes)) | |
6782610c | 4705 | (old-modtime (visited-file-modtime))) |
44dce0fb RS |
4706 | ;; Create temp files with strict access rights. It's easy to |
4707 | ;; loosen them later, whereas it's impossible to close the | |
4708 | ;; time-window of loose permissions otherwise. | |
f4a0f59b | 4709 | (unwind-protect |
44dce0fb RS |
4710 | (progn |
4711 | (clear-visited-file-modtime) | |
4712 | (set-default-file-modes ?\700) | |
4713 | ;; Try various temporary names. | |
4714 | ;; This code follows the example of make-temp-file, | |
4715 | ;; but it calls write-region in the appropriate way | |
4716 | ;; for saving the buffer. | |
4717 | (while (condition-case () | |
4718 | (progn | |
4719 | (setq tempname | |
4720 | (make-temp-name | |
4721 | (expand-file-name "tmp" dir))) | |
6b3d752c SM |
4722 | ;; Pass in nil&nil rather than point-min&max |
4723 | ;; cause we're saving the whole buffer. | |
4724 | ;; write-region-annotate-functions may use it. | |
4725 | (write-region nil nil | |
44dce0fb RS |
4726 | tempname nil realname |
4727 | buffer-file-truename 'excl) | |
4728 | nil) | |
4729 | (file-already-exists t)) | |
4730 | ;; The file was somehow created by someone else between | |
4731 | ;; `make-temp-name' and `write-region', let's try again. | |
4732 | nil) | |
4733 | (setq succeed t)) | |
4734 | ;; Reset the umask. | |
4735 | (set-default-file-modes umask) | |
4736 | ;; If we failed, restore the buffer's modtime. | |
4737 | (unless succeed | |
4738 | (set-visited-file-modtime old-modtime))) | |
4739 | ;; Since we have created an entirely new file, | |
4740 | ;; make sure it gets the right permission bits set. | |
730df8db | 4741 | (setq setmodes (or setmodes |
574c05e2 | 4742 | (list (or (file-modes buffer-file-name) |
562ca538 | 4743 | (logand ?\666 umask)) |
7c3d167f | 4744 | (file-extended-attributes buffer-file-name) |
730df8db | 4745 | buffer-file-name))) |
f4a0f59b RS |
4746 | ;; We succeeded in writing the temp file, |
4747 | ;; so rename it. | |
4748 | (rename-file tempname buffer-file-name t)) | |
4749 | ;; If file not writable, see if we can make it writable | |
4750 | ;; temporarily while we write it. | |
4751 | ;; But no need to do so if we have just backed it up | |
4752 | ;; (setmodes is set) because that says we're superseding. | |
4753 | (cond ((and tempsetmodes (not setmodes)) | |
4754 | ;; Change the mode back, after writing. | |
574c05e2 | 4755 | (setq setmodes (list (file-modes buffer-file-name) |
7c3d167f | 4756 | (file-extended-attributes buffer-file-name) |
574c05e2 | 4757 | buffer-file-name)) |
ccad023b EZ |
4758 | ;; If set-file-extended-attributes fails, fall back on |
4759 | ;; set-file-modes. | |
4760 | (unless | |
4761 | (with-demoted-errors | |
4762 | (set-file-extended-attributes buffer-file-name | |
4763 | (nth 1 setmodes))) | |
4764 | (set-file-modes buffer-file-name | |
4765 | (logior (car setmodes) 128)))))) | |
f3f9e207 RS |
4766 | (let (success) |
4767 | (unwind-protect | |
6b3d752c SM |
4768 | ;; Pass in nil&nil rather than point-min&max to indicate |
4769 | ;; we're saving the buffer rather than just a region. | |
4770 | ;; write-region-annotate-functions may make us of it. | |
9dbda100 GM |
4771 | (let ((coding-system-for-write writecoding) |
4772 | (coding-system-require-warning nil)) | |
6b3d752c | 4773 | (write-region nil nil |
f3f9e207 RS |
4774 | buffer-file-name nil t buffer-file-truename) |
4775 | (setq success t)) | |
4776 | ;; If we get an error writing the new file, and we made | |
4777 | ;; the backup by renaming, undo the backing-up. | |
4778 | (and setmodes (not success) | |
0133dab9 | 4779 | (progn |
574c05e2 KK |
4780 | (rename-file (nth 2 setmodes) buffer-file-name t) |
4781 | (setq buffer-backed-up nil)))))) | |
87d26afc RS |
4782 | setmodes)) |
4783 | ||
66f782de GM |
4784 | (declare-function diff-no-select "diff" |
4785 | (old new &optional switches no-async buf)) | |
4786 | ||
1eeae2a1 | 4787 | (defvar save-some-buffers-action-alist |
9b106871 SM |
4788 | `((?\C-r |
4789 | ,(lambda (buf) | |
4790 | (if (not enable-recursive-minibuffers) | |
4791 | (progn (display-buffer buf) | |
4792 | (setq other-window-scroll-buffer buf)) | |
4793 | (view-buffer buf (lambda (_) (exit-recursive-edit))) | |
4794 | (recursive-edit)) | |
4795 | ;; Return nil to ask about BUF again. | |
4796 | nil) | |
ca0a881a | 4797 | ,(purecopy "view this buffer")) |
9b106871 | 4798 | (?d ,(lambda (buf) |
b9330108 | 4799 | (if (null (buffer-file-name buf)) |
9b106871 | 4800 | (message "Not applicable: no file") |
b2e44819 SM |
4801 | (require 'diff) ;for diff-no-select. |
4802 | (let ((diffbuf (diff-no-select (buffer-file-name buf) buf | |
4803 | nil 'noasync))) | |
4804 | (if (not enable-recursive-minibuffers) | |
4805 | (progn (display-buffer diffbuf) | |
4806 | (setq other-window-scroll-buffer diffbuf)) | |
4807 | (view-buffer diffbuf (lambda (_) (exit-recursive-edit))) | |
4808 | (recursive-edit)))) | |
9b106871 SM |
4809 | ;; Return nil to ask about BUF again. |
4810 | nil) | |
ca0a881a | 4811 | ,(purecopy "view changes in this buffer"))) |
1eeae2a1 | 4812 | "ACTION-ALIST argument used in call to `map-y-or-n-p'.") |
3029e594 | 4813 | (put 'save-some-buffers-action-alist 'risky-local-variable t) |
1eeae2a1 | 4814 | |
a1b0c2a7 RS |
4815 | (defvar buffer-save-without-query nil |
4816 | "Non-nil means `save-some-buffers' should save this buffer without asking.") | |
4817 | (make-variable-buffer-local 'buffer-save-without-query) | |
4818 | ||
ffc0e1ca | 4819 | (defun save-some-buffers (&optional arg pred) |
b4da00e9 | 4820 | "Save some modified file-visiting buffers. Asks user about each one. |
1eeae2a1 RS |
4821 | You can answer `y' to save, `n' not to save, `C-r' to look at the |
4822 | buffer in question with `view-buffer' before deciding or `d' to | |
126c9dda | 4823 | view the differences using `diff-buffer-with-file'. |
8fd9c174 | 4824 | |
afa8e9f6 GM |
4825 | This command first saves any buffers where `buffer-save-without-query' is |
4826 | non-nil, without asking. | |
4827 | ||
5bbbceb1 | 4828 | Optional argument (the prefix) non-nil means save all with no questions. |
ffc0e1ca AS |
4829 | Optional second argument PRED determines which buffers are considered: |
4830 | If PRED is nil, all the file-visiting buffers are considered. | |
4831 | If PRED is t, then certain non-file buffers will also be considered. | |
4832 | If PRED is a zero-argument function, it indicates for each buffer whether | |
1eeae2a1 RS |
4833 | to consider it or not when called with that buffer current. |
4834 | ||
4835 | See `save-some-buffers-action-alist' if you want to | |
4836 | change the additional actions you can take on files." | |
b4da00e9 | 4837 | (interactive "P") |
907482b9 | 4838 | (save-window-excursion |
c5f09daf | 4839 | (let* (queried autosaved-buffers |
a1b0c2a7 RS |
4840 | files-done abbrevs-done) |
4841 | (dolist (buffer (buffer-list)) | |
4842 | ;; First save any buffers that we're supposed to save unconditionally. | |
4843 | ;; That way the following code won't ask about them. | |
4844 | (with-current-buffer buffer | |
4845 | (when (and buffer-save-without-query (buffer-modified-p)) | |
c5f09daf | 4846 | (push (buffer-name) autosaved-buffers) |
a1b0c2a7 RS |
4847 | (save-buffer)))) |
4848 | ;; Ask about those buffers that merit it, | |
4849 | ;; and record the number thus saved. | |
4850 | (setq files-done | |
76d5492b | 4851 | (map-y-or-n-p |
9b106871 | 4852 | (lambda (buffer) |
be9acc26 CY |
4853 | ;; Note that killing some buffers may kill others via |
4854 | ;; hooks (e.g. Rmail and its viewing buffer). | |
4855 | (and (buffer-live-p buffer) | |
4856 | (buffer-modified-p buffer) | |
9b106871 SM |
4857 | (not (buffer-base-buffer buffer)) |
4858 | (or | |
4859 | (buffer-file-name buffer) | |
4860 | (and pred | |
4861 | (progn | |
4862 | (set-buffer buffer) | |
4863 | (and buffer-offer-save (> (buffer-size) 0))))) | |
4864 | (or (not (functionp pred)) | |
4865 | (with-current-buffer buffer (funcall pred))) | |
4866 | (if arg | |
4867 | t | |
4868 | (setq queried t) | |
4869 | (if (buffer-file-name buffer) | |
4870 | (format "Save file %s? " | |
4871 | (buffer-file-name buffer)) | |
4872 | (format "Save buffer %s? " | |
4873 | (buffer-name buffer)))))) | |
4874 | (lambda (buffer) | |
4875 | (with-current-buffer buffer | |
4876 | (save-buffer))) | |
4877 | (buffer-list) | |
76d5492b | 4878 | '("buffer" "buffers" "save") |
1eeae2a1 | 4879 | save-some-buffers-action-alist)) |
bf247b6e | 4880 | ;; Maybe to save abbrevs, and record whether |
a1b0c2a7 RS |
4881 | ;; we either saved them or asked to. |
4882 | (and save-abbrevs abbrevs-changed | |
4883 | (progn | |
4884 | (if (or arg | |
4885 | (eq save-abbrevs 'silently) | |
9aea757b | 4886 | (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name))) |
a1b0c2a7 RS |
4887 | (write-abbrev-file nil)) |
4888 | ;; Don't keep bothering user if he says no. | |
4889 | (setq abbrevs-changed nil) | |
4890 | (setq abbrevs-done t))) | |
76d5492b | 4891 | (or queried (> files-done 0) abbrevs-done |
c5f09daf DE |
4892 | (cond |
4893 | ((null autosaved-buffers) | |
4894 | (message "(No files need saving)")) | |
4895 | ((= (length autosaved-buffers) 1) | |
4896 | (message "(Saved %s)" (car autosaved-buffers))) | |
4897 | (t | |
4898 | (message "(Saved %d files: %s)" | |
4899 | (length autosaved-buffers) | |
4900 | (mapconcat 'identity autosaved-buffers ", ")))))))) | |
b4da00e9 RM |
4901 | \f |
4902 | (defun not-modified (&optional arg) | |
4903 | "Mark current buffer as unmodified, not needing to be saved. | |
8fc29035 | 4904 | With prefix ARG, mark buffer as modified, so \\[save-buffer] will save. |
a641f9a1 RM |
4905 | |
4906 | It is not a good idea to use this function in Lisp programs, because it | |
4907 | prints a message in the minibuffer. Instead, use `set-buffer-modified-p'." | |
b4da00e9 RM |
4908 | (interactive "P") |
4909 | (message (if arg "Modification-flag set" | |
4910 | "Modification-flag cleared")) | |
4911 | (set-buffer-modified-p arg)) | |
4912 | ||
35e62fc9 SM |
4913 | (defun toggle-read-only (&optional arg interactive) |
4914 | (declare (obsolete read-only-mode "24.3")) | |
4915 | (interactive (list current-prefix-arg t)) | |
4916 | (if interactive | |
4917 | (call-interactively 'read-only-mode) | |
4918 | (read-only-mode (or arg 'toggle)))) | |
b4da00e9 | 4919 | |
912192d1 | 4920 | (defun insert-file (filename) |
b4da00e9 RM |
4921 | "Insert contents of file FILENAME into buffer after point. |
4922 | Set mark after the inserted text. | |
4923 | ||
4924 | This function is meant for the user to run interactively. | |
4925 | Don't call it from programs! Use `insert-file-contents' instead. | |
4926 | \(Its calling sequence is different; see its documentation)." | |
912192d1 | 4927 | (interactive "*fInsert file: ") |
3a64a3cf | 4928 | (insert-file-1 filename #'insert-file-contents)) |
b4da00e9 | 4929 | |
912192d1 | 4930 | (defun append-to-file (start end filename) |
b4da00e9 RM |
4931 | "Append the contents of the region to the end of file FILENAME. |
4932 | When called from a function, expects three arguments, | |
d8c0d419 EZ |
4933 | START, END and FILENAME. START and END are normally buffer positions |
4934 | specifying the part of the buffer to write. | |
4935 | If START is nil, that means to use the entire buffer contents. | |
4936 | If START is a string, then output that string to the file | |
4937 | instead of any buffer contents; END is ignored. | |
4938 | ||
4939 | This does character code conversion and applies annotations | |
4940 | like `write-region' does." | |
912192d1 KH |
4941 | (interactive "r\nFAppend to file: ") |
4942 | (write-region start end filename t)) | |
b4da00e9 RM |
4943 | |
4944 | (defun file-newest-backup (filename) | |
4945 | "Return most recent backup file for FILENAME or nil if no backups exist." | |
ffc0e1ca AS |
4946 | ;; `make-backup-file-name' will get us the right directory for |
4947 | ;; ordinary or numeric backups. It might create a directory for | |
4948 | ;; backups as a side-effect, according to `backup-directory-alist'. | |
e31cfca5 | 4949 | (let* ((filename (file-name-sans-versions |
783bf210 | 4950 | (make-backup-file-name (expand-file-name filename)))) |
b4da00e9 RM |
4951 | (file (file-name-nondirectory filename)) |
4952 | (dir (file-name-directory filename)) | |
4953 | (comp (file-name-all-completions file dir)) | |
cf7e94a0 RS |
4954 | (newest nil) |
4955 | tem) | |
b4da00e9 | 4956 | (while comp |
ffc0e1ca | 4957 | (setq tem (pop comp)) |
cf7e94a0 RS |
4958 | (cond ((and (backup-file-name-p tem) |
4959 | (string= (file-name-sans-versions tem) file)) | |
4960 | (setq tem (concat dir tem)) | |
4961 | (if (or (null newest) | |
4962 | (file-newer-than-file-p tem newest)) | |
4963 | (setq newest tem))))) | |
b4da00e9 RM |
4964 | newest)) |
4965 | ||
4966 | (defun rename-uniquely () | |
4967 | "Rename current buffer to a similar name not already taken. | |
4968 | This function is useful for creating multiple shell process buffers | |
cf3aa21b GM |
4969 | or multiple mail buffers, etc. |
4970 | ||
4971 | Note that some commands, in particular those based on `compilation-mode' | |
4972 | \(`compile', `grep', etc.) will reuse the current buffer if it has the | |
4973 | appropriate mode even if it has been renamed. So as well as renaming | |
4974 | the buffer, you also need to switch buffers before running another | |
4975 | instance of such commands." | |
b4da00e9 | 4976 | (interactive) |
40eb8038 | 4977 | (save-match-data |
e0df3aef KH |
4978 | (let ((base-name (buffer-name))) |
4979 | (and (string-match "<[0-9]+>\\'" base-name) | |
4980 | (not (and buffer-file-name | |
4981 | (string= base-name | |
4982 | (file-name-nondirectory buffer-file-name)))) | |
4983 | ;; If the existing buffer name has a <NNN>, | |
4984 | ;; which isn't part of the file name (if any), | |
4985 | ;; then get rid of that. | |
4986 | (setq base-name (substring base-name 0 (match-beginning 0)))) | |
4987 | (rename-buffer (generate-new-buffer-name base-name)) | |
3941fe2c | 4988 | (force-mode-line-update)))) |
5bbbceb1 | 4989 | |
4e43240a | 4990 | (defun make-directory (dir &optional parents) |
9d1f18b5 EZ |
4991 | "Create the directory DIR and optionally any nonexistent parent dirs. |
4992 | If DIR already exists as a directory, signal an error, unless | |
4993 | PARENTS is non-nil. | |
789cb0f9 | 4994 | |
9d1f18b5 EZ |
4995 | Interactively, the default choice of directory to create is the |
4996 | current buffer's default directory. That is useful when you have | |
4997 | visited a file in a nonexistent directory. | |
5ce8bb89 | 4998 | |
9d1f18b5 EZ |
4999 | Noninteractively, the second (optional) argument PARENTS, if |
5000 | non-nil, says whether to create parent directories that don't | |
bd2fcc8d LMI |
5001 | exist. Interactively, this happens by default. |
5002 | ||
5003 | If creating the directory or directories fail, an error will be | |
5004 | raised." | |
5ce8bb89 RS |
5005 | (interactive |
5006 | (list (read-file-name "Make directory: " default-directory default-directory | |
5007 | nil nil) | |
5008 | t)) | |
ee291b46 RS |
5009 | ;; If default-directory is a remote directory, |
5010 | ;; make sure we find its make-directory handler. | |
5011 | (setq dir (expand-file-name dir)) | |
6eaebaa2 | 5012 | (let ((handler (find-file-name-handler dir 'make-directory))) |
4e43240a RS |
5013 | (if handler |
5014 | (funcall handler 'make-directory dir parents) | |
5015 | (if (not parents) | |
5016 | (make-directory-internal dir) | |
5017 | (let ((dir (directory-file-name (expand-file-name dir))) | |
5018 | create-list) | |
bb4a52db JR |
5019 | (while (and (not (file-exists-p dir)) |
5020 | ;; If directory is its own parent, then we can't | |
5021 | ;; keep looping forever | |
5022 | (not (equal dir | |
5023 | (directory-file-name | |
5024 | (file-name-directory dir))))) | |
76d5492b | 5025 | (setq create-list (cons dir create-list) |
4e43240a RS |
5026 | dir (directory-file-name (file-name-directory dir)))) |
5027 | (while create-list | |
5028 | (make-directory-internal (car create-list)) | |
5029 | (setq create-list (cdr create-list)))))))) | |
96ad4c35 | 5030 | |
0e1f2ee6 MA |
5031 | (defconst directory-files-no-dot-files-regexp |
5032 | "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*" | |
1603358c | 5033 | "Regexp matching any file name except \".\" and \"..\".") |
0e1f2ee6 | 5034 | |
f1a5d776 | 5035 | (defun delete-directory (directory &optional recursive trash) |
96ad4c35 | 5036 | "Delete the directory named DIRECTORY. Does not follow symlinks. |
f1a5d776 CY |
5037 | If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well. |
5038 | TRASH non-nil means to trash the directory instead, provided | |
5039 | `delete-by-moving-to-trash' is non-nil. | |
5040 | ||
5041 | When called interactively, TRASH is t if no prefix argument is | |
5042 | given. With a prefix argument, TRASH is nil." | |
96ad4c35 | 5043 | (interactive |
f1a5d776 CY |
5044 | (let* ((trashing (and delete-by-moving-to-trash |
5045 | (null current-prefix-arg))) | |
5046 | (dir (expand-file-name | |
7e27ce9c | 5047 | (read-directory-name |
f1a5d776 CY |
5048 | (if trashing |
5049 | "Move directory to trash: " | |
5050 | "Delete directory: ") | |
5051 | default-directory default-directory nil nil)))) | |
96ad4c35 | 5052 | (list dir |
0e1f2ee6 | 5053 | (if (directory-files dir nil directory-files-no-dot-files-regexp) |
96ad4c35 | 5054 | (y-or-n-p |
9aea757b CY |
5055 | (format "Directory `%s' is not empty, really %s? " |
5056 | dir (if trashing "trash" "delete"))) | |
f1a5d776 CY |
5057 | nil) |
5058 | (null current-prefix-arg)))) | |
8e692050 MA |
5059 | ;; If default-directory is a remote directory, make sure we find its |
5060 | ;; delete-directory handler. | |
96ad4c35 MA |
5061 | (setq directory (directory-file-name (expand-file-name directory))) |
5062 | (let ((handler (find-file-name-handler directory 'delete-directory))) | |
8b0e68ea CY |
5063 | (cond |
5064 | (handler | |
5065 | (funcall handler 'delete-directory directory recursive)) | |
f1a5d776 | 5066 | ((and delete-by-moving-to-trash trash) |
8b0e68ea CY |
5067 | ;; Only move non-empty dir to trash if recursive deletion was |
5068 | ;; requested. This mimics the non-`delete-by-moving-to-trash' | |
5069 | ;; case, where the operation fails in delete-directory-internal. | |
5070 | ;; As `move-file-to-trash' trashes directories (empty or | |
5071 | ;; otherwise) as a unit, we do not need to recurse here. | |
5072 | (if (and (not recursive) | |
5073 | ;; Check if directory is empty apart from "." and "..". | |
5074 | (directory-files | |
5075 | directory 'full directory-files-no-dot-files-regexp)) | |
5076 | (error "Directory is not empty, not moving to trash") | |
5077 | (move-file-to-trash directory))) | |
c80e3b4a | 5078 | ;; Otherwise, call ourselves recursively if needed. |
8b0e68ea | 5079 | (t |
96ad4c35 | 5080 | (if (and recursive (not (file-symlink-p directory))) |
8b0e68ea CY |
5081 | (mapc (lambda (file) |
5082 | ;; This test is equivalent to | |
5083 | ;; (and (file-directory-p fn) (not (file-symlink-p fn))) | |
5084 | ;; but more efficient | |
5085 | (if (eq t (car (file-attributes file))) | |
f1a5d776 CY |
5086 | (delete-directory file recursive nil) |
5087 | (delete-file file nil))) | |
8b0e68ea CY |
5088 | ;; We do not want to delete "." and "..". |
5089 | (directory-files | |
1d78a746 CY |
5090 | directory 'full directory-files-no-dot-files-regexp))) |
5091 | (delete-directory-internal directory))))) | |
96ad4c35 | 5092 | |
96b49301 | 5093 | (defun file-equal-p (file1 file2) |
a032a702 MA |
5094 | "Return non-nil if files FILE1 and FILE2 name the same file. |
5095 | If FILE1 or FILE2 does not exist, the return value is unspecified." | |
96b49301 | 5096 | (let ((handler (or (find-file-name-handler file1 'file-equal-p) |
5097 | (find-file-name-handler file2 'file-equal-p)))) | |
25b2e303 | 5098 | (if handler |
96b49301 | 5099 | (funcall handler 'file-equal-p file1 file2) |
a032a702 MA |
5100 | (let (f1-attr f2-attr) |
5101 | (and (setq f1-attr (file-attributes (file-truename file1))) | |
5102 | (setq f2-attr (file-attributes (file-truename file2))) | |
5103 | (equal f1-attr f2-attr)))))) | |
25b2e303 | 5104 | |
42ee526b CY |
5105 | (defun file-in-directory-p (file dir) |
5106 | "Return non-nil if FILE is in DIR or a subdirectory of DIR. | |
5107 | A directory is considered to be \"in\" itself. | |
5108 | Return nil if DIR is not an existing directory." | |
5109 | (let ((handler (or (find-file-name-handler file 'file-in-directory-p) | |
5110 | (find-file-name-handler dir 'file-in-directory-p)))) | |
25b2e303 | 5111 | (if handler |
42ee526b CY |
5112 | (funcall handler 'file-in-directory-p file dir) |
5113 | (when (file-directory-p dir) ; DIR must exist. | |
5114 | (setq file (file-truename file) | |
5115 | dir (file-truename dir)) | |
5116 | (let ((ls1 (split-string file "/" t)) | |
5117 | (ls2 (split-string dir "/" t)) | |
5118 | (root (if (string-match "\\`/" file) "/" "")) | |
9a4888c0 CY |
5119 | (mismatch nil)) |
5120 | (while (and ls1 ls2 (not mismatch)) | |
5121 | (if (string-equal (car ls1) (car ls2)) | |
5122 | (setq root (concat root (car ls1) "/")) | |
5123 | (setq mismatch t)) | |
5124 | (setq ls1 (cdr ls1) | |
5125 | ls2 (cdr ls2))) | |
5126 | (unless mismatch | |
42ee526b | 5127 | (file-equal-p root dir))))))) |
25b2e303 | 5128 | |
470d996d | 5129 | (defun copy-directory (directory newname &optional keep-time parents copy-contents) |
8e692050 | 5130 | "Copy DIRECTORY to NEWNAME. Both args must be strings. |
8e692050 MA |
5131 | This function always sets the file modes of the output files to match |
5132 | the corresponding input file. | |
5133 | ||
5134 | The third arg KEEP-TIME non-nil means give the output files the same | |
5135 | last-modified time as the old ones. (This works on only some systems.) | |
5136 | ||
5137 | A prefix arg makes KEEP-TIME non-nil. | |
5138 | ||
8e692050 MA |
5139 | Noninteractively, the last argument PARENTS says whether to |
5140 | create parent directories if they don't exist. Interactively, | |
470d996d TV |
5141 | this happens by default. |
5142 | ||
5143 | If NEWNAME names an existing directory, copy DIRECTORY as a | |
5144 | subdirectory there. However, if called from Lisp with a non-nil | |
5145 | optional argument COPY-CONTENTS, copy the contents of DIRECTORY | |
5146 | directly into NEWNAME instead." | |
8e692050 MA |
5147 | (interactive |
5148 | (let ((dir (read-directory-name | |
5149 | "Copy directory: " default-directory default-directory t nil))) | |
5150 | (list dir | |
7e27ce9c | 5151 | (read-directory-name |
8e692050 MA |
5152 | (format "Copy directory %s to: " dir) |
5153 | default-directory default-directory nil nil) | |
470d996d | 5154 | current-prefix-arg t nil))) |
42ee526b | 5155 | (when (file-in-directory-p newname directory) |
25b2e303 | 5156 | (error "Cannot copy `%s' into its subdirectory `%s'" |
5157 | directory newname)) | |
8e692050 MA |
5158 | ;; If default-directory is a remote directory, make sure we find its |
5159 | ;; copy-directory handler. | |
5160 | (let ((handler (or (find-file-name-handler directory 'copy-directory) | |
5161 | (find-file-name-handler newname 'copy-directory)))) | |
5162 | (if handler | |
25b2e303 | 5163 | (funcall handler 'copy-directory directory |
5164 | newname keep-time parents copy-contents) | |
8e692050 MA |
5165 | |
5166 | ;; Compute target name. | |
5167 | (setq directory (directory-file-name (expand-file-name directory)) | |
5168 | newname (directory-file-name (expand-file-name newname))) | |
82d84d3f | 5169 | |
470d996d TV |
5170 | (cond ((not (file-directory-p newname)) |
5171 | ;; If NEWNAME is not an existing directory, create it; | |
5172 | ;; that is where we will copy the files of DIRECTORY. | |
96b49301 | 5173 | (make-directory newname parents)) |
470d996d TV |
5174 | ;; If NEWNAME is an existing directory and COPY-CONTENTS |
5175 | ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME]. | |
5176 | ((not copy-contents) | |
5177 | (setq newname (expand-file-name | |
5178 | (file-name-nondirectory | |
5179 | (directory-file-name directory)) | |
5180 | newname)) | |
5181 | (and (file-exists-p newname) | |
5182 | (not (file-directory-p newname)) | |
5183 | (error "Cannot overwrite non-directory %s with a directory" | |
5184 | newname)) | |
5185 | (make-directory newname t))) | |
0e1f2ee6 | 5186 | |
8e692050 | 5187 | ;; Copy recursively. |
6fa1f651 CY |
5188 | (dolist (file |
5189 | ;; We do not want to copy "." and "..". | |
5190 | (directory-files directory 'full | |
5191 | directory-files-no-dot-files-regexp)) | |
40311efc TV |
5192 | (let ((target (expand-file-name (file-name-nondirectory file) newname)) |
5193 | (filetype (car (file-attributes file)))) | |
5194 | (cond | |
5195 | ((eq filetype t) ; Directory but not a symlink. | |
5196 | (copy-directory file newname keep-time parents)) | |
5197 | ((stringp filetype) ; Symbolic link | |
5198 | (make-symbolic-link filetype target t)) | |
5199 | ((copy-file file target t keep-time))))) | |
8e692050 MA |
5200 | |
5201 | ;; Set directory attributes. | |
e74f1bb6 MA |
5202 | (let ((modes (file-modes directory)) |
5203 | (times (and keep-time (nth 5 (file-attributes directory))))) | |
5204 | (if modes (set-file-modes newname modes)) | |
5205 | (if times (set-file-times newname times)))))) | |
ead5edc0 GM |
5206 | |
5207 | \f | |
5208 | ;; At time of writing, only info uses this. | |
5209 | (defun prune-directory-list (dirs &optional keep reject) | |
5210 | "Return a copy of DIRS with all non-existent directories removed. | |
5211 | The optional argument KEEP is a list of directories to retain even if | |
5212 | they don't exist, and REJECT is a list of directories to remove from | |
5213 | DIRS, even if they exist; REJECT takes precedence over KEEP. | |
5214 | ||
5215 | Note that membership in REJECT and KEEP is checked using simple string | |
5216 | comparison." | |
5217 | (apply #'nconc | |
5218 | (mapcar (lambda (dir) | |
5219 | (and (not (member dir reject)) | |
5220 | (or (member dir keep) (file-directory-p dir)) | |
5221 | (list dir))) | |
5222 | dirs))) | |
5223 | ||
b4da00e9 RM |
5224 | \f |
5225 | (put 'revert-buffer-function 'permanent-local t) | |
5226 | (defvar revert-buffer-function nil | |
0973d78b RS |
5227 | "Function to use to revert this buffer, or nil to do the default. |
5228 | The function receives two arguments IGNORE-AUTO and NOCONFIRM, | |
5229 | which are the arguments that `revert-buffer' received.") | |
b4da00e9 RM |
5230 | |
5231 | (put 'revert-buffer-insert-file-contents-function 'permanent-local t) | |
5232 | (defvar revert-buffer-insert-file-contents-function nil | |
5233 | "Function to use to insert contents when reverting this buffer. | |
5234 | Gets two args, first the nominal file name to use, | |
2df32500 RS |
5235 | and second, t if reading the auto-save file. |
5236 | ||
5237 | The function you specify is responsible for updating (or preserving) point.") | |
b4da00e9 | 5238 | |
b0dc9757 LT |
5239 | (defvar buffer-stale-function nil |
5240 | "Function to check whether a non-file buffer needs reverting. | |
5241 | This should be a function with one optional argument NOCONFIRM. | |
44dce0fb | 5242 | Auto Revert Mode passes t for NOCONFIRM. The function should return |
8b0b6932 LT |
5243 | non-nil if the buffer should be reverted. A return value of |
5244 | `fast' means that the need for reverting was not checked, but | |
5245 | that reverting the buffer is fast. The buffer is current when | |
5246 | this function is called. | |
b0dc9757 | 5247 | |
4f8453ae LT |
5248 | The idea behind the NOCONFIRM argument is that it should be |
5249 | non-nil if the buffer is going to be reverted without asking the | |
5250 | user. In such situations, one has to be careful with potentially | |
c90dcdd5 LT |
5251 | time consuming operations. |
5252 | ||
5253 | For more information on how this variable is used by Auto Revert mode, | |
b3a59350 | 5254 | see Info node `(emacs)Supporting additional buffers'.") |
b0dc9757 | 5255 | |
5f76e7d4 KH |
5256 | (defvar before-revert-hook nil |
5257 | "Normal hook for `revert-buffer' to run before reverting. | |
5258 | If `revert-buffer-function' is used to override the normal revert | |
5259 | mechanism, this hook is not used.") | |
5260 | ||
5261 | (defvar after-revert-hook nil | |
5262 | "Normal hook for `revert-buffer' to run after reverting. | |
5263 | Note that the hook value that it runs is the value that was in effect | |
5264 | before reverting; that makes a difference if you have buffer-local | |
5265 | hook functions. | |
5266 | ||
5267 | If `revert-buffer-function' is used to override the normal revert | |
5268 | mechanism, this hook is not used.") | |
5269 | ||
3e214b50 JB |
5270 | (defvar revert-buffer-in-progress-p nil |
5271 | "Non-nil if a `revert-buffer' operation is in progress, nil otherwise. | |
5272 | This is true even if a `revert-buffer-function' is being used.") | |
5273 | ||
1554c03b RS |
5274 | (defvar revert-buffer-internal-hook) |
5275 | ||
9a30563f | 5276 | (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes) |
7e7c9c4e | 5277 | "Replace current buffer text with the text of the visited file on disk. |
b4da00e9 | 5278 | This undoes all changes since the file was visited or saved. |
8c0e7b73 JB |
5279 | With a prefix argument, offer to revert from latest auto-save file, if |
5280 | that is more recent than the visited file. | |
1ab31687 | 5281 | |
0dff8975 VJL |
5282 | This command also implements an interface for special buffers |
5283 | that contain text which doesn't come from a file, but reflects | |
5284 | some other data instead (e.g. Dired buffers, `buffer-list' | |
8fc29035 JB |
5285 | buffers). This is done via the variable `revert-buffer-function'. |
5286 | In these cases, it should reconstruct the buffer contents from the | |
5287 | appropriate data. | |
7e7c9c4e | 5288 | |
65ee6096 | 5289 | When called from Lisp, the first argument is IGNORE-AUTO; only offer |
1ab31687 JB |
5290 | to revert from the auto-save file when this is nil. Note that the |
5291 | sense of this argument is the reverse of the prefix argument, for the | |
5292 | sake of backward compatibility. IGNORE-AUTO is optional, defaulting | |
5293 | to nil. | |
5294 | ||
8fc29035 | 5295 | Optional second argument NOCONFIRM means don't ask for confirmation |
06b60517 | 5296 | at all. (The variable `revert-without-query' offers another way to |
518dc5be | 5297 | revert buffers without querying for confirmation.) |
b4da00e9 | 5298 | |
5b2b26d5 RS |
5299 | Optional third argument PRESERVE-MODES non-nil means don't alter |
5300 | the files modes. Normally we reinitialize them using `normal-mode'. | |
5301 | ||
8f05da42 GM |
5302 | This function binds `revert-buffer-in-progress-p' non-nil while it operates. |
5303 | ||
8c0e7b73 | 5304 | If the value of `revert-buffer-function' is non-nil, it is called to |
7e7c9c4e RS |
5305 | do all the work for this command. Otherwise, the hooks |
5306 | `before-revert-hook' and `after-revert-hook' are run at the beginning | |
5307 | and the end, and if `revert-buffer-insert-file-contents-function' is | |
5308 | non-nil, it is called instead of rereading visited file contents." | |
fb6208a6 | 5309 | |
1ab31687 JB |
5310 | ;; I admit it's odd to reverse the sense of the prefix argument, but |
5311 | ;; there is a lot of code out there which assumes that the first | |
5312 | ;; argument should be t to avoid consulting the auto-save file, and | |
5313 | ;; there's no straightforward way to encourage authors to notice a | |
5314 | ;; reversal of the argument sense. So I'm just changing the user | |
5315 | ;; interface, but leaving the programmatic interface the same. | |
e0867e99 | 5316 | (interactive (list (not current-prefix-arg))) |
b4da00e9 | 5317 | (if revert-buffer-function |
3e214b50 JB |
5318 | (let ((revert-buffer-in-progress-p t)) |
5319 | (funcall revert-buffer-function ignore-auto noconfirm)) | |
44dce0fb RS |
5320 | (with-current-buffer (or (buffer-base-buffer (current-buffer)) |
5321 | (current-buffer)) | |
3e214b50 JB |
5322 | (let* ((revert-buffer-in-progress-p t) |
5323 | (auto-save-p (and (not ignore-auto) | |
44dce0fb RS |
5324 | (recent-auto-save-p) |
5325 | buffer-auto-save-file-name | |
5326 | (file-readable-p buffer-auto-save-file-name) | |
5327 | (y-or-n-p | |
5328 | "Buffer has been auto-saved recently. Revert from auto-save file? "))) | |
5329 | (file-name (if auto-save-p | |
5330 | buffer-auto-save-file-name | |
5331 | buffer-file-name))) | |
5332 | (cond ((null file-name) | |
5333 | (error "Buffer does not seem to be associated with any file")) | |
5334 | ((or noconfirm | |
5335 | (and (not (buffer-modified-p)) | |
518dc5be EZ |
5336 | (catch 'found |
5337 | (dolist (regexp revert-without-query) | |
5338 | (when (string-match regexp file-name) | |
5339 | (throw 'found t))))) | |
9aea757b CY |
5340 | (yes-or-no-p (format "Revert buffer from file %s? " |
5341 | file-name))) | |
44dce0fb RS |
5342 | (run-hooks 'before-revert-hook) |
5343 | ;; If file was backed up but has changed since, | |
528c56e2 | 5344 | ;; we should make another backup. |
44dce0fb RS |
5345 | (and (not auto-save-p) |
5346 | (not (verify-visited-file-modtime (current-buffer))) | |
5347 | (setq buffer-backed-up nil)) | |
44dce0fb RS |
5348 | ;; Effectively copy the after-revert-hook status, |
5349 | ;; since after-find-file will clobber it. | |
5350 | (let ((global-hook (default-value 'after-revert-hook)) | |
518dc5be EZ |
5351 | (local-hook (when (local-variable-p 'after-revert-hook) |
5352 | after-revert-hook)) | |
5353 | (inhibit-read-only t)) | |
5354 | (cond | |
5355 | (revert-buffer-insert-file-contents-function | |
5356 | (unless (eq buffer-undo-list t) | |
5357 | ;; Get rid of all undo records for this buffer. | |
5358 | (setq buffer-undo-list nil)) | |
5359 | ;; Don't make undo records for the reversion. | |
5360 | (let ((buffer-undo-list t)) | |
5361 | (funcall revert-buffer-insert-file-contents-function | |
5362 | file-name auto-save-p))) | |
5363 | ((not (file-exists-p file-name)) | |
5364 | (error (if buffer-file-number | |
5365 | "File %s no longer exists!" | |
5366 | "Cannot revert nonexistent file %s") | |
5367 | file-name)) | |
b2d239c1 RS |
5368 | ((not (file-readable-p file-name)) |
5369 | (error (if buffer-file-number | |
5370 | "File %s no longer readable!" | |
5371 | "Cannot revert unreadable file %s") | |
5372 | file-name)) | |
518dc5be EZ |
5373 | (t |
5374 | ;; Bind buffer-file-name to nil | |
5375 | ;; so that we don't try to lock the file. | |
5376 | (let ((buffer-file-name nil)) | |
5377 | (or auto-save-p | |
5378 | (unlock-buffer))) | |
5379 | (widen) | |
5380 | (let ((coding-system-for-read | |
44e97401 | 5381 | ;; Auto-saved file should be read by Emacs's |
518dc5be EZ |
5382 | ;; internal coding. |
5383 | (if auto-save-p 'auto-save-coding | |
5384 | (or coding-system-for-read | |
86c507f7 KH |
5385 | (and |
5386 | buffer-file-coding-system-explicit | |
5387 | (car buffer-file-coding-system-explicit)))))) | |
e1ee3b54 | 5388 | (if (and (not enable-multibyte-characters) |
52f9b751 | 5389 | coding-system-for-read |
e1ee3b54 KH |
5390 | (not (memq (coding-system-base |
5391 | coding-system-for-read) | |
5392 | '(no-conversion raw-text)))) | |
5393 | ;; As a coding system suitable for multibyte | |
5394 | ;; buffer is specified, make the current | |
5395 | ;; buffer multibyte. | |
5396 | (set-buffer-multibyte t)) | |
5397 | ||
518dc5be EZ |
5398 | ;; This force after-insert-file-set-coding |
5399 | ;; (called from insert-file-contents) to set | |
5400 | ;; buffer-file-coding-system to a proper value. | |
5401 | (kill-local-variable 'buffer-file-coding-system) | |
5402 | ||
5403 | ;; Note that this preserves point in an intelligent way. | |
5404 | (if preserve-modes | |
5405 | (let ((buffer-file-format buffer-file-format)) | |
5406 | (insert-file-contents file-name (not auto-save-p) | |
5407 | nil nil t)) | |
5408 | (insert-file-contents file-name (not auto-save-p) | |
2a29c409 | 5409 | nil nil t))))) |
44dce0fb RS |
5410 | ;; Recompute the truename in case changes in symlinks |
5411 | ;; have changed the truename. | |
5412 | (setq buffer-file-truename | |
5413 | (abbreviate-file-name (file-truename buffer-file-name))) | |
3e214b50 | 5414 | (after-find-file nil nil t nil preserve-modes) |
44dce0fb RS |
5415 | ;; Run after-revert-hook as it was before we reverted. |
5416 | (setq-default revert-buffer-internal-hook global-hook) | |
518dc5be | 5417 | (if local-hook |
44dce0fb RS |
5418 | (set (make-local-variable 'revert-buffer-internal-hook) |
5419 | local-hook) | |
5420 | (kill-local-variable 'revert-buffer-internal-hook)) | |
5421 | (run-hooks 'revert-buffer-internal-hook)) | |
5422 | t)))))) | |
b4da00e9 | 5423 | |
64d18e8f RS |
5424 | (defun recover-this-file () |
5425 | "Recover the visited file--get contents from its last auto-save file." | |
5426 | (interactive) | |
5427 | (recover-file buffer-file-name)) | |
5428 | ||
b4da00e9 RM |
5429 | (defun recover-file (file) |
5430 | "Visit file FILE, but get contents from its last auto-save file." | |
10f7c7fc RS |
5431 | ;; Actually putting the file name in the minibuffer should be used |
5432 | ;; only rarely. | |
5433 | ;; Not just because users often use the default. | |
e1dadc17 | 5434 | (interactive "FRecover file: ") |
b4da00e9 | 5435 | (setq file (expand-file-name file)) |
f7da6740 | 5436 | (if (auto-save-file-name-p (file-name-nondirectory file)) |
4e163715 | 5437 | (error "%s is an auto-save file" (abbreviate-file-name file))) |
b4da00e9 RM |
5438 | (let ((file-name (let ((buffer-file-name file)) |
5439 | (make-auto-save-file-name)))) | |
945e1965 RS |
5440 | (cond ((if (file-exists-p file) |
5441 | (not (file-newer-than-file-p file-name file)) | |
5442 | (not (file-exists-p file-name))) | |
4e163715 SM |
5443 | (error "Auto-save file %s not current" |
5444 | (abbreviate-file-name file-name))) | |
c5e28e39 MR |
5445 | ((with-temp-buffer-window |
5446 | "*Directory*" nil | |
5447 | #'(lambda (window _value) | |
5448 | (with-selected-window window | |
5449 | (unwind-protect | |
5450 | (yes-or-no-p (format "Recover auto save file %s? " file-name)) | |
5451 | (when (window-live-p window) | |
5452 | (quit-restore-window window 'kill))))) | |
5453 | (with-current-buffer standard-output | |
5454 | (let ((switches dired-listing-switches)) | |
5455 | (if (file-symlink-p file) | |
5456 | (setq switches (concat switches " -L"))) | |
5457 | ;; Use insert-directory-safely, not insert-directory, | |
5458 | ;; because these files might not exist. In particular, | |
5459 | ;; FILE might not exist if the auto-save file was for | |
5460 | ;; a buffer that didn't visit a file, such as "*mail*". | |
5461 | ;; The code in v20.x called `ls' directly, so we need | |
5462 | ;; to emulate what `ls' did in that case. | |
5463 | (insert-directory-safely file switches) | |
5464 | (insert-directory-safely file-name switches)))) | |
b4da00e9 | 5465 | (switch-to-buffer (find-file-noselect file t)) |
518dc5be | 5466 | (let ((inhibit-read-only t) |
1e87edf5 KH |
5467 | ;; Keep the current buffer-file-coding-system. |
5468 | (coding-system buffer-file-coding-system) | |
1d0ec0d1 | 5469 | ;; Auto-saved file should be read with special coding. |
77619f8e | 5470 | (coding-system-for-read 'auto-save-coding)) |
b4da00e9 | 5471 | (erase-buffer) |
1e87edf5 KH |
5472 | (insert-file-contents file-name nil) |
5473 | (set-buffer-file-coding-system coding-system)) | |
8cfb9d46 | 5474 | (after-find-file nil nil t)) |
71873e2b | 5475 | (t (user-error "Recover-file cancelled"))))) |
b4da00e9 | 5476 | |
6598027d | 5477 | (defun recover-session () |
9aee5392 RS |
5478 | "Recover auto save files from a previous Emacs session. |
5479 | This command first displays a Dired buffer showing you the | |
5480 | previous sessions that you could recover from. | |
5481 | To choose one, move point to the proper line and then type C-c C-c. | |
5482 | Then you'll be asked about a number of files to recover." | |
5483 | (interactive) | |
363a5030 RS |
5484 | (if (null auto-save-list-file-prefix) |
5485 | (error "You set `auto-save-list-file-prefix' to disable making session files")) | |
ffc0e1ca AS |
5486 | (let ((dir (file-name-directory auto-save-list-file-prefix))) |
5487 | (unless (file-directory-p dir) | |
194600a8 JPW |
5488 | (make-directory dir t)) |
5489 | (unless (directory-files dir nil | |
5490 | (concat "\\`" (regexp-quote | |
5491 | (file-name-nondirectory | |
5492 | auto-save-list-file-prefix))) | |
5493 | t) | |
5494 | (error "No previous sessions to recover"))) | |
6f4983e6 | 5495 | (let ((ls-lisp-support-shell-wildcards t)) |
7b3478a5 | 5496 | (dired (concat auto-save-list-file-prefix "*") |
254c37a5 | 5497 | (concat dired-listing-switches " -t"))) |
5781e949 CY |
5498 | (use-local-map (nconc (make-sparse-keymap) (current-local-map))) |
5499 | (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish) | |
05e076c7 AS |
5500 | (save-excursion |
5501 | (goto-char (point-min)) | |
5502 | (or (looking-at " Move to the session you want to recover,") | |
5503 | (let ((inhibit-read-only t)) | |
5504 | ;; Each line starts with a space | |
5505 | ;; so that Font Lock mode won't highlight the first character. | |
5781e949 CY |
5506 | (insert " To recover a session, move to it and type C-c C-c.\n" |
5507 | (substitute-command-keys | |
5508 | " To delete a session file, type \ | |
5509 | \\[dired-flag-file-deletion] on its line to flag | |
5510 | the file for deletion, then \\[dired-do-flagged-delete] to \ | |
5511 | delete flagged files.\n\n")))))) | |
9aee5392 | 5512 | |
80280bb7 | 5513 | (defun recover-session-finish () |
9aee5392 RS |
5514 | "Choose one saved session to recover auto-save files from. |
5515 | This command is used in the special Dired buffer created by | |
80280bb7 | 5516 | \\[recover-session]." |
9aee5392 RS |
5517 | (interactive) |
5518 | ;; Get the name of the session file to recover from. | |
5519 | (let ((file (dired-get-filename)) | |
953a03b2 | 5520 | files |
9aee5392 | 5521 | (buffer (get-buffer-create " *recover*"))) |
c11032b9 | 5522 | (dired-unmark 1) |
033ef863 | 5523 | (dired-do-flagged-delete t) |
9aee5392 | 5524 | (unwind-protect |
8c3e96d2 | 5525 | (with-current-buffer buffer |
9aee5392 | 5526 | ;; Read in the auto-save-list file. |
9aee5392 RS |
5527 | (erase-buffer) |
5528 | (insert-file-contents file) | |
953a03b2 RS |
5529 | ;; Loop thru the text of that file |
5530 | ;; and get out the names of the files to recover. | |
5531 | (while (not (eobp)) | |
5532 | (let (thisfile autofile) | |
5533 | (if (eolp) | |
5534 | ;; This is a pair of lines for a non-file-visiting buffer. | |
5535 | ;; Get the auto-save file name and manufacture | |
5536 | ;; a "visited file name" from that. | |
5537 | (progn | |
5538 | (forward-line 1) | |
259be4e6 JB |
5539 | ;; If there is no auto-save file name, the |
5540 | ;; auto-save-list file is probably corrupted. | |
5541 | (unless (eolp) | |
5542 | (setq autofile | |
5543 | (buffer-substring-no-properties | |
5544 | (point) | |
e442c62b | 5545 | (line-end-position))) |
259be4e6 JB |
5546 | (setq thisfile |
5547 | (expand-file-name | |
5548 | (substring | |
5549 | (file-name-nondirectory autofile) | |
5550 | 1 -1) | |
5551 | (file-name-directory autofile)))) | |
953a03b2 RS |
5552 | (forward-line 1)) |
5553 | ;; This pair of lines is a file-visiting | |
5554 | ;; buffer. Use the visited file name. | |
5555 | (progn | |
5556 | (setq thisfile | |
5557 | (buffer-substring-no-properties | |
5558 | (point) (progn (end-of-line) (point)))) | |
5559 | (forward-line 1) | |
5560 | (setq autofile | |
5561 | (buffer-substring-no-properties | |
5562 | (point) (progn (end-of-line) (point)))) | |
5563 | (forward-line 1))) | |
5564 | ;; Ignore a file if its auto-save file does not exist now. | |
259be4e6 | 5565 | (if (and autofile (file-exists-p autofile)) |
953a03b2 RS |
5566 | (setq files (cons thisfile files))))) |
5567 | (setq files (nreverse files)) | |
945e1965 RS |
5568 | ;; The file contains a pair of line for each auto-saved buffer. |
5569 | ;; The first line of the pair contains the visited file name | |
5570 | ;; or is empty if the buffer was not visiting a file. | |
5571 | ;; The second line is the auto-save file name. | |
953a03b2 RS |
5572 | (if files |
5573 | (map-y-or-n-p "Recover %s? " | |
5574 | (lambda (file) | |
5575 | (condition-case nil | |
5576 | (save-excursion (recover-file file)) | |
76d5492b | 5577 | (error |
953a03b2 RS |
5578 | "Failed to recover `%s'" file))) |
5579 | files | |
5580 | '("file" "files" "recover")) | |
5581 | (message "No files can be recovered from this session now"))) | |
9aee5392 RS |
5582 | (kill-buffer buffer)))) |
5583 | ||
a151f82c | 5584 | (defun kill-buffer-ask (buffer) |
8fc29035 | 5585 | "Kill BUFFER if confirmed." |
9aea757b CY |
5586 | (when (yes-or-no-p (format "Buffer %s %s. Kill? " |
5587 | (buffer-name buffer) | |
5588 | (if (buffer-modified-p buffer) | |
5589 | "HAS BEEN EDITED" "is unmodified"))) | |
a151f82c SS |
5590 | (kill-buffer buffer))) |
5591 | ||
73ba610a | 5592 | (defun kill-some-buffers (&optional list) |
243a3ae0 | 5593 | "Kill some buffers. Asks the user whether to kill each one of them. |
bb8eaf67 | 5594 | Non-interactively, if optional argument LIST is non-nil, it |
243a3ae0 | 5595 | specifies the list of buffers to kill, asking for approval for each one." |
b4da00e9 | 5596 | (interactive) |
73ba610a RS |
5597 | (if (null list) |
5598 | (setq list (buffer-list))) | |
5599 | (while list | |
5600 | (let* ((buffer (car list)) | |
5601 | (name (buffer-name buffer))) | |
cbca0a4b RS |
5602 | (and name ; Can be nil for an indirect buffer |
5603 | ; if we killed the base buffer. | |
5604 | (not (string-equal name "")) | |
26b9ecbc | 5605 | (/= (aref name 0) ?\s) |
a151f82c | 5606 | (kill-buffer-ask buffer))) |
73ba610a | 5607 | (setq list (cdr list)))) |
a151f82c SS |
5608 | |
5609 | (defun kill-matching-buffers (regexp &optional internal-too) | |
8fc29035 | 5610 | "Kill buffers whose name matches the specified REGEXP. |
a151f82c SS |
5611 | The optional second argument indicates whether to kill internal buffers too." |
5612 | (interactive "sKill buffers matching this regular expression: \nP") | |
5613 | (dolist (buffer (buffer-list)) | |
5614 | (let ((name (buffer-name buffer))) | |
5615 | (when (and name (not (string-equal name "")) | |
5616 | (or internal-too (/= (aref name 0) ?\s)) | |
5617 | (string-match regexp name)) | |
5618 | (kill-buffer-ask buffer))))) | |
5619 | ||
b4da00e9 | 5620 | \f |
b4da00e9 RM |
5621 | (defun rename-auto-save-file () |
5622 | "Adjust current buffer's auto save file name for current conditions. | |
5623 | Also rename any existing auto save file, if it was made in this session." | |
5624 | (let ((osave buffer-auto-save-file-name)) | |
5625 | (setq buffer-auto-save-file-name | |
5626 | (make-auto-save-file-name)) | |
5627 | (if (and osave buffer-auto-save-file-name | |
5628 | (not (string= buffer-auto-save-file-name buffer-file-name)) | |
5629 | (not (string= buffer-auto-save-file-name osave)) | |
5630 | (file-exists-p osave) | |
5631 | (recent-auto-save-p)) | |
5632 | (rename-file osave buffer-auto-save-file-name t)))) | |
5633 | ||
5634 | (defun make-auto-save-file-name () | |
5635 | "Return file name to use for auto-saves of current buffer. | |
5636 | Does not consider `auto-save-visited-file-name' as that variable is checked | |
5637 | before calling this function. You can redefine this for customization. | |
5638 | See also `auto-save-file-name-p'." | |
5639 | (if buffer-file-name | |
c1105d05 MA |
5640 | (let ((handler (find-file-name-handler buffer-file-name |
5641 | 'make-auto-save-file-name))) | |
5642 | (if handler | |
5643 | (funcall handler 'make-auto-save-file-name) | |
5644 | (let ((list auto-save-file-name-transforms) | |
5645 | (filename buffer-file-name) | |
5646 | result uniq) | |
5647 | ;; Apply user-specified translations | |
5648 | ;; to the file name. | |
5649 | (while (and list (not result)) | |
5650 | (if (string-match (car (car list)) filename) | |
5651 | (setq result (replace-match (cadr (car list)) t nil | |
5652 | filename) | |
5653 | uniq (car (cddr (car list))))) | |
5654 | (setq list (cdr list))) | |
5655 | (if result | |
5656 | (if uniq | |
5657 | (setq filename (concat | |
5658 | (file-name-directory result) | |
5659 | (subst-char-in-string | |
5660 | ?/ ?! | |
5661 | (replace-regexp-in-string "!" "!!" | |
5662 | filename)))) | |
5663 | (setq filename result))) | |
5664 | (setq result | |
5665 | (if (and (eq system-type 'ms-dos) | |
5666 | (not (msdos-long-file-names))) | |
5667 | ;; We truncate the file name to DOS 8+3 limits | |
5668 | ;; before doing anything else, because the regexp | |
5669 | ;; passed to string-match below cannot handle | |
5670 | ;; extensions longer than 3 characters, multiple | |
5671 | ;; dots, and other atrocities. | |
5672 | (let ((fn (dos-8+3-filename | |
5673 | (file-name-nondirectory buffer-file-name)))) | |
5674 | (string-match | |
5675 | "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" | |
5676 | fn) | |
5677 | (concat (file-name-directory buffer-file-name) | |
5678 | "#" (match-string 1 fn) | |
5679 | "." (match-string 3 fn) "#")) | |
5680 | (concat (file-name-directory filename) | |
5681 | "#" | |
5682 | (file-name-nondirectory filename) | |
5683 | "#"))) | |
5684 | ;; Make sure auto-save file names don't contain characters | |
5685 | ;; invalid for the underlying filesystem. | |
18b28ef1 | 5686 | (if (and (memq system-type '(ms-dos windows-nt cygwin)) |
c1105d05 MA |
5687 | ;; Don't modify remote (ange-ftp) filenames |
5688 | (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result))) | |
5689 | (convert-standard-filename result) | |
5690 | result)))) | |
0a1763b4 RS |
5691 | |
5692 | ;; Deal with buffers that don't have any associated files. (Mail | |
5693 | ;; mode tends to create a good number of these.) | |
5694 | ||
7d483e8c | 5695 | (let ((buffer-name (buffer-name)) |
ff5c7181 | 5696 | (limit 0) |
77d18896 | 5697 | file-name) |
ad80c679 JR |
5698 | ;; Restrict the characters used in the file name to those which |
5699 | ;; are known to be safe on all filesystems, url-encoding the | |
5700 | ;; rest. | |
5701 | ;; We do this on all platforms, because even if we are not | |
5702 | ;; running on DOS/Windows, the current directory may be on a | |
5703 | ;; mounted VFAT filesystem, such as a USB memory stick. | |
5704 | (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit) | |
c3348e10 RS |
5705 | (let* ((character (aref buffer-name (match-beginning 0))) |
5706 | (replacement | |
ad80c679 JR |
5707 | ;; For multibyte characters, this will produce more than |
5708 | ;; 2 hex digits, so is not true URL encoding. | |
5709 | (format "%%%02X" character))) | |
c3348e10 RS |
5710 | (setq buffer-name (replace-match replacement t t buffer-name)) |
5711 | (setq limit (1+ (match-end 0))))) | |
a8abaf83 | 5712 | ;; Generate the file name. |
ff5c7181 RS |
5713 | (setq file-name |
5714 | (make-temp-file | |
5715 | (let ((fname | |
5716 | (expand-file-name | |
5717 | (format "#%s#" buffer-name) | |
5718 | ;; Try a few alternative directories, to get one we can | |
5719 | ;; write it. | |
5720 | (cond | |
5721 | ((file-writable-p default-directory) default-directory) | |
5722 | ((file-writable-p "/var/tmp/") "/var/tmp/") | |
5723 | ("~/"))))) | |
18b28ef1 | 5724 | (if (and (memq system-type '(ms-dos windows-nt cygwin)) |
ff5c7181 RS |
5725 | ;; Don't modify remote (ange-ftp) filenames |
5726 | (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname))) | |
5727 | ;; The call to convert-standard-filename is in case | |
5728 | ;; buffer-name includes characters not allowed by the | |
5729 | ;; DOS/Windows filesystems. make-temp-file writes to the | |
5730 | ;; file it creates, so we must fix the file name _before_ | |
5731 | ;; make-temp-file is called. | |
5732 | (convert-standard-filename fname) | |
5733 | fname)) | |
5734 | nil "#")) | |
5735 | ;; make-temp-file creates the file, | |
5736 | ;; but we don't want it to exist until we do an auto-save. | |
5737 | (condition-case () | |
5738 | (delete-file file-name) | |
5739 | (file-error nil)) | |
5740 | file-name))) | |
b4da00e9 RM |
5741 | |
5742 | (defun auto-save-file-name-p (filename) | |
5743 | "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'. | |
5744 | FILENAME should lack slashes. You can redefine this for customization." | |
19156242 | 5745 | (string-match "\\`#.*#\\'" filename)) |
b4da00e9 | 5746 | \f |
6f4983e6 RS |
5747 | (defun wildcard-to-regexp (wildcard) |
5748 | "Given a shell file name pattern WILDCARD, return an equivalent regexp. | |
4837b516 | 5749 | The generated regexp will match a filename only if the filename |
6f4983e6 RS |
5750 | matches that wildcard according to shell rules. Only wildcards known |
5751 | by `sh' are supported." | |
5752 | (let* ((i (string-match "[[.*+\\^$?]" wildcard)) | |
5753 | ;; Copy the initial run of non-special characters. | |
5754 | (result (substring wildcard 0 i)) | |
5755 | (len (length wildcard))) | |
5756 | ;; If no special characters, we're almost done. | |
5757 | (if i | |
5758 | (while (< i len) | |
5759 | (let ((ch (aref wildcard i)) | |
5760 | j) | |
5761 | (setq | |
5762 | result | |
5763 | (concat result | |
5764 | (cond | |
7e7c9c4e RS |
5765 | ((and (eq ch ?\[) |
5766 | (< (1+ i) len) | |
5767 | (eq (aref wildcard (1+ i)) ?\])) | |
5768 | "\\[") | |
6f4983e6 RS |
5769 | ((eq ch ?\[) ; [...] maps to regexp char class |
5770 | (progn | |
5771 | (setq i (1+ i)) | |
5772 | (concat | |
5773 | (cond | |
5774 | ((eq (aref wildcard i) ?!) ; [!...] -> [^...] | |
5775 | (progn | |
5776 | (setq i (1+ i)) | |
5777 | (if (eq (aref wildcard i) ?\]) | |
5778 | (progn | |
5779 | (setq i (1+ i)) | |
5780 | "[^]") | |
5781 | "[^"))) | |
5782 | ((eq (aref wildcard i) ?^) | |
5783 | ;; Found "[^". Insert a `\0' character | |
5784 | ;; (which cannot happen in a filename) | |
5785 | ;; into the character class, so that `^' | |
5786 | ;; is not the first character after `[', | |
5787 | ;; and thus non-special in a regexp. | |
5788 | (progn | |
5789 | (setq i (1+ i)) | |
5790 | "[\000^")) | |
5791 | ((eq (aref wildcard i) ?\]) | |
5792 | ;; I don't think `]' can appear in a | |
5793 | ;; character class in a wildcard, but | |
5794 | ;; let's be general here. | |
5795 | (progn | |
5796 | (setq i (1+ i)) | |
5797 | "[]")) | |
5798 | (t "[")) | |
5799 | (prog1 ; copy everything upto next `]'. | |
5800 | (substring wildcard | |
5801 | i | |
5802 | (setq j (string-match | |
5803 | "]" wildcard i))) | |
5804 | (setq i (if j (1- j) (1- len))))))) | |
5805 | ((eq ch ?.) "\\.") | |
5806 | ((eq ch ?*) "[^\000]*") | |
5807 | ((eq ch ?+) "\\+") | |
5808 | ((eq ch ?^) "\\^") | |
5809 | ((eq ch ?$) "\\$") | |
5810 | ((eq ch ?\\) "\\\\") ; probably cannot happen... | |
5811 | ((eq ch ??) "[^\000]") | |
5812 | (t (char-to-string ch))))) | |
5813 | (setq i (1+ i))))) | |
5814 | ;; Shell wildcards should match the entire filename, | |
5815 | ;; not its part. Make the regexp say so. | |
5816 | (concat "\\`" result "\\'"))) | |
5817 | \f | |
21540597 | 5818 | (defcustom list-directory-brief-switches |
1e8780b1 | 5819 | (purecopy "-CF") |
ba83982b | 5820 | "Switches for `list-directory' to pass to `ls' for brief listing." |
21540597 RS |
5821 | :type 'string |
5822 | :group 'dired) | |
b4da00e9 | 5823 | |
21540597 | 5824 | (defcustom list-directory-verbose-switches |
1e8780b1 | 5825 | (purecopy "-l") |
ba83982b | 5826 | "Switches for `list-directory' to pass to `ls' for verbose listing." |
21540597 RS |
5827 | :type 'string |
5828 | :group 'dired) | |
b4da00e9 | 5829 | |
5de148a2 RS |
5830 | (defun file-expand-wildcards (pattern &optional full) |
5831 | "Expand wildcard pattern PATTERN. | |
4db2a7de RS |
5832 | This returns a list of file names which match the pattern. |
5833 | ||
814af837 | 5834 | If PATTERN is written as an absolute file name, |
4db2a7de RS |
5835 | the values are absolute also. |
5836 | ||
5837 | If PATTERN is written as a relative file name, it is interpreted | |
5838 | relative to the current default directory, `default-directory'. | |
5839 | The file names returned are normally also relative to the current | |
5840 | default directory. However, if FULL is non-nil, they are absolute." | |
032388f3 RS |
5841 | (save-match-data |
5842 | (let* ((nondir (file-name-nondirectory pattern)) | |
5843 | (dirpart (file-name-directory pattern)) | |
5844 | ;; A list of all dirs that DIRPART specifies. | |
5845 | ;; This can be more than one dir | |
5846 | ;; if DIRPART contains wildcards. | |
1f3611c6 MA |
5847 | (dirs (if (and dirpart |
5848 | (string-match "[[*?]" | |
5849 | (or (file-remote-p dirpart 'localname) | |
5850 | dirpart))) | |
032388f3 RS |
5851 | (mapcar 'file-name-as-directory |
5852 | (file-expand-wildcards (directory-file-name dirpart))) | |
5853 | (list dirpart))) | |
5854 | contents) | |
5855 | (while dirs | |
5856 | (when (or (null (car dirs)) ; Possible if DIRPART is not wild. | |
28fd8759 LMI |
5857 | (and (file-directory-p (directory-file-name (car dirs))) |
5858 | (file-readable-p (car dirs)))) | |
032388f3 RS |
5859 | (let ((this-dir-contents |
5860 | ;; Filter out "." and ".." | |
5861 | (delq nil | |
5862 | (mapcar #'(lambda (name) | |
5863 | (unless (string-match "\\`\\.\\.?\\'" | |
5864 | (file-name-nondirectory name)) | |
5865 | name)) | |
5866 | (directory-files (or (car dirs) ".") full | |
5867 | (wildcard-to-regexp nondir)))))) | |
5868 | (setq contents | |
5869 | (nconc | |
5870 | (if (and (car dirs) (not full)) | |
5871 | (mapcar (function (lambda (name) (concat (car dirs) name))) | |
5872 | this-dir-contents) | |
5873 | this-dir-contents) | |
5874 | contents)))) | |
5875 | (setq dirs (cdr dirs))) | |
5876 | contents))) | |
5de148a2 | 5877 | |
1f3611c6 MA |
5878 | ;; Let Tramp know that `file-expand-wildcards' does not need an advice. |
5879 | (provide 'files '(remote-wildcards)) | |
5880 | ||
b4da00e9 RM |
5881 | (defun list-directory (dirname &optional verbose) |
5882 | "Display a list of files in or matching DIRNAME, a la `ls'. | |
5883 | DIRNAME is globbed by the shell if necessary. | |
5884 | Prefix arg (second arg if noninteractive) means supply -l switch to `ls'. | |
5885 | Actions controlled by variables `list-directory-brief-switches' | |
5886 | and `list-directory-verbose-switches'." | |
5887 | (interactive (let ((pfx current-prefix-arg)) | |
7e27ce9c | 5888 | (list (read-directory-name (if pfx "List directory (verbose): " |
b4da00e9 RM |
5889 | "List directory (brief): ") |
5890 | nil default-directory nil) | |
5891 | pfx))) | |
5892 | (let ((switches (if verbose list-directory-verbose-switches | |
84905190 RS |
5893 | list-directory-brief-switches)) |
5894 | buffer) | |
b4da00e9 RM |
5895 | (or dirname (setq dirname default-directory)) |
5896 | (setq dirname (expand-file-name dirname)) | |
5897 | (with-output-to-temp-buffer "*Directory*" | |
84905190 | 5898 | (setq buffer standard-output) |
b4da00e9 RM |
5899 | (buffer-disable-undo standard-output) |
5900 | (princ "Directory ") | |
5901 | (princ dirname) | |
5902 | (terpri) | |
7fdbcd83 | 5903 | (with-current-buffer "*Directory*" |
c3554e95 | 5904 | (let ((wildcard (not (file-directory-p dirname)))) |
84905190 RS |
5905 | (insert-directory dirname switches wildcard (not wildcard))))) |
5906 | ;; Finishing with-output-to-temp-buffer seems to clobber default-directory. | |
5907 | (with-current-buffer buffer | |
5908 | (setq default-directory | |
5909 | (if (file-directory-p dirname) | |
5910 | (file-name-as-directory dirname) | |
5911 | (file-name-directory dirname)))))) | |
c3554e95 | 5912 | |
ffc0e1ca AS |
5913 | (defun shell-quote-wildcard-pattern (pattern) |
5914 | "Quote characters special to the shell in PATTERN, leave wildcards alone. | |
5915 | ||
5916 | PATTERN is assumed to represent a file-name wildcard suitable for the | |
7f94baf0 EZ |
5917 | underlying filesystem. For Unix and GNU/Linux, each character from the |
5918 | set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all | |
ffc0e1ca AS |
5919 | the parts of the pattern which don't include wildcard characters are |
5920 | quoted with double quotes. | |
7f94baf0 EZ |
5921 | |
5922 | This function leaves alone existing quote characters (\\ on Unix and \" | |
5923 | on Windows), so PATTERN can use them to quote wildcard characters that | |
5924 | need to be passed verbatim to shell commands." | |
ffc0e1ca AS |
5925 | (save-match-data |
5926 | (cond | |
c60ee5e7 | 5927 | ((memq system-type '(ms-dos windows-nt cygwin)) |
ffc0e1ca AS |
5928 | ;; DOS/Windows don't allow `"' in file names. So if the |
5929 | ;; argument has quotes, we can safely assume it is already | |
5930 | ;; quoted by the caller. | |
5931 | (if (or (string-match "[\"]" pattern) | |
5932 | ;; We quote [&()#$'] in case their shell is a port of a | |
5933 | ;; Unixy shell. We quote [,=+] because stock DOS and | |
5934 | ;; Windows shells require that in some cases, such as | |
5935 | ;; passing arguments to batch files that use positional | |
5936 | ;; arguments like %1. | |
5937 | (not (string-match "[ \t;&()#$',=+]" pattern))) | |
5938 | pattern | |
5939 | (let ((result "\"") | |
5940 | (beg 0) | |
5941 | end) | |
5942 | (while (string-match "[*?]+" pattern beg) | |
5943 | (setq end (match-beginning 0) | |
5944 | result (concat result (substring pattern beg end) | |
5945 | "\"" | |
5946 | (substring pattern end (match-end 0)) | |
5947 | "\"") | |
5948 | beg (match-end 0))) | |
5949 | (concat result (substring pattern beg) "\"")))) | |
5950 | (t | |
5951 | (let ((beg 0)) | |
d6d61574 | 5952 | (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg) |
ffc0e1ca AS |
5953 | (setq pattern |
5954 | (concat (substring pattern 0 (match-beginning 0)) | |
5955 | "\\" | |
5956 | (substring pattern (match-beginning 0))) | |
5957 | beg (1+ (match-end 0))))) | |
5958 | pattern)))) | |
5959 | ||
5960 | ||
1e8780b1 | 5961 | (defvar insert-directory-program (purecopy "ls") |
c3554e95 RS |
5962 | "Absolute or relative name of the `ls' program used by `insert-directory'.") |
5963 | ||
1e8780b1 | 5964 | (defcustom directory-free-space-program (purecopy "df") |
ba83982b | 5965 | "Program to get the amount of free space on a file system. |
f4d04672 RS |
5966 | We assume the output has the format of `df'. |
5967 | The value of this variable must be just a command name or file name; | |
5968 | if you want to specify options, use `directory-free-space-args'. | |
5969 | ||
01b26b90 EZ |
5970 | A value of nil disables this feature. |
5971 | ||
5972 | If the function `file-system-info' is defined, it is always used in | |
5973 | preference to the program given by this variable." | |
f4d04672 RS |
5974 | :type '(choice (string :tag "Program") (const :tag "None" nil)) |
5975 | :group 'dired) | |
5976 | ||
525fdbc9 | 5977 | (defcustom directory-free-space-args |
1e8780b1 | 5978 | (purecopy (if (eq system-type 'darwin) "-k" "-Pk")) |
ba83982b | 5979 | "Options to use when running `directory-free-space-program'." |
f4d04672 RS |
5980 | :type 'string |
5981 | :group 'dired) | |
5982 | ||
01b26b90 | 5983 | (defun get-free-disk-space (dir) |
26b9ecbc | 5984 | "Return the amount of free space on directory DIR's file system. |
93a596e1 CY |
5985 | The return value is a string describing the amount of free |
5986 | space (normally, the number of free 1KB blocks). | |
5987 | ||
5988 | This function calls `file-system-info' if it is available, or | |
5989 | invokes the program specified by `directory-free-space-program' | |
5990 | and `directory-free-space-args'. If the system call or program | |
5991 | is unsuccessful, or if DIR is a remote directory, this function | |
5992 | returns nil." | |
e1bdde78 | 5993 | (unless (file-remote-p dir) |
06531fc3 MA |
5994 | ;; Try to find the number of free blocks. Non-Posix systems don't |
5995 | ;; always have df, but might have an equivalent system call. | |
5996 | (if (fboundp 'file-system-info) | |
5997 | (let ((fsinfo (file-system-info dir))) | |
5998 | (if fsinfo | |
5999 | (format "%.0f" (/ (nth 2 fsinfo) 1024)))) | |
51da8fe2 | 6000 | (setq dir (expand-file-name dir)) |
06531fc3 MA |
6001 | (save-match-data |
6002 | (with-temp-buffer | |
6003 | (when (and directory-free-space-program | |
e1bdde78 CY |
6004 | ;; Avoid failure if the default directory does |
6005 | ;; not exist (Bug#2631, Bug#3911). | |
0781098a SM |
6006 | (let ((default-directory |
6007 | (locate-dominating-file dir 'file-directory-p))) | |
6008 | (eq (process-file directory-free-space-program | |
06531fc3 MA |
6009 | nil t nil |
6010 | directory-free-space-args | |
0781098a | 6011 | (file-relative-name dir)) |
86c7144b | 6012 | 0))) |
41f54b73 CY |
6013 | ;; Assume that the "available" column is before the |
6014 | ;; "capacity" column. Find the "%" and scan backward. | |
06531fc3 | 6015 | (goto-char (point-min)) |
41f54b73 CY |
6016 | (forward-line 1) |
6017 | (when (re-search-forward | |
6018 | "[[:space:]]+[^[:space:]]+%[^%]*$" | |
6019 | (line-end-position) t) | |
6020 | (goto-char (match-beginning 0)) | |
6021 | (let ((endpt (point))) | |
6022 | (skip-chars-backward "^[:space:]") | |
6023 | (buffer-substring-no-properties (point) endpt))))))))) | |
01b26b90 | 6024 | |
9bc260cf MA |
6025 | ;; The following expression replaces `dired-move-to-filename-regexp'. |
6026 | (defvar directory-listing-before-filename-regexp | |
6027 | (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)") | |
6028 | (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)") | |
6029 | ;; In some locales, month abbreviations are as short as 2 letters, | |
6030 | ;; and they can be followed by ".". | |
6031 | ;; In Breton, a month name can include a quote character. | |
6032 | (month (concat l-or-quote l-or-quote "+\\.?")) | |
6033 | (s " ") | |
6034 | (yyyy "[0-9][0-9][0-9][0-9]") | |
6035 | (dd "[ 0-3][0-9]") | |
6036 | (HH:MM "[ 0-2][0-9][:.][0-5][0-9]") | |
6037 | (seconds "[0-6][0-9]\\([.,][0-9]+\\)?") | |
6038 | (zone "[-+][0-2][0-9][0-5][0-9]") | |
6039 | (iso-mm-dd "[01][0-9]-[0-3][0-9]") | |
6040 | (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?")) | |
6041 | (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time | |
6042 | "\\|" yyyy "-" iso-mm-dd "\\)")) | |
6043 | (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)" | |
6044 | s "+" | |
6045 | "\\(" HH:MM "\\|" yyyy "\\)")) | |
6046 | (western-comma (concat month s "+" dd "," s "+" yyyy)) | |
6047 | ;; Japanese MS-Windows ls-lisp has one-digit months, and | |
6048 | ;; omits the Kanji characters after month and day-of-month. | |
6049 | ;; On Mac OS X 10.3, the date format in East Asian locales is | |
6050 | ;; day-of-month digits followed by month digits. | |
6051 | (mm "[ 0-1]?[0-9]") | |
6052 | (east-asian | |
6053 | (concat "\\(" mm l "?" s dd l "?" s "+" | |
6054 | "\\|" dd s mm s "+" "\\)" | |
6055 | "\\(" HH:MM "\\|" yyyy l "?" "\\)"))) | |
6056 | ;; The "[0-9]" below requires the previous column to end in a digit. | |
6057 | ;; This avoids recognizing `1 may 1997' as a date in the line: | |
6058 | ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README | |
6059 | ||
6060 | ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output. | |
50c58e27 CY |
6061 | |
6062 | ;; For non-iso date formats, we add the ".*" in order to find | |
6063 | ;; the last possible match. This avoids recognizing | |
6064 | ;; `jservice 10 1024' as a date in the line: | |
9bc260cf MA |
6065 | ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host |
6066 | ||
6067 | ;; vc dired listings provide the state or blanks between file | |
6068 | ;; permissions and date. The state is always surrounded by | |
e1dbe924 | 6069 | ;; parentheses: |
9bc260cf MA |
6070 | ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el |
6071 | ;; This is not supported yet. | |
50c58e27 CY |
6072 | (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso |
6073 | "\\|.*[0-9][BkKMGTPEZY]? " | |
6074 | "\\(" western "\\|" western-comma "\\|" east-asian "\\)" | |
6075 | "\\) +"))) | |
9bc260cf MA |
6076 | "Regular expression to match up to the file name in a directory listing. |
6077 | The default value is designed to recognize dates and times | |
6078 | regardless of the language.") | |
01b26b90 | 6079 | |
a1b0c2a7 RS |
6080 | (defvar insert-directory-ls-version 'unknown) |
6081 | ||
c3554e95 RS |
6082 | ;; insert-directory |
6083 | ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and | |
6084 | ;; FULL-DIRECTORY-P is nil. | |
6085 | ;; The single line of output must display FILE's name as it was | |
6086 | ;; given, namely, an absolute path name. | |
6087 | ;; - must insert exactly one line for each file if WILDCARD or | |
6088 | ;; FULL-DIRECTORY-P is t, plus one optional "total" line | |
6089 | ;; before the file lines, plus optional text after the file lines. | |
6090 | ;; Lines are delimited by "\n", so filenames containing "\n" are not | |
6091 | ;; allowed. | |
6092 | ;; File lines should display the basename. | |
6093 | ;; - must be consistent with | |
6094 | ;; - functions dired-move-to-filename, (these two define what a file line is) | |
6095 | ;; dired-move-to-end-of-filename, | |
6096 | ;; dired-between-files, (shortcut for (not (dired-move-to-filename))) | |
6097 | ;; dired-insert-headerline | |
6098 | ;; dired-after-subdir-garbage (defines what a "total" line is) | |
6099 | ;; - variable dired-subdir-regexp | |
1fc85dae KG |
6100 | ;; - may be passed "--dired" as the first argument in SWITCHES. |
6101 | ;; Filename handlers might have to remove this switch if their | |
6102 | ;; "ls" command does not support it. | |
c3554e95 | 6103 | (defun insert-directory (file switches &optional wildcard full-directory-p) |
a18b7c81 | 6104 | "Insert directory listing for FILE, formatted according to SWITCHES. |
c3554e95 | 6105 | Leaves point after the inserted text. |
8f8607be LT |
6106 | SWITCHES may be a string of options, or a list of strings |
6107 | representing individual options. | |
c3554e95 RS |
6108 | Optional third arg WILDCARD means treat FILE as shell wildcard. |
6109 | Optional fourth arg FULL-DIRECTORY-P means file is a directory and | |
6110 | switches do not contain `d', so that a full listing is expected. | |
6111 | ||
6112 | This works by running a directory listing program | |
406e12d9 | 6113 | whose name is in the variable `insert-directory-program'. |
8f8607be LT |
6114 | If WILDCARD, it also runs the shell specified by `shell-file-name'. |
6115 | ||
60ce7e3e | 6116 | When SWITCHES contains the long `--dired' option, this function |
8f8607be LT |
6117 | treats it specially, for the sake of dired. However, the |
6118 | normally equivalent short `-D' option is just passed on to | |
6119 | `insert-directory-program', as any other option." | |
c870ab8e | 6120 | ;; We need the directory in order to find the right handler. |
d2473540 AS |
6121 | (let ((handler (find-file-name-handler (expand-file-name file) |
6122 | 'insert-directory))) | |
ebad92dc | 6123 | (if handler |
c3554e95 RS |
6124 | (funcall handler 'insert-directory file switches |
6125 | wildcard full-directory-p) | |
818286f4 | 6126 | (let (result (beg (point))) |
ebad92dc RS |
6127 | |
6128 | ;; Read the actual directory using `insert-directory-program'. | |
6129 | ;; RESULT gets the status code. | |
99f01c91 KH |
6130 | (let* (;; We at first read by no-conversion, then after |
6131 | ;; putting text property `dired-filename, decode one | |
6132 | ;; bunch by one to preserve that property. | |
6133 | (coding-system-for-read 'no-conversion) | |
6134 | ;; This is to control encoding the arguments in call-process. | |
c60ee5e7 | 6135 | (coding-system-for-write |
82e22b57 KH |
6136 | (and enable-multibyte-characters |
6137 | (or file-name-coding-system | |
99f01c91 | 6138 | default-file-name-coding-system)))) |
ebad92dc RS |
6139 | (setq result |
6140 | (if wildcard | |
6141 | ;; Run ls in the directory part of the file pattern | |
6142 | ;; using the last component as argument. | |
6143 | (let ((default-directory | |
6144 | (if (file-name-absolute-p file) | |
6145 | (file-name-directory file) | |
6146 | (file-name-directory (expand-file-name file)))) | |
6147 | (pattern (file-name-nondirectory file))) | |
82137b51 GM |
6148 | ;; NB since switches is passed to the shell, be |
6149 | ;; careful of malicious values, eg "-l;reboot". | |
6150 | ;; See eg dired-safe-switches-p. | |
ebad92dc RS |
6151 | (call-process |
6152 | shell-file-name nil t nil | |
6153 | "-c" | |
6154 | (concat (if (memq system-type '(ms-dos windows-nt)) | |
6155 | "" | |
6156 | "\\") ; Disregard Unix shell aliases! | |
6157 | insert-directory-program | |
6158 | " -d " | |
6159 | (if (stringp switches) | |
6160 | switches | |
6161 | (mapconcat 'identity switches " ")) | |
6162 | " -- " | |
6163 | ;; Quote some characters that have | |
6164 | ;; special meanings in shells; but | |
6165 | ;; don't quote the wildcards--we want | |
6166 | ;; them to be special. We also | |
6167 | ;; currently don't quote the quoting | |
6168 | ;; characters in case people want to | |
6169 | ;; use them explicitly to quote | |
6170 | ;; wildcard characters. | |
6171 | (shell-quote-wildcard-pattern pattern)))) | |
6172 | ;; SunOS 4.1.3, SVr4 and others need the "." to list the | |
6173 | ;; directory if FILE is a symbolic link. | |
ecbaeb7b MA |
6174 | (unless full-directory-p |
6175 | (setq switches | |
6176 | (if (stringp switches) | |
6177 | (concat switches " -d") | |
6178 | (add-to-list 'switches "-d" 'append)))) | |
ebad92dc RS |
6179 | (apply 'call-process |
6180 | insert-directory-program nil t nil | |
6181 | (append | |
6182 | (if (listp switches) switches | |
6183 | (unless (equal switches "") | |
6184 | ;; Split the switches at any spaces so we can | |
6185 | ;; pass separate options as separate args. | |
6186 | (split-string switches))) | |
6187 | ;; Avoid lossage if FILE starts with `-'. | |
6188 | '("--") | |
6189 | (progn | |
6190 | (if (string-match "\\`~" file) | |
6191 | (setq file (expand-file-name file))) | |
6192 | (list | |
6193 | (if full-directory-p | |
6194 | (concat (file-name-as-directory file) ".") | |
6195 | file)))))))) | |
6196 | ||
a1b0c2a7 RS |
6197 | ;; If we got "//DIRED//" in the output, it means we got a real |
6198 | ;; directory listing, even if `ls' returned nonzero. | |
6199 | ;; So ignore any errors. | |
6200 | (when (if (stringp switches) | |
6201 | (string-match "--dired\\>" switches) | |
6202 | (member "--dired" switches)) | |
6203 | (save-excursion | |
6204 | (forward-line -2) | |
6205 | (when (looking-at "//SUBDIRED//") | |
6206 | (forward-line -1)) | |
6207 | (if (looking-at "//DIRED//") | |
6208 | (setq result 0)))) | |
6209 | ||
6210 | (when (and (not (eq 0 result)) | |
6211 | (eq insert-directory-ls-version 'unknown)) | |
6212 | ;; The first time ls returns an error, | |
6213 | ;; find the version numbers of ls, | |
6214 | ;; and set insert-directory-ls-version | |
6215 | ;; to > if it is more than 5.2.1, < if it is less, nil if it | |
6216 | ;; is equal or if the info cannot be obtained. | |
6217 | ;; (That can mean it isn't GNU ls.) | |
6218 | (let ((version-out | |
6219 | (with-temp-buffer | |
6220 | (call-process "ls" nil t nil "--version") | |
6221 | (buffer-string)))) | |
6222 | (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out) | |
6223 | (let* ((version (match-string 1 version-out)) | |
6224 | (split (split-string version "[.]")) | |
027a4b6b | 6225 | (numbers (mapcar 'string-to-number split)) |
a1b0c2a7 RS |
6226 | (min '(5 2 1)) |
6227 | comparison) | |
6228 | (while (and (not comparison) (or numbers min)) | |
6229 | (cond ((null min) | |
6230 | (setq comparison '>)) | |
6231 | ((null numbers) | |
6232 | (setq comparison '<)) | |
6233 | ((> (car numbers) (car min)) | |
6234 | (setq comparison '>)) | |
6235 | ((< (car numbers) (car min)) | |
6236 | (setq comparison '<)) | |
6237 | (t | |
6238 | (setq numbers (cdr numbers) | |
6239 | min (cdr min))))) | |
6240 | (setq insert-directory-ls-version (or comparison '=))) | |
6241 | (setq insert-directory-ls-version nil)))) | |
6242 | ||
6243 | ;; For GNU ls versions 5.2.2 and up, ignore minor errors. | |
6244 | (when (and (eq 1 result) (eq insert-directory-ls-version '>)) | |
6245 | (setq result 0)) | |
6246 | ||
ebad92dc | 6247 | ;; If `insert-directory-program' failed, signal an error. |
15502042 | 6248 | (unless (eq 0 result) |
f2440e42 RS |
6249 | ;; Delete the error message it may have output. |
6250 | (delete-region beg (point)) | |
15502042 EZ |
6251 | ;; On non-Posix systems, we cannot open a directory, so |
6252 | ;; don't even try, because that will always result in | |
6253 | ;; the ubiquitous "Access denied". Instead, show the | |
6254 | ;; command line so the user can try to guess what went wrong. | |
6255 | (if (and (file-directory-p file) | |
6256 | (memq system-type '(ms-dos windows-nt))) | |
6257 | (error | |
6258 | "Reading directory: \"%s %s -- %s\" exited with status %s" | |
6259 | insert-directory-program | |
6260 | (if (listp switches) (concat switches) switches) | |
6261 | file result) | |
6262 | ;; Unix. Access the file to get a suitable error. | |
6263 | (access-file file "Reading directory") | |
6264 | (error "Listing directory failed but `access-file' worked"))) | |
ebad92dc | 6265 | |
8f8607be LT |
6266 | (when (if (stringp switches) |
6267 | (string-match "--dired\\>" switches) | |
6268 | (member "--dired" switches)) | |
9bb99df6 LT |
6269 | ;; The following overshoots by one line for an empty |
6270 | ;; directory listed with "--dired", but without "-a" | |
6271 | ;; switch, where the ls output contains a | |
6272 | ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line. | |
6273 | ;; We take care of that case later. | |
ff7affeb | 6274 | (forward-line -2) |
9423860f AS |
6275 | (when (looking-at "//SUBDIRED//") |
6276 | (delete-region (point) (progn (forward-line 1) (point))) | |
6277 | (forward-line -1)) | |
9bb99df6 LT |
6278 | (if (looking-at "//DIRED//") |
6279 | (let ((end (line-end-position)) | |
6280 | (linebeg (point)) | |
6281 | error-lines) | |
6282 | ;; Find all the lines that are error messages, | |
6283 | ;; and record the bounds of each one. | |
6284 | (goto-char beg) | |
6285 | (while (< (point) linebeg) | |
6286 | (or (eql (following-char) ?\s) | |
6287 | (push (list (point) (line-end-position)) error-lines)) | |
6288 | (forward-line 1)) | |
6289 | (setq error-lines (nreverse error-lines)) | |
6290 | ;; Now read the numeric positions of file names. | |
6291 | (goto-char linebeg) | |
6292 | (forward-word 1) | |
6293 | (forward-char 3) | |
6294 | (while (< (point) end) | |
6295 | (let ((start (insert-directory-adj-pos | |
6296 | (+ beg (read (current-buffer))) | |
6297 | error-lines)) | |
6298 | (end (insert-directory-adj-pos | |
a1b0c2a7 | 6299 | (+ beg (read (current-buffer))) |
9bb99df6 | 6300 | error-lines))) |
26b9ecbc | 6301 | (if (memq (char-after end) '(?\n ?\s)) |
9bb99df6 LT |
6302 | ;; End is followed by \n or by " -> ". |
6303 | (put-text-property start end 'dired-filename t) | |
6304 | ;; It seems that we can't trust ls's output as to | |
6305 | ;; byte positions of filenames. | |
6306 | (put-text-property beg (point) 'dired-filename nil) | |
6307 | (end-of-line)))) | |
6308 | (goto-char end) | |
6309 | (beginning-of-line) | |
6310 | (delete-region (point) (progn (forward-line 1) (point)))) | |
6311 | ;; Take care of the case where the ls output contains a | |
6312 | ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line | |
6313 | ;; and we went one line too far back (see above). | |
6314 | (forward-line 1)) | |
6315 | (if (looking-at "//DIRED-OPTIONS//") | |
6316 | (delete-region (point) (progn (forward-line 1) (point))))) | |
ff7affeb | 6317 | |
99f01c91 | 6318 | ;; Now decode what read if necessary. |
b6647390 KH |
6319 | (let ((coding (or coding-system-for-read |
6320 | file-name-coding-system | |
6321 | default-file-name-coding-system | |
6322 | 'undecided)) | |
0bded065 | 6323 | coding-no-eol |
99f01c91 | 6324 | val pos) |
b6647390 KH |
6325 | (when (and enable-multibyte-characters |
6326 | (not (memq (coding-system-base coding) | |
6327 | '(raw-text no-conversion)))) | |
6328 | ;; If no coding system is specified or detection is | |
6329 | ;; requested, detect the coding. | |
6330 | (if (eq (coding-system-base coding) 'undecided) | |
6331 | (setq coding (detect-coding-region beg (point) t))) | |
6332 | (if (not (eq (coding-system-base coding) 'undecided)) | |
6333 | (save-restriction | |
0bded065 AS |
6334 | (setq coding-no-eol |
6335 | (coding-system-change-eol-conversion coding 'unix)) | |
b6647390 KH |
6336 | (narrow-to-region beg (point)) |
6337 | (goto-char (point-min)) | |
6338 | (while (not (eobp)) | |
6339 | (setq pos (point) | |
6340 | val (get-text-property (point) 'dired-filename)) | |
6341 | (goto-char (next-single-property-change | |
6342 | (point) 'dired-filename nil (point-max))) | |
0bded065 AS |
6343 | ;; Force no eol conversion on a file name, so |
6344 | ;; that CR is preserved. | |
6345 | (decode-coding-region pos (point) | |
6346 | (if val coding-no-eol coding)) | |
b6647390 KH |
6347 | (if val |
6348 | (put-text-property pos (point) | |
6349 | 'dired-filename t))))))) | |
99f01c91 | 6350 | |
75bb5ca4 AS |
6351 | (if full-directory-p |
6352 | ;; Try to insert the amount of free space. | |
6353 | (save-excursion | |
6354 | (goto-char beg) | |
6355 | ;; First find the line to put it on. | |
6356 | (when (re-search-forward "^ *\\(total\\)" nil t) | |
6357 | (let ((available (get-free-disk-space "."))) | |
6358 | (when available | |
6359 | ;; Replace "total" with "used", to avoid confusion. | |
6360 | (replace-match "total used in directory" nil nil nil 1) | |
6361 | (end-of-line) | |
7c2fb837 | 6362 | (insert " available " available)))))))))) |
34342a07 | 6363 | |
a1b0c2a7 | 6364 | (defun insert-directory-adj-pos (pos error-lines) |
fead94d6 | 6365 | "Convert `ls --dired' file name position value POS to a buffer position. |
a1b0c2a7 RS |
6366 | File name position values returned in ls --dired output |
6367 | count only stdout; they don't count the error messages sent to stderr. | |
6368 | So this function converts to them to real buffer positions. | |
6369 | ERROR-LINES is a list of buffer positions of error message lines, | |
6370 | of the form (START END)." | |
6371 | (while (and error-lines (< (caar error-lines) pos)) | |
6372 | (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines))))) | |
6373 | (pop error-lines)) | |
6374 | pos) | |
6375 | ||
bc22fd18 EZ |
6376 | (defun insert-directory-safely (file switches |
6377 | &optional wildcard full-directory-p) | |
6378 | "Insert directory listing for FILE, formatted according to SWITCHES. | |
6379 | ||
6380 | Like `insert-directory', but if FILE does not exist, it inserts a | |
6381 | message to that effect instead of signaling an error." | |
6382 | (if (file-exists-p file) | |
6383 | (insert-directory file switches wildcard full-directory-p) | |
6384 | ;; Simulate the message printed by `ls'. | |
6385 | (insert (format "%s: No such file or directory\n" file)))) | |
6386 | ||
88902b35 | 6387 | (defvar kill-emacs-query-functions nil |
65d5c6de | 6388 | "Functions to call with no arguments to query about killing Emacs. |
c80e3b4a | 6389 | If any of these functions returns nil, killing Emacs is canceled. |
6daab4ed JB |
6390 | `save-buffers-kill-emacs' calls these functions, but `kill-emacs', |
6391 | the low level primitive, does not. See also `kill-emacs-hook'.") | |
88902b35 | 6392 | |
11f15305 | 6393 | (defcustom confirm-kill-emacs nil |
9c2ba08f EZ |
6394 | "How to ask for confirmation when leaving Emacs. |
6395 | If nil, the default, don't ask at all. If the value is non-nil, it should | |
6396 | be a predicate function such as `yes-or-no-p'." | |
11f15305 GM |
6397 | :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p) |
6398 | (const :tag "Ask with y-or-n-p" y-or-n-p) | |
6399 | (const :tag "Don't confirm" nil)) | |
bdd9ab6e | 6400 | :group 'convenience |
11f15305 GM |
6401 | :version "21.1") |
6402 | ||
b4da00e9 RM |
6403 | (defun save-buffers-kill-emacs (&optional arg) |
6404 | "Offer to save each buffer, then kill this Emacs process. | |
02243d9d GM |
6405 | With prefix ARG, silently save all file-visiting buffers without asking. |
6406 | If there are active processes where `process-query-on-exit-flag' | |
6407 | returns non-nil, asks whether processes should be killed. | |
6408 | Runs the members of `kill-emacs-query-functions' in turn and stops | |
6409 | if any returns nil. If `confirm-kill-emacs' is non-nil, calls it." | |
b4da00e9 RM |
6410 | (interactive "P") |
6411 | (save-some-buffers arg t) | |
6412 | (and (or (not (memq t (mapcar (function | |
6413 | (lambda (buf) (and (buffer-file-name buf) | |
6414 | (buffer-modified-p buf)))) | |
6415 | (buffer-list)))) | |
6416 | (yes-or-no-p "Modified buffers exist; exit anyway? ")) | |
6417 | (or (not (fboundp 'process-list)) | |
7c2fb837 | 6418 | ;; process-list is not defined on MSDOS. |
b4da00e9 RM |
6419 | (let ((processes (process-list)) |
6420 | active) | |
6421 | (while processes | |
48a4a1fb KS |
6422 | (and (memq (process-status (car processes)) '(run stop open listen)) |
6423 | (process-query-on-exit-flag (car processes)) | |
b4da00e9 RM |
6424 | (setq active t)) |
6425 | (setq processes (cdr processes))) | |
6426 | (or (not active) | |
c5e28e39 MR |
6427 | (with-temp-buffer-window |
6428 | (get-buffer-create "*Process List*") nil | |
6429 | #'(lambda (window _value) | |
6430 | (with-selected-window window | |
6431 | (unwind-protect | |
6432 | (yes-or-no-p "Active processes exist; kill them and exit anyway? ") | |
6433 | (when (window-live-p window) | |
6434 | (quit-restore-window window 'kill))))) | |
6435 | (list-processes t))))) | |
88902b35 | 6436 | ;; Query the user for other things, perhaps. |
fb15c113 | 6437 | (run-hook-with-args-until-failure 'kill-emacs-query-functions) |
11f15305 GM |
6438 | (or (null confirm-kill-emacs) |
6439 | (funcall confirm-kill-emacs "Really exit Emacs? ")) | |
b4da00e9 | 6440 | (kill-emacs))) |
59e085e0 | 6441 | |
6ed8eeff | 6442 | (defun save-buffers-kill-terminal (&optional arg) |
59e085e0 KL |
6443 | "Offer to save each buffer, then kill the current connection. |
6444 | If the current frame has no client, kill Emacs itself. | |
6445 | ||
8fc29035 | 6446 | With prefix ARG, silently save all file-visiting buffers, then kill. |
59e085e0 KL |
6447 | |
6448 | If emacsclient was started with a list of filenames to edit, then | |
6449 | only these files will be asked to be saved." | |
6450 | (interactive "P") | |
0eef14bd CY |
6451 | (if (frame-parameter (selected-frame) 'client) |
6452 | (server-save-buffers-kill-terminal arg) | |
6453 | (save-buffers-kill-emacs arg))) | |
b4da00e9 | 6454 | \f |
ffc0e1ca | 6455 | ;; We use /: as a prefix to "quote" a file name |
47afc068 RS |
6456 | ;; so that magic file name handlers will not apply to it. |
6457 | ||
6458 | (setq file-name-handler-alist | |
6d341a2a | 6459 | (cons (cons (purecopy "\\`/:") 'file-name-non-special) |
47afc068 RS |
6460 | file-name-handler-alist)) |
6461 | ||
6462 | ;; We depend on being the last handler on the list, | |
6463 | ;; so that anything else which does need handling | |
6464 | ;; has been handled already. | |
6465 | ;; So it is safe for us to inhibit *all* magic file name handlers. | |
6466 | ||
6467 | (defun file-name-non-special (operation &rest arguments) | |
6468 | (let ((file-name-handler-alist nil) | |
5cb1f728 KH |
6469 | (default-directory |
6470 | (if (eq operation 'insert-directory) | |
6471 | (directory-file-name | |
ffc0e1ca | 6472 | (expand-file-name |
5cb1f728 KH |
6473 | (unhandled-file-name-directory default-directory))) |
6474 | default-directory)) | |
47afc068 RS |
6475 | ;; Get a list of the indices of the args which are file names. |
6476 | (file-arg-indices | |
6477 | (cdr (or (assq operation | |
ae3b2983 | 6478 | ;; The first six are special because they |
47afc068 RS |
6479 | ;; return a file name. We want to include the /: |
6480 | ;; in the return value. | |
6481 | ;; So just avoid stripping it in the first place. | |
6482 | '((expand-file-name . nil) | |
6483 | (file-name-directory . nil) | |
6484 | (file-name-as-directory . nil) | |
6485 | (directory-file-name . nil) | |
c736f678 | 6486 | (file-name-sans-versions . nil) |
ae3b2983 | 6487 | (find-backup-file-name . nil) |
c736f678 | 6488 | ;; `identity' means just return the first arg |
6750c852 RS |
6489 | ;; not stripped of its quoting. |
6490 | (substitute-in-file-name identity) | |
ae3b2983 MA |
6491 | ;; `add' means add "/:" to the result. |
6492 | (file-truename add 0) | |
10e1d5f3 | 6493 | (insert-file-contents insert-file-contents 0) |
ae3b2983 MA |
6494 | ;; `unquote-then-quote' means set buffer-file-name |
6495 | ;; temporarily to unquoted filename. | |
6496 | (verify-visited-file-modtime unquote-then-quote) | |
6497 | ;; List the arguments which are filenames. | |
c37adaa5 SM |
6498 | (file-name-completion 1) |
6499 | (file-name-all-completions 1) | |
ae3b2983 | 6500 | (write-region 2 5) |
47afc068 RS |
6501 | (rename-file 0 1) |
6502 | (copy-file 0 1) | |
6503 | (make-symbolic-link 0 1) | |
6504 | (add-name-to-file 0 1))) | |
6505 | ;; For all other operations, treat the first argument only | |
6506 | ;; as the file name. | |
6507 | '(nil 0)))) | |
6750c852 | 6508 | method |
47afc068 RS |
6509 | ;; Copy ARGUMENTS so we can replace elements in it. |
6510 | (arguments (copy-sequence arguments))) | |
6750c852 RS |
6511 | (if (symbolp (car file-arg-indices)) |
6512 | (setq method (pop file-arg-indices))) | |
6513 | ;; Strip off the /: from the file names that have it. | |
47afc068 | 6514 | (save-match-data |
18b9dced | 6515 | (while (consp file-arg-indices) |
fe4d9852 KH |
6516 | (let ((pair (nthcdr (car file-arg-indices) arguments))) |
6517 | (and (car pair) | |
6518 | (string-match "\\`/:" (car pair)) | |
6519 | (setcar pair | |
6520 | (if (= (length (car pair)) 2) | |
6521 | "/" | |
6522 | (substring (car pair) 2))))) | |
47afc068 | 6523 | (setq file-arg-indices (cdr file-arg-indices)))) |
36cec983 SM |
6524 | (pcase method |
6525 | (`identity (car arguments)) | |
6526 | (`add (concat "/:" (apply operation arguments))) | |
6527 | (`insert-file-contents | |
10e1d5f3 SM |
6528 | (let ((visit (nth 1 arguments))) |
6529 | (prog1 | |
5a315f9c | 6530 | (apply operation arguments) |
10e1d5f3 SM |
6531 | (when (and visit buffer-file-name) |
6532 | (setq buffer-file-name (concat "/:" buffer-file-name)))))) | |
36cec983 | 6533 | (`unquote-then-quote |
10e1d5f3 SM |
6534 | (let ((buffer-file-name (substring buffer-file-name 2))) |
6535 | (apply operation arguments))) | |
36cec983 | 6536 | (_ |
5a315f9c | 6537 | (apply operation arguments))))) |
47afc068 | 6538 | \f |
90d10f16 MC |
6539 | ;; Symbolic modes and read-file-modes. |
6540 | ||
6541 | (defun file-modes-char-to-who (char) | |
e240aaa9 EZ |
6542 | "Convert CHAR to a numeric bit-mask for extracting mode bits. |
6543 | CHAR is in [ugoa] and represents the category of users (Owner, Group, | |
6544 | Others, or All) for whom to produce the mask. | |
6545 | The bit-mask that is returned extracts from mode bits the access rights | |
6546 | for the specified category of users." | |
90d10f16 MC |
6547 | (cond ((= char ?u) #o4700) |
6548 | ((= char ?g) #o2070) | |
6549 | ((= char ?o) #o1007) | |
6550 | ((= char ?a) #o7777) | |
6551 | (t (error "%c: bad `who' character" char)))) | |
6552 | ||
6553 | (defun file-modes-char-to-right (char &optional from) | |
e240aaa9 EZ |
6554 | "Convert CHAR to a numeric value of mode bits. |
6555 | CHAR is in [rwxXstugo] and represents symbolic access permissions. | |
6556 | If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)." | |
90d10f16 MC |
6557 | (or from (setq from 0)) |
6558 | (cond ((= char ?r) #o0444) | |
6559 | ((= char ?w) #o0222) | |
6560 | ((= char ?x) #o0111) | |
6561 | ((= char ?s) #o1000) | |
6562 | ((= char ?t) #o6000) | |
6563 | ;; Rights relative to the previous file modes. | |
6564 | ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111)) | |
6565 | ((= char ?u) (let ((uright (logand #o4700 from))) | |
6566 | (+ uright (/ uright #o10) (/ uright #o100)))) | |
6567 | ((= char ?g) (let ((gright (logand #o2070 from))) | |
6568 | (+ gright (/ gright #o10) (* gright #o10)))) | |
6569 | ((= char ?o) (let ((oright (logand #o1007 from))) | |
6570 | (+ oright (* oright #o10) (* oright #o100)))) | |
6571 | (t (error "%c: bad right character" char)))) | |
6572 | ||
6573 | (defun file-modes-rights-to-number (rights who-mask &optional from) | |
e240aaa9 | 6574 | "Convert a symbolic mode string specification to an equivalent number. |
ca66f00d | 6575 | RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\". |
e240aaa9 EZ |
6576 | WHO-MASK is the bit-mask specifying the category of users to which to |
6577 | apply the access permissions. See `file-modes-char-to-who'. | |
6578 | FROM (or 0 if nil) gives the mode bits on which to base permissions if | |
6579 | RIGHTS request to add, remove, or set permissions based on existing ones, | |
6580 | as in \"og+rX-w\"." | |
90d10f16 MC |
6581 | (let* ((num-rights (or from 0)) |
6582 | (list-rights (string-to-list rights)) | |
6583 | (op (pop list-rights))) | |
6584 | (while (memq op '(?+ ?- ?=)) | |
6585 | (let ((num-right 0) | |
6586 | char-right) | |
6587 | (while (memq (setq char-right (pop list-rights)) | |
6588 | '(?r ?w ?x ?X ?s ?t ?u ?g ?o)) | |
6589 | (setq num-right | |
6590 | (logior num-right | |
6591 | (file-modes-char-to-right char-right num-rights)))) | |
6592 | (setq num-right (logand who-mask num-right) | |
6593 | num-rights | |
6594 | (cond ((= op ?+) (logior num-rights num-right)) | |
6595 | ((= op ?-) (logand num-rights (lognot num-right))) | |
6596 | (t (logior (logand num-rights (lognot who-mask)) num-right))) | |
6597 | op char-right))) | |
6598 | num-rights)) | |
6599 | ||
6600 | (defun file-modes-symbolic-to-number (modes &optional from) | |
6601 | "Convert symbolic file modes to numeric file modes. | |
6602 | MODES is the string to convert, it should match | |
ca66f00d | 6603 | \"[ugoa]*([+-=][rwxXstugo]*)+,...\". |
64b51947 | 6604 | See Info node `(coreutils)File permissions' for more information on this |
90d10f16 | 6605 | notation. |
e240aaa9 EZ |
6606 | FROM (or 0 if nil) gives the mode bits on which to base permissions if |
6607 | MODES request to add, remove, or set permissions based on existing ones, | |
6608 | as in \"og+rX-w\"." | |
90d10f16 MC |
6609 | (save-match-data |
6610 | (let ((case-fold-search nil) | |
6611 | (num-modes (or from 0))) | |
6612 | (while (/= (string-to-char modes) 0) | |
ca66f00d | 6613 | (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes) |
90d10f16 MC |
6614 | (let ((num-who (apply 'logior 0 |
6615 | (mapcar 'file-modes-char-to-who | |
6616 | (match-string 1 modes))))) | |
6617 | (when (= num-who 0) | |
6618 | (setq num-who (default-file-modes))) | |
6619 | (setq num-modes | |
6620 | (file-modes-rights-to-number (substring modes (match-end 1)) | |
6621 | num-who num-modes) | |
6622 | modes (substring modes (match-end 3)))) | |
6623 | (error "Parse error in modes near `%s'" (substring modes 0)))) | |
6624 | num-modes))) | |
6625 | ||
6626 | (defun read-file-modes (&optional prompt orig-file) | |
e240aaa9 | 6627 | "Read file modes in octal or symbolic notation and return its numeric value. |
90d10f16 | 6628 | PROMPT is used as the prompt, default to `File modes (octal or symbolic): '. |
e240aaa9 EZ |
6629 | ORIG-FILE is the name of a file on whose mode bits to base returned |
6630 | permissions if what user types requests to add, remove, or set permissions | |
6631 | based on existing mode bits, as in \"og+rX-w\"." | |
90d10f16 MC |
6632 | (let* ((modes (or (if orig-file (file-modes orig-file) 0) |
6633 | (error "File not found"))) | |
7cb41b32 JL |
6634 | (modestr (and (stringp orig-file) |
6635 | (nth 8 (file-attributes orig-file)))) | |
6636 | (default | |
6637 | (and (stringp modestr) | |
6638 | (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr) | |
6639 | (replace-regexp-in-string | |
6640 | "-" "" | |
6641 | (format "u=%s,g=%s,o=%s" | |
6642 | (match-string 1 modestr) | |
6643 | (match-string 2 modestr) | |
6644 | (match-string 3 modestr))))) | |
6645 | (value (read-string (or prompt "File modes (octal or symbolic): ") | |
6646 | nil nil default))) | |
90d10f16 MC |
6647 | (save-match-data |
6648 | (if (string-match "^[0-7]+" value) | |
6649 | (string-to-number value 8) | |
6650 | (file-modes-symbolic-to-number value modes))))) | |
6651 | ||
6652 | \f | |
e240aaa9 | 6653 | ;; Trashcan handling. |
d63a01ef | 6654 | (defcustom trash-directory nil |
6cf29fe8 | 6655 | "Directory for `move-file-to-trash' to move files and directories to. |
d63a01ef CY |
6656 | This directory is only used when the function `system-move-file-to-trash' |
6657 | is not defined. | |
6658 | Relative paths are interpreted relative to `default-directory'. | |
6659 | If the value is nil, Emacs uses a freedesktop.org-style trashcan." | |
f7c0d931 | 6660 | :type '(choice (const nil) directory) |
6cf29fe8 | 6661 | :group 'auto-save |
d63a01ef CY |
6662 | :version "23.2") |
6663 | ||
6664 | (defvar trash--hexify-table) | |
6cf29fe8 JR |
6665 | |
6666 | (declare-function system-move-file-to-trash "w32fns.c" (filename)) | |
6667 | ||
6668 | (defun move-file-to-trash (filename) | |
d63a01ef CY |
6669 | "Move the file (or directory) named FILENAME to the trash. |
6670 | When `delete-by-moving-to-trash' is non-nil, this function is | |
6671 | called by `delete-file' and `delete-directory' instead of | |
6672 | deleting files outright. | |
6673 | ||
6674 | If the function `system-move-file-to-trash' is defined, call it | |
6675 | with FILENAME as an argument. | |
6676 | Otherwise, if `trash-directory' is non-nil, move FILENAME to that | |
6677 | directory. | |
6678 | Otherwise, trash FILENAME using the freedesktop.org conventions, | |
6679 | like the GNOME, KDE and XFCE desktop environments. Emacs only | |
6680 | moves files to \"home trash\", ignoring per-volume trashcans." | |
6cf29fe8 | 6681 | (interactive "fMove file to trash: ") |
d63a01ef CY |
6682 | (cond (trash-directory |
6683 | ;; If `trash-directory' is non-nil, move the file there. | |
6684 | (let* ((trash-dir (expand-file-name trash-directory)) | |
6685 | (fn (directory-file-name (expand-file-name filename))) | |
6686 | (new-fn (expand-file-name (file-name-nondirectory fn) | |
6687 | trash-dir))) | |
6688 | ;; We can't trash a parent directory of trash-directory. | |
1acad97c | 6689 | (if (string-prefix-p fn trash-dir) |
d63a01ef CY |
6690 | (error "Trash directory `%s' is a subdirectory of `%s'" |
6691 | trash-dir filename)) | |
6692 | (unless (file-directory-p trash-dir) | |
6693 | (make-directory trash-dir t)) | |
6694 | ;; Ensure that the trashed file-name is unique. | |
6695 | (if (file-exists-p new-fn) | |
6696 | (let ((version-control t) | |
6697 | (backup-directory-alist nil)) | |
6698 | (setq new-fn (car (find-backup-file-name new-fn))))) | |
6699 | (let (delete-by-moving-to-trash) | |
6700 | (rename-file fn new-fn)))) | |
6701 | ;; If `system-move-file-to-trash' is defined, use it. | |
6702 | ((fboundp 'system-move-file-to-trash) | |
6703 | (system-move-file-to-trash filename)) | |
6704 | ;; Otherwise, use the freedesktop.org method, as specified at | |
6705 | ;; http://freedesktop.org/wiki/Specifications/trash-spec | |
6706 | (t | |
6707 | (let* ((xdg-data-dir | |
6708 | (directory-file-name | |
6709 | (expand-file-name "Trash" | |
6710 | (or (getenv "XDG_DATA_HOME") | |
6711 | "~/.local/share")))) | |
6712 | (trash-files-dir (expand-file-name "files" xdg-data-dir)) | |
6713 | (trash-info-dir (expand-file-name "info" xdg-data-dir)) | |
6714 | (fn (directory-file-name (expand-file-name filename)))) | |
6715 | ||
6716 | ;; Check if we have permissions to delete. | |
6717 | (unless (file-writable-p (directory-file-name | |
6718 | (file-name-directory fn))) | |
6719 | (error "Cannot move %s to trash: Permission denied" filename)) | |
6720 | ;; The trashed file cannot be the trash dir or its parent. | |
1acad97c | 6721 | (if (string-prefix-p fn trash-files-dir) |
d63a01ef CY |
6722 | (error "The trash directory %s is a subdirectory of %s" |
6723 | trash-files-dir filename)) | |
1acad97c | 6724 | (if (string-prefix-p fn trash-info-dir) |
d63a01ef CY |
6725 | (error "The trash directory %s is a subdirectory of %s" |
6726 | trash-info-dir filename)) | |
6727 | ||
6728 | ;; Ensure that the trash directory exists; otherwise, create it. | |
6729 | (let ((saved-default-file-modes (default-file-modes))) | |
6bb72cbd PE |
6730 | (unwind-protect |
6731 | (progn | |
6732 | (set-default-file-modes #o700) | |
6733 | (unless (file-exists-p trash-files-dir) | |
6734 | (make-directory trash-files-dir t)) | |
6735 | (unless (file-exists-p trash-info-dir) | |
6736 | (make-directory trash-info-dir t))) | |
6737 | (set-default-file-modes saved-default-file-modes))) | |
d63a01ef CY |
6738 | |
6739 | ;; Try to move to trash with .trashinfo undo information | |
6740 | (save-excursion | |
6741 | (with-temp-buffer | |
6742 | (set-buffer-file-coding-system 'utf-8-unix) | |
6743 | (insert "[Trash Info]\nPath=") | |
6744 | ;; Perform url-encoding on FN. For compatibility with | |
6745 | ;; other programs (e.g. XFCE Thunar), allow literal "/" | |
6746 | ;; for path separators. | |
6747 | (unless (boundp 'trash--hexify-table) | |
6748 | (setq trash--hexify-table (make-vector 256 nil)) | |
6749 | (let ((unreserved-chars | |
6750 | (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m | |
6751 | ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A | |
6752 | ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O | |
6753 | ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2 | |
6754 | ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?' | |
6755 | ?\( ?\)))) | |
6756 | (dotimes (byte 256) | |
6757 | (aset trash--hexify-table byte | |
6758 | (if (memq byte unreserved-chars) | |
6759 | (char-to-string byte) | |
6760 | (format "%%%02x" byte)))))) | |
6761 | (mapc (lambda (byte) | |
6762 | (insert (aref trash--hexify-table byte))) | |
6763 | (if (multibyte-string-p fn) | |
6764 | (encode-coding-string fn 'utf-8) | |
6765 | fn)) | |
6766 | (insert "\nDeletionDate=" | |
6767 | (format-time-string "%Y-%m-%dT%T") | |
6768 | "\n") | |
6769 | ||
6770 | ;; Attempt to make .trashinfo file, trying up to 5 | |
6771 | ;; times. The .trashinfo file is opened with O_EXCL, | |
6772 | ;; as per trash-spec 0.7, even if that can be a problem | |
6773 | ;; on old NFS versions... | |
6774 | (let* ((tries 5) | |
6775 | (base-fn (expand-file-name | |
6776 | (file-name-nondirectory fn) | |
6777 | trash-files-dir)) | |
6778 | (new-fn base-fn) | |
6779 | success info-fn) | |
6780 | (while (> tries 0) | |
6781 | (setq info-fn (expand-file-name | |
6782 | (concat (file-name-nondirectory new-fn) | |
6783 | ".trashinfo") | |
6784 | trash-info-dir)) | |
6785 | (unless (condition-case nil | |
6786 | (progn | |
6787 | (write-region nil nil info-fn nil | |
6788 | 'quiet info-fn 'excl) | |
6789 | (setq tries 0 success t)) | |
6790 | (file-already-exists nil)) | |
6791 | (setq tries (1- tries)) | |
8350f087 | 6792 | ;; Uniquify new-fn. (Some file managers do not |
d63a01ef CY |
6793 | ;; like Emacs-style backup file names---e.g. bug |
6794 | ;; 170956 in Konqueror bug tracker.) | |
6795 | (setq new-fn (make-temp-name (concat base-fn "_"))))) | |
6796 | (unless success | |
6797 | (error "Cannot move %s to trash: Lock failed" filename)) | |
6798 | ||
6799 | ;; Finally, try to move the file to the trashcan. | |
6800 | (let ((delete-by-moving-to-trash nil)) | |
6801 | (rename-file fn new-fn))))))))) | |
6cf29fe8 JR |
6802 | |
6803 | \f | |
b4da00e9 | 6804 | (define-key ctl-x-map "\C-f" 'find-file) |
b4da00e9 RM |
6805 | (define-key ctl-x-map "\C-r" 'find-file-read-only) |
6806 | (define-key ctl-x-map "\C-v" 'find-alternate-file) | |
6807 | (define-key ctl-x-map "\C-s" 'save-buffer) | |
6808 | (define-key ctl-x-map "s" 'save-some-buffers) | |
6809 | (define-key ctl-x-map "\C-w" 'write-file) | |
6810 | (define-key ctl-x-map "i" 'insert-file) | |
6811 | (define-key esc-map "~" 'not-modified) | |
6812 | (define-key ctl-x-map "\C-d" 'list-directory) | |
6ed8eeff | 6813 | (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal) |
3df47cd5 | 6814 | (define-key ctl-x-map "\C-q" 'read-only-mode) |
b4da00e9 RM |
6815 | |
6816 | (define-key ctl-x-4-map "f" 'find-file-other-window) | |
6817 | (define-key ctl-x-4-map "r" 'find-file-read-only-other-window) | |
6818 | (define-key ctl-x-4-map "\C-f" 'find-file-other-window) | |
6819 | (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window) | |
924f0a24 | 6820 | (define-key ctl-x-4-map "\C-o" 'display-buffer) |
5bbbceb1 | 6821 | |
f98955ea JB |
6822 | (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame) |
6823 | (define-key ctl-x-5-map "f" 'find-file-other-frame) | |
6824 | (define-key ctl-x-5-map "\C-f" 'find-file-other-frame) | |
6825 | (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame) | |
3095ccf5 | 6826 | (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame) |
c0274f38 ER |
6827 | |
6828 | ;;; files.el ends here |