Commit | Line | Data |
---|---|---|
76dc5996 | 1 | ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*- |
c0274f38 | 2 | |
ba318903 | 3 | ;; Copyright (C) 1985-1987, 1992-2014 Free Software Foundation, Inc. |
b4da00e9 | 4 | |
34dc21db | 5 | ;; Maintainer: emacs-devel@gnu.org |
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 | |
2356b316 LI |
99 | "If non-nil, backups will be inhibited. |
100 | This variable is intended for use by making it local to a buffer, | |
101 | but it is not an automatically buffer-local variable.") | |
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 |
893cc908 LI |
162 | "Non-nil means visiting a file uses its truename as the visited-file name. |
163 | That is, the buffer visiting the file has the truename as the | |
164 | value of `buffer-file-name'. The truename of a file is found by | |
165 | chasing all links both at the file level and at the levels of the | |
166 | containing directories." | |
21540597 RS |
167 | :type 'boolean |
168 | :group 'find-file) | |
290c2be5 | 169 | (put 'find-file-visit-truename 'safe-local-variable 'booleanp) |
f3e23606 | 170 | |
26b9ecbc | 171 | (defcustom revert-without-query nil |
ba83982b | 172 | "Specify which files should be reverted without query. |
ebeb898f RS |
173 | The value is a list of regular expressions. |
174 | If the file name matches one of these regular expressions, | |
db8c4866 | 175 | then `revert-buffer' reverts the file without querying |
21540597 | 176 | if the file has changed on disk and you have not edited the buffer." |
a0d809f2 | 177 | :type '(repeat regexp) |
21540597 | 178 | :group 'find-file) |
ebeb898f | 179 | |
f3e23606 RS |
180 | (defvar buffer-file-number nil |
181 | "The device number and file number of the file visited in the current buffer. | |
182 | The value is a list of the form (FILENUM DEVNUM). | |
183 | This pair of numbers uniquely identifies the file. | |
184 | If the buffer is visiting a new file, the value is nil.") | |
185 | (make-variable-buffer-local 'buffer-file-number) | |
186 | (put 'buffer-file-number 'permanent-local t) | |
187 | ||
de88363f | 188 | (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt))) |
26b9ecbc | 189 | "Non-nil means that `buffer-file-number' uniquely identifies files.") |
de88363f | 190 | |
e554eeb7 RS |
191 | (defvar buffer-file-read-only nil |
192 | "Non-nil if visited file was read-only when visited.") | |
193 | (make-variable-buffer-local 'buffer-file-read-only) | |
194 | ||
388d6ab5 | 195 | (defcustom small-temporary-file-directory |
eb61b61b RS |
196 | (if (eq system-type 'ms-dos) (getenv "TMPDIR")) |
197 | "The directory for writing small temporary files. | |
198 | If non-nil, this directory is used instead of `temporary-file-directory' | |
199 | by programs that create small temporary files. This is for systems that | |
388d6ab5 RS |
200 | have fast storage with limited space, such as a RAM disk." |
201 | :group 'files | |
adba8116 | 202 | :initialize 'custom-initialize-delay |
bab6eadb | 203 | :type '(choice (const nil) directory)) |
eb61b61b RS |
204 | |
205 | ;; The system null device. (Should reference NULL_DEVICE from C.) | |
a7610c52 | 206 | (defvar null-device (purecopy "/dev/null") "The system null device.") |
eb61b61b | 207 | |
73e6adaa DN |
208 | (declare-function msdos-long-file-names "msdos.c") |
209 | (declare-function w32-long-file-name "w32proc.c") | |
e8ffb999 | 210 | (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep)) |
f440830d | 211 | (declare-function dired-unmark "dired" (arg &optional interactive)) |
e8ffb999 DN |
212 | (declare-function dired-do-flagged-delete "dired" (&optional nomessage)) |
213 | (declare-function dos-8+3-filename "dos-fns" (filename)) | |
7533b418 | 214 | (declare-function dosified-file-name "dos-fns" (file-name)) |
e8ffb999 | 215 | |
30966847 EZ |
216 | (defvar file-name-invalid-regexp |
217 | (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names))) | |
a7610c52 | 218 | (purecopy |
9959c16e | 219 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
30966847 | 220 | "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters |
12f68d3f | 221 | "[\000-\037]\\|" ; control characters |
30966847 | 222 | "\\(/\\.\\.?[^/]\\)\\|" ; leading dots |
a7610c52 | 223 | "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot |
c60ee5e7 | 224 | ((memq system-type '(ms-dos windows-nt cygwin)) |
a7610c52 | 225 | (purecopy |
9959c16e | 226 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
a7610c52 DN |
227 | "[|<>\"?*\000-\037]"))) ; invalid characters |
228 | (t (purecopy "[\000]"))) | |
30966847 EZ |
229 | "Regexp recognizing file names which aren't allowed by the filesystem.") |
230 | ||
21540597 | 231 | (defcustom file-precious-flag nil |
ba83982b | 232 | "Non-nil means protect against I/O errors while saving files. |
560f4415 | 233 | Some modes set this non-nil in particular buffers. |
4b7271c1 KH |
234 | |
235 | This feature works by writing the new contents into a temporary file | |
236 | and then renaming the temporary file to replace the original. | |
237 | In this way, any I/O error in writing leaves the original untouched, | |
238 | and there is never any instant where the file is nonexistent. | |
239 | ||
240 | Note that this feature forces backups to be made by copying. | |
560f4415 | 241 | Yet, at the same time, saving a precious file |
dab71b2c KF |
242 | breaks any hard links between it and other files. |
243 | ||
244 | This feature is advisory: for example, if the directory in which the | |
622bdb51 | 245 | file is being saved is not writable, Emacs may ignore a non-nil value |
1d367309 KF |
246 | of `file-precious-flag' and write directly into the file. |
247 | ||
248 | See also: `break-hardlink-on-save'." | |
21540597 RS |
249 | :type 'boolean |
250 | :group 'backup) | |
b4da00e9 | 251 | |
1d367309 | 252 | (defcustom break-hardlink-on-save nil |
e2f6a0bc CY |
253 | "Whether to allow breaking hardlinks when saving files. |
254 | If non-nil, then when saving a file that exists under several | |
255 | names \(i.e., has multiple hardlinks), break the hardlink | |
256 | associated with `buffer-file-name' and write to a new file, so | |
257 | that the other instances of the file are not affected by the | |
258 | save. | |
1d367309 KF |
259 | |
260 | If `buffer-file-name' refers to a symlink, do not break the symlink. | |
261 | ||
262 | Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory. | |
263 | For example, if the directory in which a file is being saved is not | |
622bdb51 | 264 | itself writable, then error instead of saving in some |
1d367309 KF |
265 | hardlink-nonbreaking way. |
266 | ||
267 | See also `backup-by-copying' and `backup-by-copying-when-linked'." | |
268 | :type 'boolean | |
76e7a7f0 JB |
269 | :group 'files |
270 | :version "23.1") | |
1d367309 | 271 | |
21540597 | 272 | (defcustom version-control nil |
ba83982b | 273 | "Control use of version numbers for backup files. |
93e7eeb4 JB |
274 | When t, make numeric backup versions unconditionally. |
275 | When nil, make them for files that have some already. | |
276 | The value `never' means do not make them." | |
e48807d1 AS |
277 | :type '(choice (const :tag "Never" never) |
278 | (const :tag "If existing" nil) | |
279 | (other :tag "Always" t)) | |
21540597 RS |
280 | :group 'backup |
281 | :group 'vc) | |
e48335de | 282 | (put 'version-control 'safe-local-variable |
4f91a816 | 283 | (lambda (x) (or (booleanp x) (equal x 'never)))) |
21540597 RS |
284 | |
285 | (defcustom dired-kept-versions 2 | |
ba83982b | 286 | "When cleaning directory, number of versions to keep." |
21540597 RS |
287 | :type 'integer |
288 | :group 'backup | |
289 | :group 'dired) | |
290 | ||
291 | (defcustom delete-old-versions nil | |
ba83982b | 292 | "If t, delete excess backup versions silently. |
21540597 RS |
293 | If nil, ask confirmation. Any other value prevents any trimming." |
294 | :type '(choice (const :tag "Delete" t) | |
295 | (const :tag "Ask" nil) | |
e48807d1 | 296 | (other :tag "Leave" other)) |
21540597 RS |
297 | :group 'backup) |
298 | ||
299 | (defcustom kept-old-versions 2 | |
ba83982b | 300 | "Number of oldest versions to keep when a new numbered backup is made." |
21540597 RS |
301 | :type 'integer |
302 | :group 'backup) | |
631c8020 | 303 | (put 'kept-old-versions 'safe-local-variable 'integerp) |
21540597 RS |
304 | |
305 | (defcustom kept-new-versions 2 | |
ba83982b | 306 | "Number of newest versions to keep when a new numbered backup is made. |
21540597 RS |
307 | Includes the new backup. Must be > 0" |
308 | :type 'integer | |
309 | :group 'backup) | |
631c8020 | 310 | (put 'kept-new-versions 'safe-local-variable 'integerp) |
b4da00e9 | 311 | |
21540597 | 312 | (defcustom require-final-newline nil |
ba83982b | 313 | "Whether to add a newline automatically at the end of the file. |
f4206092 RS |
314 | |
315 | A value of t means do this only when the file is about to be saved. | |
316 | A value of `visit' means do this right after the file is visited. | |
317 | A value of `visit-save' means do it at both of those times. | |
318 | Any other non-nil value means ask user whether to add a newline, when saving. | |
756c496f | 319 | A value of nil means don't add newlines. |
f4206092 RS |
320 | |
321 | Certain major modes set this locally to the value obtained | |
322 | from `mode-require-final-newline'." | |
56973319 | 323 | :safe #'symbolp |
f4206092 RS |
324 | :type '(choice (const :tag "When visiting" visit) |
325 | (const :tag "When saving" t) | |
326 | (const :tag "When visiting or saving" visit-save) | |
93d1963d | 327 | (const :tag "Don't add newlines" nil) |
0776da52 | 328 | (other :tag "Ask each time" ask)) |
17bd3d04 | 329 | :group 'editing-basics) |
b4da00e9 | 330 | |
f4206092 | 331 | (defcustom mode-require-final-newline t |
ba83982b | 332 | "Whether to add a newline at end of file, in certain major modes. |
f4206092 | 333 | Those modes set `require-final-newline' to this value when you enable them. |
0776da52 | 334 | They do so because they are often used for files that are supposed |
f4206092 RS |
335 | to end in newlines, and the question is how to arrange that. |
336 | ||
337 | A value of t means do this only when the file is about to be saved. | |
338 | A value of `visit' means do this right after the file is visited. | |
339 | A value of `visit-save' means do it at both of those times. | |
5e9961be | 340 | Any other non-nil value means ask user whether to add a newline, when saving. |
5e9961be | 341 | |
756c496f JB |
342 | A value of nil means do not add newlines. That is a risky choice in this |
343 | variable since this value is used for modes for files that ought to have | |
344 | final newlines. So if you set this to nil, you must explicitly check and | |
345 | add a final newline, whenever you save a file that really needs one." | |
f4206092 RS |
346 | :type '(choice (const :tag "When visiting" visit) |
347 | (const :tag "When saving" t) | |
348 | (const :tag "When visiting or saving" visit-save) | |
93d1963d RS |
349 | (const :tag "Don't add newlines" nil) |
350 | (other :tag "Ask each time" ask)) | |
f4206092 | 351 | :group 'editing-basics |
bf247b6e | 352 | :version "22.1") |
f4206092 | 353 | |
21540597 | 354 | (defcustom auto-save-default t |
ba83982b | 355 | "Non-nil says by default do auto-saving of every file-visiting buffer." |
21540597 RS |
356 | :type 'boolean |
357 | :group 'auto-save) | |
b4da00e9 | 358 | |
ffc0e1ca | 359 | (defcustom auto-save-file-name-transforms |
b1e5937c | 360 | `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'" |
747981b0 EZ |
361 | ;; Don't put "\\2" inside expand-file-name, since it will be |
362 | ;; transformed to "/2" on DOS/Windows. | |
a0b60c33 | 363 | ,(concat temporary-file-directory "\\2") t)) |
ba83982b | 364 | "Transforms to apply to buffer file name before making auto-save file name. |
a0b60c33 | 365 | Each transform is a list (REGEXP REPLACEMENT UNIQUIFY): |
ffc0e1ca AS |
366 | REGEXP is a regular expression to match against the file name. |
367 | If it matches, `replace-match' is used to replace the | |
368 | matching part with REPLACEMENT. | |
a0b60c33 | 369 | If the optional element UNIQUIFY is non-nil, the auto-save file name is |
36236b72 | 370 | constructed by taking the directory part of the replaced file-name, |
a0b60c33 GM |
371 | concatenated with the buffer file name with all directory separators |
372 | changed to `!' to prevent clashes. This will not work | |
373 | correctly if your filesystem truncates the resulting name. | |
374 | ||
ffc0e1ca AS |
375 | All the transforms in the list are tried, in the order they are listed. |
376 | When one transform applies, its result is final; | |
377 | no further transforms are tried. | |
378 | ||
a2899d6c KG |
379 | The default value is set up to put the auto-save file into the |
380 | temporary directory (see the variable `temporary-file-directory') for | |
a0b60c33 GM |
381 | editing a remote file. |
382 | ||
383 | On MS-DOS filesystems without long names this variable is always | |
384 | ignored." | |
ffc0e1ca | 385 | :group 'auto-save |
a0b60c33 GM |
386 | :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement") |
387 | (boolean :tag "Uniquify"))) | |
adba8116 | 388 | :initialize 'custom-initialize-delay |
ffc0e1ca AS |
389 | :version "21.1") |
390 | ||
88b36776 | 391 | (defcustom save-abbrevs t |
ba83982b | 392 | "Non-nil means save word abbrevs too when files are saved. |
02c6a1cc EZ |
393 | If `silently', don't ask the user before saving." |
394 | :type '(choice (const t) (const nil) (const silently)) | |
21540597 | 395 | :group 'abbrev) |
b4da00e9 | 396 | |
21540597 | 397 | (defcustom find-file-run-dired t |
ba83982b | 398 | "Non-nil means allow `find-file' to visit directories. |
ffc0e1ca | 399 | To visit the directory, `find-file' runs `find-directory-functions'." |
21540597 RS |
400 | :type 'boolean |
401 | :group 'find-file) | |
b4da00e9 | 402 | |
ffc0e1ca | 403 | (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect) |
ba83982b | 404 | "List of functions to try in sequence to visit a directory. |
ffc0e1ca AS |
405 | Each function is called with the directory name as the sole argument |
406 | and should return either a buffer or nil." | |
407 | :type '(hook :options (cvs-dired-noselect dired-noselect)) | |
408 | :group 'find-file) | |
409 | ||
7d371eac JL |
410 | ;; FIXME: also add a hook for `(thing-at-point 'filename)' |
411 | (defcustom file-name-at-point-functions '(ffap-guess-file-name-at-point) | |
412 | "List of functions to try in sequence to get a file name at point. | |
413 | Each function should return either nil or a file name found at the | |
414 | location of point in the current buffer." | |
415 | :type '(hook :options (ffap-guess-file-name-at-point)) | |
416 | :group 'find-file) | |
417 | ||
92966e6f RS |
418 | ;;;It is not useful to make this a local variable. |
419 | ;;;(put 'find-file-not-found-hooks 'permanent-local t) | |
e5bd0a28 SM |
420 | (define-obsolete-variable-alias 'find-file-not-found-hooks |
421 | 'find-file-not-found-functions "22.1") | |
0370fe77 | 422 | (defvar find-file-not-found-functions nil |
b4da00e9 RM |
423 | "List of functions to be called for `find-file' on nonexistent file. |
424 | These functions are called as soon as the error is detected. | |
ffc0e1ca | 425 | Variable `buffer-file-name' is already set up. |
b4da00e9 RM |
426 | The functions are called in the order given until one of them returns non-nil.") |
427 | ||
92966e6f RS |
428 | ;;;It is not useful to make this a local variable. |
429 | ;;;(put 'find-file-hooks 'permanent-local t) | |
cd6ef82d | 430 | (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1") |
564af258 | 431 | (defcustom find-file-hook nil |
b4da00e9 RM |
432 | "List of functions to be called after a buffer is loaded from a file. |
433 | The buffer's local variables (if any) will have been processed before the | |
564af258 DL |
434 | functions are called." |
435 | :group 'find-file | |
436 | :type 'hook | |
437 | :options '(auto-insert) | |
bf247b6e | 438 | :version "22.1") |
b4da00e9 | 439 | |
e5bd0a28 | 440 | (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1") |
0370fe77 | 441 | (defvar write-file-functions nil |
b4da00e9 RM |
442 | "List of functions to be called before writing out a buffer to a file. |
443 | If one of them returns non-nil, the file is considered already written | |
8c0e7b73 JB |
444 | and the rest are not called. |
445 | These hooks are considered to pertain to the visited file. | |
0370fe77 SM |
446 | So any buffer-local binding of this variable is discarded if you change |
447 | the visited file name with \\[set-visited-file-name], but not when you | |
448 | change the major mode. | |
449 | ||
0eb0202f LT |
450 | This hook is not run if any of the functions in |
451 | `write-contents-functions' returns non-nil. Both hooks pertain | |
452 | to how to save a buffer to file, for instance, choosing a suitable | |
453 | coding system and setting mode bits. (See Info | |
454 | node `(elisp)Saving Buffers'.) To perform various checks or | |
26b9ecbc | 455 | updates before the buffer is saved, use `before-save-hook'.") |
0370fe77 | 456 | (put 'write-file-functions 'permanent-local t) |
0370fe77 SM |
457 | |
458 | (defvar local-write-file-hooks nil) | |
b19f1da4 BF |
459 | (make-variable-buffer-local 'local-write-file-hooks) |
460 | (put 'local-write-file-hooks 'permanent-local t) | |
bf247b6e | 461 | (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1") |
8c0e7b73 | 462 | |
e5bd0a28 SM |
463 | (define-obsolete-variable-alias 'write-contents-hooks |
464 | 'write-contents-functions "22.1") | |
0370fe77 | 465 | (defvar write-contents-functions nil |
8c0e7b73 JB |
466 | "List of functions to be called before writing out a buffer to a file. |
467 | If one of them returns non-nil, the file is considered already written | |
7dd11b37 LH |
468 | and the rest are not called and neither are the functions in |
469 | `write-file-functions'. | |
f82966e4 KH |
470 | |
471 | This variable is meant to be used for hooks that pertain to the | |
472 | buffer's contents, not to the particular visited file; thus, | |
473 | `set-visited-file-name' does not clear this variable; but changing the | |
693f800d RS |
474 | major mode does clear it. |
475 | ||
0eb0202f LT |
476 | For hooks that _do_ pertain to the particular visited file, use |
477 | `write-file-functions'. Both this variable and | |
478 | `write-file-functions' relate to how a buffer is saved to file. | |
479 | To perform various checks or updates before the buffer is saved, | |
480 | use `before-save-hook'.") | |
0370fe77 | 481 | (make-variable-buffer-local 'write-contents-functions) |
b4da00e9 | 482 | |
21540597 | 483 | (defcustom enable-local-variables t |
ba83982b | 484 | "Control use of local variables in files you visit. |
d355b270 | 485 | The value can be t, nil, :safe, :all, or something else. |
5a6c1d87 CY |
486 | |
487 | A value of t means file local variables specifications are obeyed | |
a251756e RS |
488 | if all the specified variable values are safe; if any values are |
489 | not safe, Emacs queries you, once, whether to set them all. | |
a5ce12c3 RS |
490 | \(When you say yes to certain values, they are remembered as safe.) |
491 | ||
492 | :safe means set the safe variables, and ignore the rest. | |
e58cec15 RS |
493 | :all means set all variables, whether safe or not. |
494 | (Don't set it permanently to :all.) | |
756c496f | 495 | A value of nil means always ignore the file local variables. |
a251756e | 496 | |
a251756e | 497 | Any other value means always query you once whether to set them all. |
a5ce12c3 RS |
498 | \(When you say yes to certain values, they are remembered as safe, but |
499 | this has no effect when `enable-local-variables' is \"something else\".) | |
5a6c1d87 | 500 | |
aa5fcebf KH |
501 | This variable also controls use of major modes specified in |
502 | a -*- line. | |
b4da00e9 | 503 | |
aa5fcebf KH |
504 | The command \\[normal-mode], when used interactively, |
505 | always obeys file local variable specifications and the -*- line, | |
506 | and ignores this variable." | |
3029e594 | 507 | :risky t |
e58cec15 | 508 | :type '(choice (const :tag "Query Unsafe" t) |
a5ce12c3 | 509 | (const :tag "Safe Only" :safe) |
e58cec15 | 510 | (const :tag "Do all" :all) |
21540597 | 511 | (const :tag "Ignore" nil) |
e48807d1 | 512 | (other :tag "Query" other)) |
21540597 | 513 | :group 'find-file) |
b4da00e9 | 514 | |
97a1cd9d GM |
515 | (defvar enable-dir-local-variables t |
516 | "Non-nil means enable use of directory-local variables. | |
517 | Some modes may wish to set this to nil to prevent directory-local | |
518 | settings being applied, but still respect file-local ones.") | |
519 | ||
7b447e9b GM |
520 | ;; This is an odd variable IMO. |
521 | ;; You might wonder why it is needed, when we could just do: | |
522 | ;; (set (make-local-variable 'enable-local-variables) nil) | |
523 | ;; These two are not precisely the same. | |
524 | ;; Setting this variable does not cause -*- mode settings to be | |
525 | ;; ignored, whereas setting enable-local-variables does. | |
526 | ;; Only three places in Emacs use this variable: tar and arc modes, | |
527 | ;; and rmail. The first two don't need it. They already use | |
528 | ;; inhibit-local-variables-regexps, which is probably enough, and | |
529 | ;; could also just set enable-local-variables locally to nil. | |
530 | ;; Them setting it has the side-effect that dir-locals cannot apply to | |
531 | ;; eg tar files (?). FIXME Is this appropriate? | |
532 | ;; AFAICS, rmail is the only thing that needs this, and the only | |
533 | ;; reason it uses it is for BABYL files (which are obsolete). | |
534 | ;; These contain "-*- rmail -*-" in the first line, which rmail wants | |
535 | ;; to respect, so that find-file on a BABYL file will switch to | |
536 | ;; rmail-mode automatically (this is nice, but hardly essential, | |
537 | ;; since most people are used to explicitly running a command to | |
538 | ;; access their mail; M-x gnus etc). Rmail files may happen to | |
539 | ;; contain Local Variables sections in messages, which Rmail wants to | |
540 | ;; ignore. So AFAICS the only reason this variable exists is for a | |
541 | ;; minor convenience feature for handling of an obsolete Rmail file format. | |
da09b92b RS |
542 | (defvar local-enable-local-variables t |
543 | "Like `enable-local-variables' but meant for buffer-local bindings. | |
aa5fcebf | 544 | The meaningful values are nil and non-nil. The default is non-nil. |
da09b92b | 545 | If a major mode sets this to nil, buffer-locally, then any local |
7b447e9b | 546 | variables list in a file visited in that mode will be ignored. |
aa5fcebf | 547 | |
7b447e9b GM |
548 | This variable does not affect the use of major modes specified |
549 | in a -*- line.") | |
da09b92b | 550 | |
21540597 | 551 | (defcustom enable-local-eval 'maybe |
e442c62b | 552 | "Control processing of the \"variable\" `eval' in a file's local variables. |
d207b766 | 553 | The value can be t, nil or something else. |
8fc29035 | 554 | A value of t means obey `eval' variables. |
756c496f | 555 | A value of nil means ignore them; anything else means query." |
3029e594 | 556 | :risky t |
21540597 RS |
557 | :type '(choice (const :tag "Obey" t) |
558 | (const :tag "Ignore" nil) | |
e48807d1 | 559 | (other :tag "Query" other)) |
21540597 | 560 | :group 'find-file) |
b4da00e9 RM |
561 | |
562 | ;; Avoid losing in versions where CLASH_DETECTION is disabled. | |
563 | (or (fboundp 'lock-buffer) | |
231c4e10 | 564 | (defalias 'lock-buffer 'ignore)) |
b4da00e9 | 565 | (or (fboundp 'unlock-buffer) |
231c4e10 | 566 | (defalias 'unlock-buffer 'ignore)) |
a7305f6e RS |
567 | (or (fboundp 'file-locked-p) |
568 | (defalias 'file-locked-p 'ignore)) | |
93fe0a35 | 569 | |
cb211eb2 | 570 | (defcustom view-read-only nil |
ba83982b | 571 | "Non-nil means buffers visiting files read-only do so in view mode. |
4c91443d RS |
572 | In fact, this means that all read-only buffers normally have |
573 | View mode enabled, including buffers that are read-only because | |
574 | you visit a file you cannot alter, and buffers you make read-only | |
575 | using \\[toggle-read-only]." | |
cb211eb2 SM |
576 | :type 'boolean |
577 | :group 'view) | |
2a9fe1e2 | 578 | |
5c471b12 | 579 | (defvar file-name-history nil |
426aa4f0 EZ |
580 | "History list of file names entered in the minibuffer. |
581 | ||
582 | Maximum length of the history list is determined by the value | |
583 | of `history-length', which see.") | |
5c471b12 | 584 | \f |
1aa8fe46 | 585 | (put 'ange-ftp-completion-hook-function 'safe-magic t) |
93fe0a35 | 586 | (defun ange-ftp-completion-hook-function (op &rest args) |
ffc0e1ca AS |
587 | "Provides support for ange-ftp host name completion. |
588 | Runs the usual ange-ftp hook, but only for completion operations." | |
589 | ;; Having this here avoids the need to load ange-ftp when it's not | |
590 | ;; really in use. | |
93fe0a35 RS |
591 | (if (memq op '(file-name-completion file-name-all-completions)) |
592 | (apply 'ange-ftp-hook-function op args) | |
57e81f57 RS |
593 | (let ((inhibit-file-name-handlers |
594 | (cons 'ange-ftp-completion-hook-function | |
595 | (and (eq inhibit-file-name-operation op) | |
596 | inhibit-file-name-handlers))) | |
597 | (inhibit-file-name-operation op)) | |
93fe0a35 | 598 | (apply op args)))) |
567c1ca9 | 599 | |
98d8b17e EZ |
600 | (declare-function dos-convert-standard-filename "dos-fns.el" (filename)) |
601 | (declare-function w32-convert-standard-filename "w32-fns.el" (filename)) | |
602 | ||
567c1ca9 | 603 | (defun convert-standard-filename (filename) |
a576d8e2 | 604 | "Convert a standard file's name to something suitable for the OS. |
915b0bf0 JB |
605 | This means to guarantee valid names and perhaps to canonicalize |
606 | certain patterns. | |
607 | ||
f2430a0d SM |
608 | FILENAME should be an absolute file name since the conversion rules |
609 | sometimes vary depending on the position in the file name. E.g. c:/foo | |
610 | is a valid DOS file name, but c:/bar/c:/foo is not. | |
611 | ||
915b0bf0 JB |
612 | This function's standard definition is trivial; it just returns |
613 | the argument. However, on Windows and DOS, replace invalid | |
18b28ef1 EZ |
614 | characters. On DOS, make sure to obey the 8.3 limitations. |
615 | In the native Windows build, turn Cygwin names into native names, | |
616 | and also turn slashes into backslashes if the shell requires it (see | |
a576d8e2 LT |
617 | `w32-shell-dos-semantics'). |
618 | ||
619 | See Info node `(elisp)Standard File Names' for more details." | |
98d8b17e EZ |
620 | (cond |
621 | ((eq system-type 'cygwin) | |
622 | (let ((name (copy-sequence filename)) | |
623 | (start 0)) | |
624 | ;; Replace invalid filename characters with ! | |
625 | (while (string-match "[?*:<>|\"\000-\037]" name start) | |
626 | (aset name (match-beginning 0) ?!) | |
627 | (setq start (match-end 0))) | |
628 | name)) | |
629 | ((eq system-type 'windows-nt) | |
630 | (w32-convert-standard-filename filename)) | |
631 | ((eq system-type 'ms-dos) | |
632 | (dos-convert-standard-filename filename)) | |
633 | (t filename))) | |
5d4d17b8 KS |
634 | |
635 | (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial) | |
636 | "Read directory name, prompting with PROMPT and completing in directory DIR. | |
637 | Value is not expanded---you must call `expand-file-name' yourself. | |
25802eac LT |
638 | Default name to DEFAULT-DIRNAME if user exits with the same |
639 | non-empty string that was inserted by this function. | |
44dce0fb RS |
640 | (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used, |
641 | or just DIR if INITIAL is nil.) | |
25802eac LT |
642 | If the user exits with an empty minibuffer, this function returns |
643 | an empty string. (This can only happen if the user erased the | |
644 | pre-inserted contents or if `insert-default-directory' is nil.) | |
5d4d17b8 KS |
645 | Fourth arg MUSTMATCH non-nil means require existing directory's name. |
646 | Non-nil and non-t means also require confirmation after completion. | |
647 | Fifth arg INITIAL specifies text to start with. | |
25802eac LT |
648 | DIR should be an absolute directory name. It defaults to |
649 | the value of `default-directory'." | |
5d4d17b8 KS |
650 | (unless dir |
651 | (setq dir default-directory)) | |
54005870 | 652 | (read-file-name prompt dir (or default-dirname |
44dce0fb RS |
653 | (if initial (expand-file-name initial dir) |
654 | dir)) | |
655 | mustmatch initial | |
5d4d17b8 KS |
656 | 'file-directory-p)) |
657 | ||
b4da00e9 RM |
658 | \f |
659 | (defun pwd () | |
660 | "Show the current default directory." | |
661 | (interactive nil) | |
662 | (message "Directory %s" default-directory)) | |
663 | ||
231c4e10 ER |
664 | (defvar cd-path nil |
665 | "Value of the CDPATH environment variable, as a list. | |
9ee45b2c | 666 | Not actually set up until the first time you use it.") |
231c4e10 | 667 | |
06b60517 | 668 | (defun parse-colon-path (search-path) |
ae135939 | 669 | "Explode a search path into a list of directory names. |
1667e065 CY |
670 | Directories are separated by `path-separator' (which is colon in |
671 | GNU and Unix systems). Substitute environment variables into the | |
4cddca30 GM |
672 | resulting list of directory names. For an empty path element (i.e., |
673 | a leading or trailing separator, or two adjacent separators), return | |
674 | nil (meaning `default-directory') as the associated list element." | |
1667e065 CY |
675 | (when (stringp search-path) |
676 | (mapcar (lambda (f) | |
4cddca30 GM |
677 | (if (equal "" f) nil |
678 | (substitute-in-file-name (file-name-as-directory f)))) | |
679 | (split-string search-path path-separator)))) | |
231c4e10 ER |
680 | |
681 | (defun cd-absolute (dir) | |
30c5ce9c | 682 | "Change current directory to given absolute file name DIR." |
f4a0f59b RS |
683 | ;; Put the name into directory syntax now, |
684 | ;; because otherwise expand-file-name may give some bad results. | |
7c2fb837 | 685 | (setq dir (file-name-as-directory dir)) |
7201bfbb SM |
686 | ;; We used to additionally call abbreviate-file-name here, for an |
687 | ;; unknown reason. Problem is that most buffers are setup | |
688 | ;; without going through cd-absolute and don't call | |
689 | ;; abbreviate-file-name on their default-directory, so the few that | |
690 | ;; do end up using a superficially different directory. | |
691 | (setq dir (expand-file-name dir)) | |
b4da00e9 | 692 | (if (not (file-directory-p dir)) |
83c6f446 RS |
693 | (if (file-exists-p dir) |
694 | (error "%s is not a directory" dir) | |
31c691c1 | 695 | (error "%s: no such directory" dir)) |
2651ed05 | 696 | (unless (file-accessible-directory-p dir) |
cfef87ad TTN |
697 | (error "Cannot cd to %s: Permission denied" dir)) |
698 | (setq default-directory dir) | |
11ee8d90 | 699 | (setq list-buffers-directory dir))) |
b4da00e9 | 700 | |
231c4e10 ER |
701 | (defun cd (dir) |
702 | "Make DIR become the current buffer's default directory. | |
ae135939 JB |
703 | If your environment includes a `CDPATH' variable, try each one of |
704 | that list of directories (separated by occurrences of | |
c5994cfa JB |
705 | `path-separator') when resolving a relative directory name. |
706 | The path separator is colon in GNU and GNU-like systems." | |
dac4ea74 | 707 | (interactive |
aa56f361 SM |
708 | (list |
709 | ;; FIXME: There's a subtle bug in the completion below. Seems linked | |
710 | ;; to a fundamental difficulty of implementing `predicate' correctly. | |
711 | ;; The manifestation is that TAB may list non-directories in the case where | |
712 | ;; those files also correspond to valid directories (if your cd-path is (A/ | |
713 | ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/' | |
714 | ;; will be listed as valid completions). | |
715 | ;; This is because `a' (listed because of A/a) is indeed a valid choice | |
716 | ;; (which will lead to the use of B/a). | |
717 | (minibuffer-with-setup-hook | |
718 | (lambda () | |
719 | (setq minibuffer-completion-table | |
720 | (apply-partially #'locate-file-completion-table | |
721 | cd-path nil)) | |
722 | (setq minibuffer-completion-predicate | |
723 | (lambda (dir) | |
724 | (locate-file dir cd-path nil | |
725 | (lambda (f) (and (file-directory-p f) 'dir-ok)))))) | |
726 | (unless cd-path | |
727 | (setq cd-path (or (parse-colon-path (getenv "CDPATH")) | |
728 | (list "./")))) | |
729 | (read-directory-name "Change default directory: " | |
730 | default-directory default-directory | |
731 | t)))) | |
732 | (unless cd-path | |
733 | (setq cd-path (or (parse-colon-path (getenv "CDPATH")) | |
734 | (list "./")))) | |
735 | (cd-absolute | |
736 | (or (locate-file dir cd-path nil | |
737 | (lambda (f) (and (file-directory-p f) 'dir-ok))) | |
738 | (error "No such directory found via CDPATH environment variable")))) | |
231c4e10 | 739 | |
b4da00e9 RM |
740 | (defun load-file (file) |
741 | "Load the Lisp file named FILE." | |
58195faa DL |
742 | ;; This is a case where .elc makes a lot of sense. |
743 | (interactive (list (let ((completion-ignored-extensions | |
9ab80679 | 744 | (remove ".elc" completion-ignored-extensions))) |
ac5392dc | 745 | (read-file-name "Load file: " nil nil 'lambda)))) |
58195faa | 746 | (load (expand-file-name file) nil nil t)) |
b4da00e9 | 747 | |
38eea7c7 SM |
748 | (defun locate-file (filename path &optional suffixes predicate) |
749 | "Search for FILENAME through PATH. | |
5a836f58 LI |
750 | If found, return the absolute file name of FILENAME; otherwise |
751 | return nil. | |
c7c4bc11 EZ |
752 | PATH should be a list of directories to look in, like the lists in |
753 | `exec-path' or `load-path'. | |
38eea7c7 SM |
754 | If SUFFIXES is non-nil, it should be a list of suffixes to append to |
755 | file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). | |
c7c4bc11 | 756 | Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. |
38eea7c7 | 757 | If non-nil, PREDICATE is used instead of `file-readable-p'. |
aa56f361 SM |
758 | |
759 | This function will normally skip directories, so if you want it to find | |
760 | directories, make sure the PREDICATE function returns `dir-ok' for them. | |
761 | ||
e6f0ff92 RS |
762 | PREDICATE can also be an integer to pass to the `access' system call, |
763 | in which case file-name handlers are ignored. This usage is deprecated. | |
e6f0ff92 RS |
764 | For compatibility, PREDICATE can also be one of the symbols |
765 | `executable', `readable', `writable', or `exists', or a list of | |
766 | one or more of those symbols." | |
38eea7c7 SM |
767 | (if (and predicate (symbolp predicate) (not (functionp predicate))) |
768 | (setq predicate (list predicate))) | |
769 | (when (and (consp predicate) (not (functionp predicate))) | |
770 | (setq predicate | |
771 | (logior (if (memq 'executable predicate) 1 0) | |
772 | (if (memq 'writable predicate) 2 0) | |
773 | (if (memq 'readable predicate) 4 0)))) | |
774 | (locate-file-internal filename path suffixes predicate)) | |
775 | ||
e8dab975 SM |
776 | (defun locate-file-completion-table (dirs suffixes string pred action) |
777 | "Do completion for file names passed to `locate-file'." | |
df120481 SM |
778 | (cond |
779 | ((file-name-absolute-p string) | |
528c56e2 SM |
780 | ;; FIXME: maybe we should use completion-file-name-table instead, |
781 | ;; tho at least for `load', the arg is passed through | |
782 | ;; substitute-in-file-name for historical reasons. | |
783 | (read-file-name-internal string pred action)) | |
df120481 SM |
784 | ((eq (car-safe action) 'boundaries) |
785 | (let ((suffix (cdr action))) | |
2ee3d7f0 SM |
786 | `(boundaries |
787 | ,(length (file-name-directory string)) | |
788 | ,@(let ((x (file-name-directory suffix))) | |
789 | (if x (1- (length x)) (length suffix)))))) | |
df120481 | 790 | (t |
118cf454 SM |
791 | (let ((names '()) |
792 | ;; If we have files like "foo.el" and "foo.elc", we could load one of | |
793 | ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the | |
794 | ;; preferred way. So if we list all 3, that gives a lot of redundant | |
795 | ;; entries for the poor soul looking just for "foo". OTOH, sometimes | |
796 | ;; the user does want to pay attention to the extension. We try to | |
797 | ;; diffuse this tension by stripping the suffix, except when the | |
798 | ;; result is a single element (i.e. usually we only list "foo" unless | |
799 | ;; it's the only remaining element in the list, in which case we do | |
800 | ;; list "foo", "foo.elc" and "foo.el"). | |
801 | (fullnames '()) | |
e8dab975 | 802 | (suffix (concat (regexp-opt suffixes t) "\\'")) |
df120481 SM |
803 | (string-dir (file-name-directory string)) |
804 | (string-file (file-name-nondirectory string))) | |
e8dab975 | 805 | (dolist (dir dirs) |
118cf454 SM |
806 | (unless dir |
807 | (setq dir default-directory)) | |
808 | (if string-dir (setq dir (expand-file-name string-dir dir))) | |
809 | (when (file-directory-p dir) | |
810 | (dolist (file (file-name-all-completions | |
811 | string-file dir)) | |
812 | (if (not (string-match suffix file)) | |
813 | (push file names) | |
814 | (push file fullnames) | |
815 | (push (substring file 0 (match-beginning 0)) names))))) | |
816 | ;; Switching from names to names+fullnames creates a non-monotonicity | |
817 | ;; which can cause problems with things like partial-completion. | |
818 | ;; To minimize the problem, filter out completion-regexp-list, so that | |
43f964fc SM |
819 | ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements |
820 | ;; from `names' which only matched `string' when they still had | |
821 | ;; their suffix. | |
822 | (setq names (all-completions string names)) | |
118cf454 SM |
823 | ;; Remove duplicates of the first element, so that we can easily check |
824 | ;; if `names' really only contains a single element. | |
825 | (when (cdr names) (setcdr names (delete (car names) (cdr names)))) | |
826 | (unless (cdr names) | |
827 | ;; There's no more than one matching non-suffixed element, so expand | |
828 | ;; the list by adding the suffixed elements as well. | |
829 | (setq names (nconc names fullnames))) | |
df120481 SM |
830 | (completion-table-with-context |
831 | string-dir names string-file pred action))))) | |
e8dab975 SM |
832 | |
833 | (defun locate-file-completion (string path-and-suffixes action) | |
834 | "Do completion for file names passed to `locate-file'. | |
835 | PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)." | |
59f7af81 | 836 | (declare (obsolete locate-file-completion-table "23.1")) |
e8dab975 SM |
837 | (locate-file-completion-table (car path-and-suffixes) |
838 | (cdr path-and-suffixes) | |
839 | string nil action)) | |
2c3d8820 | 840 | |
8cd56959 | 841 | (defvar locate-dominating-stop-dir-regexp |
a7610c52 | 842 | (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'") |
8cd56959 SM |
843 | "Regexp of directory names which stop the search in `locate-dominating-file'. |
844 | Any directory whose name matches this regexp will be treated like | |
845 | a kind of root directory by `locate-dominating-file' which will stop its search | |
846 | when it bumps into it. | |
847 | The default regexp prevents fruitless and time-consuming attempts to find | |
48981b8b JR |
848 | special files in directories in which filenames are interpreted as hostnames, |
849 | or mount points potentially requiring authentication as a different user.") | |
8cd56959 SM |
850 | |
851 | ;; (defun locate-dominating-files (file regexp) | |
852 | ;; "Look up the directory hierarchy from FILE for a file matching REGEXP. | |
853 | ;; Stop at the first parent where a matching file is found and return the list | |
854 | ;; of files that that match in this directory." | |
855 | ;; (catch 'found | |
856 | ;; ;; `user' is not initialized yet because `file' may not exist, so we may | |
857 | ;; ;; have to walk up part of the hierarchy before we find the "initial UID". | |
858 | ;; (let ((user nil) | |
859 | ;; ;; Abbreviate, so as to stop when we cross ~/. | |
860 | ;; (dir (abbreviate-file-name (file-name-as-directory file))) | |
861 | ;; files) | |
862 | ;; (while (and dir | |
863 | ;; ;; As a heuristic, we stop looking up the hierarchy of | |
864 | ;; ;; directories as soon as we find a directory belonging to | |
865 | ;; ;; another user. This should save us from looking in | |
866 | ;; ;; things like /net and /afs. This assumes that all the | |
867 | ;; ;; files inside a project belong to the same user. | |
868 | ;; (let ((prev-user user)) | |
869 | ;; (setq user (nth 2 (file-attributes dir))) | |
870 | ;; (or (null prev-user) (equal user prev-user)))) | |
871 | ;; (if (setq files (condition-case nil | |
872 | ;; (directory-files dir 'full regexp 'nosort) | |
873 | ;; (error nil))) | |
874 | ;; (throw 'found files) | |
875 | ;; (if (equal dir | |
876 | ;; (setq dir (file-name-directory | |
877 | ;; (directory-file-name dir)))) | |
878 | ;; (setq dir nil)))) | |
879 | ;; nil))) | |
880 | ||
9a40b8d4 | 881 | (defun locate-dominating-file (file name) |
0781098a | 882 | "Look up the directory hierarchy from FILE for a directory containing NAME. |
09949b83 | 883 | Stop at the first parent directory containing a file NAME, |
eb182446 | 884 | and return the directory. Return nil if not found. |
0781098a SM |
885 | Instead of a string, NAME can also be a predicate taking one argument |
886 | \(a directory) and returning a non-nil value if that directory is the one for | |
887 | which we're looking." | |
8cd56959 SM |
888 | ;; We used to use the above locate-dominating-files code, but the |
889 | ;; directory-files call is very costly, so we're much better off doing | |
890 | ;; multiple calls using the code in here. | |
09949b83 | 891 | ;; |
8cd56959 SM |
892 | ;; Represent /home/luser/foo as ~/foo so that we don't try to look for |
893 | ;; `name' in /home or in /. | |
894 | (setq file (abbreviate-file-name file)) | |
895 | (let ((root nil) | |
8cd56959 SM |
896 | ;; `user' is not initialized outside the loop because |
897 | ;; `file' may not exist, so we may have to walk up part of the | |
06b60517 JB |
898 | ;; hierarchy before we find the "initial UID". Note: currently unused |
899 | ;; (user nil) | |
8cd56959 SM |
900 | try) |
901 | (while (not (or root | |
902 | (null file) | |
903 | ;; FIXME: Disabled this heuristic because it is sometimes | |
904 | ;; inappropriate. | |
905 | ;; As a heuristic, we stop looking up the hierarchy of | |
906 | ;; directories as soon as we find a directory belonging | |
907 | ;; to another user. This should save us from looking in | |
908 | ;; things like /net and /afs. This assumes that all the | |
909 | ;; files inside a project belong to the same user. | |
910 | ;; (let ((prev-user user)) | |
911 | ;; (setq user (nth 2 (file-attributes file))) | |
912 | ;; (and prev-user (not (equal user prev-user)))) | |
913 | (string-match locate-dominating-stop-dir-regexp file))) | |
0781098a SM |
914 | (setq try (if (stringp name) |
915 | (file-exists-p (expand-file-name name file)) | |
916 | (funcall name file))) | |
8cd56959 | 917 | (cond (try (setq root file)) |
06b60517 | 918 | ((equal file (setq file (file-name-directory |
8cd56959 SM |
919 | (directory-file-name file)))) |
920 | (setq file nil)))) | |
0781098a | 921 | (if root (file-name-as-directory root)))) |
8cd56959 | 922 | |
53b39e89 SM |
923 | (defcustom user-emacs-directory-warning t |
924 | "Non-nil means warn if cannot access `user-emacs-directory'. | |
925 | Set this to nil at your own risk..." | |
926 | :type 'boolean | |
927 | :group 'initialization | |
928 | :version "24.4") | |
929 | ||
930 | (defun locate-user-emacs-file (new-name &optional old-name) | |
931 | "Return an absolute per-user Emacs-specific file name. | |
932 | If NEW-NAME exists in `user-emacs-directory', return it. | |
933 | Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME. | |
934 | Else return NEW-NAME in `user-emacs-directory', creating the | |
935 | directory if it does not exist." | |
936 | (convert-standard-filename | |
937 | (let* ((home (concat "~" (or init-file-user ""))) | |
938 | (at-home (and old-name (expand-file-name old-name home))) | |
939 | (bestname (abbreviate-file-name | |
940 | (expand-file-name new-name user-emacs-directory)))) | |
941 | (if (and at-home (not (file-readable-p bestname)) | |
942 | (file-readable-p at-home)) | |
943 | at-home | |
944 | ;; Make sure `user-emacs-directory' exists, | |
945 | ;; unless we're in batch mode or dumping Emacs. | |
946 | (or noninteractive | |
947 | purify-flag | |
948 | (let (errtype) | |
949 | (if (file-directory-p user-emacs-directory) | |
950 | (or (file-accessible-directory-p user-emacs-directory) | |
951 | (setq errtype "access")) | |
952 | (let ((umask (default-file-modes))) | |
953 | (unwind-protect | |
954 | (progn | |
955 | (set-default-file-modes ?\700) | |
956 | (condition-case nil | |
957 | (make-directory user-emacs-directory) | |
958 | (error (setq errtype "create")))) | |
959 | (set-default-file-modes umask)))) | |
960 | (when (and errtype | |
961 | user-emacs-directory-warning | |
962 | (not (get 'user-emacs-directory-warning 'this-session))) | |
963 | ;; Only warn once per Emacs session. | |
964 | (put 'user-emacs-directory-warning 'this-session t) | |
965 | (display-warning 'initialization | |
966 | (format "\ | |
967 | Unable to %s `user-emacs-directory' (%s). | |
968 | Any data that would normally be written there may be lost! | |
969 | If you never want to see this message again, | |
970 | customize the variable `user-emacs-directory-warning'." | |
971 | errtype user-emacs-directory))))) | |
972 | bestname)))) | |
973 | ||
418fd375 | 974 | |
c3f6aa20 SM |
975 | (defun executable-find (command) |
976 | "Search for COMMAND in `exec-path' and return the absolute file name. | |
977 | Return nil if COMMAND is not found anywhere in `exec-path'." | |
978 | ;; Use 1 rather than file-executable-p to better match the behavior of | |
979 | ;; call-process. | |
980 | (locate-file command exec-path exec-suffixes 1)) | |
981 | ||
b4da00e9 | 982 | (defun load-library (library) |
0a56bf8c | 983 | "Load the Emacs Lisp library named LIBRARY. |
9d73a99e CY |
984 | This is an interface to the function `load'. LIBRARY is searched |
985 | for in `load-path', both with and without `load-suffixes' (as | |
986 | well as `load-file-rep-suffixes'). | |
987 | ||
988 | See Info node `(emacs)Lisp Libraries' for more details. | |
989 | See `load-file' for a different interface to `load'." | |
38eea7c7 SM |
990 | (interactive |
991 | (list (completing-read "Load library: " | |
e8dab975 SM |
992 | (apply-partially 'locate-file-completion-table |
993 | load-path | |
994 | (get-load-suffixes))))) | |
b4da00e9 | 995 | (load library)) |
5d68c2c2 | 996 | |
ac25542d | 997 | (defun file-remote-p (file &optional identification connected) |
3f788773 | 998 | "Test whether FILE specifies a location on a remote system. |
bace743a DA |
999 | A file is considered remote if accessing it is likely to |
1000 | be slower or less reliable than accessing local files. | |
1001 | ||
1002 | `file-remote-p' never opens a new remote connection. It can | |
1003 | only reuse a connection that is already open. | |
1004 | ||
1005 | Return nil or a string identifying the remote connection | |
1006 | \(ideally a prefix of FILE). Return nil if FILE is a relative | |
1007 | file name. | |
1008 | ||
1009 | When IDENTIFICATION is nil, the returned string is a complete | |
1010 | remote identifier: with components method, user, and host. The | |
1011 | components are those present in FILE, with defaults filled in for | |
1012 | any that are missing. | |
1013 | ||
1014 | IDENTIFICATION can specify which part of the identification to | |
1015 | return. IDENTIFICATION can be the symbol `method', `user', | |
1016 | `host', or `localname'. Any other value is handled like nil and | |
1017 | means to return the complete identification. The string returned | |
1018 | for IDENTIFICATION `localname' can differ depending on whether | |
1019 | there is an existing connection. | |
1020 | ||
1021 | If CONNECTED is non-nil, return an identification only if FILE is | |
1022 | located on a remote system and a connection is established to | |
1023 | that remote system. | |
1024 | ||
1025 | Tip: You can use this expansion of remote identifier components | |
1026 | to derive a new remote file name from an existing one. For | |
1027 | example, if FILE is \"/sudo::/path/to/file\" then | |
1028 | ||
1029 | \(concat \(file-remote-p FILE) \"/bin/sh\") | |
1030 | ||
1031 | returns a remote file name for file \"/bin/sh\" that has the | |
1032 | same remote identifier as FILE but expanded; a name such as | |
1033 | \"/sudo:root@myhost:/bin/sh\"." | |
04621aaa | 1034 | (let ((handler (find-file-name-handler file 'file-remote-p))) |
ff7affeb | 1035 | (if handler |
ac25542d | 1036 | (funcall handler 'file-remote-p file identification connected) |
04621aaa | 1037 | nil))) |
ff7affeb | 1038 | |
ead5edc0 GM |
1039 | ;; Probably this entire variable should be obsolete now, in favor of |
1040 | ;; something Tramp-related (?). It is not used in many places. | |
1041 | ;; It's not clear what the best file for this to be in is, but given | |
1042 | ;; it uses custom-initialize-delay, it is easier if it is preloaded | |
1043 | ;; rather than autoloaded. | |
1044 | (defcustom remote-shell-program | |
1045 | ;; This used to try various hard-coded places for remsh, rsh, and | |
1046 | ;; rcmd, trying to guess based on location whether "rsh" was | |
1047 | ;; "restricted shell" or "remote shell", but I don't see the point | |
1048 | ;; in this day and age. Almost everyone will use ssh, and have | |
1049 | ;; whatever command they want to use in PATH. | |
1050 | (purecopy | |
532f361c | 1051 | (let ((list '("ssh" "remsh" "rcmd" "rsh"))) |
ead5edc0 GM |
1052 | (while (and list |
1053 | (not (executable-find (car list))) | |
1054 | (setq list (cdr list)))) | |
1055 | (or (car list) "ssh"))) | |
1056 | "Program to use to execute commands on a remote host (e.g. ssh or rsh)." | |
2a1e2476 | 1057 | :version "24.3" ; ssh rather than rsh, etc |
ead5edc0 GM |
1058 | :initialize 'custom-initialize-delay |
1059 | :group 'environment | |
1060 | :type 'file) | |
1061 | ||
4bc3c53d MA |
1062 | (defcustom remote-file-name-inhibit-cache 10 |
1063 | "Whether to use the remote file-name cache for read access. | |
b011fbfe GM |
1064 | When `nil', never expire cached values (caution) |
1065 | When `t', never use the cache (safe, but may be slow) | |
1066 | A number means use cached values for that amount of seconds since caching. | |
1067 | ||
1068 | The attributes of remote files are cached for better performance. | |
1069 | If they are changed outside of Emacs's control, the cached values | |
1070 | become invalid, and must be reread. If you are sure that nothing | |
1071 | other than Emacs changes the files, you can set this variable to `nil'. | |
1072 | ||
1073 | If a remote file is checked regularly, it might be a good idea to | |
1074 | let-bind this variable to a value less than the interval between | |
1075 | consecutive checks. For example: | |
4bc3c53d | 1076 | |
06b60517 JB |
1077 | (defun display-time-file-nonempty-p (file) |
1078 | (let ((remote-file-name-inhibit-cache (- display-time-interval 5))) | |
1079 | (and (file-exists-p file) | |
86ec63ba | 1080 | (< 0 (nth 7 (file-attributes (file-chase-links file)))))))" |
4bc3c53d MA |
1081 | :group 'files |
1082 | :version "24.1" | |
1083 | :type `(choice | |
1084 | (const :tag "Do not inhibit file name cache" nil) | |
1085 | (const :tag "Do not use file name cache" t) | |
1086 | (integer :tag "Do not use file name cache" | |
1087 | :format "Do not use file name cache older then %v seconds" | |
1088 | :value 10))) | |
1089 | ||
ffc0e1ca | 1090 | (defun file-local-copy (file) |
5d68c2c2 RS |
1091 | "Copy the file FILE into a temporary file on this machine. |
1092 | Returns the name of the local copy, or nil, if FILE is directly | |
1093 | accessible." | |
ffc0e1ca AS |
1094 | ;; This formerly had an optional BUFFER argument that wasn't used by |
1095 | ;; anything. | |
6eaebaa2 | 1096 | (let ((handler (find-file-name-handler file 'file-local-copy))) |
5d68c2c2 RS |
1097 | (if handler |
1098 | (funcall handler 'file-local-copy file) | |
1099 | nil))) | |
f3e23606 | 1100 | |
05ef1cda | 1101 | (defun file-truename (filename &optional counter prev-dirs) |
06083aa1 GM |
1102 | "Return the truename of FILENAME. |
1103 | If FILENAME is not absolute, first expands it against `default-directory'. | |
f3e23606 RS |
1104 | The truename of a file name is found by chasing symbolic links |
1105 | both at the level of the file and at the level of the directories | |
05ef1cda RS |
1106 | containing it, until no links are left at any level. |
1107 | ||
89bf74f8 | 1108 | \(fn FILENAME)" ;; Don't document the optional arguments. |
b9963e32 JB |
1109 | ;; COUNTER and PREV-DIRS are only used in recursive calls. |
1110 | ;; COUNTER can be a cons cell whose car is the count of how many | |
1111 | ;; more links to chase before getting an error. | |
05ef1cda RS |
1112 | ;; PREV-DIRS can be a cons cell whose car is an alist |
1113 | ;; of truenames we've just recently computed. | |
f2440e42 RS |
1114 | (cond ((or (string= filename "") (string= filename "~")) |
1115 | (setq filename (expand-file-name filename)) | |
1116 | (if (string= filename "") | |
1117 | (setq filename "/"))) | |
1118 | ((and (string= (substring filename 0 1) "~") | |
1119 | (string-match "~[^/]*/?" filename)) | |
1120 | (let ((first-part | |
1121 | (substring filename 0 (match-end 0))) | |
1122 | (rest (substring filename (match-end 0)))) | |
1123 | (setq filename (concat (expand-file-name first-part) rest))))) | |
1124 | ||
05ef1cda | 1125 | (or counter (setq counter (list 100))) |
b505828b RS |
1126 | (let (done |
1127 | ;; For speed, remove the ange-ftp completion handler from the list. | |
1128 | ;; We know it's not needed here. | |
1129 | ;; For even more speed, do this only on the outermost call. | |
1130 | (file-name-handler-alist | |
1131 | (if prev-dirs file-name-handler-alist | |
1132 | (let ((tem (copy-sequence file-name-handler-alist))) | |
1133 | (delq (rassq 'ange-ftp-completion-hook-function tem) tem))))) | |
1134 | (or prev-dirs (setq prev-dirs (list nil))) | |
b1667e6c | 1135 | |
6dad7178 | 1136 | ;; andrewi@harlequin.co.uk - on Windows, there is an issue with |
b1667e6c GV |
1137 | ;; case differences being ignored by the OS, and short "8.3 DOS" |
1138 | ;; name aliases existing for all files. (The short names are not | |
1139 | ;; reported by directory-files, but can be used to refer to files.) | |
1140 | ;; It seems appropriate for file-truename to resolve these issues in | |
1141 | ;; the most natural way, which on Windows is to call the function | |
1142 | ;; `w32-long-file-name' - this returns the exact name of a file as | |
1143 | ;; it is stored on disk (expanding short name aliases with the full | |
1144 | ;; name in the process). | |
1145 | (if (eq system-type 'windows-nt) | |
6dad7178 EZ |
1146 | (unless (string-match "[[*?]" filename) |
1147 | ;; If filename exists, use its long name. If it doesn't | |
1148 | ;; exist, the recursion below on the directory of filename | |
1149 | ;; will drill down until we find a directory that exists, | |
1150 | ;; and use the long name of that, with the extra | |
1151 | ;; non-existent path components concatenated. | |
1152 | (let ((longname (w32-long-file-name filename))) | |
1153 | (if longname | |
1154 | (setq filename longname))))) | |
b1667e6c | 1155 | |
05ef1cda RS |
1156 | ;; If this file directly leads to a link, process that iteratively |
1157 | ;; so that we don't use lots of stack. | |
1158 | (while (not done) | |
1159 | (setcar counter (1- (car counter))) | |
1160 | (if (< (car counter) 0) | |
1161 | (error "Apparent cycle of symbolic links for %s" filename)) | |
1162 | (let ((handler (find-file-name-handler filename 'file-truename))) | |
1163 | ;; For file name that has a special handler, call handler. | |
1164 | ;; This is so that ange-ftp can save time by doing a no-op. | |
1165 | (if handler | |
1166 | (setq filename (funcall handler 'file-truename filename) | |
1167 | done t) | |
fb145562 | 1168 | (let ((dir (or (file-name-directory filename) default-directory)) |
05ef1cda RS |
1169 | target dirfile) |
1170 | ;; Get the truename of the directory. | |
1171 | (setq dirfile (directory-file-name dir)) | |
1172 | ;; If these are equal, we have the (or a) root directory. | |
1173 | (or (string= dir dirfile) | |
6dad7178 EZ |
1174 | (and (memq system-type '(windows-nt ms-dos cygwin)) |
1175 | (eq (compare-strings dir 0 nil dirfile 0 nil t) t)) | |
05ef1cda RS |
1176 | ;; If this is the same dir we last got the truename for, |
1177 | ;; save time--don't recalculate. | |
1178 | (if (assoc dir (car prev-dirs)) | |
1179 | (setq dir (cdr (assoc dir (car prev-dirs)))) | |
1180 | (let ((old dir) | |
1181 | (new (file-name-as-directory (file-truename dirfile counter prev-dirs)))) | |
1182 | (setcar prev-dirs (cons (cons old new) (car prev-dirs))) | |
1183 | (setq dir new)))) | |
1184 | (if (equal ".." (file-name-nondirectory filename)) | |
1185 | (setq filename | |
1186 | (directory-file-name (file-name-directory (directory-file-name dir))) | |
1187 | done t) | |
1188 | (if (equal "." (file-name-nondirectory filename)) | |
1189 | (setq filename (directory-file-name dir) | |
1190 | done t) | |
1191 | ;; Put it back on the file name. | |
1192 | (setq filename (concat dir (file-name-nondirectory filename))) | |
1193 | ;; Is the file name the name of a link? | |
1194 | (setq target (file-symlink-p filename)) | |
1195 | (if target | |
1196 | ;; Yes => chase that link, then start all over | |
1197 | ;; since the link may point to a directory name that uses links. | |
1198 | ;; We can't safely use expand-file-name here | |
1199 | ;; since target might look like foo/../bar where foo | |
1200 | ;; is itself a link. Instead, we handle . and .. above. | |
1201 | (setq filename | |
1202 | (if (file-name-absolute-p target) | |
1203 | target | |
1204 | (concat dir target)) | |
1205 | done nil) | |
1206 | ;; No, we are done! | |
1207 | (setq done t)))))))) | |
1208 | filename)) | |
5dbfdacd | 1209 | |
302fcc98 | 1210 | (defun file-chase-links (filename &optional limit) |
5dadeb29 | 1211 | "Chase links in FILENAME until a name that is not a link. |
302fcc98 RS |
1212 | Unlike `file-truename', this does not check whether a parent |
1213 | directory name is a symbolic link. | |
1214 | If the optional argument LIMIT is a number, | |
1215 | it means chase no more than that many links and then stop." | |
1216 | (let (tem (newname filename) | |
92464ae6 | 1217 | (count 0)) |
302fcc98 RS |
1218 | (while (and (or (null limit) (< count limit)) |
1219 | (setq tem (file-symlink-p newname))) | |
9695aac6 | 1220 | (save-match-data |
92464ae6 | 1221 | (if (and (null limit) (= count 100)) |
9695aac6 RS |
1222 | (error "Apparent cycle of symbolic links for %s" filename)) |
1223 | ;; In the context of a link, `//' doesn't mean what Emacs thinks. | |
1224 | (while (string-match "//+" tem) | |
1225 | (setq tem (replace-match "/" nil nil tem))) | |
1226 | ;; Handle `..' by hand, since it needs to work in the | |
1227 | ;; target of any directory symlink. | |
1228 | ;; This code is not quite complete; it does not handle | |
1229 | ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose. | |
1230 | (while (string-match "\\`\\.\\./" tem) | |
1231 | (setq tem (substring tem 3)) | |
1232 | (setq newname (expand-file-name newname)) | |
1233 | ;; Chase links in the default dir of the symlink. | |
1234 | (setq newname | |
1235 | (file-chase-links | |
1236 | (directory-file-name (file-name-directory newname)))) | |
1237 | ;; Now find the parent of that dir. | |
1238 | (setq newname (file-name-directory newname))) | |
1239 | (setq newname (expand-file-name tem (file-name-directory newname))) | |
92464ae6 | 1240 | (setq count (1+ count)))) |
5dadeb29 | 1241 | newname)) |
9bdbd98e | 1242 | |
e3971c44 EZ |
1243 | ;; A handy function to display file sizes in human-readable form. |
1244 | ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference. | |
1245 | (defun file-size-human-readable (file-size &optional flavor) | |
1246 | "Produce a string showing FILE-SIZE in human-readable form. | |
1247 | ||
1248 | Optional second argument FLAVOR controls the units and the display format: | |
1249 | ||
1250 | If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced | |
1251 | suffixes are \"k\", \"M\", \"G\", \"T\", etc. | |
1252 | If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes | |
1253 | are \"k\", \"M\", \"G\", \"T\", etc. | |
1254 | If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes | |
1255 | are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc." | |
1256 | (let ((power (if (or (null flavor) (eq flavor 'iec)) | |
1257 | 1024.0 | |
1258 | 1000.0)) | |
1259 | (post-fixes | |
1260 | ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta | |
1261 | (list "" "k" "M" "G" "T" "P" "E" "Z" "Y"))) | |
1262 | (while (and (>= file-size power) (cdr post-fixes)) | |
1263 | (setq file-size (/ file-size power) | |
1264 | post-fixes (cdr post-fixes))) | |
04f33f1e EZ |
1265 | (format (if (> (mod file-size 1.0) 0.05) |
1266 | "%.1f%s%s" | |
1267 | "%.0f%s%s") | |
1268 | file-size | |
e3971c44 EZ |
1269 | (if (and (eq flavor 'iec) (string= (car post-fixes) "k")) |
1270 | "K" | |
1271 | (car post-fixes)) | |
1272 | (if (eq flavor 'iec) "iB" "")))) | |
1273 | ||
9e8bb7f7 RS |
1274 | (defun make-temp-file (prefix &optional dir-flag suffix) |
1275 | "Create a temporary file. | |
1276 | The returned file name (created by appending some random characters at the end | |
1277 | of PREFIX, and expanding against `temporary-file-directory' if necessary), | |
1278 | is guaranteed to point to a newly created empty file. | |
1279 | You can then use `write-region' to write new data into the file. | |
1280 | ||
1281 | If DIR-FLAG is non-nil, create a new empty directory instead of a file. | |
1282 | ||
1283 | If SUFFIX is non-nil, add that at the end of the file name." | |
1284 | (let ((umask (default-file-modes)) | |
1285 | file) | |
1286 | (unwind-protect | |
1287 | (progn | |
1288 | ;; Create temp files with strict access rights. It's easy to | |
1289 | ;; loosen them later, whereas it's impossible to close the | |
1290 | ;; time-window of loose permissions otherwise. | |
1291 | (set-default-file-modes ?\700) | |
1292 | (while (condition-case () | |
1293 | (progn | |
1294 | (setq file | |
1295 | (make-temp-name | |
f8dce815 GM |
1296 | (if (zerop (length prefix)) |
1297 | (file-name-as-directory | |
1298 | temporary-file-directory) | |
1299 | (expand-file-name prefix | |
1300 | temporary-file-directory)))) | |
9e8bb7f7 RS |
1301 | (if suffix |
1302 | (setq file (concat file suffix))) | |
1303 | (if dir-flag | |
1304 | (make-directory file) | |
1305 | (write-region "" nil file nil 'silent nil 'excl)) | |
1306 | nil) | |
1307 | (file-already-exists t)) | |
1308 | ;; the file was somehow created by someone else between | |
1309 | ;; `make-temp-name' and `write-region', let's try again. | |
1310 | nil) | |
1311 | file) | |
1312 | ;; Reset the umask. | |
1313 | (set-default-file-modes umask)))) | |
1314 | ||
9bdbd98e KH |
1315 | (defun recode-file-name (file coding new-coding &optional ok-if-already-exists) |
1316 | "Change the encoding of FILE's name from CODING to NEW-CODING. | |
1317 | The value is a new name of FILE. | |
1318 | Signals a `file-already-exists' error if a file of the new name | |
26b9ecbc JB |
1319 | already exists unless optional fourth argument OK-IF-ALREADY-EXISTS |
1320 | is non-nil. A number as fourth arg means request confirmation if | |
9bdbd98e KH |
1321 | the new name already exists. This is what happens in interactive |
1322 | use with M-x." | |
1323 | (interactive | |
1324 | (let ((default-coding (or file-name-coding-system | |
1325 | default-file-name-coding-system)) | |
1326 | (filename (read-file-name "Recode filename: " nil nil t)) | |
1327 | from-coding to-coding) | |
1328 | (if (and default-coding | |
1329 | ;; We provide the default coding only when it seems that | |
1330 | ;; the filename is correctly decoded by the default | |
1331 | ;; coding. | |
1332 | (let ((charsets (find-charset-string filename))) | |
1333 | (and (not (memq 'eight-bit-control charsets)) | |
1334 | (not (memq 'eight-bit-graphic charsets))))) | |
1335 | (setq from-coding (read-coding-system | |
1336 | (format "Recode filename %s from (default %s): " | |
1337 | filename default-coding) | |
1338 | default-coding)) | |
1339 | (setq from-coding (read-coding-system | |
1340 | (format "Recode filename %s from: " filename)))) | |
cdec2ad7 | 1341 | |
9bdbd98e KH |
1342 | ;; We provide the default coding only when a user is going to |
1343 | ;; change the encoding not from the default coding. | |
1344 | (if (eq from-coding default-coding) | |
1345 | (setq to-coding (read-coding-system | |
1346 | (format "Recode filename %s from %s to: " | |
1347 | filename from-coding))) | |
1348 | (setq to-coding (read-coding-system | |
1349 | (format "Recode filename %s from %s to (default %s): " | |
1350 | filename from-coding default-coding) | |
1351 | default-coding))) | |
1352 | (list filename from-coding to-coding))) | |
1353 | ||
1354 | (let* ((default-coding (or file-name-coding-system | |
1355 | default-file-name-coding-system)) | |
1356 | ;; FILE should have been decoded by DEFAULT-CODING. | |
1357 | (encoded (encode-coding-string file default-coding)) | |
1358 | (newname (decode-coding-string encoded coding)) | |
1359 | (new-encoded (encode-coding-string newname new-coding)) | |
1360 | ;; Suppress further encoding. | |
1361 | (file-name-coding-system nil) | |
1362 | (default-file-name-coding-system nil) | |
1363 | (locale-coding-system nil)) | |
1364 | (rename-file encoded new-encoded ok-if-already-exists) | |
1365 | newname)) | |
b4da00e9 | 1366 | \f |
4a977e20 CY |
1367 | (defcustom confirm-nonexistent-file-or-buffer 'after-completion |
1368 | "Whether confirmation is requested before visiting a new file or buffer. | |
1369 | If nil, confirmation is not requested. | |
1370 | If the value is `after-completion', confirmation is only | |
1371 | requested if the user called `minibuffer-complete' right before | |
1372 | `minibuffer-complete-and-exit'. | |
1373 | Any other non-nil value means to request confirmation. | |
1374 | ||
35b05a77 SM |
1375 | This affects commands like `switch-to-buffer' and `find-file'." |
1376 | :group 'find-file | |
1377 | :version "23.1" | |
b61324c3 GM |
1378 | :type '(choice (const :tag "After completion" after-completion) |
1379 | (const :tag "Never" nil) | |
1380 | (other :tag "Always" t))) | |
4a977e20 CY |
1381 | |
1382 | (defun confirm-nonexistent-file-or-buffer () | |
1383 | "Whether to request confirmation before visiting a new file or buffer. | |
1384 | The variable `confirm-nonexistent-file-or-buffer' determines the | |
1385 | return value, which may be passed as the REQUIRE-MATCH arg to | |
1386 | `read-buffer' or `find-file-read-args'." | |
1387 | (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion) | |
1388 | 'confirm-after-completion) | |
1389 | (confirm-nonexistent-file-or-buffer | |
1390 | 'confirm) | |
1391 | (t nil))) | |
35b05a77 | 1392 | |
a42e7db0 | 1393 | (defmacro minibuffer-with-setup-hook (fun &rest body) |
9bbe0828 | 1394 | "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY. |
a42e7db0 | 1395 | BODY should use the minibuffer at most once. |
9bbe0828 CY |
1396 | Recursive uses of the minibuffer are unaffected (FUN is not |
1397 | called additional times). | |
1398 | ||
4963739e | 1399 | This macro actually adds an auxiliary function that calls FUN, |
9bbe0828 | 1400 | rather than FUN itself, to `minibuffer-setup-hook'." |
a42e7db0 SM |
1401 | (declare (indent 1) (debug t)) |
1402 | (let ((hook (make-symbol "setup-hook"))) | |
44dce0fb RS |
1403 | `(let (,hook) |
1404 | (setq ,hook | |
1405 | (lambda () | |
1406 | ;; Clear out this hook so it does not interfere | |
1407 | ;; with any recursive minibuffer usage. | |
1408 | (remove-hook 'minibuffer-setup-hook ,hook) | |
2bd49e46 | 1409 | (funcall ,fun))) |
a42e7db0 SM |
1410 | (unwind-protect |
1411 | (progn | |
1412 | (add-hook 'minibuffer-setup-hook ,hook) | |
1413 | ,@body) | |
1414 | (remove-hook 'minibuffer-setup-hook ,hook))))) | |
1415 | ||
05a7cb3d | 1416 | (defun find-file-read-args (prompt mustmatch) |
7d371eac | 1417 | (list (read-file-name prompt nil default-directory mustmatch) |
b2a26f4e | 1418 | t)) |
e6f0ff92 | 1419 | |
243ce842 | 1420 | (defun find-file (filename &optional wildcards) |
b4da00e9 RM |
1421 | "Edit file FILENAME. |
1422 | Switch to a buffer visiting file FILENAME, | |
243ce842 | 1423 | creating one if none already exists. |
e6f0ff92 RS |
1424 | Interactively, the default if you just type RET is the current directory, |
1425 | but the visited file name is available through the minibuffer history: | |
1426 | type M-n to pull it into the minibuffer. | |
1427 | ||
4d4efd30 EZ |
1428 | You can visit files on remote machines by specifying something |
1429 | like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can | |
1430 | also visit local files as a different user by specifying | |
6f174d77 | 1431 | /sudo::FILE for the file name. |
776aa432 | 1432 | See the Info node `(tramp)File name Syntax' in the Tramp Info |
6f174d77 | 1433 | manual, for more about this. |
4d4efd30 | 1434 | |
243ce842 | 1435 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
91174d63 | 1436 | expand wildcards (if any) and visit multiple files. You can |
518dc5be | 1437 | suppress wildcard expansion by setting `find-file-wildcards' to nil. |
91174d63 RS |
1438 | |
1439 | To visit a file without any kind of conversion and without | |
1440 | automatically choosing a major mode, use \\[find-file-literally]." | |
14fd09e5 SM |
1441 | (interactive |
1442 | (find-file-read-args "Find file: " | |
4a977e20 | 1443 | (confirm-nonexistent-file-or-buffer))) |
5b8ed07b RS |
1444 | (let ((value (find-file-noselect filename nil nil wildcards))) |
1445 | (if (listp value) | |
c3313451 | 1446 | (mapcar 'switch-to-buffer (nreverse value)) |
24510c22 | 1447 | (switch-to-buffer value)))) |
82d0954a | 1448 | |
243ce842 | 1449 | (defun find-file-other-window (filename &optional wildcards) |
b4da00e9 | 1450 | "Edit file FILENAME, in another window. |
4d4efd30 EZ |
1451 | |
1452 | Like \\[find-file] (which see), but creates a new window or reuses | |
1453 | an existing one. See the function `display-buffer'. | |
e6f0ff92 RS |
1454 | |
1455 | Interactively, the default if you just type RET is the current directory, | |
1456 | but the visited file name is available through the minibuffer history: | |
1457 | type M-n to pull it into the minibuffer. | |
1458 | ||
243ce842 RS |
1459 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
1460 | expand wildcards (if any) and visit multiple files." | |
14fd09e5 SM |
1461 | (interactive |
1462 | (find-file-read-args "Find file in other window: " | |
4a977e20 | 1463 | (confirm-nonexistent-file-or-buffer))) |
5b8ed07b RS |
1464 | (let ((value (find-file-noselect filename nil nil wildcards))) |
1465 | (if (listp value) | |
1466 | (progn | |
1467 | (setq value (nreverse value)) | |
a9d6a617 JL |
1468 | (cons (switch-to-buffer-other-window (car value)) |
1469 | (mapcar 'switch-to-buffer (cdr value)))) | |
5b8ed07b | 1470 | (switch-to-buffer-other-window value)))) |
243ce842 RS |
1471 | |
1472 | (defun find-file-other-frame (filename &optional wildcards) | |
f98955ea | 1473 | "Edit file FILENAME, in another frame. |
4d4efd30 EZ |
1474 | |
1475 | Like \\[find-file] (which see), but creates a new frame or reuses | |
1476 | an existing one. See the function `display-buffer'. | |
e6f0ff92 RS |
1477 | |
1478 | Interactively, the default if you just type RET is the current directory, | |
1479 | but the visited file name is available through the minibuffer history: | |
1480 | type M-n to pull it into the minibuffer. | |
1481 | ||
243ce842 RS |
1482 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
1483 | expand wildcards (if any) and visit multiple files." | |
14fd09e5 SM |
1484 | (interactive |
1485 | (find-file-read-args "Find file in other frame: " | |
4a977e20 | 1486 | (confirm-nonexistent-file-or-buffer))) |
5b8ed07b RS |
1487 | (let ((value (find-file-noselect filename nil nil wildcards))) |
1488 | (if (listp value) | |
1489 | (progn | |
1490 | (setq value (nreverse value)) | |
a9d6a617 JL |
1491 | (cons (switch-to-buffer-other-frame (car value)) |
1492 | (mapcar 'switch-to-buffer (cdr value)))) | |
5b8ed07b | 1493 | (switch-to-buffer-other-frame value)))) |
243ce842 | 1494 | |
63c8abc4 EZ |
1495 | (defun find-file-existing (filename) |
1496 | "Edit the existing file FILENAME. | |
4d4efd30 | 1497 | Like \\[find-file], but only allow a file that exists, and do not allow |
63c8abc4 EZ |
1498 | file names with wildcards." |
1499 | (interactive (nbutlast (find-file-read-args "Find existing file: " t))) | |
32226619 JB |
1500 | (if (and (not (called-interactively-p 'interactive)) |
1501 | (not (file-exists-p filename))) | |
63c8abc4 EZ |
1502 | (error "%s does not exist" filename) |
1503 | (find-file filename) | |
1504 | (current-buffer))) | |
46bfc73b | 1505 | |
0781098a | 1506 | (defun find-file--read-only (fun filename wildcards) |
a9d6a617 JL |
1507 | (unless (or (and wildcards find-file-wildcards |
1508 | (not (string-match "\\`/:" filename)) | |
1509 | (string-match "[[*?]" filename)) | |
1510 | (file-exists-p filename)) | |
1511 | (error "%s does not exist" filename)) | |
0781098a | 1512 | (let ((value (funcall fun filename wildcards))) |
35e62fc9 | 1513 | (mapc (lambda (b) (with-current-buffer b (read-only-mode 1))) |
a9d6a617 JL |
1514 | (if (listp value) value (list value))) |
1515 | value)) | |
b4da00e9 | 1516 | |
0781098a SM |
1517 | (defun find-file-read-only (filename &optional wildcards) |
1518 | "Edit file FILENAME but don't allow changes. | |
1519 | Like \\[find-file], but marks buffer as read-only. | |
1520 | Use \\[toggle-read-only] to permit editing." | |
1521 | (interactive | |
1522 | (find-file-read-args "Find file read-only: " | |
1523 | (confirm-nonexistent-file-or-buffer))) | |
1524 | (find-file--read-only #'find-file filename wildcards)) | |
1525 | ||
243ce842 | 1526 | (defun find-file-read-only-other-window (filename &optional wildcards) |
b4da00e9 | 1527 | "Edit file FILENAME in another window but don't allow changes. |
4d4efd30 | 1528 | Like \\[find-file-other-window], but marks buffer as read-only. |
b4da00e9 | 1529 | Use \\[toggle-read-only] to permit editing." |
14fd09e5 SM |
1530 | (interactive |
1531 | (find-file-read-args "Find file read-only other window: " | |
4a977e20 | 1532 | (confirm-nonexistent-file-or-buffer))) |
0781098a | 1533 | (find-file--read-only #'find-file-other-window filename wildcards)) |
b4da00e9 | 1534 | |
243ce842 | 1535 | (defun find-file-read-only-other-frame (filename &optional wildcards) |
f98955ea | 1536 | "Edit file FILENAME in another frame but don't allow changes. |
4d4efd30 | 1537 | Like \\[find-file-other-frame], but marks buffer as read-only. |
5bbbceb1 | 1538 | Use \\[toggle-read-only] to permit editing." |
14fd09e5 SM |
1539 | (interactive |
1540 | (find-file-read-args "Find file read-only other frame: " | |
4a977e20 | 1541 | (confirm-nonexistent-file-or-buffer))) |
0781098a | 1542 | (find-file--read-only #'find-file-other-frame filename wildcards)) |
a9d6a617 JL |
1543 | |
1544 | (defun find-alternate-file-other-window (filename &optional wildcards) | |
60eaf370 | 1545 | "Find file FILENAME as a replacement for the file in the next window. |
a9d6a617 JL |
1546 | This command does not select that window. |
1547 | ||
4d4efd30 EZ |
1548 | See \\[find-file] for the possible forms of the FILENAME argument. |
1549 | ||
a9d6a617 JL |
1550 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
1551 | expand wildcards (if any) and replace the file with multiple files." | |
60eaf370 RS |
1552 | (interactive |
1553 | (save-selected-window | |
1554 | (other-window 1) | |
1555 | (let ((file buffer-file-name) | |
1556 | (file-name nil) | |
1557 | (file-dir nil)) | |
1558 | (and file | |
1559 | (setq file-name (file-name-nondirectory file) | |
1560 | file-dir (file-name-directory file))) | |
1561 | (list (read-file-name | |
4b8b1ec5 SM |
1562 | "Find alternate file: " file-dir nil |
1563 | (confirm-nonexistent-file-or-buffer) file-name) | |
a9d6a617 | 1564 | t)))) |
60eaf370 | 1565 | (if (one-window-p) |
a9d6a617 | 1566 | (find-file-other-window filename wildcards) |
60eaf370 RS |
1567 | (save-selected-window |
1568 | (other-window 1) | |
a9d6a617 | 1569 | (find-alternate-file filename wildcards)))) |
60eaf370 | 1570 | |
e5d9c0d1 CY |
1571 | ;; Defined and used in buffer.c, but not as a DEFVAR_LISP. |
1572 | (defvar kill-buffer-hook nil | |
1573 | "Hook run when a buffer is killed. | |
1574 | The buffer being killed is current while the hook is running. | |
7b0e2f85 LL |
1575 | See `kill-buffer'. |
1576 | ||
1577 | Note: Be careful with let-binding this hook considering it is | |
1578 | frequently used for cleanup.") | |
06b60517 | 1579 | |
a9d6a617 | 1580 | (defun find-alternate-file (filename &optional wildcards) |
b4da00e9 RM |
1581 | "Find file FILENAME, select its buffer, kill previous buffer. |
1582 | If the current buffer now contains an empty file that you just visited | |
a9d6a617 JL |
1583 | \(presumably by mistake), use this command to visit the file you really want. |
1584 | ||
4d4efd30 EZ |
1585 | See \\[find-file] for the possible forms of the FILENAME argument. |
1586 | ||
a9d6a617 | 1587 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
077f47e2 CY |
1588 | expand wildcards (if any) and replace the file with multiple files. |
1589 | ||
1590 | If the current buffer is an indirect buffer, or the base buffer | |
1591 | for one or more indirect buffers, the other buffer(s) are not | |
1592 | killed." | |
b4da00e9 RM |
1593 | (interactive |
1594 | (let ((file buffer-file-name) | |
1595 | (file-name nil) | |
1596 | (file-dir nil)) | |
1597 | (and file | |
1598 | (setq file-name (file-name-nondirectory file) | |
1599 | file-dir (file-name-directory file))) | |
a61f59b4 | 1600 | (list (read-file-name |
4b8b1ec5 SM |
1601 | "Find alternate file: " file-dir nil |
1602 | (confirm-nonexistent-file-or-buffer) file-name) | |
a9d6a617 | 1603 | t))) |
63fabbb4 RS |
1604 | (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions) |
1605 | (error "Aborted")) | |
e07fcbdc SM |
1606 | (and (buffer-modified-p) buffer-file-name |
1607 | (not (yes-or-no-p "Kill and replace the buffer without saving it? ")) | |
1608 | (error "Aborted")) | |
b4da00e9 RM |
1609 | (let ((obuf (current-buffer)) |
1610 | (ofile buffer-file-name) | |
8bb27285 | 1611 | (onum buffer-file-number) |
37c58ca6 | 1612 | (odir dired-directory) |
8bb27285 | 1613 | (otrue buffer-file-truename) |
b4da00e9 | 1614 | (oname (buffer-name))) |
049a231b KF |
1615 | ;; Run `kill-buffer-hook' here. It needs to happen before |
1616 | ;; variables like `buffer-file-name' etc are set to nil below, | |
1617 | ;; because some of the hooks that could be invoked | |
1618 | ;; (e.g., `save-place-to-alist') depend on those variables. | |
1619 | ;; | |
1620 | ;; Note that `kill-buffer-hook' is not what queries whether to | |
1621 | ;; save a modified buffer visiting a file. Rather, `kill-buffer' | |
1622 | ;; asks that itself. Thus, there's no need to temporarily do | |
1623 | ;; `(set-buffer-modified-p nil)' before running this hook. | |
1624 | (run-hooks 'kill-buffer-hook) | |
1625 | ;; Okay, now we can end-of-life the old buffer. | |
baf9b8c4 RS |
1626 | (if (get-buffer " **lose**") |
1627 | (kill-buffer " **lose**")) | |
b4da00e9 | 1628 | (rename-buffer " **lose**") |
b4da00e9 RM |
1629 | (unwind-protect |
1630 | (progn | |
1631 | (unlock-buffer) | |
7906c044 RS |
1632 | ;; This prevents us from finding the same buffer |
1633 | ;; if we specified the same file again. | |
a4ad4d96 RS |
1634 | (setq buffer-file-name nil) |
1635 | (setq buffer-file-number nil) | |
1636 | (setq buffer-file-truename nil) | |
7906c044 RS |
1637 | ;; Likewise for dired buffers. |
1638 | (setq dired-directory nil) | |
a9d6a617 | 1639 | (find-file filename wildcards)) |
63fabbb4 RS |
1640 | (when (eq obuf (current-buffer)) |
1641 | ;; This executes if find-file gets an error | |
1642 | ;; and does not really find anything. | |
1643 | ;; We put things back as they were. | |
1644 | ;; If find-file actually finds something, we kill obuf below. | |
1645 | (setq buffer-file-name ofile) | |
1646 | (setq buffer-file-number onum) | |
1647 | (setq buffer-file-truename otrue) | |
7906c044 | 1648 | (setq dired-directory odir) |
63fabbb4 RS |
1649 | (lock-buffer) |
1650 | (rename-buffer oname))) | |
1651 | (unless (eq (current-buffer) obuf) | |
d97a9ff3 | 1652 | (with-current-buffer obuf |
049a231b KF |
1653 | ;; We already ran these; don't run them again. |
1654 | (let (kill-buffer-query-functions kill-buffer-hook) | |
d97a9ff3 | 1655 | (kill-buffer obuf)))))) |
9b8ef27d | 1656 | \f |
99d8aedf GM |
1657 | ;; FIXME we really need to fold the uniquify stuff in here by default, |
1658 | ;; not using advice, and add it to the doc string. | |
b4da00e9 RM |
1659 | (defun create-file-buffer (filename) |
1660 | "Create a suitably named buffer for visiting FILENAME, and return it. | |
1661 | FILENAME (sans directory) is used unchanged if that name is free; | |
661e8cd1 | 1662 | otherwise a string <2> or <3> or ... is appended to get an unused name. |
bb35f42f GM |
1663 | |
1664 | Emacs treats buffers whose names begin with a space as internal buffers. | |
1665 | To avoid confusion when visiting a file whose name begins with a space, | |
1666 | this function prepends a \"|\" to the final result if necessary." | |
b4da00e9 RM |
1667 | (let ((lastname (file-name-nondirectory filename))) |
1668 | (if (string= lastname "") | |
1669 | (setq lastname filename)) | |
bb35f42f GM |
1670 | (generate-new-buffer (if (string-match-p "\\` " lastname) |
1671 | (concat "|" lastname) | |
1672 | lastname)))) | |
b4da00e9 | 1673 | |
5bbbceb1 JB |
1674 | (defun generate-new-buffer (name) |
1675 | "Create and return a buffer with a name based on NAME. | |
29165787 | 1676 | Choose the buffer's name using `generate-new-buffer-name'." |
5bbbceb1 JB |
1677 | (get-buffer-create (generate-new-buffer-name name))) |
1678 | ||
1e8780b1 | 1679 | (defcustom automount-dir-prefix (purecopy "^/tmp_mnt/") |
ffc0e1ca AS |
1680 | "Regexp to match the automounter prefix in a directory name." |
1681 | :group 'files | |
1682 | :type 'regexp) | |
2a1e2476 | 1683 | (make-obsolete-variable 'automount-dir-prefix 'directory-abbrev-alist "24.3") |
e373f201 | 1684 | |
ffb3a4db | 1685 | (defvar abbreviated-home-dir nil |
ffc0e1ca | 1686 | "The user's homedir abbreviated according to `directory-abbrev-alist'.") |
ffb3a4db | 1687 | |
5bbbceb1 | 1688 | (defun abbreviate-file-name (filename) |
29165787 | 1689 | "Return a version of FILENAME shortened using `directory-abbrev-alist'. |
fe4e58ec EZ |
1690 | This also substitutes \"~\" for the user's home directory (unless the |
1691 | home directory is a root directory) and removes automounter prefixes | |
1692 | \(see the variable `automount-dir-prefix')." | |
e373f201 | 1693 | ;; Get rid of the prefixes added by the automounter. |
f663a1ce RS |
1694 | (save-match-data |
1695 | (if (and automount-dir-prefix | |
1696 | (string-match automount-dir-prefix filename) | |
1697 | (file-exists-p (file-name-directory | |
1698 | (substring filename (1- (match-end 0)))))) | |
1699 | (setq filename (substring filename (1- (match-end 0))))) | |
20431da9 CY |
1700 | ;; Avoid treating /home/foo as /home/Foo during `~' substitution. |
1701 | ;; To fix this right, we need a `file-name-case-sensitive-p' | |
1702 | ;; function, but we don't have that yet, so just guess. | |
9f2f6ad8 | 1703 | (let ((case-fold-search |
20431da9 | 1704 | (memq system-type '(ms-dos windows-nt darwin cygwin)))) |
f663a1ce RS |
1705 | ;; If any elt of directory-abbrev-alist matches this name, |
1706 | ;; abbreviate accordingly. | |
20431da9 CY |
1707 | (dolist (dir-abbrev directory-abbrev-alist) |
1708 | (if (string-match (car dir-abbrev) filename) | |
f663a1ce | 1709 | (setq filename |
20431da9 CY |
1710 | (concat (cdr dir-abbrev) |
1711 | (substring filename (match-end 0)))))) | |
f663a1ce RS |
1712 | ;; Compute and save the abbreviated homedir name. |
1713 | ;; We defer computing this until the first time it's needed, to | |
1714 | ;; give time for directory-abbrev-alist to be set properly. | |
1715 | ;; We include a slash at the end, to avoid spurious matches | |
1716 | ;; such as `/usr/foobar' when the home dir is `/usr/foo'. | |
1717 | (or abbreviated-home-dir | |
1718 | (setq abbreviated-home-dir | |
1719 | (let ((abbreviated-home-dir "$foo")) | |
528c56e2 | 1720 | (concat "\\`" (abbreviate-file-name (expand-file-name "~")) |
e959542d | 1721 | "\\(/\\|\\'\\)")))) |
f663a1ce RS |
1722 | |
1723 | ;; If FILENAME starts with the abbreviated homedir, | |
1724 | ;; make it start with `~' instead. | |
1725 | (if (and (string-match abbreviated-home-dir filename) | |
1726 | ;; If the home dir is just /, don't change it. | |
1727 | (not (and (= (match-end 0) 1) | |
1728 | (= (aref filename 0) ?/))) | |
1729 | ;; MS-DOS root directories can come with a drive letter; | |
1730 | ;; Novell Netware allows drive letters beyond `Z:'. | |
528c56e2 | 1731 | (not (and (memq system-type '(ms-dos windows-nt cygwin)) |
f663a1ce RS |
1732 | (save-match-data |
1733 | (string-match "^[a-zA-`]:/$" filename))))) | |
5bbbceb1 | 1734 | (setq filename |
f663a1ce RS |
1735 | (concat "~" |
1736 | (match-string 1 filename) | |
1737 | (substring filename (match-end 0))))) | |
1738 | filename))) | |
5bbbceb1 | 1739 | |
3a64a3cf | 1740 | (defun find-buffer-visiting (filename &optional predicate) |
138c44f6 KH |
1741 | "Return the buffer visiting file FILENAME (a string). |
1742 | This is like `get-file-buffer', except that it checks for any buffer | |
1743 | visiting the same file, possibly under a different name. | |
a1b0c2a7 RS |
1744 | If PREDICATE is non-nil, only buffers satisfying it are eligible, |
1745 | and others are ignored. | |
138c44f6 | 1746 | If there is no such live buffer, return nil." |
3a64a3cf JB |
1747 | (let ((predicate (or predicate #'identity)) |
1748 | (truename (abbreviate-file-name (file-truename filename)))) | |
1749 | (or (let ((buf (get-file-buffer filename))) | |
1750 | (when (and buf (funcall predicate buf)) buf)) | |
1751 | (let ((list (buffer-list)) found) | |
1752 | (while (and (not found) list) | |
528c56e2 | 1753 | (with-current-buffer (car list) |
3a64a3cf JB |
1754 | (if (and buffer-file-name |
1755 | (string= buffer-file-truename truename) | |
1756 | (funcall predicate (current-buffer))) | |
1757 | (setq found (car list)))) | |
1758 | (setq list (cdr list))) | |
1759 | found) | |
1760 | (let* ((attributes (file-attributes truename)) | |
1761 | (number (nthcdr 10 attributes)) | |
1762 | (list (buffer-list)) found) | |
1763 | (and buffer-file-numbers-unique | |
02bb2aab | 1764 | (car-safe number) ;Make sure the inode is not just nil. |
3a64a3cf JB |
1765 | (while (and (not found) list) |
1766 | (with-current-buffer (car list) | |
1767 | (if (and buffer-file-name | |
1768 | (equal buffer-file-number number) | |
1769 | ;; Verify this buffer's file number | |
1770 | ;; still belongs to its file. | |
1771 | (file-exists-p buffer-file-name) | |
1772 | (equal (file-attributes buffer-file-truename) | |
1773 | attributes) | |
1774 | (funcall predicate (current-buffer))) | |
1775 | (setq found (car list)))) | |
1776 | (setq list (cdr list)))) | |
1777 | found)))) | |
9b8ef27d | 1778 | \f |
5de148a2 | 1779 | (defcustom find-file-wildcards t |
ba83982b | 1780 | "Non-nil means file-visiting commands should handle wildcards. |
5de148a2 RS |
1781 | For example, if you specify `*.c', that would visit all the files |
1782 | whose names match the pattern." | |
1783 | :group 'files | |
3957c982 | 1784 | :version "20.4" |
5de148a2 RS |
1785 | :type 'boolean) |
1786 | ||
ffc0e1ca | 1787 | (defcustom find-file-suppress-same-file-warnings nil |
ba83982b | 1788 | "Non-nil means suppress warning messages for symlinked files. |
ffc0e1ca AS |
1789 | When nil, Emacs prints a warning when visiting a file that is already |
1790 | visited, but with a different name. Setting this option to t | |
1791 | suppresses this warning." | |
1792 | :group 'files | |
1793 | :version "21.1" | |
1794 | :type 'boolean) | |
1795 | ||
818286f4 | 1796 | (defcustom large-file-warning-threshold 10000000 |
5d648479 JPW |
1797 | "Maximum size of file above which a confirmation is requested. |
1798 | When nil, never request confirmation." | |
1799 | :group 'files | |
1800 | :group 'find-file | |
bf247b6e | 1801 | :version "22.1" |
5d648479 | 1802 | :type '(choice integer (const :tag "Never request confirmation" nil))) |
818286f4 | 1803 | |
26ede5d3 | 1804 | (defun abort-if-file-too-large (size op-type filename) |
afe9998d | 1805 | "If file SIZE larger than `large-file-warning-threshold', allow user to abort. |
4954b81b AR |
1806 | OP-TYPE specifies the file operation being performed (for message to user)." |
1807 | (when (and large-file-warning-threshold size | |
3ef01959 | 1808 | (> size large-file-warning-threshold) |
54c5ba1a | 1809 | (not (y-or-n-p (format "File %s is large (%s), really %s? " |
9aea757b | 1810 | (file-name-nondirectory filename) |
54c5ba1a | 1811 | (file-size-human-readable size) op-type)))) |
3ef01959 | 1812 | (error "Aborted"))) |
4954b81b | 1813 | |
243ce842 | 1814 | (defun find-file-noselect (filename &optional nowarn rawfile wildcards) |
b4da00e9 RM |
1815 | "Read file FILENAME into a buffer and return the buffer. |
1816 | If a buffer exists visiting FILENAME, return that one, but | |
1817 | verify that the file has not changed since visited or saved. | |
82d0954a | 1818 | The buffer is not selected, just returned to the caller. |
26b9ecbc JB |
1819 | Optional second arg NOWARN non-nil means suppress any warning messages. |
1820 | Optional third arg RAWFILE non-nil means the file is read literally. | |
1821 | Optional fourth arg WILDCARDS non-nil means do wildcard processing | |
5b8ed07b | 1822 | and visit all the matching files. When wildcards are actually |
a9d6a617 JL |
1823 | used and expanded, return a list of buffers that are visiting |
1824 | the various files." | |
e373f201 JB |
1825 | (setq filename |
1826 | (abbreviate-file-name | |
1827 | (expand-file-name filename))) | |
b4da00e9 | 1828 | (if (file-directory-p filename) |
ffc0e1ca AS |
1829 | (or (and find-file-run-dired |
1830 | (run-hook-with-args-until-success | |
1831 | 'find-directory-functions | |
1832 | (if find-file-visit-truename | |
1833 | (abbreviate-file-name (file-truename filename)) | |
1834 | filename))) | |
1835 | (error "%s is a directory" filename)) | |
243ce842 RS |
1836 | (if (and wildcards |
1837 | find-file-wildcards | |
f91fe604 | 1838 | (not (string-match "\\`/:" filename)) |
5de148a2 | 1839 | (string-match "[[*?]" filename)) |
ffc0e1ca AS |
1840 | (let ((files (condition-case nil |
1841 | (file-expand-wildcards filename t) | |
1842 | (error (list filename)))) | |
5de148a2 | 1843 | (find-file-wildcards nil)) |
f91fe604 | 1844 | (if (null files) |
ffc0e1ca | 1845 | (find-file-noselect filename) |
648ec2ff | 1846 | (mapcar #'find-file-noselect files))) |
5de148a2 RS |
1847 | (let* ((buf (get-file-buffer filename)) |
1848 | (truename (abbreviate-file-name (file-truename filename))) | |
818286f4 SM |
1849 | (attributes (file-attributes truename)) |
1850 | (number (nthcdr 10 attributes)) | |
5de148a2 RS |
1851 | ;; Find any buffer for a file which has same truename. |
1852 | (other (and (not buf) (find-buffer-visiting filename)))) | |
1853 | ;; Let user know if there is a buffer with the same truename. | |
1854 | (if other | |
1855 | (progn | |
1856 | (or nowarn | |
ffc0e1ca | 1857 | find-file-suppress-same-file-warnings |
5de148a2 RS |
1858 | (string-equal filename (buffer-file-name other)) |
1859 | (message "%s and %s are the same file" | |
1860 | filename (buffer-file-name other))) | |
1861 | ;; Optionally also find that buffer. | |
1862 | (if (or find-file-existing-other-name find-file-visit-truename) | |
1863 | (setq buf other)))) | |
818286f4 | 1864 | ;; Check to see if the file looks uncommonly large. |
4954b81b | 1865 | (when (not (or buf nowarn)) |
26ede5d3 | 1866 | (abort-if-file-too-large (nth 7 attributes) "open" filename)) |
5de148a2 RS |
1867 | (if buf |
1868 | ;; We are using an existing buffer. | |
2c5b1db7 | 1869 | (let (nonexistent) |
5de148a2 RS |
1870 | (or nowarn |
1871 | (verify-visited-file-modtime buf) | |
1872 | (cond ((not (file-exists-p filename)) | |
2c5b1db7 RS |
1873 | (setq nonexistent t) |
1874 | (message "File %s no longer exists!" filename)) | |
5de148a2 RS |
1875 | ;; Certain files should be reverted automatically |
1876 | ;; if they have changed on disk and not in the buffer. | |
1877 | ((and (not (buffer-modified-p buf)) | |
1878 | (let ((tail revert-without-query) | |
1879 | (found nil)) | |
1880 | (while tail | |
1881 | (if (string-match (car tail) filename) | |
1882 | (setq found t)) | |
1883 | (setq tail (cdr tail))) | |
1884 | found)) | |
1885 | (with-current-buffer buf | |
1886 | (message "Reverting file %s..." filename) | |
1887 | (revert-buffer t t) | |
1888 | (message "Reverting file %s...done" filename))) | |
1889 | ((yes-or-no-p | |
1890 | (if (string= (file-name-nondirectory filename) | |
1891 | (buffer-name buf)) | |
1892 | (format | |
1893 | (if (buffer-modified-p buf) | |
1894 | "File %s changed on disk. Discard your edits? " | |
1895 | "File %s changed on disk. Reread from disk? ") | |
1896 | (file-name-nondirectory filename)) | |
ddd64da9 RS |
1897 | (format |
1898 | (if (buffer-modified-p buf) | |
5de148a2 RS |
1899 | "File %s changed on disk. Discard your edits in %s? " |
1900 | "File %s changed on disk. Reread from disk into %s? ") | |
1901 | (file-name-nondirectory filename) | |
1902 | (buffer-name buf)))) | |
1903 | (with-current-buffer buf | |
1904 | (revert-buffer t t))))) | |
1905 | (with-current-buffer buf | |
a8d002d2 GM |
1906 | |
1907 | ;; Check if a formerly read-only file has become | |
e554eeb7 RS |
1908 | ;; writable and vice versa, but if the buffer agrees |
1909 | ;; with the new state of the file, that is ok too. | |
a8d002d2 | 1910 | (let ((read-only (not (file-writable-p buffer-file-name)))) |
2c5b1db7 RS |
1911 | (unless (or nonexistent |
1912 | (eq read-only buffer-file-read-only) | |
e554eeb7 | 1913 | (eq read-only buffer-read-only)) |
a8d002d2 | 1914 | (when (or nowarn |
9e108fe6 LI |
1915 | (let* ((new-status |
1916 | (if read-only "read-only" "writable")) | |
1917 | (question | |
1918 | (format "File %s is %s on disk. Make buffer %s, too? " | |
1919 | buffer-file-name | |
1920 | new-status new-status))) | |
a8d002d2 | 1921 | (y-or-n-p question))) |
e554eeb7 RS |
1922 | (setq buffer-read-only read-only))) |
1923 | (setq buffer-file-read-only read-only)) | |
a8d002d2 | 1924 | |
ef099a94 MN |
1925 | (unless (or (eq (null rawfile) (null find-file-literally)) |
1926 | nonexistent | |
1927 | ;; It is confusing to ask whether to visit | |
1928 | ;; non-literally if they have the file in | |
1929 | ;; hexl-mode or image-mode. | |
1930 | (memq major-mode '(hexl-mode image-mode))) | |
5de148a2 | 1931 | (if (buffer-modified-p) |
562ca538 | 1932 | (if (y-or-n-p |
674b7bae | 1933 | (format |
562ca538 RS |
1934 | (if rawfile |
1935 | "The file %s is already visited normally, | |
1936 | and you have edited the buffer. Now you have asked to visit it literally, | |
1937 | meaning no coding system handling, format conversion, or local variables. | |
1938 | Emacs can only visit a file in one way at a time. | |
1939 | ||
1940 | Do you want to save the file, and visit it literally instead? " | |
1941 | "The file %s is already visited literally, | |
1942 | meaning no coding system handling, format conversion, or local variables. | |
1943 | You have edited the buffer. Now you have asked to visit the file normally, | |
1944 | but Emacs can only visit a file in one way at a time. | |
1945 | ||
1946 | Do you want to save the file, and visit it normally instead? ") | |
1947 | (file-name-nondirectory filename))) | |
5de148a2 RS |
1948 | (progn |
1949 | (save-buffer) | |
1950 | (find-file-noselect-1 buf filename nowarn | |
1951 | rawfile truename number)) | |
562ca538 | 1952 | (if (y-or-n-p |
674b7bae | 1953 | (format |
562ca538 RS |
1954 | (if rawfile |
1955 | "\ | |
1956 | Do you want to discard your changes, and visit the file literally now? " | |
1957 | "\ | |
1958 | Do you want to discard your changes, and visit the file normally now? "))) | |
5de148a2 RS |
1959 | (find-file-noselect-1 buf filename nowarn |
1960 | rawfile truename number) | |
1961 | (error (if rawfile "File already visited non-literally" | |
1962 | "File already visited literally")))) | |
674b7bae JB |
1963 | (if (y-or-n-p |
1964 | (format | |
562ca538 RS |
1965 | (if rawfile |
1966 | "The file %s is already visited normally. | |
1967 | You have asked to visit it literally, | |
1968 | meaning no coding system decoding, format conversion, or local variables. | |
1969 | But Emacs can only visit a file in one way at a time. | |
1970 | ||
1971 | Do you want to revisit the file literally now? " | |
1972 | "The file %s is already visited literally, | |
1973 | meaning no coding system decoding, format conversion, or local variables. | |
1974 | You have asked to visit it normally, | |
1975 | but Emacs can only visit a file in one way at a time. | |
1976 | ||
1977 | Do you want to revisit the file normally now? ") | |
1978 | (file-name-nondirectory filename))) | |
5de148a2 RS |
1979 | (find-file-noselect-1 buf filename nowarn |
1980 | rawfile truename number) | |
1981 | (error (if rawfile "File already visited non-literally" | |
1982 | "File already visited literally")))))) | |
1983 | ;; Return the buffer we are using. | |
1984 | buf) | |
1985 | ;; Create a new buffer. | |
1986 | (setq buf (create-file-buffer filename)) | |
5de148a2 RS |
1987 | ;; find-file-noselect-1 may use a different buffer. |
1988 | (find-file-noselect-1 buf filename nowarn | |
1989 | rawfile truename number)))))) | |
ddd64da9 RS |
1990 | |
1991 | (defun find-file-noselect-1 (buf filename nowarn rawfile truename number) | |
4edcfd17 | 1992 | (let (error) |
ddd64da9 RS |
1993 | (with-current-buffer buf |
1994 | (kill-local-variable 'find-file-literally) | |
b296cbd4 RS |
1995 | ;; Needed in case we are re-visiting the file with a different |
1996 | ;; text representation. | |
e73ec04b | 1997 | (kill-local-variable 'buffer-file-coding-system) |
4ad1689f | 1998 | (kill-local-variable 'cursor-type) |
4edcfd17 | 1999 | (let ((inhibit-read-only t)) |
0a11c70b LT |
2000 | (erase-buffer)) |
2001 | (and (default-value 'enable-multibyte-characters) | |
2002 | (not rawfile) | |
2003 | (set-buffer-multibyte t)) | |
2004 | (if rawfile | |
74dca654 | 2005 | (condition-case () |
0a11c70b LT |
2006 | (let ((inhibit-read-only t)) |
2007 | (insert-file-contents-literally filename t)) | |
74dca654 LT |
2008 | (file-error |
2009 | (when (and (file-exists-p filename) | |
2010 | (not (file-readable-p filename))) | |
2011 | (kill-buffer buf) | |
2012 | (signal 'file-error (list "File is not readable" | |
2013 | filename))) | |
0a11c70b LT |
2014 | ;; Unconditionally set error |
2015 | (setq error t))) | |
2016 | (condition-case () | |
2017 | (let ((inhibit-read-only t)) | |
2018 | (insert-file-contents filename t)) | |
2019 | (file-error | |
2020 | (when (and (file-exists-p filename) | |
2021 | (not (file-readable-p filename))) | |
2022 | (kill-buffer buf) | |
2023 | (signal 'file-error (list "File is not readable" | |
2024 | filename))) | |
e0d8fc91 | 2025 | ;; Run find-file-not-found-functions until one returns non-nil. |
0a11c70b LT |
2026 | (or (run-hook-with-args-until-success 'find-file-not-found-functions) |
2027 | ;; If they fail too, set error. | |
2028 | (setq error t))))) | |
b120e713 KH |
2029 | ;; Record the file's truename, and maybe use that as visited name. |
2030 | (if (equal filename buffer-file-name) | |
2031 | (setq buffer-file-truename truename) | |
9ab19105 DL |
2032 | (setq buffer-file-truename |
2033 | (abbreviate-file-name (file-truename buffer-file-name)))) | |
ddd64da9 | 2034 | (setq buffer-file-number number) |
ddd64da9 | 2035 | (if find-file-visit-truename |
e442c62b | 2036 | (setq buffer-file-name (expand-file-name buffer-file-truename))) |
ddd64da9 | 2037 | ;; Set buffer's default directory to that of the file. |
b120e713 | 2038 | (setq default-directory (file-name-directory buffer-file-name)) |
ddd64da9 RS |
2039 | ;; Turn off backup files for certain file names. Since |
2040 | ;; this is a permanent local, the major mode won't eliminate it. | |
b98a8e06 RS |
2041 | (and backup-enable-predicate |
2042 | (not (funcall backup-enable-predicate buffer-file-name)) | |
ddd64da9 RS |
2043 | (progn |
2044 | (make-local-variable 'backup-inhibited) | |
2045 | (setq backup-inhibited t))) | |
f402ba38 RS |
2046 | (if rawfile |
2047 | (progn | |
2048 | (set-buffer-multibyte nil) | |
2049 | (setq buffer-file-coding-system 'no-conversion) | |
e8f30180 | 2050 | (set-buffer-major-mode buf) |
91e8293c | 2051 | (setq-local find-file-literally t)) |
f402ba38 RS |
2052 | (after-find-file error (not nowarn))) |
2053 | (current-buffer)))) | |
9b8ef27d RS |
2054 | \f |
2055 | (defun insert-file-contents-literally (filename &optional visit beg end replace) | |
2056 | "Like `insert-file-contents', but only reads in the file literally. | |
2057 | A buffer may be modified in several ways after reading into the buffer, | |
2058 | to Emacs features such as format decoding, character code | |
0370fe77 | 2059 | conversion, `find-file-hook', automatic uncompression, etc. |
9b8ef27d RS |
2060 | |
2061 | This function ensures that none of these modifications will take place." | |
2062 | (let ((format-alist nil) | |
2063 | (after-insert-file-functions nil) | |
2064 | (coding-system-for-read 'no-conversion) | |
2065 | (coding-system-for-write 'no-conversion) | |
cdec2ad7 | 2066 | (inhibit-file-name-handlers |
0781098a SM |
2067 | ;; FIXME: Yuck!! We should turn insert-file-contents-literally |
2068 | ;; into a file operation instead! | |
bfeee9d1 | 2069 | (append '(jka-compr-handler image-file-handler epa-file-handler) |
cdec2ad7 JB |
2070 | inhibit-file-name-handlers)) |
2071 | (inhibit-file-name-operation 'insert-file-contents)) | |
0781098a | 2072 | (insert-file-contents filename visit beg end replace))) |
9b8ef27d | 2073 | |
3a64a3cf JB |
2074 | (defun insert-file-1 (filename insert-func) |
2075 | (if (file-directory-p filename) | |
2076 | (signal 'file-error (list "Opening input file" "file is a directory" | |
2077 | filename))) | |
4954b81b | 2078 | ;; Check whether the file is uncommonly large |
26ede5d3 | 2079 | (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename) |
3a64a3cf JB |
2080 | (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename)) |
2081 | #'buffer-modified-p)) | |
2082 | (tem (funcall insert-func filename))) | |
2083 | (push-mark (+ (point) (car (cdr tem)))) | |
2084 | (when buffer | |
2085 | (message "File %s already visited and modified in buffer %s" | |
2086 | filename (buffer-name buffer))))) | |
2087 | ||
9b8ef27d RS |
2088 | (defun insert-file-literally (filename) |
2089 | "Insert contents of file FILENAME into buffer after point with no conversion. | |
2090 | ||
2091 | This function is meant for the user to run interactively. | |
2092 | Don't call it from programs! Use `insert-file-contents-literally' instead. | |
2093 | \(Its calling sequence is different; see its documentation)." | |
2094 | (interactive "*fInsert file literally: ") | |
3a64a3cf | 2095 | (insert-file-1 filename #'insert-file-contents-literally)) |
3e2fb4db | 2096 | (put 'insert-file-literally 'interactive-only 'insert-file-contents-literally) |
9b8ef27d RS |
2097 | |
2098 | (defvar find-file-literally nil | |
2099 | "Non-nil if this buffer was made by `find-file-literally' or equivalent. | |
72d6685c GM |
2100 | This has the `permanent-local' property, which takes effect if you |
2101 | make the variable buffer-local.") | |
9b8ef27d | 2102 | (put 'find-file-literally 'permanent-local t) |
5fc196af | 2103 | |
ffc0e1ca | 2104 | (defun find-file-literally (filename) |
5fc196af RS |
2105 | "Visit file FILENAME with no conversion of any kind. |
2106 | Format conversion and character code conversion are both disabled, | |
2107 | and multibyte characters are disabled in the resulting buffer. | |
e65db7b8 RS |
2108 | The major mode used is Fundamental mode regardless of the file name, |
2109 | and local variable specifications in the file are ignored. | |
407b4328 GM |
2110 | Automatic uncompression and adding a newline at the end of the |
2111 | file due to `require-final-newline' is also disabled. | |
9b8ef27d RS |
2112 | |
2113 | You cannot absolutely rely on this function to result in | |
b9aa9537 | 2114 | visiting the file literally. If Emacs already has a buffer |
9b8ef27d RS |
2115 | which is visiting the file, you get the existing buffer, |
2116 | regardless of whether it was created literally or not. | |
2117 | ||
2118 | In a Lisp program, if you want to be sure of accessing a file's | |
2119 | contents literally, you should create a temporary buffer and then read | |
2120 | the file contents into it using `insert-file-contents-literally'." | |
7d371eac JL |
2121 | (interactive |
2122 | (list (read-file-name | |
2123 | "Find file literally: " nil default-directory | |
2124 | (confirm-nonexistent-file-or-buffer)))) | |
9b8ef27d | 2125 | (switch-to-buffer (find-file-noselect filename nil t))) |
b4da00e9 | 2126 | \f |
e0ab8879 | 2127 | (defun after-find-file (&optional error warn noauto |
3e214b50 | 2128 | _after-find-file-from-revert-buffer |
9a30563f | 2129 | nomodes) |
b4da00e9 RM |
2130 | "Called after finding a file and by the default revert function. |
2131 | Sets buffer mode, parses local variables. | |
8cfb9d46 | 2132 | Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an |
b4da00e9 RM |
2133 | error in reading the file. WARN non-nil means warn if there |
2134 | exists an auto-save file more recent than the visited file. | |
8cfb9d46 | 2135 | NOAUTO means don't mess with auto-save mode. |
3e214b50 JB |
2136 | Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored |
2137 | \(see `revert-buffer-in-progress-p' for similar functionality). | |
9a30563f | 2138 | Fifth arg NOMODES non-nil means don't alter the file's modes. |
0370fe77 | 2139 | Finishes by calling the functions in `find-file-hook' |
9a30563f | 2140 | unless NOMODES is non-nil." |
b4da00e9 RM |
2141 | (setq buffer-read-only (not (file-writable-p buffer-file-name))) |
2142 | (if noninteractive | |
2143 | nil | |
2144 | (let* (not-serious | |
2145 | (msg | |
fe50b6ab GM |
2146 | (cond |
2147 | ((not warn) nil) | |
2148 | ((and error (file-attributes buffer-file-name)) | |
2149 | (setq buffer-read-only t) | |
7152b011 | 2150 | (if (and (file-symlink-p buffer-file-name) |
86ec63ba PE |
2151 | (not (file-exists-p |
2152 | (file-chase-links buffer-file-name)))) | |
7152b011 LMI |
2153 | "Symbolic link that points to nonexistent file" |
2154 | "File exists, but cannot be read")) | |
fe50b6ab GM |
2155 | ((not buffer-read-only) |
2156 | (if (and warn | |
2157 | ;; No need to warn if buffer is auto-saved | |
2158 | ;; under the name of the visited file. | |
2159 | (not (and buffer-file-name | |
2160 | auto-save-visited-file-name)) | |
2161 | (file-newer-than-file-p (or buffer-auto-save-file-name | |
2162 | (make-auto-save-file-name)) | |
2163 | buffer-file-name)) | |
64d18e8f | 2164 | (format "%s has auto save data; consider M-x recover-this-file" |
fe50b6ab GM |
2165 | (file-name-nondirectory buffer-file-name)) |
2166 | (setq not-serious t) | |
2167 | (if error "(New file)" nil))) | |
2168 | ((not error) | |
2169 | (setq not-serious t) | |
2170 | "Note: file is write protected") | |
2171 | ((file-attributes (directory-file-name default-directory)) | |
2172 | "File not found and directory write-protected") | |
2173 | ((file-exists-p (file-name-directory buffer-file-name)) | |
2174 | (setq buffer-read-only nil)) | |
2175 | (t | |
2176 | (setq buffer-read-only nil) | |
07703430 | 2177 | "Use M-x make-directory RET RET to create the directory and its parents")))) |
fe50b6ab | 2178 | (when msg |
a74357d4 | 2179 | (message "%s" msg) |
e09f3bff | 2180 | (or not-serious (sit-for 1 t)))) |
fe50b6ab | 2181 | (when (and auto-save-default (not noauto)) |
06b60517 | 2182 | (auto-save-mode 1))) |
ffc0e1ca AS |
2183 | ;; Make people do a little extra work (C-x C-q) |
2184 | ;; before altering a backup file. | |
fe50b6ab GM |
2185 | (when (backup-file-name-p buffer-file-name) |
2186 | (setq buffer-read-only t)) | |
8fd9c174 RS |
2187 | ;; When a file is marked read-only, |
2188 | ;; make the buffer read-only even if root is looking at it. | |
879365c6 KS |
2189 | (when (and (file-modes (buffer-file-name)) |
2190 | (zerop (logand (file-modes (buffer-file-name)) #o222))) | |
8fd9c174 | 2191 | (setq buffer-read-only t)) |
fe50b6ab GM |
2192 | (unless nomodes |
2193 | (when (and view-read-only view-mode) | |
4a74c818 | 2194 | (view-mode -1)) |
9a30563f | 2195 | (normal-mode t) |
f4206092 RS |
2196 | ;; If requested, add a newline at the end of the file. |
2197 | (and (memq require-final-newline '(visit visit-save)) | |
2198 | (> (point-max) (point-min)) | |
2199 | (/= (char-after (1- (point-max))) ?\n) | |
2200 | (not (and (eq selective-display t) | |
2201 | (= (char-after (1- (point-max))) ?\r))) | |
c09c46b2 | 2202 | (not buffer-read-only) |
f4206092 RS |
2203 | (save-excursion |
2204 | (goto-char (point-max)) | |
0d7eb2ea | 2205 | (ignore-errors (insert "\n")))) |
fe50b6ab GM |
2206 | (when (and buffer-read-only |
2207 | view-read-only | |
2208 | (not (eq (get major-mode 'mode-class) 'special))) | |
2209 | (view-mode-enter)) | |
0370fe77 | 2210 | (run-hooks 'find-file-hook))) |
b4da00e9 | 2211 | |
818286f4 SM |
2212 | (defmacro report-errors (format &rest body) |
2213 | "Eval BODY and turn any error into a FORMAT message. | |
2214 | FORMAT can have a %s escape which will be replaced with the actual error. | |
2215 | If `debug-on-error' is set, errors are not caught, so that you can | |
2216 | debug them. | |
2217 | Avoid using a large BODY since it is duplicated." | |
2218 | (declare (debug t) (indent 1)) | |
2219 | `(if debug-on-error | |
2220 | (progn . ,body) | |
2221 | (condition-case err | |
2222 | (progn . ,body) | |
2223 | (error (message ,format (prin1-to-string err)))))) | |
2224 | ||
b4da00e9 RM |
2225 | (defun normal-mode (&optional find-file) |
2226 | "Choose the major mode for this buffer automatically. | |
2227 | Also sets up any specified local variables of the file. | |
2228 | Uses the visited file name, the -*- line, and the local variables spec. | |
2229 | ||
2230 | This function is called automatically from `find-file'. In that case, | |
aa5fcebf | 2231 | we may set up the file-specified mode and local variables, |
a5ce12c3 | 2232 | depending on the value of `enable-local-variables'. |
aa5fcebf KH |
2233 | In addition, if `local-enable-local-variables' is nil, we do |
2234 | not set local variables (though we do notice a mode specified with -*-.) | |
2235 | ||
2236 | `enable-local-variables' is ignored if you run `normal-mode' interactively, | |
2237 | or from Lisp without specifying the optional argument FIND-FILE; | |
2238 | in that case, this function acts as if `enable-local-variables' were t." | |
b4da00e9 | 2239 | (interactive) |
91e8293c | 2240 | (fundamental-mode) |
0fc205c6 | 2241 | (let ((enable-local-variables (or (not find-file) enable-local-variables))) |
e145f188 GM |
2242 | ;; FIXME this is less efficient than it could be, since both |
2243 | ;; s-a-m and h-l-v may parse the same regions, looking for "mode:". | |
0fc205c6 LT |
2244 | (report-errors "File mode specification error: %s" |
2245 | (set-auto-mode)) | |
2246 | (report-errors "File local-variables error: %s" | |
818286f4 | 2247 | (hack-local-variables))) |
6e86be0b RS |
2248 | ;; Turn font lock off and on, to make sure it takes account of |
2249 | ;; whatever file local variables are relevant to it. | |
344f1111 SM |
2250 | (when (and font-lock-mode |
2251 | ;; Font-lock-mode (now in font-core.el) can be ON when | |
2252 | ;; font-lock.el still hasn't been loaded. | |
2253 | (boundp 'font-lock-keywords) | |
2254 | (eq (car font-lock-keywords) t)) | |
6e86be0b | 2255 | (setq font-lock-keywords (cadr font-lock-keywords)) |
fd06db5d | 2256 | (font-lock-mode 1))) |
b4da00e9 | 2257 | |
2372f278 | 2258 | (defcustom auto-mode-case-fold t |
94495713 KS |
2259 | "Non-nil means to try second pass through `auto-mode-alist'. |
2260 | This means that if the first case-sensitive search through the alist fails | |
2261 | to find a matching major mode, a second case-insensitive search is made. | |
2262 | On systems with case-insensitive file names, this variable is ignored, | |
bb178aaa | 2263 | since only a single case-insensitive search through the alist is made." |
94495713 KS |
2264 | :group 'files |
2265 | :version "22.1" | |
2266 | :type 'boolean) | |
2267 | ||
f76e0cd0 | 2268 | (defvar auto-mode-alist |
f209c999 MS |
2269 | ;; Note: The entries for the modes defined in cc-mode.el (c-mode, |
2270 | ;; c++-mode, java-mode and more) are added through autoload | |
2271 | ;; directives in that file. That way is discouraged since it | |
2272 | ;; spreads out the definition of the initial value. | |
4aaffda1 | 2273 | (mapcar |
e8e4d5c8 SS |
2274 | (lambda (elt) |
2275 | (cons (purecopy (car elt)) (cdr elt))) | |
813731b3 | 2276 | `(;; do this first, so that .html.pl is Polish html, not Perl |
1e5d2a04 | 2277 | ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode) |
5e339ee2 GM |
2278 | ("\\.svgz?\\'" . image-mode) |
2279 | ("\\.svgz?\\'" . xml-mode) | |
2280 | ("\\.x[bp]m\\'" . image-mode) | |
2281 | ("\\.x[bp]m\\'" . c-mode) | |
2282 | ("\\.p[bpgn]m\\'" . image-mode) | |
2283 | ("\\.tiff?\\'" . image-mode) | |
2284 | ("\\.gif\\'" . image-mode) | |
2285 | ("\\.png\\'" . image-mode) | |
2286 | ("\\.jpe?g\\'" . image-mode) | |
9e6f5419 | 2287 | ("\\.te?xt\\'" . text-mode) |
bbc67516 | 2288 | ("\\.[tT]e[xX]\\'" . tex-mode) |
4e163715 | 2289 | ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages. |
ffc0e1ca | 2290 | ("\\.ltx\\'" . latex-mode) |
4e163715 | 2291 | ("\\.dtx\\'" . doctex-mode) |
18d8cb81 | 2292 | ("\\.org\\'" . org-mode) |
ffc0e1ca | 2293 | ("\\.el\\'" . emacs-lisp-mode) |
e6e267fc | 2294 | ("Project\\.ede\\'" . emacs-lisp-mode) |
21575d92 | 2295 | ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode) |
ffc0e1ca | 2296 | ("\\.l\\'" . lisp-mode) |
bbc67516 DP |
2297 | ("\\.li?sp\\'" . lisp-mode) |
2298 | ("\\.[fF]\\'" . fortran-mode) | |
ffc0e1ca AS |
2299 | ("\\.for\\'" . fortran-mode) |
2300 | ("\\.p\\'" . pascal-mode) | |
2301 | ("\\.pas\\'" . pascal-mode) | |
448ecec3 | 2302 | ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode) |
ffc0e1ca | 2303 | ("\\.ad[abs]\\'" . ada-mode) |
7defe888 | 2304 | ("\\.ad[bs].dg\\'" . ada-mode) |
bbc67516 | 2305 | ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode) |
3968c89f | 2306 | ("Imakefile\\'" . makefile-imake-mode) |
8088bb2c DP |
2307 | ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk |
2308 | ("\\.makepp\\'" . makefile-makepp-mode) | |
2ddf2ea6 | 2309 | ,@(if (memq system-type '(berkeley-unix darwin)) |
813731b3 | 2310 | '(("\\.mk\\'" . makefile-bsdmake-mode) |
ad89bb83 | 2311 | ("\\.make\\'" . makefile-bsdmake-mode) |
47d4e709 | 2312 | ("GNUmakefile\\'" . makefile-gmake-mode) |
813731b3 DP |
2313 | ("[Mm]akefile\\'" . makefile-bsdmake-mode)) |
2314 | '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage | |
ad89bb83 | 2315 | ("\\.make\\'" . makefile-gmake-mode) |
47d4e709 | 2316 | ("[Mm]akefile\\'" . makefile-gmake-mode))) |
27a7c83f | 2317 | ("\\.am\\'" . makefile-automake-mode) |
5c6d31a4 SM |
2318 | ;; Less common extensions come here |
2319 | ;; so more common ones above are found faster. | |
ffc0e1ca AS |
2320 | ("\\.texinfo\\'" . texinfo-mode) |
2321 | ("\\.te?xi\\'" . texinfo-mode) | |
bbc67516 | 2322 | ("\\.[sS]\\'" . asm-mode) |
ffc0e1ca | 2323 | ("\\.asm\\'" . asm-mode) |
5e339ee2 GM |
2324 | ("\\.css\\'" . css-mode) |
2325 | ("\\.mixal\\'" . mixal-mode) | |
2326 | ("\\.gcov\\'" . compilation-mode) | |
2327 | ;; Besides .gdbinit, gdb documents other names to be usable for init | |
2328 | ;; files, cross-debuggers can use something like | |
2329 | ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files | |
2330 | ;; don't interfere with each other. | |
2331 | ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode) | |
75d83e22 EZ |
2332 | ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file |
2333 | ;; named 'emacs-gdb.gdb', if it exists, will be automatically | |
2334 | ;; loaded when GDB reads an objfile called 'emacs'. | |
2335 | ("-gdb\\.gdb" . gdb-script-mode) | |
bbc67516 | 2336 | ("[cC]hange\\.?[lL]og?\\'" . change-log-mode) |
40656849 | 2337 | ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode) |
ffc0e1ca AS |
2338 | ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode) |
2339 | ("\\.scm\\.[0-9]*\\'" . scheme-mode) | |
2340 | ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode) | |
b921b596 | 2341 | ("\\.bash\\'" . sh-mode) |
2d85dc34 GM |
2342 | ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode) |
2343 | ("\\(/\\|\\`\\)\\.\\(shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode) | |
ffc0e1ca | 2344 | ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode) |
d5798fa7 | 2345 | ("\\.m?spec\\'" . sh-mode) |
bbc67516 | 2346 | ("\\.m[mes]\\'" . nroff-mode) |
ffc0e1ca | 2347 | ("\\.man\\'" . nroff-mode) |
ffc0e1ca | 2348 | ("\\.sty\\'" . latex-mode) |
bbc67516 | 2349 | ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option |
ffc0e1ca AS |
2350 | ("\\.bbl\\'" . latex-mode) |
2351 | ("\\.bib\\'" . bibtex-mode) | |
5e339ee2 | 2352 | ("\\.bst\\'" . bibtex-style-mode) |
ffc0e1ca | 2353 | ("\\.sql\\'" . sql-mode) |
bbc67516 | 2354 | ("\\.m[4c]\\'" . m4-mode) |
ffc0e1ca AS |
2355 | ("\\.mf\\'" . metafont-mode) |
2356 | ("\\.mp\\'" . metapost-mode) | |
2357 | ("\\.vhdl?\\'" . vhdl-mode) | |
2358 | ("\\.article\\'" . text-mode) | |
2359 | ("\\.letter\\'" . text-mode) | |
bbc67516 | 2360 | ("\\.i?tcl\\'" . tcl-mode) |
ffc0e1ca | 2361 | ("\\.exp\\'" . tcl-mode) |
ffc0e1ca AS |
2362 | ("\\.itk\\'" . tcl-mode) |
2363 | ("\\.icn\\'" . icon-mode) | |
2364 | ("\\.sim\\'" . simula-mode) | |
2365 | ("\\.mss\\'" . scribe-mode) | |
faf2a174 GM |
2366 | ;; The Fortran standard does not say anything about file extensions. |
2367 | ;; .f90 was widely used for F90, now we seem to be trapped into | |
2368 | ;; using a different extension for each language revision. | |
2369 | ;; Anyway, the following extensions are supported by gfortran. | |
bbc67516 | 2370 | ("\\.f9[05]\\'" . f90-mode) |
faf2a174 | 2371 | ("\\.f0[38]\\'" . f90-mode) |
8f9495e7 | 2372 | ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode |
4998f839 | 2373 | ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode) |
e6e267fc | 2374 | ("\\.srt\\'" . srecode-template-mode) |
ffc0e1ca AS |
2375 | ("\\.prolog\\'" . prolog-mode) |
2376 | ("\\.tar\\'" . tar-mode) | |
0ee6e7b7 JL |
2377 | ;; The list of archive file extensions should be in sync with |
2378 | ;; `auto-coding-alist' with `no-conversion' coding system. | |
e7988f09 | 2379 | ("\\.\\(\ |
b3671a51 JL |
2380 | arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\ |
2381 | ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode) | |
fc7f4d7e | 2382 | ("\\.oxt\\'" . archive-mode) ;(Open|Libre)Office extensions. |
ccb012c5 | 2383 | ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages. |
ffc0e1ca AS |
2384 | ;; Mailer puts message to be edited in |
2385 | ;; /tmp/Re.... or Message | |
2386 | ("\\`/tmp/Re" . text-mode) | |
2387 | ("/Message[0-9]*\\'" . text-mode) | |
ffc0e1ca AS |
2388 | ;; some news reader is reported to use this |
2389 | ("\\`/tmp/fol/" . text-mode) | |
ffc0e1ca AS |
2390 | ("\\.oak\\'" . scheme-mode) |
2391 | ("\\.sgml?\\'" . sgml-mode) | |
e477ca84 | 2392 | ("\\.x[ms]l\\'" . xml-mode) |
11cb1e35 | 2393 | ("\\.dbk\\'" . xml-mode) |
ffc0e1ca AS |
2394 | ("\\.dtd\\'" . sgml-mode) |
2395 | ("\\.ds\\(ss\\)?l\\'" . dsssl-mode) | |
5055880d LL |
2396 | ("\\.js\\'" . javascript-mode) |
2397 | ("\\.json\\'" . javascript-mode) | |
855a2294 | 2398 | ("\\.[ds]?vh?\\'" . verilog-mode) |
9414dd8d CY |
2399 | ("\\.by\\'" . bovine-grammar-mode) |
2400 | ("\\.wy\\'" . wisent-grammar-mode) | |
709d45e1 KG |
2401 | ;; .emacs or .gnus or .viper following a directory delimiter in |
2402 | ;; Unix, MSDOG or VMS syntax. | |
2403 | ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode) | |
ffc0e1ca AS |
2404 | ("\\`\\..*emacs\\'" . emacs-lisp-mode) |
2405 | ;; _emacs following a directory delimiter | |
2406 | ;; in MsDos syntax | |
2407 | ("[:/]_emacs\\'" . emacs-lisp-mode) | |
2408 | ("/crontab\\.X*[0-9]+\\'" . shell-script-mode) | |
2409 | ("\\.ml\\'" . lisp-mode) | |
ce009d0b GM |
2410 | ;; Linux-2.6.9 uses some different suffix for linker scripts: |
2411 | ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo". | |
2412 | ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*". | |
2413 | ("\\.ld[si]?\\'" . ld-script-mode) | |
2414 | ("ld\\.?script\\'" . ld-script-mode) | |
54238e6d GM |
2415 | ;; .xs is also used for ld scripts, but seems to be more commonly |
2416 | ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071) | |
2417 | ("\\.xs\\'" . c-mode) | |
19543b17 GM |
2418 | ;; Explained in binutils ld/genscripts.sh. Eg: |
2419 | ;; A .x script file is the default script. | |
2420 | ;; A .xr script is for linking without relocation (-r flag). Etc. | |
2421 | ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode) | |
5e339ee2 GM |
2422 | ("\\.zone\\'" . dns-mode) |
2423 | ("\\.soa\\'" . dns-mode) | |
ebbcece3 GM |
2424 | ;; Common Lisp ASDF package system. |
2425 | ("\\.asd\\'" . lisp-mode) | |
d5798fa7 SM |
2426 | ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode) |
2427 | ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode) | |
ffc0e1ca | 2428 | ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode) |
e854cc22 | 2429 | ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG |
9a905782 | 2430 | ("\\.[eE]?[pP][sS]\\'" . ps-mode) |
72781fef | 2431 | ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe) |
e55c4863 | 2432 | ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode) |
8a28dd0b | 2433 | ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode) |
ffc0e1ca AS |
2434 | ("BROWSE\\'" . ebrowse-tree-mode) |
2435 | ("\\.ebrowse\\'" . ebrowse-tree-mode) | |
9ee45b2c | 2436 | ("#\\*mail\\*" . mail-mode) |
80174d35 | 2437 | ("\\.g\\'" . antlr-mode) |
56f9dcc9 | 2438 | ("\\.mod\\'" . m2-mode) |
80174d35 | 2439 | ("\\.ses\\'" . ses-mode) |
80174d35 | 2440 | ("\\.docbook\\'" . sgml-mode) |
00daa381 | 2441 | ("\\.com\\'" . dcl-mode) |
80174d35 DP |
2442 | ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode) |
2443 | ;; Windows candidates may be opened case sensitively on Unix | |
2444 | ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode) | |
2445 | ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode) | |
08adf84e | 2446 | ("\\.ppd\\'" . conf-ppd-mode) |
80174d35 DP |
2447 | ("java.+\\.conf\\'" . conf-javaprop-mode) |
2448 | ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode) | |
a35d9075 AS |
2449 | ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode) |
2450 | ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode) | |
40656849 CY |
2451 | ;; ChangeLog.old etc. Other change-log-mode entries are above; |
2452 | ;; this has lower priority to avoid matching changelog.sgml etc. | |
2453 | ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode) | |
80174d35 DP |
2454 | ;; either user's dot-files or under /etc or some such |
2455 | ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode) | |
2456 | ;; alas not all ~/.*rc files are like this | |
b14f1885 | 2457 | ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode) |
80174d35 DP |
2458 | ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode) |
2459 | ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode) | |
2460 | ("/X11.+app-defaults/" . conf-xdefaults-mode) | |
2461 | ("/X11.+locale/.+/Compose\\'" . conf-colon-mode) | |
2462 | ;; this contains everything twice, with space and with colon :-( | |
2463 | ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode) | |
9ee45b2c SM |
2464 | ;; Get rid of any trailing .n.m and try again. |
2465 | ;; This is for files saved by cvs-merge that look like .#<file>.<rev> | |
5c6d31a4 SM |
2466 | ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~. |
2467 | ;; Using mode nil rather than `ignore' would let the search continue | |
2468 | ;; through this list (with the shortened name) rather than start over. | |
bbc67516 | 2469 | ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t) |
5d344e88 CY |
2470 | ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t) |
2471 | ;; This should come after "in" stripping (e.g. config.h.in). | |
2472 | ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config | |
2473 | ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe) | |
5c6d31a4 SM |
2474 | ;; The following should come after the ChangeLog pattern |
2475 | ;; for the sake of ChangeLog.1, etc. | |
2476 | ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too. | |
5d344e88 | 2477 | ("\\.[1-9]\\'" . nroff-mode))) |
ffc0e1ca | 2478 | "Alist of filename patterns vs corresponding major mode functions. |
116987ba RS |
2479 | Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL). |
2480 | \(NON-NIL stands for anything that is not nil; the value does not matter.) | |
2481 | Visiting a file whose name matches REGEXP specifies FUNCTION as the | |
2482 | mode function to use. FUNCTION will be called, unless it is nil. | |
2483 | ||
2484 | If the element has the form (REGEXP FUNCTION NON-NIL), then after | |
2485 | calling FUNCTION (if it's not nil), we delete the suffix that matched | |
969be033 | 2486 | REGEXP and search the list again for another match. |
7b3f3dc2 | 2487 | |
d5040404 EZ |
2488 | The extensions whose FUNCTION is `archive-mode' should also |
2489 | appear in `auto-coding-alist' with `no-conversion' coding system. | |
2490 | ||
969be033 RS |
2491 | See also `interpreter-mode-alist', which detects executable script modes |
2492 | based on the interpreters they specify to run, | |
2493 | and `magic-mode-alist', which determines modes based on file contents.") | |
3029e594 | 2494 | (put 'auto-mode-alist 'risky-local-variable t) |
e13322a0 | 2495 | |
73936494 RS |
2496 | (defun conf-mode-maybe () |
2497 | "Select Conf mode or XML mode according to start of file." | |
2498 | (if (save-excursion | |
2499 | (save-restriction | |
2500 | (widen) | |
2501 | (goto-char (point-min)) | |
2502 | (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE "))) | |
e477ca84 | 2503 | (xml-mode) |
73936494 RS |
2504 | (conf-mode))) |
2505 | ||
d7fa5aa2 | 2506 | (defvar interpreter-mode-alist |
f209c999 MS |
2507 | ;; Note: The entries for the modes defined in cc-mode.el (awk-mode |
2508 | ;; and pike-mode) are added through autoload directives in that | |
2509 | ;; file. That way is discouraged since it spreads out the | |
2510 | ;; definition of the initial value. | |
a7610c52 | 2511 | (mapcar |
e8e4d5c8 SS |
2512 | (lambda (l) |
2513 | (cons (purecopy (car l)) (cdr l))) | |
2a08047a GM |
2514 | '(("\\(mini\\)?perl5?" . perl-mode) |
2515 | ("wishx?" . tcl-mode) | |
2516 | ("tcl\\(sh\\)?" . tcl-mode) | |
2517 | ("expect" . tcl-mode) | |
7186ba60 | 2518 | ("octave" . octave-mode) |
2a08047a GM |
2519 | ("scm" . scheme-mode) |
2520 | ("[acjkwz]sh" . sh-mode) | |
2521 | ("r?bash2?" . sh-mode) | |
bd2d43dc | 2522 | ("dash" . sh-mode) |
2a08047a GM |
2523 | ("\\(dt\\|pd\\|w\\)ksh" . sh-mode) |
2524 | ("es" . sh-mode) | |
2525 | ("i?tcsh" . sh-mode) | |
2526 | ("oash" . sh-mode) | |
2527 | ("rc" . sh-mode) | |
2528 | ("rpm" . sh-mode) | |
2529 | ("sh5?" . sh-mode) | |
2530 | ("tail" . text-mode) | |
2531 | ("more" . text-mode) | |
2532 | ("less" . text-mode) | |
2533 | ("pg" . text-mode) | |
2534 | ("make" . makefile-gmake-mode) ; Debian uses this | |
2535 | ("guile" . scheme-mode) | |
2536 | ("clisp" . lisp-mode) | |
2537 | ("emacs" . emacs-lisp-mode))) | |
c907d156 | 2538 | "Alist mapping interpreter names to major modes. |
969be033 | 2539 | This is used for files whose first lines match `auto-mode-interpreter-regexp'. |
1af4c220 | 2540 | Each element looks like (REGEXP . MODE). |
2a08047a GM |
2541 | If \\\\`REGEXP\\\\' matches the name (minus any directory part) of |
2542 | the interpreter specified in the first line of a script, enable | |
2543 | major mode MODE. | |
969be033 RS |
2544 | |
2545 | See also `auto-mode-alist'.") | |
c907d156 | 2546 | |
7b447e9b GM |
2547 | (define-obsolete-variable-alias 'inhibit-first-line-modes-regexps |
2548 | 'inhibit-file-local-variables-regexps "24.1") | |
2549 | ||
2550 | ;; TODO really this should be a list of modes (eg tar-mode), not regexps, | |
2551 | ;; because we are duplicating info from auto-mode-alist. | |
2552 | ;; TODO many elements of this list are also in auto-coding-alist. | |
2553 | (defvar inhibit-local-variables-regexps | |
2554 | (mapcar 'purecopy '("\\.tar\\'" "\\.t[bg]z\\'" | |
2555 | "\\.arc\\'" "\\.zip\\'" "\\.lzh\\'" "\\.lha\\'" | |
2556 | "\\.zoo\\'" "\\.[jew]ar\\'" "\\.xpi\\'" "\\.rar\\'" | |
2557 | "\\.7z\\'" | |
2558 | "\\.sx[dmicw]\\'" "\\.odt\\'" | |
cb05411f | 2559 | "\\.diff\\'" "\\.patch\\'" |
7b447e9b GM |
2560 | "\\.tiff?\\'" "\\.gif\\'" "\\.png\\'" "\\.jpe?g\\'")) |
2561 | "List of regexps matching file names in which to ignore local variables. | |
2562 | This includes `-*-' lines as well as trailing \"Local Variables\" sections. | |
2563 | Files matching this list are typically binary file formats. | |
2564 | They may happen to contain sequences that look like local variable | |
2565 | specifications, but are not really, or they may be containers for | |
2566 | member files with their own local variable sections, which are | |
2567 | not appropriate for the containing file. | |
e9df8f87 | 2568 | The function `inhibit-local-variables-p' uses this.") |
7b447e9b GM |
2569 | |
2570 | (define-obsolete-variable-alias 'inhibit-first-line-modes-suffixes | |
2571 | 'inhibit-local-variables-suffixes "24.1") | |
2572 | ||
2573 | (defvar inhibit-local-variables-suffixes nil | |
2574 | "List of regexps matching suffixes to remove from file names. | |
e9df8f87 GM |
2575 | The function `inhibit-local-variables-p' uses this: when checking |
2576 | a file name, it first discards from the end of the name anything that | |
2577 | matches one of these regexps.") | |
2578 | ||
2579 | ;; Can't think of any situation in which you'd want this to be nil... | |
2580 | (defvar inhibit-local-variables-ignore-case t | |
2581 | "Non-nil means `inhibit-local-variables-p' ignores case.") | |
b20ff6d0 | 2582 | |
7b447e9b GM |
2583 | (defun inhibit-local-variables-p () |
2584 | "Return non-nil if file local variables should be ignored. | |
2585 | This checks the file (or buffer) name against `inhibit-local-variables-regexps' | |
e9df8f87 GM |
2586 | and `inhibit-local-variables-suffixes'. If |
2587 | `inhibit-local-variables-ignore-case' is non-nil, this ignores case." | |
7b447e9b GM |
2588 | (let ((temp inhibit-local-variables-regexps) |
2589 | (name (if buffer-file-name | |
2590 | (file-name-sans-versions buffer-file-name) | |
e9df8f87 GM |
2591 | (buffer-name))) |
2592 | (case-fold-search inhibit-local-variables-ignore-case)) | |
7b447e9b GM |
2593 | (while (let ((sufs inhibit-local-variables-suffixes)) |
2594 | (while (and sufs (not (string-match (car sufs) name))) | |
2595 | (setq sufs (cdr sufs))) | |
2596 | sufs) | |
2597 | (setq name (substring name 0 (match-beginning 0)))) | |
2598 | (while (and temp | |
2599 | (not (string-match (car temp) name))) | |
2600 | (setq temp (cdr temp))) | |
2601 | temp)) | |
2602 | ||
ffc0e1ca | 2603 | (defvar auto-mode-interpreter-regexp |
1e8780b1 DN |
2604 | (purecopy "#![ \t]?\\([^ \t\n]*\ |
2605 | /bin/env[ \t]\\)?\\([^ \t\n]+\\)") | |
54005870 | 2606 | "Regexp matching interpreters, for file mode determination. |
ffc0e1ca | 2607 | This regular expression is matched against the first line of a file |
54005870 LT |
2608 | to determine the file's mode in `set-auto-mode'. If it matches, the file |
2609 | is assumed to be interpreted by the interpreter matched by the second group | |
2610 | of the regular expression. The mode is then determined as the mode | |
2611 | associated with that interpreter in `interpreter-mode-alist'.") | |
0720b68b | 2612 | |
1a5bfb0e | 2613 | (defvar magic-mode-alist nil |
c11781de SM |
2614 | "Alist of buffer beginnings vs. corresponding major mode functions. |
2615 | Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION). | |
2616 | After visiting a file, if REGEXP matches the text at the beginning of the | |
2617 | buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will | |
2618 | call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's | |
2619 | major mode. | |
2620 | ||
2621 | If FUNCTION is nil, then it is not called. (That is a way of saying | |
2622 | \"allow `auto-mode-alist' to decide for these files.\")") | |
2623 | (put 'magic-mode-alist 'risky-local-variable t) | |
2624 | ||
2625 | (defvar magic-fallback-mode-alist | |
1e8780b1 | 2626 | (purecopy |
1a5bfb0e | 2627 | `((image-type-auto-detected-p . image-mode) |
e15f58f8 | 2628 | ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip |
1a5bfb0e | 2629 | ;; The < comes before the groups (but the first) to reduce backtracking. |
4ac1d37a | 2630 | ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff. |
efaa82ff | 2631 | ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely. |
32a0479a | 2632 | (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
efaa82ff GM |
2633 | (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
2634 | (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<" | |
32a0479a | 2635 | comment-re "*" |
efaa82ff | 2636 | "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?" |
969be033 RS |
2637 | "[Hh][Tt][Mm][Ll]")) |
2638 | . html-mode) | |
815fde34 | 2639 | ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode) |
4ac1d37a | 2640 | ;; These two must come after html, because they are more general: |
e477ca84 | 2641 | ("<\\?xml " . xml-mode) |
811cab86 | 2642 | (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
e7d313a0 GM |
2643 | (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
2644 | (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE ")) | |
969be033 | 2645 | . sgml-mode) |
12333e2b | 2646 | ("%!PS" . ps-mode) |
1e8780b1 | 2647 | ("# xmcd " . conf-unix-mode))) |
14774875 RS |
2648 | "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'. |
2649 | Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION). | |
2650 | After visiting a file, if REGEXP matches the text at the beginning of the | |
2651 | buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will | |
2652 | call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist' | |
2653 | have not specified a mode for this file. | |
2654 | ||
2655 | If FUNCTION is nil, then it is not called.") | |
92228a10 | 2656 | (put 'magic-fallback-mode-alist 'risky-local-variable t) |
14774875 | 2657 | |
5cce080e | 2658 | (defvar magic-mode-regexp-match-limit 4000 |
14774875 | 2659 | "Upper limit on `magic-mode-alist' regexp matches. |
92228a10 | 2660 | Also applies to `magic-fallback-mode-alist'.") |
5cce080e | 2661 | |
9e6f5419 | 2662 | (defun set-auto-mode (&optional keep-mode-if-same) |
b4da00e9 | 2663 | "Select major mode appropriate for current buffer. |
4ac1d37a | 2664 | |
f3860cea | 2665 | To find the right major mode, this function checks for a -*- mode tag |
e145f188 | 2666 | checks for a `mode:' entry in the Local Variables section of the file, |
c022c4c4 RS |
2667 | checks if it uses an interpreter listed in `interpreter-mode-alist', |
2668 | matches the buffer beginning against `magic-mode-alist', | |
2669 | compares the filename against the entries in `auto-mode-alist', | |
2670 | then matches the buffer beginning against `magic-fallback-mode-alist'. | |
e3998da1 | 2671 | |
7b447e9b GM |
2672 | If `enable-local-variables' is nil, or if the file name matches |
2673 | `inhibit-local-variables-regexps', this function does not check | |
2674 | for any mode: tag anywhere in the file. If `local-enable-local-variables' | |
2675 | is nil, then the only mode: tag that can be relevant is a -*- one. | |
9de9b6a2 | 2676 | |
521cf174 | 2677 | If the optional argument KEEP-MODE-IF-SAME is non-nil, then we |
c022c4c4 RS |
2678 | set the major mode only if that would change it. In other words |
2679 | we don't actually set it to the same mode the buffer already has." | |
b4da00e9 | 2680 | ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*- |
7b447e9b GM |
2681 | (let ((try-locals (not (inhibit-local-variables-p))) |
2682 | end done mode modes) | |
e145f188 | 2683 | ;; Once we drop the deprecated feature where mode: is also allowed to |
f0da764a | 2684 | ;; specify minor-modes (ie, there can be more than one "mode:"), we can |
e145f188 GM |
2685 | ;; remove this section and just let (hack-local-variables t) handle it. |
2686 | ;; Find a -*- mode tag. | |
b4da00e9 RM |
2687 | (save-excursion |
2688 | (goto-char (point-min)) | |
2689 | (skip-chars-forward " \t\n") | |
7b447e9b | 2690 | ;; Note by design local-enable-local-variables does not matter here. |
9fa7bfe5 | 2691 | (and enable-local-variables |
7b447e9b | 2692 | try-locals |
e3f9b9c0 | 2693 | (setq end (set-auto-mode-1)) |
2d2ab9da RS |
2694 | (if (save-excursion (search-forward ":" end t)) |
2695 | ;; Find all specifications for the `mode:' variable | |
2696 | ;; and execute them left to right. | |
2697 | (while (let ((case-fold-search t)) | |
2698 | (or (and (looking-at "mode:") | |
2699 | (goto-char (match-end 0))) | |
2700 | (re-search-forward "[ \t;]mode:" end t))) | |
2701 | (skip-chars-forward " \t") | |
2702 | (let ((beg (point))) | |
9fa7bfe5 RS |
2703 | (if (search-forward ";" end t) |
2704 | (forward-char -1) | |
2705 | (goto-char end)) | |
2706 | (skip-chars-backward " \t") | |
9ee45b2c | 2707 | (push (intern (concat (downcase (buffer-substring beg (point))) "-mode")) |
2d2ab9da RS |
2708 | modes))) |
2709 | ;; Simple -*-MODE-*- case. | |
2710 | (push (intern (concat (downcase (buffer-substring (point) end)) | |
2711 | "-mode")) | |
2712 | modes)))) | |
9e6f5419 DP |
2713 | ;; If we found modes to use, invoke them now, outside the save-excursion. |
2714 | (if modes | |
521cf174 DP |
2715 | (catch 'nop |
2716 | (dolist (mode (nreverse modes)) | |
2717 | (if (not (functionp mode)) | |
2718 | (message "Ignoring unknown mode `%s'" mode) | |
2719 | (setq done t) | |
3467488e | 2720 | (or (set-auto-mode-0 mode keep-mode-if-same) |
df4d0613 | 2721 | ;; continuing would call minor modes again, toggling them off |
ec6328a2 | 2722 | (throw 'nop nil)))))) |
7b447e9b GM |
2723 | ;; hack-local-variables checks local-enable-local-variables etc, but |
2724 | ;; we might as well be explicit here for the sake of clarity. | |
e145f188 GM |
2725 | (and (not done) |
2726 | enable-local-variables | |
7b447e9b GM |
2727 | local-enable-local-variables |
2728 | try-locals | |
e145f188 GM |
2729 | (setq mode (hack-local-variables t)) |
2730 | (not (memq mode modes)) ; already tried and failed | |
2731 | (if (not (functionp mode)) | |
2732 | (message "Ignoring unknown mode `%s'" mode) | |
2733 | (setq done t) | |
2734 | (set-auto-mode-0 mode keep-mode-if-same))) | |
14774875 RS |
2735 | ;; If we didn't, look for an interpreter specified in the first line. |
2736 | ;; As a special case, allow for things like "#!/bin/env perl", which | |
2737 | ;; finds the interpreter anywhere in $PATH. | |
1af4c220 GM |
2738 | (and (not done) |
2739 | (setq mode (save-excursion | |
2740 | (goto-char (point-min)) | |
2741 | (if (looking-at auto-mode-interpreter-regexp) | |
2742 | (match-string 2)))) | |
2743 | ;; Map interpreter name to a mode, signaling we're done at the | |
2744 | ;; same time. | |
2745 | (setq done (assoc-default | |
2746 | (file-name-nondirectory mode) | |
1af4c220 | 2747 | (mapcar (lambda (e) |
feeff482 SM |
2748 | (cons |
2749 | (format "\\`%s\\'" (car e)) | |
2750 | (cdr e))) | |
1af4c220 GM |
2751 | interpreter-mode-alist) |
2752 | #'string-match-p)) | |
2753 | ;; If we found an interpreter mode to use, invoke it now. | |
2754 | (set-auto-mode-0 done keep-mode-if-same)) | |
14774875 | 2755 | ;; Next try matching the buffer beginning against magic-mode-alist. |
df4d0613 | 2756 | (unless done |
4ac1d37a DP |
2757 | (if (setq done (save-excursion |
2758 | (goto-char (point-min)) | |
5cce080e KS |
2759 | (save-restriction |
2760 | (narrow-to-region (point-min) | |
2761 | (min (point-max) | |
2762 | (+ (point-min) magic-mode-regexp-match-limit))) | |
2763 | (assoc-default nil magic-mode-alist | |
06b60517 | 2764 | (lambda (re _dummy) |
10ffa2a1 KS |
2765 | (if (functionp re) |
2766 | (funcall re) | |
2767 | (looking-at re))))))) | |
14774875 RS |
2768 | (set-auto-mode-0 done keep-mode-if-same))) |
2769 | ;; Next compare the filename against the entries in auto-mode-alist. | |
2770 | (unless done | |
2771 | (if buffer-file-name | |
f1fa5062 MA |
2772 | (let ((name buffer-file-name) |
2773 | (remote-id (file-remote-p buffer-file-name))) | |
28dbc92f MA |
2774 | ;; Remove backup-suffixes from file name. |
2775 | (setq name (file-name-sans-versions name)) | |
f1fa5062 MA |
2776 | ;; Remove remote file name identification. |
2777 | (when (and (stringp remote-id) | |
32650100 | 2778 | (string-match (regexp-quote remote-id) name)) |
f1fa5062 | 2779 | (setq name (substring name (match-end 0)))) |
14774875 RS |
2780 | (while name |
2781 | ;; Find first matching alist entry. | |
2782 | (setq mode | |
7c2fb837 | 2783 | (if (memq system-type '(windows-nt cygwin)) |
14774875 RS |
2784 | ;; System is case-insensitive. |
2785 | (let ((case-fold-search t)) | |
2786 | (assoc-default name auto-mode-alist | |
2787 | 'string-match)) | |
2788 | ;; System is case-sensitive. | |
2789 | (or | |
2790 | ;; First match case-sensitively. | |
2791 | (let ((case-fold-search nil)) | |
2792 | (assoc-default name auto-mode-alist | |
2793 | 'string-match)) | |
2794 | ;; Fallback to case-insensitive match. | |
2795 | (and auto-mode-case-fold | |
2796 | (let ((case-fold-search t)) | |
2797 | (assoc-default name auto-mode-alist | |
2798 | 'string-match)))))) | |
2799 | (if (and mode | |
2800 | (consp mode) | |
2801 | (cadr mode)) | |
2802 | (setq mode (car mode) | |
2803 | name (substring name 0 (match-beginning 0))) | |
a9dd5754 | 2804 | (setq name nil)) |
14774875 RS |
2805 | (when mode |
2806 | (set-auto-mode-0 mode keep-mode-if-same) | |
2807 | (setq done t)))))) | |
92228a10 | 2808 | ;; Next try matching the buffer beginning against magic-fallback-mode-alist. |
14774875 RS |
2809 | (unless done |
2810 | (if (setq done (save-excursion | |
2811 | (goto-char (point-min)) | |
2812 | (save-restriction | |
2813 | (narrow-to-region (point-min) | |
2814 | (min (point-max) | |
2815 | (+ (point-min) magic-mode-regexp-match-limit))) | |
92228a10 | 2816 | (assoc-default nil magic-fallback-mode-alist |
06b60517 | 2817 | (lambda (re _dummy) |
14774875 RS |
2818 | (if (functionp re) |
2819 | (funcall re) | |
2820 | (looking-at re))))))) | |
91e8293c SM |
2821 | (set-auto-mode-0 done keep-mode-if-same))) |
2822 | (unless done | |
2823 | (set-buffer-major-mode (current-buffer))))) | |
521cf174 | 2824 | |
521cf174 DP |
2825 | ;; When `keep-mode-if-same' is set, we are working on behalf of |
2826 | ;; set-visited-file-name. In that case, if the major mode specified is the | |
2827 | ;; same one we already have, don't actually reset it. We don't want to lose | |
2828 | ;; minor modes such as Font Lock. | |
3467488e | 2829 | (defun set-auto-mode-0 (mode &optional keep-mode-if-same) |
521cf174 | 2830 | "Apply MODE and return it. |
3467488e KS |
2831 | If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of |
2832 | any aliases and compared to current major mode. If they are the | |
2833 | same, do nothing and return nil." | |
0c7c413c CY |
2834 | (unless (and keep-mode-if-same |
2835 | (eq (indirect-function mode) | |
2836 | (indirect-function major-mode))) | |
2837 | (when mode | |
2838 | (funcall mode) | |
2839 | mode))) | |
b4da00e9 | 2840 | |
248da2f4 RW |
2841 | (defvar file-auto-mode-skip "^\\(#!\\|'\\\\\"\\)" |
2842 | "Regexp of lines to skip when looking for file-local settings. | |
2843 | If the first line matches this regular expression, then the -*-...-*- file- | |
2844 | local settings will be consulted on the second line instead of the first.") | |
2845 | ||
e3f9b9c0 RS |
2846 | (defun set-auto-mode-1 () |
2847 | "Find the -*- spec in the buffer. | |
2848 | Call with point at the place to start searching from. | |
7b447e9b GM |
2849 | If one is found, set point to the beginning and return the position |
2850 | of the end. Otherwise, return nil; may change point. | |
2851 | The variable `inhibit-local-variables-regexps' can cause a -*- spec to | |
2852 | be ignored; but `enable-local-variables' and `local-enable-local-variables' | |
2853 | have no effect." | |
e3f9b9c0 RS |
2854 | (let (beg end) |
2855 | (and | |
2856 | ;; Don't look for -*- if this file name matches any | |
7b447e9b GM |
2857 | ;; of the regexps in inhibit-local-variables-regexps. |
2858 | (not (inhibit-local-variables-p)) | |
f587e30b | 2859 | (search-forward "-*-" (line-end-position |
7b447e9b GM |
2860 | ;; If the file begins with "#!" (exec |
2861 | ;; interpreter magic), look for mode frobs | |
2862 | ;; in the first two lines. You cannot | |
2863 | ;; necessarily put them in the first line | |
2864 | ;; of such a file without screwing up the | |
2865 | ;; interpreter invocation. The same holds | |
2866 | ;; for '\" in man pages (preprocessor | |
dddb4597 | 2867 | ;; magic for the `man' program). |
248da2f4 | 2868 | (and (looking-at file-auto-mode-skip) 2)) t) |
e3f9b9c0 RS |
2869 | (progn |
2870 | (skip-chars-forward " \t") | |
2871 | (setq beg (point)) | |
f587e30b | 2872 | (search-forward "-*-" (line-end-position) t)) |
e3f9b9c0 RS |
2873 | (progn |
2874 | (forward-char -3) | |
2875 | (skip-chars-backward " \t") | |
2876 | (setq end (point)) | |
2877 | (goto-char beg) | |
2878 | end)))) | |
b9e1451a CY |
2879 | \f |
2880 | ;;; Handling file local variables | |
2881 | ||
2882 | (defvar ignored-local-variables | |
2b8ac025 | 2883 | '(ignored-local-variables safe-local-variable-values |
8c8b0185 | 2884 | file-local-variables-alist dir-local-variables-alist) |
b9e1451a | 2885 | "Variables to be ignored in a file's local variable spec.") |
3029e594 | 2886 | (put 'ignored-local-variables 'risky-local-variable t) |
b9e1451a CY |
2887 | |
2888 | (defvar hack-local-variables-hook nil | |
2889 | "Normal hook run after processing a file's local variables specs. | |
2890 | Major modes can use this to examine user-specified local variables | |
2891 | in order to initialize other data structure based on them.") | |
2892 | ||
2893 | (defcustom safe-local-variable-values nil | |
2894 | "List variable-value pairs that are considered safe. | |
2895 | Each element is a cons cell (VAR . VAL), where VAR is a variable | |
2896 | symbol and VAL is a value that is considered safe." | |
3029e594 | 2897 | :risky t |
b9e1451a | 2898 | :group 'find-file |
094eabe4 | 2899 | :type 'alist) |
b9e1451a | 2900 | |
182b3bec | 2901 | (defcustom safe-local-eval-forms |
5582c670 GM |
2902 | ;; This should be here at least as long as Emacs supports write-file-hooks. |
2903 | '((add-hook 'write-file-hooks 'time-stamp) | |
2904 | (add-hook 'write-file-functions 'time-stamp) | |
db148c21 SM |
2905 | (add-hook 'before-save-hook 'time-stamp nil t) |
2906 | (add-hook 'before-save-hook 'delete-trailing-whitespace nil t)) | |
ba83982b | 2907 | "Expressions that are considered safe in an `eval:' local variable. |
b9e1451a CY |
2908 | Add expressions to this list if you want Emacs to evaluate them, when |
2909 | they appear in an `eval' local variable specification, without first | |
2910 | asking you for confirmation." | |
3029e594 | 2911 | :risky t |
b9e1451a | 2912 | :group 'find-file |
5582c670 | 2913 | :version "24.1" ; added write-file-hooks |
b9e1451a CY |
2914 | :type '(repeat sexp)) |
2915 | ||
2916 | ;; Risky local variables: | |
2917 | (mapc (lambda (var) (put var 'risky-local-variable t)) | |
2918 | '(after-load-alist | |
b9e1451a CY |
2919 | buffer-auto-save-file-name |
2920 | buffer-file-name | |
2921 | buffer-file-truename | |
2922 | buffer-undo-list | |
b9e1451a CY |
2923 | debugger |
2924 | default-text-properties | |
b9e1451a CY |
2925 | eval |
2926 | exec-directory | |
2927 | exec-path | |
2928 | file-name-handler-alist | |
b9e1451a CY |
2929 | frame-title-format |
2930 | global-mode-string | |
2931 | header-line-format | |
2932 | icon-title-format | |
b9e1451a | 2933 | inhibit-quit |
b9e1451a CY |
2934 | load-path |
2935 | max-lisp-eval-depth | |
2936 | max-specpdl-size | |
b9e1451a CY |
2937 | minor-mode-map-alist |
2938 | minor-mode-overriding-map-alist | |
b9e1451a | 2939 | mode-line-format |
b9e1451a | 2940 | mode-name |
b9e1451a CY |
2941 | overriding-local-map |
2942 | overriding-terminal-local-map | |
b9e1451a | 2943 | process-environment |
b9e1451a CY |
2944 | standard-input |
2945 | standard-output | |
3029e594 | 2946 | unread-command-events)) |
b9e1451a CY |
2947 | |
2948 | ;; Safe local variables: | |
2949 | ;; | |
3e457225 RS |
2950 | ;; For variables defined by major modes, the safety declarations can go into |
2951 | ;; the major mode's file, since that will be loaded before file variables are | |
2952 | ;; processed. | |
2953 | ;; | |
2954 | ;; For variables defined by minor modes, put the safety declarations in the | |
2955 | ;; file defining the minor mode after the defcustom/defvar using an autoload | |
2956 | ;; cookie, e.g.: | |
2957 | ;; | |
2958 | ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp) | |
2959 | ;; | |
2960 | ;; Otherwise, when Emacs visits a file specifying that local variable, the | |
2961 | ;; minor mode file may not be loaded yet. | |
2962 | ;; | |
2963 | ;; For variables defined in the C source code the declaration should go here: | |
b9e1451a | 2964 | |
b38b1ec0 SM |
2965 | (dolist (pair |
2966 | '((buffer-read-only . booleanp) ;; C source code | |
2967 | (default-directory . stringp) ;; C source code | |
2968 | (fill-column . integerp) ;; C source code | |
2969 | (indent-tabs-mode . booleanp) ;; C source code | |
2970 | (left-margin . integerp) ;; C source code | |
2971 | (no-update-autoloads . booleanp) | |
2972 | (lexical-binding . booleanp) ;; C source code | |
2973 | (tab-width . integerp) ;; C source code | |
2974 | (truncate-lines . booleanp) ;; C source code | |
2975 | (word-wrap . booleanp) ;; C source code | |
2976 | (bidi-display-reordering . booleanp))) ;; C source code | |
2977 | (put (car pair) 'safe-local-variable (cdr pair))) | |
b9e1451a | 2978 | |
cd83d522 EZ |
2979 | (put 'bidi-paragraph-direction 'safe-local-variable |
2980 | (lambda (v) (memq v '(nil right-to-left left-to-right)))) | |
2981 | ||
b9e1451a | 2982 | (put 'c-set-style 'safe-local-eval-function t) |
e3f9b9c0 | 2983 | |
2b8ac025 CY |
2984 | (defvar file-local-variables-alist nil |
2985 | "Alist of file-local variable settings in the current buffer. | |
2986 | Each element in this list has the form (VAR . VALUE), where VAR | |
2987 | is a file-local variable (a symbol) and VALUE is the value | |
2988 | specified. The actual value in the buffer may differ from VALUE, | |
2989 | if it is changed by the major or minor modes, or by the user.") | |
2990 | (make-variable-buffer-local 'file-local-variables-alist) | |
2a8a455e | 2991 | (put 'file-local-variables-alist 'permanent-local t) |
2b8ac025 | 2992 | |
8c8b0185 JL |
2993 | (defvar dir-local-variables-alist nil |
2994 | "Alist of directory-local variable settings in the current buffer. | |
2995 | Each element in this list has the form (VAR . VALUE), where VAR | |
2996 | is a directory-local variable (a symbol) and VALUE is the value | |
2997 | specified in .dir-locals.el. The actual value in the buffer | |
2998 | may differ from VALUE, if it is changed by the major or minor modes, | |
2999 | or by the user.") | |
3000 | (make-variable-buffer-local 'dir-local-variables-alist) | |
3001 | ||
2b8ac025 CY |
3002 | (defvar before-hack-local-variables-hook nil |
3003 | "Normal hook run before setting file-local variables. | |
3004 | It is called after checking for unsafe/risky variables and | |
3005 | setting `file-local-variables-alist', and before applying the | |
3006 | variables stored in `file-local-variables-alist'. A hook | |
3007 | function is allowed to change the contents of this alist. | |
3008 | ||
3009 | This hook is called only if there is at least one file-local | |
3010 | variable to set.") | |
3011 | ||
75fd7f12 | 3012 | (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name) |
70b49e57 RS |
3013 | "Get confirmation before setting up local variable values. |
3014 | ALL-VARS is the list of all variables to be set up. | |
3015 | UNSAFE-VARS is the list of those that aren't marked as safe or risky. | |
1b21ee06 | 3016 | RISKY-VARS is the list of those that are marked as risky. |
07915ed9 GM |
3017 | If these settings come from directory-local variables, then |
3018 | DIR-NAME is the name of the associated directory. Otherwise it is nil." | |
a8b7cd8d CY |
3019 | (unless noninteractive |
3020 | (let ((name (cond (dir-name) | |
3021 | (buffer-file-name | |
3022 | (file-name-nondirectory buffer-file-name)) | |
3023 | ((concat "buffer " (buffer-name))))) | |
3024 | (offer-save (and (eq enable-local-variables t) | |
3025 | unsafe-vars)) | |
3026 | (buf (get-buffer-create "*Local Variables*"))) | |
3027 | ;; Set up the contents of the *Local Variables* buffer. | |
3028 | (with-current-buffer buf | |
3ef01959 CY |
3029 | (erase-buffer) |
3030 | (cond | |
3031 | (unsafe-vars | |
3032 | (insert "The local variables list in " name | |
3033 | "\ncontains values that may not be safe (*)" | |
3034 | (if risky-vars | |
3035 | ", and variables that are risky (**)." | |
3036 | "."))) | |
3037 | (risky-vars | |
3038 | (insert "The local variables list in " name | |
3039 | "\ncontains variables that are risky (**).")) | |
3040 | (t | |
3041 | (insert "A local variables list is specified in " name "."))) | |
3042 | (insert "\n\nDo you want to apply it? You can type | |
5a6c1d87 | 3043 | y -- to apply the local variables list. |
af467e28 | 3044 | n -- to ignore the local variables list.") |
3ef01959 CY |
3045 | (if offer-save |
3046 | (insert " | |
dbcd3ce0 EZ |
3047 | ! -- to apply the local variables list, and permanently mark these |
3048 | values (*) as safe (in the future, they will be set automatically.)\n\n") | |
3ef01959 CY |
3049 | (insert "\n\n")) |
3050 | (dolist (elt all-vars) | |
3051 | (cond ((member elt unsafe-vars) | |
3052 | (insert " * ")) | |
3053 | ((member elt risky-vars) | |
3054 | (insert " ** ")) | |
3055 | (t | |
3056 | (insert " "))) | |
3057 | (princ (car elt) buf) | |
3058 | (insert " : ") | |
3059 | ;; Make strings with embedded whitespace easier to read. | |
3060 | (let ((print-escape-newlines t)) | |
3061 | (prin1 (cdr elt) buf)) | |
3062 | (insert "\n")) | |
a8b7cd8d CY |
3063 | (set (make-local-variable 'cursor-type) nil) |
3064 | (set-buffer-modified-p nil) | |
3065 | (goto-char (point-min))) | |
3066 | ||
3067 | ;; Display the buffer and read a choice. | |
3068 | (save-window-excursion | |
3069 | (pop-to-buffer buf) | |
3070 | (let* ((exit-chars '(?y ?n ?\s ?\C-g ?\C-v)) | |
3071 | (prompt (format "Please type %s%s: " | |
3072 | (if offer-save "y, n, or !" "y or n") | |
3073 | (if (< (line-number-at-pos (point-max)) | |
3074 | (window-body-height)) | |
3075 | "" | |
3076 | (push ?\C-v exit-chars) | |
3077 | ", or C-v to scroll"))) | |
3078 | char) | |
3079 | (if offer-save (push ?! exit-chars)) | |
3080 | (while (null char) | |
3081 | (setq char (read-char-choice prompt exit-chars t)) | |
3082 | (when (eq char ?\C-v) | |
3083 | (condition-case nil | |
3084 | (scroll-up) | |
3085 | (error (goto-char (point-min)) | |
3086 | (recenter 1))) | |
3087 | (setq char nil))) | |
3088 | (when (and offer-save (= char ?!) unsafe-vars) | |
3089 | (customize-push-and-save 'safe-local-variable-values unsafe-vars)) | |
3090 | (prog1 (memq char '(?! ?\s ?y)) | |
3091 | (quit-window t))))))) | |
cc45837e | 3092 | |
a829b0dc SM |
3093 | (defconst hack-local-variable-regexp |
3094 | "[ \t]*\\([^][;\"'?()\\ \t\n]+\\)[ \t]*:[ \t]*") | |
3095 | ||
a0e74e72 | 3096 | (defun hack-local-variables-prop-line (&optional mode-only) |
5a6c1d87 | 3097 | "Return local variables specified in the -*- line. |
88dfa756 GM |
3098 | Returns an alist of elements (VAR . VAL), where VAR is a variable |
3099 | and VAL is the specified value. Ignores any specification for | |
3100 | `mode:' and `coding:' (which should have already been handled | |
3101 | by `set-auto-mode' and `set-auto-coding', respectively). | |
3aace4e4 | 3102 | Return nil if the -*- line is malformed. |
88dfa756 GM |
3103 | |
3104 | If MODE-ONLY is non-nil, just returns the symbol specifying the | |
3105 | mode, if there is one, otherwise nil." | |
3aace4e4 CY |
3106 | (catch 'malformed-line |
3107 | (save-excursion | |
3108 | (goto-char (point-min)) | |
3109 | (let ((end (set-auto-mode-1)) | |
3110 | result) | |
3111 | (cond ((not end) | |
3112 | nil) | |
3113 | ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)") | |
3114 | ;; Simple form: "-*- MODENAME -*-". | |
3115 | (if mode-only | |
3116 | (intern (concat (match-string 1) "-mode")))) | |
3117 | (t | |
3118 | ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-' | |
3119 | ;; (last ";" is optional). | |
3120 | ;; If MODE-ONLY, just check for `mode'. | |
3121 | ;; Otherwise, parse the -*- line into the RESULT alist. | |
a829b0dc SM |
3122 | (while (not (or (and mode-only result) |
3123 | (>= (point) end))) | |
3124 | (unless (looking-at hack-local-variable-regexp) | |
3125 | (message "Malformed mode-line: %S" | |
3126 | (buffer-substring-no-properties (point) end)) | |
3aace4e4 CY |
3127 | (throw 'malformed-line nil)) |
3128 | (goto-char (match-end 0)) | |
3129 | ;; There used to be a downcase here, | |
3130 | ;; but the manual didn't say so, | |
3131 | ;; and people want to set var names that aren't all lc. | |
3132 | (let* ((key (intern (match-string 1))) | |
3133 | (val (save-restriction | |
3134 | (narrow-to-region (point) end) | |
3135 | (let ((read-circle nil)) | |
3136 | (read (current-buffer))))) | |
3137 | ;; It is traditional to ignore | |
3138 | ;; case when checking for `mode' in set-auto-mode, | |
3139 | ;; so we must do that here as well. | |
3140 | ;; That is inconsistent, but we're stuck with it. | |
3141 | ;; The same can be said for `coding' in set-auto-coding. | |
3142 | (keyname (downcase (symbol-name key)))) | |
3143 | (if mode-only | |
3144 | (and (equal keyname "mode") | |
3145 | (setq result | |
3146 | (intern (concat (downcase (symbol-name val)) | |
3147 | "-mode")))) | |
3148 | (or (equal keyname "coding") | |
3149 | (condition-case nil | |
3150 | (push (cons (cond ((eq key 'eval) 'eval) | |
3151 | ;; Downcase "Mode:". | |
3152 | ((equal keyname "mode") 'mode) | |
3153 | (t (indirect-variable key))) | |
3154 | val) result) | |
3155 | (error nil)))) | |
3156 | (skip-chars-forward " \t;"))) | |
3157 | result)))))) | |
f3e23606 | 3158 | |
75fd7f12 | 3159 | (defun hack-local-variables-filter (variables dir-name) |
2b8ac025 CY |
3160 | "Filter local variable settings, querying the user if necessary. |
3161 | VARIABLES is the alist of variable-value settings. This alist is | |
3162 | filtered based on the values of `ignored-local-variables', | |
3163 | `enable-local-eval', `enable-local-variables', and (if necessary) | |
3164 | user interaction. The results are added to | |
3165 | `file-local-variables-alist', without applying them. | |
07915ed9 GM |
3166 | If these settings come from directory-local variables, then |
3167 | DIR-NAME is the name of the associated directory. Otherwise it is nil." | |
89bf83cd CY |
3168 | ;; Find those variables that we may want to save to |
3169 | ;; `safe-local-variable-values'. | |
3170 | (let (all-vars risky-vars unsafe-vars) | |
3171 | (dolist (elt variables) | |
3172 | (let ((var (car elt)) | |
3173 | (val (cdr elt))) | |
3174 | (cond ((memq var ignored-local-variables) | |
3175 | ;; Ignore any variable in `ignored-local-variables'. | |
3176 | nil) | |
3177 | ;; Obey `enable-local-eval'. | |
3178 | ((eq var 'eval) | |
3179 | (when enable-local-eval | |
1b15d8ad | 3180 | (let ((safe (or (hack-one-local-variable-eval-safep val) |
f40b9f10 GM |
3181 | ;; In case previously marked safe (bug#5636). |
3182 | (safe-local-variable-p var val)))) | |
3183 | ;; If not safe and e-l-v = :safe, ignore totally. | |
3184 | (when (or safe (not (eq enable-local-variables :safe))) | |
3185 | (push elt all-vars) | |
3186 | (or (eq enable-local-eval t) | |
3187 | safe | |
3188 | (push elt unsafe-vars)))))) | |
cfb54897 JL |
3189 | ;; Ignore duplicates (except `mode') in the present list. |
3190 | ((and (assq var all-vars) (not (eq var 'mode))) nil) | |
89bf83cd CY |
3191 | ;; Accept known-safe variables. |
3192 | ((or (memq var '(mode unibyte coding)) | |
3193 | (safe-local-variable-p var val)) | |
3194 | (push elt all-vars)) | |
3195 | ;; The variable is either risky or unsafe: | |
3196 | ((not (eq enable-local-variables :safe)) | |
3197 | (push elt all-vars) | |
3198 | (if (risky-local-variable-p var val) | |
3199 | (push elt risky-vars) | |
3200 | (push elt unsafe-vars)))))) | |
3201 | (and all-vars | |
3202 | ;; Query, unless all vars are safe or user wants no querying. | |
3203 | (or (and (eq enable-local-variables t) | |
3204 | (null unsafe-vars) | |
3205 | (null risky-vars)) | |
42e0a725 | 3206 | (memq enable-local-variables '(:all :safe)) |
89bf83cd CY |
3207 | (hack-local-variables-confirm all-vars unsafe-vars |
3208 | risky-vars dir-name)) | |
3209 | (dolist (elt all-vars) | |
cfb54897 | 3210 | (unless (memq (car elt) '(eval mode)) |
8c8b0185 JL |
3211 | (unless dir-name |
3212 | (setq dir-local-variables-alist | |
3213 | (assq-delete-all (car elt) dir-local-variables-alist))) | |
89bf83cd CY |
3214 | (setq file-local-variables-alist |
3215 | (assq-delete-all (car elt) file-local-variables-alist))) | |
3216 | (push elt file-local-variables-alist))))) | |
1b21ee06 | 3217 | |
012e2f9f GM |
3218 | ;; TODO? Warn once per file rather than once per session? |
3219 | (defvar hack-local-variables--warned-lexical nil) | |
3220 | ||
9de9b6a2 RS |
3221 | (defun hack-local-variables (&optional mode-only) |
3222 | "Parse and put into effect this buffer's local variables spec. | |
27b48e63 GM |
3223 | Uses `hack-local-variables-apply' to apply the variables. |
3224 | ||
88dfa756 | 3225 | If MODE-ONLY is non-nil, all we do is check whether a \"mode:\" |
162d78a1 GM |
3226 | is specified, and return the corresponding mode symbol, or nil. |
3227 | In this case, we try to ignore minor-modes, and only return a | |
7b447e9b GM |
3228 | major-mode. |
3229 | ||
3230 | If `enable-local-variables' or `local-enable-local-variables' is nil, | |
3231 | this function does nothing. If `inhibit-local-variables-regexps' | |
3232 | applies to the file in question, the file is not scanned for | |
3233 | local variables, but directory-local variables may still be applied." | |
3234 | ;; We don't let inhibit-local-variables-p influence the value of | |
3235 | ;; enable-local-variables, because then it would affect dir-local | |
3236 | ;; variables. We don't want to search eg tar files for file local | |
3237 | ;; variable sections, but there is no reason dir-locals cannot apply | |
3238 | ;; to them. The real meaning of inhibit-local-variables-p is "do | |
3239 | ;; not scan this file for local variables". | |
5a6c1d87 CY |
3240 | (let ((enable-local-variables |
3241 | (and local-enable-local-variables enable-local-variables)) | |
3242 | result) | |
2b8ac025 CY |
3243 | (unless mode-only |
3244 | (setq file-local-variables-alist nil) | |
75fd7f12 | 3245 | (report-errors "Directory-local variables error: %s" |
7b447e9b | 3246 | ;; Note this is a no-op if enable-local-variables is nil. |
75fd7f12 | 3247 | (hack-dir-local-variables))) |
7b447e9b GM |
3248 | ;; This entire function is basically a no-op if enable-local-variables |
3249 | ;; is nil. All it does is set file-local-variables-alist to nil. | |
3250 | (when enable-local-variables | |
3251 | ;; This part used to ignore enable-local-variables when mode-only | |
3252 | ;; was non-nil. That was inappropriate, eg consider the | |
3253 | ;; (artificial) example of: | |
3254 | ;; (setq local-enable-local-variables nil) | |
3255 | ;; Open a file foo.txt that contains "mode: sh". | |
3256 | ;; It correctly opens in text-mode. | |
3257 | ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode. | |
3258 | (unless (or (inhibit-local-variables-p) | |
3259 | ;; If MODE-ONLY is non-nil, and the prop line specifies a | |
3260 | ;; mode, then we're done, and have no need to scan further. | |
3261 | (and (setq result (hack-local-variables-prop-line mode-only)) | |
3262 | mode-only)) | |
7e4ccca3 GM |
3263 | ;; Look for "Local variables:" line in last page. |
3264 | (save-excursion | |
3265 | (goto-char (point-max)) | |
3266 | (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) | |
3267 | 'move) | |
3268 | (when (let ((case-fold-search t)) | |
3269 | (search-forward "Local Variables:" nil t)) | |
3270 | (skip-chars-forward " \t") | |
3271 | ;; suffix is what comes after "local variables:" in its line. | |
3272 | ;; prefix is what comes before "local variables:" in its line. | |
3273 | (let ((suffix | |
3274 | (concat | |
3275 | (regexp-quote (buffer-substring (point) | |
3276 | (line-end-position))) | |
3277 | "$")) | |
3278 | (prefix | |
3279 | (concat "^" (regexp-quote | |
3280 | (buffer-substring (line-beginning-position) | |
a829b0dc | 3281 | (match-beginning 0)))))) |
7e4ccca3 GM |
3282 | |
3283 | (forward-line 1) | |
3284 | (let ((startpos (point)) | |
3285 | endpos | |
3286 | (thisbuf (current-buffer))) | |
3287 | (save-excursion | |
3288 | (unless (let ((case-fold-search t)) | |
3289 | (re-search-forward | |
3290 | (concat prefix "[ \t]*End:[ \t]*" suffix) | |
3291 | nil t)) | |
3292 | ;; This used to be an error, but really all it means is | |
3293 | ;; that this may simply not be a local-variables section, | |
3294 | ;; so just ignore it. | |
3295 | (message "Local variables list is not properly terminated")) | |
3296 | (beginning-of-line) | |
3297 | (setq endpos (point))) | |
3298 | ||
3299 | (with-temp-buffer | |
3300 | (insert-buffer-substring thisbuf startpos endpos) | |
3301 | (goto-char (point-min)) | |
3302 | (subst-char-in-region (point) (point-max) ?\^m ?\n) | |
3303 | (while (not (eobp)) | |
3304 | ;; Discard the prefix. | |
3305 | (if (looking-at prefix) | |
3306 | (delete-region (point) (match-end 0)) | |
3307 | (error "Local variables entry is missing the prefix")) | |
3308 | (end-of-line) | |
3309 | ;; Discard the suffix. | |
3310 | (if (looking-back suffix) | |
3311 | (delete-region (match-beginning 0) (point)) | |
3312 | (error "Local variables entry is missing the suffix")) | |
3313 | (forward-line 1)) | |
3314 | (goto-char (point-min)) | |
3315 | ||
a829b0dc SM |
3316 | (while (not (or (eobp) |
3317 | (and mode-only result))) | |
3318 | ;; Find the variable name; | |
3319 | (unless (looking-at hack-local-variable-regexp) | |
3320 | (error "Malformed local variable line: %S" | |
3321 | (buffer-substring-no-properties | |
3322 | (point) (line-end-position)))) | |
3323 | (goto-char (match-end 1)) | |
3324 | (let* ((str (match-string 1)) | |
3325 | (var (intern str)) | |
162d78a1 | 3326 | val val2) |
8e999f70 GM |
3327 | (and (equal (downcase (symbol-name var)) "mode") |
3328 | (setq var 'mode)) | |
7e4ccca3 GM |
3329 | ;; Read the variable value. |
3330 | (skip-chars-forward "^:") | |
3331 | (forward-char 1) | |
3332 | (let ((read-circle nil)) | |
3333 | (setq val (read (current-buffer)))) | |
3334 | (if mode-only | |
162d78a1 GM |
3335 | (and (eq var 'mode) |
3336 | ;; Specifying minor-modes via mode: is | |
3337 | ;; deprecated, but try to reject them anyway. | |
3338 | (not (string-match | |
3339 | "-minor\\'" | |
98f593b8 | 3340 | (setq val2 (downcase (symbol-name val))))) |
162d78a1 | 3341 | (setq result (intern (concat val2 "-mode")))) |
012e2f9f GM |
3342 | (cond ((eq var 'coding)) |
3343 | ((eq var 'lexical-binding) | |
3344 | (unless hack-local-variables--warned-lexical | |
3345 | (setq hack-local-variables--warned-lexical t) | |
092c12b2 SM |
3346 | (display-warning |
3347 | :warning | |
3348 | (format "%s: `lexical-binding' at end of file unreliable" | |
3349 | (file-name-nondirectory | |
3350 | (or buffer-file-name "")))))) | |
012e2f9f GM |
3351 | (t |
3352 | (ignore-errors | |
3353 | (push (cons (if (eq var 'eval) | |
3354 | 'eval | |
3355 | (indirect-variable var)) | |
3356 | val) result)))))) | |
7b447e9b GM |
3357 | (forward-line 1)))))))) |
3358 | ;; Now we've read all the local variables. | |
3359 | ;; If MODE-ONLY is non-nil, return whether the mode was specified. | |
3360 | (if mode-only result | |
3361 | ;; Otherwise, set the variables. | |
3362 | (hack-local-variables-filter result nil) | |
3363 | (hack-local-variables-apply))))) | |
8117868f DN |
3364 | |
3365 | (defun hack-local-variables-apply () | |
27b48e63 GM |
3366 | "Apply the elements of `file-local-variables-alist'. |
3367 | If there are any elements, runs `before-hack-local-variables-hook', | |
3368 | then calls `hack-one-local-variable' to apply the alist elements one by one. | |
3369 | Finishes by running `hack-local-variables-hook', regardless of whether | |
3370 | the alist is empty or not. | |
3371 | ||
3372 | Note that this function ignores a `mode' entry if it specifies the same | |
3373 | major mode as the buffer already has." | |
8117868f DN |
3374 | (when file-local-variables-alist |
3375 | ;; Any 'evals must run in the Right sequence. | |
3376 | (setq file-local-variables-alist | |
3377 | (nreverse file-local-variables-alist)) | |
3378 | (run-hooks 'before-hack-local-variables-hook) | |
3379 | (dolist (elt file-local-variables-alist) | |
3380 | (hack-one-local-variable (car elt) (cdr elt)))) | |
3381 | (run-hooks 'hack-local-variables-hook)) | |
5a6c1d87 | 3382 | |
5a6c1d87 CY |
3383 | (defun safe-local-variable-p (sym val) |
3384 | "Non-nil if SYM is safe as a file-local variable with value VAL. | |
3385 | It is safe if any of these conditions are met: | |
3386 | ||
3387 | * There is a matching entry (SYM . VAL) in the | |
3388 | `safe-local-variable-values' user option. | |
3389 | ||
5a6c1d87 CY |
3390 | * The `safe-local-variable' property of SYM is a function that |
3391 | evaluates to a non-nil value with VAL as an argument." | |
3392 | (or (member (cons sym val) safe-local-variable-values) | |
3393 | (let ((safep (get sym 'safe-local-variable))) | |
acef0722 SM |
3394 | (and (functionp safep) |
3395 | ;; If the function signals an error, that means it | |
3396 | ;; can't assure us that the value is safe. | |
3397 | (with-demoted-errors (funcall safep val)))))) | |
5a6c1d87 | 3398 | |
06b60517 | 3399 | (defun risky-local-variable-p (sym &optional _ignored) |
5a6c1d87 CY |
3400 | "Non-nil if SYM could be dangerous as a file-local variable. |
3401 | It is dangerous if either of these conditions are met: | |
3402 | ||
3403 | * Its `risky-local-variable' property is non-nil. | |
3404 | ||
3405 | * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\", | |
3406 | \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\", | |
cc5a104d RS |
3407 | \"mode-alist\", \"font-lock-(syntactic-)keyword*\", |
3408 | \"map-alist\", or \"bindat-spec\"." | |
f36d46ca RS |
3409 | ;; If this is an alias, check the base name. |
3410 | (condition-case nil | |
3411 | (setq sym (indirect-variable sym)) | |
3412 | (error nil)) | |
5a6c1d87 CY |
3413 | (or (get sym 'risky-local-variable) |
3414 | (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\ | |
3415 | -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\ | |
3416 | -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\ | |
cc5a104d | 3417 | -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym)))) |
7ed9159a | 3418 | |
d0bd3513 RS |
3419 | (defun hack-one-local-variable-quotep (exp) |
3420 | (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp)))) | |
3421 | ||
ff7affeb RS |
3422 | (defun hack-one-local-variable-constantp (exp) |
3423 | (or (and (not (symbolp exp)) (not (consp exp))) | |
3424 | (memq exp '(t nil)) | |
3425 | (keywordp exp) | |
3426 | (hack-one-local-variable-quotep exp))) | |
3427 | ||
3428 | (defun hack-one-local-variable-eval-safep (exp) | |
3429 | "Return t if it is safe to eval EXP when it is found in a file." | |
8fd9c174 RS |
3430 | (or (not (consp exp)) |
3431 | ;; Detect certain `put' expressions. | |
3432 | (and (eq (car exp) 'put) | |
3433 | (hack-one-local-variable-quotep (nth 1 exp)) | |
3434 | (hack-one-local-variable-quotep (nth 2 exp)) | |
9b3e8086 CY |
3435 | (let ((prop (nth 1 (nth 2 exp))) |
3436 | (val (nth 3 exp))) | |
3437 | (cond ((memq prop '(lisp-indent-hook | |
3438 | lisp-indent-function | |
3439 | scheme-indent-function)) | |
3440 | ;; Only allow safe values (not functions). | |
3441 | (or (numberp val) | |
3442 | (and (hack-one-local-variable-quotep val) | |
3443 | (eq (nth 1 val) 'defun)))) | |
bc5d1dfb EZ |
3444 | ((eq prop 'edebug-form-spec) |
3445 | ;; Only allow indirect form specs. | |
b486a098 SM |
3446 | ;; During bootstrapping, edebug-basic-spec might not be |
3447 | ;; defined yet. | |
3448 | (and (fboundp 'edebug-basic-spec) | |
f215a02f AS |
3449 | (hack-one-local-variable-quotep val) |
3450 | (edebug-basic-spec (nth 1 val))))))) | |
8fd9c174 RS |
3451 | ;; Allow expressions that the user requested. |
3452 | (member exp safe-local-eval-forms) | |
3453 | ;; Certain functions can be allowed with safe arguments | |
3454 | ;; or can specify verification functions to try. | |
3455 | (and (symbolp (car exp)) | |
b8f82dc1 GM |
3456 | ;; Allow (minor)-modes calls with no arguments. |
3457 | ;; This obsoletes the use of "mode:" for such things. (Bug#8613) | |
89bd9ccd | 3458 | (or (and (member (cdr exp) '(nil (1) (0) (-1))) |
b8f82dc1 GM |
3459 | (string-match "-mode\\'" (symbol-name (car exp)))) |
3460 | (let ((prop (get (car exp) 'safe-local-eval-function))) | |
3461 | (cond ((eq prop t) | |
3462 | (let ((ok t)) | |
3463 | (dolist (arg (cdr exp)) | |
3464 | (unless (hack-one-local-variable-constantp arg) | |
3465 | (setq ok nil))) | |
3466 | ok)) | |
3467 | ((functionp prop) | |
3468 | (funcall prop exp)) | |
3469 | ((listp prop) | |
3470 | (let ((ok nil)) | |
3471 | (dolist (function prop) | |
3472 | (if (funcall function exp) | |
3473 | (setq ok t))) | |
3474 | ok)))))))) | |
ff7affeb | 3475 | |
d41706aa SM |
3476 | (defun hack-one-local-variable--obsolete (var) |
3477 | (let ((o (get var 'byte-obsolete-variable))) | |
3478 | (when o | |
3479 | (let ((instead (nth 0 o)) | |
3480 | (since (nth 2 o))) | |
3481 | (message "%s is obsolete%s; %s" | |
3482 | var (if since (format " (since %s)" since)) | |
3483 | (if (stringp instead) instead | |
3484 | (format "use `%s' instead" instead))))))) | |
3485 | ||
f3e23606 | 3486 | (defun hack-one-local-variable (var val) |
0c7c413c CY |
3487 | "Set local variable VAR with value VAL. |
3488 | If VAR is `mode', call `VAL-mode' as a function unless it's | |
3489 | already the major mode." | |
d41706aa SM |
3490 | (pcase var |
3491 | (`mode | |
3492 | (let ((mode (intern (concat (downcase (symbol-name val)) | |
3493 | "-mode")))) | |
3494 | (unless (eq (indirect-function mode) | |
3495 | (indirect-function major-mode)) | |
3496 | (funcall mode)))) | |
3497 | (`eval | |
3498 | (pcase val | |
3499 | (`(add-hook ',hook . ,_) (hack-one-local-variable--obsolete hook))) | |
3500 | (save-excursion (eval val))) | |
3501 | (_ | |
3502 | (hack-one-local-variable--obsolete var) | |
3503 | ;; Make sure the string has no text properties. | |
3504 | ;; Some text properties can get evaluated in various ways, | |
3505 | ;; so it is risky to put them on with a local variable list. | |
3506 | (if (stringp val) | |
3507 | (set-text-properties 0 (length val) nil val)) | |
3508 | (set (make-local-variable var) val)))) | |
1b21ee06 | 3509 | \f |
75fd7f12 | 3510 | ;;; Handling directory-local variables, aka project settings. |
1b21ee06 | 3511 | |
75fd7f12 | 3512 | (defvar dir-locals-class-alist '() |
25760acb CY |
3513 | "Alist mapping directory-local variable classes (symbols) to variable lists.") |
3514 | ||
3515 | (defvar dir-locals-directory-cache '() | |
3516 | "List of cached directory roots for directory-local variable classes. | |
3517 | Each element in this list has the form (DIR CLASS MTIME). | |
3518 | DIR is the name of the directory. | |
3519 | CLASS is the name of a variable class (a symbol). | |
3520 | MTIME is the recorded modification time of the directory-local | |
ebe401f6 | 3521 | variables file associated with this entry. This time is a list |
0c93aa38 | 3522 | of integers (the same format as `file-attributes'), and is |
ebe401f6 GM |
3523 | used to test whether the cache entry is still valid. |
3524 | Alternatively, MTIME can be nil, which means the entry is always | |
3525 | considered valid.") | |
1b21ee06 | 3526 | |
75fd7f12 JL |
3527 | (defsubst dir-locals-get-class-variables (class) |
3528 | "Return the variable list for CLASS." | |
3529 | (cdr (assq class dir-locals-class-alist))) | |
1b21ee06 | 3530 | |
75fd7f12 JL |
3531 | (defun dir-locals-collect-mode-variables (mode-variables variables) |
3532 | "Collect directory-local variables from MODE-VARIABLES. | |
3533 | VARIABLES is the initial list of variables. | |
1b21ee06 | 3534 | Returns the new list." |
75fd7f12 | 3535 | (dolist (pair mode-variables variables) |
1b21ee06 MO |
3536 | (let* ((variable (car pair)) |
3537 | (value (cdr pair)) | |
75fd7f12 | 3538 | (slot (assq variable variables))) |
46253b34 GM |
3539 | ;; If variables are specified more than once, only use the last. (Why?) |
3540 | ;; The pseudo-variables mode and eval are different (bug#3430). | |
3541 | (if (and slot (not (memq variable '(mode eval)))) | |
1b21ee06 MO |
3542 | (setcdr slot value) |
3543 | ;; Need a new cons in case we setcdr later. | |
75fd7f12 | 3544 | (push (cons variable value) variables))))) |
1b21ee06 | 3545 | |
75fd7f12 JL |
3546 | (defun dir-locals-collect-variables (class-variables root variables) |
3547 | "Collect entries from CLASS-VARIABLES into VARIABLES. | |
1b21ee06 | 3548 | ROOT is the root directory of the project. |
75fd7f12 | 3549 | Return the new variables list." |
1b21ee06 MO |
3550 | (let* ((file-name (buffer-file-name)) |
3551 | (sub-file-name (if file-name | |
33cf0fb2 | 3552 | ;; FIXME: Why not use file-relative-name? |
1b21ee06 | 3553 | (substring file-name (length root))))) |
33cf0fb2 SM |
3554 | (condition-case err |
3555 | (dolist (entry class-variables variables) | |
3556 | (let ((key (car entry))) | |
3557 | (cond | |
3558 | ((stringp key) | |
3559 | ;; Don't include this in the previous condition, because we | |
3560 | ;; want to filter all strings before the next condition. | |
3561 | (when (and sub-file-name | |
3562 | (>= (length sub-file-name) (length key)) | |
3563 | (string-prefix-p key sub-file-name)) | |
3564 | (setq variables (dir-locals-collect-variables | |
3565 | (cdr entry) root variables)))) | |
3566 | ((or (not key) | |
3567 | (derived-mode-p key)) | |
6640b281 GM |
3568 | (let* ((alist (cdr entry)) |
3569 | (subdirs (assq 'subdirs alist))) | |
3570 | (if (or (not subdirs) | |
3571 | (progn | |
3572 | (setq alist (delq subdirs alist)) | |
3573 | (cdr-safe subdirs)) | |
0e0b2989 | 3574 | ;; TODO someone might want to extend this to allow |
6640b281 GM |
3575 | ;; integer values for subdir, where N means |
3576 | ;; variables apply to this directory and N levels | |
3577 | ;; below it (0 == nil). | |
3578 | (equal root default-directory)) | |
3579 | (setq variables (dir-locals-collect-mode-variables | |
3580 | alist variables)))))))) | |
33cf0fb2 SM |
3581 | (error |
3582 | ;; The file's content might be invalid (e.g. have a merge conflict), but | |
3583 | ;; that shouldn't prevent the user from opening the file. | |
3584 | (message ".dir-locals error: %s" (error-message-string err)) | |
3585 | nil)))) | |
1b21ee06 | 3586 | |
c1a70892 | 3587 | (defun dir-locals-set-directory-class (directory class &optional mtime) |
75fd7f12 | 3588 | "Declare that the DIRECTORY root is an instance of CLASS. |
1b21ee06 MO |
3589 | DIRECTORY is the name of a directory, a string. |
3590 | CLASS is the name of a project class, a symbol. | |
25760acb | 3591 | MTIME is either the modification time of the directory-local |
cf66a343 | 3592 | variables file that defined this class, or nil. |
1b21ee06 MO |
3593 | |
3594 | When a file beneath DIRECTORY is visited, the mode-specific | |
25760acb | 3595 | variables from CLASS are applied to the buffer. The variables |
75fd7f12 | 3596 | for a class are defined using `dir-locals-set-class-variables'." |
1b21ee06 | 3597 | (setq directory (file-name-as-directory (expand-file-name directory))) |
75fd7f12 JL |
3598 | (unless (assq class dir-locals-class-alist) |
3599 | (error "No such class `%s'" (symbol-name class))) | |
25760acb | 3600 | (push (list directory class mtime) dir-locals-directory-cache)) |
75fd7f12 JL |
3601 | |
3602 | (defun dir-locals-set-class-variables (class variables) | |
3603 | "Map the type CLASS to a list of variable settings. | |
3604 | CLASS is the project class, a symbol. VARIABLES is a list | |
3605 | that declares directory-local variables for the class. | |
3606 | An element in VARIABLES is either of the form: | |
1b21ee06 MO |
3607 | (MAJOR-MODE . ALIST) |
3608 | or | |
3609 | (DIRECTORY . LIST) | |
3610 | ||
3611 | In the first form, MAJOR-MODE is a symbol, and ALIST is an alist | |
3612 | whose elements are of the form (VARIABLE . VALUE). | |
3613 | ||
3614 | In the second form, DIRECTORY is a directory name (a string), and | |
3615 | LIST is a list of the form accepted by the function. | |
3616 | ||
3617 | When a file is visited, the file's class is found. A directory | |
75fd7f12 JL |
3618 | may be assigned a class using `dir-locals-set-directory-class'. |
3619 | Then variables are set in the file's buffer according to the | |
4a427f58 | 3620 | VARIABLES list of the class. The list is processed in order. |
1b21ee06 MO |
3621 | |
3622 | * If the element is of the form (MAJOR-MODE . ALIST), and the | |
3623 | buffer's major mode is derived from MAJOR-MODE (as determined | |
75fd7f12 | 3624 | by `derived-mode-p'), then all the variables in ALIST are |
1b21ee06 MO |
3625 | applied. A MAJOR-MODE of nil may be used to match any buffer. |
3626 | `make-local-variable' is called for each variable before it is | |
3627 | set. | |
3628 | ||
3629 | * If the element is of the form (DIRECTORY . LIST), and DIRECTORY | |
3630 | is an initial substring of the file's directory, then LIST is | |
3631 | applied by recursively following these rules." | |
75fd7f12 | 3632 | (let ((elt (assq class dir-locals-class-alist))) |
1b21ee06 | 3633 | (if elt |
75fd7f12 JL |
3634 | (setcdr elt variables) |
3635 | (push (cons class variables) dir-locals-class-alist)))) | |
1b21ee06 | 3636 | |
75fd7f12 JL |
3637 | (defconst dir-locals-file ".dir-locals.el" |
3638 | "File that contains directory-local variables. | |
3639 | It has to be constant to enforce uniform values | |
3640 | across different environments and users.") | |
3641 | ||
3642 | (defun dir-locals-find-file (file) | |
25760acb CY |
3643 | "Find the directory-local variables for FILE. |
3644 | This searches upward in the directory tree from FILE. | |
ebe401f6 | 3645 | It stops at the first directory that has been registered in |
9a40b8d4 | 3646 | `dir-locals-directory-cache' or contains a `dir-locals-file'. |
ebe401f6 GM |
3647 | If it finds an entry in the cache, it checks that it is valid. |
3648 | A cache entry with no modification time element (normally, one that | |
3649 | has been assigned directly using `dir-locals-set-directory-class', not | |
3650 | set from a file) is always valid. | |
3651 | A cache entry based on a `dir-locals-file' is valid if the modification | |
3652 | time stored in the cache matches the current file modification time. | |
3653 | If not, the cache entry is cleared so that the file will be re-read. | |
3654 | ||
3655 | This function returns either nil (no directory local variables found), | |
3656 | or the matching entry from `dir-locals-directory-cache' (a list), | |
3657 | or the full path to the `dir-locals-file' (a string) in the case | |
3658 | of no valid cache entry." | |
35f0d8ce | 3659 | (setq file (expand-file-name file)) |
8245c361 EZ |
3660 | (let* ((dir-locals-file-name |
3661 | (if (eq system-type 'ms-dos) | |
3662 | (dosified-file-name dir-locals-file) | |
3663 | dir-locals-file)) | |
9a40b8d4 | 3664 | (locals-file (locate-dominating-file file dir-locals-file-name)) |
8245c361 | 3665 | (dir-elt nil)) |
35f0d8ce | 3666 | ;; `locate-dominating-file' may have abbreviated the name. |
9a40b8d4 | 3667 | (and locals-file |
f7fd3d79 GM |
3668 | (setq locals-file (expand-file-name dir-locals-file-name locals-file))) |
3669 | ;; Let dir-locals-read-from-file inform us via demoted-errors | |
3670 | ;; about unreadable files, etc. | |
3671 | ;; Maybe we'd want to keep searching though - that is | |
3672 | ;; a locate-dominating-file issue. | |
3673 | ;;; (or (not (file-readable-p locals-file)) | |
3674 | ;;; (not (file-regular-p locals-file))) | |
3675 | ;;; (setq locals-file nil)) | |
25760acb CY |
3676 | ;; Find the best cached value in `dir-locals-directory-cache'. |
3677 | (dolist (elt dir-locals-directory-cache) | |
75fd7f12 | 3678 | (when (and (eq t (compare-strings file nil (length (car elt)) |
8245c361 EZ |
3679 | (car elt) nil nil |
3680 | (memq system-type | |
3681 | '(windows-nt cygwin ms-dos)))) | |
75fd7f12 JL |
3682 | (> (length (car elt)) (length (car dir-elt)))) |
3683 | (setq dir-elt elt))) | |
ebe401f6 GM |
3684 | (if (and dir-elt |
3685 | (or (null locals-file) | |
3686 | (<= (length (file-name-directory locals-file)) | |
3687 | (length (car dir-elt))))) | |
3688 | ;; Found a potential cache entry. Check validity. | |
3689 | ;; A cache entry with no MTIME is assumed to always be valid | |
3690 | ;; (ie, set directly, not from a dir-locals file). | |
3691 | ;; Note, we don't bother to check that there is a matching class | |
3692 | ;; element in dir-locals-class-alist, since that's done by | |
3693 | ;; dir-locals-set-directory-class. | |
3694 | (if (or (null (nth 2 dir-elt)) | |
3695 | (let ((cached-file (expand-file-name dir-locals-file-name | |
3696 | (car dir-elt)))) | |
3697 | (and (file-readable-p cached-file) | |
25760acb | 3698 | (equal (nth 2 dir-elt) |
ebe401f6 GM |
3699 | (nth 5 (file-attributes cached-file)))))) |
3700 | ;; This cache entry is OK. | |
3701 | dir-elt | |
3702 | ;; This cache entry is invalid; clear it. | |
3703 | (setq dir-locals-directory-cache | |
3704 | (delq dir-elt dir-locals-directory-cache)) | |
3705 | ;; Return the first existing dir-locals file. Might be the same | |
3706 | ;; as dir-elt's, might not (eg latter might have been deleted). | |
3707 | locals-file) | |
3708 | ;; No cache entry. | |
3709 | locals-file))) | |
75fd7f12 JL |
3710 | |
3711 | (defun dir-locals-read-from-file (file) | |
3712 | "Load a variables FILE and register a new class and instance. | |
3713 | FILE is the name of the file holding the variables to apply. | |
3714 | The new class name is the same as the directory in which FILE | |
1b21ee06 MO |
3715 | is found. Returns the new class name." |
3716 | (with-temp-buffer | |
30213927 GM |
3717 | (with-demoted-errors "Error reading dir-locals: %S" |
3718 | (insert-file-contents file) | |
3719 | (unless (zerop (buffer-size)) | |
3720 | (let* ((dir-name (file-name-directory file)) | |
3721 | (class-name (intern dir-name)) | |
3722 | (variables (let ((read-circle nil)) | |
3723 | (read (current-buffer))))) | |
3724 | (dir-locals-set-class-variables class-name variables) | |
3725 | (dir-locals-set-directory-class dir-name class-name | |
3726 | (nth 5 (file-attributes file))) | |
3727 | class-name))))) | |
1b21ee06 | 3728 | |
dfb308ba MA |
3729 | (defcustom enable-remote-dir-locals nil |
3730 | "Non-nil means dir-local variables will be applied to remote files." | |
2a1e2476 | 3731 | :version "24.3" |
dfb308ba MA |
3732 | :type 'boolean |
3733 | :group 'find-file) | |
3734 | ||
76dc5996 SM |
3735 | (defvar hack-dir-local-variables--warned-coding nil) |
3736 | ||
75fd7f12 JL |
3737 | (defun hack-dir-local-variables () |
3738 | "Read per-directory local variables for the current buffer. | |
8c8b0185 | 3739 | Store the directory-local variables in `dir-local-variables-alist' |
97a1cd9d GM |
3740 | and `file-local-variables-alist', without applying them. |
3741 | ||
3742 | This does nothing if either `enable-local-variables' or | |
3743 | `enable-dir-local-variables' are nil." | |
2b8ac025 | 3744 | (when (and enable-local-variables |
97a1cd9d | 3745 | enable-dir-local-variables |
dfb308ba MA |
3746 | (or enable-remote-dir-locals |
3747 | (not (file-remote-p (or (buffer-file-name) | |
3748 | default-directory))))) | |
75fd7f12 | 3749 | ;; Find the variables file. |
0d42eb3e SM |
3750 | (let ((variables-file (dir-locals-find-file |
3751 | (or (buffer-file-name) default-directory))) | |
1b21ee06 | 3752 | (class nil) |
75fd7f12 | 3753 | (dir-name nil)) |
1b21ee06 | 3754 | (cond |
75fd7f12 | 3755 | ((stringp variables-file) |
07915ed9 GM |
3756 | (setq dir-name (file-name-directory variables-file) |
3757 | class (dir-locals-read-from-file variables-file))) | |
75fd7f12 | 3758 | ((consp variables-file) |
25760acb CY |
3759 | (setq dir-name (nth 0 variables-file)) |
3760 | (setq class (nth 1 variables-file)))) | |
1b21ee06 | 3761 | (when class |
75fd7f12 JL |
3762 | (let ((variables |
3763 | (dir-locals-collect-variables | |
3764 | (dir-locals-get-class-variables class) dir-name nil))) | |
3765 | (when variables | |
8c8b0185 | 3766 | (dolist (elt variables) |
824eefe4 | 3767 | (if (eq (car elt) 'coding) |
76dc5996 SM |
3768 | (unless hack-dir-local-variables--warned-coding |
3769 | (setq hack-dir-local-variables--warned-coding t) | |
3770 | (display-warning :warning | |
3771 | "Coding cannot be specified by dir-locals")) | |
824eefe4 GM |
3772 | (unless (memq (car elt) '(eval mode)) |
3773 | (setq dir-local-variables-alist | |
3774 | (assq-delete-all (car elt) dir-local-variables-alist))) | |
3775 | (push elt dir-local-variables-alist))) | |
75fd7f12 | 3776 | (hack-local-variables-filter variables dir-name))))))) |
f3e23606 | 3777 | |
8117868f | 3778 | (defun hack-dir-local-variables-non-file-buffer () |
89bd9ccd CY |
3779 | "Apply directory-local variables to a non-file buffer. |
3780 | For non-file buffers, such as Dired buffers, directory-local | |
3781 | variables are looked for in `default-directory' and its parent | |
3782 | directories." | |
8117868f DN |
3783 | (hack-dir-local-variables) |
3784 | (hack-local-variables-apply)) | |
3785 | ||
b4da00e9 | 3786 | \f |
21540597 | 3787 | (defcustom change-major-mode-with-file-name t |
ba83982b | 3788 | "Non-nil means \\[write-file] should set the major mode from the file name. |
9de9b6a2 RS |
3789 | However, the mode will not be changed if |
3790 | \(1) a local variables list or the `-*-' line specifies a major mode, or | |
3791 | \(2) the current major mode is a \"special\" mode, | |
96e777e1 | 3792 | \ not suitable for ordinary files, or |
21540597 RS |
3793 | \(3) the new file name does not particularly specify any mode." |
3794 | :type 'boolean | |
3795 | :group 'editing-basics) | |
9de9b6a2 | 3796 | |
f36012a6 | 3797 | (defun set-visited-file-name (filename &optional no-query along-with-file) |
b4da00e9 | 3798 | "Change name of file visited in current buffer to FILENAME. |
1af57101 | 3799 | This also renames the buffer to correspond to the new file. |
b4da00e9 | 3800 | The next time the buffer is saved it will go in the newly specified file. |
1af57101 | 3801 | FILENAME nil or an empty string means mark buffer as not visiting any file. |
b4da00e9 | 3802 | Remember to delete the initial contents of the minibuffer |
6a6b62f8 RS |
3803 | if you wish to pass an empty string as the argument. |
3804 | ||
3805 | The optional second argument NO-QUERY, if non-nil, inhibits asking for | |
f36012a6 RS |
3806 | confirmation in the case where another buffer is already visiting FILENAME. |
3807 | ||
3808 | The optional third argument ALONG-WITH-FILE, if non-nil, means that | |
3809 | the old visited file has been renamed to the new name FILENAME." | |
b4da00e9 | 3810 | (interactive "FSet visited file name: ") |
c11a94fe RS |
3811 | (if (buffer-base-buffer) |
3812 | (error "An indirect buffer cannot visit a file")) | |
7b447e9b | 3813 | (let (truename old-try-locals) |
a522e5bf RS |
3814 | (if filename |
3815 | (setq filename | |
3816 | (if (string-equal filename "") | |
3817 | nil | |
3818 | (expand-file-name filename)))) | |
3819 | (if filename | |
3820 | (progn | |
3821 | (setq truename (file-truename filename)) | |
3822 | (if find-file-visit-truename | |
a522e5bf | 3823 | (setq filename truename)))) |
cbca0a4b | 3824 | (if filename |
e6d0b67a | 3825 | (let ((new-name (file-name-nondirectory filename))) |
cbca0a4b RS |
3826 | (if (string= new-name "") |
3827 | (error "Empty file name")))) | |
11e314fa | 3828 | (let ((buffer (and filename (find-buffer-visiting filename)))) |
7b89d38e | 3829 | (and buffer (not (eq buffer (current-buffer))) |
6a6b62f8 | 3830 | (not no-query) |
9aea757b CY |
3831 | (not (y-or-n-p (format "A buffer is visiting %s; proceed? " |
3832 | filename))) | |
7b89d38e | 3833 | (error "Aborted"))) |
a522e5bf RS |
3834 | (or (equal filename buffer-file-name) |
3835 | (progn | |
3836 | (and filename (lock-buffer filename)) | |
3837 | (unlock-buffer))) | |
7b447e9b GM |
3838 | (setq old-try-locals (not (inhibit-local-variables-p)) |
3839 | buffer-file-name filename) | |
a522e5bf RS |
3840 | (if filename ; make buffer name reflect filename. |
3841 | (let ((new-name (file-name-nondirectory buffer-file-name))) | |
a522e5bf | 3842 | (setq default-directory (file-name-directory buffer-file-name)) |
67b6fd1c SM |
3843 | ;; If new-name == old-name, renaming would add a spurious <2> |
3844 | ;; and it's considered as a feature in rename-buffer. | |
a522e5bf RS |
3845 | (or (string= new-name (buffer-name)) |
3846 | (rename-buffer new-name t)))) | |
3847 | (setq buffer-backed-up nil) | |
f36012a6 RS |
3848 | (or along-with-file |
3849 | (clear-visited-file-modtime)) | |
8ccdc29e | 3850 | ;; Abbreviate the file names of the buffer. |
4826e97f | 3851 | (if truename |
8ccdc29e RS |
3852 | (progn |
3853 | (setq buffer-file-truename (abbreviate-file-name truename)) | |
3854 | (if find-file-visit-truename | |
b1f1ceb8 | 3855 | (setq buffer-file-name truename)))) |
a522e5bf RS |
3856 | (setq buffer-file-number |
3857 | (if filename | |
2a47b4f5 | 3858 | (nthcdr 10 (file-attributes buffer-file-name)) |
7b447e9b GM |
3859 | nil)) |
3860 | ;; write-file-functions is normally used for things like ftp-find-file | |
3861 | ;; that visit things that are not local files as if they were files. | |
3862 | ;; Changing to visit an ordinary local file instead should flush the hook. | |
3863 | (kill-local-variable 'write-file-functions) | |
3864 | (kill-local-variable 'local-write-file-hooks) | |
3865 | (kill-local-variable 'revert-buffer-function) | |
3866 | (kill-local-variable 'backup-inhibited) | |
3867 | ;; If buffer was read-only because of version control, | |
3868 | ;; that reason is gone now, so make it writable. | |
3869 | (if vc-mode | |
3870 | (setq buffer-read-only nil)) | |
3871 | (kill-local-variable 'vc-mode) | |
3872 | ;; Turn off backup files for certain file names. | |
3873 | ;; Since this is a permanent local, the major mode won't eliminate it. | |
3874 | (and buffer-file-name | |
3875 | backup-enable-predicate | |
3876 | (not (funcall backup-enable-predicate buffer-file-name)) | |
3877 | (progn | |
3878 | (make-local-variable 'backup-inhibited) | |
3879 | (setq backup-inhibited t))) | |
3880 | (let ((oauto buffer-auto-save-file-name)) | |
3881 | ;; If auto-save was not already on, turn it on if appropriate. | |
3882 | (if (not buffer-auto-save-file-name) | |
3883 | (and buffer-file-name auto-save-default | |
3884 | (auto-save-mode t)) | |
3885 | ;; If auto save is on, start using a new name. | |
3886 | ;; We deliberately don't rename or delete the old auto save | |
3887 | ;; for the old visited file name. This is because perhaps | |
3888 | ;; the user wants to save the new state and then compare with the | |
3889 | ;; previous state from the auto save file. | |
3890 | (setq buffer-auto-save-file-name | |
3891 | (make-auto-save-file-name))) | |
3892 | ;; Rename the old auto save file if any. | |
3893 | (and oauto buffer-auto-save-file-name | |
3894 | (file-exists-p oauto) | |
3895 | (rename-file oauto buffer-auto-save-file-name t))) | |
3896 | (and buffer-file-name | |
3897 | (not along-with-file) | |
3898 | (set-buffer-modified-p t)) | |
3899 | ;; Update the major mode, if the file name determines it. | |
3900 | (condition-case nil | |
3901 | ;; Don't change the mode if it is special. | |
3902 | (or (not change-major-mode-with-file-name) | |
3903 | (get major-mode 'mode-class) | |
3904 | ;; Don't change the mode if the local variable list specifies it. | |
3905 | ;; The file name can influence whether the local variables apply. | |
3906 | (and old-try-locals | |
b13f806e | 3907 | ;; h-l-v also checks it, but might as well be explicit. |
7b447e9b GM |
3908 | (not (inhibit-local-variables-p)) |
3909 | (hack-local-variables t)) | |
3910 | ;; TODO consider making normal-mode handle this case. | |
3911 | (let ((old major-mode)) | |
3912 | (set-auto-mode t) | |
3913 | (or (eq old major-mode) | |
3914 | (hack-local-variables)))) | |
3915 | (error nil)))) | |
b4da00e9 | 3916 | |
912192d1 | 3917 | (defun write-file (filename &optional confirm) |
b4da00e9 | 3918 | "Write current buffer into file FILENAME. |
7f99999a | 3919 | This makes the buffer visit that file, and marks it as not modified. |
7458cc35 | 3920 | |
7f99999a KH |
3921 | If you specify just a directory name as FILENAME, that means to use |
3922 | the default file name but in that directory. You can also yank | |
074eb6ac | 3923 | the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element]. |
7f99999a KH |
3924 | |
3925 | If the buffer is not already visiting a file, the default file name | |
3926 | for the output file is the buffer name. | |
3927 | ||
3928 | If optional second arg CONFIRM is non-nil, this function | |
3929 | asks for confirmation before overwriting an existing file. | |
912192d1 | 3930 | Interactively, confirmation is required unless you supply a prefix argument." |
b4da00e9 RM |
3931 | ;; (interactive "FWrite file: ") |
3932 | (interactive | |
3933 | (list (if buffer-file-name | |
3934 | (read-file-name "Write file: " | |
f3684505 | 3935 | nil nil nil nil) |
7f99999a KH |
3936 | (read-file-name "Write file: " default-directory |
3937 | (expand-file-name | |
3938 | (file-name-nondirectory (buffer-name)) | |
3939 | default-directory) | |
3940 | nil nil)) | |
912192d1 | 3941 | (not current-prefix-arg))) |
b4da00e9 | 3942 | (or (null filename) (string-equal filename "") |
41f48cb1 RS |
3943 | (progn |
3944 | ;; If arg is just a directory, | |
7f99999a KH |
3945 | ;; use the default file name, but in that directory. |
3946 | (if (file-directory-p filename) | |
41f48cb1 | 3947 | (setq filename (concat (file-name-as-directory filename) |
7f99999a KH |
3948 | (file-name-nondirectory |
3949 | (or buffer-file-name (buffer-name)))))) | |
c2fb8488 RS |
3950 | (and confirm |
3951 | (file-exists-p filename) | |
1afb1d07 JD |
3952 | ;; NS does its own confirm dialog. |
3953 | (not (and (eq (framep-on-display) 'ns) | |
3954 | (listp last-nonmenu-event) | |
3955 | use-dialog-box)) | |
9aea757b | 3956 | (or (y-or-n-p (format "File `%s' exists; overwrite? " filename)) |
c2fb8488 | 3957 | (error "Canceled"))) |
5f65549e | 3958 | (set-visited-file-name filename (not confirm)))) |
b4da00e9 | 3959 | (set-buffer-modified-p t) |
6492b55d KH |
3960 | ;; Make buffer writable if file is writable. |
3961 | (and buffer-file-name | |
3962 | (file-writable-p buffer-file-name) | |
3963 | (setq buffer-read-only nil)) | |
8e5c7b90 SM |
3964 | (save-buffer) |
3965 | ;; It's likely that the VC status at the new location is different from | |
3966 | ;; the one at the old location. | |
3967 | (vc-find-file-hook)) | |
b4da00e9 | 3968 | \f |
7c3d167f RF |
3969 | (defun file-extended-attributes (filename) |
3970 | "Return an alist of extended attributes of file FILENAME. | |
3971 | ||
3972 | Extended attributes are platform-specific metadata about the file, | |
3973 | such as SELinux context, list of ACL entries, etc." | |
3974 | `((acl . ,(file-acl filename)) | |
3975 | (selinux-context . ,(file-selinux-context filename)))) | |
3976 | ||
3977 | (defun set-file-extended-attributes (filename attributes) | |
3978 | "Set extended attributes of file FILENAME to ATTRIBUTES. | |
3979 | ||
3980 | ATTRIBUTES must be an alist of file attributes as returned by | |
3981 | `file-extended-attributes'." | |
3982 | (dolist (elt attributes) | |
3983 | (let ((attr (car elt)) | |
3984 | (val (cdr elt))) | |
3985 | (cond ((eq attr 'acl) | |
3986 | (set-file-acl filename val)) | |
3987 | ((eq attr 'selinux-context) | |
3988 | (set-file-selinux-context filename val)))))) | |
3989 | \f | |
b4da00e9 RM |
3990 | (defun backup-buffer () |
3991 | "Make a backup of the disk file visited by the current buffer, if appropriate. | |
3992 | This is normally done before saving the buffer the first time. | |
27ab6944 KH |
3993 | |
3994 | A backup may be done by renaming or by copying; see documentation of | |
3995 | variable `make-backup-files'. If it's done by renaming, then the file is | |
f3f9e207 RS |
3996 | no longer accessible under its old name. |
3997 | ||
3998 | The value is non-nil after a backup was made by renaming. | |
7c3d167f | 3999 | It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME). |
f3f9e207 RS |
4000 | MODES is the result of `file-modes' on the original |
4001 | file; this means that the caller, after saving the buffer, should change | |
4002 | the modes of the new file to agree with the old modes. | |
7c3d167f RF |
4003 | EXTENDED-ATTRIBUTES is the result of `file-extended-attributes' |
4004 | on the original file; this means that the caller, after saving | |
4005 | the buffer, should change the extended attributes of the new file | |
4006 | to agree with the old attributes. | |
f3f9e207 | 4007 | BACKUPNAME is the backup file name, which is the old file renamed." |
b4da00e9 RM |
4008 | (if (and make-backup-files (not backup-inhibited) |
4009 | (not buffer-backed-up) | |
4010 | (file-exists-p buffer-file-name) | |
4011 | (memq (aref (elt (file-attributes buffer-file-name) 8) 0) | |
4012 | '(?- ?l))) | |
4013 | (let ((real-file-name buffer-file-name) | |
4014 | backup-info backupname targets setmodes) | |
4015 | ;; If specified name is a symbolic link, chase it to the target. | |
4016 | ;; Thus we make the backups in the directory where the real file is. | |
5dadeb29 | 4017 | (setq real-file-name (file-chase-links real-file-name)) |
b4da00e9 RM |
4018 | (setq backup-info (find-backup-file-name real-file-name) |
4019 | backupname (car backup-info) | |
4020 | targets (cdr backup-info)) | |
5c6d31a4 SM |
4021 | ;; (if (file-directory-p buffer-file-name) |
4022 | ;; (error "Cannot save buffer in directory %s" buffer-file-name)) | |
eb650569 RS |
4023 | (if backup-info |
4024 | (condition-case () | |
4025 | (let ((delete-old-versions | |
4026 | ;; If have old versions to maybe delete, | |
4027 | ;; ask the user to confirm now, before doing anything. | |
4028 | ;; But don't actually delete til later. | |
4029 | (and targets | |
4030 | (or (eq delete-old-versions t) (eq delete-old-versions nil)) | |
4031 | (or delete-old-versions | |
9aea757b CY |
4032 | (y-or-n-p (format "Delete excess backup versions of %s? " |
4033 | real-file-name))))) | |
574c05e2 | 4034 | (modes (file-modes buffer-file-name)) |
7c3d167f RF |
4035 | (extended-attributes |
4036 | (file-extended-attributes buffer-file-name))) | |
eb650569 RS |
4037 | ;; Actually write the back up file. |
4038 | (condition-case () | |
4039 | (if (or file-precious-flag | |
ffc0e1ca | 4040 | ; (file-symlink-p buffer-file-name) |
eb650569 | 4041 | backup-by-copying |
446c63b0 | 4042 | ;; Don't rename a suid or sgid file. |
7da6bf00 | 4043 | (and modes (< 0 (logand modes #o6000))) |
79d2d279 | 4044 | (not (file-writable-p (file-name-directory real-file-name))) |
eb650569 RS |
4045 | (and backup-by-copying-when-linked |
4046 | (> (file-nlinks real-file-name) 1)) | |
ffc0e1ca AS |
4047 | (and (or backup-by-copying-when-mismatch |
4048 | (integerp backup-by-copying-when-privileged-mismatch)) | |
eb650569 | 4049 | (let ((attr (file-attributes real-file-name))) |
ffc0e1ca AS |
4050 | (and (or backup-by-copying-when-mismatch |
4051 | (and (integerp (nth 2 attr)) | |
4052 | (integerp backup-by-copying-when-privileged-mismatch) | |
4053 | (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch))) | |
97976f9f PE |
4054 | (not (file-ownership-preserved-p |
4055 | real-file-name t)))))) | |
7c3d167f RF |
4056 | (backup-buffer-copy real-file-name |
4057 | backupname modes | |
4058 | extended-attributes) | |
eb650569 RS |
4059 | ;; rename-file should delete old backup. |
4060 | (rename-file real-file-name backupname t) | |
7c3d167f RF |
4061 | (setq setmodes (list modes extended-attributes |
4062 | backupname))) | |
eb650569 | 4063 | (file-error |
b024d9f0 MD |
4064 | ;; If trouble writing the backup, write it in |
4065 | ;; .emacs.d/%backup%. | |
4066 | (setq backupname (locate-user-emacs-file "%backup%~")) | |
567c1ca9 | 4067 | (message "Cannot write backup file; backing up in %s" |
6ba7756e | 4068 | backupname) |
eb650569 | 4069 | (sleep-for 1) |
7c3d167f RF |
4070 | (backup-buffer-copy real-file-name backupname |
4071 | modes extended-attributes))) | |
eb650569 RS |
4072 | (setq buffer-backed-up t) |
4073 | ;; Now delete the old versions, if desired. | |
4074 | (if delete-old-versions | |
4075 | (while targets | |
4076 | (condition-case () | |
4077 | (delete-file (car targets)) | |
4078 | (file-error nil)) | |
4079 | (setq targets (cdr targets)))) | |
4080 | setmodes) | |
4081 | (file-error nil)))))) | |
b4da00e9 | 4082 | |
7c3d167f | 4083 | (defun backup-buffer-copy (from-name to-name modes extended-attributes) |
44dce0fb RS |
4084 | (let ((umask (default-file-modes))) |
4085 | (unwind-protect | |
4086 | (progn | |
4087 | ;; Create temp files with strict access rights. It's easy to | |
4088 | ;; loosen them later, whereas it's impossible to close the | |
4089 | ;; time-window of loose permissions otherwise. | |
4090 | (set-default-file-modes ?\700) | |
0f39d2c9 MR |
4091 | (when (condition-case nil |
4092 | ;; Try to overwrite old backup first. | |
5b2e628f | 4093 | (copy-file from-name to-name t t t) |
0f39d2c9 MR |
4094 | (error t)) |
4095 | (while (condition-case nil | |
4096 | (progn | |
4097 | (when (file-exists-p to-name) | |
4098 | (delete-file to-name)) | |
5b2e628f | 4099 | (copy-file from-name to-name nil t t) |
0f39d2c9 MR |
4100 | nil) |
4101 | (file-already-exists t)) | |
4102 | ;; The file was somehow created by someone else between | |
4103 | ;; `delete-file' and `copy-file', so let's try again. | |
4104 | ;; rms says "I think there is also a possible race | |
4105 | ;; condition for making backup files" (emacs-devel 20070821). | |
4106 | nil))) | |
44dce0fb RS |
4107 | ;; Reset the umask. |
4108 | (set-default-file-modes umask))) | |
ccad023b EZ |
4109 | ;; If set-file-extended-attributes fails, fall back on set-file-modes. |
4110 | (unless (and extended-attributes | |
4111 | (with-demoted-errors | |
4112 | (set-file-extended-attributes to-name extended-attributes))) | |
4113 | (and modes | |
4114 | (set-file-modes to-name (logand modes #o1777))))) | |
446c63b0 | 4115 | |
33cf0fb2 | 4116 | (defvar file-name-version-regexp |
2de9cc1a RT |
4117 | "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)" |
4118 | ;; The last ~[[:digit]]+ matches relative versions in git, | |
4119 | ;; e.g. `foo.js.~HEAD~1~'. | |
33cf0fb2 SM |
4120 | "Regular expression matching the backup/version part of a file name. |
4121 | Used by `file-name-sans-versions'.") | |
4122 | ||
c3554e95 | 4123 | (defun file-name-sans-versions (name &optional keep-backup-version) |
ffc0e1ca | 4124 | "Return file NAME sans backup versions or strings. |
b4da00e9 | 4125 | This is a separate procedure so your site-init or startup file can |
c3554e95 RS |
4126 | redefine it. |
4127 | If the optional argument KEEP-BACKUP-VERSION is non-nil, | |
33cf0fb2 SM |
4128 | we do not remove backup version numbers, only true file version numbers. |
4129 | See also `file-name-version-regexp'." | |
6eaebaa2 | 4130 | (let ((handler (find-file-name-handler name 'file-name-sans-versions))) |
c3554e95 RS |
4131 | (if handler |
4132 | (funcall handler 'file-name-sans-versions name keep-backup-version) | |
4133 | (substring name 0 | |
33cf0fb2 SM |
4134 | (unless keep-backup-version |
4135 | (string-match (concat file-name-version-regexp "\\'") | |
4136 | name)))))) | |
b4da00e9 | 4137 | |
97976f9f PE |
4138 | (defun file-ownership-preserved-p (file &optional group) |
4139 | "Return t if deleting FILE and rewriting it would preserve the owner. | |
4140 | Return nil if FILE does not exist, or if deleting and recreating it | |
4141 | might not preserve the owner. If GROUP is non-nil, check whether | |
4142 | the group would be preserved too." | |
cb0cd911 RS |
4143 | (let ((handler (find-file-name-handler file 'file-ownership-preserved-p))) |
4144 | (if handler | |
97976f9f | 4145 | (funcall handler 'file-ownership-preserved-p file group) |
2920e68d | 4146 | (let ((attributes (file-attributes file 'integer))) |
306faa42 RS |
4147 | ;; Return t if the file doesn't exist, since it's true that no |
4148 | ;; information would be lost by an (attempted) delete and create. | |
4149 | (or (null attributes) | |
97976f9f PE |
4150 | (and (or (= (nth 2 attributes) (user-uid)) |
4151 | ;; Files created on Windows by Administrator (RID=500) | |
4152 | ;; have the Administrators group (RID=544) recorded as | |
4153 | ;; their owner. Rewriting them will still preserve the | |
4154 | ;; owner. | |
4155 | (and (eq system-type 'windows-nt) | |
4156 | (= (user-uid) 500) (= (nth 2 attributes) 544))) | |
4157 | (or (not group) | |
4158 | ;; On BSD-derived systems files always inherit the parent | |
4159 | ;; directory's group, so skip the group-gid test. | |
4160 | (memq system-type '(berkeley-unix darwin gnu/kfreebsd)) | |
4161 | (= (nth 3 attributes) (group-gid))) | |
4162 | (let* ((parent (or (file-name-directory file) ".")) | |
4163 | (parent-attributes (file-attributes parent 'integer))) | |
4164 | (and parent-attributes | |
4165 | ;; On some systems, a file created in a setuid directory | |
4166 | ;; inherits that directory's owner. | |
4167 | (or | |
4168 | (= (nth 2 parent-attributes) (user-uid)) | |
4169 | (string-match "^...[^sS]" (nth 8 parent-attributes))) | |
4170 | ;; On many systems, a file created in a setgid directory | |
4171 | ;; inherits that directory's group. On some systems | |
4172 | ;; this happens even if the setgid bit is not set. | |
4173 | (or (not group) | |
4174 | (= (nth 3 parent-attributes) | |
4175 | (nth 3 attributes))))))))))) | |
cb0cd911 | 4176 | |
20b5d24c RS |
4177 | (defun file-name-sans-extension (filename) |
4178 | "Return FILENAME sans final \"extension\". | |
2531b0c3 EZ |
4179 | The extension, in a file name, is the part that follows the last `.', |
4180 | except that a leading `.', if any, doesn't count." | |
20b5d24c RS |
4181 | (save-match-data |
4182 | (let ((file (file-name-sans-versions (file-name-nondirectory filename))) | |
4183 | directory) | |
2531b0c3 EZ |
4184 | (if (and (string-match "\\.[^.]*\\'" file) |
4185 | (not (eq 0 (match-beginning 0)))) | |
20b5d24c | 4186 | (if (setq directory (file-name-directory filename)) |
6ee24f1e RS |
4187 | ;; Don't use expand-file-name here; if DIRECTORY is relative, |
4188 | ;; we don't want to expand it. | |
4189 | (concat directory (substring file 0 (match-beginning 0))) | |
20b5d24c RS |
4190 | (substring file 0 (match-beginning 0))) |
4191 | filename)))) | |
4192 | ||
93a2702d RS |
4193 | (defun file-name-extension (filename &optional period) |
4194 | "Return FILENAME's final \"extension\". | |
2531b0c3 | 4195 | The extension, in a file name, is the part that follows the last `.', |
32483280 | 4196 | excluding version numbers and backup suffixes, |
2531b0c3 | 4197 | except that a leading `.', if any, doesn't count. |
93a2702d RS |
4198 | Return nil for extensionless file names such as `foo'. |
4199 | Return the empty string for file names such as `foo.'. | |
4200 | ||
4201 | If PERIOD is non-nil, then the returned value includes the period | |
4202 | that delimits the extension, and if FILENAME has no extension, | |
4203 | the value is \"\"." | |
4204 | (save-match-data | |
4205 | (let ((file (file-name-sans-versions (file-name-nondirectory filename)))) | |
2531b0c3 EZ |
4206 | (if (and (string-match "\\.[^.]*\\'" file) |
4207 | (not (eq 0 (match-beginning 0)))) | |
93a2702d RS |
4208 | (substring file (+ (match-beginning 0) (if period 0 1))) |
4209 | (if period | |
4210 | ""))))) | |
4211 | ||
d2c32364 SS |
4212 | (defun file-name-base (&optional filename) |
4213 | "Return the base name of the FILENAME: no directory, no extension. | |
4214 | FILENAME defaults to `buffer-file-name'." | |
4215 | (file-name-sans-extension | |
4216 | (file-name-nondirectory (or filename (buffer-file-name))))) | |
4217 | ||
76dc5996 SM |
4218 | (defcustom make-backup-file-name-function |
4219 | #'make-backup-file-name--default-function | |
d738ebdc GM |
4220 | "A function that `make-backup-file-name' uses to create backup file names. |
4221 | The function receives a single argument, the original file name. | |
ffc0e1ca | 4222 | |
d738ebdc GM |
4223 | If you change this, you may need to change `backup-file-name-p' and |
4224 | `file-name-sans-versions' too. | |
4225 | ||
4226 | You could make this buffer-local to do something special for specific files. | |
4227 | ||
4228 | For historical reasons, a value of nil means to use the default function. | |
4229 | This should not be relied upon. | |
ffc0e1ca AS |
4230 | |
4231 | See also `backup-directory-alist'." | |
d738ebdc | 4232 | :version "24.4" ; nil -> make-backup-file-name--default-function |
ffc0e1ca | 4233 | :group 'backup |
d738ebdc GM |
4234 | :type '(choice (const :tag "Deprecated way to get the default function" nil) |
4235 | (function :tag "Function"))) | |
ffc0e1ca AS |
4236 | |
4237 | (defcustom backup-directory-alist nil | |
4238 | "Alist of filename patterns and backup directory names. | |
4239 | Each element looks like (REGEXP . DIRECTORY). Backups of files with | |
4240 | names matching REGEXP will be made in DIRECTORY. DIRECTORY may be | |
4241 | relative or absolute. If it is absolute, so that all matching files | |
4242 | are backed up into the same directory, the file names in this | |
4243 | directory will be the full name of the file backed up with all | |
4244 | directory separators changed to `!' to prevent clashes. This will not | |
4245 | work correctly if your filesystem truncates the resulting name. | |
4246 | ||
4247 | For the common case of all backups going into one directory, the alist | |
4248 | should contain a single element pairing \".\" with the appropriate | |
4249 | directory name. | |
4250 | ||
4251 | If this variable is nil, or it fails to match a filename, the backup | |
4252 | is made in the original file's directory. | |
4253 | ||
4254 | On MS-DOS filesystems without long names this variable is always | |
4255 | ignored." | |
4256 | :group 'backup | |
dca5e71d | 4257 | :type '(repeat (cons (regexp :tag "Regexp matching filename") |
ffc0e1ca AS |
4258 | (directory :tag "Backup directory name")))) |
4259 | ||
388d6ab5 RS |
4260 | (defun normal-backup-enable-predicate (name) |
4261 | "Default `backup-enable-predicate' function. | |
0c2f6dda RS |
4262 | Checks for files in `temporary-file-directory', |
4263 | `small-temporary-file-directory', and /tmp." | |
33bb237a EZ |
4264 | (let ((temporary-file-directory temporary-file-directory) |
4265 | caseless) | |
54ac5d47 | 4266 | ;; On MS-Windows, file-truename will convert short 8+3 aliases to |
33bb237a EZ |
4267 | ;; their long file-name equivalents, so compare-strings does TRT. |
4268 | (if (memq system-type '(ms-dos windows-nt)) | |
4269 | (setq temporary-file-directory (file-truename temporary-file-directory) | |
4270 | name (file-truename name) | |
4271 | caseless t)) | |
4272 | (not (or (let ((comp (compare-strings temporary-file-directory 0 nil | |
4273 | name 0 nil caseless))) | |
4274 | ;; Directory is under temporary-file-directory. | |
4275 | (and (not (eq comp t)) | |
4276 | (< comp (- (length temporary-file-directory))))) | |
4277 | (let ((comp (compare-strings "/tmp" 0 nil | |
4278 | name 0 nil))) | |
4279 | ;; Directory is under /tmp. | |
4280 | (and (not (eq comp t)) | |
4281 | (< comp (- (length "/tmp"))))) | |
4282 | (if small-temporary-file-directory | |
4283 | (let ((comp (compare-strings small-temporary-file-directory | |
4284 | 0 nil | |
4285 | name 0 nil caseless))) | |
4286 | ;; Directory is under small-temporary-file-directory. | |
4287 | (and (not (eq comp t)) | |
4288 | (< comp (- (length small-temporary-file-directory)))))))))) | |
388d6ab5 | 4289 | |
b4da00e9 RM |
4290 | (defun make-backup-file-name (file) |
4291 | "Create the non-numeric backup file name for FILE. | |
d738ebdc GM |
4292 | This calls the function that `make-backup-file-name-function' specifies, |
4293 | with a single argument FILE." | |
76dc5996 SM |
4294 | (funcall (or make-backup-file-name-function |
4295 | #'make-backup-file-name--default-function) | |
4296 | file)) | |
4297 | ||
4298 | (defun make-backup-file-name--default-function (file) | |
d738ebdc GM |
4299 | "Default function for `make-backup-file-name'. |
4300 | Normally this just returns FILE's name with `~' appended. | |
4301 | It searches for a match for FILE in `backup-directory-alist'. | |
4302 | If the directory for the backup doesn't exist, it is created." | |
76dc5996 SM |
4303 | (if (and (eq system-type 'ms-dos) |
4304 | (not (msdos-long-file-names))) | |
4305 | (let ((fn (file-name-nondirectory file))) | |
4306 | (concat (file-name-directory file) | |
4307 | (or (and (string-match "\\`[^.]+\\'" fn) | |
4308 | (concat (match-string 0 fn) ".~")) | |
4309 | (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn) | |
4310 | (concat (match-string 0 fn) "~"))))) | |
4311 | (concat (make-backup-file-name-1 file) "~"))) | |
ffc0e1ca AS |
4312 | |
4313 | (defun make-backup-file-name-1 (file) | |
d738ebdc GM |
4314 | "Subroutine of `make-backup-file-name--default-function'. |
4315 | The function `find-backup-file-name' also uses this." | |
ffc0e1ca | 4316 | (let ((alist backup-directory-alist) |
6ba7756e | 4317 | elt backup-directory abs-backup-directory) |
ffc0e1ca AS |
4318 | (while alist |
4319 | (setq elt (pop alist)) | |
4320 | (if (string-match (car elt) file) | |
4321 | (setq backup-directory (cdr elt) | |
4322 | alist nil))) | |
eb0455ab RS |
4323 | ;; If backup-directory is relative, it should be relative to the |
4324 | ;; file's directory. By expanding explicitly here, we avoid | |
4325 | ;; depending on default-directory. | |
4326 | (if backup-directory | |
6ba7756e RS |
4327 | (setq abs-backup-directory |
4328 | (expand-file-name backup-directory | |
4329 | (file-name-directory file)))) | |
4330 | (if (and abs-backup-directory (not (file-exists-p abs-backup-directory))) | |
ffc0e1ca | 4331 | (condition-case nil |
6ba7756e RS |
4332 | (make-directory abs-backup-directory 'parents) |
4333 | (file-error (setq backup-directory nil | |
4334 | abs-backup-directory nil)))) | |
ee291b46 RS |
4335 | (if (null backup-directory) |
4336 | file | |
ffc0e1ca AS |
4337 | (if (file-name-absolute-p backup-directory) |
4338 | (progn | |
c60ee5e7 | 4339 | (when (memq system-type '(windows-nt ms-dos cygwin)) |
d7b6ca4a RS |
4340 | ;; Normalize DOSish file names: downcase the drive |
4341 | ;; letter, if any, and replace the leading "x:" with | |
4342 | ;; "/drive_x". | |
ffc0e1ca AS |
4343 | (or (file-name-absolute-p file) |
4344 | (setq file (expand-file-name file))) ; make defaults explicit | |
4345 | ;; Replace any invalid file-name characters (for the | |
4346 | ;; case of backing up remote files). | |
446c097e | 4347 | (setq file (expand-file-name (convert-standard-filename file))) |
ffc0e1ca | 4348 | (if (eq (aref file 1) ?:) |
d7b6ca4a | 4349 | (setq file (concat "/" |
ffc0e1ca AS |
4350 | "drive_" |
4351 | (char-to-string (downcase (aref file 0))) | |
d7b6ca4a | 4352 | (if (eq (aref file 2) ?/) |
ffc0e1ca | 4353 | "" |
d7b6ca4a | 4354 | "/") |
ffc0e1ca AS |
4355 | (substring file 2))))) |
4356 | ;; Make the name unique by substituting directory | |
4357 | ;; separators. It may not really be worth bothering about | |
4358 | ;; doubling `!'s in the original name... | |
4359 | (expand-file-name | |
4360 | (subst-char-in-string | |
d7b6ca4a | 4361 | ?/ ?! |
ffc0e1ca AS |
4362 | (replace-regexp-in-string "!" "!!" file)) |
4363 | backup-directory)) | |
4364 | (expand-file-name (file-name-nondirectory file) | |
6ba7756e | 4365 | (file-name-as-directory abs-backup-directory)))))) |
b4da00e9 RM |
4366 | |
4367 | (defun backup-file-name-p (file) | |
4368 | "Return non-nil if FILE is a backup file name (numeric or not). | |
4369 | This is a separate function so you can redefine it for customization. | |
4370 | You may need to redefine `file-name-sans-versions' as well." | |
066327ae | 4371 | (string-match "~\\'" file)) |
b4da00e9 | 4372 | |
e2b30772 RS |
4373 | (defvar backup-extract-version-start) |
4374 | ||
2d051399 | 4375 | ;; This is used in various files. |
a7aa942a KH |
4376 | ;; The usage of backup-extract-version-start is not very clean, |
4377 | ;; but I can't see a good alternative, so as of now I am leaving it alone. | |
2d051399 | 4378 | (defun backup-extract-version (fn) |
ffc0e1ca | 4379 | "Given the name of a numeric backup file, FN, return the backup number. |
e2b30772 | 4380 | Uses the free variable `backup-extract-version-start', whose value should be |
2d051399 | 4381 | the index in the name where the version number begins." |
6cf29fe8 | 4382 | (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start) |
e2b30772 | 4383 | (= (match-beginning 0) backup-extract-version-start)) |
027a4b6b | 4384 | (string-to-number (substring fn backup-extract-version-start -1)) |
2d051399 RS |
4385 | 0)) |
4386 | ||
b4da00e9 | 4387 | (defun find-backup-file-name (fn) |
ffc0e1ca | 4388 | "Find a file name for a backup file FN, and suggestions for deletions. |
b4da00e9 | 4389 | Value is a list whose car is the name for the backup file |
ffc0e1ca AS |
4390 | and whose cdr is a list of old versions to consider deleting now. |
4391 | If the value is nil, don't make a backup. | |
d738ebdc GM |
4392 | Uses `backup-directory-alist' in the same way as |
4393 | `make-backup-file-name--default-function' does." | |
eb650569 RS |
4394 | (let ((handler (find-file-name-handler fn 'find-backup-file-name))) |
4395 | ;; Run a handler for this function so that ange-ftp can refuse to do it. | |
4396 | (if handler | |
4397 | (funcall handler 'find-backup-file-name fn) | |
f26d858e EZ |
4398 | (if (or (eq version-control 'never) |
4399 | ;; We don't support numbered backups on plain MS-DOS | |
4400 | ;; when long file names are unavailable. | |
4401 | (and (eq system-type 'ms-dos) | |
4402 | (not (msdos-long-file-names)))) | |
b4da00e9 | 4403 | (list (make-backup-file-name fn)) |
ffc0e1ca AS |
4404 | (let* ((basic-name (make-backup-file-name-1 fn)) |
4405 | (base-versions (concat (file-name-nondirectory basic-name) | |
4406 | ".~")) | |
e2b30772 | 4407 | (backup-extract-version-start (length base-versions)) |
eb650569 | 4408 | (high-water-mark 0) |
ffc0e1ca AS |
4409 | (number-to-delete 0) |
4410 | possibilities deserve-versions-p versions) | |
eb650569 RS |
4411 | (condition-case () |
4412 | (setq possibilities (file-name-all-completions | |
4413 | base-versions | |
ffc0e1ca AS |
4414 | (file-name-directory basic-name)) |
4415 | versions (sort (mapcar #'backup-extract-version | |
4416 | possibilities) | |
4417 | #'<) | |
eb650569 RS |
4418 | high-water-mark (apply 'max 0 versions) |
4419 | deserve-versions-p (or version-control | |
4420 | (> high-water-mark 0)) | |
4421 | number-to-delete (- (length versions) | |
ffc0e1ca AS |
4422 | kept-old-versions |
4423 | kept-new-versions | |
4424 | -1)) | |
4425 | (file-error (setq possibilities nil))) | |
eb650569 | 4426 | (if (not deserve-versions-p) |
8767d866 | 4427 | (list (make-backup-file-name fn)) |
ffc0e1ca | 4428 | (cons (format "%s.~%d~" basic-name (1+ high-water-mark)) |
eb650569 RS |
4429 | (if (and (> number-to-delete 0) |
4430 | ;; Delete nothing if there is overflow | |
4431 | ;; in the number of versions to keep. | |
4432 | (>= (+ kept-new-versions kept-old-versions -1) 0)) | |
ffc0e1ca AS |
4433 | (mapcar (lambda (n) |
4434 | (format "%s.~%d~" basic-name n)) | |
eb650569 RS |
4435 | (let ((v (nthcdr kept-old-versions versions))) |
4436 | (rplacd (nthcdr (1- number-to-delete) v) ()) | |
4437 | v)))))))))) | |
b4da00e9 | 4438 | |
b4da00e9 RM |
4439 | (defun file-nlinks (filename) |
4440 | "Return number of names file FILENAME has." | |
4441 | (car (cdr (file-attributes filename)))) | |
6c636af9 | 4442 | |
753ad988 KG |
4443 | ;; (defun file-relative-name (filename &optional directory) |
4444 | ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). | |
4445 | ;; This function returns a relative file name which is equivalent to FILENAME | |
4446 | ;; when used with that default directory as the default. | |
4447 | ;; If this is impossible (which can happen on MSDOS and Windows | |
4448 | ;; when the file name and directory use different drive names) | |
4449 | ;; then it returns FILENAME." | |
4450 | ;; (save-match-data | |
4451 | ;; (let ((fname (expand-file-name filename))) | |
4452 | ;; (setq directory (file-name-as-directory | |
4453 | ;; (expand-file-name (or directory default-directory)))) | |
4454 | ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different | |
4455 | ;; ;; drive names, they can't be relative, so return the absolute name. | |
4456 | ;; (if (and (or (eq system-type 'ms-dos) | |
4457 | ;; (eq system-type 'cygwin) | |
4458 | ;; (eq system-type 'windows-nt)) | |
4459 | ;; (not (string-equal (substring fname 0 2) | |
4460 | ;; (substring directory 0 2)))) | |
4461 | ;; filename | |
4462 | ;; (let ((ancestor ".") | |
4463 | ;; (fname-dir (file-name-as-directory fname))) | |
4464 | ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir)) | |
4465 | ;; (not (string-match (concat "^" (regexp-quote directory)) fname))) | |
4466 | ;; (setq directory (file-name-directory (substring directory 0 -1)) | |
4467 | ;; ancestor (if (equal ancestor ".") | |
4468 | ;; ".." | |
4469 | ;; (concat "../" ancestor)))) | |
4470 | ;; ;; Now ancestor is empty, or .., or ../.., etc. | |
4471 | ;; (if (string-match (concat "^" (regexp-quote directory)) fname) | |
4472 | ;; ;; We matched within FNAME's directory part. | |
4473 | ;; ;; Add the rest of FNAME onto ANCESTOR. | |
4474 | ;; (let ((rest (substring fname (match-end 0)))) | |
4475 | ;; (if (and (equal ancestor ".") | |
4476 | ;; (not (equal rest ""))) | |
4477 | ;; ;; But don't bother with ANCESTOR if it would give us `./'. | |
4478 | ;; rest | |
4479 | ;; (concat (file-name-as-directory ancestor) rest))) | |
4480 | ;; ;; We matched FNAME's directory equivalent. | |
4481 | ;; ancestor)))))) | |
4482 | ||
6c636af9 | 4483 | (defun file-relative-name (filename &optional directory) |
ffc0e1ca | 4484 | "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). |
2d6562a5 RS |
4485 | This function returns a relative file name which is equivalent to FILENAME |
4486 | when used with that default directory as the default. | |
15cb9968 LI |
4487 | If FILENAME is a relative file name, it will be interpreted as existing in |
4488 | `default-directory'. | |
753ad988 | 4489 | If FILENAME and DIRECTORY lie on different machines or on different drives |
1be0210d | 4490 | on a DOS/Windows machine, it returns FILENAME in expanded form." |
96c188b0 | 4491 | (save-match-data |
753ad988 KG |
4492 | (setq directory |
4493 | (file-name-as-directory (expand-file-name (or directory | |
4494 | default-directory)))) | |
4495 | (setq filename (expand-file-name filename)) | |
3f788773 | 4496 | (let ((fremote (file-remote-p filename)) |
93842198 EZ |
4497 | (dremote (file-remote-p directory)) |
4498 | (fold-case (or (memq system-type '(ms-dos cygwin windows-nt)) | |
4499 | read-file-name-completion-ignore-case))) | |
493c98af KG |
4500 | (if ;; Conditions for separate trees |
4501 | (or | |
2472c214 | 4502 | ;; Test for different filesystems on DOS/Windows |
493c98af | 4503 | (and |
7c64272b | 4504 | ;; Should `cygwin' really be included here? --stef |
493c98af | 4505 | (memq system-type '(ms-dos cygwin windows-nt)) |
2472c214 EZ |
4506 | (or |
4507 | ;; Test for different drive letters | |
93842198 | 4508 | (not (eq t (compare-strings filename 0 2 directory 0 2 fold-case))) |
2472c214 EZ |
4509 | ;; Test for UNCs on different servers |
4510 | (not (eq t (compare-strings | |
4511 | (progn | |
4512 | (if (string-match "\\`//\\([^:/]+\\)/" filename) | |
4513 | (match-string 1 filename) | |
4514 | ;; Windows file names cannot have ? in | |
4515 | ;; them, so use that to detect when | |
4516 | ;; neither FILENAME nor DIRECTORY is a | |
4517 | ;; UNC. | |
4518 | "?")) | |
4519 | 0 nil | |
4520 | (progn | |
4521 | (if (string-match "\\`//\\([^:/]+\\)/" directory) | |
4522 | (match-string 1 directory) | |
4523 | "?")) | |
4524 | 0 nil t))))) | |
493c98af | 4525 | ;; Test for different remote file system identification |
3f788773 | 4526 | (not (equal fremote dremote))) |
e2b30772 | 4527 | filename |
753ad988 KG |
4528 | (let ((ancestor ".") |
4529 | (filename-dir (file-name-as-directory filename))) | |
7c64272b SM |
4530 | (while (not |
4531 | (or | |
4532 | (eq t (compare-strings filename-dir nil (length directory) | |
93842198 | 4533 | directory nil nil fold-case)) |
7c64272b | 4534 | (eq t (compare-strings filename nil (length directory) |
93842198 | 4535 | directory nil nil fold-case)))) |
753ad988 | 4536 | (setq directory (file-name-directory (substring directory 0 -1)) |
9695aac6 RS |
4537 | ancestor (if (equal ancestor ".") |
4538 | ".." | |
4539 | (concat "../" ancestor)))) | |
753ad988 | 4540 | ;; Now ancestor is empty, or .., or ../.., etc. |
7c64272b | 4541 | (if (eq t (compare-strings filename nil (length directory) |
93842198 | 4542 | directory nil nil fold-case)) |
753ad988 KG |
4543 | ;; We matched within FILENAME's directory part. |
4544 | ;; Add the rest of FILENAME onto ANCESTOR. | |
3f7d6528 | 4545 | (let ((rest (substring filename (length directory)))) |
753ad988 | 4546 | (if (and (equal ancestor ".") (not (equal rest ""))) |
9695aac6 RS |
4547 | ;; But don't bother with ANCESTOR if it would give us `./'. |
4548 | rest | |
4549 | (concat (file-name-as-directory ancestor) rest))) | |
753ad988 KG |
4550 | ;; We matched FILENAME's directory equivalent. |
4551 | ancestor)))))) | |
b4da00e9 | 4552 | \f |
468ef484 | 4553 | (defun save-buffer (&optional arg) |
e8f4db18 RS |
4554 | "Save current buffer in visited file if modified. |
4555 | Variations are described below. | |
4556 | ||
b4da00e9 RM |
4557 | By default, makes the previous version into a backup file |
4558 | if previously requested or if this is the first save. | |
dc2ab26e | 4559 | Prefixed with one \\[universal-argument], marks this version |
b4da00e9 | 4560 | to become a backup when the next save is done. |
dc2ab26e | 4561 | Prefixed with two \\[universal-argument]'s, |
b4da00e9 | 4562 | unconditionally makes the previous version into a backup file. |
dc2ab26e | 4563 | Prefixed with three \\[universal-argument]'s, marks this version |
ac9650be RS |
4564 | to become a backup when the next save is done, |
4565 | and unconditionally makes the previous version into a backup file. | |
4566 | ||
7e34193f | 4567 | With a numeric prefix argument of 0, never make the previous version |
dc2ab26e | 4568 | into a backup file. |
b4da00e9 RM |
4569 | |
4570 | If a file's name is FOO, the names of its numbered backup versions are | |
4571 | FOO.~i~ for various integers i. A non-numbered backup file is called FOO~. | |
4572 | Numeric backups (rather than FOO~) will be made if value of | |
4573 | `version-control' is not the atom `never' and either there are already | |
4574 | numeric versions of the file being backed up, or `version-control' is | |
4575 | non-nil. | |
4576 | We don't want excessive versions piling up, so there are variables | |
4577 | `kept-old-versions', which tells Emacs how many oldest versions to keep, | |
4578 | and `kept-new-versions', which tells how many newest versions to keep. | |
4579 | Defaults are 2 old versions and 2 new. | |
4580 | `dired-kept-versions' controls dired's clean-directory (.) command. | |
de7d5e1b | 4581 | If `delete-old-versions' is nil, system will query user |
e73ec04b RS |
4582 | before trimming versions. Otherwise it does it silently. |
4583 | ||
749d2ee6 RS |
4584 | If `vc-make-backup-files' is nil, which is the default, |
4585 | no backup files are made for files managed by version control. | |
4586 | (This is because the version control system itself records previous versions.) | |
4587 | ||
e73ec04b | 4588 | See the subroutine `basic-save-buffer' for more information." |
b4da00e9 RM |
4589 | (interactive "p") |
4590 | (let ((modp (buffer-modified-p)) | |
468ef484 LI |
4591 | (make-backup-files (or (and make-backup-files (not (eq arg 0))) |
4592 | (memq arg '(16 64))))) | |
4593 | (and modp (memq arg '(16 64)) (setq buffer-backed-up nil)) | |
86a30352 EZ |
4594 | ;; We used to display the message below only for files > 50KB, but |
4595 | ;; then Rmail-mbox never displays it due to buffer swapping. If | |
4596 | ;; the test is ever re-introduced, be sure to handle saving of | |
4597 | ;; Rmail files. | |
4598 | (if (and modp (buffer-file-name)) | |
b4990dde | 4599 | (message "Saving file %s..." (buffer-file-name))) |
b4da00e9 | 4600 | (basic-save-buffer) |
468ef484 | 4601 | (and modp (memq arg '(4 64)) (setq buffer-backed-up nil)))) |
b4da00e9 RM |
4602 | |
4603 | (defun delete-auto-save-file-if-necessary (&optional force) | |
4604 | "Delete auto-save file for current buffer if `delete-auto-save-files' is t. | |
4605 | Normally delete only if the file was written by this Emacs since | |
4606 | the last real save, but optional arg FORCE non-nil means delete anyway." | |
4607 | (and buffer-auto-save-file-name delete-auto-save-files | |
4608 | (not (string= buffer-file-name buffer-auto-save-file-name)) | |
4609 | (or force (recent-auto-save-p)) | |
4610 | (progn | |
4611 | (condition-case () | |
4612 | (delete-file buffer-auto-save-file-name) | |
4613 | (file-error nil)) | |
4614 | (set-buffer-auto-saved)))) | |
4615 | ||
481f215b KH |
4616 | (defvar auto-save-hook nil |
4617 | "Normal hook run just before auto-saving.") | |
4618 | ||
3c3b81d1 SJ |
4619 | (defcustom before-save-hook nil |
4620 | "Normal hook that is run before a buffer is saved to its file." | |
25f6295e | 4621 | :options '(copyright-update time-stamp) |
3c3b81d1 SJ |
4622 | :type 'hook |
4623 | :group 'files) | |
4624 | ||
ffc0e1ca AS |
4625 | (defcustom after-save-hook nil |
4626 | "Normal hook that is run after a buffer is saved to its file." | |
4627 | :options '(executable-make-buffer-file-executable-if-script-p) | |
4628 | :type 'hook | |
4629 | :group 'files) | |
1cc852cc | 4630 | |
0516edee RS |
4631 | (defvar save-buffer-coding-system nil |
4632 | "If non-nil, use this coding system for saving the buffer. | |
4633 | More precisely, use this coding system in place of the | |
4634 | value of `buffer-file-coding-system', when saving the buffer. | |
4635 | Calling `write-region' for any purpose other than saving the buffer | |
4636 | will still use `buffer-file-coding-system'; this variable has no effect | |
4637 | in such cases.") | |
4638 | ||
d5fe94cc RS |
4639 | (make-variable-buffer-local 'save-buffer-coding-system) |
4640 | (put 'save-buffer-coding-system 'permanent-local t) | |
4641 | ||
b4da00e9 | 4642 | (defun basic-save-buffer () |
1cc852cc | 4643 | "Save the current buffer in its visited file, if it has been modified. |
0370fe77 SM |
4644 | The hooks `write-contents-functions' and `write-file-functions' get a chance |
4645 | to do the job of saving; if they do not, then the buffer is saved in | |
222cf381 | 4646 | the visited file in the usual way. |
3c3b81d1 SJ |
4647 | Before and after saving the buffer, this function runs |
4648 | `before-save-hook' and `after-save-hook', respectively." | |
b4da00e9 | 4649 | (interactive) |
19618231 | 4650 | (save-current-buffer |
c11a94fe RS |
4651 | ;; In an indirect buffer, save its base buffer instead. |
4652 | (if (buffer-base-buffer) | |
4653 | (set-buffer (buffer-base-buffer))) | |
75d1d833 BG |
4654 | (if (or (buffer-modified-p) |
4655 | ;; handle the case when no modification has been made but | |
4656 | ;; the file disappeared since visited | |
4657 | (and buffer-file-name | |
4658 | (not (file-exists-p buffer-file-name)))) | |
c11a94fe | 4659 | (let ((recent-save (recent-auto-save-p)) |
818286f4 | 4660 | setmodes) |
944c37ef | 4661 | ;; If buffer has no file name, ask user for one. |
b367ec7b | 4662 | (or buffer-file-name |
944c37ef SM |
4663 | (let ((filename |
4664 | (expand-file-name | |
4665 | (read-file-name "File to save in: " | |
4666 | nil (expand-file-name (buffer-name)))))) | |
4667 | (if (file-exists-p filename) | |
4668 | (if (file-directory-p filename) | |
4669 | ;; Signal an error if the user specified the name of an | |
4670 | ;; existing directory. | |
4671 | (error "%s is a directory" filename) | |
4672 | (unless (y-or-n-p (format "File `%s' exists; overwrite? " | |
4673 | filename)) | |
4674 | (error "Canceled")))) | |
4675 | (set-visited-file-name filename))) | |
c11a94fe RS |
4676 | (or (verify-visited-file-modtime (current-buffer)) |
4677 | (not (file-exists-p buffer-file-name)) | |
4678 | (yes-or-no-p | |
9aea757b CY |
4679 | (format |
4680 | "%s has changed since visited or saved. Save anyway? " | |
4681 | (file-name-nondirectory buffer-file-name))) | |
71873e2b | 4682 | (user-error "Save not confirmed")) |
c11a94fe RS |
4683 | (save-restriction |
4684 | (widen) | |
19618231 | 4685 | (save-excursion |
0370fe77 | 4686 | (and (> (point-max) (point-min)) |
407b4328 | 4687 | (not find-file-literally) |
19618231 RS |
4688 | (/= (char-after (1- (point-max))) ?\n) |
4689 | (not (and (eq selective-display t) | |
4690 | (= (char-after (1- (point-max))) ?\r))) | |
4691 | (or (eq require-final-newline t) | |
f4206092 | 4692 | (eq require-final-newline 'visit-save) |
19618231 RS |
4693 | (and require-final-newline |
4694 | (y-or-n-p | |
9aea757b CY |
4695 | (format "Buffer %s does not end in newline. Add one? " |
4696 | (buffer-name))))) | |
19618231 RS |
4697 | (save-excursion |
4698 | (goto-char (point-max)) | |
4699 | (insert ?\n)))) | |
fa5867f6 AS |
4700 | ;; Support VC version backups. |
4701 | (vc-before-save) | |
b7260dd4 LL |
4702 | ;; Don't let errors prevent saving the buffer. |
4703 | (with-demoted-errors (run-hooks 'before-save-hook)) | |
0370fe77 | 4704 | (or (run-hook-with-args-until-success 'write-contents-functions) |
c11a94fe | 4705 | (run-hook-with-args-until-success 'local-write-file-hooks) |
0370fe77 | 4706 | (run-hook-with-args-until-success 'write-file-functions) |
0ba5894b RS |
4707 | ;; If a hook returned t, file is already "written". |
4708 | ;; Otherwise, write it the usual way now. | |
b367ec7b GM |
4709 | (let ((dir (file-name-directory |
4710 | (expand-file-name buffer-file-name)))) | |
4711 | (unless (file-exists-p dir) | |
4712 | (if (y-or-n-p | |
4713 | (format "Directory `%s' does not exist; create? " dir)) | |
4714 | (make-directory dir t) | |
4715 | (error "Canceled"))) | |
4716 | (setq setmodes (basic-save-buffer-1)))) | |
d6e8ea6f KH |
4717 | ;; Now we have saved the current buffer. Let's make sure |
4718 | ;; that buffer-file-coding-system is fixed to what | |
4719 | ;; actually used for saving by binding it locally. | |
0516edee RS |
4720 | (if save-buffer-coding-system |
4721 | (setq save-buffer-coding-system last-coding-system-used) | |
4722 | (setq buffer-file-coding-system last-coding-system-used)) | |
2a47b4f5 RS |
4723 | (setq buffer-file-number |
4724 | (nthcdr 10 (file-attributes buffer-file-name))) | |
c11a94fe RS |
4725 | (if setmodes |
4726 | (condition-case () | |
574c05e2 | 4727 | (progn |
7e56b103 EZ |
4728 | (unless |
4729 | (with-demoted-errors | |
4730 | (set-file-modes buffer-file-name (car setmodes))) | |
4731 | (set-file-extended-attributes buffer-file-name | |
4732 | (nth 1 setmodes)))) | |
c11a94fe RS |
4733 | (error nil)))) |
4734 | ;; If the auto-save file was recent before this command, | |
4735 | ;; delete it now. | |
4736 | (delete-auto-save-file-if-necessary recent-save) | |
49530862 RS |
4737 | ;; Support VC `implicit' locking. |
4738 | (vc-after-save) | |
c11a94fe RS |
4739 | (run-hooks 'after-save-hook)) |
4740 | (message "(No changes need to be saved)")))) | |
b4da00e9 | 4741 | |
87d26afc RS |
4742 | ;; This does the "real job" of writing a buffer into its visited file |
4743 | ;; and making a backup file. This is what is normally done | |
0370fe77 | 4744 | ;; but inhibited if one of write-file-functions returns non-nil. |
7c3d167f RF |
4745 | ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like |
4746 | ;; backup-buffer. | |
87d26afc | 4747 | (defun basic-save-buffer-1 () |
969be033 RS |
4748 | (prog1 |
4749 | (if save-buffer-coding-system | |
4750 | (let ((coding-system-for-write save-buffer-coding-system)) | |
4751 | (basic-save-buffer-2)) | |
d5fe94cc | 4752 | (basic-save-buffer-2)) |
86c507f7 | 4753 | (if buffer-file-coding-system-explicit |
0ccdf61e | 4754 | (setcar buffer-file-coding-system-explicit last-coding-system-used)))) |
d5fe94cc | 4755 | |
7c3d167f RF |
4756 | ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like |
4757 | ;; backup-buffer. | |
d5fe94cc | 4758 | (defun basic-save-buffer-2 () |
9dbda100 | 4759 | (let (tempsetmodes setmodes writecoding) |
87d26afc RS |
4760 | (if (not (file-writable-p buffer-file-name)) |
4761 | (let ((dir (file-name-directory buffer-file-name))) | |
4762 | (if (not (file-directory-p dir)) | |
83c6f446 RS |
4763 | (if (file-exists-p dir) |
4764 | (error "%s is not a directory" dir) | |
87c60260 | 4765 | (error "%s: no such directory" dir)) |
87d26afc RS |
4766 | (if (not (file-exists-p buffer-file-name)) |
4767 | (error "Directory %s write-protected" dir) | |
4768 | (if (yes-or-no-p | |
9aea757b CY |
4769 | (format |
4770 | "File %s is write-protected; try to save anyway? " | |
4771 | (file-name-nondirectory | |
4772 | buffer-file-name))) | |
87d26afc RS |
4773 | (setq tempsetmodes t) |
4774 | (error "Attempt to save to a file which you aren't allowed to write")))))) | |
9dbda100 GM |
4775 | ;; This may involve prompting, so do it now before backing up the file. |
4776 | ;; Otherwise there can be a delay while the user answers the | |
4777 | ;; prompt during which the original file has been renamed. (Bug#13522) | |
4778 | (setq writecoding | |
4779 | ;; Args here should match write-region call below around | |
4780 | ;; which we use writecoding. | |
4781 | (choose-write-coding-system nil nil buffer-file-name nil t | |
4782 | buffer-file-truename)) | |
87d26afc RS |
4783 | (or buffer-backed-up |
4784 | (setq setmodes (backup-buffer))) | |
1d367309 KF |
4785 | (let* ((dir (file-name-directory buffer-file-name)) |
4786 | (dir-writable (file-writable-p dir))) | |
4787 | (if (or (and file-precious-flag dir-writable) | |
4788 | (and break-hardlink-on-save | |
35fd0881 | 4789 | (file-exists-p buffer-file-name) |
1d367309 KF |
4790 | (> (file-nlinks buffer-file-name) 1) |
4791 | (or dir-writable | |
4792 | (error (concat (format | |
4793 | "Directory %s write-protected; " dir) | |
4794 | "cannot break hardlink when saving"))))) | |
4795 | ;; Write temp name, then rename it. | |
f4a0f59b RS |
4796 | ;; This requires write access to the containing dir, |
4797 | ;; which is why we don't try it if we don't have that access. | |
4798 | (let ((realname buffer-file-name) | |
44dce0fb RS |
4799 | tempname succeed |
4800 | (umask (default-file-modes)) | |
6782610c | 4801 | (old-modtime (visited-file-modtime))) |
44dce0fb RS |
4802 | ;; Create temp files with strict access rights. It's easy to |
4803 | ;; loosen them later, whereas it's impossible to close the | |
4804 | ;; time-window of loose permissions otherwise. | |
f4a0f59b | 4805 | (unwind-protect |
44dce0fb RS |
4806 | (progn |
4807 | (clear-visited-file-modtime) | |
4808 | (set-default-file-modes ?\700) | |
4809 | ;; Try various temporary names. | |
4810 | ;; This code follows the example of make-temp-file, | |
4811 | ;; but it calls write-region in the appropriate way | |
4812 | ;; for saving the buffer. | |
4813 | (while (condition-case () | |
4814 | (progn | |
4815 | (setq tempname | |
4816 | (make-temp-name | |
4817 | (expand-file-name "tmp" dir))) | |
6b3d752c SM |
4818 | ;; Pass in nil&nil rather than point-min&max |
4819 | ;; cause we're saving the whole buffer. | |
4820 | ;; write-region-annotate-functions may use it. | |
4821 | (write-region nil nil | |
44dce0fb RS |
4822 | tempname nil realname |
4823 | buffer-file-truename 'excl) | |
4824 | nil) | |
4825 | (file-already-exists t)) | |
4826 | ;; The file was somehow created by someone else between | |
4827 | ;; `make-temp-name' and `write-region', let's try again. | |
4828 | nil) | |
4829 | (setq succeed t)) | |
4830 | ;; Reset the umask. | |
4831 | (set-default-file-modes umask) | |
4832 | ;; If we failed, restore the buffer's modtime. | |
4833 | (unless succeed | |
4834 | (set-visited-file-modtime old-modtime))) | |
4835 | ;; Since we have created an entirely new file, | |
4836 | ;; make sure it gets the right permission bits set. | |
730df8db | 4837 | (setq setmodes (or setmodes |
574c05e2 | 4838 | (list (or (file-modes buffer-file-name) |
562ca538 | 4839 | (logand ?\666 umask)) |
7c3d167f | 4840 | (file-extended-attributes buffer-file-name) |
730df8db | 4841 | buffer-file-name))) |
f4a0f59b RS |
4842 | ;; We succeeded in writing the temp file, |
4843 | ;; so rename it. | |
4844 | (rename-file tempname buffer-file-name t)) | |
4845 | ;; If file not writable, see if we can make it writable | |
4846 | ;; temporarily while we write it. | |
4847 | ;; But no need to do so if we have just backed it up | |
4848 | ;; (setmodes is set) because that says we're superseding. | |
4849 | (cond ((and tempsetmodes (not setmodes)) | |
4850 | ;; Change the mode back, after writing. | |
574c05e2 | 4851 | (setq setmodes (list (file-modes buffer-file-name) |
7c3d167f | 4852 | (file-extended-attributes buffer-file-name) |
574c05e2 | 4853 | buffer-file-name)) |
ccad023b EZ |
4854 | ;; If set-file-extended-attributes fails, fall back on |
4855 | ;; set-file-modes. | |
4856 | (unless | |
4857 | (with-demoted-errors | |
4858 | (set-file-extended-attributes buffer-file-name | |
4859 | (nth 1 setmodes))) | |
4860 | (set-file-modes buffer-file-name | |
4861 | (logior (car setmodes) 128)))))) | |
f3f9e207 RS |
4862 | (let (success) |
4863 | (unwind-protect | |
6b3d752c SM |
4864 | ;; Pass in nil&nil rather than point-min&max to indicate |
4865 | ;; we're saving the buffer rather than just a region. | |
4866 | ;; write-region-annotate-functions may make us of it. | |
9dbda100 GM |
4867 | (let ((coding-system-for-write writecoding) |
4868 | (coding-system-require-warning nil)) | |
6b3d752c | 4869 | (write-region nil nil |
f3f9e207 RS |
4870 | buffer-file-name nil t buffer-file-truename) |
4871 | (setq success t)) | |
4872 | ;; If we get an error writing the new file, and we made | |
4873 | ;; the backup by renaming, undo the backing-up. | |
4874 | (and setmodes (not success) | |
0133dab9 | 4875 | (progn |
574c05e2 KK |
4876 | (rename-file (nth 2 setmodes) buffer-file-name t) |
4877 | (setq buffer-backed-up nil)))))) | |
87d26afc RS |
4878 | setmodes)) |
4879 | ||
66f782de GM |
4880 | (declare-function diff-no-select "diff" |
4881 | (old new &optional switches no-async buf)) | |
4882 | ||
1eeae2a1 | 4883 | (defvar save-some-buffers-action-alist |
9b106871 SM |
4884 | `((?\C-r |
4885 | ,(lambda (buf) | |
4886 | (if (not enable-recursive-minibuffers) | |
4887 | (progn (display-buffer buf) | |
4888 | (setq other-window-scroll-buffer buf)) | |
4889 | (view-buffer buf (lambda (_) (exit-recursive-edit))) | |
4890 | (recursive-edit)) | |
4891 | ;; Return nil to ask about BUF again. | |
4892 | nil) | |
ca0a881a | 4893 | ,(purecopy "view this buffer")) |
9b106871 | 4894 | (?d ,(lambda (buf) |
b9330108 | 4895 | (if (null (buffer-file-name buf)) |
9b106871 | 4896 | (message "Not applicable: no file") |
b2e44819 SM |
4897 | (require 'diff) ;for diff-no-select. |
4898 | (let ((diffbuf (diff-no-select (buffer-file-name buf) buf | |
4899 | nil 'noasync))) | |
4900 | (if (not enable-recursive-minibuffers) | |
4901 | (progn (display-buffer diffbuf) | |
4902 | (setq other-window-scroll-buffer diffbuf)) | |
4903 | (view-buffer diffbuf (lambda (_) (exit-recursive-edit))) | |
4904 | (recursive-edit)))) | |
9b106871 SM |
4905 | ;; Return nil to ask about BUF again. |
4906 | nil) | |
ca0a881a | 4907 | ,(purecopy "view changes in this buffer"))) |
1eeae2a1 | 4908 | "ACTION-ALIST argument used in call to `map-y-or-n-p'.") |
3029e594 | 4909 | (put 'save-some-buffers-action-alist 'risky-local-variable t) |
1eeae2a1 | 4910 | |
a1b0c2a7 RS |
4911 | (defvar buffer-save-without-query nil |
4912 | "Non-nil means `save-some-buffers' should save this buffer without asking.") | |
4913 | (make-variable-buffer-local 'buffer-save-without-query) | |
4914 | ||
ffc0e1ca | 4915 | (defun save-some-buffers (&optional arg pred) |
b4da00e9 | 4916 | "Save some modified file-visiting buffers. Asks user about each one. |
1eeae2a1 RS |
4917 | You can answer `y' to save, `n' not to save, `C-r' to look at the |
4918 | buffer in question with `view-buffer' before deciding or `d' to | |
126c9dda | 4919 | view the differences using `diff-buffer-with-file'. |
8fd9c174 | 4920 | |
afa8e9f6 GM |
4921 | This command first saves any buffers where `buffer-save-without-query' is |
4922 | non-nil, without asking. | |
4923 | ||
5bbbceb1 | 4924 | Optional argument (the prefix) non-nil means save all with no questions. |
ffc0e1ca AS |
4925 | Optional second argument PRED determines which buffers are considered: |
4926 | If PRED is nil, all the file-visiting buffers are considered. | |
4927 | If PRED is t, then certain non-file buffers will also be considered. | |
4928 | If PRED is a zero-argument function, it indicates for each buffer whether | |
1eeae2a1 RS |
4929 | to consider it or not when called with that buffer current. |
4930 | ||
4931 | See `save-some-buffers-action-alist' if you want to | |
4932 | change the additional actions you can take on files." | |
b4da00e9 | 4933 | (interactive "P") |
907482b9 | 4934 | (save-window-excursion |
c5f09daf | 4935 | (let* (queried autosaved-buffers |
a1b0c2a7 RS |
4936 | files-done abbrevs-done) |
4937 | (dolist (buffer (buffer-list)) | |
4938 | ;; First save any buffers that we're supposed to save unconditionally. | |
4939 | ;; That way the following code won't ask about them. | |
4940 | (with-current-buffer buffer | |
4941 | (when (and buffer-save-without-query (buffer-modified-p)) | |
c5f09daf | 4942 | (push (buffer-name) autosaved-buffers) |
a1b0c2a7 RS |
4943 | (save-buffer)))) |
4944 | ;; Ask about those buffers that merit it, | |
4945 | ;; and record the number thus saved. | |
4946 | (setq files-done | |
76d5492b | 4947 | (map-y-or-n-p |
9b106871 | 4948 | (lambda (buffer) |
be9acc26 CY |
4949 | ;; Note that killing some buffers may kill others via |
4950 | ;; hooks (e.g. Rmail and its viewing buffer). | |
4951 | (and (buffer-live-p buffer) | |
4952 | (buffer-modified-p buffer) | |
9b106871 SM |
4953 | (not (buffer-base-buffer buffer)) |
4954 | (or | |
4955 | (buffer-file-name buffer) | |
4956 | (and pred | |
4957 | (progn | |
4958 | (set-buffer buffer) | |
4959 | (and buffer-offer-save (> (buffer-size) 0))))) | |
4960 | (or (not (functionp pred)) | |
4961 | (with-current-buffer buffer (funcall pred))) | |
4962 | (if arg | |
4963 | t | |
4964 | (setq queried t) | |
4965 | (if (buffer-file-name buffer) | |
4966 | (format "Save file %s? " | |
4967 | (buffer-file-name buffer)) | |
4968 | (format "Save buffer %s? " | |
4969 | (buffer-name buffer)))))) | |
4970 | (lambda (buffer) | |
4971 | (with-current-buffer buffer | |
4972 | (save-buffer))) | |
4973 | (buffer-list) | |
76d5492b | 4974 | '("buffer" "buffers" "save") |
1eeae2a1 | 4975 | save-some-buffers-action-alist)) |
bf247b6e | 4976 | ;; Maybe to save abbrevs, and record whether |
a1b0c2a7 RS |
4977 | ;; we either saved them or asked to. |
4978 | (and save-abbrevs abbrevs-changed | |
4979 | (progn | |
4980 | (if (or arg | |
4981 | (eq save-abbrevs 'silently) | |
9aea757b | 4982 | (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name))) |
a1b0c2a7 RS |
4983 | (write-abbrev-file nil)) |
4984 | ;; Don't keep bothering user if he says no. | |
4985 | (setq abbrevs-changed nil) | |
4986 | (setq abbrevs-done t))) | |
76d5492b | 4987 | (or queried (> files-done 0) abbrevs-done |
c5f09daf DE |
4988 | (cond |
4989 | ((null autosaved-buffers) | |
4990 | (message "(No files need saving)")) | |
4991 | ((= (length autosaved-buffers) 1) | |
4992 | (message "(Saved %s)" (car autosaved-buffers))) | |
4993 | (t | |
4994 | (message "(Saved %d files: %s)" | |
4995 | (length autosaved-buffers) | |
4996 | (mapconcat 'identity autosaved-buffers ", ")))))))) | |
b4da00e9 | 4997 | \f |
954b166e PE |
4998 | (defun clear-visited-file-modtime () |
4999 | "Clear out records of last mod time of visited file. | |
5000 | Next attempt to save will certainly not complain of a discrepancy." | |
5001 | (set-visited-file-modtime 0)) | |
5002 | ||
b4da00e9 RM |
5003 | (defun not-modified (&optional arg) |
5004 | "Mark current buffer as unmodified, not needing to be saved. | |
8fc29035 | 5005 | With prefix ARG, mark buffer as modified, so \\[save-buffer] will save. |
a641f9a1 RM |
5006 | |
5007 | It is not a good idea to use this function in Lisp programs, because it | |
5008 | prints a message in the minibuffer. Instead, use `set-buffer-modified-p'." | |
b4da00e9 RM |
5009 | (interactive "P") |
5010 | (message (if arg "Modification-flag set" | |
5011 | "Modification-flag cleared")) | |
5012 | (set-buffer-modified-p arg)) | |
5013 | ||
35e62fc9 SM |
5014 | (defun toggle-read-only (&optional arg interactive) |
5015 | (declare (obsolete read-only-mode "24.3")) | |
5016 | (interactive (list current-prefix-arg t)) | |
5017 | (if interactive | |
5018 | (call-interactively 'read-only-mode) | |
5019 | (read-only-mode (or arg 'toggle)))) | |
b4da00e9 | 5020 | |
912192d1 | 5021 | (defun insert-file (filename) |
b4da00e9 RM |
5022 | "Insert contents of file FILENAME into buffer after point. |
5023 | Set mark after the inserted text. | |
5024 | ||
5025 | This function is meant for the user to run interactively. | |
5026 | Don't call it from programs! Use `insert-file-contents' instead. | |
5027 | \(Its calling sequence is different; see its documentation)." | |
912192d1 | 5028 | (interactive "*fInsert file: ") |
3a64a3cf | 5029 | (insert-file-1 filename #'insert-file-contents)) |
3e2fb4db | 5030 | (put 'insert-file 'interactive-only 'insert-file-contents) |
b4da00e9 | 5031 | |
912192d1 | 5032 | (defun append-to-file (start end filename) |
b4da00e9 RM |
5033 | "Append the contents of the region to the end of file FILENAME. |
5034 | When called from a function, expects three arguments, | |
d8c0d419 EZ |
5035 | START, END and FILENAME. START and END are normally buffer positions |
5036 | specifying the part of the buffer to write. | |
5037 | If START is nil, that means to use the entire buffer contents. | |
5038 | If START is a string, then output that string to the file | |
5039 | instead of any buffer contents; END is ignored. | |
5040 | ||
5041 | This does character code conversion and applies annotations | |
5042 | like `write-region' does." | |
912192d1 KH |
5043 | (interactive "r\nFAppend to file: ") |
5044 | (write-region start end filename t)) | |
b4da00e9 RM |
5045 | |
5046 | (defun file-newest-backup (filename) | |
5047 | "Return most recent backup file for FILENAME or nil if no backups exist." | |
ffc0e1ca AS |
5048 | ;; `make-backup-file-name' will get us the right directory for |
5049 | ;; ordinary or numeric backups. It might create a directory for | |
5050 | ;; backups as a side-effect, according to `backup-directory-alist'. | |
e31cfca5 | 5051 | (let* ((filename (file-name-sans-versions |
783bf210 | 5052 | (make-backup-file-name (expand-file-name filename)))) |
b4da00e9 RM |
5053 | (file (file-name-nondirectory filename)) |
5054 | (dir (file-name-directory filename)) | |
5055 | (comp (file-name-all-completions file dir)) | |
cf7e94a0 RS |
5056 | (newest nil) |
5057 | tem) | |
b4da00e9 | 5058 | (while comp |
ffc0e1ca | 5059 | (setq tem (pop comp)) |
cf7e94a0 RS |
5060 | (cond ((and (backup-file-name-p tem) |
5061 | (string= (file-name-sans-versions tem) file)) | |
5062 | (setq tem (concat dir tem)) | |
5063 | (if (or (null newest) | |
5064 | (file-newer-than-file-p tem newest)) | |
5065 | (setq newest tem))))) | |
b4da00e9 RM |
5066 | newest)) |
5067 | ||
5068 | (defun rename-uniquely () | |
5069 | "Rename current buffer to a similar name not already taken. | |
5070 | This function is useful for creating multiple shell process buffers | |
cf3aa21b GM |
5071 | or multiple mail buffers, etc. |
5072 | ||
5073 | Note that some commands, in particular those based on `compilation-mode' | |
5074 | \(`compile', `grep', etc.) will reuse the current buffer if it has the | |
5075 | appropriate mode even if it has been renamed. So as well as renaming | |
5076 | the buffer, you also need to switch buffers before running another | |
5077 | instance of such commands." | |
b4da00e9 | 5078 | (interactive) |
40eb8038 | 5079 | (save-match-data |
e0df3aef KH |
5080 | (let ((base-name (buffer-name))) |
5081 | (and (string-match "<[0-9]+>\\'" base-name) | |
5082 | (not (and buffer-file-name | |
5083 | (string= base-name | |
5084 | (file-name-nondirectory buffer-file-name)))) | |
5085 | ;; If the existing buffer name has a <NNN>, | |
5086 | ;; which isn't part of the file name (if any), | |
5087 | ;; then get rid of that. | |
5088 | (setq base-name (substring base-name 0 (match-beginning 0)))) | |
5089 | (rename-buffer (generate-new-buffer-name base-name)) | |
3941fe2c | 5090 | (force-mode-line-update)))) |
5bbbceb1 | 5091 | |
4e43240a | 5092 | (defun make-directory (dir &optional parents) |
9d1f18b5 EZ |
5093 | "Create the directory DIR and optionally any nonexistent parent dirs. |
5094 | If DIR already exists as a directory, signal an error, unless | |
5095 | PARENTS is non-nil. | |
789cb0f9 | 5096 | |
9d1f18b5 EZ |
5097 | Interactively, the default choice of directory to create is the |
5098 | current buffer's default directory. That is useful when you have | |
5099 | visited a file in a nonexistent directory. | |
5ce8bb89 | 5100 | |
9d1f18b5 EZ |
5101 | Noninteractively, the second (optional) argument PARENTS, if |
5102 | non-nil, says whether to create parent directories that don't | |
bd2fcc8d LMI |
5103 | exist. Interactively, this happens by default. |
5104 | ||
5105 | If creating the directory or directories fail, an error will be | |
5106 | raised." | |
5ce8bb89 RS |
5107 | (interactive |
5108 | (list (read-file-name "Make directory: " default-directory default-directory | |
5109 | nil nil) | |
5110 | t)) | |
ee291b46 RS |
5111 | ;; If default-directory is a remote directory, |
5112 | ;; make sure we find its make-directory handler. | |
5113 | (setq dir (expand-file-name dir)) | |
6eaebaa2 | 5114 | (let ((handler (find-file-name-handler dir 'make-directory))) |
4e43240a RS |
5115 | (if handler |
5116 | (funcall handler 'make-directory dir parents) | |
5117 | (if (not parents) | |
5118 | (make-directory-internal dir) | |
5119 | (let ((dir (directory-file-name (expand-file-name dir))) | |
5120 | create-list) | |
bb4a52db JR |
5121 | (while (and (not (file-exists-p dir)) |
5122 | ;; If directory is its own parent, then we can't | |
5123 | ;; keep looping forever | |
5124 | (not (equal dir | |
5125 | (directory-file-name | |
5126 | (file-name-directory dir))))) | |
76d5492b | 5127 | (setq create-list (cons dir create-list) |
4e43240a RS |
5128 | dir (directory-file-name (file-name-directory dir)))) |
5129 | (while create-list | |
5130 | (make-directory-internal (car create-list)) | |
5131 | (setq create-list (cdr create-list)))))))) | |
96ad4c35 | 5132 | |
0e1f2ee6 MA |
5133 | (defconst directory-files-no-dot-files-regexp |
5134 | "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*" | |
1603358c | 5135 | "Regexp matching any file name except \".\" and \"..\".") |
0e1f2ee6 | 5136 | |
f1a5d776 | 5137 | (defun delete-directory (directory &optional recursive trash) |
96ad4c35 | 5138 | "Delete the directory named DIRECTORY. Does not follow symlinks. |
f1a5d776 CY |
5139 | If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well. |
5140 | TRASH non-nil means to trash the directory instead, provided | |
5141 | `delete-by-moving-to-trash' is non-nil. | |
5142 | ||
5143 | When called interactively, TRASH is t if no prefix argument is | |
5144 | given. With a prefix argument, TRASH is nil." | |
96ad4c35 | 5145 | (interactive |
f1a5d776 CY |
5146 | (let* ((trashing (and delete-by-moving-to-trash |
5147 | (null current-prefix-arg))) | |
5148 | (dir (expand-file-name | |
7e27ce9c | 5149 | (read-directory-name |
f1a5d776 CY |
5150 | (if trashing |
5151 | "Move directory to trash: " | |
5152 | "Delete directory: ") | |
5153 | default-directory default-directory nil nil)))) | |
96ad4c35 | 5154 | (list dir |
0e1f2ee6 | 5155 | (if (directory-files dir nil directory-files-no-dot-files-regexp) |
96ad4c35 | 5156 | (y-or-n-p |
9aea757b CY |
5157 | (format "Directory `%s' is not empty, really %s? " |
5158 | dir (if trashing "trash" "delete"))) | |
f1a5d776 CY |
5159 | nil) |
5160 | (null current-prefix-arg)))) | |
8e692050 MA |
5161 | ;; If default-directory is a remote directory, make sure we find its |
5162 | ;; delete-directory handler. | |
96ad4c35 MA |
5163 | (setq directory (directory-file-name (expand-file-name directory))) |
5164 | (let ((handler (find-file-name-handler directory 'delete-directory))) | |
8b0e68ea CY |
5165 | (cond |
5166 | (handler | |
5167 | (funcall handler 'delete-directory directory recursive)) | |
f1a5d776 | 5168 | ((and delete-by-moving-to-trash trash) |
8b0e68ea CY |
5169 | ;; Only move non-empty dir to trash if recursive deletion was |
5170 | ;; requested. This mimics the non-`delete-by-moving-to-trash' | |
5171 | ;; case, where the operation fails in delete-directory-internal. | |
5172 | ;; As `move-file-to-trash' trashes directories (empty or | |
5173 | ;; otherwise) as a unit, we do not need to recurse here. | |
5174 | (if (and (not recursive) | |
5175 | ;; Check if directory is empty apart from "." and "..". | |
5176 | (directory-files | |
5177 | directory 'full directory-files-no-dot-files-regexp)) | |
5178 | (error "Directory is not empty, not moving to trash") | |
5179 | (move-file-to-trash directory))) | |
c80e3b4a | 5180 | ;; Otherwise, call ourselves recursively if needed. |
8b0e68ea | 5181 | (t |
96ad4c35 | 5182 | (if (and recursive (not (file-symlink-p directory))) |
8b0e68ea CY |
5183 | (mapc (lambda (file) |
5184 | ;; This test is equivalent to | |
5185 | ;; (and (file-directory-p fn) (not (file-symlink-p fn))) | |
5186 | ;; but more efficient | |
5187 | (if (eq t (car (file-attributes file))) | |
f1a5d776 CY |
5188 | (delete-directory file recursive nil) |
5189 | (delete-file file nil))) | |
8b0e68ea CY |
5190 | ;; We do not want to delete "." and "..". |
5191 | (directory-files | |
1d78a746 CY |
5192 | directory 'full directory-files-no-dot-files-regexp))) |
5193 | (delete-directory-internal directory))))) | |
96ad4c35 | 5194 | |
96b49301 | 5195 | (defun file-equal-p (file1 file2) |
a032a702 MA |
5196 | "Return non-nil if files FILE1 and FILE2 name the same file. |
5197 | If FILE1 or FILE2 does not exist, the return value is unspecified." | |
96b49301 | 5198 | (let ((handler (or (find-file-name-handler file1 'file-equal-p) |
5199 | (find-file-name-handler file2 'file-equal-p)))) | |
25b2e303 | 5200 | (if handler |
96b49301 | 5201 | (funcall handler 'file-equal-p file1 file2) |
a032a702 MA |
5202 | (let (f1-attr f2-attr) |
5203 | (and (setq f1-attr (file-attributes (file-truename file1))) | |
5204 | (setq f2-attr (file-attributes (file-truename file2))) | |
5205 | (equal f1-attr f2-attr)))))) | |
25b2e303 | 5206 | |
42ee526b CY |
5207 | (defun file-in-directory-p (file dir) |
5208 | "Return non-nil if FILE is in DIR or a subdirectory of DIR. | |
5209 | A directory is considered to be \"in\" itself. | |
5210 | Return nil if DIR is not an existing directory." | |
5211 | (let ((handler (or (find-file-name-handler file 'file-in-directory-p) | |
5212 | (find-file-name-handler dir 'file-in-directory-p)))) | |
25b2e303 | 5213 | (if handler |
42ee526b CY |
5214 | (funcall handler 'file-in-directory-p file dir) |
5215 | (when (file-directory-p dir) ; DIR must exist. | |
5216 | (setq file (file-truename file) | |
5217 | dir (file-truename dir)) | |
5218 | (let ((ls1 (split-string file "/" t)) | |
5219 | (ls2 (split-string dir "/" t)) | |
5220 | (root (if (string-match "\\`/" file) "/" "")) | |
9a4888c0 CY |
5221 | (mismatch nil)) |
5222 | (while (and ls1 ls2 (not mismatch)) | |
5223 | (if (string-equal (car ls1) (car ls2)) | |
5224 | (setq root (concat root (car ls1) "/")) | |
5225 | (setq mismatch t)) | |
5226 | (setq ls1 (cdr ls1) | |
5227 | ls2 (cdr ls2))) | |
5228 | (unless mismatch | |
42ee526b | 5229 | (file-equal-p root dir))))))) |
25b2e303 | 5230 | |
470d996d | 5231 | (defun copy-directory (directory newname &optional keep-time parents copy-contents) |
8e692050 | 5232 | "Copy DIRECTORY to NEWNAME. Both args must be strings. |
8e692050 MA |
5233 | This function always sets the file modes of the output files to match |
5234 | the corresponding input file. | |
5235 | ||
5236 | The third arg KEEP-TIME non-nil means give the output files the same | |
5237 | last-modified time as the old ones. (This works on only some systems.) | |
5238 | ||
5239 | A prefix arg makes KEEP-TIME non-nil. | |
5240 | ||
8e692050 MA |
5241 | Noninteractively, the last argument PARENTS says whether to |
5242 | create parent directories if they don't exist. Interactively, | |
470d996d TV |
5243 | this happens by default. |
5244 | ||
5245 | If NEWNAME names an existing directory, copy DIRECTORY as a | |
5246 | subdirectory there. However, if called from Lisp with a non-nil | |
5247 | optional argument COPY-CONTENTS, copy the contents of DIRECTORY | |
5248 | directly into NEWNAME instead." | |
8e692050 MA |
5249 | (interactive |
5250 | (let ((dir (read-directory-name | |
5251 | "Copy directory: " default-directory default-directory t nil))) | |
5252 | (list dir | |
7e27ce9c | 5253 | (read-directory-name |
8e692050 MA |
5254 | (format "Copy directory %s to: " dir) |
5255 | default-directory default-directory nil nil) | |
470d996d | 5256 | current-prefix-arg t nil))) |
42ee526b | 5257 | (when (file-in-directory-p newname directory) |
25b2e303 | 5258 | (error "Cannot copy `%s' into its subdirectory `%s'" |
5259 | directory newname)) | |
8e692050 MA |
5260 | ;; If default-directory is a remote directory, make sure we find its |
5261 | ;; copy-directory handler. | |
5262 | (let ((handler (or (find-file-name-handler directory 'copy-directory) | |
5263 | (find-file-name-handler newname 'copy-directory)))) | |
5264 | (if handler | |
25b2e303 | 5265 | (funcall handler 'copy-directory directory |
5266 | newname keep-time parents copy-contents) | |
8e692050 MA |
5267 | |
5268 | ;; Compute target name. | |
5269 | (setq directory (directory-file-name (expand-file-name directory)) | |
5270 | newname (directory-file-name (expand-file-name newname))) | |
82d84d3f | 5271 | |
470d996d TV |
5272 | (cond ((not (file-directory-p newname)) |
5273 | ;; If NEWNAME is not an existing directory, create it; | |
5274 | ;; that is where we will copy the files of DIRECTORY. | |
96b49301 | 5275 | (make-directory newname parents)) |
470d996d TV |
5276 | ;; If NEWNAME is an existing directory and COPY-CONTENTS |
5277 | ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME]. | |
5278 | ((not copy-contents) | |
5279 | (setq newname (expand-file-name | |
5280 | (file-name-nondirectory | |
5281 | (directory-file-name directory)) | |
5282 | newname)) | |
5283 | (and (file-exists-p newname) | |
5284 | (not (file-directory-p newname)) | |
5285 | (error "Cannot overwrite non-directory %s with a directory" | |
5286 | newname)) | |
5287 | (make-directory newname t))) | |
0e1f2ee6 | 5288 | |
8e692050 | 5289 | ;; Copy recursively. |
6fa1f651 CY |
5290 | (dolist (file |
5291 | ;; We do not want to copy "." and "..". | |
5292 | (directory-files directory 'full | |
5293 | directory-files-no-dot-files-regexp)) | |
40311efc TV |
5294 | (let ((target (expand-file-name (file-name-nondirectory file) newname)) |
5295 | (filetype (car (file-attributes file)))) | |
5296 | (cond | |
5297 | ((eq filetype t) ; Directory but not a symlink. | |
5298 | (copy-directory file newname keep-time parents)) | |
5299 | ((stringp filetype) ; Symbolic link | |
5300 | (make-symbolic-link filetype target t)) | |
5301 | ((copy-file file target t keep-time))))) | |
8e692050 MA |
5302 | |
5303 | ;; Set directory attributes. | |
e74f1bb6 MA |
5304 | (let ((modes (file-modes directory)) |
5305 | (times (and keep-time (nth 5 (file-attributes directory))))) | |
5306 | (if modes (set-file-modes newname modes)) | |
5307 | (if times (set-file-times newname times)))))) | |
ead5edc0 GM |
5308 | |
5309 | \f | |
5310 | ;; At time of writing, only info uses this. | |
5311 | (defun prune-directory-list (dirs &optional keep reject) | |
5312 | "Return a copy of DIRS with all non-existent directories removed. | |
5313 | The optional argument KEEP is a list of directories to retain even if | |
5314 | they don't exist, and REJECT is a list of directories to remove from | |
5315 | DIRS, even if they exist; REJECT takes precedence over KEEP. | |
5316 | ||
5317 | Note that membership in REJECT and KEEP is checked using simple string | |
5318 | comparison." | |
5319 | (apply #'nconc | |
5320 | (mapcar (lambda (dir) | |
5321 | (and (not (member dir reject)) | |
5322 | (or (member dir keep) (file-directory-p dir)) | |
5323 | (list dir))) | |
5324 | dirs))) | |
5325 | ||
b4da00e9 RM |
5326 | \f |
5327 | (put 'revert-buffer-function 'permanent-local t) | |
ac93e56b | 5328 | (defvar revert-buffer-function #'revert-buffer--default |
d738ebdc | 5329 | "Function to use to revert this buffer. |
0973d78b | 5330 | The function receives two arguments IGNORE-AUTO and NOCONFIRM, |
ac93e56b SM |
5331 | which are the arguments that `revert-buffer' received. |
5332 | It also has access to the `preserve-modes' argument of `revert-buffer' | |
d738ebdc GM |
5333 | via the `revert-buffer-preserve-modes' dynamic variable. |
5334 | ||
5335 | For historical reasons, a value of nil means to use the default function. | |
5336 | This should not be relied upon.") | |
b4da00e9 RM |
5337 | |
5338 | (put 'revert-buffer-insert-file-contents-function 'permanent-local t) | |
76dc5996 SM |
5339 | (defvar revert-buffer-insert-file-contents-function |
5340 | #'revert-buffer-insert-file-contents--default-function | |
b4da00e9 | 5341 | "Function to use to insert contents when reverting this buffer. |
d738ebdc GM |
5342 | The function receives two arguments: the first the nominal file name to use; |
5343 | the second is t if reading the auto-save file. | |
2df32500 | 5344 | |
d738ebdc GM |
5345 | The function is responsible for updating (or preserving) point. |
5346 | ||
5347 | For historical reasons, a value of nil means to use the default function. | |
5348 | This should not be relied upon.") | |
b4da00e9 | 5349 | |
76dc5996 | 5350 | (defun buffer-stale--default-function (&optional _noconfirm) |
d738ebdc GM |
5351 | "Default function to use for `buffer-stale-function'. |
5352 | This function ignores its argument. | |
5353 | This returns non-nil if the current buffer is visiting a readable file | |
8a1d24b1 GM |
5354 | whose modification time does not match that of the buffer. |
5355 | ||
5356 | This function only handles buffers that are visiting files. | |
5357 | Non-file buffers need a custom function" | |
76dc5996 SM |
5358 | (and buffer-file-name |
5359 | (file-readable-p buffer-file-name) | |
5360 | (not (verify-visited-file-modtime (current-buffer))))) | |
5361 | ||
5362 | (defvar buffer-stale-function #'buffer-stale--default-function | |
8a1d24b1 | 5363 | "Function to check whether a buffer needs reverting. |
b0dc9757 | 5364 | This should be a function with one optional argument NOCONFIRM. |
44dce0fb | 5365 | Auto Revert Mode passes t for NOCONFIRM. The function should return |
8b0b6932 LT |
5366 | non-nil if the buffer should be reverted. A return value of |
5367 | `fast' means that the need for reverting was not checked, but | |
5368 | that reverting the buffer is fast. The buffer is current when | |
5369 | this function is called. | |
b0dc9757 | 5370 | |
4f8453ae LT |
5371 | The idea behind the NOCONFIRM argument is that it should be |
5372 | non-nil if the buffer is going to be reverted without asking the | |
5373 | user. In such situations, one has to be careful with potentially | |
c90dcdd5 LT |
5374 | time consuming operations. |
5375 | ||
d738ebdc GM |
5376 | For historical reasons, a value of nil means to use the default function. |
5377 | This should not be relied upon. | |
5378 | ||
c90dcdd5 | 5379 | For more information on how this variable is used by Auto Revert mode, |
b3a59350 | 5380 | see Info node `(emacs)Supporting additional buffers'.") |
b0dc9757 | 5381 | |
5f76e7d4 KH |
5382 | (defvar before-revert-hook nil |
5383 | "Normal hook for `revert-buffer' to run before reverting. | |
d738ebdc GM |
5384 | The function `revert-buffer--default' runs this. |
5385 | A customized `revert-buffer-function' need not run this hook.") | |
5f76e7d4 KH |
5386 | |
5387 | (defvar after-revert-hook nil | |
5388 | "Normal hook for `revert-buffer' to run after reverting. | |
5389 | Note that the hook value that it runs is the value that was in effect | |
5390 | before reverting; that makes a difference if you have buffer-local | |
5391 | hook functions. | |
5392 | ||
d738ebdc GM |
5393 | The function `revert-buffer--default' runs this. |
5394 | A customized `revert-buffer-function' need not run this hook.") | |
5f76e7d4 | 5395 | |
3e214b50 | 5396 | (defvar revert-buffer-in-progress-p nil |
d738ebdc | 5397 | "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.") |
3e214b50 | 5398 | |
1554c03b RS |
5399 | (defvar revert-buffer-internal-hook) |
5400 | ||
ac93e56b SM |
5401 | ;; `revert-buffer-function' was defined long ago to be a function of only |
5402 | ;; 2 arguments, so we have to use a dynbind variable to pass the | |
5403 | ;; `preserve-modes' argument of `revert-buffer'. | |
5404 | (defvar revert-buffer-preserve-modes) | |
5405 | ||
9a30563f | 5406 | (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes) |
7e7c9c4e | 5407 | "Replace current buffer text with the text of the visited file on disk. |
b4da00e9 | 5408 | This undoes all changes since the file was visited or saved. |
8c0e7b73 JB |
5409 | With a prefix argument, offer to revert from latest auto-save file, if |
5410 | that is more recent than the visited file. | |
1ab31687 | 5411 | |
0dff8975 VJL |
5412 | This command also implements an interface for special buffers |
5413 | that contain text which doesn't come from a file, but reflects | |
5414 | some other data instead (e.g. Dired buffers, `buffer-list' | |
8fc29035 JB |
5415 | buffers). This is done via the variable `revert-buffer-function'. |
5416 | In these cases, it should reconstruct the buffer contents from the | |
5417 | appropriate data. | |
7e7c9c4e | 5418 | |
65ee6096 | 5419 | When called from Lisp, the first argument is IGNORE-AUTO; only offer |
1ab31687 JB |
5420 | to revert from the auto-save file when this is nil. Note that the |
5421 | sense of this argument is the reverse of the prefix argument, for the | |
5422 | sake of backward compatibility. IGNORE-AUTO is optional, defaulting | |
5423 | to nil. | |
5424 | ||
8fc29035 | 5425 | Optional second argument NOCONFIRM means don't ask for confirmation |
06b60517 | 5426 | at all. (The variable `revert-without-query' offers another way to |
518dc5be | 5427 | revert buffers without querying for confirmation.) |
b4da00e9 | 5428 | |
5b2b26d5 RS |
5429 | Optional third argument PRESERVE-MODES non-nil means don't alter |
5430 | the files modes. Normally we reinitialize them using `normal-mode'. | |
5431 | ||
8f05da42 GM |
5432 | This function binds `revert-buffer-in-progress-p' non-nil while it operates. |
5433 | ||
d738ebdc GM |
5434 | This function calls the function that `revert-buffer-function' specifies |
5435 | to do the work, with arguments IGNORE-AUTO and NOCONFIRM. | |
5436 | The default function runs the hooks `before-revert-hook' and | |
5437 | `after-revert-hook'." | |
1ab31687 JB |
5438 | ;; I admit it's odd to reverse the sense of the prefix argument, but |
5439 | ;; there is a lot of code out there which assumes that the first | |
5440 | ;; argument should be t to avoid consulting the auto-save file, and | |
5441 | ;; there's no straightforward way to encourage authors to notice a | |
5442 | ;; reversal of the argument sense. So I'm just changing the user | |
5443 | ;; interface, but leaving the programmatic interface the same. | |
e0867e99 | 5444 | (interactive (list (not current-prefix-arg))) |
ac93e56b SM |
5445 | (let ((revert-buffer-in-progress-p t) |
5446 | (revert-buffer-preserve-modes preserve-modes)) | |
5447 | (funcall (or revert-buffer-function #'revert-buffer--default) | |
5448 | ignore-auto noconfirm))) | |
d738ebdc | 5449 | |
ac93e56b | 5450 | (defun revert-buffer--default (ignore-auto noconfirm) |
d738ebdc GM |
5451 | "Default function for `revert-buffer'. |
5452 | The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'. | |
5453 | Runs the hooks `before-revert-hook' and `after-revert-hook' at the | |
5454 | start and end. | |
5455 | ||
5456 | Calls `revert-buffer-insert-file-contents-function' to reread the | |
5457 | contents of the visited file, with two arguments: the first is the file | |
8a1d24b1 GM |
5458 | name, the second is non-nil if reading an auto-save file. |
5459 | ||
5460 | This function only handles buffers that are visiting files. | |
5461 | Non-file buffers need a custom function." | |
ac93e56b SM |
5462 | (with-current-buffer (or (buffer-base-buffer (current-buffer)) |
5463 | (current-buffer)) | |
5464 | (let* ((auto-save-p (and (not ignore-auto) | |
5465 | (recent-auto-save-p) | |
5466 | buffer-auto-save-file-name | |
5467 | (file-readable-p buffer-auto-save-file-name) | |
5468 | (y-or-n-p | |
5469 | "Buffer has been auto-saved recently. Revert from auto-save file? "))) | |
5470 | (file-name (if auto-save-p | |
5471 | buffer-auto-save-file-name | |
5472 | buffer-file-name))) | |
5473 | (cond ((null file-name) | |
5474 | (error "Buffer does not seem to be associated with any file")) | |
5475 | ((or noconfirm | |
5476 | (and (not (buffer-modified-p)) | |
5477 | (catch 'found | |
5478 | (dolist (regexp revert-without-query) | |
5479 | (when (string-match regexp file-name) | |
5480 | (throw 'found t))))) | |
5481 | (yes-or-no-p (format "Revert buffer from file %s? " | |
5482 | file-name))) | |
5483 | (run-hooks 'before-revert-hook) | |
5484 | ;; If file was backed up but has changed since, | |
5485 | ;; we should make another backup. | |
5486 | (and (not auto-save-p) | |
5487 | (not (verify-visited-file-modtime (current-buffer))) | |
5488 | (setq buffer-backed-up nil)) | |
5489 | ;; Effectively copy the after-revert-hook status, | |
5490 | ;; since after-find-file will clobber it. | |
5491 | (let ((global-hook (default-value 'after-revert-hook)) | |
5492 | (local-hook (when (local-variable-p 'after-revert-hook) | |
5493 | after-revert-hook)) | |
5494 | (inhibit-read-only t)) | |
76dc5996 SM |
5495 | ;; FIXME: Throw away undo-log when preserve-modes is nil? |
5496 | (funcall | |
5497 | (or revert-buffer-insert-file-contents-function | |
5498 | #'revert-buffer-insert-file-contents--default-function) | |
5499 | file-name auto-save-p) | |
ac93e56b SM |
5500 | ;; Recompute the truename in case changes in symlinks |
5501 | ;; have changed the truename. | |
5502 | (setq buffer-file-truename | |
5503 | (abbreviate-file-name (file-truename buffer-file-name))) | |
5504 | (after-find-file nil nil t nil revert-buffer-preserve-modes) | |
5505 | ;; Run after-revert-hook as it was before we reverted. | |
5506 | (setq-default revert-buffer-internal-hook global-hook) | |
5507 | (if local-hook | |
5508 | (set (make-local-variable 'revert-buffer-internal-hook) | |
5509 | local-hook) | |
5510 | (kill-local-variable 'revert-buffer-internal-hook)) | |
5511 | (run-hooks 'revert-buffer-internal-hook)) | |
5512 | t))))) | |
b4da00e9 | 5513 | |
76dc5996 | 5514 | (defun revert-buffer-insert-file-contents--default-function (file-name auto-save-p) |
d738ebdc GM |
5515 | "Default function for `revert-buffer-insert-file-contents-function'. |
5516 | The function `revert-buffer--default' calls this. | |
5517 | FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is | |
5518 | an auto-save file." | |
76dc5996 SM |
5519 | (cond |
5520 | ((not (file-exists-p file-name)) | |
5521 | (error (if buffer-file-number | |
5522 | "File %s no longer exists!" | |
5523 | "Cannot revert nonexistent file %s") | |
5524 | file-name)) | |
5525 | ((not (file-readable-p file-name)) | |
5526 | (error (if buffer-file-number | |
5527 | "File %s no longer readable!" | |
5528 | "Cannot revert unreadable file %s") | |
5529 | file-name)) | |
5530 | (t | |
5531 | ;; Bind buffer-file-name to nil | |
5532 | ;; so that we don't try to lock the file. | |
5533 | (let ((buffer-file-name nil)) | |
5534 | (or auto-save-p | |
5535 | (unlock-buffer))) | |
5536 | (widen) | |
5537 | (let ((coding-system-for-read | |
5538 | ;; Auto-saved file should be read by Emacs's | |
5539 | ;; internal coding. | |
5540 | (if auto-save-p 'auto-save-coding | |
5541 | (or coding-system-for-read | |
5542 | (and | |
5543 | buffer-file-coding-system-explicit | |
5544 | (car buffer-file-coding-system-explicit)))))) | |
5545 | (if (and (not enable-multibyte-characters) | |
5546 | coding-system-for-read | |
5547 | (not (memq (coding-system-base | |
5548 | coding-system-for-read) | |
5549 | '(no-conversion raw-text)))) | |
5550 | ;; As a coding system suitable for multibyte | |
5551 | ;; buffer is specified, make the current | |
5552 | ;; buffer multibyte. | |
5553 | (set-buffer-multibyte t)) | |
5554 | ||
5555 | ;; This force after-insert-file-set-coding | |
5556 | ;; (called from insert-file-contents) to set | |
5557 | ;; buffer-file-coding-system to a proper value. | |
5558 | (kill-local-variable 'buffer-file-coding-system) | |
5559 | ||
5560 | ;; Note that this preserves point in an intelligent way. | |
5561 | (if revert-buffer-preserve-modes | |
5562 | (let ((buffer-file-format buffer-file-format)) | |
5563 | (insert-file-contents file-name (not auto-save-p) | |
5564 | nil nil t)) | |
5565 | (insert-file-contents file-name (not auto-save-p) | |
5566 | nil nil t)))))) | |
5567 | ||
64d18e8f RS |
5568 | (defun recover-this-file () |
5569 | "Recover the visited file--get contents from its last auto-save file." | |
5570 | (interactive) | |
5571 | (recover-file buffer-file-name)) | |
5572 | ||
b4da00e9 RM |
5573 | (defun recover-file (file) |
5574 | "Visit file FILE, but get contents from its last auto-save file." | |
10f7c7fc RS |
5575 | ;; Actually putting the file name in the minibuffer should be used |
5576 | ;; only rarely. | |
5577 | ;; Not just because users often use the default. | |
e1dadc17 | 5578 | (interactive "FRecover file: ") |
b4da00e9 | 5579 | (setq file (expand-file-name file)) |
f7da6740 | 5580 | (if (auto-save-file-name-p (file-name-nondirectory file)) |
4e163715 | 5581 | (error "%s is an auto-save file" (abbreviate-file-name file))) |
b4da00e9 RM |
5582 | (let ((file-name (let ((buffer-file-name file)) |
5583 | (make-auto-save-file-name)))) | |
945e1965 RS |
5584 | (cond ((if (file-exists-p file) |
5585 | (not (file-newer-than-file-p file-name file)) | |
5586 | (not (file-exists-p file-name))) | |
4e163715 SM |
5587 | (error "Auto-save file %s not current" |
5588 | (abbreviate-file-name file-name))) | |
c5e28e39 MR |
5589 | ((with-temp-buffer-window |
5590 | "*Directory*" nil | |
5591 | #'(lambda (window _value) | |
5592 | (with-selected-window window | |
5593 | (unwind-protect | |
5594 | (yes-or-no-p (format "Recover auto save file %s? " file-name)) | |
5595 | (when (window-live-p window) | |
5596 | (quit-restore-window window 'kill))))) | |
5597 | (with-current-buffer standard-output | |
5598 | (let ((switches dired-listing-switches)) | |
5599 | (if (file-symlink-p file) | |
5600 | (setq switches (concat switches " -L"))) | |
5601 | ;; Use insert-directory-safely, not insert-directory, | |
5602 | ;; because these files might not exist. In particular, | |
5603 | ;; FILE might not exist if the auto-save file was for | |
5604 | ;; a buffer that didn't visit a file, such as "*mail*". | |
5605 | ;; The code in v20.x called `ls' directly, so we need | |
5606 | ;; to emulate what `ls' did in that case. | |
5607 | (insert-directory-safely file switches) | |
5608 | (insert-directory-safely file-name switches)))) | |
b4da00e9 | 5609 | (switch-to-buffer (find-file-noselect file t)) |
518dc5be | 5610 | (let ((inhibit-read-only t) |
1e87edf5 KH |
5611 | ;; Keep the current buffer-file-coding-system. |
5612 | (coding-system buffer-file-coding-system) | |
1d0ec0d1 | 5613 | ;; Auto-saved file should be read with special coding. |
77619f8e | 5614 | (coding-system-for-read 'auto-save-coding)) |
b4da00e9 | 5615 | (erase-buffer) |
1e87edf5 KH |
5616 | (insert-file-contents file-name nil) |
5617 | (set-buffer-file-coding-system coding-system)) | |
8cfb9d46 | 5618 | (after-find-file nil nil t)) |
d5081c1e | 5619 | (t (user-error "Recover-file canceled"))))) |
b4da00e9 | 5620 | |
6598027d | 5621 | (defun recover-session () |
9aee5392 RS |
5622 | "Recover auto save files from a previous Emacs session. |
5623 | This command first displays a Dired buffer showing you the | |
5624 | previous sessions that you could recover from. | |
5625 | To choose one, move point to the proper line and then type C-c C-c. | |
5626 | Then you'll be asked about a number of files to recover." | |
5627 | (interactive) | |
363a5030 RS |
5628 | (if (null auto-save-list-file-prefix) |
5629 | (error "You set `auto-save-list-file-prefix' to disable making session files")) | |
ffc0e1ca AS |
5630 | (let ((dir (file-name-directory auto-save-list-file-prefix))) |
5631 | (unless (file-directory-p dir) | |
194600a8 JPW |
5632 | (make-directory dir t)) |
5633 | (unless (directory-files dir nil | |
5634 | (concat "\\`" (regexp-quote | |
5635 | (file-name-nondirectory | |
5636 | auto-save-list-file-prefix))) | |
5637 | t) | |
5638 | (error "No previous sessions to recover"))) | |
6f4983e6 | 5639 | (let ((ls-lisp-support-shell-wildcards t)) |
7b3478a5 | 5640 | (dired (concat auto-save-list-file-prefix "*") |
254c37a5 | 5641 | (concat dired-listing-switches " -t"))) |
5781e949 CY |
5642 | (use-local-map (nconc (make-sparse-keymap) (current-local-map))) |
5643 | (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish) | |
05e076c7 AS |
5644 | (save-excursion |
5645 | (goto-char (point-min)) | |
5646 | (or (looking-at " Move to the session you want to recover,") | |
5647 | (let ((inhibit-read-only t)) | |
5648 | ;; Each line starts with a space | |
5649 | ;; so that Font Lock mode won't highlight the first character. | |
5781e949 CY |
5650 | (insert " To recover a session, move to it and type C-c C-c.\n" |
5651 | (substitute-command-keys | |
5652 | " To delete a session file, type \ | |
5653 | \\[dired-flag-file-deletion] on its line to flag | |
5654 | the file for deletion, then \\[dired-do-flagged-delete] to \ | |
5655 | delete flagged files.\n\n")))))) | |
9aee5392 | 5656 | |
80280bb7 | 5657 | (defun recover-session-finish () |
9aee5392 RS |
5658 | "Choose one saved session to recover auto-save files from. |
5659 | This command is used in the special Dired buffer created by | |
80280bb7 | 5660 | \\[recover-session]." |
9aee5392 RS |
5661 | (interactive) |
5662 | ;; Get the name of the session file to recover from. | |
5663 | (let ((file (dired-get-filename)) | |
953a03b2 | 5664 | files |
9aee5392 | 5665 | (buffer (get-buffer-create " *recover*"))) |
c11032b9 | 5666 | (dired-unmark 1) |
033ef863 | 5667 | (dired-do-flagged-delete t) |
9aee5392 | 5668 | (unwind-protect |
8c3e96d2 | 5669 | (with-current-buffer buffer |
9aee5392 | 5670 | ;; Read in the auto-save-list file. |
9aee5392 RS |
5671 | (erase-buffer) |
5672 | (insert-file-contents file) | |
953a03b2 RS |
5673 | ;; Loop thru the text of that file |
5674 | ;; and get out the names of the files to recover. | |
5675 | (while (not (eobp)) | |
5676 | (let (thisfile autofile) | |
5677 | (if (eolp) | |
5678 | ;; This is a pair of lines for a non-file-visiting buffer. | |
5679 | ;; Get the auto-save file name and manufacture | |
5680 | ;; a "visited file name" from that. | |
5681 | (progn | |
5682 | (forward-line 1) | |
259be4e6 JB |
5683 | ;; If there is no auto-save file name, the |
5684 | ;; auto-save-list file is probably corrupted. | |
5685 | (unless (eolp) | |
5686 | (setq autofile | |
5687 | (buffer-substring-no-properties | |
5688 | (point) | |
e442c62b | 5689 | (line-end-position))) |
259be4e6 JB |
5690 | (setq thisfile |
5691 | (expand-file-name | |
5692 | (substring | |
5693 | (file-name-nondirectory autofile) | |
5694 | 1 -1) | |
5695 | (file-name-directory autofile)))) | |
953a03b2 RS |
5696 | (forward-line 1)) |
5697 | ;; This pair of lines is a file-visiting | |
5698 | ;; buffer. Use the visited file name. | |
5699 | (progn | |
5700 | (setq thisfile | |
5701 | (buffer-substring-no-properties | |
5702 | (point) (progn (end-of-line) (point)))) | |
5703 | (forward-line 1) | |
5704 | (setq autofile | |
5705 | (buffer-substring-no-properties | |
5706 | (point) (progn (end-of-line) (point)))) | |
5707 | (forward-line 1))) | |
5708 | ;; Ignore a file if its auto-save file does not exist now. | |
259be4e6 | 5709 | (if (and autofile (file-exists-p autofile)) |
953a03b2 RS |
5710 | (setq files (cons thisfile files))))) |
5711 | (setq files (nreverse files)) | |
945e1965 RS |
5712 | ;; The file contains a pair of line for each auto-saved buffer. |
5713 | ;; The first line of the pair contains the visited file name | |
5714 | ;; or is empty if the buffer was not visiting a file. | |
5715 | ;; The second line is the auto-save file name. | |
953a03b2 RS |
5716 | (if files |
5717 | (map-y-or-n-p "Recover %s? " | |
5718 | (lambda (file) | |
5719 | (condition-case nil | |
5720 | (save-excursion (recover-file file)) | |
76d5492b | 5721 | (error |
953a03b2 RS |
5722 | "Failed to recover `%s'" file))) |
5723 | files | |
5724 | '("file" "files" "recover")) | |
5725 | (message "No files can be recovered from this session now"))) | |
9aee5392 RS |
5726 | (kill-buffer buffer)))) |
5727 | ||
a151f82c | 5728 | (defun kill-buffer-ask (buffer) |
8fc29035 | 5729 | "Kill BUFFER if confirmed." |
9aea757b CY |
5730 | (when (yes-or-no-p (format "Buffer %s %s. Kill? " |
5731 | (buffer-name buffer) | |
5732 | (if (buffer-modified-p buffer) | |
5733 | "HAS BEEN EDITED" "is unmodified"))) | |
a151f82c SS |
5734 | (kill-buffer buffer))) |
5735 | ||
73ba610a | 5736 | (defun kill-some-buffers (&optional list) |
243a3ae0 | 5737 | "Kill some buffers. Asks the user whether to kill each one of them. |
bb8eaf67 | 5738 | Non-interactively, if optional argument LIST is non-nil, it |
243a3ae0 | 5739 | specifies the list of buffers to kill, asking for approval for each one." |
b4da00e9 | 5740 | (interactive) |
73ba610a RS |
5741 | (if (null list) |
5742 | (setq list (buffer-list))) | |
5743 | (while list | |
5744 | (let* ((buffer (car list)) | |
5745 | (name (buffer-name buffer))) | |
cbca0a4b RS |
5746 | (and name ; Can be nil for an indirect buffer |
5747 | ; if we killed the base buffer. | |
5748 | (not (string-equal name "")) | |
26b9ecbc | 5749 | (/= (aref name 0) ?\s) |
a151f82c | 5750 | (kill-buffer-ask buffer))) |
73ba610a | 5751 | (setq list (cdr list)))) |
a151f82c SS |
5752 | |
5753 | (defun kill-matching-buffers (regexp &optional internal-too) | |
8fc29035 | 5754 | "Kill buffers whose name matches the specified REGEXP. |
a151f82c SS |
5755 | The optional second argument indicates whether to kill internal buffers too." |
5756 | (interactive "sKill buffers matching this regular expression: \nP") | |
5757 | (dolist (buffer (buffer-list)) | |
5758 | (let ((name (buffer-name buffer))) | |
5759 | (when (and name (not (string-equal name "")) | |
5760 | (or internal-too (/= (aref name 0) ?\s)) | |
5761 | (string-match regexp name)) | |
5762 | (kill-buffer-ask buffer))))) | |
5763 | ||
b4da00e9 | 5764 | \f |
b4da00e9 RM |
5765 | (defun rename-auto-save-file () |
5766 | "Adjust current buffer's auto save file name for current conditions. | |
5767 | Also rename any existing auto save file, if it was made in this session." | |
5768 | (let ((osave buffer-auto-save-file-name)) | |
5769 | (setq buffer-auto-save-file-name | |
5770 | (make-auto-save-file-name)) | |
5771 | (if (and osave buffer-auto-save-file-name | |
5772 | (not (string= buffer-auto-save-file-name buffer-file-name)) | |
5773 | (not (string= buffer-auto-save-file-name osave)) | |
5774 | (file-exists-p osave) | |
5775 | (recent-auto-save-p)) | |
5776 | (rename-file osave buffer-auto-save-file-name t)))) | |
5777 | ||
5778 | (defun make-auto-save-file-name () | |
5779 | "Return file name to use for auto-saves of current buffer. | |
5780 | Does not consider `auto-save-visited-file-name' as that variable is checked | |
5781 | before calling this function. You can redefine this for customization. | |
5782 | See also `auto-save-file-name-p'." | |
5783 | (if buffer-file-name | |
c1105d05 MA |
5784 | (let ((handler (find-file-name-handler buffer-file-name |
5785 | 'make-auto-save-file-name))) | |
5786 | (if handler | |
5787 | (funcall handler 'make-auto-save-file-name) | |
5788 | (let ((list auto-save-file-name-transforms) | |
5789 | (filename buffer-file-name) | |
5790 | result uniq) | |
5791 | ;; Apply user-specified translations | |
5792 | ;; to the file name. | |
5793 | (while (and list (not result)) | |
5794 | (if (string-match (car (car list)) filename) | |
5795 | (setq result (replace-match (cadr (car list)) t nil | |
5796 | filename) | |
5797 | uniq (car (cddr (car list))))) | |
5798 | (setq list (cdr list))) | |
5799 | (if result | |
5800 | (if uniq | |
5801 | (setq filename (concat | |
5802 | (file-name-directory result) | |
5803 | (subst-char-in-string | |
5804 | ?/ ?! | |
5805 | (replace-regexp-in-string "!" "!!" | |
5806 | filename)))) | |
5807 | (setq filename result))) | |
5808 | (setq result | |
5809 | (if (and (eq system-type 'ms-dos) | |
5810 | (not (msdos-long-file-names))) | |
5811 | ;; We truncate the file name to DOS 8+3 limits | |
5812 | ;; before doing anything else, because the regexp | |
5813 | ;; passed to string-match below cannot handle | |
5814 | ;; extensions longer than 3 characters, multiple | |
5815 | ;; dots, and other atrocities. | |
5816 | (let ((fn (dos-8+3-filename | |
5817 | (file-name-nondirectory buffer-file-name)))) | |
5818 | (string-match | |
5819 | "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" | |
5820 | fn) | |
5821 | (concat (file-name-directory buffer-file-name) | |
5822 | "#" (match-string 1 fn) | |
5823 | "." (match-string 3 fn) "#")) | |
5824 | (concat (file-name-directory filename) | |
5825 | "#" | |
5826 | (file-name-nondirectory filename) | |
5827 | "#"))) | |
5828 | ;; Make sure auto-save file names don't contain characters | |
5829 | ;; invalid for the underlying filesystem. | |
18b28ef1 | 5830 | (if (and (memq system-type '(ms-dos windows-nt cygwin)) |
c1105d05 MA |
5831 | ;; Don't modify remote (ange-ftp) filenames |
5832 | (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result))) | |
5833 | (convert-standard-filename result) | |
5834 | result)))) | |
0a1763b4 RS |
5835 | |
5836 | ;; Deal with buffers that don't have any associated files. (Mail | |
5837 | ;; mode tends to create a good number of these.) | |
5838 | ||
7d483e8c | 5839 | (let ((buffer-name (buffer-name)) |
ff5c7181 | 5840 | (limit 0) |
77d18896 | 5841 | file-name) |
ad80c679 JR |
5842 | ;; Restrict the characters used in the file name to those which |
5843 | ;; are known to be safe on all filesystems, url-encoding the | |
5844 | ;; rest. | |
5845 | ;; We do this on all platforms, because even if we are not | |
5846 | ;; running on DOS/Windows, the current directory may be on a | |
5847 | ;; mounted VFAT filesystem, such as a USB memory stick. | |
5848 | (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit) | |
c3348e10 RS |
5849 | (let* ((character (aref buffer-name (match-beginning 0))) |
5850 | (replacement | |
ad80c679 JR |
5851 | ;; For multibyte characters, this will produce more than |
5852 | ;; 2 hex digits, so is not true URL encoding. | |
5853 | (format "%%%02X" character))) | |
c3348e10 RS |
5854 | (setq buffer-name (replace-match replacement t t buffer-name)) |
5855 | (setq limit (1+ (match-end 0))))) | |
a8abaf83 | 5856 | ;; Generate the file name. |
ff5c7181 RS |
5857 | (setq file-name |
5858 | (make-temp-file | |
5859 | (let ((fname | |
5860 | (expand-file-name | |
5861 | (format "#%s#" buffer-name) | |
5862 | ;; Try a few alternative directories, to get one we can | |
5863 | ;; write it. | |
5864 | (cond | |
5865 | ((file-writable-p default-directory) default-directory) | |
5866 | ((file-writable-p "/var/tmp/") "/var/tmp/") | |
5867 | ("~/"))))) | |
18b28ef1 | 5868 | (if (and (memq system-type '(ms-dos windows-nt cygwin)) |
ff5c7181 RS |
5869 | ;; Don't modify remote (ange-ftp) filenames |
5870 | (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname))) | |
5871 | ;; The call to convert-standard-filename is in case | |
5872 | ;; buffer-name includes characters not allowed by the | |
5873 | ;; DOS/Windows filesystems. make-temp-file writes to the | |
5874 | ;; file it creates, so we must fix the file name _before_ | |
5875 | ;; make-temp-file is called. | |
5876 | (convert-standard-filename fname) | |
5877 | fname)) | |
5878 | nil "#")) | |
5879 | ;; make-temp-file creates the file, | |
5880 | ;; but we don't want it to exist until we do an auto-save. | |
5881 | (condition-case () | |
5882 | (delete-file file-name) | |
5883 | (file-error nil)) | |
5884 | file-name))) | |
b4da00e9 RM |
5885 | |
5886 | (defun auto-save-file-name-p (filename) | |
5887 | "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'. | |
5888 | FILENAME should lack slashes. You can redefine this for customization." | |
19156242 | 5889 | (string-match "\\`#.*#\\'" filename)) |
b4da00e9 | 5890 | \f |
6f4983e6 RS |
5891 | (defun wildcard-to-regexp (wildcard) |
5892 | "Given a shell file name pattern WILDCARD, return an equivalent regexp. | |
4837b516 | 5893 | The generated regexp will match a filename only if the filename |
6f4983e6 RS |
5894 | matches that wildcard according to shell rules. Only wildcards known |
5895 | by `sh' are supported." | |
5896 | (let* ((i (string-match "[[.*+\\^$?]" wildcard)) | |
5897 | ;; Copy the initial run of non-special characters. | |
5898 | (result (substring wildcard 0 i)) | |
5899 | (len (length wildcard))) | |
5900 | ;; If no special characters, we're almost done. | |
5901 | (if i | |
5902 | (while (< i len) | |
5903 | (let ((ch (aref wildcard i)) | |
5904 | j) | |
5905 | (setq | |
5906 | result | |
5907 | (concat result | |
5908 | (cond | |
7e7c9c4e RS |
5909 | ((and (eq ch ?\[) |
5910 | (< (1+ i) len) | |
5911 | (eq (aref wildcard (1+ i)) ?\])) | |
5912 | "\\[") | |
6f4983e6 RS |
5913 | ((eq ch ?\[) ; [...] maps to regexp char class |
5914 | (progn | |
5915 | (setq i (1+ i)) | |
5916 | (concat | |
5917 | (cond | |
5918 | ((eq (aref wildcard i) ?!) ; [!...] -> [^...] | |
5919 | (progn | |
5920 | (setq i (1+ i)) | |
5921 | (if (eq (aref wildcard i) ?\]) | |
5922 | (progn | |
5923 | (setq i (1+ i)) | |
5924 | "[^]") | |
5925 | "[^"))) | |
5926 | ((eq (aref wildcard i) ?^) | |
5927 | ;; Found "[^". Insert a `\0' character | |
5928 | ;; (which cannot happen in a filename) | |
5929 | ;; into the character class, so that `^' | |
5930 | ;; is not the first character after `[', | |
5931 | ;; and thus non-special in a regexp. | |
5932 | (progn | |
5933 | (setq i (1+ i)) | |
5934 | "[\000^")) | |
5935 | ((eq (aref wildcard i) ?\]) | |
5936 | ;; I don't think `]' can appear in a | |
5937 | ;; character class in a wildcard, but | |
5938 | ;; let's be general here. | |
5939 | (progn | |
5940 | (setq i (1+ i)) | |
5941 | "[]")) | |
5942 | (t "[")) | |
5943 | (prog1 ; copy everything upto next `]'. | |
5944 | (substring wildcard | |
5945 | i | |
5946 | (setq j (string-match | |
5947 | "]" wildcard i))) | |
5948 | (setq i (if j (1- j) (1- len))))))) | |
5949 | ((eq ch ?.) "\\.") | |
5950 | ((eq ch ?*) "[^\000]*") | |
5951 | ((eq ch ?+) "\\+") | |
5952 | ((eq ch ?^) "\\^") | |
5953 | ((eq ch ?$) "\\$") | |
5954 | ((eq ch ?\\) "\\\\") ; probably cannot happen... | |
5955 | ((eq ch ??) "[^\000]") | |
5956 | (t (char-to-string ch))))) | |
5957 | (setq i (1+ i))))) | |
5958 | ;; Shell wildcards should match the entire filename, | |
5959 | ;; not its part. Make the regexp say so. | |
5960 | (concat "\\`" result "\\'"))) | |
5961 | \f | |
21540597 | 5962 | (defcustom list-directory-brief-switches |
1e8780b1 | 5963 | (purecopy "-CF") |
ba83982b | 5964 | "Switches for `list-directory' to pass to `ls' for brief listing." |
21540597 RS |
5965 | :type 'string |
5966 | :group 'dired) | |
b4da00e9 | 5967 | |
21540597 | 5968 | (defcustom list-directory-verbose-switches |
1e8780b1 | 5969 | (purecopy "-l") |
ba83982b | 5970 | "Switches for `list-directory' to pass to `ls' for verbose listing." |
21540597 RS |
5971 | :type 'string |
5972 | :group 'dired) | |
b4da00e9 | 5973 | |
5de148a2 RS |
5974 | (defun file-expand-wildcards (pattern &optional full) |
5975 | "Expand wildcard pattern PATTERN. | |
4db2a7de RS |
5976 | This returns a list of file names which match the pattern. |
5977 | ||
814af837 | 5978 | If PATTERN is written as an absolute file name, |
4db2a7de RS |
5979 | the values are absolute also. |
5980 | ||
5981 | If PATTERN is written as a relative file name, it is interpreted | |
5982 | relative to the current default directory, `default-directory'. | |
5983 | The file names returned are normally also relative to the current | |
5984 | default directory. However, if FULL is non-nil, they are absolute." | |
032388f3 RS |
5985 | (save-match-data |
5986 | (let* ((nondir (file-name-nondirectory pattern)) | |
5987 | (dirpart (file-name-directory pattern)) | |
5988 | ;; A list of all dirs that DIRPART specifies. | |
5989 | ;; This can be more than one dir | |
5990 | ;; if DIRPART contains wildcards. | |
1f3611c6 MA |
5991 | (dirs (if (and dirpart |
5992 | (string-match "[[*?]" | |
5993 | (or (file-remote-p dirpart 'localname) | |
5994 | dirpart))) | |
032388f3 RS |
5995 | (mapcar 'file-name-as-directory |
5996 | (file-expand-wildcards (directory-file-name dirpart))) | |
5997 | (list dirpart))) | |
5998 | contents) | |
5999 | (while dirs | |
6000 | (when (or (null (car dirs)) ; Possible if DIRPART is not wild. | |
28fd8759 LMI |
6001 | (and (file-directory-p (directory-file-name (car dirs))) |
6002 | (file-readable-p (car dirs)))) | |
032388f3 RS |
6003 | (let ((this-dir-contents |
6004 | ;; Filter out "." and ".." | |
6005 | (delq nil | |
6006 | (mapcar #'(lambda (name) | |
6007 | (unless (string-match "\\`\\.\\.?\\'" | |
6008 | (file-name-nondirectory name)) | |
6009 | name)) | |
6010 | (directory-files (or (car dirs) ".") full | |
6011 | (wildcard-to-regexp nondir)))))) | |
6012 | (setq contents | |
6013 | (nconc | |
6014 | (if (and (car dirs) (not full)) | |
6015 | (mapcar (function (lambda (name) (concat (car dirs) name))) | |
6016 | this-dir-contents) | |
6017 | this-dir-contents) | |
6018 | contents)))) | |
6019 | (setq dirs (cdr dirs))) | |
6020 | contents))) | |
5de148a2 | 6021 | |
1f3611c6 MA |
6022 | ;; Let Tramp know that `file-expand-wildcards' does not need an advice. |
6023 | (provide 'files '(remote-wildcards)) | |
6024 | ||
b4da00e9 RM |
6025 | (defun list-directory (dirname &optional verbose) |
6026 | "Display a list of files in or matching DIRNAME, a la `ls'. | |
6027 | DIRNAME is globbed by the shell if necessary. | |
6028 | Prefix arg (second arg if noninteractive) means supply -l switch to `ls'. | |
6029 | Actions controlled by variables `list-directory-brief-switches' | |
6030 | and `list-directory-verbose-switches'." | |
6031 | (interactive (let ((pfx current-prefix-arg)) | |
7e27ce9c | 6032 | (list (read-directory-name (if pfx "List directory (verbose): " |
b4da00e9 RM |
6033 | "List directory (brief): ") |
6034 | nil default-directory nil) | |
6035 | pfx))) | |
6036 | (let ((switches (if verbose list-directory-verbose-switches | |
84905190 RS |
6037 | list-directory-brief-switches)) |
6038 | buffer) | |
b4da00e9 RM |
6039 | (or dirname (setq dirname default-directory)) |
6040 | (setq dirname (expand-file-name dirname)) | |
6041 | (with-output-to-temp-buffer "*Directory*" | |
84905190 | 6042 | (setq buffer standard-output) |
b4da00e9 RM |
6043 | (buffer-disable-undo standard-output) |
6044 | (princ "Directory ") | |
6045 | (princ dirname) | |
6046 | (terpri) | |
7fdbcd83 | 6047 | (with-current-buffer "*Directory*" |
c3554e95 | 6048 | (let ((wildcard (not (file-directory-p dirname)))) |
84905190 RS |
6049 | (insert-directory dirname switches wildcard (not wildcard))))) |
6050 | ;; Finishing with-output-to-temp-buffer seems to clobber default-directory. | |
6051 | (with-current-buffer buffer | |
6052 | (setq default-directory | |
6053 | (if (file-directory-p dirname) | |
6054 | (file-name-as-directory dirname) | |
6055 | (file-name-directory dirname)))))) | |
c3554e95 | 6056 | |
ffc0e1ca AS |
6057 | (defun shell-quote-wildcard-pattern (pattern) |
6058 | "Quote characters special to the shell in PATTERN, leave wildcards alone. | |
6059 | ||
6060 | PATTERN is assumed to represent a file-name wildcard suitable for the | |
7f94baf0 EZ |
6061 | underlying filesystem. For Unix and GNU/Linux, each character from the |
6062 | set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all | |
ffc0e1ca AS |
6063 | the parts of the pattern which don't include wildcard characters are |
6064 | quoted with double quotes. | |
7f94baf0 EZ |
6065 | |
6066 | This function leaves alone existing quote characters (\\ on Unix and \" | |
6067 | on Windows), so PATTERN can use them to quote wildcard characters that | |
6068 | need to be passed verbatim to shell commands." | |
ffc0e1ca AS |
6069 | (save-match-data |
6070 | (cond | |
c60ee5e7 | 6071 | ((memq system-type '(ms-dos windows-nt cygwin)) |
ffc0e1ca AS |
6072 | ;; DOS/Windows don't allow `"' in file names. So if the |
6073 | ;; argument has quotes, we can safely assume it is already | |
6074 | ;; quoted by the caller. | |
6075 | (if (or (string-match "[\"]" pattern) | |
6076 | ;; We quote [&()#$'] in case their shell is a port of a | |
6077 | ;; Unixy shell. We quote [,=+] because stock DOS and | |
6078 | ;; Windows shells require that in some cases, such as | |
6079 | ;; passing arguments to batch files that use positional | |
6080 | ;; arguments like %1. | |
6081 | (not (string-match "[ \t;&()#$',=+]" pattern))) | |
6082 | pattern | |
6083 | (let ((result "\"") | |
6084 | (beg 0) | |
6085 | end) | |
6086 | (while (string-match "[*?]+" pattern beg) | |
6087 | (setq end (match-beginning 0) | |
6088 | result (concat result (substring pattern beg end) | |
6089 | "\"" | |
6090 | (substring pattern end (match-end 0)) | |
6091 | "\"") | |
6092 | beg (match-end 0))) | |
6093 | (concat result (substring pattern beg) "\"")))) | |
6094 | (t | |
6095 | (let ((beg 0)) | |
d6d61574 | 6096 | (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg) |
ffc0e1ca AS |
6097 | (setq pattern |
6098 | (concat (substring pattern 0 (match-beginning 0)) | |
6099 | "\\" | |
6100 | (substring pattern (match-beginning 0))) | |
6101 | beg (1+ (match-end 0))))) | |
6102 | pattern)))) | |
6103 | ||
6104 | ||
1e8780b1 | 6105 | (defvar insert-directory-program (purecopy "ls") |
c3554e95 RS |
6106 | "Absolute or relative name of the `ls' program used by `insert-directory'.") |
6107 | ||
1e8780b1 | 6108 | (defcustom directory-free-space-program (purecopy "df") |
ba83982b | 6109 | "Program to get the amount of free space on a file system. |
f4d04672 RS |
6110 | We assume the output has the format of `df'. |
6111 | The value of this variable must be just a command name or file name; | |
6112 | if you want to specify options, use `directory-free-space-args'. | |
6113 | ||
01b26b90 EZ |
6114 | A value of nil disables this feature. |
6115 | ||
6116 | If the function `file-system-info' is defined, it is always used in | |
6117 | preference to the program given by this variable." | |
f4d04672 RS |
6118 | :type '(choice (string :tag "Program") (const :tag "None" nil)) |
6119 | :group 'dired) | |
6120 | ||
525fdbc9 | 6121 | (defcustom directory-free-space-args |
1e8780b1 | 6122 | (purecopy (if (eq system-type 'darwin) "-k" "-Pk")) |
ba83982b | 6123 | "Options to use when running `directory-free-space-program'." |
f4d04672 RS |
6124 | :type 'string |
6125 | :group 'dired) | |
6126 | ||
01b26b90 | 6127 | (defun get-free-disk-space (dir) |
26b9ecbc | 6128 | "Return the amount of free space on directory DIR's file system. |
93a596e1 CY |
6129 | The return value is a string describing the amount of free |
6130 | space (normally, the number of free 1KB blocks). | |
6131 | ||
6132 | This function calls `file-system-info' if it is available, or | |
6133 | invokes the program specified by `directory-free-space-program' | |
6134 | and `directory-free-space-args'. If the system call or program | |
6135 | is unsuccessful, or if DIR is a remote directory, this function | |
6136 | returns nil." | |
e1bdde78 | 6137 | (unless (file-remote-p dir) |
06531fc3 MA |
6138 | ;; Try to find the number of free blocks. Non-Posix systems don't |
6139 | ;; always have df, but might have an equivalent system call. | |
6140 | (if (fboundp 'file-system-info) | |
6141 | (let ((fsinfo (file-system-info dir))) | |
6142 | (if fsinfo | |
6143 | (format "%.0f" (/ (nth 2 fsinfo) 1024)))) | |
51da8fe2 | 6144 | (setq dir (expand-file-name dir)) |
06531fc3 MA |
6145 | (save-match-data |
6146 | (with-temp-buffer | |
6147 | (when (and directory-free-space-program | |
e1bdde78 CY |
6148 | ;; Avoid failure if the default directory does |
6149 | ;; not exist (Bug#2631, Bug#3911). | |
0781098a SM |
6150 | (let ((default-directory |
6151 | (locate-dominating-file dir 'file-directory-p))) | |
6152 | (eq (process-file directory-free-space-program | |
06531fc3 MA |
6153 | nil t nil |
6154 | directory-free-space-args | |
0781098a | 6155 | (file-relative-name dir)) |
86c7144b | 6156 | 0))) |
41f54b73 CY |
6157 | ;; Assume that the "available" column is before the |
6158 | ;; "capacity" column. Find the "%" and scan backward. | |
06531fc3 | 6159 | (goto-char (point-min)) |
41f54b73 CY |
6160 | (forward-line 1) |
6161 | (when (re-search-forward | |
6162 | "[[:space:]]+[^[:space:]]+%[^%]*$" | |
6163 | (line-end-position) t) | |
6164 | (goto-char (match-beginning 0)) | |
6165 | (let ((endpt (point))) | |
6166 | (skip-chars-backward "^[:space:]") | |
6167 | (buffer-substring-no-properties (point) endpt))))))))) | |
01b26b90 | 6168 | |
9bc260cf MA |
6169 | ;; The following expression replaces `dired-move-to-filename-regexp'. |
6170 | (defvar directory-listing-before-filename-regexp | |
6171 | (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)") | |
6172 | (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)") | |
6173 | ;; In some locales, month abbreviations are as short as 2 letters, | |
6174 | ;; and they can be followed by ".". | |
6175 | ;; In Breton, a month name can include a quote character. | |
6176 | (month (concat l-or-quote l-or-quote "+\\.?")) | |
6177 | (s " ") | |
6178 | (yyyy "[0-9][0-9][0-9][0-9]") | |
6179 | (dd "[ 0-3][0-9]") | |
6180 | (HH:MM "[ 0-2][0-9][:.][0-5][0-9]") | |
6181 | (seconds "[0-6][0-9]\\([.,][0-9]+\\)?") | |
6182 | (zone "[-+][0-2][0-9][0-5][0-9]") | |
6183 | (iso-mm-dd "[01][0-9]-[0-3][0-9]") | |
6184 | (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?")) | |
6185 | (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time | |
6186 | "\\|" yyyy "-" iso-mm-dd "\\)")) | |
6187 | (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)" | |
6188 | s "+" | |
6189 | "\\(" HH:MM "\\|" yyyy "\\)")) | |
6190 | (western-comma (concat month s "+" dd "," s "+" yyyy)) | |
6191 | ;; Japanese MS-Windows ls-lisp has one-digit months, and | |
6192 | ;; omits the Kanji characters after month and day-of-month. | |
6193 | ;; On Mac OS X 10.3, the date format in East Asian locales is | |
6194 | ;; day-of-month digits followed by month digits. | |
6195 | (mm "[ 0-1]?[0-9]") | |
6196 | (east-asian | |
6197 | (concat "\\(" mm l "?" s dd l "?" s "+" | |
6198 | "\\|" dd s mm s "+" "\\)" | |
6199 | "\\(" HH:MM "\\|" yyyy l "?" "\\)"))) | |
6200 | ;; The "[0-9]" below requires the previous column to end in a digit. | |
6201 | ;; This avoids recognizing `1 may 1997' as a date in the line: | |
6202 | ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README | |
6203 | ||
6204 | ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output. | |
50c58e27 CY |
6205 | |
6206 | ;; For non-iso date formats, we add the ".*" in order to find | |
6207 | ;; the last possible match. This avoids recognizing | |
6208 | ;; `jservice 10 1024' as a date in the line: | |
9bc260cf MA |
6209 | ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host |
6210 | ||
6211 | ;; vc dired listings provide the state or blanks between file | |
6212 | ;; permissions and date. The state is always surrounded by | |
e1dbe924 | 6213 | ;; parentheses: |
9bc260cf MA |
6214 | ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el |
6215 | ;; This is not supported yet. | |
50c58e27 CY |
6216 | (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso |
6217 | "\\|.*[0-9][BkKMGTPEZY]? " | |
6218 | "\\(" western "\\|" western-comma "\\|" east-asian "\\)" | |
6219 | "\\) +"))) | |
9bc260cf MA |
6220 | "Regular expression to match up to the file name in a directory listing. |
6221 | The default value is designed to recognize dates and times | |
6222 | regardless of the language.") | |
01b26b90 | 6223 | |
a1b0c2a7 RS |
6224 | (defvar insert-directory-ls-version 'unknown) |
6225 | ||
c3554e95 RS |
6226 | ;; insert-directory |
6227 | ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and | |
6228 | ;; FULL-DIRECTORY-P is nil. | |
6229 | ;; The single line of output must display FILE's name as it was | |
6230 | ;; given, namely, an absolute path name. | |
6231 | ;; - must insert exactly one line for each file if WILDCARD or | |
6232 | ;; FULL-DIRECTORY-P is t, plus one optional "total" line | |
6233 | ;; before the file lines, plus optional text after the file lines. | |
6234 | ;; Lines are delimited by "\n", so filenames containing "\n" are not | |
6235 | ;; allowed. | |
6236 | ;; File lines should display the basename. | |
6237 | ;; - must be consistent with | |
6238 | ;; - functions dired-move-to-filename, (these two define what a file line is) | |
6239 | ;; dired-move-to-end-of-filename, | |
6240 | ;; dired-between-files, (shortcut for (not (dired-move-to-filename))) | |
6241 | ;; dired-insert-headerline | |
6242 | ;; dired-after-subdir-garbage (defines what a "total" line is) | |
6243 | ;; - variable dired-subdir-regexp | |
1fc85dae KG |
6244 | ;; - may be passed "--dired" as the first argument in SWITCHES. |
6245 | ;; Filename handlers might have to remove this switch if their | |
6246 | ;; "ls" command does not support it. | |
c3554e95 | 6247 | (defun insert-directory (file switches &optional wildcard full-directory-p) |
a18b7c81 | 6248 | "Insert directory listing for FILE, formatted according to SWITCHES. |
c3554e95 | 6249 | Leaves point after the inserted text. |
8f8607be LT |
6250 | SWITCHES may be a string of options, or a list of strings |
6251 | representing individual options. | |
c3554e95 RS |
6252 | Optional third arg WILDCARD means treat FILE as shell wildcard. |
6253 | Optional fourth arg FULL-DIRECTORY-P means file is a directory and | |
6254 | switches do not contain `d', so that a full listing is expected. | |
6255 | ||
6256 | This works by running a directory listing program | |
406e12d9 | 6257 | whose name is in the variable `insert-directory-program'. |
8f8607be LT |
6258 | If WILDCARD, it also runs the shell specified by `shell-file-name'. |
6259 | ||
60ce7e3e | 6260 | When SWITCHES contains the long `--dired' option, this function |
8f8607be LT |
6261 | treats it specially, for the sake of dired. However, the |
6262 | normally equivalent short `-D' option is just passed on to | |
6263 | `insert-directory-program', as any other option." | |
c870ab8e | 6264 | ;; We need the directory in order to find the right handler. |
d2473540 AS |
6265 | (let ((handler (find-file-name-handler (expand-file-name file) |
6266 | 'insert-directory))) | |
ebad92dc | 6267 | (if handler |
c3554e95 RS |
6268 | (funcall handler 'insert-directory file switches |
6269 | wildcard full-directory-p) | |
818286f4 | 6270 | (let (result (beg (point))) |
ebad92dc RS |
6271 | |
6272 | ;; Read the actual directory using `insert-directory-program'. | |
6273 | ;; RESULT gets the status code. | |
99f01c91 KH |
6274 | (let* (;; We at first read by no-conversion, then after |
6275 | ;; putting text property `dired-filename, decode one | |
6276 | ;; bunch by one to preserve that property. | |
6277 | (coding-system-for-read 'no-conversion) | |
6278 | ;; This is to control encoding the arguments in call-process. | |
c60ee5e7 | 6279 | (coding-system-for-write |
82e22b57 KH |
6280 | (and enable-multibyte-characters |
6281 | (or file-name-coding-system | |
99f01c91 | 6282 | default-file-name-coding-system)))) |
ebad92dc RS |
6283 | (setq result |
6284 | (if wildcard | |
6285 | ;; Run ls in the directory part of the file pattern | |
6286 | ;; using the last component as argument. | |
6287 | (let ((default-directory | |
6288 | (if (file-name-absolute-p file) | |
6289 | (file-name-directory file) | |
6290 | (file-name-directory (expand-file-name file)))) | |
6291 | (pattern (file-name-nondirectory file))) | |
82137b51 GM |
6292 | ;; NB since switches is passed to the shell, be |
6293 | ;; careful of malicious values, eg "-l;reboot". | |
6294 | ;; See eg dired-safe-switches-p. | |
ebad92dc RS |
6295 | (call-process |
6296 | shell-file-name nil t nil | |
6297 | "-c" | |
6298 | (concat (if (memq system-type '(ms-dos windows-nt)) | |
6299 | "" | |
6300 | "\\") ; Disregard Unix shell aliases! | |
6301 | insert-directory-program | |
6302 | " -d " | |
6303 | (if (stringp switches) | |
6304 | switches | |
6305 | (mapconcat 'identity switches " ")) | |
6306 | " -- " | |
6307 | ;; Quote some characters that have | |
6308 | ;; special meanings in shells; but | |
6309 | ;; don't quote the wildcards--we want | |
6310 | ;; them to be special. We also | |
6311 | ;; currently don't quote the quoting | |
6312 | ;; characters in case people want to | |
6313 | ;; use them explicitly to quote | |
6314 | ;; wildcard characters. | |
6315 | (shell-quote-wildcard-pattern pattern)))) | |
6316 | ;; SunOS 4.1.3, SVr4 and others need the "." to list the | |
6317 | ;; directory if FILE is a symbolic link. | |
ecbaeb7b MA |
6318 | (unless full-directory-p |
6319 | (setq switches | |
76dc5996 SM |
6320 | (cond |
6321 | ((stringp switches) (concat switches " -d")) | |
6322 | ((member "-d" switches) switches) | |
6323 | (t (append switches '("-d")))))) | |
ebad92dc RS |
6324 | (apply 'call-process |
6325 | insert-directory-program nil t nil | |
6326 | (append | |
6327 | (if (listp switches) switches | |
6328 | (unless (equal switches "") | |
6329 | ;; Split the switches at any spaces so we can | |
6330 | ;; pass separate options as separate args. | |
6331 | (split-string switches))) | |
6332 | ;; Avoid lossage if FILE starts with `-'. | |
6333 | '("--") | |
6334 | (progn | |
6335 | (if (string-match "\\`~" file) | |
6336 | (setq file (expand-file-name file))) | |
6337 | (list | |
6338 | (if full-directory-p | |
6339 | (concat (file-name-as-directory file) ".") | |
6340 | file)))))))) | |
6341 | ||
a1b0c2a7 RS |
6342 | ;; If we got "//DIRED//" in the output, it means we got a real |
6343 | ;; directory listing, even if `ls' returned nonzero. | |
6344 | ;; So ignore any errors. | |
6345 | (when (if (stringp switches) | |
6346 | (string-match "--dired\\>" switches) | |
6347 | (member "--dired" switches)) | |
6348 | (save-excursion | |
6349 | (forward-line -2) | |
6350 | (when (looking-at "//SUBDIRED//") | |
6351 | (forward-line -1)) | |
6352 | (if (looking-at "//DIRED//") | |
6353 | (setq result 0)))) | |
6354 | ||
6355 | (when (and (not (eq 0 result)) | |
6356 | (eq insert-directory-ls-version 'unknown)) | |
6357 | ;; The first time ls returns an error, | |
6358 | ;; find the version numbers of ls, | |
6359 | ;; and set insert-directory-ls-version | |
6360 | ;; to > if it is more than 5.2.1, < if it is less, nil if it | |
6361 | ;; is equal or if the info cannot be obtained. | |
6362 | ;; (That can mean it isn't GNU ls.) | |
6363 | (let ((version-out | |
6364 | (with-temp-buffer | |
6365 | (call-process "ls" nil t nil "--version") | |
6366 | (buffer-string)))) | |
6367 | (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out) | |
6368 | (let* ((version (match-string 1 version-out)) | |
6369 | (split (split-string version "[.]")) | |
027a4b6b | 6370 | (numbers (mapcar 'string-to-number split)) |
a1b0c2a7 RS |
6371 | (min '(5 2 1)) |
6372 | comparison) | |
6373 | (while (and (not comparison) (or numbers min)) | |
6374 | (cond ((null min) | |
6375 | (setq comparison '>)) | |
6376 | ((null numbers) | |
6377 | (setq comparison '<)) | |
6378 | ((> (car numbers) (car min)) | |
6379 | (setq comparison '>)) | |
6380 | ((< (car numbers) (car min)) | |
6381 | (setq comparison '<)) | |
6382 | (t | |
6383 | (setq numbers (cdr numbers) | |
6384 | min (cdr min))))) | |
6385 | (setq insert-directory-ls-version (or comparison '=))) | |
6386 | (setq insert-directory-ls-version nil)))) | |
6387 | ||
6388 | ;; For GNU ls versions 5.2.2 and up, ignore minor errors. | |
6389 | (when (and (eq 1 result) (eq insert-directory-ls-version '>)) | |
6390 | (setq result 0)) | |
6391 | ||
ebad92dc | 6392 | ;; If `insert-directory-program' failed, signal an error. |
15502042 | 6393 | (unless (eq 0 result) |
f2440e42 RS |
6394 | ;; Delete the error message it may have output. |
6395 | (delete-region beg (point)) | |
15502042 EZ |
6396 | ;; On non-Posix systems, we cannot open a directory, so |
6397 | ;; don't even try, because that will always result in | |
6398 | ;; the ubiquitous "Access denied". Instead, show the | |
6399 | ;; command line so the user can try to guess what went wrong. | |
6400 | (if (and (file-directory-p file) | |
6401 | (memq system-type '(ms-dos windows-nt))) | |
6402 | (error | |
6403 | "Reading directory: \"%s %s -- %s\" exited with status %s" | |
6404 | insert-directory-program | |
6405 | (if (listp switches) (concat switches) switches) | |
6406 | file result) | |
6407 | ;; Unix. Access the file to get a suitable error. | |
6408 | (access-file file "Reading directory") | |
6409 | (error "Listing directory failed but `access-file' worked"))) | |
ebad92dc | 6410 | |
8f8607be LT |
6411 | (when (if (stringp switches) |
6412 | (string-match "--dired\\>" switches) | |
6413 | (member "--dired" switches)) | |
9bb99df6 LT |
6414 | ;; The following overshoots by one line for an empty |
6415 | ;; directory listed with "--dired", but without "-a" | |
6416 | ;; switch, where the ls output contains a | |
6417 | ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line. | |
6418 | ;; We take care of that case later. | |
ff7affeb | 6419 | (forward-line -2) |
9423860f AS |
6420 | (when (looking-at "//SUBDIRED//") |
6421 | (delete-region (point) (progn (forward-line 1) (point))) | |
6422 | (forward-line -1)) | |
9bb99df6 LT |
6423 | (if (looking-at "//DIRED//") |
6424 | (let ((end (line-end-position)) | |
6425 | (linebeg (point)) | |
6426 | error-lines) | |
6427 | ;; Find all the lines that are error messages, | |
6428 | ;; and record the bounds of each one. | |
6429 | (goto-char beg) | |
6430 | (while (< (point) linebeg) | |
6431 | (or (eql (following-char) ?\s) | |
6432 | (push (list (point) (line-end-position)) error-lines)) | |
6433 | (forward-line 1)) | |
6434 | (setq error-lines (nreverse error-lines)) | |
6435 | ;; Now read the numeric positions of file names. | |
6436 | (goto-char linebeg) | |
6437 | (forward-word 1) | |
6438 | (forward-char 3) | |
6439 | (while (< (point) end) | |
6440 | (let ((start (insert-directory-adj-pos | |
6441 | (+ beg (read (current-buffer))) | |
6442 | error-lines)) | |
6443 | (end (insert-directory-adj-pos | |
a1b0c2a7 | 6444 | (+ beg (read (current-buffer))) |
9bb99df6 | 6445 | error-lines))) |
26b9ecbc | 6446 | (if (memq (char-after end) '(?\n ?\s)) |
9bb99df6 LT |
6447 | ;; End is followed by \n or by " -> ". |
6448 | (put-text-property start end 'dired-filename t) | |
6449 | ;; It seems that we can't trust ls's output as to | |
6450 | ;; byte positions of filenames. | |
6451 | (put-text-property beg (point) 'dired-filename nil) | |
6452 | (end-of-line)))) | |
6453 | (goto-char end) | |
6454 | (beginning-of-line) | |
6455 | (delete-region (point) (progn (forward-line 1) (point)))) | |
6456 | ;; Take care of the case where the ls output contains a | |
6457 | ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line | |
6458 | ;; and we went one line too far back (see above). | |
6459 | (forward-line 1)) | |
6460 | (if (looking-at "//DIRED-OPTIONS//") | |
6461 | (delete-region (point) (progn (forward-line 1) (point))))) | |
ff7affeb | 6462 | |
99f01c91 | 6463 | ;; Now decode what read if necessary. |
b6647390 KH |
6464 | (let ((coding (or coding-system-for-read |
6465 | file-name-coding-system | |
6466 | default-file-name-coding-system | |
6467 | 'undecided)) | |
0bded065 | 6468 | coding-no-eol |
99f01c91 | 6469 | val pos) |
b6647390 KH |
6470 | (when (and enable-multibyte-characters |
6471 | (not (memq (coding-system-base coding) | |
6472 | '(raw-text no-conversion)))) | |
6473 | ;; If no coding system is specified or detection is | |
6474 | ;; requested, detect the coding. | |
6475 | (if (eq (coding-system-base coding) 'undecided) | |
6476 | (setq coding (detect-coding-region beg (point) t))) | |
6477 | (if (not (eq (coding-system-base coding) 'undecided)) | |
6478 | (save-restriction | |
0bded065 AS |
6479 | (setq coding-no-eol |
6480 | (coding-system-change-eol-conversion coding 'unix)) | |
b6647390 KH |
6481 | (narrow-to-region beg (point)) |
6482 | (goto-char (point-min)) | |
6483 | (while (not (eobp)) | |
6484 | (setq pos (point) | |
6485 | val (get-text-property (point) 'dired-filename)) | |
6486 | (goto-char (next-single-property-change | |
6487 | (point) 'dired-filename nil (point-max))) | |
0bded065 AS |
6488 | ;; Force no eol conversion on a file name, so |
6489 | ;; that CR is preserved. | |
6490 | (decode-coding-region pos (point) | |
6491 | (if val coding-no-eol coding)) | |
b6647390 KH |
6492 | (if val |
6493 | (put-text-property pos (point) | |
6494 | 'dired-filename t))))))) | |
99f01c91 | 6495 | |
75bb5ca4 AS |
6496 | (if full-directory-p |
6497 | ;; Try to insert the amount of free space. | |
6498 | (save-excursion | |
6499 | (goto-char beg) | |
6500 | ;; First find the line to put it on. | |
6501 | (when (re-search-forward "^ *\\(total\\)" nil t) | |
6502 | (let ((available (get-free-disk-space "."))) | |
6503 | (when available | |
6504 | ;; Replace "total" with "used", to avoid confusion. | |
6505 | (replace-match "total used in directory" nil nil nil 1) | |
6506 | (end-of-line) | |
7c2fb837 | 6507 | (insert " available " available)))))))))) |
34342a07 | 6508 | |
a1b0c2a7 | 6509 | (defun insert-directory-adj-pos (pos error-lines) |
fead94d6 | 6510 | "Convert `ls --dired' file name position value POS to a buffer position. |
a1b0c2a7 RS |
6511 | File name position values returned in ls --dired output |
6512 | count only stdout; they don't count the error messages sent to stderr. | |
6513 | So this function converts to them to real buffer positions. | |
6514 | ERROR-LINES is a list of buffer positions of error message lines, | |
6515 | of the form (START END)." | |
6516 | (while (and error-lines (< (caar error-lines) pos)) | |
6517 | (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines))))) | |
6518 | (pop error-lines)) | |
6519 | pos) | |
6520 | ||
bc22fd18 EZ |
6521 | (defun insert-directory-safely (file switches |
6522 | &optional wildcard full-directory-p) | |
6523 | "Insert directory listing for FILE, formatted according to SWITCHES. | |
6524 | ||
6525 | Like `insert-directory', but if FILE does not exist, it inserts a | |
6526 | message to that effect instead of signaling an error." | |
6527 | (if (file-exists-p file) | |
6528 | (insert-directory file switches wildcard full-directory-p) | |
6529 | ;; Simulate the message printed by `ls'. | |
6530 | (insert (format "%s: No such file or directory\n" file)))) | |
6531 | ||
88902b35 | 6532 | (defvar kill-emacs-query-functions nil |
65d5c6de | 6533 | "Functions to call with no arguments to query about killing Emacs. |
c80e3b4a | 6534 | If any of these functions returns nil, killing Emacs is canceled. |
6daab4ed JB |
6535 | `save-buffers-kill-emacs' calls these functions, but `kill-emacs', |
6536 | the low level primitive, does not. See also `kill-emacs-hook'.") | |
88902b35 | 6537 | |
11f15305 | 6538 | (defcustom confirm-kill-emacs nil |
9c2ba08f EZ |
6539 | "How to ask for confirmation when leaving Emacs. |
6540 | If nil, the default, don't ask at all. If the value is non-nil, it should | |
f3c60241 | 6541 | be a predicate function; for example `yes-or-no-p'." |
11f15305 GM |
6542 | :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p) |
6543 | (const :tag "Ask with y-or-n-p" y-or-n-p) | |
6abe4589 LI |
6544 | (const :tag "Don't confirm" nil) |
6545 | (function :tag "Predicate function")) | |
bdd9ab6e | 6546 | :group 'convenience |
11f15305 GM |
6547 | :version "21.1") |
6548 | ||
b4da00e9 RM |
6549 | (defun save-buffers-kill-emacs (&optional arg) |
6550 | "Offer to save each buffer, then kill this Emacs process. | |
02243d9d GM |
6551 | With prefix ARG, silently save all file-visiting buffers without asking. |
6552 | If there are active processes where `process-query-on-exit-flag' | |
6553 | returns non-nil, asks whether processes should be killed. | |
6554 | Runs the members of `kill-emacs-query-functions' in turn and stops | |
6555 | if any returns nil. If `confirm-kill-emacs' is non-nil, calls it." | |
b4da00e9 RM |
6556 | (interactive "P") |
6557 | (save-some-buffers arg t) | |
6558 | (and (or (not (memq t (mapcar (function | |
6559 | (lambda (buf) (and (buffer-file-name buf) | |
6560 | (buffer-modified-p buf)))) | |
6561 | (buffer-list)))) | |
6562 | (yes-or-no-p "Modified buffers exist; exit anyway? ")) | |
6563 | (or (not (fboundp 'process-list)) | |
7c2fb837 | 6564 | ;; process-list is not defined on MSDOS. |
b4da00e9 RM |
6565 | (let ((processes (process-list)) |
6566 | active) | |
6567 | (while processes | |
48a4a1fb KS |
6568 | (and (memq (process-status (car processes)) '(run stop open listen)) |
6569 | (process-query-on-exit-flag (car processes)) | |
b4da00e9 RM |
6570 | (setq active t)) |
6571 | (setq processes (cdr processes))) | |
6572 | (or (not active) | |
b92631bf | 6573 | (with-current-buffer-window |
c5e28e39 MR |
6574 | (get-buffer-create "*Process List*") nil |
6575 | #'(lambda (window _value) | |
6576 | (with-selected-window window | |
6577 | (unwind-protect | |
6578 | (yes-or-no-p "Active processes exist; kill them and exit anyway? ") | |
6579 | (when (window-live-p window) | |
6580 | (quit-restore-window window 'kill))))) | |
6581 | (list-processes t))))) | |
88902b35 | 6582 | ;; Query the user for other things, perhaps. |
fb15c113 | 6583 | (run-hook-with-args-until-failure 'kill-emacs-query-functions) |
11f15305 GM |
6584 | (or (null confirm-kill-emacs) |
6585 | (funcall confirm-kill-emacs "Really exit Emacs? ")) | |
b4da00e9 | 6586 | (kill-emacs))) |
59e085e0 | 6587 | |
6ed8eeff | 6588 | (defun save-buffers-kill-terminal (&optional arg) |
59e085e0 KL |
6589 | "Offer to save each buffer, then kill the current connection. |
6590 | If the current frame has no client, kill Emacs itself. | |
6591 | ||
8fc29035 | 6592 | With prefix ARG, silently save all file-visiting buffers, then kill. |
59e085e0 KL |
6593 | |
6594 | If emacsclient was started with a list of filenames to edit, then | |
6595 | only these files will be asked to be saved." | |
6596 | (interactive "P") | |
3b734d1c | 6597 | (if (frame-parameter nil 'client) |
0eef14bd CY |
6598 | (server-save-buffers-kill-terminal arg) |
6599 | (save-buffers-kill-emacs arg))) | |
b4da00e9 | 6600 | \f |
ffc0e1ca | 6601 | ;; We use /: as a prefix to "quote" a file name |
47afc068 RS |
6602 | ;; so that magic file name handlers will not apply to it. |
6603 | ||
6604 | (setq file-name-handler-alist | |
6d341a2a | 6605 | (cons (cons (purecopy "\\`/:") 'file-name-non-special) |
47afc068 RS |
6606 | file-name-handler-alist)) |
6607 | ||
6608 | ;; We depend on being the last handler on the list, | |
6609 | ;; so that anything else which does need handling | |
6610 | ;; has been handled already. | |
6611 | ;; So it is safe for us to inhibit *all* magic file name handlers. | |
6612 | ||
6613 | (defun file-name-non-special (operation &rest arguments) | |
6614 | (let ((file-name-handler-alist nil) | |
5cb1f728 KH |
6615 | (default-directory |
6616 | (if (eq operation 'insert-directory) | |
6617 | (directory-file-name | |
ffc0e1ca | 6618 | (expand-file-name |
5cb1f728 KH |
6619 | (unhandled-file-name-directory default-directory))) |
6620 | default-directory)) | |
47afc068 RS |
6621 | ;; Get a list of the indices of the args which are file names. |
6622 | (file-arg-indices | |
6623 | (cdr (or (assq operation | |
ae3b2983 | 6624 | ;; The first six are special because they |
47afc068 RS |
6625 | ;; return a file name. We want to include the /: |
6626 | ;; in the return value. | |
6627 | ;; So just avoid stripping it in the first place. | |
6628 | '((expand-file-name . nil) | |
6629 | (file-name-directory . nil) | |
6630 | (file-name-as-directory . nil) | |
6631 | (directory-file-name . nil) | |
c736f678 | 6632 | (file-name-sans-versions . nil) |
ae3b2983 | 6633 | (find-backup-file-name . nil) |
c736f678 | 6634 | ;; `identity' means just return the first arg |
6750c852 RS |
6635 | ;; not stripped of its quoting. |
6636 | (substitute-in-file-name identity) | |
ae3b2983 MA |
6637 | ;; `add' means add "/:" to the result. |
6638 | (file-truename add 0) | |
10e1d5f3 | 6639 | (insert-file-contents insert-file-contents 0) |
ae3b2983 MA |
6640 | ;; `unquote-then-quote' means set buffer-file-name |
6641 | ;; temporarily to unquoted filename. | |
6642 | (verify-visited-file-modtime unquote-then-quote) | |
6643 | ;; List the arguments which are filenames. | |
c37adaa5 SM |
6644 | (file-name-completion 1) |
6645 | (file-name-all-completions 1) | |
ae3b2983 | 6646 | (write-region 2 5) |
47afc068 RS |
6647 | (rename-file 0 1) |
6648 | (copy-file 0 1) | |
6649 | (make-symbolic-link 0 1) | |
6650 | (add-name-to-file 0 1))) | |
6651 | ;; For all other operations, treat the first argument only | |
6652 | ;; as the file name. | |
6653 | '(nil 0)))) | |
6750c852 | 6654 | method |
47afc068 RS |
6655 | ;; Copy ARGUMENTS so we can replace elements in it. |
6656 | (arguments (copy-sequence arguments))) | |
6750c852 RS |
6657 | (if (symbolp (car file-arg-indices)) |
6658 | (setq method (pop file-arg-indices))) | |
6659 | ;; Strip off the /: from the file names that have it. | |
47afc068 | 6660 | (save-match-data |
18b9dced | 6661 | (while (consp file-arg-indices) |
fe4d9852 KH |
6662 | (let ((pair (nthcdr (car file-arg-indices) arguments))) |
6663 | (and (car pair) | |
6664 | (string-match "\\`/:" (car pair)) | |
6665 | (setcar pair | |
6666 | (if (= (length (car pair)) 2) | |
6667 | "/" | |
6668 | (substring (car pair) 2))))) | |
47afc068 | 6669 | (setq file-arg-indices (cdr file-arg-indices)))) |
36cec983 SM |
6670 | (pcase method |
6671 | (`identity (car arguments)) | |
6672 | (`add (concat "/:" (apply operation arguments))) | |
6673 | (`insert-file-contents | |
10e1d5f3 SM |
6674 | (let ((visit (nth 1 arguments))) |
6675 | (prog1 | |
5a315f9c | 6676 | (apply operation arguments) |
10e1d5f3 SM |
6677 | (when (and visit buffer-file-name) |
6678 | (setq buffer-file-name (concat "/:" buffer-file-name)))))) | |
36cec983 | 6679 | (`unquote-then-quote |
10e1d5f3 SM |
6680 | (let ((buffer-file-name (substring buffer-file-name 2))) |
6681 | (apply operation arguments))) | |
36cec983 | 6682 | (_ |
5a315f9c | 6683 | (apply operation arguments))))) |
47afc068 | 6684 | \f |
90d10f16 MC |
6685 | ;; Symbolic modes and read-file-modes. |
6686 | ||
6687 | (defun file-modes-char-to-who (char) | |
e240aaa9 EZ |
6688 | "Convert CHAR to a numeric bit-mask for extracting mode bits. |
6689 | CHAR is in [ugoa] and represents the category of users (Owner, Group, | |
6690 | Others, or All) for whom to produce the mask. | |
6691 | The bit-mask that is returned extracts from mode bits the access rights | |
6692 | for the specified category of users." | |
90d10f16 MC |
6693 | (cond ((= char ?u) #o4700) |
6694 | ((= char ?g) #o2070) | |
6695 | ((= char ?o) #o1007) | |
6696 | ((= char ?a) #o7777) | |
6697 | (t (error "%c: bad `who' character" char)))) | |
6698 | ||
6699 | (defun file-modes-char-to-right (char &optional from) | |
e240aaa9 EZ |
6700 | "Convert CHAR to a numeric value of mode bits. |
6701 | CHAR is in [rwxXstugo] and represents symbolic access permissions. | |
6702 | If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)." | |
90d10f16 MC |
6703 | (or from (setq from 0)) |
6704 | (cond ((= char ?r) #o0444) | |
6705 | ((= char ?w) #o0222) | |
6706 | ((= char ?x) #o0111) | |
6707 | ((= char ?s) #o1000) | |
6708 | ((= char ?t) #o6000) | |
6709 | ;; Rights relative to the previous file modes. | |
6710 | ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111)) | |
6711 | ((= char ?u) (let ((uright (logand #o4700 from))) | |
6712 | (+ uright (/ uright #o10) (/ uright #o100)))) | |
6713 | ((= char ?g) (let ((gright (logand #o2070 from))) | |
6714 | (+ gright (/ gright #o10) (* gright #o10)))) | |
6715 | ((= char ?o) (let ((oright (logand #o1007 from))) | |
6716 | (+ oright (* oright #o10) (* oright #o100)))) | |
6717 | (t (error "%c: bad right character" char)))) | |
6718 | ||
6719 | (defun file-modes-rights-to-number (rights who-mask &optional from) | |
e240aaa9 | 6720 | "Convert a symbolic mode string specification to an equivalent number. |
ca66f00d | 6721 | RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\". |
e240aaa9 EZ |
6722 | WHO-MASK is the bit-mask specifying the category of users to which to |
6723 | apply the access permissions. See `file-modes-char-to-who'. | |
6724 | FROM (or 0 if nil) gives the mode bits on which to base permissions if | |
6725 | RIGHTS request to add, remove, or set permissions based on existing ones, | |
6726 | as in \"og+rX-w\"." | |
90d10f16 MC |
6727 | (let* ((num-rights (or from 0)) |
6728 | (list-rights (string-to-list rights)) | |
6729 | (op (pop list-rights))) | |
6730 | (while (memq op '(?+ ?- ?=)) | |
6731 | (let ((num-right 0) | |
6732 | char-right) | |
6733 | (while (memq (setq char-right (pop list-rights)) | |
6734 | '(?r ?w ?x ?X ?s ?t ?u ?g ?o)) | |
6735 | (setq num-right | |
6736 | (logior num-right | |
6737 | (file-modes-char-to-right char-right num-rights)))) | |
6738 | (setq num-right (logand who-mask num-right) | |
6739 | num-rights | |
6740 | (cond ((= op ?+) (logior num-rights num-right)) | |
6741 | ((= op ?-) (logand num-rights (lognot num-right))) | |
6742 | (t (logior (logand num-rights (lognot who-mask)) num-right))) | |
6743 | op char-right))) | |
6744 | num-rights)) | |
6745 | ||
6746 | (defun file-modes-symbolic-to-number (modes &optional from) | |
6747 | "Convert symbolic file modes to numeric file modes. | |
6748 | MODES is the string to convert, it should match | |
ca66f00d | 6749 | \"[ugoa]*([+-=][rwxXstugo]*)+,...\". |
64b51947 | 6750 | See Info node `(coreutils)File permissions' for more information on this |
90d10f16 | 6751 | notation. |
e240aaa9 EZ |
6752 | FROM (or 0 if nil) gives the mode bits on which to base permissions if |
6753 | MODES request to add, remove, or set permissions based on existing ones, | |
6754 | as in \"og+rX-w\"." | |
90d10f16 MC |
6755 | (save-match-data |
6756 | (let ((case-fold-search nil) | |
6757 | (num-modes (or from 0))) | |
6758 | (while (/= (string-to-char modes) 0) | |
ca66f00d | 6759 | (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes) |
90d10f16 MC |
6760 | (let ((num-who (apply 'logior 0 |
6761 | (mapcar 'file-modes-char-to-who | |
6762 | (match-string 1 modes))))) | |
6763 | (when (= num-who 0) | |
6764 | (setq num-who (default-file-modes))) | |
6765 | (setq num-modes | |
6766 | (file-modes-rights-to-number (substring modes (match-end 1)) | |
6767 | num-who num-modes) | |
6768 | modes (substring modes (match-end 3)))) | |
6769 | (error "Parse error in modes near `%s'" (substring modes 0)))) | |
6770 | num-modes))) | |
6771 | ||
6772 | (defun read-file-modes (&optional prompt orig-file) | |
e240aaa9 | 6773 | "Read file modes in octal or symbolic notation and return its numeric value. |
90d10f16 | 6774 | PROMPT is used as the prompt, default to `File modes (octal or symbolic): '. |
e240aaa9 EZ |
6775 | ORIG-FILE is the name of a file on whose mode bits to base returned |
6776 | permissions if what user types requests to add, remove, or set permissions | |
6777 | based on existing mode bits, as in \"og+rX-w\"." | |
90d10f16 MC |
6778 | (let* ((modes (or (if orig-file (file-modes orig-file) 0) |
6779 | (error "File not found"))) | |
7cb41b32 JL |
6780 | (modestr (and (stringp orig-file) |
6781 | (nth 8 (file-attributes orig-file)))) | |
6782 | (default | |
6783 | (and (stringp modestr) | |
6784 | (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr) | |
6785 | (replace-regexp-in-string | |
6786 | "-" "" | |
6787 | (format "u=%s,g=%s,o=%s" | |
6788 | (match-string 1 modestr) | |
6789 | (match-string 2 modestr) | |
6790 | (match-string 3 modestr))))) | |
6791 | (value (read-string (or prompt "File modes (octal or symbolic): ") | |
6792 | nil nil default))) | |
90d10f16 MC |
6793 | (save-match-data |
6794 | (if (string-match "^[0-7]+" value) | |
6795 | (string-to-number value 8) | |
6796 | (file-modes-symbolic-to-number value modes))))) | |
6797 | ||
ed4fd9c5 DA |
6798 | (define-obsolete-variable-alias 'cache-long-line-scans |
6799 | 'cache-long-scans "24.4") | |
6800 | ||
e240aaa9 | 6801 | ;; Trashcan handling. |
d63a01ef | 6802 | (defcustom trash-directory nil |
6cf29fe8 | 6803 | "Directory for `move-file-to-trash' to move files and directories to. |
d63a01ef CY |
6804 | This directory is only used when the function `system-move-file-to-trash' |
6805 | is not defined. | |
6806 | Relative paths are interpreted relative to `default-directory'. | |
6807 | If the value is nil, Emacs uses a freedesktop.org-style trashcan." | |
f7c0d931 | 6808 | :type '(choice (const nil) directory) |
6cf29fe8 | 6809 | :group 'auto-save |
d63a01ef CY |
6810 | :version "23.2") |
6811 | ||
6812 | (defvar trash--hexify-table) | |
6cf29fe8 JR |
6813 | |
6814 | (declare-function system-move-file-to-trash "w32fns.c" (filename)) | |
6815 | ||
6816 | (defun move-file-to-trash (filename) | |
d63a01ef CY |
6817 | "Move the file (or directory) named FILENAME to the trash. |
6818 | When `delete-by-moving-to-trash' is non-nil, this function is | |
6819 | called by `delete-file' and `delete-directory' instead of | |
6820 | deleting files outright. | |
6821 | ||
6822 | If the function `system-move-file-to-trash' is defined, call it | |
6823 | with FILENAME as an argument. | |
6824 | Otherwise, if `trash-directory' is non-nil, move FILENAME to that | |
6825 | directory. | |
6826 | Otherwise, trash FILENAME using the freedesktop.org conventions, | |
6827 | like the GNOME, KDE and XFCE desktop environments. Emacs only | |
6828 | moves files to \"home trash\", ignoring per-volume trashcans." | |
6cf29fe8 | 6829 | (interactive "fMove file to trash: ") |
d63a01ef CY |
6830 | (cond (trash-directory |
6831 | ;; If `trash-directory' is non-nil, move the file there. | |
6832 | (let* ((trash-dir (expand-file-name trash-directory)) | |
6833 | (fn (directory-file-name (expand-file-name filename))) | |
6834 | (new-fn (expand-file-name (file-name-nondirectory fn) | |
6835 | trash-dir))) | |
6836 | ;; We can't trash a parent directory of trash-directory. | |
1acad97c | 6837 | (if (string-prefix-p fn trash-dir) |
d63a01ef CY |
6838 | (error "Trash directory `%s' is a subdirectory of `%s'" |
6839 | trash-dir filename)) | |
6840 | (unless (file-directory-p trash-dir) | |
6841 | (make-directory trash-dir t)) | |
6842 | ;; Ensure that the trashed file-name is unique. | |
6843 | (if (file-exists-p new-fn) | |
6844 | (let ((version-control t) | |
6845 | (backup-directory-alist nil)) | |
6846 | (setq new-fn (car (find-backup-file-name new-fn))))) | |
6847 | (let (delete-by-moving-to-trash) | |
6848 | (rename-file fn new-fn)))) | |
6849 | ;; If `system-move-file-to-trash' is defined, use it. | |
6850 | ((fboundp 'system-move-file-to-trash) | |
6851 | (system-move-file-to-trash filename)) | |
6852 | ;; Otherwise, use the freedesktop.org method, as specified at | |
6853 | ;; http://freedesktop.org/wiki/Specifications/trash-spec | |
6854 | (t | |
6855 | (let* ((xdg-data-dir | |
6856 | (directory-file-name | |
6857 | (expand-file-name "Trash" | |
6858 | (or (getenv "XDG_DATA_HOME") | |
6859 | "~/.local/share")))) | |
6860 | (trash-files-dir (expand-file-name "files" xdg-data-dir)) | |
6861 | (trash-info-dir (expand-file-name "info" xdg-data-dir)) | |
6862 | (fn (directory-file-name (expand-file-name filename)))) | |
6863 | ||
6864 | ;; Check if we have permissions to delete. | |
6865 | (unless (file-writable-p (directory-file-name | |
6866 | (file-name-directory fn))) | |
6867 | (error "Cannot move %s to trash: Permission denied" filename)) | |
6868 | ;; The trashed file cannot be the trash dir or its parent. | |
1acad97c | 6869 | (if (string-prefix-p fn trash-files-dir) |
d63a01ef CY |
6870 | (error "The trash directory %s is a subdirectory of %s" |
6871 | trash-files-dir filename)) | |
1acad97c | 6872 | (if (string-prefix-p fn trash-info-dir) |
d63a01ef CY |
6873 | (error "The trash directory %s is a subdirectory of %s" |
6874 | trash-info-dir filename)) | |
6875 | ||
6876 | ;; Ensure that the trash directory exists; otherwise, create it. | |
6877 | (let ((saved-default-file-modes (default-file-modes))) | |
6bb72cbd PE |
6878 | (unwind-protect |
6879 | (progn | |
6880 | (set-default-file-modes #o700) | |
6881 | (unless (file-exists-p trash-files-dir) | |
6882 | (make-directory trash-files-dir t)) | |
6883 | (unless (file-exists-p trash-info-dir) | |
6884 | (make-directory trash-info-dir t))) | |
6885 | (set-default-file-modes saved-default-file-modes))) | |
d63a01ef CY |
6886 | |
6887 | ;; Try to move to trash with .trashinfo undo information | |
6888 | (save-excursion | |
6889 | (with-temp-buffer | |
6890 | (set-buffer-file-coding-system 'utf-8-unix) | |
6891 | (insert "[Trash Info]\nPath=") | |
6892 | ;; Perform url-encoding on FN. For compatibility with | |
6893 | ;; other programs (e.g. XFCE Thunar), allow literal "/" | |
6894 | ;; for path separators. | |
6895 | (unless (boundp 'trash--hexify-table) | |
6896 | (setq trash--hexify-table (make-vector 256 nil)) | |
6897 | (let ((unreserved-chars | |
6898 | (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m | |
6899 | ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A | |
6900 | ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O | |
6901 | ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2 | |
6902 | ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?' | |
6903 | ?\( ?\)))) | |
6904 | (dotimes (byte 256) | |
6905 | (aset trash--hexify-table byte | |
6906 | (if (memq byte unreserved-chars) | |
6907 | (char-to-string byte) | |
6908 | (format "%%%02x" byte)))))) | |
6909 | (mapc (lambda (byte) | |
6910 | (insert (aref trash--hexify-table byte))) | |
6911 | (if (multibyte-string-p fn) | |
6912 | (encode-coding-string fn 'utf-8) | |
6913 | fn)) | |
6914 | (insert "\nDeletionDate=" | |
6915 | (format-time-string "%Y-%m-%dT%T") | |
6916 | "\n") | |
6917 | ||
6918 | ;; Attempt to make .trashinfo file, trying up to 5 | |
6919 | ;; times. The .trashinfo file is opened with O_EXCL, | |
6920 | ;; as per trash-spec 0.7, even if that can be a problem | |
6921 | ;; on old NFS versions... | |
6922 | (let* ((tries 5) | |
6923 | (base-fn (expand-file-name | |
6924 | (file-name-nondirectory fn) | |
6925 | trash-files-dir)) | |
6926 | (new-fn base-fn) | |
6927 | success info-fn) | |
6928 | (while (> tries 0) | |
6929 | (setq info-fn (expand-file-name | |
6930 | (concat (file-name-nondirectory new-fn) | |
6931 | ".trashinfo") | |
6932 | trash-info-dir)) | |
6933 | (unless (condition-case nil | |
6934 | (progn | |
6935 | (write-region nil nil info-fn nil | |
6936 | 'quiet info-fn 'excl) | |
6937 | (setq tries 0 success t)) | |
6938 | (file-already-exists nil)) | |
6939 | (setq tries (1- tries)) | |
8350f087 | 6940 | ;; Uniquify new-fn. (Some file managers do not |
d63a01ef CY |
6941 | ;; like Emacs-style backup file names---e.g. bug |
6942 | ;; 170956 in Konqueror bug tracker.) | |
6943 | (setq new-fn (make-temp-name (concat base-fn "_"))))) | |
6944 | (unless success | |
6945 | (error "Cannot move %s to trash: Lock failed" filename)) | |
6946 | ||
6947 | ;; Finally, try to move the file to the trashcan. | |
6948 | (let ((delete-by-moving-to-trash nil)) | |
6949 | (rename-file fn new-fn))))))))) | |
6cf29fe8 JR |
6950 | |
6951 | \f | |
b4da00e9 | 6952 | (define-key ctl-x-map "\C-f" 'find-file) |
b4da00e9 RM |
6953 | (define-key ctl-x-map "\C-r" 'find-file-read-only) |
6954 | (define-key ctl-x-map "\C-v" 'find-alternate-file) | |
6955 | (define-key ctl-x-map "\C-s" 'save-buffer) | |
6956 | (define-key ctl-x-map "s" 'save-some-buffers) | |
6957 | (define-key ctl-x-map "\C-w" 'write-file) | |
6958 | (define-key ctl-x-map "i" 'insert-file) | |
6959 | (define-key esc-map "~" 'not-modified) | |
6960 | (define-key ctl-x-map "\C-d" 'list-directory) | |
6ed8eeff | 6961 | (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal) |
3df47cd5 | 6962 | (define-key ctl-x-map "\C-q" 'read-only-mode) |
b4da00e9 RM |
6963 | |
6964 | (define-key ctl-x-4-map "f" 'find-file-other-window) | |
6965 | (define-key ctl-x-4-map "r" 'find-file-read-only-other-window) | |
6966 | (define-key ctl-x-4-map "\C-f" 'find-file-other-window) | |
6967 | (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window) | |
924f0a24 | 6968 | (define-key ctl-x-4-map "\C-o" 'display-buffer) |
5bbbceb1 | 6969 | |
f98955ea JB |
6970 | (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame) |
6971 | (define-key ctl-x-5-map "f" 'find-file-other-frame) | |
6972 | (define-key ctl-x-5-map "\C-f" 'find-file-other-frame) | |
6973 | (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame) | |
3095ccf5 | 6974 | (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame) |
c0274f38 ER |
6975 | |
6976 | ;;; files.el ends here |