(custom-add-parent-links): Filter out custom-group-link,
[emacs.git] / src / fileio.c
blobc62ddd367670b1a07efd60e8bad61dc59b0ae2dc
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 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 2, 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"
81 #ifdef WINDOWSNT
82 #define NOMINMAX 1
83 #include <windows.h>
84 #include <stdlib.h>
85 #include <fcntl.h>
86 #endif /* not WINDOWSNT */
88 #ifdef MSDOS
89 #include "msdos.h"
90 #include <sys/param.h>
91 #if __DJGPP__ >= 2
92 #include <fcntl.h>
93 #include <string.h>
94 #endif
95 #endif
97 #ifdef DOS_NT
98 #define CORRECT_DIR_SEPS(s) \
99 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
100 else unixtodos_filename (s); \
101 } while (0)
102 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
103 redirector allows the six letters between 'Z' and 'a' as well. */
104 #ifdef MSDOS
105 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
106 #endif
107 #ifdef WINDOWSNT
108 #define IS_DRIVE(x) isalpha (x)
109 #endif
110 /* Need to lower-case the drive letter, or else expanded
111 filenames will sometimes compare inequal, because
112 `expand-file-name' doesn't always down-case the drive letter. */
113 #define DRIVE_LETTER(x) (tolower (x))
114 #endif
116 #ifdef VMS
117 #include <file.h>
118 #include <rmsdef.h>
119 #include <fab.h>
120 #include <nam.h>
121 #endif
123 #include "systime.h"
125 #ifdef HPUX
126 #include <netio.h>
127 #ifndef HPUX8
128 #ifndef HPUX9
129 #include <errnet.h>
130 #endif
131 #endif
132 #endif
134 #include "commands.h"
135 extern int use_dialog_box;
136 extern int use_file_dialog;
138 #ifndef O_WRONLY
139 #define O_WRONLY 1
140 #endif
142 #ifndef O_RDONLY
143 #define O_RDONLY 0
144 #endif
146 #ifndef S_ISLNK
147 # define lstat stat
148 #endif
150 #ifndef FILE_SYSTEM_CASE
151 #define FILE_SYSTEM_CASE(filename) (filename)
152 #endif
154 /* Nonzero during writing of auto-save files */
155 int auto_saving;
157 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
158 a new file with the same mode as the original */
159 int auto_save_mode_bits;
161 /* The symbol bound to coding-system-for-read when
162 insert-file-contents is called for recovering a file. This is not
163 an actual coding system name, but just an indicator to tell
164 insert-file-contents to use `emacs-mule' with a special flag for
165 auto saving and recovering a file. */
166 Lisp_Object Qauto_save_coding;
168 /* Coding system for file names, or nil if none. */
169 Lisp_Object Vfile_name_coding_system;
171 /* Coding system for file names used only when
172 Vfile_name_coding_system is nil. */
173 Lisp_Object Vdefault_file_name_coding_system;
175 /* Alist of elements (REGEXP . HANDLER) for file names
176 whose I/O is done with a special handler. */
177 Lisp_Object Vfile_name_handler_alist;
179 /* Property name of a file name handler,
180 which gives a list of operations it handles.. */
181 Lisp_Object Qoperations;
183 /* Lisp functions for translating file formats */
184 Lisp_Object Qformat_decode, Qformat_annotate_function;
186 /* Function to be called to decide a coding system of a reading file. */
187 Lisp_Object Vset_auto_coding_function;
189 /* Functions to be called to process text properties in inserted file. */
190 Lisp_Object Vafter_insert_file_functions;
192 /* Lisp function for setting buffer-file-coding-system and the
193 multibyteness of the current buffer after inserting a file. */
194 Lisp_Object Qafter_insert_file_set_coding;
196 /* Functions to be called to create text property annotations for file. */
197 Lisp_Object Vwrite_region_annotate_functions;
198 Lisp_Object Qwrite_region_annotate_functions;
200 /* During build_annotations, each time an annotation function is called,
201 this holds the annotations made by the previous functions. */
202 Lisp_Object Vwrite_region_annotations_so_far;
204 /* File name in which we write a list of all our auto save files. */
205 Lisp_Object Vauto_save_list_file_name;
207 /* Function to call to read a file name. */
208 Lisp_Object Vread_file_name_function;
210 /* Current predicate used by read_file_name_internal. */
211 Lisp_Object Vread_file_name_predicate;
213 /* Nonzero means completion ignores case when reading file name. */
214 int read_file_name_completion_ignore_case;
216 /* Nonzero means, when reading a filename in the minibuffer,
217 start out by inserting the default directory into the minibuffer. */
218 int insert_default_directory;
220 /* On VMS, nonzero means write new files with record format stmlf.
221 Zero means use var format. */
222 int vms_stmlf_recfm;
224 /* On NT, specifies the directory separator character, used (eg.) when
225 expanding file names. This can be bound to / or \. */
226 Lisp_Object Vdirectory_sep_char;
228 #ifdef HAVE_FSYNC
229 /* Nonzero means skip the call to fsync in Fwrite-region. */
230 int write_region_inhibit_fsync;
231 #endif
233 extern Lisp_Object Vuser_login_name;
235 #ifdef WINDOWSNT
236 extern Lisp_Object Vw32_get_true_file_attributes;
237 #endif
239 extern int minibuf_level;
241 extern int minibuffer_auto_raise;
243 extern int history_delete_duplicates;
245 /* These variables describe handlers that have "already" had a chance
246 to handle the current operation.
248 Vinhibit_file_name_handlers is a list of file name handlers.
249 Vinhibit_file_name_operation is the operation being handled.
250 If we try to handle that operation, we ignore those handlers. */
252 static Lisp_Object Vinhibit_file_name_handlers;
253 static Lisp_Object Vinhibit_file_name_operation;
255 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
256 Lisp_Object Qexcl;
257 Lisp_Object Qfile_name_history;
259 Lisp_Object Qcar_less_than_car;
261 static int a_write P_ ((int, Lisp_Object, int, int,
262 Lisp_Object *, struct coding_system *));
263 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
266 void
267 report_file_error (string, data)
268 const char *string;
269 Lisp_Object data;
271 Lisp_Object errstring;
272 int errorno = errno;
274 synchronize_system_messages_locale ();
275 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
276 Vlocale_coding_system, 0);
278 while (1)
279 switch (errorno)
281 case EEXIST:
282 Fsignal (Qfile_already_exists, Fcons (errstring, data));
283 break;
284 default:
285 /* System error messages are capitalized. Downcase the initial
286 unless it is followed by a slash. */
287 if (SREF (errstring, 1) != '/')
288 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
290 Fsignal (Qfile_error,
291 Fcons (build_string (string), Fcons (errstring, data)));
295 Lisp_Object
296 close_file_unwind (fd)
297 Lisp_Object fd;
299 emacs_close (XFASTINT (fd));
300 return Qnil;
303 /* Restore point, having saved it as a marker. */
305 static Lisp_Object
306 restore_point_unwind (location)
307 Lisp_Object location;
309 Fgoto_char (location);
310 Fset_marker (location, Qnil, Qnil);
311 return Qnil;
314 Lisp_Object Qexpand_file_name;
315 Lisp_Object Qsubstitute_in_file_name;
316 Lisp_Object Qdirectory_file_name;
317 Lisp_Object Qfile_name_directory;
318 Lisp_Object Qfile_name_nondirectory;
319 Lisp_Object Qunhandled_file_name_directory;
320 Lisp_Object Qfile_name_as_directory;
321 Lisp_Object Qcopy_file;
322 Lisp_Object Qmake_directory_internal;
323 Lisp_Object Qmake_directory;
324 Lisp_Object Qdelete_directory;
325 Lisp_Object Qdelete_file;
326 Lisp_Object Qrename_file;
327 Lisp_Object Qadd_name_to_file;
328 Lisp_Object Qmake_symbolic_link;
329 Lisp_Object Qfile_exists_p;
330 Lisp_Object Qfile_executable_p;
331 Lisp_Object Qfile_readable_p;
332 Lisp_Object Qfile_writable_p;
333 Lisp_Object Qfile_symlink_p;
334 Lisp_Object Qaccess_file;
335 Lisp_Object Qfile_directory_p;
336 Lisp_Object Qfile_regular_p;
337 Lisp_Object Qfile_accessible_directory_p;
338 Lisp_Object Qfile_modes;
339 Lisp_Object Qset_file_modes;
340 Lisp_Object Qset_file_times;
341 Lisp_Object Qfile_newer_than_file_p;
342 Lisp_Object Qinsert_file_contents;
343 Lisp_Object Qwrite_region;
344 Lisp_Object Qverify_visited_file_modtime;
345 Lisp_Object Qset_visited_file_modtime;
347 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
348 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
349 Otherwise, return nil.
350 A file name is handled if one of the regular expressions in
351 `file-name-handler-alist' matches it.
353 If OPERATION equals `inhibit-file-name-operation', then we ignore
354 any handlers that are members of `inhibit-file-name-handlers',
355 but we still do run any other handlers. This lets handlers
356 use the standard functions without calling themselves recursively. */)
357 (filename, operation)
358 Lisp_Object filename, operation;
360 /* This function must not munge the match data. */
361 Lisp_Object chain, inhibited_handlers, result;
362 int pos = -1;
364 result = Qnil;
365 CHECK_STRING (filename);
367 if (EQ (operation, Vinhibit_file_name_operation))
368 inhibited_handlers = Vinhibit_file_name_handlers;
369 else
370 inhibited_handlers = Qnil;
372 for (chain = Vfile_name_handler_alist; CONSP (chain);
373 chain = XCDR (chain))
375 Lisp_Object elt;
376 elt = XCAR (chain);
377 if (CONSP (elt))
379 Lisp_Object string = XCAR (elt);
380 int match_pos;
381 Lisp_Object handler = XCDR (elt);
382 Lisp_Object operations = Qnil;
384 if (SYMBOLP (handler))
385 operations = Fget (handler, Qoperations);
387 if (STRINGP (string)
388 && (match_pos = fast_string_match (string, filename)) > pos
389 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
391 Lisp_Object tem;
393 handler = XCDR (elt);
394 tem = Fmemq (handler, inhibited_handlers);
395 if (NILP (tem))
397 result = handler;
398 pos = match_pos;
403 QUIT;
405 return result;
408 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
409 1, 1, 0,
410 doc: /* Return the directory component in file name FILENAME.
411 Return nil if FILENAME does not include a directory.
412 Otherwise return a directory spec.
413 Given a Unix syntax file name, returns a string ending in slash;
414 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
415 (filename)
416 Lisp_Object filename;
418 #ifndef DOS_NT
419 register const unsigned char *beg;
420 #else
421 register unsigned char *beg;
422 #endif
423 register const unsigned char *p;
424 Lisp_Object handler;
426 CHECK_STRING (filename);
428 /* If the file name has special constructs in it,
429 call the corresponding file handler. */
430 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
431 if (!NILP (handler))
432 return call2 (handler, Qfile_name_directory, filename);
434 filename = FILE_SYSTEM_CASE (filename);
435 beg = SDATA (filename);
436 #ifdef DOS_NT
437 beg = strcpy (alloca (strlen (beg) + 1), beg);
438 #endif
439 p = beg + SBYTES (filename);
441 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
442 #ifdef VMS
443 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
444 #endif /* VMS */
445 #ifdef DOS_NT
446 /* only recognise drive specifier at the beginning */
447 && !(p[-1] == ':'
448 /* handle the "/:d:foo" and "/:foo" cases correctly */
449 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
450 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
451 #endif
452 ) p--;
454 if (p == beg)
455 return Qnil;
456 #ifdef DOS_NT
457 /* Expansion of "c:" to drive and default directory. */
458 if (p[-1] == ':')
460 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
461 unsigned char *res = alloca (MAXPATHLEN + 1);
462 unsigned char *r = res;
464 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
466 strncpy (res, beg, 2);
467 beg += 2;
468 r += 2;
471 if (getdefdir (toupper (*beg) - 'A' + 1, r))
473 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
474 strcat (res, "/");
475 beg = res;
476 p = beg + strlen (beg);
479 CORRECT_DIR_SEPS (beg);
480 #endif /* DOS_NT */
482 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
485 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
486 Sfile_name_nondirectory, 1, 1, 0,
487 doc: /* Return file name FILENAME sans its directory.
488 For example, in a Unix-syntax file name,
489 this is everything after the last slash,
490 or the entire name if it contains no slash. */)
491 (filename)
492 Lisp_Object filename;
494 register const unsigned char *beg, *p, *end;
495 Lisp_Object handler;
497 CHECK_STRING (filename);
499 /* If the file name has special constructs in it,
500 call the corresponding file handler. */
501 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
502 if (!NILP (handler))
503 return call2 (handler, Qfile_name_nondirectory, filename);
505 beg = SDATA (filename);
506 end = p = beg + SBYTES (filename);
508 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
509 #ifdef VMS
510 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
511 #endif /* VMS */
512 #ifdef DOS_NT
513 /* only recognise drive specifier at beginning */
514 && !(p[-1] == ':'
515 /* handle the "/:d:foo" case correctly */
516 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
517 #endif
519 p--;
521 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
524 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
525 Sunhandled_file_name_directory, 1, 1, 0,
526 doc: /* Return a directly usable directory name somehow associated with FILENAME.
527 A `directly usable' directory name is one that may be used without the
528 intervention of any file handler.
529 If FILENAME is a directly usable file itself, return
530 \(file-name-directory FILENAME).
531 The `call-process' and `start-process' functions use this function to
532 get a current directory to run processes in. */)
533 (filename)
534 Lisp_Object filename;
536 Lisp_Object handler;
538 /* If the file name has special constructs in it,
539 call the corresponding file handler. */
540 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
541 if (!NILP (handler))
542 return call2 (handler, Qunhandled_file_name_directory, filename);
544 return Ffile_name_directory (filename);
548 char *
549 file_name_as_directory (out, in)
550 char *out, *in;
552 int size = strlen (in) - 1;
554 strcpy (out, in);
556 if (size < 0)
558 out[0] = '.';
559 out[1] = '/';
560 out[2] = 0;
561 return out;
564 #ifdef VMS
565 /* Is it already a directory string? */
566 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
567 return out;
568 /* Is it a VMS directory file name? If so, hack VMS syntax. */
569 else if (! index (in, '/')
570 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
571 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
572 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
573 || ! strncmp (&in[size - 5], ".dir", 4))
574 && (in[size - 1] == '.' || in[size - 1] == ';')
575 && in[size] == '1')))
577 register char *p, *dot;
578 char brack;
580 /* x.dir -> [.x]
581 dir:x.dir --> dir:[x]
582 dir:[x]y.dir --> dir:[x.y] */
583 p = in + size;
584 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
585 if (p != in)
587 strncpy (out, in, p - in);
588 out[p - in] = '\0';
589 if (*p == ':')
591 brack = ']';
592 strcat (out, ":[");
594 else
596 brack = *p;
597 strcat (out, ".");
599 p++;
601 else
603 brack = ']';
604 strcpy (out, "[.");
606 dot = index (p, '.');
607 if (dot)
609 /* blindly remove any extension */
610 size = strlen (out) + (dot - p);
611 strncat (out, p, dot - p);
613 else
615 strcat (out, p);
616 size = strlen (out);
618 out[size++] = brack;
619 out[size] = '\0';
621 #else /* not VMS */
622 /* For Unix syntax, Append a slash if necessary */
623 if (!IS_DIRECTORY_SEP (out[size]))
625 /* Cannot use DIRECTORY_SEP, which could have any value */
626 out[size + 1] = '/';
627 out[size + 2] = '\0';
629 #ifdef DOS_NT
630 CORRECT_DIR_SEPS (out);
631 #endif
632 #endif /* not VMS */
633 return out;
636 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
637 Sfile_name_as_directory, 1, 1, 0,
638 doc: /* Return a string representing the file name FILE interpreted as a directory.
639 This operation exists because a directory is also a file, but its name as
640 a directory is different from its name as a file.
641 The result can be used as the value of `default-directory'
642 or passed as second argument to `expand-file-name'.
643 For a Unix-syntax file name, just appends a slash.
644 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
645 (file)
646 Lisp_Object file;
648 char *buf;
649 Lisp_Object handler;
651 CHECK_STRING (file);
652 if (NILP (file))
653 return Qnil;
655 /* If the file name has special constructs in it,
656 call the corresponding file handler. */
657 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
658 if (!NILP (handler))
659 return call2 (handler, Qfile_name_as_directory, file);
661 buf = (char *) alloca (SBYTES (file) + 10);
662 file_name_as_directory (buf, SDATA (file));
663 return make_specified_string (buf, -1, strlen (buf),
664 STRING_MULTIBYTE (file));
668 * Convert from directory name to filename.
669 * On VMS:
670 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
671 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
672 * On UNIX, it's simple: just make sure there isn't a terminating /
674 * Value is nonzero if the string output is different from the input.
678 directory_file_name (src, dst)
679 char *src, *dst;
681 long slen;
682 #ifdef VMS
683 long rlen;
684 char * ptr, * rptr;
685 char bracket;
686 struct FAB fab = cc$rms_fab;
687 struct NAM nam = cc$rms_nam;
688 char esa[NAM$C_MAXRSS];
689 #endif /* VMS */
691 slen = strlen (src);
692 #ifdef VMS
693 if (! index (src, '/')
694 && (src[slen - 1] == ']'
695 || src[slen - 1] == ':'
696 || src[slen - 1] == '>'))
698 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
699 fab.fab$l_fna = src;
700 fab.fab$b_fns = slen;
701 fab.fab$l_nam = &nam;
702 fab.fab$l_fop = FAB$M_NAM;
704 nam.nam$l_esa = esa;
705 nam.nam$b_ess = sizeof esa;
706 nam.nam$b_nop |= NAM$M_SYNCHK;
708 /* We call SYS$PARSE to handle such things as [--] for us. */
709 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
711 slen = nam.nam$b_esl;
712 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
713 slen -= 2;
714 esa[slen] = '\0';
715 src = esa;
717 if (src[slen - 1] != ']' && src[slen - 1] != '>')
719 /* what about when we have logical_name:???? */
720 if (src[slen - 1] == ':')
721 { /* Xlate logical name and see what we get */
722 ptr = strcpy (dst, src); /* upper case for getenv */
723 while (*ptr)
725 if ('a' <= *ptr && *ptr <= 'z')
726 *ptr -= 040;
727 ptr++;
729 dst[slen - 1] = 0; /* remove colon */
730 if (!(src = egetenv (dst)))
731 return 0;
732 /* should we jump to the beginning of this procedure?
733 Good points: allows us to use logical names that xlate
734 to Unix names,
735 Bad points: can be a problem if we just translated to a device
736 name...
737 For now, I'll punt and always expect VMS names, and hope for
738 the best! */
739 slen = strlen (src);
740 if (src[slen - 1] != ']' && src[slen - 1] != '>')
741 { /* no recursion here! */
742 strcpy (dst, src);
743 return 0;
746 else
747 { /* not a directory spec */
748 strcpy (dst, src);
749 return 0;
752 bracket = src[slen - 1];
754 /* If bracket is ']' or '>', bracket - 2 is the corresponding
755 opening bracket. */
756 ptr = index (src, bracket - 2);
757 if (ptr == 0)
758 { /* no opening bracket */
759 strcpy (dst, src);
760 return 0;
762 if (!(rptr = rindex (src, '.')))
763 rptr = ptr;
764 slen = rptr - src;
765 strncpy (dst, src, slen);
766 dst[slen] = '\0';
767 if (*rptr == '.')
769 dst[slen++] = bracket;
770 dst[slen] = '\0';
772 else
774 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
775 then translate the device and recurse. */
776 if (dst[slen - 1] == ':'
777 && dst[slen - 2] != ':' /* skip decnet nodes */
778 && strcmp (src + slen, "[000000]") == 0)
780 dst[slen - 1] = '\0';
781 if ((ptr = egetenv (dst))
782 && (rlen = strlen (ptr) - 1) > 0
783 && (ptr[rlen] == ']' || ptr[rlen] == '>')
784 && ptr[rlen - 1] == '.')
786 char * buf = (char *) alloca (strlen (ptr) + 1);
787 strcpy (buf, ptr);
788 buf[rlen - 1] = ']';
789 buf[rlen] = '\0';
790 return directory_file_name (buf, dst);
792 else
793 dst[slen - 1] = ':';
795 strcat (dst, "[000000]");
796 slen += 8;
798 rptr++;
799 rlen = strlen (rptr) - 1;
800 strncat (dst, rptr, rlen);
801 dst[slen + rlen] = '\0';
802 strcat (dst, ".DIR.1");
803 return 1;
805 #endif /* VMS */
806 /* Process as Unix format: just remove any final slash.
807 But leave "/" unchanged; do not change it to "". */
808 strcpy (dst, src);
809 #ifdef APOLLO
810 /* Handle // as root for apollo's. */
811 if ((slen > 2 && dst[slen - 1] == '/')
812 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
813 dst[slen - 1] = 0;
814 #else
815 if (slen > 1
816 && IS_DIRECTORY_SEP (dst[slen - 1])
817 #ifdef DOS_NT
818 && !IS_ANY_SEP (dst[slen - 2])
819 #endif
821 dst[slen - 1] = 0;
822 #endif
823 #ifdef DOS_NT
824 CORRECT_DIR_SEPS (dst);
825 #endif
826 return 1;
829 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
830 1, 1, 0,
831 doc: /* Returns the file name of the directory named DIRECTORY.
832 This is the name of the file that holds the data for the directory DIRECTORY.
833 This operation exists because a directory is also a file, but its name as
834 a directory is different from its name as a file.
835 In Unix-syntax, this function just removes the final slash.
836 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
837 it returns a file name such as \"[X]Y.DIR.1\". */)
838 (directory)
839 Lisp_Object directory;
841 char *buf;
842 Lisp_Object handler;
844 CHECK_STRING (directory);
846 if (NILP (directory))
847 return Qnil;
849 /* If the file name has special constructs in it,
850 call the corresponding file handler. */
851 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
852 if (!NILP (handler))
853 return call2 (handler, Qdirectory_file_name, directory);
855 #ifdef VMS
856 /* 20 extra chars is insufficient for VMS, since we might perform a
857 logical name translation. an equivalence string can be up to 255
858 chars long, so grab that much extra space... - sss */
859 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
860 #else
861 buf = (char *) alloca (SBYTES (directory) + 20);
862 #endif
863 directory_file_name (SDATA (directory), buf);
864 return make_specified_string (buf, -1, strlen (buf),
865 STRING_MULTIBYTE (directory));
868 static char make_temp_name_tbl[64] =
870 'A','B','C','D','E','F','G','H',
871 'I','J','K','L','M','N','O','P',
872 'Q','R','S','T','U','V','W','X',
873 'Y','Z','a','b','c','d','e','f',
874 'g','h','i','j','k','l','m','n',
875 'o','p','q','r','s','t','u','v',
876 'w','x','y','z','0','1','2','3',
877 '4','5','6','7','8','9','-','_'
880 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
882 /* Value is a temporary file name starting with PREFIX, a string.
884 The Emacs process number forms part of the result, so there is
885 no danger of generating a name being used by another process.
886 In addition, this function makes an attempt to choose a name
887 which has no existing file. To make this work, PREFIX should be
888 an absolute file name.
890 BASE64_P non-zero means add the pid as 3 characters in base64
891 encoding. In this case, 6 characters will be added to PREFIX to
892 form the file name. Otherwise, if Emacs is running on a system
893 with long file names, add the pid as a decimal number.
895 This function signals an error if no unique file name could be
896 generated. */
898 Lisp_Object
899 make_temp_name (prefix, base64_p)
900 Lisp_Object prefix;
901 int base64_p;
903 Lisp_Object val;
904 int len, clen;
905 int pid;
906 unsigned char *p, *data;
907 char pidbuf[20];
908 int pidlen;
910 CHECK_STRING (prefix);
912 /* VAL is created by adding 6 characters to PREFIX. The first
913 three are the PID of this process, in base 64, and the second
914 three are incremented if the file already exists. This ensures
915 262144 unique file names per PID per PREFIX. */
917 pid = (int) getpid ();
919 if (base64_p)
921 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
922 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
923 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
924 pidlen = 3;
926 else
928 #ifdef HAVE_LONG_FILE_NAMES
929 sprintf (pidbuf, "%d", pid);
930 pidlen = strlen (pidbuf);
931 #else
932 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
933 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
934 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
935 pidlen = 3;
936 #endif
939 len = SBYTES (prefix); clen = SCHARS (prefix);
940 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
941 if (!STRING_MULTIBYTE (prefix))
942 STRING_SET_UNIBYTE (val);
943 data = SDATA (val);
944 bcopy(SDATA (prefix), data, len);
945 p = data + len;
947 bcopy (pidbuf, p, pidlen);
948 p += pidlen;
950 /* Here we try to minimize useless stat'ing when this function is
951 invoked many times successively with the same PREFIX. We achieve
952 this by initializing count to a random value, and incrementing it
953 afterwards.
955 We don't want make-temp-name to be called while dumping,
956 because then make_temp_name_count_initialized_p would get set
957 and then make_temp_name_count would not be set when Emacs starts. */
959 if (!make_temp_name_count_initialized_p)
961 make_temp_name_count = (unsigned) time (NULL);
962 make_temp_name_count_initialized_p = 1;
965 while (1)
967 struct stat ignored;
968 unsigned num = make_temp_name_count;
970 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
971 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
972 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
974 /* Poor man's congruential RN generator. Replace with
975 ++make_temp_name_count for debugging. */
976 make_temp_name_count += 25229;
977 make_temp_name_count %= 225307;
979 if (stat (data, &ignored) < 0)
981 /* We want to return only if errno is ENOENT. */
982 if (errno == ENOENT)
983 return val;
984 else
985 /* The error here is dubious, but there is little else we
986 can do. The alternatives are to return nil, which is
987 as bad as (and in many cases worse than) throwing the
988 error, or to ignore the error, which will likely result
989 in looping through 225307 stat's, which is not only
990 dog-slow, but also useless since it will fallback to
991 the errow below, anyway. */
992 report_file_error ("Cannot create temporary name for prefix",
993 Fcons (prefix, Qnil));
994 /* not reached */
998 error ("Cannot create temporary name for prefix `%s'",
999 SDATA (prefix));
1000 return Qnil;
1004 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1005 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1006 The Emacs process number forms part of the result,
1007 so there is no danger of generating a name being used by another process.
1009 In addition, this function makes an attempt to choose a name
1010 which has no existing file. To make this work,
1011 PREFIX should be an absolute file name.
1013 There is a race condition between calling `make-temp-name' and creating the
1014 file which opens all kinds of security holes. For that reason, you should
1015 probably use `make-temp-file' instead, except in three circumstances:
1017 * If you are creating the file in the user's home directory.
1018 * If you are creating a directory rather than an ordinary file.
1019 * If you are taking special precautions as `make-temp-file' does. */)
1020 (prefix)
1021 Lisp_Object prefix;
1023 return make_temp_name (prefix, 0);
1028 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1029 doc: /* Convert filename NAME to absolute, and canonicalize it.
1030 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1031 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1032 the current buffer's value of `default-directory' is used.
1033 File name components that are `.' are removed, and
1034 so are file name components followed by `..', along with the `..' itself;
1035 note that these simplifications are done without checking the resulting
1036 file names in the file system.
1037 An initial `~/' expands to your home directory.
1038 An initial `~USER/' expands to USER's home directory.
1039 See also the function `substitute-in-file-name'. */)
1040 (name, default_directory)
1041 Lisp_Object name, default_directory;
1043 unsigned char *nm;
1045 register unsigned char *newdir, *p, *o;
1046 int tlen;
1047 unsigned char *target;
1048 struct passwd *pw;
1049 #ifdef VMS
1050 unsigned char * colon = 0;
1051 unsigned char * close = 0;
1052 unsigned char * slash = 0;
1053 unsigned char * brack = 0;
1054 int lbrack = 0, rbrack = 0;
1055 int dots = 0;
1056 #endif /* VMS */
1057 #ifdef DOS_NT
1058 int drive = 0;
1059 int collapse_newdir = 1;
1060 int is_escaped = 0;
1061 #endif /* DOS_NT */
1062 int length;
1063 Lisp_Object handler, result;
1064 int multibyte;
1066 CHECK_STRING (name);
1068 /* If the file name has special constructs in it,
1069 call the corresponding file handler. */
1070 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1071 if (!NILP (handler))
1072 return call3 (handler, Qexpand_file_name, name, default_directory);
1074 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1075 if (NILP (default_directory))
1076 default_directory = current_buffer->directory;
1077 if (! STRINGP (default_directory))
1079 #ifdef DOS_NT
1080 /* "/" is not considered a root directory on DOS_NT, so using "/"
1081 here causes an infinite recursion in, e.g., the following:
1083 (let (default-directory)
1084 (expand-file-name "a"))
1086 To avoid this, we set default_directory to the root of the
1087 current drive. */
1088 extern char *emacs_root_dir (void);
1090 default_directory = build_string (emacs_root_dir ());
1091 #else
1092 default_directory = build_string ("/");
1093 #endif
1096 if (!NILP (default_directory))
1098 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1099 if (!NILP (handler))
1100 return call3 (handler, Qexpand_file_name, name, default_directory);
1103 o = SDATA (default_directory);
1105 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1106 It would be better to do this down below where we actually use
1107 default_directory. Unfortunately, calling Fexpand_file_name recursively
1108 could invoke GC, and the strings might be relocated. This would
1109 be annoying because we have pointers into strings lying around
1110 that would need adjusting, and people would add new pointers to
1111 the code and forget to adjust them, resulting in intermittent bugs.
1112 Putting this call here avoids all that crud.
1114 The EQ test avoids infinite recursion. */
1115 if (! NILP (default_directory) && !EQ (default_directory, name)
1116 /* Save time in some common cases - as long as default_directory
1117 is not relative, it can be canonicalized with name below (if it
1118 is needed at all) without requiring it to be expanded now. */
1119 #ifdef DOS_NT
1120 /* Detect MSDOS file names with drive specifiers. */
1121 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1122 #ifdef WINDOWSNT
1123 /* Detect Windows file names in UNC format. */
1124 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1125 #endif
1126 #else /* not DOS_NT */
1127 /* Detect Unix absolute file names (/... alone is not absolute on
1128 DOS or Windows). */
1129 && ! (IS_DIRECTORY_SEP (o[0]))
1130 #endif /* not DOS_NT */
1133 struct gcpro gcpro1;
1135 GCPRO1 (name);
1136 default_directory = Fexpand_file_name (default_directory, Qnil);
1137 UNGCPRO;
1140 name = FILE_SYSTEM_CASE (name);
1141 nm = SDATA (name);
1142 multibyte = STRING_MULTIBYTE (name);
1144 #ifdef DOS_NT
1145 /* We will force directory separators to be either all \ or /, so make
1146 a local copy to modify, even if there ends up being no change. */
1147 nm = strcpy (alloca (strlen (nm) + 1), nm);
1149 /* Note if special escape prefix is present, but remove for now. */
1150 if (nm[0] == '/' && nm[1] == ':')
1152 is_escaped = 1;
1153 nm += 2;
1156 /* Find and remove drive specifier if present; this makes nm absolute
1157 even if the rest of the name appears to be relative. Only look for
1158 drive specifier at the beginning. */
1159 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1161 drive = nm[0];
1162 nm += 2;
1165 #ifdef WINDOWSNT
1166 /* If we see "c://somedir", we want to strip the first slash after the
1167 colon when stripping the drive letter. Otherwise, this expands to
1168 "//somedir". */
1169 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1170 nm++;
1171 #endif /* WINDOWSNT */
1172 #endif /* DOS_NT */
1174 #ifdef WINDOWSNT
1175 /* Discard any previous drive specifier if nm is now in UNC format. */
1176 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1178 drive = 0;
1180 #endif
1182 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1183 none are found, we can probably return right away. We will avoid
1184 allocating a new string if name is already fully expanded. */
1185 if (
1186 IS_DIRECTORY_SEP (nm[0])
1187 #ifdef MSDOS
1188 && drive && !is_escaped
1189 #endif
1190 #ifdef WINDOWSNT
1191 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1192 #endif
1193 #ifdef VMS
1194 || index (nm, ':')
1195 #endif /* VMS */
1198 /* If it turns out that the filename we want to return is just a
1199 suffix of FILENAME, we don't need to go through and edit
1200 things; we just need to construct a new string using data
1201 starting at the middle of FILENAME. If we set lose to a
1202 non-zero value, that means we've discovered that we can't do
1203 that cool trick. */
1204 int lose = 0;
1206 p = nm;
1207 while (*p)
1209 /* Since we know the name is absolute, we can assume that each
1210 element starts with a "/". */
1212 /* "." and ".." are hairy. */
1213 if (IS_DIRECTORY_SEP (p[0])
1214 && p[1] == '.'
1215 && (IS_DIRECTORY_SEP (p[2])
1216 || p[2] == 0
1217 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1218 || p[3] == 0))))
1219 lose = 1;
1220 /* We want to replace multiple `/' in a row with a single
1221 slash. */
1222 else if (p > nm
1223 && IS_DIRECTORY_SEP (p[0])
1224 && IS_DIRECTORY_SEP (p[1]))
1225 lose = 1;
1227 #ifdef VMS
1228 if (p[0] == '\\')
1229 lose = 1;
1230 if (p[0] == '/') {
1231 /* if dev:[dir]/, move nm to / */
1232 if (!slash && p > nm && (brack || colon)) {
1233 nm = (brack ? brack + 1 : colon + 1);
1234 lbrack = rbrack = 0;
1235 brack = 0;
1236 colon = 0;
1238 slash = p;
1240 if (p[0] == '-')
1241 #ifdef NO_HYPHENS_IN_FILENAMES
1242 if (lbrack == rbrack)
1244 /* Avoid clobbering negative version numbers. */
1245 if (dots < 2)
1246 p[0] = '_';
1248 else
1249 #endif /* NO_HYPHENS_IN_FILENAMES */
1250 if (lbrack > rbrack &&
1251 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1252 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1253 lose = 1;
1254 #ifdef NO_HYPHENS_IN_FILENAMES
1255 else
1256 p[0] = '_';
1257 #endif /* NO_HYPHENS_IN_FILENAMES */
1258 /* count open brackets, reset close bracket pointer */
1259 if (p[0] == '[' || p[0] == '<')
1260 lbrack++, brack = 0;
1261 /* count close brackets, set close bracket pointer */
1262 if (p[0] == ']' || p[0] == '>')
1263 rbrack++, brack = p;
1264 /* detect ][ or >< */
1265 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1266 lose = 1;
1267 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1268 nm = p + 1, lose = 1;
1269 if (p[0] == ':' && (colon || slash))
1270 /* if dev1:[dir]dev2:, move nm to dev2: */
1271 if (brack)
1273 nm = brack + 1;
1274 brack = 0;
1276 /* if /name/dev:, move nm to dev: */
1277 else if (slash)
1278 nm = slash + 1;
1279 /* if node::dev:, move colon following dev */
1280 else if (colon && colon[-1] == ':')
1281 colon = p;
1282 /* if dev1:dev2:, move nm to dev2: */
1283 else if (colon && colon[-1] != ':')
1285 nm = colon + 1;
1286 colon = 0;
1288 if (p[0] == ':' && !colon)
1290 if (p[1] == ':')
1291 p++;
1292 colon = p;
1294 if (lbrack == rbrack)
1295 if (p[0] == ';')
1296 dots = 2;
1297 else if (p[0] == '.')
1298 dots++;
1299 #endif /* VMS */
1300 p++;
1302 if (!lose)
1304 #ifdef VMS
1305 if (index (nm, '/'))
1307 nm = sys_translate_unix (nm);
1308 return make_specified_string (nm, -1, strlen (nm), multibyte);
1310 #endif /* VMS */
1311 #ifdef DOS_NT
1312 /* Make sure directories are all separated with / or \ as
1313 desired, but avoid allocation of a new string when not
1314 required. */
1315 CORRECT_DIR_SEPS (nm);
1316 #ifdef WINDOWSNT
1317 if (IS_DIRECTORY_SEP (nm[1]))
1319 if (strcmp (nm, SDATA (name)) != 0)
1320 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1322 else
1323 #endif
1324 /* drive must be set, so this is okay */
1325 if (strcmp (nm - 2, SDATA (name)) != 0)
1327 char temp[] = " :";
1329 name = make_specified_string (nm, -1, p - nm, multibyte);
1330 temp[0] = DRIVE_LETTER (drive);
1331 name = concat2 (build_string (temp), name);
1333 return name;
1334 #else /* not DOS_NT */
1335 if (nm == SDATA (name))
1336 return name;
1337 return make_specified_string (nm, -1, strlen (nm), multibyte);
1338 #endif /* not DOS_NT */
1342 /* At this point, nm might or might not be an absolute file name. We
1343 need to expand ~ or ~user if present, otherwise prefix nm with
1344 default_directory if nm is not absolute, and finally collapse /./
1345 and /foo/../ sequences.
1347 We set newdir to be the appropriate prefix if one is needed:
1348 - the relevant user directory if nm starts with ~ or ~user
1349 - the specified drive's working dir (DOS/NT only) if nm does not
1350 start with /
1351 - the value of default_directory.
1353 Note that these prefixes are not guaranteed to be absolute (except
1354 for the working dir of a drive). Therefore, to ensure we always
1355 return an absolute name, if the final prefix is not absolute we
1356 append it to the current working directory. */
1358 newdir = 0;
1360 if (nm[0] == '~') /* prefix ~ */
1362 if (IS_DIRECTORY_SEP (nm[1])
1363 #ifdef VMS
1364 || nm[1] == ':'
1365 #endif /* VMS */
1366 || nm[1] == 0) /* ~ by itself */
1368 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1369 newdir = (unsigned char *) "";
1370 nm++;
1371 #ifdef DOS_NT
1372 collapse_newdir = 0;
1373 #endif
1374 #ifdef VMS
1375 nm++; /* Don't leave the slash in nm. */
1376 #endif /* VMS */
1378 else /* ~user/filename */
1380 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1381 #ifdef VMS
1382 && *p != ':'
1383 #endif /* VMS */
1384 ); p++);
1385 o = (unsigned char *) alloca (p - nm + 1);
1386 bcopy ((char *) nm, o, p - nm);
1387 o [p - nm] = 0;
1389 pw = (struct passwd *) getpwnam (o + 1);
1390 if (pw)
1392 newdir = (unsigned char *) pw -> pw_dir;
1393 #ifdef VMS
1394 nm = p + 1; /* skip the terminator */
1395 #else
1396 nm = p;
1397 #ifdef DOS_NT
1398 collapse_newdir = 0;
1399 #endif
1400 #endif /* VMS */
1403 /* If we don't find a user of that name, leave the name
1404 unchanged; don't move nm forward to p. */
1408 #ifdef DOS_NT
1409 /* On DOS and Windows, nm is absolute if a drive name was specified;
1410 use the drive's current directory as the prefix if needed. */
1411 if (!newdir && drive)
1413 /* Get default directory if needed to make nm absolute. */
1414 if (!IS_DIRECTORY_SEP (nm[0]))
1416 newdir = alloca (MAXPATHLEN + 1);
1417 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1418 newdir = NULL;
1420 if (!newdir)
1422 /* Either nm starts with /, or drive isn't mounted. */
1423 newdir = alloca (4);
1424 newdir[0] = DRIVE_LETTER (drive);
1425 newdir[1] = ':';
1426 newdir[2] = '/';
1427 newdir[3] = 0;
1430 #endif /* DOS_NT */
1432 /* Finally, if no prefix has been specified and nm is not absolute,
1433 then it must be expanded relative to default_directory. */
1435 if (1
1436 #ifndef DOS_NT
1437 /* /... alone is not absolute on DOS and Windows. */
1438 && !IS_DIRECTORY_SEP (nm[0])
1439 #endif
1440 #ifdef WINDOWSNT
1441 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1442 #endif
1443 #ifdef VMS
1444 && !index (nm, ':')
1445 #endif
1446 && !newdir)
1448 newdir = SDATA (default_directory);
1449 multibyte |= STRING_MULTIBYTE (default_directory);
1450 #ifdef DOS_NT
1451 /* Note if special escape prefix is present, but remove for now. */
1452 if (newdir[0] == '/' && newdir[1] == ':')
1454 is_escaped = 1;
1455 newdir += 2;
1457 #endif
1460 #ifdef DOS_NT
1461 if (newdir)
1463 /* First ensure newdir is an absolute name. */
1464 if (
1465 /* Detect MSDOS file names with drive specifiers. */
1466 ! (IS_DRIVE (newdir[0])
1467 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1468 #ifdef WINDOWSNT
1469 /* Detect Windows file names in UNC format. */
1470 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1471 #endif
1474 /* Effectively, let newdir be (expand-file-name newdir cwd).
1475 Because of the admonition against calling expand-file-name
1476 when we have pointers into lisp strings, we accomplish this
1477 indirectly by prepending newdir to nm if necessary, and using
1478 cwd (or the wd of newdir's drive) as the new newdir. */
1480 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1482 drive = newdir[0];
1483 newdir += 2;
1485 if (!IS_DIRECTORY_SEP (nm[0]))
1487 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1488 file_name_as_directory (tmp, newdir);
1489 strcat (tmp, nm);
1490 nm = tmp;
1492 newdir = alloca (MAXPATHLEN + 1);
1493 if (drive)
1495 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1496 newdir = "/";
1498 else
1499 getwd (newdir);
1502 /* Strip off drive name from prefix, if present. */
1503 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1505 drive = newdir[0];
1506 newdir += 2;
1509 /* Keep only a prefix from newdir if nm starts with slash
1510 (//server/share for UNC, nothing otherwise). */
1511 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1513 #ifdef WINDOWSNT
1514 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1516 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1517 p = newdir + 2;
1518 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1519 p++;
1520 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1521 *p = 0;
1523 else
1524 #endif
1525 newdir = "";
1528 #endif /* DOS_NT */
1530 if (newdir)
1532 /* Get rid of any slash at the end of newdir, unless newdir is
1533 just / or // (an incomplete UNC name). */
1534 length = strlen (newdir);
1535 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1536 #ifdef WINDOWSNT
1537 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1538 #endif
1541 unsigned char *temp = (unsigned char *) alloca (length);
1542 bcopy (newdir, temp, length - 1);
1543 temp[length - 1] = 0;
1544 newdir = temp;
1546 tlen = length + 1;
1548 else
1549 tlen = 0;
1551 /* Now concatenate the directory and name to new space in the stack frame */
1552 tlen += strlen (nm) + 1;
1553 #ifdef DOS_NT
1554 /* Reserve space for drive specifier and escape prefix, since either
1555 or both may need to be inserted. (The Microsoft x86 compiler
1556 produces incorrect code if the following two lines are combined.) */
1557 target = (unsigned char *) alloca (tlen + 4);
1558 target += 4;
1559 #else /* not DOS_NT */
1560 target = (unsigned char *) alloca (tlen);
1561 #endif /* not DOS_NT */
1562 *target = 0;
1564 if (newdir)
1566 #ifndef VMS
1567 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1569 #ifdef DOS_NT
1570 /* If newdir is effectively "C:/", then the drive letter will have
1571 been stripped and newdir will be "/". Concatenating with an
1572 absolute directory in nm produces "//", which will then be
1573 incorrectly treated as a network share. Ignore newdir in
1574 this case (keeping the drive letter). */
1575 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1576 && newdir[1] == '\0'))
1577 #endif
1578 strcpy (target, newdir);
1580 else
1581 #endif
1582 file_name_as_directory (target, newdir);
1585 strcat (target, nm);
1586 #ifdef VMS
1587 if (index (target, '/'))
1588 strcpy (target, sys_translate_unix (target));
1589 #endif /* VMS */
1591 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1593 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1594 appear. */
1596 p = target;
1597 o = target;
1599 while (*p)
1601 #ifdef VMS
1602 if (*p != ']' && *p != '>' && *p != '-')
1604 if (*p == '\\')
1605 p++;
1606 *o++ = *p++;
1608 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1609 /* brackets are offset from each other by 2 */
1611 p += 2;
1612 if (*p != '.' && *p != '-' && o[-1] != '.')
1613 /* convert [foo][bar] to [bar] */
1614 while (o[-1] != '[' && o[-1] != '<')
1615 o--;
1616 else if (*p == '-' && *o != '.')
1617 *--p = '.';
1619 else if (p[0] == '-' && o[-1] == '.' &&
1620 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1621 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1624 o--;
1625 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1626 if (p[1] == '.') /* foo.-.bar ==> bar. */
1627 p += 2;
1628 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1629 p++, o--;
1630 /* else [foo.-] ==> [-] */
1632 else
1634 #ifdef NO_HYPHENS_IN_FILENAMES
1635 if (*p == '-' &&
1636 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1637 p[1] != ']' && p[1] != '>' && p[1] != '.')
1638 *p = '_';
1639 #endif /* NO_HYPHENS_IN_FILENAMES */
1640 *o++ = *p++;
1642 #else /* not VMS */
1643 if (!IS_DIRECTORY_SEP (*p))
1645 *o++ = *p++;
1647 else if (IS_DIRECTORY_SEP (p[0])
1648 && p[1] == '.'
1649 && (IS_DIRECTORY_SEP (p[2])
1650 || p[2] == 0))
1652 /* If "/." is the entire filename, keep the "/". Otherwise,
1653 just delete the whole "/.". */
1654 if (o == target && p[2] == '\0')
1655 *o++ = *p;
1656 p += 2;
1658 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1659 /* `/../' is the "superroot" on certain file systems.
1660 Turned off on DOS_NT systems because they have no
1661 "superroot" and because this causes us to produce
1662 file names like "d:/../foo" which fail file-related
1663 functions of the underlying OS. (To reproduce, try a
1664 long series of "../../" in default_directory, longer
1665 than the number of levels from the root.) */
1666 #ifndef DOS_NT
1667 && o != target
1668 #endif
1669 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1671 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1673 /* Keep initial / only if this is the whole name. */
1674 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1675 ++o;
1676 p += 3;
1678 else if (p > target
1679 && IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1]))
1681 /* Collapse multiple `/' in a row. */
1682 *o++ = *p++;
1683 while (IS_DIRECTORY_SEP (*p))
1684 ++p;
1686 else
1688 *o++ = *p++;
1690 #endif /* not VMS */
1693 #ifdef DOS_NT
1694 /* At last, set drive name. */
1695 #ifdef WINDOWSNT
1696 /* Except for network file name. */
1697 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1698 #endif /* WINDOWSNT */
1700 if (!drive) abort ();
1701 target -= 2;
1702 target[0] = DRIVE_LETTER (drive);
1703 target[1] = ':';
1705 /* Reinsert the escape prefix if required. */
1706 if (is_escaped)
1708 target -= 2;
1709 target[0] = '/';
1710 target[1] = ':';
1712 CORRECT_DIR_SEPS (target);
1713 #endif /* DOS_NT */
1715 result = make_specified_string (target, -1, o - target, multibyte);
1717 /* Again look to see if the file name has special constructs in it
1718 and perhaps call the corresponding file handler. This is needed
1719 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1720 the ".." component gives us "/user@host:/bar/../baz" which needs
1721 to be expanded again. */
1722 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1723 if (!NILP (handler))
1724 return call3 (handler, Qexpand_file_name, result, default_directory);
1726 return result;
1729 #if 0
1730 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1731 This is the old version of expand-file-name, before it was thoroughly
1732 rewritten for Emacs 10.31. We leave this version here commented-out,
1733 because the code is very complex and likely to have subtle bugs. If
1734 bugs _are_ found, it might be of interest to look at the old code and
1735 see what did it do in the relevant situation.
1737 Don't remove this code: it's true that it will be accessible via CVS,
1738 but a few years from deletion, people will forget it is there. */
1740 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1741 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1742 "Convert FILENAME to absolute, and canonicalize it.\n\
1743 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1744 \(does not start with slash); if DEFAULT is nil or missing,\n\
1745 the current buffer's value of default-directory is used.\n\
1746 Filenames containing `.' or `..' as components are simplified;\n\
1747 initial `~/' expands to your home directory.\n\
1748 See also the function `substitute-in-file-name'.")
1749 (name, defalt)
1750 Lisp_Object name, defalt;
1752 unsigned char *nm;
1754 register unsigned char *newdir, *p, *o;
1755 int tlen;
1756 unsigned char *target;
1757 struct passwd *pw;
1758 int lose;
1759 #ifdef VMS
1760 unsigned char * colon = 0;
1761 unsigned char * close = 0;
1762 unsigned char * slash = 0;
1763 unsigned char * brack = 0;
1764 int lbrack = 0, rbrack = 0;
1765 int dots = 0;
1766 #endif /* VMS */
1768 CHECK_STRING (name);
1770 #ifdef VMS
1771 /* Filenames on VMS are always upper case. */
1772 name = Fupcase (name);
1773 #endif
1775 nm = SDATA (name);
1777 /* If nm is absolute, flush ...// and detect /./ and /../.
1778 If no /./ or /../ we can return right away. */
1779 if (
1780 nm[0] == '/'
1781 #ifdef VMS
1782 || index (nm, ':')
1783 #endif /* VMS */
1786 p = nm;
1787 lose = 0;
1788 while (*p)
1790 if (p[0] == '/' && p[1] == '/'
1791 #ifdef APOLLO
1792 /* // at start of filename is meaningful on Apollo system. */
1793 && nm != p
1794 #endif /* APOLLO */
1796 nm = p + 1;
1797 if (p[0] == '/' && p[1] == '~')
1798 nm = p + 1, lose = 1;
1799 if (p[0] == '/' && p[1] == '.'
1800 && (p[2] == '/' || p[2] == 0
1801 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1802 lose = 1;
1803 #ifdef VMS
1804 if (p[0] == '\\')
1805 lose = 1;
1806 if (p[0] == '/') {
1807 /* if dev:[dir]/, move nm to / */
1808 if (!slash && p > nm && (brack || colon)) {
1809 nm = (brack ? brack + 1 : colon + 1);
1810 lbrack = rbrack = 0;
1811 brack = 0;
1812 colon = 0;
1814 slash = p;
1816 if (p[0] == '-')
1817 #ifndef VMS4_4
1818 /* VMS pre V4.4,convert '-'s in filenames. */
1819 if (lbrack == rbrack)
1821 if (dots < 2) /* this is to allow negative version numbers */
1822 p[0] = '_';
1824 else
1825 #endif /* VMS4_4 */
1826 if (lbrack > rbrack &&
1827 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1828 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1829 lose = 1;
1830 #ifndef VMS4_4
1831 else
1832 p[0] = '_';
1833 #endif /* VMS4_4 */
1834 /* count open brackets, reset close bracket pointer */
1835 if (p[0] == '[' || p[0] == '<')
1836 lbrack++, brack = 0;
1837 /* count close brackets, set close bracket pointer */
1838 if (p[0] == ']' || p[0] == '>')
1839 rbrack++, brack = p;
1840 /* detect ][ or >< */
1841 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1842 lose = 1;
1843 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1844 nm = p + 1, lose = 1;
1845 if (p[0] == ':' && (colon || slash))
1846 /* if dev1:[dir]dev2:, move nm to dev2: */
1847 if (brack)
1849 nm = brack + 1;
1850 brack = 0;
1852 /* If /name/dev:, move nm to dev: */
1853 else if (slash)
1854 nm = slash + 1;
1855 /* If node::dev:, move colon following dev */
1856 else if (colon && colon[-1] == ':')
1857 colon = p;
1858 /* If dev1:dev2:, move nm to dev2: */
1859 else if (colon && colon[-1] != ':')
1861 nm = colon + 1;
1862 colon = 0;
1864 if (p[0] == ':' && !colon)
1866 if (p[1] == ':')
1867 p++;
1868 colon = p;
1870 if (lbrack == rbrack)
1871 if (p[0] == ';')
1872 dots = 2;
1873 else if (p[0] == '.')
1874 dots++;
1875 #endif /* VMS */
1876 p++;
1878 if (!lose)
1880 #ifdef VMS
1881 if (index (nm, '/'))
1882 return build_string (sys_translate_unix (nm));
1883 #endif /* VMS */
1884 if (nm == SDATA (name))
1885 return name;
1886 return build_string (nm);
1890 /* Now determine directory to start with and put it in NEWDIR */
1892 newdir = 0;
1894 if (nm[0] == '~') /* prefix ~ */
1895 if (nm[1] == '/'
1896 #ifdef VMS
1897 || nm[1] == ':'
1898 #endif /* VMS */
1899 || nm[1] == 0)/* ~/filename */
1901 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1902 newdir = (unsigned char *) "";
1903 nm++;
1904 #ifdef VMS
1905 nm++; /* Don't leave the slash in nm. */
1906 #endif /* VMS */
1908 else /* ~user/filename */
1910 /* Get past ~ to user */
1911 unsigned char *user = nm + 1;
1912 /* Find end of name. */
1913 unsigned char *ptr = (unsigned char *) index (user, '/');
1914 int len = ptr ? ptr - user : strlen (user);
1915 #ifdef VMS
1916 unsigned char *ptr1 = index (user, ':');
1917 if (ptr1 != 0 && ptr1 - user < len)
1918 len = ptr1 - user;
1919 #endif /* VMS */
1920 /* Copy the user name into temp storage. */
1921 o = (unsigned char *) alloca (len + 1);
1922 bcopy ((char *) user, o, len);
1923 o[len] = 0;
1925 /* Look up the user name. */
1926 pw = (struct passwd *) getpwnam (o + 1);
1927 if (!pw)
1928 error ("\"%s\" isn't a registered user", o + 1);
1930 newdir = (unsigned char *) pw->pw_dir;
1932 /* Discard the user name from NM. */
1933 nm += len;
1936 if (nm[0] != '/'
1937 #ifdef VMS
1938 && !index (nm, ':')
1939 #endif /* not VMS */
1940 && !newdir)
1942 if (NILP (defalt))
1943 defalt = current_buffer->directory;
1944 CHECK_STRING (defalt);
1945 newdir = SDATA (defalt);
1948 /* Now concatenate the directory and name to new space in the stack frame */
1950 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1951 target = (unsigned char *) alloca (tlen);
1952 *target = 0;
1954 if (newdir)
1956 #ifndef VMS
1957 if (nm[0] == 0 || nm[0] == '/')
1958 strcpy (target, newdir);
1959 else
1960 #endif
1961 file_name_as_directory (target, newdir);
1964 strcat (target, nm);
1965 #ifdef VMS
1966 if (index (target, '/'))
1967 strcpy (target, sys_translate_unix (target));
1968 #endif /* VMS */
1970 /* Now canonicalize by removing /. and /foo/.. if they appear */
1972 p = target;
1973 o = target;
1975 while (*p)
1977 #ifdef VMS
1978 if (*p != ']' && *p != '>' && *p != '-')
1980 if (*p == '\\')
1981 p++;
1982 *o++ = *p++;
1984 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1985 /* brackets are offset from each other by 2 */
1987 p += 2;
1988 if (*p != '.' && *p != '-' && o[-1] != '.')
1989 /* convert [foo][bar] to [bar] */
1990 while (o[-1] != '[' && o[-1] != '<')
1991 o--;
1992 else if (*p == '-' && *o != '.')
1993 *--p = '.';
1995 else if (p[0] == '-' && o[-1] == '.' &&
1996 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1997 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2000 o--;
2001 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2002 if (p[1] == '.') /* foo.-.bar ==> bar. */
2003 p += 2;
2004 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2005 p++, o--;
2006 /* else [foo.-] ==> [-] */
2008 else
2010 #ifndef VMS4_4
2011 if (*p == '-' &&
2012 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
2013 p[1] != ']' && p[1] != '>' && p[1] != '.')
2014 *p = '_';
2015 #endif /* VMS4_4 */
2016 *o++ = *p++;
2018 #else /* not VMS */
2019 if (*p != '/')
2021 *o++ = *p++;
2023 else if (!strncmp (p, "//", 2)
2024 #ifdef APOLLO
2025 /* // at start of filename is meaningful in Apollo system. */
2026 && o != target
2027 #endif /* APOLLO */
2030 o = target;
2031 p++;
2033 else if (p[0] == '/' && p[1] == '.' &&
2034 (p[2] == '/' || p[2] == 0))
2035 p += 2;
2036 else if (!strncmp (p, "/..", 3)
2037 /* `/../' is the "superroot" on certain file systems. */
2038 && o != target
2039 && (p[3] == '/' || p[3] == 0))
2041 while (o != target && *--o != '/')
2043 #ifdef APOLLO
2044 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2045 ++o;
2046 else
2047 #endif /* APOLLO */
2048 if (o == target && *o == '/')
2049 ++o;
2050 p += 3;
2052 else
2054 *o++ = *p++;
2056 #endif /* not VMS */
2059 return make_string (target, o - target);
2061 #endif
2063 /* If /~ or // appears, discard everything through first slash. */
2064 static int
2065 file_name_absolute_p (filename)
2066 const unsigned char *filename;
2068 return
2069 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2070 #ifdef VMS
2071 /* ??? This criterion is probably wrong for '<'. */
2072 || index (filename, ':') || index (filename, '<')
2073 || (*filename == '[' && (filename[1] != '-'
2074 || (filename[2] != '.' && filename[2] != ']'))
2075 && filename[1] != '.')
2076 #endif /* VMS */
2077 #ifdef DOS_NT
2078 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2079 && IS_DIRECTORY_SEP (filename[2]))
2080 #endif
2084 static unsigned char *
2085 search_embedded_absfilename (nm, endp)
2086 unsigned char *nm, *endp;
2088 unsigned char *p, *s;
2090 for (p = nm + 1; p < endp; p++)
2092 if ((0
2093 #ifdef VMS
2094 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2095 #endif /* VMS */
2096 || IS_DIRECTORY_SEP (p[-1]))
2097 && file_name_absolute_p (p)
2098 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2099 /* // at start of file name is meaningful in Apollo,
2100 WindowsNT and Cygwin systems. */
2101 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2102 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2105 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2106 #ifdef VMS
2107 && *s != ':'
2108 #endif /* VMS */
2109 ); s++);
2110 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2112 unsigned char *o = alloca (s - p + 1);
2113 struct passwd *pw;
2114 bcopy (p, o, s - p);
2115 o [s - p] = 0;
2117 /* If we have ~user and `user' exists, discard
2118 everything up to ~. But if `user' does not exist, leave
2119 ~user alone, it might be a literal file name. */
2120 if ((pw = getpwnam (o + 1)))
2121 return p;
2122 else
2123 xfree (pw);
2125 else
2126 return p;
2129 return NULL;
2132 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2133 Ssubstitute_in_file_name, 1, 1, 0,
2134 doc: /* Substitute environment variables referred to in FILENAME.
2135 `$FOO' where FOO is an environment variable name means to substitute
2136 the value of that variable. The variable name should be terminated
2137 with a character not a letter, digit or underscore; otherwise, enclose
2138 the entire variable name in braces.
2139 If `/~' appears, all of FILENAME through that `/' is discarded.
2141 On VMS, `$' substitution is not done; this function does little and only
2142 duplicates what `expand-file-name' does. */)
2143 (filename)
2144 Lisp_Object filename;
2146 unsigned char *nm;
2148 register unsigned char *s, *p, *o, *x, *endp;
2149 unsigned char *target = NULL;
2150 int total = 0;
2151 int substituted = 0;
2152 unsigned char *xnm;
2153 Lisp_Object handler;
2155 CHECK_STRING (filename);
2157 /* If the file name has special constructs in it,
2158 call the corresponding file handler. */
2159 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2160 if (!NILP (handler))
2161 return call2 (handler, Qsubstitute_in_file_name, filename);
2163 nm = SDATA (filename);
2164 #ifdef DOS_NT
2165 nm = strcpy (alloca (strlen (nm) + 1), nm);
2166 CORRECT_DIR_SEPS (nm);
2167 substituted = (strcmp (nm, SDATA (filename)) != 0);
2168 #endif
2169 endp = nm + SBYTES (filename);
2171 /* If /~ or // appears, discard everything through first slash. */
2172 p = search_embedded_absfilename (nm, endp);
2173 if (p)
2174 /* Start over with the new string, so we check the file-name-handler
2175 again. Important with filenames like "/home/foo//:/hello///there"
2176 which whould substitute to "/:/hello///there" rather than "/there". */
2177 return Fsubstitute_in_file_name
2178 (make_specified_string (p, -1, endp - p,
2179 STRING_MULTIBYTE (filename)));
2181 #ifdef VMS
2182 return filename;
2183 #else
2185 /* See if any variables are substituted into the string
2186 and find the total length of their values in `total' */
2188 for (p = nm; p != endp;)
2189 if (*p != '$')
2190 p++;
2191 else
2193 p++;
2194 if (p == endp)
2195 goto badsubst;
2196 else if (*p == '$')
2198 /* "$$" means a single "$" */
2199 p++;
2200 total -= 1;
2201 substituted = 1;
2202 continue;
2204 else if (*p == '{')
2206 o = ++p;
2207 while (p != endp && *p != '}') p++;
2208 if (*p != '}') goto missingclose;
2209 s = p;
2211 else
2213 o = p;
2214 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2215 s = p;
2218 /* Copy out the variable name */
2219 target = (unsigned char *) alloca (s - o + 1);
2220 strncpy (target, o, s - o);
2221 target[s - o] = 0;
2222 #ifdef DOS_NT
2223 strupr (target); /* $home == $HOME etc. */
2224 #endif /* DOS_NT */
2226 /* Get variable value */
2227 o = (unsigned char *) egetenv (target);
2228 if (o)
2230 total += strlen (o);
2231 substituted = 1;
2233 else if (*p == '}')
2234 goto badvar;
2237 if (!substituted)
2238 return filename;
2240 /* If substitution required, recopy the string and do it */
2241 /* Make space in stack frame for the new copy */
2242 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2243 x = xnm;
2245 /* Copy the rest of the name through, replacing $ constructs with values */
2246 for (p = nm; *p;)
2247 if (*p != '$')
2248 *x++ = *p++;
2249 else
2251 p++;
2252 if (p == endp)
2253 goto badsubst;
2254 else if (*p == '$')
2256 *x++ = *p++;
2257 continue;
2259 else if (*p == '{')
2261 o = ++p;
2262 while (p != endp && *p != '}') p++;
2263 if (*p != '}') goto missingclose;
2264 s = p++;
2266 else
2268 o = p;
2269 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2270 s = p;
2273 /* Copy out the variable name */
2274 target = (unsigned char *) alloca (s - o + 1);
2275 strncpy (target, o, s - o);
2276 target[s - o] = 0;
2277 #ifdef DOS_NT
2278 strupr (target); /* $home == $HOME etc. */
2279 #endif /* DOS_NT */
2281 /* Get variable value */
2282 o = (unsigned char *) egetenv (target);
2283 if (!o)
2285 *x++ = '$';
2286 strcpy (x, target); x+= strlen (target);
2288 else if (STRING_MULTIBYTE (filename))
2290 /* If the original string is multibyte,
2291 convert what we substitute into multibyte. */
2292 while (*o)
2294 int c = unibyte_char_to_multibyte (*o++);
2295 x += CHAR_STRING (c, x);
2298 else
2300 strcpy (x, o);
2301 x += strlen (o);
2305 *x = 0;
2307 /* If /~ or // appears, discard everything through first slash. */
2308 while ((p = search_embedded_absfilename (xnm, x)))
2309 /* This time we do not start over because we've already expanded envvars
2310 and replaced $$ with $. Maybe we should start over as well, but we'd
2311 need to quote some $ to $$ first. */
2312 xnm = p;
2314 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2316 badsubst:
2317 error ("Bad format environment-variable substitution");
2318 missingclose:
2319 error ("Missing \"}\" in environment-variable substitution");
2320 badvar:
2321 error ("Substituting nonexistent environment variable \"%s\"", target);
2323 /* NOTREACHED */
2324 #endif /* not VMS */
2325 return Qnil;
2328 /* A slightly faster and more convenient way to get
2329 (directory-file-name (expand-file-name FOO)). */
2331 Lisp_Object
2332 expand_and_dir_to_file (filename, defdir)
2333 Lisp_Object filename, defdir;
2335 register Lisp_Object absname;
2337 absname = Fexpand_file_name (filename, defdir);
2338 #ifdef VMS
2340 register int c = SREF (absname, SBYTES (absname) - 1);
2341 if (c == ':' || c == ']' || c == '>')
2342 absname = Fdirectory_file_name (absname);
2344 #else
2345 /* Remove final slash, if any (unless this is the root dir).
2346 stat behaves differently depending! */
2347 if (SCHARS (absname) > 1
2348 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2349 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2350 /* We cannot take shortcuts; they might be wrong for magic file names. */
2351 absname = Fdirectory_file_name (absname);
2352 #endif
2353 return absname;
2356 /* Signal an error if the file ABSNAME already exists.
2357 If INTERACTIVE is nonzero, ask the user whether to proceed,
2358 and bypass the error if the user says to go ahead.
2359 QUERYSTRING is a name for the action that is being considered
2360 to alter the file.
2362 *STATPTR is used to store the stat information if the file exists.
2363 If the file does not exist, STATPTR->st_mode is set to 0.
2364 If STATPTR is null, we don't store into it.
2366 If QUICK is nonzero, we ask for y or n, not yes or no. */
2368 void
2369 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2370 Lisp_Object absname;
2371 unsigned char *querystring;
2372 int interactive;
2373 struct stat *statptr;
2374 int quick;
2376 register Lisp_Object tem, encoded_filename;
2377 struct stat statbuf;
2378 struct gcpro gcpro1;
2380 encoded_filename = ENCODE_FILE (absname);
2382 /* stat is a good way to tell whether the file exists,
2383 regardless of what access permissions it has. */
2384 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2386 if (! interactive)
2387 Fsignal (Qfile_already_exists,
2388 Fcons (build_string ("File already exists"),
2389 Fcons (absname, Qnil)));
2390 GCPRO1 (absname);
2391 tem = format2 ("File %s already exists; %s anyway? ",
2392 absname, build_string (querystring));
2393 if (quick)
2394 tem = Fy_or_n_p (tem);
2395 else
2396 tem = do_yes_or_no_p (tem);
2397 UNGCPRO;
2398 if (NILP (tem))
2399 Fsignal (Qfile_already_exists,
2400 Fcons (build_string ("File already exists"),
2401 Fcons (absname, Qnil)));
2402 if (statptr)
2403 *statptr = statbuf;
2405 else
2407 if (statptr)
2408 statptr->st_mode = 0;
2410 return;
2413 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 6,
2414 "fCopy file: \nGCopy %s to file: \np\nP",
2415 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2416 If NEWNAME names a directory, copy FILE there.
2417 Signals a `file-already-exists' error if file NEWNAME already exists,
2418 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2419 A number as third arg means request confirmation if NEWNAME already exists.
2420 This is what happens in interactive use with M-x.
2421 Always sets the file modes of the output file to match the input file.
2423 Fourth arg KEEP-TIME non-nil means give the output file the same
2424 last-modified time as the old one. (This works on only some systems.)
2426 A prefix arg makes KEEP-TIME non-nil.
2428 The optional fifth arg MUSTBENEW, if non-nil, insists on a check
2429 for an existing file with the same name. If MUSTBENEW is `excl',
2430 that means to get an error if the file already exists; never overwrite.
2431 If MUSTBENEW is neither nil nor `excl', that means ask for
2432 confirmation before overwriting, but do go ahead and overwrite the file
2433 if the user confirms.
2435 If PRESERVE-UID-GID is non-nil, we try to transfer the
2436 uid and gid of FILE to NEWNAME. */)
2437 (file, newname, ok_if_already_exists, keep_time, mustbenew, preserve_uid_gid)
2438 Lisp_Object file, newname, ok_if_already_exists, keep_time, mustbenew;
2439 Lisp_Object preserve_uid_gid;
2441 int ifd, ofd, n;
2442 char buf[16 * 1024];
2443 struct stat st, out_st;
2444 Lisp_Object handler;
2445 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2446 int count = SPECPDL_INDEX ();
2447 int input_file_statable_p;
2448 Lisp_Object encoded_file, encoded_newname;
2450 encoded_file = encoded_newname = Qnil;
2451 GCPRO4 (file, newname, encoded_file, encoded_newname);
2452 CHECK_STRING (file);
2453 CHECK_STRING (newname);
2455 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
2456 barf_or_query_if_file_exists (newname, "overwrite", 1, 0, 1);
2458 if (!NILP (Ffile_directory_p (newname)))
2459 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2460 else
2461 newname = Fexpand_file_name (newname, Qnil);
2463 file = Fexpand_file_name (file, Qnil);
2465 /* If the input file name has special constructs in it,
2466 call the corresponding file handler. */
2467 handler = Ffind_file_name_handler (file, Qcopy_file);
2468 /* Likewise for output file name. */
2469 if (NILP (handler))
2470 handler = Ffind_file_name_handler (newname, Qcopy_file);
2471 if (!NILP (handler))
2472 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2473 ok_if_already_exists, keep_time));
2475 encoded_file = ENCODE_FILE (file);
2476 encoded_newname = ENCODE_FILE (newname);
2478 if (NILP (ok_if_already_exists)
2479 || INTEGERP (ok_if_already_exists))
2480 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2481 INTEGERP (ok_if_already_exists), &out_st, 0);
2482 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2483 out_st.st_mode = 0;
2485 #ifdef WINDOWSNT
2486 if (!CopyFile (SDATA (encoded_file),
2487 SDATA (encoded_newname),
2488 FALSE))
2489 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2490 /* CopyFile retains the timestamp by default. */
2491 else if (NILP (keep_time))
2493 EMACS_TIME now;
2494 DWORD attributes;
2495 char * filename;
2497 EMACS_GET_TIME (now);
2498 filename = SDATA (encoded_newname);
2500 /* Ensure file is writable while its modified time is set. */
2501 attributes = GetFileAttributes (filename);
2502 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2503 if (set_file_times (filename, now, now))
2505 /* Restore original attributes. */
2506 SetFileAttributes (filename, attributes);
2507 Fsignal (Qfile_date_error,
2508 Fcons (build_string ("Cannot set file date"),
2509 Fcons (newname, Qnil)));
2511 /* Restore original attributes. */
2512 SetFileAttributes (filename, attributes);
2514 #else /* not WINDOWSNT */
2515 immediate_quit = 1;
2516 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2517 immediate_quit = 0;
2519 if (ifd < 0)
2520 report_file_error ("Opening input file", Fcons (file, Qnil));
2522 record_unwind_protect (close_file_unwind, make_number (ifd));
2524 /* We can only copy regular files and symbolic links. Other files are not
2525 copyable by us. */
2526 input_file_statable_p = (fstat (ifd, &st) >= 0);
2528 #if !defined (MSDOS) || __DJGPP__ > 1
2529 if (out_st.st_mode != 0
2530 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2532 errno = 0;
2533 report_file_error ("Input and output files are the same",
2534 Fcons (file, Fcons (newname, Qnil)));
2536 #endif
2538 #if defined (S_ISREG) && defined (S_ISLNK)
2539 if (input_file_statable_p)
2541 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2543 #if defined (EISDIR)
2544 /* Get a better looking error message. */
2545 errno = EISDIR;
2546 #endif /* EISDIR */
2547 report_file_error ("Non-regular file", Fcons (file, Qnil));
2550 #endif /* S_ISREG && S_ISLNK */
2552 #ifdef VMS
2553 /* Create the copy file with the same record format as the input file */
2554 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2555 #else
2556 #ifdef MSDOS
2557 /* System's default file type was set to binary by _fmode in emacs.c. */
2558 ofd = emacs_open (SDATA (encoded_newname),
2559 O_WRONLY | O_TRUNC | O_CREAT
2560 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
2561 S_IREAD | S_IWRITE);
2562 #else /* not MSDOS */
2563 ofd = emacs_open (SDATA (encoded_newname),
2564 O_WRONLY | O_TRUNC | O_CREAT
2565 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
2566 0666);
2567 #endif /* not MSDOS */
2568 #endif /* VMS */
2569 if (ofd < 0)
2570 report_file_error ("Opening output file", Fcons (newname, Qnil));
2572 record_unwind_protect (close_file_unwind, make_number (ofd));
2574 immediate_quit = 1;
2575 QUIT;
2576 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2577 if (emacs_write (ofd, buf, n) != n)
2578 report_file_error ("I/O error", Fcons (newname, Qnil));
2579 immediate_quit = 0;
2581 #ifndef MSDOS
2582 /* Preserve the original file modes, and if requested, also its
2583 owner and group. */
2584 if (input_file_statable_p)
2586 if (! NILP (preserve_uid_gid))
2587 fchown (ofd, st.st_uid, st.st_gid);
2588 fchmod (ofd, st.st_mode & 07777);
2590 #endif /* not MSDOS */
2592 /* Closing the output clobbers the file times on some systems. */
2593 if (emacs_close (ofd) < 0)
2594 report_file_error ("I/O error", Fcons (newname, Qnil));
2596 if (input_file_statable_p)
2598 if (!NILP (keep_time))
2600 EMACS_TIME atime, mtime;
2601 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2602 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2603 if (set_file_times (SDATA (encoded_newname),
2604 atime, mtime))
2605 Fsignal (Qfile_date_error,
2606 Fcons (build_string ("Cannot set file date"),
2607 Fcons (newname, Qnil)));
2611 emacs_close (ifd);
2613 #if defined (__DJGPP__) && __DJGPP__ > 1
2614 if (input_file_statable_p)
2616 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2617 and if it can't, it tells so. Otherwise, under MSDOS we usually
2618 get only the READ bit, which will make the copied file read-only,
2619 so it's better not to chmod at all. */
2620 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2621 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2623 #endif /* DJGPP version 2 or newer */
2624 #endif /* not WINDOWSNT */
2626 /* Discard the unwind protects. */
2627 specpdl_ptr = specpdl + count;
2629 UNGCPRO;
2630 return Qnil;
2633 DEFUN ("make-directory-internal", Fmake_directory_internal,
2634 Smake_directory_internal, 1, 1, 0,
2635 doc: /* Create a new directory named DIRECTORY. */)
2636 (directory)
2637 Lisp_Object directory;
2639 const unsigned char *dir;
2640 Lisp_Object handler;
2641 Lisp_Object encoded_dir;
2643 CHECK_STRING (directory);
2644 directory = Fexpand_file_name (directory, Qnil);
2646 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2647 if (!NILP (handler))
2648 return call2 (handler, Qmake_directory_internal, directory);
2650 encoded_dir = ENCODE_FILE (directory);
2652 dir = SDATA (encoded_dir);
2654 #ifdef WINDOWSNT
2655 if (mkdir (dir) != 0)
2656 #else
2657 if (mkdir (dir, 0777) != 0)
2658 #endif
2659 report_file_error ("Creating directory", Flist (1, &directory));
2661 return Qnil;
2664 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2665 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2666 (directory)
2667 Lisp_Object directory;
2669 const unsigned char *dir;
2670 Lisp_Object handler;
2671 Lisp_Object encoded_dir;
2673 CHECK_STRING (directory);
2674 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2676 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2677 if (!NILP (handler))
2678 return call2 (handler, Qdelete_directory, directory);
2680 encoded_dir = ENCODE_FILE (directory);
2682 dir = SDATA (encoded_dir);
2684 if (rmdir (dir) != 0)
2685 report_file_error ("Removing directory", Flist (1, &directory));
2687 return Qnil;
2690 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2691 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2692 If file has multiple names, it continues to exist with the other names. */)
2693 (filename)
2694 Lisp_Object filename;
2696 Lisp_Object handler;
2697 Lisp_Object encoded_file;
2698 struct gcpro gcpro1;
2700 GCPRO1 (filename);
2701 if (!NILP (Ffile_directory_p (filename))
2702 && NILP (Ffile_symlink_p (filename)))
2703 Fsignal (Qfile_error,
2704 Fcons (build_string ("Removing old name: is a directory"),
2705 Fcons (filename, Qnil)));
2706 UNGCPRO;
2707 filename = Fexpand_file_name (filename, Qnil);
2709 handler = Ffind_file_name_handler (filename, Qdelete_file);
2710 if (!NILP (handler))
2711 return call2 (handler, Qdelete_file, filename);
2713 encoded_file = ENCODE_FILE (filename);
2715 if (0 > unlink (SDATA (encoded_file)))
2716 report_file_error ("Removing old name", Flist (1, &filename));
2717 return Qnil;
2720 static Lisp_Object
2721 internal_delete_file_1 (ignore)
2722 Lisp_Object ignore;
2724 return Qt;
2727 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2730 internal_delete_file (filename)
2731 Lisp_Object filename;
2733 Lisp_Object tem;
2734 tem = internal_condition_case_1 (Fdelete_file, filename,
2735 Qt, internal_delete_file_1);
2736 return NILP (tem);
2739 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2740 "fRename file: \nGRename %s to file: \np",
2741 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2742 If file has names other than FILE, it continues to have those names.
2743 Signals a `file-already-exists' error if a file NEWNAME already exists
2744 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2745 A number as third arg means request confirmation if NEWNAME already exists.
2746 This is what happens in interactive use with M-x. */)
2747 (file, newname, ok_if_already_exists)
2748 Lisp_Object file, newname, ok_if_already_exists;
2750 #ifdef NO_ARG_ARRAY
2751 Lisp_Object args[2];
2752 #endif
2753 Lisp_Object handler;
2754 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2755 Lisp_Object encoded_file, encoded_newname, symlink_target;
2757 symlink_target = encoded_file = encoded_newname = Qnil;
2758 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2759 CHECK_STRING (file);
2760 CHECK_STRING (newname);
2761 file = Fexpand_file_name (file, Qnil);
2763 if (!NILP (Ffile_directory_p (newname)))
2764 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2765 else
2766 newname = Fexpand_file_name (newname, Qnil);
2768 /* If the file name has special constructs in it,
2769 call the corresponding file handler. */
2770 handler = Ffind_file_name_handler (file, Qrename_file);
2771 if (NILP (handler))
2772 handler = Ffind_file_name_handler (newname, Qrename_file);
2773 if (!NILP (handler))
2774 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2775 file, newname, ok_if_already_exists));
2777 encoded_file = ENCODE_FILE (file);
2778 encoded_newname = ENCODE_FILE (newname);
2780 #ifdef DOS_NT
2781 /* If the file names are identical but for the case, don't ask for
2782 confirmation: they simply want to change the letter-case of the
2783 file name. */
2784 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2785 #endif
2786 if (NILP (ok_if_already_exists)
2787 || INTEGERP (ok_if_already_exists))
2788 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2789 INTEGERP (ok_if_already_exists), 0, 0);
2790 #ifndef BSD4_1
2791 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2792 #else
2793 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2794 || 0 > unlink (SDATA (encoded_file)))
2795 #endif
2797 if (errno == EXDEV)
2799 #ifdef S_IFLNK
2800 symlink_target = Ffile_symlink_p (file);
2801 if (! NILP (symlink_target))
2802 Fmake_symbolic_link (symlink_target, newname,
2803 NILP (ok_if_already_exists) ? Qnil : Qt);
2804 else
2805 #endif
2806 Fcopy_file (file, newname,
2807 /* We have already prompted if it was an integer,
2808 so don't have copy-file prompt again. */
2809 NILP (ok_if_already_exists) ? Qnil : Qt,
2810 Qt, Qnil, Qt);
2812 Fdelete_file (file);
2814 else
2815 #ifdef NO_ARG_ARRAY
2817 args[0] = file;
2818 args[1] = newname;
2819 report_file_error ("Renaming", Flist (2, args));
2821 #else
2822 report_file_error ("Renaming", Flist (2, &file));
2823 #endif
2825 UNGCPRO;
2826 return Qnil;
2829 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2830 "fAdd name to file: \nGName to add to %s: \np",
2831 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2832 Signals a `file-already-exists' error if a file NEWNAME already exists
2833 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2834 A number as third arg means request confirmation if NEWNAME already exists.
2835 This is what happens in interactive use with M-x. */)
2836 (file, newname, ok_if_already_exists)
2837 Lisp_Object file, newname, ok_if_already_exists;
2839 #ifdef NO_ARG_ARRAY
2840 Lisp_Object args[2];
2841 #endif
2842 Lisp_Object handler;
2843 Lisp_Object encoded_file, encoded_newname;
2844 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2846 GCPRO4 (file, newname, encoded_file, encoded_newname);
2847 encoded_file = encoded_newname = Qnil;
2848 CHECK_STRING (file);
2849 CHECK_STRING (newname);
2850 file = Fexpand_file_name (file, Qnil);
2852 if (!NILP (Ffile_directory_p (newname)))
2853 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2854 else
2855 newname = Fexpand_file_name (newname, Qnil);
2857 /* If the file name has special constructs in it,
2858 call the corresponding file handler. */
2859 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2860 if (!NILP (handler))
2861 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2862 newname, ok_if_already_exists));
2864 /* If the new name has special constructs in it,
2865 call the corresponding file handler. */
2866 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2867 if (!NILP (handler))
2868 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2869 newname, ok_if_already_exists));
2871 encoded_file = ENCODE_FILE (file);
2872 encoded_newname = ENCODE_FILE (newname);
2874 if (NILP (ok_if_already_exists)
2875 || INTEGERP (ok_if_already_exists))
2876 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2877 INTEGERP (ok_if_already_exists), 0, 0);
2879 unlink (SDATA (newname));
2880 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2882 #ifdef NO_ARG_ARRAY
2883 args[0] = file;
2884 args[1] = newname;
2885 report_file_error ("Adding new name", Flist (2, args));
2886 #else
2887 report_file_error ("Adding new name", Flist (2, &file));
2888 #endif
2891 UNGCPRO;
2892 return Qnil;
2895 #ifdef S_IFLNK
2896 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2897 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2898 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2899 Both args must be strings.
2900 Signals a `file-already-exists' error if a file LINKNAME already exists
2901 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2902 A number as third arg means request confirmation if LINKNAME already exists.
2903 This happens for interactive use with M-x. */)
2904 (filename, linkname, ok_if_already_exists)
2905 Lisp_Object filename, linkname, ok_if_already_exists;
2907 #ifdef NO_ARG_ARRAY
2908 Lisp_Object args[2];
2909 #endif
2910 Lisp_Object handler;
2911 Lisp_Object encoded_filename, encoded_linkname;
2912 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2914 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2915 encoded_filename = encoded_linkname = Qnil;
2916 CHECK_STRING (filename);
2917 CHECK_STRING (linkname);
2918 /* If the link target has a ~, we must expand it to get
2919 a truly valid file name. Otherwise, do not expand;
2920 we want to permit links to relative file names. */
2921 if (SREF (filename, 0) == '~')
2922 filename = Fexpand_file_name (filename, Qnil);
2924 if (!NILP (Ffile_directory_p (linkname)))
2925 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2926 else
2927 linkname = Fexpand_file_name (linkname, Qnil);
2929 /* If the file name has special constructs in it,
2930 call the corresponding file handler. */
2931 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2932 if (!NILP (handler))
2933 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2934 linkname, ok_if_already_exists));
2936 /* If the new link name has special constructs in it,
2937 call the corresponding file handler. */
2938 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2939 if (!NILP (handler))
2940 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2941 linkname, ok_if_already_exists));
2943 encoded_filename = ENCODE_FILE (filename);
2944 encoded_linkname = ENCODE_FILE (linkname);
2946 if (NILP (ok_if_already_exists)
2947 || INTEGERP (ok_if_already_exists))
2948 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2949 INTEGERP (ok_if_already_exists), 0, 0);
2950 if (0 > symlink (SDATA (encoded_filename),
2951 SDATA (encoded_linkname)))
2953 /* If we didn't complain already, silently delete existing file. */
2954 if (errno == EEXIST)
2956 unlink (SDATA (encoded_linkname));
2957 if (0 <= symlink (SDATA (encoded_filename),
2958 SDATA (encoded_linkname)))
2960 UNGCPRO;
2961 return Qnil;
2965 #ifdef NO_ARG_ARRAY
2966 args[0] = filename;
2967 args[1] = linkname;
2968 report_file_error ("Making symbolic link", Flist (2, args));
2969 #else
2970 report_file_error ("Making symbolic link", Flist (2, &filename));
2971 #endif
2973 UNGCPRO;
2974 return Qnil;
2976 #endif /* S_IFLNK */
2978 #ifdef VMS
2980 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2981 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2982 doc: /* Define the job-wide logical name NAME to have the value STRING.
2983 If STRING is nil or a null string, the logical name NAME is deleted. */)
2984 (name, string)
2985 Lisp_Object name;
2986 Lisp_Object string;
2988 CHECK_STRING (name);
2989 if (NILP (string))
2990 delete_logical_name (SDATA (name));
2991 else
2993 CHECK_STRING (string);
2995 if (SCHARS (string) == 0)
2996 delete_logical_name (SDATA (name));
2997 else
2998 define_logical_name (SDATA (name), SDATA (string));
3001 return string;
3003 #endif /* VMS */
3005 #ifdef HPUX_NET
3007 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
3008 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
3009 (path, login)
3010 Lisp_Object path, login;
3012 int netresult;
3014 CHECK_STRING (path);
3015 CHECK_STRING (login);
3017 netresult = netunam (SDATA (path), SDATA (login));
3019 if (netresult == -1)
3020 return Qnil;
3021 else
3022 return Qt;
3024 #endif /* HPUX_NET */
3026 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
3027 1, 1, 0,
3028 doc: /* Return t if file FILENAME specifies an absolute file name.
3029 On Unix, this is a name starting with a `/' or a `~'. */)
3030 (filename)
3031 Lisp_Object filename;
3033 CHECK_STRING (filename);
3034 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3037 /* Return nonzero if file FILENAME exists and can be executed. */
3039 static int
3040 check_executable (filename)
3041 char *filename;
3043 #ifdef DOS_NT
3044 int len = strlen (filename);
3045 char *suffix;
3046 struct stat st;
3047 if (stat (filename, &st) < 0)
3048 return 0;
3049 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3050 return ((st.st_mode & S_IEXEC) != 0);
3051 #else
3052 return (S_ISREG (st.st_mode)
3053 && len >= 5
3054 && (stricmp ((suffix = filename + len-4), ".com") == 0
3055 || stricmp (suffix, ".exe") == 0
3056 || stricmp (suffix, ".bat") == 0)
3057 || (st.st_mode & S_IFMT) == S_IFDIR);
3058 #endif /* not WINDOWSNT */
3059 #else /* not DOS_NT */
3060 #ifdef HAVE_EUIDACCESS
3061 return (euidaccess (filename, 1) >= 0);
3062 #else
3063 /* Access isn't quite right because it uses the real uid
3064 and we really want to test with the effective uid.
3065 But Unix doesn't give us a right way to do it. */
3066 return (access (filename, 1) >= 0);
3067 #endif
3068 #endif /* not DOS_NT */
3071 /* Return nonzero if file FILENAME exists and can be written. */
3073 static int
3074 check_writable (filename)
3075 char *filename;
3077 #ifdef MSDOS
3078 struct stat st;
3079 if (stat (filename, &st) < 0)
3080 return 0;
3081 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3082 #else /* not MSDOS */
3083 #ifdef HAVE_EUIDACCESS
3084 return (euidaccess (filename, 2) >= 0);
3085 #else
3086 /* Access isn't quite right because it uses the real uid
3087 and we really want to test with the effective uid.
3088 But Unix doesn't give us a right way to do it.
3089 Opening with O_WRONLY could work for an ordinary file,
3090 but would lose for directories. */
3091 return (access (filename, 2) >= 0);
3092 #endif
3093 #endif /* not MSDOS */
3096 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3097 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3098 See also `file-readable-p' and `file-attributes'.
3099 This returns nil for a symlink to a nonexistent file.
3100 Use `file-symlink-p' to test for such links. */)
3101 (filename)
3102 Lisp_Object filename;
3104 Lisp_Object absname;
3105 Lisp_Object handler;
3106 struct stat statbuf;
3108 CHECK_STRING (filename);
3109 absname = Fexpand_file_name (filename, Qnil);
3111 /* If the file name has special constructs in it,
3112 call the corresponding file handler. */
3113 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3114 if (!NILP (handler))
3115 return call2 (handler, Qfile_exists_p, absname);
3117 absname = ENCODE_FILE (absname);
3119 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3122 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3123 doc: /* Return t if FILENAME can be executed by you.
3124 For a directory, this means you can access files in that directory. */)
3125 (filename)
3126 Lisp_Object filename;
3128 Lisp_Object absname;
3129 Lisp_Object handler;
3131 CHECK_STRING (filename);
3132 absname = Fexpand_file_name (filename, Qnil);
3134 /* If the file name has special constructs in it,
3135 call the corresponding file handler. */
3136 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3137 if (!NILP (handler))
3138 return call2 (handler, Qfile_executable_p, absname);
3140 absname = ENCODE_FILE (absname);
3142 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3145 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3146 doc: /* Return t if file FILENAME exists and you can read it.
3147 See also `file-exists-p' and `file-attributes'. */)
3148 (filename)
3149 Lisp_Object filename;
3151 Lisp_Object absname;
3152 Lisp_Object handler;
3153 int desc;
3154 int flags;
3155 struct stat statbuf;
3157 CHECK_STRING (filename);
3158 absname = Fexpand_file_name (filename, Qnil);
3160 /* If the file name has special constructs in it,
3161 call the corresponding file handler. */
3162 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3163 if (!NILP (handler))
3164 return call2 (handler, Qfile_readable_p, absname);
3166 absname = ENCODE_FILE (absname);
3168 #if defined(DOS_NT) || defined(macintosh)
3169 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3170 directories. */
3171 if (access (SDATA (absname), 0) == 0)
3172 return Qt;
3173 return Qnil;
3174 #else /* not DOS_NT and not macintosh */
3175 flags = O_RDONLY;
3176 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3177 /* Opening a fifo without O_NONBLOCK can wait.
3178 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3179 except in the case of a fifo, on a system which handles it. */
3180 desc = stat (SDATA (absname), &statbuf);
3181 if (desc < 0)
3182 return Qnil;
3183 if (S_ISFIFO (statbuf.st_mode))
3184 flags |= O_NONBLOCK;
3185 #endif
3186 desc = emacs_open (SDATA (absname), flags, 0);
3187 if (desc < 0)
3188 return Qnil;
3189 emacs_close (desc);
3190 return Qt;
3191 #endif /* not DOS_NT and not macintosh */
3194 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3195 on the RT/PC. */
3196 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3197 doc: /* Return t if file FILENAME can be written or created by you. */)
3198 (filename)
3199 Lisp_Object filename;
3201 Lisp_Object absname, dir, encoded;
3202 Lisp_Object handler;
3203 struct stat statbuf;
3205 CHECK_STRING (filename);
3206 absname = Fexpand_file_name (filename, Qnil);
3208 /* If the file name has special constructs in it,
3209 call the corresponding file handler. */
3210 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3211 if (!NILP (handler))
3212 return call2 (handler, Qfile_writable_p, absname);
3214 encoded = ENCODE_FILE (absname);
3215 if (stat (SDATA (encoded), &statbuf) >= 0)
3216 return (check_writable (SDATA (encoded))
3217 ? Qt : Qnil);
3219 dir = Ffile_name_directory (absname);
3220 #ifdef VMS
3221 if (!NILP (dir))
3222 dir = Fdirectory_file_name (dir);
3223 #endif /* VMS */
3224 #ifdef MSDOS
3225 if (!NILP (dir))
3226 dir = Fdirectory_file_name (dir);
3227 #endif /* MSDOS */
3229 dir = ENCODE_FILE (dir);
3230 #ifdef WINDOWSNT
3231 /* The read-only attribute of the parent directory doesn't affect
3232 whether a file or directory can be created within it. Some day we
3233 should check ACLs though, which do affect this. */
3234 if (stat (SDATA (dir), &statbuf) < 0)
3235 return Qnil;
3236 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3237 #else
3238 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3239 ? Qt : Qnil);
3240 #endif
3243 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3244 doc: /* Access file FILENAME, and get an error if that does not work.
3245 The second argument STRING is used in the error message.
3246 If there is no error, returns nil. */)
3247 (filename, string)
3248 Lisp_Object filename, string;
3250 Lisp_Object handler, encoded_filename, absname;
3251 int fd;
3253 CHECK_STRING (filename);
3254 absname = Fexpand_file_name (filename, Qnil);
3256 CHECK_STRING (string);
3258 /* If the file name has special constructs in it,
3259 call the corresponding file handler. */
3260 handler = Ffind_file_name_handler (absname, Qaccess_file);
3261 if (!NILP (handler))
3262 return call3 (handler, Qaccess_file, absname, string);
3264 encoded_filename = ENCODE_FILE (absname);
3266 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3267 if (fd < 0)
3268 report_file_error (SDATA (string), Fcons (filename, Qnil));
3269 emacs_close (fd);
3271 return Qnil;
3274 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3275 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3276 The value is the link target, as a string.
3277 Otherwise it returns nil.
3279 This function returns t when given the name of a symlink that
3280 points to a nonexistent file. */)
3281 (filename)
3282 Lisp_Object filename;
3284 Lisp_Object handler;
3286 CHECK_STRING (filename);
3287 filename = Fexpand_file_name (filename, Qnil);
3289 /* If the file name has special constructs in it,
3290 call the corresponding file handler. */
3291 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3292 if (!NILP (handler))
3293 return call2 (handler, Qfile_symlink_p, filename);
3295 #ifdef S_IFLNK
3297 char *buf;
3298 int bufsize;
3299 int valsize;
3300 Lisp_Object val;
3302 filename = ENCODE_FILE (filename);
3304 bufsize = 50;
3305 buf = NULL;
3308 bufsize *= 2;
3309 buf = (char *) xrealloc (buf, bufsize);
3310 bzero (buf, bufsize);
3312 errno = 0;
3313 valsize = readlink (SDATA (filename), buf, bufsize);
3314 if (valsize == -1)
3316 #ifdef ERANGE
3317 /* HP-UX reports ERANGE if buffer is too small. */
3318 if (errno == ERANGE)
3319 valsize = bufsize;
3320 else
3321 #endif
3323 xfree (buf);
3324 return Qnil;
3328 while (valsize >= bufsize);
3330 val = make_string (buf, valsize);
3331 if (buf[0] == '/' && index (buf, ':'))
3332 val = concat2 (build_string ("/:"), val);
3333 xfree (buf);
3334 val = DECODE_FILE (val);
3335 return val;
3337 #else /* not S_IFLNK */
3338 return Qnil;
3339 #endif /* not S_IFLNK */
3342 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3343 doc: /* Return t if FILENAME names an existing directory.
3344 Symbolic links to directories count as directories.
3345 See `file-symlink-p' to distinguish symlinks. */)
3346 (filename)
3347 Lisp_Object filename;
3349 register Lisp_Object absname;
3350 struct stat st;
3351 Lisp_Object handler;
3353 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3355 /* If the file name has special constructs in it,
3356 call the corresponding file handler. */
3357 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3358 if (!NILP (handler))
3359 return call2 (handler, Qfile_directory_p, absname);
3361 absname = ENCODE_FILE (absname);
3363 if (stat (SDATA (absname), &st) < 0)
3364 return Qnil;
3365 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3368 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3369 doc: /* Return t if file FILENAME names a directory you can open.
3370 For the value to be t, FILENAME must specify the name of a directory as a file,
3371 and the directory must allow you to open files in it. In order to use a
3372 directory as a buffer's current directory, this predicate must return true.
3373 A directory name spec may be given instead; then the value is t
3374 if the directory so specified exists and really is a readable and
3375 searchable directory. */)
3376 (filename)
3377 Lisp_Object filename;
3379 Lisp_Object handler;
3380 int tem;
3381 struct gcpro gcpro1;
3383 /* If the file name has special constructs in it,
3384 call the corresponding file handler. */
3385 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3386 if (!NILP (handler))
3387 return call2 (handler, Qfile_accessible_directory_p, filename);
3389 GCPRO1 (filename);
3390 tem = (NILP (Ffile_directory_p (filename))
3391 || NILP (Ffile_executable_p (filename)));
3392 UNGCPRO;
3393 return tem ? Qnil : Qt;
3396 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3397 doc: /* Return t if FILENAME names a regular file.
3398 This is the sort of file that holds an ordinary stream of data bytes.
3399 Symbolic links to regular files count as regular files.
3400 See `file-symlink-p' to distinguish symlinks. */)
3401 (filename)
3402 Lisp_Object filename;
3404 register Lisp_Object absname;
3405 struct stat st;
3406 Lisp_Object handler;
3408 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3410 /* If the file name has special constructs in it,
3411 call the corresponding file handler. */
3412 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3413 if (!NILP (handler))
3414 return call2 (handler, Qfile_regular_p, absname);
3416 absname = ENCODE_FILE (absname);
3418 #ifdef WINDOWSNT
3420 int result;
3421 Lisp_Object tem = Vw32_get_true_file_attributes;
3423 /* Tell stat to use expensive method to get accurate info. */
3424 Vw32_get_true_file_attributes = Qt;
3425 result = stat (SDATA (absname), &st);
3426 Vw32_get_true_file_attributes = tem;
3428 if (result < 0)
3429 return Qnil;
3430 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3432 #else
3433 if (stat (SDATA (absname), &st) < 0)
3434 return Qnil;
3435 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3436 #endif
3439 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3440 doc: /* Return mode bits of file named FILENAME, as an integer.
3441 Return nil, if file does not exist or is not accessible. */)
3442 (filename)
3443 Lisp_Object filename;
3445 Lisp_Object absname;
3446 struct stat st;
3447 Lisp_Object handler;
3449 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3451 /* If the file name has special constructs in it,
3452 call the corresponding file handler. */
3453 handler = Ffind_file_name_handler (absname, Qfile_modes);
3454 if (!NILP (handler))
3455 return call2 (handler, Qfile_modes, absname);
3457 absname = ENCODE_FILE (absname);
3459 if (stat (SDATA (absname), &st) < 0)
3460 return Qnil;
3461 #if defined (MSDOS) && __DJGPP__ < 2
3462 if (check_executable (SDATA (absname)))
3463 st.st_mode |= S_IEXEC;
3464 #endif /* MSDOS && __DJGPP__ < 2 */
3466 return make_number (st.st_mode & 07777);
3469 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3470 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3471 Only the 12 low bits of MODE are used. */)
3472 (filename, mode)
3473 Lisp_Object filename, mode;
3475 Lisp_Object absname, encoded_absname;
3476 Lisp_Object handler;
3478 absname = Fexpand_file_name (filename, current_buffer->directory);
3479 CHECK_NUMBER (mode);
3481 /* If the file name has special constructs in it,
3482 call the corresponding file handler. */
3483 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3484 if (!NILP (handler))
3485 return call3 (handler, Qset_file_modes, absname, mode);
3487 encoded_absname = ENCODE_FILE (absname);
3489 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3490 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3492 return Qnil;
3495 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3496 doc: /* Set the file permission bits for newly created files.
3497 The argument MODE should be an integer; only the low 9 bits are used.
3498 This setting is inherited by subprocesses. */)
3499 (mode)
3500 Lisp_Object mode;
3502 CHECK_NUMBER (mode);
3504 umask ((~ XINT (mode)) & 0777);
3506 return Qnil;
3509 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3510 doc: /* Return the default file protection for created files.
3511 The value is an integer. */)
3514 int realmask;
3515 Lisp_Object value;
3517 realmask = umask (0);
3518 umask (realmask);
3520 XSETINT (value, (~ realmask) & 0777);
3521 return value;
3524 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3526 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3527 doc: /* Set times of file FILENAME to TIME.
3528 Set both access and modification times.
3529 Return t on success, else nil.
3530 Use the current time if TIME is nil. TIME is in the format of
3531 `current-time'. */)
3532 (filename, time)
3533 Lisp_Object filename, time;
3535 Lisp_Object absname, encoded_absname;
3536 Lisp_Object handler;
3537 time_t sec;
3538 int usec;
3540 if (! lisp_time_argument (time, &sec, &usec))
3541 error ("Invalid time specification");
3543 absname = Fexpand_file_name (filename, current_buffer->directory);
3545 /* If the file name has special constructs in it,
3546 call the corresponding file handler. */
3547 handler = Ffind_file_name_handler (absname, Qset_file_times);
3548 if (!NILP (handler))
3549 return call3 (handler, Qset_file_times, absname, time);
3551 encoded_absname = ENCODE_FILE (absname);
3554 EMACS_TIME t;
3556 EMACS_SET_SECS (t, sec);
3557 EMACS_SET_USECS (t, usec);
3559 if (set_file_times (SDATA (encoded_absname), t, t))
3561 #ifdef DOS_NT
3562 struct stat st;
3564 /* Setting times on a directory always fails. */
3565 if (stat (SDATA (encoded_absname), &st) == 0
3566 && (st.st_mode & S_IFMT) == S_IFDIR)
3567 return Qnil;
3568 #endif
3569 report_file_error ("Setting file times", Fcons (absname, Qnil));
3570 return Qnil;
3574 return Qt;
3577 #ifdef __NetBSD__
3578 #define unix 42
3579 #endif
3581 #ifdef unix
3582 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3583 doc: /* Tell Unix to finish all pending disk updates. */)
3586 sync ();
3587 return Qnil;
3590 #endif /* unix */
3592 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3593 doc: /* Return t if file FILE1 is newer than file FILE2.
3594 If FILE1 does not exist, the answer is nil;
3595 otherwise, if FILE2 does not exist, the answer is t. */)
3596 (file1, file2)
3597 Lisp_Object file1, file2;
3599 Lisp_Object absname1, absname2;
3600 struct stat st;
3601 int mtime1;
3602 Lisp_Object handler;
3603 struct gcpro gcpro1, gcpro2;
3605 CHECK_STRING (file1);
3606 CHECK_STRING (file2);
3608 absname1 = Qnil;
3609 GCPRO2 (absname1, file2);
3610 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3611 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3612 UNGCPRO;
3614 /* If the file name has special constructs in it,
3615 call the corresponding file handler. */
3616 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3617 if (NILP (handler))
3618 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3619 if (!NILP (handler))
3620 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3622 GCPRO2 (absname1, absname2);
3623 absname1 = ENCODE_FILE (absname1);
3624 absname2 = ENCODE_FILE (absname2);
3625 UNGCPRO;
3627 if (stat (SDATA (absname1), &st) < 0)
3628 return Qnil;
3630 mtime1 = st.st_mtime;
3632 if (stat (SDATA (absname2), &st) < 0)
3633 return Qt;
3635 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3638 #ifdef DOS_NT
3639 Lisp_Object Qfind_buffer_file_type;
3640 #endif /* DOS_NT */
3642 #ifndef READ_BUF_SIZE
3643 #define READ_BUF_SIZE (64 << 10)
3644 #endif
3646 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3648 /* This function is called after Lisp functions to decide a coding
3649 system are called, or when they cause an error. Before they are
3650 called, the current buffer is set unibyte and it contains only a
3651 newly inserted text (thus the buffer was empty before the
3652 insertion).
3654 The functions may set markers, overlays, text properties, or even
3655 alter the buffer contents, change the current buffer.
3657 Here, we reset all those changes by:
3658 o set back the current buffer.
3659 o move all markers and overlays to BEG.
3660 o remove all text properties.
3661 o set back the buffer multibyteness. */
3663 static Lisp_Object
3664 decide_coding_unwind (unwind_data)
3665 Lisp_Object unwind_data;
3667 Lisp_Object multibyte, undo_list, buffer;
3669 multibyte = XCAR (unwind_data);
3670 unwind_data = XCDR (unwind_data);
3671 undo_list = XCAR (unwind_data);
3672 buffer = XCDR (unwind_data);
3674 if (current_buffer != XBUFFER (buffer))
3675 set_buffer_internal (XBUFFER (buffer));
3676 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3677 adjust_overlays_for_delete (BEG, Z - BEG);
3678 BUF_INTERVALS (current_buffer) = 0;
3679 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3681 /* Now we are safe to change the buffer's multibyteness directly. */
3682 current_buffer->enable_multibyte_characters = multibyte;
3683 current_buffer->undo_list = undo_list;
3685 return Qnil;
3689 /* Used to pass values from insert-file-contents to read_non_regular. */
3691 static int non_regular_fd;
3692 static int non_regular_inserted;
3693 static int non_regular_nbytes;
3696 /* Read from a non-regular file.
3697 Read non_regular_trytry bytes max from non_regular_fd.
3698 Non_regular_inserted specifies where to put the read bytes.
3699 Value is the number of bytes read. */
3701 static Lisp_Object
3702 read_non_regular ()
3704 int nbytes;
3706 immediate_quit = 1;
3707 QUIT;
3708 nbytes = emacs_read (non_regular_fd,
3709 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3710 non_regular_nbytes);
3711 immediate_quit = 0;
3712 return make_number (nbytes);
3716 /* Condition-case handler used when reading from non-regular files
3717 in insert-file-contents. */
3719 static Lisp_Object
3720 read_non_regular_quit ()
3722 return Qnil;
3726 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3727 1, 5, 0,
3728 doc: /* Insert contents of file FILENAME after point.
3729 Returns list of absolute file name and number of characters inserted.
3730 If second argument VISIT is non-nil, the buffer's visited filename
3731 and last save file modtime are set, and it is marked unmodified.
3732 If visiting and the file does not exist, visiting is completed
3733 before the error is signaled.
3734 The optional third and fourth arguments BEG and END
3735 specify what portion of the file to insert.
3736 These arguments count bytes in the file, not characters in the buffer.
3737 If VISIT is non-nil, BEG and END must be nil.
3739 If optional fifth argument REPLACE is non-nil,
3740 it means replace the current buffer contents (in the accessible portion)
3741 with the file contents. This is better than simply deleting and inserting
3742 the whole thing because (1) it preserves some marker positions
3743 and (2) it puts less data in the undo list.
3744 When REPLACE is non-nil, the value is the number of characters actually read,
3745 which is often less than the number of characters to be read.
3747 This does code conversion according to the value of
3748 `coding-system-for-read' or `file-coding-system-alist',
3749 and sets the variable `last-coding-system-used' to the coding system
3750 actually used. */)
3751 (filename, visit, beg, end, replace)
3752 Lisp_Object filename, visit, beg, end, replace;
3754 struct stat st;
3755 register int fd;
3756 int inserted = 0;
3757 register int how_much;
3758 register int unprocessed;
3759 int count = SPECPDL_INDEX ();
3760 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3761 Lisp_Object handler, val, insval, orig_filename;
3762 Lisp_Object p;
3763 int total = 0;
3764 int not_regular = 0;
3765 unsigned char read_buf[READ_BUF_SIZE];
3766 struct coding_system coding;
3767 unsigned char buffer[1 << 14];
3768 int replace_handled = 0;
3769 int set_coding_system = 0;
3770 int coding_system_decided = 0;
3771 int read_quit = 0;
3772 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3773 int we_locked_file = 0;
3775 if (current_buffer->base_buffer && ! NILP (visit))
3776 error ("Cannot do file visiting in an indirect buffer");
3778 if (!NILP (current_buffer->read_only))
3779 Fbarf_if_buffer_read_only ();
3781 val = Qnil;
3782 p = Qnil;
3783 orig_filename = Qnil;
3785 GCPRO4 (filename, val, p, orig_filename);
3787 CHECK_STRING (filename);
3788 filename = Fexpand_file_name (filename, Qnil);
3790 /* If the file name has special constructs in it,
3791 call the corresponding file handler. */
3792 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3793 if (!NILP (handler))
3795 val = call6 (handler, Qinsert_file_contents, filename,
3796 visit, beg, end, replace);
3797 if (CONSP (val) && CONSP (XCDR (val)))
3798 inserted = XINT (XCAR (XCDR (val)));
3799 goto handled;
3802 orig_filename = filename;
3803 filename = ENCODE_FILE (filename);
3805 fd = -1;
3807 #ifdef WINDOWSNT
3809 Lisp_Object tem = Vw32_get_true_file_attributes;
3811 /* Tell stat to use expensive method to get accurate info. */
3812 Vw32_get_true_file_attributes = Qt;
3813 total = stat (SDATA (filename), &st);
3814 Vw32_get_true_file_attributes = tem;
3816 if (total < 0)
3817 #else
3818 #ifndef APOLLO
3819 if (stat (SDATA (filename), &st) < 0)
3820 #else
3821 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3822 || fstat (fd, &st) < 0)
3823 #endif /* not APOLLO */
3824 #endif /* WINDOWSNT */
3826 if (fd >= 0) emacs_close (fd);
3827 badopen:
3828 if (NILP (visit))
3829 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3830 st.st_mtime = -1;
3831 how_much = 0;
3832 if (!NILP (Vcoding_system_for_read))
3833 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3834 goto notfound;
3837 #ifdef S_IFREG
3838 /* This code will need to be changed in order to work on named
3839 pipes, and it's probably just not worth it. So we should at
3840 least signal an error. */
3841 if (!S_ISREG (st.st_mode))
3843 not_regular = 1;
3845 if (! NILP (visit))
3846 goto notfound;
3848 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3849 Fsignal (Qfile_error,
3850 Fcons (build_string ("not a regular file"),
3851 Fcons (orig_filename, Qnil)));
3853 #endif
3855 if (fd < 0)
3856 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3857 goto badopen;
3859 /* Replacement should preserve point as it preserves markers. */
3860 if (!NILP (replace))
3861 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3863 record_unwind_protect (close_file_unwind, make_number (fd));
3865 /* Supposedly happens on VMS. */
3866 /* Can happen on any platform that uses long as type of off_t, but allows
3867 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3868 give a message suitable for the latter case. */
3869 if (! not_regular && st.st_size < 0)
3870 error ("Maximum buffer size exceeded");
3872 /* Prevent redisplay optimizations. */
3873 current_buffer->clip_changed = 1;
3875 if (!NILP (visit))
3877 if (!NILP (beg) || !NILP (end))
3878 error ("Attempt to visit less than an entire file");
3879 if (BEG < Z && NILP (replace))
3880 error ("Cannot do file visiting in a non-empty buffer");
3883 if (!NILP (beg))
3884 CHECK_NUMBER (beg);
3885 else
3886 XSETFASTINT (beg, 0);
3888 if (!NILP (end))
3889 CHECK_NUMBER (end);
3890 else
3892 if (! not_regular)
3894 XSETINT (end, st.st_size);
3896 /* Arithmetic overflow can occur if an Emacs integer cannot
3897 represent the file size, or if the calculations below
3898 overflow. The calculations below double the file size
3899 twice, so check that it can be multiplied by 4 safely. */
3900 if (XINT (end) != st.st_size
3901 || ((int) st.st_size * 4) / 4 != st.st_size)
3902 error ("Maximum buffer size exceeded");
3904 /* The file size returned from stat may be zero, but data
3905 may be readable nonetheless, for example when this is a
3906 file in the /proc filesystem. */
3907 if (st.st_size == 0)
3908 XSETINT (end, READ_BUF_SIZE);
3912 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3914 /* We use emacs-mule for auto saving... */
3915 setup_coding_system (Qemacs_mule, &coding);
3916 /* ... but with the special flag to indicate to read in a
3917 multibyte sequence for eight-bit-control char as is. */
3918 coding.flags = 1;
3919 coding.src_multibyte = 0;
3920 coding.dst_multibyte
3921 = !NILP (current_buffer->enable_multibyte_characters);
3922 coding.eol_type = CODING_EOL_LF;
3923 coding_system_decided = 1;
3925 else if (BEG < Z)
3927 /* Decide the coding system to use for reading the file now
3928 because we can't use an optimized method for handling
3929 `coding:' tag if the current buffer is not empty. */
3930 Lisp_Object val;
3931 val = Qnil;
3933 if (!NILP (Vcoding_system_for_read))
3934 val = Vcoding_system_for_read;
3935 else
3937 /* Don't try looking inside a file for a coding system
3938 specification if it is not seekable. */
3939 if (! not_regular && ! NILP (Vset_auto_coding_function))
3941 /* Find a coding system specified in the heading two
3942 lines or in the tailing several lines of the file.
3943 We assume that the 1K-byte and 3K-byte for heading
3944 and tailing respectively are sufficient for this
3945 purpose. */
3946 int nread;
3948 if (st.st_size <= (1024 * 4))
3949 nread = emacs_read (fd, read_buf, 1024 * 4);
3950 else
3952 nread = emacs_read (fd, read_buf, 1024);
3953 if (nread >= 0)
3955 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3956 report_file_error ("Setting file position",
3957 Fcons (orig_filename, Qnil));
3958 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3962 if (nread < 0)
3963 error ("IO error reading %s: %s",
3964 SDATA (orig_filename), emacs_strerror (errno));
3965 else if (nread > 0)
3967 struct buffer *prev = current_buffer;
3968 Lisp_Object buffer;
3969 struct buffer *buf;
3971 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3973 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3974 buf = XBUFFER (buffer);
3976 delete_all_overlays (buf);
3977 buf->directory = current_buffer->directory;
3978 buf->read_only = Qnil;
3979 buf->filename = Qnil;
3980 buf->undo_list = Qt;
3981 eassert (buf->overlays_before == NULL);
3982 eassert (buf->overlays_after == NULL);
3984 set_buffer_internal (buf);
3985 Ferase_buffer ();
3986 buf->enable_multibyte_characters = Qnil;
3988 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3989 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3990 val = call2 (Vset_auto_coding_function,
3991 filename, make_number (nread));
3992 set_buffer_internal (prev);
3994 /* Discard the unwind protect for recovering the
3995 current buffer. */
3996 specpdl_ptr--;
3998 /* Rewind the file for the actual read done later. */
3999 if (lseek (fd, 0, 0) < 0)
4000 report_file_error ("Setting file position",
4001 Fcons (orig_filename, Qnil));
4005 if (NILP (val))
4007 /* If we have not yet decided a coding system, check
4008 file-coding-system-alist. */
4009 Lisp_Object args[6], coding_systems;
4011 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4012 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
4013 coding_systems = Ffind_operation_coding_system (6, args);
4014 if (CONSP (coding_systems))
4015 val = XCAR (coding_systems);
4019 setup_coding_system (Fcheck_coding_system (val), &coding);
4020 /* Ensure we set Vlast_coding_system_used. */
4021 set_coding_system = 1;
4023 if (NILP (current_buffer->enable_multibyte_characters)
4024 && ! NILP (val))
4025 /* We must suppress all character code conversion except for
4026 end-of-line conversion. */
4027 setup_raw_text_coding_system (&coding);
4029 coding.src_multibyte = 0;
4030 coding.dst_multibyte
4031 = !NILP (current_buffer->enable_multibyte_characters);
4032 coding_system_decided = 1;
4035 /* If requested, replace the accessible part of the buffer
4036 with the file contents. Avoid replacing text at the
4037 beginning or end of the buffer that matches the file contents;
4038 that preserves markers pointing to the unchanged parts.
4040 Here we implement this feature in an optimized way
4041 for the case where code conversion is NOT needed.
4042 The following if-statement handles the case of conversion
4043 in a less optimal way.
4045 If the code conversion is "automatic" then we try using this
4046 method and hope for the best.
4047 But if we discover the need for conversion, we give up on this method
4048 and let the following if-statement handle the replace job. */
4049 if (!NILP (replace)
4050 && BEGV < ZV
4051 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4053 /* same_at_start and same_at_end count bytes,
4054 because file access counts bytes
4055 and BEG and END count bytes. */
4056 int same_at_start = BEGV_BYTE;
4057 int same_at_end = ZV_BYTE;
4058 int overlap;
4059 /* There is still a possibility we will find the need to do code
4060 conversion. If that happens, we set this variable to 1 to
4061 give up on handling REPLACE in the optimized way. */
4062 int giveup_match_end = 0;
4064 if (XINT (beg) != 0)
4066 if (lseek (fd, XINT (beg), 0) < 0)
4067 report_file_error ("Setting file position",
4068 Fcons (orig_filename, Qnil));
4071 immediate_quit = 1;
4072 QUIT;
4073 /* Count how many chars at the start of the file
4074 match the text at the beginning of the buffer. */
4075 while (1)
4077 int nread, bufpos;
4079 nread = emacs_read (fd, buffer, sizeof buffer);
4080 if (nread < 0)
4081 error ("IO error reading %s: %s",
4082 SDATA (orig_filename), emacs_strerror (errno));
4083 else if (nread == 0)
4084 break;
4086 if (coding.type == coding_type_undecided)
4087 detect_coding (&coding, buffer, nread);
4088 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4089 /* We found that the file should be decoded somehow.
4090 Let's give up here. */
4092 giveup_match_end = 1;
4093 break;
4096 if (coding.eol_type == CODING_EOL_UNDECIDED)
4097 detect_eol (&coding, buffer, nread);
4098 if (coding.eol_type != CODING_EOL_UNDECIDED
4099 && coding.eol_type != CODING_EOL_LF)
4100 /* We found that the format of eol should be decoded.
4101 Let's give up here. */
4103 giveup_match_end = 1;
4104 break;
4107 bufpos = 0;
4108 while (bufpos < nread && same_at_start < ZV_BYTE
4109 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4110 same_at_start++, bufpos++;
4111 /* If we found a discrepancy, stop the scan.
4112 Otherwise loop around and scan the next bufferful. */
4113 if (bufpos != nread)
4114 break;
4116 immediate_quit = 0;
4117 /* If the file matches the buffer completely,
4118 there's no need to replace anything. */
4119 if (same_at_start - BEGV_BYTE == XINT (end))
4121 emacs_close (fd);
4122 specpdl_ptr--;
4123 /* Truncate the buffer to the size of the file. */
4124 del_range_1 (same_at_start, same_at_end, 0, 0);
4125 goto handled;
4127 immediate_quit = 1;
4128 QUIT;
4129 /* Count how many chars at the end of the file
4130 match the text at the end of the buffer. But, if we have
4131 already found that decoding is necessary, don't waste time. */
4132 while (!giveup_match_end)
4134 int total_read, nread, bufpos, curpos, trial;
4136 /* At what file position are we now scanning? */
4137 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4138 /* If the entire file matches the buffer tail, stop the scan. */
4139 if (curpos == 0)
4140 break;
4141 /* How much can we scan in the next step? */
4142 trial = min (curpos, sizeof buffer);
4143 if (lseek (fd, curpos - trial, 0) < 0)
4144 report_file_error ("Setting file position",
4145 Fcons (orig_filename, Qnil));
4147 total_read = nread = 0;
4148 while (total_read < trial)
4150 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4151 if (nread < 0)
4152 error ("IO error reading %s: %s",
4153 SDATA (orig_filename), emacs_strerror (errno));
4154 else if (nread == 0)
4155 break;
4156 total_read += nread;
4159 /* Scan this bufferful from the end, comparing with
4160 the Emacs buffer. */
4161 bufpos = total_read;
4163 /* Compare with same_at_start to avoid counting some buffer text
4164 as matching both at the file's beginning and at the end. */
4165 while (bufpos > 0 && same_at_end > same_at_start
4166 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4167 same_at_end--, bufpos--;
4169 /* If we found a discrepancy, stop the scan.
4170 Otherwise loop around and scan the preceding bufferful. */
4171 if (bufpos != 0)
4173 /* If this discrepancy is because of code conversion,
4174 we cannot use this method; giveup and try the other. */
4175 if (same_at_end > same_at_start
4176 && FETCH_BYTE (same_at_end - 1) >= 0200
4177 && ! NILP (current_buffer->enable_multibyte_characters)
4178 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4179 giveup_match_end = 1;
4180 break;
4183 if (nread == 0)
4184 break;
4186 immediate_quit = 0;
4188 if (! giveup_match_end)
4190 int temp;
4192 /* We win! We can handle REPLACE the optimized way. */
4194 /* Extend the start of non-matching text area to multibyte
4195 character boundary. */
4196 if (! NILP (current_buffer->enable_multibyte_characters))
4197 while (same_at_start > BEGV_BYTE
4198 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4199 same_at_start--;
4201 /* Extend the end of non-matching text area to multibyte
4202 character boundary. */
4203 if (! NILP (current_buffer->enable_multibyte_characters))
4204 while (same_at_end < ZV_BYTE
4205 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4206 same_at_end++;
4208 /* Don't try to reuse the same piece of text twice. */
4209 overlap = (same_at_start - BEGV_BYTE
4210 - (same_at_end + st.st_size - ZV));
4211 if (overlap > 0)
4212 same_at_end += overlap;
4214 /* Arrange to read only the nonmatching middle part of the file. */
4215 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4216 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4218 del_range_byte (same_at_start, same_at_end, 0);
4219 /* Insert from the file at the proper position. */
4220 temp = BYTE_TO_CHAR (same_at_start);
4221 SET_PT_BOTH (temp, same_at_start);
4223 /* If display currently starts at beginning of line,
4224 keep it that way. */
4225 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4226 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4228 replace_handled = 1;
4232 /* If requested, replace the accessible part of the buffer
4233 with the file contents. Avoid replacing text at the
4234 beginning or end of the buffer that matches the file contents;
4235 that preserves markers pointing to the unchanged parts.
4237 Here we implement this feature for the case where code conversion
4238 is needed, in a simple way that needs a lot of memory.
4239 The preceding if-statement handles the case of no conversion
4240 in a more optimized way. */
4241 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4243 int same_at_start = BEGV_BYTE;
4244 int same_at_end = ZV_BYTE;
4245 int overlap;
4246 int bufpos;
4247 /* Make sure that the gap is large enough. */
4248 int bufsize = 2 * st.st_size;
4249 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4250 int temp;
4252 /* First read the whole file, performing code conversion into
4253 CONVERSION_BUFFER. */
4255 if (lseek (fd, XINT (beg), 0) < 0)
4257 xfree (conversion_buffer);
4258 report_file_error ("Setting file position",
4259 Fcons (orig_filename, Qnil));
4262 total = st.st_size; /* Total bytes in the file. */
4263 how_much = 0; /* Bytes read from file so far. */
4264 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4265 unprocessed = 0; /* Bytes not processed in previous loop. */
4267 while (how_much < total)
4269 /* try is reserved in some compilers (Microsoft C) */
4270 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4271 unsigned char *destination = read_buf + unprocessed;
4272 int this;
4274 /* Allow quitting out of the actual I/O. */
4275 immediate_quit = 1;
4276 QUIT;
4277 this = emacs_read (fd, destination, trytry);
4278 immediate_quit = 0;
4280 if (this < 0 || this + unprocessed == 0)
4282 how_much = this;
4283 break;
4286 how_much += this;
4288 if (CODING_MAY_REQUIRE_DECODING (&coding))
4290 int require, result;
4292 this += unprocessed;
4294 /* If we are using more space than estimated,
4295 make CONVERSION_BUFFER bigger. */
4296 require = decoding_buffer_size (&coding, this);
4297 if (inserted + require + 2 * (total - how_much) > bufsize)
4299 bufsize = inserted + require + 2 * (total - how_much);
4300 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4303 /* Convert this batch with results in CONVERSION_BUFFER. */
4304 if (how_much >= total) /* This is the last block. */
4305 coding.mode |= CODING_MODE_LAST_BLOCK;
4306 if (coding.composing != COMPOSITION_DISABLED)
4307 coding_allocate_composition_data (&coding, BEGV);
4308 result = decode_coding (&coding, read_buf,
4309 conversion_buffer + inserted,
4310 this, bufsize - inserted);
4312 /* Save for next iteration whatever we didn't convert. */
4313 unprocessed = this - coding.consumed;
4314 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4315 if (!NILP (current_buffer->enable_multibyte_characters))
4316 this = coding.produced;
4317 else
4318 this = str_as_unibyte (conversion_buffer + inserted,
4319 coding.produced);
4322 inserted += this;
4325 /* At this point, INSERTED is how many characters (i.e. bytes)
4326 are present in CONVERSION_BUFFER.
4327 HOW_MUCH should equal TOTAL,
4328 or should be <= 0 if we couldn't read the file. */
4330 if (how_much < 0)
4332 xfree (conversion_buffer);
4333 coding_free_composition_data (&coding);
4334 if (how_much == -1)
4335 error ("IO error reading %s: %s",
4336 SDATA (orig_filename), emacs_strerror (errno));
4337 else if (how_much == -2)
4338 error ("maximum buffer size exceeded");
4341 /* Compare the beginning of the converted file
4342 with the buffer text. */
4344 bufpos = 0;
4345 while (bufpos < inserted && same_at_start < same_at_end
4346 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4347 same_at_start++, bufpos++;
4349 /* If the file matches the buffer completely,
4350 there's no need to replace anything. */
4352 if (bufpos == inserted)
4354 xfree (conversion_buffer);
4355 coding_free_composition_data (&coding);
4356 emacs_close (fd);
4357 specpdl_ptr--;
4358 /* Truncate the buffer to the size of the file. */
4359 del_range_byte (same_at_start, same_at_end, 0);
4360 inserted = 0;
4361 goto handled;
4364 /* Extend the start of non-matching text area to multibyte
4365 character boundary. */
4366 if (! NILP (current_buffer->enable_multibyte_characters))
4367 while (same_at_start > BEGV_BYTE
4368 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4369 same_at_start--;
4371 /* Scan this bufferful from the end, comparing with
4372 the Emacs buffer. */
4373 bufpos = inserted;
4375 /* Compare with same_at_start to avoid counting some buffer text
4376 as matching both at the file's beginning and at the end. */
4377 while (bufpos > 0 && same_at_end > same_at_start
4378 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4379 same_at_end--, bufpos--;
4381 /* Extend the end of non-matching text area to multibyte
4382 character boundary. */
4383 if (! NILP (current_buffer->enable_multibyte_characters))
4384 while (same_at_end < ZV_BYTE
4385 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4386 same_at_end++;
4388 /* Don't try to reuse the same piece of text twice. */
4389 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4390 if (overlap > 0)
4391 same_at_end += overlap;
4393 /* If display currently starts at beginning of line,
4394 keep it that way. */
4395 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4396 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4398 /* Replace the chars that we need to replace,
4399 and update INSERTED to equal the number of bytes
4400 we are taking from the file. */
4401 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4403 if (same_at_end != same_at_start)
4405 del_range_byte (same_at_start, same_at_end, 0);
4406 temp = GPT;
4407 same_at_start = GPT_BYTE;
4409 else
4411 temp = BYTE_TO_CHAR (same_at_start);
4413 /* Insert from the file at the proper position. */
4414 SET_PT_BOTH (temp, same_at_start);
4415 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4416 0, 0, 0);
4417 if (coding.cmp_data && coding.cmp_data->used)
4418 coding_restore_composition (&coding, Fcurrent_buffer ());
4419 coding_free_composition_data (&coding);
4421 /* Set `inserted' to the number of inserted characters. */
4422 inserted = PT - temp;
4424 xfree (conversion_buffer);
4425 emacs_close (fd);
4426 specpdl_ptr--;
4428 goto handled;
4431 if (! not_regular)
4433 register Lisp_Object temp;
4435 total = XINT (end) - XINT (beg);
4437 /* Make sure point-max won't overflow after this insertion. */
4438 XSETINT (temp, total);
4439 if (total != XINT (temp))
4440 error ("Maximum buffer size exceeded");
4442 else
4443 /* For a special file, all we can do is guess. */
4444 total = READ_BUF_SIZE;
4446 if (NILP (visit) && inserted > 0)
4448 #ifdef CLASH_DETECTION
4449 if (!NILP (current_buffer->file_truename)
4450 /* Make binding buffer-file-name to nil effective. */
4451 && !NILP (current_buffer->filename)
4452 && SAVE_MODIFF >= MODIFF)
4453 we_locked_file = 1;
4454 #endif /* CLASH_DETECTION */
4455 prepare_to_modify_buffer (GPT, GPT, NULL);
4458 move_gap (PT);
4459 if (GAP_SIZE < total)
4460 make_gap (total - GAP_SIZE);
4462 if (XINT (beg) != 0 || !NILP (replace))
4464 if (lseek (fd, XINT (beg), 0) < 0)
4465 report_file_error ("Setting file position",
4466 Fcons (orig_filename, Qnil));
4469 /* In the following loop, HOW_MUCH contains the total bytes read so
4470 far for a regular file, and not changed for a special file. But,
4471 before exiting the loop, it is set to a negative value if I/O
4472 error occurs. */
4473 how_much = 0;
4475 /* Total bytes inserted. */
4476 inserted = 0;
4478 /* Here, we don't do code conversion in the loop. It is done by
4479 code_convert_region after all data are read into the buffer. */
4481 int gap_size = GAP_SIZE;
4483 while (how_much < total)
4485 /* try is reserved in some compilers (Microsoft C) */
4486 int trytry = min (total - how_much, READ_BUF_SIZE);
4487 int this;
4489 if (not_regular)
4491 Lisp_Object val;
4493 /* Maybe make more room. */
4494 if (gap_size < trytry)
4496 make_gap (total - gap_size);
4497 gap_size = GAP_SIZE;
4500 /* Read from the file, capturing `quit'. When an
4501 error occurs, end the loop, and arrange for a quit
4502 to be signaled after decoding the text we read. */
4503 non_regular_fd = fd;
4504 non_regular_inserted = inserted;
4505 non_regular_nbytes = trytry;
4506 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4507 read_non_regular_quit);
4508 if (NILP (val))
4510 read_quit = 1;
4511 break;
4514 this = XINT (val);
4516 else
4518 /* Allow quitting out of the actual I/O. We don't make text
4519 part of the buffer until all the reading is done, so a C-g
4520 here doesn't do any harm. */
4521 immediate_quit = 1;
4522 QUIT;
4523 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4524 immediate_quit = 0;
4527 if (this <= 0)
4529 how_much = this;
4530 break;
4533 gap_size -= this;
4535 /* For a regular file, where TOTAL is the real size,
4536 count HOW_MUCH to compare with it.
4537 For a special file, where TOTAL is just a buffer size,
4538 so don't bother counting in HOW_MUCH.
4539 (INSERTED is where we count the number of characters inserted.) */
4540 if (! not_regular)
4541 how_much += this;
4542 inserted += this;
4546 /* Now we have read all the file data into the gap.
4547 If it was empty, undo marking the buffer modified. */
4549 if (inserted == 0)
4551 #ifdef CLASH_DETECTION
4552 if (we_locked_file)
4553 unlock_file (current_buffer->file_truename);
4554 #endif
4555 Vdeactivate_mark = old_Vdeactivate_mark;
4558 /* Make the text read part of the buffer. */
4559 GAP_SIZE -= inserted;
4560 GPT += inserted;
4561 GPT_BYTE += inserted;
4562 ZV += inserted;
4563 ZV_BYTE += inserted;
4564 Z += inserted;
4565 Z_BYTE += inserted;
4567 if (GAP_SIZE > 0)
4568 /* Put an anchor to ensure multi-byte form ends at gap. */
4569 *GPT_ADDR = 0;
4571 emacs_close (fd);
4573 /* Discard the unwind protect for closing the file. */
4574 specpdl_ptr--;
4576 if (how_much < 0)
4577 error ("IO error reading %s: %s",
4578 SDATA (orig_filename), emacs_strerror (errno));
4580 notfound:
4582 if (! coding_system_decided)
4584 /* The coding system is not yet decided. Decide it by an
4585 optimized method for handling `coding:' tag.
4587 Note that we can get here only if the buffer was empty
4588 before the insertion. */
4589 Lisp_Object val;
4590 val = Qnil;
4592 if (!NILP (Vcoding_system_for_read))
4593 val = Vcoding_system_for_read;
4594 else
4596 /* Since we are sure that the current buffer was empty
4597 before the insertion, we can toggle
4598 enable-multibyte-characters directly here without taking
4599 care of marker adjustment and byte combining problem. By
4600 this way, we can run Lisp program safely before decoding
4601 the inserted text. */
4602 Lisp_Object unwind_data;
4603 int count = SPECPDL_INDEX ();
4605 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4606 Fcons (current_buffer->undo_list,
4607 Fcurrent_buffer ()));
4608 current_buffer->enable_multibyte_characters = Qnil;
4609 current_buffer->undo_list = Qt;
4610 record_unwind_protect (decide_coding_unwind, unwind_data);
4612 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4614 val = call2 (Vset_auto_coding_function,
4615 filename, make_number (inserted));
4618 if (NILP (val))
4620 /* If the coding system is not yet decided, check
4621 file-coding-system-alist. */
4622 Lisp_Object args[6], coding_systems;
4624 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4625 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4626 coding_systems = Ffind_operation_coding_system (6, args);
4627 if (CONSP (coding_systems))
4628 val = XCAR (coding_systems);
4630 unbind_to (count, Qnil);
4631 inserted = Z_BYTE - BEG_BYTE;
4634 /* The following kludgy code is to avoid some compiler bug.
4635 We can't simply do
4636 setup_coding_system (val, &coding);
4637 on some system. */
4639 struct coding_system temp_coding;
4640 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4641 bcopy (&temp_coding, &coding, sizeof coding);
4643 /* Ensure we set Vlast_coding_system_used. */
4644 set_coding_system = 1;
4646 if (NILP (current_buffer->enable_multibyte_characters)
4647 && ! NILP (val))
4648 /* We must suppress all character code conversion except for
4649 end-of-line conversion. */
4650 setup_raw_text_coding_system (&coding);
4651 coding.src_multibyte = 0;
4652 coding.dst_multibyte
4653 = !NILP (current_buffer->enable_multibyte_characters);
4656 if (!NILP (visit)
4657 /* Can't do this if part of the buffer might be preserved. */
4658 && NILP (replace)
4659 && (coding.type == coding_type_no_conversion
4660 || coding.type == coding_type_raw_text))
4662 /* Visiting a file with these coding system makes the buffer
4663 unibyte. */
4664 current_buffer->enable_multibyte_characters = Qnil;
4665 coding.dst_multibyte = 0;
4668 if (inserted > 0 || coding.type == coding_type_ccl)
4670 if (CODING_MAY_REQUIRE_DECODING (&coding))
4672 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4673 &coding, 0, 0);
4674 inserted = coding.produced_char;
4676 else
4677 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4678 inserted);
4681 /* Now INSERTED is measured in characters. */
4683 #ifdef DOS_NT
4684 /* Use the conversion type to determine buffer-file-type
4685 (find-buffer-file-type is now used to help determine the
4686 conversion). */
4687 if ((coding.eol_type == CODING_EOL_UNDECIDED
4688 || coding.eol_type == CODING_EOL_LF)
4689 && ! CODING_REQUIRE_DECODING (&coding))
4690 current_buffer->buffer_file_type = Qt;
4691 else
4692 current_buffer->buffer_file_type = Qnil;
4693 #endif
4695 handled:
4697 if (!NILP (visit))
4699 if (!EQ (current_buffer->undo_list, Qt))
4700 current_buffer->undo_list = Qnil;
4701 #ifdef APOLLO
4702 stat (SDATA (filename), &st);
4703 #endif
4705 if (NILP (handler))
4707 current_buffer->modtime = st.st_mtime;
4708 current_buffer->filename = orig_filename;
4711 SAVE_MODIFF = MODIFF;
4712 current_buffer->auto_save_modified = MODIFF;
4713 XSETFASTINT (current_buffer->save_length, Z - BEG);
4714 #ifdef CLASH_DETECTION
4715 if (NILP (handler))
4717 if (!NILP (current_buffer->file_truename))
4718 unlock_file (current_buffer->file_truename);
4719 unlock_file (filename);
4721 #endif /* CLASH_DETECTION */
4722 if (not_regular)
4723 Fsignal (Qfile_error,
4724 Fcons (build_string ("not a regular file"),
4725 Fcons (orig_filename, Qnil)));
4728 if (set_coding_system)
4729 Vlast_coding_system_used = coding.symbol;
4731 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4733 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4734 visit);
4735 if (! NILP (insval))
4737 CHECK_NUMBER (insval);
4738 inserted = XFASTINT (insval);
4742 /* Decode file format */
4743 if (inserted > 0)
4745 int empty_undo_list_p = 0;
4747 /* If we're anyway going to discard undo information, don't
4748 record it in the first place. The buffer's undo list at this
4749 point is either nil or t when visiting a file. */
4750 if (!NILP (visit))
4752 empty_undo_list_p = NILP (current_buffer->undo_list);
4753 current_buffer->undo_list = Qt;
4756 insval = call3 (Qformat_decode,
4757 Qnil, make_number (inserted), visit);
4758 CHECK_NUMBER (insval);
4759 inserted = XFASTINT (insval);
4761 if (!NILP (visit))
4762 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4765 /* Call after-change hooks for the inserted text, aside from the case
4766 of normal visiting (not with REPLACE), which is done in a new buffer
4767 "before" the buffer is changed. */
4768 if (inserted > 0 && total > 0
4769 && (NILP (visit) || !NILP (replace)))
4771 signal_after_change (PT, 0, inserted);
4772 update_compositions (PT, PT, CHECK_BORDER);
4775 p = Vafter_insert_file_functions;
4776 while (CONSP (p))
4778 insval = call1 (XCAR (p), make_number (inserted));
4779 if (!NILP (insval))
4781 CHECK_NUMBER (insval);
4782 inserted = XFASTINT (insval);
4784 QUIT;
4785 p = XCDR (p);
4788 if (!NILP (visit)
4789 && current_buffer->modtime == -1)
4791 /* If visiting nonexistent file, return nil. */
4792 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4795 if (read_quit)
4796 Fsignal (Qquit, Qnil);
4798 /* ??? Retval needs to be dealt with in all cases consistently. */
4799 if (NILP (val))
4800 val = Fcons (orig_filename,
4801 Fcons (make_number (inserted),
4802 Qnil));
4804 RETURN_UNGCPRO (unbind_to (count, val));
4807 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4808 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4809 Lisp_Object, Lisp_Object));
4811 /* If build_annotations switched buffers, switch back to BUF.
4812 Kill the temporary buffer that was selected in the meantime.
4814 Since this kill only the last temporary buffer, some buffers remain
4815 not killed if build_annotations switched buffers more than once.
4816 -- K.Handa */
4818 static Lisp_Object
4819 build_annotations_unwind (buf)
4820 Lisp_Object buf;
4822 Lisp_Object tembuf;
4824 if (XBUFFER (buf) == current_buffer)
4825 return Qnil;
4826 tembuf = Fcurrent_buffer ();
4827 Fset_buffer (buf);
4828 Fkill_buffer (tembuf);
4829 return Qnil;
4832 /* Decide the coding-system to encode the data with. */
4834 void
4835 choose_write_coding_system (start, end, filename,
4836 append, visit, lockname, coding)
4837 Lisp_Object start, end, filename, append, visit, lockname;
4838 struct coding_system *coding;
4840 Lisp_Object val;
4842 if (auto_saving
4843 && NILP (Fstring_equal (current_buffer->filename,
4844 current_buffer->auto_save_file_name)))
4846 /* We use emacs-mule for auto saving... */
4847 setup_coding_system (Qemacs_mule, coding);
4848 /* ... but with the special flag to indicate not to strip off
4849 leading code of eight-bit-control chars. */
4850 coding->flags = 1;
4851 goto done_setup_coding;
4853 else if (!NILP (Vcoding_system_for_write))
4855 val = Vcoding_system_for_write;
4856 if (coding_system_require_warning
4857 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4858 /* Confirm that VAL can surely encode the current region. */
4859 val = call5 (Vselect_safe_coding_system_function,
4860 start, end, Fcons (Qt, Fcons (val, Qnil)),
4861 Qnil, filename);
4863 else
4865 /* If the variable `buffer-file-coding-system' is set locally,
4866 it means that the file was read with some kind of code
4867 conversion or the variable is explicitly set by users. We
4868 had better write it out with the same coding system even if
4869 `enable-multibyte-characters' is nil.
4871 If it is not set locally, we anyway have to convert EOL
4872 format if the default value of `buffer-file-coding-system'
4873 tells that it is not Unix-like (LF only) format. */
4874 int using_default_coding = 0;
4875 int force_raw_text = 0;
4877 val = current_buffer->buffer_file_coding_system;
4878 if (NILP (val)
4879 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4881 val = Qnil;
4882 if (NILP (current_buffer->enable_multibyte_characters))
4883 force_raw_text = 1;
4886 if (NILP (val))
4888 /* Check file-coding-system-alist. */
4889 Lisp_Object args[7], coding_systems;
4891 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4892 args[3] = filename; args[4] = append; args[5] = visit;
4893 args[6] = lockname;
4894 coding_systems = Ffind_operation_coding_system (7, args);
4895 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4896 val = XCDR (coding_systems);
4899 if (NILP (val)
4900 && !NILP (current_buffer->buffer_file_coding_system))
4902 /* If we still have not decided a coding system, use the
4903 default value of buffer-file-coding-system. */
4904 val = current_buffer->buffer_file_coding_system;
4905 using_default_coding = 1;
4908 if (!force_raw_text
4909 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4910 /* Confirm that VAL can surely encode the current region. */
4911 val = call5 (Vselect_safe_coding_system_function,
4912 start, end, val, Qnil, filename);
4914 setup_coding_system (Fcheck_coding_system (val), coding);
4915 if (coding->eol_type == CODING_EOL_UNDECIDED
4916 && !using_default_coding)
4918 if (! EQ (default_buffer_file_coding.symbol,
4919 buffer_defaults.buffer_file_coding_system))
4920 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4921 &default_buffer_file_coding);
4922 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4924 Lisp_Object subsidiaries;
4926 coding->eol_type = default_buffer_file_coding.eol_type;
4927 subsidiaries = Fget (coding->symbol, Qeol_type);
4928 if (VECTORP (subsidiaries)
4929 && XVECTOR (subsidiaries)->size == 3)
4930 coding->symbol
4931 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4935 if (force_raw_text)
4936 setup_raw_text_coding_system (coding);
4937 goto done_setup_coding;
4940 setup_coding_system (Fcheck_coding_system (val), coding);
4942 done_setup_coding:
4943 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4944 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4947 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4948 "r\nFWrite region to file: \ni\ni\ni\np",
4949 doc: /* Write current region into specified file.
4950 When called from a program, requires three arguments:
4951 START, END and FILENAME. START and END are normally buffer positions
4952 specifying the part of the buffer to write.
4953 If START is nil, that means to use the entire buffer contents.
4954 If START is a string, then output that string to the file
4955 instead of any buffer contents; END is ignored.
4957 Optional fourth argument APPEND if non-nil means
4958 append to existing file contents (if any). If it is an integer,
4959 seek to that offset in the file before writing.
4960 Optional fifth argument VISIT, if t or a string, means
4961 set the last-save-file-modtime of buffer to this file's modtime
4962 and mark buffer not modified.
4963 If VISIT is a string, it is a second file name;
4964 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4965 VISIT is also the file name to lock and unlock for clash detection.
4966 If VISIT is neither t nor nil nor a string,
4967 that means do not display the \"Wrote file\" message.
4968 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4969 use for locking and unlocking, overriding FILENAME and VISIT.
4970 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4971 for an existing file with the same name. If MUSTBENEW is `excl',
4972 that means to get an error if the file already exists; never overwrite.
4973 If MUSTBENEW is neither nil nor `excl', that means ask for
4974 confirmation before overwriting, but do go ahead and overwrite the file
4975 if the user confirms.
4977 This does code conversion according to the value of
4978 `coding-system-for-write', `buffer-file-coding-system', or
4979 `file-coding-system-alist', and sets the variable
4980 `last-coding-system-used' to the coding system actually used. */)
4981 (start, end, filename, append, visit, lockname, mustbenew)
4982 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4984 register int desc;
4985 int failure;
4986 int save_errno = 0;
4987 const unsigned char *fn;
4988 struct stat st;
4989 int tem;
4990 int count = SPECPDL_INDEX ();
4991 int count1;
4992 #ifdef VMS
4993 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4994 #endif /* VMS */
4995 Lisp_Object handler;
4996 Lisp_Object visit_file;
4997 Lisp_Object annotations;
4998 Lisp_Object encoded_filename;
4999 int visiting = (EQ (visit, Qt) || STRINGP (visit));
5000 int quietly = !NILP (visit);
5001 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5002 struct buffer *given_buffer;
5003 #ifdef DOS_NT
5004 int buffer_file_type = O_BINARY;
5005 #endif /* DOS_NT */
5006 struct coding_system coding;
5008 if (current_buffer->base_buffer && visiting)
5009 error ("Cannot do file visiting in an indirect buffer");
5011 if (!NILP (start) && !STRINGP (start))
5012 validate_region (&start, &end);
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 (iff 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. */
5311 if (errno != EINTR)
5312 failure = 1, save_errno = errno;
5314 #endif
5316 /* Spurious "file has changed on disk" warnings have been
5317 observed on Suns as well.
5318 It seems that `close' can change the modtime, under nfs.
5320 (This has supposedly been fixed in Sunos 4,
5321 but who knows about all the other machines with NFS?) */
5322 #if 0
5324 /* On VMS and APOLLO, must do the stat after the close
5325 since closing changes the modtime. */
5326 #ifndef VMS
5327 #ifndef APOLLO
5328 /* Recall that #if defined does not work on VMS. */
5329 #define FOO
5330 fstat (desc, &st);
5331 #endif
5332 #endif
5333 #endif
5335 /* NFS can report a write failure now. */
5336 if (emacs_close (desc) < 0)
5337 failure = 1, save_errno = errno;
5339 #ifdef VMS
5340 /* If we wrote to a temporary name and had no errors, rename to real name. */
5341 if (fname)
5343 if (!failure)
5344 failure = (rename (fn, fname) != 0), save_errno = errno;
5345 fn = fname;
5347 #endif /* VMS */
5349 #ifndef FOO
5350 stat (fn, &st);
5351 #endif
5352 /* Discard the unwind protect for close_file_unwind. */
5353 specpdl_ptr = specpdl + count1;
5354 /* Restore the original current buffer. */
5355 visit_file = unbind_to (count, visit_file);
5357 #ifdef CLASH_DETECTION
5358 if (!auto_saving)
5359 unlock_file (lockname);
5360 #endif /* CLASH_DETECTION */
5362 /* Do this before reporting IO error
5363 to avoid a "file has changed on disk" warning on
5364 next attempt to save. */
5365 if (visiting)
5366 current_buffer->modtime = st.st_mtime;
5368 if (failure)
5369 error ("IO error writing %s: %s", SDATA (filename),
5370 emacs_strerror (save_errno));
5372 if (visiting)
5374 SAVE_MODIFF = MODIFF;
5375 XSETFASTINT (current_buffer->save_length, Z - BEG);
5376 current_buffer->filename = visit_file;
5377 update_mode_lines++;
5379 else if (quietly)
5381 if (auto_saving
5382 && ! NILP (Fstring_equal (current_buffer->filename,
5383 current_buffer->auto_save_file_name)))
5384 SAVE_MODIFF = MODIFF;
5386 return Qnil;
5389 if (!auto_saving)
5390 message_with_string ((INTEGERP (append)
5391 ? "Updated %s"
5392 : ! NILP (append)
5393 ? "Added to %s"
5394 : "Wrote %s"),
5395 visit_file, 1);
5397 return Qnil;
5400 Lisp_Object merge ();
5402 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5403 doc: /* Return t if (car A) is numerically less than (car B). */)
5404 (a, b)
5405 Lisp_Object a, b;
5407 return Flss (Fcar (a), Fcar (b));
5410 /* Build the complete list of annotations appropriate for writing out
5411 the text between START and END, by calling all the functions in
5412 write-region-annotate-functions and merging the lists they return.
5413 If one of these functions switches to a different buffer, we assume
5414 that buffer contains altered text. Therefore, the caller must
5415 make sure to restore the current buffer in all cases,
5416 as save-excursion would do. */
5418 static Lisp_Object
5419 build_annotations (start, end)
5420 Lisp_Object start, end;
5422 Lisp_Object annotations;
5423 Lisp_Object p, res;
5424 struct gcpro gcpro1, gcpro2;
5425 Lisp_Object original_buffer;
5426 int i, used_global = 0;
5428 XSETBUFFER (original_buffer, current_buffer);
5430 annotations = Qnil;
5431 p = Vwrite_region_annotate_functions;
5432 GCPRO2 (annotations, p);
5433 while (CONSP (p))
5435 struct buffer *given_buffer = current_buffer;
5436 if (EQ (Qt, XCAR (p)) && !used_global)
5437 { /* Use the global value of the hook. */
5438 Lisp_Object arg[2];
5439 used_global = 1;
5440 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5441 arg[1] = XCDR (p);
5442 p = Fappend (2, arg);
5443 continue;
5445 Vwrite_region_annotations_so_far = annotations;
5446 res = call2 (XCAR (p), start, end);
5447 /* If the function makes a different buffer current,
5448 assume that means this buffer contains altered text to be output.
5449 Reset START and END from the buffer bounds
5450 and discard all previous annotations because they should have
5451 been dealt with by this function. */
5452 if (current_buffer != given_buffer)
5454 XSETFASTINT (start, BEGV);
5455 XSETFASTINT (end, ZV);
5456 annotations = Qnil;
5458 Flength (res); /* Check basic validity of return value */
5459 annotations = merge (annotations, res, Qcar_less_than_car);
5460 p = XCDR (p);
5463 /* Now do the same for annotation functions implied by the file-format */
5464 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5465 p = current_buffer->auto_save_file_format;
5466 else
5467 p = current_buffer->file_format;
5468 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5470 struct buffer *given_buffer = current_buffer;
5472 Vwrite_region_annotations_so_far = annotations;
5474 /* Value is either a list of annotations or nil if the function
5475 has written annotations to a temporary buffer, which is now
5476 current. */
5477 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5478 original_buffer, make_number (i));
5479 if (current_buffer != given_buffer)
5481 XSETFASTINT (start, BEGV);
5482 XSETFASTINT (end, ZV);
5483 annotations = Qnil;
5486 if (CONSP (res))
5487 annotations = merge (annotations, res, Qcar_less_than_car);
5490 UNGCPRO;
5491 return annotations;
5494 static Lisp_Object
5495 build_annotations_2 (start, end, pre_write_conversion, annotations)
5496 Lisp_Object start, end, pre_write_conversion, annotations;
5498 struct gcpro gcpro1;
5499 Lisp_Object res;
5501 GCPRO1 (annotations);
5502 /* At last, do the same for the function PRE_WRITE_CONVERSION
5503 implied by the current coding-system. */
5504 if (!NILP (pre_write_conversion))
5506 struct buffer *given_buffer = current_buffer;
5507 Vwrite_region_annotations_so_far = annotations;
5508 res = call2 (pre_write_conversion, start, end);
5509 Flength (res);
5510 annotations = (current_buffer != given_buffer
5511 ? res
5512 : merge (annotations, res, Qcar_less_than_car));
5515 UNGCPRO;
5516 return annotations;
5519 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5520 If STRING is nil, POS is the character position in the current buffer.
5521 Intersperse with them the annotations from *ANNOT
5522 which fall within the range of POS to POS + NCHARS,
5523 each at its appropriate position.
5525 We modify *ANNOT by discarding elements as we use them up.
5527 The return value is negative in case of system call failure. */
5529 static int
5530 a_write (desc, string, pos, nchars, annot, coding)
5531 int desc;
5532 Lisp_Object string;
5533 register int nchars;
5534 int pos;
5535 Lisp_Object *annot;
5536 struct coding_system *coding;
5538 Lisp_Object tem;
5539 int nextpos;
5540 int lastpos = pos + nchars;
5542 while (NILP (*annot) || CONSP (*annot))
5544 tem = Fcar_safe (Fcar (*annot));
5545 nextpos = pos - 1;
5546 if (INTEGERP (tem))
5547 nextpos = XFASTINT (tem);
5549 /* If there are no more annotations in this range,
5550 output the rest of the range all at once. */
5551 if (! (nextpos >= pos && nextpos <= lastpos))
5552 return e_write (desc, string, pos, lastpos, coding);
5554 /* Output buffer text up to the next annotation's position. */
5555 if (nextpos > pos)
5557 if (0 > e_write (desc, string, pos, nextpos, coding))
5558 return -1;
5559 pos = nextpos;
5561 /* Output the annotation. */
5562 tem = Fcdr (Fcar (*annot));
5563 if (STRINGP (tem))
5565 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5566 return -1;
5568 *annot = Fcdr (*annot);
5570 return 0;
5573 #ifndef WRITE_BUF_SIZE
5574 #define WRITE_BUF_SIZE (16 * 1024)
5575 #endif
5577 /* Write text in the range START and END into descriptor DESC,
5578 encoding them with coding system CODING. If STRING is nil, START
5579 and END are character positions of the current buffer, else they
5580 are indexes to the string STRING. */
5582 static int
5583 e_write (desc, string, start, end, coding)
5584 int desc;
5585 Lisp_Object string;
5586 int start, end;
5587 struct coding_system *coding;
5589 register char *addr;
5590 register int nbytes;
5591 char buf[WRITE_BUF_SIZE];
5592 int return_val = 0;
5594 if (start >= end)
5595 coding->composing = COMPOSITION_DISABLED;
5596 if (coding->composing != COMPOSITION_DISABLED)
5597 coding_save_composition (coding, start, end, string);
5599 if (STRINGP (string))
5601 addr = SDATA (string);
5602 nbytes = SBYTES (string);
5603 coding->src_multibyte = STRING_MULTIBYTE (string);
5605 else if (start < end)
5607 /* It is assured that the gap is not in the range START and END-1. */
5608 addr = CHAR_POS_ADDR (start);
5609 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5610 coding->src_multibyte
5611 = !NILP (current_buffer->enable_multibyte_characters);
5613 else
5615 addr = "";
5616 nbytes = 0;
5617 coding->src_multibyte = 1;
5620 /* We used to have a code for handling selective display here. But,
5621 now it is handled within encode_coding. */
5622 while (1)
5624 int result;
5626 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5627 if (coding->produced > 0)
5629 coding->produced -= emacs_write (desc, buf, coding->produced);
5630 if (coding->produced)
5632 return_val = -1;
5633 break;
5636 nbytes -= coding->consumed;
5637 addr += coding->consumed;
5638 if (result == CODING_FINISH_INSUFFICIENT_SRC
5639 && nbytes > 0)
5641 /* The source text ends by an incomplete multibyte form.
5642 There's no way other than write it out as is. */
5643 nbytes -= emacs_write (desc, addr, nbytes);
5644 if (nbytes)
5646 return_val = -1;
5647 break;
5650 if (nbytes <= 0)
5651 break;
5652 start += coding->consumed_char;
5653 if (coding->cmp_data)
5654 coding_adjust_composition_offset (coding, start);
5657 if (coding->cmp_data)
5658 coding_free_composition_data (coding);
5660 return return_val;
5663 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5664 Sverify_visited_file_modtime, 1, 1, 0,
5665 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5666 This means that the file has not been changed since it was visited or saved.
5667 See Info node `(elisp)Modification Time' for more details. */)
5668 (buf)
5669 Lisp_Object buf;
5671 struct buffer *b;
5672 struct stat st;
5673 Lisp_Object handler;
5674 Lisp_Object filename;
5676 CHECK_BUFFER (buf);
5677 b = XBUFFER (buf);
5679 if (!STRINGP (b->filename)) return Qt;
5680 if (b->modtime == 0) return Qt;
5682 /* If the file name has special constructs in it,
5683 call the corresponding file handler. */
5684 handler = Ffind_file_name_handler (b->filename,
5685 Qverify_visited_file_modtime);
5686 if (!NILP (handler))
5687 return call2 (handler, Qverify_visited_file_modtime, buf);
5689 filename = ENCODE_FILE (b->filename);
5691 if (stat (SDATA (filename), &st) < 0)
5693 /* If the file doesn't exist now and didn't exist before,
5694 we say that it isn't modified, provided the error is a tame one. */
5695 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5696 st.st_mtime = -1;
5697 else
5698 st.st_mtime = 0;
5700 if (st.st_mtime == b->modtime
5701 /* If both are positive, accept them if they are off by one second. */
5702 || (st.st_mtime > 0 && b->modtime > 0
5703 && (st.st_mtime == b->modtime + 1
5704 || st.st_mtime == b->modtime - 1)))
5705 return Qt;
5706 return Qnil;
5709 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5710 Sclear_visited_file_modtime, 0, 0, 0,
5711 doc: /* Clear out records of last mod time of visited file.
5712 Next attempt to save will certainly not complain of a discrepancy. */)
5715 current_buffer->modtime = 0;
5716 return Qnil;
5719 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5720 Svisited_file_modtime, 0, 0, 0,
5721 doc: /* Return the current buffer's recorded visited file modification time.
5722 The value is a list of the form (HIGH LOW), like the time values
5723 that `file-attributes' returns. If the current buffer has no recorded
5724 file modification time, this function returns 0.
5725 See Info node `(elisp)Modification Time' for more details. */)
5728 Lisp_Object tcons;
5729 tcons = long_to_cons ((unsigned long) current_buffer->modtime);
5730 if (CONSP (tcons))
5731 return list2 (XCAR (tcons), XCDR (tcons));
5732 return tcons;
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 ring_bell ();
5784 args[0] = build_string ("Auto-saving %s: %s");
5785 args[1] = current_buffer->name;
5786 args[2] = Ferror_message_string (error);
5787 msg = Fformat (3, args);
5788 GCPRO1 (msg);
5789 nbytes = SBYTES (msg);
5790 SAFE_ALLOCA (msgbuf, char *, nbytes);
5791 bcopy (SDATA (msg), msgbuf, nbytes);
5793 for (i = 0; i < 3; ++i)
5795 if (i == 0)
5796 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5797 else
5798 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5799 Fsleep_for (make_number (1), Qnil);
5802 SAFE_FREE ();
5803 UNGCPRO;
5804 return Qnil;
5807 Lisp_Object
5808 auto_save_1 ()
5810 struct stat st;
5811 Lisp_Object modes;
5813 auto_save_mode_bits = 0666;
5815 /* Get visited file's mode to become the auto save file's mode. */
5816 if (! NILP (current_buffer->filename))
5818 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5819 /* But make sure we can overwrite it later! */
5820 auto_save_mode_bits = st.st_mode | 0600;
5821 else if ((modes = Ffile_modes (current_buffer->filename),
5822 INTEGERP (modes)))
5823 /* Remote files don't cooperate with stat. */
5824 auto_save_mode_bits = XINT (modes) | 0600;
5827 return
5828 Fwrite_region (Qnil, Qnil,
5829 current_buffer->auto_save_file_name,
5830 Qnil, Qlambda, Qnil, Qnil);
5833 static Lisp_Object
5834 do_auto_save_unwind (arg) /* used as unwind-protect function */
5835 Lisp_Object arg;
5837 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5838 auto_saving = 0;
5839 if (stream != NULL)
5840 fclose (stream);
5841 return Qnil;
5844 static Lisp_Object
5845 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5846 Lisp_Object value;
5848 minibuffer_auto_raise = XINT (value);
5849 return Qnil;
5852 static Lisp_Object
5853 do_auto_save_make_dir (dir)
5854 Lisp_Object dir;
5856 return call2 (Qmake_directory, dir, Qt);
5859 static Lisp_Object
5860 do_auto_save_eh (ignore)
5861 Lisp_Object ignore;
5863 return Qnil;
5866 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5867 doc: /* Auto-save all buffers that need it.
5868 This is all buffers that have auto-saving enabled
5869 and are changed since last auto-saved.
5870 Auto-saving writes the buffer into a file
5871 so that your editing is not lost if the system crashes.
5872 This file is not the file you visited; that changes only when you save.
5873 Normally we run the normal hook `auto-save-hook' before saving.
5875 A non-nil NO-MESSAGE argument means do not print any message if successful.
5876 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5877 (no_message, current_only)
5878 Lisp_Object no_message, current_only;
5880 struct buffer *old = current_buffer, *b;
5881 Lisp_Object tail, buf;
5882 int auto_saved = 0;
5883 int do_handled_files;
5884 Lisp_Object oquit;
5885 FILE *stream = NULL;
5886 int count = SPECPDL_INDEX ();
5887 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5888 int old_message_p = 0;
5889 struct gcpro gcpro1, gcpro2;
5891 if (max_specpdl_size < specpdl_size + 40)
5892 max_specpdl_size = specpdl_size + 40;
5894 if (minibuf_level)
5895 no_message = Qt;
5897 if (NILP (no_message))
5899 old_message_p = push_message ();
5900 record_unwind_protect (pop_message_unwind, Qnil);
5903 /* Ordinarily don't quit within this function,
5904 but don't make it impossible to quit (in case we get hung in I/O). */
5905 oquit = Vquit_flag;
5906 Vquit_flag = Qnil;
5908 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5909 point to non-strings reached from Vbuffer_alist. */
5911 if (!NILP (Vrun_hooks))
5912 call1 (Vrun_hooks, intern ("auto-save-hook"));
5914 if (STRINGP (Vauto_save_list_file_name))
5916 Lisp_Object listfile;
5918 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5920 /* Don't try to create the directory when shutting down Emacs,
5921 because creating the directory might signal an error, and
5922 that would leave Emacs in a strange state. */
5923 if (!NILP (Vrun_hooks))
5925 Lisp_Object dir;
5926 dir = Qnil;
5927 GCPRO2 (dir, listfile);
5928 dir = Ffile_name_directory (listfile);
5929 if (NILP (Ffile_directory_p (dir)))
5930 internal_condition_case_1 (do_auto_save_make_dir,
5931 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5932 do_auto_save_eh);
5933 UNGCPRO;
5936 stream = fopen (SDATA (listfile), "w");
5939 record_unwind_protect (do_auto_save_unwind,
5940 make_save_value (stream, 0));
5941 record_unwind_protect (do_auto_save_unwind_1,
5942 make_number (minibuffer_auto_raise));
5943 minibuffer_auto_raise = 0;
5944 auto_saving = 1;
5946 /* On first pass, save all files that don't have handlers.
5947 On second pass, save all files that do have handlers.
5949 If Emacs is crashing, the handlers may tweak what is causing
5950 Emacs to crash in the first place, and it would be a shame if
5951 Emacs failed to autosave perfectly ordinary files because it
5952 couldn't handle some ange-ftp'd file. */
5954 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5955 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5957 buf = XCDR (XCAR (tail));
5958 b = XBUFFER (buf);
5960 /* Record all the buffers that have auto save mode
5961 in the special file that lists them. For each of these buffers,
5962 Record visited name (if any) and auto save name. */
5963 if (STRINGP (b->auto_save_file_name)
5964 && stream != NULL && do_handled_files == 0)
5966 if (!NILP (b->filename))
5968 fwrite (SDATA (b->filename), 1,
5969 SBYTES (b->filename), stream);
5971 putc ('\n', stream);
5972 fwrite (SDATA (b->auto_save_file_name), 1,
5973 SBYTES (b->auto_save_file_name), stream);
5974 putc ('\n', stream);
5977 if (!NILP (current_only)
5978 && b != current_buffer)
5979 continue;
5981 /* Don't auto-save indirect buffers.
5982 The base buffer takes care of it. */
5983 if (b->base_buffer)
5984 continue;
5986 /* Check for auto save enabled
5987 and file changed since last auto save
5988 and file changed since last real save. */
5989 if (STRINGP (b->auto_save_file_name)
5990 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5991 && b->auto_save_modified < BUF_MODIFF (b)
5992 /* -1 means we've turned off autosaving for a while--see below. */
5993 && XINT (b->save_length) >= 0
5994 && (do_handled_files
5995 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5996 Qwrite_region))))
5998 EMACS_TIME before_time, after_time;
6000 EMACS_GET_TIME (before_time);
6002 /* If we had a failure, don't try again for 20 minutes. */
6003 if (b->auto_save_failure_time >= 0
6004 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
6005 continue;
6007 if ((XFASTINT (b->save_length) * 10
6008 > (BUF_Z (b) - BUF_BEG (b)) * 13)
6009 /* A short file is likely to change a large fraction;
6010 spare the user annoying messages. */
6011 && XFASTINT (b->save_length) > 5000
6012 /* These messages are frequent and annoying for `*mail*'. */
6013 && !EQ (b->filename, Qnil)
6014 && NILP (no_message))
6016 /* It has shrunk too much; turn off auto-saving here. */
6017 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6018 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6019 b->name, 1);
6020 minibuffer_auto_raise = 0;
6021 /* Turn off auto-saving until there's a real save,
6022 and prevent any more warnings. */
6023 XSETINT (b->save_length, -1);
6024 Fsleep_for (make_number (1), Qnil);
6025 continue;
6027 set_buffer_internal (b);
6028 if (!auto_saved && NILP (no_message))
6029 message1 ("Auto-saving...");
6030 internal_condition_case (auto_save_1, Qt, auto_save_error);
6031 auto_saved++;
6032 b->auto_save_modified = BUF_MODIFF (b);
6033 XSETFASTINT (current_buffer->save_length, Z - BEG);
6034 set_buffer_internal (old);
6036 EMACS_GET_TIME (after_time);
6038 /* If auto-save took more than 60 seconds,
6039 assume it was an NFS failure that got a timeout. */
6040 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6041 b->auto_save_failure_time = EMACS_SECS (after_time);
6045 /* Prevent another auto save till enough input events come in. */
6046 record_auto_save ();
6048 if (auto_saved && NILP (no_message))
6050 if (old_message_p)
6052 /* If we are going to restore an old message,
6053 give time to read ours. */
6054 sit_for (1, 0, 0, 0, 0);
6055 restore_message ();
6057 else
6058 /* If we displayed a message and then restored a state
6059 with no message, leave a "done" message on the screen. */
6060 message1 ("Auto-saving...done");
6063 Vquit_flag = oquit;
6065 /* This restores the message-stack status. */
6066 unbind_to (count, Qnil);
6067 return Qnil;
6070 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6071 Sset_buffer_auto_saved, 0, 0, 0,
6072 doc: /* Mark current buffer as auto-saved with its current text.
6073 No auto-save file will be written until the buffer changes again. */)
6076 current_buffer->auto_save_modified = MODIFF;
6077 XSETFASTINT (current_buffer->save_length, Z - BEG);
6078 current_buffer->auto_save_failure_time = -1;
6079 return Qnil;
6082 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6083 Sclear_buffer_auto_save_failure, 0, 0, 0,
6084 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6087 current_buffer->auto_save_failure_time = -1;
6088 return Qnil;
6091 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6092 0, 0, 0,
6093 doc: /* Return t if current buffer has been auto-saved recently.
6094 More precisely, if it has been auto-saved since last read from or saved
6095 in the visited file. If the buffer has no visited file,
6096 then any auto-save counts as "recent". */)
6099 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6102 /* Reading and completing file names */
6103 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6105 /* In the string VAL, change each $ to $$ and return the result. */
6107 static Lisp_Object
6108 double_dollars (val)
6109 Lisp_Object val;
6111 register const unsigned char *old;
6112 register unsigned char *new;
6113 register int n;
6114 int osize, count;
6116 osize = SBYTES (val);
6118 /* Count the number of $ characters. */
6119 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6120 if (*old++ == '$') count++;
6121 if (count > 0)
6123 old = SDATA (val);
6124 val = make_uninit_multibyte_string (SCHARS (val) + count,
6125 osize + count);
6126 new = SDATA (val);
6127 for (n = osize; n > 0; n--)
6128 if (*old != '$')
6129 *new++ = *old++;
6130 else
6132 *new++ = '$';
6133 *new++ = '$';
6134 old++;
6137 return val;
6140 static Lisp_Object
6141 read_file_name_cleanup (arg)
6142 Lisp_Object arg;
6144 return (current_buffer->directory = arg);
6147 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6148 3, 3, 0,
6149 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6150 (string, dir, action)
6151 Lisp_Object string, dir, action;
6152 /* action is nil for complete, t for return list of completions,
6153 lambda for verify final value */
6155 Lisp_Object name, specdir, realdir, val, orig_string;
6156 int changed;
6157 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6159 CHECK_STRING (string);
6161 realdir = dir;
6162 name = string;
6163 orig_string = Qnil;
6164 specdir = Qnil;
6165 changed = 0;
6166 /* No need to protect ACTION--we only compare it with t and nil. */
6167 GCPRO5 (string, realdir, name, specdir, orig_string);
6169 if (SCHARS (string) == 0)
6171 if (EQ (action, Qlambda))
6173 UNGCPRO;
6174 return Qnil;
6177 else
6179 orig_string = string;
6180 string = Fsubstitute_in_file_name (string);
6181 changed = NILP (Fstring_equal (string, orig_string));
6182 name = Ffile_name_nondirectory (string);
6183 val = Ffile_name_directory (string);
6184 if (! NILP (val))
6185 realdir = Fexpand_file_name (val, realdir);
6188 if (NILP (action))
6190 specdir = Ffile_name_directory (string);
6191 val = Ffile_name_completion (name, realdir);
6192 UNGCPRO;
6193 if (!STRINGP (val))
6195 if (changed)
6196 return double_dollars (string);
6197 return val;
6200 if (!NILP (specdir))
6201 val = concat2 (specdir, val);
6202 #ifndef VMS
6203 return double_dollars (val);
6204 #else /* not VMS */
6205 return val;
6206 #endif /* not VMS */
6208 UNGCPRO;
6210 if (EQ (action, Qt))
6212 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6213 Lisp_Object comp;
6214 int count;
6216 if (NILP (Vread_file_name_predicate)
6217 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6218 return all;
6220 #ifndef VMS
6221 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6223 /* Brute-force speed up for directory checking:
6224 Discard strings which don't end in a slash. */
6225 for (comp = Qnil; CONSP (all); all = XCDR (all))
6227 Lisp_Object tem = XCAR (all);
6228 int len;
6229 if (STRINGP (tem) &&
6230 (len = SCHARS (tem), len > 0) &&
6231 IS_DIRECTORY_SEP (SREF (tem, len-1)))
6232 comp = Fcons (tem, comp);
6235 else
6236 #endif
6238 /* Must do it the hard (and slow) way. */
6239 Lisp_Object tem;
6240 GCPRO3 (all, comp, specdir);
6241 count = SPECPDL_INDEX ();
6242 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6243 current_buffer->directory = realdir;
6244 for (comp = Qnil; CONSP (all); all = XCDR (all))
6246 tem = call1 (Vread_file_name_predicate, XCAR (all));
6247 if (!NILP (tem))
6248 comp = Fcons (XCAR (all), comp);
6250 unbind_to (count, Qnil);
6251 UNGCPRO;
6253 return Fnreverse (comp);
6256 /* Only other case actually used is ACTION = lambda */
6257 #ifdef VMS
6258 /* Supposedly this helps commands such as `cd' that read directory names,
6259 but can someone explain how it helps them? -- RMS */
6260 if (SCHARS (name) == 0)
6261 return Qt;
6262 #endif /* VMS */
6263 string = Fexpand_file_name (string, dir);
6264 if (!NILP (Vread_file_name_predicate))
6265 return call1 (Vread_file_name_predicate, string);
6266 return Ffile_exists_p (string);
6269 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6270 Snext_read_file_uses_dialog_p, 0, 0, 0,
6271 doc: /* Return t if a call to `read-file-name' will use a dialog.
6272 The return value is only relevant for a call to `read-file-name' that happens
6273 before any other event (mouse or keypress) is handeled. */)
6276 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6277 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6278 && use_dialog_box
6279 && use_file_dialog
6280 && have_menus_p ())
6281 return Qt;
6282 #endif
6283 return Qnil;
6286 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6287 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6288 Value is not expanded---you must call `expand-file-name' yourself.
6289 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6290 the same non-empty string that was inserted by this function.
6291 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6292 except that if INITIAL is specified, that combined with DIR is used.)
6293 If the user exits with an empty minibuffer, this function returns
6294 an empty string. (This can only happen if the user erased the
6295 pre-inserted contents or if `insert-default-directory' is nil.)
6296 Fourth arg MUSTMATCH non-nil means require existing file's name.
6297 Non-nil and non-t means also require confirmation after completion.
6298 Fifth arg INITIAL specifies text to start with.
6299 If optional sixth arg PREDICATE is non-nil, possible completions and
6300 the resulting file name must satisfy (funcall PREDICATE NAME).
6301 DIR should be an absolute directory name. It defaults to the value of
6302 `default-directory'.
6304 If this command was invoked with the mouse, use a file dialog box if
6305 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6306 provides a file dialog box.
6308 See also `read-file-name-completion-ignore-case'
6309 and `read-file-name-function'. */)
6310 (prompt, dir, default_filename, mustmatch, initial, predicate)
6311 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6313 Lisp_Object val, insdef, tem;
6314 struct gcpro gcpro1, gcpro2;
6315 register char *homedir;
6316 Lisp_Object decoded_homedir;
6317 int replace_in_history = 0;
6318 int add_to_history = 0;
6319 int count;
6321 if (NILP (dir))
6322 dir = current_buffer->directory;
6323 if (NILP (Ffile_name_absolute_p (dir)))
6324 dir = Fexpand_file_name (dir, Qnil);
6325 if (NILP (default_filename))
6326 default_filename
6327 = (!NILP (initial)
6328 ? Fexpand_file_name (initial, dir)
6329 : current_buffer->filename);
6331 /* If dir starts with user's homedir, change that to ~. */
6332 homedir = (char *) egetenv ("HOME");
6333 #ifdef DOS_NT
6334 /* homedir can be NULL in temacs, since Vprocess_environment is not
6335 yet set up. We shouldn't crash in that case. */
6336 if (homedir != 0)
6338 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6339 CORRECT_DIR_SEPS (homedir);
6341 #endif
6342 if (homedir != 0)
6343 decoded_homedir
6344 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6345 if (homedir != 0
6346 && STRINGP (dir)
6347 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6348 SBYTES (decoded_homedir))
6349 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6351 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6352 dir = concat2 (build_string ("~"), dir);
6354 /* Likewise for default_filename. */
6355 if (homedir != 0
6356 && STRINGP (default_filename)
6357 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6358 SBYTES (decoded_homedir))
6359 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6361 default_filename
6362 = Fsubstring (default_filename,
6363 make_number (SCHARS (decoded_homedir)), Qnil);
6364 default_filename = concat2 (build_string ("~"), default_filename);
6366 if (!NILP (default_filename))
6368 CHECK_STRING (default_filename);
6369 default_filename = double_dollars (default_filename);
6372 if (insert_default_directory && STRINGP (dir))
6374 insdef = dir;
6375 if (!NILP (initial))
6377 Lisp_Object args[2], pos;
6379 args[0] = insdef;
6380 args[1] = initial;
6381 insdef = Fconcat (2, args);
6382 pos = make_number (SCHARS (double_dollars (dir)));
6383 insdef = Fcons (double_dollars (insdef), pos);
6385 else
6386 insdef = double_dollars (insdef);
6388 else if (STRINGP (initial))
6389 insdef = Fcons (double_dollars (initial), make_number (0));
6390 else
6391 insdef = Qnil;
6393 if (!NILP (Vread_file_name_function))
6395 Lisp_Object args[7];
6397 GCPRO2 (insdef, default_filename);
6398 args[0] = Vread_file_name_function;
6399 args[1] = prompt;
6400 args[2] = dir;
6401 args[3] = default_filename;
6402 args[4] = mustmatch;
6403 args[5] = initial;
6404 args[6] = predicate;
6405 RETURN_UNGCPRO (Ffuncall (7, args));
6408 count = SPECPDL_INDEX ();
6409 specbind (intern ("completion-ignore-case"),
6410 read_file_name_completion_ignore_case ? Qt : Qnil);
6411 specbind (intern ("minibuffer-completing-file-name"), Qt);
6412 specbind (intern ("read-file-name-predicate"),
6413 (NILP (predicate) ? Qfile_exists_p : predicate));
6415 GCPRO2 (insdef, default_filename);
6417 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6418 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6420 /* If DIR contains a file name, split it. */
6421 Lisp_Object file;
6422 file = Ffile_name_nondirectory (dir);
6423 if (SCHARS (file) && NILP (default_filename))
6425 default_filename = file;
6426 dir = Ffile_name_directory (dir);
6428 if (!NILP(default_filename))
6429 default_filename = Fexpand_file_name (default_filename, dir);
6430 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6431 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6432 add_to_history = 1;
6434 else
6435 #endif
6436 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6437 dir, mustmatch, insdef,
6438 Qfile_name_history, default_filename, Qnil);
6440 tem = Fsymbol_value (Qfile_name_history);
6441 if (CONSP (tem) && EQ (XCAR (tem), val))
6442 replace_in_history = 1;
6444 /* If Fcompleting_read returned the inserted default string itself
6445 (rather than a new string with the same contents),
6446 it has to mean that the user typed RET with the minibuffer empty.
6447 In that case, we really want to return ""
6448 so that commands such as set-visited-file-name can distinguish. */
6449 if (EQ (val, default_filename))
6451 /* In this case, Fcompleting_read has not added an element
6452 to the history. Maybe we should. */
6453 if (! replace_in_history)
6454 add_to_history = 1;
6456 val = empty_string;
6459 unbind_to (count, Qnil);
6460 UNGCPRO;
6461 if (NILP (val))
6462 error ("No file name specified");
6464 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6466 if (!NILP (tem) && !NILP (default_filename))
6467 val = default_filename;
6468 val = Fsubstitute_in_file_name (val);
6470 if (replace_in_history)
6471 /* Replace what Fcompleting_read added to the history
6472 with what we will actually return. */
6474 Lisp_Object val1 = double_dollars (val);
6475 tem = Fsymbol_value (Qfile_name_history);
6476 if (history_delete_duplicates)
6477 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6478 XSETCAR (tem, val1);
6480 else if (add_to_history)
6482 /* Add the value to the history--but not if it matches
6483 the last value already there. */
6484 Lisp_Object val1 = double_dollars (val);
6485 tem = Fsymbol_value (Qfile_name_history);
6486 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6488 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6489 Fset (Qfile_name_history, Fcons (val1, tem));
6493 return val;
6497 void
6498 init_fileio_once ()
6500 /* Must be set before any path manipulation is performed. */
6501 XSETFASTINT (Vdirectory_sep_char, '/');
6505 void
6506 syms_of_fileio ()
6508 Qoperations = intern ("operations");
6509 Qexpand_file_name = intern ("expand-file-name");
6510 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6511 Qdirectory_file_name = intern ("directory-file-name");
6512 Qfile_name_directory = intern ("file-name-directory");
6513 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6514 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6515 Qfile_name_as_directory = intern ("file-name-as-directory");
6516 Qcopy_file = intern ("copy-file");
6517 Qmake_directory_internal = intern ("make-directory-internal");
6518 Qmake_directory = intern ("make-directory");
6519 Qdelete_directory = intern ("delete-directory");
6520 Qdelete_file = intern ("delete-file");
6521 Qrename_file = intern ("rename-file");
6522 Qadd_name_to_file = intern ("add-name-to-file");
6523 Qmake_symbolic_link = intern ("make-symbolic-link");
6524 Qfile_exists_p = intern ("file-exists-p");
6525 Qfile_executable_p = intern ("file-executable-p");
6526 Qfile_readable_p = intern ("file-readable-p");
6527 Qfile_writable_p = intern ("file-writable-p");
6528 Qfile_symlink_p = intern ("file-symlink-p");
6529 Qaccess_file = intern ("access-file");
6530 Qfile_directory_p = intern ("file-directory-p");
6531 Qfile_regular_p = intern ("file-regular-p");
6532 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6533 Qfile_modes = intern ("file-modes");
6534 Qset_file_modes = intern ("set-file-modes");
6535 Qset_file_times = intern ("set-file-times");
6536 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6537 Qinsert_file_contents = intern ("insert-file-contents");
6538 Qwrite_region = intern ("write-region");
6539 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6540 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6541 Qauto_save_coding = intern ("auto-save-coding");
6543 staticpro (&Qoperations);
6544 staticpro (&Qexpand_file_name);
6545 staticpro (&Qsubstitute_in_file_name);
6546 staticpro (&Qdirectory_file_name);
6547 staticpro (&Qfile_name_directory);
6548 staticpro (&Qfile_name_nondirectory);
6549 staticpro (&Qunhandled_file_name_directory);
6550 staticpro (&Qfile_name_as_directory);
6551 staticpro (&Qcopy_file);
6552 staticpro (&Qmake_directory_internal);
6553 staticpro (&Qmake_directory);
6554 staticpro (&Qdelete_directory);
6555 staticpro (&Qdelete_file);
6556 staticpro (&Qrename_file);
6557 staticpro (&Qadd_name_to_file);
6558 staticpro (&Qmake_symbolic_link);
6559 staticpro (&Qfile_exists_p);
6560 staticpro (&Qfile_executable_p);
6561 staticpro (&Qfile_readable_p);
6562 staticpro (&Qfile_writable_p);
6563 staticpro (&Qaccess_file);
6564 staticpro (&Qfile_symlink_p);
6565 staticpro (&Qfile_directory_p);
6566 staticpro (&Qfile_regular_p);
6567 staticpro (&Qfile_accessible_directory_p);
6568 staticpro (&Qfile_modes);
6569 staticpro (&Qset_file_modes);
6570 staticpro (&Qset_file_times);
6571 staticpro (&Qfile_newer_than_file_p);
6572 staticpro (&Qinsert_file_contents);
6573 staticpro (&Qwrite_region);
6574 staticpro (&Qverify_visited_file_modtime);
6575 staticpro (&Qset_visited_file_modtime);
6576 staticpro (&Qauto_save_coding);
6578 Qfile_name_history = intern ("file-name-history");
6579 Fset (Qfile_name_history, Qnil);
6580 staticpro (&Qfile_name_history);
6582 Qfile_error = intern ("file-error");
6583 staticpro (&Qfile_error);
6584 Qfile_already_exists = intern ("file-already-exists");
6585 staticpro (&Qfile_already_exists);
6586 Qfile_date_error = intern ("file-date-error");
6587 staticpro (&Qfile_date_error);
6588 Qexcl = intern ("excl");
6589 staticpro (&Qexcl);
6591 #ifdef DOS_NT
6592 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6593 staticpro (&Qfind_buffer_file_type);
6594 #endif /* DOS_NT */
6596 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6597 doc: /* *Coding system for encoding file names.
6598 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6599 Vfile_name_coding_system = Qnil;
6601 DEFVAR_LISP ("default-file-name-coding-system",
6602 &Vdefault_file_name_coding_system,
6603 doc: /* Default coding system for encoding file names.
6604 This variable is used only when `file-name-coding-system' is nil.
6606 This variable is set/changed by the command `set-language-environment'.
6607 User should not set this variable manually,
6608 instead use `file-name-coding-system' to get a constant encoding
6609 of file names regardless of the current language environment. */);
6610 Vdefault_file_name_coding_system = Qnil;
6612 Qformat_decode = intern ("format-decode");
6613 staticpro (&Qformat_decode);
6614 Qformat_annotate_function = intern ("format-annotate-function");
6615 staticpro (&Qformat_annotate_function);
6616 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6617 staticpro (&Qafter_insert_file_set_coding);
6619 Qcar_less_than_car = intern ("car-less-than-car");
6620 staticpro (&Qcar_less_than_car);
6622 Fput (Qfile_error, Qerror_conditions,
6623 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
6624 Fput (Qfile_error, Qerror_message,
6625 build_string ("File error"));
6627 Fput (Qfile_already_exists, Qerror_conditions,
6628 Fcons (Qfile_already_exists,
6629 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6630 Fput (Qfile_already_exists, Qerror_message,
6631 build_string ("File already exists"));
6633 Fput (Qfile_date_error, Qerror_conditions,
6634 Fcons (Qfile_date_error,
6635 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6636 Fput (Qfile_date_error, Qerror_message,
6637 build_string ("Cannot set file date"));
6639 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6640 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6641 Vread_file_name_function = Qnil;
6643 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6644 doc: /* Current predicate used by `read-file-name-internal'. */);
6645 Vread_file_name_predicate = Qnil;
6647 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6648 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6649 #if defined VMS || defined DOS_NT || defined MAC_OS
6650 read_file_name_completion_ignore_case = 1;
6651 #else
6652 read_file_name_completion_ignore_case = 0;
6653 #endif
6655 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6656 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6657 If the initial minibuffer contents are non-empty, you can usually
6658 request a default filename by typing RETURN without editing. For some
6659 commands, exiting with an empty minibuffer has a special meaning,
6660 such as making the current buffer visit no file in the case of
6661 `set-visited-file-name'.
6662 If this variable is non-nil, the minibuffer contents are always
6663 initially non-empty and typing RETURN without editing will fetch the
6664 default name, if one is provided. Note however that this default name
6665 is not necessarily the name originally inserted in the minibuffer, if
6666 that is just the default directory.
6667 If this variable is nil, the minibuffer often starts out empty. In
6668 that case you may have to explicitly fetch the next history element to
6669 request the default name. */);
6670 insert_default_directory = 1;
6672 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6673 doc: /* *Non-nil means write new files with record format `stmlf'.
6674 nil means use format `var'. This variable is meaningful only on VMS. */);
6675 vms_stmlf_recfm = 0;
6677 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6678 doc: /* Directory separator character for built-in functions that return file names.
6679 The value is always ?/. Don't use this variable, just use `/'. */);
6681 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6682 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6683 If a file name matches REGEXP, then all I/O on that file is done by calling
6684 HANDLER.
6686 The first argument given to HANDLER is the name of the I/O primitive
6687 to be handled; the remaining arguments are the arguments that were
6688 passed to that primitive. For example, if you do
6689 (file-exists-p FILENAME)
6690 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6691 (funcall HANDLER 'file-exists-p FILENAME)
6692 The function `find-file-name-handler' checks this list for a handler
6693 for its argument. */);
6694 Vfile_name_handler_alist = Qnil;
6696 DEFVAR_LISP ("set-auto-coding-function",
6697 &Vset_auto_coding_function,
6698 doc: /* If non-nil, a function to call to decide a coding system of file.
6699 Two arguments are passed to this function: the file name
6700 and the length of a file contents following the point.
6701 This function should return a coding system to decode the file contents.
6702 It should check the file name against `auto-coding-alist'.
6703 If no coding system is decided, it should check a coding system
6704 specified in the heading lines with the format:
6705 -*- ... coding: CODING-SYSTEM; ... -*-
6706 or local variable spec of the tailing lines with `coding:' tag. */);
6707 Vset_auto_coding_function = Qnil;
6709 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6710 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6711 Each is passed one argument, the number of characters inserted.
6712 It should return the new character count, and leave point the same.
6713 If `insert-file-contents' is intercepted by a handler from
6714 `file-name-handler-alist', that handler is responsible for calling the
6715 functions in `after-insert-file-functions' if appropriate. */);
6716 Vafter_insert_file_functions = Qnil;
6718 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6719 doc: /* A list of functions to be called at the start of `write-region'.
6720 Each is passed two arguments, START and END as for `write-region'.
6721 These are usually two numbers but not always; see the documentation
6722 for `write-region'. The function should return a list of pairs
6723 of the form (POSITION . STRING), consisting of strings to be effectively
6724 inserted at the specified positions of the file being written (1 means to
6725 insert before the first byte written). The POSITIONs must be sorted into
6726 increasing order. If there are several functions in the list, the several
6727 lists are merged destructively. Alternatively, the function can return
6728 with a different buffer current; in that case it should pay attention
6729 to the annotations returned by previous functions and listed in
6730 `write-region-annotations-so-far'.*/);
6731 Vwrite_region_annotate_functions = Qnil;
6732 staticpro (&Qwrite_region_annotate_functions);
6733 Qwrite_region_annotate_functions
6734 = intern ("write-region-annotate-functions");
6736 DEFVAR_LISP ("write-region-annotations-so-far",
6737 &Vwrite_region_annotations_so_far,
6738 doc: /* When an annotation function is called, this holds the previous annotations.
6739 These are the annotations made by other annotation functions
6740 that were already called. See also `write-region-annotate-functions'. */);
6741 Vwrite_region_annotations_so_far = Qnil;
6743 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6744 doc: /* A list of file name handlers that temporarily should not be used.
6745 This applies only to the operation `inhibit-file-name-operation'. */);
6746 Vinhibit_file_name_handlers = Qnil;
6748 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6749 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6750 Vinhibit_file_name_operation = Qnil;
6752 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6753 doc: /* File name in which we write a list of all auto save file names.
6754 This variable is initialized automatically from `auto-save-list-file-prefix'
6755 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6756 a non-nil value. */);
6757 Vauto_save_list_file_name = Qnil;
6759 #ifdef HAVE_FSYNC
6760 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6761 doc: /* *Non-nil means don't call fsync in `write-region'.
6762 This variable affects calls to `write-region' as well as save commands.
6763 A non-nil value may result in data loss! */);
6764 write_region_inhibit_fsync = 0;
6765 #endif
6767 defsubr (&Sfind_file_name_handler);
6768 defsubr (&Sfile_name_directory);
6769 defsubr (&Sfile_name_nondirectory);
6770 defsubr (&Sunhandled_file_name_directory);
6771 defsubr (&Sfile_name_as_directory);
6772 defsubr (&Sdirectory_file_name);
6773 defsubr (&Smake_temp_name);
6774 defsubr (&Sexpand_file_name);
6775 defsubr (&Ssubstitute_in_file_name);
6776 defsubr (&Scopy_file);
6777 defsubr (&Smake_directory_internal);
6778 defsubr (&Sdelete_directory);
6779 defsubr (&Sdelete_file);
6780 defsubr (&Srename_file);
6781 defsubr (&Sadd_name_to_file);
6782 #ifdef S_IFLNK
6783 defsubr (&Smake_symbolic_link);
6784 #endif /* S_IFLNK */
6785 #ifdef VMS
6786 defsubr (&Sdefine_logical_name);
6787 #endif /* VMS */
6788 #ifdef HPUX_NET
6789 defsubr (&Ssysnetunam);
6790 #endif /* HPUX_NET */
6791 defsubr (&Sfile_name_absolute_p);
6792 defsubr (&Sfile_exists_p);
6793 defsubr (&Sfile_executable_p);
6794 defsubr (&Sfile_readable_p);
6795 defsubr (&Sfile_writable_p);
6796 defsubr (&Saccess_file);
6797 defsubr (&Sfile_symlink_p);
6798 defsubr (&Sfile_directory_p);
6799 defsubr (&Sfile_accessible_directory_p);
6800 defsubr (&Sfile_regular_p);
6801 defsubr (&Sfile_modes);
6802 defsubr (&Sset_file_modes);
6803 defsubr (&Sset_file_times);
6804 defsubr (&Sset_default_file_modes);
6805 defsubr (&Sdefault_file_modes);
6806 defsubr (&Sfile_newer_than_file_p);
6807 defsubr (&Sinsert_file_contents);
6808 defsubr (&Swrite_region);
6809 defsubr (&Scar_less_than_car);
6810 defsubr (&Sverify_visited_file_modtime);
6811 defsubr (&Sclear_visited_file_modtime);
6812 defsubr (&Svisited_file_modtime);
6813 defsubr (&Sset_visited_file_modtime);
6814 defsubr (&Sdo_auto_save);
6815 defsubr (&Sset_buffer_auto_saved);
6816 defsubr (&Sclear_buffer_auto_save_failure);
6817 defsubr (&Srecent_auto_save_p);
6819 defsubr (&Sread_file_name_internal);
6820 defsubr (&Sread_file_name);
6821 defsubr (&Snext_read_file_uses_dialog_p);
6823 #ifdef unix
6824 defsubr (&Sunix_sync);
6825 #endif
6828 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6829 (do not change this comment) */