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