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