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