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