fileio.c 178 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4
                 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
22
#include <limits.h>
Jim Blandy's avatar
Jim Blandy committed
23

24
#ifdef HAVE_FCNTL_H
25 26 27
#include <fcntl.h>
#endif

28
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
29 30
#include <sys/types.h>
#include <sys/stat.h>
31
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
32

33 34 35 36
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

37 38 39 40
#if !defined (S_ISLNK) && defined (S_IFLNK)
#  define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
#endif

41 42 43 44
#if !defined (S_ISFIFO) && defined (S_IFIFO)
#  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
#endif

45 46 47 48
#if !defined (S_ISREG) && defined (S_IFREG)
#  define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
#endif

49
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
50
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
51 52
#endif

Jim Blandy's avatar
Jim Blandy committed
53 54 55
#include <ctype.h>
#include <errno.h>

Karel Klíc's avatar
Karel Klíc committed
56 57 58 59 60
#ifdef HAVE_LIBSELINUX
#include <selinux/selinux.h>
#include <selinux/context.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
61
#include "lisp.h"
62
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
63
#include "buffer.h"
64
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
65
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
66
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
67
#include "blockinput.h"
Karoly Lorentey's avatar
Karoly Lorentey committed
68 69
#include "frame.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
70

71 72 73 74 75 76 77
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
78 79 80 81 82 83 84
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#include <fcntl.h>
#include <string.h>
#endif

85 86 87 88 89 90 91 92 93
#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
94 95 96 97
/* 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))
98 99
#endif

Jim Blandy's avatar
Jim Blandy committed
100
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
101 102 103

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

106 107
#include "commands.h"

Jim Blandy's avatar
Jim Blandy committed
108 109 110 111
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
112 113 114 115
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

116 117 118 119
#ifndef S_ISLNK
#  define lstat stat
#endif

120 121 122 123
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129 130
/* 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;

131 132 133
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

134 135 136 137 138 139 140
/* 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;

141 142 143
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

144 145 146 147
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

148
/* Alist of elements (REGEXP . HANDLER) for file names
149 150 151
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

152 153 154 155
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

156 157 158
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

159
/* Function to be called to decide a coding system of a reading file.  */
160
Lisp_Object Vset_auto_coding_function;
161

162 163 164
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

165
/* Lisp function for setting buffer-file-coding-system and the
166
   multibyteness of the current buffer after inserting a file.  */
167
Lisp_Object Qafter_insert_file_set_coding;
168

169 170
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
171
Lisp_Object Qwrite_region_annotate_functions;
172
Lisp_Object Vwrite_region_post_annotation_function;
173

174 175 176 177
/* During build_annotations, each time an annotation function is called,
   this holds the annotations made by the previous functions.  */
Lisp_Object Vwrite_region_annotations_so_far;

178 179 180 181
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
Lisp_Object Vwrite_region_annotation_buffers;

182 183 184
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

185 186 187
/* Whether or not files are auto-saved into themselves.  */
Lisp_Object Vauto_save_visited_file_name;

188 189 190
/* Whether or not to continue auto-saving after a large deletion.  */
Lisp_Object Vauto_save_include_big_deletions;

191 192 193 194
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

195 196 197 198 199
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

200
/* Non-zero means call move-file-to-trash in Fdelete_file or
201
   Fdelete_directory_internal.  */
202 203
int delete_by_moving_to_trash;

204 205
Lisp_Object Qdelete_by_moving_to_trash;

206 207 208
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

209 210 211 212 213 214
/* Lisp function for recursively copying directories.  */
Lisp_Object Qcopy_directory;

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

215 216 217 218
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

219 220 221 222 223 224 225
/* These variables describe handlers that have "already" had a chance
   to handle the current operation.

   Vinhibit_file_name_handlers is a list of file name handlers.
   Vinhibit_file_name_operation is the operation being handled.
   If we try to handle that operation, we ignore those handlers.  */

226
static Lisp_Object Vinhibit_file_name_handlers;
227
static Lisp_Object Vinhibit_file_name_operation;
228

229
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
230
Lisp_Object Qexcl;
231 232
Lisp_Object Qfile_name_history;

233 234
Lisp_Object Qcar_less_than_car;

235 236 237
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 *);
238

239

240
void
241
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
242 243
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
244
  int errorno = errno;
245
  char *str;
Jim Blandy's avatar
Jim Blandy committed
246

247
  synchronize_system_messages_locale ();
