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