(latexenc-find-file-coding-system): Don't inherit the EOL part of the
[emacs.git] / src / fileio.c
blob537b7f4d10db6c50f5f3117320cf7d8c5f556740
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
24 #ifdef HAVE_FCNTL_H
25 #include <fcntl.h>
26 #endif
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
38 #endif
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
42 #endif
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
46 #endif
48 #ifdef HAVE_PWD_H
49 #include <pwd.h>
50 #endif
52 #include <ctype.h>
54 #ifdef VMS
55 #include "vmsdir.h"
56 #include <perror.h>
57 #include <stddef.h>
58 #include <string.h>
59 #endif
61 #include <errno.h>
63 #ifndef vax11c
64 #ifndef USE_CRT_DLL
65 extern int errno;
66 #endif
67 #endif
69 #ifdef APOLLO
70 #include <sys/time.h>
71 #endif
73 #include "lisp.h"
74 #include "intervals.h"
75 #include "buffer.h"
76 #include "charset.h"
77 #include "coding.h"
78 #include "window.h"
80 #ifdef WINDOWSNT
81 #define NOMINMAX 1
82 #include <windows.h>
83 #include <stdlib.h>
84 #include <fcntl.h>
85 #endif /* not WINDOWSNT */
87 #ifdef MSDOS
88 #include "msdos.h"
89 #include <sys/param.h>
90 #if __DJGPP__ >= 2
91 #include <fcntl.h>
92 #include <string.h>
93 #endif
94 #endif
96 #ifdef DOS_NT
97 #define CORRECT_DIR_SEPS(s) \
98 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
99 else unixtodos_filename (s); \
100 } while (0)
101 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
102 redirector allows the six letters between 'Z' and 'a' as well. */
103 #ifdef MSDOS
104 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
105 #endif
106 #ifdef WINDOWSNT
107 #define IS_DRIVE(x) isalpha (x)
108 #endif
109 /* Need to lower-case the drive letter, or else expanded
110 filenames will sometimes compare inequal, because
111 `expand-file-name' doesn't always down-case the drive letter. */
112 #define DRIVE_LETTER(x) (tolower (x))
113 #endif
115 #ifdef VMS
116 #include <file.h>
117 #include <rmsdef.h>
118 #include <fab.h>
119 #include <nam.h>
120 #endif
122 #include "systime.h"
124 #ifdef HPUX
125 #include <netio.h>
126 #ifndef HPUX8
127 #ifndef HPUX9
128 #include <errnet.h>
129 #endif
130 #endif
131 #endif
133 #include "commands.h"
134 extern int use_dialog_box;
135 extern int use_file_dialog;
137 #ifndef O_WRONLY
138 #define O_WRONLY 1
139 #endif
141 #ifndef O_RDONLY
142 #define O_RDONLY 0
143 #endif
145 #ifndef S_ISLNK
146 # define lstat stat
147 #endif
149 #ifndef FILE_SYSTEM_CASE
150 #define FILE_SYSTEM_CASE(filename) (filename)
151 #endif
153 /* Nonzero during writing of auto-save files */
154 int auto_saving;
156 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
157 a new file with the same mode as the original */
158 int auto_save_mode_bits;
160 /* The symbol bound to coding-system-for-read when
161 insert-file-contents is called for recovering a file. This is not
162 an actual coding system name, but just an indicator to tell
163 insert-file-contents to use `emacs-mule' with a special flag for
164 auto saving and recovering a file. */
165 Lisp_Object Qauto_save_coding;
167 /* Coding system for file names, or nil if none. */
168 Lisp_Object Vfile_name_coding_system;
170 /* Coding system for file names used only when
171 Vfile_name_coding_system is nil. */
172 Lisp_Object Vdefault_file_name_coding_system;
174 /* Alist of elements (REGEXP . HANDLER) for file names
175 whose I/O is done with a special handler. */
176 Lisp_Object Vfile_name_handler_alist;
178 /* Property name of a file name handler,
179 which gives a list of operations it handles.. */
180 Lisp_Object Qoperations;
182 /* Lisp functions for translating file formats */
183 Lisp_Object Qformat_decode, Qformat_annotate_function;
185 /* Function to be called to decide a coding system of a reading file. */
186 Lisp_Object Vset_auto_coding_function;
188 /* Functions to be called to process text properties in inserted file. */
189 Lisp_Object Vafter_insert_file_functions;
191 /* Lisp function for setting buffer-file-coding-system and the
192 multibyteness of the current buffer after inserting a file. */
193 Lisp_Object Qafter_insert_file_set_coding;
195 /* Functions to be called to create text property annotations for file. */
196 Lisp_Object Vwrite_region_annotate_functions;
197 Lisp_Object Qwrite_region_annotate_functions;
199 /* During build_annotations, each time an annotation function is called,
200 this holds the annotations made by the previous functions. */
201 Lisp_Object Vwrite_region_annotations_so_far;
203 /* File name in which we write a list of all our auto save files. */
204 Lisp_Object Vauto_save_list_file_name;
206 /* Function to call to read a file name. */
207 Lisp_Object Vread_file_name_function;
209 /* Current predicate used by read_file_name_internal. */
210 Lisp_Object Vread_file_name_predicate;
212 /* Nonzero means completion ignores case when reading file name. */
213 int read_file_name_completion_ignore_case;
215 /* Nonzero means, when reading a filename in the minibuffer,
216 start out by inserting the default directory into the minibuffer. */
217 int insert_default_directory;
219 /* On VMS, nonzero means write new files with record format stmlf.
220 Zero means use var format. */
221 int vms_stmlf_recfm;
223 /* On NT, specifies the directory separator character, used (eg.) when
224 expanding file names. This can be bound to / or \. */
225 Lisp_Object Vdirectory_sep_char;
227 extern Lisp_Object Vuser_login_name;
229 #ifdef WINDOWSNT
230 extern Lisp_Object Vw32_get_true_file_attributes;
231 #endif
233 extern int minibuf_level;
235 extern int minibuffer_auto_raise;
237 extern int history_delete_duplicates;
239 /* These variables describe handlers that have "already" had a chance
240 to handle the current operation.
242 Vinhibit_file_name_handlers is a list of file name handlers.
243 Vinhibit_file_name_operation is the operation being handled.
244 If we try to handle that operation, we ignore those handlers. */
246 static Lisp_Object Vinhibit_file_name_handlers;
247 static Lisp_Object Vinhibit_file_name_operation;
249 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
250 Lisp_Object Qexcl;
251 Lisp_Object Qfile_name_history;
253 Lisp_Object Qcar_less_than_car;
255 static int a_write P_ ((int, Lisp_Object, int, int,
256 Lisp_Object *, struct coding_system *));
257 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
260 void
261 report_file_error (string, data)
262 const char *string;
263 Lisp_Object data;
265 Lisp_Object errstring;
266 int errorno = errno;
268 synchronize_system_messages_locale ();
269 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
270 Vlocale_coding_system, 0);
272 while (1)
273 switch (errorno)
275 case EEXIST:
276 Fsignal (Qfile_already_exists, Fcons (errstring, data));
277 break;
278 default:
279 /* System error messages are capitalized. Downcase the initial
280 unless it is followed by a slash. */
281 if (SREF (errstring, 1) != '/')
282 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
284 Fsignal (Qfile_error,
285 Fcons (build_string (string), Fcons (errstring, data)));
289 Lisp_Object
290 close_file_unwind (fd)
291 Lisp_Object fd;
293 emacs_close (XFASTINT (fd));
294 return Qnil;
297 /* Restore point, having saved it as a marker. */
299 static Lisp_Object
300 restore_point_unwind (location)
301 Lisp_Object location;
303 Fgoto_char (location);
304 Fset_marker (location, Qnil, Qnil);
305 return Qnil;
308 Lisp_Object Qexpand_file_name;
309 Lisp_Object Qsubstitute_in_file_name;
310 Lisp_Object Qdirectory_file_name;
311 Lisp_Object Qfile_name_directory;
312 Lisp_Object Qfile_name_nondirectory;
313 Lisp_Object Qunhandled_file_name_directory;
314 Lisp_Object Qfile_name_as_directory;
315 Lisp_Object Qcopy_file;
316 Lisp_Object Qmake_directory_internal;
317 Lisp_Object Qmake_directory;
318 Lisp_Object Qdelete_directory;
319 Lisp_Object Qdelete_file;
320 Lisp_Object Qrename_file;
321 Lisp_Object Qadd_name_to_file;
322 Lisp_Object Qmake_symbolic_link;
323 Lisp_Object Qfile_exists_p;
324 Lisp_Object Qfile_executable_p;
325 Lisp_Object Qfile_readable_p;
326 Lisp_Object Qfile_writable_p;
327 Lisp_Object Qfile_symlink_p;
328 Lisp_Object Qaccess_file;
329 Lisp_Object Qfile_directory_p;
330 Lisp_Object Qfile_regular_p;
331 Lisp_Object Qfile_accessible_directory_p;
332 Lisp_Object Qfile_modes;
333 Lisp_Object Qset_file_modes;
334 Lisp_Object Qset_file_times;
335 Lisp_Object Qfile_newer_than_file_p;
336 Lisp_Object Qinsert_file_contents;
337 Lisp_Object Qwrite_region;
338 Lisp_Object Qverify_visited_file_modtime;
339 Lisp_Object Qset_visited_file_modtime;
341 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
342 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
343 Otherwise, return nil.
344 A file name is handled if one of the regular expressions in
345 `file-name-handler-alist' matches it.
347 If OPERATION equals `inhibit-file-name-operation', then we ignore
348 any handlers that are members of `inhibit-file-name-handlers',
349 but we still do run any other handlers. This lets handlers
350 use the standard functions without calling themselves recursively. */)
351 (filename, operation)
352 Lisp_Object filename, operation;
354 /* This function must not munge the match data. */
355 Lisp_Object chain, inhibited_handlers, result;
356 int pos = -1;
358 result = Qnil;
359 CHECK_STRING (filename);
361 if (EQ (operation, Vinhibit_file_name_operation))
362 inhibited_handlers = Vinhibit_file_name_handlers;
363 else
364 inhibited_handlers = Qnil;
366 for (chain = Vfile_name_handler_alist; CONSP (chain);
367 chain = XCDR (chain))
369 Lisp_Object elt;
370 elt = XCAR (chain);
371 if (CONSP (elt))
373 Lisp_Object string = XCAR (elt);
374 int match_pos;
375 Lisp_Object handler = XCDR (elt);
376 Lisp_Object operations = Qnil;
378 if (SYMBOLP (handler))
379 operations = Fget (handler, Qoperations);
381 if (STRINGP (string)
382 && (match_pos = fast_string_match (string, filename)) > pos
383 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
385 Lisp_Object tem;
387 handler = XCDR (elt);
388 tem = Fmemq (handler, inhibited_handlers);
389 if (NILP (tem))
391 result = handler;
392 pos = match_pos;
397 QUIT;
399 return result;
402 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
403 1, 1, 0,
404 doc: /* Return the directory component in file name FILENAME.
405 Return nil if FILENAME does not include a directory.
406 Otherwise return a directory spec.
407 Given a Unix syntax file name, returns a string ending in slash;
408 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
409 (filename)
410 Lisp_Object filename;
412 #ifndef DOS_NT
413 register const unsigned char *beg;
414 #else
415 register unsigned char *beg;
416 #endif
417 register const unsigned char *p;
418 Lisp_Object handler;
420 CHECK_STRING (filename);
422 /* If the file name has special constructs in it,
423 call the corresponding file handler. */
424 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
425 if (!NILP (handler))
426 return call2 (handler, Qfile_name_directory, filename);
428 filename = FILE_SYSTEM_CASE (filename);
429 beg = SDATA (filename);
430 #ifdef DOS_NT
431 beg = strcpy (alloca (strlen (beg) + 1), beg);
432 #endif
433 p = beg + SBYTES (filename);
435 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
436 #ifdef VMS
437 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
438 #endif /* VMS */
439 #ifdef DOS_NT
440 /* only recognise drive specifier at the beginning */
441 && !(p[-1] == ':'
442 /* handle the "/:d:foo" and "/:foo" cases correctly */
443 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
444 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
445 #endif
446 ) p--;
448 if (p == beg)
449 return Qnil;
450 #ifdef DOS_NT
451 /* Expansion of "c:" to drive and default directory. */
452 if (p[-1] == ':')
454 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
455 unsigned char *res = alloca (MAXPATHLEN + 1);
456 unsigned char *r = res;
458 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
460 strncpy (res, beg, 2);
461 beg += 2;
462 r += 2;
465 if (getdefdir (toupper (*beg) - 'A' + 1, r))
467 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
468 strcat (res, "/");
469 beg = res;
470 p = beg + strlen (beg);
473 CORRECT_DIR_SEPS (beg);
474 #endif /* DOS_NT */
476 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
479 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
480 Sfile_name_nondirectory, 1, 1, 0,
481 doc: /* Return file name FILENAME sans its directory.
482 For example, in a Unix-syntax file name,
483 this is everything after the last slash,
484 or the entire name if it contains no slash. */)
485 (filename)
486 Lisp_Object filename;
488 register const unsigned char *beg, *p, *end;
489 Lisp_Object handler;
491 CHECK_STRING (filename);
493 /* If the file name has special constructs in it,
494 call the corresponding file handler. */
495 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
496 if (!NILP (handler))
497 return call2 (handler, Qfile_name_nondirectory, filename);
499 beg = SDATA (filename);
500 end = p = beg + SBYTES (filename);
502 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
503 #ifdef VMS
504 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
505 #endif /* VMS */
506 #ifdef DOS_NT
507 /* only recognise drive specifier at beginning */
508 && !(p[-1] == ':'
509 /* handle the "/:d:foo" case correctly */
510 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
511 #endif
513 p--;
515 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
518 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
519 Sunhandled_file_name_directory, 1, 1, 0,
520 doc: /* Return a directly usable directory name somehow associated with FILENAME.
521 A `directly usable' directory name is one that may be used without the
522 intervention of any file handler.
523 If FILENAME is a directly usable file itself, return
524 \(file-name-directory FILENAME).
525 The `call-process' and `start-process' functions use this function to
526 get a current directory to run processes in. */)
527 (filename)
528 Lisp_Object filename;
530 Lisp_Object handler;
532 /* If the file name has special constructs in it,
533 call the corresponding file handler. */
534 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
535 if (!NILP (handler))
536 return call2 (handler, Qunhandled_file_name_directory, filename);
538 return Ffile_name_directory (filename);
542 char *
543 file_name_as_directory (out, in)
544 char *out, *in;
546 int size = strlen (in) - 1;
548 strcpy (out, in);
550 if (size < 0)
552 out[0] = '.';
553 out[1] = '/';
554 out[2] = 0;
555 return out;
558 #ifdef VMS
559 /* Is it already a directory string? */
560 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
561 return out;
562 /* Is it a VMS directory file name? If so, hack VMS syntax. */
563 else if (! index (in, '/')
564 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
565 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
566 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
567 || ! strncmp (&in[size - 5], ".dir", 4))
568 && (in[size - 1] == '.' || in[size - 1] == ';')
569 && in[size] == '1')))
571 register char *p, *dot;
572 char brack;
574 /* x.dir -> [.x]
575 dir:x.dir --> dir:[x]
576 dir:[x]y.dir --> dir:[x.y] */
577 p = in + size;
578 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
579 if (p != in)
581 strncpy (out, in, p - in);
582 out[p - in] = '\0';
583 if (*p == ':')
585 brack = ']';
586 strcat (out, ":[");
588 else
590 brack = *p;
591 strcat (out, ".");
593 p++;
595 else
597 brack = ']';
598 strcpy (out, "[.");
600 dot = index (p, '.');
601 if (dot)
603 /* blindly remove any extension */
604 size = strlen (out) + (dot - p);
605 strncat (out, p, dot - p);
607 else
609 strcat (out, p);
610 size = strlen (out);
612 out[size++] = brack;
613 out[size] = '\0';
615 #else /* not VMS */
616 /* For Unix syntax, Append a slash if necessary */
617 if (!IS_DIRECTORY_SEP (out[size]))
619 /* Cannot use DIRECTORY_SEP, which could have any value */
620 out[size + 1] = '/';
621 out[size + 2] = '\0';
623 #ifdef DOS_NT
624 CORRECT_DIR_SEPS (out);
625 #endif
626 #endif /* not VMS */
627 return out;
630 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
631 Sfile_name_as_directory, 1, 1, 0,
632 doc: /* Return a string representing the file name FILE interpreted as a directory.
633 This operation exists because a directory is also a file, but its name as
634 a directory is different from its name as a file.
635 The result can be used as the value of `default-directory'
636 or passed as second argument to `expand-file-name'.
637 For a Unix-syntax file name, just appends a slash.
638 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
639 (file)
640 Lisp_Object file;
642 char *buf;
643 Lisp_Object handler;
645 CHECK_STRING (file);
646 if (NILP (file))
647 return Qnil;
649 /* If the file name has special constructs in it,
650 call the corresponding file handler. */
651 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
652 if (!NILP (handler))
653 return call2 (handler, Qfile_name_as_directory, file);
655 buf = (char *) alloca (SBYTES (file) + 10);
656 file_name_as_directory (buf, SDATA (file));
657 return make_specified_string (buf, -1, strlen (buf),
658 STRING_MULTIBYTE (file));
662 * Convert from directory name to filename.
663 * On VMS:
664 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
665 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
666 * On UNIX, it's simple: just make sure there isn't a terminating /
668 * Value is nonzero if the string output is different from the input.
672 directory_file_name (src, dst)
673 char *src, *dst;
675 long slen;
676 #ifdef VMS
677 long rlen;
678 char * ptr, * rptr;
679 char bracket;
680 struct FAB fab = cc$rms_fab;
681 struct NAM nam = cc$rms_nam;
682 char esa[NAM$C_MAXRSS];
683 #endif /* VMS */
685 slen = strlen (src);
686 #ifdef VMS
687 if (! index (src, '/')
688 && (src[slen - 1] == ']'
689 || src[slen - 1] == ':'
690 || src[slen - 1] == '>'))
692 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
693 fab.fab$l_fna = src;
694 fab.fab$b_fns = slen;
695 fab.fab$l_nam = &nam;
696 fab.fab$l_fop = FAB$M_NAM;
698 nam.nam$l_esa = esa;
699 nam.nam$b_ess = sizeof esa;
700 nam.nam$b_nop |= NAM$M_SYNCHK;
702 /* We call SYS$PARSE to handle such things as [--] for us. */
703 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
705 slen = nam.nam$b_esl;
706 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
707 slen -= 2;
708 esa[slen] = '\0';
709 src = esa;
711 if (src[slen - 1] != ']' && src[slen - 1] != '>')
713 /* what about when we have logical_name:???? */
714 if (src[slen - 1] == ':')
715 { /* Xlate logical name and see what we get */
716 ptr = strcpy (dst, src); /* upper case for getenv */
717 while (*ptr)
719 if ('a' <= *ptr && *ptr <= 'z')
720 *ptr -= 040;
721 ptr++;
723 dst[slen - 1] = 0; /* remove colon */
724 if (!(src = egetenv (dst)))
725 return 0;
726 /* should we jump to the beginning of this procedure?
727 Good points: allows us to use logical names that xlate
728 to Unix names,
729 Bad points: can be a problem if we just translated to a device
730 name...
731 For now, I'll punt and always expect VMS names, and hope for
732 the best! */
733 slen = strlen (src);
734 if (src[slen - 1] != ']' && src[slen - 1] != '>')
735 { /* no recursion here! */
736 strcpy (dst, src);
737 return 0;
740 else
741 { /* not a directory spec */
742 strcpy (dst, src);
743 return 0;
746 bracket = src[slen - 1];
748 /* If bracket is ']' or '>', bracket - 2 is the corresponding
749 opening bracket. */
750 ptr = index (src, bracket - 2);
751 if (ptr == 0)
752 { /* no opening bracket */
753 strcpy (dst, src);
754 return 0;
756 if (!(rptr = rindex (src, '.')))
757 rptr = ptr;
758 slen = rptr - src;
759 strncpy (dst, src, slen);
760 dst[slen] = '\0';
761 if (*rptr == '.')
763 dst[slen++] = bracket;
764 dst[slen] = '\0';
766 else
768 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
769 then translate the device and recurse. */
770 if (dst[slen - 1] == ':'
771 && dst[slen - 2] != ':' /* skip decnet nodes */
772 && strcmp (src + slen, "[000000]") == 0)
774 dst[slen - 1] = '\0';
775 if ((ptr = egetenv (dst))
776 && (rlen = strlen (ptr) - 1) > 0
777 && (ptr[rlen] == ']' || ptr[rlen] == '>')
778 && ptr[rlen - 1] == '.')
780 char * buf = (char *) alloca (strlen (ptr) + 1);
781 strcpy (buf, ptr);
782 buf[rlen - 1] = ']';
783 buf[rlen] = '\0';
784 return directory_file_name (buf, dst);
786 else
787 dst[slen - 1] = ':';
789 strcat (dst, "[000000]");
790 slen += 8;
792 rptr++;
793 rlen = strlen (rptr) - 1;
794 strncat (dst, rptr, rlen);
795 dst[slen + rlen] = '\0';
796 strcat (dst, ".DIR.1");
797 return 1;
799 #endif /* VMS */
800 /* Process as Unix format: just remove any final slash.
801 But leave "/" unchanged; do not change it to "". */
802 strcpy (dst, src);
803 #ifdef APOLLO
804 /* Handle // as root for apollo's. */
805 if ((slen > 2 && dst[slen - 1] == '/')
806 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
807 dst[slen - 1] = 0;
808 #else
809 if (slen > 1
810 && IS_DIRECTORY_SEP (dst[slen - 1])
811 #ifdef DOS_NT
812 && !IS_ANY_SEP (dst[slen - 2])
813 #endif
815 dst[slen - 1] = 0;
816 #endif
817 #ifdef DOS_NT
818 CORRECT_DIR_SEPS (dst);
819 #endif
820 return 1;
823 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
824 1, 1, 0,
825 doc: /* Returns the file name of the directory named DIRECTORY.
826 This is the name of the file that holds the data for the directory DIRECTORY.
827 This operation exists because a directory is also a file, but its name as
828 a directory is different from its name as a file.
829 In Unix-syntax, this function just removes the final slash.
830 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
831 it returns a file name such as \"[X]Y.DIR.1\". */)
832 (directory)
833 Lisp_Object directory;
835 char *buf;
836 Lisp_Object handler;
838 CHECK_STRING (directory);
840 if (NILP (directory))
841 return Qnil;
843 /* If the file name has special constructs in it,
844 call the corresponding file handler. */
845 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
846 if (!NILP (handler))
847 return call2 (handler, Qdirectory_file_name, directory);
849 #ifdef VMS
850 /* 20 extra chars is insufficient for VMS, since we might perform a
851 logical name translation. an equivalence string can be up to 255
852 chars long, so grab that much extra space... - sss */
853 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
854 #else
855 buf = (char *) alloca (SBYTES (directory) + 20);
856 #endif
857 directory_file_name (SDATA (directory), buf);
858 return make_specified_string (buf, -1, strlen (buf),
859 STRING_MULTIBYTE (directory));
862 static char make_temp_name_tbl[64] =
864 'A','B','C','D','E','F','G','H',
865 'I','J','K','L','M','N','O','P',
866 'Q','R','S','T','U','V','W','X',
867 'Y','Z','a','b','c','d','e','f',
868 'g','h','i','j','k','l','m','n',
869 'o','p','q','r','s','t','u','v',
870 'w','x','y','z','0','1','2','3',
871 '4','5','6','7','8','9','-','_'
874 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
876 /* Value is a temporary file name starting with PREFIX, a string.
878 The Emacs process number forms part of the result, so there is
879 no danger of generating a name being used by another process.
880 In addition, this function makes an attempt to choose a name
881 which has no existing file. To make this work, PREFIX should be
882 an absolute file name.
884 BASE64_P non-zero means add the pid as 3 characters in base64
885 encoding. In this case, 6 characters will be added to PREFIX to
886 form the file name. Otherwise, if Emacs is running on a system
887 with long file names, add the pid as a decimal number.
889 This function signals an error if no unique file name could be
890 generated. */
892 Lisp_Object
893 make_temp_name (prefix, base64_p)
894 Lisp_Object prefix;
895 int base64_p;
897 Lisp_Object val;
898 int len, clen;
899 int pid;
900 unsigned char *p, *data;
901 char pidbuf[20];
902 int pidlen;
904 CHECK_STRING (prefix);
906 /* VAL is created by adding 6 characters to PREFIX. The first
907 three are the PID of this process, in base 64, and the second
908 three are incremented if the file already exists. This ensures
909 262144 unique file names per PID per PREFIX. */
911 pid = (int) getpid ();
913 if (base64_p)
915 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
916 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
917 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
918 pidlen = 3;
920 else
922 #ifdef HAVE_LONG_FILE_NAMES
923 sprintf (pidbuf, "%d", pid);
924 pidlen = strlen (pidbuf);
925 #else
926 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
927 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
928 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
929 pidlen = 3;
930 #endif
933 len = SBYTES (prefix); clen = SCHARS (prefix);
934 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
935 if (!STRING_MULTIBYTE (prefix))
936 STRING_SET_UNIBYTE (val);
937 data = SDATA (val);
938 bcopy(SDATA (prefix), data, len);
939 p = data + len;
941 bcopy (pidbuf, p, pidlen);
942 p += pidlen;
944 /* Here we try to minimize useless stat'ing when this function is
945 invoked many times successively with the same PREFIX. We achieve
946 this by initializing count to a random value, and incrementing it
947 afterwards.
949 We don't want make-temp-name to be called while dumping,
950 because then make_temp_name_count_initialized_p would get set
951 and then make_temp_name_count would not be set when Emacs starts. */
953 if (!make_temp_name_count_initialized_p)
955 make_temp_name_count = (unsigned) time (NULL);
956 make_temp_name_count_initialized_p = 1;
959 while (1)
961 struct stat ignored;
962 unsigned num = make_temp_name_count;
964 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
965 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
966 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
968 /* Poor man's congruential RN generator. Replace with
969 ++make_temp_name_count for debugging. */
970 make_temp_name_count += 25229;
971 make_temp_name_count %= 225307;
973 if (stat (data, &ignored) < 0)
975 /* We want to return only if errno is ENOENT. */
976 if (errno == ENOENT)
977 return val;
978 else
979 /* The error here is dubious, but there is little else we
980 can do. The alternatives are to return nil, which is
981 as bad as (and in many cases worse than) throwing the
982 error, or to ignore the error, which will likely result
983 in looping through 225307 stat's, which is not only
984 dog-slow, but also useless since it will fallback to
985 the errow below, anyway. */
986 report_file_error ("Cannot create temporary name for prefix",
987 Fcons (prefix, Qnil));
988 /* not reached */
992 error ("Cannot create temporary name for prefix `%s'",
993 SDATA (prefix));
994 return Qnil;
998 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
999 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1000 The Emacs process number forms part of the result,
1001 so there is no danger of generating a name being used by another process.
1003 In addition, this function makes an attempt to choose a name
1004 which has no existing file. To make this work,
1005 PREFIX should be an absolute file name.
1007 There is a race condition between calling `make-temp-name' and creating the
1008 file which opens all kinds of security holes. For that reason, you should
1009 probably use `make-temp-file' instead, except in three circumstances:
1011 * If you are creating the file in the user's home directory.
1012 * If you are creating a directory rather than an ordinary file.
1013 * If you are taking special precautions as `make-temp-file' does. */)
1014 (prefix)
1015 Lisp_Object prefix;
1017 return make_temp_name (prefix, 0);
1022 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1023 doc: /* Convert filename NAME to absolute, and canonicalize it.
1024 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1025 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1026 the current buffer's value of `default-directory' is used.
1027 File name components that are `.' are removed, and
1028 so are file name components followed by `..', along with the `..' itself;
1029 note that these simplifications are done without checking the resulting
1030 file names in the file system.
1031 An initial `~/' expands to your home directory.
1032 An initial `~USER/' expands to USER's home directory.
1033 See also the function `substitute-in-file-name'. */)
1034 (name, default_directory)
1035 Lisp_Object name, default_directory;
1037 unsigned char *nm;
1039 register unsigned char *newdir, *p, *o;
1040 int tlen;
1041 unsigned char *target;
1042 struct passwd *pw;
1043 #ifdef VMS
1044 unsigned char * colon = 0;
1045 unsigned char * close = 0;
1046 unsigned char * slash = 0;
1047 unsigned char * brack = 0;
1048 int lbrack = 0, rbrack = 0;
1049 int dots = 0;
1050 #endif /* VMS */
1051 #ifdef DOS_NT
1052 int drive = 0;
1053 int collapse_newdir = 1;
1054 int is_escaped = 0;
1055 #endif /* DOS_NT */
1056 int length;
1057 Lisp_Object handler, result;
1059 CHECK_STRING (name);
1061 /* If the file name has special constructs in it,
1062 call the corresponding file handler. */
1063 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1064 if (!NILP (handler))
1065 return call3 (handler, Qexpand_file_name, name, default_directory);
1067 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1068 if (NILP (default_directory))
1069 default_directory = current_buffer->directory;
1070 if (! STRINGP (default_directory))
1072 #ifdef DOS_NT
1073 /* "/" is not considered a root directory on DOS_NT, so using "/"
1074 here causes an infinite recursion in, e.g., the following:
1076 (let (default-directory)
1077 (expand-file-name "a"))
1079 To avoid this, we set default_directory to the root of the
1080 current drive. */
1081 extern char *emacs_root_dir (void);
1083 default_directory = build_string (emacs_root_dir ());
1084 #else
1085 default_directory = build_string ("/");
1086 #endif
1089 if (!NILP (default_directory))
1091 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1092 if (!NILP (handler))
1093 return call3 (handler, Qexpand_file_name, name, default_directory);
1096 o = SDATA (default_directory);
1098 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1099 It would be better to do this down below where we actually use
1100 default_directory. Unfortunately, calling Fexpand_file_name recursively
1101 could invoke GC, and the strings might be relocated. This would
1102 be annoying because we have pointers into strings lying around
1103 that would need adjusting, and people would add new pointers to
1104 the code and forget to adjust them, resulting in intermittent bugs.
1105 Putting this call here avoids all that crud.
1107 The EQ test avoids infinite recursion. */
1108 if (! NILP (default_directory) && !EQ (default_directory, name)
1109 /* Save time in some common cases - as long as default_directory
1110 is not relative, it can be canonicalized with name below (if it
1111 is needed at all) without requiring it to be expanded now. */
1112 #ifdef DOS_NT
1113 /* Detect MSDOS file names with drive specifiers. */
1114 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1115 #ifdef WINDOWSNT
1116 /* Detect Windows file names in UNC format. */
1117 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1118 #endif
1119 #else /* not DOS_NT */
1120 /* Detect Unix absolute file names (/... alone is not absolute on
1121 DOS or Windows). */
1122 && ! (IS_DIRECTORY_SEP (o[0]))
1123 #endif /* not DOS_NT */
1126 struct gcpro gcpro1;
1128 GCPRO1 (name);
1129 default_directory = Fexpand_file_name (default_directory, Qnil);
1130 UNGCPRO;
1133 name = FILE_SYSTEM_CASE (name);
1134 nm = SDATA (name);
1136 #ifdef DOS_NT
1137 /* We will force directory separators to be either all \ or /, so make
1138 a local copy to modify, even if there ends up being no change. */
1139 nm = strcpy (alloca (strlen (nm) + 1), nm);
1141 /* Note if special escape prefix is present, but remove for now. */
1142 if (nm[0] == '/' && nm[1] == ':')
1144 is_escaped = 1;
1145 nm += 2;
1148 /* Find and remove drive specifier if present; this makes nm absolute
1149 even if the rest of the name appears to be relative. Only look for
1150 drive specifier at the beginning. */
1151 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1153 drive = nm[0];
1154 nm += 2;
1157 #ifdef WINDOWSNT
1158 /* If we see "c://somedir", we want to strip the first slash after the
1159 colon when stripping the drive letter. Otherwise, this expands to
1160 "//somedir". */
1161 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1162 nm++;
1163 #endif /* WINDOWSNT */
1164 #endif /* DOS_NT */
1166 #ifdef WINDOWSNT
1167 /* Discard any previous drive specifier if nm is now in UNC format. */
1168 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1170 drive = 0;
1172 #endif
1174 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1175 none are found, we can probably return right away. We will avoid
1176 allocating a new string if name is already fully expanded. */
1177 if (
1178 IS_DIRECTORY_SEP (nm[0])
1179 #ifdef MSDOS
1180 && drive && !is_escaped
1181 #endif
1182 #ifdef WINDOWSNT
1183 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1184 #endif
1185 #ifdef VMS
1186 || index (nm, ':')
1187 #endif /* VMS */
1190 /* If it turns out that the filename we want to return is just a
1191 suffix of FILENAME, we don't need to go through and edit
1192 things; we just need to construct a new string using data
1193 starting at the middle of FILENAME. If we set lose to a
1194 non-zero value, that means we've discovered that we can't do
1195 that cool trick. */
1196 int lose = 0;
1198 p = nm;
1199 while (*p)
1201 /* Since we know the name is absolute, we can assume that each
1202 element starts with a "/". */
1204 /* "." and ".." are hairy. */
1205 if (IS_DIRECTORY_SEP (p[0])
1206 && p[1] == '.'
1207 && (IS_DIRECTORY_SEP (p[2])
1208 || p[2] == 0
1209 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1210 || p[3] == 0))))
1211 lose = 1;
1212 /* We want to replace multiple `/' in a row with a single
1213 slash. */
1214 else if (p > nm
1215 && IS_DIRECTORY_SEP (p[0])
1216 && IS_DIRECTORY_SEP (p[1]))
1217 lose = 1;
1219 #ifdef VMS
1220 if (p[0] == '\\')
1221 lose = 1;
1222 if (p[0] == '/') {
1223 /* if dev:[dir]/, move nm to / */
1224 if (!slash && p > nm && (brack || colon)) {
1225 nm = (brack ? brack + 1 : colon + 1);
1226 lbrack = rbrack = 0;
1227 brack = 0;
1228 colon = 0;
1230 slash = p;
1232 if (p[0] == '-')
1233 #ifdef NO_HYPHENS_IN_FILENAMES
1234 if (lbrack == rbrack)
1236 /* Avoid clobbering negative version numbers. */
1237 if (dots < 2)
1238 p[0] = '_';
1240 else
1241 #endif /* NO_HYPHENS_IN_FILENAMES */
1242 if (lbrack > rbrack &&
1243 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1244 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1245 lose = 1;
1246 #ifdef NO_HYPHENS_IN_FILENAMES
1247 else
1248 p[0] = '_';
1249 #endif /* NO_HYPHENS_IN_FILENAMES */
1250 /* count open brackets, reset close bracket pointer */
1251 if (p[0] == '[' || p[0] == '<')
1252 lbrack++, brack = 0;
1253 /* count close brackets, set close bracket pointer */
1254 if (p[0] == ']' || p[0] == '>')
1255 rbrack++, brack = p;
1256 /* detect ][ or >< */
1257 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1258 lose = 1;
1259 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1260 nm = p + 1, lose = 1;
1261 if (p[0] == ':' && (colon || slash))
1262 /* if dev1:[dir]dev2:, move nm to dev2: */
1263 if (brack)
1265 nm = brack + 1;
1266 brack = 0;
1268 /* if /name/dev:, move nm to dev: */
1269 else if (slash)
1270 nm = slash + 1;
1271 /* if node::dev:, move colon following dev */
1272 else if (colon && colon[-1] == ':')
1273 colon = p;
1274 /* if dev1:dev2:, move nm to dev2: */
1275 else if (colon && colon[-1] != ':')
1277 nm = colon + 1;
1278 colon = 0;
1280 if (p[0] == ':' && !colon)
1282 if (p[1] == ':')
1283 p++;
1284 colon = p;
1286 if (lbrack == rbrack)
1287 if (p[0] == ';')
1288 dots = 2;
1289 else if (p[0] == '.')
1290 dots++;
1291 #endif /* VMS */
1292 p++;
1294 if (!lose)
1296 #ifdef VMS
1297 if (index (nm, '/'))
1299 nm = sys_translate_unix (nm);
1300 return make_specified_string (nm, -1, strlen (nm),
1301 STRING_MULTIBYTE (name));
1303 #endif /* VMS */
1304 #ifdef DOS_NT
1305 /* Make sure directories are all separated with / or \ as
1306 desired, but avoid allocation of a new string when not
1307 required. */
1308 CORRECT_DIR_SEPS (nm);
1309 #ifdef WINDOWSNT
1310 if (IS_DIRECTORY_SEP (nm[1]))
1312 if (strcmp (nm, SDATA (name)) != 0)
1313 name = make_specified_string (nm, -1, strlen (nm),
1314 STRING_MULTIBYTE (name));
1316 else
1317 #endif
1318 /* drive must be set, so this is okay */
1319 if (strcmp (nm - 2, SDATA (name)) != 0)
1321 char temp[] = " :";
1323 name = make_specified_string (nm, -1, p - nm,
1324 STRING_MULTIBYTE (name));
1325 temp[0] = DRIVE_LETTER (drive);
1326 name = concat2 (build_string (temp), name);
1328 return name;
1329 #else /* not DOS_NT */
1330 if (nm == SDATA (name))
1331 return name;
1332 return make_specified_string (nm, -1, strlen (nm),
1333 STRING_MULTIBYTE (name));
1334 #endif /* not DOS_NT */
1338 /* At this point, nm might or might not be an absolute file name. We
1339 need to expand ~ or ~user if present, otherwise prefix nm with
1340 default_directory if nm is not absolute, and finally collapse /./
1341 and /foo/../ sequences.
1343 We set newdir to be the appropriate prefix if one is needed:
1344 - the relevant user directory if nm starts with ~ or ~user
1345 - the specified drive's working dir (DOS/NT only) if nm does not
1346 start with /
1347 - the value of default_directory.
1349 Note that these prefixes are not guaranteed to be absolute (except
1350 for the working dir of a drive). Therefore, to ensure we always
1351 return an absolute name, if the final prefix is not absolute we
1352 append it to the current working directory. */
1354 newdir = 0;
1356 if (nm[0] == '~') /* prefix ~ */
1358 if (IS_DIRECTORY_SEP (nm[1])
1359 #ifdef VMS
1360 || nm[1] == ':'
1361 #endif /* VMS */
1362 || nm[1] == 0) /* ~ by itself */
1364 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1365 newdir = (unsigned char *) "";
1366 nm++;
1367 #ifdef DOS_NT
1368 collapse_newdir = 0;
1369 #endif
1370 #ifdef VMS
1371 nm++; /* Don't leave the slash in nm. */
1372 #endif /* VMS */
1374 else /* ~user/filename */
1376 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1377 #ifdef VMS
1378 && *p != ':'
1379 #endif /* VMS */
1380 ); p++);
1381 o = (unsigned char *) alloca (p - nm + 1);
1382 bcopy ((char *) nm, o, p - nm);
1383 o [p - nm] = 0;
1385 pw = (struct passwd *) getpwnam (o + 1);
1386 if (pw)
1388 newdir = (unsigned char *) pw -> pw_dir;
1389 #ifdef VMS
1390 nm = p + 1; /* skip the terminator */
1391 #else
1392 nm = p;
1393 #ifdef DOS_NT
1394 collapse_newdir = 0;
1395 #endif
1396 #endif /* VMS */
1399 /* If we don't find a user of that name, leave the name
1400 unchanged; don't move nm forward to p. */
1404 #ifdef DOS_NT
1405 /* On DOS and Windows, nm is absolute if a drive name was specified;
1406 use the drive's current directory as the prefix if needed. */
1407 if (!newdir && drive)
1409 /* Get default directory if needed to make nm absolute. */
1410 if (!IS_DIRECTORY_SEP (nm[0]))
1412 newdir = alloca (MAXPATHLEN + 1);
1413 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1414 newdir = NULL;
1416 if (!newdir)
1418 /* Either nm starts with /, or drive isn't mounted. */
1419 newdir = alloca (4);
1420 newdir[0] = DRIVE_LETTER (drive);
1421 newdir[1] = ':';
1422 newdir[2] = '/';
1423 newdir[3] = 0;
1426 #endif /* DOS_NT */
1428 /* Finally, if no prefix has been specified and nm is not absolute,
1429 then it must be expanded relative to default_directory. */
1431 if (1
1432 #ifndef DOS_NT
1433 /* /... alone is not absolute on DOS and Windows. */
1434 && !IS_DIRECTORY_SEP (nm[0])
1435 #endif
1436 #ifdef WINDOWSNT
1437 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1438 #endif
1439 #ifdef VMS
1440 && !index (nm, ':')
1441 #endif
1442 && !newdir)
1444 newdir = SDATA (default_directory);
1445 #ifdef DOS_NT
1446 /* Note if special escape prefix is present, but remove for now. */
1447 if (newdir[0] == '/' && newdir[1] == ':')
1449 is_escaped = 1;
1450 newdir += 2;
1452 #endif
1455 #ifdef DOS_NT
1456 if (newdir)
1458 /* First ensure newdir is an absolute name. */
1459 if (
1460 /* Detect MSDOS file names with drive specifiers. */
1461 ! (IS_DRIVE (newdir[0])
1462 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1463 #ifdef WINDOWSNT
1464 /* Detect Windows file names in UNC format. */
1465 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1466 #endif
1469 /* Effectively, let newdir be (expand-file-name newdir cwd).
1470 Because of the admonition against calling expand-file-name
1471 when we have pointers into lisp strings, we accomplish this
1472 indirectly by prepending newdir to nm if necessary, and using
1473 cwd (or the wd of newdir's drive) as the new newdir. */
1475 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1477 drive = newdir[0];
1478 newdir += 2;
1480 if (!IS_DIRECTORY_SEP (nm[0]))
1482 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1483 file_name_as_directory (tmp, newdir);
1484 strcat (tmp, nm);
1485 nm = tmp;
1487 newdir = alloca (MAXPATHLEN + 1);
1488 if (drive)
1490 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1491 newdir = "/";
1493 else
1494 getwd (newdir);
1497 /* Strip off drive name from prefix, if present. */
1498 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1500 drive = newdir[0];
1501 newdir += 2;
1504 /* Keep only a prefix from newdir if nm starts with slash
1505 (//server/share for UNC, nothing otherwise). */
1506 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1508 #ifdef WINDOWSNT
1509 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1511 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1512 p = newdir + 2;
1513 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1514 p++;
1515 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1516 *p = 0;
1518 else
1519 #endif
1520 newdir = "";
1523 #endif /* DOS_NT */
1525 if (newdir)
1527 /* Get rid of any slash at the end of newdir, unless newdir is
1528 just / or // (an incomplete UNC name). */
1529 length = strlen (newdir);
1530 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1531 #ifdef WINDOWSNT
1532 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1533 #endif
1536 unsigned char *temp = (unsigned char *) alloca (length);
1537 bcopy (newdir, temp, length - 1);
1538 temp[length - 1] = 0;
1539 newdir = temp;
1541 tlen = length + 1;
1543 else
1544 tlen = 0;
1546 /* Now concatenate the directory and name to new space in the stack frame */
1547 tlen += strlen (nm) + 1;
1548 #ifdef DOS_NT
1549 /* Reserve space for drive specifier and escape prefix, since either
1550 or both may need to be inserted. (The Microsoft x86 compiler
1551 produces incorrect code if the following two lines are combined.) */
1552 target = (unsigned char *) alloca (tlen + 4);
1553 target += 4;
1554 #else /* not DOS_NT */
1555 target = (unsigned char *) alloca (tlen);
1556 #endif /* not DOS_NT */
1557 *target = 0;
1559 if (newdir)
1561 #ifndef VMS
1562 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1564 #ifdef DOS_NT
1565 /* If newdir is effectively "C:/", then the drive letter will have
1566 been stripped and newdir will be "/". Concatenating with an
1567 absolute directory in nm produces "//", which will then be
1568 incorrectly treated as a network share. Ignore newdir in
1569 this case (keeping the drive letter). */
1570 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1571 && newdir[1] == '\0'))
1572 #endif
1573 strcpy (target, newdir);
1575 else
1576 #endif
1577 file_name_as_directory (target, newdir);
1580 strcat (target, nm);
1581 #ifdef VMS
1582 if (index (target, '/'))
1583 strcpy (target, sys_translate_unix (target));
1584 #endif /* VMS */
1586 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1588 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1589 appear. */
1591 p = target;
1592 o = target;
1594 while (*p)
1596 #ifdef VMS
1597 if (*p != ']' && *p != '>' && *p != '-')
1599 if (*p == '\\')
1600 p++;
1601 *o++ = *p++;
1603 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1604 /* brackets are offset from each other by 2 */
1606 p += 2;
1607 if (*p != '.' && *p != '-' && o[-1] != '.')
1608 /* convert [foo][bar] to [bar] */
1609 while (o[-1] != '[' && o[-1] != '<')
1610 o--;
1611 else if (*p == '-' && *o != '.')
1612 *--p = '.';
1614 else if (p[0] == '-' && o[-1] == '.' &&
1615 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1616 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1619 o--;
1620 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1621 if (p[1] == '.') /* foo.-.bar ==> bar. */
1622 p += 2;
1623 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1624 p++, o--;
1625 /* else [foo.-] ==> [-] */
1627 else
1629 #ifdef NO_HYPHENS_IN_FILENAMES
1630 if (*p == '-' &&
1631 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1632 p[1] != ']' && p[1] != '>' && p[1] != '.')
1633 *p = '_';
1634 #endif /* NO_HYPHENS_IN_FILENAMES */
1635 *o++ = *p++;
1637 #else /* not VMS */
1638 if (!IS_DIRECTORY_SEP (*p))
1640 *o++ = *p++;
1642 else if (IS_DIRECTORY_SEP (p[0])
1643 && p[1] == '.'
1644 && (IS_DIRECTORY_SEP (p[2])
1645 || p[2] == 0))
1647 /* If "/." is the entire filename, keep the "/". Otherwise,
1648 just delete the whole "/.". */
1649 if (o == target && p[2] == '\0')
1650 *o++ = *p;
1651 p += 2;
1653 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1654 /* `/../' is the "superroot" on certain file systems.
1655 Turned off on DOS_NT systems because they have no
1656 "superroot" and because this causes us to produce
1657 file names like "d:/../foo" which fail file-related
1658 functions of the underlying OS. (To reproduce, try a
1659 long series of "../../" in default_directory, longer
1660 than the number of levels from the root.) */
1661 #ifndef DOS_NT
1662 && o != target
1663 #endif
1664 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1666 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1668 /* Keep initial / only if this is the whole name. */
1669 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1670 ++o;
1671 p += 3;
1673 else if (p > target
1674 && IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1]))
1676 /* Collapse multiple `/' in a row. */
1677 *o++ = *p++;
1678 while (IS_DIRECTORY_SEP (*p))
1679 ++p;
1681 else
1683 *o++ = *p++;
1685 #endif /* not VMS */
1688 #ifdef DOS_NT
1689 /* At last, set drive name. */
1690 #ifdef WINDOWSNT
1691 /* Except for network file name. */
1692 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1693 #endif /* WINDOWSNT */
1695 if (!drive) abort ();
1696 target -= 2;
1697 target[0] = DRIVE_LETTER (drive);
1698 target[1] = ':';
1700 /* Reinsert the escape prefix if required. */
1701 if (is_escaped)
1703 target -= 2;
1704 target[0] = '/';
1705 target[1] = ':';
1707 CORRECT_DIR_SEPS (target);
1708 #endif /* DOS_NT */
1710 result = make_specified_string (target, -1, o - target,
1711 STRING_MULTIBYTE (name));
1713 /* Again look to see if the file name has special constructs in it
1714 and perhaps call the corresponding file handler. This is needed
1715 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1716 the ".." component gives us "/user@host:/bar/../baz" which needs
1717 to be expanded again. */
1718 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1719 if (!NILP (handler))
1720 return call3 (handler, Qexpand_file_name, result, default_directory);
1722 return result;
1725 #if 0
1726 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1727 This is the old version of expand-file-name, before it was thoroughly
1728 rewritten for Emacs 10.31. We leave this version here commented-out,
1729 because the code is very complex and likely to have subtle bugs. If
1730 bugs _are_ found, it might be of interest to look at the old code and
1731 see what did it do in the relevant situation.
1733 Don't remove this code: it's true that it will be accessible via CVS,
1734 but a few years from deletion, people will forget it is there. */
1736 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1737 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1738 "Convert FILENAME to absolute, and canonicalize it.\n\
1739 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1740 \(does not start with slash); if DEFAULT is nil or missing,\n\
1741 the current buffer's value of default-directory is used.\n\
1742 Filenames containing `.' or `..' as components are simplified;\n\
1743 initial `~/' expands to your home directory.\n\
1744 See also the function `substitute-in-file-name'.")
1745 (name, defalt)
1746 Lisp_Object name, defalt;
1748 unsigned char *nm;
1750 register unsigned char *newdir, *p, *o;
1751 int tlen;
1752 unsigned char *target;
1753 struct passwd *pw;
1754 int lose;
1755 #ifdef VMS
1756 unsigned char * colon = 0;
1757 unsigned char * close = 0;
1758 unsigned char * slash = 0;
1759 unsigned char * brack = 0;
1760 int lbrack = 0, rbrack = 0;
1761 int dots = 0;
1762 #endif /* VMS */
1764 CHECK_STRING (name);
1766 #ifdef VMS
1767 /* Filenames on VMS are always upper case. */
1768 name = Fupcase (name);
1769 #endif
1771 nm = SDATA (name);
1773 /* If nm is absolute, flush ...// and detect /./ and /../.
1774 If no /./ or /../ we can return right away. */
1775 if (
1776 nm[0] == '/'
1777 #ifdef VMS
1778 || index (nm, ':')
1779 #endif /* VMS */
1782 p = nm;
1783 lose = 0;
1784 while (*p)
1786 if (p[0] == '/' && p[1] == '/'
1787 #ifdef APOLLO
1788 /* // at start of filename is meaningful on Apollo system. */
1789 && nm != p
1790 #endif /* APOLLO */
1792 nm = p + 1;
1793 if (p[0] == '/' && p[1] == '~')
1794 nm = p + 1, lose = 1;
1795 if (p[0] == '/' && p[1] == '.'
1796 && (p[2] == '/' || p[2] == 0
1797 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1798 lose = 1;
1799 #ifdef VMS
1800 if (p[0] == '\\')
1801 lose = 1;
1802 if (p[0] == '/') {
1803 /* if dev:[dir]/, move nm to / */
1804 if (!slash && p > nm && (brack || colon)) {
1805 nm = (brack ? brack + 1 : colon + 1);
1806 lbrack = rbrack = 0;
1807 brack = 0;
1808 colon = 0;
1810 slash = p;
1812 if (p[0] == '-')
1813 #ifndef VMS4_4
1814 /* VMS pre V4.4,convert '-'s in filenames. */
1815 if (lbrack == rbrack)
1817 if (dots < 2) /* this is to allow negative version numbers */
1818 p[0] = '_';
1820 else
1821 #endif /* VMS4_4 */
1822 if (lbrack > rbrack &&
1823 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1824 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1825 lose = 1;
1826 #ifndef VMS4_4
1827 else
1828 p[0] = '_';
1829 #endif /* VMS4_4 */
1830 /* count open brackets, reset close bracket pointer */
1831 if (p[0] == '[' || p[0] == '<')
1832 lbrack++, brack = 0;
1833 /* count close brackets, set close bracket pointer */
1834 if (p[0] == ']' || p[0] == '>')
1835 rbrack++, brack = p;
1836 /* detect ][ or >< */
1837 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1838 lose = 1;
1839 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1840 nm = p + 1, lose = 1;
1841 if (p[0] == ':' && (colon || slash))
1842 /* if dev1:[dir]dev2:, move nm to dev2: */
1843 if (brack)
1845 nm = brack + 1;
1846 brack = 0;
1848 /* If /name/dev:, move nm to dev: */
1849 else if (slash)
1850 nm = slash + 1;
1851 /* If node::dev:, move colon following dev */
1852 else if (colon && colon[-1] == ':')
1853 colon = p;
1854 /* If dev1:dev2:, move nm to dev2: */
1855 else if (colon && colon[-1] != ':')
1857 nm = colon + 1;
1858 colon = 0;
1860 if (p[0] == ':' && !colon)
1862 if (p[1] == ':')
1863 p++;
1864 colon = p;
1866 if (lbrack == rbrack)
1867 if (p[0] == ';')
1868 dots = 2;
1869 else if (p[0] == '.')
1870 dots++;
1871 #endif /* VMS */
1872 p++;
1874 if (!lose)
1876 #ifdef VMS
1877 if (index (nm, '/'))
1878 return build_string (sys_translate_unix (nm));
1879 #endif /* VMS */
1880 if (nm == SDATA (name))
1881 return name;
1882 return build_string (nm);
1886 /* Now determine directory to start with and put it in NEWDIR */
1888 newdir = 0;
1890 if (nm[0] == '~') /* prefix ~ */
1891 if (nm[1] == '/'
1892 #ifdef VMS
1893 || nm[1] == ':'
1894 #endif /* VMS */
1895 || nm[1] == 0)/* ~/filename */
1897 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1898 newdir = (unsigned char *) "";
1899 nm++;
1900 #ifdef VMS
1901 nm++; /* Don't leave the slash in nm. */
1902 #endif /* VMS */
1904 else /* ~user/filename */
1906 /* Get past ~ to user */
1907 unsigned char *user = nm + 1;
1908 /* Find end of name. */
1909 unsigned char *ptr = (unsigned char *) index (user, '/');
1910 int len = ptr ? ptr - user : strlen (user);
1911 #ifdef VMS
1912 unsigned char *ptr1 = index (user, ':');
1913 if (ptr1 != 0 && ptr1 - user < len)
1914 len = ptr1 - user;
1915 #endif /* VMS */
1916 /* Copy the user name into temp storage. */
1917 o = (unsigned char *) alloca (len + 1);
1918 bcopy ((char *) user, o, len);
1919 o[len] = 0;
1921 /* Look up the user name. */
1922 pw = (struct passwd *) getpwnam (o + 1);
1923 if (!pw)
1924 error ("\"%s\" isn't a registered user", o + 1);
1926 newdir = (unsigned char *) pw->pw_dir;
1928 /* Discard the user name from NM. */
1929 nm += len;
1932 if (nm[0] != '/'
1933 #ifdef VMS
1934 && !index (nm, ':')
1935 #endif /* not VMS */
1936 && !newdir)
1938 if (NILP (defalt))
1939 defalt = current_buffer->directory;
1940 CHECK_STRING (defalt);
1941 newdir = SDATA (defalt);
1944 /* Now concatenate the directory and name to new space in the stack frame */
1946 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1947 target = (unsigned char *) alloca (tlen);
1948 *target = 0;
1950 if (newdir)
1952 #ifndef VMS
1953 if (nm[0] == 0 || nm[0] == '/')
1954 strcpy (target, newdir);
1955 else
1956 #endif
1957 file_name_as_directory (target, newdir);
1960 strcat (target, nm);
1961 #ifdef VMS
1962 if (index (target, '/'))
1963 strcpy (target, sys_translate_unix (target));
1964 #endif /* VMS */
1966 /* Now canonicalize by removing /. and /foo/.. if they appear */
1968 p = target;
1969 o = target;
1971 while (*p)
1973 #ifdef VMS
1974 if (*p != ']' && *p != '>' && *p != '-')
1976 if (*p == '\\')
1977 p++;
1978 *o++ = *p++;
1980 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1981 /* brackets are offset from each other by 2 */
1983 p += 2;
1984 if (*p != '.' && *p != '-' && o[-1] != '.')
1985 /* convert [foo][bar] to [bar] */
1986 while (o[-1] != '[' && o[-1] != '<')
1987 o--;
1988 else if (*p == '-' && *o != '.')
1989 *--p = '.';
1991 else if (p[0] == '-' && o[-1] == '.' &&
1992 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1993 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1996 o--;
1997 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1998 if (p[1] == '.') /* foo.-.bar ==> bar. */
1999 p += 2;
2000 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2001 p++, o--;
2002 /* else [foo.-] ==> [-] */
2004 else
2006 #ifndef VMS4_4
2007 if (*p == '-' &&
2008 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
2009 p[1] != ']' && p[1] != '>' && p[1] != '.')
2010 *p = '_';
2011 #endif /* VMS4_4 */
2012 *o++ = *p++;
2014 #else /* not VMS */
2015 if (*p != '/')
2017 *o++ = *p++;
2019 else if (!strncmp (p, "//", 2)
2020 #ifdef APOLLO
2021 /* // at start of filename is meaningful in Apollo system. */
2022 && o != target
2023 #endif /* APOLLO */
2026 o = target;
2027 p++;
2029 else if (p[0] == '/' && p[1] == '.' &&
2030 (p[2] == '/' || p[2] == 0))
2031 p += 2;
2032 else if (!strncmp (p, "/..", 3)
2033 /* `/../' is the "superroot" on certain file systems. */
2034 && o != target
2035 && (p[3] == '/' || p[3] == 0))
2037 while (o != target && *--o != '/')
2039 #ifdef APOLLO
2040 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2041 ++o;
2042 else
2043 #endif /* APOLLO */
2044 if (o == target && *o == '/')
2045 ++o;
2046 p += 3;
2048 else
2050 *o++ = *p++;
2052 #endif /* not VMS */
2055 return make_string (target, o - target);
2057 #endif
2059 /* If /~ or // appears, discard everything through first slash. */
2060 static int
2061 file_name_absolute_p (filename)
2062 const unsigned char *filename;
2064 return
2065 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2066 #ifdef VMS
2067 /* ??? This criterion is probably wrong for '<'. */
2068 || index (filename, ':') || index (filename, '<')
2069 || (*filename == '[' && (filename[1] != '-'
2070 || (filename[2] != '.' && filename[2] != ']'))
2071 && filename[1] != '.')
2072 #endif /* VMS */
2073 #ifdef DOS_NT
2074 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2075 && IS_DIRECTORY_SEP (filename[2]))
2076 #endif
2080 static unsigned char *
2081 search_embedded_absfilename (nm, endp)
2082 unsigned char *nm, *endp;
2084 unsigned char *p, *s;
2086 for (p = nm + 1; p < endp; p++)
2088 if ((0
2089 #ifdef VMS
2090 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2091 #endif /* VMS */
2092 || IS_DIRECTORY_SEP (p[-1]))
2093 && file_name_absolute_p (p)
2094 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2095 /* // at start of file name is meaningful in Apollo,
2096 WindowsNT and Cygwin systems. */
2097 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2098 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2101 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2102 #ifdef VMS
2103 && *s != ':'
2104 #endif /* VMS */
2105 ); s++);
2106 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2108 unsigned char *o = alloca (s - p + 1);
2109 struct passwd *pw;
2110 bcopy (p, o, s - p);
2111 o [s - p] = 0;
2113 /* If we have ~user and `user' exists, discard
2114 everything up to ~. But if `user' does not exist, leave
2115 ~user alone, it might be a literal file name. */
2116 if ((pw = getpwnam (o + 1)))
2117 return p;
2118 else
2119 xfree (pw);
2121 else
2122 return p;
2125 return NULL;
2128 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2129 Ssubstitute_in_file_name, 1, 1, 0,
2130 doc: /* Substitute environment variables referred to in FILENAME.
2131 `$FOO' where FOO is an environment variable name means to substitute
2132 the value of that variable. The variable name should be terminated
2133 with a character not a letter, digit or underscore; otherwise, enclose
2134 the entire variable name in braces.
2135 If `/~' appears, all of FILENAME through that `/' is discarded.
2137 On VMS, `$' substitution is not done; this function does little and only
2138 duplicates what `expand-file-name' does. */)
2139 (filename)
2140 Lisp_Object filename;
2142 unsigned char *nm;
2144 register unsigned char *s, *p, *o, *x, *endp;
2145 unsigned char *target = NULL;
2146 int total = 0;
2147 int substituted = 0;
2148 unsigned char *xnm;
2149 Lisp_Object handler;
2151 CHECK_STRING (filename);
2153 /* If the file name has special constructs in it,
2154 call the corresponding file handler. */
2155 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2156 if (!NILP (handler))
2157 return call2 (handler, Qsubstitute_in_file_name, filename);
2159 nm = SDATA (filename);
2160 #ifdef DOS_NT
2161 nm = strcpy (alloca (strlen (nm) + 1), nm);
2162 CORRECT_DIR_SEPS (nm);
2163 substituted = (strcmp (nm, SDATA (filename)) != 0);
2164 #endif
2165 endp = nm + SBYTES (filename);
2167 /* If /~ or // appears, discard everything through first slash. */
2168 p = search_embedded_absfilename (nm, endp);
2169 if (p)
2170 /* Start over with the new string, so we check the file-name-handler
2171 again. Important with filenames like "/home/foo//:/hello///there"
2172 which whould substitute to "/:/hello///there" rather than "/there". */
2173 return Fsubstitute_in_file_name
2174 (make_specified_string (p, -1, endp - p,
2175 STRING_MULTIBYTE (filename)));
2177 #ifdef VMS
2178 return filename;
2179 #else
2181 /* See if any variables are substituted into the string
2182 and find the total length of their values in `total' */
2184 for (p = nm; p != endp;)
2185 if (*p != '$')
2186 p++;
2187 else
2189 p++;
2190 if (p == endp)
2191 goto badsubst;
2192 else if (*p == '$')
2194 /* "$$" means a single "$" */
2195 p++;
2196 total -= 1;
2197 substituted = 1;
2198 continue;
2200 else if (*p == '{')
2202 o = ++p;
2203 while (p != endp && *p != '}') p++;
2204 if (*p != '}') goto missingclose;
2205 s = p;
2207 else
2209 o = p;
2210 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2211 s = p;
2214 /* Copy out the variable name */
2215 target = (unsigned char *) alloca (s - o + 1);
2216 strncpy (target, o, s - o);
2217 target[s - o] = 0;
2218 #ifdef DOS_NT
2219 strupr (target); /* $home == $HOME etc. */
2220 #endif /* DOS_NT */
2222 /* Get variable value */
2223 o = (unsigned char *) egetenv (target);
2224 if (o)
2226 total += strlen (o);
2227 substituted = 1;
2229 else if (*p == '}')
2230 goto badvar;
2233 if (!substituted)
2234 return filename;
2236 /* If substitution required, recopy the string and do it */
2237 /* Make space in stack frame for the new copy */
2238 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2239 x = xnm;
2241 /* Copy the rest of the name through, replacing $ constructs with values */
2242 for (p = nm; *p;)
2243 if (*p != '$')
2244 *x++ = *p++;
2245 else
2247 p++;
2248 if (p == endp)
2249 goto badsubst;
2250 else if (*p == '$')
2252 *x++ = *p++;
2253 continue;
2255 else if (*p == '{')
2257 o = ++p;
2258 while (p != endp && *p != '}') p++;
2259 if (*p != '}') goto missingclose;
2260 s = p++;
2262 else
2264 o = p;
2265 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2266 s = p;
2269 /* Copy out the variable name */
2270 target = (unsigned char *) alloca (s - o + 1);
2271 strncpy (target, o, s - o);
2272 target[s - o] = 0;
2273 #ifdef DOS_NT
2274 strupr (target); /* $home == $HOME etc. */
2275 #endif /* DOS_NT */
2277 /* Get variable value */
2278 o = (unsigned char *) egetenv (target);
2279 if (!o)
2281 *x++ = '$';
2282 strcpy (x, target); x+= strlen (target);
2284 else if (STRING_MULTIBYTE (filename))
2286 /* If the original string is multibyte,
2287 convert what we substitute into multibyte. */
2288 while (*o)
2290 int c = unibyte_char_to_multibyte (*o++);
2291 x += CHAR_STRING (c, x);
2294 else
2296 strcpy (x, o);
2297 x += strlen (o);
2301 *x = 0;
2303 /* If /~ or // appears, discard everything through first slash. */
2304 while ((p = search_embedded_absfilename (xnm, x)))
2305 /* This time we do not start over because we've already expanded envvars
2306 and replaced $$ with $. Maybe we should start over as well, but we'd
2307 need to quote some $ to $$ first. */
2308 xnm = p;
2310 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2312 badsubst:
2313 error ("Bad format environment-variable substitution");
2314 missingclose:
2315 error ("Missing \"}\" in environment-variable substitution");
2316 badvar:
2317 error ("Substituting nonexistent environment variable \"%s\"", target);
2319 /* NOTREACHED */
2320 #endif /* not VMS */
2321 return Qnil;
2324 /* A slightly faster and more convenient way to get
2325 (directory-file-name (expand-file-name FOO)). */
2327 Lisp_Object
2328 expand_and_dir_to_file (filename, defdir)
2329 Lisp_Object filename, defdir;
2331 register Lisp_Object absname;
2333 absname = Fexpand_file_name (filename, defdir);
2334 #ifdef VMS
2336 register int c = SREF (absname, SBYTES (absname) - 1);
2337 if (c == ':' || c == ']' || c == '>')
2338 absname = Fdirectory_file_name (absname);
2340 #else
2341 /* Remove final slash, if any (unless this is the root dir).
2342 stat behaves differently depending! */
2343 if (SCHARS (absname) > 1
2344 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2345 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2346 /* We cannot take shortcuts; they might be wrong for magic file names. */
2347 absname = Fdirectory_file_name (absname);
2348 #endif
2349 return absname;
2352 /* Signal an error if the file ABSNAME already exists.
2353 If INTERACTIVE is nonzero, ask the user whether to proceed,
2354 and bypass the error if the user says to go ahead.
2355 QUERYSTRING is a name for the action that is being considered
2356 to alter the file.
2358 *STATPTR is used to store the stat information if the file exists.
2359 If the file does not exist, STATPTR->st_mode is set to 0.
2360 If STATPTR is null, we don't store into it.
2362 If QUICK is nonzero, we ask for y or n, not yes or no. */
2364 void
2365 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2366 Lisp_Object absname;
2367 unsigned char *querystring;
2368 int interactive;
2369 struct stat *statptr;
2370 int quick;
2372 register Lisp_Object tem, encoded_filename;
2373 struct stat statbuf;
2374 struct gcpro gcpro1;
2376 encoded_filename = ENCODE_FILE (absname);
2378 /* stat is a good way to tell whether the file exists,
2379 regardless of what access permissions it has. */
2380 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2382 if (! interactive)
2383 Fsignal (Qfile_already_exists,
2384 Fcons (build_string ("File already exists"),
2385 Fcons (absname, Qnil)));
2386 GCPRO1 (absname);
2387 tem = format2 ("File %s already exists; %s anyway? ",
2388 absname, build_string (querystring));
2389 if (quick)
2390 tem = Fy_or_n_p (tem);
2391 else
2392 tem = do_yes_or_no_p (tem);
2393 UNGCPRO;
2394 if (NILP (tem))
2395 Fsignal (Qfile_already_exists,
2396 Fcons (build_string ("File already exists"),
2397 Fcons (absname, Qnil)));
2398 if (statptr)
2399 *statptr = statbuf;
2401 else
2403 if (statptr)
2404 statptr->st_mode = 0;
2406 return;
2409 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2410 "fCopy file: \nGCopy %s to file: \np\nP",
2411 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2412 If NEWNAME names a directory, copy FILE there.
2413 Signals a `file-already-exists' error if file NEWNAME already exists,
2414 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2415 A number as third arg means request confirmation if NEWNAME already exists.
2416 This is what happens in interactive use with M-x.
2417 Always sets the file modes of the output file to match the input file.
2419 Fourth arg KEEP-TIME non-nil means give the output file the same
2420 last-modified time as the old one. (This works on only some systems.)
2422 A prefix arg makes KEEP-TIME non-nil.
2424 The optional fifth arg MUSTBENEW, if non-nil, insists on a check
2425 for an existing file with the same name. If MUSTBENEW is `excl',
2426 that means to get an error if the file already exists; never overwrite.
2427 If MUSTBENEW is neither nil nor `excl', that means ask for
2428 confirmation before overwriting, but do go ahead and overwrite the file
2429 if the user confirms. */)
2430 (file, newname, ok_if_already_exists, keep_time, mustbenew)
2431 Lisp_Object file, newname, ok_if_already_exists, keep_time, mustbenew;
2433 int ifd, ofd, n;
2434 char buf[16 * 1024];
2435 struct stat st, out_st;
2436 Lisp_Object handler;
2437 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2438 int count = SPECPDL_INDEX ();
2439 int input_file_statable_p;
2440 Lisp_Object encoded_file, encoded_newname;
2442 encoded_file = encoded_newname = Qnil;
2443 GCPRO4 (file, newname, encoded_file, encoded_newname);
2444 CHECK_STRING (file);
2445 CHECK_STRING (newname);
2447 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
2448 barf_or_query_if_file_exists (newname, "overwrite", 1, 0, 1);
2450 if (!NILP (Ffile_directory_p (newname)))
2451 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2452 else
2453 newname = Fexpand_file_name (newname, Qnil);
2455 file = Fexpand_file_name (file, Qnil);
2457 /* If the input file name has special constructs in it,
2458 call the corresponding file handler. */
2459 handler = Ffind_file_name_handler (file, Qcopy_file);
2460 /* Likewise for output file name. */
2461 if (NILP (handler))
2462 handler = Ffind_file_name_handler (newname, Qcopy_file);
2463 if (!NILP (handler))
2464 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2465 ok_if_already_exists, keep_time));
2467 encoded_file = ENCODE_FILE (file);
2468 encoded_newname = ENCODE_FILE (newname);
2470 if (NILP (ok_if_already_exists)
2471 || INTEGERP (ok_if_already_exists))
2472 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2473 INTEGERP (ok_if_already_exists), &out_st, 0);
2474 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2475 out_st.st_mode = 0;
2477 #ifdef WINDOWSNT
2478 if (!CopyFile (SDATA (encoded_file),
2479 SDATA (encoded_newname),
2480 FALSE))
2481 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2482 /* CopyFile retains the timestamp by default. */
2483 else if (NILP (keep_time))
2485 EMACS_TIME now;
2486 DWORD attributes;
2487 char * filename;
2489 EMACS_GET_TIME (now);
2490 filename = SDATA (encoded_newname);
2492 /* Ensure file is writable while its modified time is set. */
2493 attributes = GetFileAttributes (filename);
2494 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2495 if (set_file_times (filename, now, now))
2497 /* Restore original attributes. */
2498 SetFileAttributes (filename, attributes);
2499 Fsignal (Qfile_date_error,
2500 Fcons (build_string ("Cannot set file date"),
2501 Fcons (newname, Qnil)));
2503 /* Restore original attributes. */
2504 SetFileAttributes (filename, attributes);
2506 #else /* not WINDOWSNT */
2507 immediate_quit = 1;
2508 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2509 immediate_quit = 0;
2511 if (ifd < 0)
2512 report_file_error ("Opening input file", Fcons (file, Qnil));
2514 record_unwind_protect (close_file_unwind, make_number (ifd));
2516 /* We can only copy regular files and symbolic links. Other files are not
2517 copyable by us. */
2518 input_file_statable_p = (fstat (ifd, &st) >= 0);
2520 #if !defined (DOS_NT) || __DJGPP__ > 1
2521 if (out_st.st_mode != 0
2522 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2524 errno = 0;
2525 report_file_error ("Input and output files are the same",
2526 Fcons (file, Fcons (newname, Qnil)));
2528 #endif
2530 #if defined (S_ISREG) && defined (S_ISLNK)
2531 if (input_file_statable_p)
2533 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2535 #if defined (EISDIR)
2536 /* Get a better looking error message. */
2537 errno = EISDIR;
2538 #endif /* EISDIR */
2539 report_file_error ("Non-regular file", Fcons (file, Qnil));
2542 #endif /* S_ISREG && S_ISLNK */
2544 #ifdef VMS
2545 /* Create the copy file with the same record format as the input file */
2546 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2547 #else
2548 #ifdef MSDOS
2549 /* System's default file type was set to binary by _fmode in emacs.c. */
2550 ofd = emacs_open (SDATA (encoded_newname),
2551 O_WRONLY | O_TRUNC | O_CREAT
2552 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
2553 S_IREAD | S_IWRITE);
2554 #else /* not MSDOS */
2555 ofd = emacs_open (SDATA (encoded_newname),
2556 O_WRONLY | O_TRUNC | O_CREAT
2557 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
2558 0666);
2559 #endif /* not MSDOS */
2560 #endif /* VMS */
2561 if (ofd < 0)
2562 report_file_error ("Opening output file", Fcons (newname, Qnil));
2564 record_unwind_protect (close_file_unwind, make_number (ofd));
2566 immediate_quit = 1;
2567 QUIT;
2568 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2569 if (emacs_write (ofd, buf, n) != n)
2570 report_file_error ("I/O error", Fcons (newname, Qnil));
2571 immediate_quit = 0;
2573 /* Closing the output clobbers the file times on some systems. */
2574 if (emacs_close (ofd) < 0)
2575 report_file_error ("I/O error", Fcons (newname, Qnil));
2577 if (input_file_statable_p)
2579 if (!NILP (keep_time))
2581 EMACS_TIME atime, mtime;
2582 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2583 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2584 if (set_file_times (SDATA (encoded_newname),
2585 atime, mtime))
2586 Fsignal (Qfile_date_error,
2587 Fcons (build_string ("Cannot set file date"),
2588 Fcons (newname, Qnil)));
2590 #ifndef MSDOS
2591 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2592 #else /* MSDOS */
2593 #if defined (__DJGPP__) && __DJGPP__ > 1
2594 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2595 and if it can't, it tells so. Otherwise, under MSDOS we usually
2596 get only the READ bit, which will make the copied file read-only,
2597 so it's better not to chmod at all. */
2598 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2599 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2600 #endif /* DJGPP version 2 or newer */
2601 #endif /* MSDOS */
2604 emacs_close (ifd);
2605 #endif /* WINDOWSNT */
2607 /* Discard the unwind protects. */
2608 specpdl_ptr = specpdl + count;
2610 UNGCPRO;
2611 return Qnil;
2614 DEFUN ("make-directory-internal", Fmake_directory_internal,
2615 Smake_directory_internal, 1, 1, 0,
2616 doc: /* Create a new directory named DIRECTORY. */)
2617 (directory)
2618 Lisp_Object directory;
2620 const unsigned char *dir;
2621 Lisp_Object handler;
2622 Lisp_Object encoded_dir;
2624 CHECK_STRING (directory);
2625 directory = Fexpand_file_name (directory, Qnil);
2627 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2628 if (!NILP (handler))
2629 return call2 (handler, Qmake_directory_internal, directory);
2631 encoded_dir = ENCODE_FILE (directory);
2633 dir = SDATA (encoded_dir);
2635 #ifdef WINDOWSNT
2636 if (mkdir (dir) != 0)
2637 #else
2638 if (mkdir (dir, 0777) != 0)
2639 #endif
2640 report_file_error ("Creating directory", Flist (1, &directory));
2642 return Qnil;
2645 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2646 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2647 (directory)
2648 Lisp_Object directory;
2650 const unsigned char *dir;
2651 Lisp_Object handler;
2652 Lisp_Object encoded_dir;
2654 CHECK_STRING (directory);
2655 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2657 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2658 if (!NILP (handler))
2659 return call2 (handler, Qdelete_directory, directory);
2661 encoded_dir = ENCODE_FILE (directory);
2663 dir = SDATA (encoded_dir);
2665 if (rmdir (dir) != 0)
2666 report_file_error ("Removing directory", Flist (1, &directory));
2668 return Qnil;
2671 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2672 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2673 If file has multiple names, it continues to exist with the other names. */)
2674 (filename)
2675 Lisp_Object filename;
2677 Lisp_Object handler;
2678 Lisp_Object encoded_file;
2679 struct gcpro gcpro1;
2681 GCPRO1 (filename);
2682 if (!NILP (Ffile_directory_p (filename))
2683 && NILP (Ffile_symlink_p (filename)))
2684 Fsignal (Qfile_error,
2685 Fcons (build_string ("Removing old name: is a directory"),
2686 Fcons (filename, Qnil)));
2687 UNGCPRO;
2688 filename = Fexpand_file_name (filename, Qnil);
2690 handler = Ffind_file_name_handler (filename, Qdelete_file);
2691 if (!NILP (handler))
2692 return call2 (handler, Qdelete_file, filename);
2694 encoded_file = ENCODE_FILE (filename);
2696 if (0 > unlink (SDATA (encoded_file)))
2697 report_file_error ("Removing old name", Flist (1, &filename));
2698 return Qnil;
2701 static Lisp_Object
2702 internal_delete_file_1 (ignore)
2703 Lisp_Object ignore;
2705 return Qt;
2708 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2711 internal_delete_file (filename)
2712 Lisp_Object filename;
2714 return NILP (internal_condition_case_1 (Fdelete_file, filename,
2715 Qt, internal_delete_file_1));
2718 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2719 "fRename file: \nGRename %s to file: \np",
2720 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2721 If file has names other than FILE, it continues to have those names.
2722 Signals a `file-already-exists' error if a file NEWNAME already exists
2723 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2724 A number as third arg means request confirmation if NEWNAME already exists.
2725 This is what happens in interactive use with M-x. */)
2726 (file, newname, ok_if_already_exists)
2727 Lisp_Object file, newname, ok_if_already_exists;
2729 #ifdef NO_ARG_ARRAY
2730 Lisp_Object args[2];
2731 #endif
2732 Lisp_Object handler;
2733 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2734 Lisp_Object encoded_file, encoded_newname, symlink_target;
2736 symlink_target = encoded_file = encoded_newname = Qnil;
2737 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2738 CHECK_STRING (file);
2739 CHECK_STRING (newname);
2740 file = Fexpand_file_name (file, Qnil);
2742 if (!NILP (Ffile_directory_p (newname)))
2743 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2744 else
2745 newname = Fexpand_file_name (newname, Qnil);
2747 /* If the file name has special constructs in it,
2748 call the corresponding file handler. */
2749 handler = Ffind_file_name_handler (file, Qrename_file);
2750 if (NILP (handler))
2751 handler = Ffind_file_name_handler (newname, Qrename_file);
2752 if (!NILP (handler))
2753 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2754 file, newname, ok_if_already_exists));
2756 encoded_file = ENCODE_FILE (file);
2757 encoded_newname = ENCODE_FILE (newname);
2759 #ifdef DOS_NT
2760 /* If the file names are identical but for the case, don't ask for
2761 confirmation: they simply want to change the letter-case of the
2762 file name. */
2763 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2764 #endif
2765 if (NILP (ok_if_already_exists)
2766 || INTEGERP (ok_if_already_exists))
2767 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2768 INTEGERP (ok_if_already_exists), 0, 0);
2769 #ifndef BSD4_1
2770 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2771 #else
2772 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2773 || 0 > unlink (SDATA (encoded_file)))
2774 #endif
2776 if (errno == EXDEV)
2778 #ifdef S_IFLNK
2779 symlink_target = Ffile_symlink_p (file);
2780 if (! NILP (symlink_target))
2781 Fmake_symbolic_link (symlink_target, newname,
2782 NILP (ok_if_already_exists) ? Qnil : Qt);
2783 else
2784 #endif
2785 Fcopy_file (file, newname,
2786 /* We have already prompted if it was an integer,
2787 so don't have copy-file prompt again. */
2788 NILP (ok_if_already_exists) ? Qnil : Qt,
2789 Qt, Qnil);
2790 Fdelete_file (file);
2792 else
2793 #ifdef NO_ARG_ARRAY
2795 args[0] = file;
2796 args[1] = newname;
2797 report_file_error ("Renaming", Flist (2, args));
2799 #else
2800 report_file_error ("Renaming", Flist (2, &file));
2801 #endif
2803 UNGCPRO;
2804 return Qnil;
2807 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2808 "fAdd name to file: \nGName to add to %s: \np",
2809 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2810 Signals a `file-already-exists' error if a file NEWNAME already exists
2811 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2812 A number as third arg means request confirmation if NEWNAME already exists.
2813 This is what happens in interactive use with M-x. */)
2814 (file, newname, ok_if_already_exists)
2815 Lisp_Object file, newname, ok_if_already_exists;
2817 #ifdef NO_ARG_ARRAY
2818 Lisp_Object args[2];
2819 #endif
2820 Lisp_Object handler;
2821 Lisp_Object encoded_file, encoded_newname;
2822 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2824 GCPRO4 (file, newname, encoded_file, encoded_newname);
2825 encoded_file = encoded_newname = Qnil;
2826 CHECK_STRING (file);
2827 CHECK_STRING (newname);
2828 file = Fexpand_file_name (file, Qnil);
2830 if (!NILP (Ffile_directory_p (newname)))
2831 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2832 else
2833 newname = Fexpand_file_name (newname, Qnil);
2835 /* If the file name has special constructs in it,
2836 call the corresponding file handler. */
2837 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2838 if (!NILP (handler))
2839 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2840 newname, ok_if_already_exists));
2842 /* If the new name has special constructs in it,
2843 call the corresponding file handler. */
2844 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2845 if (!NILP (handler))
2846 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2847 newname, ok_if_already_exists));
2849 encoded_file = ENCODE_FILE (file);
2850 encoded_newname = ENCODE_FILE (newname);
2852 if (NILP (ok_if_already_exists)
2853 || INTEGERP (ok_if_already_exists))
2854 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2855 INTEGERP (ok_if_already_exists), 0, 0);
2857 unlink (SDATA (newname));
2858 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2860 #ifdef NO_ARG_ARRAY
2861 args[0] = file;
2862 args[1] = newname;
2863 report_file_error ("Adding new name", Flist (2, args));
2864 #else
2865 report_file_error ("Adding new name", Flist (2, &file));
2866 #endif
2869 UNGCPRO;
2870 return Qnil;
2873 #ifdef S_IFLNK
2874 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2875 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2876 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2877 Both args must be strings.
2878 Signals a `file-already-exists' error if a file LINKNAME already exists
2879 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2880 A number as third arg means request confirmation if LINKNAME already exists.
2881 This happens for interactive use with M-x. */)
2882 (filename, linkname, ok_if_already_exists)
2883 Lisp_Object filename, linkname, ok_if_already_exists;
2885 #ifdef NO_ARG_ARRAY
2886 Lisp_Object args[2];
2887 #endif
2888 Lisp_Object handler;
2889 Lisp_Object encoded_filename, encoded_linkname;
2890 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2892 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2893 encoded_filename = encoded_linkname = Qnil;
2894 CHECK_STRING (filename);
2895 CHECK_STRING (linkname);
2896 /* If the link target has a ~, we must expand it to get
2897 a truly valid file name. Otherwise, do not expand;
2898 we want to permit links to relative file names. */
2899 if (SREF (filename, 0) == '~')
2900 filename = Fexpand_file_name (filename, Qnil);
2902 if (!NILP (Ffile_directory_p (linkname)))
2903 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2904 else
2905 linkname = Fexpand_file_name (linkname, Qnil);
2907 /* If the file name has special constructs in it,
2908 call the corresponding file handler. */
2909 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2910 if (!NILP (handler))
2911 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2912 linkname, ok_if_already_exists));
2914 /* If the new link name has special constructs in it,
2915 call the corresponding file handler. */
2916 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2917 if (!NILP (handler))
2918 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2919 linkname, ok_if_already_exists));
2921 encoded_filename = ENCODE_FILE (filename);
2922 encoded_linkname = ENCODE_FILE (linkname);
2924 if (NILP (ok_if_already_exists)
2925 || INTEGERP (ok_if_already_exists))
2926 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2927 INTEGERP (ok_if_already_exists), 0, 0);
2928 if (0 > symlink (SDATA (encoded_filename),
2929 SDATA (encoded_linkname)))
2931 /* If we didn't complain already, silently delete existing file. */
2932 if (errno == EEXIST)
2934 unlink (SDATA (encoded_linkname));
2935 if (0 <= symlink (SDATA (encoded_filename),
2936 SDATA (encoded_linkname)))
2938 UNGCPRO;
2939 return Qnil;
2943 #ifdef NO_ARG_ARRAY
2944 args[0] = filename;
2945 args[1] = linkname;
2946 report_file_error ("Making symbolic link", Flist (2, args));
2947 #else
2948 report_file_error ("Making symbolic link", Flist (2, &filename));
2949 #endif
2951 UNGCPRO;
2952 return Qnil;
2954 #endif /* S_IFLNK */
2956 #ifdef VMS
2958 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2959 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2960 doc: /* Define the job-wide logical name NAME to have the value STRING.
2961 If STRING is nil or a null string, the logical name NAME is deleted. */)
2962 (name, string)
2963 Lisp_Object name;
2964 Lisp_Object string;
2966 CHECK_STRING (name);
2967 if (NILP (string))
2968 delete_logical_name (SDATA (name));
2969 else
2971 CHECK_STRING (string);
2973 if (SCHARS (string) == 0)
2974 delete_logical_name (SDATA (name));
2975 else
2976 define_logical_name (SDATA (name), SDATA (string));
2979 return string;
2981 #endif /* VMS */
2983 #ifdef HPUX_NET
2985 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2986 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2987 (path, login)
2988 Lisp_Object path, login;
2990 int netresult;
2992 CHECK_STRING (path);
2993 CHECK_STRING (login);
2995 netresult = netunam (SDATA (path), SDATA (login));
2997 if (netresult == -1)
2998 return Qnil;
2999 else
3000 return Qt;
3002 #endif /* HPUX_NET */
3004 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
3005 1, 1, 0,
3006 doc: /* Return t if file FILENAME specifies an absolute file name.
3007 On Unix, this is a name starting with a `/' or a `~'. */)
3008 (filename)
3009 Lisp_Object filename;
3011 CHECK_STRING (filename);
3012 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3015 /* Return nonzero if file FILENAME exists and can be executed. */
3017 static int
3018 check_executable (filename)
3019 char *filename;
3021 #ifdef DOS_NT
3022 int len = strlen (filename);
3023 char *suffix;
3024 struct stat st;
3025 if (stat (filename, &st) < 0)
3026 return 0;
3027 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3028 return ((st.st_mode & S_IEXEC) != 0);
3029 #else
3030 return (S_ISREG (st.st_mode)
3031 && len >= 5
3032 && (stricmp ((suffix = filename + len-4), ".com") == 0
3033 || stricmp (suffix, ".exe") == 0
3034 || stricmp (suffix, ".bat") == 0)
3035 || (st.st_mode & S_IFMT) == S_IFDIR);
3036 #endif /* not WINDOWSNT */
3037 #else /* not DOS_NT */
3038 #ifdef HAVE_EUIDACCESS
3039 return (euidaccess (filename, 1) >= 0);
3040 #else
3041 /* Access isn't quite right because it uses the real uid
3042 and we really want to test with the effective uid.
3043 But Unix doesn't give us a right way to do it. */
3044 return (access (filename, 1) >= 0);
3045 #endif
3046 #endif /* not DOS_NT */
3049 /* Return nonzero if file FILENAME exists and can be written. */
3051 static int
3052 check_writable (filename)
3053 char *filename;
3055 #ifdef MSDOS
3056 struct stat st;
3057 if (stat (filename, &st) < 0)
3058 return 0;
3059 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3060 #else /* not MSDOS */
3061 #ifdef HAVE_EUIDACCESS
3062 return (euidaccess (filename, 2) >= 0);
3063 #else
3064 /* Access isn't quite right because it uses the real uid
3065 and we really want to test with the effective uid.
3066 But Unix doesn't give us a right way to do it.
3067 Opening with O_WRONLY could work for an ordinary file,
3068 but would lose for directories. */
3069 return (access (filename, 2) >= 0);
3070 #endif
3071 #endif /* not MSDOS */
3074 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3075 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3076 See also `file-readable-p' and `file-attributes'.
3077 This returns nil for a symlink to a nonexistent file.
3078 Use `file-symlink-p' to test for such links. */)
3079 (filename)
3080 Lisp_Object filename;
3082 Lisp_Object absname;
3083 Lisp_Object handler;
3084 struct stat statbuf;
3086 CHECK_STRING (filename);
3087 absname = Fexpand_file_name (filename, Qnil);
3089 /* If the file name has special constructs in it,
3090 call the corresponding file handler. */
3091 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3092 if (!NILP (handler))
3093 return call2 (handler, Qfile_exists_p, absname);
3095 absname = ENCODE_FILE (absname);
3097 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3100 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3101 doc: /* Return t if FILENAME can be executed by you.
3102 For a directory, this means you can access files in that directory. */)
3103 (filename)
3104 Lisp_Object filename;
3106 Lisp_Object absname;
3107 Lisp_Object handler;
3109 CHECK_STRING (filename);
3110 absname = Fexpand_file_name (filename, Qnil);
3112 /* If the file name has special constructs in it,
3113 call the corresponding file handler. */
3114 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3115 if (!NILP (handler))
3116 return call2 (handler, Qfile_executable_p, absname);
3118 absname = ENCODE_FILE (absname);
3120 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3123 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3124 doc: /* Return t if file FILENAME exists and you can read it.
3125 See also `file-exists-p' and `file-attributes'. */)
3126 (filename)
3127 Lisp_Object filename;
3129 Lisp_Object absname;
3130 Lisp_Object handler;
3131 int desc;
3132 int flags;
3133 struct stat statbuf;
3135 CHECK_STRING (filename);
3136 absname = Fexpand_file_name (filename, Qnil);
3138 /* If the file name has special constructs in it,
3139 call the corresponding file handler. */
3140 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3141 if (!NILP (handler))
3142 return call2 (handler, Qfile_readable_p, absname);
3144 absname = ENCODE_FILE (absname);
3146 #if defined(DOS_NT) || defined(macintosh)
3147 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3148 directories. */
3149 if (access (SDATA (absname), 0) == 0)
3150 return Qt;
3151 return Qnil;
3152 #else /* not DOS_NT and not macintosh */
3153 flags = O_RDONLY;
3154 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3155 /* Opening a fifo without O_NONBLOCK can wait.
3156 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3157 except in the case of a fifo, on a system which handles it. */
3158 desc = stat (SDATA (absname), &statbuf);
3159 if (desc < 0)
3160 return Qnil;
3161 if (S_ISFIFO (statbuf.st_mode))
3162 flags |= O_NONBLOCK;
3163 #endif
3164 desc = emacs_open (SDATA (absname), flags, 0);
3165 if (desc < 0)
3166 return Qnil;
3167 emacs_close (desc);
3168 return Qt;
3169 #endif /* not DOS_NT and not macintosh */
3172 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3173 on the RT/PC. */
3174 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3175 doc: /* Return t if file FILENAME can be written or created by you. */)
3176 (filename)
3177 Lisp_Object filename;
3179 Lisp_Object absname, dir, encoded;
3180 Lisp_Object handler;
3181 struct stat statbuf;
3183 CHECK_STRING (filename);
3184 absname = Fexpand_file_name (filename, Qnil);
3186 /* If the file name has special constructs in it,
3187 call the corresponding file handler. */
3188 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3189 if (!NILP (handler))
3190 return call2 (handler, Qfile_writable_p, absname);
3192 encoded = ENCODE_FILE (absname);
3193 if (stat (SDATA (encoded), &statbuf) >= 0)
3194 return (check_writable (SDATA (encoded))
3195 ? Qt : Qnil);
3197 dir = Ffile_name_directory (absname);
3198 #ifdef VMS
3199 if (!NILP (dir))
3200 dir = Fdirectory_file_name (dir);
3201 #endif /* VMS */
3202 #ifdef MSDOS
3203 if (!NILP (dir))
3204 dir = Fdirectory_file_name (dir);
3205 #endif /* MSDOS */
3207 dir = ENCODE_FILE (dir);
3208 #ifdef WINDOWSNT
3209 /* The read-only attribute of the parent directory doesn't affect
3210 whether a file or directory can be created within it. Some day we
3211 should check ACLs though, which do affect this. */
3212 if (stat (SDATA (dir), &statbuf) < 0)
3213 return Qnil;
3214 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3215 #else
3216 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3217 ? Qt : Qnil);
3218 #endif
3221 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3222 doc: /* Access file FILENAME, and get an error if that does not work.
3223 The second argument STRING is used in the error message.
3224 If there is no error, returns nil. */)
3225 (filename, string)
3226 Lisp_Object filename, string;
3228 Lisp_Object handler, encoded_filename, absname;
3229 int fd;
3231 CHECK_STRING (filename);
3232 absname = Fexpand_file_name (filename, Qnil);
3234 CHECK_STRING (string);
3236 /* If the file name has special constructs in it,
3237 call the corresponding file handler. */
3238 handler = Ffind_file_name_handler (absname, Qaccess_file);
3239 if (!NILP (handler))
3240 return call3 (handler, Qaccess_file, absname, string);
3242 encoded_filename = ENCODE_FILE (absname);
3244 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3245 if (fd < 0)
3246 report_file_error (SDATA (string), Fcons (filename, Qnil));
3247 emacs_close (fd);
3249 return Qnil;
3252 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3253 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3254 The value is the link target, as a string.
3255 Otherwise it returns nil.
3257 This function returns t when given the name of a symlink that
3258 points to a nonexistent file. */)
3259 (filename)
3260 Lisp_Object filename;
3262 Lisp_Object handler;
3264 CHECK_STRING (filename);
3265 filename = Fexpand_file_name (filename, Qnil);
3267 /* If the file name has special constructs in it,
3268 call the corresponding file handler. */
3269 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3270 if (!NILP (handler))
3271 return call2 (handler, Qfile_symlink_p, filename);
3273 #ifdef S_IFLNK
3275 char *buf;
3276 int bufsize;
3277 int valsize;
3278 Lisp_Object val;
3280 filename = ENCODE_FILE (filename);
3282 bufsize = 50;
3283 buf = NULL;
3286 bufsize *= 2;
3287 buf = (char *) xrealloc (buf, bufsize);
3288 bzero (buf, bufsize);
3290 errno = 0;
3291 valsize = readlink (SDATA (filename), buf, bufsize);
3292 if (valsize == -1)
3294 #ifdef ERANGE
3295 /* HP-UX reports ERANGE if buffer is too small. */
3296 if (errno == ERANGE)
3297 valsize = bufsize;
3298 else
3299 #endif
3301 xfree (buf);
3302 return Qnil;
3306 while (valsize >= bufsize);
3308 val = make_string (buf, valsize);
3309 if (buf[0] == '/' && index (buf, ':'))
3310 val = concat2 (build_string ("/:"), val);
3311 xfree (buf);
3312 val = DECODE_FILE (val);
3313 return val;
3315 #else /* not S_IFLNK */
3316 return Qnil;
3317 #endif /* not S_IFLNK */
3320 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3321 doc: /* Return t if FILENAME names an existing directory.
3322 Symbolic links to directories count as directories.
3323 See `file-symlink-p' to distinguish symlinks. */)
3324 (filename)
3325 Lisp_Object filename;
3327 register Lisp_Object absname;
3328 struct stat st;
3329 Lisp_Object handler;
3331 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3333 /* If the file name has special constructs in it,
3334 call the corresponding file handler. */
3335 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3336 if (!NILP (handler))
3337 return call2 (handler, Qfile_directory_p, absname);
3339 absname = ENCODE_FILE (absname);
3341 if (stat (SDATA (absname), &st) < 0)
3342 return Qnil;
3343 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3346 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3347 doc: /* Return t if file FILENAME names a directory you can open.
3348 For the value to be t, FILENAME must specify the name of a directory as a file,
3349 and the directory must allow you to open files in it. In order to use a
3350 directory as a buffer's current directory, this predicate must return true.
3351 A directory name spec may be given instead; then the value is t
3352 if the directory so specified exists and really is a readable and
3353 searchable directory. */)
3354 (filename)
3355 Lisp_Object filename;
3357 Lisp_Object handler;
3358 int tem;
3359 struct gcpro gcpro1;
3361 /* If the file name has special constructs in it,
3362 call the corresponding file handler. */
3363 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3364 if (!NILP (handler))
3365 return call2 (handler, Qfile_accessible_directory_p, filename);
3367 GCPRO1 (filename);
3368 tem = (NILP (Ffile_directory_p (filename))
3369 || NILP (Ffile_executable_p (filename)));
3370 UNGCPRO;
3371 return tem ? Qnil : Qt;
3374 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3375 doc: /* Return t if file FILENAME is the name of a regular file.
3376 This is the sort of file that holds an ordinary stream of data bytes. */)
3377 (filename)
3378 Lisp_Object filename;
3380 register Lisp_Object absname;
3381 struct stat st;
3382 Lisp_Object handler;
3384 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3386 /* If the file name has special constructs in it,
3387 call the corresponding file handler. */
3388 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3389 if (!NILP (handler))
3390 return call2 (handler, Qfile_regular_p, absname);
3392 absname = ENCODE_FILE (absname);
3394 #ifdef WINDOWSNT
3396 int result;
3397 Lisp_Object tem = Vw32_get_true_file_attributes;
3399 /* Tell stat to use expensive method to get accurate info. */
3400 Vw32_get_true_file_attributes = Qt;
3401 result = stat (SDATA (absname), &st);
3402 Vw32_get_true_file_attributes = tem;
3404 if (result < 0)
3405 return Qnil;
3406 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3408 #else
3409 if (stat (SDATA (absname), &st) < 0)
3410 return Qnil;
3411 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3412 #endif
3415 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3416 doc: /* Return mode bits of file named FILENAME, as an integer.
3417 Return nil, if file does not exist or is not accessible. */)
3418 (filename)
3419 Lisp_Object filename;
3421 Lisp_Object absname;
3422 struct stat st;
3423 Lisp_Object handler;
3425 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3427 /* If the file name has special constructs in it,
3428 call the corresponding file handler. */
3429 handler = Ffind_file_name_handler (absname, Qfile_modes);
3430 if (!NILP (handler))
3431 return call2 (handler, Qfile_modes, absname);
3433 absname = ENCODE_FILE (absname);
3435 if (stat (SDATA (absname), &st) < 0)
3436 return Qnil;
3437 #if defined (MSDOS) && __DJGPP__ < 2
3438 if (check_executable (SDATA (absname)))
3439 st.st_mode |= S_IEXEC;
3440 #endif /* MSDOS && __DJGPP__ < 2 */
3442 return make_number (st.st_mode & 07777);
3445 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3446 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3447 Only the 12 low bits of MODE are used. */)
3448 (filename, mode)
3449 Lisp_Object filename, mode;
3451 Lisp_Object absname, encoded_absname;
3452 Lisp_Object handler;
3454 absname = Fexpand_file_name (filename, current_buffer->directory);
3455 CHECK_NUMBER (mode);
3457 /* If the file name has special constructs in it,
3458 call the corresponding file handler. */
3459 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3460 if (!NILP (handler))
3461 return call3 (handler, Qset_file_modes, absname, mode);
3463 encoded_absname = ENCODE_FILE (absname);
3465 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3466 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3468 return Qnil;
3471 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3472 doc: /* Set the file permission bits for newly created files.
3473 The argument MODE should be an integer; only the low 9 bits are used.
3474 This setting is inherited by subprocesses. */)
3475 (mode)
3476 Lisp_Object mode;
3478 CHECK_NUMBER (mode);
3480 umask ((~ XINT (mode)) & 0777);
3482 return Qnil;
3485 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3486 doc: /* Return the default file protection for created files.
3487 The value is an integer. */)
3490 int realmask;
3491 Lisp_Object value;
3493 realmask = umask (0);
3494 umask (realmask);
3496 XSETINT (value, (~ realmask) & 0777);
3497 return value;
3500 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3502 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3503 doc: /* Set times of file FILENAME to TIME.
3504 Set both access and modification times.
3505 Return t on success, else nil.
3506 Use the current time if TIME is nil. TIME is in the format of
3507 `current-time'. */)
3508 (filename, time)
3509 Lisp_Object filename, time;
3511 Lisp_Object absname, encoded_absname;
3512 Lisp_Object handler;
3513 time_t sec;
3514 int usec;
3516 if (! lisp_time_argument (time, &sec, &usec))
3517 error ("Invalid time specification");
3519 absname = Fexpand_file_name (filename, current_buffer->directory);
3521 /* If the file name has special constructs in it,
3522 call the corresponding file handler. */
3523 handler = Ffind_file_name_handler (absname, Qset_file_times);
3524 if (!NILP (handler))
3525 return call3 (handler, Qset_file_times, absname, time);
3527 encoded_absname = ENCODE_FILE (absname);
3530 EMACS_TIME t;
3532 EMACS_SET_SECS (t, sec);
3533 EMACS_SET_USECS (t, usec);
3535 if (set_file_times (SDATA (encoded_absname), t, t))
3537 #ifdef DOS_NT
3538 struct stat st;
3540 /* Setting times on a directory always fails. */
3541 if (stat (SDATA (encoded_absname), &st) == 0
3542 && (st.st_mode & S_IFMT) == S_IFDIR)
3543 return Qnil;
3544 #endif
3545 report_file_error ("Setting file times", Fcons (absname, Qnil));
3546 return Qnil;
3550 return Qt;
3553 #ifdef __NetBSD__
3554 #define unix 42
3555 #endif
3557 #ifdef unix
3558 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3559 doc: /* Tell Unix to finish all pending disk updates. */)
3562 sync ();
3563 return Qnil;
3566 #endif /* unix */
3568 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3569 doc: /* Return t if file FILE1 is newer than file FILE2.
3570 If FILE1 does not exist, the answer is nil;
3571 otherwise, if FILE2 does not exist, the answer is t. */)
3572 (file1, file2)
3573 Lisp_Object file1, file2;
3575 Lisp_Object absname1, absname2;
3576 struct stat st;
3577 int mtime1;
3578 Lisp_Object handler;
3579 struct gcpro gcpro1, gcpro2;
3581 CHECK_STRING (file1);
3582 CHECK_STRING (file2);
3584 absname1 = Qnil;
3585 GCPRO2 (absname1, file2);
3586 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3587 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3588 UNGCPRO;
3590 /* If the file name has special constructs in it,
3591 call the corresponding file handler. */
3592 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3593 if (NILP (handler))
3594 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3595 if (!NILP (handler))
3596 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3598 GCPRO2 (absname1, absname2);
3599 absname1 = ENCODE_FILE (absname1);
3600 absname2 = ENCODE_FILE (absname2);
3601 UNGCPRO;
3603 if (stat (SDATA (absname1), &st) < 0)
3604 return Qnil;
3606 mtime1 = st.st_mtime;
3608 if (stat (SDATA (absname2), &st) < 0)
3609 return Qt;
3611 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3614 #ifdef DOS_NT
3615 Lisp_Object Qfind_buffer_file_type;
3616 #endif /* DOS_NT */
3618 #ifndef READ_BUF_SIZE
3619 #define READ_BUF_SIZE (64 << 10)
3620 #endif
3622 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3624 /* This function is called after Lisp functions to decide a coding
3625 system are called, or when they cause an error. Before they are
3626 called, the current buffer is set unibyte and it contains only a
3627 newly inserted text (thus the buffer was empty before the
3628 insertion).
3630 The functions may set markers, overlays, text properties, or even
3631 alter the buffer contents, change the current buffer.
3633 Here, we reset all those changes by:
3634 o set back the current buffer.
3635 o move all markers and overlays to BEG.
3636 o remove all text properties.
3637 o set back the buffer multibyteness. */
3639 static Lisp_Object
3640 decide_coding_unwind (unwind_data)
3641 Lisp_Object unwind_data;
3643 Lisp_Object multibyte, undo_list, buffer;
3645 multibyte = XCAR (unwind_data);
3646 unwind_data = XCDR (unwind_data);
3647 undo_list = XCAR (unwind_data);
3648 buffer = XCDR (unwind_data);
3650 if (current_buffer != XBUFFER (buffer))
3651 set_buffer_internal (XBUFFER (buffer));
3652 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3653 adjust_overlays_for_delete (BEG, Z - BEG);
3654 BUF_INTERVALS (current_buffer) = 0;
3655 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3657 /* Now we are safe to change the buffer's multibyteness directly. */
3658 current_buffer->enable_multibyte_characters = multibyte;
3659 current_buffer->undo_list = undo_list;
3661 return Qnil;
3665 /* Used to pass values from insert-file-contents to read_non_regular. */
3667 static int non_regular_fd;
3668 static int non_regular_inserted;
3669 static int non_regular_nbytes;
3672 /* Read from a non-regular file.
3673 Read non_regular_trytry bytes max from non_regular_fd.
3674 Non_regular_inserted specifies where to put the read bytes.
3675 Value is the number of bytes read. */
3677 static Lisp_Object
3678 read_non_regular ()
3680 int nbytes;
3682 immediate_quit = 1;
3683 QUIT;
3684 nbytes = emacs_read (non_regular_fd,
3685 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3686 non_regular_nbytes);
3687 immediate_quit = 0;
3688 return make_number (nbytes);
3692 /* Condition-case handler used when reading from non-regular files
3693 in insert-file-contents. */
3695 static Lisp_Object
3696 read_non_regular_quit ()
3698 return Qnil;
3702 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3703 1, 5, 0,
3704 doc: /* Insert contents of file FILENAME after point.
3705 Returns list of absolute file name and number of characters inserted.
3706 If second argument VISIT is non-nil, the buffer's visited filename
3707 and last save file modtime are set, and it is marked unmodified.
3708 If visiting and the file does not exist, visiting is completed
3709 before the error is signaled.
3710 The optional third and fourth arguments BEG and END
3711 specify what portion of the file to insert.
3712 These arguments count bytes in the file, not characters in the buffer.
3713 If VISIT is non-nil, BEG and END must be nil.
3715 If optional fifth argument REPLACE is non-nil,
3716 it means replace the current buffer contents (in the accessible portion)
3717 with the file contents. This is better than simply deleting and inserting
3718 the whole thing because (1) it preserves some marker positions
3719 and (2) it puts less data in the undo list.
3720 When REPLACE is non-nil, the value is the number of characters actually read,
3721 which is often less than the number of characters to be read.
3723 This does code conversion according to the value of
3724 `coding-system-for-read' or `file-coding-system-alist',
3725 and sets the variable `last-coding-system-used' to the coding system
3726 actually used. */)
3727 (filename, visit, beg, end, replace)
3728 Lisp_Object filename, visit, beg, end, replace;
3730 struct stat st;
3731 register int fd;
3732 int inserted = 0;
3733 register int how_much;
3734 register int unprocessed;
3735 int count = SPECPDL_INDEX ();
3736 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3737 Lisp_Object handler, val, insval, orig_filename;
3738 Lisp_Object p;
3739 int total = 0;
3740 int not_regular = 0;
3741 unsigned char read_buf[READ_BUF_SIZE];
3742 struct coding_system coding;
3743 unsigned char buffer[1 << 14];
3744 int replace_handled = 0;
3745 int set_coding_system = 0;
3746 int coding_system_decided = 0;
3747 int read_quit = 0;
3748 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3749 int we_locked_file = 0;
3751 if (current_buffer->base_buffer && ! NILP (visit))
3752 error ("Cannot do file visiting in an indirect buffer");
3754 if (!NILP (current_buffer->read_only))
3755 Fbarf_if_buffer_read_only ();
3757 val = Qnil;
3758 p = Qnil;
3759 orig_filename = Qnil;
3761 GCPRO4 (filename, val, p, orig_filename);
3763 CHECK_STRING (filename);
3764 filename = Fexpand_file_name (filename, Qnil);
3766 /* If the file name has special constructs in it,
3767 call the corresponding file handler. */
3768 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3769 if (!NILP (handler))
3771 val = call6 (handler, Qinsert_file_contents, filename,
3772 visit, beg, end, replace);
3773 if (CONSP (val) && CONSP (XCDR (val)))
3774 inserted = XINT (XCAR (XCDR (val)));
3775 goto handled;
3778 orig_filename = filename;
3779 filename = ENCODE_FILE (filename);
3781 fd = -1;
3783 #ifdef WINDOWSNT
3785 Lisp_Object tem = Vw32_get_true_file_attributes;
3787 /* Tell stat to use expensive method to get accurate info. */
3788 Vw32_get_true_file_attributes = Qt;
3789 total = stat (SDATA (filename), &st);
3790 Vw32_get_true_file_attributes = tem;
3792 if (total < 0)
3793 #else
3794 #ifndef APOLLO
3795 if (stat (SDATA (filename), &st) < 0)
3796 #else
3797 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3798 || fstat (fd, &st) < 0)
3799 #endif /* not APOLLO */
3800 #endif /* WINDOWSNT */
3802 if (fd >= 0) emacs_close (fd);
3803 badopen:
3804 if (NILP (visit))
3805 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3806 st.st_mtime = -1;
3807 how_much = 0;
3808 if (!NILP (Vcoding_system_for_read))
3809 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3810 goto notfound;
3813 #ifdef S_IFREG
3814 /* This code will need to be changed in order to work on named
3815 pipes, and it's probably just not worth it. So we should at
3816 least signal an error. */
3817 if (!S_ISREG (st.st_mode))
3819 not_regular = 1;
3821 if (! NILP (visit))
3822 goto notfound;
3824 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3825 Fsignal (Qfile_error,
3826 Fcons (build_string ("not a regular file"),
3827 Fcons (orig_filename, Qnil)));
3829 #endif
3831 if (fd < 0)
3832 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3833 goto badopen;
3835 /* Replacement should preserve point as it preserves markers. */
3836 if (!NILP (replace))
3837 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3839 record_unwind_protect (close_file_unwind, make_number (fd));
3841 /* Supposedly happens on VMS. */
3842 /* Can happen on any platform that uses long as type of off_t, but allows
3843 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3844 give a message suitable for the latter case. */
3845 if (! not_regular && st.st_size < 0)
3846 error ("Maximum buffer size exceeded");
3848 /* Prevent redisplay optimizations. */
3849 current_buffer->clip_changed = 1;
3851 if (!NILP (visit))
3853 if (!NILP (beg) || !NILP (end))
3854 error ("Attempt to visit less than an entire file");
3855 if (BEG < Z && NILP (replace))
3856 error ("Cannot do file visiting in a non-empty buffer");
3859 if (!NILP (beg))
3860 CHECK_NUMBER (beg);
3861 else
3862 XSETFASTINT (beg, 0);
3864 if (!NILP (end))
3865 CHECK_NUMBER (end);
3866 else
3868 if (! not_regular)
3870 XSETINT (end, st.st_size);
3872 /* Arithmetic overflow can occur if an Emacs integer cannot
3873 represent the file size, or if the calculations below
3874 overflow. The calculations below double the file size
3875 twice, so check that it can be multiplied by 4 safely. */
3876 if (XINT (end) != st.st_size
3877 || ((int) st.st_size * 4) / 4 != st.st_size)
3878 error ("Maximum buffer size exceeded");
3880 /* The file size returned from stat may be zero, but data
3881 may be readable nonetheless, for example when this is a
3882 file in the /proc filesystem. */
3883 if (st.st_size == 0)
3884 XSETINT (end, READ_BUF_SIZE);
3888 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3890 /* We use emacs-mule for auto saving... */
3891 setup_coding_system (Qemacs_mule, &coding);
3892 /* ... but with the special flag to indicate to read in a
3893 multibyte sequence for eight-bit-control char as is. */
3894 coding.flags = 1;
3895 coding.src_multibyte = 0;
3896 coding.dst_multibyte
3897 = !NILP (current_buffer->enable_multibyte_characters);
3898 coding.eol_type = CODING_EOL_LF;
3899 coding_system_decided = 1;
3901 else if (BEG < Z)
3903 /* Decide the coding system to use for reading the file now
3904 because we can't use an optimized method for handling
3905 `coding:' tag if the current buffer is not empty. */
3906 Lisp_Object val;
3907 val = Qnil;
3909 if (!NILP (Vcoding_system_for_read))
3910 val = Vcoding_system_for_read;
3911 else
3913 /* Don't try looking inside a file for a coding system
3914 specification if it is not seekable. */
3915 if (! not_regular && ! NILP (Vset_auto_coding_function))
3917 /* Find a coding system specified in the heading two
3918 lines or in the tailing several lines of the file.
3919 We assume that the 1K-byte and 3K-byte for heading
3920 and tailing respectively are sufficient for this
3921 purpose. */
3922 int nread;
3924 if (st.st_size <= (1024 * 4))
3925 nread = emacs_read (fd, read_buf, 1024 * 4);
3926 else
3928 nread = emacs_read (fd, read_buf, 1024);
3929 if (nread >= 0)
3931 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3932 report_file_error ("Setting file position",
3933 Fcons (orig_filename, Qnil));
3934 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3938 if (nread < 0)
3939 error ("IO error reading %s: %s",
3940 SDATA (orig_filename), emacs_strerror (errno));
3941 else if (nread > 0)
3943 struct buffer *prev = current_buffer;
3944 Lisp_Object buffer;
3945 struct buffer *buf;
3947 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3949 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3950 buf = XBUFFER (buffer);
3952 delete_all_overlays (buf);
3953 buf->directory = current_buffer->directory;
3954 buf->read_only = Qnil;
3955 buf->filename = Qnil;
3956 buf->undo_list = Qt;
3957 eassert (buf->overlays_before == NULL);
3958 eassert (buf->overlays_after == NULL);
3960 set_buffer_internal (buf);
3961 Ferase_buffer ();
3962 buf->enable_multibyte_characters = Qnil;
3964 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3965 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3966 val = call2 (Vset_auto_coding_function,
3967 filename, make_number (nread));
3968 set_buffer_internal (prev);
3970 /* Discard the unwind protect for recovering the
3971 current buffer. */
3972 specpdl_ptr--;
3974 /* Rewind the file for the actual read done later. */
3975 if (lseek (fd, 0, 0) < 0)
3976 report_file_error ("Setting file position",
3977 Fcons (orig_filename, Qnil));
3981 if (NILP (val))
3983 /* If we have not yet decided a coding system, check
3984 file-coding-system-alist. */
3985 Lisp_Object args[6], coding_systems;
3987 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3988 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3989 coding_systems = Ffind_operation_coding_system (6, args);
3990 if (CONSP (coding_systems))
3991 val = XCAR (coding_systems);
3995 setup_coding_system (Fcheck_coding_system (val), &coding);
3996 /* Ensure we set Vlast_coding_system_used. */
3997 set_coding_system = 1;
3999 if (NILP (current_buffer->enable_multibyte_characters)
4000 && ! NILP (val))
4001 /* We must suppress all character code conversion except for
4002 end-of-line conversion. */
4003 setup_raw_text_coding_system (&coding);
4005 coding.src_multibyte = 0;
4006 coding.dst_multibyte
4007 = !NILP (current_buffer->enable_multibyte_characters);
4008 coding_system_decided = 1;
4011 /* If requested, replace the accessible part of the buffer
4012 with the file contents. Avoid replacing text at the
4013 beginning or end of the buffer that matches the file contents;
4014 that preserves markers pointing to the unchanged parts.
4016 Here we implement this feature in an optimized way
4017 for the case where code conversion is NOT needed.
4018 The following if-statement handles the case of conversion
4019 in a less optimal way.
4021 If the code conversion is "automatic" then we try using this
4022 method and hope for the best.
4023 But if we discover the need for conversion, we give up on this method
4024 and let the following if-statement handle the replace job. */
4025 if (!NILP (replace)
4026 && BEGV < ZV
4027 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4029 /* same_at_start and same_at_end count bytes,
4030 because file access counts bytes
4031 and BEG and END count bytes. */
4032 int same_at_start = BEGV_BYTE;
4033 int same_at_end = ZV_BYTE;
4034 int overlap;
4035 /* There is still a possibility we will find the need to do code
4036 conversion. If that happens, we set this variable to 1 to
4037 give up on handling REPLACE in the optimized way. */
4038 int giveup_match_end = 0;
4040 if (XINT (beg) != 0)
4042 if (lseek (fd, XINT (beg), 0) < 0)
4043 report_file_error ("Setting file position",
4044 Fcons (orig_filename, Qnil));
4047 immediate_quit = 1;
4048 QUIT;
4049 /* Count how many chars at the start of the file
4050 match the text at the beginning of the buffer. */
4051 while (1)
4053 int nread, bufpos;
4055 nread = emacs_read (fd, buffer, sizeof buffer);
4056 if (nread < 0)
4057 error ("IO error reading %s: %s",
4058 SDATA (orig_filename), emacs_strerror (errno));
4059 else if (nread == 0)
4060 break;
4062 if (coding.type == coding_type_undecided)
4063 detect_coding (&coding, buffer, nread);
4064 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4065 /* We found that the file should be decoded somehow.
4066 Let's give up here. */
4068 giveup_match_end = 1;
4069 break;
4072 if (coding.eol_type == CODING_EOL_UNDECIDED)
4073 detect_eol (&coding, buffer, nread);
4074 if (coding.eol_type != CODING_EOL_UNDECIDED
4075 && coding.eol_type != CODING_EOL_LF)
4076 /* We found that the format of eol should be decoded.
4077 Let's give up here. */
4079 giveup_match_end = 1;
4080 break;
4083 bufpos = 0;
4084 while (bufpos < nread && same_at_start < ZV_BYTE
4085 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4086 same_at_start++, bufpos++;
4087 /* If we found a discrepancy, stop the scan.
4088 Otherwise loop around and scan the next bufferful. */
4089 if (bufpos != nread)
4090 break;
4092 immediate_quit = 0;
4093 /* If the file matches the buffer completely,
4094 there's no need to replace anything. */
4095 if (same_at_start - BEGV_BYTE == XINT (end))
4097 emacs_close (fd);
4098 specpdl_ptr--;
4099 /* Truncate the buffer to the size of the file. */
4100 del_range_1 (same_at_start, same_at_end, 0, 0);
4101 goto handled;
4103 immediate_quit = 1;
4104 QUIT;
4105 /* Count how many chars at the end of the file
4106 match the text at the end of the buffer. But, if we have
4107 already found that decoding is necessary, don't waste time. */
4108 while (!giveup_match_end)
4110 int total_read, nread, bufpos, curpos, trial;
4112 /* At what file position are we now scanning? */
4113 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4114 /* If the entire file matches the buffer tail, stop the scan. */
4115 if (curpos == 0)
4116 break;
4117 /* How much can we scan in the next step? */
4118 trial = min (curpos, sizeof buffer);
4119 if (lseek (fd, curpos - trial, 0) < 0)
4120 report_file_error ("Setting file position",
4121 Fcons (orig_filename, Qnil));
4123 total_read = nread = 0;
4124 while (total_read < trial)
4126 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4127 if (nread < 0)
4128 error ("IO error reading %s: %s",
4129 SDATA (orig_filename), emacs_strerror (errno));
4130 else if (nread == 0)
4131 break;
4132 total_read += nread;
4135 /* Scan this bufferful from the end, comparing with
4136 the Emacs buffer. */
4137 bufpos = total_read;
4139 /* Compare with same_at_start to avoid counting some buffer text
4140 as matching both at the file's beginning and at the end. */
4141 while (bufpos > 0 && same_at_end > same_at_start
4142 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4143 same_at_end--, bufpos--;
4145 /* If we found a discrepancy, stop the scan.
4146 Otherwise loop around and scan the preceding bufferful. */
4147 if (bufpos != 0)
4149 /* If this discrepancy is because of code conversion,
4150 we cannot use this method; giveup and try the other. */
4151 if (same_at_end > same_at_start
4152 && FETCH_BYTE (same_at_end - 1) >= 0200
4153 && ! NILP (current_buffer->enable_multibyte_characters)
4154 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4155 giveup_match_end = 1;
4156 break;
4159 if (nread == 0)
4160 break;
4162 immediate_quit = 0;
4164 if (! giveup_match_end)
4166 int temp;
4168 /* We win! We can handle REPLACE the optimized way. */
4170 /* Extend the start of non-matching text area to multibyte
4171 character boundary. */
4172 if (! NILP (current_buffer->enable_multibyte_characters))
4173 while (same_at_start > BEGV_BYTE
4174 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4175 same_at_start--;
4177 /* Extend the end of non-matching text area to multibyte
4178 character boundary. */
4179 if (! NILP (current_buffer->enable_multibyte_characters))
4180 while (same_at_end < ZV_BYTE
4181 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4182 same_at_end++;
4184 /* Don't try to reuse the same piece of text twice. */
4185 overlap = (same_at_start - BEGV_BYTE
4186 - (same_at_end + st.st_size - ZV));
4187 if (overlap > 0)
4188 same_at_end += overlap;
4190 /* Arrange to read only the nonmatching middle part of the file. */
4191 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4192 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4194 del_range_byte (same_at_start, same_at_end, 0);
4195 /* Insert from the file at the proper position. */
4196 temp = BYTE_TO_CHAR (same_at_start);
4197 SET_PT_BOTH (temp, same_at_start);
4199 /* If display currently starts at beginning of line,
4200 keep it that way. */
4201 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4202 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4204 replace_handled = 1;
4208 /* If requested, replace the accessible part of the buffer
4209 with the file contents. Avoid replacing text at the
4210 beginning or end of the buffer that matches the file contents;
4211 that preserves markers pointing to the unchanged parts.
4213 Here we implement this feature for the case where code conversion
4214 is needed, in a simple way that needs a lot of memory.
4215 The preceding if-statement handles the case of no conversion
4216 in a more optimized way. */
4217 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4219 int same_at_start = BEGV_BYTE;
4220 int same_at_end = ZV_BYTE;
4221 int overlap;
4222 int bufpos;
4223 /* Make sure that the gap is large enough. */
4224 int bufsize = 2 * st.st_size;
4225 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4226 int temp;
4228 /* First read the whole file, performing code conversion into
4229 CONVERSION_BUFFER. */
4231 if (lseek (fd, XINT (beg), 0) < 0)
4233 xfree (conversion_buffer);
4234 report_file_error ("Setting file position",
4235 Fcons (orig_filename, Qnil));
4238 total = st.st_size; /* Total bytes in the file. */
4239 how_much = 0; /* Bytes read from file so far. */
4240 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4241 unprocessed = 0; /* Bytes not processed in previous loop. */
4243 while (how_much < total)
4245 /* try is reserved in some compilers (Microsoft C) */
4246 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4247 unsigned char *destination = read_buf + unprocessed;
4248 int this;
4250 /* Allow quitting out of the actual I/O. */
4251 immediate_quit = 1;
4252 QUIT;
4253 this = emacs_read (fd, destination, trytry);
4254 immediate_quit = 0;
4256 if (this < 0 || this + unprocessed == 0)
4258 how_much = this;
4259 break;
4262 how_much += this;
4264 if (CODING_MAY_REQUIRE_DECODING (&coding))
4266 int require, result;
4268 this += unprocessed;
4270 /* If we are using more space than estimated,
4271 make CONVERSION_BUFFER bigger. */
4272 require = decoding_buffer_size (&coding, this);
4273 if (inserted + require + 2 * (total - how_much) > bufsize)
4275 bufsize = inserted + require + 2 * (total - how_much);
4276 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4279 /* Convert this batch with results in CONVERSION_BUFFER. */
4280 if (how_much >= total) /* This is the last block. */
4281 coding.mode |= CODING_MODE_LAST_BLOCK;
4282 if (coding.composing != COMPOSITION_DISABLED)
4283 coding_allocate_composition_data (&coding, BEGV);
4284 result = decode_coding (&coding, read_buf,
4285 conversion_buffer + inserted,
4286 this, bufsize - inserted);
4288 /* Save for next iteration whatever we didn't convert. */
4289 unprocessed = this - coding.consumed;
4290 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4291 if (!NILP (current_buffer->enable_multibyte_characters))
4292 this = coding.produced;
4293 else
4294 this = str_as_unibyte (conversion_buffer + inserted,
4295 coding.produced);
4298 inserted += this;
4301 /* At this point, INSERTED is how many characters (i.e. bytes)
4302 are present in CONVERSION_BUFFER.
4303 HOW_MUCH should equal TOTAL,
4304 or should be <= 0 if we couldn't read the file. */
4306 if (how_much < 0)
4308 xfree (conversion_buffer);
4309 coding_free_composition_data (&coding);
4310 if (how_much == -1)
4311 error ("IO error reading %s: %s",
4312 SDATA (orig_filename), emacs_strerror (errno));
4313 else if (how_much == -2)
4314 error ("maximum buffer size exceeded");
4317 /* Compare the beginning of the converted file
4318 with the buffer text. */
4320 bufpos = 0;
4321 while (bufpos < inserted && same_at_start < same_at_end
4322 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4323 same_at_start++, bufpos++;
4325 /* If the file matches the buffer completely,
4326 there's no need to replace anything. */
4328 if (bufpos == inserted)
4330 xfree (conversion_buffer);
4331 coding_free_composition_data (&coding);
4332 emacs_close (fd);
4333 specpdl_ptr--;
4334 /* Truncate the buffer to the size of the file. */
4335 del_range_byte (same_at_start, same_at_end, 0);
4336 inserted = 0;
4337 goto handled;
4340 /* Extend the start of non-matching text area to multibyte
4341 character boundary. */
4342 if (! NILP (current_buffer->enable_multibyte_characters))
4343 while (same_at_start > BEGV_BYTE
4344 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4345 same_at_start--;
4347 /* Scan this bufferful from the end, comparing with
4348 the Emacs buffer. */
4349 bufpos = inserted;
4351 /* Compare with same_at_start to avoid counting some buffer text
4352 as matching both at the file's beginning and at the end. */
4353 while (bufpos > 0 && same_at_end > same_at_start
4354 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4355 same_at_end--, bufpos--;
4357 /* Extend the end of non-matching text area to multibyte
4358 character boundary. */
4359 if (! NILP (current_buffer->enable_multibyte_characters))
4360 while (same_at_end < ZV_BYTE
4361 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4362 same_at_end++;
4364 /* Don't try to reuse the same piece of text twice. */
4365 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4366 if (overlap > 0)
4367 same_at_end += overlap;
4369 /* If display currently starts at beginning of line,
4370 keep it that way. */
4371 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4372 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4374 /* Replace the chars that we need to replace,
4375 and update INSERTED to equal the number of bytes
4376 we are taking from the file. */
4377 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4379 if (same_at_end != same_at_start)
4381 del_range_byte (same_at_start, same_at_end, 0);
4382 temp = GPT;
4383 same_at_start = GPT_BYTE;
4385 else
4387 temp = BYTE_TO_CHAR (same_at_start);
4389 /* Insert from the file at the proper position. */
4390 SET_PT_BOTH (temp, same_at_start);
4391 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4392 0, 0, 0);
4393 if (coding.cmp_data && coding.cmp_data->used)
4394 coding_restore_composition (&coding, Fcurrent_buffer ());
4395 coding_free_composition_data (&coding);
4397 /* Set `inserted' to the number of inserted characters. */
4398 inserted = PT - temp;
4400 xfree (conversion_buffer);
4401 emacs_close (fd);
4402 specpdl_ptr--;
4404 goto handled;
4407 if (! not_regular)
4409 register Lisp_Object temp;
4411 total = XINT (end) - XINT (beg);
4413 /* Make sure point-max won't overflow after this insertion. */
4414 XSETINT (temp, total);
4415 if (total != XINT (temp))
4416 error ("Maximum buffer size exceeded");
4418 else
4419 /* For a special file, all we can do is guess. */
4420 total = READ_BUF_SIZE;
4422 if (NILP (visit) && inserted > 0)
4424 #ifdef CLASH_DETECTION
4425 if (!NILP (current_buffer->file_truename)
4426 /* Make binding buffer-file-name to nil effective. */
4427 && !NILP (current_buffer->filename)
4428 && SAVE_MODIFF >= MODIFF)
4429 we_locked_file = 1;
4430 #endif /* CLASH_DETECTION */
4431 prepare_to_modify_buffer (GPT, GPT, NULL);
4434 move_gap (PT);
4435 if (GAP_SIZE < total)
4436 make_gap (total - GAP_SIZE);
4438 if (XINT (beg) != 0 || !NILP (replace))
4440 if (lseek (fd, XINT (beg), 0) < 0)
4441 report_file_error ("Setting file position",
4442 Fcons (orig_filename, Qnil));
4445 /* In the following loop, HOW_MUCH contains the total bytes read so
4446 far for a regular file, and not changed for a special file. But,
4447 before exiting the loop, it is set to a negative value if I/O
4448 error occurs. */
4449 how_much = 0;
4451 /* Total bytes inserted. */
4452 inserted = 0;
4454 /* Here, we don't do code conversion in the loop. It is done by
4455 code_convert_region after all data are read into the buffer. */
4457 int gap_size = GAP_SIZE;
4459 while (how_much < total)
4461 /* try is reserved in some compilers (Microsoft C) */
4462 int trytry = min (total - how_much, READ_BUF_SIZE);
4463 int this;
4465 if (not_regular)
4467 Lisp_Object val;
4469 /* Maybe make more room. */
4470 if (gap_size < trytry)
4472 make_gap (total - gap_size);
4473 gap_size = GAP_SIZE;
4476 /* Read from the file, capturing `quit'. When an
4477 error occurs, end the loop, and arrange for a quit
4478 to be signaled after decoding the text we read. */
4479 non_regular_fd = fd;
4480 non_regular_inserted = inserted;
4481 non_regular_nbytes = trytry;
4482 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4483 read_non_regular_quit);
4484 if (NILP (val))
4486 read_quit = 1;
4487 break;
4490 this = XINT (val);
4492 else
4494 /* Allow quitting out of the actual I/O. We don't make text
4495 part of the buffer until all the reading is done, so a C-g
4496 here doesn't do any harm. */
4497 immediate_quit = 1;
4498 QUIT;
4499 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4500 immediate_quit = 0;
4503 if (this <= 0)
4505 how_much = this;
4506 break;
4509 gap_size -= this;
4511 /* For a regular file, where TOTAL is the real size,
4512 count HOW_MUCH to compare with it.
4513 For a special file, where TOTAL is just a buffer size,
4514 so don't bother counting in HOW_MUCH.
4515 (INSERTED is where we count the number of characters inserted.) */
4516 if (! not_regular)
4517 how_much += this;
4518 inserted += this;
4522 /* Now we have read all the file data into the gap.
4523 If it was empty, undo marking the buffer modified. */
4525 if (inserted == 0)
4527 #ifdef CLASH_DETECTION
4528 if (we_locked_file)
4529 unlock_file (current_buffer->file_truename);
4530 #endif
4531 Vdeactivate_mark = old_Vdeactivate_mark;
4534 /* Make the text read part of the buffer. */
4535 GAP_SIZE -= inserted;
4536 GPT += inserted;
4537 GPT_BYTE += inserted;
4538 ZV += inserted;
4539 ZV_BYTE += inserted;
4540 Z += inserted;
4541 Z_BYTE += inserted;
4543 if (GAP_SIZE > 0)
4544 /* Put an anchor to ensure multi-byte form ends at gap. */
4545 *GPT_ADDR = 0;
4547 emacs_close (fd);
4549 /* Discard the unwind protect for closing the file. */
4550 specpdl_ptr--;
4552 if (how_much < 0)
4553 error ("IO error reading %s: %s",
4554 SDATA (orig_filename), emacs_strerror (errno));
4556 notfound:
4558 if (! coding_system_decided)
4560 /* The coding system is not yet decided. Decide it by an
4561 optimized method for handling `coding:' tag.
4563 Note that we can get here only if the buffer was empty
4564 before the insertion. */
4565 Lisp_Object val;
4566 val = Qnil;
4568 if (!NILP (Vcoding_system_for_read))
4569 val = Vcoding_system_for_read;
4570 else
4572 /* Since we are sure that the current buffer was empty
4573 before the insertion, we can toggle
4574 enable-multibyte-characters directly here without taking
4575 care of marker adjustment and byte combining problem. By
4576 this way, we can run Lisp program safely before decoding
4577 the inserted text. */
4578 Lisp_Object unwind_data;
4579 int count = SPECPDL_INDEX ();
4581 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4582 Fcons (current_buffer->undo_list,
4583 Fcurrent_buffer ()));
4584 current_buffer->enable_multibyte_characters = Qnil;
4585 current_buffer->undo_list = Qt;
4586 record_unwind_protect (decide_coding_unwind, unwind_data);
4588 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4590 val = call2 (Vset_auto_coding_function,
4591 filename, make_number (inserted));
4594 if (NILP (val))
4596 /* If the coding system is not yet decided, check
4597 file-coding-system-alist. */
4598 Lisp_Object args[6], coding_systems;
4600 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4601 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4602 coding_systems = Ffind_operation_coding_system (6, args);
4603 if (CONSP (coding_systems))
4604 val = XCAR (coding_systems);
4606 unbind_to (count, Qnil);
4607 inserted = Z_BYTE - BEG_BYTE;
4610 /* The following kludgy code is to avoid some compiler bug.
4611 We can't simply do
4612 setup_coding_system (val, &coding);
4613 on some system. */
4615 struct coding_system temp_coding;
4616 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4617 bcopy (&temp_coding, &coding, sizeof coding);
4619 /* Ensure we set Vlast_coding_system_used. */
4620 set_coding_system = 1;
4622 if (NILP (current_buffer->enable_multibyte_characters)
4623 && ! NILP (val))
4624 /* We must suppress all character code conversion except for
4625 end-of-line conversion. */
4626 setup_raw_text_coding_system (&coding);
4627 coding.src_multibyte = 0;
4628 coding.dst_multibyte
4629 = !NILP (current_buffer->enable_multibyte_characters);
4632 if (!NILP (visit)
4633 /* Can't do this if part of the buffer might be preserved. */
4634 && NILP (replace)
4635 && (coding.type == coding_type_no_conversion
4636 || coding.type == coding_type_raw_text))
4638 /* Visiting a file with these coding system makes the buffer
4639 unibyte. */
4640 current_buffer->enable_multibyte_characters = Qnil;
4641 coding.dst_multibyte = 0;
4644 if (inserted > 0 || coding.type == coding_type_ccl)
4646 if (CODING_MAY_REQUIRE_DECODING (&coding))
4648 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4649 &coding, 0, 0);
4650 inserted = coding.produced_char;
4652 else
4653 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4654 inserted);
4657 /* Now INSERTED is measured in characters. */
4659 #ifdef DOS_NT
4660 /* Use the conversion type to determine buffer-file-type
4661 (find-buffer-file-type is now used to help determine the
4662 conversion). */
4663 if ((coding.eol_type == CODING_EOL_UNDECIDED
4664 || coding.eol_type == CODING_EOL_LF)
4665 && ! CODING_REQUIRE_DECODING (&coding))
4666 current_buffer->buffer_file_type = Qt;
4667 else
4668 current_buffer->buffer_file_type = Qnil;
4669 #endif
4671 handled:
4673 if (!NILP (visit))
4675 if (!EQ (current_buffer->undo_list, Qt))
4676 current_buffer->undo_list = Qnil;
4677 #ifdef APOLLO
4678 stat (SDATA (filename), &st);
4679 #endif
4681 if (NILP (handler))
4683 current_buffer->modtime = st.st_mtime;
4684 current_buffer->filename = orig_filename;
4687 SAVE_MODIFF = MODIFF;
4688 current_buffer->auto_save_modified = MODIFF;
4689 XSETFASTINT (current_buffer->save_length, Z - BEG);
4690 #ifdef CLASH_DETECTION
4691 if (NILP (handler))
4693 if (!NILP (current_buffer->file_truename))
4694 unlock_file (current_buffer->file_truename);
4695 unlock_file (filename);
4697 #endif /* CLASH_DETECTION */
4698 if (not_regular)
4699 Fsignal (Qfile_error,
4700 Fcons (build_string ("not a regular file"),
4701 Fcons (orig_filename, Qnil)));
4704 if (set_coding_system)
4705 Vlast_coding_system_used = coding.symbol;
4707 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4709 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4710 visit);
4711 if (! NILP (insval))
4713 CHECK_NUMBER (insval);
4714 inserted = XFASTINT (insval);
4718 /* Decode file format */
4719 if (inserted > 0)
4721 int empty_undo_list_p = 0;
4723 /* If we're anyway going to discard undo information, don't
4724 record it in the first place. The buffer's undo list at this
4725 point is either nil or t when visiting a file. */
4726 if (!NILP (visit))
4728 empty_undo_list_p = NILP (current_buffer->undo_list);
4729 current_buffer->undo_list = Qt;
4732 insval = call3 (Qformat_decode,
4733 Qnil, make_number (inserted), visit);
4734 CHECK_NUMBER (insval);
4735 inserted = XFASTINT (insval);
4737 if (!NILP (visit))
4738 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4741 /* Call after-change hooks for the inserted text, aside from the case
4742 of normal visiting (not with REPLACE), which is done in a new buffer
4743 "before" the buffer is changed. */
4744 if (inserted > 0 && total > 0
4745 && (NILP (visit) || !NILP (replace)))
4747 signal_after_change (PT, 0, inserted);
4748 update_compositions (PT, PT, CHECK_BORDER);
4751 p = Vafter_insert_file_functions;
4752 while (CONSP (p))
4754 insval = call1 (XCAR (p), make_number (inserted));
4755 if (!NILP (insval))
4757 CHECK_NUMBER (insval);
4758 inserted = XFASTINT (insval);
4760 QUIT;
4761 p = XCDR (p);
4764 if (!NILP (visit)
4765 && current_buffer->modtime == -1)
4767 /* If visiting nonexistent file, return nil. */
4768 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4771 if (read_quit)
4772 Fsignal (Qquit, Qnil);
4774 /* ??? Retval needs to be dealt with in all cases consistently. */
4775 if (NILP (val))
4776 val = Fcons (orig_filename,
4777 Fcons (make_number (inserted),
4778 Qnil));
4780 RETURN_UNGCPRO (unbind_to (count, val));
4783 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4784 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4785 Lisp_Object, Lisp_Object));
4787 /* If build_annotations switched buffers, switch back to BUF.
4788 Kill the temporary buffer that was selected in the meantime.
4790 Since this kill only the last temporary buffer, some buffers remain
4791 not killed if build_annotations switched buffers more than once.
4792 -- K.Handa */
4794 static Lisp_Object
4795 build_annotations_unwind (buf)
4796 Lisp_Object buf;
4798 Lisp_Object tembuf;
4800 if (XBUFFER (buf) == current_buffer)
4801 return Qnil;
4802 tembuf = Fcurrent_buffer ();
4803 Fset_buffer (buf);
4804 Fkill_buffer (tembuf);
4805 return Qnil;
4808 /* Decide the coding-system to encode the data with. */
4810 void
4811 choose_write_coding_system (start, end, filename,
4812 append, visit, lockname, coding)
4813 Lisp_Object start, end, filename, append, visit, lockname;
4814 struct coding_system *coding;
4816 Lisp_Object val;
4818 if (auto_saving
4819 && NILP (Fstring_equal (current_buffer->filename,
4820 current_buffer->auto_save_file_name)))
4822 /* We use emacs-mule for auto saving... */
4823 setup_coding_system (Qemacs_mule, coding);
4824 /* ... but with the special flag to indicate not to strip off
4825 leading code of eight-bit-control chars. */
4826 coding->flags = 1;
4827 goto done_setup_coding;
4829 else if (!NILP (Vcoding_system_for_write))
4831 val = Vcoding_system_for_write;
4832 if (coding_system_require_warning
4833 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4834 /* Confirm that VAL can surely encode the current region. */
4835 val = call5 (Vselect_safe_coding_system_function,
4836 start, end, Fcons (Qt, Fcons (val, Qnil)),
4837 Qnil, filename);
4839 else
4841 /* If the variable `buffer-file-coding-system' is set locally,
4842 it means that the file was read with some kind of code
4843 conversion or the variable is explicitly set by users. We
4844 had better write it out with the same coding system even if
4845 `enable-multibyte-characters' is nil.
4847 If it is not set locally, we anyway have to convert EOL
4848 format if the default value of `buffer-file-coding-system'
4849 tells that it is not Unix-like (LF only) format. */
4850 int using_default_coding = 0;
4851 int force_raw_text = 0;
4853 val = current_buffer->buffer_file_coding_system;
4854 if (NILP (val)
4855 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4857 val = Qnil;
4858 if (NILP (current_buffer->enable_multibyte_characters))
4859 force_raw_text = 1;
4862 if (NILP (val))
4864 /* Check file-coding-system-alist. */
4865 Lisp_Object args[7], coding_systems;
4867 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4868 args[3] = filename; args[4] = append; args[5] = visit;
4869 args[6] = lockname;
4870 coding_systems = Ffind_operation_coding_system (7, args);
4871 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4872 val = XCDR (coding_systems);
4875 if (NILP (val)
4876 && !NILP (current_buffer->buffer_file_coding_system))
4878 /* If we still have not decided a coding system, use the
4879 default value of buffer-file-coding-system. */
4880 val = current_buffer->buffer_file_coding_system;
4881 using_default_coding = 1;
4884 if (!force_raw_text
4885 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4886 /* Confirm that VAL can surely encode the current region. */
4887 val = call5 (Vselect_safe_coding_system_function,
4888 start, end, val, Qnil, filename);
4890 setup_coding_system (Fcheck_coding_system (val), coding);
4891 if (coding->eol_type == CODING_EOL_UNDECIDED
4892 && !using_default_coding)
4894 if (! EQ (default_buffer_file_coding.symbol,
4895 buffer_defaults.buffer_file_coding_system))
4896 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4897 &default_buffer_file_coding);
4898 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4900 Lisp_Object subsidiaries;
4902 coding->eol_type = default_buffer_file_coding.eol_type;
4903 subsidiaries = Fget (coding->symbol, Qeol_type);
4904 if (VECTORP (subsidiaries)
4905 && XVECTOR (subsidiaries)->size == 3)
4906 coding->symbol
4907 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4911 if (force_raw_text)
4912 setup_raw_text_coding_system (coding);
4913 goto done_setup_coding;
4916 setup_coding_system (Fcheck_coding_system (val), coding);
4918 done_setup_coding:
4919 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4920 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4923 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4924 "r\nFWrite region to file: \ni\ni\ni\np",
4925 doc: /* Write current region into specified file.
4926 When called from a program, requires three arguments:
4927 START, END and FILENAME. START and END are normally buffer positions
4928 specifying the part of the buffer to write.
4929 If START is nil, that means to use the entire buffer contents.
4930 If START is a string, then output that string to the file
4931 instead of any buffer contents; END is ignored.
4933 Optional fourth argument APPEND if non-nil means
4934 append to existing file contents (if any). If it is an integer,
4935 seek to that offset in the file before writing.
4936 Optional fifth argument VISIT, if t or a string, means
4937 set the last-save-file-modtime of buffer to this file's modtime
4938 and mark buffer not modified.
4939 If VISIT is a string, it is a second file name;
4940 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4941 VISIT is also the file name to lock and unlock for clash detection.
4942 If VISIT is neither t nor nil nor a string,
4943 that means do not display the \"Wrote file\" message.
4944 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4945 use for locking and unlocking, overriding FILENAME and VISIT.
4946 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4947 for an existing file with the same name. If MUSTBENEW is `excl',
4948 that means to get an error if the file already exists; never overwrite.
4949 If MUSTBENEW is neither nil nor `excl', that means ask for
4950 confirmation before overwriting, but do go ahead and overwrite the file
4951 if the user confirms.
4953 This does code conversion according to the value of
4954 `coding-system-for-write', `buffer-file-coding-system', or
4955 `file-coding-system-alist', and sets the variable
4956 `last-coding-system-used' to the coding system actually used. */)
4957 (start, end, filename, append, visit, lockname, mustbenew)
4958 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4960 register int desc;
4961 int failure;
4962 int save_errno = 0;
4963 const unsigned char *fn;
4964 struct stat st;
4965 int tem;
4966 int count = SPECPDL_INDEX ();
4967 int count1;
4968 #ifdef VMS
4969 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4970 #endif /* VMS */
4971 Lisp_Object handler;
4972 Lisp_Object visit_file;
4973 Lisp_Object annotations;
4974 Lisp_Object encoded_filename;
4975 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4976 int quietly = !NILP (visit);
4977 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4978 struct buffer *given_buffer;
4979 #ifdef DOS_NT
4980 int buffer_file_type = O_BINARY;
4981 #endif /* DOS_NT */
4982 struct coding_system coding;
4984 if (current_buffer->base_buffer && visiting)
4985 error ("Cannot do file visiting in an indirect buffer");
4987 if (!NILP (start) && !STRINGP (start))
4988 validate_region (&start, &end);
4990 GCPRO5 (start, filename, visit, visit_file, lockname);
4992 filename = Fexpand_file_name (filename, Qnil);
4994 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4995 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4997 if (STRINGP (visit))
4998 visit_file = Fexpand_file_name (visit, Qnil);
4999 else
5000 visit_file = filename;
5002 if (NILP (lockname))
5003 lockname = visit_file;
5005 annotations = Qnil;
5007 /* If the file name has special constructs in it,
5008 call the corresponding file handler. */
5009 handler = Ffind_file_name_handler (filename, Qwrite_region);
5010 /* If FILENAME has no handler, see if VISIT has one. */
5011 if (NILP (handler) && STRINGP (visit))
5012 handler = Ffind_file_name_handler (visit, Qwrite_region);
5014 if (!NILP (handler))
5016 Lisp_Object val;
5017 val = call6 (handler, Qwrite_region, start, end,
5018 filename, append, visit);
5020 if (visiting)
5022 SAVE_MODIFF = MODIFF;
5023 XSETFASTINT (current_buffer->save_length, Z - BEG);
5024 current_buffer->filename = visit_file;
5026 UNGCPRO;
5027 return val;
5030 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5032 /* Special kludge to simplify auto-saving. */
5033 if (NILP (start))
5035 XSETFASTINT (start, BEG);
5036 XSETFASTINT (end, Z);
5037 Fwiden ();
5040 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5041 count1 = SPECPDL_INDEX ();
5043 given_buffer = current_buffer;
5045 if (!STRINGP (start))
5047 annotations = build_annotations (start, end);
5049 if (current_buffer != given_buffer)
5051 XSETFASTINT (start, BEGV);
5052 XSETFASTINT (end, ZV);
5056 UNGCPRO;
5058 GCPRO5 (start, filename, annotations, visit_file, lockname);
5060 /* Decide the coding-system to encode the data with.
5061 We used to make this choice before calling build_annotations, but that
5062 leads to problems when a write-annotate-function takes care of
5063 unsavable chars (as was the case with X-Symbol). */
5064 choose_write_coding_system (start, end, filename,
5065 append, visit, lockname, &coding);
5066 Vlast_coding_system_used = coding.symbol;
5068 given_buffer = current_buffer;
5069 if (! STRINGP (start))
5071 annotations = build_annotations_2 (start, end,
5072 coding.pre_write_conversion, annotations);
5073 if (current_buffer != given_buffer)
5075 XSETFASTINT (start, BEGV);
5076 XSETFASTINT (end, ZV);
5080 #ifdef CLASH_DETECTION
5081 if (!auto_saving)
5083 #if 0 /* This causes trouble for GNUS. */
5084 /* If we've locked this file for some other buffer,
5085 query before proceeding. */
5086 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5087 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5088 #endif
5090 lock_file (lockname);
5092 #endif /* CLASH_DETECTION */
5094 encoded_filename = ENCODE_FILE (filename);
5096 fn = SDATA (encoded_filename);
5097 desc = -1;
5098 if (!NILP (append))
5099 #ifdef DOS_NT
5100 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5101 #else /* not DOS_NT */
5102 desc = emacs_open (fn, O_WRONLY, 0);
5103 #endif /* not DOS_NT */
5105 if (desc < 0 && (NILP (append) || errno == ENOENT))
5106 #ifdef VMS
5107 if (auto_saving) /* Overwrite any previous version of autosave file */
5109 vms_truncate (fn); /* if fn exists, truncate to zero length */
5110 desc = emacs_open (fn, O_RDWR, 0);
5111 if (desc < 0)
5112 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5113 ? SDATA (current_buffer->filename) : 0,
5114 fn);
5116 else /* Write to temporary name and rename if no errors */
5118 Lisp_Object temp_name;
5119 temp_name = Ffile_name_directory (filename);
5121 if (!NILP (temp_name))
5123 temp_name = Fmake_temp_name (concat2 (temp_name,
5124 build_string ("$$SAVE$$")));
5125 fname = SDATA (filename);
5126 fn = SDATA (temp_name);
5127 desc = creat_copy_attrs (fname, fn);
5128 if (desc < 0)
5130 /* If we can't open the temporary file, try creating a new
5131 version of the original file. VMS "creat" creates a
5132 new version rather than truncating an existing file. */
5133 fn = fname;
5134 fname = 0;
5135 desc = creat (fn, 0666);
5136 #if 0 /* This can clobber an existing file and fail to replace it,
5137 if the user runs out of space. */
5138 if (desc < 0)
5140 /* We can't make a new version;
5141 try to truncate and rewrite existing version if any. */
5142 vms_truncate (fn);
5143 desc = emacs_open (fn, O_RDWR, 0);
5145 #endif
5148 else
5149 desc = creat (fn, 0666);
5151 #else /* not VMS */
5152 #ifdef DOS_NT
5153 desc = emacs_open (fn,
5154 O_WRONLY | O_CREAT | buffer_file_type
5155 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5156 S_IREAD | S_IWRITE);
5157 #else /* not DOS_NT */
5158 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5159 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5160 auto_saving ? auto_save_mode_bits : 0666);
5161 #endif /* not DOS_NT */
5162 #endif /* not VMS */
5164 if (desc < 0)
5166 #ifdef CLASH_DETECTION
5167 save_errno = errno;
5168 if (!auto_saving) unlock_file (lockname);
5169 errno = save_errno;
5170 #endif /* CLASH_DETECTION */
5171 UNGCPRO;
5172 report_file_error ("Opening output file", Fcons (filename, Qnil));
5175 record_unwind_protect (close_file_unwind, make_number (desc));
5177 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5179 long ret;
5181 if (NUMBERP (append))
5182 ret = lseek (desc, XINT (append), 1);
5183 else
5184 ret = lseek (desc, 0, 2);
5185 if (ret < 0)
5187 #ifdef CLASH_DETECTION
5188 if (!auto_saving) unlock_file (lockname);
5189 #endif /* CLASH_DETECTION */
5190 UNGCPRO;
5191 report_file_error ("Lseek error", Fcons (filename, Qnil));
5195 UNGCPRO;
5197 #ifdef VMS
5199 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5200 * if we do writes that don't end with a carriage return. Furthermore
5201 * it cannot handle writes of more then 16K. The modified
5202 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5203 * this EXCEPT for the last record (iff it doesn't end with a carriage
5204 * return). This implies that if your buffer doesn't end with a carriage
5205 * return, you get one free... tough. However it also means that if
5206 * we make two calls to sys_write (a la the following code) you can
5207 * get one at the gap as well. The easiest way to fix this (honest)
5208 * is to move the gap to the next newline (or the end of the buffer).
5209 * Thus this change.
5211 * Yech!
5213 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5214 move_gap (find_next_newline (GPT, 1));
5215 #else
5216 /* Whether VMS or not, we must move the gap to the next of newline
5217 when we must put designation sequences at beginning of line. */
5218 if (INTEGERP (start)
5219 && coding.type == coding_type_iso2022
5220 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5221 && GPT > BEG && GPT_ADDR[-1] != '\n')
5223 int opoint = PT, opoint_byte = PT_BYTE;
5224 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5225 move_gap_both (PT, PT_BYTE);
5226 SET_PT_BOTH (opoint, opoint_byte);
5228 #endif
5230 failure = 0;
5231 immediate_quit = 1;
5233 if (STRINGP (start))
5235 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5236 &annotations, &coding);
5237 save_errno = errno;
5239 else if (XINT (start) != XINT (end))
5241 tem = CHAR_TO_BYTE (XINT (start));
5243 if (XINT (start) < GPT)
5245 failure = 0 > a_write (desc, Qnil, XINT (start),
5246 min (GPT, XINT (end)) - XINT (start),
5247 &annotations, &coding);
5248 save_errno = errno;
5251 if (XINT (end) > GPT && !failure)
5253 tem = max (XINT (start), GPT);
5254 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5255 &annotations, &coding);
5256 save_errno = errno;
5259 else
5261 /* If file was empty, still need to write the annotations */
5262 coding.mode |= CODING_MODE_LAST_BLOCK;
5263 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5264 save_errno = errno;
5267 if (CODING_REQUIRE_FLUSHING (&coding)
5268 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5269 && ! failure)
5271 /* We have to flush out a data. */
5272 coding.mode |= CODING_MODE_LAST_BLOCK;
5273 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5274 save_errno = errno;
5277 immediate_quit = 0;
5279 #ifdef HAVE_FSYNC
5280 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5281 Disk full in NFS may be reported here. */
5282 /* mib says that closing the file will try to write as fast as NFS can do
5283 it, and that means the fsync here is not crucial for autosave files. */
5284 if (!auto_saving && fsync (desc) < 0)
5286 /* If fsync fails with EINTR, don't treat that as serious. */
5287 if (errno != EINTR)
5288 failure = 1, save_errno = errno;
5290 #endif
5292 /* Spurious "file has changed on disk" warnings have been
5293 observed on Suns as well.
5294 It seems that `close' can change the modtime, under nfs.
5296 (This has supposedly been fixed in Sunos 4,
5297 but who knows about all the other machines with NFS?) */
5298 #if 0
5300 /* On VMS and APOLLO, must do the stat after the close
5301 since closing changes the modtime. */
5302 #ifndef VMS
5303 #ifndef APOLLO
5304 /* Recall that #if defined does not work on VMS. */
5305 #define FOO
5306 fstat (desc, &st);
5307 #endif
5308 #endif
5309 #endif
5311 /* NFS can report a write failure now. */
5312 if (emacs_close (desc) < 0)
5313 failure = 1, save_errno = errno;
5315 #ifdef VMS
5316 /* If we wrote to a temporary name and had no errors, rename to real name. */
5317 if (fname)
5319 if (!failure)
5320 failure = (rename (fn, fname) != 0), save_errno = errno;
5321 fn = fname;
5323 #endif /* VMS */
5325 #ifndef FOO
5326 stat (fn, &st);
5327 #endif
5328 /* Discard the unwind protect for close_file_unwind. */
5329 specpdl_ptr = specpdl + count1;
5330 /* Restore the original current buffer. */
5331 visit_file = unbind_to (count, visit_file);
5333 #ifdef CLASH_DETECTION
5334 if (!auto_saving)
5335 unlock_file (lockname);
5336 #endif /* CLASH_DETECTION */
5338 /* Do this before reporting IO error
5339 to avoid a "file has changed on disk" warning on
5340 next attempt to save. */
5341 if (visiting)
5342 current_buffer->modtime = st.st_mtime;
5344 if (failure)
5345 error ("IO error writing %s: %s", SDATA (filename),
5346 emacs_strerror (save_errno));
5348 if (visiting)
5350 SAVE_MODIFF = MODIFF;
5351 XSETFASTINT (current_buffer->save_length, Z - BEG);
5352 current_buffer->filename = visit_file;
5353 update_mode_lines++;
5355 else if (quietly)
5357 if (auto_saving
5358 && ! NILP (Fstring_equal (current_buffer->filename,
5359 current_buffer->auto_save_file_name)))
5360 SAVE_MODIFF = MODIFF;
5362 return Qnil;
5365 if (!auto_saving)
5366 message_with_string ((INTEGERP (append)
5367 ? "Updated %s"
5368 : ! NILP (append)
5369 ? "Added to %s"
5370 : "Wrote %s"),
5371 visit_file, 1);
5373 return Qnil;
5376 Lisp_Object merge ();
5378 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5379 doc: /* Return t if (car A) is numerically less than (car B). */)
5380 (a, b)
5381 Lisp_Object a, b;
5383 return Flss (Fcar (a), Fcar (b));
5386 /* Build the complete list of annotations appropriate for writing out
5387 the text between START and END, by calling all the functions in
5388 write-region-annotate-functions and merging the lists they return.
5389 If one of these functions switches to a different buffer, we assume
5390 that buffer contains altered text. Therefore, the caller must
5391 make sure to restore the current buffer in all cases,
5392 as save-excursion would do. */
5394 static Lisp_Object
5395 build_annotations (start, end)
5396 Lisp_Object start, end;
5398 Lisp_Object annotations;
5399 Lisp_Object p, res;
5400 struct gcpro gcpro1, gcpro2;
5401 Lisp_Object original_buffer;
5402 int i, used_global = 0;
5404 XSETBUFFER (original_buffer, current_buffer);
5406 annotations = Qnil;
5407 p = Vwrite_region_annotate_functions;
5408 GCPRO2 (annotations, p);
5409 while (CONSP (p))
5411 struct buffer *given_buffer = current_buffer;
5412 if (EQ (Qt, XCAR (p)) && !used_global)
5413 { /* Use the global value of the hook. */
5414 Lisp_Object arg[2];
5415 used_global = 1;
5416 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5417 arg[1] = XCDR (p);
5418 p = Fappend (2, arg);
5419 continue;
5421 Vwrite_region_annotations_so_far = annotations;
5422 res = call2 (XCAR (p), start, end);
5423 /* If the function makes a different buffer current,
5424 assume that means this buffer contains altered text to be output.
5425 Reset START and END from the buffer bounds
5426 and discard all previous annotations because they should have
5427 been dealt with by this function. */
5428 if (current_buffer != given_buffer)
5430 XSETFASTINT (start, BEGV);
5431 XSETFASTINT (end, ZV);
5432 annotations = Qnil;
5434 Flength (res); /* Check basic validity of return value */
5435 annotations = merge (annotations, res, Qcar_less_than_car);
5436 p = XCDR (p);
5439 /* Now do the same for annotation functions implied by the file-format */
5440 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5441 p = current_buffer->auto_save_file_format;
5442 else
5443 p = current_buffer->file_format;
5444 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5446 struct buffer *given_buffer = current_buffer;
5448 Vwrite_region_annotations_so_far = annotations;
5450 /* Value is either a list of annotations or nil if the function
5451 has written annotations to a temporary buffer, which is now
5452 current. */
5453 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5454 original_buffer, make_number (i));
5455 if (current_buffer != given_buffer)
5457 XSETFASTINT (start, BEGV);
5458 XSETFASTINT (end, ZV);
5459 annotations = Qnil;
5462 if (CONSP (res))
5463 annotations = merge (annotations, res, Qcar_less_than_car);
5466 UNGCPRO;
5467 return annotations;
5470 static Lisp_Object
5471 build_annotations_2 (start, end, pre_write_conversion, annotations)
5472 Lisp_Object start, end, pre_write_conversion, annotations;
5474 struct gcpro gcpro1;
5475 Lisp_Object res;
5477 GCPRO1 (annotations);
5478 /* At last, do the same for the function PRE_WRITE_CONVERSION
5479 implied by the current coding-system. */
5480 if (!NILP (pre_write_conversion))
5482 struct buffer *given_buffer = current_buffer;
5483 Vwrite_region_annotations_so_far = annotations;
5484 res = call2 (pre_write_conversion, start, end);
5485 Flength (res);
5486 annotations = (current_buffer != given_buffer
5487 ? res
5488 : merge (annotations, res, Qcar_less_than_car));
5491 UNGCPRO;
5492 return annotations;
5495 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5496 If STRING is nil, POS is the character position in the current buffer.
5497 Intersperse with them the annotations from *ANNOT
5498 which fall within the range of POS to POS + NCHARS,
5499 each at its appropriate position.
5501 We modify *ANNOT by discarding elements as we use them up.
5503 The return value is negative in case of system call failure. */
5505 static int
5506 a_write (desc, string, pos, nchars, annot, coding)
5507 int desc;
5508 Lisp_Object string;
5509 register int nchars;
5510 int pos;
5511 Lisp_Object *annot;
5512 struct coding_system *coding;
5514 Lisp_Object tem;
5515 int nextpos;
5516 int lastpos = pos + nchars;
5518 while (NILP (*annot) || CONSP (*annot))
5520 tem = Fcar_safe (Fcar (*annot));
5521 nextpos = pos - 1;
5522 if (INTEGERP (tem))
5523 nextpos = XFASTINT (tem);
5525 /* If there are no more annotations in this range,
5526 output the rest of the range all at once. */
5527 if (! (nextpos >= pos && nextpos <= lastpos))
5528 return e_write (desc, string, pos, lastpos, coding);
5530 /* Output buffer text up to the next annotation's position. */
5531 if (nextpos > pos)
5533 if (0 > e_write (desc, string, pos, nextpos, coding))
5534 return -1;
5535 pos = nextpos;
5537 /* Output the annotation. */
5538 tem = Fcdr (Fcar (*annot));
5539 if (STRINGP (tem))
5541 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5542 return -1;
5544 *annot = Fcdr (*annot);
5546 return 0;
5549 #ifndef WRITE_BUF_SIZE
5550 #define WRITE_BUF_SIZE (16 * 1024)
5551 #endif
5553 /* Write text in the range START and END into descriptor DESC,
5554 encoding them with coding system CODING. If STRING is nil, START
5555 and END are character positions of the current buffer, else they
5556 are indexes to the string STRING. */
5558 static int
5559 e_write (desc, string, start, end, coding)
5560 int desc;
5561 Lisp_Object string;
5562 int start, end;
5563 struct coding_system *coding;
5565 register char *addr;
5566 register int nbytes;
5567 char buf[WRITE_BUF_SIZE];
5568 int return_val = 0;
5570 if (start >= end)
5571 coding->composing = COMPOSITION_DISABLED;
5572 if (coding->composing != COMPOSITION_DISABLED)
5573 coding_save_composition (coding, start, end, string);
5575 if (STRINGP (string))
5577 addr = SDATA (string);
5578 nbytes = SBYTES (string);
5579 coding->src_multibyte = STRING_MULTIBYTE (string);
5581 else if (start < end)
5583 /* It is assured that the gap is not in the range START and END-1. */
5584 addr = CHAR_POS_ADDR (start);
5585 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5586 coding->src_multibyte
5587 = !NILP (current_buffer->enable_multibyte_characters);
5589 else
5591 addr = "";
5592 nbytes = 0;
5593 coding->src_multibyte = 1;
5596 /* We used to have a code for handling selective display here. But,
5597 now it is handled within encode_coding. */
5598 while (1)
5600 int result;
5602 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5603 if (coding->produced > 0)
5605 coding->produced -= emacs_write (desc, buf, coding->produced);
5606 if (coding->produced)
5608 return_val = -1;
5609 break;
5612 nbytes -= coding->consumed;
5613 addr += coding->consumed;
5614 if (result == CODING_FINISH_INSUFFICIENT_SRC
5615 && nbytes > 0)
5617 /* The source text ends by an incomplete multibyte form.
5618 There's no way other than write it out as is. */
5619 nbytes -= emacs_write (desc, addr, nbytes);
5620 if (nbytes)
5622 return_val = -1;
5623 break;
5626 if (nbytes <= 0)
5627 break;
5628 start += coding->consumed_char;
5629 if (coding->cmp_data)
5630 coding_adjust_composition_offset (coding, start);
5633 if (coding->cmp_data)
5634 coding_free_composition_data (coding);
5636 return return_val;
5639 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5640 Sverify_visited_file_modtime, 1, 1, 0,
5641 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5642 This means that the file has not been changed since it was visited or saved.
5643 See Info node `(elisp)Modification Time' for more details. */)
5644 (buf)
5645 Lisp_Object buf;
5647 struct buffer *b;
5648 struct stat st;
5649 Lisp_Object handler;
5650 Lisp_Object filename;
5652 CHECK_BUFFER (buf);
5653 b = XBUFFER (buf);
5655 if (!STRINGP (b->filename)) return Qt;
5656 if (b->modtime == 0) return Qt;
5658 /* If the file name has special constructs in it,
5659 call the corresponding file handler. */
5660 handler = Ffind_file_name_handler (b->filename,
5661 Qverify_visited_file_modtime);
5662 if (!NILP (handler))
5663 return call2 (handler, Qverify_visited_file_modtime, buf);
5665 filename = ENCODE_FILE (b->filename);
5667 if (stat (SDATA (filename), &st) < 0)
5669 /* If the file doesn't exist now and didn't exist before,
5670 we say that it isn't modified, provided the error is a tame one. */
5671 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5672 st.st_mtime = -1;
5673 else
5674 st.st_mtime = 0;
5676 if (st.st_mtime == b->modtime
5677 /* If both are positive, accept them if they are off by one second. */
5678 || (st.st_mtime > 0 && b->modtime > 0
5679 && (st.st_mtime == b->modtime + 1
5680 || st.st_mtime == b->modtime - 1)))
5681 return Qt;
5682 return Qnil;
5685 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5686 Sclear_visited_file_modtime, 0, 0, 0,
5687 doc: /* Clear out records of last mod time of visited file.
5688 Next attempt to save will certainly not complain of a discrepancy. */)
5691 current_buffer->modtime = 0;
5692 return Qnil;
5695 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5696 Svisited_file_modtime, 0, 0, 0,
5697 doc: /* Return the current buffer's recorded visited file modification time.
5698 The value is a list of the form (HIGH LOW), like the time values
5699 that `file-attributes' returns. If the current buffer has no recorded
5700 file modification time, this function returns 0.
5701 See Info node `(elisp)Modification Time' for more details. */)
5704 Lisp_Object tcons;
5705 tcons = long_to_cons ((unsigned long) current_buffer->modtime);
5706 if (CONSP (tcons))
5707 return list2 (XCAR (tcons), XCDR (tcons));
5708 return tcons;
5711 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5712 Sset_visited_file_modtime, 0, 1, 0,
5713 doc: /* Update buffer's recorded modification time from the visited file's time.
5714 Useful if the buffer was not read from the file normally
5715 or if the file itself has been changed for some known benign reason.
5716 An argument specifies the modification time value to use
5717 \(instead of that of the visited file), in the form of a list
5718 \(HIGH . LOW) or (HIGH LOW). */)
5719 (time_list)
5720 Lisp_Object time_list;
5722 if (!NILP (time_list))
5723 current_buffer->modtime = cons_to_long (time_list);
5724 else
5726 register Lisp_Object filename;
5727 struct stat st;
5728 Lisp_Object handler;
5730 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5732 /* If the file name has special constructs in it,
5733 call the corresponding file handler. */
5734 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5735 if (!NILP (handler))
5736 /* The handler can find the file name the same way we did. */
5737 return call2 (handler, Qset_visited_file_modtime, Qnil);
5739 filename = ENCODE_FILE (filename);
5741 if (stat (SDATA (filename), &st) >= 0)
5742 current_buffer->modtime = st.st_mtime;
5745 return Qnil;
5748 Lisp_Object
5749 auto_save_error (error)
5750 Lisp_Object error;
5752 Lisp_Object args[3], msg;
5753 int i, nbytes;
5754 struct gcpro gcpro1;
5756 ring_bell ();
5758 args[0] = build_string ("Auto-saving %s: %s");
5759 args[1] = current_buffer->name;
5760 args[2] = Ferror_message_string (error);
5761 msg = Fformat (3, args);
5762 GCPRO1 (msg);
5763 nbytes = SBYTES (msg);
5765 for (i = 0; i < 3; ++i)
5767 if (i == 0)
5768 message2 (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5769 else
5770 message2_nolog (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5771 Fsleep_for (make_number (1), Qnil);
5774 UNGCPRO;
5775 return Qnil;
5778 Lisp_Object
5779 auto_save_1 ()
5781 struct stat st;
5782 Lisp_Object modes;
5784 auto_save_mode_bits = 0666;
5786 /* Get visited file's mode to become the auto save file's mode. */
5787 if (! NILP (current_buffer->filename))
5789 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5790 /* But make sure we can overwrite it later! */
5791 auto_save_mode_bits = st.st_mode | 0600;
5792 else if ((modes = Ffile_modes (current_buffer->filename),
5793 INTEGERP (modes)))
5794 /* Remote files don't cooperate with stat. */
5795 auto_save_mode_bits = XINT (modes) | 0600;
5798 return
5799 Fwrite_region (Qnil, Qnil,
5800 current_buffer->auto_save_file_name,
5801 Qnil, Qlambda, Qnil, Qnil);
5804 static Lisp_Object
5805 do_auto_save_unwind (stream) /* used as unwind-protect function */
5806 Lisp_Object stream;
5808 auto_saving = 0;
5809 if (!NILP (stream))
5810 fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
5811 | XFASTINT (XCDR (stream))));
5812 return Qnil;
5815 static Lisp_Object
5816 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5817 Lisp_Object value;
5819 minibuffer_auto_raise = XINT (value);
5820 return Qnil;
5823 static Lisp_Object
5824 do_auto_save_make_dir (dir)
5825 Lisp_Object dir;
5827 return call2 (Qmake_directory, dir, Qt);
5830 static Lisp_Object
5831 do_auto_save_eh (ignore)
5832 Lisp_Object ignore;
5834 return Qnil;
5837 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5838 doc: /* Auto-save all buffers that need it.
5839 This is all buffers that have auto-saving enabled
5840 and are changed since last auto-saved.
5841 Auto-saving writes the buffer into a file
5842 so that your editing is not lost if the system crashes.
5843 This file is not the file you visited; that changes only when you save.
5844 Normally we run the normal hook `auto-save-hook' before saving.
5846 A non-nil NO-MESSAGE argument means do not print any message if successful.
5847 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5848 (no_message, current_only)
5849 Lisp_Object no_message, current_only;
5851 struct buffer *old = current_buffer, *b;
5852 Lisp_Object tail, buf;
5853 int auto_saved = 0;
5854 int do_handled_files;
5855 Lisp_Object oquit;
5856 FILE *stream;
5857 Lisp_Object lispstream;
5858 int count = SPECPDL_INDEX ();
5859 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5860 int old_message_p = 0;
5861 struct gcpro gcpro1, gcpro2;
5863 if (max_specpdl_size < specpdl_size + 40)
5864 max_specpdl_size = specpdl_size + 40;
5866 if (minibuf_level)
5867 no_message = Qt;
5869 if (NILP (no_message))
5871 old_message_p = push_message ();
5872 record_unwind_protect (pop_message_unwind, Qnil);
5875 /* Ordinarily don't quit within this function,
5876 but don't make it impossible to quit (in case we get hung in I/O). */
5877 oquit = Vquit_flag;
5878 Vquit_flag = Qnil;
5880 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5881 point to non-strings reached from Vbuffer_alist. */
5883 if (!NILP (Vrun_hooks))
5884 call1 (Vrun_hooks, intern ("auto-save-hook"));
5886 if (STRINGP (Vauto_save_list_file_name))
5888 Lisp_Object listfile;
5890 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5892 /* Don't try to create the directory when shutting down Emacs,
5893 because creating the directory might signal an error, and
5894 that would leave Emacs in a strange state. */
5895 if (!NILP (Vrun_hooks))
5897 Lisp_Object dir;
5898 dir = Qnil;
5899 GCPRO2 (dir, listfile);
5900 dir = Ffile_name_directory (listfile);
5901 if (NILP (Ffile_directory_p (dir)))
5902 internal_condition_case_1 (do_auto_save_make_dir,
5903 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5904 do_auto_save_eh);
5905 UNGCPRO;
5908 stream = fopen (SDATA (listfile), "w");
5909 if (stream != NULL)
5911 /* Arrange to close that file whether or not we get an error.
5912 Also reset auto_saving to 0. */
5913 lispstream = Fcons (Qnil, Qnil);
5914 XSETCARFASTINT (lispstream, (EMACS_UINT)stream >> 16);
5915 XSETCDRFASTINT (lispstream, (EMACS_UINT)stream & 0xffff);
5917 else
5918 lispstream = Qnil;
5920 else
5922 stream = NULL;
5923 lispstream = Qnil;
5926 record_unwind_protect (do_auto_save_unwind, lispstream);
5927 record_unwind_protect (do_auto_save_unwind_1,
5928 make_number (minibuffer_auto_raise));
5929 minibuffer_auto_raise = 0;
5930 auto_saving = 1;
5932 /* On first pass, save all files that don't have handlers.
5933 On second pass, save all files that do have handlers.
5935 If Emacs is crashing, the handlers may tweak what is causing
5936 Emacs to crash in the first place, and it would be a shame if
5937 Emacs failed to autosave perfectly ordinary files because it
5938 couldn't handle some ange-ftp'd file. */
5940 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5941 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5943 buf = XCDR (XCAR (tail));
5944 b = XBUFFER (buf);
5946 /* Record all the buffers that have auto save mode
5947 in the special file that lists them. For each of these buffers,
5948 Record visited name (if any) and auto save name. */
5949 if (STRINGP (b->auto_save_file_name)
5950 && stream != NULL && do_handled_files == 0)
5952 if (!NILP (b->filename))
5954 fwrite (SDATA (b->filename), 1,
5955 SBYTES (b->filename), stream);
5957 putc ('\n', stream);
5958 fwrite (SDATA (b->auto_save_file_name), 1,
5959 SBYTES (b->auto_save_file_name), stream);
5960 putc ('\n', stream);
5963 if (!NILP (current_only)
5964 && b != current_buffer)
5965 continue;
5967 /* Don't auto-save indirect buffers.
5968 The base buffer takes care of it. */
5969 if (b->base_buffer)
5970 continue;
5972 /* Check for auto save enabled
5973 and file changed since last auto save
5974 and file changed since last real save. */
5975 if (STRINGP (b->auto_save_file_name)
5976 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5977 && b->auto_save_modified < BUF_MODIFF (b)
5978 /* -1 means we've turned off autosaving for a while--see below. */
5979 && XINT (b->save_length) >= 0
5980 && (do_handled_files
5981 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5982 Qwrite_region))))
5984 EMACS_TIME before_time, after_time;
5986 EMACS_GET_TIME (before_time);
5988 /* If we had a failure, don't try again for 20 minutes. */
5989 if (b->auto_save_failure_time >= 0
5990 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5991 continue;
5993 if ((XFASTINT (b->save_length) * 10
5994 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5995 /* A short file is likely to change a large fraction;
5996 spare the user annoying messages. */
5997 && XFASTINT (b->save_length) > 5000
5998 /* These messages are frequent and annoying for `*mail*'. */
5999 && !EQ (b->filename, Qnil)
6000 && NILP (no_message))
6002 /* It has shrunk too much; turn off auto-saving here. */
6003 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6004 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6005 b->name, 1);
6006 minibuffer_auto_raise = 0;
6007 /* Turn off auto-saving until there's a real save,
6008 and prevent any more warnings. */
6009 XSETINT (b->save_length, -1);
6010 Fsleep_for (make_number (1), Qnil);
6011 continue;
6013 set_buffer_internal (b);
6014 if (!auto_saved && NILP (no_message))
6015 message1 ("Auto-saving...");
6016 internal_condition_case (auto_save_1, Qt, auto_save_error);
6017 auto_saved++;
6018 b->auto_save_modified = BUF_MODIFF (b);
6019 XSETFASTINT (current_buffer->save_length, Z - BEG);
6020 set_buffer_internal (old);
6022 EMACS_GET_TIME (after_time);
6024 /* If auto-save took more than 60 seconds,
6025 assume it was an NFS failure that got a timeout. */
6026 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6027 b->auto_save_failure_time = EMACS_SECS (after_time);
6031 /* Prevent another auto save till enough input events come in. */
6032 record_auto_save ();
6034 if (auto_saved && NILP (no_message))
6036 if (old_message_p)
6038 /* If we are going to restore an old message,
6039 give time to read ours. */
6040 sit_for (1, 0, 0, 0, 0);
6041 restore_message ();
6043 else
6044 /* If we displayed a message and then restored a state
6045 with no message, leave a "done" message on the screen. */
6046 message1 ("Auto-saving...done");
6049 Vquit_flag = oquit;
6051 /* This restores the message-stack status. */
6052 unbind_to (count, Qnil);
6053 return Qnil;
6056 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6057 Sset_buffer_auto_saved, 0, 0, 0,
6058 doc: /* Mark current buffer as auto-saved with its current text.
6059 No auto-save file will be written until the buffer changes again. */)
6062 current_buffer->auto_save_modified = MODIFF;
6063 XSETFASTINT (current_buffer->save_length, Z - BEG);
6064 current_buffer->auto_save_failure_time = -1;
6065 return Qnil;
6068 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6069 Sclear_buffer_auto_save_failure, 0, 0, 0,
6070 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6073 current_buffer->auto_save_failure_time = -1;
6074 return Qnil;
6077 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6078 0, 0, 0,
6079 doc: /* Return t if current buffer has been auto-saved recently.
6080 More precisely, if it has been auto-saved since last read from or saved
6081 in the visited file. If the buffer has no visited file,
6082 then any auto-save counts as "recent". */)
6085 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6088 /* Reading and completing file names */
6089 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6091 /* In the string VAL, change each $ to $$ and return the result. */
6093 static Lisp_Object
6094 double_dollars (val)
6095 Lisp_Object val;
6097 register const unsigned char *old;
6098 register unsigned char *new;
6099 register int n;
6100 int osize, count;
6102 osize = SBYTES (val);
6104 /* Count the number of $ characters. */
6105 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6106 if (*old++ == '$') count++;
6107 if (count > 0)
6109 old = SDATA (val);
6110 val = make_uninit_multibyte_string (SCHARS (val) + count,
6111 osize + count);
6112 new = SDATA (val);
6113 for (n = osize; n > 0; n--)
6114 if (*old != '$')
6115 *new++ = *old++;
6116 else
6118 *new++ = '$';
6119 *new++ = '$';
6120 old++;
6123 return val;
6126 static Lisp_Object
6127 read_file_name_cleanup (arg)
6128 Lisp_Object arg;
6130 return (current_buffer->directory = arg);
6133 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6134 3, 3, 0,
6135 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6136 (string, dir, action)
6137 Lisp_Object string, dir, action;
6138 /* action is nil for complete, t for return list of completions,
6139 lambda for verify final value */
6141 Lisp_Object name, specdir, realdir, val, orig_string;
6142 int changed;
6143 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6145 CHECK_STRING (string);
6147 realdir = dir;
6148 name = string;
6149 orig_string = Qnil;
6150 specdir = Qnil;
6151 changed = 0;
6152 /* No need to protect ACTION--we only compare it with t and nil. */
6153 GCPRO5 (string, realdir, name, specdir, orig_string);
6155 if (SCHARS (string) == 0)
6157 if (EQ (action, Qlambda))
6159 UNGCPRO;
6160 return Qnil;
6163 else
6165 orig_string = string;
6166 string = Fsubstitute_in_file_name (string);
6167 changed = NILP (Fstring_equal (string, orig_string));
6168 name = Ffile_name_nondirectory (string);
6169 val = Ffile_name_directory (string);
6170 if (! NILP (val))
6171 realdir = Fexpand_file_name (val, realdir);
6174 if (NILP (action))
6176 specdir = Ffile_name_directory (string);
6177 val = Ffile_name_completion (name, realdir);
6178 UNGCPRO;
6179 if (!STRINGP (val))
6181 if (changed)
6182 return double_dollars (string);
6183 return val;
6186 if (!NILP (specdir))
6187 val = concat2 (specdir, val);
6188 #ifndef VMS
6189 return double_dollars (val);
6190 #else /* not VMS */
6191 return val;
6192 #endif /* not VMS */
6194 UNGCPRO;
6196 if (EQ (action, Qt))
6198 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6199 Lisp_Object comp;
6200 int count;
6202 if (NILP (Vread_file_name_predicate)
6203 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6204 return all;
6206 #ifndef VMS
6207 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6209 /* Brute-force speed up for directory checking:
6210 Discard strings which don't end in a slash. */
6211 for (comp = Qnil; CONSP (all); all = XCDR (all))
6213 Lisp_Object tem = XCAR (all);
6214 int len;
6215 if (STRINGP (tem) &&
6216 (len = SCHARS (tem), len > 0) &&
6217 IS_DIRECTORY_SEP (SREF (tem, len-1)))
6218 comp = Fcons (tem, comp);
6221 else
6222 #endif
6224 /* Must do it the hard (and slow) way. */
6225 GCPRO3 (all, comp, specdir);
6226 count = SPECPDL_INDEX ();
6227 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6228 current_buffer->directory = realdir;
6229 for (comp = Qnil; CONSP (all); all = XCDR (all))
6230 if (!NILP (call1 (Vread_file_name_predicate, XCAR (all))))
6231 comp = Fcons (XCAR (all), comp);
6232 unbind_to (count, Qnil);
6233 UNGCPRO;
6235 return Fnreverse (comp);
6238 /* Only other case actually used is ACTION = lambda */
6239 #ifdef VMS
6240 /* Supposedly this helps commands such as `cd' that read directory names,
6241 but can someone explain how it helps them? -- RMS */
6242 if (SCHARS (name) == 0)
6243 return Qt;
6244 #endif /* VMS */
6245 string = Fexpand_file_name (string, dir);
6246 if (!NILP (Vread_file_name_predicate))
6247 return call1 (Vread_file_name_predicate, string);
6248 return Ffile_exists_p (string);
6251 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6252 Snext_read_file_uses_dialog_p, 0, 0, 0,
6253 doc: /* Return t if a call to `read-file-name' will use a dialog.
6254 The return value is only relevant for a call to `read-file-name' that happens
6255 before any other event (mouse or keypress) is handeled. */)
6258 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6259 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6260 && use_dialog_box
6261 && use_file_dialog
6262 && have_menus_p ())
6263 return Qt;
6264 #endif
6265 return Qnil;
6268 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6269 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6270 Value is not expanded---you must call `expand-file-name' yourself.
6271 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6272 the same non-empty string that was inserted by this function.
6273 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6274 except that if INITIAL is specified, that combined with DIR is used.)
6275 If the user exits with an empty minibuffer, this function returns
6276 an empty string. (This can only happen if the user erased the
6277 pre-inserted contents or if `insert-default-directory' is nil.)
6278 Fourth arg MUSTMATCH non-nil means require existing file's name.
6279 Non-nil and non-t means also require confirmation after completion.
6280 Fifth arg INITIAL specifies text to start with.
6281 If optional sixth arg PREDICATE is non-nil, possible completions and
6282 the resulting file name must satisfy (funcall PREDICATE NAME).
6283 DIR should be an absolute directory name. It defaults to the value of
6284 `default-directory'.
6286 If this command was invoked with the mouse, use a file dialog box if
6287 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6288 provides a file dialog box.
6290 See also `read-file-name-completion-ignore-case'
6291 and `read-file-name-function'. */)
6292 (prompt, dir, default_filename, mustmatch, initial, predicate)
6293 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6295 Lisp_Object val, insdef, tem;
6296 struct gcpro gcpro1, gcpro2;
6297 register char *homedir;
6298 Lisp_Object decoded_homedir;
6299 int replace_in_history = 0;
6300 int add_to_history = 0;
6301 int count;
6303 if (NILP (dir))
6304 dir = current_buffer->directory;
6305 if (NILP (Ffile_name_absolute_p (dir)))
6306 dir = Fexpand_file_name (dir, Qnil);
6307 if (NILP (default_filename))
6308 default_filename
6309 = (!NILP (initial)
6310 ? Fexpand_file_name (initial, dir)
6311 : current_buffer->filename);
6313 /* If dir starts with user's homedir, change that to ~. */
6314 homedir = (char *) egetenv ("HOME");
6315 #ifdef DOS_NT
6316 /* homedir can be NULL in temacs, since Vprocess_environment is not
6317 yet set up. We shouldn't crash in that case. */
6318 if (homedir != 0)
6320 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6321 CORRECT_DIR_SEPS (homedir);
6323 #endif
6324 if (homedir != 0)
6325 decoded_homedir
6326 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6327 if (homedir != 0
6328 && STRINGP (dir)
6329 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6330 SBYTES (decoded_homedir))
6331 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6333 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6334 dir = concat2 (build_string ("~"), dir);
6336 /* Likewise for default_filename. */
6337 if (homedir != 0
6338 && STRINGP (default_filename)
6339 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6340 SBYTES (decoded_homedir))
6341 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6343 default_filename
6344 = Fsubstring (default_filename,
6345 make_number (SCHARS (decoded_homedir)), Qnil);
6346 default_filename = concat2 (build_string ("~"), default_filename);
6348 if (!NILP (default_filename))
6350 CHECK_STRING (default_filename);
6351 default_filename = double_dollars (default_filename);
6354 if (insert_default_directory && STRINGP (dir))
6356 insdef = dir;
6357 if (!NILP (initial))
6359 Lisp_Object args[2], pos;
6361 args[0] = insdef;
6362 args[1] = initial;
6363 insdef = Fconcat (2, args);
6364 pos = make_number (SCHARS (double_dollars (dir)));
6365 insdef = Fcons (double_dollars (insdef), pos);
6367 else
6368 insdef = double_dollars (insdef);
6370 else if (STRINGP (initial))
6371 insdef = Fcons (double_dollars (initial), make_number (0));
6372 else
6373 insdef = Qnil;
6375 if (!NILP (Vread_file_name_function))
6377 Lisp_Object args[7];
6379 GCPRO2 (insdef, default_filename);
6380 args[0] = Vread_file_name_function;
6381 args[1] = prompt;
6382 args[2] = dir;
6383 args[3] = default_filename;
6384 args[4] = mustmatch;
6385 args[5] = initial;
6386 args[6] = predicate;
6387 RETURN_UNGCPRO (Ffuncall (7, args));
6390 count = SPECPDL_INDEX ();
6391 specbind (intern ("completion-ignore-case"),
6392 read_file_name_completion_ignore_case ? Qt : Qnil);
6393 specbind (intern ("minibuffer-completing-file-name"), Qt);
6394 specbind (intern ("read-file-name-predicate"),
6395 (NILP (predicate) ? Qfile_exists_p : predicate));
6397 GCPRO2 (insdef, default_filename);
6399 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6400 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6402 /* If DIR contains a file name, split it. */
6403 Lisp_Object file;
6404 file = Ffile_name_nondirectory (dir);
6405 if (SCHARS (file) && NILP (default_filename))
6407 default_filename = file;
6408 dir = Ffile_name_directory (dir);
6410 if (!NILP(default_filename))
6411 default_filename = Fexpand_file_name (default_filename, dir);
6412 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6413 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6414 add_to_history = 1;
6416 else
6417 #endif
6418 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6419 dir, mustmatch, insdef,
6420 Qfile_name_history, default_filename, Qnil);
6422 tem = Fsymbol_value (Qfile_name_history);
6423 if (CONSP (tem) && EQ (XCAR (tem), val))
6424 replace_in_history = 1;
6426 /* If Fcompleting_read returned the inserted default string itself
6427 (rather than a new string with the same contents),
6428 it has to mean that the user typed RET with the minibuffer empty.
6429 In that case, we really want to return ""
6430 so that commands such as set-visited-file-name can distinguish. */
6431 if (EQ (val, default_filename))
6433 /* In this case, Fcompleting_read has not added an element
6434 to the history. Maybe we should. */
6435 if (! replace_in_history)
6436 add_to_history = 1;
6438 val = empty_string;
6441 unbind_to (count, Qnil);
6442 UNGCPRO;
6443 if (NILP (val))
6444 error ("No file name specified");
6446 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6448 if (!NILP (tem) && !NILP (default_filename))
6449 val = default_filename;
6450 val = Fsubstitute_in_file_name (val);
6452 if (replace_in_history)
6453 /* Replace what Fcompleting_read added to the history
6454 with what we will actually return. */
6456 Lisp_Object val1 = double_dollars (val);
6457 tem = Fsymbol_value (Qfile_name_history);
6458 if (history_delete_duplicates)
6459 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6460 XSETCAR (tem, val1);
6462 else if (add_to_history)
6464 /* Add the value to the history--but not if it matches
6465 the last value already there. */
6466 Lisp_Object val1 = double_dollars (val);
6467 tem = Fsymbol_value (Qfile_name_history);
6468 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6470 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6471 Fset (Qfile_name_history, Fcons (val1, tem));
6475 return val;
6479 void
6480 init_fileio_once ()
6482 /* Must be set before any path manipulation is performed. */
6483 XSETFASTINT (Vdirectory_sep_char, '/');
6487 void
6488 syms_of_fileio ()
6490 Qoperations = intern ("operations");
6491 Qexpand_file_name = intern ("expand-file-name");
6492 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6493 Qdirectory_file_name = intern ("directory-file-name");
6494 Qfile_name_directory = intern ("file-name-directory");
6495 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6496 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6497 Qfile_name_as_directory = intern ("file-name-as-directory");
6498 Qcopy_file = intern ("copy-file");
6499 Qmake_directory_internal = intern ("make-directory-internal");
6500 Qmake_directory = intern ("make-directory");
6501 Qdelete_directory = intern ("delete-directory");
6502 Qdelete_file = intern ("delete-file");
6503 Qrename_file = intern ("rename-file");
6504 Qadd_name_to_file = intern ("add-name-to-file");
6505 Qmake_symbolic_link = intern ("make-symbolic-link");
6506 Qfile_exists_p = intern ("file-exists-p");
6507 Qfile_executable_p = intern ("file-executable-p");
6508 Qfile_readable_p = intern ("file-readable-p");
6509 Qfile_writable_p = intern ("file-writable-p");
6510 Qfile_symlink_p = intern ("file-symlink-p");
6511 Qaccess_file = intern ("access-file");
6512 Qfile_directory_p = intern ("file-directory-p");
6513 Qfile_regular_p = intern ("file-regular-p");
6514 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6515 Qfile_modes = intern ("file-modes");
6516 Qset_file_modes = intern ("set-file-modes");
6517 Qset_file_times = intern ("set-file-times");
6518 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6519 Qinsert_file_contents = intern ("insert-file-contents");
6520 Qwrite_region = intern ("write-region");
6521 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6522 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6523 Qauto_save_coding = intern ("auto-save-coding");
6525 staticpro (&Qoperations);
6526 staticpro (&Qexpand_file_name);
6527 staticpro (&Qsubstitute_in_file_name);
6528 staticpro (&Qdirectory_file_name);
6529 staticpro (&Qfile_name_directory);
6530 staticpro (&Qfile_name_nondirectory);
6531 staticpro (&Qunhandled_file_name_directory);
6532 staticpro (&Qfile_name_as_directory);
6533 staticpro (&Qcopy_file);
6534 staticpro (&Qmake_directory_internal);
6535 staticpro (&Qmake_directory);
6536 staticpro (&Qdelete_directory);
6537 staticpro (&Qdelete_file);
6538 staticpro (&Qrename_file);
6539 staticpro (&Qadd_name_to_file);
6540 staticpro (&Qmake_symbolic_link);
6541 staticpro (&Qfile_exists_p);
6542 staticpro (&Qfile_executable_p);
6543 staticpro (&Qfile_readable_p);
6544 staticpro (&Qfile_writable_p);
6545 staticpro (&Qaccess_file);
6546 staticpro (&Qfile_symlink_p);
6547 staticpro (&Qfile_directory_p);
6548 staticpro (&Qfile_regular_p);
6549 staticpro (&Qfile_accessible_directory_p);
6550 staticpro (&Qfile_modes);
6551 staticpro (&Qset_file_modes);
6552 staticpro (&Qset_file_times);
6553 staticpro (&Qfile_newer_than_file_p);
6554 staticpro (&Qinsert_file_contents);
6555 staticpro (&Qwrite_region);
6556 staticpro (&Qverify_visited_file_modtime);
6557 staticpro (&Qset_visited_file_modtime);
6558 staticpro (&Qauto_save_coding);
6560 Qfile_name_history = intern ("file-name-history");
6561 Fset (Qfile_name_history, Qnil);
6562 staticpro (&Qfile_name_history);
6564 Qfile_error = intern ("file-error");
6565 staticpro (&Qfile_error);
6566 Qfile_already_exists = intern ("file-already-exists");
6567 staticpro (&Qfile_already_exists);
6568 Qfile_date_error = intern ("file-date-error");
6569 staticpro (&Qfile_date_error);
6570 Qexcl = intern ("excl");
6571 staticpro (&Qexcl);
6573 #ifdef DOS_NT
6574 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6575 staticpro (&Qfind_buffer_file_type);
6576 #endif /* DOS_NT */
6578 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6579 doc: /* *Coding system for encoding file names.
6580 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6581 Vfile_name_coding_system = Qnil;
6583 DEFVAR_LISP ("default-file-name-coding-system",
6584 &Vdefault_file_name_coding_system,
6585 doc: /* Default coding system for encoding file names.
6586 This variable is used only when `file-name-coding-system' is nil.
6588 This variable is set/changed by the command `set-language-environment'.
6589 User should not set this variable manually,
6590 instead use `file-name-coding-system' to get a constant encoding
6591 of file names regardless of the current language environment. */);
6592 Vdefault_file_name_coding_system = Qnil;
6594 Qformat_decode = intern ("format-decode");
6595 staticpro (&Qformat_decode);
6596 Qformat_annotate_function = intern ("format-annotate-function");
6597 staticpro (&Qformat_annotate_function);
6598 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6599 staticpro (&Qafter_insert_file_set_coding);
6601 Qcar_less_than_car = intern ("car-less-than-car");
6602 staticpro (&Qcar_less_than_car);
6604 Fput (Qfile_error, Qerror_conditions,
6605 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
6606 Fput (Qfile_error, Qerror_message,
6607 build_string ("File error"));
6609 Fput (Qfile_already_exists, Qerror_conditions,
6610 Fcons (Qfile_already_exists,
6611 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6612 Fput (Qfile_already_exists, Qerror_message,
6613 build_string ("File already exists"));
6615 Fput (Qfile_date_error, Qerror_conditions,
6616 Fcons (Qfile_date_error,
6617 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6618 Fput (Qfile_date_error, Qerror_message,
6619 build_string ("Cannot set file date"));
6621 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6622 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6623 Vread_file_name_function = Qnil;
6625 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6626 doc: /* Current predicate used by `read-file-name-internal'. */);
6627 Vread_file_name_predicate = Qnil;
6629 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6630 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6631 #if defined VMS || defined DOS_NT || defined MAC_OS
6632 read_file_name_completion_ignore_case = 1;
6633 #else
6634 read_file_name_completion_ignore_case = 0;
6635 #endif
6637 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6638 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6639 If the initial minibuffer contents are non-empty, you can usually
6640 request a default filename by typing RETURN without editing. For some
6641 commands, exiting with an empty minibuffer has a special meaning,
6642 such as making the current buffer visit no file in the case of
6643 `set-visited-file-name'.
6644 If this variable is non-nil, the minibuffer contents are always
6645 initially non-empty and typing RETURN without editing will fetch the
6646 default name, if one is provided. Note however that this default name
6647 is not necessarily the name originally inserted in the minibuffer, if
6648 that is just the default directory.
6649 If this variable is nil, the minibuffer often starts out empty. In
6650 that case you may have to explicitly fetch the next history element to
6651 request the default name. */);
6652 insert_default_directory = 1;
6654 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6655 doc: /* *Non-nil means write new files with record format `stmlf'.
6656 nil means use format `var'. This variable is meaningful only on VMS. */);
6657 vms_stmlf_recfm = 0;
6659 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6660 doc: /* Directory separator character for built-in functions that return file names.
6661 The value is always ?/. Don't use this variable, just use `/'. */);
6663 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6664 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6665 If a file name matches REGEXP, then all I/O on that file is done by calling
6666 HANDLER.
6668 The first argument given to HANDLER is the name of the I/O primitive
6669 to be handled; the remaining arguments are the arguments that were
6670 passed to that primitive. For example, if you do
6671 (file-exists-p FILENAME)
6672 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6673 (funcall HANDLER 'file-exists-p FILENAME)
6674 The function `find-file-name-handler' checks this list for a handler
6675 for its argument. */);
6676 Vfile_name_handler_alist = Qnil;
6678 DEFVAR_LISP ("set-auto-coding-function",
6679 &Vset_auto_coding_function,
6680 doc: /* If non-nil, a function to call to decide a coding system of file.
6681 Two arguments are passed to this function: the file name
6682 and the length of a file contents following the point.
6683 This function should return a coding system to decode the file contents.
6684 It should check the file name against `auto-coding-alist'.
6685 If no coding system is decided, it should check a coding system
6686 specified in the heading lines with the format:
6687 -*- ... coding: CODING-SYSTEM; ... -*-
6688 or local variable spec of the tailing lines with `coding:' tag. */);
6689 Vset_auto_coding_function = Qnil;
6691 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6692 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6693 Each is passed one argument, the number of characters inserted.
6694 It should return the new character count, and leave point the same.
6695 If `insert-file-contents' is intercepted by a handler from
6696 `file-name-handler-alist', that handler is responsible for calling the
6697 functions in `after-insert-file-functions' if appropriate. */);
6698 Vafter_insert_file_functions = Qnil;
6700 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6701 doc: /* A list of functions to be called at the start of `write-region'.
6702 Each is passed two arguments, START and END as for `write-region'.
6703 These are usually two numbers but not always; see the documentation
6704 for `write-region'. The function should return a list of pairs
6705 of the form (POSITION . STRING), consisting of strings to be effectively
6706 inserted at the specified positions of the file being written (1 means to
6707 insert before the first byte written). The POSITIONs must be sorted into
6708 increasing order. If there are several functions in the list, the several
6709 lists are merged destructively. Alternatively, the function can return
6710 with a different buffer current; in that case it should pay attention
6711 to the annotations returned by previous functions and listed in
6712 `write-region-annotations-so-far'.*/);
6713 Vwrite_region_annotate_functions = Qnil;
6714 staticpro (&Qwrite_region_annotate_functions);
6715 Qwrite_region_annotate_functions
6716 = intern ("write-region-annotate-functions");
6718 DEFVAR_LISP ("write-region-annotations-so-far",
6719 &Vwrite_region_annotations_so_far,
6720 doc: /* When an annotation function is called, this holds the previous annotations.
6721 These are the annotations made by other annotation functions
6722 that were already called. See also `write-region-annotate-functions'. */);
6723 Vwrite_region_annotations_so_far = Qnil;
6725 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6726 doc: /* A list of file name handlers that temporarily should not be used.
6727 This applies only to the operation `inhibit-file-name-operation'. */);
6728 Vinhibit_file_name_handlers = Qnil;
6730 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6731 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6732 Vinhibit_file_name_operation = Qnil;
6734 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6735 doc: /* File name in which we write a list of all auto save file names.
6736 This variable is initialized automatically from `auto-save-list-file-prefix'
6737 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6738 a non-nil value. */);
6739 Vauto_save_list_file_name = Qnil;
6741 defsubr (&Sfind_file_name_handler);
6742 defsubr (&Sfile_name_directory);
6743 defsubr (&Sfile_name_nondirectory);
6744 defsubr (&Sunhandled_file_name_directory);
6745 defsubr (&Sfile_name_as_directory);
6746 defsubr (&Sdirectory_file_name);
6747 defsubr (&Smake_temp_name);
6748 defsubr (&Sexpand_file_name);
6749 defsubr (&Ssubstitute_in_file_name);
6750 defsubr (&Scopy_file);
6751 defsubr (&Smake_directory_internal);
6752 defsubr (&Sdelete_directory);
6753 defsubr (&Sdelete_file);
6754 defsubr (&Srename_file);
6755 defsubr (&Sadd_name_to_file);
6756 #ifdef S_IFLNK
6757 defsubr (&Smake_symbolic_link);
6758 #endif /* S_IFLNK */
6759 #ifdef VMS
6760 defsubr (&Sdefine_logical_name);
6761 #endif /* VMS */
6762 #ifdef HPUX_NET
6763 defsubr (&Ssysnetunam);
6764 #endif /* HPUX_NET */
6765 defsubr (&Sfile_name_absolute_p);
6766 defsubr (&Sfile_exists_p);
6767 defsubr (&Sfile_executable_p);
6768 defsubr (&Sfile_readable_p);
6769 defsubr (&Sfile_writable_p);
6770 defsubr (&Saccess_file);
6771 defsubr (&Sfile_symlink_p);
6772 defsubr (&Sfile_directory_p);
6773 defsubr (&Sfile_accessible_directory_p);
6774 defsubr (&Sfile_regular_p);
6775 defsubr (&Sfile_modes);
6776 defsubr (&Sset_file_modes);
6777 defsubr (&Sset_file_times);
6778 defsubr (&Sset_default_file_modes);
6779 defsubr (&Sdefault_file_modes);
6780 defsubr (&Sfile_newer_than_file_p);
6781 defsubr (&Sinsert_file_contents);
6782 defsubr (&Swrite_region);
6783 defsubr (&Scar_less_than_car);
6784 defsubr (&Sverify_visited_file_modtime);
6785 defsubr (&Sclear_visited_file_modtime);
6786 defsubr (&Svisited_file_modtime);
6787 defsubr (&Sset_visited_file_modtime);
6788 defsubr (&Sdo_auto_save);
6789 defsubr (&Sset_buffer_auto_saved);
6790 defsubr (&Sclear_buffer_auto_save_failure);
6791 defsubr (&Srecent_auto_save_p);
6793 defsubr (&Sread_file_name_internal);
6794 defsubr (&Sread_file_name);
6795 defsubr (&Snext_read_file_uses_dialog_p);
6797 #ifdef unix
6798 defsubr (&Sunix_sync);
6799 #endif
6802 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6803 (do not change this comment) */