*** empty log message ***
[emacs.git] / src / fileio.c
bloba44552010c747fe872773a2b27725031b8a25421
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985,86,87,88,93,94,95,96,97,98,99,2000,01,2003
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.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 VMS
49 #include "vms-pwd.h"
50 #else
51 #include <pwd.h>
52 #endif
54 #include <ctype.h>
56 #ifdef VMS
57 #include "vmsdir.h"
58 #include <perror.h>
59 #include <stddef.h>
60 #include <string.h>
61 #endif
63 #include <errno.h>
65 #ifndef vax11c
66 #ifndef USE_CRT_DLL
67 extern int errno;
68 #endif
69 #endif
71 #ifdef APOLLO
72 #include <sys/time.h>
73 #endif
75 #include "lisp.h"
76 #include "intervals.h"
77 #include "buffer.h"
78 #include "charset.h"
79 #include "coding.h"
80 #include "window.h"
82 #ifdef WINDOWSNT
83 #define NOMINMAX 1
84 #include <windows.h>
85 #include <stdlib.h>
86 #include <fcntl.h>
87 #endif /* not WINDOWSNT */
89 #ifdef MSDOS
90 #include "msdos.h"
91 #include <sys/param.h>
92 #if __DJGPP__ >= 2
93 #include <fcntl.h>
94 #include <string.h>
95 #endif
96 #endif
98 #ifdef DOS_NT
99 #define CORRECT_DIR_SEPS(s) \
100 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
101 else unixtodos_filename (s); \
102 } while (0)
103 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
104 redirector allows the six letters between 'Z' and 'a' as well. */
105 #ifdef MSDOS
106 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
107 #endif
108 #ifdef WINDOWSNT
109 #define IS_DRIVE(x) isalpha (x)
110 #endif
111 /* Need to lower-case the drive letter, or else expanded
112 filenames will sometimes compare inequal, because
113 `expand-file-name' doesn't always down-case the drive letter. */
114 #define DRIVE_LETTER(x) (tolower (x))
115 #endif
117 #ifdef VMS
118 #include <file.h>
119 #include <rmsdef.h>
120 #include <fab.h>
121 #include <nam.h>
122 #endif
124 #include "systime.h"
126 #ifdef HPUX
127 #include <netio.h>
128 #ifndef HPUX8
129 #ifndef HPUX9
130 #include <errnet.h>
131 #endif
132 #endif
133 #endif
135 #include "commands.h"
136 extern int use_dialog_box;
138 #ifndef O_WRONLY
139 #define O_WRONLY 1
140 #endif
142 #ifndef O_RDONLY
143 #define O_RDONLY 0
144 #endif
146 #ifndef S_ISLNK
147 # define lstat stat
148 #endif
150 /* Nonzero during writing of auto-save files */
151 int auto_saving;
153 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
154 a new file with the same mode as the original */
155 int auto_save_mode_bits;
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 /* Format for auto-save files */
176 Lisp_Object Vauto_save_file_format;
178 /* Lisp functions for translating file formats */
179 Lisp_Object Qformat_decode, Qformat_annotate_function;
181 /* Function to be called to decide a coding system of a reading file. */
182 Lisp_Object Vset_auto_coding_function;
184 /* Functions to be called to process text properties in inserted file. */
185 Lisp_Object Vafter_insert_file_functions;
187 /* Lisp function for setting buffer-file-coding-system and the
188 multibyteness of the current buffer after inserting a file. */
189 Lisp_Object Qafter_insert_file_set_coding;
191 /* Functions to be called to create text property annotations for file. */
192 Lisp_Object Vwrite_region_annotate_functions;
193 Lisp_Object Qwrite_region_annotate_functions;
195 /* During build_annotations, each time an annotation function is called,
196 this holds the annotations made by the previous functions. */
197 Lisp_Object Vwrite_region_annotations_so_far;
199 /* File name in which we write a list of all our auto save files. */
200 Lisp_Object Vauto_save_list_file_name;
202 /* Function to call to read a file name. */
203 Lisp_Object Vread_file_name_function;
205 /* Current predicate used by read_file_name_internal. */
206 Lisp_Object Vread_file_name_predicate;
208 /* Nonzero means, when reading a filename in the minibuffer,
209 start out by inserting the default directory into the minibuffer. */
210 int insert_default_directory;
212 /* On VMS, nonzero means write new files with record format stmlf.
213 Zero means use var format. */
214 int vms_stmlf_recfm;
216 /* On NT, specifies the directory separator character, used (eg.) when
217 expanding file names. This can be bound to / or \. */
218 Lisp_Object Vdirectory_sep_char;
220 extern Lisp_Object Vuser_login_name;
222 #ifdef WINDOWSNT
223 extern Lisp_Object Vw32_get_true_file_attributes;
224 #endif
226 extern int minibuf_level;
228 extern int minibuffer_auto_raise;
230 /* These variables describe handlers that have "already" had a chance
231 to handle the current operation.
233 Vinhibit_file_name_handlers is a list of file name handlers.
234 Vinhibit_file_name_operation is the operation being handled.
235 If we try to handle that operation, we ignore those handlers. */
237 static Lisp_Object Vinhibit_file_name_handlers;
238 static Lisp_Object Vinhibit_file_name_operation;
240 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
241 Lisp_Object Qexcl;
242 Lisp_Object Qfile_name_history;
244 Lisp_Object Qcar_less_than_car;
246 static int a_write P_ ((int, Lisp_Object, int, int,
247 Lisp_Object *, struct coding_system *));
248 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
251 void
252 report_file_error (string, data)
253 const char *string;
254 Lisp_Object data;
256 Lisp_Object errstring;
257 int errorno = errno;
259 synchronize_system_messages_locale ();
260 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
261 Vlocale_coding_system, 0);
263 while (1)
264 switch (errorno)
266 case EEXIST:
267 Fsignal (Qfile_already_exists, Fcons (errstring, data));
268 break;
269 default:
270 /* System error messages are capitalized. Downcase the initial
271 unless it is followed by a slash. */
272 if (SREF (errstring, 1) != '/')
273 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
275 Fsignal (Qfile_error,
276 Fcons (build_string (string), Fcons (errstring, data)));
280 Lisp_Object
281 close_file_unwind (fd)
282 Lisp_Object fd;
284 emacs_close (XFASTINT (fd));
285 return Qnil;
288 /* Restore point, having saved it as a marker. */
290 static Lisp_Object
291 restore_point_unwind (location)
292 Lisp_Object location;
294 Fgoto_char (location);
295 Fset_marker (location, Qnil, Qnil);
296 return Qnil;
299 Lisp_Object Qexpand_file_name;
300 Lisp_Object Qsubstitute_in_file_name;
301 Lisp_Object Qdirectory_file_name;
302 Lisp_Object Qfile_name_directory;
303 Lisp_Object Qfile_name_nondirectory;
304 Lisp_Object Qunhandled_file_name_directory;
305 Lisp_Object Qfile_name_as_directory;
306 Lisp_Object Qcopy_file;
307 Lisp_Object Qmake_directory_internal;
308 Lisp_Object Qmake_directory;
309 Lisp_Object Qdelete_directory;
310 Lisp_Object Qdelete_file;
311 Lisp_Object Qrename_file;
312 Lisp_Object Qadd_name_to_file;
313 Lisp_Object Qmake_symbolic_link;
314 Lisp_Object Qfile_exists_p;
315 Lisp_Object Qfile_executable_p;
316 Lisp_Object Qfile_readable_p;
317 Lisp_Object Qfile_writable_p;
318 Lisp_Object Qfile_symlink_p;
319 Lisp_Object Qaccess_file;
320 Lisp_Object Qfile_directory_p;
321 Lisp_Object Qfile_regular_p;
322 Lisp_Object Qfile_accessible_directory_p;
323 Lisp_Object Qfile_modes;
324 Lisp_Object Qset_file_modes;
325 Lisp_Object Qfile_newer_than_file_p;
326 Lisp_Object Qinsert_file_contents;
327 Lisp_Object Qwrite_region;
328 Lisp_Object Qverify_visited_file_modtime;
329 Lisp_Object Qset_visited_file_modtime;
331 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
332 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
333 Otherwise, return nil.
334 A file name is handled if one of the regular expressions in
335 `file-name-handler-alist' matches it.
337 If OPERATION equals `inhibit-file-name-operation', then we ignore
338 any handlers that are members of `inhibit-file-name-handlers',
339 but we still do run any other handlers. This lets handlers
340 use the standard functions without calling themselves recursively. */)
341 (filename, operation)
342 Lisp_Object filename, operation;
344 /* This function must not munge the match data. */
345 Lisp_Object chain, inhibited_handlers, result;
346 int pos = -1;
348 result = Qnil;
349 CHECK_STRING (filename);
351 if (EQ (operation, Vinhibit_file_name_operation))
352 inhibited_handlers = Vinhibit_file_name_handlers;
353 else
354 inhibited_handlers = Qnil;
356 for (chain = Vfile_name_handler_alist; CONSP (chain);
357 chain = XCDR (chain))
359 Lisp_Object elt;
360 elt = XCAR (chain);
361 if (CONSP (elt))
363 Lisp_Object string;
364 int match_pos;
365 string = XCAR (elt);
366 if (STRINGP (string)
367 && (match_pos = fast_string_match (string, filename)) > pos)
369 Lisp_Object handler, tem;
371 handler = XCDR (elt);
372 tem = Fmemq (handler, inhibited_handlers);
373 if (NILP (tem))
375 result = handler;
376 pos = match_pos;
381 QUIT;
383 return result;
386 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
387 1, 1, 0,
388 doc: /* Return the directory component in file name FILENAME.
389 Return nil if FILENAME does not include a directory.
390 Otherwise return a directory spec.
391 Given a Unix syntax file name, returns a string ending in slash;
392 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
393 (filename)
394 Lisp_Object filename;
396 #ifndef DOS_NT
397 register const unsigned char *beg;
398 #else
399 register unsigned char *beg;
400 #endif
401 register const unsigned char *p;
402 Lisp_Object handler;
404 CHECK_STRING (filename);
406 /* If the file name has special constructs in it,
407 call the corresponding file handler. */
408 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
409 if (!NILP (handler))
410 return call2 (handler, Qfile_name_directory, filename);
412 #ifdef FILE_SYSTEM_CASE
413 filename = FILE_SYSTEM_CASE (filename);
414 #endif
415 beg = SDATA (filename);
416 #ifdef DOS_NT
417 beg = strcpy (alloca (strlen (beg) + 1), beg);
418 #endif
419 p = beg + SBYTES (filename);
421 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
422 #ifdef VMS
423 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
424 #endif /* VMS */
425 #ifdef DOS_NT
426 /* only recognise drive specifier at the beginning */
427 && !(p[-1] == ':'
428 /* handle the "/:d:foo" and "/:foo" cases correctly */
429 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
430 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
431 #endif
432 ) p--;
434 if (p == beg)
435 return Qnil;
436 #ifdef DOS_NT
437 /* Expansion of "c:" to drive and default directory. */
438 if (p[-1] == ':')
440 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
441 unsigned char *res = alloca (MAXPATHLEN + 1);
442 unsigned char *r = res;
444 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
446 strncpy (res, beg, 2);
447 beg += 2;
448 r += 2;
451 if (getdefdir (toupper (*beg) - 'A' + 1, r))
453 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
454 strcat (res, "/");
455 beg = res;
456 p = beg + strlen (beg);
459 CORRECT_DIR_SEPS (beg);
460 #endif /* DOS_NT */
462 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
465 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
466 Sfile_name_nondirectory, 1, 1, 0,
467 doc: /* Return file name FILENAME sans its directory.
468 For example, in a Unix-syntax file name,
469 this is everything after the last slash,
470 or the entire name if it contains no slash. */)
471 (filename)
472 Lisp_Object filename;
474 register const unsigned char *beg, *p, *end;
475 Lisp_Object handler;
477 CHECK_STRING (filename);
479 /* If the file name has special constructs in it,
480 call the corresponding file handler. */
481 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
482 if (!NILP (handler))
483 return call2 (handler, Qfile_name_nondirectory, filename);
485 beg = SDATA (filename);
486 end = p = beg + SBYTES (filename);
488 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
489 #ifdef VMS
490 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
491 #endif /* VMS */
492 #ifdef DOS_NT
493 /* only recognise drive specifier at beginning */
494 && !(p[-1] == ':'
495 /* handle the "/:d:foo" case correctly */
496 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
497 #endif
499 p--;
501 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
504 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
505 Sunhandled_file_name_directory, 1, 1, 0,
506 doc: /* Return a directly usable directory name somehow associated with FILENAME.
507 A `directly usable' directory name is one that may be used without the
508 intervention of any file handler.
509 If FILENAME is a directly usable file itself, return
510 \(file-name-directory FILENAME).
511 The `call-process' and `start-process' functions use this function to
512 get a current directory to run processes in. */)
513 (filename)
514 Lisp_Object filename;
516 Lisp_Object handler;
518 /* If the file name has special constructs in it,
519 call the corresponding file handler. */
520 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
521 if (!NILP (handler))
522 return call2 (handler, Qunhandled_file_name_directory, filename);
524 return Ffile_name_directory (filename);
528 char *
529 file_name_as_directory (out, in)
530 char *out, *in;
532 int size = strlen (in) - 1;
534 strcpy (out, in);
536 if (size < 0)
538 out[0] = '.';
539 out[1] = '/';
540 out[2] = 0;
541 return out;
544 #ifdef VMS
545 /* Is it already a directory string? */
546 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
547 return out;
548 /* Is it a VMS directory file name? If so, hack VMS syntax. */
549 else if (! index (in, '/')
550 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
551 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
552 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
553 || ! strncmp (&in[size - 5], ".dir", 4))
554 && (in[size - 1] == '.' || in[size - 1] == ';')
555 && in[size] == '1')))
557 register char *p, *dot;
558 char brack;
560 /* x.dir -> [.x]
561 dir:x.dir --> dir:[x]
562 dir:[x]y.dir --> dir:[x.y] */
563 p = in + size;
564 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
565 if (p != in)
567 strncpy (out, in, p - in);
568 out[p - in] = '\0';
569 if (*p == ':')
571 brack = ']';
572 strcat (out, ":[");
574 else
576 brack = *p;
577 strcat (out, ".");
579 p++;
581 else
583 brack = ']';
584 strcpy (out, "[.");
586 dot = index (p, '.');
587 if (dot)
589 /* blindly remove any extension */
590 size = strlen (out) + (dot - p);
591 strncat (out, p, dot - p);
593 else
595 strcat (out, p);
596 size = strlen (out);
598 out[size++] = brack;
599 out[size] = '\0';
601 #else /* not VMS */
602 /* For Unix syntax, Append a slash if necessary */
603 if (!IS_DIRECTORY_SEP (out[size]))
605 /* Cannot use DIRECTORY_SEP, which could have any value */
606 out[size + 1] = '/';
607 out[size + 2] = '\0';
609 #ifdef DOS_NT
610 CORRECT_DIR_SEPS (out);
611 #endif
612 #endif /* not VMS */
613 return out;
616 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
617 Sfile_name_as_directory, 1, 1, 0,
618 doc: /* Return a string representing the file name FILE interpreted as a directory.
619 This operation exists because a directory is also a file, but its name as
620 a directory is different from its name as a file.
621 The result can be used as the value of `default-directory'
622 or passed as second argument to `expand-file-name'.
623 For a Unix-syntax file name, just appends a slash.
624 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
625 (file)
626 Lisp_Object file;
628 char *buf;
629 Lisp_Object handler;
631 CHECK_STRING (file);
632 if (NILP (file))
633 return Qnil;
635 /* If the file name has special constructs in it,
636 call the corresponding file handler. */
637 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
638 if (!NILP (handler))
639 return call2 (handler, Qfile_name_as_directory, file);
641 buf = (char *) alloca (SBYTES (file) + 10);
642 file_name_as_directory (buf, SDATA (file));
643 return make_specified_string (buf, -1, strlen (buf),
644 STRING_MULTIBYTE (file));
648 * Convert from directory name to filename.
649 * On VMS:
650 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
651 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
652 * On UNIX, it's simple: just make sure there isn't a terminating /
654 * Value is nonzero if the string output is different from the input.
658 directory_file_name (src, dst)
659 char *src, *dst;
661 long slen;
662 #ifdef VMS
663 long rlen;
664 char * ptr, * rptr;
665 char bracket;
666 struct FAB fab = cc$rms_fab;
667 struct NAM nam = cc$rms_nam;
668 char esa[NAM$C_MAXRSS];
669 #endif /* VMS */
671 slen = strlen (src);
672 #ifdef VMS
673 if (! index (src, '/')
674 && (src[slen - 1] == ']'
675 || src[slen - 1] == ':'
676 || src[slen - 1] == '>'))
678 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
679 fab.fab$l_fna = src;
680 fab.fab$b_fns = slen;
681 fab.fab$l_nam = &nam;
682 fab.fab$l_fop = FAB$M_NAM;
684 nam.nam$l_esa = esa;
685 nam.nam$b_ess = sizeof esa;
686 nam.nam$b_nop |= NAM$M_SYNCHK;
688 /* We call SYS$PARSE to handle such things as [--] for us. */
689 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
691 slen = nam.nam$b_esl;
692 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
693 slen -= 2;
694 esa[slen] = '\0';
695 src = esa;
697 if (src[slen - 1] != ']' && src[slen - 1] != '>')
699 /* what about when we have logical_name:???? */
700 if (src[slen - 1] == ':')
701 { /* Xlate logical name and see what we get */
702 ptr = strcpy (dst, src); /* upper case for getenv */
703 while (*ptr)
705 if ('a' <= *ptr && *ptr <= 'z')
706 *ptr -= 040;
707 ptr++;
709 dst[slen - 1] = 0; /* remove colon */
710 if (!(src = egetenv (dst)))
711 return 0;
712 /* should we jump to the beginning of this procedure?
713 Good points: allows us to use logical names that xlate
714 to Unix names,
715 Bad points: can be a problem if we just translated to a device
716 name...
717 For now, I'll punt and always expect VMS names, and hope for
718 the best! */
719 slen = strlen (src);
720 if (src[slen - 1] != ']' && src[slen - 1] != '>')
721 { /* no recursion here! */
722 strcpy (dst, src);
723 return 0;
726 else
727 { /* not a directory spec */
728 strcpy (dst, src);
729 return 0;
732 bracket = src[slen - 1];
734 /* If bracket is ']' or '>', bracket - 2 is the corresponding
735 opening bracket. */
736 ptr = index (src, bracket - 2);
737 if (ptr == 0)
738 { /* no opening bracket */
739 strcpy (dst, src);
740 return 0;
742 if (!(rptr = rindex (src, '.')))
743 rptr = ptr;
744 slen = rptr - src;
745 strncpy (dst, src, slen);
746 dst[slen] = '\0';
747 if (*rptr == '.')
749 dst[slen++] = bracket;
750 dst[slen] = '\0';
752 else
754 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
755 then translate the device and recurse. */
756 if (dst[slen - 1] == ':'
757 && dst[slen - 2] != ':' /* skip decnet nodes */
758 && strcmp (src + slen, "[000000]") == 0)
760 dst[slen - 1] = '\0';
761 if ((ptr = egetenv (dst))
762 && (rlen = strlen (ptr) - 1) > 0
763 && (ptr[rlen] == ']' || ptr[rlen] == '>')
764 && ptr[rlen - 1] == '.')
766 char * buf = (char *) alloca (strlen (ptr) + 1);
767 strcpy (buf, ptr);
768 buf[rlen - 1] = ']';
769 buf[rlen] = '\0';
770 return directory_file_name (buf, dst);
772 else
773 dst[slen - 1] = ':';
775 strcat (dst, "[000000]");
776 slen += 8;
778 rptr++;
779 rlen = strlen (rptr) - 1;
780 strncat (dst, rptr, rlen);
781 dst[slen + rlen] = '\0';
782 strcat (dst, ".DIR.1");
783 return 1;
785 #endif /* VMS */
786 /* Process as Unix format: just remove any final slash.
787 But leave "/" unchanged; do not change it to "". */
788 strcpy (dst, src);
789 #ifdef APOLLO
790 /* Handle // as root for apollo's. */
791 if ((slen > 2 && dst[slen - 1] == '/')
792 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
793 dst[slen - 1] = 0;
794 #else
795 if (slen > 1
796 && IS_DIRECTORY_SEP (dst[slen - 1])
797 #ifdef DOS_NT
798 && !IS_ANY_SEP (dst[slen - 2])
799 #endif
801 dst[slen - 1] = 0;
802 #endif
803 #ifdef DOS_NT
804 CORRECT_DIR_SEPS (dst);
805 #endif
806 return 1;
809 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
810 1, 1, 0,
811 doc: /* Returns the file name of the directory named DIRECTORY.
812 This is the name of the file that holds the data for the directory DIRECTORY.
813 This operation exists because a directory is also a file, but its name as
814 a directory is different from its name as a file.
815 In Unix-syntax, this function just removes the final slash.
816 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
817 it returns a file name such as \"[X]Y.DIR.1\". */)
818 (directory)
819 Lisp_Object directory;
821 char *buf;
822 Lisp_Object handler;
824 CHECK_STRING (directory);
826 if (NILP (directory))
827 return Qnil;
829 /* If the file name has special constructs in it,
830 call the corresponding file handler. */
831 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
832 if (!NILP (handler))
833 return call2 (handler, Qdirectory_file_name, directory);
835 #ifdef VMS
836 /* 20 extra chars is insufficient for VMS, since we might perform a
837 logical name translation. an equivalence string can be up to 255
838 chars long, so grab that much extra space... - sss */
839 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
840 #else
841 buf = (char *) alloca (SBYTES (directory) + 20);
842 #endif
843 directory_file_name (SDATA (directory), buf);
844 return make_specified_string (buf, -1, strlen (buf),
845 STRING_MULTIBYTE (directory));
848 static char make_temp_name_tbl[64] =
850 'A','B','C','D','E','F','G','H',
851 'I','J','K','L','M','N','O','P',
852 'Q','R','S','T','U','V','W','X',
853 'Y','Z','a','b','c','d','e','f',
854 'g','h','i','j','k','l','m','n',
855 'o','p','q','r','s','t','u','v',
856 'w','x','y','z','0','1','2','3',
857 '4','5','6','7','8','9','-','_'
860 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
862 /* Value is a temporary file name starting with PREFIX, a string.
864 The Emacs process number forms part of the result, so there is
865 no danger of generating a name being used by another process.
866 In addition, this function makes an attempt to choose a name
867 which has no existing file. To make this work, PREFIX should be
868 an absolute file name.
870 BASE64_P non-zero means add the pid as 3 characters in base64
871 encoding. In this case, 6 characters will be added to PREFIX to
872 form the file name. Otherwise, if Emacs is running on a system
873 with long file names, add the pid as a decimal number.
875 This function signals an error if no unique file name could be
876 generated. */
878 Lisp_Object
879 make_temp_name (prefix, base64_p)
880 Lisp_Object prefix;
881 int base64_p;
883 Lisp_Object val;
884 int len;
885 int pid;
886 unsigned char *p, *data;
887 char pidbuf[20];
888 int pidlen;
890 CHECK_STRING (prefix);
892 /* VAL is created by adding 6 characters to PREFIX. The first
893 three are the PID of this process, in base 64, and the second
894 three are incremented if the file already exists. This ensures
895 262144 unique file names per PID per PREFIX. */
897 pid = (int) getpid ();
899 if (base64_p)
901 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
902 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
903 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
904 pidlen = 3;
906 else
908 #ifdef HAVE_LONG_FILE_NAMES
909 sprintf (pidbuf, "%d", pid);
910 pidlen = strlen (pidbuf);
911 #else
912 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
913 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
914 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
915 pidlen = 3;
916 #endif
919 len = SCHARS (prefix);
920 val = make_uninit_string (len + 3 + pidlen);
921 data = SDATA (val);
922 bcopy(SDATA (prefix), data, len);
923 p = data + len;
925 bcopy (pidbuf, p, pidlen);
926 p += pidlen;
928 /* Here we try to minimize useless stat'ing when this function is
929 invoked many times successively with the same PREFIX. We achieve
930 this by initializing count to a random value, and incrementing it
931 afterwards.
933 We don't want make-temp-name to be called while dumping,
934 because then make_temp_name_count_initialized_p would get set
935 and then make_temp_name_count would not be set when Emacs starts. */
937 if (!make_temp_name_count_initialized_p)
939 make_temp_name_count = (unsigned) time (NULL);
940 make_temp_name_count_initialized_p = 1;
943 while (1)
945 struct stat ignored;
946 unsigned num = make_temp_name_count;
948 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
949 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
950 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
952 /* Poor man's congruential RN generator. Replace with
953 ++make_temp_name_count for debugging. */
954 make_temp_name_count += 25229;
955 make_temp_name_count %= 225307;
957 if (stat (data, &ignored) < 0)
959 /* We want to return only if errno is ENOENT. */
960 if (errno == ENOENT)
961 return val;
962 else
963 /* The error here is dubious, but there is little else we
964 can do. The alternatives are to return nil, which is
965 as bad as (and in many cases worse than) throwing the
966 error, or to ignore the error, which will likely result
967 in looping through 225307 stat's, which is not only
968 dog-slow, but also useless since it will fallback to
969 the errow below, anyway. */
970 report_file_error ("Cannot create temporary name for prefix",
971 Fcons (prefix, Qnil));
972 /* not reached */
976 error ("Cannot create temporary name for prefix `%s'",
977 SDATA (prefix));
978 return Qnil;
982 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
983 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
984 The Emacs process number forms part of the result,
985 so there is no danger of generating a name being used by another process.
987 In addition, this function makes an attempt to choose a name
988 which has no existing file. To make this work,
989 PREFIX should be an absolute file name.
991 There is a race condition between calling `make-temp-name' and creating the
992 file which opens all kinds of security holes. For that reason, you should
993 probably use `make-temp-file' instead, except in three circumstances:
995 * If you are creating the file in the user's home directory.
996 * If you are creating a directory rather than an ordinary file.
997 * If you are taking special precautions as `make-temp-file' does. */)
998 (prefix)
999 Lisp_Object prefix;
1001 return make_temp_name (prefix, 0);
1006 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1007 doc: /* Convert filename NAME to absolute, and canonicalize it.
1008 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1009 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1010 the current buffer's value of default-directory is used.
1011 File name components that are `.' are removed, and
1012 so are file name components followed by `..', along with the `..' itself;
1013 note that these simplifications are done without checking the resulting
1014 file names in the file system.
1015 An initial `~/' expands to your home directory.
1016 An initial `~USER/' expands to USER's home directory.
1017 See also the function `substitute-in-file-name'. */)
1018 (name, default_directory)
1019 Lisp_Object name, default_directory;
1021 unsigned char *nm;
1023 register unsigned char *newdir, *p, *o;
1024 int tlen;
1025 unsigned char *target;
1026 struct passwd *pw;
1027 #ifdef VMS
1028 unsigned char * colon = 0;
1029 unsigned char * close = 0;
1030 unsigned char * slash = 0;
1031 unsigned char * brack = 0;
1032 int lbrack = 0, rbrack = 0;
1033 int dots = 0;
1034 #endif /* VMS */
1035 #ifdef DOS_NT
1036 int drive = 0;
1037 int collapse_newdir = 1;
1038 int is_escaped = 0;
1039 #endif /* DOS_NT */
1040 int length;
1041 Lisp_Object handler, result;
1043 CHECK_STRING (name);
1045 /* If the file name has special constructs in it,
1046 call the corresponding file handler. */
1047 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1048 if (!NILP (handler))
1049 return call3 (handler, Qexpand_file_name, name, default_directory);
1051 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1052 if (NILP (default_directory))
1053 default_directory = current_buffer->directory;
1054 if (! STRINGP (default_directory))
1056 #ifdef DOS_NT
1057 /* "/" is not considered a root directory on DOS_NT, so using "/"
1058 here causes an infinite recursion in, e.g., the following:
1060 (let (default-directory)
1061 (expand-file-name "a"))
1063 To avoid this, we set default_directory to the root of the
1064 current drive. */
1065 extern char *emacs_root_dir (void);
1067 default_directory = build_string (emacs_root_dir ());
1068 #else
1069 default_directory = build_string ("/");
1070 #endif
1073 if (!NILP (default_directory))
1075 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1076 if (!NILP (handler))
1077 return call3 (handler, Qexpand_file_name, name, default_directory);
1080 o = SDATA (default_directory);
1082 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1083 It would be better to do this down below where we actually use
1084 default_directory. Unfortunately, calling Fexpand_file_name recursively
1085 could invoke GC, and the strings might be relocated. This would
1086 be annoying because we have pointers into strings lying around
1087 that would need adjusting, and people would add new pointers to
1088 the code and forget to adjust them, resulting in intermittent bugs.
1089 Putting this call here avoids all that crud.
1091 The EQ test avoids infinite recursion. */
1092 if (! NILP (default_directory) && !EQ (default_directory, name)
1093 /* Save time in some common cases - as long as default_directory
1094 is not relative, it can be canonicalized with name below (if it
1095 is needed at all) without requiring it to be expanded now. */
1096 #ifdef DOS_NT
1097 /* Detect MSDOS file names with drive specifiers. */
1098 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1099 #ifdef WINDOWSNT
1100 /* Detect Windows file names in UNC format. */
1101 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1102 #endif
1103 #else /* not DOS_NT */
1104 /* Detect Unix absolute file names (/... alone is not absolute on
1105 DOS or Windows). */
1106 && ! (IS_DIRECTORY_SEP (o[0]))
1107 #endif /* not DOS_NT */
1110 struct gcpro gcpro1;
1112 GCPRO1 (name);
1113 default_directory = Fexpand_file_name (default_directory, Qnil);
1114 UNGCPRO;
1117 #ifdef VMS
1118 /* Filenames on VMS are always upper case. */
1119 name = Fupcase (name);
1120 #endif
1121 #ifdef FILE_SYSTEM_CASE
1122 name = FILE_SYSTEM_CASE (name);
1123 #endif
1125 nm = SDATA (name);
1127 #ifdef DOS_NT
1128 /* We will force directory separators to be either all \ or /, so make
1129 a local copy to modify, even if there ends up being no change. */
1130 nm = strcpy (alloca (strlen (nm) + 1), nm);
1132 /* Note if special escape prefix is present, but remove for now. */
1133 if (nm[0] == '/' && nm[1] == ':')
1135 is_escaped = 1;
1136 nm += 2;
1139 /* Find and remove drive specifier if present; this makes nm absolute
1140 even if the rest of the name appears to be relative. Only look for
1141 drive specifier at the beginning. */
1142 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1144 drive = nm[0];
1145 nm += 2;
1148 #ifdef WINDOWSNT
1149 /* If we see "c://somedir", we want to strip the first slash after the
1150 colon when stripping the drive letter. Otherwise, this expands to
1151 "//somedir". */
1152 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1153 nm++;
1154 #endif /* WINDOWSNT */
1155 #endif /* DOS_NT */
1157 #ifdef WINDOWSNT
1158 /* Discard any previous drive specifier if nm is now in UNC format. */
1159 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1161 drive = 0;
1163 #endif
1165 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1166 none are found, we can probably return right away. We will avoid
1167 allocating a new string if name is already fully expanded. */
1168 if (
1169 IS_DIRECTORY_SEP (nm[0])
1170 #ifdef MSDOS
1171 && drive && !is_escaped
1172 #endif
1173 #ifdef WINDOWSNT
1174 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1175 #endif
1176 #ifdef VMS
1177 || index (nm, ':')
1178 #endif /* VMS */
1181 /* If it turns out that the filename we want to return is just a
1182 suffix of FILENAME, we don't need to go through and edit
1183 things; we just need to construct a new string using data
1184 starting at the middle of FILENAME. If we set lose to a
1185 non-zero value, that means we've discovered that we can't do
1186 that cool trick. */
1187 int lose = 0;
1189 p = nm;
1190 while (*p)
1192 /* Since we know the name is absolute, we can assume that each
1193 element starts with a "/". */
1195 /* "." and ".." are hairy. */
1196 if (IS_DIRECTORY_SEP (p[0])
1197 && p[1] == '.'
1198 && (IS_DIRECTORY_SEP (p[2])
1199 || p[2] == 0
1200 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1201 || p[3] == 0))))
1202 lose = 1;
1203 /* We want to replace multiple `/' in a row with a single
1204 slash. */
1205 else if (p > nm
1206 && IS_DIRECTORY_SEP (p[0])
1207 && IS_DIRECTORY_SEP (p[1]))
1208 lose = 1;
1210 #ifdef VMS
1211 if (p[0] == '\\')
1212 lose = 1;
1213 if (p[0] == '/') {
1214 /* if dev:[dir]/, move nm to / */
1215 if (!slash && p > nm && (brack || colon)) {
1216 nm = (brack ? brack + 1 : colon + 1);
1217 lbrack = rbrack = 0;
1218 brack = 0;
1219 colon = 0;
1221 slash = p;
1223 if (p[0] == '-')
1224 #ifndef VMS4_4
1225 /* VMS pre V4.4,convert '-'s in filenames. */
1226 if (lbrack == rbrack)
1228 if (dots < 2) /* this is to allow negative version numbers */
1229 p[0] = '_';
1231 else
1232 #endif /* VMS4_4 */
1233 if (lbrack > rbrack &&
1234 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1235 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1236 lose = 1;
1237 #ifndef VMS4_4
1238 else
1239 p[0] = '_';
1240 #endif /* VMS4_4 */
1241 /* count open brackets, reset close bracket pointer */
1242 if (p[0] == '[' || p[0] == '<')
1243 lbrack++, brack = 0;
1244 /* count close brackets, set close bracket pointer */
1245 if (p[0] == ']' || p[0] == '>')
1246 rbrack++, brack = p;
1247 /* detect ][ or >< */
1248 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1249 lose = 1;
1250 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1251 nm = p + 1, lose = 1;
1252 if (p[0] == ':' && (colon || slash))
1253 /* if dev1:[dir]dev2:, move nm to dev2: */
1254 if (brack)
1256 nm = brack + 1;
1257 brack = 0;
1259 /* if /name/dev:, move nm to dev: */
1260 else if (slash)
1261 nm = slash + 1;
1262 /* if node::dev:, move colon following dev */
1263 else if (colon && colon[-1] == ':')
1264 colon = p;
1265 /* if dev1:dev2:, move nm to dev2: */
1266 else if (colon && colon[-1] != ':')
1268 nm = colon + 1;
1269 colon = 0;
1271 if (p[0] == ':' && !colon)
1273 if (p[1] == ':')
1274 p++;
1275 colon = p;
1277 if (lbrack == rbrack)
1278 if (p[0] == ';')
1279 dots = 2;
1280 else if (p[0] == '.')
1281 dots++;
1282 #endif /* VMS */
1283 p++;
1285 if (!lose)
1287 #ifdef VMS
1288 if (index (nm, '/'))
1290 nm = sys_translate_unix (nm);
1291 return make_specified_string (nm, -1, strlen (nm),
1292 STRING_MULTIBYTE (name));
1294 #endif /* VMS */
1295 #ifdef DOS_NT
1296 /* Make sure directories are all separated with / or \ as
1297 desired, but avoid allocation of a new string when not
1298 required. */
1299 CORRECT_DIR_SEPS (nm);
1300 #ifdef WINDOWSNT
1301 if (IS_DIRECTORY_SEP (nm[1]))
1303 if (strcmp (nm, SDATA (name)) != 0)
1304 name = make_specified_string (nm, -1, strlen (nm),
1305 STRING_MULTIBYTE (name));
1307 else
1308 #endif
1309 /* drive must be set, so this is okay */
1310 if (strcmp (nm - 2, SDATA (name)) != 0)
1312 char temp[] = " :";
1314 name = make_specified_string (nm, -1, p - nm,
1315 STRING_MULTIBYTE (name));
1316 temp[0] = DRIVE_LETTER (drive);
1317 name = concat2 (build_string (temp), name);
1319 return name;
1320 #else /* not DOS_NT */
1321 if (nm == SDATA (name))
1322 return name;
1323 return make_specified_string (nm, -1, strlen (nm),
1324 STRING_MULTIBYTE (name));
1325 #endif /* not DOS_NT */
1329 /* At this point, nm might or might not be an absolute file name. We
1330 need to expand ~ or ~user if present, otherwise prefix nm with
1331 default_directory if nm is not absolute, and finally collapse /./
1332 and /foo/../ sequences.
1334 We set newdir to be the appropriate prefix if one is needed:
1335 - the relevant user directory if nm starts with ~ or ~user
1336 - the specified drive's working dir (DOS/NT only) if nm does not
1337 start with /
1338 - the value of default_directory.
1340 Note that these prefixes are not guaranteed to be absolute (except
1341 for the working dir of a drive). Therefore, to ensure we always
1342 return an absolute name, if the final prefix is not absolute we
1343 append it to the current working directory. */
1345 newdir = 0;
1347 if (nm[0] == '~') /* prefix ~ */
1349 if (IS_DIRECTORY_SEP (nm[1])
1350 #ifdef VMS
1351 || nm[1] == ':'
1352 #endif /* VMS */
1353 || nm[1] == 0) /* ~ by itself */
1355 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1356 newdir = (unsigned char *) "";
1357 nm++;
1358 #ifdef DOS_NT
1359 collapse_newdir = 0;
1360 #endif
1361 #ifdef VMS
1362 nm++; /* Don't leave the slash in nm. */
1363 #endif /* VMS */
1365 else /* ~user/filename */
1367 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1368 #ifdef VMS
1369 && *p != ':'
1370 #endif /* VMS */
1371 ); p++);
1372 o = (unsigned char *) alloca (p - nm + 1);
1373 bcopy ((char *) nm, o, p - nm);
1374 o [p - nm] = 0;
1376 pw = (struct passwd *) getpwnam (o + 1);
1377 if (pw)
1379 newdir = (unsigned char *) pw -> pw_dir;
1380 #ifdef VMS
1381 nm = p + 1; /* skip the terminator */
1382 #else
1383 nm = p;
1384 #ifdef DOS_NT
1385 collapse_newdir = 0;
1386 #endif
1387 #endif /* VMS */
1390 /* If we don't find a user of that name, leave the name
1391 unchanged; don't move nm forward to p. */
1395 #ifdef DOS_NT
1396 /* On DOS and Windows, nm is absolute if a drive name was specified;
1397 use the drive's current directory as the prefix if needed. */
1398 if (!newdir && drive)
1400 /* Get default directory if needed to make nm absolute. */
1401 if (!IS_DIRECTORY_SEP (nm[0]))
1403 newdir = alloca (MAXPATHLEN + 1);
1404 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1405 newdir = NULL;
1407 if (!newdir)
1409 /* Either nm starts with /, or drive isn't mounted. */
1410 newdir = alloca (4);
1411 newdir[0] = DRIVE_LETTER (drive);
1412 newdir[1] = ':';
1413 newdir[2] = '/';
1414 newdir[3] = 0;
1417 #endif /* DOS_NT */
1419 /* Finally, if no prefix has been specified and nm is not absolute,
1420 then it must be expanded relative to default_directory. */
1422 if (1
1423 #ifndef DOS_NT
1424 /* /... alone is not absolute on DOS and Windows. */
1425 && !IS_DIRECTORY_SEP (nm[0])
1426 #endif
1427 #ifdef WINDOWSNT
1428 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1429 #endif
1430 #ifdef VMS
1431 && !index (nm, ':')
1432 #endif
1433 && !newdir)
1435 newdir = SDATA (default_directory);
1436 #ifdef DOS_NT
1437 /* Note if special escape prefix is present, but remove for now. */
1438 if (newdir[0] == '/' && newdir[1] == ':')
1440 is_escaped = 1;
1441 newdir += 2;
1443 #endif
1446 #ifdef DOS_NT
1447 if (newdir)
1449 /* First ensure newdir is an absolute name. */
1450 if (
1451 /* Detect MSDOS file names with drive specifiers. */
1452 ! (IS_DRIVE (newdir[0])
1453 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1454 #ifdef WINDOWSNT
1455 /* Detect Windows file names in UNC format. */
1456 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1457 #endif
1460 /* Effectively, let newdir be (expand-file-name newdir cwd).
1461 Because of the admonition against calling expand-file-name
1462 when we have pointers into lisp strings, we accomplish this
1463 indirectly by prepending newdir to nm if necessary, and using
1464 cwd (or the wd of newdir's drive) as the new newdir. */
1466 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1468 drive = newdir[0];
1469 newdir += 2;
1471 if (!IS_DIRECTORY_SEP (nm[0]))
1473 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1474 file_name_as_directory (tmp, newdir);
1475 strcat (tmp, nm);
1476 nm = tmp;
1478 newdir = alloca (MAXPATHLEN + 1);
1479 if (drive)
1481 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1482 newdir = "/";
1484 else
1485 getwd (newdir);
1488 /* Strip off drive name from prefix, if present. */
1489 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1491 drive = newdir[0];
1492 newdir += 2;
1495 /* Keep only a prefix from newdir if nm starts with slash
1496 (//server/share for UNC, nothing otherwise). */
1497 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1499 #ifdef WINDOWSNT
1500 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1502 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1503 p = newdir + 2;
1504 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1505 p++;
1506 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1507 *p = 0;
1509 else
1510 #endif
1511 newdir = "";
1514 #endif /* DOS_NT */
1516 if (newdir)
1518 /* Get rid of any slash at the end of newdir, unless newdir is
1519 just / or // (an incomplete UNC name). */
1520 length = strlen (newdir);
1521 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1522 #ifdef WINDOWSNT
1523 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1524 #endif
1527 unsigned char *temp = (unsigned char *) alloca (length);
1528 bcopy (newdir, temp, length - 1);
1529 temp[length - 1] = 0;
1530 newdir = temp;
1532 tlen = length + 1;
1534 else
1535 tlen = 0;
1537 /* Now concatenate the directory and name to new space in the stack frame */
1538 tlen += strlen (nm) + 1;
1539 #ifdef DOS_NT
1540 /* Reserve space for drive specifier and escape prefix, since either
1541 or both may need to be inserted. (The Microsoft x86 compiler
1542 produces incorrect code if the following two lines are combined.) */
1543 target = (unsigned char *) alloca (tlen + 4);
1544 target += 4;
1545 #else /* not DOS_NT */
1546 target = (unsigned char *) alloca (tlen);
1547 #endif /* not DOS_NT */
1548 *target = 0;
1550 if (newdir)
1552 #ifndef VMS
1553 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1555 #ifdef DOS_NT
1556 /* If newdir is effectively "C:/", then the drive letter will have
1557 been stripped and newdir will be "/". Concatenating with an
1558 absolute directory in nm produces "//", which will then be
1559 incorrectly treated as a network share. Ignore newdir in
1560 this case (keeping the drive letter). */
1561 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1562 && newdir[1] == '\0'))
1563 #endif
1564 strcpy (target, newdir);
1566 else
1567 #endif
1568 file_name_as_directory (target, newdir);
1571 strcat (target, nm);
1572 #ifdef VMS
1573 if (index (target, '/'))
1574 strcpy (target, sys_translate_unix (target));
1575 #endif /* VMS */
1577 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1579 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1580 appear. */
1582 p = target;
1583 o = target;
1585 while (*p)
1587 #ifdef VMS
1588 if (*p != ']' && *p != '>' && *p != '-')
1590 if (*p == '\\')
1591 p++;
1592 *o++ = *p++;
1594 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1595 /* brackets are offset from each other by 2 */
1597 p += 2;
1598 if (*p != '.' && *p != '-' && o[-1] != '.')
1599 /* convert [foo][bar] to [bar] */
1600 while (o[-1] != '[' && o[-1] != '<')
1601 o--;
1602 else if (*p == '-' && *o != '.')
1603 *--p = '.';
1605 else if (p[0] == '-' && o[-1] == '.' &&
1606 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1607 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1610 o--;
1611 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1612 if (p[1] == '.') /* foo.-.bar ==> bar. */
1613 p += 2;
1614 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1615 p++, o--;
1616 /* else [foo.-] ==> [-] */
1618 else
1620 #ifndef VMS4_4
1621 if (*p == '-' &&
1622 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1623 p[1] != ']' && p[1] != '>' && p[1] != '.')
1624 *p = '_';
1625 #endif /* VMS4_4 */
1626 *o++ = *p++;
1628 #else /* not VMS */
1629 if (!IS_DIRECTORY_SEP (*p))
1631 *o++ = *p++;
1633 else if (IS_DIRECTORY_SEP (p[0])
1634 && p[1] == '.'
1635 && (IS_DIRECTORY_SEP (p[2])
1636 || p[2] == 0))
1638 /* If "/." is the entire filename, keep the "/". Otherwise,
1639 just delete the whole "/.". */
1640 if (o == target && p[2] == '\0')
1641 *o++ = *p;
1642 p += 2;
1644 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1645 /* `/../' is the "superroot" on certain file systems. */
1646 && o != target
1647 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1649 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1651 /* Keep initial / only if this is the whole name. */
1652 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1653 ++o;
1654 p += 3;
1656 else if (p > target
1657 && IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1]))
1659 /* Collapse multiple `/' in a row. */
1660 *o++ = *p++;
1661 while (IS_DIRECTORY_SEP (*p))
1662 ++p;
1664 else
1666 *o++ = *p++;
1668 #endif /* not VMS */
1671 #ifdef DOS_NT
1672 /* At last, set drive name. */
1673 #ifdef WINDOWSNT
1674 /* Except for network file name. */
1675 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1676 #endif /* WINDOWSNT */
1678 if (!drive) abort ();
1679 target -= 2;
1680 target[0] = DRIVE_LETTER (drive);
1681 target[1] = ':';
1683 /* Reinsert the escape prefix if required. */
1684 if (is_escaped)
1686 target -= 2;
1687 target[0] = '/';
1688 target[1] = ':';
1690 CORRECT_DIR_SEPS (target);
1691 #endif /* DOS_NT */
1693 result = make_specified_string (target, -1, o - target,
1694 STRING_MULTIBYTE (name));
1696 /* Again look to see if the file name has special constructs in it
1697 and perhaps call the corresponding file handler. This is needed
1698 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1699 the ".." component gives us "/user@host:/bar/../baz" which needs
1700 to be expanded again. */
1701 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1702 if (!NILP (handler))
1703 return call3 (handler, Qexpand_file_name, result, default_directory);
1705 return result;
1708 #if 0
1709 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1710 This is the old version of expand-file-name, before it was thoroughly
1711 rewritten for Emacs 10.31. We leave this version here commented-out,
1712 because the code is very complex and likely to have subtle bugs. If
1713 bugs _are_ found, it might be of interest to look at the old code and
1714 see what did it do in the relevant situation.
1716 Don't remove this code: it's true that it will be accessible via CVS,
1717 but a few years from deletion, people will forget it is there. */
1719 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1720 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1721 "Convert FILENAME to absolute, and canonicalize it.\n\
1722 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1723 (does not start with slash); if DEFAULT is nil or missing,\n\
1724 the current buffer's value of default-directory is used.\n\
1725 Filenames containing `.' or `..' as components are simplified;\n\
1726 initial `~/' expands to your home directory.\n\
1727 See also the function `substitute-in-file-name'.")
1728 (name, defalt)
1729 Lisp_Object name, defalt;
1731 unsigned char *nm;
1733 register unsigned char *newdir, *p, *o;
1734 int tlen;
1735 unsigned char *target;
1736 struct passwd *pw;
1737 int lose;
1738 #ifdef VMS
1739 unsigned char * colon = 0;
1740 unsigned char * close = 0;
1741 unsigned char * slash = 0;
1742 unsigned char * brack = 0;
1743 int lbrack = 0, rbrack = 0;
1744 int dots = 0;
1745 #endif /* VMS */
1747 CHECK_STRING (name);
1749 #ifdef VMS
1750 /* Filenames on VMS are always upper case. */
1751 name = Fupcase (name);
1752 #endif
1754 nm = SDATA (name);
1756 /* If nm is absolute, flush ...// and detect /./ and /../.
1757 If no /./ or /../ we can return right away. */
1758 if (
1759 nm[0] == '/'
1760 #ifdef VMS
1761 || index (nm, ':')
1762 #endif /* VMS */
1765 p = nm;
1766 lose = 0;
1767 while (*p)
1769 if (p[0] == '/' && p[1] == '/'
1770 #ifdef APOLLO
1771 /* // at start of filename is meaningful on Apollo system. */
1772 && nm != p
1773 #endif /* APOLLO */
1775 nm = p + 1;
1776 if (p[0] == '/' && p[1] == '~')
1777 nm = p + 1, lose = 1;
1778 if (p[0] == '/' && p[1] == '.'
1779 && (p[2] == '/' || p[2] == 0
1780 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1781 lose = 1;
1782 #ifdef VMS
1783 if (p[0] == '\\')
1784 lose = 1;
1785 if (p[0] == '/') {
1786 /* if dev:[dir]/, move nm to / */
1787 if (!slash && p > nm && (brack || colon)) {
1788 nm = (brack ? brack + 1 : colon + 1);
1789 lbrack = rbrack = 0;
1790 brack = 0;
1791 colon = 0;
1793 slash = p;
1795 if (p[0] == '-')
1796 #ifndef VMS4_4
1797 /* VMS pre V4.4,convert '-'s in filenames. */
1798 if (lbrack == rbrack)
1800 if (dots < 2) /* this is to allow negative version numbers */
1801 p[0] = '_';
1803 else
1804 #endif /* VMS4_4 */
1805 if (lbrack > rbrack &&
1806 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1807 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1808 lose = 1;
1809 #ifndef VMS4_4
1810 else
1811 p[0] = '_';
1812 #endif /* VMS4_4 */
1813 /* count open brackets, reset close bracket pointer */
1814 if (p[0] == '[' || p[0] == '<')
1815 lbrack++, brack = 0;
1816 /* count close brackets, set close bracket pointer */
1817 if (p[0] == ']' || p[0] == '>')
1818 rbrack++, brack = p;
1819 /* detect ][ or >< */
1820 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1821 lose = 1;
1822 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1823 nm = p + 1, lose = 1;
1824 if (p[0] == ':' && (colon || slash))
1825 /* if dev1:[dir]dev2:, move nm to dev2: */
1826 if (brack)
1828 nm = brack + 1;
1829 brack = 0;
1831 /* If /name/dev:, move nm to dev: */
1832 else if (slash)
1833 nm = slash + 1;
1834 /* If node::dev:, move colon following dev */
1835 else if (colon && colon[-1] == ':')
1836 colon = p;
1837 /* If dev1:dev2:, move nm to dev2: */
1838 else if (colon && colon[-1] != ':')
1840 nm = colon + 1;
1841 colon = 0;
1843 if (p[0] == ':' && !colon)
1845 if (p[1] == ':')
1846 p++;
1847 colon = p;
1849 if (lbrack == rbrack)
1850 if (p[0] == ';')
1851 dots = 2;
1852 else if (p[0] == '.')
1853 dots++;
1854 #endif /* VMS */
1855 p++;
1857 if (!lose)
1859 #ifdef VMS
1860 if (index (nm, '/'))
1861 return build_string (sys_translate_unix (nm));
1862 #endif /* VMS */
1863 if (nm == SDATA (name))
1864 return name;
1865 return build_string (nm);
1869 /* Now determine directory to start with and put it in NEWDIR */
1871 newdir = 0;
1873 if (nm[0] == '~') /* prefix ~ */
1874 if (nm[1] == '/'
1875 #ifdef VMS
1876 || nm[1] == ':'
1877 #endif /* VMS */
1878 || nm[1] == 0)/* ~/filename */
1880 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1881 newdir = (unsigned char *) "";
1882 nm++;
1883 #ifdef VMS
1884 nm++; /* Don't leave the slash in nm. */
1885 #endif /* VMS */
1887 else /* ~user/filename */
1889 /* Get past ~ to user */
1890 unsigned char *user = nm + 1;
1891 /* Find end of name. */
1892 unsigned char *ptr = (unsigned char *) index (user, '/');
1893 int len = ptr ? ptr - user : strlen (user);
1894 #ifdef VMS
1895 unsigned char *ptr1 = index (user, ':');
1896 if (ptr1 != 0 && ptr1 - user < len)
1897 len = ptr1 - user;
1898 #endif /* VMS */
1899 /* Copy the user name into temp storage. */
1900 o = (unsigned char *) alloca (len + 1);
1901 bcopy ((char *) user, o, len);
1902 o[len] = 0;
1904 /* Look up the user name. */
1905 pw = (struct passwd *) getpwnam (o + 1);
1906 if (!pw)
1907 error ("\"%s\" isn't a registered user", o + 1);
1909 newdir = (unsigned char *) pw->pw_dir;
1911 /* Discard the user name from NM. */
1912 nm += len;
1915 if (nm[0] != '/'
1916 #ifdef VMS
1917 && !index (nm, ':')
1918 #endif /* not VMS */
1919 && !newdir)
1921 if (NILP (defalt))
1922 defalt = current_buffer->directory;
1923 CHECK_STRING (defalt);
1924 newdir = SDATA (defalt);
1927 /* Now concatenate the directory and name to new space in the stack frame */
1929 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1930 target = (unsigned char *) alloca (tlen);
1931 *target = 0;
1933 if (newdir)
1935 #ifndef VMS
1936 if (nm[0] == 0 || nm[0] == '/')
1937 strcpy (target, newdir);
1938 else
1939 #endif
1940 file_name_as_directory (target, newdir);
1943 strcat (target, nm);
1944 #ifdef VMS
1945 if (index (target, '/'))
1946 strcpy (target, sys_translate_unix (target));
1947 #endif /* VMS */
1949 /* Now canonicalize by removing /. and /foo/.. if they appear */
1951 p = target;
1952 o = target;
1954 while (*p)
1956 #ifdef VMS
1957 if (*p != ']' && *p != '>' && *p != '-')
1959 if (*p == '\\')
1960 p++;
1961 *o++ = *p++;
1963 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1964 /* brackets are offset from each other by 2 */
1966 p += 2;
1967 if (*p != '.' && *p != '-' && o[-1] != '.')
1968 /* convert [foo][bar] to [bar] */
1969 while (o[-1] != '[' && o[-1] != '<')
1970 o--;
1971 else if (*p == '-' && *o != '.')
1972 *--p = '.';
1974 else if (p[0] == '-' && o[-1] == '.' &&
1975 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1976 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1979 o--;
1980 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1981 if (p[1] == '.') /* foo.-.bar ==> bar. */
1982 p += 2;
1983 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1984 p++, o--;
1985 /* else [foo.-] ==> [-] */
1987 else
1989 #ifndef VMS4_4
1990 if (*p == '-' &&
1991 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1992 p[1] != ']' && p[1] != '>' && p[1] != '.')
1993 *p = '_';
1994 #endif /* VMS4_4 */
1995 *o++ = *p++;
1997 #else /* not VMS */
1998 if (*p != '/')
2000 *o++ = *p++;
2002 else if (!strncmp (p, "//", 2)
2003 #ifdef APOLLO
2004 /* // at start of filename is meaningful in Apollo system. */
2005 && o != target
2006 #endif /* APOLLO */
2009 o = target;
2010 p++;
2012 else if (p[0] == '/' && p[1] == '.' &&
2013 (p[2] == '/' || p[2] == 0))
2014 p += 2;
2015 else if (!strncmp (p, "/..", 3)
2016 /* `/../' is the "superroot" on certain file systems. */
2017 && o != target
2018 && (p[3] == '/' || p[3] == 0))
2020 while (o != target && *--o != '/')
2022 #ifdef APOLLO
2023 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2024 ++o;
2025 else
2026 #endif /* APOLLO */
2027 if (o == target && *o == '/')
2028 ++o;
2029 p += 3;
2031 else
2033 *o++ = *p++;
2035 #endif /* not VMS */
2038 return make_string (target, o - target);
2040 #endif
2042 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2043 Ssubstitute_in_file_name, 1, 1, 0,
2044 doc: /* Substitute environment variables referred to in FILENAME.
2045 `$FOO' where FOO is an environment variable name means to substitute
2046 the value of that variable. The variable name should be terminated
2047 with a character not a letter, digit or underscore; otherwise, enclose
2048 the entire variable name in braces.
2049 If `/~' appears, all of FILENAME through that `/' is discarded.
2051 On VMS, `$' substitution is not done; this function does little and only
2052 duplicates what `expand-file-name' does. */)
2053 (filename)
2054 Lisp_Object filename;
2056 unsigned char *nm;
2058 register unsigned char *s, *p, *o, *x, *endp;
2059 unsigned char *target = NULL;
2060 int total = 0;
2061 int substituted = 0;
2062 unsigned char *xnm;
2063 struct passwd *pw;
2064 Lisp_Object handler;
2066 CHECK_STRING (filename);
2068 /* If the file name has special constructs in it,
2069 call the corresponding file handler. */
2070 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2071 if (!NILP (handler))
2072 return call2 (handler, Qsubstitute_in_file_name, filename);
2074 nm = SDATA (filename);
2075 #ifdef DOS_NT
2076 nm = strcpy (alloca (strlen (nm) + 1), nm);
2077 CORRECT_DIR_SEPS (nm);
2078 substituted = (strcmp (nm, SDATA (filename)) != 0);
2079 #endif
2080 endp = nm + SBYTES (filename);
2082 /* If /~ or // appears, discard everything through first slash. */
2084 for (p = nm; p != endp; p++)
2086 if ((p[0] == '~'
2087 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2088 /* // at start of file name is meaningful in Apollo,
2089 WindowsNT and Cygwin systems. */
2090 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != nm)
2091 #else /* not (APOLLO || WINDOWSNT || CYGWIN) */
2092 || IS_DIRECTORY_SEP (p[0])
2093 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2095 && p != nm
2096 && (0
2097 #ifdef VMS
2098 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2099 #endif /* VMS */
2100 || IS_DIRECTORY_SEP (p[-1])))
2102 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2103 #ifdef VMS
2104 && *s != ':'
2105 #endif /* VMS */
2106 ); s++);
2107 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2109 o = (unsigned char *) alloca (s - p + 1);
2110 bcopy ((char *) p, o, s - p);
2111 o [s - p] = 0;
2113 pw = (struct passwd *) getpwnam (o + 1);
2115 /* If we have ~/ or ~user and `user' exists, discard
2116 everything up to ~. But if `user' does not exist, leave
2117 ~user alone, it might be a literal file name. */
2118 if (IS_DIRECTORY_SEP (p[0]) || s == p + 1 || pw)
2120 nm = p;
2121 substituted = 1;
2124 #ifdef DOS_NT
2125 /* see comment in expand-file-name about drive specifiers */
2126 else if (IS_DRIVE (p[0]) && p[1] == ':'
2127 && p > nm && IS_DIRECTORY_SEP (p[-1]))
2129 nm = p;
2130 substituted = 1;
2132 #endif /* DOS_NT */
2135 #ifdef VMS
2136 return make_specified_string (nm, -1, strlen (nm),
2137 STRING_MULTIBYTE (filename));
2138 #else
2140 /* See if any variables are substituted into the string
2141 and find the total length of their values in `total' */
2143 for (p = nm; p != endp;)
2144 if (*p != '$')
2145 p++;
2146 else
2148 p++;
2149 if (p == endp)
2150 goto badsubst;
2151 else if (*p == '$')
2153 /* "$$" means a single "$" */
2154 p++;
2155 total -= 1;
2156 substituted = 1;
2157 continue;
2159 else if (*p == '{')
2161 o = ++p;
2162 while (p != endp && *p != '}') p++;
2163 if (*p != '}') goto missingclose;
2164 s = p;
2166 else
2168 o = p;
2169 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2170 s = p;
2173 /* Copy out the variable name */
2174 target = (unsigned char *) alloca (s - o + 1);
2175 strncpy (target, o, s - o);
2176 target[s - o] = 0;
2177 #ifdef DOS_NT
2178 strupr (target); /* $home == $HOME etc. */
2179 #endif /* DOS_NT */
2181 /* Get variable value */
2182 o = (unsigned char *) egetenv (target);
2183 if (o)
2185 total += strlen (o);
2186 substituted = 1;
2188 else if (*p == '}')
2189 goto badvar;
2192 if (!substituted)
2193 return filename;
2195 /* If substitution required, recopy the string and do it */
2196 /* Make space in stack frame for the new copy */
2197 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2198 x = xnm;
2200 /* Copy the rest of the name through, replacing $ constructs with values */
2201 for (p = nm; *p;)
2202 if (*p != '$')
2203 *x++ = *p++;
2204 else
2206 p++;
2207 if (p == endp)
2208 goto badsubst;
2209 else if (*p == '$')
2211 *x++ = *p++;
2212 continue;
2214 else if (*p == '{')
2216 o = ++p;
2217 while (p != endp && *p != '}') p++;
2218 if (*p != '}') goto missingclose;
2219 s = p++;
2221 else
2223 o = p;
2224 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2225 s = p;
2228 /* Copy out the variable name */
2229 target = (unsigned char *) alloca (s - o + 1);
2230 strncpy (target, o, s - o);
2231 target[s - o] = 0;
2232 #ifdef DOS_NT
2233 strupr (target); /* $home == $HOME etc. */
2234 #endif /* DOS_NT */
2236 /* Get variable value */
2237 o = (unsigned char *) egetenv (target);
2238 if (!o)
2240 *x++ = '$';
2241 strcpy (x, target); x+= strlen (target);
2243 else if (STRING_MULTIBYTE (filename))
2245 /* If the original string is multibyte,
2246 convert what we substitute into multibyte. */
2247 while (*o)
2249 int c = unibyte_char_to_multibyte (*o++);
2250 x += CHAR_STRING (c, x);
2253 else
2255 strcpy (x, o);
2256 x += strlen (o);
2260 *x = 0;
2262 /* If /~ or // appears, discard everything through first slash. */
2264 for (p = xnm; p != x; p++)
2265 if ((p[0] == '~'
2266 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2267 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != xnm)
2268 #else /* not (APOLLO || WINDOWSNT || CYGWIN) */
2269 || IS_DIRECTORY_SEP (p[0])
2270 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2272 && p != xnm && IS_DIRECTORY_SEP (p[-1]))
2273 xnm = p;
2274 #ifdef DOS_NT
2275 else if (IS_DRIVE (p[0]) && p[1] == ':'
2276 && p > xnm && IS_DIRECTORY_SEP (p[-1]))
2277 xnm = p;
2278 #endif
2280 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2282 badsubst:
2283 error ("Bad format environment-variable substitution");
2284 missingclose:
2285 error ("Missing \"}\" in environment-variable substitution");
2286 badvar:
2287 error ("Substituting nonexistent environment variable \"%s\"", target);
2289 /* NOTREACHED */
2290 #endif /* not VMS */
2291 return Qnil;
2294 /* A slightly faster and more convenient way to get
2295 (directory-file-name (expand-file-name FOO)). */
2297 Lisp_Object
2298 expand_and_dir_to_file (filename, defdir)
2299 Lisp_Object filename, defdir;
2301 register Lisp_Object absname;
2303 absname = Fexpand_file_name (filename, defdir);
2304 #ifdef VMS
2306 register int c = SREF (absname, SBYTES (absname) - 1);
2307 if (c == ':' || c == ']' || c == '>')
2308 absname = Fdirectory_file_name (absname);
2310 #else
2311 /* Remove final slash, if any (unless this is the root dir).
2312 stat behaves differently depending! */
2313 if (SCHARS (absname) > 1
2314 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2315 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2316 /* We cannot take shortcuts; they might be wrong for magic file names. */
2317 absname = Fdirectory_file_name (absname);
2318 #endif
2319 return absname;
2322 /* Signal an error if the file ABSNAME already exists.
2323 If INTERACTIVE is nonzero, ask the user whether to proceed,
2324 and bypass the error if the user says to go ahead.
2325 QUERYSTRING is a name for the action that is being considered
2326 to alter the file.
2328 *STATPTR is used to store the stat information if the file exists.
2329 If the file does not exist, STATPTR->st_mode is set to 0.
2330 If STATPTR is null, we don't store into it.
2332 If QUICK is nonzero, we ask for y or n, not yes or no. */
2334 void
2335 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2336 Lisp_Object absname;
2337 unsigned char *querystring;
2338 int interactive;
2339 struct stat *statptr;
2340 int quick;
2342 register Lisp_Object tem, encoded_filename;
2343 struct stat statbuf;
2344 struct gcpro gcpro1;
2346 encoded_filename = ENCODE_FILE (absname);
2348 /* stat is a good way to tell whether the file exists,
2349 regardless of what access permissions it has. */
2350 if (stat (SDATA (encoded_filename), &statbuf) >= 0)
2352 if (! interactive)
2353 Fsignal (Qfile_already_exists,
2354 Fcons (build_string ("File already exists"),
2355 Fcons (absname, Qnil)));
2356 GCPRO1 (absname);
2357 tem = format2 ("File %s already exists; %s anyway? ",
2358 absname, build_string (querystring));
2359 if (quick)
2360 tem = Fy_or_n_p (tem);
2361 else
2362 tem = do_yes_or_no_p (tem);
2363 UNGCPRO;
2364 if (NILP (tem))
2365 Fsignal (Qfile_already_exists,
2366 Fcons (build_string ("File already exists"),
2367 Fcons (absname, Qnil)));
2368 if (statptr)
2369 *statptr = statbuf;
2371 else
2373 if (statptr)
2374 statptr->st_mode = 0;
2376 return;
2379 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 4,
2380 "fCopy file: \nFCopy %s to file: \np\nP",
2381 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2382 If NEWNAME names a directory, copy FILE there.
2383 Signals a `file-already-exists' error if file NEWNAME already exists,
2384 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2385 A number as third arg means request confirmation if NEWNAME already exists.
2386 This is what happens in interactive use with M-x.
2387 Fourth arg KEEP-TIME non-nil means give the new file the same
2388 last-modified time as the old one. (This works on only some systems.)
2389 A prefix arg makes KEEP-TIME non-nil.
2390 Also set the file modes of the target file to match the source file. */)
2391 (file, newname, ok_if_already_exists, keep_time)
2392 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2394 int ifd, ofd, n;
2395 char buf[16 * 1024];
2396 struct stat st, out_st;
2397 Lisp_Object handler;
2398 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2399 int count = SPECPDL_INDEX ();
2400 int input_file_statable_p;
2401 Lisp_Object encoded_file, encoded_newname;
2403 encoded_file = encoded_newname = Qnil;
2404 GCPRO4 (file, newname, encoded_file, encoded_newname);
2405 CHECK_STRING (file);
2406 CHECK_STRING (newname);
2408 if (!NILP (Ffile_directory_p (newname)))
2409 newname = Fexpand_file_name (file, newname);
2410 else
2411 newname = Fexpand_file_name (newname, Qnil);
2413 file = Fexpand_file_name (file, Qnil);
2415 /* If the input file name has special constructs in it,
2416 call the corresponding file handler. */
2417 handler = Ffind_file_name_handler (file, Qcopy_file);
2418 /* Likewise for output file name. */
2419 if (NILP (handler))
2420 handler = Ffind_file_name_handler (newname, Qcopy_file);
2421 if (!NILP (handler))
2422 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2423 ok_if_already_exists, keep_time));
2425 encoded_file = ENCODE_FILE (file);
2426 encoded_newname = ENCODE_FILE (newname);
2428 if (NILP (ok_if_already_exists)
2429 || INTEGERP (ok_if_already_exists))
2430 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2431 INTEGERP (ok_if_already_exists), &out_st, 0);
2432 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2433 out_st.st_mode = 0;
2435 #ifdef WINDOWSNT
2436 if (!CopyFile (SDATA (encoded_file),
2437 SDATA (encoded_newname),
2438 FALSE))
2439 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2440 /* CopyFile retains the timestamp by default. */
2441 else if (NILP (keep_time))
2443 EMACS_TIME now;
2444 DWORD attributes;
2445 char * filename;
2447 EMACS_GET_TIME (now);
2448 filename = SDATA (encoded_newname);
2450 /* Ensure file is writable while its modified time is set. */
2451 attributes = GetFileAttributes (filename);
2452 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2453 if (set_file_times (filename, now, now))
2455 /* Restore original attributes. */
2456 SetFileAttributes (filename, attributes);
2457 Fsignal (Qfile_date_error,
2458 Fcons (build_string ("Cannot set file date"),
2459 Fcons (newname, Qnil)));
2461 /* Restore original attributes. */
2462 SetFileAttributes (filename, attributes);
2464 #else /* not WINDOWSNT */
2465 immediate_quit = 1;
2466 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2467 immediate_quit = 0;
2469 if (ifd < 0)
2470 report_file_error ("Opening input file", Fcons (file, Qnil));
2472 record_unwind_protect (close_file_unwind, make_number (ifd));
2474 /* We can only copy regular files and symbolic links. Other files are not
2475 copyable by us. */
2476 input_file_statable_p = (fstat (ifd, &st) >= 0);
2478 #if !defined (DOS_NT) || __DJGPP__ > 1
2479 if (out_st.st_mode != 0
2480 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2482 errno = 0;
2483 report_file_error ("Input and output files are the same",
2484 Fcons (file, Fcons (newname, Qnil)));
2486 #endif
2488 #if defined (S_ISREG) && defined (S_ISLNK)
2489 if (input_file_statable_p)
2491 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2493 #if defined (EISDIR)
2494 /* Get a better looking error message. */
2495 errno = EISDIR;
2496 #endif /* EISDIR */
2497 report_file_error ("Non-regular file", Fcons (file, Qnil));
2500 #endif /* S_ISREG && S_ISLNK */
2502 #ifdef VMS
2503 /* Create the copy file with the same record format as the input file */
2504 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2505 #else
2506 #ifdef MSDOS
2507 /* System's default file type was set to binary by _fmode in emacs.c. */
2508 ofd = creat (SDATA (encoded_newname), S_IREAD | S_IWRITE);
2509 #else /* not MSDOS */
2510 ofd = creat (SDATA (encoded_newname), 0666);
2511 #endif /* not MSDOS */
2512 #endif /* VMS */
2513 if (ofd < 0)
2514 report_file_error ("Opening output file", Fcons (newname, Qnil));
2516 record_unwind_protect (close_file_unwind, make_number (ofd));
2518 immediate_quit = 1;
2519 QUIT;
2520 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2521 if (emacs_write (ofd, buf, n) != n)
2522 report_file_error ("I/O error", Fcons (newname, Qnil));
2523 immediate_quit = 0;
2525 /* Closing the output clobbers the file times on some systems. */
2526 if (emacs_close (ofd) < 0)
2527 report_file_error ("I/O error", Fcons (newname, Qnil));
2529 if (input_file_statable_p)
2531 if (!NILP (keep_time))
2533 EMACS_TIME atime, mtime;
2534 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2535 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2536 if (set_file_times (SDATA (encoded_newname),
2537 atime, mtime))
2538 Fsignal (Qfile_date_error,
2539 Fcons (build_string ("Cannot set file date"),
2540 Fcons (newname, Qnil)));
2542 #ifndef MSDOS
2543 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2544 #else /* MSDOS */
2545 #if defined (__DJGPP__) && __DJGPP__ > 1
2546 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2547 and if it can't, it tells so. Otherwise, under MSDOS we usually
2548 get only the READ bit, which will make the copied file read-only,
2549 so it's better not to chmod at all. */
2550 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2551 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2552 #endif /* DJGPP version 2 or newer */
2553 #endif /* MSDOS */
2556 emacs_close (ifd);
2557 #endif /* WINDOWSNT */
2559 /* Discard the unwind protects. */
2560 specpdl_ptr = specpdl + count;
2562 UNGCPRO;
2563 return Qnil;
2566 DEFUN ("make-directory-internal", Fmake_directory_internal,
2567 Smake_directory_internal, 1, 1, 0,
2568 doc: /* Create a new directory named DIRECTORY. */)
2569 (directory)
2570 Lisp_Object directory;
2572 const unsigned char *dir;
2573 Lisp_Object handler;
2574 Lisp_Object encoded_dir;
2576 CHECK_STRING (directory);
2577 directory = Fexpand_file_name (directory, Qnil);
2579 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2580 if (!NILP (handler))
2581 return call2 (handler, Qmake_directory_internal, directory);
2583 encoded_dir = ENCODE_FILE (directory);
2585 dir = SDATA (encoded_dir);
2587 #ifdef WINDOWSNT
2588 if (mkdir (dir) != 0)
2589 #else
2590 if (mkdir (dir, 0777) != 0)
2591 #endif
2592 report_file_error ("Creating directory", Flist (1, &directory));
2594 return Qnil;
2597 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2598 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2599 (directory)
2600 Lisp_Object directory;
2602 const unsigned char *dir;
2603 Lisp_Object handler;
2604 Lisp_Object encoded_dir;
2606 CHECK_STRING (directory);
2607 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2609 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2610 if (!NILP (handler))
2611 return call2 (handler, Qdelete_directory, directory);
2613 encoded_dir = ENCODE_FILE (directory);
2615 dir = SDATA (encoded_dir);
2617 if (rmdir (dir) != 0)
2618 report_file_error ("Removing directory", Flist (1, &directory));
2620 return Qnil;
2623 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2624 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2625 If file has multiple names, it continues to exist with the other names. */)
2626 (filename)
2627 Lisp_Object filename;
2629 Lisp_Object handler;
2630 Lisp_Object encoded_file;
2631 struct gcpro gcpro1;
2633 GCPRO1 (filename);
2634 if (!NILP (Ffile_directory_p (filename))
2635 && NILP (Ffile_symlink_p (filename)))
2636 Fsignal (Qfile_error,
2637 Fcons (build_string ("Removing old name: is a directory"),
2638 Fcons (filename, Qnil)));
2639 UNGCPRO;
2640 filename = Fexpand_file_name (filename, Qnil);
2642 handler = Ffind_file_name_handler (filename, Qdelete_file);
2643 if (!NILP (handler))
2644 return call2 (handler, Qdelete_file, filename);
2646 encoded_file = ENCODE_FILE (filename);
2648 if (0 > unlink (SDATA (encoded_file)))
2649 report_file_error ("Removing old name", Flist (1, &filename));
2650 return Qnil;
2653 static Lisp_Object
2654 internal_delete_file_1 (ignore)
2655 Lisp_Object ignore;
2657 return Qt;
2660 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2663 internal_delete_file (filename)
2664 Lisp_Object filename;
2666 return NILP (internal_condition_case_1 (Fdelete_file, filename,
2667 Qt, internal_delete_file_1));
2670 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2671 "fRename file: \nFRename %s to file: \np",
2672 doc: /* Rename FILE as NEWNAME. Both args strings.
2673 If file has names other than FILE, it continues to have those names.
2674 Signals a `file-already-exists' error if a file NEWNAME already exists
2675 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2676 A number as third arg means request confirmation if NEWNAME already exists.
2677 This is what happens in interactive use with M-x. */)
2678 (file, newname, ok_if_already_exists)
2679 Lisp_Object file, newname, ok_if_already_exists;
2681 #ifdef NO_ARG_ARRAY
2682 Lisp_Object args[2];
2683 #endif
2684 Lisp_Object handler;
2685 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2686 Lisp_Object encoded_file, encoded_newname;
2688 encoded_file = encoded_newname = Qnil;
2689 GCPRO4 (file, newname, encoded_file, encoded_newname);
2690 CHECK_STRING (file);
2691 CHECK_STRING (newname);
2692 file = Fexpand_file_name (file, Qnil);
2693 newname = Fexpand_file_name (newname, Qnil);
2695 /* If the file name has special constructs in it,
2696 call the corresponding file handler. */
2697 handler = Ffind_file_name_handler (file, Qrename_file);
2698 if (NILP (handler))
2699 handler = Ffind_file_name_handler (newname, Qrename_file);
2700 if (!NILP (handler))
2701 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2702 file, newname, ok_if_already_exists));
2704 encoded_file = ENCODE_FILE (file);
2705 encoded_newname = ENCODE_FILE (newname);
2707 #ifdef DOS_NT
2708 /* If the file names are identical but for the case, don't ask for
2709 confirmation: they simply want to change the letter-case of the
2710 file name. */
2711 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2712 #endif
2713 if (NILP (ok_if_already_exists)
2714 || INTEGERP (ok_if_already_exists))
2715 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2716 INTEGERP (ok_if_already_exists), 0, 0);
2717 #ifndef BSD4_1
2718 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2719 #else
2720 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2721 || 0 > unlink (SDATA (encoded_file)))
2722 #endif
2724 if (errno == EXDEV)
2726 Fcopy_file (file, newname,
2727 /* We have already prompted if it was an integer,
2728 so don't have copy-file prompt again. */
2729 NILP (ok_if_already_exists) ? Qnil : Qt, Qt);
2730 Fdelete_file (file);
2732 else
2733 #ifdef NO_ARG_ARRAY
2735 args[0] = file;
2736 args[1] = newname;
2737 report_file_error ("Renaming", Flist (2, args));
2739 #else
2740 report_file_error ("Renaming", Flist (2, &file));
2741 #endif
2743 UNGCPRO;
2744 return Qnil;
2747 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2748 "fAdd name to file: \nFName to add to %s: \np",
2749 doc: /* Give FILE additional name NEWNAME. Both args strings.
2750 Signals a `file-already-exists' error if a file NEWNAME already exists
2751 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2752 A number as third arg means request confirmation if NEWNAME already exists.
2753 This is what happens in interactive use with M-x. */)
2754 (file, newname, ok_if_already_exists)
2755 Lisp_Object file, newname, ok_if_already_exists;
2757 #ifdef NO_ARG_ARRAY
2758 Lisp_Object args[2];
2759 #endif
2760 Lisp_Object handler;
2761 Lisp_Object encoded_file, encoded_newname;
2762 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2764 GCPRO4 (file, newname, encoded_file, encoded_newname);
2765 encoded_file = encoded_newname = Qnil;
2766 CHECK_STRING (file);
2767 CHECK_STRING (newname);
2768 file = Fexpand_file_name (file, Qnil);
2769 newname = Fexpand_file_name (newname, Qnil);
2771 /* If the file name has special constructs in it,
2772 call the corresponding file handler. */
2773 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2774 if (!NILP (handler))
2775 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2776 newname, ok_if_already_exists));
2778 /* If the new name has special constructs in it,
2779 call the corresponding file handler. */
2780 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2781 if (!NILP (handler))
2782 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2783 newname, ok_if_already_exists));
2785 encoded_file = ENCODE_FILE (file);
2786 encoded_newname = ENCODE_FILE (newname);
2788 if (NILP (ok_if_already_exists)
2789 || INTEGERP (ok_if_already_exists))
2790 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2791 INTEGERP (ok_if_already_exists), 0, 0);
2793 unlink (SDATA (newname));
2794 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2796 #ifdef NO_ARG_ARRAY
2797 args[0] = file;
2798 args[1] = newname;
2799 report_file_error ("Adding new name", Flist (2, args));
2800 #else
2801 report_file_error ("Adding new name", Flist (2, &file));
2802 #endif
2805 UNGCPRO;
2806 return Qnil;
2809 #ifdef S_IFLNK
2810 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2811 "FMake symbolic link to file: \nFMake symbolic link to file %s: \np",
2812 doc: /* Make a symbolic link to FILENAME, named LINKNAME. Both args strings.
2813 Signals a `file-already-exists' error if a file LINKNAME already exists
2814 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2815 A number as third arg means request confirmation if LINKNAME already exists.
2816 This happens for interactive use with M-x. */)
2817 (filename, linkname, ok_if_already_exists)
2818 Lisp_Object filename, linkname, ok_if_already_exists;
2820 #ifdef NO_ARG_ARRAY
2821 Lisp_Object args[2];
2822 #endif
2823 Lisp_Object handler;
2824 Lisp_Object encoded_filename, encoded_linkname;
2825 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2827 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2828 encoded_filename = encoded_linkname = Qnil;
2829 CHECK_STRING (filename);
2830 CHECK_STRING (linkname);
2831 /* If the link target has a ~, we must expand it to get
2832 a truly valid file name. Otherwise, do not expand;
2833 we want to permit links to relative file names. */
2834 if (SREF (filename, 0) == '~')
2835 filename = Fexpand_file_name (filename, Qnil);
2836 linkname = Fexpand_file_name (linkname, Qnil);
2838 /* If the file name has special constructs in it,
2839 call the corresponding file handler. */
2840 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2841 if (!NILP (handler))
2842 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2843 linkname, ok_if_already_exists));
2845 /* If the new link name has special constructs in it,
2846 call the corresponding file handler. */
2847 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2848 if (!NILP (handler))
2849 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2850 linkname, ok_if_already_exists));
2852 encoded_filename = ENCODE_FILE (filename);
2853 encoded_linkname = ENCODE_FILE (linkname);
2855 if (NILP (ok_if_already_exists)
2856 || INTEGERP (ok_if_already_exists))
2857 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2858 INTEGERP (ok_if_already_exists), 0, 0);
2859 if (0 > symlink (SDATA (encoded_filename),
2860 SDATA (encoded_linkname)))
2862 /* If we didn't complain already, silently delete existing file. */
2863 if (errno == EEXIST)
2865 unlink (SDATA (encoded_linkname));
2866 if (0 <= symlink (SDATA (encoded_filename),
2867 SDATA (encoded_linkname)))
2869 UNGCPRO;
2870 return Qnil;
2874 #ifdef NO_ARG_ARRAY
2875 args[0] = filename;
2876 args[1] = linkname;
2877 report_file_error ("Making symbolic link", Flist (2, args));
2878 #else
2879 report_file_error ("Making symbolic link", Flist (2, &filename));
2880 #endif
2882 UNGCPRO;
2883 return Qnil;
2885 #endif /* S_IFLNK */
2887 #ifdef VMS
2889 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2890 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2891 doc: /* Define the job-wide logical name NAME to have the value STRING.
2892 If STRING is nil or a null string, the logical name NAME is deleted. */)
2893 (name, string)
2894 Lisp_Object name;
2895 Lisp_Object string;
2897 CHECK_STRING (name);
2898 if (NILP (string))
2899 delete_logical_name (SDATA (name));
2900 else
2902 CHECK_STRING (string);
2904 if (SCHARS (string) == 0)
2905 delete_logical_name (SDATA (name));
2906 else
2907 define_logical_name (SDATA (name), SDATA (string));
2910 return string;
2912 #endif /* VMS */
2914 #ifdef HPUX_NET
2916 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2917 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2918 (path, login)
2919 Lisp_Object path, login;
2921 int netresult;
2923 CHECK_STRING (path);
2924 CHECK_STRING (login);
2926 netresult = netunam (SDATA (path), SDATA (login));
2928 if (netresult == -1)
2929 return Qnil;
2930 else
2931 return Qt;
2933 #endif /* HPUX_NET */
2935 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2936 1, 1, 0,
2937 doc: /* Return t if file FILENAME specifies an absolute file name.
2938 On Unix, this is a name starting with a `/' or a `~'. */)
2939 (filename)
2940 Lisp_Object filename;
2942 const unsigned char *ptr;
2944 CHECK_STRING (filename);
2945 ptr = SDATA (filename);
2946 if (IS_DIRECTORY_SEP (*ptr) || *ptr == '~'
2947 #ifdef VMS
2948 /* ??? This criterion is probably wrong for '<'. */
2949 || index (ptr, ':') || index (ptr, '<')
2950 || (*ptr == '[' && (ptr[1] != '-' || (ptr[2] != '.' && ptr[2] != ']'))
2951 && ptr[1] != '.')
2952 #endif /* VMS */
2953 #ifdef DOS_NT
2954 || (IS_DRIVE (*ptr) && ptr[1] == ':' && IS_DIRECTORY_SEP (ptr[2]))
2955 #endif
2957 return Qt;
2958 else
2959 return Qnil;
2962 /* Return nonzero if file FILENAME exists and can be executed. */
2964 static int
2965 check_executable (filename)
2966 char *filename;
2968 #ifdef DOS_NT
2969 int len = strlen (filename);
2970 char *suffix;
2971 struct stat st;
2972 if (stat (filename, &st) < 0)
2973 return 0;
2974 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2975 return ((st.st_mode & S_IEXEC) != 0);
2976 #else
2977 return (S_ISREG (st.st_mode)
2978 && len >= 5
2979 && (stricmp ((suffix = filename + len-4), ".com") == 0
2980 || stricmp (suffix, ".exe") == 0
2981 || stricmp (suffix, ".bat") == 0)
2982 || (st.st_mode & S_IFMT) == S_IFDIR);
2983 #endif /* not WINDOWSNT */
2984 #else /* not DOS_NT */
2985 #ifdef HAVE_EUIDACCESS
2986 return (euidaccess (filename, 1) >= 0);
2987 #else
2988 /* Access isn't quite right because it uses the real uid
2989 and we really want to test with the effective uid.
2990 But Unix doesn't give us a right way to do it. */
2991 return (access (filename, 1) >= 0);
2992 #endif
2993 #endif /* not DOS_NT */
2996 /* Return nonzero if file FILENAME exists and can be written. */
2998 static int
2999 check_writable (filename)
3000 char *filename;
3002 #ifdef MSDOS
3003 struct stat st;
3004 if (stat (filename, &st) < 0)
3005 return 0;
3006 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3007 #else /* not MSDOS */
3008 #ifdef HAVE_EUIDACCESS
3009 return (euidaccess (filename, 2) >= 0);
3010 #else
3011 /* Access isn't quite right because it uses the real uid
3012 and we really want to test with the effective uid.
3013 But Unix doesn't give us a right way to do it.
3014 Opening with O_WRONLY could work for an ordinary file,
3015 but would lose for directories. */
3016 return (access (filename, 2) >= 0);
3017 #endif
3018 #endif /* not MSDOS */
3021 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3022 doc: /* Return t if file FILENAME exists. (This does not mean you can read it.)
3023 See also `file-readable-p' and `file-attributes'. */)
3024 (filename)
3025 Lisp_Object filename;
3027 Lisp_Object absname;
3028 Lisp_Object handler;
3029 struct stat statbuf;
3031 CHECK_STRING (filename);
3032 absname = Fexpand_file_name (filename, Qnil);
3034 /* If the file name has special constructs in it,
3035 call the corresponding file handler. */
3036 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3037 if (!NILP (handler))
3038 return call2 (handler, Qfile_exists_p, absname);
3040 absname = ENCODE_FILE (absname);
3042 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3045 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3046 doc: /* Return t if FILENAME can be executed by you.
3047 For a directory, this means you can access files in that directory. */)
3048 (filename)
3049 Lisp_Object filename;
3051 Lisp_Object absname;
3052 Lisp_Object handler;
3054 CHECK_STRING (filename);
3055 absname = Fexpand_file_name (filename, Qnil);
3057 /* If the file name has special constructs in it,
3058 call the corresponding file handler. */
3059 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3060 if (!NILP (handler))
3061 return call2 (handler, Qfile_executable_p, absname);
3063 absname = ENCODE_FILE (absname);
3065 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3068 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3069 doc: /* Return t if file FILENAME exists and you can read it.
3070 See also `file-exists-p' and `file-attributes'. */)
3071 (filename)
3072 Lisp_Object filename;
3074 Lisp_Object absname;
3075 Lisp_Object handler;
3076 int desc;
3077 int flags;
3078 struct stat statbuf;
3080 CHECK_STRING (filename);
3081 absname = Fexpand_file_name (filename, Qnil);
3083 /* If the file name has special constructs in it,
3084 call the corresponding file handler. */
3085 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3086 if (!NILP (handler))
3087 return call2 (handler, Qfile_readable_p, absname);
3089 absname = ENCODE_FILE (absname);
3091 #if defined(DOS_NT) || defined(macintosh)
3092 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3093 directories. */
3094 if (access (SDATA (absname), 0) == 0)
3095 return Qt;
3096 return Qnil;
3097 #else /* not DOS_NT and not macintosh */
3098 flags = O_RDONLY;
3099 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3100 /* Opening a fifo without O_NONBLOCK can wait.
3101 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3102 except in the case of a fifo, on a system which handles it. */
3103 desc = stat (SDATA (absname), &statbuf);
3104 if (desc < 0)
3105 return Qnil;
3106 if (S_ISFIFO (statbuf.st_mode))
3107 flags |= O_NONBLOCK;
3108 #endif
3109 desc = emacs_open (SDATA (absname), flags, 0);
3110 if (desc < 0)
3111 return Qnil;
3112 emacs_close (desc);
3113 return Qt;
3114 #endif /* not DOS_NT and not macintosh */
3117 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3118 on the RT/PC. */
3119 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3120 doc: /* Return t if file FILENAME can be written or created by you. */)
3121 (filename)
3122 Lisp_Object filename;
3124 Lisp_Object absname, dir, encoded;
3125 Lisp_Object handler;
3126 struct stat statbuf;
3128 CHECK_STRING (filename);
3129 absname = Fexpand_file_name (filename, Qnil);
3131 /* If the file name has special constructs in it,
3132 call the corresponding file handler. */
3133 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3134 if (!NILP (handler))
3135 return call2 (handler, Qfile_writable_p, absname);
3137 encoded = ENCODE_FILE (absname);
3138 if (stat (SDATA (encoded), &statbuf) >= 0)
3139 return (check_writable (SDATA (encoded))
3140 ? Qt : Qnil);
3142 dir = Ffile_name_directory (absname);
3143 #ifdef VMS
3144 if (!NILP (dir))
3145 dir = Fdirectory_file_name (dir);
3146 #endif /* VMS */
3147 #ifdef MSDOS
3148 if (!NILP (dir))
3149 dir = Fdirectory_file_name (dir);
3150 #endif /* MSDOS */
3152 dir = ENCODE_FILE (dir);
3153 #ifdef WINDOWSNT
3154 /* The read-only attribute of the parent directory doesn't affect
3155 whether a file or directory can be created within it. Some day we
3156 should check ACLs though, which do affect this. */
3157 if (stat (SDATA (dir), &statbuf) < 0)
3158 return Qnil;
3159 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3160 #else
3161 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3162 ? Qt : Qnil);
3163 #endif
3166 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3167 doc: /* Access file FILENAME, and get an error if that does not work.
3168 The second argument STRING is used in the error message.
3169 If there is no error, we return nil. */)
3170 (filename, string)
3171 Lisp_Object filename, string;
3173 Lisp_Object handler, encoded_filename, absname;
3174 int fd;
3176 CHECK_STRING (filename);
3177 absname = Fexpand_file_name (filename, Qnil);
3179 CHECK_STRING (string);
3181 /* If the file name has special constructs in it,
3182 call the corresponding file handler. */
3183 handler = Ffind_file_name_handler (absname, Qaccess_file);
3184 if (!NILP (handler))
3185 return call3 (handler, Qaccess_file, absname, string);
3187 encoded_filename = ENCODE_FILE (absname);
3189 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3190 if (fd < 0)
3191 report_file_error (SDATA (string), Fcons (filename, Qnil));
3192 emacs_close (fd);
3194 return Qnil;
3197 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3198 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3199 The value is the link target, as a string.
3200 Otherwise returns nil. */)
3201 (filename)
3202 Lisp_Object filename;
3204 Lisp_Object handler;
3206 CHECK_STRING (filename);
3207 filename = Fexpand_file_name (filename, Qnil);
3209 /* If the file name has special constructs in it,
3210 call the corresponding file handler. */
3211 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3212 if (!NILP (handler))
3213 return call2 (handler, Qfile_symlink_p, filename);
3215 #ifdef S_IFLNK
3217 char *buf;
3218 int bufsize;
3219 int valsize;
3220 Lisp_Object val;
3222 filename = ENCODE_FILE (filename);
3224 bufsize = 50;
3225 buf = NULL;
3228 bufsize *= 2;
3229 buf = (char *) xrealloc (buf, bufsize);
3230 bzero (buf, bufsize);
3232 errno = 0;
3233 valsize = readlink (SDATA (filename), buf, bufsize);
3234 if (valsize == -1)
3236 #ifdef ERANGE
3237 /* HP-UX reports ERANGE if buffer is too small. */
3238 if (errno == ERANGE)
3239 valsize = bufsize;
3240 else
3241 #endif
3243 xfree (buf);
3244 return Qnil;
3248 while (valsize >= bufsize);
3250 val = make_string (buf, valsize);
3251 if (buf[0] == '/' && index (buf, ':'))
3252 val = concat2 (build_string ("/:"), val);
3253 xfree (buf);
3254 val = DECODE_FILE (val);
3255 return val;
3257 #else /* not S_IFLNK */
3258 return Qnil;
3259 #endif /* not S_IFLNK */
3262 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3263 doc: /* Return t if FILENAME names an existing directory.
3264 Symbolic links to directories count as directories.
3265 See `file-symlink-p' to distinguish symlinks. */)
3266 (filename)
3267 Lisp_Object filename;
3269 register Lisp_Object absname;
3270 struct stat st;
3271 Lisp_Object handler;
3273 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3275 /* If the file name has special constructs in it,
3276 call the corresponding file handler. */
3277 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3278 if (!NILP (handler))
3279 return call2 (handler, Qfile_directory_p, absname);
3281 absname = ENCODE_FILE (absname);
3283 if (stat (SDATA (absname), &st) < 0)
3284 return Qnil;
3285 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3288 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3289 doc: /* Return t if file FILENAME names a directory you can open.
3290 For the value to be t, FILENAME must specify the name of a directory as a file,
3291 and the directory must allow you to open files in it. In order to use a
3292 directory as a buffer's current directory, this predicate must return true.
3293 A directory name spec may be given instead; then the value is t
3294 if the directory so specified exists and really is a readable and
3295 searchable directory. */)
3296 (filename)
3297 Lisp_Object filename;
3299 Lisp_Object handler;
3300 int tem;
3301 struct gcpro gcpro1;
3303 /* If the file name has special constructs in it,
3304 call the corresponding file handler. */
3305 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3306 if (!NILP (handler))
3307 return call2 (handler, Qfile_accessible_directory_p, filename);
3309 GCPRO1 (filename);
3310 tem = (NILP (Ffile_directory_p (filename))
3311 || NILP (Ffile_executable_p (filename)));
3312 UNGCPRO;
3313 return tem ? Qnil : Qt;
3316 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3317 doc: /* Return t if file FILENAME is the name of a regular file.
3318 This is the sort of file that holds an ordinary stream of data bytes. */)
3319 (filename)
3320 Lisp_Object filename;
3322 register Lisp_Object absname;
3323 struct stat st;
3324 Lisp_Object handler;
3326 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3328 /* If the file name has special constructs in it,
3329 call the corresponding file handler. */
3330 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3331 if (!NILP (handler))
3332 return call2 (handler, Qfile_regular_p, absname);
3334 absname = ENCODE_FILE (absname);
3336 #ifdef WINDOWSNT
3338 int result;
3339 Lisp_Object tem = Vw32_get_true_file_attributes;
3341 /* Tell stat to use expensive method to get accurate info. */
3342 Vw32_get_true_file_attributes = Qt;
3343 result = stat (SDATA (absname), &st);
3344 Vw32_get_true_file_attributes = tem;
3346 if (result < 0)
3347 return Qnil;
3348 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3350 #else
3351 if (stat (SDATA (absname), &st) < 0)
3352 return Qnil;
3353 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3354 #endif
3357 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3358 doc: /* Return mode bits of file named FILENAME, as an integer. */)
3359 (filename)
3360 Lisp_Object filename;
3362 Lisp_Object absname;
3363 struct stat st;
3364 Lisp_Object handler;
3366 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3368 /* If the file name has special constructs in it,
3369 call the corresponding file handler. */
3370 handler = Ffind_file_name_handler (absname, Qfile_modes);
3371 if (!NILP (handler))
3372 return call2 (handler, Qfile_modes, absname);
3374 absname = ENCODE_FILE (absname);
3376 if (stat (SDATA (absname), &st) < 0)
3377 return Qnil;
3378 #if defined (MSDOS) && __DJGPP__ < 2
3379 if (check_executable (SDATA (absname)))
3380 st.st_mode |= S_IEXEC;
3381 #endif /* MSDOS && __DJGPP__ < 2 */
3383 return make_number (st.st_mode & 07777);
3386 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3387 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3388 Only the 12 low bits of MODE are used. */)
3389 (filename, mode)
3390 Lisp_Object filename, mode;
3392 Lisp_Object absname, encoded_absname;
3393 Lisp_Object handler;
3395 absname = Fexpand_file_name (filename, current_buffer->directory);
3396 CHECK_NUMBER (mode);
3398 /* If the file name has special constructs in it,
3399 call the corresponding file handler. */
3400 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3401 if (!NILP (handler))
3402 return call3 (handler, Qset_file_modes, absname, mode);
3404 encoded_absname = ENCODE_FILE (absname);
3406 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3407 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3409 return Qnil;
3412 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3413 doc: /* Set the file permission bits for newly created files.
3414 The argument MODE should be an integer; only the low 9 bits are used.
3415 This setting is inherited by subprocesses. */)
3416 (mode)
3417 Lisp_Object mode;
3419 CHECK_NUMBER (mode);
3421 umask ((~ XINT (mode)) & 0777);
3423 return Qnil;
3426 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3427 doc: /* Return the default file protection for created files.
3428 The value is an integer. */)
3431 int realmask;
3432 Lisp_Object value;
3434 realmask = umask (0);
3435 umask (realmask);
3437 XSETINT (value, (~ realmask) & 0777);
3438 return value;
3442 #ifdef __NetBSD__
3443 #define unix 42
3444 #endif
3446 #ifdef unix
3447 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3448 doc: /* Tell Unix to finish all pending disk updates. */)
3451 sync ();
3452 return Qnil;
3455 #endif /* unix */
3457 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3458 doc: /* Return t if file FILE1 is newer than file FILE2.
3459 If FILE1 does not exist, the answer is nil;
3460 otherwise, if FILE2 does not exist, the answer is t. */)
3461 (file1, file2)
3462 Lisp_Object file1, file2;
3464 Lisp_Object absname1, absname2;
3465 struct stat st;
3466 int mtime1;
3467 Lisp_Object handler;
3468 struct gcpro gcpro1, gcpro2;
3470 CHECK_STRING (file1);
3471 CHECK_STRING (file2);
3473 absname1 = Qnil;
3474 GCPRO2 (absname1, file2);
3475 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3476 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3477 UNGCPRO;
3479 /* If the file name has special constructs in it,
3480 call the corresponding file handler. */
3481 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3482 if (NILP (handler))
3483 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3484 if (!NILP (handler))
3485 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3487 GCPRO2 (absname1, absname2);
3488 absname1 = ENCODE_FILE (absname1);
3489 absname2 = ENCODE_FILE (absname2);
3490 UNGCPRO;
3492 if (stat (SDATA (absname1), &st) < 0)
3493 return Qnil;
3495 mtime1 = st.st_mtime;
3497 if (stat (SDATA (absname2), &st) < 0)
3498 return Qt;
3500 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3503 #ifdef DOS_NT
3504 Lisp_Object Qfind_buffer_file_type;
3505 #endif /* DOS_NT */
3507 #ifndef READ_BUF_SIZE
3508 #define READ_BUF_SIZE (64 << 10)
3509 #endif
3511 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3513 /* This function is called after Lisp functions to decide a coding
3514 system are called, or when they cause an error. Before they are
3515 called, the current buffer is set unibyte and it contains only a
3516 newly inserted text (thus the buffer was empty before the
3517 insertion).
3519 The functions may set markers, overlays, text properties, or even
3520 alter the buffer contents, change the current buffer.
3522 Here, we reset all those changes by:
3523 o set back the current buffer.
3524 o move all markers and overlays to BEG.
3525 o remove all text properties.
3526 o set back the buffer multibyteness. */
3528 static Lisp_Object
3529 decide_coding_unwind (unwind_data)
3530 Lisp_Object unwind_data;
3532 Lisp_Object multibyte, undo_list, buffer;
3534 multibyte = XCAR (unwind_data);
3535 unwind_data = XCDR (unwind_data);
3536 undo_list = XCAR (unwind_data);
3537 buffer = XCDR (unwind_data);
3539 if (current_buffer != XBUFFER (buffer))
3540 set_buffer_internal (XBUFFER (buffer));
3541 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3542 adjust_overlays_for_delete (BEG, Z - BEG);
3543 BUF_INTERVALS (current_buffer) = 0;
3544 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3546 /* Now we are safe to change the buffer's multibyteness directly. */
3547 current_buffer->enable_multibyte_characters = multibyte;
3548 current_buffer->undo_list = undo_list;
3550 return Qnil;
3554 /* Used to pass values from insert-file-contents to read_non_regular. */
3556 static int non_regular_fd;
3557 static int non_regular_inserted;
3558 static int non_regular_nbytes;
3561 /* Read from a non-regular file.
3562 Read non_regular_trytry bytes max from non_regular_fd.
3563 Non_regular_inserted specifies where to put the read bytes.
3564 Value is the number of bytes read. */
3566 static Lisp_Object
3567 read_non_regular ()
3569 int nbytes;
3571 immediate_quit = 1;
3572 QUIT;
3573 nbytes = emacs_read (non_regular_fd,
3574 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3575 non_regular_nbytes);
3576 immediate_quit = 0;
3577 return make_number (nbytes);
3581 /* Condition-case handler used when reading from non-regular files
3582 in insert-file-contents. */
3584 static Lisp_Object
3585 read_non_regular_quit ()
3587 return Qnil;
3591 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3592 1, 5, 0,
3593 doc: /* Insert contents of file FILENAME after point.
3594 Returns list of absolute file name and number of characters inserted.
3595 If second argument VISIT is non-nil, the buffer's visited filename
3596 and last save file modtime are set, and it is marked unmodified.
3597 If visiting and the file does not exist, visiting is completed
3598 before the error is signaled.
3599 The optional third and fourth arguments BEG and END
3600 specify what portion of the file to insert.
3601 These arguments count bytes in the file, not characters in the buffer.
3602 If VISIT is non-nil, BEG and END must be nil.
3604 If optional fifth argument REPLACE is non-nil,
3605 it means replace the current buffer contents (in the accessible portion)
3606 with the file contents. This is better than simply deleting and inserting
3607 the whole thing because (1) it preserves some marker positions
3608 and (2) it puts less data in the undo list.
3609 When REPLACE is non-nil, the value is the number of characters actually read,
3610 which is often less than the number of characters to be read.
3612 This does code conversion according to the value of
3613 `coding-system-for-read' or `file-coding-system-alist',
3614 and sets the variable `last-coding-system-used' to the coding system
3615 actually used. */)
3616 (filename, visit, beg, end, replace)
3617 Lisp_Object filename, visit, beg, end, replace;
3619 struct stat st;
3620 register int fd;
3621 int inserted = 0;
3622 register int how_much;
3623 register int unprocessed;
3624 int count = SPECPDL_INDEX ();
3625 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3626 Lisp_Object handler, val, insval, orig_filename;
3627 Lisp_Object p;
3628 int total = 0;
3629 int not_regular = 0;
3630 unsigned char read_buf[READ_BUF_SIZE];
3631 struct coding_system coding;
3632 unsigned char buffer[1 << 14];
3633 int replace_handled = 0;
3634 int set_coding_system = 0;
3635 int coding_system_decided = 0;
3636 int read_quit = 0;
3638 if (current_buffer->base_buffer && ! NILP (visit))
3639 error ("Cannot do file visiting in an indirect buffer");
3641 if (!NILP (current_buffer->read_only))
3642 Fbarf_if_buffer_read_only ();
3644 val = Qnil;
3645 p = Qnil;
3646 orig_filename = Qnil;
3648 GCPRO4 (filename, val, p, orig_filename);
3650 CHECK_STRING (filename);
3651 filename = Fexpand_file_name (filename, Qnil);
3653 /* If the file name has special constructs in it,
3654 call the corresponding file handler. */
3655 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3656 if (!NILP (handler))
3658 val = call6 (handler, Qinsert_file_contents, filename,
3659 visit, beg, end, replace);
3660 if (CONSP (val) && CONSP (XCDR (val)))
3661 inserted = XINT (XCAR (XCDR (val)));
3662 goto handled;
3665 orig_filename = filename;
3666 filename = ENCODE_FILE (filename);
3668 fd = -1;
3670 #ifdef WINDOWSNT
3672 Lisp_Object tem = Vw32_get_true_file_attributes;
3674 /* Tell stat to use expensive method to get accurate info. */
3675 Vw32_get_true_file_attributes = Qt;
3676 total = stat (SDATA (filename), &st);
3677 Vw32_get_true_file_attributes = tem;
3679 if (total < 0)
3680 #else
3681 #ifndef APOLLO
3682 if (stat (SDATA (filename), &st) < 0)
3683 #else
3684 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3685 || fstat (fd, &st) < 0)
3686 #endif /* not APOLLO */
3687 #endif /* WINDOWSNT */
3689 if (fd >= 0) emacs_close (fd);
3690 badopen:
3691 if (NILP (visit))
3692 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3693 st.st_mtime = -1;
3694 how_much = 0;
3695 if (!NILP (Vcoding_system_for_read))
3696 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3697 goto notfound;
3700 #ifdef S_IFREG
3701 /* This code will need to be changed in order to work on named
3702 pipes, and it's probably just not worth it. So we should at
3703 least signal an error. */
3704 if (!S_ISREG (st.st_mode))
3706 not_regular = 1;
3708 if (! NILP (visit))
3709 goto notfound;
3711 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3712 Fsignal (Qfile_error,
3713 Fcons (build_string ("not a regular file"),
3714 Fcons (orig_filename, Qnil)));
3716 #endif
3718 if (fd < 0)
3719 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3720 goto badopen;
3722 /* Replacement should preserve point as it preserves markers. */
3723 if (!NILP (replace))
3724 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3726 record_unwind_protect (close_file_unwind, make_number (fd));
3728 /* Supposedly happens on VMS. */
3729 /* Can happen on any platform that uses long as type of off_t, but allows
3730 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3731 give a message suitable for the latter case. */
3732 if (! not_regular && st.st_size < 0)
3733 error ("Maximum buffer size exceeded");
3735 /* Prevent redisplay optimizations. */
3736 current_buffer->clip_changed = 1;
3738 if (!NILP (visit))
3740 if (!NILP (beg) || !NILP (end))
3741 error ("Attempt to visit less than an entire file");
3742 if (BEG < Z && NILP (replace))
3743 error ("Cannot do file visiting in a non-empty buffer");
3746 if (!NILP (beg))
3747 CHECK_NUMBER (beg);
3748 else
3749 XSETFASTINT (beg, 0);
3751 if (!NILP (end))
3752 CHECK_NUMBER (end);
3753 else
3755 if (! not_regular)
3757 XSETINT (end, st.st_size);
3759 /* Arithmetic overflow can occur if an Emacs integer cannot
3760 represent the file size, or if the calculations below
3761 overflow. The calculations below double the file size
3762 twice, so check that it can be multiplied by 4 safely. */
3763 if (XINT (end) != st.st_size
3764 || ((int) st.st_size * 4) / 4 != st.st_size)
3765 error ("Maximum buffer size exceeded");
3767 /* The file size returned from stat may be zero, but data
3768 may be readable nonetheless, for example when this is a
3769 file in the /proc filesystem. */
3770 if (st.st_size == 0)
3771 XSETINT (end, READ_BUF_SIZE);
3775 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3777 /* We use emacs-mule for auto saving... */
3778 setup_coding_system (Qemacs_mule, &coding);
3779 /* ... but with the special flag to indicate to read in a
3780 multibyte sequence for eight-bit-control char as is. */
3781 coding.flags = 1;
3782 coding.src_multibyte = 0;
3783 coding.dst_multibyte
3784 = !NILP (current_buffer->enable_multibyte_characters);
3785 coding.eol_type = CODING_EOL_LF;
3786 coding_system_decided = 1;
3788 else if (BEG < Z)
3790 /* Decide the coding system to use for reading the file now
3791 because we can't use an optimized method for handling
3792 `coding:' tag if the current buffer is not empty. */
3793 Lisp_Object val;
3794 val = Qnil;
3796 if (!NILP (Vcoding_system_for_read))
3797 val = Vcoding_system_for_read;
3798 else if (! NILP (replace))
3799 /* In REPLACE mode, we can use the same coding system
3800 that was used to visit the file. */
3801 val = current_buffer->buffer_file_coding_system;
3802 else
3804 /* Don't try looking inside a file for a coding system
3805 specification if it is not seekable. */
3806 if (! not_regular && ! NILP (Vset_auto_coding_function))
3808 /* Find a coding system specified in the heading two
3809 lines or in the tailing several lines of the file.
3810 We assume that the 1K-byte and 3K-byte for heading
3811 and tailing respectively are sufficient for this
3812 purpose. */
3813 int nread;
3815 if (st.st_size <= (1024 * 4))
3816 nread = emacs_read (fd, read_buf, 1024 * 4);
3817 else
3819 nread = emacs_read (fd, read_buf, 1024);
3820 if (nread >= 0)
3822 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3823 report_file_error ("Setting file position",
3824 Fcons (orig_filename, Qnil));
3825 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3829 if (nread < 0)
3830 error ("IO error reading %s: %s",
3831 SDATA (orig_filename), emacs_strerror (errno));
3832 else if (nread > 0)
3834 struct buffer *prev = current_buffer;
3835 Lisp_Object buffer;
3836 struct buffer *buf;
3838 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3840 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3841 buf = XBUFFER (buffer);
3843 delete_all_overlays (buf);
3844 buf->directory = current_buffer->directory;
3845 buf->read_only = Qnil;
3846 buf->filename = Qnil;
3847 buf->undo_list = Qt;
3848 eassert (buf->overlays_before == NULL);
3849 eassert (buf->overlays_after == NULL);
3851 set_buffer_internal (buf);
3852 Ferase_buffer ();
3853 buf->enable_multibyte_characters = Qnil;
3855 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3856 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3857 val = call2 (Vset_auto_coding_function,
3858 filename, make_number (nread));
3859 set_buffer_internal (prev);
3861 /* Discard the unwind protect for recovering the
3862 current buffer. */
3863 specpdl_ptr--;
3865 /* Rewind the file for the actual read done later. */
3866 if (lseek (fd, 0, 0) < 0)
3867 report_file_error ("Setting file position",
3868 Fcons (orig_filename, Qnil));
3872 if (NILP (val))
3874 /* If we have not yet decided a coding system, check
3875 file-coding-system-alist. */
3876 Lisp_Object args[6], coding_systems;
3878 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3879 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3880 coding_systems = Ffind_operation_coding_system (6, args);
3881 if (CONSP (coding_systems))
3882 val = XCAR (coding_systems);
3886 setup_coding_system (Fcheck_coding_system (val), &coding);
3887 /* Ensure we set Vlast_coding_system_used. */
3888 set_coding_system = 1;
3890 if (NILP (current_buffer->enable_multibyte_characters)
3891 && ! NILP (val))
3892 /* We must suppress all character code conversion except for
3893 end-of-line conversion. */
3894 setup_raw_text_coding_system (&coding);
3896 coding.src_multibyte = 0;
3897 coding.dst_multibyte
3898 = !NILP (current_buffer->enable_multibyte_characters);
3899 coding_system_decided = 1;
3902 /* If requested, replace the accessible part of the buffer
3903 with the file contents. Avoid replacing text at the
3904 beginning or end of the buffer that matches the file contents;
3905 that preserves markers pointing to the unchanged parts.
3907 Here we implement this feature in an optimized way
3908 for the case where code conversion is NOT needed.
3909 The following if-statement handles the case of conversion
3910 in a less optimal way.
3912 If the code conversion is "automatic" then we try using this
3913 method and hope for the best.
3914 But if we discover the need for conversion, we give up on this method
3915 and let the following if-statement handle the replace job. */
3916 if (!NILP (replace)
3917 && BEGV < ZV
3918 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
3920 /* same_at_start and same_at_end count bytes,
3921 because file access counts bytes
3922 and BEG and END count bytes. */
3923 int same_at_start = BEGV_BYTE;
3924 int same_at_end = ZV_BYTE;
3925 int overlap;
3926 /* There is still a possibility we will find the need to do code
3927 conversion. If that happens, we set this variable to 1 to
3928 give up on handling REPLACE in the optimized way. */
3929 int giveup_match_end = 0;
3931 if (XINT (beg) != 0)
3933 if (lseek (fd, XINT (beg), 0) < 0)
3934 report_file_error ("Setting file position",
3935 Fcons (orig_filename, Qnil));
3938 immediate_quit = 1;
3939 QUIT;
3940 /* Count how many chars at the start of the file
3941 match the text at the beginning of the buffer. */
3942 while (1)
3944 int nread, bufpos;
3946 nread = emacs_read (fd, buffer, sizeof buffer);
3947 if (nread < 0)
3948 error ("IO error reading %s: %s",
3949 SDATA (orig_filename), emacs_strerror (errno));
3950 else if (nread == 0)
3951 break;
3953 if (coding.type == coding_type_undecided)
3954 detect_coding (&coding, buffer, nread);
3955 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
3956 /* We found that the file should be decoded somehow.
3957 Let's give up here. */
3959 giveup_match_end = 1;
3960 break;
3963 if (coding.eol_type == CODING_EOL_UNDECIDED)
3964 detect_eol (&coding, buffer, nread);
3965 if (coding.eol_type != CODING_EOL_UNDECIDED
3966 && coding.eol_type != CODING_EOL_LF)
3967 /* We found that the format of eol should be decoded.
3968 Let's give up here. */
3970 giveup_match_end = 1;
3971 break;
3974 bufpos = 0;
3975 while (bufpos < nread && same_at_start < ZV_BYTE
3976 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3977 same_at_start++, bufpos++;
3978 /* If we found a discrepancy, stop the scan.
3979 Otherwise loop around and scan the next bufferful. */
3980 if (bufpos != nread)
3981 break;
3983 immediate_quit = 0;
3984 /* If the file matches the buffer completely,
3985 there's no need to replace anything. */
3986 if (same_at_start - BEGV_BYTE == XINT (end))
3988 emacs_close (fd);
3989 specpdl_ptr--;
3990 /* Truncate the buffer to the size of the file. */
3991 del_range_1 (same_at_start, same_at_end, 0, 0);
3992 goto handled;
3994 immediate_quit = 1;
3995 QUIT;
3996 /* Count how many chars at the end of the file
3997 match the text at the end of the buffer. But, if we have
3998 already found that decoding is necessary, don't waste time. */
3999 while (!giveup_match_end)
4001 int total_read, nread, bufpos, curpos, trial;
4003 /* At what file position are we now scanning? */
4004 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4005 /* If the entire file matches the buffer tail, stop the scan. */
4006 if (curpos == 0)
4007 break;
4008 /* How much can we scan in the next step? */
4009 trial = min (curpos, sizeof buffer);
4010 if (lseek (fd, curpos - trial, 0) < 0)
4011 report_file_error ("Setting file position",
4012 Fcons (orig_filename, Qnil));
4014 total_read = nread = 0;
4015 while (total_read < trial)
4017 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4018 if (nread < 0)
4019 error ("IO error reading %s: %s",
4020 SDATA (orig_filename), emacs_strerror (errno));
4021 else if (nread == 0)
4022 break;
4023 total_read += nread;
4026 /* Scan this bufferful from the end, comparing with
4027 the Emacs buffer. */
4028 bufpos = total_read;
4030 /* Compare with same_at_start to avoid counting some buffer text
4031 as matching both at the file's beginning and at the end. */
4032 while (bufpos > 0 && same_at_end > same_at_start
4033 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4034 same_at_end--, bufpos--;
4036 /* If we found a discrepancy, stop the scan.
4037 Otherwise loop around and scan the preceding bufferful. */
4038 if (bufpos != 0)
4040 /* If this discrepancy is because of code conversion,
4041 we cannot use this method; giveup and try the other. */
4042 if (same_at_end > same_at_start
4043 && FETCH_BYTE (same_at_end - 1) >= 0200
4044 && ! NILP (current_buffer->enable_multibyte_characters)
4045 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4046 giveup_match_end = 1;
4047 break;
4050 if (nread == 0)
4051 break;
4053 immediate_quit = 0;
4055 if (! giveup_match_end)
4057 int temp;
4059 /* We win! We can handle REPLACE the optimized way. */
4061 /* Extend the start of non-matching text area to multibyte
4062 character boundary. */
4063 if (! NILP (current_buffer->enable_multibyte_characters))
4064 while (same_at_start > BEGV_BYTE
4065 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4066 same_at_start--;
4068 /* Extend the end of non-matching text area to multibyte
4069 character boundary. */
4070 if (! NILP (current_buffer->enable_multibyte_characters))
4071 while (same_at_end < ZV_BYTE
4072 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4073 same_at_end++;
4075 /* Don't try to reuse the same piece of text twice. */
4076 overlap = (same_at_start - BEGV_BYTE
4077 - (same_at_end + st.st_size - ZV));
4078 if (overlap > 0)
4079 same_at_end += overlap;
4081 /* Arrange to read only the nonmatching middle part of the file. */
4082 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4083 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4085 del_range_byte (same_at_start, same_at_end, 0);
4086 /* Insert from the file at the proper position. */
4087 temp = BYTE_TO_CHAR (same_at_start);
4088 SET_PT_BOTH (temp, same_at_start);
4090 /* If display currently starts at beginning of line,
4091 keep it that way. */
4092 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4093 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4095 replace_handled = 1;
4099 /* If requested, replace the accessible part of the buffer
4100 with the file contents. Avoid replacing text at the
4101 beginning or end of the buffer that matches the file contents;
4102 that preserves markers pointing to the unchanged parts.
4104 Here we implement this feature for the case where code conversion
4105 is needed, in a simple way that needs a lot of memory.
4106 The preceding if-statement handles the case of no conversion
4107 in a more optimized way. */
4108 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4110 int same_at_start = BEGV_BYTE;
4111 int same_at_end = ZV_BYTE;
4112 int overlap;
4113 int bufpos;
4114 /* Make sure that the gap is large enough. */
4115 int bufsize = 2 * st.st_size;
4116 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4117 int temp;
4119 /* First read the whole file, performing code conversion into
4120 CONVERSION_BUFFER. */
4122 if (lseek (fd, XINT (beg), 0) < 0)
4124 xfree (conversion_buffer);
4125 report_file_error ("Setting file position",
4126 Fcons (orig_filename, Qnil));
4129 total = st.st_size; /* Total bytes in the file. */
4130 how_much = 0; /* Bytes read from file so far. */
4131 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4132 unprocessed = 0; /* Bytes not processed in previous loop. */
4134 while (how_much < total)
4136 /* try is reserved in some compilers (Microsoft C) */
4137 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4138 unsigned char *destination = read_buf + unprocessed;
4139 int this;
4141 /* Allow quitting out of the actual I/O. */
4142 immediate_quit = 1;
4143 QUIT;
4144 this = emacs_read (fd, destination, trytry);
4145 immediate_quit = 0;
4147 if (this < 0 || this + unprocessed == 0)
4149 how_much = this;
4150 break;
4153 how_much += this;
4155 if (CODING_MAY_REQUIRE_DECODING (&coding))
4157 int require, result;
4159 this += unprocessed;
4161 /* If we are using more space than estimated,
4162 make CONVERSION_BUFFER bigger. */
4163 require = decoding_buffer_size (&coding, this);
4164 if (inserted + require + 2 * (total - how_much) > bufsize)
4166 bufsize = inserted + require + 2 * (total - how_much);
4167 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4170 /* Convert this batch with results in CONVERSION_BUFFER. */
4171 if (how_much >= total) /* This is the last block. */
4172 coding.mode |= CODING_MODE_LAST_BLOCK;
4173 if (coding.composing != COMPOSITION_DISABLED)
4174 coding_allocate_composition_data (&coding, BEGV);
4175 result = decode_coding (&coding, read_buf,
4176 conversion_buffer + inserted,
4177 this, bufsize - inserted);
4179 /* Save for next iteration whatever we didn't convert. */
4180 unprocessed = this - coding.consumed;
4181 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4182 if (!NILP (current_buffer->enable_multibyte_characters))
4183 this = coding.produced;
4184 else
4185 this = str_as_unibyte (conversion_buffer + inserted,
4186 coding.produced);
4189 inserted += this;
4192 /* At this point, INSERTED is how many characters (i.e. bytes)
4193 are present in CONVERSION_BUFFER.
4194 HOW_MUCH should equal TOTAL,
4195 or should be <= 0 if we couldn't read the file. */
4197 if (how_much < 0)
4199 xfree (conversion_buffer);
4201 if (how_much == -1)
4202 error ("IO error reading %s: %s",
4203 SDATA (orig_filename), emacs_strerror (errno));
4204 else if (how_much == -2)
4205 error ("maximum buffer size exceeded");
4208 /* Compare the beginning of the converted file
4209 with the buffer text. */
4211 bufpos = 0;
4212 while (bufpos < inserted && same_at_start < same_at_end
4213 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4214 same_at_start++, bufpos++;
4216 /* If the file matches the buffer completely,
4217 there's no need to replace anything. */
4219 if (bufpos == inserted)
4221 xfree (conversion_buffer);
4222 emacs_close (fd);
4223 specpdl_ptr--;
4224 /* Truncate the buffer to the size of the file. */
4225 del_range_byte (same_at_start, same_at_end, 0);
4226 inserted = 0;
4227 goto handled;
4230 /* Extend the start of non-matching text area to multibyte
4231 character boundary. */
4232 if (! NILP (current_buffer->enable_multibyte_characters))
4233 while (same_at_start > BEGV_BYTE
4234 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4235 same_at_start--;
4237 /* Scan this bufferful from the end, comparing with
4238 the Emacs buffer. */
4239 bufpos = inserted;
4241 /* Compare with same_at_start to avoid counting some buffer text
4242 as matching both at the file's beginning and at the end. */
4243 while (bufpos > 0 && same_at_end > same_at_start
4244 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4245 same_at_end--, bufpos--;
4247 /* Extend the end of non-matching text area to multibyte
4248 character boundary. */
4249 if (! NILP (current_buffer->enable_multibyte_characters))
4250 while (same_at_end < ZV_BYTE
4251 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4252 same_at_end++;
4254 /* Don't try to reuse the same piece of text twice. */
4255 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4256 if (overlap > 0)
4257 same_at_end += overlap;
4259 /* If display currently starts at beginning of line,
4260 keep it that way. */
4261 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4262 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4264 /* Replace the chars that we need to replace,
4265 and update INSERTED to equal the number of bytes
4266 we are taking from the file. */
4267 inserted -= (Z_BYTE - same_at_end) + (same_at_start - BEG_BYTE);
4269 if (same_at_end != same_at_start)
4271 del_range_byte (same_at_start, same_at_end, 0);
4272 temp = GPT;
4273 same_at_start = GPT_BYTE;
4275 else
4277 temp = BYTE_TO_CHAR (same_at_start);
4279 /* Insert from the file at the proper position. */
4280 SET_PT_BOTH (temp, same_at_start);
4281 insert_1 (conversion_buffer + same_at_start - BEG_BYTE, inserted,
4282 0, 0, 0);
4283 if (coding.cmp_data && coding.cmp_data->used)
4284 coding_restore_composition (&coding, Fcurrent_buffer ());
4285 coding_free_composition_data (&coding);
4287 /* Set `inserted' to the number of inserted characters. */
4288 inserted = PT - temp;
4290 xfree (conversion_buffer);
4291 emacs_close (fd);
4292 specpdl_ptr--;
4294 goto handled;
4297 if (! not_regular)
4299 register Lisp_Object temp;
4301 total = XINT (end) - XINT (beg);
4303 /* Make sure point-max won't overflow after this insertion. */
4304 XSETINT (temp, total);
4305 if (total != XINT (temp))
4306 error ("Maximum buffer size exceeded");
4308 else
4309 /* For a special file, all we can do is guess. */
4310 total = READ_BUF_SIZE;
4312 if (NILP (visit) && total > 0)
4313 prepare_to_modify_buffer (PT, PT, NULL);
4315 move_gap (PT);
4316 if (GAP_SIZE < total)
4317 make_gap (total - GAP_SIZE);
4319 if (XINT (beg) != 0 || !NILP (replace))
4321 if (lseek (fd, XINT (beg), 0) < 0)
4322 report_file_error ("Setting file position",
4323 Fcons (orig_filename, Qnil));
4326 /* In the following loop, HOW_MUCH contains the total bytes read so
4327 far for a regular file, and not changed for a special file. But,
4328 before exiting the loop, it is set to a negative value if I/O
4329 error occurs. */
4330 how_much = 0;
4332 /* Total bytes inserted. */
4333 inserted = 0;
4335 /* Here, we don't do code conversion in the loop. It is done by
4336 code_convert_region after all data are read into the buffer. */
4338 int gap_size = GAP_SIZE;
4340 while (how_much < total)
4342 /* try is reserved in some compilers (Microsoft C) */
4343 int trytry = min (total - how_much, READ_BUF_SIZE);
4344 int this;
4346 if (not_regular)
4348 Lisp_Object val;
4350 /* Maybe make more room. */
4351 if (gap_size < trytry)
4353 make_gap (total - gap_size);
4354 gap_size = GAP_SIZE;
4357 /* Read from the file, capturing `quit'. When an
4358 error occurs, end the loop, and arrange for a quit
4359 to be signaled after decoding the text we read. */
4360 non_regular_fd = fd;
4361 non_regular_inserted = inserted;
4362 non_regular_nbytes = trytry;
4363 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4364 read_non_regular_quit);
4365 if (NILP (val))
4367 read_quit = 1;
4368 break;
4371 this = XINT (val);
4373 else
4375 /* Allow quitting out of the actual I/O. We don't make text
4376 part of the buffer until all the reading is done, so a C-g
4377 here doesn't do any harm. */
4378 immediate_quit = 1;
4379 QUIT;
4380 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4381 immediate_quit = 0;
4384 if (this <= 0)
4386 how_much = this;
4387 break;
4390 gap_size -= this;
4392 /* For a regular file, where TOTAL is the real size,
4393 count HOW_MUCH to compare with it.
4394 For a special file, where TOTAL is just a buffer size,
4395 so don't bother counting in HOW_MUCH.
4396 (INSERTED is where we count the number of characters inserted.) */
4397 if (! not_regular)
4398 how_much += this;
4399 inserted += this;
4403 /* Make the text read part of the buffer. */
4404 GAP_SIZE -= inserted;
4405 GPT += inserted;
4406 GPT_BYTE += inserted;
4407 ZV += inserted;
4408 ZV_BYTE += inserted;
4409 Z += inserted;
4410 Z_BYTE += inserted;
4412 if (GAP_SIZE > 0)
4413 /* Put an anchor to ensure multi-byte form ends at gap. */
4414 *GPT_ADDR = 0;
4416 emacs_close (fd);
4418 /* Discard the unwind protect for closing the file. */
4419 specpdl_ptr--;
4421 if (how_much < 0)
4422 error ("IO error reading %s: %s",
4423 SDATA (orig_filename), emacs_strerror (errno));
4425 notfound:
4427 if (! coding_system_decided)
4429 /* The coding system is not yet decided. Decide it by an
4430 optimized method for handling `coding:' tag.
4432 Note that we can get here only if the buffer was empty
4433 before the insertion. */
4434 Lisp_Object val;
4435 val = Qnil;
4437 if (!NILP (Vcoding_system_for_read))
4438 val = Vcoding_system_for_read;
4439 else
4441 /* Since we are sure that the current buffer was empty
4442 before the insertion, we can toggle
4443 enable-multibyte-characters directly here without taking
4444 care of marker adjustment and byte combining problem. By
4445 this way, we can run Lisp program safely before decoding
4446 the inserted text. */
4447 Lisp_Object unwind_data;
4448 int count = SPECPDL_INDEX ();
4450 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4451 Fcons (current_buffer->undo_list,
4452 Fcurrent_buffer ()));
4453 current_buffer->enable_multibyte_characters = Qnil;
4454 current_buffer->undo_list = Qt;
4455 record_unwind_protect (decide_coding_unwind, unwind_data);
4457 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4459 val = call2 (Vset_auto_coding_function,
4460 filename, make_number (inserted));
4463 if (NILP (val))
4465 /* If the coding system is not yet decided, check
4466 file-coding-system-alist. */
4467 Lisp_Object args[6], coding_systems;
4469 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4470 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4471 coding_systems = Ffind_operation_coding_system (6, args);
4472 if (CONSP (coding_systems))
4473 val = XCAR (coding_systems);
4476 unbind_to (count, Qnil);
4477 inserted = Z_BYTE - BEG_BYTE;
4480 /* The following kludgy code is to avoid some compiler bug.
4481 We can't simply do
4482 setup_coding_system (val, &coding);
4483 on some system. */
4485 struct coding_system temp_coding;
4486 setup_coding_system (val, &temp_coding);
4487 bcopy (&temp_coding, &coding, sizeof coding);
4489 /* Ensure we set Vlast_coding_system_used. */
4490 set_coding_system = 1;
4492 if (NILP (current_buffer->enable_multibyte_characters)
4493 && ! NILP (val))
4494 /* We must suppress all character code conversion except for
4495 end-of-line conversion. */
4496 setup_raw_text_coding_system (&coding);
4497 coding.src_multibyte = 0;
4498 coding.dst_multibyte
4499 = !NILP (current_buffer->enable_multibyte_characters);
4502 if (!NILP (visit)
4503 /* Can't do this if part of the buffer might be preserved. */
4504 && NILP (replace)
4505 && (coding.type == coding_type_no_conversion
4506 || coding.type == coding_type_raw_text))
4508 /* Visiting a file with these coding system makes the buffer
4509 unibyte. */
4510 current_buffer->enable_multibyte_characters = Qnil;
4511 coding.dst_multibyte = 0;
4514 if (inserted > 0 || coding.type == coding_type_ccl)
4516 if (CODING_MAY_REQUIRE_DECODING (&coding))
4518 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4519 &coding, 0, 0);
4520 inserted = coding.produced_char;
4522 else
4523 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4524 inserted);
4527 /* Now INSERTED is measured in characters. */
4529 #ifdef DOS_NT
4530 /* Use the conversion type to determine buffer-file-type
4531 (find-buffer-file-type is now used to help determine the
4532 conversion). */
4533 if ((coding.eol_type == CODING_EOL_UNDECIDED
4534 || coding.eol_type == CODING_EOL_LF)
4535 && ! CODING_REQUIRE_DECODING (&coding))
4536 current_buffer->buffer_file_type = Qt;
4537 else
4538 current_buffer->buffer_file_type = Qnil;
4539 #endif
4541 handled:
4543 if (!NILP (visit))
4545 if (!EQ (current_buffer->undo_list, Qt))
4546 current_buffer->undo_list = Qnil;
4547 #ifdef APOLLO
4548 stat (SDATA (filename), &st);
4549 #endif
4551 if (NILP (handler))
4553 current_buffer->modtime = st.st_mtime;
4554 current_buffer->filename = orig_filename;
4557 SAVE_MODIFF = MODIFF;
4558 current_buffer->auto_save_modified = MODIFF;
4559 XSETFASTINT (current_buffer->save_length, Z - BEG);
4560 #ifdef CLASH_DETECTION
4561 if (NILP (handler))
4563 if (!NILP (current_buffer->file_truename))
4564 unlock_file (current_buffer->file_truename);
4565 unlock_file (filename);
4567 #endif /* CLASH_DETECTION */
4568 if (not_regular)
4569 Fsignal (Qfile_error,
4570 Fcons (build_string ("not a regular file"),
4571 Fcons (orig_filename, Qnil)));
4574 if (set_coding_system)
4575 Vlast_coding_system_used = coding.symbol;
4577 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4579 insval = call1 (Qafter_insert_file_set_coding, make_number (inserted));
4580 if (! NILP (insval))
4582 CHECK_NUMBER (insval);
4583 inserted = XFASTINT (insval);
4587 /* Decode file format */
4588 if (inserted > 0)
4590 int empty_undo_list_p = 0;
4592 /* If we're anyway going to discard undo information, don't
4593 record it in the first place. The buffer's undo list at this
4594 point is either nil or t when visiting a file. */
4595 if (!NILP (visit))
4597 empty_undo_list_p = NILP (current_buffer->undo_list);
4598 current_buffer->undo_list = Qt;
4601 insval = call3 (Qformat_decode,
4602 Qnil, make_number (inserted), visit);
4603 CHECK_NUMBER (insval);
4604 inserted = XFASTINT (insval);
4606 if (!NILP (visit))
4607 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4610 /* Call after-change hooks for the inserted text, aside from the case
4611 of normal visiting (not with REPLACE), which is done in a new buffer
4612 "before" the buffer is changed. */
4613 if (inserted > 0 && total > 0
4614 && (NILP (visit) || !NILP (replace)))
4616 signal_after_change (PT, 0, inserted);
4617 update_compositions (PT, PT, CHECK_BORDER);
4620 p = Vafter_insert_file_functions;
4621 while (CONSP (p))
4623 insval = call1 (XCAR (p), make_number (inserted));
4624 if (!NILP (insval))
4626 CHECK_NUMBER (insval);
4627 inserted = XFASTINT (insval);
4629 QUIT;
4630 p = XCDR (p);
4633 if (!NILP (visit)
4634 && current_buffer->modtime == -1)
4636 /* If visiting nonexistent file, return nil. */
4637 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4640 if (read_quit)
4641 Fsignal (Qquit, Qnil);
4643 /* ??? Retval needs to be dealt with in all cases consistently. */
4644 if (NILP (val))
4645 val = Fcons (orig_filename,
4646 Fcons (make_number (inserted),
4647 Qnil));
4649 RETURN_UNGCPRO (unbind_to (count, val));
4652 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4653 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4654 Lisp_Object, Lisp_Object));
4656 /* If build_annotations switched buffers, switch back to BUF.
4657 Kill the temporary buffer that was selected in the meantime.
4659 Since this kill only the last temporary buffer, some buffers remain
4660 not killed if build_annotations switched buffers more than once.
4661 -- K.Handa */
4663 static Lisp_Object
4664 build_annotations_unwind (buf)
4665 Lisp_Object buf;
4667 Lisp_Object tembuf;
4669 if (XBUFFER (buf) == current_buffer)
4670 return Qnil;
4671 tembuf = Fcurrent_buffer ();
4672 Fset_buffer (buf);
4673 Fkill_buffer (tembuf);
4674 return Qnil;
4677 /* Decide the coding-system to encode the data with. */
4679 void
4680 choose_write_coding_system (start, end, filename,
4681 append, visit, lockname, coding)
4682 Lisp_Object start, end, filename, append, visit, lockname;
4683 struct coding_system *coding;
4685 Lisp_Object val;
4687 if (auto_saving)
4689 /* We use emacs-mule for auto saving... */
4690 setup_coding_system (Qemacs_mule, coding);
4691 /* ... but with the special flag to indicate not to strip off
4692 leading code of eight-bit-control chars. */
4693 coding->flags = 1;
4694 goto done_setup_coding;
4696 else if (!NILP (Vcoding_system_for_write))
4698 val = Vcoding_system_for_write;
4699 if (coding_system_require_warning
4700 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4701 /* Confirm that VAL can surely encode the current region. */
4702 val = call5 (Vselect_safe_coding_system_function,
4703 start, end, Fcons (Qt, Fcons (val, Qnil)),
4704 Qnil, filename);
4706 else
4708 /* If the variable `buffer-file-coding-system' is set locally,
4709 it means that the file was read with some kind of code
4710 conversion or the variable is explicitly set by users. We
4711 had better write it out with the same coding system even if
4712 `enable-multibyte-characters' is nil.
4714 If it is not set locally, we anyway have to convert EOL
4715 format if the default value of `buffer-file-coding-system'
4716 tells that it is not Unix-like (LF only) format. */
4717 int using_default_coding = 0;
4718 int force_raw_text = 0;
4720 val = current_buffer->buffer_file_coding_system;
4721 if (NILP (val)
4722 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4724 val = Qnil;
4725 if (NILP (current_buffer->enable_multibyte_characters))
4726 force_raw_text = 1;
4729 if (NILP (val))
4731 /* Check file-coding-system-alist. */
4732 Lisp_Object args[7], coding_systems;
4734 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4735 args[3] = filename; args[4] = append; args[5] = visit;
4736 args[6] = lockname;
4737 coding_systems = Ffind_operation_coding_system (7, args);
4738 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4739 val = XCDR (coding_systems);
4742 if (NILP (val)
4743 && !NILP (current_buffer->buffer_file_coding_system))
4745 /* If we still have not decided a coding system, use the
4746 default value of buffer-file-coding-system. */
4747 val = current_buffer->buffer_file_coding_system;
4748 using_default_coding = 1;
4751 if (!force_raw_text
4752 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4753 /* Confirm that VAL can surely encode the current region. */
4754 val = call5 (Vselect_safe_coding_system_function,
4755 start, end, val, Qnil, filename);
4757 setup_coding_system (Fcheck_coding_system (val), coding);
4758 if (coding->eol_type == CODING_EOL_UNDECIDED
4759 && !using_default_coding)
4761 if (! EQ (default_buffer_file_coding.symbol,
4762 buffer_defaults.buffer_file_coding_system))
4763 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4764 &default_buffer_file_coding);
4765 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4767 Lisp_Object subsidiaries;
4769 coding->eol_type = default_buffer_file_coding.eol_type;
4770 subsidiaries = Fget (coding->symbol, Qeol_type);
4771 if (VECTORP (subsidiaries)
4772 && XVECTOR (subsidiaries)->size == 3)
4773 coding->symbol
4774 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4778 if (force_raw_text)
4779 setup_raw_text_coding_system (coding);
4780 goto done_setup_coding;
4783 setup_coding_system (Fcheck_coding_system (val), coding);
4785 done_setup_coding:
4786 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4787 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4790 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4791 "r\nFWrite region to file: \ni\ni\ni\np",
4792 doc: /* Write current region into specified file.
4793 When called from a program, requires three arguments:
4794 START, END and FILENAME. START and END are normally buffer positions
4795 specifying the part of the buffer to write.
4796 If START is nil, that means to use the entire buffer contents.
4797 If START is a string, then output that string to the file
4798 instead of any buffer contents; END is ignored.
4800 Optional fourth argument APPEND if non-nil means
4801 append to existing file contents (if any). If it is an integer,
4802 seek to that offset in the file before writing.
4803 Optional fifth argument VISIT if t means
4804 set the last-save-file-modtime of buffer to this file's modtime
4805 and mark buffer not modified.
4806 If VISIT is a string, it is a second file name;
4807 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4808 VISIT is also the file name to lock and unlock for clash detection.
4809 If VISIT is neither t nor nil nor a string,
4810 that means do not display the \"Wrote file\" message.
4811 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4812 use for locking and unlocking, overriding FILENAME and VISIT.
4813 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4814 for an existing file with the same name. If MUSTBENEW is `excl',
4815 that means to get an error if the file already exists; never overwrite.
4816 If MUSTBENEW is neither nil nor `excl', that means ask for
4817 confirmation before overwriting, but do go ahead and overwrite the file
4818 if the user confirms.
4820 This does code conversion according to the value of
4821 `coding-system-for-write', `buffer-file-coding-system', or
4822 `file-coding-system-alist', and sets the variable
4823 `last-coding-system-used' to the coding system actually used. */)
4824 (start, end, filename, append, visit, lockname, mustbenew)
4825 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4827 register int desc;
4828 int failure;
4829 int save_errno = 0;
4830 const unsigned char *fn;
4831 struct stat st;
4832 int tem;
4833 int count = SPECPDL_INDEX ();
4834 int count1;
4835 #ifdef VMS
4836 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4837 #endif /* VMS */
4838 Lisp_Object handler;
4839 Lisp_Object visit_file;
4840 Lisp_Object annotations;
4841 Lisp_Object encoded_filename;
4842 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4843 int quietly = !NILP (visit);
4844 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4845 struct buffer *given_buffer;
4846 #ifdef DOS_NT
4847 int buffer_file_type = O_BINARY;
4848 #endif /* DOS_NT */
4849 struct coding_system coding;
4851 if (current_buffer->base_buffer && visiting)
4852 error ("Cannot do file visiting in an indirect buffer");
4854 if (!NILP (start) && !STRINGP (start))
4855 validate_region (&start, &end);
4857 GCPRO5 (start, filename, visit, visit_file, lockname);
4859 filename = Fexpand_file_name (filename, Qnil);
4861 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4862 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4864 if (STRINGP (visit))
4865 visit_file = Fexpand_file_name (visit, Qnil);
4866 else
4867 visit_file = filename;
4869 if (NILP (lockname))
4870 lockname = visit_file;
4872 annotations = Qnil;
4874 /* If the file name has special constructs in it,
4875 call the corresponding file handler. */
4876 handler = Ffind_file_name_handler (filename, Qwrite_region);
4877 /* If FILENAME has no handler, see if VISIT has one. */
4878 if (NILP (handler) && STRINGP (visit))
4879 handler = Ffind_file_name_handler (visit, Qwrite_region);
4881 if (!NILP (handler))
4883 Lisp_Object val;
4884 val = call6 (handler, Qwrite_region, start, end,
4885 filename, append, visit);
4887 if (visiting)
4889 SAVE_MODIFF = MODIFF;
4890 XSETFASTINT (current_buffer->save_length, Z - BEG);
4891 current_buffer->filename = visit_file;
4893 UNGCPRO;
4894 return val;
4897 record_unwind_protect (save_restriction_restore, save_restriction_save ());
4899 /* Special kludge to simplify auto-saving. */
4900 if (NILP (start))
4902 XSETFASTINT (start, BEG);
4903 XSETFASTINT (end, Z);
4904 Fwiden ();
4907 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
4908 count1 = SPECPDL_INDEX ();
4910 given_buffer = current_buffer;
4912 if (!STRINGP (start))
4914 annotations = build_annotations (start, end);
4916 if (current_buffer != given_buffer)
4918 XSETFASTINT (start, BEGV);
4919 XSETFASTINT (end, ZV);
4923 UNGCPRO;
4925 GCPRO5 (start, filename, annotations, visit_file, lockname);
4927 /* Decide the coding-system to encode the data with.
4928 We used to make this choice before calling build_annotations, but that
4929 leads to problems when a write-annotate-function takes care of
4930 unsavable chars (as was the case with X-Symbol). */
4931 choose_write_coding_system (start, end, filename,
4932 append, visit, lockname, &coding);
4933 Vlast_coding_system_used = coding.symbol;
4935 given_buffer = current_buffer;
4936 if (! STRINGP (start))
4938 annotations = build_annotations_2 (start, end,
4939 coding.pre_write_conversion, annotations);
4940 if (current_buffer != given_buffer)
4942 XSETFASTINT (start, BEGV);
4943 XSETFASTINT (end, ZV);
4947 #ifdef CLASH_DETECTION
4948 if (!auto_saving)
4950 #if 0 /* This causes trouble for GNUS. */
4951 /* If we've locked this file for some other buffer,
4952 query before proceeding. */
4953 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
4954 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
4955 #endif
4957 lock_file (lockname);
4959 #endif /* CLASH_DETECTION */
4961 encoded_filename = ENCODE_FILE (filename);
4963 fn = SDATA (encoded_filename);
4964 desc = -1;
4965 if (!NILP (append))
4966 #ifdef DOS_NT
4967 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
4968 #else /* not DOS_NT */
4969 desc = emacs_open (fn, O_WRONLY, 0);
4970 #endif /* not DOS_NT */
4972 if (desc < 0 && (NILP (append) || errno == ENOENT))
4973 #ifdef VMS
4974 if (auto_saving) /* Overwrite any previous version of autosave file */
4976 vms_truncate (fn); /* if fn exists, truncate to zero length */
4977 desc = emacs_open (fn, O_RDWR, 0);
4978 if (desc < 0)
4979 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
4980 ? SDATA (current_buffer->filename) : 0,
4981 fn);
4983 else /* Write to temporary name and rename if no errors */
4985 Lisp_Object temp_name;
4986 temp_name = Ffile_name_directory (filename);
4988 if (!NILP (temp_name))
4990 temp_name = Fmake_temp_name (concat2 (temp_name,
4991 build_string ("$$SAVE$$")));
4992 fname = SDATA (filename);
4993 fn = SDATA (temp_name);
4994 desc = creat_copy_attrs (fname, fn);
4995 if (desc < 0)
4997 /* If we can't open the temporary file, try creating a new
4998 version of the original file. VMS "creat" creates a
4999 new version rather than truncating an existing file. */
5000 fn = fname;
5001 fname = 0;
5002 desc = creat (fn, 0666);
5003 #if 0 /* This can clobber an existing file and fail to replace it,
5004 if the user runs out of space. */
5005 if (desc < 0)
5007 /* We can't make a new version;
5008 try to truncate and rewrite existing version if any. */
5009 vms_truncate (fn);
5010 desc = emacs_open (fn, O_RDWR, 0);
5012 #endif
5015 else
5016 desc = creat (fn, 0666);
5018 #else /* not VMS */
5019 #ifdef DOS_NT
5020 desc = emacs_open (fn,
5021 O_WRONLY | O_CREAT | buffer_file_type
5022 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5023 S_IREAD | S_IWRITE);
5024 #else /* not DOS_NT */
5025 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5026 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5027 auto_saving ? auto_save_mode_bits : 0666);
5028 #endif /* not DOS_NT */
5029 #endif /* not VMS */
5031 if (desc < 0)
5033 #ifdef CLASH_DETECTION
5034 save_errno = errno;
5035 if (!auto_saving) unlock_file (lockname);
5036 errno = save_errno;
5037 #endif /* CLASH_DETECTION */
5038 UNGCPRO;
5039 report_file_error ("Opening output file", Fcons (filename, Qnil));
5042 record_unwind_protect (close_file_unwind, make_number (desc));
5044 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5046 long ret;
5048 if (NUMBERP (append))
5049 ret = lseek (desc, XINT (append), 1);
5050 else
5051 ret = lseek (desc, 0, 2);
5052 if (ret < 0)
5054 #ifdef CLASH_DETECTION
5055 if (!auto_saving) unlock_file (lockname);
5056 #endif /* CLASH_DETECTION */
5057 UNGCPRO;
5058 report_file_error ("Lseek error", Fcons (filename, Qnil));
5062 UNGCPRO;
5064 #ifdef VMS
5066 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5067 * if we do writes that don't end with a carriage return. Furthermore
5068 * it cannot handle writes of more then 16K. The modified
5069 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5070 * this EXCEPT for the last record (iff it doesn't end with a carriage
5071 * return). This implies that if your buffer doesn't end with a carriage
5072 * return, you get one free... tough. However it also means that if
5073 * we make two calls to sys_write (a la the following code) you can
5074 * get one at the gap as well. The easiest way to fix this (honest)
5075 * is to move the gap to the next newline (or the end of the buffer).
5076 * Thus this change.
5078 * Yech!
5080 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5081 move_gap (find_next_newline (GPT, 1));
5082 #else
5083 /* Whether VMS or not, we must move the gap to the next of newline
5084 when we must put designation sequences at beginning of line. */
5085 if (INTEGERP (start)
5086 && coding.type == coding_type_iso2022
5087 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5088 && GPT > BEG && GPT_ADDR[-1] != '\n')
5090 int opoint = PT, opoint_byte = PT_BYTE;
5091 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5092 move_gap_both (PT, PT_BYTE);
5093 SET_PT_BOTH (opoint, opoint_byte);
5095 #endif
5097 failure = 0;
5098 immediate_quit = 1;
5100 if (STRINGP (start))
5102 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5103 &annotations, &coding);
5104 save_errno = errno;
5106 else if (XINT (start) != XINT (end))
5108 tem = CHAR_TO_BYTE (XINT (start));
5110 if (XINT (start) < GPT)
5112 failure = 0 > a_write (desc, Qnil, XINT (start),
5113 min (GPT, XINT (end)) - XINT (start),
5114 &annotations, &coding);
5115 save_errno = errno;
5118 if (XINT (end) > GPT && !failure)
5120 tem = max (XINT (start), GPT);
5121 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5122 &annotations, &coding);
5123 save_errno = errno;
5126 else
5128 /* If file was empty, still need to write the annotations */
5129 coding.mode |= CODING_MODE_LAST_BLOCK;
5130 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5131 save_errno = errno;
5134 if (CODING_REQUIRE_FLUSHING (&coding)
5135 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5136 && ! failure)
5138 /* We have to flush out a data. */
5139 coding.mode |= CODING_MODE_LAST_BLOCK;
5140 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5141 save_errno = errno;
5144 immediate_quit = 0;
5146 #ifdef HAVE_FSYNC
5147 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5148 Disk full in NFS may be reported here. */
5149 /* mib says that closing the file will try to write as fast as NFS can do
5150 it, and that means the fsync here is not crucial for autosave files. */
5151 if (!auto_saving && fsync (desc) < 0)
5153 /* If fsync fails with EINTR, don't treat that as serious. */
5154 if (errno != EINTR)
5155 failure = 1, save_errno = errno;
5157 #endif
5159 /* Spurious "file has changed on disk" warnings have been
5160 observed on Suns as well.
5161 It seems that `close' can change the modtime, under nfs.
5163 (This has supposedly been fixed in Sunos 4,
5164 but who knows about all the other machines with NFS?) */
5165 #if 0
5167 /* On VMS and APOLLO, must do the stat after the close
5168 since closing changes the modtime. */
5169 #ifndef VMS
5170 #ifndef APOLLO
5171 /* Recall that #if defined does not work on VMS. */
5172 #define FOO
5173 fstat (desc, &st);
5174 #endif
5175 #endif
5176 #endif
5178 /* NFS can report a write failure now. */
5179 if (emacs_close (desc) < 0)
5180 failure = 1, save_errno = errno;
5182 #ifdef VMS
5183 /* If we wrote to a temporary name and had no errors, rename to real name. */
5184 if (fname)
5186 if (!failure)
5187 failure = (rename (fn, fname) != 0), save_errno = errno;
5188 fn = fname;
5190 #endif /* VMS */
5192 #ifndef FOO
5193 stat (fn, &st);
5194 #endif
5195 /* Discard the unwind protect for close_file_unwind. */
5196 specpdl_ptr = specpdl + count1;
5197 /* Restore the original current buffer. */
5198 visit_file = unbind_to (count, visit_file);
5200 #ifdef CLASH_DETECTION
5201 if (!auto_saving)
5202 unlock_file (lockname);
5203 #endif /* CLASH_DETECTION */
5205 /* Do this before reporting IO error
5206 to avoid a "file has changed on disk" warning on
5207 next attempt to save. */
5208 if (visiting)
5209 current_buffer->modtime = st.st_mtime;
5211 if (failure)
5212 error ("IO error writing %s: %s", SDATA (filename),
5213 emacs_strerror (save_errno));
5215 if (visiting)
5217 SAVE_MODIFF = MODIFF;
5218 XSETFASTINT (current_buffer->save_length, Z - BEG);
5219 current_buffer->filename = visit_file;
5220 update_mode_lines++;
5222 else if (quietly)
5223 return Qnil;
5225 if (!auto_saving)
5226 message_with_string ((! INTEGERP (append)
5227 ? "Updated %s"
5228 : ! NILP (append)
5229 ? "Added to %s"
5230 : "Wrote %s"),
5231 visit_file, 1);
5233 return Qnil;
5236 Lisp_Object merge ();
5238 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5239 doc: /* Return t if (car A) is numerically less than (car B). */)
5240 (a, b)
5241 Lisp_Object a, b;
5243 return Flss (Fcar (a), Fcar (b));
5246 /* Build the complete list of annotations appropriate for writing out
5247 the text between START and END, by calling all the functions in
5248 write-region-annotate-functions and merging the lists they return.
5249 If one of these functions switches to a different buffer, we assume
5250 that buffer contains altered text. Therefore, the caller must
5251 make sure to restore the current buffer in all cases,
5252 as save-excursion would do. */
5254 static Lisp_Object
5255 build_annotations (start, end)
5256 Lisp_Object start, end;
5258 Lisp_Object annotations;
5259 Lisp_Object p, res;
5260 struct gcpro gcpro1, gcpro2;
5261 Lisp_Object original_buffer;
5262 int i, used_global = 0;
5264 XSETBUFFER (original_buffer, current_buffer);
5266 annotations = Qnil;
5267 p = Vwrite_region_annotate_functions;
5268 GCPRO2 (annotations, p);
5269 while (CONSP (p))
5271 struct buffer *given_buffer = current_buffer;
5272 if (EQ (Qt, XCAR (p)) && !used_global)
5273 { /* Use the global value of the hook. */
5274 Lisp_Object arg[2];
5275 used_global = 1;
5276 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5277 arg[1] = XCDR (p);
5278 p = Fappend (2, arg);
5279 continue;
5281 Vwrite_region_annotations_so_far = annotations;
5282 res = call2 (XCAR (p), start, end);
5283 /* If the function makes a different buffer current,
5284 assume that means this buffer contains altered text to be output.
5285 Reset START and END from the buffer bounds
5286 and discard all previous annotations because they should have
5287 been dealt with by this function. */
5288 if (current_buffer != given_buffer)
5290 XSETFASTINT (start, BEGV);
5291 XSETFASTINT (end, ZV);
5292 annotations = Qnil;
5294 Flength (res); /* Check basic validity of return value */
5295 annotations = merge (annotations, res, Qcar_less_than_car);
5296 p = XCDR (p);
5299 /* Now do the same for annotation functions implied by the file-format */
5300 if (auto_saving && (!EQ (Vauto_save_file_format, Qt)))
5301 p = Vauto_save_file_format;
5302 else
5303 p = current_buffer->file_format;
5304 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5306 struct buffer *given_buffer = current_buffer;
5308 Vwrite_region_annotations_so_far = annotations;
5310 /* Value is either a list of annotations or nil if the function
5311 has written annotations to a temporary buffer, which is now
5312 current. */
5313 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5314 original_buffer, make_number (i));
5315 if (current_buffer != given_buffer)
5317 XSETFASTINT (start, BEGV);
5318 XSETFASTINT (end, ZV);
5319 annotations = Qnil;
5322 if (CONSP (res))
5323 annotations = merge (annotations, res, Qcar_less_than_car);
5326 UNGCPRO;
5327 return annotations;
5330 static Lisp_Object
5331 build_annotations_2 (start, end, pre_write_conversion, annotations)
5332 Lisp_Object start, end, pre_write_conversion, annotations;
5334 struct gcpro gcpro1;
5335 Lisp_Object res;
5337 GCPRO1 (annotations);
5338 /* At last, do the same for the function PRE_WRITE_CONVERSION
5339 implied by the current coding-system. */
5340 if (!NILP (pre_write_conversion))
5342 struct buffer *given_buffer = current_buffer;
5343 Vwrite_region_annotations_so_far = annotations;
5344 res = call2 (pre_write_conversion, start, end);
5345 Flength (res);
5346 annotations = (current_buffer != given_buffer
5347 ? res
5348 : merge (annotations, res, Qcar_less_than_car));
5351 UNGCPRO;
5352 return annotations;
5355 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5356 If STRING is nil, POS is the character position in the current buffer.
5357 Intersperse with them the annotations from *ANNOT
5358 which fall within the range of POS to POS + NCHARS,
5359 each at its appropriate position.
5361 We modify *ANNOT by discarding elements as we use them up.
5363 The return value is negative in case of system call failure. */
5365 static int
5366 a_write (desc, string, pos, nchars, annot, coding)
5367 int desc;
5368 Lisp_Object string;
5369 register int nchars;
5370 int pos;
5371 Lisp_Object *annot;
5372 struct coding_system *coding;
5374 Lisp_Object tem;
5375 int nextpos;
5376 int lastpos = pos + nchars;
5378 while (NILP (*annot) || CONSP (*annot))
5380 tem = Fcar_safe (Fcar (*annot));
5381 nextpos = pos - 1;
5382 if (INTEGERP (tem))
5383 nextpos = XFASTINT (tem);
5385 /* If there are no more annotations in this range,
5386 output the rest of the range all at once. */
5387 if (! (nextpos >= pos && nextpos <= lastpos))
5388 return e_write (desc, string, pos, lastpos, coding);
5390 /* Output buffer text up to the next annotation's position. */
5391 if (nextpos > pos)
5393 if (0 > e_write (desc, string, pos, nextpos, coding))
5394 return -1;
5395 pos = nextpos;
5397 /* Output the annotation. */
5398 tem = Fcdr (Fcar (*annot));
5399 if (STRINGP (tem))
5401 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5402 return -1;
5404 *annot = Fcdr (*annot);
5406 return 0;
5409 #ifndef WRITE_BUF_SIZE
5410 #define WRITE_BUF_SIZE (16 * 1024)
5411 #endif
5413 /* Write text in the range START and END into descriptor DESC,
5414 encoding them with coding system CODING. If STRING is nil, START
5415 and END are character positions of the current buffer, else they
5416 are indexes to the string STRING. */
5418 static int
5419 e_write (desc, string, start, end, coding)
5420 int desc;
5421 Lisp_Object string;
5422 int start, end;
5423 struct coding_system *coding;
5425 register char *addr;
5426 register int nbytes;
5427 char buf[WRITE_BUF_SIZE];
5428 int return_val = 0;
5430 if (start >= end)
5431 coding->composing = COMPOSITION_DISABLED;
5432 if (coding->composing != COMPOSITION_DISABLED)
5433 coding_save_composition (coding, start, end, string);
5435 if (STRINGP (string))
5437 addr = SDATA (string);
5438 nbytes = SBYTES (string);
5439 coding->src_multibyte = STRING_MULTIBYTE (string);
5441 else if (start < end)
5443 /* It is assured that the gap is not in the range START and END-1. */
5444 addr = CHAR_POS_ADDR (start);
5445 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5446 coding->src_multibyte
5447 = !NILP (current_buffer->enable_multibyte_characters);
5449 else
5451 addr = "";
5452 nbytes = 0;
5453 coding->src_multibyte = 1;
5456 /* We used to have a code for handling selective display here. But,
5457 now it is handled within encode_coding. */
5458 while (1)
5460 int result;
5462 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5463 if (coding->produced > 0)
5465 coding->produced -= emacs_write (desc, buf, coding->produced);
5466 if (coding->produced)
5468 return_val = -1;
5469 break;
5472 nbytes -= coding->consumed;
5473 addr += coding->consumed;
5474 if (result == CODING_FINISH_INSUFFICIENT_SRC
5475 && nbytes > 0)
5477 /* The source text ends by an incomplete multibyte form.
5478 There's no way other than write it out as is. */
5479 nbytes -= emacs_write (desc, addr, nbytes);
5480 if (nbytes)
5482 return_val = -1;
5483 break;
5486 if (nbytes <= 0)
5487 break;
5488 start += coding->consumed_char;
5489 if (coding->cmp_data)
5490 coding_adjust_composition_offset (coding, start);
5493 if (coding->cmp_data)
5494 coding_free_composition_data (coding);
5496 return return_val;
5499 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5500 Sverify_visited_file_modtime, 1, 1, 0,
5501 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5502 This means that the file has not been changed since it was visited or saved. */)
5503 (buf)
5504 Lisp_Object buf;
5506 struct buffer *b;
5507 struct stat st;
5508 Lisp_Object handler;
5509 Lisp_Object filename;
5511 CHECK_BUFFER (buf);
5512 b = XBUFFER (buf);
5514 if (!STRINGP (b->filename)) return Qt;
5515 if (b->modtime == 0) return Qt;
5517 /* If the file name has special constructs in it,
5518 call the corresponding file handler. */
5519 handler = Ffind_file_name_handler (b->filename,
5520 Qverify_visited_file_modtime);
5521 if (!NILP (handler))
5522 return call2 (handler, Qverify_visited_file_modtime, buf);
5524 filename = ENCODE_FILE (b->filename);
5526 if (stat (SDATA (filename), &st) < 0)
5528 /* If the file doesn't exist now and didn't exist before,
5529 we say that it isn't modified, provided the error is a tame one. */
5530 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5531 st.st_mtime = -1;
5532 else
5533 st.st_mtime = 0;
5535 if (st.st_mtime == b->modtime
5536 /* If both are positive, accept them if they are off by one second. */
5537 || (st.st_mtime > 0 && b->modtime > 0
5538 && (st.st_mtime == b->modtime + 1
5539 || st.st_mtime == b->modtime - 1)))
5540 return Qt;
5541 return Qnil;
5544 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5545 Sclear_visited_file_modtime, 0, 0, 0,
5546 doc: /* Clear out records of last mod time of visited file.
5547 Next attempt to save will certainly not complain of a discrepancy. */)
5550 current_buffer->modtime = 0;
5551 return Qnil;
5554 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5555 Svisited_file_modtime, 0, 0, 0,
5556 doc: /* Return the current buffer's recorded visited file modification time.
5557 The value is a list of the form (HIGH . LOW), like the time values
5558 that `file-attributes' returns. */)
5561 return long_to_cons ((unsigned long) current_buffer->modtime);
5564 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5565 Sset_visited_file_modtime, 0, 1, 0,
5566 doc: /* Update buffer's recorded modification time from the visited file's time.
5567 Useful if the buffer was not read from the file normally
5568 or if the file itself has been changed for some known benign reason.
5569 An argument specifies the modification time value to use
5570 \(instead of that of the visited file), in the form of a list
5571 \(HIGH . LOW) or (HIGH LOW). */)
5572 (time_list)
5573 Lisp_Object time_list;
5575 if (!NILP (time_list))
5576 current_buffer->modtime = cons_to_long (time_list);
5577 else
5579 register Lisp_Object filename;
5580 struct stat st;
5581 Lisp_Object handler;
5583 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5585 /* If the file name has special constructs in it,
5586 call the corresponding file handler. */
5587 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5588 if (!NILP (handler))
5589 /* The handler can find the file name the same way we did. */
5590 return call2 (handler, Qset_visited_file_modtime, Qnil);
5592 filename = ENCODE_FILE (filename);
5594 if (stat (SDATA (filename), &st) >= 0)
5595 current_buffer->modtime = st.st_mtime;
5598 return Qnil;
5601 Lisp_Object
5602 auto_save_error (error)
5603 Lisp_Object error;
5605 Lisp_Object args[3], msg;
5606 int i, nbytes;
5607 struct gcpro gcpro1;
5609 ring_bell ();
5611 args[0] = build_string ("Auto-saving %s: %s");
5612 args[1] = current_buffer->name;
5613 args[2] = Ferror_message_string (error);
5614 msg = Fformat (3, args);
5615 GCPRO1 (msg);
5616 nbytes = SBYTES (msg);
5618 for (i = 0; i < 3; ++i)
5620 if (i == 0)
5621 message2 (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5622 else
5623 message2_nolog (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5624 Fsleep_for (make_number (1), Qnil);
5627 UNGCPRO;
5628 return Qnil;
5631 Lisp_Object
5632 auto_save_1 ()
5634 struct stat st;
5636 /* Get visited file's mode to become the auto save file's mode. */
5637 if (! NILP (current_buffer->filename)
5638 && stat (SDATA (current_buffer->filename), &st) >= 0)
5639 /* But make sure we can overwrite it later! */
5640 auto_save_mode_bits = st.st_mode | 0600;
5641 else
5642 auto_save_mode_bits = 0666;
5644 return
5645 Fwrite_region (Qnil, Qnil,
5646 current_buffer->auto_save_file_name,
5647 Qnil, Qlambda, Qnil, Qnil);
5650 static Lisp_Object
5651 do_auto_save_unwind (stream) /* used as unwind-protect function */
5652 Lisp_Object stream;
5654 auto_saving = 0;
5655 if (!NILP (stream))
5656 fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
5657 | XFASTINT (XCDR (stream))));
5658 return Qnil;
5661 static Lisp_Object
5662 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5663 Lisp_Object value;
5665 minibuffer_auto_raise = XINT (value);
5666 return Qnil;
5669 static Lisp_Object
5670 do_auto_save_make_dir (dir)
5671 Lisp_Object dir;
5673 return call2 (Qmake_directory, dir, Qt);
5676 static Lisp_Object
5677 do_auto_save_eh (ignore)
5678 Lisp_Object ignore;
5680 return Qnil;
5683 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5684 doc: /* Auto-save all buffers that need it.
5685 This is all buffers that have auto-saving enabled
5686 and are changed since last auto-saved.
5687 Auto-saving writes the buffer into a file
5688 so that your editing is not lost if the system crashes.
5689 This file is not the file you visited; that changes only when you save.
5690 Normally we run the normal hook `auto-save-hook' before saving.
5692 A non-nil NO-MESSAGE argument means do not print any message if successful.
5693 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5694 (no_message, current_only)
5695 Lisp_Object no_message, current_only;
5697 struct buffer *old = current_buffer, *b;
5698 Lisp_Object tail, buf;
5699 int auto_saved = 0;
5700 int do_handled_files;
5701 Lisp_Object oquit;
5702 FILE *stream;
5703 Lisp_Object lispstream;
5704 int count = SPECPDL_INDEX ();
5705 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5706 int old_message_p = 0;
5707 struct gcpro gcpro1, gcpro2;
5709 if (max_specpdl_size < specpdl_size + 40)
5710 max_specpdl_size = specpdl_size + 40;
5712 if (minibuf_level)
5713 no_message = Qt;
5715 if (NILP (no_message))
5717 old_message_p = push_message ();
5718 record_unwind_protect (pop_message_unwind, Qnil);
5721 /* Ordinarily don't quit within this function,
5722 but don't make it impossible to quit (in case we get hung in I/O). */
5723 oquit = Vquit_flag;
5724 Vquit_flag = Qnil;
5726 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5727 point to non-strings reached from Vbuffer_alist. */
5729 if (!NILP (Vrun_hooks))
5730 call1 (Vrun_hooks, intern ("auto-save-hook"));
5732 if (STRINGP (Vauto_save_list_file_name))
5734 Lisp_Object listfile;
5736 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5738 /* Don't try to create the directory when shutting down Emacs,
5739 because creating the directory might signal an error, and
5740 that would leave Emacs in a strange state. */
5741 if (!NILP (Vrun_hooks))
5743 Lisp_Object dir;
5744 dir = Qnil;
5745 GCPRO2 (dir, listfile);
5746 dir = Ffile_name_directory (listfile);
5747 if (NILP (Ffile_directory_p (dir)))
5748 internal_condition_case_1 (do_auto_save_make_dir,
5749 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5750 do_auto_save_eh);
5751 UNGCPRO;
5754 stream = fopen (SDATA (listfile), "w");
5755 if (stream != NULL)
5757 /* Arrange to close that file whether or not we get an error.
5758 Also reset auto_saving to 0. */
5759 lispstream = Fcons (Qnil, Qnil);
5760 XSETCARFASTINT (lispstream, (EMACS_UINT)stream >> 16);
5761 XSETCDRFASTINT (lispstream, (EMACS_UINT)stream & 0xffff);
5763 else
5764 lispstream = Qnil;
5766 else
5768 stream = NULL;
5769 lispstream = Qnil;
5772 record_unwind_protect (do_auto_save_unwind, lispstream);
5773 record_unwind_protect (do_auto_save_unwind_1,
5774 make_number (minibuffer_auto_raise));
5775 minibuffer_auto_raise = 0;
5776 auto_saving = 1;
5778 /* First, save all files which don't have handlers. If Emacs is
5779 crashing, the handlers may tweak what is causing Emacs to crash
5780 in the first place, and it would be a shame if Emacs failed to
5781 autosave perfectly ordinary files because it couldn't handle some
5782 ange-ftp'd file. */
5783 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5784 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5786 buf = XCDR (XCAR (tail));
5787 b = XBUFFER (buf);
5789 /* Record all the buffers that have auto save mode
5790 in the special file that lists them. For each of these buffers,
5791 Record visited name (if any) and auto save name. */
5792 if (STRINGP (b->auto_save_file_name)
5793 && stream != NULL && do_handled_files == 0)
5795 if (!NILP (b->filename))
5797 fwrite (SDATA (b->filename), 1,
5798 SBYTES (b->filename), stream);
5800 putc ('\n', stream);
5801 fwrite (SDATA (b->auto_save_file_name), 1,
5802 SBYTES (b->auto_save_file_name), stream);
5803 putc ('\n', stream);
5806 if (!NILP (current_only)
5807 && b != current_buffer)
5808 continue;
5810 /* Don't auto-save indirect buffers.
5811 The base buffer takes care of it. */
5812 if (b->base_buffer)
5813 continue;
5815 /* Check for auto save enabled
5816 and file changed since last auto save
5817 and file changed since last real save. */
5818 if (STRINGP (b->auto_save_file_name)
5819 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5820 && b->auto_save_modified < BUF_MODIFF (b)
5821 /* -1 means we've turned off autosaving for a while--see below. */
5822 && XINT (b->save_length) >= 0
5823 && (do_handled_files
5824 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5825 Qwrite_region))))
5827 EMACS_TIME before_time, after_time;
5829 EMACS_GET_TIME (before_time);
5831 /* If we had a failure, don't try again for 20 minutes. */
5832 if (b->auto_save_failure_time >= 0
5833 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5834 continue;
5836 if ((XFASTINT (b->save_length) * 10
5837 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5838 /* A short file is likely to change a large fraction;
5839 spare the user annoying messages. */
5840 && XFASTINT (b->save_length) > 5000
5841 /* These messages are frequent and annoying for `*mail*'. */
5842 && !EQ (b->filename, Qnil)
5843 && NILP (no_message))
5845 /* It has shrunk too much; turn off auto-saving here. */
5846 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5847 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5848 b->name, 1);
5849 minibuffer_auto_raise = 0;
5850 /* Turn off auto-saving until there's a real save,
5851 and prevent any more warnings. */
5852 XSETINT (b->save_length, -1);
5853 Fsleep_for (make_number (1), Qnil);
5854 continue;
5856 set_buffer_internal (b);
5857 if (!auto_saved && NILP (no_message))
5858 message1 ("Auto-saving...");
5859 internal_condition_case (auto_save_1, Qt, auto_save_error);
5860 auto_saved++;
5861 b->auto_save_modified = BUF_MODIFF (b);
5862 XSETFASTINT (current_buffer->save_length, Z - BEG);
5863 set_buffer_internal (old);
5865 EMACS_GET_TIME (after_time);
5867 /* If auto-save took more than 60 seconds,
5868 assume it was an NFS failure that got a timeout. */
5869 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5870 b->auto_save_failure_time = EMACS_SECS (after_time);
5874 /* Prevent another auto save till enough input events come in. */
5875 record_auto_save ();
5877 if (auto_saved && NILP (no_message))
5879 if (old_message_p)
5881 /* If we are going to restore an old message,
5882 give time to read ours. */
5883 sit_for (1, 0, 0, 0, 0);
5884 restore_message ();
5886 else
5887 /* If we displayed a message and then restored a state
5888 with no message, leave a "done" message on the screen. */
5889 message1 ("Auto-saving...done");
5892 Vquit_flag = oquit;
5894 /* This restores the message-stack status. */
5895 unbind_to (count, Qnil);
5896 return Qnil;
5899 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
5900 Sset_buffer_auto_saved, 0, 0, 0,
5901 doc: /* Mark current buffer as auto-saved with its current text.
5902 No auto-save file will be written until the buffer changes again. */)
5905 current_buffer->auto_save_modified = MODIFF;
5906 XSETFASTINT (current_buffer->save_length, Z - BEG);
5907 current_buffer->auto_save_failure_time = -1;
5908 return Qnil;
5911 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
5912 Sclear_buffer_auto_save_failure, 0, 0, 0,
5913 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
5916 current_buffer->auto_save_failure_time = -1;
5917 return Qnil;
5920 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
5921 0, 0, 0,
5922 doc: /* Return t if buffer has been auto-saved since last read in or saved. */)
5925 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
5928 /* Reading and completing file names */
5929 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
5931 /* In the string VAL, change each $ to $$ and return the result. */
5933 static Lisp_Object
5934 double_dollars (val)
5935 Lisp_Object val;
5937 register const unsigned char *old;
5938 register unsigned char *new;
5939 register int n;
5940 int osize, count;
5942 osize = SBYTES (val);
5944 /* Count the number of $ characters. */
5945 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
5946 if (*old++ == '$') count++;
5947 if (count > 0)
5949 old = SDATA (val);
5950 val = make_uninit_multibyte_string (SCHARS (val) + count,
5951 osize + count);
5952 new = SDATA (val);
5953 for (n = osize; n > 0; n--)
5954 if (*old != '$')
5955 *new++ = *old++;
5956 else
5958 *new++ = '$';
5959 *new++ = '$';
5960 old++;
5963 return val;
5966 static Lisp_Object
5967 read_file_name_cleanup (arg)
5968 Lisp_Object arg;
5970 return (current_buffer->directory = arg);
5973 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
5974 3, 3, 0,
5975 doc: /* Internal subroutine for read-file-name. Do not call this. */)
5976 (string, dir, action)
5977 Lisp_Object string, dir, action;
5978 /* action is nil for complete, t for return list of completions,
5979 lambda for verify final value */
5981 Lisp_Object name, specdir, realdir, val, orig_string;
5982 int changed;
5983 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5985 CHECK_STRING (string);
5987 realdir = dir;
5988 name = string;
5989 orig_string = Qnil;
5990 specdir = Qnil;
5991 changed = 0;
5992 /* No need to protect ACTION--we only compare it with t and nil. */
5993 GCPRO5 (string, realdir, name, specdir, orig_string);
5995 if (SCHARS (string) == 0)
5997 if (EQ (action, Qlambda))
5999 UNGCPRO;
6000 return Qnil;
6003 else
6005 orig_string = string;
6006 string = Fsubstitute_in_file_name (string);
6007 changed = NILP (Fstring_equal (string, orig_string));
6008 name = Ffile_name_nondirectory (string);
6009 val = Ffile_name_directory (string);
6010 if (! NILP (val))
6011 realdir = Fexpand_file_name (val, realdir);
6014 if (NILP (action))
6016 specdir = Ffile_name_directory (string);
6017 val = Ffile_name_completion (name, realdir);
6018 UNGCPRO;
6019 if (!STRINGP (val))
6021 if (changed)
6022 return double_dollars (string);
6023 return val;
6026 if (!NILP (specdir))
6027 val = concat2 (specdir, val);
6028 #ifndef VMS
6029 return double_dollars (val);
6030 #else /* not VMS */
6031 return val;
6032 #endif /* not VMS */
6034 UNGCPRO;
6036 if (EQ (action, Qt))
6038 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6039 Lisp_Object comp;
6040 int count;
6042 if (NILP (Vread_file_name_predicate)
6043 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6044 return all;
6046 #ifndef VMS
6047 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6049 /* Brute-force speed up for directory checking:
6050 Discard strings which don't end in a slash. */
6051 for (comp = Qnil; CONSP (all); all = XCDR (all))
6053 Lisp_Object tem = XCAR (all);
6054 int len;
6055 if (STRINGP (tem) &&
6056 (len = SCHARS (tem), len > 0) &&
6057 IS_DIRECTORY_SEP (SREF (tem, len-1)))
6058 comp = Fcons (tem, comp);
6061 else
6062 #endif
6064 /* Must do it the hard (and slow) way. */
6065 GCPRO3 (all, comp, specdir);
6066 count = SPECPDL_INDEX ();
6067 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6068 current_buffer->directory = realdir;
6069 for (comp = Qnil; CONSP (all); all = XCDR (all))
6070 if (!NILP (call1 (Vread_file_name_predicate, XCAR (all))))
6071 comp = Fcons (XCAR (all), comp);
6072 unbind_to (count, Qnil);
6073 UNGCPRO;
6075 return Fnreverse (comp);
6078 /* Only other case actually used is ACTION = lambda */
6079 #ifdef VMS
6080 /* Supposedly this helps commands such as `cd' that read directory names,
6081 but can someone explain how it helps them? -- RMS */
6082 if (SCHARS (name) == 0)
6083 return Qt;
6084 #endif /* VMS */
6085 if (!NILP (Vread_file_name_predicate))
6086 return call1 (Vread_file_name_predicate, string);
6087 return Ffile_exists_p (string);
6090 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6091 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6092 Value is not expanded---you must call `expand-file-name' yourself.
6093 Default name to DEFAULT-FILENAME if user enters a null string.
6094 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6095 except that if INITIAL is specified, that combined with DIR is used.)
6096 Fourth arg MUSTMATCH non-nil means require existing file's name.
6097 Non-nil and non-t means also require confirmation after completion.
6098 Fifth arg INITIAL specifies text to start with.
6099 If optional sixth arg PREDICATE is non-nil, possible completions and the
6100 resulting file name must satisfy (funcall PREDICATE NAME).
6101 DIR defaults to current buffer's directory default.
6103 If this command was invoked with the mouse, use a file dialog box if
6104 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6105 provides a file dialog box. */)
6106 (prompt, dir, default_filename, mustmatch, initial, predicate)
6107 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6109 Lisp_Object val, insdef, tem;
6110 struct gcpro gcpro1, gcpro2;
6111 register char *homedir;
6112 Lisp_Object decoded_homedir;
6113 int replace_in_history = 0;
6114 int add_to_history = 0;
6115 int count;
6117 if (NILP (dir))
6118 dir = current_buffer->directory;
6119 if (NILP (default_filename))
6120 default_filename = !NILP (initial)
6121 ? Fexpand_file_name (initial, dir)
6122 : current_buffer->filename;
6124 /* If dir starts with user's homedir, change that to ~. */
6125 homedir = (char *) egetenv ("HOME");
6126 #ifdef DOS_NT
6127 /* homedir can be NULL in temacs, since Vprocess_environment is not
6128 yet set up. We shouldn't crash in that case. */
6129 if (homedir != 0)
6131 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6132 CORRECT_DIR_SEPS (homedir);
6134 #endif
6135 if (homedir != 0)
6136 decoded_homedir
6137 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6138 if (homedir != 0
6139 && STRINGP (dir)
6140 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6141 SBYTES (decoded_homedir))
6142 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6144 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6145 dir = concat2 (build_string ("~"), dir);
6147 /* Likewise for default_filename. */
6148 if (homedir != 0
6149 && STRINGP (default_filename)
6150 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6151 SBYTES (decoded_homedir))
6152 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6154 default_filename
6155 = Fsubstring (default_filename,
6156 make_number (SCHARS (decoded_homedir)), Qnil);
6157 default_filename = concat2 (build_string ("~"), default_filename);
6159 if (!NILP (default_filename))
6161 CHECK_STRING (default_filename);
6162 default_filename = double_dollars (default_filename);
6165 if (insert_default_directory && STRINGP (dir))
6167 insdef = dir;
6168 if (!NILP (initial))
6170 Lisp_Object args[2], pos;
6172 args[0] = insdef;
6173 args[1] = initial;
6174 insdef = Fconcat (2, args);
6175 pos = make_number (SCHARS (double_dollars (dir)));
6176 insdef = Fcons (double_dollars (insdef), pos);
6178 else
6179 insdef = double_dollars (insdef);
6181 else if (STRINGP (initial))
6182 insdef = Fcons (double_dollars (initial), make_number (0));
6183 else
6184 insdef = Qnil;
6186 if (!NILP (Vread_file_name_function))
6188 Lisp_Object args[7];
6190 GCPRO2 (insdef, default_filename);
6191 args[0] = Vread_file_name_function;
6192 args[1] = prompt;
6193 args[2] = dir;
6194 args[3] = default_filename;
6195 args[4] = mustmatch;
6196 args[5] = initial;
6197 args[6] = predicate;
6198 RETURN_UNGCPRO (Ffuncall (7, args));
6201 count = SPECPDL_INDEX ();
6202 #ifdef VMS
6203 specbind (intern ("completion-ignore-case"), Qt);
6204 #endif
6206 specbind (intern ("minibuffer-completing-file-name"), Qt);
6207 specbind (intern ("read-file-name-predicate"),
6208 (NILP (predicate) ? Qfile_exists_p : predicate));
6210 GCPRO2 (insdef, default_filename);
6212 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
6213 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6214 && use_dialog_box
6215 && have_menus_p ())
6217 /* If DIR contains a file name, split it. */
6218 Lisp_Object file;
6219 file = Ffile_name_nondirectory (dir);
6220 if (SCHARS (file) && NILP (default_filename))
6222 default_filename = file;
6223 dir = Ffile_name_directory (dir);
6225 if (!NILP(default_filename))
6226 default_filename = Fexpand_file_name (default_filename, dir);
6227 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch);
6228 add_to_history = 1;
6230 else
6231 #endif
6232 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6233 dir, mustmatch, insdef,
6234 Qfile_name_history, default_filename, Qnil);
6236 tem = Fsymbol_value (Qfile_name_history);
6237 if (CONSP (tem) && EQ (XCAR (tem), val))
6238 replace_in_history = 1;
6240 /* If Fcompleting_read returned the inserted default string itself
6241 (rather than a new string with the same contents),
6242 it has to mean that the user typed RET with the minibuffer empty.
6243 In that case, we really want to return ""
6244 so that commands such as set-visited-file-name can distinguish. */
6245 if (EQ (val, default_filename))
6247 /* In this case, Fcompleting_read has not added an element
6248 to the history. Maybe we should. */
6249 if (! replace_in_history)
6250 add_to_history = 1;
6252 val = empty_string;
6255 unbind_to (count, Qnil);
6256 UNGCPRO;
6257 if (NILP (val))
6258 error ("No file name specified");
6260 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6262 if (!NILP (tem) && !NILP (default_filename))
6263 val = default_filename;
6264 else if (SCHARS (val) == 0 && NILP (insdef))
6266 if (!NILP (default_filename))
6267 val = default_filename;
6268 else
6269 error ("No default file name");
6271 val = Fsubstitute_in_file_name (val);
6273 if (replace_in_history)
6274 /* Replace what Fcompleting_read added to the history
6275 with what we will actually return. */
6276 XSETCAR (Fsymbol_value (Qfile_name_history), double_dollars (val));
6277 else if (add_to_history)
6279 /* Add the value to the history--but not if it matches
6280 the last value already there. */
6281 Lisp_Object val1 = double_dollars (val);
6282 tem = Fsymbol_value (Qfile_name_history);
6283 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6284 Fset (Qfile_name_history,
6285 Fcons (val1, tem));
6288 return val;
6292 void
6293 init_fileio_once ()
6295 /* Must be set before any path manipulation is performed. */
6296 XSETFASTINT (Vdirectory_sep_char, '/');
6300 void
6301 syms_of_fileio ()
6303 Qexpand_file_name = intern ("expand-file-name");
6304 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6305 Qdirectory_file_name = intern ("directory-file-name");
6306 Qfile_name_directory = intern ("file-name-directory");
6307 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6308 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6309 Qfile_name_as_directory = intern ("file-name-as-directory");
6310 Qcopy_file = intern ("copy-file");
6311 Qmake_directory_internal = intern ("make-directory-internal");
6312 Qmake_directory = intern ("make-directory");
6313 Qdelete_directory = intern ("delete-directory");
6314 Qdelete_file = intern ("delete-file");
6315 Qrename_file = intern ("rename-file");
6316 Qadd_name_to_file = intern ("add-name-to-file");
6317 Qmake_symbolic_link = intern ("make-symbolic-link");
6318 Qfile_exists_p = intern ("file-exists-p");
6319 Qfile_executable_p = intern ("file-executable-p");
6320 Qfile_readable_p = intern ("file-readable-p");
6321 Qfile_writable_p = intern ("file-writable-p");
6322 Qfile_symlink_p = intern ("file-symlink-p");
6323 Qaccess_file = intern ("access-file");
6324 Qfile_directory_p = intern ("file-directory-p");
6325 Qfile_regular_p = intern ("file-regular-p");
6326 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6327 Qfile_modes = intern ("file-modes");
6328 Qset_file_modes = intern ("set-file-modes");
6329 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6330 Qinsert_file_contents = intern ("insert-file-contents");
6331 Qwrite_region = intern ("write-region");
6332 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6333 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6334 Qauto_save_coding = intern ("auto-save-coding");
6336 staticpro (&Qexpand_file_name);
6337 staticpro (&Qsubstitute_in_file_name);
6338 staticpro (&Qdirectory_file_name);
6339 staticpro (&Qfile_name_directory);
6340 staticpro (&Qfile_name_nondirectory);
6341 staticpro (&Qunhandled_file_name_directory);
6342 staticpro (&Qfile_name_as_directory);
6343 staticpro (&Qcopy_file);
6344 staticpro (&Qmake_directory_internal);
6345 staticpro (&Qmake_directory);
6346 staticpro (&Qdelete_directory);
6347 staticpro (&Qdelete_file);
6348 staticpro (&Qrename_file);
6349 staticpro (&Qadd_name_to_file);
6350 staticpro (&Qmake_symbolic_link);
6351 staticpro (&Qfile_exists_p);
6352 staticpro (&Qfile_executable_p);
6353 staticpro (&Qfile_readable_p);
6354 staticpro (&Qfile_writable_p);
6355 staticpro (&Qaccess_file);
6356 staticpro (&Qfile_symlink_p);
6357 staticpro (&Qfile_directory_p);
6358 staticpro (&Qfile_regular_p);
6359 staticpro (&Qfile_accessible_directory_p);
6360 staticpro (&Qfile_modes);
6361 staticpro (&Qset_file_modes);
6362 staticpro (&Qfile_newer_than_file_p);
6363 staticpro (&Qinsert_file_contents);
6364 staticpro (&Qwrite_region);
6365 staticpro (&Qverify_visited_file_modtime);
6366 staticpro (&Qset_visited_file_modtime);
6367 staticpro (&Qauto_save_coding);
6369 Qfile_name_history = intern ("file-name-history");
6370 Fset (Qfile_name_history, Qnil);
6371 staticpro (&Qfile_name_history);
6373 Qfile_error = intern ("file-error");
6374 staticpro (&Qfile_error);
6375 Qfile_already_exists = intern ("file-already-exists");
6376 staticpro (&Qfile_already_exists);
6377 Qfile_date_error = intern ("file-date-error");
6378 staticpro (&Qfile_date_error);
6379 Qexcl = intern ("excl");
6380 staticpro (&Qexcl);
6382 #ifdef DOS_NT
6383 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6384 staticpro (&Qfind_buffer_file_type);
6385 #endif /* DOS_NT */
6387 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6388 doc: /* *Coding system for encoding file names.
6389 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6390 Vfile_name_coding_system = Qnil;
6392 DEFVAR_LISP ("default-file-name-coding-system",
6393 &Vdefault_file_name_coding_system,
6394 doc: /* Default coding system for encoding file names.
6395 This variable is used only when `file-name-coding-system' is nil.
6397 This variable is set/changed by the command `set-language-environment'.
6398 User should not set this variable manually,
6399 instead use `file-name-coding-system' to get a constant encoding
6400 of file names regardless of the current language environment. */);
6401 Vdefault_file_name_coding_system = Qnil;
6403 DEFVAR_LISP ("auto-save-file-format", &Vauto_save_file_format,
6404 doc: /* *Format in which to write auto-save files.
6405 Should be a list of symbols naming formats that are defined in `format-alist'.
6406 If it is t, which is the default, auto-save files are written in the
6407 same format as a regular save would use. */);
6408 Vauto_save_file_format = Qt;
6410 Qformat_decode = intern ("format-decode");
6411 staticpro (&Qformat_decode);
6412 Qformat_annotate_function = intern ("format-annotate-function");
6413 staticpro (&Qformat_annotate_function);
6414 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6415 staticpro (&Qafter_insert_file_set_coding);
6417 Qcar_less_than_car = intern ("car-less-than-car");
6418 staticpro (&Qcar_less_than_car);
6420 Fput (Qfile_error, Qerror_conditions,
6421 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
6422 Fput (Qfile_error, Qerror_message,
6423 build_string ("File error"));
6425 Fput (Qfile_already_exists, Qerror_conditions,
6426 Fcons (Qfile_already_exists,
6427 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6428 Fput (Qfile_already_exists, Qerror_message,
6429 build_string ("File already exists"));
6431 Fput (Qfile_date_error, Qerror_conditions,
6432 Fcons (Qfile_date_error,
6433 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6434 Fput (Qfile_date_error, Qerror_message,
6435 build_string ("Cannot set file date"));
6437 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6438 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6439 Vread_file_name_function = Qnil;
6441 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6442 doc: /* Current predicate used by `read-file-name-internal'. */);
6443 Vread_file_name_predicate = Qnil;
6445 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6446 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer. */);
6447 insert_default_directory = 1;
6449 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6450 doc: /* *Non-nil means write new files with record format `stmlf'.
6451 nil means use format `var'. This variable is meaningful only on VMS. */);
6452 vms_stmlf_recfm = 0;
6454 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6455 doc: /* Directory separator character for built-in functions that return file names.
6456 The value is always ?/. Don't use this variable, just use `/'. */);
6458 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6459 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6460 If a file name matches REGEXP, then all I/O on that file is done by calling
6461 HANDLER.
6463 The first argument given to HANDLER is the name of the I/O primitive
6464 to be handled; the remaining arguments are the arguments that were
6465 passed to that primitive. For example, if you do
6466 (file-exists-p FILENAME)
6467 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6468 (funcall HANDLER 'file-exists-p FILENAME)
6469 The function `find-file-name-handler' checks this list for a handler
6470 for its argument. */);
6471 Vfile_name_handler_alist = Qnil;
6473 DEFVAR_LISP ("set-auto-coding-function",
6474 &Vset_auto_coding_function,
6475 doc: /* If non-nil, a function to call to decide a coding system of file.
6476 Two arguments are passed to this function: the file name
6477 and the length of a file contents following the point.
6478 This function should return a coding system to decode the file contents.
6479 It should check the file name against `auto-coding-alist'.
6480 If no coding system is decided, it should check a coding system
6481 specified in the heading lines with the format:
6482 -*- ... coding: CODING-SYSTEM; ... -*-
6483 or local variable spec of the tailing lines with `coding:' tag. */);
6484 Vset_auto_coding_function = Qnil;
6486 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6487 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6488 Each is passed one argument, the number of characters inserted.
6489 It should return the new character count, and leave point the same.
6490 If `insert-file-contents' is intercepted by a handler from
6491 `file-name-handler-alist', that handler is responsible for calling the
6492 functions in `after-insert-file-functions' if appropriate. */);
6493 Vafter_insert_file_functions = Qnil;
6495 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6496 doc: /* A list of functions to be called at the start of `write-region'.
6497 Each is passed two arguments, START and END as for `write-region'.
6498 These are usually two numbers but not always; see the documentation
6499 for `write-region'. The function should return a list of pairs
6500 of the form (POSITION . STRING), consisting of strings to be effectively
6501 inserted at the specified positions of the file being written (1 means to
6502 insert before the first byte written). The POSITIONs must be sorted into
6503 increasing order. If there are several functions in the list, the several
6504 lists are merged destructively. Alternatively, the function can return
6505 with a different buffer current; in that case it should pay attention
6506 to the annotations returned by previous functions and listed in
6507 `write-region-annotations-so-far'.*/);
6508 Vwrite_region_annotate_functions = Qnil;
6509 staticpro (&Qwrite_region_annotate_functions);
6510 Qwrite_region_annotate_functions
6511 = intern ("write-region-annotate-functions");
6513 DEFVAR_LISP ("write-region-annotations-so-far",
6514 &Vwrite_region_annotations_so_far,
6515 doc: /* When an annotation function is called, this holds the previous annotations.
6516 These are the annotations made by other annotation functions
6517 that were already called. See also `write-region-annotate-functions'. */);
6518 Vwrite_region_annotations_so_far = Qnil;
6520 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6521 doc: /* A list of file name handlers that temporarily should not be used.
6522 This applies only to the operation `inhibit-file-name-operation'. */);
6523 Vinhibit_file_name_handlers = Qnil;
6525 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6526 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6527 Vinhibit_file_name_operation = Qnil;
6529 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6530 doc: /* File name in which we write a list of all auto save file names.
6531 This variable is initialized automatically from `auto-save-list-file-prefix'
6532 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6533 a non-nil value. */);
6534 Vauto_save_list_file_name = Qnil;
6536 defsubr (&Sfind_file_name_handler);
6537 defsubr (&Sfile_name_directory);
6538 defsubr (&Sfile_name_nondirectory);
6539 defsubr (&Sunhandled_file_name_directory);
6540 defsubr (&Sfile_name_as_directory);
6541 defsubr (&Sdirectory_file_name);
6542 defsubr (&Smake_temp_name);
6543 defsubr (&Sexpand_file_name);
6544 defsubr (&Ssubstitute_in_file_name);
6545 defsubr (&Scopy_file);
6546 defsubr (&Smake_directory_internal);
6547 defsubr (&Sdelete_directory);
6548 defsubr (&Sdelete_file);
6549 defsubr (&Srename_file);
6550 defsubr (&Sadd_name_to_file);
6551 #ifdef S_IFLNK
6552 defsubr (&Smake_symbolic_link);
6553 #endif /* S_IFLNK */
6554 #ifdef VMS
6555 defsubr (&Sdefine_logical_name);
6556 #endif /* VMS */
6557 #ifdef HPUX_NET
6558 defsubr (&Ssysnetunam);
6559 #endif /* HPUX_NET */
6560 defsubr (&Sfile_name_absolute_p);
6561 defsubr (&Sfile_exists_p);
6562 defsubr (&Sfile_executable_p);
6563 defsubr (&Sfile_readable_p);
6564 defsubr (&Sfile_writable_p);
6565 defsubr (&Saccess_file);
6566 defsubr (&Sfile_symlink_p);
6567 defsubr (&Sfile_directory_p);
6568 defsubr (&Sfile_accessible_directory_p);
6569 defsubr (&Sfile_regular_p);
6570 defsubr (&Sfile_modes);
6571 defsubr (&Sset_file_modes);
6572 defsubr (&Sset_default_file_modes);
6573 defsubr (&Sdefault_file_modes);
6574 defsubr (&Sfile_newer_than_file_p);
6575 defsubr (&Sinsert_file_contents);
6576 defsubr (&Swrite_region);
6577 defsubr (&Scar_less_than_car);
6578 defsubr (&Sverify_visited_file_modtime);
6579 defsubr (&Sclear_visited_file_modtime);
6580 defsubr (&Svisited_file_modtime);
6581 defsubr (&Sset_visited_file_modtime);
6582 defsubr (&Sdo_auto_save);
6583 defsubr (&Sset_buffer_auto_saved);
6584 defsubr (&Sclear_buffer_auto_save_failure);
6585 defsubr (&Srecent_auto_save_p);
6587 defsubr (&Sread_file_name_internal);
6588 defsubr (&Sread_file_name);
6590 #ifdef unix
6591 defsubr (&Sunix_sync);
6592 #endif