Commit | Line | Data |
---|---|---|
570d7624 | 1 | /* File IO for GNU Emacs. |
e9bffc61 | 2 | |
ba318903 | 3 | Copyright (C) 1985-1988, 1993-2014 Free Software Foundation, Inc. |
570d7624 JB |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
9ec0b715 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
570d7624 | 8 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
570d7624 JB |
11 | |
12 | GNU Emacs is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
570d7624 | 19 | |
18160b98 | 20 | #include <config.h> |
77a28bbf | 21 | #include <limits.h> |
bb369dc6 | 22 | #include <fcntl.h> |
406af475 | 23 | #include "sysstdio.h" |
570d7624 JB |
24 | #include <sys/types.h> |
25 | #include <sys/stat.h> | |
29beb080 | 26 | #include <unistd.h> |
29beb080 | 27 | |
5b9c0a1d | 28 | #ifdef HAVE_PWD_H |
570d7624 | 29 | #include <pwd.h> |
bfb61299 JB |
30 | #endif |
31 | ||
570d7624 JB |
32 | #include <errno.h> |
33 | ||
574c05e2 KK |
34 | #ifdef HAVE_LIBSELINUX |
35 | #include <selinux/selinux.h> | |
36 | #include <selinux/context.h> | |
37 | #endif | |
38 | ||
ffdc270a | 39 | #ifdef HAVE_ACL_SET_FILE |
7c3d167f RF |
40 | #include <sys/acl.h> |
41 | #endif | |
42 | ||
620f13b0 PE |
43 | #include <c-ctype.h> |
44 | ||
570d7624 | 45 | #include "lisp.h" |
8d4e077b | 46 | #include "intervals.h" |
db327c7e | 47 | #include "character.h" |
e5560ff7 | 48 | #include "buffer.h" |
6fdaa9a0 | 49 | #include "coding.h" |
570d7624 | 50 | #include "window.h" |
67c08d6c | 51 | #include "blockinput.h" |
addccbd0 | 52 | #include "region-cache.h" |
385ed61f KL |
53 | #include "frame.h" |
54 | #include "dispextern.h" | |
570d7624 | 55 | |
5e570b75 RS |
56 | #ifdef WINDOWSNT |
57 | #define NOMINMAX 1 | |
58 | #include <windows.h> | |
bb385a92 | 59 | #include <sys/file.h> |
a68089e4 | 60 | #include "w32.h" |
5e570b75 RS |
61 | #endif /* not WINDOWSNT */ |
62 | ||
7990d02a EZ |
63 | #ifdef MSDOS |
64 | #include "msdos.h" | |
65 | #include <sys/param.h> | |
7990d02a | 66 | #endif |
7990d02a | 67 | |
199607e4 | 68 | #ifdef DOS_NT |
199607e4 | 69 | /* On Windows, drive letters must be alphabetic - on DOS, the Netware |
a5bb9bd3 | 70 | redirector allows the six letters between 'Z' and 'a' as well. */ |
199607e4 RS |
71 | #ifdef MSDOS |
72 | #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z') | |
73 | #endif | |
74 | #ifdef WINDOWSNT | |
620f13b0 | 75 | #define IS_DRIVE(x) c_isalpha (x) |
199607e4 | 76 | #endif |
f54b565c | 77 | /* Need to lower-case the drive letter, or else expanded |
53964682 | 78 | filenames will sometimes compare unequal, because |
f54b565c | 79 | `expand-file-name' doesn't always down-case the drive letter. */ |
620f13b0 | 80 | #define DRIVE_LETTER(x) c_tolower (x) |
199607e4 RS |
81 | #endif |
82 | ||
de5bf5d3 | 83 | #include "systime.h" |
ffdc270a | 84 | #include <acl.h> |
8654f9d7 PE |
85 | #include <allocator.h> |
86 | #include <careadlinkat.h> | |
d35af63c | 87 | #include <stat-time.h> |
570d7624 JB |
88 | |
89 | #ifdef HPUX | |
90 | #include <netio.h> | |
47e7b9e5 | 91 | #endif |
570d7624 | 92 | |
9c856db9 | 93 | #include "commands.h" |
9c856db9 | 94 | |
f75d7a91 PE |
95 | /* True during writing of auto-save files. */ |
96 | static bool auto_saving; | |
570d7624 | 97 | |
a560b856 PE |
98 | /* Emacs's real umask. */ |
99 | static mode_t realmask; | |
100 | ||
71873e2b | 101 | /* Nonzero umask during creation of auto-save directories. */ |
f75d7a91 | 102 | static mode_t auto_saving_dir_umask; |
09450bae | 103 | |
570d7624 | 104 | /* Set by auto_save_1 to mode of original file so Fwrite_region will create |
71873e2b | 105 | a new file with the same mode as the original. */ |
f75d7a91 | 106 | static mode_t auto_save_mode_bits; |
570d7624 | 107 | |
71873e2b | 108 | /* Set by auto_save_1 if an error occurred during the last auto-save. */ |
f75d7a91 | 109 | static bool auto_save_error_occurred; |
ca730bf0 | 110 | |
9fe43ff6 PE |
111 | /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device |
112 | number of a file system where time stamps were observed to to work. */ | |
113 | static bool valid_timestamp_file_system; | |
114 | static dev_t timestamp_file_system; | |
115 | ||
356a6224 KH |
116 | /* The symbol bound to coding-system-for-read when |
117 | insert-file-contents is called for recovering a file. This is not | |
118 | an actual coding system name, but just an indicator to tell | |
119 | insert-file-contents to use `emacs-mule' with a special flag for | |
120 | auto saving and recovering a file. */ | |
955cbe7b | 121 | static Lisp_Object Qauto_save_coding; |
356a6224 | 122 | |
f6c9b683 RS |
123 | /* Property name of a file name handler, |
124 | which gives a list of operations it handles.. */ | |
955cbe7b | 125 | static Lisp_Object Qoperations; |
f6c9b683 | 126 | |
71873e2b | 127 | /* Lisp functions for translating file formats. */ |
955cbe7b | 128 | static Lisp_Object Qformat_decode, Qformat_annotate_function; |
0d420e88 | 129 | |
2080470e | 130 | /* Lisp function for setting buffer-file-coding-system and the |
b6426b03 | 131 | multibyteness of the current buffer after inserting a file. */ |
955cbe7b | 132 | static Lisp_Object Qafter_insert_file_set_coding; |
b6426b03 | 133 | |
955cbe7b | 134 | static Lisp_Object Qwrite_region_annotate_functions; |
67fbc0cb CY |
135 | /* Each time an annotation function changes the buffer, the new buffer |
136 | is added here. */ | |
5045092b | 137 | static Lisp_Object Vwrite_region_annotation_buffers; |
67fbc0cb | 138 | |
955cbe7b | 139 | static Lisp_Object Qdelete_by_moving_to_trash; |
d2b66acf | 140 | |
6cf29fe8 | 141 | /* Lisp function for moving files to trash. */ |
955cbe7b | 142 | static Lisp_Object Qmove_file_to_trash; |
6cf29fe8 | 143 | |
8719abec | 144 | /* Lisp function for recursively copying directories. */ |
955cbe7b | 145 | static Lisp_Object Qcopy_directory; |
8719abec CY |
146 | |
147 | /* Lisp function for recursively deleting directories. */ | |
955cbe7b | 148 | static Lisp_Object Qdelete_directory; |
8719abec | 149 | |
ee041f2d SM |
150 | static Lisp_Object Qsubstitute_env_in_file_name; |
151 | ||
86dfb7a8 | 152 | Lisp_Object Qfile_error, Qfile_notify_error; |
955cbe7b PE |
153 | static Lisp_Object Qfile_already_exists, Qfile_date_error; |
154 | static Lisp_Object Qexcl; | |
15c65264 RS |
155 | Lisp_Object Qfile_name_history; |
156 | ||
955cbe7b | 157 | static Lisp_Object Qcar_less_than_car; |
d6a3cc15 | 158 | |
f75d7a91 PE |
159 | static bool a_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t, |
160 | Lisp_Object *, struct coding_system *); | |
161 | static bool e_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t, | |
162 | struct coding_system *); | |
ce51c54c | 163 | |
ec7adf26 | 164 | \f |
3d798ba7 PE |
165 | /* Return true if FILENAME exists. */ |
166 | ||
167 | static bool | |
168 | check_existing (const char *filename) | |
169 | { | |
170 | return faccessat (AT_FDCWD, filename, F_OK, AT_EACCESS) == 0; | |
171 | } | |
172 | ||
173 | /* Return true if file FILENAME exists and can be executed. */ | |
174 | ||
175 | static bool | |
176 | check_executable (char *filename) | |
177 | { | |
178 | return faccessat (AT_FDCWD, filename, X_OK, AT_EACCESS) == 0; | |
179 | } | |
180 | ||
181 | /* Return true if file FILENAME exists and can be accessed | |
182 | according to AMODE, which should include W_OK. | |
183 | On failure, return false and set errno. */ | |
184 | ||
185 | static bool | |
186 | check_writable (const char *filename, int amode) | |
187 | { | |
188 | #ifdef MSDOS | |
189 | /* FIXME: an faccessat implementation should be added to the | |
190 | DOS/Windows ports and this #ifdef branch should be removed. */ | |
191 | struct stat st; | |
192 | if (stat (filename, &st) < 0) | |
193 | return 0; | |
194 | errno = EPERM; | |
195 | return (st.st_mode & S_IWRITE || S_ISDIR (st.st_mode)); | |
196 | #else /* not MSDOS */ | |
197 | bool res = faccessat (AT_FDCWD, filename, amode, AT_EACCESS) == 0; | |
198 | #ifdef CYGWIN | |
199 | /* faccessat may have returned failure because Cygwin couldn't | |
200 | determine the file's UID or GID; if so, we return success. */ | |
201 | if (!res) | |
202 | { | |
203 | int faccessat_errno = errno; | |
204 | struct stat st; | |
205 | if (stat (filename, &st) < 0) | |
206 | return 0; | |
207 | res = (st.st_uid == -1 || st.st_gid == -1); | |
208 | errno = faccessat_errno; | |
209 | } | |
210 | #endif /* CYGWIN */ | |
211 | return res; | |
212 | #endif /* not MSDOS */ | |
213 | } | |
214 | \f | |
a773ed9a | 215 | /* Signal a file-access failure. STRING describes the failure, |
a9757f6a PE |
216 | NAME the file involved, and ERRORNO the errno value. |
217 | ||
218 | If NAME is neither null nor a pair, package it up as a singleton | |
219 | list before reporting it; this saves report_file_errno's caller the | |
220 | trouble of preserving errno before calling list1. */ | |
a773ed9a | 221 | |
5d01d666 | 222 | void |
a9757f6a | 223 | report_file_errno (char const *string, Lisp_Object name, int errorno) |
570d7624 | 224 | { |
a9757f6a | 225 | Lisp_Object data = CONSP (name) || NILP (name) ? name : list1 (name); |
570d7624 | 226 | Lisp_Object errstring; |
d7259fdb | 227 | char *str; |
570d7624 | 228 | |
ca9c0567 | 229 | synchronize_system_messages_locale (); |
d7259fdb | 230 | str = strerror (errorno); |
d7ea76b4 | 231 | errstring = code_convert_string_norecord (build_unibyte_string (str), |
68c45bf0 PE |
232 | Vlocale_coding_system, 0); |
233 | ||
570d7624 | 234 | while (1) |
505ab9bc RS |
235 | switch (errorno) |
236 | { | |
237 | case EEXIST: | |
24b1ddad | 238 | xsignal (Qfile_already_exists, Fcons (errstring, data)); |
505ab9bc RS |
239 | break; |
240 | default: | |
241 | /* System error messages are capitalized. Downcase the initial | |
39824137 EZ |
242 | unless it is followed by a slash. (The slash case caters to |
243 | error messages that begin with "I/O" or, in German, "E/A".) */ | |
d5443ffd KH |
244 | if (STRING_MULTIBYTE (errstring) |
245 | && ! EQ (Faref (errstring, make_number (1)), make_number ('/'))) | |
6c0969ca KH |
246 | { |
247 | int c; | |
248 | ||
51b59d79 | 249 | str = SSDATA (errstring); |
5976c3fe | 250 | c = STRING_CHAR ((unsigned char *) str); |
5da9919f | 251 | Faset (errstring, make_number (0), make_number (downcase (c))); |
6c0969ca | 252 | } |
505ab9bc | 253 | |
24b1ddad | 254 | xsignal (Qfile_error, |
505ab9bc RS |
255 | Fcons (build_string (string), Fcons (errstring, data))); |
256 | } | |
570d7624 | 257 | } |
b5148e85 | 258 | |
a9757f6a | 259 | /* Signal a file-access failure that set errno. STRING describes the |
b648c163 PE |
260 | failure, NAME the file involved. When invoking this function, take |
261 | care to not use arguments such as build_string ("foo") that involve | |
262 | side effects that may set errno. */ | |
a9757f6a | 263 | |
a773ed9a | 264 | void |
a9757f6a | 265 | report_file_error (char const *string, Lisp_Object name) |
a773ed9a | 266 | { |
a9757f6a | 267 | report_file_errno (string, name, errno); |
a773ed9a PE |
268 | } |
269 | ||
27e498e6 PE |
270 | void |
271 | close_file_unwind (int fd) | |
b5148e85 | 272 | { |
a0931322 | 273 | emacs_close (fd); |
b5148e85 | 274 | } |
a1d2b64a | 275 | |
5d1922cd BT |
276 | void |
277 | close_file_ptr_unwind (void *fdp) | |
278 | { | |
279 | int fd = *((int *) fdp); | |
280 | if (fd >= 0) | |
281 | emacs_close (fd); | |
282 | } | |
283 | ||
f4b1eb36 PE |
284 | void |
285 | fclose_unwind (void *arg) | |
286 | { | |
287 | FILE *stream = arg; | |
288 | fclose (stream); | |
289 | } | |
290 | ||
5d1922cd BT |
291 | void |
292 | fclose_ptr_unwind (void *arg) | |
293 | { | |
294 | FILE *stream = *((void **) arg); | |
295 | if (stream) | |
296 | fclose (stream); | |
297 | } | |
298 | ||
a1d2b64a RS |
299 | /* Restore point, having saved it as a marker. */ |
300 | ||
27e498e6 | 301 | void |
971de7fb | 302 | restore_point_unwind (Lisp_Object location) |
a1d2b64a | 303 | { |
ec7adf26 | 304 | Fgoto_char (location); |
bc923770 | 305 | unchain_marker (XMARKER (location)); |
a1d2b64a | 306 | } |
59c94f03 | 307 | |
570d7624 | 308 | \f |
955cbe7b PE |
309 | static Lisp_Object Qexpand_file_name; |
310 | static Lisp_Object Qsubstitute_in_file_name; | |
311 | static Lisp_Object Qdirectory_file_name; | |
312 | static Lisp_Object Qfile_name_directory; | |
313 | static Lisp_Object Qfile_name_nondirectory; | |
314 | static Lisp_Object Qunhandled_file_name_directory; | |
315 | static Lisp_Object Qfile_name_as_directory; | |
316 | static Lisp_Object Qcopy_file; | |
317 | static Lisp_Object Qmake_directory_internal; | |
318 | static Lisp_Object Qmake_directory; | |
319 | static Lisp_Object Qdelete_directory_internal; | |
32f4334d | 320 | Lisp_Object Qdelete_file; |
955cbe7b PE |
321 | static Lisp_Object Qrename_file; |
322 | static Lisp_Object Qadd_name_to_file; | |
323 | static Lisp_Object Qmake_symbolic_link; | |
32f4334d | 324 | Lisp_Object Qfile_exists_p; |
955cbe7b PE |
325 | static Lisp_Object Qfile_executable_p; |
326 | static Lisp_Object Qfile_readable_p; | |
327 | static Lisp_Object Qfile_writable_p; | |
328 | static Lisp_Object Qfile_symlink_p; | |
329 | static Lisp_Object Qaccess_file; | |
32f4334d | 330 | Lisp_Object Qfile_directory_p; |
955cbe7b PE |
331 | static Lisp_Object Qfile_regular_p; |
332 | static Lisp_Object Qfile_accessible_directory_p; | |
333 | static Lisp_Object Qfile_modes; | |
334 | static Lisp_Object Qset_file_modes; | |
335 | static Lisp_Object Qset_file_times; | |
336 | static Lisp_Object Qfile_selinux_context; | |
337 | static Lisp_Object Qset_file_selinux_context; | |
7c3d167f RF |
338 | static Lisp_Object Qfile_acl; |
339 | static Lisp_Object Qset_file_acl; | |
955cbe7b | 340 | static Lisp_Object Qfile_newer_than_file_p; |
32f4334d | 341 | Lisp_Object Qinsert_file_contents; |
3f011c7f | 342 | static Lisp_Object Qchoose_write_coding_system; |
32f4334d | 343 | Lisp_Object Qwrite_region; |
955cbe7b PE |
344 | static Lisp_Object Qverify_visited_file_modtime; |
345 | static Lisp_Object Qset_visited_file_modtime; | |
32f4334d | 346 | |
a7ca3326 | 347 | DEFUN ("find-file-name-handler", Ffind_file_name_handler, |
16a97296 | 348 | Sfind_file_name_handler, 2, 2, 0, |
8c1a1077 PJ |
349 | doc: /* Return FILENAME's handler function for OPERATION, if it has one. |
350 | Otherwise, return nil. | |
351 | A file name is handled if one of the regular expressions in | |
352 | `file-name-handler-alist' matches it. | |
353 | ||
354 | If OPERATION equals `inhibit-file-name-operation', then we ignore | |
355 | any handlers that are members of `inhibit-file-name-handlers', | |
356 | but we still do run any other handlers. This lets handlers | |
357 | use the standard functions without calling themselves recursively. */) | |
5842a27b | 358 | (Lisp_Object filename, Lisp_Object operation) |
32f4334d | 359 | { |
642ef245 | 360 | /* This function must not munge the match data. */ |
204ee271 | 361 | Lisp_Object chain, inhibited_handlers, result; |
d311d28c | 362 | ptrdiff_t pos = -1; |
642ef245 | 363 | |
204ee271 | 364 | result = Qnil; |
b7826503 | 365 | CHECK_STRING (filename); |
e4432095 | 366 | |
a65970a0 RS |
367 | if (EQ (operation, Vinhibit_file_name_operation)) |
368 | inhibited_handlers = Vinhibit_file_name_handlers; | |
369 | else | |
370 | inhibited_handlers = Qnil; | |
82c2d839 | 371 | |
93c30b5f | 372 | for (chain = Vfile_name_handler_alist; CONSP (chain); |
03699b14 | 373 | chain = XCDR (chain)) |
32f4334d RS |
374 | { |
375 | Lisp_Object elt; | |
03699b14 | 376 | elt = XCAR (chain); |
93c30b5f | 377 | if (CONSP (elt)) |
32f4334d | 378 | { |
f6c9b683 | 379 | Lisp_Object string = XCAR (elt); |
d311d28c | 380 | ptrdiff_t match_pos; |
f6c9b683 | 381 | Lisp_Object handler = XCDR (elt); |
68780e2a RS |
382 | Lisp_Object operations = Qnil; |
383 | ||
384 | if (SYMBOLP (handler)) | |
385 | operations = Fget (handler, Qoperations); | |
f6c9b683 | 386 | |
8d2ced53 | 387 | if (STRINGP (string) |
f6c9b683 RS |
388 | && (match_pos = fast_string_match (string, filename)) > pos |
389 | && (NILP (operations) || ! NILP (Fmemq (operation, operations)))) | |
a65970a0 | 390 | { |
f6c9b683 | 391 | Lisp_Object tem; |
a65970a0 | 392 | |
03699b14 | 393 | handler = XCDR (elt); |
a65970a0 RS |
394 | tem = Fmemq (handler, inhibited_handlers); |
395 | if (NILP (tem)) | |
8d2ced53 SM |
396 | { |
397 | result = handler; | |
398 | pos = match_pos; | |
399 | } | |
a65970a0 | 400 | } |
32f4334d | 401 | } |
642ef245 JB |
402 | |
403 | QUIT; | |
32f4334d | 404 | } |
8d2ced53 | 405 | return result; |
32f4334d RS |
406 | } |
407 | \f | |
a7ca3326 | 408 | DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, |
8c1a1077 PJ |
409 | 1, 1, 0, |
410 | doc: /* Return the directory component in file name FILENAME. | |
411 | Return nil if FILENAME does not include a directory. | |
78379264 | 412 | Otherwise return a directory name. |
7c2fb837 | 413 | Given a Unix syntax file name, returns a string ending in slash. */) |
5842a27b | 414 | (Lisp_Object filename) |
570d7624 | 415 | { |
100c44b7 | 416 | #ifndef DOS_NT |
5976c3fe | 417 | register const char *beg; |
100c44b7 | 418 | #else |
5976c3fe | 419 | register char *beg; |
273ac8d1 | 420 | Lisp_Object tem_fn; |
100c44b7 | 421 | #endif |
5976c3fe | 422 | register const char *p; |
0bf2eed2 | 423 | Lisp_Object handler; |
570d7624 | 424 | |
b7826503 | 425 | CHECK_STRING (filename); |
570d7624 | 426 | |
0bf2eed2 RS |
427 | /* If the file name has special constructs in it, |
428 | call the corresponding file handler. */ | |
3b7f6e60 | 429 | handler = Ffind_file_name_handler (filename, Qfile_name_directory); |
0bf2eed2 | 430 | if (!NILP (handler)) |
2375c96a CY |
431 | { |
432 | Lisp_Object handled_name = call2 (handler, Qfile_name_directory, | |
433 | filename); | |
434 | return STRINGP (handled_name) ? handled_name : Qnil; | |
435 | } | |
0bf2eed2 | 436 | |
199607e4 | 437 | #ifdef DOS_NT |
5b71542d | 438 | beg = xlispstrdupa (filename); |
0f3f018c | 439 | #else |
5976c3fe | 440 | beg = SSDATA (filename); |
199607e4 | 441 | #endif |
d5db4077 | 442 | p = beg + SBYTES (filename); |
570d7624 | 443 | |
199607e4 | 444 | while (p != beg && !IS_DIRECTORY_SEP (p[-1]) |
199607e4 | 445 | #ifdef DOS_NT |
e1dbe924 | 446 | /* only recognize drive specifier at the beginning */ |
ba14e174 RS |
447 | && !(p[-1] == ':' |
448 | /* handle the "/:d:foo" and "/:foo" cases correctly */ | |
449 | && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg)) | |
450 | || (p == beg + 4 && IS_DIRECTORY_SEP (*beg)))) | |
199607e4 | 451 | #endif |
570d7624 JB |
452 | ) p--; |
453 | ||
454 | if (p == beg) | |
455 | return Qnil; | |
5e570b75 | 456 | #ifdef DOS_NT |
4c3c22f3 | 457 | /* Expansion of "c:" to drive and default directory. */ |
ba14e174 | 458 | if (p[-1] == ':') |
4c3c22f3 | 459 | { |
4c3c22f3 | 460 | /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */ |
5976c3fe PE |
461 | char *res = alloca (MAXPATHLEN + 1); |
462 | char *r = res; | |
ba14e174 RS |
463 | |
464 | if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':') | |
465 | { | |
e99a530f | 466 | memcpy (res, beg, 2); |
ba14e174 RS |
467 | beg += 2; |
468 | r += 2; | |
469 | } | |
470 | ||
620f13b0 | 471 | if (getdefdir (c_toupper (*beg) - 'A' + 1, r)) |
4c3c22f3 | 472 | { |
e7ac588e EZ |
473 | size_t l = strlen (res); |
474 | ||
475 | if (l > 3 || !IS_DIRECTORY_SEP (res[l - 1])) | |
4c3c22f3 RS |
476 | strcat (res, "/"); |
477 | beg = res; | |
478 | p = beg + strlen (beg); | |
1fd201bb | 479 | dostounix_filename (beg); |
f5c81c80 EZ |
480 | tem_fn = make_specified_string (beg, -1, p - beg, |
481 | STRING_MULTIBYTE (filename)); | |
4c3c22f3 | 482 | } |
f5c81c80 EZ |
483 | else |
484 | tem_fn = make_specified_string (beg - 2, -1, p - beg + 2, | |
485 | STRING_MULTIBYTE (filename)); | |
486 | } | |
487 | else if (STRING_MULTIBYTE (filename)) | |
488 | { | |
e7ac588e | 489 | tem_fn = make_specified_string (beg, -1, p - beg, 1); |
1fd201bb | 490 | dostounix_filename (SSDATA (tem_fn)); |
e7ac588e EZ |
491 | #ifdef WINDOWSNT |
492 | if (!NILP (Vw32_downcase_file_names)) | |
493 | tem_fn = Fdowncase (tem_fn); | |
494 | #endif | |
f5c81c80 EZ |
495 | } |
496 | else | |
497 | { | |
1fd201bb | 498 | dostounix_filename (beg); |
f5c81c80 | 499 | tem_fn = make_specified_string (beg, -1, p - beg, 0); |
4c3c22f3 | 500 | } |
f5c81c80 | 501 | return tem_fn; |
273ac8d1 | 502 | #else /* DOS_NT */ |
d7231f93 | 503 | return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename)); |
273ac8d1 | 504 | #endif /* DOS_NT */ |
570d7624 JB |
505 | } |
506 | ||
a7ca3326 | 507 | DEFUN ("file-name-nondirectory", Ffile_name_nondirectory, |
60d67b83 | 508 | Sfile_name_nondirectory, 1, 1, 0, |
8c1a1077 PJ |
509 | doc: /* Return file name FILENAME sans its directory. |
510 | For example, in a Unix-syntax file name, | |
511 | this is everything after the last slash, | |
512 | or the entire name if it contains no slash. */) | |
5842a27b | 513 | (Lisp_Object filename) |
570d7624 | 514 | { |
5976c3fe | 515 | register const char *beg, *p, *end; |
0bf2eed2 | 516 | Lisp_Object handler; |
570d7624 | 517 | |
b7826503 | 518 | CHECK_STRING (filename); |
570d7624 | 519 | |
0bf2eed2 RS |
520 | /* If the file name has special constructs in it, |
521 | call the corresponding file handler. */ | |
3b7f6e60 | 522 | handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory); |
0bf2eed2 | 523 | if (!NILP (handler)) |
2375c96a CY |
524 | { |
525 | Lisp_Object handled_name = call2 (handler, Qfile_name_nondirectory, | |
526 | filename); | |
527 | if (STRINGP (handled_name)) | |
528 | return handled_name; | |
529 | error ("Invalid handler in `file-name-handler-alist'"); | |
530 | } | |
0bf2eed2 | 531 | |
5976c3fe | 532 | beg = SSDATA (filename); |
d5db4077 | 533 | end = p = beg + SBYTES (filename); |
570d7624 | 534 | |
199607e4 | 535 | while (p != beg && !IS_DIRECTORY_SEP (p[-1]) |
199607e4 | 536 | #ifdef DOS_NT |
e1dbe924 | 537 | /* only recognize drive specifier at beginning */ |
ba14e174 RS |
538 | && !(p[-1] == ':' |
539 | /* handle the "/:d:foo" case correctly */ | |
540 | && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg)))) | |
199607e4 | 541 | #endif |
60d67b83 RS |
542 | ) |
543 | p--; | |
570d7624 | 544 | |
d7231f93 | 545 | return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename)); |
570d7624 | 546 | } |
642ef245 | 547 | |
a7ca3326 | 548 | DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory, |
60d67b83 | 549 | Sunhandled_file_name_directory, 1, 1, 0, |
8c1a1077 PJ |
550 | doc: /* Return a directly usable directory name somehow associated with FILENAME. |
551 | A `directly usable' directory name is one that may be used without the | |
552 | intervention of any file handler. | |
553 | If FILENAME is a directly usable file itself, return | |
554 | \(file-name-directory FILENAME). | |
ca319910 SM |
555 | If FILENAME refers to a file which is not accessible from a local process, |
556 | then this should return nil. | |
8c1a1077 PJ |
557 | The `call-process' and `start-process' functions use this function to |
558 | get a current directory to run processes in. */) | |
5842a27b | 559 | (Lisp_Object filename) |
642ef245 JB |
560 | { |
561 | Lisp_Object handler; | |
562 | ||
563 | /* If the file name has special constructs in it, | |
564 | call the corresponding file handler. */ | |
49307295 | 565 | handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory); |
642ef245 | 566 | if (!NILP (handler)) |
2375c96a CY |
567 | { |
568 | Lisp_Object handled_name = call2 (handler, Qunhandled_file_name_directory, | |
569 | filename); | |
570 | return STRINGP (handled_name) ? handled_name : Qnil; | |
571 | } | |
642ef245 JB |
572 | |
573 | return Ffile_name_directory (filename); | |
574 | } | |
575 | ||
c365c355 PE |
576 | /* Maximum number of bytes that DST will be longer than SRC |
577 | in file_name_as_directory. This occurs when SRCLEN == 0. */ | |
578 | enum { file_name_as_directory_slop = 2 }; | |
579 | ||
f5c81c80 EZ |
580 | /* Convert from file name SRC of length SRCLEN to directory name in |
581 | DST. MULTIBYTE non-zero means the file name in SRC is a multibyte | |
582 | string. On UNIX, just make sure there is a terminating /. Return | |
583 | the length of DST in bytes. */ | |
570d7624 | 584 | |
c293e30c | 585 | static ptrdiff_t |
f5c81c80 EZ |
586 | file_name_as_directory (char *dst, const char *src, ptrdiff_t srclen, |
587 | bool multibyte) | |
c293e30c DA |
588 | { |
589 | if (srclen == 0) | |
8aa3a244 | 590 | { |
c293e30c DA |
591 | dst[0] = '.'; |
592 | dst[1] = '/'; | |
593 | dst[2] = '\0'; | |
594 | return 2; | |
8aa3a244 RS |
595 | } |
596 | ||
c365c355 | 597 | memcpy (dst, src, srclen); |
c293e30c | 598 | if (!IS_DIRECTORY_SEP (dst[srclen - 1])) |
c365c355 PE |
599 | dst[srclen++] = DIRECTORY_SEP; |
600 | dst[srclen] = 0; | |
199607e4 | 601 | #ifdef DOS_NT |
1fd201bb | 602 | dostounix_filename (dst); |
199607e4 | 603 | #endif |
c293e30c | 604 | return srclen; |
570d7624 JB |
605 | } |
606 | ||
a7ca3326 | 607 | DEFUN ("file-name-as-directory", Ffile_name_as_directory, |
570d7624 | 608 | Sfile_name_as_directory, 1, 1, 0, |
0dac4f85 | 609 | doc: /* Return a string representing the file name FILE interpreted as a directory. |
8c1a1077 PJ |
610 | This operation exists because a directory is also a file, but its name as |
611 | a directory is different from its name as a file. | |
612 | The result can be used as the value of `default-directory' | |
613 | or passed as second argument to `expand-file-name'. | |
7c2fb837 | 614 | For a Unix-syntax file name, just appends a slash. */) |
5842a27b | 615 | (Lisp_Object file) |
570d7624 JB |
616 | { |
617 | char *buf; | |
c293e30c | 618 | ptrdiff_t length; |
c365c355 PE |
619 | Lisp_Object handler, val; |
620 | USE_SAFE_ALLOCA; | |
570d7624 | 621 | |
b7826503 | 622 | CHECK_STRING (file); |
265a9e55 | 623 | if (NILP (file)) |
570d7624 | 624 | return Qnil; |
0bf2eed2 RS |
625 | |
626 | /* If the file name has special constructs in it, | |
627 | call the corresponding file handler. */ | |
49307295 | 628 | handler = Ffind_file_name_handler (file, Qfile_name_as_directory); |
0bf2eed2 | 629 | if (!NILP (handler)) |
2375c96a CY |
630 | { |
631 | Lisp_Object handled_name = call2 (handler, Qfile_name_as_directory, | |
632 | file); | |
633 | if (STRINGP (handled_name)) | |
634 | return handled_name; | |
635 | error ("Invalid handler in `file-name-handler-alist'"); | |
636 | } | |
0bf2eed2 | 637 | |
e7ac588e EZ |
638 | #ifdef WINDOWSNT |
639 | if (!NILP (Vw32_downcase_file_names)) | |
640 | file = Fdowncase (file); | |
641 | #endif | |
c365c355 | 642 | buf = SAFE_ALLOCA (SBYTES (file) + file_name_as_directory_slop + 1); |
f5c81c80 EZ |
643 | length = file_name_as_directory (buf, SSDATA (file), SBYTES (file), |
644 | STRING_MULTIBYTE (file)); | |
c365c355 PE |
645 | val = make_specified_string (buf, -1, length, STRING_MULTIBYTE (file)); |
646 | SAFE_FREE (); | |
647 | return val; | |
570d7624 JB |
648 | } |
649 | \f | |
f5c81c80 EZ |
650 | /* Convert from directory name SRC of length SRCLEN to file name in |
651 | DST. MULTIBYTE non-zero means the file name in SRC is a multibyte | |
652 | string. On UNIX, just make sure there isn't a terminating /. | |
653 | Return the length of DST in bytes. */ | |
570d7624 | 654 | |
c293e30c | 655 | static ptrdiff_t |
f5c81c80 | 656 | directory_file_name (char *dst, char *src, ptrdiff_t srclen, bool multibyte) |
570d7624 | 657 | { |
570d7624 | 658 | /* Process as Unix format: just remove any final slash. |
c365c355 PE |
659 | But leave "/" and "//" unchanged. */ |
660 | while (srclen > 1 | |
4592782e | 661 | #ifdef DOS_NT |
c365c355 | 662 | && !IS_ANY_SEP (src[srclen - 2]) |
4592782e | 663 | #endif |
c365c355 PE |
664 | && IS_DIRECTORY_SEP (src[srclen - 1]) |
665 | && ! (srclen == 2 && IS_DIRECTORY_SEP (src[0]))) | |
666 | srclen--; | |
667 | ||
668 | memcpy (dst, src, srclen); | |
669 | dst[srclen] = 0; | |
199607e4 | 670 | #ifdef DOS_NT |
1fd201bb | 671 | dostounix_filename (dst); |
125feee8 | 672 | #endif |
c293e30c | 673 | return srclen; |
570d7624 JB |
674 | } |
675 | ||
a7ca3326 | 676 | DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name, |
8c1a1077 PJ |
677 | 1, 1, 0, |
678 | doc: /* Returns the file name of the directory named DIRECTORY. | |
679 | This is the name of the file that holds the data for the directory DIRECTORY. | |
680 | This operation exists because a directory is also a file, but its name as | |
681 | a directory is different from its name as a file. | |
7c2fb837 | 682 | In Unix-syntax, this function just removes the final slash. */) |
5842a27b | 683 | (Lisp_Object directory) |
570d7624 JB |
684 | { |
685 | char *buf; | |
c293e30c | 686 | ptrdiff_t length; |
c365c355 PE |
687 | Lisp_Object handler, val; |
688 | USE_SAFE_ALLOCA; | |
570d7624 | 689 | |
b7826503 | 690 | CHECK_STRING (directory); |
570d7624 | 691 | |
265a9e55 | 692 | if (NILP (directory)) |
570d7624 | 693 | return Qnil; |
0bf2eed2 RS |
694 | |
695 | /* If the file name has special constructs in it, | |
696 | call the corresponding file handler. */ | |
49307295 | 697 | handler = Ffind_file_name_handler (directory, Qdirectory_file_name); |
0bf2eed2 | 698 | if (!NILP (handler)) |
2375c96a CY |
699 | { |
700 | Lisp_Object handled_name = call2 (handler, Qdirectory_file_name, | |
701 | directory); | |
702 | if (STRINGP (handled_name)) | |
703 | return handled_name; | |
704 | error ("Invalid handler in `file-name-handler-alist'"); | |
705 | } | |
0bf2eed2 | 706 | |
e7ac588e EZ |
707 | #ifdef WINDOWSNT |
708 | if (!NILP (Vw32_downcase_file_names)) | |
709 | directory = Fdowncase (directory); | |
710 | #endif | |
c365c355 | 711 | buf = SAFE_ALLOCA (SBYTES (directory) + 1); |
f5c81c80 EZ |
712 | length = directory_file_name (buf, SSDATA (directory), SBYTES (directory), |
713 | STRING_MULTIBYTE (directory)); | |
c365c355 PE |
714 | val = make_specified_string (buf, -1, length, STRING_MULTIBYTE (directory)); |
715 | SAFE_FREE (); | |
716 | return val; | |
570d7624 JB |
717 | } |
718 | ||
91433552 | 719 | static const char make_temp_name_tbl[64] = |
3ce839e4 RS |
720 | { |
721 | 'A','B','C','D','E','F','G','H', | |
722 | 'I','J','K','L','M','N','O','P', | |
723 | 'Q','R','S','T','U','V','W','X', | |
724 | 'Y','Z','a','b','c','d','e','f', | |
725 | 'g','h','i','j','k','l','m','n', | |
726 | 'o','p','q','r','s','t','u','v', | |
727 | 'w','x','y','z','0','1','2','3', | |
728 | '4','5','6','7','8','9','-','_' | |
729 | }; | |
cb613bb8 | 730 | |
3ce839e4 RS |
731 | static unsigned make_temp_name_count, make_temp_name_count_initialized_p; |
732 | ||
cb613bb8 | 733 | /* Value is a temporary file name starting with PREFIX, a string. |
efdc16c9 | 734 | |
cb613bb8 GM |
735 | The Emacs process number forms part of the result, so there is |
736 | no danger of generating a name being used by another process. | |
737 | In addition, this function makes an attempt to choose a name | |
738 | which has no existing file. To make this work, PREFIX should be | |
739 | an absolute file name. | |
efdc16c9 | 740 | |
f75d7a91 | 741 | BASE64_P means add the pid as 3 characters in base64 |
cb613bb8 GM |
742 | encoding. In this case, 6 characters will be added to PREFIX to |
743 | form the file name. Otherwise, if Emacs is running on a system | |
744 | with long file names, add the pid as a decimal number. | |
745 | ||
746 | This function signals an error if no unique file name could be | |
747 | generated. */ | |
748 | ||
749 | Lisp_Object | |
f75d7a91 | 750 | make_temp_name (Lisp_Object prefix, bool base64_p) |
570d7624 | 751 | { |
d0065ff1 EZ |
752 | Lisp_Object val, encoded_prefix; |
753 | int len; | |
a81d11a3 | 754 | printmax_t pid; |
5976c3fe | 755 | char *p, *data; |
a81d11a3 | 756 | char pidbuf[INT_BUFSIZE_BOUND (printmax_t)]; |
3ce839e4 | 757 | int pidlen; |
efdc16c9 | 758 | |
b7826503 | 759 | CHECK_STRING (prefix); |
3ce839e4 RS |
760 | |
761 | /* VAL is created by adding 6 characters to PREFIX. The first | |
762 | three are the PID of this process, in base 64, and the second | |
763 | three are incremented if the file already exists. This ensures | |
764 | 262144 unique file names per PID per PREFIX. */ | |
765 | ||
93f4cf88 | 766 | pid = getpid (); |
3ce839e4 | 767 | |
cb613bb8 GM |
768 | if (base64_p) |
769 | { | |
770 | pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6; | |
771 | pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6; | |
772 | pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6; | |
773 | pidlen = 3; | |
774 | } | |
775 | else | |
776 | { | |
3ce839e4 | 777 | #ifdef HAVE_LONG_FILE_NAMES |
a81d11a3 | 778 | pidlen = sprintf (pidbuf, "%"pMd, pid); |
3a3bfb18 | 779 | #else |
cb613bb8 GM |
780 | pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6; |
781 | pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6; | |
782 | pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6; | |
783 | pidlen = 3; | |
3ce839e4 | 784 | #endif |
cb613bb8 | 785 | } |
efdc16c9 | 786 | |
d0065ff1 EZ |
787 | encoded_prefix = ENCODE_FILE (prefix); |
788 | len = SBYTES (encoded_prefix); | |
789 | val = make_uninit_string (len + 3 + pidlen); | |
5976c3fe | 790 | data = SSDATA (val); |
d0065ff1 | 791 | memcpy (data, SSDATA (encoded_prefix), len); |
3ce839e4 RS |
792 | p = data + len; |
793 | ||
72af86bd | 794 | memcpy (p, pidbuf, pidlen); |
3ce839e4 RS |
795 | p += pidlen; |
796 | ||
797 | /* Here we try to minimize useless stat'ing when this function is | |
798 | invoked many times successively with the same PREFIX. We achieve | |
799 | this by initializing count to a random value, and incrementing it | |
f6a492a9 RS |
800 | afterwards. |
801 | ||
802 | We don't want make-temp-name to be called while dumping, | |
803 | because then make_temp_name_count_initialized_p would get set | |
804 | and then make_temp_name_count would not be set when Emacs starts. */ | |
805 | ||
3ce839e4 RS |
806 | if (!make_temp_name_count_initialized_p) |
807 | { | |
327eeec8 | 808 | make_temp_name_count = time (NULL); |
3ce839e4 RS |
809 | make_temp_name_count_initialized_p = 1; |
810 | } | |
811 | ||
812 | while (1) | |
813 | { | |
8a7777fc | 814 | unsigned num = make_temp_name_count; |
3ce839e4 RS |
815 | |
816 | p[0] = make_temp_name_tbl[num & 63], num >>= 6; | |
817 | p[1] = make_temp_name_tbl[num & 63], num >>= 6; | |
818 | p[2] = make_temp_name_tbl[num & 63], num >>= 6; | |
819 | ||
8a7777fc RS |
820 | /* Poor man's congruential RN generator. Replace with |
821 | ++make_temp_name_count for debugging. */ | |
822 | make_temp_name_count += 25229; | |
823 | make_temp_name_count %= 225307; | |
824 | ||
bb385a92 | 825 | if (!check_existing (data)) |
3ce839e4 RS |
826 | { |
827 | /* We want to return only if errno is ENOENT. */ | |
828 | if (errno == ENOENT) | |
d0065ff1 | 829 | return DECODE_FILE (val); |
3ce839e4 RS |
830 | else |
831 | /* The error here is dubious, but there is little else we | |
832 | can do. The alternatives are to return nil, which is | |
833 | as bad as (and in many cases worse than) throwing the | |
834 | error, or to ignore the error, which will likely result | |
8a7777fc | 835 | in looping through 225307 stat's, which is not only |
410ed5c3 PE |
836 | dog-slow, but also useless since eventually nil would |
837 | have to be returned anyway. */ | |
9869bb0b | 838 | report_file_error ("Cannot create temporary name for prefix", |
a9757f6a | 839 | prefix); |
3ce839e4 RS |
840 | /* not reached */ |
841 | } | |
842 | } | |
570d7624 | 843 | } |
3ce839e4 | 844 | |
cb613bb8 GM |
845 | |
846 | DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0, | |
8c1a1077 PJ |
847 | doc: /* Generate temporary file name (string) starting with PREFIX (a string). |
848 | The Emacs process number forms part of the result, | |
849 | so there is no danger of generating a name being used by another process. | |
850 | ||
851 | In addition, this function makes an attempt to choose a name | |
852 | which has no existing file. To make this work, | |
853 | PREFIX should be an absolute file name. | |
854 | ||
855 | There is a race condition between calling `make-temp-name' and creating the | |
856 | file which opens all kinds of security holes. For that reason, you should | |
f9e6f049 RS |
857 | probably use `make-temp-file' instead, except in three circumstances: |
858 | ||
859 | * If you are creating the file in the user's home directory. | |
860 | * If you are creating a directory rather than an ordinary file. | |
861 | * If you are taking special precautions as `make-temp-file' does. */) | |
5842a27b | 862 | (Lisp_Object prefix) |
cb613bb8 GM |
863 | { |
864 | return make_temp_name (prefix, 0); | |
865 | } | |
866 | ||
867 | ||
570d7624 | 868 | \f |
a7ca3326 | 869 | DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, |
8c1a1077 PJ |
870 | doc: /* Convert filename NAME to absolute, and canonicalize it. |
871 | Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative | |
d177e213 XF |
872 | \(does not start with slash or tilde); both the directory name and |
873 | a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or | |
874 | missing, the current buffer's value of `default-directory' is used. | |
1b2a627f EZ |
875 | NAME should be a string that is a valid file name for the underlying |
876 | filesystem. | |
8c1a1077 PJ |
877 | File name components that are `.' are removed, and |
878 | so are file name components followed by `..', along with the `..' itself; | |
879 | note that these simplifications are done without checking the resulting | |
880 | file names in the file system. | |
15579471 EZ |
881 | Multiple consecutive slashes are collapsed into a single slash, |
882 | except at the beginning of the file name when they are significant (e.g., | |
883 | UNC file names on MS-Windows.) | |
8c1a1077 PJ |
884 | An initial `~/' expands to your home directory. |
885 | An initial `~USER/' expands to USER's home directory. | |
07114296 CY |
886 | See also the function `substitute-in-file-name'. |
887 | ||
888 | For technical reasons, this function can return correct but | |
889 | non-intuitive results for the root directory; for instance, | |
890 | \(expand-file-name ".." "/") returns "/..". For this reason, use | |
15579471 | 891 | \(directory-file-name (file-name-directory dirname)) to traverse a |
07114296 | 892 | filesystem tree, not (expand-file-name ".." dirname). */) |
5842a27b | 893 | (Lisp_Object name, Lisp_Object default_directory) |
570d7624 | 894 | { |
5b5a2ea1 SM |
895 | /* These point to SDATA and need to be careful with string-relocation |
896 | during GC (via DECODE_FILE). */ | |
2893f146 PE |
897 | char *nm; |
898 | const char *newdir; | |
5b5a2ea1 | 899 | /* This should only point to alloca'd data. */ |
5976c3fe | 900 | char *target; |
199607e4 | 901 | |
93f4cf88 | 902 | ptrdiff_t tlen; |
570d7624 | 903 | struct passwd *pw; |
5e570b75 | 904 | #ifdef DOS_NT |
199607e4 | 905 | int drive = 0; |
f75d7a91 PE |
906 | bool collapse_newdir = 1; |
907 | bool is_escaped = 0; | |
5e570b75 | 908 | #endif /* DOS_NT */ |
93f4cf88 | 909 | ptrdiff_t length; |
2375c96a | 910 | Lisp_Object handler, result, handled_name; |
fce31d69 | 911 | bool multibyte; |
9c06a1f3 | 912 | Lisp_Object hdir; |
c365c355 | 913 | USE_SAFE_ALLOCA; |
199607e4 | 914 | |
b7826503 | 915 | CHECK_STRING (name); |
570d7624 | 916 | |
0bf2eed2 RS |
917 | /* If the file name has special constructs in it, |
918 | call the corresponding file handler. */ | |
49307295 | 919 | handler = Ffind_file_name_handler (name, Qexpand_file_name); |
0bf2eed2 | 920 | if (!NILP (handler)) |
2375c96a CY |
921 | { |
922 | handled_name = call3 (handler, Qexpand_file_name, | |
923 | name, default_directory); | |
924 | if (STRINGP (handled_name)) | |
925 | return handled_name; | |
926 | error ("Invalid handler in `file-name-handler-alist'"); | |
927 | } | |
928 | ||
58fc9587 | 929 | |
3b7f6e60 EN |
930 | /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */ |
931 | if (NILP (default_directory)) | |
4b4deea2 | 932 | default_directory = BVAR (current_buffer, directory); |
82330e7f | 933 | if (! STRINGP (default_directory)) |
dd693537 EZ |
934 | { |
935 | #ifdef DOS_NT | |
936 | /* "/" is not considered a root directory on DOS_NT, so using "/" | |
937 | here causes an infinite recursion in, e.g., the following: | |
938 | ||
939 | (let (default-directory) | |
940 | (expand-file-name "a")) | |
941 | ||
942 | To avoid this, we set default_directory to the root of the | |
943 | current drive. */ | |
dd693537 EZ |
944 | default_directory = build_string (emacs_root_dir ()); |
945 | #else | |
946 | default_directory = build_string ("/"); | |
947 | #endif | |
948 | } | |
58fc9587 | 949 | |
3b7f6e60 | 950 | if (!NILP (default_directory)) |
273e0829 | 951 | { |
3b7f6e60 | 952 | handler = Ffind_file_name_handler (default_directory, Qexpand_file_name); |
273e0829 | 953 | if (!NILP (handler)) |
2375c96a CY |
954 | { |
955 | handled_name = call3 (handler, Qexpand_file_name, | |
956 | name, default_directory); | |
957 | if (STRINGP (handled_name)) | |
958 | return handled_name; | |
959 | error ("Invalid handler in `file-name-handler-alist'"); | |
960 | } | |
273e0829 | 961 | } |
0bf2eed2 | 962 | |
5b5a2ea1 | 963 | { |
5976c3fe | 964 | char *o = SSDATA (default_directory); |
5b5a2ea1 SM |
965 | |
966 | /* Make sure DEFAULT_DIRECTORY is properly expanded. | |
967 | It would be better to do this down below where we actually use | |
968 | default_directory. Unfortunately, calling Fexpand_file_name recursively | |
969 | could invoke GC, and the strings might be relocated. This would | |
970 | be annoying because we have pointers into strings lying around | |
971 | that would need adjusting, and people would add new pointers to | |
972 | the code and forget to adjust them, resulting in intermittent bugs. | |
973 | Putting this call here avoids all that crud. | |
974 | ||
975 | The EQ test avoids infinite recursion. */ | |
976 | if (! NILP (default_directory) && !EQ (default_directory, name) | |
977 | /* Save time in some common cases - as long as default_directory | |
978 | is not relative, it can be canonicalized with name below (if it | |
979 | is needed at all) without requiring it to be expanded now. */ | |
01937013 | 980 | #ifdef DOS_NT |
5b5a2ea1 SM |
981 | /* Detect MSDOS file names with drive specifiers. */ |
982 | && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) | |
983 | && IS_DIRECTORY_SEP (o[2])) | |
199607e4 | 984 | #ifdef WINDOWSNT |
5b5a2ea1 SM |
985 | /* Detect Windows file names in UNC format. */ |
986 | && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1])) | |
01937013 | 987 | #endif |
199607e4 RS |
988 | #else /* not DOS_NT */ |
989 | /* Detect Unix absolute file names (/... alone is not absolute on | |
990 | DOS or Windows). */ | |
5b5a2ea1 | 991 | && ! (IS_DIRECTORY_SEP (o[0])) |
199607e4 | 992 | #endif /* not DOS_NT */ |
5b5a2ea1 SM |
993 | ) |
994 | { | |
995 | struct gcpro gcpro1; | |
f14b1c68 | 996 | |
5b5a2ea1 SM |
997 | GCPRO1 (name); |
998 | default_directory = Fexpand_file_name (default_directory, Qnil); | |
999 | UNGCPRO; | |
1000 | } | |
1001 | } | |
2b046a72 | 1002 | multibyte = STRING_MULTIBYTE (name); |
6d060996 KH |
1003 | if (multibyte != STRING_MULTIBYTE (default_directory)) |
1004 | { | |
1005 | if (multibyte) | |
d0065ff1 EZ |
1006 | { |
1007 | unsigned char *p = SDATA (name); | |
1008 | ||
200fc949 | 1009 | while (*p && ASCII_CHAR_P (*p)) |
d0065ff1 EZ |
1010 | p++; |
1011 | if (*p == '\0') | |
1012 | { | |
1013 | /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is | |
1014 | unibyte. Do not convert DEFAULT_DIRECTORY to | |
1015 | multibyte; instead, convert NAME to a unibyte string, | |
1016 | so that the result of this function is also a unibyte | |
a67c4ae0 | 1017 | string. This is needed during bootstrapping and |
d0065ff1 EZ |
1018 | dumping, when Emacs cannot decode file names, because |
1019 | the locale environment is not set up. */ | |
1020 | name = make_unibyte_string (SSDATA (name), SBYTES (name)); | |
1021 | multibyte = 0; | |
1022 | } | |
1023 | else | |
1024 | default_directory = string_to_multibyte (default_directory); | |
1025 | } | |
6d060996 KH |
1026 | else |
1027 | { | |
1028 | name = string_to_multibyte (name); | |
1029 | multibyte = 1; | |
1030 | } | |
1031 | } | |
1032 | ||
e7ac588e EZ |
1033 | #ifdef WINDOWSNT |
1034 | if (!NILP (Vw32_downcase_file_names)) | |
1035 | default_directory = Fdowncase (default_directory); | |
1036 | #endif | |
1037 | ||
e8d32c7e | 1038 | /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */ |
5b71542d | 1039 | nm = xlispstrdupa (name); |
199607e4 | 1040 | |
565f0b98 | 1041 | #ifdef DOS_NT |
f0f95d31 RS |
1042 | /* Note if special escape prefix is present, but remove for now. */ |
1043 | if (nm[0] == '/' && nm[1] == ':') | |
1044 | { | |
1045 | is_escaped = 1; | |
1046 | nm += 2; | |
1047 | } | |
1048 | ||
199607e4 | 1049 | /* Find and remove drive specifier if present; this makes nm absolute |
f0f95d31 RS |
1050 | even if the rest of the name appears to be relative. Only look for |
1051 | drive specifier at the beginning. */ | |
1052 | if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1])) | |
1053 | { | |
5976c3fe | 1054 | drive = (unsigned char) nm[0]; |
f0f95d31 RS |
1055 | nm += 2; |
1056 | } | |
bb1ff1f4 GV |
1057 | |
1058 | #ifdef WINDOWSNT | |
1059 | /* If we see "c://somedir", we want to strip the first slash after the | |
1060 | colon when stripping the drive letter. Otherwise, this expands to | |
1061 | "//somedir". */ | |
1062 | if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1])) | |
1063 | nm++; | |
4c3c22f3 | 1064 | |
e8d32c7e | 1065 | /* Discard any previous drive specifier if nm is now in UNC format. */ |
cb8b26b4 EZ |
1066 | if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]) |
1067 | && !IS_DIRECTORY_SEP (nm[2])) | |
1068 | drive = 0; | |
5b5a2ea1 SM |
1069 | #endif /* WINDOWSNT */ |
1070 | #endif /* DOS_NT */ | |
199607e4 | 1071 | |
214378ec GM |
1072 | /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if |
1073 | none are found, we can probably return right away. We will avoid | |
1074 | allocating a new string if name is already fully expanded. */ | |
570d7624 | 1075 | if ( |
5e570b75 | 1076 | IS_DIRECTORY_SEP (nm[0]) |
199607e4 | 1077 | #ifdef MSDOS |
f0f95d31 | 1078 | && drive && !is_escaped |
199607e4 RS |
1079 | #endif |
1080 | #ifdef WINDOWSNT | |
f0f95d31 | 1081 | && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped |
199607e4 | 1082 | #endif |
570d7624 JB |
1083 | ) |
1084 | { | |
f14b1c68 JB |
1085 | /* If it turns out that the filename we want to return is just a |
1086 | suffix of FILENAME, we don't need to go through and edit | |
1087 | things; we just need to construct a new string using data | |
f75d7a91 PE |
1088 | starting at the middle of FILENAME. If we set LOSE, that |
1089 | means we've discovered that we can't do that cool trick. */ | |
1090 | bool lose = 0; | |
5976c3fe | 1091 | char *p = nm; |
f14b1c68 | 1092 | |
570d7624 JB |
1093 | while (*p) |
1094 | { | |
199607e4 | 1095 | /* Since we know the name is absolute, we can assume that each |
c77d647e JB |
1096 | element starts with a "/". */ |
1097 | ||
c77d647e | 1098 | /* "." and ".." are hairy. */ |
5e570b75 | 1099 | if (IS_DIRECTORY_SEP (p[0]) |
c77d647e | 1100 | && p[1] == '.' |
5e570b75 | 1101 | && (IS_DIRECTORY_SEP (p[2]) |
c77d647e | 1102 | || p[2] == 0 |
5e570b75 | 1103 | || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3]) |
c77d647e | 1104 | || p[3] == 0)))) |
570d7624 | 1105 | lose = 1; |
c365c355 PE |
1106 | /* Replace multiple slashes with a single one, except |
1107 | leave leading "//" alone. */ | |
1108 | else if (IS_DIRECTORY_SEP (p[0]) | |
1109 | && IS_DIRECTORY_SEP (p[1]) | |
1110 | && (p != nm || IS_DIRECTORY_SEP (p[2]))) | |
214378ec | 1111 | lose = 1; |
570d7624 JB |
1112 | p++; |
1113 | } | |
1114 | if (!lose) | |
1115 | { | |
199607e4 | 1116 | #ifdef DOS_NT |
087fc47a JB |
1117 | /* Make sure directories are all separated with /, but |
1118 | avoid allocation of a new string when not required. */ | |
1fd201bb | 1119 | dostounix_filename (nm); |
199607e4 RS |
1120 | #ifdef WINDOWSNT |
1121 | if (IS_DIRECTORY_SEP (nm[1])) | |
1122 | { | |
42a5b22f | 1123 | if (strcmp (nm, SSDATA (name)) != 0) |
2b046a72 | 1124 | name = make_specified_string (nm, -1, strlen (nm), multibyte); |
199607e4 RS |
1125 | } |
1126 | else | |
1127 | #endif | |
e8d32c7e | 1128 | /* Drive must be set, so this is okay. */ |
5976c3fe | 1129 | if (strcmp (nm - 2, SSDATA (name)) != 0) |
199607e4 | 1130 | { |
3f817c73 KH |
1131 | char temp[] = " :"; |
1132 | ||
2b046a72 | 1133 | name = make_specified_string (nm, -1, p - nm, multibyte); |
3f817c73 KH |
1134 | temp[0] = DRIVE_LETTER (drive); |
1135 | name = concat2 (build_string (temp), name); | |
199607e4 | 1136 | } |
e7ac588e EZ |
1137 | #ifdef WINDOWSNT |
1138 | if (!NILP (Vw32_downcase_file_names)) | |
1139 | name = Fdowncase (name); | |
1140 | #endif | |
199607e4 RS |
1141 | return name; |
1142 | #else /* not DOS_NT */ | |
42a5b22f | 1143 | if (strcmp (nm, SSDATA (name)) == 0) |
570d7624 | 1144 | return name; |
2b046a72 | 1145 | return make_specified_string (nm, -1, strlen (nm), multibyte); |
5e570b75 | 1146 | #endif /* not DOS_NT */ |
570d7624 JB |
1147 | } |
1148 | } | |
1149 | ||
199607e4 RS |
1150 | /* At this point, nm might or might not be an absolute file name. We |
1151 | need to expand ~ or ~user if present, otherwise prefix nm with | |
1152 | default_directory if nm is not absolute, and finally collapse /./ | |
1153 | and /foo/../ sequences. | |
1154 | ||
1155 | We set newdir to be the appropriate prefix if one is needed: | |
1156 | - the relevant user directory if nm starts with ~ or ~user | |
1157 | - the specified drive's working dir (DOS/NT only) if nm does not | |
1158 | start with / | |
1159 | - the value of default_directory. | |
1160 | ||
1161 | Note that these prefixes are not guaranteed to be absolute (except | |
1162 | for the working dir of a drive). Therefore, to ensure we always | |
1163 | return an absolute name, if the final prefix is not absolute we | |
1164 | append it to the current working directory. */ | |
570d7624 JB |
1165 | |
1166 | newdir = 0; | |
1167 | ||
1168 | if (nm[0] == '~') /* prefix ~ */ | |
c77d647e | 1169 | { |
5e570b75 | 1170 | if (IS_DIRECTORY_SEP (nm[1]) |
c77d647e JB |
1171 | || nm[1] == 0) /* ~ by itself */ |
1172 | { | |
6d557778 EZ |
1173 | Lisp_Object tem; |
1174 | ||
5976c3fe PE |
1175 | if (!(newdir = egetenv ("HOME"))) |
1176 | newdir = ""; | |
199607e4 | 1177 | nm++; |
e8d32c7e | 1178 | /* `egetenv' may return a unibyte string, which will bite us since |
6d557778 | 1179 | we expect the directory to be multibyte. */ |
857fd372 EZ |
1180 | #ifdef WINDOWSNT |
1181 | if (newdir[0]) | |
1182 | { | |
1183 | char newdir_utf8[MAX_UTF8_PATH]; | |
1184 | ||
1185 | filename_from_ansi (newdir, newdir_utf8); | |
1186 | tem = build_string (newdir_utf8); | |
1187 | } | |
1188 | else | |
857fd372 | 1189 | #endif |
db50ad5f | 1190 | tem = build_string (newdir); |
f5c81c80 | 1191 | if (multibyte && !STRING_MULTIBYTE (tem)) |
9c06a1f3 EZ |
1192 | { |
1193 | hdir = DECODE_FILE (tem); | |
5976c3fe | 1194 | newdir = SSDATA (hdir); |
9c06a1f3 | 1195 | } |
5e570b75 | 1196 | #ifdef DOS_NT |
9a1dc3be | 1197 | collapse_newdir = 0; |
4c3c22f3 | 1198 | #endif |
c77d647e JB |
1199 | } |
1200 | else /* ~user/filename */ | |
1201 | { | |
5976c3fe | 1202 | char *o, *p; |
c365c355 PE |
1203 | for (p = nm; *p && !IS_DIRECTORY_SEP (*p); p++) |
1204 | continue; | |
1205 | o = SAFE_ALLOCA (p - nm + 1); | |
72af86bd | 1206 | memcpy (o, nm, p - nm); |
c365c355 | 1207 | o[p - nm] = 0; |
c77d647e | 1208 | |
4d7e6e51 | 1209 | block_input (); |
350e0088 | 1210 | pw = getpwnam (o + 1); |
4d7e6e51 | 1211 | unblock_input (); |
c77d647e JB |
1212 | if (pw) |
1213 | { | |
f5c81c80 EZ |
1214 | Lisp_Object tem; |
1215 | ||
5976c3fe | 1216 | newdir = pw->pw_dir; |
f5c81c80 EZ |
1217 | /* `getpwnam' may return a unibyte string, which will |
1218 | bite us since we expect the directory to be | |
1219 | multibyte. */ | |
1220 | tem = build_string (newdir); | |
1221 | if (multibyte && !STRING_MULTIBYTE (tem)) | |
1222 | { | |
1223 | hdir = DECODE_FILE (tem); | |
1224 | newdir = SSDATA (hdir); | |
1225 | } | |
c77d647e | 1226 | nm = p; |
199607e4 | 1227 | #ifdef DOS_NT |
9a1dc3be | 1228 | collapse_newdir = 0; |
199607e4 | 1229 | #endif |
c77d647e | 1230 | } |
e5d77022 | 1231 | |
c77d647e JB |
1232 | /* If we don't find a user of that name, leave the name |
1233 | unchanged; don't move nm forward to p. */ | |
1234 | } | |
1235 | } | |
570d7624 | 1236 | |
5e570b75 | 1237 | #ifdef DOS_NT |
199607e4 RS |
1238 | /* On DOS and Windows, nm is absolute if a drive name was specified; |
1239 | use the drive's current directory as the prefix if needed. */ | |
1240 | if (!newdir && drive) | |
1241 | { | |
e8d32c7e | 1242 | /* Get default directory if needed to make nm absolute. */ |
2893f146 | 1243 | char *adir = NULL; |
199607e4 RS |
1244 | if (!IS_DIRECTORY_SEP (nm[0])) |
1245 | { | |
2893f146 | 1246 | adir = alloca (MAXPATHLEN + 1); |
620f13b0 | 1247 | if (!getdefdir (c_toupper (drive) - 'A' + 1, adir)) |
2893f146 | 1248 | adir = NULL; |
f5c81c80 EZ |
1249 | else if (multibyte) |
1250 | { | |
1251 | Lisp_Object tem = build_string (adir); | |
1252 | ||
1253 | tem = DECODE_FILE (tem); | |
1254 | memcpy (adir, SSDATA (tem), SBYTES (tem) + 1); | |
1255 | } | |
199607e4 | 1256 | } |
2893f146 | 1257 | if (!adir) |
199607e4 | 1258 | { |
e8d32c7e | 1259 | /* Either nm starts with /, or drive isn't mounted. */ |
2893f146 PE |
1260 | adir = alloca (4); |
1261 | adir[0] = DRIVE_LETTER (drive); | |
1262 | adir[1] = ':'; | |
1263 | adir[2] = '/'; | |
1264 | adir[3] = 0; | |
199607e4 | 1265 | } |
2893f146 | 1266 | newdir = adir; |
199607e4 | 1267 | } |
5e570b75 | 1268 | #endif /* DOS_NT */ |
199607e4 RS |
1269 | |
1270 | /* Finally, if no prefix has been specified and nm is not absolute, | |
e8d32c7e | 1271 | then it must be expanded relative to default_directory. */ |
199607e4 | 1272 | |
34097368 | 1273 | if (1 |
199607e4 | 1274 | #ifndef DOS_NT |
e8d32c7e | 1275 | /* /... alone is not absolute on DOS and Windows. */ |
34097368 | 1276 | && !IS_DIRECTORY_SEP (nm[0]) |
199607e4 RS |
1277 | #endif |
1278 | #ifdef WINDOWSNT | |
cb8b26b4 EZ |
1279 | && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]) |
1280 | && !IS_DIRECTORY_SEP (nm[2])) | |
199607e4 | 1281 | #endif |
570d7624 JB |
1282 | && !newdir) |
1283 | { | |
5976c3fe | 1284 | newdir = SSDATA (default_directory); |
f0f95d31 RS |
1285 | #ifdef DOS_NT |
1286 | /* Note if special escape prefix is present, but remove for now. */ | |
1287 | if (newdir[0] == '/' && newdir[1] == ':') | |
1288 | { | |
1289 | is_escaped = 1; | |
1290 | newdir += 2; | |
1291 | } | |
1292 | #endif | |
570d7624 JB |
1293 | } |
1294 | ||
5e570b75 | 1295 | #ifdef DOS_NT |
199607e4 RS |
1296 | if (newdir) |
1297 | { | |
e8d32c7e | 1298 | /* First ensure newdir is an absolute name. */ |
199607e4 RS |
1299 | if ( |
1300 | /* Detect MSDOS file names with drive specifiers. */ | |
1301 | ! (IS_DRIVE (newdir[0]) | |
1302 | && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2])) | |
1303 | #ifdef WINDOWSNT | |
1304 | /* Detect Windows file names in UNC format. */ | |
cb8b26b4 EZ |
1305 | && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]) |
1306 | && !IS_DIRECTORY_SEP (newdir[2])) | |
199607e4 RS |
1307 | #endif |
1308 | ) | |
1309 | { | |
1310 | /* Effectively, let newdir be (expand-file-name newdir cwd). | |
1311 | Because of the admonition against calling expand-file-name | |
1312 | when we have pointers into lisp strings, we accomplish this | |
1313 | indirectly by prepending newdir to nm if necessary, and using | |
e8d32c7e | 1314 | cwd (or the wd of newdir's drive) as the new newdir. */ |
2893f146 | 1315 | char *adir; |
5c4a19a9 EZ |
1316 | #ifdef WINDOWSNT |
1317 | const int adir_size = MAX_UTF8_PATH; | |
1318 | #else | |
1319 | const int adir_size = MAXPATHLEN + 1; | |
1320 | #endif | |
f5c81c80 | 1321 | |
c70a4df6 | 1322 | if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1])) |
199607e4 | 1323 | { |
5976c3fe | 1324 | drive = (unsigned char) newdir[0]; |
199607e4 RS |
1325 | newdir += 2; |
1326 | } | |
1327 | if (!IS_DIRECTORY_SEP (nm[0])) | |
1328 | { | |
c293e30c | 1329 | ptrdiff_t newlen = strlen (newdir); |
c365c355 PE |
1330 | char *tmp = alloca (newlen + file_name_as_directory_slop |
1331 | + strlen (nm) + 1); | |
f5c81c80 | 1332 | file_name_as_directory (tmp, newdir, newlen, multibyte); |
199607e4 RS |
1333 | strcat (tmp, nm); |
1334 | nm = tmp; | |
1335 | } | |
5c4a19a9 | 1336 | adir = alloca (adir_size); |
199607e4 RS |
1337 | if (drive) |
1338 | { | |
620f13b0 | 1339 | if (!getdefdir (c_toupper (drive) - 'A' + 1, adir)) |
f5c81c80 | 1340 | strcpy (adir, "/"); |
199607e4 RS |
1341 | } |
1342 | else | |
5c4a19a9 | 1343 | getcwd (adir, adir_size); |
f5c81c80 EZ |
1344 | if (multibyte) |
1345 | { | |
1346 | Lisp_Object tem = build_string (adir); | |
1347 | ||
1348 | tem = DECODE_FILE (tem); | |
1349 | memcpy (adir, SSDATA (tem), SBYTES (tem) + 1); | |
1350 | } | |
2893f146 | 1351 | newdir = adir; |
199607e4 RS |
1352 | } |
1353 | ||
e8d32c7e | 1354 | /* Strip off drive name from prefix, if present. */ |
c70a4df6 | 1355 | if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1])) |
199607e4 RS |
1356 | { |
1357 | drive = newdir[0]; | |
1358 | newdir += 2; | |
1359 | } | |
1360 | ||
1361 | /* Keep only a prefix from newdir if nm starts with slash | |
82330e7f | 1362 | (//server/share for UNC, nothing otherwise). */ |
9a1dc3be | 1363 | if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir) |
199607e4 RS |
1364 | { |
1365 | #ifdef WINDOWSNT | |
cb8b26b4 EZ |
1366 | if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]) |
1367 | && !IS_DIRECTORY_SEP (newdir[2])) | |
199607e4 | 1368 | { |
2893f146 PE |
1369 | char *adir = strcpy (alloca (strlen (newdir) + 1), newdir); |
1370 | char *p = adir + 2; | |
199607e4 RS |
1371 | while (*p && !IS_DIRECTORY_SEP (*p)) p++; |
1372 | p++; | |
1373 | while (*p && !IS_DIRECTORY_SEP (*p)) p++; | |
1374 | *p = 0; | |
2893f146 | 1375 | newdir = adir; |
199607e4 RS |
1376 | } |
1377 | else | |
1378 | #endif | |
1379 | newdir = ""; | |
1380 | } | |
1381 | } | |
5e570b75 | 1382 | #endif /* DOS_NT */ |
199607e4 RS |
1383 | |
1384 | if (newdir) | |
bfb61299 | 1385 | { |
c365c355 PE |
1386 | /* Ignore any slash at the end of newdir, unless newdir is |
1387 | just "/" or "//". */ | |
199607e4 | 1388 | length = strlen (newdir); |
c365c355 PE |
1389 | while (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1]) |
1390 | && ! (length == 2 && IS_DIRECTORY_SEP (newdir[0]))) | |
1391 | length--; | |
bfb61299 JB |
1392 | } |
1393 | else | |
c365c355 | 1394 | length = 0; |
570d7624 | 1395 | |
e8d32c7e | 1396 | /* Now concatenate the directory and name to new space in the stack frame. */ |
c365c355 | 1397 | tlen = length + file_name_as_directory_slop + strlen (nm) + 1; |
5e570b75 | 1398 | #ifdef DOS_NT |
f0f95d31 RS |
1399 | /* Reserve space for drive specifier and escape prefix, since either |
1400 | or both may need to be inserted. (The Microsoft x86 compiler | |
5e570b75 | 1401 | produces incorrect code if the following two lines are combined.) */ |
38182d90 | 1402 | target = alloca (tlen + 4); |
f0f95d31 | 1403 | target += 4; |
5e570b75 | 1404 | #else /* not DOS_NT */ |
c365c355 | 1405 | target = SAFE_ALLOCA (tlen); |
5e570b75 | 1406 | #endif /* not DOS_NT */ |
570d7624 JB |
1407 | *target = 0; |
1408 | ||
1409 | if (newdir) | |
1410 | { | |
5e570b75 | 1411 | if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0])) |
f5321b5c | 1412 | { |
3ea2d8b2 | 1413 | #ifdef DOS_NT |
f5321b5c RS |
1414 | /* If newdir is effectively "C:/", then the drive letter will have |
1415 | been stripped and newdir will be "/". Concatenating with an | |
1416 | absolute directory in nm produces "//", which will then be | |
1417 | incorrectly treated as a network share. Ignore newdir in | |
1418 | this case (keeping the drive letter). */ | |
efdc16c9 | 1419 | if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0]) |
f5321b5c RS |
1420 | && newdir[1] == '\0')) |
1421 | #endif | |
c365c355 PE |
1422 | { |
1423 | memcpy (target, newdir, length); | |
1424 | target[length] = 0; | |
1425 | } | |
f5321b5c | 1426 | } |
570d7624 | 1427 | else |
f5c81c80 | 1428 | file_name_as_directory (target, newdir, length, multibyte); |
570d7624 JB |
1429 | } |
1430 | ||
1431 | strcat (target, nm); | |
199607e4 | 1432 | |
214378ec GM |
1433 | /* Now canonicalize by removing `//', `/.' and `/foo/..' if they |
1434 | appear. */ | |
5b5a2ea1 | 1435 | { |
5976c3fe PE |
1436 | char *p = target; |
1437 | char *o = target; | |
570d7624 | 1438 | |
5b5a2ea1 SM |
1439 | while (*p) |
1440 | { | |
5b5a2ea1 SM |
1441 | if (!IS_DIRECTORY_SEP (*p)) |
1442 | { | |
1443 | *o++ = *p++; | |
1444 | } | |
1445 | else if (p[1] == '.' | |
1446 | && (IS_DIRECTORY_SEP (p[2]) | |
1447 | || p[2] == 0)) | |
1448 | { | |
1449 | /* If "/." is the entire filename, keep the "/". Otherwise, | |
1450 | just delete the whole "/.". */ | |
1451 | if (o == target && p[2] == '\0') | |
1452 | *o++ = *p; | |
1453 | p += 2; | |
1454 | } | |
1455 | else if (p[1] == '.' && p[2] == '.' | |
1456 | /* `/../' is the "superroot" on certain file systems. | |
1457 | Turned off on DOS_NT systems because they have no | |
1458 | "superroot" and because this causes us to produce | |
1459 | file names like "d:/../foo" which fail file-related | |
1460 | functions of the underlying OS. (To reproduce, try a | |
1461 | long series of "../../" in default_directory, longer | |
1462 | than the number of levels from the root.) */ | |
aa4060b9 | 1463 | #ifndef DOS_NT |
5b5a2ea1 | 1464 | && o != target |
aa4060b9 | 1465 | #endif |
5b5a2ea1 SM |
1466 | && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0)) |
1467 | { | |
972ed246 | 1468 | #ifdef WINDOWSNT |
5976c3fe | 1469 | char *prev_o = o; |
972ed246 | 1470 | #endif |
7ba11bee PE |
1471 | while (o != target && (--o, !IS_DIRECTORY_SEP (*o))) |
1472 | continue; | |
972ed246 JR |
1473 | #ifdef WINDOWSNT |
1474 | /* Don't go below server level in UNC filenames. */ | |
1475 | if (o == target + 1 && IS_DIRECTORY_SEP (*o) | |
1476 | && IS_DIRECTORY_SEP (*target)) | |
1477 | o = prev_o; | |
1478 | else | |
1479 | #endif | |
5b5a2ea1 SM |
1480 | /* Keep initial / only if this is the whole name. */ |
1481 | if (o == target && IS_ANY_SEP (*o) && p[3] == 0) | |
1482 | ++o; | |
1483 | p += 3; | |
1484 | } | |
c365c355 PE |
1485 | else if (IS_DIRECTORY_SEP (p[1]) |
1486 | && (p != target || IS_DIRECTORY_SEP (p[2]))) | |
1487 | /* Collapse multiple "/", except leave leading "//" alone. */ | |
5b5a2ea1 SM |
1488 | p++; |
1489 | else | |
1490 | { | |
1491 | *o++ = *p++; | |
1492 | } | |
5b5a2ea1 | 1493 | } |
570d7624 | 1494 | |
5e570b75 | 1495 | #ifdef DOS_NT |
e8d32c7e | 1496 | /* At last, set drive name. */ |
5e570b75 | 1497 | #ifdef WINDOWSNT |
5b5a2ea1 SM |
1498 | /* Except for network file name. */ |
1499 | if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1]))) | |
5e570b75 | 1500 | #endif /* WINDOWSNT */ |
5b5a2ea1 | 1501 | { |
1088b922 | 1502 | if (!drive) emacs_abort (); |
5b5a2ea1 SM |
1503 | target -= 2; |
1504 | target[0] = DRIVE_LETTER (drive); | |
1505 | target[1] = ':'; | |
1506 | } | |
1507 | /* Reinsert the escape prefix if required. */ | |
1508 | if (is_escaped) | |
1509 | { | |
1510 | target -= 2; | |
1511 | target[0] = '/'; | |
1512 | target[1] = ':'; | |
1513 | } | |
5b5a2ea1 | 1514 | result = make_specified_string (target, -1, o - target, multibyte); |
1fd201bb | 1515 | dostounix_filename (SSDATA (result)); |
e7ac588e EZ |
1516 | #ifdef WINDOWSNT |
1517 | if (!NILP (Vw32_downcase_file_names)) | |
1518 | result = Fdowncase (result); | |
1519 | #endif | |
273ac8d1 EZ |
1520 | #else /* !DOS_NT */ |
1521 | result = make_specified_string (target, -1, o - target, multibyte); | |
1522 | #endif /* !DOS_NT */ | |
5b5a2ea1 | 1523 | } |
beb402de KG |
1524 | |
1525 | /* Again look to see if the file name has special constructs in it | |
1526 | and perhaps call the corresponding file handler. This is needed | |
1527 | for filenames such as "/foo/../user@host:/bar/../baz". Expanding | |
1528 | the ".." component gives us "/user@host:/bar/../baz" which needs | |
e8d32c7e | 1529 | to be expanded again. */ |
beb402de KG |
1530 | handler = Ffind_file_name_handler (result, Qexpand_file_name); |
1531 | if (!NILP (handler)) | |
2375c96a CY |
1532 | { |
1533 | handled_name = call3 (handler, Qexpand_file_name, | |
1534 | result, default_directory); | |
c365c355 PE |
1535 | if (! STRINGP (handled_name)) |
1536 | error ("Invalid handler in `file-name-handler-alist'"); | |
1537 | result = handled_name; | |
2375c96a | 1538 | } |
beb402de | 1539 | |
c365c355 | 1540 | SAFE_FREE (); |
beb402de | 1541 | return result; |
570d7624 | 1542 | } |
5e570b75 | 1543 | |
4887597a EZ |
1544 | #if 0 |
1545 | /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION! | |
1546 | This is the old version of expand-file-name, before it was thoroughly | |
1547 | rewritten for Emacs 10.31. We leave this version here commented-out, | |
1548 | because the code is very complex and likely to have subtle bugs. If | |
1549 | bugs _are_ found, it might be of interest to look at the old code and | |
1550 | see what did it do in the relevant situation. | |
1551 | ||
30f50381 GM |
1552 | Don't remove this code: it's true that it will be accessible |
1553 | from the repository, but a few years from deletion, people will | |
1554 | forget it is there. */ | |
4887597a EZ |
1555 | |
1556 | /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */ | |
1557 | DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, | |
1558 | "Convert FILENAME to absolute, and canonicalize it.\n\ | |
1559 | Second arg DEFAULT is directory to start with if FILENAME is relative\n\ | |
c70a4df6 | 1560 | \(does not start with slash); if DEFAULT is nil or missing,\n\ |
4887597a EZ |
1561 | the current buffer's value of default-directory is used.\n\ |
1562 | Filenames containing `.' or `..' as components are simplified;\n\ | |
1563 | initial `~/' expands to your home directory.\n\ | |
1564 | See also the function `substitute-in-file-name'.") | |
1565 | (name, defalt) | |
1566 | Lisp_Object name, defalt; | |
1567 | { | |
1568 | unsigned char *nm; | |
1569 | ||
1570 | register unsigned char *newdir, *p, *o; | |
93f4cf88 | 1571 | ptrdiff_t tlen; |
4887597a EZ |
1572 | unsigned char *target; |
1573 | struct passwd *pw; | |
4887597a | 1574 | |
b7826503 | 1575 | CHECK_STRING (name); |
d5db4077 | 1576 | nm = SDATA (name); |
4887597a EZ |
1577 | |
1578 | /* If nm is absolute, flush ...// and detect /./ and /../. | |
1579 | If no /./ or /../ we can return right away. */ | |
7c2fb837 | 1580 | if (nm[0] == '/') |
4887597a | 1581 | { |
f75d7a91 | 1582 | bool lose = 0; |
4887597a | 1583 | p = nm; |
4887597a EZ |
1584 | while (*p) |
1585 | { | |
ce2fe65a | 1586 | if (p[0] == '/' && p[1] == '/') |
4887597a EZ |
1587 | nm = p + 1; |
1588 | if (p[0] == '/' && p[1] == '~') | |
1589 | nm = p + 1, lose = 1; | |
1590 | if (p[0] == '/' && p[1] == '.' | |
1591 | && (p[2] == '/' || p[2] == 0 | |
1592 | || (p[2] == '.' && (p[3] == '/' || p[3] == 0)))) | |
1593 | lose = 1; | |
4887597a EZ |
1594 | p++; |
1595 | } | |
1596 | if (!lose) | |
1597 | { | |
d5db4077 | 1598 | if (nm == SDATA (name)) |
4887597a EZ |
1599 | return name; |
1600 | return build_string (nm); | |
1601 | } | |
1602 | } | |
1603 | ||
e8d32c7e | 1604 | /* Now determine directory to start with and put it in NEWDIR. */ |
4887597a EZ |
1605 | |
1606 | newdir = 0; | |
1607 | ||
1608 | if (nm[0] == '~') /* prefix ~ */ | |
7c2fb837 | 1609 | if (nm[1] == '/' || nm[1] == 0)/* ~/filename */ |
4887597a EZ |
1610 | { |
1611 | if (!(newdir = (unsigned char *) egetenv ("HOME"))) | |
1612 | newdir = (unsigned char *) ""; | |
1613 | nm++; | |
4887597a EZ |
1614 | } |
1615 | else /* ~user/filename */ | |
1616 | { | |
e8d32c7e | 1617 | /* Get past ~ to user. */ |
4887597a | 1618 | unsigned char *user = nm + 1; |
e8d32c7e | 1619 | /* Find end of name. */ |
8966b757 | 1620 | unsigned char *ptr = (unsigned char *) strchr (user, '/'); |
93f4cf88 | 1621 | ptrdiff_t len = ptr ? ptr - user : strlen (user); |
e8d32c7e | 1622 | /* Copy the user name into temp storage. */ |
38182d90 | 1623 | o = alloca (len + 1); |
72af86bd | 1624 | memcpy (o, user, len); |
4887597a EZ |
1625 | o[len] = 0; |
1626 | ||
e8d32c7e | 1627 | /* Look up the user name. */ |
4d7e6e51 | 1628 | block_input (); |
4887597a | 1629 | pw = (struct passwd *) getpwnam (o + 1); |
4d7e6e51 | 1630 | unblock_input (); |
4887597a EZ |
1631 | if (!pw) |
1632 | error ("\"%s\" isn't a registered user", o + 1); | |
1633 | ||
1634 | newdir = (unsigned char *) pw->pw_dir; | |
1635 | ||
1636 | /* Discard the user name from NM. */ | |
1637 | nm += len; | |
1638 | } | |
1639 | ||
7c2fb837 | 1640 | if (nm[0] != '/' && !newdir) |
4887597a EZ |
1641 | { |
1642 | if (NILP (defalt)) | |
1643 | defalt = current_buffer->directory; | |
b7826503 | 1644 | CHECK_STRING (defalt); |
d5db4077 | 1645 | newdir = SDATA (defalt); |
4887597a EZ |
1646 | } |
1647 | ||
e8d32c7e | 1648 | /* Now concatenate the directory and name to new space in the stack frame. */ |
4887597a EZ |
1649 | |
1650 | tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1; | |
38182d90 | 1651 | target = alloca (tlen); |
4887597a EZ |
1652 | *target = 0; |
1653 | ||
1654 | if (newdir) | |
1655 | { | |
4887597a EZ |
1656 | if (nm[0] == 0 || nm[0] == '/') |
1657 | strcpy (target, newdir); | |
1658 | else | |
4887597a EZ |
1659 | file_name_as_directory (target, newdir); |
1660 | } | |
1661 | ||
1662 | strcat (target, nm); | |
4887597a | 1663 | |
e8d32c7e | 1664 | /* Now canonicalize by removing /. and /foo/.. if they appear. */ |
4887597a EZ |
1665 | |
1666 | p = target; | |
1667 | o = target; | |
1668 | ||
1669 | while (*p) | |
1670 | { | |
4887597a EZ |
1671 | if (*p != '/') |
1672 | { | |
1673 | *o++ = *p++; | |
1674 | } | |
1675 | else if (!strncmp (p, "//", 2) | |
4887597a EZ |
1676 | ) |
1677 | { | |
1678 | o = target; | |
1679 | p++; | |
1680 | } | |
994a7262 RS |
1681 | else if (p[0] == '/' && p[1] == '.' |
1682 | && (p[2] == '/' || p[2] == 0)) | |
4887597a EZ |
1683 | p += 2; |
1684 | else if (!strncmp (p, "/..", 3) | |
1685 | /* `/../' is the "superroot" on certain file systems. */ | |
1686 | && o != target | |
1687 | && (p[3] == '/' || p[3] == 0)) | |
1688 | { | |
1689 | while (o != target && *--o != '/') | |
1690 | ; | |
4887597a EZ |
1691 | if (o == target && *o == '/') |
1692 | ++o; | |
1693 | p += 3; | |
1694 | } | |
1695 | else | |
1696 | { | |
1697 | *o++ = *p++; | |
1698 | } | |
4887597a EZ |
1699 | } |
1700 | ||
1701 | return make_string (target, o - target); | |
1702 | } | |
1703 | #endif | |
570d7624 | 1704 | \f |
c70a4df6 | 1705 | /* If /~ or // appears, discard everything through first slash. */ |
f75d7a91 | 1706 | static bool |
5976c3fe | 1707 | file_name_absolute_p (const char *filename) |
c70a4df6 SM |
1708 | { |
1709 | return | |
1710 | (IS_DIRECTORY_SEP (*filename) || *filename == '~' | |
c70a4df6 SM |
1711 | #ifdef DOS_NT |
1712 | || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1]) | |
1713 | && IS_DIRECTORY_SEP (filename[2])) | |
1714 | #endif | |
1715 | ); | |
1716 | } | |
1717 | ||
5976c3fe PE |
1718 | static char * |
1719 | search_embedded_absfilename (char *nm, char *endp) | |
c70a4df6 | 1720 | { |
5976c3fe | 1721 | char *p, *s; |
c70a4df6 SM |
1722 | |
1723 | for (p = nm + 1; p < endp; p++) | |
1724 | { | |
ce2fe65a | 1725 | if (IS_DIRECTORY_SEP (p[-1]) |
c70a4df6 | 1726 | && file_name_absolute_p (p) |
5e617bc2 | 1727 | #if defined (WINDOWSNT) || defined (CYGWIN) |
c70a4df6 SM |
1728 | /* // at start of file name is meaningful in Apollo, |
1729 | WindowsNT and Cygwin systems. */ | |
f34574c6 | 1730 | && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm) |
e39a993c | 1731 | #endif /* not (WINDOWSNT || CYGWIN) */ |
ce2fe65a | 1732 | ) |
c70a4df6 | 1733 | { |
ce2fe65a | 1734 | for (s = p; *s && !IS_DIRECTORY_SEP (*s); s++); |
e8d32c7e | 1735 | if (p[0] == '~' && s > p + 1) /* We've got "/~something/". */ |
c70a4df6 | 1736 | { |
5976c3fe | 1737 | char *o = alloca (s - p + 1); |
c70a4df6 | 1738 | struct passwd *pw; |
72af86bd | 1739 | memcpy (o, p, s - p); |
c70a4df6 SM |
1740 | o [s - p] = 0; |
1741 | ||
1742 | /* If we have ~user and `user' exists, discard | |
1743 | everything up to ~. But if `user' does not exist, leave | |
1744 | ~user alone, it might be a literal file name. */ | |
4d7e6e51 | 1745 | block_input (); |
67c08d6c | 1746 | pw = getpwnam (o + 1); |
4d7e6e51 | 1747 | unblock_input (); |
67c08d6c | 1748 | if (pw) |
c70a4df6 | 1749 | return p; |
c70a4df6 SM |
1750 | } |
1751 | else | |
1752 | return p; | |
1753 | } | |
1754 | } | |
1755 | return NULL; | |
1756 | } | |
1757 | ||
a7ca3326 | 1758 | DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name, |
8c1a1077 PJ |
1759 | Ssubstitute_in_file_name, 1, 1, 0, |
1760 | doc: /* Substitute environment variables referred to in FILENAME. | |
1761 | `$FOO' where FOO is an environment variable name means to substitute | |
1762 | the value of that variable. The variable name should be terminated | |
1763 | with a character not a letter, digit or underscore; otherwise, enclose | |
1764 | the entire variable name in braces. | |
c68845e0 GM |
1765 | |
1766 | If `/~' appears, all of FILENAME through that `/' is discarded. | |
1767 | If `//' appears, everything up to and including the first of | |
1768 | those `/' is discarded. */) | |
5842a27b | 1769 | (Lisp_Object filename) |
570d7624 | 1770 | { |
ee041f2d SM |
1771 | char *nm, *p, *x, *endp; |
1772 | bool substituted = false; | |
fce31d69 | 1773 | bool multibyte; |
5976c3fe | 1774 | char *xnm; |
8ce069f5 | 1775 | Lisp_Object handler; |
570d7624 | 1776 | |
b7826503 | 1777 | CHECK_STRING (filename); |
570d7624 | 1778 | |
58aec0d6 JR |
1779 | multibyte = STRING_MULTIBYTE (filename); |
1780 | ||
8ce069f5 RS |
1781 | /* If the file name has special constructs in it, |
1782 | call the corresponding file handler. */ | |
3b7f6e60 | 1783 | handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name); |
8ce069f5 | 1784 | if (!NILP (handler)) |
2375c96a CY |
1785 | { |
1786 | Lisp_Object handled_name = call2 (handler, Qsubstitute_in_file_name, | |
1787 | filename); | |
1788 | if (STRINGP (handled_name)) | |
1789 | return handled_name; | |
1790 | error ("Invalid handler in `file-name-handler-alist'"); | |
1791 | } | |
8ce069f5 | 1792 | |
58aec0d6 JR |
1793 | /* Always work on a copy of the string, in case GC happens during |
1794 | decode of environment variables, causing the original Lisp_String | |
1795 | data to be relocated. */ | |
5b71542d | 1796 | nm = xlispstrdupa (filename); |
0f3f018c | 1797 | |
58aec0d6 | 1798 | #ifdef DOS_NT |
1fd201bb | 1799 | dostounix_filename (nm); |
e7ac588e | 1800 | substituted = (memcmp (nm, SDATA (filename), SBYTES (filename)) != 0); |
a5a1cc06 | 1801 | #endif |
d5db4077 | 1802 | endp = nm + SBYTES (filename); |
570d7624 | 1803 | |
82330e7f | 1804 | /* If /~ or // appears, discard everything through first slash. */ |
c70a4df6 SM |
1805 | p = search_embedded_absfilename (nm, endp); |
1806 | if (p) | |
1807 | /* Start over with the new string, so we check the file-name-handler | |
1808 | again. Important with filenames like "/home/foo//:/hello///there" | |
ee7683eb | 1809 | which would substitute to "/:/hello///there" rather than "/there". */ |
c70a4df6 | 1810 | return Fsubstitute_in_file_name |
58aec0d6 | 1811 | (make_specified_string (p, -1, endp - p, multibyte)); |
570d7624 | 1812 | |
ee041f2d | 1813 | /* See if any variables are substituted into the string. */ |
570d7624 | 1814 | |
ee041f2d SM |
1815 | if (!NILP (Ffboundp (Qsubstitute_env_in_file_name))) |
1816 | { | |
1817 | Lisp_Object name | |
1818 | = (!substituted ? filename | |
1819 | : make_specified_string (nm, -1, endp - nm, multibyte)); | |
1820 | Lisp_Object tmp = call1 (Qsubstitute_env_in_file_name, name); | |
1821 | CHECK_STRING (tmp); | |
1822 | if (!EQ (tmp, name)) | |
1823 | substituted = true; | |
1824 | filename = tmp; | |
1825 | } | |
570d7624 JB |
1826 | |
1827 | if (!substituted) | |
e7ac588e EZ |
1828 | { |
1829 | #ifdef WINDOWSNT | |
1830 | if (!NILP (Vw32_downcase_file_names)) | |
1831 | filename = Fdowncase (filename); | |
1832 | #endif | |
1833 | return filename; | |
1834 | } | |
570d7624 | 1835 | |
ee041f2d SM |
1836 | xnm = SSDATA (filename); |
1837 | x = xnm + SBYTES (filename); | |
3d798ba7 | 1838 | |
82330e7f | 1839 | /* If /~ or // appears, discard everything through first slash. */ |
ce2fe65a | 1840 | while ((p = search_embedded_absfilename (xnm, x)) != NULL) |
c70a4df6 SM |
1841 | /* This time we do not start over because we've already expanded envvars |
1842 | and replaced $$ with $. Maybe we should start over as well, but we'd | |
1843 | need to quote some $ to $$ first. */ | |
1844 | xnm = p; | |
570d7624 | 1845 | |
e7ac588e EZ |
1846 | #ifdef WINDOWSNT |
1847 | if (!NILP (Vw32_downcase_file_names)) | |
1848 | { | |
1849 | Lisp_Object xname = make_specified_string (xnm, -1, x - xnm, multibyte); | |
1850 | ||
1851 | xname = Fdowncase (xname); | |
1852 | return xname; | |
1853 | } | |
1854 | else | |
1855 | #endif | |
ee041f2d SM |
1856 | return (xnm == SSDATA (filename) |
1857 | ? filename | |
1858 | : make_specified_string (xnm, -1, x - xnm, multibyte)); | |
570d7624 JB |
1859 | } |
1860 | \f | |
067ffa38 | 1861 | /* A slightly faster and more convenient way to get |
298b760e | 1862 | (directory-file-name (expand-file-name FOO)). */ |
067ffa38 | 1863 | |
570d7624 | 1864 | Lisp_Object |
971de7fb | 1865 | expand_and_dir_to_file (Lisp_Object filename, Lisp_Object defdir) |
570d7624 | 1866 | { |
199607e4 | 1867 | register Lisp_Object absname; |
570d7624 | 1868 | |
199607e4 | 1869 | absname = Fexpand_file_name (filename, defdir); |
7c2fb837 | 1870 | |
199607e4 | 1871 | /* Remove final slash, if any (unless this is the root dir). |
570d7624 | 1872 | stat behaves differently depending! */ |
d5db4077 KR |
1873 | if (SCHARS (absname) > 1 |
1874 | && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1)) | |
e8d32c7e | 1875 | && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname) - 2))) |
ddc61f46 | 1876 | /* We cannot take shortcuts; they might be wrong for magic file names. */ |
199607e4 | 1877 | absname = Fdirectory_file_name (absname); |
199607e4 | 1878 | return absname; |
570d7624 JB |
1879 | } |
1880 | \f | |
3ed15d97 | 1881 | /* Signal an error if the file ABSNAME already exists. |
a560b856 | 1882 | If KNOWN_TO_EXIST, the file is known to exist. |
3ed15d97 RS |
1883 | QUERYSTRING is a name for the action that is being considered |
1884 | to alter the file. | |
a560b856 PE |
1885 | If INTERACTIVE, ask the user whether to proceed, |
1886 | and bypass the error if the user says to go ahead. | |
f75d7a91 | 1887 | If QUICK, ask for y or n, not yes or no. */ |
3ed15d97 | 1888 | |
f14b7e14 | 1889 | static void |
a560b856 PE |
1890 | barf_or_query_if_file_exists (Lisp_Object absname, bool known_to_exist, |
1891 | const char *querystring, bool interactive, | |
f75d7a91 | 1892 | bool quick) |
570d7624 | 1893 | { |
f75d7a91 | 1894 | Lisp_Object tem, encoded_filename; |
4018b5ef | 1895 | struct stat statbuf; |
570d7624 JB |
1896 | struct gcpro gcpro1; |
1897 | ||
643c73b9 RS |
1898 | encoded_filename = ENCODE_FILE (absname); |
1899 | ||
a560b856 | 1900 | if (! known_to_exist && lstat (SSDATA (encoded_filename), &statbuf) == 0) |
570d7624 | 1901 | { |
6e9b2be9 | 1902 | if (S_ISDIR (statbuf.st_mode)) |
c4f2d8d4 | 1903 | xsignal2 (Qfile_error, |
ad637907 | 1904 | build_string ("File is a directory"), absname); |
a560b856 PE |
1905 | known_to_exist = true; |
1906 | } | |
c4f2d8d4 | 1907 | |
a560b856 PE |
1908 | if (known_to_exist) |
1909 | { | |
570d7624 | 1910 | if (! interactive) |
24b1ddad KS |
1911 | xsignal2 (Qfile_already_exists, |
1912 | build_string ("File already exists"), absname); | |
570d7624 | 1913 | GCPRO1 (absname); |
67e8e2b8 RS |
1914 | tem = format2 ("File %s already exists; %s anyway? ", |
1915 | absname, build_string (querystring)); | |
b8b29dc9 | 1916 | if (quick) |
5616cc54 | 1917 | tem = call1 (intern ("y-or-n-p"), tem); |
b8b29dc9 RS |
1918 | else |
1919 | tem = do_yes_or_no_p (tem); | |
570d7624 | 1920 | UNGCPRO; |
265a9e55 | 1921 | if (NILP (tem)) |
24b1ddad KS |
1922 | xsignal2 (Qfile_already_exists, |
1923 | build_string ("File already exists"), absname); | |
3ed15d97 | 1924 | } |
570d7624 JB |
1925 | } |
1926 | ||
574c05e2 | 1927 | DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 6, |
7c0f6118 | 1928 | "fCopy file: \nGCopy %s to file: \np\nP", |
8c1a1077 PJ |
1929 | doc: /* Copy FILE to NEWNAME. Both args must be strings. |
1930 | If NEWNAME names a directory, copy FILE there. | |
795c20df CY |
1931 | |
1932 | This function always sets the file modes of the output file to match | |
1933 | the input file. | |
1934 | ||
1935 | The optional third argument OK-IF-ALREADY-EXISTS specifies what to do | |
1936 | if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we | |
1937 | signal a `file-already-exists' error without overwriting. If | |
1938 | OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user | |
1939 | about overwriting; this is what happens in interactive use with M-x. | |
1940 | Any other value for OK-IF-ALREADY-EXISTS means to overwrite the | |
1941 | existing file. | |
c50f15d0 | 1942 | |
7f08b80e | 1943 | Fourth arg KEEP-TIME non-nil means give the output file the same |
8c1a1077 | 1944 | last-modified time as the old one. (This works on only some systems.) |
c50f15d0 | 1945 | |
7fce7dfe EZ |
1946 | A prefix arg makes KEEP-TIME non-nil. |
1947 | ||
586702ce | 1948 | If PRESERVE-UID-GID is non-nil, we try to transfer the |
574c05e2 KK |
1949 | uid and gid of FILE to NEWNAME. |
1950 | ||
a560b856 PE |
1951 | If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME; |
1952 | this includes the file modes, along with ACL entries and SELinux | |
1953 | context if present. Otherwise, if NEWNAME is created its file | |
1954 | permission bits are those of FILE, masked by the default file | |
1955 | permissions. */) | |
1956 | (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists, | |
1957 | Lisp_Object keep_time, Lisp_Object preserve_uid_gid, | |
1958 | Lisp_Object preserve_permissions) | |
570d7624 | 1959 | { |
32f4334d | 1960 | Lisp_Object handler; |
b1d1b865 | 1961 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
2bfa3d3e | 1962 | dynwind_begin (); |
b1d1b865 | 1963 | Lisp_Object encoded_file, encoded_newname; |
574c05e2 KK |
1964 | #if HAVE_LIBSELINUX |
1965 | security_context_t con; | |
f75d7a91 | 1966 | int conlength = 0; |
574c05e2 | 1967 | #endif |
ffdc270a | 1968 | #ifdef WINDOWSNT |
ec4440cf | 1969 | int result; |
af025ae8 | 1970 | #else |
2db9da01 JB |
1971 | bool already_exists = false; |
1972 | mode_t new_mask; | |
af025ae8 EZ |
1973 | int ifd, ofd; |
1974 | int n; | |
1975 | char buf[16 * 1024]; | |
1976 | struct stat st; | |
7c3d167f | 1977 | #endif |
570d7624 | 1978 | |
b1d1b865 RS |
1979 | encoded_file = encoded_newname = Qnil; |
1980 | GCPRO4 (file, newname, encoded_file, encoded_newname); | |
b7826503 PJ |
1981 | CHECK_STRING (file); |
1982 | CHECK_STRING (newname); | |
b1d1b865 | 1983 | |
a9d14e54 | 1984 | if (!NILP (Ffile_directory_p (newname))) |
6b61353c | 1985 | newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname); |
a9d14e54 GM |
1986 | else |
1987 | newname = Fexpand_file_name (newname, Qnil); | |
1988 | ||
3b7f6e60 | 1989 | file = Fexpand_file_name (file, Qnil); |
32f4334d | 1990 | |
0bf2eed2 | 1991 | /* If the input file name has special constructs in it, |
32f4334d | 1992 | call the corresponding file handler. */ |
3b7f6e60 | 1993 | handler = Ffind_file_name_handler (file, Qcopy_file); |
0bf2eed2 | 1994 | /* Likewise for output file name. */ |
51cf6d37 | 1995 | if (NILP (handler)) |
49307295 | 1996 | handler = Ffind_file_name_handler (newname, Qcopy_file); |
2bfa3d3e BT |
1997 | if (!NILP (handler)) { |
1998 | dynwind_end (); | |
1999 | return call7 (handler, Qcopy_file, file, newname, ok_if_already_exists, keep_time, preserve_uid_gid, preserve_permissions); | |
2000 | } | |
32f4334d | 2001 | |
b1d1b865 RS |
2002 | encoded_file = ENCODE_FILE (file); |
2003 | encoded_newname = ENCODE_FILE (newname); | |
2004 | ||
a560b856 | 2005 | #ifdef WINDOWSNT |
265a9e55 | 2006 | if (NILP (ok_if_already_exists) |
93c30b5f | 2007 | || INTEGERP (ok_if_already_exists)) |
a560b856 PE |
2008 | barf_or_query_if_file_exists (newname, false, "copy to it", |
2009 | INTEGERP (ok_if_already_exists), false); | |
570d7624 | 2010 | |
ec4440cf EZ |
2011 | result = w32_copy_file (SSDATA (encoded_file), SSDATA (encoded_newname), |
2012 | !NILP (keep_time), !NILP (preserve_uid_gid), | |
a560b856 | 2013 | !NILP (preserve_permissions)); |
ec4440cf | 2014 | switch (result) |
66447e07 | 2015 | { |
ec4440cf EZ |
2016 | case -1: |
2017 | report_file_error ("Copying file", list2 (file, newname)); | |
2018 | case -2: | |
2019 | report_file_error ("Copying permissions from", file); | |
2020 | case -3: | |
2021 | xsignal2 (Qfile_date_error, | |
2022 | build_string ("Resetting file times"), newname); | |
2023 | case -4: | |
2024 | report_file_error ("Copying permissions to", newname); | |
66447e07 | 2025 | } |
e8691c59 | 2026 | #else /* not WINDOWSNT */ |
13336908 | 2027 | immediate_quit = 1; |
42a5b22f | 2028 | ifd = emacs_open (SSDATA (encoded_file), O_RDONLY, 0); |
13336908 RS |
2029 | immediate_quit = 0; |
2030 | ||
570d7624 | 2031 | if (ifd < 0) |
a9757f6a | 2032 | report_file_error ("Opening input file", file); |
570d7624 | 2033 | |
5d1922cd | 2034 | record_unwind_protect_int_1 (close_file_unwind, ifd, false); |
b5148e85 | 2035 | |
d20704ef | 2036 | if (fstat (ifd, &st) != 0) |
a9757f6a | 2037 | report_file_error ("Input file status", file); |
f73b0ada | 2038 | |
a560b856 | 2039 | if (!NILP (preserve_permissions)) |
574c05e2 | 2040 | { |
7c3d167f RF |
2041 | #if HAVE_LIBSELINUX |
2042 | if (is_selinux_enabled ()) | |
2043 | { | |
2044 | conlength = fgetfilecon (ifd, &con); | |
2045 | if (conlength == -1) | |
a9757f6a | 2046 | report_file_error ("Doing fgetfilecon", file); |
7c3d167f RF |
2047 | } |
2048 | #endif | |
7c3d167f | 2049 | } |
574c05e2 | 2050 | |
d20704ef PE |
2051 | /* We can copy only regular files. */ |
2052 | if (!S_ISREG (st.st_mode)) | |
a9757f6a | 2053 | report_file_errno ("Non-regular file", file, |
a773ed9a | 2054 | S_ISDIR (st.st_mode) ? EISDIR : EINVAL); |
f73b0ada | 2055 | |
a773ed9a | 2056 | #ifndef MSDOS |
a560b856 | 2057 | new_mask = st.st_mode & (!NILP (preserve_uid_gid) ? 0700 : 0777); |
a773ed9a | 2058 | #else |
a560b856 | 2059 | new_mask = S_IREAD | S_IWRITE; |
a773ed9a | 2060 | #endif |
a560b856 PE |
2061 | |
2062 | ofd = emacs_open (SSDATA (encoded_newname), O_WRONLY | O_CREAT | O_EXCL, | |
2063 | new_mask); | |
2064 | if (ofd < 0 && errno == EEXIST) | |
2065 | { | |
2066 | if (NILP (ok_if_already_exists) || INTEGERP (ok_if_already_exists)) | |
2067 | barf_or_query_if_file_exists (newname, true, "copy to it", | |
2068 | INTEGERP (ok_if_already_exists), false); | |
2069 | already_exists = true; | |
2070 | ofd = emacs_open (SSDATA (encoded_newname), O_WRONLY, 0); | |
2071 | } | |
570d7624 | 2072 | if (ofd < 0) |
a9757f6a | 2073 | report_file_error ("Opening output file", newname); |
b5148e85 | 2074 | |
5d1922cd | 2075 | record_unwind_protect_int_1 (close_file_unwind, ofd, false); |
570d7624 | 2076 | |
a560b856 PE |
2077 | if (already_exists) |
2078 | { | |
2079 | struct stat out_st; | |
2080 | if (fstat (ofd, &out_st) != 0) | |
2081 | report_file_error ("Output file status", newname); | |
2082 | if (st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino) | |
2083 | report_file_errno ("Input and output files are the same", | |
2084 | list2 (file, newname), 0); | |
2085 | if (ftruncate (ofd, 0) != 0) | |
2086 | report_file_error ("Truncating output file", newname); | |
2087 | } | |
2088 | ||
b5148e85 RS |
2089 | immediate_quit = 1; |
2090 | QUIT; | |
68c45bf0 | 2091 | while ((n = emacs_read (ifd, buf, sizeof buf)) > 0) |
4ebbdd67 | 2092 | if (emacs_write_sig (ofd, buf, n) != n) |
4e604a5d | 2093 | report_file_error ("Write error", newname); |
b5148e85 | 2094 | immediate_quit = 0; |
570d7624 | 2095 | |
b016179b | 2096 | #ifndef MSDOS |
ffdc270a | 2097 | /* Preserve the original file permissions, and if requested, also its |
b016179b | 2098 | owner and group. */ |
d20704ef | 2099 | { |
a560b856 PE |
2100 | mode_t preserved_permissions = st.st_mode & 07777; |
2101 | mode_t default_permissions = st.st_mode & 0777 & ~realmask; | |
d20704ef PE |
2102 | if (!NILP (preserve_uid_gid)) |
2103 | { | |
2104 | /* Attempt to change owner and group. If that doesn't work | |
2105 | attempt to change just the group, as that is sometimes allowed. | |
2106 | Adjust the mode mask to eliminate setuid or setgid bits | |
a560b856 PE |
2107 | or group permissions bits that are inappropriate if the |
2108 | owner or group are wrong. */ | |
d20704ef PE |
2109 | if (fchown (ofd, st.st_uid, st.st_gid) != 0) |
2110 | { | |
d20704ef | 2111 | if (fchown (ofd, -1, st.st_gid) == 0) |
a560b856 PE |
2112 | preserved_permissions &= ~04000; |
2113 | else | |
2114 | { | |
2115 | preserved_permissions &= ~06000; | |
2116 | ||
2117 | /* Copy the other bits to the group bits, since the | |
2118 | group is wrong. */ | |
2119 | preserved_permissions &= ~070; | |
2120 | preserved_permissions |= (preserved_permissions & 7) << 3; | |
2121 | default_permissions &= ~070; | |
2122 | default_permissions |= (default_permissions & 7) << 3; | |
2123 | } | |
d20704ef PE |
2124 | } |
2125 | } | |
ffdc270a | 2126 | |
a560b856 | 2127 | switch (!NILP (preserve_permissions) |
ffdc270a PE |
2128 | ? qcopy_acl (SSDATA (encoded_file), ifd, |
2129 | SSDATA (encoded_newname), ofd, | |
a560b856 PE |
2130 | preserved_permissions) |
2131 | : (already_exists | |
2132 | || (new_mask & ~realmask) == default_permissions) | |
2133 | ? 0 | |
2134 | : fchmod (ofd, default_permissions)) | |
ffdc270a | 2135 | { |
a9757f6a PE |
2136 | case -2: report_file_error ("Copying permissions from", file); |
2137 | case -1: report_file_error ("Copying permissions to", newname); | |
ffdc270a | 2138 | } |
d20704ef | 2139 | } |
b016179b | 2140 | #endif /* not MSDOS */ |
586702ce | 2141 | |
574c05e2 KK |
2142 | #if HAVE_LIBSELINUX |
2143 | if (conlength > 0) | |
2144 | { | |
24c51a09 | 2145 | /* Set the modified context back to the file. */ |
f75d7a91 | 2146 | bool fail = fsetfilecon (ofd, con) != 0; |
24c51a09 GM |
2147 | /* See http://debbugs.gnu.org/11245 for ENOTSUP. */ |
2148 | if (fail && errno != ENOTSUP) | |
a9757f6a | 2149 | report_file_error ("Doing fsetfilecon", newname); |
574c05e2 KK |
2150 | |
2151 | freecon (con); | |
2152 | } | |
2153 | #endif | |
2154 | ||
d20704ef | 2155 | if (!NILP (keep_time)) |
570d7624 | 2156 | { |
43aac990 PE |
2157 | struct timespec atime = get_stat_atime (&st); |
2158 | struct timespec mtime = get_stat_mtime (&st); | |
96c06863 | 2159 | if (set_file_times (ofd, SSDATA (encoded_newname), atime, mtime) != 0) |
d20704ef PE |
2160 | xsignal2 (Qfile_date_error, |
2161 | build_string ("Cannot set file date"), newname); | |
570d7624 JB |
2162 | } |
2163 | ||
d35af63c | 2164 | if (emacs_close (ofd) < 0) |
4e604a5d | 2165 | report_file_error ("Write error", newname); |
d35af63c | 2166 | |
68c45bf0 | 2167 | emacs_close (ifd); |
b016179b | 2168 | |
ed68db4d | 2169 | #ifdef MSDOS |
d20704ef PE |
2170 | /* In DJGPP v2.0 and later, fstat usually returns true file mode bits, |
2171 | and if it can't, it tells so. Otherwise, under MSDOS we usually | |
2172 | get only the READ bit, which will make the copied file read-only, | |
2173 | so it's better not to chmod at all. */ | |
2174 | if ((_djstat_flags & _STFAIL_WRITEBIT) == 0) | |
2175 | chmod (SDATA (encoded_newname), st.st_mode & 07777); | |
ed68db4d | 2176 | #endif /* MSDOS */ |
b016179b | 2177 | #endif /* not WINDOWSNT */ |
5acac34e | 2178 | |
2bfa3d3e | 2179 | dynwind_end (); |
b5148e85 | 2180 | |
570d7624 JB |
2181 | UNGCPRO; |
2182 | return Qnil; | |
2183 | } | |
385b6cc7 | 2184 | \f |
9bbe01fb | 2185 | DEFUN ("make-directory-internal", Fmake_directory_internal, |
353cfc19 | 2186 | Smake_directory_internal, 1, 1, 0, |
8c1a1077 | 2187 | doc: /* Create a new directory named DIRECTORY. */) |
5842a27b | 2188 | (Lisp_Object directory) |
570d7624 | 2189 | { |
5976c3fe | 2190 | const char *dir; |
32f4334d | 2191 | Lisp_Object handler; |
b1d1b865 | 2192 | Lisp_Object encoded_dir; |
570d7624 | 2193 | |
b7826503 | 2194 | CHECK_STRING (directory); |
3b7f6e60 | 2195 | directory = Fexpand_file_name (directory, Qnil); |
32f4334d | 2196 | |
3b7f6e60 | 2197 | handler = Ffind_file_name_handler (directory, Qmake_directory_internal); |
32f4334d | 2198 | if (!NILP (handler)) |
3b7f6e60 | 2199 | return call2 (handler, Qmake_directory_internal, directory); |
9bbe01fb | 2200 | |
b1d1b865 RS |
2201 | encoded_dir = ENCODE_FILE (directory); |
2202 | ||
5976c3fe | 2203 | dir = SSDATA (encoded_dir); |
570d7624 | 2204 | |
5e570b75 RS |
2205 | #ifdef WINDOWSNT |
2206 | if (mkdir (dir) != 0) | |
2207 | #else | |
09450bae | 2208 | if (mkdir (dir, 0777 & ~auto_saving_dir_umask) != 0) |
5e570b75 | 2209 | #endif |
a9757f6a | 2210 | report_file_error ("Creating directory", directory); |
570d7624 | 2211 | |
32f4334d | 2212 | return Qnil; |
570d7624 JB |
2213 | } |
2214 | ||
9d8f3bd9 MA |
2215 | DEFUN ("delete-directory-internal", Fdelete_directory_internal, |
2216 | Sdelete_directory_internal, 1, 1, 0, | |
efdc16c9 | 2217 | doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */) |
5842a27b | 2218 | (Lisp_Object directory) |
570d7624 | 2219 | { |
5976c3fe | 2220 | const char *dir; |
b1d1b865 | 2221 | Lisp_Object encoded_dir; |
570d7624 | 2222 | |
b7826503 | 2223 | CHECK_STRING (directory); |
3b7f6e60 | 2224 | directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil)); |
b1d1b865 | 2225 | encoded_dir = ENCODE_FILE (directory); |
5976c3fe | 2226 | dir = SSDATA (encoded_dir); |
b1d1b865 | 2227 | |
570d7624 | 2228 | if (rmdir (dir) != 0) |
a9757f6a | 2229 | report_file_error ("Removing directory", directory); |
570d7624 JB |
2230 | |
2231 | return Qnil; | |
2232 | } | |
2233 | ||
2e2bbddb | 2234 | DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 2, |
f1a5d776 CY |
2235 | "(list (read-file-name \ |
2236 | (if (and delete-by-moving-to-trash (null current-prefix-arg)) \ | |
2237 | \"Move file to trash: \" \"Delete file: \") \ | |
2238 | nil default-directory (confirm-nonexistent-file-or-buffer)) \ | |
2239 | (null current-prefix-arg))", | |
efdc16c9 | 2240 | doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink. |
53967e09 | 2241 | If file has multiple names, it continues to exist with the other names. |
f1a5d776 CY |
2242 | TRASH non-nil means to trash the file instead of deleting, provided |
2243 | `delete-by-moving-to-trash' is non-nil. | |
53967e09 | 2244 | |
f1a5d776 CY |
2245 | When called interactively, TRASH is t if no prefix argument is given. |
2246 | With a prefix argument, TRASH is nil. */) | |
5842a27b | 2247 | (Lisp_Object filename, Lisp_Object trash) |
570d7624 | 2248 | { |
32f4334d | 2249 | Lisp_Object handler; |
b1d1b865 | 2250 | Lisp_Object encoded_file; |
efdc16c9 | 2251 | struct gcpro gcpro1; |
b1d1b865 | 2252 | |
efdc16c9 | 2253 | GCPRO1 (filename); |
b4bd27c5 RS |
2254 | if (!NILP (Ffile_directory_p (filename)) |
2255 | && NILP (Ffile_symlink_p (filename))) | |
24b1ddad KS |
2256 | xsignal2 (Qfile_error, |
2257 | build_string ("Removing old name: is a directory"), | |
2258 | filename); | |
efdc16c9 | 2259 | UNGCPRO; |
570d7624 | 2260 | filename = Fexpand_file_name (filename, Qnil); |
32f4334d | 2261 | |
49307295 | 2262 | handler = Ffind_file_name_handler (filename, Qdelete_file); |
32f4334d | 2263 | if (!NILP (handler)) |
f5783df3 | 2264 | return call3 (handler, Qdelete_file, filename, trash); |
32f4334d | 2265 | |
f1a5d776 | 2266 | if (delete_by_moving_to_trash && !NILP (trash)) |
6cf29fe8 JR |
2267 | return call1 (Qmove_file_to_trash, filename); |
2268 | ||
b1d1b865 RS |
2269 | encoded_file = ENCODE_FILE (filename); |
2270 | ||
ce2fe65a | 2271 | if (unlink (SSDATA (encoded_file)) < 0) |
a9757f6a | 2272 | report_file_error ("Removing old name", filename); |
8a9b0da9 | 2273 | return Qnil; |
570d7624 JB |
2274 | } |
2275 | ||
385b6cc7 | 2276 | static Lisp_Object |
971de7fb | 2277 | internal_delete_file_1 (Lisp_Object ignore) |
385b6cc7 RS |
2278 | { |
2279 | return Qt; | |
2280 | } | |
2281 | ||
7d80ea23 | 2282 | /* Delete file FILENAME, returning true if successful. |
f1a5d776 | 2283 | This ignores `delete-by-moving-to-trash'. */ |
385b6cc7 | 2284 | |
7d80ea23 | 2285 | bool |
f1a5d776 | 2286 | internal_delete_file (Lisp_Object filename) |
385b6cc7 | 2287 | { |
b0728617 EZ |
2288 | Lisp_Object tem; |
2289 | ||
2290 | tem = internal_condition_case_2 (Fdelete_file, filename, Qnil, | |
2291 | Qt, internal_delete_file_1); | |
2292 | return NILP (tem); | |
385b6cc7 RS |
2293 | } |
2294 | \f | |
570d7624 | 2295 | DEFUN ("rename-file", Frename_file, Srename_file, 2, 3, |
7c0f6118 | 2296 | "fRename file: \nGRename %s to file: \np", |
a4e03fe5 | 2297 | doc: /* Rename FILE as NEWNAME. Both args must be strings. |
8c1a1077 PJ |
2298 | If file has names other than FILE, it continues to have those names. |
2299 | Signals a `file-already-exists' error if a file NEWNAME already exists | |
2300 | unless optional third argument OK-IF-ALREADY-EXISTS is non-nil. | |
2301 | A number as third arg means request confirmation if NEWNAME already exists. | |
2302 | This is what happens in interactive use with M-x. */) | |
5842a27b | 2303 | (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists) |
570d7624 | 2304 | { |
32f4334d | 2305 | Lisp_Object handler; |
f72b5416 JD |
2306 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
2307 | Lisp_Object encoded_file, encoded_newname, symlink_target; | |
570d7624 | 2308 | |
f72b5416 JD |
2309 | symlink_target = encoded_file = encoded_newname = Qnil; |
2310 | GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target); | |
b7826503 PJ |
2311 | CHECK_STRING (file); |
2312 | CHECK_STRING (newname); | |
3b7f6e60 | 2313 | file = Fexpand_file_name (file, Qnil); |
1ffc5c90 | 2314 | |
f83caf70 EZ |
2315 | if ((!NILP (Ffile_directory_p (newname))) |
2316 | #ifdef DOS_NT | |
2317 | /* If the file names are identical but for the case, | |
2318 | don't attempt to move directory to itself. */ | |
2319 | && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname)))) | |
2320 | #endif | |
2321 | ) | |
8719abec | 2322 | { |
ce2fe65a AS |
2323 | Lisp_Object fname = (NILP (Ffile_directory_p (file)) |
2324 | ? file : Fdirectory_file_name (file)); | |
8719abec CY |
2325 | newname = Fexpand_file_name (Ffile_name_nondirectory (fname), newname); |
2326 | } | |
1ffc5c90 RS |
2327 | else |
2328 | newname = Fexpand_file_name (newname, Qnil); | |
32f4334d RS |
2329 | |
2330 | /* If the file name has special constructs in it, | |
2331 | call the corresponding file handler. */ | |
3b7f6e60 | 2332 | handler = Ffind_file_name_handler (file, Qrename_file); |
51cf6d37 | 2333 | if (NILP (handler)) |
49307295 | 2334 | handler = Ffind_file_name_handler (newname, Qrename_file); |
32f4334d | 2335 | if (!NILP (handler)) |
2bfa3d3e | 2336 | return call4 (handler, Qrename_file, file, newname, ok_if_already_exists); |
32f4334d | 2337 | |
b1d1b865 RS |
2338 | encoded_file = ENCODE_FILE (file); |
2339 | encoded_newname = ENCODE_FILE (newname); | |
2340 | ||
bc77278f EZ |
2341 | #ifdef DOS_NT |
2342 | /* If the file names are identical but for the case, don't ask for | |
2343 | confirmation: they simply want to change the letter-case of the | |
2344 | file name. */ | |
2345 | if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname)))) | |
2346 | #endif | |
265a9e55 | 2347 | if (NILP (ok_if_already_exists) |
93c30b5f | 2348 | || INTEGERP (ok_if_already_exists)) |
a560b856 PE |
2349 | barf_or_query_if_file_exists (newname, false, "rename to it", |
2350 | INTEGERP (ok_if_already_exists), false); | |
ce2fe65a | 2351 | if (rename (SSDATA (encoded_file), SSDATA (encoded_newname)) < 0) |
570d7624 | 2352 | { |
b648c163 PE |
2353 | int rename_errno = errno; |
2354 | if (rename_errno == EXDEV) | |
570d7624 | 2355 | { |
d311d28c | 2356 | ptrdiff_t count; |
f72b5416 | 2357 | symlink_target = Ffile_symlink_p (file); |
440c7d00 JD |
2358 | if (! NILP (symlink_target)) |
2359 | Fmake_symbolic_link (symlink_target, newname, | |
f59abab9 | 2360 | NILP (ok_if_already_exists) ? Qnil : Qt); |
ae0d7250 | 2361 | else if (!NILP (Ffile_directory_p (file))) |
8719abec CY |
2362 | call4 (Qcopy_directory, file, newname, Qt, Qnil); |
2363 | else | |
2364 | /* We have already prompted if it was an integer, so don't | |
2365 | have copy-file prompt again. */ | |
586702ce | 2366 | Fcopy_file (file, newname, |
586702ce | 2367 | NILP (ok_if_already_exists) ? Qnil : Qt, |
574c05e2 | 2368 | Qt, Qt, Qt); |
d550c425 | 2369 | |
2bfa3d3e | 2370 | dynwind_begin (); |
d2b66acf | 2371 | specbind (Qdelete_by_moving_to_trash, Qnil); |
8fab2362 | 2372 | |
ae0d7250 | 2373 | if (!NILP (Ffile_directory_p (file)) && NILP (symlink_target)) |
8719abec CY |
2374 | call2 (Qdelete_directory, file, Qt); |
2375 | else | |
f1a5d776 | 2376 | Fdelete_file (file, Qnil); |
2bfa3d3e | 2377 | dynwind_end (); |
570d7624 JB |
2378 | } |
2379 | else | |
b648c163 | 2380 | report_file_errno ("Renaming", list2 (file, newname), rename_errno); |
570d7624 JB |
2381 | } |
2382 | UNGCPRO; | |
2383 | return Qnil; | |
2384 | } | |
2385 | ||
2386 | DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3, | |
7c0f6118 | 2387 | "fAdd name to file: \nGName to add to %s: \np", |
a4e03fe5 | 2388 | doc: /* Give FILE additional name NEWNAME. Both args must be strings. |
8c1a1077 PJ |
2389 | Signals a `file-already-exists' error if a file NEWNAME already exists |
2390 | unless optional third argument OK-IF-ALREADY-EXISTS is non-nil. | |
2391 | A number as third arg means request confirmation if NEWNAME already exists. | |
2392 | This is what happens in interactive use with M-x. */) | |
5842a27b | 2393 | (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists) |
570d7624 | 2394 | { |
32f4334d | 2395 | Lisp_Object handler; |
b1d1b865 RS |
2396 | Lisp_Object encoded_file, encoded_newname; |
2397 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
570d7624 | 2398 | |
b1d1b865 RS |
2399 | GCPRO4 (file, newname, encoded_file, encoded_newname); |
2400 | encoded_file = encoded_newname = Qnil; | |
b7826503 PJ |
2401 | CHECK_STRING (file); |
2402 | CHECK_STRING (newname); | |
3b7f6e60 | 2403 | file = Fexpand_file_name (file, Qnil); |
1ffc5c90 RS |
2404 | |
2405 | if (!NILP (Ffile_directory_p (newname))) | |
2406 | newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname); | |
2407 | else | |
2408 | newname = Fexpand_file_name (newname, Qnil); | |
32f4334d RS |
2409 | |
2410 | /* If the file name has special constructs in it, | |
2411 | call the corresponding file handler. */ | |
3b7f6e60 | 2412 | handler = Ffind_file_name_handler (file, Qadd_name_to_file); |
32f4334d | 2413 | if (!NILP (handler)) |
2bfa3d3e | 2414 | return call4 (handler, Qadd_name_to_file, file, newname, ok_if_already_exists); |
32f4334d | 2415 | |
adc6741c RS |
2416 | /* If the new name has special constructs in it, |
2417 | call the corresponding file handler. */ | |
2418 | handler = Ffind_file_name_handler (newname, Qadd_name_to_file); | |
2419 | if (!NILP (handler)) | |
2bfa3d3e | 2420 | return call4 (handler, Qadd_name_to_file, file, newname, ok_if_already_exists); |
adc6741c | 2421 | |
b1d1b865 RS |
2422 | encoded_file = ENCODE_FILE (file); |
2423 | encoded_newname = ENCODE_FILE (newname); | |
2424 | ||
265a9e55 | 2425 | if (NILP (ok_if_already_exists) |
93c30b5f | 2426 | || INTEGERP (ok_if_already_exists)) |
a560b856 PE |
2427 | barf_or_query_if_file_exists (newname, false, "make it a new name", |
2428 | INTEGERP (ok_if_already_exists), false); | |
5e570b75 | 2429 | |
42a5b22f | 2430 | unlink (SSDATA (newname)); |
ce2fe65a | 2431 | if (link (SSDATA (encoded_file), SSDATA (encoded_newname)) < 0) |
b648c163 PE |
2432 | { |
2433 | int link_errno = errno; | |
2434 | report_file_errno ("Adding new name", list2 (file, newname), link_errno); | |
2435 | } | |
570d7624 JB |
2436 | |
2437 | UNGCPRO; | |
2438 | return Qnil; | |
2439 | } | |
2440 | ||
570d7624 | 2441 | DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3, |
7c0f6118 | 2442 | "FMake symbolic link to file: \nGMake symbolic link to file %s: \np", |
68780e2a RS |
2443 | doc: /* Make a symbolic link to FILENAME, named LINKNAME. |
2444 | Both args must be strings. | |
8c1a1077 PJ |
2445 | Signals a `file-already-exists' error if a file LINKNAME already exists |
2446 | unless optional third argument OK-IF-ALREADY-EXISTS is non-nil. | |
2447 | A number as third arg means request confirmation if LINKNAME already exists. | |
2448 | This happens for interactive use with M-x. */) | |
5842a27b | 2449 | (Lisp_Object filename, Lisp_Object linkname, Lisp_Object ok_if_already_exists) |
570d7624 | 2450 | { |
32f4334d | 2451 | Lisp_Object handler; |
b1d1b865 RS |
2452 | Lisp_Object encoded_filename, encoded_linkname; |
2453 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
570d7624 | 2454 | |
b1d1b865 RS |
2455 | GCPRO4 (filename, linkname, encoded_filename, encoded_linkname); |
2456 | encoded_filename = encoded_linkname = Qnil; | |
b7826503 PJ |
2457 | CHECK_STRING (filename); |
2458 | CHECK_STRING (linkname); | |
d9bc1c99 RS |
2459 | /* If the link target has a ~, we must expand it to get |
2460 | a truly valid file name. Otherwise, do not expand; | |
2461 | we want to permit links to relative file names. */ | |
d5db4077 | 2462 | if (SREF (filename, 0) == '~') |
d9bc1c99 | 2463 | filename = Fexpand_file_name (filename, Qnil); |
1ffc5c90 RS |
2464 | |
2465 | if (!NILP (Ffile_directory_p (linkname))) | |
dac24db4 | 2466 | linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname); |
1ffc5c90 RS |
2467 | else |
2468 | linkname = Fexpand_file_name (linkname, Qnil); | |
32f4334d RS |
2469 | |
2470 | /* If the file name has special constructs in it, | |
2471 | call the corresponding file handler. */ | |
49307295 | 2472 | handler = Ffind_file_name_handler (filename, Qmake_symbolic_link); |
32f4334d | 2473 | if (!NILP (handler)) |
2bfa3d3e | 2474 | return call4 (handler, Qmake_symbolic_link, filename, linkname, ok_if_already_exists); |
32f4334d | 2475 | |
adc6741c RS |
2476 | /* If the new link name has special constructs in it, |
2477 | call the corresponding file handler. */ | |
2478 | handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link); | |
2479 | if (!NILP (handler)) | |
2bfa3d3e | 2480 | return call4 (handler, Qmake_symbolic_link, filename, linkname, ok_if_already_exists); |
adc6741c | 2481 | |
b1d1b865 RS |
2482 | encoded_filename = ENCODE_FILE (filename); |
2483 | encoded_linkname = ENCODE_FILE (linkname); | |
2484 | ||
265a9e55 | 2485 | if (NILP (ok_if_already_exists) |
93c30b5f | 2486 | || INTEGERP (ok_if_already_exists)) |
a560b856 PE |
2487 | barf_or_query_if_file_exists (linkname, false, "make it a link", |
2488 | INTEGERP (ok_if_already_exists), false); | |
ce2fe65a | 2489 | if (symlink (SSDATA (encoded_filename), SSDATA (encoded_linkname)) < 0) |
570d7624 JB |
2490 | { |
2491 | /* If we didn't complain already, silently delete existing file. */ | |
b648c163 | 2492 | int symlink_errno; |
570d7624 JB |
2493 | if (errno == EEXIST) |
2494 | { | |
42a5b22f | 2495 | unlink (SSDATA (encoded_linkname)); |
ce2fe65a AS |
2496 | if (symlink (SSDATA (encoded_filename), SSDATA (encoded_linkname)) |
2497 | >= 0) | |
1a04498e KH |
2498 | { |
2499 | UNGCPRO; | |
2500 | return Qnil; | |
2501 | } | |
570d7624 | 2502 | } |
d9d0d182 PE |
2503 | if (errno == ENOSYS) |
2504 | { | |
2505 | UNGCPRO; | |
2506 | xsignal1 (Qfile_error, | |
2507 | build_string ("Symbolic links are not supported")); | |
2508 | } | |
570d7624 | 2509 | |
b648c163 PE |
2510 | symlink_errno = errno; |
2511 | report_file_errno ("Making symbolic link", list2 (filename, linkname), | |
2512 | symlink_errno); | |
570d7624 JB |
2513 | } |
2514 | UNGCPRO; | |
2515 | return Qnil; | |
e89b536d | 2516 | } |
570d7624 | 2517 | |
570d7624 | 2518 | \f |
a7ca3326 | 2519 | DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p, |
570d7624 | 2520 | 1, 1, 0, |
8c1a1077 PJ |
2521 | doc: /* Return t if file FILENAME specifies an absolute file name. |
2522 | On Unix, this is a name starting with a `/' or a `~'. */) | |
5842a27b | 2523 | (Lisp_Object filename) |
570d7624 | 2524 | { |
b7826503 | 2525 | CHECK_STRING (filename); |
5976c3fe | 2526 | return file_name_absolute_p (SSDATA (filename)) ? Qt : Qnil; |
570d7624 | 2527 | } |
3beeedfe | 2528 | \f |
a7ca3326 | 2529 | DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0, |
68780e2a RS |
2530 | doc: /* Return t if file FILENAME exists (whether or not you can read it.) |
2531 | See also `file-readable-p' and `file-attributes'. | |
2532 | This returns nil for a symlink to a nonexistent file. | |
2533 | Use `file-symlink-p' to test for such links. */) | |
5842a27b | 2534 | (Lisp_Object filename) |
570d7624 | 2535 | { |
199607e4 | 2536 | Lisp_Object absname; |
32f4334d | 2537 | Lisp_Object handler; |
570d7624 | 2538 | |
b7826503 | 2539 | CHECK_STRING (filename); |
199607e4 | 2540 | absname = Fexpand_file_name (filename, Qnil); |
32f4334d RS |
2541 | |
2542 | /* If the file name has special constructs in it, | |
2543 | call the corresponding file handler. */ | |
199607e4 | 2544 | handler = Ffind_file_name_handler (absname, Qfile_exists_p); |
32f4334d | 2545 | if (!NILP (handler)) |
a773ed9a PE |
2546 | { |
2547 | Lisp_Object result = call2 (handler, Qfile_exists_p, absname); | |
2548 | errno = 0; | |
2549 | return result; | |
2550 | } | |
32f4334d | 2551 | |
b1d1b865 RS |
2552 | absname = ENCODE_FILE (absname); |
2553 | ||
3d798ba7 | 2554 | return check_existing (SSDATA (absname)) ? Qt : Qnil; |
570d7624 JB |
2555 | } |
2556 | ||
2557 | DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0, | |
8c1a1077 | 2558 | doc: /* Return t if FILENAME can be executed by you. |
970fd401 GM |
2559 | For a directory, this means you can access files in that directory. |
2560 | \(It is generally better to use `file-accessible-directory-p' for that | |
2561 | purpose, though.) */) | |
5842a27b | 2562 | (Lisp_Object filename) |
570d7624 | 2563 | { |
199607e4 | 2564 | Lisp_Object absname; |
32f4334d | 2565 | Lisp_Object handler; |
570d7624 | 2566 | |
b7826503 | 2567 | CHECK_STRING (filename); |
199607e4 | 2568 | absname = Fexpand_file_name (filename, Qnil); |
32f4334d RS |
2569 | |
2570 | /* If the file name has special constructs in it, | |
2571 | call the corresponding file handler. */ | |
199607e4 | 2572 | handler = Ffind_file_name_handler (absname, Qfile_executable_p); |
32f4334d | 2573 | if (!NILP (handler)) |
199607e4 | 2574 | return call2 (handler, Qfile_executable_p, absname); |
32f4334d | 2575 | |
b1d1b865 RS |
2576 | absname = ENCODE_FILE (absname); |
2577 | ||
42a5b22f | 2578 | return (check_executable (SSDATA (absname)) ? Qt : Qnil); |
570d7624 JB |
2579 | } |
2580 | ||
a7ca3326 | 2581 | DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0, |
8c1a1077 PJ |
2582 | doc: /* Return t if file FILENAME exists and you can read it. |
2583 | See also `file-exists-p' and `file-attributes'. */) | |
5842a27b | 2584 | (Lisp_Object filename) |
570d7624 | 2585 | { |
199607e4 | 2586 | Lisp_Object absname; |
32f4334d | 2587 | Lisp_Object handler; |
570d7624 | 2588 | |
b7826503 | 2589 | CHECK_STRING (filename); |
199607e4 | 2590 | absname = Fexpand_file_name (filename, Qnil); |
32f4334d RS |
2591 | |
2592 | /* If the file name has special constructs in it, | |
2593 | call the corresponding file handler. */ | |
199607e4 | 2594 | handler = Ffind_file_name_handler (absname, Qfile_readable_p); |
32f4334d | 2595 | if (!NILP (handler)) |
199607e4 | 2596 | return call2 (handler, Qfile_readable_p, absname); |
32f4334d | 2597 | |
b1d1b865 | 2598 | absname = ENCODE_FILE (absname); |
73dcdb9f PE |
2599 | return (faccessat (AT_FDCWD, SSDATA (absname), R_OK, AT_EACCESS) == 0 |
2600 | ? Qt : Qnil); | |
570d7624 JB |
2601 | } |
2602 | ||
f793dc6c | 2603 | DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0, |
8c1a1077 | 2604 | doc: /* Return t if file FILENAME can be written or created by you. */) |
5842a27b | 2605 | (Lisp_Object filename) |
f793dc6c | 2606 | { |
b1d1b865 | 2607 | Lisp_Object absname, dir, encoded; |
f793dc6c | 2608 | Lisp_Object handler; |
f793dc6c | 2609 | |
b7826503 | 2610 | CHECK_STRING (filename); |
199607e4 | 2611 | absname = Fexpand_file_name (filename, Qnil); |
f793dc6c RS |
2612 | |
2613 | /* If the file name has special constructs in it, | |
2614 | call the corresponding file handler. */ | |
199607e4 | 2615 | handler = Ffind_file_name_handler (absname, Qfile_writable_p); |
f793dc6c | 2616 | if (!NILP (handler)) |
199607e4 | 2617 | return call2 (handler, Qfile_writable_p, absname); |
f793dc6c | 2618 | |
b1d1b865 | 2619 | encoded = ENCODE_FILE (absname); |
73dcdb9f PE |
2620 | if (check_writable (SSDATA (encoded), W_OK)) |
2621 | return Qt; | |
2622 | if (errno != ENOENT) | |
2623 | return Qnil; | |
b1d1b865 | 2624 | |
199607e4 | 2625 | dir = Ffile_name_directory (absname); |
73dcdb9f | 2626 | eassert (!NILP (dir)); |
f793dc6c | 2627 | #ifdef MSDOS |
73dcdb9f | 2628 | dir = Fdirectory_file_name (dir); |
f793dc6c | 2629 | #endif /* MSDOS */ |
b1d1b865 RS |
2630 | |
2631 | dir = ENCODE_FILE (dir); | |
e3e8a75a GM |
2632 | #ifdef WINDOWSNT |
2633 | /* The read-only attribute of the parent directory doesn't affect | |
2634 | whether a file or directory can be created within it. Some day we | |
2635 | should check ACLs though, which do affect this. */ | |
73dcdb9f | 2636 | return file_directory_p (SDATA (dir)) ? Qt : Qnil; |
e3e8a75a | 2637 | #else |
73dcdb9f | 2638 | return check_writable (SSDATA (dir), W_OK | X_OK) ? Qt : Qnil; |
e3e8a75a | 2639 | #endif |
f793dc6c RS |
2640 | } |
2641 | \f | |
1f8653eb | 2642 | DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0, |
8c1a1077 PJ |
2643 | doc: /* Access file FILENAME, and get an error if that does not work. |
2644 | The second argument STRING is used in the error message. | |
a4e03fe5 | 2645 | If there is no error, returns nil. */) |
5842a27b | 2646 | (Lisp_Object filename, Lisp_Object string) |
1f8653eb | 2647 | { |
49475635 | 2648 | Lisp_Object handler, encoded_filename, absname; |
1f8653eb | 2649 | |
b7826503 | 2650 | CHECK_STRING (filename); |
49475635 EZ |
2651 | absname = Fexpand_file_name (filename, Qnil); |
2652 | ||
b7826503 | 2653 | CHECK_STRING (string); |
1f8653eb RS |
2654 | |
2655 | /* If the file name has special constructs in it, | |
2656 | call the corresponding file handler. */ | |
49475635 | 2657 | handler = Ffind_file_name_handler (absname, Qaccess_file); |
1f8653eb | 2658 | if (!NILP (handler)) |
49475635 | 2659 | return call3 (handler, Qaccess_file, absname, string); |
1f8653eb | 2660 | |
49475635 | 2661 | encoded_filename = ENCODE_FILE (absname); |
b1d1b865 | 2662 | |
a773ed9a | 2663 | if (faccessat (AT_FDCWD, SSDATA (encoded_filename), R_OK, AT_EACCESS) != 0) |
a9757f6a | 2664 | report_file_error (SSDATA (string), filename); |
1f8653eb RS |
2665 | |
2666 | return Qnil; | |
2667 | } | |
2668 | \f | |
8654f9d7 PE |
2669 | /* Relative to directory FD, return the symbolic link value of FILENAME. |
2670 | On failure, return nil. */ | |
2671 | Lisp_Object | |
2672 | emacs_readlinkat (int fd, char const *filename) | |
2673 | { | |
2674 | static struct allocator const emacs_norealloc_allocator = | |
2675 | { xmalloc, NULL, xfree, memory_full }; | |
2676 | Lisp_Object val; | |
2677 | char readlink_buf[1024]; | |
2678 | char *buf = careadlinkat (fd, filename, readlink_buf, sizeof readlink_buf, | |
2679 | &emacs_norealloc_allocator, readlinkat); | |
2680 | if (!buf) | |
2681 | return Qnil; | |
2682 | ||
eeccd06f | 2683 | val = build_unibyte_string (buf); |
8654f9d7 | 2684 | if (buf[0] == '/' && strchr (buf, ':')) |
eeccd06f | 2685 | val = concat2 (build_unibyte_string ("/:"), val); |
8654f9d7 PE |
2686 | if (buf != readlink_buf) |
2687 | xfree (buf); | |
2688 | val = DECODE_FILE (val); | |
2689 | return val; | |
2690 | } | |
2691 | ||
a7ca3326 | 2692 | DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0, |
8c1a1077 | 2693 | doc: /* Return non-nil if file FILENAME is the name of a symbolic link. |
1c353c74 | 2694 | The value is the link target, as a string. |
68780e2a RS |
2695 | Otherwise it returns nil. |
2696 | ||
33f0ba7e | 2697 | This function does not check whether the link target exists. */) |
5842a27b | 2698 | (Lisp_Object filename) |
570d7624 | 2699 | { |
32f4334d | 2700 | Lisp_Object handler; |
570d7624 | 2701 | |
b7826503 | 2702 | CHECK_STRING (filename); |
570d7624 JB |
2703 | filename = Fexpand_file_name (filename, Qnil); |
2704 | ||
32f4334d RS |
2705 | /* If the file name has special constructs in it, |
2706 | call the corresponding file handler. */ | |
49307295 | 2707 | handler = Ffind_file_name_handler (filename, Qfile_symlink_p); |
32f4334d RS |
2708 | if (!NILP (handler)) |
2709 | return call2 (handler, Qfile_symlink_p, filename); | |
2710 | ||
b1d1b865 RS |
2711 | filename = ENCODE_FILE (filename); |
2712 | ||
8654f9d7 | 2713 | return emacs_readlinkat (AT_FDCWD, SSDATA (filename)); |
570d7624 JB |
2714 | } |
2715 | ||
a7ca3326 | 2716 | DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0, |
8c1a1077 PJ |
2717 | doc: /* Return t if FILENAME names an existing directory. |
2718 | Symbolic links to directories count as directories. | |
2719 | See `file-symlink-p' to distinguish symlinks. */) | |
5842a27b | 2720 | (Lisp_Object filename) |
570d7624 | 2721 | { |
73dcdb9f | 2722 | Lisp_Object absname; |
32f4334d | 2723 | Lisp_Object handler; |
570d7624 | 2724 | |
4b4deea2 | 2725 | absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory)); |
570d7624 | 2726 | |
32f4334d RS |
2727 | /* If the file name has special constructs in it, |
2728 | call the corresponding file handler. */ | |
199607e4 | 2729 | handler = Ffind_file_name_handler (absname, Qfile_directory_p); |
32f4334d | 2730 | if (!NILP (handler)) |
199607e4 | 2731 | return call2 (handler, Qfile_directory_p, absname); |
32f4334d | 2732 | |
b1d1b865 RS |
2733 | absname = ENCODE_FILE (absname); |
2734 | ||
73dcdb9f PE |
2735 | return file_directory_p (SSDATA (absname)) ? Qt : Qnil; |
2736 | } | |
2737 | ||
2738 | /* Return true if FILE is a directory or a symlink to a directory. */ | |
2739 | bool | |
2740 | file_directory_p (char const *file) | |
2741 | { | |
2742 | #ifdef WINDOWSNT | |
2743 | /* This is cheaper than 'stat'. */ | |
2744 | return faccessat (AT_FDCWD, file, D_OK, AT_EACCESS) == 0; | |
2745 | #else | |
2746 | struct stat st; | |
2747 | return stat (file, &st) == 0 && S_ISDIR (st.st_mode); | |
2748 | #endif | |
570d7624 JB |
2749 | } |
2750 | ||
a7ca3326 | 2751 | DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, |
16a97296 | 2752 | Sfile_accessible_directory_p, 1, 1, 0, |
e385ec41 RS |
2753 | doc: /* Return t if file FILENAME names a directory you can open. |
2754 | For the value to be t, FILENAME must specify the name of a directory as a file, | |
2755 | and the directory must allow you to open files in it. In order to use a | |
8c1a1077 PJ |
2756 | directory as a buffer's current directory, this predicate must return true. |
2757 | A directory name spec may be given instead; then the value is t | |
2758 | if the directory so specified exists and really is a readable and | |
2759 | searchable directory. */) | |
5842a27b | 2760 | (Lisp_Object filename) |
b72dea2a | 2761 | { |
73dcdb9f | 2762 | Lisp_Object absname; |
32f4334d | 2763 | Lisp_Object handler; |
73dcdb9f PE |
2764 | |
2765 | CHECK_STRING (filename); | |
2766 | absname = Fexpand_file_name (filename, Qnil); | |
32f4334d RS |
2767 | |
2768 | /* If the file name has special constructs in it, | |
2769 | call the corresponding file handler. */ | |
73dcdb9f | 2770 | handler = Ffind_file_name_handler (absname, Qfile_accessible_directory_p); |
32f4334d | 2771 | if (!NILP (handler)) |
a773ed9a PE |
2772 | { |
2773 | Lisp_Object r = call2 (handler, Qfile_accessible_directory_p, absname); | |
2774 | errno = 0; | |
2775 | return r; | |
2776 | } | |
32f4334d | 2777 | |
73dcdb9f PE |
2778 | absname = ENCODE_FILE (absname); |
2779 | return file_accessible_directory_p (SSDATA (absname)) ? Qt : Qnil; | |
2780 | } | |
2781 | ||
2782 | /* If FILE is a searchable directory or a symlink to a | |
2783 | searchable directory, return true. Otherwise return | |
2784 | false and set errno to an error number. */ | |
2785 | bool | |
2786 | file_accessible_directory_p (char const *file) | |
2787 | { | |
2788 | #ifdef DOS_NT | |
2789 | /* There's no need to test whether FILE is searchable, as the | |
2790 | searchable/executable bit is invented on DOS_NT platforms. */ | |
2791 | return file_directory_p (file); | |
2792 | #else | |
2793 | /* On POSIXish platforms, use just one system call; this avoids a | |
2794 | race and is typically faster. */ | |
2795 | ptrdiff_t len = strlen (file); | |
2796 | char const *dir; | |
2797 | bool ok; | |
2798 | int saved_errno; | |
2799 | USE_SAFE_ALLOCA; | |
2800 | ||
2801 | /* Normally a file "FOO" is an accessible directory if "FOO/." exists. | |
2802 | There are three exceptions: "", "/", and "//". Leave "" alone, | |
2803 | as it's invalid. Append only "." to the other two exceptions as | |
2804 | "/" and "//" are distinct on some platforms, whereas "/", "///", | |
2805 | "////", etc. are all equivalent. */ | |
2806 | if (! len) | |
2807 | dir = file; | |
2808 | else | |
2809 | { | |
2810 | /* Just check for trailing '/' when deciding whether to append '/'. | |
2811 | That's simpler than testing the two special cases "/" and "//", | |
2812 | and it's a safe optimization here. */ | |
2813 | char *buf = SAFE_ALLOCA (len + 3); | |
2814 | memcpy (buf, file, len); | |
31ff141c | 2815 | strcpy (buf + len, &"/."[file[len - 1] == '/']); |
73dcdb9f PE |
2816 | dir = buf; |
2817 | } | |
2818 | ||
2819 | ok = check_existing (dir); | |
2820 | saved_errno = errno; | |
2821 | SAFE_FREE (); | |
2822 | errno = saved_errno; | |
2823 | return ok; | |
2824 | #endif | |
b72dea2a JB |
2825 | } |
2826 | ||
f793dc6c | 2827 | DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0, |
19a9c3b7 LH |
2828 | doc: /* Return t if FILENAME names a regular file. |
2829 | This is the sort of file that holds an ordinary stream of data bytes. | |
2830 | Symbolic links to regular files count as regular files. | |
2831 | See `file-symlink-p' to distinguish symlinks. */) | |
5842a27b | 2832 | (Lisp_Object filename) |
f793dc6c | 2833 | { |
199607e4 | 2834 | register Lisp_Object absname; |
f793dc6c RS |
2835 | struct stat st; |
2836 | Lisp_Object handler; | |
2837 | ||
4b4deea2 | 2838 | absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory)); |
f793dc6c RS |
2839 | |
2840 | /* If the file name has special constructs in it, | |
2841 | call the corresponding file handler. */ | |
199607e4 | 2842 | handler = Ffind_file_name_handler (absname, Qfile_regular_p); |
f793dc6c | 2843 | if (!NILP (handler)) |
199607e4 | 2844 | return call2 (handler, Qfile_regular_p, absname); |
f793dc6c | 2845 | |
b1d1b865 RS |
2846 | absname = ENCODE_FILE (absname); |
2847 | ||
c1c4693e RS |
2848 | #ifdef WINDOWSNT |
2849 | { | |
2850 | int result; | |
2851 | Lisp_Object tem = Vw32_get_true_file_attributes; | |
2852 | ||
2853 | /* Tell stat to use expensive method to get accurate info. */ | |
2854 | Vw32_get_true_file_attributes = Qt; | |
d5db4077 | 2855 | result = stat (SDATA (absname), &st); |
c1c4693e RS |
2856 | Vw32_get_true_file_attributes = tem; |
2857 | ||
2858 | if (result < 0) | |
2859 | return Qnil; | |
f68c809d | 2860 | return S_ISREG (st.st_mode) ? Qt : Qnil; |
c1c4693e RS |
2861 | } |
2862 | #else | |
42a5b22f | 2863 | if (stat (SSDATA (absname), &st) < 0) |
f793dc6c | 2864 | return Qnil; |
f68c809d | 2865 | return S_ISREG (st.st_mode) ? Qt : Qnil; |
c1c4693e | 2866 | #endif |
f793dc6c RS |
2867 | } |
2868 | \f | |
574c05e2 KK |
2869 | DEFUN ("file-selinux-context", Ffile_selinux_context, |
2870 | Sfile_selinux_context, 1, 1, 0, | |
fa74b241 CY |
2871 | doc: /* Return SELinux context of file named FILENAME. |
2872 | The return value is a list (USER ROLE TYPE RANGE), where the list | |
2873 | elements are strings naming the user, role, type, and range of the | |
2874 | file's SELinux security context. | |
2875 | ||
2876 | Return (nil nil nil nil) if the file is nonexistent or inaccessible, | |
2877 | or if SELinux is disabled, or if Emacs lacks SELinux support. */) | |
5842a27b | 2878 | (Lisp_Object filename) |
574c05e2 KK |
2879 | { |
2880 | Lisp_Object absname; | |
2881 | Lisp_Object values[4]; | |
2882 | Lisp_Object handler; | |
2883 | #if HAVE_LIBSELINUX | |
2884 | security_context_t con; | |
2885 | int conlength; | |
2886 | context_t context; | |
2887 | #endif | |
2888 | ||
4b4deea2 | 2889 | absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory)); |
574c05e2 KK |
2890 | |
2891 | /* If the file name has special constructs in it, | |
2892 | call the corresponding file handler. */ | |
2893 | handler = Ffind_file_name_handler (absname, Qfile_selinux_context); | |
2894 | if (!NILP (handler)) | |
2895 | return call2 (handler, Qfile_selinux_context, absname); | |
2896 | ||
2897 | absname = ENCODE_FILE (absname); | |
2898 | ||
2899 | values[0] = Qnil; | |
2900 | values[1] = Qnil; | |
2901 | values[2] = Qnil; | |
2902 | values[3] = Qnil; | |
2903 | #if HAVE_LIBSELINUX | |
2904 | if (is_selinux_enabled ()) | |
2905 | { | |
b14aac08 | 2906 | conlength = lgetfilecon (SSDATA (absname), &con); |
574c05e2 KK |
2907 | if (conlength > 0) |
2908 | { | |
2909 | context = context_new (con); | |
45841e65 KK |
2910 | if (context_user_get (context)) |
2911 | values[0] = build_string (context_user_get (context)); | |
2912 | if (context_role_get (context)) | |
2913 | values[1] = build_string (context_role_get (context)); | |
2914 | if (context_type_get (context)) | |
2915 | values[2] = build_string (context_type_get (context)); | |
2916 | if (context_range_get (context)) | |
2917 | values[3] = build_string (context_range_get (context)); | |
574c05e2 | 2918 | context_free (context); |
c6ba4138 | 2919 | freecon (con); |
574c05e2 | 2920 | } |
574c05e2 KK |
2921 | } |
2922 | #endif | |
2923 | ||
c72d972c | 2924 | return Flist (ARRAYELTS (values), values); |
574c05e2 KK |
2925 | } |
2926 | \f | |
2927 | DEFUN ("set-file-selinux-context", Fset_file_selinux_context, | |
2928 | Sset_file_selinux_context, 2, 2, 0, | |
fa74b241 CY |
2929 | doc: /* Set SELinux context of file named FILENAME to CONTEXT. |
2930 | CONTEXT should be a list (USER ROLE TYPE RANGE), where the list | |
2931 | elements are strings naming the components of a SELinux context. | |
2932 | ||
ccad023b EZ |
2933 | Value is t if setting of SELinux context was successful, nil otherwise. |
2934 | ||
2935 | This function does nothing and returns nil if SELinux is disabled, | |
2936 | or if Emacs was not compiled with SELinux support. */) | |
5842a27b | 2937 | (Lisp_Object filename, Lisp_Object context) |
574c05e2 | 2938 | { |
0f4a96b5 | 2939 | Lisp_Object absname; |
574c05e2 | 2940 | Lisp_Object handler; |
0f4a96b5 JB |
2941 | #if HAVE_LIBSELINUX |
2942 | Lisp_Object encoded_absname; | |
574c05e2 KK |
2943 | Lisp_Object user = CAR_SAFE (context); |
2944 | Lisp_Object role = CAR_SAFE (CDR_SAFE (context)); | |
2945 | Lisp_Object type = CAR_SAFE (CDR_SAFE (CDR_SAFE (context))); | |
2946 | Lisp_Object range = CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context)))); | |
574c05e2 | 2947 | security_context_t con; |
f75d7a91 PE |
2948 | bool fail; |
2949 | int conlength; | |
574c05e2 KK |
2950 | context_t parsed_con; |
2951 | #endif | |
2952 | ||
4b4deea2 | 2953 | absname = Fexpand_file_name (filename, BVAR (current_buffer, directory)); |
574c05e2 KK |
2954 | |
2955 | /* If the file name has special constructs in it, | |
2956 | call the corresponding file handler. */ | |
2957 | handler = Ffind_file_name_handler (absname, Qset_file_selinux_context); | |
2958 | if (!NILP (handler)) | |
2959 | return call3 (handler, Qset_file_selinux_context, absname, context); | |
2960 | ||
0f4a96b5 | 2961 | #if HAVE_LIBSELINUX |
574c05e2 KK |
2962 | if (is_selinux_enabled ()) |
2963 | { | |
2964 | /* Get current file context. */ | |
a9b53ad3 | 2965 | encoded_absname = ENCODE_FILE (absname); |
b14aac08 | 2966 | conlength = lgetfilecon (SSDATA (encoded_absname), &con); |
574c05e2 KK |
2967 | if (conlength > 0) |
2968 | { | |
2969 | parsed_con = context_new (con); | |
2970 | /* Change the parts defined in the parameter.*/ | |
2971 | if (STRINGP (user)) | |
2972 | { | |
b14aac08 | 2973 | if (context_user_set (parsed_con, SSDATA (user))) |
574c05e2 KK |
2974 | error ("Doing context_user_set"); |
2975 | } | |
2976 | if (STRINGP (role)) | |
2977 | { | |
b14aac08 | 2978 | if (context_role_set (parsed_con, SSDATA (role))) |
574c05e2 KK |
2979 | error ("Doing context_role_set"); |
2980 | } | |
2981 | if (STRINGP (type)) | |
2982 | { | |
b14aac08 | 2983 | if (context_type_set (parsed_con, SSDATA (type))) |
574c05e2 KK |
2984 | error ("Doing context_type_set"); |
2985 | } | |
2986 | if (STRINGP (range)) | |
2987 | { | |
b14aac08 | 2988 | if (context_range_set (parsed_con, SSDATA (range))) |
574c05e2 KK |
2989 | error ("Doing context_range_set"); |
2990 | } | |
2991 | ||
24c51a09 | 2992 | /* Set the modified context back to the file. */ |
f75d7a91 PE |
2993 | fail = (lsetfilecon (SSDATA (encoded_absname), |
2994 | context_str (parsed_con)) | |
2995 | != 0); | |
24c51a09 GM |
2996 | /* See http://debbugs.gnu.org/11245 for ENOTSUP. */ |
2997 | if (fail && errno != ENOTSUP) | |
a9757f6a | 2998 | report_file_error ("Doing lsetfilecon", absname); |
574c05e2 KK |
2999 | |
3000 | context_free (parsed_con); | |
c6ba4138 | 3001 | freecon (con); |
c1fea2c0 | 3002 | return fail ? Qnil : Qt; |
574c05e2 KK |
3003 | } |
3004 | else | |
a9757f6a | 3005 | report_file_error ("Doing lgetfilecon", absname); |
574c05e2 KK |
3006 | } |
3007 | #endif | |
3008 | ||
3009 | return Qnil; | |
3010 | } | |
3011 | \f | |
7c3d167f | 3012 | DEFUN ("file-acl", Ffile_acl, Sfile_acl, 1, 1, 0, |
553081a5 SM |
3013 | doc: /* Return ACL entries of file named FILENAME. |
3014 | The entries are returned in a format suitable for use in `set-file-acl' | |
3015 | but is otherwise undocumented and subject to change. | |
7c3d167f | 3016 | Return nil if file does not exist or is not accessible, or if Emacs |
553081a5 | 3017 | was unable to determine the ACL entries. */) |
7c3d167f RF |
3018 | (Lisp_Object filename) |
3019 | { | |
3020 | Lisp_Object absname; | |
3021 | Lisp_Object handler; | |
ffdc270a | 3022 | #ifdef HAVE_ACL_SET_FILE |
7c3d167f RF |
3023 | acl_t acl; |
3024 | Lisp_Object acl_string; | |
3025 | char *str; | |
d895e63e PE |
3026 | # ifndef HAVE_ACL_TYPE_EXTENDED |
3027 | acl_type_t ACL_TYPE_EXTENDED = ACL_TYPE_ACCESS; | |
3028 | # endif | |
7c3d167f RF |
3029 | #endif |
3030 | ||
3031 | absname = expand_and_dir_to_file (filename, | |
3032 | BVAR (current_buffer, directory)); | |
3033 | ||
3034 | /* If the file name has special constructs in it, | |
3035 | call the corresponding file handler. */ | |
3036 | handler = Ffind_file_name_handler (absname, Qfile_acl); | |
3037 | if (!NILP (handler)) | |
3038 | return call2 (handler, Qfile_acl, absname); | |
3039 | ||
ffdc270a | 3040 | #ifdef HAVE_ACL_SET_FILE |
7c3d167f RF |
3041 | absname = ENCODE_FILE (absname); |
3042 | ||
d895e63e | 3043 | acl = acl_get_file (SSDATA (absname), ACL_TYPE_EXTENDED); |
7c3d167f RF |
3044 | if (acl == NULL) |
3045 | return Qnil; | |
3046 | ||
3047 | str = acl_to_text (acl, NULL); | |
3048 | if (str == NULL) | |
3049 | { | |
3050 | acl_free (acl); | |
3051 | return Qnil; | |
3052 | } | |
3053 | ||
3054 | acl_string = build_string (str); | |
3055 | acl_free (str); | |
3056 | acl_free (acl); | |
3057 | ||
3058 | return acl_string; | |
3059 | #endif | |
3060 | ||
3061 | return Qnil; | |
3062 | } | |
3063 | ||
3064 | DEFUN ("set-file-acl", Fset_file_acl, Sset_file_acl, | |
3065 | 2, 2, 0, | |
3066 | doc: /* Set ACL of file named FILENAME to ACL-STRING. | |
3067 | ACL-STRING should contain the textual representation of the ACL | |
3068 | entries in a format suitable for the platform. | |
3069 | ||
ccad023b EZ |
3070 | Value is t if setting of ACL was successful, nil otherwise. |
3071 | ||
7c3d167f RF |
3072 | Setting ACL for local files requires Emacs to be built with ACL |
3073 | support. */) | |
3074 | (Lisp_Object filename, Lisp_Object acl_string) | |
3075 | { | |
3076 | Lisp_Object absname; | |
3077 | Lisp_Object handler; | |
ffdc270a | 3078 | #ifdef HAVE_ACL_SET_FILE |
7c3d167f RF |
3079 | Lisp_Object encoded_absname; |
3080 | acl_t acl; | |
3081 | bool fail; | |
3082 | #endif | |
3083 | ||
3084 | absname = Fexpand_file_name (filename, BVAR (current_buffer, directory)); | |
3085 | ||
3086 | /* If the file name has special constructs in it, | |
3087 | call the corresponding file handler. */ | |
3088 | handler = Ffind_file_name_handler (absname, Qset_file_acl); | |
3089 | if (!NILP (handler)) | |
3090 | return call3 (handler, Qset_file_acl, absname, acl_string); | |
3091 | ||
ffdc270a | 3092 | #ifdef HAVE_ACL_SET_FILE |
7c3d167f RF |
3093 | if (STRINGP (acl_string)) |
3094 | { | |
3095 | acl = acl_from_text (SSDATA (acl_string)); | |
3096 | if (acl == NULL) | |
3097 | { | |
a9757f6a | 3098 | report_file_error ("Converting ACL", absname); |
7c3d167f RF |
3099 | return Qnil; |
3100 | } | |
3101 | ||
3102 | encoded_absname = ENCODE_FILE (absname); | |
3103 | ||
3104 | fail = (acl_set_file (SSDATA (encoded_absname), ACL_TYPE_ACCESS, | |
3105 | acl) | |
3106 | != 0); | |
ffdc270a | 3107 | if (fail && acl_errno_valid (errno)) |
a9757f6a | 3108 | report_file_error ("Setting ACL", absname); |
7c3d167f RF |
3109 | |
3110 | acl_free (acl); | |
c1fea2c0 | 3111 | return fail ? Qnil : Qt; |
7c3d167f RF |
3112 | } |
3113 | #endif | |
3114 | ||
3115 | return Qnil; | |
3116 | } | |
3117 | \f | |
570d7624 | 3118 | DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0, |
d4a42098 KS |
3119 | doc: /* Return mode bits of file named FILENAME, as an integer. |
3120 | Return nil, if file does not exist or is not accessible. */) | |
5842a27b | 3121 | (Lisp_Object filename) |
570d7624 | 3122 | { |
199607e4 | 3123 | Lisp_Object absname; |
570d7624 | 3124 | struct stat st; |
32f4334d | 3125 | Lisp_Object handler; |
570d7624 | 3126 | |
4b4deea2 | 3127 | absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory)); |
570d7624 | 3128 | |
32f4334d RS |
3129 | /* If the file name has special constructs in it, |
3130 | call the corresponding file handler. */ | |
199607e4 | 3131 | handler = Ffind_file_name_handler (absname, Qfile_modes); |
32f4334d | 3132 | if (!NILP (handler)) |
199607e4 | 3133 | return call2 (handler, Qfile_modes, absname); |
32f4334d | 3134 | |
b1d1b865 RS |
3135 | absname = ENCODE_FILE (absname); |
3136 | ||
42a5b22f | 3137 | if (stat (SSDATA (absname), &st) < 0) |
570d7624 | 3138 | return Qnil; |
3ace87e3 | 3139 | |
570d7624 JB |
3140 | return make_number (st.st_mode & 07777); |
3141 | } | |
3142 | ||
09fbdf6c MC |
3143 | DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, |
3144 | "(let ((file (read-file-name \"File: \"))) \ | |
3145 | (list file (read-file-modes nil file)))", | |
8c1a1077 | 3146 | doc: /* Set mode bits of file named FILENAME to MODE (an integer). |
ea429250 EZ |
3147 | Only the 12 low bits of MODE are used. |
3148 | ||
3149 | Interactively, mode bits are read by `read-file-modes', which accepts | |
712adc82 | 3150 | symbolic notation, like the `chmod' command from GNU Coreutils. */) |
5842a27b | 3151 | (Lisp_Object filename, Lisp_Object mode) |
570d7624 | 3152 | { |
b1d1b865 | 3153 | Lisp_Object absname, encoded_absname; |
32f4334d | 3154 | Lisp_Object handler; |
570d7624 | 3155 | |
4b4deea2 | 3156 | absname = Fexpand_file_name (filename, BVAR (current_buffer, directory)); |
b7826503 | 3157 | CHECK_NUMBER (mode); |
570d7624 | 3158 | |
32f4334d RS |
3159 | /* If the file name has special constructs in it, |
3160 | call the corresponding file handler. */ | |
199607e4 | 3161 | handler = Ffind_file_name_handler (absname, Qset_file_modes); |
32f4334d | 3162 | if (!NILP (handler)) |
199607e4 | 3163 | return call3 (handler, Qset_file_modes, absname, mode); |
32f4334d | 3164 | |
b1d1b865 RS |
3165 | encoded_absname = ENCODE_FILE (absname); |
3166 | ||
18c52557 | 3167 | if (chmod (SSDATA (encoded_absname), XINT (mode) & 07777) < 0) |
a9757f6a | 3168 | report_file_error ("Doing chmod", absname); |
570d7624 JB |
3169 | |
3170 | return Qnil; | |
3171 | } | |
3172 | ||
c24e9a53 | 3173 | DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0, |
8c1a1077 PJ |
3174 | doc: /* Set the file permission bits for newly created files. |
3175 | The argument MODE should be an integer; only the low 9 bits are used. | |
3176 | This setting is inherited by subprocesses. */) | |
5842a27b | 3177 | (Lisp_Object mode) |
36a8c287 | 3178 | { |
a560b856 | 3179 | mode_t oldrealmask, oldumask, newumask; |
b7826503 | 3180 | CHECK_NUMBER (mode); |
a560b856 PE |
3181 | oldrealmask = realmask; |
3182 | newumask = ~ XINT (mode) & 0777; | |
199607e4 | 3183 | |
a560b856 PE |
3184 | block_input (); |
3185 | realmask = newumask; | |
3186 | oldumask = umask (newumask); | |
3187 | unblock_input (); | |
36a8c287 | 3188 | |
a560b856 | 3189 | eassert (oldumask == oldrealmask); |
36a8c287 JB |
3190 | return Qnil; |
3191 | } | |
3192 | ||
c24e9a53 | 3193 | DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0, |
8c1a1077 PJ |
3194 | doc: /* Return the default file protection for created files. |
3195 | The value is an integer. */) | |
5842a27b | 3196 | (void) |
36a8c287 | 3197 | { |
5f85ea58 | 3198 | Lisp_Object value; |
46283abe | 3199 | XSETINT (value, (~ realmask) & 0777); |
5f85ea58 | 3200 | return value; |
36a8c287 | 3201 | } |
819da85b | 3202 | \f |
819da85b EZ |
3203 | |
3204 | DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0, | |
f839df0c | 3205 | doc: /* Set times of file FILENAME to TIMESTAMP. |
819da85b EZ |
3206 | Set both access and modification times. |
3207 | Return t on success, else nil. | |
f839df0c | 3208 | Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of |
819da85b | 3209 | `current-time'. */) |
f839df0c | 3210 | (Lisp_Object filename, Lisp_Object timestamp) |
819da85b EZ |
3211 | { |
3212 | Lisp_Object absname, encoded_absname; | |
3213 | Lisp_Object handler; | |
43aac990 | 3214 | struct timespec t = lisp_time_argument (timestamp); |
819da85b | 3215 | |
4b4deea2 | 3216 | absname = Fexpand_file_name (filename, BVAR (current_buffer, directory)); |
819da85b EZ |
3217 | |
3218 | /* If the file name has special constructs in it, | |
3219 | call the corresponding file handler. */ | |
3220 | handler = Ffind_file_name_handler (absname, Qset_file_times); | |
3221 | if (!NILP (handler)) | |
f839df0c | 3222 | return call3 (handler, Qset_file_times, absname, timestamp); |
819da85b EZ |
3223 | |
3224 | encoded_absname = ENCODE_FILE (absname); | |
5df5e07c | 3225 | |
819da85b | 3226 | { |
96c06863 | 3227 | if (set_file_times (-1, SSDATA (encoded_absname), t, t) != 0) |
819da85b | 3228 | { |
0d9f584b | 3229 | #ifdef MSDOS |
819da85b | 3230 | /* Setting times on a directory always fails. */ |
73dcdb9f | 3231 | if (file_directory_p (SSDATA (encoded_absname))) |
819da85b EZ |
3232 | return Qnil; |
3233 | #endif | |
a9757f6a | 3234 | report_file_error ("Setting file times", absname); |
819da85b EZ |
3235 | } |
3236 | } | |
5df5e07c | 3237 | |
819da85b EZ |
3238 | return Qt; |
3239 | } | |
f793dc6c | 3240 | \f |
697c17a2 | 3241 | #ifdef HAVE_SYNC |
85ffea93 | 3242 | DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "", |
8c1a1077 | 3243 | doc: /* Tell Unix to finish all pending disk updates. */) |
5842a27b | 3244 | (void) |
85ffea93 RS |
3245 | { |
3246 | sync (); | |
3247 | return Qnil; | |
3248 | } | |
3249 | ||
697c17a2 | 3250 | #endif /* HAVE_SYNC */ |
85ffea93 | 3251 | |
570d7624 | 3252 | DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0, |
8c1a1077 PJ |
3253 | doc: /* Return t if file FILE1 is newer than file FILE2. |
3254 | If FILE1 does not exist, the answer is nil; | |
3255 | otherwise, if FILE2 does not exist, the answer is t. */) | |
5842a27b | 3256 | (Lisp_Object file1, Lisp_Object file2) |
570d7624 | 3257 | { |
199607e4 | 3258 | Lisp_Object absname1, absname2; |
39adff0d | 3259 | struct stat st1, st2; |
32f4334d | 3260 | Lisp_Object handler; |
09121adc | 3261 | struct gcpro gcpro1, gcpro2; |
570d7624 | 3262 | |
b7826503 PJ |
3263 | CHECK_STRING (file1); |
3264 | CHECK_STRING (file2); | |
570d7624 | 3265 | |
199607e4 RS |
3266 | absname1 = Qnil; |
3267 | GCPRO2 (absname1, file2); | |
4b4deea2 TT |
3268 | absname1 = expand_and_dir_to_file (file1, BVAR (current_buffer, directory)); |
3269 | absname2 = expand_and_dir_to_file (file2, BVAR (current_buffer, directory)); | |
09121adc | 3270 | UNGCPRO; |
570d7624 | 3271 | |
32f4334d RS |
3272 | /* If the file name has special constructs in it, |
3273 | call the corresponding file handler. */ | |
199607e4 | 3274 | handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p); |
51cf6d37 | 3275 | if (NILP (handler)) |
199607e4 | 3276 | handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p); |
32f4334d | 3277 | if (!NILP (handler)) |
199607e4 | 3278 | return call3 (handler, Qfile_newer_than_file_p, absname1, absname2); |
32f4334d | 3279 | |
b1d1b865 RS |
3280 | GCPRO2 (absname1, absname2); |
3281 | absname1 = ENCODE_FILE (absname1); | |
3282 | absname2 = ENCODE_FILE (absname2); | |
3283 | UNGCPRO; | |
3284 | ||
39adff0d | 3285 | if (stat (SSDATA (absname1), &st1) < 0) |
570d7624 JB |
3286 | return Qnil; |
3287 | ||
39adff0d | 3288 | if (stat (SSDATA (absname2), &st2) < 0) |
570d7624 JB |
3289 | return Qt; |
3290 | ||
43aac990 | 3291 | return (timespec_cmp (get_stat_mtime (&st2), get_stat_mtime (&st1)) < 0 |
39adff0d | 3292 | ? Qt : Qnil); |
570d7624 JB |
3293 | } |
3294 | \f | |
6fdaa9a0 KH |
3295 | #ifndef READ_BUF_SIZE |
3296 | #define READ_BUF_SIZE (64 << 10) | |
3297 | #endif | |
d311d28c PE |
3298 | /* Some buffer offsets are stored in 'int' variables. */ |
3299 | verify (READ_BUF_SIZE <= INT_MAX); | |
6fdaa9a0 | 3300 | |
98a7d268 KH |
3301 | /* This function is called after Lisp functions to decide a coding |
3302 | system are called, or when they cause an error. Before they are | |
3303 | called, the current buffer is set unibyte and it contains only a | |
3304 | newly inserted text (thus the buffer was empty before the | |
3305 | insertion). | |
3306 | ||
3307 | The functions may set markers, overlays, text properties, or even | |
3308 | alter the buffer contents, change the current buffer. | |
3309 | ||
3310 | Here, we reset all those changes by: | |
3311 | o set back the current buffer. | |
3312 | o move all markers and overlays to BEG. | |
3313 | o remove all text properties. | |
3314 | o set back the buffer multibyteness. */ | |
f736ffbf | 3315 | |
27e498e6 | 3316 | static void |
971de7fb | 3317 | decide_coding_unwind (Lisp_Object unwind_data) |
f736ffbf | 3318 | { |
98a7d268 | 3319 | Lisp_Object multibyte, undo_list, buffer; |
f736ffbf | 3320 | |
98a7d268 KH |
3321 | multibyte = XCAR (unwind_data); |
3322 | unwind_data = XCDR (unwind_data); | |
3323 | undo_list = XCAR (unwind_data); | |
3324 | buffer = XCDR (unwind_data); | |
3325 | ||
a3d794a1 | 3326 | set_buffer_internal (XBUFFER (buffer)); |
98a7d268 KH |
3327 | adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE); |
3328 | adjust_overlays_for_delete (BEG, Z - BEG); | |
0c94c8d6 | 3329 | set_buffer_intervals (current_buffer, NULL); |
98a7d268 KH |
3330 | TEMP_SET_PT_BOTH (BEG, BEG_BYTE); |
3331 | ||
3332 | /* Now we are safe to change the buffer's multibyteness directly. */ | |
39eb03f1 PE |
3333 | bset_enable_multibyte_characters (current_buffer, multibyte); |
3334 | bset_undo_list (current_buffer, undo_list); | |
f736ffbf KH |
3335 | } |
3336 | ||
2ef88fd4 | 3337 | /* Read from a non-regular file. STATE is a Lisp_Save_Value |
3346c1d0 DA |
3338 | object where slot 0 is the file descriptor, slot 1 specifies |
3339 | an offset to put the read bytes, and slot 2 is the maximum | |
3340 | amount of bytes to read. Value is the number of bytes read. */ | |
55587f8a GM |
3341 | |
3342 | static Lisp_Object | |
2ef88fd4 | 3343 | read_non_regular (Lisp_Object state) |
55587f8a | 3344 | { |
d311d28c | 3345 | int nbytes; |
efdc16c9 | 3346 | |
1b978129 GM |
3347 | immediate_quit = 1; |
3348 | QUIT; | |
3346c1d0 | 3349 | nbytes = emacs_read (XSAVE_INTEGER (state, 0), |
5976c3fe | 3350 | ((char *) BEG_ADDR + PT_BYTE - BEG_BYTE |
3346c1d0 DA |
3351 | + XSAVE_INTEGER (state, 1)), |
3352 | XSAVE_INTEGER (state, 2)); | |
1b978129 | 3353 | immediate_quit = 0; |
e07469fa DA |
3354 | /* Fast recycle this object for the likely next call. */ |
3355 | free_misc (state); | |
1b978129 GM |
3356 | return make_number (nbytes); |
3357 | } | |
55587f8a | 3358 | |
2ef88fd4 DA |
3359 | |
3360 | /* Condition-case handler used when reading from non-regular files | |
3361 | in insert-file-contents. */ | |
1b978129 GM |
3362 | |
3363 | static Lisp_Object | |
2ef88fd4 | 3364 | read_non_regular_quit (Lisp_Object ignore) |
1b978129 | 3365 | { |
55587f8a GM |
3366 | return Qnil; |
3367 | } | |
3368 | ||
b3fbb395 PE |
3369 | /* Return the file offset that VAL represents, checking for type |
3370 | errors and overflow. */ | |
e69dafad | 3371 | static off_t |
b3fbb395 | 3372 | file_offset (Lisp_Object val) |
e69dafad | 3373 | { |
b3fbb395 PE |
3374 | if (RANGED_INTEGERP (0, val, TYPE_MAXIMUM (off_t))) |
3375 | return XINT (val); | |
3376 | ||
3377 | if (FLOATP (val)) | |
e69dafad | 3378 | { |
b3fbb395 | 3379 | double v = XFLOAT_DATA (val); |
7216e43b | 3380 | if (0 <= v |
b3fbb395 PE |
3381 | && (sizeof (off_t) < sizeof v |
3382 | ? v <= TYPE_MAXIMUM (off_t) | |
3383 | : v < TYPE_MAXIMUM (off_t))) | |
3384 | return v; | |
e69dafad | 3385 | } |
b3fbb395 PE |
3386 | |
3387 | wrong_type_argument (intern ("file-offset"), val); | |
e69dafad PE |
3388 | } |
3389 | ||
f0941253 | 3390 | /* Return a special time value indicating the error number ERRNUM. */ |
43aac990 | 3391 | static struct timespec |
f0941253 | 3392 | time_error_value (int errnum) |
dbeed9a6 | 3393 | { |
0497dc44 | 3394 | int ns = (errnum == ENOENT || errnum == EACCES || errnum == ENOTDIR |
dbeed9a6 PE |
3395 | ? NONEXISTENT_MODTIME_NSECS |
3396 | : UNKNOWN_MODTIME_NSECS); | |
43aac990 | 3397 | return make_timespec (0, ns); |
dbeed9a6 | 3398 | } |
55587f8a | 3399 | |
570d7624 | 3400 | DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents, |
8c1a1077 PJ |
3401 | 1, 5, 0, |
3402 | doc: /* Insert contents of file FILENAME after point. | |
cf6d2357 | 3403 | Returns list of absolute file name and number of characters inserted. |
6f2528d8 MR |
3404 | If second argument VISIT is non-nil, the buffer's visited filename and |
3405 | last save file modtime are set, and it is marked unmodified. If | |
3406 | visiting and the file does not exist, visiting is completed before the | |
3407 | error is signaled. | |
3408 | ||
3409 | The optional third and fourth arguments BEG and END specify what portion | |
3410 | of the file to insert. These arguments count bytes in the file, not | |
3411 | characters in the buffer. If VISIT is non-nil, BEG and END must be nil. | |
3412 | ||
3413 | If optional fifth argument REPLACE is non-nil, replace the current | |
3414 | buffer contents (in the accessible portion) with the file contents. | |
3415 | This is better than simply deleting and inserting the whole thing | |
3416 | because (1) it preserves some marker positions and (2) it puts less data | |
3417 | in the undo list. When REPLACE is non-nil, the second return value is | |
3418 | the number of characters that replace previous buffer contents. | |
3419 | ||
3420 | This function does code conversion according to the value of | |
3421 | `coding-system-for-read' or `file-coding-system-alist', and sets the | |
bb085aed EZ |
3422 | variable `last-coding-system-used' to the coding system actually used. |
3423 | ||
3424 | In addition, this function decodes the inserted text from known formats | |
3425 | by calling `format-decode', which see. */) | |
5842a27b | 3426 | (Lisp_Object filename, Lisp_Object visit, Lisp_Object beg, Lisp_Object end, Lisp_Object replace) |
570d7624 JB |
3427 | { |
3428 | struct stat st; | |
43aac990 | 3429 | struct timespec mtime; |
f75d7a91 | 3430 | int fd; |
d311d28c | 3431 | ptrdiff_t inserted = 0; |
f75d7a91 | 3432 | ptrdiff_t how_much; |
728f8f0a | 3433 | off_t beg_offset, end_offset; |
f75d7a91 | 3434 | int unprocessed; |
6f2528d8 MR |
3435 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
3436 | Lisp_Object handler, val, insval, orig_filename, old_undo; | |
d6a3cc15 | 3437 | Lisp_Object p; |
d311d28c | 3438 | ptrdiff_t total = 0; |
f75d7a91 | 3439 | bool not_regular = 0; |
2ef88fd4 | 3440 | int save_errno = 0; |
5976c3fe | 3441 | char read_buf[READ_BUF_SIZE]; |
6fdaa9a0 | 3442 | struct coding_system coding; |
f75d7a91 PE |
3443 | bool replace_handled = 0; |
3444 | bool set_coding_system = 0; | |
db327c7e | 3445 | Lisp_Object coding_system; |
f75d7a91 | 3446 | bool read_quit = 0; |
22513e52 SM |
3447 | /* If the undo log only contains the insertion, there's no point |
3448 | keeping it. It's typically when we first fill a file-buffer. */ | |
3449 | bool empty_undo_list_p | |
3450 | = (!NILP (visit) && NILP (BVAR (current_buffer, undo_list)) | |
3451 | && BEG == Z); | |
490ee853 | 3452 | Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark; |
f75d7a91 | 3453 | bool we_locked_file = 0; |
9f62b5dd BT |
3454 | |
3455 | dynwind_begin (); | |
32f4334d | 3456 | |
95385625 RS |
3457 | if (current_buffer->base_buffer && ! NILP (visit)) |
3458 | error ("Cannot do file visiting in an indirect buffer"); | |
3459 | ||
4b4deea2 | 3460 | if (!NILP (BVAR (current_buffer, read_only))) |
95385625 RS |
3461 | Fbarf_if_buffer_read_only (); |
3462 | ||
32f4334d | 3463 | val = Qnil; |
d6a3cc15 | 3464 | p = Qnil; |
b1d1b865 | 3465 | orig_filename = Qnil; |
6f2528d8 | 3466 | old_undo = Qnil; |
32f4334d | 3467 | |
6f2528d8 | 3468 | GCPRO5 (filename, val, p, orig_filename, old_undo); |
570d7624 | 3469 | |
b7826503 | 3470 | CHECK_STRING (filename); |
570d7624 JB |
3471 | filename = Fexpand_file_name (filename, Qnil); |
3472 | ||
1c157f8d KH |
3473 | /* The value Qnil means that the coding system is not yet |
3474 | decided. */ | |
3475 | coding_system = Qnil; | |
3476 | ||
32f4334d RS |
3477 | /* If the file name has special constructs in it, |
3478 | call the corresponding file handler. */ | |
49307295 | 3479 | handler = Ffind_file_name_handler (filename, Qinsert_file_contents); |
32f4334d RS |
3480 | if (!NILP (handler)) |
3481 | { | |
3d0387c0 RS |
3482 | val = call6 (handler, Qinsert_file_contents, filename, |
3483 | visit, beg, end, replace); | |
d311d28c PE |
3484 | if (CONSP (val) && CONSP (XCDR (val)) |
3485 | && RANGED_INTEGERP (0, XCAR (XCDR (val)), ZV - PT)) | |
03699b14 | 3486 | inserted = XINT (XCAR (XCDR (val))); |
32f4334d RS |
3487 | goto handled; |
3488 | } | |
3489 | ||
b1d1b865 RS |
3490 | orig_filename = filename; |
3491 | filename = ENCODE_FILE (filename); | |
3492 | ||
67722112 PE |
3493 | fd = emacs_open (SSDATA (filename), O_RDONLY, 0); |
3494 | if (fd < 0) | |
570d7624 | 3495 | { |
e5e9d610 | 3496 | save_errno = errno; |
265a9e55 | 3497 | if (NILP (visit)) |
a9757f6a | 3498 | report_file_error ("Opening input file", orig_filename); |
f0941253 | 3499 | mtime = time_error_value (save_errno); |
b885bf36 | 3500 | st.st_size = -1; |
0de6b8f4 | 3501 | if (!NILP (Vcoding_system_for_read)) |
22d92d6b | 3502 | Fset (Qbuffer_file_coding_system, Vcoding_system_for_read); |
570d7624 JB |
3503 | goto notfound; |
3504 | } | |
3505 | ||
5d1922cd | 3506 | record_unwind_protect_ptr (close_file_ptr_unwind, &fd); |
41d48a42 | 3507 | |
67722112 PE |
3508 | /* Replacement should preserve point as it preserves markers. */ |
3509 | if (!NILP (replace)) | |
3510 | record_unwind_protect (restore_point_unwind, Fpoint_marker ()); | |
3511 | ||
67722112 | 3512 | if (fstat (fd, &st) != 0) |
a9757f6a | 3513 | report_file_error ("Input file status", orig_filename); |
67722112 PE |
3514 | mtime = get_stat_mtime (&st); |
3515 | ||
be53b411 JB |
3516 | /* This code will need to be changed in order to work on named |
3517 | pipes, and it's probably just not worth it. So we should at | |
3518 | least signal an error. */ | |
99bc28f4 | 3519 | if (!S_ISREG (st.st_mode)) |
330bfe57 | 3520 | { |
d4b8687b RS |
3521 | not_regular = 1; |
3522 | ||
3523 | if (! NILP (visit)) | |
3524 | goto notfound; | |
3525 | ||
3526 | if (! NILP (replace) || ! NILP (beg) || ! NILP (end)) | |
24b1ddad KS |
3527 | xsignal2 (Qfile_error, |
3528 | build_string ("not a regular file"), orig_filename); | |
330bfe57 | 3529 | } |
be53b411 | 3530 | |
9f57b6b4 KH |
3531 | if (!NILP (visit)) |
3532 | { | |
3533 | if (!NILP (beg) || !NILP (end)) | |
3534 | error ("Attempt to visit less than an entire file"); | |
3535 | if (BEG < Z && NILP (replace)) | |
3536 | error ("Cannot do file visiting in a non-empty buffer"); | |
3537 | } | |
7fded690 JB |
3538 | |
3539 | if (!NILP (beg)) | |
b3fbb395 | 3540 | beg_offset = file_offset (beg); |
7fded690 | 3541 | else |
728f8f0a | 3542 | beg_offset = 0; |
7fded690 JB |
3543 | |
3544 | if (!NILP (end)) | |
b3fbb395 | 3545 | end_offset = file_offset (end); |
7fded690 JB |
3546 | else |
3547 | { | |
728f8f0a PE |
3548 | if (not_regular) |
3549 | end_offset = TYPE_MAXIMUM (off_t); | |
3550 | else | |
d4b8687b | 3551 | { |
728f8f0a PE |
3552 | end_offset = st.st_size; |
3553 | ||
3554 | /* A negative size can happen on a platform that allows file | |
3555 | sizes greater than the maximum off_t value. */ | |
3556 | if (end_offset < 0) | |
3557 | buffer_overflow (); | |
68c45bf0 | 3558 | |
d21dd12d GM |
3559 | /* The file size returned from stat may be zero, but data |
3560 | may be readable nonetheless, for example when this is a | |
3561 | file in the /proc filesystem. */ | |
728f8f0a PE |
3562 | if (end_offset == 0) |
3563 | end_offset = READ_BUF_SIZE; | |
d4b8687b | 3564 | } |
7fded690 JB |
3565 | } |
3566 | ||
728f8f0a PE |
3567 | /* Check now whether the buffer will become too large, |
3568 | in the likely case where the file's length is not changing. | |
3569 | This saves a lot of needless work before a buffer overflow. */ | |
3570 | if (! not_regular) | |
3571 | { | |
3572 | /* The likely offset where we will stop reading. We could read | |
3573 | more (or less), if the file grows (or shrinks) as we read it. */ | |
3574 | off_t likely_end = min (end_offset, st.st_size); | |
3575 | ||
3576 | if (beg_offset < likely_end) | |
3577 | { | |
ce2fe65a AS |
3578 | ptrdiff_t buf_bytes |
3579 | = Z_BYTE - (!NILP (replace) ? ZV_BYTE - BEGV_BYTE : 0); | |
728f8f0a PE |
3580 | ptrdiff_t buf_growth_max = BUF_BYTES_MAX - buf_bytes; |
3581 | off_t likely_growth = likely_end - beg_offset; | |
3582 | if (buf_growth_max < likely_growth) | |
3583 | buffer_overflow (); | |
3584 | } | |
3585 | } | |
3586 | ||
3587 | /* Prevent redisplay optimizations. */ | |
3588 | current_buffer->clip_changed = 1; | |
3589 | ||
356a6224 | 3590 | if (EQ (Vcoding_system_for_read, Qauto_save_coding)) |
5560aecd | 3591 | { |
75421805 | 3592 | coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix); |
5560aecd KH |
3593 | setup_coding_system (coding_system, &coding); |
3594 | /* Ensure we set Vlast_coding_system_used. */ | |
3595 | set_coding_system = 1; | |
3596 | } | |
356a6224 | 3597 | else if (BEG < Z) |
f736ffbf KH |
3598 | { |
3599 | /* Decide the coding system to use for reading the file now | |
3600 | because we can't use an optimized method for handling | |
3601 | `coding:' tag if the current buffer is not empty. */ | |
f736ffbf | 3602 | if (!NILP (Vcoding_system_for_read)) |
db327c7e | 3603 | coding_system = Vcoding_system_for_read; |
f736ffbf KH |
3604 | else |
3605 | { | |
3606 | /* Don't try looking inside a file for a coding system | |
3607 | specification if it is not seekable. */ | |
3608 | if (! not_regular && ! NILP (Vset_auto_coding_function)) | |
3609 | { | |
3610 | /* Find a coding system specified in the heading two | |
3611 | lines or in the tailing several lines of the file. | |
3612 | We assume that the 1K-byte and 3K-byte for heading | |
003a7eaa | 3613 | and tailing respectively are sufficient for this |
f736ffbf | 3614 | purpose. */ |
d311d28c | 3615 | int nread; |
f736ffbf KH |
3616 | |
3617 | if (st.st_size <= (1024 * 4)) | |
68c45bf0 | 3618 | nread = emacs_read (fd, read_buf, 1024 * 4); |
f736ffbf KH |
3619 | else |
3620 | { | |
68c45bf0 | 3621 | nread = emacs_read (fd, read_buf, 1024); |
4c95c9a5 | 3622 | if (nread == 1024) |
f736ffbf | 3623 | { |
4c95c9a5 PE |
3624 | int ntail; |
3625 | if (lseek (fd, - (1024 * 3), SEEK_END) < 0) | |
f736ffbf | 3626 | report_file_error ("Setting file position", |
a9757f6a | 3627 | orig_filename); |
4c95c9a5 PE |
3628 | ntail = emacs_read (fd, read_buf + nread, 1024 * 3); |
3629 | nread = ntail < 0 ? ntail : nread + ntail; | |
f736ffbf KH |
3630 | } |
3631 | } | |
feb9dc27 | 3632 | |
f736ffbf | 3633 | if (nread < 0) |
4e604a5d | 3634 | report_file_error ("Read error", orig_filename); |
f736ffbf KH |
3635 | else if (nread > 0) |
3636 | { | |
f839df0c | 3637 | Lisp_Object workbuf; |
685fc579 | 3638 | struct buffer *buf; |
f736ffbf | 3639 | |
9f62b5dd | 3640 | dynwind_begin (); |
66322887 | 3641 | record_unwind_current_buffer (); |
1d92afcd | 3642 | |
f839df0c PE |
3643 | workbuf = Fget_buffer_create (build_string (" *code-converting-work*")); |
3644 | buf = XBUFFER (workbuf); | |
685fc579 | 3645 | |
29ea8ae9 | 3646 | delete_all_overlays (buf); |
39eb03f1 PE |
3647 | bset_directory (buf, BVAR (current_buffer, directory)); |
3648 | bset_read_only (buf, Qnil); | |
3649 | bset_filename (buf, Qnil); | |
3650 | bset_undo_list (buf, Qt); | |
fd318b54 DA |
3651 | eassert (buf->overlays_before == NULL); |
3652 | eassert (buf->overlays_after == NULL); | |
efdc16c9 | 3653 | |
685fc579 RS |
3654 | set_buffer_internal (buf); |
3655 | Ferase_buffer (); | |
39eb03f1 | 3656 | bset_enable_multibyte_characters (buf, Qnil); |
685fc579 | 3657 | |
b68864e5 | 3658 | insert_1_both ((char *) read_buf, nread, nread, 0, 0, 0); |
f736ffbf | 3659 | TEMP_SET_PT_BOTH (BEG, BEG_BYTE); |
db327c7e | 3660 | coding_system = call2 (Vset_auto_coding_function, |
8f924df7 | 3661 | filename, make_number (nread)); |
efdc16c9 | 3662 | |
9f62b5dd | 3663 | dynwind_end (); |
f736ffbf KH |
3664 | |
3665 | /* Rewind the file for the actual read done later. */ | |
e69dafad | 3666 | if (lseek (fd, 0, SEEK_SET) < 0) |
a9757f6a | 3667 | report_file_error ("Setting file position", orig_filename); |
f736ffbf KH |
3668 | } |
3669 | } | |
feb9dc27 | 3670 | |
db327c7e | 3671 | if (NILP (coding_system)) |
f736ffbf KH |
3672 | { |
3673 | /* If we have not yet decided a coding system, check | |
3674 | file-coding-system-alist. */ | |
8f924df7 | 3675 | Lisp_Object args[6]; |
f736ffbf KH |
3676 | |
3677 | args[0] = Qinsert_file_contents, args[1] = orig_filename; | |
3678 | args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace; | |
8f924df7 KH |
3679 | coding_system = Ffind_operation_coding_system (6, args); |
3680 | if (CONSP (coding_system)) | |
3681 | coding_system = XCAR (coding_system); | |
f736ffbf KH |
3682 | } |
3683 | } | |
c9e82392 | 3684 | |
db327c7e KH |
3685 | if (NILP (coding_system)) |
3686 | coding_system = Qundecided; | |
3687 | else | |
3688 | CHECK_CODING_SYSTEM (coding_system); | |
c8a6d68a | 3689 | |
4b4deea2 | 3690 | if (NILP (BVAR (current_buffer, enable_multibyte_characters))) |
237a6fd2 RS |
3691 | /* We must suppress all character code conversion except for |
3692 | end-of-line conversion. */ | |
db327c7e | 3693 | coding_system = raw_text_coding_system (coding_system); |
54369368 | 3694 | |
db327c7e KH |
3695 | setup_coding_system (coding_system, &coding); |
3696 | /* Ensure we set Vlast_coding_system_used. */ | |
3697 | set_coding_system = 1; | |
f736ffbf | 3698 | } |
6cf71bf1 | 3699 | |
3d0387c0 RS |
3700 | /* If requested, replace the accessible part of the buffer |
3701 | with the file contents. Avoid replacing text at the | |
3702 | beginning or end of the buffer that matches the file contents; | |
3dbcf3f6 RS |
3703 | that preserves markers pointing to the unchanged parts. |
3704 | ||
3705 | Here we implement this feature in an optimized way | |
3706 | for the case where code conversion is NOT needed. | |
3707 | The following if-statement handles the case of conversion | |
727a0b4a RS |
3708 | in a less optimal way. |
3709 | ||
3710 | If the code conversion is "automatic" then we try using this | |
3711 | method and hope for the best. | |
3712 | But if we discover the need for conversion, we give up on this method | |
3713 | and let the following if-statement handle the replace job. */ | |
3dbcf3f6 | 3714 | if (!NILP (replace) |
f736ffbf | 3715 | && BEGV < ZV |
db327c7e KH |
3716 | && (NILP (coding_system) |
3717 | || ! CODING_REQUIRE_DECODING (&coding))) | |
3d0387c0 | 3718 | { |
ec7adf26 RS |
3719 | /* same_at_start and same_at_end count bytes, |
3720 | because file access counts bytes | |
3721 | and BEG and END count bytes. */ | |
d311d28c PE |
3722 | ptrdiff_t same_at_start = BEGV_BYTE; |
3723 | ptrdiff_t same_at_end = ZV_BYTE; | |
3724 | ptrdiff_t overlap; | |
6fdaa9a0 | 3725 | /* There is still a possibility we will find the need to do code |
f75d7a91 | 3726 | conversion. If that happens, set this variable to |
727a0b4a | 3727 | give up on handling REPLACE in the optimized way. */ |
f75d7a91 | 3728 | bool giveup_match_end = 0; |
9c28748f | 3729 | |
728f8f0a | 3730 | if (beg_offset != 0) |
4d2a0879 | 3731 | { |
728f8f0a | 3732 | if (lseek (fd, beg_offset, SEEK_SET) < 0) |
a9757f6a | 3733 | report_file_error ("Setting file position", orig_filename); |
4d2a0879 RS |
3734 | } |
3735 | ||
3d0387c0 RS |
3736 | immediate_quit = 1; |
3737 | QUIT; | |
3738 | /* Count how many chars at the start of the file | |
3739 | match the text at the beginning of the buffer. */ | |
3740 | while (1) | |
3741 | { | |
d311d28c | 3742 | int nread, bufpos; |
3d0387c0 | 3743 | |
2ef88fd4 | 3744 | nread = emacs_read (fd, read_buf, sizeof read_buf); |
3d0387c0 | 3745 | if (nread < 0) |
4e604a5d | 3746 | report_file_error ("Read error", orig_filename); |
3d0387c0 RS |
3747 | else if (nread == 0) |
3748 | break; | |
6fdaa9a0 | 3749 | |
db327c7e | 3750 | if (CODING_REQUIRE_DETECTION (&coding)) |
727a0b4a | 3751 | { |
2ef88fd4 | 3752 | coding_system = detect_coding_system ((unsigned char *) read_buf, |
5976c3fe | 3753 | nread, nread, 1, 0, |
db327c7e KH |
3754 | coding_system); |
3755 | setup_coding_system (coding_system, &coding); | |
727a0b4a RS |
3756 | } |
3757 | ||
db327c7e KH |
3758 | if (CODING_REQUIRE_DECODING (&coding)) |
3759 | /* We found that the file should be decoded somehow. | |
727a0b4a RS |
3760 | Let's give up here. */ |
3761 | { | |
3762 | giveup_match_end = 1; | |
3763 | break; | |
3764 | } | |
3765 | ||
3d0387c0 | 3766 | bufpos = 0; |
ec7adf26 | 3767 | while (bufpos < nread && same_at_start < ZV_BYTE |
2ef88fd4 | 3768 | && FETCH_BYTE (same_at_start) == read_buf[bufpos]) |
3d0387c0 RS |
3769 | same_at_start++, bufpos++; |
3770 | /* If we found a discrepancy, stop the scan. | |
8e6208c5 | 3771 | Otherwise loop around and scan the next bufferful. */ |
3d0387c0 RS |
3772 | if (bufpos != nread) |
3773 | break; | |
3774 | } | |
3775 | immediate_quit = 0; | |
3776 | /* If the file matches the buffer completely, | |
3777 | there's no need to replace anything. */ | |
2ba8e008 | 3778 | if (same_at_start - BEGV_BYTE == end_offset - beg_offset) |
3d0387c0 | 3779 | { |
68c45bf0 | 3780 | emacs_close (fd); |
5d1922cd | 3781 | fd = -1; |
9d611ffe | 3782 | |
1051b3b3 | 3783 | /* Truncate the buffer to the size of the file. */ |
7dae4502 | 3784 | del_range_1 (same_at_start, same_at_end, 0, 0); |
3d0387c0 RS |
3785 | goto handled; |
3786 | } | |
3787 | immediate_quit = 1; | |
3788 | QUIT; | |
3789 | /* Count how many chars at the end of the file | |
6fdaa9a0 KH |
3790 | match the text at the end of the buffer. But, if we have |
3791 | already found that decoding is necessary, don't waste time. */ | |
3792 | while (!giveup_match_end) | |
3d0387c0 | 3793 | { |
728f8f0a PE |
3794 | int total_read, nread, bufpos, trial; |
3795 | off_t curpos; | |
3d0387c0 RS |
3796 | |
3797 | /* At what file position are we now scanning? */ | |
728f8f0a | 3798 | curpos = end_offset - (ZV_BYTE - same_at_end); |
fc81fa9e KH |
3799 | /* If the entire file matches the buffer tail, stop the scan. */ |
3800 | if (curpos == 0) | |
3801 | break; | |
3d0387c0 | 3802 | /* How much can we scan in the next step? */ |
2ef88fd4 | 3803 | trial = min (curpos, sizeof read_buf); |
728f8f0a | 3804 | if (lseek (fd, curpos - trial, SEEK_SET) < 0) |
a9757f6a | 3805 | report_file_error ("Setting file position", orig_filename); |
3d0387c0 | 3806 | |
b02439c8 | 3807 | total_read = nread = 0; |
3d0387c0 RS |
3808 | while (total_read < trial) |
3809 | { | |
2ef88fd4 | 3810 | nread = emacs_read (fd, read_buf + total_read, trial - total_read); |
2bd2273e | 3811 | if (nread < 0) |
4e604a5d | 3812 | report_file_error ("Read error", orig_filename); |
2bd2273e GM |
3813 | else if (nread == 0) |
3814 | break; | |
3d0387c0 RS |
3815 | total_read += nread; |
3816 | } | |
efdc16c9 | 3817 | |
8e6208c5 | 3818 | /* Scan this bufferful from the end, comparing with |
3d0387c0 RS |
3819 | the Emacs buffer. */ |
3820 | bufpos = total_read; | |
efdc16c9 | 3821 | |
3d0387c0 RS |
3822 | /* Compare with same_at_start to avoid counting some buffer text |
3823 | as matching both at the file's beginning and at the end. */ | |
3824 | while (bufpos > 0 && same_at_end > same_at_start | |
2ef88fd4 | 3825 | && FETCH_BYTE (same_at_end - 1) == read_buf[bufpos - 1]) |
3d0387c0 | 3826 | same_at_end--, bufpos--; |
727a0b4a | 3827 | |
3d0387c0 | 3828 | /* If we found a discrepancy, stop the scan. |
8e6208c5 | 3829 | Otherwise loop around and scan the preceding bufferful. */ |
3d0387c0 | 3830 | if (bufpos != 0) |
727a0b4a RS |
3831 | { |
3832 | /* If this discrepancy is because of code conversion, | |
3833 | we cannot use this method; giveup and try the other. */ | |
3834 | if (same_at_end > same_at_start | |
3835 | && FETCH_BYTE (same_at_end - 1) >= 0200 | |
4b4deea2 | 3836 | && ! NILP (BVAR (current_buffer, enable_multibyte_characters)) |
c8a6d68a | 3837 | && (CODING_MAY_REQUIRE_DECODING (&coding))) |
727a0b4a RS |
3838 | giveup_match_end = 1; |
3839 | break; | |
3840 | } | |
b02439c8 GM |
3841 | |
3842 | if (nread == 0) | |
3843 | break; | |
3d0387c0 RS |
3844 | } |
3845 | immediate_quit = 0; | |
9c28748f | 3846 | |
727a0b4a RS |
3847 | if (! giveup_match_end) |
3848 | { | |
d311d28c | 3849 | ptrdiff_t temp; |
ec7adf26 | 3850 | |
727a0b4a | 3851 | /* We win! We can handle REPLACE the optimized way. */ |
9c28748f | 3852 | |
20f6783d RS |
3853 | /* Extend the start of non-matching text area to multibyte |
3854 | character boundary. */ | |
4b4deea2 | 3855 | if (! NILP (BVAR (current_buffer, enable_multibyte_characters))) |
20f6783d RS |
3856 | while (same_at_start > BEGV_BYTE |
3857 | && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start))) | |
3858 | same_at_start--; | |
3859 | ||
3860 | /* Extend the end of non-matching text area to multibyte | |
71312b68 | 3861 | character boundary. */ |
4b4deea2 | 3862 | if (! NILP (BVAR (current_buffer, enable_multibyte_characters))) |
ec7adf26 RS |
3863 | while (same_at_end < ZV_BYTE |
3864 | && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end))) | |
71312b68 RS |
3865 | same_at_end++; |
3866 | ||
727a0b4a | 3867 | /* Don't try to reuse the same piece of text twice. */ |
ec7adf26 | 3868 | overlap = (same_at_start - BEGV_BYTE |
728f8f0a PE |
3869 | - (same_at_end |
3870 | + (! NILP (end) ? end_offset : st.st_size) - ZV_BYTE)); | |
727a0b4a RS |
3871 | if (overlap > 0) |
3872 | same_at_end += overlap; | |
9c28748f | 3873 | |
727a0b4a | 3874 | /* Arrange to read only the nonmatching middle part of the file. */ |
728f8f0a PE |
3875 | beg_offset += same_at_start - BEGV_BYTE; |
3876 | end_offset -= ZV_BYTE - same_at_end; | |
3dbcf3f6 | 3877 | |
de1e0d91 EZ |
3878 | invalidate_buffer_caches (current_buffer, |
3879 | BYTE_TO_CHAR (same_at_start), | |
3880 | BYTE_TO_CHAR (same_at_end)); | |
ec7adf26 | 3881 | del_range_byte (same_at_start, same_at_end, 0); |
727a0b4a | 3882 | /* Insert from the file at the proper position. */ |
ec7adf26 RS |
3883 | temp = BYTE_TO_CHAR (same_at_start); |
3884 | SET_PT_BOTH (temp, same_at_start); | |
727a0b4a RS |
3885 | |
3886 | /* If display currently starts at beginning of line, | |
3887 | keep it that way. */ | |
e74aeda8 | 3888 | if (XBUFFER (XWINDOW (selected_window)->contents) == current_buffer) |
c98ff5dd | 3889 | XWINDOW (selected_window)->start_at_line_beg = !NILP (Fbolp ()); |
727a0b4a RS |
3890 | |
3891 | replace_handled = 1; | |
3892 | } | |
3dbcf3f6 RS |
3893 | } |
3894 | ||
3895 | /* If requested, replace the accessible part of the buffer | |
3896 | with the file contents. Avoid replacing text at the | |
3897 | beginning or end of the buffer that matches the file contents; | |
3898 | that preserves markers pointing to the unchanged parts. | |
3899 | ||
3900 | Here we implement this feature for the case where code conversion | |
3901 | is needed, in a simple way that needs a lot of memory. | |
3902 | The preceding if-statement handles the case of no conversion | |
3903 | in a more optimized way. */ | |
f736ffbf | 3904 | if (!NILP (replace) && ! replace_handled && BEGV < ZV) |
3dbcf3f6 | 3905 | { |
d311d28c PE |
3906 | ptrdiff_t same_at_start = BEGV_BYTE; |
3907 | ptrdiff_t same_at_end = ZV_BYTE; | |
3908 | ptrdiff_t same_at_start_charpos; | |
3909 | ptrdiff_t inserted_chars; | |
3910 | ptrdiff_t overlap; | |
3911 | ptrdiff_t bufpos; | |
db327c7e | 3912 | unsigned char *decoded; |
d311d28c PE |
3913 | ptrdiff_t temp; |
3914 | ptrdiff_t this = 0; | |
f10fe38f PE |
3915 | bool multibyte |
3916 | = ! NILP (BVAR (current_buffer, enable_multibyte_characters)); | |
5b359650 | 3917 | Lisp_Object conversion_buffer; |
83aca1cb | 3918 | struct gcpro gcpro1; |
db327c7e | 3919 | |
9f62b5dd | 3920 | dynwind_begin (); |
5b359650 | 3921 | conversion_buffer = code_conversion_save (1, multibyte); |
3dbcf3f6 RS |
3922 | |
3923 | /* First read the whole file, performing code conversion into | |
3924 | CONVERSION_BUFFER. */ | |
3925 | ||
728f8f0a | 3926 | if (lseek (fd, beg_offset, SEEK_SET) < 0) |
a9757f6a | 3927 | report_file_error ("Setting file position", orig_filename); |
727a0b4a | 3928 | |
3dbcf3f6 RS |
3929 | inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */ |
3930 | unprocessed = 0; /* Bytes not processed in previous loop. */ | |
3931 | ||
2ba48777 | 3932 | GCPRO1 (conversion_buffer); |
b41b8a7e | 3933 | while (1) |
3dbcf3f6 | 3934 | { |
b41b8a7e PE |
3935 | /* Read at most READ_BUF_SIZE bytes at a time, to allow |
3936 | quitting while reading a huge file. */ | |
3dbcf3f6 RS |
3937 | |
3938 | /* Allow quitting out of the actual I/O. */ | |
3939 | immediate_quit = 1; | |
3940 | QUIT; | |
b41b8a7e PE |
3941 | this = emacs_read (fd, read_buf + unprocessed, |
3942 | READ_BUF_SIZE - unprocessed); | |
3dbcf3f6 RS |
3943 | immediate_quit = 0; |
3944 | ||
db327c7e | 3945 | if (this <= 0) |
43aae36e | 3946 | break; |
3dbcf3f6 | 3947 | |
bf1c0f27 SM |
3948 | BUF_TEMP_SET_PT (XBUFFER (conversion_buffer), |
3949 | BUF_Z (XBUFFER (conversion_buffer))); | |
5976c3fe PE |
3950 | decode_coding_c_string (&coding, (unsigned char *) read_buf, |
3951 | unprocessed + this, conversion_buffer); | |
db327c7e KH |
3952 | unprocessed = coding.carryover_bytes; |
3953 | if (coding.carryover_bytes > 0) | |
72af86bd | 3954 | memcpy (read_buf, coding.carryover, unprocessed); |
3dbcf3f6 | 3955 | } |
2ba48777 | 3956 | UNGCPRO; |
43aae36e | 3957 | if (this < 0) |
4e604a5d | 3958 | report_file_error ("Read error", orig_filename); |
41d48a42 | 3959 | emacs_close (fd); |
5d1922cd | 3960 | fd = -1; |
3dbcf3f6 | 3961 | |
db327c7e KH |
3962 | if (unprocessed > 0) |
3963 | { | |
3964 | coding.mode |= CODING_MODE_LAST_BLOCK; | |
5976c3fe PE |
3965 | decode_coding_c_string (&coding, (unsigned char *) read_buf, |
3966 | unprocessed, conversion_buffer); | |
db327c7e KH |
3967 | coding.mode &= ~CODING_MODE_LAST_BLOCK; |
3968 | } | |
3969 | ||
50b06221 | 3970 | coding_system = CODING_ID_NAME (coding.id); |
f6a07420 | 3971 | set_coding_system = 1; |
db327c7e | 3972 | decoded = BUF_BEG_ADDR (XBUFFER (conversion_buffer)); |
50342b35 KH |
3973 | inserted = (BUF_Z_BYTE (XBUFFER (conversion_buffer)) |
3974 | - BUF_BEG_BYTE (XBUFFER (conversion_buffer))); | |
db327c7e KH |
3975 | |
3976 | /* Compare the beginning of the converted string with the buffer | |
3977 | text. */ | |
3dbcf3f6 RS |
3978 | |
3979 | bufpos = 0; | |
3980 | while (bufpos < inserted && same_at_start < same_at_end | |
db327c7e | 3981 | && FETCH_BYTE (same_at_start) == decoded[bufpos]) |
3dbcf3f6 RS |
3982 | same_at_start++, bufpos++; |
3983 | ||
db327c7e | 3984 | /* If the file matches the head of buffer completely, |
3dbcf3f6 RS |
3985 | there's no need to replace anything. */ |
3986 | ||
3987 | if (bufpos == inserted) | |
3988 | { | |
3dbcf3f6 | 3989 | /* Truncate the buffer to the size of the file. */ |
0e64479a | 3990 | if (same_at_start != same_at_end) |
de1e0d91 EZ |
3991 | { |
3992 | invalidate_buffer_caches (current_buffer, | |
3993 | BYTE_TO_CHAR (same_at_start), | |
3994 | BYTE_TO_CHAR (same_at_end)); | |
3995 | del_range_byte (same_at_start, same_at_end, 0); | |
3996 | } | |
427f5aab | 3997 | inserted = 0; |
e8553dd1 | 3998 | |
9f62b5dd | 3999 | dynwind_end (); |
3dbcf3f6 RS |
4000 | goto handled; |
4001 | } | |
4002 | ||
db327c7e KH |
4003 | /* Extend the start of non-matching text area to the previous |
4004 | multibyte character boundary. */ | |
4b4deea2 | 4005 | if (! NILP (BVAR (current_buffer, enable_multibyte_characters))) |
20f6783d RS |
4006 | while (same_at_start > BEGV_BYTE |
4007 | && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start))) | |
4008 | same_at_start--; | |
4009 | ||
3dbcf3f6 RS |
4010 | /* Scan this bufferful from the end, comparing with |
4011 | the Emacs buffer. */ | |
4012 | bufpos = inserted; | |
4013 | ||
4014 | /* Compare with same_at_start to avoid counting some buffer text | |
4015 | as matching both at the file's beginning and at the end. */ | |
4016 | while (bufpos > 0 && same_at_end > same_at_start | |
db327c7e | 4017 | && FETCH_BYTE (same_at_end - 1) == decoded[bufpos - 1]) |
3dbcf3f6 RS |
4018 | same_at_end--, bufpos--; |
4019 | ||
db327c7e KH |
4020 | /* Extend the end of non-matching text area to the next |
4021 | multibyte character boundary. */ | |
4b4deea2 | 4022 | if (! NILP (BVAR (current_buffer, enable_multibyte_characters))) |
20f6783d RS |
4023 | while (same_at_end < ZV_BYTE |
4024 | && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end))) | |
4025 | same_at_end++; | |
4026 | ||
3dbcf3f6 | 4027 | /* Don't try to reuse the same piece of text twice. */ |
ec7adf26 | 4028 | overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE); |
3dbcf3f6 RS |
4029 | if (overlap > 0) |
4030 | same_at_end += overlap; | |
4031 | ||
727a0b4a RS |
4032 | /* If display currently starts at beginning of line, |
4033 | keep it that way. */ | |
e74aeda8 | 4034 | if (XBUFFER (XWINDOW (selected_window)->contents) == current_buffer) |
c98ff5dd | 4035 | XWINDOW (selected_window)->start_at_line_beg = !NILP (Fbolp ()); |
727a0b4a | 4036 | |
3dbcf3f6 RS |
4037 | /* Replace the chars that we need to replace, |
4038 | and update INSERTED to equal the number of bytes | |
db327c7e | 4039 | we are taking from the decoded string. */ |
4b70e2c9 | 4040 | inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE); |
427f5aab | 4041 | |
643c73b9 | 4042 | if (same_at_end != same_at_start) |
427f5aab | 4043 | { |
de1e0d91 EZ |
4044 | invalidate_buffer_caches (current_buffer, |
4045 | BYTE_TO_CHAR (same_at_start), | |
4046 | BYTE_TO_CHAR (same_at_end)); | |
427f5aab KH |
4047 | del_range_byte (same_at_start, same_at_end, 0); |
4048 | temp = GPT; | |
22513e52 | 4049 | eassert (same_at_start == GPT_BYTE); |
427f5aab KH |
4050 | same_at_start = GPT_BYTE; |
4051 | } | |
643c73b9 RS |
4052 | else |
4053 | { | |
643c73b9 | 4054 | temp = BYTE_TO_CHAR (same_at_start); |
643c73b9 | 4055 | } |
427f5aab KH |
4056 | /* Insert from the file at the proper position. */ |
4057 | SET_PT_BOTH (temp, same_at_start); | |
50342b35 KH |
4058 | same_at_start_charpos |
4059 | = buf_bytepos_to_charpos (XBUFFER (conversion_buffer), | |
7f5d2c72 SM |
4060 | same_at_start - BEGV_BYTE |
4061 | + BUF_BEG_BYTE (XBUFFER (conversion_buffer))); | |
22513e52 | 4062 | eassert (same_at_start_charpos == temp - (BEGV - BEG)); |
50342b35 KH |
4063 | inserted_chars |
4064 | = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer), | |
7f5d2c72 SM |
4065 | same_at_start + inserted - BEGV_BYTE |
4066 | + BUF_BEG_BYTE (XBUFFER (conversion_buffer))) | |
50342b35 | 4067 | - same_at_start_charpos); |
d07af40d KH |
4068 | /* This binding is to avoid ask-user-about-supersession-threat |
4069 | being called in insert_from_buffer (via in | |
4070 | prepare_to_modify_buffer). */ | |
4071 | specbind (intern ("buffer-file-name"), Qnil); | |
db327c7e | 4072 | insert_from_buffer (XBUFFER (conversion_buffer), |
50342b35 | 4073 | same_at_start_charpos, inserted_chars, 0); |
427f5aab KH |
4074 | /* Set `inserted' to the number of inserted characters. */ |
4075 | inserted = PT - temp; | |
77343e1d KH |
4076 | /* Set point before the inserted characters. */ |
4077 | SET_PT_BOTH (temp, same_at_start); | |
3dbcf3f6 | 4078 | |
9f62b5dd | 4079 | dynwind_end (); |
3dbcf3f6 | 4080 | |
3dbcf3f6 | 4081 | goto handled; |
3d0387c0 RS |
4082 | } |
4083 | ||
d4b8687b | 4084 | if (! not_regular) |
728f8f0a | 4085 | total = end_offset - beg_offset; |
d4b8687b RS |
4086 | else |
4087 | /* For a special file, all we can do is guess. */ | |
4088 | total = READ_BUF_SIZE; | |
570d7624 | 4089 | |
8b913b57 | 4090 | if (NILP (visit) && total > 0) |
68780e2a | 4091 | { |
4b4deea2 | 4092 | if (!NILP (BVAR (current_buffer, file_truename)) |
68780e2a | 4093 | /* Make binding buffer-file-name to nil effective. */ |
4b4deea2 | 4094 | && !NILP (BVAR (current_buffer, filename)) |
68780e2a RS |
4095 | && SAVE_MODIFF >= MODIFF) |
4096 | we_locked_file = 1; | |
bc329caa | 4097 | prepare_to_modify_buffer (PT, PT, NULL); |
68780e2a | 4098 | } |
570d7624 | 4099 | |
13002885 | 4100 | move_gap_both (PT, PT_BYTE); |
7fded690 JB |
4101 | if (GAP_SIZE < total) |
4102 | make_gap (total - GAP_SIZE); | |
4103 | ||
728f8f0a | 4104 | if (beg_offset != 0 || !NILP (replace)) |
7fded690 | 4105 | { |
728f8f0a | 4106 | if (lseek (fd, beg_offset, SEEK_SET) < 0) |
a9757f6a | 4107 | report_file_error ("Setting file position", orig_filename); |
7fded690 JB |
4108 | } |
4109 | ||
2ef88fd4 DA |
4110 | /* In the following loop, HOW_MUCH contains the total bytes read so |
4111 | far for a regular file, and not changed for a special file. But, | |
4112 | before exiting the loop, it is set to a negative value if I/O | |
4113 | error occurs. */ | |
a1d2b64a | 4114 | how_much = 0; |
efdc16c9 | 4115 | |
6fdaa9a0 KH |
4116 | /* Total bytes inserted. */ |
4117 | inserted = 0; | |
efdc16c9 | 4118 | |
2ef88fd4 DA |
4119 | /* Here, we don't do code conversion in the loop. It is done by |
4120 | decode_coding_gap after all data are read into the buffer. */ | |
4121 | { | |
4122 | ptrdiff_t gap_size = GAP_SIZE; | |
1b978129 | 4123 | |
2ef88fd4 DA |
4124 | while (how_much < total) |
4125 | { | |
4126 | /* try is reserved in some compilers (Microsoft C) */ | |
4127 | ptrdiff_t trytry = min (total - how_much, READ_BUF_SIZE); | |
4128 | ptrdiff_t this; | |
1b978129 | 4129 | |
2ef88fd4 DA |
4130 | if (not_regular) |
4131 | { | |
4132 | Lisp_Object nbytes; | |
4133 | ||
4134 | /* Maybe make more room. */ | |
4135 | if (gap_size < trytry) | |
4136 | { | |
4137 | make_gap (trytry - gap_size); | |
4138 | gap_size = GAP_SIZE - inserted; | |
4139 | } | |
4140 | ||
4141 | /* Read from the file, capturing `quit'. When an | |
4142 | error occurs, end the loop, and arrange for a quit | |
4143 | to be signaled after decoding the text we read. */ | |
4144 | nbytes = internal_condition_case_1 | |
4145 | (read_non_regular, | |
1396ac86 | 4146 | make_save_int_int_int (fd, inserted, trytry), |
2ef88fd4 DA |
4147 | Qerror, read_non_regular_quit); |
4148 | ||
4149 | if (NILP (nbytes)) | |
4150 | { | |
4151 | read_quit = 1; | |
4152 | break; | |
4153 | } | |
4154 | ||
4155 | this = XINT (nbytes); | |
4156 | } | |
4157 | else | |
4158 | { | |
4159 | /* Allow quitting out of the actual I/O. We don't make text | |
4160 | part of the buffer until all the reading is done, so a C-g | |
4161 | here doesn't do any harm. */ | |
4162 | immediate_quit = 1; | |
4163 | QUIT; | |
4164 | this = emacs_read (fd, | |
4165 | ((char *) BEG_ADDR + PT_BYTE - BEG_BYTE | |
4166 | + inserted), | |
4167 | trytry); | |
4168 | immediate_quit = 0; | |
4169 | } | |
4170 | ||
4171 | if (this <= 0) | |
4172 | { | |
4173 | how_much = this; | |
4174 | break; | |
4175 | } | |
4176 | ||
4177 | gap_size -= this; | |
4178 | ||
4179 | /* For a regular file, where TOTAL is the real size, | |
4180 | count HOW_MUCH to compare with it. | |
4181 | For a special file, where TOTAL is just a buffer size, | |
4182 | so don't bother counting in HOW_MUCH. | |
4183 | (INSERTED is where we count the number of characters inserted.) */ | |
4184 | if (! not_regular) | |
4185 | how_much += this; | |
4186 | inserted += this; | |
4187 | } | |
4188 | } | |
1b978129 | 4189 | |
e07469fa DA |
4190 | /* Now we have either read all the file data into the gap, |
4191 | or stop reading on I/O error or quit. If nothing was | |
4192 | read, undo marking the buffer modified. */ | |
68780e2a RS |
4193 | |
4194 | if (inserted == 0) | |
4195 | { | |
4196 | if (we_locked_file) | |
4b4deea2 | 4197 | unlock_file (BVAR (current_buffer, file_truename)); |
68780e2a RS |
4198 | Vdeactivate_mark = old_Vdeactivate_mark; |
4199 | } | |
83c1cf6d RS |
4200 | else |
4201 | Vdeactivate_mark = Qt; | |
68780e2a | 4202 | |
68c45bf0 | 4203 | emacs_close (fd); |
5d1922cd | 4204 | fd = -1; |
6fdaa9a0 | 4205 | |
2ef88fd4 | 4206 | if (how_much < 0) |
4e604a5d | 4207 | report_file_error ("Read error", orig_filename); |
2ef88fd4 DA |
4208 | |
4209 | /* Make the text read part of the buffer. */ | |
4210 | GAP_SIZE -= inserted; | |
4211 | GPT += inserted; | |
4212 | GPT_BYTE += inserted; | |
4213 | ZV += inserted; | |
4214 | ZV_BYTE += inserted; | |
4215 | Z += inserted; | |
4216 | Z_BYTE += inserted; | |
4217 | ||
4218 | if (GAP_SIZE > 0) | |
4219 | /* Put an anchor to ensure multi-byte form ends at gap. */ | |
4220 | *GPT_ADDR = 0; | |
4221 | ||
f8569325 DL |
4222 | notfound: |
4223 | ||
db327c7e | 4224 | if (NILP (coding_system)) |
c8a6d68a | 4225 | { |
2df42e09 | 4226 | /* The coding system is not yet decided. Decide it by an |
dfe35e7b RS |
4227 | optimized method for handling `coding:' tag. |
4228 | ||
4229 | Note that we can get here only if the buffer was empty | |
4230 | before the insertion. */ | |
f736ffbf | 4231 | |
2df42e09 | 4232 | if (!NILP (Vcoding_system_for_read)) |
db327c7e | 4233 | coding_system = Vcoding_system_for_read; |
2df42e09 KH |
4234 | else |
4235 | { | |
98a7d268 KH |
4236 | /* Since we are sure that the current buffer was empty |
4237 | before the insertion, we can toggle | |
4238 | enable-multibyte-characters directly here without taking | |
9a7f80aa KH |
4239 | care of marker adjustment. By this way, we can run Lisp |
4240 | program safely before decoding the inserted text. */ | |
98a7d268 | 4241 | Lisp_Object unwind_data; |
9f62b5dd | 4242 | dynwind_begin (); |
2df42e09 | 4243 | |
4b4deea2 TT |
4244 | unwind_data = Fcons (BVAR (current_buffer, enable_multibyte_characters), |
4245 | Fcons (BVAR (current_buffer, undo_list), | |
98a7d268 | 4246 | Fcurrent_buffer ())); |
39eb03f1 PE |
4247 | bset_enable_multibyte_characters (current_buffer, Qnil); |
4248 | bset_undo_list (current_buffer, Qt); | |
98a7d268 KH |
4249 | record_unwind_protect (decide_coding_unwind, unwind_data); |
4250 | ||
4251 | if (inserted > 0 && ! NILP (Vset_auto_coding_function)) | |
4252 | { | |
db327c7e | 4253 | coding_system = call2 (Vset_auto_coding_function, |
8f924df7 | 4254 | filename, make_number (inserted)); |
2df42e09 | 4255 | } |
f736ffbf | 4256 | |
db327c7e | 4257 | if (NILP (coding_system)) |
2df42e09 KH |
4258 | { |
4259 | /* If the coding system is not yet decided, check | |
4260 | file-coding-system-alist. */ | |
8f924df7 | 4261 | Lisp_Object args[6]; |
f736ffbf | 4262 | |
2df42e09 KH |
4263 | args[0] = Qinsert_file_contents, args[1] = orig_filename; |
4264 | args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil; | |
8f924df7 KH |
4265 | coding_system = Ffind_operation_coding_system (6, args); |
4266 | if (CONSP (coding_system)) | |
4267 | coding_system = XCAR (coding_system); | |
f736ffbf | 4268 | } |
9f62b5dd | 4269 | dynwind_end (); |
98a7d268 | 4270 | inserted = Z_BYTE - BEG_BYTE; |
2df42e09 | 4271 | } |
f736ffbf | 4272 | |
db327c7e KH |
4273 | if (NILP (coding_system)) |
4274 | coding_system = Qundecided; | |
4275 | else | |
4276 | CHECK_CODING_SYSTEM (coding_system); | |
f736ffbf | 4277 | |
4b4deea2 | 4278 | if (NILP (BVAR (current_buffer, enable_multibyte_characters))) |
237a6fd2 | 4279 | /* We must suppress all character code conversion except for |
2df42e09 | 4280 | end-of-line conversion. */ |
db327c7e | 4281 | coding_system = raw_text_coding_system (coding_system); |
db327c7e KH |
4282 | setup_coding_system (coding_system, &coding); |
4283 | /* Ensure we set Vlast_coding_system_used. */ | |
4284 | set_coding_system = 1; | |
2df42e09 | 4285 | } |
f736ffbf | 4286 | |
db327c7e | 4287 | if (!NILP (visit)) |
8c3b9441 | 4288 | { |
db327c7e | 4289 | /* When we visit a file by raw-text, we change the buffer to |
9a7f80aa | 4290 | unibyte. */ |
db327c7e KH |
4291 | if (CODING_FOR_UNIBYTE (&coding) |
4292 | /* Can't do this if part of the buffer might be preserved. */ | |
4293 | && NILP (replace)) | |
4294 | /* Visiting a file with these coding system makes the buffer | |
4295 | unibyte. */ | |
39eb03f1 | 4296 | bset_enable_multibyte_characters (current_buffer, Qnil); |
8c3b9441 KH |
4297 | } |
4298 | ||
4b4deea2 | 4299 | coding.dst_multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters)); |
5b359650 | 4300 | if (CODING_MAY_REQUIRE_DECODING (&coding) |
1c157f8d | 4301 | && (inserted > 0 || CODING_REQUIRE_FLUSHING (&coding))) |
2df42e09 | 4302 | { |
db327c7e KH |
4303 | move_gap_both (PT, PT_BYTE); |
4304 | GAP_SIZE += inserted; | |
4305 | ZV_BYTE -= inserted; | |
4306 | Z_BYTE -= inserted; | |
4307 | ZV -= inserted; | |
4308 | Z -= inserted; | |
4309 | decode_coding_gap (&coding, inserted, inserted); | |
4310 | inserted = coding.produced_char; | |
5b359650 | 4311 | coding_system = CODING_ID_NAME (coding.id); |
2df42e09 | 4312 | } |
db327c7e KH |
4313 | else if (inserted > 0) |
4314 | adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted, | |
4315 | inserted); | |
570d7624 | 4316 | |
0068070e SM |
4317 | /* Call after-change hooks for the inserted text, aside from the case |
4318 | of normal visiting (not with REPLACE), which is done in a new buffer | |
4319 | "before" the buffer is changed. */ | |
4320 | if (inserted > 0 && total > 0 | |
4321 | && (NILP (visit) || !NILP (replace))) | |
4322 | { | |
4323 | signal_after_change (PT, 0, inserted); | |
4324 | update_compositions (PT, PT, CHECK_BORDER); | |
4325 | } | |
4326 | ||
cf6d2357 RS |
4327 | /* Now INSERTED is measured in characters. */ |
4328 | ||
32f4334d | 4329 | handled: |
570d7624 | 4330 | |
265a9e55 | 4331 | if (!NILP (visit)) |
570d7624 | 4332 | { |
22513e52 | 4333 | if (empty_undo_list_p) |
39eb03f1 | 4334 | bset_undo_list (current_buffer, Qnil); |
62bcf009 | 4335 | |
a7e82472 RS |
4336 | if (NILP (handler)) |
4337 | { | |
dbeed9a6 | 4338 | current_buffer->modtime = mtime; |
58b963f7 | 4339 | current_buffer->modtime_size = st.st_size; |
39eb03f1 | 4340 | bset_filename (current_buffer, orig_filename); |
a7e82472 | 4341 | } |
62bcf009 | 4342 | |
95385625 | 4343 | SAVE_MODIFF = MODIFF; |
0b5397c2 | 4344 | BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF; |
4b4deea2 | 4345 | XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG); |
32f4334d RS |
4346 | if (NILP (handler)) |
4347 | { | |
4b4deea2 TT |
4348 | if (!NILP (BVAR (current_buffer, file_truename))) |
4349 | unlock_file (BVAR (current_buffer, file_truename)); | |
32f4334d RS |
4350 | unlock_file (filename); |
4351 | } | |
330bfe57 | 4352 | if (not_regular) |
24b1ddad KS |
4353 | xsignal2 (Qfile_error, |
4354 | build_string ("not a regular file"), orig_filename); | |
570d7624 JB |
4355 | } |
4356 | ||
b6426b03 | 4357 | if (set_coding_system) |
8f924df7 | 4358 | Vlast_coding_system_used = coding_system; |
b6426b03 | 4359 | |
2080470e | 4360 | if (! NILP (Ffboundp (Qafter_insert_file_set_coding))) |
b6426b03 | 4361 | { |
37a3c774 KH |
4362 | insval = call2 (Qafter_insert_file_set_coding, make_number (inserted), |
4363 | visit); | |
b6426b03 KH |
4364 | if (! NILP (insval)) |
4365 | { | |
d311d28c PE |
4366 | if (! RANGED_INTEGERP (0, insval, ZV - PT)) |
4367 | wrong_type_argument (intern ("inserted-chars"), insval); | |
b6426b03 KH |
4368 | inserted = XFASTINT (insval); |
4369 | } | |
4370 | } | |
4371 | ||
6420e80c | 4372 | /* Decode file format. */ |
c8a6d68a | 4373 | if (inserted > 0) |
0d420e88 | 4374 | { |
6420e80c | 4375 | /* Don't run point motion or modification hooks when decoding. */ |
d311d28c | 4376 | ptrdiff_t old_inserted = inserted; |
9f62b5dd | 4377 | dynwind_begin (); |
6f2528d8 MR |
4378 | specbind (Qinhibit_point_motion_hooks, Qt); |
4379 | specbind (Qinhibit_modification_hooks, Qt); | |
4380 | ||
6420e80c | 4381 | /* Save old undo list and don't record undo for decoding. */ |
4b4deea2 | 4382 | old_undo = BVAR (current_buffer, undo_list); |
39eb03f1 | 4383 | bset_undo_list (current_buffer, Qt); |
efdc16c9 | 4384 | |
6f2528d8 | 4385 | if (NILP (replace)) |
ed8e506f | 4386 | { |
6f2528d8 MR |
4387 | insval = call3 (Qformat_decode, |
4388 | Qnil, make_number (inserted), visit); | |
d311d28c PE |
4389 | if (! RANGED_INTEGERP (0, insval, ZV - PT)) |
4390 | wrong_type_argument (intern ("inserted-chars"), insval); | |
6f2528d8 MR |
4391 | inserted = XFASTINT (insval); |
4392 | } | |
4393 | else | |
4394 | { | |
4395 | /* If REPLACE is non-nil and we succeeded in not replacing the | |
6420e80c AS |
4396 | beginning or end of the buffer text with the file's contents, |
4397 | call format-decode with `point' positioned at the beginning | |
fa463103 | 4398 | of the buffer and `inserted' equaling the number of |
6420e80c AS |
4399 | characters in the buffer. Otherwise, format-decode might |
4400 | fail to correctly analyze the beginning or end of the buffer. | |
4401 | Hence we temporarily save `point' and `inserted' here and | |
4402 | restore `point' iff format-decode did not insert or delete | |
4403 | any text. Otherwise we leave `point' at point-min. */ | |
d311d28c PE |
4404 | ptrdiff_t opoint = PT; |
4405 | ptrdiff_t opoint_byte = PT_BYTE; | |
4406 | ptrdiff_t oinserted = ZV - BEGV; | |
4407 | EMACS_INT ochars_modiff = CHARS_MODIFF; | |
1f163f28 MA |
4408 | |
4409 | TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE); | |
6f2528d8 MR |
4410 | insval = call3 (Qformat_decode, |
4411 | Qnil, make_number (oinserted), visit); | |
d311d28c PE |
4412 | if (! RANGED_INTEGERP (0, insval, ZV - PT)) |
4413 | wrong_type_argument (intern ("inserted-chars"), insval); | |
cac4219c MR |
4414 | if (ochars_modiff == CHARS_MODIFF) |
4415 | /* format_decode didn't modify buffer's characters => move | |
4416 | point back to position before inserted text and leave | |
6420e80c | 4417 | value of inserted alone. */ |
6f2528d8 | 4418 | SET_PT_BOTH (opoint, opoint_byte); |
cac4219c MR |
4419 | else |
4420 | /* format_decode modified buffer's characters => consider | |
6420e80c | 4421 | entire buffer changed and leave point at point-min. */ |
cac4219c | 4422 | inserted = XFASTINT (insval); |
ed8e506f | 4423 | } |
efdc16c9 | 4424 | |
6f2528d8 | 4425 | /* For consistency with format-decode call these now iff inserted > 0 |
6420e80c | 4426 | (martin 2007-06-28). */ |
6f2528d8 MR |
4427 | p = Vafter_insert_file_functions; |
4428 | while (CONSP (p)) | |
4429 | { | |
4430 | if (NILP (replace)) | |
4431 | { | |
4432 | insval = call1 (XCAR (p), make_number (inserted)); | |
4433 | if (!NILP (insval)) | |
4434 | { | |
d311d28c PE |
4435 | if (! RANGED_INTEGERP (0, insval, ZV - PT)) |
4436 | wrong_type_argument (intern ("inserted-chars"), insval); | |
6f2528d8 MR |
4437 | inserted = XFASTINT (insval); |
4438 | } | |
4439 | } | |
4440 | else | |
4441 | { | |
6420e80c AS |
4442 | /* For the rationale of this see the comment on |
4443 | format-decode above. */ | |
d311d28c PE |
4444 | ptrdiff_t opoint = PT; |
4445 | ptrdiff_t opoint_byte = PT_BYTE; | |
4446 | ptrdiff_t oinserted = ZV - BEGV; | |
4447 | EMACS_INT ochars_modiff = CHARS_MODIFF; | |
1f163f28 | 4448 | |
6f2528d8 MR |
4449 | TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE); |
4450 | insval = call1 (XCAR (p), make_number (oinserted)); | |
4451 | if (!NILP (insval)) | |
4452 | { | |
d311d28c PE |
4453 | if (! RANGED_INTEGERP (0, insval, ZV - PT)) |
4454 | wrong_type_argument (intern ("inserted-chars"), insval); | |
cac4219c MR |
4455 | if (ochars_modiff == CHARS_MODIFF) |
4456 | /* after_insert_file_functions didn't modify | |
4457 | buffer's characters => move point back to | |
4458 | position before inserted text and leave value of | |
6420e80c | 4459 | inserted alone. */ |
6f2528d8 | 4460 | SET_PT_BOTH (opoint, opoint_byte); |
cac4219c MR |
4461 | else |
4462 | /* after_insert_file_functions did modify buffer's | |
4463 | characters => consider entire buffer changed and | |
6420e80c | 4464 | leave point at point-min. */ |
cac4219c | 4465 | inserted = XFASTINT (insval); |
6f2528d8 MR |
4466 | } |
4467 | } | |
4468 | ||
4469 | QUIT; | |
4470 | p = XCDR (p); | |
ed8e506f | 4471 | } |
efdc16c9 | 4472 | |
22513e52 | 4473 | if (!empty_undo_list_p) |
6f2528d8 | 4474 | { |
39eb03f1 | 4475 | bset_undo_list (current_buffer, old_undo); |
6420e80c | 4476 | if (CONSP (old_undo) && inserted != old_inserted) |
6f2528d8 | 4477 | { |
6420e80c AS |
4478 | /* Adjust the last undo record for the size change during |
4479 | the format conversion. */ | |
6f2528d8 | 4480 | Lisp_Object tem = XCAR (old_undo); |
6420e80c AS |
4481 | if (CONSP (tem) && INTEGERP (XCAR (tem)) |
4482 | && INTEGERP (XCDR (tem)) | |
4483 | && XFASTINT (XCDR (tem)) == PT + old_inserted) | |
4484 | XSETCDR (tem, make_number (PT + inserted)); | |
6f2528d8 MR |
4485 | } |
4486 | } | |
6f2528d8 | 4487 | else |
1bc99c9c | 4488 | /* If undo_list was Qt before, keep it that way. |
6420e80c | 4489 | Otherwise start with an empty undo_list. */ |
39eb03f1 | 4490 | bset_undo_list (current_buffer, EQ (old_undo, Qt) ? Qt : Qnil); |
efdc16c9 | 4491 | |
9f62b5dd | 4492 | dynwind_end (); |
0d420e88 BG |
4493 | } |
4494 | ||
f8569325 | 4495 | if (!NILP (visit) |
43aac990 | 4496 | && current_buffer->modtime.tv_nsec == NONEXISTENT_MODTIME_NSECS) |
f8569325 DL |
4497 | { |
4498 | /* If visiting nonexistent file, return nil. */ | |
a9757f6a | 4499 | report_file_errno ("Opening input file", orig_filename, save_errno); |
d6a3cc15 RS |
4500 | } |
4501 | ||
addccbd0 EZ |
4502 | /* We made a lot of deletions and insertions above, so invalidate |
4503 | the newline cache for the entire region of the inserted | |
4504 | characters. */ | |
c10e9ece EZ |
4505 | if (current_buffer->base_buffer && current_buffer->base_buffer->newline_cache) |
4506 | invalidate_region_cache (current_buffer->base_buffer, | |
4507 | current_buffer->base_buffer->newline_cache, | |
4508 | PT - BEG, Z - PT - inserted); | |
4509 | else if (current_buffer->newline_cache) | |
addccbd0 EZ |
4510 | invalidate_region_cache (current_buffer, |
4511 | current_buffer->newline_cache, | |
4512 | PT - BEG, Z - PT - inserted); | |
4513 | ||
1b978129 GM |
4514 | if (read_quit) |
4515 | Fsignal (Qquit, Qnil); | |
4516 | ||
2ef88fd4 | 4517 | /* Retval needs to be dealt with in all cases consistently. */ |
a1d2b64a | 4518 | if (NILP (val)) |
e07469fa | 4519 | val = list2 (orig_filename, make_number (inserted)); |
a1d2b64a | 4520 | |
9f62b5dd BT |
4521 | dynwind_end (); |
4522 | return val; | |
570d7624 | 4523 | } |
7fded690 | 4524 | \f |
f57e2426 | 4525 | static Lisp_Object build_annotations (Lisp_Object, Lisp_Object); |
d6a3cc15 | 4526 | |
27e498e6 | 4527 | static void |
971de7fb | 4528 | build_annotations_unwind (Lisp_Object arg) |
6fc6f94b | 4529 | { |
67fbc0cb | 4530 | Vwrite_region_annotation_buffers = arg; |
6fc6f94b RS |
4531 | } |
4532 | ||
7c82a4a9 SM |
4533 | /* Decide the coding-system to encode the data with. */ |
4534 | ||
9dbda100 GM |
4535 | DEFUN ("choose-write-coding-system", Fchoose_write_coding_system, |
4536 | Schoose_write_coding_system, 3, 6, 0, | |
4537 | doc: /* Choose the coding system for writing a file. | |
4538 | Arguments are as for `write-region'. | |
4539 | This function is for internal use only. It may prompt the user. */ ) | |
4540 | (Lisp_Object start, Lisp_Object end, Lisp_Object filename, | |
4541 | Lisp_Object append, Lisp_Object visit, Lisp_Object lockname) | |
7c82a4a9 SM |
4542 | { |
4543 | Lisp_Object val; | |
75421805 | 4544 | Lisp_Object eol_parent = Qnil; |
7c82a4a9 | 4545 | |
9dbda100 GM |
4546 | /* Mimic write-region behavior. */ |
4547 | if (NILP (start)) | |
4548 | { | |
4549 | XSETFASTINT (start, BEGV); | |
4550 | XSETFASTINT (end, ZV); | |
4551 | } | |
4552 | ||
6b61353c | 4553 | if (auto_saving |
4b4deea2 TT |
4554 | && NILP (Fstring_equal (BVAR (current_buffer, filename), |
4555 | BVAR (current_buffer, auto_save_file_name)))) | |
75421805 KH |
4556 | { |
4557 | val = Qutf_8_emacs; | |
4558 | eol_parent = Qunix; | |
4559 | } | |
7c82a4a9 | 4560 | else if (!NILP (Vcoding_system_for_write)) |
42b01e1e KH |
4561 | { |
4562 | val = Vcoding_system_for_write; | |
4563 | if (coding_system_require_warning | |
4564 | && !NILP (Ffboundp (Vselect_safe_coding_system_function))) | |
4565 | /* Confirm that VAL can surely encode the current region. */ | |
4566 | val = call5 (Vselect_safe_coding_system_function, | |
6c6f1994 | 4567 | start, end, list2 (Qt, val), |
42b01e1e KH |
4568 | Qnil, filename); |
4569 | } | |
7c82a4a9 SM |
4570 | else |
4571 | { | |
4572 | /* If the variable `buffer-file-coding-system' is set locally, | |
4573 | it means that the file was read with some kind of code | |
4574 | conversion or the variable is explicitly set by users. We | |
4575 | had better write it out with the same coding system even if | |
4576 | `enable-multibyte-characters' is nil. | |
4577 | ||
4578 | If it is not set locally, we anyway have to convert EOL | |
4579 | format if the default value of `buffer-file-coding-system' | |
4580 | tells that it is not Unix-like (LF only) format. */ | |
f75d7a91 PE |
4581 | bool using_default_coding = 0; |
4582 | bool force_raw_text = 0; | |
7c82a4a9 | 4583 | |
4b4deea2 | 4584 | val = BVAR (current_buffer, buffer_file_coding_system); |
7c82a4a9 SM |
4585 | if (NILP (val) |
4586 | || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil))) | |
4587 | { | |
4588 | val = Qnil; | |
4b4deea2 | 4589 | if (NILP (BVAR (current_buffer, enable_multibyte_characters))) |
7c82a4a9 SM |
4590 | force_raw_text = 1; |
4591 | } | |
efdc16c9 | 4592 | |
7c82a4a9 SM |
4593 | if (NILP (val)) |
4594 | { | |
4595 | /* Check file-coding-system-alist. */ | |
4596 | Lisp_Object args[7], coding_systems; | |
4597 | ||
4598 | args[0] = Qwrite_region; args[1] = start; args[2] = end; | |
4599 | args[3] = filename; args[4] = append; args[5] = visit; | |
4600 | args[6] = lockname; | |
4601 | coding_systems = Ffind_operation_coding_system (7, args); | |
4602 | if (CONSP (coding_systems) && !NILP (XCDR (coding_systems))) | |
4603 | val = XCDR (coding_systems); | |
4604 | } | |
4605 | ||
c934586d | 4606 | if (NILP (val)) |
7c82a4a9 SM |
4607 | { |
4608 | /* If we still have not decided a coding system, use the | |
4609 | default value of buffer-file-coding-system. */ | |
4b4deea2 | 4610 | val = BVAR (current_buffer, buffer_file_coding_system); |
7c82a4a9 SM |
4611 | using_default_coding = 1; |
4612 | } | |
efdc16c9 | 4613 | |
db327c7e KH |
4614 | if (! NILP (val) && ! force_raw_text) |
4615 | { | |
4616 | Lisp_Object spec, attrs; | |
4617 | ||
4618 | CHECK_CODING_SYSTEM_GET_SPEC (val, spec); | |
4619 | attrs = AREF (spec, 0); | |
4620 | if (EQ (CODING_ATTR_TYPE (attrs), Qraw_text)) | |
4621 | force_raw_text = 1; | |
4622 | } | |
4623 | ||
7c82a4a9 SM |
4624 | if (!force_raw_text |
4625 | && !NILP (Ffboundp (Vselect_safe_coding_system_function))) | |
4626 | /* Confirm that VAL can surely encode the current region. */ | |
905a4276 PJ |
4627 | val = call5 (Vselect_safe_coding_system_function, |
4628 | start, end, val, Qnil, filename); | |
7c82a4a9 | 4629 | |
db327c7e KH |
4630 | /* If the decided coding-system doesn't specify end-of-line |
4631 | format, we use that of | |
4632 | `default-buffer-file-coding-system'. */ | |
c934586d | 4633 | if (! using_default_coding |
4b4deea2 | 4634 | && ! NILP (BVAR (&buffer_defaults, buffer_file_coding_system))) |
db327c7e | 4635 | val = (coding_inherit_eol_type |
4b4deea2 | 4636 | (val, BVAR (&buffer_defaults, buffer_file_coding_system))); |
7c82a4a9 | 4637 | |
db327c7e KH |
4638 | /* If we decide not to encode text, use `raw-text' or one of its |
4639 | subsidiaries. */ | |
7c82a4a9 | 4640 | if (force_raw_text) |
db327c7e | 4641 | val = raw_text_coding_system (val); |
7c82a4a9 SM |
4642 | } |
4643 | ||
75421805 | 4644 | val = coding_inherit_eol_type (val, eol_parent); |
c934586d | 4645 | return val; |
7c82a4a9 SM |
4646 | } |
4647 | ||
a7ca3326 | 4648 | DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7, |
8c1a1077 PJ |
4649 | "r\nFWrite region to file: \ni\ni\ni\np", |
4650 | doc: /* Write current region into specified file. | |
c2efea25 RS |
4651 | When called from a program, requires three arguments: |
4652 | START, END and FILENAME. START and END are normally buffer positions | |
4653 | specifying the part of the buffer to write. | |
4654 | If START is nil, that means to use the entire buffer contents. | |
4655 | If START is a string, then output that string to the file | |
4656 | instead of any buffer contents; END is ignored. | |
4657 | ||
8c1a1077 | 4658 | Optional fourth argument APPEND if non-nil means |
b3fbb395 | 4659 | append to existing file contents (if any). If it is a number, |
8c1a1077 | 4660 | seek to that offset in the file before writing. |
36e50520 | 4661 | Optional fifth argument VISIT, if t or a string, means |
8c1a1077 PJ |
4662 | set the last-save-file-modtime of buffer to this file's modtime |
4663 | and mark buffer not modified. | |
4664 | If VISIT is a string, it is a second file name; | |
4665 | the output goes to FILENAME, but the buffer is marked as visiting VISIT. | |
4666 | VISIT is also the file name to lock and unlock for clash detection. | |
4667 | If VISIT is neither t nor nil nor a string, | |
5f4e6aa9 | 4668 | that means do not display the \"Wrote file\" message. |
8c1a1077 PJ |
4669 | The optional sixth arg LOCKNAME, if non-nil, specifies the name to |
4670 | use for locking and unlocking, overriding FILENAME and VISIT. | |
4671 | The optional seventh arg MUSTBENEW, if non-nil, insists on a check | |
4672 | for an existing file with the same name. If MUSTBENEW is `excl', | |
4673 | that means to get an error if the file already exists; never overwrite. | |
4674 | If MUSTBENEW is neither nil nor `excl', that means ask for | |
4675 | confirmation before overwriting, but do go ahead and overwrite the file | |
4676 | if the user confirms. | |
8c1a1077 PJ |
4677 | |
4678 | This does code conversion according to the value of | |
4679 | `coding-system-for-write', `buffer-file-coding-system', or | |
4680 | `file-coding-system-alist', and sets the variable | |
aacd8ba1 GM |
4681 | `last-coding-system-used' to the coding system actually used. |
4682 | ||
4683 | This calls `write-region-annotate-functions' at the start, and | |
4684 | `write-region-post-annotation-function' at the end. */) | |
94fcd171 PE |
4685 | (Lisp_Object start, Lisp_Object end, Lisp_Object filename, Lisp_Object append, |
4686 | Lisp_Object visit, Lisp_Object lockname, Lisp_Object mustbenew) | |
4687 | { | |
4688 | return write_region (start, end, filename, append, visit, lockname, mustbenew, | |
4689 | -1); | |
4690 | } | |
4691 | ||
4692 | /* Like Fwrite_region, except that if DESC is nonnegative, it is a file | |
4693 | descriptor for FILENAME, so do not open or close FILENAME. */ | |
4694 | ||
4695 | Lisp_Object | |
4696 | write_region (Lisp_Object start, Lisp_Object end, Lisp_Object filename, | |
4697 | Lisp_Object append, Lisp_Object visit, Lisp_Object lockname, | |
4698 | Lisp_Object mustbenew, int desc) | |
570d7624 | 4699 | { |
3a955a1f PE |
4700 | int open_flags; |
4701 | int mode; | |
4702 | off_t offset IF_LINT (= 0); | |
94fcd171 | 4703 | bool open_and_close_file = desc < 0; |
f75d7a91 | 4704 | bool ok; |
6bbd7a29 | 4705 | int save_errno = 0; |
5976c3fe | 4706 | const char *fn; |
570d7624 | 4707 | struct stat st; |
43aac990 | 4708 | struct timespec modtime; |
3eac9910 | 4709 | Lisp_Object handler; |
4ad827c5 | 4710 | Lisp_Object visit_file; |
65b7d3e7 | 4711 | Lisp_Object annotations; |
b1d1b865 | 4712 | Lisp_Object encoded_filename; |
f75d7a91 PE |
4713 | bool visiting = (EQ (visit, Qt) || STRINGP (visit)); |
4714 | bool quietly = !NILP (visit); | |
94fcd171 | 4715 | bool file_locked = 0; |
7204a979 | 4716 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
6fc6f94b | 4717 | struct buffer *given_buffer; |
6fdaa9a0 | 4718 | struct coding_system coding; |
570d7624 | 4719 | |
d3a67486 | 4720 | if (current_buffer->base_buffer && visiting) |
95385625 RS |
4721 | error ("Cannot do file visiting in an indirect buffer"); |
4722 | ||
561cb8e1 | 4723 | if (!NILP (start) && !STRINGP (start)) |
570d7624 JB |
4724 | validate_region (&start, &end); |
4725 | ||
95c1c901 | 4726 | visit_file = Qnil; |
59fac292 | 4727 | GCPRO5 (start, filename, visit, visit_file, lockname); |
b56567b5 | 4728 | |
570d7624 | 4729 | filename = Fexpand_file_name (filename, Qnil); |
de1d0127 | 4730 | |
236a12f2 | 4731 | if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl)) |
a560b856 | 4732 | barf_or_query_if_file_exists (filename, false, "overwrite", true, true); |
de1d0127 | 4733 | |
561cb8e1 | 4734 | if (STRINGP (visit)) |
e5176bae | 4735 | visit_file = Fexpand_file_name (visit, Qnil); |
4ad827c5 RS |
4736 | else |
4737 | visit_file = filename; | |
4738 | ||
7204a979 RS |
4739 | if (NILP (lockname)) |
4740 | lockname = visit_file; | |
4741 | ||
65b7d3e7 RS |
4742 | annotations = Qnil; |
4743 | ||
32f4334d RS |
4744 | /* If the file name has special constructs in it, |
4745 | call the corresponding file handler. */ | |
49307295 | 4746 | handler = Ffind_file_name_handler (filename, Qwrite_region); |
b56ad927 | 4747 | /* If FILENAME has no handler, see if VISIT has one. */ |
93c30b5f | 4748 | if (NILP (handler) && STRINGP (visit)) |
199607e4 | 4749 | handler = Ffind_file_name_handler (visit, Qwrite_region); |
3eac9910 | 4750 | |
32f4334d RS |
4751 | if (!NILP (handler)) |
4752 | { | |
32f4334d | 4753 | Lisp_Object val; |
51cf6d37 RS |
4754 | val = call6 (handler, Qwrite_region, start, end, |
4755 | filename, append, visit); | |
32f4334d | 4756 | |
d6a3cc15 | 4757 | if (visiting) |
32f4334d | 4758 | { |
95385625 | 4759 | SAVE_MODIFF = MODIFF; |
4b4deea2 | 4760 | XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG); |
39eb03f1 | 4761 | bset_filename (current_buffer, visit_file); |
32f4334d | 4762 | } |
09121adc | 4763 | UNGCPRO; |
32f4334d RS |
4764 | return val; |
4765 | } | |
4766 | ||
9f62b5dd | 4767 | dynwind_begin (); |
4a38de71 KH |
4768 | record_unwind_protect (save_restriction_restore, save_restriction_save ()); |
4769 | ||
561cb8e1 RS |
4770 | /* Special kludge to simplify auto-saving. */ |
4771 | if (NILP (start)) | |
4772 | { | |
6b3d752c SM |
4773 | /* Do it later, so write-region-annotate-function can work differently |
4774 | if we save "the buffer" vs "a region". | |
4775 | This is useful in tar-mode. --Stef | |
2acfd7ae | 4776 | XSETFASTINT (start, BEG); |
6b3d752c | 4777 | XSETFASTINT (end, Z); */ |
4a38de71 | 4778 | Fwiden (); |
561cb8e1 RS |
4779 | } |
4780 | ||
67fbc0cb CY |
4781 | record_unwind_protect (build_annotations_unwind, |
4782 | Vwrite_region_annotation_buffers); | |
6c6f1994 | 4783 | Vwrite_region_annotation_buffers = list1 (Fcurrent_buffer ()); |
6fc6f94b RS |
4784 | |
4785 | given_buffer = current_buffer; | |
bf3428a1 RS |
4786 | |
4787 | if (!STRINGP (start)) | |
236a12f2 | 4788 | { |
bf3428a1 RS |
4789 | annotations = build_annotations (start, end); |
4790 | ||
4791 | if (current_buffer != given_buffer) | |
4792 | { | |
4793 | XSETFASTINT (start, BEGV); | |
4794 | XSETFASTINT (end, ZV); | |
4795 | } | |
236a12f2 SM |
4796 | } |
4797 | ||
6b3d752c SM |
4798 | if (NILP (start)) |
4799 | { | |
4800 | XSETFASTINT (start, BEGV); | |
4801 | XSETFASTINT (end, ZV); | |
4802 | } | |
4803 | ||
236a12f2 SM |
4804 | UNGCPRO; |
4805 | ||
4806 | GCPRO5 (start, filename, annotations, visit_file, lockname); | |
4807 | ||
59fac292 SM |
4808 | /* Decide the coding-system to encode the data with. |
4809 | We used to make this choice before calling build_annotations, but that | |
4810 | leads to problems when a write-annotate-function takes care of | |
4811 | unsavable chars (as was the case with X-Symbol). */ | |
538f3845 | 4812 | Vlast_coding_system_used = |
9dbda100 | 4813 | Fchoose_write_coding_system (start, end, filename, |
538f3845 | 4814 | append, visit, lockname); |
9dbda100 GM |
4815 | |
4816 | setup_coding_system (Vlast_coding_system_used, &coding); | |
4817 | ||
4818 | if (!STRINGP (start) && !NILP (BVAR (current_buffer, selective_display))) | |
4819 | coding.mode |= CODING_MODE_SELECTIVE_DISPLAY; | |
d6a3cc15 | 4820 | |
94fcd171 PE |
4821 | if (open_and_close_file && !auto_saving) |
4822 | { | |
4823 | lock_file (lockname); | |
4824 | file_locked = 1; | |
4825 | } | |
570d7624 | 4826 | |
b1d1b865 | 4827 | encoded_filename = ENCODE_FILE (filename); |
5976c3fe | 4828 | fn = SSDATA (encoded_filename); |
3a955a1f PE |
4829 | open_flags = O_WRONLY | O_BINARY | O_CREAT; |
4830 | open_flags |= EQ (mustbenew, Qexcl) ? O_EXCL : !NILP (append) ? 0 : O_TRUNC; | |
4831 | if (NUMBERP (append)) | |
4832 | offset = file_offset (append); | |
4833 | else if (!NILP (append)) | |
4834 | open_flags |= O_APPEND; | |
5e570b75 | 4835 | #ifdef DOS_NT |
3a955a1f PE |
4836 | mode = S_IREAD | S_IWRITE; |
4837 | #else | |
4838 | mode = auto_saving ? auto_save_mode_bits : 0666; | |
4839 | #endif | |
4840 | ||
94fcd171 | 4841 | if (open_and_close_file) |
570d7624 | 4842 | { |
94fcd171 PE |
4843 | desc = emacs_open (fn, open_flags, mode); |
4844 | if (desc < 0) | |
4845 | { | |
4846 | int open_errno = errno; | |
94fcd171 PE |
4847 | if (file_locked) |
4848 | unlock_file (lockname); | |
94fcd171 PE |
4849 | UNGCPRO; |
4850 | report_file_errno ("Opening output file", filename, open_errno); | |
4851 | } | |
570d7624 | 4852 | |
9f62b5dd | 4853 | dynwind_begin (); |
5d1922cd | 4854 | record_unwind_protect_int_1 (close_file_unwind, desc, false); |
94fcd171 | 4855 | } |
570d7624 | 4856 | |
3a955a1f | 4857 | if (NUMBERP (append)) |
43fb7d9a | 4858 | { |
3a955a1f | 4859 | off_t ret = lseek (desc, offset, SEEK_SET); |
43fb7d9a DL |
4860 | if (ret < 0) |
4861 | { | |
a773ed9a | 4862 | int lseek_errno = errno; |
94fcd171 PE |
4863 | if (file_locked) |
4864 | unlock_file (lockname); | |
43fb7d9a | 4865 | UNGCPRO; |
a9757f6a | 4866 | report_file_errno ("Lseek error", filename, lseek_errno); |
43fb7d9a DL |
4867 | } |
4868 | } | |
efdc16c9 | 4869 | |
43fb7d9a | 4870 | UNGCPRO; |
570d7624 | 4871 | |
570d7624 JB |
4872 | immediate_quit = 1; |
4873 | ||
561cb8e1 | 4874 | if (STRINGP (start)) |
f75d7a91 | 4875 | ok = a_write (desc, start, 0, SCHARS (start), &annotations, &coding); |
570d7624 | 4876 | else if (XINT (start) != XINT (end)) |
f75d7a91 PE |
4877 | ok = a_write (desc, Qnil, XINT (start), XINT (end) - XINT (start), |
4878 | &annotations, &coding); | |
69f6e679 RS |
4879 | else |
4880 | { | |
f75d7a91 | 4881 | /* If file was empty, still need to write the annotations. */ |
c8a6d68a | 4882 | coding.mode |= CODING_MODE_LAST_BLOCK; |
f75d7a91 | 4883 | ok = a_write (desc, Qnil, XINT (end), 0, &annotations, &coding); |
6fdaa9a0 | 4884 | } |
f75d7a91 | 4885 | save_errno = errno; |
6fdaa9a0 | 4886 | |
f75d7a91 PE |
4887 | if (ok && CODING_REQUIRE_FLUSHING (&coding) |
4888 | && !(coding.mode & CODING_MODE_LAST_BLOCK)) | |
6fdaa9a0 KH |
4889 | { |
4890 | /* We have to flush out a data. */ | |
c8a6d68a | 4891 | coding.mode |= CODING_MODE_LAST_BLOCK; |
f75d7a91 | 4892 | ok = e_write (desc, Qnil, 1, 1, &coding); |
69f6e679 | 4893 | save_errno = errno; |
570d7624 JB |
4894 | } |
4895 | ||
4896 | immediate_quit = 0; | |
4897 | ||
94fcd171 PE |
4898 | /* fsync is not crucial for temporary files. Nor for auto-save |
4899 | files, since they might lose some work anyway. */ | |
4900 | if (open_and_close_file && !auto_saving && !write_region_inhibit_fsync) | |
cb33c142 | 4901 | { |
cbee2131 PE |
4902 | /* Transfer data and metadata to disk, retrying if interrupted. |
4903 | fsync can report a write failure here, e.g., due to disk full | |
4904 | under NFS. But ignore EINVAL, which means fsync is not | |
4905 | supported on this file. */ | |
47d7532e PE |
4906 | while (fsync (desc) != 0) |
4907 | if (errno != EINTR) | |
4908 | { | |
4909 | if (errno != EINVAL) | |
4910 | ok = 0, save_errno = errno; | |
4911 | break; | |
4912 | } | |
cb33c142 | 4913 | } |
570d7624 | 4914 | |
43aac990 | 4915 | modtime = invalid_timespec (); |
d6453ce4 PE |
4916 | if (visiting) |
4917 | { | |
4918 | if (fstat (desc, &st) == 0) | |
4919 | modtime = get_stat_mtime (&st); | |
4920 | else | |
4921 | ok = 0, save_errno = errno; | |
4922 | } | |
4923 | ||
94fcd171 PE |
4924 | if (open_and_close_file) |
4925 | { | |
4926 | /* NFS can report a write failure now. */ | |
4927 | if (emacs_close (desc) < 0) | |
4928 | ok = 0, save_errno = errno; | |
570d7624 | 4929 | |
9f62b5dd | 4930 | dynwind_end (); |
94fcd171 | 4931 | } |
67fbc0cb | 4932 | |
9fe43ff6 PE |
4933 | /* Some file systems have a bug where st_mtime is not updated |
4934 | properly after a write. For example, CIFS might not see the | |
4935 | st_mtime change until after the file is opened again. | |
4936 | ||
4937 | Attempt to detect this file system bug, and update MODTIME to the | |
4938 | newer st_mtime if the bug appears to be present. This introduces | |
4939 | a race condition, so to avoid most instances of the race condition | |
4940 | on non-buggy file systems, skip this check if the most recently | |
4941 | encountered non-buggy file system was the current file system. | |
4942 | ||
4943 | A race condition can occur if some other process modifies the | |
4944 | file between the fstat above and the fstat below, but the race is | |
4945 | unlikely and a similar race between the last write and the fstat | |
4946 | above cannot possibly be closed anyway. */ | |
4947 | ||
43aac990 | 4948 | if (timespec_valid_p (modtime) |
9fe43ff6 PE |
4949 | && ! (valid_timestamp_file_system && st.st_dev == timestamp_file_system)) |
4950 | { | |
21cd50b8 | 4951 | int desc1 = emacs_open (fn, O_WRONLY | O_BINARY, 0); |
908589fd | 4952 | if (desc1 >= 0) |
9fe43ff6 PE |
4953 | { |
4954 | struct stat st1; | |
4955 | if (fstat (desc1, &st1) == 0 | |
4956 | && st.st_dev == st1.st_dev && st.st_ino == st1.st_ino) | |
4957 | { | |
8ea41ea9 PE |
4958 | /* Use the heuristic if it appears to be valid. With neither |
4959 | O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the | |
4960 | file, the time stamp won't change. Also, some non-POSIX | |
4961 | systems don't update an empty file's time stamp when | |
4962 | truncating it. Finally, file systems with 100 ns or worse | |
4963 | resolution sometimes seem to have bugs: on a system with ns | |
4964 | resolution, checking ns % 100 incorrectly avoids the heuristic | |
4965 | 1% of the time, but the problem should be temporary as we will | |
4966 | try again on the next time stamp. */ | |
4967 | bool use_heuristic | |
4968 | = ((open_flags & (O_EXCL | O_TRUNC)) != 0 | |
4969 | && st.st_size != 0 | |
43aac990 | 4970 | && modtime.tv_nsec % 100 != 0); |
8ea41ea9 | 4971 | |
43aac990 | 4972 | struct timespec modtime1 = get_stat_mtime (&st1); |
8ea41ea9 | 4973 | if (use_heuristic |
43aac990 | 4974 | && timespec_cmp (modtime, modtime1) == 0 |
9fe43ff6 PE |
4975 | && st.st_size == st1.st_size) |
4976 | { | |
4977 | timestamp_file_system = st.st_dev; | |
4978 | valid_timestamp_file_system = 1; | |
4979 | } | |
4980 | else | |
4981 | { | |
4982 | st.st_size = st1.st_size; | |
4983 | modtime = modtime1; | |
4984 | } | |
4985 | } | |
4986 | emacs_close (desc1); | |
4987 | } | |
4988 | } | |
4989 | ||
67fbc0cb | 4990 | /* Call write-region-post-annotation-function. */ |
294fa707 | 4991 | while (CONSP (Vwrite_region_annotation_buffers)) |
67fbc0cb CY |
4992 | { |
4993 | Lisp_Object buf = XCAR (Vwrite_region_annotation_buffers); | |
4994 | if (!NILP (Fbuffer_live_p (buf))) | |
4995 | { | |
4996 | Fset_buffer (buf); | |
4997 | if (FUNCTIONP (Vwrite_region_post_annotation_function)) | |
4998 | call0 (Vwrite_region_post_annotation_function); | |
4999 | } | |
5000 | Vwrite_region_annotation_buffers | |
5001 | = XCDR (Vwrite_region_annotation_buffers); | |
5002 | } | |
5003 | ||
9f62b5dd | 5004 | dynwind_end (); |
570d7624 | 5005 | |
94fcd171 | 5006 | if (file_locked) |
7204a979 | 5007 | unlock_file (lockname); |
570d7624 JB |
5008 | |
5009 | /* Do this before reporting IO error | |
5010 | to avoid a "file has changed on disk" warning on | |
5011 | next attempt to save. */ | |
43aac990 | 5012 | if (timespec_valid_p (modtime)) |
58b963f7 | 5013 | { |
d6453ce4 | 5014 | current_buffer->modtime = modtime; |
58b963f7 SM |
5015 | current_buffer->modtime_size = st.st_size; |
5016 | } | |
570d7624 | 5017 | |
f75d7a91 | 5018 | if (! ok) |
4e604a5d | 5019 | report_file_errno ("Write error", filename, save_errno); |
570d7624 | 5020 | |
d6a3cc15 | 5021 | if (visiting) |
570d7624 | 5022 | { |
95385625 | 5023 | SAVE_MODIFF = MODIFF; |
4b4deea2 | 5024 | XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG); |
39eb03f1 | 5025 | bset_filename (current_buffer, visit_file); |
2ec9db5d | 5026 | update_mode_lines = 14; |
570d7624 | 5027 | } |
d6a3cc15 | 5028 | else if (quietly) |
6b61353c KH |
5029 | { |
5030 | if (auto_saving | |
4b4deea2 TT |
5031 | && ! NILP (Fstring_equal (BVAR (current_buffer, filename), |
5032 | BVAR (current_buffer, auto_save_file_name)))) | |
6b61353c KH |
5033 | SAVE_MODIFF = MODIFF; |
5034 | ||
5035 | return Qnil; | |
5036 | } | |
570d7624 JB |
5037 | |
5038 | if (!auto_saving) | |
3908c576 | 5039 | message_with_string ((NUMBERP (append) |
0c328a0e RS |
5040 | ? "Updated %s" |
5041 | : ! NILP (append) | |
5042 | ? "Added to %s" | |
5043 | : "Wrote %s"), | |
5044 | visit_file, 1); | |
570d7624 JB |
5045 | |
5046 | return Qnil; | |
5047 | } | |
ec7adf26 | 5048 | \f |
d6a3cc15 | 5049 | DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0, |
8c1a1077 | 5050 | doc: /* Return t if (car A) is numerically less than (car B). */) |
5842a27b | 5051 | (Lisp_Object a, Lisp_Object b) |
d6a3cc15 | 5052 | { |
56a0e352 PE |
5053 | Lisp_Object args[2]; |
5054 | args[0] = Fcar (a); | |
5055 | args[1] = Fcar (b); | |
ebb99847 | 5056 | return Flss (2, args); |
d6a3cc15 RS |
5057 | } |
5058 | ||
5059 | /* Build the complete list of annotations appropriate for writing out | |
5060 | the text between START and END, by calling all the functions in | |
6fc6f94b RS |
5061 | write-region-annotate-functions and merging the lists they return. |
5062 | If one of these functions switches to a different buffer, we assume | |
5063 | that buffer contains altered text. Therefore, the caller must | |
5064 | make sure to restore the current buffer in all cases, | |
5065 | as save-excursion would do. */ | |
d6a3cc15 RS |
5066 | |
5067 | static Lisp_Object | |
971de7fb | 5068 | build_annotations (Lisp_Object start, Lisp_Object end) |
d6a3cc15 RS |
5069 | { |
5070 | Lisp_Object annotations; | |
5071 | Lisp_Object p, res; | |
5072 | struct gcpro gcpro1, gcpro2; | |
0a20b684 | 5073 | Lisp_Object original_buffer; |
f75d7a91 PE |
5074 | int i; |
5075 | bool used_global = 0; | |
0a20b684 RS |
5076 | |
5077 | XSETBUFFER (original_buffer, current_buffer); | |
d6a3cc15 RS |
5078 | |
5079 | annotations = Qnil; | |
5080 | p = Vwrite_region_annotate_functions; | |
5081 | GCPRO2 (annotations, p); | |
28c3eb5a | 5082 | while (CONSP (p)) |
d6a3cc15 | 5083 | { |
6fc6f94b | 5084 | struct buffer *given_buffer = current_buffer; |
bd235610 SM |
5085 | if (EQ (Qt, XCAR (p)) && !used_global) |
5086 | { /* Use the global value of the hook. */ | |
5087 | Lisp_Object arg[2]; | |
5088 | used_global = 1; | |
5089 | arg[0] = Fdefault_value (Qwrite_region_annotate_functions); | |
5090 | arg[1] = XCDR (p); | |
5091 | p = Fappend (2, arg); | |
5092 | continue; | |
5093 | } | |
6fc6f94b | 5094 | Vwrite_region_annotations_so_far = annotations; |
28c3eb5a | 5095 | res = call2 (XCAR (p), start, end); |
6fc6f94b RS |
5096 | /* If the function makes a different buffer current, |
5097 | assume that means this buffer contains altered text to be output. | |
5098 | Reset START and END from the buffer bounds | |
5099 | and discard all previous annotations because they should have | |
5100 | been dealt with by this function. */ | |
5101 | if (current_buffer != given_buffer) | |
5102 | { | |
67fbc0cb CY |
5103 | Vwrite_region_annotation_buffers |
5104 | = Fcons (Fcurrent_buffer (), | |
5105 | Vwrite_region_annotation_buffers); | |
3cf29f61 RS |
5106 | XSETFASTINT (start, BEGV); |
5107 | XSETFASTINT (end, ZV); | |
6fc6f94b RS |
5108 | annotations = Qnil; |
5109 | } | |
d6a3cc15 RS |
5110 | Flength (res); /* Check basic validity of return value */ |
5111 | annotations = merge (annotations, res, Qcar_less_than_car); | |
28c3eb5a | 5112 | p = XCDR (p); |
d6a3cc15 | 5113 | } |
0d420e88 BG |
5114 | |
5115 | /* Now do the same for annotation functions implied by the file-format */ | |
4b4deea2 TT |
5116 | if (auto_saving && (!EQ (BVAR (current_buffer, auto_save_file_format), Qt))) |
5117 | p = BVAR (current_buffer, auto_save_file_format); | |
0d420e88 | 5118 | else |
4b4deea2 | 5119 | p = BVAR (current_buffer, file_format); |
28c3eb5a | 5120 | for (i = 0; CONSP (p); p = XCDR (p), ++i) |
0d420e88 BG |
5121 | { |
5122 | struct buffer *given_buffer = current_buffer; | |
efdc16c9 | 5123 | |
0d420e88 | 5124 | Vwrite_region_annotations_so_far = annotations; |
532ed661 GM |
5125 | |
5126 | /* Value is either a list of annotations or nil if the function | |
5127 | has written annotations to a temporary buffer, which is now | |
5128 | current. */ | |
28c3eb5a | 5129 | res = call5 (Qformat_annotate_function, XCAR (p), start, end, |
532ed661 | 5130 | original_buffer, make_number (i)); |
0d420e88 BG |
5131 | if (current_buffer != given_buffer) |
5132 | { | |
3cf29f61 RS |
5133 | XSETFASTINT (start, BEGV); |
5134 | XSETFASTINT (end, ZV); | |
0d420e88 BG |
5135 | annotations = Qnil; |
5136 | } | |
efdc16c9 | 5137 | |
532ed661 GM |
5138 | if (CONSP (res)) |
5139 | annotations = merge (annotations, res, Qcar_less_than_car); | |
0d420e88 | 5140 | } |
6fdaa9a0 | 5141 | |
236a12f2 SM |
5142 | UNGCPRO; |
5143 | return annotations; | |
5144 | } | |
5145 | ||
ec7adf26 | 5146 | \f |
ce51c54c KH |
5147 | /* Write to descriptor DESC the NCHARS chars starting at POS of STRING. |
5148 | If STRING is nil, POS is the character position in the current buffer. | |
d6a3cc15 | 5149 | Intersperse with them the annotations from *ANNOT |
ce51c54c | 5150 | which fall within the range of POS to POS + NCHARS, |
d6a3cc15 RS |
5151 | each at its appropriate position. |
5152 | ||
ec7adf26 RS |
5153 | We modify *ANNOT by discarding elements as we use them up. |
5154 | ||
f75d7a91 | 5155 | Return true if successful. */ |
d6a3cc15 | 5156 | |
f75d7a91 | 5157 | static bool |
d311d28c | 5158 | a_write (int desc, Lisp_Object string, ptrdiff_t pos, |
f75d7a91 | 5159 | ptrdiff_t nchars, Lisp_Object *annot, |
8a2cbd72 | 5160 | struct coding_system *coding) |
d6a3cc15 RS |
5161 | { |
5162 | Lisp_Object tem; | |
d311d28c PE |
5163 | ptrdiff_t nextpos; |
5164 | ptrdiff_t lastpos = pos + nchars; | |
d6a3cc15 | 5165 | |
eb15aa18 | 5166 | while (NILP (*annot) || CONSP (*annot)) |
d6a3cc15 RS |
5167 | { |
5168 | tem = Fcar_safe (Fcar (*annot)); | |
ce51c54c | 5169 | nextpos = pos - 1; |
ec7adf26 | 5170 | if (INTEGERP (tem)) |
ce51c54c | 5171 | nextpos = XFASTINT (tem); |
ec7adf26 RS |
5172 | |
5173 | /* If there are no more annotations in this range, | |
5174 | output the rest of the range all at once. */ | |
ce51c54c KH |
5175 | if (! (nextpos >= pos && nextpos <= lastpos)) |
5176 | return e_write (desc, string, pos, lastpos, coding); | |
ec7adf26 RS |
5177 | |
5178 | /* Output buffer text up to the next annotation's position. */ | |
ce51c54c | 5179 | if (nextpos > pos) |
d6a3cc15 | 5180 | { |
f75d7a91 PE |
5181 | if (!e_write (desc, string, pos, nextpos, coding)) |
5182 | return 0; | |
ce51c54c | 5183 | pos = nextpos; |
d6a3cc15 | 5184 | } |
ec7adf26 | 5185 | /* Output the annotation. */ |
d6a3cc15 RS |
5186 | tem = Fcdr (Fcar (*annot)); |
5187 | if (STRINGP (tem)) | |
5188 | { | |
f75d7a91 PE |
5189 | if (!e_write (desc, tem, 0, SCHARS (tem), coding)) |
5190 | return 0; | |
d6a3cc15 RS |
5191 | } |
5192 | *annot = Fcdr (*annot); | |
5193 | } | |
f75d7a91 | 5194 | return 1; |
d6a3cc15 RS |
5195 | } |
5196 | ||
f8498081 DA |
5197 | /* Maximum number of characters that the next |
5198 | function encodes per one loop iteration. */ | |
5199 | ||
5200 | enum { E_WRITE_MAX = 8 * 1024 * 1024 }; | |
6fdaa9a0 | 5201 | |
ce51c54c KH |
5202 | /* Write text in the range START and END into descriptor DESC, |
5203 | encoding them with coding system CODING. If STRING is nil, START | |
5204 | and END are character positions of the current buffer, else they | |
f75d7a91 | 5205 | are indexes to the string STRING. Return true if successful. */ |
ec7adf26 | 5206 | |
f75d7a91 | 5207 | static bool |
d311d28c | 5208 | e_write (int desc, Lisp_Object string, ptrdiff_t start, ptrdiff_t end, |
8a2cbd72 | 5209 | struct coding_system *coding) |
570d7624 | 5210 | { |
ce51c54c KH |
5211 | if (STRINGP (string)) |
5212 | { | |
db327c7e | 5213 | start = 0; |
8f924df7 | 5214 | end = SCHARS (string); |
ce51c54c | 5215 | } |
570d7624 | 5216 | |
6fdaa9a0 KH |
5217 | /* We used to have a code for handling selective display here. But, |
5218 | now it is handled within encode_coding. */ | |
01ca97a2 KH |
5219 | |
5220 | while (start < end) | |
570d7624 | 5221 | { |
01ca97a2 | 5222 | if (STRINGP (string)) |
6ad568dd | 5223 | { |
01ca97a2 KH |
5224 | coding->src_multibyte = SCHARS (string) < SBYTES (string); |
5225 | if (CODING_REQUIRE_ENCODING (coding)) | |
5226 | { | |
f8498081 DA |
5227 | ptrdiff_t nchars = min (end - start, E_WRITE_MAX); |
5228 | ||
5229 | /* Avoid creating huge Lisp string in encode_coding_object. */ | |
5230 | if (nchars == E_WRITE_MAX) | |
5231 | coding->raw_destination = 1; | |
5232 | ||
5233 | encode_coding_object | |
5234 | (coding, string, start, string_char_to_byte (string, start), | |
5235 | start + nchars, string_char_to_byte (string, start + nchars), | |
5236 | Qt); | |
01ca97a2 KH |
5237 | } |
5238 | else | |
5239 | { | |
5240 | coding->dst_object = string; | |
5241 | coding->consumed_char = SCHARS (string); | |
5242 | coding->produced = SBYTES (string); | |
5243 | } | |
6ad568dd | 5244 | } |
db327c7e | 5245 | else |
6ad568dd | 5246 | { |
d311d28c PE |
5247 | ptrdiff_t start_byte = CHAR_TO_BYTE (start); |
5248 | ptrdiff_t end_byte = CHAR_TO_BYTE (end); | |
b4132433 | 5249 | |
01ca97a2 KH |
5250 | coding->src_multibyte = (end - start) < (end_byte - start_byte); |
5251 | if (CODING_REQUIRE_ENCODING (coding)) | |
5252 | { | |
f8498081 DA |
5253 | ptrdiff_t nchars = min (end - start, E_WRITE_MAX); |
5254 | ||
5255 | /* Likewise. */ | |
5256 | if (nchars == E_WRITE_MAX) | |
5257 | coding->raw_destination = 1; | |
5258 | ||
5259 | encode_coding_object | |
5260 | (coding, Fcurrent_buffer (), start, start_byte, | |
5261 | start + nchars, CHAR_TO_BYTE (start + nchars), Qt); | |
01ca97a2 KH |
5262 | } |
5263 | else | |
5264 | { | |
5265 | coding->dst_object = Qnil; | |
5266 | coding->dst_pos_byte = start_byte; | |
5267 | if (start >= GPT || end <= GPT) | |
5268 | { | |
5269 | coding->consumed_char = end - start; | |
5270 | coding->produced = end_byte - start_byte; | |
5271 | } | |
5272 | else | |
5273 | { | |
5274 | coding->consumed_char = GPT - start; | |
5275 | coding->produced = GPT_BYTE - start_byte; | |
5276 | } | |
5277 | } | |
c185d744 | 5278 | } |
01ca97a2 KH |
5279 | |
5280 | if (coding->produced > 0) | |
c185d744 | 5281 | { |
f8498081 DA |
5282 | char *buf = (coding->raw_destination ? (char *) coding->destination |
5283 | : (STRINGP (coding->dst_object) | |
5284 | ? SSDATA (coding->dst_object) | |
5285 | : (char *) BYTE_POS_ADDR (coding->dst_pos_byte))); | |
4ebbdd67 | 5286 | coding->produced -= emacs_write_sig (desc, buf, coding->produced); |
01ca97a2 | 5287 | |
f8498081 DA |
5288 | if (coding->raw_destination) |
5289 | { | |
5290 | /* We're responsible for freeing this, see | |
5291 | encode_coding_object to check why. */ | |
5292 | xfree (coding->destination); | |
5293 | coding->raw_destination = 0; | |
5294 | } | |
01ca97a2 | 5295 | if (coding->produced) |
f75d7a91 | 5296 | return 0; |
570d7624 | 5297 | } |
01ca97a2 | 5298 | start += coding->consumed_char; |
c185d744 KH |
5299 | } |
5300 | ||
f75d7a91 | 5301 | return 1; |
570d7624 | 5302 | } |
ec7adf26 | 5303 | \f |
a7ca3326 | 5304 | DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime, |
ec1b9b17 | 5305 | Sverify_visited_file_modtime, 0, 1, 0, |
8c1a1077 | 5306 | doc: /* Return t if last mod time of BUF's visited file matches what BUF records. |
6b61353c | 5307 | This means that the file has not been changed since it was visited or saved. |
ec1b9b17 | 5308 | If BUF is omitted or nil, it defaults to the current buffer. |
6b61353c | 5309 | See Info node `(elisp)Modification Time' for more details. */) |
5842a27b | 5310 | (Lisp_Object buf) |
570d7624 JB |
5311 | { |
5312 | struct buffer *b; | |
5313 | struct stat st; | |
32f4334d | 5314 | Lisp_Object handler; |
b1d1b865 | 5315 | Lisp_Object filename; |
43aac990 | 5316 | struct timespec mtime; |
570d7624 | 5317 | |
ec1b9b17 GM |
5318 | if (NILP (buf)) |
5319 | b = current_buffer; | |
5320 | else | |
5321 | { | |
5322 | CHECK_BUFFER (buf); | |
5323 | b = XBUFFER (buf); | |
5324 | } | |
570d7624 | 5325 | |
4b4deea2 | 5326 | if (!STRINGP (BVAR (b, filename))) return Qt; |
43aac990 | 5327 | if (b->modtime.tv_nsec == UNKNOWN_MODTIME_NSECS) return Qt; |
570d7624 | 5328 | |
32f4334d RS |
5329 | /* If the file name has special constructs in it, |
5330 | call the corresponding file handler. */ | |
4b4deea2 | 5331 | handler = Ffind_file_name_handler (BVAR (b, filename), |
49307295 | 5332 | Qverify_visited_file_modtime); |
32f4334d | 5333 | if (!NILP (handler)) |
09121adc | 5334 | return call2 (handler, Qverify_visited_file_modtime, buf); |
32f4334d | 5335 | |
4b4deea2 | 5336 | filename = ENCODE_FILE (BVAR (b, filename)); |
b1d1b865 | 5337 | |
dbeed9a6 PE |
5338 | mtime = (stat (SSDATA (filename), &st) == 0 |
5339 | ? get_stat_mtime (&st) | |
f0941253 | 5340 | : time_error_value (errno)); |
43aac990 | 5341 | if (timespec_cmp (mtime, b->modtime) == 0 |
645c6a30 PE |
5342 | && (b->modtime_size < 0 |
5343 | || st.st_size == b->modtime_size)) | |
570d7624 JB |
5344 | return Qt; |
5345 | return Qnil; | |
5346 | } | |
5347 | ||
f5d5eccf | 5348 | DEFUN ("visited-file-modtime", Fvisited_file_modtime, |
8c1a1077 PJ |
5349 | Svisited_file_modtime, 0, 0, 0, |
5350 | doc: /* Return the current buffer's recorded visited file modification time. | |
d35af63c | 5351 | The value is a list of the form (HIGH LOW USEC PSEC), like the time values that |
1c4d7f3d LMI |
5352 | `file-attributes' returns. If the current buffer has no recorded file |
5353 | modification time, this function returns 0. If the visited file | |
954b166e | 5354 | doesn't exist, return -1. |
6b61353c | 5355 | See Info node `(elisp)Modification Time' for more details. */) |
5842a27b | 5356 | (void) |
f5d5eccf | 5357 | { |
43aac990 | 5358 | int ns = current_buffer->modtime.tv_nsec; |
954b166e PE |
5359 | if (ns < 0) |
5360 | return make_number (UNKNOWN_MODTIME_NSECS - ns); | |
d35af63c | 5361 | return make_lisp_time (current_buffer->modtime); |
f5d5eccf RS |
5362 | } |
5363 | ||
570d7624 | 5364 | DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime, |
8c1a1077 PJ |
5365 | Sset_visited_file_modtime, 0, 1, 0, |
5366 | doc: /* Update buffer's recorded modification time from the visited file's time. | |
5367 | Useful if the buffer was not read from the file normally | |
5368 | or if the file itself has been changed for some known benign reason. | |
5369 | An argument specifies the modification time value to use | |
5370 | \(instead of that of the visited file), in the form of a list | |
954b166e PE |
5371 | \(HIGH LOW USEC PSEC) or an integer flag as returned by |
5372 | `visited-file-modtime'. */) | |
5373 | (Lisp_Object time_flag) | |
570d7624 | 5374 | { |
954b166e | 5375 | if (!NILP (time_flag)) |
58b963f7 | 5376 | { |
43aac990 | 5377 | struct timespec mtime; |
954b166e PE |
5378 | if (INTEGERP (time_flag)) |
5379 | { | |
5380 | CHECK_RANGED_INTEGER (time_flag, -1, 0); | |
43aac990 | 5381 | mtime = make_timespec (0, UNKNOWN_MODTIME_NSECS - XINT (time_flag)); |
954b166e PE |
5382 | } |
5383 | else | |
5384 | mtime = lisp_time_argument (time_flag); | |
5385 | ||
5386 | current_buffer->modtime = mtime; | |
58b963f7 SM |
5387 | current_buffer->modtime_size = -1; |
5388 | } | |
f5d5eccf RS |
5389 | else |
5390 | { | |
5391 | register Lisp_Object filename; | |
5392 | struct stat st; | |
5393 | Lisp_Object handler; | |
570d7624 | 5394 | |
4b4deea2 | 5395 | filename = Fexpand_file_name (BVAR (current_buffer, filename), Qnil); |
32f4334d | 5396 | |
f5d5eccf RS |
5397 | /* If the file name has special constructs in it, |
5398 | call the corresponding file handler. */ | |
49307295 | 5399 | handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime); |
f5d5eccf | 5400 | if (!NILP (handler)) |
caf3c431 | 5401 | /* The handler can find the file name the same way we did. */ |
76c881b0 | 5402 | return call2 (handler, Qset_visited_file_modtime, Qnil); |
b1d1b865 RS |
5403 | |
5404 | filename = ENCODE_FILE (filename); | |
5405 | ||
42a5b22f | 5406 | if (stat (SSDATA (filename), &st) >= 0) |
58b963f7 | 5407 | { |
d35af63c | 5408 | current_buffer->modtime = get_stat_mtime (&st); |
58b963f7 SM |
5409 | current_buffer->modtime_size = st.st_size; |
5410 | } | |
f5d5eccf | 5411 | } |
570d7624 JB |
5412 | |
5413 | return Qnil; | |
5414 | } | |
5415 | \f | |
f14b7e14 | 5416 | static Lisp_Object |
f839df0c | 5417 | auto_save_error (Lisp_Object error_val) |
570d7624 | 5418 | { |
d7f31e22 | 5419 | Lisp_Object args[3], msg; |
b09cca6a | 5420 | int i; |
d7f31e22 | 5421 | struct gcpro gcpro1; |
efdc16c9 | 5422 | |
ca730bf0 CY |
5423 | auto_save_error_occurred = 1; |
5424 | ||
385ed61f | 5425 | ring_bell (XFRAME (selected_frame)); |
efdc16c9 | 5426 | |
d7f31e22 | 5427 | args[0] = build_string ("Auto-saving %s: %s"); |
4b4deea2 | 5428 | args[1] = BVAR (current_buffer, name); |
f839df0c | 5429 | args[2] = Ferror_message_string (error_val); |
d7f31e22 GM |
5430 | msg = Fformat (3, args); |
5431 | GCPRO1 (msg); | |
d7f31e22 GM |
5432 | |
5433 | for (i = 0; i < 3; ++i) | |
5434 | { | |
5435 | if (i == 0) | |
b09cca6a | 5436 | message3 (msg); |
d7f31e22 | 5437 | else |
b09cca6a | 5438 | message3_nolog (msg); |
d7f31e22 GM |
5439 | Fsleep_for (make_number (1), Qnil); |
5440 | } | |
5441 | ||
5442 | UNGCPRO; | |
570d7624 JB |
5443 | return Qnil; |
5444 | } | |
5445 | ||
f14b7e14 | 5446 | static Lisp_Object |
971de7fb | 5447 | auto_save_1 (void) |
570d7624 | 5448 | { |
570d7624 | 5449 | struct stat st; |
d4a42098 KS |
5450 | Lisp_Object modes; |
5451 | ||
5452 | auto_save_mode_bits = 0666; | |
570d7624 JB |
5453 | |
5454 | /* Get visited file's mode to become the auto save file's mode. */ | |
4b4deea2 | 5455 | if (! NILP (BVAR (current_buffer, filename))) |
d4a42098 | 5456 | { |
4b4deea2 | 5457 | if (stat (SSDATA (BVAR (current_buffer, filename)), &st) >= 0) |
d4a42098 | 5458 | /* But make sure we can overwrite it later! */ |
18c52557 | 5459 | auto_save_mode_bits = (st.st_mode | 0600) & 0777; |
ce2fe65a AS |
5460 | else if (modes = Ffile_modes (BVAR (current_buffer, filename)), |
5461 | INTEGERP (modes)) | |
d4a42098 | 5462 | /* Remote files don't cooperate with stat. */ |
18c52557 | 5463 | auto_save_mode_bits = (XINT (modes) | 0600) & 0777; |
d4a42098 | 5464 | } |
570d7624 JB |
5465 | |
5466 | return | |
4b4deea2 | 5467 | Fwrite_region (Qnil, Qnil, BVAR (current_buffer, auto_save_file_name), Qnil, |
699b53bc CY |
5468 | NILP (Vauto_save_visited_file_name) ? Qlambda : Qt, |
5469 | Qnil, Qnil); | |
570d7624 JB |
5470 | } |
5471 | ||
27e498e6 PE |
5472 | struct auto_save_unwind |
5473 | { | |
5474 | FILE *stream; | |
5475 | bool auto_raise; | |
5476 | }; | |
410ed5c3 | 5477 | |
27e498e6 PE |
5478 | static void |
5479 | do_auto_save_unwind (void *arg) | |
e54d3b5d | 5480 | { |
27e498e6 PE |
5481 | struct auto_save_unwind *p = arg; |
5482 | FILE *stream = p->stream; | |
5483 | minibuffer_auto_raise = p->auto_raise; | |
3be3c08e | 5484 | auto_saving = 0; |
fff7e982 | 5485 | if (stream != NULL) |
aab12958 | 5486 | { |
4d7e6e51 | 5487 | block_input (); |
aab12958 | 5488 | fclose (stream); |
4d7e6e51 | 5489 | unblock_input (); |
aab12958 | 5490 | } |
a8c828be RS |
5491 | } |
5492 | ||
5794dd61 | 5493 | static Lisp_Object |
971de7fb | 5494 | do_auto_save_make_dir (Lisp_Object dir) |
5794dd61 | 5495 | { |
09450bae | 5496 | Lisp_Object result; |
26816cbf | 5497 | |
09450bae PE |
5498 | auto_saving_dir_umask = 077; |
5499 | result = call2 (Qmake_directory, dir, Qt); | |
5500 | auto_saving_dir_umask = 0; | |
5501 | return result; | |
5794dd61 RS |
5502 | } |
5503 | ||
5504 | static Lisp_Object | |
971de7fb | 5505 | do_auto_save_eh (Lisp_Object ignore) |
5794dd61 | 5506 | { |
09450bae | 5507 | auto_saving_dir_umask = 0; |
5794dd61 RS |
5508 | return Qnil; |
5509 | } | |
5510 | ||
a7ca3326 | 5511 | DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "", |
8c1a1077 PJ |
5512 | doc: /* Auto-save all buffers that need it. |
5513 | This is all buffers that have auto-saving enabled | |
5514 | and are changed since last auto-saved. | |
5515 | Auto-saving writes the buffer into a file | |
5516 | so that your editing is not lost if the system crashes. | |
5517 | This file is not the file you visited; that changes only when you save. | |
5518 | Normally we run the normal hook `auto-save-hook' before saving. | |
5519 | ||
5520 | A non-nil NO-MESSAGE argument means do not print any message if successful. | |
5521 | A non-nil CURRENT-ONLY argument means save only current buffer. */) | |
5842a27b | 5522 | (Lisp_Object no_message, Lisp_Object current_only) |
570d7624 JB |
5523 | { |
5524 | struct buffer *old = current_buffer, *b; | |
dee091a3 | 5525 | Lisp_Object tail, buf, hook; |
f75d7a91 | 5526 | bool auto_saved = 0; |
f14b1c68 | 5527 | int do_handled_files; |
ff4c9993 | 5528 | Lisp_Object oquit; |
fff7e982 | 5529 | FILE *stream = NULL; |
2bfa3d3e | 5530 | dynwind_begin (); |
f75d7a91 | 5531 | bool orig_minibuffer_auto_raise = minibuffer_auto_raise; |
fce31d69 | 5532 | bool old_message_p = 0; |
27e498e6 | 5533 | struct auto_save_unwind auto_save_unwind; |
d57563b6 | 5534 | struct gcpro gcpro1, gcpro2; |
38da540d RS |
5535 | |
5536 | if (max_specpdl_size < specpdl_size + 40) | |
5537 | max_specpdl_size = specpdl_size + 40; | |
5538 | ||
5539 | if (minibuf_level) | |
5540 | no_message = Qt; | |
5541 | ||
5794dd61 RS |
5542 | if (NILP (no_message)) |
5543 | { | |
5544 | old_message_p = push_message (); | |
27e498e6 | 5545 | record_unwind_protect_void (pop_message_unwind); |
5794dd61 | 5546 | } |
efdc16c9 | 5547 | |
ff4c9993 RS |
5548 | /* Ordinarily don't quit within this function, |
5549 | but don't make it impossible to quit (in case we get hung in I/O). */ | |
5550 | oquit = Vquit_flag; | |
5551 | Vquit_flag = Qnil; | |
570d7624 JB |
5552 | |
5553 | /* No GCPRO needed, because (when it matters) all Lisp_Object variables | |
5554 | point to non-strings reached from Vbuffer_alist. */ | |
5555 | ||
dee091a3 | 5556 | hook = intern ("auto-save-hook"); |
afbfe143 | 5557 | safe_run_hooks (hook); |
570d7624 | 5558 | |
e54d3b5d RS |
5559 | if (STRINGP (Vauto_save_list_file_name)) |
5560 | { | |
0894672f | 5561 | Lisp_Object listfile; |
efdc16c9 | 5562 | |
258fd2cb | 5563 | listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil); |
0894672f GM |
5564 | |
5565 | /* Don't try to create the directory when shutting down Emacs, | |
5566 | because creating the directory might signal an error, and | |
5567 | that would leave Emacs in a strange state. */ | |
5568 | if (!NILP (Vrun_hooks)) | |
5569 | { | |
5570 | Lisp_Object dir; | |
d57563b6 RS |
5571 | dir = Qnil; |
5572 | GCPRO2 (dir, listfile); | |
0894672f GM |
5573 | dir = Ffile_name_directory (listfile); |
5574 | if (NILP (Ffile_directory_p (dir))) | |
5794dd61 | 5575 | internal_condition_case_1 (do_auto_save_make_dir, |
09450bae | 5576 | dir, Qt, |
5794dd61 | 5577 | do_auto_save_eh); |
d57563b6 | 5578 | UNGCPRO; |
0894672f | 5579 | } |
efdc16c9 | 5580 | |
406af475 | 5581 | stream = emacs_fopen (SSDATA (listfile), "w"); |
1b335d29 | 5582 | } |
199607e4 | 5583 | |
27e498e6 PE |
5584 | auto_save_unwind.stream = stream; |
5585 | auto_save_unwind.auto_raise = minibuffer_auto_raise; | |
5586 | record_unwind_protect_ptr (do_auto_save_unwind, &auto_save_unwind); | |
a8c828be | 5587 | minibuffer_auto_raise = 0; |
3be3c08e | 5588 | auto_saving = 1; |
ca730bf0 | 5589 | auto_save_error_occurred = 0; |
3be3c08e | 5590 | |
6b61353c KH |
5591 | /* On first pass, save all files that don't have handlers. |
5592 | On second pass, save all files that do have handlers. | |
5593 | ||
5594 | If Emacs is crashing, the handlers may tweak what is causing | |
5595 | Emacs to crash in the first place, and it would be a shame if | |
5596 | Emacs failed to autosave perfectly ordinary files because it | |
5597 | couldn't handle some ange-ftp'd file. */ | |
5598 | ||
f14b1c68 | 5599 | for (do_handled_files = 0; do_handled_files < 2; do_handled_files++) |
8f3a2c26 | 5600 | FOR_EACH_LIVE_BUFFER (tail, buf) |
f14b1c68 | 5601 | { |
f14b1c68 | 5602 | b = XBUFFER (buf); |
199607e4 | 5603 | |
e54d3b5d | 5604 | /* Record all the buffers that have auto save mode |
258fd2cb RS |
5605 | in the special file that lists them. For each of these buffers, |
5606 | Record visited name (if any) and auto save name. */ | |
4b4deea2 | 5607 | if (STRINGP (BVAR (b, auto_save_file_name)) |
1b335d29 | 5608 | && stream != NULL && do_handled_files == 0) |
e54d3b5d | 5609 | { |
4d7e6e51 | 5610 | block_input (); |
4b4deea2 | 5611 | if (!NILP (BVAR (b, filename))) |
258fd2cb | 5612 | { |
4b4deea2 TT |
5613 | fwrite (SDATA (BVAR (b, filename)), 1, |
5614 | SBYTES (BVAR (b, filename)), stream); | |
258fd2cb | 5615 | } |
1b335d29 | 5616 | putc ('\n', stream); |
4b4deea2 TT |
5617 | fwrite (SDATA (BVAR (b, auto_save_file_name)), 1, |
5618 | SBYTES (BVAR (b, auto_save_file_name)), stream); | |
1b335d29 | 5619 | putc ('\n', stream); |
4d7e6e51 | 5620 | unblock_input (); |
e54d3b5d | 5621 | } |
17857782 | 5622 | |
f14b1c68 JB |
5623 | if (!NILP (current_only) |
5624 | && b != current_buffer) | |
5625 | continue; | |
e54d3b5d | 5626 | |
95385625 RS |
5627 | /* Don't auto-save indirect buffers. |
5628 | The base buffer takes care of it. */ | |
5629 | if (b->base_buffer) | |
5630 | continue; | |
5631 | ||
f14b1c68 JB |
5632 | /* Check for auto save enabled |
5633 | and file changed since last auto save | |
5634 | and file changed since last real save. */ | |
4b4deea2 | 5635 | if (STRINGP (BVAR (b, auto_save_file_name)) |
95385625 | 5636 | && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b) |
0b5397c2 | 5637 | && BUF_AUTOSAVE_MODIFF (b) < BUF_MODIFF (b) |
82c2d839 | 5638 | /* -1 means we've turned off autosaving for a while--see below. */ |
4b4deea2 | 5639 | && XINT (BVAR (b, save_length)) >= 0 |
f14b1c68 | 5640 | && (do_handled_files |
4b4deea2 | 5641 | || NILP (Ffind_file_name_handler (BVAR (b, auto_save_file_name), |
49307295 | 5642 | Qwrite_region)))) |
f14b1c68 | 5643 | { |
43aac990 PE |
5644 | struct timespec before_time = current_timespec (); |
5645 | struct timespec after_time; | |
b60247d9 RS |
5646 | |
5647 | /* If we had a failure, don't try again for 20 minutes. */ | |
d311d28c | 5648 | if (b->auto_save_failure_time > 0 |
43aac990 | 5649 | && before_time.tv_sec - b->auto_save_failure_time < 1200) |
b60247d9 RS |
5650 | continue; |
5651 | ||
090101cf CY |
5652 | set_buffer_internal (b); |
5653 | if (NILP (Vauto_save_include_big_deletions) | |
4b4deea2 | 5654 | && (XFASTINT (BVAR (b, save_length)) * 10 |
4be941e3 | 5655 | > (BUF_Z (b) - BUF_BEG (b)) * 13) |
f14b1c68 JB |
5656 | /* A short file is likely to change a large fraction; |
5657 | spare the user annoying messages. */ | |
4b4deea2 | 5658 | && XFASTINT (BVAR (b, save_length)) > 5000 |
f14b1c68 | 5659 | /* These messages are frequent and annoying for `*mail*'. */ |
4b4deea2 | 5660 | && !EQ (BVAR (b, filename), Qnil) |
f14b1c68 JB |
5661 | && NILP (no_message)) |
5662 | { | |
5663 | /* It has shrunk too much; turn off auto-saving here. */ | |
a8c828be | 5664 | minibuffer_auto_raise = orig_minibuffer_auto_raise; |
fd91d0d4 | 5665 | message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save", |
4b4deea2 | 5666 | BVAR (b, name), 1); |
a8c828be | 5667 | minibuffer_auto_raise = 0; |
82c2d839 RS |
5668 | /* Turn off auto-saving until there's a real save, |
5669 | and prevent any more warnings. */ | |
4b4deea2 | 5670 | XSETINT (BVAR (b, save_length), -1); |
f14b1c68 JB |
5671 | Fsleep_for (make_number (1), Qnil); |
5672 | continue; | |
5673 | } | |
f14b1c68 JB |
5674 | if (!auto_saved && NILP (no_message)) |
5675 | message1 ("Auto-saving..."); | |
5676 | internal_condition_case (auto_save_1, Qt, auto_save_error); | |
f75d7a91 | 5677 | auto_saved = 1; |
0b5397c2 | 5678 | BUF_AUTOSAVE_MODIFF (b) = BUF_MODIFF (b); |
4b4deea2 | 5679 | XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG); |
f14b1c68 | 5680 | set_buffer_internal (old); |
b60247d9 | 5681 | |
43aac990 | 5682 | after_time = current_timespec (); |
b60247d9 RS |
5683 | |
5684 | /* If auto-save took more than 60 seconds, | |
5685 | assume it was an NFS failure that got a timeout. */ | |
43aac990 PE |
5686 | if (after_time.tv_sec - before_time.tv_sec > 60) |
5687 | b->auto_save_failure_time = after_time.tv_sec; | |
f14b1c68 JB |
5688 | } |
5689 | } | |
570d7624 | 5690 | |
b67f2ca5 RS |
5691 | /* Prevent another auto save till enough input events come in. */ |
5692 | record_auto_save (); | |
570d7624 | 5693 | |
17857782 | 5694 | if (auto_saved && NILP (no_message)) |
f05b275b | 5695 | { |
5794dd61 | 5696 | if (old_message_p) |
31f3d831 | 5697 | { |
5794dd61 RS |
5698 | /* If we are going to restore an old message, |
5699 | give time to read ours. */ | |
83f8d903 | 5700 | sit_for (make_number (1), 0, 0); |
c71106e5 | 5701 | restore_message (); |
31f3d831 | 5702 | } |
ca730bf0 | 5703 | else if (!auto_save_error_occurred) |
31e31a15 CY |
5704 | /* Don't overwrite the error message if an error occurred. |
5705 | If we displayed a message and then restored a state | |
5794dd61 | 5706 | with no message, leave a "done" message on the screen. */ |
f05b275b KH |
5707 | message1 ("Auto-saving...done"); |
5708 | } | |
570d7624 | 5709 | |
ff4c9993 RS |
5710 | Vquit_flag = oquit; |
5711 | ||
5794dd61 | 5712 | /* This restores the message-stack status. */ |
2bfa3d3e | 5713 | dynwind_end (); |
570d7624 JB |
5714 | return Qnil; |
5715 | } | |
5716 | ||
5717 | DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved, | |
8c1a1077 PJ |
5718 | Sset_buffer_auto_saved, 0, 0, 0, |
5719 | doc: /* Mark current buffer as auto-saved with its current text. | |
5720 | No auto-save file will be written until the buffer changes again. */) | |
5842a27b | 5721 | (void) |
570d7624 | 5722 | { |
0b5397c2 SM |
5723 | /* FIXME: This should not be called in indirect buffers, since |
5724 | they're not autosaved. */ | |
5725 | BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF; | |
4b4deea2 | 5726 | XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG); |
d311d28c | 5727 | current_buffer->auto_save_failure_time = 0; |
b60247d9 RS |
5728 | return Qnil; |
5729 | } | |
5730 | ||
5731 | DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure, | |
8c1a1077 PJ |
5732 | Sclear_buffer_auto_save_failure, 0, 0, 0, |
5733 | doc: /* Clear any record of a recent auto-save failure in the current buffer. */) | |
5842a27b | 5734 | (void) |
b60247d9 | 5735 | { |
d311d28c | 5736 | current_buffer->auto_save_failure_time = 0; |
570d7624 JB |
5737 | return Qnil; |
5738 | } | |
5739 | ||
5740 | DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p, | |
8c1a1077 | 5741 | 0, 0, 0, |
68780e2a RS |
5742 | doc: /* Return t if current buffer has been auto-saved recently. |
5743 | More precisely, if it has been auto-saved since last read from or saved | |
5744 | in the visited file. If the buffer has no visited file, | |
5745 | then any auto-save counts as "recent". */) | |
5842a27b | 5746 | (void) |
570d7624 | 5747 | { |
0b5397c2 SM |
5748 | /* FIXME: maybe we should return nil for indirect buffers since |
5749 | they're never autosaved. */ | |
5750 | return (SAVE_MODIFF < BUF_AUTOSAVE_MODIFF (current_buffer) ? Qt : Qnil); | |
570d7624 JB |
5751 | } |
5752 | \f | |
5753 | /* Reading and completing file names */ | |
6e710ae5 | 5754 | |
88208bb8 JD |
5755 | DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p, |
5756 | Snext_read_file_uses_dialog_p, 0, 0, 0, | |
5757 | doc: /* Return t if a call to `read-file-name' will use a dialog. | |
5758 | The return value is only relevant for a call to `read-file-name' that happens | |
1a0de25c | 5759 | before any other event (mouse or keypress) is handled. */) |
5842a27b | 5760 | (void) |
88208bb8 | 5761 | { |
d7e642cc JD |
5762 | #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \ |
5763 | || defined (HAVE_NS) | |
88208bb8 JD |
5764 | if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event)) |
5765 | && use_dialog_box | |
5766 | && use_file_dialog | |
7452b7bd | 5767 | && window_system_available (SELECTED_FRAME ())) |
88208bb8 JD |
5768 | return Qt; |
5769 | #endif | |
5770 | return Qnil; | |
5771 | } | |
d4a42098 | 5772 | |
9fe43ff6 PE |
5773 | void |
5774 | init_fileio (void) | |
5775 | { | |
a560b856 PE |
5776 | realmask = umask (0); |
5777 | umask (realmask); | |
5778 | ||
9fe43ff6 | 5779 | valid_timestamp_file_system = 0; |
1db72ad3 RF |
5780 | |
5781 | /* fsync can be a significant performance hit. Often it doesn't | |
5782 | suffice to make the file-save operation survive a crash. For | |
5783 | batch scripts, which are typically part of larger shell commands | |
5784 | that don't fsync other files, its effect on performance can be | |
5785 | significant so its utility is particularly questionable. | |
5786 | Hence, for now by default fsync is used only when interactive. | |
5787 | ||
5788 | For more on why fsync often fails to work on today's hardware, see: | |
5789 | Zheng M et al. Understanding the robustness of SSDs under power fault. | |
5790 | 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84 | |
5791 | http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf | |
5792 | ||
5793 | For more on why fsync does not suffice even if it works properly, see: | |
5794 | Roche X. Necessary step(s) to synchronize filename operations on disk. | |
5795 | Austin Group Defect 672, 2013-03-19 | |
5796 | http://austingroupbugs.net/view.php?id=672 */ | |
5797 | write_region_inhibit_fsync = noninteractive; | |
9fe43ff6 PE |
5798 | } |
5799 | ||
dfcf069d | 5800 | void |
971de7fb | 5801 | syms_of_fileio (void) |
570d7624 | 5802 | { |
fe6aa7a1 BT |
5803 | #include "fileio.x" |
5804 | ||
cd3520a4 JB |
5805 | DEFSYM (Qoperations, "operations"); |
5806 | DEFSYM (Qexpand_file_name, "expand-file-name"); | |
5807 | DEFSYM (Qsubstitute_in_file_name, "substitute-in-file-name"); | |
5808 | DEFSYM (Qdirectory_file_name, "directory-file-name"); | |
5809 | DEFSYM (Qfile_name_directory, "file-name-directory"); | |
5810 | DEFSYM (Qfile_name_nondirectory, "file-name-nondirectory"); | |
5811 | DEFSYM (Qunhandled_file_name_directory, "unhandled-file-name-directory"); | |
5812 | DEFSYM (Qfile_name_as_directory, "file-name-as-directory"); | |
5813 | DEFSYM (Qcopy_file, "copy-file"); | |
5814 | DEFSYM (Qmake_directory_internal, "make-directory-internal"); | |
5815 | DEFSYM (Qmake_directory, "make-directory"); | |
5816 | DEFSYM (Qdelete_directory_internal, "delete-directory-internal"); | |
5817 | DEFSYM (Qdelete_file, "delete-file"); | |
5818 | DEFSYM (Qrename_file, "rename-file"); | |
5819 | DEFSYM (Qadd_name_to_file, "add-name-to-file"); | |
5820 | DEFSYM (Qmake_symbolic_link, "make-symbolic-link"); | |
5821 | DEFSYM (Qfile_exists_p, "file-exists-p"); | |
5822 | DEFSYM (Qfile_executable_p, "file-executable-p"); | |
5823 | DEFSYM (Qfile_readable_p, "file-readable-p"); | |
5824 | DEFSYM (Qfile_writable_p, "file-writable-p"); | |
5825 | DEFSYM (Qfile_symlink_p, "file-symlink-p"); | |
5826 | DEFSYM (Qaccess_file, "access-file"); | |
5827 | DEFSYM (Qfile_directory_p, "file-directory-p"); | |
5828 | DEFSYM (Qfile_regular_p, "file-regular-p"); | |
5829 | DEFSYM (Qfile_accessible_directory_p, "file-accessible-directory-p"); | |
5830 | DEFSYM (Qfile_modes, "file-modes"); | |
5831 | DEFSYM (Qset_file_modes, "set-file-modes"); | |
5832 | DEFSYM (Qset_file_times, "set-file-times"); | |
5833 | DEFSYM (Qfile_selinux_context, "file-selinux-context"); | |
5834 | DEFSYM (Qset_file_selinux_context, "set-file-selinux-context"); | |
7c3d167f RF |
5835 | DEFSYM (Qfile_acl, "file-acl"); |
5836 | DEFSYM (Qset_file_acl, "set-file-acl"); | |
cd3520a4 JB |
5837 | DEFSYM (Qfile_newer_than_file_p, "file-newer-than-file-p"); |
5838 | DEFSYM (Qinsert_file_contents, "insert-file-contents"); | |
9dbda100 | 5839 | DEFSYM (Qchoose_write_coding_system, "choose-write-coding-system"); |
cd3520a4 JB |
5840 | DEFSYM (Qwrite_region, "write-region"); |
5841 | DEFSYM (Qverify_visited_file_modtime, "verify-visited-file-modtime"); | |
5842 | DEFSYM (Qset_visited_file_modtime, "set-visited-file-modtime"); | |
5843 | DEFSYM (Qauto_save_coding, "auto-save-coding"); | |
5844 | ||
5845 | DEFSYM (Qfile_name_history, "file-name-history"); | |
642ef245 | 5846 | Fset (Qfile_name_history, Qnil); |
15c65264 | 5847 | |
cd3520a4 JB |
5848 | DEFSYM (Qfile_error, "file-error"); |
5849 | DEFSYM (Qfile_already_exists, "file-already-exists"); | |
5850 | DEFSYM (Qfile_date_error, "file-date-error"); | |
86dfb7a8 | 5851 | DEFSYM (Qfile_notify_error, "file-notify-error"); |
cd3520a4 | 5852 | DEFSYM (Qexcl, "excl"); |
570d7624 | 5853 | |
29208e82 | 5854 | DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system, |
fb7ada5f | 5855 | doc: /* Coding system for encoding file names. |
7df14908 EZ |
5856 | If it is nil, `default-file-name-coding-system' (which see) is used. |
5857 | ||
5858 | On MS-Windows, the value of this variable is largely ignored if | |
6630df25 EZ |
5859 | \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows |
5860 | behaves as if file names were encoded in `utf-8'. */); | |
b1d1b865 RS |
5861 | Vfile_name_coding_system = Qnil; |
5862 | ||
cd913586 | 5863 | DEFVAR_LISP ("default-file-name-coding-system", |
29208e82 | 5864 | Vdefault_file_name_coding_system, |
8c1a1077 | 5865 | doc: /* Default coding system for encoding file names. |
346ebf53 | 5866 | This variable is used only when `file-name-coding-system' is nil. |
8c1a1077 | 5867 | |
346ebf53 | 5868 | This variable is set/changed by the command `set-language-environment'. |
8c1a1077 | 5869 | User should not set this variable manually, |
346ebf53 | 5870 | instead use `file-name-coding-system' to get a constant encoding |
7df14908 EZ |
5871 | of file names regardless of the current language environment. |
5872 | ||
5873 | On MS-Windows, the value of this variable is largely ignored if | |
6630df25 EZ |
5874 | \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows |
5875 | behaves as if file names were encoded in `utf-8'. */); | |
cd913586 KH |
5876 | Vdefault_file_name_coding_system = Qnil; |
5877 | ||
cd3520a4 JB |
5878 | DEFSYM (Qformat_decode, "format-decode"); |
5879 | DEFSYM (Qformat_annotate_function, "format-annotate-function"); | |
5880 | DEFSYM (Qafter_insert_file_set_coding, "after-insert-file-set-coding"); | |
5881 | DEFSYM (Qcar_less_than_car, "car-less-than-car"); | |
d6a3cc15 | 5882 | |
570d7624 | 5883 | Fput (Qfile_error, Qerror_conditions, |
d67b4f80 | 5884 | Fpurecopy (list2 (Qfile_error, Qerror))); |
570d7624 | 5885 | Fput (Qfile_error, Qerror_message, |
2a0213a6 | 5886 | build_pure_c_string ("File error")); |
570d7624 JB |
5887 | |
5888 | Fput (Qfile_already_exists, Qerror_conditions, | |
d67b4f80 | 5889 | Fpurecopy (list3 (Qfile_already_exists, Qfile_error, Qerror))); |
570d7624 | 5890 | Fput (Qfile_already_exists, Qerror_message, |
2a0213a6 | 5891 | build_pure_c_string ("File already exists")); |
570d7624 | 5892 | |
c0b7b21c | 5893 | Fput (Qfile_date_error, Qerror_conditions, |
d67b4f80 | 5894 | Fpurecopy (list3 (Qfile_date_error, Qfile_error, Qerror))); |
c0b7b21c | 5895 | Fput (Qfile_date_error, Qerror_message, |
2a0213a6 | 5896 | build_pure_c_string ("Cannot set file date")); |
c0b7b21c | 5897 | |
86dfb7a8 MA |
5898 | Fput (Qfile_notify_error, Qerror_conditions, |
5899 | Fpurecopy (list3 (Qfile_notify_error, Qfile_error, Qerror))); | |
5900 | Fput (Qfile_notify_error, Qerror_message, | |
5901 | build_pure_c_string ("File notification error")); | |
5902 | ||
29208e82 | 5903 | DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist, |
a59225b1 CY |
5904 | doc: /* Alist of elements (REGEXP . HANDLER) for file names handled specially. |
5905 | If a file name matches REGEXP, all I/O on that file is done by calling | |
5906 | HANDLER. If a file name matches more than one handler, the handler | |
5907 | whose match starts last in the file name gets precedence. The | |
5908 | function `find-file-name-handler' checks this list for a handler for | |
5909 | its argument. | |
5910 | ||
5911 | HANDLER should be a function. The first argument given to it is the | |
5912 | name of the I/O primitive to be handled; the remaining arguments are | |
5913 | the arguments that were passed to that primitive. For example, if you | |
5914 | do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then | |
5915 | HANDLER is called like this: | |
5916 | ||
5917 | (funcall HANDLER 'file-exists-p FILENAME) | |
5918 | ||
5919 | Note that HANDLER must be able to handle all I/O primitives; if it has | |
5920 | nothing special to do for a primitive, it should reinvoke the | |
5921 | primitive to handle the operation \"the usual way\". | |
5922 | See Info node `(elisp)Magic File Names' for more details. */); | |
09121adc RS |
5923 | Vfile_name_handler_alist = Qnil; |
5924 | ||
0414b394 | 5925 | DEFVAR_LISP ("set-auto-coding-function", |
29208e82 | 5926 | Vset_auto_coding_function, |
8c1a1077 PJ |
5927 | doc: /* If non-nil, a function to call to decide a coding system of file. |
5928 | Two arguments are passed to this function: the file name | |
5929 | and the length of a file contents following the point. | |
5930 | This function should return a coding system to decode the file contents. | |
5931 | It should check the file name against `auto-coding-alist'. | |
5932 | If no coding system is decided, it should check a coding system | |
5933 | specified in the heading lines with the format: | |
5934 | -*- ... coding: CODING-SYSTEM; ... -*- | |
5935 | or local variable spec of the tailing lines with `coding:' tag. */); | |
0414b394 | 5936 | Vset_auto_coding_function = Qnil; |
c9e82392 | 5937 | |
29208e82 | 5938 | DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions, |
8c1a1077 | 5939 | doc: /* A list of functions to be called at the end of `insert-file-contents'. |
0cf9f5b5 RS |
5940 | Each is passed one argument, the number of characters inserted, |
5941 | with point at the start of the inserted text. Each function | |
5942 | should leave point the same, and return the new character count. | |
cf6d2357 RS |
5943 | If `insert-file-contents' is intercepted by a handler from |
5944 | `file-name-handler-alist', that handler is responsible for calling the | |
5945 | functions in `after-insert-file-functions' if appropriate. */); | |
d6a3cc15 RS |
5946 | Vafter_insert_file_functions = Qnil; |
5947 | ||
29208e82 | 5948 | DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions, |
8c1a1077 PJ |
5949 | doc: /* A list of functions to be called at the start of `write-region'. |
5950 | Each is passed two arguments, START and END as for `write-region'. | |
5951 | These are usually two numbers but not always; see the documentation | |
5952 | for `write-region'. The function should return a list of pairs | |
5953 | of the form (POSITION . STRING), consisting of strings to be effectively | |
5954 | inserted at the specified positions of the file being written (1 means to | |
5955 | insert before the first byte written). The POSITIONs must be sorted into | |
67fbc0cb CY |
5956 | increasing order. |
5957 | ||
5958 | If there are several annotation functions, the lists returned by these | |
5959 | functions are merged destructively. As each annotation function runs, | |
5960 | the variable `write-region-annotations-so-far' contains a list of all | |
5961 | annotations returned by previous annotation functions. | |
5962 | ||
5963 | An annotation function can return with a different buffer current. | |
5964 | Doing so removes the annotations returned by previous functions, and | |
5965 | resets START and END to `point-min' and `point-max' of the new buffer. | |
5966 | ||
5967 | After `write-region' completes, Emacs calls the function stored in | |
5968 | `write-region-post-annotation-function', once for each buffer that was | |
5969 | current when building the annotations (i.e., at least once), with that | |
5970 | buffer current. */); | |
d6a3cc15 | 5971 | Vwrite_region_annotate_functions = Qnil; |
cd3520a4 | 5972 | DEFSYM (Qwrite_region_annotate_functions, "write-region-annotate-functions"); |
d6a3cc15 | 5973 | |
67fbc0cb | 5974 | DEFVAR_LISP ("write-region-post-annotation-function", |
29208e82 | 5975 | Vwrite_region_post_annotation_function, |
67fbc0cb CY |
5976 | doc: /* Function to call after `write-region' completes. |
5977 | The function is called with no arguments. If one or more of the | |
5978 | annotation functions in `write-region-annotate-functions' changed the | |
5979 | current buffer, the function stored in this variable is called for | |
5980 | each of those additional buffers as well, in addition to the original | |
5981 | buffer. The relevant buffer is current during each function call. */); | |
5982 | Vwrite_region_post_annotation_function = Qnil; | |
5983 | staticpro (&Vwrite_region_annotation_buffers); | |
5984 | ||
6fc6f94b | 5985 | DEFVAR_LISP ("write-region-annotations-so-far", |
29208e82 | 5986 | Vwrite_region_annotations_so_far, |
8c1a1077 PJ |
5987 | doc: /* When an annotation function is called, this holds the previous annotations. |
5988 | These are the annotations made by other annotation functions | |
5989 | that were already called. See also `write-region-annotate-functions'. */); | |
6fc6f94b RS |
5990 | Vwrite_region_annotations_so_far = Qnil; |
5991 | ||
29208e82 | 5992 | DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers, |
8c1a1077 PJ |
5993 | doc: /* A list of file name handlers that temporarily should not be used. |
5994 | This applies only to the operation `inhibit-file-name-operation'. */); | |
82c2d839 RS |
5995 | Vinhibit_file_name_handlers = Qnil; |
5996 | ||
29208e82 | 5997 | DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation, |
8c1a1077 | 5998 | doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */); |
a65970a0 RS |
5999 | Vinhibit_file_name_operation = Qnil; |
6000 | ||
29208e82 | 6001 | DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name, |
8c1a1077 PJ |
6002 | doc: /* File name in which we write a list of all auto save file names. |
6003 | This variable is initialized automatically from `auto-save-list-file-prefix' | |
a2458031 | 6004 | shortly after Emacs reads your init file, if you have not yet given it |
8c1a1077 | 6005 | a non-nil value. */); |
e54d3b5d RS |
6006 | Vauto_save_list_file_name = Qnil; |
6007 | ||
29208e82 | 6008 | DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name, |
699b53bc CY |
6009 | doc: /* Non-nil says auto-save a buffer in the file it is visiting, when practical. |
6010 | Normally auto-save files are written under other names. */); | |
6011 | Vauto_save_visited_file_name = Qnil; | |
6012 | ||
29208e82 | 6013 | DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions, |
090101cf CY |
6014 | doc: /* If non-nil, auto-save even if a large part of the text is deleted. |
6015 | If nil, deleting a substantial portion of the text disables auto-save | |
6016 | in the buffer; this is the default behavior, because the auto-save | |
6017 | file is usually more useful if it contains the deleted text. */); | |
6018 | Vauto_save_include_big_deletions = Qnil; | |
6019 | ||
29208e82 | 6020 | DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync, |
fb7ada5f | 6021 | doc: /* Non-nil means don't call fsync in `write-region'. |
e3f509dd | 6022 | This variable affects calls to `write-region' as well as save commands. |
cbee2131 | 6023 | Setting this to nil may avoid data loss if the system loses power or |
6cbdfa01 | 6024 | the operating system crashes. By default, it is non-nil in batch mode. */); |
1db72ad3 | 6025 | write_region_inhibit_fsync = 0; /* See also `init_fileio' above. */ |
ccf61795 | 6026 | |
29208e82 | 6027 | DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash, |
6cf29fe8 | 6028 | doc: /* Specifies whether to use the system's trash can. |
f1a5d776 CY |
6029 | When non-nil, certain file deletion commands use the function |
6030 | `move-file-to-trash' instead of deleting files outright. | |
6031 | This includes interactive calls to `delete-file' and | |
6032 | `delete-directory' and the Dired deletion commands. */); | |
6cf29fe8 | 6033 | delete_by_moving_to_trash = 0; |
d67b4f80 | 6034 | Qdelete_by_moving_to_trash = intern_c_string ("delete-by-moving-to-trash"); |
cd3520a4 JB |
6035 | |
6036 | DEFSYM (Qmove_file_to_trash, "move-file-to-trash"); | |
6037 | DEFSYM (Qcopy_directory, "copy-directory"); | |
6038 | DEFSYM (Qdelete_directory, "delete-directory"); | |
ee041f2d | 6039 | DEFSYM (Qsubstitute_env_in_file_name, "substitute-env-in-file-name"); |
570d7624 | 6040 | } |