fileio.c 176 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
Glenn Morris's avatar
Glenn Morris committed
2 3 4 5

Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997,
  1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
  2009, 2010, 2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

9
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
10
it under the terms of the GNU General Public License as published by
11 12
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
23
#include <limits.h>
24
#include <fcntl.h>
25
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
26 27
#include <sys/types.h>
#include <sys/stat.h>
28
#include <setjmp.h>
29 30
#include <unistd.h>

31 32 33 34
#if !defined (S_ISLNK) && defined (S_IFLNK)
#  define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
#endif

35 36 37 38
#if !defined (S_ISFIFO) && defined (S_IFIFO)
#  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
#endif

39 40 41 42
#if !defined (S_ISREG) && defined (S_IFREG)
#  define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
#endif

43
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
44
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
45 46
#endif

Jim Blandy's avatar
Jim Blandy committed
47 48 49
#include <ctype.h>
#include <errno.h>

Karel Klíc's avatar
Karel Klíc committed
50 51 52 53 54
#ifdef HAVE_LIBSELINUX
#include <selinux/selinux.h>
#include <selinux/context.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
55
#include "lisp.h"
56
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
57
#include "buffer.h"
58
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
59
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
60
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
61
#include "blockinput.h"
Karoly Lorentey's avatar
Karoly Lorentey committed
62 63
#include "frame.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
64

65 66 67 68 69 70
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
71 72 73 74 75 76
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#include <fcntl.h>
#endif

77 78 79 80 81 82 83 84 85
#ifdef DOS_NT
/* On Windows, drive letters must be alphabetic - on DOS, the Netware
   redirector allows the six letters between 'Z' and 'a' as well. */
#ifdef MSDOS
#define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
#endif
#ifdef WINDOWSNT
#define IS_DRIVE(x) isalpha (x)
#endif
86 87 88 89
/* Need to lower-case the drive letter, or else expanded
   filenames will sometimes compare inequal, because
   `expand-file-name' doesn't always down-case the drive letter.  */
#define DRIVE_LETTER(x) (tolower (x))
90 91
#endif

Jim Blandy's avatar
Jim Blandy committed
92
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
93 94 95

#ifdef HPUX
#include <netio.h>
96
#endif
Jim Blandy's avatar
Jim Blandy committed
97

98 99
#include "commands.h"

100 101 102 103
#ifndef S_ISLNK
#  define lstat stat
#endif

104 105 106 107
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
108 109 110 111 112 113 114
/* Nonzero during writing of auto-save files */
int auto_saving;

/* Set by auto_save_1 to mode of original file so Fwrite_region will create
   a new file with the same mode as the original */
int auto_save_mode_bits;

115 116 117
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

118 119 120 121 122 123 124
/* The symbol bound to coding-system-for-read when
   insert-file-contents is called for recovering a file.  This is not
   an actual coding system name, but just an indicator to tell
   insert-file-contents to use `emacs-mule' with a special flag for
   auto saving and recovering a file.  */
Lisp_Object Qauto_save_coding;

125 126 127 128
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

129 130 131
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

132
/* Lisp function for setting buffer-file-coding-system and the
133
   multibyteness of the current buffer after inserting a file.  */
134
Lisp_Object Qafter_insert_file_set_coding;
135

136
Lisp_Object Qwrite_region_annotate_functions;
137 138 139 140
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
Lisp_Object Vwrite_region_annotation_buffers;

141 142 143
#ifdef HAVE_FSYNC
#endif

144 145
Lisp_Object Qdelete_by_moving_to_trash;

146 147 148
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

149 150 151 152 153 154
/* Lisp function for recursively copying directories.  */
Lisp_Object Qcopy_directory;

/* Lisp function for recursively deleting directories.  */
Lisp_Object Qdelete_directory;

155 156 157
#ifdef WINDOWSNT
#endif

158
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
159
Lisp_Object Qexcl;
160 161
Lisp_Object Qfile_name_history;

162 163
Lisp_Object Qcar_less_than_car;

164 165 166
static int a_write (int, Lisp_Object, int, int,
                    Lisp_Object *, struct coding_system *);
