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