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