(Vauto_save_list_file_name): Move here from file.el.
[emacs/old-mirror.git] / src / fileio.c
blob81836bd82139f73d16b2fb5c3432ab649a03fc1f
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
25 #ifdef HAVE_FCNTL_H
26 #include <fcntl.h>
27 #endif
29 #include <stdio.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
39 #endif
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
43 #endif
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
47 #endif
49 #ifdef HAVE_PWD_H
50 #include <pwd.h>
51 #endif
53 #include <ctype.h>
55 #ifdef VMS
56 #include "vmsdir.h"
57 #include <perror.h>
58 #include <stddef.h>
59 #include <string.h>
60 #endif
62 #include <errno.h>
64 #ifndef vax11c
65 #ifndef USE_CRT_DLL
66 extern int errno;
67 #endif
68 #endif
70 #ifdef APOLLO
71 #include <sys/time.h>
72 #endif
74 #include "lisp.h"
75 #include "intervals.h"
76 #include "buffer.h"
77 #include "charset.h"
78 #include "coding.h"
79 #include "window.h"
80 #include "blockinput.h"
82 #ifdef WINDOWSNT
83 #define NOMINMAX 1
84 #include <windows.h>
85 #include <stdlib.h>
86 #include <fcntl.h>
87 #endif /* not WINDOWSNT */
89 #ifdef MSDOS
90 #include "msdos.h"
91 #include <sys/param.h>
92 #if __DJGPP__ >= 2
93 #include <fcntl.h>
94 #include <string.h>
95 #endif
96 #endif
98 #ifdef DOS_NT
99 #define CORRECT_DIR_SEPS(s) \
100 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
101 else unixtodos_filename (s); \
102 } while (0)
103 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
104 redirector allows the six letters between 'Z' and 'a' as well. */
105 #ifdef MSDOS
106 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
107 #endif
108 #ifdef WINDOWSNT
109 #define IS_DRIVE(x) isalpha (x)
110 #endif
111 /* Need to lower-case the drive letter, or else expanded
112 filenames will sometimes compare inequal, because
113 `expand-file-name' doesn't always down-case the drive letter. */
114 #define DRIVE_LETTER(x) (tolower (x))
115 #endif
117 #ifdef VMS
118 #include <file.h>
119 #include <rmsdef.h>
120 #include <fab.h>
121 #include <nam.h>
122 #endif
124 #include "systime.h"
126 #ifdef HPUX
127 #include <netio.h>
128 #ifndef HPUX8
129 #ifndef HPUX9
130 #include <errnet.h>
131 #endif
132 #endif
133 #endif
135 #include "commands.h"
136 extern int use_dialog_box;
137 extern int use_file_dialog;
139 #ifndef O_WRONLY
140 #define O_WRONLY 1
141 #endif
143 #ifndef O_RDONLY
144 #define O_RDONLY 0
145 #endif
147 #ifndef S_ISLNK
148 # define lstat stat
149 #endif
151 #ifndef FILE_SYSTEM_CASE
152 #define FILE_SYSTEM_CASE(filename) (filename)
153 #endif
155 /* Nonzero during writing of auto-save files */
156 int auto_saving;
158 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
159 a new file with the same mode as the original */
160 int auto_save_mode_bits;
162 /* Set by auto_save_1 if an error occurred during the last auto-save. */
163 int auto_save_error_occurred;
165 /* The symbol bound to coding-system-for-read when
166 insert-file-contents is called for recovering a file. This is not
167 an actual coding system name, but just an indicator to tell
168 insert-file-contents to use `emacs-mule' with a special flag for
169 auto saving and recovering a file. */
170 Lisp_Object Qauto_save_coding;
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 /* Property name of a file name handler,
184 which gives a list of operations it handles.. */
185 Lisp_Object Qoperations;
187 /* Lisp functions for translating file formats */
188 Lisp_Object Qformat_decode, Qformat_annotate_function;
190 /* Function to be called to decide a coding system of a reading file. */
191 Lisp_Object Vset_auto_coding_function;
193 /* Functions to be called to process text properties in inserted file. */
194 Lisp_Object Vafter_insert_file_functions;
196 /* Lisp function for setting buffer-file-coding-system and the
197 multibyteness of the current buffer after inserting a file. */
198 Lisp_Object Qafter_insert_file_set_coding;
200 /* Functions to be called to create text property annotations for file. */
201 Lisp_Object Vwrite_region_annotate_functions;
202 Lisp_Object Qwrite_region_annotate_functions;
204 /* During build_annotations, each time an annotation function is called,
205 this holds the annotations made by the previous functions. */
206 Lisp_Object Vwrite_region_annotations_so_far;
208 /* File name in which we write a list of all our auto save files. */
209 Lisp_Object Vauto_save_list_file_name;
211 /* Whether or not files are auto-saved into themselves. */
212 Lisp_Object Vauto_save_visited_file_name;
214 /* Function to call to read a file name. */
215 Lisp_Object Vread_file_name_function;
217 /* Current predicate used by read_file_name_internal. */
218 Lisp_Object Vread_file_name_predicate;
220 /* Nonzero means completion ignores case when reading file name. */
221 int read_file_name_completion_ignore_case;
223 /* Nonzero means, when reading a filename in the minibuffer,
224 start out by inserting the default directory into the minibuffer. */
225 int insert_default_directory;
227 /* On VMS, nonzero means write new files with record format stmlf.
228 Zero means use var format. */
229 int vms_stmlf_recfm;
231 /* On NT, specifies the directory separator character, used (eg.) when
232 expanding file names. This can be bound to / or \. */
233 Lisp_Object Vdirectory_sep_char;
235 #ifdef HAVE_FSYNC
236 /* Nonzero means skip the call to fsync in Fwrite-region. */
237 int write_region_inhibit_fsync;
238 #endif
240 extern Lisp_Object Vuser_login_name;
242 #ifdef WINDOWSNT
243 extern Lisp_Object Vw32_get_true_file_attributes;
244 #endif
246 extern int minibuf_level;
248 extern int minibuffer_auto_raise;
250 extern int history_delete_duplicates;
252 /* These variables describe handlers that have "already" had a chance
253 to handle the current operation.
255 Vinhibit_file_name_handlers is a list of file name handlers.
256 Vinhibit_file_name_operation is the operation being handled.
257 If we try to handle that operation, we ignore those handlers. */
259 static Lisp_Object Vinhibit_file_name_handlers;
260 static Lisp_Object Vinhibit_file_name_operation;
262 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
263 Lisp_Object Qexcl;
264 Lisp_Object Qfile_name_history;
266 Lisp_Object Qcar_less_than_car;
268 static int a_write P_ ((int, Lisp_Object, int, int,
269 Lisp_Object *, struct coding_system *));
270 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
273 void
274 report_file_error (string, data)
275 const char *string;
276 Lisp_Object data;
278 Lisp_Object errstring;
279 int errorno = errno;
281 synchronize_system_messages_locale ();
282 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
283 Vlocale_coding_system, 0);
285 while (1)
286 switch (errorno)
288 case EEXIST:
289 xsignal (Qfile_already_exists, Fcons (errstring, data));
290 break;
291 default:
292 /* System error messages are capitalized. Downcase the initial
293 unless it is followed by a slash. */
294 if (SREF (errstring, 1) != '/')
295 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
297 xsignal (Qfile_error,
298 Fcons (build_string (string), Fcons (errstring, data)));
302 Lisp_Object
303 close_file_unwind (fd)
304 Lisp_Object fd;
306 emacs_close (XFASTINT (fd));
307 return Qnil;
310 /* Restore point, having saved it as a marker. */
312 static Lisp_Object
313 restore_point_unwind (location)
314 Lisp_Object location;
316 Fgoto_char (location);
317 Fset_marker (location, Qnil, Qnil);
318 return Qnil;
321 Lisp_Object Qexpand_file_name;
322 Lisp_Object Qsubstitute_in_file_name;
323 Lisp_Object Qdirectory_file_name;
324 Lisp_Object Qfile_name_directory;
325 Lisp_Object Qfile_name_nondirectory;
326 Lisp_Object Qunhandled_file_name_directory;
327 Lisp_Object Qfile_name_as_directory;
328 Lisp_Object Qcopy_file;
329 Lisp_Object Qmake_directory_internal;
330 Lisp_Object Qmake_directory;
331 Lisp_Object Qdelete_directory;
332 Lisp_Object Qdelete_file;
333 Lisp_Object Qrename_file;
334 Lisp_Object Qadd_name_to_file;
335 Lisp_Object Qmake_symbolic_link;
336 Lisp_Object Qfile_exists_p;
337 Lisp_Object Qfile_executable_p;
338 Lisp_Object Qfile_readable_p;
339 Lisp_Object Qfile_writable_p;
340 Lisp_Object Qfile_symlink_p;
341 Lisp_Object Qaccess_file;
342 Lisp_Object Qfile_directory_p;
343 Lisp_Object Qfile_regular_p;
344 Lisp_Object Qfile_accessible_directory_p;
345 Lisp_Object Qfile_modes;
346 Lisp_Object Qset_file_modes;
347 Lisp_Object Qset_file_times;
348 Lisp_Object Qfile_newer_than_file_p;
349 Lisp_Object Qinsert_file_contents;
350 Lisp_Object Qwrite_region;
351 Lisp_Object Qverify_visited_file_modtime;
352 Lisp_Object Qset_visited_file_modtime;
354 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
355 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
356 Otherwise, return nil.
357 A file name is handled if one of the regular expressions in
358 `file-name-handler-alist' matches it.
360 If OPERATION equals `inhibit-file-name-operation', then we ignore
361 any handlers that are members of `inhibit-file-name-handlers',
362 but we still do run any other handlers. This lets handlers
363 use the standard functions without calling themselves recursively. */)
364 (filename, operation)
365 Lisp_Object filename, operation;
367 /* This function must not munge the match data. */
368 Lisp_Object chain, inhibited_handlers, result;
369 int pos = -1;
371 result = Qnil;
372 CHECK_STRING (filename);
374 if (EQ (operation, Vinhibit_file_name_operation))
375 inhibited_handlers = Vinhibit_file_name_handlers;
376 else
377 inhibited_handlers = Qnil;
379 for (chain = Vfile_name_handler_alist; CONSP (chain);
380 chain = XCDR (chain))
382 Lisp_Object elt;
383 elt = XCAR (chain);
384 if (CONSP (elt))
386 Lisp_Object string = XCAR (elt);
387 int match_pos;
388 Lisp_Object handler = XCDR (elt);
389 Lisp_Object operations = Qnil;
391 if (SYMBOLP (handler))
392 operations = Fget (handler, Qoperations);
394 if (STRINGP (string)
395 && (match_pos = fast_string_match (string, filename)) > pos
396 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
398 Lisp_Object tem;
400 handler = XCDR (elt);
401 tem = Fmemq (handler, inhibited_handlers);
402 if (NILP (tem))
404 result = handler;
405 pos = match_pos;
410 QUIT;
412 return result;
415 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
416 1, 1, 0,
417 doc: /* Return the directory component in file name FILENAME.
418 Return nil if FILENAME does not include a directory.
419 Otherwise return a directory name.
420 Given a Unix syntax file name, returns a string ending in slash;
421 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
422 (filename)
423 Lisp_Object filename;
425 #ifndef DOS_NT
426 register const unsigned char *beg;
427 #else
428 register unsigned char *beg;
429 #endif
430 register const unsigned char *p;
431 Lisp_Object handler;
433 CHECK_STRING (filename);
435 /* If the file name has special constructs in it,
436 call the corresponding file handler. */
437 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
438 if (!NILP (handler))
439 return call2 (handler, Qfile_name_directory, filename);
441 filename = FILE_SYSTEM_CASE (filename);
442 beg = SDATA (filename);
443 #ifdef DOS_NT
444 beg = strcpy (alloca (strlen (beg) + 1), beg);
445 #endif
446 p = beg + SBYTES (filename);
448 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
449 #ifdef VMS
450 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
451 #endif /* VMS */
452 #ifdef DOS_NT
453 /* only recognise drive specifier at the beginning */
454 && !(p[-1] == ':'
455 /* handle the "/:d:foo" and "/:foo" cases correctly */
456 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
457 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
458 #endif
459 ) p--;
461 if (p == beg)
462 return Qnil;
463 #ifdef DOS_NT
464 /* Expansion of "c:" to drive and default directory. */
465 if (p[-1] == ':')
467 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
468 unsigned char *res = alloca (MAXPATHLEN + 1);
469 unsigned char *r = res;
471 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
473 strncpy (res, beg, 2);
474 beg += 2;
475 r += 2;
478 if (getdefdir (toupper (*beg) - 'A' + 1, r))
480 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
481 strcat (res, "/");
482 beg = res;
483 p = beg + strlen (beg);
486 CORRECT_DIR_SEPS (beg);
487 #endif /* DOS_NT */
489 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
492 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
493 Sfile_name_nondirectory, 1, 1, 0,
494 doc: /* Return file name FILENAME sans its directory.
495 For example, in a Unix-syntax file name,
496 this is everything after the last slash,
497 or the entire name if it contains no slash. */)
498 (filename)
499 Lisp_Object filename;
501 register const unsigned char *beg, *p, *end;
502 Lisp_Object handler;
504 CHECK_STRING (filename);
506 /* If the file name has special constructs in it,
507 call the corresponding file handler. */
508 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
509 if (!NILP (handler))
510 return call2 (handler, Qfile_name_nondirectory, filename);
512 beg = SDATA (filename);
513 end = p = beg + SBYTES (filename);
515 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
516 #ifdef VMS
517 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
518 #endif /* VMS */
519 #ifdef DOS_NT
520 /* only recognise drive specifier at beginning */
521 && !(p[-1] == ':'
522 /* handle the "/:d:foo" case correctly */
523 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
524 #endif
526 p--;
528 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
531 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
532 Sunhandled_file_name_directory, 1, 1, 0,
533 doc: /* Return a directly usable directory name somehow associated with FILENAME.
534 A `directly usable' directory name is one that may be used without the
535 intervention of any file handler.
536 If FILENAME is a directly usable file itself, return
537 \(file-name-directory FILENAME).
538 The `call-process' and `start-process' functions use this function to
539 get a current directory to run processes in. */)
540 (filename)
541 Lisp_Object filename;
543 Lisp_Object handler;
545 /* If the file name has special constructs in it,
546 call the corresponding file handler. */
547 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
548 if (!NILP (handler))
549 return call2 (handler, Qunhandled_file_name_directory, filename);
551 return Ffile_name_directory (filename);
555 char *
556 file_name_as_directory (out, in)
557 char *out, *in;
559 int size = strlen (in) - 1;
561 strcpy (out, in);
563 if (size < 0)
565 out[0] = '.';
566 out[1] = '/';
567 out[2] = 0;
568 return out;
571 #ifdef VMS
572 /* Is it already a directory string? */
573 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
574 return out;
575 /* Is it a VMS directory file name? If so, hack VMS syntax. */
576 else if (! index (in, '/')
577 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
578 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
579 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
580 || ! strncmp (&in[size - 5], ".dir", 4))
581 && (in[size - 1] == '.' || in[size - 1] == ';')
582 && in[size] == '1')))
584 register char *p, *dot;
585 char brack;
587 /* x.dir -> [.x]
588 dir:x.dir --> dir:[x]
589 dir:[x]y.dir --> dir:[x.y] */
590 p = in + size;
591 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
592 if (p != in)
594 strncpy (out, in, p - in);
595 out[p - in] = '\0';
596 if (*p == ':')
598 brack = ']';
599 strcat (out, ":[");
601 else
603 brack = *p;
604 strcat (out, ".");
606 p++;
608 else
610 brack = ']';
611 strcpy (out, "[.");
613 dot = index (p, '.');
614 if (dot)
616 /* blindly remove any extension */
617 size = strlen (out) + (dot - p);
618 strncat (out, p, dot - p);
620 else
622 strcat (out, p);
623 size = strlen (out);
625 out[size++] = brack;
626 out[size] = '\0';
628 #else /* not VMS */
629 /* For Unix syntax, Append a slash if necessary */
630 if (!IS_DIRECTORY_SEP (out[size]))
632 /* Cannot use DIRECTORY_SEP, which could have any value */
633 out[size + 1] = '/';
634 out[size + 2] = '\0';
636 #ifdef DOS_NT
637 CORRECT_DIR_SEPS (out);
638 #endif
639 #endif /* not VMS */
640 return out;
643 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
644 Sfile_name_as_directory, 1, 1, 0,
645 doc: /* Return a string representing the file name FILE interpreted as a directory.
646 This operation exists because a directory is also a file, but its name as
647 a directory is different from its name as a file.
648 The result can be used as the value of `default-directory'
649 or passed as second argument to `expand-file-name'.
650 For a Unix-syntax file name, just appends a slash.
651 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
652 (file)
653 Lisp_Object file;
655 char *buf;
656 Lisp_Object handler;
658 CHECK_STRING (file);
659 if (NILP (file))
660 return Qnil;
662 /* If the file name has special constructs in it,
663 call the corresponding file handler. */
664 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
665 if (!NILP (handler))
666 return call2 (handler, Qfile_name_as_directory, file);
668 buf = (char *) alloca (SBYTES (file) + 10);
669 file_name_as_directory (buf, SDATA (file));
670 return make_specified_string (buf, -1, strlen (buf),
671 STRING_MULTIBYTE (file));
675 * Convert from directory name to filename.
676 * On VMS:
677 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
678 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
679 * On UNIX, it's simple: just make sure there isn't a terminating /
681 * Value is nonzero if the string output is different from the input.
685 directory_file_name (src, dst)
686 char *src, *dst;
688 long slen;
689 #ifdef VMS
690 long rlen;
691 char * ptr, * rptr;
692 char bracket;
693 struct FAB fab = cc$rms_fab;
694 struct NAM nam = cc$rms_nam;
695 char esa[NAM$C_MAXRSS];
696 #endif /* VMS */
698 slen = strlen (src);
699 #ifdef VMS
700 if (! index (src, '/')
701 && (src[slen - 1] == ']'
702 || src[slen - 1] == ':'
703 || src[slen - 1] == '>'))
705 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
706 fab.fab$l_fna = src;
707 fab.fab$b_fns = slen;
708 fab.fab$l_nam = &nam;
709 fab.fab$l_fop = FAB$M_NAM;
711 nam.nam$l_esa = esa;
712 nam.nam$b_ess = sizeof esa;
713 nam.nam$b_nop |= NAM$M_SYNCHK;
715 /* We call SYS$PARSE to handle such things as [--] for us. */
716 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
718 slen = nam.nam$b_esl;
719 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
720 slen -= 2;
721 esa[slen] = '\0';
722 src = esa;
724 if (src[slen - 1] != ']' && src[slen - 1] != '>')
726 /* what about when we have logical_name:???? */
727 if (src[slen - 1] == ':')
728 { /* Xlate logical name and see what we get */
729 ptr = strcpy (dst, src); /* upper case for getenv */
730 while (*ptr)
732 if ('a' <= *ptr && *ptr <= 'z')
733 *ptr -= 040;
734 ptr++;
736 dst[slen - 1] = 0; /* remove colon */
737 if (!(src = egetenv (dst)))
738 return 0;
739 /* should we jump to the beginning of this procedure?
740 Good points: allows us to use logical names that xlate
741 to Unix names,
742 Bad points: can be a problem if we just translated to a device
743 name...
744 For now, I'll punt and always expect VMS names, and hope for
745 the best! */
746 slen = strlen (src);
747 if (src[slen - 1] != ']' && src[slen - 1] != '>')
748 { /* no recursion here! */
749 strcpy (dst, src);
750 return 0;
753 else
754 { /* not a directory spec */
755 strcpy (dst, src);
756 return 0;
759 bracket = src[slen - 1];
761 /* If bracket is ']' or '>', bracket - 2 is the corresponding
762 opening bracket. */
763 ptr = index (src, bracket - 2);
764 if (ptr == 0)
765 { /* no opening bracket */
766 strcpy (dst, src);
767 return 0;
769 if (!(rptr = rindex (src, '.')))
770 rptr = ptr;
771 slen = rptr - src;
772 strncpy (dst, src, slen);
773 dst[slen] = '\0';
774 if (*rptr == '.')
776 dst[slen++] = bracket;
777 dst[slen] = '\0';
779 else
781 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
782 then translate the device and recurse. */
783 if (dst[slen - 1] == ':'
784 && dst[slen - 2] != ':' /* skip decnet nodes */
785 && strcmp (src + slen, "[000000]") == 0)
787 dst[slen - 1] = '\0';
788 if ((ptr = egetenv (dst))
789 && (rlen = strlen (ptr) - 1) > 0
790 && (ptr[rlen] == ']' || ptr[rlen] == '>')
791 && ptr[rlen - 1] == '.')
793 char * buf = (char *) alloca (strlen (ptr) + 1);
794 strcpy (buf, ptr);
795 buf[rlen - 1] = ']';
796 buf[rlen] = '\0';
797 return directory_file_name (buf, dst);
799 else
800 dst[slen - 1] = ':';
802 strcat (dst, "[000000]");
803 slen += 8;
805 rptr++;
806 rlen = strlen (rptr) - 1;
807 strncat (dst, rptr, rlen);
808 dst[slen + rlen] = '\0';
809 strcat (dst, ".DIR.1");
810 return 1;
812 #endif /* VMS */
813 /* Process as Unix format: just remove any final slash.
814 But leave "/" unchanged; do not change it to "". */
815 strcpy (dst, src);
816 #ifdef APOLLO
817 /* Handle // as root for apollo's. */
818 if ((slen > 2 && dst[slen - 1] == '/')
819 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
820 dst[slen - 1] = 0;
821 #else
822 if (slen > 1
823 && IS_DIRECTORY_SEP (dst[slen - 1])
824 #ifdef DOS_NT
825 && !IS_ANY_SEP (dst[slen - 2])
826 #endif
828 dst[slen - 1] = 0;
829 #endif
830 #ifdef DOS_NT
831 CORRECT_DIR_SEPS (dst);
832 #endif
833 return 1;
836 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
837 1, 1, 0,
838 doc: /* Returns the file name of the directory named DIRECTORY.
839 This is the name of the file that holds the data for the directory DIRECTORY.
840 This operation exists because a directory is also a file, but its name as
841 a directory is different from its name as a file.
842 In Unix-syntax, this function just removes the final slash.
843 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
844 it returns a file name such as \"[X]Y.DIR.1\". */)
845 (directory)
846 Lisp_Object directory;
848 char *buf;
849 Lisp_Object handler;
851 CHECK_STRING (directory);
853 if (NILP (directory))
854 return Qnil;
856 /* If the file name has special constructs in it,
857 call the corresponding file handler. */
858 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
859 if (!NILP (handler))
860 return call2 (handler, Qdirectory_file_name, directory);
862 #ifdef VMS
863 /* 20 extra chars is insufficient for VMS, since we might perform a
864 logical name translation. an equivalence string can be up to 255
865 chars long, so grab that much extra space... - sss */
866 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
867 #else
868 buf = (char *) alloca (SBYTES (directory) + 20);
869 #endif
870 directory_file_name (SDATA (directory), buf);
871 return make_specified_string (buf, -1, strlen (buf),
872 STRING_MULTIBYTE (directory));
875 static char make_temp_name_tbl[64] =
877 'A','B','C','D','E','F','G','H',
878 'I','J','K','L','M','N','O','P',
879 'Q','R','S','T','U','V','W','X',
880 'Y','Z','a','b','c','d','e','f',
881 'g','h','i','j','k','l','m','n',
882 'o','p','q','r','s','t','u','v',
883 'w','x','y','z','0','1','2','3',
884 '4','5','6','7','8','9','-','_'
887 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
889 /* Value is a temporary file name starting with PREFIX, a string.
891 The Emacs process number forms part of the result, so there is
892 no danger of generating a name being used by another process.
893 In addition, this function makes an attempt to choose a name
894 which has no existing file. To make this work, PREFIX should be
895 an absolute file name.
897 BASE64_P non-zero means add the pid as 3 characters in base64
898 encoding. In this case, 6 characters will be added to PREFIX to
899 form the file name. Otherwise, if Emacs is running on a system
900 with long file names, add the pid as a decimal number.
902 This function signals an error if no unique file name could be
903 generated. */
905 Lisp_Object
906 make_temp_name (prefix, base64_p)
907 Lisp_Object prefix;
908 int base64_p;
910 Lisp_Object val;
911 int len, clen;
912 int pid;
913 unsigned char *p, *data;
914 char pidbuf[20];
915 int pidlen;
917 CHECK_STRING (prefix);
919 /* VAL is created by adding 6 characters to PREFIX. The first
920 three are the PID of this process, in base 64, and the second
921 three are incremented if the file already exists. This ensures
922 262144 unique file names per PID per PREFIX. */
924 pid = (int) getpid ();
926 if (base64_p)
928 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
929 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
930 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
931 pidlen = 3;
933 else
935 #ifdef HAVE_LONG_FILE_NAMES
936 sprintf (pidbuf, "%d", pid);
937 pidlen = strlen (pidbuf);
938 #else
939 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
940 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
941 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
942 pidlen = 3;
943 #endif
946 len = SBYTES (prefix); clen = SCHARS (prefix);
947 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
948 if (!STRING_MULTIBYTE (prefix))
949 STRING_SET_UNIBYTE (val);
950 data = SDATA (val);
951 bcopy(SDATA (prefix), data, len);
952 p = data + len;
954 bcopy (pidbuf, p, pidlen);
955 p += pidlen;
957 /* Here we try to minimize useless stat'ing when this function is
958 invoked many times successively with the same PREFIX. We achieve
959 this by initializing count to a random value, and incrementing it
960 afterwards.
962 We don't want make-temp-name to be called while dumping,
963 because then make_temp_name_count_initialized_p would get set
964 and then make_temp_name_count would not be set when Emacs starts. */
966 if (!make_temp_name_count_initialized_p)
968 make_temp_name_count = (unsigned) time (NULL);
969 make_temp_name_count_initialized_p = 1;
972 while (1)
974 struct stat ignored;
975 unsigned num = make_temp_name_count;
977 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
978 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
979 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
981 /* Poor man's congruential RN generator. Replace with
982 ++make_temp_name_count for debugging. */
983 make_temp_name_count += 25229;
984 make_temp_name_count %= 225307;
986 if (stat (data, &ignored) < 0)
988 /* We want to return only if errno is ENOENT. */
989 if (errno == ENOENT)
990 return val;
991 else
992 /* The error here is dubious, but there is little else we
993 can do. The alternatives are to return nil, which is
994 as bad as (and in many cases worse than) throwing the
995 error, or to ignore the error, which will likely result
996 in looping through 225307 stat's, which is not only
997 dog-slow, but also useless since it will fallback to
998 the errow below, anyway. */
999 report_file_error ("Cannot create temporary name for prefix",
1000 Fcons (prefix, Qnil));
1001 /* not reached */
1005 error ("Cannot create temporary name for prefix `%s'",
1006 SDATA (prefix));
1007 return Qnil;
1011 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1012 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1013 The Emacs process number forms part of the result,
1014 so there is no danger of generating a name being used by another process.
1016 In addition, this function makes an attempt to choose a name
1017 which has no existing file. To make this work,
1018 PREFIX should be an absolute file name.
1020 There is a race condition between calling `make-temp-name' and creating the
1021 file which opens all kinds of security holes. For that reason, you should
1022 probably use `make-temp-file' instead, except in three circumstances:
1024 * If you are creating the file in the user's home directory.
1025 * If you are creating a directory rather than an ordinary file.
1026 * If you are taking special precautions as `make-temp-file' does. */)
1027 (prefix)
1028 Lisp_Object prefix;
1030 return make_temp_name (prefix, 0);
1035 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1036 doc: /* Convert filename NAME to absolute, and canonicalize it.
1037 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1038 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
1039 the current buffer's value of `default-directory' is used.
1040 File name components that are `.' are removed, and
1041 so are file name components followed by `..', along with the `..' itself;
1042 note that these simplifications are done without checking the resulting
1043 file names in the file system.
1044 An initial `~/' expands to your home directory.
1045 An initial `~USER/' expands to USER's home directory.
1046 See also the function `substitute-in-file-name'. */)
1047 (name, default_directory)
1048 Lisp_Object name, default_directory;
1050 unsigned char *nm;
1052 register unsigned char *newdir, *p, *o;
1053 int tlen;
1054 unsigned char *target;
1055 struct passwd *pw;
1056 #ifdef VMS
1057 unsigned char * colon = 0;
1058 unsigned char * close = 0;
1059 unsigned char * slash = 0;
1060 unsigned char * brack = 0;
1061 int lbrack = 0, rbrack = 0;
1062 int dots = 0;
1063 #endif /* VMS */
1064 #ifdef DOS_NT
1065 int drive = 0;
1066 int collapse_newdir = 1;
1067 int is_escaped = 0;
1068 #endif /* DOS_NT */
1069 int length;
1070 Lisp_Object handler, result;
1071 int multibyte;
1072 Lisp_Object hdir;
1074 CHECK_STRING (name);
1076 /* If the file name has special constructs in it,
1077 call the corresponding file handler. */
1078 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1079 if (!NILP (handler))
1080 return call3 (handler, Qexpand_file_name, name, default_directory);
1082 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1083 if (NILP (default_directory))
1084 default_directory = current_buffer->directory;
1085 if (! STRINGP (default_directory))
1087 #ifdef DOS_NT
1088 /* "/" is not considered a root directory on DOS_NT, so using "/"
1089 here causes an infinite recursion in, e.g., the following:
1091 (let (default-directory)
1092 (expand-file-name "a"))
1094 To avoid this, we set default_directory to the root of the
1095 current drive. */
1096 extern char *emacs_root_dir (void);
1098 default_directory = build_string (emacs_root_dir ());
1099 #else
1100 default_directory = build_string ("/");
1101 #endif
1104 if (!NILP (default_directory))
1106 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1107 if (!NILP (handler))
1108 return call3 (handler, Qexpand_file_name, name, default_directory);
1111 o = SDATA (default_directory);
1113 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1114 It would be better to do this down below where we actually use
1115 default_directory. Unfortunately, calling Fexpand_file_name recursively
1116 could invoke GC, and the strings might be relocated. This would
1117 be annoying because we have pointers into strings lying around
1118 that would need adjusting, and people would add new pointers to
1119 the code and forget to adjust them, resulting in intermittent bugs.
1120 Putting this call here avoids all that crud.
1122 The EQ test avoids infinite recursion. */
1123 if (! NILP (default_directory) && !EQ (default_directory, name)
1124 /* Save time in some common cases - as long as default_directory
1125 is not relative, it can be canonicalized with name below (if it
1126 is needed at all) without requiring it to be expanded now. */
1127 #ifdef DOS_NT
1128 /* Detect MSDOS file names with drive specifiers. */
1129 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1130 #ifdef WINDOWSNT
1131 /* Detect Windows file names in UNC format. */
1132 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1133 #endif
1134 #else /* not DOS_NT */
1135 /* Detect Unix absolute file names (/... alone is not absolute on
1136 DOS or Windows). */
1137 && ! (IS_DIRECTORY_SEP (o[0]))
1138 #endif /* not DOS_NT */
1141 struct gcpro gcpro1;
1143 GCPRO1 (name);
1144 default_directory = Fexpand_file_name (default_directory, Qnil);
1145 UNGCPRO;
1148 name = FILE_SYSTEM_CASE (name);
1149 nm = SDATA (name);
1150 multibyte = STRING_MULTIBYTE (name);
1152 #ifdef DOS_NT
1153 /* We will force directory separators to be either all \ or /, so make
1154 a local copy to modify, even if there ends up being no change. */
1155 nm = strcpy (alloca (strlen (nm) + 1), nm);
1157 /* Note if special escape prefix is present, but remove for now. */
1158 if (nm[0] == '/' && nm[1] == ':')
1160 is_escaped = 1;
1161 nm += 2;
1164 /* Find and remove drive specifier if present; this makes nm absolute
1165 even if the rest of the name appears to be relative. Only look for
1166 drive specifier at the beginning. */
1167 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1169 drive = nm[0];
1170 nm += 2;
1173 #ifdef WINDOWSNT
1174 /* If we see "c://somedir", we want to strip the first slash after the
1175 colon when stripping the drive letter. Otherwise, this expands to
1176 "//somedir". */
1177 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1178 nm++;
1179 #endif /* WINDOWSNT */
1180 #endif /* DOS_NT */
1182 #ifdef WINDOWSNT
1183 /* Discard any previous drive specifier if nm is now in UNC format. */
1184 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1186 drive = 0;
1188 #endif
1190 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1191 none are found, we can probably return right away. We will avoid
1192 allocating a new string if name is already fully expanded. */
1193 if (
1194 IS_DIRECTORY_SEP (nm[0])
1195 #ifdef MSDOS
1196 && drive && !is_escaped
1197 #endif
1198 #ifdef WINDOWSNT
1199 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1200 #endif
1201 #ifdef VMS
1202 || index (nm, ':')
1203 #endif /* VMS */
1206 /* If it turns out that the filename we want to return is just a
1207 suffix of FILENAME, we don't need to go through and edit
1208 things; we just need to construct a new string using data
1209 starting at the middle of FILENAME. If we set lose to a
1210 non-zero value, that means we've discovered that we can't do
1211 that cool trick. */
1212 int lose = 0;
1214 p = nm;
1215 while (*p)
1217 /* Since we know the name is absolute, we can assume that each
1218 element starts with a "/". */
1220 /* "." and ".." are hairy. */
1221 if (IS_DIRECTORY_SEP (p[0])
1222 && p[1] == '.'
1223 && (IS_DIRECTORY_SEP (p[2])
1224 || p[2] == 0
1225 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1226 || p[3] == 0))))
1227 lose = 1;
1228 /* We want to replace multiple `/' in a row with a single
1229 slash. */
1230 else if (p > nm
1231 && IS_DIRECTORY_SEP (p[0])
1232 && IS_DIRECTORY_SEP (p[1]))
1233 lose = 1;
1235 #ifdef VMS
1236 if (p[0] == '\\')
1237 lose = 1;
1238 if (p[0] == '/') {
1239 /* if dev:[dir]/, move nm to / */
1240 if (!slash && p > nm && (brack || colon)) {
1241 nm = (brack ? brack + 1 : colon + 1);
1242 lbrack = rbrack = 0;
1243 brack = 0;
1244 colon = 0;
1246 slash = p;
1248 if (p[0] == '-')
1249 #ifdef NO_HYPHENS_IN_FILENAMES
1250 if (lbrack == rbrack)
1252 /* Avoid clobbering negative version numbers. */
1253 if (dots < 2)
1254 p[0] = '_';
1256 else
1257 #endif /* NO_HYPHENS_IN_FILENAMES */
1258 if (lbrack > rbrack
1259 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1260 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1261 lose = 1;
1262 #ifdef NO_HYPHENS_IN_FILENAMES
1263 else
1264 p[0] = '_';
1265 #endif /* NO_HYPHENS_IN_FILENAMES */
1266 /* count open brackets, reset close bracket pointer */
1267 if (p[0] == '[' || p[0] == '<')
1268 lbrack++, brack = 0;
1269 /* count close brackets, set close bracket pointer */
1270 if (p[0] == ']' || p[0] == '>')
1271 rbrack++, brack = p;
1272 /* detect ][ or >< */
1273 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1274 lose = 1;
1275 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1276 nm = p + 1, lose = 1;
1277 if (p[0] == ':' && (colon || slash))
1278 /* if dev1:[dir]dev2:, move nm to dev2: */
1279 if (brack)
1281 nm = brack + 1;
1282 brack = 0;
1284 /* if /name/dev:, move nm to dev: */
1285 else if (slash)
1286 nm = slash + 1;
1287 /* if node::dev:, move colon following dev */
1288 else if (colon && colon[-1] == ':')
1289 colon = p;
1290 /* if dev1:dev2:, move nm to dev2: */
1291 else if (colon && colon[-1] != ':')
1293 nm = colon + 1;
1294 colon = 0;
1296 if (p[0] == ':' && !colon)
1298 if (p[1] == ':')
1299 p++;
1300 colon = p;
1302 if (lbrack == rbrack)
1303 if (p[0] == ';')
1304 dots = 2;
1305 else if (p[0] == '.')
1306 dots++;
1307 #endif /* VMS */
1308 p++;
1310 if (!lose)
1312 #ifdef VMS
1313 if (index (nm, '/'))
1315 nm = sys_translate_unix (nm);
1316 return make_specified_string (nm, -1, strlen (nm), multibyte);
1318 #endif /* VMS */
1319 #ifdef DOS_NT
1320 /* Make sure directories are all separated with / or \ as
1321 desired, but avoid allocation of a new string when not
1322 required. */
1323 CORRECT_DIR_SEPS (nm);
1324 #ifdef WINDOWSNT
1325 if (IS_DIRECTORY_SEP (nm[1]))
1327 if (strcmp (nm, SDATA (name)) != 0)
1328 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1330 else
1331 #endif
1332 /* drive must be set, so this is okay */
1333 if (strcmp (nm - 2, SDATA (name)) != 0)
1335 char temp[] = " :";
1337 name = make_specified_string (nm, -1, p - nm, multibyte);
1338 temp[0] = DRIVE_LETTER (drive);
1339 name = concat2 (build_string (temp), name);
1341 return name;
1342 #else /* not DOS_NT */
1343 if (nm == SDATA (name))
1344 return name;
1345 return make_specified_string (nm, -1, strlen (nm), multibyte);
1346 #endif /* not DOS_NT */
1350 /* At this point, nm might or might not be an absolute file name. We
1351 need to expand ~ or ~user if present, otherwise prefix nm with
1352 default_directory if nm is not absolute, and finally collapse /./
1353 and /foo/../ sequences.
1355 We set newdir to be the appropriate prefix if one is needed:
1356 - the relevant user directory if nm starts with ~ or ~user
1357 - the specified drive's working dir (DOS/NT only) if nm does not
1358 start with /
1359 - the value of default_directory.
1361 Note that these prefixes are not guaranteed to be absolute (except
1362 for the working dir of a drive). Therefore, to ensure we always
1363 return an absolute name, if the final prefix is not absolute we
1364 append it to the current working directory. */
1366 newdir = 0;
1368 if (nm[0] == '~') /* prefix ~ */
1370 if (IS_DIRECTORY_SEP (nm[1])
1371 #ifdef VMS
1372 || nm[1] == ':'
1373 #endif /* VMS */
1374 || nm[1] == 0) /* ~ by itself */
1376 Lisp_Object tem;
1378 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1379 newdir = (unsigned char *) "";
1380 nm++;
1381 /* egetenv may return a unibyte string, which will bite us since
1382 we expect the directory to be multibyte. */
1383 tem = build_string (newdir);
1384 if (!STRING_MULTIBYTE (tem))
1386 hdir = DECODE_FILE (tem);
1387 newdir = SDATA (hdir);
1389 #ifdef DOS_NT
1390 collapse_newdir = 0;
1391 #endif
1392 #ifdef VMS
1393 nm++; /* Don't leave the slash in nm. */
1394 #endif /* VMS */
1396 else /* ~user/filename */
1398 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1399 #ifdef VMS
1400 && *p != ':'
1401 #endif /* VMS */
1402 ); p++);
1403 o = (unsigned char *) alloca (p - nm + 1);
1404 bcopy ((char *) nm, o, p - nm);
1405 o [p - nm] = 0;
1407 BLOCK_INPUT;
1408 pw = (struct passwd *) getpwnam (o + 1);
1409 UNBLOCK_INPUT;
1410 if (pw)
1412 newdir = (unsigned char *) pw -> pw_dir;
1413 #ifdef VMS
1414 nm = p + 1; /* skip the terminator */
1415 #else
1416 nm = p;
1417 #ifdef DOS_NT
1418 collapse_newdir = 0;
1419 #endif
1420 #endif /* VMS */
1423 /* If we don't find a user of that name, leave the name
1424 unchanged; don't move nm forward to p. */
1428 #ifdef DOS_NT
1429 /* On DOS and Windows, nm is absolute if a drive name was specified;
1430 use the drive's current directory as the prefix if needed. */
1431 if (!newdir && drive)
1433 /* Get default directory if needed to make nm absolute. */
1434 if (!IS_DIRECTORY_SEP (nm[0]))
1436 newdir = alloca (MAXPATHLEN + 1);
1437 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1438 newdir = NULL;
1440 if (!newdir)
1442 /* Either nm starts with /, or drive isn't mounted. */
1443 newdir = alloca (4);
1444 newdir[0] = DRIVE_LETTER (drive);
1445 newdir[1] = ':';
1446 newdir[2] = '/';
1447 newdir[3] = 0;
1450 #endif /* DOS_NT */
1452 /* Finally, if no prefix has been specified and nm is not absolute,
1453 then it must be expanded relative to default_directory. */
1455 if (1
1456 #ifndef DOS_NT
1457 /* /... alone is not absolute on DOS and Windows. */
1458 && !IS_DIRECTORY_SEP (nm[0])
1459 #endif
1460 #ifdef WINDOWSNT
1461 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1462 #endif
1463 #ifdef VMS
1464 && !index (nm, ':')
1465 #endif
1466 && !newdir)
1468 newdir = SDATA (default_directory);
1469 multibyte |= STRING_MULTIBYTE (default_directory);
1470 #ifdef DOS_NT
1471 /* Note if special escape prefix is present, but remove for now. */
1472 if (newdir[0] == '/' && newdir[1] == ':')
1474 is_escaped = 1;
1475 newdir += 2;
1477 #endif
1480 #ifdef DOS_NT
1481 if (newdir)
1483 /* First ensure newdir is an absolute name. */
1484 if (
1485 /* Detect MSDOS file names with drive specifiers. */
1486 ! (IS_DRIVE (newdir[0])
1487 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1488 #ifdef WINDOWSNT
1489 /* Detect Windows file names in UNC format. */
1490 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1491 #endif
1494 /* Effectively, let newdir be (expand-file-name newdir cwd).
1495 Because of the admonition against calling expand-file-name
1496 when we have pointers into lisp strings, we accomplish this
1497 indirectly by prepending newdir to nm if necessary, and using
1498 cwd (or the wd of newdir's drive) as the new newdir. */
1500 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1502 drive = newdir[0];
1503 newdir += 2;
1505 if (!IS_DIRECTORY_SEP (nm[0]))
1507 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1508 file_name_as_directory (tmp, newdir);
1509 strcat (tmp, nm);
1510 nm = tmp;
1512 newdir = alloca (MAXPATHLEN + 1);
1513 if (drive)
1515 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1516 newdir = "/";
1518 else
1519 getwd (newdir);
1522 /* Strip off drive name from prefix, if present. */
1523 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1525 drive = newdir[0];
1526 newdir += 2;
1529 /* Keep only a prefix from newdir if nm starts with slash
1530 (//server/share for UNC, nothing otherwise). */
1531 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1533 #ifdef WINDOWSNT
1534 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1536 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1537 p = newdir + 2;
1538 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1539 p++;
1540 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1541 *p = 0;
1543 else
1544 #endif
1545 newdir = "";
1548 #endif /* DOS_NT */
1550 if (newdir)
1552 /* Get rid of any slash at the end of newdir, unless newdir is
1553 just / or // (an incomplete UNC name). */
1554 length = strlen (newdir);
1555 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1556 #ifdef WINDOWSNT
1557 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1558 #endif
1561 unsigned char *temp = (unsigned char *) alloca (length);
1562 bcopy (newdir, temp, length - 1);
1563 temp[length - 1] = 0;
1564 newdir = temp;
1566 tlen = length + 1;
1568 else
1569 tlen = 0;
1571 /* Now concatenate the directory and name to new space in the stack frame */
1572 tlen += strlen (nm) + 1;
1573 #ifdef DOS_NT
1574 /* Reserve space for drive specifier and escape prefix, since either
1575 or both may need to be inserted. (The Microsoft x86 compiler
1576 produces incorrect code if the following two lines are combined.) */
1577 target = (unsigned char *) alloca (tlen + 4);
1578 target += 4;
1579 #else /* not DOS_NT */
1580 target = (unsigned char *) alloca (tlen);
1581 #endif /* not DOS_NT */
1582 *target = 0;
1584 if (newdir)
1586 #ifndef VMS
1587 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1589 #ifdef DOS_NT
1590 /* If newdir is effectively "C:/", then the drive letter will have
1591 been stripped and newdir will be "/". Concatenating with an
1592 absolute directory in nm produces "//", which will then be
1593 incorrectly treated as a network share. Ignore newdir in
1594 this case (keeping the drive letter). */
1595 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1596 && newdir[1] == '\0'))
1597 #endif
1598 strcpy (target, newdir);
1600 else
1601 #endif
1602 file_name_as_directory (target, newdir);
1605 strcat (target, nm);
1606 #ifdef VMS
1607 if (index (target, '/'))
1608 strcpy (target, sys_translate_unix (target));
1609 #endif /* VMS */
1611 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1613 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1614 appear. */
1616 p = target;
1617 o = target;
1619 while (*p)
1621 #ifdef VMS
1622 if (*p != ']' && *p != '>' && *p != '-')
1624 if (*p == '\\')
1625 p++;
1626 *o++ = *p++;
1628 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1629 /* brackets are offset from each other by 2 */
1631 p += 2;
1632 if (*p != '.' && *p != '-' && o[-1] != '.')
1633 /* convert [foo][bar] to [bar] */
1634 while (o[-1] != '[' && o[-1] != '<')
1635 o--;
1636 else if (*p == '-' && *o != '.')
1637 *--p = '.';
1639 else if (p[0] == '-' && o[-1] == '.'
1640 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1641 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1644 o--;
1645 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1646 if (p[1] == '.') /* foo.-.bar ==> bar. */
1647 p += 2;
1648 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1649 p++, o--;
1650 /* else [foo.-] ==> [-] */
1652 else
1654 #ifdef NO_HYPHENS_IN_FILENAMES
1655 if (*p == '-'
1656 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
1657 && p[1] != ']' && p[1] != '>' && p[1] != '.')
1658 *p = '_';
1659 #endif /* NO_HYPHENS_IN_FILENAMES */
1660 *o++ = *p++;
1662 #else /* not VMS */
1663 if (!IS_DIRECTORY_SEP (*p))
1665 *o++ = *p++;
1667 else if (p[1] == '.'
1668 && (IS_DIRECTORY_SEP (p[2])
1669 || p[2] == 0))
1671 /* If "/." is the entire filename, keep the "/". Otherwise,
1672 just delete the whole "/.". */
1673 if (o == target && p[2] == '\0')
1674 *o++ = *p;
1675 p += 2;
1677 else if (p[1] == '.' && p[2] == '.'
1678 /* `/../' is the "superroot" on certain file systems.
1679 Turned off on DOS_NT systems because they have no
1680 "superroot" and because this causes us to produce
1681 file names like "d:/../foo" which fail file-related
1682 functions of the underlying OS. (To reproduce, try a
1683 long series of "../../" in default_directory, longer
1684 than the number of levels from the root.) */
1685 #ifndef DOS_NT
1686 && o != target
1687 #endif
1688 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1690 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1692 /* Keep initial / only if this is the whole name. */
1693 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1694 ++o;
1695 p += 3;
1697 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1698 /* Collapse multiple `/' in a row. */
1699 p++;
1700 else
1702 *o++ = *p++;
1704 #endif /* not VMS */
1707 #ifdef DOS_NT
1708 /* At last, set drive name. */
1709 #ifdef WINDOWSNT
1710 /* Except for network file name. */
1711 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1712 #endif /* WINDOWSNT */
1714 if (!drive) abort ();
1715 target -= 2;
1716 target[0] = DRIVE_LETTER (drive);
1717 target[1] = ':';
1719 /* Reinsert the escape prefix if required. */
1720 if (is_escaped)
1722 target -= 2;
1723 target[0] = '/';
1724 target[1] = ':';
1726 CORRECT_DIR_SEPS (target);
1727 #endif /* DOS_NT */
1729 result = make_specified_string (target, -1, o - target, multibyte);
1731 /* Again look to see if the file name has special constructs in it
1732 and perhaps call the corresponding file handler. This is needed
1733 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1734 the ".." component gives us "/user@host:/bar/../baz" which needs
1735 to be expanded again. */
1736 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1737 if (!NILP (handler))
1738 return call3 (handler, Qexpand_file_name, result, default_directory);
1740 return result;
1743 #if 0
1744 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1745 This is the old version of expand-file-name, before it was thoroughly
1746 rewritten for Emacs 10.31. We leave this version here commented-out,
1747 because the code is very complex and likely to have subtle bugs. If
1748 bugs _are_ found, it might be of interest to look at the old code and
1749 see what did it do in the relevant situation.
1751 Don't remove this code: it's true that it will be accessible via CVS,
1752 but a few years from deletion, people will forget it is there. */
1754 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1755 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1756 "Convert FILENAME to absolute, and canonicalize it.\n\
1757 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1758 \(does not start with slash); if DEFAULT is nil or missing,\n\
1759 the current buffer's value of default-directory is used.\n\
1760 Filenames containing `.' or `..' as components are simplified;\n\
1761 initial `~/' expands to your home directory.\n\
1762 See also the function `substitute-in-file-name'.")
1763 (name, defalt)
1764 Lisp_Object name, defalt;
1766 unsigned char *nm;
1768 register unsigned char *newdir, *p, *o;
1769 int tlen;
1770 unsigned char *target;
1771 struct passwd *pw;
1772 int lose;
1773 #ifdef VMS
1774 unsigned char * colon = 0;
1775 unsigned char * close = 0;
1776 unsigned char * slash = 0;
1777 unsigned char * brack = 0;
1778 int lbrack = 0, rbrack = 0;
1779 int dots = 0;
1780 #endif /* VMS */
1782 CHECK_STRING (name);
1784 #ifdef VMS
1785 /* Filenames on VMS are always upper case. */
1786 name = Fupcase (name);
1787 #endif
1789 nm = SDATA (name);
1791 /* If nm is absolute, flush ...// and detect /./ and /../.
1792 If no /./ or /../ we can return right away. */
1793 if (
1794 nm[0] == '/'
1795 #ifdef VMS
1796 || index (nm, ':')
1797 #endif /* VMS */
1800 p = nm;
1801 lose = 0;
1802 while (*p)
1804 if (p[0] == '/' && p[1] == '/'
1805 #ifdef APOLLO
1806 /* // at start of filename is meaningful on Apollo system. */
1807 && nm != p
1808 #endif /* APOLLO */
1810 nm = p + 1;
1811 if (p[0] == '/' && p[1] == '~')
1812 nm = p + 1, lose = 1;
1813 if (p[0] == '/' && p[1] == '.'
1814 && (p[2] == '/' || p[2] == 0
1815 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1816 lose = 1;
1817 #ifdef VMS
1818 if (p[0] == '\\')
1819 lose = 1;
1820 if (p[0] == '/') {
1821 /* if dev:[dir]/, move nm to / */
1822 if (!slash && p > nm && (brack || colon)) {
1823 nm = (brack ? brack + 1 : colon + 1);
1824 lbrack = rbrack = 0;
1825 brack = 0;
1826 colon = 0;
1828 slash = p;
1830 if (p[0] == '-')
1831 #ifndef VMS4_4
1832 /* VMS pre V4.4,convert '-'s in filenames. */
1833 if (lbrack == rbrack)
1835 if (dots < 2) /* this is to allow negative version numbers */
1836 p[0] = '_';
1838 else
1839 #endif /* VMS4_4 */
1840 if (lbrack > rbrack
1841 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1842 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1843 lose = 1;
1844 #ifndef VMS4_4
1845 else
1846 p[0] = '_';
1847 #endif /* VMS4_4 */
1848 /* count open brackets, reset close bracket pointer */
1849 if (p[0] == '[' || p[0] == '<')
1850 lbrack++, brack = 0;
1851 /* count close brackets, set close bracket pointer */
1852 if (p[0] == ']' || p[0] == '>')
1853 rbrack++, brack = p;
1854 /* detect ][ or >< */
1855 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1856 lose = 1;
1857 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1858 nm = p + 1, lose = 1;
1859 if (p[0] == ':' && (colon || slash))
1860 /* if dev1:[dir]dev2:, move nm to dev2: */
1861 if (brack)
1863 nm = brack + 1;
1864 brack = 0;
1866 /* If /name/dev:, move nm to dev: */
1867 else if (slash)
1868 nm = slash + 1;
1869 /* If node::dev:, move colon following dev */
1870 else if (colon && colon[-1] == ':')
1871 colon = p;
1872 /* If dev1:dev2:, move nm to dev2: */
1873 else if (colon && colon[-1] != ':')
1875 nm = colon + 1;
1876 colon = 0;
1878 if (p[0] == ':' && !colon)
1880 if (p[1] == ':')
1881 p++;
1882 colon = p;
1884 if (lbrack == rbrack)
1885 if (p[0] == ';')
1886 dots = 2;
1887 else if (p[0] == '.')
1888 dots++;
1889 #endif /* VMS */
1890 p++;
1892 if (!lose)
1894 #ifdef VMS
1895 if (index (nm, '/'))
1896 return build_string (sys_translate_unix (nm));
1897 #endif /* VMS */
1898 if (nm == SDATA (name))
1899 return name;
1900 return build_string (nm);
1904 /* Now determine directory to start with and put it in NEWDIR */
1906 newdir = 0;
1908 if (nm[0] == '~') /* prefix ~ */
1909 if (nm[1] == '/'
1910 #ifdef VMS
1911 || nm[1] == ':'
1912 #endif /* VMS */
1913 || nm[1] == 0)/* ~/filename */
1915 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1916 newdir = (unsigned char *) "";
1917 nm++;
1918 #ifdef VMS
1919 nm++; /* Don't leave the slash in nm. */
1920 #endif /* VMS */
1922 else /* ~user/filename */
1924 /* Get past ~ to user */
1925 unsigned char *user = nm + 1;
1926 /* Find end of name. */
1927 unsigned char *ptr = (unsigned char *) index (user, '/');
1928 int len = ptr ? ptr - user : strlen (user);
1929 #ifdef VMS
1930 unsigned char *ptr1 = index (user, ':');
1931 if (ptr1 != 0 && ptr1 - user < len)
1932 len = ptr1 - user;
1933 #endif /* VMS */
1934 /* Copy the user name into temp storage. */
1935 o = (unsigned char *) alloca (len + 1);
1936 bcopy ((char *) user, o, len);
1937 o[len] = 0;
1939 /* Look up the user name. */
1940 BLOCK_INPUT;
1941 pw = (struct passwd *) getpwnam (o + 1);
1942 UNBLOCK_INPUT;
1943 if (!pw)
1944 error ("\"%s\" isn't a registered user", o + 1);
1946 newdir = (unsigned char *) pw->pw_dir;
1948 /* Discard the user name from NM. */
1949 nm += len;
1952 if (nm[0] != '/'
1953 #ifdef VMS
1954 && !index (nm, ':')
1955 #endif /* not VMS */
1956 && !newdir)
1958 if (NILP (defalt))
1959 defalt = current_buffer->directory;
1960 CHECK_STRING (defalt);
1961 newdir = SDATA (defalt);
1964 /* Now concatenate the directory and name to new space in the stack frame */
1966 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1967 target = (unsigned char *) alloca (tlen);
1968 *target = 0;
1970 if (newdir)
1972 #ifndef VMS
1973 if (nm[0] == 0 || nm[0] == '/')
1974 strcpy (target, newdir);
1975 else
1976 #endif
1977 file_name_as_directory (target, newdir);
1980 strcat (target, nm);
1981 #ifdef VMS
1982 if (index (target, '/'))
1983 strcpy (target, sys_translate_unix (target));
1984 #endif /* VMS */
1986 /* Now canonicalize by removing /. and /foo/.. if they appear */
1988 p = target;
1989 o = target;
1991 while (*p)
1993 #ifdef VMS
1994 if (*p != ']' && *p != '>' && *p != '-')
1996 if (*p == '\\')
1997 p++;
1998 *o++ = *p++;
2000 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
2001 /* brackets are offset from each other by 2 */
2003 p += 2;
2004 if (*p != '.' && *p != '-' && o[-1] != '.')
2005 /* convert [foo][bar] to [bar] */
2006 while (o[-1] != '[' && o[-1] != '<')
2007 o--;
2008 else if (*p == '-' && *o != '.')
2009 *--p = '.';
2011 else if (p[0] == '-' && o[-1] == '.'
2012 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
2013 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2016 o--;
2017 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2018 if (p[1] == '.') /* foo.-.bar ==> bar. */
2019 p += 2;
2020 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2021 p++, o--;
2022 /* else [foo.-] ==> [-] */
2024 else
2026 #ifndef VMS4_4
2027 if (*p == '-'
2028 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
2029 && p[1] != ']' && p[1] != '>' && p[1] != '.')
2030 *p = '_';
2031 #endif /* VMS4_4 */
2032 *o++ = *p++;
2034 #else /* not VMS */
2035 if (*p != '/')
2037 *o++ = *p++;
2039 else if (!strncmp (p, "//", 2)
2040 #ifdef APOLLO
2041 /* // at start of filename is meaningful in Apollo system. */
2042 && o != target
2043 #endif /* APOLLO */
2046 o = target;
2047 p++;
2049 else if (p[0] == '/' && p[1] == '.'
2050 && (p[2] == '/' || p[2] == 0))
2051 p += 2;
2052 else if (!strncmp (p, "/..", 3)
2053 /* `/../' is the "superroot" on certain file systems. */
2054 && o != target
2055 && (p[3] == '/' || p[3] == 0))
2057 while (o != target && *--o != '/')
2059 #ifdef APOLLO
2060 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2061 ++o;
2062 else
2063 #endif /* APOLLO */
2064 if (o == target && *o == '/')
2065 ++o;
2066 p += 3;
2068 else
2070 *o++ = *p++;
2072 #endif /* not VMS */
2075 return make_string (target, o - target);
2077 #endif
2079 /* If /~ or // appears, discard everything through first slash. */
2080 static int
2081 file_name_absolute_p (filename)
2082 const unsigned char *filename;
2084 return
2085 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2086 #ifdef VMS
2087 /* ??? This criterion is probably wrong for '<'. */
2088 || index (filename, ':') || index (filename, '<')
2089 || (*filename == '[' && (filename[1] != '-'
2090 || (filename[2] != '.' && filename[2] != ']'))
2091 && filename[1] != '.')
2092 #endif /* VMS */
2093 #ifdef DOS_NT
2094 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2095 && IS_DIRECTORY_SEP (filename[2]))
2096 #endif
2100 static unsigned char *
2101 search_embedded_absfilename (nm, endp)
2102 unsigned char *nm, *endp;
2104 unsigned char *p, *s;
2106 for (p = nm + 1; p < endp; p++)
2108 if ((0
2109 #ifdef VMS
2110 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2111 #endif /* VMS */
2112 || IS_DIRECTORY_SEP (p[-1]))
2113 && file_name_absolute_p (p)
2114 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2115 /* // at start of file name is meaningful in Apollo,
2116 WindowsNT and Cygwin systems. */
2117 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2118 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2121 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2122 #ifdef VMS
2123 && *s != ':'
2124 #endif /* VMS */
2125 ); s++);
2126 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2128 unsigned char *o = alloca (s - p + 1);
2129 struct passwd *pw;
2130 bcopy (p, o, s - p);
2131 o [s - p] = 0;
2133 /* If we have ~user and `user' exists, discard
2134 everything up to ~. But if `user' does not exist, leave
2135 ~user alone, it might be a literal file name. */
2136 BLOCK_INPUT;
2137 pw = getpwnam (o + 1);
2138 UNBLOCK_INPUT;
2139 if (pw)
2140 return p;
2142 else
2143 return p;
2146 return NULL;
2149 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2150 Ssubstitute_in_file_name, 1, 1, 0,
2151 doc: /* Substitute environment variables referred to in FILENAME.
2152 `$FOO' where FOO is an environment variable name means to substitute
2153 the value of that variable. The variable name should be terminated
2154 with a character not a letter, digit or underscore; otherwise, enclose
2155 the entire variable name in braces.
2156 If `/~' appears, all of FILENAME through that `/' is discarded.
2158 On VMS, `$' substitution is not done; this function does little and only
2159 duplicates what `expand-file-name' does. */)
2160 (filename)
2161 Lisp_Object filename;
2163 unsigned char *nm;
2165 register unsigned char *s, *p, *o, *x, *endp;
2166 unsigned char *target = NULL;
2167 int total = 0;
2168 int substituted = 0;
2169 unsigned char *xnm;
2170 Lisp_Object handler;
2172 CHECK_STRING (filename);
2174 /* If the file name has special constructs in it,
2175 call the corresponding file handler. */
2176 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2177 if (!NILP (handler))
2178 return call2 (handler, Qsubstitute_in_file_name, filename);
2180 nm = SDATA (filename);
2181 #ifdef DOS_NT
2182 nm = strcpy (alloca (strlen (nm) + 1), nm);
2183 CORRECT_DIR_SEPS (nm);
2184 substituted = (strcmp (nm, SDATA (filename)) != 0);
2185 #endif
2186 endp = nm + SBYTES (filename);
2188 /* If /~ or // appears, discard everything through first slash. */
2189 p = search_embedded_absfilename (nm, endp);
2190 if (p)
2191 /* Start over with the new string, so we check the file-name-handler
2192 again. Important with filenames like "/home/foo//:/hello///there"
2193 which whould substitute to "/:/hello///there" rather than "/there". */
2194 return Fsubstitute_in_file_name
2195 (make_specified_string (p, -1, endp - p,
2196 STRING_MULTIBYTE (filename)));
2198 #ifdef VMS
2199 return filename;
2200 #else
2202 /* See if any variables are substituted into the string
2203 and find the total length of their values in `total' */
2205 for (p = nm; p != endp;)
2206 if (*p != '$')
2207 p++;
2208 else
2210 p++;
2211 if (p == endp)
2212 goto badsubst;
2213 else if (*p == '$')
2215 /* "$$" means a single "$" */
2216 p++;
2217 total -= 1;
2218 substituted = 1;
2219 continue;
2221 else if (*p == '{')
2223 o = ++p;
2224 while (p != endp && *p != '}') p++;
2225 if (*p != '}') goto missingclose;
2226 s = p;
2228 else
2230 o = p;
2231 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2232 s = p;
2235 /* Copy out the variable name */
2236 target = (unsigned char *) alloca (s - o + 1);
2237 strncpy (target, o, s - o);
2238 target[s - o] = 0;
2239 #ifdef DOS_NT
2240 strupr (target); /* $home == $HOME etc. */
2241 #endif /* DOS_NT */
2243 /* Get variable value */
2244 o = (unsigned char *) egetenv (target);
2245 if (o)
2246 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
2247 total += strlen (o) * (STRING_MULTIBYTE (filename) ? 2 : 1);
2248 substituted = 1;
2250 else if (*p == '}')
2251 goto badvar;
2254 if (!substituted)
2255 return filename;
2257 /* If substitution required, recopy the string and do it */
2258 /* Make space in stack frame for the new copy */
2259 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2260 x = xnm;
2262 /* Copy the rest of the name through, replacing $ constructs with values */
2263 for (p = nm; *p;)
2264 if (*p != '$')
2265 *x++ = *p++;
2266 else
2268 p++;
2269 if (p == endp)
2270 goto badsubst;
2271 else if (*p == '$')
2273 *x++ = *p++;
2274 continue;
2276 else if (*p == '{')
2278 o = ++p;
2279 while (p != endp && *p != '}') p++;
2280 if (*p != '}') goto missingclose;
2281 s = p++;
2283 else
2285 o = p;
2286 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2287 s = p;
2290 /* Copy out the variable name */
2291 target = (unsigned char *) alloca (s - o + 1);
2292 strncpy (target, o, s - o);
2293 target[s - o] = 0;
2294 #ifdef DOS_NT
2295 strupr (target); /* $home == $HOME etc. */
2296 #endif /* DOS_NT */
2298 /* Get variable value */
2299 o = (unsigned char *) egetenv (target);
2300 if (!o)
2302 *x++ = '$';
2303 strcpy (x, target); x+= strlen (target);
2305 else if (STRING_MULTIBYTE (filename))
2307 /* If the original string is multibyte,
2308 convert what we substitute into multibyte. */
2309 while (*o)
2311 int c = unibyte_char_to_multibyte (*o++);
2312 x += CHAR_STRING (c, x);
2315 else
2317 strcpy (x, o);
2318 x += strlen (o);
2322 *x = 0;
2324 /* If /~ or // appears, discard everything through first slash. */
2325 while ((p = search_embedded_absfilename (xnm, x)))
2326 /* This time we do not start over because we've already expanded envvars
2327 and replaced $$ with $. Maybe we should start over as well, but we'd
2328 need to quote some $ to $$ first. */
2329 xnm = p;
2331 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2333 badsubst:
2334 error ("Bad format environment-variable substitution");
2335 missingclose:
2336 error ("Missing \"}\" in environment-variable substitution");
2337 badvar:
2338 error ("Substituting nonexistent environment variable \"%s\"", target);
2340 /* NOTREACHED */
2341 #endif /* not VMS */
2342 return Qnil;
2345 /* A slightly faster and more convenient way to get
2346 (directory-file-name (expand-file-name FOO)). */
2348 Lisp_Object
2349 expand_and_dir_to_file (filename, defdir)
2350 Lisp_Object filename, defdir;
2352 register Lisp_Object absname;
2354 absname = Fexpand_file_name (filename, defdir);
2355 #ifdef VMS
2357 register int c = SREF (absname, SBYTES (absname) - 1);
2358 if (c == ':' || c == ']' || c == '>')
2359 absname = Fdirectory_file_name (absname);
2361 #else
2362 /* Remove final slash, if any (unless this is the root dir).
2363 stat behaves differently depending! */
2364 if (SCHARS (absname) > 1
2365 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2366 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2367 /* We cannot take shortcuts; they might be wrong for magic file names. */
2368 absname = Fdirectory_file_name (absname);
2369 #endif
2370 return absname;
2373 /* Signal an error if the file ABSNAME already exists.
2374 If INTERACTIVE is nonzero, ask the user whether to proceed,
2375 and bypass the error if the user says to go ahead.
2376 QUERYSTRING is a name for the action that is being considered
2377 to alter the file.
2379 *STATPTR is used to store the stat information if the file exists.
2380 If the file does not exist, STATPTR->st_mode is set to 0.
2381 If STATPTR is null, we don't store into it.
2383 If QUICK is nonzero, we ask for y or n, not yes or no. */
2385 void
2386 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2387 Lisp_Object absname;
2388 unsigned char *querystring;
2389 int interactive;
2390 struct stat *statptr;
2391 int quick;
2393 register Lisp_Object tem, encoded_filename;
2394 struct stat statbuf;
2395 struct gcpro gcpro1;
2397 encoded_filename = ENCODE_FILE (absname);
2399 /* stat is a good way to tell whether the file exists,
2400 regardless of what access permissions it has. */
2401 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2403 if (! interactive)
2404 xsignal2 (Qfile_already_exists,
2405 build_string ("File already exists"), absname);
2406 GCPRO1 (absname);
2407 tem = format2 ("File %s already exists; %s anyway? ",
2408 absname, build_string (querystring));
2409 if (quick)
2410 tem = Fy_or_n_p (tem);
2411 else
2412 tem = do_yes_or_no_p (tem);
2413 UNGCPRO;
2414 if (NILP (tem))
2415 xsignal2 (Qfile_already_exists,
2416 build_string ("File already exists"), absname);
2417 if (statptr)
2418 *statptr = statbuf;
2420 else
2422 if (statptr)
2423 statptr->st_mode = 0;
2425 return;
2428 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2429 "fCopy file: \nGCopy %s to file: \np\nP",
2430 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2431 If NEWNAME names a directory, copy FILE there.
2433 This function always sets the file modes of the output file to match
2434 the input file.
2436 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2437 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2438 signal a `file-already-exists' error without overwriting. If
2439 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2440 about overwriting; this is what happens in interactive use with M-x.
2441 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2442 existing file.
2444 Fourth arg KEEP-TIME non-nil means give the output file the same
2445 last-modified time as the old one. (This works on only some systems.)
2447 A prefix arg makes KEEP-TIME non-nil.
2449 If PRESERVE-UID-GID is non-nil, we try to transfer the
2450 uid and gid of FILE to NEWNAME. */)
2451 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2452 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2453 Lisp_Object preserve_uid_gid;
2455 int ifd, ofd, n;
2456 char buf[16 * 1024];
2457 struct stat st, out_st;
2458 Lisp_Object handler;
2459 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2460 int count = SPECPDL_INDEX ();
2461 int input_file_statable_p;
2462 Lisp_Object encoded_file, encoded_newname;
2464 encoded_file = encoded_newname = Qnil;
2465 GCPRO4 (file, newname, encoded_file, encoded_newname);
2466 CHECK_STRING (file);
2467 CHECK_STRING (newname);
2469 if (!NILP (Ffile_directory_p (newname)))
2470 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2471 else
2472 newname = Fexpand_file_name (newname, Qnil);
2474 file = Fexpand_file_name (file, Qnil);
2476 /* If the input file name has special constructs in it,
2477 call the corresponding file handler. */
2478 handler = Ffind_file_name_handler (file, Qcopy_file);
2479 /* Likewise for output file name. */
2480 if (NILP (handler))
2481 handler = Ffind_file_name_handler (newname, Qcopy_file);
2482 if (!NILP (handler))
2483 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2484 ok_if_already_exists, keep_time));
2486 encoded_file = ENCODE_FILE (file);
2487 encoded_newname = ENCODE_FILE (newname);
2489 if (NILP (ok_if_already_exists)
2490 || INTEGERP (ok_if_already_exists))
2491 barf_or_query_if_file_exists (newname, "copy to it",
2492 INTEGERP (ok_if_already_exists), &out_st, 0);
2493 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2494 out_st.st_mode = 0;
2496 #ifdef WINDOWSNT
2497 if (!CopyFile (SDATA (encoded_file),
2498 SDATA (encoded_newname),
2499 FALSE))
2500 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2501 /* CopyFile retains the timestamp by default. */
2502 else if (NILP (keep_time))
2504 EMACS_TIME now;
2505 DWORD attributes;
2506 char * filename;
2508 EMACS_GET_TIME (now);
2509 filename = SDATA (encoded_newname);
2511 /* Ensure file is writable while its modified time is set. */
2512 attributes = GetFileAttributes (filename);
2513 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2514 if (set_file_times (filename, now, now))
2516 /* Restore original attributes. */
2517 SetFileAttributes (filename, attributes);
2518 xsignal2 (Qfile_date_error,
2519 build_string ("Cannot set file date"), newname);
2521 /* Restore original attributes. */
2522 SetFileAttributes (filename, attributes);
2524 #else /* not WINDOWSNT */
2525 immediate_quit = 1;
2526 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2527 immediate_quit = 0;
2529 if (ifd < 0)
2530 report_file_error ("Opening input file", Fcons (file, Qnil));
2532 record_unwind_protect (close_file_unwind, make_number (ifd));
2534 /* We can only copy regular files and symbolic links. Other files are not
2535 copyable by us. */
2536 input_file_statable_p = (fstat (ifd, &st) >= 0);
2538 #if !defined (MSDOS) || __DJGPP__ > 1
2539 if (out_st.st_mode != 0
2540 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2542 errno = 0;
2543 report_file_error ("Input and output files are the same",
2544 Fcons (file, Fcons (newname, Qnil)));
2546 #endif
2548 #if defined (S_ISREG) && defined (S_ISLNK)
2549 if (input_file_statable_p)
2551 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2553 #if defined (EISDIR)
2554 /* Get a better looking error message. */
2555 errno = EISDIR;
2556 #endif /* EISDIR */
2557 report_file_error ("Non-regular file", Fcons (file, Qnil));
2560 #endif /* S_ISREG && S_ISLNK */
2562 #ifdef VMS
2563 /* Create the copy file with the same record format as the input file */
2564 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2565 #else
2566 #ifdef MSDOS
2567 /* System's default file type was set to binary by _fmode in emacs.c. */
2568 ofd = emacs_open (SDATA (encoded_newname),
2569 O_WRONLY | O_TRUNC | O_CREAT
2570 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2571 S_IREAD | S_IWRITE);
2572 #else /* not MSDOS */
2573 ofd = emacs_open (SDATA (encoded_newname),
2574 O_WRONLY | O_TRUNC | O_CREAT
2575 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2576 0666);
2577 #endif /* not MSDOS */
2578 #endif /* VMS */
2579 if (ofd < 0)
2580 report_file_error ("Opening output file", Fcons (newname, Qnil));
2582 record_unwind_protect (close_file_unwind, make_number (ofd));
2584 immediate_quit = 1;
2585 QUIT;
2586 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2587 if (emacs_write (ofd, buf, n) != n)
2588 report_file_error ("I/O error", Fcons (newname, Qnil));
2589 immediate_quit = 0;
2591 #ifndef MSDOS
2592 /* Preserve the original file modes, and if requested, also its
2593 owner and group. */
2594 if (input_file_statable_p)
2596 if (! NILP (preserve_uid_gid))
2597 fchown (ofd, st.st_uid, st.st_gid);
2598 fchmod (ofd, st.st_mode & 07777);
2600 #endif /* not MSDOS */
2602 /* Closing the output clobbers the file times on some systems. */
2603 if (emacs_close (ofd) < 0)
2604 report_file_error ("I/O error", Fcons (newname, Qnil));
2606 if (input_file_statable_p)
2608 if (!NILP (keep_time))
2610 EMACS_TIME atime, mtime;
2611 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2612 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2613 if (set_file_times (SDATA (encoded_newname),
2614 atime, mtime))
2615 xsignal2 (Qfile_date_error,
2616 build_string ("Cannot set file date"), newname);
2620 emacs_close (ifd);
2622 #if defined (__DJGPP__) && __DJGPP__ > 1
2623 if (input_file_statable_p)
2625 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2626 and if it can't, it tells so. Otherwise, under MSDOS we usually
2627 get only the READ bit, which will make the copied file read-only,
2628 so it's better not to chmod at all. */
2629 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2630 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2632 #endif /* DJGPP version 2 or newer */
2633 #endif /* not WINDOWSNT */
2635 /* Discard the unwind protects. */
2636 specpdl_ptr = specpdl + count;
2638 UNGCPRO;
2639 return Qnil;
2642 DEFUN ("make-directory-internal", Fmake_directory_internal,
2643 Smake_directory_internal, 1, 1, 0,
2644 doc: /* Create a new directory named DIRECTORY. */)
2645 (directory)
2646 Lisp_Object directory;
2648 const unsigned char *dir;
2649 Lisp_Object handler;
2650 Lisp_Object encoded_dir;
2652 CHECK_STRING (directory);
2653 directory = Fexpand_file_name (directory, Qnil);
2655 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2656 if (!NILP (handler))
2657 return call2 (handler, Qmake_directory_internal, directory);
2659 encoded_dir = ENCODE_FILE (directory);
2661 dir = SDATA (encoded_dir);
2663 #ifdef WINDOWSNT
2664 if (mkdir (dir) != 0)
2665 #else
2666 if (mkdir (dir, 0777) != 0)
2667 #endif
2668 report_file_error ("Creating directory", list1 (directory));
2670 return Qnil;
2673 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2674 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2675 (directory)
2676 Lisp_Object directory;
2678 const unsigned char *dir;
2679 Lisp_Object handler;
2680 Lisp_Object encoded_dir;
2682 CHECK_STRING (directory);
2683 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2685 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2686 if (!NILP (handler))
2687 return call2 (handler, Qdelete_directory, directory);
2689 encoded_dir = ENCODE_FILE (directory);
2691 dir = SDATA (encoded_dir);
2693 if (rmdir (dir) != 0)
2694 report_file_error ("Removing directory", list1 (directory));
2696 return Qnil;
2699 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2700 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2701 If file has multiple names, it continues to exist with the other names. */)
2702 (filename)
2703 Lisp_Object filename;
2705 Lisp_Object handler;
2706 Lisp_Object encoded_file;
2707 struct gcpro gcpro1;
2709 GCPRO1 (filename);
2710 if (!NILP (Ffile_directory_p (filename))
2711 && NILP (Ffile_symlink_p (filename)))
2712 xsignal2 (Qfile_error,
2713 build_string ("Removing old name: is a directory"),
2714 filename);
2715 UNGCPRO;
2716 filename = Fexpand_file_name (filename, Qnil);
2718 handler = Ffind_file_name_handler (filename, Qdelete_file);
2719 if (!NILP (handler))
2720 return call2 (handler, Qdelete_file, filename);
2722 encoded_file = ENCODE_FILE (filename);
2724 if (0 > unlink (SDATA (encoded_file)))
2725 report_file_error ("Removing old name", list1 (filename));
2726 return Qnil;
2729 static Lisp_Object
2730 internal_delete_file_1 (ignore)
2731 Lisp_Object ignore;
2733 return Qt;
2736 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2739 internal_delete_file (filename)
2740 Lisp_Object filename;
2742 Lisp_Object tem;
2743 tem = internal_condition_case_1 (Fdelete_file, filename,
2744 Qt, internal_delete_file_1);
2745 return NILP (tem);
2748 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2749 "fRename file: \nGRename %s to file: \np",
2750 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2751 If file has names other than FILE, it continues to have those names.
2752 Signals a `file-already-exists' error if a file NEWNAME already exists
2753 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2754 A number as third arg means request confirmation if NEWNAME already exists.
2755 This is what happens in interactive use with M-x. */)
2756 (file, newname, ok_if_already_exists)
2757 Lisp_Object file, newname, ok_if_already_exists;
2759 Lisp_Object handler;
2760 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2761 Lisp_Object encoded_file, encoded_newname, symlink_target;
2763 symlink_target = encoded_file = encoded_newname = Qnil;
2764 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2765 CHECK_STRING (file);
2766 CHECK_STRING (newname);
2767 file = Fexpand_file_name (file, Qnil);
2769 if ((!NILP (Ffile_directory_p (newname)))
2770 #ifdef DOS_NT
2771 /* If the file names are identical but for the case,
2772 don't attempt to move directory to itself. */
2773 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2774 #endif
2776 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2777 else
2778 newname = Fexpand_file_name (newname, Qnil);
2780 /* If the file name has special constructs in it,
2781 call the corresponding file handler. */
2782 handler = Ffind_file_name_handler (file, Qrename_file);
2783 if (NILP (handler))
2784 handler = Ffind_file_name_handler (newname, Qrename_file);
2785 if (!NILP (handler))
2786 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2787 file, newname, ok_if_already_exists));
2789 encoded_file = ENCODE_FILE (file);
2790 encoded_newname = ENCODE_FILE (newname);
2792 #ifdef DOS_NT
2793 /* If the file names are identical but for the case, don't ask for
2794 confirmation: they simply want to change the letter-case of the
2795 file name. */
2796 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2797 #endif
2798 if (NILP (ok_if_already_exists)
2799 || INTEGERP (ok_if_already_exists))
2800 barf_or_query_if_file_exists (newname, "rename to it",
2801 INTEGERP (ok_if_already_exists), 0, 0);
2802 #ifndef BSD4_1
2803 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2804 #else
2805 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2806 || 0 > unlink (SDATA (encoded_file)))
2807 #endif
2809 if (errno == EXDEV)
2811 #ifdef S_IFLNK
2812 symlink_target = Ffile_symlink_p (file);
2813 if (! NILP (symlink_target))
2814 Fmake_symbolic_link (symlink_target, newname,
2815 NILP (ok_if_already_exists) ? Qnil : Qt);
2816 else
2817 #endif
2818 Fcopy_file (file, newname,
2819 /* We have already prompted if it was an integer,
2820 so don't have copy-file prompt again. */
2821 NILP (ok_if_already_exists) ? Qnil : Qt,
2822 Qt, Qt);
2824 Fdelete_file (file);
2826 else
2827 report_file_error ("Renaming", list2 (file, newname));
2829 UNGCPRO;
2830 return Qnil;
2833 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2834 "fAdd name to file: \nGName to add to %s: \np",
2835 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2836 Signals a `file-already-exists' error if a file NEWNAME already exists
2837 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2838 A number as third arg means request confirmation if NEWNAME already exists.
2839 This is what happens in interactive use with M-x. */)
2840 (file, newname, ok_if_already_exists)
2841 Lisp_Object file, newname, ok_if_already_exists;
2843 Lisp_Object handler;
2844 Lisp_Object encoded_file, encoded_newname;
2845 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2847 GCPRO4 (file, newname, encoded_file, encoded_newname);
2848 encoded_file = encoded_newname = Qnil;
2849 CHECK_STRING (file);
2850 CHECK_STRING (newname);
2851 file = Fexpand_file_name (file, Qnil);
2853 if (!NILP (Ffile_directory_p (newname)))
2854 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2855 else
2856 newname = Fexpand_file_name (newname, Qnil);
2858 /* If the file name has special constructs in it,
2859 call the corresponding file handler. */
2860 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2861 if (!NILP (handler))
2862 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2863 newname, ok_if_already_exists));
2865 /* If the new name has special constructs in it,
2866 call the corresponding file handler. */
2867 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2868 if (!NILP (handler))
2869 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2870 newname, ok_if_already_exists));
2872 encoded_file = ENCODE_FILE (file);
2873 encoded_newname = ENCODE_FILE (newname);
2875 if (NILP (ok_if_already_exists)
2876 || INTEGERP (ok_if_already_exists))
2877 barf_or_query_if_file_exists (newname, "make it a new name",
2878 INTEGERP (ok_if_already_exists), 0, 0);
2880 unlink (SDATA (newname));
2881 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2882 report_file_error ("Adding new name", list2 (file, newname));
2884 UNGCPRO;
2885 return Qnil;
2888 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2889 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2890 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2891 Both args must be strings.
2892 Signals a `file-already-exists' error if a file LINKNAME already exists
2893 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2894 A number as third arg means request confirmation if LINKNAME already exists.
2895 This happens for interactive use with M-x. */)
2896 (filename, linkname, ok_if_already_exists)
2897 Lisp_Object filename, linkname, ok_if_already_exists;
2899 Lisp_Object handler;
2900 Lisp_Object encoded_filename, encoded_linkname;
2901 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2903 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2904 encoded_filename = encoded_linkname = Qnil;
2905 CHECK_STRING (filename);
2906 CHECK_STRING (linkname);
2907 /* If the link target has a ~, we must expand it to get
2908 a truly valid file name. Otherwise, do not expand;
2909 we want to permit links to relative file names. */
2910 if (SREF (filename, 0) == '~')
2911 filename = Fexpand_file_name (filename, Qnil);
2913 if (!NILP (Ffile_directory_p (linkname)))
2914 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2915 else
2916 linkname = Fexpand_file_name (linkname, Qnil);
2918 /* If the file name has special constructs in it,
2919 call the corresponding file handler. */
2920 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2921 if (!NILP (handler))
2922 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2923 linkname, ok_if_already_exists));
2925 /* If the new link name has special constructs in it,
2926 call the corresponding file handler. */
2927 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2928 if (!NILP (handler))
2929 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2930 linkname, ok_if_already_exists));
2932 #ifdef S_IFLNK
2933 encoded_filename = ENCODE_FILE (filename);
2934 encoded_linkname = ENCODE_FILE (linkname);
2936 if (NILP (ok_if_already_exists)
2937 || INTEGERP (ok_if_already_exists))
2938 barf_or_query_if_file_exists (linkname, "make it a link",
2939 INTEGERP (ok_if_already_exists), 0, 0);
2940 if (0 > symlink (SDATA (encoded_filename),
2941 SDATA (encoded_linkname)))
2943 /* If we didn't complain already, silently delete existing file. */
2944 if (errno == EEXIST)
2946 unlink (SDATA (encoded_linkname));
2947 if (0 <= symlink (SDATA (encoded_filename),
2948 SDATA (encoded_linkname)))
2950 UNGCPRO;
2951 return Qnil;
2955 report_file_error ("Making symbolic link", list2 (filename, linkname));
2957 UNGCPRO;
2958 return Qnil;
2960 #else
2961 UNGCPRO;
2962 xsignal1 (Qfile_error, build_string ("Symbolic links are not supported"));
2964 #endif /* S_IFLNK */
2967 #ifdef VMS
2969 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2970 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2971 doc: /* Define the job-wide logical name NAME to have the value STRING.
2972 If STRING is nil or a null string, the logical name NAME is deleted. */)
2973 (name, string)
2974 Lisp_Object name;
2975 Lisp_Object string;
2977 CHECK_STRING (name);
2978 if (NILP (string))
2979 delete_logical_name (SDATA (name));
2980 else
2982 CHECK_STRING (string);
2984 if (SCHARS (string) == 0)
2985 delete_logical_name (SDATA (name));
2986 else
2987 define_logical_name (SDATA (name), SDATA (string));
2990 return string;
2992 #endif /* VMS */
2994 #ifdef HPUX_NET
2996 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2997 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2998 (path, login)
2999 Lisp_Object path, login;
3001 int netresult;
3003 CHECK_STRING (path);
3004 CHECK_STRING (login);
3006 netresult = netunam (SDATA (path), SDATA (login));
3008 if (netresult == -1)
3009 return Qnil;
3010 else
3011 return Qt;
3013 #endif /* HPUX_NET */
3015 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
3016 1, 1, 0,
3017 doc: /* Return t if file FILENAME specifies an absolute file name.
3018 On Unix, this is a name starting with a `/' or a `~'. */)
3019 (filename)
3020 Lisp_Object filename;
3022 CHECK_STRING (filename);
3023 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3026 /* Return nonzero if file FILENAME exists and can be executed. */
3028 static int
3029 check_executable (filename)
3030 char *filename;
3032 #ifdef DOS_NT
3033 int len = strlen (filename);
3034 char *suffix;
3035 struct stat st;
3036 if (stat (filename, &st) < 0)
3037 return 0;
3038 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3039 return ((st.st_mode & S_IEXEC) != 0);
3040 #else
3041 return (S_ISREG (st.st_mode)
3042 && len >= 5
3043 && (stricmp ((suffix = filename + len-4), ".com") == 0
3044 || stricmp (suffix, ".exe") == 0
3045 || stricmp (suffix, ".bat") == 0)
3046 || (st.st_mode & S_IFMT) == S_IFDIR);
3047 #endif /* not WINDOWSNT */
3048 #else /* not DOS_NT */
3049 #ifdef HAVE_EUIDACCESS
3050 return (euidaccess (filename, 1) >= 0);
3051 #else
3052 /* Access isn't quite right because it uses the real uid
3053 and we really want to test with the effective uid.
3054 But Unix doesn't give us a right way to do it. */
3055 return (access (filename, 1) >= 0);
3056 #endif
3057 #endif /* not DOS_NT */
3060 /* Return nonzero if file FILENAME exists and can be written. */
3062 static int
3063 check_writable (filename)
3064 char *filename;
3066 #ifdef MSDOS
3067 struct stat st;
3068 if (stat (filename, &st) < 0)
3069 return 0;
3070 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3071 #else /* not MSDOS */
3072 #ifdef HAVE_EUIDACCESS
3073 return (euidaccess (filename, 2) >= 0);
3074 #else
3075 /* Access isn't quite right because it uses the real uid
3076 and we really want to test with the effective uid.
3077 But Unix doesn't give us a right way to do it.
3078 Opening with O_WRONLY could work for an ordinary file,
3079 but would lose for directories. */
3080 return (access (filename, 2) >= 0);
3081 #endif
3082 #endif /* not MSDOS */
3085 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3086 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3087 See also `file-readable-p' and `file-attributes'.
3088 This returns nil for a symlink to a nonexistent file.
3089 Use `file-symlink-p' to test for such links. */)
3090 (filename)
3091 Lisp_Object filename;
3093 Lisp_Object absname;
3094 Lisp_Object handler;
3095 struct stat statbuf;
3097 CHECK_STRING (filename);
3098 absname = Fexpand_file_name (filename, Qnil);
3100 /* If the file name has special constructs in it,
3101 call the corresponding file handler. */
3102 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3103 if (!NILP (handler))
3104 return call2 (handler, Qfile_exists_p, absname);
3106 absname = ENCODE_FILE (absname);
3108 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3111 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3112 doc: /* Return t if FILENAME can be executed by you.
3113 For a directory, this means you can access files in that directory. */)
3114 (filename)
3115 Lisp_Object filename;
3117 Lisp_Object absname;
3118 Lisp_Object handler;
3120 CHECK_STRING (filename);
3121 absname = Fexpand_file_name (filename, Qnil);
3123 /* If the file name has special constructs in it,
3124 call the corresponding file handler. */
3125 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3126 if (!NILP (handler))
3127 return call2 (handler, Qfile_executable_p, absname);
3129 absname = ENCODE_FILE (absname);
3131 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3134 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3135 doc: /* Return t if file FILENAME exists and you can read it.
3136 See also `file-exists-p' and `file-attributes'. */)
3137 (filename)
3138 Lisp_Object filename;
3140 Lisp_Object absname;
3141 Lisp_Object handler;
3142 int desc;
3143 int flags;
3144 struct stat statbuf;
3146 CHECK_STRING (filename);
3147 absname = Fexpand_file_name (filename, Qnil);
3149 /* If the file name has special constructs in it,
3150 call the corresponding file handler. */
3151 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3152 if (!NILP (handler))
3153 return call2 (handler, Qfile_readable_p, absname);
3155 absname = ENCODE_FILE (absname);
3157 #if defined(DOS_NT) || defined(macintosh)
3158 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3159 directories. */
3160 if (access (SDATA (absname), 0) == 0)
3161 return Qt;
3162 return Qnil;
3163 #else /* not DOS_NT and not macintosh */
3164 flags = O_RDONLY;
3165 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3166 /* Opening a fifo without O_NONBLOCK can wait.
3167 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3168 except in the case of a fifo, on a system which handles it. */
3169 desc = stat (SDATA (absname), &statbuf);
3170 if (desc < 0)
3171 return Qnil;
3172 if (S_ISFIFO (statbuf.st_mode))
3173 flags |= O_NONBLOCK;
3174 #endif
3175 desc = emacs_open (SDATA (absname), flags, 0);
3176 if (desc < 0)
3177 return Qnil;
3178 emacs_close (desc);
3179 return Qt;
3180 #endif /* not DOS_NT and not macintosh */
3183 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3184 on the RT/PC. */
3185 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3186 doc: /* Return t if file FILENAME can be written or created by you. */)
3187 (filename)
3188 Lisp_Object filename;
3190 Lisp_Object absname, dir, encoded;
3191 Lisp_Object handler;
3192 struct stat statbuf;
3194 CHECK_STRING (filename);
3195 absname = Fexpand_file_name (filename, Qnil);
3197 /* If the file name has special constructs in it,
3198 call the corresponding file handler. */
3199 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3200 if (!NILP (handler))
3201 return call2 (handler, Qfile_writable_p, absname);
3203 encoded = ENCODE_FILE (absname);
3204 if (stat (SDATA (encoded), &statbuf) >= 0)
3205 return (check_writable (SDATA (encoded))
3206 ? Qt : Qnil);
3208 dir = Ffile_name_directory (absname);
3209 #ifdef VMS
3210 if (!NILP (dir))
3211 dir = Fdirectory_file_name (dir);
3212 #endif /* VMS */
3213 #ifdef MSDOS
3214 if (!NILP (dir))
3215 dir = Fdirectory_file_name (dir);
3216 #endif /* MSDOS */
3218 dir = ENCODE_FILE (dir);
3219 #ifdef WINDOWSNT
3220 /* The read-only attribute of the parent directory doesn't affect
3221 whether a file or directory can be created within it. Some day we
3222 should check ACLs though, which do affect this. */
3223 if (stat (SDATA (dir), &statbuf) < 0)
3224 return Qnil;
3225 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3226 #else
3227 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3228 ? Qt : Qnil);
3229 #endif
3232 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3233 doc: /* Access file FILENAME, and get an error if that does not work.
3234 The second argument STRING is used in the error message.
3235 If there is no error, returns nil. */)
3236 (filename, string)
3237 Lisp_Object filename, string;
3239 Lisp_Object handler, encoded_filename, absname;
3240 int fd;
3242 CHECK_STRING (filename);
3243 absname = Fexpand_file_name (filename, Qnil);
3245 CHECK_STRING (string);
3247 /* If the file name has special constructs in it,
3248 call the corresponding file handler. */
3249 handler = Ffind_file_name_handler (absname, Qaccess_file);
3250 if (!NILP (handler))
3251 return call3 (handler, Qaccess_file, absname, string);
3253 encoded_filename = ENCODE_FILE (absname);
3255 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3256 if (fd < 0)
3257 report_file_error (SDATA (string), Fcons (filename, Qnil));
3258 emacs_close (fd);
3260 return Qnil;
3263 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3264 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3265 The value is the link target, as a string.
3266 Otherwise it returns nil.
3268 This function returns t when given the name of a symlink that
3269 points to a nonexistent file. */)
3270 (filename)
3271 Lisp_Object filename;
3273 Lisp_Object handler;
3275 CHECK_STRING (filename);
3276 filename = Fexpand_file_name (filename, Qnil);
3278 /* If the file name has special constructs in it,
3279 call the corresponding file handler. */
3280 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3281 if (!NILP (handler))
3282 return call2 (handler, Qfile_symlink_p, filename);
3284 #ifdef S_IFLNK
3286 char *buf;
3287 int bufsize;
3288 int valsize;
3289 Lisp_Object val;
3291 filename = ENCODE_FILE (filename);
3293 bufsize = 50;
3294 buf = NULL;
3297 bufsize *= 2;
3298 buf = (char *) xrealloc (buf, bufsize);
3299 bzero (buf, bufsize);
3301 errno = 0;
3302 valsize = readlink (SDATA (filename), buf, bufsize);
3303 if (valsize == -1)
3305 #ifdef ERANGE
3306 /* HP-UX reports ERANGE if buffer is too small. */
3307 if (errno == ERANGE)
3308 valsize = bufsize;
3309 else
3310 #endif
3312 xfree (buf);
3313 return Qnil;
3317 while (valsize >= bufsize);
3319 val = make_string (buf, valsize);
3320 if (buf[0] == '/' && index (buf, ':'))
3321 val = concat2 (build_string ("/:"), val);
3322 xfree (buf);
3323 val = DECODE_FILE (val);
3324 return val;
3326 #else /* not S_IFLNK */
3327 return Qnil;
3328 #endif /* not S_IFLNK */
3331 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3332 doc: /* Return t if FILENAME names an existing directory.
3333 Symbolic links to directories count as directories.
3334 See `file-symlink-p' to distinguish symlinks. */)
3335 (filename)
3336 Lisp_Object filename;
3338 register Lisp_Object absname;
3339 struct stat st;
3340 Lisp_Object handler;
3342 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3344 /* If the file name has special constructs in it,
3345 call the corresponding file handler. */
3346 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3347 if (!NILP (handler))
3348 return call2 (handler, Qfile_directory_p, absname);
3350 absname = ENCODE_FILE (absname);
3352 if (stat (SDATA (absname), &st) < 0)
3353 return Qnil;
3354 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3357 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3358 doc: /* Return t if file FILENAME names a directory you can open.
3359 For the value to be t, FILENAME must specify the name of a directory as a file,
3360 and the directory must allow you to open files in it. In order to use a
3361 directory as a buffer's current directory, this predicate must return true.
3362 A directory name spec may be given instead; then the value is t
3363 if the directory so specified exists and really is a readable and
3364 searchable directory. */)
3365 (filename)
3366 Lisp_Object filename;
3368 Lisp_Object handler;
3369 int tem;
3370 struct gcpro gcpro1;
3372 /* If the file name has special constructs in it,
3373 call the corresponding file handler. */
3374 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3375 if (!NILP (handler))
3376 return call2 (handler, Qfile_accessible_directory_p, filename);
3378 GCPRO1 (filename);
3379 tem = (NILP (Ffile_directory_p (filename))
3380 || NILP (Ffile_executable_p (filename)));
3381 UNGCPRO;
3382 return tem ? Qnil : Qt;
3385 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3386 doc: /* Return t if FILENAME names a regular file.
3387 This is the sort of file that holds an ordinary stream of data bytes.
3388 Symbolic links to regular files count as regular files.
3389 See `file-symlink-p' to distinguish symlinks. */)
3390 (filename)
3391 Lisp_Object filename;
3393 register Lisp_Object absname;
3394 struct stat st;
3395 Lisp_Object handler;
3397 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3399 /* If the file name has special constructs in it,
3400 call the corresponding file handler. */
3401 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3402 if (!NILP (handler))
3403 return call2 (handler, Qfile_regular_p, absname);
3405 absname = ENCODE_FILE (absname);
3407 #ifdef WINDOWSNT
3409 int result;
3410 Lisp_Object tem = Vw32_get_true_file_attributes;
3412 /* Tell stat to use expensive method to get accurate info. */
3413 Vw32_get_true_file_attributes = Qt;
3414 result = stat (SDATA (absname), &st);
3415 Vw32_get_true_file_attributes = tem;
3417 if (result < 0)
3418 return Qnil;
3419 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3421 #else
3422 if (stat (SDATA (absname), &st) < 0)
3423 return Qnil;
3424 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3425 #endif
3428 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3429 doc: /* Return mode bits of file named FILENAME, as an integer.
3430 Return nil, if file does not exist or is not accessible. */)
3431 (filename)
3432 Lisp_Object filename;
3434 Lisp_Object absname;
3435 struct stat st;
3436 Lisp_Object handler;
3438 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3440 /* If the file name has special constructs in it,
3441 call the corresponding file handler. */
3442 handler = Ffind_file_name_handler (absname, Qfile_modes);
3443 if (!NILP (handler))
3444 return call2 (handler, Qfile_modes, absname);
3446 absname = ENCODE_FILE (absname);
3448 if (stat (SDATA (absname), &st) < 0)
3449 return Qnil;
3450 #if defined (MSDOS) && __DJGPP__ < 2
3451 if (check_executable (SDATA (absname)))
3452 st.st_mode |= S_IEXEC;
3453 #endif /* MSDOS && __DJGPP__ < 2 */
3455 return make_number (st.st_mode & 07777);
3458 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3459 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3460 Only the 12 low bits of MODE are used. */)
3461 (filename, mode)
3462 Lisp_Object filename, mode;
3464 Lisp_Object absname, encoded_absname;
3465 Lisp_Object handler;
3467 absname = Fexpand_file_name (filename, current_buffer->directory);
3468 CHECK_NUMBER (mode);
3470 /* If the file name has special constructs in it,
3471 call the corresponding file handler. */
3472 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3473 if (!NILP (handler))
3474 return call3 (handler, Qset_file_modes, absname, mode);
3476 encoded_absname = ENCODE_FILE (absname);
3478 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3479 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3481 return Qnil;
3484 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3485 doc: /* Set the file permission bits for newly created files.
3486 The argument MODE should be an integer; only the low 9 bits are used.
3487 This setting is inherited by subprocesses. */)
3488 (mode)
3489 Lisp_Object mode;
3491 CHECK_NUMBER (mode);
3493 umask ((~ XINT (mode)) & 0777);
3495 return Qnil;
3498 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3499 doc: /* Return the default file protection for created files.
3500 The value is an integer. */)
3503 int realmask;
3504 Lisp_Object value;
3506 realmask = umask (0);
3507 umask (realmask);
3509 XSETINT (value, (~ realmask) & 0777);
3510 return value;
3513 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3515 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3516 doc: /* Set times of file FILENAME to TIME.
3517 Set both access and modification times.
3518 Return t on success, else nil.
3519 Use the current time if TIME is nil. TIME is in the format of
3520 `current-time'. */)
3521 (filename, time)
3522 Lisp_Object filename, time;
3524 Lisp_Object absname, encoded_absname;
3525 Lisp_Object handler;
3526 time_t sec;
3527 int usec;
3529 if (! lisp_time_argument (time, &sec, &usec))
3530 error ("Invalid time specification");
3532 absname = Fexpand_file_name (filename, current_buffer->directory);
3534 /* If the file name has special constructs in it,
3535 call the corresponding file handler. */
3536 handler = Ffind_file_name_handler (absname, Qset_file_times);
3537 if (!NILP (handler))
3538 return call3 (handler, Qset_file_times, absname, time);
3540 encoded_absname = ENCODE_FILE (absname);
3543 EMACS_TIME t;
3545 EMACS_SET_SECS (t, sec);
3546 EMACS_SET_USECS (t, usec);
3548 if (set_file_times (SDATA (encoded_absname), t, t))
3550 #ifdef DOS_NT
3551 struct stat st;
3553 /* Setting times on a directory always fails. */
3554 if (stat (SDATA (encoded_absname), &st) == 0
3555 && (st.st_mode & S_IFMT) == S_IFDIR)
3556 return Qnil;
3557 #endif
3558 report_file_error ("Setting file times", Fcons (absname, Qnil));
3559 return Qnil;
3563 return Qt;
3566 #ifdef HAVE_SYNC
3567 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3568 doc: /* Tell Unix to finish all pending disk updates. */)
3571 sync ();
3572 return Qnil;
3575 #endif /* HAVE_SYNC */
3577 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3578 doc: /* Return t if file FILE1 is newer than file FILE2.
3579 If FILE1 does not exist, the answer is nil;
3580 otherwise, if FILE2 does not exist, the answer is t. */)
3581 (file1, file2)
3582 Lisp_Object file1, file2;
3584 Lisp_Object absname1, absname2;
3585 struct stat st;
3586 int mtime1;
3587 Lisp_Object handler;
3588 struct gcpro gcpro1, gcpro2;
3590 CHECK_STRING (file1);
3591 CHECK_STRING (file2);
3593 absname1 = Qnil;
3594 GCPRO2 (absname1, file2);
3595 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3596 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3597 UNGCPRO;
3599 /* If the file name has special constructs in it,
3600 call the corresponding file handler. */
3601 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3602 if (NILP (handler))
3603 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3604 if (!NILP (handler))
3605 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3607 GCPRO2 (absname1, absname2);
3608 absname1 = ENCODE_FILE (absname1);
3609 absname2 = ENCODE_FILE (absname2);
3610 UNGCPRO;
3612 if (stat (SDATA (absname1), &st) < 0)
3613 return Qnil;
3615 mtime1 = st.st_mtime;
3617 if (stat (SDATA (absname2), &st) < 0)
3618 return Qt;
3620 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3623 #ifdef DOS_NT
3624 Lisp_Object Qfind_buffer_file_type;
3625 #endif /* DOS_NT */
3627 #ifndef READ_BUF_SIZE
3628 #define READ_BUF_SIZE (64 << 10)
3629 #endif
3631 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3633 /* This function is called after Lisp functions to decide a coding
3634 system are called, or when they cause an error. Before they are
3635 called, the current buffer is set unibyte and it contains only a
3636 newly inserted text (thus the buffer was empty before the
3637 insertion).
3639 The functions may set markers, overlays, text properties, or even
3640 alter the buffer contents, change the current buffer.
3642 Here, we reset all those changes by:
3643 o set back the current buffer.
3644 o move all markers and overlays to BEG.
3645 o remove all text properties.
3646 o set back the buffer multibyteness. */
3648 static Lisp_Object
3649 decide_coding_unwind (unwind_data)
3650 Lisp_Object unwind_data;
3652 Lisp_Object multibyte, undo_list, buffer;
3654 multibyte = XCAR (unwind_data);
3655 unwind_data = XCDR (unwind_data);
3656 undo_list = XCAR (unwind_data);
3657 buffer = XCDR (unwind_data);
3659 if (current_buffer != XBUFFER (buffer))
3660 set_buffer_internal (XBUFFER (buffer));
3661 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3662 adjust_overlays_for_delete (BEG, Z - BEG);
3663 BUF_INTERVALS (current_buffer) = 0;
3664 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3666 /* Now we are safe to change the buffer's multibyteness directly. */
3667 current_buffer->enable_multibyte_characters = multibyte;
3668 current_buffer->undo_list = undo_list;
3670 return Qnil;
3674 /* Used to pass values from insert-file-contents to read_non_regular. */
3676 static int non_regular_fd;
3677 static int non_regular_inserted;
3678 static int non_regular_nbytes;
3681 /* Read from a non-regular file.
3682 Read non_regular_trytry bytes max from non_regular_fd.
3683 Non_regular_inserted specifies where to put the read bytes.
3684 Value is the number of bytes read. */
3686 static Lisp_Object
3687 read_non_regular ()
3689 int nbytes;
3691 immediate_quit = 1;
3692 QUIT;
3693 nbytes = emacs_read (non_regular_fd,
3694 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3695 non_regular_nbytes);
3696 immediate_quit = 0;
3697 return make_number (nbytes);
3701 /* Condition-case handler used when reading from non-regular files
3702 in insert-file-contents. */
3704 static Lisp_Object
3705 read_non_regular_quit ()
3707 return Qnil;
3711 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3712 1, 5, 0,
3713 doc: /* Insert contents of file FILENAME after point.
3714 Returns list of absolute file name and number of characters inserted.
3715 If second argument VISIT is non-nil, the buffer's visited filename
3716 and last save file modtime are set, and it is marked unmodified.
3717 If visiting and the file does not exist, visiting is completed
3718 before the error is signaled.
3719 The optional third and fourth arguments BEG and END
3720 specify what portion of the file to insert.
3721 These arguments count bytes in the file, not characters in the buffer.
3722 If VISIT is non-nil, BEG and END must be nil.
3724 If optional fifth argument REPLACE is non-nil,
3725 it means replace the current buffer contents (in the accessible portion)
3726 with the file contents. This is better than simply deleting and inserting
3727 the whole thing because (1) it preserves some marker positions
3728 and (2) it puts less data in the undo list.
3729 When REPLACE is non-nil, the value is the number of characters actually read,
3730 which is often less than the number of characters to be read.
3732 This does code conversion according to the value of
3733 `coding-system-for-read' or `file-coding-system-alist',
3734 and sets the variable `last-coding-system-used' to the coding system
3735 actually used. */)
3736 (filename, visit, beg, end, replace)
3737 Lisp_Object filename, visit, beg, end, replace;
3739 struct stat st;
3740 register int fd;
3741 int inserted = 0;
3742 register int how_much;
3743 register int unprocessed;
3744 int count = SPECPDL_INDEX ();
3745 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3746 Lisp_Object handler, val, insval, orig_filename;
3747 Lisp_Object p;
3748 int total = 0;
3749 int not_regular = 0;
3750 unsigned char read_buf[READ_BUF_SIZE];
3751 struct coding_system coding;
3752 unsigned char buffer[1 << 14];
3753 int replace_handled = 0;
3754 int set_coding_system = 0;
3755 int coding_system_decided = 0;
3756 int read_quit = 0;
3757 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3758 int we_locked_file = 0;
3760 if (current_buffer->base_buffer && ! NILP (visit))
3761 error ("Cannot do file visiting in an indirect buffer");
3763 if (!NILP (current_buffer->read_only))
3764 Fbarf_if_buffer_read_only ();
3766 val = Qnil;
3767 p = Qnil;
3768 orig_filename = Qnil;
3770 GCPRO4 (filename, val, p, orig_filename);
3772 CHECK_STRING (filename);
3773 filename = Fexpand_file_name (filename, Qnil);
3775 /* If the file name has special constructs in it,
3776 call the corresponding file handler. */
3777 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3778 if (!NILP (handler))
3780 val = call6 (handler, Qinsert_file_contents, filename,
3781 visit, beg, end, replace);
3782 if (CONSP (val) && CONSP (XCDR (val)))
3783 inserted = XINT (XCAR (XCDR (val)));
3784 goto handled;
3787 orig_filename = filename;
3788 filename = ENCODE_FILE (filename);
3790 fd = -1;
3792 #ifdef WINDOWSNT
3794 Lisp_Object tem = Vw32_get_true_file_attributes;
3796 /* Tell stat to use expensive method to get accurate info. */
3797 Vw32_get_true_file_attributes = Qt;
3798 total = stat (SDATA (filename), &st);
3799 Vw32_get_true_file_attributes = tem;
3801 if (total < 0)
3802 #else
3803 #ifndef APOLLO
3804 if (stat (SDATA (filename), &st) < 0)
3805 #else
3806 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3807 || fstat (fd, &st) < 0)
3808 #endif /* not APOLLO */
3809 #endif /* WINDOWSNT */
3811 if (fd >= 0) emacs_close (fd);
3812 badopen:
3813 if (NILP (visit))
3814 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3815 st.st_mtime = -1;
3816 how_much = 0;
3817 if (!NILP (Vcoding_system_for_read))
3818 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3819 goto notfound;
3822 #ifdef S_IFREG
3823 /* This code will need to be changed in order to work on named
3824 pipes, and it's probably just not worth it. So we should at
3825 least signal an error. */
3826 if (!S_ISREG (st.st_mode))
3828 not_regular = 1;
3830 if (! NILP (visit))
3831 goto notfound;
3833 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3834 xsignal2 (Qfile_error,
3835 build_string ("not a regular file"), orig_filename);
3837 #endif
3839 if (fd < 0)
3840 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3841 goto badopen;
3843 /* Replacement should preserve point as it preserves markers. */
3844 if (!NILP (replace))
3845 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3847 record_unwind_protect (close_file_unwind, make_number (fd));
3849 /* Supposedly happens on VMS. */
3850 /* Can happen on any platform that uses long as type of off_t, but allows
3851 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3852 give a message suitable for the latter case. */
3853 if (! not_regular && st.st_size < 0)
3854 error ("Maximum buffer size exceeded");
3856 /* Prevent redisplay optimizations. */
3857 current_buffer->clip_changed = 1;
3859 if (!NILP (visit))
3861 if (!NILP (beg) || !NILP (end))
3862 error ("Attempt to visit less than an entire file");
3863 if (BEG < Z && NILP (replace))
3864 error ("Cannot do file visiting in a non-empty buffer");
3867 if (!NILP (beg))
3868 CHECK_NUMBER (beg);
3869 else
3870 XSETFASTINT (beg, 0);
3872 if (!NILP (end))
3873 CHECK_NUMBER (end);
3874 else
3876 if (! not_regular)
3878 XSETINT (end, st.st_size);
3880 /* Arithmetic overflow can occur if an Emacs integer cannot
3881 represent the file size, or if the calculations below
3882 overflow. The calculations below double the file size
3883 twice, so check that it can be multiplied by 4 safely. */
3884 if (XINT (end) != st.st_size
3885 || ((int) st.st_size * 4) / 4 != st.st_size)
3886 error ("Maximum buffer size exceeded");
3888 /* The file size returned from stat may be zero, but data
3889 may be readable nonetheless, for example when this is a
3890 file in the /proc filesystem. */
3891 if (st.st_size == 0)
3892 XSETINT (end, READ_BUF_SIZE);
3896 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3898 /* We use emacs-mule for auto saving... */
3899 setup_coding_system (Qemacs_mule, &coding);
3900 /* ... but with the special flag to indicate to read in a
3901 multibyte sequence for eight-bit-control char as is. */
3902 coding.flags = 1;
3903 coding.src_multibyte = 0;
3904 coding.dst_multibyte
3905 = !NILP (current_buffer->enable_multibyte_characters);
3906 coding.eol_type = CODING_EOL_LF;
3907 coding_system_decided = 1;
3909 else if (BEG < Z)
3911 /* Decide the coding system to use for reading the file now
3912 because we can't use an optimized method for handling
3913 `coding:' tag if the current buffer is not empty. */
3914 Lisp_Object val;
3915 val = Qnil;
3917 if (!NILP (Vcoding_system_for_read))
3918 val = Vcoding_system_for_read;
3919 else
3921 /* Don't try looking inside a file for a coding system
3922 specification if it is not seekable. */
3923 if (! not_regular && ! NILP (Vset_auto_coding_function))
3925 /* Find a coding system specified in the heading two
3926 lines or in the tailing several lines of the file.
3927 We assume that the 1K-byte and 3K-byte for heading
3928 and tailing respectively are sufficient for this
3929 purpose. */
3930 int nread;
3932 if (st.st_size <= (1024 * 4))
3933 nread = emacs_read (fd, read_buf, 1024 * 4);
3934 else
3936 nread = emacs_read (fd, read_buf, 1024);
3937 if (nread >= 0)
3939 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3940 report_file_error ("Setting file position",
3941 Fcons (orig_filename, Qnil));
3942 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3946 if (nread < 0)
3947 error ("IO error reading %s: %s",
3948 SDATA (orig_filename), emacs_strerror (errno));
3949 else if (nread > 0)
3951 struct buffer *prev = current_buffer;
3952 Lisp_Object buffer;
3953 struct buffer *buf;
3955 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3957 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3958 buf = XBUFFER (buffer);
3960 delete_all_overlays (buf);
3961 buf->directory = current_buffer->directory;
3962 buf->read_only = Qnil;
3963 buf->filename = Qnil;
3964 buf->undo_list = Qt;
3965 eassert (buf->overlays_before == NULL);
3966 eassert (buf->overlays_after == NULL);
3968 set_buffer_internal (buf);
3969 Ferase_buffer ();
3970 buf->enable_multibyte_characters = Qnil;
3972 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3973 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3974 val = call2 (Vset_auto_coding_function,
3975 filename, make_number (nread));
3976 set_buffer_internal (prev);
3978 /* Discard the unwind protect for recovering the
3979 current buffer. */
3980 specpdl_ptr--;
3982 /* Rewind the file for the actual read done later. */
3983 if (lseek (fd, 0, 0) < 0)
3984 report_file_error ("Setting file position",
3985 Fcons (orig_filename, Qnil));
3989 if (NILP (val))
3991 /* If we have not yet decided a coding system, check
3992 file-coding-system-alist. */
3993 Lisp_Object args[6], coding_systems;
3995 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3996 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3997 coding_systems = Ffind_operation_coding_system (6, args);
3998 if (CONSP (coding_systems))
3999 val = XCAR (coding_systems);
4003 setup_coding_system (Fcheck_coding_system (val), &coding);
4004 /* Ensure we set Vlast_coding_system_used. */
4005 set_coding_system = 1;
4007 if (NILP (current_buffer->enable_multibyte_characters)
4008 && ! NILP (val))
4009 /* We must suppress all character code conversion except for
4010 end-of-line conversion. */
4011 setup_raw_text_coding_system (&coding);
4013 coding.src_multibyte = 0;
4014 coding.dst_multibyte
4015 = !NILP (current_buffer->enable_multibyte_characters);
4016 coding_system_decided = 1;
4019 /* If requested, replace the accessible part of the buffer
4020 with the file contents. Avoid replacing text at the
4021 beginning or end of the buffer that matches the file contents;
4022 that preserves markers pointing to the unchanged parts.
4024 Here we implement this feature in an optimized way
4025 for the case where code conversion is NOT needed.
4026 The following if-statement handles the case of conversion
4027 in a less optimal way.
4029 If the code conversion is "automatic" then we try using this
4030 method and hope for the best.
4031 But if we discover the need for conversion, we give up on this method
4032 and let the following if-statement handle the replace job. */
4033 if (!NILP (replace)
4034 && BEGV < ZV
4035 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4037 /* same_at_start and same_at_end count bytes,
4038 because file access counts bytes
4039 and BEG and END count bytes. */
4040 int same_at_start = BEGV_BYTE;
4041 int same_at_end = ZV_BYTE;
4042 int overlap;
4043 /* There is still a possibility we will find the need to do code
4044 conversion. If that happens, we set this variable to 1 to
4045 give up on handling REPLACE in the optimized way. */
4046 int giveup_match_end = 0;
4048 if (XINT (beg) != 0)
4050 if (lseek (fd, XINT (beg), 0) < 0)
4051 report_file_error ("Setting file position",
4052 Fcons (orig_filename, Qnil));
4055 immediate_quit = 1;
4056 QUIT;
4057 /* Count how many chars at the start of the file
4058 match the text at the beginning of the buffer. */
4059 while (1)
4061 int nread, bufpos;
4063 nread = emacs_read (fd, buffer, sizeof buffer);
4064 if (nread < 0)
4065 error ("IO error reading %s: %s",
4066 SDATA (orig_filename), emacs_strerror (errno));
4067 else if (nread == 0)
4068 break;
4070 if (coding.type == coding_type_undecided)
4071 detect_coding (&coding, buffer, nread);
4072 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4073 /* We found that the file should be decoded somehow.
4074 Let's give up here. */
4076 giveup_match_end = 1;
4077 break;
4080 if (coding.eol_type == CODING_EOL_UNDECIDED)
4081 detect_eol (&coding, buffer, nread);
4082 if (coding.eol_type != CODING_EOL_UNDECIDED
4083 && coding.eol_type != CODING_EOL_LF)
4084 /* We found that the format of eol should be decoded.
4085 Let's give up here. */
4087 giveup_match_end = 1;
4088 break;
4091 bufpos = 0;
4092 while (bufpos < nread && same_at_start < ZV_BYTE
4093 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4094 same_at_start++, bufpos++;
4095 /* If we found a discrepancy, stop the scan.
4096 Otherwise loop around and scan the next bufferful. */
4097 if (bufpos != nread)
4098 break;
4100 immediate_quit = 0;
4101 /* If the file matches the buffer completely,
4102 there's no need to replace anything. */
4103 if (same_at_start - BEGV_BYTE == XINT (end))
4105 emacs_close (fd);
4106 specpdl_ptr--;
4107 /* Truncate the buffer to the size of the file. */
4108 del_range_1 (same_at_start, same_at_end, 0, 0);
4109 goto handled;
4111 immediate_quit = 1;
4112 QUIT;
4113 /* Count how many chars at the end of the file
4114 match the text at the end of the buffer. But, if we have
4115 already found that decoding is necessary, don't waste time. */
4116 while (!giveup_match_end)
4118 int total_read, nread, bufpos, curpos, trial;
4120 /* At what file position are we now scanning? */
4121 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4122 /* If the entire file matches the buffer tail, stop the scan. */
4123 if (curpos == 0)
4124 break;
4125 /* How much can we scan in the next step? */
4126 trial = min (curpos, sizeof buffer);
4127 if (lseek (fd, curpos - trial, 0) < 0)
4128 report_file_error ("Setting file position",
4129 Fcons (orig_filename, Qnil));
4131 total_read = nread = 0;
4132 while (total_read < trial)
4134 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4135 if (nread < 0)
4136 error ("IO error reading %s: %s",
4137 SDATA (orig_filename), emacs_strerror (errno));
4138 else if (nread == 0)
4139 break;
4140 total_read += nread;
4143 /* Scan this bufferful from the end, comparing with
4144 the Emacs buffer. */
4145 bufpos = total_read;
4147 /* Compare with same_at_start to avoid counting some buffer text
4148 as matching both at the file's beginning and at the end. */
4149 while (bufpos > 0 && same_at_end > same_at_start
4150 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4151 same_at_end--, bufpos--;
4153 /* If we found a discrepancy, stop the scan.
4154 Otherwise loop around and scan the preceding bufferful. */
4155 if (bufpos != 0)
4157 /* If this discrepancy is because of code conversion,
4158 we cannot use this method; giveup and try the other. */
4159 if (same_at_end > same_at_start
4160 && FETCH_BYTE (same_at_end - 1) >= 0200
4161 && ! NILP (current_buffer->enable_multibyte_characters)
4162 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4163 giveup_match_end = 1;
4164 break;
4167 if (nread == 0)
4168 break;
4170 immediate_quit = 0;
4172 if (! giveup_match_end)
4174 int temp;
4176 /* We win! We can handle REPLACE the optimized way. */
4178 /* Extend the start of non-matching text area to multibyte
4179 character boundary. */
4180 if (! NILP (current_buffer->enable_multibyte_characters))
4181 while (same_at_start > BEGV_BYTE
4182 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4183 same_at_start--;
4185 /* Extend the end of non-matching text area to multibyte
4186 character boundary. */
4187 if (! NILP (current_buffer->enable_multibyte_characters))
4188 while (same_at_end < ZV_BYTE
4189 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4190 same_at_end++;
4192 /* Don't try to reuse the same piece of text twice. */
4193 overlap = (same_at_start - BEGV_BYTE
4194 - (same_at_end + st.st_size - ZV));
4195 if (overlap > 0)
4196 same_at_end += overlap;
4198 /* Arrange to read only the nonmatching middle part of the file. */
4199 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4200 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4202 del_range_byte (same_at_start, same_at_end, 0);
4203 /* Insert from the file at the proper position. */
4204 temp = BYTE_TO_CHAR (same_at_start);
4205 SET_PT_BOTH (temp, same_at_start);
4207 /* If display currently starts at beginning of line,
4208 keep it that way. */
4209 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4210 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4212 replace_handled = 1;
4216 /* If requested, replace the accessible part of the buffer
4217 with the file contents. Avoid replacing text at the
4218 beginning or end of the buffer that matches the file contents;
4219 that preserves markers pointing to the unchanged parts.
4221 Here we implement this feature for the case where code conversion
4222 is needed, in a simple way that needs a lot of memory.
4223 The preceding if-statement handles the case of no conversion
4224 in a more optimized way. */
4225 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4227 int same_at_start = BEGV_BYTE;
4228 int same_at_end = ZV_BYTE;
4229 int overlap;
4230 int bufpos;
4231 /* Make sure that the gap is large enough. */
4232 int bufsize = 2 * st.st_size;
4233 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4234 int temp;
4236 /* First read the whole file, performing code conversion into
4237 CONVERSION_BUFFER. */
4239 if (lseek (fd, XINT (beg), 0) < 0)
4241 xfree (conversion_buffer);
4242 report_file_error ("Setting file position",
4243 Fcons (orig_filename, Qnil));
4246 total = st.st_size; /* Total bytes in the file. */
4247 how_much = 0; /* Bytes read from file so far. */
4248 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4249 unprocessed = 0; /* Bytes not processed in previous loop. */
4251 while (how_much < total)
4253 /* try is reserved in some compilers (Microsoft C) */
4254 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4255 unsigned char *destination = read_buf + unprocessed;
4256 int this;
4258 /* Allow quitting out of the actual I/O. */
4259 immediate_quit = 1;
4260 QUIT;
4261 this = emacs_read (fd, destination, trytry);
4262 immediate_quit = 0;
4264 if (this < 0 || this + unprocessed == 0)
4266 how_much = this;
4267 break;
4270 how_much += this;
4272 if (CODING_MAY_REQUIRE_DECODING (&coding))
4274 int require, result;
4276 this += unprocessed;
4278 /* If we are using more space than estimated,
4279 make CONVERSION_BUFFER bigger. */
4280 require = decoding_buffer_size (&coding, this);
4281 if (inserted + require + 2 * (total - how_much) > bufsize)
4283 bufsize = inserted + require + 2 * (total - how_much);
4284 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4287 /* Convert this batch with results in CONVERSION_BUFFER. */
4288 if (how_much >= total) /* This is the last block. */
4289 coding.mode |= CODING_MODE_LAST_BLOCK;
4290 if (coding.composing != COMPOSITION_DISABLED)
4291 coding_allocate_composition_data (&coding, BEGV);
4292 result = decode_coding (&coding, read_buf,
4293 conversion_buffer + inserted,
4294 this, bufsize - inserted);
4296 /* Save for next iteration whatever we didn't convert. */
4297 unprocessed = this - coding.consumed;
4298 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4299 if (!NILP (current_buffer->enable_multibyte_characters))
4300 this = coding.produced;
4301 else
4302 this = str_as_unibyte (conversion_buffer + inserted,
4303 coding.produced);
4306 inserted += this;
4309 /* At this point, INSERTED is how many characters (i.e. bytes)
4310 are present in CONVERSION_BUFFER.
4311 HOW_MUCH should equal TOTAL,
4312 or should be <= 0 if we couldn't read the file. */
4314 if (how_much < 0)
4316 xfree (conversion_buffer);
4317 coding_free_composition_data (&coding);
4318 error ("IO error reading %s: %s",
4319 SDATA (orig_filename), emacs_strerror (errno));
4322 /* Compare the beginning of the converted file
4323 with the buffer text. */
4325 bufpos = 0;
4326 while (bufpos < inserted && same_at_start < same_at_end
4327 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4328 same_at_start++, bufpos++;
4330 /* If the file matches the buffer completely,
4331 there's no need to replace anything. */
4333 if (bufpos == inserted)
4335 xfree (conversion_buffer);
4336 coding_free_composition_data (&coding);
4337 emacs_close (fd);
4338 specpdl_ptr--;
4339 /* Truncate the buffer to the size of the file. */
4340 del_range_byte (same_at_start, same_at_end, 0);
4341 inserted = 0;
4342 goto handled;
4345 /* Extend the start of non-matching text area to multibyte
4346 character boundary. */
4347 if (! NILP (current_buffer->enable_multibyte_characters))
4348 while (same_at_start > BEGV_BYTE
4349 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4350 same_at_start--;
4352 /* Scan this bufferful from the end, comparing with
4353 the Emacs buffer. */
4354 bufpos = inserted;
4356 /* Compare with same_at_start to avoid counting some buffer text
4357 as matching both at the file's beginning and at the end. */
4358 while (bufpos > 0 && same_at_end > same_at_start
4359 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4360 same_at_end--, bufpos--;
4362 /* Extend the end of non-matching text area to multibyte
4363 character boundary. */
4364 if (! NILP (current_buffer->enable_multibyte_characters))
4365 while (same_at_end < ZV_BYTE
4366 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4367 same_at_end++;
4369 /* Don't try to reuse the same piece of text twice. */
4370 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4371 if (overlap > 0)
4372 same_at_end += overlap;
4374 /* If display currently starts at beginning of line,
4375 keep it that way. */
4376 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4377 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4379 /* Replace the chars that we need to replace,
4380 and update INSERTED to equal the number of bytes
4381 we are taking from the file. */
4382 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4384 if (same_at_end != same_at_start)
4386 del_range_byte (same_at_start, same_at_end, 0);
4387 temp = GPT;
4388 same_at_start = GPT_BYTE;
4390 else
4392 temp = BYTE_TO_CHAR (same_at_start);
4394 /* Insert from the file at the proper position. */
4395 SET_PT_BOTH (temp, same_at_start);
4396 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4397 0, 0, 0);
4398 if (coding.cmp_data && coding.cmp_data->used)
4399 coding_restore_composition (&coding, Fcurrent_buffer ());
4400 coding_free_composition_data (&coding);
4402 /* Set `inserted' to the number of inserted characters. */
4403 inserted = PT - temp;
4404 /* Set point before the inserted characters. */
4405 SET_PT_BOTH (temp, same_at_start);
4407 xfree (conversion_buffer);
4408 emacs_close (fd);
4409 specpdl_ptr--;
4411 goto handled;
4414 if (! not_regular)
4416 register Lisp_Object temp;
4418 total = XINT (end) - XINT (beg);
4420 /* Make sure point-max won't overflow after this insertion. */
4421 XSETINT (temp, total);
4422 if (total != XINT (temp))
4423 error ("Maximum buffer size exceeded");
4425 else
4426 /* For a special file, all we can do is guess. */
4427 total = READ_BUF_SIZE;
4429 if (NILP (visit) && inserted > 0)
4431 #ifdef CLASH_DETECTION
4432 if (!NILP (current_buffer->file_truename)
4433 /* Make binding buffer-file-name to nil effective. */
4434 && !NILP (current_buffer->filename)
4435 && SAVE_MODIFF >= MODIFF)
4436 we_locked_file = 1;
4437 #endif /* CLASH_DETECTION */
4438 prepare_to_modify_buffer (GPT, GPT, NULL);
4441 move_gap (PT);
4442 if (GAP_SIZE < total)
4443 make_gap (total - GAP_SIZE);
4445 if (XINT (beg) != 0 || !NILP (replace))
4447 if (lseek (fd, XINT (beg), 0) < 0)
4448 report_file_error ("Setting file position",
4449 Fcons (orig_filename, Qnil));
4452 /* In the following loop, HOW_MUCH contains the total bytes read so
4453 far for a regular file, and not changed for a special file. But,
4454 before exiting the loop, it is set to a negative value if I/O
4455 error occurs. */
4456 how_much = 0;
4458 /* Total bytes inserted. */
4459 inserted = 0;
4461 /* Here, we don't do code conversion in the loop. It is done by
4462 code_convert_region after all data are read into the buffer. */
4464 int gap_size = GAP_SIZE;
4466 while (how_much < total)
4468 /* try is reserved in some compilers (Microsoft C) */
4469 int trytry = min (total - how_much, READ_BUF_SIZE);
4470 int this;
4472 if (not_regular)
4474 Lisp_Object val;
4476 /* Maybe make more room. */
4477 if (gap_size < trytry)
4479 make_gap (total - gap_size);
4480 gap_size = GAP_SIZE;
4483 /* Read from the file, capturing `quit'. When an
4484 error occurs, end the loop, and arrange for a quit
4485 to be signaled after decoding the text we read. */
4486 non_regular_fd = fd;
4487 non_regular_inserted = inserted;
4488 non_regular_nbytes = trytry;
4489 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4490 read_non_regular_quit);
4491 if (NILP (val))
4493 read_quit = 1;
4494 break;
4497 this = XINT (val);
4499 else
4501 /* Allow quitting out of the actual I/O. We don't make text
4502 part of the buffer until all the reading is done, so a C-g
4503 here doesn't do any harm. */
4504 immediate_quit = 1;
4505 QUIT;
4506 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4507 immediate_quit = 0;
4510 if (this <= 0)
4512 how_much = this;
4513 break;
4516 gap_size -= this;
4518 /* For a regular file, where TOTAL is the real size,
4519 count HOW_MUCH to compare with it.
4520 For a special file, where TOTAL is just a buffer size,
4521 so don't bother counting in HOW_MUCH.
4522 (INSERTED is where we count the number of characters inserted.) */
4523 if (! not_regular)
4524 how_much += this;
4525 inserted += this;
4529 /* Now we have read all the file data into the gap.
4530 If it was empty, undo marking the buffer modified. */
4532 if (inserted == 0)
4534 #ifdef CLASH_DETECTION
4535 if (we_locked_file)
4536 unlock_file (current_buffer->file_truename);
4537 #endif
4538 Vdeactivate_mark = old_Vdeactivate_mark;
4540 else
4541 Vdeactivate_mark = Qt;
4543 /* Make the text read part of the buffer. */
4544 GAP_SIZE -= inserted;
4545 GPT += inserted;
4546 GPT_BYTE += inserted;
4547 ZV += inserted;
4548 ZV_BYTE += inserted;
4549 Z += inserted;
4550 Z_BYTE += inserted;
4552 if (GAP_SIZE > 0)
4553 /* Put an anchor to ensure multi-byte form ends at gap. */
4554 *GPT_ADDR = 0;
4556 emacs_close (fd);
4558 /* Discard the unwind protect for closing the file. */
4559 specpdl_ptr--;
4561 if (how_much < 0)
4562 error ("IO error reading %s: %s",
4563 SDATA (orig_filename), emacs_strerror (errno));
4565 notfound:
4567 if (! coding_system_decided)
4569 /* The coding system is not yet decided. Decide it by an
4570 optimized method for handling `coding:' tag.
4572 Note that we can get here only if the buffer was empty
4573 before the insertion. */
4574 Lisp_Object val;
4575 val = Qnil;
4577 if (!NILP (Vcoding_system_for_read))
4578 val = Vcoding_system_for_read;
4579 else
4581 /* Since we are sure that the current buffer was empty
4582 before the insertion, we can toggle
4583 enable-multibyte-characters directly here without taking
4584 care of marker adjustment and byte combining problem. By
4585 this way, we can run Lisp program safely before decoding
4586 the inserted text. */
4587 Lisp_Object unwind_data;
4588 int count = SPECPDL_INDEX ();
4590 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4591 Fcons (current_buffer->undo_list,
4592 Fcurrent_buffer ()));
4593 current_buffer->enable_multibyte_characters = Qnil;
4594 current_buffer->undo_list = Qt;
4595 record_unwind_protect (decide_coding_unwind, unwind_data);
4597 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4599 val = call2 (Vset_auto_coding_function,
4600 filename, make_number (inserted));
4603 if (NILP (val))
4605 /* If the coding system is not yet decided, check
4606 file-coding-system-alist. */
4607 Lisp_Object args[6], coding_systems;
4609 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4610 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4611 coding_systems = Ffind_operation_coding_system (6, args);
4612 if (CONSP (coding_systems))
4613 val = XCAR (coding_systems);
4615 unbind_to (count, Qnil);
4616 inserted = Z_BYTE - BEG_BYTE;
4619 /* The following kludgy code is to avoid some compiler bug.
4620 We can't simply do
4621 setup_coding_system (val, &coding);
4622 on some system. */
4624 struct coding_system temp_coding;
4625 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4626 bcopy (&temp_coding, &coding, sizeof coding);
4628 /* Ensure we set Vlast_coding_system_used. */
4629 set_coding_system = 1;
4631 if (NILP (current_buffer->enable_multibyte_characters)
4632 && ! NILP (val))
4633 /* We must suppress all character code conversion except for
4634 end-of-line conversion. */
4635 setup_raw_text_coding_system (&coding);
4636 coding.src_multibyte = 0;
4637 coding.dst_multibyte
4638 = !NILP (current_buffer->enable_multibyte_characters);
4641 if (!NILP (visit)
4642 /* Can't do this if part of the buffer might be preserved. */
4643 && NILP (replace)
4644 && (coding.type == coding_type_no_conversion
4645 || coding.type == coding_type_raw_text))
4647 /* Visiting a file with these coding system makes the buffer
4648 unibyte. */
4649 current_buffer->enable_multibyte_characters = Qnil;
4650 coding.dst_multibyte = 0;
4653 if (inserted > 0 || coding.type == coding_type_ccl)
4655 if (CODING_MAY_REQUIRE_DECODING (&coding))
4657 if (coding.type == coding_type_ccl)
4658 coding.spec.ccl.decoder.quit_silently = 1;
4659 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4660 &coding, 0, 0);
4661 if (coding.type == coding_type_ccl)
4662 coding.spec.ccl.decoder.quit_silently = 0;
4663 if (coding.result == CODING_FINISH_INTERRUPT)
4665 /* Fixme: It is better that we report that the decoding
4666 was interruppted by the user, and the current buffer
4667 contents doesn't reflect the file correctly. */
4668 Fsignal (Qquit, Qnil);
4670 inserted = coding.produced_char;
4672 else
4673 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4674 inserted);
4677 /* Now INSERTED is measured in characters. */
4679 #ifdef DOS_NT
4680 /* Use the conversion type to determine buffer-file-type
4681 (find-buffer-file-type is now used to help determine the
4682 conversion). */
4683 if ((coding.eol_type == CODING_EOL_UNDECIDED
4684 || coding.eol_type == CODING_EOL_LF)
4685 && ! CODING_REQUIRE_DECODING (&coding))
4686 current_buffer->buffer_file_type = Qt;
4687 else
4688 current_buffer->buffer_file_type = Qnil;
4689 #endif
4691 handled:
4693 if (!NILP (visit))
4695 if (!EQ (current_buffer->undo_list, Qt))
4696 current_buffer->undo_list = Qnil;
4697 #ifdef APOLLO
4698 stat (SDATA (filename), &st);
4699 #endif
4701 if (NILP (handler))
4703 current_buffer->modtime = st.st_mtime;
4704 current_buffer->filename = orig_filename;
4707 SAVE_MODIFF = MODIFF;
4708 current_buffer->auto_save_modified = MODIFF;
4709 XSETFASTINT (current_buffer->save_length, Z - BEG);
4710 #ifdef CLASH_DETECTION
4711 if (NILP (handler))
4713 if (!NILP (current_buffer->file_truename))
4714 unlock_file (current_buffer->file_truename);
4715 unlock_file (filename);
4717 #endif /* CLASH_DETECTION */
4718 if (not_regular)
4719 xsignal2 (Qfile_error,
4720 build_string ("not a regular file"), orig_filename);
4723 if (set_coding_system)
4724 Vlast_coding_system_used = coding.symbol;
4726 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4728 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4729 visit);
4730 if (! NILP (insval))
4732 CHECK_NUMBER (insval);
4733 inserted = XFASTINT (insval);
4737 /* Decode file format */
4738 if (inserted > 0)
4740 int empty_undo_list_p = 0;
4742 /* If we're anyway going to discard undo information, don't
4743 record it in the first place. The buffer's undo list at this
4744 point is either nil or t when visiting a file. */
4745 if (!NILP (visit))
4747 empty_undo_list_p = NILP (current_buffer->undo_list);
4748 current_buffer->undo_list = Qt;
4751 insval = call3 (Qformat_decode,
4752 Qnil, make_number (inserted), visit);
4753 CHECK_NUMBER (insval);
4754 inserted = XFASTINT (insval);
4756 if (!NILP (visit))
4757 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4760 /* Call after-change hooks for the inserted text, aside from the case
4761 of normal visiting (not with REPLACE), which is done in a new buffer
4762 "before" the buffer is changed. */
4763 if (inserted > 0 && total > 0
4764 && (NILP (visit) || !NILP (replace)))
4766 signal_after_change (PT, 0, inserted);
4767 update_compositions (PT, PT, CHECK_BORDER);
4770 p = Vafter_insert_file_functions;
4771 while (CONSP (p))
4773 insval = call1 (XCAR (p), make_number (inserted));
4774 if (!NILP (insval))
4776 CHECK_NUMBER (insval);
4777 inserted = XFASTINT (insval);
4779 QUIT;
4780 p = XCDR (p);
4783 if (!NILP (visit)
4784 && current_buffer->modtime == -1)
4786 /* If visiting nonexistent file, return nil. */
4787 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4790 if (read_quit)
4791 Fsignal (Qquit, Qnil);
4793 /* ??? Retval needs to be dealt with in all cases consistently. */
4794 if (NILP (val))
4795 val = Fcons (orig_filename,
4796 Fcons (make_number (inserted),
4797 Qnil));
4799 RETURN_UNGCPRO (unbind_to (count, val));
4802 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4803 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4804 Lisp_Object, Lisp_Object));
4806 /* If build_annotations switched buffers, switch back to BUF.
4807 Kill the temporary buffer that was selected in the meantime.
4809 Since this kill only the last temporary buffer, some buffers remain
4810 not killed if build_annotations switched buffers more than once.
4811 -- K.Handa */
4813 static Lisp_Object
4814 build_annotations_unwind (buf)
4815 Lisp_Object buf;
4817 Lisp_Object tembuf;
4819 if (XBUFFER (buf) == current_buffer)
4820 return Qnil;
4821 tembuf = Fcurrent_buffer ();
4822 Fset_buffer (buf);
4823 Fkill_buffer (tembuf);
4824 return Qnil;
4827 /* Decide the coding-system to encode the data with. */
4829 void
4830 choose_write_coding_system (start, end, filename,
4831 append, visit, lockname, coding)
4832 Lisp_Object start, end, filename, append, visit, lockname;
4833 struct coding_system *coding;
4835 Lisp_Object val;
4837 if (auto_saving
4838 && NILP (Fstring_equal (current_buffer->filename,
4839 current_buffer->auto_save_file_name)))
4841 /* We use emacs-mule for auto saving... */
4842 setup_coding_system (Qemacs_mule, coding);
4843 /* ... but with the special flag to indicate not to strip off
4844 leading code of eight-bit-control chars. */
4845 coding->flags = 1;
4846 /* We force LF for end-of-line because that is faster. */
4847 coding->eol_type = CODING_EOL_LF;
4848 goto done_setup_coding;
4850 else if (!NILP (Vcoding_system_for_write))
4852 val = Vcoding_system_for_write;
4853 if (coding_system_require_warning
4854 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4855 /* Confirm that VAL can surely encode the current region. */
4856 val = call5 (Vselect_safe_coding_system_function,
4857 start, end, Fcons (Qt, Fcons (val, Qnil)),
4858 Qnil, filename);
4860 else
4862 /* If the variable `buffer-file-coding-system' is set locally,
4863 it means that the file was read with some kind of code
4864 conversion or the variable is explicitly set by users. We
4865 had better write it out with the same coding system even if
4866 `enable-multibyte-characters' is nil.
4868 If it is not set locally, we anyway have to convert EOL
4869 format if the default value of `buffer-file-coding-system'
4870 tells that it is not Unix-like (LF only) format. */
4871 int using_default_coding = 0;
4872 int force_raw_text = 0;
4874 val = current_buffer->buffer_file_coding_system;
4875 if (NILP (val)
4876 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4878 val = Qnil;
4879 if (NILP (current_buffer->enable_multibyte_characters))
4880 force_raw_text = 1;
4883 if (NILP (val))
4885 /* Check file-coding-system-alist. */
4886 Lisp_Object args[7], coding_systems;
4888 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4889 args[3] = filename; args[4] = append; args[5] = visit;
4890 args[6] = lockname;
4891 coding_systems = Ffind_operation_coding_system (7, args);
4892 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4893 val = XCDR (coding_systems);
4896 if (NILP (val)
4897 && !NILP (current_buffer->buffer_file_coding_system))
4899 /* If we still have not decided a coding system, use the
4900 default value of buffer-file-coding-system. */
4901 val = current_buffer->buffer_file_coding_system;
4902 using_default_coding = 1;
4905 if (!force_raw_text
4906 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4907 /* Confirm that VAL can surely encode the current region. */
4908 val = call5 (Vselect_safe_coding_system_function,
4909 start, end, val, Qnil, filename);
4911 setup_coding_system (Fcheck_coding_system (val), coding);
4912 if (coding->eol_type == CODING_EOL_UNDECIDED
4913 && !using_default_coding)
4915 if (! EQ (default_buffer_file_coding.symbol,
4916 buffer_defaults.buffer_file_coding_system))
4917 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4918 &default_buffer_file_coding);
4919 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4921 Lisp_Object subsidiaries;
4923 coding->eol_type = default_buffer_file_coding.eol_type;
4924 subsidiaries = Fget (coding->symbol, Qeol_type);
4925 if (VECTORP (subsidiaries)
4926 && XVECTOR (subsidiaries)->size == 3)
4927 coding->symbol
4928 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4932 if (force_raw_text)
4933 setup_raw_text_coding_system (coding);
4934 goto done_setup_coding;
4937 setup_coding_system (Fcheck_coding_system (val), coding);
4939 done_setup_coding:
4940 if (coding->eol_type == CODING_EOL_UNDECIDED)
4941 coding->eol_type = system_eol_type;
4942 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4943 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4946 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4947 "r\nFWrite region to file: \ni\ni\ni\np",
4948 doc: /* Write current region into specified file.
4949 When called from a program, requires three arguments:
4950 START, END and FILENAME. START and END are normally buffer positions
4951 specifying the part of the buffer to write.
4952 If START is nil, that means to use the entire buffer contents.
4953 If START is a string, then output that string to the file
4954 instead of any buffer contents; END is ignored.
4956 Optional fourth argument APPEND if non-nil means
4957 append to existing file contents (if any). If it is an integer,
4958 seek to that offset in the file before writing.
4959 Optional fifth argument VISIT, if t or a string, means
4960 set the last-save-file-modtime of buffer to this file's modtime
4961 and mark buffer not modified.
4962 If VISIT is a string, it is a second file name;
4963 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4964 VISIT is also the file name to lock and unlock for clash detection.
4965 If VISIT is neither t nor nil nor a string,
4966 that means do not display the \"Wrote file\" message.
4967 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4968 use for locking and unlocking, overriding FILENAME and VISIT.
4969 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4970 for an existing file with the same name. If MUSTBENEW is `excl',
4971 that means to get an error if the file already exists; never overwrite.
4972 If MUSTBENEW is neither nil nor `excl', that means ask for
4973 confirmation before overwriting, but do go ahead and overwrite the file
4974 if the user confirms.
4976 This does code conversion according to the value of
4977 `coding-system-for-write', `buffer-file-coding-system', or
4978 `file-coding-system-alist', and sets the variable
4979 `last-coding-system-used' to the coding system actually used. */)
4980 (start, end, filename, append, visit, lockname, mustbenew)
4981 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4983 register int desc;
4984 int failure;
4985 int save_errno = 0;
4986 const unsigned char *fn;
4987 struct stat st;
4988 int tem;
4989 int count = SPECPDL_INDEX ();
4990 int count1;
4991 #ifdef VMS
4992 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4993 #endif /* VMS */
4994 Lisp_Object handler;
4995 Lisp_Object visit_file;
4996 Lisp_Object annotations;
4997 Lisp_Object encoded_filename;
4998 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4999 int quietly = !NILP (visit);
5000 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5001 struct buffer *given_buffer;
5002 #ifdef DOS_NT
5003 int buffer_file_type = O_BINARY;
5004 #endif /* DOS_NT */
5005 struct coding_system coding;
5007 if (current_buffer->base_buffer && visiting)
5008 error ("Cannot do file visiting in an indirect buffer");
5010 if (!NILP (start) && !STRINGP (start))
5011 validate_region (&start, &end);
5013 visit_file = Qnil;
5014 GCPRO5 (start, filename, visit, visit_file, lockname);
5016 filename = Fexpand_file_name (filename, Qnil);
5018 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5019 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5021 if (STRINGP (visit))
5022 visit_file = Fexpand_file_name (visit, Qnil);
5023 else
5024 visit_file = filename;
5026 if (NILP (lockname))
5027 lockname = visit_file;
5029 annotations = Qnil;
5031 /* If the file name has special constructs in it,
5032 call the corresponding file handler. */
5033 handler = Ffind_file_name_handler (filename, Qwrite_region);
5034 /* If FILENAME has no handler, see if VISIT has one. */
5035 if (NILP (handler) && STRINGP (visit))
5036 handler = Ffind_file_name_handler (visit, Qwrite_region);
5038 if (!NILP (handler))
5040 Lisp_Object val;
5041 val = call6 (handler, Qwrite_region, start, end,
5042 filename, append, visit);
5044 if (visiting)
5046 SAVE_MODIFF = MODIFF;
5047 XSETFASTINT (current_buffer->save_length, Z - BEG);
5048 current_buffer->filename = visit_file;
5050 UNGCPRO;
5051 return val;
5054 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5056 /* Special kludge to simplify auto-saving. */
5057 if (NILP (start))
5059 XSETFASTINT (start, BEG);
5060 XSETFASTINT (end, Z);
5061 Fwiden ();
5064 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5065 count1 = SPECPDL_INDEX ();
5067 given_buffer = current_buffer;
5069 if (!STRINGP (start))
5071 annotations = build_annotations (start, end);
5073 if (current_buffer != given_buffer)
5075 XSETFASTINT (start, BEGV);
5076 XSETFASTINT (end, ZV);
5080 UNGCPRO;
5082 GCPRO5 (start, filename, annotations, visit_file, lockname);
5084 /* Decide the coding-system to encode the data with.
5085 We used to make this choice before calling build_annotations, but that
5086 leads to problems when a write-annotate-function takes care of
5087 unsavable chars (as was the case with X-Symbol). */
5088 choose_write_coding_system (start, end, filename,
5089 append, visit, lockname, &coding);
5090 Vlast_coding_system_used = coding.symbol;
5092 given_buffer = current_buffer;
5093 if (! STRINGP (start))
5095 annotations = build_annotations_2 (start, end,
5096 coding.pre_write_conversion, annotations);
5097 if (current_buffer != given_buffer)
5099 XSETFASTINT (start, BEGV);
5100 XSETFASTINT (end, ZV);
5104 #ifdef CLASH_DETECTION
5105 if (!auto_saving)
5107 #if 0 /* This causes trouble for GNUS. */
5108 /* If we've locked this file for some other buffer,
5109 query before proceeding. */
5110 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5111 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5112 #endif
5114 lock_file (lockname);
5116 #endif /* CLASH_DETECTION */
5118 encoded_filename = ENCODE_FILE (filename);
5120 fn = SDATA (encoded_filename);
5121 desc = -1;
5122 if (!NILP (append))
5123 #ifdef DOS_NT
5124 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5125 #else /* not DOS_NT */
5126 desc = emacs_open (fn, O_WRONLY, 0);
5127 #endif /* not DOS_NT */
5129 if (desc < 0 && (NILP (append) || errno == ENOENT))
5130 #ifdef VMS
5131 if (auto_saving) /* Overwrite any previous version of autosave file */
5133 vms_truncate (fn); /* if fn exists, truncate to zero length */
5134 desc = emacs_open (fn, O_RDWR, 0);
5135 if (desc < 0)
5136 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5137 ? SDATA (current_buffer->filename) : 0,
5138 fn);
5140 else /* Write to temporary name and rename if no errors */
5142 Lisp_Object temp_name;
5143 temp_name = Ffile_name_directory (filename);
5145 if (!NILP (temp_name))
5147 temp_name = Fmake_temp_name (concat2 (temp_name,
5148 build_string ("$$SAVE$$")));
5149 fname = SDATA (filename);
5150 fn = SDATA (temp_name);
5151 desc = creat_copy_attrs (fname, fn);
5152 if (desc < 0)
5154 /* If we can't open the temporary file, try creating a new
5155 version of the original file. VMS "creat" creates a
5156 new version rather than truncating an existing file. */
5157 fn = fname;
5158 fname = 0;
5159 desc = creat (fn, 0666);
5160 #if 0 /* This can clobber an existing file and fail to replace it,
5161 if the user runs out of space. */
5162 if (desc < 0)
5164 /* We can't make a new version;
5165 try to truncate and rewrite existing version if any. */
5166 vms_truncate (fn);
5167 desc = emacs_open (fn, O_RDWR, 0);
5169 #endif
5172 else
5173 desc = creat (fn, 0666);
5175 #else /* not VMS */
5176 #ifdef DOS_NT
5177 desc = emacs_open (fn,
5178 O_WRONLY | O_CREAT | buffer_file_type
5179 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5180 S_IREAD | S_IWRITE);
5181 #else /* not DOS_NT */
5182 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5183 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5184 auto_saving ? auto_save_mode_bits : 0666);
5185 #endif /* not DOS_NT */
5186 #endif /* not VMS */
5188 if (desc < 0)
5190 #ifdef CLASH_DETECTION
5191 save_errno = errno;
5192 if (!auto_saving) unlock_file (lockname);
5193 errno = save_errno;
5194 #endif /* CLASH_DETECTION */
5195 UNGCPRO;
5196 report_file_error ("Opening output file", Fcons (filename, Qnil));
5199 record_unwind_protect (close_file_unwind, make_number (desc));
5201 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5203 long ret;
5205 if (NUMBERP (append))
5206 ret = lseek (desc, XINT (append), 1);
5207 else
5208 ret = lseek (desc, 0, 2);
5209 if (ret < 0)
5211 #ifdef CLASH_DETECTION
5212 if (!auto_saving) unlock_file (lockname);
5213 #endif /* CLASH_DETECTION */
5214 UNGCPRO;
5215 report_file_error ("Lseek error", Fcons (filename, Qnil));
5219 UNGCPRO;
5221 #ifdef VMS
5223 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5224 * if we do writes that don't end with a carriage return. Furthermore
5225 * it cannot handle writes of more then 16K. The modified
5226 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5227 * this EXCEPT for the last record (if it doesn't end with a carriage
5228 * return). This implies that if your buffer doesn't end with a carriage
5229 * return, you get one free... tough. However it also means that if
5230 * we make two calls to sys_write (a la the following code) you can
5231 * get one at the gap as well. The easiest way to fix this (honest)
5232 * is to move the gap to the next newline (or the end of the buffer).
5233 * Thus this change.
5235 * Yech!
5237 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5238 move_gap (find_next_newline (GPT, 1));
5239 #else
5240 /* Whether VMS or not, we must move the gap to the next of newline
5241 when we must put designation sequences at beginning of line. */
5242 if (INTEGERP (start)
5243 && coding.type == coding_type_iso2022
5244 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5245 && GPT > BEG && GPT_ADDR[-1] != '\n')
5247 int opoint = PT, opoint_byte = PT_BYTE;
5248 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5249 move_gap_both (PT, PT_BYTE);
5250 SET_PT_BOTH (opoint, opoint_byte);
5252 #endif
5254 failure = 0;
5255 immediate_quit = 1;
5257 if (STRINGP (start))
5259 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5260 &annotations, &coding);
5261 save_errno = errno;
5263 else if (XINT (start) != XINT (end))
5265 tem = CHAR_TO_BYTE (XINT (start));
5267 if (XINT (start) < GPT)
5269 failure = 0 > a_write (desc, Qnil, XINT (start),
5270 min (GPT, XINT (end)) - XINT (start),
5271 &annotations, &coding);
5272 save_errno = errno;
5275 if (XINT (end) > GPT && !failure)
5277 tem = max (XINT (start), GPT);
5278 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5279 &annotations, &coding);
5280 save_errno = errno;
5283 else
5285 /* If file was empty, still need to write the annotations */
5286 coding.mode |= CODING_MODE_LAST_BLOCK;
5287 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5288 save_errno = errno;
5291 if (CODING_REQUIRE_FLUSHING (&coding)
5292 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5293 && ! failure)
5295 /* We have to flush out a data. */
5296 coding.mode |= CODING_MODE_LAST_BLOCK;
5297 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5298 save_errno = errno;
5301 immediate_quit = 0;
5303 #ifdef HAVE_FSYNC
5304 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5305 Disk full in NFS may be reported here. */
5306 /* mib says that closing the file will try to write as fast as NFS can do
5307 it, and that means the fsync here is not crucial for autosave files. */
5308 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5310 /* If fsync fails with EINTR, don't treat that as serious. Also
5311 ignore EINVAL which happens when fsync is not supported on this
5312 file. */
5313 if (errno != EINTR && errno != EINVAL)
5314 failure = 1, save_errno = errno;
5316 #endif
5318 /* Spurious "file has changed on disk" warnings have been
5319 observed on Suns as well.
5320 It seems that `close' can change the modtime, under nfs.
5322 (This has supposedly been fixed in Sunos 4,
5323 but who knows about all the other machines with NFS?) */
5324 #if 0
5326 /* On VMS and APOLLO, must do the stat after the close
5327 since closing changes the modtime. */
5328 #ifndef VMS
5329 #ifndef APOLLO
5330 /* Recall that #if defined does not work on VMS. */
5331 #define FOO
5332 fstat (desc, &st);
5333 #endif
5334 #endif
5335 #endif
5337 /* NFS can report a write failure now. */
5338 if (emacs_close (desc) < 0)
5339 failure = 1, save_errno = errno;
5341 #ifdef VMS
5342 /* If we wrote to a temporary name and had no errors, rename to real name. */
5343 if (fname)
5345 if (!failure)
5346 failure = (rename (fn, fname) != 0), save_errno = errno;
5347 fn = fname;
5349 #endif /* VMS */
5351 #ifndef FOO
5352 stat (fn, &st);
5353 #endif
5354 /* Discard the unwind protect for close_file_unwind. */
5355 specpdl_ptr = specpdl + count1;
5356 /* Restore the original current buffer. */
5357 visit_file = unbind_to (count, visit_file);
5359 #ifdef CLASH_DETECTION
5360 if (!auto_saving)
5361 unlock_file (lockname);
5362 #endif /* CLASH_DETECTION */
5364 /* Do this before reporting IO error
5365 to avoid a "file has changed on disk" warning on
5366 next attempt to save. */
5367 if (visiting)
5368 current_buffer->modtime = st.st_mtime;
5370 if (failure)
5371 error ("IO error writing %s: %s", SDATA (filename),
5372 emacs_strerror (save_errno));
5374 if (visiting)
5376 SAVE_MODIFF = MODIFF;
5377 XSETFASTINT (current_buffer->save_length, Z - BEG);
5378 current_buffer->filename = visit_file;
5379 update_mode_lines++;
5381 else if (quietly)
5383 if (auto_saving
5384 && ! NILP (Fstring_equal (current_buffer->filename,
5385 current_buffer->auto_save_file_name)))
5386 SAVE_MODIFF = MODIFF;
5388 return Qnil;
5391 if (!auto_saving)
5392 message_with_string ((INTEGERP (append)
5393 ? "Updated %s"
5394 : ! NILP (append)
5395 ? "Added to %s"
5396 : "Wrote %s"),
5397 visit_file, 1);
5399 return Qnil;
5402 Lisp_Object merge ();
5404 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5405 doc: /* Return t if (car A) is numerically less than (car B). */)
5406 (a, b)
5407 Lisp_Object a, b;
5409 return Flss (Fcar (a), Fcar (b));
5412 /* Build the complete list of annotations appropriate for writing out
5413 the text between START and END, by calling all the functions in
5414 write-region-annotate-functions and merging the lists they return.
5415 If one of these functions switches to a different buffer, we assume
5416 that buffer contains altered text. Therefore, the caller must
5417 make sure to restore the current buffer in all cases,
5418 as save-excursion would do. */
5420 static Lisp_Object
5421 build_annotations (start, end)
5422 Lisp_Object start, end;
5424 Lisp_Object annotations;
5425 Lisp_Object p, res;
5426 struct gcpro gcpro1, gcpro2;
5427 Lisp_Object original_buffer;
5428 int i, used_global = 0;
5430 XSETBUFFER (original_buffer, current_buffer);
5432 annotations = Qnil;
5433 p = Vwrite_region_annotate_functions;
5434 GCPRO2 (annotations, p);
5435 while (CONSP (p))
5437 struct buffer *given_buffer = current_buffer;
5438 if (EQ (Qt, XCAR (p)) && !used_global)
5439 { /* Use the global value of the hook. */
5440 Lisp_Object arg[2];
5441 used_global = 1;
5442 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5443 arg[1] = XCDR (p);
5444 p = Fappend (2, arg);
5445 continue;
5447 Vwrite_region_annotations_so_far = annotations;
5448 res = call2 (XCAR (p), start, end);
5449 /* If the function makes a different buffer current,
5450 assume that means this buffer contains altered text to be output.
5451 Reset START and END from the buffer bounds
5452 and discard all previous annotations because they should have
5453 been dealt with by this function. */
5454 if (current_buffer != given_buffer)
5456 XSETFASTINT (start, BEGV);
5457 XSETFASTINT (end, ZV);
5458 annotations = Qnil;
5460 Flength (res); /* Check basic validity of return value */
5461 annotations = merge (annotations, res, Qcar_less_than_car);
5462 p = XCDR (p);
5465 /* Now do the same for annotation functions implied by the file-format */
5466 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5467 p = current_buffer->auto_save_file_format;
5468 else
5469 p = current_buffer->file_format;
5470 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5472 struct buffer *given_buffer = current_buffer;
5474 Vwrite_region_annotations_so_far = annotations;
5476 /* Value is either a list of annotations or nil if the function
5477 has written annotations to a temporary buffer, which is now
5478 current. */
5479 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5480 original_buffer, make_number (i));
5481 if (current_buffer != given_buffer)
5483 XSETFASTINT (start, BEGV);
5484 XSETFASTINT (end, ZV);
5485 annotations = Qnil;
5488 if (CONSP (res))
5489 annotations = merge (annotations, res, Qcar_less_than_car);
5492 UNGCPRO;
5493 return annotations;
5496 static Lisp_Object
5497 build_annotations_2 (start, end, pre_write_conversion, annotations)
5498 Lisp_Object start, end, pre_write_conversion, annotations;
5500 struct gcpro gcpro1;
5501 Lisp_Object res;
5503 GCPRO1 (annotations);
5504 /* At last, do the same for the function PRE_WRITE_CONVERSION
5505 implied by the current coding-system. */
5506 if (!NILP (pre_write_conversion))
5508 struct buffer *given_buffer = current_buffer;
5509 Vwrite_region_annotations_so_far = annotations;
5510 res = call2 (pre_write_conversion, start, end);
5511 Flength (res);
5512 annotations = (current_buffer != given_buffer
5513 ? res
5514 : merge (annotations, res, Qcar_less_than_car));
5517 UNGCPRO;
5518 return annotations;
5521 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5522 If STRING is nil, POS is the character position in the current buffer.
5523 Intersperse with them the annotations from *ANNOT
5524 which fall within the range of POS to POS + NCHARS,
5525 each at its appropriate position.
5527 We modify *ANNOT by discarding elements as we use them up.
5529 The return value is negative in case of system call failure. */
5531 static int
5532 a_write (desc, string, pos, nchars, annot, coding)
5533 int desc;
5534 Lisp_Object string;
5535 register int nchars;
5536 int pos;
5537 Lisp_Object *annot;
5538 struct coding_system *coding;
5540 Lisp_Object tem;
5541 int nextpos;
5542 int lastpos = pos + nchars;
5544 while (NILP (*annot) || CONSP (*annot))
5546 tem = Fcar_safe (Fcar (*annot));
5547 nextpos = pos - 1;
5548 if (INTEGERP (tem))
5549 nextpos = XFASTINT (tem);
5551 /* If there are no more annotations in this range,
5552 output the rest of the range all at once. */
5553 if (! (nextpos >= pos && nextpos <= lastpos))
5554 return e_write (desc, string, pos, lastpos, coding);
5556 /* Output buffer text up to the next annotation's position. */
5557 if (nextpos > pos)
5559 if (0 > e_write (desc, string, pos, nextpos, coding))
5560 return -1;
5561 pos = nextpos;
5563 /* Output the annotation. */
5564 tem = Fcdr (Fcar (*annot));
5565 if (STRINGP (tem))
5567 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5568 return -1;
5570 *annot = Fcdr (*annot);
5572 return 0;
5575 #ifndef WRITE_BUF_SIZE
5576 #define WRITE_BUF_SIZE (16 * 1024)
5577 #endif
5579 /* Write text in the range START and END into descriptor DESC,
5580 encoding them with coding system CODING. If STRING is nil, START
5581 and END are character positions of the current buffer, else they
5582 are indexes to the string STRING. */
5584 static int
5585 e_write (desc, string, start, end, coding)
5586 int desc;
5587 Lisp_Object string;
5588 int start, end;
5589 struct coding_system *coding;
5591 register char *addr;
5592 register int nbytes;
5593 char buf[WRITE_BUF_SIZE];
5594 int return_val = 0;
5596 if (start >= end)
5597 coding->composing = COMPOSITION_DISABLED;
5598 if (coding->composing != COMPOSITION_DISABLED)
5599 coding_save_composition (coding, start, end, string);
5601 if (STRINGP (string))
5603 addr = SDATA (string);
5604 nbytes = SBYTES (string);
5605 coding->src_multibyte = STRING_MULTIBYTE (string);
5607 else if (start < end)
5609 /* It is assured that the gap is not in the range START and END-1. */
5610 addr = CHAR_POS_ADDR (start);
5611 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5612 coding->src_multibyte
5613 = !NILP (current_buffer->enable_multibyte_characters);
5615 else
5617 addr = "";
5618 nbytes = 0;
5619 coding->src_multibyte = 1;
5622 /* We used to have a code for handling selective display here. But,
5623 now it is handled within encode_coding. */
5624 while (1)
5626 int result;
5628 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5629 if (coding->produced > 0)
5631 coding->produced -= emacs_write (desc, buf, coding->produced);
5632 if (coding->produced)
5634 return_val = -1;
5635 break;
5638 nbytes -= coding->consumed;
5639 addr += coding->consumed;
5640 if (result == CODING_FINISH_INSUFFICIENT_SRC
5641 && nbytes > 0)
5643 /* The source text ends by an incomplete multibyte form.
5644 There's no way other than write it out as is. */
5645 nbytes -= emacs_write (desc, addr, nbytes);
5646 if (nbytes)
5648 return_val = -1;
5649 break;
5652 if (nbytes <= 0)
5653 break;
5654 start += coding->consumed_char;
5655 if (coding->cmp_data)
5656 coding_adjust_composition_offset (coding, start);
5659 if (coding->cmp_data)
5660 coding_free_composition_data (coding);
5662 return return_val;
5665 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5666 Sverify_visited_file_modtime, 1, 1, 0,
5667 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5668 This means that the file has not been changed since it was visited or saved.
5669 See Info node `(elisp)Modification Time' for more details. */)
5670 (buf)
5671 Lisp_Object buf;
5673 struct buffer *b;
5674 struct stat st;
5675 Lisp_Object handler;
5676 Lisp_Object filename;
5678 CHECK_BUFFER (buf);
5679 b = XBUFFER (buf);
5681 if (!STRINGP (b->filename)) return Qt;
5682 if (b->modtime == 0) return Qt;
5684 /* If the file name has special constructs in it,
5685 call the corresponding file handler. */
5686 handler = Ffind_file_name_handler (b->filename,
5687 Qverify_visited_file_modtime);
5688 if (!NILP (handler))
5689 return call2 (handler, Qverify_visited_file_modtime, buf);
5691 filename = ENCODE_FILE (b->filename);
5693 if (stat (SDATA (filename), &st) < 0)
5695 /* If the file doesn't exist now and didn't exist before,
5696 we say that it isn't modified, provided the error is a tame one. */
5697 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5698 st.st_mtime = -1;
5699 else
5700 st.st_mtime = 0;
5702 if (st.st_mtime == b->modtime
5703 /* If both are positive, accept them if they are off by one second. */
5704 || (st.st_mtime > 0 && b->modtime > 0
5705 && (st.st_mtime == b->modtime + 1
5706 || st.st_mtime == b->modtime - 1)))
5707 return Qt;
5708 return Qnil;
5711 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5712 Sclear_visited_file_modtime, 0, 0, 0,
5713 doc: /* Clear out records of last mod time of visited file.
5714 Next attempt to save will certainly not complain of a discrepancy. */)
5717 current_buffer->modtime = 0;
5718 return Qnil;
5721 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5722 Svisited_file_modtime, 0, 0, 0,
5723 doc: /* Return the current buffer's recorded visited file modification time.
5724 The value is a list of the form (HIGH LOW), like the time values
5725 that `file-attributes' returns. If the current buffer has no recorded
5726 file modification time, this function returns 0.
5727 See Info node `(elisp)Modification Time' for more details. */)
5730 if (! current_buffer->modtime)
5731 return make_number (0);
5732 return make_time ((time_t) current_buffer->modtime);
5735 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5736 Sset_visited_file_modtime, 0, 1, 0,
5737 doc: /* Update buffer's recorded modification time from the visited file's time.
5738 Useful if the buffer was not read from the file normally
5739 or if the file itself has been changed for some known benign reason.
5740 An argument specifies the modification time value to use
5741 \(instead of that of the visited file), in the form of a list
5742 \(HIGH . LOW) or (HIGH LOW). */)
5743 (time_list)
5744 Lisp_Object time_list;
5746 if (!NILP (time_list))
5747 current_buffer->modtime = cons_to_long (time_list);
5748 else
5750 register Lisp_Object filename;
5751 struct stat st;
5752 Lisp_Object handler;
5754 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5756 /* If the file name has special constructs in it,
5757 call the corresponding file handler. */
5758 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5759 if (!NILP (handler))
5760 /* The handler can find the file name the same way we did. */
5761 return call2 (handler, Qset_visited_file_modtime, Qnil);
5763 filename = ENCODE_FILE (filename);
5765 if (stat (SDATA (filename), &st) >= 0)
5766 current_buffer->modtime = st.st_mtime;
5769 return Qnil;
5772 Lisp_Object
5773 auto_save_error (error)
5774 Lisp_Object error;
5776 Lisp_Object args[3], msg;
5777 int i, nbytes;
5778 struct gcpro gcpro1;
5779 char *msgbuf;
5780 USE_SAFE_ALLOCA;
5782 auto_save_error_occurred = 1;
5784 ring_bell ();
5786 args[0] = build_string ("Auto-saving %s: %s");
5787 args[1] = current_buffer->name;
5788 args[2] = Ferror_message_string (error);
5789 msg = Fformat (3, args);
5790 GCPRO1 (msg);
5791 nbytes = SBYTES (msg);
5792 SAFE_ALLOCA (msgbuf, char *, nbytes);
5793 bcopy (SDATA (msg), msgbuf, nbytes);
5795 for (i = 0; i < 3; ++i)
5797 if (i == 0)
5798 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5799 else
5800 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5801 Fsleep_for (make_number (1), Qnil);
5804 SAFE_FREE ();
5805 UNGCPRO;
5806 return Qnil;
5809 Lisp_Object
5810 auto_save_1 ()
5812 struct stat st;
5813 Lisp_Object modes;
5815 auto_save_mode_bits = 0666;
5817 /* Get visited file's mode to become the auto save file's mode. */
5818 if (! NILP (current_buffer->filename))
5820 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5821 /* But make sure we can overwrite it later! */
5822 auto_save_mode_bits = st.st_mode | 0600;
5823 else if ((modes = Ffile_modes (current_buffer->filename),
5824 INTEGERP (modes)))
5825 /* Remote files don't cooperate with stat. */
5826 auto_save_mode_bits = XINT (modes) | 0600;
5829 return
5830 Fwrite_region (Qnil, Qnil, current_buffer->auto_save_file_name, Qnil,
5831 NILP (Vauto_save_visited_file_name) ? Qlambda : Qt,
5832 Qnil, Qnil);
5835 static Lisp_Object
5836 do_auto_save_unwind (arg) /* used as unwind-protect function */
5837 Lisp_Object arg;
5839 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5840 auto_saving = 0;
5841 if (stream != NULL)
5843 BLOCK_INPUT;
5844 fclose (stream);
5845 UNBLOCK_INPUT;
5847 return Qnil;
5850 static Lisp_Object
5851 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5852 Lisp_Object value;
5854 minibuffer_auto_raise = XINT (value);
5855 return Qnil;
5858 static Lisp_Object
5859 do_auto_save_make_dir (dir)
5860 Lisp_Object dir;
5862 Lisp_Object mode;
5864 call2 (Qmake_directory, dir, Qt);
5865 XSETFASTINT (mode, 0700);
5866 return Fset_file_modes (dir, mode);
5869 static Lisp_Object
5870 do_auto_save_eh (ignore)
5871 Lisp_Object ignore;
5873 return Qnil;
5876 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5877 doc: /* Auto-save all buffers that need it.
5878 This is all buffers that have auto-saving enabled
5879 and are changed since last auto-saved.
5880 Auto-saving writes the buffer into a file
5881 so that your editing is not lost if the system crashes.
5882 This file is not the file you visited; that changes only when you save.
5883 Normally we run the normal hook `auto-save-hook' before saving.
5885 A non-nil NO-MESSAGE argument means do not print any message if successful.
5886 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5887 (no_message, current_only)
5888 Lisp_Object no_message, current_only;
5890 struct buffer *old = current_buffer, *b;
5891 Lisp_Object tail, buf;
5892 int auto_saved = 0;
5893 int do_handled_files;
5894 Lisp_Object oquit;
5895 FILE *stream = NULL;
5896 int count = SPECPDL_INDEX ();
5897 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5898 int old_message_p = 0;
5899 struct gcpro gcpro1, gcpro2;
5901 if (max_specpdl_size < specpdl_size + 40)
5902 max_specpdl_size = specpdl_size + 40;
5904 if (minibuf_level)
5905 no_message = Qt;
5907 if (NILP (no_message))
5909 old_message_p = push_message ();
5910 record_unwind_protect (pop_message_unwind, Qnil);
5913 /* Ordinarily don't quit within this function,
5914 but don't make it impossible to quit (in case we get hung in I/O). */
5915 oquit = Vquit_flag;
5916 Vquit_flag = Qnil;
5918 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5919 point to non-strings reached from Vbuffer_alist. */
5921 if (!NILP (Vrun_hooks))
5922 call1 (Vrun_hooks, intern ("auto-save-hook"));
5924 if (STRINGP (Vauto_save_list_file_name))
5926 Lisp_Object listfile;
5928 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5930 /* Don't try to create the directory when shutting down Emacs,
5931 because creating the directory might signal an error, and
5932 that would leave Emacs in a strange state. */
5933 if (!NILP (Vrun_hooks))
5935 Lisp_Object dir;
5936 dir = Qnil;
5937 GCPRO2 (dir, listfile);
5938 dir = Ffile_name_directory (listfile);
5939 if (NILP (Ffile_directory_p (dir)))
5940 internal_condition_case_1 (do_auto_save_make_dir,
5941 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5942 do_auto_save_eh);
5943 UNGCPRO;
5946 stream = fopen (SDATA (listfile), "w");
5949 record_unwind_protect (do_auto_save_unwind,
5950 make_save_value (stream, 0));
5951 record_unwind_protect (do_auto_save_unwind_1,
5952 make_number (minibuffer_auto_raise));
5953 minibuffer_auto_raise = 0;
5954 auto_saving = 1;
5955 auto_save_error_occurred = 0;
5957 /* On first pass, save all files that don't have handlers.
5958 On second pass, save all files that do have handlers.
5960 If Emacs is crashing, the handlers may tweak what is causing
5961 Emacs to crash in the first place, and it would be a shame if
5962 Emacs failed to autosave perfectly ordinary files because it
5963 couldn't handle some ange-ftp'd file. */
5965 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5966 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5968 buf = XCDR (XCAR (tail));
5969 b = XBUFFER (buf);
5971 /* Record all the buffers that have auto save mode
5972 in the special file that lists them. For each of these buffers,
5973 Record visited name (if any) and auto save name. */
5974 if (STRINGP (b->auto_save_file_name)
5975 && stream != NULL && do_handled_files == 0)
5977 BLOCK_INPUT;
5978 if (!NILP (b->filename))
5980 fwrite (SDATA (b->filename), 1,
5981 SBYTES (b->filename), stream);
5983 putc ('\n', stream);
5984 fwrite (SDATA (b->auto_save_file_name), 1,
5985 SBYTES (b->auto_save_file_name), stream);
5986 putc ('\n', stream);
5987 UNBLOCK_INPUT;
5990 if (!NILP (current_only)
5991 && b != current_buffer)
5992 continue;
5994 /* Don't auto-save indirect buffers.
5995 The base buffer takes care of it. */
5996 if (b->base_buffer)
5997 continue;
5999 /* Check for auto save enabled
6000 and file changed since last auto save
6001 and file changed since last real save. */
6002 if (STRINGP (b->auto_save_file_name)
6003 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
6004 && b->auto_save_modified < BUF_MODIFF (b)
6005 /* -1 means we've turned off autosaving for a while--see below. */
6006 && XINT (b->save_length) >= 0
6007 && (do_handled_files
6008 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
6009 Qwrite_region))))
6011 EMACS_TIME before_time, after_time;
6013 EMACS_GET_TIME (before_time);
6015 /* If we had a failure, don't try again for 20 minutes. */
6016 if (b->auto_save_failure_time >= 0
6017 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
6018 continue;
6020 if ((XFASTINT (b->save_length) * 10
6021 > (BUF_Z (b) - BUF_BEG (b)) * 13)
6022 /* A short file is likely to change a large fraction;
6023 spare the user annoying messages. */
6024 && XFASTINT (b->save_length) > 5000
6025 /* These messages are frequent and annoying for `*mail*'. */
6026 && !EQ (b->filename, Qnil)
6027 && NILP (no_message))
6029 /* It has shrunk too much; turn off auto-saving here. */
6030 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6031 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6032 b->name, 1);
6033 minibuffer_auto_raise = 0;
6034 /* Turn off auto-saving until there's a real save,
6035 and prevent any more warnings. */
6036 XSETINT (b->save_length, -1);
6037 Fsleep_for (make_number (1), Qnil);
6038 continue;
6040 set_buffer_internal (b);
6041 if (!auto_saved && NILP (no_message))
6042 message1 ("Auto-saving...");
6043 internal_condition_case (auto_save_1, Qt, auto_save_error);
6044 auto_saved++;
6045 b->auto_save_modified = BUF_MODIFF (b);
6046 XSETFASTINT (current_buffer->save_length, Z - BEG);
6047 set_buffer_internal (old);
6049 EMACS_GET_TIME (after_time);
6051 /* If auto-save took more than 60 seconds,
6052 assume it was an NFS failure that got a timeout. */
6053 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6054 b->auto_save_failure_time = EMACS_SECS (after_time);
6058 /* Prevent another auto save till enough input events come in. */
6059 record_auto_save ();
6061 if (auto_saved && NILP (no_message))
6063 if (old_message_p)
6065 /* If we are going to restore an old message,
6066 give time to read ours. */
6067 sit_for (make_number (1), 0, 0);
6068 restore_message ();
6070 else if (!auto_save_error_occurred)
6071 /* Don't overwrite the error message if an error occurred.
6072 If we displayed a message and then restored a state
6073 with no message, leave a "done" message on the screen. */
6074 message1 ("Auto-saving...done");
6077 Vquit_flag = oquit;
6079 /* This restores the message-stack status. */
6080 unbind_to (count, Qnil);
6081 return Qnil;
6084 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6085 Sset_buffer_auto_saved, 0, 0, 0,
6086 doc: /* Mark current buffer as auto-saved with its current text.
6087 No auto-save file will be written until the buffer changes again. */)
6090 current_buffer->auto_save_modified = MODIFF;
6091 XSETFASTINT (current_buffer->save_length, Z - BEG);
6092 current_buffer->auto_save_failure_time = -1;
6093 return Qnil;
6096 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6097 Sclear_buffer_auto_save_failure, 0, 0, 0,
6098 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6101 current_buffer->auto_save_failure_time = -1;
6102 return Qnil;
6105 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6106 0, 0, 0,
6107 doc: /* Return t if current buffer has been auto-saved recently.
6108 More precisely, if it has been auto-saved since last read from or saved
6109 in the visited file. If the buffer has no visited file,
6110 then any auto-save counts as "recent". */)
6113 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6116 /* Reading and completing file names */
6117 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6118 extern Lisp_Object Qcompletion_ignore_case;
6120 /* In the string VAL, change each $ to $$ and return the result. */
6122 static Lisp_Object
6123 double_dollars (val)
6124 Lisp_Object val;
6126 register const unsigned char *old;
6127 register unsigned char *new;
6128 register int n;
6129 int osize, count;
6131 osize = SBYTES (val);
6133 /* Count the number of $ characters. */
6134 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6135 if (*old++ == '$') count++;
6136 if (count > 0)
6138 old = SDATA (val);
6139 val = make_uninit_multibyte_string (SCHARS (val) + count,
6140 osize + count);
6141 new = SDATA (val);
6142 for (n = osize; n > 0; n--)
6143 if (*old != '$')
6144 *new++ = *old++;
6145 else
6147 *new++ = '$';
6148 *new++ = '$';
6149 old++;
6152 return val;
6155 static Lisp_Object
6156 read_file_name_cleanup (arg)
6157 Lisp_Object arg;
6159 return (current_buffer->directory = arg);
6162 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6163 3, 3, 0,
6164 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6165 (string, dir, action)
6166 Lisp_Object string, dir, action;
6167 /* action is nil for complete, t for return list of completions,
6168 lambda for verify final value */
6170 Lisp_Object name, specdir, realdir, val, orig_string;
6171 int changed;
6172 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6174 CHECK_STRING (string);
6176 realdir = dir;
6177 name = string;
6178 orig_string = Qnil;
6179 specdir = Qnil;
6180 changed = 0;
6181 /* No need to protect ACTION--we only compare it with t and nil. */
6182 GCPRO5 (string, realdir, name, specdir, orig_string);
6184 if (SCHARS (string) == 0)
6186 if (EQ (action, Qlambda))
6188 UNGCPRO;
6189 return Qnil;
6192 else
6194 orig_string = string;
6195 string = Fsubstitute_in_file_name (string);
6196 changed = NILP (Fstring_equal (string, orig_string));
6197 name = Ffile_name_nondirectory (string);
6198 val = Ffile_name_directory (string);
6199 if (! NILP (val))
6200 realdir = Fexpand_file_name (val, realdir);
6203 if (NILP (action))
6205 specdir = Ffile_name_directory (string);
6206 val = Ffile_name_completion (name, realdir, Vread_file_name_predicate);
6207 UNGCPRO;
6208 if (!STRINGP (val))
6210 if (changed)
6211 return double_dollars (string);
6212 return val;
6215 if (!NILP (specdir))
6216 val = concat2 (specdir, val);
6217 #ifndef VMS
6218 return double_dollars (val);
6219 #else /* not VMS */
6220 return val;
6221 #endif /* not VMS */
6223 UNGCPRO;
6225 if (EQ (action, Qt))
6227 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6228 Lisp_Object comp;
6229 int count;
6231 if (NILP (Vread_file_name_predicate)
6232 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6233 return all;
6235 #ifndef VMS
6236 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6238 /* Brute-force speed up for directory checking:
6239 Discard strings which don't end in a slash. */
6240 for (comp = Qnil; CONSP (all); all = XCDR (all))
6242 Lisp_Object tem = XCAR (all);
6243 int len;
6244 if (STRINGP (tem)
6245 && (len = SBYTES (tem), len > 0)
6246 && IS_DIRECTORY_SEP (SREF (tem, len-1)))
6247 comp = Fcons (tem, comp);
6250 else
6251 #endif
6253 /* Must do it the hard (and slow) way. */
6254 Lisp_Object tem;
6255 GCPRO3 (all, comp, specdir);
6256 count = SPECPDL_INDEX ();
6257 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6258 current_buffer->directory = realdir;
6259 for (comp = Qnil; CONSP (all); all = XCDR (all))
6261 tem = call1 (Vread_file_name_predicate, XCAR (all));
6262 if (!NILP (tem))
6263 comp = Fcons (XCAR (all), comp);
6265 unbind_to (count, Qnil);
6266 UNGCPRO;
6268 return Fnreverse (comp);
6271 /* Only other case actually used is ACTION = lambda */
6272 #ifdef VMS
6273 /* Supposedly this helps commands such as `cd' that read directory names,
6274 but can someone explain how it helps them? -- RMS */
6275 if (SCHARS (name) == 0)
6276 return Qt;
6277 #endif /* VMS */
6278 string = Fexpand_file_name (string, dir);
6279 if (!NILP (Vread_file_name_predicate))
6280 return call1 (Vread_file_name_predicate, string);
6281 return Ffile_exists_p (string);
6284 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6285 Snext_read_file_uses_dialog_p, 0, 0, 0,
6286 doc: /* Return t if a call to `read-file-name' will use a dialog.
6287 The return value is only relevant for a call to `read-file-name' that happens
6288 before any other event (mouse or keypress) is handeled. */)
6291 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6292 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6293 && use_dialog_box
6294 && use_file_dialog
6295 && have_menus_p ())
6296 return Qt;
6297 #endif
6298 return Qnil;
6301 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6302 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6303 Value is not expanded---you must call `expand-file-name' yourself.
6304 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6305 the same non-empty string that was inserted by this function.
6306 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6307 except that if INITIAL is specified, that combined with DIR is used.)
6308 If the user exits with an empty minibuffer, this function returns
6309 an empty string. (This can only happen if the user erased the
6310 pre-inserted contents or if `insert-default-directory' is nil.)
6311 Fourth arg MUSTMATCH non-nil means require existing file's name.
6312 Non-nil and non-t means also require confirmation after completion.
6313 Fifth arg INITIAL specifies text to start with.
6314 If optional sixth arg PREDICATE is non-nil, possible completions and
6315 the resulting file name must satisfy (funcall PREDICATE NAME).
6316 DIR should be an absolute directory name. It defaults to the value of
6317 `default-directory'.
6319 If this command was invoked with the mouse, use a file dialog box if
6320 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6321 provides a file dialog box.
6323 See also `read-file-name-completion-ignore-case'
6324 and `read-file-name-function'. */)
6325 (prompt, dir, default_filename, mustmatch, initial, predicate)
6326 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6328 Lisp_Object val, insdef, tem;
6329 struct gcpro gcpro1, gcpro2;
6330 register char *homedir;
6331 Lisp_Object decoded_homedir;
6332 int replace_in_history = 0;
6333 int add_to_history = 0;
6334 int count;
6336 if (NILP (dir))
6337 dir = current_buffer->directory;
6338 if (NILP (Ffile_name_absolute_p (dir)))
6339 dir = Fexpand_file_name (dir, Qnil);
6340 if (NILP (default_filename))
6341 default_filename
6342 = (!NILP (initial)
6343 ? Fexpand_file_name (initial, dir)
6344 : current_buffer->filename);
6346 /* If dir starts with user's homedir, change that to ~. */
6347 homedir = (char *) egetenv ("HOME");
6348 #ifdef DOS_NT
6349 /* homedir can be NULL in temacs, since Vprocess_environment is not
6350 yet set up. We shouldn't crash in that case. */
6351 if (homedir != 0)
6353 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6354 CORRECT_DIR_SEPS (homedir);
6356 #endif
6357 if (homedir != 0)
6358 decoded_homedir
6359 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6360 if (homedir != 0
6361 && STRINGP (dir)
6362 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6363 SBYTES (decoded_homedir))
6364 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6366 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6367 dir = concat2 (build_string ("~"), dir);
6369 /* Likewise for default_filename. */
6370 if (homedir != 0
6371 && STRINGP (default_filename)
6372 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6373 SBYTES (decoded_homedir))
6374 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6376 default_filename
6377 = Fsubstring (default_filename,
6378 make_number (SCHARS (decoded_homedir)), Qnil);
6379 default_filename = concat2 (build_string ("~"), default_filename);
6381 if (!NILP (default_filename))
6383 CHECK_STRING (default_filename);
6384 default_filename = double_dollars (default_filename);
6387 if (insert_default_directory && STRINGP (dir))
6389 insdef = dir;
6390 if (!NILP (initial))
6392 Lisp_Object args[2], pos;
6394 args[0] = insdef;
6395 args[1] = initial;
6396 insdef = Fconcat (2, args);
6397 pos = make_number (SCHARS (double_dollars (dir)));
6398 insdef = Fcons (double_dollars (insdef), pos);
6400 else
6401 insdef = double_dollars (insdef);
6403 else if (STRINGP (initial))
6404 insdef = Fcons (double_dollars (initial), make_number (0));
6405 else
6406 insdef = Qnil;
6408 if (!NILP (Vread_file_name_function))
6410 Lisp_Object args[7];
6412 GCPRO2 (insdef, default_filename);
6413 args[0] = Vread_file_name_function;
6414 args[1] = prompt;
6415 args[2] = dir;
6416 args[3] = default_filename;
6417 args[4] = mustmatch;
6418 args[5] = initial;
6419 args[6] = predicate;
6420 RETURN_UNGCPRO (Ffuncall (7, args));
6423 count = SPECPDL_INDEX ();
6424 specbind (Qcompletion_ignore_case,
6425 read_file_name_completion_ignore_case ? Qt : Qnil);
6426 specbind (intern ("minibuffer-completing-file-name"), Qt);
6427 specbind (intern ("read-file-name-predicate"),
6428 (NILP (predicate) ? Qfile_exists_p : predicate));
6430 GCPRO2 (insdef, default_filename);
6432 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6433 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6435 /* If DIR contains a file name, split it. */
6436 Lisp_Object file;
6437 file = Ffile_name_nondirectory (dir);
6438 if (SCHARS (file) && NILP (default_filename))
6440 default_filename = file;
6441 dir = Ffile_name_directory (dir);
6443 if (!NILP(default_filename))
6444 default_filename = Fexpand_file_name (default_filename, dir);
6445 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6446 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6447 add_to_history = 1;
6449 else
6450 #endif
6451 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6452 dir, mustmatch, insdef,
6453 Qfile_name_history, default_filename, Qnil);
6455 tem = Fsymbol_value (Qfile_name_history);
6456 if (CONSP (tem) && EQ (XCAR (tem), val))
6457 replace_in_history = 1;
6459 /* If Fcompleting_read returned the inserted default string itself
6460 (rather than a new string with the same contents),
6461 it has to mean that the user typed RET with the minibuffer empty.
6462 In that case, we really want to return ""
6463 so that commands such as set-visited-file-name can distinguish. */
6464 if (EQ (val, default_filename))
6466 /* In this case, Fcompleting_read has not added an element
6467 to the history. Maybe we should. */
6468 if (! replace_in_history)
6469 add_to_history = 1;
6471 val = empty_string;
6474 unbind_to (count, Qnil);
6475 UNGCPRO;
6476 if (NILP (val))
6477 error ("No file name specified");
6479 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6481 if (!NILP (tem) && !NILP (default_filename))
6482 val = default_filename;
6483 val = Fsubstitute_in_file_name (val);
6485 if (replace_in_history)
6486 /* Replace what Fcompleting_read added to the history
6487 with what we will actually return. */
6489 Lisp_Object val1 = double_dollars (val);
6490 tem = Fsymbol_value (Qfile_name_history);
6491 if (history_delete_duplicates)
6492 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6493 XSETCAR (tem, val1);
6495 else if (add_to_history)
6497 /* Add the value to the history--but not if it matches
6498 the last value already there. */
6499 Lisp_Object val1 = double_dollars (val);
6500 tem = Fsymbol_value (Qfile_name_history);
6501 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6503 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6504 Fset (Qfile_name_history, Fcons (val1, tem));
6508 return val;
6512 void
6513 init_fileio_once ()
6515 /* Must be set before any path manipulation is performed. */
6516 XSETFASTINT (Vdirectory_sep_char, '/');
6520 void
6521 syms_of_fileio ()
6523 Qoperations = intern ("operations");
6524 Qexpand_file_name = intern ("expand-file-name");
6525 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6526 Qdirectory_file_name = intern ("directory-file-name");
6527 Qfile_name_directory = intern ("file-name-directory");
6528 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6529 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6530 Qfile_name_as_directory = intern ("file-name-as-directory");
6531 Qcopy_file = intern ("copy-file");
6532 Qmake_directory_internal = intern ("make-directory-internal");
6533 Qmake_directory = intern ("make-directory");
6534 Qdelete_directory = intern ("delete-directory");
6535 Qdelete_file = intern ("delete-file");
6536 Qrename_file = intern ("rename-file");
6537 Qadd_name_to_file = intern ("add-name-to-file");
6538 Qmake_symbolic_link = intern ("make-symbolic-link");
6539 Qfile_exists_p = intern ("file-exists-p");
6540 Qfile_executable_p = intern ("file-executable-p");
6541 Qfile_readable_p = intern ("file-readable-p");
6542 Qfile_writable_p = intern ("file-writable-p");
6543 Qfile_symlink_p = intern ("file-symlink-p");
6544 Qaccess_file = intern ("access-file");
6545 Qfile_directory_p = intern ("file-directory-p");
6546 Qfile_regular_p = intern ("file-regular-p");
6547 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6548 Qfile_modes = intern ("file-modes");
6549 Qset_file_modes = intern ("set-file-modes");
6550 Qset_file_times = intern ("set-file-times");
6551 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6552 Qinsert_file_contents = intern ("insert-file-contents");
6553 Qwrite_region = intern ("write-region");
6554 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6555 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6556 Qauto_save_coding = intern ("auto-save-coding");
6558 staticpro (&Qoperations);
6559 staticpro (&Qexpand_file_name);
6560 staticpro (&Qsubstitute_in_file_name);
6561 staticpro (&Qdirectory_file_name);
6562 staticpro (&Qfile_name_directory);
6563 staticpro (&Qfile_name_nondirectory);
6564 staticpro (&Qunhandled_file_name_directory);
6565 staticpro (&Qfile_name_as_directory);
6566 staticpro (&Qcopy_file);
6567 staticpro (&Qmake_directory_internal);
6568 staticpro (&Qmake_directory);
6569 staticpro (&Qdelete_directory);
6570 staticpro (&Qdelete_file);
6571 staticpro (&Qrename_file);
6572 staticpro (&Qadd_name_to_file);
6573 staticpro (&Qmake_symbolic_link);
6574 staticpro (&Qfile_exists_p);
6575 staticpro (&Qfile_executable_p);
6576 staticpro (&Qfile_readable_p);
6577 staticpro (&Qfile_writable_p);
6578 staticpro (&Qaccess_file);
6579 staticpro (&Qfile_symlink_p);
6580 staticpro (&Qfile_directory_p);
6581 staticpro (&Qfile_regular_p);
6582 staticpro (&Qfile_accessible_directory_p);
6583 staticpro (&Qfile_modes);
6584 staticpro (&Qset_file_modes);
6585 staticpro (&Qset_file_times);
6586 staticpro (&Qfile_newer_than_file_p);
6587 staticpro (&Qinsert_file_contents);
6588 staticpro (&Qwrite_region);
6589 staticpro (&Qverify_visited_file_modtime);
6590 staticpro (&Qset_visited_file_modtime);
6591 staticpro (&Qauto_save_coding);
6593 Qfile_name_history = intern ("file-name-history");
6594 Fset (Qfile_name_history, Qnil);
6595 staticpro (&Qfile_name_history);
6597 Qfile_error = intern ("file-error");
6598 staticpro (&Qfile_error);
6599 Qfile_already_exists = intern ("file-already-exists");
6600 staticpro (&Qfile_already_exists);
6601 Qfile_date_error = intern ("file-date-error");
6602 staticpro (&Qfile_date_error);
6603 Qexcl = intern ("excl");
6604 staticpro (&Qexcl);
6606 #ifdef DOS_NT
6607 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6608 staticpro (&Qfind_buffer_file_type);
6609 #endif /* DOS_NT */
6611 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6612 doc: /* *Coding system for encoding file names.
6613 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6614 Vfile_name_coding_system = Qnil;
6616 DEFVAR_LISP ("default-file-name-coding-system",
6617 &Vdefault_file_name_coding_system,
6618 doc: /* Default coding system for encoding file names.
6619 This variable is used only when `file-name-coding-system' is nil.
6621 This variable is set/changed by the command `set-language-environment'.
6622 User should not set this variable manually,
6623 instead use `file-name-coding-system' to get a constant encoding
6624 of file names regardless of the current language environment. */);
6625 Vdefault_file_name_coding_system = Qnil;
6627 Qformat_decode = intern ("format-decode");
6628 staticpro (&Qformat_decode);
6629 Qformat_annotate_function = intern ("format-annotate-function");
6630 staticpro (&Qformat_annotate_function);
6631 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6632 staticpro (&Qafter_insert_file_set_coding);
6634 Qcar_less_than_car = intern ("car-less-than-car");
6635 staticpro (&Qcar_less_than_car);
6637 Fput (Qfile_error, Qerror_conditions,
6638 list2 (Qfile_error, Qerror));
6639 Fput (Qfile_error, Qerror_message,
6640 build_string ("File error"));
6642 Fput (Qfile_already_exists, Qerror_conditions,
6643 list3 (Qfile_already_exists, Qfile_error, Qerror));
6644 Fput (Qfile_already_exists, Qerror_message,
6645 build_string ("File already exists"));
6647 Fput (Qfile_date_error, Qerror_conditions,
6648 list3 (Qfile_date_error, Qfile_error, Qerror));
6649 Fput (Qfile_date_error, Qerror_message,
6650 build_string ("Cannot set file date"));
6652 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6653 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6654 Vread_file_name_function = Qnil;
6656 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6657 doc: /* Current predicate used by `read-file-name-internal'. */);
6658 Vread_file_name_predicate = Qnil;
6660 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6661 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6662 #if defined VMS || defined DOS_NT || defined MAC_OS
6663 read_file_name_completion_ignore_case = 1;
6664 #else
6665 read_file_name_completion_ignore_case = 0;
6666 #endif
6668 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6669 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6671 When the initial minibuffer contents show a name of a file or a directory,
6672 typing RETURN without editing the initial contents is equivalent to typing
6673 the default file name.
6675 If this variable is non-nil, the minibuffer contents are always
6676 initially non-empty, and typing RETURN without editing will fetch the
6677 default name, if one is provided. Note however that this default name
6678 is not necessarily the same as initial contents inserted in the minibuffer,
6679 if the initial contents is just the default directory.
6681 If this variable is nil, the minibuffer often starts out empty. In
6682 that case you may have to explicitly fetch the next history element to
6683 request the default name; typing RETURN without editing will leave
6684 the minibuffer empty.
6686 For some commands, exiting with an empty minibuffer has a special meaning,
6687 such as making the current buffer visit no file in the case of
6688 `set-visited-file-name'. */);
6689 insert_default_directory = 1;
6691 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6692 doc: /* *Non-nil means write new files with record format `stmlf'.
6693 nil means use format `var'. This variable is meaningful only on VMS. */);
6694 vms_stmlf_recfm = 0;
6696 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6697 doc: /* Directory separator character for built-in functions that return file names.
6698 The value is always ?/. Don't use this variable, just use `/'. */);
6700 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6701 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6702 If a file name matches REGEXP, then all I/O on that file is done by calling
6703 HANDLER.
6705 The first argument given to HANDLER is the name of the I/O primitive
6706 to be handled; the remaining arguments are the arguments that were
6707 passed to that primitive. For example, if you do
6708 (file-exists-p FILENAME)
6709 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6710 (funcall HANDLER 'file-exists-p FILENAME)
6711 The function `find-file-name-handler' checks this list for a handler
6712 for its argument. */);
6713 Vfile_name_handler_alist = Qnil;
6715 DEFVAR_LISP ("set-auto-coding-function",
6716 &Vset_auto_coding_function,
6717 doc: /* If non-nil, a function to call to decide a coding system of file.
6718 Two arguments are passed to this function: the file name
6719 and the length of a file contents following the point.
6720 This function should return a coding system to decode the file contents.
6721 It should check the file name against `auto-coding-alist'.
6722 If no coding system is decided, it should check a coding system
6723 specified in the heading lines with the format:
6724 -*- ... coding: CODING-SYSTEM; ... -*-
6725 or local variable spec of the tailing lines with `coding:' tag. */);
6726 Vset_auto_coding_function = Qnil;
6728 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6729 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6730 Each is passed one argument, the number of characters inserted.
6731 It should return the new character count, and leave point the same.
6732 If `insert-file-contents' is intercepted by a handler from
6733 `file-name-handler-alist', that handler is responsible for calling the
6734 functions in `after-insert-file-functions' if appropriate. */);
6735 Vafter_insert_file_functions = Qnil;
6737 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6738 doc: /* A list of functions to be called at the start of `write-region'.
6739 Each is passed two arguments, START and END as for `write-region'.
6740 These are usually two numbers but not always; see the documentation
6741 for `write-region'. The function should return a list of pairs
6742 of the form (POSITION . STRING), consisting of strings to be effectively
6743 inserted at the specified positions of the file being written (1 means to
6744 insert before the first byte written). The POSITIONs must be sorted into
6745 increasing order. If there are several functions in the list, the several
6746 lists are merged destructively. Alternatively, the function can return
6747 with a different buffer current; in that case it should pay attention
6748 to the annotations returned by previous functions and listed in
6749 `write-region-annotations-so-far'.*/);
6750 Vwrite_region_annotate_functions = Qnil;
6751 staticpro (&Qwrite_region_annotate_functions);
6752 Qwrite_region_annotate_functions
6753 = intern ("write-region-annotate-functions");
6755 DEFVAR_LISP ("write-region-annotations-so-far",
6756 &Vwrite_region_annotations_so_far,
6757 doc: /* When an annotation function is called, this holds the previous annotations.
6758 These are the annotations made by other annotation functions
6759 that were already called. See also `write-region-annotate-functions'. */);
6760 Vwrite_region_annotations_so_far = Qnil;
6762 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6763 doc: /* A list of file name handlers that temporarily should not be used.
6764 This applies only to the operation `inhibit-file-name-operation'. */);
6765 Vinhibit_file_name_handlers = Qnil;
6767 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6768 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6769 Vinhibit_file_name_operation = Qnil;
6771 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6772 doc: /* File name in which we write a list of all auto save file names.
6773 This variable is initialized automatically from `auto-save-list-file-prefix'
6774 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6775 a non-nil value. */);
6776 Vauto_save_list_file_name = Qnil;
6778 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name,
6779 doc: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6780 Normally auto-save files are written under other names. */);
6781 Vauto_save_visited_file_name = Qnil;
6783 #ifdef HAVE_FSYNC
6784 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6785 doc: /* *Non-nil means don't call fsync in `write-region'.
6786 This variable affects calls to `write-region' as well as save commands.
6787 A non-nil value may result in data loss! */);
6788 write_region_inhibit_fsync = 0;
6789 #endif
6791 defsubr (&Sfind_file_name_handler);
6792 defsubr (&Sfile_name_directory);
6793 defsubr (&Sfile_name_nondirectory);
6794 defsubr (&Sunhandled_file_name_directory);
6795 defsubr (&Sfile_name_as_directory);
6796 defsubr (&Sdirectory_file_name);
6797 defsubr (&Smake_temp_name);
6798 defsubr (&Sexpand_file_name);
6799 defsubr (&Ssubstitute_in_file_name);
6800 defsubr (&Scopy_file);
6801 defsubr (&Smake_directory_internal);
6802 defsubr (&Sdelete_directory);
6803 defsubr (&Sdelete_file);
6804 defsubr (&Srename_file);
6805 defsubr (&Sadd_name_to_file);
6806 defsubr (&Smake_symbolic_link);
6807 #ifdef VMS
6808 defsubr (&Sdefine_logical_name);
6809 #endif /* VMS */
6810 #ifdef HPUX_NET
6811 defsubr (&Ssysnetunam);
6812 #endif /* HPUX_NET */
6813 defsubr (&Sfile_name_absolute_p);
6814 defsubr (&Sfile_exists_p);
6815 defsubr (&Sfile_executable_p);
6816 defsubr (&Sfile_readable_p);
6817 defsubr (&Sfile_writable_p);
6818 defsubr (&Saccess_file);
6819 defsubr (&Sfile_symlink_p);
6820 defsubr (&Sfile_directory_p);
6821 defsubr (&Sfile_accessible_directory_p);
6822 defsubr (&Sfile_regular_p);
6823 defsubr (&Sfile_modes);
6824 defsubr (&Sset_file_modes);
6825 defsubr (&Sset_file_times);
6826 defsubr (&Sset_default_file_modes);
6827 defsubr (&Sdefault_file_modes);
6828 defsubr (&Sfile_newer_than_file_p);
6829 defsubr (&Sinsert_file_contents);
6830 defsubr (&Swrite_region);
6831 defsubr (&Scar_less_than_car);
6832 defsubr (&Sverify_visited_file_modtime);
6833 defsubr (&Sclear_visited_file_modtime);
6834 defsubr (&Svisited_file_modtime);
6835 defsubr (&Sset_visited_file_modtime);
6836 defsubr (&Sdo_auto_save);
6837 defsubr (&Sset_buffer_auto_saved);
6838 defsubr (&Sclear_buffer_auto_save_failure);
6839 defsubr (&Srecent_auto_save_p);
6841 defsubr (&Sread_file_name_internal);
6842 defsubr (&Sread_file_name);
6843 defsubr (&Snext_read_file_uses_dialog_p);
6845 #ifdef HAVE_SYNC
6846 defsubr (&Sunix_sync);
6847 #endif
6850 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6851 (do not change this comment) */