(Frecenter): If ARG < 0, and on a window system
[emacs.git] / src / fileio.c
bloba8edc2f75b7b8aa89bdb63779712a74af3c4e16d
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 #define _GNU_SOURCE /* for euidaccess */
24 #include <config.h>
26 #if defined (USG5) || defined (BSD_SYSTEM) || defined (LINUX)
27 #include <fcntl.h>
28 #endif
30 #include <stdio.h>
31 #include <sys/types.h>
32 #include <sys/stat.h>
34 #ifdef HAVE_UNISTD_H
35 #include <unistd.h>
36 #endif
38 #if !defined (S_ISLNK) && defined (S_IFLNK)
39 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #endif
42 #if !defined (S_ISFIFO) && defined (S_IFIFO)
43 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #endif
46 #if !defined (S_ISREG) && defined (S_IFREG)
47 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
48 #endif
50 #ifdef VMS
51 #include "vms-pwd.h"
52 #else
53 #include <pwd.h>
54 #endif
56 #include <ctype.h>
58 #ifdef VMS
59 #include "vmsdir.h"
60 #include <perror.h>
61 #include <stddef.h>
62 #include <string.h>
63 #endif
65 #include <errno.h>
67 #ifndef vax11c
68 #ifndef USE_CRT_DLL
69 extern int errno;
70 #endif
71 #endif
73 #ifdef APOLLO
74 #include <sys/time.h>
75 #endif
77 #ifndef USG
78 #ifndef VMS
79 #ifndef BSD4_1
80 #ifndef WINDOWSNT
81 #define HAVE_FSYNC
82 #endif
83 #endif
84 #endif
85 #endif
87 #include "lisp.h"
88 #include "intervals.h"
89 #include "buffer.h"
90 #include "charset.h"
91 #include "coding.h"
92 #include "window.h"
94 #ifdef WINDOWSNT
95 #define NOMINMAX 1
96 #include <windows.h>
97 #include <stdlib.h>
98 #include <fcntl.h>
99 #endif /* not WINDOWSNT */
101 #ifdef MSDOS
102 #include "msdos.h"
103 #include <sys/param.h>
104 #if __DJGPP__ >= 2
105 #include <fcntl.h>
106 #include <string.h>
107 #endif
108 #endif
110 #ifdef DOS_NT
111 #define CORRECT_DIR_SEPS(s) \
112 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
113 else unixtodos_filename (s); \
114 } while (0)
115 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
116 redirector allows the six letters between 'Z' and 'a' as well. */
117 #ifdef MSDOS
118 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
119 #endif
120 #ifdef WINDOWSNT
121 #define IS_DRIVE(x) isalpha (x)
122 #endif
123 /* Need to lower-case the drive letter, or else expanded
124 filenames will sometimes compare inequal, because
125 `expand-file-name' doesn't always down-case the drive letter. */
126 #define DRIVE_LETTER(x) (tolower (x))
127 #endif
129 #ifdef VMS
130 #include <file.h>
131 #include <rmsdef.h>
132 #include <fab.h>
133 #include <nam.h>
134 #endif
136 #include "systime.h"
138 #ifdef HPUX
139 #include <netio.h>
140 #ifndef HPUX8
141 #ifndef HPUX9
142 #include <errnet.h>
143 #endif
144 #endif
145 #endif
147 #include "commands.h"
148 extern int use_dialog_box;
150 #ifndef O_WRONLY
151 #define O_WRONLY 1
152 #endif
154 #ifndef O_RDONLY
155 #define O_RDONLY 0
156 #endif
158 #ifndef S_ISLNK
159 # define lstat stat
160 #endif
162 #define min(a, b) ((a) < (b) ? (a) : (b))
163 #define max(a, b) ((a) > (b) ? (a) : (b))
165 /* Nonzero during writing of auto-save files */
166 int auto_saving;
168 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
169 a new file with the same mode as the original */
170 int auto_save_mode_bits;
172 /* Coding system for file names, or nil if none. */
173 Lisp_Object Vfile_name_coding_system;
175 /* Coding system for file names used only when
176 Vfile_name_coding_system is nil. */
177 Lisp_Object Vdefault_file_name_coding_system;
179 /* Alist of elements (REGEXP . HANDLER) for file names
180 whose I/O is done with a special handler. */
181 Lisp_Object Vfile_name_handler_alist;
183 /* Format for auto-save files */
184 Lisp_Object Vauto_save_file_format;
186 /* Lisp functions for translating file formats */
187 Lisp_Object Qformat_decode, Qformat_annotate_function;
189 /* Function to be called to decide a coding system of a reading file. */
190 Lisp_Object Vset_auto_coding_function;
192 /* Functions to be called to process text properties in inserted file. */
193 Lisp_Object Vafter_insert_file_functions;
195 /* Functions to be called to create text property annotations for file. */
196 Lisp_Object Vwrite_region_annotate_functions;
198 /* During build_annotations, each time an annotation function is called,
199 this holds the annotations made by the previous functions. */
200 Lisp_Object Vwrite_region_annotations_so_far;
202 /* File name in which we write a list of all our auto save files. */
203 Lisp_Object Vauto_save_list_file_name;
205 /* Nonzero means, when reading a filename in the minibuffer,
206 start out by inserting the default directory into the minibuffer. */
207 int insert_default_directory;
209 /* On VMS, nonzero means write new files with record format stmlf.
210 Zero means use var format. */
211 int vms_stmlf_recfm;
213 /* On NT, specifies the directory separator character, used (eg.) when
214 expanding file names. This can be bound to / or \. */
215 Lisp_Object Vdirectory_sep_char;
217 extern Lisp_Object Vuser_login_name;
219 #ifdef WINDOWSNT
220 extern Lisp_Object Vw32_get_true_file_attributes;
221 #endif
223 extern int minibuf_level;
225 extern int minibuffer_auto_raise;
227 /* These variables describe handlers that have "already" had a chance
228 to handle the current operation.
230 Vinhibit_file_name_handlers is a list of file name handlers.
231 Vinhibit_file_name_operation is the operation being handled.
232 If we try to handle that operation, we ignore those handlers. */
234 static Lisp_Object Vinhibit_file_name_handlers;
235 static Lisp_Object Vinhibit_file_name_operation;
237 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
238 Lisp_Object Qexcl;
239 Lisp_Object Qfile_name_history;
241 Lisp_Object Qcar_less_than_car;
243 static int a_write P_ ((int, Lisp_Object, int, int,
244 Lisp_Object *, struct coding_system *));
245 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
248 void
249 report_file_error (string, data)
250 char *string;
251 Lisp_Object data;
253 Lisp_Object errstring;
254 int errorno = errno;
256 synchronize_system_messages_locale ();
257 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
258 Vlocale_coding_system, 0);
260 while (1)
261 switch (errorno)
263 case EEXIST:
264 Fsignal (Qfile_already_exists, Fcons (errstring, data));
265 break;
266 default:
267 /* System error messages are capitalized. Downcase the initial
268 unless it is followed by a slash. */
269 if (XSTRING (errstring)->data[1] != '/')
270 XSTRING (errstring)->data[0] = DOWNCASE (XSTRING (errstring)->data[0]);
272 Fsignal (Qfile_error,
273 Fcons (build_string (string), Fcons (errstring, data)));
277 Lisp_Object
278 close_file_unwind (fd)
279 Lisp_Object fd;
281 emacs_close (XFASTINT (fd));
282 return Qnil;
285 /* Restore point, having saved it as a marker. */
287 static Lisp_Object
288 restore_point_unwind (location)
289 Lisp_Object location;
291 Fgoto_char (location);
292 Fset_marker (location, Qnil, Qnil);
293 return Qnil;
296 Lisp_Object Qexpand_file_name;
297 Lisp_Object Qsubstitute_in_file_name;
298 Lisp_Object Qdirectory_file_name;
299 Lisp_Object Qfile_name_directory;
300 Lisp_Object Qfile_name_nondirectory;
301 Lisp_Object Qunhandled_file_name_directory;
302 Lisp_Object Qfile_name_as_directory;
303 Lisp_Object Qcopy_file;
304 Lisp_Object Qmake_directory_internal;
305 Lisp_Object Qmake_directory;
306 Lisp_Object Qdelete_directory;
307 Lisp_Object Qdelete_file;
308 Lisp_Object Qrename_file;
309 Lisp_Object Qadd_name_to_file;
310 Lisp_Object Qmake_symbolic_link;
311 Lisp_Object Qfile_exists_p;
312 Lisp_Object Qfile_executable_p;
313 Lisp_Object Qfile_readable_p;
314 Lisp_Object Qfile_writable_p;
315 Lisp_Object Qfile_symlink_p;
316 Lisp_Object Qaccess_file;
317 Lisp_Object Qfile_directory_p;
318 Lisp_Object Qfile_regular_p;
319 Lisp_Object Qfile_accessible_directory_p;
320 Lisp_Object Qfile_modes;
321 Lisp_Object Qset_file_modes;
322 Lisp_Object Qfile_newer_than_file_p;
323 Lisp_Object Qinsert_file_contents;
324 Lisp_Object Qwrite_region;
325 Lisp_Object Qverify_visited_file_modtime;
326 Lisp_Object Qset_visited_file_modtime;
328 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
329 "Return FILENAME's handler function for OPERATION, if it has one.\n\
330 Otherwise, return nil.\n\
331 A file name is handled if one of the regular expressions in\n\
332 `file-name-handler-alist' matches it.\n\n\
333 If OPERATION equals `inhibit-file-name-operation', then we ignore\n\
334 any handlers that are members of `inhibit-file-name-handlers',\n\
335 but we still do run any other handlers. This lets handlers\n\
336 use the standard functions without calling themselves recursively.")
337 (filename, operation)
338 Lisp_Object filename, operation;
340 /* This function must not munge the match data. */
341 Lisp_Object chain, inhibited_handlers;
343 CHECK_STRING (filename, 0);
345 if (EQ (operation, Vinhibit_file_name_operation))
346 inhibited_handlers = Vinhibit_file_name_handlers;
347 else
348 inhibited_handlers = Qnil;
350 for (chain = Vfile_name_handler_alist; CONSP (chain);
351 chain = XCDR (chain))
353 Lisp_Object elt;
354 elt = XCAR (chain);
355 if (CONSP (elt))
357 Lisp_Object string;
358 string = XCAR (elt);
359 if (STRINGP (string) && fast_string_match (string, filename) >= 0)
361 Lisp_Object handler, tem;
363 handler = XCDR (elt);
364 tem = Fmemq (handler, inhibited_handlers);
365 if (NILP (tem))
366 return handler;
370 QUIT;
372 return Qnil;
375 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
376 1, 1, 0,
377 "Return the directory component in file name FILENAME.\n\
378 Return nil if FILENAME does not include a directory.\n\
379 Otherwise return a directory spec.\n\
380 Given a Unix syntax file name, returns a string ending in slash;\n\
381 on VMS, perhaps instead a string ending in `:', `]' or `>'.")
382 (filename)
383 Lisp_Object filename;
385 register unsigned char *beg;
386 register unsigned char *p;
387 Lisp_Object handler;
389 CHECK_STRING (filename, 0);
391 /* If the file name has special constructs in it,
392 call the corresponding file handler. */
393 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
394 if (!NILP (handler))
395 return call2 (handler, Qfile_name_directory, filename);
397 #ifdef FILE_SYSTEM_CASE
398 filename = FILE_SYSTEM_CASE (filename);
399 #endif
400 beg = XSTRING (filename)->data;
401 #ifdef DOS_NT
402 beg = strcpy (alloca (strlen (beg) + 1), beg);
403 #endif
404 p = beg + STRING_BYTES (XSTRING (filename));
406 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
407 #ifdef VMS
408 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
409 #endif /* VMS */
410 #ifdef DOS_NT
411 /* only recognise drive specifier at the beginning */
412 && !(p[-1] == ':'
413 /* handle the "/:d:foo" and "/:foo" cases correctly */
414 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
415 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
416 #endif
417 ) p--;
419 if (p == beg)
420 return Qnil;
421 #ifdef DOS_NT
422 /* Expansion of "c:" to drive and default directory. */
423 if (p[-1] == ':')
425 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
426 unsigned char *res = alloca (MAXPATHLEN + 1);
427 unsigned char *r = res;
429 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
431 strncpy (res, beg, 2);
432 beg += 2;
433 r += 2;
436 if (getdefdir (toupper (*beg) - 'A' + 1, r))
438 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
439 strcat (res, "/");
440 beg = res;
441 p = beg + strlen (beg);
444 CORRECT_DIR_SEPS (beg);
445 #endif /* DOS_NT */
447 if (STRING_MULTIBYTE (filename))
448 return make_string (beg, p - beg);
449 return make_unibyte_string (beg, p - beg);
452 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
453 Sfile_name_nondirectory, 1, 1, 0,
454 "Return file name FILENAME sans its directory.\n\
455 For example, in a Unix-syntax file name,\n\
456 this is everything after the last slash,\n\
457 or the entire name if it contains no slash.")
458 (filename)
459 Lisp_Object filename;
461 register unsigned char *beg, *p, *end;
462 Lisp_Object handler;
464 CHECK_STRING (filename, 0);
466 /* If the file name has special constructs in it,
467 call the corresponding file handler. */
468 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
469 if (!NILP (handler))
470 return call2 (handler, Qfile_name_nondirectory, filename);
472 beg = XSTRING (filename)->data;
473 end = p = beg + STRING_BYTES (XSTRING (filename));
475 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
476 #ifdef VMS
477 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
478 #endif /* VMS */
479 #ifdef DOS_NT
480 /* only recognise drive specifier at beginning */
481 && !(p[-1] == ':'
482 /* handle the "/:d:foo" case correctly */
483 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
484 #endif
486 p--;
488 if (STRING_MULTIBYTE (filename))
489 return make_string (p, end - p);
490 return make_unibyte_string (p, end - p);
493 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
494 Sunhandled_file_name_directory, 1, 1, 0,
495 "Return a directly usable directory name somehow associated with FILENAME.\n\
496 A `directly usable' directory name is one that may be used without the\n\
497 intervention of any file handler.\n\
498 If FILENAME is a directly usable file itself, return\n\
499 \(file-name-directory FILENAME).\n\
500 The `call-process' and `start-process' functions use this function to\n\
501 get a current directory to run processes in.")
502 (filename)
503 Lisp_Object filename;
505 Lisp_Object handler;
507 /* If the file name has special constructs in it,
508 call the corresponding file handler. */
509 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
510 if (!NILP (handler))
511 return call2 (handler, Qunhandled_file_name_directory, filename);
513 return Ffile_name_directory (filename);
517 char *
518 file_name_as_directory (out, in)
519 char *out, *in;
521 int size = strlen (in) - 1;
523 strcpy (out, in);
525 if (size < 0)
527 out[0] = '.';
528 out[1] = '/';
529 out[2] = 0;
530 return out;
533 #ifdef VMS
534 /* Is it already a directory string? */
535 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
536 return out;
537 /* Is it a VMS directory file name? If so, hack VMS syntax. */
538 else if (! index (in, '/')
539 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
540 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
541 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
542 || ! strncmp (&in[size - 5], ".dir", 4))
543 && (in[size - 1] == '.' || in[size - 1] == ';')
544 && in[size] == '1')))
546 register char *p, *dot;
547 char brack;
549 /* x.dir -> [.x]
550 dir:x.dir --> dir:[x]
551 dir:[x]y.dir --> dir:[x.y] */
552 p = in + size;
553 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
554 if (p != in)
556 strncpy (out, in, p - in);
557 out[p - in] = '\0';
558 if (*p == ':')
560 brack = ']';
561 strcat (out, ":[");
563 else
565 brack = *p;
566 strcat (out, ".");
568 p++;
570 else
572 brack = ']';
573 strcpy (out, "[.");
575 dot = index (p, '.');
576 if (dot)
578 /* blindly remove any extension */
579 size = strlen (out) + (dot - p);
580 strncat (out, p, dot - p);
582 else
584 strcat (out, p);
585 size = strlen (out);
587 out[size++] = brack;
588 out[size] = '\0';
590 #else /* not VMS */
591 /* For Unix syntax, Append a slash if necessary */
592 if (!IS_DIRECTORY_SEP (out[size]))
594 out[size + 1] = DIRECTORY_SEP;
595 out[size + 2] = '\0';
597 #ifdef DOS_NT
598 CORRECT_DIR_SEPS (out);
599 #endif
600 #endif /* not VMS */
601 return out;
604 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
605 Sfile_name_as_directory, 1, 1, 0,
606 "Return a string representing file FILENAME interpreted as a directory.\n\
607 This operation exists because a directory is also a file, but its name as\n\
608 a directory is different from its name as a file.\n\
609 The result can be used as the value of `default-directory'\n\
610 or passed as second argument to `expand-file-name'.\n\
611 For a Unix-syntax file name, just appends a slash.\n\
612 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.")
613 (file)
614 Lisp_Object file;
616 char *buf;
617 Lisp_Object handler;
619 CHECK_STRING (file, 0);
620 if (NILP (file))
621 return Qnil;
623 /* If the file name has special constructs in it,
624 call the corresponding file handler. */
625 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
626 if (!NILP (handler))
627 return call2 (handler, Qfile_name_as_directory, file);
629 buf = (char *) alloca (STRING_BYTES (XSTRING (file)) + 10);
630 return build_string (file_name_as_directory (buf, XSTRING (file)->data));
634 * Convert from directory name to filename.
635 * On VMS:
636 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
637 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
638 * On UNIX, it's simple: just make sure there isn't a terminating /
640 * Value is nonzero if the string output is different from the input.
644 directory_file_name (src, dst)
645 char *src, *dst;
647 long slen;
648 #ifdef VMS
649 long rlen;
650 char * ptr, * rptr;
651 char bracket;
652 struct FAB fab = cc$rms_fab;
653 struct NAM nam = cc$rms_nam;
654 char esa[NAM$C_MAXRSS];
655 #endif /* VMS */
657 slen = strlen (src);
658 #ifdef VMS
659 if (! index (src, '/')
660 && (src[slen - 1] == ']'
661 || src[slen - 1] == ':'
662 || src[slen - 1] == '>'))
664 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
665 fab.fab$l_fna = src;
666 fab.fab$b_fns = slen;
667 fab.fab$l_nam = &nam;
668 fab.fab$l_fop = FAB$M_NAM;
670 nam.nam$l_esa = esa;
671 nam.nam$b_ess = sizeof esa;
672 nam.nam$b_nop |= NAM$M_SYNCHK;
674 /* We call SYS$PARSE to handle such things as [--] for us. */
675 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
677 slen = nam.nam$b_esl;
678 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
679 slen -= 2;
680 esa[slen] = '\0';
681 src = esa;
683 if (src[slen - 1] != ']' && src[slen - 1] != '>')
685 /* what about when we have logical_name:???? */
686 if (src[slen - 1] == ':')
687 { /* Xlate logical name and see what we get */
688 ptr = strcpy (dst, src); /* upper case for getenv */
689 while (*ptr)
691 if ('a' <= *ptr && *ptr <= 'z')
692 *ptr -= 040;
693 ptr++;
695 dst[slen - 1] = 0; /* remove colon */
696 if (!(src = egetenv (dst)))
697 return 0;
698 /* should we jump to the beginning of this procedure?
699 Good points: allows us to use logical names that xlate
700 to Unix names,
701 Bad points: can be a problem if we just translated to a device
702 name...
703 For now, I'll punt and always expect VMS names, and hope for
704 the best! */
705 slen = strlen (src);
706 if (src[slen - 1] != ']' && src[slen - 1] != '>')
707 { /* no recursion here! */
708 strcpy (dst, src);
709 return 0;
712 else
713 { /* not a directory spec */
714 strcpy (dst, src);
715 return 0;
718 bracket = src[slen - 1];
720 /* If bracket is ']' or '>', bracket - 2 is the corresponding
721 opening bracket. */
722 ptr = index (src, bracket - 2);
723 if (ptr == 0)
724 { /* no opening bracket */
725 strcpy (dst, src);
726 return 0;
728 if (!(rptr = rindex (src, '.')))
729 rptr = ptr;
730 slen = rptr - src;
731 strncpy (dst, src, slen);
732 dst[slen] = '\0';
733 if (*rptr == '.')
735 dst[slen++] = bracket;
736 dst[slen] = '\0';
738 else
740 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
741 then translate the device and recurse. */
742 if (dst[slen - 1] == ':'
743 && dst[slen - 2] != ':' /* skip decnet nodes */
744 && strcmp (src + slen, "[000000]") == 0)
746 dst[slen - 1] = '\0';
747 if ((ptr = egetenv (dst))
748 && (rlen = strlen (ptr) - 1) > 0
749 && (ptr[rlen] == ']' || ptr[rlen] == '>')
750 && ptr[rlen - 1] == '.')
752 char * buf = (char *) alloca (strlen (ptr) + 1);
753 strcpy (buf, ptr);
754 buf[rlen - 1] = ']';
755 buf[rlen] = '\0';
756 return directory_file_name (buf, dst);
758 else
759 dst[slen - 1] = ':';
761 strcat (dst, "[000000]");
762 slen += 8;
764 rptr++;
765 rlen = strlen (rptr) - 1;
766 strncat (dst, rptr, rlen);
767 dst[slen + rlen] = '\0';
768 strcat (dst, ".DIR.1");
769 return 1;
771 #endif /* VMS */
772 /* Process as Unix format: just remove any final slash.
773 But leave "/" unchanged; do not change it to "". */
774 strcpy (dst, src);
775 #ifdef APOLLO
776 /* Handle // as root for apollo's. */
777 if ((slen > 2 && dst[slen - 1] == '/')
778 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
779 dst[slen - 1] = 0;
780 #else
781 if (slen > 1
782 && IS_DIRECTORY_SEP (dst[slen - 1])
783 #ifdef DOS_NT
784 && !IS_ANY_SEP (dst[slen - 2])
785 #endif
787 dst[slen - 1] = 0;
788 #endif
789 #ifdef DOS_NT
790 CORRECT_DIR_SEPS (dst);
791 #endif
792 return 1;
795 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
796 1, 1, 0,
797 "Returns the file name of the directory named DIRECTORY.\n\
798 This is the name of the file that holds the data for the directory DIRECTORY.\n\
799 This operation exists because a directory is also a file, but its name as\n\
800 a directory is different from its name as a file.\n\
801 In Unix-syntax, this function just removes the final slash.\n\
802 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",\n\
803 it returns a file name such as \"[X]Y.DIR.1\".")
804 (directory)
805 Lisp_Object directory;
807 char *buf;
808 Lisp_Object handler;
810 CHECK_STRING (directory, 0);
812 if (NILP (directory))
813 return Qnil;
815 /* If the file name has special constructs in it,
816 call the corresponding file handler. */
817 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
818 if (!NILP (handler))
819 return call2 (handler, Qdirectory_file_name, directory);
821 #ifdef VMS
822 /* 20 extra chars is insufficient for VMS, since we might perform a
823 logical name translation. an equivalence string can be up to 255
824 chars long, so grab that much extra space... - sss */
825 buf = (char *) alloca (STRING_BYTES (XSTRING (directory)) + 20 + 255);
826 #else
827 buf = (char *) alloca (STRING_BYTES (XSTRING (directory)) + 20);
828 #endif
829 directory_file_name (XSTRING (directory)->data, buf);
830 return build_string (buf);
833 static char make_temp_name_tbl[64] =
835 'A','B','C','D','E','F','G','H',
836 'I','J','K','L','M','N','O','P',
837 'Q','R','S','T','U','V','W','X',
838 'Y','Z','a','b','c','d','e','f',
839 'g','h','i','j','k','l','m','n',
840 'o','p','q','r','s','t','u','v',
841 'w','x','y','z','0','1','2','3',
842 '4','5','6','7','8','9','-','_'
845 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
847 /* Value is a temporary file name starting with PREFIX, a string.
849 The Emacs process number forms part of the result, so there is
850 no danger of generating a name being used by another process.
851 In addition, this function makes an attempt to choose a name
852 which has no existing file. To make this work, PREFIX should be
853 an absolute file name.
855 BASE64_P non-zero means add the pid as 3 characters in base64
856 encoding. In this case, 6 characters will be added to PREFIX to
857 form the file name. Otherwise, if Emacs is running on a system
858 with long file names, add the pid as a decimal number.
860 This function signals an error if no unique file name could be
861 generated. */
863 Lisp_Object
864 make_temp_name (prefix, base64_p)
865 Lisp_Object prefix;
866 int base64_p;
868 Lisp_Object val;
869 int len;
870 int pid;
871 unsigned char *p, *data;
872 char pidbuf[20];
873 int pidlen;
875 CHECK_STRING (prefix, 0);
877 /* VAL is created by adding 6 characters to PREFIX. The first
878 three are the PID of this process, in base 64, and the second
879 three are incremented if the file already exists. This ensures
880 262144 unique file names per PID per PREFIX. */
882 pid = (int) getpid ();
884 if (base64_p)
886 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
887 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
888 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
889 pidlen = 3;
891 else
893 #ifdef HAVE_LONG_FILE_NAMES
894 sprintf (pidbuf, "%d", pid);
895 pidlen = strlen (pidbuf);
896 #else
897 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
898 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
899 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
900 pidlen = 3;
901 #endif
904 len = XSTRING (prefix)->size;
905 val = make_uninit_string (len + 3 + pidlen);
906 data = XSTRING (val)->data;
907 bcopy(XSTRING (prefix)->data, data, len);
908 p = data + len;
910 bcopy (pidbuf, p, pidlen);
911 p += pidlen;
913 /* Here we try to minimize useless stat'ing when this function is
914 invoked many times successively with the same PREFIX. We achieve
915 this by initializing count to a random value, and incrementing it
916 afterwards.
918 We don't want make-temp-name to be called while dumping,
919 because then make_temp_name_count_initialized_p would get set
920 and then make_temp_name_count would not be set when Emacs starts. */
922 if (!make_temp_name_count_initialized_p)
924 make_temp_name_count = (unsigned) time (NULL);
925 make_temp_name_count_initialized_p = 1;
928 while (1)
930 struct stat ignored;
931 unsigned num = make_temp_name_count;
933 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
934 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
935 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
937 /* Poor man's congruential RN generator. Replace with
938 ++make_temp_name_count for debugging. */
939 make_temp_name_count += 25229;
940 make_temp_name_count %= 225307;
942 if (stat (data, &ignored) < 0)
944 /* We want to return only if errno is ENOENT. */
945 if (errno == ENOENT)
946 return val;
947 else
948 /* The error here is dubious, but there is little else we
949 can do. The alternatives are to return nil, which is
950 as bad as (and in many cases worse than) throwing the
951 error, or to ignore the error, which will likely result
952 in looping through 225307 stat's, which is not only
953 dog-slow, but also useless since it will fallback to
954 the errow below, anyway. */
955 report_file_error ("Cannot create temporary name for prefix",
956 Fcons (prefix, Qnil));
957 /* not reached */
961 error ("Cannot create temporary name for prefix `%s'",
962 XSTRING (prefix)->data);
963 return Qnil;
967 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
968 "Generate temporary file name (string) starting with PREFIX (a string).\n\
969 The Emacs process number forms part of the result,\n\
970 so there is no danger of generating a name being used by another process.\n\
972 In addition, this function makes an attempt to choose a name\n\
973 which has no existing file. To make this work,\n\
974 PREFIX should be an absolute file name.\n\
976 There is a race condition between calling `make-temp-name' and creating the\n\
977 file which opens all kinds of security holes. For that reason, you should\n\
978 probably use `make-temp-file' instead.")
979 (prefix)
980 Lisp_Object prefix;
982 return make_temp_name (prefix, 0);
987 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
988 "Convert filename NAME to absolute, and canonicalize it.\n\
989 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative\n\
990 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,\n\
991 the current buffer's value of default-directory is used.\n\
992 File name components that are `.' are removed, and \n\
993 so are file name components followed by `..', along with the `..' itself;\n\
994 note that these simplifications are done without checking the resulting\n\
995 file names in the file system.\n\
996 An initial `~/' expands to your home directory.\n\
997 An initial `~USER/' expands to USER's home directory.\n\
998 See also the function `substitute-in-file-name'.")
999 (name, default_directory)
1000 Lisp_Object name, default_directory;
1002 unsigned char *nm;
1004 register unsigned char *newdir, *p, *o;
1005 int tlen;
1006 unsigned char *target;
1007 struct passwd *pw;
1008 #ifdef VMS
1009 unsigned char * colon = 0;
1010 unsigned char * close = 0;
1011 unsigned char * slash = 0;
1012 unsigned char * brack = 0;
1013 int lbrack = 0, rbrack = 0;
1014 int dots = 0;
1015 #endif /* VMS */
1016 #ifdef DOS_NT
1017 int drive = 0;
1018 int collapse_newdir = 1;
1019 int is_escaped = 0;
1020 #endif /* DOS_NT */
1021 int length;
1022 Lisp_Object handler;
1024 CHECK_STRING (name, 0);
1026 /* If the file name has special constructs in it,
1027 call the corresponding file handler. */
1028 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1029 if (!NILP (handler))
1030 return call3 (handler, Qexpand_file_name, name, default_directory);
1032 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1033 if (NILP (default_directory))
1034 default_directory = current_buffer->directory;
1035 if (! STRINGP (default_directory))
1036 default_directory = build_string ("/");
1038 if (!NILP (default_directory))
1040 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1041 if (!NILP (handler))
1042 return call3 (handler, Qexpand_file_name, name, default_directory);
1045 o = XSTRING (default_directory)->data;
1047 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1048 It would be better to do this down below where we actually use
1049 default_directory. Unfortunately, calling Fexpand_file_name recursively
1050 could invoke GC, and the strings might be relocated. This would
1051 be annoying because we have pointers into strings lying around
1052 that would need adjusting, and people would add new pointers to
1053 the code and forget to adjust them, resulting in intermittent bugs.
1054 Putting this call here avoids all that crud.
1056 The EQ test avoids infinite recursion. */
1057 if (! NILP (default_directory) && !EQ (default_directory, name)
1058 /* Save time in some common cases - as long as default_directory
1059 is not relative, it can be canonicalized with name below (if it
1060 is needed at all) without requiring it to be expanded now. */
1061 #ifdef DOS_NT
1062 /* Detect MSDOS file names with drive specifiers. */
1063 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1064 #ifdef WINDOWSNT
1065 /* Detect Windows file names in UNC format. */
1066 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1067 #endif
1068 #else /* not DOS_NT */
1069 /* Detect Unix absolute file names (/... alone is not absolute on
1070 DOS or Windows). */
1071 && ! (IS_DIRECTORY_SEP (o[0]))
1072 #endif /* not DOS_NT */
1075 struct gcpro gcpro1;
1077 GCPRO1 (name);
1078 default_directory = Fexpand_file_name (default_directory, Qnil);
1079 UNGCPRO;
1082 #ifdef VMS
1083 /* Filenames on VMS are always upper case. */
1084 name = Fupcase (name);
1085 #endif
1086 #ifdef FILE_SYSTEM_CASE
1087 name = FILE_SYSTEM_CASE (name);
1088 #endif
1090 nm = XSTRING (name)->data;
1092 #ifdef DOS_NT
1093 /* We will force directory separators to be either all \ or /, so make
1094 a local copy to modify, even if there ends up being no change. */
1095 nm = strcpy (alloca (strlen (nm) + 1), nm);
1097 /* Note if special escape prefix is present, but remove for now. */
1098 if (nm[0] == '/' && nm[1] == ':')
1100 is_escaped = 1;
1101 nm += 2;
1104 /* Find and remove drive specifier if present; this makes nm absolute
1105 even if the rest of the name appears to be relative. Only look for
1106 drive specifier at the beginning. */
1107 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1109 drive = nm[0];
1110 nm += 2;
1113 #ifdef WINDOWSNT
1114 /* If we see "c://somedir", we want to strip the first slash after the
1115 colon when stripping the drive letter. Otherwise, this expands to
1116 "//somedir". */
1117 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1118 nm++;
1119 #endif /* WINDOWSNT */
1120 #endif /* DOS_NT */
1122 #ifdef WINDOWSNT
1123 /* Discard any previous drive specifier if nm is now in UNC format. */
1124 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1126 drive = 0;
1128 #endif
1130 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1131 none are found, we can probably return right away. We will avoid
1132 allocating a new string if name is already fully expanded. */
1133 if (
1134 IS_DIRECTORY_SEP (nm[0])
1135 #ifdef MSDOS
1136 && drive && !is_escaped
1137 #endif
1138 #ifdef WINDOWSNT
1139 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1140 #endif
1141 #ifdef VMS
1142 || index (nm, ':')
1143 #endif /* VMS */
1146 /* If it turns out that the filename we want to return is just a
1147 suffix of FILENAME, we don't need to go through and edit
1148 things; we just need to construct a new string using data
1149 starting at the middle of FILENAME. If we set lose to a
1150 non-zero value, that means we've discovered that we can't do
1151 that cool trick. */
1152 int lose = 0;
1154 p = nm;
1155 while (*p)
1157 /* Since we know the name is absolute, we can assume that each
1158 element starts with a "/". */
1160 /* "." and ".." are hairy. */
1161 if (IS_DIRECTORY_SEP (p[0])
1162 && p[1] == '.'
1163 && (IS_DIRECTORY_SEP (p[2])
1164 || p[2] == 0
1165 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1166 || p[3] == 0))))
1167 lose = 1;
1168 /* We want to replace multiple `/' in a row with a single
1169 slash. */
1170 else if (p > nm
1171 && IS_DIRECTORY_SEP (p[0])
1172 && IS_DIRECTORY_SEP (p[1]))
1173 lose = 1;
1175 #ifdef VMS
1176 if (p[0] == '\\')
1177 lose = 1;
1178 if (p[0] == '/') {
1179 /* if dev:[dir]/, move nm to / */
1180 if (!slash && p > nm && (brack || colon)) {
1181 nm = (brack ? brack + 1 : colon + 1);
1182 lbrack = rbrack = 0;
1183 brack = 0;
1184 colon = 0;
1186 slash = p;
1188 if (p[0] == '-')
1189 #ifndef VMS4_4
1190 /* VMS pre V4.4,convert '-'s in filenames. */
1191 if (lbrack == rbrack)
1193 if (dots < 2) /* this is to allow negative version numbers */
1194 p[0] = '_';
1196 else
1197 #endif /* VMS4_4 */
1198 if (lbrack > rbrack &&
1199 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1200 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1201 lose = 1;
1202 #ifndef VMS4_4
1203 else
1204 p[0] = '_';
1205 #endif /* VMS4_4 */
1206 /* count open brackets, reset close bracket pointer */
1207 if (p[0] == '[' || p[0] == '<')
1208 lbrack++, brack = 0;
1209 /* count close brackets, set close bracket pointer */
1210 if (p[0] == ']' || p[0] == '>')
1211 rbrack++, brack = p;
1212 /* detect ][ or >< */
1213 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1214 lose = 1;
1215 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1216 nm = p + 1, lose = 1;
1217 if (p[0] == ':' && (colon || slash))
1218 /* if dev1:[dir]dev2:, move nm to dev2: */
1219 if (brack)
1221 nm = brack + 1;
1222 brack = 0;
1224 /* if /name/dev:, move nm to dev: */
1225 else if (slash)
1226 nm = slash + 1;
1227 /* if node::dev:, move colon following dev */
1228 else if (colon && colon[-1] == ':')
1229 colon = p;
1230 /* if dev1:dev2:, move nm to dev2: */
1231 else if (colon && colon[-1] != ':')
1233 nm = colon + 1;
1234 colon = 0;
1236 if (p[0] == ':' && !colon)
1238 if (p[1] == ':')
1239 p++;
1240 colon = p;
1242 if (lbrack == rbrack)
1243 if (p[0] == ';')
1244 dots = 2;
1245 else if (p[0] == '.')
1246 dots++;
1247 #endif /* VMS */
1248 p++;
1250 if (!lose)
1252 #ifdef VMS
1253 if (index (nm, '/'))
1254 return build_string (sys_translate_unix (nm));
1255 #endif /* VMS */
1256 #ifdef DOS_NT
1257 /* Make sure directories are all separated with / or \ as
1258 desired, but avoid allocation of a new string when not
1259 required. */
1260 CORRECT_DIR_SEPS (nm);
1261 #ifdef WINDOWSNT
1262 if (IS_DIRECTORY_SEP (nm[1]))
1264 if (strcmp (nm, XSTRING (name)->data) != 0)
1265 name = build_string (nm);
1267 else
1268 #endif
1269 /* drive must be set, so this is okay */
1270 if (strcmp (nm - 2, XSTRING (name)->data) != 0)
1272 name = make_string (nm - 2, p - nm + 2);
1273 XSTRING (name)->data[0] = DRIVE_LETTER (drive);
1274 XSTRING (name)->data[1] = ':';
1276 return name;
1277 #else /* not DOS_NT */
1278 if (nm == XSTRING (name)->data)
1279 return name;
1280 return build_string (nm);
1281 #endif /* not DOS_NT */
1285 /* At this point, nm might or might not be an absolute file name. We
1286 need to expand ~ or ~user if present, otherwise prefix nm with
1287 default_directory if nm is not absolute, and finally collapse /./
1288 and /foo/../ sequences.
1290 We set newdir to be the appropriate prefix if one is needed:
1291 - the relevant user directory if nm starts with ~ or ~user
1292 - the specified drive's working dir (DOS/NT only) if nm does not
1293 start with /
1294 - the value of default_directory.
1296 Note that these prefixes are not guaranteed to be absolute (except
1297 for the working dir of a drive). Therefore, to ensure we always
1298 return an absolute name, if the final prefix is not absolute we
1299 append it to the current working directory. */
1301 newdir = 0;
1303 if (nm[0] == '~') /* prefix ~ */
1305 if (IS_DIRECTORY_SEP (nm[1])
1306 #ifdef VMS
1307 || nm[1] == ':'
1308 #endif /* VMS */
1309 || nm[1] == 0) /* ~ by itself */
1311 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1312 newdir = (unsigned char *) "";
1313 nm++;
1314 #ifdef DOS_NT
1315 collapse_newdir = 0;
1316 #endif
1317 #ifdef VMS
1318 nm++; /* Don't leave the slash in nm. */
1319 #endif /* VMS */
1321 else /* ~user/filename */
1323 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1324 #ifdef VMS
1325 && *p != ':'
1326 #endif /* VMS */
1327 ); p++);
1328 o = (unsigned char *) alloca (p - nm + 1);
1329 bcopy ((char *) nm, o, p - nm);
1330 o [p - nm] = 0;
1332 pw = (struct passwd *) getpwnam (o + 1);
1333 if (pw)
1335 newdir = (unsigned char *) pw -> pw_dir;
1336 #ifdef VMS
1337 nm = p + 1; /* skip the terminator */
1338 #else
1339 nm = p;
1340 #ifdef DOS_NT
1341 collapse_newdir = 0;
1342 #endif
1343 #endif /* VMS */
1346 /* If we don't find a user of that name, leave the name
1347 unchanged; don't move nm forward to p. */
1351 #ifdef DOS_NT
1352 /* On DOS and Windows, nm is absolute if a drive name was specified;
1353 use the drive's current directory as the prefix if needed. */
1354 if (!newdir && drive)
1356 /* Get default directory if needed to make nm absolute. */
1357 if (!IS_DIRECTORY_SEP (nm[0]))
1359 newdir = alloca (MAXPATHLEN + 1);
1360 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1361 newdir = NULL;
1363 if (!newdir)
1365 /* Either nm starts with /, or drive isn't mounted. */
1366 newdir = alloca (4);
1367 newdir[0] = DRIVE_LETTER (drive);
1368 newdir[1] = ':';
1369 newdir[2] = '/';
1370 newdir[3] = 0;
1373 #endif /* DOS_NT */
1375 /* Finally, if no prefix has been specified and nm is not absolute,
1376 then it must be expanded relative to default_directory. */
1378 if (1
1379 #ifndef DOS_NT
1380 /* /... alone is not absolute on DOS and Windows. */
1381 && !IS_DIRECTORY_SEP (nm[0])
1382 #endif
1383 #ifdef WINDOWSNT
1384 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1385 #endif
1386 #ifdef VMS
1387 && !index (nm, ':')
1388 #endif
1389 && !newdir)
1391 newdir = XSTRING (default_directory)->data;
1392 #ifdef DOS_NT
1393 /* Note if special escape prefix is present, but remove for now. */
1394 if (newdir[0] == '/' && newdir[1] == ':')
1396 is_escaped = 1;
1397 newdir += 2;
1399 #endif
1402 #ifdef DOS_NT
1403 if (newdir)
1405 /* First ensure newdir is an absolute name. */
1406 if (
1407 /* Detect MSDOS file names with drive specifiers. */
1408 ! (IS_DRIVE (newdir[0])
1409 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1410 #ifdef WINDOWSNT
1411 /* Detect Windows file names in UNC format. */
1412 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1413 #endif
1416 /* Effectively, let newdir be (expand-file-name newdir cwd).
1417 Because of the admonition against calling expand-file-name
1418 when we have pointers into lisp strings, we accomplish this
1419 indirectly by prepending newdir to nm if necessary, and using
1420 cwd (or the wd of newdir's drive) as the new newdir. */
1422 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1424 drive = newdir[0];
1425 newdir += 2;
1427 if (!IS_DIRECTORY_SEP (nm[0]))
1429 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1430 file_name_as_directory (tmp, newdir);
1431 strcat (tmp, nm);
1432 nm = tmp;
1434 newdir = alloca (MAXPATHLEN + 1);
1435 if (drive)
1437 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1438 newdir = "/";
1440 else
1441 getwd (newdir);
1444 /* Strip off drive name from prefix, if present. */
1445 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1447 drive = newdir[0];
1448 newdir += 2;
1451 /* Keep only a prefix from newdir if nm starts with slash
1452 (//server/share for UNC, nothing otherwise). */
1453 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1455 #ifdef WINDOWSNT
1456 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1458 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1459 p = newdir + 2;
1460 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1461 p++;
1462 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1463 *p = 0;
1465 else
1466 #endif
1467 newdir = "";
1470 #endif /* DOS_NT */
1472 if (newdir)
1474 /* Get rid of any slash at the end of newdir, unless newdir is
1475 just / or // (an incomplete UNC name). */
1476 length = strlen (newdir);
1477 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1478 #ifdef WINDOWSNT
1479 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1480 #endif
1483 unsigned char *temp = (unsigned char *) alloca (length);
1484 bcopy (newdir, temp, length - 1);
1485 temp[length - 1] = 0;
1486 newdir = temp;
1488 tlen = length + 1;
1490 else
1491 tlen = 0;
1493 /* Now concatenate the directory and name to new space in the stack frame */
1494 tlen += strlen (nm) + 1;
1495 #ifdef DOS_NT
1496 /* Reserve space for drive specifier and escape prefix, since either
1497 or both may need to be inserted. (The Microsoft x86 compiler
1498 produces incorrect code if the following two lines are combined.) */
1499 target = (unsigned char *) alloca (tlen + 4);
1500 target += 4;
1501 #else /* not DOS_NT */
1502 target = (unsigned char *) alloca (tlen);
1503 #endif /* not DOS_NT */
1504 *target = 0;
1506 if (newdir)
1508 #ifndef VMS
1509 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1511 #ifdef DOS_NT
1512 /* If newdir is effectively "C:/", then the drive letter will have
1513 been stripped and newdir will be "/". Concatenating with an
1514 absolute directory in nm produces "//", which will then be
1515 incorrectly treated as a network share. Ignore newdir in
1516 this case (keeping the drive letter). */
1517 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1518 && newdir[1] == '\0'))
1519 #endif
1520 strcpy (target, newdir);
1522 else
1523 #endif
1524 file_name_as_directory (target, newdir);
1527 strcat (target, nm);
1528 #ifdef VMS
1529 if (index (target, '/'))
1530 strcpy (target, sys_translate_unix (target));
1531 #endif /* VMS */
1533 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1535 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1536 appear. */
1538 p = target;
1539 o = target;
1541 while (*p)
1543 #ifdef VMS
1544 if (*p != ']' && *p != '>' && *p != '-')
1546 if (*p == '\\')
1547 p++;
1548 *o++ = *p++;
1550 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1551 /* brackets are offset from each other by 2 */
1553 p += 2;
1554 if (*p != '.' && *p != '-' && o[-1] != '.')
1555 /* convert [foo][bar] to [bar] */
1556 while (o[-1] != '[' && o[-1] != '<')
1557 o--;
1558 else if (*p == '-' && *o != '.')
1559 *--p = '.';
1561 else if (p[0] == '-' && o[-1] == '.' &&
1562 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1563 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1566 o--;
1567 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1568 if (p[1] == '.') /* foo.-.bar ==> bar. */
1569 p += 2;
1570 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1571 p++, o--;
1572 /* else [foo.-] ==> [-] */
1574 else
1576 #ifndef VMS4_4
1577 if (*p == '-' &&
1578 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1579 p[1] != ']' && p[1] != '>' && p[1] != '.')
1580 *p = '_';
1581 #endif /* VMS4_4 */
1582 *o++ = *p++;
1584 #else /* not VMS */
1585 if (!IS_DIRECTORY_SEP (*p))
1587 *o++ = *p++;
1589 else if (IS_DIRECTORY_SEP (p[0])
1590 && p[1] == '.'
1591 && (IS_DIRECTORY_SEP (p[2])
1592 || p[2] == 0))
1594 /* If "/." is the entire filename, keep the "/". Otherwise,
1595 just delete the whole "/.". */
1596 if (o == target && p[2] == '\0')
1597 *o++ = *p;
1598 p += 2;
1600 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1601 /* `/../' is the "superroot" on certain file systems. */
1602 && o != target
1603 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1605 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1607 /* Keep initial / only if this is the whole name. */
1608 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1609 ++o;
1610 p += 3;
1612 else if (p > target
1613 && IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1]))
1615 /* Collapse multiple `/' in a row. */
1616 *o++ = *p++;
1617 while (IS_DIRECTORY_SEP (*p))
1618 ++p;
1620 else
1622 *o++ = *p++;
1624 #endif /* not VMS */
1627 #ifdef DOS_NT
1628 /* At last, set drive name. */
1629 #ifdef WINDOWSNT
1630 /* Except for network file name. */
1631 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1632 #endif /* WINDOWSNT */
1634 if (!drive) abort ();
1635 target -= 2;
1636 target[0] = DRIVE_LETTER (drive);
1637 target[1] = ':';
1639 /* Reinsert the escape prefix if required. */
1640 if (is_escaped)
1642 target -= 2;
1643 target[0] = '/';
1644 target[1] = ':';
1646 CORRECT_DIR_SEPS (target);
1647 #endif /* DOS_NT */
1649 return make_string (target, o - target);
1652 #if 0
1653 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1654 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1655 "Convert FILENAME to absolute, and canonicalize it.\n\
1656 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1657 (does not start with slash); if DEFAULT is nil or missing,\n\
1658 the current buffer's value of default-directory is used.\n\
1659 Filenames containing `.' or `..' as components are simplified;\n\
1660 initial `~/' expands to your home directory.\n\
1661 See also the function `substitute-in-file-name'.")
1662 (name, defalt)
1663 Lisp_Object name, defalt;
1665 unsigned char *nm;
1667 register unsigned char *newdir, *p, *o;
1668 int tlen;
1669 unsigned char *target;
1670 struct passwd *pw;
1671 int lose;
1672 #ifdef VMS
1673 unsigned char * colon = 0;
1674 unsigned char * close = 0;
1675 unsigned char * slash = 0;
1676 unsigned char * brack = 0;
1677 int lbrack = 0, rbrack = 0;
1678 int dots = 0;
1679 #endif /* VMS */
1681 CHECK_STRING (name, 0);
1683 #ifdef VMS
1684 /* Filenames on VMS are always upper case. */
1685 name = Fupcase (name);
1686 #endif
1688 nm = XSTRING (name)->data;
1690 /* If nm is absolute, flush ...// and detect /./ and /../.
1691 If no /./ or /../ we can return right away. */
1692 if (
1693 nm[0] == '/'
1694 #ifdef VMS
1695 || index (nm, ':')
1696 #endif /* VMS */
1699 p = nm;
1700 lose = 0;
1701 while (*p)
1703 if (p[0] == '/' && p[1] == '/'
1704 #ifdef APOLLO
1705 /* // at start of filename is meaningful on Apollo system. */
1706 && nm != p
1707 #endif /* APOLLO */
1709 nm = p + 1;
1710 if (p[0] == '/' && p[1] == '~')
1711 nm = p + 1, lose = 1;
1712 if (p[0] == '/' && p[1] == '.'
1713 && (p[2] == '/' || p[2] == 0
1714 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1715 lose = 1;
1716 #ifdef VMS
1717 if (p[0] == '\\')
1718 lose = 1;
1719 if (p[0] == '/') {
1720 /* if dev:[dir]/, move nm to / */
1721 if (!slash && p > nm && (brack || colon)) {
1722 nm = (brack ? brack + 1 : colon + 1);
1723 lbrack = rbrack = 0;
1724 brack = 0;
1725 colon = 0;
1727 slash = p;
1729 if (p[0] == '-')
1730 #ifndef VMS4_4
1731 /* VMS pre V4.4,convert '-'s in filenames. */
1732 if (lbrack == rbrack)
1734 if (dots < 2) /* this is to allow negative version numbers */
1735 p[0] = '_';
1737 else
1738 #endif /* VMS4_4 */
1739 if (lbrack > rbrack &&
1740 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1741 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1742 lose = 1;
1743 #ifndef VMS4_4
1744 else
1745 p[0] = '_';
1746 #endif /* VMS4_4 */
1747 /* count open brackets, reset close bracket pointer */
1748 if (p[0] == '[' || p[0] == '<')
1749 lbrack++, brack = 0;
1750 /* count close brackets, set close bracket pointer */
1751 if (p[0] == ']' || p[0] == '>')
1752 rbrack++, brack = p;
1753 /* detect ][ or >< */
1754 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1755 lose = 1;
1756 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1757 nm = p + 1, lose = 1;
1758 if (p[0] == ':' && (colon || slash))
1759 /* if dev1:[dir]dev2:, move nm to dev2: */
1760 if (brack)
1762 nm = brack + 1;
1763 brack = 0;
1765 /* If /name/dev:, move nm to dev: */
1766 else if (slash)
1767 nm = slash + 1;
1768 /* If node::dev:, move colon following dev */
1769 else if (colon && colon[-1] == ':')
1770 colon = p;
1771 /* If dev1:dev2:, move nm to dev2: */
1772 else if (colon && colon[-1] != ':')
1774 nm = colon + 1;
1775 colon = 0;
1777 if (p[0] == ':' && !colon)
1779 if (p[1] == ':')
1780 p++;
1781 colon = p;
1783 if (lbrack == rbrack)
1784 if (p[0] == ';')
1785 dots = 2;
1786 else if (p[0] == '.')
1787 dots++;
1788 #endif /* VMS */
1789 p++;
1791 if (!lose)
1793 #ifdef VMS
1794 if (index (nm, '/'))
1795 return build_string (sys_translate_unix (nm));
1796 #endif /* VMS */
1797 if (nm == XSTRING (name)->data)
1798 return name;
1799 return build_string (nm);
1803 /* Now determine directory to start with and put it in NEWDIR */
1805 newdir = 0;
1807 if (nm[0] == '~') /* prefix ~ */
1808 if (nm[1] == '/'
1809 #ifdef VMS
1810 || nm[1] == ':'
1811 #endif /* VMS */
1812 || nm[1] == 0)/* ~/filename */
1814 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1815 newdir = (unsigned char *) "";
1816 nm++;
1817 #ifdef VMS
1818 nm++; /* Don't leave the slash in nm. */
1819 #endif /* VMS */
1821 else /* ~user/filename */
1823 /* Get past ~ to user */
1824 unsigned char *user = nm + 1;
1825 /* Find end of name. */
1826 unsigned char *ptr = (unsigned char *) index (user, '/');
1827 int len = ptr ? ptr - user : strlen (user);
1828 #ifdef VMS
1829 unsigned char *ptr1 = index (user, ':');
1830 if (ptr1 != 0 && ptr1 - user < len)
1831 len = ptr1 - user;
1832 #endif /* VMS */
1833 /* Copy the user name into temp storage. */
1834 o = (unsigned char *) alloca (len + 1);
1835 bcopy ((char *) user, o, len);
1836 o[len] = 0;
1838 /* Look up the user name. */
1839 pw = (struct passwd *) getpwnam (o + 1);
1840 if (!pw)
1841 error ("\"%s\" isn't a registered user", o + 1);
1843 newdir = (unsigned char *) pw->pw_dir;
1845 /* Discard the user name from NM. */
1846 nm += len;
1849 if (nm[0] != '/'
1850 #ifdef VMS
1851 && !index (nm, ':')
1852 #endif /* not VMS */
1853 && !newdir)
1855 if (NILP (defalt))
1856 defalt = current_buffer->directory;
1857 CHECK_STRING (defalt, 1);
1858 newdir = XSTRING (defalt)->data;
1861 /* Now concatenate the directory and name to new space in the stack frame */
1863 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1864 target = (unsigned char *) alloca (tlen);
1865 *target = 0;
1867 if (newdir)
1869 #ifndef VMS
1870 if (nm[0] == 0 || nm[0] == '/')
1871 strcpy (target, newdir);
1872 else
1873 #endif
1874 file_name_as_directory (target, newdir);
1877 strcat (target, nm);
1878 #ifdef VMS
1879 if (index (target, '/'))
1880 strcpy (target, sys_translate_unix (target));
1881 #endif /* VMS */
1883 /* Now canonicalize by removing /. and /foo/.. if they appear */
1885 p = target;
1886 o = target;
1888 while (*p)
1890 #ifdef VMS
1891 if (*p != ']' && *p != '>' && *p != '-')
1893 if (*p == '\\')
1894 p++;
1895 *o++ = *p++;
1897 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1898 /* brackets are offset from each other by 2 */
1900 p += 2;
1901 if (*p != '.' && *p != '-' && o[-1] != '.')
1902 /* convert [foo][bar] to [bar] */
1903 while (o[-1] != '[' && o[-1] != '<')
1904 o--;
1905 else if (*p == '-' && *o != '.')
1906 *--p = '.';
1908 else if (p[0] == '-' && o[-1] == '.' &&
1909 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1910 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1913 o--;
1914 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1915 if (p[1] == '.') /* foo.-.bar ==> bar. */
1916 p += 2;
1917 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1918 p++, o--;
1919 /* else [foo.-] ==> [-] */
1921 else
1923 #ifndef VMS4_4
1924 if (*p == '-' &&
1925 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1926 p[1] != ']' && p[1] != '>' && p[1] != '.')
1927 *p = '_';
1928 #endif /* VMS4_4 */
1929 *o++ = *p++;
1931 #else /* not VMS */
1932 if (*p != '/')
1934 *o++ = *p++;
1936 else if (!strncmp (p, "//", 2)
1937 #ifdef APOLLO
1938 /* // at start of filename is meaningful in Apollo system. */
1939 && o != target
1940 #endif /* APOLLO */
1943 o = target;
1944 p++;
1946 else if (p[0] == '/' && p[1] == '.' &&
1947 (p[2] == '/' || p[2] == 0))
1948 p += 2;
1949 else if (!strncmp (p, "/..", 3)
1950 /* `/../' is the "superroot" on certain file systems. */
1951 && o != target
1952 && (p[3] == '/' || p[3] == 0))
1954 while (o != target && *--o != '/')
1956 #ifdef APOLLO
1957 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
1958 ++o;
1959 else
1960 #endif /* APOLLO */
1961 if (o == target && *o == '/')
1962 ++o;
1963 p += 3;
1965 else
1967 *o++ = *p++;
1969 #endif /* not VMS */
1972 return make_string (target, o - target);
1974 #endif
1976 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
1977 Ssubstitute_in_file_name, 1, 1, 0,
1978 "Substitute environment variables referred to in FILENAME.\n\
1979 `$FOO' where FOO is an environment variable name means to substitute\n\
1980 the value of that variable. The variable name should be terminated\n\
1981 with a character not a letter, digit or underscore; otherwise, enclose\n\
1982 the entire variable name in braces.\n\
1983 If `/~' appears, all of FILENAME through that `/' is discarded.\n\n\
1984 On VMS, `$' substitution is not done; this function does little and only\n\
1985 duplicates what `expand-file-name' does.")
1986 (filename)
1987 Lisp_Object filename;
1989 unsigned char *nm;
1991 register unsigned char *s, *p, *o, *x, *endp;
1992 unsigned char *target = NULL;
1993 int total = 0;
1994 int substituted = 0;
1995 unsigned char *xnm;
1996 Lisp_Object handler;
1998 CHECK_STRING (filename, 0);
2000 /* If the file name has special constructs in it,
2001 call the corresponding file handler. */
2002 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2003 if (!NILP (handler))
2004 return call2 (handler, Qsubstitute_in_file_name, filename);
2006 nm = XSTRING (filename)->data;
2007 #ifdef DOS_NT
2008 nm = strcpy (alloca (strlen (nm) + 1), nm);
2009 CORRECT_DIR_SEPS (nm);
2010 substituted = (strcmp (nm, XSTRING (filename)->data) != 0);
2011 #endif
2012 endp = nm + STRING_BYTES (XSTRING (filename));
2014 /* If /~ or // appears, discard everything through first slash. */
2016 for (p = nm; p != endp; p++)
2018 if ((p[0] == '~'
2019 #if defined (APOLLO) || defined (WINDOWSNT)
2020 /* // at start of file name is meaningful in Apollo and
2021 WindowsNT systems. */
2022 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != nm)
2023 #else /* not (APOLLO || WINDOWSNT) */
2024 || IS_DIRECTORY_SEP (p[0])
2025 #endif /* not (APOLLO || WINDOWSNT) */
2027 && p != nm
2028 && (0
2029 #ifdef VMS
2030 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2031 #endif /* VMS */
2032 || IS_DIRECTORY_SEP (p[-1])))
2034 nm = p;
2035 substituted = 1;
2037 #ifdef DOS_NT
2038 /* see comment in expand-file-name about drive specifiers */
2039 else if (IS_DRIVE (p[0]) && p[1] == ':'
2040 && p > nm && IS_DIRECTORY_SEP (p[-1]))
2042 nm = p;
2043 substituted = 1;
2045 #endif /* DOS_NT */
2048 #ifdef VMS
2049 return build_string (nm);
2050 #else
2052 /* See if any variables are substituted into the string
2053 and find the total length of their values in `total' */
2055 for (p = nm; p != endp;)
2056 if (*p != '$')
2057 p++;
2058 else
2060 p++;
2061 if (p == endp)
2062 goto badsubst;
2063 else if (*p == '$')
2065 /* "$$" means a single "$" */
2066 p++;
2067 total -= 1;
2068 substituted = 1;
2069 continue;
2071 else if (*p == '{')
2073 o = ++p;
2074 while (p != endp && *p != '}') p++;
2075 if (*p != '}') goto missingclose;
2076 s = p;
2078 else
2080 o = p;
2081 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2082 s = p;
2085 /* Copy out the variable name */
2086 target = (unsigned char *) alloca (s - o + 1);
2087 strncpy (target, o, s - o);
2088 target[s - o] = 0;
2089 #ifdef DOS_NT
2090 strupr (target); /* $home == $HOME etc. */
2091 #endif /* DOS_NT */
2093 /* Get variable value */
2094 o = (unsigned char *) egetenv (target);
2095 if (!o) goto badvar;
2096 total += strlen (o);
2097 substituted = 1;
2100 if (!substituted)
2101 return filename;
2103 /* If substitution required, recopy the string and do it */
2104 /* Make space in stack frame for the new copy */
2105 xnm = (unsigned char *) alloca (STRING_BYTES (XSTRING (filename)) + total + 1);
2106 x = xnm;
2108 /* Copy the rest of the name through, replacing $ constructs with values */
2109 for (p = nm; *p;)
2110 if (*p != '$')
2111 *x++ = *p++;
2112 else
2114 p++;
2115 if (p == endp)
2116 goto badsubst;
2117 else if (*p == '$')
2119 *x++ = *p++;
2120 continue;
2122 else if (*p == '{')
2124 o = ++p;
2125 while (p != endp && *p != '}') p++;
2126 if (*p != '}') goto missingclose;
2127 s = p++;
2129 else
2131 o = p;
2132 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2133 s = p;
2136 /* Copy out the variable name */
2137 target = (unsigned char *) alloca (s - o + 1);
2138 strncpy (target, o, s - o);
2139 target[s - o] = 0;
2140 #ifdef DOS_NT
2141 strupr (target); /* $home == $HOME etc. */
2142 #endif /* DOS_NT */
2144 /* Get variable value */
2145 o = (unsigned char *) egetenv (target);
2146 if (!o)
2147 goto badvar;
2149 if (STRING_MULTIBYTE (filename))
2151 /* If the original string is multibyte,
2152 convert what we substitute into multibyte. */
2153 while (*o)
2155 int c = unibyte_char_to_multibyte (*o++);
2156 x += CHAR_STRING (c, x);
2159 else
2161 strcpy (x, o);
2162 x += strlen (o);
2166 *x = 0;
2168 /* If /~ or // appears, discard everything through first slash. */
2170 for (p = xnm; p != x; p++)
2171 if ((p[0] == '~'
2172 #if defined (APOLLO) || defined (WINDOWSNT)
2173 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != xnm)
2174 #else /* not (APOLLO || WINDOWSNT) */
2175 || IS_DIRECTORY_SEP (p[0])
2176 #endif /* not (APOLLO || WINDOWSNT) */
2178 && p != xnm && IS_DIRECTORY_SEP (p[-1]))
2179 xnm = p;
2180 #ifdef DOS_NT
2181 else if (IS_DRIVE (p[0]) && p[1] == ':'
2182 && p > xnm && IS_DIRECTORY_SEP (p[-1]))
2183 xnm = p;
2184 #endif
2186 if (STRING_MULTIBYTE (filename))
2187 return make_string (xnm, x - xnm);
2188 return make_unibyte_string (xnm, x - xnm);
2190 badsubst:
2191 error ("Bad format environment-variable substitution");
2192 missingclose:
2193 error ("Missing \"}\" in environment-variable substitution");
2194 badvar:
2195 error ("Substituting nonexistent environment variable \"%s\"", target);
2197 /* NOTREACHED */
2198 #endif /* not VMS */
2199 return Qnil;
2202 /* A slightly faster and more convenient way to get
2203 (directory-file-name (expand-file-name FOO)). */
2205 Lisp_Object
2206 expand_and_dir_to_file (filename, defdir)
2207 Lisp_Object filename, defdir;
2209 register Lisp_Object absname;
2211 absname = Fexpand_file_name (filename, defdir);
2212 #ifdef VMS
2214 register int c = XSTRING (absname)->data[STRING_BYTES (XSTRING (absname)) - 1];
2215 if (c == ':' || c == ']' || c == '>')
2216 absname = Fdirectory_file_name (absname);
2218 #else
2219 /* Remove final slash, if any (unless this is the root dir).
2220 stat behaves differently depending! */
2221 if (XSTRING (absname)->size > 1
2222 && IS_DIRECTORY_SEP (XSTRING (absname)->data[STRING_BYTES (XSTRING (absname)) - 1])
2223 && !IS_DEVICE_SEP (XSTRING (absname)->data[STRING_BYTES (XSTRING (absname))-2]))
2224 /* We cannot take shortcuts; they might be wrong for magic file names. */
2225 absname = Fdirectory_file_name (absname);
2226 #endif
2227 return absname;
2230 /* Signal an error if the file ABSNAME already exists.
2231 If INTERACTIVE is nonzero, ask the user whether to proceed,
2232 and bypass the error if the user says to go ahead.
2233 QUERYSTRING is a name for the action that is being considered
2234 to alter the file.
2236 *STATPTR is used to store the stat information if the file exists.
2237 If the file does not exist, STATPTR->st_mode is set to 0.
2238 If STATPTR is null, we don't store into it.
2240 If QUICK is nonzero, we ask for y or n, not yes or no. */
2242 void
2243 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2244 Lisp_Object absname;
2245 unsigned char *querystring;
2246 int interactive;
2247 struct stat *statptr;
2248 int quick;
2250 register Lisp_Object tem, encoded_filename;
2251 struct stat statbuf;
2252 struct gcpro gcpro1;
2254 encoded_filename = ENCODE_FILE (absname);
2256 /* stat is a good way to tell whether the file exists,
2257 regardless of what access permissions it has. */
2258 if (stat (XSTRING (encoded_filename)->data, &statbuf) >= 0)
2260 if (! interactive)
2261 Fsignal (Qfile_already_exists,
2262 Fcons (build_string ("File already exists"),
2263 Fcons (absname, Qnil)));
2264 GCPRO1 (absname);
2265 tem = format1 ("File %s already exists; %s anyway? ",
2266 XSTRING (absname)->data, querystring);
2267 if (quick)
2268 tem = Fy_or_n_p (tem);
2269 else
2270 tem = do_yes_or_no_p (tem);
2271 UNGCPRO;
2272 if (NILP (tem))
2273 Fsignal (Qfile_already_exists,
2274 Fcons (build_string ("File already exists"),
2275 Fcons (absname, Qnil)));
2276 if (statptr)
2277 *statptr = statbuf;
2279 else
2281 if (statptr)
2282 statptr->st_mode = 0;
2284 return;
2287 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 4,
2288 "fCopy file: \nFCopy %s to file: \np\nP",
2289 "Copy FILE to NEWNAME. Both args must be strings.\n\
2290 Signals a `file-already-exists' error if file NEWNAME already exists,\n\
2291 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.\n\
2292 A number as third arg means request confirmation if NEWNAME already exists.\n\
2293 This is what happens in interactive use with M-x.\n\
2294 Fourth arg KEEP-TIME non-nil means give the new file the same\n\
2295 last-modified time as the old one. (This works on only some systems.)\n\
2296 A prefix arg makes KEEP-TIME non-nil.")
2297 (file, newname, ok_if_already_exists, keep_time)
2298 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2300 int ifd, ofd, n;
2301 char buf[16 * 1024];
2302 struct stat st, out_st;
2303 Lisp_Object handler;
2304 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2305 int count = specpdl_ptr - specpdl;
2306 int input_file_statable_p;
2307 Lisp_Object encoded_file, encoded_newname;
2309 encoded_file = encoded_newname = Qnil;
2310 GCPRO4 (file, newname, encoded_file, encoded_newname);
2311 CHECK_STRING (file, 0);
2312 CHECK_STRING (newname, 1);
2314 file = Fexpand_file_name (file, Qnil);
2315 newname = Fexpand_file_name (newname, Qnil);
2317 /* If the input file name has special constructs in it,
2318 call the corresponding file handler. */
2319 handler = Ffind_file_name_handler (file, Qcopy_file);
2320 /* Likewise for output file name. */
2321 if (NILP (handler))
2322 handler = Ffind_file_name_handler (newname, Qcopy_file);
2323 if (!NILP (handler))
2324 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2325 ok_if_already_exists, keep_time));
2327 encoded_file = ENCODE_FILE (file);
2328 encoded_newname = ENCODE_FILE (newname);
2330 if (NILP (ok_if_already_exists)
2331 || INTEGERP (ok_if_already_exists))
2332 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2333 INTEGERP (ok_if_already_exists), &out_st, 0);
2334 else if (stat (XSTRING (encoded_newname)->data, &out_st) < 0)
2335 out_st.st_mode = 0;
2337 #ifdef WINDOWSNT
2338 if (!CopyFile (XSTRING (encoded_file)->data,
2339 XSTRING (encoded_newname)->data,
2340 FALSE))
2341 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2342 else if (NILP (keep_time))
2344 EMACS_TIME now;
2345 EMACS_GET_TIME (now);
2346 if (set_file_times (XSTRING (encoded_newname)->data,
2347 now, now))
2348 Fsignal (Qfile_date_error,
2349 Fcons (build_string ("Cannot set file date"),
2350 Fcons (newname, Qnil)));
2352 #else /* not WINDOWSNT */
2353 ifd = emacs_open (XSTRING (encoded_file)->data, O_RDONLY, 0);
2354 if (ifd < 0)
2355 report_file_error ("Opening input file", Fcons (file, Qnil));
2357 record_unwind_protect (close_file_unwind, make_number (ifd));
2359 /* We can only copy regular files and symbolic links. Other files are not
2360 copyable by us. */
2361 input_file_statable_p = (fstat (ifd, &st) >= 0);
2363 #if !defined (DOS_NT) || __DJGPP__ > 1
2364 if (out_st.st_mode != 0
2365 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2367 errno = 0;
2368 report_file_error ("Input and output files are the same",
2369 Fcons (file, Fcons (newname, Qnil)));
2371 #endif
2373 #if defined (S_ISREG) && defined (S_ISLNK)
2374 if (input_file_statable_p)
2376 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2378 #if defined (EISDIR)
2379 /* Get a better looking error message. */
2380 errno = EISDIR;
2381 #endif /* EISDIR */
2382 report_file_error ("Non-regular file", Fcons (file, Qnil));
2385 #endif /* S_ISREG && S_ISLNK */
2387 #ifdef VMS
2388 /* Create the copy file with the same record format as the input file */
2389 ofd = sys_creat (XSTRING (encoded_newname)->data, 0666, ifd);
2390 #else
2391 #ifdef MSDOS
2392 /* System's default file type was set to binary by _fmode in emacs.c. */
2393 ofd = creat (XSTRING (encoded_newname)->data, S_IREAD | S_IWRITE);
2394 #else /* not MSDOS */
2395 ofd = creat (XSTRING (encoded_newname)->data, 0666);
2396 #endif /* not MSDOS */
2397 #endif /* VMS */
2398 if (ofd < 0)
2399 report_file_error ("Opening output file", Fcons (newname, Qnil));
2401 record_unwind_protect (close_file_unwind, make_number (ofd));
2403 immediate_quit = 1;
2404 QUIT;
2405 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2406 if (emacs_write (ofd, buf, n) != n)
2407 report_file_error ("I/O error", Fcons (newname, Qnil));
2408 immediate_quit = 0;
2410 /* Closing the output clobbers the file times on some systems. */
2411 if (emacs_close (ofd) < 0)
2412 report_file_error ("I/O error", Fcons (newname, Qnil));
2414 if (input_file_statable_p)
2416 if (!NILP (keep_time))
2418 EMACS_TIME atime, mtime;
2419 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2420 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2421 if (set_file_times (XSTRING (encoded_newname)->data,
2422 atime, mtime))
2423 Fsignal (Qfile_date_error,
2424 Fcons (build_string ("Cannot set file date"),
2425 Fcons (newname, Qnil)));
2427 #ifndef MSDOS
2428 chmod (XSTRING (encoded_newname)->data, st.st_mode & 07777);
2429 #else /* MSDOS */
2430 #if defined (__DJGPP__) && __DJGPP__ > 1
2431 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2432 and if it can't, it tells so. Otherwise, under MSDOS we usually
2433 get only the READ bit, which will make the copied file read-only,
2434 so it's better not to chmod at all. */
2435 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2436 chmod (XSTRING (encoded_newname)->data, st.st_mode & 07777);
2437 #endif /* DJGPP version 2 or newer */
2438 #endif /* MSDOS */
2441 emacs_close (ifd);
2442 #endif /* WINDOWSNT */
2444 /* Discard the unwind protects. */
2445 specpdl_ptr = specpdl + count;
2447 UNGCPRO;
2448 return Qnil;
2451 DEFUN ("make-directory-internal", Fmake_directory_internal,
2452 Smake_directory_internal, 1, 1, 0,
2453 "Create a new directory named DIRECTORY.")
2454 (directory)
2455 Lisp_Object directory;
2457 unsigned char *dir;
2458 Lisp_Object handler;
2459 Lisp_Object encoded_dir;
2461 CHECK_STRING (directory, 0);
2462 directory = Fexpand_file_name (directory, Qnil);
2464 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2465 if (!NILP (handler))
2466 return call2 (handler, Qmake_directory_internal, directory);
2468 encoded_dir = ENCODE_FILE (directory);
2470 dir = XSTRING (encoded_dir)->data;
2472 #ifdef WINDOWSNT
2473 if (mkdir (dir) != 0)
2474 #else
2475 if (mkdir (dir, 0777) != 0)
2476 #endif
2477 report_file_error ("Creating directory", Flist (1, &directory));
2479 return Qnil;
2482 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2483 "Delete the directory named DIRECTORY.")
2484 (directory)
2485 Lisp_Object directory;
2487 unsigned char *dir;
2488 Lisp_Object handler;
2489 Lisp_Object encoded_dir;
2491 CHECK_STRING (directory, 0);
2492 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2494 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2495 if (!NILP (handler))
2496 return call2 (handler, Qdelete_directory, directory);
2498 encoded_dir = ENCODE_FILE (directory);
2500 dir = XSTRING (encoded_dir)->data;
2502 if (rmdir (dir) != 0)
2503 report_file_error ("Removing directory", Flist (1, &directory));
2505 return Qnil;
2508 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2509 "Delete file named FILENAME.\n\
2510 If file has multiple names, it continues to exist with the other names.")
2511 (filename)
2512 Lisp_Object filename;
2514 Lisp_Object handler;
2515 Lisp_Object encoded_file;
2517 CHECK_STRING (filename, 0);
2518 filename = Fexpand_file_name (filename, Qnil);
2520 handler = Ffind_file_name_handler (filename, Qdelete_file);
2521 if (!NILP (handler))
2522 return call2 (handler, Qdelete_file, filename);
2524 encoded_file = ENCODE_FILE (filename);
2526 if (0 > unlink (XSTRING (encoded_file)->data))
2527 report_file_error ("Removing old name", Flist (1, &filename));
2528 return Qnil;
2531 static Lisp_Object
2532 internal_delete_file_1 (ignore)
2533 Lisp_Object ignore;
2535 return Qt;
2538 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2541 internal_delete_file (filename)
2542 Lisp_Object filename;
2544 return NILP (internal_condition_case_1 (Fdelete_file, filename,
2545 Qt, internal_delete_file_1));
2548 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2549 "fRename file: \nFRename %s to file: \np",
2550 "Rename FILE as NEWNAME. Both args strings.\n\
2551 If file has names other than FILE, it continues to have those names.\n\
2552 Signals a `file-already-exists' error if a file NEWNAME already exists\n\
2553 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2554 A number as third arg means request confirmation if NEWNAME already exists.\n\
2555 This is what happens in interactive use with M-x.")
2556 (file, newname, ok_if_already_exists)
2557 Lisp_Object file, newname, ok_if_already_exists;
2559 #ifdef NO_ARG_ARRAY
2560 Lisp_Object args[2];
2561 #endif
2562 Lisp_Object handler;
2563 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2564 Lisp_Object encoded_file, encoded_newname;
2566 encoded_file = encoded_newname = Qnil;
2567 GCPRO4 (file, newname, encoded_file, encoded_newname);
2568 CHECK_STRING (file, 0);
2569 CHECK_STRING (newname, 1);
2570 file = Fexpand_file_name (file, Qnil);
2571 newname = Fexpand_file_name (newname, Qnil);
2573 /* If the file name has special constructs in it,
2574 call the corresponding file handler. */
2575 handler = Ffind_file_name_handler (file, Qrename_file);
2576 if (NILP (handler))
2577 handler = Ffind_file_name_handler (newname, Qrename_file);
2578 if (!NILP (handler))
2579 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2580 file, newname, ok_if_already_exists));
2582 encoded_file = ENCODE_FILE (file);
2583 encoded_newname = ENCODE_FILE (newname);
2585 #ifdef DOS_NT
2586 /* If the file names are identical but for the case, don't ask for
2587 confirmation: they simply want to change the letter-case of the
2588 file name. */
2589 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2590 #endif
2591 if (NILP (ok_if_already_exists)
2592 || INTEGERP (ok_if_already_exists))
2593 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2594 INTEGERP (ok_if_already_exists), 0, 0);
2595 #ifndef BSD4_1
2596 if (0 > rename (XSTRING (encoded_file)->data, XSTRING (encoded_newname)->data))
2597 #else
2598 if (0 > link (XSTRING (encoded_file)->data, XSTRING (encoded_newname)->data)
2599 || 0 > unlink (XSTRING (encoded_file)->data))
2600 #endif
2602 if (errno == EXDEV)
2604 Fcopy_file (file, newname,
2605 /* We have already prompted if it was an integer,
2606 so don't have copy-file prompt again. */
2607 NILP (ok_if_already_exists) ? Qnil : Qt, Qt);
2608 Fdelete_file (file);
2610 else
2611 #ifdef NO_ARG_ARRAY
2613 args[0] = file;
2614 args[1] = newname;
2615 report_file_error ("Renaming", Flist (2, args));
2617 #else
2618 report_file_error ("Renaming", Flist (2, &file));
2619 #endif
2621 UNGCPRO;
2622 return Qnil;
2625 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2626 "fAdd name to file: \nFName to add to %s: \np",
2627 "Give FILE additional name NEWNAME. Both args strings.\n\
2628 Signals a `file-already-exists' error if a file NEWNAME already exists\n\
2629 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2630 A number as third arg means request confirmation if NEWNAME already exists.\n\
2631 This is what happens in interactive use with M-x.")
2632 (file, newname, ok_if_already_exists)
2633 Lisp_Object file, newname, ok_if_already_exists;
2635 #ifdef NO_ARG_ARRAY
2636 Lisp_Object args[2];
2637 #endif
2638 Lisp_Object handler;
2639 Lisp_Object encoded_file, encoded_newname;
2640 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2642 GCPRO4 (file, newname, encoded_file, encoded_newname);
2643 encoded_file = encoded_newname = Qnil;
2644 CHECK_STRING (file, 0);
2645 CHECK_STRING (newname, 1);
2646 file = Fexpand_file_name (file, Qnil);
2647 newname = Fexpand_file_name (newname, Qnil);
2649 /* If the file name has special constructs in it,
2650 call the corresponding file handler. */
2651 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2652 if (!NILP (handler))
2653 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2654 newname, ok_if_already_exists));
2656 /* If the new name has special constructs in it,
2657 call the corresponding file handler. */
2658 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2659 if (!NILP (handler))
2660 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2661 newname, ok_if_already_exists));
2663 encoded_file = ENCODE_FILE (file);
2664 encoded_newname = ENCODE_FILE (newname);
2666 if (NILP (ok_if_already_exists)
2667 || INTEGERP (ok_if_already_exists))
2668 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2669 INTEGERP (ok_if_already_exists), 0, 0);
2671 unlink (XSTRING (newname)->data);
2672 if (0 > link (XSTRING (encoded_file)->data, XSTRING (encoded_newname)->data))
2674 #ifdef NO_ARG_ARRAY
2675 args[0] = file;
2676 args[1] = newname;
2677 report_file_error ("Adding new name", Flist (2, args));
2678 #else
2679 report_file_error ("Adding new name", Flist (2, &file));
2680 #endif
2683 UNGCPRO;
2684 return Qnil;
2687 #ifdef S_IFLNK
2688 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2689 "FMake symbolic link to file: \nFMake symbolic link to file %s: \np",
2690 "Make a symbolic link to FILENAME, named LINKNAME. Both args strings.\n\
2691 Signals a `file-already-exists' error if a file LINKNAME already exists\n\
2692 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2693 A number as third arg means request confirmation if LINKNAME already exists.\n\
2694 This happens for interactive use with M-x.")
2695 (filename, linkname, ok_if_already_exists)
2696 Lisp_Object filename, linkname, ok_if_already_exists;
2698 #ifdef NO_ARG_ARRAY
2699 Lisp_Object args[2];
2700 #endif
2701 Lisp_Object handler;
2702 Lisp_Object encoded_filename, encoded_linkname;
2703 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2705 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2706 encoded_filename = encoded_linkname = Qnil;
2707 CHECK_STRING (filename, 0);
2708 CHECK_STRING (linkname, 1);
2709 /* If the link target has a ~, we must expand it to get
2710 a truly valid file name. Otherwise, do not expand;
2711 we want to permit links to relative file names. */
2712 if (XSTRING (filename)->data[0] == '~')
2713 filename = Fexpand_file_name (filename, Qnil);
2714 linkname = Fexpand_file_name (linkname, Qnil);
2716 /* If the file name has special constructs in it,
2717 call the corresponding file handler. */
2718 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2719 if (!NILP (handler))
2720 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2721 linkname, ok_if_already_exists));
2723 /* If the new link name has special constructs in it,
2724 call the corresponding file handler. */
2725 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2726 if (!NILP (handler))
2727 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2728 linkname, ok_if_already_exists));
2730 encoded_filename = ENCODE_FILE (filename);
2731 encoded_linkname = ENCODE_FILE (linkname);
2733 if (NILP (ok_if_already_exists)
2734 || INTEGERP (ok_if_already_exists))
2735 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2736 INTEGERP (ok_if_already_exists), 0, 0);
2737 if (0 > symlink (XSTRING (encoded_filename)->data,
2738 XSTRING (encoded_linkname)->data))
2740 /* If we didn't complain already, silently delete existing file. */
2741 if (errno == EEXIST)
2743 unlink (XSTRING (encoded_linkname)->data);
2744 if (0 <= symlink (XSTRING (encoded_filename)->data,
2745 XSTRING (encoded_linkname)->data))
2747 UNGCPRO;
2748 return Qnil;
2752 #ifdef NO_ARG_ARRAY
2753 args[0] = filename;
2754 args[1] = linkname;
2755 report_file_error ("Making symbolic link", Flist (2, args));
2756 #else
2757 report_file_error ("Making symbolic link", Flist (2, &filename));
2758 #endif
2760 UNGCPRO;
2761 return Qnil;
2763 #endif /* S_IFLNK */
2765 #ifdef VMS
2767 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2768 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2769 "Define the job-wide logical name NAME to have the value STRING.\n\
2770 If STRING is nil or a null string, the logical name NAME is deleted.")
2771 (name, string)
2772 Lisp_Object name;
2773 Lisp_Object string;
2775 CHECK_STRING (name, 0);
2776 if (NILP (string))
2777 delete_logical_name (XSTRING (name)->data);
2778 else
2780 CHECK_STRING (string, 1);
2782 if (XSTRING (string)->size == 0)
2783 delete_logical_name (XSTRING (name)->data);
2784 else
2785 define_logical_name (XSTRING (name)->data, XSTRING (string)->data);
2788 return string;
2790 #endif /* VMS */
2792 #ifdef HPUX_NET
2794 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2795 "Open a network connection to PATH using LOGIN as the login string.")
2796 (path, login)
2797 Lisp_Object path, login;
2799 int netresult;
2801 CHECK_STRING (path, 0);
2802 CHECK_STRING (login, 0);
2804 netresult = netunam (XSTRING (path)->data, XSTRING (login)->data);
2806 if (netresult == -1)
2807 return Qnil;
2808 else
2809 return Qt;
2811 #endif /* HPUX_NET */
2813 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2814 1, 1, 0,
2815 "Return t if file FILENAME specifies an absolute file name.\n\
2816 On Unix, this is a name starting with a `/' or a `~'.")
2817 (filename)
2818 Lisp_Object filename;
2820 unsigned char *ptr;
2822 CHECK_STRING (filename, 0);
2823 ptr = XSTRING (filename)->data;
2824 if (IS_DIRECTORY_SEP (*ptr) || *ptr == '~'
2825 #ifdef VMS
2826 /* ??? This criterion is probably wrong for '<'. */
2827 || index (ptr, ':') || index (ptr, '<')
2828 || (*ptr == '[' && (ptr[1] != '-' || (ptr[2] != '.' && ptr[2] != ']'))
2829 && ptr[1] != '.')
2830 #endif /* VMS */
2831 #ifdef DOS_NT
2832 || (IS_DRIVE (*ptr) && ptr[1] == ':' && IS_DIRECTORY_SEP (ptr[2]))
2833 #endif
2835 return Qt;
2836 else
2837 return Qnil;
2840 /* Return nonzero if file FILENAME exists and can be executed. */
2842 static int
2843 check_executable (filename)
2844 char *filename;
2846 #ifdef DOS_NT
2847 int len = strlen (filename);
2848 char *suffix;
2849 struct stat st;
2850 if (stat (filename, &st) < 0)
2851 return 0;
2852 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2853 return ((st.st_mode & S_IEXEC) != 0);
2854 #else
2855 return (S_ISREG (st.st_mode)
2856 && len >= 5
2857 && (stricmp ((suffix = filename + len-4), ".com") == 0
2858 || stricmp (suffix, ".exe") == 0
2859 || stricmp (suffix, ".bat") == 0)
2860 || (st.st_mode & S_IFMT) == S_IFDIR);
2861 #endif /* not WINDOWSNT */
2862 #else /* not DOS_NT */
2863 #ifdef HAVE_EUIDACCESS
2864 return (euidaccess (filename, 1) >= 0);
2865 #else
2866 /* Access isn't quite right because it uses the real uid
2867 and we really want to test with the effective uid.
2868 But Unix doesn't give us a right way to do it. */
2869 return (access (filename, 1) >= 0);
2870 #endif
2871 #endif /* not DOS_NT */
2874 /* Return nonzero if file FILENAME exists and can be written. */
2876 static int
2877 check_writable (filename)
2878 char *filename;
2880 #ifdef MSDOS
2881 struct stat st;
2882 if (stat (filename, &st) < 0)
2883 return 0;
2884 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
2885 #else /* not MSDOS */
2886 #ifdef HAVE_EUIDACCESS
2887 return (euidaccess (filename, 2) >= 0);
2888 #else
2889 /* Access isn't quite right because it uses the real uid
2890 and we really want to test with the effective uid.
2891 But Unix doesn't give us a right way to do it.
2892 Opening with O_WRONLY could work for an ordinary file,
2893 but would lose for directories. */
2894 return (access (filename, 2) >= 0);
2895 #endif
2896 #endif /* not MSDOS */
2899 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2900 "Return t if file FILENAME exists. (This does not mean you can read it.)\n\
2901 See also `file-readable-p' and `file-attributes'.")
2902 (filename)
2903 Lisp_Object filename;
2905 Lisp_Object absname;
2906 Lisp_Object handler;
2907 struct stat statbuf;
2909 CHECK_STRING (filename, 0);
2910 absname = Fexpand_file_name (filename, Qnil);
2912 /* If the file name has special constructs in it,
2913 call the corresponding file handler. */
2914 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
2915 if (!NILP (handler))
2916 return call2 (handler, Qfile_exists_p, absname);
2918 absname = ENCODE_FILE (absname);
2920 return (stat (XSTRING (absname)->data, &statbuf) >= 0) ? Qt : Qnil;
2923 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2924 "Return t if FILENAME can be executed by you.\n\
2925 For a directory, this means you can access files in that directory.")
2926 (filename)
2927 Lisp_Object filename;
2930 Lisp_Object absname;
2931 Lisp_Object handler;
2933 CHECK_STRING (filename, 0);
2934 absname = Fexpand_file_name (filename, Qnil);
2936 /* If the file name has special constructs in it,
2937 call the corresponding file handler. */
2938 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
2939 if (!NILP (handler))
2940 return call2 (handler, Qfile_executable_p, absname);
2942 absname = ENCODE_FILE (absname);
2944 return (check_executable (XSTRING (absname)->data) ? Qt : Qnil);
2947 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
2948 "Return t if file FILENAME exists and you can read it.\n\
2949 See also `file-exists-p' and `file-attributes'.")
2950 (filename)
2951 Lisp_Object filename;
2953 Lisp_Object absname;
2954 Lisp_Object handler;
2955 int desc;
2956 int flags;
2957 struct stat statbuf;
2959 CHECK_STRING (filename, 0);
2960 absname = Fexpand_file_name (filename, Qnil);
2962 /* If the file name has special constructs in it,
2963 call the corresponding file handler. */
2964 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
2965 if (!NILP (handler))
2966 return call2 (handler, Qfile_readable_p, absname);
2968 absname = ENCODE_FILE (absname);
2970 #ifdef DOS_NT
2971 /* Under MS-DOS and Windows, open does not work for directories. */
2972 if (access (XSTRING (absname)->data, 0) == 0)
2973 return Qt;
2974 return Qnil;
2975 #else /* not DOS_NT */
2976 flags = O_RDONLY;
2977 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2978 /* Opening a fifo without O_NONBLOCK can wait.
2979 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2980 except in the case of a fifo, on a system which handles it. */
2981 desc = stat (XSTRING (absname)->data, &statbuf);
2982 if (desc < 0)
2983 return Qnil;
2984 if (S_ISFIFO (statbuf.st_mode))
2985 flags |= O_NONBLOCK;
2986 #endif
2987 desc = emacs_open (XSTRING (absname)->data, flags, 0);
2988 if (desc < 0)
2989 return Qnil;
2990 emacs_close (desc);
2991 return Qt;
2992 #endif /* not DOS_NT */
2995 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2996 on the RT/PC. */
2997 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
2998 "Return t if file FILENAME can be written or created by you.")
2999 (filename)
3000 Lisp_Object filename;
3002 Lisp_Object absname, dir, encoded;
3003 Lisp_Object handler;
3004 struct stat statbuf;
3006 CHECK_STRING (filename, 0);
3007 absname = Fexpand_file_name (filename, Qnil);
3009 /* If the file name has special constructs in it,
3010 call the corresponding file handler. */
3011 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3012 if (!NILP (handler))
3013 return call2 (handler, Qfile_writable_p, absname);
3015 encoded = ENCODE_FILE (absname);
3016 if (stat (XSTRING (encoded)->data, &statbuf) >= 0)
3017 return (check_writable (XSTRING (encoded)->data)
3018 ? Qt : Qnil);
3020 dir = Ffile_name_directory (absname);
3021 #ifdef VMS
3022 if (!NILP (dir))
3023 dir = Fdirectory_file_name (dir);
3024 #endif /* VMS */
3025 #ifdef MSDOS
3026 if (!NILP (dir))
3027 dir = Fdirectory_file_name (dir);
3028 #endif /* MSDOS */
3030 dir = ENCODE_FILE (dir);
3031 #ifdef WINDOWSNT
3032 /* The read-only attribute of the parent directory doesn't affect
3033 whether a file or directory can be created within it. Some day we
3034 should check ACLs though, which do affect this. */
3035 if (stat (XSTRING (dir)->data, &statbuf) < 0)
3036 return Qnil;
3037 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3038 #else
3039 return (check_writable (!NILP (dir) ? (char *) XSTRING (dir)->data : "")
3040 ? Qt : Qnil);
3041 #endif
3044 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3045 "Access file FILENAME, and get an error if that does not work.\n\
3046 The second argument STRING is used in the error message.\n\
3047 If there is no error, we return nil.")
3048 (filename, string)
3049 Lisp_Object filename, string;
3051 Lisp_Object handler, encoded_filename;
3052 int fd;
3054 CHECK_STRING (filename, 0);
3055 CHECK_STRING (string, 1);
3057 /* If the file name has special constructs in it,
3058 call the corresponding file handler. */
3059 handler = Ffind_file_name_handler (filename, Qaccess_file);
3060 if (!NILP (handler))
3061 return call3 (handler, Qaccess_file, filename, string);
3063 encoded_filename = ENCODE_FILE (filename);
3065 fd = emacs_open (XSTRING (encoded_filename)->data, O_RDONLY, 0);
3066 if (fd < 0)
3067 report_file_error (XSTRING (string)->data, Fcons (filename, Qnil));
3068 emacs_close (fd);
3070 return Qnil;
3073 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3074 "Return non-nil if file FILENAME is the name of a symbolic link.\n\
3075 The value is the name of the file to which it is linked.\n\
3076 Otherwise returns nil.")
3077 (filename)
3078 Lisp_Object filename;
3080 #ifdef S_IFLNK
3081 char *buf;
3082 int bufsize;
3083 int valsize;
3084 Lisp_Object val;
3085 Lisp_Object handler;
3087 CHECK_STRING (filename, 0);
3088 filename = Fexpand_file_name (filename, Qnil);
3090 /* If the file name has special constructs in it,
3091 call the corresponding file handler. */
3092 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3093 if (!NILP (handler))
3094 return call2 (handler, Qfile_symlink_p, filename);
3096 filename = ENCODE_FILE (filename);
3098 bufsize = 100;
3099 while (1)
3101 buf = (char *) xmalloc (bufsize);
3102 bzero (buf, bufsize);
3103 valsize = readlink (XSTRING (filename)->data, buf, bufsize);
3104 if (valsize < bufsize) break;
3105 /* Buffer was not long enough */
3106 xfree (buf);
3107 bufsize *= 2;
3109 if (valsize == -1)
3111 xfree (buf);
3112 return Qnil;
3114 val = make_string (buf, valsize);
3115 if (buf[0] == '/' && index (buf, ':'))
3116 val = concat2 (build_string ("/:"), val);
3117 xfree (buf);
3118 val = DECODE_FILE (val);
3119 return val;
3120 #else /* not S_IFLNK */
3121 return Qnil;
3122 #endif /* not S_IFLNK */
3125 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3126 "Return t if FILENAME names an existing directory.\n\
3127 Symbolic links to directories count as directories.\n\
3128 See `file-symlink-p' to distinguish symlinks.")
3129 (filename)
3130 Lisp_Object filename;
3132 register Lisp_Object absname;
3133 struct stat st;
3134 Lisp_Object handler;
3136 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3138 /* If the file name has special constructs in it,
3139 call the corresponding file handler. */
3140 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3141 if (!NILP (handler))
3142 return call2 (handler, Qfile_directory_p, absname);
3144 absname = ENCODE_FILE (absname);
3146 if (stat (XSTRING (absname)->data, &st) < 0)
3147 return Qnil;
3148 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3151 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3152 "Return t if file FILENAME is the name of a directory as a file,\n\
3153 and files in that directory can be opened by you. In order to use a\n\
3154 directory as a buffer's current directory, this predicate must return true.\n\
3155 A directory name spec may be given instead; then the value is t\n\
3156 if the directory so specified exists and really is a readable and\n\
3157 searchable directory.")
3158 (filename)
3159 Lisp_Object filename;
3161 Lisp_Object handler;
3162 int tem;
3163 struct gcpro gcpro1;
3165 /* If the file name has special constructs in it,
3166 call the corresponding file handler. */
3167 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3168 if (!NILP (handler))
3169 return call2 (handler, Qfile_accessible_directory_p, filename);
3171 /* It's an unlikely combination, but yes we really do need to gcpro:
3172 Suppose that file-accessible-directory-p has no handler, but
3173 file-directory-p does have a handler; this handler causes a GC which
3174 relocates the string in `filename'; and finally file-directory-p
3175 returns non-nil. Then we would end up passing a garbaged string
3176 to file-executable-p. */
3177 GCPRO1 (filename);
3178 tem = (NILP (Ffile_directory_p (filename))
3179 || NILP (Ffile_executable_p (filename)));
3180 UNGCPRO;
3181 return tem ? Qnil : Qt;
3184 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3185 "Return t if file FILENAME is the name of a regular file.\n\
3186 This is the sort of file that holds an ordinary stream of data bytes.")
3187 (filename)
3188 Lisp_Object filename;
3190 register Lisp_Object absname;
3191 struct stat st;
3192 Lisp_Object handler;
3194 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3196 /* If the file name has special constructs in it,
3197 call the corresponding file handler. */
3198 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3199 if (!NILP (handler))
3200 return call2 (handler, Qfile_regular_p, absname);
3202 absname = ENCODE_FILE (absname);
3204 #ifdef WINDOWSNT
3206 int result;
3207 Lisp_Object tem = Vw32_get_true_file_attributes;
3209 /* Tell stat to use expensive method to get accurate info. */
3210 Vw32_get_true_file_attributes = Qt;
3211 result = stat (XSTRING (absname)->data, &st);
3212 Vw32_get_true_file_attributes = tem;
3214 if (result < 0)
3215 return Qnil;
3216 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3218 #else
3219 if (stat (XSTRING (absname)->data, &st) < 0)
3220 return Qnil;
3221 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3222 #endif
3225 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3226 "Return mode bits of file named FILENAME, as an integer.")
3227 (filename)
3228 Lisp_Object filename;
3230 Lisp_Object absname;
3231 struct stat st;
3232 Lisp_Object handler;
3234 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3236 /* If the file name has special constructs in it,
3237 call the corresponding file handler. */
3238 handler = Ffind_file_name_handler (absname, Qfile_modes);
3239 if (!NILP (handler))
3240 return call2 (handler, Qfile_modes, absname);
3242 absname = ENCODE_FILE (absname);
3244 if (stat (XSTRING (absname)->data, &st) < 0)
3245 return Qnil;
3246 #if defined (MSDOS) && __DJGPP__ < 2
3247 if (check_executable (XSTRING (absname)->data))
3248 st.st_mode |= S_IEXEC;
3249 #endif /* MSDOS && __DJGPP__ < 2 */
3251 return make_number (st.st_mode & 07777);
3254 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3255 "Set mode bits of file named FILENAME to MODE (an integer).\n\
3256 Only the 12 low bits of MODE are used.")
3257 (filename, mode)
3258 Lisp_Object filename, mode;
3260 Lisp_Object absname, encoded_absname;
3261 Lisp_Object handler;
3263 absname = Fexpand_file_name (filename, current_buffer->directory);
3264 CHECK_NUMBER (mode, 1);
3266 /* If the file name has special constructs in it,
3267 call the corresponding file handler. */
3268 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3269 if (!NILP (handler))
3270 return call3 (handler, Qset_file_modes, absname, mode);
3272 encoded_absname = ENCODE_FILE (absname);
3274 if (chmod (XSTRING (encoded_absname)->data, XINT (mode)) < 0)
3275 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3277 return Qnil;
3280 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3281 "Set the file permission bits for newly created files.\n\
3282 The argument MODE should be an integer; only the low 9 bits are used.\n\
3283 This setting is inherited by subprocesses.")
3284 (mode)
3285 Lisp_Object mode;
3287 CHECK_NUMBER (mode, 0);
3289 umask ((~ XINT (mode)) & 0777);
3291 return Qnil;
3294 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3295 "Return the default file protection for created files.\n\
3296 The value is an integer.")
3299 int realmask;
3300 Lisp_Object value;
3302 realmask = umask (0);
3303 umask (realmask);
3305 XSETINT (value, (~ realmask) & 0777);
3306 return value;
3310 #ifdef __NetBSD__
3311 #define unix 42
3312 #endif
3314 #ifdef unix
3315 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3316 "Tell Unix to finish all pending disk updates.")
3319 sync ();
3320 return Qnil;
3323 #endif /* unix */
3325 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3326 "Return t if file FILE1 is newer than file FILE2.\n\
3327 If FILE1 does not exist, the answer is nil;\n\
3328 otherwise, if FILE2 does not exist, the answer is t.")
3329 (file1, file2)
3330 Lisp_Object file1, file2;
3332 Lisp_Object absname1, absname2;
3333 struct stat st;
3334 int mtime1;
3335 Lisp_Object handler;
3336 struct gcpro gcpro1, gcpro2;
3338 CHECK_STRING (file1, 0);
3339 CHECK_STRING (file2, 0);
3341 absname1 = Qnil;
3342 GCPRO2 (absname1, file2);
3343 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3344 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3345 UNGCPRO;
3347 /* If the file name has special constructs in it,
3348 call the corresponding file handler. */
3349 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3350 if (NILP (handler))
3351 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3352 if (!NILP (handler))
3353 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3355 GCPRO2 (absname1, absname2);
3356 absname1 = ENCODE_FILE (absname1);
3357 absname2 = ENCODE_FILE (absname2);
3358 UNGCPRO;
3360 if (stat (XSTRING (absname1)->data, &st) < 0)
3361 return Qnil;
3363 mtime1 = st.st_mtime;
3365 if (stat (XSTRING (absname2)->data, &st) < 0)
3366 return Qt;
3368 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3371 #ifdef DOS_NT
3372 Lisp_Object Qfind_buffer_file_type;
3373 #endif /* DOS_NT */
3375 #ifndef READ_BUF_SIZE
3376 #define READ_BUF_SIZE (64 << 10)
3377 #endif
3379 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3381 /* This function is called after Lisp functions to decide a coding
3382 system are called, or when they cause an error. Before they are
3383 called, the current buffer is set unibyte and it contains only a
3384 newly inserted text (thus the buffer was empty before the
3385 insertion).
3387 The functions may set markers, overlays, text properties, or even
3388 alter the buffer contents, change the current buffer.
3390 Here, we reset all those changes by:
3391 o set back the current buffer.
3392 o move all markers and overlays to BEG.
3393 o remove all text properties.
3394 o set back the buffer multibyteness. */
3396 static Lisp_Object
3397 decide_coding_unwind (unwind_data)
3398 Lisp_Object unwind_data;
3400 Lisp_Object multibyte, undo_list, buffer;
3402 multibyte = XCAR (unwind_data);
3403 unwind_data = XCDR (unwind_data);
3404 undo_list = XCAR (unwind_data);
3405 buffer = XCDR (unwind_data);
3407 if (current_buffer != XBUFFER (buffer))
3408 set_buffer_internal (XBUFFER (buffer));
3409 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3410 adjust_overlays_for_delete (BEG, Z - BEG);
3411 BUF_INTERVALS (current_buffer) = 0;
3412 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3414 /* Now we are safe to change the buffer's multibyteness directly. */
3415 current_buffer->enable_multibyte_characters = multibyte;
3416 current_buffer->undo_list = undo_list;
3418 return Qnil;
3422 /* Used to pass values from insert-file-contents to read_non_regular. */
3424 static int non_regular_fd;
3425 static int non_regular_inserted;
3426 static int non_regular_nbytes;
3429 /* Read from a non-regular file.
3430 Read non_regular_trytry bytes max from non_regular_fd.
3431 Non_regular_inserted specifies where to put the read bytes.
3432 Value is the number of bytes read. */
3434 static Lisp_Object
3435 read_non_regular ()
3437 int nbytes;
3439 immediate_quit = 1;
3440 QUIT;
3441 nbytes = emacs_read (non_regular_fd,
3442 BEG_ADDR + PT_BYTE - 1 + non_regular_inserted,
3443 non_regular_nbytes);
3444 Fsignal (Qquit, Qnil);
3445 immediate_quit = 0;
3446 return make_number (nbytes);
3450 /* Condition-case handler used when reading from non-regular files
3451 in insert-file-contents. */
3453 static Lisp_Object
3454 read_non_regular_quit ()
3456 return Qnil;
3460 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3461 1, 5, 0,
3462 "Insert contents of file FILENAME after point.\n\
3463 Returns list of absolute file name and number of bytes inserted.\n\
3464 If second argument VISIT is non-nil, the buffer's visited filename\n\
3465 and last save file modtime are set, and it is marked unmodified.\n\
3466 If visiting and the file does not exist, visiting is completed\n\
3467 before the error is signaled.\n\
3468 The optional third and fourth arguments BEG and END\n\
3469 specify what portion of the file to insert.\n\
3470 These arguments count bytes in the file, not characters in the buffer.\n\
3471 If VISIT is non-nil, BEG and END must be nil.\n\
3473 If optional fifth argument REPLACE is non-nil,\n\
3474 it means replace the current buffer contents (in the accessible portion)\n\
3475 with the file contents. This is better than simply deleting and inserting\n\
3476 the whole thing because (1) it preserves some marker positions\n\
3477 and (2) it puts less data in the undo list.\n\
3478 When REPLACE is non-nil, the value is the number of characters actually read,\n\
3479 which is often less than the number of characters to be read.\n\
3481 This does code conversion according to the value of\n\
3482 `coding-system-for-read' or `file-coding-system-alist',\n\
3483 and sets the variable `last-coding-system-used' to the coding system\n\
3484 actually used.")
3485 (filename, visit, beg, end, replace)
3486 Lisp_Object filename, visit, beg, end, replace;
3488 struct stat st;
3489 register int fd;
3490 int inserted = 0;
3491 register int how_much;
3492 register int unprocessed;
3493 int count = BINDING_STACK_SIZE ();
3494 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3495 Lisp_Object handler, val, insval, orig_filename;
3496 Lisp_Object p;
3497 int total = 0;
3498 int not_regular = 0;
3499 unsigned char read_buf[READ_BUF_SIZE];
3500 struct coding_system coding;
3501 unsigned char buffer[1 << 14];
3502 int replace_handled = 0;
3503 int set_coding_system = 0;
3504 int coding_system_decided = 0;
3505 int gap_size;
3506 int read_quit = 0;
3508 if (current_buffer->base_buffer && ! NILP (visit))
3509 error ("Cannot do file visiting in an indirect buffer");
3511 if (!NILP (current_buffer->read_only))
3512 Fbarf_if_buffer_read_only ();
3514 val = Qnil;
3515 p = Qnil;
3516 orig_filename = Qnil;
3518 GCPRO4 (filename, val, p, orig_filename);
3520 CHECK_STRING (filename, 0);
3521 filename = Fexpand_file_name (filename, Qnil);
3523 /* If the file name has special constructs in it,
3524 call the corresponding file handler. */
3525 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3526 if (!NILP (handler))
3528 val = call6 (handler, Qinsert_file_contents, filename,
3529 visit, beg, end, replace);
3530 if (CONSP (val) && CONSP (XCDR (val)))
3531 inserted = XINT (XCAR (XCDR (val)));
3532 goto handled;
3535 orig_filename = filename;
3536 filename = ENCODE_FILE (filename);
3538 fd = -1;
3540 #ifdef WINDOWSNT
3542 Lisp_Object tem = Vw32_get_true_file_attributes;
3544 /* Tell stat to use expensive method to get accurate info. */
3545 Vw32_get_true_file_attributes = Qt;
3546 total = stat (XSTRING (filename)->data, &st);
3547 Vw32_get_true_file_attributes = tem;
3549 if (total < 0)
3550 #else
3551 #ifndef APOLLO
3552 if (stat (XSTRING (filename)->data, &st) < 0)
3553 #else
3554 if ((fd = emacs_open (XSTRING (filename)->data, O_RDONLY, 0)) < 0
3555 || fstat (fd, &st) < 0)
3556 #endif /* not APOLLO */
3557 #endif /* WINDOWSNT */
3559 if (fd >= 0) emacs_close (fd);
3560 badopen:
3561 if (NILP (visit))
3562 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3563 st.st_mtime = -1;
3564 how_much = 0;
3565 if (!NILP (Vcoding_system_for_read))
3566 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3567 goto notfound;
3570 #ifdef S_IFREG
3571 /* This code will need to be changed in order to work on named
3572 pipes, and it's probably just not worth it. So we should at
3573 least signal an error. */
3574 if (!S_ISREG (st.st_mode))
3576 not_regular = 1;
3578 if (! NILP (visit))
3579 goto notfound;
3581 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3582 Fsignal (Qfile_error,
3583 Fcons (build_string ("not a regular file"),
3584 Fcons (orig_filename, Qnil)));
3586 #endif
3588 if (fd < 0)
3589 if ((fd = emacs_open (XSTRING (filename)->data, O_RDONLY, 0)) < 0)
3590 goto badopen;
3592 /* Replacement should preserve point as it preserves markers. */
3593 if (!NILP (replace))
3594 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3596 record_unwind_protect (close_file_unwind, make_number (fd));
3598 /* Supposedly happens on VMS. */
3599 if (! not_regular && st.st_size < 0)
3600 error ("File size is negative");
3602 /* Prevent redisplay optimizations. */
3603 current_buffer->clip_changed = 1;
3605 if (!NILP (visit))
3607 if (!NILP (beg) || !NILP (end))
3608 error ("Attempt to visit less than an entire file");
3609 if (BEG < Z && NILP (replace))
3610 error ("Cannot do file visiting in a non-empty buffer");
3613 if (!NILP (beg))
3614 CHECK_NUMBER (beg, 0);
3615 else
3616 XSETFASTINT (beg, 0);
3618 if (!NILP (end))
3619 CHECK_NUMBER (end, 0);
3620 else
3622 if (! not_regular)
3624 XSETINT (end, st.st_size);
3626 /* Arithmetic overflow can occur if an Emacs integer cannot
3627 represent the file size, or if the calculations below
3628 overflow. The calculations below double the file size
3629 twice, so check that it can be multiplied by 4 safely. */
3630 if (XINT (end) != st.st_size
3631 || ((int) st.st_size * 4) / 4 != st.st_size)
3632 error ("Maximum buffer size exceeded");
3634 /* The file size returned from stat may be zero, but data
3635 may be readable nonetheless, for example when this is a
3636 file in the /proc filesystem. */
3637 if (st.st_size == 0)
3638 XSETINT (end, READ_BUF_SIZE);
3642 if (BEG < Z)
3644 /* Decide the coding system to use for reading the file now
3645 because we can't use an optimized method for handling
3646 `coding:' tag if the current buffer is not empty. */
3647 Lisp_Object val;
3648 val = Qnil;
3650 if (!NILP (Vcoding_system_for_read))
3651 val = Vcoding_system_for_read;
3652 else if (! NILP (replace))
3653 /* In REPLACE mode, we can use the same coding system
3654 that was used to visit the file. */
3655 val = current_buffer->buffer_file_coding_system;
3656 else
3658 /* Don't try looking inside a file for a coding system
3659 specification if it is not seekable. */
3660 if (! not_regular && ! NILP (Vset_auto_coding_function))
3662 /* Find a coding system specified in the heading two
3663 lines or in the tailing several lines of the file.
3664 We assume that the 1K-byte and 3K-byte for heading
3665 and tailing respectively are sufficient for this
3666 purpose. */
3667 int nread;
3669 if (st.st_size <= (1024 * 4))
3670 nread = emacs_read (fd, read_buf, 1024 * 4);
3671 else
3673 nread = emacs_read (fd, read_buf, 1024);
3674 if (nread >= 0)
3676 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3677 report_file_error ("Setting file position",
3678 Fcons (orig_filename, Qnil));
3679 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3683 if (nread < 0)
3684 error ("IO error reading %s: %s",
3685 XSTRING (orig_filename)->data, emacs_strerror (errno));
3686 else if (nread > 0)
3688 struct buffer *prev = current_buffer;
3689 int count1;
3691 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3693 /* The call to temp_output_buffer_setup binds
3694 standard-output. */
3695 count1 = specpdl_ptr - specpdl;
3696 temp_output_buffer_setup (" *code-converting-work*");
3698 set_buffer_internal (XBUFFER (Vstandard_output));
3699 current_buffer->enable_multibyte_characters = Qnil;
3700 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3701 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3702 val = call2 (Vset_auto_coding_function,
3703 filename, make_number (nread));
3704 set_buffer_internal (prev);
3706 /* Remove the binding for standard-output. */
3707 unbind_to (count1, Qnil);
3709 /* Discard the unwind protect for recovering the
3710 current buffer. */
3711 specpdl_ptr--;
3713 /* Rewind the file for the actual read done later. */
3714 if (lseek (fd, 0, 0) < 0)
3715 report_file_error ("Setting file position",
3716 Fcons (orig_filename, Qnil));
3720 if (NILP (val))
3722 /* If we have not yet decided a coding system, check
3723 file-coding-system-alist. */
3724 Lisp_Object args[6], coding_systems;
3726 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3727 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3728 coding_systems = Ffind_operation_coding_system (6, args);
3729 if (CONSP (coding_systems))
3730 val = XCAR (coding_systems);
3734 setup_coding_system (Fcheck_coding_system (val), &coding);
3735 /* Ensure we set Vlast_coding_system_used. */
3736 set_coding_system = 1;
3738 if (NILP (current_buffer->enable_multibyte_characters)
3739 && ! NILP (val))
3740 /* We must suppress all character code conversion except for
3741 end-of-line conversion. */
3742 setup_raw_text_coding_system (&coding);
3744 coding.src_multibyte = 0;
3745 coding.dst_multibyte
3746 = !NILP (current_buffer->enable_multibyte_characters);
3747 coding_system_decided = 1;
3750 /* If requested, replace the accessible part of the buffer
3751 with the file contents. Avoid replacing text at the
3752 beginning or end of the buffer that matches the file contents;
3753 that preserves markers pointing to the unchanged parts.
3755 Here we implement this feature in an optimized way
3756 for the case where code conversion is NOT needed.
3757 The following if-statement handles the case of conversion
3758 in a less optimal way.
3760 If the code conversion is "automatic" then we try using this
3761 method and hope for the best.
3762 But if we discover the need for conversion, we give up on this method
3763 and let the following if-statement handle the replace job. */
3764 if (!NILP (replace)
3765 && BEGV < ZV
3766 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
3768 /* same_at_start and same_at_end count bytes,
3769 because file access counts bytes
3770 and BEG and END count bytes. */
3771 int same_at_start = BEGV_BYTE;
3772 int same_at_end = ZV_BYTE;
3773 int overlap;
3774 /* There is still a possibility we will find the need to do code
3775 conversion. If that happens, we set this variable to 1 to
3776 give up on handling REPLACE in the optimized way. */
3777 int giveup_match_end = 0;
3779 if (XINT (beg) != 0)
3781 if (lseek (fd, XINT (beg), 0) < 0)
3782 report_file_error ("Setting file position",
3783 Fcons (orig_filename, Qnil));
3786 immediate_quit = 1;
3787 QUIT;
3788 /* Count how many chars at the start of the file
3789 match the text at the beginning of the buffer. */
3790 while (1)
3792 int nread, bufpos;
3794 nread = emacs_read (fd, buffer, sizeof buffer);
3795 if (nread < 0)
3796 error ("IO error reading %s: %s",
3797 XSTRING (orig_filename)->data, emacs_strerror (errno));
3798 else if (nread == 0)
3799 break;
3801 if (coding.type == coding_type_undecided)
3802 detect_coding (&coding, buffer, nread);
3803 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
3804 /* We found that the file should be decoded somehow.
3805 Let's give up here. */
3807 giveup_match_end = 1;
3808 break;
3811 if (coding.eol_type == CODING_EOL_UNDECIDED)
3812 detect_eol (&coding, buffer, nread);
3813 if (coding.eol_type != CODING_EOL_UNDECIDED
3814 && coding.eol_type != CODING_EOL_LF)
3815 /* We found that the format of eol should be decoded.
3816 Let's give up here. */
3818 giveup_match_end = 1;
3819 break;
3822 bufpos = 0;
3823 while (bufpos < nread && same_at_start < ZV_BYTE
3824 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3825 same_at_start++, bufpos++;
3826 /* If we found a discrepancy, stop the scan.
3827 Otherwise loop around and scan the next bufferful. */
3828 if (bufpos != nread)
3829 break;
3831 immediate_quit = 0;
3832 /* If the file matches the buffer completely,
3833 there's no need to replace anything. */
3834 if (same_at_start - BEGV_BYTE == XINT (end))
3836 emacs_close (fd);
3837 specpdl_ptr--;
3838 /* Truncate the buffer to the size of the file. */
3839 del_range_1 (same_at_start, same_at_end, 0, 0);
3840 goto handled;
3842 immediate_quit = 1;
3843 QUIT;
3844 /* Count how many chars at the end of the file
3845 match the text at the end of the buffer. But, if we have
3846 already found that decoding is necessary, don't waste time. */
3847 while (!giveup_match_end)
3849 int total_read, nread, bufpos, curpos, trial;
3851 /* At what file position are we now scanning? */
3852 curpos = XINT (end) - (ZV_BYTE - same_at_end);
3853 /* If the entire file matches the buffer tail, stop the scan. */
3854 if (curpos == 0)
3855 break;
3856 /* How much can we scan in the next step? */
3857 trial = min (curpos, sizeof buffer);
3858 if (lseek (fd, curpos - trial, 0) < 0)
3859 report_file_error ("Setting file position",
3860 Fcons (orig_filename, Qnil));
3862 total_read = 0;
3863 while (total_read < trial)
3865 nread = emacs_read (fd, buffer + total_read, trial - total_read);
3866 if (nread < 0)
3867 error ("IO error reading %s: %s",
3868 XSTRING (orig_filename)->data, emacs_strerror (errno));
3869 else if (nread == 0)
3870 break;
3871 total_read += nread;
3874 /* Scan this bufferful from the end, comparing with
3875 the Emacs buffer. */
3876 bufpos = total_read;
3878 /* Compare with same_at_start to avoid counting some buffer text
3879 as matching both at the file's beginning and at the end. */
3880 while (bufpos > 0 && same_at_end > same_at_start
3881 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3882 same_at_end--, bufpos--;
3884 /* If we found a discrepancy, stop the scan.
3885 Otherwise loop around and scan the preceding bufferful. */
3886 if (bufpos != 0)
3888 /* If this discrepancy is because of code conversion,
3889 we cannot use this method; giveup and try the other. */
3890 if (same_at_end > same_at_start
3891 && FETCH_BYTE (same_at_end - 1) >= 0200
3892 && ! NILP (current_buffer->enable_multibyte_characters)
3893 && (CODING_MAY_REQUIRE_DECODING (&coding)))
3894 giveup_match_end = 1;
3895 break;
3898 immediate_quit = 0;
3900 if (! giveup_match_end)
3902 int temp;
3904 /* We win! We can handle REPLACE the optimized way. */
3906 /* Extend the start of non-matching text area to multibyte
3907 character boundary. */
3908 if (! NILP (current_buffer->enable_multibyte_characters))
3909 while (same_at_start > BEGV_BYTE
3910 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3911 same_at_start--;
3913 /* Extend the end of non-matching text area to multibyte
3914 character boundary. */
3915 if (! NILP (current_buffer->enable_multibyte_characters))
3916 while (same_at_end < ZV_BYTE
3917 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3918 same_at_end++;
3920 /* Don't try to reuse the same piece of text twice. */
3921 overlap = (same_at_start - BEGV_BYTE
3922 - (same_at_end + st.st_size - ZV));
3923 if (overlap > 0)
3924 same_at_end += overlap;
3926 /* Arrange to read only the nonmatching middle part of the file. */
3927 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
3928 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
3930 del_range_byte (same_at_start, same_at_end, 0);
3931 /* Insert from the file at the proper position. */
3932 temp = BYTE_TO_CHAR (same_at_start);
3933 SET_PT_BOTH (temp, same_at_start);
3935 /* If display currently starts at beginning of line,
3936 keep it that way. */
3937 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3938 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3940 replace_handled = 1;
3944 /* If requested, replace the accessible part of the buffer
3945 with the file contents. Avoid replacing text at the
3946 beginning or end of the buffer that matches the file contents;
3947 that preserves markers pointing to the unchanged parts.
3949 Here we implement this feature for the case where code conversion
3950 is needed, in a simple way that needs a lot of memory.
3951 The preceding if-statement handles the case of no conversion
3952 in a more optimized way. */
3953 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
3955 int same_at_start = BEGV_BYTE;
3956 int same_at_end = ZV_BYTE;
3957 int overlap;
3958 int bufpos;
3959 /* Make sure that the gap is large enough. */
3960 int bufsize = 2 * st.st_size;
3961 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
3962 int temp;
3964 /* First read the whole file, performing code conversion into
3965 CONVERSION_BUFFER. */
3967 if (lseek (fd, XINT (beg), 0) < 0)
3969 xfree (conversion_buffer);
3970 report_file_error ("Setting file position",
3971 Fcons (orig_filename, Qnil));
3974 total = st.st_size; /* Total bytes in the file. */
3975 how_much = 0; /* Bytes read from file so far. */
3976 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
3977 unprocessed = 0; /* Bytes not processed in previous loop. */
3979 while (how_much < total)
3981 /* try is reserved in some compilers (Microsoft C) */
3982 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
3983 unsigned char *destination = read_buf + unprocessed;
3984 int this;
3986 /* Allow quitting out of the actual I/O. */
3987 immediate_quit = 1;
3988 QUIT;
3989 this = emacs_read (fd, destination, trytry);
3990 immediate_quit = 0;
3992 if (this < 0 || this + unprocessed == 0)
3994 how_much = this;
3995 break;
3998 how_much += this;
4000 if (CODING_MAY_REQUIRE_DECODING (&coding))
4002 int require, result;
4004 this += unprocessed;
4006 /* If we are using more space than estimated,
4007 make CONVERSION_BUFFER bigger. */
4008 require = decoding_buffer_size (&coding, this);
4009 if (inserted + require + 2 * (total - how_much) > bufsize)
4011 bufsize = inserted + require + 2 * (total - how_much);
4012 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4015 /* Convert this batch with results in CONVERSION_BUFFER. */
4016 if (how_much >= total) /* This is the last block. */
4017 coding.mode |= CODING_MODE_LAST_BLOCK;
4018 result = decode_coding (&coding, read_buf,
4019 conversion_buffer + inserted,
4020 this, bufsize - inserted);
4022 /* Save for next iteration whatever we didn't convert. */
4023 unprocessed = this - coding.consumed;
4024 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4025 if (!NILP (current_buffer->enable_multibyte_characters))
4026 this = coding.produced;
4027 else
4028 this = str_as_unibyte (conversion_buffer + inserted,
4029 coding.produced);
4032 inserted += this;
4035 /* At this point, INSERTED is how many characters (i.e. bytes)
4036 are present in CONVERSION_BUFFER.
4037 HOW_MUCH should equal TOTAL,
4038 or should be <= 0 if we couldn't read the file. */
4040 if (how_much < 0)
4042 xfree (conversion_buffer);
4044 if (how_much == -1)
4045 error ("IO error reading %s: %s",
4046 XSTRING (orig_filename)->data, emacs_strerror (errno));
4047 else if (how_much == -2)
4048 error ("maximum buffer size exceeded");
4051 /* Compare the beginning of the converted file
4052 with the buffer text. */
4054 bufpos = 0;
4055 while (bufpos < inserted && same_at_start < same_at_end
4056 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4057 same_at_start++, bufpos++;
4059 /* If the file matches the buffer completely,
4060 there's no need to replace anything. */
4062 if (bufpos == inserted)
4064 xfree (conversion_buffer);
4065 emacs_close (fd);
4066 specpdl_ptr--;
4067 /* Truncate the buffer to the size of the file. */
4068 del_range_byte (same_at_start, same_at_end, 0);
4069 inserted = 0;
4070 goto handled;
4073 /* Extend the start of non-matching text area to multibyte
4074 character boundary. */
4075 if (! NILP (current_buffer->enable_multibyte_characters))
4076 while (same_at_start > BEGV_BYTE
4077 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4078 same_at_start--;
4080 /* Scan this bufferful from the end, comparing with
4081 the Emacs buffer. */
4082 bufpos = inserted;
4084 /* Compare with same_at_start to avoid counting some buffer text
4085 as matching both at the file's beginning and at the end. */
4086 while (bufpos > 0 && same_at_end > same_at_start
4087 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4088 same_at_end--, bufpos--;
4090 /* Extend the end of non-matching text area to multibyte
4091 character boundary. */
4092 if (! NILP (current_buffer->enable_multibyte_characters))
4093 while (same_at_end < ZV_BYTE
4094 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4095 same_at_end++;
4097 /* Don't try to reuse the same piece of text twice. */
4098 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4099 if (overlap > 0)
4100 same_at_end += overlap;
4102 /* If display currently starts at beginning of line,
4103 keep it that way. */
4104 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4105 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4107 /* Replace the chars that we need to replace,
4108 and update INSERTED to equal the number of bytes
4109 we are taking from the file. */
4110 inserted -= (Z_BYTE - same_at_end) + (same_at_start - BEG_BYTE);
4112 if (same_at_end != same_at_start)
4114 del_range_byte (same_at_start, same_at_end, 0);
4115 temp = GPT;
4116 same_at_start = GPT_BYTE;
4118 else
4120 temp = BYTE_TO_CHAR (same_at_start);
4122 /* Insert from the file at the proper position. */
4123 SET_PT_BOTH (temp, same_at_start);
4124 insert_1 (conversion_buffer + same_at_start - BEG_BYTE, inserted,
4125 0, 0, 0);
4126 /* Set `inserted' to the number of inserted characters. */
4127 inserted = PT - temp;
4129 xfree (conversion_buffer);
4130 emacs_close (fd);
4131 specpdl_ptr--;
4133 goto handled;
4136 if (! not_regular)
4138 register Lisp_Object temp;
4140 total = XINT (end) - XINT (beg);
4142 /* Make sure point-max won't overflow after this insertion. */
4143 XSETINT (temp, total);
4144 if (total != XINT (temp))
4145 error ("Maximum buffer size exceeded");
4147 else
4148 /* For a special file, all we can do is guess. */
4149 total = READ_BUF_SIZE;
4151 if (NILP (visit) && total > 0)
4152 prepare_to_modify_buffer (PT, PT, NULL);
4154 move_gap (PT);
4155 if (GAP_SIZE < total)
4156 make_gap (total - GAP_SIZE);
4158 if (XINT (beg) != 0 || !NILP (replace))
4160 if (lseek (fd, XINT (beg), 0) < 0)
4161 report_file_error ("Setting file position",
4162 Fcons (orig_filename, Qnil));
4165 /* In the following loop, HOW_MUCH contains the total bytes read so
4166 far for a regular file, and not changed for a special file. But,
4167 before exiting the loop, it is set to a negative value if I/O
4168 error occurs. */
4169 how_much = 0;
4171 /* Total bytes inserted. */
4172 inserted = 0;
4174 /* Here, we don't do code conversion in the loop. It is done by
4175 code_convert_region after all data are read into the buffer. */
4177 int gap_size = GAP_SIZE;
4179 while (how_much < total)
4181 /* try is reserved in some compilers (Microsoft C) */
4182 int trytry = min (total - how_much, READ_BUF_SIZE);
4183 int this;
4185 if (not_regular)
4187 Lisp_Object val;
4189 /* Maybe make more room. */
4190 if (gap_size < trytry)
4192 make_gap (total - gap_size);
4193 gap_size = GAP_SIZE;
4196 /* Read from the file, capturing `quit'. When an
4197 error occurs, end the loop, and arrange for a quit
4198 to be signaled after decoding the text we read. */
4199 non_regular_fd = fd;
4200 non_regular_inserted = inserted;
4201 non_regular_nbytes = trytry;
4202 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4203 read_non_regular_quit);
4204 if (NILP (val))
4206 read_quit = 1;
4207 break;
4210 this = XINT (val);
4212 else
4214 /* Allow quitting out of the actual I/O. We don't make text
4215 part of the buffer until all the reading is done, so a C-g
4216 here doesn't do any harm. */
4217 immediate_quit = 1;
4218 QUIT;
4219 this = emacs_read (fd, BEG_ADDR + PT_BYTE - 1 + inserted, trytry);
4220 immediate_quit = 0;
4223 if (this <= 0)
4225 how_much = this;
4226 break;
4229 gap_size -= this;
4231 /* For a regular file, where TOTAL is the real size,
4232 count HOW_MUCH to compare with it.
4233 For a special file, where TOTAL is just a buffer size,
4234 so don't bother counting in HOW_MUCH.
4235 (INSERTED is where we count the number of characters inserted.) */
4236 if (! not_regular)
4237 how_much += this;
4238 inserted += this;
4242 /* Make the text read part of the buffer. */
4243 GAP_SIZE -= inserted;
4244 GPT += inserted;
4245 GPT_BYTE += inserted;
4246 ZV += inserted;
4247 ZV_BYTE += inserted;
4248 Z += inserted;
4249 Z_BYTE += inserted;
4251 if (GAP_SIZE > 0)
4252 /* Put an anchor to ensure multi-byte form ends at gap. */
4253 *GPT_ADDR = 0;
4255 emacs_close (fd);
4257 /* Discard the unwind protect for closing the file. */
4258 specpdl_ptr--;
4260 if (how_much < 0)
4261 error ("IO error reading %s: %s",
4262 XSTRING (orig_filename)->data, emacs_strerror (errno));
4264 notfound:
4266 if (! coding_system_decided)
4268 /* The coding system is not yet decided. Decide it by an
4269 optimized method for handling `coding:' tag.
4271 Note that we can get here only if the buffer was empty
4272 before the insertion. */
4273 Lisp_Object val;
4274 val = Qnil;
4276 if (!NILP (Vcoding_system_for_read))
4277 val = Vcoding_system_for_read;
4278 else
4280 /* Since we are sure that the current buffer was empty
4281 before the insertion, we can toggle
4282 enable-multibyte-characters directly here without taking
4283 care of marker adjustment and byte combining problem. By
4284 this way, we can run Lisp program safely before decoding
4285 the inserted text. */
4286 Lisp_Object unwind_data;
4287 int count = specpdl_ptr - specpdl;
4289 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4290 Fcons (current_buffer->undo_list,
4291 Fcurrent_buffer ()));
4292 current_buffer->enable_multibyte_characters = Qnil;
4293 current_buffer->undo_list = Qt;
4294 record_unwind_protect (decide_coding_unwind, unwind_data);
4296 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4298 val = call2 (Vset_auto_coding_function,
4299 filename, make_number (inserted));
4302 if (NILP (val))
4304 /* If the coding system is not yet decided, check
4305 file-coding-system-alist. */
4306 Lisp_Object args[6], coding_systems;
4308 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4309 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4310 coding_systems = Ffind_operation_coding_system (6, args);
4311 if (CONSP (coding_systems))
4312 val = XCAR (coding_systems);
4315 unbind_to (count, Qnil);
4316 inserted = Z_BYTE - BEG_BYTE;
4319 /* The following kludgy code is to avoid some compiler bug.
4320 We can't simply do
4321 setup_coding_system (val, &coding);
4322 on some system. */
4324 struct coding_system temp_coding;
4325 setup_coding_system (val, &temp_coding);
4326 bcopy (&temp_coding, &coding, sizeof coding);
4328 /* Ensure we set Vlast_coding_system_used. */
4329 set_coding_system = 1;
4331 if (NILP (current_buffer->enable_multibyte_characters)
4332 && ! NILP (val))
4333 /* We must suppress all character code conversion except for
4334 end-of-line conversion. */
4335 setup_raw_text_coding_system (&coding);
4336 coding.src_multibyte = 0;
4337 coding.dst_multibyte
4338 = !NILP (current_buffer->enable_multibyte_characters);
4341 if (!NILP (visit)
4342 && (coding.type == coding_type_no_conversion
4343 || coding.type == coding_type_raw_text))
4345 /* Visiting a file with these coding system always make the buffer
4346 unibyte. */
4347 current_buffer->enable_multibyte_characters = Qnil;
4348 coding.dst_multibyte = 0;
4351 if (inserted > 0 || coding.type == coding_type_ccl)
4353 if (CODING_MAY_REQUIRE_DECODING (&coding))
4355 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4356 &coding, 0, 0);
4357 inserted = coding.produced_char;
4359 else
4360 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4361 inserted);
4364 #ifdef DOS_NT
4365 /* Use the conversion type to determine buffer-file-type
4366 (find-buffer-file-type is now used to help determine the
4367 conversion). */
4368 if ((coding.eol_type == CODING_EOL_UNDECIDED
4369 || coding.eol_type == CODING_EOL_LF)
4370 && ! CODING_REQUIRE_DECODING (&coding))
4371 current_buffer->buffer_file_type = Qt;
4372 else
4373 current_buffer->buffer_file_type = Qnil;
4374 #endif
4376 handled:
4378 if (!NILP (visit))
4380 if (!EQ (current_buffer->undo_list, Qt))
4381 current_buffer->undo_list = Qnil;
4382 #ifdef APOLLO
4383 stat (XSTRING (filename)->data, &st);
4384 #endif
4386 if (NILP (handler))
4388 current_buffer->modtime = st.st_mtime;
4389 current_buffer->filename = orig_filename;
4392 SAVE_MODIFF = MODIFF;
4393 current_buffer->auto_save_modified = MODIFF;
4394 XSETFASTINT (current_buffer->save_length, Z - BEG);
4395 #ifdef CLASH_DETECTION
4396 if (NILP (handler))
4398 if (!NILP (current_buffer->file_truename))
4399 unlock_file (current_buffer->file_truename);
4400 unlock_file (filename);
4402 #endif /* CLASH_DETECTION */
4403 if (not_regular)
4404 Fsignal (Qfile_error,
4405 Fcons (build_string ("not a regular file"),
4406 Fcons (orig_filename, Qnil)));
4409 /* Decode file format */
4410 if (inserted > 0)
4412 int empty_undo_list_p = 0;
4414 /* If we're anyway going to discard undo information, don't
4415 record it in the first place. The buffer's undo list at this
4416 point is either nil or t when visiting a file. */
4417 if (!NILP (visit))
4419 empty_undo_list_p = NILP (current_buffer->undo_list);
4420 current_buffer->undo_list = Qt;
4423 insval = call3 (Qformat_decode,
4424 Qnil, make_number (inserted), visit);
4425 CHECK_NUMBER (insval, 0);
4426 inserted = XFASTINT (insval);
4428 if (!NILP (visit))
4429 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4432 if (set_coding_system)
4433 Vlast_coding_system_used = coding.symbol;
4435 /* Call after-change hooks for the inserted text, aside from the case
4436 of normal visiting (not with REPLACE), which is done in a new buffer
4437 "before" the buffer is changed. */
4438 if (inserted > 0 && total > 0
4439 && (NILP (visit) || !NILP (replace)))
4441 signal_after_change (PT, 0, inserted);
4442 update_compositions (PT, PT, CHECK_BORDER);
4445 p = Vafter_insert_file_functions;
4446 while (!NILP (p))
4448 insval = call1 (Fcar (p), make_number (inserted));
4449 if (!NILP (insval))
4451 CHECK_NUMBER (insval, 0);
4452 inserted = XFASTINT (insval);
4454 QUIT;
4455 p = Fcdr (p);
4458 if (!NILP (visit)
4459 && current_buffer->modtime == -1)
4461 /* If visiting nonexistent file, return nil. */
4462 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4465 if (read_quit)
4466 Fsignal (Qquit, Qnil);
4468 /* ??? Retval needs to be dealt with in all cases consistently. */
4469 if (NILP (val))
4470 val = Fcons (orig_filename,
4471 Fcons (make_number (inserted),
4472 Qnil));
4474 RETURN_UNGCPRO (unbind_to (count, val));
4477 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object,
4478 Lisp_Object));
4480 /* If build_annotations switched buffers, switch back to BUF.
4481 Kill the temporary buffer that was selected in the meantime.
4483 Since this kill only the last temporary buffer, some buffers remain
4484 not killed if build_annotations switched buffers more than once.
4485 -- K.Handa */
4487 static Lisp_Object
4488 build_annotations_unwind (buf)
4489 Lisp_Object buf;
4491 Lisp_Object tembuf;
4493 if (XBUFFER (buf) == current_buffer)
4494 return Qnil;
4495 tembuf = Fcurrent_buffer ();
4496 Fset_buffer (buf);
4497 Fkill_buffer (tembuf);
4498 return Qnil;
4501 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4502 "r\nFWrite region to file: \ni\ni\ni\np",
4503 "Write current region into specified file.\n\
4504 When called from a program, takes three arguments:\n\
4505 START, END and FILENAME. START and END are buffer positions.\n\
4506 Optional fourth argument APPEND if non-nil means\n\
4507 append to existing file contents (if any). If it is an integer,\n\
4508 seek to that offset in the file before writing.\n\
4509 Optional fifth argument VISIT if t means\n\
4510 set the last-save-file-modtime of buffer to this file's modtime\n\
4511 and mark buffer not modified.\n\
4512 If VISIT is a string, it is a second file name;\n\
4513 the output goes to FILENAME, but the buffer is marked as visiting VISIT.\n\
4514 VISIT is also the file name to lock and unlock for clash detection.\n\
4515 If VISIT is neither t nor nil nor a string,\n\
4516 that means do not print the \"Wrote file\" message.\n\
4517 The optional sixth arg LOCKNAME, if non-nil, specifies the name to\n\
4518 use for locking and unlocking, overriding FILENAME and VISIT.\n\
4519 The optional seventh arg MUSTBENEW, if non-nil, insists on a check\n\
4520 for an existing file with the same name. If MUSTBENEW is `excl',\n\
4521 that means to get an error if the file already exists; never overwrite.\n\
4522 If MUSTBENEW is neither nil nor `excl', that means ask for\n\
4523 confirmation before overwriting, but do go ahead and overwrite the file\n\
4524 if the user confirms.\n\
4525 Kludgy feature: if START is a string, then that string is written\n\
4526 to the file, instead of any buffer contents, and END is ignored.\n\
4528 This does code conversion according to the value of\n\
4529 `coding-system-for-write', `buffer-file-coding-system', or\n\
4530 `file-coding-system-alist', and sets the variable\n\
4531 `last-coding-system-used' to the coding system actually used.")
4533 (start, end, filename, append, visit, lockname, mustbenew)
4534 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4536 register int desc;
4537 int failure;
4538 int save_errno = 0;
4539 unsigned char *fn;
4540 struct stat st;
4541 int tem;
4542 int count = specpdl_ptr - specpdl;
4543 int count1;
4544 #ifdef VMS
4545 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4546 #endif /* VMS */
4547 Lisp_Object handler;
4548 Lisp_Object visit_file;
4549 Lisp_Object annotations;
4550 Lisp_Object encoded_filename;
4551 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4552 int quietly = !NILP (visit);
4553 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4554 struct buffer *given_buffer;
4555 #ifdef DOS_NT
4556 int buffer_file_type = O_BINARY;
4557 #endif /* DOS_NT */
4558 struct coding_system coding;
4560 if (current_buffer->base_buffer && visiting)
4561 error ("Cannot do file visiting in an indirect buffer");
4563 if (!NILP (start) && !STRINGP (start))
4564 validate_region (&start, &end);
4566 GCPRO4 (start, filename, visit, lockname);
4568 /* Decide the coding-system to encode the data with. */
4570 Lisp_Object val;
4572 if (auto_saving)
4573 val = Qnil;
4574 else if (!NILP (Vcoding_system_for_write))
4575 val = Vcoding_system_for_write;
4576 else
4578 /* If the variable `buffer-file-coding-system' is set locally,
4579 it means that the file was read with some kind of code
4580 conversion or the variable is explicitly set by users. We
4581 had better write it out with the same coding system even if
4582 `enable-multibyte-characters' is nil.
4584 If it is not set locally, we anyway have to convert EOL
4585 format if the default value of `buffer-file-coding-system'
4586 tells that it is not Unix-like (LF only) format. */
4587 int using_default_coding = 0;
4588 int force_raw_text = 0;
4590 val = current_buffer->buffer_file_coding_system;
4591 if (NILP (val)
4592 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4594 val = Qnil;
4595 if (NILP (current_buffer->enable_multibyte_characters))
4596 force_raw_text = 1;
4599 if (NILP (val))
4601 /* Check file-coding-system-alist. */
4602 Lisp_Object args[7], coding_systems;
4604 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4605 args[3] = filename; args[4] = append; args[5] = visit;
4606 args[6] = lockname;
4607 coding_systems = Ffind_operation_coding_system (7, args);
4608 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4609 val = XCDR (coding_systems);
4612 if (NILP (val)
4613 && !NILP (current_buffer->buffer_file_coding_system))
4615 /* If we still have not decided a coding system, use the
4616 default value of buffer-file-coding-system. */
4617 val = current_buffer->buffer_file_coding_system;
4618 using_default_coding = 1;
4621 if (!force_raw_text
4622 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4623 /* Confirm that VAL can surely encode the current region. */
4624 val = call3 (Vselect_safe_coding_system_function, start, end, val);
4626 setup_coding_system (Fcheck_coding_system (val), &coding);
4627 if (coding.eol_type == CODING_EOL_UNDECIDED
4628 && !using_default_coding)
4630 if (! EQ (default_buffer_file_coding.symbol,
4631 buffer_defaults.buffer_file_coding_system))
4632 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4633 &default_buffer_file_coding);
4634 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4636 Lisp_Object subsidiaries;
4638 coding.eol_type = default_buffer_file_coding.eol_type;
4639 subsidiaries = Fget (coding.symbol, Qeol_type);
4640 if (VECTORP (subsidiaries)
4641 && XVECTOR (subsidiaries)->size == 3)
4642 coding.symbol
4643 = XVECTOR (subsidiaries)->contents[coding.eol_type];
4647 if (force_raw_text)
4648 setup_raw_text_coding_system (&coding);
4649 goto done_setup_coding;
4652 setup_coding_system (Fcheck_coding_system (val), &coding);
4654 done_setup_coding:
4655 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4656 coding.mode |= CODING_MODE_SELECTIVE_DISPLAY;
4659 Vlast_coding_system_used = coding.symbol;
4661 filename = Fexpand_file_name (filename, Qnil);
4663 if (! NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4664 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4666 if (STRINGP (visit))
4667 visit_file = Fexpand_file_name (visit, Qnil);
4668 else
4669 visit_file = filename;
4670 UNGCPRO;
4672 annotations = Qnil;
4674 if (NILP (lockname))
4675 lockname = visit_file;
4677 GCPRO5 (start, filename, annotations, visit_file, lockname);
4679 /* If the file name has special constructs in it,
4680 call the corresponding file handler. */
4681 handler = Ffind_file_name_handler (filename, Qwrite_region);
4682 /* If FILENAME has no handler, see if VISIT has one. */
4683 if (NILP (handler) && STRINGP (visit))
4684 handler = Ffind_file_name_handler (visit, Qwrite_region);
4686 if (!NILP (handler))
4688 Lisp_Object val;
4689 val = call6 (handler, Qwrite_region, start, end,
4690 filename, append, visit);
4692 if (visiting)
4694 SAVE_MODIFF = MODIFF;
4695 XSETFASTINT (current_buffer->save_length, Z - BEG);
4696 current_buffer->filename = visit_file;
4698 UNGCPRO;
4699 return val;
4702 /* Special kludge to simplify auto-saving. */
4703 if (NILP (start))
4705 XSETFASTINT (start, BEG);
4706 XSETFASTINT (end, Z);
4709 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
4710 count1 = specpdl_ptr - specpdl;
4712 given_buffer = current_buffer;
4713 annotations = build_annotations (start, end, coding.pre_write_conversion);
4714 if (current_buffer != given_buffer)
4716 XSETFASTINT (start, BEGV);
4717 XSETFASTINT (end, ZV);
4720 #ifdef CLASH_DETECTION
4721 if (!auto_saving)
4723 #if 0 /* This causes trouble for GNUS. */
4724 /* If we've locked this file for some other buffer,
4725 query before proceeding. */
4726 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
4727 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
4728 #endif
4730 lock_file (lockname);
4732 #endif /* CLASH_DETECTION */
4734 encoded_filename = ENCODE_FILE (filename);
4736 fn = XSTRING (encoded_filename)->data;
4737 desc = -1;
4738 if (!NILP (append))
4739 #ifdef DOS_NT
4740 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
4741 #else /* not DOS_NT */
4742 desc = emacs_open (fn, O_WRONLY, 0);
4743 #endif /* not DOS_NT */
4745 if (desc < 0 && (NILP (append) || errno == ENOENT))
4746 #ifdef VMS
4747 if (auto_saving) /* Overwrite any previous version of autosave file */
4749 vms_truncate (fn); /* if fn exists, truncate to zero length */
4750 desc = emacs_open (fn, O_RDWR, 0);
4751 if (desc < 0)
4752 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
4753 ? XSTRING (current_buffer->filename)->data : 0,
4754 fn);
4756 else /* Write to temporary name and rename if no errors */
4758 Lisp_Object temp_name;
4759 temp_name = Ffile_name_directory (filename);
4761 if (!NILP (temp_name))
4763 temp_name = Fmake_temp_name (concat2 (temp_name,
4764 build_string ("$$SAVE$$")));
4765 fname = XSTRING (filename)->data;
4766 fn = XSTRING (temp_name)->data;
4767 desc = creat_copy_attrs (fname, fn);
4768 if (desc < 0)
4770 /* If we can't open the temporary file, try creating a new
4771 version of the original file. VMS "creat" creates a
4772 new version rather than truncating an existing file. */
4773 fn = fname;
4774 fname = 0;
4775 desc = creat (fn, 0666);
4776 #if 0 /* This can clobber an existing file and fail to replace it,
4777 if the user runs out of space. */
4778 if (desc < 0)
4780 /* We can't make a new version;
4781 try to truncate and rewrite existing version if any. */
4782 vms_truncate (fn);
4783 desc = emacs_open (fn, O_RDWR, 0);
4785 #endif
4788 else
4789 desc = creat (fn, 0666);
4791 #else /* not VMS */
4792 #ifdef DOS_NT
4793 desc = emacs_open (fn,
4794 O_WRONLY | O_CREAT | buffer_file_type
4795 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
4796 S_IREAD | S_IWRITE);
4797 #else /* not DOS_NT */
4798 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
4799 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
4800 auto_saving ? auto_save_mode_bits : 0666);
4801 #endif /* not DOS_NT */
4802 #endif /* not VMS */
4804 if (desc < 0)
4806 #ifdef CLASH_DETECTION
4807 save_errno = errno;
4808 if (!auto_saving) unlock_file (lockname);
4809 errno = save_errno;
4810 #endif /* CLASH_DETECTION */
4811 UNGCPRO;
4812 report_file_error ("Opening output file", Fcons (filename, Qnil));
4815 record_unwind_protect (close_file_unwind, make_number (desc));
4817 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
4819 long ret;
4821 if (NUMBERP (append))
4822 ret = lseek (desc, XINT (append), 1);
4823 else
4824 ret = lseek (desc, 0, 2);
4825 if (ret < 0)
4827 #ifdef CLASH_DETECTION
4828 if (!auto_saving) unlock_file (lockname);
4829 #endif /* CLASH_DETECTION */
4830 UNGCPRO;
4831 report_file_error ("Lseek error", Fcons (filename, Qnil));
4835 UNGCPRO;
4837 #ifdef VMS
4839 * Kludge Warning: The VMS C RTL likes to insert carriage returns
4840 * if we do writes that don't end with a carriage return. Furthermore
4841 * it cannot handle writes of more then 16K. The modified
4842 * version of "sys_write" in SYSDEP.C (see comment there) copes with
4843 * this EXCEPT for the last record (iff it doesn't end with a carriage
4844 * return). This implies that if your buffer doesn't end with a carriage
4845 * return, you get one free... tough. However it also means that if
4846 * we make two calls to sys_write (a la the following code) you can
4847 * get one at the gap as well. The easiest way to fix this (honest)
4848 * is to move the gap to the next newline (or the end of the buffer).
4849 * Thus this change.
4851 * Yech!
4853 if (GPT > BEG && GPT_ADDR[-1] != '\n')
4854 move_gap (find_next_newline (GPT, 1));
4855 #else
4856 /* Whether VMS or not, we must move the gap to the next of newline
4857 when we must put designation sequences at beginning of line. */
4858 if (INTEGERP (start)
4859 && coding.type == coding_type_iso2022
4860 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
4861 && GPT > BEG && GPT_ADDR[-1] != '\n')
4863 int opoint = PT, opoint_byte = PT_BYTE;
4864 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
4865 move_gap_both (PT, PT_BYTE);
4866 SET_PT_BOTH (opoint, opoint_byte);
4868 #endif
4870 failure = 0;
4871 immediate_quit = 1;
4873 if (STRINGP (start))
4875 failure = 0 > a_write (desc, start, 0, XSTRING (start)->size,
4876 &annotations, &coding);
4877 save_errno = errno;
4879 else if (XINT (start) != XINT (end))
4881 tem = CHAR_TO_BYTE (XINT (start));
4883 if (XINT (start) < GPT)
4885 failure = 0 > a_write (desc, Qnil, XINT (start),
4886 min (GPT, XINT (end)) - XINT (start),
4887 &annotations, &coding);
4888 save_errno = errno;
4891 if (XINT (end) > GPT && !failure)
4893 tem = max (XINT (start), GPT);
4894 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
4895 &annotations, &coding);
4896 save_errno = errno;
4899 else
4901 /* If file was empty, still need to write the annotations */
4902 coding.mode |= CODING_MODE_LAST_BLOCK;
4903 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
4904 save_errno = errno;
4907 if (CODING_REQUIRE_FLUSHING (&coding)
4908 && !(coding.mode & CODING_MODE_LAST_BLOCK)
4909 && ! failure)
4911 /* We have to flush out a data. */
4912 coding.mode |= CODING_MODE_LAST_BLOCK;
4913 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
4914 save_errno = errno;
4917 immediate_quit = 0;
4919 #ifdef HAVE_FSYNC
4920 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4921 Disk full in NFS may be reported here. */
4922 /* mib says that closing the file will try to write as fast as NFS can do
4923 it, and that means the fsync here is not crucial for autosave files. */
4924 if (!auto_saving && fsync (desc) < 0)
4926 /* If fsync fails with EINTR, don't treat that as serious. */
4927 if (errno != EINTR)
4928 failure = 1, save_errno = errno;
4930 #endif
4932 /* Spurious "file has changed on disk" warnings have been
4933 observed on Suns as well.
4934 It seems that `close' can change the modtime, under nfs.
4936 (This has supposedly been fixed in Sunos 4,
4937 but who knows about all the other machines with NFS?) */
4938 #if 0
4940 /* On VMS and APOLLO, must do the stat after the close
4941 since closing changes the modtime. */
4942 #ifndef VMS
4943 #ifndef APOLLO
4944 /* Recall that #if defined does not work on VMS. */
4945 #define FOO
4946 fstat (desc, &st);
4947 #endif
4948 #endif
4949 #endif
4951 /* NFS can report a write failure now. */
4952 if (emacs_close (desc) < 0)
4953 failure = 1, save_errno = errno;
4955 #ifdef VMS
4956 /* If we wrote to a temporary name and had no errors, rename to real name. */
4957 if (fname)
4959 if (!failure)
4960 failure = (rename (fn, fname) != 0), save_errno = errno;
4961 fn = fname;
4963 #endif /* VMS */
4965 #ifndef FOO
4966 stat (fn, &st);
4967 #endif
4968 /* Discard the unwind protect for close_file_unwind. */
4969 specpdl_ptr = specpdl + count1;
4970 /* Restore the original current buffer. */
4971 visit_file = unbind_to (count, visit_file);
4973 #ifdef CLASH_DETECTION
4974 if (!auto_saving)
4975 unlock_file (lockname);
4976 #endif /* CLASH_DETECTION */
4978 /* Do this before reporting IO error
4979 to avoid a "file has changed on disk" warning on
4980 next attempt to save. */
4981 if (visiting)
4982 current_buffer->modtime = st.st_mtime;
4984 if (failure)
4985 error ("IO error writing %s: %s", XSTRING (filename)->data,
4986 emacs_strerror (save_errno));
4988 if (visiting)
4990 SAVE_MODIFF = MODIFF;
4991 XSETFASTINT (current_buffer->save_length, Z - BEG);
4992 current_buffer->filename = visit_file;
4993 update_mode_lines++;
4995 else if (quietly)
4996 return Qnil;
4998 if (!auto_saving)
4999 message_with_string ("Wrote %s", visit_file, 1);
5001 return Qnil;
5004 Lisp_Object merge ();
5006 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5007 "Return t if (car A) is numerically less than (car B).")
5008 (a, b)
5009 Lisp_Object a, b;
5011 return Flss (Fcar (a), Fcar (b));
5014 /* Build the complete list of annotations appropriate for writing out
5015 the text between START and END, by calling all the functions in
5016 write-region-annotate-functions and merging the lists they return.
5017 If one of these functions switches to a different buffer, we assume
5018 that buffer contains altered text. Therefore, the caller must
5019 make sure to restore the current buffer in all cases,
5020 as save-excursion would do. */
5022 static Lisp_Object
5023 build_annotations (start, end, pre_write_conversion)
5024 Lisp_Object start, end, pre_write_conversion;
5026 Lisp_Object annotations;
5027 Lisp_Object p, res;
5028 struct gcpro gcpro1, gcpro2;
5029 Lisp_Object original_buffer;
5030 int i;
5032 XSETBUFFER (original_buffer, current_buffer);
5034 annotations = Qnil;
5035 p = Vwrite_region_annotate_functions;
5036 GCPRO2 (annotations, p);
5037 while (!NILP (p))
5039 struct buffer *given_buffer = current_buffer;
5040 Vwrite_region_annotations_so_far = annotations;
5041 res = call2 (Fcar (p), start, end);
5042 /* If the function makes a different buffer current,
5043 assume that means this buffer contains altered text to be output.
5044 Reset START and END from the buffer bounds
5045 and discard all previous annotations because they should have
5046 been dealt with by this function. */
5047 if (current_buffer != given_buffer)
5049 XSETFASTINT (start, BEGV);
5050 XSETFASTINT (end, ZV);
5051 annotations = Qnil;
5053 Flength (res); /* Check basic validity of return value */
5054 annotations = merge (annotations, res, Qcar_less_than_car);
5055 p = Fcdr (p);
5058 /* Now do the same for annotation functions implied by the file-format */
5059 if (auto_saving && (!EQ (Vauto_save_file_format, Qt)))
5060 p = Vauto_save_file_format;
5061 else
5062 p = current_buffer->file_format;
5063 for (i = 0; !NILP (p); p = Fcdr (p), ++i)
5065 struct buffer *given_buffer = current_buffer;
5067 Vwrite_region_annotations_so_far = annotations;
5069 /* Value is either a list of annotations or nil if the function
5070 has written annotations to a temporary buffer, which is now
5071 current. */
5072 res = call5 (Qformat_annotate_function, Fcar (p), start, end,
5073 original_buffer, make_number (i));
5074 if (current_buffer != given_buffer)
5076 XSETFASTINT (start, BEGV);
5077 XSETFASTINT (end, ZV);
5078 annotations = Qnil;
5081 if (CONSP (res))
5082 annotations = merge (annotations, res, Qcar_less_than_car);
5085 /* At last, do the same for the function PRE_WRITE_CONVERSION
5086 implied by the current coding-system. */
5087 if (!NILP (pre_write_conversion))
5089 struct buffer *given_buffer = current_buffer;
5090 Vwrite_region_annotations_so_far = annotations;
5091 res = call2 (pre_write_conversion, start, end);
5092 Flength (res);
5093 annotations = (current_buffer != given_buffer
5094 ? res
5095 : merge (annotations, res, Qcar_less_than_car));
5098 UNGCPRO;
5099 return annotations;
5102 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5103 If STRING is nil, POS is the character position in the current buffer.
5104 Intersperse with them the annotations from *ANNOT
5105 which fall within the range of POS to POS + NCHARS,
5106 each at its appropriate position.
5108 We modify *ANNOT by discarding elements as we use them up.
5110 The return value is negative in case of system call failure. */
5112 static int
5113 a_write (desc, string, pos, nchars, annot, coding)
5114 int desc;
5115 Lisp_Object string;
5116 register int nchars;
5117 int pos;
5118 Lisp_Object *annot;
5119 struct coding_system *coding;
5121 Lisp_Object tem;
5122 int nextpos;
5123 int lastpos = pos + nchars;
5125 while (NILP (*annot) || CONSP (*annot))
5127 tem = Fcar_safe (Fcar (*annot));
5128 nextpos = pos - 1;
5129 if (INTEGERP (tem))
5130 nextpos = XFASTINT (tem);
5132 /* If there are no more annotations in this range,
5133 output the rest of the range all at once. */
5134 if (! (nextpos >= pos && nextpos <= lastpos))
5135 return e_write (desc, string, pos, lastpos, coding);
5137 /* Output buffer text up to the next annotation's position. */
5138 if (nextpos > pos)
5140 if (0 > e_write (desc, string, pos, nextpos, coding))
5141 return -1;
5142 pos = nextpos;
5144 /* Output the annotation. */
5145 tem = Fcdr (Fcar (*annot));
5146 if (STRINGP (tem))
5148 if (0 > e_write (desc, tem, 0, XSTRING (tem)->size, coding))
5149 return -1;
5151 *annot = Fcdr (*annot);
5153 return 0;
5156 #ifndef WRITE_BUF_SIZE
5157 #define WRITE_BUF_SIZE (16 * 1024)
5158 #endif
5160 /* Write text in the range START and END into descriptor DESC,
5161 encoding them with coding system CODING. If STRING is nil, START
5162 and END are character positions of the current buffer, else they
5163 are indexes to the string STRING. */
5165 static int
5166 e_write (desc, string, start, end, coding)
5167 int desc;
5168 Lisp_Object string;
5169 int start, end;
5170 struct coding_system *coding;
5172 register char *addr;
5173 register int nbytes;
5174 char buf[WRITE_BUF_SIZE];
5175 int return_val = 0;
5177 if (start >= end)
5178 coding->composing = COMPOSITION_DISABLED;
5179 if (coding->composing != COMPOSITION_DISABLED)
5180 coding_save_composition (coding, start, end, string);
5182 if (STRINGP (string))
5184 addr = XSTRING (string)->data;
5185 nbytes = STRING_BYTES (XSTRING (string));
5186 coding->src_multibyte = STRING_MULTIBYTE (string);
5188 else if (start < end)
5190 /* It is assured that the gap is not in the range START and END-1. */
5191 addr = CHAR_POS_ADDR (start);
5192 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5193 coding->src_multibyte
5194 = !NILP (current_buffer->enable_multibyte_characters);
5196 else
5198 addr = "";
5199 nbytes = 0;
5200 coding->src_multibyte = 1;
5203 /* We used to have a code for handling selective display here. But,
5204 now it is handled within encode_coding. */
5205 while (1)
5207 int result;
5209 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5210 if (coding->produced > 0)
5212 coding->produced -= emacs_write (desc, buf, coding->produced);
5213 if (coding->produced)
5215 return_val = -1;
5216 break;
5219 nbytes -= coding->consumed;
5220 addr += coding->consumed;
5221 if (result == CODING_FINISH_INSUFFICIENT_SRC
5222 && nbytes > 0)
5224 /* The source text ends by an incomplete multibyte form.
5225 There's no way other than write it out as is. */
5226 nbytes -= emacs_write (desc, addr, nbytes);
5227 if (nbytes)
5229 return_val = -1;
5230 break;
5233 if (nbytes <= 0)
5234 break;
5235 start += coding->consumed_char;
5236 if (coding->cmp_data)
5237 coding_adjust_composition_offset (coding, start);
5240 if (coding->cmp_data)
5241 coding_free_composition_data (coding);
5243 return return_val;
5246 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5247 Sverify_visited_file_modtime, 1, 1, 0,
5248 "Return t if last mod time of BUF's visited file matches what BUF records.\n\
5249 This means that the file has not been changed since it was visited or saved.")
5250 (buf)
5251 Lisp_Object buf;
5253 struct buffer *b;
5254 struct stat st;
5255 Lisp_Object handler;
5256 Lisp_Object filename;
5258 CHECK_BUFFER (buf, 0);
5259 b = XBUFFER (buf);
5261 if (!STRINGP (b->filename)) return Qt;
5262 if (b->modtime == 0) return Qt;
5264 /* If the file name has special constructs in it,
5265 call the corresponding file handler. */
5266 handler = Ffind_file_name_handler (b->filename,
5267 Qverify_visited_file_modtime);
5268 if (!NILP (handler))
5269 return call2 (handler, Qverify_visited_file_modtime, buf);
5271 filename = ENCODE_FILE (b->filename);
5273 if (stat (XSTRING (filename)->data, &st) < 0)
5275 /* If the file doesn't exist now and didn't exist before,
5276 we say that it isn't modified, provided the error is a tame one. */
5277 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5278 st.st_mtime = -1;
5279 else
5280 st.st_mtime = 0;
5282 if (st.st_mtime == b->modtime
5283 /* If both are positive, accept them if they are off by one second. */
5284 || (st.st_mtime > 0 && b->modtime > 0
5285 && (st.st_mtime == b->modtime + 1
5286 || st.st_mtime == b->modtime - 1)))
5287 return Qt;
5288 return Qnil;
5291 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5292 Sclear_visited_file_modtime, 0, 0, 0,
5293 "Clear out records of last mod time of visited file.\n\
5294 Next attempt to save will certainly not complain of a discrepancy.")
5297 current_buffer->modtime = 0;
5298 return Qnil;
5301 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5302 Svisited_file_modtime, 0, 0, 0,
5303 "Return the current buffer's recorded visited file modification time.\n\
5304 The value is a list of the form (HIGH . LOW), like the time values\n\
5305 that `file-attributes' returns.")
5308 return long_to_cons ((unsigned long) current_buffer->modtime);
5311 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5312 Sset_visited_file_modtime, 0, 1, 0,
5313 "Update buffer's recorded modification time from the visited file's time.\n\
5314 Useful if the buffer was not read from the file normally\n\
5315 or if the file itself has been changed for some known benign reason.\n\
5316 An argument specifies the modification time value to use\n\
5317 \(instead of that of the visited file), in the form of a list\n\
5318 \(HIGH . LOW) or (HIGH LOW).")
5319 (time_list)
5320 Lisp_Object time_list;
5322 if (!NILP (time_list))
5323 current_buffer->modtime = cons_to_long (time_list);
5324 else
5326 register Lisp_Object filename;
5327 struct stat st;
5328 Lisp_Object handler;
5330 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5332 /* If the file name has special constructs in it,
5333 call the corresponding file handler. */
5334 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5335 if (!NILP (handler))
5336 /* The handler can find the file name the same way we did. */
5337 return call2 (handler, Qset_visited_file_modtime, Qnil);
5339 filename = ENCODE_FILE (filename);
5341 if (stat (XSTRING (filename)->data, &st) >= 0)
5342 current_buffer->modtime = st.st_mtime;
5345 return Qnil;
5348 Lisp_Object
5349 auto_save_error (error)
5350 Lisp_Object error;
5352 Lisp_Object args[3], msg;
5353 int i, nbytes;
5354 struct gcpro gcpro1;
5356 ring_bell ();
5358 args[0] = build_string ("Auto-saving %s: %s");
5359 args[1] = current_buffer->name;
5360 args[2] = Ferror_message_string (error);
5361 msg = Fformat (3, args);
5362 GCPRO1 (msg);
5363 nbytes = STRING_BYTES (XSTRING (msg));
5365 for (i = 0; i < 3; ++i)
5367 if (i == 0)
5368 message2 (XSTRING (msg)->data, nbytes, STRING_MULTIBYTE (msg));
5369 else
5370 message2_nolog (XSTRING (msg)->data, nbytes, STRING_MULTIBYTE (msg));
5371 Fsleep_for (make_number (1), Qnil);
5374 UNGCPRO;
5375 return Qnil;
5378 Lisp_Object
5379 auto_save_1 ()
5381 struct stat st;
5383 /* Get visited file's mode to become the auto save file's mode. */
5384 if (! NILP (current_buffer->filename)
5385 && stat (XSTRING (current_buffer->filename)->data, &st) >= 0)
5386 /* But make sure we can overwrite it later! */
5387 auto_save_mode_bits = st.st_mode | 0600;
5388 else
5389 auto_save_mode_bits = 0666;
5391 return
5392 Fwrite_region (Qnil, Qnil,
5393 current_buffer->auto_save_file_name,
5394 Qnil, Qlambda, Qnil, Qnil);
5397 static Lisp_Object
5398 do_auto_save_unwind (stream) /* used as unwind-protect function */
5399 Lisp_Object stream;
5401 auto_saving = 0;
5402 if (!NILP (stream))
5403 fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
5404 | XFASTINT (XCDR (stream))));
5405 pop_message ();
5406 return Qnil;
5409 static Lisp_Object
5410 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5411 Lisp_Object value;
5413 minibuffer_auto_raise = XINT (value);
5414 return Qnil;
5417 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5418 "Auto-save all buffers that need it.\n\
5419 This is all buffers that have auto-saving enabled\n\
5420 and are changed since last auto-saved.\n\
5421 Auto-saving writes the buffer into a file\n\
5422 so that your editing is not lost if the system crashes.\n\
5423 This file is not the file you visited; that changes only when you save.\n\
5424 Normally we run the normal hook `auto-save-hook' before saving.\n\n\
5425 A non-nil NO-MESSAGE argument means do not print any message if successful.\n\
5426 A non-nil CURRENT-ONLY argument means save only current buffer.")
5427 (no_message, current_only)
5428 Lisp_Object no_message, current_only;
5430 struct buffer *old = current_buffer, *b;
5431 Lisp_Object tail, buf;
5432 int auto_saved = 0;
5433 int do_handled_files;
5434 Lisp_Object oquit;
5435 FILE *stream;
5436 Lisp_Object lispstream;
5437 int count = specpdl_ptr - specpdl;
5438 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5439 int message_p = push_message ();
5441 /* Ordinarily don't quit within this function,
5442 but don't make it impossible to quit (in case we get hung in I/O). */
5443 oquit = Vquit_flag;
5444 Vquit_flag = Qnil;
5446 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5447 point to non-strings reached from Vbuffer_alist. */
5449 if (minibuf_level)
5450 no_message = Qt;
5452 if (!NILP (Vrun_hooks))
5453 call1 (Vrun_hooks, intern ("auto-save-hook"));
5455 if (STRINGP (Vauto_save_list_file_name))
5457 Lisp_Object listfile;
5459 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5461 /* Don't try to create the directory when shutting down Emacs,
5462 because creating the directory might signal an error, and
5463 that would leave Emacs in a strange state. */
5464 if (!NILP (Vrun_hooks))
5466 Lisp_Object dir;
5467 dir = Ffile_name_directory (listfile);
5468 if (NILP (Ffile_directory_p (dir)))
5469 call2 (Qmake_directory, dir, Qt);
5472 stream = fopen (XSTRING (listfile)->data, "w");
5473 if (stream != NULL)
5475 /* Arrange to close that file whether or not we get an error.
5476 Also reset auto_saving to 0. */
5477 lispstream = Fcons (Qnil, Qnil);
5478 XSETFASTINT (XCAR (lispstream), (EMACS_UINT)stream >> 16);
5479 XSETFASTINT (XCDR (lispstream), (EMACS_UINT)stream & 0xffff);
5481 else
5482 lispstream = Qnil;
5484 else
5486 stream = NULL;
5487 lispstream = Qnil;
5490 record_unwind_protect (do_auto_save_unwind, lispstream);
5491 record_unwind_protect (do_auto_save_unwind_1,
5492 make_number (minibuffer_auto_raise));
5493 minibuffer_auto_raise = 0;
5494 auto_saving = 1;
5496 /* First, save all files which don't have handlers. If Emacs is
5497 crashing, the handlers may tweak what is causing Emacs to crash
5498 in the first place, and it would be a shame if Emacs failed to
5499 autosave perfectly ordinary files because it couldn't handle some
5500 ange-ftp'd file. */
5501 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5502 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5504 buf = XCDR (XCAR (tail));
5505 b = XBUFFER (buf);
5507 /* Record all the buffers that have auto save mode
5508 in the special file that lists them. For each of these buffers,
5509 Record visited name (if any) and auto save name. */
5510 if (STRINGP (b->auto_save_file_name)
5511 && stream != NULL && do_handled_files == 0)
5513 if (!NILP (b->filename))
5515 fwrite (XSTRING (b->filename)->data, 1,
5516 STRING_BYTES (XSTRING (b->filename)), stream);
5518 putc ('\n', stream);
5519 fwrite (XSTRING (b->auto_save_file_name)->data, 1,
5520 STRING_BYTES (XSTRING (b->auto_save_file_name)), stream);
5521 putc ('\n', stream);
5524 if (!NILP (current_only)
5525 && b != current_buffer)
5526 continue;
5528 /* Don't auto-save indirect buffers.
5529 The base buffer takes care of it. */
5530 if (b->base_buffer)
5531 continue;
5533 /* Check for auto save enabled
5534 and file changed since last auto save
5535 and file changed since last real save. */
5536 if (STRINGP (b->auto_save_file_name)
5537 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5538 && b->auto_save_modified < BUF_MODIFF (b)
5539 /* -1 means we've turned off autosaving for a while--see below. */
5540 && XINT (b->save_length) >= 0
5541 && (do_handled_files
5542 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5543 Qwrite_region))))
5545 EMACS_TIME before_time, after_time;
5547 EMACS_GET_TIME (before_time);
5549 /* If we had a failure, don't try again for 20 minutes. */
5550 if (b->auto_save_failure_time >= 0
5551 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5552 continue;
5554 if ((XFASTINT (b->save_length) * 10
5555 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5556 /* A short file is likely to change a large fraction;
5557 spare the user annoying messages. */
5558 && XFASTINT (b->save_length) > 5000
5559 /* These messages are frequent and annoying for `*mail*'. */
5560 && !EQ (b->filename, Qnil)
5561 && NILP (no_message))
5563 /* It has shrunk too much; turn off auto-saving here. */
5564 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5565 message_with_string ("Buffer %s has shrunk a lot; auto save turned off there",
5566 b->name, 1);
5567 minibuffer_auto_raise = 0;
5568 /* Turn off auto-saving until there's a real save,
5569 and prevent any more warnings. */
5570 XSETINT (b->save_length, -1);
5571 Fsleep_for (make_number (1), Qnil);
5572 continue;
5574 set_buffer_internal (b);
5575 if (!auto_saved && NILP (no_message))
5576 message1 ("Auto-saving...");
5577 internal_condition_case (auto_save_1, Qt, auto_save_error);
5578 auto_saved++;
5579 b->auto_save_modified = BUF_MODIFF (b);
5580 XSETFASTINT (current_buffer->save_length, Z - BEG);
5581 set_buffer_internal (old);
5583 EMACS_GET_TIME (after_time);
5585 /* If auto-save took more than 60 seconds,
5586 assume it was an NFS failure that got a timeout. */
5587 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5588 b->auto_save_failure_time = EMACS_SECS (after_time);
5592 /* Prevent another auto save till enough input events come in. */
5593 record_auto_save ();
5595 if (auto_saved && NILP (no_message))
5597 if (message_p)
5599 sit_for (1, 0, 0, 0, 0);
5600 restore_message ();
5602 else
5603 message1 ("Auto-saving...done");
5606 Vquit_flag = oquit;
5608 unbind_to (count, Qnil);
5609 return Qnil;
5612 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
5613 Sset_buffer_auto_saved, 0, 0, 0,
5614 "Mark current buffer as auto-saved with its current text.\n\
5615 No auto-save file will be written until the buffer changes again.")
5618 current_buffer->auto_save_modified = MODIFF;
5619 XSETFASTINT (current_buffer->save_length, Z - BEG);
5620 current_buffer->auto_save_failure_time = -1;
5621 return Qnil;
5624 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
5625 Sclear_buffer_auto_save_failure, 0, 0, 0,
5626 "Clear any record of a recent auto-save failure in the current buffer.")
5629 current_buffer->auto_save_failure_time = -1;
5630 return Qnil;
5633 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
5634 0, 0, 0,
5635 "Return t if buffer has been auto-saved since last read in or saved.")
5638 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
5641 /* Reading and completing file names */
5642 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
5644 /* In the string VAL, change each $ to $$ and return the result. */
5646 static Lisp_Object
5647 double_dollars (val)
5648 Lisp_Object val;
5650 register unsigned char *old, *new;
5651 register int n;
5652 int osize, count;
5654 osize = STRING_BYTES (XSTRING (val));
5656 /* Count the number of $ characters. */
5657 for (n = osize, count = 0, old = XSTRING (val)->data; n > 0; n--)
5658 if (*old++ == '$') count++;
5659 if (count > 0)
5661 old = XSTRING (val)->data;
5662 val = make_uninit_multibyte_string (XSTRING (val)->size + count,
5663 osize + count);
5664 new = XSTRING (val)->data;
5665 for (n = osize; n > 0; n--)
5666 if (*old != '$')
5667 *new++ = *old++;
5668 else
5670 *new++ = '$';
5671 *new++ = '$';
5672 old++;
5675 return val;
5678 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
5679 3, 3, 0,
5680 "Internal subroutine for read-file-name. Do not call this.")
5681 (string, dir, action)
5682 Lisp_Object string, dir, action;
5683 /* action is nil for complete, t for return list of completions,
5684 lambda for verify final value */
5686 Lisp_Object name, specdir, realdir, val, orig_string;
5687 int changed;
5688 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5690 CHECK_STRING (string, 0);
5692 realdir = dir;
5693 name = string;
5694 orig_string = Qnil;
5695 specdir = Qnil;
5696 changed = 0;
5697 /* No need to protect ACTION--we only compare it with t and nil. */
5698 GCPRO5 (string, realdir, name, specdir, orig_string);
5700 if (XSTRING (string)->size == 0)
5702 if (EQ (action, Qlambda))
5704 UNGCPRO;
5705 return Qnil;
5708 else
5710 orig_string = string;
5711 string = Fsubstitute_in_file_name (string);
5712 changed = NILP (Fstring_equal (string, orig_string));
5713 name = Ffile_name_nondirectory (string);
5714 val = Ffile_name_directory (string);
5715 if (! NILP (val))
5716 realdir = Fexpand_file_name (val, realdir);
5719 if (NILP (action))
5721 specdir = Ffile_name_directory (string);
5722 val = Ffile_name_completion (name, realdir);
5723 UNGCPRO;
5724 if (!STRINGP (val))
5726 if (changed)
5727 return double_dollars (string);
5728 return val;
5731 if (!NILP (specdir))
5732 val = concat2 (specdir, val);
5733 #ifndef VMS
5734 return double_dollars (val);
5735 #else /* not VMS */
5736 return val;
5737 #endif /* not VMS */
5739 UNGCPRO;
5741 if (EQ (action, Qt))
5742 return Ffile_name_all_completions (name, realdir);
5743 /* Only other case actually used is ACTION = lambda */
5744 #ifdef VMS
5745 /* Supposedly this helps commands such as `cd' that read directory names,
5746 but can someone explain how it helps them? -- RMS */
5747 if (XSTRING (name)->size == 0)
5748 return Qt;
5749 #endif /* VMS */
5750 return Ffile_exists_p (string);
5753 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 5, 0,
5754 "Read file name, prompting with PROMPT and completing in directory DIR.\n\
5755 Value is not expanded---you must call `expand-file-name' yourself.\n\
5756 Default name to DEFAULT-FILENAME if user enters a null string.\n\
5757 (If DEFAULT-FILENAME is omitted, the visited file name is used,\n\
5758 except that if INITIAL is specified, that combined with DIR is used.)\n\
5759 Fourth arg MUSTMATCH non-nil means require existing file's name.\n\
5760 Non-nil and non-t means also require confirmation after completion.\n\
5761 Fifth arg INITIAL specifies text to start with.\n\
5762 DIR defaults to current buffer's directory default.\n\
5764 If this command was invoked with the mouse, use a file dialog box if\n\
5765 `use-dialog-box' is non-nil, and the window system or X toolkit in use\n\
5766 provides a file dialog box..")
5767 (prompt, dir, default_filename, mustmatch, initial)
5768 Lisp_Object prompt, dir, default_filename, mustmatch, initial;
5770 Lisp_Object val, insdef, tem;
5771 struct gcpro gcpro1, gcpro2;
5772 register char *homedir;
5773 int replace_in_history = 0;
5774 int add_to_history = 0;
5775 int count;
5777 if (NILP (dir))
5778 dir = current_buffer->directory;
5779 if (NILP (default_filename))
5781 if (! NILP (initial))
5782 default_filename = Fexpand_file_name (initial, dir);
5783 else
5784 default_filename = current_buffer->filename;
5787 /* If dir starts with user's homedir, change that to ~. */
5788 homedir = (char *) egetenv ("HOME");
5789 #ifdef DOS_NT
5790 /* homedir can be NULL in temacs, since Vprocess_environment is not
5791 yet set up. We shouldn't crash in that case. */
5792 if (homedir != 0)
5794 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
5795 CORRECT_DIR_SEPS (homedir);
5797 #endif
5798 if (homedir != 0
5799 && STRINGP (dir)
5800 && !strncmp (homedir, XSTRING (dir)->data, strlen (homedir))
5801 && IS_DIRECTORY_SEP (XSTRING (dir)->data[strlen (homedir)]))
5803 dir = make_string (XSTRING (dir)->data + strlen (homedir) - 1,
5804 STRING_BYTES (XSTRING (dir)) - strlen (homedir) + 1);
5805 XSTRING (dir)->data[0] = '~';
5807 /* Likewise for default_filename. */
5808 if (homedir != 0
5809 && STRINGP (default_filename)
5810 && !strncmp (homedir, XSTRING (default_filename)->data, strlen (homedir))
5811 && IS_DIRECTORY_SEP (XSTRING (default_filename)->data[strlen (homedir)]))
5813 default_filename
5814 = make_string (XSTRING (default_filename)->data + strlen (homedir) - 1,
5815 STRING_BYTES (XSTRING (default_filename)) - strlen (homedir) + 1);
5816 XSTRING (default_filename)->data[0] = '~';
5818 if (!NILP (default_filename))
5820 CHECK_STRING (default_filename, 3);
5821 default_filename = double_dollars (default_filename);
5824 if (insert_default_directory && STRINGP (dir))
5826 insdef = dir;
5827 if (!NILP (initial))
5829 Lisp_Object args[2], pos;
5831 args[0] = insdef;
5832 args[1] = initial;
5833 insdef = Fconcat (2, args);
5834 pos = make_number (XSTRING (double_dollars (dir))->size);
5835 insdef = Fcons (double_dollars (insdef), pos);
5837 else
5838 insdef = double_dollars (insdef);
5840 else if (STRINGP (initial))
5841 insdef = Fcons (double_dollars (initial), make_number (0));
5842 else
5843 insdef = Qnil;
5845 count = specpdl_ptr - specpdl;
5846 #ifdef VMS
5847 specbind (intern ("completion-ignore-case"), Qt);
5848 #endif
5850 specbind (intern ("minibuffer-completing-file-name"), Qt);
5852 GCPRO2 (insdef, default_filename);
5854 #if defined (USE_MOTIF) || defined (HAVE_NTGUI)
5855 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
5856 && use_dialog_box
5857 && have_menus_p ())
5859 /* If DIR contains a file name, split it. */
5860 Lisp_Object file;
5861 file = Ffile_name_nondirectory (dir);
5862 if (XSTRING (file)->size && NILP (default_filename))
5864 default_filename = file;
5865 dir = Ffile_name_directory (dir);
5867 if (!NILP(default_filename))
5868 default_filename = Fexpand_file_name (default_filename, dir);
5869 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch);
5870 add_to_history = 1;
5872 else
5873 #endif
5874 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
5875 dir, mustmatch, insdef,
5876 Qfile_name_history, default_filename, Qnil);
5878 tem = Fsymbol_value (Qfile_name_history);
5879 if (CONSP (tem) && EQ (XCAR (tem), val))
5880 replace_in_history = 1;
5882 /* If Fcompleting_read returned the inserted default string itself
5883 (rather than a new string with the same contents),
5884 it has to mean that the user typed RET with the minibuffer empty.
5885 In that case, we really want to return ""
5886 so that commands such as set-visited-file-name can distinguish. */
5887 if (EQ (val, default_filename))
5889 /* In this case, Fcompleting_read has not added an element
5890 to the history. Maybe we should. */
5891 if (! replace_in_history)
5892 add_to_history = 1;
5894 val = build_string ("");
5897 unbind_to (count, Qnil);
5898 UNGCPRO;
5899 if (NILP (val))
5900 error ("No file name specified");
5902 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
5904 if (!NILP (tem) && !NILP (default_filename))
5905 val = default_filename;
5906 else if (XSTRING (val)->size == 0 && NILP (insdef))
5908 if (!NILP (default_filename))
5909 val = default_filename;
5910 else
5911 error ("No default file name");
5913 val = Fsubstitute_in_file_name (val);
5915 if (replace_in_history)
5916 /* Replace what Fcompleting_read added to the history
5917 with what we will actually return. */
5918 XCAR (Fsymbol_value (Qfile_name_history)) = double_dollars (val);
5919 else if (add_to_history)
5921 /* Add the value to the history--but not if it matches
5922 the last value already there. */
5923 Lisp_Object val1 = double_dollars (val);
5924 tem = Fsymbol_value (Qfile_name_history);
5925 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
5926 Fset (Qfile_name_history,
5927 Fcons (val1, tem));
5930 return val;
5934 void
5935 init_fileio_once ()
5937 /* Must be set before any path manipulation is performed. */
5938 XSETFASTINT (Vdirectory_sep_char, '/');
5942 void
5943 syms_of_fileio ()
5945 Qexpand_file_name = intern ("expand-file-name");
5946 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
5947 Qdirectory_file_name = intern ("directory-file-name");
5948 Qfile_name_directory = intern ("file-name-directory");
5949 Qfile_name_nondirectory = intern ("file-name-nondirectory");
5950 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
5951 Qfile_name_as_directory = intern ("file-name-as-directory");
5952 Qcopy_file = intern ("copy-file");
5953 Qmake_directory_internal = intern ("make-directory-internal");
5954 Qmake_directory = intern ("make-directory");
5955 Qdelete_directory = intern ("delete-directory");
5956 Qdelete_file = intern ("delete-file");
5957 Qrename_file = intern ("rename-file");
5958 Qadd_name_to_file = intern ("add-name-to-file");
5959 Qmake_symbolic_link = intern ("make-symbolic-link");
5960 Qfile_exists_p = intern ("file-exists-p");
5961 Qfile_executable_p = intern ("file-executable-p");
5962 Qfile_readable_p = intern ("file-readable-p");
5963 Qfile_writable_p = intern ("file-writable-p");
5964 Qfile_symlink_p = intern ("file-symlink-p");
5965 Qaccess_file = intern ("access-file");
5966 Qfile_directory_p = intern ("file-directory-p");
5967 Qfile_regular_p = intern ("file-regular-p");
5968 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
5969 Qfile_modes = intern ("file-modes");
5970 Qset_file_modes = intern ("set-file-modes");
5971 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
5972 Qinsert_file_contents = intern ("insert-file-contents");
5973 Qwrite_region = intern ("write-region");
5974 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
5975 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
5977 staticpro (&Qexpand_file_name);
5978 staticpro (&Qsubstitute_in_file_name);
5979 staticpro (&Qdirectory_file_name);
5980 staticpro (&Qfile_name_directory);
5981 staticpro (&Qfile_name_nondirectory);
5982 staticpro (&Qunhandled_file_name_directory);
5983 staticpro (&Qfile_name_as_directory);
5984 staticpro (&Qcopy_file);
5985 staticpro (&Qmake_directory_internal);
5986 staticpro (&Qmake_directory);
5987 staticpro (&Qdelete_directory);
5988 staticpro (&Qdelete_file);
5989 staticpro (&Qrename_file);
5990 staticpro (&Qadd_name_to_file);
5991 staticpro (&Qmake_symbolic_link);
5992 staticpro (&Qfile_exists_p);
5993 staticpro (&Qfile_executable_p);
5994 staticpro (&Qfile_readable_p);
5995 staticpro (&Qfile_writable_p);
5996 staticpro (&Qaccess_file);
5997 staticpro (&Qfile_symlink_p);
5998 staticpro (&Qfile_directory_p);
5999 staticpro (&Qfile_regular_p);
6000 staticpro (&Qfile_accessible_directory_p);
6001 staticpro (&Qfile_modes);
6002 staticpro (&Qset_file_modes);
6003 staticpro (&Qfile_newer_than_file_p);
6004 staticpro (&Qinsert_file_contents);
6005 staticpro (&Qwrite_region);
6006 staticpro (&Qverify_visited_file_modtime);
6007 staticpro (&Qset_visited_file_modtime);
6009 Qfile_name_history = intern ("file-name-history");
6010 Fset (Qfile_name_history, Qnil);
6011 staticpro (&Qfile_name_history);
6013 Qfile_error = intern ("file-error");
6014 staticpro (&Qfile_error);
6015 Qfile_already_exists = intern ("file-already-exists");
6016 staticpro (&Qfile_already_exists);
6017 Qfile_date_error = intern ("file-date-error");
6018 staticpro (&Qfile_date_error);
6019 Qexcl = intern ("excl");
6020 staticpro (&Qexcl);
6022 #ifdef DOS_NT
6023 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6024 staticpro (&Qfind_buffer_file_type);
6025 #endif /* DOS_NT */
6027 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6028 "*Coding system for encoding file names.\n\
6029 If it is nil, default-file-name-coding-system (which see) is used.");
6030 Vfile_name_coding_system = Qnil;
6032 DEFVAR_LISP ("default-file-name-coding-system",
6033 &Vdefault_file_name_coding_system,
6034 "Default coding system for encoding file names.\n\
6035 This variable is used only when file-name-coding-system is nil.\n\
6037 This variable is set/changed by the command set-language-environment.\n\
6038 User should not set this variable manually,\n\
6039 instead use file-name-coding-system to get a constant encoding\n\
6040 of file names regardless of the current language environment.");
6041 Vdefault_file_name_coding_system = Qnil;
6043 DEFVAR_LISP ("auto-save-file-format", &Vauto_save_file_format,
6044 "*Format in which to write auto-save files.\n\
6045 Should be a list of symbols naming formats that are defined in `format-alist'.\n\
6046 If it is t, which is the default, auto-save files are written in the\n\
6047 same format as a regular save would use.");
6048 Vauto_save_file_format = Qt;
6050 Qformat_decode = intern ("format-decode");
6051 staticpro (&Qformat_decode);
6052 Qformat_annotate_function = intern ("format-annotate-function");
6053 staticpro (&Qformat_annotate_function);
6055 Qcar_less_than_car = intern ("car-less-than-car");
6056 staticpro (&Qcar_less_than_car);
6058 Fput (Qfile_error, Qerror_conditions,
6059 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
6060 Fput (Qfile_error, Qerror_message,
6061 build_string ("File error"));
6063 Fput (Qfile_already_exists, Qerror_conditions,
6064 Fcons (Qfile_already_exists,
6065 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6066 Fput (Qfile_already_exists, Qerror_message,
6067 build_string ("File already exists"));
6069 Fput (Qfile_date_error, Qerror_conditions,
6070 Fcons (Qfile_date_error,
6071 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6072 Fput (Qfile_date_error, Qerror_message,
6073 build_string ("Cannot set file date"));
6075 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6076 "*Non-nil means when reading a filename start with default dir in minibuffer.");
6077 insert_default_directory = 1;
6079 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6080 "*Non-nil means write new files with record format `stmlf'.\n\
6081 nil means use format `var'. This variable is meaningful only on VMS.");
6082 vms_stmlf_recfm = 0;
6084 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6085 "Directory separator character for built-in functions that return file names.\n\
6086 The value should be either ?/ or ?\\ (any other value is treated as ?\\).\n\
6087 This variable affects the built-in functions only on Windows,\n\
6088 on other platforms, it is initialized so that Lisp code can find out\n\
6089 what the normal separator is.\n\
6091 WARNING: This variable is deprecated and will be removed in the near\n\
6092 future. DO NOT USE IT.");
6094 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6095 "*Alist of elements (REGEXP . HANDLER) for file names handled specially.\n\
6096 If a file name matches REGEXP, then all I/O on that file is done by calling\n\
6097 HANDLER.\n\
6099 The first argument given to HANDLER is the name of the I/O primitive\n\
6100 to be handled; the remaining arguments are the arguments that were\n\
6101 passed to that primitive. For example, if you do\n\
6102 (file-exists-p FILENAME)\n\
6103 and FILENAME is handled by HANDLER, then HANDLER is called like this:\n\
6104 (funcall HANDLER 'file-exists-p FILENAME)\n\
6105 The function `find-file-name-handler' checks this list for a handler\n\
6106 for its argument.");
6107 Vfile_name_handler_alist = Qnil;
6109 DEFVAR_LISP ("set-auto-coding-function",
6110 &Vset_auto_coding_function,
6111 "If non-nil, a function to call to decide a coding system of file.\n\
6112 Two arguments are passed to this function: the file name\n\
6113 and the length of a file contents following the point.\n\
6114 This function should return a coding system to decode the file contents.\n\
6115 It should check the file name against `auto-coding-alist'.\n\
6116 If no coding system is decided, it should check a coding system\n\
6117 specified in the heading lines with the format:\n\
6118 -*- ... coding: CODING-SYSTEM; ... -*-\n\
6119 or local variable spec of the tailing lines with `coding:' tag.");
6120 Vset_auto_coding_function = Qnil;
6122 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6123 "A list of functions to be called at the end of `insert-file-contents'.\n\
6124 Each is passed one argument, the number of bytes inserted. It should return\n\
6125 the new byte count, and leave point the same. If `insert-file-contents' is\n\
6126 intercepted by a handler from `file-name-handler-alist', that handler is\n\
6127 responsible for calling the after-insert-file-functions if appropriate.");
6128 Vafter_insert_file_functions = Qnil;
6130 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6131 "A list of functions to be called at the start of `write-region'.\n\
6132 Each is passed two arguments, START and END as for `write-region'.\n\
6133 These are usually two numbers but not always; see the documentation\n\
6134 for `write-region'. The function should return a list of pairs\n\
6135 of the form (POSITION . STRING), consisting of strings to be effectively\n\
6136 inserted at the specified positions of the file being written (1 means to\n\
6137 insert before the first byte written). The POSITIONs must be sorted into\n\
6138 increasing order. If there are several functions in the list, the several\n\
6139 lists are merged destructively.");
6140 Vwrite_region_annotate_functions = Qnil;
6142 DEFVAR_LISP ("write-region-annotations-so-far",
6143 &Vwrite_region_annotations_so_far,
6144 "When an annotation function is called, this holds the previous annotations.\n\
6145 These are the annotations made by other annotation functions\n\
6146 that were already called. See also `write-region-annotate-functions'.");
6147 Vwrite_region_annotations_so_far = Qnil;
6149 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6150 "A list of file name handlers that temporarily should not be used.\n\
6151 This applies only to the operation `inhibit-file-name-operation'.");
6152 Vinhibit_file_name_handlers = Qnil;
6154 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6155 "The operation for which `inhibit-file-name-handlers' is applicable.");
6156 Vinhibit_file_name_operation = Qnil;
6158 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6159 "File name in which we write a list of all auto save file names.\n\
6160 This variable is initialized automatically from `auto-save-list-file-prefix'\n\
6161 shortly after Emacs reads your `.emacs' file, if you have not yet given it\n\
6162 a non-nil value.");
6163 Vauto_save_list_file_name = Qnil;
6165 defsubr (&Sfind_file_name_handler);
6166 defsubr (&Sfile_name_directory);
6167 defsubr (&Sfile_name_nondirectory);
6168 defsubr (&Sunhandled_file_name_directory);
6169 defsubr (&Sfile_name_as_directory);
6170 defsubr (&Sdirectory_file_name);
6171 defsubr (&Smake_temp_name);
6172 defsubr (&Sexpand_file_name);
6173 defsubr (&Ssubstitute_in_file_name);
6174 defsubr (&Scopy_file);
6175 defsubr (&Smake_directory_internal);
6176 defsubr (&Sdelete_directory);
6177 defsubr (&Sdelete_file);
6178 defsubr (&Srename_file);
6179 defsubr (&Sadd_name_to_file);
6180 #ifdef S_IFLNK
6181 defsubr (&Smake_symbolic_link);
6182 #endif /* S_IFLNK */
6183 #ifdef VMS
6184 defsubr (&Sdefine_logical_name);
6185 #endif /* VMS */
6186 #ifdef HPUX_NET
6187 defsubr (&Ssysnetunam);
6188 #endif /* HPUX_NET */
6189 defsubr (&Sfile_name_absolute_p);
6190 defsubr (&Sfile_exists_p);
6191 defsubr (&Sfile_executable_p);
6192 defsubr (&Sfile_readable_p);
6193 defsubr (&Sfile_writable_p);
6194 defsubr (&Saccess_file);
6195 defsubr (&Sfile_symlink_p);
6196 defsubr (&Sfile_directory_p);
6197 defsubr (&Sfile_accessible_directory_p);
6198 defsubr (&Sfile_regular_p);
6199 defsubr (&Sfile_modes);
6200 defsubr (&Sset_file_modes);
6201 defsubr (&Sset_default_file_modes);
6202 defsubr (&Sdefault_file_modes);
6203 defsubr (&Sfile_newer_than_file_p);
6204 defsubr (&Sinsert_file_contents);
6205 defsubr (&Swrite_region);
6206 defsubr (&Scar_less_than_car);
6207 defsubr (&Sverify_visited_file_modtime);
6208 defsubr (&Sclear_visited_file_modtime);
6209 defsubr (&Svisited_file_modtime);
6210 defsubr (&Sset_visited_file_modtime);
6211 defsubr (&Sdo_auto_save);
6212 defsubr (&Sset_buffer_auto_saved);
6213 defsubr (&Sclear_buffer_auto_save_failure);
6214 defsubr (&Srecent_auto_save_p);
6216 defsubr (&Sread_file_name_internal);
6217 defsubr (&Sread_file_name);
6219 #ifdef unix
6220 defsubr (&Sunix_sync);
6221 #endif