]> code.delx.au - gnu-emacs/blob - src/fileio.c
Use ASCII tests for character types.
[gnu-emacs] / 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 <setjmp.h>
27 #include <unistd.h>
28
29 #ifdef HAVE_PWD_H
30 #include <pwd.h>
31 #endif
32
33 #include <errno.h>
34
35 #ifdef HAVE_LIBSELINUX
36 #include <selinux/selinux.h>
37 #include <selinux/context.h>
38 #endif
39
40 #include <c-ctype.h>
41
42 #include "lisp.h"
43 #include "intervals.h"
44 #include "character.h"
45 #include "buffer.h"
46 #include "coding.h"
47 #include "window.h"
48 #include "blockinput.h"
49 #include "frame.h"
50 #include "dispextern.h"
51
52 #ifdef WINDOWSNT
53 #define NOMINMAX 1
54 #include <windows.h>
55 #include <fcntl.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 /* Nonzero during writing of auto-save files. */
89 static int auto_saving;
90
91 /* Nonzero umask during creation of auto-save directories. */
92 static int 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 int auto_save_mode_bits;
97
98 /* Set by auto_save_1 if an error occurred during the last auto-save. */
99 static int 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 int a_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t,
149 Lisp_Object *, struct coding_system *);
150 static int 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 non-zero 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, int 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 struct stat ignored;
673 unsigned num = make_temp_name_count;
674
675 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
676 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
677 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
678
679 /* Poor man's congruential RN generator. Replace with
680 ++make_temp_name_count for debugging. */
681 make_temp_name_count += 25229;
682 make_temp_name_count %= 225307;
683
684 if (stat (data, &ignored) < 0)
685 {
686 /* We want to return only if errno is ENOENT. */
687 if (errno == ENOENT)
688 return val;
689 else
690 /* The error here is dubious, but there is little else we
691 can do. The alternatives are to return nil, which is
692 as bad as (and in many cases worse than) throwing the
693 error, or to ignore the error, which will likely result
694 in looping through 225307 stat's, which is not only
695 dog-slow, but also useless since eventually nil would
696 have to be returned anyway. */
697 report_file_error ("Cannot create temporary name for prefix",
698 Fcons (prefix, Qnil));
699 /* not reached */
700 }
701 }
702 }
703
704
705 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
706 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
707 The Emacs process number forms part of the result,
708 so there is no danger of generating a name being used by another process.
709
710 In addition, this function makes an attempt to choose a name
711 which has no existing file. To make this work,
712 PREFIX should be an absolute file name.
713
714 There is a race condition between calling `make-temp-name' and creating the
715 file which opens all kinds of security holes. For that reason, you should
716 probably use `make-temp-file' instead, except in three circumstances:
717
718 * If you are creating the file in the user's home directory.
719 * If you are creating a directory rather than an ordinary file.
720 * If you are taking special precautions as `make-temp-file' does. */)
721 (Lisp_Object prefix)
722 {
723 return make_temp_name (prefix, 0);
724 }
725
726
727 \f
728 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
729 doc: /* Convert filename NAME to absolute, and canonicalize it.
730 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
731 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
732 the current buffer's value of `default-directory' is used.
733 NAME should be a string that is a valid file name for the underlying
734 filesystem.
735 File name components that are `.' are removed, and
736 so are file name components followed by `..', along with the `..' itself;
737 note that these simplifications are done without checking the resulting
738 file names in the file system.
739 Multiple consecutive slashes are collapsed into a single slash,
740 except at the beginning of the file name when they are significant (e.g.,
741 UNC file names on MS-Windows.)
742 An initial `~/' expands to your home directory.
743 An initial `~USER/' expands to USER's home directory.
744 See also the function `substitute-in-file-name'.
745
746 For technical reasons, this function can return correct but
747 non-intuitive results for the root directory; for instance,
748 \(expand-file-name ".." "/") returns "/..". For this reason, use
749 \(directory-file-name (file-name-directory dirname)) to traverse a
750 filesystem tree, not (expand-file-name ".." dirname). */)
751 (Lisp_Object name, Lisp_Object default_directory)
752 {
753 /* These point to SDATA and need to be careful with string-relocation
754 during GC (via DECODE_FILE). */
755 char *nm;
756 const char *newdir;
757 /* This should only point to alloca'd data. */
758 char *target;
759
760 ptrdiff_t tlen;
761 struct passwd *pw;
762 #ifdef DOS_NT
763 int drive = 0;
764 int collapse_newdir = 1;
765 int is_escaped = 0;
766 #endif /* DOS_NT */
767 ptrdiff_t length;
768 Lisp_Object handler, result, handled_name;
769 int multibyte;
770 Lisp_Object hdir;
771
772 CHECK_STRING (name);
773
774 /* If the file name has special constructs in it,
775 call the corresponding file handler. */
776 handler = Ffind_file_name_handler (name, Qexpand_file_name);
777 if (!NILP (handler))
778 {
779 handled_name = call3 (handler, Qexpand_file_name,
780 name, default_directory);
781 if (STRINGP (handled_name))
782 return handled_name;
783 error ("Invalid handler in `file-name-handler-alist'");
784 }
785
786
787 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
788 if (NILP (default_directory))
789 default_directory = BVAR (current_buffer, directory);
790 if (! STRINGP (default_directory))
791 {
792 #ifdef DOS_NT
793 /* "/" is not considered a root directory on DOS_NT, so using "/"
794 here causes an infinite recursion in, e.g., the following:
795
796 (let (default-directory)
797 (expand-file-name "a"))
798
799 To avoid this, we set default_directory to the root of the
800 current drive. */
801 default_directory = build_string (emacs_root_dir ());
802 #else
803 default_directory = build_string ("/");
804 #endif
805 }
806
807 if (!NILP (default_directory))
808 {
809 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
810 if (!NILP (handler))
811 {
812 handled_name = call3 (handler, Qexpand_file_name,
813 name, default_directory);
814 if (STRINGP (handled_name))
815 return handled_name;
816 error ("Invalid handler in `file-name-handler-alist'");
817 }
818 }
819
820 {
821 char *o = SSDATA (default_directory);
822
823 /* Make sure DEFAULT_DIRECTORY is properly expanded.
824 It would be better to do this down below where we actually use
825 default_directory. Unfortunately, calling Fexpand_file_name recursively
826 could invoke GC, and the strings might be relocated. This would
827 be annoying because we have pointers into strings lying around
828 that would need adjusting, and people would add new pointers to
829 the code and forget to adjust them, resulting in intermittent bugs.
830 Putting this call here avoids all that crud.
831
832 The EQ test avoids infinite recursion. */
833 if (! NILP (default_directory) && !EQ (default_directory, name)
834 /* Save time in some common cases - as long as default_directory
835 is not relative, it can be canonicalized with name below (if it
836 is needed at all) without requiring it to be expanded now. */
837 #ifdef DOS_NT
838 /* Detect MSDOS file names with drive specifiers. */
839 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
840 && IS_DIRECTORY_SEP (o[2]))
841 #ifdef WINDOWSNT
842 /* Detect Windows file names in UNC format. */
843 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
844 #endif
845 #else /* not DOS_NT */
846 /* Detect Unix absolute file names (/... alone is not absolute on
847 DOS or Windows). */
848 && ! (IS_DIRECTORY_SEP (o[0]))
849 #endif /* not DOS_NT */
850 )
851 {
852 struct gcpro gcpro1;
853
854 GCPRO1 (name);
855 default_directory = Fexpand_file_name (default_directory, Qnil);
856 UNGCPRO;
857 }
858 }
859 multibyte = STRING_MULTIBYTE (name);
860 if (multibyte != STRING_MULTIBYTE (default_directory))
861 {
862 if (multibyte)
863 default_directory = string_to_multibyte (default_directory);
864 else
865 {
866 name = string_to_multibyte (name);
867 multibyte = 1;
868 }
869 }
870
871 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
872 nm = alloca (SBYTES (name) + 1);
873 memcpy (nm, SSDATA (name), SBYTES (name) + 1);
874
875 #ifdef DOS_NT
876 /* Note if special escape prefix is present, but remove for now. */
877 if (nm[0] == '/' && nm[1] == ':')
878 {
879 is_escaped = 1;
880 nm += 2;
881 }
882
883 /* Find and remove drive specifier if present; this makes nm absolute
884 even if the rest of the name appears to be relative. Only look for
885 drive specifier at the beginning. */
886 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
887 {
888 drive = (unsigned char) nm[0];
889 nm += 2;
890 }
891
892 #ifdef WINDOWSNT
893 /* If we see "c://somedir", we want to strip the first slash after the
894 colon when stripping the drive letter. Otherwise, this expands to
895 "//somedir". */
896 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
897 nm++;
898
899 /* Discard any previous drive specifier if nm is now in UNC format. */
900 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
901 {
902 drive = 0;
903 }
904 #endif /* WINDOWSNT */
905 #endif /* DOS_NT */
906
907 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
908 none are found, we can probably return right away. We will avoid
909 allocating a new string if name is already fully expanded. */
910 if (
911 IS_DIRECTORY_SEP (nm[0])
912 #ifdef MSDOS
913 && drive && !is_escaped
914 #endif
915 #ifdef WINDOWSNT
916 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
917 #endif
918 )
919 {
920 /* If it turns out that the filename we want to return is just a
921 suffix of FILENAME, we don't need to go through and edit
922 things; we just need to construct a new string using data
923 starting at the middle of FILENAME. If we set lose to a
924 non-zero value, that means we've discovered that we can't do
925 that cool trick. */
926 int lose = 0;
927 char *p = nm;
928
929 while (*p)
930 {
931 /* Since we know the name is absolute, we can assume that each
932 element starts with a "/". */
933
934 /* "." and ".." are hairy. */
935 if (IS_DIRECTORY_SEP (p[0])
936 && p[1] == '.'
937 && (IS_DIRECTORY_SEP (p[2])
938 || p[2] == 0
939 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
940 || p[3] == 0))))
941 lose = 1;
942 /* We want to replace multiple `/' in a row with a single
943 slash. */
944 else if (p > nm
945 && IS_DIRECTORY_SEP (p[0])
946 && IS_DIRECTORY_SEP (p[1]))
947 lose = 1;
948 p++;
949 }
950 if (!lose)
951 {
952 #ifdef DOS_NT
953 /* Make sure directories are all separated with /, but
954 avoid allocation of a new string when not required. */
955 dostounix_filename (nm);
956 #ifdef WINDOWSNT
957 if (IS_DIRECTORY_SEP (nm[1]))
958 {
959 if (strcmp (nm, SSDATA (name)) != 0)
960 name = make_specified_string (nm, -1, strlen (nm), multibyte);
961 }
962 else
963 #endif
964 /* Drive must be set, so this is okay. */
965 if (strcmp (nm - 2, SSDATA (name)) != 0)
966 {
967 char temp[] = " :";
968
969 name = make_specified_string (nm, -1, p - nm, multibyte);
970 temp[0] = DRIVE_LETTER (drive);
971 name = concat2 (build_string (temp), name);
972 }
973 return name;
974 #else /* not DOS_NT */
975 if (strcmp (nm, SSDATA (name)) == 0)
976 return name;
977 return make_specified_string (nm, -1, strlen (nm), multibyte);
978 #endif /* not DOS_NT */
979 }
980 }
981
982 /* At this point, nm might or might not be an absolute file name. We
983 need to expand ~ or ~user if present, otherwise prefix nm with
984 default_directory if nm is not absolute, and finally collapse /./
985 and /foo/../ sequences.
986
987 We set newdir to be the appropriate prefix if one is needed:
988 - the relevant user directory if nm starts with ~ or ~user
989 - the specified drive's working dir (DOS/NT only) if nm does not
990 start with /
991 - the value of default_directory.
992
993 Note that these prefixes are not guaranteed to be absolute (except
994 for the working dir of a drive). Therefore, to ensure we always
995 return an absolute name, if the final prefix is not absolute we
996 append it to the current working directory. */
997
998 newdir = 0;
999
1000 if (nm[0] == '~') /* prefix ~ */
1001 {
1002 if (IS_DIRECTORY_SEP (nm[1])
1003 || nm[1] == 0) /* ~ by itself */
1004 {
1005 Lisp_Object tem;
1006
1007 if (!(newdir = egetenv ("HOME")))
1008 newdir = "";
1009 nm++;
1010 /* `egetenv' may return a unibyte string, which will bite us since
1011 we expect the directory to be multibyte. */
1012 tem = build_string (newdir);
1013 if (!STRING_MULTIBYTE (tem))
1014 {
1015 hdir = DECODE_FILE (tem);
1016 newdir = SSDATA (hdir);
1017 }
1018 #ifdef DOS_NT
1019 collapse_newdir = 0;
1020 #endif
1021 }
1022 else /* ~user/filename */
1023 {
1024 char *o, *p;
1025 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)); p++);
1026 o = alloca (p - nm + 1);
1027 memcpy (o, nm, p - nm);
1028 o [p - nm] = 0;
1029
1030 BLOCK_INPUT;
1031 pw = (struct passwd *) getpwnam (o + 1);
1032 UNBLOCK_INPUT;
1033 if (pw)
1034 {
1035 newdir = pw->pw_dir;
1036 nm = p;
1037 #ifdef DOS_NT
1038 collapse_newdir = 0;
1039 #endif
1040 }
1041
1042 /* If we don't find a user of that name, leave the name
1043 unchanged; don't move nm forward to p. */
1044 }
1045 }
1046
1047 #ifdef DOS_NT
1048 /* On DOS and Windows, nm is absolute if a drive name was specified;
1049 use the drive's current directory as the prefix if needed. */
1050 if (!newdir && drive)
1051 {
1052 /* Get default directory if needed to make nm absolute. */
1053 char *adir = NULL;
1054 if (!IS_DIRECTORY_SEP (nm[0]))
1055 {
1056 adir = alloca (MAXPATHLEN + 1);
1057 if (!getdefdir (c_toupper (drive) - 'A' + 1, adir))
1058 adir = NULL;
1059 }
1060 if (!adir)
1061 {
1062 /* Either nm starts with /, or drive isn't mounted. */
1063 adir = alloca (4);
1064 adir[0] = DRIVE_LETTER (drive);
1065 adir[1] = ':';
1066 adir[2] = '/';
1067 adir[3] = 0;
1068 }
1069 newdir = adir;
1070 }
1071 #endif /* DOS_NT */
1072
1073 /* Finally, if no prefix has been specified and nm is not absolute,
1074 then it must be expanded relative to default_directory. */
1075
1076 if (1
1077 #ifndef DOS_NT
1078 /* /... alone is not absolute on DOS and Windows. */
1079 && !IS_DIRECTORY_SEP (nm[0])
1080 #endif
1081 #ifdef WINDOWSNT
1082 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1083 #endif
1084 && !newdir)
1085 {
1086 newdir = SSDATA (default_directory);
1087 #ifdef DOS_NT
1088 /* Note if special escape prefix is present, but remove for now. */
1089 if (newdir[0] == '/' && newdir[1] == ':')
1090 {
1091 is_escaped = 1;
1092 newdir += 2;
1093 }
1094 #endif
1095 }
1096
1097 #ifdef DOS_NT
1098 if (newdir)
1099 {
1100 /* First ensure newdir is an absolute name. */
1101 if (
1102 /* Detect MSDOS file names with drive specifiers. */
1103 ! (IS_DRIVE (newdir[0])
1104 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1105 #ifdef WINDOWSNT
1106 /* Detect Windows file names in UNC format. */
1107 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1108 #endif
1109 )
1110 {
1111 /* Effectively, let newdir be (expand-file-name newdir cwd).
1112 Because of the admonition against calling expand-file-name
1113 when we have pointers into lisp strings, we accomplish this
1114 indirectly by prepending newdir to nm if necessary, and using
1115 cwd (or the wd of newdir's drive) as the new newdir. */
1116 char *adir;
1117 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1118 {
1119 drive = (unsigned char) newdir[0];
1120 newdir += 2;
1121 }
1122 if (!IS_DIRECTORY_SEP (nm[0]))
1123 {
1124 ptrdiff_t newlen = strlen (newdir);
1125 char *tmp = alloca (newlen + strlen (nm) + 2);
1126 file_name_as_directory (tmp, newdir, newlen);
1127 strcat (tmp, nm);
1128 nm = tmp;
1129 }
1130 adir = alloca (MAXPATHLEN + 1);
1131 if (drive)
1132 {
1133 if (!getdefdir (c_toupper (drive) - 'A' + 1, adir))
1134 newdir = "/";
1135 }
1136 else
1137 getwd (adir);
1138 newdir = adir;
1139 }
1140
1141 /* Strip off drive name from prefix, if present. */
1142 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1143 {
1144 drive = newdir[0];
1145 newdir += 2;
1146 }
1147
1148 /* Keep only a prefix from newdir if nm starts with slash
1149 (//server/share for UNC, nothing otherwise). */
1150 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1151 {
1152 #ifdef WINDOWSNT
1153 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1154 {
1155 char *adir = strcpy (alloca (strlen (newdir) + 1), newdir);
1156 char *p = adir + 2;
1157 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1158 p++;
1159 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1160 *p = 0;
1161 newdir = adir;
1162 }
1163 else
1164 #endif
1165 newdir = "";
1166 }
1167 }
1168 #endif /* DOS_NT */
1169
1170 if (newdir)
1171 {
1172 /* Get rid of any slash at the end of newdir, unless newdir is
1173 just / or // (an incomplete UNC name). */
1174 length = strlen (newdir);
1175 tlen = length + 1;
1176 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1177 #ifdef WINDOWSNT
1178 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1179 #endif
1180 )
1181 {
1182 char *temp = alloca (length);
1183 memcpy (temp, newdir, length - 1);
1184 temp[length - 1] = 0;
1185 length--;
1186 newdir = temp;
1187 }
1188 }
1189 else
1190 {
1191 length = 0;
1192 tlen = 0;
1193 }
1194
1195 /* Now concatenate the directory and name to new space in the stack frame. */
1196 tlen += strlen (nm) + 1;
1197 #ifdef DOS_NT
1198 /* Reserve space for drive specifier and escape prefix, since either
1199 or both may need to be inserted. (The Microsoft x86 compiler
1200 produces incorrect code if the following two lines are combined.) */
1201 target = alloca (tlen + 4);
1202 target += 4;
1203 #else /* not DOS_NT */
1204 target = alloca (tlen);
1205 #endif /* not DOS_NT */
1206 *target = 0;
1207
1208 if (newdir)
1209 {
1210 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1211 {
1212 #ifdef DOS_NT
1213 /* If newdir is effectively "C:/", then the drive letter will have
1214 been stripped and newdir will be "/". Concatenating with an
1215 absolute directory in nm produces "//", which will then be
1216 incorrectly treated as a network share. Ignore newdir in
1217 this case (keeping the drive letter). */
1218 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1219 && newdir[1] == '\0'))
1220 #endif
1221 strcpy (target, newdir);
1222 }
1223 else
1224 file_name_as_directory (target, newdir, length);
1225 }
1226
1227 strcat (target, nm);
1228
1229 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1230 appear. */
1231 {
1232 char *p = target;
1233 char *o = target;
1234
1235 while (*p)
1236 {
1237 if (!IS_DIRECTORY_SEP (*p))
1238 {
1239 *o++ = *p++;
1240 }
1241 else if (p[1] == '.'
1242 && (IS_DIRECTORY_SEP (p[2])
1243 || p[2] == 0))
1244 {
1245 /* If "/." is the entire filename, keep the "/". Otherwise,
1246 just delete the whole "/.". */
1247 if (o == target && p[2] == '\0')
1248 *o++ = *p;
1249 p += 2;
1250 }
1251 else if (p[1] == '.' && p[2] == '.'
1252 /* `/../' is the "superroot" on certain file systems.
1253 Turned off on DOS_NT systems because they have no
1254 "superroot" and because this causes us to produce
1255 file names like "d:/../foo" which fail file-related
1256 functions of the underlying OS. (To reproduce, try a
1257 long series of "../../" in default_directory, longer
1258 than the number of levels from the root.) */
1259 #ifndef DOS_NT
1260 && o != target
1261 #endif
1262 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1263 {
1264 #ifdef WINDOWSNT
1265 char *prev_o = o;
1266 #endif
1267 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1268 ;
1269 #ifdef WINDOWSNT
1270 /* Don't go below server level in UNC filenames. */
1271 if (o == target + 1 && IS_DIRECTORY_SEP (*o)
1272 && IS_DIRECTORY_SEP (*target))
1273 o = prev_o;
1274 else
1275 #endif
1276 /* Keep initial / only if this is the whole name. */
1277 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1278 ++o;
1279 p += 3;
1280 }
1281 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1282 /* Collapse multiple `/' in a row. */
1283 p++;
1284 else
1285 {
1286 *o++ = *p++;
1287 }
1288 }
1289
1290 #ifdef DOS_NT
1291 /* At last, set drive name. */
1292 #ifdef WINDOWSNT
1293 /* Except for network file name. */
1294 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1295 #endif /* WINDOWSNT */
1296 {
1297 if (!drive) abort ();
1298 target -= 2;
1299 target[0] = DRIVE_LETTER (drive);
1300 target[1] = ':';
1301 }
1302 /* Reinsert the escape prefix if required. */
1303 if (is_escaped)
1304 {
1305 target -= 2;
1306 target[0] = '/';
1307 target[1] = ':';
1308 }
1309 dostounix_filename (target);
1310 #endif /* DOS_NT */
1311
1312 result = make_specified_string (target, -1, o - target, multibyte);
1313 }
1314
1315 /* Again look to see if the file name has special constructs in it
1316 and perhaps call the corresponding file handler. This is needed
1317 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1318 the ".." component gives us "/user@host:/bar/../baz" which needs
1319 to be expanded again. */
1320 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1321 if (!NILP (handler))
1322 {
1323 handled_name = call3 (handler, Qexpand_file_name,
1324 result, default_directory);
1325 if (STRINGP (handled_name))
1326 return handled_name;
1327 error ("Invalid handler in `file-name-handler-alist'");
1328 }
1329
1330 return result;
1331 }
1332
1333 #if 0
1334 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1335 This is the old version of expand-file-name, before it was thoroughly
1336 rewritten for Emacs 10.31. We leave this version here commented-out,
1337 because the code is very complex and likely to have subtle bugs. If
1338 bugs _are_ found, it might be of interest to look at the old code and
1339 see what did it do in the relevant situation.
1340
1341 Don't remove this code: it's true that it will be accessible
1342 from the repository, but a few years from deletion, people will
1343 forget it is there. */
1344
1345 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1346 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1347 "Convert FILENAME to absolute, and canonicalize it.\n\
1348 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1349 \(does not start with slash); if DEFAULT is nil or missing,\n\
1350 the current buffer's value of default-directory is used.\n\
1351 Filenames containing `.' or `..' as components are simplified;\n\
1352 initial `~/' expands to your home directory.\n\
1353 See also the function `substitute-in-file-name'.")
1354 (name, defalt)
1355 Lisp_Object name, defalt;
1356 {
1357 unsigned char *nm;
1358
1359 register unsigned char *newdir, *p, *o;
1360 ptrdiff_t tlen;
1361 unsigned char *target;
1362 struct passwd *pw;
1363 int lose;
1364
1365 CHECK_STRING (name);
1366 nm = SDATA (name);
1367
1368 /* If nm is absolute, flush ...// and detect /./ and /../.
1369 If no /./ or /../ we can return right away. */
1370 if (nm[0] == '/')
1371 {
1372 p = nm;
1373 lose = 0;
1374 while (*p)
1375 {
1376 if (p[0] == '/' && p[1] == '/'
1377 )
1378 nm = p + 1;
1379 if (p[0] == '/' && p[1] == '~')
1380 nm = p + 1, lose = 1;
1381 if (p[0] == '/' && p[1] == '.'
1382 && (p[2] == '/' || p[2] == 0
1383 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1384 lose = 1;
1385 p++;
1386 }
1387 if (!lose)
1388 {
1389 if (nm == SDATA (name))
1390 return name;
1391 return build_string (nm);
1392 }
1393 }
1394
1395 /* Now determine directory to start with and put it in NEWDIR. */
1396
1397 newdir = 0;
1398
1399 if (nm[0] == '~') /* prefix ~ */
1400 if (nm[1] == '/' || nm[1] == 0)/* ~/filename */
1401 {
1402 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1403 newdir = (unsigned char *) "";
1404 nm++;
1405 }
1406 else /* ~user/filename */
1407 {
1408 /* Get past ~ to user. */
1409 unsigned char *user = nm + 1;
1410 /* Find end of name. */
1411 unsigned char *ptr = (unsigned char *) strchr (user, '/');
1412 ptrdiff_t len = ptr ? ptr - user : strlen (user);
1413 /* Copy the user name into temp storage. */
1414 o = alloca (len + 1);
1415 memcpy (o, user, len);
1416 o[len] = 0;
1417
1418 /* Look up the user name. */
1419 BLOCK_INPUT;
1420 pw = (struct passwd *) getpwnam (o + 1);
1421 UNBLOCK_INPUT;
1422 if (!pw)
1423 error ("\"%s\" isn't a registered user", o + 1);
1424
1425 newdir = (unsigned char *) pw->pw_dir;
1426
1427 /* Discard the user name from NM. */
1428 nm += len;
1429 }
1430
1431 if (nm[0] != '/' && !newdir)
1432 {
1433 if (NILP (defalt))
1434 defalt = current_buffer->directory;
1435 CHECK_STRING (defalt);
1436 newdir = SDATA (defalt);
1437 }
1438
1439 /* Now concatenate the directory and name to new space in the stack frame. */
1440
1441 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1442 target = alloca (tlen);
1443 *target = 0;
1444
1445 if (newdir)
1446 {
1447 if (nm[0] == 0 || nm[0] == '/')
1448 strcpy (target, newdir);
1449 else
1450 file_name_as_directory (target, newdir);
1451 }
1452
1453 strcat (target, nm);
1454
1455 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1456
1457 p = target;
1458 o = target;
1459
1460 while (*p)
1461 {
1462 if (*p != '/')
1463 {
1464 *o++ = *p++;
1465 }
1466 else if (!strncmp (p, "//", 2)
1467 )
1468 {
1469 o = target;
1470 p++;
1471 }
1472 else if (p[0] == '/' && p[1] == '.'
1473 && (p[2] == '/' || p[2] == 0))
1474 p += 2;
1475 else if (!strncmp (p, "/..", 3)
1476 /* `/../' is the "superroot" on certain file systems. */
1477 && o != target
1478 && (p[3] == '/' || p[3] == 0))
1479 {
1480 while (o != target && *--o != '/')
1481 ;
1482 if (o == target && *o == '/')
1483 ++o;
1484 p += 3;
1485 }
1486 else
1487 {
1488 *o++ = *p++;
1489 }
1490 }
1491
1492 return make_string (target, o - target);
1493 }
1494 #endif
1495 \f
1496 /* If /~ or // appears, discard everything through first slash. */
1497 static int
1498 file_name_absolute_p (const char *filename)
1499 {
1500 return
1501 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
1502 #ifdef DOS_NT
1503 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
1504 && IS_DIRECTORY_SEP (filename[2]))
1505 #endif
1506 );
1507 }
1508
1509 static char *
1510 search_embedded_absfilename (char *nm, char *endp)
1511 {
1512 char *p, *s;
1513
1514 for (p = nm + 1; p < endp; p++)
1515 {
1516 if ((0
1517 || IS_DIRECTORY_SEP (p[-1]))
1518 && file_name_absolute_p (p)
1519 #if defined (WINDOWSNT) || defined (CYGWIN)
1520 /* // at start of file name is meaningful in Apollo,
1521 WindowsNT and Cygwin systems. */
1522 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
1523 #endif /* not (WINDOWSNT || CYGWIN) */
1524 )
1525 {
1526 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)); s++);
1527 if (p[0] == '~' && s > p + 1) /* We've got "/~something/". */
1528 {
1529 char *o = alloca (s - p + 1);
1530 struct passwd *pw;
1531 memcpy (o, p, s - p);
1532 o [s - p] = 0;
1533
1534 /* If we have ~user and `user' exists, discard
1535 everything up to ~. But if `user' does not exist, leave
1536 ~user alone, it might be a literal file name. */
1537 BLOCK_INPUT;
1538 pw = getpwnam (o + 1);
1539 UNBLOCK_INPUT;
1540 if (pw)
1541 return p;
1542 }
1543 else
1544 return p;
1545 }
1546 }
1547 return NULL;
1548 }
1549
1550 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
1551 Ssubstitute_in_file_name, 1, 1, 0,
1552 doc: /* Substitute environment variables referred to in FILENAME.
1553 `$FOO' where FOO is an environment variable name means to substitute
1554 the value of that variable. The variable name should be terminated
1555 with a character not a letter, digit or underscore; otherwise, enclose
1556 the entire variable name in braces.
1557
1558 If `/~' appears, all of FILENAME through that `/' is discarded.
1559 If `//' appears, everything up to and including the first of
1560 those `/' is discarded. */)
1561 (Lisp_Object filename)
1562 {
1563 char *nm;
1564
1565 register char *s, *p, *o, *x, *endp;
1566 char *target = NULL;
1567 int total = 0;
1568 int substituted = 0;
1569 int multibyte;
1570 char *xnm;
1571 Lisp_Object handler;
1572
1573 CHECK_STRING (filename);
1574
1575 multibyte = STRING_MULTIBYTE (filename);
1576
1577 /* If the file name has special constructs in it,
1578 call the corresponding file handler. */
1579 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
1580 if (!NILP (handler))
1581 {
1582 Lisp_Object handled_name = call2 (handler, Qsubstitute_in_file_name,
1583 filename);
1584 if (STRINGP (handled_name))
1585 return handled_name;
1586 error ("Invalid handler in `file-name-handler-alist'");
1587 }
1588
1589 /* Always work on a copy of the string, in case GC happens during
1590 decode of environment variables, causing the original Lisp_String
1591 data to be relocated. */
1592 nm = alloca (SBYTES (filename) + 1);
1593 memcpy (nm, SDATA (filename), SBYTES (filename) + 1);
1594
1595 #ifdef DOS_NT
1596 dostounix_filename (nm);
1597 substituted = (strcmp (nm, SDATA (filename)) != 0);
1598 #endif
1599 endp = nm + SBYTES (filename);
1600
1601 /* If /~ or // appears, discard everything through first slash. */
1602 p = search_embedded_absfilename (nm, endp);
1603 if (p)
1604 /* Start over with the new string, so we check the file-name-handler
1605 again. Important with filenames like "/home/foo//:/hello///there"
1606 which would substitute to "/:/hello///there" rather than "/there". */
1607 return Fsubstitute_in_file_name
1608 (make_specified_string (p, -1, endp - p, multibyte));
1609
1610 /* See if any variables are substituted into the string
1611 and find the total length of their values in `total'. */
1612
1613 for (p = nm; p != endp;)
1614 if (*p != '$')
1615 p++;
1616 else
1617 {
1618 p++;
1619 if (p == endp)
1620 goto badsubst;
1621 else if (*p == '$')
1622 {
1623 /* "$$" means a single "$". */
1624 p++;
1625 total -= 1;
1626 substituted = 1;
1627 continue;
1628 }
1629 else if (*p == '{')
1630 {
1631 o = ++p;
1632 while (p != endp && *p != '}') p++;
1633 if (*p != '}') goto missingclose;
1634 s = p;
1635 }
1636 else
1637 {
1638 o = p;
1639 while (p != endp && (c_isalnum (*p) || *p == '_')) p++;
1640 s = p;
1641 }
1642
1643 /* Copy out the variable name. */
1644 target = alloca (s - o + 1);
1645 memcpy (target, o, s - o);
1646 target[s - o] = 0;
1647 #ifdef DOS_NT
1648 strupr (target); /* $home == $HOME etc. */
1649 #endif /* DOS_NT */
1650
1651 /* Get variable value. */
1652 o = egetenv (target);
1653 if (o)
1654 {
1655 /* Don't try to guess a maximum length - UTF8 can use up to
1656 four bytes per character. This code is unlikely to run
1657 in a situation that requires performance, so decoding the
1658 env variables twice should be acceptable. Note that
1659 decoding may cause a garbage collect. */
1660 Lisp_Object orig, decoded;
1661 orig = build_unibyte_string (o);
1662 decoded = DECODE_FILE (orig);
1663 total += SBYTES (decoded);
1664 substituted = 1;
1665 }
1666 else if (*p == '}')
1667 goto badvar;
1668 }
1669
1670 if (!substituted)
1671 return filename;
1672
1673 /* If substitution required, recopy the string and do it. */
1674 /* Make space in stack frame for the new copy. */
1675 xnm = alloca (SBYTES (filename) + total + 1);
1676 x = xnm;
1677
1678 /* Copy the rest of the name through, replacing $ constructs with values. */
1679 for (p = nm; *p;)
1680 if (*p != '$')
1681 *x++ = *p++;
1682 else
1683 {
1684 p++;
1685 if (p == endp)
1686 goto badsubst;
1687 else if (*p == '$')
1688 {
1689 *x++ = *p++;
1690 continue;
1691 }
1692 else if (*p == '{')
1693 {
1694 o = ++p;
1695 while (p != endp && *p != '}') p++;
1696 if (*p != '}') goto missingclose;
1697 s = p++;
1698 }
1699 else
1700 {
1701 o = p;
1702 while (p != endp && (c_isalnum (*p) || *p == '_')) p++;
1703 s = p;
1704 }
1705
1706 /* Copy out the variable name. */
1707 target = alloca (s - o + 1);
1708 memcpy (target, o, s - o);
1709 target[s - o] = 0;
1710 #ifdef DOS_NT
1711 strupr (target); /* $home == $HOME etc. */
1712 #endif /* DOS_NT */
1713
1714 /* Get variable value. */
1715 o = egetenv (target);
1716 if (!o)
1717 {
1718 *x++ = '$';
1719 strcpy (x, target); x+= strlen (target);
1720 }
1721 else
1722 {
1723 Lisp_Object orig, decoded;
1724 ptrdiff_t orig_length, decoded_length;
1725 orig_length = strlen (o);
1726 orig = make_unibyte_string (o, orig_length);
1727 decoded = DECODE_FILE (orig);
1728 decoded_length = SBYTES (decoded);
1729 memcpy (x, SDATA (decoded), decoded_length);
1730 x += decoded_length;
1731
1732 /* If environment variable needed decoding, return value
1733 needs to be multibyte. */
1734 if (decoded_length != orig_length
1735 || memcmp (SDATA (decoded), o, orig_length))
1736 multibyte = 1;
1737 }
1738 }
1739
1740 *x = 0;
1741
1742 /* If /~ or // appears, discard everything through first slash. */
1743 while ((p = search_embedded_absfilename (xnm, x)))
1744 /* This time we do not start over because we've already expanded envvars
1745 and replaced $$ with $. Maybe we should start over as well, but we'd
1746 need to quote some $ to $$ first. */
1747 xnm = p;
1748
1749 return make_specified_string (xnm, -1, x - xnm, multibyte);
1750
1751 badsubst:
1752 error ("Bad format environment-variable substitution");
1753 missingclose:
1754 error ("Missing \"}\" in environment-variable substitution");
1755 badvar:
1756 error ("Substituting nonexistent environment variable \"%s\"", target);
1757
1758 /* NOTREACHED */
1759 return Qnil;
1760 }
1761 \f
1762 /* A slightly faster and more convenient way to get
1763 (directory-file-name (expand-file-name FOO)). */
1764
1765 Lisp_Object
1766 expand_and_dir_to_file (Lisp_Object filename, Lisp_Object defdir)
1767 {
1768 register Lisp_Object absname;
1769
1770 absname = Fexpand_file_name (filename, defdir);
1771
1772 /* Remove final slash, if any (unless this is the root dir).
1773 stat behaves differently depending! */
1774 if (SCHARS (absname) > 1
1775 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
1776 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname) - 2)))
1777 /* We cannot take shortcuts; they might be wrong for magic file names. */
1778 absname = Fdirectory_file_name (absname);
1779 return absname;
1780 }
1781 \f
1782 /* Signal an error if the file ABSNAME already exists.
1783 If INTERACTIVE is nonzero, ask the user whether to proceed,
1784 and bypass the error if the user says to go ahead.
1785 QUERYSTRING is a name for the action that is being considered
1786 to alter the file.
1787
1788 *STATPTR is used to store the stat information if the file exists.
1789 If the file does not exist, STATPTR->st_mode is set to 0.
1790 If STATPTR is null, we don't store into it.
1791
1792 If QUICK is nonzero, we ask for y or n, not yes or no. */
1793
1794 static void
1795 barf_or_query_if_file_exists (Lisp_Object absname, const char *querystring,
1796 int interactive, struct stat *statptr, int quick)
1797 {
1798 register Lisp_Object tem, encoded_filename;
1799 struct stat statbuf;
1800 struct gcpro gcpro1;
1801
1802 encoded_filename = ENCODE_FILE (absname);
1803
1804 /* `stat' is a good way to tell whether the file exists,
1805 regardless of what access permissions it has. */
1806 if (lstat (SSDATA (encoded_filename), &statbuf) >= 0)
1807 {
1808 if (S_ISDIR (statbuf.st_mode))
1809 xsignal2 (Qfile_error,
1810 build_string ("File is a directory"), absname);
1811
1812 if (! interactive)
1813 xsignal2 (Qfile_already_exists,
1814 build_string ("File already exists"), absname);
1815 GCPRO1 (absname);
1816 tem = format2 ("File %s already exists; %s anyway? ",
1817 absname, build_string (querystring));
1818 if (quick)
1819 tem = call1 (intern ("y-or-n-p"), tem);
1820 else
1821 tem = do_yes_or_no_p (tem);
1822 UNGCPRO;
1823 if (NILP (tem))
1824 xsignal2 (Qfile_already_exists,
1825 build_string ("File already exists"), absname);
1826 if (statptr)
1827 *statptr = statbuf;
1828 }
1829 else
1830 {
1831 if (statptr)
1832 statptr->st_mode = 0;
1833 }
1834 return;
1835 }
1836
1837 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 6,
1838 "fCopy file: \nGCopy %s to file: \np\nP",
1839 doc: /* Copy FILE to NEWNAME. Both args must be strings.
1840 If NEWNAME names a directory, copy FILE there.
1841
1842 This function always sets the file modes of the output file to match
1843 the input file.
1844
1845 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1846 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1847 signal a `file-already-exists' error without overwriting. If
1848 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1849 about overwriting; this is what happens in interactive use with M-x.
1850 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1851 existing file.
1852
1853 Fourth arg KEEP-TIME non-nil means give the output file the same
1854 last-modified time as the old one. (This works on only some systems.)
1855
1856 A prefix arg makes KEEP-TIME non-nil.
1857
1858 If PRESERVE-UID-GID is non-nil, we try to transfer the
1859 uid and gid of FILE to NEWNAME.
1860
1861 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1862 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1863 (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)
1864 {
1865 int ifd, ofd;
1866 int n;
1867 char buf[16 * 1024];
1868 struct stat st, out_st;
1869 Lisp_Object handler;
1870 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1871 ptrdiff_t count = SPECPDL_INDEX ();
1872 int input_file_statable_p;
1873 Lisp_Object encoded_file, encoded_newname;
1874 #if HAVE_LIBSELINUX
1875 security_context_t con;
1876 int fail, conlength = 0;
1877 #endif
1878
1879 encoded_file = encoded_newname = Qnil;
1880 GCPRO4 (file, newname, encoded_file, encoded_newname);
1881 CHECK_STRING (file);
1882 CHECK_STRING (newname);
1883
1884 if (!NILP (Ffile_directory_p (newname)))
1885 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
1886 else
1887 newname = Fexpand_file_name (newname, Qnil);
1888
1889 file = Fexpand_file_name (file, Qnil);
1890
1891 /* If the input file name has special constructs in it,
1892 call the corresponding file handler. */
1893 handler = Ffind_file_name_handler (file, Qcopy_file);
1894 /* Likewise for output file name. */
1895 if (NILP (handler))
1896 handler = Ffind_file_name_handler (newname, Qcopy_file);
1897 if (!NILP (handler))
1898 RETURN_UNGCPRO (call7 (handler, Qcopy_file, file, newname,
1899 ok_if_already_exists, keep_time, preserve_uid_gid,
1900 preserve_selinux_context));
1901
1902 encoded_file = ENCODE_FILE (file);
1903 encoded_newname = ENCODE_FILE (newname);
1904
1905 if (NILP (ok_if_already_exists)
1906 || INTEGERP (ok_if_already_exists))
1907 barf_or_query_if_file_exists (newname, "copy to it",
1908 INTEGERP (ok_if_already_exists), &out_st, 0);
1909 else if (stat (SSDATA (encoded_newname), &out_st) < 0)
1910 out_st.st_mode = 0;
1911
1912 #ifdef WINDOWSNT
1913 if (!CopyFile (SDATA (encoded_file),
1914 SDATA (encoded_newname),
1915 FALSE))
1916 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
1917 /* CopyFile retains the timestamp by default. */
1918 else if (NILP (keep_time))
1919 {
1920 EMACS_TIME now;
1921 DWORD attributes;
1922 char * filename;
1923
1924 filename = SDATA (encoded_newname);
1925
1926 /* Ensure file is writable while its modified time is set. */
1927 attributes = GetFileAttributes (filename);
1928 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
1929 now = current_emacs_time ();
1930 if (set_file_times (-1, filename, now, now))
1931 {
1932 /* Restore original attributes. */
1933 SetFileAttributes (filename, attributes);
1934 xsignal2 (Qfile_date_error,
1935 build_string ("Cannot set file date"), newname);
1936 }
1937 /* Restore original attributes. */
1938 SetFileAttributes (filename, attributes);
1939 }
1940 #else /* not WINDOWSNT */
1941 immediate_quit = 1;
1942 ifd = emacs_open (SSDATA (encoded_file), O_RDONLY, 0);
1943 immediate_quit = 0;
1944
1945 if (ifd < 0)
1946 report_file_error ("Opening input file", Fcons (file, Qnil));
1947
1948 record_unwind_protect (close_file_unwind, make_number (ifd));
1949
1950 /* We can only copy regular files and symbolic links. Other files are not
1951 copyable by us. */
1952 input_file_statable_p = (fstat (ifd, &st) >= 0);
1953
1954 #if HAVE_LIBSELINUX
1955 if (!NILP (preserve_selinux_context) && is_selinux_enabled ())
1956 {
1957 conlength = fgetfilecon (ifd, &con);
1958 if (conlength == -1)
1959 report_file_error ("Doing fgetfilecon", Fcons (file, Qnil));
1960 }
1961 #endif
1962
1963 if (out_st.st_mode != 0
1964 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
1965 {
1966 errno = 0;
1967 report_file_error ("Input and output files are the same",
1968 Fcons (file, Fcons (newname, Qnil)));
1969 }
1970
1971 if (input_file_statable_p)
1972 {
1973 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
1974 {
1975 #if defined (EISDIR)
1976 /* Get a better looking error message. */
1977 errno = EISDIR;
1978 #endif /* EISDIR */
1979 report_file_error ("Non-regular file", Fcons (file, Qnil));
1980 }
1981 }
1982
1983 #ifdef MSDOS
1984 /* System's default file type was set to binary by _fmode in emacs.c. */
1985 ofd = emacs_open (SDATA (encoded_newname),
1986 O_WRONLY | O_TRUNC | O_CREAT
1987 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
1988 S_IREAD | S_IWRITE);
1989 #else /* not MSDOS */
1990 {
1991 int new_mask = 0666;
1992 if (input_file_statable_p)
1993 {
1994 if (!NILP (preserve_uid_gid))
1995 new_mask = 0600;
1996 new_mask &= st.st_mode;
1997 }
1998 ofd = emacs_open (SSDATA (encoded_newname),
1999 (O_WRONLY | O_TRUNC | O_CREAT
2000 | (NILP (ok_if_already_exists) ? O_EXCL : 0)),
2001 new_mask);
2002 }
2003 #endif /* not MSDOS */
2004 if (ofd < 0)
2005 report_file_error ("Opening output file", Fcons (newname, Qnil));
2006
2007 record_unwind_protect (close_file_unwind, make_number (ofd));
2008
2009 immediate_quit = 1;
2010 QUIT;
2011 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2012 if (emacs_write (ofd, buf, n) != n)
2013 report_file_error ("I/O error", Fcons (newname, Qnil));
2014 immediate_quit = 0;
2015
2016 #ifndef MSDOS
2017 /* Preserve the original file modes, and if requested, also its
2018 owner and group. */
2019 if (input_file_statable_p)
2020 {
2021 int mode_mask = 07777;
2022 if (!NILP (preserve_uid_gid))
2023 {
2024 /* Attempt to change owner and group. If that doesn't work
2025 attempt to change just the group, as that is sometimes allowed.
2026 Adjust the mode mask to eliminate setuid or setgid bits
2027 that are inappropriate if the owner and group are wrong. */
2028 if (fchown (ofd, st.st_uid, st.st_gid) != 0)
2029 {
2030 mode_mask &= ~06000;
2031 if (fchown (ofd, -1, st.st_gid) == 0)
2032 mode_mask |= 02000;
2033 }
2034 }
2035 if (fchmod (ofd, st.st_mode & mode_mask) != 0)
2036 report_file_error ("Doing chmod", Fcons (newname, Qnil));
2037 }
2038 #endif /* not MSDOS */
2039
2040 #if HAVE_LIBSELINUX
2041 if (conlength > 0)
2042 {
2043 /* Set the modified context back to the file. */
2044 fail = fsetfilecon (ofd, con);
2045 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2046 if (fail && errno != ENOTSUP)
2047 report_file_error ("Doing fsetfilecon", Fcons (newname, Qnil));
2048
2049 freecon (con);
2050 }
2051 #endif
2052
2053 if (input_file_statable_p)
2054 {
2055 if (!NILP (keep_time))
2056 {
2057 EMACS_TIME atime = get_stat_atime (&st);
2058 EMACS_TIME mtime = get_stat_mtime (&st);
2059 if (set_file_times (ofd, SSDATA (encoded_newname), atime, mtime))
2060 xsignal2 (Qfile_date_error,
2061 build_string ("Cannot set file date"), newname);
2062 }
2063 }
2064
2065 if (emacs_close (ofd) < 0)
2066 report_file_error ("I/O error", Fcons (newname, Qnil));
2067
2068 emacs_close (ifd);
2069
2070 #ifdef MSDOS
2071 if (input_file_statable_p)
2072 {
2073 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2074 and if it can't, it tells so. Otherwise, under MSDOS we usually
2075 get only the READ bit, which will make the copied file read-only,
2076 so it's better not to chmod at all. */
2077 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2078 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2079 }
2080 #endif /* MSDOS */
2081 #endif /* not WINDOWSNT */
2082
2083 /* Discard the unwind protects. */
2084 specpdl_ptr = specpdl + count;
2085
2086 UNGCPRO;
2087 return Qnil;
2088 }
2089 \f
2090 DEFUN ("make-directory-internal", Fmake_directory_internal,
2091 Smake_directory_internal, 1, 1, 0,
2092 doc: /* Create a new directory named DIRECTORY. */)
2093 (Lisp_Object directory)
2094 {
2095 const char *dir;
2096 Lisp_Object handler;
2097 Lisp_Object encoded_dir;
2098
2099 CHECK_STRING (directory);
2100 directory = Fexpand_file_name (directory, Qnil);
2101
2102 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2103 if (!NILP (handler))
2104 return call2 (handler, Qmake_directory_internal, directory);
2105
2106 encoded_dir = ENCODE_FILE (directory);
2107
2108 dir = SSDATA (encoded_dir);
2109
2110 #ifdef WINDOWSNT
2111 if (mkdir (dir) != 0)
2112 #else
2113 if (mkdir (dir, 0777 & ~auto_saving_dir_umask) != 0)
2114 #endif
2115 report_file_error ("Creating directory", list1 (directory));
2116
2117 return Qnil;
2118 }
2119
2120 DEFUN ("delete-directory-internal", Fdelete_directory_internal,
2121 Sdelete_directory_internal, 1, 1, 0,
2122 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2123 (Lisp_Object directory)
2124 {
2125 const char *dir;
2126 Lisp_Object encoded_dir;
2127
2128 CHECK_STRING (directory);
2129 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2130 encoded_dir = ENCODE_FILE (directory);
2131 dir = SSDATA (encoded_dir);
2132
2133 if (rmdir (dir) != 0)
2134 report_file_error ("Removing directory", list1 (directory));
2135
2136 return Qnil;
2137 }
2138
2139 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 2,
2140 "(list (read-file-name \
2141 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2142 \"Move file to trash: \" \"Delete file: \") \
2143 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2144 (null current-prefix-arg))",
2145 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2146 If file has multiple names, it continues to exist with the other names.
2147 TRASH non-nil means to trash the file instead of deleting, provided
2148 `delete-by-moving-to-trash' is non-nil.
2149
2150 When called interactively, TRASH is t if no prefix argument is given.
2151 With a prefix argument, TRASH is nil. */)
2152 (Lisp_Object filename, Lisp_Object trash)
2153 {
2154 Lisp_Object handler;
2155 Lisp_Object encoded_file;
2156 struct gcpro gcpro1;
2157
2158 GCPRO1 (filename);
2159 if (!NILP (Ffile_directory_p (filename))
2160 && NILP (Ffile_symlink_p (filename)))
2161 xsignal2 (Qfile_error,
2162 build_string ("Removing old name: is a directory"),
2163 filename);
2164 UNGCPRO;
2165 filename = Fexpand_file_name (filename, Qnil);
2166
2167 handler = Ffind_file_name_handler (filename, Qdelete_file);
2168 if (!NILP (handler))
2169 return call3 (handler, Qdelete_file, filename, trash);
2170
2171 if (delete_by_moving_to_trash && !NILP (trash))
2172 return call1 (Qmove_file_to_trash, filename);
2173
2174 encoded_file = ENCODE_FILE (filename);
2175
2176 if (0 > unlink (SSDATA (encoded_file)))
2177 report_file_error ("Removing old name", list1 (filename));
2178 return Qnil;
2179 }
2180
2181 static Lisp_Object
2182 internal_delete_file_1 (Lisp_Object ignore)
2183 {
2184 return Qt;
2185 }
2186
2187 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2188 This ignores `delete-by-moving-to-trash'. */
2189
2190 int
2191 internal_delete_file (Lisp_Object filename)
2192 {
2193 Lisp_Object tem;
2194
2195 tem = internal_condition_case_2 (Fdelete_file, filename, Qnil,
2196 Qt, internal_delete_file_1);
2197 return NILP (tem);
2198 }
2199 \f
2200 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2201 "fRename file: \nGRename %s to file: \np",
2202 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2203 If file has names other than FILE, it continues to have those names.
2204 Signals a `file-already-exists' error if a file NEWNAME already exists
2205 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2206 A number as third arg means request confirmation if NEWNAME already exists.
2207 This is what happens in interactive use with M-x. */)
2208 (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists)
2209 {
2210 Lisp_Object handler;
2211 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2212 Lisp_Object encoded_file, encoded_newname, symlink_target;
2213
2214 symlink_target = encoded_file = encoded_newname = Qnil;
2215 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2216 CHECK_STRING (file);
2217 CHECK_STRING (newname);
2218 file = Fexpand_file_name (file, Qnil);
2219
2220 if ((!NILP (Ffile_directory_p (newname)))
2221 #ifdef DOS_NT
2222 /* If the file names are identical but for the case,
2223 don't attempt to move directory to itself. */
2224 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2225 #endif
2226 )
2227 {
2228 Lisp_Object fname = NILP (Ffile_directory_p (file))
2229 ? file : Fdirectory_file_name (file);
2230 newname = Fexpand_file_name (Ffile_name_nondirectory (fname), newname);
2231 }
2232 else
2233 newname = Fexpand_file_name (newname, Qnil);
2234
2235 /* If the file name has special constructs in it,
2236 call the corresponding file handler. */
2237 handler = Ffind_file_name_handler (file, Qrename_file);
2238 if (NILP (handler))
2239 handler = Ffind_file_name_handler (newname, Qrename_file);
2240 if (!NILP (handler))
2241 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2242 file, newname, ok_if_already_exists));
2243
2244 encoded_file = ENCODE_FILE (file);
2245 encoded_newname = ENCODE_FILE (newname);
2246
2247 #ifdef DOS_NT
2248 /* If the file names are identical but for the case, don't ask for
2249 confirmation: they simply want to change the letter-case of the
2250 file name. */
2251 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2252 #endif
2253 if (NILP (ok_if_already_exists)
2254 || INTEGERP (ok_if_already_exists))
2255 barf_or_query_if_file_exists (newname, "rename to it",
2256 INTEGERP (ok_if_already_exists), 0, 0);
2257 if (0 > rename (SSDATA (encoded_file), SSDATA (encoded_newname)))
2258 {
2259 if (errno == EXDEV)
2260 {
2261 ptrdiff_t count;
2262 symlink_target = Ffile_symlink_p (file);
2263 if (! NILP (symlink_target))
2264 Fmake_symbolic_link (symlink_target, newname,
2265 NILP (ok_if_already_exists) ? Qnil : Qt);
2266 else if (!NILP (Ffile_directory_p (file)))
2267 call4 (Qcopy_directory, file, newname, Qt, Qnil);
2268 else
2269 /* We have already prompted if it was an integer, so don't
2270 have copy-file prompt again. */
2271 Fcopy_file (file, newname,
2272 NILP (ok_if_already_exists) ? Qnil : Qt,
2273 Qt, Qt, Qt);
2274
2275 count = SPECPDL_INDEX ();
2276 specbind (Qdelete_by_moving_to_trash, Qnil);
2277
2278 if (!NILP (Ffile_directory_p (file)) && NILP (symlink_target))
2279 call2 (Qdelete_directory, file, Qt);
2280 else
2281 Fdelete_file (file, Qnil);
2282 unbind_to (count, Qnil);
2283 }
2284 else
2285 report_file_error ("Renaming", list2 (file, newname));
2286 }
2287 UNGCPRO;
2288 return Qnil;
2289 }
2290
2291 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2292 "fAdd name to file: \nGName to add to %s: \np",
2293 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2294 Signals a `file-already-exists' error if a file NEWNAME already exists
2295 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2296 A number as third arg means request confirmation if NEWNAME already exists.
2297 This is what happens in interactive use with M-x. */)
2298 (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists)
2299 {
2300 Lisp_Object handler;
2301 Lisp_Object encoded_file, encoded_newname;
2302 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2303
2304 GCPRO4 (file, newname, encoded_file, encoded_newname);
2305 encoded_file = encoded_newname = Qnil;
2306 CHECK_STRING (file);
2307 CHECK_STRING (newname);
2308 file = Fexpand_file_name (file, Qnil);
2309
2310 if (!NILP (Ffile_directory_p (newname)))
2311 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2312 else
2313 newname = Fexpand_file_name (newname, Qnil);
2314
2315 /* If the file name has special constructs in it,
2316 call the corresponding file handler. */
2317 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2318 if (!NILP (handler))
2319 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2320 newname, ok_if_already_exists));
2321
2322 /* If the new name has special constructs in it,
2323 call the corresponding file handler. */
2324 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2325 if (!NILP (handler))
2326 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2327 newname, ok_if_already_exists));
2328
2329 encoded_file = ENCODE_FILE (file);
2330 encoded_newname = ENCODE_FILE (newname);
2331
2332 if (NILP (ok_if_already_exists)
2333 || INTEGERP (ok_if_already_exists))
2334 barf_or_query_if_file_exists (newname, "make it a new name",
2335 INTEGERP (ok_if_already_exists), 0, 0);
2336
2337 unlink (SSDATA (newname));
2338 if (0 > link (SSDATA (encoded_file), SSDATA (encoded_newname)))
2339 report_file_error ("Adding new name", list2 (file, newname));
2340
2341 UNGCPRO;
2342 return Qnil;
2343 }
2344
2345 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2346 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2347 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2348 Both args must be strings.
2349 Signals a `file-already-exists' error if a file LINKNAME already exists
2350 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2351 A number as third arg means request confirmation if LINKNAME already exists.
2352 This happens for interactive use with M-x. */)
2353 (Lisp_Object filename, Lisp_Object linkname, Lisp_Object ok_if_already_exists)
2354 {
2355 Lisp_Object handler;
2356 Lisp_Object encoded_filename, encoded_linkname;
2357 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2358
2359 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2360 encoded_filename = encoded_linkname = Qnil;
2361 CHECK_STRING (filename);
2362 CHECK_STRING (linkname);
2363 /* If the link target has a ~, we must expand it to get
2364 a truly valid file name. Otherwise, do not expand;
2365 we want to permit links to relative file names. */
2366 if (SREF (filename, 0) == '~')
2367 filename = Fexpand_file_name (filename, Qnil);
2368
2369 if (!NILP (Ffile_directory_p (linkname)))
2370 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2371 else
2372 linkname = Fexpand_file_name (linkname, Qnil);
2373
2374 /* If the file name has special constructs in it,
2375 call the corresponding file handler. */
2376 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2377 if (!NILP (handler))
2378 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2379 linkname, ok_if_already_exists));
2380
2381 /* If the new link name has special constructs in it,
2382 call the corresponding file handler. */
2383 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2384 if (!NILP (handler))
2385 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2386 linkname, ok_if_already_exists));
2387
2388 encoded_filename = ENCODE_FILE (filename);
2389 encoded_linkname = ENCODE_FILE (linkname);
2390
2391 if (NILP (ok_if_already_exists)
2392 || INTEGERP (ok_if_already_exists))
2393 barf_or_query_if_file_exists (linkname, "make it a link",
2394 INTEGERP (ok_if_already_exists), 0, 0);
2395 if (0 > symlink (SSDATA (encoded_filename),
2396 SSDATA (encoded_linkname)))
2397 {
2398 /* If we didn't complain already, silently delete existing file. */
2399 if (errno == EEXIST)
2400 {
2401 unlink (SSDATA (encoded_linkname));
2402 if (0 <= symlink (SSDATA (encoded_filename),
2403 SSDATA (encoded_linkname)))
2404 {
2405 UNGCPRO;
2406 return Qnil;
2407 }
2408 }
2409 if (errno == ENOSYS)
2410 {
2411 UNGCPRO;
2412 xsignal1 (Qfile_error,
2413 build_string ("Symbolic links are not supported"));
2414 }
2415
2416 report_file_error ("Making symbolic link", list2 (filename, linkname));
2417 }
2418 UNGCPRO;
2419 return Qnil;
2420 }
2421
2422 \f
2423 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2424 1, 1, 0,
2425 doc: /* Return t if file FILENAME specifies an absolute file name.
2426 On Unix, this is a name starting with a `/' or a `~'. */)
2427 (Lisp_Object filename)
2428 {
2429 CHECK_STRING (filename);
2430 return file_name_absolute_p (SSDATA (filename)) ? Qt : Qnil;
2431 }
2432 \f
2433 /* Return nonzero if file FILENAME exists and can be executed. */
2434
2435 static int
2436 check_executable (char *filename)
2437 {
2438 #ifdef DOS_NT
2439 struct stat st;
2440 if (stat (filename, &st) < 0)
2441 return 0;
2442 return ((st.st_mode & S_IEXEC) != 0);
2443 #else /* not DOS_NT */
2444 #ifdef HAVE_EUIDACCESS
2445 return (euidaccess (filename, 1) >= 0);
2446 #else
2447 /* Access isn't quite right because it uses the real uid
2448 and we really want to test with the effective uid.
2449 But Unix doesn't give us a right way to do it. */
2450 return (access (filename, 1) >= 0);
2451 #endif
2452 #endif /* not DOS_NT */
2453 }
2454
2455 /* Return nonzero if file FILENAME exists and can be written. */
2456
2457 static int
2458 check_writable (const char *filename)
2459 {
2460 #ifdef MSDOS
2461 struct stat st;
2462 if (stat (filename, &st) < 0)
2463 return 0;
2464 return (st.st_mode & S_IWRITE || S_ISDIR (st.st_mode));
2465 #else /* not MSDOS */
2466 #ifdef HAVE_EUIDACCESS
2467 int res = (euidaccess (filename, 2) >= 0);
2468 #ifdef CYGWIN
2469 /* euidaccess may have returned failure because Cygwin couldn't
2470 determine the file's UID or GID; if so, we return success. */
2471 if (!res)
2472 {
2473 struct stat st;
2474 if (stat (filename, &st) < 0)
2475 return 0;
2476 res = (st.st_uid == -1 || st.st_gid == -1);
2477 }
2478 #endif /* CYGWIN */
2479 return res;
2480 #else /* not HAVE_EUIDACCESS */
2481 /* Access isn't quite right because it uses the real uid
2482 and we really want to test with the effective uid.
2483 But Unix doesn't give us a right way to do it.
2484 Opening with O_WRONLY could work for an ordinary file,
2485 but would lose for directories. */
2486 return (access (filename, 2) >= 0);
2487 #endif /* not HAVE_EUIDACCESS */
2488 #endif /* not MSDOS */
2489 }
2490
2491 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2492 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
2493 See also `file-readable-p' and `file-attributes'.
2494 This returns nil for a symlink to a nonexistent file.
2495 Use `file-symlink-p' to test for such links. */)
2496 (Lisp_Object filename)
2497 {
2498 Lisp_Object absname;
2499 Lisp_Object handler;
2500 struct stat statbuf;
2501
2502 CHECK_STRING (filename);
2503 absname = Fexpand_file_name (filename, Qnil);
2504
2505 /* If the file name has special constructs in it,
2506 call the corresponding file handler. */
2507 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
2508 if (!NILP (handler))
2509 return call2 (handler, Qfile_exists_p, absname);
2510
2511 absname = ENCODE_FILE (absname);
2512
2513 return (stat (SSDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
2514 }
2515
2516 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2517 doc: /* Return t if FILENAME can be executed by you.
2518 For a directory, this means you can access files in that directory. */)
2519 (Lisp_Object filename)
2520 {
2521 Lisp_Object absname;
2522 Lisp_Object handler;
2523
2524 CHECK_STRING (filename);
2525 absname = Fexpand_file_name (filename, Qnil);
2526
2527 /* If the file name has special constructs in it,
2528 call the corresponding file handler. */
2529 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
2530 if (!NILP (handler))
2531 return call2 (handler, Qfile_executable_p, absname);
2532
2533 absname = ENCODE_FILE (absname);
2534
2535 return (check_executable (SSDATA (absname)) ? Qt : Qnil);
2536 }
2537
2538 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
2539 doc: /* Return t if file FILENAME exists and you can read it.
2540 See also `file-exists-p' and `file-attributes'. */)
2541 (Lisp_Object filename)
2542 {
2543 Lisp_Object absname;
2544 Lisp_Object handler;
2545 int desc;
2546 int flags;
2547 struct stat statbuf;
2548
2549 CHECK_STRING (filename);
2550 absname = Fexpand_file_name (filename, Qnil);
2551
2552 /* If the file name has special constructs in it,
2553 call the corresponding file handler. */
2554 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
2555 if (!NILP (handler))
2556 return call2 (handler, Qfile_readable_p, absname);
2557
2558 absname = ENCODE_FILE (absname);
2559
2560 #if defined (DOS_NT) || defined (macintosh)
2561 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2562 directories. */
2563 if (access (SDATA (absname), 0) == 0)
2564 return Qt;
2565 return Qnil;
2566 #else /* not DOS_NT and not macintosh */
2567 flags = O_RDONLY;
2568 #ifdef O_NONBLOCK
2569 /* Opening a fifo without O_NONBLOCK can wait.
2570 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2571 except in the case of a fifo, on a system which handles it. */
2572 desc = stat (SSDATA (absname), &statbuf);
2573 if (desc < 0)
2574 return Qnil;
2575 if (S_ISFIFO (statbuf.st_mode))
2576 flags |= O_NONBLOCK;
2577 #endif
2578 desc = emacs_open (SSDATA (absname), flags, 0);
2579 if (desc < 0)
2580 return Qnil;
2581 emacs_close (desc);
2582 return Qt;
2583 #endif /* not DOS_NT and not macintosh */
2584 }
2585
2586 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2587 on the RT/PC. */
2588 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
2589 doc: /* Return t if file FILENAME can be written or created by you. */)
2590 (Lisp_Object filename)
2591 {
2592 Lisp_Object absname, dir, encoded;
2593 Lisp_Object handler;
2594 struct stat statbuf;
2595
2596 CHECK_STRING (filename);
2597 absname = Fexpand_file_name (filename, Qnil);
2598
2599 /* If the file name has special constructs in it,
2600 call the corresponding file handler. */
2601 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
2602 if (!NILP (handler))
2603 return call2 (handler, Qfile_writable_p, absname);
2604
2605 encoded = ENCODE_FILE (absname);
2606 if (stat (SSDATA (encoded), &statbuf) >= 0)
2607 return (check_writable (SSDATA (encoded))
2608 ? Qt : Qnil);
2609
2610 dir = Ffile_name_directory (absname);
2611 #ifdef MSDOS
2612 if (!NILP (dir))
2613 dir = Fdirectory_file_name (dir);
2614 #endif /* MSDOS */
2615
2616 dir = ENCODE_FILE (dir);
2617 #ifdef WINDOWSNT
2618 /* The read-only attribute of the parent directory doesn't affect
2619 whether a file or directory can be created within it. Some day we
2620 should check ACLs though, which do affect this. */
2621 if (stat (SDATA (dir), &statbuf) < 0)
2622 return Qnil;
2623 return S_ISDIR (statbuf.st_mode) ? Qt : Qnil;
2624 #else
2625 return (check_writable (!NILP (dir) ? SSDATA (dir) : "")
2626 ? Qt : Qnil);
2627 #endif
2628 }
2629 \f
2630 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
2631 doc: /* Access file FILENAME, and get an error if that does not work.
2632 The second argument STRING is used in the error message.
2633 If there is no error, returns nil. */)
2634 (Lisp_Object filename, Lisp_Object string)
2635 {
2636 Lisp_Object handler, encoded_filename, absname;
2637 int fd;
2638
2639 CHECK_STRING (filename);
2640 absname = Fexpand_file_name (filename, Qnil);
2641
2642 CHECK_STRING (string);
2643
2644 /* If the file name has special constructs in it,
2645 call the corresponding file handler. */
2646 handler = Ffind_file_name_handler (absname, Qaccess_file);
2647 if (!NILP (handler))
2648 return call3 (handler, Qaccess_file, absname, string);
2649
2650 encoded_filename = ENCODE_FILE (absname);
2651
2652 fd = emacs_open (SSDATA (encoded_filename), O_RDONLY, 0);
2653 if (fd < 0)
2654 report_file_error (SSDATA (string), Fcons (filename, Qnil));
2655 emacs_close (fd);
2656
2657 return Qnil;
2658 }
2659 \f
2660 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
2661 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
2662 The value is the link target, as a string.
2663 Otherwise it returns nil.
2664
2665 This function returns t when given the name of a symlink that
2666 points to a nonexistent file. */)
2667 (Lisp_Object filename)
2668 {
2669 Lisp_Object handler;
2670 char *buf;
2671 Lisp_Object val;
2672 char readlink_buf[READLINK_BUFSIZE];
2673
2674 CHECK_STRING (filename);
2675 filename = Fexpand_file_name (filename, Qnil);
2676
2677 /* If the file name has special constructs in it,
2678 call the corresponding file handler. */
2679 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
2680 if (!NILP (handler))
2681 return call2 (handler, Qfile_symlink_p, filename);
2682
2683 filename = ENCODE_FILE (filename);
2684
2685 buf = emacs_readlink (SSDATA (filename), readlink_buf);
2686 if (! buf)
2687 return Qnil;
2688
2689 val = build_string (buf);
2690 if (buf[0] == '/' && strchr (buf, ':'))
2691 val = concat2 (build_string ("/:"), val);
2692 if (buf != readlink_buf)
2693 xfree (buf);
2694 val = DECODE_FILE (val);
2695 return val;
2696 }
2697
2698 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
2699 doc: /* Return t if FILENAME names an existing directory.
2700 Symbolic links to directories count as directories.
2701 See `file-symlink-p' to distinguish symlinks. */)
2702 (Lisp_Object filename)
2703 {
2704 register Lisp_Object absname;
2705 struct stat st;
2706 Lisp_Object handler;
2707
2708 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
2709
2710 /* If the file name has special constructs in it,
2711 call the corresponding file handler. */
2712 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
2713 if (!NILP (handler))
2714 return call2 (handler, Qfile_directory_p, absname);
2715
2716 absname = ENCODE_FILE (absname);
2717
2718 if (stat (SSDATA (absname), &st) < 0)
2719 return Qnil;
2720 return S_ISDIR (st.st_mode) ? Qt : Qnil;
2721 }
2722
2723 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p,
2724 Sfile_accessible_directory_p, 1, 1, 0,
2725 doc: /* Return t if file FILENAME names a directory you can open.
2726 For the value to be t, FILENAME must specify the name of a directory as a file,
2727 and the directory must allow you to open files in it. In order to use a
2728 directory as a buffer's current directory, this predicate must return true.
2729 A directory name spec may be given instead; then the value is t
2730 if the directory so specified exists and really is a readable and
2731 searchable directory. */)
2732 (Lisp_Object filename)
2733 {
2734 Lisp_Object handler;
2735 int tem;
2736 struct gcpro gcpro1;
2737
2738 /* If the file name has special constructs in it,
2739 call the corresponding file handler. */
2740 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
2741 if (!NILP (handler))
2742 return call2 (handler, Qfile_accessible_directory_p, filename);
2743
2744 GCPRO1 (filename);
2745 tem = (NILP (Ffile_directory_p (filename))
2746 || NILP (Ffile_executable_p (filename)));
2747 UNGCPRO;
2748 return tem ? Qnil : Qt;
2749 }
2750
2751 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
2752 doc: /* Return t if FILENAME names a regular file.
2753 This is the sort of file that holds an ordinary stream of data bytes.
2754 Symbolic links to regular files count as regular files.
2755 See `file-symlink-p' to distinguish symlinks. */)
2756 (Lisp_Object filename)
2757 {
2758 register Lisp_Object absname;
2759 struct stat st;
2760 Lisp_Object handler;
2761
2762 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
2763
2764 /* If the file name has special constructs in it,
2765 call the corresponding file handler. */
2766 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
2767 if (!NILP (handler))
2768 return call2 (handler, Qfile_regular_p, absname);
2769
2770 absname = ENCODE_FILE (absname);
2771
2772 #ifdef WINDOWSNT
2773 {
2774 int result;
2775 Lisp_Object tem = Vw32_get_true_file_attributes;
2776
2777 /* Tell stat to use expensive method to get accurate info. */
2778 Vw32_get_true_file_attributes = Qt;
2779 result = stat (SDATA (absname), &st);
2780 Vw32_get_true_file_attributes = tem;
2781
2782 if (result < 0)
2783 return Qnil;
2784 return S_ISREG (st.st_mode) ? Qt : Qnil;
2785 }
2786 #else
2787 if (stat (SSDATA (absname), &st) < 0)
2788 return Qnil;
2789 return S_ISREG (st.st_mode) ? Qt : Qnil;
2790 #endif
2791 }
2792 \f
2793 DEFUN ("file-selinux-context", Ffile_selinux_context,
2794 Sfile_selinux_context, 1, 1, 0,
2795 doc: /* Return SELinux context of file named FILENAME.
2796 The return value is a list (USER ROLE TYPE RANGE), where the list
2797 elements are strings naming the user, role, type, and range of the
2798 file's SELinux security context.
2799
2800 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2801 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2802 (Lisp_Object filename)
2803 {
2804 Lisp_Object absname;
2805 Lisp_Object values[4];
2806 Lisp_Object handler;
2807 #if HAVE_LIBSELINUX
2808 security_context_t con;
2809 int conlength;
2810 context_t context;
2811 #endif
2812
2813 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
2814
2815 /* If the file name has special constructs in it,
2816 call the corresponding file handler. */
2817 handler = Ffind_file_name_handler (absname, Qfile_selinux_context);
2818 if (!NILP (handler))
2819 return call2 (handler, Qfile_selinux_context, absname);
2820
2821 absname = ENCODE_FILE (absname);
2822
2823 values[0] = Qnil;
2824 values[1] = Qnil;
2825 values[2] = Qnil;
2826 values[3] = Qnil;
2827 #if HAVE_LIBSELINUX
2828 if (is_selinux_enabled ())
2829 {
2830 conlength = lgetfilecon (SSDATA (absname), &con);
2831 if (conlength > 0)
2832 {
2833 context = context_new (con);
2834 if (context_user_get (context))
2835 values[0] = build_string (context_user_get (context));
2836 if (context_role_get (context))
2837 values[1] = build_string (context_role_get (context));
2838 if (context_type_get (context))
2839 values[2] = build_string (context_type_get (context));
2840 if (context_range_get (context))
2841 values[3] = build_string (context_range_get (context));
2842 context_free (context);
2843 }
2844 if (con)
2845 freecon (con);
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 int fail, conlength;
2872 context_t parsed_con;
2873 #endif
2874
2875 absname = Fexpand_file_name (filename, BVAR (current_buffer, directory));
2876
2877 /* If the file name has special constructs in it,
2878 call the corresponding file handler. */
2879 handler = Ffind_file_name_handler (absname, Qset_file_selinux_context);
2880 if (!NILP (handler))
2881 return call3 (handler, Qset_file_selinux_context, absname, context);
2882
2883 #if HAVE_LIBSELINUX
2884 if (is_selinux_enabled ())
2885 {
2886 /* Get current file context. */
2887 encoded_absname = ENCODE_FILE (absname);
2888 conlength = lgetfilecon (SSDATA (encoded_absname), &con);
2889 if (conlength > 0)
2890 {
2891 parsed_con = context_new (con);
2892 /* Change the parts defined in the parameter.*/
2893 if (STRINGP (user))
2894 {
2895 if (context_user_set (parsed_con, SSDATA (user)))
2896 error ("Doing context_user_set");
2897 }
2898 if (STRINGP (role))
2899 {
2900 if (context_role_set (parsed_con, SSDATA (role)))
2901 error ("Doing context_role_set");
2902 }
2903 if (STRINGP (type))
2904 {
2905 if (context_type_set (parsed_con, SSDATA (type)))
2906 error ("Doing context_type_set");
2907 }
2908 if (STRINGP (range))
2909 {
2910 if (context_range_set (parsed_con, SSDATA (range)))
2911 error ("Doing context_range_set");
2912 }
2913
2914 /* Set the modified context back to the file. */
2915 fail = lsetfilecon (SSDATA (encoded_absname),
2916 context_str (parsed_con));
2917 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2918 if (fail && errno != ENOTSUP)
2919 report_file_error ("Doing lsetfilecon", Fcons (absname, Qnil));
2920
2921 context_free (parsed_con);
2922 }
2923 else
2924 report_file_error ("Doing lgetfilecon", Fcons (absname, Qnil));
2925
2926 if (con)
2927 freecon (con);
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 int 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 DOS_NT
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 if (current_buffer != XBUFFER (buffer))
3146 set_buffer_internal (XBUFFER (buffer));
3147 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3148 adjust_overlays_for_delete (BEG, Z - BEG);
3149 buffer_set_intervals (current_buffer, NULL);
3150 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3151
3152 /* Now we are safe to change the buffer's multibyteness directly. */
3153 BSET (current_buffer, enable_multibyte_characters, multibyte);
3154 BSET (current_buffer, undo_list, undo_list);
3155
3156 return Qnil;
3157 }
3158
3159
3160 /* Used to pass values from insert-file-contents to read_non_regular. */
3161
3162 static int non_regular_fd;
3163 static ptrdiff_t non_regular_inserted;
3164 static int non_regular_nbytes;
3165
3166
3167 /* Read from a non-regular file.
3168 Read non_regular_nbytes bytes max from non_regular_fd.
3169 Non_regular_inserted specifies where to put the read bytes.
3170 Value is the number of bytes read. */
3171
3172 static Lisp_Object
3173 read_non_regular (Lisp_Object ignore)
3174 {
3175 int nbytes;
3176
3177 immediate_quit = 1;
3178 QUIT;
3179 nbytes = emacs_read (non_regular_fd,
3180 ((char *) BEG_ADDR + PT_BYTE - BEG_BYTE
3181 + non_regular_inserted),
3182 non_regular_nbytes);
3183 immediate_quit = 0;
3184 return make_number (nbytes);
3185 }
3186
3187
3188 /* Condition-case handler used when reading from non-regular files
3189 in insert-file-contents. */
3190
3191 static Lisp_Object
3192 read_non_regular_quit (Lisp_Object ignore)
3193 {
3194 return Qnil;
3195 }
3196
3197 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3198 except that it also tests for OFFSET being out of lseek's range. */
3199 static off_t
3200 emacs_lseek (int fd, EMACS_INT offset, int whence)
3201 {
3202 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3203 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3204 if (! ((TYPE_MINIMUM (off_t) <= offset) & (offset <= TYPE_MAXIMUM (off_t))))
3205 {
3206 errno = EINVAL;
3207 return -1;
3208 }
3209 return lseek (fd, offset, whence);
3210 }
3211
3212 /* Return a special time value indicating the error number ERRNUM. */
3213 static EMACS_TIME
3214 time_error_value (int errnum)
3215 {
3216 int ns = (errnum == ENOENT || errnum == EACCES || errnum == ENOTDIR
3217 ? NONEXISTENT_MODTIME_NSECS
3218 : UNKNOWN_MODTIME_NSECS);
3219 return make_emacs_time (0, ns);
3220 }
3221
3222 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3223 1, 5, 0,
3224 doc: /* Insert contents of file FILENAME after point.
3225 Returns list of absolute file name and number of characters inserted.
3226 If second argument VISIT is non-nil, the buffer's visited filename and
3227 last save file modtime are set, and it is marked unmodified. If
3228 visiting and the file does not exist, visiting is completed before the
3229 error is signaled.
3230
3231 The optional third and fourth arguments BEG and END specify what portion
3232 of the file to insert. These arguments count bytes in the file, not
3233 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3234
3235 If optional fifth argument REPLACE is non-nil, replace the current
3236 buffer contents (in the accessible portion) with the file contents.
3237 This is better than simply deleting and inserting the whole thing
3238 because (1) it preserves some marker positions and (2) it puts less data
3239 in the undo list. When REPLACE is non-nil, the second return value is
3240 the number of characters that replace previous buffer contents.
3241
3242 This function does code conversion according to the value of
3243 `coding-system-for-read' or `file-coding-system-alist', and sets the
3244 variable `last-coding-system-used' to the coding system actually used. */)
3245 (Lisp_Object filename, Lisp_Object visit, Lisp_Object beg, Lisp_Object end, Lisp_Object replace)
3246 {
3247 struct stat st;
3248 int file_status;
3249 EMACS_TIME mtime;
3250 register int fd;
3251 ptrdiff_t inserted = 0;
3252 int nochange = 0;
3253 register ptrdiff_t how_much;
3254 off_t beg_offset, end_offset;
3255 register int unprocessed;
3256 ptrdiff_t count = SPECPDL_INDEX ();
3257 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3258 Lisp_Object handler, val, insval, orig_filename, old_undo;
3259 Lisp_Object p;
3260 ptrdiff_t total = 0;
3261 int not_regular = 0;
3262 int save_errno = 0;
3263 char read_buf[READ_BUF_SIZE];
3264 struct coding_system coding;
3265 char buffer[1 << 14];
3266 int replace_handled = 0;
3267 int set_coding_system = 0;
3268 Lisp_Object coding_system;
3269 int read_quit = 0;
3270 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3271 int we_locked_file = 0;
3272 int deferred_remove_unwind_protect = 0;
3273
3274 if (current_buffer->base_buffer && ! NILP (visit))
3275 error ("Cannot do file visiting in an indirect buffer");
3276
3277 if (!NILP (BVAR (current_buffer, read_only)))
3278 Fbarf_if_buffer_read_only ();
3279
3280 val = Qnil;
3281 p = Qnil;
3282 orig_filename = Qnil;
3283 old_undo = Qnil;
3284
3285 GCPRO5 (filename, val, p, orig_filename, old_undo);
3286
3287 CHECK_STRING (filename);
3288 filename = Fexpand_file_name (filename, Qnil);
3289
3290 /* The value Qnil means that the coding system is not yet
3291 decided. */
3292 coding_system = Qnil;
3293
3294 /* If the file name has special constructs in it,
3295 call the corresponding file handler. */
3296 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3297 if (!NILP (handler))
3298 {
3299 val = call6 (handler, Qinsert_file_contents, filename,
3300 visit, beg, end, replace);
3301 if (CONSP (val) && CONSP (XCDR (val))
3302 && RANGED_INTEGERP (0, XCAR (XCDR (val)), ZV - PT))
3303 inserted = XINT (XCAR (XCDR (val)));
3304 goto handled;
3305 }
3306
3307 orig_filename = filename;
3308 filename = ENCODE_FILE (filename);
3309
3310 fd = -1;
3311
3312 #ifdef WINDOWSNT
3313 {
3314 Lisp_Object tem = Vw32_get_true_file_attributes;
3315
3316 /* Tell stat to use expensive method to get accurate info. */
3317 Vw32_get_true_file_attributes = Qt;
3318 file_status = stat (SSDATA (filename), &st);
3319 Vw32_get_true_file_attributes = tem;
3320 }
3321 #else
3322 file_status = stat (SSDATA (filename), &st);
3323 #endif /* WINDOWSNT */
3324
3325 if (file_status == 0)
3326 mtime = get_stat_mtime (&st);
3327 else
3328 {
3329 badopen:
3330 save_errno = errno;
3331 if (NILP (visit))
3332 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3333 mtime = time_error_value (save_errno);
3334 st.st_size = -1;
3335 how_much = 0;
3336 if (!NILP (Vcoding_system_for_read))
3337 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3338 goto notfound;
3339 }
3340
3341 /* This code will need to be changed in order to work on named
3342 pipes, and it's probably just not worth it. So we should at
3343 least signal an error. */
3344 if (!S_ISREG (st.st_mode))
3345 {
3346 not_regular = 1;
3347
3348 if (! NILP (visit))
3349 goto notfound;
3350
3351 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3352 xsignal2 (Qfile_error,
3353 build_string ("not a regular file"), orig_filename);
3354 }
3355
3356 if (fd < 0)
3357 if ((fd = emacs_open (SSDATA (filename), O_RDONLY, 0)) < 0)
3358 goto badopen;
3359
3360 /* Replacement should preserve point as it preserves markers. */
3361 if (!NILP (replace))
3362 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3363
3364 record_unwind_protect (close_file_unwind, make_number (fd));
3365
3366
3367 if (!NILP (visit))
3368 {
3369 if (!NILP (beg) || !NILP (end))
3370 error ("Attempt to visit less than an entire file");
3371 if (BEG < Z && NILP (replace))
3372 error ("Cannot do file visiting in a non-empty buffer");
3373 }
3374
3375 if (!NILP (beg))
3376 {
3377 if (! (RANGED_INTEGERP (0, beg, TYPE_MAXIMUM (off_t))))
3378 wrong_type_argument (intern ("file-offset"), beg);
3379 beg_offset = XFASTINT (beg);
3380 }
3381 else
3382 beg_offset = 0;
3383
3384 if (!NILP (end))
3385 {
3386 if (! (RANGED_INTEGERP (0, end, TYPE_MAXIMUM (off_t))))
3387 wrong_type_argument (intern ("file-offset"), end);
3388 end_offset = XFASTINT (end);
3389 }
3390 else
3391 {
3392 if (not_regular)
3393 end_offset = TYPE_MAXIMUM (off_t);
3394 else
3395 {
3396 end_offset = st.st_size;
3397
3398 /* A negative size can happen on a platform that allows file
3399 sizes greater than the maximum off_t value. */
3400 if (end_offset < 0)
3401 buffer_overflow ();
3402
3403 /* The file size returned from stat may be zero, but data
3404 may be readable nonetheless, for example when this is a
3405 file in the /proc filesystem. */
3406 if (end_offset == 0)
3407 end_offset = READ_BUF_SIZE;
3408 }
3409 }
3410
3411 /* Check now whether the buffer will become too large,
3412 in the likely case where the file's length is not changing.
3413 This saves a lot of needless work before a buffer overflow. */
3414 if (! not_regular)
3415 {
3416 /* The likely offset where we will stop reading. We could read
3417 more (or less), if the file grows (or shrinks) as we read it. */
3418 off_t likely_end = min (end_offset, st.st_size);
3419
3420 if (beg_offset < likely_end)
3421 {
3422 ptrdiff_t buf_bytes =
3423 Z_BYTE - (!NILP (replace) ? ZV_BYTE - BEGV_BYTE : 0);
3424 ptrdiff_t buf_growth_max = BUF_BYTES_MAX - buf_bytes;
3425 off_t likely_growth = likely_end - beg_offset;
3426 if (buf_growth_max < likely_growth)
3427 buffer_overflow ();
3428 }
3429 }
3430
3431 /* Prevent redisplay optimizations. */
3432 current_buffer->clip_changed = 1;
3433
3434 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3435 {
3436 coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix);
3437 setup_coding_system (coding_system, &coding);
3438 /* Ensure we set Vlast_coding_system_used. */
3439 set_coding_system = 1;
3440 }
3441 else if (BEG < Z)
3442 {
3443 /* Decide the coding system to use for reading the file now
3444 because we can't use an optimized method for handling
3445 `coding:' tag if the current buffer is not empty. */
3446 if (!NILP (Vcoding_system_for_read))
3447 coding_system = Vcoding_system_for_read;
3448 else
3449 {
3450 /* Don't try looking inside a file for a coding system
3451 specification if it is not seekable. */
3452 if (! not_regular && ! NILP (Vset_auto_coding_function))
3453 {
3454 /* Find a coding system specified in the heading two
3455 lines or in the tailing several lines of the file.
3456 We assume that the 1K-byte and 3K-byte for heading
3457 and tailing respectively are sufficient for this
3458 purpose. */
3459 int nread;
3460
3461 if (st.st_size <= (1024 * 4))
3462 nread = emacs_read (fd, read_buf, 1024 * 4);
3463 else
3464 {
3465 nread = emacs_read (fd, read_buf, 1024);
3466 if (nread >= 0)
3467 {
3468 if (lseek (fd, st.st_size - (1024 * 3), SEEK_SET) < 0)
3469 report_file_error ("Setting file position",
3470 Fcons (orig_filename, Qnil));
3471 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3472 }
3473 }
3474
3475 if (nread < 0)
3476 error ("IO error reading %s: %s",
3477 SDATA (orig_filename), emacs_strerror (errno));
3478 else if (nread > 0)
3479 {
3480 struct buffer *prev = current_buffer;
3481 Lisp_Object workbuf;
3482 struct buffer *buf;
3483
3484 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3485
3486 workbuf = Fget_buffer_create (build_string (" *code-converting-work*"));
3487 buf = XBUFFER (workbuf);
3488
3489 delete_all_overlays (buf);
3490 BSET (buf, directory, BVAR (current_buffer, directory));
3491 BSET (buf, read_only, Qnil);
3492 BSET (buf, filename, Qnil);
3493 BSET (buf, undo_list, Qt);
3494 eassert (buf->overlays_before == NULL);
3495 eassert (buf->overlays_after == NULL);
3496
3497 set_buffer_internal (buf);
3498 Ferase_buffer ();
3499 BSET (buf, enable_multibyte_characters, Qnil);
3500
3501 insert_1_both ((char *) read_buf, nread, nread, 0, 0, 0);
3502 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3503 coding_system = call2 (Vset_auto_coding_function,
3504 filename, make_number (nread));
3505 set_buffer_internal (prev);
3506
3507 /* Discard the unwind protect for recovering the
3508 current buffer. */
3509 specpdl_ptr--;
3510
3511 /* Rewind the file for the actual read done later. */
3512 if (lseek (fd, 0, SEEK_SET) < 0)
3513 report_file_error ("Setting file position",
3514 Fcons (orig_filename, Qnil));
3515 }
3516 }
3517
3518 if (NILP (coding_system))
3519 {
3520 /* If we have not yet decided a coding system, check
3521 file-coding-system-alist. */
3522 Lisp_Object args[6];
3523
3524 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3525 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3526 coding_system = Ffind_operation_coding_system (6, args);
3527 if (CONSP (coding_system))
3528 coding_system = XCAR (coding_system);
3529 }
3530 }
3531
3532 if (NILP (coding_system))
3533 coding_system = Qundecided;
3534 else
3535 CHECK_CODING_SYSTEM (coding_system);
3536
3537 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3538 /* We must suppress all character code conversion except for
3539 end-of-line conversion. */
3540 coding_system = raw_text_coding_system (coding_system);
3541
3542 setup_coding_system (coding_system, &coding);
3543 /* Ensure we set Vlast_coding_system_used. */
3544 set_coding_system = 1;
3545 }
3546
3547 /* If requested, replace the accessible part of the buffer
3548 with the file contents. Avoid replacing text at the
3549 beginning or end of the buffer that matches the file contents;
3550 that preserves markers pointing to the unchanged parts.
3551
3552 Here we implement this feature in an optimized way
3553 for the case where code conversion is NOT needed.
3554 The following if-statement handles the case of conversion
3555 in a less optimal way.
3556
3557 If the code conversion is "automatic" then we try using this
3558 method and hope for the best.
3559 But if we discover the need for conversion, we give up on this method
3560 and let the following if-statement handle the replace job. */
3561 if (!NILP (replace)
3562 && BEGV < ZV
3563 && (NILP (coding_system)
3564 || ! CODING_REQUIRE_DECODING (&coding)))
3565 {
3566 /* same_at_start and same_at_end count bytes,
3567 because file access counts bytes
3568 and BEG and END count bytes. */
3569 ptrdiff_t same_at_start = BEGV_BYTE;
3570 ptrdiff_t same_at_end = ZV_BYTE;
3571 ptrdiff_t overlap;
3572 /* There is still a possibility we will find the need to do code
3573 conversion. If that happens, we set this variable to 1 to
3574 give up on handling REPLACE in the optimized way. */
3575 int giveup_match_end = 0;
3576
3577 if (beg_offset != 0)
3578 {
3579 if (lseek (fd, beg_offset, SEEK_SET) < 0)
3580 report_file_error ("Setting file position",
3581 Fcons (orig_filename, Qnil));
3582 }
3583
3584 immediate_quit = 1;
3585 QUIT;
3586 /* Count how many chars at the start of the file
3587 match the text at the beginning of the buffer. */
3588 while (1)
3589 {
3590 int nread, bufpos;
3591
3592 nread = emacs_read (fd, buffer, sizeof buffer);
3593 if (nread < 0)
3594 error ("IO error reading %s: %s",
3595 SSDATA (orig_filename), emacs_strerror (errno));
3596 else if (nread == 0)
3597 break;
3598
3599 if (CODING_REQUIRE_DETECTION (&coding))
3600 {
3601 coding_system = detect_coding_system ((unsigned char *) buffer,
3602 nread, nread, 1, 0,
3603 coding_system);
3604 setup_coding_system (coding_system, &coding);
3605 }
3606
3607 if (CODING_REQUIRE_DECODING (&coding))
3608 /* We found that the file should be decoded somehow.
3609 Let's give up here. */
3610 {
3611 giveup_match_end = 1;
3612 break;
3613 }
3614
3615 bufpos = 0;
3616 while (bufpos < nread && same_at_start < ZV_BYTE
3617 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3618 same_at_start++, bufpos++;
3619 /* If we found a discrepancy, stop the scan.
3620 Otherwise loop around and scan the next bufferful. */
3621 if (bufpos != nread)
3622 break;
3623 }
3624 immediate_quit = 0;
3625 /* If the file matches the buffer completely,
3626 there's no need to replace anything. */
3627 if (same_at_start - BEGV_BYTE == end_offset - beg_offset)
3628 {
3629 emacs_close (fd);
3630 specpdl_ptr--;
3631 /* Truncate the buffer to the size of the file. */
3632 del_range_1 (same_at_start, same_at_end, 0, 0);
3633 goto handled;
3634 }
3635 immediate_quit = 1;
3636 QUIT;
3637 /* Count how many chars at the end of the file
3638 match the text at the end of the buffer. But, if we have
3639 already found that decoding is necessary, don't waste time. */
3640 while (!giveup_match_end)
3641 {
3642 int total_read, nread, bufpos, trial;
3643 off_t curpos;
3644
3645 /* At what file position are we now scanning? */
3646 curpos = end_offset - (ZV_BYTE - same_at_end);
3647 /* If the entire file matches the buffer tail, stop the scan. */
3648 if (curpos == 0)
3649 break;
3650 /* How much can we scan in the next step? */
3651 trial = min (curpos, sizeof buffer);
3652 if (lseek (fd, curpos - trial, SEEK_SET) < 0)
3653 report_file_error ("Setting file position",
3654 Fcons (orig_filename, Qnil));
3655
3656 total_read = nread = 0;
3657 while (total_read < trial)
3658 {
3659 nread = emacs_read (fd, buffer + total_read, trial - total_read);
3660 if (nread < 0)
3661 error ("IO error reading %s: %s",
3662 SDATA (orig_filename), emacs_strerror (errno));
3663 else if (nread == 0)
3664 break;
3665 total_read += nread;
3666 }
3667
3668 /* Scan this bufferful from the end, comparing with
3669 the Emacs buffer. */
3670 bufpos = total_read;
3671
3672 /* Compare with same_at_start to avoid counting some buffer text
3673 as matching both at the file's beginning and at the end. */
3674 while (bufpos > 0 && same_at_end > same_at_start
3675 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3676 same_at_end--, bufpos--;
3677
3678 /* If we found a discrepancy, stop the scan.
3679 Otherwise loop around and scan the preceding bufferful. */
3680 if (bufpos != 0)
3681 {
3682 /* If this discrepancy is because of code conversion,
3683 we cannot use this method; giveup and try the other. */
3684 if (same_at_end > same_at_start
3685 && FETCH_BYTE (same_at_end - 1) >= 0200
3686 && ! NILP (BVAR (current_buffer, enable_multibyte_characters))
3687 && (CODING_MAY_REQUIRE_DECODING (&coding)))
3688 giveup_match_end = 1;
3689 break;
3690 }
3691
3692 if (nread == 0)
3693 break;
3694 }
3695 immediate_quit = 0;
3696
3697 if (! giveup_match_end)
3698 {
3699 ptrdiff_t temp;
3700
3701 /* We win! We can handle REPLACE the optimized way. */
3702
3703 /* Extend the start of non-matching text area to multibyte
3704 character boundary. */
3705 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
3706 while (same_at_start > BEGV_BYTE
3707 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3708 same_at_start--;
3709
3710 /* Extend the end of non-matching text area to multibyte
3711 character boundary. */
3712 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
3713 while (same_at_end < ZV_BYTE
3714 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3715 same_at_end++;
3716
3717 /* Don't try to reuse the same piece of text twice. */
3718 overlap = (same_at_start - BEGV_BYTE
3719 - (same_at_end
3720 + (! NILP (end) ? end_offset : st.st_size) - ZV_BYTE));
3721 if (overlap > 0)
3722 same_at_end += overlap;
3723
3724 /* Arrange to read only the nonmatching middle part of the file. */
3725 beg_offset += same_at_start - BEGV_BYTE;
3726 end_offset -= ZV_BYTE - same_at_end;
3727
3728 del_range_byte (same_at_start, same_at_end, 0);
3729 /* Insert from the file at the proper position. */
3730 temp = BYTE_TO_CHAR (same_at_start);
3731 SET_PT_BOTH (temp, same_at_start);
3732
3733 /* If display currently starts at beginning of line,
3734 keep it that way. */
3735 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3736 XWINDOW (selected_window)->start_at_line_beg = !NILP (Fbolp ());
3737
3738 replace_handled = 1;
3739 }
3740 }
3741
3742 /* If requested, replace the accessible part of the buffer
3743 with the file contents. Avoid replacing text at the
3744 beginning or end of the buffer that matches the file contents;
3745 that preserves markers pointing to the unchanged parts.
3746
3747 Here we implement this feature for the case where code conversion
3748 is needed, in a simple way that needs a lot of memory.
3749 The preceding if-statement handles the case of no conversion
3750 in a more optimized way. */
3751 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
3752 {
3753 ptrdiff_t same_at_start = BEGV_BYTE;
3754 ptrdiff_t same_at_end = ZV_BYTE;
3755 ptrdiff_t same_at_start_charpos;
3756 ptrdiff_t inserted_chars;
3757 ptrdiff_t overlap;
3758 ptrdiff_t bufpos;
3759 unsigned char *decoded;
3760 ptrdiff_t temp;
3761 ptrdiff_t this = 0;
3762 ptrdiff_t this_count = SPECPDL_INDEX ();
3763 int multibyte = ! 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 (current_buffer, enable_multibyte_characters, Qnil);
4109 BSET (current_buffer, undo_list, 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 (current_buffer, enable_multibyte_characters, 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 (current_buffer, undo_list, Qnil);
4201
4202 if (NILP (handler))
4203 {
4204 current_buffer->modtime = mtime;
4205 current_buffer->modtime_size = st.st_size;
4206 BSET (current_buffer, filename, 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 (current_buffer, undo_list, 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 (current_buffer, undo_list, 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 (current_buffer, undo_list, 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 int using_default_coding = 0;
4431 int 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 register int desc;
4541 int failure;
4542 int save_errno = 0;
4543 const char *fn;
4544 struct stat st;
4545 ptrdiff_t count = SPECPDL_INDEX ();
4546 int count1;
4547 Lisp_Object handler;
4548 Lisp_Object visit_file;
4549 Lisp_Object annotations;
4550 Lisp_Object encoded_filename;
4551 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4552 int quietly = !NILP (visit);
4553 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4554 struct buffer *given_buffer;
4555 struct coding_system coding;
4556
4557 if (current_buffer->base_buffer && visiting)
4558 error ("Cannot do file visiting in an indirect buffer");
4559
4560 if (!NILP (start) && !STRINGP (start))
4561 validate_region (&start, &end);
4562
4563 visit_file = Qnil;
4564 GCPRO5 (start, filename, visit, visit_file, lockname);
4565
4566 filename = Fexpand_file_name (filename, Qnil);
4567
4568 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4569 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4570
4571 if (STRINGP (visit))
4572 visit_file = Fexpand_file_name (visit, Qnil);
4573 else
4574 visit_file = filename;
4575
4576 if (NILP (lockname))
4577 lockname = visit_file;
4578
4579 annotations = Qnil;
4580
4581 /* If the file name has special constructs in it,
4582 call the corresponding file handler. */
4583 handler = Ffind_file_name_handler (filename, Qwrite_region);
4584 /* If FILENAME has no handler, see if VISIT has one. */
4585 if (NILP (handler) && STRINGP (visit))
4586 handler = Ffind_file_name_handler (visit, Qwrite_region);
4587
4588 if (!NILP (handler))
4589 {
4590 Lisp_Object val;
4591 val = call6 (handler, Qwrite_region, start, end,
4592 filename, append, visit);
4593
4594 if (visiting)
4595 {
4596 SAVE_MODIFF = MODIFF;
4597 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
4598 BSET (current_buffer, filename, visit_file);
4599 }
4600 UNGCPRO;
4601 return val;
4602 }
4603
4604 record_unwind_protect (save_restriction_restore, save_restriction_save ());
4605
4606 /* Special kludge to simplify auto-saving. */
4607 if (NILP (start))
4608 {
4609 /* Do it later, so write-region-annotate-function can work differently
4610 if we save "the buffer" vs "a region".
4611 This is useful in tar-mode. --Stef
4612 XSETFASTINT (start, BEG);
4613 XSETFASTINT (end, Z); */
4614 Fwiden ();
4615 }
4616
4617 record_unwind_protect (build_annotations_unwind,
4618 Vwrite_region_annotation_buffers);
4619 Vwrite_region_annotation_buffers = Fcons (Fcurrent_buffer (), Qnil);
4620 count1 = SPECPDL_INDEX ();
4621
4622 given_buffer = current_buffer;
4623
4624 if (!STRINGP (start))
4625 {
4626 annotations = build_annotations (start, end);
4627
4628 if (current_buffer != given_buffer)
4629 {
4630 XSETFASTINT (start, BEGV);
4631 XSETFASTINT (end, ZV);
4632 }
4633 }
4634
4635 if (NILP (start))
4636 {
4637 XSETFASTINT (start, BEGV);
4638 XSETFASTINT (end, ZV);
4639 }
4640
4641 UNGCPRO;
4642
4643 GCPRO5 (start, filename, annotations, visit_file, lockname);
4644
4645 /* Decide the coding-system to encode the data with.
4646 We used to make this choice before calling build_annotations, but that
4647 leads to problems when a write-annotate-function takes care of
4648 unsavable chars (as was the case with X-Symbol). */
4649 Vlast_coding_system_used
4650 = choose_write_coding_system (start, end, filename,
4651 append, visit, lockname, &coding);
4652
4653 #ifdef CLASH_DETECTION
4654 if (!auto_saving)
4655 lock_file (lockname);
4656 #endif /* CLASH_DETECTION */
4657
4658 encoded_filename = ENCODE_FILE (filename);
4659
4660 fn = SSDATA (encoded_filename);
4661 desc = -1;
4662 if (!NILP (append))
4663 #ifdef DOS_NT
4664 desc = emacs_open (fn, O_WRONLY | O_BINARY, 0);
4665 #else /* not DOS_NT */
4666 desc = emacs_open (fn, O_WRONLY, 0);
4667 #endif /* not DOS_NT */
4668
4669 if (desc < 0 && (NILP (append) || errno == ENOENT))
4670 #ifdef DOS_NT
4671 desc = emacs_open (fn,
4672 O_WRONLY | O_CREAT | O_BINARY
4673 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
4674 S_IREAD | S_IWRITE);
4675 #else /* not DOS_NT */
4676 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
4677 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
4678 auto_saving ? auto_save_mode_bits : 0666);
4679 #endif /* not DOS_NT */
4680
4681 if (desc < 0)
4682 {
4683 #ifdef CLASH_DETECTION
4684 save_errno = errno;
4685 if (!auto_saving) unlock_file (lockname);
4686 errno = save_errno;
4687 #endif /* CLASH_DETECTION */
4688 UNGCPRO;
4689 report_file_error ("Opening output file", Fcons (filename, Qnil));
4690 }
4691
4692 record_unwind_protect (close_file_unwind, make_number (desc));
4693
4694 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
4695 {
4696 off_t ret;
4697
4698 if (NUMBERP (append))
4699 ret = emacs_lseek (desc, XINT (append), SEEK_CUR);
4700 else
4701 ret = lseek (desc, 0, SEEK_END);
4702 if (ret < 0)
4703 {
4704 #ifdef CLASH_DETECTION
4705 save_errno = errno;
4706 if (!auto_saving) unlock_file (lockname);
4707 errno = save_errno;
4708 #endif /* CLASH_DETECTION */
4709 UNGCPRO;
4710 report_file_error ("Lseek error", Fcons (filename, Qnil));
4711 }
4712 }
4713
4714 UNGCPRO;
4715
4716 failure = 0;
4717 immediate_quit = 1;
4718
4719 if (STRINGP (start))
4720 {
4721 failure = 0 > a_write (desc, start, 0, SCHARS (start),
4722 &annotations, &coding);
4723 save_errno = errno;
4724 }
4725 else if (XINT (start) != XINT (end))
4726 {
4727 failure = 0 > a_write (desc, Qnil,
4728 XINT (start), XINT (end) - XINT (start),
4729 &annotations, &coding);
4730 save_errno = errno;
4731 }
4732 else
4733 {
4734 /* If file was empty, still need to write the annotations */
4735 coding.mode |= CODING_MODE_LAST_BLOCK;
4736 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
4737 save_errno = errno;
4738 }
4739
4740 if (CODING_REQUIRE_FLUSHING (&coding)
4741 && !(coding.mode & CODING_MODE_LAST_BLOCK)
4742 && ! failure)
4743 {
4744 /* We have to flush out a data. */
4745 coding.mode |= CODING_MODE_LAST_BLOCK;
4746 failure = 0 > e_write (desc, Qnil, 1, 1, &coding);
4747 save_errno = errno;
4748 }
4749
4750 immediate_quit = 0;
4751
4752 #ifdef HAVE_FSYNC
4753 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4754 Disk full in NFS may be reported here. */
4755 /* mib says that closing the file will try to write as fast as NFS can do
4756 it, and that means the fsync here is not crucial for autosave files. */
4757 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
4758 {
4759 /* If fsync fails with EINTR, don't treat that as serious. Also
4760 ignore EINVAL which happens when fsync is not supported on this
4761 file. */
4762 if (errno != EINTR && errno != EINVAL)
4763 failure = 1, save_errno = errno;
4764 }
4765 #endif
4766
4767 /* NFS can report a write failure now. */
4768 if (emacs_close (desc) < 0)
4769 failure = 1, save_errno = errno;
4770
4771 stat (fn, &st);
4772
4773 /* Discard the unwind protect for close_file_unwind. */
4774 specpdl_ptr = specpdl + count1;
4775
4776 /* Call write-region-post-annotation-function. */
4777 while (CONSP (Vwrite_region_annotation_buffers))
4778 {
4779 Lisp_Object buf = XCAR (Vwrite_region_annotation_buffers);
4780 if (!NILP (Fbuffer_live_p (buf)))
4781 {
4782 Fset_buffer (buf);
4783 if (FUNCTIONP (Vwrite_region_post_annotation_function))
4784 call0 (Vwrite_region_post_annotation_function);
4785 }
4786 Vwrite_region_annotation_buffers
4787 = XCDR (Vwrite_region_annotation_buffers);
4788 }
4789
4790 unbind_to (count, Qnil);
4791
4792 #ifdef CLASH_DETECTION
4793 if (!auto_saving)
4794 unlock_file (lockname);
4795 #endif /* CLASH_DETECTION */
4796
4797 /* Do this before reporting IO error
4798 to avoid a "file has changed on disk" warning on
4799 next attempt to save. */
4800 if (visiting)
4801 {
4802 current_buffer->modtime = get_stat_mtime (&st);
4803 current_buffer->modtime_size = st.st_size;
4804 }
4805
4806 if (failure)
4807 error ("IO error writing %s: %s", SDATA (filename),
4808 emacs_strerror (save_errno));
4809
4810 if (visiting)
4811 {
4812 SAVE_MODIFF = MODIFF;
4813 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
4814 BSET (current_buffer, filename, visit_file);
4815 update_mode_lines++;
4816 }
4817 else if (quietly)
4818 {
4819 if (auto_saving
4820 && ! NILP (Fstring_equal (BVAR (current_buffer, filename),
4821 BVAR (current_buffer, auto_save_file_name))))
4822 SAVE_MODIFF = MODIFF;
4823
4824 return Qnil;
4825 }
4826
4827 if (!auto_saving)
4828 message_with_string ((INTEGERP (append)
4829 ? "Updated %s"
4830 : ! NILP (append)
4831 ? "Added to %s"
4832 : "Wrote %s"),
4833 visit_file, 1);
4834
4835 return Qnil;
4836 }
4837 \f
4838 Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object);
4839
4840 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
4841 doc: /* Return t if (car A) is numerically less than (car B). */)
4842 (Lisp_Object a, Lisp_Object b)
4843 {
4844 return Flss (Fcar (a), Fcar (b));
4845 }
4846
4847 /* Build the complete list of annotations appropriate for writing out
4848 the text between START and END, by calling all the functions in
4849 write-region-annotate-functions and merging the lists they return.
4850 If one of these functions switches to a different buffer, we assume
4851 that buffer contains altered text. Therefore, the caller must
4852 make sure to restore the current buffer in all cases,
4853 as save-excursion would do. */
4854
4855 static Lisp_Object
4856 build_annotations (Lisp_Object start, Lisp_Object end)
4857 {
4858 Lisp_Object annotations;
4859 Lisp_Object p, res;
4860 struct gcpro gcpro1, gcpro2;
4861 Lisp_Object original_buffer;
4862 int i, used_global = 0;
4863
4864 XSETBUFFER (original_buffer, current_buffer);
4865
4866 annotations = Qnil;
4867 p = Vwrite_region_annotate_functions;
4868 GCPRO2 (annotations, p);
4869 while (CONSP (p))
4870 {
4871 struct buffer *given_buffer = current_buffer;
4872 if (EQ (Qt, XCAR (p)) && !used_global)
4873 { /* Use the global value of the hook. */
4874 Lisp_Object arg[2];
4875 used_global = 1;
4876 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
4877 arg[1] = XCDR (p);
4878 p = Fappend (2, arg);
4879 continue;
4880 }
4881 Vwrite_region_annotations_so_far = annotations;
4882 res = call2 (XCAR (p), start, end);
4883 /* If the function makes a different buffer current,
4884 assume that means this buffer contains altered text to be output.
4885 Reset START and END from the buffer bounds
4886 and discard all previous annotations because they should have
4887 been dealt with by this function. */
4888 if (current_buffer != given_buffer)
4889 {
4890 Vwrite_region_annotation_buffers
4891 = Fcons (Fcurrent_buffer (),
4892 Vwrite_region_annotation_buffers);
4893 XSETFASTINT (start, BEGV);
4894 XSETFASTINT (end, ZV);
4895 annotations = Qnil;
4896 }
4897 Flength (res); /* Check basic validity of return value */
4898 annotations = merge (annotations, res, Qcar_less_than_car);
4899 p = XCDR (p);
4900 }
4901
4902 /* Now do the same for annotation functions implied by the file-format */
4903 if (auto_saving && (!EQ (BVAR (current_buffer, auto_save_file_format), Qt)))
4904 p = BVAR (current_buffer, auto_save_file_format);
4905 else
4906 p = BVAR (current_buffer, file_format);
4907 for (i = 0; CONSP (p); p = XCDR (p), ++i)
4908 {
4909 struct buffer *given_buffer = current_buffer;
4910
4911 Vwrite_region_annotations_so_far = annotations;
4912
4913 /* Value is either a list of annotations or nil if the function
4914 has written annotations to a temporary buffer, which is now
4915 current. */
4916 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
4917 original_buffer, make_number (i));
4918 if (current_buffer != given_buffer)
4919 {
4920 XSETFASTINT (start, BEGV);
4921 XSETFASTINT (end, ZV);
4922 annotations = Qnil;
4923 }
4924
4925 if (CONSP (res))
4926 annotations = merge (annotations, res, Qcar_less_than_car);
4927 }
4928
4929 UNGCPRO;
4930 return annotations;
4931 }
4932
4933 \f
4934 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4935 If STRING is nil, POS is the character position in the current buffer.
4936 Intersperse with them the annotations from *ANNOT
4937 which fall within the range of POS to POS + NCHARS,
4938 each at its appropriate position.
4939
4940 We modify *ANNOT by discarding elements as we use them up.
4941
4942 The return value is negative in case of system call failure. */
4943
4944 static int
4945 a_write (int desc, Lisp_Object string, ptrdiff_t pos,
4946 register ptrdiff_t nchars, Lisp_Object *annot,
4947 struct coding_system *coding)
4948 {
4949 Lisp_Object tem;
4950 ptrdiff_t nextpos;
4951 ptrdiff_t lastpos = pos + nchars;
4952
4953 while (NILP (*annot) || CONSP (*annot))
4954 {
4955 tem = Fcar_safe (Fcar (*annot));
4956 nextpos = pos - 1;
4957 if (INTEGERP (tem))
4958 nextpos = XFASTINT (tem);
4959
4960 /* If there are no more annotations in this range,
4961 output the rest of the range all at once. */
4962 if (! (nextpos >= pos && nextpos <= lastpos))
4963 return e_write (desc, string, pos, lastpos, coding);
4964
4965 /* Output buffer text up to the next annotation's position. */
4966 if (nextpos > pos)
4967 {
4968 if (0 > e_write (desc, string, pos, nextpos, coding))
4969 return -1;
4970 pos = nextpos;
4971 }
4972 /* Output the annotation. */
4973 tem = Fcdr (Fcar (*annot));
4974 if (STRINGP (tem))
4975 {
4976 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
4977 return -1;
4978 }
4979 *annot = Fcdr (*annot);
4980 }
4981 return 0;
4982 }
4983
4984
4985 /* Write text in the range START and END into descriptor DESC,
4986 encoding them with coding system CODING. If STRING is nil, START
4987 and END are character positions of the current buffer, else they
4988 are indexes to the string STRING. */
4989
4990 static int
4991 e_write (int desc, Lisp_Object string, ptrdiff_t start, ptrdiff_t end,
4992 struct coding_system *coding)
4993 {
4994 if (STRINGP (string))
4995 {
4996 start = 0;
4997 end = SCHARS (string);
4998 }
4999
5000 /* We used to have a code for handling selective display here. But,
5001 now it is handled within encode_coding. */
5002
5003 while (start < end)
5004 {
5005 if (STRINGP (string))
5006 {
5007 coding->src_multibyte = SCHARS (string) < SBYTES (string);
5008 if (CODING_REQUIRE_ENCODING (coding))
5009 {
5010 encode_coding_object (coding, string,
5011 start, string_char_to_byte (string, start),
5012 end, string_char_to_byte (string, end), Qt);
5013 }
5014 else
5015 {
5016 coding->dst_object = string;
5017 coding->consumed_char = SCHARS (string);
5018 coding->produced = SBYTES (string);
5019 }
5020 }
5021 else
5022 {
5023 ptrdiff_t start_byte = CHAR_TO_BYTE (start);
5024 ptrdiff_t end_byte = CHAR_TO_BYTE (end);
5025
5026 coding->src_multibyte = (end - start) < (end_byte - start_byte);
5027 if (CODING_REQUIRE_ENCODING (coding))
5028 {
5029 encode_coding_object (coding, Fcurrent_buffer (),
5030 start, start_byte, end, end_byte, Qt);
5031 }
5032 else
5033 {
5034 coding->dst_object = Qnil;
5035 coding->dst_pos_byte = start_byte;
5036 if (start >= GPT || end <= GPT)
5037 {
5038 coding->consumed_char = end - start;
5039 coding->produced = end_byte - start_byte;
5040 }
5041 else
5042 {
5043 coding->consumed_char = GPT - start;
5044 coding->produced = GPT_BYTE - start_byte;
5045 }
5046 }
5047 }
5048
5049 if (coding->produced > 0)
5050 {
5051 coding->produced -=
5052 emacs_write (desc,
5053 STRINGP (coding->dst_object)
5054 ? SSDATA (coding->dst_object)
5055 : (char *) BYTE_POS_ADDR (coding->dst_pos_byte),
5056 coding->produced);
5057
5058 if (coding->produced)
5059 return -1;
5060 }
5061 start += coding->consumed_char;
5062 }
5063
5064 return 0;
5065 }
5066 \f
5067 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5068 Sverify_visited_file_modtime, 0, 1, 0,
5069 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5070 This means that the file has not been changed since it was visited or saved.
5071 If BUF is omitted or nil, it defaults to the current buffer.
5072 See Info node `(elisp)Modification Time' for more details. */)
5073 (Lisp_Object buf)
5074 {
5075 struct buffer *b;
5076 struct stat st;
5077 Lisp_Object handler;
5078 Lisp_Object filename;
5079 EMACS_TIME mtime, diff;
5080
5081 if (NILP (buf))
5082 b = current_buffer;
5083 else
5084 {
5085 CHECK_BUFFER (buf);
5086 b = XBUFFER (buf);
5087 }
5088
5089 if (!STRINGP (BVAR (b, filename))) return Qt;
5090 if (EMACS_NSECS (b->modtime) == UNKNOWN_MODTIME_NSECS) return Qt;
5091
5092 /* If the file name has special constructs in it,
5093 call the corresponding file handler. */
5094 handler = Ffind_file_name_handler (BVAR (b, filename),
5095 Qverify_visited_file_modtime);
5096 if (!NILP (handler))
5097 return call2 (handler, Qverify_visited_file_modtime, buf);
5098
5099 filename = ENCODE_FILE (BVAR (b, filename));
5100
5101 mtime = (stat (SSDATA (filename), &st) == 0
5102 ? get_stat_mtime (&st)
5103 : time_error_value (errno));
5104 if ((EMACS_TIME_EQ (mtime, b->modtime)
5105 /* If both exist, accept them if they are off by one second. */
5106 || (EMACS_TIME_VALID_P (mtime) && EMACS_TIME_VALID_P (b->modtime)
5107 && ((diff = (EMACS_TIME_LT (mtime, b->modtime)
5108 ? sub_emacs_time (b->modtime, mtime)
5109 : sub_emacs_time (mtime, b->modtime))),
5110 EMACS_TIME_LE (diff, make_emacs_time (1, 0)))))
5111 && (st.st_size == b->modtime_size
5112 || b->modtime_size < 0))
5113 return Qt;
5114 return Qnil;
5115 }
5116
5117 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5118 Sclear_visited_file_modtime, 0, 0, 0,
5119 doc: /* Clear out records of last mod time of visited file.
5120 Next attempt to save will certainly not complain of a discrepancy. */)
5121 (void)
5122 {
5123 current_buffer->modtime = make_emacs_time (0, UNKNOWN_MODTIME_NSECS);
5124 current_buffer->modtime_size = -1;
5125 return Qnil;
5126 }
5127
5128 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5129 Svisited_file_modtime, 0, 0, 0,
5130 doc: /* Return the current buffer's recorded visited file modification time.
5131 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5132 `file-attributes' returns. If the current buffer has no recorded file
5133 modification time, this function returns 0. If the visited file
5134 doesn't exist, HIGH will be -1.
5135 See Info node `(elisp)Modification Time' for more details. */)
5136 (void)
5137 {
5138 if (EMACS_NSECS (current_buffer->modtime) < 0)
5139 return make_number (0);
5140 return make_lisp_time (current_buffer->modtime);
5141 }
5142
5143 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5144 Sset_visited_file_modtime, 0, 1, 0,
5145 doc: /* Update buffer's recorded modification time from the visited file's time.
5146 Useful if the buffer was not read from the file normally
5147 or if the file itself has been changed for some known benign reason.
5148 An argument specifies the modification time value to use
5149 \(instead of that of the visited file), in the form of a list
5150 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5151 (Lisp_Object time_list)
5152 {
5153 if (!NILP (time_list))
5154 {
5155 current_buffer->modtime = lisp_time_argument (time_list);
5156 current_buffer->modtime_size = -1;
5157 }
5158 else
5159 {
5160 register Lisp_Object filename;
5161 struct stat st;
5162 Lisp_Object handler;
5163
5164 filename = Fexpand_file_name (BVAR (current_buffer, filename), Qnil);
5165
5166 /* If the file name has special constructs in it,
5167 call the corresponding file handler. */
5168 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5169 if (!NILP (handler))
5170 /* The handler can find the file name the same way we did. */
5171 return call2 (handler, Qset_visited_file_modtime, Qnil);
5172
5173 filename = ENCODE_FILE (filename);
5174
5175 if (stat (SSDATA (filename), &st) >= 0)
5176 {
5177 current_buffer->modtime = get_stat_mtime (&st);
5178 current_buffer->modtime_size = st.st_size;
5179 }
5180 }
5181
5182 return Qnil;
5183 }
5184 \f
5185 static Lisp_Object
5186 auto_save_error (Lisp_Object error_val)
5187 {
5188 Lisp_Object args[3], msg;
5189 int i, nbytes;
5190 struct gcpro gcpro1;
5191 char *msgbuf;
5192 USE_SAFE_ALLOCA;
5193
5194 auto_save_error_occurred = 1;
5195
5196 ring_bell (XFRAME (selected_frame));
5197
5198 args[0] = build_string ("Auto-saving %s: %s");
5199 args[1] = BVAR (current_buffer, name);
5200 args[2] = Ferror_message_string (error_val);
5201 msg = Fformat (3, args);
5202 GCPRO1 (msg);
5203 nbytes = SBYTES (msg);
5204 msgbuf = SAFE_ALLOCA (nbytes);
5205 memcpy (msgbuf, SDATA (msg), nbytes);
5206
5207 for (i = 0; i < 3; ++i)
5208 {
5209 if (i == 0)
5210 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5211 else
5212 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5213 Fsleep_for (make_number (1), Qnil);
5214 }
5215
5216 SAFE_FREE ();
5217 UNGCPRO;
5218 return Qnil;
5219 }
5220
5221 static Lisp_Object
5222 auto_save_1 (void)
5223 {
5224 struct stat st;
5225 Lisp_Object modes;
5226
5227 auto_save_mode_bits = 0666;
5228
5229 /* Get visited file's mode to become the auto save file's mode. */
5230 if (! NILP (BVAR (current_buffer, filename)))
5231 {
5232 if (stat (SSDATA (BVAR (current_buffer, filename)), &st) >= 0)
5233 /* But make sure we can overwrite it later! */
5234 auto_save_mode_bits = (st.st_mode | 0600) & 0777;
5235 else if ((modes = Ffile_modes (BVAR (current_buffer, filename)),
5236 INTEGERP (modes)))
5237 /* Remote files don't cooperate with stat. */
5238 auto_save_mode_bits = (XINT (modes) | 0600) & 0777;
5239 }
5240
5241 return
5242 Fwrite_region (Qnil, Qnil, BVAR (current_buffer, auto_save_file_name), Qnil,
5243 NILP (Vauto_save_visited_file_name) ? Qlambda : Qt,
5244 Qnil, Qnil);
5245 }
5246
5247 static Lisp_Object
5248 do_auto_save_unwind (Lisp_Object arg) /* used as unwind-protect function */
5249
5250 {
5251 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5252 auto_saving = 0;
5253 if (stream != NULL)
5254 {
5255 BLOCK_INPUT;
5256 fclose (stream);
5257 UNBLOCK_INPUT;
5258 }
5259 return Qnil;
5260 }
5261
5262 static Lisp_Object
5263 do_auto_save_unwind_1 (Lisp_Object value) /* used as unwind-protect function */
5264
5265 {
5266 minibuffer_auto_raise = XINT (value);
5267 return Qnil;
5268 }
5269
5270 static Lisp_Object
5271 do_auto_save_make_dir (Lisp_Object dir)
5272 {
5273 Lisp_Object result;
5274
5275 auto_saving_dir_umask = 077;
5276 result = call2 (Qmake_directory, dir, Qt);
5277 auto_saving_dir_umask = 0;
5278 return result;
5279 }
5280
5281 static Lisp_Object
5282 do_auto_save_eh (Lisp_Object ignore)
5283 {
5284 auto_saving_dir_umask = 0;
5285 return Qnil;
5286 }
5287
5288 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5289 doc: /* Auto-save all buffers that need it.
5290 This is all buffers that have auto-saving enabled
5291 and are changed since last auto-saved.
5292 Auto-saving writes the buffer into a file
5293 so that your editing is not lost if the system crashes.
5294 This file is not the file you visited; that changes only when you save.
5295 Normally we run the normal hook `auto-save-hook' before saving.
5296
5297 A non-nil NO-MESSAGE argument means do not print any message if successful.
5298 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5299 (Lisp_Object no_message, Lisp_Object current_only)
5300 {
5301 struct buffer *old = current_buffer, *b;
5302 Lisp_Object tail, buf, hook;
5303 int auto_saved = 0;
5304 int do_handled_files;
5305 Lisp_Object oquit;
5306 FILE *stream = NULL;
5307 ptrdiff_t count = SPECPDL_INDEX ();
5308 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5309 int old_message_p = 0;
5310 struct gcpro gcpro1, gcpro2;
5311
5312 if (max_specpdl_size < specpdl_size + 40)
5313 max_specpdl_size = specpdl_size + 40;
5314
5315 if (minibuf_level)
5316 no_message = Qt;
5317
5318 if (NILP (no_message))
5319 {
5320 old_message_p = push_message ();
5321 record_unwind_protect (pop_message_unwind, Qnil);
5322 }
5323
5324 /* Ordinarily don't quit within this function,
5325 but don't make it impossible to quit (in case we get hung in I/O). */
5326 oquit = Vquit_flag;
5327 Vquit_flag = Qnil;
5328
5329 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5330 point to non-strings reached from Vbuffer_alist. */
5331
5332 hook = intern ("auto-save-hook");
5333 Frun_hooks (1, &hook);
5334
5335 if (STRINGP (Vauto_save_list_file_name))
5336 {
5337 Lisp_Object listfile;
5338
5339 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5340
5341 /* Don't try to create the directory when shutting down Emacs,
5342 because creating the directory might signal an error, and
5343 that would leave Emacs in a strange state. */
5344 if (!NILP (Vrun_hooks))
5345 {
5346 Lisp_Object dir;
5347 dir = Qnil;
5348 GCPRO2 (dir, listfile);
5349 dir = Ffile_name_directory (listfile);
5350 if (NILP (Ffile_directory_p (dir)))
5351 internal_condition_case_1 (do_auto_save_make_dir,
5352 dir, Qt,
5353 do_auto_save_eh);
5354 UNGCPRO;
5355 }
5356
5357 stream = fopen (SSDATA (listfile), "w");
5358 }
5359
5360 record_unwind_protect (do_auto_save_unwind,
5361 make_save_value (stream, 0));
5362 record_unwind_protect (do_auto_save_unwind_1,
5363 make_number (minibuffer_auto_raise));
5364 minibuffer_auto_raise = 0;
5365 auto_saving = 1;
5366 auto_save_error_occurred = 0;
5367
5368 /* On first pass, save all files that don't have handlers.
5369 On second pass, save all files that do have handlers.
5370
5371 If Emacs is crashing, the handlers may tweak what is causing
5372 Emacs to crash in the first place, and it would be a shame if
5373 Emacs failed to autosave perfectly ordinary files because it
5374 couldn't handle some ange-ftp'd file. */
5375
5376 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5377 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
5378 {
5379 buf = XCDR (XCAR (tail));
5380 b = XBUFFER (buf);
5381
5382 /* Record all the buffers that have auto save mode
5383 in the special file that lists them. For each of these buffers,
5384 Record visited name (if any) and auto save name. */
5385 if (STRINGP (BVAR (b, auto_save_file_name))
5386 && stream != NULL && do_handled_files == 0)
5387 {
5388 BLOCK_INPUT;
5389 if (!NILP (BVAR (b, filename)))
5390 {
5391 fwrite (SDATA (BVAR (b, filename)), 1,
5392 SBYTES (BVAR (b, filename)), stream);
5393 }
5394 putc ('\n', stream);
5395 fwrite (SDATA (BVAR (b, auto_save_file_name)), 1,
5396 SBYTES (BVAR (b, auto_save_file_name)), stream);
5397 putc ('\n', stream);
5398 UNBLOCK_INPUT;
5399 }
5400
5401 if (!NILP (current_only)
5402 && b != current_buffer)
5403 continue;
5404
5405 /* Don't auto-save indirect buffers.
5406 The base buffer takes care of it. */
5407 if (b->base_buffer)
5408 continue;
5409
5410 /* Check for auto save enabled
5411 and file changed since last auto save
5412 and file changed since last real save. */
5413 if (STRINGP (BVAR (b, auto_save_file_name))
5414 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5415 && BUF_AUTOSAVE_MODIFF (b) < BUF_MODIFF (b)
5416 /* -1 means we've turned off autosaving for a while--see below. */
5417 && XINT (BVAR (b, save_length)) >= 0
5418 && (do_handled_files
5419 || NILP (Ffind_file_name_handler (BVAR (b, auto_save_file_name),
5420 Qwrite_region))))
5421 {
5422 EMACS_TIME before_time = current_emacs_time ();
5423 EMACS_TIME after_time;
5424
5425 /* If we had a failure, don't try again for 20 minutes. */
5426 if (b->auto_save_failure_time > 0
5427 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5428 continue;
5429
5430 set_buffer_internal (b);
5431 if (NILP (Vauto_save_include_big_deletions)
5432 && (XFASTINT (BVAR (b, save_length)) * 10
5433 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5434 /* A short file is likely to change a large fraction;
5435 spare the user annoying messages. */
5436 && XFASTINT (BVAR (b, save_length)) > 5000
5437 /* These messages are frequent and annoying for `*mail*'. */
5438 && !EQ (BVAR (b, filename), Qnil)
5439 && NILP (no_message))
5440 {
5441 /* It has shrunk too much; turn off auto-saving here. */
5442 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5443 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5444 BVAR (b, name), 1);
5445 minibuffer_auto_raise = 0;
5446 /* Turn off auto-saving until there's a real save,
5447 and prevent any more warnings. */
5448 XSETINT (BVAR (b, save_length), -1);
5449 Fsleep_for (make_number (1), Qnil);
5450 continue;
5451 }
5452 if (!auto_saved && NILP (no_message))
5453 message1 ("Auto-saving...");
5454 internal_condition_case (auto_save_1, Qt, auto_save_error);
5455 auto_saved++;
5456 BUF_AUTOSAVE_MODIFF (b) = BUF_MODIFF (b);
5457 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
5458 set_buffer_internal (old);
5459
5460 after_time = current_emacs_time ();
5461
5462 /* If auto-save took more than 60 seconds,
5463 assume it was an NFS failure that got a timeout. */
5464 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5465 b->auto_save_failure_time = EMACS_SECS (after_time);
5466 }
5467 }
5468
5469 /* Prevent another auto save till enough input events come in. */
5470 record_auto_save ();
5471
5472 if (auto_saved && NILP (no_message))
5473 {
5474 if (old_message_p)
5475 {
5476 /* If we are going to restore an old message,
5477 give time to read ours. */
5478 sit_for (make_number (1), 0, 0);
5479 restore_message ();
5480 }
5481 else if (!auto_save_error_occurred)
5482 /* Don't overwrite the error message if an error occurred.
5483 If we displayed a message and then restored a state
5484 with no message, leave a "done" message on the screen. */
5485 message1 ("Auto-saving...done");
5486 }
5487
5488 Vquit_flag = oquit;
5489
5490 /* This restores the message-stack status. */
5491 unbind_to (count, Qnil);
5492 return Qnil;
5493 }
5494
5495 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
5496 Sset_buffer_auto_saved, 0, 0, 0,
5497 doc: /* Mark current buffer as auto-saved with its current text.
5498 No auto-save file will be written until the buffer changes again. */)
5499 (void)
5500 {
5501 /* FIXME: This should not be called in indirect buffers, since
5502 they're not autosaved. */
5503 BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF;
5504 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
5505 current_buffer->auto_save_failure_time = 0;
5506 return Qnil;
5507 }
5508
5509 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
5510 Sclear_buffer_auto_save_failure, 0, 0, 0,
5511 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
5512 (void)
5513 {
5514 current_buffer->auto_save_failure_time = 0;
5515 return Qnil;
5516 }
5517
5518 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
5519 0, 0, 0,
5520 doc: /* Return t if current buffer has been auto-saved recently.
5521 More precisely, if it has been auto-saved since last read from or saved
5522 in the visited file. If the buffer has no visited file,
5523 then any auto-save counts as "recent". */)
5524 (void)
5525 {
5526 /* FIXME: maybe we should return nil for indirect buffers since
5527 they're never autosaved. */
5528 return (SAVE_MODIFF < BUF_AUTOSAVE_MODIFF (current_buffer) ? Qt : Qnil);
5529 }
5530 \f
5531 /* Reading and completing file names */
5532
5533 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
5534 Snext_read_file_uses_dialog_p, 0, 0, 0,
5535 doc: /* Return t if a call to `read-file-name' will use a dialog.
5536 The return value is only relevant for a call to `read-file-name' that happens
5537 before any other event (mouse or keypress) is handled. */)
5538 (void)
5539 {
5540 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
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 }