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