static int e_write (int, Lisp_Object, int, int, struct coding_system *);
167

168

169
void
170
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
171 172
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
173
  int errorno = errno;
174
  char *str;
Jim Blandy's avatar
Jim Blandy committed
175

176
  synchronize_system_messages_locale ();
177 178 179
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
180 181
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
182
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
183 184 185
    switch (errorno)
      {
      case EEXIST:
186
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
190 191
	   unless it is followed by a slash.  (The slash case caters to
	   error messages that begin with "I/O" or, in German, "E/A".)  */
192 193
	if (STRING_MULTIBYTE (errstring)
	    && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
194 195 196
	  {
	    int c;

197
	    str = SSDATA (errstring);
198
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
199
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
200
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
201

202
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
203 204
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
205
}
206

207
Lisp_Object
208
close_file_unwind (Lisp_Object fd)
209
{
210
  emacs_close (XFASTINT (fd));
211
  return Qnil;
212
}
213 214 215

/* Restore point, having saved it as a marker.  */

Andreas Schwab's avatar
Andreas Schwab committed
216
Lisp_Object
217
restore_point_unwind (Lisp_Object location)
218
{
219
  Fgoto_char (location);
220
  Fset_marker (location, Qnil, Qnil);
221
  return Qnil;
222
}
223

Jim Blandy's avatar
Jim Blandy committed
224

225
Lisp_Object Qexpand_file_name;
226
Lisp_Object Qsubstitute_in_file_name;
227 228 229
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
230
Lisp_Object Qunhandled_file_name_directory;
231
Lisp_Object Qfile_name_as_directory;
232
Lisp_Object Qcopy_file;
233
Lisp_Object Qmake_directory_internal;
234
Lisp_Object Qmake_directory;
235
Lisp_Object Qdelete_directory_internal;
236 237 238 239 240 241 242 243
Lisp_Object Qdelete_file;
Lisp_Object Qrename_file;
Lisp_Object Qadd_name_to_file;
Lisp_Object Qmake_symbolic_link;
Lisp_Object Qfile_exists_p;
Lisp_Object Qfile_executable_p;
Lisp_Object Qfile_readable_p;
Lisp_Object Qfile_writable_p;
244 245
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
246
Lisp_Object Qfile_directory_p;
247
Lisp_Object Qfile_regular_p;
248 249 250
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
251
Lisp_Object Qset_file_times;
Karel Klíc's avatar
Karel Klíc committed
252 253
Lisp_Object Qfile_selinux_context;
Lisp_Object Qset_file_selinux_context;
254 255 256 257
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
258
Lisp_Object Qset_visited_file_modtime;
259

260
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
261 262 263 264 265 266 267 268 269
       doc: /* Return FILENAME's handler function for OPERATION, if it has one.
Otherwise, return nil.
A file name is handled if one of the regular expressions in
`file-name-handler-alist' matches it.

If OPERATION equals `inhibit-file-name-operation', then we ignore
any handlers that are members of `inhibit-file-name-handlers',
but we still do run any other handlers.  This lets handlers
use the standard functions without calling themselves recursively.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
270
  (Lisp_Object filename, Lisp_Object operation)
271
{
272
  /* This function must not munge the match data.  */
273
  Lisp_Object chain, inhibited_handlers, result;
274
  int pos = -1;
275

276
  result = Qnil;
277
  CHECK_STRING (filename);
278

279 280 281 282
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
283

284
  for (chain = Vfile_name_handler_alist; CONSP (chain);
285
       chain = XCDR (chain))
286 287
    {
      Lisp_Object elt;
288
      elt = XCAR (chain);
289
      if (CONSP (elt))
290
	{
291
	  Lisp_Object string = XCAR (elt);
292
	  int match_pos;
293
	  Lisp_Object handler = XCDR (elt);
294 295 296 297
	  Lisp_Object operations = Qnil;

	  if (SYMBOLP (handler))
	    operations = Fget (handler, Qoperations);
298

299
	  if (STRINGP (string)
300 301
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
302
	    {
303
	      Lisp_Object tem;
304

305
	      handler = XCDR (elt);
306 307
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
308 309 310 311
		{
		  result = handler;
		  pos = match_pos;
		}
312
	    }
313
	}
314 315

      QUIT;
316
    }
317
  return result;
318 319
}

Jim Blandy's avatar
Jim Blandy committed
320
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
321 322 323
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
324
Otherwise return a directory name.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
325
Given a Unix syntax file name, returns a string ending in slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
326
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
327
{
328
#ifndef DOS_NT
329
  register const unsigned char *beg;
330 331 332
#else
  register unsigned char *beg;
#endif
333
  register const unsigned char *p;
334
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
335

336
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
337

338 339
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
340
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
341
  if (!NILP (handler))
342
    return call2 (handler, Qfile_name_directory, filename);
343

344
  filename = FILE_SYSTEM_CASE (filename);
345
#ifdef DOS_NT
346
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
347
  memcpy (beg, SDATA (filename), SBYTES (filename) + 1);
348 349
#else
  beg = SDATA (filename);
350
#endif
351
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
352

353 354
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
355 356 357 358 359
	 /* only recognise drive specifier at the beginning */
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" and "/:foo" cases correctly  */
	      && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
		  || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
360
#endif
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364
	 ) p--;

  if (p == beg)
    return Qnil;
365
#ifdef DOS_NT
366
  /* Expansion of "c:" to drive and default directory.  */
367
  if (p[-1] == ':')
368 369
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
370
      unsigned char *res = alloca (MAXPATHLEN + 1);
371 372 373 374 375 376 377 378 379 380
      unsigned char *r = res;

      if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
	{
	  strncpy (res, beg, 2);
	  beg += 2;
	  r += 2;
	}

      if (getdefdir (toupper (*beg) - 'A' + 1, r))
381
	{
382
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
383 384 385 386 387
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
388
  dostounix_filename (beg);
389
#endif /* DOS_NT */
390

391
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
392 393
}

394 395
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
396 397 398 399
       doc: /* Return file name FILENAME sans its directory.
For example, in a Unix-syntax file name,
this is everything after the last slash,
or the entire name if it contains no slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
400
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
401
{
402
  register const unsigned char *beg, *p, *end;
403
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
404

405
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
406

407 408
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
409
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
410
  if (!NILP (handler))
411
    return call2 (handler, Qfile_name_nondirectory, filename);
412

413 414
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
415

416 417 418
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
419 420 421
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
422
#endif
423 424
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
425

426
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
427
}
428

429 430
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
431 432 433 434 435
       doc: /* Return a directly usable directory name somehow associated with FILENAME.
A `directly usable' directory name is one that may be used without the
intervention of any file handler.
If FILENAME is a directly usable file itself, return
\(file-name-directory FILENAME).
Stefan Monnier's avatar
Stefan Monnier committed
436 437
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
438 439
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
440
  (Lisp_Object filename)
441 442 443 444 445
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
446
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
447 448 449 450 451 452
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
453 454

char *
455
file_name_as_directory (char *out, char *in)
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460
{
  int size = strlen (in) - 1;

  strcpy (out, in);

461 462
  if (size < 0)
    {
463 464 465
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
466 467 468
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
469
  /* For Unix syntax, Append a slash if necessary */
470
  if (!IS_DIRECTORY_SEP (out[size]))
471
    {
472
      out[size + 1] = DIRECTORY_SEP;
473 474
      out[size + 2] = '\0';
    }
475
#ifdef DOS_NT
476
  dostounix_filename (out);
477
#endif
Jim Blandy's avatar
Jim Blandy committed
478 479 480 481 482
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
483
       doc: /* Return a string representing the file name FILE interpreted as a directory.
484 485 486 487
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
The result can be used as the value of `default-directory'
or passed as second argument to `expand-file-name'.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
488
For a Unix-syntax file name, just appends a slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
489
  (Lisp_Object file)
Jim Blandy's avatar
Jim Blandy committed
490 491
{
  char *buf;
492
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
493

494
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
495
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
496
    return Qnil;
497 498 499

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
500
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
501 502 503
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

504
  buf = (char *) alloca (SBYTES (file) + 10);
505 506 507
  file_name_as_directory (buf, SDATA (file));
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (file));
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511
}

/*
 * Convert from directory name to filename.
512
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
513 514 515 516

 * Value is nonzero if the string output is different from the input.
 */

Andreas Schwab's avatar
Andreas Schwab committed
517
int
518
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522
{
  long slen;

  slen = strlen (src);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
523

Jim Blandy's avatar
Jim Blandy committed
524 525 526
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
527
  if (slen > 1
528
      && IS_DIRECTORY_SEP (dst[slen - 1])
529 530 531 532
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
533
    dst[slen - 1] = 0;
534
#ifdef DOS_NT
535
  dostounix_filename (dst);
536
#endif
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
541 542 543 544 545
       1, 1, 0,
       doc: /* Returns the file name of the directory named DIRECTORY.
This is the name of the file that holds the data for the directory DIRECTORY.
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
546
In Unix-syntax, this function just removes the final slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
547
  (Lisp_Object directory)
Jim Blandy's avatar
Jim Blandy committed
548 549
{
  char *buf;
550
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
551

552
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
553

Jim Blandy's avatar
Jim Blandy committed
554
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
555
    return Qnil;
556 557 558

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
559
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
560 561 562
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

563 564
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
565 566
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
567 568
}

569
static const char make_temp_name_tbl[64] =
570 571 572 573 574 575 576 577 578 579
{
  'A','B','C','D','E','F','G','H',
  'I','J','K','L','M','N','O','P',
  'Q','R','S','T','U','V','W','X',
  'Y','Z','a','b','c','d','e','f',
  'g','h','i','j','k','l','m','n',
  'o','p','q','r','s','t','u','v',
  'w','x','y','z','0','1','2','3',
  '4','5','6','7','8','9','-','_'
};
580

581 582
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

583
/* Value is a temporary file name starting with PREFIX, a string.
584

585 586 587 588 589
   The Emacs process number forms part of the result, so there is
   no danger of generating a name being used by another process.
   In addition, this function makes an attempt to choose a name
   which has no existing file.  To make this work, PREFIX should be
   an absolute file name.
590

591 592 593 594 595 596 597 598 599
   BASE64_P non-zero means add the pid as 3 characters in base64
   encoding.  In this case, 6 characters will be added to PREFIX to
   form the file name.  Otherwise, if Emacs is running on a system
   with long file names, add the pid as a decimal number.

   This function signals an error if no unique file name could be
   generated.  */

Lisp_Object
600
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
601 602
{
  Lisp_Object val;
603
  int len, clen;
604 605 606 607
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
608

609
  CHECK_STRING (prefix);
610 611 612 613 614 615 616 617

  /* VAL is created by adding 6 characters to PREFIX.  The first
     three are the PID of this process, in base 64, and the second
     three are incremented if the file already exists.  This ensures
     262144 unique file names per PID per PREFIX.  */

  pid = (int) getpid ();

618 619 620 621 622 623 624 625 626
  if (base64_p)
    {
      pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidlen = 3;
    }
  else
    {
627
#ifdef HAVE_LONG_FILE_NAMES
628 629
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
630
#else
631 632 633 634
      pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidlen = 3;
635
#endif
636
    }
637

638 639 640 641
  len = SBYTES (prefix); clen = SCHARS (prefix);
  val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
  if (!STRING_MULTIBYTE (prefix))
    STRING_SET_UNIBYTE (val);
642
  data = SDATA (val);
643
  memcpy (data, SDATA (prefix), len);
644 645
  p = data + len;

646
  memcpy (p, pidbuf, pidlen);
647 648 649 650 651
  p += pidlen;

  /* Here we try to minimize useless stat'ing when this function is
     invoked many times successively with the same PREFIX.  We achieve
     this by initializing count to a random value, and incrementing it
Richard M. Stallman's avatar
Richard M. Stallman committed
652 653 654 655 656 657
     afterwards.

     We don't want make-temp-name to be called while dumping,
     because then make_temp_name_count_initialized_p would get set
     and then make_temp_name_count would not be set when Emacs starts.  */

658 659 660 661 662 663 664 665 666
  if (!make_temp_name_count_initialized_p)
    {
      make_temp_name_count = (unsigned) time (NULL);
      make_temp_name_count_initialized_p = 1;
    }

  while (1)
    {
      struct stat ignored;
667
      unsigned num = make_temp_name_count;
668 669 670 671 672

      p[0] = make_temp_name_tbl[num & 63], num >>= 6;
      p[1] = make_temp_name_tbl[num & 63], num >>= 6;
      p[2] = make_temp_name_tbl[num & 63], num >>= 6;

673 674 675 676 677
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

678 679 680 681 682 683 684 685 686 687
      if (stat (data, &ignored) < 0)
	{
	  /* We want to return only if errno is ENOENT.  */
	  if (errno == ENOENT)
	    return val;
	  else
	    /* The error here is dubious, but there is little else we
	       can do.  The alternatives are to return nil, which is
	       as bad as (and in many cases worse than) throwing the
	       error, or to ignore the error, which will likely result
688
	       in looping through 225307 stat's, which is not only
689 690
	       dog-slow, but also useless since eventually nil would
	       have to be returned anyway.  */
691
	    report_file_error ("Cannot create temporary name for prefix",
692 693 694 695
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }
Jim Blandy's avatar
Jim Blandy committed
696
}
697

698 699

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
700 701 702 703 704 705 706 707 708 709
       doc: /* Generate temporary file name (string) starting with PREFIX (a string).
The Emacs process number forms part of the result,
so there is no danger of generating a name being used by another process.

In addition, this function makes an attempt to choose a name
which has no existing file.  To make this work,
PREFIX should be an absolute file name.

There is a race condition between calling `make-temp-name' and creating the
file which opens all kinds of security holes.  For that reason, you should
710 711 712 713 714
probably use `make-temp-file' instead, except in three circumstances:

* If you are creating the file in the user's home directory.
* If you are creating a directory rather than an ordinary file.
* If you are taking special precautions as `make-temp-file' does.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
715
  (Lisp_Object prefix)
716 717 718 719 720
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
721 722

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
723 724
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
725
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
726
the current buffer's value of `default-directory' is used.
727 728
NAME should be a string that is a valid file name for the underlying
filesystem.
729 730 731 732
File name components that are `.' are removed, and
so are file name components followed by `..', along with the `..' itself;
note that these simplifications are done without checking the resulting
file names in the file system.
733 734 735
Multiple consecutive slashes are collapsed into a single slash,
except at the beginning of the file name when they are significant (e.g.,
UNC file names on MS-Windows.)
736 737
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
Chong Yidong's avatar
Chong Yidong committed
738 739 740 741 742
See also the function `substitute-in-file-name'.

For technical reasons, this function can return correct but
non-intuitive results for the root directory; for instance,
\(expand-file-name ".." "/") returns "/..".  For this reason, use
743
\(directory-file-name (file-name-directory dirname)) to traverse a
Chong Yidong's avatar
Chong Yidong committed
744
filesystem tree, not (expand-file-name ".."  dirname).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
745
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
746
{
747 748 749 750 751
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
  unsigned char *nm, *newdir;
  /* This should only point to alloca'd data.  */
  unsigned char *target;
752

Jim Blandy's avatar
Jim Blandy committed
753 754
  int tlen;
  struct passwd *pw;
755
#ifdef DOS_NT
756
  int drive = 0;
757
  int collapse_newdir = 1;
758
  int is_escaped = 0;
759
#endif /* DOS_NT */
760
  int length;
761
  Lisp_Object handler, result;
762
  int multibyte;
763
  Lisp_Object hdir;
764

765
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
766

767 768
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
769
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
770
  if (!NILP (handler))
771
    return call3 (handler, Qexpand_file_name, name, default_directory);
772

773 774 775
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
776
  if (! STRINGP (default_directory))
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
    {
#ifdef DOS_NT
      /* "/" is not considered a root directory on DOS_NT, so using "/"
	 here causes an infinite recursion in, e.g., the following:

            (let (default-directory)
	      (expand-file-name "a"))

	 To avoid this, we set default_directory to the root of the
	 current drive.  */
      default_directory = build_string (emacs_root_dir ());
#else
      default_directory = build_string ("/");
#endif
    }
792

793
  if (!NILP (default_directory))
794
    {
795
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
796
      if (!NILP (handler))
797
	return call3 (handler, Qexpand_file_name, name, default_directory);
798
    }
799

800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
  {
    unsigned char *o = SDATA (default_directory);

    /* Make sure DEFAULT_DIRECTORY is properly expanded.
       It would be better to do this down below where we actually use
       default_directory.  Unfortunately, calling Fexpand_file_name recursively
       could invoke GC, and the strings might be relocated.  This would
       be annoying because we have pointers into strings lying around
       that would need adjusting, and people would add new pointers to
       the code and forget to adjust them, resulting in intermittent bugs.
       Putting this call here avoids all that crud.

       The EQ test avoids infinite recursion.  */
    if (! NILP (default_directory) && !EQ (default_directory, name)
	/* Save time in some common cases - as long as default_directory
	   is not relative, it can be canonicalized with name below (if it
	   is needed at all) without requiring it to be expanded now.  */
817
#ifdef DOS_NT
818 819 820
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
821
#ifdef WINDOWSNT
822 823
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
824
#endif
825 826 827
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
828
	&& ! (IS_DIRECTORY_SEP (o[0]))
829
#endif /* not DOS_NT */
830 831 832
	)
      {
	struct gcpro gcpro1;
833

834 835 836 837 838
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
839
  name = FILE_SYSTEM_CASE (name);
840
  multibyte = STRING_MULTIBYTE (name);
841 842 843 844 845 846 847 848 849 850 851
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

852
  /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
853
  nm = (unsigned char *) alloca (SBYTES (name) + 1);
854
  memcpy (nm, SDATA (name), SBYTES (name) + 1);
855

856
#ifdef DOS_NT
857 858 859 860 861 862 863
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

864
  /* Find and remove drive specifier if present; this makes nm absolute
865 866 867 868 869 870 871
     even if the rest of the name appears to be relative.  Only look for
     drive specifier at the beginning.  */
  if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
    {
      drive = nm[0];
      nm += 2;
    }
872 873 874 875 876 877 878

#ifdef WINDOWSNT
  /* If we see "c://somedir", we want to strip the first slash after the
     colon when stripping the drive letter.  Otherwise, this expands to
     "//somedir".  */
  if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    nm++;
879

880 881 882 883 884
  /* Discard any previous drive specifier if nm is now in UNC format. */
  if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    {
      drive = 0;
    }
885 886
#endif /* WINDOWSNT */
#endif /* DOS_NT */
887

888 889 890
  /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
     none are found, we can probably return right away.  We will avoid
     allocating a new string if name is already fully expanded.  */
Jim Blandy's avatar
Jim Blandy committed
891
  if (
892
      IS_DIRECTORY_SEP (nm[0])
893
#ifdef MSDOS
894
      && drive && !is_escaped
895 896
#endif
#ifdef WINDOWSNT
897
      && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
898
#endif
Jim Blandy's avatar
Jim Blandy committed
899 900
      )
    {
901 902 903 904 905 906 907
      /* If it turns out that the filename we want to return is just a
	 suffix of FILENAME, we don't need to go through and edit
	 things; we just need to construct a new string using data
	 starting at the middle of FILENAME.  If we set lose to a
	 non-zero value, that means we've discovered that we can't do
	 that cool trick.  */
      int lose = 0;
908
      unsigned char *p = nm;
909

Jim Blandy's avatar
Jim Blandy committed
910 911
      while (*p)
	{
912
	  /* Since we know the name is absolute, we can assume that each
913 914 915
	     element starts with a "/".  */

	  /* "." and ".." are hairy.  */
916
	  if (IS_DIRECTORY_SEP (p[0])