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