(thumbs-call-convert): Use call-process directly
[emacs.git] / src / fileio.c
blob19558fa332a11a15533a05b275b07896b3b3399d
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
24 #include <limits.h>
26 #ifdef HAVE_FCNTL_H
27 #include <fcntl.h>
28 #endif
30 #include <stdio.h>
31 #include <sys/types.h>
32 #include <sys/stat.h>
34 #ifdef HAVE_UNISTD_H
35 #include <unistd.h>
36 #endif
38 #if !defined (S_ISLNK) && defined (S_IFLNK)
39 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #endif
42 #if !defined (S_ISFIFO) && defined (S_IFIFO)
43 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #endif
46 #if !defined (S_ISREG) && defined (S_IFREG)
47 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
48 #endif
50 #ifdef HAVE_PWD_H
51 #include <pwd.h>
52 #endif
54 #include <ctype.h>
56 #ifdef VMS
57 #include "vmsdir.h"
58 #include <perror.h>
59 #include <stddef.h>
60 #include <string.h>
61 #endif
63 #include <errno.h>
65 #ifndef vax11c
66 #ifndef USE_CRT_DLL
67 extern int errno;
68 #endif
69 #endif
71 #ifdef APOLLO
72 #include <sys/time.h>
73 #endif
75 #include "lisp.h"
76 #include "intervals.h"
77 #include "buffer.h"
78 #include "charset.h"
79 #include "coding.h"
80 #include "window.h"
81 #include "blockinput.h"
82 #include "frame.h"
83 #include "dispextern.h"
85 #ifdef WINDOWSNT
86 #define NOMINMAX 1
87 #include <windows.h>
88 #include <stdlib.h>
89 #include <fcntl.h>
90 #endif /* not WINDOWSNT */
92 #ifdef MSDOS
93 #include "msdos.h"
94 #include <sys/param.h>
95 #if __DJGPP__ >= 2
96 #include <fcntl.h>
97 #include <string.h>
98 #endif
99 #endif
101 #ifdef DOS_NT
102 #define CORRECT_DIR_SEPS(s) \
103 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
104 else unixtodos_filename (s); \
105 } while (0)
106 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
107 redirector allows the six letters between 'Z' and 'a' as well. */
108 #ifdef MSDOS
109 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
110 #endif
111 #ifdef WINDOWSNT
112 #define IS_DRIVE(x) isalpha (x)
113 #endif
114 /* Need to lower-case the drive letter, or else expanded
115 filenames will sometimes compare inequal, because
116 `expand-file-name' doesn't always down-case the drive letter. */
117 #define DRIVE_LETTER(x) (tolower (x))
118 #endif
120 #ifdef VMS
121 #include <file.h>
122 #include <rmsdef.h>
123 #include <fab.h>
124 #include <nam.h>
125 #endif
127 #include "systime.h"
129 #ifdef HPUX
130 #include <netio.h>
131 #ifndef HPUX8
132 #ifndef HPUX9
133 #include <errnet.h>
134 #endif
135 #endif
136 #endif
138 #include "commands.h"
139 extern int use_dialog_box;
140 extern int use_file_dialog;
142 #ifndef O_WRONLY
143 #define O_WRONLY 1
144 #endif
146 #ifndef O_RDONLY
147 #define O_RDONLY 0
148 #endif
150 #ifndef S_ISLNK
151 # define lstat stat
152 #endif
154 #ifndef FILE_SYSTEM_CASE
155 #define FILE_SYSTEM_CASE(filename) (filename)
156 #endif
158 /* Nonzero during writing of auto-save files */
159 int auto_saving;
161 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
162 a new file with the same mode as the original */
163 int auto_save_mode_bits;
165 /* The symbol bound to coding-system-for-read when
166 insert-file-contents is called for recovering a file. This is not
167 an actual coding system name, but just an indicator to tell
168 insert-file-contents to use `emacs-mule' with a special flag for
169 auto saving and recovering a file. */
170 Lisp_Object Qauto_save_coding;
172 /* Coding system for file names, or nil if none. */
173 Lisp_Object Vfile_name_coding_system;
175 /* Coding system for file names used only when
176 Vfile_name_coding_system is nil. */
177 Lisp_Object Vdefault_file_name_coding_system;
179 /* Alist of elements (REGEXP . HANDLER) for file names
180 whose I/O is done with a special handler. */
181 Lisp_Object Vfile_name_handler_alist;
183 /* Property name of a file name handler,
184 which gives a list of operations it handles.. */
185 Lisp_Object Qoperations;
187 /* Lisp functions for translating file formats */
188 Lisp_Object Qformat_decode, Qformat_annotate_function;
190 /* Function to be called to decide a coding system of a reading file. */
191 Lisp_Object Vset_auto_coding_function;
193 /* Functions to be called to process text properties in inserted file. */
194 Lisp_Object Vafter_insert_file_functions;
196 /* Lisp function for setting buffer-file-coding-system and the
197 multibyteness of the current buffer after inserting a file. */
198 Lisp_Object Qafter_insert_file_set_coding;
200 /* Functions to be called to create text property annotations for file. */
201 Lisp_Object Vwrite_region_annotate_functions;
202 Lisp_Object Qwrite_region_annotate_functions;
204 /* During build_annotations, each time an annotation function is called,
205 this holds the annotations made by the previous functions. */
206 Lisp_Object Vwrite_region_annotations_so_far;
208 /* File name in which we write a list of all our auto save files. */
209 Lisp_Object Vauto_save_list_file_name;
211 /* Function to call to read a file name. */
212 Lisp_Object Vread_file_name_function;
214 /* Current predicate used by read_file_name_internal. */
215 Lisp_Object Vread_file_name_predicate;
217 /* Nonzero means completion ignores case when reading file name. */
218 int read_file_name_completion_ignore_case;
220 /* Nonzero means, when reading a filename in the minibuffer,
221 start out by inserting the default directory into the minibuffer. */
222 int insert_default_directory;
224 /* On VMS, nonzero means write new files with record format stmlf.
225 Zero means use var format. */
226 int vms_stmlf_recfm;
228 /* On NT, specifies the directory separator character, used (eg.) when
229 expanding file names. This can be bound to / or \. */
230 Lisp_Object Vdirectory_sep_char;
232 #ifdef HAVE_FSYNC
233 /* Nonzero means skip the call to fsync in Fwrite-region. */
234 int write_region_inhibit_fsync;
235 #endif
237 extern Lisp_Object Vuser_login_name;
239 #ifdef WINDOWSNT
240 extern Lisp_Object Vw32_get_true_file_attributes;
241 #endif
243 extern int minibuf_level;
245 extern int minibuffer_auto_raise;
247 extern int history_delete_duplicates;
249 /* These variables describe handlers that have "already" had a chance
250 to handle the current operation.
252 Vinhibit_file_name_handlers is a list of file name handlers.
253 Vinhibit_file_name_operation is the operation being handled.
254 If we try to handle that operation, we ignore those handlers. */
256 static Lisp_Object Vinhibit_file_name_handlers;
257 static Lisp_Object Vinhibit_file_name_operation;
259 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
260 Lisp_Object Qexcl;
261 Lisp_Object Qfile_name_history;
263 Lisp_Object Qcar_less_than_car;
265 static int a_write P_ ((int, Lisp_Object, int, int,
266 Lisp_Object *, struct coding_system *));
267 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
270 void
271 report_file_error (string, data)
272 const char *string;
273 Lisp_Object data;
275 Lisp_Object errstring;
276 int errorno = errno;
278 synchronize_system_messages_locale ();
279 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
280 Vlocale_coding_system, 0);
282 while (1)
283 switch (errorno)
285 case EEXIST:
286 xsignal (Qfile_already_exists, Fcons (errstring, data));
287 break;
288 default:
289 /* System error messages are capitalized. Downcase the initial
290 unless it is followed by a slash. */
291 if (SREF (errstring, 1) != '/')
292 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
294 xsignal (Qfile_error,
295 Fcons (build_string (string), Fcons (errstring, data)));
299 Lisp_Object
300 close_file_unwind (fd)
301 Lisp_Object fd;
303 emacs_close (XFASTINT (fd));
304 return Qnil;
307 /* Restore point, having saved it as a marker. */
309 static Lisp_Object
310 restore_point_unwind (location)
311 Lisp_Object location;
313 Fgoto_char (location);
314 Fset_marker (location, Qnil, Qnil);
315 return Qnil;
318 Lisp_Object Qexpand_file_name;
319 Lisp_Object Qsubstitute_in_file_name;
320 Lisp_Object Qdirectory_file_name;
321 Lisp_Object Qfile_name_directory;
322 Lisp_Object Qfile_name_nondirectory;
323 Lisp_Object Qunhandled_file_name_directory;
324 Lisp_Object Qfile_name_as_directory;
325 Lisp_Object Qcopy_file;
326 Lisp_Object Qmake_directory_internal;
327 Lisp_Object Qmake_directory;
328 Lisp_Object Qdelete_directory;
329 Lisp_Object Qdelete_file;
330 Lisp_Object Qrename_file;
331 Lisp_Object Qadd_name_to_file;
332 Lisp_Object Qmake_symbolic_link;
333 Lisp_Object Qfile_exists_p;
334 Lisp_Object Qfile_executable_p;
335 Lisp_Object Qfile_readable_p;
336 Lisp_Object Qfile_writable_p;
337 Lisp_Object Qfile_symlink_p;
338 Lisp_Object Qaccess_file;
339 Lisp_Object Qfile_directory_p;
340 Lisp_Object Qfile_regular_p;
341 Lisp_Object Qfile_accessible_directory_p;
342 Lisp_Object Qfile_modes;
343 Lisp_Object Qset_file_modes;
344 Lisp_Object Qset_file_times;
345 Lisp_Object Qfile_newer_than_file_p;
346 Lisp_Object Qinsert_file_contents;
347 Lisp_Object Qwrite_region;
348 Lisp_Object Qverify_visited_file_modtime;
349 Lisp_Object Qset_visited_file_modtime;
351 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
352 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
353 Otherwise, return nil.
354 A file name is handled if one of the regular expressions in
355 `file-name-handler-alist' matches it.
357 If OPERATION equals `inhibit-file-name-operation', then we ignore
358 any handlers that are members of `inhibit-file-name-handlers',
359 but we still do run any other handlers. This lets handlers
360 use the standard functions without calling themselves recursively. */)
361 (filename, operation)
362 Lisp_Object filename, operation;
364 /* This function must not munge the match data. */
365 Lisp_Object chain, inhibited_handlers, result;
366 int pos = -1;
368 result = Qnil;
369 CHECK_STRING (filename);
371 if (EQ (operation, Vinhibit_file_name_operation))
372 inhibited_handlers = Vinhibit_file_name_handlers;
373 else
374 inhibited_handlers = Qnil;
376 for (chain = Vfile_name_handler_alist; CONSP (chain);
377 chain = XCDR (chain))
379 Lisp_Object elt;
380 elt = XCAR (chain);
381 if (CONSP (elt))
383 Lisp_Object string = XCAR (elt);
384 int match_pos;
385 Lisp_Object handler = XCDR (elt);
386 Lisp_Object operations = Qnil;
388 if (SYMBOLP (handler))
389 operations = Fget (handler, Qoperations);
391 if (STRINGP (string)
392 && (match_pos = fast_string_match (string, filename)) > pos
393 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
395 Lisp_Object tem;
397 handler = XCDR (elt);
398 tem = Fmemq (handler, inhibited_handlers);
399 if (NILP (tem))
401 result = handler;
402 pos = match_pos;
407 QUIT;
409 return result;
412 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
413 1, 1, 0,
414 doc: /* Return the directory component in file name FILENAME.
415 Return nil if FILENAME does not include a directory.
416 Otherwise return a directory spec.
417 Given a Unix syntax file name, returns a string ending in slash;
418 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
419 (filename)
420 Lisp_Object filename;
422 #ifndef DOS_NT
423 register const unsigned char *beg;
424 #else
425 register unsigned char *beg;
426 #endif
427 register const unsigned char *p;
428 Lisp_Object handler;
430 CHECK_STRING (filename);
432 /* If the file name has special constructs in it,
433 call the corresponding file handler. */
434 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
435 if (!NILP (handler))
436 return call2 (handler, Qfile_name_directory, filename);
438 filename = FILE_SYSTEM_CASE (filename);
439 beg = SDATA (filename);
440 #ifdef DOS_NT
441 beg = strcpy (alloca (strlen (beg) + 1), beg);
442 #endif
443 p = beg + SBYTES (filename);
445 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
446 #ifdef VMS
447 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
448 #endif /* VMS */
449 #ifdef DOS_NT
450 /* only recognise drive specifier at the beginning */
451 && !(p[-1] == ':'
452 /* handle the "/:d:foo" and "/:foo" cases correctly */
453 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
454 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
455 #endif
456 ) p--;
458 if (p == beg)
459 return Qnil;
460 #ifdef DOS_NT
461 /* Expansion of "c:" to drive and default directory. */
462 if (p[-1] == ':')
464 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
465 unsigned char *res = alloca (MAXPATHLEN + 1);
466 unsigned char *r = res;
468 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
470 strncpy (res, beg, 2);
471 beg += 2;
472 r += 2;
475 if (getdefdir (toupper (*beg) - 'A' + 1, r))
477 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
478 strcat (res, "/");
479 beg = res;
480 p = beg + strlen (beg);
483 CORRECT_DIR_SEPS (beg);
484 #endif /* DOS_NT */
486 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
489 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
490 Sfile_name_nondirectory, 1, 1, 0,
491 doc: /* Return file name FILENAME sans its directory.
492 For example, in a Unix-syntax file name,
493 this is everything after the last slash,
494 or the entire name if it contains no slash. */)
495 (filename)
496 Lisp_Object filename;
498 register const unsigned char *beg, *p, *end;
499 Lisp_Object handler;
501 CHECK_STRING (filename);
503 /* If the file name has special constructs in it,
504 call the corresponding file handler. */
505 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
506 if (!NILP (handler))
507 return call2 (handler, Qfile_name_nondirectory, filename);
509 beg = SDATA (filename);
510 end = p = beg + SBYTES (filename);
512 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
513 #ifdef VMS
514 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
515 #endif /* VMS */
516 #ifdef DOS_NT
517 /* only recognise drive specifier at beginning */
518 && !(p[-1] == ':'
519 /* handle the "/:d:foo" case correctly */
520 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
521 #endif
523 p--;
525 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
528 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
529 Sunhandled_file_name_directory, 1, 1, 0,
530 doc: /* Return a directly usable directory name somehow associated with FILENAME.
531 A `directly usable' directory name is one that may be used without the
532 intervention of any file handler.
533 If FILENAME is a directly usable file itself, return
534 \(file-name-directory FILENAME).
535 The `call-process' and `start-process' functions use this function to
536 get a current directory to run processes in. */)
537 (filename)
538 Lisp_Object filename;
540 Lisp_Object handler;
542 /* If the file name has special constructs in it,
543 call the corresponding file handler. */
544 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
545 if (!NILP (handler))
546 return call2 (handler, Qunhandled_file_name_directory, filename);
548 return Ffile_name_directory (filename);
552 char *
553 file_name_as_directory (out, in)
554 char *out, *in;
556 int size = strlen (in) - 1;
558 strcpy (out, in);
560 if (size < 0)
562 out[0] = '.';
563 out[1] = '/';
564 out[2] = 0;
565 return out;
568 #ifdef VMS
569 /* Is it already a directory string? */
570 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
571 return out;
572 /* Is it a VMS directory file name? If so, hack VMS syntax. */
573 else if (! index (in, '/')
574 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
575 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
576 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
577 || ! strncmp (&in[size - 5], ".dir", 4))
578 && (in[size - 1] == '.' || in[size - 1] == ';')
579 && in[size] == '1')))
581 register char *p, *dot;
582 char brack;
584 /* x.dir -> [.x]
585 dir:x.dir --> dir:[x]
586 dir:[x]y.dir --> dir:[x.y] */
587 p = in + size;
588 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
589 if (p != in)
591 strncpy (out, in, p - in);
592 out[p - in] = '\0';
593 if (*p == ':')
595 brack = ']';
596 strcat (out, ":[");
598 else
600 brack = *p;
601 strcat (out, ".");
603 p++;
605 else
607 brack = ']';
608 strcpy (out, "[.");
610 dot = index (p, '.');
611 if (dot)
613 /* blindly remove any extension */
614 size = strlen (out) + (dot - p);
615 strncat (out, p, dot - p);
617 else
619 strcat (out, p);
620 size = strlen (out);
622 out[size++] = brack;
623 out[size] = '\0';
625 #else /* not VMS */
626 /* For Unix syntax, Append a slash if necessary */
627 if (!IS_DIRECTORY_SEP (out[size]))
629 /* Cannot use DIRECTORY_SEP, which could have any value */
630 out[size + 1] = '/';
631 out[size + 2] = '\0';
633 #ifdef DOS_NT
634 CORRECT_DIR_SEPS (out);
635 #endif
636 #endif /* not VMS */
637 return out;
640 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
641 Sfile_name_as_directory, 1, 1, 0,
642 doc: /* Return a string representing the file name FILE interpreted as a directory.
643 This operation exists because a directory is also a file, but its name as
644 a directory is different from its name as a file.
645 The result can be used as the value of `default-directory'
646 or passed as second argument to `expand-file-name'.
647 For a Unix-syntax file name, just appends a slash.
648 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
649 (file)
650 Lisp_Object file;
652 char *buf;
653 Lisp_Object handler;
655 CHECK_STRING (file);
656 if (NILP (file))
657 return Qnil;
659 /* If the file name has special constructs in it,
660 call the corresponding file handler. */
661 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
662 if (!NILP (handler))
663 return call2 (handler, Qfile_name_as_directory, file);
665 buf = (char *) alloca (SBYTES (file) + 10);
666 file_name_as_directory (buf, SDATA (file));
667 return make_specified_string (buf, -1, strlen (buf),
668 STRING_MULTIBYTE (file));
672 * Convert from directory name to filename.
673 * On VMS:
674 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
675 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
676 * On UNIX, it's simple: just make sure there isn't a terminating /
678 * Value is nonzero if the string output is different from the input.
682 directory_file_name (src, dst)
683 char *src, *dst;
685 long slen;
686 #ifdef VMS
687 long rlen;
688 char * ptr, * rptr;
689 char bracket;
690 struct FAB fab = cc$rms_fab;
691 struct NAM nam = cc$rms_nam;
692 char esa[NAM$C_MAXRSS];
693 #endif /* VMS */
695 slen = strlen (src);
696 #ifdef VMS
697 if (! index (src, '/')
698 && (src[slen - 1] == ']'
699 || src[slen - 1] == ':'
700 || src[slen - 1] == '>'))
702 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
703 fab.fab$l_fna = src;
704 fab.fab$b_fns = slen;
705 fab.fab$l_nam = &nam;
706 fab.fab$l_fop = FAB$M_NAM;
708 nam.nam$l_esa = esa;
709 nam.nam$b_ess = sizeof esa;
710 nam.nam$b_nop |= NAM$M_SYNCHK;
712 /* We call SYS$PARSE to handle such things as [--] for us. */
713 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
715 slen = nam.nam$b_esl;
716 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
717 slen -= 2;
718 esa[slen] = '\0';
719 src = esa;
721 if (src[slen - 1] != ']' && src[slen - 1] != '>')
723 /* what about when we have logical_name:???? */
724 if (src[slen - 1] == ':')
725 { /* Xlate logical name and see what we get */
726 ptr = strcpy (dst, src); /* upper case for getenv */
727 while (*ptr)
729 if ('a' <= *ptr && *ptr <= 'z')
730 *ptr -= 040;
731 ptr++;
733 dst[slen - 1] = 0; /* remove colon */
734 if (!(src = egetenv (dst)))
735 return 0;
736 /* should we jump to the beginning of this procedure?
737 Good points: allows us to use logical names that xlate
738 to Unix names,
739 Bad points: can be a problem if we just translated to a device
740 name...
741 For now, I'll punt and always expect VMS names, and hope for
742 the best! */
743 slen = strlen (src);
744 if (src[slen - 1] != ']' && src[slen - 1] != '>')
745 { /* no recursion here! */
746 strcpy (dst, src);
747 return 0;
750 else
751 { /* not a directory spec */
752 strcpy (dst, src);
753 return 0;
756 bracket = src[slen - 1];
758 /* If bracket is ']' or '>', bracket - 2 is the corresponding
759 opening bracket. */
760 ptr = index (src, bracket - 2);
761 if (ptr == 0)
762 { /* no opening bracket */
763 strcpy (dst, src);
764 return 0;
766 if (!(rptr = rindex (src, '.')))
767 rptr = ptr;
768 slen = rptr - src;
769 strncpy (dst, src, slen);
770 dst[slen] = '\0';
771 if (*rptr == '.')
773 dst[slen++] = bracket;
774 dst[slen] = '\0';
776 else
778 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
779 then translate the device and recurse. */
780 if (dst[slen - 1] == ':'
781 && dst[slen - 2] != ':' /* skip decnet nodes */
782 && strcmp (src + slen, "[000000]") == 0)
784 dst[slen - 1] = '\0';
785 if ((ptr = egetenv (dst))
786 && (rlen = strlen (ptr) - 1) > 0
787 && (ptr[rlen] == ']' || ptr[rlen] == '>')
788 && ptr[rlen - 1] == '.')
790 char * buf = (char *) alloca (strlen (ptr) + 1);
791 strcpy (buf, ptr);
792 buf[rlen - 1] = ']';
793 buf[rlen] = '\0';
794 return directory_file_name (buf, dst);
796 else
797 dst[slen - 1] = ':';
799 strcat (dst, "[000000]");
800 slen += 8;
802 rptr++;
803 rlen = strlen (rptr) - 1;
804 strncat (dst, rptr, rlen);
805 dst[slen + rlen] = '\0';
806 strcat (dst, ".DIR.1");
807 return 1;
809 #endif /* VMS */
810 /* Process as Unix format: just remove any final slash.
811 But leave "/" unchanged; do not change it to "". */
812 strcpy (dst, src);
813 #ifdef APOLLO
814 /* Handle // as root for apollo's. */
815 if ((slen > 2 && dst[slen - 1] == '/')
816 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
817 dst[slen - 1] = 0;
818 #else
819 if (slen > 1
820 && IS_DIRECTORY_SEP (dst[slen - 1])
821 #ifdef DOS_NT
822 && !IS_ANY_SEP (dst[slen - 2])
823 #endif
825 dst[slen - 1] = 0;
826 #endif
827 #ifdef DOS_NT
828 CORRECT_DIR_SEPS (dst);
829 #endif
830 return 1;
833 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
834 1, 1, 0,
835 doc: /* Returns the file name of the directory named DIRECTORY.
836 This is the name of the file that holds the data for the directory DIRECTORY.
837 This operation exists because a directory is also a file, but its name as
838 a directory is different from its name as a file.
839 In Unix-syntax, this function just removes the final slash.
840 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
841 it returns a file name such as \"[X]Y.DIR.1\". */)
842 (directory)
843 Lisp_Object directory;
845 char *buf;
846 Lisp_Object handler;
848 CHECK_STRING (directory);
850 if (NILP (directory))
851 return Qnil;
853 /* If the file name has special constructs in it,
854 call the corresponding file handler. */
855 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
856 if (!NILP (handler))
857 return call2 (handler, Qdirectory_file_name, directory);
859 #ifdef VMS
860 /* 20 extra chars is insufficient for VMS, since we might perform a
861 logical name translation. an equivalence string can be up to 255
862 chars long, so grab that much extra space... - sss */
863 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
864 #else
865 buf = (char *) alloca (SBYTES (directory) + 20);
866 #endif
867 directory_file_name (SDATA (directory), buf);
868 return make_specified_string (buf, -1, strlen (buf),
869 STRING_MULTIBYTE (directory));
872 static char make_temp_name_tbl[64] =
874 'A','B','C','D','E','F','G','H',
875 'I','J','K','L','M','N','O','P',
876 'Q','R','S','T','U','V','W','X',
877 'Y','Z','a','b','c','d','e','f',
878 'g','h','i','j','k','l','m','n',
879 'o','p','q','r','s','t','u','v',
880 'w','x','y','z','0','1','2','3',
881 '4','5','6','7','8','9','-','_'
884 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
886 /* Value is a temporary file name starting with PREFIX, a string.
888 The Emacs process number forms part of the result, so there is
889 no danger of generating a name being used by another process.
890 In addition, this function makes an attempt to choose a name
891 which has no existing file. To make this work, PREFIX should be
892 an absolute file name.
894 BASE64_P non-zero means add the pid as 3 characters in base64
895 encoding. In this case, 6 characters will be added to PREFIX to
896 form the file name. Otherwise, if Emacs is running on a system
897 with long file names, add the pid as a decimal number.
899 This function signals an error if no unique file name could be
900 generated. */
902 Lisp_Object
903 make_temp_name (prefix, base64_p)
904 Lisp_Object prefix;
905 int base64_p;
907 Lisp_Object val;
908 int len, clen;
909 int pid;
910 unsigned char *p, *data;
911 char pidbuf[20];
912 int pidlen;
914 CHECK_STRING (prefix);
916 /* VAL is created by adding 6 characters to PREFIX. The first
917 three are the PID of this process, in base 64, and the second
918 three are incremented if the file already exists. This ensures
919 262144 unique file names per PID per PREFIX. */
921 pid = (int) getpid ();
923 if (base64_p)
925 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
926 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
927 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
928 pidlen = 3;
930 else
932 #ifdef HAVE_LONG_FILE_NAMES
933 sprintf (pidbuf, "%d", pid);
934 pidlen = strlen (pidbuf);
935 #else
936 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
937 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
938 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
939 pidlen = 3;
940 #endif
943 len = SBYTES (prefix); clen = SCHARS (prefix);
944 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
945 if (!STRING_MULTIBYTE (prefix))
946 STRING_SET_UNIBYTE (val);
947 data = SDATA (val);
948 bcopy(SDATA (prefix), data, len);
949 p = data + len;
951 bcopy (pidbuf, p, pidlen);
952 p += pidlen;
954 /* Here we try to minimize useless stat'ing when this function is
955 invoked many times successively with the same PREFIX. We achieve
956 this by initializing count to a random value, and incrementing it
957 afterwards.
959 We don't want make-temp-name to be called while dumping,
960 because then make_temp_name_count_initialized_p would get set
961 and then make_temp_name_count would not be set when Emacs starts. */
963 if (!make_temp_name_count_initialized_p)
965 make_temp_name_count = (unsigned) time (NULL);
966 make_temp_name_count_initialized_p = 1;
969 while (1)
971 struct stat ignored;
972 unsigned num = make_temp_name_count;
974 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
975 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
976 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
978 /* Poor man's congruential RN generator. Replace with
979 ++make_temp_name_count for debugging. */
980 make_temp_name_count += 25229;
981 make_temp_name_count %= 225307;
983 if (stat (data, &ignored) < 0)
985 /* We want to return only if errno is ENOENT. */
986 if (errno == ENOENT)
987 return val;
988 else
989 /* The error here is dubious, but there is little else we
990 can do. The alternatives are to return nil, which is
991 as bad as (and in many cases worse than) throwing the
992 error, or to ignore the error, which will likely result
993 in looping through 225307 stat's, which is not only
994 dog-slow, but also useless since it will fallback to
995 the errow below, anyway. */
996 report_file_error ("Cannot create temporary name for prefix",
997 Fcons (prefix, Qnil));
998 /* not reached */
1002 error ("Cannot create temporary name for prefix `%s'",
1003 SDATA (prefix));
1004 return Qnil;
1008 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1009 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1010 The Emacs process number forms part of the result,
1011 so there is no danger of generating a name being used by another process.
1013 In addition, this function makes an attempt to choose a name
1014 which has no existing file. To make this work,
1015 PREFIX should be an absolute file name.
1017 There is a race condition between calling `make-temp-name' and creating the
1018 file which opens all kinds of security holes. For that reason, you should
1019 probably use `make-temp-file' instead, except in three circumstances:
1021 * If you are creating the file in the user's home directory.
1022 * If you are creating a directory rather than an ordinary file.
1023 * If you are taking special precautions as `make-temp-file' does. */)
1024 (prefix)
1025 Lisp_Object prefix;
1027 return make_temp_name (prefix, 0);
1032 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1033 doc: /* Convert filename NAME to absolute, and canonicalize it.
1034 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1035 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1036 the current buffer's value of `default-directory' is used.
1037 File name components that are `.' are removed, and
1038 so are file name components followed by `..', along with the `..' itself;
1039 note that these simplifications are done without checking the resulting
1040 file names in the file system.
1041 An initial `~/' expands to your home directory.
1042 An initial `~USER/' expands to USER's home directory.
1043 See also the function `substitute-in-file-name'. */)
1044 (name, default_directory)
1045 Lisp_Object name, default_directory;
1047 unsigned char *nm;
1049 register unsigned char *newdir, *p, *o;
1050 int tlen;
1051 unsigned char *target;
1052 struct passwd *pw;
1053 #ifdef VMS
1054 unsigned char * colon = 0;
1055 unsigned char * close = 0;
1056 unsigned char * slash = 0;
1057 unsigned char * brack = 0;
1058 int lbrack = 0, rbrack = 0;
1059 int dots = 0;
1060 #endif /* VMS */
1061 #ifdef DOS_NT
1062 int drive = 0;
1063 int collapse_newdir = 1;
1064 int is_escaped = 0;
1065 #endif /* DOS_NT */
1066 int length;
1067 Lisp_Object handler, result;
1068 int multibyte;
1070 CHECK_STRING (name);
1072 /* If the file name has special constructs in it,
1073 call the corresponding file handler. */
1074 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1075 if (!NILP (handler))
1076 return call3 (handler, Qexpand_file_name, name, default_directory);
1078 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1079 if (NILP (default_directory))
1080 default_directory = current_buffer->directory;
1081 if (! STRINGP (default_directory))
1083 #ifdef DOS_NT
1084 /* "/" is not considered a root directory on DOS_NT, so using "/"
1085 here causes an infinite recursion in, e.g., the following:
1087 (let (default-directory)
1088 (expand-file-name "a"))
1090 To avoid this, we set default_directory to the root of the
1091 current drive. */
1092 extern char *emacs_root_dir (void);
1094 default_directory = build_string (emacs_root_dir ());
1095 #else
1096 default_directory = build_string ("/");
1097 #endif
1100 if (!NILP (default_directory))
1102 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1103 if (!NILP (handler))
1104 return call3 (handler, Qexpand_file_name, name, default_directory);
1107 o = SDATA (default_directory);
1109 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1110 It would be better to do this down below where we actually use
1111 default_directory. Unfortunately, calling Fexpand_file_name recursively
1112 could invoke GC, and the strings might be relocated. This would
1113 be annoying because we have pointers into strings lying around
1114 that would need adjusting, and people would add new pointers to
1115 the code and forget to adjust them, resulting in intermittent bugs.
1116 Putting this call here avoids all that crud.
1118 The EQ test avoids infinite recursion. */
1119 if (! NILP (default_directory) && !EQ (default_directory, name)
1120 /* Save time in some common cases - as long as default_directory
1121 is not relative, it can be canonicalized with name below (if it
1122 is needed at all) without requiring it to be expanded now. */
1123 #ifdef DOS_NT
1124 /* Detect MSDOS file names with drive specifiers. */
1125 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1126 #ifdef WINDOWSNT
1127 /* Detect Windows file names in UNC format. */
1128 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1129 #endif
1130 #else /* not DOS_NT */
1131 /* Detect Unix absolute file names (/... alone is not absolute on
1132 DOS or Windows). */
1133 && ! (IS_DIRECTORY_SEP (o[0]))
1134 #endif /* not DOS_NT */
1137 struct gcpro gcpro1;
1139 GCPRO1 (name);
1140 default_directory = Fexpand_file_name (default_directory, Qnil);
1141 UNGCPRO;
1144 name = FILE_SYSTEM_CASE (name);
1145 nm = SDATA (name);
1146 multibyte = STRING_MULTIBYTE (name);
1148 #ifdef DOS_NT
1149 /* We will force directory separators to be either all \ or /, so make
1150 a local copy to modify, even if there ends up being no change. */
1151 nm = strcpy (alloca (strlen (nm) + 1), nm);
1153 /* Note if special escape prefix is present, but remove for now. */
1154 if (nm[0] == '/' && nm[1] == ':')
1156 is_escaped = 1;
1157 nm += 2;
1160 /* Find and remove drive specifier if present; this makes nm absolute
1161 even if the rest of the name appears to be relative. Only look for
1162 drive specifier at the beginning. */
1163 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1165 drive = nm[0];
1166 nm += 2;
1169 #ifdef WINDOWSNT
1170 /* If we see "c://somedir", we want to strip the first slash after the
1171 colon when stripping the drive letter. Otherwise, this expands to
1172 "//somedir". */
1173 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1174 nm++;
1175 #endif /* WINDOWSNT */
1176 #endif /* DOS_NT */
1178 #ifdef WINDOWSNT
1179 /* Discard any previous drive specifier if nm is now in UNC format. */
1180 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1182 drive = 0;
1184 #endif
1186 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1187 none are found, we can probably return right away. We will avoid
1188 allocating a new string if name is already fully expanded. */
1189 if (
1190 IS_DIRECTORY_SEP (nm[0])
1191 #ifdef MSDOS
1192 && drive && !is_escaped
1193 #endif
1194 #ifdef WINDOWSNT
1195 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1196 #endif
1197 #ifdef VMS
1198 || index (nm, ':')
1199 #endif /* VMS */
1202 /* If it turns out that the filename we want to return is just a
1203 suffix of FILENAME, we don't need to go through and edit
1204 things; we just need to construct a new string using data
1205 starting at the middle of FILENAME. If we set lose to a
1206 non-zero value, that means we've discovered that we can't do
1207 that cool trick. */
1208 int lose = 0;
1210 p = nm;
1211 while (*p)
1213 /* Since we know the name is absolute, we can assume that each
1214 element starts with a "/". */
1216 /* "." and ".." are hairy. */
1217 if (IS_DIRECTORY_SEP (p[0])
1218 && p[1] == '.'
1219 && (IS_DIRECTORY_SEP (p[2])
1220 || p[2] == 0
1221 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1222 || p[3] == 0))))
1223 lose = 1;
1224 /* We want to replace multiple `/' in a row with a single
1225 slash. */
1226 else if (p > nm
1227 && IS_DIRECTORY_SEP (p[0])
1228 && IS_DIRECTORY_SEP (p[1]))
1229 lose = 1;
1231 #ifdef VMS
1232 if (p[0] == '\\')
1233 lose = 1;
1234 if (p[0] == '/') {
1235 /* if dev:[dir]/, move nm to / */
1236 if (!slash && p > nm && (brack || colon)) {
1237 nm = (brack ? brack + 1 : colon + 1);
1238 lbrack = rbrack = 0;
1239 brack = 0;
1240 colon = 0;
1242 slash = p;
1244 if (p[0] == '-')
1245 #ifdef NO_HYPHENS_IN_FILENAMES
1246 if (lbrack == rbrack)
1248 /* Avoid clobbering negative version numbers. */
1249 if (dots < 2)
1250 p[0] = '_';
1252 else
1253 #endif /* NO_HYPHENS_IN_FILENAMES */
1254 if (lbrack > rbrack
1255 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1256 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1257 lose = 1;
1258 #ifdef NO_HYPHENS_IN_FILENAMES
1259 else
1260 p[0] = '_';
1261 #endif /* NO_HYPHENS_IN_FILENAMES */
1262 /* count open brackets, reset close bracket pointer */
1263 if (p[0] == '[' || p[0] == '<')
1264 lbrack++, brack = 0;
1265 /* count close brackets, set close bracket pointer */
1266 if (p[0] == ']' || p[0] == '>')
1267 rbrack++, brack = p;
1268 /* detect ][ or >< */
1269 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1270 lose = 1;
1271 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1272 nm = p + 1, lose = 1;
1273 if (p[0] == ':' && (colon || slash))
1274 /* if dev1:[dir]dev2:, move nm to dev2: */
1275 if (brack)
1277 nm = brack + 1;
1278 brack = 0;
1280 /* if /name/dev:, move nm to dev: */
1281 else if (slash)
1282 nm = slash + 1;
1283 /* if node::dev:, move colon following dev */
1284 else if (colon && colon[-1] == ':')
1285 colon = p;
1286 /* if dev1:dev2:, move nm to dev2: */
1287 else if (colon && colon[-1] != ':')
1289 nm = colon + 1;
1290 colon = 0;
1292 if (p[0] == ':' && !colon)
1294 if (p[1] == ':')
1295 p++;
1296 colon = p;
1298 if (lbrack == rbrack)
1299 if (p[0] == ';')
1300 dots = 2;
1301 else if (p[0] == '.')
1302 dots++;
1303 #endif /* VMS */
1304 p++;
1306 if (!lose)
1308 #ifdef VMS
1309 if (index (nm, '/'))
1311 nm = sys_translate_unix (nm);
1312 return make_specified_string (nm, -1, strlen (nm), multibyte);
1314 #endif /* VMS */
1315 #ifdef DOS_NT
1316 /* Make sure directories are all separated with / or \ as
1317 desired, but avoid allocation of a new string when not
1318 required. */
1319 CORRECT_DIR_SEPS (nm);
1320 #ifdef WINDOWSNT
1321 if (IS_DIRECTORY_SEP (nm[1]))
1323 if (strcmp (nm, SDATA (name)) != 0)
1324 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1326 else
1327 #endif
1328 /* drive must be set, so this is okay */
1329 if (strcmp (nm - 2, SDATA (name)) != 0)
1331 char temp[] = " :";
1333 name = make_specified_string (nm, -1, p - nm, multibyte);
1334 temp[0] = DRIVE_LETTER (drive);
1335 name = concat2 (build_string (temp), name);
1337 return name;
1338 #else /* not DOS_NT */
1339 if (nm == SDATA (name))
1340 return name;
1341 return make_specified_string (nm, -1, strlen (nm), multibyte);
1342 #endif /* not DOS_NT */
1346 /* At this point, nm might or might not be an absolute file name. We
1347 need to expand ~ or ~user if present, otherwise prefix nm with
1348 default_directory if nm is not absolute, and finally collapse /./
1349 and /foo/../ sequences.
1351 We set newdir to be the appropriate prefix if one is needed:
1352 - the relevant user directory if nm starts with ~ or ~user
1353 - the specified drive's working dir (DOS/NT only) if nm does not
1354 start with /
1355 - the value of default_directory.
1357 Note that these prefixes are not guaranteed to be absolute (except
1358 for the working dir of a drive). Therefore, to ensure we always
1359 return an absolute name, if the final prefix is not absolute we
1360 append it to the current working directory. */
1362 newdir = 0;
1364 if (nm[0] == '~') /* prefix ~ */
1366 if (IS_DIRECTORY_SEP (nm[1])
1367 #ifdef VMS
1368 || nm[1] == ':'
1369 #endif /* VMS */
1370 || nm[1] == 0) /* ~ by itself */
1372 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1373 newdir = (unsigned char *) "";
1374 nm++;
1375 #ifdef DOS_NT
1376 collapse_newdir = 0;
1377 #endif
1378 #ifdef VMS
1379 nm++; /* Don't leave the slash in nm. */
1380 #endif /* VMS */
1382 else /* ~user/filename */
1384 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1385 #ifdef VMS
1386 && *p != ':'
1387 #endif /* VMS */
1388 ); p++);
1389 o = (unsigned char *) alloca (p - nm + 1);
1390 bcopy ((char *) nm, o, p - nm);
1391 o [p - nm] = 0;
1393 BLOCK_INPUT;
1394 pw = (struct passwd *) getpwnam (o + 1);
1395 UNBLOCK_INPUT;
1396 if (pw)
1398 newdir = (unsigned char *) pw -> pw_dir;
1399 #ifdef VMS
1400 nm = p + 1; /* skip the terminator */
1401 #else
1402 nm = p;
1403 #ifdef DOS_NT
1404 collapse_newdir = 0;
1405 #endif
1406 #endif /* VMS */
1409 /* If we don't find a user of that name, leave the name
1410 unchanged; don't move nm forward to p. */
1414 #ifdef DOS_NT
1415 /* On DOS and Windows, nm is absolute if a drive name was specified;
1416 use the drive's current directory as the prefix if needed. */
1417 if (!newdir && drive)
1419 /* Get default directory if needed to make nm absolute. */
1420 if (!IS_DIRECTORY_SEP (nm[0]))
1422 newdir = alloca (MAXPATHLEN + 1);
1423 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1424 newdir = NULL;
1426 if (!newdir)
1428 /* Either nm starts with /, or drive isn't mounted. */
1429 newdir = alloca (4);
1430 newdir[0] = DRIVE_LETTER (drive);
1431 newdir[1] = ':';
1432 newdir[2] = '/';
1433 newdir[3] = 0;
1436 #endif /* DOS_NT */
1438 /* Finally, if no prefix has been specified and nm is not absolute,
1439 then it must be expanded relative to default_directory. */
1441 if (1
1442 #ifndef DOS_NT
1443 /* /... alone is not absolute on DOS and Windows. */
1444 && !IS_DIRECTORY_SEP (nm[0])
1445 #endif
1446 #ifdef WINDOWSNT
1447 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1448 #endif
1449 #ifdef VMS
1450 && !index (nm, ':')
1451 #endif
1452 && !newdir)
1454 newdir = SDATA (default_directory);
1455 multibyte |= STRING_MULTIBYTE (default_directory);
1456 #ifdef DOS_NT
1457 /* Note if special escape prefix is present, but remove for now. */
1458 if (newdir[0] == '/' && newdir[1] == ':')
1460 is_escaped = 1;
1461 newdir += 2;
1463 #endif
1466 #ifdef DOS_NT
1467 if (newdir)
1469 /* First ensure newdir is an absolute name. */
1470 if (
1471 /* Detect MSDOS file names with drive specifiers. */
1472 ! (IS_DRIVE (newdir[0])
1473 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1474 #ifdef WINDOWSNT
1475 /* Detect Windows file names in UNC format. */
1476 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1477 #endif
1480 /* Effectively, let newdir be (expand-file-name newdir cwd).
1481 Because of the admonition against calling expand-file-name
1482 when we have pointers into lisp strings, we accomplish this
1483 indirectly by prepending newdir to nm if necessary, and using
1484 cwd (or the wd of newdir's drive) as the new newdir. */
1486 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1488 drive = newdir[0];
1489 newdir += 2;
1491 if (!IS_DIRECTORY_SEP (nm[0]))
1493 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1494 file_name_as_directory (tmp, newdir);
1495 strcat (tmp, nm);
1496 nm = tmp;
1498 newdir = alloca (MAXPATHLEN + 1);
1499 if (drive)
1501 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1502 newdir = "/";
1504 else
1505 getwd (newdir);
1508 /* Strip off drive name from prefix, if present. */
1509 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1511 drive = newdir[0];
1512 newdir += 2;
1515 /* Keep only a prefix from newdir if nm starts with slash
1516 (//server/share for UNC, nothing otherwise). */
1517 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1519 #ifdef WINDOWSNT
1520 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1522 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1523 p = newdir + 2;
1524 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1525 p++;
1526 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1527 *p = 0;
1529 else
1530 #endif
1531 newdir = "";
1534 #endif /* DOS_NT */
1536 if (newdir)
1538 /* Get rid of any slash at the end of newdir, unless newdir is
1539 just / or // (an incomplete UNC name). */
1540 length = strlen (newdir);
1541 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1542 #ifdef WINDOWSNT
1543 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1544 #endif
1547 unsigned char *temp = (unsigned char *) alloca (length);
1548 bcopy (newdir, temp, length - 1);
1549 temp[length - 1] = 0;
1550 newdir = temp;
1552 tlen = length + 1;
1554 else
1555 tlen = 0;
1557 /* Now concatenate the directory and name to new space in the stack frame */
1558 tlen += strlen (nm) + 1;
1559 #ifdef DOS_NT
1560 /* Reserve space for drive specifier and escape prefix, since either
1561 or both may need to be inserted. (The Microsoft x86 compiler
1562 produces incorrect code if the following two lines are combined.) */
1563 target = (unsigned char *) alloca (tlen + 4);
1564 target += 4;
1565 #else /* not DOS_NT */
1566 target = (unsigned char *) alloca (tlen);
1567 #endif /* not DOS_NT */
1568 *target = 0;
1570 if (newdir)
1572 #ifndef VMS
1573 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1575 #ifdef DOS_NT
1576 /* If newdir is effectively "C:/", then the drive letter will have
1577 been stripped and newdir will be "/". Concatenating with an
1578 absolute directory in nm produces "//", which will then be
1579 incorrectly treated as a network share. Ignore newdir in
1580 this case (keeping the drive letter). */
1581 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1582 && newdir[1] == '\0'))
1583 #endif
1584 strcpy (target, newdir);
1586 else
1587 #endif
1588 file_name_as_directory (target, newdir);
1591 strcat (target, nm);
1592 #ifdef VMS
1593 if (index (target, '/'))
1594 strcpy (target, sys_translate_unix (target));
1595 #endif /* VMS */
1597 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1599 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1600 appear. */
1602 p = target;
1603 o = target;
1605 while (*p)
1607 #ifdef VMS
1608 if (*p != ']' && *p != '>' && *p != '-')
1610 if (*p == '\\')
1611 p++;
1612 *o++ = *p++;
1614 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1615 /* brackets are offset from each other by 2 */
1617 p += 2;
1618 if (*p != '.' && *p != '-' && o[-1] != '.')
1619 /* convert [foo][bar] to [bar] */
1620 while (o[-1] != '[' && o[-1] != '<')
1621 o--;
1622 else if (*p == '-' && *o != '.')
1623 *--p = '.';
1625 else if (p[0] == '-' && o[-1] == '.'
1626 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1627 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1630 o--;
1631 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1632 if (p[1] == '.') /* foo.-.bar ==> bar. */
1633 p += 2;
1634 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1635 p++, o--;
1636 /* else [foo.-] ==> [-] */
1638 else
1640 #ifdef NO_HYPHENS_IN_FILENAMES
1641 if (*p == '-'
1642 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
1643 && p[1] != ']' && p[1] != '>' && p[1] != '.')
1644 *p = '_';
1645 #endif /* NO_HYPHENS_IN_FILENAMES */
1646 *o++ = *p++;
1648 #else /* not VMS */
1649 if (!IS_DIRECTORY_SEP (*p))
1651 *o++ = *p++;
1653 else if (p[1] == '.'
1654 && (IS_DIRECTORY_SEP (p[2])
1655 || p[2] == 0))
1657 /* If "/." is the entire filename, keep the "/". Otherwise,
1658 just delete the whole "/.". */
1659 if (o == target && p[2] == '\0')
1660 *o++ = *p;
1661 p += 2;
1663 else if (p[1] == '.' && p[2] == '.'
1664 /* `/../' is the "superroot" on certain file systems.
1665 Turned off on DOS_NT systems because they have no
1666 "superroot" and because this causes us to produce
1667 file names like "d:/../foo" which fail file-related
1668 functions of the underlying OS. (To reproduce, try a
1669 long series of "../../" in default_directory, longer
1670 than the number of levels from the root.) */
1671 #ifndef DOS_NT
1672 && o != target
1673 #endif
1674 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1676 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1678 /* Keep initial / only if this is the whole name. */
1679 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1680 ++o;
1681 p += 3;
1683 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1684 /* Collapse multiple `/' in a row. */
1685 p++;
1686 else
1688 *o++ = *p++;
1690 #endif /* not VMS */
1693 #ifdef DOS_NT
1694 /* At last, set drive name. */
1695 #ifdef WINDOWSNT
1696 /* Except for network file name. */
1697 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1698 #endif /* WINDOWSNT */
1700 if (!drive) abort ();
1701 target -= 2;
1702 target[0] = DRIVE_LETTER (drive);
1703 target[1] = ':';
1705 /* Reinsert the escape prefix if required. */
1706 if (is_escaped)
1708 target -= 2;
1709 target[0] = '/';
1710 target[1] = ':';
1712 CORRECT_DIR_SEPS (target);
1713 #endif /* DOS_NT */
1715 result = make_specified_string (target, -1, o - target, multibyte);
1717 /* Again look to see if the file name has special constructs in it
1718 and perhaps call the corresponding file handler. This is needed
1719 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1720 the ".." component gives us "/user@host:/bar/../baz" which needs
1721 to be expanded again. */
1722 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1723 if (!NILP (handler))
1724 return call3 (handler, Qexpand_file_name, result, default_directory);
1726 return result;
1729 #if 0
1730 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1731 This is the old version of expand-file-name, before it was thoroughly
1732 rewritten for Emacs 10.31. We leave this version here commented-out,
1733 because the code is very complex and likely to have subtle bugs. If
1734 bugs _are_ found, it might be of interest to look at the old code and
1735 see what did it do in the relevant situation.
1737 Don't remove this code: it's true that it will be accessible via CVS,
1738 but a few years from deletion, people will forget it is there. */
1740 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1741 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1742 "Convert FILENAME to absolute, and canonicalize it.\n\
1743 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1744 \(does not start with slash); if DEFAULT is nil or missing,\n\
1745 the current buffer's value of default-directory is used.\n\
1746 Filenames containing `.' or `..' as components are simplified;\n\
1747 initial `~/' expands to your home directory.\n\
1748 See also the function `substitute-in-file-name'.")
1749 (name, defalt)
1750 Lisp_Object name, defalt;
1752 unsigned char *nm;
1754 register unsigned char *newdir, *p, *o;
1755 int tlen;
1756 unsigned char *target;
1757 struct passwd *pw;
1758 int lose;
1759 #ifdef VMS
1760 unsigned char * colon = 0;
1761 unsigned char * close = 0;
1762 unsigned char * slash = 0;
1763 unsigned char * brack = 0;
1764 int lbrack = 0, rbrack = 0;
1765 int dots = 0;
1766 #endif /* VMS */
1768 CHECK_STRING (name);
1770 #ifdef VMS
1771 /* Filenames on VMS are always upper case. */
1772 name = Fupcase (name);
1773 #endif
1775 nm = SDATA (name);
1777 /* If nm is absolute, flush ...// and detect /./ and /../.
1778 If no /./ or /../ we can return right away. */
1779 if (
1780 nm[0] == '/'
1781 #ifdef VMS
1782 || index (nm, ':')
1783 #endif /* VMS */
1786 p = nm;
1787 lose = 0;
1788 while (*p)
1790 if (p[0] == '/' && p[1] == '/'
1791 #ifdef APOLLO
1792 /* // at start of filename is meaningful on Apollo system. */
1793 && nm != p
1794 #endif /* APOLLO */
1796 nm = p + 1;
1797 if (p[0] == '/' && p[1] == '~')
1798 nm = p + 1, lose = 1;
1799 if (p[0] == '/' && p[1] == '.'
1800 && (p[2] == '/' || p[2] == 0
1801 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1802 lose = 1;
1803 #ifdef VMS
1804 if (p[0] == '\\')
1805 lose = 1;
1806 if (p[0] == '/') {
1807 /* if dev:[dir]/, move nm to / */
1808 if (!slash && p > nm && (brack || colon)) {
1809 nm = (brack ? brack + 1 : colon + 1);
1810 lbrack = rbrack = 0;
1811 brack = 0;
1812 colon = 0;
1814 slash = p;
1816 if (p[0] == '-')
1817 #ifndef VMS4_4
1818 /* VMS pre V4.4,convert '-'s in filenames. */
1819 if (lbrack == rbrack)
1821 if (dots < 2) /* this is to allow negative version numbers */
1822 p[0] = '_';
1824 else
1825 #endif /* VMS4_4 */
1826 if (lbrack > rbrack
1827 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1828 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1829 lose = 1;
1830 #ifndef VMS4_4
1831 else
1832 p[0] = '_';
1833 #endif /* VMS4_4 */
1834 /* count open brackets, reset close bracket pointer */
1835 if (p[0] == '[' || p[0] == '<')
1836 lbrack++, brack = 0;
1837 /* count close brackets, set close bracket pointer */
1838 if (p[0] == ']' || p[0] == '>')
1839 rbrack++, brack = p;
1840 /* detect ][ or >< */
1841 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1842 lose = 1;
1843 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1844 nm = p + 1, lose = 1;
1845 if (p[0] == ':' && (colon || slash))
1846 /* if dev1:[dir]dev2:, move nm to dev2: */
1847 if (brack)
1849 nm = brack + 1;
1850 brack = 0;
1852 /* If /name/dev:, move nm to dev: */
1853 else if (slash)
1854 nm = slash + 1;
1855 /* If node::dev:, move colon following dev */
1856 else if (colon && colon[-1] == ':')
1857 colon = p;
1858 /* If dev1:dev2:, move nm to dev2: */
1859 else if (colon && colon[-1] != ':')
1861 nm = colon + 1;
1862 colon = 0;
1864 if (p[0] == ':' && !colon)
1866 if (p[1] == ':')
1867 p++;
1868 colon = p;
1870 if (lbrack == rbrack)
1871 if (p[0] == ';')
1872 dots = 2;
1873 else if (p[0] == '.')
1874 dots++;
1875 #endif /* VMS */
1876 p++;
1878 if (!lose)
1880 #ifdef VMS
1881 if (index (nm, '/'))
1882 return build_string (sys_translate_unix (nm));
1883 #endif /* VMS */
1884 if (nm == SDATA (name))
1885 return name;
1886 return build_string (nm);
1890 /* Now determine directory to start with and put it in NEWDIR */
1892 newdir = 0;
1894 if (nm[0] == '~') /* prefix ~ */
1895 if (nm[1] == '/'
1896 #ifdef VMS
1897 || nm[1] == ':'
1898 #endif /* VMS */
1899 || nm[1] == 0)/* ~/filename */
1901 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1902 newdir = (unsigned char *) "";
1903 nm++;
1904 #ifdef VMS
1905 nm++; /* Don't leave the slash in nm. */
1906 #endif /* VMS */
1908 else /* ~user/filename */
1910 /* Get past ~ to user */
1911 unsigned char *user = nm + 1;
1912 /* Find end of name. */
1913 unsigned char *ptr = (unsigned char *) index (user, '/');
1914 int len = ptr ? ptr - user : strlen (user);
1915 #ifdef VMS
1916 unsigned char *ptr1 = index (user, ':');
1917 if (ptr1 != 0 && ptr1 - user < len)
1918 len = ptr1 - user;
1919 #endif /* VMS */
1920 /* Copy the user name into temp storage. */
1921 o = (unsigned char *) alloca (len + 1);
1922 bcopy ((char *) user, o, len);
1923 o[len] = 0;
1925 /* Look up the user name. */
1926 BLOCK_INPUT;
1927 pw = (struct passwd *) getpwnam (o + 1);
1928 UNBLOCK_INPUT;
1929 if (!pw)
1930 error ("\"%s\" isn't a registered user", o + 1);
1932 newdir = (unsigned char *) pw->pw_dir;
1934 /* Discard the user name from NM. */
1935 nm += len;
1938 if (nm[0] != '/'
1939 #ifdef VMS
1940 && !index (nm, ':')
1941 #endif /* not VMS */
1942 && !newdir)
1944 if (NILP (defalt))
1945 defalt = current_buffer->directory;
1946 CHECK_STRING (defalt);
1947 newdir = SDATA (defalt);
1950 /* Now concatenate the directory and name to new space in the stack frame */
1952 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1953 target = (unsigned char *) alloca (tlen);
1954 *target = 0;
1956 if (newdir)
1958 #ifndef VMS
1959 if (nm[0] == 0 || nm[0] == '/')
1960 strcpy (target, newdir);
1961 else
1962 #endif
1963 file_name_as_directory (target, newdir);
1966 strcat (target, nm);
1967 #ifdef VMS
1968 if (index (target, '/'))
1969 strcpy (target, sys_translate_unix (target));
1970 #endif /* VMS */
1972 /* Now canonicalize by removing /. and /foo/.. if they appear */
1974 p = target;
1975 o = target;
1977 while (*p)
1979 #ifdef VMS
1980 if (*p != ']' && *p != '>' && *p != '-')
1982 if (*p == '\\')
1983 p++;
1984 *o++ = *p++;
1986 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1987 /* brackets are offset from each other by 2 */
1989 p += 2;
1990 if (*p != '.' && *p != '-' && o[-1] != '.')
1991 /* convert [foo][bar] to [bar] */
1992 while (o[-1] != '[' && o[-1] != '<')
1993 o--;
1994 else if (*p == '-' && *o != '.')
1995 *--p = '.';
1997 else if (p[0] == '-' && o[-1] == '.'
1998 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1999 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2002 o--;
2003 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2004 if (p[1] == '.') /* foo.-.bar ==> bar. */
2005 p += 2;
2006 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2007 p++, o--;
2008 /* else [foo.-] ==> [-] */
2010 else
2012 #ifndef VMS4_4
2013 if (*p == '-'
2014 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
2015 && p[1] != ']' && p[1] != '>' && p[1] != '.')
2016 *p = '_';
2017 #endif /* VMS4_4 */
2018 *o++ = *p++;
2020 #else /* not VMS */
2021 if (*p != '/')
2023 *o++ = *p++;
2025 else if (!strncmp (p, "//", 2)
2026 #ifdef APOLLO
2027 /* // at start of filename is meaningful in Apollo system. */
2028 && o != target
2029 #endif /* APOLLO */
2032 o = target;
2033 p++;
2035 else if (p[0] == '/' && p[1] == '.'
2036 && (p[2] == '/' || p[2] == 0))
2037 p += 2;
2038 else if (!strncmp (p, "/..", 3)
2039 /* `/../' is the "superroot" on certain file systems. */
2040 && o != target
2041 && (p[3] == '/' || p[3] == 0))
2043 while (o != target && *--o != '/')
2045 #ifdef APOLLO
2046 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2047 ++o;
2048 else
2049 #endif /* APOLLO */
2050 if (o == target && *o == '/')
2051 ++o;
2052 p += 3;
2054 else
2056 *o++ = *p++;
2058 #endif /* not VMS */
2061 return make_string (target, o - target);
2063 #endif
2065 /* If /~ or // appears, discard everything through first slash. */
2066 static int
2067 file_name_absolute_p (filename)
2068 const unsigned char *filename;
2070 return
2071 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2072 #ifdef VMS
2073 /* ??? This criterion is probably wrong for '<'. */
2074 || index (filename, ':') || index (filename, '<')
2075 || (*filename == '[' && (filename[1] != '-'
2076 || (filename[2] != '.' && filename[2] != ']'))
2077 && filename[1] != '.')
2078 #endif /* VMS */
2079 #ifdef DOS_NT
2080 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2081 && IS_DIRECTORY_SEP (filename[2]))
2082 #endif
2086 static unsigned char *
2087 search_embedded_absfilename (nm, endp)
2088 unsigned char *nm, *endp;
2090 unsigned char *p, *s;
2092 for (p = nm + 1; p < endp; p++)
2094 if ((0
2095 #ifdef VMS
2096 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2097 #endif /* VMS */
2098 || IS_DIRECTORY_SEP (p[-1]))
2099 && file_name_absolute_p (p)
2100 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2101 /* // at start of file name is meaningful in Apollo,
2102 WindowsNT and Cygwin systems. */
2103 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2104 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2107 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2108 #ifdef VMS
2109 && *s != ':'
2110 #endif /* VMS */
2111 ); s++);
2112 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2114 unsigned char *o = alloca (s - p + 1);
2115 struct passwd *pw;
2116 bcopy (p, o, s - p);
2117 o [s - p] = 0;
2119 /* If we have ~user and `user' exists, discard
2120 everything up to ~. But if `user' does not exist, leave
2121 ~user alone, it might be a literal file name. */
2122 BLOCK_INPUT;
2123 pw = getpwnam (o + 1);
2124 UNBLOCK_INPUT;
2125 if (pw)
2126 return p;
2128 else
2129 return p;
2132 return NULL;
2135 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2136 Ssubstitute_in_file_name, 1, 1, 0,
2137 doc: /* Substitute environment variables referred to in FILENAME.
2138 `$FOO' where FOO is an environment variable name means to substitute
2139 the value of that variable. The variable name should be terminated
2140 with a character not a letter, digit or underscore; otherwise, enclose
2141 the entire variable name in braces.
2142 If `/~' appears, all of FILENAME through that `/' is discarded.
2144 On VMS, `$' substitution is not done; this function does little and only
2145 duplicates what `expand-file-name' does. */)
2146 (filename)
2147 Lisp_Object filename;
2149 unsigned char *nm;
2151 register unsigned char *s, *p, *o, *x, *endp;
2152 unsigned char *target = NULL;
2153 int total = 0;
2154 int substituted = 0;
2155 unsigned char *xnm;
2156 Lisp_Object handler;
2158 CHECK_STRING (filename);
2160 /* If the file name has special constructs in it,
2161 call the corresponding file handler. */
2162 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2163 if (!NILP (handler))
2164 return call2 (handler, Qsubstitute_in_file_name, filename);
2166 nm = SDATA (filename);
2167 #ifdef DOS_NT
2168 nm = strcpy (alloca (strlen (nm) + 1), nm);
2169 CORRECT_DIR_SEPS (nm);
2170 substituted = (strcmp (nm, SDATA (filename)) != 0);
2171 #endif
2172 endp = nm + SBYTES (filename);
2174 /* If /~ or // appears, discard everything through first slash. */
2175 p = search_embedded_absfilename (nm, endp);
2176 if (p)
2177 /* Start over with the new string, so we check the file-name-handler
2178 again. Important with filenames like "/home/foo//:/hello///there"
2179 which whould substitute to "/:/hello///there" rather than "/there". */
2180 return Fsubstitute_in_file_name
2181 (make_specified_string (p, -1, endp - p,
2182 STRING_MULTIBYTE (filename)));
2184 #ifdef VMS
2185 return filename;
2186 #else
2188 /* See if any variables are substituted into the string
2189 and find the total length of their values in `total' */
2191 for (p = nm; p != endp;)
2192 if (*p != '$')
2193 p++;
2194 else
2196 p++;
2197 if (p == endp)
2198 goto badsubst;
2199 else if (*p == '$')
2201 /* "$$" means a single "$" */
2202 p++;
2203 total -= 1;
2204 substituted = 1;
2205 continue;
2207 else if (*p == '{')
2209 o = ++p;
2210 while (p != endp && *p != '}') p++;
2211 if (*p != '}') goto missingclose;
2212 s = p;
2214 else
2216 o = p;
2217 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2218 s = p;
2221 /* Copy out the variable name */
2222 target = (unsigned char *) alloca (s - o + 1);
2223 strncpy (target, o, s - o);
2224 target[s - o] = 0;
2225 #ifdef DOS_NT
2226 strupr (target); /* $home == $HOME etc. */
2227 #endif /* DOS_NT */
2229 /* Get variable value */
2230 o = (unsigned char *) egetenv (target);
2231 if (o)
2233 total += strlen (o);
2234 substituted = 1;
2236 else if (*p == '}')
2237 goto badvar;
2240 if (!substituted)
2241 return filename;
2243 /* If substitution required, recopy the string and do it */
2244 /* Make space in stack frame for the new copy */
2245 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2246 x = xnm;
2248 /* Copy the rest of the name through, replacing $ constructs with values */
2249 for (p = nm; *p;)
2250 if (*p != '$')
2251 *x++ = *p++;
2252 else
2254 p++;
2255 if (p == endp)
2256 goto badsubst;
2257 else if (*p == '$')
2259 *x++ = *p++;
2260 continue;
2262 else if (*p == '{')
2264 o = ++p;
2265 while (p != endp && *p != '}') p++;
2266 if (*p != '}') goto missingclose;
2267 s = p++;
2269 else
2271 o = p;
2272 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2273 s = p;
2276 /* Copy out the variable name */
2277 target = (unsigned char *) alloca (s - o + 1);
2278 strncpy (target, o, s - o);
2279 target[s - o] = 0;
2280 #ifdef DOS_NT
2281 strupr (target); /* $home == $HOME etc. */
2282 #endif /* DOS_NT */
2284 /* Get variable value */
2285 o = (unsigned char *) egetenv (target);
2286 if (!o)
2288 *x++ = '$';
2289 strcpy (x, target); x+= strlen (target);
2291 else if (STRING_MULTIBYTE (filename))
2293 /* If the original string is multibyte,
2294 convert what we substitute into multibyte. */
2295 while (*o)
2297 int c = unibyte_char_to_multibyte (*o++);
2298 x += CHAR_STRING (c, x);
2301 else
2303 strcpy (x, o);
2304 x += strlen (o);
2308 *x = 0;
2310 /* If /~ or // appears, discard everything through first slash. */
2311 while ((p = search_embedded_absfilename (xnm, x)))
2312 /* This time we do not start over because we've already expanded envvars
2313 and replaced $$ with $. Maybe we should start over as well, but we'd
2314 need to quote some $ to $$ first. */
2315 xnm = p;
2317 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2319 badsubst:
2320 error ("Bad format environment-variable substitution");
2321 missingclose:
2322 error ("Missing \"}\" in environment-variable substitution");
2323 badvar:
2324 error ("Substituting nonexistent environment variable \"%s\"", target);
2326 /* NOTREACHED */
2327 #endif /* not VMS */
2328 return Qnil;
2331 /* A slightly faster and more convenient way to get
2332 (directory-file-name (expand-file-name FOO)). */
2334 Lisp_Object
2335 expand_and_dir_to_file (filename, defdir)
2336 Lisp_Object filename, defdir;
2338 register Lisp_Object absname;
2340 absname = Fexpand_file_name (filename, defdir);
2341 #ifdef VMS
2343 register int c = SREF (absname, SBYTES (absname) - 1);
2344 if (c == ':' || c == ']' || c == '>')
2345 absname = Fdirectory_file_name (absname);
2347 #else
2348 /* Remove final slash, if any (unless this is the root dir).
2349 stat behaves differently depending! */
2350 if (SCHARS (absname) > 1
2351 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2352 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2353 /* We cannot take shortcuts; they might be wrong for magic file names. */
2354 absname = Fdirectory_file_name (absname);
2355 #endif
2356 return absname;
2359 /* Signal an error if the file ABSNAME already exists.
2360 If INTERACTIVE is nonzero, ask the user whether to proceed,
2361 and bypass the error if the user says to go ahead.
2362 QUERYSTRING is a name for the action that is being considered
2363 to alter the file.
2365 *STATPTR is used to store the stat information if the file exists.
2366 If the file does not exist, STATPTR->st_mode is set to 0.
2367 If STATPTR is null, we don't store into it.
2369 If QUICK is nonzero, we ask for y or n, not yes or no. */
2371 void
2372 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2373 Lisp_Object absname;
2374 unsigned char *querystring;
2375 int interactive;
2376 struct stat *statptr;
2377 int quick;
2379 register Lisp_Object tem, encoded_filename;
2380 struct stat statbuf;
2381 struct gcpro gcpro1;
2383 encoded_filename = ENCODE_FILE (absname);
2385 /* stat is a good way to tell whether the file exists,
2386 regardless of what access permissions it has. */
2387 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2389 if (! interactive)
2390 xsignal2 (Qfile_already_exists,
2391 build_string ("File already exists"), absname);
2392 GCPRO1 (absname);
2393 tem = format2 ("File %s already exists; %s anyway? ",
2394 absname, build_string (querystring));
2395 if (quick)
2396 tem = Fy_or_n_p (tem);
2397 else
2398 tem = do_yes_or_no_p (tem);
2399 UNGCPRO;
2400 if (NILP (tem))
2401 xsignal2 (Qfile_already_exists,
2402 build_string ("File already exists"), absname);
2403 if (statptr)
2404 *statptr = statbuf;
2406 else
2408 if (statptr)
2409 statptr->st_mode = 0;
2411 return;
2414 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2415 "fCopy file: \nGCopy %s to file: \np\nP",
2416 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2417 If NEWNAME names a directory, copy FILE there.
2419 This function always sets the file modes of the output file to match
2420 the input file.
2422 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2423 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2424 signal a `file-already-exists' error without overwriting. If
2425 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2426 about overwriting; this is what happens in interactive use with M-x.
2427 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2428 existing file.
2430 Fourth arg KEEP-TIME non-nil means give the output file the same
2431 last-modified time as the old one. (This works on only some systems.)
2433 A prefix arg makes KEEP-TIME non-nil.
2435 If PRESERVE-UID-GID is non-nil, we try to transfer the
2436 uid and gid of FILE to NEWNAME. */)
2437 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2438 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2439 Lisp_Object preserve_uid_gid;
2441 int ifd, ofd, n;
2442 char buf[16 * 1024];
2443 struct stat st, out_st;
2444 Lisp_Object handler;
2445 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2446 int count = SPECPDL_INDEX ();
2447 int input_file_statable_p;
2448 Lisp_Object encoded_file, encoded_newname;
2450 encoded_file = encoded_newname = Qnil;
2451 GCPRO4 (file, newname, encoded_file, encoded_newname);
2452 CHECK_STRING (file);
2453 CHECK_STRING (newname);
2455 if (!NILP (Ffile_directory_p (newname)))
2456 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2457 else
2458 newname = Fexpand_file_name (newname, Qnil);
2460 file = Fexpand_file_name (file, Qnil);
2462 /* If the input file name has special constructs in it,
2463 call the corresponding file handler. */
2464 handler = Ffind_file_name_handler (file, Qcopy_file);
2465 /* Likewise for output file name. */
2466 if (NILP (handler))
2467 handler = Ffind_file_name_handler (newname, Qcopy_file);
2468 if (!NILP (handler))
2469 RETURN_UNGCPRO (call6 (handler, Qcopy_file, file, newname,
2470 ok_if_already_exists, keep_time, preserve_uid_gid));
2472 encoded_file = ENCODE_FILE (file);
2473 encoded_newname = ENCODE_FILE (newname);
2475 if (NILP (ok_if_already_exists)
2476 || INTEGERP (ok_if_already_exists))
2477 barf_or_query_if_file_exists (newname, "copy to it",
2478 INTEGERP (ok_if_already_exists), &out_st, 0);
2479 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2480 out_st.st_mode = 0;
2482 #ifdef WINDOWSNT
2483 if (!CopyFile (SDATA (encoded_file),
2484 SDATA (encoded_newname),
2485 FALSE))
2486 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2487 /* CopyFile retains the timestamp by default. */
2488 else if (NILP (keep_time))
2490 EMACS_TIME now;
2491 DWORD attributes;
2492 char * filename;
2494 EMACS_GET_TIME (now);
2495 filename = SDATA (encoded_newname);
2497 /* Ensure file is writable while its modified time is set. */
2498 attributes = GetFileAttributes (filename);
2499 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2500 if (set_file_times (filename, now, now))
2502 /* Restore original attributes. */
2503 SetFileAttributes (filename, attributes);
2504 xsignal2 (Qfile_date_error,
2505 build_string ("Cannot set file date"), newname);
2507 /* Restore original attributes. */
2508 SetFileAttributes (filename, attributes);
2510 #else /* not WINDOWSNT */
2511 immediate_quit = 1;
2512 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2513 immediate_quit = 0;
2515 if (ifd < 0)
2516 report_file_error ("Opening input file", Fcons (file, Qnil));
2518 record_unwind_protect (close_file_unwind, make_number (ifd));
2520 /* We can only copy regular files and symbolic links. Other files are not
2521 copyable by us. */
2522 input_file_statable_p = (fstat (ifd, &st) >= 0);
2524 #if !defined (MSDOS) || __DJGPP__ > 1
2525 if (out_st.st_mode != 0
2526 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2528 errno = 0;
2529 report_file_error ("Input and output files are the same",
2530 Fcons (file, Fcons (newname, Qnil)));
2532 #endif
2534 #if defined (S_ISREG) && defined (S_ISLNK)
2535 if (input_file_statable_p)
2537 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2539 #if defined (EISDIR)
2540 /* Get a better looking error message. */
2541 errno = EISDIR;
2542 #endif /* EISDIR */
2543 report_file_error ("Non-regular file", Fcons (file, Qnil));
2546 #endif /* S_ISREG && S_ISLNK */
2548 #ifdef VMS
2549 /* Create the copy file with the same record format as the input file */
2550 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2551 #else
2552 #ifdef MSDOS
2553 /* System's default file type was set to binary by _fmode in emacs.c. */
2554 ofd = emacs_open (SDATA (encoded_newname),
2555 O_WRONLY | O_TRUNC | O_CREAT
2556 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2557 S_IREAD | S_IWRITE);
2558 #else /* not MSDOS */
2559 ofd = emacs_open (SDATA (encoded_newname),
2560 O_WRONLY | O_TRUNC | O_CREAT
2561 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2562 0666);
2563 #endif /* not MSDOS */
2564 #endif /* VMS */
2565 if (ofd < 0)
2566 report_file_error ("Opening output file", Fcons (newname, Qnil));
2568 record_unwind_protect (close_file_unwind, make_number (ofd));
2570 immediate_quit = 1;
2571 QUIT;
2572 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2573 if (emacs_write (ofd, buf, n) != n)
2574 report_file_error ("I/O error", Fcons (newname, Qnil));
2575 immediate_quit = 0;
2577 #ifndef MSDOS
2578 /* Preserve the original file modes, and if requested, also its
2579 owner and group. */
2580 if (input_file_statable_p)
2582 if (! NILP (preserve_uid_gid))
2583 fchown (ofd, st.st_uid, st.st_gid);
2584 fchmod (ofd, st.st_mode & 07777);
2586 #endif /* not MSDOS */
2588 /* Closing the output clobbers the file times on some systems. */
2589 if (emacs_close (ofd) < 0)
2590 report_file_error ("I/O error", Fcons (newname, Qnil));
2592 if (input_file_statable_p)
2594 if (!NILP (keep_time))
2596 EMACS_TIME atime, mtime;
2597 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2598 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2599 if (set_file_times (SDATA (encoded_newname),
2600 atime, mtime))
2601 xsignal2 (Qfile_date_error,
2602 build_string ("Cannot set file date"), newname);
2606 emacs_close (ifd);
2608 #if defined (__DJGPP__) && __DJGPP__ > 1
2609 if (input_file_statable_p)
2611 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2612 and if it can't, it tells so. Otherwise, under MSDOS we usually
2613 get only the READ bit, which will make the copied file read-only,
2614 so it's better not to chmod at all. */
2615 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2616 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2618 #endif /* DJGPP version 2 or newer */
2619 #endif /* not WINDOWSNT */
2621 /* Discard the unwind protects. */
2622 specpdl_ptr = specpdl + count;
2624 UNGCPRO;
2625 return Qnil;
2628 DEFUN ("make-directory-internal", Fmake_directory_internal,
2629 Smake_directory_internal, 1, 1, 0,
2630 doc: /* Create a new directory named DIRECTORY. */)
2631 (directory)
2632 Lisp_Object directory;
2634 const unsigned char *dir;
2635 Lisp_Object handler;
2636 Lisp_Object encoded_dir;
2638 CHECK_STRING (directory);
2639 directory = Fexpand_file_name (directory, Qnil);
2641 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2642 if (!NILP (handler))
2643 return call2 (handler, Qmake_directory_internal, directory);
2645 encoded_dir = ENCODE_FILE (directory);
2647 dir = SDATA (encoded_dir);
2649 #ifdef WINDOWSNT
2650 if (mkdir (dir) != 0)
2651 #else
2652 if (mkdir (dir, 0777) != 0)
2653 #endif
2654 report_file_error ("Creating directory", list1 (directory));
2656 return Qnil;
2659 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2660 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2661 (directory)
2662 Lisp_Object directory;
2664 const unsigned char *dir;
2665 Lisp_Object handler;
2666 Lisp_Object encoded_dir;
2668 CHECK_STRING (directory);
2669 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2671 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2672 if (!NILP (handler))
2673 return call2 (handler, Qdelete_directory, directory);
2675 encoded_dir = ENCODE_FILE (directory);
2677 dir = SDATA (encoded_dir);
2679 if (rmdir (dir) != 0)
2680 report_file_error ("Removing directory", list1 (directory));
2682 return Qnil;
2685 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2686 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2687 If file has multiple names, it continues to exist with the other names. */)
2688 (filename)
2689 Lisp_Object filename;
2691 Lisp_Object handler;
2692 Lisp_Object encoded_file;
2693 struct gcpro gcpro1;
2695 GCPRO1 (filename);
2696 if (!NILP (Ffile_directory_p (filename))
2697 && NILP (Ffile_symlink_p (filename)))
2698 xsignal2 (Qfile_error,
2699 build_string ("Removing old name: is a directory"),
2700 filename);
2701 UNGCPRO;
2702 filename = Fexpand_file_name (filename, Qnil);
2704 handler = Ffind_file_name_handler (filename, Qdelete_file);
2705 if (!NILP (handler))
2706 return call2 (handler, Qdelete_file, filename);
2708 encoded_file = ENCODE_FILE (filename);
2710 if (0 > unlink (SDATA (encoded_file)))
2711 report_file_error ("Removing old name", list1 (filename));
2712 return Qnil;
2715 static Lisp_Object
2716 internal_delete_file_1 (ignore)
2717 Lisp_Object ignore;
2719 return Qt;
2722 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2725 internal_delete_file (filename)
2726 Lisp_Object filename;
2728 Lisp_Object tem;
2729 tem = internal_condition_case_1 (Fdelete_file, filename,
2730 Qt, internal_delete_file_1);
2731 return NILP (tem);
2734 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2735 "fRename file: \nGRename %s to file: \np",
2736 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2737 If file has names other than FILE, it continues to have those names.
2738 Signals a `file-already-exists' error if a file NEWNAME already exists
2739 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2740 A number as third arg means request confirmation if NEWNAME already exists.
2741 This is what happens in interactive use with M-x. */)
2742 (file, newname, ok_if_already_exists)
2743 Lisp_Object file, newname, ok_if_already_exists;
2745 Lisp_Object handler;
2746 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2747 Lisp_Object encoded_file, encoded_newname, symlink_target;
2749 symlink_target = encoded_file = encoded_newname = Qnil;
2750 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2751 CHECK_STRING (file);
2752 CHECK_STRING (newname);
2753 file = Fexpand_file_name (file, Qnil);
2755 if ((!NILP (Ffile_directory_p (newname)))
2756 #ifdef DOS_NT
2757 /* If the file names are identical but for the case,
2758 don't attempt to move directory to itself. */
2759 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2760 #endif
2762 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2763 else
2764 newname = Fexpand_file_name (newname, Qnil);
2766 /* If the file name has special constructs in it,
2767 call the corresponding file handler. */
2768 handler = Ffind_file_name_handler (file, Qrename_file);
2769 if (NILP (handler))
2770 handler = Ffind_file_name_handler (newname, Qrename_file);
2771 if (!NILP (handler))
2772 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2773 file, newname, ok_if_already_exists));
2775 encoded_file = ENCODE_FILE (file);
2776 encoded_newname = ENCODE_FILE (newname);
2778 #ifdef DOS_NT
2779 /* If the file names are identical but for the case, don't ask for
2780 confirmation: they simply want to change the letter-case of the
2781 file name. */
2782 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2783 #endif
2784 if (NILP (ok_if_already_exists)
2785 || INTEGERP (ok_if_already_exists))
2786 barf_or_query_if_file_exists (newname, "rename to it",
2787 INTEGERP (ok_if_already_exists), 0, 0);
2788 #ifndef BSD4_1
2789 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2790 #else
2791 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2792 || 0 > unlink (SDATA (encoded_file)))
2793 #endif
2795 if (errno == EXDEV)
2797 #ifdef S_IFLNK
2798 symlink_target = Ffile_symlink_p (file);
2799 if (! NILP (symlink_target))
2800 Fmake_symbolic_link (symlink_target, newname,
2801 NILP (ok_if_already_exists) ? Qnil : Qt);
2802 else
2803 #endif
2804 Fcopy_file (file, newname,
2805 /* We have already prompted if it was an integer,
2806 so don't have copy-file prompt again. */
2807 NILP (ok_if_already_exists) ? Qnil : Qt,
2808 Qt, Qt);
2810 Fdelete_file (file);
2812 else
2813 report_file_error ("Renaming", list2 (file, newname));
2815 UNGCPRO;
2816 return Qnil;
2819 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2820 "fAdd name to file: \nGName to add to %s: \np",
2821 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2822 Signals a `file-already-exists' error if a file NEWNAME already exists
2823 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2824 A number as third arg means request confirmation if NEWNAME already exists.
2825 This is what happens in interactive use with M-x. */)
2826 (file, newname, ok_if_already_exists)
2827 Lisp_Object file, newname, ok_if_already_exists;
2829 Lisp_Object handler;
2830 Lisp_Object encoded_file, encoded_newname;
2831 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2833 GCPRO4 (file, newname, encoded_file, encoded_newname);
2834 encoded_file = encoded_newname = Qnil;
2835 CHECK_STRING (file);
2836 CHECK_STRING (newname);
2837 file = Fexpand_file_name (file, Qnil);
2839 if (!NILP (Ffile_directory_p (newname)))
2840 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2841 else
2842 newname = Fexpand_file_name (newname, Qnil);
2844 /* If the file name has special constructs in it,
2845 call the corresponding file handler. */
2846 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2847 if (!NILP (handler))
2848 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2849 newname, ok_if_already_exists));
2851 /* If the new name has special constructs in it,
2852 call the corresponding file handler. */
2853 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2854 if (!NILP (handler))
2855 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2856 newname, ok_if_already_exists));
2858 encoded_file = ENCODE_FILE (file);
2859 encoded_newname = ENCODE_FILE (newname);
2861 if (NILP (ok_if_already_exists)
2862 || INTEGERP (ok_if_already_exists))
2863 barf_or_query_if_file_exists (newname, "make it a new name",
2864 INTEGERP (ok_if_already_exists), 0, 0);
2866 unlink (SDATA (newname));
2867 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2868 report_file_error ("Adding new name", list2 (file, newname));
2870 UNGCPRO;
2871 return Qnil;
2874 #ifdef S_IFLNK
2875 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2876 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2877 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2878 Both args must be strings.
2879 Signals a `file-already-exists' error if a file LINKNAME already exists
2880 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2881 A number as third arg means request confirmation if LINKNAME already exists.
2882 This happens for interactive use with M-x. */)
2883 (filename, linkname, ok_if_already_exists)
2884 Lisp_Object filename, linkname, ok_if_already_exists;
2886 Lisp_Object handler;
2887 Lisp_Object encoded_filename, encoded_linkname;
2888 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2890 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2891 encoded_filename = encoded_linkname = Qnil;
2892 CHECK_STRING (filename);
2893 CHECK_STRING (linkname);
2894 /* If the link target has a ~, we must expand it to get
2895 a truly valid file name. Otherwise, do not expand;
2896 we want to permit links to relative file names. */
2897 if (SREF (filename, 0) == '~')
2898 filename = Fexpand_file_name (filename, Qnil);
2900 if (!NILP (Ffile_directory_p (linkname)))
2901 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2902 else
2903 linkname = Fexpand_file_name (linkname, Qnil);
2905 /* If the file name has special constructs in it,
2906 call the corresponding file handler. */
2907 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2908 if (!NILP (handler))
2909 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2910 linkname, ok_if_already_exists));
2912 /* If the new link name has special constructs in it,
2913 call the corresponding file handler. */
2914 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2915 if (!NILP (handler))
2916 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2917 linkname, ok_if_already_exists));
2919 encoded_filename = ENCODE_FILE (filename);
2920 encoded_linkname = ENCODE_FILE (linkname);
2922 if (NILP (ok_if_already_exists)
2923 || INTEGERP (ok_if_already_exists))
2924 barf_or_query_if_file_exists (linkname, "make it a link",
2925 INTEGERP (ok_if_already_exists), 0, 0);
2926 if (0 > symlink (SDATA (encoded_filename),
2927 SDATA (encoded_linkname)))
2929 /* If we didn't complain already, silently delete existing file. */
2930 if (errno == EEXIST)
2932 unlink (SDATA (encoded_linkname));
2933 if (0 <= symlink (SDATA (encoded_filename),
2934 SDATA (encoded_linkname)))
2936 UNGCPRO;
2937 return Qnil;
2941 report_file_error ("Making symbolic link", list2 (filename, linkname));
2943 UNGCPRO;
2944 return Qnil;
2946 #endif /* S_IFLNK */
2948 #ifdef VMS
2950 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2951 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2952 doc: /* Define the job-wide logical name NAME to have the value STRING.
2953 If STRING is nil or a null string, the logical name NAME is deleted. */)
2954 (name, string)
2955 Lisp_Object name;
2956 Lisp_Object string;
2958 CHECK_STRING (name);
2959 if (NILP (string))
2960 delete_logical_name (SDATA (name));
2961 else
2963 CHECK_STRING (string);
2965 if (SCHARS (string) == 0)
2966 delete_logical_name (SDATA (name));
2967 else
2968 define_logical_name (SDATA (name), SDATA (string));
2971 return string;
2973 #endif /* VMS */
2975 #ifdef HPUX_NET
2977 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2978 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2979 (path, login)
2980 Lisp_Object path, login;
2982 int netresult;
2984 CHECK_STRING (path);
2985 CHECK_STRING (login);
2987 netresult = netunam (SDATA (path), SDATA (login));
2989 if (netresult == -1)
2990 return Qnil;
2991 else
2992 return Qt;
2994 #endif /* HPUX_NET */
2996 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2997 1, 1, 0,
2998 doc: /* Return t if file FILENAME specifies an absolute file name.
2999 On Unix, this is a name starting with a `/' or a `~'. */)
3000 (filename)
3001 Lisp_Object filename;
3003 CHECK_STRING (filename);
3004 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3007 /* Return nonzero if file FILENAME exists and can be executed. */
3009 static int
3010 check_executable (filename)
3011 char *filename;
3013 #ifdef DOS_NT
3014 int len = strlen (filename);
3015 char *suffix;
3016 struct stat st;
3017 if (stat (filename, &st) < 0)
3018 return 0;
3019 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3020 return ((st.st_mode & S_IEXEC) != 0);
3021 #else
3022 return (S_ISREG (st.st_mode)
3023 && len >= 5
3024 && (stricmp ((suffix = filename + len-4), ".com") == 0
3025 || stricmp (suffix, ".exe") == 0
3026 || stricmp (suffix, ".bat") == 0)
3027 || (st.st_mode & S_IFMT) == S_IFDIR);
3028 #endif /* not WINDOWSNT */
3029 #else /* not DOS_NT */
3030 #ifdef HAVE_EUIDACCESS
3031 return (euidaccess (filename, 1) >= 0);
3032 #else
3033 /* Access isn't quite right because it uses the real uid
3034 and we really want to test with the effective uid.
3035 But Unix doesn't give us a right way to do it. */
3036 return (access (filename, 1) >= 0);
3037 #endif
3038 #endif /* not DOS_NT */
3041 /* Return nonzero if file FILENAME exists and can be written. */
3043 static int
3044 check_writable (filename)
3045 char *filename;
3047 #ifdef MSDOS
3048 struct stat st;
3049 if (stat (filename, &st) < 0)
3050 return 0;
3051 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3052 #else /* not MSDOS */
3053 #ifdef HAVE_EUIDACCESS
3054 return (euidaccess (filename, 2) >= 0);
3055 #else
3056 /* Access isn't quite right because it uses the real uid
3057 and we really want to test with the effective uid.
3058 But Unix doesn't give us a right way to do it.
3059 Opening with O_WRONLY could work for an ordinary file,
3060 but would lose for directories. */
3061 return (access (filename, 2) >= 0);
3062 #endif
3063 #endif /* not MSDOS */
3066 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3067 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3068 See also `file-readable-p' and `file-attributes'.
3069 This returns nil for a symlink to a nonexistent file.
3070 Use `file-symlink-p' to test for such links. */)
3071 (filename)
3072 Lisp_Object filename;
3074 Lisp_Object absname;
3075 Lisp_Object handler;
3076 struct stat statbuf;
3078 CHECK_STRING (filename);
3079 absname = Fexpand_file_name (filename, Qnil);
3081 /* If the file name has special constructs in it,
3082 call the corresponding file handler. */
3083 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3084 if (!NILP (handler))
3085 return call2 (handler, Qfile_exists_p, absname);
3087 absname = ENCODE_FILE (absname);
3089 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3092 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3093 doc: /* Return t if FILENAME can be executed by you.
3094 For a directory, this means you can access files in that directory. */)
3095 (filename)
3096 Lisp_Object filename;
3098 Lisp_Object absname;
3099 Lisp_Object handler;
3101 CHECK_STRING (filename);
3102 absname = Fexpand_file_name (filename, Qnil);
3104 /* If the file name has special constructs in it,
3105 call the corresponding file handler. */
3106 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3107 if (!NILP (handler))
3108 return call2 (handler, Qfile_executable_p, absname);
3110 absname = ENCODE_FILE (absname);
3112 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3115 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3116 doc: /* Return t if file FILENAME exists and you can read it.
3117 See also `file-exists-p' and `file-attributes'. */)
3118 (filename)
3119 Lisp_Object filename;
3121 Lisp_Object absname;
3122 Lisp_Object handler;
3123 int desc;
3124 int flags;
3125 struct stat statbuf;
3127 CHECK_STRING (filename);
3128 absname = Fexpand_file_name (filename, Qnil);
3130 /* If the file name has special constructs in it,
3131 call the corresponding file handler. */
3132 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3133 if (!NILP (handler))
3134 return call2 (handler, Qfile_readable_p, absname);
3136 absname = ENCODE_FILE (absname);
3138 #if defined(DOS_NT) || defined(macintosh)
3139 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3140 directories. */
3141 if (access (SDATA (absname), 0) == 0)
3142 return Qt;
3143 return Qnil;
3144 #else /* not DOS_NT and not macintosh */
3145 flags = O_RDONLY;
3146 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3147 /* Opening a fifo without O_NONBLOCK can wait.
3148 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3149 except in the case of a fifo, on a system which handles it. */
3150 desc = stat (SDATA (absname), &statbuf);
3151 if (desc < 0)
3152 return Qnil;
3153 if (S_ISFIFO (statbuf.st_mode))
3154 flags |= O_NONBLOCK;
3155 #endif
3156 desc = emacs_open (SDATA (absname), flags, 0);
3157 if (desc < 0)
3158 return Qnil;
3159 emacs_close (desc);
3160 return Qt;
3161 #endif /* not DOS_NT and not macintosh */
3164 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3165 on the RT/PC. */
3166 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3167 doc: /* Return t if file FILENAME can be written or created by you. */)
3168 (filename)
3169 Lisp_Object filename;
3171 Lisp_Object absname, dir, encoded;
3172 Lisp_Object handler;
3173 struct stat statbuf;
3175 CHECK_STRING (filename);
3176 absname = Fexpand_file_name (filename, Qnil);
3178 /* If the file name has special constructs in it,
3179 call the corresponding file handler. */
3180 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3181 if (!NILP (handler))
3182 return call2 (handler, Qfile_writable_p, absname);
3184 encoded = ENCODE_FILE (absname);
3185 if (stat (SDATA (encoded), &statbuf) >= 0)
3186 return (check_writable (SDATA (encoded))
3187 ? Qt : Qnil);
3189 dir = Ffile_name_directory (absname);
3190 #ifdef VMS
3191 if (!NILP (dir))
3192 dir = Fdirectory_file_name (dir);
3193 #endif /* VMS */
3194 #ifdef MSDOS
3195 if (!NILP (dir))
3196 dir = Fdirectory_file_name (dir);
3197 #endif /* MSDOS */
3199 dir = ENCODE_FILE (dir);
3200 #ifdef WINDOWSNT
3201 /* The read-only attribute of the parent directory doesn't affect
3202 whether a file or directory can be created within it. Some day we
3203 should check ACLs though, which do affect this. */
3204 if (stat (SDATA (dir), &statbuf) < 0)
3205 return Qnil;
3206 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3207 #else
3208 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3209 ? Qt : Qnil);
3210 #endif
3213 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3214 doc: /* Access file FILENAME, and get an error if that does not work.
3215 The second argument STRING is used in the error message.
3216 If there is no error, returns nil. */)
3217 (filename, string)
3218 Lisp_Object filename, string;
3220 Lisp_Object handler, encoded_filename, absname;
3221 int fd;
3223 CHECK_STRING (filename);
3224 absname = Fexpand_file_name (filename, Qnil);
3226 CHECK_STRING (string);
3228 /* If the file name has special constructs in it,
3229 call the corresponding file handler. */
3230 handler = Ffind_file_name_handler (absname, Qaccess_file);
3231 if (!NILP (handler))
3232 return call3 (handler, Qaccess_file, absname, string);
3234 encoded_filename = ENCODE_FILE (absname);
3236 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3237 if (fd < 0)
3238 report_file_error (SDATA (string), Fcons (filename, Qnil));
3239 emacs_close (fd);
3241 return Qnil;
3244 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3245 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3246 The value is the link target, as a string.
3247 Otherwise it returns nil.
3249 This function returns t when given the name of a symlink that
3250 points to a nonexistent file. */)
3251 (filename)
3252 Lisp_Object filename;
3254 Lisp_Object handler;
3256 CHECK_STRING (filename);
3257 filename = Fexpand_file_name (filename, Qnil);
3259 /* If the file name has special constructs in it,
3260 call the corresponding file handler. */
3261 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3262 if (!NILP (handler))
3263 return call2 (handler, Qfile_symlink_p, filename);
3265 #ifdef S_IFLNK
3267 char *buf;
3268 int bufsize;
3269 int valsize;
3270 Lisp_Object val;
3272 filename = ENCODE_FILE (filename);
3274 bufsize = 50;
3275 buf = NULL;
3278 bufsize *= 2;
3279 buf = (char *) xrealloc (buf, bufsize);
3280 bzero (buf, bufsize);
3282 errno = 0;
3283 valsize = readlink (SDATA (filename), buf, bufsize);
3284 if (valsize == -1)
3286 #ifdef ERANGE
3287 /* HP-UX reports ERANGE if buffer is too small. */
3288 if (errno == ERANGE)
3289 valsize = bufsize;
3290 else
3291 #endif
3293 xfree (buf);
3294 return Qnil;
3298 while (valsize >= bufsize);
3300 val = make_string (buf, valsize);
3301 if (buf[0] == '/' && index (buf, ':'))
3302 val = concat2 (build_string ("/:"), val);
3303 xfree (buf);
3304 val = DECODE_FILE (val);
3305 return val;
3307 #else /* not S_IFLNK */
3308 return Qnil;
3309 #endif /* not S_IFLNK */
3312 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3313 doc: /* Return t if FILENAME names an existing directory.
3314 Symbolic links to directories count as directories.
3315 See `file-symlink-p' to distinguish symlinks. */)
3316 (filename)
3317 Lisp_Object filename;
3319 register Lisp_Object absname;
3320 struct stat st;
3321 Lisp_Object handler;
3323 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3325 /* If the file name has special constructs in it,
3326 call the corresponding file handler. */
3327 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3328 if (!NILP (handler))
3329 return call2 (handler, Qfile_directory_p, absname);
3331 absname = ENCODE_FILE (absname);
3333 if (stat (SDATA (absname), &st) < 0)
3334 return Qnil;
3335 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3338 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3339 doc: /* Return t if file FILENAME names a directory you can open.
3340 For the value to be t, FILENAME must specify the name of a directory as a file,
3341 and the directory must allow you to open files in it. In order to use a
3342 directory as a buffer's current directory, this predicate must return true.
3343 A directory name spec may be given instead; then the value is t
3344 if the directory so specified exists and really is a readable and
3345 searchable directory. */)
3346 (filename)
3347 Lisp_Object filename;
3349 Lisp_Object handler;
3350 int tem;
3351 struct gcpro gcpro1;
3353 /* If the file name has special constructs in it,
3354 call the corresponding file handler. */
3355 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3356 if (!NILP (handler))
3357 return call2 (handler, Qfile_accessible_directory_p, filename);
3359 GCPRO1 (filename);
3360 tem = (NILP (Ffile_directory_p (filename))
3361 || NILP (Ffile_executable_p (filename)));
3362 UNGCPRO;
3363 return tem ? Qnil : Qt;
3366 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3367 doc: /* Return t if FILENAME names a regular file.
3368 This is the sort of file that holds an ordinary stream of data bytes.
3369 Symbolic links to regular files count as regular files.
3370 See `file-symlink-p' to distinguish symlinks. */)
3371 (filename)
3372 Lisp_Object filename;
3374 register Lisp_Object absname;
3375 struct stat st;
3376 Lisp_Object handler;
3378 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3380 /* If the file name has special constructs in it,
3381 call the corresponding file handler. */
3382 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3383 if (!NILP (handler))
3384 return call2 (handler, Qfile_regular_p, absname);
3386 absname = ENCODE_FILE (absname);
3388 #ifdef WINDOWSNT
3390 int result;
3391 Lisp_Object tem = Vw32_get_true_file_attributes;
3393 /* Tell stat to use expensive method to get accurate info. */
3394 Vw32_get_true_file_attributes = Qt;
3395 result = stat (SDATA (absname), &st);
3396 Vw32_get_true_file_attributes = tem;
3398 if (result < 0)
3399 return Qnil;
3400 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3402 #else
3403 if (stat (SDATA (absname), &st) < 0)
3404 return Qnil;
3405 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3406 #endif
3409 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3410 doc: /* Return mode bits of file named FILENAME, as an integer.
3411 Return nil, if file does not exist or is not accessible. */)
3412 (filename)
3413 Lisp_Object filename;
3415 Lisp_Object absname;
3416 struct stat st;
3417 Lisp_Object handler;
3419 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3421 /* If the file name has special constructs in it,
3422 call the corresponding file handler. */
3423 handler = Ffind_file_name_handler (absname, Qfile_modes);
3424 if (!NILP (handler))
3425 return call2 (handler, Qfile_modes, absname);
3427 absname = ENCODE_FILE (absname);
3429 if (stat (SDATA (absname), &st) < 0)
3430 return Qnil;
3431 #if defined (MSDOS) && __DJGPP__ < 2
3432 if (check_executable (SDATA (absname)))
3433 st.st_mode |= S_IEXEC;
3434 #endif /* MSDOS && __DJGPP__ < 2 */
3436 return make_number (st.st_mode & 07777);
3439 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2,
3440 "(let ((file (read-file-name \"File: \"))) \
3441 (list file (read-file-modes nil file)))",
3442 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3443 Only the 12 low bits of MODE are used. */)
3444 (filename, mode)
3445 Lisp_Object filename, mode;
3447 Lisp_Object absname, encoded_absname;
3448 Lisp_Object handler;
3450 absname = Fexpand_file_name (filename, current_buffer->directory);
3451 CHECK_NUMBER (mode);
3453 /* If the file name has special constructs in it,
3454 call the corresponding file handler. */
3455 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3456 if (!NILP (handler))
3457 return call3 (handler, Qset_file_modes, absname, mode);
3459 encoded_absname = ENCODE_FILE (absname);
3461 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3462 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3464 return Qnil;
3467 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3468 doc: /* Set the file permission bits for newly created files.
3469 The argument MODE should be an integer; only the low 9 bits are used.
3470 This setting is inherited by subprocesses. */)
3471 (mode)
3472 Lisp_Object mode;
3474 CHECK_NUMBER (mode);
3476 umask ((~ XINT (mode)) & 0777);
3478 return Qnil;
3481 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3482 doc: /* Return the default file protection for created files.
3483 The value is an integer. */)
3486 int realmask;
3487 Lisp_Object value;
3489 realmask = umask (0);
3490 umask (realmask);
3492 XSETINT (value, (~ realmask) & 0777);
3493 return value;
3496 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3498 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3499 doc: /* Set times of file FILENAME to TIME.
3500 Set both access and modification times.
3501 Return t on success, else nil.
3502 Use the current time if TIME is nil. TIME is in the format of
3503 `current-time'. */)
3504 (filename, time)
3505 Lisp_Object filename, time;
3507 Lisp_Object absname, encoded_absname;
3508 Lisp_Object handler;
3509 time_t sec;
3510 int usec;
3512 if (! lisp_time_argument (time, &sec, &usec))
3513 error ("Invalid time specification");
3515 absname = Fexpand_file_name (filename, current_buffer->directory);
3517 /* If the file name has special constructs in it,
3518 call the corresponding file handler. */
3519 handler = Ffind_file_name_handler (absname, Qset_file_times);
3520 if (!NILP (handler))
3521 return call3 (handler, Qset_file_times, absname, time);
3523 encoded_absname = ENCODE_FILE (absname);
3526 EMACS_TIME t;
3528 EMACS_SET_SECS (t, sec);
3529 EMACS_SET_USECS (t, usec);
3531 if (set_file_times (SDATA (encoded_absname), t, t))
3533 #ifdef DOS_NT
3534 struct stat st;
3536 /* Setting times on a directory always fails. */
3537 if (stat (SDATA (encoded_absname), &st) == 0
3538 && (st.st_mode & S_IFMT) == S_IFDIR)
3539 return Qnil;
3540 #endif
3541 report_file_error ("Setting file times", Fcons (absname, Qnil));
3542 return Qnil;
3546 return Qt;
3549 #ifdef HAVE_SYNC
3550 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3551 doc: /* Tell Unix to finish all pending disk updates. */)
3554 sync ();
3555 return Qnil;
3558 #endif /* HAVE_SYNC */
3560 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3561 doc: /* Return t if file FILE1 is newer than file FILE2.
3562 If FILE1 does not exist, the answer is nil;
3563 otherwise, if FILE2 does not exist, the answer is t. */)
3564 (file1, file2)
3565 Lisp_Object file1, file2;
3567 Lisp_Object absname1, absname2;
3568 struct stat st;
3569 int mtime1;
3570 Lisp_Object handler;
3571 struct gcpro gcpro1, gcpro2;
3573 CHECK_STRING (file1);
3574 CHECK_STRING (file2);
3576 absname1 = Qnil;
3577 GCPRO2 (absname1, file2);
3578 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3579 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3580 UNGCPRO;
3582 /* If the file name has special constructs in it,
3583 call the corresponding file handler. */
3584 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3585 if (NILP (handler))
3586 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3587 if (!NILP (handler))
3588 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3590 GCPRO2 (absname1, absname2);
3591 absname1 = ENCODE_FILE (absname1);
3592 absname2 = ENCODE_FILE (absname2);
3593 UNGCPRO;
3595 if (stat (SDATA (absname1), &st) < 0)
3596 return Qnil;
3598 mtime1 = st.st_mtime;
3600 if (stat (SDATA (absname2), &st) < 0)
3601 return Qt;
3603 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3606 #ifdef DOS_NT
3607 Lisp_Object Qfind_buffer_file_type;
3608 #endif /* DOS_NT */
3610 #ifndef READ_BUF_SIZE
3611 #define READ_BUF_SIZE (64 << 10)
3612 #endif
3614 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3616 /* This function is called after Lisp functions to decide a coding
3617 system are called, or when they cause an error. Before they are
3618 called, the current buffer is set unibyte and it contains only a
3619 newly inserted text (thus the buffer was empty before the
3620 insertion).
3622 The functions may set markers, overlays, text properties, or even
3623 alter the buffer contents, change the current buffer.
3625 Here, we reset all those changes by:
3626 o set back the current buffer.
3627 o move all markers and overlays to BEG.
3628 o remove all text properties.
3629 o set back the buffer multibyteness. */
3631 static Lisp_Object
3632 decide_coding_unwind (unwind_data)
3633 Lisp_Object unwind_data;
3635 Lisp_Object multibyte, undo_list, buffer;
3637 multibyte = XCAR (unwind_data);
3638 unwind_data = XCDR (unwind_data);
3639 undo_list = XCAR (unwind_data);
3640 buffer = XCDR (unwind_data);
3642 if (current_buffer != XBUFFER (buffer))
3643 set_buffer_internal (XBUFFER (buffer));
3644 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3645 adjust_overlays_for_delete (BEG, Z - BEG);
3646 BUF_INTERVALS (current_buffer) = 0;
3647 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3649 /* Now we are safe to change the buffer's multibyteness directly. */
3650 current_buffer->enable_multibyte_characters = multibyte;
3651 current_buffer->undo_list = undo_list;
3653 return Qnil;
3657 /* Used to pass values from insert-file-contents to read_non_regular. */
3659 static int non_regular_fd;
3660 static int non_regular_inserted;
3661 static int non_regular_nbytes;
3664 /* Read from a non-regular file.
3665 Read non_regular_trytry bytes max from non_regular_fd.
3666 Non_regular_inserted specifies where to put the read bytes.
3667 Value is the number of bytes read. */
3669 static Lisp_Object
3670 read_non_regular ()
3672 int nbytes;
3674 immediate_quit = 1;
3675 QUIT;
3676 nbytes = emacs_read (non_regular_fd,
3677 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3678 non_regular_nbytes);
3679 immediate_quit = 0;
3680 return make_number (nbytes);
3684 /* Condition-case handler used when reading from non-regular files
3685 in insert-file-contents. */
3687 static Lisp_Object
3688 read_non_regular_quit ()
3690 return Qnil;
3694 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3695 1, 5, 0,
3696 doc: /* Insert contents of file FILENAME after point.
3697 Returns list of absolute file name and number of characters inserted.
3698 If second argument VISIT is non-nil, the buffer's visited filename and
3699 last save file modtime are set, and it is marked unmodified. If
3700 visiting and the file does not exist, visiting is completed before the
3701 error is signaled.
3703 The optional third and fourth arguments BEG and END specify what portion
3704 of the file to insert. These arguments count bytes in the file, not
3705 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3707 If optional fifth argument REPLACE is non-nil, replace the current
3708 buffer contents (in the accessible portion) with the file contents.
3709 This is better than simply deleting and inserting the whole thing
3710 because (1) it preserves some marker positions and (2) it puts less data
3711 in the undo list. When REPLACE is non-nil, the second return value is
3712 the number of characters that replace previous buffer contents.
3714 This function does code conversion according to the value of
3715 `coding-system-for-read' or `file-coding-system-alist', and sets the
3716 variable `last-coding-system-used' to the coding system actually used. */)
3717 (filename, visit, beg, end, replace)
3718 Lisp_Object filename, visit, beg, end, replace;
3720 struct stat st;
3721 register int fd;
3722 int inserted = 0;
3723 register int how_much;
3724 register int unprocessed;
3725 int count = SPECPDL_INDEX ();
3726 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3727 Lisp_Object handler, val, insval, orig_filename, old_undo;
3728 Lisp_Object p;
3729 int total = 0;
3730 int not_regular = 0;
3731 unsigned char read_buf[READ_BUF_SIZE];
3732 struct coding_system coding;
3733 unsigned char buffer[1 << 14];
3734 int replace_handled = 0;
3735 int set_coding_system = 0;
3736 int coding_system_decided = 0;
3737 int read_quit = 0;
3738 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3739 int we_locked_file = 0;
3741 if (current_buffer->base_buffer && ! NILP (visit))
3742 error ("Cannot do file visiting in an indirect buffer");
3744 if (!NILP (current_buffer->read_only))
3745 Fbarf_if_buffer_read_only ();
3747 val = Qnil;
3748 p = Qnil;
3749 orig_filename = Qnil;
3750 old_undo = Qnil;
3752 GCPRO5 (filename, val, p, orig_filename, old_undo);
3754 CHECK_STRING (filename);
3755 filename = Fexpand_file_name (filename, Qnil);
3757 /* If the file name has special constructs in it,
3758 call the corresponding file handler. */
3759 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3760 if (!NILP (handler))
3762 val = call6 (handler, Qinsert_file_contents, filename,
3763 visit, beg, end, replace);
3764 if (CONSP (val) && CONSP (XCDR (val)))
3765 inserted = XINT (XCAR (XCDR (val)));
3766 goto handled;
3769 orig_filename = filename;
3770 filename = ENCODE_FILE (filename);
3772 fd = -1;
3774 #ifdef WINDOWSNT
3776 Lisp_Object tem = Vw32_get_true_file_attributes;
3778 /* Tell stat to use expensive method to get accurate info. */
3779 Vw32_get_true_file_attributes = Qt;
3780 total = stat (SDATA (filename), &st);
3781 Vw32_get_true_file_attributes = tem;
3783 if (total < 0)
3784 #else
3785 #ifndef APOLLO
3786 if (stat (SDATA (filename), &st) < 0)
3787 #else
3788 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3789 || fstat (fd, &st) < 0)
3790 #endif /* not APOLLO */
3791 #endif /* WINDOWSNT */
3793 if (fd >= 0) emacs_close (fd);
3794 badopen:
3795 if (NILP (visit))
3796 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3797 st.st_mtime = -1;
3798 how_much = 0;
3799 if (!NILP (Vcoding_system_for_read))
3800 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3801 goto notfound;
3804 #ifdef S_IFREG
3805 /* This code will need to be changed in order to work on named
3806 pipes, and it's probably just not worth it. So we should at
3807 least signal an error. */
3808 if (!S_ISREG (st.st_mode))
3810 not_regular = 1;
3812 if (! NILP (visit))
3813 goto notfound;
3815 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3816 xsignal2 (Qfile_error,
3817 build_string ("not a regular file"), orig_filename);
3819 #endif
3821 if (fd < 0)
3822 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3823 goto badopen;
3825 /* Replacement should preserve point as it preserves markers. */
3826 if (!NILP (replace))
3827 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3829 record_unwind_protect (close_file_unwind, make_number (fd));
3831 /* Supposedly happens on VMS. */
3832 /* Can happen on any platform that uses long as type of off_t, but allows
3833 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3834 give a message suitable for the latter case. */
3835 if (! not_regular && st.st_size < 0)
3836 error ("Maximum buffer size exceeded");
3838 /* Prevent redisplay optimizations. */
3839 current_buffer->clip_changed = 1;
3841 if (!NILP (visit))
3843 if (!NILP (beg) || !NILP (end))
3844 error ("Attempt to visit less than an entire file");
3845 if (BEG < Z && NILP (replace))
3846 error ("Cannot do file visiting in a non-empty buffer");
3849 if (!NILP (beg))
3850 CHECK_NUMBER (beg);
3851 else
3852 XSETFASTINT (beg, 0);
3854 if (!NILP (end))
3855 CHECK_NUMBER (end);
3856 else
3858 if (! not_regular)
3860 XSETINT (end, st.st_size);
3862 /* Arithmetic overflow can occur if an Emacs integer cannot
3863 represent the file size, or if the calculations below
3864 overflow. The calculations below double the file size
3865 twice, so check that it can be multiplied by 4 safely. */
3866 if (XINT (end) != st.st_size
3867 || st.st_size > INT_MAX / 4)
3868 error ("Maximum buffer size exceeded");
3870 /* The file size returned from stat may be zero, but data
3871 may be readable nonetheless, for example when this is a
3872 file in the /proc filesystem. */
3873 if (st.st_size == 0)
3874 XSETINT (end, READ_BUF_SIZE);
3878 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3880 /* We use emacs-mule for auto saving... */
3881 setup_coding_system (Qemacs_mule, &coding);
3882 /* ... but with the special flag to indicate to read in a
3883 multibyte sequence for eight-bit-control char as is. */
3884 coding.flags = 1;
3885 coding.src_multibyte = 0;
3886 coding.dst_multibyte
3887 = !NILP (current_buffer->enable_multibyte_characters);
3888 coding.eol_type = CODING_EOL_LF;
3889 coding_system_decided = 1;
3891 else if (BEG < Z)
3893 /* Decide the coding system to use for reading the file now
3894 because we can't use an optimized method for handling
3895 `coding:' tag if the current buffer is not empty. */
3896 Lisp_Object val;
3897 val = Qnil;
3899 if (!NILP (Vcoding_system_for_read))
3900 val = Vcoding_system_for_read;
3901 else
3903 /* Don't try looking inside a file for a coding system
3904 specification if it is not seekable. */
3905 if (! not_regular && ! NILP (Vset_auto_coding_function))
3907 /* Find a coding system specified in the heading two
3908 lines or in the tailing several lines of the file.
3909 We assume that the 1K-byte and 3K-byte for heading
3910 and tailing respectively are sufficient for this
3911 purpose. */
3912 int nread;
3914 if (st.st_size <= (1024 * 4))
3915 nread = emacs_read (fd, read_buf, 1024 * 4);
3916 else
3918 nread = emacs_read (fd, read_buf, 1024);
3919 if (nread >= 0)
3921 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3922 report_file_error ("Setting file position",
3923 Fcons (orig_filename, Qnil));
3924 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3928 if (nread < 0)
3929 error ("IO error reading %s: %s",
3930 SDATA (orig_filename), emacs_strerror (errno));
3931 else if (nread > 0)
3933 struct buffer *prev = current_buffer;
3934 Lisp_Object buffer;
3935 struct buffer *buf;
3937 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3939 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3940 buf = XBUFFER (buffer);
3942 delete_all_overlays (buf);
3943 buf->directory = current_buffer->directory;
3944 buf->read_only = Qnil;
3945 buf->filename = Qnil;
3946 buf->undo_list = Qt;
3947 eassert (buf->overlays_before == NULL);
3948 eassert (buf->overlays_after == NULL);
3950 set_buffer_internal (buf);
3951 Ferase_buffer ();
3952 buf->enable_multibyte_characters = Qnil;
3954 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3955 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3956 val = call2 (Vset_auto_coding_function,
3957 filename, make_number (nread));
3958 set_buffer_internal (prev);
3960 /* Discard the unwind protect for recovering the
3961 current buffer. */
3962 specpdl_ptr--;
3964 /* Rewind the file for the actual read done later. */
3965 if (lseek (fd, 0, 0) < 0)
3966 report_file_error ("Setting file position",
3967 Fcons (orig_filename, Qnil));
3971 if (NILP (val))
3973 /* If we have not yet decided a coding system, check
3974 file-coding-system-alist. */
3975 Lisp_Object args[6], coding_systems;
3977 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3978 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3979 coding_systems = Ffind_operation_coding_system (6, args);
3980 if (CONSP (coding_systems))
3981 val = XCAR (coding_systems);
3985 setup_coding_system (Fcheck_coding_system (val), &coding);
3986 /* Ensure we set Vlast_coding_system_used. */
3987 set_coding_system = 1;
3989 if (NILP (current_buffer->enable_multibyte_characters)
3990 && ! NILP (val))
3991 /* We must suppress all character code conversion except for
3992 end-of-line conversion. */
3993 setup_raw_text_coding_system (&coding);
3995 coding.src_multibyte = 0;
3996 coding.dst_multibyte
3997 = !NILP (current_buffer->enable_multibyte_characters);
3998 coding_system_decided = 1;
4001 /* If requested, replace the accessible part of the buffer
4002 with the file contents. Avoid replacing text at the
4003 beginning or end of the buffer that matches the file contents;
4004 that preserves markers pointing to the unchanged parts.
4006 Here we implement this feature in an optimized way
4007 for the case where code conversion is NOT needed.
4008 The following if-statement handles the case of conversion
4009 in a less optimal way.
4011 If the code conversion is "automatic" then we try using this
4012 method and hope for the best.
4013 But if we discover the need for conversion, we give up on this method
4014 and let the following if-statement handle the replace job. */
4015 if (!NILP (replace)
4016 && BEGV < ZV
4017 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4019 /* same_at_start and same_at_end count bytes,
4020 because file access counts bytes
4021 and BEG and END count bytes. */
4022 int same_at_start = BEGV_BYTE;
4023 int same_at_end = ZV_BYTE;
4024 int overlap;
4025 /* There is still a possibility we will find the need to do code
4026 conversion. If that happens, we set this variable to 1 to
4027 give up on handling REPLACE in the optimized way. */
4028 int giveup_match_end = 0;
4030 if (XINT (beg) != 0)
4032 if (lseek (fd, XINT (beg), 0) < 0)
4033 report_file_error ("Setting file position",
4034 Fcons (orig_filename, Qnil));
4037 immediate_quit = 1;
4038 QUIT;
4039 /* Count how many chars at the start of the file
4040 match the text at the beginning of the buffer. */
4041 while (1)
4043 int nread, bufpos;
4045 nread = emacs_read (fd, buffer, sizeof buffer);
4046 if (nread < 0)
4047 error ("IO error reading %s: %s",
4048 SDATA (orig_filename), emacs_strerror (errno));
4049 else if (nread == 0)
4050 break;
4052 if (coding.type == coding_type_undecided)
4053 detect_coding (&coding, buffer, nread);
4054 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4055 /* We found that the file should be decoded somehow.
4056 Let's give up here. */
4058 giveup_match_end = 1;
4059 break;
4062 if (coding.eol_type == CODING_EOL_UNDECIDED)
4063 detect_eol (&coding, buffer, nread);
4064 if (coding.eol_type != CODING_EOL_UNDECIDED
4065 && coding.eol_type != CODING_EOL_LF)
4066 /* We found that the format of eol should be decoded.
4067 Let's give up here. */
4069 giveup_match_end = 1;
4070 break;
4073 bufpos = 0;
4074 while (bufpos < nread && same_at_start < ZV_BYTE
4075 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4076 same_at_start++, bufpos++;
4077 /* If we found a discrepancy, stop the scan.
4078 Otherwise loop around and scan the next bufferful. */
4079 if (bufpos != nread)
4080 break;
4082 immediate_quit = 0;
4083 /* If the file matches the buffer completely,
4084 there's no need to replace anything. */
4085 if (same_at_start - BEGV_BYTE == XINT (end))
4087 emacs_close (fd);
4088 specpdl_ptr--;
4089 /* Truncate the buffer to the size of the file. */
4090 del_range_1 (same_at_start, same_at_end, 0, 0);
4091 goto handled;
4093 immediate_quit = 1;
4094 QUIT;
4095 /* Count how many chars at the end of the file
4096 match the text at the end of the buffer. But, if we have
4097 already found that decoding is necessary, don't waste time. */
4098 while (!giveup_match_end)
4100 int total_read, nread, bufpos, curpos, trial;
4102 /* At what file position are we now scanning? */
4103 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4104 /* If the entire file matches the buffer tail, stop the scan. */
4105 if (curpos == 0)
4106 break;
4107 /* How much can we scan in the next step? */
4108 trial = min (curpos, sizeof buffer);
4109 if (lseek (fd, curpos - trial, 0) < 0)
4110 report_file_error ("Setting file position",
4111 Fcons (orig_filename, Qnil));
4113 total_read = nread = 0;
4114 while (total_read < trial)
4116 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4117 if (nread < 0)
4118 error ("IO error reading %s: %s",
4119 SDATA (orig_filename), emacs_strerror (errno));
4120 else if (nread == 0)
4121 break;
4122 total_read += nread;
4125 /* Scan this bufferful from the end, comparing with
4126 the Emacs buffer. */
4127 bufpos = total_read;
4129 /* Compare with same_at_start to avoid counting some buffer text
4130 as matching both at the file's beginning and at the end. */
4131 while (bufpos > 0 && same_at_end > same_at_start
4132 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4133 same_at_end--, bufpos--;
4135 /* If we found a discrepancy, stop the scan.
4136 Otherwise loop around and scan the preceding bufferful. */
4137 if (bufpos != 0)
4139 /* If this discrepancy is because of code conversion,
4140 we cannot use this method; giveup and try the other. */
4141 if (same_at_end > same_at_start
4142 && FETCH_BYTE (same_at_end - 1) >= 0200
4143 && ! NILP (current_buffer->enable_multibyte_characters)
4144 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4145 giveup_match_end = 1;
4146 break;
4149 if (nread == 0)
4150 break;
4152 immediate_quit = 0;
4154 if (! giveup_match_end)
4156 int temp;
4158 /* We win! We can handle REPLACE the optimized way. */
4160 /* Extend the start of non-matching text area to multibyte
4161 character boundary. */
4162 if (! NILP (current_buffer->enable_multibyte_characters))
4163 while (same_at_start > BEGV_BYTE
4164 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4165 same_at_start--;
4167 /* Extend the end of non-matching text area to multibyte
4168 character boundary. */
4169 if (! NILP (current_buffer->enable_multibyte_characters))
4170 while (same_at_end < ZV_BYTE
4171 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4172 same_at_end++;
4174 /* Don't try to reuse the same piece of text twice. */
4175 overlap = (same_at_start - BEGV_BYTE
4176 - (same_at_end + st.st_size - ZV));
4177 if (overlap > 0)
4178 same_at_end += overlap;
4180 /* Arrange to read only the nonmatching middle part of the file. */
4181 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4182 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4184 del_range_byte (same_at_start, same_at_end, 0);
4185 /* Insert from the file at the proper position. */
4186 temp = BYTE_TO_CHAR (same_at_start);
4187 SET_PT_BOTH (temp, same_at_start);
4189 /* If display currently starts at beginning of line,
4190 keep it that way. */
4191 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4192 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4194 replace_handled = 1;
4198 /* If requested, replace the accessible part of the buffer
4199 with the file contents. Avoid replacing text at the
4200 beginning or end of the buffer that matches the file contents;
4201 that preserves markers pointing to the unchanged parts.
4203 Here we implement this feature for the case where code conversion
4204 is needed, in a simple way that needs a lot of memory.
4205 The preceding if-statement handles the case of no conversion
4206 in a more optimized way. */
4207 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4209 int same_at_start = BEGV_BYTE;
4210 int same_at_end = ZV_BYTE;
4211 int overlap;
4212 int bufpos;
4213 /* Make sure that the gap is large enough. */
4214 int bufsize = 2 * st.st_size;
4215 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4216 int temp;
4218 /* First read the whole file, performing code conversion into
4219 CONVERSION_BUFFER. */
4221 if (lseek (fd, XINT (beg), 0) < 0)
4223 xfree (conversion_buffer);
4224 report_file_error ("Setting file position",
4225 Fcons (orig_filename, Qnil));
4228 total = st.st_size; /* Total bytes in the file. */
4229 how_much = 0; /* Bytes read from file so far. */
4230 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4231 unprocessed = 0; /* Bytes not processed in previous loop. */
4233 while (how_much < total)
4235 /* try is reserved in some compilers (Microsoft C) */
4236 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4237 unsigned char *destination = read_buf + unprocessed;
4238 int this;
4240 /* Allow quitting out of the actual I/O. */
4241 immediate_quit = 1;
4242 QUIT;
4243 this = emacs_read (fd, destination, trytry);
4244 immediate_quit = 0;
4246 if (this < 0 || this + unprocessed == 0)
4248 how_much = this;
4249 break;
4252 how_much += this;
4254 if (CODING_MAY_REQUIRE_DECODING (&coding))
4256 int require, result;
4258 this += unprocessed;
4260 /* If we are using more space than estimated,
4261 make CONVERSION_BUFFER bigger. */
4262 require = decoding_buffer_size (&coding, this);
4263 if (inserted + require + 2 * (total - how_much) > bufsize)
4265 bufsize = inserted + require + 2 * (total - how_much);
4266 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4269 /* Convert this batch with results in CONVERSION_BUFFER. */
4270 if (how_much >= total) /* This is the last block. */
4271 coding.mode |= CODING_MODE_LAST_BLOCK;
4272 if (coding.composing != COMPOSITION_DISABLED)
4273 coding_allocate_composition_data (&coding, BEGV);
4274 result = decode_coding (&coding, read_buf,
4275 conversion_buffer + inserted,
4276 this, bufsize - inserted);
4278 /* Save for next iteration whatever we didn't convert. */
4279 unprocessed = this - coding.consumed;
4280 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4281 if (!NILP (current_buffer->enable_multibyte_characters))
4282 this = coding.produced;
4283 else
4284 this = str_as_unibyte (conversion_buffer + inserted,
4285 coding.produced);
4288 inserted += this;
4291 /* At this point, INSERTED is how many characters (i.e. bytes)
4292 are present in CONVERSION_BUFFER.
4293 HOW_MUCH should equal TOTAL,
4294 or should be <= 0 if we couldn't read the file. */
4296 if (how_much < 0)
4298 xfree (conversion_buffer);
4299 coding_free_composition_data (&coding);
4300 error ("IO error reading %s: %s",
4301 SDATA (orig_filename), emacs_strerror (errno));
4304 /* Compare the beginning of the converted file
4305 with the buffer text. */
4307 bufpos = 0;
4308 while (bufpos < inserted && same_at_start < same_at_end
4309 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4310 same_at_start++, bufpos++;
4312 /* If the file matches the buffer completely,
4313 there's no need to replace anything. */
4315 if (bufpos == inserted)
4317 xfree (conversion_buffer);
4318 coding_free_composition_data (&coding);
4319 emacs_close (fd);
4320 specpdl_ptr--;
4321 /* Truncate the buffer to the size of the file. */
4322 del_range_byte (same_at_start, same_at_end, 0);
4323 inserted = 0;
4324 goto handled;
4327 /* Extend the start of non-matching text area to multibyte
4328 character boundary. */
4329 if (! NILP (current_buffer->enable_multibyte_characters))
4330 while (same_at_start > BEGV_BYTE
4331 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4332 same_at_start--;
4334 /* Scan this bufferful from the end, comparing with
4335 the Emacs buffer. */
4336 bufpos = inserted;
4338 /* Compare with same_at_start to avoid counting some buffer text
4339 as matching both at the file's beginning and at the end. */
4340 while (bufpos > 0 && same_at_end > same_at_start
4341 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4342 same_at_end--, bufpos--;
4344 /* Extend the end of non-matching text area to multibyte
4345 character boundary. */
4346 if (! NILP (current_buffer->enable_multibyte_characters))
4347 while (same_at_end < ZV_BYTE
4348 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4349 same_at_end++;
4351 /* Don't try to reuse the same piece of text twice. */
4352 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4353 if (overlap > 0)
4354 same_at_end += overlap;
4356 /* If display currently starts at beginning of line,
4357 keep it that way. */
4358 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4359 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4361 /* Replace the chars that we need to replace,
4362 and update INSERTED to equal the number of bytes
4363 we are taking from the file. */
4364 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4366 if (same_at_end != same_at_start)
4368 del_range_byte (same_at_start, same_at_end, 0);
4369 temp = GPT;
4370 same_at_start = GPT_BYTE;
4372 else
4374 temp = BYTE_TO_CHAR (same_at_start);
4376 /* Insert from the file at the proper position. */
4377 SET_PT_BOTH (temp, same_at_start);
4378 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4379 0, 0, 0);
4380 if (coding.cmp_data && coding.cmp_data->used)
4381 coding_restore_composition (&coding, Fcurrent_buffer ());
4382 coding_free_composition_data (&coding);
4384 /* Set `inserted' to the number of inserted characters. */
4385 inserted = PT - temp;
4386 /* Set point before the inserted characters. */
4387 SET_PT_BOTH (temp, same_at_start);
4389 xfree (conversion_buffer);
4390 emacs_close (fd);
4391 specpdl_ptr--;
4393 goto handled;
4396 if (! not_regular)
4398 register Lisp_Object temp;
4400 total = XINT (end) - XINT (beg);
4402 /* Make sure point-max won't overflow after this insertion. */
4403 XSETINT (temp, total);
4404 if (total != XINT (temp))
4405 error ("Maximum buffer size exceeded");
4407 else
4408 /* For a special file, all we can do is guess. */
4409 total = READ_BUF_SIZE;
4411 if (NILP (visit) && inserted > 0)
4413 #ifdef CLASH_DETECTION
4414 if (!NILP (current_buffer->file_truename)
4415 /* Make binding buffer-file-name to nil effective. */
4416 && !NILP (current_buffer->filename)
4417 && SAVE_MODIFF >= MODIFF)
4418 we_locked_file = 1;
4419 #endif /* CLASH_DETECTION */
4420 prepare_to_modify_buffer (GPT, GPT, NULL);
4423 move_gap (PT);
4424 if (GAP_SIZE < total)
4425 make_gap (total - GAP_SIZE);
4427 if (XINT (beg) != 0 || !NILP (replace))
4429 if (lseek (fd, XINT (beg), 0) < 0)
4430 report_file_error ("Setting file position",
4431 Fcons (orig_filename, Qnil));
4434 /* In the following loop, HOW_MUCH contains the total bytes read so
4435 far for a regular file, and not changed for a special file. But,
4436 before exiting the loop, it is set to a negative value if I/O
4437 error occurs. */
4438 how_much = 0;
4440 /* Total bytes inserted. */
4441 inserted = 0;
4443 /* Here, we don't do code conversion in the loop. It is done by
4444 code_convert_region after all data are read into the buffer. */
4446 int gap_size = GAP_SIZE;
4448 while (how_much < total)
4450 /* try is reserved in some compilers (Microsoft C) */
4451 int trytry = min (total - how_much, READ_BUF_SIZE);
4452 int this;
4454 if (not_regular)
4456 Lisp_Object val;
4458 /* Maybe make more room. */
4459 if (gap_size < trytry)
4461 make_gap (total - gap_size);
4462 gap_size = GAP_SIZE;
4465 /* Read from the file, capturing `quit'. When an
4466 error occurs, end the loop, and arrange for a quit
4467 to be signaled after decoding the text we read. */
4468 non_regular_fd = fd;
4469 non_regular_inserted = inserted;
4470 non_regular_nbytes = trytry;
4471 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4472 read_non_regular_quit);
4473 if (NILP (val))
4475 read_quit = 1;
4476 break;
4479 this = XINT (val);
4481 else
4483 /* Allow quitting out of the actual I/O. We don't make text
4484 part of the buffer until all the reading is done, so a C-g
4485 here doesn't do any harm. */
4486 immediate_quit = 1;
4487 QUIT;
4488 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4489 immediate_quit = 0;
4492 if (this <= 0)
4494 how_much = this;
4495 break;
4498 gap_size -= this;
4500 /* For a regular file, where TOTAL is the real size,
4501 count HOW_MUCH to compare with it.
4502 For a special file, where TOTAL is just a buffer size,
4503 so don't bother counting in HOW_MUCH.
4504 (INSERTED is where we count the number of characters inserted.) */
4505 if (! not_regular)
4506 how_much += this;
4507 inserted += this;
4511 /* Now we have read all the file data into the gap.
4512 If it was empty, undo marking the buffer modified. */
4514 if (inserted == 0)
4516 #ifdef CLASH_DETECTION
4517 if (we_locked_file)
4518 unlock_file (current_buffer->file_truename);
4519 #endif
4520 Vdeactivate_mark = old_Vdeactivate_mark;
4522 else
4523 Vdeactivate_mark = Qt;
4525 /* Make the text read part of the buffer. */
4526 GAP_SIZE -= inserted;
4527 GPT += inserted;
4528 GPT_BYTE += inserted;
4529 ZV += inserted;
4530 ZV_BYTE += inserted;
4531 Z += inserted;
4532 Z_BYTE += inserted;
4534 if (GAP_SIZE > 0)
4535 /* Put an anchor to ensure multi-byte form ends at gap. */
4536 *GPT_ADDR = 0;
4538 emacs_close (fd);
4540 /* Discard the unwind protect for closing the file. */
4541 specpdl_ptr--;
4543 if (how_much < 0)
4544 error ("IO error reading %s: %s",
4545 SDATA (orig_filename), emacs_strerror (errno));
4547 notfound:
4549 if (! coding_system_decided)
4551 /* The coding system is not yet decided. Decide it by an
4552 optimized method for handling `coding:' tag.
4554 Note that we can get here only if the buffer was empty
4555 before the insertion. */
4556 Lisp_Object val;
4557 val = Qnil;
4559 if (!NILP (Vcoding_system_for_read))
4560 val = Vcoding_system_for_read;
4561 else
4563 /* Since we are sure that the current buffer was empty
4564 before the insertion, we can toggle
4565 enable-multibyte-characters directly here without taking
4566 care of marker adjustment and byte combining problem. By
4567 this way, we can run Lisp program safely before decoding
4568 the inserted text. */
4569 Lisp_Object unwind_data;
4570 int count = SPECPDL_INDEX ();
4572 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4573 Fcons (current_buffer->undo_list,
4574 Fcurrent_buffer ()));
4575 current_buffer->enable_multibyte_characters = Qnil;
4576 current_buffer->undo_list = Qt;
4577 record_unwind_protect (decide_coding_unwind, unwind_data);
4579 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4581 val = call2 (Vset_auto_coding_function,
4582 filename, make_number (inserted));
4585 if (NILP (val))
4587 /* If the coding system is not yet decided, check
4588 file-coding-system-alist. */
4589 Lisp_Object args[6], coding_systems;
4591 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4592 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4593 coding_systems = Ffind_operation_coding_system (6, args);
4594 if (CONSP (coding_systems))
4595 val = XCAR (coding_systems);
4597 unbind_to (count, Qnil);
4598 inserted = Z_BYTE - BEG_BYTE;
4601 /* The following kludgy code is to avoid some compiler bug.
4602 We can't simply do
4603 setup_coding_system (val, &coding);
4604 on some system. */
4606 struct coding_system temp_coding;
4607 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4608 bcopy (&temp_coding, &coding, sizeof coding);
4610 /* Ensure we set Vlast_coding_system_used. */
4611 set_coding_system = 1;
4613 if (NILP (current_buffer->enable_multibyte_characters)
4614 && ! NILP (val))
4615 /* We must suppress all character code conversion except for
4616 end-of-line conversion. */
4617 setup_raw_text_coding_system (&coding);
4618 coding.src_multibyte = 0;
4619 coding.dst_multibyte
4620 = !NILP (current_buffer->enable_multibyte_characters);
4623 if (!NILP (visit)
4624 /* Can't do this if part of the buffer might be preserved. */
4625 && NILP (replace)
4626 && (coding.type == coding_type_no_conversion
4627 || coding.type == coding_type_raw_text))
4629 /* Visiting a file with these coding system makes the buffer
4630 unibyte. */
4631 current_buffer->enable_multibyte_characters = Qnil;
4632 coding.dst_multibyte = 0;
4635 if (inserted > 0 || coding.type == coding_type_ccl)
4637 if (CODING_MAY_REQUIRE_DECODING (&coding))
4639 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4640 &coding, 0, 0);
4641 inserted = coding.produced_char;
4643 else
4644 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4645 inserted);
4648 /* Now INSERTED is measured in characters. */
4650 #ifdef DOS_NT
4651 /* Use the conversion type to determine buffer-file-type
4652 (find-buffer-file-type is now used to help determine the
4653 conversion). */
4654 if ((coding.eol_type == CODING_EOL_UNDECIDED
4655 || coding.eol_type == CODING_EOL_LF)
4656 && ! CODING_REQUIRE_DECODING (&coding))
4657 current_buffer->buffer_file_type = Qt;
4658 else
4659 current_buffer->buffer_file_type = Qnil;
4660 #endif
4662 handled:
4664 if (!NILP (visit))
4666 if (!EQ (current_buffer->undo_list, Qt))
4667 current_buffer->undo_list = Qnil;
4668 #ifdef APOLLO
4669 stat (SDATA (filename), &st);
4670 #endif
4672 if (NILP (handler))
4674 current_buffer->modtime = st.st_mtime;
4675 current_buffer->filename = orig_filename;
4678 SAVE_MODIFF = MODIFF;
4679 current_buffer->auto_save_modified = MODIFF;
4680 XSETFASTINT (current_buffer->save_length, Z - BEG);
4681 #ifdef CLASH_DETECTION
4682 if (NILP (handler))
4684 if (!NILP (current_buffer->file_truename))
4685 unlock_file (current_buffer->file_truename);
4686 unlock_file (filename);
4688 #endif /* CLASH_DETECTION */
4689 if (not_regular)
4690 xsignal2 (Qfile_error,
4691 build_string ("not a regular file"), orig_filename);
4694 if (set_coding_system)
4695 Vlast_coding_system_used = coding.symbol;
4697 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4699 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4700 visit);
4701 if (! NILP (insval))
4703 CHECK_NUMBER (insval);
4704 inserted = XFASTINT (insval);
4708 /* Decode file format */
4709 if (inserted > 0)
4711 /* Don't run point motion or modification hooks when decoding. */
4712 int count = SPECPDL_INDEX ();
4713 specbind (Qinhibit_point_motion_hooks, Qt);
4714 specbind (Qinhibit_modification_hooks, Qt);
4716 /* Save old undo list and don't record undo for decoding. */
4717 old_undo = current_buffer->undo_list;
4718 current_buffer->undo_list = Qt;
4720 if (NILP (replace))
4722 insval = call3 (Qformat_decode,
4723 Qnil, make_number (inserted), visit);
4724 CHECK_NUMBER (insval);
4725 inserted = XFASTINT (insval);
4727 else
4729 /* If REPLACE is non-nil and we succeeded in not replacing the
4730 beginning or end of the buffer text with the file's contents,
4731 call format-decode with `point' positioned at the beginning of
4732 the buffer and `inserted' equalling the number of characters
4733 in the buffer. Otherwise, format-decode might fail to
4734 correctly analyze the beginning or end of the buffer. Hence
4735 we temporarily save `point' and `inserted' here and restore
4736 `point' iff format-decode did not insert or delete any text.
4737 Otherwise we leave `point' at point-min. */
4738 int opoint = PT;
4739 int opoint_byte = PT_BYTE;
4740 int oinserted = ZV - BEGV;
4741 int ochars_modiff = CHARS_MODIFF;
4743 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4744 insval = call3 (Qformat_decode,
4745 Qnil, make_number (oinserted), visit);
4746 CHECK_NUMBER (insval);
4747 if (ochars_modiff == CHARS_MODIFF)
4748 /* format_decode didn't modify buffer's characters => move
4749 point back to position before inserted text and leave
4750 value of inserted alone. */
4751 SET_PT_BOTH (opoint, opoint_byte);
4752 else
4753 /* format_decode modified buffer's characters => consider
4754 entire buffer changed and leave point at point-min. */
4755 inserted = XFASTINT (insval);
4758 /* For consistency with format-decode call these now iff inserted > 0
4759 (martin 2007-06-28) */
4760 p = Vafter_insert_file_functions;
4761 while (CONSP (p))
4763 if (NILP (replace))
4765 insval = call1 (XCAR (p), make_number (inserted));
4766 if (!NILP (insval))
4768 CHECK_NUMBER (insval);
4769 inserted = XFASTINT (insval);
4772 else
4774 /* For the rationale of this see the comment on format-decode above. */
4775 int opoint = PT;
4776 int opoint_byte = PT_BYTE;
4777 int oinserted = ZV - BEGV;
4778 int ochars_modiff = CHARS_MODIFF;
4780 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4781 insval = call1 (XCAR (p), make_number (oinserted));
4782 if (!NILP (insval))
4784 CHECK_NUMBER (insval);
4785 if (ochars_modiff == CHARS_MODIFF)
4786 /* after_insert_file_functions didn't modify
4787 buffer's characters => move point back to
4788 position before inserted text and leave value of
4789 inserted alone. */
4790 SET_PT_BOTH (opoint, opoint_byte);
4791 else
4792 /* after_insert_file_functions did modify buffer's
4793 characters => consider entire buffer changed and
4794 leave point at point-min. */
4795 inserted = XFASTINT (insval);
4799 QUIT;
4800 p = XCDR (p);
4803 if (NILP (visit))
4805 Lisp_Object lbeg, lend;
4806 XSETINT (lbeg, PT);
4807 XSETINT (lend, PT + inserted);
4808 if (CONSP (old_undo))
4810 Lisp_Object tem = XCAR (old_undo);
4811 if (CONSP (tem) && INTEGERP (XCAR (tem)) &&
4812 INTEGERP (XCDR (tem)) && EQ (XCAR (tem), lbeg))
4813 /* In the non-visiting case record only the final insertion. */
4814 current_buffer->undo_list =
4815 Fcons (Fcons (lbeg, lend), Fcdr (old_undo));
4818 else
4819 /* If undo_list was Qt before, keep it that way.
4820 Otherwise start with an empty undo_list. */
4821 current_buffer->undo_list = EQ (old_undo, Qt) ? Qt : Qnil;
4823 unbind_to (count, Qnil);
4826 /* Call after-change hooks for the inserted text, aside from the case
4827 of normal visiting (not with REPLACE), which is done in a new buffer
4828 "before" the buffer is changed. */
4829 if (inserted > 0 && total > 0
4830 && (NILP (visit) || !NILP (replace)))
4832 signal_after_change (PT, 0, inserted);
4833 update_compositions (PT, PT, CHECK_BORDER);
4836 if (!NILP (visit)
4837 && current_buffer->modtime == -1)
4839 /* If visiting nonexistent file, return nil. */
4840 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4843 if (read_quit)
4844 Fsignal (Qquit, Qnil);
4846 /* ??? Retval needs to be dealt with in all cases consistently. */
4847 if (NILP (val))
4848 val = Fcons (orig_filename,
4849 Fcons (make_number (inserted),
4850 Qnil));
4852 RETURN_UNGCPRO (unbind_to (count, val));
4855 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4856 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4857 Lisp_Object, Lisp_Object));
4859 /* If build_annotations switched buffers, switch back to BUF.
4860 Kill the temporary buffer that was selected in the meantime.
4862 Since this kill only the last temporary buffer, some buffers remain
4863 not killed if build_annotations switched buffers more than once.
4864 -- K.Handa */
4866 static Lisp_Object
4867 build_annotations_unwind (buf)
4868 Lisp_Object buf;
4870 Lisp_Object tembuf;
4872 if (XBUFFER (buf) == current_buffer)
4873 return Qnil;
4874 tembuf = Fcurrent_buffer ();
4875 Fset_buffer (buf);
4876 Fkill_buffer (tembuf);
4877 return Qnil;
4880 /* Decide the coding-system to encode the data with. */
4882 void
4883 choose_write_coding_system (start, end, filename,
4884 append, visit, lockname, coding)
4885 Lisp_Object start, end, filename, append, visit, lockname;
4886 struct coding_system *coding;
4888 Lisp_Object val;
4890 if (auto_saving
4891 && NILP (Fstring_equal (current_buffer->filename,
4892 current_buffer->auto_save_file_name)))
4894 /* We use emacs-mule for auto saving... */
4895 setup_coding_system (Qemacs_mule, coding);
4896 /* ... but with the special flag to indicate not to strip off
4897 leading code of eight-bit-control chars. */
4898 coding->flags = 1;
4899 /* We force LF for end-of-line because that is faster. */
4900 coding->eol_type = CODING_EOL_LF;
4901 goto done_setup_coding;
4903 else if (!NILP (Vcoding_system_for_write))
4905 val = Vcoding_system_for_write;
4906 if (coding_system_require_warning
4907 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4908 /* Confirm that VAL can surely encode the current region. */
4909 val = call5 (Vselect_safe_coding_system_function,
4910 start, end, Fcons (Qt, Fcons (val, Qnil)),
4911 Qnil, filename);
4913 else
4915 /* If the variable `buffer-file-coding-system' is set locally,
4916 it means that the file was read with some kind of code
4917 conversion or the variable is explicitly set by users. We
4918 had better write it out with the same coding system even if
4919 `enable-multibyte-characters' is nil.
4921 If it is not set locally, we anyway have to convert EOL
4922 format if the default value of `buffer-file-coding-system'
4923 tells that it is not Unix-like (LF only) format. */
4924 int using_default_coding = 0;
4925 int force_raw_text = 0;
4927 val = current_buffer->buffer_file_coding_system;
4928 if (NILP (val)
4929 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4931 val = Qnil;
4932 if (NILP (current_buffer->enable_multibyte_characters))
4933 force_raw_text = 1;
4936 if (NILP (val))
4938 /* Check file-coding-system-alist. */
4939 Lisp_Object args[7], coding_systems;
4941 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4942 args[3] = filename; args[4] = append; args[5] = visit;
4943 args[6] = lockname;
4944 coding_systems = Ffind_operation_coding_system (7, args);
4945 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4946 val = XCDR (coding_systems);
4949 if (NILP (val)
4950 && !NILP (current_buffer->buffer_file_coding_system))
4952 /* If we still have not decided a coding system, use the
4953 default value of buffer-file-coding-system. */
4954 val = current_buffer->buffer_file_coding_system;
4955 using_default_coding = 1;
4958 if (!force_raw_text
4959 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4960 /* Confirm that VAL can surely encode the current region. */
4961 val = call5 (Vselect_safe_coding_system_function,
4962 start, end, val, Qnil, filename);
4964 setup_coding_system (Fcheck_coding_system (val), coding);
4965 if (coding->eol_type == CODING_EOL_UNDECIDED
4966 && !using_default_coding)
4968 if (! EQ (default_buffer_file_coding.symbol,
4969 buffer_defaults.buffer_file_coding_system))
4970 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4971 &default_buffer_file_coding);
4972 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4974 Lisp_Object subsidiaries;
4976 coding->eol_type = default_buffer_file_coding.eol_type;
4977 subsidiaries = Fget (coding->symbol, Qeol_type);
4978 if (VECTORP (subsidiaries)
4979 && XVECTOR (subsidiaries)->size == 3)
4980 coding->symbol
4981 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4985 if (force_raw_text)
4986 setup_raw_text_coding_system (coding);
4987 goto done_setup_coding;
4990 setup_coding_system (Fcheck_coding_system (val), coding);
4992 done_setup_coding:
4993 if (coding->eol_type == CODING_EOL_UNDECIDED)
4994 coding->eol_type = system_eol_type;
4995 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4996 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4999 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
5000 "r\nFWrite region to file: \ni\ni\ni\np",
5001 doc: /* Write current region into specified file.
5002 When called from a program, requires three arguments:
5003 START, END and FILENAME. START and END are normally buffer positions
5004 specifying the part of the buffer to write.
5005 If START is nil, that means to use the entire buffer contents.
5006 If START is a string, then output that string to the file
5007 instead of any buffer contents; END is ignored.
5009 Optional fourth argument APPEND if non-nil means
5010 append to existing file contents (if any). If it is an integer,
5011 seek to that offset in the file before writing.
5012 Optional fifth argument VISIT, if t or a string, means
5013 set the last-save-file-modtime of buffer to this file's modtime
5014 and mark buffer not modified.
5015 If VISIT is a string, it is a second file name;
5016 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
5017 VISIT is also the file name to lock and unlock for clash detection.
5018 If VISIT is neither t nor nil nor a string,
5019 that means do not display the \"Wrote file\" message.
5020 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
5021 use for locking and unlocking, overriding FILENAME and VISIT.
5022 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
5023 for an existing file with the same name. If MUSTBENEW is `excl',
5024 that means to get an error if the file already exists; never overwrite.
5025 If MUSTBENEW is neither nil nor `excl', that means ask for
5026 confirmation before overwriting, but do go ahead and overwrite the file
5027 if the user confirms.
5029 This does code conversion according to the value of
5030 `coding-system-for-write', `buffer-file-coding-system', or
5031 `file-coding-system-alist', and sets the variable
5032 `last-coding-system-used' to the coding system actually used. */)
5033 (start, end, filename, append, visit, lockname, mustbenew)
5034 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
5036 register int desc;
5037 int failure;
5038 int save_errno = 0;
5039 const unsigned char *fn;
5040 struct stat st;
5041 int tem;
5042 int count = SPECPDL_INDEX ();
5043 int count1;
5044 #ifdef VMS
5045 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
5046 #endif /* VMS */
5047 Lisp_Object handler;
5048 Lisp_Object visit_file;
5049 Lisp_Object annotations;
5050 Lisp_Object encoded_filename;
5051 int visiting = (EQ (visit, Qt) || STRINGP (visit));
5052 int quietly = !NILP (visit);
5053 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5054 struct buffer *given_buffer;
5055 #ifdef DOS_NT
5056 int buffer_file_type = O_BINARY;
5057 #endif /* DOS_NT */
5058 struct coding_system coding;
5060 if (current_buffer->base_buffer && visiting)
5061 error ("Cannot do file visiting in an indirect buffer");
5063 if (!NILP (start) && !STRINGP (start))
5064 validate_region (&start, &end);
5066 visit_file = Qnil;
5067 GCPRO5 (start, filename, visit, visit_file, lockname);
5069 filename = Fexpand_file_name (filename, Qnil);
5071 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5072 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5074 if (STRINGP (visit))
5075 visit_file = Fexpand_file_name (visit, Qnil);
5076 else
5077 visit_file = filename;
5079 if (NILP (lockname))
5080 lockname = visit_file;
5082 annotations = Qnil;
5084 /* If the file name has special constructs in it,
5085 call the corresponding file handler. */
5086 handler = Ffind_file_name_handler (filename, Qwrite_region);
5087 /* If FILENAME has no handler, see if VISIT has one. */
5088 if (NILP (handler) && STRINGP (visit))
5089 handler = Ffind_file_name_handler (visit, Qwrite_region);
5091 if (!NILP (handler))
5093 Lisp_Object val;
5094 val = call6 (handler, Qwrite_region, start, end,
5095 filename, append, visit);
5097 if (visiting)
5099 SAVE_MODIFF = MODIFF;
5100 XSETFASTINT (current_buffer->save_length, Z - BEG);
5101 current_buffer->filename = visit_file;
5103 UNGCPRO;
5104 return val;
5107 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5109 /* Special kludge to simplify auto-saving. */
5110 if (NILP (start))
5112 XSETFASTINT (start, BEG);
5113 XSETFASTINT (end, Z);
5114 Fwiden ();
5117 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5118 count1 = SPECPDL_INDEX ();
5120 given_buffer = current_buffer;
5122 if (!STRINGP (start))
5124 annotations = build_annotations (start, end);
5126 if (current_buffer != given_buffer)
5128 XSETFASTINT (start, BEGV);
5129 XSETFASTINT (end, ZV);
5133 UNGCPRO;
5135 GCPRO5 (start, filename, annotations, visit_file, lockname);
5137 /* Decide the coding-system to encode the data with.
5138 We used to make this choice before calling build_annotations, but that
5139 leads to problems when a write-annotate-function takes care of
5140 unsavable chars (as was the case with X-Symbol). */
5141 choose_write_coding_system (start, end, filename,
5142 append, visit, lockname, &coding);
5143 Vlast_coding_system_used = coding.symbol;
5145 given_buffer = current_buffer;
5146 if (! STRINGP (start))
5148 annotations = build_annotations_2 (start, end,
5149 coding.pre_write_conversion, annotations);
5150 if (current_buffer != given_buffer)
5152 XSETFASTINT (start, BEGV);
5153 XSETFASTINT (end, ZV);
5157 #ifdef CLASH_DETECTION
5158 if (!auto_saving)
5160 #if 0 /* This causes trouble for GNUS. */
5161 /* If we've locked this file for some other buffer,
5162 query before proceeding. */
5163 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5164 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5165 #endif
5167 lock_file (lockname);
5169 #endif /* CLASH_DETECTION */
5171 encoded_filename = ENCODE_FILE (filename);
5173 fn = SDATA (encoded_filename);
5174 desc = -1;
5175 if (!NILP (append))
5176 #ifdef DOS_NT
5177 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5178 #else /* not DOS_NT */
5179 desc = emacs_open (fn, O_WRONLY, 0);
5180 #endif /* not DOS_NT */
5182 if (desc < 0 && (NILP (append) || errno == ENOENT))
5183 #ifdef VMS
5184 if (auto_saving) /* Overwrite any previous version of autosave file */
5186 vms_truncate (fn); /* if fn exists, truncate to zero length */
5187 desc = emacs_open (fn, O_RDWR, 0);
5188 if (desc < 0)
5189 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5190 ? SDATA (current_buffer->filename) : 0,
5191 fn);
5193 else /* Write to temporary name and rename if no errors */
5195 Lisp_Object temp_name;
5196 temp_name = Ffile_name_directory (filename);
5198 if (!NILP (temp_name))
5200 temp_name = Fmake_temp_name (concat2 (temp_name,
5201 build_string ("$$SAVE$$")));
5202 fname = SDATA (filename);
5203 fn = SDATA (temp_name);
5204 desc = creat_copy_attrs (fname, fn);
5205 if (desc < 0)
5207 /* If we can't open the temporary file, try creating a new
5208 version of the original file. VMS "creat" creates a
5209 new version rather than truncating an existing file. */
5210 fn = fname;
5211 fname = 0;
5212 desc = creat (fn, 0666);
5213 #if 0 /* This can clobber an existing file and fail to replace it,
5214 if the user runs out of space. */
5215 if (desc < 0)
5217 /* We can't make a new version;
5218 try to truncate and rewrite existing version if any. */
5219 vms_truncate (fn);
5220 desc = emacs_open (fn, O_RDWR, 0);
5222 #endif
5225 else
5226 desc = creat (fn, 0666);
5228 #else /* not VMS */
5229 #ifdef DOS_NT
5230 desc = emacs_open (fn,
5231 O_WRONLY | O_CREAT | buffer_file_type
5232 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5233 S_IREAD | S_IWRITE);
5234 #else /* not DOS_NT */
5235 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5236 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5237 auto_saving ? auto_save_mode_bits : 0666);
5238 #endif /* not DOS_NT */
5239 #endif /* not VMS */
5241 if (desc < 0)
5243 #ifdef CLASH_DETECTION
5244 save_errno = errno;
5245 if (!auto_saving) unlock_file (lockname);
5246 errno = save_errno;
5247 #endif /* CLASH_DETECTION */
5248 UNGCPRO;
5249 report_file_error ("Opening output file", Fcons (filename, Qnil));
5252 record_unwind_protect (close_file_unwind, make_number (desc));
5254 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5256 long ret;
5258 if (NUMBERP (append))
5259 ret = lseek (desc, XINT (append), 1);
5260 else
5261 ret = lseek (desc, 0, 2);
5262 if (ret < 0)
5264 #ifdef CLASH_DETECTION
5265 if (!auto_saving) unlock_file (lockname);
5266 #endif /* CLASH_DETECTION */
5267 UNGCPRO;
5268 report_file_error ("Lseek error", Fcons (filename, Qnil));
5272 UNGCPRO;
5274 #ifdef VMS
5276 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5277 * if we do writes that don't end with a carriage return. Furthermore
5278 * it cannot handle writes of more then 16K. The modified
5279 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5280 * this EXCEPT for the last record (if it doesn't end with a carriage
5281 * return). This implies that if your buffer doesn't end with a carriage
5282 * return, you get one free... tough. However it also means that if
5283 * we make two calls to sys_write (a la the following code) you can
5284 * get one at the gap as well. The easiest way to fix this (honest)
5285 * is to move the gap to the next newline (or the end of the buffer).
5286 * Thus this change.
5288 * Yech!
5290 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5291 move_gap (find_next_newline (GPT, 1));
5292 #else
5293 /* Whether VMS or not, we must move the gap to the next of newline
5294 when we must put designation sequences at beginning of line. */
5295 if (INTEGERP (start)
5296 && coding.type == coding_type_iso2022
5297 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5298 && GPT > BEG && GPT_ADDR[-1] != '\n')
5300 int opoint = PT, opoint_byte = PT_BYTE;
5301 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5302 move_gap_both (PT, PT_BYTE);
5303 SET_PT_BOTH (opoint, opoint_byte);
5305 #endif
5307 failure = 0;
5308 immediate_quit = 1;
5310 if (STRINGP (start))
5312 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5313 &annotations, &coding);
5314 save_errno = errno;
5316 else if (XINT (start) != XINT (end))
5318 tem = CHAR_TO_BYTE (XINT (start));
5320 if (XINT (start) < GPT)
5322 failure = 0 > a_write (desc, Qnil, XINT (start),
5323 min (GPT, XINT (end)) - XINT (start),
5324 &annotations, &coding);
5325 save_errno = errno;
5328 if (XINT (end) > GPT && !failure)
5330 tem = max (XINT (start), GPT);
5331 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5332 &annotations, &coding);
5333 save_errno = errno;
5336 else
5338 /* If file was empty, still need to write the annotations */
5339 coding.mode |= CODING_MODE_LAST_BLOCK;
5340 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5341 save_errno = errno;
5344 if (CODING_REQUIRE_FLUSHING (&coding)
5345 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5346 && ! failure)
5348 /* We have to flush out a data. */
5349 coding.mode |= CODING_MODE_LAST_BLOCK;
5350 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5351 save_errno = errno;
5354 immediate_quit = 0;
5356 #ifdef HAVE_FSYNC
5357 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5358 Disk full in NFS may be reported here. */
5359 /* mib says that closing the file will try to write as fast as NFS can do
5360 it, and that means the fsync here is not crucial for autosave files. */
5361 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5363 /* If fsync fails with EINTR, don't treat that as serious. Also
5364 ignore EINVAL which happens when fsync is not supported on this
5365 file. */
5366 if (errno != EINTR && errno != EINVAL)
5367 failure = 1, save_errno = errno;
5369 #endif
5371 /* Spurious "file has changed on disk" warnings have been
5372 observed on Suns as well.
5373 It seems that `close' can change the modtime, under nfs.
5375 (This has supposedly been fixed in Sunos 4,
5376 but who knows about all the other machines with NFS?) */
5377 #if 0
5379 /* On VMS and APOLLO, must do the stat after the close
5380 since closing changes the modtime. */
5381 #ifndef VMS
5382 #ifndef APOLLO
5383 /* Recall that #if defined does not work on VMS. */
5384 #define FOO
5385 fstat (desc, &st);
5386 #endif
5387 #endif
5388 #endif
5390 /* NFS can report a write failure now. */
5391 if (emacs_close (desc) < 0)
5392 failure = 1, save_errno = errno;
5394 #ifdef VMS
5395 /* If we wrote to a temporary name and had no errors, rename to real name. */
5396 if (fname)
5398 if (!failure)
5399 failure = (rename (fn, fname) != 0), save_errno = errno;
5400 fn = fname;
5402 #endif /* VMS */
5404 #ifndef FOO
5405 stat (fn, &st);
5406 #endif
5407 /* Discard the unwind protect for close_file_unwind. */
5408 specpdl_ptr = specpdl + count1;
5409 /* Restore the original current buffer. */
5410 visit_file = unbind_to (count, visit_file);
5412 #ifdef CLASH_DETECTION
5413 if (!auto_saving)
5414 unlock_file (lockname);
5415 #endif /* CLASH_DETECTION */
5417 /* Do this before reporting IO error
5418 to avoid a "file has changed on disk" warning on
5419 next attempt to save. */
5420 if (visiting)
5421 current_buffer->modtime = st.st_mtime;
5423 if (failure)
5424 error ("IO error writing %s: %s", SDATA (filename),
5425 emacs_strerror (save_errno));
5427 if (visiting)
5429 SAVE_MODIFF = MODIFF;
5430 XSETFASTINT (current_buffer->save_length, Z - BEG);
5431 current_buffer->filename = visit_file;
5432 update_mode_lines++;
5434 else if (quietly)
5436 if (auto_saving
5437 && ! NILP (Fstring_equal (current_buffer->filename,
5438 current_buffer->auto_save_file_name)))
5439 SAVE_MODIFF = MODIFF;
5441 return Qnil;
5444 if (!auto_saving)
5445 message_with_string ((INTEGERP (append)
5446 ? "Updated %s"
5447 : ! NILP (append)
5448 ? "Added to %s"
5449 : "Wrote %s"),
5450 visit_file, 1);
5452 return Qnil;
5455 Lisp_Object merge ();
5457 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5458 doc: /* Return t if (car A) is numerically less than (car B). */)
5459 (a, b)
5460 Lisp_Object a, b;
5462 return Flss (Fcar (a), Fcar (b));
5465 /* Build the complete list of annotations appropriate for writing out
5466 the text between START and END, by calling all the functions in
5467 write-region-annotate-functions and merging the lists they return.
5468 If one of these functions switches to a different buffer, we assume
5469 that buffer contains altered text. Therefore, the caller must
5470 make sure to restore the current buffer in all cases,
5471 as save-excursion would do. */
5473 static Lisp_Object
5474 build_annotations (start, end)
5475 Lisp_Object start, end;
5477 Lisp_Object annotations;
5478 Lisp_Object p, res;
5479 struct gcpro gcpro1, gcpro2;
5480 Lisp_Object original_buffer;
5481 int i, used_global = 0;
5483 XSETBUFFER (original_buffer, current_buffer);
5485 annotations = Qnil;
5486 p = Vwrite_region_annotate_functions;
5487 GCPRO2 (annotations, p);
5488 while (CONSP (p))
5490 struct buffer *given_buffer = current_buffer;
5491 if (EQ (Qt, XCAR (p)) && !used_global)
5492 { /* Use the global value of the hook. */
5493 Lisp_Object arg[2];
5494 used_global = 1;
5495 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5496 arg[1] = XCDR (p);
5497 p = Fappend (2, arg);
5498 continue;
5500 Vwrite_region_annotations_so_far = annotations;
5501 res = call2 (XCAR (p), start, end);
5502 /* If the function makes a different buffer current,
5503 assume that means this buffer contains altered text to be output.
5504 Reset START and END from the buffer bounds
5505 and discard all previous annotations because they should have
5506 been dealt with by this function. */
5507 if (current_buffer != given_buffer)
5509 XSETFASTINT (start, BEGV);
5510 XSETFASTINT (end, ZV);
5511 annotations = Qnil;
5513 Flength (res); /* Check basic validity of return value */
5514 annotations = merge (annotations, res, Qcar_less_than_car);
5515 p = XCDR (p);
5518 /* Now do the same for annotation functions implied by the file-format */
5519 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5520 p = current_buffer->auto_save_file_format;
5521 else
5522 p = current_buffer->file_format;
5523 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5525 struct buffer *given_buffer = current_buffer;
5527 Vwrite_region_annotations_so_far = annotations;
5529 /* Value is either a list of annotations or nil if the function
5530 has written annotations to a temporary buffer, which is now
5531 current. */
5532 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5533 original_buffer, make_number (i));
5534 if (current_buffer != given_buffer)
5536 XSETFASTINT (start, BEGV);
5537 XSETFASTINT (end, ZV);
5538 annotations = Qnil;
5541 if (CONSP (res))
5542 annotations = merge (annotations, res, Qcar_less_than_car);
5545 UNGCPRO;
5546 return annotations;
5549 static Lisp_Object
5550 build_annotations_2 (start, end, pre_write_conversion, annotations)
5551 Lisp_Object start, end, pre_write_conversion, annotations;
5553 struct gcpro gcpro1;
5554 Lisp_Object res;
5556 GCPRO1 (annotations);
5557 /* At last, do the same for the function PRE_WRITE_CONVERSION
5558 implied by the current coding-system. */
5559 if (!NILP (pre_write_conversion))
5561 struct buffer *given_buffer = current_buffer;
5562 Vwrite_region_annotations_so_far = annotations;
5563 res = call2 (pre_write_conversion, start, end);
5564 Flength (res);
5565 annotations = (current_buffer != given_buffer
5566 ? res
5567 : merge (annotations, res, Qcar_less_than_car));
5570 UNGCPRO;
5571 return annotations;
5574 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5575 If STRING is nil, POS is the character position in the current buffer.
5576 Intersperse with them the annotations from *ANNOT
5577 which fall within the range of POS to POS + NCHARS,
5578 each at its appropriate position.
5580 We modify *ANNOT by discarding elements as we use them up.
5582 The return value is negative in case of system call failure. */
5584 static int
5585 a_write (desc, string, pos, nchars, annot, coding)
5586 int desc;
5587 Lisp_Object string;
5588 register int nchars;
5589 int pos;
5590 Lisp_Object *annot;
5591 struct coding_system *coding;
5593 Lisp_Object tem;
5594 int nextpos;
5595 int lastpos = pos + nchars;
5597 while (NILP (*annot) || CONSP (*annot))
5599 tem = Fcar_safe (Fcar (*annot));
5600 nextpos = pos - 1;
5601 if (INTEGERP (tem))
5602 nextpos = XFASTINT (tem);
5604 /* If there are no more annotations in this range,
5605 output the rest of the range all at once. */
5606 if (! (nextpos >= pos && nextpos <= lastpos))
5607 return e_write (desc, string, pos, lastpos, coding);
5609 /* Output buffer text up to the next annotation's position. */
5610 if (nextpos > pos)
5612 if (0 > e_write (desc, string, pos, nextpos, coding))
5613 return -1;
5614 pos = nextpos;
5616 /* Output the annotation. */
5617 tem = Fcdr (Fcar (*annot));
5618 if (STRINGP (tem))
5620 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5621 return -1;
5623 *annot = Fcdr (*annot);
5625 return 0;
5628 #ifndef WRITE_BUF_SIZE
5629 #define WRITE_BUF_SIZE (16 * 1024)
5630 #endif
5632 /* Write text in the range START and END into descriptor DESC,
5633 encoding them with coding system CODING. If STRING is nil, START
5634 and END are character positions of the current buffer, else they
5635 are indexes to the string STRING. */
5637 static int
5638 e_write (desc, string, start, end, coding)
5639 int desc;
5640 Lisp_Object string;
5641 int start, end;
5642 struct coding_system *coding;
5644 register char *addr;
5645 register int nbytes;
5646 char buf[WRITE_BUF_SIZE];
5647 int return_val = 0;
5649 if (start >= end)
5650 coding->composing = COMPOSITION_DISABLED;
5651 if (coding->composing != COMPOSITION_DISABLED)
5652 coding_save_composition (coding, start, end, string);
5654 if (STRINGP (string))
5656 addr = SDATA (string);
5657 nbytes = SBYTES (string);
5658 coding->src_multibyte = STRING_MULTIBYTE (string);
5660 else if (start < end)
5662 /* It is assured that the gap is not in the range START and END-1. */
5663 addr = CHAR_POS_ADDR (start);
5664 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5665 coding->src_multibyte
5666 = !NILP (current_buffer->enable_multibyte_characters);
5668 else
5670 addr = "";
5671 nbytes = 0;
5672 coding->src_multibyte = 1;
5675 /* We used to have a code for handling selective display here. But,
5676 now it is handled within encode_coding. */
5677 while (1)
5679 int result;
5681 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5682 if (coding->produced > 0)
5684 coding->produced -= emacs_write (desc, buf, coding->produced);
5685 if (coding->produced)
5687 return_val = -1;
5688 break;
5691 nbytes -= coding->consumed;
5692 addr += coding->consumed;
5693 if (result == CODING_FINISH_INSUFFICIENT_SRC
5694 && nbytes > 0)
5696 /* The source text ends by an incomplete multibyte form.
5697 There's no way other than write it out as is. */
5698 nbytes -= emacs_write (desc, addr, nbytes);
5699 if (nbytes)
5701 return_val = -1;
5702 break;
5705 if (nbytes <= 0)
5706 break;
5707 start += coding->consumed_char;
5708 if (coding->cmp_data)
5709 coding_adjust_composition_offset (coding, start);
5712 if (coding->cmp_data)
5713 coding_free_composition_data (coding);
5715 return return_val;
5718 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5719 Sverify_visited_file_modtime, 1, 1, 0,
5720 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5721 This means that the file has not been changed since it was visited or saved.
5722 See Info node `(elisp)Modification Time' for more details. */)
5723 (buf)
5724 Lisp_Object buf;
5726 struct buffer *b;
5727 struct stat st;
5728 Lisp_Object handler;
5729 Lisp_Object filename;
5731 CHECK_BUFFER (buf);
5732 b = XBUFFER (buf);
5734 if (!STRINGP (b->filename)) return Qt;
5735 if (b->modtime == 0) return Qt;
5737 /* If the file name has special constructs in it,
5738 call the corresponding file handler. */
5739 handler = Ffind_file_name_handler (b->filename,
5740 Qverify_visited_file_modtime);
5741 if (!NILP (handler))
5742 return call2 (handler, Qverify_visited_file_modtime, buf);
5744 filename = ENCODE_FILE (b->filename);
5746 if (stat (SDATA (filename), &st) < 0)
5748 /* If the file doesn't exist now and didn't exist before,
5749 we say that it isn't modified, provided the error is a tame one. */
5750 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5751 st.st_mtime = -1;
5752 else
5753 st.st_mtime = 0;
5755 if (st.st_mtime == b->modtime
5756 /* If both are positive, accept them if they are off by one second. */
5757 || (st.st_mtime > 0 && b->modtime > 0
5758 && (st.st_mtime == b->modtime + 1
5759 || st.st_mtime == b->modtime - 1)))
5760 return Qt;
5761 return Qnil;
5764 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5765 Sclear_visited_file_modtime, 0, 0, 0,
5766 doc: /* Clear out records of last mod time of visited file.
5767 Next attempt to save will certainly not complain of a discrepancy. */)
5770 current_buffer->modtime = 0;
5771 return Qnil;
5774 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5775 Svisited_file_modtime, 0, 0, 0,
5776 doc: /* Return the current buffer's recorded visited file modification time.
5777 The value is a list of the form (HIGH LOW), like the time values
5778 that `file-attributes' returns. If the current buffer has no recorded
5779 file modification time, this function returns 0.
5780 See Info node `(elisp)Modification Time' for more details. */)
5783 if (! current_buffer->modtime)
5784 return make_number (0);
5785 return make_time ((time_t) current_buffer->modtime);
5788 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5789 Sset_visited_file_modtime, 0, 1, 0,
5790 doc: /* Update buffer's recorded modification time from the visited file's time.
5791 Useful if the buffer was not read from the file normally
5792 or if the file itself has been changed for some known benign reason.
5793 An argument specifies the modification time value to use
5794 \(instead of that of the visited file), in the form of a list
5795 \(HIGH . LOW) or (HIGH LOW). */)
5796 (time_list)
5797 Lisp_Object time_list;
5799 if (!NILP (time_list))
5800 current_buffer->modtime = cons_to_long (time_list);
5801 else
5803 register Lisp_Object filename;
5804 struct stat st;
5805 Lisp_Object handler;
5807 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5809 /* If the file name has special constructs in it,
5810 call the corresponding file handler. */
5811 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5812 if (!NILP (handler))
5813 /* The handler can find the file name the same way we did. */
5814 return call2 (handler, Qset_visited_file_modtime, Qnil);
5816 filename = ENCODE_FILE (filename);
5818 if (stat (SDATA (filename), &st) >= 0)
5819 current_buffer->modtime = st.st_mtime;
5822 return Qnil;
5825 Lisp_Object
5826 auto_save_error (error)
5827 Lisp_Object error;
5829 Lisp_Object args[3], msg;
5830 int i, nbytes;
5831 struct gcpro gcpro1;
5832 char *msgbuf;
5833 USE_SAFE_ALLOCA;
5835 ring_bell (XFRAME (selected_frame));
5837 args[0] = build_string ("Auto-saving %s: %s");
5838 args[1] = current_buffer->name;
5839 args[2] = Ferror_message_string (error);
5840 msg = Fformat (3, args);
5841 GCPRO1 (msg);
5842 nbytes = SBYTES (msg);
5843 SAFE_ALLOCA (msgbuf, char *, nbytes);
5844 bcopy (SDATA (msg), msgbuf, nbytes);
5846 for (i = 0; i < 3; ++i)
5848 if (i == 0)
5849 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5850 else
5851 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5852 Fsleep_for (make_number (1), Qnil);
5855 SAFE_FREE ();
5856 UNGCPRO;
5857 return Qnil;
5860 Lisp_Object
5861 auto_save_1 ()
5863 struct stat st;
5864 Lisp_Object modes;
5866 auto_save_mode_bits = 0666;
5868 /* Get visited file's mode to become the auto save file's mode. */
5869 if (! NILP (current_buffer->filename))
5871 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5872 /* But make sure we can overwrite it later! */
5873 auto_save_mode_bits = st.st_mode | 0600;
5874 else if ((modes = Ffile_modes (current_buffer->filename),
5875 INTEGERP (modes)))
5876 /* Remote files don't cooperate with stat. */
5877 auto_save_mode_bits = XINT (modes) | 0600;
5880 return
5881 Fwrite_region (Qnil, Qnil,
5882 current_buffer->auto_save_file_name,
5883 Qnil, Qlambda, Qnil, Qnil);
5886 static Lisp_Object
5887 do_auto_save_unwind (arg) /* used as unwind-protect function */
5888 Lisp_Object arg;
5890 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5891 auto_saving = 0;
5892 if (stream != NULL)
5894 BLOCK_INPUT;
5895 fclose (stream);
5896 UNBLOCK_INPUT;
5898 return Qnil;
5901 static Lisp_Object
5902 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5903 Lisp_Object value;
5905 minibuffer_auto_raise = XINT (value);
5906 return Qnil;
5909 static Lisp_Object
5910 do_auto_save_make_dir (dir)
5911 Lisp_Object dir;
5913 Lisp_Object mode;
5915 call2 (Qmake_directory, dir, Qt);
5916 XSETFASTINT (mode, 0700);
5917 return Fset_file_modes (dir, mode);
5920 static Lisp_Object
5921 do_auto_save_eh (ignore)
5922 Lisp_Object ignore;
5924 return Qnil;
5927 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5928 doc: /* Auto-save all buffers that need it.
5929 This is all buffers that have auto-saving enabled
5930 and are changed since last auto-saved.
5931 Auto-saving writes the buffer into a file
5932 so that your editing is not lost if the system crashes.
5933 This file is not the file you visited; that changes only when you save.
5934 Normally we run the normal hook `auto-save-hook' before saving.
5936 A non-nil NO-MESSAGE argument means do not print any message if successful.
5937 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5938 (no_message, current_only)
5939 Lisp_Object no_message, current_only;
5941 struct buffer *old = current_buffer, *b;
5942 Lisp_Object tail, buf;
5943 int auto_saved = 0;
5944 int do_handled_files;
5945 Lisp_Object oquit;
5946 FILE *stream = NULL;
5947 int count = SPECPDL_INDEX ();
5948 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5949 int old_message_p = 0;
5950 struct gcpro gcpro1, gcpro2;
5952 if (max_specpdl_size < specpdl_size + 40)
5953 max_specpdl_size = specpdl_size + 40;
5955 if (minibuf_level)
5956 no_message = Qt;
5958 if (NILP (no_message))
5960 old_message_p = push_message ();
5961 record_unwind_protect (pop_message_unwind, Qnil);
5964 /* Ordinarily don't quit within this function,
5965 but don't make it impossible to quit (in case we get hung in I/O). */
5966 oquit = Vquit_flag;
5967 Vquit_flag = Qnil;
5969 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5970 point to non-strings reached from Vbuffer_alist. */
5972 if (!NILP (Vrun_hooks))
5973 call1 (Vrun_hooks, intern ("auto-save-hook"));
5975 if (STRINGP (Vauto_save_list_file_name))
5977 Lisp_Object listfile;
5979 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5981 /* Don't try to create the directory when shutting down Emacs,
5982 because creating the directory might signal an error, and
5983 that would leave Emacs in a strange state. */
5984 if (!NILP (Vrun_hooks))
5986 Lisp_Object dir;
5987 dir = Qnil;
5988 GCPRO2 (dir, listfile);
5989 dir = Ffile_name_directory (listfile);
5990 if (NILP (Ffile_directory_p (dir)))
5991 internal_condition_case_1 (do_auto_save_make_dir,
5992 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5993 do_auto_save_eh);
5994 UNGCPRO;
5997 stream = fopen (SDATA (listfile), "w");
6000 record_unwind_protect (do_auto_save_unwind,
6001 make_save_value (stream, 0));
6002 record_unwind_protect (do_auto_save_unwind_1,
6003 make_number (minibuffer_auto_raise));
6004 minibuffer_auto_raise = 0;
6005 auto_saving = 1;
6007 /* On first pass, save all files that don't have handlers.
6008 On second pass, save all files that do have handlers.
6010 If Emacs is crashing, the handlers may tweak what is causing
6011 Emacs to crash in the first place, and it would be a shame if
6012 Emacs failed to autosave perfectly ordinary files because it
6013 couldn't handle some ange-ftp'd file. */
6015 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
6016 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
6018 buf = XCDR (XCAR (tail));
6019 b = XBUFFER (buf);
6021 /* Record all the buffers that have auto save mode
6022 in the special file that lists them. For each of these buffers,
6023 Record visited name (if any) and auto save name. */
6024 if (STRINGP (b->auto_save_file_name)
6025 && stream != NULL && do_handled_files == 0)
6027 BLOCK_INPUT;
6028 if (!NILP (b->filename))
6030 fwrite (SDATA (b->filename), 1,
6031 SBYTES (b->filename), stream);
6033 putc ('\n', stream);
6034 fwrite (SDATA (b->auto_save_file_name), 1,
6035 SBYTES (b->auto_save_file_name), stream);
6036 putc ('\n', stream);
6037 UNBLOCK_INPUT;
6040 if (!NILP (current_only)
6041 && b != current_buffer)
6042 continue;
6044 /* Don't auto-save indirect buffers.
6045 The base buffer takes care of it. */
6046 if (b->base_buffer)
6047 continue;
6049 /* Check for auto save enabled
6050 and file changed since last auto save
6051 and file changed since last real save. */
6052 if (STRINGP (b->auto_save_file_name)
6053 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
6054 && b->auto_save_modified < BUF_MODIFF (b)
6055 /* -1 means we've turned off autosaving for a while--see below. */
6056 && XINT (b->save_length) >= 0
6057 && (do_handled_files
6058 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
6059 Qwrite_region))))
6061 EMACS_TIME before_time, after_time;
6063 EMACS_GET_TIME (before_time);
6065 /* If we had a failure, don't try again for 20 minutes. */
6066 if (b->auto_save_failure_time >= 0
6067 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
6068 continue;
6070 if ((XFASTINT (b->save_length) * 10
6071 > (BUF_Z (b) - BUF_BEG (b)) * 13)
6072 /* A short file is likely to change a large fraction;
6073 spare the user annoying messages. */
6074 && XFASTINT (b->save_length) > 5000
6075 /* These messages are frequent and annoying for `*mail*'. */
6076 && !EQ (b->filename, Qnil)
6077 && NILP (no_message))
6079 /* It has shrunk too much; turn off auto-saving here. */
6080 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6081 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6082 b->name, 1);
6083 minibuffer_auto_raise = 0;
6084 /* Turn off auto-saving until there's a real save,
6085 and prevent any more warnings. */
6086 XSETINT (b->save_length, -1);
6087 Fsleep_for (make_number (1), Qnil);
6088 continue;
6090 set_buffer_internal (b);
6091 if (!auto_saved && NILP (no_message))
6092 message1 ("Auto-saving...");
6093 internal_condition_case (auto_save_1, Qt, auto_save_error);
6094 auto_saved++;
6095 b->auto_save_modified = BUF_MODIFF (b);
6096 XSETFASTINT (current_buffer->save_length, Z - BEG);
6097 set_buffer_internal (old);
6099 EMACS_GET_TIME (after_time);
6101 /* If auto-save took more than 60 seconds,
6102 assume it was an NFS failure that got a timeout. */
6103 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6104 b->auto_save_failure_time = EMACS_SECS (after_time);
6108 /* Prevent another auto save till enough input events come in. */
6109 record_auto_save ();
6111 if (auto_saved && NILP (no_message))
6113 if (old_message_p)
6115 /* If we are going to restore an old message,
6116 give time to read ours. */
6117 sit_for (make_number (1), 0, 0);
6118 restore_message ();
6120 else
6121 /* If we displayed a message and then restored a state
6122 with no message, leave a "done" message on the screen. */
6123 message1 ("Auto-saving...done");
6126 Vquit_flag = oquit;
6128 /* This restores the message-stack status. */
6129 unbind_to (count, Qnil);
6130 return Qnil;
6133 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6134 Sset_buffer_auto_saved, 0, 0, 0,
6135 doc: /* Mark current buffer as auto-saved with its current text.
6136 No auto-save file will be written until the buffer changes again. */)
6139 current_buffer->auto_save_modified = MODIFF;
6140 XSETFASTINT (current_buffer->save_length, Z - BEG);
6141 current_buffer->auto_save_failure_time = -1;
6142 return Qnil;
6145 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6146 Sclear_buffer_auto_save_failure, 0, 0, 0,
6147 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6150 current_buffer->auto_save_failure_time = -1;
6151 return Qnil;
6154 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6155 0, 0, 0,
6156 doc: /* Return t if current buffer has been auto-saved recently.
6157 More precisely, if it has been auto-saved since last read from or saved
6158 in the visited file. If the buffer has no visited file,
6159 then any auto-save counts as "recent". */)
6162 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6165 /* Reading and completing file names */
6166 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6167 extern Lisp_Object Qcompletion_ignore_case;
6169 /* In the string VAL, change each $ to $$ and return the result. */
6171 static Lisp_Object
6172 double_dollars (val)
6173 Lisp_Object val;
6175 register const unsigned char *old;
6176 register unsigned char *new;
6177 register int n;
6178 int osize, count;
6180 osize = SBYTES (val);
6182 /* Count the number of $ characters. */
6183 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6184 if (*old++ == '$') count++;
6185 if (count > 0)
6187 old = SDATA (val);
6188 val = make_uninit_multibyte_string (SCHARS (val) + count,
6189 osize + count);
6190 new = SDATA (val);
6191 for (n = osize; n > 0; n--)
6192 if (*old != '$')
6193 *new++ = *old++;
6194 else
6196 *new++ = '$';
6197 *new++ = '$';
6198 old++;
6201 return val;
6204 static Lisp_Object
6205 read_file_name_cleanup (arg)
6206 Lisp_Object arg;
6208 return (current_buffer->directory = arg);
6211 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6212 3, 3, 0,
6213 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6214 (string, dir, action)
6215 Lisp_Object string, dir, action;
6216 /* action is nil for complete, t for return list of completions,
6217 lambda for verify final value */
6219 Lisp_Object name, specdir, realdir, val, orig_string;
6220 int changed;
6221 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6223 CHECK_STRING (string);
6225 realdir = dir;
6226 name = string;
6227 orig_string = Qnil;
6228 specdir = Qnil;
6229 changed = 0;
6230 /* No need to protect ACTION--we only compare it with t and nil. */
6231 GCPRO5 (string, realdir, name, specdir, orig_string);
6233 if (SCHARS (string) == 0)
6235 if (EQ (action, Qlambda))
6237 UNGCPRO;
6238 return Qnil;
6241 else
6243 orig_string = string;
6244 string = Fsubstitute_in_file_name (string);
6245 changed = NILP (Fstring_equal (string, orig_string));
6246 name = Ffile_name_nondirectory (string);
6247 val = Ffile_name_directory (string);
6248 if (! NILP (val))
6249 realdir = Fexpand_file_name (val, realdir);
6252 if (NILP (action))
6254 specdir = Ffile_name_directory (string);
6255 val = Ffile_name_completion (name, realdir, Vread_file_name_predicate);
6256 UNGCPRO;
6257 if (!STRINGP (val))
6259 if (changed)
6260 return double_dollars (string);
6261 return val;
6264 if (!NILP (specdir))
6265 val = concat2 (specdir, val);
6266 #ifndef VMS
6267 return double_dollars (val);
6268 #else /* not VMS */
6269 return val;
6270 #endif /* not VMS */
6272 UNGCPRO;
6274 if (EQ (action, Qt))
6276 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6277 Lisp_Object comp;
6278 int count;
6280 if (NILP (Vread_file_name_predicate)
6281 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6282 return all;
6284 #ifndef VMS
6285 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6287 /* Brute-force speed up for directory checking:
6288 Discard strings which don't end in a slash. */
6289 for (comp = Qnil; CONSP (all); all = XCDR (all))
6291 Lisp_Object tem = XCAR (all);
6292 int len;
6293 if (STRINGP (tem)
6294 && (len = SBYTES (tem), len > 0)
6295 && IS_DIRECTORY_SEP (SREF (tem, len-1)))
6296 comp = Fcons (tem, comp);
6299 else
6300 #endif
6302 /* Must do it the hard (and slow) way. */
6303 Lisp_Object tem;
6304 GCPRO3 (all, comp, specdir);
6305 count = SPECPDL_INDEX ();
6306 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6307 current_buffer->directory = realdir;
6308 for (comp = Qnil; CONSP (all); all = XCDR (all))
6310 tem = call1 (Vread_file_name_predicate, XCAR (all));
6311 if (!NILP (tem))
6312 comp = Fcons (XCAR (all), comp);
6314 unbind_to (count, Qnil);
6315 UNGCPRO;
6317 return Fnreverse (comp);
6320 /* Only other case actually used is ACTION = lambda */
6321 #ifdef VMS
6322 /* Supposedly this helps commands such as `cd' that read directory names,
6323 but can someone explain how it helps them? -- RMS */
6324 if (SCHARS (name) == 0)
6325 return Qt;
6326 #endif /* VMS */
6327 string = Fexpand_file_name (string, dir);
6328 if (!NILP (Vread_file_name_predicate))
6329 return call1 (Vread_file_name_predicate, string);
6330 return Ffile_exists_p (string);
6333 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6334 Snext_read_file_uses_dialog_p, 0, 0, 0,
6335 doc: /* Return t if a call to `read-file-name' will use a dialog.
6336 The return value is only relevant for a call to `read-file-name' that happens
6337 before any other event (mouse or keypress) is handeled. */)
6340 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6341 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6342 && use_dialog_box
6343 && use_file_dialog
6344 && have_menus_p ())
6345 return Qt;
6346 #endif
6347 return Qnil;
6350 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6351 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6352 Value is not expanded---you must call `expand-file-name' yourself.
6353 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6354 the same non-empty string that was inserted by this function.
6355 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6356 except that if INITIAL is specified, that combined with DIR is used.)
6357 If the user exits with an empty minibuffer, this function returns
6358 an empty string. (This can only happen if the user erased the
6359 pre-inserted contents or if `insert-default-directory' is nil.)
6360 Fourth arg MUSTMATCH non-nil means require existing file's name.
6361 Non-nil and non-t means also require confirmation after completion.
6362 Fifth arg INITIAL specifies text to start with.
6363 If optional sixth arg PREDICATE is non-nil, possible completions and
6364 the resulting file name must satisfy (funcall PREDICATE NAME).
6365 DIR should be an absolute directory name. It defaults to the value of
6366 `default-directory'.
6368 If this command was invoked with the mouse, use a file dialog box if
6369 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6370 provides a file dialog box.
6372 See also `read-file-name-completion-ignore-case'
6373 and `read-file-name-function'. */)
6374 (prompt, dir, default_filename, mustmatch, initial, predicate)
6375 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6377 Lisp_Object val, insdef, tem;
6378 struct gcpro gcpro1, gcpro2;
6379 register char *homedir;
6380 Lisp_Object decoded_homedir;
6381 int replace_in_history = 0;
6382 int add_to_history = 0;
6383 int count;
6385 if (NILP (dir))
6386 dir = current_buffer->directory;
6387 if (NILP (Ffile_name_absolute_p (dir)))
6388 dir = Fexpand_file_name (dir, Qnil);
6389 if (NILP (default_filename))
6390 default_filename
6391 = (!NILP (initial)
6392 ? Fexpand_file_name (initial, dir)
6393 : current_buffer->filename);
6395 /* If dir starts with user's homedir, change that to ~. */
6396 homedir = (char *) egetenv ("HOME");
6397 #ifdef DOS_NT
6398 /* homedir can be NULL in temacs, since Vglobal_environment is not
6399 yet set up. We shouldn't crash in that case. */
6400 if (homedir != 0)
6402 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6403 CORRECT_DIR_SEPS (homedir);
6405 #endif
6406 if (homedir != 0)
6407 decoded_homedir
6408 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6409 if (homedir != 0
6410 && STRINGP (dir)
6411 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6412 SBYTES (decoded_homedir))
6413 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6415 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6416 dir = concat2 (build_string ("~"), dir);
6418 /* Likewise for default_filename. */
6419 if (homedir != 0
6420 && STRINGP (default_filename)
6421 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6422 SBYTES (decoded_homedir))
6423 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6425 default_filename
6426 = Fsubstring (default_filename,
6427 make_number (SCHARS (decoded_homedir)), Qnil);
6428 default_filename = concat2 (build_string ("~"), default_filename);
6430 if (!NILP (default_filename))
6432 CHECK_STRING (default_filename);
6433 default_filename = double_dollars (default_filename);
6436 if (insert_default_directory && STRINGP (dir))
6438 insdef = dir;
6439 if (!NILP (initial))
6441 Lisp_Object args[2], pos;
6443 args[0] = insdef;
6444 args[1] = initial;
6445 insdef = Fconcat (2, args);
6446 pos = make_number (SCHARS (double_dollars (dir)));
6447 insdef = Fcons (double_dollars (insdef), pos);
6449 else
6450 insdef = double_dollars (insdef);
6452 else if (STRINGP (initial))
6453 insdef = Fcons (double_dollars (initial), make_number (0));
6454 else
6455 insdef = Qnil;
6457 if (!NILP (Vread_file_name_function))
6459 Lisp_Object args[7];
6461 GCPRO2 (insdef, default_filename);
6462 args[0] = Vread_file_name_function;
6463 args[1] = prompt;
6464 args[2] = dir;
6465 args[3] = default_filename;
6466 args[4] = mustmatch;
6467 args[5] = initial;
6468 args[6] = predicate;
6469 RETURN_UNGCPRO (Ffuncall (7, args));
6472 count = SPECPDL_INDEX ();
6473 specbind (Qcompletion_ignore_case,
6474 read_file_name_completion_ignore_case ? Qt : Qnil);
6475 specbind (intern ("minibuffer-completing-file-name"), Qt);
6476 specbind (intern ("read-file-name-predicate"),
6477 (NILP (predicate) ? Qfile_exists_p : predicate));
6479 GCPRO2 (insdef, default_filename);
6481 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6482 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6484 /* If DIR contains a file name, split it. */
6485 Lisp_Object file;
6486 file = Ffile_name_nondirectory (dir);
6487 if (SCHARS (file) && NILP (default_filename))
6489 default_filename = file;
6490 dir = Ffile_name_directory (dir);
6492 if (!NILP(default_filename))
6493 default_filename = Fexpand_file_name (default_filename, dir);
6494 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6495 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6496 add_to_history = 1;
6498 else
6499 #endif
6500 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6501 dir, mustmatch, insdef,
6502 Qfile_name_history, default_filename, Qnil);
6504 tem = Fsymbol_value (Qfile_name_history);
6505 if (CONSP (tem) && EQ (XCAR (tem), val))
6506 replace_in_history = 1;
6508 /* If Fcompleting_read returned the inserted default string itself
6509 (rather than a new string with the same contents),
6510 it has to mean that the user typed RET with the minibuffer empty.
6511 In that case, we really want to return ""
6512 so that commands such as set-visited-file-name can distinguish. */
6513 if (EQ (val, default_filename))
6515 /* In this case, Fcompleting_read has not added an element
6516 to the history. Maybe we should. */
6517 if (! replace_in_history)
6518 add_to_history = 1;
6520 val = empty_unibyte_string;
6523 unbind_to (count, Qnil);
6524 UNGCPRO;
6525 if (NILP (val))
6526 error ("No file name specified");
6528 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6530 if (!NILP (tem) && !NILP (default_filename))
6531 val = default_filename;
6532 val = Fsubstitute_in_file_name (val);
6534 if (replace_in_history)
6535 /* Replace what Fcompleting_read added to the history
6536 with what we will actually return. */
6538 Lisp_Object val1 = double_dollars (val);
6539 tem = Fsymbol_value (Qfile_name_history);
6540 if (history_delete_duplicates)
6541 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6542 XSETCAR (tem, val1);
6544 else if (add_to_history)
6546 /* Add the value to the history--but not if it matches
6547 the last value already there. */
6548 Lisp_Object val1 = double_dollars (val);
6549 tem = Fsymbol_value (Qfile_name_history);
6550 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6552 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6553 Fset (Qfile_name_history, Fcons (val1, tem));
6557 return val;
6561 void
6562 init_fileio_once ()
6564 /* Must be set before any path manipulation is performed. */
6565 XSETFASTINT (Vdirectory_sep_char, '/');
6569 void
6570 syms_of_fileio ()
6572 Qoperations = intern ("operations");
6573 Qexpand_file_name = intern ("expand-file-name");
6574 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6575 Qdirectory_file_name = intern ("directory-file-name");
6576 Qfile_name_directory = intern ("file-name-directory");
6577 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6578 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6579 Qfile_name_as_directory = intern ("file-name-as-directory");
6580 Qcopy_file = intern ("copy-file");
6581 Qmake_directory_internal = intern ("make-directory-internal");
6582 Qmake_directory = intern ("make-directory");
6583 Qdelete_directory = intern ("delete-directory");
6584 Qdelete_file = intern ("delete-file");
6585 Qrename_file = intern ("rename-file");
6586 Qadd_name_to_file = intern ("add-name-to-file");
6587 Qmake_symbolic_link = intern ("make-symbolic-link");
6588 Qfile_exists_p = intern ("file-exists-p");
6589 Qfile_executable_p = intern ("file-executable-p");
6590 Qfile_readable_p = intern ("file-readable-p");
6591 Qfile_writable_p = intern ("file-writable-p");
6592 Qfile_symlink_p = intern ("file-symlink-p");
6593 Qaccess_file = intern ("access-file");
6594 Qfile_directory_p = intern ("file-directory-p");
6595 Qfile_regular_p = intern ("file-regular-p");
6596 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6597 Qfile_modes = intern ("file-modes");
6598 Qset_file_modes = intern ("set-file-modes");
6599 Qset_file_times = intern ("set-file-times");
6600 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6601 Qinsert_file_contents = intern ("insert-file-contents");
6602 Qwrite_region = intern ("write-region");
6603 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6604 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6605 Qauto_save_coding = intern ("auto-save-coding");
6607 staticpro (&Qoperations);
6608 staticpro (&Qexpand_file_name);
6609 staticpro (&Qsubstitute_in_file_name);
6610 staticpro (&Qdirectory_file_name);
6611 staticpro (&Qfile_name_directory);
6612 staticpro (&Qfile_name_nondirectory);
6613 staticpro (&Qunhandled_file_name_directory);
6614 staticpro (&Qfile_name_as_directory);
6615 staticpro (&Qcopy_file);
6616 staticpro (&Qmake_directory_internal);
6617 staticpro (&Qmake_directory);
6618 staticpro (&Qdelete_directory);
6619 staticpro (&Qdelete_file);
6620 staticpro (&Qrename_file);
6621 staticpro (&Qadd_name_to_file);
6622 staticpro (&Qmake_symbolic_link);
6623 staticpro (&Qfile_exists_p);
6624 staticpro (&Qfile_executable_p);
6625 staticpro (&Qfile_readable_p);
6626 staticpro (&Qfile_writable_p);
6627 staticpro (&Qaccess_file);
6628 staticpro (&Qfile_symlink_p);
6629 staticpro (&Qfile_directory_p);
6630 staticpro (&Qfile_regular_p);
6631 staticpro (&Qfile_accessible_directory_p);
6632 staticpro (&Qfile_modes);
6633 staticpro (&Qset_file_modes);
6634 staticpro (&Qset_file_times);
6635 staticpro (&Qfile_newer_than_file_p);
6636 staticpro (&Qinsert_file_contents);
6637 staticpro (&Qwrite_region);
6638 staticpro (&Qverify_visited_file_modtime);
6639 staticpro (&Qset_visited_file_modtime);
6640 staticpro (&Qauto_save_coding);
6642 Qfile_name_history = intern ("file-name-history");
6643 Fset (Qfile_name_history, Qnil);
6644 staticpro (&Qfile_name_history);
6646 Qfile_error = intern ("file-error");
6647 staticpro (&Qfile_error);
6648 Qfile_already_exists = intern ("file-already-exists");
6649 staticpro (&Qfile_already_exists);
6650 Qfile_date_error = intern ("file-date-error");
6651 staticpro (&Qfile_date_error);
6652 Qexcl = intern ("excl");
6653 staticpro (&Qexcl);
6655 #ifdef DOS_NT
6656 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6657 staticpro (&Qfind_buffer_file_type);
6658 #endif /* DOS_NT */
6660 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6661 doc: /* *Coding system for encoding file names.
6662 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6663 Vfile_name_coding_system = Qnil;
6665 DEFVAR_LISP ("default-file-name-coding-system",
6666 &Vdefault_file_name_coding_system,
6667 doc: /* Default coding system for encoding file names.
6668 This variable is used only when `file-name-coding-system' is nil.
6670 This variable is set/changed by the command `set-language-environment'.
6671 User should not set this variable manually,
6672 instead use `file-name-coding-system' to get a constant encoding
6673 of file names regardless of the current language environment. */);
6674 Vdefault_file_name_coding_system = Qnil;
6676 Qformat_decode = intern ("format-decode");
6677 staticpro (&Qformat_decode);
6678 Qformat_annotate_function = intern ("format-annotate-function");
6679 staticpro (&Qformat_annotate_function);
6680 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6681 staticpro (&Qafter_insert_file_set_coding);
6683 Qcar_less_than_car = intern ("car-less-than-car");
6684 staticpro (&Qcar_less_than_car);
6686 Fput (Qfile_error, Qerror_conditions,
6687 list2 (Qfile_error, Qerror));
6688 Fput (Qfile_error, Qerror_message,
6689 build_string ("File error"));
6691 Fput (Qfile_already_exists, Qerror_conditions,
6692 list3 (Qfile_already_exists, Qfile_error, Qerror));
6693 Fput (Qfile_already_exists, Qerror_message,
6694 build_string ("File already exists"));
6696 Fput (Qfile_date_error, Qerror_conditions,
6697 list3 (Qfile_date_error, Qfile_error, Qerror));
6698 Fput (Qfile_date_error, Qerror_message,
6699 build_string ("Cannot set file date"));
6701 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6702 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6703 Vread_file_name_function = Qnil;
6705 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6706 doc: /* Current predicate used by `read-file-name-internal'. */);
6707 Vread_file_name_predicate = Qnil;
6709 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6710 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6711 #if defined VMS || defined DOS_NT || defined MAC_OS
6712 read_file_name_completion_ignore_case = 1;
6713 #else
6714 read_file_name_completion_ignore_case = 0;
6715 #endif
6717 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6718 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6719 If the initial minibuffer contents are non-empty, you can usually
6720 request a default filename by typing RETURN without editing. For some
6721 commands, exiting with an empty minibuffer has a special meaning,
6722 such as making the current buffer visit no file in the case of
6723 `set-visited-file-name'.
6724 If this variable is non-nil, the minibuffer contents are always
6725 initially non-empty and typing RETURN without editing will fetch the
6726 default name, if one is provided. Note however that this default name
6727 is not necessarily the name originally inserted in the minibuffer, if
6728 that is just the default directory.
6729 If this variable is nil, the minibuffer often starts out empty. In
6730 that case you may have to explicitly fetch the next history element to
6731 request the default name. */);
6732 insert_default_directory = 1;
6734 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6735 doc: /* *Non-nil means write new files with record format `stmlf'.
6736 nil means use format `var'. This variable is meaningful only on VMS. */);
6737 vms_stmlf_recfm = 0;
6739 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6740 doc: /* Directory separator character for built-in functions that return file names.
6741 The value is always ?/. Don't use this variable, just use `/'. */);
6743 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6744 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6745 If a file name matches REGEXP, then all I/O on that file is done by calling
6746 HANDLER.
6748 The first argument given to HANDLER is the name of the I/O primitive
6749 to be handled; the remaining arguments are the arguments that were
6750 passed to that primitive. For example, if you do
6751 (file-exists-p FILENAME)
6752 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6753 (funcall HANDLER 'file-exists-p FILENAME)
6754 The function `find-file-name-handler' checks this list for a handler
6755 for its argument. */);
6756 Vfile_name_handler_alist = Qnil;
6758 DEFVAR_LISP ("set-auto-coding-function",
6759 &Vset_auto_coding_function,
6760 doc: /* If non-nil, a function to call to decide a coding system of file.
6761 Two arguments are passed to this function: the file name
6762 and the length of a file contents following the point.
6763 This function should return a coding system to decode the file contents.
6764 It should check the file name against `auto-coding-alist'.
6765 If no coding system is decided, it should check a coding system
6766 specified in the heading lines with the format:
6767 -*- ... coding: CODING-SYSTEM; ... -*-
6768 or local variable spec of the tailing lines with `coding:' tag. */);
6769 Vset_auto_coding_function = Qnil;
6771 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6772 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6773 Each is passed one argument, the number of characters inserted,
6774 with point at the start of the inserted text. Each function
6775 should leave point the same, and return the new character count.
6776 If `insert-file-contents' is intercepted by a handler from
6777 `file-name-handler-alist', that handler is responsible for calling the
6778 functions in `after-insert-file-functions' if appropriate. */);
6779 Vafter_insert_file_functions = Qnil;
6781 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6782 doc: /* A list of functions to be called at the start of `write-region'.
6783 Each is passed two arguments, START and END as for `write-region'.
6784 These are usually two numbers but not always; see the documentation
6785 for `write-region'. The function should return a list of pairs
6786 of the form (POSITION . STRING), consisting of strings to be effectively
6787 inserted at the specified positions of the file being written (1 means to
6788 insert before the first byte written). The POSITIONs must be sorted into
6789 increasing order. If there are several functions in the list, the several
6790 lists are merged destructively. Alternatively, the function can return
6791 with a different buffer current; in that case it should pay attention
6792 to the annotations returned by previous functions and listed in
6793 `write-region-annotations-so-far'.*/);
6794 Vwrite_region_annotate_functions = Qnil;
6795 staticpro (&Qwrite_region_annotate_functions);
6796 Qwrite_region_annotate_functions
6797 = intern ("write-region-annotate-functions");
6799 DEFVAR_LISP ("write-region-annotations-so-far",
6800 &Vwrite_region_annotations_so_far,
6801 doc: /* When an annotation function is called, this holds the previous annotations.
6802 These are the annotations made by other annotation functions
6803 that were already called. See also `write-region-annotate-functions'. */);
6804 Vwrite_region_annotations_so_far = Qnil;
6806 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6807 doc: /* A list of file name handlers that temporarily should not be used.
6808 This applies only to the operation `inhibit-file-name-operation'. */);
6809 Vinhibit_file_name_handlers = Qnil;
6811 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6812 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6813 Vinhibit_file_name_operation = Qnil;
6815 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6816 doc: /* File name in which we write a list of all auto save file names.
6817 This variable is initialized automatically from `auto-save-list-file-prefix'
6818 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6819 a non-nil value. */);
6820 Vauto_save_list_file_name = Qnil;
6822 #ifdef HAVE_FSYNC
6823 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6824 doc: /* *Non-nil means don't call fsync in `write-region'.
6825 This variable affects calls to `write-region' as well as save commands.
6826 A non-nil value may result in data loss! */);
6827 write_region_inhibit_fsync = 0;
6828 #endif
6830 defsubr (&Sfind_file_name_handler);
6831 defsubr (&Sfile_name_directory);
6832 defsubr (&Sfile_name_nondirectory);
6833 defsubr (&Sunhandled_file_name_directory);
6834 defsubr (&Sfile_name_as_directory);
6835 defsubr (&Sdirectory_file_name);
6836 defsubr (&Smake_temp_name);
6837 defsubr (&Sexpand_file_name);
6838 defsubr (&Ssubstitute_in_file_name);
6839 defsubr (&Scopy_file);
6840 defsubr (&Smake_directory_internal);
6841 defsubr (&Sdelete_directory);
6842 defsubr (&Sdelete_file);
6843 defsubr (&Srename_file);
6844 defsubr (&Sadd_name_to_file);
6845 #ifdef S_IFLNK
6846 defsubr (&Smake_symbolic_link);
6847 #endif /* S_IFLNK */
6848 #ifdef VMS
6849 defsubr (&Sdefine_logical_name);
6850 #endif /* VMS */
6851 #ifdef HPUX_NET
6852 defsubr (&Ssysnetunam);
6853 #endif /* HPUX_NET */
6854 defsubr (&Sfile_name_absolute_p);
6855 defsubr (&Sfile_exists_p);
6856 defsubr (&Sfile_executable_p);
6857 defsubr (&Sfile_readable_p);
6858 defsubr (&Sfile_writable_p);
6859 defsubr (&Saccess_file);
6860 defsubr (&Sfile_symlink_p);
6861 defsubr (&Sfile_directory_p);
6862 defsubr (&Sfile_accessible_directory_p);
6863 defsubr (&Sfile_regular_p);
6864 defsubr (&Sfile_modes);
6865 defsubr (&Sset_file_modes);
6866 defsubr (&Sset_file_times);
6867 defsubr (&Sset_default_file_modes);
6868 defsubr (&Sdefault_file_modes);
6869 defsubr (&Sfile_newer_than_file_p);
6870 defsubr (&Sinsert_file_contents);
6871 defsubr (&Swrite_region);
6872 defsubr (&Scar_less_than_car);
6873 defsubr (&Sverify_visited_file_modtime);
6874 defsubr (&Sclear_visited_file_modtime);
6875 defsubr (&Svisited_file_modtime);
6876 defsubr (&Sset_visited_file_modtime);
6877 defsubr (&Sdo_auto_save);
6878 defsubr (&Sset_buffer_auto_saved);
6879 defsubr (&Sclear_buffer_auto_save_failure);
6880 defsubr (&Srecent_auto_save_p);
6882 defsubr (&Sread_file_name_internal);
6883 defsubr (&Sread_file_name);
6884 defsubr (&Snext_read_file_uses_dialog_p);
6886 #ifdef HAVE_SYNC
6887 defsubr (&Sunix_sync);
6888 #endif
6891 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6892 (do not change this comment) */