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