new version
[emacs.git] / src / fileio.c
blobe23b74a17208cd542421115fcc7ef2fec1dbe48b
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985,86,87,88,93,94,95,96,1997 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #include <config.h>
23 #if defined (USG5) || defined (BSD_SYSTEM) || defined (LINUX)
24 #include <fcntl.h>
25 #endif
27 #include <stdio.h>
28 #include <sys/types.h>
29 #include <sys/stat.h>
31 #ifdef HAVE_UNISTD_H
32 #include <unistd.h>
33 #endif
35 #if !defined (S_ISLNK) && defined (S_IFLNK)
36 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
37 #endif
39 #if !defined (S_ISFIFO) && defined (S_IFIFO)
40 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
41 #endif
43 #if !defined (S_ISREG) && defined (S_IFREG)
44 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
45 #endif
47 #ifdef VMS
48 #include "vms-pwd.h"
49 #else
50 #include <pwd.h>
51 #endif
53 #ifdef MSDOS
54 #include "msdos.h"
55 #include <sys/param.h>
56 #if __DJGPP__ >= 2
57 #include <fcntl.h>
58 #include <string.h>
59 #endif
60 #endif
62 #include <ctype.h>
64 #ifdef VMS
65 #include "vmsdir.h"
66 #include <perror.h>
67 #include <stddef.h>
68 #include <string.h>
69 #endif
71 #include <errno.h>
73 #ifndef vax11c
74 extern int errno;
75 #endif
77 extern char *strerror ();
79 #ifdef APOLLO
80 #include <sys/time.h>
81 #endif
83 #ifndef USG
84 #ifndef VMS
85 #ifndef BSD4_1
86 #ifndef WINDOWSNT
87 #define HAVE_FSYNC
88 #endif
89 #endif
90 #endif
91 #endif
93 #include "lisp.h"
94 #include "intervals.h"
95 #include "buffer.h"
96 #include "charset.h"
97 #include "coding.h"
98 #include "window.h"
100 #ifdef WINDOWSNT
101 #define NOMINMAX 1
102 #include <windows.h>
103 #include <stdlib.h>
104 #include <fcntl.h>
105 #endif /* not WINDOWSNT */
107 #ifdef DOS_NT
108 #define CORRECT_DIR_SEPS(s) \
109 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
110 else unixtodos_filename (s); \
111 } while (0)
112 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
113 redirector allows the six letters between 'Z' and 'a' as well. */
114 #ifdef MSDOS
115 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
116 #endif
117 #ifdef WINDOWSNT
118 #define IS_DRIVE(x) isalpha (x)
119 #endif
120 /* Need to lower-case the drive letter, or else expanded
121 filenames will sometimes compare inequal, because
122 `expand-file-name' doesn't always down-case the drive letter. */
123 #define DRIVE_LETTER(x) (tolower (x))
124 #endif
126 #ifdef VMS
127 #include <file.h>
128 #include <rmsdef.h>
129 #include <fab.h>
130 #include <nam.h>
131 #endif
133 #include "systime.h"
135 #ifdef HPUX
136 #include <netio.h>
137 #ifndef HPUX8
138 #ifndef HPUX9
139 #include <errnet.h>
140 #endif
141 #endif
142 #endif
144 #ifndef O_WRONLY
145 #define O_WRONLY 1
146 #endif
148 #ifndef O_RDONLY
149 #define O_RDONLY 0
150 #endif
152 #define min(a, b) ((a) < (b) ? (a) : (b))
153 #define max(a, b) ((a) > (b) ? (a) : (b))
155 /* Encode the file name NAME using the specified coding system
156 for file names, if any. */
157 #define ENCODE_FILE(name) \
158 (! NILP (Vfile_name_coding_system) \
159 && XFASTINT (Vfile_name_coding_system) != 0 \
160 ? Fencode_coding_string (name, Vfile_name_coding_system, Qt) \
161 : name)
163 /* Nonzero during writing of auto-save files */
164 int auto_saving;
166 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
167 a new file with the same mode as the original */
168 int auto_save_mode_bits;
170 /* Coding system for file names, or nil if none. */
171 Lisp_Object Vfile_name_coding_system;
173 /* Alist of elements (REGEXP . HANDLER) for file names
174 whose I/O is done with a special handler. */
175 Lisp_Object Vfile_name_handler_alist;
177 /* Format for auto-save files */
178 Lisp_Object Vauto_save_file_format;
180 /* Lisp functions for translating file formats */
181 Lisp_Object Qformat_decode, Qformat_annotate_function;
183 /* Function to be called to decide a coding system of a reading file. */
184 Lisp_Object Vset_auto_coding_function;
186 /* Functions to be called to process text properties in inserted file. */
187 Lisp_Object Vafter_insert_file_functions;
189 /* Functions to be called to create text property annotations for file. */
190 Lisp_Object Vwrite_region_annotate_functions;
192 /* During build_annotations, each time an annotation function is called,
193 this holds the annotations made by the previous functions. */
194 Lisp_Object Vwrite_region_annotations_so_far;
196 /* File name in which we write a list of all our auto save files. */
197 Lisp_Object Vauto_save_list_file_name;
199 /* Nonzero means, when reading a filename in the minibuffer,
200 start out by inserting the default directory into the minibuffer. */
201 int insert_default_directory;
203 /* On VMS, nonzero means write new files with record format stmlf.
204 Zero means use var format. */
205 int vms_stmlf_recfm;
207 /* On NT, specifies the directory separator character, used (eg.) when
208 expanding file names. This can be bound to / or \. */
209 Lisp_Object Vdirectory_sep_char;
211 extern Lisp_Object Vuser_login_name;
213 extern int minibuf_level;
215 extern int minibuffer_auto_raise;
217 /* These variables describe handlers that have "already" had a chance
218 to handle the current operation.
220 Vinhibit_file_name_handlers is a list of file name handlers.
221 Vinhibit_file_name_operation is the operation being handled.
222 If we try to handle that operation, we ignore those handlers. */
224 static Lisp_Object Vinhibit_file_name_handlers;
225 static Lisp_Object Vinhibit_file_name_operation;
227 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
229 Lisp_Object Qfile_name_history;
231 Lisp_Object Qcar_less_than_car;
233 report_file_error (string, data)
234 char *string;
235 Lisp_Object data;
237 Lisp_Object errstring;
239 errstring = build_string (strerror (errno));
241 /* System error messages are capitalized. Downcase the initial
242 unless it is followed by a slash. */
243 if (XSTRING (errstring)->data[1] != '/')
244 XSTRING (errstring)->data[0] = DOWNCASE (XSTRING (errstring)->data[0]);
246 while (1)
247 Fsignal (Qfile_error,
248 Fcons (build_string (string), Fcons (errstring, data)));
251 close_file_unwind (fd)
252 Lisp_Object fd;
254 close (XFASTINT (fd));
257 /* Restore point, having saved it as a marker. */
259 restore_point_unwind (location)
260 Lisp_Object location;
262 SET_PT (marker_position (location));
263 Fset_marker (location, Qnil, Qnil);
266 Lisp_Object Qexpand_file_name;
267 Lisp_Object Qsubstitute_in_file_name;
268 Lisp_Object Qdirectory_file_name;
269 Lisp_Object Qfile_name_directory;
270 Lisp_Object Qfile_name_nondirectory;
271 Lisp_Object Qunhandled_file_name_directory;
272 Lisp_Object Qfile_name_as_directory;
273 Lisp_Object Qcopy_file;
274 Lisp_Object Qmake_directory_internal;
275 Lisp_Object Qdelete_directory;
276 Lisp_Object Qdelete_file;
277 Lisp_Object Qrename_file;
278 Lisp_Object Qadd_name_to_file;
279 Lisp_Object Qmake_symbolic_link;
280 Lisp_Object Qfile_exists_p;
281 Lisp_Object Qfile_executable_p;
282 Lisp_Object Qfile_readable_p;
283 Lisp_Object Qfile_writable_p;
284 Lisp_Object Qfile_symlink_p;
285 Lisp_Object Qaccess_file;
286 Lisp_Object Qfile_directory_p;
287 Lisp_Object Qfile_regular_p;
288 Lisp_Object Qfile_accessible_directory_p;
289 Lisp_Object Qfile_modes;
290 Lisp_Object Qset_file_modes;
291 Lisp_Object Qfile_newer_than_file_p;
292 Lisp_Object Qinsert_file_contents;
293 Lisp_Object Qwrite_region;
294 Lisp_Object Qverify_visited_file_modtime;
295 Lisp_Object Qset_visited_file_modtime;
297 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
298 "Return FILENAME's handler function for OPERATION, if it has one.\n\
299 Otherwise, return nil.\n\
300 A file name is handled if one of the regular expressions in\n\
301 `file-name-handler-alist' matches it.\n\n\
302 If OPERATION equals `inhibit-file-name-operation', then we ignore\n\
303 any handlers that are members of `inhibit-file-name-handlers',\n\
304 but we still do run any other handlers. This lets handlers\n\
305 use the standard functions without calling themselves recursively.")
306 (filename, operation)
307 Lisp_Object filename, operation;
309 /* This function must not munge the match data. */
310 Lisp_Object chain, inhibited_handlers;
312 CHECK_STRING (filename, 0);
314 if (EQ (operation, Vinhibit_file_name_operation))
315 inhibited_handlers = Vinhibit_file_name_handlers;
316 else
317 inhibited_handlers = Qnil;
319 for (chain = Vfile_name_handler_alist; CONSP (chain);
320 chain = XCONS (chain)->cdr)
322 Lisp_Object elt;
323 elt = XCONS (chain)->car;
324 if (CONSP (elt))
326 Lisp_Object string;
327 string = XCONS (elt)->car;
328 if (STRINGP (string) && fast_string_match (string, filename) >= 0)
330 Lisp_Object handler, tem;
332 handler = XCONS (elt)->cdr;
333 tem = Fmemq (handler, inhibited_handlers);
334 if (NILP (tem))
335 return handler;
339 QUIT;
341 return Qnil;
344 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
345 1, 1, 0,
346 "Return the directory component in file name FILENAME.\n\
347 Return nil if FILENAME does not include a directory.\n\
348 Otherwise return a directory spec.\n\
349 Given a Unix syntax file name, returns a string ending in slash;\n\
350 on VMS, perhaps instead a string ending in `:', `]' or `>'.")
351 (filename)
352 Lisp_Object filename;
354 register unsigned char *beg;
355 register unsigned char *p;
356 Lisp_Object handler;
358 CHECK_STRING (filename, 0);
360 /* If the file name has special constructs in it,
361 call the corresponding file handler. */
362 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
363 if (!NILP (handler))
364 return call2 (handler, Qfile_name_directory, filename);
366 #ifdef FILE_SYSTEM_CASE
367 filename = FILE_SYSTEM_CASE (filename);
368 #endif
369 beg = XSTRING (filename)->data;
370 #ifdef DOS_NT
371 beg = strcpy (alloca (strlen (beg) + 1), beg);
372 #endif
373 p = beg + XSTRING (filename)->size;
375 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
376 #ifdef VMS
377 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
378 #endif /* VMS */
379 #ifdef DOS_NT
380 /* only recognise drive specifier at beginning */
381 && !(p[-1] == ':' && p == beg + 2)
382 #endif
383 ) p--;
385 if (p == beg)
386 return Qnil;
387 #ifdef DOS_NT
388 /* Expansion of "c:" to drive and default directory. */
389 if (p == beg + 2 && beg[1] == ':')
391 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
392 unsigned char *res = alloca (MAXPATHLEN + 1);
393 if (getdefdir (toupper (*beg) - 'A' + 1, res))
395 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
396 strcat (res, "/");
397 beg = res;
398 p = beg + strlen (beg);
401 CORRECT_DIR_SEPS (beg);
402 #endif /* DOS_NT */
403 return make_string (beg, p - beg);
406 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory, Sfile_name_nondirectory,
407 1, 1, 0,
408 "Return file name FILENAME sans its directory.\n\
409 For example, in a Unix-syntax file name,\n\
410 this is everything after the last slash,\n\
411 or the entire name if it contains no slash.")
412 (filename)
413 Lisp_Object filename;
415 register unsigned char *beg, *p, *end;
416 Lisp_Object handler;
418 CHECK_STRING (filename, 0);
420 /* If the file name has special constructs in it,
421 call the corresponding file handler. */
422 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
423 if (!NILP (handler))
424 return call2 (handler, Qfile_name_nondirectory, filename);
426 beg = XSTRING (filename)->data;
427 end = p = beg + XSTRING (filename)->size;
429 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
430 #ifdef VMS
431 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
432 #endif /* VMS */
433 #ifdef DOS_NT
434 /* only recognise drive specifier at beginning */
435 && !(p[-1] == ':' && p == beg + 2)
436 #endif
437 ) p--;
439 return make_string (p, end - p);
442 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory, Sunhandled_file_name_directory, 1, 1, 0,
443 "Return a directly usable directory name somehow associated with FILENAME.\n\
444 A `directly usable' directory name is one that may be used without the\n\
445 intervention of any file handler.\n\
446 If FILENAME is a directly usable file itself, return\n\
447 (file-name-directory FILENAME).\n\
448 The `call-process' and `start-process' functions use this function to\n\
449 get a current directory to run processes in.")
450 (filename)
451 Lisp_Object filename;
453 Lisp_Object handler;
455 /* If the file name has special constructs in it,
456 call the corresponding file handler. */
457 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
458 if (!NILP (handler))
459 return call2 (handler, Qunhandled_file_name_directory, filename);
461 return Ffile_name_directory (filename);
465 char *
466 file_name_as_directory (out, in)
467 char *out, *in;
469 int size = strlen (in) - 1;
471 strcpy (out, in);
473 #ifdef VMS
474 /* Is it already a directory string? */
475 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
476 return out;
477 /* Is it a VMS directory file name? If so, hack VMS syntax. */
478 else if (! index (in, '/')
479 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
480 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
481 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
482 || ! strncmp (&in[size - 5], ".dir", 4))
483 && (in[size - 1] == '.' || in[size - 1] == ';')
484 && in[size] == '1')))
486 register char *p, *dot;
487 char brack;
489 /* x.dir -> [.x]
490 dir:x.dir --> dir:[x]
491 dir:[x]y.dir --> dir:[x.y] */
492 p = in + size;
493 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
494 if (p != in)
496 strncpy (out, in, p - in);
497 out[p - in] = '\0';
498 if (*p == ':')
500 brack = ']';
501 strcat (out, ":[");
503 else
505 brack = *p;
506 strcat (out, ".");
508 p++;
510 else
512 brack = ']';
513 strcpy (out, "[.");
515 dot = index (p, '.');
516 if (dot)
518 /* blindly remove any extension */
519 size = strlen (out) + (dot - p);
520 strncat (out, p, dot - p);
522 else
524 strcat (out, p);
525 size = strlen (out);
527 out[size++] = brack;
528 out[size] = '\0';
530 #else /* not VMS */
531 /* For Unix syntax, Append a slash if necessary */
532 if (!IS_DIRECTORY_SEP (out[size]))
534 out[size + 1] = DIRECTORY_SEP;
535 out[size + 2] = '\0';
537 #ifdef DOS_NT
538 CORRECT_DIR_SEPS (out);
539 #endif
540 #endif /* not VMS */
541 return out;
544 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
545 Sfile_name_as_directory, 1, 1, 0,
546 "Return a string representing file FILENAME interpreted as a directory.\n\
547 This operation exists because a directory is also a file, but its name as\n\
548 a directory is different from its name as a file.\n\
549 The result can be used as the value of `default-directory'\n\
550 or passed as second argument to `expand-file-name'.\n\
551 For a Unix-syntax file name, just appends a slash.\n\
552 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.")
553 (file)
554 Lisp_Object file;
556 char *buf;
557 Lisp_Object handler;
559 CHECK_STRING (file, 0);
560 if (NILP (file))
561 return Qnil;
563 /* If the file name has special constructs in it,
564 call the corresponding file handler. */
565 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
566 if (!NILP (handler))
567 return call2 (handler, Qfile_name_as_directory, file);
569 buf = (char *) alloca (XSTRING (file)->size + 10);
570 return build_string (file_name_as_directory (buf, XSTRING (file)->data));
574 * Convert from directory name to filename.
575 * On VMS:
576 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
577 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
578 * On UNIX, it's simple: just make sure there isn't a terminating /
580 * Value is nonzero if the string output is different from the input.
583 directory_file_name (src, dst)
584 char *src, *dst;
586 long slen;
587 #ifdef VMS
588 long rlen;
589 char * ptr, * rptr;
590 char bracket;
591 struct FAB fab = cc$rms_fab;
592 struct NAM nam = cc$rms_nam;
593 char esa[NAM$C_MAXRSS];
594 #endif /* VMS */
596 slen = strlen (src);
597 #ifdef VMS
598 if (! index (src, '/')
599 && (src[slen - 1] == ']'
600 || src[slen - 1] == ':'
601 || src[slen - 1] == '>'))
603 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
604 fab.fab$l_fna = src;
605 fab.fab$b_fns = slen;
606 fab.fab$l_nam = &nam;
607 fab.fab$l_fop = FAB$M_NAM;
609 nam.nam$l_esa = esa;
610 nam.nam$b_ess = sizeof esa;
611 nam.nam$b_nop |= NAM$M_SYNCHK;
613 /* We call SYS$PARSE to handle such things as [--] for us. */
614 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
616 slen = nam.nam$b_esl;
617 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
618 slen -= 2;
619 esa[slen] = '\0';
620 src = esa;
622 if (src[slen - 1] != ']' && src[slen - 1] != '>')
624 /* what about when we have logical_name:???? */
625 if (src[slen - 1] == ':')
626 { /* Xlate logical name and see what we get */
627 ptr = strcpy (dst, src); /* upper case for getenv */
628 while (*ptr)
630 if ('a' <= *ptr && *ptr <= 'z')
631 *ptr -= 040;
632 ptr++;
634 dst[slen - 1] = 0; /* remove colon */
635 if (!(src = egetenv (dst)))
636 return 0;
637 /* should we jump to the beginning of this procedure?
638 Good points: allows us to use logical names that xlate
639 to Unix names,
640 Bad points: can be a problem if we just translated to a device
641 name...
642 For now, I'll punt and always expect VMS names, and hope for
643 the best! */
644 slen = strlen (src);
645 if (src[slen - 1] != ']' && src[slen - 1] != '>')
646 { /* no recursion here! */
647 strcpy (dst, src);
648 return 0;
651 else
652 { /* not a directory spec */
653 strcpy (dst, src);
654 return 0;
657 bracket = src[slen - 1];
659 /* If bracket is ']' or '>', bracket - 2 is the corresponding
660 opening bracket. */
661 ptr = index (src, bracket - 2);
662 if (ptr == 0)
663 { /* no opening bracket */
664 strcpy (dst, src);
665 return 0;
667 if (!(rptr = rindex (src, '.')))
668 rptr = ptr;
669 slen = rptr - src;
670 strncpy (dst, src, slen);
671 dst[slen] = '\0';
672 if (*rptr == '.')
674 dst[slen++] = bracket;
675 dst[slen] = '\0';
677 else
679 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
680 then translate the device and recurse. */
681 if (dst[slen - 1] == ':'
682 && dst[slen - 2] != ':' /* skip decnet nodes */
683 && strcmp (src + slen, "[000000]") == 0)
685 dst[slen - 1] = '\0';
686 if ((ptr = egetenv (dst))
687 && (rlen = strlen (ptr) - 1) > 0
688 && (ptr[rlen] == ']' || ptr[rlen] == '>')
689 && ptr[rlen - 1] == '.')
691 char * buf = (char *) alloca (strlen (ptr) + 1);
692 strcpy (buf, ptr);
693 buf[rlen - 1] = ']';
694 buf[rlen] = '\0';
695 return directory_file_name (buf, dst);
697 else
698 dst[slen - 1] = ':';
700 strcat (dst, "[000000]");
701 slen += 8;
703 rptr++;
704 rlen = strlen (rptr) - 1;
705 strncat (dst, rptr, rlen);
706 dst[slen + rlen] = '\0';
707 strcat (dst, ".DIR.1");
708 return 1;
710 #endif /* VMS */
711 /* Process as Unix format: just remove any final slash.
712 But leave "/" unchanged; do not change it to "". */
713 strcpy (dst, src);
714 #ifdef APOLLO
715 /* Handle // as root for apollo's. */
716 if ((slen > 2 && dst[slen - 1] == '/')
717 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
718 dst[slen - 1] = 0;
719 #else
720 if (slen > 1
721 && IS_DIRECTORY_SEP (dst[slen - 1])
722 #ifdef DOS_NT
723 && !IS_ANY_SEP (dst[slen - 2])
724 #endif
726 dst[slen - 1] = 0;
727 #endif
728 #ifdef DOS_NT
729 CORRECT_DIR_SEPS (dst);
730 #endif
731 return 1;
734 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
735 1, 1, 0,
736 "Returns the file name of the directory named DIRECTORY.\n\
737 This is the name of the file that holds the data for the directory DIRECTORY.\n\
738 This operation exists because a directory is also a file, but its name as\n\
739 a directory is different from its name as a file.\n\
740 In Unix-syntax, this function just removes the final slash.\n\
741 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",\n\
742 it returns a file name such as \"[X]Y.DIR.1\".")
743 (directory)
744 Lisp_Object directory;
746 char *buf;
747 Lisp_Object handler;
749 CHECK_STRING (directory, 0);
751 if (NILP (directory))
752 return Qnil;
754 /* If the file name has special constructs in it,
755 call the corresponding file handler. */
756 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
757 if (!NILP (handler))
758 return call2 (handler, Qdirectory_file_name, directory);
760 #ifdef VMS
761 /* 20 extra chars is insufficient for VMS, since we might perform a
762 logical name translation. an equivalence string can be up to 255
763 chars long, so grab that much extra space... - sss */
764 buf = (char *) alloca (XSTRING (directory)->size + 20 + 255);
765 #else
766 buf = (char *) alloca (XSTRING (directory)->size + 20);
767 #endif
768 directory_file_name (XSTRING (directory)->data, buf);
769 return build_string (buf);
772 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
773 "Generate temporary file name (string) starting with PREFIX (a string).\n\
774 The Emacs process number forms part of the result,\n\
775 so there is no danger of generating a name being used by another process.\n\
776 In addition, this function makes an attempt to choose a name\n\
777 which has no existing file.")
778 (prefix)
779 Lisp_Object prefix;
781 Lisp_Object val;
782 #ifdef MSDOS
783 /* Don't use too many characters of the restricted 8+3 DOS
784 filename space. */
785 val = concat2 (prefix, build_string ("a.XXX"));
786 #else
787 val = concat2 (prefix, build_string ("XXXXXX"));
788 #endif
789 mktemp (XSTRING (val)->data);
790 #ifdef DOS_NT
791 CORRECT_DIR_SEPS (XSTRING (val)->data);
792 #endif
793 return val;
796 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
797 "Convert filename NAME to absolute, and canonicalize it.\n\
798 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative\n\
799 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,\n\
800 the current buffer's value of default-directory is used.\n\
801 File name components that are `.' are removed, and \n\
802 so are file name components followed by `..', along with the `..' itself;\n\
803 note that these simplifications are done without checking the resulting\n\
804 file names in the file system.\n\
805 An initial `~/' expands to your home directory.\n\
806 An initial `~USER/' expands to USER's home directory.\n\
807 See also the function `substitute-in-file-name'.")
808 (name, default_directory)
809 Lisp_Object name, default_directory;
811 unsigned char *nm;
813 register unsigned char *newdir, *p, *o;
814 int tlen;
815 unsigned char *target;
816 struct passwd *pw;
817 #ifdef VMS
818 unsigned char * colon = 0;
819 unsigned char * close = 0;
820 unsigned char * slash = 0;
821 unsigned char * brack = 0;
822 int lbrack = 0, rbrack = 0;
823 int dots = 0;
824 #endif /* VMS */
825 #ifdef DOS_NT
826 int drive = 0;
827 int collapse_newdir = 1;
828 #endif /* DOS_NT */
829 int length;
830 Lisp_Object handler;
832 CHECK_STRING (name, 0);
834 /* If the file name has special constructs in it,
835 call the corresponding file handler. */
836 handler = Ffind_file_name_handler (name, Qexpand_file_name);
837 if (!NILP (handler))
838 return call3 (handler, Qexpand_file_name, name, default_directory);
840 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
841 if (NILP (default_directory))
842 default_directory = current_buffer->directory;
843 if (! STRINGP (default_directory))
844 default_directory = build_string ("/");
846 if (!NILP (default_directory))
848 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
849 if (!NILP (handler))
850 return call3 (handler, Qexpand_file_name, name, default_directory);
853 o = XSTRING (default_directory)->data;
855 /* Make sure DEFAULT_DIRECTORY is properly expanded.
856 It would be better to do this down below where we actually use
857 default_directory. Unfortunately, calling Fexpand_file_name recursively
858 could invoke GC, and the strings might be relocated. This would
859 be annoying because we have pointers into strings lying around
860 that would need adjusting, and people would add new pointers to
861 the code and forget to adjust them, resulting in intermittent bugs.
862 Putting this call here avoids all that crud.
864 The EQ test avoids infinite recursion. */
865 if (! NILP (default_directory) && !EQ (default_directory, name)
866 /* Save time in some common cases - as long as default_directory
867 is not relative, it can be canonicalized with name below (if it
868 is needed at all) without requiring it to be expanded now. */
869 #ifdef DOS_NT
870 /* Detect MSDOS file names with drive specifiers. */
871 && ! (IS_DRIVE (o[0]) && (IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2])))
872 #ifdef WINDOWSNT
873 /* Detect Windows file names in UNC format. */
874 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
875 #endif
876 #else /* not DOS_NT */
877 /* Detect Unix absolute file names (/... alone is not absolute on
878 DOS or Windows). */
879 && ! (IS_DIRECTORY_SEP (o[0]))
880 #endif /* not DOS_NT */
883 struct gcpro gcpro1;
885 GCPRO1 (name);
886 default_directory = Fexpand_file_name (default_directory, Qnil);
887 UNGCPRO;
890 #ifdef VMS
891 /* Filenames on VMS are always upper case. */
892 name = Fupcase (name);
893 #endif
894 #ifdef FILE_SYSTEM_CASE
895 name = FILE_SYSTEM_CASE (name);
896 #endif
898 nm = XSTRING (name)->data;
900 #ifdef DOS_NT
901 /* We will force directory separators to be either all \ or /, so make
902 a local copy to modify, even if there ends up being no change. */
903 nm = strcpy (alloca (strlen (nm) + 1), nm);
905 /* Find and remove drive specifier if present; this makes nm absolute
906 even if the rest of the name appears to be relative. */
908 unsigned char *colon = rindex (nm, ':');
910 if (colon)
911 /* Only recognize colon as part of drive specifier if there is a
912 single alphabetic character preceeding the colon (and if the
913 character before the drive letter, if present, is a directory
914 separator); this is to support the remote system syntax used by
915 ange-ftp, and the "po:username" syntax for POP mailboxes. */
916 look_again:
917 if (nm == colon)
918 nm++;
919 else if (IS_DRIVE (colon[-1])
920 && (colon == nm + 1 || IS_DIRECTORY_SEP (colon[-2])))
922 drive = colon[-1];
923 nm = colon + 1;
925 else
927 while (--colon >= nm)
928 if (colon[0] == ':')
929 goto look_again;
933 #ifdef WINDOWSNT
934 /* If we see "c://somedir", we want to strip the first slash after the
935 colon when stripping the drive letter. Otherwise, this expands to
936 "//somedir". */
937 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
938 nm++;
939 #endif /* WINDOWSNT */
940 #endif /* DOS_NT */
942 #ifdef WINDOWSNT
943 /* Discard any previous drive specifier if nm is now in UNC format. */
944 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
946 drive = 0;
948 #endif
950 /* If nm is absolute, look for /./ or /../ sequences; if none are
951 found, we can probably return right away. We will avoid allocating
952 a new string if name is already fully expanded. */
953 if (
954 IS_DIRECTORY_SEP (nm[0])
955 #ifdef MSDOS
956 && drive
957 #endif
958 #ifdef WINDOWSNT
959 && (drive || IS_DIRECTORY_SEP (nm[1]))
960 #endif
961 #ifdef VMS
962 || index (nm, ':')
963 #endif /* VMS */
966 /* If it turns out that the filename we want to return is just a
967 suffix of FILENAME, we don't need to go through and edit
968 things; we just need to construct a new string using data
969 starting at the middle of FILENAME. If we set lose to a
970 non-zero value, that means we've discovered that we can't do
971 that cool trick. */
972 int lose = 0;
974 p = nm;
975 while (*p)
977 /* Since we know the name is absolute, we can assume that each
978 element starts with a "/". */
980 /* "." and ".." are hairy. */
981 if (IS_DIRECTORY_SEP (p[0])
982 && p[1] == '.'
983 && (IS_DIRECTORY_SEP (p[2])
984 || p[2] == 0
985 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
986 || p[3] == 0))))
987 lose = 1;
988 #ifdef VMS
989 if (p[0] == '\\')
990 lose = 1;
991 if (p[0] == '/') {
992 /* if dev:[dir]/, move nm to / */
993 if (!slash && p > nm && (brack || colon)) {
994 nm = (brack ? brack + 1 : colon + 1);
995 lbrack = rbrack = 0;
996 brack = 0;
997 colon = 0;
999 slash = p;
1001 if (p[0] == '-')
1002 #ifndef VMS4_4
1003 /* VMS pre V4.4,convert '-'s in filenames. */
1004 if (lbrack == rbrack)
1006 if (dots < 2) /* this is to allow negative version numbers */
1007 p[0] = '_';
1009 else
1010 #endif /* VMS4_4 */
1011 if (lbrack > rbrack &&
1012 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1013 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1014 lose = 1;
1015 #ifndef VMS4_4
1016 else
1017 p[0] = '_';
1018 #endif /* VMS4_4 */
1019 /* count open brackets, reset close bracket pointer */
1020 if (p[0] == '[' || p[0] == '<')
1021 lbrack++, brack = 0;
1022 /* count close brackets, set close bracket pointer */
1023 if (p[0] == ']' || p[0] == '>')
1024 rbrack++, brack = p;
1025 /* detect ][ or >< */
1026 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1027 lose = 1;
1028 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1029 nm = p + 1, lose = 1;
1030 if (p[0] == ':' && (colon || slash))
1031 /* if dev1:[dir]dev2:, move nm to dev2: */
1032 if (brack)
1034 nm = brack + 1;
1035 brack = 0;
1037 /* if /name/dev:, move nm to dev: */
1038 else if (slash)
1039 nm = slash + 1;
1040 /* if node::dev:, move colon following dev */
1041 else if (colon && colon[-1] == ':')
1042 colon = p;
1043 /* if dev1:dev2:, move nm to dev2: */
1044 else if (colon && colon[-1] != ':')
1046 nm = colon + 1;
1047 colon = 0;
1049 if (p[0] == ':' && !colon)
1051 if (p[1] == ':')
1052 p++;
1053 colon = p;
1055 if (lbrack == rbrack)
1056 if (p[0] == ';')
1057 dots = 2;
1058 else if (p[0] == '.')
1059 dots++;
1060 #endif /* VMS */
1061 p++;
1063 if (!lose)
1065 #ifdef VMS
1066 if (index (nm, '/'))
1067 return build_string (sys_translate_unix (nm));
1068 #endif /* VMS */
1069 #ifdef DOS_NT
1070 /* Make sure directories are all separated with / or \ as
1071 desired, but avoid allocation of a new string when not
1072 required. */
1073 CORRECT_DIR_SEPS (nm);
1074 #ifdef WINDOWSNT
1075 if (IS_DIRECTORY_SEP (nm[1]))
1077 if (strcmp (nm, XSTRING (name)->data) != 0)
1078 name = build_string (nm);
1080 else
1081 #endif
1082 /* drive must be set, so this is okay */
1083 if (strcmp (nm - 2, XSTRING (name)->data) != 0)
1085 name = make_string (nm - 2, p - nm + 2);
1086 XSTRING (name)->data[0] = DRIVE_LETTER (drive);
1087 XSTRING (name)->data[1] = ':';
1089 return name;
1090 #else /* not DOS_NT */
1091 if (nm == XSTRING (name)->data)
1092 return name;
1093 return build_string (nm);
1094 #endif /* not DOS_NT */
1098 /* At this point, nm might or might not be an absolute file name. We
1099 need to expand ~ or ~user if present, otherwise prefix nm with
1100 default_directory if nm is not absolute, and finally collapse /./
1101 and /foo/../ sequences.
1103 We set newdir to be the appropriate prefix if one is needed:
1104 - the relevant user directory if nm starts with ~ or ~user
1105 - the specified drive's working dir (DOS/NT only) if nm does not
1106 start with /
1107 - the value of default_directory.
1109 Note that these prefixes are not guaranteed to be absolute (except
1110 for the working dir of a drive). Therefore, to ensure we always
1111 return an absolute name, if the final prefix is not absolute we
1112 append it to the current working directory. */
1114 newdir = 0;
1116 if (nm[0] == '~') /* prefix ~ */
1118 if (IS_DIRECTORY_SEP (nm[1])
1119 #ifdef VMS
1120 || nm[1] == ':'
1121 #endif /* VMS */
1122 || nm[1] == 0) /* ~ by itself */
1124 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1125 newdir = (unsigned char *) "";
1126 nm++;
1127 #ifdef DOS_NT
1128 collapse_newdir = 0;
1129 #endif
1130 #ifdef VMS
1131 nm++; /* Don't leave the slash in nm. */
1132 #endif /* VMS */
1134 else /* ~user/filename */
1136 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1137 #ifdef VMS
1138 && *p != ':'
1139 #endif /* VMS */
1140 ); p++);
1141 o = (unsigned char *) alloca (p - nm + 1);
1142 bcopy ((char *) nm, o, p - nm);
1143 o [p - nm] = 0;
1145 pw = (struct passwd *) getpwnam (o + 1);
1146 if (pw)
1148 newdir = (unsigned char *) pw -> pw_dir;
1149 #ifdef VMS
1150 nm = p + 1; /* skip the terminator */
1151 #else
1152 nm = p;
1153 #ifdef DOS_NT
1154 collapse_newdir = 0;
1155 #endif
1156 #endif /* VMS */
1159 /* If we don't find a user of that name, leave the name
1160 unchanged; don't move nm forward to p. */
1164 #ifdef DOS_NT
1165 /* On DOS and Windows, nm is absolute if a drive name was specified;
1166 use the drive's current directory as the prefix if needed. */
1167 if (!newdir && drive)
1169 /* Get default directory if needed to make nm absolute. */
1170 if (!IS_DIRECTORY_SEP (nm[0]))
1172 newdir = alloca (MAXPATHLEN + 1);
1173 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1174 newdir = NULL;
1176 if (!newdir)
1178 /* Either nm starts with /, or drive isn't mounted. */
1179 newdir = alloca (4);
1180 newdir[0] = DRIVE_LETTER (drive);
1181 newdir[1] = ':';
1182 newdir[2] = '/';
1183 newdir[3] = 0;
1186 #endif /* DOS_NT */
1188 /* Finally, if no prefix has been specified and nm is not absolute,
1189 then it must be expanded relative to default_directory. */
1191 if (1
1192 #ifndef DOS_NT
1193 /* /... alone is not absolute on DOS and Windows. */
1194 && !IS_DIRECTORY_SEP (nm[0])
1195 #endif
1196 #ifdef WINDOWSNT
1197 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1198 #endif
1199 #ifdef VMS
1200 && !index (nm, ':')
1201 #endif
1202 && !newdir)
1204 newdir = XSTRING (default_directory)->data;
1207 #ifdef DOS_NT
1208 if (newdir)
1210 /* First ensure newdir is an absolute name. */
1211 if (
1212 /* Detect MSDOS file names with drive specifiers. */
1213 ! (IS_DRIVE (newdir[0])
1214 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1215 #ifdef WINDOWSNT
1216 /* Detect Windows file names in UNC format. */
1217 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1218 #endif
1221 /* Effectively, let newdir be (expand-file-name newdir cwd).
1222 Because of the admonition against calling expand-file-name
1223 when we have pointers into lisp strings, we accomplish this
1224 indirectly by prepending newdir to nm if necessary, and using
1225 cwd (or the wd of newdir's drive) as the new newdir. */
1227 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1229 drive = newdir[0];
1230 newdir += 2;
1232 if (!IS_DIRECTORY_SEP (nm[0]))
1234 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1235 file_name_as_directory (tmp, newdir);
1236 strcat (tmp, nm);
1237 nm = tmp;
1239 newdir = alloca (MAXPATHLEN + 1);
1240 if (drive)
1242 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1243 newdir = "/";
1245 else
1246 getwd (newdir);
1249 /* Strip off drive name from prefix, if present. */
1250 if (IS_DRIVE (newdir[0]) && newdir[1] == ':')
1252 drive = newdir[0];
1253 newdir += 2;
1256 /* Keep only a prefix from newdir if nm starts with slash
1257 (//server/share for UNC, nothing otherwise). */
1258 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1260 #ifdef WINDOWSNT
1261 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1263 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1264 p = newdir + 2;
1265 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1266 p++;
1267 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1268 *p = 0;
1270 else
1271 #endif
1272 newdir = "";
1275 #endif /* DOS_NT */
1277 if (newdir)
1279 /* Get rid of any slash at the end of newdir, unless newdir is
1280 just // (an incomplete UNC name). */
1281 length = strlen (newdir);
1282 if (length > 0 && IS_DIRECTORY_SEP (newdir[length - 1])
1283 #ifdef WINDOWSNT
1284 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1285 #endif
1288 unsigned char *temp = (unsigned char *) alloca (length);
1289 bcopy (newdir, temp, length - 1);
1290 temp[length - 1] = 0;
1291 newdir = temp;
1293 tlen = length + 1;
1295 else
1296 tlen = 0;
1298 /* Now concatenate the directory and name to new space in the stack frame */
1299 tlen += strlen (nm) + 1;
1300 #ifdef DOS_NT
1301 /* Add reserved space for drive name. (The Microsoft x86 compiler
1302 produces incorrect code if the following two lines are combined.) */
1303 target = (unsigned char *) alloca (tlen + 2);
1304 target += 2;
1305 #else /* not DOS_NT */
1306 target = (unsigned char *) alloca (tlen);
1307 #endif /* not DOS_NT */
1308 *target = 0;
1310 if (newdir)
1312 #ifndef VMS
1313 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1314 strcpy (target, newdir);
1315 else
1316 #endif
1317 file_name_as_directory (target, newdir);
1320 strcat (target, nm);
1321 #ifdef VMS
1322 if (index (target, '/'))
1323 strcpy (target, sys_translate_unix (target));
1324 #endif /* VMS */
1326 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1328 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1330 p = target;
1331 o = target;
1333 while (*p)
1335 #ifdef VMS
1336 if (*p != ']' && *p != '>' && *p != '-')
1338 if (*p == '\\')
1339 p++;
1340 *o++ = *p++;
1342 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1343 /* brackets are offset from each other by 2 */
1345 p += 2;
1346 if (*p != '.' && *p != '-' && o[-1] != '.')
1347 /* convert [foo][bar] to [bar] */
1348 while (o[-1] != '[' && o[-1] != '<')
1349 o--;
1350 else if (*p == '-' && *o != '.')
1351 *--p = '.';
1353 else if (p[0] == '-' && o[-1] == '.' &&
1354 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1355 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1358 o--;
1359 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1360 if (p[1] == '.') /* foo.-.bar ==> bar. */
1361 p += 2;
1362 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1363 p++, o--;
1364 /* else [foo.-] ==> [-] */
1366 else
1368 #ifndef VMS4_4
1369 if (*p == '-' &&
1370 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1371 p[1] != ']' && p[1] != '>' && p[1] != '.')
1372 *p = '_';
1373 #endif /* VMS4_4 */
1374 *o++ = *p++;
1376 #else /* not VMS */
1377 if (!IS_DIRECTORY_SEP (*p))
1379 *o++ = *p++;
1381 else if (IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1])
1382 #if defined (APOLLO) || defined (WINDOWSNT)
1383 /* // at start of filename is meaningful in Apollo
1384 and WindowsNT systems. */
1385 && o != target
1386 #endif /* APOLLO || WINDOWSNT */
1389 o = target;
1390 p++;
1392 else if (IS_DIRECTORY_SEP (p[0])
1393 && p[1] == '.'
1394 && (IS_DIRECTORY_SEP (p[2])
1395 || p[2] == 0))
1397 /* If "/." is the entire filename, keep the "/". Otherwise,
1398 just delete the whole "/.". */
1399 if (o == target && p[2] == '\0')
1400 *o++ = *p;
1401 p += 2;
1403 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1404 /* `/../' is the "superroot" on certain file systems. */
1405 && o != target
1406 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1408 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1410 /* Keep initial / only if this is the whole name. */
1411 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1412 ++o;
1413 p += 3;
1415 else
1417 *o++ = *p++;
1419 #endif /* not VMS */
1422 #ifdef DOS_NT
1423 /* At last, set drive name. */
1424 #ifdef WINDOWSNT
1425 /* Except for network file name. */
1426 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1427 #endif /* WINDOWSNT */
1429 if (!drive) abort ();
1430 target -= 2;
1431 target[0] = DRIVE_LETTER (drive);
1432 target[1] = ':';
1434 CORRECT_DIR_SEPS (target);
1435 #endif /* DOS_NT */
1437 return make_string (target, o - target);
1440 #if 0
1441 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1442 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1443 "Convert FILENAME to absolute, and canonicalize it.\n\
1444 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1445 (does not start with slash); if DEFAULT is nil or missing,\n\
1446 the current buffer's value of default-directory is used.\n\
1447 Filenames containing `.' or `..' as components are simplified;\n\
1448 initial `~/' expands to your home directory.\n\
1449 See also the function `substitute-in-file-name'.")
1450 (name, defalt)
1451 Lisp_Object name, defalt;
1453 unsigned char *nm;
1455 register unsigned char *newdir, *p, *o;
1456 int tlen;
1457 unsigned char *target;
1458 struct passwd *pw;
1459 int lose;
1460 #ifdef VMS
1461 unsigned char * colon = 0;
1462 unsigned char * close = 0;
1463 unsigned char * slash = 0;
1464 unsigned char * brack = 0;
1465 int lbrack = 0, rbrack = 0;
1466 int dots = 0;
1467 #endif /* VMS */
1469 CHECK_STRING (name, 0);
1471 #ifdef VMS
1472 /* Filenames on VMS are always upper case. */
1473 name = Fupcase (name);
1474 #endif
1476 nm = XSTRING (name)->data;
1478 /* If nm is absolute, flush ...// and detect /./ and /../.
1479 If no /./ or /../ we can return right away. */
1480 if (
1481 nm[0] == '/'
1482 #ifdef VMS
1483 || index (nm, ':')
1484 #endif /* VMS */
1487 p = nm;
1488 lose = 0;
1489 while (*p)
1491 if (p[0] == '/' && p[1] == '/'
1492 #ifdef APOLLO
1493 /* // at start of filename is meaningful on Apollo system. */
1494 && nm != p
1495 #endif /* APOLLO */
1497 nm = p + 1;
1498 if (p[0] == '/' && p[1] == '~')
1499 nm = p + 1, lose = 1;
1500 if (p[0] == '/' && p[1] == '.'
1501 && (p[2] == '/' || p[2] == 0
1502 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1503 lose = 1;
1504 #ifdef VMS
1505 if (p[0] == '\\')
1506 lose = 1;
1507 if (p[0] == '/') {
1508 /* if dev:[dir]/, move nm to / */
1509 if (!slash && p > nm && (brack || colon)) {
1510 nm = (brack ? brack + 1 : colon + 1);
1511 lbrack = rbrack = 0;
1512 brack = 0;
1513 colon = 0;
1515 slash = p;
1517 if (p[0] == '-')
1518 #ifndef VMS4_4
1519 /* VMS pre V4.4,convert '-'s in filenames. */
1520 if (lbrack == rbrack)
1522 if (dots < 2) /* this is to allow negative version numbers */
1523 p[0] = '_';
1525 else
1526 #endif /* VMS4_4 */
1527 if (lbrack > rbrack &&
1528 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1529 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1530 lose = 1;
1531 #ifndef VMS4_4
1532 else
1533 p[0] = '_';
1534 #endif /* VMS4_4 */
1535 /* count open brackets, reset close bracket pointer */
1536 if (p[0] == '[' || p[0] == '<')
1537 lbrack++, brack = 0;
1538 /* count close brackets, set close bracket pointer */
1539 if (p[0] == ']' || p[0] == '>')
1540 rbrack++, brack = p;
1541 /* detect ][ or >< */
1542 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1543 lose = 1;
1544 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1545 nm = p + 1, lose = 1;
1546 if (p[0] == ':' && (colon || slash))
1547 /* if dev1:[dir]dev2:, move nm to dev2: */
1548 if (brack)
1550 nm = brack + 1;
1551 brack = 0;
1553 /* If /name/dev:, move nm to dev: */
1554 else if (slash)
1555 nm = slash + 1;
1556 /* If node::dev:, move colon following dev */
1557 else if (colon && colon[-1] == ':')
1558 colon = p;
1559 /* If dev1:dev2:, move nm to dev2: */
1560 else if (colon && colon[-1] != ':')
1562 nm = colon + 1;
1563 colon = 0;
1565 if (p[0] == ':' && !colon)
1567 if (p[1] == ':')
1568 p++;
1569 colon = p;
1571 if (lbrack == rbrack)
1572 if (p[0] == ';')
1573 dots = 2;
1574 else if (p[0] == '.')
1575 dots++;
1576 #endif /* VMS */
1577 p++;
1579 if (!lose)
1581 #ifdef VMS
1582 if (index (nm, '/'))
1583 return build_string (sys_translate_unix (nm));
1584 #endif /* VMS */
1585 if (nm == XSTRING (name)->data)
1586 return name;
1587 return build_string (nm);
1591 /* Now determine directory to start with and put it in NEWDIR */
1593 newdir = 0;
1595 if (nm[0] == '~') /* prefix ~ */
1596 if (nm[1] == '/'
1597 #ifdef VMS
1598 || nm[1] == ':'
1599 #endif /* VMS */
1600 || nm[1] == 0)/* ~/filename */
1602 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1603 newdir = (unsigned char *) "";
1604 nm++;
1605 #ifdef VMS
1606 nm++; /* Don't leave the slash in nm. */
1607 #endif /* VMS */
1609 else /* ~user/filename */
1611 /* Get past ~ to user */
1612 unsigned char *user = nm + 1;
1613 /* Find end of name. */
1614 unsigned char *ptr = (unsigned char *) index (user, '/');
1615 int len = ptr ? ptr - user : strlen (user);
1616 #ifdef VMS
1617 unsigned char *ptr1 = index (user, ':');
1618 if (ptr1 != 0 && ptr1 - user < len)
1619 len = ptr1 - user;
1620 #endif /* VMS */
1621 /* Copy the user name into temp storage. */
1622 o = (unsigned char *) alloca (len + 1);
1623 bcopy ((char *) user, o, len);
1624 o[len] = 0;
1626 /* Look up the user name. */
1627 pw = (struct passwd *) getpwnam (o + 1);
1628 if (!pw)
1629 error ("\"%s\" isn't a registered user", o + 1);
1631 newdir = (unsigned char *) pw->pw_dir;
1633 /* Discard the user name from NM. */
1634 nm += len;
1637 if (nm[0] != '/'
1638 #ifdef VMS
1639 && !index (nm, ':')
1640 #endif /* not VMS */
1641 && !newdir)
1643 if (NILP (defalt))
1644 defalt = current_buffer->directory;
1645 CHECK_STRING (defalt, 1);
1646 newdir = XSTRING (defalt)->data;
1649 /* Now concatenate the directory and name to new space in the stack frame */
1651 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1652 target = (unsigned char *) alloca (tlen);
1653 *target = 0;
1655 if (newdir)
1657 #ifndef VMS
1658 if (nm[0] == 0 || nm[0] == '/')
1659 strcpy (target, newdir);
1660 else
1661 #endif
1662 file_name_as_directory (target, newdir);
1665 strcat (target, nm);
1666 #ifdef VMS
1667 if (index (target, '/'))
1668 strcpy (target, sys_translate_unix (target));
1669 #endif /* VMS */
1671 /* Now canonicalize by removing /. and /foo/.. if they appear */
1673 p = target;
1674 o = target;
1676 while (*p)
1678 #ifdef VMS
1679 if (*p != ']' && *p != '>' && *p != '-')
1681 if (*p == '\\')
1682 p++;
1683 *o++ = *p++;
1685 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1686 /* brackets are offset from each other by 2 */
1688 p += 2;
1689 if (*p != '.' && *p != '-' && o[-1] != '.')
1690 /* convert [foo][bar] to [bar] */
1691 while (o[-1] != '[' && o[-1] != '<')
1692 o--;
1693 else if (*p == '-' && *o != '.')
1694 *--p = '.';
1696 else if (p[0] == '-' && o[-1] == '.' &&
1697 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1698 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1701 o--;
1702 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1703 if (p[1] == '.') /* foo.-.bar ==> bar. */
1704 p += 2;
1705 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1706 p++, o--;
1707 /* else [foo.-] ==> [-] */
1709 else
1711 #ifndef VMS4_4
1712 if (*p == '-' &&
1713 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1714 p[1] != ']' && p[1] != '>' && p[1] != '.')
1715 *p = '_';
1716 #endif /* VMS4_4 */
1717 *o++ = *p++;
1719 #else /* not VMS */
1720 if (*p != '/')
1722 *o++ = *p++;
1724 else if (!strncmp (p, "//", 2)
1725 #ifdef APOLLO
1726 /* // at start of filename is meaningful in Apollo system. */
1727 && o != target
1728 #endif /* APOLLO */
1731 o = target;
1732 p++;
1734 else if (p[0] == '/' && p[1] == '.' &&
1735 (p[2] == '/' || p[2] == 0))
1736 p += 2;
1737 else if (!strncmp (p, "/..", 3)
1738 /* `/../' is the "superroot" on certain file systems. */
1739 && o != target
1740 && (p[3] == '/' || p[3] == 0))
1742 while (o != target && *--o != '/')
1744 #ifdef APOLLO
1745 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
1746 ++o;
1747 else
1748 #endif /* APOLLO */
1749 if (o == target && *o == '/')
1750 ++o;
1751 p += 3;
1753 else
1755 *o++ = *p++;
1757 #endif /* not VMS */
1760 return make_string (target, o - target);
1762 #endif
1764 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
1765 Ssubstitute_in_file_name, 1, 1, 0,
1766 "Substitute environment variables referred to in FILENAME.\n\
1767 `$FOO' where FOO is an environment variable name means to substitute\n\
1768 the value of that variable. The variable name should be terminated\n\
1769 with a character not a letter, digit or underscore; otherwise, enclose\n\
1770 the entire variable name in braces.\n\
1771 If `/~' appears, all of FILENAME through that `/' is discarded.\n\n\
1772 On VMS, `$' substitution is not done; this function does little and only\n\
1773 duplicates what `expand-file-name' does.")
1774 (filename)
1775 Lisp_Object filename;
1777 unsigned char *nm;
1779 register unsigned char *s, *p, *o, *x, *endp;
1780 unsigned char *target;
1781 int total = 0;
1782 int substituted = 0;
1783 unsigned char *xnm;
1784 Lisp_Object handler;
1786 CHECK_STRING (filename, 0);
1788 /* If the file name has special constructs in it,
1789 call the corresponding file handler. */
1790 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
1791 if (!NILP (handler))
1792 return call2 (handler, Qsubstitute_in_file_name, filename);
1794 nm = XSTRING (filename)->data;
1795 #ifdef DOS_NT
1796 nm = strcpy (alloca (strlen (nm) + 1), nm);
1797 CORRECT_DIR_SEPS (nm);
1798 substituted = (strcmp (nm, XSTRING (filename)->data) != 0);
1799 #endif
1800 endp = nm + XSTRING (filename)->size;
1802 /* If /~ or // appears, discard everything through first slash. */
1804 for (p = nm; p != endp; p++)
1806 if ((p[0] == '~'
1807 #if defined (APOLLO) || defined (WINDOWSNT)
1808 /* // at start of file name is meaningful in Apollo and
1809 WindowsNT systems. */
1810 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != nm)
1811 #else /* not (APOLLO || WINDOWSNT) */
1812 || IS_DIRECTORY_SEP (p[0])
1813 #endif /* not (APOLLO || WINDOWSNT) */
1815 && p != nm
1816 && (0
1817 #ifdef VMS
1818 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
1819 #endif /* VMS */
1820 || IS_DIRECTORY_SEP (p[-1])))
1822 nm = p;
1823 substituted = 1;
1825 #ifdef DOS_NT
1826 /* see comment in expand-file-name about drive specifiers */
1827 else if (IS_DRIVE (p[0]) && p[1] == ':'
1828 && p > nm && IS_DIRECTORY_SEP (p[-1]))
1830 nm = p;
1831 substituted = 1;
1833 #endif /* DOS_NT */
1836 #ifdef VMS
1837 return build_string (nm);
1838 #else
1840 /* See if any variables are substituted into the string
1841 and find the total length of their values in `total' */
1843 for (p = nm; p != endp;)
1844 if (*p != '$')
1845 p++;
1846 else
1848 p++;
1849 if (p == endp)
1850 goto badsubst;
1851 else if (*p == '$')
1853 /* "$$" means a single "$" */
1854 p++;
1855 total -= 1;
1856 substituted = 1;
1857 continue;
1859 else if (*p == '{')
1861 o = ++p;
1862 while (p != endp && *p != '}') p++;
1863 if (*p != '}') goto missingclose;
1864 s = p;
1866 else
1868 o = p;
1869 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1870 s = p;
1873 /* Copy out the variable name */
1874 target = (unsigned char *) alloca (s - o + 1);
1875 strncpy (target, o, s - o);
1876 target[s - o] = 0;
1877 #ifdef DOS_NT
1878 strupr (target); /* $home == $HOME etc. */
1879 #endif /* DOS_NT */
1881 /* Get variable value */
1882 o = (unsigned char *) egetenv (target);
1883 if (!o) goto badvar;
1884 total += strlen (o);
1885 substituted = 1;
1888 if (!substituted)
1889 return filename;
1891 /* If substitution required, recopy the string and do it */
1892 /* Make space in stack frame for the new copy */
1893 xnm = (unsigned char *) alloca (XSTRING (filename)->size + total + 1);
1894 x = xnm;
1896 /* Copy the rest of the name through, replacing $ constructs with values */
1897 for (p = nm; *p;)
1898 if (*p != '$')
1899 *x++ = *p++;
1900 else
1902 p++;
1903 if (p == endp)
1904 goto badsubst;
1905 else if (*p == '$')
1907 *x++ = *p++;
1908 continue;
1910 else if (*p == '{')
1912 o = ++p;
1913 while (p != endp && *p != '}') p++;
1914 if (*p != '}') goto missingclose;
1915 s = p++;
1917 else
1919 o = p;
1920 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1921 s = p;
1924 /* Copy out the variable name */
1925 target = (unsigned char *) alloca (s - o + 1);
1926 strncpy (target, o, s - o);
1927 target[s - o] = 0;
1928 #ifdef DOS_NT
1929 strupr (target); /* $home == $HOME etc. */
1930 #endif /* DOS_NT */
1932 /* Get variable value */
1933 o = (unsigned char *) egetenv (target);
1934 if (!o)
1935 goto badvar;
1937 strcpy (x, o);
1938 x += strlen (o);
1941 *x = 0;
1943 /* If /~ or // appears, discard everything through first slash. */
1945 for (p = xnm; p != x; p++)
1946 if ((p[0] == '~'
1947 #if defined (APOLLO) || defined (WINDOWSNT)
1948 || (IS_DIRECTORY_SEP (p[0]) && p - 1 != xnm)
1949 #else /* not (APOLLO || WINDOWSNT) */
1950 || IS_DIRECTORY_SEP (p[0])
1951 #endif /* not (APOLLO || WINDOWSNT) */
1953 && p != xnm && IS_DIRECTORY_SEP (p[-1]))
1954 xnm = p;
1955 #ifdef DOS_NT
1956 else if (IS_DRIVE (p[0]) && p[1] == ':'
1957 && p > nm && IS_DIRECTORY_SEP (p[-1]))
1958 xnm = p;
1959 #endif
1961 return make_string (xnm, x - xnm);
1963 badsubst:
1964 error ("Bad format environment-variable substitution");
1965 missingclose:
1966 error ("Missing \"}\" in environment-variable substitution");
1967 badvar:
1968 error ("Substituting nonexistent environment variable \"%s\"", target);
1970 /* NOTREACHED */
1971 #endif /* not VMS */
1974 /* A slightly faster and more convenient way to get
1975 (directory-file-name (expand-file-name FOO)). */
1977 Lisp_Object
1978 expand_and_dir_to_file (filename, defdir)
1979 Lisp_Object filename, defdir;
1981 register Lisp_Object absname;
1983 absname = Fexpand_file_name (filename, defdir);
1984 #ifdef VMS
1986 register int c = XSTRING (absname)->data[XSTRING (absname)->size - 1];
1987 if (c == ':' || c == ']' || c == '>')
1988 absname = Fdirectory_file_name (absname);
1990 #else
1991 /* Remove final slash, if any (unless this is the root dir).
1992 stat behaves differently depending! */
1993 if (XSTRING (absname)->size > 1
1994 && IS_DIRECTORY_SEP (XSTRING (absname)->data[XSTRING (absname)->size - 1])
1995 && !IS_DEVICE_SEP (XSTRING (absname)->data[XSTRING (absname)->size-2]))
1996 /* We cannot take shortcuts; they might be wrong for magic file names. */
1997 absname = Fdirectory_file_name (absname);
1998 #endif
1999 return absname;
2002 /* Signal an error if the file ABSNAME already exists.
2003 If INTERACTIVE is nonzero, ask the user whether to proceed,
2004 and bypass the error if the user says to go ahead.
2005 QUERYSTRING is a name for the action that is being considered
2006 to alter the file.
2007 *STATPTR is used to store the stat information if the file exists.
2008 If the file does not exist, STATPTR->st_mode is set to 0. */
2010 void
2011 barf_or_query_if_file_exists (absname, querystring, interactive, statptr)
2012 Lisp_Object absname;
2013 unsigned char *querystring;
2014 int interactive;
2015 struct stat *statptr;
2017 register Lisp_Object tem;
2018 struct stat statbuf;
2019 struct gcpro gcpro1;
2021 /* stat is a good way to tell whether the file exists,
2022 regardless of what access permissions it has. */
2023 if (stat (XSTRING (absname)->data, &statbuf) >= 0)
2025 if (! interactive)
2026 Fsignal (Qfile_already_exists,
2027 Fcons (build_string ("File already exists"),
2028 Fcons (absname, Qnil)));
2029 GCPRO1 (absname);
2030 tem = do_yes_or_no_p (format1 ("File %s already exists; %s anyway? ",
2031 XSTRING (absname)->data, querystring));
2032 UNGCPRO;
2033 if (NILP (tem))
2034 Fsignal (Qfile_already_exists,
2035 Fcons (build_string ("File already exists"),
2036 Fcons (absname, Qnil)));
2037 if (statptr)
2038 *statptr = statbuf;
2040 else
2042 if (statptr)
2043 statptr->st_mode = 0;
2045 return;
2048 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 4,
2049 "fCopy file: \nFCopy %s to file: \np\nP",
2050 "Copy FILE to NEWNAME. Both args must be strings.\n\
2051 Signals a `file-already-exists' error if file NEWNAME already exists,\n\
2052 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.\n\
2053 A number as third arg means request confirmation if NEWNAME already exists.\n\
2054 This is what happens in interactive use with M-x.\n\
2055 Fourth arg KEEP-TIME non-nil means give the new file the same\n\
2056 last-modified time as the old one. (This works on only some systems.)\n\
2057 A prefix arg makes KEEP-TIME non-nil.")
2058 (file, newname, ok_if_already_exists, keep_date)
2059 Lisp_Object file, newname, ok_if_already_exists, keep_date;
2061 int ifd, ofd, n;
2062 char buf[16 * 1024];
2063 struct stat st, out_st;
2064 Lisp_Object handler;
2065 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2066 int count = specpdl_ptr - specpdl;
2067 int input_file_statable_p;
2068 Lisp_Object encoded_file, encoded_newname;
2070 encoded_file = encoded_newname = Qnil;
2071 GCPRO4 (file, newname, encoded_file, encoded_newname);
2072 CHECK_STRING (file, 0);
2073 CHECK_STRING (newname, 1);
2075 file = Fexpand_file_name (file, Qnil);
2076 newname = Fexpand_file_name (newname, Qnil);
2078 /* If the input file name has special constructs in it,
2079 call the corresponding file handler. */
2080 handler = Ffind_file_name_handler (file, Qcopy_file);
2081 /* Likewise for output file name. */
2082 if (NILP (handler))
2083 handler = Ffind_file_name_handler (newname, Qcopy_file);
2084 if (!NILP (handler))
2085 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2086 ok_if_already_exists, keep_date));
2088 encoded_file = ENCODE_FILE (file);
2089 encoded_newname = ENCODE_FILE (newname);
2091 if (NILP (ok_if_already_exists)
2092 || INTEGERP (ok_if_already_exists))
2093 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2094 INTEGERP (ok_if_already_exists), &out_st);
2095 else if (stat (XSTRING (encoded_newname)->data, &out_st) < 0)
2096 out_st.st_mode = 0;
2098 ifd = open (XSTRING (encoded_file)->data, O_RDONLY);
2099 if (ifd < 0)
2100 report_file_error ("Opening input file", Fcons (file, Qnil));
2102 record_unwind_protect (close_file_unwind, make_number (ifd));
2104 /* We can only copy regular files and symbolic links. Other files are not
2105 copyable by us. */
2106 input_file_statable_p = (fstat (ifd, &st) >= 0);
2108 #if !defined (MSDOS) || __DJGPP__ > 1
2109 if (out_st.st_mode != 0
2110 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2112 errno = 0;
2113 report_file_error ("Input and output files are the same",
2114 Fcons (file, Fcons (newname, Qnil)));
2116 #endif
2118 #if defined (S_ISREG) && defined (S_ISLNK)
2119 if (input_file_statable_p)
2121 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2123 #if defined (EISDIR)
2124 /* Get a better looking error message. */
2125 errno = EISDIR;
2126 #endif /* EISDIR */
2127 report_file_error ("Non-regular file", Fcons (file, Qnil));
2130 #endif /* S_ISREG && S_ISLNK */
2132 #ifdef VMS
2133 /* Create the copy file with the same record format as the input file */
2134 ofd = sys_creat (XSTRING (encoded_newname)->data, 0666, ifd);
2135 #else
2136 #ifdef MSDOS
2137 /* System's default file type was set to binary by _fmode in emacs.c. */
2138 ofd = creat (XSTRING (encoded_newname)->data, S_IREAD | S_IWRITE);
2139 #else /* not MSDOS */
2140 ofd = creat (XSTRING (encoded_newname)->data, 0666);
2141 #endif /* not MSDOS */
2142 #endif /* VMS */
2143 if (ofd < 0)
2144 report_file_error ("Opening output file", Fcons (newname, Qnil));
2146 record_unwind_protect (close_file_unwind, make_number (ofd));
2148 immediate_quit = 1;
2149 QUIT;
2150 while ((n = read (ifd, buf, sizeof buf)) > 0)
2151 if (write (ofd, buf, n) != n)
2152 report_file_error ("I/O error", Fcons (newname, Qnil));
2153 immediate_quit = 0;
2155 /* Closing the output clobbers the file times on some systems. */
2156 if (close (ofd) < 0)
2157 report_file_error ("I/O error", Fcons (newname, Qnil));
2159 if (input_file_statable_p)
2161 if (!NILP (keep_date))
2163 EMACS_TIME atime, mtime;
2164 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2165 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2166 if (set_file_times (XSTRING (encoded_newname)->data,
2167 atime, mtime))
2168 Fsignal (Qfile_date_error,
2169 Fcons (build_string ("Cannot set file date"),
2170 Fcons (newname, Qnil)));
2172 #ifndef MSDOS
2173 chmod (XSTRING (encoded_newname)->data, st.st_mode & 07777);
2174 #else /* MSDOS */
2175 #if defined (__DJGPP__) && __DJGPP__ > 1
2176 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2177 and if it can't, it tells so. Otherwise, under MSDOS we usually
2178 get only the READ bit, which will make the copied file read-only,
2179 so it's better not to chmod at all. */
2180 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2181 chmod (XSTRING (encoded_newname)->data, st.st_mode & 07777);
2182 #endif /* DJGPP version 2 or newer */
2183 #endif /* MSDOS */
2186 close (ifd);
2188 /* Discard the unwind protects. */
2189 specpdl_ptr = specpdl + count;
2191 UNGCPRO;
2192 return Qnil;
2195 DEFUN ("make-directory-internal", Fmake_directory_internal,
2196 Smake_directory_internal, 1, 1, 0,
2197 "Create a new directory named DIRECTORY.")
2198 (directory)
2199 Lisp_Object directory;
2201 unsigned char *dir;
2202 Lisp_Object handler;
2203 Lisp_Object encoded_dir;
2205 CHECK_STRING (directory, 0);
2206 directory = Fexpand_file_name (directory, Qnil);
2208 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2209 if (!NILP (handler))
2210 return call2 (handler, Qmake_directory_internal, directory);
2212 encoded_dir = ENCODE_FILE (directory);
2214 dir = XSTRING (encoded_dir)->data;
2216 #ifdef WINDOWSNT
2217 if (mkdir (dir) != 0)
2218 #else
2219 if (mkdir (dir, 0777) != 0)
2220 #endif
2221 report_file_error ("Creating directory", Flist (1, &directory));
2223 return Qnil;
2226 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2227 "Delete the directory named DIRECTORY.")
2228 (directory)
2229 Lisp_Object directory;
2231 unsigned char *dir;
2232 Lisp_Object handler;
2233 Lisp_Object encoded_dir;
2235 CHECK_STRING (directory, 0);
2236 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2238 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2239 if (!NILP (handler))
2240 return call2 (handler, Qdelete_directory, directory);
2242 encoded_dir = ENCODE_FILE (directory);
2244 dir = XSTRING (encoded_dir)->data;
2246 if (rmdir (dir) != 0)
2247 report_file_error ("Removing directory", Flist (1, &directory));
2249 return Qnil;
2252 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2253 "Delete file named FILENAME.\n\
2254 If file has multiple names, it continues to exist with the other names.")
2255 (filename)
2256 Lisp_Object filename;
2258 Lisp_Object handler;
2259 Lisp_Object encoded_file;
2261 CHECK_STRING (filename, 0);
2262 filename = Fexpand_file_name (filename, Qnil);
2264 handler = Ffind_file_name_handler (filename, Qdelete_file);
2265 if (!NILP (handler))
2266 return call2 (handler, Qdelete_file, filename);
2268 encoded_file = ENCODE_FILE (filename);
2270 if (0 > unlink (XSTRING (encoded_file)->data))
2271 report_file_error ("Removing old name", Flist (1, &filename));
2272 return Qnil;
2275 static Lisp_Object
2276 internal_delete_file_1 (ignore)
2277 Lisp_Object ignore;
2279 return Qt;
2282 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2285 internal_delete_file (filename)
2286 Lisp_Object filename;
2288 return NILP (internal_condition_case_1 (Fdelete_file, filename,
2289 Qt, internal_delete_file_1));
2292 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2293 "fRename file: \nFRename %s to file: \np",
2294 "Rename FILE as NEWNAME. Both args strings.\n\
2295 If file has names other than FILE, it continues to have those names.\n\
2296 Signals a `file-already-exists' error if a file NEWNAME already exists\n\
2297 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2298 A number as third arg means request confirmation if NEWNAME already exists.\n\
2299 This is what happens in interactive use with M-x.")
2300 (file, newname, ok_if_already_exists)
2301 Lisp_Object file, newname, ok_if_already_exists;
2303 #ifdef NO_ARG_ARRAY
2304 Lisp_Object args[2];
2305 #endif
2306 Lisp_Object handler;
2307 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2308 Lisp_Object encoded_file, encoded_newname;
2310 encoded_file = encoded_newname = Qnil;
2311 GCPRO4 (file, newname, encoded_file, encoded_newname);
2312 CHECK_STRING (file, 0);
2313 CHECK_STRING (newname, 1);
2314 file = Fexpand_file_name (file, Qnil);
2315 newname = Fexpand_file_name (newname, Qnil);
2317 /* If the file name has special constructs in it,
2318 call the corresponding file handler. */
2319 handler = Ffind_file_name_handler (file, Qrename_file);
2320 if (NILP (handler))
2321 handler = Ffind_file_name_handler (newname, Qrename_file);
2322 if (!NILP (handler))
2323 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2324 file, newname, ok_if_already_exists));
2326 encoded_file = ENCODE_FILE (file);
2327 encoded_newname = ENCODE_FILE (newname);
2329 if (NILP (ok_if_already_exists)
2330 || INTEGERP (ok_if_already_exists))
2331 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2332 INTEGERP (ok_if_already_exists), 0);
2333 #ifndef BSD4_1
2334 if (0 > rename (XSTRING (encoded_file)->data, XSTRING (encoded_newname)->data))
2335 #else
2336 if (0 > link (XSTRING (encoded_file)->data, XSTRING (encoded_newname)->data)
2337 || 0 > unlink (XSTRING (encoded_file)->data))
2338 #endif
2340 if (errno == EXDEV)
2342 Fcopy_file (file, newname,
2343 /* We have already prompted if it was an integer,
2344 so don't have copy-file prompt again. */
2345 NILP (ok_if_already_exists) ? Qnil : Qt, Qt);
2346 Fdelete_file (file);
2348 else
2349 #ifdef NO_ARG_ARRAY
2351 args[0] = file;
2352 args[1] = newname;
2353 report_file_error ("Renaming", Flist (2, args));
2355 #else
2356 report_file_error ("Renaming", Flist (2, &file));
2357 #endif
2359 UNGCPRO;
2360 return Qnil;
2363 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2364 "fAdd name to file: \nFName to add to %s: \np",
2365 "Give FILE additional name NEWNAME. Both args strings.\n\
2366 Signals a `file-already-exists' error if a file NEWNAME already exists\n\
2367 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2368 A number as third arg means request confirmation if NEWNAME already exists.\n\
2369 This is what happens in interactive use with M-x.")
2370 (file, newname, ok_if_already_exists)
2371 Lisp_Object file, newname, ok_if_already_exists;
2373 #ifdef NO_ARG_ARRAY
2374 Lisp_Object args[2];
2375 #endif
2376 Lisp_Object handler;
2377 Lisp_Object encoded_file, encoded_newname;
2378 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2380 GCPRO4 (file, newname, encoded_file, encoded_newname);
2381 encoded_file = encoded_newname = Qnil;
2382 CHECK_STRING (file, 0);
2383 CHECK_STRING (newname, 1);
2384 file = Fexpand_file_name (file, Qnil);
2385 newname = Fexpand_file_name (newname, Qnil);
2387 /* If the file name has special constructs in it,
2388 call the corresponding file handler. */
2389 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2390 if (!NILP (handler))
2391 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2392 newname, ok_if_already_exists));
2394 /* If the new name has special constructs in it,
2395 call the corresponding file handler. */
2396 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2397 if (!NILP (handler))
2398 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2399 newname, ok_if_already_exists));
2401 encoded_file = ENCODE_FILE (file);
2402 encoded_newname = ENCODE_FILE (newname);
2404 if (NILP (ok_if_already_exists)
2405 || INTEGERP (ok_if_already_exists))
2406 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2407 INTEGERP (ok_if_already_exists), 0);
2409 unlink (XSTRING (newname)->data);
2410 if (0 > link (XSTRING (encoded_file)->data, XSTRING (encoded_newname)->data))
2412 #ifdef NO_ARG_ARRAY
2413 args[0] = file;
2414 args[1] = newname;
2415 report_file_error ("Adding new name", Flist (2, args));
2416 #else
2417 report_file_error ("Adding new name", Flist (2, &file));
2418 #endif
2421 UNGCPRO;
2422 return Qnil;
2425 #ifdef S_IFLNK
2426 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2427 "FMake symbolic link to file: \nFMake symbolic link to file %s: \np",
2428 "Make a symbolic link to FILENAME, named LINKNAME. Both args strings.\n\
2429 Signals a `file-already-exists' error if a file LINKNAME already exists\n\
2430 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2431 A number as third arg means request confirmation if LINKNAME already exists.\n\
2432 This happens for interactive use with M-x.")
2433 (filename, linkname, ok_if_already_exists)
2434 Lisp_Object filename, linkname, ok_if_already_exists;
2436 #ifdef NO_ARG_ARRAY
2437 Lisp_Object args[2];
2438 #endif
2439 Lisp_Object handler;
2440 Lisp_Object encoded_filename, encoded_linkname;
2441 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2443 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2444 encoded_filename = encoded_linkname = Qnil;
2445 CHECK_STRING (filename, 0);
2446 CHECK_STRING (linkname, 1);
2447 /* If the link target has a ~, we must expand it to get
2448 a truly valid file name. Otherwise, do not expand;
2449 we want to permit links to relative file names. */
2450 if (XSTRING (filename)->data[0] == '~')
2451 filename = Fexpand_file_name (filename, Qnil);
2452 linkname = Fexpand_file_name (linkname, Qnil);
2454 /* If the file name has special constructs in it,
2455 call the corresponding file handler. */
2456 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2457 if (!NILP (handler))
2458 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2459 linkname, ok_if_already_exists));
2461 /* If the new link name has special constructs in it,
2462 call the corresponding file handler. */
2463 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2464 if (!NILP (handler))
2465 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2466 linkname, ok_if_already_exists));
2468 encoded_filename = ENCODE_FILE (filename);
2469 encoded_linkname = ENCODE_FILE (linkname);
2471 if (NILP (ok_if_already_exists)
2472 || INTEGERP (ok_if_already_exists))
2473 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2474 INTEGERP (ok_if_already_exists), 0);
2475 if (0 > symlink (XSTRING (encoded_filename)->data,
2476 XSTRING (encoded_linkname)->data))
2478 /* If we didn't complain already, silently delete existing file. */
2479 if (errno == EEXIST)
2481 unlink (XSTRING (encoded_linkname)->data);
2482 if (0 <= symlink (XSTRING (encoded_filename)->data,
2483 XSTRING (encoded_linkname)->data))
2485 UNGCPRO;
2486 return Qnil;
2490 #ifdef NO_ARG_ARRAY
2491 args[0] = filename;
2492 args[1] = linkname;
2493 report_file_error ("Making symbolic link", Flist (2, args));
2494 #else
2495 report_file_error ("Making symbolic link", Flist (2, &filename));
2496 #endif
2498 UNGCPRO;
2499 return Qnil;
2501 #endif /* S_IFLNK */
2503 #ifdef VMS
2505 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2506 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2507 "Define the job-wide logical name NAME to have the value STRING.\n\
2508 If STRING is nil or a null string, the logical name NAME is deleted.")
2509 (name, string)
2510 Lisp_Object name;
2511 Lisp_Object string;
2513 CHECK_STRING (name, 0);
2514 if (NILP (string))
2515 delete_logical_name (XSTRING (name)->data);
2516 else
2518 CHECK_STRING (string, 1);
2520 if (XSTRING (string)->size == 0)
2521 delete_logical_name (XSTRING (name)->data);
2522 else
2523 define_logical_name (XSTRING (name)->data, XSTRING (string)->data);
2526 return string;
2528 #endif /* VMS */
2530 #ifdef HPUX_NET
2532 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2533 "Open a network connection to PATH using LOGIN as the login string.")
2534 (path, login)
2535 Lisp_Object path, login;
2537 int netresult;
2539 CHECK_STRING (path, 0);
2540 CHECK_STRING (login, 0);
2542 netresult = netunam (XSTRING (path)->data, XSTRING (login)->data);
2544 if (netresult == -1)
2545 return Qnil;
2546 else
2547 return Qt;
2549 #endif /* HPUX_NET */
2551 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2552 1, 1, 0,
2553 "Return t if file FILENAME specifies an absolute file name.\n\
2554 On Unix, this is a name starting with a `/' or a `~'.")
2555 (filename)
2556 Lisp_Object filename;
2558 unsigned char *ptr;
2560 CHECK_STRING (filename, 0);
2561 ptr = XSTRING (filename)->data;
2562 if (IS_DIRECTORY_SEP (*ptr) || *ptr == '~'
2563 #ifdef VMS
2564 /* ??? This criterion is probably wrong for '<'. */
2565 || index (ptr, ':') || index (ptr, '<')
2566 || (*ptr == '[' && (ptr[1] != '-' || (ptr[2] != '.' && ptr[2] != ']'))
2567 && ptr[1] != '.')
2568 #endif /* VMS */
2569 #ifdef DOS_NT
2570 || (IS_DRIVE (*ptr) && ptr[1] == ':' && IS_DIRECTORY_SEP (ptr[2]))
2571 #endif
2573 return Qt;
2574 else
2575 return Qnil;
2578 /* Return nonzero if file FILENAME exists and can be executed. */
2580 static int
2581 check_executable (filename)
2582 char *filename;
2584 #ifdef DOS_NT
2585 int len = strlen (filename);
2586 char *suffix;
2587 struct stat st;
2588 if (stat (filename, &st) < 0)
2589 return 0;
2590 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2591 return ((st.st_mode & S_IEXEC) != 0);
2592 #else
2593 return (S_ISREG (st.st_mode)
2594 && len >= 5
2595 && (stricmp ((suffix = filename + len-4), ".com") == 0
2596 || stricmp (suffix, ".exe") == 0
2597 || stricmp (suffix, ".bat") == 0)
2598 || (st.st_mode & S_IFMT) == S_IFDIR);
2599 #endif /* not WINDOWSNT */
2600 #else /* not DOS_NT */
2601 #ifdef HAVE_EUIDACCESS
2602 return (euidaccess (filename, 1) >= 0);
2603 #else
2604 /* Access isn't quite right because it uses the real uid
2605 and we really want to test with the effective uid.
2606 But Unix doesn't give us a right way to do it. */
2607 return (access (filename, 1) >= 0);
2608 #endif
2609 #endif /* not DOS_NT */
2612 /* Return nonzero if file FILENAME exists and can be written. */
2614 static int
2615 check_writable (filename)
2616 char *filename;
2618 #ifdef MSDOS
2619 struct stat st;
2620 if (stat (filename, &st) < 0)
2621 return 0;
2622 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
2623 #else /* not MSDOS */
2624 #ifdef HAVE_EUIDACCESS
2625 return (euidaccess (filename, 2) >= 0);
2626 #else
2627 /* Access isn't quite right because it uses the real uid
2628 and we really want to test with the effective uid.
2629 But Unix doesn't give us a right way to do it.
2630 Opening with O_WRONLY could work for an ordinary file,
2631 but would lose for directories. */
2632 return (access (filename, 2) >= 0);
2633 #endif
2634 #endif /* not MSDOS */
2637 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2638 "Return t if file FILENAME exists. (This does not mean you can read it.)\n\
2639 See also `file-readable-p' and `file-attributes'.")
2640 (filename)
2641 Lisp_Object filename;
2643 Lisp_Object absname;
2644 Lisp_Object handler;
2645 struct stat statbuf;
2647 CHECK_STRING (filename, 0);
2648 absname = Fexpand_file_name (filename, Qnil);
2650 /* If the file name has special constructs in it,
2651 call the corresponding file handler. */
2652 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
2653 if (!NILP (handler))
2654 return call2 (handler, Qfile_exists_p, absname);
2656 absname = ENCODE_FILE (absname);
2658 return (stat (XSTRING (absname)->data, &statbuf) >= 0) ? Qt : Qnil;
2661 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2662 "Return t if FILENAME can be executed by you.\n\
2663 For a directory, this means you can access files in that directory.")
2664 (filename)
2665 Lisp_Object filename;
2668 Lisp_Object absname;
2669 Lisp_Object handler;
2671 CHECK_STRING (filename, 0);
2672 absname = Fexpand_file_name (filename, Qnil);
2674 /* If the file name has special constructs in it,
2675 call the corresponding file handler. */
2676 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
2677 if (!NILP (handler))
2678 return call2 (handler, Qfile_executable_p, absname);
2680 absname = ENCODE_FILE (absname);
2682 return (check_executable (XSTRING (absname)->data) ? Qt : Qnil);
2685 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
2686 "Return t if file FILENAME exists and you can read it.\n\
2687 See also `file-exists-p' and `file-attributes'.")
2688 (filename)
2689 Lisp_Object filename;
2691 Lisp_Object absname;
2692 Lisp_Object handler;
2693 int desc;
2694 int flags;
2695 struct stat statbuf;
2697 CHECK_STRING (filename, 0);
2698 absname = Fexpand_file_name (filename, Qnil);
2700 /* If the file name has special constructs in it,
2701 call the corresponding file handler. */
2702 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
2703 if (!NILP (handler))
2704 return call2 (handler, Qfile_readable_p, absname);
2706 absname = ENCODE_FILE (absname);
2708 #ifdef DOS_NT
2709 /* Under MS-DOS and Windows, open does not work for directories. */
2710 if (access (XSTRING (absname)->data, 0) == 0)
2711 return Qt;
2712 return Qnil;
2713 #else /* not DOS_NT */
2714 flags = O_RDONLY;
2715 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2716 /* Opening a fifo without O_NONBLOCK can wait.
2717 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2718 except in the case of a fifo, on a system which handles it. */
2719 desc = stat (XSTRING (absname)->data, &statbuf);
2720 if (desc < 0)
2721 return Qnil;
2722 if (S_ISFIFO (statbuf.st_mode))
2723 flags |= O_NONBLOCK;
2724 #endif
2725 desc = open (XSTRING (absname)->data, flags);
2726 if (desc < 0)
2727 return Qnil;
2728 close (desc);
2729 return Qt;
2730 #endif /* not DOS_NT */
2733 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2734 on the RT/PC. */
2735 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
2736 "Return t if file FILENAME can be written or created by you.")
2737 (filename)
2738 Lisp_Object filename;
2740 Lisp_Object absname, dir, encoded;
2741 Lisp_Object handler;
2742 struct stat statbuf;
2744 CHECK_STRING (filename, 0);
2745 absname = Fexpand_file_name (filename, Qnil);
2747 /* If the file name has special constructs in it,
2748 call the corresponding file handler. */
2749 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
2750 if (!NILP (handler))
2751 return call2 (handler, Qfile_writable_p, absname);
2753 encoded = ENCODE_FILE (absname);
2754 if (stat (XSTRING (encoded)->data, &statbuf) >= 0)
2755 return (check_writable (XSTRING (encoded)->data)
2756 ? Qt : Qnil);
2758 dir = Ffile_name_directory (absname);
2759 #ifdef VMS
2760 if (!NILP (dir))
2761 dir = Fdirectory_file_name (dir);
2762 #endif /* VMS */
2763 #ifdef MSDOS
2764 if (!NILP (dir))
2765 dir = Fdirectory_file_name (dir);
2766 #endif /* MSDOS */
2768 dir = ENCODE_FILE (dir);
2769 return (check_writable (!NILP (dir) ? (char *) XSTRING (dir)->data : "")
2770 ? Qt : Qnil);
2773 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
2774 "Access file FILENAME, and get an error if that does not work.\n\
2775 The second argument STRING is used in the error message.\n\
2776 If there is no error, we return nil.")
2777 (filename, string)
2778 Lisp_Object filename, string;
2780 Lisp_Object handler, encoded_filename;
2781 int fd;
2783 CHECK_STRING (filename, 0);
2785 /* If the file name has special constructs in it,
2786 call the corresponding file handler. */
2787 handler = Ffind_file_name_handler (filename, Qaccess_file);
2788 if (!NILP (handler))
2789 return call3 (handler, Qaccess_file, filename, string);
2791 encoded_filename = ENCODE_FILE (filename);
2793 fd = open (XSTRING (encoded_filename)->data, O_RDONLY);
2794 if (fd < 0)
2795 report_file_error (XSTRING (string)->data, Fcons (filename, Qnil));
2796 close (fd);
2798 return Qnil;
2801 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
2802 "Return non-nil if file FILENAME is the name of a symbolic link.\n\
2803 The value is the name of the file to which it is linked.\n\
2804 Otherwise returns nil.")
2805 (filename)
2806 Lisp_Object filename;
2808 #ifdef S_IFLNK
2809 char *buf;
2810 int bufsize;
2811 int valsize;
2812 Lisp_Object val;
2813 Lisp_Object handler;
2815 CHECK_STRING (filename, 0);
2816 filename = Fexpand_file_name (filename, Qnil);
2818 /* If the file name has special constructs in it,
2819 call the corresponding file handler. */
2820 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
2821 if (!NILP (handler))
2822 return call2 (handler, Qfile_symlink_p, filename);
2824 filename = ENCODE_FILE (filename);
2826 bufsize = 100;
2827 while (1)
2829 buf = (char *) xmalloc (bufsize);
2830 bzero (buf, bufsize);
2831 valsize = readlink (XSTRING (filename)->data, buf, bufsize);
2832 if (valsize < bufsize) break;
2833 /* Buffer was not long enough */
2834 xfree (buf);
2835 bufsize *= 2;
2837 if (valsize == -1)
2839 xfree (buf);
2840 return Qnil;
2842 val = make_string (buf, valsize);
2843 xfree (buf);
2844 return Fdecode_coding_string (val, Vfile_name_coding_system, Qt);
2845 #else /* not S_IFLNK */
2846 return Qnil;
2847 #endif /* not S_IFLNK */
2850 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
2851 "Return t if FILENAME names an existing directory.")
2852 (filename)
2853 Lisp_Object filename;
2855 register Lisp_Object absname;
2856 struct stat st;
2857 Lisp_Object handler;
2859 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2861 /* If the file name has special constructs in it,
2862 call the corresponding file handler. */
2863 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
2864 if (!NILP (handler))
2865 return call2 (handler, Qfile_directory_p, absname);
2867 absname = ENCODE_FILE (absname);
2869 if (stat (XSTRING (absname)->data, &st) < 0)
2870 return Qnil;
2871 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
2874 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
2875 "Return t if file FILENAME is the name of a directory as a file,\n\
2876 and files in that directory can be opened by you. In order to use a\n\
2877 directory as a buffer's current directory, this predicate must return true.\n\
2878 A directory name spec may be given instead; then the value is t\n\
2879 if the directory so specified exists and really is a readable and\n\
2880 searchable directory.")
2881 (filename)
2882 Lisp_Object filename;
2884 Lisp_Object handler;
2885 int tem;
2886 struct gcpro gcpro1;
2888 /* If the file name has special constructs in it,
2889 call the corresponding file handler. */
2890 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
2891 if (!NILP (handler))
2892 return call2 (handler, Qfile_accessible_directory_p, filename);
2894 /* It's an unlikely combination, but yes we really do need to gcpro:
2895 Suppose that file-accessible-directory-p has no handler, but
2896 file-directory-p does have a handler; this handler causes a GC which
2897 relocates the string in `filename'; and finally file-directory-p
2898 returns non-nil. Then we would end up passing a garbaged string
2899 to file-executable-p. */
2900 GCPRO1 (filename);
2901 tem = (NILP (Ffile_directory_p (filename))
2902 || NILP (Ffile_executable_p (filename)));
2903 UNGCPRO;
2904 return tem ? Qnil : Qt;
2907 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
2908 "Return t if file FILENAME is the name of a regular file.\n\
2909 This is the sort of file that holds an ordinary stream of data bytes.")
2910 (filename)
2911 Lisp_Object filename;
2913 register Lisp_Object absname;
2914 struct stat st;
2915 Lisp_Object handler;
2917 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2919 /* If the file name has special constructs in it,
2920 call the corresponding file handler. */
2921 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
2922 if (!NILP (handler))
2923 return call2 (handler, Qfile_regular_p, absname);
2925 absname = ENCODE_FILE (absname);
2927 if (stat (XSTRING (absname)->data, &st) < 0)
2928 return Qnil;
2929 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
2932 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
2933 "Return mode bits of file named FILENAME, as an integer.")
2934 (filename)
2935 Lisp_Object filename;
2937 Lisp_Object absname;
2938 struct stat st;
2939 Lisp_Object handler;
2941 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2943 /* If the file name has special constructs in it,
2944 call the corresponding file handler. */
2945 handler = Ffind_file_name_handler (absname, Qfile_modes);
2946 if (!NILP (handler))
2947 return call2 (handler, Qfile_modes, absname);
2949 absname = ENCODE_FILE (absname);
2951 if (stat (XSTRING (absname)->data, &st) < 0)
2952 return Qnil;
2953 #if defined (MSDOS) && __DJGPP__ < 2
2954 if (check_executable (XSTRING (absname)->data))
2955 st.st_mode |= S_IEXEC;
2956 #endif /* MSDOS && __DJGPP__ < 2 */
2958 return make_number (st.st_mode & 07777);
2961 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
2962 "Set mode bits of file named FILENAME to MODE (an integer).\n\
2963 Only the 12 low bits of MODE are used.")
2964 (filename, mode)
2965 Lisp_Object filename, mode;
2967 Lisp_Object absname, encoded_absname;
2968 Lisp_Object handler;
2970 absname = Fexpand_file_name (filename, current_buffer->directory);
2971 CHECK_NUMBER (mode, 1);
2973 /* If the file name has special constructs in it,
2974 call the corresponding file handler. */
2975 handler = Ffind_file_name_handler (absname, Qset_file_modes);
2976 if (!NILP (handler))
2977 return call3 (handler, Qset_file_modes, absname, mode);
2979 encoded_absname = ENCODE_FILE (absname);
2981 if (chmod (XSTRING (encoded_absname)->data, XINT (mode)) < 0)
2982 report_file_error ("Doing chmod", Fcons (absname, Qnil));
2984 return Qnil;
2987 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
2988 "Set the file permission bits for newly created files.\n\
2989 The argument MODE should be an integer; only the low 9 bits are used.\n\
2990 This setting is inherited by subprocesses.")
2991 (mode)
2992 Lisp_Object mode;
2994 CHECK_NUMBER (mode, 0);
2996 umask ((~ XINT (mode)) & 0777);
2998 return Qnil;
3001 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3002 "Return the default file protection for created files.\n\
3003 The value is an integer.")
3006 int realmask;
3007 Lisp_Object value;
3009 realmask = umask (0);
3010 umask (realmask);
3012 XSETINT (value, (~ realmask) & 0777);
3013 return value;
3016 #ifdef unix
3018 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3019 "Tell Unix to finish all pending disk updates.")
3022 sync ();
3023 return Qnil;
3026 #endif /* unix */
3028 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3029 "Return t if file FILE1 is newer than file FILE2.\n\
3030 If FILE1 does not exist, the answer is nil;\n\
3031 otherwise, if FILE2 does not exist, the answer is t.")
3032 (file1, file2)
3033 Lisp_Object file1, file2;
3035 Lisp_Object absname1, absname2;
3036 struct stat st;
3037 int mtime1;
3038 Lisp_Object handler;
3039 struct gcpro gcpro1, gcpro2;
3041 CHECK_STRING (file1, 0);
3042 CHECK_STRING (file2, 0);
3044 absname1 = Qnil;
3045 GCPRO2 (absname1, file2);
3046 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3047 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3048 UNGCPRO;
3050 /* If the file name has special constructs in it,
3051 call the corresponding file handler. */
3052 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3053 if (NILP (handler))
3054 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3055 if (!NILP (handler))
3056 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3058 GCPRO2 (absname1, absname2);
3059 absname1 = ENCODE_FILE (absname1);
3060 absname2 = ENCODE_FILE (absname2);
3061 UNGCPRO;
3063 if (stat (XSTRING (absname1)->data, &st) < 0)
3064 return Qnil;
3066 mtime1 = st.st_mtime;
3068 if (stat (XSTRING (absname2)->data, &st) < 0)
3069 return Qt;
3071 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3074 #ifdef DOS_NT
3075 Lisp_Object Qfind_buffer_file_type;
3076 #endif /* DOS_NT */
3078 #ifndef READ_BUF_SIZE
3079 #define READ_BUF_SIZE (64 << 10)
3080 #endif
3082 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3083 1, 5, 0,
3084 "Insert contents of file FILENAME after point.\n\
3085 Returns list of absolute file name and length of data inserted.\n\
3086 If second argument VISIT is non-nil, the buffer's visited filename\n\
3087 and last save file modtime are set, and it is marked unmodified.\n\
3088 If visiting and the file does not exist, visiting is completed\n\
3089 before the error is signaled.\n\
3090 The optional third and fourth arguments BEG and END\n\
3091 specify what portion of the file to insert.\n\
3092 If VISIT is non-nil, BEG and END must be nil.\n\
3094 If optional fifth argument REPLACE is non-nil,\n\
3095 it means replace the current buffer contents (in the accessible portion)\n\
3096 with the file contents. This is better than simply deleting and inserting\n\
3097 the whole thing because (1) it preserves some marker positions\n\
3098 and (2) it puts less data in the undo list.\n\
3099 When REPLACE is non-nil, the value is the number of characters actually read,\n\
3100 which is often less than the number of characters to be read.\n\
3101 This does code conversion according to the value of\n\
3102 `coding-system-for-read' or `file-coding-system-alist',\n\
3103 and sets the variable `last-coding-system-used' to the coding system\n\
3104 actually used.")
3105 (filename, visit, beg, end, replace)
3106 Lisp_Object filename, visit, beg, end, replace;
3108 struct stat st;
3109 register int fd;
3110 register int inserted = 0;
3111 register int how_much;
3112 register int unprocessed;
3113 int count = specpdl_ptr - specpdl;
3114 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3115 Lisp_Object handler, val, insval, orig_filename;
3116 Lisp_Object p;
3117 int total;
3118 int not_regular = 0;
3119 char read_buf[READ_BUF_SIZE];
3120 struct coding_system coding;
3121 unsigned char buffer[1 << 14];
3122 int replace_handled = 0;
3124 if (current_buffer->base_buffer && ! NILP (visit))
3125 error ("Cannot do file visiting in an indirect buffer");
3127 if (!NILP (current_buffer->read_only))
3128 Fbarf_if_buffer_read_only ();
3130 val = Qnil;
3131 p = Qnil;
3132 orig_filename = Qnil;
3134 GCPRO4 (filename, val, p, orig_filename);
3136 CHECK_STRING (filename, 0);
3137 filename = Fexpand_file_name (filename, Qnil);
3139 /* If the file name has special constructs in it,
3140 call the corresponding file handler. */
3141 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3142 if (!NILP (handler))
3144 val = call6 (handler, Qinsert_file_contents, filename,
3145 visit, beg, end, replace);
3146 goto handled;
3149 orig_filename = filename;
3150 filename = ENCODE_FILE (filename);
3152 fd = -1;
3154 #ifndef APOLLO
3155 if (stat (XSTRING (filename)->data, &st) < 0)
3156 #else
3157 if ((fd = open (XSTRING (filename)->data, O_RDONLY)) < 0
3158 || fstat (fd, &st) < 0)
3159 #endif /* not APOLLO */
3161 if (fd >= 0) close (fd);
3162 badopen:
3163 if (NILP (visit))
3164 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3165 st.st_mtime = -1;
3166 how_much = 0;
3167 goto notfound;
3170 #ifdef S_IFREG
3171 /* This code will need to be changed in order to work on named
3172 pipes, and it's probably just not worth it. So we should at
3173 least signal an error. */
3174 if (!S_ISREG (st.st_mode))
3176 not_regular = 1;
3178 if (! NILP (visit))
3179 goto notfound;
3181 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3182 Fsignal (Qfile_error,
3183 Fcons (build_string ("not a regular file"),
3184 Fcons (orig_filename, Qnil)));
3186 #endif
3188 if (fd < 0)
3189 if ((fd = open (XSTRING (filename)->data, O_RDONLY)) < 0)
3190 goto badopen;
3192 /* Replacement should preserve point as it preserves markers. */
3193 if (!NILP (replace))
3194 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3196 record_unwind_protect (close_file_unwind, make_number (fd));
3198 /* Supposedly happens on VMS. */
3199 if (! not_regular && st.st_size < 0)
3200 error ("File size is negative");
3202 if (!NILP (beg) || !NILP (end))
3203 if (!NILP (visit))
3204 error ("Attempt to visit less than an entire file");
3206 if (!NILP (beg))
3207 CHECK_NUMBER (beg, 0);
3208 else
3209 XSETFASTINT (beg, 0);
3211 if (!NILP (end))
3212 CHECK_NUMBER (end, 0);
3213 else
3215 if (! not_regular)
3217 XSETINT (end, st.st_size);
3218 if (XINT (end) != st.st_size)
3219 error ("Maximum buffer size exceeded");
3223 /* Decide the coding-system of the file. */
3225 Lisp_Object val = Qnil;
3227 if (!NILP (Vcoding_system_for_read))
3228 val = Vcoding_system_for_read;
3229 else if (NILP (current_buffer->enable_multibyte_characters))
3230 val = Qemacs_mule;
3231 else
3233 if (! NILP (Vset_auto_coding_function))
3235 /* Find a coding system specified in the heading two lines
3236 or in the tailing several lines of the file. We assume
3237 that the 1K-byte and 3K-byte for heading and tailing
3238 respectively are sufficient fot this purpose. */
3239 int how_many, nread;
3241 if (st.st_size <= (1024 * 4))
3242 nread = read (fd, read_buf, 1024 * 4);
3243 else
3245 nread = read (fd, read_buf, 1024);
3246 if (nread >= 0)
3248 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3249 report_file_error ("Setting file position",
3250 Fcons (orig_filename, Qnil));
3251 nread += read (fd, read_buf + nread, 1024 * 3);
3255 if (nread < 0)
3256 error ("IO error reading %s: %s",
3257 XSTRING (orig_filename)->data, strerror (errno));
3258 else if (nread > 0)
3260 val = call1 (Vset_auto_coding_function,
3261 make_string (read_buf, nread));
3262 /* Rewind the file for the actual read done later. */
3263 if (lseek (fd, 0, 0) < 0)
3264 report_file_error ("Setting file position",
3265 Fcons (orig_filename, Qnil));
3268 if (NILP (val))
3270 Lisp_Object args[6], coding_systems;
3272 args[0] = Qinsert_file_contents, args[1] = orig_filename,
3273 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3274 coding_systems = Ffind_operation_coding_system (6, args);
3275 if (CONSP (coding_systems)) val = XCONS (coding_systems)->car;
3278 setup_coding_system (Fcheck_coding_system (val), &coding);
3281 /* If requested, replace the accessible part of the buffer
3282 with the file contents. Avoid replacing text at the
3283 beginning or end of the buffer that matches the file contents;
3284 that preserves markers pointing to the unchanged parts.
3286 Here we implement this feature in an optimized way
3287 for the case where code conversion is NOT needed.
3288 The following if-statement handles the case of conversion
3289 in a less optimal way.
3291 If the code conversion is "automatic" then we try using this
3292 method and hope for the best.
3293 But if we discover the need for conversion, we give up on this method
3294 and let the following if-statement handle the replace job. */
3295 if (!NILP (replace)
3296 && CODING_MAY_REQUIRE_NO_CONVERSION (&coding))
3298 int same_at_start = BEGV;
3299 int same_at_end = ZV;
3300 int overlap;
3301 /* There is still a possibility we will find the need to do code
3302 conversion. If that happens, we set this variable to 1 to
3303 give up on handling REPLACE in the optimized way. */
3304 int giveup_match_end = 0;
3306 if (XINT (beg) != 0)
3308 if (lseek (fd, XINT (beg), 0) < 0)
3309 report_file_error ("Setting file position",
3310 Fcons (orig_filename, Qnil));
3313 immediate_quit = 1;
3314 QUIT;
3315 /* Count how many chars at the start of the file
3316 match the text at the beginning of the buffer. */
3317 while (1)
3319 int nread, bufpos;
3321 nread = read (fd, buffer, sizeof buffer);
3322 if (nread < 0)
3323 error ("IO error reading %s: %s",
3324 XSTRING (orig_filename)->data, strerror (errno));
3325 else if (nread == 0)
3326 break;
3328 if (coding.type == coding_type_undecided)
3329 detect_coding (&coding, buffer, nread);
3330 if (coding.type != coding_type_undecided
3331 && coding.type != coding_type_no_conversion
3332 && coding.type != coding_type_emacs_mule)
3333 /* We found that the file should be decoded somehow.
3334 Let's give up here. */
3336 giveup_match_end = 1;
3337 break;
3340 if (coding.eol_type == CODING_EOL_UNDECIDED)
3341 detect_eol (&coding, buffer, nread);
3342 if (coding.eol_type != CODING_EOL_UNDECIDED
3343 && coding.eol_type != CODING_EOL_LF)
3344 /* We found that the format of eol should be decoded.
3345 Let's give up here. */
3347 giveup_match_end = 1;
3348 break;
3351 bufpos = 0;
3352 while (bufpos < nread && same_at_start < ZV
3353 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3354 same_at_start++, bufpos++;
3355 /* If we found a discrepancy, stop the scan.
3356 Otherwise loop around and scan the next bufferful. */
3357 if (bufpos != nread)
3358 break;
3360 immediate_quit = 0;
3361 /* If the file matches the buffer completely,
3362 there's no need to replace anything. */
3363 if (same_at_start - BEGV == XINT (end))
3365 close (fd);
3366 specpdl_ptr--;
3367 /* Truncate the buffer to the size of the file. */
3368 del_range_1 (same_at_start, same_at_end, 0);
3369 goto handled;
3371 immediate_quit = 1;
3372 QUIT;
3373 /* Count how many chars at the end of the file
3374 match the text at the end of the buffer. But, if we have
3375 already found that decoding is necessary, don't waste time. */
3376 while (!giveup_match_end)
3378 int total_read, nread, bufpos, curpos, trial;
3380 /* At what file position are we now scanning? */
3381 curpos = XINT (end) - (ZV - same_at_end);
3382 /* If the entire file matches the buffer tail, stop the scan. */
3383 if (curpos == 0)
3384 break;
3385 /* How much can we scan in the next step? */
3386 trial = min (curpos, sizeof buffer);
3387 if (lseek (fd, curpos - trial, 0) < 0)
3388 report_file_error ("Setting file position",
3389 Fcons (orig_filename, Qnil));
3391 total_read = 0;
3392 while (total_read < trial)
3394 nread = read (fd, buffer + total_read, trial - total_read);
3395 if (nread <= 0)
3396 error ("IO error reading %s: %s",
3397 XSTRING (orig_filename)->data, strerror (errno));
3398 total_read += nread;
3400 /* Scan this bufferful from the end, comparing with
3401 the Emacs buffer. */
3402 bufpos = total_read;
3403 /* Compare with same_at_start to avoid counting some buffer text
3404 as matching both at the file's beginning and at the end. */
3405 while (bufpos > 0 && same_at_end > same_at_start
3406 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3407 same_at_end--, bufpos--;
3409 /* If we found a discrepancy, stop the scan.
3410 Otherwise loop around and scan the preceding bufferful. */
3411 if (bufpos != 0)
3413 /* If this discrepancy is because of code conversion,
3414 we cannot use this method; giveup and try the other. */
3415 if (same_at_end > same_at_start
3416 && FETCH_BYTE (same_at_end - 1) >= 0200
3417 && ! NILP (current_buffer->enable_multibyte_characters)
3418 && ! CODING_REQUIRE_NO_CONVERSION (&coding))
3419 giveup_match_end = 1;
3420 break;
3423 immediate_quit = 0;
3425 if (! giveup_match_end)
3427 /* We win! We can handle REPLACE the optimized way. */
3429 /* Extends the end of non-matching text area to multibyte
3430 character boundary. */
3431 if (! NILP (current_buffer->enable_multibyte_characters))
3432 while (same_at_end < ZV && ! CHAR_HEAD_P (POS_ADDR (same_at_end)))
3433 same_at_end++;
3435 /* Don't try to reuse the same piece of text twice. */
3436 overlap = same_at_start - BEGV - (same_at_end + st.st_size - ZV);
3437 if (overlap > 0)
3438 same_at_end += overlap;
3440 /* Arrange to read only the nonmatching middle part of the file. */
3441 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV));
3442 XSETFASTINT (end, XINT (end) - (ZV - same_at_end));
3444 del_range_1 (same_at_start, same_at_end, 0);
3445 /* Insert from the file at the proper position. */
3446 SET_PT (same_at_start);
3448 /* If display currently starts at beginning of line,
3449 keep it that way. */
3450 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3451 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3453 replace_handled = 1;
3457 /* If requested, replace the accessible part of the buffer
3458 with the file contents. Avoid replacing text at the
3459 beginning or end of the buffer that matches the file contents;
3460 that preserves markers pointing to the unchanged parts.
3462 Here we implement this feature for the case where code conversion
3463 is needed, in a simple way that needs a lot of memory.
3464 The preceding if-statement handles the case of no conversion
3465 in a more optimized way. */
3466 if (!NILP (replace) && ! replace_handled)
3468 int same_at_start = BEGV;
3469 int same_at_end = ZV;
3470 int overlap;
3471 int bufpos;
3472 /* Make sure that the gap is large enough. */
3473 int bufsize = 2 * st.st_size;
3474 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
3476 /* First read the whole file, performing code conversion into
3477 CONVERSION_BUFFER. */
3479 if (lseek (fd, XINT (beg), 0) < 0)
3481 free (conversion_buffer);
3482 report_file_error ("Setting file position",
3483 Fcons (orig_filename, Qnil));
3486 total = st.st_size; /* Total bytes in the file. */
3487 how_much = 0; /* Bytes read from file so far. */
3488 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
3489 unprocessed = 0; /* Bytes not processed in previous loop. */
3491 while (how_much < total)
3493 /* try is reserved in some compilers (Microsoft C) */
3494 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
3495 char *destination = read_buf + unprocessed;
3496 int this;
3498 /* Allow quitting out of the actual I/O. */
3499 immediate_quit = 1;
3500 QUIT;
3501 this = read (fd, destination, trytry);
3502 immediate_quit = 0;
3504 if (this < 0 || this + unprocessed == 0)
3506 how_much = this;
3507 break;
3510 how_much += this;
3512 if (! CODING_REQUIRE_NO_CONVERSION (&coding))
3514 int require, produced, consumed;
3516 this += unprocessed;
3518 /* If we are using more space than estimated,
3519 make CONVERSION_BUFFER bigger. */
3520 require = decoding_buffer_size (&coding, this);
3521 if (inserted + require + 2 * (total - how_much) > bufsize)
3523 bufsize = inserted + require + 2 * (total - how_much);
3524 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
3527 /* Convert this batch with results in CONVERSION_BUFFER. */
3528 if (how_much >= total) /* This is the last block. */
3529 coding.last_block = 1;
3530 produced = decode_coding (&coding, read_buf,
3531 conversion_buffer + inserted,
3532 this, bufsize - inserted,
3533 &consumed);
3535 /* Save for next iteration whatever we didn't convert. */
3536 unprocessed = this - consumed;
3537 bcopy (read_buf + consumed, read_buf, unprocessed);
3538 this = produced;
3541 inserted += this;
3544 /* At this point, INSERTED is how many characters
3545 are present in CONVERSION_BUFFER.
3546 HOW_MUCH should equal TOTAL,
3547 or should be <= 0 if we couldn't read the file. */
3549 if (how_much < 0)
3551 free (conversion_buffer);
3553 if (how_much == -1)
3554 error ("IO error reading %s: %s",
3555 XSTRING (orig_filename)->data, strerror (errno));
3556 else if (how_much == -2)
3557 error ("maximum buffer size exceeded");
3560 /* Compare the beginning of the converted file
3561 with the buffer text. */
3563 bufpos = 0;
3564 while (bufpos < inserted && same_at_start < same_at_end
3565 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
3566 same_at_start++, bufpos++;
3568 /* If the file matches the buffer completely,
3569 there's no need to replace anything. */
3571 if (bufpos == inserted)
3573 free (conversion_buffer);
3574 close (fd);
3575 specpdl_ptr--;
3576 /* Truncate the buffer to the size of the file. */
3577 del_range_1 (same_at_start, same_at_end, 0);
3578 goto handled;
3581 /* Scan this bufferful from the end, comparing with
3582 the Emacs buffer. */
3583 bufpos = inserted;
3585 /* Compare with same_at_start to avoid counting some buffer text
3586 as matching both at the file's beginning and at the end. */
3587 while (bufpos > 0 && same_at_end > same_at_start
3588 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
3589 same_at_end--, bufpos--;
3591 /* Don't try to reuse the same piece of text twice. */
3592 overlap = same_at_start - BEGV - (same_at_end + inserted - ZV);
3593 if (overlap > 0)
3594 same_at_end += overlap;
3596 /* If display currently starts at beginning of line,
3597 keep it that way. */
3598 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3599 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3601 /* Replace the chars that we need to replace,
3602 and update INSERTED to equal the number of bytes
3603 we are taking from the file. */
3604 inserted -= (Z - same_at_end) + (same_at_start - BEG);
3605 move_gap (same_at_start);
3606 del_range_1 (same_at_start, same_at_end, 0);
3607 SET_PT (same_at_start);
3608 insert_1 (conversion_buffer + same_at_start - BEG, inserted, 0, 0);
3610 free (conversion_buffer);
3611 close (fd);
3612 specpdl_ptr--;
3614 goto handled;
3617 if (! not_regular)
3619 register Lisp_Object temp;
3621 total = XINT (end) - XINT (beg);
3623 /* Make sure point-max won't overflow after this insertion. */
3624 XSETINT (temp, total);
3625 if (total != XINT (temp))
3626 error ("Maximum buffer size exceeded");
3628 else
3629 /* For a special file, all we can do is guess. */
3630 total = READ_BUF_SIZE;
3632 if (NILP (visit) && total > 0)
3633 prepare_to_modify_buffer (PT, PT, NULL);
3635 move_gap (PT);
3636 if (GAP_SIZE < total)
3637 make_gap (total - GAP_SIZE);
3639 if (XINT (beg) != 0 || !NILP (replace))
3641 if (lseek (fd, XINT (beg), 0) < 0)
3642 report_file_error ("Setting file position",
3643 Fcons (orig_filename, Qnil));
3646 /* In the following loop, HOW_MUCH contains the total bytes read so
3647 far. Before exiting the loop, it is set to -1 if I/O error
3648 occurs, set to -2 if the maximum buffer size is exceeded. */
3649 how_much = 0;
3650 /* Total bytes inserted. */
3651 inserted = 0;
3652 /* Bytes not processed in the previous loop because short gap size. */
3653 unprocessed = 0;
3654 while (how_much < total)
3656 /* try is reserved in some compilers (Microsoft C) */
3657 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
3658 char *destination = (CODING_REQUIRE_NO_CONVERSION (&coding)
3659 ? (char *) (POS_ADDR (PT + inserted - 1) + 1)
3660 : read_buf + unprocessed);
3661 int this;
3663 /* Allow quitting out of the actual I/O. */
3664 immediate_quit = 1;
3665 QUIT;
3666 this = read (fd, destination, trytry);
3667 immediate_quit = 0;
3669 if (this < 0 || this + unprocessed == 0)
3671 how_much = this;
3672 break;
3675 /* For a regular file, where TOTAL is the real size,
3676 count HOW_MUCH to compare with it.
3677 For a special file, where TOTAL is just a buffer size,
3678 so don't bother counting in HOW_MUCH.
3679 (INSERTED is where we count the number of characters inserted.) */
3680 if (! not_regular)
3681 how_much += this;
3683 if (! CODING_REQUIRE_NO_CONVERSION (&coding))
3685 int require, produced, consumed;
3687 this += unprocessed;
3688 /* Make sure that the gap is large enough. */
3689 require = decoding_buffer_size (&coding, this);
3690 if (GAP_SIZE < require)
3691 make_gap (require - GAP_SIZE);
3693 if (! not_regular)
3695 if (how_much >= total) /* This is the last block. */
3696 coding.last_block = 1;
3698 else
3700 /* If we encounter EOF, say it is the last block. (The
3701 data this will apply to is the UNPROCESSED characters
3702 carried over from the last batch.) */
3703 if (this == 0)
3704 coding.last_block = 1;
3707 produced = decode_coding (&coding, read_buf,
3708 POS_ADDR (PT + inserted - 1) + 1,
3709 this, GAP_SIZE, &consumed);
3710 if (produced > 0)
3712 Lisp_Object temp;
3714 XSET (temp, Lisp_Int, Z + produced);
3715 if (Z + produced != XINT (temp))
3717 how_much = -2;
3718 break;
3721 unprocessed = this - consumed;
3722 bcopy (read_buf + consumed, read_buf, unprocessed);
3723 this = produced;
3726 GPT += this;
3727 GAP_SIZE -= this;
3728 ZV += this;
3729 Z += this;
3730 if (GAP_SIZE > 0)
3731 /* Put an anchor to ensure multi-byte form ends at gap. */
3732 *GPT_ADDR = 0;
3733 inserted += this;
3737 #ifdef DOS_NT
3738 /* Use the conversion type to determine buffer-file-type
3739 (find-buffer-file-type is now used to help determine the
3740 conversion). */
3741 if (coding.eol_type != CODING_EOL_UNDECIDED
3742 && coding.eol_type != CODING_EOL_LF)
3743 current_buffer->buffer_file_type = Qnil;
3744 else
3745 current_buffer->buffer_file_type = Qt;
3746 #endif
3748 /* We don't have to consider file type of MSDOS because all files
3749 are read as binary and end-of-line format has already been
3750 decoded appropriately. */
3751 #if 0
3752 #ifdef DOS_NT
3753 /* Demacs 1.1.1 91/10/16 HIRANO Satoshi, MW July 1993 */
3754 /* Determine file type from name and remove LFs from CR-LFs if the file
3755 is deemed to be a text file. */
3757 current_buffer->buffer_file_type
3758 = call1 (Qfind_buffer_file_type, orig_filename);
3759 if (NILP (current_buffer->buffer_file_type))
3761 int reduced_size
3762 = inserted - crlf_to_lf (inserted, POS_ADDR (PT - 1) + 1);
3763 ZV -= reduced_size;
3764 Z -= reduced_size;
3765 GPT -= reduced_size;
3766 GAP_SIZE += reduced_size;
3767 inserted -= reduced_size;
3770 #endif /* DOS_NT */
3771 #endif /* 0 */
3773 if (inserted > 0)
3775 record_insert (PT, inserted);
3777 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
3778 offset_intervals (current_buffer, PT, inserted);
3779 MODIFF++;
3782 close (fd);
3784 /* Discard the unwind protect for closing the file. */
3785 specpdl_ptr--;
3787 if (how_much == -1)
3788 error ("IO error reading %s: %s",
3789 XSTRING (orig_filename)->data, strerror (errno));
3790 else if (how_much == -2)
3791 error ("maximum buffer size exceeded");
3793 notfound:
3794 handled:
3796 if (!NILP (visit))
3798 if (!EQ (current_buffer->undo_list, Qt))
3799 current_buffer->undo_list = Qnil;
3800 #ifdef APOLLO
3801 stat (XSTRING (filename)->data, &st);
3802 #endif
3804 if (NILP (handler))
3806 current_buffer->modtime = st.st_mtime;
3807 current_buffer->filename = orig_filename;
3810 SAVE_MODIFF = MODIFF;
3811 current_buffer->auto_save_modified = MODIFF;
3812 XSETFASTINT (current_buffer->save_length, Z - BEG);
3813 #ifdef CLASH_DETECTION
3814 if (NILP (handler))
3816 if (!NILP (current_buffer->file_truename))
3817 unlock_file (current_buffer->file_truename);
3818 unlock_file (filename);
3820 #endif /* CLASH_DETECTION */
3821 if (not_regular)
3822 Fsignal (Qfile_error,
3823 Fcons (build_string ("not a regular file"),
3824 Fcons (orig_filename, Qnil)));
3826 /* If visiting nonexistent file, return nil. */
3827 if (current_buffer->modtime == -1)
3828 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3831 /* Decode file format */
3832 if (inserted > 0)
3834 insval = call3 (Qformat_decode,
3835 Qnil, make_number (inserted), visit);
3836 CHECK_NUMBER (insval, 0);
3837 inserted = XFASTINT (insval);
3840 /* Call after-change hooks for the inserted text, aside from the case
3841 of normal visiting (not with REPLACE), which is done in a new buffer
3842 "before" the buffer is changed. */
3843 if (inserted > 0 && total > 0
3844 && (NILP (visit) || !NILP (replace)))
3845 signal_after_change (PT, 0, inserted);
3847 if (inserted > 0)
3849 p = Vafter_insert_file_functions;
3850 if (!NILP (coding.post_read_conversion))
3851 p = Fcons (coding.post_read_conversion, p);
3853 while (!NILP (p))
3855 insval = call1 (Fcar (p), make_number (inserted));
3856 if (!NILP (insval))
3858 CHECK_NUMBER (insval, 0);
3859 inserted = XFASTINT (insval);
3861 QUIT;
3862 p = Fcdr (p);
3866 if (NILP (val))
3867 val = Fcons (orig_filename,
3868 Fcons (make_number (inserted),
3869 Qnil));
3871 RETURN_UNGCPRO (unbind_to (count, val));
3874 static Lisp_Object build_annotations ();
3875 extern Lisp_Object Ffile_locked_p ();
3877 /* If build_annotations switched buffers, switch back to BUF.
3878 Kill the temporary buffer that was selected in the meantime.
3880 Since this kill only the last temporary buffer, some buffers remain
3881 not killed if build_annotations switched buffers more than once.
3882 -- K.Handa */
3884 static Lisp_Object
3885 build_annotations_unwind (buf)
3886 Lisp_Object buf;
3888 Lisp_Object tembuf;
3890 if (XBUFFER (buf) == current_buffer)
3891 return Qnil;
3892 tembuf = Fcurrent_buffer ();
3893 Fset_buffer (buf);
3894 Fkill_buffer (tembuf);
3895 return Qnil;
3898 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 6,
3899 "r\nFWrite region to file: ",
3900 "Write current region into specified file.\n\
3901 When called from a program, takes three arguments:\n\
3902 START, END and FILENAME. START and END are buffer positions.\n\
3903 Optional fourth argument APPEND if non-nil means\n\
3904 append to existing file contents (if any).\n\
3905 Optional fifth argument VISIT if t means\n\
3906 set the last-save-file-modtime of buffer to this file's modtime\n\
3907 and mark buffer not modified.\n\
3908 If VISIT is a string, it is a second file name;\n\
3909 the output goes to FILENAME, but the buffer is marked as visiting VISIT.\n\
3910 VISIT is also the file name to lock and unlock for clash detection.\n\
3911 If VISIT is neither t nor nil nor a string,\n\
3912 that means do not print the \"Wrote file\" message.\n\
3913 The optional sixth arg LOCKNAME, if non-nil, specifies the name to\n\
3914 use for locking and unlocking, overriding FILENAME and VISIT.\n\
3915 Kludgy feature: if START is a string, then that string is written\n\
3916 to the file, instead of any buffer contents, and END is ignored.")
3917 (start, end, filename, append, visit, lockname)
3918 Lisp_Object start, end, filename, append, visit, lockname;
3920 register int desc;
3921 int failure;
3922 int save_errno;
3923 unsigned char *fn;
3924 struct stat st;
3925 int tem;
3926 int count = specpdl_ptr - specpdl;
3927 int count1;
3928 #ifdef VMS
3929 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
3930 #endif /* VMS */
3931 Lisp_Object handler;
3932 Lisp_Object visit_file;
3933 Lisp_Object annotations;
3934 Lisp_Object encoded_filename;
3935 int visiting, quietly;
3936 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3937 struct buffer *given_buffer;
3938 #ifdef DOS_NT
3939 int buffer_file_type = O_BINARY;
3940 #endif /* DOS_NT */
3941 struct coding_system coding;
3943 if (current_buffer->base_buffer && ! NILP (visit))
3944 error ("Cannot do file visiting in an indirect buffer");
3946 if (!NILP (start) && !STRINGP (start))
3947 validate_region (&start, &end);
3949 GCPRO4 (start, filename, visit, lockname);
3951 /* Decide the coding-system to encode the data with. */
3953 Lisp_Object val;
3955 if (auto_saving)
3956 val = Qnil;
3957 else if (!NILP (Vcoding_system_for_write))
3958 val = Vcoding_system_for_write;
3959 else if (NILP (current_buffer->enable_multibyte_characters))
3961 /* If the variable `buffer-file-coding-system' is set locally,
3962 it means that the file was read with some kind of code
3963 conversion or the varialbe is explicitely set by users. We
3964 had better write it out with the same coding system even if
3965 `enable-multibyte-characters' is nil.
3967 If is is not set locally, we anyway have to convert EOL
3968 format if the default value of `buffer-file-coding-system'
3969 tells that it is not Unix-like (LF only) format. */
3970 val = current_buffer->buffer_file_coding_system;
3971 if (NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
3973 struct coding_system coding_temp;
3975 setup_coding_system (Fcheck_coding_system (val), &coding_temp);
3976 if (coding_temp.eol_type == CODING_EOL_CRLF
3977 || coding_temp.eol_type == CODING_EOL_CR)
3979 setup_coding_system (Qemacs_mule, &coding);
3980 coding.eol_type = coding_temp.eol_type;
3981 goto done_setup_coding;
3983 val = Qnil;
3986 else
3988 Lisp_Object args[7], coding_systems;
3990 args[0] = Qwrite_region, args[1] = start, args[2] = end,
3991 args[3] = filename, args[4] = append, args[5] = visit,
3992 args[6] = lockname;
3993 coding_systems = Ffind_operation_coding_system (7, args);
3994 val = (CONSP (coding_systems) && !NILP (XCONS (coding_systems)->cdr)
3995 ? XCONS (coding_systems)->cdr
3996 : current_buffer->buffer_file_coding_system);
3998 setup_coding_system (Fcheck_coding_system (val), &coding);
4000 done_setup_coding:
4001 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4002 coding.selective = 1;
4005 filename = Fexpand_file_name (filename, Qnil);
4006 if (STRINGP (visit))
4007 visit_file = Fexpand_file_name (visit, Qnil);
4008 else
4009 visit_file = filename;
4010 UNGCPRO;
4012 visiting = (EQ (visit, Qt) || STRINGP (visit));
4013 quietly = !NILP (visit);
4015 annotations = Qnil;
4017 if (NILP (lockname))
4018 lockname = visit_file;
4020 GCPRO5 (start, filename, annotations, visit_file, lockname);
4022 /* If the file name has special constructs in it,
4023 call the corresponding file handler. */
4024 handler = Ffind_file_name_handler (filename, Qwrite_region);
4025 /* If FILENAME has no handler, see if VISIT has one. */
4026 if (NILP (handler) && STRINGP (visit))
4027 handler = Ffind_file_name_handler (visit, Qwrite_region);
4029 if (!NILP (handler))
4031 Lisp_Object val;
4032 val = call6 (handler, Qwrite_region, start, end,
4033 filename, append, visit);
4035 if (visiting)
4037 SAVE_MODIFF = MODIFF;
4038 XSETFASTINT (current_buffer->save_length, Z - BEG);
4039 current_buffer->filename = visit_file;
4041 UNGCPRO;
4042 return val;
4045 /* Special kludge to simplify auto-saving. */
4046 if (NILP (start))
4048 XSETFASTINT (start, BEG);
4049 XSETFASTINT (end, Z);
4052 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
4053 count1 = specpdl_ptr - specpdl;
4055 given_buffer = current_buffer;
4056 annotations = build_annotations (start, end, coding.pre_write_conversion);
4057 if (current_buffer != given_buffer)
4059 XSETFASTINT (start, BEGV);
4060 XSETFASTINT (end, ZV);
4063 #ifdef CLASH_DETECTION
4064 if (!auto_saving)
4066 #if 0 /* This causes trouble for GNUS. */
4067 /* If we've locked this file for some other buffer,
4068 query before proceeding. */
4069 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
4070 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
4071 #endif
4073 lock_file (lockname);
4075 #endif /* CLASH_DETECTION */
4077 encoded_filename = ENCODE_FILE (filename);
4079 fn = XSTRING (encoded_filename)->data;
4080 desc = -1;
4081 if (!NILP (append))
4082 #ifdef DOS_NT
4083 desc = open (fn, O_WRONLY | buffer_file_type);
4084 #else /* not DOS_NT */
4085 desc = open (fn, O_WRONLY);
4086 #endif /* not DOS_NT */
4088 if (desc < 0 && (NILP (append) || errno == ENOENT))
4089 #ifdef VMS
4090 if (auto_saving) /* Overwrite any previous version of autosave file */
4092 vms_truncate (fn); /* if fn exists, truncate to zero length */
4093 desc = open (fn, O_RDWR);
4094 if (desc < 0)
4095 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
4096 ? XSTRING (current_buffer->filename)->data : 0,
4097 fn);
4099 else /* Write to temporary name and rename if no errors */
4101 Lisp_Object temp_name;
4102 temp_name = Ffile_name_directory (filename);
4104 if (!NILP (temp_name))
4106 temp_name = Fmake_temp_name (concat2 (temp_name,
4107 build_string ("$$SAVE$$")));
4108 fname = XSTRING (filename)->data;
4109 fn = XSTRING (temp_name)->data;
4110 desc = creat_copy_attrs (fname, fn);
4111 if (desc < 0)
4113 /* If we can't open the temporary file, try creating a new
4114 version of the original file. VMS "creat" creates a
4115 new version rather than truncating an existing file. */
4116 fn = fname;
4117 fname = 0;
4118 desc = creat (fn, 0666);
4119 #if 0 /* This can clobber an existing file and fail to replace it,
4120 if the user runs out of space. */
4121 if (desc < 0)
4123 /* We can't make a new version;
4124 try to truncate and rewrite existing version if any. */
4125 vms_truncate (fn);
4126 desc = open (fn, O_RDWR);
4128 #endif
4131 else
4132 desc = creat (fn, 0666);
4134 #else /* not VMS */
4135 #ifdef DOS_NT
4136 desc = open (fn,
4137 O_WRONLY | O_TRUNC | O_CREAT | buffer_file_type,
4138 S_IREAD | S_IWRITE);
4139 #else /* not DOS_NT */
4140 desc = creat (fn, auto_saving ? auto_save_mode_bits : 0666);
4141 #endif /* not DOS_NT */
4142 #endif /* not VMS */
4144 UNGCPRO;
4146 if (desc < 0)
4148 #ifdef CLASH_DETECTION
4149 save_errno = errno;
4150 if (!auto_saving) unlock_file (lockname);
4151 errno = save_errno;
4152 #endif /* CLASH_DETECTION */
4153 report_file_error ("Opening output file", Fcons (filename, Qnil));
4156 record_unwind_protect (close_file_unwind, make_number (desc));
4158 if (!NILP (append))
4159 if (lseek (desc, 0, 2) < 0)
4161 #ifdef CLASH_DETECTION
4162 if (!auto_saving) unlock_file (lockname);
4163 #endif /* CLASH_DETECTION */
4164 report_file_error ("Lseek error", Fcons (filename, Qnil));
4167 #ifdef VMS
4169 * Kludge Warning: The VMS C RTL likes to insert carriage returns
4170 * if we do writes that don't end with a carriage return. Furthermore
4171 * it cannot handle writes of more then 16K. The modified
4172 * version of "sys_write" in SYSDEP.C (see comment there) copes with
4173 * this EXCEPT for the last record (iff it doesn't end with a carriage
4174 * return). This implies that if your buffer doesn't end with a carriage
4175 * return, you get one free... tough. However it also means that if
4176 * we make two calls to sys_write (a la the following code) you can
4177 * get one at the gap as well. The easiest way to fix this (honest)
4178 * is to move the gap to the next newline (or the end of the buffer).
4179 * Thus this change.
4181 * Yech!
4183 if (GPT > BEG && GPT_ADDR[-1] != '\n')
4184 move_gap (find_next_newline (GPT, 1));
4185 #else
4186 /* Whether VMS or not, we must move the gap to the next of newline
4187 when we must put designation sequences at beginning of line. */
4188 if (INTEGERP (start)
4189 && coding.type == coding_type_iso2022
4190 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
4191 && GPT > BEG && GPT_ADDR[-1] != '\n')
4192 move_gap (find_next_newline (GPT, 1));
4193 #endif
4195 failure = 0;
4196 immediate_quit = 1;
4198 if (STRINGP (start))
4200 failure = 0 > a_write (desc, XSTRING (start)->data,
4201 XSTRING (start)->size, 0, &annotations, &coding);
4202 save_errno = errno;
4204 else if (XINT (start) != XINT (end))
4206 int nwritten = 0;
4207 if (XINT (start) < GPT)
4209 register int end1 = XINT (end);
4210 tem = XINT (start);
4211 failure = 0 > a_write (desc, POS_ADDR (tem),
4212 min (GPT, end1) - tem, tem, &annotations,
4213 &coding);
4214 nwritten += min (GPT, end1) - tem;
4215 save_errno = errno;
4218 if (XINT (end) > GPT && !failure)
4220 tem = XINT (start);
4221 tem = max (tem, GPT);
4222 failure = 0 > a_write (desc, POS_ADDR (tem), XINT (end) - tem,
4223 tem, &annotations, &coding);
4224 nwritten += XINT (end) - tem;
4225 save_errno = errno;
4228 else
4230 /* If file was empty, still need to write the annotations */
4231 coding.last_block = 1;
4232 failure = 0 > a_write (desc, "", 0, XINT (start), &annotations, &coding);
4233 save_errno = errno;
4236 if (coding.require_flushing && !coding.last_block)
4238 /* We have to flush out a data. */
4239 coding.last_block = 1;
4240 failure = 0 > e_write (desc, "", 0, &coding);
4241 save_errno = errno;
4244 immediate_quit = 0;
4246 #ifdef HAVE_FSYNC
4247 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4248 Disk full in NFS may be reported here. */
4249 /* mib says that closing the file will try to write as fast as NFS can do
4250 it, and that means the fsync here is not crucial for autosave files. */
4251 if (!auto_saving && fsync (desc) < 0)
4253 /* If fsync fails with EINTR, don't treat that as serious. */
4254 if (errno != EINTR)
4255 failure = 1, save_errno = errno;
4257 #endif
4259 /* Spurious "file has changed on disk" warnings have been
4260 observed on Suns as well.
4261 It seems that `close' can change the modtime, under nfs.
4263 (This has supposedly been fixed in Sunos 4,
4264 but who knows about all the other machines with NFS?) */
4265 #if 0
4267 /* On VMS and APOLLO, must do the stat after the close
4268 since closing changes the modtime. */
4269 #ifndef VMS
4270 #ifndef APOLLO
4271 /* Recall that #if defined does not work on VMS. */
4272 #define FOO
4273 fstat (desc, &st);
4274 #endif
4275 #endif
4276 #endif
4278 /* NFS can report a write failure now. */
4279 if (close (desc) < 0)
4280 failure = 1, save_errno = errno;
4282 #ifdef VMS
4283 /* If we wrote to a temporary name and had no errors, rename to real name. */
4284 if (fname)
4286 if (!failure)
4287 failure = (rename (fn, fname) != 0), save_errno = errno;
4288 fn = fname;
4290 #endif /* VMS */
4292 #ifndef FOO
4293 stat (fn, &st);
4294 #endif
4295 /* Discard the unwind protect for close_file_unwind. */
4296 specpdl_ptr = specpdl + count1;
4297 /* Restore the original current buffer. */
4298 visit_file = unbind_to (count, visit_file);
4300 #ifdef CLASH_DETECTION
4301 if (!auto_saving)
4302 unlock_file (lockname);
4303 #endif /* CLASH_DETECTION */
4305 /* Do this before reporting IO error
4306 to avoid a "file has changed on disk" warning on
4307 next attempt to save. */
4308 if (visiting)
4309 current_buffer->modtime = st.st_mtime;
4311 if (failure)
4312 error ("IO error writing %s: %s", XSTRING (filename)->data,
4313 strerror (save_errno));
4315 if (visiting)
4317 SAVE_MODIFF = MODIFF;
4318 XSETFASTINT (current_buffer->save_length, Z - BEG);
4319 current_buffer->filename = visit_file;
4320 update_mode_lines++;
4322 else if (quietly)
4323 return Qnil;
4325 if (!auto_saving)
4326 message ("Wrote %s", XSTRING (visit_file)->data);
4328 return Qnil;
4331 Lisp_Object merge ();
4333 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
4334 "Return t if (car A) is numerically less than (car B).")
4335 (a, b)
4336 Lisp_Object a, b;
4338 return Flss (Fcar (a), Fcar (b));
4341 /* Build the complete list of annotations appropriate for writing out
4342 the text between START and END, by calling all the functions in
4343 write-region-annotate-functions and merging the lists they return.
4344 If one of these functions switches to a different buffer, we assume
4345 that buffer contains altered text. Therefore, the caller must
4346 make sure to restore the current buffer in all cases,
4347 as save-excursion would do. */
4349 static Lisp_Object
4350 build_annotations (start, end, pre_write_conversion)
4351 Lisp_Object start, end, pre_write_conversion;
4353 Lisp_Object annotations;
4354 Lisp_Object p, res;
4355 struct gcpro gcpro1, gcpro2;
4356 Lisp_Object original_buffer;
4358 XSETBUFFER (original_buffer, current_buffer);
4360 annotations = Qnil;
4361 p = Vwrite_region_annotate_functions;
4362 GCPRO2 (annotations, p);
4363 while (!NILP (p))
4365 struct buffer *given_buffer = current_buffer;
4366 Vwrite_region_annotations_so_far = annotations;
4367 res = call2 (Fcar (p), start, end);
4368 /* If the function makes a different buffer current,
4369 assume that means this buffer contains altered text to be output.
4370 Reset START and END from the buffer bounds
4371 and discard all previous annotations because they should have
4372 been dealt with by this function. */
4373 if (current_buffer != given_buffer)
4375 XSETFASTINT (start, BEGV);
4376 XSETFASTINT (end, ZV);
4377 annotations = Qnil;
4379 Flength (res); /* Check basic validity of return value */
4380 annotations = merge (annotations, res, Qcar_less_than_car);
4381 p = Fcdr (p);
4384 /* Now do the same for annotation functions implied by the file-format */
4385 if (auto_saving && (!EQ (Vauto_save_file_format, Qt)))
4386 p = Vauto_save_file_format;
4387 else
4388 p = current_buffer->file_format;
4389 while (!NILP (p))
4391 struct buffer *given_buffer = current_buffer;
4392 Vwrite_region_annotations_so_far = annotations;
4393 res = call4 (Qformat_annotate_function, Fcar (p), start, end,
4394 original_buffer);
4395 if (current_buffer != given_buffer)
4397 XSETFASTINT (start, BEGV);
4398 XSETFASTINT (end, ZV);
4399 annotations = Qnil;
4401 Flength (res);
4402 annotations = merge (annotations, res, Qcar_less_than_car);
4403 p = Fcdr (p);
4406 /* At last, do the same for the function PRE_WRITE_CONVERSION
4407 implied by the current coding-system. */
4408 if (!NILP (pre_write_conversion))
4410 struct buffer *given_buffer = current_buffer;
4411 Vwrite_region_annotations_so_far = annotations;
4412 res = call2 (pre_write_conversion, start, end);
4413 Flength (res);
4414 annotations = (current_buffer != given_buffer
4415 ? res
4416 : merge (annotations, res, Qcar_less_than_car));
4419 UNGCPRO;
4420 return annotations;
4423 /* Write to descriptor DESC the LEN characters starting at ADDR,
4424 assuming they start at position POS in the buffer.
4425 Intersperse with them the annotations from *ANNOT
4426 (those which fall within the range of positions POS to POS + LEN),
4427 each at its appropriate position.
4429 Modify *ANNOT by discarding elements as we output them.
4430 The return value is negative in case of system call failure. */
4433 a_write (desc, addr, len, pos, annot, coding)
4434 int desc;
4435 register char *addr;
4436 register int len;
4437 int pos;
4438 Lisp_Object *annot;
4439 struct coding_system *coding;
4441 Lisp_Object tem;
4442 int nextpos;
4443 int lastpos = pos + len;
4445 while (NILP (*annot) || CONSP (*annot))
4447 tem = Fcar_safe (Fcar (*annot));
4448 if (INTEGERP (tem) && XINT (tem) >= pos && XFASTINT (tem) <= lastpos)
4449 nextpos = XFASTINT (tem);
4450 else
4451 return e_write (desc, addr, lastpos - pos, coding);
4452 if (nextpos > pos)
4454 if (0 > e_write (desc, addr, nextpos - pos, coding))
4455 return -1;
4456 addr += nextpos - pos;
4457 pos = nextpos;
4459 tem = Fcdr (Fcar (*annot));
4460 if (STRINGP (tem))
4462 if (0 > e_write (desc, XSTRING (tem)->data, XSTRING (tem)->size,
4463 coding))
4464 return -1;
4466 *annot = Fcdr (*annot);
4470 #ifndef WRITE_BUF_SIZE
4471 #define WRITE_BUF_SIZE (16 * 1024)
4472 #endif
4475 e_write (desc, addr, len, coding)
4476 int desc;
4477 register char *addr;
4478 register int len;
4479 struct coding_system *coding;
4481 char buf[WRITE_BUF_SIZE];
4482 int produced, consumed;
4484 /* We used to have a code for handling selective display here. But,
4485 now it is handled within encode_coding. */
4486 while (1)
4488 produced = encode_coding (coding, addr, buf, len, WRITE_BUF_SIZE,
4489 &consumed);
4490 len -= consumed, addr += consumed;
4491 if (produced > 0)
4493 produced -= write (desc, buf, produced);
4494 if (produced) return -1;
4496 if (len <= 0)
4497 break;
4499 return 0;
4502 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
4503 Sverify_visited_file_modtime, 1, 1, 0,
4504 "Return t if last mod time of BUF's visited file matches what BUF records.\n\
4505 This means that the file has not been changed since it was visited or saved.")
4506 (buf)
4507 Lisp_Object buf;
4509 struct buffer *b;
4510 struct stat st;
4511 Lisp_Object handler;
4512 Lisp_Object filename;
4514 CHECK_BUFFER (buf, 0);
4515 b = XBUFFER (buf);
4517 if (!STRINGP (b->filename)) return Qt;
4518 if (b->modtime == 0) return Qt;
4520 /* If the file name has special constructs in it,
4521 call the corresponding file handler. */
4522 handler = Ffind_file_name_handler (b->filename,
4523 Qverify_visited_file_modtime);
4524 if (!NILP (handler))
4525 return call2 (handler, Qverify_visited_file_modtime, buf);
4527 filename = ENCODE_FILE (b->filename);
4529 if (stat (XSTRING (filename)->data, &st) < 0)
4531 /* If the file doesn't exist now and didn't exist before,
4532 we say that it isn't modified, provided the error is a tame one. */
4533 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
4534 st.st_mtime = -1;
4535 else
4536 st.st_mtime = 0;
4538 if (st.st_mtime == b->modtime
4539 /* If both are positive, accept them if they are off by one second. */
4540 || (st.st_mtime > 0 && b->modtime > 0
4541 && (st.st_mtime == b->modtime + 1
4542 || st.st_mtime == b->modtime - 1)))
4543 return Qt;
4544 return Qnil;
4547 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
4548 Sclear_visited_file_modtime, 0, 0, 0,
4549 "Clear out records of last mod time of visited file.\n\
4550 Next attempt to save will certainly not complain of a discrepancy.")
4553 current_buffer->modtime = 0;
4554 return Qnil;
4557 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
4558 Svisited_file_modtime, 0, 0, 0,
4559 "Return the current buffer's recorded visited file modification time.\n\
4560 The value is a list of the form (HIGH . LOW), like the time values\n\
4561 that `file-attributes' returns.")
4564 return long_to_cons ((unsigned long) current_buffer->modtime);
4567 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
4568 Sset_visited_file_modtime, 0, 1, 0,
4569 "Update buffer's recorded modification time from the visited file's time.\n\
4570 Useful if the buffer was not read from the file normally\n\
4571 or if the file itself has been changed for some known benign reason.\n\
4572 An argument specifies the modification time value to use\n\
4573 \(instead of that of the visited file), in the form of a list\n\
4574 \(HIGH . LOW) or (HIGH LOW).")
4575 (time_list)
4576 Lisp_Object time_list;
4578 if (!NILP (time_list))
4579 current_buffer->modtime = cons_to_long (time_list);
4580 else
4582 register Lisp_Object filename;
4583 struct stat st;
4584 Lisp_Object handler;
4586 filename = Fexpand_file_name (current_buffer->filename, Qnil);
4588 /* If the file name has special constructs in it,
4589 call the corresponding file handler. */
4590 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
4591 if (!NILP (handler))
4592 /* The handler can find the file name the same way we did. */
4593 return call2 (handler, Qset_visited_file_modtime, Qnil);
4595 filename = ENCODE_FILE (filename);
4597 if (stat (XSTRING (filename)->data, &st) >= 0)
4598 current_buffer->modtime = st.st_mtime;
4601 return Qnil;
4604 Lisp_Object
4605 auto_save_error ()
4607 ring_bell ();
4608 message ("Autosaving...error for %s", XSTRING (current_buffer->name)->data);
4609 Fsleep_for (make_number (1), Qnil);
4610 message ("Autosaving...error!for %s", XSTRING (current_buffer->name)->data);
4611 Fsleep_for (make_number (1), Qnil);
4612 message ("Autosaving...error for %s", XSTRING (current_buffer->name)->data);
4613 Fsleep_for (make_number (1), Qnil);
4614 return Qnil;
4617 Lisp_Object
4618 auto_save_1 ()
4620 unsigned char *fn;
4621 struct stat st;
4623 /* Get visited file's mode to become the auto save file's mode. */
4624 if (stat (XSTRING (current_buffer->filename)->data, &st) >= 0)
4625 /* But make sure we can overwrite it later! */
4626 auto_save_mode_bits = st.st_mode | 0600;
4627 else
4628 auto_save_mode_bits = 0666;
4630 return
4631 Fwrite_region (Qnil, Qnil,
4632 current_buffer->auto_save_file_name,
4633 Qnil, Qlambda, Qnil);
4636 static Lisp_Object
4637 do_auto_save_unwind (stream) /* used as unwind-protect function */
4638 Lisp_Object stream;
4640 auto_saving = 0;
4641 if (!NILP (stream))
4642 fclose ((FILE *) (XFASTINT (XCONS (stream)->car) << 16
4643 | XFASTINT (XCONS (stream)->cdr)));
4644 return Qnil;
4647 static Lisp_Object
4648 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
4649 Lisp_Object value;
4651 minibuffer_auto_raise = XINT (value);
4652 return Qnil;
4655 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
4656 "Auto-save all buffers that need it.\n\
4657 This is all buffers that have auto-saving enabled\n\
4658 and are changed since last auto-saved.\n\
4659 Auto-saving writes the buffer into a file\n\
4660 so that your editing is not lost if the system crashes.\n\
4661 This file is not the file you visited; that changes only when you save.\n\
4662 Normally we run the normal hook `auto-save-hook' before saving.\n\n\
4663 A non-nil NO-MESSAGE argument means do not print any message if successful.\n\
4664 A non-nil CURRENT-ONLY argument means save only current buffer.")
4665 (no_message, current_only)
4666 Lisp_Object no_message, current_only;
4668 struct buffer *old = current_buffer, *b;
4669 Lisp_Object tail, buf;
4670 int auto_saved = 0;
4671 char *omessage = echo_area_glyphs;
4672 int omessage_length = echo_area_glyphs_length;
4673 int do_handled_files;
4674 Lisp_Object oquit;
4675 FILE *stream;
4676 Lisp_Object lispstream;
4677 int count = specpdl_ptr - specpdl;
4678 int *ptr;
4679 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
4681 /* Ordinarily don't quit within this function,
4682 but don't make it impossible to quit (in case we get hung in I/O). */
4683 oquit = Vquit_flag;
4684 Vquit_flag = Qnil;
4686 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
4687 point to non-strings reached from Vbuffer_alist. */
4689 if (minibuf_level)
4690 no_message = Qt;
4692 if (!NILP (Vrun_hooks))
4693 call1 (Vrun_hooks, intern ("auto-save-hook"));
4695 if (STRINGP (Vauto_save_list_file_name))
4697 Lisp_Object listfile;
4698 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
4699 stream = fopen (XSTRING (listfile)->data, "w");
4700 if (stream != NULL)
4702 /* Arrange to close that file whether or not we get an error.
4703 Also reset auto_saving to 0. */
4704 lispstream = Fcons (Qnil, Qnil);
4705 XSETFASTINT (XCONS (lispstream)->car, (EMACS_UINT)stream >> 16);
4706 XSETFASTINT (XCONS (lispstream)->cdr, (EMACS_UINT)stream & 0xffff);
4708 else
4709 lispstream = Qnil;
4711 else
4713 stream = NULL;
4714 lispstream = Qnil;
4717 record_unwind_protect (do_auto_save_unwind, lispstream);
4718 record_unwind_protect (do_auto_save_unwind_1,
4719 make_number (minibuffer_auto_raise));
4720 minibuffer_auto_raise = 0;
4721 auto_saving = 1;
4723 /* First, save all files which don't have handlers. If Emacs is
4724 crashing, the handlers may tweak what is causing Emacs to crash
4725 in the first place, and it would be a shame if Emacs failed to
4726 autosave perfectly ordinary files because it couldn't handle some
4727 ange-ftp'd file. */
4728 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
4729 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCONS (tail)->cdr)
4731 buf = XCONS (XCONS (tail)->car)->cdr;
4732 b = XBUFFER (buf);
4734 /* Record all the buffers that have auto save mode
4735 in the special file that lists them. For each of these buffers,
4736 Record visited name (if any) and auto save name. */
4737 if (STRINGP (b->auto_save_file_name)
4738 && stream != NULL && do_handled_files == 0)
4740 if (!NILP (b->filename))
4742 fwrite (XSTRING (b->filename)->data, 1,
4743 XSTRING (b->filename)->size, stream);
4745 putc ('\n', stream);
4746 fwrite (XSTRING (b->auto_save_file_name)->data, 1,
4747 XSTRING (b->auto_save_file_name)->size, stream);
4748 putc ('\n', stream);
4751 if (!NILP (current_only)
4752 && b != current_buffer)
4753 continue;
4755 /* Don't auto-save indirect buffers.
4756 The base buffer takes care of it. */
4757 if (b->base_buffer)
4758 continue;
4760 /* Check for auto save enabled
4761 and file changed since last auto save
4762 and file changed since last real save. */
4763 if (STRINGP (b->auto_save_file_name)
4764 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
4765 && b->auto_save_modified < BUF_MODIFF (b)
4766 /* -1 means we've turned off autosaving for a while--see below. */
4767 && XINT (b->save_length) >= 0
4768 && (do_handled_files
4769 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
4770 Qwrite_region))))
4772 EMACS_TIME before_time, after_time;
4774 EMACS_GET_TIME (before_time);
4776 /* If we had a failure, don't try again for 20 minutes. */
4777 if (b->auto_save_failure_time >= 0
4778 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
4779 continue;
4781 if ((XFASTINT (b->save_length) * 10
4782 > (BUF_Z (b) - BUF_BEG (b)) * 13)
4783 /* A short file is likely to change a large fraction;
4784 spare the user annoying messages. */
4785 && XFASTINT (b->save_length) > 5000
4786 /* These messages are frequent and annoying for `*mail*'. */
4787 && !EQ (b->filename, Qnil)
4788 && NILP (no_message))
4790 /* It has shrunk too much; turn off auto-saving here. */
4791 minibuffer_auto_raise = orig_minibuffer_auto_raise;
4792 message ("Buffer %s has shrunk a lot; auto save turned off there",
4793 XSTRING (b->name)->data);
4794 minibuffer_auto_raise = 0;
4795 /* Turn off auto-saving until there's a real save,
4796 and prevent any more warnings. */
4797 XSETINT (b->save_length, -1);
4798 Fsleep_for (make_number (1), Qnil);
4799 continue;
4801 set_buffer_internal (b);
4802 if (!auto_saved && NILP (no_message))
4803 message1 ("Auto-saving...");
4804 internal_condition_case (auto_save_1, Qt, auto_save_error);
4805 auto_saved++;
4806 b->auto_save_modified = BUF_MODIFF (b);
4807 XSETFASTINT (current_buffer->save_length, Z - BEG);
4808 set_buffer_internal (old);
4810 EMACS_GET_TIME (after_time);
4812 /* If auto-save took more than 60 seconds,
4813 assume it was an NFS failure that got a timeout. */
4814 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
4815 b->auto_save_failure_time = EMACS_SECS (after_time);
4819 /* Prevent another auto save till enough input events come in. */
4820 record_auto_save ();
4822 if (auto_saved && NILP (no_message))
4824 if (omessage)
4826 sit_for (1, 0, 0, 0, 0);
4827 message2 (omessage, omessage_length);
4829 else
4830 message1 ("Auto-saving...done");
4833 Vquit_flag = oquit;
4835 unbind_to (count, Qnil);
4836 return Qnil;
4839 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
4840 Sset_buffer_auto_saved, 0, 0, 0,
4841 "Mark current buffer as auto-saved with its current text.\n\
4842 No auto-save file will be written until the buffer changes again.")
4845 current_buffer->auto_save_modified = MODIFF;
4846 XSETFASTINT (current_buffer->save_length, Z - BEG);
4847 current_buffer->auto_save_failure_time = -1;
4848 return Qnil;
4851 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
4852 Sclear_buffer_auto_save_failure, 0, 0, 0,
4853 "Clear any record of a recent auto-save failure in the current buffer.")
4856 current_buffer->auto_save_failure_time = -1;
4857 return Qnil;
4860 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
4861 0, 0, 0,
4862 "Return t if buffer has been auto-saved since last read in or saved.")
4865 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
4868 /* Reading and completing file names */
4869 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
4871 /* In the string VAL, change each $ to $$ and return the result. */
4873 static Lisp_Object
4874 double_dollars (val)
4875 Lisp_Object val;
4877 register unsigned char *old, *new;
4878 register int n;
4879 int osize, count;
4881 osize = XSTRING (val)->size;
4882 /* Quote "$" as "$$" to get it past substitute-in-file-name */
4883 for (n = osize, count = 0, old = XSTRING (val)->data; n > 0; n--)
4884 if (*old++ == '$') count++;
4885 if (count > 0)
4887 old = XSTRING (val)->data;
4888 val = Fmake_string (make_number (osize + count), make_number (0));
4889 new = XSTRING (val)->data;
4890 for (n = osize; n > 0; n--)
4891 if (*old != '$')
4892 *new++ = *old++;
4893 else
4895 *new++ = '$';
4896 *new++ = '$';
4897 old++;
4900 return val;
4903 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
4904 3, 3, 0,
4905 "Internal subroutine for read-file-name. Do not call this.")
4906 (string, dir, action)
4907 Lisp_Object string, dir, action;
4908 /* action is nil for complete, t for return list of completions,
4909 lambda for verify final value */
4911 Lisp_Object name, specdir, realdir, val, orig_string;
4912 int changed;
4913 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4915 CHECK_STRING (string, 0);
4917 realdir = dir;
4918 name = string;
4919 orig_string = Qnil;
4920 specdir = Qnil;
4921 changed = 0;
4922 /* No need to protect ACTION--we only compare it with t and nil. */
4923 GCPRO5 (string, realdir, name, specdir, orig_string);
4925 if (XSTRING (string)->size == 0)
4927 if (EQ (action, Qlambda))
4929 UNGCPRO;
4930 return Qnil;
4933 else
4935 orig_string = string;
4936 string = Fsubstitute_in_file_name (string);
4937 changed = NILP (Fstring_equal (string, orig_string));
4938 name = Ffile_name_nondirectory (string);
4939 val = Ffile_name_directory (string);
4940 if (! NILP (val))
4941 realdir = Fexpand_file_name (val, realdir);
4944 if (NILP (action))
4946 specdir = Ffile_name_directory (string);
4947 val = Ffile_name_completion (name, realdir);
4948 UNGCPRO;
4949 if (!STRINGP (val))
4951 if (changed)
4952 return double_dollars (string);
4953 return val;
4956 if (!NILP (specdir))
4957 val = concat2 (specdir, val);
4958 #ifndef VMS
4959 return double_dollars (val);
4960 #else /* not VMS */
4961 return val;
4962 #endif /* not VMS */
4964 UNGCPRO;
4966 if (EQ (action, Qt))
4967 return Ffile_name_all_completions (name, realdir);
4968 /* Only other case actually used is ACTION = lambda */
4969 #ifdef VMS
4970 /* Supposedly this helps commands such as `cd' that read directory names,
4971 but can someone explain how it helps them? -- RMS */
4972 if (XSTRING (name)->size == 0)
4973 return Qt;
4974 #endif /* VMS */
4975 return Ffile_exists_p (string);
4978 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 5, 0,
4979 "Read file name, prompting with PROMPT and completing in directory DIR.\n\
4980 Value is not expanded---you must call `expand-file-name' yourself.\n\
4981 Default name to DEFAULT-FILENAME if user enters a null string.\n\
4982 (If DEFAULT-FILENAME is omitted, the visited file name is used,\n\
4983 except that if INITIAL is specified, that combined with DIR is used.)\n\
4984 Fourth arg MUSTMATCH non-nil means require existing file's name.\n\
4985 Non-nil and non-t means also require confirmation after completion.\n\
4986 Fifth arg INITIAL specifies text to start with.\n\
4987 DIR defaults to current buffer's directory default.")
4988 (prompt, dir, default_filename, mustmatch, initial)
4989 Lisp_Object prompt, dir, default_filename, mustmatch, initial;
4991 Lisp_Object val, insdef, insdef1, tem;
4992 struct gcpro gcpro1, gcpro2;
4993 register char *homedir;
4994 int count;
4996 if (NILP (dir))
4997 dir = current_buffer->directory;
4998 if (NILP (default_filename))
5000 if (! NILP (initial))
5001 default_filename = Fexpand_file_name (initial, dir);
5002 else
5003 default_filename = current_buffer->filename;
5006 /* If dir starts with user's homedir, change that to ~. */
5007 homedir = (char *) egetenv ("HOME");
5008 #ifdef DOS_NT
5009 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
5010 CORRECT_DIR_SEPS (homedir);
5011 #endif
5012 if (homedir != 0
5013 && STRINGP (dir)
5014 && !strncmp (homedir, XSTRING (dir)->data, strlen (homedir))
5015 && IS_DIRECTORY_SEP (XSTRING (dir)->data[strlen (homedir)]))
5017 dir = make_string (XSTRING (dir)->data + strlen (homedir) - 1,
5018 XSTRING (dir)->size - strlen (homedir) + 1);
5019 XSTRING (dir)->data[0] = '~';
5022 if (insert_default_directory && STRINGP (dir))
5024 insdef = dir;
5025 if (!NILP (initial))
5027 Lisp_Object args[2], pos;
5029 args[0] = insdef;
5030 args[1] = initial;
5031 insdef = Fconcat (2, args);
5032 pos = make_number (XSTRING (double_dollars (dir))->size);
5033 insdef1 = Fcons (double_dollars (insdef), pos);
5035 else
5036 insdef1 = double_dollars (insdef);
5038 else if (STRINGP (initial))
5040 insdef = initial;
5041 insdef1 = Fcons (double_dollars (insdef), make_number (0));
5043 else
5044 insdef = Qnil, insdef1 = Qnil;
5046 #ifdef VMS
5047 count = specpdl_ptr - specpdl;
5048 specbind (intern ("completion-ignore-case"), Qt);
5049 #endif
5051 GCPRO2 (insdef, default_filename);
5052 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
5053 dir, mustmatch, insdef1,
5054 Qfile_name_history, default_filename, Qnil);
5055 /* If Fcompleting_read returned the default string itself
5056 (rather than a new string with the same contents),
5057 it has to mean that the user typed RET with the minibuffer empty.
5058 In that case, we really want to return ""
5059 so that commands such as set-visited-file-name can distinguish. */
5060 if (EQ (val, default_filename))
5061 val = build_string ("");
5063 #ifdef VMS
5064 unbind_to (count, Qnil);
5065 #endif
5067 UNGCPRO;
5068 if (NILP (val))
5069 error ("No file name specified");
5070 tem = Fstring_equal (val, insdef);
5071 if (!NILP (tem) && !NILP (default_filename))
5072 return default_filename;
5073 if (XSTRING (val)->size == 0 && NILP (insdef))
5075 if (!NILP (default_filename))
5076 return default_filename;
5077 else
5078 error ("No default file name");
5080 return Fsubstitute_in_file_name (val);
5083 #if 0 /* Old version */
5084 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 5, 0,
5085 /* Don't confuse make-docfile by having two doc strings for this function.
5086 make-docfile does not pay attention to #if, for good reason! */
5088 (prompt, dir, defalt, mustmatch, initial)
5089 Lisp_Object prompt, dir, defalt, mustmatch, initial;
5091 Lisp_Object val, insdef, tem;
5092 struct gcpro gcpro1, gcpro2;
5093 register char *homedir;
5094 int count;
5096 if (NILP (dir))
5097 dir = current_buffer->directory;
5098 if (NILP (defalt))
5099 defalt = current_buffer->filename;
5101 /* If dir starts with user's homedir, change that to ~. */
5102 homedir = (char *) egetenv ("HOME");
5103 if (homedir != 0
5104 && STRINGP (dir)
5105 && !strncmp (homedir, XSTRING (dir)->data, strlen (homedir))
5106 && XSTRING (dir)->data[strlen (homedir)] == '/')
5108 dir = make_string (XSTRING (dir)->data + strlen (homedir) - 1,
5109 XSTRING (dir)->size - strlen (homedir) + 1);
5110 XSTRING (dir)->data[0] = '~';
5113 if (!NILP (initial))
5114 insdef = initial;
5115 else if (insert_default_directory)
5116 insdef = dir;
5117 else
5118 insdef = build_string ("");
5120 #ifdef VMS
5121 count = specpdl_ptr - specpdl;
5122 specbind (intern ("completion-ignore-case"), Qt);
5123 #endif
5125 GCPRO2 (insdef, defalt);
5126 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
5127 dir, mustmatch,
5128 insert_default_directory ? insdef : Qnil,
5129 Qfile_name_history, Qnil, Qnil);
5131 #ifdef VMS
5132 unbind_to (count, Qnil);
5133 #endif
5135 UNGCPRO;
5136 if (NILP (val))
5137 error ("No file name specified");
5138 tem = Fstring_equal (val, insdef);
5139 if (!NILP (tem) && !NILP (defalt))
5140 return defalt;
5141 return Fsubstitute_in_file_name (val);
5143 #endif /* Old version */
5145 syms_of_fileio ()
5147 Qexpand_file_name = intern ("expand-file-name");
5148 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
5149 Qdirectory_file_name = intern ("directory-file-name");
5150 Qfile_name_directory = intern ("file-name-directory");
5151 Qfile_name_nondirectory = intern ("file-name-nondirectory");
5152 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
5153 Qfile_name_as_directory = intern ("file-name-as-directory");
5154 Qcopy_file = intern ("copy-file");
5155 Qmake_directory_internal = intern ("make-directory-internal");
5156 Qdelete_directory = intern ("delete-directory");
5157 Qdelete_file = intern ("delete-file");
5158 Qrename_file = intern ("rename-file");
5159 Qadd_name_to_file = intern ("add-name-to-file");
5160 Qmake_symbolic_link = intern ("make-symbolic-link");
5161 Qfile_exists_p = intern ("file-exists-p");
5162 Qfile_executable_p = intern ("file-executable-p");
5163 Qfile_readable_p = intern ("file-readable-p");
5164 Qfile_writable_p = intern ("file-writable-p");
5165 Qfile_symlink_p = intern ("file-symlink-p");
5166 Qaccess_file = intern ("access-file");
5167 Qfile_directory_p = intern ("file-directory-p");
5168 Qfile_regular_p = intern ("file-regular-p");
5169 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
5170 Qfile_modes = intern ("file-modes");
5171 Qset_file_modes = intern ("set-file-modes");
5172 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
5173 Qinsert_file_contents = intern ("insert-file-contents");
5174 Qwrite_region = intern ("write-region");
5175 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
5176 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
5178 staticpro (&Qexpand_file_name);
5179 staticpro (&Qsubstitute_in_file_name);
5180 staticpro (&Qdirectory_file_name);
5181 staticpro (&Qfile_name_directory);
5182 staticpro (&Qfile_name_nondirectory);
5183 staticpro (&Qunhandled_file_name_directory);
5184 staticpro (&Qfile_name_as_directory);
5185 staticpro (&Qcopy_file);
5186 staticpro (&Qmake_directory_internal);
5187 staticpro (&Qdelete_directory);
5188 staticpro (&Qdelete_file);
5189 staticpro (&Qrename_file);
5190 staticpro (&Qadd_name_to_file);
5191 staticpro (&Qmake_symbolic_link);
5192 staticpro (&Qfile_exists_p);
5193 staticpro (&Qfile_executable_p);
5194 staticpro (&Qfile_readable_p);
5195 staticpro (&Qfile_writable_p);
5196 staticpro (&Qaccess_file);
5197 staticpro (&Qfile_symlink_p);
5198 staticpro (&Qfile_directory_p);
5199 staticpro (&Qfile_regular_p);
5200 staticpro (&Qfile_accessible_directory_p);
5201 staticpro (&Qfile_modes);
5202 staticpro (&Qset_file_modes);
5203 staticpro (&Qfile_newer_than_file_p);
5204 staticpro (&Qinsert_file_contents);
5205 staticpro (&Qwrite_region);
5206 staticpro (&Qverify_visited_file_modtime);
5207 staticpro (&Qset_visited_file_modtime);
5209 Qfile_name_history = intern ("file-name-history");
5210 Fset (Qfile_name_history, Qnil);
5211 staticpro (&Qfile_name_history);
5213 Qfile_error = intern ("file-error");
5214 staticpro (&Qfile_error);
5215 Qfile_already_exists = intern ("file-already-exists");
5216 staticpro (&Qfile_already_exists);
5217 Qfile_date_error = intern ("file-date-error");
5218 staticpro (&Qfile_date_error);
5220 #ifdef DOS_NT
5221 Qfind_buffer_file_type = intern ("find-buffer-file-type");
5222 staticpro (&Qfind_buffer_file_type);
5223 #endif /* DOS_NT */
5225 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
5226 "*Coding system for encoding file names.");
5227 Vfile_name_coding_system = Qnil;
5229 DEFVAR_LISP ("auto-save-file-format", &Vauto_save_file_format,
5230 "*Format in which to write auto-save files.\n\
5231 Should be a list of symbols naming formats that are defined in `format-alist'.\n\
5232 If it is t, which is the default, auto-save files are written in the\n\
5233 same format as a regular save would use.");
5234 Vauto_save_file_format = Qt;
5236 Qformat_decode = intern ("format-decode");
5237 staticpro (&Qformat_decode);
5238 Qformat_annotate_function = intern ("format-annotate-function");
5239 staticpro (&Qformat_annotate_function);
5241 Qcar_less_than_car = intern ("car-less-than-car");
5242 staticpro (&Qcar_less_than_car);
5244 Fput (Qfile_error, Qerror_conditions,
5245 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
5246 Fput (Qfile_error, Qerror_message,
5247 build_string ("File error"));
5249 Fput (Qfile_already_exists, Qerror_conditions,
5250 Fcons (Qfile_already_exists,
5251 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
5252 Fput (Qfile_already_exists, Qerror_message,
5253 build_string ("File already exists"));
5255 Fput (Qfile_date_error, Qerror_conditions,
5256 Fcons (Qfile_date_error,
5257 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
5258 Fput (Qfile_date_error, Qerror_message,
5259 build_string ("Cannot set file date"));
5261 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
5262 "*Non-nil means when reading a filename start with default dir in minibuffer.");
5263 insert_default_directory = 1;
5265 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
5266 "*Non-nil means write new files with record format `stmlf'.\n\
5267 nil means use format `var'. This variable is meaningful only on VMS.");
5268 vms_stmlf_recfm = 0;
5270 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
5271 "Directory separator character for built-in functions that return file names.\n\
5272 The value should be either ?/ or ?\\ (any other value is treated as ?\\).\n\
5273 This variable affects the built-in functions only on Windows,\n\
5274 on other platforms, it is initialized so that Lisp code can find out\n\
5275 what the normal separator is.");
5276 XSETFASTINT (Vdirectory_sep_char, '/');
5278 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
5279 "*Alist of elements (REGEXP . HANDLER) for file names handled specially.\n\
5280 If a file name matches REGEXP, then all I/O on that file is done by calling\n\
5281 HANDLER.\n\
5283 The first argument given to HANDLER is the name of the I/O primitive\n\
5284 to be handled; the remaining arguments are the arguments that were\n\
5285 passed to that primitive. For example, if you do\n\
5286 (file-exists-p FILENAME)\n\
5287 and FILENAME is handled by HANDLER, then HANDLER is called like this:\n\
5288 (funcall HANDLER 'file-exists-p FILENAME)\n\
5289 The function `find-file-name-handler' checks this list for a handler\n\
5290 for its argument.");
5291 Vfile_name_handler_alist = Qnil;
5293 DEFVAR_LISP ("set-auto-coding-function",
5294 &Vset_auto_coding_function,
5295 "If non-nil, a function to call to decide a coding system of file.\n\
5296 One argument is passed to this function: the string of concatination\n\
5297 or the heading 1K-byte and the tailing 3K-byte of a file to be read.\n\
5298 This function should return a coding system to decode the file contents\n\
5299 specified in the heading lines with the format:\n\
5300 -*- ... coding: CODING-SYSTEM; ... -*-\n\
5301 or local variable spec of the tailing lines with `coding:' tag.");
5302 Vset_auto_coding_function = Qnil;
5304 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
5305 "A list of functions to be called at the end of `insert-file-contents'.\n\
5306 Each is passed one argument, the number of bytes inserted. It should return\n\
5307 the new byte count, and leave point the same. If `insert-file-contents' is\n\
5308 intercepted by a handler from `file-name-handler-alist', that handler is\n\
5309 responsible for calling the after-insert-file-functions if appropriate.");
5310 Vafter_insert_file_functions = Qnil;
5312 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
5313 "A list of functions to be called at the start of `write-region'.\n\
5314 Each is passed two arguments, START and END as for `write-region'.\n\
5315 These are usually two numbers but not always; see the documentation\n\
5316 for `write-region'. The function should return a list of pairs\n\
5317 of the form (POSITION . STRING), consisting of strings to be effectively\n\
5318 inserted at the specified positions of the file being written (1 means to\n\
5319 insert before the first byte written). The POSITIONs must be sorted into\n\
5320 increasing order. If there are several functions in the list, the several\n\
5321 lists are merged destructively.");
5322 Vwrite_region_annotate_functions = Qnil;
5324 DEFVAR_LISP ("write-region-annotations-so-far",
5325 &Vwrite_region_annotations_so_far,
5326 "When an annotation function is called, this holds the previous annotations.\n\
5327 These are the annotations made by other annotation functions\n\
5328 that were already called. See also `write-region-annotate-functions'.");
5329 Vwrite_region_annotations_so_far = Qnil;
5331 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
5332 "A list of file name handlers that temporarily should not be used.\n\
5333 This applies only to the operation `inhibit-file-name-operation'.");
5334 Vinhibit_file_name_handlers = Qnil;
5336 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
5337 "The operation for which `inhibit-file-name-handlers' is applicable.");
5338 Vinhibit_file_name_operation = Qnil;
5340 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
5341 "File name in which we write a list of all auto save file names.\n\
5342 This variable is initialized automatically from `auto-save-list-file-prefix'\n\
5343 shortly after Emacs reads your `.emacs' file, if you have not yet given it\n\
5344 a non-nil value.");
5345 Vauto_save_list_file_name = Qnil;
5347 defsubr (&Sfind_file_name_handler);
5348 defsubr (&Sfile_name_directory);
5349 defsubr (&Sfile_name_nondirectory);
5350 defsubr (&Sunhandled_file_name_directory);
5351 defsubr (&Sfile_name_as_directory);
5352 defsubr (&Sdirectory_file_name);
5353 defsubr (&Smake_temp_name);
5354 defsubr (&Sexpand_file_name);
5355 defsubr (&Ssubstitute_in_file_name);
5356 defsubr (&Scopy_file);
5357 defsubr (&Smake_directory_internal);
5358 defsubr (&Sdelete_directory);
5359 defsubr (&Sdelete_file);
5360 defsubr (&Srename_file);
5361 defsubr (&Sadd_name_to_file);
5362 #ifdef S_IFLNK
5363 defsubr (&Smake_symbolic_link);
5364 #endif /* S_IFLNK */
5365 #ifdef VMS
5366 defsubr (&Sdefine_logical_name);
5367 #endif /* VMS */
5368 #ifdef HPUX_NET
5369 defsubr (&Ssysnetunam);
5370 #endif /* HPUX_NET */
5371 defsubr (&Sfile_name_absolute_p);
5372 defsubr (&Sfile_exists_p);
5373 defsubr (&Sfile_executable_p);
5374 defsubr (&Sfile_readable_p);
5375 defsubr (&Sfile_writable_p);
5376 defsubr (&Saccess_file);
5377 defsubr (&Sfile_symlink_p);
5378 defsubr (&Sfile_directory_p);
5379 defsubr (&Sfile_accessible_directory_p);
5380 defsubr (&Sfile_regular_p);
5381 defsubr (&Sfile_modes);
5382 defsubr (&Sset_file_modes);
5383 defsubr (&Sset_default_file_modes);
5384 defsubr (&Sdefault_file_modes);
5385 defsubr (&Sfile_newer_than_file_p);
5386 defsubr (&Sinsert_file_contents);
5387 defsubr (&Swrite_region);
5388 defsubr (&Scar_less_than_car);
5389 defsubr (&Sverify_visited_file_modtime);
5390 defsubr (&Sclear_visited_file_modtime);
5391 defsubr (&Svisited_file_modtime);
5392 defsubr (&Sset_visited_file_modtime);
5393 defsubr (&Sdo_auto_save);
5394 defsubr (&Sset_buffer_auto_saved);
5395 defsubr (&Sclear_buffer_auto_save_failure);
5396 defsubr (&Srecent_auto_save_p);
5398 defsubr (&Sread_file_name_internal);
5399 defsubr (&Sread_file_name);
5401 #ifdef unix
5402 defsubr (&Sunix_sync);
5403 #endif