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