248 249 250
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
251 252
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
253
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
254 255 256
    switch (errorno)
      {
      case EEXIST:
257
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
258 259 260
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
261 262
	   unless it is followed by a slash.  (The slash case caters to
	   error messages that begin with "I/O" or, in German, "E/A".)  */
263 264
	if (STRING_MULTIBYTE (errstring)
	    && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
265 266 267 268
	  {
	    int c;

	    str = (char *) SDATA (errstring);
269
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
270
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
271
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
272

273
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
276
}
277

278
Lisp_Object
279
close_file_unwind (Lisp_Object fd)
280
{
281
  emacs_close (XFASTINT (fd));
282
  return Qnil;
283
}
284 285 286

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

Andreas Schwab's avatar
Andreas Schwab committed
287
Lisp_Object
288
restore_point_unwind (Lisp_Object location)
289
{
290
  Fgoto_char (location);
291
  Fset_marker (location, Qnil, Qnil);
292
  return Qnil;
293
}
294

Jim Blandy's avatar
Jim Blandy committed
295

296
Lisp_Object Qexpand_file_name;
297
Lisp_Object Qsubstitute_in_file_name;
298 299 300
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
301
Lisp_Object Qunhandled_file_name_directory;
302
Lisp_Object Qfile_name_as_directory;
303
Lisp_Object Qcopy_file;
304
Lisp_Object Qmake_directory_internal;
305
Lisp_Object Qmake_directory;
306
Lisp_Object Qdelete_directory_internal;
307 308 309 310 311 312 313 314
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;
315 316
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
317
Lisp_Object Qfile_directory_p;
318
Lisp_Object Qfile_regular_p;
319 320 321
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
322
Lisp_Object Qset_file_times;
Karel Klíc's avatar
Karel Klíc committed
323 324
Lisp_Object Qfile_selinux_context;
Lisp_Object Qset_file_selinux_context;
325 326 327 328
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
329
Lisp_Object Qset_visited_file_modtime;
330

331
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
332 333 334 335 336 337 338 339 340
       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
341
  (Lisp_Object filename, Lisp_Object operation)
342
{
343
  /* This function must not munge the match data.  */
344
  Lisp_Object chain, inhibited_handlers, result;
345
  int pos = -1;
346

347
  result = Qnil;
348
  CHECK_STRING (filename);
349

350 351 352 353
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
354

355
  for (chain = Vfile_name_handler_alist; CONSP (chain);
356
       chain = XCDR (chain))
357 358
    {
      Lisp_Object elt;
359
      elt = XCAR (chain);
360
      if (CONSP (elt))
361
	{
362
	  Lisp_Object string = XCAR (elt);
363
	  int match_pos;
364
	  Lisp_Object handler = XCDR (elt);
365 366 367 368
	  Lisp_Object operations = Qnil;

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

370
	  if (STRINGP (string)
371 372
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
373
	    {
374
	      Lisp_Object tem;
375

376
	      handler = XCDR (elt);
377 378
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
379 380 381 382
		{
		  result = handler;
		  pos = match_pos;
		}
383
	    }
384
	}
385 386

      QUIT;
387
    }
388
  return result;
389 390
}

Jim Blandy's avatar
Jim Blandy committed
391
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
392 393 394
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
395
Otherwise return a directory name.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
396
Given a Unix syntax file name, returns a string ending in slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
397
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
398
{
399
#ifndef DOS_NT
400
  register const unsigned char *beg;
401 402 403
#else
  register unsigned char *beg;
#endif
404
  register const unsigned char *p;
405
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
406

407
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
408

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

415
  filename = FILE_SYSTEM_CASE (filename);
416
#ifdef DOS_NT
417
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
418
  memcpy (beg, SDATA (filename), SBYTES (filename) + 1);
419 420
#else
  beg = SDATA (filename);
421
#endif
422
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
423

424 425
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
426 427 428 429 430
	 /* 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))))
431
#endif
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435
	 ) p--;

  if (p == beg)
    return Qnil;
436
#ifdef DOS_NT
437
  /* Expansion of "c:" to drive and default directory.  */
438
  if (p[-1] == ':')
439 440
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
441
      unsigned char *res = alloca (MAXPATHLEN + 1);
442 443 444 445 446 447 448 449 450 451
      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))
452
	{
453
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
454 455 456 457 458
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
459
  dostounix_filename (beg);
460
#endif /* DOS_NT */
461

462
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
463 464
}

465 466
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
467 468 469 470
       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
471
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
472
{
473
  register const unsigned char *beg, *p, *end;
474
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
475

476
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
477

478 479
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
480
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
481
  if (!NILP (handler))
482
    return call2 (handler, Qfile_name_nondirectory, filename);
483

484 485
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
486

487 488 489
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
490 491 492
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
493
#endif
494 495
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
496

497
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
498
}
499

500 501
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
502 503 504 505 506
       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
507 508
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
509 510
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
511
  (Lisp_Object filename)
512 513 514 515 516
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
517
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
518 519 520 521 522 523
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
524 525

char *
526
file_name_as_directory (char *out, char *in)
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530 531
{
  int size = strlen (in) - 1;

  strcpy (out, in);

532 533
  if (size < 0)
    {
534 535 536
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
537 538 539
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
540
  /* For Unix syntax, Append a slash if necessary */
541
  if (!IS_DIRECTORY_SEP (out[size]))
542
    {
543
      out[size + 1] = DIRECTORY_SEP;
544 545
      out[size + 2] = '\0';
    }
546
#ifdef DOS_NT
547
  dostounix_filename (out);
548
#endif
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
554
       doc: /* Return a string representing the file name FILE interpreted as a directory.
555 556 557 558
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
559
For a Unix-syntax file name, just appends a slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
560
  (Lisp_Object file)
Jim Blandy's avatar
Jim Blandy committed
561 562
{
  char *buf;
563
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
564

565
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
566
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
567
    return Qnil;
568 569 570

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
571
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
572 573 574
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

575
  buf = (char *) alloca (SBYTES (file) + 10);
576 577 578
  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
579 580 581 582
}

/*
 * Convert from directory name to filename.
583
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587

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

Andreas Schwab's avatar
Andreas Schwab committed
588
int
589
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
590 591 592 593
{
  long slen;

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

Jim Blandy's avatar
Jim Blandy committed
595 596 597
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
598
  if (slen > 1
599
      && IS_DIRECTORY_SEP (dst[slen - 1])
600 601 602 603
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
604
    dst[slen - 1] = 0;
605
#ifdef DOS_NT
606
  dostounix_filename (dst);
607
#endif
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
612 613 614 615 616
       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
617
In Unix-syntax, this function just removes the final slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
618
  (Lisp_Object directory)
Jim Blandy's avatar
Jim Blandy committed
619 620
{
  char *buf;
621
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
622

623
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
624

Jim Blandy's avatar
Jim Blandy committed
625
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
626
    return Qnil;
627 628 629

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
630
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
631 632 633
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

634 635
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
636 637
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
638 639
}

640
static const char make_temp_name_tbl[64] =
641 642 643 644 645 646 647 648 649 650
{
  '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','-','_'
};
651

652 653
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

654
/* Value is a temporary file name starting with PREFIX, a string.
655

656 657 658 659 660
   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.
661

662 663 664 665 666 667 668 669 670
   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
671
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
672 673
{
  Lisp_Object val;
674
  int len, clen;
675 676 677 678
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
679

680
  CHECK_STRING (prefix);
681 682 683 684 685 686 687 688

  /* 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 ();

689 690 691 692 693 694 695 696 697
  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
    {
698
#ifdef HAVE_LONG_FILE_NAMES
699 700
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
701
#else
702 703 704 705
      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;
706
#endif
707
    }
708

709 710 711 712
  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);
713
  data = SDATA (val);
714
  memcpy (data, SDATA (prefix), len);
715 716
  p = data + len;

717
  memcpy (p, pidbuf, pidlen);
718 719 720 721 722
  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
723 724 725 726 727 728
     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.  */

729 730 731 732 733 734 735 736 737
  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;
738
      unsigned num = make_temp_name_count;
739 740 741 742 743

      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;

744 745 746 747 748
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

749 750 751 752 753 754 755 756 757 758
      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
759 760 761
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
762
	    report_file_error ("Cannot create temporary name for prefix",
763 764 765 766 767 768
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
769
	 SDATA (prefix));
770
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
771
}
772

773 774

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
775 776 777 778 779 780 781 782 783 784
       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
785 786 787 788 789
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
790
  (Lisp_Object prefix)
791 792 793 794 795
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
796 797

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
798 799
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
800
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
801
the current buffer's value of `default-directory' is used.
802 803 804 805 806 807
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.
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
Chong Yidong's avatar
Chong Yidong committed
808 809 810 811 812 813 814
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
(directory-file-name (file-name-directory dirname)) to traverse a
filesystem tree, not (expand-file-name ".."  dirname).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
815
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
816
{
817 818 819 820 821
  /* 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;
822

Jim Blandy's avatar
Jim Blandy committed
823 824
  int tlen;
  struct passwd *pw;
825
#ifdef DOS_NT
826
  int drive = 0;
827
  int collapse_newdir = 1;
828
  int is_escaped = 0;
829
#endif /* DOS_NT */
830
  int length;
831
  Lisp_Object handler, result;
832
  int multibyte;
833
  Lisp_Object hdir;
834

835
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
836

837 838
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
839
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
840
  if (!NILP (handler))
841
    return call3 (handler, Qexpand_file_name, name, default_directory);
842

843 844 845
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
846
  if (! STRINGP (default_directory))
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
    {
#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.  */