Add arch tagline
[emacs.git] / src / fileio.c
blob2544bd50e408c71fe8c685b04e8243213bc09fd1
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 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <limits.h>
24 #ifdef HAVE_FCNTL_H
25 #include <fcntl.h>
26 #endif
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
38 #endif
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
42 #endif
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
46 #endif
48 #ifdef HAVE_PWD_H
49 #include <pwd.h>
50 #endif
52 #include <ctype.h>
54 #ifdef VMS
55 #include "vmsdir.h"
56 #include <perror.h>
57 #include <stddef.h>
58 #include <string.h>
59 #endif
61 #include <errno.h>
63 #ifndef vax11c
64 #ifndef USE_CRT_DLL
65 extern int errno;
66 #endif
67 #endif
69 #include "lisp.h"
70 #include "intervals.h"
71 #include "buffer.h"
72 #include "character.h"
73 #include "coding.h"
74 #include "window.h"
75 #include "blockinput.h"
76 #include "frame.h"
77 #include "dispextern.h"
79 #ifdef WINDOWSNT
80 #define NOMINMAX 1
81 #include <windows.h>
82 #include <stdlib.h>
83 #include <fcntl.h>
84 #endif /* not WINDOWSNT */
86 #ifdef MSDOS
87 #include "msdos.h"
88 #include <sys/param.h>
89 #if __DJGPP__ >= 2
90 #include <fcntl.h>
91 #include <string.h>
92 #endif
93 #endif
95 #ifdef DOS_NT
96 #define CORRECT_DIR_SEPS(s) \
97 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
98 else unixtodos_filename (s); \
99 } while (0)
100 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
101 redirector allows the six letters between 'Z' and 'a' as well. */
102 #ifdef MSDOS
103 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
104 #endif
105 #ifdef WINDOWSNT
106 #define IS_DRIVE(x) isalpha (x)
107 #endif
108 /* Need to lower-case the drive letter, or else expanded
109 filenames will sometimes compare inequal, because
110 `expand-file-name' doesn't always down-case the drive letter. */
111 #define DRIVE_LETTER(x) (tolower (x))
112 #endif
114 #ifdef VMS
115 #include <file.h>
116 #include <rmsdef.h>
117 #include <fab.h>
118 #include <nam.h>
119 #endif
121 #include "systime.h"
123 #ifdef HPUX
124 #include <netio.h>
125 #endif
127 #include "commands.h"
128 extern int use_dialog_box;
129 extern int use_file_dialog;
131 #ifndef O_WRONLY
132 #define O_WRONLY 1
133 #endif
135 #ifndef O_RDONLY
136 #define O_RDONLY 0
137 #endif
139 #ifndef S_ISLNK
140 # define lstat stat
141 #endif
143 #ifndef FILE_SYSTEM_CASE
144 #define FILE_SYSTEM_CASE(filename) (filename)
145 #endif
147 /* Nonzero during writing of auto-save files */
148 int auto_saving;
150 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
151 a new file with the same mode as the original */
152 int auto_save_mode_bits;
154 /* Set by auto_save_1 if an error occurred during the last auto-save. */
155 int auto_save_error_occurred;
157 /* The symbol bound to coding-system-for-read when
158 insert-file-contents is called for recovering a file. This is not
159 an actual coding system name, but just an indicator to tell
160 insert-file-contents to use `emacs-mule' with a special flag for
161 auto saving and recovering a file. */
162 Lisp_Object Qauto_save_coding;
164 /* Coding system for file names, or nil if none. */
165 Lisp_Object Vfile_name_coding_system;
167 /* Coding system for file names used only when
168 Vfile_name_coding_system is nil. */
169 Lisp_Object Vdefault_file_name_coding_system;
171 /* Alist of elements (REGEXP . HANDLER) for file names
172 whose I/O is done with a special handler. */
173 Lisp_Object Vfile_name_handler_alist;
175 /* Property name of a file name handler,
176 which gives a list of operations it handles.. */
177 Lisp_Object Qoperations;
179 /* Lisp functions for translating file formats */
180 Lisp_Object Qformat_decode, Qformat_annotate_function;
182 /* Function to be called to decide a coding system of a reading file. */
183 Lisp_Object Vset_auto_coding_function;
185 /* Functions to be called to process text properties in inserted file. */
186 Lisp_Object Vafter_insert_file_functions;
188 /* Lisp function for setting buffer-file-coding-system and the
189 multibyteness of the current buffer after inserting a file. */
190 Lisp_Object Qafter_insert_file_set_coding;
192 /* Functions to be called to create text property annotations for file. */
193 Lisp_Object Vwrite_region_annotate_functions;
194 Lisp_Object Qwrite_region_annotate_functions;
196 /* During build_annotations, each time an annotation function is called,
197 this holds the annotations made by the previous functions. */
198 Lisp_Object Vwrite_region_annotations_so_far;
200 /* File name in which we write a list of all our auto save files. */
201 Lisp_Object Vauto_save_list_file_name;
203 /* On VMS, nonzero means write new files with record format stmlf.
204 Zero means use var format. */
205 int vms_stmlf_recfm;
207 /* On NT, specifies the directory separator character, used (eg.) when
208 expanding file names. This can be bound to / or \. */
209 Lisp_Object Vdirectory_sep_char;
211 #ifdef HAVE_FSYNC
212 /* Nonzero means skip the call to fsync in Fwrite-region. */
213 int write_region_inhibit_fsync;
214 #endif
216 /* Non-zero means call move-file-to-trash in Fdelete_file or
217 Fdelete_directory. */
218 int delete_by_moving_to_trash;
220 /* Lisp function for moving files to trash. */
221 Lisp_Object Qmove_file_to_trash;
223 extern Lisp_Object Vuser_login_name;
225 #ifdef WINDOWSNT
226 extern Lisp_Object Vw32_get_true_file_attributes;
227 #endif
229 extern int minibuf_level;
231 extern int minibuffer_auto_raise;
233 extern int history_delete_duplicates;
235 /* These variables describe handlers that have "already" had a chance
236 to handle the current operation.
238 Vinhibit_file_name_handlers is a list of file name handlers.
239 Vinhibit_file_name_operation is the operation being handled.
240 If we try to handle that operation, we ignore those handlers. */
242 static Lisp_Object Vinhibit_file_name_handlers;
243 static Lisp_Object Vinhibit_file_name_operation;
245 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
246 Lisp_Object Qexcl;
247 Lisp_Object Qfile_name_history;
249 Lisp_Object Qcar_less_than_car;
251 static int a_write P_ ((int, Lisp_Object, int, int,
252 Lisp_Object *, struct coding_system *));
253 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
256 void
257 report_file_error (string, data)
258 const char *string;
259 Lisp_Object data;
261 Lisp_Object errstring;
262 int errorno = errno;
263 char *str;
265 synchronize_system_messages_locale ();
266 str = strerror (errorno);
267 errstring = code_convert_string_norecord (make_unibyte_string (str,
268 strlen (str)),
269 Vlocale_coding_system, 0);
271 while (1)
272 switch (errorno)
274 case EEXIST:
275 xsignal (Qfile_already_exists, Fcons (errstring, data));
276 break;
277 default:
278 /* System error messages are capitalized. Downcase the initial
279 unless it is followed by a slash. */
280 if (SREF (errstring, 1) != '/')
281 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
283 xsignal (Qfile_error,
284 Fcons (build_string (string), Fcons (errstring, data)));
288 Lisp_Object
289 close_file_unwind (fd)
290 Lisp_Object fd;
292 emacs_close (XFASTINT (fd));
293 return Qnil;
296 /* Restore point, having saved it as a marker. */
298 static Lisp_Object
299 restore_point_unwind (location)
300 Lisp_Object location;
302 Fgoto_char (location);
303 Fset_marker (location, Qnil, Qnil);
304 return Qnil;
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;
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.
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;
354 /* This function must not munge the match data. */
355 Lisp_Object chain, inhibited_handlers, result;
356 int pos = -1;
358 result = Qnil;
359 CHECK_STRING (filename);
361 if (EQ (operation, Vinhibit_file_name_operation))
362 inhibited_handlers = Vinhibit_file_name_handlers;
363 else
364 inhibited_handlers = Qnil;
366 for (chain = Vfile_name_handler_alist; CONSP (chain);
367 chain = XCDR (chain))
369 Lisp_Object elt;
370 elt = XCAR (chain);
371 if (CONSP (elt))
373 Lisp_Object string = XCAR (elt);
374 int match_pos;
375 Lisp_Object handler = XCDR (elt);
376 Lisp_Object operations = Qnil;
378 if (SYMBOLP (handler))
379 operations = Fget (handler, Qoperations);
381 if (STRINGP (string)
382 && (match_pos = fast_string_match (string, filename)) > pos
383 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
385 Lisp_Object tem;
387 handler = XCDR (elt);
388 tem = Fmemq (handler, inhibited_handlers);
389 if (NILP (tem))
391 result = handler;
392 pos = match_pos;
397 QUIT;
399 return result;
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 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
409 (filename)
410 Lisp_Object filename;
412 #ifndef DOS_NT
413 register const unsigned char *beg;
414 #else
415 register unsigned char *beg;
416 #endif
417 register const unsigned char *p;
418 Lisp_Object handler;
420 CHECK_STRING (filename);
422 /* If the file name has special constructs in it,
423 call the corresponding file handler. */
424 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
425 if (!NILP (handler))
426 return call2 (handler, Qfile_name_directory, filename);
428 filename = FILE_SYSTEM_CASE (filename);
429 beg = SDATA (filename);
430 #ifdef DOS_NT
431 beg = strcpy (alloca (strlen (beg) + 1), beg);
432 #endif
433 p = beg + SBYTES (filename);
435 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
436 #ifdef VMS
437 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
438 #endif /* VMS */
439 #ifdef DOS_NT
440 /* only recognise drive specifier at the beginning */
441 && !(p[-1] == ':'
442 /* handle the "/:d:foo" and "/:foo" cases correctly */
443 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
444 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
445 #endif
446 ) p--;
448 if (p == beg)
449 return Qnil;
450 #ifdef DOS_NT
451 /* Expansion of "c:" to drive and default directory. */
452 if (p[-1] == ':')
454 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
455 unsigned char *res = alloca (MAXPATHLEN + 1);
456 unsigned char *r = res;
458 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
460 strncpy (res, beg, 2);
461 beg += 2;
462 r += 2;
465 if (getdefdir (toupper (*beg) - 'A' + 1, r))
467 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
468 strcat (res, "/");
469 beg = res;
470 p = beg + strlen (beg);
473 CORRECT_DIR_SEPS (beg);
474 #endif /* DOS_NT */
476 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
479 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
480 Sfile_name_nondirectory, 1, 1, 0,
481 doc: /* Return file name FILENAME sans its directory.
482 For example, in a Unix-syntax file name,
483 this is everything after the last slash,
484 or the entire name if it contains no slash. */)
485 (filename)
486 Lisp_Object filename;
488 register const unsigned char *beg, *p, *end;
489 Lisp_Object handler;
491 CHECK_STRING (filename);
493 /* If the file name has special constructs in it,
494 call the corresponding file handler. */
495 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
496 if (!NILP (handler))
497 return call2 (handler, Qfile_name_nondirectory, filename);
499 beg = SDATA (filename);
500 end = p = beg + SBYTES (filename);
502 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
503 #ifdef VMS
504 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
505 #endif /* VMS */
506 #ifdef DOS_NT
507 /* only recognise drive specifier at beginning */
508 && !(p[-1] == ':'
509 /* handle the "/:d:foo" case correctly */
510 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
511 #endif
513 p--;
515 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
518 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
519 Sunhandled_file_name_directory, 1, 1, 0,
520 doc: /* Return a directly usable directory name somehow associated with FILENAME.
521 A `directly usable' directory name is one that may be used without the
522 intervention of any file handler.
523 If FILENAME is a directly usable file itself, return
524 \(file-name-directory FILENAME).
525 If FILENAME refers to a file which is not accessible from a local process,
526 then this should return nil.
527 The `call-process' and `start-process' functions use this function to
528 get a current directory to run processes in. */)
529 (filename)
530 Lisp_Object filename;
532 Lisp_Object handler;
534 /* If the file name has special constructs in it,
535 call the corresponding file handler. */
536 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
537 if (!NILP (handler))
538 return call2 (handler, Qunhandled_file_name_directory, filename);
540 return Ffile_name_directory (filename);
544 char *
545 file_name_as_directory (out, in)
546 char *out, *in;
548 int size = strlen (in) - 1;
550 strcpy (out, in);
552 if (size < 0)
554 out[0] = '.';
555 out[1] = '/';
556 out[2] = 0;
557 return out;
560 #ifdef VMS
561 /* Is it already a directory string? */
562 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
563 return out;
564 /* Is it a VMS directory file name? If so, hack VMS syntax. */
565 else if (! index (in, '/')
566 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
567 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
568 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
569 || ! strncmp (&in[size - 5], ".dir", 4))
570 && (in[size - 1] == '.' || in[size - 1] == ';')
571 && in[size] == '1')))
573 register char *p, *dot;
574 char brack;
576 /* x.dir -> [.x]
577 dir:x.dir --> dir:[x]
578 dir:[x]y.dir --> dir:[x.y] */
579 p = in + size;
580 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
581 if (p != in)
583 strncpy (out, in, p - in);
584 out[p - in] = '\0';
585 if (*p == ':')
587 brack = ']';
588 strcat (out, ":[");
590 else
592 brack = *p;
593 strcat (out, ".");
595 p++;
597 else
599 brack = ']';
600 strcpy (out, "[.");
602 dot = index (p, '.');
603 if (dot)
605 /* blindly remove any extension */
606 size = strlen (out) + (dot - p);
607 strncat (out, p, dot - p);
609 else
611 strcat (out, p);
612 size = strlen (out);
614 out[size++] = brack;
615 out[size] = '\0';
617 #else /* not VMS */
618 /* For Unix syntax, Append a slash if necessary */
619 if (!IS_DIRECTORY_SEP (out[size]))
621 /* Cannot use DIRECTORY_SEP, which could have any value */
622 out[size + 1] = '/';
623 out[size + 2] = '\0';
625 #ifdef DOS_NT
626 CORRECT_DIR_SEPS (out);
627 #endif
628 #endif /* not VMS */
629 return out;
632 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
633 Sfile_name_as_directory, 1, 1, 0,
634 doc: /* Return a string representing the file name FILE interpreted as a directory.
635 This operation exists because a directory is also a file, but its name as
636 a directory is different from its name as a file.
637 The result can be used as the value of `default-directory'
638 or passed as second argument to `expand-file-name'.
639 For a Unix-syntax file name, just appends a slash.
640 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
641 (file)
642 Lisp_Object file;
644 char *buf;
645 Lisp_Object handler;
647 CHECK_STRING (file);
648 if (NILP (file))
649 return Qnil;
651 /* If the file name has special constructs in it,
652 call the corresponding file handler. */
653 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
654 if (!NILP (handler))
655 return call2 (handler, Qfile_name_as_directory, file);
657 buf = (char *) alloca (SBYTES (file) + 10);
658 file_name_as_directory (buf, SDATA (file));
659 return make_specified_string (buf, -1, strlen (buf),
660 STRING_MULTIBYTE (file));
664 * Convert from directory name to filename.
665 * On VMS:
666 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
667 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
668 * On UNIX, it's simple: just make sure there isn't a terminating /
670 * Value is nonzero if the string output is different from the input.
674 directory_file_name (src, dst)
675 char *src, *dst;
677 long slen;
678 #ifdef VMS
679 long rlen;
680 char * ptr, * rptr;
681 char bracket;
682 struct FAB fab = cc$rms_fab;
683 struct NAM nam = cc$rms_nam;
684 char esa[NAM$C_MAXRSS];
685 #endif /* VMS */
687 slen = strlen (src);
688 #ifdef VMS
689 if (! index (src, '/')
690 && (src[slen - 1] == ']'
691 || src[slen - 1] == ':'
692 || src[slen - 1] == '>'))
694 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
695 fab.fab$l_fna = src;
696 fab.fab$b_fns = slen;
697 fab.fab$l_nam = &nam;
698 fab.fab$l_fop = FAB$M_NAM;
700 nam.nam$l_esa = esa;
701 nam.nam$b_ess = sizeof esa;
702 nam.nam$b_nop |= NAM$M_SYNCHK;
704 /* We call SYS$PARSE to handle such things as [--] for us. */
705 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
707 slen = nam.nam$b_esl;
708 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
709 slen -= 2;
710 esa[slen] = '\0';
711 src = esa;
713 if (src[slen - 1] != ']' && src[slen - 1] != '>')
715 /* what about when we have logical_name:???? */
716 if (src[slen - 1] == ':')
717 { /* Xlate logical name and see what we get */
718 ptr = strcpy (dst, src); /* upper case for getenv */
719 while (*ptr)
721 if ('a' <= *ptr && *ptr <= 'z')
722 *ptr -= 040;
723 ptr++;
725 dst[slen - 1] = 0; /* remove colon */
726 if (!(src = egetenv (dst)))
727 return 0;
728 /* should we jump to the beginning of this procedure?
729 Good points: allows us to use logical names that xlate
730 to Unix names,
731 Bad points: can be a problem if we just translated to a device
732 name...
733 For now, I'll punt and always expect VMS names, and hope for
734 the best! */
735 slen = strlen (src);
736 if (src[slen - 1] != ']' && src[slen - 1] != '>')
737 { /* no recursion here! */
738 strcpy (dst, src);
739 return 0;
742 else
743 { /* not a directory spec */
744 strcpy (dst, src);
745 return 0;
748 bracket = src[slen - 1];
750 /* If bracket is ']' or '>', bracket - 2 is the corresponding
751 opening bracket. */
752 ptr = index (src, bracket - 2);
753 if (ptr == 0)
754 { /* no opening bracket */
755 strcpy (dst, src);
756 return 0;
758 if (!(rptr = rindex (src, '.')))
759 rptr = ptr;
760 slen = rptr - src;
761 strncpy (dst, src, slen);
762 dst[slen] = '\0';
763 if (*rptr == '.')
765 dst[slen++] = bracket;
766 dst[slen] = '\0';
768 else
770 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
771 then translate the device and recurse. */
772 if (dst[slen - 1] == ':'
773 && dst[slen - 2] != ':' /* skip decnet nodes */
774 && strcmp (src + slen, "[000000]") == 0)
776 dst[slen - 1] = '\0';
777 if ((ptr = egetenv (dst))
778 && (rlen = strlen (ptr) - 1) > 0
779 && (ptr[rlen] == ']' || ptr[rlen] == '>')
780 && ptr[rlen - 1] == '.')
782 char * buf = (char *) alloca (strlen (ptr) + 1);
783 strcpy (buf, ptr);
784 buf[rlen - 1] = ']';
785 buf[rlen] = '\0';
786 return directory_file_name (buf, dst);
788 else
789 dst[slen - 1] = ':';
791 strcat (dst, "[000000]");
792 slen += 8;
794 rptr++;
795 rlen = strlen (rptr) - 1;
796 strncat (dst, rptr, rlen);
797 dst[slen + rlen] = '\0';
798 strcat (dst, ".DIR.1");
799 return 1;
801 #endif /* VMS */
802 /* Process as Unix format: just remove any final slash.
803 But leave "/" unchanged; do not change it to "". */
804 strcpy (dst, src);
805 if (slen > 1
806 && IS_DIRECTORY_SEP (dst[slen - 1])
807 #ifdef DOS_NT
808 && !IS_ANY_SEP (dst[slen - 2])
809 #endif
811 dst[slen - 1] = 0;
812 #ifdef DOS_NT
813 CORRECT_DIR_SEPS (dst);
814 #endif
815 return 1;
818 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
819 1, 1, 0,
820 doc: /* Returns the file name of the directory named DIRECTORY.
821 This is the name of the file that holds the data for the directory DIRECTORY.
822 This operation exists because a directory is also a file, but its name as
823 a directory is different from its name as a file.
824 In Unix-syntax, this function just removes the final slash.
825 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
826 it returns a file name such as \"[X]Y.DIR.1\". */)
827 (directory)
828 Lisp_Object directory;
830 char *buf;
831 Lisp_Object handler;
833 CHECK_STRING (directory);
835 if (NILP (directory))
836 return Qnil;
838 /* If the file name has special constructs in it,
839 call the corresponding file handler. */
840 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
841 if (!NILP (handler))
842 return call2 (handler, Qdirectory_file_name, directory);
844 #ifdef VMS
845 /* 20 extra chars is insufficient for VMS, since we might perform a
846 logical name translation. an equivalence string can be up to 255
847 chars long, so grab that much extra space... - sss */
848 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
849 #else
850 buf = (char *) alloca (SBYTES (directory) + 20);
851 #endif
852 directory_file_name (SDATA (directory), buf);
853 return make_specified_string (buf, -1, strlen (buf),
854 STRING_MULTIBYTE (directory));
857 static char make_temp_name_tbl[64] =
859 'A','B','C','D','E','F','G','H',
860 'I','J','K','L','M','N','O','P',
861 'Q','R','S','T','U','V','W','X',
862 'Y','Z','a','b','c','d','e','f',
863 'g','h','i','j','k','l','m','n',
864 'o','p','q','r','s','t','u','v',
865 'w','x','y','z','0','1','2','3',
866 '4','5','6','7','8','9','-','_'
869 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
871 /* Value is a temporary file name starting with PREFIX, a string.
873 The Emacs process number forms part of the result, so there is
874 no danger of generating a name being used by another process.
875 In addition, this function makes an attempt to choose a name
876 which has no existing file. To make this work, PREFIX should be
877 an absolute file name.
879 BASE64_P non-zero means add the pid as 3 characters in base64
880 encoding. In this case, 6 characters will be added to PREFIX to
881 form the file name. Otherwise, if Emacs is running on a system
882 with long file names, add the pid as a decimal number.
884 This function signals an error if no unique file name could be
885 generated. */
887 Lisp_Object
888 make_temp_name (prefix, base64_p)
889 Lisp_Object prefix;
890 int base64_p;
892 Lisp_Object val;
893 int len, clen;
894 int pid;
895 unsigned char *p, *data;
896 char pidbuf[20];
897 int pidlen;
899 CHECK_STRING (prefix);
901 /* VAL is created by adding 6 characters to PREFIX. The first
902 three are the PID of this process, in base 64, and the second
903 three are incremented if the file already exists. This ensures
904 262144 unique file names per PID per PREFIX. */
906 pid = (int) getpid ();
908 if (base64_p)
910 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
911 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
912 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
913 pidlen = 3;
915 else
917 #ifdef HAVE_LONG_FILE_NAMES
918 sprintf (pidbuf, "%d", pid);
919 pidlen = strlen (pidbuf);
920 #else
921 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
922 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
923 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
924 pidlen = 3;
925 #endif
928 len = SBYTES (prefix); clen = SCHARS (prefix);
929 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
930 if (!STRING_MULTIBYTE (prefix))
931 STRING_SET_UNIBYTE (val);
932 data = SDATA (val);
933 bcopy(SDATA (prefix), data, len);
934 p = data + len;
936 bcopy (pidbuf, p, pidlen);
937 p += pidlen;
939 /* Here we try to minimize useless stat'ing when this function is
940 invoked many times successively with the same PREFIX. We achieve
941 this by initializing count to a random value, and incrementing it
942 afterwards.
944 We don't want make-temp-name to be called while dumping,
945 because then make_temp_name_count_initialized_p would get set
946 and then make_temp_name_count would not be set when Emacs starts. */
948 if (!make_temp_name_count_initialized_p)
950 make_temp_name_count = (unsigned) time (NULL);
951 make_temp_name_count_initialized_p = 1;
954 while (1)
956 struct stat ignored;
957 unsigned num = make_temp_name_count;
959 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
960 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
961 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
963 /* Poor man's congruential RN generator. Replace with
964 ++make_temp_name_count for debugging. */
965 make_temp_name_count += 25229;
966 make_temp_name_count %= 225307;
968 if (stat (data, &ignored) < 0)
970 /* We want to return only if errno is ENOENT. */
971 if (errno == ENOENT)
972 return val;
973 else
974 /* The error here is dubious, but there is little else we
975 can do. The alternatives are to return nil, which is
976 as bad as (and in many cases worse than) throwing the
977 error, or to ignore the error, which will likely result
978 in looping through 225307 stat's, which is not only
979 dog-slow, but also useless since it will fallback to
980 the errow below, anyway. */
981 report_file_error ("Cannot create temporary name for prefix",
982 Fcons (prefix, Qnil));
983 /* not reached */
987 error ("Cannot create temporary name for prefix `%s'",
988 SDATA (prefix));
989 return Qnil;
993 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
994 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
995 The Emacs process number forms part of the result,
996 so there is no danger of generating a name being used by another process.
998 In addition, this function makes an attempt to choose a name
999 which has no existing file. To make this work,
1000 PREFIX should be an absolute file name.
1002 There is a race condition between calling `make-temp-name' and creating the
1003 file which opens all kinds of security holes. For that reason, you should
1004 probably use `make-temp-file' instead, except in three circumstances:
1006 * If you are creating the file in the user's home directory.
1007 * If you are creating a directory rather than an ordinary file.
1008 * If you are taking special precautions as `make-temp-file' does. */)
1009 (prefix)
1010 Lisp_Object prefix;
1012 return make_temp_name (prefix, 0);
1017 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1018 doc: /* Convert filename NAME to absolute, and canonicalize it.
1019 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1020 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
1021 the current buffer's value of `default-directory' is used.
1022 File name components that are `.' are removed, and
1023 so are file name components followed by `..', along with the `..' itself;
1024 note that these simplifications are done without checking the resulting
1025 file names in the file system.
1026 An initial `~/' expands to your home directory.
1027 An initial `~USER/' expands to USER's home directory.
1028 See also the function `substitute-in-file-name'. */)
1029 (name, default_directory)
1030 Lisp_Object name, default_directory;
1032 /* These point to SDATA and need to be careful with string-relocation
1033 during GC (via DECODE_FILE). */
1034 unsigned char *nm, *newdir;
1035 int nm_in_name;
1036 /* This should only point to alloca'd data. */
1037 unsigned char *target;
1039 int tlen;
1040 struct passwd *pw;
1041 #ifdef VMS
1042 unsigned char * colon = 0;
1043 unsigned char * close = 0;
1044 unsigned char * slash = 0;
1045 unsigned char * brack = 0;
1046 int lbrack = 0, rbrack = 0;
1047 int dots = 0;
1048 #endif /* VMS */
1049 #ifdef DOS_NT
1050 int drive = 0;
1051 int collapse_newdir = 1;
1052 int is_escaped = 0;
1053 #endif /* DOS_NT */
1054 int length;
1055 Lisp_Object handler, result;
1056 int multibyte;
1057 Lisp_Object hdir;
1059 CHECK_STRING (name);
1061 /* If the file name has special constructs in it,
1062 call the corresponding file handler. */
1063 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1064 if (!NILP (handler))
1065 return call3 (handler, Qexpand_file_name, name, default_directory);
1067 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1068 if (NILP (default_directory))
1069 default_directory = current_buffer->directory;
1070 if (! STRINGP (default_directory))
1072 #ifdef DOS_NT
1073 /* "/" is not considered a root directory on DOS_NT, so using "/"
1074 here causes an infinite recursion in, e.g., the following:
1076 (let (default-directory)
1077 (expand-file-name "a"))
1079 To avoid this, we set default_directory to the root of the
1080 current drive. */
1081 extern char *emacs_root_dir (void);
1083 default_directory = build_string (emacs_root_dir ());
1084 #else
1085 default_directory = build_string ("/");
1086 #endif
1089 if (!NILP (default_directory))
1091 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1092 if (!NILP (handler))
1093 return call3 (handler, Qexpand_file_name, name, default_directory);
1097 unsigned char *o = SDATA (default_directory);
1099 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1100 It would be better to do this down below where we actually use
1101 default_directory. Unfortunately, calling Fexpand_file_name recursively
1102 could invoke GC, and the strings might be relocated. This would
1103 be annoying because we have pointers into strings lying around
1104 that would need adjusting, and people would add new pointers to
1105 the code and forget to adjust them, resulting in intermittent bugs.
1106 Putting this call here avoids all that crud.
1108 The EQ test avoids infinite recursion. */
1109 if (! NILP (default_directory) && !EQ (default_directory, name)
1110 /* Save time in some common cases - as long as default_directory
1111 is not relative, it can be canonicalized with name below (if it
1112 is needed at all) without requiring it to be expanded now. */
1113 #ifdef DOS_NT
1114 /* Detect MSDOS file names with drive specifiers. */
1115 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
1116 && IS_DIRECTORY_SEP (o[2]))
1117 #ifdef WINDOWSNT
1118 /* Detect Windows file names in UNC format. */
1119 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1120 #endif
1121 #else /* not DOS_NT */
1122 /* Detect Unix absolute file names (/... alone is not absolute on
1123 DOS or Windows). */
1124 && ! (IS_DIRECTORY_SEP (o[0]))
1125 #endif /* not DOS_NT */
1128 struct gcpro gcpro1;
1130 GCPRO1 (name);
1131 default_directory = Fexpand_file_name (default_directory, Qnil);
1132 UNGCPRO;
1135 name = FILE_SYSTEM_CASE (name);
1136 multibyte = STRING_MULTIBYTE (name);
1137 if (multibyte != STRING_MULTIBYTE (default_directory))
1139 if (multibyte)
1140 default_directory = string_to_multibyte (default_directory);
1141 else
1143 name = string_to_multibyte (name);
1144 multibyte = 1;
1148 nm = SDATA (name);
1149 nm_in_name = 1;
1151 #ifdef DOS_NT
1152 /* We will force directory separators to be either all \ or /, so make
1153 a local copy to modify, even if there ends up being no change. */
1154 nm = strcpy (alloca (strlen (nm) + 1), nm);
1155 nm_in_name = 0;
1157 /* Note if special escape prefix is present, but remove for now. */
1158 if (nm[0] == '/' && nm[1] == ':')
1160 is_escaped = 1;
1161 nm += 2;
1164 /* Find and remove drive specifier if present; this makes nm absolute
1165 even if the rest of the name appears to be relative. Only look for
1166 drive specifier at the beginning. */
1167 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1169 drive = nm[0];
1170 nm += 2;
1173 #ifdef WINDOWSNT
1174 /* If we see "c://somedir", we want to strip the first slash after the
1175 colon when stripping the drive letter. Otherwise, this expands to
1176 "//somedir". */
1177 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1178 nm++;
1180 /* Discard any previous drive specifier if nm is now in UNC format. */
1181 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1183 drive = 0;
1185 #endif /* WINDOWSNT */
1186 #endif /* DOS_NT */
1188 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1189 none are found, we can probably return right away. We will avoid
1190 allocating a new string if name is already fully expanded. */
1191 if (
1192 IS_DIRECTORY_SEP (nm[0])
1193 #ifdef MSDOS
1194 && drive && !is_escaped
1195 #endif
1196 #ifdef WINDOWSNT
1197 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1198 #endif
1199 #ifdef VMS
1200 || index (nm, ':')
1201 #endif /* VMS */
1204 /* If it turns out that the filename we want to return is just a
1205 suffix of FILENAME, we don't need to go through and edit
1206 things; we just need to construct a new string using data
1207 starting at the middle of FILENAME. If we set lose to a
1208 non-zero value, that means we've discovered that we can't do
1209 that cool trick. */
1210 int lose = 0;
1211 unsigned char *p = nm;
1213 while (*p)
1215 /* Since we know the name is absolute, we can assume that each
1216 element starts with a "/". */
1218 /* "." and ".." are hairy. */
1219 if (IS_DIRECTORY_SEP (p[0])
1220 && p[1] == '.'
1221 && (IS_DIRECTORY_SEP (p[2])
1222 || p[2] == 0
1223 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1224 || p[3] == 0))))
1225 lose = 1;
1226 /* We want to replace multiple `/' in a row with a single
1227 slash. */
1228 else if (p > nm
1229 && IS_DIRECTORY_SEP (p[0])
1230 && IS_DIRECTORY_SEP (p[1]))
1231 lose = 1;
1233 #ifdef VMS
1234 if (p[0] == '\\')
1235 lose = 1;
1236 if (p[0] == '/') {
1237 /* if dev:[dir]/, move nm to / */
1238 if (!slash && p > nm && (brack || colon)) {
1239 nm = (brack ? brack + 1 : colon + 1);
1240 lbrack = rbrack = 0;
1241 brack = 0;
1242 colon = 0;
1244 slash = p;
1246 if (p[0] == '-')
1247 #ifdef NO_HYPHENS_IN_FILENAMES
1248 if (lbrack == rbrack)
1250 /* Avoid clobbering negative version numbers. */
1251 if (dots < 2)
1252 p[0] = '_';
1254 else
1255 #endif /* NO_HYPHENS_IN_FILENAMES */
1256 if (lbrack > rbrack
1257 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1258 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1259 lose = 1;
1260 #ifdef NO_HYPHENS_IN_FILENAMES
1261 else
1262 p[0] = '_';
1263 #endif /* NO_HYPHENS_IN_FILENAMES */
1264 /* count open brackets, reset close bracket pointer */
1265 if (p[0] == '[' || p[0] == '<')
1266 lbrack++, brack = 0;
1267 /* count close brackets, set close bracket pointer */
1268 if (p[0] == ']' || p[0] == '>')
1269 rbrack++, brack = p;
1270 /* detect ][ or >< */
1271 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1272 lose = 1;
1273 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1274 nm = p + 1, lose = 1;
1275 if (p[0] == ':' && (colon || slash))
1276 /* if dev1:[dir]dev2:, move nm to dev2: */
1277 if (brack)
1279 nm = brack + 1;
1280 brack = 0;
1282 /* if /name/dev:, move nm to dev: */
1283 else if (slash)
1284 nm = slash + 1;
1285 /* if node::dev:, move colon following dev */
1286 else if (colon && colon[-1] == ':')
1287 colon = p;
1288 /* if dev1:dev2:, move nm to dev2: */
1289 else if (colon && colon[-1] != ':')
1291 nm = colon + 1;
1292 colon = 0;
1294 if (p[0] == ':' && !colon)
1296 if (p[1] == ':')
1297 p++;
1298 colon = p;
1300 if (lbrack == rbrack)
1301 if (p[0] == ';')
1302 dots = 2;
1303 else if (p[0] == '.')
1304 dots++;
1305 #endif /* VMS */
1306 p++;
1308 if (!lose)
1310 #ifdef VMS
1311 if (index (nm, '/'))
1313 nm = sys_translate_unix (nm);
1314 nm_in_name = 0;
1315 return make_specified_string (nm, -1, strlen (nm), multibyte);
1317 #endif /* VMS */
1318 #ifdef DOS_NT
1319 /* Make sure directories are all separated with / or \ as
1320 desired, but avoid allocation of a new string when not
1321 required. */
1322 CORRECT_DIR_SEPS (nm);
1323 #ifdef WINDOWSNT
1324 if (IS_DIRECTORY_SEP (nm[1]))
1326 if (strcmp (nm, SDATA (name)) != 0)
1327 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1329 else
1330 #endif
1331 /* drive must be set, so this is okay */
1332 if (strcmp (nm - 2, SDATA (name)) != 0)
1334 char temp[] = " :";
1336 name = make_specified_string (nm, -1, p - nm, multibyte);
1337 temp[0] = DRIVE_LETTER (drive);
1338 name = concat2 (build_string (temp), name);
1340 return name;
1341 #else /* not DOS_NT */
1342 if (nm == SDATA (name))
1343 return name;
1344 return make_specified_string (nm, -1, strlen (nm), multibyte);
1345 #endif /* not DOS_NT */
1349 /* At this point, nm might or might not be an absolute file name. We
1350 need to expand ~ or ~user if present, otherwise prefix nm with
1351 default_directory if nm is not absolute, and finally collapse /./
1352 and /foo/../ sequences.
1354 We set newdir to be the appropriate prefix if one is needed:
1355 - the relevant user directory if nm starts with ~ or ~user
1356 - the specified drive's working dir (DOS/NT only) if nm does not
1357 start with /
1358 - the value of default_directory.
1360 Note that these prefixes are not guaranteed to be absolute (except
1361 for the working dir of a drive). Therefore, to ensure we always
1362 return an absolute name, if the final prefix is not absolute we
1363 append it to the current working directory. */
1365 newdir = 0;
1367 if (nm[0] == '~') /* prefix ~ */
1369 if (IS_DIRECTORY_SEP (nm[1])
1370 #ifdef VMS
1371 || nm[1] == ':'
1372 #endif /* VMS */
1373 || nm[1] == 0) /* ~ by itself */
1375 Lisp_Object tem;
1377 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1378 newdir = (unsigned char *) "";
1379 nm++;
1380 /* egetenv may return a unibyte string, which will bite us since
1381 we expect the directory to be multibyte. */
1382 tem = build_string (newdir);
1383 if (!STRING_MULTIBYTE (tem))
1385 /* FIXME: DECODE_FILE may GC, which may move SDATA(name),
1386 after which `nm' won't point to the right place any more. */
1387 int offset = nm - SDATA (name);
1388 hdir = DECODE_FILE (tem);
1389 newdir = SDATA (hdir);
1390 if (nm_in_name)
1391 nm = SDATA (name) + offset;
1393 #ifdef DOS_NT
1394 collapse_newdir = 0;
1395 #endif
1396 #ifdef VMS
1397 nm++; /* Don't leave the slash in nm. */
1398 #endif /* VMS */
1400 else /* ~user/filename */
1402 unsigned char *o, *p;
1403 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1404 #ifdef VMS
1405 && *p != ':'
1406 #endif /* VMS */
1407 ); p++);
1408 o = alloca (p - nm + 1);
1409 bcopy ((char *) nm, o, p - nm);
1410 o [p - nm] = 0;
1412 BLOCK_INPUT;
1413 pw = (struct passwd *) getpwnam (o + 1);
1414 UNBLOCK_INPUT;
1415 if (pw)
1417 newdir = (unsigned char *) pw -> pw_dir;
1418 #ifdef VMS
1419 nm = p + 1; /* skip the terminator */
1420 #else
1421 nm = p;
1422 #ifdef DOS_NT
1423 collapse_newdir = 0;
1424 #endif
1425 #endif /* VMS */
1428 /* If we don't find a user of that name, leave the name
1429 unchanged; don't move nm forward to p. */
1433 #ifdef DOS_NT
1434 /* On DOS and Windows, nm is absolute if a drive name was specified;
1435 use the drive's current directory as the prefix if needed. */
1436 if (!newdir && drive)
1438 /* Get default directory if needed to make nm absolute. */
1439 if (!IS_DIRECTORY_SEP (nm[0]))
1441 newdir = alloca (MAXPATHLEN + 1);
1442 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1443 newdir = NULL;
1445 if (!newdir)
1447 /* Either nm starts with /, or drive isn't mounted. */
1448 newdir = alloca (4);
1449 newdir[0] = DRIVE_LETTER (drive);
1450 newdir[1] = ':';
1451 newdir[2] = '/';
1452 newdir[3] = 0;
1455 #endif /* DOS_NT */
1457 /* Finally, if no prefix has been specified and nm is not absolute,
1458 then it must be expanded relative to default_directory. */
1460 if (1
1461 #ifndef DOS_NT
1462 /* /... alone is not absolute on DOS and Windows. */
1463 && !IS_DIRECTORY_SEP (nm[0])
1464 #endif
1465 #ifdef WINDOWSNT
1466 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1467 #endif
1468 #ifdef VMS
1469 && !index (nm, ':')
1470 #endif
1471 && !newdir)
1473 newdir = SDATA (default_directory);
1474 #ifdef DOS_NT
1475 /* Note if special escape prefix is present, but remove for now. */
1476 if (newdir[0] == '/' && newdir[1] == ':')
1478 is_escaped = 1;
1479 newdir += 2;
1481 #endif
1484 #ifdef DOS_NT
1485 if (newdir)
1487 /* First ensure newdir is an absolute name. */
1488 if (
1489 /* Detect MSDOS file names with drive specifiers. */
1490 ! (IS_DRIVE (newdir[0])
1491 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1492 #ifdef WINDOWSNT
1493 /* Detect Windows file names in UNC format. */
1494 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1495 #endif
1498 /* Effectively, let newdir be (expand-file-name newdir cwd).
1499 Because of the admonition against calling expand-file-name
1500 when we have pointers into lisp strings, we accomplish this
1501 indirectly by prepending newdir to nm if necessary, and using
1502 cwd (or the wd of newdir's drive) as the new newdir. */
1504 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1506 drive = newdir[0];
1507 newdir += 2;
1509 if (!IS_DIRECTORY_SEP (nm[0]))
1511 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1512 file_name_as_directory (tmp, newdir);
1513 strcat (tmp, nm);
1514 nm = tmp;
1516 newdir = alloca (MAXPATHLEN + 1);
1517 if (drive)
1519 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1520 newdir = "/";
1522 else
1523 getwd (newdir);
1526 /* Strip off drive name from prefix, if present. */
1527 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1529 drive = newdir[0];
1530 newdir += 2;
1533 /* Keep only a prefix from newdir if nm starts with slash
1534 (//server/share for UNC, nothing otherwise). */
1535 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1537 #ifdef WINDOWSNT
1538 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1540 unsigned char *p;
1541 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1542 p = newdir + 2;
1543 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1544 p++;
1545 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1546 *p = 0;
1548 else
1549 #endif
1550 newdir = "";
1553 #endif /* DOS_NT */
1555 if (newdir)
1557 /* Get rid of any slash at the end of newdir, unless newdir is
1558 just / or // (an incomplete UNC name). */
1559 length = strlen (newdir);
1560 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1561 #ifdef WINDOWSNT
1562 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1563 #endif
1566 unsigned char *temp = (unsigned char *) alloca (length);
1567 bcopy (newdir, temp, length - 1);
1568 temp[length - 1] = 0;
1569 newdir = temp;
1571 tlen = length + 1;
1573 else
1574 tlen = 0;
1576 /* Now concatenate the directory and name to new space in the stack frame */
1577 tlen += strlen (nm) + 1;
1578 #ifdef DOS_NT
1579 /* Reserve space for drive specifier and escape prefix, since either
1580 or both may need to be inserted. (The Microsoft x86 compiler
1581 produces incorrect code if the following two lines are combined.) */
1582 target = (unsigned char *) alloca (tlen + 4);
1583 target += 4;
1584 #else /* not DOS_NT */
1585 target = (unsigned char *) alloca (tlen);
1586 #endif /* not DOS_NT */
1587 *target = 0;
1589 if (newdir)
1591 #ifndef VMS
1592 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1594 #ifdef DOS_NT
1595 /* If newdir is effectively "C:/", then the drive letter will have
1596 been stripped and newdir will be "/". Concatenating with an
1597 absolute directory in nm produces "//", which will then be
1598 incorrectly treated as a network share. Ignore newdir in
1599 this case (keeping the drive letter). */
1600 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1601 && newdir[1] == '\0'))
1602 #endif
1603 strcpy (target, newdir);
1605 else
1606 #endif
1607 file_name_as_directory (target, newdir);
1610 strcat (target, nm);
1611 #ifdef VMS
1612 if (index (target, '/'))
1613 strcpy (target, sys_translate_unix (target));
1614 #endif /* VMS */
1616 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1618 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1619 appear. */
1622 unsigned char *p = target;
1623 unsigned char *o = target;
1625 while (*p)
1627 #ifdef VMS
1628 if (*p != ']' && *p != '>' && *p != '-')
1630 if (*p == '\\')
1631 p++;
1632 *o++ = *p++;
1634 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1635 /* brackets are offset from each other by 2 */
1637 p += 2;
1638 if (*p != '.' && *p != '-' && o[-1] != '.')
1639 /* convert [foo][bar] to [bar] */
1640 while (o[-1] != '[' && o[-1] != '<')
1641 o--;
1642 else if (*p == '-' && *o != '.')
1643 *--p = '.';
1645 else if (p[0] == '-' && o[-1] == '.'
1646 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1647 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1650 o--;
1651 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1652 if (p[1] == '.') /* foo.-.bar ==> bar. */
1653 p += 2;
1654 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1655 p++, o--;
1656 /* else [foo.-] ==> [-] */
1658 else
1660 #ifdef NO_HYPHENS_IN_FILENAMES
1661 if (*p == '-'
1662 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
1663 && p[1] != ']' && p[1] != '>' && p[1] != '.')
1664 *p = '_';
1665 #endif /* NO_HYPHENS_IN_FILENAMES */
1666 *o++ = *p++;
1668 #else /* not VMS */
1669 if (!IS_DIRECTORY_SEP (*p))
1671 *o++ = *p++;
1673 else if (p[1] == '.'
1674 && (IS_DIRECTORY_SEP (p[2])
1675 || p[2] == 0))
1677 /* If "/." is the entire filename, keep the "/". Otherwise,
1678 just delete the whole "/.". */
1679 if (o == target && p[2] == '\0')
1680 *o++ = *p;
1681 p += 2;
1683 else if (p[1] == '.' && p[2] == '.'
1684 /* `/../' is the "superroot" on certain file systems.
1685 Turned off on DOS_NT systems because they have no
1686 "superroot" and because this causes us to produce
1687 file names like "d:/../foo" which fail file-related
1688 functions of the underlying OS. (To reproduce, try a
1689 long series of "../../" in default_directory, longer
1690 than the number of levels from the root.) */
1691 #ifndef DOS_NT
1692 && o != target
1693 #endif
1694 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1696 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1698 /* Keep initial / only if this is the whole name. */
1699 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1700 ++o;
1701 p += 3;
1703 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1704 /* Collapse multiple `/' in a row. */
1705 p++;
1706 else
1708 *o++ = *p++;
1710 #endif /* not VMS */
1713 #ifdef DOS_NT
1714 /* At last, set drive name. */
1715 #ifdef WINDOWSNT
1716 /* Except for network file name. */
1717 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1718 #endif /* WINDOWSNT */
1720 if (!drive) abort ();
1721 target -= 2;
1722 target[0] = DRIVE_LETTER (drive);
1723 target[1] = ':';
1725 /* Reinsert the escape prefix if required. */
1726 if (is_escaped)
1728 target -= 2;
1729 target[0] = '/';
1730 target[1] = ':';
1732 CORRECT_DIR_SEPS (target);
1733 #endif /* DOS_NT */
1735 result = make_specified_string (target, -1, o - target, multibyte);
1738 /* Again look to see if the file name has special constructs in it
1739 and perhaps call the corresponding file handler. This is needed
1740 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1741 the ".." component gives us "/user@host:/bar/../baz" which needs
1742 to be expanded again. */
1743 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1744 if (!NILP (handler))
1745 return call3 (handler, Qexpand_file_name, result, default_directory);
1747 return result;
1750 #if 0
1751 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1752 This is the old version of expand-file-name, before it was thoroughly
1753 rewritten for Emacs 10.31. We leave this version here commented-out,
1754 because the code is very complex and likely to have subtle bugs. If
1755 bugs _are_ found, it might be of interest to look at the old code and
1756 see what did it do in the relevant situation.
1758 Don't remove this code: it's true that it will be accessible via CVS,
1759 but a few years from deletion, people will forget it is there. */
1761 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1762 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1763 "Convert FILENAME to absolute, and canonicalize it.\n\
1764 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1765 \(does not start with slash); if DEFAULT is nil or missing,\n\
1766 the current buffer's value of default-directory is used.\n\
1767 Filenames containing `.' or `..' as components are simplified;\n\
1768 initial `~/' expands to your home directory.\n\
1769 See also the function `substitute-in-file-name'.")
1770 (name, defalt)
1771 Lisp_Object name, defalt;
1773 unsigned char *nm;
1775 register unsigned char *newdir, *p, *o;
1776 int tlen;
1777 unsigned char *target;
1778 struct passwd *pw;
1779 int lose;
1780 #ifdef VMS
1781 unsigned char * colon = 0;
1782 unsigned char * close = 0;
1783 unsigned char * slash = 0;
1784 unsigned char * brack = 0;
1785 int lbrack = 0, rbrack = 0;
1786 int dots = 0;
1787 #endif /* VMS */
1789 CHECK_STRING (name);
1791 #ifdef VMS
1792 /* Filenames on VMS are always upper case. */
1793 name = Fupcase (name);
1794 #endif
1796 nm = SDATA (name);
1798 /* If nm is absolute, flush ...// and detect /./ and /../.
1799 If no /./ or /../ we can return right away. */
1800 if (
1801 nm[0] == '/'
1802 #ifdef VMS
1803 || index (nm, ':')
1804 #endif /* VMS */
1807 p = nm;
1808 lose = 0;
1809 while (*p)
1811 if (p[0] == '/' && p[1] == '/'
1813 nm = p + 1;
1814 if (p[0] == '/' && p[1] == '~')
1815 nm = p + 1, lose = 1;
1816 if (p[0] == '/' && p[1] == '.'
1817 && (p[2] == '/' || p[2] == 0
1818 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1819 lose = 1;
1820 #ifdef VMS
1821 if (p[0] == '\\')
1822 lose = 1;
1823 if (p[0] == '/') {
1824 /* if dev:[dir]/, move nm to / */
1825 if (!slash && p > nm && (brack || colon)) {
1826 nm = (brack ? brack + 1 : colon + 1);
1827 lbrack = rbrack = 0;
1828 brack = 0;
1829 colon = 0;
1831 slash = p;
1833 if (p[0] == '-')
1834 #ifndef VMS4_4
1835 /* VMS pre V4.4,convert '-'s in filenames. */
1836 if (lbrack == rbrack)
1838 if (dots < 2) /* this is to allow negative version numbers */
1839 p[0] = '_';
1841 else
1842 #endif /* VMS4_4 */
1843 if (lbrack > rbrack
1844 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1845 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1846 lose = 1;
1847 #ifndef VMS4_4
1848 else
1849 p[0] = '_';
1850 #endif /* VMS4_4 */
1851 /* count open brackets, reset close bracket pointer */
1852 if (p[0] == '[' || p[0] == '<')
1853 lbrack++, brack = 0;
1854 /* count close brackets, set close bracket pointer */
1855 if (p[0] == ']' || p[0] == '>')
1856 rbrack++, brack = p;
1857 /* detect ][ or >< */
1858 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1859 lose = 1;
1860 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1861 nm = p + 1, lose = 1;
1862 if (p[0] == ':' && (colon || slash))
1863 /* if dev1:[dir]dev2:, move nm to dev2: */
1864 if (brack)
1866 nm = brack + 1;
1867 brack = 0;
1869 /* If /name/dev:, move nm to dev: */
1870 else if (slash)
1871 nm = slash + 1;
1872 /* If node::dev:, move colon following dev */
1873 else if (colon && colon[-1] == ':')
1874 colon = p;
1875 /* If dev1:dev2:, move nm to dev2: */
1876 else if (colon && colon[-1] != ':')
1878 nm = colon + 1;
1879 colon = 0;
1881 if (p[0] == ':' && !colon)
1883 if (p[1] == ':')
1884 p++;
1885 colon = p;
1887 if (lbrack == rbrack)
1888 if (p[0] == ';')
1889 dots = 2;
1890 else if (p[0] == '.')
1891 dots++;
1892 #endif /* VMS */
1893 p++;
1895 if (!lose)
1897 #ifdef VMS
1898 if (index (nm, '/'))
1899 return build_string (sys_translate_unix (nm));
1900 #endif /* VMS */
1901 if (nm == SDATA (name))
1902 return name;
1903 return build_string (nm);
1907 /* Now determine directory to start with and put it in NEWDIR */
1909 newdir = 0;
1911 if (nm[0] == '~') /* prefix ~ */
1912 if (nm[1] == '/'
1913 #ifdef VMS
1914 || nm[1] == ':'
1915 #endif /* VMS */
1916 || nm[1] == 0)/* ~/filename */
1918 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1919 newdir = (unsigned char *) "";
1920 nm++;
1921 #ifdef VMS
1922 nm++; /* Don't leave the slash in nm. */
1923 #endif /* VMS */
1925 else /* ~user/filename */
1927 /* Get past ~ to user */
1928 unsigned char *user = nm + 1;
1929 /* Find end of name. */
1930 unsigned char *ptr = (unsigned char *) index (user, '/');
1931 int len = ptr ? ptr - user : strlen (user);
1932 #ifdef VMS
1933 unsigned char *ptr1 = index (user, ':');
1934 if (ptr1 != 0 && ptr1 - user < len)
1935 len = ptr1 - user;
1936 #endif /* VMS */
1937 /* Copy the user name into temp storage. */
1938 o = (unsigned char *) alloca (len + 1);
1939 bcopy ((char *) user, o, len);
1940 o[len] = 0;
1942 /* Look up the user name. */
1943 BLOCK_INPUT;
1944 pw = (struct passwd *) getpwnam (o + 1);
1945 UNBLOCK_INPUT;
1946 if (!pw)
1947 error ("\"%s\" isn't a registered user", o + 1);
1949 newdir = (unsigned char *) pw->pw_dir;
1951 /* Discard the user name from NM. */
1952 nm += len;
1955 if (nm[0] != '/'
1956 #ifdef VMS
1957 && !index (nm, ':')
1958 #endif /* not VMS */
1959 && !newdir)
1961 if (NILP (defalt))
1962 defalt = current_buffer->directory;
1963 CHECK_STRING (defalt);
1964 newdir = SDATA (defalt);
1967 /* Now concatenate the directory and name to new space in the stack frame */
1969 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1970 target = (unsigned char *) alloca (tlen);
1971 *target = 0;
1973 if (newdir)
1975 #ifndef VMS
1976 if (nm[0] == 0 || nm[0] == '/')
1977 strcpy (target, newdir);
1978 else
1979 #endif
1980 file_name_as_directory (target, newdir);
1983 strcat (target, nm);
1984 #ifdef VMS
1985 if (index (target, '/'))
1986 strcpy (target, sys_translate_unix (target));
1987 #endif /* VMS */
1989 /* Now canonicalize by removing /. and /foo/.. if they appear */
1991 p = target;
1992 o = target;
1994 while (*p)
1996 #ifdef VMS
1997 if (*p != ']' && *p != '>' && *p != '-')
1999 if (*p == '\\')
2000 p++;
2001 *o++ = *p++;
2003 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
2004 /* brackets are offset from each other by 2 */
2006 p += 2;
2007 if (*p != '.' && *p != '-' && o[-1] != '.')
2008 /* convert [foo][bar] to [bar] */
2009 while (o[-1] != '[' && o[-1] != '<')
2010 o--;
2011 else if (*p == '-' && *o != '.')
2012 *--p = '.';
2014 else if (p[0] == '-' && o[-1] == '.'
2015 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
2016 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2019 o--;
2020 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2021 if (p[1] == '.') /* foo.-.bar ==> bar. */
2022 p += 2;
2023 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2024 p++, o--;
2025 /* else [foo.-] ==> [-] */
2027 else
2029 #ifndef VMS4_4
2030 if (*p == '-'
2031 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
2032 && p[1] != ']' && p[1] != '>' && p[1] != '.')
2033 *p = '_';
2034 #endif /* VMS4_4 */
2035 *o++ = *p++;
2037 #else /* not VMS */
2038 if (*p != '/')
2040 *o++ = *p++;
2042 else if (!strncmp (p, "//", 2)
2045 o = target;
2046 p++;
2048 else if (p[0] == '/' && p[1] == '.'
2049 && (p[2] == '/' || p[2] == 0))
2050 p += 2;
2051 else if (!strncmp (p, "/..", 3)
2052 /* `/../' is the "superroot" on certain file systems. */
2053 && o != target
2054 && (p[3] == '/' || p[3] == 0))
2056 while (o != target && *--o != '/')
2058 if (o == target && *o == '/')
2059 ++o;
2060 p += 3;
2062 else
2064 *o++ = *p++;
2066 #endif /* not VMS */
2069 return make_string (target, o - target);
2071 #endif
2073 /* If /~ or // appears, discard everything through first slash. */
2074 static int
2075 file_name_absolute_p (filename)
2076 const unsigned char *filename;
2078 return
2079 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2080 #ifdef VMS
2081 /* ??? This criterion is probably wrong for '<'. */
2082 || index (filename, ':') || index (filename, '<')
2083 || (*filename == '[' && (filename[1] != '-'
2084 || (filename[2] != '.' && filename[2] != ']'))
2085 && filename[1] != '.')
2086 #endif /* VMS */
2087 #ifdef DOS_NT
2088 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2089 && IS_DIRECTORY_SEP (filename[2]))
2090 #endif
2094 static unsigned char *
2095 search_embedded_absfilename (nm, endp)
2096 unsigned char *nm, *endp;
2098 unsigned char *p, *s;
2100 for (p = nm + 1; p < endp; p++)
2102 if ((0
2103 #ifdef VMS
2104 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2105 #endif /* VMS */
2106 || IS_DIRECTORY_SEP (p[-1]))
2107 && file_name_absolute_p (p)
2108 #if defined (WINDOWSNT) || defined(CYGWIN)
2109 /* // at start of file name is meaningful in Apollo,
2110 WindowsNT and Cygwin systems. */
2111 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2112 #endif /* not (WINDOWSNT || CYGWIN) */
2115 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2116 #ifdef VMS
2117 && *s != ':'
2118 #endif /* VMS */
2119 ); s++);
2120 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2122 unsigned char *o = alloca (s - p + 1);
2123 struct passwd *pw;
2124 bcopy (p, o, s - p);
2125 o [s - p] = 0;
2127 /* If we have ~user and `user' exists, discard
2128 everything up to ~. But if `user' does not exist, leave
2129 ~user alone, it might be a literal file name. */
2130 BLOCK_INPUT;
2131 pw = getpwnam (o + 1);
2132 UNBLOCK_INPUT;
2133 if (pw)
2134 return p;
2136 else
2137 return p;
2140 return NULL;
2143 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2144 Ssubstitute_in_file_name, 1, 1, 0,
2145 doc: /* Substitute environment variables referred to in FILENAME.
2146 `$FOO' where FOO is an environment variable name means to substitute
2147 the value of that variable. The variable name should be terminated
2148 with a character not a letter, digit or underscore; otherwise, enclose
2149 the entire variable name in braces.
2150 If `/~' appears, all of FILENAME through that `/' is discarded.
2152 On VMS, `$' substitution is not done; this function does little and only
2153 duplicates what `expand-file-name' does. */)
2154 (filename)
2155 Lisp_Object filename;
2157 unsigned char *nm;
2159 register unsigned char *s, *p, *o, *x, *endp;
2160 unsigned char *target = NULL;
2161 int total = 0;
2162 int substituted = 0;
2163 unsigned char *xnm;
2164 Lisp_Object handler;
2166 CHECK_STRING (filename);
2168 /* If the file name has special constructs in it,
2169 call the corresponding file handler. */
2170 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2171 if (!NILP (handler))
2172 return call2 (handler, Qsubstitute_in_file_name, filename);
2174 nm = SDATA (filename);
2175 #ifdef DOS_NT
2176 nm = strcpy (alloca (strlen (nm) + 1), nm);
2177 CORRECT_DIR_SEPS (nm);
2178 substituted = (strcmp (nm, SDATA (filename)) != 0);
2179 #endif
2180 endp = nm + SBYTES (filename);
2182 /* If /~ or // appears, discard everything through first slash. */
2183 p = search_embedded_absfilename (nm, endp);
2184 if (p)
2185 /* Start over with the new string, so we check the file-name-handler
2186 again. Important with filenames like "/home/foo//:/hello///there"
2187 which whould substitute to "/:/hello///there" rather than "/there". */
2188 return Fsubstitute_in_file_name
2189 (make_specified_string (p, -1, endp - p,
2190 STRING_MULTIBYTE (filename)));
2192 #ifdef VMS
2193 return filename;
2194 #else
2196 /* See if any variables are substituted into the string
2197 and find the total length of their values in `total' */
2199 for (p = nm; p != endp;)
2200 if (*p != '$')
2201 p++;
2202 else
2204 p++;
2205 if (p == endp)
2206 goto badsubst;
2207 else if (*p == '$')
2209 /* "$$" means a single "$" */
2210 p++;
2211 total -= 1;
2212 substituted = 1;
2213 continue;
2215 else if (*p == '{')
2217 o = ++p;
2218 while (p != endp && *p != '}') p++;
2219 if (*p != '}') goto missingclose;
2220 s = p;
2222 else
2224 o = p;
2225 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2226 s = p;
2229 /* Copy out the variable name */
2230 target = (unsigned char *) alloca (s - o + 1);
2231 strncpy (target, o, s - o);
2232 target[s - o] = 0;
2233 #ifdef DOS_NT
2234 strupr (target); /* $home == $HOME etc. */
2235 #endif /* DOS_NT */
2237 /* Get variable value */
2238 o = (unsigned char *) egetenv (target);
2239 if (o)
2240 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
2241 total += strlen (o) * (STRING_MULTIBYTE (filename) ? 2 : 1);
2242 substituted = 1;
2244 else if (*p == '}')
2245 goto badvar;
2248 if (!substituted)
2249 return filename;
2251 /* If substitution required, recopy the string and do it */
2252 /* Make space in stack frame for the new copy */
2253 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2254 x = xnm;
2256 /* Copy the rest of the name through, replacing $ constructs with values */
2257 for (p = nm; *p;)
2258 if (*p != '$')
2259 *x++ = *p++;
2260 else
2262 p++;
2263 if (p == endp)
2264 goto badsubst;
2265 else if (*p == '$')
2267 *x++ = *p++;
2268 continue;
2270 else if (*p == '{')
2272 o = ++p;
2273 while (p != endp && *p != '}') p++;
2274 if (*p != '}') goto missingclose;
2275 s = p++;
2277 else
2279 o = p;
2280 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2281 s = p;
2284 /* Copy out the variable name */
2285 target = (unsigned char *) alloca (s - o + 1);
2286 strncpy (target, o, s - o);
2287 target[s - o] = 0;
2288 #ifdef DOS_NT
2289 strupr (target); /* $home == $HOME etc. */
2290 #endif /* DOS_NT */
2292 /* Get variable value */
2293 o = (unsigned char *) egetenv (target);
2294 if (!o)
2296 *x++ = '$';
2297 strcpy (x, target); x+= strlen (target);
2299 else if (STRING_MULTIBYTE (filename))
2301 /* If the original string is multibyte,
2302 convert what we substitute into multibyte. */
2303 while (*o)
2305 int c = *o++;
2306 c = unibyte_char_to_multibyte (c);
2307 x += CHAR_STRING (c, x);
2310 else
2312 strcpy (x, o);
2313 x += strlen (o);
2317 *x = 0;
2319 /* If /~ or // appears, discard everything through first slash. */
2320 while ((p = search_embedded_absfilename (xnm, x)))
2321 /* This time we do not start over because we've already expanded envvars
2322 and replaced $$ with $. Maybe we should start over as well, but we'd
2323 need to quote some $ to $$ first. */
2324 xnm = p;
2326 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2328 badsubst:
2329 error ("Bad format environment-variable substitution");
2330 missingclose:
2331 error ("Missing \"}\" in environment-variable substitution");
2332 badvar:
2333 error ("Substituting nonexistent environment variable \"%s\"", target);
2335 /* NOTREACHED */
2336 #endif /* not VMS */
2337 return Qnil;
2340 /* A slightly faster and more convenient way to get
2341 (directory-file-name (expand-file-name FOO)). */
2343 Lisp_Object
2344 expand_and_dir_to_file (filename, defdir)
2345 Lisp_Object filename, defdir;
2347 register Lisp_Object absname;
2349 absname = Fexpand_file_name (filename, defdir);
2350 #ifdef VMS
2352 register int c = SREF (absname, SBYTES (absname) - 1);
2353 if (c == ':' || c == ']' || c == '>')
2354 absname = Fdirectory_file_name (absname);
2356 #else
2357 /* Remove final slash, if any (unless this is the root dir).
2358 stat behaves differently depending! */
2359 if (SCHARS (absname) > 1
2360 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2361 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2362 /* We cannot take shortcuts; they might be wrong for magic file names. */
2363 absname = Fdirectory_file_name (absname);
2364 #endif
2365 return absname;
2368 /* Signal an error if the file ABSNAME already exists.
2369 If INTERACTIVE is nonzero, ask the user whether to proceed,
2370 and bypass the error if the user says to go ahead.
2371 QUERYSTRING is a name for the action that is being considered
2372 to alter the file.
2374 *STATPTR is used to store the stat information if the file exists.
2375 If the file does not exist, STATPTR->st_mode is set to 0.
2376 If STATPTR is null, we don't store into it.
2378 If QUICK is nonzero, we ask for y or n, not yes or no. */
2380 void
2381 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2382 Lisp_Object absname;
2383 unsigned char *querystring;
2384 int interactive;
2385 struct stat *statptr;
2386 int quick;
2388 register Lisp_Object tem, encoded_filename;
2389 struct stat statbuf;
2390 struct gcpro gcpro1;
2392 encoded_filename = ENCODE_FILE (absname);
2394 /* stat is a good way to tell whether the file exists,
2395 regardless of what access permissions it has. */
2396 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2398 if (! interactive)
2399 xsignal2 (Qfile_already_exists,
2400 build_string ("File already exists"), absname);
2401 GCPRO1 (absname);
2402 tem = format2 ("File %s already exists; %s anyway? ",
2403 absname, build_string (querystring));
2404 if (quick)
2405 tem = Fy_or_n_p (tem);
2406 else
2407 tem = do_yes_or_no_p (tem);
2408 UNGCPRO;
2409 if (NILP (tem))
2410 xsignal2 (Qfile_already_exists,
2411 build_string ("File already exists"), absname);
2412 if (statptr)
2413 *statptr = statbuf;
2415 else
2417 if (statptr)
2418 statptr->st_mode = 0;
2420 return;
2423 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2424 "fCopy file: \nGCopy %s to file: \np\nP",
2425 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2426 If NEWNAME names a directory, copy FILE there.
2428 This function always sets the file modes of the output file to match
2429 the input file.
2431 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2432 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2433 signal a `file-already-exists' error without overwriting. If
2434 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2435 about overwriting; this is what happens in interactive use with M-x.
2436 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2437 existing file.
2439 Fourth arg KEEP-TIME non-nil means give the output file the same
2440 last-modified time as the old one. (This works on only some systems.)
2442 A prefix arg makes KEEP-TIME non-nil.
2444 If PRESERVE-UID-GID is non-nil, we try to transfer the
2445 uid and gid of FILE to NEWNAME. */)
2446 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2447 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2448 Lisp_Object preserve_uid_gid;
2450 int ifd, ofd, n;
2451 char buf[16 * 1024];
2452 struct stat st, out_st;
2453 Lisp_Object handler;
2454 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2455 int count = SPECPDL_INDEX ();
2456 int input_file_statable_p;
2457 Lisp_Object encoded_file, encoded_newname;
2459 encoded_file = encoded_newname = Qnil;
2460 GCPRO4 (file, newname, encoded_file, encoded_newname);
2461 CHECK_STRING (file);
2462 CHECK_STRING (newname);
2464 if (!NILP (Ffile_directory_p (newname)))
2465 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2466 else
2467 newname = Fexpand_file_name (newname, Qnil);
2469 file = Fexpand_file_name (file, Qnil);
2471 /* If the input file name has special constructs in it,
2472 call the corresponding file handler. */
2473 handler = Ffind_file_name_handler (file, Qcopy_file);
2474 /* Likewise for output file name. */
2475 if (NILP (handler))
2476 handler = Ffind_file_name_handler (newname, Qcopy_file);
2477 if (!NILP (handler))
2478 RETURN_UNGCPRO (call6 (handler, Qcopy_file, file, newname,
2479 ok_if_already_exists, keep_time, preserve_uid_gid));
2481 encoded_file = ENCODE_FILE (file);
2482 encoded_newname = ENCODE_FILE (newname);
2484 if (NILP (ok_if_already_exists)
2485 || INTEGERP (ok_if_already_exists))
2486 barf_or_query_if_file_exists (newname, "copy to it",
2487 INTEGERP (ok_if_already_exists), &out_st, 0);
2488 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2489 out_st.st_mode = 0;
2491 #ifdef WINDOWSNT
2492 if (!CopyFile (SDATA (encoded_file),
2493 SDATA (encoded_newname),
2494 FALSE))
2495 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2496 /* CopyFile retains the timestamp by default. */
2497 else if (NILP (keep_time))
2499 EMACS_TIME now;
2500 DWORD attributes;
2501 char * filename;
2503 EMACS_GET_TIME (now);
2504 filename = SDATA (encoded_newname);
2506 /* Ensure file is writable while its modified time is set. */
2507 attributes = GetFileAttributes (filename);
2508 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2509 if (set_file_times (filename, now, now))
2511 /* Restore original attributes. */
2512 SetFileAttributes (filename, attributes);
2513 xsignal2 (Qfile_date_error,
2514 build_string ("Cannot set file date"), newname);
2516 /* Restore original attributes. */
2517 SetFileAttributes (filename, attributes);
2519 #else /* not WINDOWSNT */
2520 immediate_quit = 1;
2521 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2522 immediate_quit = 0;
2524 if (ifd < 0)
2525 report_file_error ("Opening input file", Fcons (file, Qnil));
2527 record_unwind_protect (close_file_unwind, make_number (ifd));
2529 /* We can only copy regular files and symbolic links. Other files are not
2530 copyable by us. */
2531 input_file_statable_p = (fstat (ifd, &st) >= 0);
2533 #if !defined (MSDOS) || __DJGPP__ > 1
2534 if (out_st.st_mode != 0
2535 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2537 errno = 0;
2538 report_file_error ("Input and output files are the same",
2539 Fcons (file, Fcons (newname, Qnil)));
2541 #endif
2543 #if defined (S_ISREG) && defined (S_ISLNK)
2544 if (input_file_statable_p)
2546 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2548 #if defined (EISDIR)
2549 /* Get a better looking error message. */
2550 errno = EISDIR;
2551 #endif /* EISDIR */
2552 report_file_error ("Non-regular file", Fcons (file, Qnil));
2555 #endif /* S_ISREG && S_ISLNK */
2557 #ifdef VMS
2558 /* Create the copy file with the same record format as the input file */
2559 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2560 #else
2561 #ifdef MSDOS
2562 /* System's default file type was set to binary by _fmode in emacs.c. */
2563 ofd = emacs_open (SDATA (encoded_newname),
2564 O_WRONLY | O_TRUNC | O_CREAT
2565 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2566 S_IREAD | S_IWRITE);
2567 #else /* not MSDOS */
2568 ofd = emacs_open (SDATA (encoded_newname),
2569 O_WRONLY | O_TRUNC | O_CREAT
2570 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2571 0666);
2572 #endif /* not MSDOS */
2573 #endif /* VMS */
2574 if (ofd < 0)
2575 report_file_error ("Opening output file", Fcons (newname, Qnil));
2577 record_unwind_protect (close_file_unwind, make_number (ofd));
2579 immediate_quit = 1;
2580 QUIT;
2581 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2582 if (emacs_write (ofd, buf, n) != n)
2583 report_file_error ("I/O error", Fcons (newname, Qnil));
2584 immediate_quit = 0;
2586 #ifndef MSDOS
2587 /* Preserve the original file modes, and if requested, also its
2588 owner and group. */
2589 if (input_file_statable_p)
2591 if (! NILP (preserve_uid_gid))
2592 fchown (ofd, st.st_uid, st.st_gid);
2593 fchmod (ofd, st.st_mode & 07777);
2595 #endif /* not MSDOS */
2597 /* Closing the output clobbers the file times on some systems. */
2598 if (emacs_close (ofd) < 0)
2599 report_file_error ("I/O error", Fcons (newname, Qnil));
2601 if (input_file_statable_p)
2603 if (!NILP (keep_time))
2605 EMACS_TIME atime, mtime;
2606 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2607 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2608 if (set_file_times (SDATA (encoded_newname),
2609 atime, mtime))
2610 xsignal2 (Qfile_date_error,
2611 build_string ("Cannot set file date"), newname);
2615 emacs_close (ifd);
2617 #if defined (__DJGPP__) && __DJGPP__ > 1
2618 if (input_file_statable_p)
2620 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2621 and if it can't, it tells so. Otherwise, under MSDOS we usually
2622 get only the READ bit, which will make the copied file read-only,
2623 so it's better not to chmod at all. */
2624 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2625 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2627 #endif /* DJGPP version 2 or newer */
2628 #endif /* not WINDOWSNT */
2630 /* Discard the unwind protects. */
2631 specpdl_ptr = specpdl + count;
2633 UNGCPRO;
2634 return Qnil;
2637 DEFUN ("make-directory-internal", Fmake_directory_internal,
2638 Smake_directory_internal, 1, 1, 0,
2639 doc: /* Create a new directory named DIRECTORY. */)
2640 (directory)
2641 Lisp_Object directory;
2643 const unsigned char *dir;
2644 Lisp_Object handler;
2645 Lisp_Object encoded_dir;
2647 CHECK_STRING (directory);
2648 directory = Fexpand_file_name (directory, Qnil);
2650 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2651 if (!NILP (handler))
2652 return call2 (handler, Qmake_directory_internal, directory);
2654 encoded_dir = ENCODE_FILE (directory);
2656 dir = SDATA (encoded_dir);
2658 #ifdef WINDOWSNT
2659 if (mkdir (dir) != 0)
2660 #else
2661 if (mkdir (dir, 0777) != 0)
2662 #endif
2663 report_file_error ("Creating directory", list1 (directory));
2665 return Qnil;
2668 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2669 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2670 (directory)
2671 Lisp_Object directory;
2673 const unsigned char *dir;
2674 Lisp_Object handler;
2675 Lisp_Object encoded_dir;
2677 CHECK_STRING (directory);
2678 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2680 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2681 if (!NILP (handler))
2682 return call2 (handler, Qdelete_directory, directory);
2684 if (delete_by_moving_to_trash)
2685 return call1 (Qmove_file_to_trash, directory);
2687 encoded_dir = ENCODE_FILE (directory);
2689 dir = SDATA (encoded_dir);
2691 if (rmdir (dir) != 0)
2692 report_file_error ("Removing directory", list1 (directory));
2694 return Qnil;
2697 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2698 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2699 If file has multiple names, it continues to exist with the other names. */)
2700 (filename)
2701 Lisp_Object filename;
2703 Lisp_Object handler;
2704 Lisp_Object encoded_file;
2705 struct gcpro gcpro1;
2707 GCPRO1 (filename);
2708 if (!NILP (Ffile_directory_p (filename))
2709 && NILP (Ffile_symlink_p (filename)))
2710 xsignal2 (Qfile_error,
2711 build_string ("Removing old name: is a directory"),
2712 filename);
2713 UNGCPRO;
2714 filename = Fexpand_file_name (filename, Qnil);
2716 handler = Ffind_file_name_handler (filename, Qdelete_file);
2717 if (!NILP (handler))
2718 return call2 (handler, Qdelete_file, filename);
2720 if (delete_by_moving_to_trash)
2721 return call1 (Qmove_file_to_trash, filename);
2723 encoded_file = ENCODE_FILE (filename);
2725 if (0 > unlink (SDATA (encoded_file)))
2726 report_file_error ("Removing old name", list1 (filename));
2727 return Qnil;
2730 static Lisp_Object
2731 internal_delete_file_1 (ignore)
2732 Lisp_Object ignore;
2734 return Qt;
2737 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2740 internal_delete_file (filename)
2741 Lisp_Object filename;
2743 Lisp_Object tem;
2744 tem = internal_condition_case_1 (Fdelete_file, filename,
2745 Qt, internal_delete_file_1);
2746 return NILP (tem);
2749 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2750 "fRename file: \nGRename %s to file: \np",
2751 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2752 If file has names other than FILE, it continues to have those names.
2753 Signals a `file-already-exists' error if a file NEWNAME already exists
2754 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2755 A number as third arg means request confirmation if NEWNAME already exists.
2756 This is what happens in interactive use with M-x. */)
2757 (file, newname, ok_if_already_exists)
2758 Lisp_Object file, newname, ok_if_already_exists;
2760 Lisp_Object handler;
2761 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2762 Lisp_Object encoded_file, encoded_newname, symlink_target;
2764 symlink_target = encoded_file = encoded_newname = Qnil;
2765 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2766 CHECK_STRING (file);
2767 CHECK_STRING (newname);
2768 file = Fexpand_file_name (file, Qnil);
2770 if ((!NILP (Ffile_directory_p (newname)))
2771 #ifdef DOS_NT
2772 /* If the file names are identical but for the case,
2773 don't attempt to move directory to itself. */
2774 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2775 #endif
2777 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2778 else
2779 newname = Fexpand_file_name (newname, Qnil);
2781 /* If the file name has special constructs in it,
2782 call the corresponding file handler. */
2783 handler = Ffind_file_name_handler (file, Qrename_file);
2784 if (NILP (handler))
2785 handler = Ffind_file_name_handler (newname, Qrename_file);
2786 if (!NILP (handler))
2787 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2788 file, newname, ok_if_already_exists));
2790 encoded_file = ENCODE_FILE (file);
2791 encoded_newname = ENCODE_FILE (newname);
2793 #ifdef DOS_NT
2794 /* If the file names are identical but for the case, don't ask for
2795 confirmation: they simply want to change the letter-case of the
2796 file name. */
2797 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2798 #endif
2799 if (NILP (ok_if_already_exists)
2800 || INTEGERP (ok_if_already_exists))
2801 barf_or_query_if_file_exists (newname, "rename to it",
2802 INTEGERP (ok_if_already_exists), 0, 0);
2803 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2805 if (errno == EXDEV)
2807 #ifdef S_IFLNK
2808 symlink_target = Ffile_symlink_p (file);
2809 if (! NILP (symlink_target))
2810 Fmake_symbolic_link (symlink_target, newname,
2811 NILP (ok_if_already_exists) ? Qnil : Qt);
2812 else
2813 #endif
2814 Fcopy_file (file, newname,
2815 /* We have already prompted if it was an integer,
2816 so don't have copy-file prompt again. */
2817 NILP (ok_if_already_exists) ? Qnil : Qt,
2818 Qt, Qt);
2820 Fdelete_file (file);
2822 else
2823 report_file_error ("Renaming", list2 (file, newname));
2825 UNGCPRO;
2826 return Qnil;
2829 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2830 "fAdd name to file: \nGName to add to %s: \np",
2831 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2832 Signals a `file-already-exists' error if a file NEWNAME already exists
2833 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2834 A number as third arg means request confirmation if NEWNAME already exists.
2835 This is what happens in interactive use with M-x. */)
2836 (file, newname, ok_if_already_exists)
2837 Lisp_Object file, newname, ok_if_already_exists;
2839 Lisp_Object handler;
2840 Lisp_Object encoded_file, encoded_newname;
2841 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2843 GCPRO4 (file, newname, encoded_file, encoded_newname);
2844 encoded_file = encoded_newname = Qnil;
2845 CHECK_STRING (file);
2846 CHECK_STRING (newname);
2847 file = Fexpand_file_name (file, Qnil);
2849 if (!NILP (Ffile_directory_p (newname)))
2850 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2851 else
2852 newname = Fexpand_file_name (newname, Qnil);
2854 /* If the file name has special constructs in it,
2855 call the corresponding file handler. */
2856 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2857 if (!NILP (handler))
2858 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2859 newname, ok_if_already_exists));
2861 /* If the new name has special constructs in it,
2862 call the corresponding file handler. */
2863 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2864 if (!NILP (handler))
2865 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2866 newname, ok_if_already_exists));
2868 encoded_file = ENCODE_FILE (file);
2869 encoded_newname = ENCODE_FILE (newname);
2871 if (NILP (ok_if_already_exists)
2872 || INTEGERP (ok_if_already_exists))
2873 barf_or_query_if_file_exists (newname, "make it a new name",
2874 INTEGERP (ok_if_already_exists), 0, 0);
2876 unlink (SDATA (newname));
2877 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2878 report_file_error ("Adding new name", list2 (file, newname));
2880 UNGCPRO;
2881 return Qnil;
2884 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2885 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2886 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2887 Both args must be strings.
2888 Signals a `file-already-exists' error if a file LINKNAME already exists
2889 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2890 A number as third arg means request confirmation if LINKNAME already exists.
2891 This happens for interactive use with M-x. */)
2892 (filename, linkname, ok_if_already_exists)
2893 Lisp_Object filename, linkname, ok_if_already_exists;
2895 Lisp_Object handler;
2896 Lisp_Object encoded_filename, encoded_linkname;
2897 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2899 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2900 encoded_filename = encoded_linkname = Qnil;
2901 CHECK_STRING (filename);
2902 CHECK_STRING (linkname);
2903 /* If the link target has a ~, we must expand it to get
2904 a truly valid file name. Otherwise, do not expand;
2905 we want to permit links to relative file names. */
2906 if (SREF (filename, 0) == '~')
2907 filename = Fexpand_file_name (filename, Qnil);
2909 if (!NILP (Ffile_directory_p (linkname)))
2910 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2911 else
2912 linkname = Fexpand_file_name (linkname, Qnil);
2914 /* If the file name has special constructs in it,
2915 call the corresponding file handler. */
2916 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2917 if (!NILP (handler))
2918 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2919 linkname, ok_if_already_exists));
2921 /* If the new link name has special constructs in it,
2922 call the corresponding file handler. */
2923 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2924 if (!NILP (handler))
2925 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2926 linkname, ok_if_already_exists));
2928 #ifdef S_IFLNK
2929 encoded_filename = ENCODE_FILE (filename);
2930 encoded_linkname = ENCODE_FILE (linkname);
2932 if (NILP (ok_if_already_exists)
2933 || INTEGERP (ok_if_already_exists))
2934 barf_or_query_if_file_exists (linkname, "make it a link",
2935 INTEGERP (ok_if_already_exists), 0, 0);
2936 if (0 > symlink (SDATA (encoded_filename),
2937 SDATA (encoded_linkname)))
2939 /* If we didn't complain already, silently delete existing file. */
2940 if (errno == EEXIST)
2942 unlink (SDATA (encoded_linkname));
2943 if (0 <= symlink (SDATA (encoded_filename),
2944 SDATA (encoded_linkname)))
2946 UNGCPRO;
2947 return Qnil;
2951 report_file_error ("Making symbolic link", list2 (filename, linkname));
2953 UNGCPRO;
2954 return Qnil;
2956 #else
2957 UNGCPRO;
2958 xsignal1 (Qfile_error, build_string ("Symbolic links are not supported"));
2960 #endif /* S_IFLNK */
2963 #ifdef VMS
2965 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2966 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2967 doc: /* Define the job-wide logical name NAME to have the value STRING.
2968 If STRING is nil or a null string, the logical name NAME is deleted. */)
2969 (name, string)
2970 Lisp_Object name;
2971 Lisp_Object string;
2973 CHECK_STRING (name);
2974 if (NILP (string))
2975 delete_logical_name (SDATA (name));
2976 else
2978 CHECK_STRING (string);
2980 if (SCHARS (string) == 0)
2981 delete_logical_name (SDATA (name));
2982 else
2983 define_logical_name (SDATA (name), SDATA (string));
2986 return string;
2988 #endif /* VMS */
2991 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2992 1, 1, 0,
2993 doc: /* Return t if file FILENAME specifies an absolute file name.
2994 On Unix, this is a name starting with a `/' or a `~'. */)
2995 (filename)
2996 Lisp_Object filename;
2998 CHECK_STRING (filename);
2999 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3002 /* Return nonzero if file FILENAME exists and can be executed. */
3004 static int
3005 check_executable (filename)
3006 char *filename;
3008 #ifdef DOS_NT
3009 int len = strlen (filename);
3010 char *suffix;
3011 struct stat st;
3012 if (stat (filename, &st) < 0)
3013 return 0;
3014 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3015 return ((st.st_mode & S_IEXEC) != 0);
3016 #else
3017 return (S_ISREG (st.st_mode)
3018 && len >= 5
3019 && (xstrcasecmp ((suffix = filename + len-4), ".com") == 0
3020 || xstrcasecmp (suffix, ".exe") == 0
3021 || xstrcasecmp (suffix, ".bat") == 0)
3022 || (st.st_mode & S_IFMT) == S_IFDIR);
3023 #endif /* not WINDOWSNT */
3024 #else /* not DOS_NT */
3025 #ifdef HAVE_EUIDACCESS
3026 return (euidaccess (filename, 1) >= 0);
3027 #else
3028 /* Access isn't quite right because it uses the real uid
3029 and we really want to test with the effective uid.
3030 But Unix doesn't give us a right way to do it. */
3031 return (access (filename, 1) >= 0);
3032 #endif
3033 #endif /* not DOS_NT */
3036 /* Return nonzero if file FILENAME exists and can be written. */
3038 static int
3039 check_writable (filename)
3040 char *filename;
3042 #ifdef MSDOS
3043 struct stat st;
3044 if (stat (filename, &st) < 0)
3045 return 0;
3046 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3047 #else /* not MSDOS */
3048 #ifdef HAVE_EUIDACCESS
3049 return (euidaccess (filename, 2) >= 0);
3050 #else
3051 /* Access isn't quite right because it uses the real uid
3052 and we really want to test with the effective uid.
3053 But Unix doesn't give us a right way to do it.
3054 Opening with O_WRONLY could work for an ordinary file,
3055 but would lose for directories. */
3056 return (access (filename, 2) >= 0);
3057 #endif
3058 #endif /* not MSDOS */
3061 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3062 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3063 See also `file-readable-p' and `file-attributes'.
3064 This returns nil for a symlink to a nonexistent file.
3065 Use `file-symlink-p' to test for such links. */)
3066 (filename)
3067 Lisp_Object filename;
3069 Lisp_Object absname;
3070 Lisp_Object handler;
3071 struct stat statbuf;
3073 CHECK_STRING (filename);
3074 absname = Fexpand_file_name (filename, Qnil);
3076 /* If the file name has special constructs in it,
3077 call the corresponding file handler. */
3078 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3079 if (!NILP (handler))
3080 return call2 (handler, Qfile_exists_p, absname);
3082 absname = ENCODE_FILE (absname);
3084 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3087 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3088 doc: /* Return t if FILENAME can be executed by you.
3089 For a directory, this means you can access files in that directory. */)
3090 (filename)
3091 Lisp_Object filename;
3093 Lisp_Object absname;
3094 Lisp_Object handler;
3096 CHECK_STRING (filename);
3097 absname = Fexpand_file_name (filename, Qnil);
3099 /* If the file name has special constructs in it,
3100 call the corresponding file handler. */
3101 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3102 if (!NILP (handler))
3103 return call2 (handler, Qfile_executable_p, absname);
3105 absname = ENCODE_FILE (absname);
3107 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3110 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3111 doc: /* Return t if file FILENAME exists and you can read it.
3112 See also `file-exists-p' and `file-attributes'. */)
3113 (filename)
3114 Lisp_Object filename;
3116 Lisp_Object absname;
3117 Lisp_Object handler;
3118 int desc;
3119 int flags;
3120 struct stat statbuf;
3122 CHECK_STRING (filename);
3123 absname = Fexpand_file_name (filename, Qnil);
3125 /* If the file name has special constructs in it,
3126 call the corresponding file handler. */
3127 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3128 if (!NILP (handler))
3129 return call2 (handler, Qfile_readable_p, absname);
3131 absname = ENCODE_FILE (absname);
3133 #if defined(DOS_NT) || defined(macintosh)
3134 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3135 directories. */
3136 if (access (SDATA (absname), 0) == 0)
3137 return Qt;
3138 return Qnil;
3139 #else /* not DOS_NT and not macintosh */
3140 flags = O_RDONLY;
3141 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3142 /* Opening a fifo without O_NONBLOCK can wait.
3143 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3144 except in the case of a fifo, on a system which handles it. */
3145 desc = stat (SDATA (absname), &statbuf);
3146 if (desc < 0)
3147 return Qnil;
3148 if (S_ISFIFO (statbuf.st_mode))
3149 flags |= O_NONBLOCK;
3150 #endif
3151 desc = emacs_open (SDATA (absname), flags, 0);
3152 if (desc < 0)
3153 return Qnil;
3154 emacs_close (desc);
3155 return Qt;
3156 #endif /* not DOS_NT and not macintosh */
3159 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3160 on the RT/PC. */
3161 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3162 doc: /* Return t if file FILENAME can be written or created by you. */)
3163 (filename)
3164 Lisp_Object filename;
3166 Lisp_Object absname, dir, encoded;
3167 Lisp_Object handler;
3168 struct stat statbuf;
3170 CHECK_STRING (filename);
3171 absname = Fexpand_file_name (filename, Qnil);
3173 /* If the file name has special constructs in it,
3174 call the corresponding file handler. */
3175 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3176 if (!NILP (handler))
3177 return call2 (handler, Qfile_writable_p, absname);
3179 encoded = ENCODE_FILE (absname);
3180 if (stat (SDATA (encoded), &statbuf) >= 0)
3181 return (check_writable (SDATA (encoded))
3182 ? Qt : Qnil);
3184 dir = Ffile_name_directory (absname);
3185 #ifdef VMS
3186 if (!NILP (dir))
3187 dir = Fdirectory_file_name (dir);
3188 #endif /* VMS */
3189 #ifdef MSDOS
3190 if (!NILP (dir))
3191 dir = Fdirectory_file_name (dir);
3192 #endif /* MSDOS */
3194 dir = ENCODE_FILE (dir);
3195 #ifdef WINDOWSNT
3196 /* The read-only attribute of the parent directory doesn't affect
3197 whether a file or directory can be created within it. Some day we
3198 should check ACLs though, which do affect this. */
3199 if (stat (SDATA (dir), &statbuf) < 0)
3200 return Qnil;
3201 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3202 #else
3203 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3204 ? Qt : Qnil);
3205 #endif
3208 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3209 doc: /* Access file FILENAME, and get an error if that does not work.
3210 The second argument STRING is used in the error message.
3211 If there is no error, returns nil. */)
3212 (filename, string)
3213 Lisp_Object filename, string;
3215 Lisp_Object handler, encoded_filename, absname;
3216 int fd;
3218 CHECK_STRING (filename);
3219 absname = Fexpand_file_name (filename, Qnil);
3221 CHECK_STRING (string);
3223 /* If the file name has special constructs in it,
3224 call the corresponding file handler. */
3225 handler = Ffind_file_name_handler (absname, Qaccess_file);
3226 if (!NILP (handler))
3227 return call3 (handler, Qaccess_file, absname, string);
3229 encoded_filename = ENCODE_FILE (absname);
3231 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3232 if (fd < 0)
3233 report_file_error (SDATA (string), Fcons (filename, Qnil));
3234 emacs_close (fd);
3236 return Qnil;
3239 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3240 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3241 The value is the link target, as a string.
3242 Otherwise it returns nil.
3244 This function returns t when given the name of a symlink that
3245 points to a nonexistent file. */)
3246 (filename)
3247 Lisp_Object filename;
3249 Lisp_Object handler;
3251 CHECK_STRING (filename);
3252 filename = Fexpand_file_name (filename, Qnil);
3254 /* If the file name has special constructs in it,
3255 call the corresponding file handler. */
3256 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3257 if (!NILP (handler))
3258 return call2 (handler, Qfile_symlink_p, filename);
3260 #ifdef S_IFLNK
3262 char *buf;
3263 int bufsize;
3264 int valsize;
3265 Lisp_Object val;
3267 filename = ENCODE_FILE (filename);
3269 bufsize = 50;
3270 buf = NULL;
3273 bufsize *= 2;
3274 buf = (char *) xrealloc (buf, bufsize);
3275 bzero (buf, bufsize);
3277 errno = 0;
3278 valsize = readlink (SDATA (filename), buf, bufsize);
3279 if (valsize == -1)
3281 #ifdef ERANGE
3282 /* HP-UX reports ERANGE if buffer is too small. */
3283 if (errno == ERANGE)
3284 valsize = bufsize;
3285 else
3286 #endif
3288 xfree (buf);
3289 return Qnil;
3293 while (valsize >= bufsize);
3295 val = make_string (buf, valsize);
3296 if (buf[0] == '/' && index (buf, ':'))
3297 val = concat2 (build_string ("/:"), val);
3298 xfree (buf);
3299 val = DECODE_FILE (val);
3300 return val;
3302 #else /* not S_IFLNK */
3303 return Qnil;
3304 #endif /* not S_IFLNK */
3307 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3308 doc: /* Return t if FILENAME names an existing directory.
3309 Symbolic links to directories count as directories.
3310 See `file-symlink-p' to distinguish symlinks. */)
3311 (filename)
3312 Lisp_Object filename;
3314 register Lisp_Object absname;
3315 struct stat st;
3316 Lisp_Object handler;
3318 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3320 /* If the file name has special constructs in it,
3321 call the corresponding file handler. */
3322 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3323 if (!NILP (handler))
3324 return call2 (handler, Qfile_directory_p, absname);
3326 absname = ENCODE_FILE (absname);
3328 if (stat (SDATA (absname), &st) < 0)
3329 return Qnil;
3330 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3333 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3334 doc: /* Return t if file FILENAME names a directory you can open.
3335 For the value to be t, FILENAME must specify the name of a directory as a file,
3336 and the directory must allow you to open files in it. In order to use a
3337 directory as a buffer's current directory, this predicate must return true.
3338 A directory name spec may be given instead; then the value is t
3339 if the directory so specified exists and really is a readable and
3340 searchable directory. */)
3341 (filename)
3342 Lisp_Object filename;
3344 Lisp_Object handler;
3345 int tem;
3346 struct gcpro gcpro1;
3348 /* If the file name has special constructs in it,
3349 call the corresponding file handler. */
3350 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3351 if (!NILP (handler))
3352 return call2 (handler, Qfile_accessible_directory_p, filename);
3354 GCPRO1 (filename);
3355 tem = (NILP (Ffile_directory_p (filename))
3356 || NILP (Ffile_executable_p (filename)));
3357 UNGCPRO;
3358 return tem ? Qnil : Qt;
3361 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3362 doc: /* Return t if FILENAME names a regular file.
3363 This is the sort of file that holds an ordinary stream of data bytes.
3364 Symbolic links to regular files count as regular files.
3365 See `file-symlink-p' to distinguish symlinks. */)
3366 (filename)
3367 Lisp_Object filename;
3369 register Lisp_Object absname;
3370 struct stat st;
3371 Lisp_Object handler;
3373 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3375 /* If the file name has special constructs in it,
3376 call the corresponding file handler. */
3377 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3378 if (!NILP (handler))
3379 return call2 (handler, Qfile_regular_p, absname);
3381 absname = ENCODE_FILE (absname);
3383 #ifdef WINDOWSNT
3385 int result;
3386 Lisp_Object tem = Vw32_get_true_file_attributes;
3388 /* Tell stat to use expensive method to get accurate info. */
3389 Vw32_get_true_file_attributes = Qt;
3390 result = stat (SDATA (absname), &st);
3391 Vw32_get_true_file_attributes = tem;
3393 if (result < 0)
3394 return Qnil;
3395 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3397 #else
3398 if (stat (SDATA (absname), &st) < 0)
3399 return Qnil;
3400 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3401 #endif
3404 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3405 doc: /* Return mode bits of file named FILENAME, as an integer.
3406 Return nil, if file does not exist or is not accessible. */)
3407 (filename)
3408 Lisp_Object filename;
3410 Lisp_Object absname;
3411 struct stat st;
3412 Lisp_Object handler;
3414 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3416 /* If the file name has special constructs in it,
3417 call the corresponding file handler. */
3418 handler = Ffind_file_name_handler (absname, Qfile_modes);
3419 if (!NILP (handler))
3420 return call2 (handler, Qfile_modes, absname);
3422 absname = ENCODE_FILE (absname);
3424 if (stat (SDATA (absname), &st) < 0)
3425 return Qnil;
3426 #if defined (MSDOS) && __DJGPP__ < 2
3427 if (check_executable (SDATA (absname)))
3428 st.st_mode |= S_IEXEC;
3429 #endif /* MSDOS && __DJGPP__ < 2 */
3431 return make_number (st.st_mode & 07777);
3434 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2,
3435 "(let ((file (read-file-name \"File: \"))) \
3436 (list file (read-file-modes nil file)))",
3437 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3438 Only the 12 low bits of MODE are used. */)
3439 (filename, mode)
3440 Lisp_Object filename, mode;
3442 Lisp_Object absname, encoded_absname;
3443 Lisp_Object handler;
3445 absname = Fexpand_file_name (filename, current_buffer->directory);
3446 CHECK_NUMBER (mode);
3448 /* If the file name has special constructs in it,
3449 call the corresponding file handler. */
3450 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3451 if (!NILP (handler))
3452 return call3 (handler, Qset_file_modes, absname, mode);
3454 encoded_absname = ENCODE_FILE (absname);
3456 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3457 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3459 return Qnil;
3462 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3463 doc: /* Set the file permission bits for newly created files.
3464 The argument MODE should be an integer; only the low 9 bits are used.
3465 This setting is inherited by subprocesses. */)
3466 (mode)
3467 Lisp_Object mode;
3469 CHECK_NUMBER (mode);
3471 umask ((~ XINT (mode)) & 0777);
3473 return Qnil;
3476 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3477 doc: /* Return the default file protection for created files.
3478 The value is an integer. */)
3481 int realmask;
3482 Lisp_Object value;
3484 realmask = umask (0);
3485 umask (realmask);
3487 XSETINT (value, (~ realmask) & 0777);
3488 return value;
3491 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3493 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3494 doc: /* Set times of file FILENAME to TIME.
3495 Set both access and modification times.
3496 Return t on success, else nil.
3497 Use the current time if TIME is nil. TIME is in the format of
3498 `current-time'. */)
3499 (filename, time)
3500 Lisp_Object filename, time;
3502 Lisp_Object absname, encoded_absname;
3503 Lisp_Object handler;
3504 time_t sec;
3505 int usec;
3507 if (! lisp_time_argument (time, &sec, &usec))
3508 error ("Invalid time specification");
3510 absname = Fexpand_file_name (filename, current_buffer->directory);
3512 /* If the file name has special constructs in it,
3513 call the corresponding file handler. */
3514 handler = Ffind_file_name_handler (absname, Qset_file_times);
3515 if (!NILP (handler))
3516 return call3 (handler, Qset_file_times, absname, time);
3518 encoded_absname = ENCODE_FILE (absname);
3521 EMACS_TIME t;
3523 EMACS_SET_SECS (t, sec);
3524 EMACS_SET_USECS (t, usec);
3526 if (set_file_times (SDATA (encoded_absname), t, t))
3528 #ifdef DOS_NT
3529 struct stat st;
3531 /* Setting times on a directory always fails. */
3532 if (stat (SDATA (encoded_absname), &st) == 0
3533 && (st.st_mode & S_IFMT) == S_IFDIR)
3534 return Qnil;
3535 #endif
3536 report_file_error ("Setting file times", Fcons (absname, Qnil));
3537 return Qnil;
3541 return Qt;
3544 #ifdef HAVE_SYNC
3545 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3546 doc: /* Tell Unix to finish all pending disk updates. */)
3549 sync ();
3550 return Qnil;
3553 #endif /* HAVE_SYNC */
3555 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3556 doc: /* Return t if file FILE1 is newer than file FILE2.
3557 If FILE1 does not exist, the answer is nil;
3558 otherwise, if FILE2 does not exist, the answer is t. */)
3559 (file1, file2)
3560 Lisp_Object file1, file2;
3562 Lisp_Object absname1, absname2;
3563 struct stat st;
3564 int mtime1;
3565 Lisp_Object handler;
3566 struct gcpro gcpro1, gcpro2;
3568 CHECK_STRING (file1);
3569 CHECK_STRING (file2);
3571 absname1 = Qnil;
3572 GCPRO2 (absname1, file2);
3573 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3574 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3575 UNGCPRO;
3577 /* If the file name has special constructs in it,
3578 call the corresponding file handler. */
3579 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3580 if (NILP (handler))
3581 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3582 if (!NILP (handler))
3583 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3585 GCPRO2 (absname1, absname2);
3586 absname1 = ENCODE_FILE (absname1);
3587 absname2 = ENCODE_FILE (absname2);
3588 UNGCPRO;
3590 if (stat (SDATA (absname1), &st) < 0)
3591 return Qnil;
3593 mtime1 = st.st_mtime;
3595 if (stat (SDATA (absname2), &st) < 0)
3596 return Qt;
3598 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3601 #ifdef DOS_NT
3602 Lisp_Object Qfind_buffer_file_type;
3603 #endif /* DOS_NT */
3605 #ifndef READ_BUF_SIZE
3606 #define READ_BUF_SIZE (64 << 10)
3607 #endif
3609 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3611 /* This function is called after Lisp functions to decide a coding
3612 system are called, or when they cause an error. Before they are
3613 called, the current buffer is set unibyte and it contains only a
3614 newly inserted text (thus the buffer was empty before the
3615 insertion).
3617 The functions may set markers, overlays, text properties, or even
3618 alter the buffer contents, change the current buffer.
3620 Here, we reset all those changes by:
3621 o set back the current buffer.
3622 o move all markers and overlays to BEG.
3623 o remove all text properties.
3624 o set back the buffer multibyteness. */
3626 static Lisp_Object
3627 decide_coding_unwind (unwind_data)
3628 Lisp_Object unwind_data;
3630 Lisp_Object multibyte, undo_list, buffer;
3632 multibyte = XCAR (unwind_data);
3633 unwind_data = XCDR (unwind_data);
3634 undo_list = XCAR (unwind_data);
3635 buffer = XCDR (unwind_data);
3637 if (current_buffer != XBUFFER (buffer))
3638 set_buffer_internal (XBUFFER (buffer));
3639 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3640 adjust_overlays_for_delete (BEG, Z - BEG);
3641 BUF_INTERVALS (current_buffer) = 0;
3642 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3644 /* Now we are safe to change the buffer's multibyteness directly. */
3645 current_buffer->enable_multibyte_characters = multibyte;
3646 current_buffer->undo_list = undo_list;
3648 return Qnil;
3652 /* Used to pass values from insert-file-contents to read_non_regular. */
3654 static int non_regular_fd;
3655 static int non_regular_inserted;
3656 static int non_regular_nbytes;
3659 /* Read from a non-regular file.
3660 Read non_regular_trytry bytes max from non_regular_fd.
3661 Non_regular_inserted specifies where to put the read bytes.
3662 Value is the number of bytes read. */
3664 static Lisp_Object
3665 read_non_regular ()
3667 int nbytes;
3669 immediate_quit = 1;
3670 QUIT;
3671 nbytes = emacs_read (non_regular_fd,
3672 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3673 non_regular_nbytes);
3674 immediate_quit = 0;
3675 return make_number (nbytes);
3679 /* Condition-case handler used when reading from non-regular files
3680 in insert-file-contents. */
3682 static Lisp_Object
3683 read_non_regular_quit ()
3685 return Qnil;
3689 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3690 1, 5, 0,
3691 doc: /* Insert contents of file FILENAME after point.
3692 Returns list of absolute file name and number of characters inserted.
3693 If second argument VISIT is non-nil, the buffer's visited filename and
3694 last save file modtime are set, and it is marked unmodified. If
3695 visiting and the file does not exist, visiting is completed before the
3696 error is signaled.
3698 The optional third and fourth arguments BEG and END specify what portion
3699 of the file to insert. These arguments count bytes in the file, not
3700 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3702 If optional fifth argument REPLACE is non-nil, replace the current
3703 buffer contents (in the accessible portion) with the file contents.
3704 This is better than simply deleting and inserting the whole thing
3705 because (1) it preserves some marker positions and (2) it puts less data
3706 in the undo list. When REPLACE is non-nil, the second return value is
3707 the number of characters that replace previous buffer contents.
3709 This function does code conversion according to the value of
3710 `coding-system-for-read' or `file-coding-system-alist', and sets the
3711 variable `last-coding-system-used' to the coding system actually used. */)
3712 (filename, visit, beg, end, replace)
3713 Lisp_Object filename, visit, beg, end, replace;
3715 struct stat st;
3716 register int fd;
3717 int inserted = 0;
3718 int nochange = 0;
3719 register int how_much;
3720 register int unprocessed;
3721 int count = SPECPDL_INDEX ();
3722 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3723 Lisp_Object handler, val, insval, orig_filename, old_undo;
3724 Lisp_Object p;
3725 int total = 0;
3726 int not_regular = 0;
3727 unsigned char read_buf[READ_BUF_SIZE];
3728 struct coding_system coding;
3729 unsigned char buffer[1 << 14];
3730 int replace_handled = 0;
3731 int set_coding_system = 0;
3732 Lisp_Object coding_system;
3733 int read_quit = 0;
3734 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3735 int we_locked_file = 0;
3737 if (current_buffer->base_buffer && ! NILP (visit))
3738 error ("Cannot do file visiting in an indirect buffer");
3740 if (!NILP (current_buffer->read_only))
3741 Fbarf_if_buffer_read_only ();
3743 val = Qnil;
3744 p = Qnil;
3745 orig_filename = Qnil;
3746 old_undo = Qnil;
3748 GCPRO5 (filename, val, p, orig_filename, old_undo);
3750 CHECK_STRING (filename);
3751 filename = Fexpand_file_name (filename, Qnil);
3753 /* The value Qnil means that the coding system is not yet
3754 decided. */
3755 coding_system = Qnil;
3757 /* If the file name has special constructs in it,
3758 call the corresponding file handler. */
3759 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3760 if (!NILP (handler))
3762 val = call6 (handler, Qinsert_file_contents, filename,
3763 visit, beg, end, replace);
3764 if (CONSP (val) && CONSP (XCDR (val)))
3765 inserted = XINT (XCAR (XCDR (val)));
3766 goto handled;
3769 orig_filename = filename;
3770 filename = ENCODE_FILE (filename);
3772 fd = -1;
3774 #ifdef WINDOWSNT
3776 Lisp_Object tem = Vw32_get_true_file_attributes;
3778 /* Tell stat to use expensive method to get accurate info. */
3779 Vw32_get_true_file_attributes = Qt;
3780 total = stat (SDATA (filename), &st);
3781 Vw32_get_true_file_attributes = tem;
3783 if (total < 0)
3784 #else
3785 if (stat (SDATA (filename), &st) < 0)
3786 #endif /* WINDOWSNT */
3788 if (fd >= 0) emacs_close (fd);
3789 badopen:
3790 if (NILP (visit))
3791 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3792 st.st_mtime = -1;
3793 how_much = 0;
3794 if (!NILP (Vcoding_system_for_read))
3795 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3796 goto notfound;
3799 #ifdef S_IFREG
3800 /* This code will need to be changed in order to work on named
3801 pipes, and it's probably just not worth it. So we should at
3802 least signal an error. */
3803 if (!S_ISREG (st.st_mode))
3805 not_regular = 1;
3807 if (! NILP (visit))
3808 goto notfound;
3810 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3811 xsignal2 (Qfile_error,
3812 build_string ("not a regular file"), orig_filename);
3814 #endif
3816 if (fd < 0)
3817 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3818 goto badopen;
3820 /* Replacement should preserve point as it preserves markers. */
3821 if (!NILP (replace))
3822 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3824 record_unwind_protect (close_file_unwind, make_number (fd));
3826 /* Supposedly happens on VMS. */
3827 /* Can happen on any platform that uses long as type of off_t, but allows
3828 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3829 give a message suitable for the latter case. */
3830 if (! not_regular && st.st_size < 0)
3831 error ("Maximum buffer size exceeded");
3833 /* Prevent redisplay optimizations. */
3834 current_buffer->clip_changed = 1;
3836 if (!NILP (visit))
3838 if (!NILP (beg) || !NILP (end))
3839 error ("Attempt to visit less than an entire file");
3840 if (BEG < Z && NILP (replace))
3841 error ("Cannot do file visiting in a non-empty buffer");
3844 if (!NILP (beg))
3845 CHECK_NUMBER (beg);
3846 else
3847 XSETFASTINT (beg, 0);
3849 if (!NILP (end))
3850 CHECK_NUMBER (end);
3851 else
3853 if (! not_regular)
3855 XSETINT (end, st.st_size);
3857 /* Arithmetic overflow can occur if an Emacs integer cannot
3858 represent the file size, or if the calculations below
3859 overflow. The calculations below double the file size
3860 twice, so check that it can be multiplied by 4 safely. */
3861 if (XINT (end) != st.st_size
3862 || st.st_size > INT_MAX / 4)
3863 error ("Maximum buffer size exceeded");
3865 /* The file size returned from stat may be zero, but data
3866 may be readable nonetheless, for example when this is a
3867 file in the /proc filesystem. */
3868 if (st.st_size == 0)
3869 XSETINT (end, READ_BUF_SIZE);
3873 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3875 coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix);
3876 setup_coding_system (coding_system, &coding);
3877 /* Ensure we set Vlast_coding_system_used. */
3878 set_coding_system = 1;
3880 else if (BEG < Z)
3882 /* Decide the coding system to use for reading the file now
3883 because we can't use an optimized method for handling
3884 `coding:' tag if the current buffer is not empty. */
3885 if (!NILP (Vcoding_system_for_read))
3886 coding_system = Vcoding_system_for_read;
3887 else
3889 /* Don't try looking inside a file for a coding system
3890 specification if it is not seekable. */
3891 if (! not_regular && ! NILP (Vset_auto_coding_function))
3893 /* Find a coding system specified in the heading two
3894 lines or in the tailing several lines of the file.
3895 We assume that the 1K-byte and 3K-byte for heading
3896 and tailing respectively are sufficient for this
3897 purpose. */
3898 int nread;
3900 if (st.st_size <= (1024 * 4))
3901 nread = emacs_read (fd, read_buf, 1024 * 4);
3902 else
3904 nread = emacs_read (fd, read_buf, 1024);
3905 if (nread >= 0)
3907 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3908 report_file_error ("Setting file position",
3909 Fcons (orig_filename, Qnil));
3910 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3914 if (nread < 0)
3915 error ("IO error reading %s: %s",
3916 SDATA (orig_filename), emacs_strerror (errno));
3917 else if (nread > 0)
3919 struct buffer *prev = current_buffer;
3920 Lisp_Object buffer;
3921 struct buffer *buf;
3923 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3925 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3926 buf = XBUFFER (buffer);
3928 delete_all_overlays (buf);
3929 buf->directory = current_buffer->directory;
3930 buf->read_only = Qnil;
3931 buf->filename = Qnil;
3932 buf->undo_list = Qt;
3933 eassert (buf->overlays_before == NULL);
3934 eassert (buf->overlays_after == NULL);
3936 set_buffer_internal (buf);
3937 Ferase_buffer ();
3938 buf->enable_multibyte_characters = Qnil;
3940 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3941 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3942 coding_system = call2 (Vset_auto_coding_function,
3943 filename, make_number (nread));
3944 set_buffer_internal (prev);
3946 /* Discard the unwind protect for recovering the
3947 current buffer. */
3948 specpdl_ptr--;
3950 /* Rewind the file for the actual read done later. */
3951 if (lseek (fd, 0, 0) < 0)
3952 report_file_error ("Setting file position",
3953 Fcons (orig_filename, Qnil));
3957 if (NILP (coding_system))
3959 /* If we have not yet decided a coding system, check
3960 file-coding-system-alist. */
3961 Lisp_Object args[6];
3963 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3964 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3965 coding_system = Ffind_operation_coding_system (6, args);
3966 if (CONSP (coding_system))
3967 coding_system = XCAR (coding_system);
3971 if (NILP (coding_system))
3972 coding_system = Qundecided;
3973 else
3974 CHECK_CODING_SYSTEM (coding_system);
3976 if (NILP (current_buffer->enable_multibyte_characters))
3977 /* We must suppress all character code conversion except for
3978 end-of-line conversion. */
3979 coding_system = raw_text_coding_system (coding_system);
3981 setup_coding_system (coding_system, &coding);
3982 /* Ensure we set Vlast_coding_system_used. */
3983 set_coding_system = 1;
3986 /* If requested, replace the accessible part of the buffer
3987 with the file contents. Avoid replacing text at the
3988 beginning or end of the buffer that matches the file contents;
3989 that preserves markers pointing to the unchanged parts.
3991 Here we implement this feature in an optimized way
3992 for the case where code conversion is NOT needed.
3993 The following if-statement handles the case of conversion
3994 in a less optimal way.
3996 If the code conversion is "automatic" then we try using this
3997 method and hope for the best.
3998 But if we discover the need for conversion, we give up on this method
3999 and let the following if-statement handle the replace job. */
4000 if (!NILP (replace)
4001 && BEGV < ZV
4002 && (NILP (coding_system)
4003 || ! CODING_REQUIRE_DECODING (&coding)))
4005 /* same_at_start and same_at_end count bytes,
4006 because file access counts bytes
4007 and BEG and END count bytes. */
4008 int same_at_start = BEGV_BYTE;
4009 int same_at_end = ZV_BYTE;
4010 int overlap;
4011 /* There is still a possibility we will find the need to do code
4012 conversion. If that happens, we set this variable to 1 to
4013 give up on handling REPLACE in the optimized way. */
4014 int giveup_match_end = 0;
4016 if (XINT (beg) != 0)
4018 if (lseek (fd, XINT (beg), 0) < 0)
4019 report_file_error ("Setting file position",
4020 Fcons (orig_filename, Qnil));
4023 immediate_quit = 1;
4024 QUIT;
4025 /* Count how many chars at the start of the file
4026 match the text at the beginning of the buffer. */
4027 while (1)
4029 int nread, bufpos;
4031 nread = emacs_read (fd, buffer, sizeof buffer);
4032 if (nread < 0)
4033 error ("IO error reading %s: %s",
4034 SDATA (orig_filename), emacs_strerror (errno));
4035 else if (nread == 0)
4036 break;
4038 if (CODING_REQUIRE_DETECTION (&coding))
4040 coding_system = detect_coding_system (buffer, nread, nread, 1, 0,
4041 coding_system);
4042 setup_coding_system (coding_system, &coding);
4045 if (CODING_REQUIRE_DECODING (&coding))
4046 /* We found that the file should be decoded somehow.
4047 Let's give up here. */
4049 giveup_match_end = 1;
4050 break;
4053 bufpos = 0;
4054 while (bufpos < nread && same_at_start < ZV_BYTE
4055 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4056 same_at_start++, bufpos++;
4057 /* If we found a discrepancy, stop the scan.
4058 Otherwise loop around and scan the next bufferful. */
4059 if (bufpos != nread)
4060 break;
4062 immediate_quit = 0;
4063 /* If the file matches the buffer completely,
4064 there's no need to replace anything. */
4065 if (same_at_start - BEGV_BYTE == XINT (end))
4067 emacs_close (fd);
4068 specpdl_ptr--;
4069 /* Truncate the buffer to the size of the file. */
4070 del_range_1 (same_at_start, same_at_end, 0, 0);
4071 goto handled;
4073 immediate_quit = 1;
4074 QUIT;
4075 /* Count how many chars at the end of the file
4076 match the text at the end of the buffer. But, if we have
4077 already found that decoding is necessary, don't waste time. */
4078 while (!giveup_match_end)
4080 int total_read, nread, bufpos, curpos, trial;
4082 /* At what file position are we now scanning? */
4083 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4084 /* If the entire file matches the buffer tail, stop the scan. */
4085 if (curpos == 0)
4086 break;
4087 /* How much can we scan in the next step? */
4088 trial = min (curpos, sizeof buffer);
4089 if (lseek (fd, curpos - trial, 0) < 0)
4090 report_file_error ("Setting file position",
4091 Fcons (orig_filename, Qnil));
4093 total_read = nread = 0;
4094 while (total_read < trial)
4096 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4097 if (nread < 0)
4098 error ("IO error reading %s: %s",
4099 SDATA (orig_filename), emacs_strerror (errno));
4100 else if (nread == 0)
4101 break;
4102 total_read += nread;
4105 /* Scan this bufferful from the end, comparing with
4106 the Emacs buffer. */
4107 bufpos = total_read;
4109 /* Compare with same_at_start to avoid counting some buffer text
4110 as matching both at the file's beginning and at the end. */
4111 while (bufpos > 0 && same_at_end > same_at_start
4112 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4113 same_at_end--, bufpos--;
4115 /* If we found a discrepancy, stop the scan.
4116 Otherwise loop around and scan the preceding bufferful. */
4117 if (bufpos != 0)
4119 /* If this discrepancy is because of code conversion,
4120 we cannot use this method; giveup and try the other. */
4121 if (same_at_end > same_at_start
4122 && FETCH_BYTE (same_at_end - 1) >= 0200
4123 && ! NILP (current_buffer->enable_multibyte_characters)
4124 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4125 giveup_match_end = 1;
4126 break;
4129 if (nread == 0)
4130 break;
4132 immediate_quit = 0;
4134 if (! giveup_match_end)
4136 int temp;
4138 /* We win! We can handle REPLACE the optimized way. */
4140 /* Extend the start of non-matching text area to multibyte
4141 character boundary. */
4142 if (! NILP (current_buffer->enable_multibyte_characters))
4143 while (same_at_start > BEGV_BYTE
4144 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4145 same_at_start--;
4147 /* Extend the end of non-matching text area to multibyte
4148 character boundary. */
4149 if (! NILP (current_buffer->enable_multibyte_characters))
4150 while (same_at_end < ZV_BYTE
4151 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4152 same_at_end++;
4154 /* Don't try to reuse the same piece of text twice. */
4155 overlap = (same_at_start - BEGV_BYTE
4156 - (same_at_end + st.st_size - ZV));
4157 if (overlap > 0)
4158 same_at_end += overlap;
4160 /* Arrange to read only the nonmatching middle part of the file. */
4161 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4162 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4164 del_range_byte (same_at_start, same_at_end, 0);
4165 /* Insert from the file at the proper position. */
4166 temp = BYTE_TO_CHAR (same_at_start);
4167 SET_PT_BOTH (temp, same_at_start);
4169 /* If display currently starts at beginning of line,
4170 keep it that way. */
4171 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4172 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4174 replace_handled = 1;
4178 /* If requested, replace the accessible part of the buffer
4179 with the file contents. Avoid replacing text at the
4180 beginning or end of the buffer that matches the file contents;
4181 that preserves markers pointing to the unchanged parts.
4183 Here we implement this feature for the case where code conversion
4184 is needed, in a simple way that needs a lot of memory.
4185 The preceding if-statement handles the case of no conversion
4186 in a more optimized way. */
4187 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4189 EMACS_INT same_at_start = BEGV_BYTE;
4190 EMACS_INT same_at_end = ZV_BYTE;
4191 EMACS_INT same_at_start_charpos;
4192 EMACS_INT inserted_chars;
4193 EMACS_INT overlap;
4194 EMACS_INT bufpos;
4195 unsigned char *decoded;
4196 int temp;
4197 int this_count = SPECPDL_INDEX ();
4198 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
4199 Lisp_Object conversion_buffer;
4201 conversion_buffer = code_conversion_save (1, multibyte);
4203 /* First read the whole file, performing code conversion into
4204 CONVERSION_BUFFER. */
4206 if (lseek (fd, XINT (beg), 0) < 0)
4207 report_file_error ("Setting file position",
4208 Fcons (orig_filename, Qnil));
4210 total = st.st_size; /* Total bytes in the file. */
4211 how_much = 0; /* Bytes read from file so far. */
4212 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4213 unprocessed = 0; /* Bytes not processed in previous loop. */
4215 GCPRO1 (conversion_buffer);
4216 while (how_much < total)
4218 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
4219 quitting while reading a huge while. */
4220 /* try is reserved in some compilers (Microsoft C) */
4221 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4222 int this;
4224 /* Allow quitting out of the actual I/O. */
4225 immediate_quit = 1;
4226 QUIT;
4227 this = emacs_read (fd, read_buf + unprocessed, trytry);
4228 immediate_quit = 0;
4230 if (this <= 0)
4232 if (this < 0)
4233 how_much = this;
4234 break;
4237 how_much += this;
4239 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer),
4240 BUF_Z (XBUFFER (conversion_buffer)));
4241 decode_coding_c_string (&coding, read_buf, unprocessed + this,
4242 conversion_buffer);
4243 unprocessed = coding.carryover_bytes;
4244 if (coding.carryover_bytes > 0)
4245 bcopy (coding.carryover, read_buf, unprocessed);
4247 UNGCPRO;
4248 emacs_close (fd);
4250 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
4251 if we couldn't read the file. */
4253 if (how_much < 0)
4254 error ("IO error reading %s: %s",
4255 SDATA (orig_filename), emacs_strerror (errno));
4257 if (unprocessed > 0)
4259 coding.mode |= CODING_MODE_LAST_BLOCK;
4260 decode_coding_c_string (&coding, read_buf, unprocessed,
4261 conversion_buffer);
4262 coding.mode &= ~CODING_MODE_LAST_BLOCK;
4265 decoded = BUF_BEG_ADDR (XBUFFER (conversion_buffer));
4266 inserted = (BUF_Z_BYTE (XBUFFER (conversion_buffer))
4267 - BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
4269 /* Compare the beginning of the converted string with the buffer
4270 text. */
4272 bufpos = 0;
4273 while (bufpos < inserted && same_at_start < same_at_end
4274 && FETCH_BYTE (same_at_start) == decoded[bufpos])
4275 same_at_start++, bufpos++;
4277 /* If the file matches the head of buffer completely,
4278 there's no need to replace anything. */
4280 if (bufpos == inserted)
4282 specpdl_ptr--;
4283 /* Truncate the buffer to the size of the file. */
4284 if (same_at_start == same_at_end)
4285 nochange = 1;
4286 else
4287 del_range_byte (same_at_start, same_at_end, 0);
4288 inserted = 0;
4290 unbind_to (this_count, Qnil);
4291 goto handled;
4294 /* Extend the start of non-matching text area to the previous
4295 multibyte character boundary. */
4296 if (! NILP (current_buffer->enable_multibyte_characters))
4297 while (same_at_start > BEGV_BYTE
4298 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4299 same_at_start--;
4301 /* Scan this bufferful from the end, comparing with
4302 the Emacs buffer. */
4303 bufpos = inserted;
4305 /* Compare with same_at_start to avoid counting some buffer text
4306 as matching both at the file's beginning and at the end. */
4307 while (bufpos > 0 && same_at_end > same_at_start
4308 && FETCH_BYTE (same_at_end - 1) == decoded[bufpos - 1])
4309 same_at_end--, bufpos--;
4311 /* Extend the end of non-matching text area to the next
4312 multibyte character boundary. */
4313 if (! NILP (current_buffer->enable_multibyte_characters))
4314 while (same_at_end < ZV_BYTE
4315 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4316 same_at_end++;
4318 /* Don't try to reuse the same piece of text twice. */
4319 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4320 if (overlap > 0)
4321 same_at_end += overlap;
4323 /* If display currently starts at beginning of line,
4324 keep it that way. */
4325 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4326 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4328 /* Replace the chars that we need to replace,
4329 and update INSERTED to equal the number of bytes
4330 we are taking from the decoded string. */
4331 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4333 if (same_at_end != same_at_start)
4335 del_range_byte (same_at_start, same_at_end, 0);
4336 temp = GPT;
4337 same_at_start = GPT_BYTE;
4339 else
4341 temp = BYTE_TO_CHAR (same_at_start);
4343 /* Insert from the file at the proper position. */
4344 SET_PT_BOTH (temp, same_at_start);
4345 same_at_start_charpos
4346 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
4347 same_at_start - BEGV_BYTE
4348 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
4349 inserted_chars
4350 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
4351 same_at_start + inserted - BEGV_BYTE
4352 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)))
4353 - same_at_start_charpos);
4354 /* This binding is to avoid ask-user-about-supersession-threat
4355 being called in insert_from_buffer (via in
4356 prepare_to_modify_buffer). */
4357 specbind (intern ("buffer-file-name"), Qnil);
4358 insert_from_buffer (XBUFFER (conversion_buffer),
4359 same_at_start_charpos, inserted_chars, 0);
4360 /* Set `inserted' to the number of inserted characters. */
4361 inserted = PT - temp;
4362 /* Set point before the inserted characters. */
4363 SET_PT_BOTH (temp, same_at_start);
4365 unbind_to (this_count, Qnil);
4367 goto handled;
4370 if (! not_regular)
4372 register Lisp_Object temp;
4374 total = XINT (end) - XINT (beg);
4376 /* Make sure point-max won't overflow after this insertion. */
4377 XSETINT (temp, total);
4378 if (total != XINT (temp))
4379 error ("Maximum buffer size exceeded");
4381 else
4382 /* For a special file, all we can do is guess. */
4383 total = READ_BUF_SIZE;
4385 if (NILP (visit) && inserted > 0)
4387 #ifdef CLASH_DETECTION
4388 if (!NILP (current_buffer->file_truename)
4389 /* Make binding buffer-file-name to nil effective. */
4390 && !NILP (current_buffer->filename)
4391 && SAVE_MODIFF >= MODIFF)
4392 we_locked_file = 1;
4393 #endif /* CLASH_DETECTION */
4394 prepare_to_modify_buffer (GPT, GPT, NULL);
4397 move_gap (PT);
4398 if (GAP_SIZE < total)
4399 make_gap (total - GAP_SIZE);
4401 if (XINT (beg) != 0 || !NILP (replace))
4403 if (lseek (fd, XINT (beg), 0) < 0)
4404 report_file_error ("Setting file position",
4405 Fcons (orig_filename, Qnil));
4408 /* In the following loop, HOW_MUCH contains the total bytes read so
4409 far for a regular file, and not changed for a special file. But,
4410 before exiting the loop, it is set to a negative value if I/O
4411 error occurs. */
4412 how_much = 0;
4414 /* Total bytes inserted. */
4415 inserted = 0;
4417 /* Here, we don't do code conversion in the loop. It is done by
4418 decode_coding_gap after all data are read into the buffer. */
4420 int gap_size = GAP_SIZE;
4422 while (how_much < total)
4424 /* try is reserved in some compilers (Microsoft C) */
4425 int trytry = min (total - how_much, READ_BUF_SIZE);
4426 int this;
4428 if (not_regular)
4430 Lisp_Object val;
4432 /* Maybe make more room. */
4433 if (gap_size < trytry)
4435 make_gap (total - gap_size);
4436 gap_size = GAP_SIZE;
4439 /* Read from the file, capturing `quit'. When an
4440 error occurs, end the loop, and arrange for a quit
4441 to be signaled after decoding the text we read. */
4442 non_regular_fd = fd;
4443 non_regular_inserted = inserted;
4444 non_regular_nbytes = trytry;
4445 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4446 read_non_regular_quit);
4447 if (NILP (val))
4449 read_quit = 1;
4450 break;
4453 this = XINT (val);
4455 else
4457 /* Allow quitting out of the actual I/O. We don't make text
4458 part of the buffer until all the reading is done, so a C-g
4459 here doesn't do any harm. */
4460 immediate_quit = 1;
4461 QUIT;
4462 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4463 immediate_quit = 0;
4466 if (this <= 0)
4468 how_much = this;
4469 break;
4472 gap_size -= this;
4474 /* For a regular file, where TOTAL is the real size,
4475 count HOW_MUCH to compare with it.
4476 For a special file, where TOTAL is just a buffer size,
4477 so don't bother counting in HOW_MUCH.
4478 (INSERTED is where we count the number of characters inserted.) */
4479 if (! not_regular)
4480 how_much += this;
4481 inserted += this;
4485 /* Now we have read all the file data into the gap.
4486 If it was empty, undo marking the buffer modified. */
4488 if (inserted == 0)
4490 #ifdef CLASH_DETECTION
4491 if (we_locked_file)
4492 unlock_file (current_buffer->file_truename);
4493 #endif
4494 Vdeactivate_mark = old_Vdeactivate_mark;
4496 else
4497 Vdeactivate_mark = Qt;
4499 /* Make the text read part of the buffer. */
4500 GAP_SIZE -= inserted;
4501 GPT += inserted;
4502 GPT_BYTE += inserted;
4503 ZV += inserted;
4504 ZV_BYTE += inserted;
4505 Z += inserted;
4506 Z_BYTE += inserted;
4508 if (GAP_SIZE > 0)
4509 /* Put an anchor to ensure multi-byte form ends at gap. */
4510 *GPT_ADDR = 0;
4512 emacs_close (fd);
4514 /* Discard the unwind protect for closing the file. */
4515 specpdl_ptr--;
4517 if (how_much < 0)
4518 error ("IO error reading %s: %s",
4519 SDATA (orig_filename), emacs_strerror (errno));
4521 notfound:
4523 if (NILP (coding_system))
4525 /* The coding system is not yet decided. Decide it by an
4526 optimized method for handling `coding:' tag.
4528 Note that we can get here only if the buffer was empty
4529 before the insertion. */
4531 if (!NILP (Vcoding_system_for_read))
4532 coding_system = Vcoding_system_for_read;
4533 else
4535 /* Since we are sure that the current buffer was empty
4536 before the insertion, we can toggle
4537 enable-multibyte-characters directly here without taking
4538 care of marker adjustment. By this way, we can run Lisp
4539 program safely before decoding the inserted text. */
4540 Lisp_Object unwind_data;
4541 int count = SPECPDL_INDEX ();
4543 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4544 Fcons (current_buffer->undo_list,
4545 Fcurrent_buffer ()));
4546 current_buffer->enable_multibyte_characters = Qnil;
4547 current_buffer->undo_list = Qt;
4548 record_unwind_protect (decide_coding_unwind, unwind_data);
4550 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4552 coding_system = call2 (Vset_auto_coding_function,
4553 filename, make_number (inserted));
4556 if (NILP (coding_system))
4558 /* If the coding system is not yet decided, check
4559 file-coding-system-alist. */
4560 Lisp_Object args[6];
4562 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4563 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4564 coding_system = Ffind_operation_coding_system (6, args);
4565 if (CONSP (coding_system))
4566 coding_system = XCAR (coding_system);
4568 unbind_to (count, Qnil);
4569 inserted = Z_BYTE - BEG_BYTE;
4572 if (NILP (coding_system))
4573 coding_system = Qundecided;
4574 else
4575 CHECK_CODING_SYSTEM (coding_system);
4577 if (NILP (current_buffer->enable_multibyte_characters))
4578 /* We must suppress all character code conversion except for
4579 end-of-line conversion. */
4580 coding_system = raw_text_coding_system (coding_system);
4581 setup_coding_system (coding_system, &coding);
4582 /* Ensure we set Vlast_coding_system_used. */
4583 set_coding_system = 1;
4586 if (!NILP (visit))
4588 /* When we visit a file by raw-text, we change the buffer to
4589 unibyte. */
4590 if (CODING_FOR_UNIBYTE (&coding)
4591 /* Can't do this if part of the buffer might be preserved. */
4592 && NILP (replace))
4593 /* Visiting a file with these coding system makes the buffer
4594 unibyte. */
4595 current_buffer->enable_multibyte_characters = Qnil;
4598 coding.dst_multibyte = ! NILP (current_buffer->enable_multibyte_characters);
4599 if (CODING_MAY_REQUIRE_DECODING (&coding)
4600 && (inserted > 0 || CODING_REQUIRE_FLUSHING (&coding)))
4602 move_gap_both (PT, PT_BYTE);
4603 GAP_SIZE += inserted;
4604 ZV_BYTE -= inserted;
4605 Z_BYTE -= inserted;
4606 ZV -= inserted;
4607 Z -= inserted;
4608 decode_coding_gap (&coding, inserted, inserted);
4609 inserted = coding.produced_char;
4610 coding_system = CODING_ID_NAME (coding.id);
4612 else if (inserted > 0)
4613 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4614 inserted);
4616 /* Now INSERTED is measured in characters. */
4618 #ifdef DOS_NT
4619 /* Use the conversion type to determine buffer-file-type
4620 (find-buffer-file-type is now used to help determine the
4621 conversion). */
4622 if ((VECTORP (CODING_ID_EOL_TYPE (coding.id))
4623 || EQ (CODING_ID_EOL_TYPE (coding.id), Qunix))
4624 && ! CODING_REQUIRE_DECODING (&coding))
4625 current_buffer->buffer_file_type = Qt;
4626 else
4627 current_buffer->buffer_file_type = Qnil;
4628 #endif
4630 handled:
4632 if (!NILP (visit))
4634 if (!EQ (current_buffer->undo_list, Qt) && !nochange)
4635 current_buffer->undo_list = Qnil;
4637 if (NILP (handler))
4639 current_buffer->modtime = st.st_mtime;
4640 current_buffer->filename = orig_filename;
4643 SAVE_MODIFF = MODIFF;
4644 current_buffer->auto_save_modified = MODIFF;
4645 XSETFASTINT (current_buffer->save_length, Z - BEG);
4646 #ifdef CLASH_DETECTION
4647 if (NILP (handler))
4649 if (!NILP (current_buffer->file_truename))
4650 unlock_file (current_buffer->file_truename);
4651 unlock_file (filename);
4653 #endif /* CLASH_DETECTION */
4654 if (not_regular)
4655 xsignal2 (Qfile_error,
4656 build_string ("not a regular file"), orig_filename);
4659 if (set_coding_system)
4660 Vlast_coding_system_used = coding_system;
4662 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4664 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4665 visit);
4666 if (! NILP (insval))
4668 CHECK_NUMBER (insval);
4669 inserted = XFASTINT (insval);
4673 /* Decode file format */
4674 if (inserted > 0)
4676 /* Don't run point motion or modification hooks when decoding. */
4677 int count = SPECPDL_INDEX ();
4678 specbind (Qinhibit_point_motion_hooks, Qt);
4679 specbind (Qinhibit_modification_hooks, Qt);
4681 /* Save old undo list and don't record undo for decoding. */
4682 old_undo = current_buffer->undo_list;
4683 current_buffer->undo_list = Qt;
4685 if (NILP (replace))
4687 insval = call3 (Qformat_decode,
4688 Qnil, make_number (inserted), visit);
4689 CHECK_NUMBER (insval);
4690 inserted = XFASTINT (insval);
4692 else
4694 /* If REPLACE is non-nil and we succeeded in not replacing the
4695 beginning or end of the buffer text with the file's contents,
4696 call format-decode with `point' positioned at the beginning of
4697 the buffer and `inserted' equalling the number of characters
4698 in the buffer. Otherwise, format-decode might fail to
4699 correctly analyze the beginning or end of the buffer. Hence
4700 we temporarily save `point' and `inserted' here and restore
4701 `point' iff format-decode did not insert or delete any text.
4702 Otherwise we leave `point' at point-min. */
4703 int opoint = PT;
4704 int opoint_byte = PT_BYTE;
4705 int oinserted = ZV - BEGV;
4706 int ochars_modiff = CHARS_MODIFF;
4708 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4709 insval = call3 (Qformat_decode,
4710 Qnil, make_number (oinserted), visit);
4711 CHECK_NUMBER (insval);
4712 if (ochars_modiff == CHARS_MODIFF)
4713 /* format_decode didn't modify buffer's characters => move
4714 point back to position before inserted text and leave
4715 value of inserted alone. */
4716 SET_PT_BOTH (opoint, opoint_byte);
4717 else
4718 /* format_decode modified buffer's characters => consider
4719 entire buffer changed and leave point at point-min. */
4720 inserted = XFASTINT (insval);
4723 /* For consistency with format-decode call these now iff inserted > 0
4724 (martin 2007-06-28) */
4725 p = Vafter_insert_file_functions;
4726 while (CONSP (p))
4728 if (NILP (replace))
4730 insval = call1 (XCAR (p), make_number (inserted));
4731 if (!NILP (insval))
4733 CHECK_NUMBER (insval);
4734 inserted = XFASTINT (insval);
4737 else
4739 /* For the rationale of this see the comment on format-decode above. */
4740 int opoint = PT;
4741 int opoint_byte = PT_BYTE;
4742 int oinserted = ZV - BEGV;
4743 int ochars_modiff = CHARS_MODIFF;
4745 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4746 insval = call1 (XCAR (p), make_number (oinserted));
4747 if (!NILP (insval))
4749 CHECK_NUMBER (insval);
4750 if (ochars_modiff == CHARS_MODIFF)
4751 /* after_insert_file_functions didn't modify
4752 buffer's characters => move point back to
4753 position before inserted text and leave value of
4754 inserted alone. */
4755 SET_PT_BOTH (opoint, opoint_byte);
4756 else
4757 /* after_insert_file_functions did modify buffer's
4758 characters => consider entire buffer changed and
4759 leave point at point-min. */
4760 inserted = XFASTINT (insval);
4764 QUIT;
4765 p = XCDR (p);
4768 if (NILP (visit))
4770 Lisp_Object lbeg, lend;
4771 XSETINT (lbeg, PT);
4772 XSETINT (lend, PT + inserted);
4773 if (CONSP (old_undo))
4775 Lisp_Object tem = XCAR (old_undo);
4776 if (CONSP (tem) && INTEGERP (XCAR (tem)) &&
4777 INTEGERP (XCDR (tem)) && EQ (XCAR (tem), lbeg))
4778 /* In the non-visiting case record only the final insertion. */
4779 current_buffer->undo_list =
4780 Fcons (Fcons (lbeg, lend), Fcdr (old_undo));
4783 else
4784 /* If undo_list was Qt before, keep it that way.
4785 Otherwise start with an empty undo_list. */
4786 current_buffer->undo_list = EQ (old_undo, Qt) ? Qt : Qnil;
4788 unbind_to (count, Qnil);
4791 /* Call after-change hooks for the inserted text, aside from the case
4792 of normal visiting (not with REPLACE), which is done in a new buffer
4793 "before" the buffer is changed. */
4794 if (inserted > 0 && total > 0
4795 && (NILP (visit) || !NILP (replace)))
4797 signal_after_change (PT, 0, inserted);
4798 update_compositions (PT, PT, CHECK_BORDER);
4801 if (!NILP (visit)
4802 && current_buffer->modtime == -1)
4804 /* If visiting nonexistent file, return nil. */
4805 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4808 if (read_quit)
4809 Fsignal (Qquit, Qnil);
4811 /* ??? Retval needs to be dealt with in all cases consistently. */
4812 if (NILP (val))
4813 val = Fcons (orig_filename,
4814 Fcons (make_number (inserted),
4815 Qnil));
4817 RETURN_UNGCPRO (unbind_to (count, val));
4820 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4822 /* If build_annotations switched buffers, switch back to BUF.
4823 Kill the temporary buffer that was selected in the meantime.
4825 Since this kill only the last temporary buffer, some buffers remain
4826 not killed if build_annotations switched buffers more than once.
4827 -- K.Handa */
4829 static Lisp_Object
4830 build_annotations_unwind (buf)
4831 Lisp_Object buf;
4833 Lisp_Object tembuf;
4835 if (XBUFFER (buf) == current_buffer)
4836 return Qnil;
4837 tembuf = Fcurrent_buffer ();
4838 Fset_buffer (buf);
4839 Fkill_buffer (tembuf);
4840 return Qnil;
4843 /* Decide the coding-system to encode the data with. */
4845 static Lisp_Object
4846 choose_write_coding_system (start, end, filename,
4847 append, visit, lockname, coding)
4848 Lisp_Object start, end, filename, append, visit, lockname;
4849 struct coding_system *coding;
4851 Lisp_Object val;
4852 Lisp_Object eol_parent = Qnil;
4854 if (auto_saving
4855 && NILP (Fstring_equal (current_buffer->filename,
4856 current_buffer->auto_save_file_name)))
4858 val = Qutf_8_emacs;
4859 eol_parent = Qunix;
4861 else if (!NILP (Vcoding_system_for_write))
4863 val = Vcoding_system_for_write;
4864 if (coding_system_require_warning
4865 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4866 /* Confirm that VAL can surely encode the current region. */
4867 val = call5 (Vselect_safe_coding_system_function,
4868 start, end, Fcons (Qt, Fcons (val, Qnil)),
4869 Qnil, filename);
4871 else
4873 /* If the variable `buffer-file-coding-system' is set locally,
4874 it means that the file was read with some kind of code
4875 conversion or the variable is explicitly set by users. We
4876 had better write it out with the same coding system even if
4877 `enable-multibyte-characters' is nil.
4879 If it is not set locally, we anyway have to convert EOL
4880 format if the default value of `buffer-file-coding-system'
4881 tells that it is not Unix-like (LF only) format. */
4882 int using_default_coding = 0;
4883 int force_raw_text = 0;
4885 val = current_buffer->buffer_file_coding_system;
4886 if (NILP (val)
4887 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4889 val = Qnil;
4890 if (NILP (current_buffer->enable_multibyte_characters))
4891 force_raw_text = 1;
4894 if (NILP (val))
4896 /* Check file-coding-system-alist. */
4897 Lisp_Object args[7], coding_systems;
4899 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4900 args[3] = filename; args[4] = append; args[5] = visit;
4901 args[6] = lockname;
4902 coding_systems = Ffind_operation_coding_system (7, args);
4903 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4904 val = XCDR (coding_systems);
4907 if (NILP (val))
4909 /* If we still have not decided a coding system, use the
4910 default value of buffer-file-coding-system. */
4911 val = current_buffer->buffer_file_coding_system;
4912 using_default_coding = 1;
4915 if (! NILP (val) && ! force_raw_text)
4917 Lisp_Object spec, attrs;
4919 CHECK_CODING_SYSTEM_GET_SPEC (val, spec);
4920 attrs = AREF (spec, 0);
4921 if (EQ (CODING_ATTR_TYPE (attrs), Qraw_text))
4922 force_raw_text = 1;
4925 if (!force_raw_text
4926 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4927 /* Confirm that VAL can surely encode the current region. */
4928 val = call5 (Vselect_safe_coding_system_function,
4929 start, end, val, Qnil, filename);
4931 /* If the decided coding-system doesn't specify end-of-line
4932 format, we use that of
4933 `default-buffer-file-coding-system'. */
4934 if (! using_default_coding
4935 && ! NILP (buffer_defaults.buffer_file_coding_system))
4936 val = (coding_inherit_eol_type
4937 (val, buffer_defaults.buffer_file_coding_system));
4939 /* If we decide not to encode text, use `raw-text' or one of its
4940 subsidiaries. */
4941 if (force_raw_text)
4942 val = raw_text_coding_system (val);
4945 val = coding_inherit_eol_type (val, eol_parent);
4946 setup_coding_system (val, coding);
4948 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4949 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4950 return val;
4953 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4954 "r\nFWrite region to file: \ni\ni\ni\np",
4955 doc: /* Write current region into specified file.
4956 When called from a program, requires three arguments:
4957 START, END and FILENAME. START and END are normally buffer positions
4958 specifying the part of the buffer to write.
4959 If START is nil, that means to use the entire buffer contents.
4960 If START is a string, then output that string to the file
4961 instead of any buffer contents; END is ignored.
4963 Optional fourth argument APPEND if non-nil means
4964 append to existing file contents (if any). If it is an integer,
4965 seek to that offset in the file before writing.
4966 Optional fifth argument VISIT, if t or a string, means
4967 set the last-save-file-modtime of buffer to this file's modtime
4968 and mark buffer not modified.
4969 If VISIT is a string, it is a second file name;
4970 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4971 VISIT is also the file name to lock and unlock for clash detection.
4972 If VISIT is neither t nor nil nor a string,
4973 that means do not display the \"Wrote file\" message.
4974 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4975 use for locking and unlocking, overriding FILENAME and VISIT.
4976 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4977 for an existing file with the same name. If MUSTBENEW is `excl',
4978 that means to get an error if the file already exists; never overwrite.
4979 If MUSTBENEW is neither nil nor `excl', that means ask for
4980 confirmation before overwriting, but do go ahead and overwrite the file
4981 if the user confirms.
4983 This does code conversion according to the value of
4984 `coding-system-for-write', `buffer-file-coding-system', or
4985 `file-coding-system-alist', and sets the variable
4986 `last-coding-system-used' to the coding system actually used. */)
4987 (start, end, filename, append, visit, lockname, mustbenew)
4988 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4990 register int desc;
4991 int failure;
4992 int save_errno = 0;
4993 const unsigned char *fn;
4994 struct stat st;
4995 int count = SPECPDL_INDEX ();
4996 int count1;
4997 #ifdef VMS
4998 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4999 #endif /* VMS */
5000 Lisp_Object handler;
5001 Lisp_Object visit_file;
5002 Lisp_Object annotations;
5003 Lisp_Object encoded_filename;
5004 int visiting = (EQ (visit, Qt) || STRINGP (visit));
5005 int quietly = !NILP (visit);
5006 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5007 struct buffer *given_buffer;
5008 #ifdef DOS_NT
5009 int buffer_file_type = O_BINARY;
5010 #endif /* DOS_NT */
5011 struct coding_system coding;
5013 if (current_buffer->base_buffer && visiting)
5014 error ("Cannot do file visiting in an indirect buffer");
5016 if (!NILP (start) && !STRINGP (start))
5017 validate_region (&start, &end);
5019 visit_file = Qnil;
5020 GCPRO5 (start, filename, visit, visit_file, lockname);
5022 filename = Fexpand_file_name (filename, Qnil);
5024 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5025 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5027 if (STRINGP (visit))
5028 visit_file = Fexpand_file_name (visit, Qnil);
5029 else
5030 visit_file = filename;
5032 if (NILP (lockname))
5033 lockname = visit_file;
5035 annotations = Qnil;
5037 /* If the file name has special constructs in it,
5038 call the corresponding file handler. */
5039 handler = Ffind_file_name_handler (filename, Qwrite_region);
5040 /* If FILENAME has no handler, see if VISIT has one. */
5041 if (NILP (handler) && STRINGP (visit))
5042 handler = Ffind_file_name_handler (visit, Qwrite_region);
5044 if (!NILP (handler))
5046 Lisp_Object val;
5047 val = call6 (handler, Qwrite_region, start, end,
5048 filename, append, visit);
5050 if (visiting)
5052 SAVE_MODIFF = MODIFF;
5053 XSETFASTINT (current_buffer->save_length, Z - BEG);
5054 current_buffer->filename = visit_file;
5056 UNGCPRO;
5057 return val;
5060 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5062 /* Special kludge to simplify auto-saving. */
5063 if (NILP (start))
5065 /* Do it later, so write-region-annotate-function can work differently
5066 if we save "the buffer" vs "a region".
5067 This is useful in tar-mode. --Stef
5068 XSETFASTINT (start, BEG);
5069 XSETFASTINT (end, Z); */
5070 Fwiden ();
5073 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5074 count1 = SPECPDL_INDEX ();
5076 given_buffer = current_buffer;
5078 if (!STRINGP (start))
5080 annotations = build_annotations (start, end);
5082 if (current_buffer != given_buffer)
5084 XSETFASTINT (start, BEGV);
5085 XSETFASTINT (end, ZV);
5089 if (NILP (start))
5091 XSETFASTINT (start, BEGV);
5092 XSETFASTINT (end, ZV);
5095 UNGCPRO;
5097 GCPRO5 (start, filename, annotations, visit_file, lockname);
5099 /* Decide the coding-system to encode the data with.
5100 We used to make this choice before calling build_annotations, but that
5101 leads to problems when a write-annotate-function takes care of
5102 unsavable chars (as was the case with X-Symbol). */
5103 Vlast_coding_system_used
5104 = choose_write_coding_system (start, end, filename,
5105 append, visit, lockname, &coding);
5107 #ifdef CLASH_DETECTION
5108 if (!auto_saving)
5110 #if 0 /* This causes trouble for GNUS. */
5111 /* If we've locked this file for some other buffer,
5112 query before proceeding. */
5113 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5114 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5115 #endif
5117 lock_file (lockname);
5119 #endif /* CLASH_DETECTION */
5121 encoded_filename = ENCODE_FILE (filename);
5123 fn = SDATA (encoded_filename);
5124 desc = -1;
5125 if (!NILP (append))
5126 #ifdef DOS_NT
5127 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5128 #else /* not DOS_NT */
5129 desc = emacs_open (fn, O_WRONLY, 0);
5130 #endif /* not DOS_NT */
5132 if (desc < 0 && (NILP (append) || errno == ENOENT))
5133 #ifdef VMS
5134 if (auto_saving) /* Overwrite any previous version of autosave file */
5136 vms_truncate (fn); /* if fn exists, truncate to zero length */
5137 desc = emacs_open (fn, O_RDWR, 0);
5138 if (desc < 0)
5139 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5140 ? SDATA (current_buffer->filename) : 0,
5141 fn);
5143 else /* Write to temporary name and rename if no errors */
5145 Lisp_Object temp_name;
5146 temp_name = Ffile_name_directory (filename);
5148 if (!NILP (temp_name))
5150 temp_name = Fmake_temp_name (concat2 (temp_name,
5151 build_string ("$$SAVE$$")));
5152 fname = SDATA (filename);
5153 fn = SDATA (temp_name);
5154 desc = creat_copy_attrs (fname, fn);
5155 if (desc < 0)
5157 /* If we can't open the temporary file, try creating a new
5158 version of the original file. VMS "creat" creates a
5159 new version rather than truncating an existing file. */
5160 fn = fname;
5161 fname = 0;
5162 desc = creat (fn, 0666);
5163 #if 0 /* This can clobber an existing file and fail to replace it,
5164 if the user runs out of space. */
5165 if (desc < 0)
5167 /* We can't make a new version;
5168 try to truncate and rewrite existing version if any. */
5169 vms_truncate (fn);
5170 desc = emacs_open (fn, O_RDWR, 0);
5172 #endif
5175 else
5176 desc = creat (fn, 0666);
5178 #else /* not VMS */
5179 #ifdef DOS_NT
5180 desc = emacs_open (fn,
5181 O_WRONLY | O_CREAT | buffer_file_type
5182 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5183 S_IREAD | S_IWRITE);
5184 #else /* not DOS_NT */
5185 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5186 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5187 auto_saving ? auto_save_mode_bits : 0666);
5188 #endif /* not DOS_NT */
5189 #endif /* not VMS */
5191 if (desc < 0)
5193 #ifdef CLASH_DETECTION
5194 save_errno = errno;
5195 if (!auto_saving) unlock_file (lockname);
5196 errno = save_errno;
5197 #endif /* CLASH_DETECTION */
5198 UNGCPRO;
5199 report_file_error ("Opening output file", Fcons (filename, Qnil));
5202 record_unwind_protect (close_file_unwind, make_number (desc));
5204 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5206 long ret;
5208 if (NUMBERP (append))
5209 ret = lseek (desc, XINT (append), 1);
5210 else
5211 ret = lseek (desc, 0, 2);
5212 if (ret < 0)
5214 #ifdef CLASH_DETECTION
5215 if (!auto_saving) unlock_file (lockname);
5216 #endif /* CLASH_DETECTION */
5217 UNGCPRO;
5218 report_file_error ("Lseek error", Fcons (filename, Qnil));
5222 UNGCPRO;
5224 #ifdef VMS
5226 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5227 * if we do writes that don't end with a carriage return. Furthermore
5228 * it cannot handle writes of more then 16K. The modified
5229 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5230 * this EXCEPT for the last record (if it doesn't end with a carriage
5231 * return). This implies that if your buffer doesn't end with a carriage
5232 * return, you get one free... tough. However it also means that if
5233 * we make two calls to sys_write (a la the following code) you can
5234 * get one at the gap as well. The easiest way to fix this (honest)
5235 * is to move the gap to the next newline (or the end of the buffer).
5236 * Thus this change.
5238 * Yech!
5240 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5241 move_gap (find_next_newline (GPT, 1));
5242 #else
5243 #if 0
5244 /* The new encoding routine doesn't require the following. */
5246 /* Whether VMS or not, we must move the gap to the next of newline
5247 when we must put designation sequences at beginning of line. */
5248 if (INTEGERP (start)
5249 && coding.type == coding_type_iso2022
5250 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5251 && GPT > BEG && GPT_ADDR[-1] != '\n')
5253 int opoint = PT, opoint_byte = PT_BYTE;
5254 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5255 move_gap_both (PT, PT_BYTE);
5256 SET_PT_BOTH (opoint, opoint_byte);
5258 #endif
5259 #endif
5261 failure = 0;
5262 immediate_quit = 1;
5264 if (STRINGP (start))
5266 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5267 &annotations, &coding);
5268 save_errno = errno;
5270 else if (XINT (start) != XINT (end))
5272 failure = 0 > a_write (desc, Qnil,
5273 XINT (start), XINT (end) - XINT (start),
5274 &annotations, &coding);
5275 save_errno = errno;
5277 else
5279 /* If file was empty, still need to write the annotations */
5280 coding.mode |= CODING_MODE_LAST_BLOCK;
5281 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5282 save_errno = errno;
5285 if (CODING_REQUIRE_FLUSHING (&coding)
5286 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5287 && ! failure)
5289 /* We have to flush out a data. */
5290 coding.mode |= CODING_MODE_LAST_BLOCK;
5291 failure = 0 > e_write (desc, Qnil, 1, 1, &coding);
5292 save_errno = errno;
5295 immediate_quit = 0;
5297 #ifdef HAVE_FSYNC
5298 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5299 Disk full in NFS may be reported here. */
5300 /* mib says that closing the file will try to write as fast as NFS can do
5301 it, and that means the fsync here is not crucial for autosave files. */
5302 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5304 /* If fsync fails with EINTR, don't treat that as serious. Also
5305 ignore EINVAL which happens when fsync is not supported on this
5306 file. */
5307 if (errno != EINTR && errno != EINVAL)
5308 failure = 1, save_errno = errno;
5310 #endif
5312 /* Spurious "file has changed on disk" warnings have been
5313 observed on Suns as well.
5314 It seems that `close' can change the modtime, under nfs.
5316 (This has supposedly been fixed in Sunos 4,
5317 but who knows about all the other machines with NFS?) */
5318 #if 0
5320 /* On VMS, must do the stat after the close
5321 since closing changes the modtime. */
5322 #ifndef VMS
5323 /* Recall that #if defined does not work on VMS. */
5324 #define FOO
5325 fstat (desc, &st);
5326 #endif
5327 #endif
5329 /* NFS can report a write failure now. */
5330 if (emacs_close (desc) < 0)
5331 failure = 1, save_errno = errno;
5333 #ifdef VMS
5334 /* If we wrote to a temporary name and had no errors, rename to real name. */
5335 if (fname)
5337 if (!failure)
5338 failure = (rename (fn, fname) != 0), save_errno = errno;
5339 fn = fname;
5341 #endif /* VMS */
5343 #ifndef FOO
5344 stat (fn, &st);
5345 #endif
5346 /* Discard the unwind protect for close_file_unwind. */
5347 specpdl_ptr = specpdl + count1;
5348 /* Restore the original current buffer. */
5349 visit_file = unbind_to (count, visit_file);
5351 #ifdef CLASH_DETECTION
5352 if (!auto_saving)
5353 unlock_file (lockname);
5354 #endif /* CLASH_DETECTION */
5356 /* Do this before reporting IO error
5357 to avoid a "file has changed on disk" warning on
5358 next attempt to save. */
5359 if (visiting)
5360 current_buffer->modtime = st.st_mtime;
5362 if (failure)
5363 error ("IO error writing %s: %s", SDATA (filename),
5364 emacs_strerror (save_errno));
5366 if (visiting)
5368 SAVE_MODIFF = MODIFF;
5369 XSETFASTINT (current_buffer->save_length, Z - BEG);
5370 current_buffer->filename = visit_file;
5371 update_mode_lines++;
5373 else if (quietly)
5375 if (auto_saving
5376 && ! NILP (Fstring_equal (current_buffer->filename,
5377 current_buffer->auto_save_file_name)))
5378 SAVE_MODIFF = MODIFF;
5380 return Qnil;
5383 if (!auto_saving)
5384 message_with_string ((INTEGERP (append)
5385 ? "Updated %s"
5386 : ! NILP (append)
5387 ? "Added to %s"
5388 : "Wrote %s"),
5389 visit_file, 1);
5391 return Qnil;
5394 Lisp_Object merge ();
5396 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5397 doc: /* Return t if (car A) is numerically less than (car B). */)
5398 (a, b)
5399 Lisp_Object a, b;
5401 return Flss (Fcar (a), Fcar (b));
5404 /* Build the complete list of annotations appropriate for writing out
5405 the text between START and END, by calling all the functions in
5406 write-region-annotate-functions and merging the lists they return.
5407 If one of these functions switches to a different buffer, we assume
5408 that buffer contains altered text. Therefore, the caller must
5409 make sure to restore the current buffer in all cases,
5410 as save-excursion would do. */
5412 static Lisp_Object
5413 build_annotations (start, end)
5414 Lisp_Object start, end;
5416 Lisp_Object annotations;
5417 Lisp_Object p, res;
5418 struct gcpro gcpro1, gcpro2;
5419 Lisp_Object original_buffer;
5420 int i, used_global = 0;
5422 XSETBUFFER (original_buffer, current_buffer);
5424 annotations = Qnil;
5425 p = Vwrite_region_annotate_functions;
5426 GCPRO2 (annotations, p);
5427 while (CONSP (p))
5429 struct buffer *given_buffer = current_buffer;
5430 if (EQ (Qt, XCAR (p)) && !used_global)
5431 { /* Use the global value of the hook. */
5432 Lisp_Object arg[2];
5433 used_global = 1;
5434 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5435 arg[1] = XCDR (p);
5436 p = Fappend (2, arg);
5437 continue;
5439 Vwrite_region_annotations_so_far = annotations;
5440 res = call2 (XCAR (p), start, end);
5441 /* If the function makes a different buffer current,
5442 assume that means this buffer contains altered text to be output.
5443 Reset START and END from the buffer bounds
5444 and discard all previous annotations because they should have
5445 been dealt with by this function. */
5446 if (current_buffer != given_buffer)
5448 XSETFASTINT (start, BEGV);
5449 XSETFASTINT (end, ZV);
5450 annotations = Qnil;
5452 Flength (res); /* Check basic validity of return value */
5453 annotations = merge (annotations, res, Qcar_less_than_car);
5454 p = XCDR (p);
5457 /* Now do the same for annotation functions implied by the file-format */
5458 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5459 p = current_buffer->auto_save_file_format;
5460 else
5461 p = current_buffer->file_format;
5462 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5464 struct buffer *given_buffer = current_buffer;
5466 Vwrite_region_annotations_so_far = annotations;
5468 /* Value is either a list of annotations or nil if the function
5469 has written annotations to a temporary buffer, which is now
5470 current. */
5471 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5472 original_buffer, make_number (i));
5473 if (current_buffer != given_buffer)
5475 XSETFASTINT (start, BEGV);
5476 XSETFASTINT (end, ZV);
5477 annotations = Qnil;
5480 if (CONSP (res))
5481 annotations = merge (annotations, res, Qcar_less_than_car);
5484 UNGCPRO;
5485 return annotations;
5489 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5490 If STRING is nil, POS is the character position in the current buffer.
5491 Intersperse with them the annotations from *ANNOT
5492 which fall within the range of POS to POS + NCHARS,
5493 each at its appropriate position.
5495 We modify *ANNOT by discarding elements as we use them up.
5497 The return value is negative in case of system call failure. */
5499 static int
5500 a_write (desc, string, pos, nchars, annot, coding)
5501 int desc;
5502 Lisp_Object string;
5503 register int nchars;
5504 int pos;
5505 Lisp_Object *annot;
5506 struct coding_system *coding;
5508 Lisp_Object tem;
5509 int nextpos;
5510 int lastpos = pos + nchars;
5512 while (NILP (*annot) || CONSP (*annot))
5514 tem = Fcar_safe (Fcar (*annot));
5515 nextpos = pos - 1;
5516 if (INTEGERP (tem))
5517 nextpos = XFASTINT (tem);
5519 /* If there are no more annotations in this range,
5520 output the rest of the range all at once. */
5521 if (! (nextpos >= pos && nextpos <= lastpos))
5522 return e_write (desc, string, pos, lastpos, coding);
5524 /* Output buffer text up to the next annotation's position. */
5525 if (nextpos > pos)
5527 if (0 > e_write (desc, string, pos, nextpos, coding))
5528 return -1;
5529 pos = nextpos;
5531 /* Output the annotation. */
5532 tem = Fcdr (Fcar (*annot));
5533 if (STRINGP (tem))
5535 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5536 return -1;
5538 *annot = Fcdr (*annot);
5540 return 0;
5544 /* Write text in the range START and END into descriptor DESC,
5545 encoding them with coding system CODING. If STRING is nil, START
5546 and END are character positions of the current buffer, else they
5547 are indexes to the string STRING. */
5549 static int
5550 e_write (desc, string, start, end, coding)
5551 int desc;
5552 Lisp_Object string;
5553 int start, end;
5554 struct coding_system *coding;
5556 if (STRINGP (string))
5558 start = 0;
5559 end = SCHARS (string);
5562 /* We used to have a code for handling selective display here. But,
5563 now it is handled within encode_coding. */
5565 while (start < end)
5567 if (STRINGP (string))
5569 coding->src_multibyte = SCHARS (string) < SBYTES (string);
5570 if (CODING_REQUIRE_ENCODING (coding))
5572 encode_coding_object (coding, string,
5573 start, string_char_to_byte (string, start),
5574 end, string_char_to_byte (string, end), Qt);
5576 else
5578 coding->dst_object = string;
5579 coding->consumed_char = SCHARS (string);
5580 coding->produced = SBYTES (string);
5583 else
5585 int start_byte = CHAR_TO_BYTE (start);
5586 int end_byte = CHAR_TO_BYTE (end);
5588 coding->src_multibyte = (end - start) < (end_byte - start_byte);
5589 if (CODING_REQUIRE_ENCODING (coding))
5591 encode_coding_object (coding, Fcurrent_buffer (),
5592 start, start_byte, end, end_byte, Qt);
5594 else
5596 coding->dst_object = Qnil;
5597 coding->dst_pos_byte = start_byte;
5598 if (start >= GPT || end <= GPT)
5600 coding->consumed_char = end - start;
5601 coding->produced = end_byte - start_byte;
5603 else
5605 coding->consumed_char = GPT - start;
5606 coding->produced = GPT_BYTE - start_byte;
5611 if (coding->produced > 0)
5613 coding->produced -=
5614 emacs_write (desc,
5615 STRINGP (coding->dst_object)
5616 ? SDATA (coding->dst_object)
5617 : BYTE_POS_ADDR (coding->dst_pos_byte),
5618 coding->produced);
5620 if (coding->produced)
5621 return -1;
5623 start += coding->consumed_char;
5626 return 0;
5629 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5630 Sverify_visited_file_modtime, 1, 1, 0,
5631 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5632 This means that the file has not been changed since it was visited or saved.
5633 See Info node `(elisp)Modification Time' for more details. */)
5634 (buf)
5635 Lisp_Object buf;
5637 struct buffer *b;
5638 struct stat st;
5639 Lisp_Object handler;
5640 Lisp_Object filename;
5642 CHECK_BUFFER (buf);
5643 b = XBUFFER (buf);
5645 if (!STRINGP (b->filename)) return Qt;
5646 if (b->modtime == 0) return Qt;
5648 /* If the file name has special constructs in it,
5649 call the corresponding file handler. */
5650 handler = Ffind_file_name_handler (b->filename,
5651 Qverify_visited_file_modtime);
5652 if (!NILP (handler))
5653 return call2 (handler, Qverify_visited_file_modtime, buf);
5655 filename = ENCODE_FILE (b->filename);
5657 if (stat (SDATA (filename), &st) < 0)
5659 /* If the file doesn't exist now and didn't exist before,
5660 we say that it isn't modified, provided the error is a tame one. */
5661 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5662 st.st_mtime = -1;
5663 else
5664 st.st_mtime = 0;
5666 if (st.st_mtime == b->modtime
5667 /* If both are positive, accept them if they are off by one second. */
5668 || (st.st_mtime > 0 && b->modtime > 0
5669 && (st.st_mtime == b->modtime + 1
5670 || st.st_mtime == b->modtime - 1)))
5671 return Qt;
5672 return Qnil;
5675 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5676 Sclear_visited_file_modtime, 0, 0, 0,
5677 doc: /* Clear out records of last mod time of visited file.
5678 Next attempt to save will certainly not complain of a discrepancy. */)
5681 current_buffer->modtime = 0;
5682 return Qnil;
5685 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5686 Svisited_file_modtime, 0, 0, 0,
5687 doc: /* Return the current buffer's recorded visited file modification time.
5688 The value is a list of the form (HIGH LOW), like the time values
5689 that `file-attributes' returns. If the current buffer has no recorded
5690 file modification time, this function returns 0.
5691 See Info node `(elisp)Modification Time' for more details. */)
5694 if (! current_buffer->modtime)
5695 return make_number (0);
5696 return make_time ((time_t) current_buffer->modtime);
5699 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5700 Sset_visited_file_modtime, 0, 1, 0,
5701 doc: /* Update buffer's recorded modification time from the visited file's time.
5702 Useful if the buffer was not read from the file normally
5703 or if the file itself has been changed for some known benign reason.
5704 An argument specifies the modification time value to use
5705 \(instead of that of the visited file), in the form of a list
5706 \(HIGH . LOW) or (HIGH LOW). */)
5707 (time_list)
5708 Lisp_Object time_list;
5710 if (!NILP (time_list))
5711 current_buffer->modtime = cons_to_long (time_list);
5712 else
5714 register Lisp_Object filename;
5715 struct stat st;
5716 Lisp_Object handler;
5718 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5720 /* If the file name has special constructs in it,
5721 call the corresponding file handler. */
5722 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5723 if (!NILP (handler))
5724 /* The handler can find the file name the same way we did. */
5725 return call2 (handler, Qset_visited_file_modtime, Qnil);
5727 filename = ENCODE_FILE (filename);
5729 if (stat (SDATA (filename), &st) >= 0)
5730 current_buffer->modtime = st.st_mtime;
5733 return Qnil;
5736 Lisp_Object
5737 auto_save_error (error)
5738 Lisp_Object error;
5740 Lisp_Object args[3], msg;
5741 int i, nbytes;
5742 struct gcpro gcpro1;
5743 char *msgbuf;
5744 USE_SAFE_ALLOCA;
5746 auto_save_error_occurred = 1;
5748 ring_bell (XFRAME (selected_frame));
5750 args[0] = build_string ("Auto-saving %s: %s");
5751 args[1] = current_buffer->name;
5752 args[2] = Ferror_message_string (error);
5753 msg = Fformat (3, args);
5754 GCPRO1 (msg);
5755 nbytes = SBYTES (msg);
5756 SAFE_ALLOCA (msgbuf, char *, nbytes);
5757 bcopy (SDATA (msg), msgbuf, nbytes);
5759 for (i = 0; i < 3; ++i)
5761 if (i == 0)
5762 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5763 else
5764 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5765 Fsleep_for (make_number (1), Qnil);
5768 SAFE_FREE ();
5769 UNGCPRO;
5770 return Qnil;
5773 Lisp_Object
5774 auto_save_1 ()
5776 struct stat st;
5777 Lisp_Object modes;
5779 auto_save_mode_bits = 0666;
5781 /* Get visited file's mode to become the auto save file's mode. */
5782 if (! NILP (current_buffer->filename))
5784 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5785 /* But make sure we can overwrite it later! */
5786 auto_save_mode_bits = st.st_mode | 0600;
5787 else if ((modes = Ffile_modes (current_buffer->filename),
5788 INTEGERP (modes)))
5789 /* Remote files don't cooperate with stat. */
5790 auto_save_mode_bits = XINT (modes) | 0600;
5793 return
5794 Fwrite_region (Qnil, Qnil,
5795 current_buffer->auto_save_file_name,
5796 Qnil, Qlambda, Qnil, Qnil);
5799 static Lisp_Object
5800 do_auto_save_unwind (arg) /* used as unwind-protect function */
5801 Lisp_Object arg;
5803 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5804 auto_saving = 0;
5805 if (stream != NULL)
5807 BLOCK_INPUT;
5808 fclose (stream);
5809 UNBLOCK_INPUT;
5811 return Qnil;
5814 static Lisp_Object
5815 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5816 Lisp_Object value;
5818 minibuffer_auto_raise = XINT (value);
5819 return Qnil;
5822 static Lisp_Object
5823 do_auto_save_make_dir (dir)
5824 Lisp_Object dir;
5826 Lisp_Object mode;
5828 call2 (Qmake_directory, dir, Qt);
5829 XSETFASTINT (mode, 0700);
5830 return Fset_file_modes (dir, mode);
5833 static Lisp_Object
5834 do_auto_save_eh (ignore)
5835 Lisp_Object ignore;
5837 return Qnil;
5840 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5841 doc: /* Auto-save all buffers that need it.
5842 This is all buffers that have auto-saving enabled
5843 and are changed since last auto-saved.
5844 Auto-saving writes the buffer into a file
5845 so that your editing is not lost if the system crashes.
5846 This file is not the file you visited; that changes only when you save.
5847 Normally we run the normal hook `auto-save-hook' before saving.
5849 A non-nil NO-MESSAGE argument means do not print any message if successful.
5850 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5851 (no_message, current_only)
5852 Lisp_Object no_message, current_only;
5854 struct buffer *old = current_buffer, *b;
5855 Lisp_Object tail, buf;
5856 int auto_saved = 0;
5857 int do_handled_files;
5858 Lisp_Object oquit;
5859 FILE *stream = NULL;
5860 int count = SPECPDL_INDEX ();
5861 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5862 int old_message_p = 0;
5863 struct gcpro gcpro1, gcpro2;
5865 if (max_specpdl_size < specpdl_size + 40)
5866 max_specpdl_size = specpdl_size + 40;
5868 if (minibuf_level)
5869 no_message = Qt;
5871 if (NILP (no_message))
5873 old_message_p = push_message ();
5874 record_unwind_protect (pop_message_unwind, Qnil);
5877 /* Ordinarily don't quit within this function,
5878 but don't make it impossible to quit (in case we get hung in I/O). */
5879 oquit = Vquit_flag;
5880 Vquit_flag = Qnil;
5882 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5883 point to non-strings reached from Vbuffer_alist. */
5885 if (!NILP (Vrun_hooks))
5886 call1 (Vrun_hooks, intern ("auto-save-hook"));
5888 if (STRINGP (Vauto_save_list_file_name))
5890 Lisp_Object listfile;
5892 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5894 /* Don't try to create the directory when shutting down Emacs,
5895 because creating the directory might signal an error, and
5896 that would leave Emacs in a strange state. */
5897 if (!NILP (Vrun_hooks))
5899 Lisp_Object dir;
5900 dir = Qnil;
5901 GCPRO2 (dir, listfile);
5902 dir = Ffile_name_directory (listfile);
5903 if (NILP (Ffile_directory_p (dir)))
5904 internal_condition_case_1 (do_auto_save_make_dir,
5905 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5906 do_auto_save_eh);
5907 UNGCPRO;
5910 stream = fopen (SDATA (listfile), "w");
5913 record_unwind_protect (do_auto_save_unwind,
5914 make_save_value (stream, 0));
5915 record_unwind_protect (do_auto_save_unwind_1,
5916 make_number (minibuffer_auto_raise));
5917 minibuffer_auto_raise = 0;
5918 auto_saving = 1;
5919 auto_save_error_occurred = 0;
5921 /* On first pass, save all files that don't have handlers.
5922 On second pass, save all files that do have handlers.
5924 If Emacs is crashing, the handlers may tweak what is causing
5925 Emacs to crash in the first place, and it would be a shame if
5926 Emacs failed to autosave perfectly ordinary files because it
5927 couldn't handle some ange-ftp'd file. */
5929 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5930 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
5932 buf = XCDR (XCAR (tail));
5933 b = XBUFFER (buf);
5935 /* Record all the buffers that have auto save mode
5936 in the special file that lists them. For each of these buffers,
5937 Record visited name (if any) and auto save name. */
5938 if (STRINGP (b->auto_save_file_name)
5939 && stream != NULL && do_handled_files == 0)
5941 BLOCK_INPUT;
5942 if (!NILP (b->filename))
5944 fwrite (SDATA (b->filename), 1,
5945 SBYTES (b->filename), stream);
5947 putc ('\n', stream);
5948 fwrite (SDATA (b->auto_save_file_name), 1,
5949 SBYTES (b->auto_save_file_name), stream);
5950 putc ('\n', stream);
5951 UNBLOCK_INPUT;
5954 if (!NILP (current_only)
5955 && b != current_buffer)
5956 continue;
5958 /* Don't auto-save indirect buffers.
5959 The base buffer takes care of it. */
5960 if (b->base_buffer)
5961 continue;
5963 /* Check for auto save enabled
5964 and file changed since last auto save
5965 and file changed since last real save. */
5966 if (STRINGP (b->auto_save_file_name)
5967 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5968 && b->auto_save_modified < BUF_MODIFF (b)
5969 /* -1 means we've turned off autosaving for a while--see below. */
5970 && XINT (b->save_length) >= 0
5971 && (do_handled_files
5972 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5973 Qwrite_region))))
5975 EMACS_TIME before_time, after_time;
5977 EMACS_GET_TIME (before_time);
5979 /* If we had a failure, don't try again for 20 minutes. */
5980 if (b->auto_save_failure_time >= 0
5981 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5982 continue;
5984 if ((XFASTINT (b->save_length) * 10
5985 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5986 /* A short file is likely to change a large fraction;
5987 spare the user annoying messages. */
5988 && XFASTINT (b->save_length) > 5000
5989 /* These messages are frequent and annoying for `*mail*'. */
5990 && !EQ (b->filename, Qnil)
5991 && NILP (no_message))
5993 /* It has shrunk too much; turn off auto-saving here. */
5994 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5995 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5996 b->name, 1);
5997 minibuffer_auto_raise = 0;
5998 /* Turn off auto-saving until there's a real save,
5999 and prevent any more warnings. */
6000 XSETINT (b->save_length, -1);
6001 Fsleep_for (make_number (1), Qnil);
6002 continue;
6004 set_buffer_internal (b);
6005 if (!auto_saved && NILP (no_message))
6006 message1 ("Auto-saving...");
6007 internal_condition_case (auto_save_1, Qt, auto_save_error);
6008 auto_saved++;
6009 b->auto_save_modified = BUF_MODIFF (b);
6010 XSETFASTINT (current_buffer->save_length, Z - BEG);
6011 set_buffer_internal (old);
6013 EMACS_GET_TIME (after_time);
6015 /* If auto-save took more than 60 seconds,
6016 assume it was an NFS failure that got a timeout. */
6017 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6018 b->auto_save_failure_time = EMACS_SECS (after_time);
6022 /* Prevent another auto save till enough input events come in. */
6023 record_auto_save ();
6025 if (auto_saved && NILP (no_message))
6027 if (old_message_p)
6029 /* If we are going to restore an old message,
6030 give time to read ours. */
6031 sit_for (make_number (1), 0, 0);
6032 restore_message ();
6034 else if (!auto_save_error_occurred)
6035 /* Don't overwrite the error message if an error occurred.
6036 If we displayed a message and then restored a state
6037 with no message, leave a "done" message on the screen. */
6038 message1 ("Auto-saving...done");
6041 Vquit_flag = oquit;
6043 /* This restores the message-stack status. */
6044 unbind_to (count, Qnil);
6045 return Qnil;
6048 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6049 Sset_buffer_auto_saved, 0, 0, 0,
6050 doc: /* Mark current buffer as auto-saved with its current text.
6051 No auto-save file will be written until the buffer changes again. */)
6054 current_buffer->auto_save_modified = MODIFF;
6055 XSETFASTINT (current_buffer->save_length, Z - BEG);
6056 current_buffer->auto_save_failure_time = -1;
6057 return Qnil;
6060 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6061 Sclear_buffer_auto_save_failure, 0, 0, 0,
6062 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6065 current_buffer->auto_save_failure_time = -1;
6066 return Qnil;
6069 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6070 0, 0, 0,
6071 doc: /* Return t if current buffer has been auto-saved recently.
6072 More precisely, if it has been auto-saved since last read from or saved
6073 in the visited file. If the buffer has no visited file,
6074 then any auto-save counts as "recent". */)
6077 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6080 /* Reading and completing file names */
6082 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6083 Snext_read_file_uses_dialog_p, 0, 0, 0,
6084 doc: /* Return t if a call to `read-file-name' will use a dialog.
6085 The return value is only relevant for a call to `read-file-name' that happens
6086 before any other event (mouse or keypress) is handeled. */)
6089 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6090 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6091 && use_dialog_box
6092 && use_file_dialog
6093 && have_menus_p ())
6094 return Qt;
6095 #endif
6096 return Qnil;
6099 Lisp_Object
6100 Fread_file_name (prompt, dir, default_filename, mustmatch, initial, predicate)
6101 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6103 struct gcpro gcpro1, gcpro2;
6104 Lisp_Object args[7];
6106 GCPRO1 (default_filename);
6107 args[0] = intern ("read-file-name");
6108 args[1] = prompt;
6109 args[2] = dir;
6110 args[3] = default_filename;
6111 args[4] = mustmatch;
6112 args[5] = initial;
6113 args[6] = predicate;
6114 RETURN_UNGCPRO (Ffuncall (7, args));
6118 void
6119 init_fileio_once ()
6121 /* Must be set before any path manipulation is performed. */
6122 XSETFASTINT (Vdirectory_sep_char, '/');
6126 void
6127 syms_of_fileio ()
6129 Qoperations = intern ("operations");
6130 Qexpand_file_name = intern ("expand-file-name");
6131 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6132 Qdirectory_file_name = intern ("directory-file-name");
6133 Qfile_name_directory = intern ("file-name-directory");
6134 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6135 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6136 Qfile_name_as_directory = intern ("file-name-as-directory");
6137 Qcopy_file = intern ("copy-file");
6138 Qmake_directory_internal = intern ("make-directory-internal");
6139 Qmake_directory = intern ("make-directory");
6140 Qdelete_directory = intern ("delete-directory");
6141 Qdelete_file = intern ("delete-file");
6142 Qrename_file = intern ("rename-file");
6143 Qadd_name_to_file = intern ("add-name-to-file");
6144 Qmake_symbolic_link = intern ("make-symbolic-link");
6145 Qfile_exists_p = intern ("file-exists-p");
6146 Qfile_executable_p = intern ("file-executable-p");
6147 Qfile_readable_p = intern ("file-readable-p");
6148 Qfile_writable_p = intern ("file-writable-p");
6149 Qfile_symlink_p = intern ("file-symlink-p");
6150 Qaccess_file = intern ("access-file");
6151 Qfile_directory_p = intern ("file-directory-p");
6152 Qfile_regular_p = intern ("file-regular-p");
6153 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6154 Qfile_modes = intern ("file-modes");
6155 Qset_file_modes = intern ("set-file-modes");
6156 Qset_file_times = intern ("set-file-times");
6157 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6158 Qinsert_file_contents = intern ("insert-file-contents");
6159 Qwrite_region = intern ("write-region");
6160 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6161 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6162 Qauto_save_coding = intern ("auto-save-coding");
6164 staticpro (&Qoperations);
6165 staticpro (&Qexpand_file_name);
6166 staticpro (&Qsubstitute_in_file_name);
6167 staticpro (&Qdirectory_file_name);
6168 staticpro (&Qfile_name_directory);
6169 staticpro (&Qfile_name_nondirectory);
6170 staticpro (&Qunhandled_file_name_directory);
6171 staticpro (&Qfile_name_as_directory);
6172 staticpro (&Qcopy_file);
6173 staticpro (&Qmake_directory_internal);
6174 staticpro (&Qmake_directory);
6175 staticpro (&Qdelete_directory);
6176 staticpro (&Qdelete_file);
6177 staticpro (&Qrename_file);
6178 staticpro (&Qadd_name_to_file);
6179 staticpro (&Qmake_symbolic_link);
6180 staticpro (&Qfile_exists_p);
6181 staticpro (&Qfile_executable_p);
6182 staticpro (&Qfile_readable_p);
6183 staticpro (&Qfile_writable_p);
6184 staticpro (&Qaccess_file);
6185 staticpro (&Qfile_symlink_p);
6186 staticpro (&Qfile_directory_p);
6187 staticpro (&Qfile_regular_p);
6188 staticpro (&Qfile_accessible_directory_p);
6189 staticpro (&Qfile_modes);
6190 staticpro (&Qset_file_modes);
6191 staticpro (&Qset_file_times);
6192 staticpro (&Qfile_newer_than_file_p);
6193 staticpro (&Qinsert_file_contents);
6194 staticpro (&Qwrite_region);
6195 staticpro (&Qverify_visited_file_modtime);
6196 staticpro (&Qset_visited_file_modtime);
6197 staticpro (&Qauto_save_coding);
6199 Qfile_name_history = intern ("file-name-history");
6200 Fset (Qfile_name_history, Qnil);
6201 staticpro (&Qfile_name_history);
6203 Qfile_error = intern ("file-error");
6204 staticpro (&Qfile_error);
6205 Qfile_already_exists = intern ("file-already-exists");
6206 staticpro (&Qfile_already_exists);
6207 Qfile_date_error = intern ("file-date-error");
6208 staticpro (&Qfile_date_error);
6209 Qexcl = intern ("excl");
6210 staticpro (&Qexcl);
6212 #ifdef DOS_NT
6213 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6214 staticpro (&Qfind_buffer_file_type);
6215 #endif /* DOS_NT */
6217 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6218 doc: /* *Coding system for encoding file names.
6219 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6220 Vfile_name_coding_system = Qnil;
6222 DEFVAR_LISP ("default-file-name-coding-system",
6223 &Vdefault_file_name_coding_system,
6224 doc: /* Default coding system for encoding file names.
6225 This variable is used only when `file-name-coding-system' is nil.
6227 This variable is set/changed by the command `set-language-environment'.
6228 User should not set this variable manually,
6229 instead use `file-name-coding-system' to get a constant encoding
6230 of file names regardless of the current language environment. */);
6231 Vdefault_file_name_coding_system = Qnil;
6233 Qformat_decode = intern ("format-decode");
6234 staticpro (&Qformat_decode);
6235 Qformat_annotate_function = intern ("format-annotate-function");
6236 staticpro (&Qformat_annotate_function);
6237 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6238 staticpro (&Qafter_insert_file_set_coding);
6240 Qcar_less_than_car = intern ("car-less-than-car");
6241 staticpro (&Qcar_less_than_car);
6243 Fput (Qfile_error, Qerror_conditions,
6244 list2 (Qfile_error, Qerror));
6245 Fput (Qfile_error, Qerror_message,
6246 build_string ("File error"));
6248 Fput (Qfile_already_exists, Qerror_conditions,
6249 list3 (Qfile_already_exists, Qfile_error, Qerror));
6250 Fput (Qfile_already_exists, Qerror_message,
6251 build_string ("File already exists"));
6253 Fput (Qfile_date_error, Qerror_conditions,
6254 list3 (Qfile_date_error, Qfile_error, Qerror));
6255 Fput (Qfile_date_error, Qerror_message,
6256 build_string ("Cannot set file date"));
6258 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6259 doc: /* *Non-nil means write new files with record format `stmlf'.
6260 nil means use format `var'. This variable is meaningful only on VMS. */);
6261 vms_stmlf_recfm = 0;
6263 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6264 doc: /* Directory separator character for built-in functions that return file names.
6265 The value is always ?/. Don't use this variable, just use `/'. */);
6267 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6268 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6269 If a file name matches REGEXP, then all I/O on that file is done by calling
6270 HANDLER.
6272 The first argument given to HANDLER is the name of the I/O primitive
6273 to be handled; the remaining arguments are the arguments that were
6274 passed to that primitive. For example, if you do
6275 (file-exists-p FILENAME)
6276 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6277 (funcall HANDLER 'file-exists-p FILENAME)
6278 The function `find-file-name-handler' checks this list for a handler
6279 for its argument. */);
6280 Vfile_name_handler_alist = Qnil;
6282 DEFVAR_LISP ("set-auto-coding-function",
6283 &Vset_auto_coding_function,
6284 doc: /* If non-nil, a function to call to decide a coding system of file.
6285 Two arguments are passed to this function: the file name
6286 and the length of a file contents following the point.
6287 This function should return a coding system to decode the file contents.
6288 It should check the file name against `auto-coding-alist'.
6289 If no coding system is decided, it should check a coding system
6290 specified in the heading lines with the format:
6291 -*- ... coding: CODING-SYSTEM; ... -*-
6292 or local variable spec of the tailing lines with `coding:' tag. */);
6293 Vset_auto_coding_function = Qnil;
6295 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6296 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6297 Each is passed one argument, the number of characters inserted,
6298 with point at the start of the inserted text. Each function
6299 should leave point the same, and return the new character count.
6300 If `insert-file-contents' is intercepted by a handler from
6301 `file-name-handler-alist', that handler is responsible for calling the
6302 functions in `after-insert-file-functions' if appropriate. */);
6303 Vafter_insert_file_functions = Qnil;
6305 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6306 doc: /* A list of functions to be called at the start of `write-region'.
6307 Each is passed two arguments, START and END as for `write-region'.
6308 These are usually two numbers but not always; see the documentation
6309 for `write-region'. The function should return a list of pairs
6310 of the form (POSITION . STRING), consisting of strings to be effectively
6311 inserted at the specified positions of the file being written (1 means to
6312 insert before the first byte written). The POSITIONs must be sorted into
6313 increasing order. If there are several functions in the list, the several
6314 lists are merged destructively. Alternatively, the function can return
6315 with a different buffer current; in that case it should pay attention
6316 to the annotations returned by previous functions and listed in
6317 `write-region-annotations-so-far'.*/);
6318 Vwrite_region_annotate_functions = Qnil;
6319 staticpro (&Qwrite_region_annotate_functions);
6320 Qwrite_region_annotate_functions
6321 = intern ("write-region-annotate-functions");
6323 DEFVAR_LISP ("write-region-annotations-so-far",
6324 &Vwrite_region_annotations_so_far,
6325 doc: /* When an annotation function is called, this holds the previous annotations.
6326 These are the annotations made by other annotation functions
6327 that were already called. See also `write-region-annotate-functions'. */);
6328 Vwrite_region_annotations_so_far = Qnil;
6330 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6331 doc: /* A list of file name handlers that temporarily should not be used.
6332 This applies only to the operation `inhibit-file-name-operation'. */);
6333 Vinhibit_file_name_handlers = Qnil;
6335 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6336 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6337 Vinhibit_file_name_operation = Qnil;
6339 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6340 doc: /* File name in which we write a list of all auto save file names.
6341 This variable is initialized automatically from `auto-save-list-file-prefix'
6342 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6343 a non-nil value. */);
6344 Vauto_save_list_file_name = Qnil;
6346 #ifdef HAVE_FSYNC
6347 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6348 doc: /* *Non-nil means don't call fsync in `write-region'.
6349 This variable affects calls to `write-region' as well as save commands.
6350 A non-nil value may result in data loss! */);
6351 write_region_inhibit_fsync = 0;
6352 #endif
6354 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash,
6355 doc: /* Specifies whether to use the system's trash can.
6356 When non-nil, the function `move-file-to-trash' will be used by
6357 `delete-file' and `delete-directory'. */);
6358 delete_by_moving_to_trash = 0;
6359 Qmove_file_to_trash = intern ("move-file-to-trash");
6360 staticpro (&Qmove_file_to_trash);
6362 defsubr (&Sfind_file_name_handler);
6363 defsubr (&Sfile_name_directory);
6364 defsubr (&Sfile_name_nondirectory);
6365 defsubr (&Sunhandled_file_name_directory);
6366 defsubr (&Sfile_name_as_directory);
6367 defsubr (&Sdirectory_file_name);
6368 defsubr (&Smake_temp_name);
6369 defsubr (&Sexpand_file_name);
6370 defsubr (&Ssubstitute_in_file_name);
6371 defsubr (&Scopy_file);
6372 defsubr (&Smake_directory_internal);
6373 defsubr (&Sdelete_directory);
6374 defsubr (&Sdelete_file);
6375 defsubr (&Srename_file);
6376 defsubr (&Sadd_name_to_file);
6377 defsubr (&Smake_symbolic_link);
6378 #ifdef VMS
6379 defsubr (&Sdefine_logical_name);
6380 #endif /* VMS */
6381 defsubr (&Sfile_name_absolute_p);
6382 defsubr (&Sfile_exists_p);
6383 defsubr (&Sfile_executable_p);
6384 defsubr (&Sfile_readable_p);
6385 defsubr (&Sfile_writable_p);
6386 defsubr (&Saccess_file);
6387 defsubr (&Sfile_symlink_p);
6388 defsubr (&Sfile_directory_p);
6389 defsubr (&Sfile_accessible_directory_p);
6390 defsubr (&Sfile_regular_p);
6391 defsubr (&Sfile_modes);
6392 defsubr (&Sset_file_modes);
6393 defsubr (&Sset_file_times);
6394 defsubr (&Sset_default_file_modes);
6395 defsubr (&Sdefault_file_modes);
6396 defsubr (&Sfile_newer_than_file_p);
6397 defsubr (&Sinsert_file_contents);
6398 defsubr (&Swrite_region);
6399 defsubr (&Scar_less_than_car);
6400 defsubr (&Sverify_visited_file_modtime);
6401 defsubr (&Sclear_visited_file_modtime);
6402 defsubr (&Svisited_file_modtime);
6403 defsubr (&Sset_visited_file_modtime);
6404 defsubr (&Sdo_auto_save);
6405 defsubr (&Sset_buffer_auto_saved);
6406 defsubr (&Sclear_buffer_auto_save_failure);
6407 defsubr (&Srecent_auto_save_p);
6409 defsubr (&Snext_read_file_uses_dialog_p);
6411 #ifdef HAVE_SYNC
6412 defsubr (&Sunix_sync);
6413 #endif
6416 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6417 (do not change this comment) */