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