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