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, 2011 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>
23
#include <fcntl.h>
24
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
25 26
#include <sys/types.h>
#include <sys/stat.h>
27
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
28

29 30 31 32
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
49 50 51
#include <ctype.h>
#include <errno.h>

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

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

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

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

79 80 81 82 83 84 85 86 87
#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
88 89 90 91
/* 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))
92 93
#endif

Jim Blandy's avatar
Jim Blandy committed
94
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
95 96 97

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

100 101
#include "commands.h"

102 103 104 105
#ifndef S_ISLNK
#  define lstat stat
#endif

106 107 108 109
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
110 111 112 113 114 115 116
/* 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;

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

120 121 122 123 124 125 126
/* 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;

127 128 129
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

130 131 132 133
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

134
/* Alist of elements (REGEXP . HANDLER) for file names
135 136 137
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

138 139 140 141
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

142 143 144
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

145
/* Function to be called to decide a coding system of a reading file.  */
146
Lisp_Object Vset_auto_coding_function;
147

148 149 150
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

151
/* Lisp function for setting buffer-file-coding-system and the
152
   multibyteness of the current buffer after inserting a file.  */
153
Lisp_Object Qafter_insert_file_set_coding;
154

155 156
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
157
Lisp_Object Qwrite_region_annotate_functions;
158
Lisp_Object Vwrite_region_post_annotation_function;
159

160 161 162 163
/* 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;

164 165 166 167
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
Lisp_Object Vwrite_region_annotation_buffers;

168 169 170
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

171 172 173
/* Whether or not files are auto-saved into themselves.  */
Lisp_Object Vauto_save_visited_file_name;

174 175 176
/* Whether or not to continue auto-saving after a large deletion.  */
Lisp_Object Vauto_save_include_big_deletions;

177 178 179 180 181
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

182
/* Non-zero means call move-file-to-trash in Fdelete_file or
183
   Fdelete_directory_internal.  */
184 185
int delete_by_moving_to_trash;

186 187
Lisp_Object Qdelete_by_moving_to_trash;

188 189 190
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

191 192 193 194 195 196
/* Lisp function for recursively copying directories.  */
Lisp_Object Qcopy_directory;

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

197 198 199 200
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

201 202 203 204 205 206 207
/* 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.  */

208
static Lisp_Object Vinhibit_file_name_handlers;
209
static Lisp_Object Vinhibit_file_name_operation;
210

211
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
212
Lisp_Object Qexcl;
213 214
Lisp_Object Qfile_name_history;

215 216
Lisp_Object Qcar_less_than_car;

217 218 219
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 *);
220

221

222
void
223
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
224 225
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
226
  int errorno = errno;
227
  char *str;
Jim Blandy's avatar
Jim Blandy committed
228

229
  synchronize_system_messages_locale ();
