(xg_update_frame_menubar): Add missing return value.
[emacs.git] / src / fileio.c
blob02b45ed077cecea594fc45fcf77b305515b95f84
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985,86,87,88,93,94,95,96,97,98,99,2000, 2001
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 /* Coding system for file names, or nil if none. */
158 Lisp_Object Vfile_name_coding_system;
160 /* Coding system for file names used only when
161 Vfile_name_coding_system is nil. */
162 Lisp_Object Vdefault_file_name_coding_system;
164 /* Alist of elements (REGEXP . HANDLER) for file names
165 whose I/O is done with a special handler. */
166 Lisp_Object Vfile_name_handler_alist;
168 /* Format for auto-save files */
169 Lisp_Object Vauto_save_file_format;
171 /* Lisp functions for translating file formats */
172 Lisp_Object Qformat_decode, Qformat_annotate_function;
174 /* Function to be called to decide a coding system of a reading file. */
175 Lisp_Object Vset_auto_coding_function;
177 /* Functions to be called to process text properties in inserted file. */
178 Lisp_Object Vafter_insert_file_functions;
180 /* Functions to be called to create text property annotations for file. */
181 Lisp_Object Vwrite_region_annotate_functions;
183 /* During build_annotations, each time an annotation function is called,
184 this holds the annotations made by the previous functions. */
185 Lisp_Object Vwrite_region_annotations_so_far;
187 /* File name in which we write a list of all our auto save files. */
188 Lisp_Object Vauto_save_list_file_name;
190 /* Function to call to read a file name. */
191 Lisp_Object Vread_file_name_function;
193 /* Current predicate used by read_file_name_internal. */
194 Lisp_Object Vread_file_name_predicate;
196 /* Nonzero means, when reading a filename in the minibuffer,
197 start out by inserting the default directory into the minibuffer. */
198 int insert_default_directory;
200 /* On VMS, nonzero means write new files with record format stmlf.
201 Zero means use var format. */
202 int vms_stmlf_recfm;
204 /* On NT, specifies the directory separator character, used (eg.) when
205 expanding file names. This can be bound to / or \. */
206 Lisp_Object Vdirectory_sep_char;
208 extern Lisp_Object Vuser_login_name;
210 #ifdef WINDOWSNT
211 extern Lisp_Object Vw32_get_true_file_attributes;
212 #endif
214 extern int minibuf_level;
216 extern int minibuffer_auto_raise;
218 /* These variables describe handlers that have "already" had a chance
219 to handle the current operation.
221 Vinhibit_file_name_handlers is a list of file name handlers.
222 Vinhibit_file_name_operation is the operation being handled.
223 If we try to handle that operation, we ignore those handlers. */
225 static Lisp_Object Vinhibit_file_name_handlers;
226 static Lisp_Object Vinhibit_file_name_operation;
228 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
229 Lisp_Object Qexcl;
230 Lisp_Object Qfile_name_history;
232 Lisp_Object Qcar_less_than_car;
234 static int a_write P_ ((int, Lisp_Object, int, int,
235 Lisp_Object *, struct coding_system *));
236 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
239 void
240 report_file_error (string, data)
241 const char *string;
242 Lisp_Object data;
244 Lisp_Object errstring;
245 int errorno = errno;
247 synchronize_system_messages_locale ();
248 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
249 Vlocale_coding_system, 0);
251 while (1)
252 switch (errorno)
254 case EEXIST:
255 Fsignal (Qfile_already_exists, Fcons (errstring, data));
256 break;
257 default:
258 /* System error messages are capitalized. Downcase the initial
259 unless it is followed by a slash. */
260 if (SREF (errstring, 1) != '/')
261 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
263 Fsignal (Qfile_error,
264 Fcons (build_string (string), Fcons (errstring, data)));
268 Lisp_Object
269 close_file_unwind (fd)
270 Lisp_Object fd;
272 emacs_close (XFASTINT (fd));
273 return Qnil;
276 /* Restore point, having saved it as a marker. */
278 static Lisp_Object
279 restore_point_unwind (location)
280 Lisp_Object location;
282 Fgoto_char (location);
283 Fset_marker (location, Qnil, Qnil);
284 return Qnil;
287 Lisp_Object Qexpand_file_name;
288 Lisp_Object Qsubstitute_in_file_name;
289 Lisp_Object Qdirectory_file_name;
290 Lisp_Object Qfile_name_directory;
291 Lisp_Object Qfile_name_nondirectory;
292 Lisp_Object Qunhandled_file_name_directory;
293 Lisp_Object Qfile_name_as_directory;
294 Lisp_Object Qcopy_file;
295 Lisp_Object Qmake_directory_internal;
296 Lisp_Object Qmake_directory;
297 Lisp_Object Qdelete_directory;
298 Lisp_Object Qdelete_file;
299 Lisp_Object Qrename_file;
300 Lisp_Object Qadd_name_to_file;
301 Lisp_Object Qmake_symbolic_link;
302 Lisp_Object Qfile_exists_p;
303 Lisp_Object Qfile_executable_p;
304 Lisp_Object Qfile_readable_p;
305 Lisp_Object Qfile_writable_p;
306 Lisp_Object Qfile_symlink_p;
307 Lisp_Object Qaccess_file;
308 Lisp_Object Qfile_directory_p;
309 Lisp_Object Qfile_regular_p;
310 Lisp_Object Qfile_accessible_directory_p;
311 Lisp_Object Qfile_modes;
312 Lisp_Object Qset_file_modes;
313 Lisp_Object Qfile_newer_than_file_p;
314 Lisp_Object Qinsert_file_contents;
315 Lisp_Object Qwrite_region;
316 Lisp_Object Qverify_visited_file_modtime;
317 Lisp_Object Qset_visited_file_modtime;
319 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
320 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
321 Otherwise, return nil.
322 A file name is handled if one of the regular expressions in
323 `file-name-handler-alist' matches it.
325 If OPERATION equals `inhibit-file-name-operation', then we ignore
326 any handlers that are members of `inhibit-file-name-handlers',
327 but we still do run any other handlers. This lets handlers
328 use the standard functions without calling themselves recursively. */)
329 (filename, operation)
330 Lisp_Object filename, operation;
332 /* This function must not munge the match data. */
333 Lisp_Object chain, inhibited_handlers, result;
334 int pos = -1;
336 result = Qnil;
337 CHECK_STRING (filename);
339 if (EQ (operation, Vinhibit_file_name_operation))
340 inhibited_handlers = Vinhibit_file_name_handlers;
341 else
342 inhibited_handlers = Qnil;
344 for (chain = Vfile_name_handler_alist; CONSP (chain);
345 chain = XCDR (chain))
347 Lisp_Object elt;
348 elt = XCAR (chain);
349 if (CONSP (elt))
351 Lisp_Object string;
352 int match_pos;
353 string = XCAR (elt);
354 if (STRINGP (string)
355 && (match_pos = fast_string_match (string, filename)) > pos)
357 Lisp_Object handler, tem;
359 handler = XCDR (elt);
360 tem = Fmemq (handler, inhibited_handlers);
361 if (NILP (tem))
363 result = handler;
364 pos = match_pos;
369 QUIT;
371 return result;
374 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
375 1, 1, 0,
376 doc: /* Return the directory component in file name FILENAME.
377 Return nil if FILENAME does not include a directory.
378 Otherwise return a directory spec.
379 Given a Unix syntax file name, returns a string ending in slash;
380 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
381 (filename)
382 Lisp_Object filename;
384 #ifndef DOS_NT
385 register const unsigned char *beg;
386 #else
387 register unsigned char *beg;
388 #endif
389 register const unsigned char *p;
390 Lisp_Object handler;
392 CHECK_STRING (filename);
394 /* If the file name has special constructs in it,
395 call the corresponding file handler. */
396 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
397 if (!NILP (handler))
398 return call2 (handler, Qfile_name_directory, filename);
400 #ifdef FILE_SYSTEM_CASE
401 filename = FILE_SYSTEM_CASE (filename);
402 #endif
403 beg = SDATA (filename);
404 #ifdef DOS_NT
405 beg = strcpy (alloca (strlen (beg) + 1), beg);
406 #endif
407 p = beg + SBYTES (filename);
409 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
410 #ifdef VMS
411 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
412 #endif /* VMS */
413 #ifdef DOS_NT
414 /* only recognise drive specifier at the beginning */
415 && !(p[-1] == ':'
416 /* handle the "/:d:foo" and "/:foo" cases correctly */
417 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
418 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
419 #endif
420 ) p--;
422 if (p == beg)
423 return Qnil;
424 #ifdef DOS_NT
425 /* Expansion of "c:" to drive and default directory. */
426 if (p[-1] == ':')
428 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
429 unsigned char *res = alloca (MAXPATHLEN + 1);
430 unsigned char *r = res;
432 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
434 strncpy (res, beg, 2);
435 beg += 2;
436 r += 2;
439 if (getdefdir (toupper (*beg) - 'A' + 1, r))
441 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
442 strcat (res, "/");
443 beg = res;
444 p = beg + strlen (beg);
447 CORRECT_DIR_SEPS (beg);
448 #endif /* DOS_NT */
450 if (STRING_MULTIBYTE (filename))
451 return make_string (beg, p - beg);
452 return make_unibyte_string (beg, p - beg);
455 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
456 Sfile_name_nondirectory, 1, 1, 0,
457 doc: /* Return file name FILENAME sans its directory.
458 For example, in a Unix-syntax file name,
459 this is everything after the last slash,
460 or the entire name if it contains no slash. */)
461 (filename)
462 Lisp_Object filename;
464 register const unsigned char *beg, *p, *end;
465 Lisp_Object handler;
467 CHECK_STRING (filename);
469 /* If the file name has special constructs in it,
470 call the corresponding file handler. */
471 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
472 if (!NILP (handler))
473 return call2 (handler, Qfile_name_nondirectory, filename);
475 beg = SDATA (filename);
476 end = p = beg + SBYTES (filename);
478 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
479 #ifdef VMS
480 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
481 #endif /* VMS */
482 #ifdef DOS_NT
483 /* only recognise drive specifier at beginning */
484 && !(p[-1] == ':'
485 /* handle the "/:d:foo" case correctly */
486 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
487 #endif
489 p--;
491 if (STRING_MULTIBYTE (filename))
492 return make_string (p, end - p);
493 return make_unibyte_string (p, end - p);
496 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
497 Sunhandled_file_name_directory, 1, 1, 0,
498 doc: /* Return a directly usable directory name somehow associated with FILENAME.
499 A `directly usable' directory name is one that may be used without the
500 intervention of any file handler.
501 If FILENAME is a directly usable file itself, return
502 \(file-name-directory FILENAME).
503 The `call-process' and `start-process' functions use this function to
504 get a current directory to run processes in. */)
505 (filename)
506 Lisp_Object filename;
508 Lisp_Object handler;
510 /* If the file name has special constructs in it,
511 call the corresponding file handler. */
512 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
513 if (!NILP (handler))
514 return call2 (handler, Qunhandled_file_name_directory, filename);
516 return Ffile_name_directory (filename);
520 char *
521 file_name_as_directory (out, in)
522 char *out, *in;
524 int size = strlen (in) - 1;
526 strcpy (out, in);
528 if (size < 0)
530 out[0] = '.';
531 out[1] = '/';
532 out[2] = 0;
533 return out;
536 #ifdef VMS
537 /* Is it already a directory string? */
538 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
539 return out;
540 /* Is it a VMS directory file name? If so, hack VMS syntax. */
541 else if (! index (in, '/')
542 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
543 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
544 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
545 || ! strncmp (&in[size - 5], ".dir", 4))
546 && (in[size - 1] == '.' || in[size - 1] == ';')
547 && in[size] == '1')))
549 register char *p, *dot;
550 char brack;
552 /* x.dir -> [.x]
553 dir:x.dir --> dir:[x]
554 dir:[x]y.dir --> dir:[x.y] */
555 p = in + size;
556 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
557 if (p != in)
559 strncpy (out, in, p - in);
560 out[p - in] = '\0';
561 if (*p == ':')
563 brack = ']';
564 strcat (out, ":[");
566 else
568 brack = *p;
569 strcat (out, ".");
571 p++;
573 else
575 brack = ']';
576 strcpy (out, "[.");
578 dot = index (p, '.');
579 if (dot)
581 /* blindly remove any extension */
582 size = strlen (out) + (dot - p);
583 strncat (out, p, dot - p);
585 else
587 strcat (out, p);
588 size = strlen (out);
590 out[size++] = brack;
591 out[size] = '\0';
593 #else /* not VMS */
594 /* For Unix syntax, Append a slash if necessary */
595 if (!IS_DIRECTORY_SEP (out[size]))
597 /* Cannot use DIRECTORY_SEP, which could have any value */
598 out[size + 1] = '/';
599 out[size + 2] = '\0';
601 #ifdef DOS_NT
602 CORRECT_DIR_SEPS (out);
603 #endif
604 #endif /* not VMS */
605 return out;
608 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
609 Sfile_name_as_directory, 1, 1, 0,
610 doc: /* Return a string representing the file name FILE interpreted as a directory.
611 This operation exists because a directory is also a file, but its name as
612 a directory is different from its name as a file.
613 The result can be used as the value of `default-directory'
614 or passed as second argument to `expand-file-name'.
615 For a Unix-syntax file name, just appends a slash.
616 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
617 (file)
618 Lisp_Object file;
620 char *buf;
621 Lisp_Object handler;
623 CHECK_STRING (file);
624 if (NILP (file))
625 return Qnil;
627 /* If the file name has special constructs in it,
628 call the corresponding file handler. */
629 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
630 if (!NILP (handler))
631 return call2 (handler, Qfile_name_as_directory, file);
633 buf = (char *) alloca (SBYTES (file) + 10);
634 return build_string (file_name_as_directory (buf, SDATA (file)));
638 * Convert from directory name to filename.
639 * On VMS:
640 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
641 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
642 * On UNIX, it's simple: just make sure there isn't a terminating /
644 * Value is nonzero if the string output is different from the input.
648 directory_file_name (src, dst)
649 char *src, *dst;
651 long slen;
652 #ifdef VMS
653 long rlen;
654 char * ptr, * rptr;
655 char bracket;
656 struct FAB fab = cc$rms_fab;
657 struct NAM nam = cc$rms_nam;
658 char esa[NAM$C_MAXRSS];
659 #endif /* VMS */
661 slen = strlen (src);
662 #ifdef VMS
663 if (! index (src, '/')
664 && (src[slen - 1] == ']'
665 || src[slen - 1] == ':'
666 || src[slen - 1] == '>'))
668 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
669 fab.fab$l_fna = src;
670 fab.fab$b_fns = slen;
671 fab.fab$l_nam = &nam;
672 fab.fab$l_fop = FAB$M_NAM;
674 nam.nam$l_esa = esa;
675 nam.nam$b_ess = sizeof esa;
676 nam.nam$b_nop |= NAM$M_SYNCHK;
678 /* We call SYS$PARSE to handle such things as [--] for us. */
679 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
681 slen = nam.nam$b_esl;
682 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
683 slen -= 2;
684 esa[slen] = '\0';
685 src = esa;
687 if (src[slen - 1] != ']' && src[slen - 1] != '>')
689 /* what about when we have logical_name:???? */
690 if (src[slen - 1] == ':')
691 { /* Xlate logical name and see what we get */
692 ptr = strcpy (dst, src); /* upper case for getenv */
693 while (*ptr)
695 if ('a' <= *ptr && *ptr <= 'z')
696 *ptr -= 040;
697 ptr++;
699 dst[slen - 1] = 0; /* remove colon */
700 if (!(src = egetenv (dst)))
701 return 0;
702 /* should we jump to the beginning of this procedure?
703 Good points: allows us to use logical names that xlate
704 to Unix names,
705 Bad points: can be a problem if we just translated to a device
706 name...
707 For now, I'll punt and always expect VMS names, and hope for
708 the best! */
709 slen = strlen (src);
710 if (src[slen - 1] != ']' && src[slen - 1] != '>')
711 { /* no recursion here! */
712 strcpy (dst, src);
713 return 0;
716 else
717 { /* not a directory spec */
718 strcpy (dst, src);
719 return 0;
722 bracket = src[slen - 1];
724 /* If bracket is ']' or '>', bracket - 2 is the corresponding
725 opening bracket. */
726 ptr = index (src, bracket - 2);
727 if (ptr == 0)
728 { /* no opening bracket */
729 strcpy (dst, src);
730 return 0;
732 if (!(rptr = rindex (src, '.')))
733 rptr = ptr;
734 slen = rptr - src;
735 strncpy (dst, src, slen);
736 dst[slen] = '\0';
737 if (*rptr == '.')
739 dst[slen++] = bracket;
740 dst[slen] = '\0';
742 else
744 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
745 then translate the device and recurse. */
746 if (dst[slen - 1] == ':'
747 && dst[slen - 2] != ':' /* skip decnet nodes */
748 && strcmp (src + slen, "[000000]") == 0)
750 dst[slen - 1] = '\0';
751 if ((ptr = egetenv (dst))
752 && (rlen = strlen (ptr) - 1) > 0
753 && (ptr[rlen] == ']' || ptr[rlen] == '>')
754 && ptr[rlen - 1] == '.')
756 char * buf = (char *) alloca (strlen (ptr) + 1);
757 strcpy (buf, ptr);
758 buf[rlen - 1] = ']';
759 buf[rlen] = '\0';
760 return directory_file_name (buf, dst);
762 else
763 dst[slen - 1] = ':';
765 strcat (dst, "[000000]");
766 slen += 8;
768 rptr++;
769 rlen = strlen (rptr) - 1;
770 strncat (dst, rptr, rlen);
771 dst[slen + rlen] = '\0';
772 strcat (dst, ".DIR.1");
773 return 1;
775 #endif /* VMS */
776 /* Process as Unix format: just remove any final slash.
777 But leave "/" unchanged; do not change it to "". */
778 strcpy (dst, src);
779 #ifdef APOLLO
780 /* Handle // as root for apollo's. */
781 if ((slen > 2 && dst[slen - 1] == '/')
782 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
783 dst[slen - 1] = 0;
784 #else
785 if (slen > 1
786 && IS_DIRECTORY_SEP (dst[slen - 1])
787 #ifdef DOS_NT
788 && !IS_ANY_SEP (dst[slen - 2])
789 #endif
791 dst[slen - 1] = 0;
792 #endif
793 #ifdef DOS_NT
794 CORRECT_DIR_SEPS (dst);
795 #endif
796 return 1;
799 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
800 1, 1, 0,
801 doc: /* Returns the file name of the directory named DIRECTORY.
802 This is the name of the file that holds the data for the directory DIRECTORY.
803 This operation exists because a directory is also a file, but its name as
804 a directory is different from its name as a file.
805 In Unix-syntax, this function just removes the final slash.
806 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
807 it returns a file name such as \"[X]Y.DIR.1\". */)
808 (directory)
809 Lisp_Object directory;
811 char *buf;
812 Lisp_Object handler;
814 CHECK_STRING (directory);
816 if (NILP (directory))
817 return Qnil;
819 /* If the file name has special constructs in it,
820 call the corresponding file handler. */
821 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
822 if (!NILP (handler))
823 return call2 (handler, Qdirectory_file_name, directory);
825 #ifdef VMS
826 /* 20 extra chars is insufficient for VMS, since we might perform a
827 logical name translation. an equivalence string can be up to 255
828 chars long, so grab that much extra space... - sss */
829 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
830 #else
831 buf = (char *) alloca (SBYTES (directory) + 20);
832 #endif
833 directory_file_name (SDATA (directory), buf);
834 return build_string (buf);
837 static char make_temp_name_tbl[64] =
839 'A','B','C','D','E','F','G','H',
840 'I','J','K','L','M','N','O','P',
841 'Q','R','S','T','U','V','W','X',
842 'Y','Z','a','b','c','d','e','f',
843 'g','h','i','j','k','l','m','n',
844 'o','p','q','r','s','t','u','v',
845 'w','x','y','z','0','1','2','3',
846 '4','5','6','7','8','9','-','_'
849 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
851 /* Value is a temporary file name starting with PREFIX, a string.
853 The Emacs process number forms part of the result, so there is
854 no danger of generating a name being used by another process.
855 In addition, this function makes an attempt to choose a name
856 which has no existing file. To make this work, PREFIX should be
857 an absolute file name.
859 BASE64_P non-zero means add the pid as 3 characters in base64
860 encoding. In this case, 6 characters will be added to PREFIX to
861 form the file name. Otherwise, if Emacs is running on a system
862 with long file names, add the pid as a decimal number.
864 This function signals an error if no unique file name could be
865 generated. */
867 Lisp_Object
868 make_temp_name (prefix, base64_p)
869 Lisp_Object prefix;
870 int base64_p;
872 Lisp_Object val;
873 int len;
874 int pid;
875 unsigned char *p, *data;
876 char pidbuf[20];
877 int pidlen;
879 CHECK_STRING (prefix);
881 /* VAL is created by adding 6 characters to PREFIX. The first
882 three are the PID of this process, in base 64, and the second
883 three are incremented if the file already exists. This ensures
884 262144 unique file names per PID per PREFIX. */
886 pid = (int) getpid ();
888 if (base64_p)
890 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
891 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
892 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
893 pidlen = 3;
895 else
897 #ifdef HAVE_LONG_FILE_NAMES
898 sprintf (pidbuf, "%d", pid);
899 pidlen = strlen (pidbuf);
900 #else
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;
905 #endif
908 len = SCHARS (prefix);
909 val = make_uninit_string (len + 3 + pidlen);
910 data = SDATA (val);
911 bcopy(SDATA (prefix), data, len);
912 p = data + len;
914 bcopy (pidbuf, p, pidlen);
915 p += pidlen;
917 /* Here we try to minimize useless stat'ing when this function is
918 invoked many times successively with the same PREFIX. We achieve
919 this by initializing count to a random value, and incrementing it
920 afterwards.
922 We don't want make-temp-name to be called while dumping,
923 because then make_temp_name_count_initialized_p would get set
924 and then make_temp_name_count would not be set when Emacs starts. */
926 if (!make_temp_name_count_initialized_p)
928 make_temp_name_count = (unsigned) time (NULL);
929 make_temp_name_count_initialized_p = 1;
932 while (1)
934 struct stat ignored;
935 unsigned num = make_temp_name_count;
937 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
938 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
939 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
941 /* Poor man's congruential RN generator. Replace with
942 ++make_temp_name_count for debugging. */
943 make_temp_name_count += 25229;
944 make_temp_name_count %= 225307;
946 if (stat (data, &ignored) < 0)
948 /* We want to return only if errno is ENOENT. */
949 if (errno == ENOENT)
950 return val;
951 else
952 /* The error here is dubious, but there is little else we
953 can do. The alternatives are to return nil, which is
954 as bad as (and in many cases worse than) throwing the
955 error, or to ignore the error, which will likely result
956 in looping through 225307 stat's, which is not only
957 dog-slow, but also useless since it will fallback to
958 the errow below, anyway. */
959 report_file_error ("Cannot create temporary name for prefix",
960 Fcons (prefix, Qnil));
961 /* not reached */
965 error ("Cannot create temporary name for prefix `%s'",
966 SDATA (prefix));
967 return Qnil;
971 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
972 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
973 The Emacs process number forms part of the result,
974 so there is no danger of generating a name being used by another process.
976 In addition, this function makes an attempt to choose a name
977 which has no existing file. To make this work,
978 PREFIX should be an absolute file name.
980 There is a race condition between calling `make-temp-name' and creating the
981 file which opens all kinds of security holes. For that reason, you should
982 probably use `make-temp-file' instead, except in three circumstances:
984 * If you are creating the file in the user's home directory.
985 * If you are creating a directory rather than an ordinary file.
986 * If you are taking special precautions as `make-temp-file' does. */)
987 (prefix)
988 Lisp_Object prefix;
990 return make_temp_name (prefix, 0);
995 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
996 doc: /* Convert filename NAME to absolute, and canonicalize it.
997 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
998 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
999 the current buffer's value of default-directory is used.
1000 File name components that are `.' are removed, and
1001 so are file name components followed by `..', along with the `..' itself;
1002 note that these simplifications are done without checking the resulting
1003 file names in the file system.
1004 An initial `~/' expands to your home directory.
1005 An initial `~USER/' expands to USER's home directory.
1006 See also the function `substitute-in-file-name'. */)
1007 (name, default_directory)
1008 Lisp_Object name, default_directory;
1010 unsigned char *nm;
1012 register unsigned char *newdir, *p, *o;
1013 int tlen;
1014 unsigned char *target;
1015 struct passwd *pw;
1016 #ifdef VMS
1017 unsigned char * colon = 0;
1018 unsigned char * close = 0;
1019 unsigned char * slash = 0;
1020 unsigned char * brack = 0;
1021 int lbrack = 0, rbrack = 0;
1022 int dots = 0;
1023 #endif /* VMS */
1024 #ifdef DOS_NT
1025 int drive = 0;
1026 int collapse_newdir = 1;
1027 int is_escaped = 0;
1028 #endif /* DOS_NT */
1029 int length;
1030 Lisp_Object handler;
1032 CHECK_STRING (name);
1034 /* If the file name has special constructs in it,
1035 call the corresponding file handler. */
1036 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1037 if (!NILP (handler))
1038 return call3 (handler, Qexpand_file_name, name, default_directory);
1040 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1041 if (NILP (default_directory))
1042 default_directory = current_buffer->directory;
1043 if (! STRINGP (default_directory))
1045 #ifdef DOS_NT
1046 /* "/" is not considered a root directory on DOS_NT, so using "/"
1047 here causes an infinite recursion in, e.g., the following:
1049 (let (default-directory)
1050 (expand-file-name "a"))
1052 To avoid this, we set default_directory to the root of the
1053 current drive. */
1054 extern char *emacs_root_dir (void);
1056 default_directory = build_string (emacs_root_dir ());
1057 #else
1058 default_directory = build_string ("/");
1059 #endif
1062 if (!NILP (default_directory))
1064 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1065 if (!NILP (handler))
1066 return call3 (handler, Qexpand_file_name, name, default_directory);
1069 o = SDATA (default_directory);
1071 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1072 It would be better to do this down below where we actually use
1073 default_directory. Unfortunately, calling Fexpand_file_name recursively
1074 could invoke GC, and the strings might be relocated. This would
1075 be annoying because we have pointers into strings lying around
1076 that would need adjusting, and people would add new pointers to
1077 the code and forget to adjust them, resulting in intermittent bugs.
1078 Putting this call here avoids all that crud.
1080 The EQ test avoids infinite recursion. */
1081 if (! NILP (default_directory) && !EQ (default_directory, name)
1082 /* Save time in some common cases - as long as default_directory
1083 is not relative, it can be canonicalized with name below (if it
1084 is needed at all) without requiring it to be expanded now. */
1085 #ifdef DOS_NT
1086 /* Detect MSDOS file names with drive specifiers. */
1087 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1088 #ifdef WINDOWSNT
1089 /* Detect Windows file names in UNC format. */
1090 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1091 #endif
1092 #else /* not DOS_NT */
1093 /* Detect Unix absolute file names (/... alone is not absolute on
1094 DOS or Windows). */
1095 && ! (IS_DIRECTORY_SEP (o[0]))
1096 #endif /* not DOS_NT */
1099 struct gcpro gcpro1;
1101 GCPRO1 (name);
1102 default_directory = Fexpand_file_name (default_directory, Qnil);
1103 UNGCPRO;
1106 #ifdef VMS
1107 /* Filenames on VMS are always upper case. */
1108 name = Fupcase (name);
1109 #endif
1110 #ifdef FILE_SYSTEM_CASE
1111 name = FILE_SYSTEM_CASE (name);
1112 #endif
1114 nm = SDATA (name);
1116 #ifdef DOS_NT
1117 /* We will force directory separators to be either all \ or /, so make
1118 a local copy to modify, even if there ends up being no change. */
1119 nm = strcpy (alloca (strlen (nm) + 1), nm);
1121 /* Note if special escape prefix is present, but remove for now. */
1122 if (nm[0] == '/' && nm[1] == ':')
1124 is_escaped = 1;
1125 nm += 2;
1128 /* Find and remove drive specifier if present; this makes nm absolute
1129 even if the rest of the name appears to be relative. Only look for
1130 drive specifier at the beginning. */
1131 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1133 drive = nm[0];
1134 nm += 2;
1137 #ifdef WINDOWSNT
1138 /* If we see "c://somedir", we want to strip the first slash after the
1139 colon when stripping the drive letter. Otherwise, this expands to
1140 "//somedir". */
1141 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1142 nm++;
1143 #endif /* WINDOWSNT */
1144 #endif /* DOS_NT */
1146 #ifdef WINDOWSNT
1147 /* Discard any previous drive specifier if nm is now in UNC format. */
1148 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1150 drive = 0;
1152 #endif
1154 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1155 none are found, we can probably return right away. We will avoid
1156 allocating a new string if name is already fully expanded. */
1157 if (
1158 IS_DIRECTORY_SEP (nm[0])
1159 #ifdef MSDOS
1160 && drive && !is_escaped
1161 #endif
1162 #ifdef WINDOWSNT
1163 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1164 #endif
1165 #ifdef VMS
1166 || index (nm, ':')
1167 #endif /* VMS */
1170 /* If it turns out that the filename we want to return is just a
1171 suffix of FILENAME, we don't need to go through and edit
1172 things; we just need to construct a new string using data
1173 starting at the middle of FILENAME. If we set lose to a
1174 non-zero value, that means we've discovered that we can't do
1175 that cool trick. */
1176 int lose = 0;
1178 p = nm;
1179 while (*p)
1181 /* Since we know the name is absolute, we can assume that each
1182 element starts with a "/". */
1184 /* "." and ".." are hairy. */
1185 if (IS_DIRECTORY_SEP (p[0])
1186 && p[1] == '.'
1187 && (IS_DIRECTORY_SEP (p[2])
1188 || p[2] == 0
1189 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1190 || p[3] == 0))))
1191 lose = 1;
1192 /* We want to replace multiple `/' in a row with a single
1193 slash. */
1194 else if (p > nm
1195 && IS_DIRECTORY_SEP (p[0])
1196 && IS_DIRECTORY_SEP (p[1]))
1197 lose = 1;
1199 #ifdef VMS
1200 if (p[0] == '\\')
1201 lose = 1;
1202 if (p[0] == '/') {
1203 /* if dev:[dir]/, move nm to / */
1204 if (!slash && p > nm && (brack || colon)) {
1205 nm = (brack ? brack + 1 : colon + 1);
1206 lbrack = rbrack = 0;
1207 brack = 0;
1208 colon = 0;
1210 slash = p;
1212 if (p[0] == '-')
1213 #ifndef VMS4_4
1214 /* VMS pre V4.4,convert '-'s in filenames. */
1215 if (lbrack == rbrack)
1217 if (dots < 2) /* this is to allow negative version numbers */
1218 p[0] = '_';
1220 else
1221 #endif /* VMS4_4 */
1222 if (lbrack > rbrack &&
1223 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1224 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1225 lose = 1;
1226 #ifndef VMS4_4
1227 else
1228 p[0] = '_';
1229 #endif /* VMS4_4 */
1230 /* count open brackets, reset close bracket pointer */
1231 if (p[0] == '[' || p[0] == '<')
1232 lbrack++, brack = 0;
1233 /* count close brackets, set close bracket pointer */
1234 if (p[0] == ']' || p[0] == '>')
1235 rbrack++, brack = p;
1236 /* detect ][ or >< */
1237 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1238 lose = 1;
1239 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1240 nm = p + 1, lose = 1;
1241 if (p[0] == ':' && (colon || slash))
1242 /* if dev1:[dir]dev2:, move nm to dev2: */
1243 if (brack)
1245 nm = brack + 1;
1246 brack = 0;
1248 /* if /name/dev:, move nm to dev: */
1249 else if (slash)
1250 nm = slash + 1;
1251 /* if node::dev:, move colon following dev */
1252 else if (colon && colon[-1] == ':')
1253 colon = p;
1254 /* if dev1:dev2:, move nm to dev2: */
1255 else if (colon && colon[-1] != ':')
1257 nm = colon + 1;
1258 colon = 0;
1260 if (p[0] == ':' && !colon)
1262 if (p[1] == ':')
1263 p++;
1264 colon = p;
1266 if (lbrack == rbrack)
1267 if (p[0] == ';')
1268 dots = 2;
1269 else if (p[0] == '.')
1270 dots++;
1271 #endif /* VMS */
1272 p++;
1274 if (!lose)
1276 #ifdef VMS
1277 if (index (nm, '/'))
1278 return build_string (sys_translate_unix (nm));
1279 #endif /* VMS */
1280 #ifdef DOS_NT
1281 /* Make sure directories are all separated with / or \ as
1282 desired, but avoid allocation of a new string when not
1283 required. */
1284 CORRECT_DIR_SEPS (nm);
1285 #ifdef WINDOWSNT
1286 if (IS_DIRECTORY_SEP (nm[1]))
1288 if (strcmp (nm, SDATA (name)) != 0)
1289 name = build_string (nm);
1291 else
1292 #endif
1293 /* drive must be set, so this is okay */
1294 if (strcmp (nm - 2, SDATA (name)) != 0)
1296 name = make_string (nm - 2, p - nm + 2);
1297 SSET (name, 0, DRIVE_LETTER (drive));
1298 SSET (name, 1, ':');
1300 return name;
1301 #else /* not DOS_NT */
1302 if (nm == SDATA (name))
1303 return name;
1304 return build_string (nm);
1305 #endif /* not DOS_NT */
1309 /* At this point, nm might or might not be an absolute file name. We
1310 need to expand ~ or ~user if present, otherwise prefix nm with
1311 default_directory if nm is not absolute, and finally collapse /./
1312 and /foo/../ sequences.
1314 We set newdir to be the appropriate prefix if one is needed:
1315 - the relevant user directory if nm starts with ~ or ~user
1316 - the specified drive's working dir (DOS/NT only) if nm does not
1317 start with /
1318 - the value of default_directory.
1320 Note that these prefixes are not guaranteed to be absolute (except
1321 for the working dir of a drive). Therefore, to ensure we always
1322 return an absolute name, if the final prefix is not absolute we
1323 append it to the current working directory. */
1325 newdir = 0;
1327 if (nm[0] == '~') /* prefix ~ */
1329 if (IS_DIRECTORY_SEP (nm[1])
1330 #ifdef VMS
1331 || nm[1] == ':'
1332 #endif /* VMS */
1333 || nm[1] == 0) /* ~ by itself */
1335 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1336 newdir = (unsigned char *) "";
1337 nm++;
1338 #ifdef DOS_NT
1339 collapse_newdir = 0;
1340 #endif
1341 #ifdef VMS
1342 nm++; /* Don't leave the slash in nm. */
1343 #endif /* VMS */
1345 else /* ~user/filename */
1347 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1348 #ifdef VMS
1349 && *p != ':'
1350 #endif /* VMS */
1351 ); p++);
1352 o = (unsigned char *) alloca (p - nm + 1);
1353 bcopy ((char *) nm, o, p - nm);
1354 o [p - nm] = 0;
1356 pw = (struct passwd *) getpwnam (o + 1);
1357 if (pw)
1359 newdir = (unsigned char *) pw -> pw_dir;
1360 #ifdef VMS
1361 nm = p + 1; /* skip the terminator */
1362 #else
1363 nm = p;
1364 #ifdef DOS_NT
1365 collapse_newdir = 0;
1366 #endif
1367 #endif /* VMS */
1370 /* If we don't find a user of that name, leave the name
1371 unchanged; don't move nm forward to p. */
1375 #ifdef DOS_NT
1376 /* On DOS and Windows, nm is absolute if a drive name was specified;
1377 use the drive's current directory as the prefix if needed. */
1378 if (!newdir && drive)
1380 /* Get default directory if needed to make nm absolute. */
1381 if (!IS_DIRECTORY_SEP (nm[0]))
1383 newdir = alloca (MAXPATHLEN + 1);
1384 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1385 newdir = NULL;
1387 if (!newdir)
1389 /* Either nm starts with /, or drive isn't mounted. */
1390 newdir = alloca (4);
1391 newdir[0] = DRIVE_LETTER (drive);
1392 newdir[1] = ':';
1393 newdir[2] = '/';
1394 newdir[3] = 0;
1397 #endif /* DOS_NT */
1399 /* Finally, if no prefix has been specified and nm is not absolute,
1400 then it must be expanded relative to default_directory. */
1402 if (1
1403 #ifndef DOS_NT
1404 /* /... alone is not absolute on DOS and Windows. */
1405 && !IS_DIRECTORY_SEP (nm[0])
1406 #endif
1407 #ifdef WINDOWSNT
1408 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1409 #endif
1410 #ifdef VMS
1411 && !index (nm, ':')
1412 #endif
1413 && !newdir)
1415 newdir = SDATA (default_directory);
1416 #ifdef DOS_NT
1417 /* Note if special escape prefix is present, but remove for now. */
1418 if (newdir[0] == '/' && newdir[1] == ':')
1420 is_escaped = 1;
1421 newdir += 2;
1423 #endif
1426 #ifdef DOS_NT
1427 if (newdir)
1429 /* First ensure newdir is an absolute name. */
1430 if (
1431 /* Detect MSDOS file names with drive specifiers. */
1432 ! (IS_DRIVE (newdir[0])
1433 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1434 #ifdef WINDOWSNT
1435 /* Detect Windows file names in UNC format. */
1436 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1437 #endif
1440 /* Effectively, let newdir be (expand-file-name newdir cwd).
1441 Because of the admonition against calling expand-file-name
1442 when we have pointers into lisp strings, we accomplish this
1443 indirectly by prepending newdir to nm if necessary, and using
1444 cwd (or the wd of newdir's drive) as the new newdir. */
1446 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1448 drive = newdir[0];
1449 newdir += 2;
1451 if (!IS_DIRECTORY_SEP (nm[0]))
1453 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1454 file_name_as_directory (tmp, newdir);
1455 strcat (tmp, nm);
1456 nm = tmp;
1458 newdir = alloca (MAXPATHLEN + 1);
1459 if (drive)
1461 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1462 newdir = "/";
1464 else
1465 getwd (newdir);
1468 /* Strip off drive name from prefix, if present. */
1469 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1471 drive = newdir[0];
1472 newdir += 2;
1475 /* Keep only a prefix from newdir if nm starts with slash
1476 (//server/share for UNC, nothing otherwise). */
1477 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1479 #ifdef WINDOWSNT
1480 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1482 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1483 p = newdir + 2;
1484 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1485 p++;
1486 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1487 *p = 0;
1489 else
1490 #endif
1491 newdir = "";
1494 #endif /* DOS_NT */
1496 if (newdir)
1498 /* Get rid of any slash at the end of newdir, unless newdir is
1499 just / or // (an incomplete UNC name). */
1500 length = strlen (newdir);
1501 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1502 #ifdef WINDOWSNT
1503 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1504 #endif
1507 unsigned char *temp = (unsigned char *) alloca (length);
1508 bcopy (newdir, temp, length - 1);
1509 temp[length - 1] = 0;
1510 newdir = temp;
1512 tlen = length + 1;
1514 else
1515 tlen = 0;
1517 /* Now concatenate the directory and name to new space in the stack frame */
1518 tlen += strlen (nm) + 1;
1519 #ifdef DOS_NT
1520 /* Reserve space for drive specifier and escape prefix, since either
1521 or both may need to be inserted. (The Microsoft x86 compiler
1522 produces incorrect code if the following two lines are combined.) */
1523 target = (unsigned char *) alloca (tlen + 4);
1524 target += 4;
1525 #else /* not DOS_NT */
1526 target = (unsigned char *) alloca (tlen);
1527 #endif /* not DOS_NT */
1528 *target = 0;
1530 if (newdir)
1532 #ifndef VMS
1533 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1535 #ifdef DOS_NT
1536 /* If newdir is effectively "C:/", then the drive letter will have
1537 been stripped and newdir will be "/". Concatenating with an
1538 absolute directory in nm produces "//", which will then be
1539 incorrectly treated as a network share. Ignore newdir in
1540 this case (keeping the drive letter). */
1541 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1542 && newdir[1] == '\0'))
1543 #endif
1544 strcpy (target, newdir);
1546 else
1547 #endif
1548 file_name_as_directory (target, newdir);
1551 strcat (target, nm);
1552 #ifdef VMS
1553 if (index (target, '/'))
1554 strcpy (target, sys_translate_unix (target));
1555 #endif /* VMS */
1557 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1559 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1560 appear. */
1562 p = target;
1563 o = target;
1565 while (*p)
1567 #ifdef VMS
1568 if (*p != ']' && *p != '>' && *p != '-')
1570 if (*p == '\\')
1571 p++;
1572 *o++ = *p++;
1574 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1575 /* brackets are offset from each other by 2 */
1577 p += 2;
1578 if (*p != '.' && *p != '-' && o[-1] != '.')
1579 /* convert [foo][bar] to [bar] */
1580 while (o[-1] != '[' && o[-1] != '<')
1581 o--;
1582 else if (*p == '-' && *o != '.')
1583 *--p = '.';
1585 else if (p[0] == '-' && o[-1] == '.' &&
1586 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1587 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1590 o--;
1591 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1592 if (p[1] == '.') /* foo.-.bar ==> bar. */
1593 p += 2;
1594 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1595 p++, o--;
1596 /* else [foo.-] ==> [-] */
1598 else
1600 #ifndef VMS4_4
1601 if (*p == '-' &&
1602 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1603 p[1] != ']' && p[1] != '>' && p[1] != '.')
1604 *p = '_';
1605 #endif /* VMS4_4 */
1606 *o++ = *p++;
1608 #else /* not VMS */
1609 if (!IS_DIRECTORY_SEP (*p))
1611 *o++ = *p++;
1613 else if (IS_DIRECTORY_SEP (p[0])
1614 && p[1] == '.'
1615 && (IS_DIRECTORY_SEP (p[2])
1616 || p[2] == 0))
1618 /* If "/." is the entire filename, keep the "/". Otherwise,
1619 just delete the whole "/.". */
1620 if (o == target && p[2] == '\0')
1621 *o++ = *p;
1622 p += 2;
1624 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1625 /* `/../' is the "superroot" on certain file systems. */
1626 && o != target
1627 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1629 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1631 /* Keep initial / only if this is the whole name. */
1632 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1633 ++o;
1634 p += 3;
1636 else if (p > target
1637 && IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1]))
1639 /* Collapse multiple `/' in a row. */
1640 *o++ = *p++;
1641 while (IS_DIRECTORY_SEP (*p))
1642 ++p;
1644 else
1646 *o++ = *p++;
1648 #endif /* not VMS */
1651 #ifdef DOS_NT
1652 /* At last, set drive name. */
1653 #ifdef WINDOWSNT
1654 /* Except for network file name. */
1655 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1656 #endif /* WINDOWSNT */
1658 if (!drive) abort ();
1659 target -= 2;
1660 target[0] = DRIVE_LETTER (drive);
1661 target[1] = ':';
1663 /* Reinsert the escape prefix if required. */
1664 if (is_escaped)
1666 target -= 2;
1667 target[0] = '/';
1668 target[1] = ':';
1670 CORRECT_DIR_SEPS (target);
1671 #endif /* DOS_NT */
1673 return make_string (target, o - target);
1676 #if 0
1677 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1678 This is the old version of expand-file-name, before it was thoroughly
1679 rewritten for Emacs 10.31. We leave this version here commented-out,
1680 because the code is very complex and likely to have subtle bugs. If
1681 bugs _are_ found, it might be of interest to look at the old code and
1682 see what did it do in the relevant situation.
1684 Don't remove this code: it's true that it will be accessible via CVS,
1685 but a few years from deletion, people will forget it is there. */
1687 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1688 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1689 "Convert FILENAME to absolute, and canonicalize it.\n\
1690 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1691 (does not start with slash); if DEFAULT is nil or missing,\n\
1692 the current buffer's value of default-directory is used.\n\
1693 Filenames containing `.' or `..' as components are simplified;\n\
1694 initial `~/' expands to your home directory.\n\
1695 See also the function `substitute-in-file-name'.")
1696 (name, defalt)
1697 Lisp_Object name, defalt;
1699 unsigned char *nm;
1701 register unsigned char *newdir, *p, *o;
1702 int tlen;
1703 unsigned char *target;
1704 struct passwd *pw;
1705 int lose;
1706 #ifdef VMS
1707 unsigned char * colon = 0;
1708 unsigned char * close = 0;
1709 unsigned char * slash = 0;
1710 unsigned char * brack = 0;
1711 int lbrack = 0, rbrack = 0;
1712 int dots = 0;
1713 #endif /* VMS */
1715 CHECK_STRING (name);
1717 #ifdef VMS
1718 /* Filenames on VMS are always upper case. */
1719 name = Fupcase (name);
1720 #endif
1722 nm = SDATA (name);
1724 /* If nm is absolute, flush ...// and detect /./ and /../.
1725 If no /./ or /../ we can return right away. */
1726 if (
1727 nm[0] == '/'
1728 #ifdef VMS
1729 || index (nm, ':')
1730 #endif /* VMS */
1733 p = nm;
1734 lose = 0;
1735 while (*p)
1737 if (p[0] == '/' && p[1] == '/'
1738 #ifdef APOLLO
1739 /* // at start of filename is meaningful on Apollo system. */
1740 && nm != p
1741 #endif /* APOLLO */
1743 nm = p + 1;
1744 if (p[0] == '/' && p[1] == '~')
1745 nm = p + 1, lose = 1;
1746 if (p[0] == '/' && p[1] == '.'
1747 && (p[2] == '/' || p[2] == 0
1748 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1749 lose = 1;
1750 #ifdef VMS
1751 if (p[0] == '\\')
1752 lose = 1;
1753 if (p[0] == '/') {
1754 /* if dev:[dir]/, move nm to / */
1755 if (!slash && p > nm && (brack || colon)) {
1756 nm = (brack ? brack + 1 : colon + 1);
1757 lbrack = rbrack = 0;
1758 brack = 0;
1759 colon = 0;
1761 slash = p;
1763 if (p[0] == '-')
1764 #ifndef VMS4_4
1765 /* VMS pre V4.4,convert '-'s in filenames. */
1766 if (lbrack == rbrack)
1768 if (dots < 2) /* this is to allow negative version numbers */
1769 p[0] = '_';
1771 else
1772 #endif /* VMS4_4 */
1773 if (lbrack > rbrack &&
1774 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1775 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1776 lose = 1;
1777 #ifndef VMS4_4
1778 else
1779 p[0] = '_';
1780 #endif /* VMS4_4 */
1781 /* count open brackets, reset close bracket pointer */
1782 if (p[0] == '[' || p[0] == '<')
1783 lbrack++, brack = 0;
1784 /* count close brackets, set close bracket pointer */
1785 if (p[0] == ']' || p[0] == '>')
1786 rbrack++, brack = p;
1787 /* detect ][ or >< */
1788 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1789 lose = 1;
1790 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1791 nm = p + 1, lose = 1;
1792 if (p[0] == ':' && (colon || slash))
1793 /* if dev1:[dir]dev2:, move nm to dev2: */
1794 if (brack)
1796 nm = brack + 1;
1797 brack = 0;
1799 /* If /name/dev:, move nm to dev: */
1800 else if (slash)
1801 nm = slash + 1;
1802 /* If node::dev:, move colon following dev */
1803 else if (colon && colon[-1] == ':')
1804 colon = p;
1805 /* If dev1:dev2:, move nm to dev2: */
1806 else if (colon && colon[-1] != ':')
1808 nm = colon + 1;
1809 colon = 0;
1811 if (p[0] == ':' && !colon)
1813 if (p[1] == ':')
1814 p++;
1815 colon = p;
1817 if (lbrack == rbrack)
1818 if (p[0] == ';')
1819 dots = 2;
1820 else if (p[0] == '.')
1821 dots++;
1822 #endif /* VMS */
1823 p++;
1825 if (!lose)
1827 #ifdef VMS
1828 if (index (nm, '/'))
1829 return build_string (sys_translate_unix (nm));
1830 #endif /* VMS */
1831 if (nm == SDATA (name))
1832 return name;
1833 return build_string (nm);
1837 /* Now determine directory to start with and put it in NEWDIR */
1839 newdir = 0;
1841 if (nm[0] == '~') /* prefix ~ */
1842 if (nm[1] == '/'
1843 #ifdef VMS
1844 || nm[1] == ':'
1845 #endif /* VMS */
1846 || nm[1] == 0)/* ~/filename */
1848 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1849 newdir = (unsigned char *) "";
1850 nm++;
1851 #ifdef VMS
1852 nm++; /* Don't leave the slash in nm. */
1853 #endif /* VMS */
1855 else /* ~user/filename */
1857 /* Get past ~ to user */
1858 unsigned char *user = nm + 1;
1859 /* Find end of name. */
1860 unsigned char *ptr = (unsigned char *) index (user, '/');
1861 int len = ptr ? ptr - user : strlen (user);
1862 #ifdef VMS
1863 unsigned char *ptr1 = index (user, ':');
1864 if (ptr1 != 0 && ptr1 - user < len)
1865 len = ptr1 - user;
1866 #endif /* VMS */
1867 /* Copy the user name into temp storage. */
1868 o = (unsigned char *) alloca (len + 1);
1869 bcopy ((char *) user, o, len);
1870 o[len] = 0;
1872 /* Look up the user name. */
1873 pw = (struct passwd *) getpwnam (o + 1);
1874 if (!pw)
1875 error ("\"%s\" isn't a registered user", o + 1);
1877 newdir = (unsigned char *) pw->pw_dir;
1879 /* Discard the user name from NM. */
1880 nm += len;
1883 if (nm[0] != '/'
1884 #ifdef VMS
1885 && !index (nm, ':')
1886 #endif /* not VMS */
1887 && !newdir)
1889 if (NILP (defalt))
1890 defalt = current_buffer->directory;
1891 CHECK_STRING (defalt);
1892 newdir = SDATA (defalt);
1895 /* Now concatenate the directory and name to new space in the stack frame */
1897 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1898 target = (unsigned char *) alloca (tlen);
1899 *target = 0;
1901 if (newdir)
1903 #ifndef VMS
1904 if (nm[0] == 0 || nm[0] == '/')
1905 strcpy (target, newdir);
1906 else
1907 #endif
1908 file_name_as_directory (target, newdir);
1911 strcat (target, nm);
1912 #ifdef VMS
1913 if (index (target, '/'))
1914 strcpy (target, sys_translate_unix (target));
1915 #endif /* VMS */
1917 /* Now canonicalize by removing /. and /foo/.. if they appear */
1919 p = target;
1920 o = target;
1922 while (*p)
1924 #ifdef VMS
1925 if (*p != ']' && *p != '>' && *p != '-')
1927 if (*p == '\\')
1928 p++;
1929 *o++ = *p++;
1931 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1932 /* brackets are offset from each other by 2 */
1934 p += 2;
1935 if (*p != '.' && *p != '-' && o[-1] != '.')
1936 /* convert [foo][bar] to [bar] */
1937 while (o[-1] != '[' && o[-1] != '<')
1938 o--;
1939 else if (*p == '-' && *o != '.')
1940 *--p = '.';
1942 else if (p[0] == '-' && o[-1] == '.' &&
1943 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1944 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1947 o--;
1948 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1949 if (p[1] == '.') /* foo.-.bar ==> bar. */
1950 p += 2;
1951 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1952 p++, o--;
1953 /* else [foo.-] ==> [-] */
1955 else
1957 #ifndef VMS4_4
1958 if (*p == '-' &&
1959 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1960 p[1] != ']' && p[1] != '>' && p[1] != '.')
1961 *p = '_';
1962 #endif /* VMS4_4 */
1963 *o++ = *p++;
1965 #else /* not VMS */
1966 if (*p != '/')
1968 *o++ = *p++;
1970 else if (!strncmp (p, "//", 2)
1971 #ifdef APOLLO
1972 /* // at start of filename is meaningful in Apollo system. */
1973 && o != target
1974 #endif /* APOLLO */
1977 o = target;
1978 p++;
1980 else if (p[0] == '/' && p[1] == '.' &&
1981 (p[2] == '/' || p[2] == 0))
1982 p += 2;
1983 else if (!strncmp (p, "/..", 3)
1984 /* `/../' is the "superroot" on certain file systems. */
1985 && o != target
1986 && (p[3] == '/' || p[3] == 0))
1988 while (o != target && *--o != '/')
1990 #ifdef APOLLO
1991 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
1992 ++o;
1993 else
1994 #endif /* APOLLO */
1995 if (o == target && *o == '/')
1996 ++o;
1997 p += 3;
1999 else
2001 *o++ = *p++;
2003 #endif /* not VMS */
2006 return make_string (target, o - target);
2008 #endif
2010 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2011 Ssubstitute_in_file_name, 1, 1, 0,
2012 doc: /* Substitute environment variables referred to in FILENAME.
2013 `$FOO' where FOO is an environment variable name means to substitute
2014 the value of that variable. The variable name should be terminated
2015 with a character not a letter, digit or underscore; otherwise, enclose
2016 the entire variable name in braces.
2017 If `/~' appears, all of FILENAME through that `/' is discarded.
2019 On VMS, `$' substitution is not done; this function does little and only
2020 duplicates what `expand-file-name' does. */)
2021 (filename)
2022 Lisp_Object filename;
2024 unsigned char *nm;
2026 register unsigned char *s, *p, *o, *x, *endp;
2027 unsigned char *target = NULL;
2028 int total = 0;
2029 int substituted = 0;
2030 unsigned char *xnm;
2031 struct passwd *pw;
2032 Lisp_Object handler;
2034 CHECK_STRING (filename);
2036 /* If the file name has special constructs in it,
2037 call the corresponding file handler. */
2038 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2039 if (!NILP (handler))
2040 return call2 (handler, Qsubstitute_in_file_name, filename);
2042 nm = SDATA (filename);
2043 #ifdef DOS_NT
2044 nm = strcpy (alloca (strlen (nm) + 1), nm);
2045 CORRECT_DIR_SEPS (nm);
2046 substituted = (strcmp (nm, SDATA (filename)) != 0);
2047 #endif
2048 endp = nm + SBYTES (filename);
2050 /* If /~ or // appears, discard everything through first slash. */
2052 for (p = nm; p != endp; p++)
2054 if ((p[0] == '~'
2055 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2056 /* // at start of file name is meaningful in Apollo,
2057 WindowsNT and Cygwin systems. */
2058 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != nm)
2059 #else /* not (APOLLO || WINDOWSNT || CYGWIN) */
2060 || IS_DIRECTORY_SEP (p[0])
2061 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2063 && p != nm
2064 && (0
2065 #ifdef VMS
2066 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2067 #endif /* VMS */
2068 || IS_DIRECTORY_SEP (p[-1])))
2070 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2071 #ifdef VMS
2072 && *s != ':'
2073 #endif /* VMS */
2074 ); s++);
2075 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2077 o = (unsigned char *) alloca (s - p + 1);
2078 bcopy ((char *) p, o, s - p);
2079 o [s - p] = 0;
2081 pw = (struct passwd *) getpwnam (o + 1);
2083 /* If we have ~/ or ~user and `user' exists, discard
2084 everything up to ~. But if `user' does not exist, leave
2085 ~user alone, it might be a literal file name. */
2086 if (IS_DIRECTORY_SEP (p[0]) || s == p + 1 || pw)
2088 nm = p;
2089 substituted = 1;
2092 #ifdef DOS_NT
2093 /* see comment in expand-file-name about drive specifiers */
2094 else if (IS_DRIVE (p[0]) && p[1] == ':'
2095 && p > nm && IS_DIRECTORY_SEP (p[-1]))
2097 nm = p;
2098 substituted = 1;
2100 #endif /* DOS_NT */
2103 #ifdef VMS
2104 return build_string (nm);
2105 #else
2107 /* See if any variables are substituted into the string
2108 and find the total length of their values in `total' */
2110 for (p = nm; p != endp;)
2111 if (*p != '$')
2112 p++;
2113 else
2115 p++;
2116 if (p == endp)
2117 goto badsubst;
2118 else if (*p == '$')
2120 /* "$$" means a single "$" */
2121 p++;
2122 total -= 1;
2123 substituted = 1;
2124 continue;
2126 else if (*p == '{')
2128 o = ++p;
2129 while (p != endp && *p != '}') p++;
2130 if (*p != '}') goto missingclose;
2131 s = p;
2133 else
2135 o = p;
2136 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2137 s = p;
2140 /* Copy out the variable name */
2141 target = (unsigned char *) alloca (s - o + 1);
2142 strncpy (target, o, s - o);
2143 target[s - o] = 0;
2144 #ifdef DOS_NT
2145 strupr (target); /* $home == $HOME etc. */
2146 #endif /* DOS_NT */
2148 /* Get variable value */
2149 o = (unsigned char *) egetenv (target);
2150 if (o)
2152 total += strlen (o);
2153 substituted = 1;
2155 else if (*p == '}')
2156 goto badvar;
2159 if (!substituted)
2160 return filename;
2162 /* If substitution required, recopy the string and do it */
2163 /* Make space in stack frame for the new copy */
2164 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2165 x = xnm;
2167 /* Copy the rest of the name through, replacing $ constructs with values */
2168 for (p = nm; *p;)
2169 if (*p != '$')
2170 *x++ = *p++;
2171 else
2173 p++;
2174 if (p == endp)
2175 goto badsubst;
2176 else if (*p == '$')
2178 *x++ = *p++;
2179 continue;
2181 else if (*p == '{')
2183 o = ++p;
2184 while (p != endp && *p != '}') p++;
2185 if (*p != '}') goto missingclose;
2186 s = p++;
2188 else
2190 o = p;
2191 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2192 s = p;
2195 /* Copy out the variable name */
2196 target = (unsigned char *) alloca (s - o + 1);
2197 strncpy (target, o, s - o);
2198 target[s - o] = 0;
2199 #ifdef DOS_NT
2200 strupr (target); /* $home == $HOME etc. */
2201 #endif /* DOS_NT */
2203 /* Get variable value */
2204 o = (unsigned char *) egetenv (target);
2205 if (!o)
2207 *x++ = '$';
2208 strcpy (x, target); x+= strlen (target);
2210 else if (STRING_MULTIBYTE (filename))
2212 /* If the original string is multibyte,
2213 convert what we substitute into multibyte. */
2214 while (*o)
2216 int c = unibyte_char_to_multibyte (*o++);
2217 x += CHAR_STRING (c, x);
2220 else
2222 strcpy (x, o);
2223 x += strlen (o);
2227 *x = 0;
2229 /* If /~ or // appears, discard everything through first slash. */
2231 for (p = xnm; p != x; p++)
2232 if ((p[0] == '~'
2233 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2234 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != xnm)
2235 #else /* not (APOLLO || WINDOWSNT || CYGWIN) */
2236 || IS_DIRECTORY_SEP (p[0])
2237 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2239 && p != xnm && IS_DIRECTORY_SEP (p[-1]))
2240 xnm = p;
2241 #ifdef DOS_NT
2242 else if (IS_DRIVE (p[0]) && p[1] == ':'
2243 && p > xnm && IS_DIRECTORY_SEP (p[-1]))
2244 xnm = p;
2245 #endif
2247 if (STRING_MULTIBYTE (filename))
2248 return make_string (xnm, x - xnm);
2249 return make_unibyte_string (xnm, x - xnm);
2251 badsubst:
2252 error ("Bad format environment-variable substitution");
2253 missingclose:
2254 error ("Missing \"}\" in environment-variable substitution");
2255 badvar:
2256 error ("Substituting nonexistent environment variable \"%s\"", target);
2258 /* NOTREACHED */
2259 #endif /* not VMS */
2260 return Qnil;
2263 /* A slightly faster and more convenient way to get
2264 (directory-file-name (expand-file-name FOO)). */
2266 Lisp_Object
2267 expand_and_dir_to_file (filename, defdir)
2268 Lisp_Object filename, defdir;
2270 register Lisp_Object absname;
2272 absname = Fexpand_file_name (filename, defdir);
2273 #ifdef VMS
2275 register int c = SREF (absname, SBYTES (absname) - 1);
2276 if (c == ':' || c == ']' || c == '>')
2277 absname = Fdirectory_file_name (absname);
2279 #else
2280 /* Remove final slash, if any (unless this is the root dir).
2281 stat behaves differently depending! */
2282 if (SCHARS (absname) > 1
2283 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2284 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2285 /* We cannot take shortcuts; they might be wrong for magic file names. */
2286 absname = Fdirectory_file_name (absname);
2287 #endif
2288 return absname;
2291 /* Signal an error if the file ABSNAME already exists.
2292 If INTERACTIVE is nonzero, ask the user whether to proceed,
2293 and bypass the error if the user says to go ahead.
2294 QUERYSTRING is a name for the action that is being considered
2295 to alter the file.
2297 *STATPTR is used to store the stat information if the file exists.
2298 If the file does not exist, STATPTR->st_mode is set to 0.
2299 If STATPTR is null, we don't store into it.
2301 If QUICK is nonzero, we ask for y or n, not yes or no. */
2303 void
2304 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2305 Lisp_Object absname;
2306 unsigned char *querystring;
2307 int interactive;
2308 struct stat *statptr;
2309 int quick;
2311 register Lisp_Object tem, encoded_filename;
2312 struct stat statbuf;
2313 struct gcpro gcpro1;
2315 encoded_filename = ENCODE_FILE (absname);
2317 /* stat is a good way to tell whether the file exists,
2318 regardless of what access permissions it has. */
2319 if (stat (SDATA (encoded_filename), &statbuf) >= 0)
2321 if (! interactive)
2322 Fsignal (Qfile_already_exists,
2323 Fcons (build_string ("File already exists"),
2324 Fcons (absname, Qnil)));
2325 GCPRO1 (absname);
2326 tem = format2 ("File %s already exists; %s anyway? ",
2327 absname, build_string (querystring));
2328 if (quick)
2329 tem = Fy_or_n_p (tem);
2330 else
2331 tem = do_yes_or_no_p (tem);
2332 UNGCPRO;
2333 if (NILP (tem))
2334 Fsignal (Qfile_already_exists,
2335 Fcons (build_string ("File already exists"),
2336 Fcons (absname, Qnil)));
2337 if (statptr)
2338 *statptr = statbuf;
2340 else
2342 if (statptr)
2343 statptr->st_mode = 0;
2345 return;
2348 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 4,
2349 "fCopy file: \nFCopy %s to file: \np\nP",
2350 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2351 If NEWNAME names a directory, copy FILE there.
2352 Signals a `file-already-exists' error if file NEWNAME already exists,
2353 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2354 A number as third arg means request confirmation if NEWNAME already exists.
2355 This is what happens in interactive use with M-x.
2356 Fourth arg KEEP-TIME non-nil means give the new file the same
2357 last-modified time as the old one. (This works on only some systems.)
2358 A prefix arg makes KEEP-TIME non-nil. */)
2359 (file, newname, ok_if_already_exists, keep_time)
2360 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2362 int ifd, ofd, n;
2363 char buf[16 * 1024];
2364 struct stat st, out_st;
2365 Lisp_Object handler;
2366 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2367 int count = SPECPDL_INDEX ();
2368 int input_file_statable_p;
2369 Lisp_Object encoded_file, encoded_newname;
2371 encoded_file = encoded_newname = Qnil;
2372 GCPRO4 (file, newname, encoded_file, encoded_newname);
2373 CHECK_STRING (file);
2374 CHECK_STRING (newname);
2376 if (!NILP (Ffile_directory_p (newname)))
2377 newname = Fexpand_file_name (file, newname);
2378 else
2379 newname = Fexpand_file_name (newname, Qnil);
2381 file = Fexpand_file_name (file, Qnil);
2383 /* If the input file name has special constructs in it,
2384 call the corresponding file handler. */
2385 handler = Ffind_file_name_handler (file, Qcopy_file);
2386 /* Likewise for output file name. */
2387 if (NILP (handler))
2388 handler = Ffind_file_name_handler (newname, Qcopy_file);
2389 if (!NILP (handler))
2390 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2391 ok_if_already_exists, keep_time));
2393 encoded_file = ENCODE_FILE (file);
2394 encoded_newname = ENCODE_FILE (newname);
2396 if (NILP (ok_if_already_exists)
2397 || INTEGERP (ok_if_already_exists))
2398 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2399 INTEGERP (ok_if_already_exists), &out_st, 0);
2400 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2401 out_st.st_mode = 0;
2403 #ifdef WINDOWSNT
2404 if (!CopyFile (SDATA (encoded_file),
2405 SDATA (encoded_newname),
2406 FALSE))
2407 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2408 /* CopyFile retains the timestamp by default. */
2409 else if (NILP (keep_time))
2411 EMACS_TIME now;
2412 DWORD attributes;
2413 char * filename;
2415 EMACS_GET_TIME (now);
2416 filename = SDATA (encoded_newname);
2418 /* Ensure file is writable while its modified time is set. */
2419 attributes = GetFileAttributes (filename);
2420 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2421 if (set_file_times (filename, now, now))
2423 /* Restore original attributes. */
2424 SetFileAttributes (filename, attributes);
2425 Fsignal (Qfile_date_error,
2426 Fcons (build_string ("Cannot set file date"),
2427 Fcons (newname, Qnil)));
2429 /* Restore original attributes. */
2430 SetFileAttributes (filename, attributes);
2432 #else /* not WINDOWSNT */
2433 immediate_quit = 1;
2434 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2435 immediate_quit = 0;
2437 if (ifd < 0)
2438 report_file_error ("Opening input file", Fcons (file, Qnil));
2440 record_unwind_protect (close_file_unwind, make_number (ifd));
2442 /* We can only copy regular files and symbolic links. Other files are not
2443 copyable by us. */
2444 input_file_statable_p = (fstat (ifd, &st) >= 0);
2446 #if !defined (DOS_NT) || __DJGPP__ > 1
2447 if (out_st.st_mode != 0
2448 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2450 errno = 0;
2451 report_file_error ("Input and output files are the same",
2452 Fcons (file, Fcons (newname, Qnil)));
2454 #endif
2456 #if defined (S_ISREG) && defined (S_ISLNK)
2457 if (input_file_statable_p)
2459 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2461 #if defined (EISDIR)
2462 /* Get a better looking error message. */
2463 errno = EISDIR;
2464 #endif /* EISDIR */
2465 report_file_error ("Non-regular file", Fcons (file, Qnil));
2468 #endif /* S_ISREG && S_ISLNK */
2470 #ifdef VMS
2471 /* Create the copy file with the same record format as the input file */
2472 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2473 #else
2474 #ifdef MSDOS
2475 /* System's default file type was set to binary by _fmode in emacs.c. */
2476 ofd = creat (SDATA (encoded_newname), S_IREAD | S_IWRITE);
2477 #else /* not MSDOS */
2478 ofd = creat (SDATA (encoded_newname), 0666);
2479 #endif /* not MSDOS */
2480 #endif /* VMS */
2481 if (ofd < 0)
2482 report_file_error ("Opening output file", Fcons (newname, Qnil));
2484 record_unwind_protect (close_file_unwind, make_number (ofd));
2486 immediate_quit = 1;
2487 QUIT;
2488 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2489 if (emacs_write (ofd, buf, n) != n)
2490 report_file_error ("I/O error", Fcons (newname, Qnil));
2491 immediate_quit = 0;
2493 /* Closing the output clobbers the file times on some systems. */
2494 if (emacs_close (ofd) < 0)
2495 report_file_error ("I/O error", Fcons (newname, Qnil));
2497 if (input_file_statable_p)
2499 if (!NILP (keep_time))
2501 EMACS_TIME atime, mtime;
2502 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2503 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2504 if (set_file_times (SDATA (encoded_newname),
2505 atime, mtime))
2506 Fsignal (Qfile_date_error,
2507 Fcons (build_string ("Cannot set file date"),
2508 Fcons (newname, Qnil)));
2510 #ifndef MSDOS
2511 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2512 #else /* MSDOS */
2513 #if defined (__DJGPP__) && __DJGPP__ > 1
2514 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2515 and if it can't, it tells so. Otherwise, under MSDOS we usually
2516 get only the READ bit, which will make the copied file read-only,
2517 so it's better not to chmod at all. */
2518 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2519 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2520 #endif /* DJGPP version 2 or newer */
2521 #endif /* MSDOS */
2524 emacs_close (ifd);
2525 #endif /* WINDOWSNT */
2527 /* Discard the unwind protects. */
2528 specpdl_ptr = specpdl + count;
2530 UNGCPRO;
2531 return Qnil;
2534 DEFUN ("make-directory-internal", Fmake_directory_internal,
2535 Smake_directory_internal, 1, 1, 0,
2536 doc: /* Create a new directory named DIRECTORY. */)
2537 (directory)
2538 Lisp_Object directory;
2540 const unsigned char *dir;
2541 Lisp_Object handler;
2542 Lisp_Object encoded_dir;
2544 CHECK_STRING (directory);
2545 directory = Fexpand_file_name (directory, Qnil);
2547 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2548 if (!NILP (handler))
2549 return call2 (handler, Qmake_directory_internal, directory);
2551 encoded_dir = ENCODE_FILE (directory);
2553 dir = SDATA (encoded_dir);
2555 #ifdef WINDOWSNT
2556 if (mkdir (dir) != 0)
2557 #else
2558 if (mkdir (dir, 0777) != 0)
2559 #endif
2560 report_file_error ("Creating directory", Flist (1, &directory));
2562 return Qnil;
2565 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2566 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2567 (directory)
2568 Lisp_Object directory;
2570 const unsigned char *dir;
2571 Lisp_Object handler;
2572 Lisp_Object encoded_dir;
2574 CHECK_STRING (directory);
2575 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2577 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2578 if (!NILP (handler))
2579 return call2 (handler, Qdelete_directory, directory);
2581 encoded_dir = ENCODE_FILE (directory);
2583 dir = SDATA (encoded_dir);
2585 if (rmdir (dir) != 0)
2586 report_file_error ("Removing directory", Flist (1, &directory));
2588 return Qnil;
2591 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2592 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2593 If file has multiple names, it continues to exist with the other names. */)
2594 (filename)
2595 Lisp_Object filename;
2597 Lisp_Object handler;
2598 Lisp_Object encoded_file;
2599 struct gcpro gcpro1;
2601 GCPRO1 (filename);
2602 if (!NILP (Ffile_directory_p (filename)))
2603 Fsignal (Qfile_error,
2604 Fcons (build_string ("Removing old name: is a directory"),
2605 Fcons (filename, Qnil)));
2606 UNGCPRO;
2607 filename = Fexpand_file_name (filename, Qnil);
2609 handler = Ffind_file_name_handler (filename, Qdelete_file);
2610 if (!NILP (handler))
2611 return call2 (handler, Qdelete_file, filename);
2613 encoded_file = ENCODE_FILE (filename);
2615 if (0 > unlink (SDATA (encoded_file)))
2616 report_file_error ("Removing old name", Flist (1, &filename));
2617 return Qnil;
2620 static Lisp_Object
2621 internal_delete_file_1 (ignore)
2622 Lisp_Object ignore;
2624 return Qt;
2627 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2630 internal_delete_file (filename)
2631 Lisp_Object filename;
2633 return NILP (internal_condition_case_1 (Fdelete_file, filename,
2634 Qt, internal_delete_file_1));
2637 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2638 "fRename file: \nFRename %s to file: \np",
2639 doc: /* Rename FILE as NEWNAME. Both args strings.
2640 If file has names other than FILE, it continues to have those names.
2641 Signals a `file-already-exists' error if a file NEWNAME already exists
2642 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2643 A number as third arg means request confirmation if NEWNAME already exists.
2644 This is what happens in interactive use with M-x. */)
2645 (file, newname, ok_if_already_exists)
2646 Lisp_Object file, newname, ok_if_already_exists;
2648 #ifdef NO_ARG_ARRAY
2649 Lisp_Object args[2];
2650 #endif
2651 Lisp_Object handler;
2652 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2653 Lisp_Object encoded_file, encoded_newname;
2655 encoded_file = encoded_newname = Qnil;
2656 GCPRO4 (file, newname, encoded_file, encoded_newname);
2657 CHECK_STRING (file);
2658 CHECK_STRING (newname);
2659 file = Fexpand_file_name (file, Qnil);
2660 newname = Fexpand_file_name (newname, Qnil);
2662 /* If the file name has special constructs in it,
2663 call the corresponding file handler. */
2664 handler = Ffind_file_name_handler (file, Qrename_file);
2665 if (NILP (handler))
2666 handler = Ffind_file_name_handler (newname, Qrename_file);
2667 if (!NILP (handler))
2668 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2669 file, newname, ok_if_already_exists));
2671 encoded_file = ENCODE_FILE (file);
2672 encoded_newname = ENCODE_FILE (newname);
2674 #ifdef DOS_NT
2675 /* If the file names are identical but for the case, don't ask for
2676 confirmation: they simply want to change the letter-case of the
2677 file name. */
2678 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2679 #endif
2680 if (NILP (ok_if_already_exists)
2681 || INTEGERP (ok_if_already_exists))
2682 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2683 INTEGERP (ok_if_already_exists), 0, 0);
2684 #ifndef BSD4_1
2685 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2686 #else
2687 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2688 || 0 > unlink (SDATA (encoded_file)))
2689 #endif
2691 if (errno == EXDEV)
2693 Fcopy_file (file, newname,
2694 /* We have already prompted if it was an integer,
2695 so don't have copy-file prompt again. */
2696 NILP (ok_if_already_exists) ? Qnil : Qt, Qt);
2697 Fdelete_file (file);
2699 else
2700 #ifdef NO_ARG_ARRAY
2702 args[0] = file;
2703 args[1] = newname;
2704 report_file_error ("Renaming", Flist (2, args));
2706 #else
2707 report_file_error ("Renaming", Flist (2, &file));
2708 #endif
2710 UNGCPRO;
2711 return Qnil;
2714 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2715 "fAdd name to file: \nFName to add to %s: \np",
2716 doc: /* Give FILE additional name NEWNAME. Both args strings.
2717 Signals a `file-already-exists' error if a file NEWNAME already exists
2718 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2719 A number as third arg means request confirmation if NEWNAME already exists.
2720 This is what happens in interactive use with M-x. */)
2721 (file, newname, ok_if_already_exists)
2722 Lisp_Object file, newname, ok_if_already_exists;
2724 #ifdef NO_ARG_ARRAY
2725 Lisp_Object args[2];
2726 #endif
2727 Lisp_Object handler;
2728 Lisp_Object encoded_file, encoded_newname;
2729 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2731 GCPRO4 (file, newname, encoded_file, encoded_newname);
2732 encoded_file = encoded_newname = Qnil;
2733 CHECK_STRING (file);
2734 CHECK_STRING (newname);
2735 file = Fexpand_file_name (file, Qnil);
2736 newname = Fexpand_file_name (newname, Qnil);
2738 /* If the file name has special constructs in it,
2739 call the corresponding file handler. */
2740 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2741 if (!NILP (handler))
2742 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2743 newname, ok_if_already_exists));
2745 /* If the new name has special constructs in it,
2746 call the corresponding file handler. */
2747 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2748 if (!NILP (handler))
2749 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2750 newname, ok_if_already_exists));
2752 encoded_file = ENCODE_FILE (file);
2753 encoded_newname = ENCODE_FILE (newname);
2755 if (NILP (ok_if_already_exists)
2756 || INTEGERP (ok_if_already_exists))
2757 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2758 INTEGERP (ok_if_already_exists), 0, 0);
2760 unlink (SDATA (newname));
2761 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2763 #ifdef NO_ARG_ARRAY
2764 args[0] = file;
2765 args[1] = newname;
2766 report_file_error ("Adding new name", Flist (2, args));
2767 #else
2768 report_file_error ("Adding new name", Flist (2, &file));
2769 #endif
2772 UNGCPRO;
2773 return Qnil;
2776 #ifdef S_IFLNK
2777 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2778 "FMake symbolic link to file: \nFMake symbolic link to file %s: \np",
2779 doc: /* Make a symbolic link to FILENAME, named LINKNAME. Both args strings.
2780 Signals a `file-already-exists' error if a file LINKNAME already exists
2781 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2782 A number as third arg means request confirmation if LINKNAME already exists.
2783 This happens for interactive use with M-x. */)
2784 (filename, linkname, ok_if_already_exists)
2785 Lisp_Object filename, linkname, ok_if_already_exists;
2787 #ifdef NO_ARG_ARRAY
2788 Lisp_Object args[2];
2789 #endif
2790 Lisp_Object handler;
2791 Lisp_Object encoded_filename, encoded_linkname;
2792 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2794 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2795 encoded_filename = encoded_linkname = Qnil;
2796 CHECK_STRING (filename);
2797 CHECK_STRING (linkname);
2798 /* If the link target has a ~, we must expand it to get
2799 a truly valid file name. Otherwise, do not expand;
2800 we want to permit links to relative file names. */
2801 if (SREF (filename, 0) == '~')
2802 filename = Fexpand_file_name (filename, Qnil);
2803 linkname = Fexpand_file_name (linkname, Qnil);
2805 /* If the file name has special constructs in it,
2806 call the corresponding file handler. */
2807 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2808 if (!NILP (handler))
2809 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2810 linkname, ok_if_already_exists));
2812 /* If the new link name has special constructs in it,
2813 call the corresponding file handler. */
2814 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2815 if (!NILP (handler))
2816 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2817 linkname, ok_if_already_exists));
2819 encoded_filename = ENCODE_FILE (filename);
2820 encoded_linkname = ENCODE_FILE (linkname);
2822 if (NILP (ok_if_already_exists)
2823 || INTEGERP (ok_if_already_exists))
2824 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2825 INTEGERP (ok_if_already_exists), 0, 0);
2826 if (0 > symlink (SDATA (encoded_filename),
2827 SDATA (encoded_linkname)))
2829 /* If we didn't complain already, silently delete existing file. */
2830 if (errno == EEXIST)
2832 unlink (SDATA (encoded_linkname));
2833 if (0 <= symlink (SDATA (encoded_filename),
2834 SDATA (encoded_linkname)))
2836 UNGCPRO;
2837 return Qnil;
2841 #ifdef NO_ARG_ARRAY
2842 args[0] = filename;
2843 args[1] = linkname;
2844 report_file_error ("Making symbolic link", Flist (2, args));
2845 #else
2846 report_file_error ("Making symbolic link", Flist (2, &filename));
2847 #endif
2849 UNGCPRO;
2850 return Qnil;
2852 #endif /* S_IFLNK */
2854 #ifdef VMS
2856 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2857 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2858 doc: /* Define the job-wide logical name NAME to have the value STRING.
2859 If STRING is nil or a null string, the logical name NAME is deleted. */)
2860 (name, string)
2861 Lisp_Object name;
2862 Lisp_Object string;
2864 CHECK_STRING (name);
2865 if (NILP (string))
2866 delete_logical_name (SDATA (name));
2867 else
2869 CHECK_STRING (string);
2871 if (SCHARS (string) == 0)
2872 delete_logical_name (SDATA (name));
2873 else
2874 define_logical_name (SDATA (name), SDATA (string));
2877 return string;
2879 #endif /* VMS */
2881 #ifdef HPUX_NET
2883 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2884 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2885 (path, login)
2886 Lisp_Object path, login;
2888 int netresult;
2890 CHECK_STRING (path);
2891 CHECK_STRING (login);
2893 netresult = netunam (SDATA (path), SDATA (login));
2895 if (netresult == -1)
2896 return Qnil;
2897 else
2898 return Qt;
2900 #endif /* HPUX_NET */
2902 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2903 1, 1, 0,
2904 doc: /* Return t if file FILENAME specifies an absolute file name.
2905 On Unix, this is a name starting with a `/' or a `~'. */)
2906 (filename)
2907 Lisp_Object filename;
2909 const unsigned char *ptr;
2911 CHECK_STRING (filename);
2912 ptr = SDATA (filename);
2913 if (IS_DIRECTORY_SEP (*ptr) || *ptr == '~'
2914 #ifdef VMS
2915 /* ??? This criterion is probably wrong for '<'. */
2916 || index (ptr, ':') || index (ptr, '<')
2917 || (*ptr == '[' && (ptr[1] != '-' || (ptr[2] != '.' && ptr[2] != ']'))
2918 && ptr[1] != '.')
2919 #endif /* VMS */
2920 #ifdef DOS_NT
2921 || (IS_DRIVE (*ptr) && ptr[1] == ':' && IS_DIRECTORY_SEP (ptr[2]))
2922 #endif
2924 return Qt;
2925 else
2926 return Qnil;
2929 /* Return nonzero if file FILENAME exists and can be executed. */
2931 static int
2932 check_executable (filename)
2933 char *filename;
2935 #ifdef DOS_NT
2936 int len = strlen (filename);
2937 char *suffix;
2938 struct stat st;
2939 if (stat (filename, &st) < 0)
2940 return 0;
2941 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2942 return ((st.st_mode & S_IEXEC) != 0);
2943 #else
2944 return (S_ISREG (st.st_mode)
2945 && len >= 5
2946 && (stricmp ((suffix = filename + len-4), ".com") == 0
2947 || stricmp (suffix, ".exe") == 0
2948 || stricmp (suffix, ".bat") == 0)
2949 || (st.st_mode & S_IFMT) == S_IFDIR);
2950 #endif /* not WINDOWSNT */
2951 #else /* not DOS_NT */
2952 #ifdef HAVE_EUIDACCESS
2953 return (euidaccess (filename, 1) >= 0);
2954 #else
2955 /* Access isn't quite right because it uses the real uid
2956 and we really want to test with the effective uid.
2957 But Unix doesn't give us a right way to do it. */
2958 return (access (filename, 1) >= 0);
2959 #endif
2960 #endif /* not DOS_NT */
2963 /* Return nonzero if file FILENAME exists and can be written. */
2965 static int
2966 check_writable (filename)
2967 char *filename;
2969 #ifdef MSDOS
2970 struct stat st;
2971 if (stat (filename, &st) < 0)
2972 return 0;
2973 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
2974 #else /* not MSDOS */
2975 #ifdef HAVE_EUIDACCESS
2976 return (euidaccess (filename, 2) >= 0);
2977 #else
2978 /* Access isn't quite right because it uses the real uid
2979 and we really want to test with the effective uid.
2980 But Unix doesn't give us a right way to do it.
2981 Opening with O_WRONLY could work for an ordinary file,
2982 but would lose for directories. */
2983 return (access (filename, 2) >= 0);
2984 #endif
2985 #endif /* not MSDOS */
2988 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2989 doc: /* Return t if file FILENAME exists. (This does not mean you can read it.)
2990 See also `file-readable-p' and `file-attributes'. */)
2991 (filename)
2992 Lisp_Object filename;
2994 Lisp_Object absname;
2995 Lisp_Object handler;
2996 struct stat statbuf;
2998 CHECK_STRING (filename);
2999 absname = Fexpand_file_name (filename, Qnil);
3001 /* If the file name has special constructs in it,
3002 call the corresponding file handler. */
3003 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3004 if (!NILP (handler))
3005 return call2 (handler, Qfile_exists_p, absname);
3007 absname = ENCODE_FILE (absname);
3009 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3012 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3013 doc: /* Return t if FILENAME can be executed by you.
3014 For a directory, this means you can access files in that directory. */)
3015 (filename)
3016 Lisp_Object filename;
3018 Lisp_Object absname;
3019 Lisp_Object handler;
3021 CHECK_STRING (filename);
3022 absname = Fexpand_file_name (filename, Qnil);
3024 /* If the file name has special constructs in it,
3025 call the corresponding file handler. */
3026 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3027 if (!NILP (handler))
3028 return call2 (handler, Qfile_executable_p, absname);
3030 absname = ENCODE_FILE (absname);
3032 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3035 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3036 doc: /* Return t if file FILENAME exists and you can read it.
3037 See also `file-exists-p' and `file-attributes'. */)
3038 (filename)
3039 Lisp_Object filename;
3041 Lisp_Object absname;
3042 Lisp_Object handler;
3043 int desc;
3044 int flags;
3045 struct stat statbuf;
3047 CHECK_STRING (filename);
3048 absname = Fexpand_file_name (filename, Qnil);
3050 /* If the file name has special constructs in it,
3051 call the corresponding file handler. */
3052 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3053 if (!NILP (handler))
3054 return call2 (handler, Qfile_readable_p, absname);
3056 absname = ENCODE_FILE (absname);
3058 #if defined(DOS_NT) || defined(macintosh)
3059 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3060 directories. */
3061 if (access (SDATA (absname), 0) == 0)
3062 return Qt;
3063 return Qnil;
3064 #else /* not DOS_NT and not macintosh */
3065 flags = O_RDONLY;
3066 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3067 /* Opening a fifo without O_NONBLOCK can wait.
3068 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3069 except in the case of a fifo, on a system which handles it. */
3070 desc = stat (SDATA (absname), &statbuf);
3071 if (desc < 0)
3072 return Qnil;
3073 if (S_ISFIFO (statbuf.st_mode))
3074 flags |= O_NONBLOCK;
3075 #endif
3076 desc = emacs_open (SDATA (absname), flags, 0);
3077 if (desc < 0)
3078 return Qnil;
3079 emacs_close (desc);
3080 return Qt;
3081 #endif /* not DOS_NT and not macintosh */
3084 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3085 on the RT/PC. */
3086 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3087 doc: /* Return t if file FILENAME can be written or created by you. */)
3088 (filename)
3089 Lisp_Object filename;
3091 Lisp_Object absname, dir, encoded;
3092 Lisp_Object handler;
3093 struct stat statbuf;
3095 CHECK_STRING (filename);
3096 absname = Fexpand_file_name (filename, Qnil);
3098 /* If the file name has special constructs in it,
3099 call the corresponding file handler. */
3100 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3101 if (!NILP (handler))
3102 return call2 (handler, Qfile_writable_p, absname);
3104 encoded = ENCODE_FILE (absname);
3105 if (stat (SDATA (encoded), &statbuf) >= 0)
3106 return (check_writable (SDATA (encoded))
3107 ? Qt : Qnil);
3109 dir = Ffile_name_directory (absname);
3110 #ifdef VMS
3111 if (!NILP (dir))
3112 dir = Fdirectory_file_name (dir);
3113 #endif /* VMS */
3114 #ifdef MSDOS
3115 if (!NILP (dir))
3116 dir = Fdirectory_file_name (dir);
3117 #endif /* MSDOS */
3119 dir = ENCODE_FILE (dir);
3120 #ifdef WINDOWSNT
3121 /* The read-only attribute of the parent directory doesn't affect
3122 whether a file or directory can be created within it. Some day we
3123 should check ACLs though, which do affect this. */
3124 if (stat (SDATA (dir), &statbuf) < 0)
3125 return Qnil;
3126 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3127 #else
3128 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3129 ? Qt : Qnil);
3130 #endif
3133 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3134 doc: /* Access file FILENAME, and get an error if that does not work.
3135 The second argument STRING is used in the error message.
3136 If there is no error, we return nil. */)
3137 (filename, string)
3138 Lisp_Object filename, string;
3140 Lisp_Object handler, encoded_filename, absname;
3141 int fd;
3143 CHECK_STRING (filename);
3144 absname = Fexpand_file_name (filename, Qnil);
3146 CHECK_STRING (string);
3148 /* If the file name has special constructs in it,
3149 call the corresponding file handler. */
3150 handler = Ffind_file_name_handler (absname, Qaccess_file);
3151 if (!NILP (handler))
3152 return call3 (handler, Qaccess_file, absname, string);
3154 encoded_filename = ENCODE_FILE (absname);
3156 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3157 if (fd < 0)
3158 report_file_error (SDATA (string), Fcons (filename, Qnil));
3159 emacs_close (fd);
3161 return Qnil;
3164 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3165 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3166 The value is the name of the file to which it is linked.
3167 Otherwise returns nil. */)
3168 (filename)
3169 Lisp_Object filename;
3171 #ifdef S_IFLNK
3172 char *buf;
3173 int bufsize;
3174 int valsize;
3175 Lisp_Object val;
3176 Lisp_Object handler;
3178 CHECK_STRING (filename);
3179 filename = Fexpand_file_name (filename, Qnil);
3181 /* If the file name has special constructs in it,
3182 call the corresponding file handler. */
3183 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3184 if (!NILP (handler))
3185 return call2 (handler, Qfile_symlink_p, filename);
3187 filename = ENCODE_FILE (filename);
3189 bufsize = 50;
3190 buf = NULL;
3193 bufsize *= 2;
3194 buf = (char *) xrealloc (buf, bufsize);
3195 bzero (buf, bufsize);
3197 errno = 0;
3198 valsize = readlink (SDATA (filename), buf, bufsize);
3199 if (valsize == -1)
3201 #ifdef ERANGE
3202 /* HP-UX reports ERANGE if buffer is too small. */
3203 if (errno == ERANGE)
3204 valsize = bufsize;
3205 else
3206 #endif
3208 xfree (buf);
3209 return Qnil;
3213 while (valsize >= bufsize);
3215 val = make_string (buf, valsize);
3216 if (buf[0] == '/' && index (buf, ':'))
3217 val = concat2 (build_string ("/:"), val);
3218 xfree (buf);
3219 val = DECODE_FILE (val);
3220 return val;
3221 #else /* not S_IFLNK */
3222 return Qnil;
3223 #endif /* not S_IFLNK */
3226 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3227 doc: /* Return t if FILENAME names an existing directory.
3228 Symbolic links to directories count as directories.
3229 See `file-symlink-p' to distinguish symlinks. */)
3230 (filename)
3231 Lisp_Object filename;
3233 register Lisp_Object absname;
3234 struct stat st;
3235 Lisp_Object handler;
3237 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3239 /* If the file name has special constructs in it,
3240 call the corresponding file handler. */
3241 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3242 if (!NILP (handler))
3243 return call2 (handler, Qfile_directory_p, absname);
3245 absname = ENCODE_FILE (absname);
3247 if (stat (SDATA (absname), &st) < 0)
3248 return Qnil;
3249 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3252 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3253 doc: /* Return t if file FILENAME names a directory you can open.
3254 For the value to be t, FILENAME must specify the name of a directory as a file,
3255 and the directory must allow you to open files in it. In order to use a
3256 directory as a buffer's current directory, this predicate must return true.
3257 A directory name spec may be given instead; then the value is t
3258 if the directory so specified exists and really is a readable and
3259 searchable directory. */)
3260 (filename)
3261 Lisp_Object filename;
3263 Lisp_Object handler;
3264 int tem;
3265 struct gcpro gcpro1;
3267 /* If the file name has special constructs in it,
3268 call the corresponding file handler. */
3269 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3270 if (!NILP (handler))
3271 return call2 (handler, Qfile_accessible_directory_p, filename);
3273 GCPRO1 (filename);
3274 tem = (NILP (Ffile_directory_p (filename))
3275 || NILP (Ffile_executable_p (filename)));
3276 UNGCPRO;
3277 return tem ? Qnil : Qt;
3280 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3281 doc: /* Return t if file FILENAME is the name of a regular file.
3282 This is the sort of file that holds an ordinary stream of data bytes. */)
3283 (filename)
3284 Lisp_Object filename;
3286 register Lisp_Object absname;
3287 struct stat st;
3288 Lisp_Object handler;
3290 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3292 /* If the file name has special constructs in it,
3293 call the corresponding file handler. */
3294 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3295 if (!NILP (handler))
3296 return call2 (handler, Qfile_regular_p, absname);
3298 absname = ENCODE_FILE (absname);
3300 #ifdef WINDOWSNT
3302 int result;
3303 Lisp_Object tem = Vw32_get_true_file_attributes;
3305 /* Tell stat to use expensive method to get accurate info. */
3306 Vw32_get_true_file_attributes = Qt;
3307 result = stat (SDATA (absname), &st);
3308 Vw32_get_true_file_attributes = tem;
3310 if (result < 0)
3311 return Qnil;
3312 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3314 #else
3315 if (stat (SDATA (absname), &st) < 0)
3316 return Qnil;
3317 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3318 #endif
3321 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3322 doc: /* Return mode bits of file named FILENAME, as an integer. */)
3323 (filename)
3324 Lisp_Object filename;
3326 Lisp_Object absname;
3327 struct stat st;
3328 Lisp_Object handler;
3330 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3332 /* If the file name has special constructs in it,
3333 call the corresponding file handler. */
3334 handler = Ffind_file_name_handler (absname, Qfile_modes);
3335 if (!NILP (handler))
3336 return call2 (handler, Qfile_modes, absname);
3338 absname = ENCODE_FILE (absname);
3340 if (stat (SDATA (absname), &st) < 0)
3341 return Qnil;
3342 #if defined (MSDOS) && __DJGPP__ < 2
3343 if (check_executable (SDATA (absname)))
3344 st.st_mode |= S_IEXEC;
3345 #endif /* MSDOS && __DJGPP__ < 2 */
3347 return make_number (st.st_mode & 07777);
3350 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3351 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3352 Only the 12 low bits of MODE are used. */)
3353 (filename, mode)
3354 Lisp_Object filename, mode;
3356 Lisp_Object absname, encoded_absname;
3357 Lisp_Object handler;
3359 absname = Fexpand_file_name (filename, current_buffer->directory);
3360 CHECK_NUMBER (mode);
3362 /* If the file name has special constructs in it,
3363 call the corresponding file handler. */
3364 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3365 if (!NILP (handler))
3366 return call3 (handler, Qset_file_modes, absname, mode);
3368 encoded_absname = ENCODE_FILE (absname);
3370 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3371 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3373 return Qnil;
3376 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3377 doc: /* Set the file permission bits for newly created files.
3378 The argument MODE should be an integer; only the low 9 bits are used.
3379 This setting is inherited by subprocesses. */)
3380 (mode)
3381 Lisp_Object mode;
3383 CHECK_NUMBER (mode);
3385 umask ((~ XINT (mode)) & 0777);
3387 return Qnil;
3390 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3391 doc: /* Return the default file protection for created files.
3392 The value is an integer. */)
3395 int realmask;
3396 Lisp_Object value;
3398 realmask = umask (0);
3399 umask (realmask);
3401 XSETINT (value, (~ realmask) & 0777);
3402 return value;
3406 #ifdef __NetBSD__
3407 #define unix 42
3408 #endif
3410 #ifdef unix
3411 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3412 doc: /* Tell Unix to finish all pending disk updates. */)
3415 sync ();
3416 return Qnil;
3419 #endif /* unix */
3421 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3422 doc: /* Return t if file FILE1 is newer than file FILE2.
3423 If FILE1 does not exist, the answer is nil;
3424 otherwise, if FILE2 does not exist, the answer is t. */)
3425 (file1, file2)
3426 Lisp_Object file1, file2;
3428 Lisp_Object absname1, absname2;
3429 struct stat st;
3430 int mtime1;
3431 Lisp_Object handler;
3432 struct gcpro gcpro1, gcpro2;
3434 CHECK_STRING (file1);
3435 CHECK_STRING (file2);
3437 absname1 = Qnil;
3438 GCPRO2 (absname1, file2);
3439 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3440 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3441 UNGCPRO;
3443 /* If the file name has special constructs in it,
3444 call the corresponding file handler. */
3445 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3446 if (NILP (handler))
3447 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3448 if (!NILP (handler))
3449 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3451 GCPRO2 (absname1, absname2);
3452 absname1 = ENCODE_FILE (absname1);
3453 absname2 = ENCODE_FILE (absname2);
3454 UNGCPRO;
3456 if (stat (SDATA (absname1), &st) < 0)
3457 return Qnil;
3459 mtime1 = st.st_mtime;
3461 if (stat (SDATA (absname2), &st) < 0)
3462 return Qt;
3464 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3467 #ifdef DOS_NT
3468 Lisp_Object Qfind_buffer_file_type;
3469 #endif /* DOS_NT */
3471 #ifndef READ_BUF_SIZE
3472 #define READ_BUF_SIZE (64 << 10)
3473 #endif
3475 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3477 /* This function is called after Lisp functions to decide a coding
3478 system are called, or when they cause an error. Before they are
3479 called, the current buffer is set unibyte and it contains only a
3480 newly inserted text (thus the buffer was empty before the
3481 insertion).
3483 The functions may set markers, overlays, text properties, or even
3484 alter the buffer contents, change the current buffer.
3486 Here, we reset all those changes by:
3487 o set back the current buffer.
3488 o move all markers and overlays to BEG.
3489 o remove all text properties.
3490 o set back the buffer multibyteness. */
3492 static Lisp_Object
3493 decide_coding_unwind (unwind_data)
3494 Lisp_Object unwind_data;
3496 Lisp_Object multibyte, undo_list, buffer;
3498 multibyte = XCAR (unwind_data);
3499 unwind_data = XCDR (unwind_data);
3500 undo_list = XCAR (unwind_data);
3501 buffer = XCDR (unwind_data);
3503 if (current_buffer != XBUFFER (buffer))
3504 set_buffer_internal (XBUFFER (buffer));
3505 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3506 adjust_overlays_for_delete (BEG, Z - BEG);
3507 BUF_INTERVALS (current_buffer) = 0;
3508 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3510 /* Now we are safe to change the buffer's multibyteness directly. */
3511 current_buffer->enable_multibyte_characters = multibyte;
3512 current_buffer->undo_list = undo_list;
3514 return Qnil;
3518 /* Used to pass values from insert-file-contents to read_non_regular. */
3520 static int non_regular_fd;
3521 static int non_regular_inserted;
3522 static int non_regular_nbytes;
3525 /* Read from a non-regular file.
3526 Read non_regular_trytry bytes max from non_regular_fd.
3527 Non_regular_inserted specifies where to put the read bytes.
3528 Value is the number of bytes read. */
3530 static Lisp_Object
3531 read_non_regular ()
3533 int nbytes;
3535 immediate_quit = 1;
3536 QUIT;
3537 nbytes = emacs_read (non_regular_fd,
3538 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3539 non_regular_nbytes);
3540 immediate_quit = 0;
3541 return make_number (nbytes);
3545 /* Condition-case handler used when reading from non-regular files
3546 in insert-file-contents. */
3548 static Lisp_Object
3549 read_non_regular_quit ()
3551 return Qnil;
3555 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3556 1, 5, 0,
3557 doc: /* Insert contents of file FILENAME after point.
3558 Returns list of absolute file name and number of bytes inserted.
3559 If second argument VISIT is non-nil, the buffer's visited filename
3560 and last save file modtime are set, and it is marked unmodified.
3561 If visiting and the file does not exist, visiting is completed
3562 before the error is signaled.
3563 The optional third and fourth arguments BEG and END
3564 specify what portion of the file to insert.
3565 These arguments count bytes in the file, not characters in the buffer.
3566 If VISIT is non-nil, BEG and END must be nil.
3568 If optional fifth argument REPLACE is non-nil,
3569 it means replace the current buffer contents (in the accessible portion)
3570 with the file contents. This is better than simply deleting and inserting
3571 the whole thing because (1) it preserves some marker positions
3572 and (2) it puts less data in the undo list.
3573 When REPLACE is non-nil, the value is the number of characters actually read,
3574 which is often less than the number of characters to be read.
3576 This does code conversion according to the value of
3577 `coding-system-for-read' or `file-coding-system-alist',
3578 and sets the variable `last-coding-system-used' to the coding system
3579 actually used. */)
3580 (filename, visit, beg, end, replace)
3581 Lisp_Object filename, visit, beg, end, replace;
3583 struct stat st;
3584 register int fd;
3585 int inserted = 0;
3586 register int how_much;
3587 register int unprocessed;
3588 int count = SPECPDL_INDEX ();
3589 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3590 Lisp_Object handler, val, insval, orig_filename;
3591 Lisp_Object p;
3592 int total = 0;
3593 int not_regular = 0;
3594 unsigned char read_buf[READ_BUF_SIZE];
3595 struct coding_system coding;
3596 unsigned char buffer[1 << 14];
3597 int replace_handled = 0;
3598 int set_coding_system = 0;
3599 int coding_system_decided = 0;
3600 int read_quit = 0;
3602 if (current_buffer->base_buffer && ! NILP (visit))
3603 error ("Cannot do file visiting in an indirect buffer");
3605 if (!NILP (current_buffer->read_only))
3606 Fbarf_if_buffer_read_only ();
3608 val = Qnil;
3609 p = Qnil;
3610 orig_filename = Qnil;
3612 GCPRO4 (filename, val, p, orig_filename);
3614 CHECK_STRING (filename);
3615 filename = Fexpand_file_name (filename, Qnil);
3617 /* If the file name has special constructs in it,
3618 call the corresponding file handler. */
3619 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3620 if (!NILP (handler))
3622 val = call6 (handler, Qinsert_file_contents, filename,
3623 visit, beg, end, replace);
3624 if (CONSP (val) && CONSP (XCDR (val)))
3625 inserted = XINT (XCAR (XCDR (val)));
3626 goto handled;
3629 orig_filename = filename;
3630 filename = ENCODE_FILE (filename);
3632 fd = -1;
3634 #ifdef WINDOWSNT
3636 Lisp_Object tem = Vw32_get_true_file_attributes;
3638 /* Tell stat to use expensive method to get accurate info. */
3639 Vw32_get_true_file_attributes = Qt;
3640 total = stat (SDATA (filename), &st);
3641 Vw32_get_true_file_attributes = tem;
3643 if (total < 0)
3644 #else
3645 #ifndef APOLLO
3646 if (stat (SDATA (filename), &st) < 0)
3647 #else
3648 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3649 || fstat (fd, &st) < 0)
3650 #endif /* not APOLLO */
3651 #endif /* WINDOWSNT */
3653 if (fd >= 0) emacs_close (fd);
3654 badopen:
3655 if (NILP (visit))
3656 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3657 st.st_mtime = -1;
3658 how_much = 0;
3659 if (!NILP (Vcoding_system_for_read))
3660 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3661 goto notfound;
3664 #ifdef S_IFREG
3665 /* This code will need to be changed in order to work on named
3666 pipes, and it's probably just not worth it. So we should at
3667 least signal an error. */
3668 if (!S_ISREG (st.st_mode))
3670 not_regular = 1;
3672 if (! NILP (visit))
3673 goto notfound;
3675 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3676 Fsignal (Qfile_error,
3677 Fcons (build_string ("not a regular file"),
3678 Fcons (orig_filename, Qnil)));
3680 #endif
3682 if (fd < 0)
3683 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3684 goto badopen;
3686 /* Replacement should preserve point as it preserves markers. */
3687 if (!NILP (replace))
3688 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3690 record_unwind_protect (close_file_unwind, make_number (fd));
3692 /* Supposedly happens on VMS. */
3693 /* Can happen on any platform that uses long as type of off_t, but allows
3694 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3695 give a message suitable for the latter case. */
3696 if (! not_regular && st.st_size < 0)
3697 error ("Maximum buffer size exceeded");
3699 /* Prevent redisplay optimizations. */
3700 current_buffer->clip_changed = 1;
3702 if (!NILP (visit))
3704 if (!NILP (beg) || !NILP (end))
3705 error ("Attempt to visit less than an entire file");
3706 if (BEG < Z && NILP (replace))
3707 error ("Cannot do file visiting in a non-empty buffer");
3710 if (!NILP (beg))
3711 CHECK_NUMBER (beg);
3712 else
3713 XSETFASTINT (beg, 0);
3715 if (!NILP (end))
3716 CHECK_NUMBER (end);
3717 else
3719 if (! not_regular)
3721 XSETINT (end, st.st_size);
3723 /* Arithmetic overflow can occur if an Emacs integer cannot
3724 represent the file size, or if the calculations below
3725 overflow. The calculations below double the file size
3726 twice, so check that it can be multiplied by 4 safely. */
3727 if (XINT (end) != st.st_size
3728 || ((int) st.st_size * 4) / 4 != st.st_size)
3729 error ("Maximum buffer size exceeded");
3731 /* The file size returned from stat may be zero, but data
3732 may be readable nonetheless, for example when this is a
3733 file in the /proc filesystem. */
3734 if (st.st_size == 0)
3735 XSETINT (end, READ_BUF_SIZE);
3739 if (BEG < Z)
3741 /* Decide the coding system to use for reading the file now
3742 because we can't use an optimized method for handling
3743 `coding:' tag if the current buffer is not empty. */
3744 Lisp_Object val;
3745 val = Qnil;
3747 if (!NILP (Vcoding_system_for_read))
3748 val = Vcoding_system_for_read;
3749 else if (! NILP (replace))
3750 /* In REPLACE mode, we can use the same coding system
3751 that was used to visit the file. */
3752 val = current_buffer->buffer_file_coding_system;
3753 else
3755 /* Don't try looking inside a file for a coding system
3756 specification if it is not seekable. */
3757 if (! not_regular && ! NILP (Vset_auto_coding_function))
3759 /* Find a coding system specified in the heading two
3760 lines or in the tailing several lines of the file.
3761 We assume that the 1K-byte and 3K-byte for heading
3762 and tailing respectively are sufficient for this
3763 purpose. */
3764 int nread;
3766 if (st.st_size <= (1024 * 4))
3767 nread = emacs_read (fd, read_buf, 1024 * 4);
3768 else
3770 nread = emacs_read (fd, read_buf, 1024);
3771 if (nread >= 0)
3773 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3774 report_file_error ("Setting file position",
3775 Fcons (orig_filename, Qnil));
3776 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3780 if (nread < 0)
3781 error ("IO error reading %s: %s",
3782 SDATA (orig_filename), emacs_strerror (errno));
3783 else if (nread > 0)
3785 struct buffer *prev = current_buffer;
3786 Lisp_Object buffer;
3787 struct buffer *buf;
3789 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3791 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3792 buf = XBUFFER (buffer);
3794 buf->directory = current_buffer->directory;
3795 buf->read_only = Qnil;
3796 buf->filename = Qnil;
3797 buf->undo_list = Qt;
3798 buf->overlays_before = Qnil;
3799 buf->overlays_after = Qnil;
3801 set_buffer_internal (buf);
3802 Ferase_buffer ();
3803 buf->enable_multibyte_characters = Qnil;
3805 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3806 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3807 val = call2 (Vset_auto_coding_function,
3808 filename, make_number (nread));
3809 set_buffer_internal (prev);
3811 /* Discard the unwind protect for recovering the
3812 current buffer. */
3813 specpdl_ptr--;
3815 /* Rewind the file for the actual read done later. */
3816 if (lseek (fd, 0, 0) < 0)
3817 report_file_error ("Setting file position",
3818 Fcons (orig_filename, Qnil));
3822 if (NILP (val))
3824 /* If we have not yet decided a coding system, check
3825 file-coding-system-alist. */
3826 Lisp_Object args[6], coding_systems;
3828 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3829 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3830 coding_systems = Ffind_operation_coding_system (6, args);
3831 if (CONSP (coding_systems))
3832 val = XCAR (coding_systems);
3836 setup_coding_system (Fcheck_coding_system (val), &coding);
3837 /* Ensure we set Vlast_coding_system_used. */
3838 set_coding_system = 1;
3840 if (NILP (current_buffer->enable_multibyte_characters)
3841 && ! NILP (val))
3842 /* We must suppress all character code conversion except for
3843 end-of-line conversion. */
3844 setup_raw_text_coding_system (&coding);
3846 coding.src_multibyte = 0;
3847 coding.dst_multibyte
3848 = !NILP (current_buffer->enable_multibyte_characters);
3849 coding_system_decided = 1;
3852 /* If requested, replace the accessible part of the buffer
3853 with the file contents. Avoid replacing text at the
3854 beginning or end of the buffer that matches the file contents;
3855 that preserves markers pointing to the unchanged parts.
3857 Here we implement this feature in an optimized way
3858 for the case where code conversion is NOT needed.
3859 The following if-statement handles the case of conversion
3860 in a less optimal way.
3862 If the code conversion is "automatic" then we try using this
3863 method and hope for the best.
3864 But if we discover the need for conversion, we give up on this method
3865 and let the following if-statement handle the replace job. */
3866 if (!NILP (replace)
3867 && BEGV < ZV
3868 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
3870 /* same_at_start and same_at_end count bytes,
3871 because file access counts bytes
3872 and BEG and END count bytes. */
3873 int same_at_start = BEGV_BYTE;
3874 int same_at_end = ZV_BYTE;
3875 int overlap;
3876 /* There is still a possibility we will find the need to do code
3877 conversion. If that happens, we set this variable to 1 to
3878 give up on handling REPLACE in the optimized way. */
3879 int giveup_match_end = 0;
3881 if (XINT (beg) != 0)
3883 if (lseek (fd, XINT (beg), 0) < 0)
3884 report_file_error ("Setting file position",
3885 Fcons (orig_filename, Qnil));
3888 immediate_quit = 1;
3889 QUIT;
3890 /* Count how many chars at the start of the file
3891 match the text at the beginning of the buffer. */
3892 while (1)
3894 int nread, bufpos;
3896 nread = emacs_read (fd, buffer, sizeof buffer);
3897 if (nread < 0)
3898 error ("IO error reading %s: %s",
3899 SDATA (orig_filename), emacs_strerror (errno));
3900 else if (nread == 0)
3901 break;
3903 if (coding.type == coding_type_undecided)
3904 detect_coding (&coding, buffer, nread);
3905 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
3906 /* We found that the file should be decoded somehow.
3907 Let's give up here. */
3909 giveup_match_end = 1;
3910 break;
3913 if (coding.eol_type == CODING_EOL_UNDECIDED)
3914 detect_eol (&coding, buffer, nread);
3915 if (coding.eol_type != CODING_EOL_UNDECIDED
3916 && coding.eol_type != CODING_EOL_LF)
3917 /* We found that the format of eol should be decoded.
3918 Let's give up here. */
3920 giveup_match_end = 1;
3921 break;
3924 bufpos = 0;
3925 while (bufpos < nread && same_at_start < ZV_BYTE
3926 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3927 same_at_start++, bufpos++;
3928 /* If we found a discrepancy, stop the scan.
3929 Otherwise loop around and scan the next bufferful. */
3930 if (bufpos != nread)
3931 break;
3933 immediate_quit = 0;
3934 /* If the file matches the buffer completely,
3935 there's no need to replace anything. */
3936 if (same_at_start - BEGV_BYTE == XINT (end))
3938 emacs_close (fd);
3939 specpdl_ptr--;
3940 /* Truncate the buffer to the size of the file. */
3941 del_range_1 (same_at_start, same_at_end, 0, 0);
3942 goto handled;
3944 immediate_quit = 1;
3945 QUIT;
3946 /* Count how many chars at the end of the file
3947 match the text at the end of the buffer. But, if we have
3948 already found that decoding is necessary, don't waste time. */
3949 while (!giveup_match_end)
3951 int total_read, nread, bufpos, curpos, trial;
3953 /* At what file position are we now scanning? */
3954 curpos = XINT (end) - (ZV_BYTE - same_at_end);
3955 /* If the entire file matches the buffer tail, stop the scan. */
3956 if (curpos == 0)
3957 break;
3958 /* How much can we scan in the next step? */
3959 trial = min (curpos, sizeof buffer);
3960 if (lseek (fd, curpos - trial, 0) < 0)
3961 report_file_error ("Setting file position",
3962 Fcons (orig_filename, Qnil));
3964 total_read = nread = 0;
3965 while (total_read < trial)
3967 nread = emacs_read (fd, buffer + total_read, trial - total_read);
3968 if (nread < 0)
3969 error ("IO error reading %s: %s",
3970 SDATA (orig_filename), emacs_strerror (errno));
3971 else if (nread == 0)
3972 break;
3973 total_read += nread;
3976 /* Scan this bufferful from the end, comparing with
3977 the Emacs buffer. */
3978 bufpos = total_read;
3980 /* Compare with same_at_start to avoid counting some buffer text
3981 as matching both at the file's beginning and at the end. */
3982 while (bufpos > 0 && same_at_end > same_at_start
3983 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3984 same_at_end--, bufpos--;
3986 /* If we found a discrepancy, stop the scan.
3987 Otherwise loop around and scan the preceding bufferful. */
3988 if (bufpos != 0)
3990 /* If this discrepancy is because of code conversion,
3991 we cannot use this method; giveup and try the other. */
3992 if (same_at_end > same_at_start
3993 && FETCH_BYTE (same_at_end - 1) >= 0200
3994 && ! NILP (current_buffer->enable_multibyte_characters)
3995 && (CODING_MAY_REQUIRE_DECODING (&coding)))
3996 giveup_match_end = 1;
3997 break;
4000 if (nread == 0)
4001 break;
4003 immediate_quit = 0;
4005 if (! giveup_match_end)
4007 int temp;
4009 /* We win! We can handle REPLACE the optimized way. */
4011 /* Extend the start of non-matching text area to multibyte
4012 character boundary. */
4013 if (! NILP (current_buffer->enable_multibyte_characters))
4014 while (same_at_start > BEGV_BYTE
4015 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4016 same_at_start--;
4018 /* Extend the end of non-matching text area to multibyte
4019 character boundary. */
4020 if (! NILP (current_buffer->enable_multibyte_characters))
4021 while (same_at_end < ZV_BYTE
4022 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4023 same_at_end++;
4025 /* Don't try to reuse the same piece of text twice. */
4026 overlap = (same_at_start - BEGV_BYTE
4027 - (same_at_end + st.st_size - ZV));
4028 if (overlap > 0)
4029 same_at_end += overlap;
4031 /* Arrange to read only the nonmatching middle part of the file. */
4032 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4033 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4035 del_range_byte (same_at_start, same_at_end, 0);
4036 /* Insert from the file at the proper position. */
4037 temp = BYTE_TO_CHAR (same_at_start);
4038 SET_PT_BOTH (temp, same_at_start);
4040 /* If display currently starts at beginning of line,
4041 keep it that way. */
4042 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4043 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4045 replace_handled = 1;
4049 /* If requested, replace the accessible part of the buffer
4050 with the file contents. Avoid replacing text at the
4051 beginning or end of the buffer that matches the file contents;
4052 that preserves markers pointing to the unchanged parts.
4054 Here we implement this feature for the case where code conversion
4055 is needed, in a simple way that needs a lot of memory.
4056 The preceding if-statement handles the case of no conversion
4057 in a more optimized way. */
4058 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4060 int same_at_start = BEGV_BYTE;
4061 int same_at_end = ZV_BYTE;
4062 int overlap;
4063 int bufpos;
4064 /* Make sure that the gap is large enough. */
4065 int bufsize = 2 * st.st_size;
4066 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4067 int temp;
4069 /* First read the whole file, performing code conversion into
4070 CONVERSION_BUFFER. */
4072 if (lseek (fd, XINT (beg), 0) < 0)
4074 xfree (conversion_buffer);
4075 report_file_error ("Setting file position",
4076 Fcons (orig_filename, Qnil));
4079 total = st.st_size; /* Total bytes in the file. */
4080 how_much = 0; /* Bytes read from file so far. */
4081 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4082 unprocessed = 0; /* Bytes not processed in previous loop. */
4084 while (how_much < total)
4086 /* try is reserved in some compilers (Microsoft C) */
4087 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4088 unsigned char *destination = read_buf + unprocessed;
4089 int this;
4091 /* Allow quitting out of the actual I/O. */
4092 immediate_quit = 1;
4093 QUIT;
4094 this = emacs_read (fd, destination, trytry);
4095 immediate_quit = 0;
4097 if (this < 0 || this + unprocessed == 0)
4099 how_much = this;
4100 break;
4103 how_much += this;
4105 if (CODING_MAY_REQUIRE_DECODING (&coding))
4107 int require, result;
4109 this += unprocessed;
4111 /* If we are using more space than estimated,
4112 make CONVERSION_BUFFER bigger. */
4113 require = decoding_buffer_size (&coding, this);
4114 if (inserted + require + 2 * (total - how_much) > bufsize)
4116 bufsize = inserted + require + 2 * (total - how_much);
4117 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4120 /* Convert this batch with results in CONVERSION_BUFFER. */
4121 if (how_much >= total) /* This is the last block. */
4122 coding.mode |= CODING_MODE_LAST_BLOCK;
4123 if (coding.composing != COMPOSITION_DISABLED)
4124 coding_allocate_composition_data (&coding, BEGV);
4125 result = decode_coding (&coding, read_buf,
4126 conversion_buffer + inserted,
4127 this, bufsize - inserted);
4129 /* Save for next iteration whatever we didn't convert. */
4130 unprocessed = this - coding.consumed;
4131 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4132 if (!NILP (current_buffer->enable_multibyte_characters))
4133 this = coding.produced;
4134 else
4135 this = str_as_unibyte (conversion_buffer + inserted,
4136 coding.produced);
4139 inserted += this;
4142 /* At this point, INSERTED is how many characters (i.e. bytes)
4143 are present in CONVERSION_BUFFER.
4144 HOW_MUCH should equal TOTAL,
4145 or should be <= 0 if we couldn't read the file. */
4147 if (how_much < 0)
4149 xfree (conversion_buffer);
4151 if (how_much == -1)
4152 error ("IO error reading %s: %s",
4153 SDATA (orig_filename), emacs_strerror (errno));
4154 else if (how_much == -2)
4155 error ("maximum buffer size exceeded");
4158 /* Compare the beginning of the converted file
4159 with the buffer text. */
4161 bufpos = 0;
4162 while (bufpos < inserted && same_at_start < same_at_end
4163 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4164 same_at_start++, bufpos++;
4166 /* If the file matches the buffer completely,
4167 there's no need to replace anything. */
4169 if (bufpos == inserted)
4171 xfree (conversion_buffer);
4172 emacs_close (fd);
4173 specpdl_ptr--;
4174 /* Truncate the buffer to the size of the file. */
4175 del_range_byte (same_at_start, same_at_end, 0);
4176 inserted = 0;
4177 goto handled;
4180 /* Extend the start of non-matching text area to multibyte
4181 character boundary. */
4182 if (! NILP (current_buffer->enable_multibyte_characters))
4183 while (same_at_start > BEGV_BYTE
4184 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4185 same_at_start--;
4187 /* Scan this bufferful from the end, comparing with
4188 the Emacs buffer. */
4189 bufpos = inserted;
4191 /* Compare with same_at_start to avoid counting some buffer text
4192 as matching both at the file's beginning and at the end. */
4193 while (bufpos > 0 && same_at_end > same_at_start
4194 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4195 same_at_end--, bufpos--;
4197 /* Extend the end of non-matching text area to multibyte
4198 character boundary. */
4199 if (! NILP (current_buffer->enable_multibyte_characters))
4200 while (same_at_end < ZV_BYTE
4201 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4202 same_at_end++;
4204 /* Don't try to reuse the same piece of text twice. */
4205 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4206 if (overlap > 0)
4207 same_at_end += overlap;
4209 /* If display currently starts at beginning of line,
4210 keep it that way. */
4211 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4212 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4214 /* Replace the chars that we need to replace,
4215 and update INSERTED to equal the number of bytes
4216 we are taking from the file. */
4217 inserted -= (Z_BYTE - same_at_end) + (same_at_start - BEG_BYTE);
4219 if (same_at_end != same_at_start)
4221 del_range_byte (same_at_start, same_at_end, 0);
4222 temp = GPT;
4223 same_at_start = GPT_BYTE;
4225 else
4227 temp = BYTE_TO_CHAR (same_at_start);
4229 /* Insert from the file at the proper position. */
4230 SET_PT_BOTH (temp, same_at_start);
4231 insert_1 (conversion_buffer + same_at_start - BEG_BYTE, inserted,
4232 0, 0, 0);
4233 if (coding.cmp_data && coding.cmp_data->used)
4234 coding_restore_composition (&coding, Fcurrent_buffer ());
4235 coding_free_composition_data (&coding);
4237 /* Set `inserted' to the number of inserted characters. */
4238 inserted = PT - temp;
4240 xfree (conversion_buffer);
4241 emacs_close (fd);
4242 specpdl_ptr--;
4244 goto handled;
4247 if (! not_regular)
4249 register Lisp_Object temp;
4251 total = XINT (end) - XINT (beg);
4253 /* Make sure point-max won't overflow after this insertion. */
4254 XSETINT (temp, total);
4255 if (total != XINT (temp))
4256 error ("Maximum buffer size exceeded");
4258 else
4259 /* For a special file, all we can do is guess. */
4260 total = READ_BUF_SIZE;
4262 if (NILP (visit) && total > 0)
4263 prepare_to_modify_buffer (PT, PT, NULL);
4265 move_gap (PT);
4266 if (GAP_SIZE < total)
4267 make_gap (total - GAP_SIZE);
4269 if (XINT (beg) != 0 || !NILP (replace))
4271 if (lseek (fd, XINT (beg), 0) < 0)
4272 report_file_error ("Setting file position",
4273 Fcons (orig_filename, Qnil));
4276 /* In the following loop, HOW_MUCH contains the total bytes read so
4277 far for a regular file, and not changed for a special file. But,
4278 before exiting the loop, it is set to a negative value if I/O
4279 error occurs. */
4280 how_much = 0;
4282 /* Total bytes inserted. */
4283 inserted = 0;
4285 /* Here, we don't do code conversion in the loop. It is done by
4286 code_convert_region after all data are read into the buffer. */
4288 int gap_size = GAP_SIZE;
4290 while (how_much < total)
4292 /* try is reserved in some compilers (Microsoft C) */
4293 int trytry = min (total - how_much, READ_BUF_SIZE);
4294 int this;
4296 if (not_regular)
4298 Lisp_Object val;
4300 /* Maybe make more room. */
4301 if (gap_size < trytry)
4303 make_gap (total - gap_size);
4304 gap_size = GAP_SIZE;
4307 /* Read from the file, capturing `quit'. When an
4308 error occurs, end the loop, and arrange for a quit
4309 to be signaled after decoding the text we read. */
4310 non_regular_fd = fd;
4311 non_regular_inserted = inserted;
4312 non_regular_nbytes = trytry;
4313 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4314 read_non_regular_quit);
4315 if (NILP (val))
4317 read_quit = 1;
4318 break;
4321 this = XINT (val);
4323 else
4325 /* Allow quitting out of the actual I/O. We don't make text
4326 part of the buffer until all the reading is done, so a C-g
4327 here doesn't do any harm. */
4328 immediate_quit = 1;
4329 QUIT;
4330 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4331 immediate_quit = 0;
4334 if (this <= 0)
4336 how_much = this;
4337 break;
4340 gap_size -= this;
4342 /* For a regular file, where TOTAL is the real size,
4343 count HOW_MUCH to compare with it.
4344 For a special file, where TOTAL is just a buffer size,
4345 so don't bother counting in HOW_MUCH.
4346 (INSERTED is where we count the number of characters inserted.) */
4347 if (! not_regular)
4348 how_much += this;
4349 inserted += this;
4353 /* Make the text read part of the buffer. */
4354 GAP_SIZE -= inserted;
4355 GPT += inserted;
4356 GPT_BYTE += inserted;
4357 ZV += inserted;
4358 ZV_BYTE += inserted;
4359 Z += inserted;
4360 Z_BYTE += inserted;
4362 if (GAP_SIZE > 0)
4363 /* Put an anchor to ensure multi-byte form ends at gap. */
4364 *GPT_ADDR = 0;
4366 emacs_close (fd);
4368 /* Discard the unwind protect for closing the file. */
4369 specpdl_ptr--;
4371 if (how_much < 0)
4372 error ("IO error reading %s: %s",
4373 SDATA (orig_filename), emacs_strerror (errno));
4375 notfound:
4377 if (! coding_system_decided)
4379 /* The coding system is not yet decided. Decide it by an
4380 optimized method for handling `coding:' tag.
4382 Note that we can get here only if the buffer was empty
4383 before the insertion. */
4384 Lisp_Object val;
4385 val = Qnil;
4387 if (!NILP (Vcoding_system_for_read))
4388 val = Vcoding_system_for_read;
4389 else
4391 /* Since we are sure that the current buffer was empty
4392 before the insertion, we can toggle
4393 enable-multibyte-characters directly here without taking
4394 care of marker adjustment and byte combining problem. By
4395 this way, we can run Lisp program safely before decoding
4396 the inserted text. */
4397 Lisp_Object unwind_data;
4398 int count = SPECPDL_INDEX ();
4400 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4401 Fcons (current_buffer->undo_list,
4402 Fcurrent_buffer ()));
4403 current_buffer->enable_multibyte_characters = Qnil;
4404 current_buffer->undo_list = Qt;
4405 record_unwind_protect (decide_coding_unwind, unwind_data);
4407 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4409 val = call2 (Vset_auto_coding_function,
4410 filename, make_number (inserted));
4413 if (NILP (val))
4415 /* If the coding system is not yet decided, check
4416 file-coding-system-alist. */
4417 Lisp_Object args[6], coding_systems;
4419 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4420 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4421 coding_systems = Ffind_operation_coding_system (6, args);
4422 if (CONSP (coding_systems))
4423 val = XCAR (coding_systems);
4426 unbind_to (count, Qnil);
4427 inserted = Z_BYTE - BEG_BYTE;
4430 /* The following kludgy code is to avoid some compiler bug.
4431 We can't simply do
4432 setup_coding_system (val, &coding);
4433 on some system. */
4435 struct coding_system temp_coding;
4436 setup_coding_system (val, &temp_coding);
4437 bcopy (&temp_coding, &coding, sizeof coding);
4439 /* Ensure we set Vlast_coding_system_used. */
4440 set_coding_system = 1;
4442 if (NILP (current_buffer->enable_multibyte_characters)
4443 && ! NILP (val))
4444 /* We must suppress all character code conversion except for
4445 end-of-line conversion. */
4446 setup_raw_text_coding_system (&coding);
4447 coding.src_multibyte = 0;
4448 coding.dst_multibyte
4449 = !NILP (current_buffer->enable_multibyte_characters);
4452 if (!NILP (visit)
4453 /* Can't do this if part of the buffer might be preserved. */
4454 && NILP (replace)
4455 && (coding.type == coding_type_no_conversion
4456 || coding.type == coding_type_raw_text))
4458 /* Visiting a file with these coding system makes the buffer
4459 unibyte. */
4460 current_buffer->enable_multibyte_characters = Qnil;
4461 coding.dst_multibyte = 0;
4464 if (inserted > 0 || coding.type == coding_type_ccl)
4466 if (CODING_MAY_REQUIRE_DECODING (&coding))
4468 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4469 &coding, 0, 0);
4470 inserted = coding.produced_char;
4472 else
4473 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4474 inserted);
4477 #ifdef DOS_NT
4478 /* Use the conversion type to determine buffer-file-type
4479 (find-buffer-file-type is now used to help determine the
4480 conversion). */
4481 if ((coding.eol_type == CODING_EOL_UNDECIDED
4482 || coding.eol_type == CODING_EOL_LF)
4483 && ! CODING_REQUIRE_DECODING (&coding))
4484 current_buffer->buffer_file_type = Qt;
4485 else
4486 current_buffer->buffer_file_type = Qnil;
4487 #endif
4489 handled:
4491 if (!NILP (visit))
4493 if (!EQ (current_buffer->undo_list, Qt))
4494 current_buffer->undo_list = Qnil;
4495 #ifdef APOLLO
4496 stat (SDATA (filename), &st);
4497 #endif
4499 if (NILP (handler))
4501 current_buffer->modtime = st.st_mtime;
4502 current_buffer->filename = orig_filename;
4505 SAVE_MODIFF = MODIFF;
4506 current_buffer->auto_save_modified = MODIFF;
4507 XSETFASTINT (current_buffer->save_length, Z - BEG);
4508 #ifdef CLASH_DETECTION
4509 if (NILP (handler))
4511 if (!NILP (current_buffer->file_truename))
4512 unlock_file (current_buffer->file_truename);
4513 unlock_file (filename);
4515 #endif /* CLASH_DETECTION */
4516 if (not_regular)
4517 Fsignal (Qfile_error,
4518 Fcons (build_string ("not a regular file"),
4519 Fcons (orig_filename, Qnil)));
4522 /* Decode file format */
4523 if (inserted > 0)
4525 int empty_undo_list_p = 0;
4527 /* If we're anyway going to discard undo information, don't
4528 record it in the first place. The buffer's undo list at this
4529 point is either nil or t when visiting a file. */
4530 if (!NILP (visit))
4532 empty_undo_list_p = NILP (current_buffer->undo_list);
4533 current_buffer->undo_list = Qt;
4536 insval = call3 (Qformat_decode,
4537 Qnil, make_number (inserted), visit);
4538 CHECK_NUMBER (insval);
4539 inserted = XFASTINT (insval);
4541 if (!NILP (visit))
4542 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4545 if (set_coding_system)
4546 Vlast_coding_system_used = coding.symbol;
4548 /* Call after-change hooks for the inserted text, aside from the case
4549 of normal visiting (not with REPLACE), which is done in a new buffer
4550 "before" the buffer is changed. */
4551 if (inserted > 0 && total > 0
4552 && (NILP (visit) || !NILP (replace)))
4554 signal_after_change (PT, 0, inserted);
4555 update_compositions (PT, PT, CHECK_BORDER);
4558 p = Vafter_insert_file_functions;
4559 while (CONSP (p))
4561 insval = call1 (XCAR (p), make_number (inserted));
4562 if (!NILP (insval))
4564 CHECK_NUMBER (insval);
4565 inserted = XFASTINT (insval);
4567 QUIT;
4568 p = XCDR (p);
4571 if (!NILP (visit)
4572 && current_buffer->modtime == -1)
4574 /* If visiting nonexistent file, return nil. */
4575 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4578 if (read_quit)
4579 Fsignal (Qquit, Qnil);
4581 /* ??? Retval needs to be dealt with in all cases consistently. */
4582 if (NILP (val))
4583 val = Fcons (orig_filename,
4584 Fcons (make_number (inserted),
4585 Qnil));
4587 RETURN_UNGCPRO (unbind_to (count, val));
4590 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4591 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4592 Lisp_Object, Lisp_Object));
4594 /* If build_annotations switched buffers, switch back to BUF.
4595 Kill the temporary buffer that was selected in the meantime.
4597 Since this kill only the last temporary buffer, some buffers remain
4598 not killed if build_annotations switched buffers more than once.
4599 -- K.Handa */
4601 static Lisp_Object
4602 build_annotations_unwind (buf)
4603 Lisp_Object buf;
4605 Lisp_Object tembuf;
4607 if (XBUFFER (buf) == current_buffer)
4608 return Qnil;
4609 tembuf = Fcurrent_buffer ();
4610 Fset_buffer (buf);
4611 Fkill_buffer (tembuf);
4612 return Qnil;
4615 /* Decide the coding-system to encode the data with. */
4617 void
4618 choose_write_coding_system (start, end, filename,
4619 append, visit, lockname, coding)
4620 Lisp_Object start, end, filename, append, visit, lockname;
4621 struct coding_system *coding;
4623 Lisp_Object val;
4625 if (auto_saving)
4626 val = Qnil;
4627 else if (!NILP (Vcoding_system_for_write))
4629 val = Vcoding_system_for_write;
4630 if (coding_system_require_warning
4631 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4632 /* Confirm that VAL can surely encode the current region. */
4633 val = call5 (Vselect_safe_coding_system_function,
4634 start, end, Fcons (Qt, Fcons (val, Qnil)),
4635 Qnil, filename);
4637 else
4639 /* If the variable `buffer-file-coding-system' is set locally,
4640 it means that the file was read with some kind of code
4641 conversion or the variable is explicitly set by users. We
4642 had better write it out with the same coding system even if
4643 `enable-multibyte-characters' is nil.
4645 If it is not set locally, we anyway have to convert EOL
4646 format if the default value of `buffer-file-coding-system'
4647 tells that it is not Unix-like (LF only) format. */
4648 int using_default_coding = 0;
4649 int force_raw_text = 0;
4651 val = current_buffer->buffer_file_coding_system;
4652 if (NILP (val)
4653 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4655 val = Qnil;
4656 if (NILP (current_buffer->enable_multibyte_characters))
4657 force_raw_text = 1;
4660 if (NILP (val))
4662 /* Check file-coding-system-alist. */
4663 Lisp_Object args[7], coding_systems;
4665 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4666 args[3] = filename; args[4] = append; args[5] = visit;
4667 args[6] = lockname;
4668 coding_systems = Ffind_operation_coding_system (7, args);
4669 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4670 val = XCDR (coding_systems);
4673 if (NILP (val)
4674 && !NILP (current_buffer->buffer_file_coding_system))
4676 /* If we still have not decided a coding system, use the
4677 default value of buffer-file-coding-system. */
4678 val = current_buffer->buffer_file_coding_system;
4679 using_default_coding = 1;
4682 if (!force_raw_text
4683 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4684 /* Confirm that VAL can surely encode the current region. */
4685 val = call5 (Vselect_safe_coding_system_function,
4686 start, end, val, Qnil, filename);
4688 setup_coding_system (Fcheck_coding_system (val), coding);
4689 if (coding->eol_type == CODING_EOL_UNDECIDED
4690 && !using_default_coding)
4692 if (! EQ (default_buffer_file_coding.symbol,
4693 buffer_defaults.buffer_file_coding_system))
4694 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4695 &default_buffer_file_coding);
4696 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4698 Lisp_Object subsidiaries;
4700 coding->eol_type = default_buffer_file_coding.eol_type;
4701 subsidiaries = Fget (coding->symbol, Qeol_type);
4702 if (VECTORP (subsidiaries)
4703 && XVECTOR (subsidiaries)->size == 3)
4704 coding->symbol
4705 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4709 if (force_raw_text)
4710 setup_raw_text_coding_system (coding);
4711 goto done_setup_coding;
4714 setup_coding_system (Fcheck_coding_system (val), coding);
4716 done_setup_coding:
4717 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4718 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4721 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4722 "r\nFWrite region to file: \ni\ni\ni\np",
4723 doc: /* Write current region into specified file.
4724 When called from a program, requires three arguments:
4725 START, END and FILENAME. START and END are normally buffer positions
4726 specifying the part of the buffer to write.
4727 If START is nil, that means to use the entire buffer contents.
4728 If START is a string, then output that string to the file
4729 instead of any buffer contents; END is ignored.
4731 Optional fourth argument APPEND if non-nil means
4732 append to existing file contents (if any). If it is an integer,
4733 seek to that offset in the file before writing.
4734 Optional fifth argument VISIT if t means
4735 set the last-save-file-modtime of buffer to this file's modtime
4736 and mark buffer not modified.
4737 If VISIT is a string, it is a second file name;
4738 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4739 VISIT is also the file name to lock and unlock for clash detection.
4740 If VISIT is neither t nor nil nor a string,
4741 that means do not display the \"Wrote file\" message.
4742 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4743 use for locking and unlocking, overriding FILENAME and VISIT.
4744 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4745 for an existing file with the same name. If MUSTBENEW is `excl',
4746 that means to get an error if the file already exists; never overwrite.
4747 If MUSTBENEW is neither nil nor `excl', that means ask for
4748 confirmation before overwriting, but do go ahead and overwrite the file
4749 if the user confirms.
4751 This does code conversion according to the value of
4752 `coding-system-for-write', `buffer-file-coding-system', or
4753 `file-coding-system-alist', and sets the variable
4754 `last-coding-system-used' to the coding system actually used. */)
4755 (start, end, filename, append, visit, lockname, mustbenew)
4756 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4758 register int desc;
4759 int failure;
4760 int save_errno = 0;
4761 const unsigned char *fn;
4762 struct stat st;
4763 int tem;
4764 int count = SPECPDL_INDEX ();
4765 int count1;
4766 #ifdef VMS
4767 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4768 #endif /* VMS */
4769 Lisp_Object handler;
4770 Lisp_Object visit_file;
4771 Lisp_Object annotations;
4772 Lisp_Object encoded_filename;
4773 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4774 int quietly = !NILP (visit);
4775 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4776 struct buffer *given_buffer;
4777 #ifdef DOS_NT
4778 int buffer_file_type = O_BINARY;
4779 #endif /* DOS_NT */
4780 struct coding_system coding;
4782 if (current_buffer->base_buffer && visiting)
4783 error ("Cannot do file visiting in an indirect buffer");
4785 if (!NILP (start) && !STRINGP (start))
4786 validate_region (&start, &end);
4788 GCPRO5 (start, filename, visit, visit_file, lockname);
4790 filename = Fexpand_file_name (filename, Qnil);
4792 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4793 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4795 if (STRINGP (visit))
4796 visit_file = Fexpand_file_name (visit, Qnil);
4797 else
4798 visit_file = filename;
4800 if (NILP (lockname))
4801 lockname = visit_file;
4803 annotations = Qnil;
4805 /* If the file name has special constructs in it,
4806 call the corresponding file handler. */
4807 handler = Ffind_file_name_handler (filename, Qwrite_region);
4808 /* If FILENAME has no handler, see if VISIT has one. */
4809 if (NILP (handler) && STRINGP (visit))
4810 handler = Ffind_file_name_handler (visit, Qwrite_region);
4812 if (!NILP (handler))
4814 Lisp_Object val;
4815 val = call6 (handler, Qwrite_region, start, end,
4816 filename, append, visit);
4818 if (visiting)
4820 SAVE_MODIFF = MODIFF;
4821 XSETFASTINT (current_buffer->save_length, Z - BEG);
4822 current_buffer->filename = visit_file;
4824 UNGCPRO;
4825 return val;
4828 /* Special kludge to simplify auto-saving. */
4829 if (NILP (start))
4831 XSETFASTINT (start, BEG);
4832 XSETFASTINT (end, Z);
4835 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
4836 count1 = SPECPDL_INDEX ();
4838 given_buffer = current_buffer;
4840 if (!STRINGP (start))
4842 annotations = build_annotations (start, end);
4844 if (current_buffer != given_buffer)
4846 XSETFASTINT (start, BEGV);
4847 XSETFASTINT (end, ZV);
4851 UNGCPRO;
4853 GCPRO5 (start, filename, annotations, visit_file, lockname);
4855 /* Decide the coding-system to encode the data with.
4856 We used to make this choice before calling build_annotations, but that
4857 leads to problems when a write-annotate-function takes care of
4858 unsavable chars (as was the case with X-Symbol). */
4859 choose_write_coding_system (start, end, filename,
4860 append, visit, lockname, &coding);
4861 Vlast_coding_system_used = coding.symbol;
4863 given_buffer = current_buffer;
4864 if (! STRINGP (start))
4866 annotations = build_annotations_2 (start, end,
4867 coding.pre_write_conversion, annotations);
4868 if (current_buffer != given_buffer)
4870 XSETFASTINT (start, BEGV);
4871 XSETFASTINT (end, ZV);
4875 #ifdef CLASH_DETECTION
4876 if (!auto_saving)
4878 #if 0 /* This causes trouble for GNUS. */
4879 /* If we've locked this file for some other buffer,
4880 query before proceeding. */
4881 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
4882 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
4883 #endif
4885 lock_file (lockname);
4887 #endif /* CLASH_DETECTION */
4889 encoded_filename = ENCODE_FILE (filename);
4891 fn = SDATA (encoded_filename);
4892 desc = -1;
4893 if (!NILP (append))
4894 #ifdef DOS_NT
4895 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
4896 #else /* not DOS_NT */
4897 desc = emacs_open (fn, O_WRONLY, 0);
4898 #endif /* not DOS_NT */
4900 if (desc < 0 && (NILP (append) || errno == ENOENT))
4901 #ifdef VMS
4902 if (auto_saving) /* Overwrite any previous version of autosave file */
4904 vms_truncate (fn); /* if fn exists, truncate to zero length */
4905 desc = emacs_open (fn, O_RDWR, 0);
4906 if (desc < 0)
4907 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
4908 ? SDATA (current_buffer->filename) : 0,
4909 fn);
4911 else /* Write to temporary name and rename if no errors */
4913 Lisp_Object temp_name;
4914 temp_name = Ffile_name_directory (filename);
4916 if (!NILP (temp_name))
4918 temp_name = Fmake_temp_name (concat2 (temp_name,
4919 build_string ("$$SAVE$$")));
4920 fname = SDATA (filename);
4921 fn = SDATA (temp_name);
4922 desc = creat_copy_attrs (fname, fn);
4923 if (desc < 0)
4925 /* If we can't open the temporary file, try creating a new
4926 version of the original file. VMS "creat" creates a
4927 new version rather than truncating an existing file. */
4928 fn = fname;
4929 fname = 0;
4930 desc = creat (fn, 0666);
4931 #if 0 /* This can clobber an existing file and fail to replace it,
4932 if the user runs out of space. */
4933 if (desc < 0)
4935 /* We can't make a new version;
4936 try to truncate and rewrite existing version if any. */
4937 vms_truncate (fn);
4938 desc = emacs_open (fn, O_RDWR, 0);
4940 #endif
4943 else
4944 desc = creat (fn, 0666);
4946 #else /* not VMS */
4947 #ifdef DOS_NT
4948 desc = emacs_open (fn,
4949 O_WRONLY | O_CREAT | buffer_file_type
4950 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
4951 S_IREAD | S_IWRITE);
4952 #else /* not DOS_NT */
4953 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
4954 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
4955 auto_saving ? auto_save_mode_bits : 0666);
4956 #endif /* not DOS_NT */
4957 #endif /* not VMS */
4959 if (desc < 0)
4961 #ifdef CLASH_DETECTION
4962 save_errno = errno;
4963 if (!auto_saving) unlock_file (lockname);
4964 errno = save_errno;
4965 #endif /* CLASH_DETECTION */
4966 UNGCPRO;
4967 report_file_error ("Opening output file", Fcons (filename, Qnil));
4970 record_unwind_protect (close_file_unwind, make_number (desc));
4972 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
4974 long ret;
4976 if (NUMBERP (append))
4977 ret = lseek (desc, XINT (append), 1);
4978 else
4979 ret = lseek (desc, 0, 2);
4980 if (ret < 0)
4982 #ifdef CLASH_DETECTION
4983 if (!auto_saving) unlock_file (lockname);
4984 #endif /* CLASH_DETECTION */
4985 UNGCPRO;
4986 report_file_error ("Lseek error", Fcons (filename, Qnil));
4990 UNGCPRO;
4992 #ifdef VMS
4994 * Kludge Warning: The VMS C RTL likes to insert carriage returns
4995 * if we do writes that don't end with a carriage return. Furthermore
4996 * it cannot handle writes of more then 16K. The modified
4997 * version of "sys_write" in SYSDEP.C (see comment there) copes with
4998 * this EXCEPT for the last record (iff it doesn't end with a carriage
4999 * return). This implies that if your buffer doesn't end with a carriage
5000 * return, you get one free... tough. However it also means that if
5001 * we make two calls to sys_write (a la the following code) you can
5002 * get one at the gap as well. The easiest way to fix this (honest)
5003 * is to move the gap to the next newline (or the end of the buffer).
5004 * Thus this change.
5006 * Yech!
5008 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5009 move_gap (find_next_newline (GPT, 1));
5010 #else
5011 /* Whether VMS or not, we must move the gap to the next of newline
5012 when we must put designation sequences at beginning of line. */
5013 if (INTEGERP (start)
5014 && coding.type == coding_type_iso2022
5015 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5016 && GPT > BEG && GPT_ADDR[-1] != '\n')
5018 int opoint = PT, opoint_byte = PT_BYTE;
5019 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5020 move_gap_both (PT, PT_BYTE);
5021 SET_PT_BOTH (opoint, opoint_byte);
5023 #endif
5025 failure = 0;
5026 immediate_quit = 1;
5028 if (STRINGP (start))
5030 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5031 &annotations, &coding);
5032 save_errno = errno;
5034 else if (XINT (start) != XINT (end))
5036 tem = CHAR_TO_BYTE (XINT (start));
5038 if (XINT (start) < GPT)
5040 failure = 0 > a_write (desc, Qnil, XINT (start),
5041 min (GPT, XINT (end)) - XINT (start),
5042 &annotations, &coding);
5043 save_errno = errno;
5046 if (XINT (end) > GPT && !failure)
5048 tem = max (XINT (start), GPT);
5049 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5050 &annotations, &coding);
5051 save_errno = errno;
5054 else
5056 /* If file was empty, still need to write the annotations */
5057 coding.mode |= CODING_MODE_LAST_BLOCK;
5058 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5059 save_errno = errno;
5062 if (CODING_REQUIRE_FLUSHING (&coding)
5063 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5064 && ! failure)
5066 /* We have to flush out a data. */
5067 coding.mode |= CODING_MODE_LAST_BLOCK;
5068 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5069 save_errno = errno;
5072 immediate_quit = 0;
5074 #ifdef HAVE_FSYNC
5075 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5076 Disk full in NFS may be reported here. */
5077 /* mib says that closing the file will try to write as fast as NFS can do
5078 it, and that means the fsync here is not crucial for autosave files. */
5079 if (!auto_saving && fsync (desc) < 0)
5081 /* If fsync fails with EINTR, don't treat that as serious. */
5082 if (errno != EINTR)
5083 failure = 1, save_errno = errno;
5085 #endif
5087 /* Spurious "file has changed on disk" warnings have been
5088 observed on Suns as well.
5089 It seems that `close' can change the modtime, under nfs.
5091 (This has supposedly been fixed in Sunos 4,
5092 but who knows about all the other machines with NFS?) */
5093 #if 0
5095 /* On VMS and APOLLO, must do the stat after the close
5096 since closing changes the modtime. */
5097 #ifndef VMS
5098 #ifndef APOLLO
5099 /* Recall that #if defined does not work on VMS. */
5100 #define FOO
5101 fstat (desc, &st);
5102 #endif
5103 #endif
5104 #endif
5106 /* NFS can report a write failure now. */
5107 if (emacs_close (desc) < 0)
5108 failure = 1, save_errno = errno;
5110 #ifdef VMS
5111 /* If we wrote to a temporary name and had no errors, rename to real name. */
5112 if (fname)
5114 if (!failure)
5115 failure = (rename (fn, fname) != 0), save_errno = errno;
5116 fn = fname;
5118 #endif /* VMS */
5120 #ifndef FOO
5121 stat (fn, &st);
5122 #endif
5123 /* Discard the unwind protect for close_file_unwind. */
5124 specpdl_ptr = specpdl + count1;
5125 /* Restore the original current buffer. */
5126 visit_file = unbind_to (count, visit_file);
5128 #ifdef CLASH_DETECTION
5129 if (!auto_saving)
5130 unlock_file (lockname);
5131 #endif /* CLASH_DETECTION */
5133 /* Do this before reporting IO error
5134 to avoid a "file has changed on disk" warning on
5135 next attempt to save. */
5136 if (visiting)
5137 current_buffer->modtime = st.st_mtime;
5139 if (failure)
5140 error ("IO error writing %s: %s", SDATA (filename),
5141 emacs_strerror (save_errno));
5143 if (visiting)
5145 SAVE_MODIFF = MODIFF;
5146 XSETFASTINT (current_buffer->save_length, Z - BEG);
5147 current_buffer->filename = visit_file;
5148 update_mode_lines++;
5150 else if (quietly)
5151 return Qnil;
5153 if (!auto_saving)
5154 message_with_string ("Wrote %s", visit_file, 1);
5156 return Qnil;
5159 Lisp_Object merge ();
5161 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5162 doc: /* Return t if (car A) is numerically less than (car B). */)
5163 (a, b)
5164 Lisp_Object a, b;
5166 return Flss (Fcar (a), Fcar (b));
5169 /* Build the complete list of annotations appropriate for writing out
5170 the text between START and END, by calling all the functions in
5171 write-region-annotate-functions and merging the lists they return.
5172 If one of these functions switches to a different buffer, we assume
5173 that buffer contains altered text. Therefore, the caller must
5174 make sure to restore the current buffer in all cases,
5175 as save-excursion would do. */
5177 static Lisp_Object
5178 build_annotations (start, end)
5179 Lisp_Object start, end;
5181 Lisp_Object annotations;
5182 Lisp_Object p, res;
5183 struct gcpro gcpro1, gcpro2;
5184 Lisp_Object original_buffer;
5185 int i;
5187 XSETBUFFER (original_buffer, current_buffer);
5189 annotations = Qnil;
5190 p = Vwrite_region_annotate_functions;
5191 GCPRO2 (annotations, p);
5192 while (CONSP (p))
5194 struct buffer *given_buffer = current_buffer;
5195 Vwrite_region_annotations_so_far = annotations;
5196 res = call2 (XCAR (p), start, end);
5197 /* If the function makes a different buffer current,
5198 assume that means this buffer contains altered text to be output.
5199 Reset START and END from the buffer bounds
5200 and discard all previous annotations because they should have
5201 been dealt with by this function. */
5202 if (current_buffer != given_buffer)
5204 XSETFASTINT (start, BEGV);
5205 XSETFASTINT (end, ZV);
5206 annotations = Qnil;
5208 Flength (res); /* Check basic validity of return value */
5209 annotations = merge (annotations, res, Qcar_less_than_car);
5210 p = XCDR (p);
5213 /* Now do the same for annotation functions implied by the file-format */
5214 if (auto_saving && (!EQ (Vauto_save_file_format, Qt)))
5215 p = Vauto_save_file_format;
5216 else
5217 p = current_buffer->file_format;
5218 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5220 struct buffer *given_buffer = current_buffer;
5222 Vwrite_region_annotations_so_far = annotations;
5224 /* Value is either a list of annotations or nil if the function
5225 has written annotations to a temporary buffer, which is now
5226 current. */
5227 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5228 original_buffer, make_number (i));
5229 if (current_buffer != given_buffer)
5231 XSETFASTINT (start, BEGV);
5232 XSETFASTINT (end, ZV);
5233 annotations = Qnil;
5236 if (CONSP (res))
5237 annotations = merge (annotations, res, Qcar_less_than_car);
5240 UNGCPRO;
5241 return annotations;
5244 static Lisp_Object
5245 build_annotations_2 (start, end, pre_write_conversion, annotations)
5246 Lisp_Object start, end, pre_write_conversion, annotations;
5248 struct gcpro gcpro1;
5249 Lisp_Object res;
5251 GCPRO1 (annotations);
5252 /* At last, do the same for the function PRE_WRITE_CONVERSION
5253 implied by the current coding-system. */
5254 if (!NILP (pre_write_conversion))
5256 struct buffer *given_buffer = current_buffer;
5257 Vwrite_region_annotations_so_far = annotations;
5258 res = call2 (pre_write_conversion, start, end);
5259 Flength (res);
5260 annotations = (current_buffer != given_buffer
5261 ? res
5262 : merge (annotations, res, Qcar_less_than_car));
5265 UNGCPRO;
5266 return annotations;
5269 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5270 If STRING is nil, POS is the character position in the current buffer.
5271 Intersperse with them the annotations from *ANNOT
5272 which fall within the range of POS to POS + NCHARS,
5273 each at its appropriate position.
5275 We modify *ANNOT by discarding elements as we use them up.
5277 The return value is negative in case of system call failure. */
5279 static int
5280 a_write (desc, string, pos, nchars, annot, coding)
5281 int desc;
5282 Lisp_Object string;
5283 register int nchars;
5284 int pos;
5285 Lisp_Object *annot;
5286 struct coding_system *coding;
5288 Lisp_Object tem;
5289 int nextpos;
5290 int lastpos = pos + nchars;
5292 while (NILP (*annot) || CONSP (*annot))
5294 tem = Fcar_safe (Fcar (*annot));
5295 nextpos = pos - 1;
5296 if (INTEGERP (tem))
5297 nextpos = XFASTINT (tem);
5299 /* If there are no more annotations in this range,
5300 output the rest of the range all at once. */
5301 if (! (nextpos >= pos && nextpos <= lastpos))
5302 return e_write (desc, string, pos, lastpos, coding);
5304 /* Output buffer text up to the next annotation's position. */
5305 if (nextpos > pos)
5307 if (0 > e_write (desc, string, pos, nextpos, coding))
5308 return -1;
5309 pos = nextpos;
5311 /* Output the annotation. */
5312 tem = Fcdr (Fcar (*annot));
5313 if (STRINGP (tem))
5315 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5316 return -1;
5318 *annot = Fcdr (*annot);
5320 return 0;
5323 #ifndef WRITE_BUF_SIZE
5324 #define WRITE_BUF_SIZE (16 * 1024)
5325 #endif
5327 /* Write text in the range START and END into descriptor DESC,
5328 encoding them with coding system CODING. If STRING is nil, START
5329 and END are character positions of the current buffer, else they
5330 are indexes to the string STRING. */
5332 static int
5333 e_write (desc, string, start, end, coding)
5334 int desc;
5335 Lisp_Object string;
5336 int start, end;
5337 struct coding_system *coding;
5339 register char *addr;
5340 register int nbytes;
5341 char buf[WRITE_BUF_SIZE];
5342 int return_val = 0;
5344 if (start >= end)
5345 coding->composing = COMPOSITION_DISABLED;
5346 if (coding->composing != COMPOSITION_DISABLED)
5347 coding_save_composition (coding, start, end, string);
5349 if (STRINGP (string))
5351 addr = SDATA (string);
5352 nbytes = SBYTES (string);
5353 coding->src_multibyte = STRING_MULTIBYTE (string);
5355 else if (start < end)
5357 /* It is assured that the gap is not in the range START and END-1. */
5358 addr = CHAR_POS_ADDR (start);
5359 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5360 coding->src_multibyte
5361 = !NILP (current_buffer->enable_multibyte_characters);
5363 else
5365 addr = "";
5366 nbytes = 0;
5367 coding->src_multibyte = 1;
5370 /* We used to have a code for handling selective display here. But,
5371 now it is handled within encode_coding. */
5372 while (1)
5374 int result;
5376 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5377 if (coding->produced > 0)
5379 coding->produced -= emacs_write (desc, buf, coding->produced);
5380 if (coding->produced)
5382 return_val = -1;
5383 break;
5386 nbytes -= coding->consumed;
5387 addr += coding->consumed;
5388 if (result == CODING_FINISH_INSUFFICIENT_SRC
5389 && nbytes > 0)
5391 /* The source text ends by an incomplete multibyte form.
5392 There's no way other than write it out as is. */
5393 nbytes -= emacs_write (desc, addr, nbytes);
5394 if (nbytes)
5396 return_val = -1;
5397 break;
5400 if (nbytes <= 0)
5401 break;
5402 start += coding->consumed_char;
5403 if (coding->cmp_data)
5404 coding_adjust_composition_offset (coding, start);
5407 if (coding->cmp_data)
5408 coding_free_composition_data (coding);
5410 return return_val;
5413 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5414 Sverify_visited_file_modtime, 1, 1, 0,
5415 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5416 This means that the file has not been changed since it was visited or saved. */)
5417 (buf)
5418 Lisp_Object buf;
5420 struct buffer *b;
5421 struct stat st;
5422 Lisp_Object handler;
5423 Lisp_Object filename;
5425 CHECK_BUFFER (buf);
5426 b = XBUFFER (buf);
5428 if (!STRINGP (b->filename)) return Qt;
5429 if (b->modtime == 0) return Qt;
5431 /* If the file name has special constructs in it,
5432 call the corresponding file handler. */
5433 handler = Ffind_file_name_handler (b->filename,
5434 Qverify_visited_file_modtime);
5435 if (!NILP (handler))
5436 return call2 (handler, Qverify_visited_file_modtime, buf);
5438 filename = ENCODE_FILE (b->filename);
5440 if (stat (SDATA (filename), &st) < 0)
5442 /* If the file doesn't exist now and didn't exist before,
5443 we say that it isn't modified, provided the error is a tame one. */
5444 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5445 st.st_mtime = -1;
5446 else
5447 st.st_mtime = 0;
5449 if (st.st_mtime == b->modtime
5450 /* If both are positive, accept them if they are off by one second. */
5451 || (st.st_mtime > 0 && b->modtime > 0
5452 && (st.st_mtime == b->modtime + 1
5453 || st.st_mtime == b->modtime - 1)))
5454 return Qt;
5455 return Qnil;
5458 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5459 Sclear_visited_file_modtime, 0, 0, 0,
5460 doc: /* Clear out records of last mod time of visited file.
5461 Next attempt to save will certainly not complain of a discrepancy. */)
5464 current_buffer->modtime = 0;
5465 return Qnil;
5468 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5469 Svisited_file_modtime, 0, 0, 0,
5470 doc: /* Return the current buffer's recorded visited file modification time.
5471 The value is a list of the form (HIGH . LOW), like the time values
5472 that `file-attributes' returns. */)
5475 return long_to_cons ((unsigned long) current_buffer->modtime);
5478 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5479 Sset_visited_file_modtime, 0, 1, 0,
5480 doc: /* Update buffer's recorded modification time from the visited file's time.
5481 Useful if the buffer was not read from the file normally
5482 or if the file itself has been changed for some known benign reason.
5483 An argument specifies the modification time value to use
5484 \(instead of that of the visited file), in the form of a list
5485 \(HIGH . LOW) or (HIGH LOW). */)
5486 (time_list)
5487 Lisp_Object time_list;
5489 if (!NILP (time_list))
5490 current_buffer->modtime = cons_to_long (time_list);
5491 else
5493 register Lisp_Object filename;
5494 struct stat st;
5495 Lisp_Object handler;
5497 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5499 /* If the file name has special constructs in it,
5500 call the corresponding file handler. */
5501 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5502 if (!NILP (handler))
5503 /* The handler can find the file name the same way we did. */
5504 return call2 (handler, Qset_visited_file_modtime, Qnil);
5506 filename = ENCODE_FILE (filename);
5508 if (stat (SDATA (filename), &st) >= 0)
5509 current_buffer->modtime = st.st_mtime;
5512 return Qnil;
5515 Lisp_Object
5516 auto_save_error (error)
5517 Lisp_Object error;
5519 Lisp_Object args[3], msg;
5520 int i, nbytes;
5521 struct gcpro gcpro1;
5523 ring_bell ();
5525 args[0] = build_string ("Auto-saving %s: %s");
5526 args[1] = current_buffer->name;
5527 args[2] = Ferror_message_string (error);
5528 msg = Fformat (3, args);
5529 GCPRO1 (msg);
5530 nbytes = SBYTES (msg);
5532 for (i = 0; i < 3; ++i)
5534 if (i == 0)
5535 message2 (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5536 else
5537 message2_nolog (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5538 Fsleep_for (make_number (1), Qnil);
5541 UNGCPRO;
5542 return Qnil;
5545 Lisp_Object
5546 auto_save_1 ()
5548 struct stat st;
5550 /* Get visited file's mode to become the auto save file's mode. */
5551 if (! NILP (current_buffer->filename)
5552 && stat (SDATA (current_buffer->filename), &st) >= 0)
5553 /* But make sure we can overwrite it later! */
5554 auto_save_mode_bits = st.st_mode | 0600;
5555 else
5556 auto_save_mode_bits = 0666;
5558 return
5559 Fwrite_region (Qnil, Qnil,
5560 current_buffer->auto_save_file_name,
5561 Qnil, Qlambda, Qnil, Qnil);
5564 static Lisp_Object
5565 do_auto_save_unwind (stream) /* used as unwind-protect function */
5566 Lisp_Object stream;
5568 auto_saving = 0;
5569 if (!NILP (stream))
5570 fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
5571 | XFASTINT (XCDR (stream))));
5572 return Qnil;
5575 static Lisp_Object
5576 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5577 Lisp_Object value;
5579 minibuffer_auto_raise = XINT (value);
5580 return Qnil;
5583 static Lisp_Object
5584 do_auto_save_make_dir (dir)
5585 Lisp_Object dir;
5587 return call2 (Qmake_directory, dir, Qt);
5590 static Lisp_Object
5591 do_auto_save_eh (ignore)
5592 Lisp_Object ignore;
5594 return Qnil;
5597 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5598 doc: /* Auto-save all buffers that need it.
5599 This is all buffers that have auto-saving enabled
5600 and are changed since last auto-saved.
5601 Auto-saving writes the buffer into a file
5602 so that your editing is not lost if the system crashes.
5603 This file is not the file you visited; that changes only when you save.
5604 Normally we run the normal hook `auto-save-hook' before saving.
5606 A non-nil NO-MESSAGE argument means do not print any message if successful.
5607 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5608 (no_message, current_only)
5609 Lisp_Object no_message, current_only;
5611 struct buffer *old = current_buffer, *b;
5612 Lisp_Object tail, buf;
5613 int auto_saved = 0;
5614 int do_handled_files;
5615 Lisp_Object oquit;
5616 FILE *stream;
5617 Lisp_Object lispstream;
5618 int count = SPECPDL_INDEX ();
5619 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5620 int old_message_p = 0;
5621 struct gcpro gcpro1, gcpro2;
5623 if (max_specpdl_size < specpdl_size + 40)
5624 max_specpdl_size = specpdl_size + 40;
5626 if (minibuf_level)
5627 no_message = Qt;
5629 if (NILP (no_message))
5631 old_message_p = push_message ();
5632 record_unwind_protect (pop_message_unwind, Qnil);
5635 /* Ordinarily don't quit within this function,
5636 but don't make it impossible to quit (in case we get hung in I/O). */
5637 oquit = Vquit_flag;
5638 Vquit_flag = Qnil;
5640 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5641 point to non-strings reached from Vbuffer_alist. */
5643 if (!NILP (Vrun_hooks))
5644 call1 (Vrun_hooks, intern ("auto-save-hook"));
5646 if (STRINGP (Vauto_save_list_file_name))
5648 Lisp_Object listfile;
5650 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5652 /* Don't try to create the directory when shutting down Emacs,
5653 because creating the directory might signal an error, and
5654 that would leave Emacs in a strange state. */
5655 if (!NILP (Vrun_hooks))
5657 Lisp_Object dir;
5658 dir = Qnil;
5659 GCPRO2 (dir, listfile);
5660 dir = Ffile_name_directory (listfile);
5661 if (NILP (Ffile_directory_p (dir)))
5662 internal_condition_case_1 (do_auto_save_make_dir,
5663 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5664 do_auto_save_eh);
5665 UNGCPRO;
5668 stream = fopen (SDATA (listfile), "w");
5669 if (stream != NULL)
5671 /* Arrange to close that file whether or not we get an error.
5672 Also reset auto_saving to 0. */
5673 lispstream = Fcons (Qnil, Qnil);
5674 XSETCARFASTINT (lispstream, (EMACS_UINT)stream >> 16);
5675 XSETCDRFASTINT (lispstream, (EMACS_UINT)stream & 0xffff);
5677 else
5678 lispstream = Qnil;
5680 else
5682 stream = NULL;
5683 lispstream = Qnil;
5686 record_unwind_protect (do_auto_save_unwind, lispstream);
5687 record_unwind_protect (do_auto_save_unwind_1,
5688 make_number (minibuffer_auto_raise));
5689 minibuffer_auto_raise = 0;
5690 auto_saving = 1;
5692 /* First, save all files which don't have handlers. If Emacs is
5693 crashing, the handlers may tweak what is causing Emacs to crash
5694 in the first place, and it would be a shame if Emacs failed to
5695 autosave perfectly ordinary files because it couldn't handle some
5696 ange-ftp'd file. */
5697 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5698 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5700 buf = XCDR (XCAR (tail));
5701 b = XBUFFER (buf);
5703 /* Record all the buffers that have auto save mode
5704 in the special file that lists them. For each of these buffers,
5705 Record visited name (if any) and auto save name. */
5706 if (STRINGP (b->auto_save_file_name)
5707 && stream != NULL && do_handled_files == 0)
5709 if (!NILP (b->filename))
5711 fwrite (SDATA (b->filename), 1,
5712 SBYTES (b->filename), stream);
5714 putc ('\n', stream);
5715 fwrite (SDATA (b->auto_save_file_name), 1,
5716 SBYTES (b->auto_save_file_name), stream);
5717 putc ('\n', stream);
5720 if (!NILP (current_only)
5721 && b != current_buffer)
5722 continue;
5724 /* Don't auto-save indirect buffers.
5725 The base buffer takes care of it. */
5726 if (b->base_buffer)
5727 continue;
5729 /* Check for auto save enabled
5730 and file changed since last auto save
5731 and file changed since last real save. */
5732 if (STRINGP (b->auto_save_file_name)
5733 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5734 && b->auto_save_modified < BUF_MODIFF (b)
5735 /* -1 means we've turned off autosaving for a while--see below. */
5736 && XINT (b->save_length) >= 0
5737 && (do_handled_files
5738 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5739 Qwrite_region))))
5741 EMACS_TIME before_time, after_time;
5743 EMACS_GET_TIME (before_time);
5745 /* If we had a failure, don't try again for 20 minutes. */
5746 if (b->auto_save_failure_time >= 0
5747 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5748 continue;
5750 if ((XFASTINT (b->save_length) * 10
5751 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5752 /* A short file is likely to change a large fraction;
5753 spare the user annoying messages. */
5754 && XFASTINT (b->save_length) > 5000
5755 /* These messages are frequent and annoying for `*mail*'. */
5756 && !EQ (b->filename, Qnil)
5757 && NILP (no_message))
5759 /* It has shrunk too much; turn off auto-saving here. */
5760 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5761 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5762 b->name, 1);
5763 minibuffer_auto_raise = 0;
5764 /* Turn off auto-saving until there's a real save,
5765 and prevent any more warnings. */
5766 XSETINT (b->save_length, -1);
5767 Fsleep_for (make_number (1), Qnil);
5768 continue;
5770 set_buffer_internal (b);
5771 if (!auto_saved && NILP (no_message))
5772 message1 ("Auto-saving...");
5773 internal_condition_case (auto_save_1, Qt, auto_save_error);
5774 auto_saved++;
5775 b->auto_save_modified = BUF_MODIFF (b);
5776 XSETFASTINT (current_buffer->save_length, Z - BEG);
5777 set_buffer_internal (old);
5779 EMACS_GET_TIME (after_time);
5781 /* If auto-save took more than 60 seconds,
5782 assume it was an NFS failure that got a timeout. */
5783 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5784 b->auto_save_failure_time = EMACS_SECS (after_time);
5788 /* Prevent another auto save till enough input events come in. */
5789 record_auto_save ();
5791 if (auto_saved && NILP (no_message))
5793 if (old_message_p)
5795 /* If we are going to restore an old message,
5796 give time to read ours. */
5797 sit_for (1, 0, 0, 0, 0);
5798 restore_message ();
5800 else
5801 /* If we displayed a message and then restored a state
5802 with no message, leave a "done" message on the screen. */
5803 message1 ("Auto-saving...done");
5806 Vquit_flag = oquit;
5808 /* This restores the message-stack status. */
5809 unbind_to (count, Qnil);
5810 return Qnil;
5813 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
5814 Sset_buffer_auto_saved, 0, 0, 0,
5815 doc: /* Mark current buffer as auto-saved with its current text.
5816 No auto-save file will be written until the buffer changes again. */)
5819 current_buffer->auto_save_modified = MODIFF;
5820 XSETFASTINT (current_buffer->save_length, Z - BEG);
5821 current_buffer->auto_save_failure_time = -1;
5822 return Qnil;
5825 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
5826 Sclear_buffer_auto_save_failure, 0, 0, 0,
5827 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
5830 current_buffer->auto_save_failure_time = -1;
5831 return Qnil;
5834 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
5835 0, 0, 0,
5836 doc: /* Return t if buffer has been auto-saved since last read in or saved. */)
5839 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
5842 /* Reading and completing file names */
5843 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
5845 /* In the string VAL, change each $ to $$ and return the result. */
5847 static Lisp_Object
5848 double_dollars (val)
5849 Lisp_Object val;
5851 register const unsigned char *old;
5852 register unsigned char *new;
5853 register int n;
5854 int osize, count;
5856 osize = SBYTES (val);
5858 /* Count the number of $ characters. */
5859 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
5860 if (*old++ == '$') count++;
5861 if (count > 0)
5863 old = SDATA (val);
5864 val = make_uninit_multibyte_string (SCHARS (val) + count,
5865 osize + count);
5866 new = SDATA (val);
5867 for (n = osize; n > 0; n--)
5868 if (*old != '$')
5869 *new++ = *old++;
5870 else
5872 *new++ = '$';
5873 *new++ = '$';
5874 old++;
5877 return val;
5880 static Lisp_Object
5881 read_file_name_cleanup (arg)
5882 Lisp_Object arg;
5884 return (current_buffer->directory = arg);
5887 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
5888 3, 3, 0,
5889 doc: /* Internal subroutine for read-file-name. Do not call this. */)
5890 (string, dir, action)
5891 Lisp_Object string, dir, action;
5892 /* action is nil for complete, t for return list of completions,
5893 lambda for verify final value */
5895 Lisp_Object name, specdir, realdir, val, orig_string;
5896 int changed;
5897 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5899 CHECK_STRING (string);
5901 realdir = dir;
5902 name = string;
5903 orig_string = Qnil;
5904 specdir = Qnil;
5905 changed = 0;
5906 /* No need to protect ACTION--we only compare it with t and nil. */
5907 GCPRO5 (string, realdir, name, specdir, orig_string);
5909 if (SCHARS (string) == 0)
5911 if (EQ (action, Qlambda))
5913 UNGCPRO;
5914 return Qnil;
5917 else
5919 orig_string = string;
5920 string = Fsubstitute_in_file_name (string);
5921 changed = NILP (Fstring_equal (string, orig_string));
5922 name = Ffile_name_nondirectory (string);
5923 val = Ffile_name_directory (string);
5924 if (! NILP (val))
5925 realdir = Fexpand_file_name (val, realdir);
5928 if (NILP (action))
5930 specdir = Ffile_name_directory (string);
5931 val = Ffile_name_completion (name, realdir);
5932 UNGCPRO;
5933 if (!STRINGP (val))
5935 if (changed)
5936 return double_dollars (string);
5937 return val;
5940 if (!NILP (specdir))
5941 val = concat2 (specdir, val);
5942 #ifndef VMS
5943 return double_dollars (val);
5944 #else /* not VMS */
5945 return val;
5946 #endif /* not VMS */
5948 UNGCPRO;
5950 if (EQ (action, Qt))
5952 Lisp_Object all = Ffile_name_all_completions (name, realdir);
5953 Lisp_Object comp;
5954 int count;
5956 if (NILP (Vread_file_name_predicate)
5957 || EQ (Vread_file_name_predicate, Qfile_exists_p))
5958 return all;
5960 #ifndef VMS
5961 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
5963 /* Brute-force speed up for directory checking:
5964 Discard strings which don't end in a slash. */
5965 for (comp = Qnil; CONSP (all); all = XCDR (all))
5967 Lisp_Object tem = XCAR (all);
5968 int len;
5969 if (STRINGP (tem) &&
5970 (len = SCHARS (tem), len > 0) &&
5971 IS_DIRECTORY_SEP (SREF (tem, len-1)))
5972 comp = Fcons (tem, comp);
5975 else
5976 #endif
5978 /* Must do it the hard (and slow) way. */
5979 GCPRO3 (all, comp, specdir);
5980 count = SPECPDL_INDEX ();
5981 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
5982 current_buffer->directory = realdir;
5983 for (comp = Qnil; CONSP (all); all = XCDR (all))
5984 if (!NILP (call1 (Vread_file_name_predicate, XCAR (all))))
5985 comp = Fcons (XCAR (all), comp);
5986 unbind_to (count, Qnil);
5987 UNGCPRO;
5989 return Fnreverse (comp);
5992 /* Only other case actually used is ACTION = lambda */
5993 #ifdef VMS
5994 /* Supposedly this helps commands such as `cd' that read directory names,
5995 but can someone explain how it helps them? -- RMS */
5996 if (SCHARS (name) == 0)
5997 return Qt;
5998 #endif /* VMS */
5999 if (!NILP (Vread_file_name_predicate))
6000 return call1 (Vread_file_name_predicate, string);
6001 return Ffile_exists_p (string);
6004 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6005 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6006 Value is not expanded---you must call `expand-file-name' yourself.
6007 Default name to DEFAULT-FILENAME if user enters a null string.
6008 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6009 except that if INITIAL is specified, that combined with DIR is used.)
6010 Fourth arg MUSTMATCH non-nil means require existing file's name.
6011 Non-nil and non-t means also require confirmation after completion.
6012 Fifth arg INITIAL specifies text to start with.
6013 If optional sixth arg PREDICATE is non-nil, possible completions and the
6014 resulting file name must satisfy (funcall PREDICATE NAME).
6015 DIR defaults to current buffer's directory default.
6017 If this command was invoked with the mouse, use a file dialog box if
6018 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6019 provides a file dialog box. */)
6020 (prompt, dir, default_filename, mustmatch, initial, predicate)
6021 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6023 Lisp_Object val, insdef, tem;
6024 struct gcpro gcpro1, gcpro2;
6025 register char *homedir;
6026 int replace_in_history = 0;
6027 int add_to_history = 0;
6028 int count;
6030 if (NILP (dir))
6031 dir = current_buffer->directory;
6032 if (NILP (default_filename))
6033 default_filename = !NILP (initial)
6034 ? Fexpand_file_name (initial, dir)
6035 : current_buffer->filename;
6037 /* If dir starts with user's homedir, change that to ~. */
6038 homedir = (char *) egetenv ("HOME");
6039 #ifdef DOS_NT
6040 /* homedir can be NULL in temacs, since Vprocess_environment is not
6041 yet set up. We shouldn't crash in that case. */
6042 if (homedir != 0)
6044 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6045 CORRECT_DIR_SEPS (homedir);
6047 #endif
6048 if (homedir != 0
6049 && STRINGP (dir)
6050 && !strncmp (homedir, SDATA (dir), strlen (homedir))
6051 && IS_DIRECTORY_SEP (SREF (dir, strlen (homedir))))
6053 dir = make_string (SDATA (dir) + strlen (homedir) - 1,
6054 SBYTES (dir) - strlen (homedir) + 1);
6055 SSET (dir, 0, '~');
6057 /* Likewise for default_filename. */
6058 if (homedir != 0
6059 && STRINGP (default_filename)
6060 && !strncmp (homedir, SDATA (default_filename), strlen (homedir))
6061 && IS_DIRECTORY_SEP (SREF (default_filename, strlen (homedir))))
6063 default_filename
6064 = make_string (SDATA (default_filename) + strlen (homedir) - 1,
6065 SBYTES (default_filename) - strlen (homedir) + 1);
6066 SSET (default_filename, 0, '~');
6068 if (!NILP (default_filename))
6070 CHECK_STRING (default_filename);
6071 default_filename = double_dollars (default_filename);
6074 if (insert_default_directory && STRINGP (dir))
6076 insdef = dir;
6077 if (!NILP (initial))
6079 Lisp_Object args[2], pos;
6081 args[0] = insdef;
6082 args[1] = initial;
6083 insdef = Fconcat (2, args);
6084 pos = make_number (SCHARS (double_dollars (dir)));
6085 insdef = Fcons (double_dollars (insdef), pos);
6087 else
6088 insdef = double_dollars (insdef);
6090 else if (STRINGP (initial))
6091 insdef = Fcons (double_dollars (initial), make_number (0));
6092 else
6093 insdef = Qnil;
6095 if (!NILP (Vread_file_name_function))
6097 Lisp_Object args[7];
6099 GCPRO2 (insdef, default_filename);
6100 args[0] = Vread_file_name_function;
6101 args[1] = prompt;
6102 args[2] = dir;
6103 args[3] = default_filename;
6104 args[4] = mustmatch;
6105 args[5] = initial;
6106 args[6] = predicate;
6107 RETURN_UNGCPRO (Ffuncall (7, args));
6110 count = SPECPDL_INDEX ();
6111 #ifdef VMS
6112 specbind (intern ("completion-ignore-case"), Qt);
6113 #endif
6115 specbind (intern ("minibuffer-completing-file-name"), Qt);
6116 specbind (intern ("read-file-name-predicate"),
6117 (NILP (predicate) ? Qfile_exists_p : predicate));
6119 GCPRO2 (insdef, default_filename);
6121 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
6122 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6123 && use_dialog_box
6124 && have_menus_p ())
6126 /* If DIR contains a file name, split it. */
6127 Lisp_Object file;
6128 file = Ffile_name_nondirectory (dir);
6129 if (SCHARS (file) && NILP (default_filename))
6131 default_filename = file;
6132 dir = Ffile_name_directory (dir);
6134 if (!NILP(default_filename))
6135 default_filename = Fexpand_file_name (default_filename, dir);
6136 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch);
6137 add_to_history = 1;
6139 else
6140 #endif
6141 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6142 dir, mustmatch, insdef,
6143 Qfile_name_history, default_filename, Qnil);
6145 tem = Fsymbol_value (Qfile_name_history);
6146 if (CONSP (tem) && EQ (XCAR (tem), val))
6147 replace_in_history = 1;
6149 /* If Fcompleting_read returned the inserted default string itself
6150 (rather than a new string with the same contents),
6151 it has to mean that the user typed RET with the minibuffer empty.
6152 In that case, we really want to return ""
6153 so that commands such as set-visited-file-name can distinguish. */
6154 if (EQ (val, default_filename))
6156 /* In this case, Fcompleting_read has not added an element
6157 to the history. Maybe we should. */
6158 if (! replace_in_history)
6159 add_to_history = 1;
6161 val = empty_string;
6164 unbind_to (count, Qnil);
6165 UNGCPRO;
6166 if (NILP (val))
6167 error ("No file name specified");
6169 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6171 if (!NILP (tem) && !NILP (default_filename))
6172 val = default_filename;
6173 else if (SCHARS (val) == 0 && NILP (insdef))
6175 if (!NILP (default_filename))
6176 val = default_filename;
6177 else
6178 error ("No default file name");
6180 val = Fsubstitute_in_file_name (val);
6182 if (replace_in_history)
6183 /* Replace what Fcompleting_read added to the history
6184 with what we will actually return. */
6185 XSETCAR (Fsymbol_value (Qfile_name_history), double_dollars (val));
6186 else if (add_to_history)
6188 /* Add the value to the history--but not if it matches
6189 the last value already there. */
6190 Lisp_Object val1 = double_dollars (val);
6191 tem = Fsymbol_value (Qfile_name_history);
6192 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6193 Fset (Qfile_name_history,
6194 Fcons (val1, tem));
6197 return val;
6201 void
6202 init_fileio_once ()
6204 /* Must be set before any path manipulation is performed. */
6205 XSETFASTINT (Vdirectory_sep_char, '/');
6209 void
6210 syms_of_fileio ()
6212 Qexpand_file_name = intern ("expand-file-name");
6213 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6214 Qdirectory_file_name = intern ("directory-file-name");
6215 Qfile_name_directory = intern ("file-name-directory");
6216 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6217 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6218 Qfile_name_as_directory = intern ("file-name-as-directory");
6219 Qcopy_file = intern ("copy-file");
6220 Qmake_directory_internal = intern ("make-directory-internal");
6221 Qmake_directory = intern ("make-directory");
6222 Qdelete_directory = intern ("delete-directory");
6223 Qdelete_file = intern ("delete-file");
6224 Qrename_file = intern ("rename-file");
6225 Qadd_name_to_file = intern ("add-name-to-file");
6226 Qmake_symbolic_link = intern ("make-symbolic-link");
6227 Qfile_exists_p = intern ("file-exists-p");
6228 Qfile_executable_p = intern ("file-executable-p");
6229 Qfile_readable_p = intern ("file-readable-p");
6230 Qfile_writable_p = intern ("file-writable-p");
6231 Qfile_symlink_p = intern ("file-symlink-p");
6232 Qaccess_file = intern ("access-file");
6233 Qfile_directory_p = intern ("file-directory-p");
6234 Qfile_regular_p = intern ("file-regular-p");
6235 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6236 Qfile_modes = intern ("file-modes");
6237 Qset_file_modes = intern ("set-file-modes");
6238 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6239 Qinsert_file_contents = intern ("insert-file-contents");
6240 Qwrite_region = intern ("write-region");
6241 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6242 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6244 staticpro (&Qexpand_file_name);
6245 staticpro (&Qsubstitute_in_file_name);
6246 staticpro (&Qdirectory_file_name);
6247 staticpro (&Qfile_name_directory);
6248 staticpro (&Qfile_name_nondirectory);
6249 staticpro (&Qunhandled_file_name_directory);
6250 staticpro (&Qfile_name_as_directory);
6251 staticpro (&Qcopy_file);
6252 staticpro (&Qmake_directory_internal);
6253 staticpro (&Qmake_directory);
6254 staticpro (&Qdelete_directory);
6255 staticpro (&Qdelete_file);
6256 staticpro (&Qrename_file);
6257 staticpro (&Qadd_name_to_file);
6258 staticpro (&Qmake_symbolic_link);
6259 staticpro (&Qfile_exists_p);
6260 staticpro (&Qfile_executable_p);
6261 staticpro (&Qfile_readable_p);
6262 staticpro (&Qfile_writable_p);
6263 staticpro (&Qaccess_file);
6264 staticpro (&Qfile_symlink_p);
6265 staticpro (&Qfile_directory_p);
6266 staticpro (&Qfile_regular_p);
6267 staticpro (&Qfile_accessible_directory_p);
6268 staticpro (&Qfile_modes);
6269 staticpro (&Qset_file_modes);
6270 staticpro (&Qfile_newer_than_file_p);
6271 staticpro (&Qinsert_file_contents);
6272 staticpro (&Qwrite_region);
6273 staticpro (&Qverify_visited_file_modtime);
6274 staticpro (&Qset_visited_file_modtime);
6276 Qfile_name_history = intern ("file-name-history");
6277 Fset (Qfile_name_history, Qnil);
6278 staticpro (&Qfile_name_history);
6280 Qfile_error = intern ("file-error");
6281 staticpro (&Qfile_error);
6282 Qfile_already_exists = intern ("file-already-exists");
6283 staticpro (&Qfile_already_exists);
6284 Qfile_date_error = intern ("file-date-error");
6285 staticpro (&Qfile_date_error);
6286 Qexcl = intern ("excl");
6287 staticpro (&Qexcl);
6289 #ifdef DOS_NT
6290 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6291 staticpro (&Qfind_buffer_file_type);
6292 #endif /* DOS_NT */
6294 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6295 doc: /* *Coding system for encoding file names.
6296 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6297 Vfile_name_coding_system = Qnil;
6299 DEFVAR_LISP ("default-file-name-coding-system",
6300 &Vdefault_file_name_coding_system,
6301 doc: /* Default coding system for encoding file names.
6302 This variable is used only when `file-name-coding-system' is nil.
6304 This variable is set/changed by the command `set-language-environment'.
6305 User should not set this variable manually,
6306 instead use `file-name-coding-system' to get a constant encoding
6307 of file names regardless of the current language environment. */);
6308 Vdefault_file_name_coding_system = Qnil;
6310 DEFVAR_LISP ("auto-save-file-format", &Vauto_save_file_format,
6311 doc: /* *Format in which to write auto-save files.
6312 Should be a list of symbols naming formats that are defined in `format-alist'.
6313 If it is t, which is the default, auto-save files are written in the
6314 same format as a regular save would use. */);
6315 Vauto_save_file_format = Qt;
6317 Qformat_decode = intern ("format-decode");
6318 staticpro (&Qformat_decode);
6319 Qformat_annotate_function = intern ("format-annotate-function");
6320 staticpro (&Qformat_annotate_function);
6322 Qcar_less_than_car = intern ("car-less-than-car");
6323 staticpro (&Qcar_less_than_car);
6325 Fput (Qfile_error, Qerror_conditions,
6326 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
6327 Fput (Qfile_error, Qerror_message,
6328 build_string ("File error"));
6330 Fput (Qfile_already_exists, Qerror_conditions,
6331 Fcons (Qfile_already_exists,
6332 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6333 Fput (Qfile_already_exists, Qerror_message,
6334 build_string ("File already exists"));
6336 Fput (Qfile_date_error, Qerror_conditions,
6337 Fcons (Qfile_date_error,
6338 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6339 Fput (Qfile_date_error, Qerror_message,
6340 build_string ("Cannot set file date"));
6342 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6343 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6344 Vread_file_name_function = Qnil;
6346 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6347 doc: /* Current predicate used by `read-file-name-internal'. */);
6348 Vread_file_name_predicate = Qnil;
6350 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6351 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer. */);
6352 insert_default_directory = 1;
6354 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6355 doc: /* *Non-nil means write new files with record format `stmlf'.
6356 nil means use format `var'. This variable is meaningful only on VMS. */);
6357 vms_stmlf_recfm = 0;
6359 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6360 doc: /* Directory separator character for built-in functions that return file names.
6361 The value is always ?/. Don't use this variable, just use `/'. */);
6363 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6364 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6365 If a file name matches REGEXP, then all I/O on that file is done by calling
6366 HANDLER.
6368 The first argument given to HANDLER is the name of the I/O primitive
6369 to be handled; the remaining arguments are the arguments that were
6370 passed to that primitive. For example, if you do
6371 (file-exists-p FILENAME)
6372 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6373 (funcall HANDLER 'file-exists-p FILENAME)
6374 The function `find-file-name-handler' checks this list for a handler
6375 for its argument. */);
6376 Vfile_name_handler_alist = Qnil;
6378 DEFVAR_LISP ("set-auto-coding-function",
6379 &Vset_auto_coding_function,
6380 doc: /* If non-nil, a function to call to decide a coding system of file.
6381 Two arguments are passed to this function: the file name
6382 and the length of a file contents following the point.
6383 This function should return a coding system to decode the file contents.
6384 It should check the file name against `auto-coding-alist'.
6385 If no coding system is decided, it should check a coding system
6386 specified in the heading lines with the format:
6387 -*- ... coding: CODING-SYSTEM; ... -*-
6388 or local variable spec of the tailing lines with `coding:' tag. */);
6389 Vset_auto_coding_function = Qnil;
6391 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6392 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6393 Each is passed one argument, the number of bytes inserted. It should return
6394 the new byte count, and leave point the same. If `insert-file-contents' is
6395 intercepted by a handler from `file-name-handler-alist', that handler is
6396 responsible for calling the after-insert-file-functions if appropriate. */);
6397 Vafter_insert_file_functions = Qnil;
6399 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6400 doc: /* A list of functions to be called at the start of `write-region'.
6401 Each is passed two arguments, START and END as for `write-region'.
6402 These are usually two numbers but not always; see the documentation
6403 for `write-region'. The function should return a list of pairs
6404 of the form (POSITION . STRING), consisting of strings to be effectively
6405 inserted at the specified positions of the file being written (1 means to
6406 insert before the first byte written). The POSITIONs must be sorted into
6407 increasing order. If there are several functions in the list, the several
6408 lists are merged destructively. Alternatively, the function can return
6409 with a different buffer current and value nil.*/);
6410 Vwrite_region_annotate_functions = Qnil;
6412 DEFVAR_LISP ("write-region-annotations-so-far",
6413 &Vwrite_region_annotations_so_far,
6414 doc: /* When an annotation function is called, this holds the previous annotations.
6415 These are the annotations made by other annotation functions
6416 that were already called. See also `write-region-annotate-functions'. */);
6417 Vwrite_region_annotations_so_far = Qnil;
6419 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6420 doc: /* A list of file name handlers that temporarily should not be used.
6421 This applies only to the operation `inhibit-file-name-operation'. */);
6422 Vinhibit_file_name_handlers = Qnil;
6424 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6425 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6426 Vinhibit_file_name_operation = Qnil;
6428 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6429 doc: /* File name in which we write a list of all auto save file names.
6430 This variable is initialized automatically from `auto-save-list-file-prefix'
6431 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6432 a non-nil value. */);
6433 Vauto_save_list_file_name = Qnil;
6435 defsubr (&Sfind_file_name_handler);
6436 defsubr (&Sfile_name_directory);
6437 defsubr (&Sfile_name_nondirectory);
6438 defsubr (&Sunhandled_file_name_directory);
6439 defsubr (&Sfile_name_as_directory);
6440 defsubr (&Sdirectory_file_name);
6441 defsubr (&Smake_temp_name);
6442 defsubr (&Sexpand_file_name);
6443 defsubr (&Ssubstitute_in_file_name);
6444 defsubr (&Scopy_file);
6445 defsubr (&Smake_directory_internal);
6446 defsubr (&Sdelete_directory);
6447 defsubr (&Sdelete_file);
6448 defsubr (&Srename_file);
6449 defsubr (&Sadd_name_to_file);
6450 #ifdef S_IFLNK
6451 defsubr (&Smake_symbolic_link);
6452 #endif /* S_IFLNK */
6453 #ifdef VMS
6454 defsubr (&Sdefine_logical_name);
6455 #endif /* VMS */
6456 #ifdef HPUX_NET
6457 defsubr (&Ssysnetunam);
6458 #endif /* HPUX_NET */
6459 defsubr (&Sfile_name_absolute_p);
6460 defsubr (&Sfile_exists_p);
6461 defsubr (&Sfile_executable_p);
6462 defsubr (&Sfile_readable_p);
6463 defsubr (&Sfile_writable_p);
6464 defsubr (&Saccess_file);
6465 defsubr (&Sfile_symlink_p);
6466 defsubr (&Sfile_directory_p);
6467 defsubr (&Sfile_accessible_directory_p);
6468 defsubr (&Sfile_regular_p);
6469 defsubr (&Sfile_modes);
6470 defsubr (&Sset_file_modes);
6471 defsubr (&Sset_default_file_modes);
6472 defsubr (&Sdefault_file_modes);
6473 defsubr (&Sfile_newer_than_file_p);
6474 defsubr (&Sinsert_file_contents);
6475 defsubr (&Swrite_region);
6476 defsubr (&Scar_less_than_car);
6477 defsubr (&Sverify_visited_file_modtime);
6478 defsubr (&Sclear_visited_file_modtime);
6479 defsubr (&Svisited_file_modtime);
6480 defsubr (&Sset_visited_file_modtime);
6481 defsubr (&Sdo_auto_save);
6482 defsubr (&Sset_buffer_auto_saved);
6483 defsubr (&Sclear_buffer_auto_save_failure);
6484 defsubr (&Srecent_auto_save_p);
6486 defsubr (&Sread_file_name_internal);
6487 defsubr (&Sread_file_name);
6489 #ifdef unix
6490 defsubr (&Sunix_sync);
6491 #endif