Avoid non-portable shell command negation
[emacs.git] / src / fileio.c
blob4bfbae918448735675fdfc056b478072dce23e72
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <limits.h>
24 #ifdef HAVE_FCNTL_H
25 #include <fcntl.h>
26 #endif
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <setjmp.h>
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
39 #endif
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
43 #endif
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
47 #endif
49 #ifdef HAVE_PWD_H
50 #include <pwd.h>
51 #endif
53 #include <ctype.h>
54 #include <errno.h>
56 #ifdef HAVE_LIBSELINUX
57 #include <selinux/selinux.h>
58 #include <selinux/context.h>
59 #endif
61 #include "lisp.h"
62 #include "intervals.h"
63 #include "buffer.h"
64 #include "character.h"
65 #include "coding.h"
66 #include "window.h"
67 #include "blockinput.h"
68 #include "frame.h"
69 #include "dispextern.h"
71 #ifdef WINDOWSNT
72 #define NOMINMAX 1
73 #include <windows.h>
74 #include <stdlib.h>
75 #include <fcntl.h>
76 #endif /* not WINDOWSNT */
78 #ifdef MSDOS
79 #include "msdos.h"
80 #include <sys/param.h>
81 #include <fcntl.h>
82 #include <string.h>
83 #endif
85 #ifdef DOS_NT
86 #define CORRECT_DIR_SEPS(s) \
87 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
88 else unixtodos_filename (s); \
89 } while (0)
90 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
91 redirector allows the six letters between 'Z' and 'a' as well. */
92 #ifdef MSDOS
93 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
94 #endif
95 #ifdef WINDOWSNT
96 #define IS_DRIVE(x) isalpha (x)
97 #endif
98 /* Need to lower-case the drive letter, or else expanded
99 filenames will sometimes compare inequal, because
100 `expand-file-name' doesn't always down-case the drive letter. */
101 #define DRIVE_LETTER(x) (tolower (x))
102 #endif
104 #include "systime.h"
106 #ifdef HPUX
107 #include <netio.h>
108 #endif
110 #include "commands.h"
111 extern int use_dialog_box;
112 extern int use_file_dialog;
114 #ifndef O_WRONLY
115 #define O_WRONLY 1
116 #endif
118 #ifndef O_RDONLY
119 #define O_RDONLY 0
120 #endif
122 #ifndef S_ISLNK
123 # define lstat stat
124 #endif
126 #ifndef FILE_SYSTEM_CASE
127 #define FILE_SYSTEM_CASE(filename) (filename)
128 #endif
130 /* Nonzero during writing of auto-save files */
131 int auto_saving;
133 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
134 a new file with the same mode as the original */
135 int auto_save_mode_bits;
137 /* Set by auto_save_1 if an error occurred during the last auto-save. */
138 int auto_save_error_occurred;
140 /* The symbol bound to coding-system-for-read when
141 insert-file-contents is called for recovering a file. This is not
142 an actual coding system name, but just an indicator to tell
143 insert-file-contents to use `emacs-mule' with a special flag for
144 auto saving and recovering a file. */
145 Lisp_Object Qauto_save_coding;
147 /* Coding system for file names, or nil if none. */
148 Lisp_Object Vfile_name_coding_system;
150 /* Coding system for file names used only when
151 Vfile_name_coding_system is nil. */
152 Lisp_Object Vdefault_file_name_coding_system;
154 /* Alist of elements (REGEXP . HANDLER) for file names
155 whose I/O is done with a special handler. */
156 Lisp_Object Vfile_name_handler_alist;
158 /* Property name of a file name handler,
159 which gives a list of operations it handles.. */
160 Lisp_Object Qoperations;
162 /* Lisp functions for translating file formats */
163 Lisp_Object Qformat_decode, Qformat_annotate_function;
165 /* Function to be called to decide a coding system of a reading file. */
166 Lisp_Object Vset_auto_coding_function;
168 /* Functions to be called to process text properties in inserted file. */
169 Lisp_Object Vafter_insert_file_functions;
171 /* Lisp function for setting buffer-file-coding-system and the
172 multibyteness of the current buffer after inserting a file. */
173 Lisp_Object Qafter_insert_file_set_coding;
175 /* Functions to be called to create text property annotations for file. */
176 Lisp_Object Vwrite_region_annotate_functions;
177 Lisp_Object Qwrite_region_annotate_functions;
178 Lisp_Object Vwrite_region_post_annotation_function;
180 /* During build_annotations, each time an annotation function is called,
181 this holds the annotations made by the previous functions. */
182 Lisp_Object Vwrite_region_annotations_so_far;
184 /* Each time an annotation function changes the buffer, the new buffer
185 is added here. */
186 Lisp_Object Vwrite_region_annotation_buffers;
188 /* File name in which we write a list of all our auto save files. */
189 Lisp_Object Vauto_save_list_file_name;
191 /* Whether or not files are auto-saved into themselves. */
192 Lisp_Object Vauto_save_visited_file_name;
194 /* Whether or not to continue auto-saving after a large deletion. */
195 Lisp_Object Vauto_save_include_big_deletions;
197 /* On NT, specifies the directory separator character, used (eg.) when
198 expanding file names. This can be bound to / or \. */
199 Lisp_Object Vdirectory_sep_char;
201 #ifdef HAVE_FSYNC
202 /* Nonzero means skip the call to fsync in Fwrite-region. */
203 int write_region_inhibit_fsync;
204 #endif
206 /* Non-zero means call move-file-to-trash in Fdelete_file or
207 Fdelete_directory_internal. */
208 int delete_by_moving_to_trash;
210 Lisp_Object Qdelete_by_moving_to_trash;
212 /* Lisp function for moving files to trash. */
213 Lisp_Object Qmove_file_to_trash;
215 /* Lisp function for recursively copying directories. */
216 Lisp_Object Qcopy_directory;
218 /* Lisp function for recursively deleting directories. */
219 Lisp_Object Qdelete_directory;
221 extern Lisp_Object Vuser_login_name;
223 #ifdef WINDOWSNT
224 extern Lisp_Object Vw32_get_true_file_attributes;
225 #endif
227 extern int minibuf_level;
229 extern int minibuffer_auto_raise;
231 /* These variables describe handlers that have "already" had a chance
232 to handle the current operation.
234 Vinhibit_file_name_handlers is a list of file name handlers.
235 Vinhibit_file_name_operation is the operation being handled.
236 If we try to handle that operation, we ignore those handlers. */
238 static Lisp_Object Vinhibit_file_name_handlers;
239 static Lisp_Object Vinhibit_file_name_operation;
241 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
242 Lisp_Object Qexcl;
243 Lisp_Object Qfile_name_history;
245 Lisp_Object Qcar_less_than_car;
247 static int a_write P_ ((int, Lisp_Object, int, int,
248 Lisp_Object *, struct coding_system *));
249 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
252 void
253 report_file_error (string, data)
254 const char *string;
255 Lisp_Object data;
257 Lisp_Object errstring;
258 int errorno = errno;
259 char *str;
261 synchronize_system_messages_locale ();
262 str = strerror (errorno);
263 errstring = code_convert_string_norecord (make_unibyte_string (str,
264 strlen (str)),
265 Vlocale_coding_system, 0);
267 while (1)
268 switch (errorno)
270 case EEXIST:
271 xsignal (Qfile_already_exists, Fcons (errstring, data));
272 break;
273 default:
274 /* System error messages are capitalized. Downcase the initial
275 unless it is followed by a slash. (The slash case caters to
276 error messages that begin with "I/O" or, in German, "E/A".) */
277 if (STRING_MULTIBYTE (errstring)
278 && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
280 int c;
282 str = (char *) SDATA (errstring);
283 c = STRING_CHAR (str);
284 Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
287 xsignal (Qfile_error,
288 Fcons (build_string (string), Fcons (errstring, data)));
292 Lisp_Object
293 close_file_unwind (fd)
294 Lisp_Object fd;
296 emacs_close (XFASTINT (fd));
297 return Qnil;
300 /* Restore point, having saved it as a marker. */
302 static Lisp_Object
303 restore_point_unwind (location)
304 Lisp_Object location;
306 Fgoto_char (location);
307 Fset_marker (location, Qnil, Qnil);
308 return Qnil;
312 Lisp_Object Qexpand_file_name;
313 Lisp_Object Qsubstitute_in_file_name;
314 Lisp_Object Qdirectory_file_name;
315 Lisp_Object Qfile_name_directory;
316 Lisp_Object Qfile_name_nondirectory;
317 Lisp_Object Qunhandled_file_name_directory;
318 Lisp_Object Qfile_name_as_directory;
319 Lisp_Object Qcopy_file;
320 Lisp_Object Qmake_directory_internal;
321 Lisp_Object Qmake_directory;
322 Lisp_Object Qdelete_directory_internal;
323 Lisp_Object Qdelete_file;
324 Lisp_Object Qrename_file;
325 Lisp_Object Qadd_name_to_file;
326 Lisp_Object Qmake_symbolic_link;
327 Lisp_Object Qfile_exists_p;
328 Lisp_Object Qfile_executable_p;
329 Lisp_Object Qfile_readable_p;
330 Lisp_Object Qfile_writable_p;
331 Lisp_Object Qfile_symlink_p;
332 Lisp_Object Qaccess_file;
333 Lisp_Object Qfile_directory_p;
334 Lisp_Object Qfile_regular_p;
335 Lisp_Object Qfile_accessible_directory_p;
336 Lisp_Object Qfile_modes;
337 Lisp_Object Qset_file_modes;
338 Lisp_Object Qset_file_times;
339 Lisp_Object Qfile_selinux_context;
340 Lisp_Object Qset_file_selinux_context;
341 Lisp_Object Qfile_newer_than_file_p;
342 Lisp_Object Qinsert_file_contents;
343 Lisp_Object Qwrite_region;
344 Lisp_Object Qverify_visited_file_modtime;
345 Lisp_Object Qset_visited_file_modtime;
347 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
348 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
349 Otherwise, return nil.
350 A file name is handled if one of the regular expressions in
351 `file-name-handler-alist' matches it.
353 If OPERATION equals `inhibit-file-name-operation', then we ignore
354 any handlers that are members of `inhibit-file-name-handlers',
355 but we still do run any other handlers. This lets handlers
356 use the standard functions without calling themselves recursively. */)
357 (filename, operation)
358 Lisp_Object filename, operation;
360 /* This function must not munge the match data. */
361 Lisp_Object chain, inhibited_handlers, result;
362 int pos = -1;
364 result = Qnil;
365 CHECK_STRING (filename);
367 if (EQ (operation, Vinhibit_file_name_operation))
368 inhibited_handlers = Vinhibit_file_name_handlers;
369 else
370 inhibited_handlers = Qnil;
372 for (chain = Vfile_name_handler_alist; CONSP (chain);
373 chain = XCDR (chain))
375 Lisp_Object elt;
376 elt = XCAR (chain);
377 if (CONSP (elt))
379 Lisp_Object string = XCAR (elt);
380 int match_pos;
381 Lisp_Object handler = XCDR (elt);
382 Lisp_Object operations = Qnil;
384 if (SYMBOLP (handler))
385 operations = Fget (handler, Qoperations);
387 if (STRINGP (string)
388 && (match_pos = fast_string_match (string, filename)) > pos
389 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
391 Lisp_Object tem;
393 handler = XCDR (elt);
394 tem = Fmemq (handler, inhibited_handlers);
395 if (NILP (tem))
397 result = handler;
398 pos = match_pos;
403 QUIT;
405 return result;
408 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
409 1, 1, 0,
410 doc: /* Return the directory component in file name FILENAME.
411 Return nil if FILENAME does not include a directory.
412 Otherwise return a directory name.
413 Given a Unix syntax file name, returns a string ending in slash. */)
414 (filename)
415 Lisp_Object filename;
417 #ifndef DOS_NT
418 register const unsigned char *beg;
419 #else
420 register unsigned char *beg;
421 #endif
422 register const unsigned char *p;
423 Lisp_Object handler;
425 CHECK_STRING (filename);
427 /* If the file name has special constructs in it,
428 call the corresponding file handler. */
429 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
430 if (!NILP (handler))
431 return call2 (handler, Qfile_name_directory, filename);
433 filename = FILE_SYSTEM_CASE (filename);
434 #ifdef DOS_NT
435 beg = (unsigned char *) alloca (SBYTES (filename) + 1);
436 bcopy (SDATA (filename), beg, SBYTES (filename) + 1);
437 #else
438 beg = SDATA (filename);
439 #endif
440 p = beg + SBYTES (filename);
442 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
443 #ifdef DOS_NT
444 /* only recognise drive specifier at the beginning */
445 && !(p[-1] == ':'
446 /* handle the "/:d:foo" and "/:foo" cases correctly */
447 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
448 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
449 #endif
450 ) p--;
452 if (p == beg)
453 return Qnil;
454 #ifdef DOS_NT
455 /* Expansion of "c:" to drive and default directory. */
456 if (p[-1] == ':')
458 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
459 unsigned char *res = alloca (MAXPATHLEN + 1);
460 unsigned char *r = res;
462 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
464 strncpy (res, beg, 2);
465 beg += 2;
466 r += 2;
469 if (getdefdir (toupper (*beg) - 'A' + 1, r))
471 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
472 strcat (res, "/");
473 beg = res;
474 p = beg + strlen (beg);
477 CORRECT_DIR_SEPS (beg);
478 #endif /* DOS_NT */
480 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
483 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
484 Sfile_name_nondirectory, 1, 1, 0,
485 doc: /* Return file name FILENAME sans its directory.
486 For example, in a Unix-syntax file name,
487 this is everything after the last slash,
488 or the entire name if it contains no slash. */)
489 (filename)
490 Lisp_Object filename;
492 register const unsigned char *beg, *p, *end;
493 Lisp_Object handler;
495 CHECK_STRING (filename);
497 /* If the file name has special constructs in it,
498 call the corresponding file handler. */
499 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
500 if (!NILP (handler))
501 return call2 (handler, Qfile_name_nondirectory, filename);
503 beg = SDATA (filename);
504 end = p = beg + SBYTES (filename);
506 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
507 #ifdef DOS_NT
508 /* only recognise drive specifier at beginning */
509 && !(p[-1] == ':'
510 /* handle the "/:d:foo" case correctly */
511 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
512 #endif
514 p--;
516 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
519 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
520 Sunhandled_file_name_directory, 1, 1, 0,
521 doc: /* Return a directly usable directory name somehow associated with FILENAME.
522 A `directly usable' directory name is one that may be used without the
523 intervention of any file handler.
524 If FILENAME is a directly usable file itself, return
525 \(file-name-directory FILENAME).
526 If FILENAME refers to a file which is not accessible from a local process,
527 then this should return nil.
528 The `call-process' and `start-process' functions use this function to
529 get a current directory to run processes in. */)
530 (filename)
531 Lisp_Object filename;
533 Lisp_Object handler;
535 /* If the file name has special constructs in it,
536 call the corresponding file handler. */
537 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
538 if (!NILP (handler))
539 return call2 (handler, Qunhandled_file_name_directory, filename);
541 return Ffile_name_directory (filename);
545 char *
546 file_name_as_directory (out, in)
547 char *out, *in;
549 int size = strlen (in) - 1;
551 strcpy (out, in);
553 if (size < 0)
555 out[0] = '.';
556 out[1] = '/';
557 out[2] = 0;
558 return out;
561 /* For Unix syntax, Append a slash if necessary */
562 if (!IS_DIRECTORY_SEP (out[size]))
564 /* Cannot use DIRECTORY_SEP, which could have any value */
565 out[size + 1] = '/';
566 out[size + 2] = '\0';
568 #ifdef DOS_NT
569 CORRECT_DIR_SEPS (out);
570 #endif
571 return out;
574 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
575 Sfile_name_as_directory, 1, 1, 0,
576 doc: /* Return a string representing the file name FILE interpreted as a directory.
577 This operation exists because a directory is also a file, but its name as
578 a directory is different from its name as a file.
579 The result can be used as the value of `default-directory'
580 or passed as second argument to `expand-file-name'.
581 For a Unix-syntax file name, just appends a slash. */)
582 (file)
583 Lisp_Object file;
585 char *buf;
586 Lisp_Object handler;
588 CHECK_STRING (file);
589 if (NILP (file))
590 return Qnil;
592 /* If the file name has special constructs in it,
593 call the corresponding file handler. */
594 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
595 if (!NILP (handler))
596 return call2 (handler, Qfile_name_as_directory, file);
598 buf = (char *) alloca (SBYTES (file) + 10);
599 file_name_as_directory (buf, SDATA (file));
600 return make_specified_string (buf, -1, strlen (buf),
601 STRING_MULTIBYTE (file));
605 * Convert from directory name to filename.
606 * On UNIX, it's simple: just make sure there isn't a terminating /
608 * Value is nonzero if the string output is different from the input.
612 directory_file_name (src, dst)
613 char *src, *dst;
615 long slen;
617 slen = strlen (src);
619 /* Process as Unix format: just remove any final slash.
620 But leave "/" unchanged; do not change it to "". */
621 strcpy (dst, src);
622 if (slen > 1
623 && IS_DIRECTORY_SEP (dst[slen - 1])
624 #ifdef DOS_NT
625 && !IS_ANY_SEP (dst[slen - 2])
626 #endif
628 dst[slen - 1] = 0;
629 #ifdef DOS_NT
630 CORRECT_DIR_SEPS (dst);
631 #endif
632 return 1;
635 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
636 1, 1, 0,
637 doc: /* Returns the file name of the directory named DIRECTORY.
638 This is the name of the file that holds the data for the directory DIRECTORY.
639 This operation exists because a directory is also a file, but its name as
640 a directory is different from its name as a file.
641 In Unix-syntax, this function just removes the final slash. */)
642 (directory)
643 Lisp_Object directory;
645 char *buf;
646 Lisp_Object handler;
648 CHECK_STRING (directory);
650 if (NILP (directory))
651 return Qnil;
653 /* If the file name has special constructs in it,
654 call the corresponding file handler. */
655 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
656 if (!NILP (handler))
657 return call2 (handler, Qdirectory_file_name, directory);
659 buf = (char *) alloca (SBYTES (directory) + 20);
660 directory_file_name (SDATA (directory), buf);
661 return make_specified_string (buf, -1, strlen (buf),
662 STRING_MULTIBYTE (directory));
665 static const char make_temp_name_tbl[64] =
667 'A','B','C','D','E','F','G','H',
668 'I','J','K','L','M','N','O','P',
669 'Q','R','S','T','U','V','W','X',
670 'Y','Z','a','b','c','d','e','f',
671 'g','h','i','j','k','l','m','n',
672 'o','p','q','r','s','t','u','v',
673 'w','x','y','z','0','1','2','3',
674 '4','5','6','7','8','9','-','_'
677 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
679 /* Value is a temporary file name starting with PREFIX, a string.
681 The Emacs process number forms part of the result, so there is
682 no danger of generating a name being used by another process.
683 In addition, this function makes an attempt to choose a name
684 which has no existing file. To make this work, PREFIX should be
685 an absolute file name.
687 BASE64_P non-zero means add the pid as 3 characters in base64
688 encoding. In this case, 6 characters will be added to PREFIX to
689 form the file name. Otherwise, if Emacs is running on a system
690 with long file names, add the pid as a decimal number.
692 This function signals an error if no unique file name could be
693 generated. */
695 Lisp_Object
696 make_temp_name (prefix, base64_p)
697 Lisp_Object prefix;
698 int base64_p;
700 Lisp_Object val;
701 int len, clen;
702 int pid;
703 unsigned char *p, *data;
704 char pidbuf[20];
705 int pidlen;
707 CHECK_STRING (prefix);
709 /* VAL is created by adding 6 characters to PREFIX. The first
710 three are the PID of this process, in base 64, and the second
711 three are incremented if the file already exists. This ensures
712 262144 unique file names per PID per PREFIX. */
714 pid = (int) getpid ();
716 if (base64_p)
718 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
719 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
720 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
721 pidlen = 3;
723 else
725 #ifdef HAVE_LONG_FILE_NAMES
726 sprintf (pidbuf, "%d", pid);
727 pidlen = strlen (pidbuf);
728 #else
729 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
730 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
731 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
732 pidlen = 3;
733 #endif
736 len = SBYTES (prefix); clen = SCHARS (prefix);
737 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
738 if (!STRING_MULTIBYTE (prefix))
739 STRING_SET_UNIBYTE (val);
740 data = SDATA (val);
741 bcopy(SDATA (prefix), data, len);
742 p = data + len;
744 bcopy (pidbuf, p, pidlen);
745 p += pidlen;
747 /* Here we try to minimize useless stat'ing when this function is
748 invoked many times successively with the same PREFIX. We achieve
749 this by initializing count to a random value, and incrementing it
750 afterwards.
752 We don't want make-temp-name to be called while dumping,
753 because then make_temp_name_count_initialized_p would get set
754 and then make_temp_name_count would not be set when Emacs starts. */
756 if (!make_temp_name_count_initialized_p)
758 make_temp_name_count = (unsigned) time (NULL);
759 make_temp_name_count_initialized_p = 1;
762 while (1)
764 struct stat ignored;
765 unsigned num = make_temp_name_count;
767 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
768 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
769 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
771 /* Poor man's congruential RN generator. Replace with
772 ++make_temp_name_count for debugging. */
773 make_temp_name_count += 25229;
774 make_temp_name_count %= 225307;
776 if (stat (data, &ignored) < 0)
778 /* We want to return only if errno is ENOENT. */
779 if (errno == ENOENT)
780 return val;
781 else
782 /* The error here is dubious, but there is little else we
783 can do. The alternatives are to return nil, which is
784 as bad as (and in many cases worse than) throwing the
785 error, or to ignore the error, which will likely result
786 in looping through 225307 stat's, which is not only
787 dog-slow, but also useless since it will fallback to
788 the errow below, anyway. */
789 report_file_error ("Cannot create temporary name for prefix",
790 Fcons (prefix, Qnil));
791 /* not reached */
795 error ("Cannot create temporary name for prefix `%s'",
796 SDATA (prefix));
797 return Qnil;
801 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
802 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
803 The Emacs process number forms part of the result,
804 so there is no danger of generating a name being used by another process.
806 In addition, this function makes an attempt to choose a name
807 which has no existing file. To make this work,
808 PREFIX should be an absolute file name.
810 There is a race condition between calling `make-temp-name' and creating the
811 file which opens all kinds of security holes. For that reason, you should
812 probably use `make-temp-file' instead, except in three circumstances:
814 * If you are creating the file in the user's home directory.
815 * If you are creating a directory rather than an ordinary file.
816 * If you are taking special precautions as `make-temp-file' does. */)
817 (prefix)
818 Lisp_Object prefix;
820 return make_temp_name (prefix, 0);
825 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
826 doc: /* Convert filename NAME to absolute, and canonicalize it.
827 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
828 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
829 the current buffer's value of `default-directory' is used.
830 File name components that are `.' are removed, and
831 so are file name components followed by `..', along with the `..' itself;
832 note that these simplifications are done without checking the resulting
833 file names in the file system.
834 An initial `~/' expands to your home directory.
835 An initial `~USER/' expands to USER's home directory.
836 See also the function `substitute-in-file-name'.
838 For technical reasons, this function can return correct but
839 non-intuitive results for the root directory; for instance,
840 \(expand-file-name ".." "/") returns "/..". For this reason, use
841 (directory-file-name (file-name-directory dirname)) to traverse a
842 filesystem tree, not (expand-file-name ".." dirname). */)
843 (name, default_directory)
844 Lisp_Object name, default_directory;
846 /* These point to SDATA and need to be careful with string-relocation
847 during GC (via DECODE_FILE). */
848 unsigned char *nm, *newdir;
849 /* This should only point to alloca'd data. */
850 unsigned char *target;
852 int tlen;
853 struct passwd *pw;
854 #ifdef DOS_NT
855 int drive = 0;
856 int collapse_newdir = 1;
857 int is_escaped = 0;
858 #endif /* DOS_NT */
859 int length;
860 Lisp_Object handler, result;
861 int multibyte;
862 Lisp_Object hdir;
864 CHECK_STRING (name);
866 /* If the file name has special constructs in it,
867 call the corresponding file handler. */
868 handler = Ffind_file_name_handler (name, Qexpand_file_name);
869 if (!NILP (handler))
870 return call3 (handler, Qexpand_file_name, name, default_directory);
872 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
873 if (NILP (default_directory))
874 default_directory = current_buffer->directory;
875 if (! STRINGP (default_directory))
877 #ifdef DOS_NT
878 /* "/" is not considered a root directory on DOS_NT, so using "/"
879 here causes an infinite recursion in, e.g., the following:
881 (let (default-directory)
882 (expand-file-name "a"))
884 To avoid this, we set default_directory to the root of the
885 current drive. */
886 extern char *emacs_root_dir (void);
888 default_directory = build_string (emacs_root_dir ());
889 #else
890 default_directory = build_string ("/");
891 #endif
894 if (!NILP (default_directory))
896 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
897 if (!NILP (handler))
898 return call3 (handler, Qexpand_file_name, name, default_directory);
902 unsigned char *o = SDATA (default_directory);
904 /* Make sure DEFAULT_DIRECTORY is properly expanded.
905 It would be better to do this down below where we actually use
906 default_directory. Unfortunately, calling Fexpand_file_name recursively
907 could invoke GC, and the strings might be relocated. This would
908 be annoying because we have pointers into strings lying around
909 that would need adjusting, and people would add new pointers to
910 the code and forget to adjust them, resulting in intermittent bugs.
911 Putting this call here avoids all that crud.
913 The EQ test avoids infinite recursion. */
914 if (! NILP (default_directory) && !EQ (default_directory, name)
915 /* Save time in some common cases - as long as default_directory
916 is not relative, it can be canonicalized with name below (if it
917 is needed at all) without requiring it to be expanded now. */
918 #ifdef DOS_NT
919 /* Detect MSDOS file names with drive specifiers. */
920 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
921 && IS_DIRECTORY_SEP (o[2]))
922 #ifdef WINDOWSNT
923 /* Detect Windows file names in UNC format. */
924 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
925 #endif
926 #else /* not DOS_NT */
927 /* Detect Unix absolute file names (/... alone is not absolute on
928 DOS or Windows). */
929 && ! (IS_DIRECTORY_SEP (o[0]))
930 #endif /* not DOS_NT */
933 struct gcpro gcpro1;
935 GCPRO1 (name);
936 default_directory = Fexpand_file_name (default_directory, Qnil);
937 UNGCPRO;
940 name = FILE_SYSTEM_CASE (name);
941 multibyte = STRING_MULTIBYTE (name);
942 if (multibyte != STRING_MULTIBYTE (default_directory))
944 if (multibyte)
945 default_directory = string_to_multibyte (default_directory);
946 else
948 name = string_to_multibyte (name);
949 multibyte = 1;
953 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
954 nm = (unsigned char *) alloca (SBYTES (name) + 1);
955 bcopy (SDATA (name), nm, SBYTES (name) + 1);
957 #ifdef DOS_NT
958 /* Note if special escape prefix is present, but remove for now. */
959 if (nm[0] == '/' && nm[1] == ':')
961 is_escaped = 1;
962 nm += 2;
965 /* Find and remove drive specifier if present; this makes nm absolute
966 even if the rest of the name appears to be relative. Only look for
967 drive specifier at the beginning. */
968 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
970 drive = nm[0];
971 nm += 2;
974 #ifdef WINDOWSNT
975 /* If we see "c://somedir", we want to strip the first slash after the
976 colon when stripping the drive letter. Otherwise, this expands to
977 "//somedir". */
978 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
979 nm++;
981 /* Discard any previous drive specifier if nm is now in UNC format. */
982 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
984 drive = 0;
986 #endif /* WINDOWSNT */
987 #endif /* DOS_NT */
989 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
990 none are found, we can probably return right away. We will avoid
991 allocating a new string if name is already fully expanded. */
992 if (
993 IS_DIRECTORY_SEP (nm[0])
994 #ifdef MSDOS
995 && drive && !is_escaped
996 #endif
997 #ifdef WINDOWSNT
998 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
999 #endif
1002 /* If it turns out that the filename we want to return is just a
1003 suffix of FILENAME, we don't need to go through and edit
1004 things; we just need to construct a new string using data
1005 starting at the middle of FILENAME. If we set lose to a
1006 non-zero value, that means we've discovered that we can't do
1007 that cool trick. */
1008 int lose = 0;
1009 unsigned char *p = nm;
1011 while (*p)
1013 /* Since we know the name is absolute, we can assume that each
1014 element starts with a "/". */
1016 /* "." and ".." are hairy. */
1017 if (IS_DIRECTORY_SEP (p[0])
1018 && p[1] == '.'
1019 && (IS_DIRECTORY_SEP (p[2])
1020 || p[2] == 0
1021 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1022 || p[3] == 0))))
1023 lose = 1;
1024 /* We want to replace multiple `/' in a row with a single
1025 slash. */
1026 else if (p > nm
1027 && IS_DIRECTORY_SEP (p[0])
1028 && IS_DIRECTORY_SEP (p[1]))
1029 lose = 1;
1030 p++;
1032 if (!lose)
1034 #ifdef DOS_NT
1035 /* Make sure directories are all separated with / or \ as
1036 desired, but avoid allocation of a new string when not
1037 required. */
1038 CORRECT_DIR_SEPS (nm);
1039 #ifdef WINDOWSNT
1040 if (IS_DIRECTORY_SEP (nm[1]))
1042 if (strcmp (nm, SDATA (name)) != 0)
1043 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1045 else
1046 #endif
1047 /* drive must be set, so this is okay */
1048 if (strcmp (nm - 2, SDATA (name)) != 0)
1050 char temp[] = " :";
1052 name = make_specified_string (nm, -1, p - nm, multibyte);
1053 temp[0] = DRIVE_LETTER (drive);
1054 name = concat2 (build_string (temp), name);
1056 return name;
1057 #else /* not DOS_NT */
1058 if (strcmp (nm, SDATA (name)) == 0)
1059 return name;
1060 return make_specified_string (nm, -1, strlen (nm), multibyte);
1061 #endif /* not DOS_NT */
1065 /* At this point, nm might or might not be an absolute file name. We
1066 need to expand ~ or ~user if present, otherwise prefix nm with
1067 default_directory if nm is not absolute, and finally collapse /./
1068 and /foo/../ sequences.
1070 We set newdir to be the appropriate prefix if one is needed:
1071 - the relevant user directory if nm starts with ~ or ~user
1072 - the specified drive's working dir (DOS/NT only) if nm does not
1073 start with /
1074 - the value of default_directory.
1076 Note that these prefixes are not guaranteed to be absolute (except
1077 for the working dir of a drive). Therefore, to ensure we always
1078 return an absolute name, if the final prefix is not absolute we
1079 append it to the current working directory. */
1081 newdir = 0;
1083 if (nm[0] == '~') /* prefix ~ */
1085 if (IS_DIRECTORY_SEP (nm[1])
1086 || nm[1] == 0) /* ~ by itself */
1088 Lisp_Object tem;
1090 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1091 newdir = (unsigned char *) "";
1092 nm++;
1093 /* egetenv may return a unibyte string, which will bite us since
1094 we expect the directory to be multibyte. */
1095 tem = build_string (newdir);
1096 if (!STRING_MULTIBYTE (tem))
1098 hdir = DECODE_FILE (tem);
1099 newdir = SDATA (hdir);
1101 #ifdef DOS_NT
1102 collapse_newdir = 0;
1103 #endif
1105 else /* ~user/filename */
1107 unsigned char *o, *p;
1108 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)); p++);
1109 o = alloca (p - nm + 1);
1110 bcopy ((char *) nm, o, p - nm);
1111 o [p - nm] = 0;
1113 BLOCK_INPUT;
1114 pw = (struct passwd *) getpwnam (o + 1);
1115 UNBLOCK_INPUT;
1116 if (pw)
1118 newdir = (unsigned char *) pw -> pw_dir;
1119 nm = p;
1120 #ifdef DOS_NT
1121 collapse_newdir = 0;
1122 #endif
1125 /* If we don't find a user of that name, leave the name
1126 unchanged; don't move nm forward to p. */
1130 #ifdef DOS_NT
1131 /* On DOS and Windows, nm is absolute if a drive name was specified;
1132 use the drive's current directory as the prefix if needed. */
1133 if (!newdir && drive)
1135 /* Get default directory if needed to make nm absolute. */
1136 if (!IS_DIRECTORY_SEP (nm[0]))
1138 newdir = alloca (MAXPATHLEN + 1);
1139 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1140 newdir = NULL;
1142 if (!newdir)
1144 /* Either nm starts with /, or drive isn't mounted. */
1145 newdir = alloca (4);
1146 newdir[0] = DRIVE_LETTER (drive);
1147 newdir[1] = ':';
1148 newdir[2] = '/';
1149 newdir[3] = 0;
1152 #endif /* DOS_NT */
1154 /* Finally, if no prefix has been specified and nm is not absolute,
1155 then it must be expanded relative to default_directory. */
1157 if (1
1158 #ifndef DOS_NT
1159 /* /... alone is not absolute on DOS and Windows. */
1160 && !IS_DIRECTORY_SEP (nm[0])
1161 #endif
1162 #ifdef WINDOWSNT
1163 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1164 #endif
1165 && !newdir)
1167 newdir = SDATA (default_directory);
1168 #ifdef DOS_NT
1169 /* Note if special escape prefix is present, but remove for now. */
1170 if (newdir[0] == '/' && newdir[1] == ':')
1172 is_escaped = 1;
1173 newdir += 2;
1175 #endif
1178 #ifdef DOS_NT
1179 if (newdir)
1181 /* First ensure newdir is an absolute name. */
1182 if (
1183 /* Detect MSDOS file names with drive specifiers. */
1184 ! (IS_DRIVE (newdir[0])
1185 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1186 #ifdef WINDOWSNT
1187 /* Detect Windows file names in UNC format. */
1188 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1189 #endif
1192 /* Effectively, let newdir be (expand-file-name newdir cwd).
1193 Because of the admonition against calling expand-file-name
1194 when we have pointers into lisp strings, we accomplish this
1195 indirectly by prepending newdir to nm if necessary, and using
1196 cwd (or the wd of newdir's drive) as the new newdir. */
1198 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1200 drive = newdir[0];
1201 newdir += 2;
1203 if (!IS_DIRECTORY_SEP (nm[0]))
1205 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1206 file_name_as_directory (tmp, newdir);
1207 strcat (tmp, nm);
1208 nm = tmp;
1210 newdir = alloca (MAXPATHLEN + 1);
1211 if (drive)
1213 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1214 newdir = "/";
1216 else
1217 getwd (newdir);
1220 /* Strip off drive name from prefix, if present. */
1221 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1223 drive = newdir[0];
1224 newdir += 2;
1227 /* Keep only a prefix from newdir if nm starts with slash
1228 (//server/share for UNC, nothing otherwise). */
1229 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1231 #ifdef WINDOWSNT
1232 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1234 unsigned char *p;
1235 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1236 p = newdir + 2;
1237 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1238 p++;
1239 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1240 *p = 0;
1242 else
1243 #endif
1244 newdir = "";
1247 #endif /* DOS_NT */
1249 if (newdir)
1251 /* Get rid of any slash at the end of newdir, unless newdir is
1252 just / or // (an incomplete UNC name). */
1253 length = strlen (newdir);
1254 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1255 #ifdef WINDOWSNT
1256 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1257 #endif
1260 unsigned char *temp = (unsigned char *) alloca (length);
1261 bcopy (newdir, temp, length - 1);
1262 temp[length - 1] = 0;
1263 newdir = temp;
1265 tlen = length + 1;
1267 else
1268 tlen = 0;
1270 /* Now concatenate the directory and name to new space in the stack frame */
1271 tlen += strlen (nm) + 1;
1272 #ifdef DOS_NT
1273 /* Reserve space for drive specifier and escape prefix, since either
1274 or both may need to be inserted. (The Microsoft x86 compiler
1275 produces incorrect code if the following two lines are combined.) */
1276 target = (unsigned char *) alloca (tlen + 4);
1277 target += 4;
1278 #else /* not DOS_NT */
1279 target = (unsigned char *) alloca (tlen);
1280 #endif /* not DOS_NT */
1281 *target = 0;
1283 if (newdir)
1285 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1287 #ifdef DOS_NT
1288 /* If newdir is effectively "C:/", then the drive letter will have
1289 been stripped and newdir will be "/". Concatenating with an
1290 absolute directory in nm produces "//", which will then be
1291 incorrectly treated as a network share. Ignore newdir in
1292 this case (keeping the drive letter). */
1293 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1294 && newdir[1] == '\0'))
1295 #endif
1296 strcpy (target, newdir);
1298 else
1299 file_name_as_directory (target, newdir);
1302 strcat (target, nm);
1304 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1305 appear. */
1307 unsigned char *p = target;
1308 unsigned char *o = target;
1310 while (*p)
1312 if (!IS_DIRECTORY_SEP (*p))
1314 *o++ = *p++;
1316 else if (p[1] == '.'
1317 && (IS_DIRECTORY_SEP (p[2])
1318 || p[2] == 0))
1320 /* If "/." is the entire filename, keep the "/". Otherwise,
1321 just delete the whole "/.". */
1322 if (o == target && p[2] == '\0')
1323 *o++ = *p;
1324 p += 2;
1326 else if (p[1] == '.' && p[2] == '.'
1327 /* `/../' is the "superroot" on certain file systems.
1328 Turned off on DOS_NT systems because they have no
1329 "superroot" and because this causes us to produce
1330 file names like "d:/../foo" which fail file-related
1331 functions of the underlying OS. (To reproduce, try a
1332 long series of "../../" in default_directory, longer
1333 than the number of levels from the root.) */
1334 #ifndef DOS_NT
1335 && o != target
1336 #endif
1337 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1339 #ifdef WINDOWSNT
1340 unsigned char *prev_o = o;
1341 #endif
1342 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1344 #ifdef WINDOWSNT
1345 /* Don't go below server level in UNC filenames. */
1346 if (o == target + 1 && IS_DIRECTORY_SEP (*o)
1347 && IS_DIRECTORY_SEP (*target))
1348 o = prev_o;
1349 else
1350 #endif
1351 /* Keep initial / only if this is the whole name. */
1352 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1353 ++o;
1354 p += 3;
1356 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1357 /* Collapse multiple `/' in a row. */
1358 p++;
1359 else
1361 *o++ = *p++;
1365 #ifdef DOS_NT
1366 /* At last, set drive name. */
1367 #ifdef WINDOWSNT
1368 /* Except for network file name. */
1369 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1370 #endif /* WINDOWSNT */
1372 if (!drive) abort ();
1373 target -= 2;
1374 target[0] = DRIVE_LETTER (drive);
1375 target[1] = ':';
1377 /* Reinsert the escape prefix if required. */
1378 if (is_escaped)
1380 target -= 2;
1381 target[0] = '/';
1382 target[1] = ':';
1384 CORRECT_DIR_SEPS (target);
1385 #endif /* DOS_NT */
1387 result = make_specified_string (target, -1, o - target, multibyte);
1390 /* Again look to see if the file name has special constructs in it
1391 and perhaps call the corresponding file handler. This is needed
1392 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1393 the ".." component gives us "/user@host:/bar/../baz" which needs
1394 to be expanded again. */
1395 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1396 if (!NILP (handler))
1397 return call3 (handler, Qexpand_file_name, result, default_directory);
1399 return result;
1402 #if 0
1403 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1404 This is the old version of expand-file-name, before it was thoroughly
1405 rewritten for Emacs 10.31. We leave this version here commented-out,
1406 because the code is very complex and likely to have subtle bugs. If
1407 bugs _are_ found, it might be of interest to look at the old code and
1408 see what did it do in the relevant situation.
1410 Don't remove this code: it's true that it will be accessible
1411 from the repository, but a few years from deletion, people will
1412 forget it is there. */
1414 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1415 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1416 "Convert FILENAME to absolute, and canonicalize it.\n\
1417 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1418 \(does not start with slash); if DEFAULT is nil or missing,\n\
1419 the current buffer's value of default-directory is used.\n\
1420 Filenames containing `.' or `..' as components are simplified;\n\
1421 initial `~/' expands to your home directory.\n\
1422 See also the function `substitute-in-file-name'.")
1423 (name, defalt)
1424 Lisp_Object name, defalt;
1426 unsigned char *nm;
1428 register unsigned char *newdir, *p, *o;
1429 int tlen;
1430 unsigned char *target;
1431 struct passwd *pw;
1432 int lose;
1434 CHECK_STRING (name);
1435 nm = SDATA (name);
1437 /* If nm is absolute, flush ...// and detect /./ and /../.
1438 If no /./ or /../ we can return right away. */
1439 if (nm[0] == '/')
1441 p = nm;
1442 lose = 0;
1443 while (*p)
1445 if (p[0] == '/' && p[1] == '/'
1447 nm = p + 1;
1448 if (p[0] == '/' && p[1] == '~')
1449 nm = p + 1, lose = 1;
1450 if (p[0] == '/' && p[1] == '.'
1451 && (p[2] == '/' || p[2] == 0
1452 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1453 lose = 1;
1454 p++;
1456 if (!lose)
1458 if (nm == SDATA (name))
1459 return name;
1460 return build_string (nm);
1464 /* Now determine directory to start with and put it in NEWDIR */
1466 newdir = 0;
1468 if (nm[0] == '~') /* prefix ~ */
1469 if (nm[1] == '/' || nm[1] == 0)/* ~/filename */
1471 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1472 newdir = (unsigned char *) "";
1473 nm++;
1475 else /* ~user/filename */
1477 /* Get past ~ to user */
1478 unsigned char *user = nm + 1;
1479 /* Find end of name. */
1480 unsigned char *ptr = (unsigned char *) index (user, '/');
1481 int len = ptr ? ptr - user : strlen (user);
1482 /* Copy the user name into temp storage. */
1483 o = (unsigned char *) alloca (len + 1);
1484 bcopy ((char *) user, o, len);
1485 o[len] = 0;
1487 /* Look up the user name. */
1488 BLOCK_INPUT;
1489 pw = (struct passwd *) getpwnam (o + 1);
1490 UNBLOCK_INPUT;
1491 if (!pw)
1492 error ("\"%s\" isn't a registered user", o + 1);
1494 newdir = (unsigned char *) pw->pw_dir;
1496 /* Discard the user name from NM. */
1497 nm += len;
1500 if (nm[0] != '/' && !newdir)
1502 if (NILP (defalt))
1503 defalt = current_buffer->directory;
1504 CHECK_STRING (defalt);
1505 newdir = SDATA (defalt);
1508 /* Now concatenate the directory and name to new space in the stack frame */
1510 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1511 target = (unsigned char *) alloca (tlen);
1512 *target = 0;
1514 if (newdir)
1516 if (nm[0] == 0 || nm[0] == '/')
1517 strcpy (target, newdir);
1518 else
1519 file_name_as_directory (target, newdir);
1522 strcat (target, nm);
1524 /* Now canonicalize by removing /. and /foo/.. if they appear */
1526 p = target;
1527 o = target;
1529 while (*p)
1531 if (*p != '/')
1533 *o++ = *p++;
1535 else if (!strncmp (p, "//", 2)
1538 o = target;
1539 p++;
1541 else if (p[0] == '/' && p[1] == '.'
1542 && (p[2] == '/' || p[2] == 0))
1543 p += 2;
1544 else if (!strncmp (p, "/..", 3)
1545 /* `/../' is the "superroot" on certain file systems. */
1546 && o != target
1547 && (p[3] == '/' || p[3] == 0))
1549 while (o != target && *--o != '/')
1551 if (o == target && *o == '/')
1552 ++o;
1553 p += 3;
1555 else
1557 *o++ = *p++;
1561 return make_string (target, o - target);
1563 #endif
1565 /* If /~ or // appears, discard everything through first slash. */
1566 static int
1567 file_name_absolute_p (filename)
1568 const unsigned char *filename;
1570 return
1571 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
1572 #ifdef DOS_NT
1573 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
1574 && IS_DIRECTORY_SEP (filename[2]))
1575 #endif
1579 static unsigned char *
1580 search_embedded_absfilename (nm, endp)
1581 unsigned char *nm, *endp;
1583 unsigned char *p, *s;
1585 for (p = nm + 1; p < endp; p++)
1587 if ((0
1588 || IS_DIRECTORY_SEP (p[-1]))
1589 && file_name_absolute_p (p)
1590 #if defined (WINDOWSNT) || defined(CYGWIN)
1591 /* // at start of file name is meaningful in Apollo,
1592 WindowsNT and Cygwin systems. */
1593 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
1594 #endif /* not (WINDOWSNT || CYGWIN) */
1597 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)); s++);
1598 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
1600 unsigned char *o = alloca (s - p + 1);
1601 struct passwd *pw;
1602 bcopy (p, o, s - p);
1603 o [s - p] = 0;
1605 /* If we have ~user and `user' exists, discard
1606 everything up to ~. But if `user' does not exist, leave
1607 ~user alone, it might be a literal file name. */
1608 BLOCK_INPUT;
1609 pw = getpwnam (o + 1);
1610 UNBLOCK_INPUT;
1611 if (pw)
1612 return p;
1614 else
1615 return p;
1618 return NULL;
1621 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
1622 Ssubstitute_in_file_name, 1, 1, 0,
1623 doc: /* Substitute environment variables referred to in FILENAME.
1624 `$FOO' where FOO is an environment variable name means to substitute
1625 the value of that variable. The variable name should be terminated
1626 with a character not a letter, digit or underscore; otherwise, enclose
1627 the entire variable name in braces.
1629 If `/~' appears, all of FILENAME through that `/' is discarded.
1630 If `//' appears, everything up to and including the first of
1631 those `/' is discarded. */)
1632 (filename)
1633 Lisp_Object filename;
1635 unsigned char *nm;
1637 register unsigned char *s, *p, *o, *x, *endp;
1638 unsigned char *target = NULL;
1639 int total = 0;
1640 int substituted = 0;
1641 int multibyte;
1642 unsigned char *xnm;
1643 Lisp_Object handler;
1645 CHECK_STRING (filename);
1647 multibyte = STRING_MULTIBYTE (filename);
1649 /* If the file name has special constructs in it,
1650 call the corresponding file handler. */
1651 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
1652 if (!NILP (handler))
1653 return call2 (handler, Qsubstitute_in_file_name, filename);
1655 /* Always work on a copy of the string, in case GC happens during
1656 decode of environment variables, causing the original Lisp_String
1657 data to be relocated. */
1658 nm = (unsigned char *) alloca (SBYTES (filename) + 1);
1659 bcopy (SDATA (filename), nm, SBYTES (filename) + 1);
1661 #ifdef DOS_NT
1662 CORRECT_DIR_SEPS (nm);
1663 substituted = (strcmp (nm, SDATA (filename)) != 0);
1664 #endif
1665 endp = nm + SBYTES (filename);
1667 /* If /~ or // appears, discard everything through first slash. */
1668 p = search_embedded_absfilename (nm, endp);
1669 if (p)
1670 /* Start over with the new string, so we check the file-name-handler
1671 again. Important with filenames like "/home/foo//:/hello///there"
1672 which whould substitute to "/:/hello///there" rather than "/there". */
1673 return Fsubstitute_in_file_name
1674 (make_specified_string (p, -1, endp - p, multibyte));
1676 /* See if any variables are substituted into the string
1677 and find the total length of their values in `total' */
1679 for (p = nm; p != endp;)
1680 if (*p != '$')
1681 p++;
1682 else
1684 p++;
1685 if (p == endp)
1686 goto badsubst;
1687 else if (*p == '$')
1689 /* "$$" means a single "$" */
1690 p++;
1691 total -= 1;
1692 substituted = 1;
1693 continue;
1695 else if (*p == '{')
1697 o = ++p;
1698 while (p != endp && *p != '}') p++;
1699 if (*p != '}') goto missingclose;
1700 s = p;
1702 else
1704 o = p;
1705 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1706 s = p;
1709 /* Copy out the variable name */
1710 target = (unsigned char *) alloca (s - o + 1);
1711 strncpy (target, o, s - o);
1712 target[s - o] = 0;
1713 #ifdef DOS_NT
1714 strupr (target); /* $home == $HOME etc. */
1715 #endif /* DOS_NT */
1717 /* Get variable value */
1718 o = (unsigned char *) egetenv (target);
1719 if (o)
1721 /* Don't try to guess a maximum length - UTF8 can use up to
1722 four bytes per character. This code is unlikely to run
1723 in a situation that requires performance, so decoding the
1724 env variables twice should be acceptable. Note that
1725 decoding may cause a garbage collect. */
1726 Lisp_Object orig, decoded;
1727 orig = make_unibyte_string (o, strlen (o));
1728 decoded = DECODE_FILE (orig);
1729 total += SBYTES (decoded);
1730 substituted = 1;
1732 else if (*p == '}')
1733 goto badvar;
1736 if (!substituted)
1737 return filename;
1739 /* If substitution required, recopy the string and do it */
1740 /* Make space in stack frame for the new copy */
1741 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
1742 x = xnm;
1744 /* Copy the rest of the name through, replacing $ constructs with values */
1745 for (p = nm; *p;)
1746 if (*p != '$')
1747 *x++ = *p++;
1748 else
1750 p++;
1751 if (p == endp)
1752 goto badsubst;
1753 else if (*p == '$')
1755 *x++ = *p++;
1756 continue;
1758 else if (*p == '{')
1760 o = ++p;
1761 while (p != endp && *p != '}') p++;
1762 if (*p != '}') goto missingclose;
1763 s = p++;
1765 else
1767 o = p;
1768 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1769 s = p;
1772 /* Copy out the variable name */
1773 target = (unsigned char *) alloca (s - o + 1);
1774 strncpy (target, o, s - o);
1775 target[s - o] = 0;
1776 #ifdef DOS_NT
1777 strupr (target); /* $home == $HOME etc. */
1778 #endif /* DOS_NT */
1780 /* Get variable value */
1781 o = (unsigned char *) egetenv (target);
1782 if (!o)
1784 *x++ = '$';
1785 strcpy (x, target); x+= strlen (target);
1787 else
1789 Lisp_Object orig, decoded;
1790 int orig_length, decoded_length;
1791 orig_length = strlen (o);
1792 orig = make_unibyte_string (o, orig_length);
1793 decoded = DECODE_FILE (orig);
1794 decoded_length = SBYTES (decoded);
1795 strncpy (x, SDATA (decoded), decoded_length);
1796 x += decoded_length;
1798 /* If environment variable needed decoding, return value
1799 needs to be multibyte. */
1800 if (decoded_length != orig_length
1801 || strncmp (SDATA (decoded), o, orig_length))
1802 multibyte = 1;
1806 *x = 0;
1808 /* If /~ or // appears, discard everything through first slash. */
1809 while ((p = search_embedded_absfilename (xnm, x)))
1810 /* This time we do not start over because we've already expanded envvars
1811 and replaced $$ with $. Maybe we should start over as well, but we'd
1812 need to quote some $ to $$ first. */
1813 xnm = p;
1815 return make_specified_string (xnm, -1, x - xnm, multibyte);
1817 badsubst:
1818 error ("Bad format environment-variable substitution");
1819 missingclose:
1820 error ("Missing \"}\" in environment-variable substitution");
1821 badvar:
1822 error ("Substituting nonexistent environment variable \"%s\"", target);
1824 /* NOTREACHED */
1825 return Qnil;
1828 /* A slightly faster and more convenient way to get
1829 (directory-file-name (expand-file-name FOO)). */
1831 Lisp_Object
1832 expand_and_dir_to_file (filename, defdir)
1833 Lisp_Object filename, defdir;
1835 register Lisp_Object absname;
1837 absname = Fexpand_file_name (filename, defdir);
1839 /* Remove final slash, if any (unless this is the root dir).
1840 stat behaves differently depending! */
1841 if (SCHARS (absname) > 1
1842 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
1843 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
1844 /* We cannot take shortcuts; they might be wrong for magic file names. */
1845 absname = Fdirectory_file_name (absname);
1846 return absname;
1849 /* Signal an error if the file ABSNAME already exists.
1850 If INTERACTIVE is nonzero, ask the user whether to proceed,
1851 and bypass the error if the user says to go ahead.
1852 QUERYSTRING is a name for the action that is being considered
1853 to alter the file.
1855 *STATPTR is used to store the stat information if the file exists.
1856 If the file does not exist, STATPTR->st_mode is set to 0.
1857 If STATPTR is null, we don't store into it.
1859 If QUICK is nonzero, we ask for y or n, not yes or no. */
1861 void
1862 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
1863 Lisp_Object absname;
1864 unsigned char *querystring;
1865 int interactive;
1866 struct stat *statptr;
1867 int quick;
1869 register Lisp_Object tem, encoded_filename;
1870 struct stat statbuf;
1871 struct gcpro gcpro1;
1873 encoded_filename = ENCODE_FILE (absname);
1875 /* stat is a good way to tell whether the file exists,
1876 regardless of what access permissions it has. */
1877 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
1879 if (! interactive)
1880 xsignal2 (Qfile_already_exists,
1881 build_string ("File already exists"), absname);
1882 GCPRO1 (absname);
1883 tem = format2 ("File %s already exists; %s anyway? ",
1884 absname, build_string (querystring));
1885 if (quick)
1886 tem = Fy_or_n_p (tem);
1887 else
1888 tem = do_yes_or_no_p (tem);
1889 UNGCPRO;
1890 if (NILP (tem))
1891 xsignal2 (Qfile_already_exists,
1892 build_string ("File already exists"), absname);
1893 if (statptr)
1894 *statptr = statbuf;
1896 else
1898 if (statptr)
1899 statptr->st_mode = 0;
1901 return;
1904 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 6,
1905 "fCopy file: \nGCopy %s to file: \np\nP",
1906 doc: /* Copy FILE to NEWNAME. Both args must be strings.
1907 If NEWNAME names a directory, copy FILE there.
1909 This function always sets the file modes of the output file to match
1910 the input file.
1912 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1913 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1914 signal a `file-already-exists' error without overwriting. If
1915 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1916 about overwriting; this is what happens in interactive use with M-x.
1917 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1918 existing file.
1920 Fourth arg KEEP-TIME non-nil means give the output file the same
1921 last-modified time as the old one. (This works on only some systems.)
1923 A prefix arg makes KEEP-TIME non-nil.
1925 If PRESERVE-UID-GID is non-nil, we try to transfer the
1926 uid and gid of FILE to NEWNAME.
1928 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1929 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1930 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid, preserve_selinux_context)
1931 Lisp_Object file, newname, ok_if_already_exists, keep_time;
1932 Lisp_Object preserve_uid_gid, preserve_selinux_context;
1934 int ifd, ofd, n;
1935 char buf[16 * 1024];
1936 struct stat st, out_st;
1937 Lisp_Object handler;
1938 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1939 int count = SPECPDL_INDEX ();
1940 int input_file_statable_p;
1941 Lisp_Object encoded_file, encoded_newname;
1942 #if HAVE_LIBSELINUX
1943 security_context_t con;
1944 int fail, conlength = 0;
1945 #endif
1947 encoded_file = encoded_newname = Qnil;
1948 GCPRO4 (file, newname, encoded_file, encoded_newname);
1949 CHECK_STRING (file);
1950 CHECK_STRING (newname);
1952 if (!NILP (Ffile_directory_p (newname)))
1953 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
1954 else
1955 newname = Fexpand_file_name (newname, Qnil);
1957 file = Fexpand_file_name (file, Qnil);
1959 /* If the input file name has special constructs in it,
1960 call the corresponding file handler. */
1961 handler = Ffind_file_name_handler (file, Qcopy_file);
1962 /* Likewise for output file name. */
1963 if (NILP (handler))
1964 handler = Ffind_file_name_handler (newname, Qcopy_file);
1965 if (!NILP (handler))
1966 RETURN_UNGCPRO (call7 (handler, Qcopy_file, file, newname,
1967 ok_if_already_exists, keep_time, preserve_uid_gid,
1968 preserve_selinux_context));
1970 encoded_file = ENCODE_FILE (file);
1971 encoded_newname = ENCODE_FILE (newname);
1973 if (NILP (ok_if_already_exists)
1974 || INTEGERP (ok_if_already_exists))
1975 barf_or_query_if_file_exists (newname, "copy to it",
1976 INTEGERP (ok_if_already_exists), &out_st, 0);
1977 else if (stat (SDATA (encoded_newname), &out_st) < 0)
1978 out_st.st_mode = 0;
1980 #ifdef WINDOWSNT
1981 if (!CopyFile (SDATA (encoded_file),
1982 SDATA (encoded_newname),
1983 FALSE))
1984 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
1985 /* CopyFile retains the timestamp by default. */
1986 else if (NILP (keep_time))
1988 EMACS_TIME now;
1989 DWORD attributes;
1990 char * filename;
1992 EMACS_GET_TIME (now);
1993 filename = SDATA (encoded_newname);
1995 /* Ensure file is writable while its modified time is set. */
1996 attributes = GetFileAttributes (filename);
1997 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
1998 if (set_file_times (filename, now, now))
2000 /* Restore original attributes. */
2001 SetFileAttributes (filename, attributes);
2002 xsignal2 (Qfile_date_error,
2003 build_string ("Cannot set file date"), newname);
2005 /* Restore original attributes. */
2006 SetFileAttributes (filename, attributes);
2008 #else /* not WINDOWSNT */
2009 immediate_quit = 1;
2010 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2011 immediate_quit = 0;
2013 if (ifd < 0)
2014 report_file_error ("Opening input file", Fcons (file, Qnil));
2016 record_unwind_protect (close_file_unwind, make_number (ifd));
2018 /* We can only copy regular files and symbolic links. Other files are not
2019 copyable by us. */
2020 input_file_statable_p = (fstat (ifd, &st) >= 0);
2022 #if HAVE_LIBSELINUX
2023 if (!NILP (preserve_selinux_context) && is_selinux_enabled ())
2025 conlength = fgetfilecon (ifd, &con);
2026 if (conlength == -1)
2027 report_file_error ("Doing fgetfilecon", Fcons (file, Qnil));
2029 #endif
2031 if (out_st.st_mode != 0
2032 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2034 errno = 0;
2035 report_file_error ("Input and output files are the same",
2036 Fcons (file, Fcons (newname, Qnil)));
2039 #if defined (S_ISREG) && defined (S_ISLNK)
2040 if (input_file_statable_p)
2042 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2044 #if defined (EISDIR)
2045 /* Get a better looking error message. */
2046 errno = EISDIR;
2047 #endif /* EISDIR */
2048 report_file_error ("Non-regular file", Fcons (file, Qnil));
2051 #endif /* S_ISREG && S_ISLNK */
2053 #ifdef MSDOS
2054 /* System's default file type was set to binary by _fmode in emacs.c. */
2055 ofd = emacs_open (SDATA (encoded_newname),
2056 O_WRONLY | O_TRUNC | O_CREAT
2057 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2058 S_IREAD | S_IWRITE);
2059 #else /* not MSDOS */
2060 ofd = emacs_open (SDATA (encoded_newname),
2061 O_WRONLY | O_TRUNC | O_CREAT
2062 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2063 0666);
2064 #endif /* not MSDOS */
2065 if (ofd < 0)
2066 report_file_error ("Opening output file", Fcons (newname, Qnil));
2068 record_unwind_protect (close_file_unwind, make_number (ofd));
2070 immediate_quit = 1;
2071 QUIT;
2072 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2073 if (emacs_write (ofd, buf, n) != n)
2074 report_file_error ("I/O error", Fcons (newname, Qnil));
2075 immediate_quit = 0;
2077 #ifndef MSDOS
2078 /* Preserve the original file modes, and if requested, also its
2079 owner and group. */
2080 if (input_file_statable_p)
2082 if (! NILP (preserve_uid_gid))
2083 fchown (ofd, st.st_uid, st.st_gid);
2084 fchmod (ofd, st.st_mode & 07777);
2086 #endif /* not MSDOS */
2088 #if HAVE_LIBSELINUX
2089 if (conlength > 0)
2091 /* Set the modified context back to the file. */
2092 fail = fsetfilecon (ofd, con);
2093 if (fail)
2094 report_file_error ("Doing fsetfilecon", Fcons (newname, Qnil));
2096 freecon (con);
2098 #endif
2100 /* Closing the output clobbers the file times on some systems. */
2101 if (emacs_close (ofd) < 0)
2102 report_file_error ("I/O error", Fcons (newname, Qnil));
2104 if (input_file_statable_p)
2106 if (!NILP (keep_time))
2108 EMACS_TIME atime, mtime;
2109 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2110 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2111 if (set_file_times (SDATA (encoded_newname),
2112 atime, mtime))
2113 xsignal2 (Qfile_date_error,
2114 build_string ("Cannot set file date"), newname);
2118 emacs_close (ifd);
2120 #ifdef MSDOS
2121 if (input_file_statable_p)
2123 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2124 and if it can't, it tells so. Otherwise, under MSDOS we usually
2125 get only the READ bit, which will make the copied file read-only,
2126 so it's better not to chmod at all. */
2127 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2128 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2130 #endif /* MSDOS */
2131 #endif /* not WINDOWSNT */
2133 /* Discard the unwind protects. */
2134 specpdl_ptr = specpdl + count;
2136 UNGCPRO;
2137 return Qnil;
2140 DEFUN ("make-directory-internal", Fmake_directory_internal,
2141 Smake_directory_internal, 1, 1, 0,
2142 doc: /* Create a new directory named DIRECTORY. */)
2143 (directory)
2144 Lisp_Object directory;
2146 const unsigned char *dir;
2147 Lisp_Object handler;
2148 Lisp_Object encoded_dir;
2150 CHECK_STRING (directory);
2151 directory = Fexpand_file_name (directory, Qnil);
2153 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2154 if (!NILP (handler))
2155 return call2 (handler, Qmake_directory_internal, directory);
2157 encoded_dir = ENCODE_FILE (directory);
2159 dir = SDATA (encoded_dir);
2161 #ifdef WINDOWSNT
2162 if (mkdir (dir) != 0)
2163 #else
2164 if (mkdir (dir, 0777) != 0)
2165 #endif
2166 report_file_error ("Creating directory", list1 (directory));
2168 return Qnil;
2171 DEFUN ("delete-directory-internal", Fdelete_directory_internal,
2172 Sdelete_directory_internal, 1, 1, 0,
2173 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2174 (directory)
2175 Lisp_Object directory;
2177 const unsigned char *dir;
2178 Lisp_Object handler;
2179 Lisp_Object encoded_dir;
2181 CHECK_STRING (directory);
2182 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2184 if (delete_by_moving_to_trash)
2185 return call1 (Qmove_file_to_trash, directory);
2187 encoded_dir = ENCODE_FILE (directory);
2189 dir = SDATA (encoded_dir);
2191 if (rmdir (dir) != 0)
2192 report_file_error ("Removing directory", list1 (directory));
2194 return Qnil;
2197 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2198 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2199 If file has multiple names, it continues to exist with the other names. */)
2200 (filename)
2201 Lisp_Object filename;
2203 Lisp_Object handler;
2204 Lisp_Object encoded_file;
2205 struct gcpro gcpro1;
2207 GCPRO1 (filename);
2208 if (!NILP (Ffile_directory_p (filename))
2209 && NILP (Ffile_symlink_p (filename)))
2210 xsignal2 (Qfile_error,
2211 build_string ("Removing old name: is a directory"),
2212 filename);
2213 UNGCPRO;
2214 filename = Fexpand_file_name (filename, Qnil);
2216 handler = Ffind_file_name_handler (filename, Qdelete_file);
2217 if (!NILP (handler))
2218 return call2 (handler, Qdelete_file, filename);
2220 if (delete_by_moving_to_trash)
2221 return call1 (Qmove_file_to_trash, filename);
2223 encoded_file = ENCODE_FILE (filename);
2225 if (0 > unlink (SDATA (encoded_file)))
2226 report_file_error ("Removing old name", list1 (filename));
2227 return Qnil;
2230 static Lisp_Object
2231 internal_delete_file_1 (ignore)
2232 Lisp_Object ignore;
2234 return Qt;
2237 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2240 internal_delete_file (filename)
2241 Lisp_Object filename;
2243 Lisp_Object tem;
2244 tem = internal_condition_case_1 (Fdelete_file, filename,
2245 Qt, internal_delete_file_1);
2246 return NILP (tem);
2249 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2250 "fRename file: \nGRename %s to file: \np",
2251 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2252 If file has names other than FILE, it continues to have those names.
2253 Signals a `file-already-exists' error if a file NEWNAME already exists
2254 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2255 A number as third arg means request confirmation if NEWNAME already exists.
2256 This is what happens in interactive use with M-x. */)
2257 (file, newname, ok_if_already_exists)
2258 Lisp_Object file, newname, ok_if_already_exists;
2260 Lisp_Object handler;
2261 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2262 Lisp_Object encoded_file, encoded_newname, symlink_target;
2264 symlink_target = encoded_file = encoded_newname = Qnil;
2265 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2266 CHECK_STRING (file);
2267 CHECK_STRING (newname);
2268 file = Fexpand_file_name (file, Qnil);
2270 if ((!NILP (Ffile_directory_p (newname)))
2271 #ifdef DOS_NT
2272 /* If the file names are identical but for the case,
2273 don't attempt to move directory to itself. */
2274 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2275 #endif
2278 Lisp_Object fname = NILP (Ffile_directory_p (file))
2279 ? file : Fdirectory_file_name (file);
2280 newname = Fexpand_file_name (Ffile_name_nondirectory (fname), newname);
2282 else
2283 newname = Fexpand_file_name (newname, Qnil);
2285 /* If the file name has special constructs in it,
2286 call the corresponding file handler. */
2287 handler = Ffind_file_name_handler (file, Qrename_file);
2288 if (NILP (handler))
2289 handler = Ffind_file_name_handler (newname, Qrename_file);
2290 if (!NILP (handler))
2291 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2292 file, newname, ok_if_already_exists));
2294 encoded_file = ENCODE_FILE (file);
2295 encoded_newname = ENCODE_FILE (newname);
2297 #ifdef DOS_NT
2298 /* If the file names are identical but for the case, don't ask for
2299 confirmation: they simply want to change the letter-case of the
2300 file name. */
2301 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2302 #endif
2303 if (NILP (ok_if_already_exists)
2304 || INTEGERP (ok_if_already_exists))
2305 barf_or_query_if_file_exists (newname, "rename to it",
2306 INTEGERP (ok_if_already_exists), 0, 0);
2307 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2309 if (errno == EXDEV)
2311 int count;
2312 #ifdef S_IFLNK
2313 symlink_target = Ffile_symlink_p (file);
2314 if (! NILP (symlink_target))
2315 Fmake_symbolic_link (symlink_target, newname,
2316 NILP (ok_if_already_exists) ? Qnil : Qt);
2317 else
2318 #endif
2319 if (!NILP (Ffile_directory_p (file)))
2320 call4 (Qcopy_directory, file, newname, Qt, Qnil);
2321 else
2322 /* We have already prompted if it was an integer, so don't
2323 have copy-file prompt again. */
2324 Fcopy_file (file, newname,
2325 NILP (ok_if_already_exists) ? Qnil : Qt,
2326 Qt, Qt, Qt);
2328 count = SPECPDL_INDEX ();
2329 specbind (Qdelete_by_moving_to_trash, Qnil);
2331 if (!NILP (Ffile_directory_p (file))
2332 #ifdef S_IFLNK
2333 && NILP (symlink_target)
2334 #endif
2336 call2 (Qdelete_directory, file, Qt);
2337 else
2338 Fdelete_file (file);
2339 unbind_to (count, Qnil);
2341 else
2342 report_file_error ("Renaming", list2 (file, newname));
2344 UNGCPRO;
2345 return Qnil;
2348 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2349 "fAdd name to file: \nGName to add to %s: \np",
2350 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2351 Signals a `file-already-exists' error if a file NEWNAME already exists
2352 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2353 A number as third arg means request confirmation if NEWNAME already exists.
2354 This is what happens in interactive use with M-x. */)
2355 (file, newname, ok_if_already_exists)
2356 Lisp_Object file, newname, ok_if_already_exists;
2358 Lisp_Object handler;
2359 Lisp_Object encoded_file, encoded_newname;
2360 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2362 GCPRO4 (file, newname, encoded_file, encoded_newname);
2363 encoded_file = encoded_newname = Qnil;
2364 CHECK_STRING (file);
2365 CHECK_STRING (newname);
2366 file = Fexpand_file_name (file, Qnil);
2368 if (!NILP (Ffile_directory_p (newname)))
2369 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2370 else
2371 newname = Fexpand_file_name (newname, Qnil);
2373 /* If the file name has special constructs in it,
2374 call the corresponding file handler. */
2375 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2376 if (!NILP (handler))
2377 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2378 newname, ok_if_already_exists));
2380 /* If the new name has special constructs in it,
2381 call the corresponding file handler. */
2382 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2383 if (!NILP (handler))
2384 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2385 newname, ok_if_already_exists));
2387 encoded_file = ENCODE_FILE (file);
2388 encoded_newname = ENCODE_FILE (newname);
2390 if (NILP (ok_if_already_exists)
2391 || INTEGERP (ok_if_already_exists))
2392 barf_or_query_if_file_exists (newname, "make it a new name",
2393 INTEGERP (ok_if_already_exists), 0, 0);
2395 unlink (SDATA (newname));
2396 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2397 report_file_error ("Adding new name", list2 (file, newname));
2399 UNGCPRO;
2400 return Qnil;
2403 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2404 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2405 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2406 Both args must be strings.
2407 Signals a `file-already-exists' error if a file LINKNAME already exists
2408 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2409 A number as third arg means request confirmation if LINKNAME already exists.
2410 This happens for interactive use with M-x. */)
2411 (filename, linkname, ok_if_already_exists)
2412 Lisp_Object filename, linkname, ok_if_already_exists;
2414 Lisp_Object handler;
2415 Lisp_Object encoded_filename, encoded_linkname;
2416 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2418 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2419 encoded_filename = encoded_linkname = Qnil;
2420 CHECK_STRING (filename);
2421 CHECK_STRING (linkname);
2422 /* If the link target has a ~, we must expand it to get
2423 a truly valid file name. Otherwise, do not expand;
2424 we want to permit links to relative file names. */
2425 if (SREF (filename, 0) == '~')
2426 filename = Fexpand_file_name (filename, Qnil);
2428 if (!NILP (Ffile_directory_p (linkname)))
2429 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2430 else
2431 linkname = Fexpand_file_name (linkname, Qnil);
2433 /* If the file name has special constructs in it,
2434 call the corresponding file handler. */
2435 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2436 if (!NILP (handler))
2437 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2438 linkname, ok_if_already_exists));
2440 /* If the new link name has special constructs in it,
2441 call the corresponding file handler. */
2442 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2443 if (!NILP (handler))
2444 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2445 linkname, ok_if_already_exists));
2447 #ifdef S_IFLNK
2448 encoded_filename = ENCODE_FILE (filename);
2449 encoded_linkname = ENCODE_FILE (linkname);
2451 if (NILP (ok_if_already_exists)
2452 || INTEGERP (ok_if_already_exists))
2453 barf_or_query_if_file_exists (linkname, "make it a link",
2454 INTEGERP (ok_if_already_exists), 0, 0);
2455 if (0 > symlink (SDATA (encoded_filename),
2456 SDATA (encoded_linkname)))
2458 /* If we didn't complain already, silently delete existing file. */
2459 if (errno == EEXIST)
2461 unlink (SDATA (encoded_linkname));
2462 if (0 <= symlink (SDATA (encoded_filename),
2463 SDATA (encoded_linkname)))
2465 UNGCPRO;
2466 return Qnil;
2470 report_file_error ("Making symbolic link", list2 (filename, linkname));
2472 UNGCPRO;
2473 return Qnil;
2475 #else
2476 UNGCPRO;
2477 xsignal1 (Qfile_error, build_string ("Symbolic links are not supported"));
2479 #endif /* S_IFLNK */
2483 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2484 1, 1, 0,
2485 doc: /* Return t if file FILENAME specifies an absolute file name.
2486 On Unix, this is a name starting with a `/' or a `~'. */)
2487 (filename)
2488 Lisp_Object filename;
2490 CHECK_STRING (filename);
2491 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
2494 /* Return nonzero if file FILENAME exists and can be executed. */
2496 static int
2497 check_executable (filename)
2498 char *filename;
2500 #ifdef DOS_NT
2501 int len = strlen (filename);
2502 char *suffix;
2503 struct stat st;
2504 if (stat (filename, &st) < 0)
2505 return 0;
2506 return ((st.st_mode & S_IEXEC) != 0);
2507 #else /* not DOS_NT */
2508 #ifdef HAVE_EUIDACCESS
2509 return (euidaccess (filename, 1) >= 0);
2510 #else
2511 /* Access isn't quite right because it uses the real uid
2512 and we really want to test with the effective uid.
2513 But Unix doesn't give us a right way to do it. */
2514 return (access (filename, 1) >= 0);
2515 #endif
2516 #endif /* not DOS_NT */
2519 /* Return nonzero if file FILENAME exists and can be written. */
2521 static int
2522 check_writable (filename)
2523 char *filename;
2525 #ifdef MSDOS
2526 struct stat st;
2527 if (stat (filename, &st) < 0)
2528 return 0;
2529 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
2530 #else /* not MSDOS */
2531 #ifdef HAVE_EUIDACCESS
2532 return (euidaccess (filename, 2) >= 0);
2533 #else
2534 /* Access isn't quite right because it uses the real uid
2535 and we really want to test with the effective uid.
2536 But Unix doesn't give us a right way to do it.
2537 Opening with O_WRONLY could work for an ordinary file,
2538 but would lose for directories. */
2539 return (access (filename, 2) >= 0);
2540 #endif
2541 #endif /* not MSDOS */
2544 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2545 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
2546 See also `file-readable-p' and `file-attributes'.
2547 This returns nil for a symlink to a nonexistent file.
2548 Use `file-symlink-p' to test for such links. */)
2549 (filename)
2550 Lisp_Object filename;
2552 Lisp_Object absname;
2553 Lisp_Object handler;
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_exists_p);
2562 if (!NILP (handler))
2563 return call2 (handler, Qfile_exists_p, absname);
2565 absname = ENCODE_FILE (absname);
2567 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
2570 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2571 doc: /* Return t if FILENAME can be executed by you.
2572 For a directory, this means you can access files in that directory. */)
2573 (filename)
2574 Lisp_Object filename;
2576 Lisp_Object absname;
2577 Lisp_Object handler;
2579 CHECK_STRING (filename);
2580 absname = Fexpand_file_name (filename, Qnil);
2582 /* If the file name has special constructs in it,
2583 call the corresponding file handler. */
2584 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
2585 if (!NILP (handler))
2586 return call2 (handler, Qfile_executable_p, absname);
2588 absname = ENCODE_FILE (absname);
2590 return (check_executable (SDATA (absname)) ? Qt : Qnil);
2593 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
2594 doc: /* Return t if file FILENAME exists and you can read it.
2595 See also `file-exists-p' and `file-attributes'. */)
2596 (filename)
2597 Lisp_Object filename;
2599 Lisp_Object absname;
2600 Lisp_Object handler;
2601 int desc;
2602 int flags;
2603 struct stat statbuf;
2605 CHECK_STRING (filename);
2606 absname = Fexpand_file_name (filename, Qnil);
2608 /* If the file name has special constructs in it,
2609 call the corresponding file handler. */
2610 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
2611 if (!NILP (handler))
2612 return call2 (handler, Qfile_readable_p, absname);
2614 absname = ENCODE_FILE (absname);
2616 #if defined(DOS_NT) || defined(macintosh)
2617 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2618 directories. */
2619 if (access (SDATA (absname), 0) == 0)
2620 return Qt;
2621 return Qnil;
2622 #else /* not DOS_NT and not macintosh */
2623 flags = O_RDONLY;
2624 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2625 /* Opening a fifo without O_NONBLOCK can wait.
2626 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2627 except in the case of a fifo, on a system which handles it. */
2628 desc = stat (SDATA (absname), &statbuf);
2629 if (desc < 0)
2630 return Qnil;
2631 if (S_ISFIFO (statbuf.st_mode))
2632 flags |= O_NONBLOCK;
2633 #endif
2634 desc = emacs_open (SDATA (absname), flags, 0);
2635 if (desc < 0)
2636 return Qnil;
2637 emacs_close (desc);
2638 return Qt;
2639 #endif /* not DOS_NT and not macintosh */
2642 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2643 on the RT/PC. */
2644 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
2645 doc: /* Return t if file FILENAME can be written or created by you. */)
2646 (filename)
2647 Lisp_Object filename;
2649 Lisp_Object absname, dir, encoded;
2650 Lisp_Object handler;
2651 struct stat statbuf;
2653 CHECK_STRING (filename);
2654 absname = Fexpand_file_name (filename, Qnil);
2656 /* If the file name has special constructs in it,
2657 call the corresponding file handler. */
2658 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
2659 if (!NILP (handler))
2660 return call2 (handler, Qfile_writable_p, absname);
2662 encoded = ENCODE_FILE (absname);
2663 if (stat (SDATA (encoded), &statbuf) >= 0)
2664 return (check_writable (SDATA (encoded))
2665 ? Qt : Qnil);
2667 dir = Ffile_name_directory (absname);
2668 #ifdef MSDOS
2669 if (!NILP (dir))
2670 dir = Fdirectory_file_name (dir);
2671 #endif /* MSDOS */
2673 dir = ENCODE_FILE (dir);
2674 #ifdef WINDOWSNT
2675 /* The read-only attribute of the parent directory doesn't affect
2676 whether a file or directory can be created within it. Some day we
2677 should check ACLs though, which do affect this. */
2678 if (stat (SDATA (dir), &statbuf) < 0)
2679 return Qnil;
2680 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
2681 #else
2682 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
2683 ? Qt : Qnil);
2684 #endif
2687 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
2688 doc: /* Access file FILENAME, and get an error if that does not work.
2689 The second argument STRING is used in the error message.
2690 If there is no error, returns nil. */)
2691 (filename, string)
2692 Lisp_Object filename, string;
2694 Lisp_Object handler, encoded_filename, absname;
2695 int fd;
2697 CHECK_STRING (filename);
2698 absname = Fexpand_file_name (filename, Qnil);
2700 CHECK_STRING (string);
2702 /* If the file name has special constructs in it,
2703 call the corresponding file handler. */
2704 handler = Ffind_file_name_handler (absname, Qaccess_file);
2705 if (!NILP (handler))
2706 return call3 (handler, Qaccess_file, absname, string);
2708 encoded_filename = ENCODE_FILE (absname);
2710 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
2711 if (fd < 0)
2712 report_file_error (SDATA (string), Fcons (filename, Qnil));
2713 emacs_close (fd);
2715 return Qnil;
2718 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
2719 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
2720 The value is the link target, as a string.
2721 Otherwise it returns nil.
2723 This function returns t when given the name of a symlink that
2724 points to a nonexistent file. */)
2725 (filename)
2726 Lisp_Object filename;
2728 Lisp_Object handler;
2730 CHECK_STRING (filename);
2731 filename = Fexpand_file_name (filename, Qnil);
2733 /* If the file name has special constructs in it,
2734 call the corresponding file handler. */
2735 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
2736 if (!NILP (handler))
2737 return call2 (handler, Qfile_symlink_p, filename);
2739 #ifdef S_IFLNK
2741 char *buf;
2742 int bufsize;
2743 int valsize;
2744 Lisp_Object val;
2746 filename = ENCODE_FILE (filename);
2748 bufsize = 50;
2749 buf = NULL;
2752 bufsize *= 2;
2753 buf = (char *) xrealloc (buf, bufsize);
2754 bzero (buf, bufsize);
2756 errno = 0;
2757 valsize = readlink (SDATA (filename), buf, bufsize);
2758 if (valsize == -1)
2760 #ifdef ERANGE
2761 /* HP-UX reports ERANGE if buffer is too small. */
2762 if (errno == ERANGE)
2763 valsize = bufsize;
2764 else
2765 #endif
2767 xfree (buf);
2768 return Qnil;
2772 while (valsize >= bufsize);
2774 val = make_string (buf, valsize);
2775 if (buf[0] == '/' && index (buf, ':'))
2776 val = concat2 (build_string ("/:"), val);
2777 xfree (buf);
2778 val = DECODE_FILE (val);
2779 return val;
2781 #else /* not S_IFLNK */
2782 return Qnil;
2783 #endif /* not S_IFLNK */
2786 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
2787 doc: /* Return t if FILENAME names an existing directory.
2788 Symbolic links to directories count as directories.
2789 See `file-symlink-p' to distinguish symlinks. */)
2790 (filename)
2791 Lisp_Object filename;
2793 register Lisp_Object absname;
2794 struct stat st;
2795 Lisp_Object handler;
2797 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2799 /* If the file name has special constructs in it,
2800 call the corresponding file handler. */
2801 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
2802 if (!NILP (handler))
2803 return call2 (handler, Qfile_directory_p, absname);
2805 absname = ENCODE_FILE (absname);
2807 if (stat (SDATA (absname), &st) < 0)
2808 return Qnil;
2809 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
2812 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
2813 doc: /* Return t if file FILENAME names a directory you can open.
2814 For the value to be t, FILENAME must specify the name of a directory as a file,
2815 and the directory must allow you to open files in it. In order to use a
2816 directory as a buffer's current directory, this predicate must return true.
2817 A directory name spec may be given instead; then the value is t
2818 if the directory so specified exists and really is a readable and
2819 searchable directory. */)
2820 (filename)
2821 Lisp_Object filename;
2823 Lisp_Object handler;
2824 int tem;
2825 struct gcpro gcpro1;
2827 /* If the file name has special constructs in it,
2828 call the corresponding file handler. */
2829 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
2830 if (!NILP (handler))
2831 return call2 (handler, Qfile_accessible_directory_p, filename);
2833 GCPRO1 (filename);
2834 tem = (NILP (Ffile_directory_p (filename))
2835 || NILP (Ffile_executable_p (filename)));
2836 UNGCPRO;
2837 return tem ? Qnil : Qt;
2840 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
2841 doc: /* Return t if FILENAME names a regular file.
2842 This is the sort of file that holds an ordinary stream of data bytes.
2843 Symbolic links to regular files count as regular files.
2844 See `file-symlink-p' to distinguish symlinks. */)
2845 (filename)
2846 Lisp_Object filename;
2848 register Lisp_Object absname;
2849 struct stat st;
2850 Lisp_Object handler;
2852 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2854 /* If the file name has special constructs in it,
2855 call the corresponding file handler. */
2856 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
2857 if (!NILP (handler))
2858 return call2 (handler, Qfile_regular_p, absname);
2860 absname = ENCODE_FILE (absname);
2862 #ifdef WINDOWSNT
2864 int result;
2865 Lisp_Object tem = Vw32_get_true_file_attributes;
2867 /* Tell stat to use expensive method to get accurate info. */
2868 Vw32_get_true_file_attributes = Qt;
2869 result = stat (SDATA (absname), &st);
2870 Vw32_get_true_file_attributes = tem;
2872 if (result < 0)
2873 return Qnil;
2874 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
2876 #else
2877 if (stat (SDATA (absname), &st) < 0)
2878 return Qnil;
2879 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
2880 #endif
2883 DEFUN ("file-selinux-context", Ffile_selinux_context,
2884 Sfile_selinux_context, 1, 1, 0,
2885 doc: /* Return SELinux context of file named FILENAME,
2886 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2887 if file does not exist, is not accessible, or SELinux is disabled */)
2888 (filename)
2889 Lisp_Object filename;
2891 Lisp_Object absname;
2892 Lisp_Object values[4];
2893 Lisp_Object handler;
2894 #if HAVE_LIBSELINUX
2895 security_context_t con;
2896 int conlength;
2897 context_t context;
2898 #endif
2900 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2902 /* If the file name has special constructs in it,
2903 call the corresponding file handler. */
2904 handler = Ffind_file_name_handler (absname, Qfile_selinux_context);
2905 if (!NILP (handler))
2906 return call2 (handler, Qfile_selinux_context, absname);
2908 absname = ENCODE_FILE (absname);
2910 values[0] = Qnil;
2911 values[1] = Qnil;
2912 values[2] = Qnil;
2913 values[3] = Qnil;
2914 #if HAVE_LIBSELINUX
2915 if (is_selinux_enabled ())
2917 conlength = lgetfilecon (SDATA (absname), &con);
2918 if (conlength > 0)
2920 context = context_new (con);
2921 values[0] = build_string (context_user_get (context));
2922 values[1] = build_string (context_role_get (context));
2923 values[2] = build_string (context_type_get (context));
2924 values[3] = build_string (context_range_get (context));
2925 context_free (context);
2927 if (con)
2928 freecon (con);
2930 #endif
2932 return Flist (sizeof(values) / sizeof(values[0]), values);
2935 DEFUN ("set-file-selinux-context", Fset_file_selinux_context,
2936 Sset_file_selinux_context, 2, 2, 0,
2937 doc: /* Set SELinux context of file named FILENAME to CONTEXT
2938 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2939 is disabled. */)
2940 (filename, context)
2941 Lisp_Object filename, context;
2943 Lisp_Object absname, encoded_absname;
2944 Lisp_Object handler;
2945 Lisp_Object user = CAR_SAFE (context);
2946 Lisp_Object role = CAR_SAFE (CDR_SAFE (context));
2947 Lisp_Object type = CAR_SAFE (CDR_SAFE (CDR_SAFE (context)));
2948 Lisp_Object range = CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context))));
2949 #if HAVE_LIBSELINUX
2950 security_context_t con;
2951 int fail, conlength;
2952 context_t parsed_con;
2953 #endif
2955 absname = Fexpand_file_name (filename, current_buffer->directory);
2957 /* If the file name has special constructs in it,
2958 call the corresponding file handler. */
2959 handler = Ffind_file_name_handler (absname, Qset_file_selinux_context);
2960 if (!NILP (handler))
2961 return call3 (handler, Qset_file_selinux_context, absname, context);
2963 encoded_absname = ENCODE_FILE (absname);
2965 #if HAVE_LIBSELINUX
2966 if (is_selinux_enabled ())
2968 /* Get current file context. */
2969 conlength = lgetfilecon (SDATA (encoded_absname), &con);
2970 if (conlength > 0)
2972 parsed_con = context_new (con);
2973 /* Change the parts defined in the parameter.*/
2974 if (STRINGP (user))
2976 if (context_user_set (parsed_con, SDATA (user)))
2977 error ("Doing context_user_set");
2979 if (STRINGP (role))
2981 if (context_role_set (parsed_con, SDATA (role)))
2982 error ("Doing context_role_set");
2984 if (STRINGP (type))
2986 if (context_type_set (parsed_con, SDATA (type)))
2987 error ("Doing context_type_set");
2989 if (STRINGP (range))
2991 if (context_range_set (parsed_con, SDATA (range)))
2992 error ("Doing context_range_set");
2995 /* Set the modified context back to the file. */
2996 fail = lsetfilecon (SDATA (encoded_absname), context_str (parsed_con));
2997 if (fail)
2998 report_file_error ("Doing lsetfilecon", Fcons (absname, Qnil));
3000 context_free (parsed_con);
3002 else
3003 report_file_error("Doing lgetfilecon", Fcons (absname, Qnil));
3005 if (con)
3006 freecon (con);
3008 #endif
3010 return Qnil;
3013 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3014 doc: /* Return mode bits of file named FILENAME, as an integer.
3015 Return nil, if file does not exist or is not accessible. */)
3016 (filename)
3017 Lisp_Object filename;
3019 Lisp_Object absname;
3020 struct stat st;
3021 Lisp_Object handler;
3023 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3025 /* If the file name has special constructs in it,
3026 call the corresponding file handler. */
3027 handler = Ffind_file_name_handler (absname, Qfile_modes);
3028 if (!NILP (handler))
3029 return call2 (handler, Qfile_modes, absname);
3031 absname = ENCODE_FILE (absname);
3033 if (stat (SDATA (absname), &st) < 0)
3034 return Qnil;
3036 return make_number (st.st_mode & 07777);
3039 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2,
3040 "(let ((file (read-file-name \"File: \"))) \
3041 (list file (read-file-modes nil file)))",
3042 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3043 Only the 12 low bits of MODE are used.
3045 Interactively, mode bits are read by `read-file-modes', which accepts
3046 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3047 (filename, mode)
3048 Lisp_Object filename, mode;
3050 Lisp_Object absname, encoded_absname;
3051 Lisp_Object handler;
3053 absname = Fexpand_file_name (filename, current_buffer->directory);
3054 CHECK_NUMBER (mode);
3056 /* If the file name has special constructs in it,
3057 call the corresponding file handler. */
3058 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3059 if (!NILP (handler))
3060 return call3 (handler, Qset_file_modes, absname, mode);
3062 encoded_absname = ENCODE_FILE (absname);
3064 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3065 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3067 return Qnil;
3070 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3071 doc: /* Set the file permission bits for newly created files.
3072 The argument MODE should be an integer; only the low 9 bits are used.
3073 This setting is inherited by subprocesses. */)
3074 (mode)
3075 Lisp_Object mode;
3077 CHECK_NUMBER (mode);
3079 umask ((~ XINT (mode)) & 0777);
3081 return Qnil;
3084 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3085 doc: /* Return the default file protection for created files.
3086 The value is an integer. */)
3089 int realmask;
3090 Lisp_Object value;
3092 realmask = umask (0);
3093 umask (realmask);
3095 XSETINT (value, (~ realmask) & 0777);
3096 return value;
3099 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3101 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3102 doc: /* Set times of file FILENAME to TIME.
3103 Set both access and modification times.
3104 Return t on success, else nil.
3105 Use the current time if TIME is nil. TIME is in the format of
3106 `current-time'. */)
3107 (filename, time)
3108 Lisp_Object filename, time;
3110 Lisp_Object absname, encoded_absname;
3111 Lisp_Object handler;
3112 time_t sec;
3113 int usec;
3115 if (! lisp_time_argument (time, &sec, &usec))
3116 error ("Invalid time specification");
3118 absname = Fexpand_file_name (filename, current_buffer->directory);
3120 /* If the file name has special constructs in it,
3121 call the corresponding file handler. */
3122 handler = Ffind_file_name_handler (absname, Qset_file_times);
3123 if (!NILP (handler))
3124 return call3 (handler, Qset_file_times, absname, time);
3126 encoded_absname = ENCODE_FILE (absname);
3129 EMACS_TIME t;
3131 EMACS_SET_SECS (t, sec);
3132 EMACS_SET_USECS (t, usec);
3134 if (set_file_times (SDATA (encoded_absname), t, t))
3136 #ifdef DOS_NT
3137 struct stat st;
3139 /* Setting times on a directory always fails. */
3140 if (stat (SDATA (encoded_absname), &st) == 0
3141 && (st.st_mode & S_IFMT) == S_IFDIR)
3142 return Qnil;
3143 #endif
3144 report_file_error ("Setting file times", Fcons (absname, Qnil));
3145 return Qnil;
3149 return Qt;
3152 #ifdef HAVE_SYNC
3153 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3154 doc: /* Tell Unix to finish all pending disk updates. */)
3157 sync ();
3158 return Qnil;
3161 #endif /* HAVE_SYNC */
3163 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3164 doc: /* Return t if file FILE1 is newer than file FILE2.
3165 If FILE1 does not exist, the answer is nil;
3166 otherwise, if FILE2 does not exist, the answer is t. */)
3167 (file1, file2)
3168 Lisp_Object file1, file2;
3170 Lisp_Object absname1, absname2;
3171 struct stat st;
3172 int mtime1;
3173 Lisp_Object handler;
3174 struct gcpro gcpro1, gcpro2;
3176 CHECK_STRING (file1);
3177 CHECK_STRING (file2);
3179 absname1 = Qnil;
3180 GCPRO2 (absname1, file2);
3181 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3182 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3183 UNGCPRO;
3185 /* If the file name has special constructs in it,
3186 call the corresponding file handler. */
3187 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3188 if (NILP (handler))
3189 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3190 if (!NILP (handler))
3191 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3193 GCPRO2 (absname1, absname2);
3194 absname1 = ENCODE_FILE (absname1);
3195 absname2 = ENCODE_FILE (absname2);
3196 UNGCPRO;
3198 if (stat (SDATA (absname1), &st) < 0)
3199 return Qnil;
3201 mtime1 = st.st_mtime;
3203 if (stat (SDATA (absname2), &st) < 0)
3204 return Qt;
3206 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3209 #ifdef DOS_NT
3210 Lisp_Object Qfind_buffer_file_type;
3211 #endif /* DOS_NT */
3213 #ifndef READ_BUF_SIZE
3214 #define READ_BUF_SIZE (64 << 10)
3215 #endif
3217 /* This function is called after Lisp functions to decide a coding
3218 system are called, or when they cause an error. Before they are
3219 called, the current buffer is set unibyte and it contains only a
3220 newly inserted text (thus the buffer was empty before the
3221 insertion).
3223 The functions may set markers, overlays, text properties, or even
3224 alter the buffer contents, change the current buffer.
3226 Here, we reset all those changes by:
3227 o set back the current buffer.
3228 o move all markers and overlays to BEG.
3229 o remove all text properties.
3230 o set back the buffer multibyteness. */
3232 static Lisp_Object
3233 decide_coding_unwind (unwind_data)
3234 Lisp_Object unwind_data;
3236 Lisp_Object multibyte, undo_list, buffer;
3238 multibyte = XCAR (unwind_data);
3239 unwind_data = XCDR (unwind_data);
3240 undo_list = XCAR (unwind_data);
3241 buffer = XCDR (unwind_data);
3243 if (current_buffer != XBUFFER (buffer))
3244 set_buffer_internal (XBUFFER (buffer));
3245 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3246 adjust_overlays_for_delete (BEG, Z - BEG);
3247 BUF_INTERVALS (current_buffer) = 0;
3248 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3250 /* Now we are safe to change the buffer's multibyteness directly. */
3251 current_buffer->enable_multibyte_characters = multibyte;
3252 current_buffer->undo_list = undo_list;
3254 return Qnil;
3258 /* Used to pass values from insert-file-contents to read_non_regular. */
3260 static int non_regular_fd;
3261 static EMACS_INT non_regular_inserted;
3262 static EMACS_INT non_regular_nbytes;
3265 /* Read from a non-regular file.
3266 Read non_regular_trytry bytes max from non_regular_fd.
3267 Non_regular_inserted specifies where to put the read bytes.
3268 Value is the number of bytes read. */
3270 static Lisp_Object
3271 read_non_regular ()
3273 EMACS_INT nbytes;
3275 immediate_quit = 1;
3276 QUIT;
3277 nbytes = emacs_read (non_regular_fd,
3278 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3279 non_regular_nbytes);
3280 immediate_quit = 0;
3281 return make_number (nbytes);
3285 /* Condition-case handler used when reading from non-regular files
3286 in insert-file-contents. */
3288 static Lisp_Object
3289 read_non_regular_quit ()
3291 return Qnil;
3295 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3296 1, 5, 0,
3297 doc: /* Insert contents of file FILENAME after point.
3298 Returns list of absolute file name and number of characters inserted.
3299 If second argument VISIT is non-nil, the buffer's visited filename and
3300 last save file modtime are set, and it is marked unmodified. If
3301 visiting and the file does not exist, visiting is completed before the
3302 error is signaled.
3304 The optional third and fourth arguments BEG and END specify what portion
3305 of the file to insert. These arguments count bytes in the file, not
3306 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3308 If optional fifth argument REPLACE is non-nil, replace the current
3309 buffer contents (in the accessible portion) with the file contents.
3310 This is better than simply deleting and inserting the whole thing
3311 because (1) it preserves some marker positions and (2) it puts less data
3312 in the undo list. When REPLACE is non-nil, the second return value is
3313 the number of characters that replace previous buffer contents.
3315 This function does code conversion according to the value of
3316 `coding-system-for-read' or `file-coding-system-alist', and sets the
3317 variable `last-coding-system-used' to the coding system actually used. */)
3318 (filename, visit, beg, end, replace)
3319 Lisp_Object filename, visit, beg, end, replace;
3321 struct stat st;
3322 register int fd;
3323 EMACS_INT inserted = 0;
3324 int nochange = 0;
3325 register EMACS_INT how_much;
3326 register EMACS_INT unprocessed;
3327 int count = SPECPDL_INDEX ();
3328 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3329 Lisp_Object handler, val, insval, orig_filename, old_undo;
3330 Lisp_Object p;
3331 EMACS_INT total = 0;
3332 int not_regular = 0;
3333 unsigned char read_buf[READ_BUF_SIZE];
3334 struct coding_system coding;
3335 unsigned char buffer[1 << 14];
3336 int replace_handled = 0;
3337 int set_coding_system = 0;
3338 Lisp_Object coding_system;
3339 int read_quit = 0;
3340 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3341 int we_locked_file = 0;
3342 int deferred_remove_unwind_protect = 0;
3344 if (current_buffer->base_buffer && ! NILP (visit))
3345 error ("Cannot do file visiting in an indirect buffer");
3347 if (!NILP (current_buffer->read_only))
3348 Fbarf_if_buffer_read_only ();
3350 val = Qnil;
3351 p = Qnil;
3352 orig_filename = Qnil;
3353 old_undo = Qnil;
3355 GCPRO5 (filename, val, p, orig_filename, old_undo);
3357 CHECK_STRING (filename);
3358 filename = Fexpand_file_name (filename, Qnil);
3360 /* The value Qnil means that the coding system is not yet
3361 decided. */
3362 coding_system = Qnil;
3364 /* If the file name has special constructs in it,
3365 call the corresponding file handler. */
3366 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3367 if (!NILP (handler))
3369 val = call6 (handler, Qinsert_file_contents, filename,
3370 visit, beg, end, replace);
3371 if (CONSP (val) && CONSP (XCDR (val)))
3372 inserted = XINT (XCAR (XCDR (val)));
3373 goto handled;
3376 orig_filename = filename;
3377 filename = ENCODE_FILE (filename);
3379 fd = -1;
3381 #ifdef WINDOWSNT
3383 Lisp_Object tem = Vw32_get_true_file_attributes;
3385 /* Tell stat to use expensive method to get accurate info. */
3386 Vw32_get_true_file_attributes = Qt;
3387 total = stat (SDATA (filename), &st);
3388 Vw32_get_true_file_attributes = tem;
3390 if (total < 0)
3391 #else
3392 if (stat (SDATA (filename), &st) < 0)
3393 #endif /* WINDOWSNT */
3395 if (fd >= 0) emacs_close (fd);
3396 badopen:
3397 if (NILP (visit))
3398 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3399 st.st_mtime = -1;
3400 how_much = 0;
3401 if (!NILP (Vcoding_system_for_read))
3402 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3403 goto notfound;
3406 #ifdef S_IFREG
3407 /* This code will need to be changed in order to work on named
3408 pipes, and it's probably just not worth it. So we should at
3409 least signal an error. */
3410 if (!S_ISREG (st.st_mode))
3412 not_regular = 1;
3414 if (! NILP (visit))
3415 goto notfound;
3417 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3418 xsignal2 (Qfile_error,
3419 build_string ("not a regular file"), orig_filename);
3421 #endif
3423 if (fd < 0)
3424 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3425 goto badopen;
3427 /* Replacement should preserve point as it preserves markers. */
3428 if (!NILP (replace))
3429 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3431 record_unwind_protect (close_file_unwind, make_number (fd));
3433 /* Can happen on any platform that uses long as type of off_t, but allows
3434 file sizes to exceed 2Gb, so give a suitable message. */
3435 if (! not_regular && st.st_size < 0)
3436 error ("Maximum buffer size exceeded");
3438 /* Prevent redisplay optimizations. */
3439 current_buffer->clip_changed = 1;
3441 if (!NILP (visit))
3443 if (!NILP (beg) || !NILP (end))
3444 error ("Attempt to visit less than an entire file");
3445 if (BEG < Z && NILP (replace))
3446 error ("Cannot do file visiting in a non-empty buffer");
3449 if (!NILP (beg))
3450 CHECK_NUMBER (beg);
3451 else
3452 XSETFASTINT (beg, 0);
3454 if (!NILP (end))
3455 CHECK_NUMBER (end);
3456 else
3458 if (! not_regular)
3460 XSETINT (end, st.st_size);
3462 /* Arithmetic overflow can occur if an Emacs integer cannot
3463 represent the file size, or if the calculations below
3464 overflow. The calculations below double the file size
3465 twice, so check that it can be multiplied by 4 safely. */
3466 if (XINT (end) != st.st_size
3467 /* Actually, it should test either INT_MAX or LONG_MAX
3468 depending on which one is used for EMACS_INT. But in
3469 any case, in practice, this test is redundant with the
3470 one above.
3471 || st.st_size > INT_MAX / 4 */)
3472 error ("Maximum buffer size exceeded");
3474 /* The file size returned from stat may be zero, but data
3475 may be readable nonetheless, for example when this is a
3476 file in the /proc filesystem. */
3477 if (st.st_size == 0)
3478 XSETINT (end, READ_BUF_SIZE);
3482 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3484 coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix);
3485 setup_coding_system (coding_system, &coding);
3486 /* Ensure we set Vlast_coding_system_used. */
3487 set_coding_system = 1;
3489 else if (BEG < Z)
3491 /* Decide the coding system to use for reading the file now
3492 because we can't use an optimized method for handling
3493 `coding:' tag if the current buffer is not empty. */
3494 if (!NILP (Vcoding_system_for_read))
3495 coding_system = Vcoding_system_for_read;
3496 else
3498 /* Don't try looking inside a file for a coding system
3499 specification if it is not seekable. */
3500 if (! not_regular && ! NILP (Vset_auto_coding_function))
3502 /* Find a coding system specified in the heading two
3503 lines or in the tailing several lines of the file.
3504 We assume that the 1K-byte and 3K-byte for heading
3505 and tailing respectively are sufficient for this
3506 purpose. */
3507 EMACS_INT nread;
3509 if (st.st_size <= (1024 * 4))
3510 nread = emacs_read (fd, read_buf, 1024 * 4);
3511 else
3513 nread = emacs_read (fd, read_buf, 1024);
3514 if (nread >= 0)
3516 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3517 report_file_error ("Setting file position",
3518 Fcons (orig_filename, Qnil));
3519 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3523 if (nread < 0)
3524 error ("IO error reading %s: %s",
3525 SDATA (orig_filename), emacs_strerror (errno));
3526 else if (nread > 0)
3528 struct buffer *prev = current_buffer;
3529 Lisp_Object buffer;
3530 struct buffer *buf;
3532 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3534 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3535 buf = XBUFFER (buffer);
3537 delete_all_overlays (buf);
3538 buf->directory = current_buffer->directory;
3539 buf->read_only = Qnil;
3540 buf->filename = Qnil;
3541 buf->undo_list = Qt;
3542 eassert (buf->overlays_before == NULL);
3543 eassert (buf->overlays_after == NULL);
3545 set_buffer_internal (buf);
3546 Ferase_buffer ();
3547 buf->enable_multibyte_characters = Qnil;
3549 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3550 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3551 coding_system = call2 (Vset_auto_coding_function,
3552 filename, make_number (nread));
3553 set_buffer_internal (prev);
3555 /* Discard the unwind protect for recovering the
3556 current buffer. */
3557 specpdl_ptr--;
3559 /* Rewind the file for the actual read done later. */
3560 if (lseek (fd, 0, 0) < 0)
3561 report_file_error ("Setting file position",
3562 Fcons (orig_filename, Qnil));
3566 if (NILP (coding_system))
3568 /* If we have not yet decided a coding system, check
3569 file-coding-system-alist. */
3570 Lisp_Object args[6];
3572 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3573 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3574 coding_system = Ffind_operation_coding_system (6, args);
3575 if (CONSP (coding_system))
3576 coding_system = XCAR (coding_system);
3580 if (NILP (coding_system))
3581 coding_system = Qundecided;
3582 else
3583 CHECK_CODING_SYSTEM (coding_system);
3585 if (NILP (current_buffer->enable_multibyte_characters))
3586 /* We must suppress all character code conversion except for
3587 end-of-line conversion. */
3588 coding_system = raw_text_coding_system (coding_system);
3590 setup_coding_system (coding_system, &coding);
3591 /* Ensure we set Vlast_coding_system_used. */
3592 set_coding_system = 1;
3595 /* If requested, replace the accessible part of the buffer
3596 with the file contents. Avoid replacing text at the
3597 beginning or end of the buffer that matches the file contents;
3598 that preserves markers pointing to the unchanged parts.
3600 Here we implement this feature in an optimized way
3601 for the case where code conversion is NOT needed.
3602 The following if-statement handles the case of conversion
3603 in a less optimal way.
3605 If the code conversion is "automatic" then we try using this
3606 method and hope for the best.
3607 But if we discover the need for conversion, we give up on this method
3608 and let the following if-statement handle the replace job. */
3609 if (!NILP (replace)
3610 && BEGV < ZV
3611 && (NILP (coding_system)
3612 || ! CODING_REQUIRE_DECODING (&coding)))
3614 /* same_at_start and same_at_end count bytes,
3615 because file access counts bytes
3616 and BEG and END count bytes. */
3617 EMACS_INT same_at_start = BEGV_BYTE;
3618 EMACS_INT same_at_end = ZV_BYTE;
3619 EMACS_INT overlap;
3620 /* There is still a possibility we will find the need to do code
3621 conversion. If that happens, we set this variable to 1 to
3622 give up on handling REPLACE in the optimized way. */
3623 int giveup_match_end = 0;
3625 if (XINT (beg) != 0)
3627 if (lseek (fd, XINT (beg), 0) < 0)
3628 report_file_error ("Setting file position",
3629 Fcons (orig_filename, Qnil));
3632 immediate_quit = 1;
3633 QUIT;
3634 /* Count how many chars at the start of the file
3635 match the text at the beginning of the buffer. */
3636 while (1)
3638 EMACS_INT nread, bufpos;
3640 nread = emacs_read (fd, buffer, sizeof buffer);
3641 if (nread < 0)
3642 error ("IO error reading %s: %s",
3643 SDATA (orig_filename), emacs_strerror (errno));
3644 else if (nread == 0)
3645 break;
3647 if (CODING_REQUIRE_DETECTION (&coding))
3649 coding_system = detect_coding_system (buffer, nread, nread, 1, 0,
3650 coding_system);
3651 setup_coding_system (coding_system, &coding);
3654 if (CODING_REQUIRE_DECODING (&coding))
3655 /* We found that the file should be decoded somehow.
3656 Let's give up here. */
3658 giveup_match_end = 1;
3659 break;
3662 bufpos = 0;
3663 while (bufpos < nread && same_at_start < ZV_BYTE
3664 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3665 same_at_start++, bufpos++;
3666 /* If we found a discrepancy, stop the scan.
3667 Otherwise loop around and scan the next bufferful. */
3668 if (bufpos != nread)
3669 break;
3671 immediate_quit = 0;
3672 /* If the file matches the buffer completely,
3673 there's no need to replace anything. */
3674 if (same_at_start - BEGV_BYTE == XINT (end))
3676 emacs_close (fd);
3677 specpdl_ptr--;
3678 /* Truncate the buffer to the size of the file. */
3679 del_range_1 (same_at_start, same_at_end, 0, 0);
3680 goto handled;
3682 immediate_quit = 1;
3683 QUIT;
3684 /* Count how many chars at the end of the file
3685 match the text at the end of the buffer. But, if we have
3686 already found that decoding is necessary, don't waste time. */
3687 while (!giveup_match_end)
3689 EMACS_INT total_read, nread, bufpos, curpos, trial;
3691 /* At what file position are we now scanning? */
3692 curpos = XINT (end) - (ZV_BYTE - same_at_end);
3693 /* If the entire file matches the buffer tail, stop the scan. */
3694 if (curpos == 0)
3695 break;
3696 /* How much can we scan in the next step? */
3697 trial = min (curpos, sizeof buffer);
3698 if (lseek (fd, curpos - trial, 0) < 0)
3699 report_file_error ("Setting file position",
3700 Fcons (orig_filename, Qnil));
3702 total_read = nread = 0;
3703 while (total_read < trial)
3705 nread = emacs_read (fd, buffer + total_read, trial - total_read);
3706 if (nread < 0)
3707 error ("IO error reading %s: %s",
3708 SDATA (orig_filename), emacs_strerror (errno));
3709 else if (nread == 0)
3710 break;
3711 total_read += nread;
3714 /* Scan this bufferful from the end, comparing with
3715 the Emacs buffer. */
3716 bufpos = total_read;
3718 /* Compare with same_at_start to avoid counting some buffer text
3719 as matching both at the file's beginning and at the end. */
3720 while (bufpos > 0 && same_at_end > same_at_start
3721 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3722 same_at_end--, bufpos--;
3724 /* If we found a discrepancy, stop the scan.
3725 Otherwise loop around and scan the preceding bufferful. */
3726 if (bufpos != 0)
3728 /* If this discrepancy is because of code conversion,
3729 we cannot use this method; giveup and try the other. */
3730 if (same_at_end > same_at_start
3731 && FETCH_BYTE (same_at_end - 1) >= 0200
3732 && ! NILP (current_buffer->enable_multibyte_characters)
3733 && (CODING_MAY_REQUIRE_DECODING (&coding)))
3734 giveup_match_end = 1;
3735 break;
3738 if (nread == 0)
3739 break;
3741 immediate_quit = 0;
3743 if (! giveup_match_end)
3745 EMACS_INT temp;
3747 /* We win! We can handle REPLACE the optimized way. */
3749 /* Extend the start of non-matching text area to multibyte
3750 character boundary. */
3751 if (! NILP (current_buffer->enable_multibyte_characters))
3752 while (same_at_start > BEGV_BYTE
3753 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3754 same_at_start--;
3756 /* Extend the end of non-matching text area to multibyte
3757 character boundary. */
3758 if (! NILP (current_buffer->enable_multibyte_characters))
3759 while (same_at_end < ZV_BYTE
3760 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3761 same_at_end++;
3763 /* Don't try to reuse the same piece of text twice. */
3764 overlap = (same_at_start - BEGV_BYTE
3765 - (same_at_end + st.st_size - ZV));
3766 if (overlap > 0)
3767 same_at_end += overlap;
3769 /* Arrange to read only the nonmatching middle part of the file. */
3770 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
3771 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
3773 del_range_byte (same_at_start, same_at_end, 0);
3774 /* Insert from the file at the proper position. */
3775 temp = BYTE_TO_CHAR (same_at_start);
3776 SET_PT_BOTH (temp, same_at_start);
3778 /* If display currently starts at beginning of line,
3779 keep it that way. */
3780 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3781 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3783 replace_handled = 1;
3787 /* If requested, replace the accessible part of the buffer
3788 with the file contents. Avoid replacing text at the
3789 beginning or end of the buffer that matches the file contents;
3790 that preserves markers pointing to the unchanged parts.
3792 Here we implement this feature for the case where code conversion
3793 is needed, in a simple way that needs a lot of memory.
3794 The preceding if-statement handles the case of no conversion
3795 in a more optimized way. */
3796 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
3798 EMACS_INT same_at_start = BEGV_BYTE;
3799 EMACS_INT same_at_end = ZV_BYTE;
3800 EMACS_INT same_at_start_charpos;
3801 EMACS_INT inserted_chars;
3802 EMACS_INT overlap;
3803 EMACS_INT bufpos;
3804 unsigned char *decoded;
3805 EMACS_INT temp;
3806 int this_count = SPECPDL_INDEX ();
3807 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3808 Lisp_Object conversion_buffer;
3810 conversion_buffer = code_conversion_save (1, multibyte);
3812 /* First read the whole file, performing code conversion into
3813 CONVERSION_BUFFER. */
3815 if (lseek (fd, XINT (beg), 0) < 0)
3816 report_file_error ("Setting file position",
3817 Fcons (orig_filename, Qnil));
3819 total = st.st_size; /* Total bytes in the file. */
3820 how_much = 0; /* Bytes read from file so far. */
3821 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
3822 unprocessed = 0; /* Bytes not processed in previous loop. */
3824 GCPRO1 (conversion_buffer);
3825 while (how_much < total)
3827 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3828 quitting while reading a huge while. */
3829 /* try is reserved in some compilers (Microsoft C) */
3830 EMACS_INT trytry = min (total - how_much,
3831 READ_BUF_SIZE - unprocessed);
3832 EMACS_INT this;
3834 /* Allow quitting out of the actual I/O. */
3835 immediate_quit = 1;
3836 QUIT;
3837 this = emacs_read (fd, read_buf + unprocessed, trytry);
3838 immediate_quit = 0;
3840 if (this <= 0)
3842 if (this < 0)
3843 how_much = this;
3844 break;
3847 how_much += this;
3849 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer),
3850 BUF_Z (XBUFFER (conversion_buffer)));
3851 decode_coding_c_string (&coding, read_buf, unprocessed + this,
3852 conversion_buffer);
3853 unprocessed = coding.carryover_bytes;
3854 if (coding.carryover_bytes > 0)
3855 bcopy (coding.carryover, read_buf, unprocessed);
3857 UNGCPRO;
3858 emacs_close (fd);
3860 /* We should remove the unwind_protect calling
3861 close_file_unwind, but other stuff has been added the stack,
3862 so defer the removal till we reach the `handled' label. */
3863 deferred_remove_unwind_protect = 1;
3865 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3866 if we couldn't read the file. */
3868 if (how_much < 0)
3869 error ("IO error reading %s: %s",
3870 SDATA (orig_filename), emacs_strerror (errno));
3872 if (unprocessed > 0)
3874 coding.mode |= CODING_MODE_LAST_BLOCK;
3875 decode_coding_c_string (&coding, read_buf, unprocessed,
3876 conversion_buffer);
3877 coding.mode &= ~CODING_MODE_LAST_BLOCK;
3880 coding_system = CODING_ID_NAME (coding.id);
3881 set_coding_system = 1;
3882 decoded = BUF_BEG_ADDR (XBUFFER (conversion_buffer));
3883 inserted = (BUF_Z_BYTE (XBUFFER (conversion_buffer))
3884 - BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
3886 /* Compare the beginning of the converted string with the buffer
3887 text. */
3889 bufpos = 0;
3890 while (bufpos < inserted && same_at_start < same_at_end
3891 && FETCH_BYTE (same_at_start) == decoded[bufpos])
3892 same_at_start++, bufpos++;
3894 /* If the file matches the head of buffer completely,
3895 there's no need to replace anything. */
3897 if (bufpos == inserted)
3899 /* Truncate the buffer to the size of the file. */
3900 if (same_at_start == same_at_end)
3901 nochange = 1;
3902 else
3903 del_range_byte (same_at_start, same_at_end, 0);
3904 inserted = 0;
3906 unbind_to (this_count, Qnil);
3907 goto handled;
3910 /* Extend the start of non-matching text area to the previous
3911 multibyte character boundary. */
3912 if (! NILP (current_buffer->enable_multibyte_characters))
3913 while (same_at_start > BEGV_BYTE
3914 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3915 same_at_start--;
3917 /* Scan this bufferful from the end, comparing with
3918 the Emacs buffer. */
3919 bufpos = inserted;
3921 /* Compare with same_at_start to avoid counting some buffer text
3922 as matching both at the file's beginning and at the end. */
3923 while (bufpos > 0 && same_at_end > same_at_start
3924 && FETCH_BYTE (same_at_end - 1) == decoded[bufpos - 1])
3925 same_at_end--, bufpos--;
3927 /* Extend the end of non-matching text area to the next
3928 multibyte character boundary. */
3929 if (! NILP (current_buffer->enable_multibyte_characters))
3930 while (same_at_end < ZV_BYTE
3931 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3932 same_at_end++;
3934 /* Don't try to reuse the same piece of text twice. */
3935 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
3936 if (overlap > 0)
3937 same_at_end += overlap;
3939 /* If display currently starts at beginning of line,
3940 keep it that way. */
3941 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3942 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3944 /* Replace the chars that we need to replace,
3945 and update INSERTED to equal the number of bytes
3946 we are taking from the decoded string. */
3947 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
3949 if (same_at_end != same_at_start)
3951 del_range_byte (same_at_start, same_at_end, 0);
3952 temp = GPT;
3953 same_at_start = GPT_BYTE;
3955 else
3957 temp = BYTE_TO_CHAR (same_at_start);
3959 /* Insert from the file at the proper position. */
3960 SET_PT_BOTH (temp, same_at_start);
3961 same_at_start_charpos
3962 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
3963 same_at_start - BEGV_BYTE
3964 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
3965 inserted_chars
3966 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
3967 same_at_start + inserted - BEGV_BYTE
3968 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)))
3969 - same_at_start_charpos);
3970 /* This binding is to avoid ask-user-about-supersession-threat
3971 being called in insert_from_buffer (via in
3972 prepare_to_modify_buffer). */
3973 specbind (intern ("buffer-file-name"), Qnil);
3974 insert_from_buffer (XBUFFER (conversion_buffer),
3975 same_at_start_charpos, inserted_chars, 0);
3976 /* Set `inserted' to the number of inserted characters. */
3977 inserted = PT - temp;
3978 /* Set point before the inserted characters. */
3979 SET_PT_BOTH (temp, same_at_start);
3981 unbind_to (this_count, Qnil);
3983 goto handled;
3986 if (! not_regular)
3988 register Lisp_Object temp;
3990 total = XINT (end) - XINT (beg);
3992 /* Make sure point-max won't overflow after this insertion. */
3993 XSETINT (temp, total);
3994 if (total != XINT (temp))
3995 error ("Maximum buffer size exceeded");
3997 else
3998 /* For a special file, all we can do is guess. */
3999 total = READ_BUF_SIZE;
4001 if (NILP (visit) && inserted > 0)
4003 #ifdef CLASH_DETECTION
4004 if (!NILP (current_buffer->file_truename)
4005 /* Make binding buffer-file-name to nil effective. */
4006 && !NILP (current_buffer->filename)
4007 && SAVE_MODIFF >= MODIFF)
4008 we_locked_file = 1;
4009 #endif /* CLASH_DETECTION */
4010 prepare_to_modify_buffer (GPT, GPT, NULL);
4013 move_gap (PT);
4014 if (GAP_SIZE < total)
4015 make_gap (total - GAP_SIZE);
4017 if (XINT (beg) != 0 || !NILP (replace))
4019 if (lseek (fd, XINT (beg), 0) < 0)
4020 report_file_error ("Setting file position",
4021 Fcons (orig_filename, Qnil));
4024 /* In the following loop, HOW_MUCH contains the total bytes read so
4025 far for a regular file, and not changed for a special file. But,
4026 before exiting the loop, it is set to a negative value if I/O
4027 error occurs. */
4028 how_much = 0;
4030 /* Total bytes inserted. */
4031 inserted = 0;
4033 /* Here, we don't do code conversion in the loop. It is done by
4034 decode_coding_gap after all data are read into the buffer. */
4036 EMACS_INT gap_size = GAP_SIZE;
4038 while (how_much < total)
4040 /* try is reserved in some compilers (Microsoft C) */
4041 EMACS_INT trytry = min (total - how_much, READ_BUF_SIZE);
4042 EMACS_INT this;
4044 if (not_regular)
4046 Lisp_Object val;
4048 /* Maybe make more room. */
4049 if (gap_size < trytry)
4051 make_gap (total - gap_size);
4052 gap_size = GAP_SIZE;
4055 /* Read from the file, capturing `quit'. When an
4056 error occurs, end the loop, and arrange for a quit
4057 to be signaled after decoding the text we read. */
4058 non_regular_fd = fd;
4059 non_regular_inserted = inserted;
4060 non_regular_nbytes = trytry;
4061 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4062 read_non_regular_quit);
4063 if (NILP (val))
4065 read_quit = 1;
4066 break;
4069 this = XINT (val);
4071 else
4073 /* Allow quitting out of the actual I/O. We don't make text
4074 part of the buffer until all the reading is done, so a C-g
4075 here doesn't do any harm. */
4076 immediate_quit = 1;
4077 QUIT;
4078 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4079 immediate_quit = 0;
4082 if (this <= 0)
4084 how_much = this;
4085 break;
4088 gap_size -= this;
4090 /* For a regular file, where TOTAL is the real size,
4091 count HOW_MUCH to compare with it.
4092 For a special file, where TOTAL is just a buffer size,
4093 so don't bother counting in HOW_MUCH.
4094 (INSERTED is where we count the number of characters inserted.) */
4095 if (! not_regular)
4096 how_much += this;
4097 inserted += this;
4101 /* Now we have read all the file data into the gap.
4102 If it was empty, undo marking the buffer modified. */
4104 if (inserted == 0)
4106 #ifdef CLASH_DETECTION
4107 if (we_locked_file)
4108 unlock_file (current_buffer->file_truename);
4109 #endif
4110 Vdeactivate_mark = old_Vdeactivate_mark;
4112 else
4113 Vdeactivate_mark = Qt;
4115 /* Make the text read part of the buffer. */
4116 GAP_SIZE -= inserted;
4117 GPT += inserted;
4118 GPT_BYTE += inserted;
4119 ZV += inserted;
4120 ZV_BYTE += inserted;
4121 Z += inserted;
4122 Z_BYTE += inserted;
4124 if (GAP_SIZE > 0)
4125 /* Put an anchor to ensure multi-byte form ends at gap. */
4126 *GPT_ADDR = 0;
4128 emacs_close (fd);
4130 /* Discard the unwind protect for closing the file. */
4131 specpdl_ptr--;
4133 if (how_much < 0)
4134 error ("IO error reading %s: %s",
4135 SDATA (orig_filename), emacs_strerror (errno));
4137 notfound:
4139 if (NILP (coding_system))
4141 /* The coding system is not yet decided. Decide it by an
4142 optimized method for handling `coding:' tag.
4144 Note that we can get here only if the buffer was empty
4145 before the insertion. */
4147 if (!NILP (Vcoding_system_for_read))
4148 coding_system = Vcoding_system_for_read;
4149 else
4151 /* Since we are sure that the current buffer was empty
4152 before the insertion, we can toggle
4153 enable-multibyte-characters directly here without taking
4154 care of marker adjustment. By this way, we can run Lisp
4155 program safely before decoding the inserted text. */
4156 Lisp_Object unwind_data;
4157 int count = SPECPDL_INDEX ();
4159 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4160 Fcons (current_buffer->undo_list,
4161 Fcurrent_buffer ()));
4162 current_buffer->enable_multibyte_characters = Qnil;
4163 current_buffer->undo_list = Qt;
4164 record_unwind_protect (decide_coding_unwind, unwind_data);
4166 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4168 coding_system = call2 (Vset_auto_coding_function,
4169 filename, make_number (inserted));
4172 if (NILP (coding_system))
4174 /* If the coding system is not yet decided, check
4175 file-coding-system-alist. */
4176 Lisp_Object args[6];
4178 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4179 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4180 coding_system = Ffind_operation_coding_system (6, args);
4181 if (CONSP (coding_system))
4182 coding_system = XCAR (coding_system);
4184 unbind_to (count, Qnil);
4185 inserted = Z_BYTE - BEG_BYTE;
4188 if (NILP (coding_system))
4189 coding_system = Qundecided;
4190 else
4191 CHECK_CODING_SYSTEM (coding_system);
4193 if (NILP (current_buffer->enable_multibyte_characters))
4194 /* We must suppress all character code conversion except for
4195 end-of-line conversion. */
4196 coding_system = raw_text_coding_system (coding_system);
4197 setup_coding_system (coding_system, &coding);
4198 /* Ensure we set Vlast_coding_system_used. */
4199 set_coding_system = 1;
4202 if (!NILP (visit))
4204 /* When we visit a file by raw-text, we change the buffer to
4205 unibyte. */
4206 if (CODING_FOR_UNIBYTE (&coding)
4207 /* Can't do this if part of the buffer might be preserved. */
4208 && NILP (replace))
4209 /* Visiting a file with these coding system makes the buffer
4210 unibyte. */
4211 current_buffer->enable_multibyte_characters = Qnil;
4214 coding.dst_multibyte = ! NILP (current_buffer->enable_multibyte_characters);
4215 if (CODING_MAY_REQUIRE_DECODING (&coding)
4216 && (inserted > 0 || CODING_REQUIRE_FLUSHING (&coding)))
4218 move_gap_both (PT, PT_BYTE);
4219 GAP_SIZE += inserted;
4220 ZV_BYTE -= inserted;
4221 Z_BYTE -= inserted;
4222 ZV -= inserted;
4223 Z -= inserted;
4224 decode_coding_gap (&coding, inserted, inserted);
4225 inserted = coding.produced_char;
4226 coding_system = CODING_ID_NAME (coding.id);
4228 else if (inserted > 0)
4229 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4230 inserted);
4232 /* Now INSERTED is measured in characters. */
4234 #ifdef DOS_NT
4235 /* Use the conversion type to determine buffer-file-type
4236 (find-buffer-file-type is now used to help determine the
4237 conversion). */
4238 if ((VECTORP (CODING_ID_EOL_TYPE (coding.id))
4239 || EQ (CODING_ID_EOL_TYPE (coding.id), Qunix))
4240 && ! CODING_REQUIRE_DECODING (&coding))
4241 current_buffer->buffer_file_type = Qt;
4242 else
4243 current_buffer->buffer_file_type = Qnil;
4244 #endif
4246 handled:
4248 if (deferred_remove_unwind_protect)
4249 /* If requested above, discard the unwind protect for closing the
4250 file. */
4251 specpdl_ptr--;
4253 if (!NILP (visit))
4255 if (!EQ (current_buffer->undo_list, Qt) && !nochange)
4256 current_buffer->undo_list = Qnil;
4258 if (NILP (handler))
4260 current_buffer->modtime = st.st_mtime;
4261 current_buffer->modtime_size = st.st_size;
4262 current_buffer->filename = orig_filename;
4265 SAVE_MODIFF = MODIFF;
4266 BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF;
4267 XSETFASTINT (current_buffer->save_length, Z - BEG);
4268 #ifdef CLASH_DETECTION
4269 if (NILP (handler))
4271 if (!NILP (current_buffer->file_truename))
4272 unlock_file (current_buffer->file_truename);
4273 unlock_file (filename);
4275 #endif /* CLASH_DETECTION */
4276 if (not_regular)
4277 xsignal2 (Qfile_error,
4278 build_string ("not a regular file"), orig_filename);
4281 if (set_coding_system)
4282 Vlast_coding_system_used = coding_system;
4284 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4286 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4287 visit);
4288 if (! NILP (insval))
4290 CHECK_NUMBER (insval);
4291 inserted = XFASTINT (insval);
4295 /* Decode file format. */
4296 if (inserted > 0)
4298 /* Don't run point motion or modification hooks when decoding. */
4299 int count = SPECPDL_INDEX ();
4300 EMACS_INT old_inserted = inserted;
4301 specbind (Qinhibit_point_motion_hooks, Qt);
4302 specbind (Qinhibit_modification_hooks, Qt);
4304 /* Save old undo list and don't record undo for decoding. */
4305 old_undo = current_buffer->undo_list;
4306 current_buffer->undo_list = Qt;
4308 if (NILP (replace))
4310 insval = call3 (Qformat_decode,
4311 Qnil, make_number (inserted), visit);
4312 CHECK_NUMBER (insval);
4313 inserted = XFASTINT (insval);
4315 else
4317 /* If REPLACE is non-nil and we succeeded in not replacing the
4318 beginning or end of the buffer text with the file's contents,
4319 call format-decode with `point' positioned at the beginning
4320 of the buffer and `inserted' equalling the number of
4321 characters in the buffer. Otherwise, format-decode might
4322 fail to correctly analyze the beginning or end of the buffer.
4323 Hence we temporarily save `point' and `inserted' here and
4324 restore `point' iff format-decode did not insert or delete
4325 any text. Otherwise we leave `point' at point-min. */
4326 EMACS_INT opoint = PT;
4327 EMACS_INT opoint_byte = PT_BYTE;
4328 EMACS_INT oinserted = ZV - BEGV;
4329 int ochars_modiff = CHARS_MODIFF;
4331 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4332 insval = call3 (Qformat_decode,
4333 Qnil, make_number (oinserted), visit);
4334 CHECK_NUMBER (insval);
4335 if (ochars_modiff == CHARS_MODIFF)
4336 /* format_decode didn't modify buffer's characters => move
4337 point back to position before inserted text and leave
4338 value of inserted alone. */
4339 SET_PT_BOTH (opoint, opoint_byte);
4340 else
4341 /* format_decode modified buffer's characters => consider
4342 entire buffer changed and leave point at point-min. */
4343 inserted = XFASTINT (insval);
4346 /* For consistency with format-decode call these now iff inserted > 0
4347 (martin 2007-06-28). */
4348 p = Vafter_insert_file_functions;
4349 while (CONSP (p))
4351 if (NILP (replace))
4353 insval = call1 (XCAR (p), make_number (inserted));
4354 if (!NILP (insval))
4356 CHECK_NUMBER (insval);
4357 inserted = XFASTINT (insval);
4360 else
4362 /* For the rationale of this see the comment on
4363 format-decode above. */
4364 EMACS_INT opoint = PT;
4365 EMACS_INT opoint_byte = PT_BYTE;
4366 EMACS_INT oinserted = ZV - BEGV;
4367 int ochars_modiff = CHARS_MODIFF;
4369 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4370 insval = call1 (XCAR (p), make_number (oinserted));
4371 if (!NILP (insval))
4373 CHECK_NUMBER (insval);
4374 if (ochars_modiff == CHARS_MODIFF)
4375 /* after_insert_file_functions didn't modify
4376 buffer's characters => move point back to
4377 position before inserted text and leave value of
4378 inserted alone. */
4379 SET_PT_BOTH (opoint, opoint_byte);
4380 else
4381 /* after_insert_file_functions did modify buffer's
4382 characters => consider entire buffer changed and
4383 leave point at point-min. */
4384 inserted = XFASTINT (insval);
4388 QUIT;
4389 p = XCDR (p);
4392 if (NILP (visit))
4394 current_buffer->undo_list = old_undo;
4395 if (CONSP (old_undo) && inserted != old_inserted)
4397 /* Adjust the last undo record for the size change during
4398 the format conversion. */
4399 Lisp_Object tem = XCAR (old_undo);
4400 if (CONSP (tem) && INTEGERP (XCAR (tem))
4401 && INTEGERP (XCDR (tem))
4402 && XFASTINT (XCDR (tem)) == PT + old_inserted)
4403 XSETCDR (tem, make_number (PT + inserted));
4406 else
4407 /* If undo_list was Qt before, keep it that way.
4408 Otherwise start with an empty undo_list. */
4409 current_buffer->undo_list = EQ (old_undo, Qt) ? Qt : Qnil;
4411 unbind_to (count, Qnil);
4414 /* Call after-change hooks for the inserted text, aside from the case
4415 of normal visiting (not with REPLACE), which is done in a new buffer
4416 "before" the buffer is changed. */
4417 if (inserted > 0 && total > 0
4418 && (NILP (visit) || !NILP (replace)))
4420 signal_after_change (PT, 0, inserted);
4421 update_compositions (PT, PT, CHECK_BORDER);
4424 if (!NILP (visit)
4425 && current_buffer->modtime == -1)
4427 /* If visiting nonexistent file, return nil. */
4428 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4431 if (read_quit)
4432 Fsignal (Qquit, Qnil);
4434 /* ??? Retval needs to be dealt with in all cases consistently. */
4435 if (NILP (val))
4436 val = Fcons (orig_filename,
4437 Fcons (make_number (inserted),
4438 Qnil));
4440 RETURN_UNGCPRO (unbind_to (count, val));
4443 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4445 static Lisp_Object
4446 build_annotations_unwind (arg)
4447 Lisp_Object arg;
4449 Vwrite_region_annotation_buffers = arg;
4450 return Qnil;
4453 /* Decide the coding-system to encode the data with. */
4455 static Lisp_Object
4456 choose_write_coding_system (start, end, filename,
4457 append, visit, lockname, coding)
4458 Lisp_Object start, end, filename, append, visit, lockname;
4459 struct coding_system *coding;
4461 Lisp_Object val;
4462 Lisp_Object eol_parent = Qnil;
4464 if (auto_saving
4465 && NILP (Fstring_equal (current_buffer->filename,
4466 current_buffer->auto_save_file_name)))
4468 val = Qutf_8_emacs;
4469 eol_parent = Qunix;
4471 else if (!NILP (Vcoding_system_for_write))
4473 val = Vcoding_system_for_write;
4474 if (coding_system_require_warning
4475 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4476 /* Confirm that VAL can surely encode the current region. */
4477 val = call5 (Vselect_safe_coding_system_function,
4478 start, end, Fcons (Qt, Fcons (val, Qnil)),
4479 Qnil, filename);
4481 else
4483 /* If the variable `buffer-file-coding-system' is set locally,
4484 it means that the file was read with some kind of code
4485 conversion or the variable is explicitly set by users. We
4486 had better write it out with the same coding system even if
4487 `enable-multibyte-characters' is nil.
4489 If it is not set locally, we anyway have to convert EOL
4490 format if the default value of `buffer-file-coding-system'
4491 tells that it is not Unix-like (LF only) format. */
4492 int using_default_coding = 0;
4493 int force_raw_text = 0;
4495 val = current_buffer->buffer_file_coding_system;
4496 if (NILP (val)
4497 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4499 val = Qnil;
4500 if (NILP (current_buffer->enable_multibyte_characters))
4501 force_raw_text = 1;
4504 if (NILP (val))
4506 /* Check file-coding-system-alist. */
4507 Lisp_Object args[7], coding_systems;
4509 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4510 args[3] = filename; args[4] = append; args[5] = visit;
4511 args[6] = lockname;
4512 coding_systems = Ffind_operation_coding_system (7, args);
4513 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4514 val = XCDR (coding_systems);
4517 if (NILP (val))
4519 /* If we still have not decided a coding system, use the
4520 default value of buffer-file-coding-system. */
4521 val = current_buffer->buffer_file_coding_system;
4522 using_default_coding = 1;
4525 if (! NILP (val) && ! force_raw_text)
4527 Lisp_Object spec, attrs;
4529 CHECK_CODING_SYSTEM_GET_SPEC (val, spec);
4530 attrs = AREF (spec, 0);
4531 if (EQ (CODING_ATTR_TYPE (attrs), Qraw_text))
4532 force_raw_text = 1;
4535 if (!force_raw_text
4536 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4537 /* Confirm that VAL can surely encode the current region. */
4538 val = call5 (Vselect_safe_coding_system_function,
4539 start, end, val, Qnil, filename);
4541 /* If the decided coding-system doesn't specify end-of-line
4542 format, we use that of
4543 `default-buffer-file-coding-system'. */
4544 if (! using_default_coding
4545 && ! NILP (buffer_defaults.buffer_file_coding_system))
4546 val = (coding_inherit_eol_type
4547 (val, buffer_defaults.buffer_file_coding_system));
4549 /* If we decide not to encode text, use `raw-text' or one of its
4550 subsidiaries. */
4551 if (force_raw_text)
4552 val = raw_text_coding_system (val);
4555 val = coding_inherit_eol_type (val, eol_parent);
4556 setup_coding_system (val, coding);
4558 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4559 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4560 return val;
4563 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4564 "r\nFWrite region to file: \ni\ni\ni\np",
4565 doc: /* Write current region into specified file.
4566 When called from a program, requires three arguments:
4567 START, END and FILENAME. START and END are normally buffer positions
4568 specifying the part of the buffer to write.
4569 If START is nil, that means to use the entire buffer contents.
4570 If START is a string, then output that string to the file
4571 instead of any buffer contents; END is ignored.
4573 Optional fourth argument APPEND if non-nil means
4574 append to existing file contents (if any). If it is an integer,
4575 seek to that offset in the file before writing.
4576 Optional fifth argument VISIT, if t or a string, means
4577 set the last-save-file-modtime of buffer to this file's modtime
4578 and mark buffer not modified.
4579 If VISIT is a string, it is a second file name;
4580 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4581 VISIT is also the file name to lock and unlock for clash detection.
4582 If VISIT is neither t nor nil nor a string,
4583 that means do not display the \"Wrote file\" message.
4584 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4585 use for locking and unlocking, overriding FILENAME and VISIT.
4586 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4587 for an existing file with the same name. If MUSTBENEW is `excl',
4588 that means to get an error if the file already exists; never overwrite.
4589 If MUSTBENEW is neither nil nor `excl', that means ask for
4590 confirmation before overwriting, but do go ahead and overwrite the file
4591 if the user confirms.
4593 This does code conversion according to the value of
4594 `coding-system-for-write', `buffer-file-coding-system', or
4595 `file-coding-system-alist', and sets the variable
4596 `last-coding-system-used' to the coding system actually used.
4598 This calls `write-region-annotate-functions' at the start, and
4599 `write-region-post-annotation-function' at the end. */)
4600 (start, end, filename, append, visit, lockname, mustbenew)
4601 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4603 register int desc;
4604 int failure;
4605 int save_errno = 0;
4606 const unsigned char *fn;
4607 struct stat st;
4608 int count = SPECPDL_INDEX ();
4609 int count1;
4610 Lisp_Object handler;
4611 Lisp_Object visit_file;
4612 Lisp_Object annotations;
4613 Lisp_Object encoded_filename;
4614 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4615 int quietly = !NILP (visit);
4616 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4617 struct buffer *given_buffer;
4618 #ifdef DOS_NT
4619 int buffer_file_type = O_BINARY;
4620 #endif /* DOS_NT */
4621 struct coding_system coding;
4623 if (current_buffer->base_buffer && visiting)
4624 error ("Cannot do file visiting in an indirect buffer");
4626 if (!NILP (start) && !STRINGP (start))
4627 validate_region (&start, &end);
4629 visit_file = Qnil;
4630 GCPRO5 (start, filename, visit, visit_file, lockname);
4632 filename = Fexpand_file_name (filename, Qnil);
4634 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4635 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4637 if (STRINGP (visit))
4638 visit_file = Fexpand_file_name (visit, Qnil);
4639 else
4640 visit_file = filename;
4642 if (NILP (lockname))
4643 lockname = visit_file;
4645 annotations = Qnil;
4647 /* If the file name has special constructs in it,
4648 call the corresponding file handler. */
4649 handler = Ffind_file_name_handler (filename, Qwrite_region);
4650 /* If FILENAME has no handler, see if VISIT has one. */
4651 if (NILP (handler) && STRINGP (visit))
4652 handler = Ffind_file_name_handler (visit, Qwrite_region);
4654 if (!NILP (handler))
4656 Lisp_Object val;
4657 val = call6 (handler, Qwrite_region, start, end,
4658 filename, append, visit);
4660 if (visiting)
4662 SAVE_MODIFF = MODIFF;
4663 XSETFASTINT (current_buffer->save_length, Z - BEG);
4664 current_buffer->filename = visit_file;
4666 UNGCPRO;
4667 return val;
4670 record_unwind_protect (save_restriction_restore, save_restriction_save ());
4672 /* Special kludge to simplify auto-saving. */
4673 if (NILP (start))
4675 /* Do it later, so write-region-annotate-function can work differently
4676 if we save "the buffer" vs "a region".
4677 This is useful in tar-mode. --Stef
4678 XSETFASTINT (start, BEG);
4679 XSETFASTINT (end, Z); */
4680 Fwiden ();
4683 record_unwind_protect (build_annotations_unwind,
4684 Vwrite_region_annotation_buffers);
4685 Vwrite_region_annotation_buffers = Fcons (Fcurrent_buffer (), Qnil);
4686 count1 = SPECPDL_INDEX ();
4688 given_buffer = current_buffer;
4690 if (!STRINGP (start))
4692 annotations = build_annotations (start, end);
4694 if (current_buffer != given_buffer)
4696 XSETFASTINT (start, BEGV);
4697 XSETFASTINT (end, ZV);
4701 if (NILP (start))
4703 XSETFASTINT (start, BEGV);
4704 XSETFASTINT (end, ZV);
4707 UNGCPRO;
4709 GCPRO5 (start, filename, annotations, visit_file, lockname);
4711 /* Decide the coding-system to encode the data with.
4712 We used to make this choice before calling build_annotations, but that
4713 leads to problems when a write-annotate-function takes care of
4714 unsavable chars (as was the case with X-Symbol). */
4715 Vlast_coding_system_used
4716 = choose_write_coding_system (start, end, filename,
4717 append, visit, lockname, &coding);
4719 #ifdef CLASH_DETECTION
4720 if (!auto_saving)
4721 lock_file (lockname);
4722 #endif /* CLASH_DETECTION */
4724 encoded_filename = ENCODE_FILE (filename);
4726 fn = SDATA (encoded_filename);
4727 desc = -1;
4728 if (!NILP (append))
4729 #ifdef DOS_NT
4730 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
4731 #else /* not DOS_NT */
4732 desc = emacs_open (fn, O_WRONLY, 0);
4733 #endif /* not DOS_NT */
4735 if (desc < 0 && (NILP (append) || errno == ENOENT))
4736 #ifdef DOS_NT
4737 desc = emacs_open (fn,
4738 O_WRONLY | O_CREAT | buffer_file_type
4739 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
4740 S_IREAD | S_IWRITE);
4741 #else /* not DOS_NT */
4742 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
4743 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
4744 auto_saving ? auto_save_mode_bits : 0666);
4745 #endif /* not DOS_NT */
4747 if (desc < 0)
4749 #ifdef CLASH_DETECTION
4750 save_errno = errno;
4751 if (!auto_saving) unlock_file (lockname);
4752 errno = save_errno;
4753 #endif /* CLASH_DETECTION */
4754 UNGCPRO;
4755 report_file_error ("Opening output file", Fcons (filename, Qnil));
4758 record_unwind_protect (close_file_unwind, make_number (desc));
4760 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
4762 long ret;
4764 if (NUMBERP (append))
4765 ret = lseek (desc, XINT (append), 1);
4766 else
4767 ret = lseek (desc, 0, 2);
4768 if (ret < 0)
4770 #ifdef CLASH_DETECTION
4771 if (!auto_saving) unlock_file (lockname);
4772 #endif /* CLASH_DETECTION */
4773 UNGCPRO;
4774 report_file_error ("Lseek error", Fcons (filename, Qnil));
4778 UNGCPRO;
4780 failure = 0;
4781 immediate_quit = 1;
4783 if (STRINGP (start))
4785 failure = 0 > a_write (desc, start, 0, SCHARS (start),
4786 &annotations, &coding);
4787 save_errno = errno;
4789 else if (XINT (start) != XINT (end))
4791 failure = 0 > a_write (desc, Qnil,
4792 XINT (start), XINT (end) - XINT (start),
4793 &annotations, &coding);
4794 save_errno = errno;
4796 else
4798 /* If file was empty, still need to write the annotations */
4799 coding.mode |= CODING_MODE_LAST_BLOCK;
4800 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
4801 save_errno = errno;
4804 if (CODING_REQUIRE_FLUSHING (&coding)
4805 && !(coding.mode & CODING_MODE_LAST_BLOCK)
4806 && ! failure)
4808 /* We have to flush out a data. */
4809 coding.mode |= CODING_MODE_LAST_BLOCK;
4810 failure = 0 > e_write (desc, Qnil, 1, 1, &coding);
4811 save_errno = errno;
4814 immediate_quit = 0;
4816 #ifdef HAVE_FSYNC
4817 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4818 Disk full in NFS may be reported here. */
4819 /* mib says that closing the file will try to write as fast as NFS can do
4820 it, and that means the fsync here is not crucial for autosave files. */
4821 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
4823 /* If fsync fails with EINTR, don't treat that as serious. Also
4824 ignore EINVAL which happens when fsync is not supported on this
4825 file. */
4826 if (errno != EINTR && errno != EINVAL)
4827 failure = 1, save_errno = errno;
4829 #endif
4831 /* NFS can report a write failure now. */
4832 if (emacs_close (desc) < 0)
4833 failure = 1, save_errno = errno;
4835 stat (fn, &st);
4837 /* Discard the unwind protect for close_file_unwind. */
4838 specpdl_ptr = specpdl + count1;
4840 /* Call write-region-post-annotation-function. */
4841 while (CONSP (Vwrite_region_annotation_buffers))
4843 Lisp_Object buf = XCAR (Vwrite_region_annotation_buffers);
4844 if (!NILP (Fbuffer_live_p (buf)))
4846 Fset_buffer (buf);
4847 if (FUNCTIONP (Vwrite_region_post_annotation_function))
4848 call0 (Vwrite_region_post_annotation_function);
4850 Vwrite_region_annotation_buffers
4851 = XCDR (Vwrite_region_annotation_buffers);
4854 unbind_to (count, Qnil);
4856 #ifdef CLASH_DETECTION
4857 if (!auto_saving)
4858 unlock_file (lockname);
4859 #endif /* CLASH_DETECTION */
4861 /* Do this before reporting IO error
4862 to avoid a "file has changed on disk" warning on
4863 next attempt to save. */
4864 if (visiting)
4866 current_buffer->modtime = st.st_mtime;
4867 current_buffer->modtime_size = st.st_size;
4870 if (failure)
4871 error ("IO error writing %s: %s", SDATA (filename),
4872 emacs_strerror (save_errno));
4874 if (visiting)
4876 SAVE_MODIFF = MODIFF;
4877 XSETFASTINT (current_buffer->save_length, Z - BEG);
4878 current_buffer->filename = visit_file;
4879 update_mode_lines++;
4881 else if (quietly)
4883 if (auto_saving
4884 && ! NILP (Fstring_equal (current_buffer->filename,
4885 current_buffer->auto_save_file_name)))
4886 SAVE_MODIFF = MODIFF;
4888 return Qnil;
4891 if (!auto_saving)
4892 message_with_string ((INTEGERP (append)
4893 ? "Updated %s"
4894 : ! NILP (append)
4895 ? "Added to %s"
4896 : "Wrote %s"),
4897 visit_file, 1);
4899 return Qnil;
4902 Lisp_Object merge ();
4904 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
4905 doc: /* Return t if (car A) is numerically less than (car B). */)
4906 (a, b)
4907 Lisp_Object a, b;
4909 return Flss (Fcar (a), Fcar (b));
4912 /* Build the complete list of annotations appropriate for writing out
4913 the text between START and END, by calling all the functions in
4914 write-region-annotate-functions and merging the lists they return.
4915 If one of these functions switches to a different buffer, we assume
4916 that buffer contains altered text. Therefore, the caller must
4917 make sure to restore the current buffer in all cases,
4918 as save-excursion would do. */
4920 static Lisp_Object
4921 build_annotations (start, end)
4922 Lisp_Object start, end;
4924 Lisp_Object annotations;
4925 Lisp_Object p, res;
4926 struct gcpro gcpro1, gcpro2;
4927 Lisp_Object original_buffer;
4928 int i, used_global = 0;
4930 XSETBUFFER (original_buffer, current_buffer);
4932 annotations = Qnil;
4933 p = Vwrite_region_annotate_functions;
4934 GCPRO2 (annotations, p);
4935 while (CONSP (p))
4937 struct buffer *given_buffer = current_buffer;
4938 if (EQ (Qt, XCAR (p)) && !used_global)
4939 { /* Use the global value of the hook. */
4940 Lisp_Object arg[2];
4941 used_global = 1;
4942 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
4943 arg[1] = XCDR (p);
4944 p = Fappend (2, arg);
4945 continue;
4947 Vwrite_region_annotations_so_far = annotations;
4948 res = call2 (XCAR (p), start, end);
4949 /* If the function makes a different buffer current,
4950 assume that means this buffer contains altered text to be output.
4951 Reset START and END from the buffer bounds
4952 and discard all previous annotations because they should have
4953 been dealt with by this function. */
4954 if (current_buffer != given_buffer)
4956 Vwrite_region_annotation_buffers
4957 = Fcons (Fcurrent_buffer (),
4958 Vwrite_region_annotation_buffers);
4959 XSETFASTINT (start, BEGV);
4960 XSETFASTINT (end, ZV);
4961 annotations = Qnil;
4963 Flength (res); /* Check basic validity of return value */
4964 annotations = merge (annotations, res, Qcar_less_than_car);
4965 p = XCDR (p);
4968 /* Now do the same for annotation functions implied by the file-format */
4969 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
4970 p = current_buffer->auto_save_file_format;
4971 else
4972 p = current_buffer->file_format;
4973 for (i = 0; CONSP (p); p = XCDR (p), ++i)
4975 struct buffer *given_buffer = current_buffer;
4977 Vwrite_region_annotations_so_far = annotations;
4979 /* Value is either a list of annotations or nil if the function
4980 has written annotations to a temporary buffer, which is now
4981 current. */
4982 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
4983 original_buffer, make_number (i));
4984 if (current_buffer != given_buffer)
4986 XSETFASTINT (start, BEGV);
4987 XSETFASTINT (end, ZV);
4988 annotations = Qnil;
4991 if (CONSP (res))
4992 annotations = merge (annotations, res, Qcar_less_than_car);
4995 UNGCPRO;
4996 return annotations;
5000 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5001 If STRING is nil, POS is the character position in the current buffer.
5002 Intersperse with them the annotations from *ANNOT
5003 which fall within the range of POS to POS + NCHARS,
5004 each at its appropriate position.
5006 We modify *ANNOT by discarding elements as we use them up.
5008 The return value is negative in case of system call failure. */
5010 static int
5011 a_write (desc, string, pos, nchars, annot, coding)
5012 int desc;
5013 Lisp_Object string;
5014 register int nchars;
5015 int pos;
5016 Lisp_Object *annot;
5017 struct coding_system *coding;
5019 Lisp_Object tem;
5020 int nextpos;
5021 int lastpos = pos + nchars;
5023 while (NILP (*annot) || CONSP (*annot))
5025 tem = Fcar_safe (Fcar (*annot));
5026 nextpos = pos - 1;
5027 if (INTEGERP (tem))
5028 nextpos = XFASTINT (tem);
5030 /* If there are no more annotations in this range,
5031 output the rest of the range all at once. */
5032 if (! (nextpos >= pos && nextpos <= lastpos))
5033 return e_write (desc, string, pos, lastpos, coding);
5035 /* Output buffer text up to the next annotation's position. */
5036 if (nextpos > pos)
5038 if (0 > e_write (desc, string, pos, nextpos, coding))
5039 return -1;
5040 pos = nextpos;
5042 /* Output the annotation. */
5043 tem = Fcdr (Fcar (*annot));
5044 if (STRINGP (tem))
5046 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5047 return -1;
5049 *annot = Fcdr (*annot);
5051 return 0;
5055 /* Write text in the range START and END into descriptor DESC,
5056 encoding them with coding system CODING. If STRING is nil, START
5057 and END are character positions of the current buffer, else they
5058 are indexes to the string STRING. */
5060 static int
5061 e_write (desc, string, start, end, coding)
5062 int desc;
5063 Lisp_Object string;
5064 int start, end;
5065 struct coding_system *coding;
5067 if (STRINGP (string))
5069 start = 0;
5070 end = SCHARS (string);
5073 /* We used to have a code for handling selective display here. But,
5074 now it is handled within encode_coding. */
5076 while (start < end)
5078 if (STRINGP (string))
5080 coding->src_multibyte = SCHARS (string) < SBYTES (string);
5081 if (CODING_REQUIRE_ENCODING (coding))
5083 encode_coding_object (coding, string,
5084 start, string_char_to_byte (string, start),
5085 end, string_char_to_byte (string, end), Qt);
5087 else
5089 coding->dst_object = string;
5090 coding->consumed_char = SCHARS (string);
5091 coding->produced = SBYTES (string);
5094 else
5096 int start_byte = CHAR_TO_BYTE (start);
5097 int end_byte = CHAR_TO_BYTE (end);
5099 coding->src_multibyte = (end - start) < (end_byte - start_byte);
5100 if (CODING_REQUIRE_ENCODING (coding))
5102 encode_coding_object (coding, Fcurrent_buffer (),
5103 start, start_byte, end, end_byte, Qt);
5105 else
5107 coding->dst_object = Qnil;
5108 coding->dst_pos_byte = start_byte;
5109 if (start >= GPT || end <= GPT)
5111 coding->consumed_char = end - start;
5112 coding->produced = end_byte - start_byte;
5114 else
5116 coding->consumed_char = GPT - start;
5117 coding->produced = GPT_BYTE - start_byte;
5122 if (coding->produced > 0)
5124 coding->produced -=
5125 emacs_write (desc,
5126 STRINGP (coding->dst_object)
5127 ? SDATA (coding->dst_object)
5128 : BYTE_POS_ADDR (coding->dst_pos_byte),
5129 coding->produced);
5131 if (coding->produced)
5132 return -1;
5134 start += coding->consumed_char;
5137 return 0;
5140 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5141 Sverify_visited_file_modtime, 1, 1, 0,
5142 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5143 This means that the file has not been changed since it was visited or saved.
5144 See Info node `(elisp)Modification Time' for more details. */)
5145 (buf)
5146 Lisp_Object buf;
5148 struct buffer *b;
5149 struct stat st;
5150 Lisp_Object handler;
5151 Lisp_Object filename;
5153 CHECK_BUFFER (buf);
5154 b = XBUFFER (buf);
5156 if (!STRINGP (b->filename)) return Qt;
5157 if (b->modtime == 0) return Qt;
5159 /* If the file name has special constructs in it,
5160 call the corresponding file handler. */
5161 handler = Ffind_file_name_handler (b->filename,
5162 Qverify_visited_file_modtime);
5163 if (!NILP (handler))
5164 return call2 (handler, Qverify_visited_file_modtime, buf);
5166 filename = ENCODE_FILE (b->filename);
5168 if (stat (SDATA (filename), &st) < 0)
5170 /* If the file doesn't exist now and didn't exist before,
5171 we say that it isn't modified, provided the error is a tame one. */
5172 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5173 st.st_mtime = -1;
5174 else
5175 st.st_mtime = 0;
5177 if ((st.st_mtime == b->modtime
5178 /* If both are positive, accept them if they are off by one second. */
5179 || (st.st_mtime > 0 && b->modtime > 0
5180 && (st.st_mtime == b->modtime + 1
5181 || st.st_mtime == b->modtime - 1)))
5182 && (st.st_size == b->modtime_size
5183 || b->modtime_size < 0))
5184 return Qt;
5185 return Qnil;
5188 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5189 Sclear_visited_file_modtime, 0, 0, 0,
5190 doc: /* Clear out records of last mod time of visited file.
5191 Next attempt to save will certainly not complain of a discrepancy. */)
5194 current_buffer->modtime = 0;
5195 current_buffer->modtime_size = -1;
5196 return Qnil;
5199 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5200 Svisited_file_modtime, 0, 0, 0,
5201 doc: /* Return the current buffer's recorded visited file modification time.
5202 The value is a list of the form (HIGH LOW), like the time values
5203 that `file-attributes' returns. If the current buffer has no recorded
5204 file modification time, this function returns 0.
5205 See Info node `(elisp)Modification Time' for more details. */)
5208 if (! current_buffer->modtime)
5209 return make_number (0);
5210 return make_time ((time_t) current_buffer->modtime);
5213 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5214 Sset_visited_file_modtime, 0, 1, 0,
5215 doc: /* Update buffer's recorded modification time from the visited file's time.
5216 Useful if the buffer was not read from the file normally
5217 or if the file itself has been changed for some known benign reason.
5218 An argument specifies the modification time value to use
5219 \(instead of that of the visited file), in the form of a list
5220 \(HIGH . LOW) or (HIGH LOW). */)
5221 (time_list)
5222 Lisp_Object time_list;
5224 if (!NILP (time_list))
5226 current_buffer->modtime = cons_to_long (time_list);
5227 current_buffer->modtime_size = -1;
5229 else
5231 register Lisp_Object filename;
5232 struct stat st;
5233 Lisp_Object handler;
5235 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5237 /* If the file name has special constructs in it,
5238 call the corresponding file handler. */
5239 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5240 if (!NILP (handler))
5241 /* The handler can find the file name the same way we did. */
5242 return call2 (handler, Qset_visited_file_modtime, Qnil);
5244 filename = ENCODE_FILE (filename);
5246 if (stat (SDATA (filename), &st) >= 0)
5248 current_buffer->modtime = st.st_mtime;
5249 current_buffer->modtime_size = st.st_size;
5253 return Qnil;
5256 Lisp_Object
5257 auto_save_error (error)
5258 Lisp_Object error;
5260 Lisp_Object args[3], msg;
5261 int i, nbytes;
5262 struct gcpro gcpro1;
5263 char *msgbuf;
5264 USE_SAFE_ALLOCA;
5266 auto_save_error_occurred = 1;
5268 ring_bell (XFRAME (selected_frame));
5270 args[0] = build_string ("Auto-saving %s: %s");
5271 args[1] = current_buffer->name;
5272 args[2] = Ferror_message_string (error);
5273 msg = Fformat (3, args);
5274 GCPRO1 (msg);
5275 nbytes = SBYTES (msg);
5276 SAFE_ALLOCA (msgbuf, char *, nbytes);
5277 bcopy (SDATA (msg), msgbuf, nbytes);
5279 for (i = 0; i < 3; ++i)
5281 if (i == 0)
5282 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5283 else
5284 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5285 Fsleep_for (make_number (1), Qnil);
5288 SAFE_FREE ();
5289 UNGCPRO;
5290 return Qnil;
5293 Lisp_Object
5294 auto_save_1 ()
5296 struct stat st;
5297 Lisp_Object modes;
5299 auto_save_mode_bits = 0666;
5301 /* Get visited file's mode to become the auto save file's mode. */
5302 if (! NILP (current_buffer->filename))
5304 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5305 /* But make sure we can overwrite it later! */
5306 auto_save_mode_bits = st.st_mode | 0600;
5307 else if ((modes = Ffile_modes (current_buffer->filename),
5308 INTEGERP (modes)))
5309 /* Remote files don't cooperate with stat. */
5310 auto_save_mode_bits = XINT (modes) | 0600;
5313 return
5314 Fwrite_region (Qnil, Qnil, current_buffer->auto_save_file_name, Qnil,
5315 NILP (Vauto_save_visited_file_name) ? Qlambda : Qt,
5316 Qnil, Qnil);
5319 static Lisp_Object
5320 do_auto_save_unwind (arg) /* used as unwind-protect function */
5321 Lisp_Object arg;
5323 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5324 auto_saving = 0;
5325 if (stream != NULL)
5327 BLOCK_INPUT;
5328 fclose (stream);
5329 UNBLOCK_INPUT;
5331 return Qnil;
5334 static Lisp_Object
5335 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5336 Lisp_Object value;
5338 minibuffer_auto_raise = XINT (value);
5339 return Qnil;
5342 static Lisp_Object
5343 do_auto_save_make_dir (dir)
5344 Lisp_Object dir;
5346 Lisp_Object mode;
5348 call2 (Qmake_directory, dir, Qt);
5349 XSETFASTINT (mode, 0700);
5350 return Fset_file_modes (dir, mode);
5353 static Lisp_Object
5354 do_auto_save_eh (ignore)
5355 Lisp_Object ignore;
5357 return Qnil;
5360 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5361 doc: /* Auto-save all buffers that need it.
5362 This is all buffers that have auto-saving enabled
5363 and are changed since last auto-saved.
5364 Auto-saving writes the buffer into a file
5365 so that your editing is not lost if the system crashes.
5366 This file is not the file you visited; that changes only when you save.
5367 Normally we run the normal hook `auto-save-hook' before saving.
5369 A non-nil NO-MESSAGE argument means do not print any message if successful.
5370 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5371 (no_message, current_only)
5372 Lisp_Object no_message, current_only;
5374 struct buffer *old = current_buffer, *b;
5375 Lisp_Object tail, buf;
5376 int auto_saved = 0;
5377 int do_handled_files;
5378 Lisp_Object oquit;
5379 FILE *stream = NULL;
5380 int count = SPECPDL_INDEX ();
5381 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5382 int old_message_p = 0;
5383 struct gcpro gcpro1, gcpro2;
5385 if (max_specpdl_size < specpdl_size + 40)
5386 max_specpdl_size = specpdl_size + 40;
5388 if (minibuf_level)
5389 no_message = Qt;
5391 if (NILP (no_message))
5393 old_message_p = push_message ();
5394 record_unwind_protect (pop_message_unwind, Qnil);
5397 /* Ordinarily don't quit within this function,
5398 but don't make it impossible to quit (in case we get hung in I/O). */
5399 oquit = Vquit_flag;
5400 Vquit_flag = Qnil;
5402 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5403 point to non-strings reached from Vbuffer_alist. */
5405 if (!NILP (Vrun_hooks))
5406 call1 (Vrun_hooks, intern ("auto-save-hook"));
5408 if (STRINGP (Vauto_save_list_file_name))
5410 Lisp_Object listfile;
5412 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5414 /* Don't try to create the directory when shutting down Emacs,
5415 because creating the directory might signal an error, and
5416 that would leave Emacs in a strange state. */
5417 if (!NILP (Vrun_hooks))
5419 Lisp_Object dir;
5420 dir = Qnil;
5421 GCPRO2 (dir, listfile);
5422 dir = Ffile_name_directory (listfile);
5423 if (NILP (Ffile_directory_p (dir)))
5424 internal_condition_case_1 (do_auto_save_make_dir,
5425 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5426 do_auto_save_eh);
5427 UNGCPRO;
5430 stream = fopen (SDATA (listfile), "w");
5433 record_unwind_protect (do_auto_save_unwind,
5434 make_save_value (stream, 0));
5435 record_unwind_protect (do_auto_save_unwind_1,
5436 make_number (minibuffer_auto_raise));
5437 minibuffer_auto_raise = 0;
5438 auto_saving = 1;
5439 auto_save_error_occurred = 0;
5441 /* On first pass, save all files that don't have handlers.
5442 On second pass, save all files that do have handlers.
5444 If Emacs is crashing, the handlers may tweak what is causing
5445 Emacs to crash in the first place, and it would be a shame if
5446 Emacs failed to autosave perfectly ordinary files because it
5447 couldn't handle some ange-ftp'd file. */
5449 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5450 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
5452 buf = XCDR (XCAR (tail));
5453 b = XBUFFER (buf);
5455 /* Record all the buffers that have auto save mode
5456 in the special file that lists them. For each of these buffers,
5457 Record visited name (if any) and auto save name. */
5458 if (STRINGP (b->auto_save_file_name)
5459 && stream != NULL && do_handled_files == 0)
5461 BLOCK_INPUT;
5462 if (!NILP (b->filename))
5464 fwrite (SDATA (b->filename), 1,
5465 SBYTES (b->filename), stream);
5467 putc ('\n', stream);
5468 fwrite (SDATA (b->auto_save_file_name), 1,
5469 SBYTES (b->auto_save_file_name), stream);
5470 putc ('\n', stream);
5471 UNBLOCK_INPUT;
5474 if (!NILP (current_only)
5475 && b != current_buffer)
5476 continue;
5478 /* Don't auto-save indirect buffers.
5479 The base buffer takes care of it. */
5480 if (b->base_buffer)
5481 continue;
5483 /* Check for auto save enabled
5484 and file changed since last auto save
5485 and file changed since last real save. */
5486 if (STRINGP (b->auto_save_file_name)
5487 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5488 && BUF_AUTOSAVE_MODIFF (b) < BUF_MODIFF (b)
5489 /* -1 means we've turned off autosaving for a while--see below. */
5490 && XINT (b->save_length) >= 0
5491 && (do_handled_files
5492 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5493 Qwrite_region))))
5495 EMACS_TIME before_time, after_time;
5497 EMACS_GET_TIME (before_time);
5499 /* If we had a failure, don't try again for 20 minutes. */
5500 if (b->auto_save_failure_time >= 0
5501 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5502 continue;
5504 set_buffer_internal (b);
5505 if (NILP (Vauto_save_include_big_deletions)
5506 && (XFASTINT (b->save_length) * 10
5507 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5508 /* A short file is likely to change a large fraction;
5509 spare the user annoying messages. */
5510 && XFASTINT (b->save_length) > 5000
5511 /* These messages are frequent and annoying for `*mail*'. */
5512 && !EQ (b->filename, Qnil)
5513 && NILP (no_message))
5515 /* It has shrunk too much; turn off auto-saving here. */
5516 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5517 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5518 b->name, 1);
5519 minibuffer_auto_raise = 0;
5520 /* Turn off auto-saving until there's a real save,
5521 and prevent any more warnings. */
5522 XSETINT (b->save_length, -1);
5523 Fsleep_for (make_number (1), Qnil);
5524 continue;
5526 if (!auto_saved && NILP (no_message))
5527 message1 ("Auto-saving...");
5528 internal_condition_case (auto_save_1, Qt, auto_save_error);
5529 auto_saved++;
5530 BUF_AUTOSAVE_MODIFF (b) = BUF_MODIFF (b);
5531 XSETFASTINT (current_buffer->save_length, Z - BEG);
5532 set_buffer_internal (old);
5534 EMACS_GET_TIME (after_time);
5536 /* If auto-save took more than 60 seconds,
5537 assume it was an NFS failure that got a timeout. */
5538 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5539 b->auto_save_failure_time = EMACS_SECS (after_time);
5543 /* Prevent another auto save till enough input events come in. */
5544 record_auto_save ();
5546 if (auto_saved && NILP (no_message))
5548 if (old_message_p)
5550 /* If we are going to restore an old message,
5551 give time to read ours. */
5552 sit_for (make_number (1), 0, 0);
5553 restore_message ();
5555 else if (!auto_save_error_occurred)
5556 /* Don't overwrite the error message if an error occurred.
5557 If we displayed a message and then restored a state
5558 with no message, leave a "done" message on the screen. */
5559 message1 ("Auto-saving...done");
5562 Vquit_flag = oquit;
5564 /* This restores the message-stack status. */
5565 unbind_to (count, Qnil);
5566 return Qnil;
5569 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
5570 Sset_buffer_auto_saved, 0, 0, 0,
5571 doc: /* Mark current buffer as auto-saved with its current text.
5572 No auto-save file will be written until the buffer changes again. */)
5575 /* FIXME: This should not be called in indirect buffers, since
5576 they're not autosaved. */
5577 BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF;
5578 XSETFASTINT (current_buffer->save_length, Z - BEG);
5579 current_buffer->auto_save_failure_time = -1;
5580 return Qnil;
5583 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
5584 Sclear_buffer_auto_save_failure, 0, 0, 0,
5585 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
5588 current_buffer->auto_save_failure_time = -1;
5589 return Qnil;
5592 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
5593 0, 0, 0,
5594 doc: /* Return t if current buffer has been auto-saved recently.
5595 More precisely, if it has been auto-saved since last read from or saved
5596 in the visited file. If the buffer has no visited file,
5597 then any auto-save counts as "recent". */)
5600 /* FIXME: maybe we should return nil for indirect buffers since
5601 they're never autosaved. */
5602 return (SAVE_MODIFF < BUF_AUTOSAVE_MODIFF (current_buffer) ? Qt : Qnil);
5605 /* Reading and completing file names */
5607 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
5608 Snext_read_file_uses_dialog_p, 0, 0, 0,
5609 doc: /* Return t if a call to `read-file-name' will use a dialog.
5610 The return value is only relevant for a call to `read-file-name' that happens
5611 before any other event (mouse or keypress) is handled. */)
5614 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5615 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
5616 && use_dialog_box
5617 && use_file_dialog
5618 && have_menus_p ())
5619 return Qt;
5620 #endif
5621 return Qnil;
5624 Lisp_Object
5625 Fread_file_name (prompt, dir, default_filename, mustmatch, initial, predicate)
5626 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
5628 struct gcpro gcpro1, gcpro2;
5629 Lisp_Object args[7];
5631 GCPRO1 (default_filename);
5632 args[0] = intern ("read-file-name");
5633 args[1] = prompt;
5634 args[2] = dir;
5635 args[3] = default_filename;
5636 args[4] = mustmatch;
5637 args[5] = initial;
5638 args[6] = predicate;
5639 RETURN_UNGCPRO (Ffuncall (7, args));
5643 void
5644 syms_of_fileio ()
5646 Qoperations = intern_c_string ("operations");
5647 Qexpand_file_name = intern_c_string ("expand-file-name");
5648 Qsubstitute_in_file_name = intern_c_string ("substitute-in-file-name");
5649 Qdirectory_file_name = intern_c_string ("directory-file-name");
5650 Qfile_name_directory = intern_c_string ("file-name-directory");
5651 Qfile_name_nondirectory = intern_c_string ("file-name-nondirectory");
5652 Qunhandled_file_name_directory = intern_c_string ("unhandled-file-name-directory");
5653 Qfile_name_as_directory = intern_c_string ("file-name-as-directory");
5654 Qcopy_file = intern_c_string ("copy-file");
5655 Qmake_directory_internal = intern_c_string ("make-directory-internal");
5656 Qmake_directory = intern_c_string ("make-directory");
5657 Qdelete_directory_internal = intern_c_string ("delete-directory-internal");
5658 Qdelete_file = intern_c_string ("delete-file");
5659 Qrename_file = intern_c_string ("rename-file");
5660 Qadd_name_to_file = intern_c_string ("add-name-to-file");
5661 Qmake_symbolic_link = intern_c_string ("make-symbolic-link");
5662 Qfile_exists_p = intern_c_string ("file-exists-p");
5663 Qfile_executable_p = intern_c_string ("file-executable-p");
5664 Qfile_readable_p = intern_c_string ("file-readable-p");
5665 Qfile_writable_p = intern_c_string ("file-writable-p");
5666 Qfile_symlink_p = intern_c_string ("file-symlink-p");
5667 Qaccess_file = intern_c_string ("access-file");
5668 Qfile_directory_p = intern_c_string ("file-directory-p");
5669 Qfile_regular_p = intern_c_string ("file-regular-p");
5670 Qfile_accessible_directory_p = intern_c_string ("file-accessible-directory-p");
5671 Qfile_modes = intern_c_string ("file-modes");
5672 Qset_file_modes = intern_c_string ("set-file-modes");
5673 Qset_file_times = intern_c_string ("set-file-times");
5674 Qfile_selinux_context = intern_c_string("file-selinux-context");
5675 Qset_file_selinux_context = intern_c_string("set-file-selinux-context");
5676 Qfile_newer_than_file_p = intern_c_string ("file-newer-than-file-p");
5677 Qinsert_file_contents = intern_c_string ("insert-file-contents");
5678 Qwrite_region = intern_c_string ("write-region");
5679 Qverify_visited_file_modtime = intern_c_string ("verify-visited-file-modtime");
5680 Qset_visited_file_modtime = intern_c_string ("set-visited-file-modtime");
5681 Qauto_save_coding = intern_c_string ("auto-save-coding");
5683 staticpro (&Qoperations);
5684 staticpro (&Qexpand_file_name);
5685 staticpro (&Qsubstitute_in_file_name);
5686 staticpro (&Qdirectory_file_name);
5687 staticpro (&Qfile_name_directory);
5688 staticpro (&Qfile_name_nondirectory);
5689 staticpro (&Qunhandled_file_name_directory);
5690 staticpro (&Qfile_name_as_directory);
5691 staticpro (&Qcopy_file);
5692 staticpro (&Qmake_directory_internal);
5693 staticpro (&Qmake_directory);
5694 staticpro (&Qdelete_directory_internal);
5695 staticpro (&Qdelete_file);
5696 staticpro (&Qrename_file);
5697 staticpro (&Qadd_name_to_file);
5698 staticpro (&Qmake_symbolic_link);
5699 staticpro (&Qfile_exists_p);
5700 staticpro (&Qfile_executable_p);
5701 staticpro (&Qfile_readable_p);
5702 staticpro (&Qfile_writable_p);
5703 staticpro (&Qaccess_file);
5704 staticpro (&Qfile_symlink_p);
5705 staticpro (&Qfile_directory_p);
5706 staticpro (&Qfile_regular_p);
5707 staticpro (&Qfile_accessible_directory_p);
5708 staticpro (&Qfile_modes);
5709 staticpro (&Qset_file_modes);
5710 staticpro (&Qset_file_times);
5711 staticpro (&Qfile_selinux_context);
5712 staticpro (&Qset_file_selinux_context);
5713 staticpro (&Qfile_newer_than_file_p);
5714 staticpro (&Qinsert_file_contents);
5715 staticpro (&Qwrite_region);
5716 staticpro (&Qverify_visited_file_modtime);
5717 staticpro (&Qset_visited_file_modtime);
5718 staticpro (&Qauto_save_coding);
5720 Qfile_name_history = intern_c_string ("file-name-history");
5721 Fset (Qfile_name_history, Qnil);
5722 staticpro (&Qfile_name_history);
5724 Qfile_error = intern_c_string ("file-error");
5725 staticpro (&Qfile_error);
5726 Qfile_already_exists = intern_c_string ("file-already-exists");
5727 staticpro (&Qfile_already_exists);
5728 Qfile_date_error = intern_c_string ("file-date-error");
5729 staticpro (&Qfile_date_error);
5730 Qexcl = intern_c_string ("excl");
5731 staticpro (&Qexcl);
5733 #ifdef DOS_NT
5734 Qfind_buffer_file_type = intern_c_string ("find-buffer-file-type");
5735 staticpro (&Qfind_buffer_file_type);
5736 #endif /* DOS_NT */
5738 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
5739 doc: /* *Coding system for encoding file names.
5740 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5741 Vfile_name_coding_system = Qnil;
5743 DEFVAR_LISP ("default-file-name-coding-system",
5744 &Vdefault_file_name_coding_system,
5745 doc: /* Default coding system for encoding file names.
5746 This variable is used only when `file-name-coding-system' is nil.
5748 This variable is set/changed by the command `set-language-environment'.
5749 User should not set this variable manually,
5750 instead use `file-name-coding-system' to get a constant encoding
5751 of file names regardless of the current language environment. */);
5752 Vdefault_file_name_coding_system = Qnil;
5754 Qformat_decode = intern_c_string ("format-decode");
5755 staticpro (&Qformat_decode);
5756 Qformat_annotate_function = intern_c_string ("format-annotate-function");
5757 staticpro (&Qformat_annotate_function);
5758 Qafter_insert_file_set_coding = intern_c_string ("after-insert-file-set-coding");
5759 staticpro (&Qafter_insert_file_set_coding);
5761 Qcar_less_than_car = intern_c_string ("car-less-than-car");
5762 staticpro (&Qcar_less_than_car);
5764 Fput (Qfile_error, Qerror_conditions,
5765 Fpurecopy (list2 (Qfile_error, Qerror)));
5766 Fput (Qfile_error, Qerror_message,
5767 make_pure_c_string ("File error"));
5769 Fput (Qfile_already_exists, Qerror_conditions,
5770 Fpurecopy (list3 (Qfile_already_exists, Qfile_error, Qerror)));
5771 Fput (Qfile_already_exists, Qerror_message,
5772 make_pure_c_string ("File already exists"));
5774 Fput (Qfile_date_error, Qerror_conditions,
5775 Fpurecopy (list3 (Qfile_date_error, Qfile_error, Qerror)));
5776 Fput (Qfile_date_error, Qerror_message,
5777 make_pure_c_string ("Cannot set file date"));
5779 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
5780 doc: /* Directory separator character for built-in functions that return file names.
5781 The value is always ?/. Don't use this variable, just use `/'. */);
5782 XSETFASTINT (Vdirectory_sep_char, '/');
5784 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
5785 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5786 If a file name matches REGEXP, then all I/O on that file is done by calling
5787 HANDLER.
5789 The first argument given to HANDLER is the name of the I/O primitive
5790 to be handled; the remaining arguments are the arguments that were
5791 passed to that primitive. For example, if you do
5792 (file-exists-p FILENAME)
5793 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5794 (funcall HANDLER 'file-exists-p FILENAME)
5795 The function `find-file-name-handler' checks this list for a handler
5796 for its argument. */);
5797 Vfile_name_handler_alist = Qnil;
5799 DEFVAR_LISP ("set-auto-coding-function",
5800 &Vset_auto_coding_function,
5801 doc: /* If non-nil, a function to call to decide a coding system of file.
5802 Two arguments are passed to this function: the file name
5803 and the length of a file contents following the point.
5804 This function should return a coding system to decode the file contents.
5805 It should check the file name against `auto-coding-alist'.
5806 If no coding system is decided, it should check a coding system
5807 specified in the heading lines with the format:
5808 -*- ... coding: CODING-SYSTEM; ... -*-
5809 or local variable spec of the tailing lines with `coding:' tag. */);
5810 Vset_auto_coding_function = Qnil;
5812 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
5813 doc: /* A list of functions to be called at the end of `insert-file-contents'.
5814 Each is passed one argument, the number of characters inserted,
5815 with point at the start of the inserted text. Each function
5816 should leave point the same, and return the new character count.
5817 If `insert-file-contents' is intercepted by a handler from
5818 `file-name-handler-alist', that handler is responsible for calling the
5819 functions in `after-insert-file-functions' if appropriate. */);
5820 Vafter_insert_file_functions = Qnil;
5822 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
5823 doc: /* A list of functions to be called at the start of `write-region'.
5824 Each is passed two arguments, START and END as for `write-region'.
5825 These are usually two numbers but not always; see the documentation
5826 for `write-region'. The function should return a list of pairs
5827 of the form (POSITION . STRING), consisting of strings to be effectively
5828 inserted at the specified positions of the file being written (1 means to
5829 insert before the first byte written). The POSITIONs must be sorted into
5830 increasing order.
5832 If there are several annotation functions, the lists returned by these
5833 functions are merged destructively. As each annotation function runs,
5834 the variable `write-region-annotations-so-far' contains a list of all
5835 annotations returned by previous annotation functions.
5837 An annotation function can return with a different buffer current.
5838 Doing so removes the annotations returned by previous functions, and
5839 resets START and END to `point-min' and `point-max' of the new buffer.
5841 After `write-region' completes, Emacs calls the function stored in
5842 `write-region-post-annotation-function', once for each buffer that was
5843 current when building the annotations (i.e., at least once), with that
5844 buffer current. */);
5845 Vwrite_region_annotate_functions = Qnil;
5846 staticpro (&Qwrite_region_annotate_functions);
5847 Qwrite_region_annotate_functions
5848 = intern_c_string ("write-region-annotate-functions");
5850 DEFVAR_LISP ("write-region-post-annotation-function",
5851 &Vwrite_region_post_annotation_function,
5852 doc: /* Function to call after `write-region' completes.
5853 The function is called with no arguments. If one or more of the
5854 annotation functions in `write-region-annotate-functions' changed the
5855 current buffer, the function stored in this variable is called for
5856 each of those additional buffers as well, in addition to the original
5857 buffer. The relevant buffer is current during each function call. */);
5858 Vwrite_region_post_annotation_function = Qnil;
5859 staticpro (&Vwrite_region_annotation_buffers);
5861 DEFVAR_LISP ("write-region-annotations-so-far",
5862 &Vwrite_region_annotations_so_far,
5863 doc: /* When an annotation function is called, this holds the previous annotations.
5864 These are the annotations made by other annotation functions
5865 that were already called. See also `write-region-annotate-functions'. */);
5866 Vwrite_region_annotations_so_far = Qnil;
5868 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
5869 doc: /* A list of file name handlers that temporarily should not be used.
5870 This applies only to the operation `inhibit-file-name-operation'. */);
5871 Vinhibit_file_name_handlers = Qnil;
5873 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
5874 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5875 Vinhibit_file_name_operation = Qnil;
5877 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
5878 doc: /* File name in which we write a list of all auto save file names.
5879 This variable is initialized automatically from `auto-save-list-file-prefix'
5880 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5881 a non-nil value. */);
5882 Vauto_save_list_file_name = Qnil;
5884 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name,
5885 doc: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5886 Normally auto-save files are written under other names. */);
5887 Vauto_save_visited_file_name = Qnil;
5889 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions,
5890 doc: /* If non-nil, auto-save even if a large part of the text is deleted.
5891 If nil, deleting a substantial portion of the text disables auto-save
5892 in the buffer; this is the default behavior, because the auto-save
5893 file is usually more useful if it contains the deleted text. */);
5894 Vauto_save_include_big_deletions = Qnil;
5896 #ifdef HAVE_FSYNC
5897 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
5898 doc: /* *Non-nil means don't call fsync in `write-region'.
5899 This variable affects calls to `write-region' as well as save commands.
5900 A non-nil value may result in data loss! */);
5901 write_region_inhibit_fsync = 0;
5902 #endif
5904 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash,
5905 doc: /* Specifies whether to use the system's trash can.
5906 When non-nil, the function `move-file-to-trash' will be used by
5907 `delete-file' and `delete-directory'. */);
5908 delete_by_moving_to_trash = 0;
5909 Qdelete_by_moving_to_trash = intern_c_string ("delete-by-moving-to-trash");
5910 Qmove_file_to_trash = intern_c_string ("move-file-to-trash");
5911 staticpro (&Qmove_file_to_trash);
5912 Qcopy_directory = intern_c_string ("copy-directory");
5913 staticpro (&Qcopy_directory);
5914 Qdelete_directory = intern_c_string ("delete-directory");
5915 staticpro (&Qdelete_directory);
5917 defsubr (&Sfind_file_name_handler);
5918 defsubr (&Sfile_name_directory);
5919 defsubr (&Sfile_name_nondirectory);
5920 defsubr (&Sunhandled_file_name_directory);
5921 defsubr (&Sfile_name_as_directory);
5922 defsubr (&Sdirectory_file_name);
5923 defsubr (&Smake_temp_name);
5924 defsubr (&Sexpand_file_name);
5925 defsubr (&Ssubstitute_in_file_name);
5926 defsubr (&Scopy_file);
5927 defsubr (&Smake_directory_internal);
5928 defsubr (&Sdelete_directory_internal);
5929 defsubr (&Sdelete_file);
5930 defsubr (&Srename_file);
5931 defsubr (&Sadd_name_to_file);
5932 defsubr (&Smake_symbolic_link);
5933 defsubr (&Sfile_name_absolute_p);
5934 defsubr (&Sfile_exists_p);
5935 defsubr (&Sfile_executable_p);
5936 defsubr (&Sfile_readable_p);
5937 defsubr (&Sfile_writable_p);
5938 defsubr (&Saccess_file);
5939 defsubr (&Sfile_symlink_p);
5940 defsubr (&Sfile_directory_p);
5941 defsubr (&Sfile_accessible_directory_p);
5942 defsubr (&Sfile_regular_p);
5943 defsubr (&Sfile_modes);
5944 defsubr (&Sset_file_modes);
5945 defsubr (&Sset_file_times);
5946 defsubr (&Sfile_selinux_context);
5947 defsubr (&Sset_file_selinux_context);
5948 defsubr (&Sset_default_file_modes);
5949 defsubr (&Sdefault_file_modes);
5950 defsubr (&Sfile_newer_than_file_p);
5951 defsubr (&Sinsert_file_contents);
5952 defsubr (&Swrite_region);
5953 defsubr (&Scar_less_than_car);
5954 defsubr (&Sverify_visited_file_modtime);
5955 defsubr (&Sclear_visited_file_modtime);
5956 defsubr (&Svisited_file_modtime);
5957 defsubr (&Sset_visited_file_modtime);
5958 defsubr (&Sdo_auto_save);
5959 defsubr (&Sset_buffer_auto_saved);
5960 defsubr (&Sclear_buffer_auto_save_failure);
5961 defsubr (&Srecent_auto_save_p);
5963 defsubr (&Snext_read_file_uses_dialog_p);
5965 #ifdef HAVE_SYNC
5966 defsubr (&Sunix_sync);
5967 #endif
5970 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5971 (do not change this comment) */