230 231 232
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
233 234
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
235
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
236 237 238
    switch (errorno)
      {
      case EEXIST:
239
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
240 241 242
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
243 244
	   unless it is followed by a slash.  (The slash case caters to
	   error messages that begin with "I/O" or, in German, "E/A".)  */
245 246
	if (STRING_MULTIBYTE (errstring)
	    && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
247 248 249 250
	  {
	    int c;

	    str = (char *) SDATA (errstring);
251
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
252
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
253
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
254

255
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
256 257
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
258
}
259

260
Lisp_Object
261
close_file_unwind (Lisp_Object fd)
262
{
263
  emacs_close (XFASTINT (fd));
264
  return Qnil;
265
}
266 267 268

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

Andreas Schwab's avatar
Andreas Schwab committed
269
Lisp_Object
270
restore_point_unwind (Lisp_Object location)
271
{
272
  Fgoto_char (location);
273
  Fset_marker (location, Qnil, Qnil);
274
  return Qnil;
275
}
276

Jim Blandy's avatar
Jim Blandy committed
277

278
Lisp_Object Qexpand_file_name;
279
Lisp_Object Qsubstitute_in_file_name;
280 281 282
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
283
Lisp_Object Qunhandled_file_name_directory;
284
Lisp_Object Qfile_name_as_directory;
285
Lisp_Object Qcopy_file;
286
Lisp_Object Qmake_directory_internal;
287
Lisp_Object Qmake_directory;
288
Lisp_Object Qdelete_directory_internal;
289 290 291 292 293 294 295 296
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;
297 298
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
299
Lisp_Object Qfile_directory_p;
300
Lisp_Object Qfile_regular_p;
301 302 303
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
304
Lisp_Object Qset_file_times;
Karel Klíc's avatar
Karel Klíc committed
305 306
Lisp_Object Qfile_selinux_context;
Lisp_Object Qset_file_selinux_context;
307 308 309 310
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
311
Lisp_Object Qset_visited_file_modtime;
312

313
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
314 315 316 317 318 319 320 321 322
       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
323
  (Lisp_Object filename, Lisp_Object operation)
324
{
325
  /* This function must not munge the match data.  */
326
  Lisp_Object chain, inhibited_handlers, result;
327
  int pos = -1;
328

329
  result = Qnil;
330
  CHECK_STRING (filename);
331

332 333 334 335
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
336

337
  for (chain = Vfile_name_handler_alist; CONSP (chain);
338
       chain = XCDR (chain))
339 340
    {
      Lisp_Object elt;
341
      elt = XCAR (chain);
342
      if (CONSP (elt))
343
	{
344
	  Lisp_Object string = XCAR (elt);
345
	  int match_pos;
346
	  Lisp_Object handler = XCDR (elt);
347 348 349 350
	  Lisp_Object operations = Qnil;

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

352
	  if (STRINGP (string)
353 354
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
355
	    {
356
	      Lisp_Object tem;
357

358
	      handler = XCDR (elt);
359 360
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
361 362 363 364
		{
		  result = handler;
		  pos = match_pos;
		}
365
	    }
366
	}
367 368

      QUIT;
369
    }
370
  return result;
371 372
}

Jim Blandy's avatar
Jim Blandy committed
373
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
374 375 376
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
377
Otherwise return a directory name.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
378
Given a Unix syntax file name, returns a string ending in slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
379
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
380
{
381
#ifndef DOS_NT
382
  register const unsigned char *beg;
383 384 385
#else
  register unsigned char *beg;
#endif
386
  register const unsigned char *p;
387
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
388

389
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
390

391 392
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
393
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
394
  if (!NILP (handler))
395
    return call2 (handler, Qfile_name_directory, filename);
396

397
  filename = FILE_SYSTEM_CASE (filename);
398
#ifdef DOS_NT
399
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
400
  memcpy (beg, SDATA (filename), SBYTES (filename) + 1);
401 402
#else
  beg = SDATA (filename);
403
#endif
404
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
405

406 407
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
408 409 410 411 412
	 /* 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))))
413
#endif
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417
	 ) p--;

  if (p == beg)
    return Qnil;
418
#ifdef DOS_NT
419
  /* Expansion of "c:" to drive and default directory.  */
420
  if (p[-1] == ':')
421 422
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
423
      unsigned char *res = alloca (MAXPATHLEN + 1);
424 425 426 427 428 429 430 431 432 433
      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))
434
	{
435
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
436 437 438 439 440
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
441
  dostounix_filename (beg);
442
#endif /* DOS_NT */
443

444
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
445 446
}

447 448
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
449 450 451 452
       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
453
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
454
{
455
  register const unsigned char *beg, *p, *end;
456
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
457

458
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
459

460 461
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
462
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
463
  if (!NILP (handler))
464
    return call2 (handler, Qfile_name_nondirectory, filename);
465

466 467
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
468

469 470 471
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
472 473 474
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
475
#endif
476 477
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
478

479
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
480
}
481

482 483
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
484 485 486 487 488
       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
489 490
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
491 492
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
493
  (Lisp_Object filename)
494 495 496 497 498
{
  Lisp_Object handler;

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

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
506 507

char *
508
file_name_as_directory (char *out, char *in)
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513
{
  int size = strlen (in) - 1;

  strcpy (out, in);

514 515
  if (size < 0)
    {
516 517 518
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
519 520 521
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
522
  /* For Unix syntax, Append a slash if necessary */
523
  if (!IS_DIRECTORY_SEP (out[size]))
524
    {
525
      out[size + 1] = DIRECTORY_SEP;
526 527
      out[size + 2] = '\0';
    }
528
#ifdef DOS_NT
529
  dostounix_filename (out);
530
#endif
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534 535
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
536
       doc: /* Return a string representing the file name FILE interpreted as a directory.
537 538 539 540
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
541
For a Unix-syntax file name, just appends a slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
542
  (Lisp_Object file)
Jim Blandy's avatar
Jim Blandy committed
543 544
{
  char *buf;
545
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
546

547
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
548
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
549
    return Qnil;
550 551 552

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
553
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
554 555 556
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

557
  buf = (char *) alloca (SBYTES (file) + 10);
558 559 560
  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
561 562 563 564
}

/*
 * Convert from directory name to filename.
565
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569

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

Andreas Schwab's avatar
Andreas Schwab committed
570
int
571
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
572 573 574 575
{
  long slen;

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

Jim Blandy's avatar
Jim Blandy committed
577 578 579
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
580
  if (slen > 1
581
      && IS_DIRECTORY_SEP (dst[slen - 1])
582 583 584 585
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
586
    dst[slen - 1] = 0;
587
#ifdef DOS_NT
588
  dostounix_filename (dst);
589
#endif
Jim Blandy's avatar
Jim Blandy committed
590 591 592 593
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
594 595 596 597 598
       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
599
In Unix-syntax, this function just removes the final slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
600
  (Lisp_Object directory)
Jim Blandy's avatar
Jim Blandy committed
601 602
{
  char *buf;
603
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
604

605
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
606

Jim Blandy's avatar
Jim Blandy committed
607
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
608
    return Qnil;
609 610 611

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
612
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
613 614 615
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

616 617
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
618 619
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
620 621
}

622
static const char make_temp_name_tbl[64] =
623 624 625 626 627 628 629 630 631 632
{
  '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','-','_'
};
633

634 635
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

636
/* Value is a temporary file name starting with PREFIX, a string.
637

638 639 640 641 642
   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.
643

644 645 646 647 648 649 650 651 652
   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
653
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
654 655
{
  Lisp_Object val;
656
  int len, clen;
657 658 659 660
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
661

662
  CHECK_STRING (prefix);
663 664 665 666 667 668 669 670

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

671 672 673 674 675 676 677 678 679
  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
    {
680
#ifdef HAVE_LONG_FILE_NAMES
681 682
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
683
#else
684 685 686 687
      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;
688
#endif
689
    }
690

691 692 693 694
  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);
695
  data = SDATA (val);
696
  memcpy (data, SDATA (prefix), len);
697 698
  p = data + len;

699
  memcpy (p, pidbuf, pidlen);
700 701 702 703 704
  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
705 706 707 708 709 710
     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.  */

711 712 713 714 715 716 717 718 719
  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;
720
      unsigned num = make_temp_name_count;
721 722 723 724 725

      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;

726 727 728 729 730
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

731 732 733 734 735 736 737 738 739 740
      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
741 742 743
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
744
	    report_file_error ("Cannot create temporary name for prefix",
745 746 747 748 749 750
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
751
	 SDATA (prefix));
752
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
753
}
754

755 756

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
757 758 759 760 761 762 763 764 765 766
       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
767 768 769 770 771
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
772
  (Lisp_Object prefix)
773 774 775 776 777
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
778 779

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
780 781
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
782
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
783
the current buffer's value of `default-directory' is used.
784 785
NAME should be a string that is a valid file name for the underlying
filesystem.
786 787 788 789
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.
790 791 792
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.)
793 794
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
Chong Yidong's avatar
Chong Yidong committed
795 796 797 798 799
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
800
\(directory-file-name (file-name-directory dirname)) to traverse a
Chong Yidong's avatar
Chong Yidong committed
801
filesystem tree, not (expand-file-name ".."  dirname).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
802
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
803
{
804 805 806 807 808
  /* 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;
809

Jim Blandy's avatar
Jim Blandy committed
810 811
  int tlen;
  struct passwd *pw;
812
#ifdef DOS_NT
813
  int drive = 0;
814
  int collapse_newdir = 1;
815
  int is_escaped = 0;
816
#endif /* DOS_NT */
817
  int length;
818
  Lisp_Object handler, result;
819
  int multibyte;
820
  Lisp_Object hdir;
821

822
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
823

824 825
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
826
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
827
  if (!NILP (handler))
828
    return call3 (handler, Qexpand_file_name, name, default_directory);
829

830 831 832
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
833
  if (! STRINGP (default_directory))
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
    {
#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
    }
849

850
  if (!NILP (default_directory))
851
    {
852
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
853
      if (!NILP (handler))
854
	return call3 (handler, Qexpand_file_name, name, default_directory);
855
    }
856

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
  {
    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.  */
874
#ifdef DOS_NT
875 876 877
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
878
#ifdef WINDOWSNT
879 880
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
881
#endif
882 883 884
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
885
	&& ! (IS_DIRECTORY_SEP (o[0]))
886
#endif /* not DOS_NT */
887 888 889
	)
      {
	struct gcpro gcpro1;
890

891 892 893 894 895
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
896
  name = FILE_SYSTEM_CASE (name);
897
  multibyte = STRING_MULTIBYTE (name);
898 899 900 901 902 903 904 905 906 907 908
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

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

913
#ifdef DOS_NT
914 915 916 917 918 919 920
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

921
  /* Find and remove drive specifier if present; this makes nm absolute
922 923 924 925 926 927 928
     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;
    }
929 930 931 932 933 934 935

#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++;
936

937 938 939 940 941
  /* 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;
    }
942 943
#endif /* WINDOWSNT */
#endif /* DOS_NT */
944

945 946 947
  /* 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
948
  if (
949
      IS_DIRECTORY_SEP (nm[0])
950
#ifdef MSDOS
951
      && drive && !is_escaped
952 953
#endif
#ifdef WINDOWSNT
954
      && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
955
#endif
Jim Blandy's avatar
Jim Blandy committed
956 957
      )
    {
958 959 960 961 962 963 964
      /* 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;
965
      unsigned char *p = nm;
966

Jim Blandy's avatar
Jim Blandy committed
967 968
      while (*p)
	{
969
	  /* Since we know the name is absolute, we can assume that each
970 971 972
	     element starts with a "/".  */

	  /* "." and ".." are hairy.  */
973
	  if (IS_DIRECTORY_SEP (p[0])
974
	      && p[1] == '.'
975
	      && (IS_DIRECTORY_SEP (p[2])
976
		  || p[2] == 0
977
		  || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
978
				      || p[3] == 0))))
Jim Blandy's avatar
Jim Blandy committed
979
	    lose = 1;
980 981 982 983 984 985
	  /* We want to replace multiple `/' in a row with a single
	     slash.  */
	  else if (p > nm
		   && IS_DIRECTORY_SEP (p[0])
		   && IS_DIRECTORY_SEP (p[1]))
	    lose = 1;
Jim Blandy's avatar
Jim Blandy committed
986 987 988 989
	  p++;
	}
      if (!lose)
	{
990
#ifdef DOS_NT
991 992 993
	  /* Make sure directories are all separated with /, but
	     avoid allocation of a new string when not required. */
	  dostounix_filename (nm);