fileio.c 179 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"
extern int use_dialog_box;
Kenichi Handa's avatar
Kenichi Handa committed
108
extern int use_file_dialog;
109

Jim Blandy's avatar
Jim Blandy committed
110 111 112 113
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

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

118 119 120 121
#ifndef S_ISLNK
#  define lstat stat
#endif

122 123 124 125
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

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

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

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

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

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

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

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

158 159 160
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

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

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

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

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

176 177 178 179
/* 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;

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

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

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

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

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

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

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

206 207
Lisp_Object Qdelete_by_moving_to_trash;

208 209 210
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

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

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

217 218
extern Lisp_Object Vuser_login_name;

219 220 221 222
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

223 224
extern int minibuf_level;

225 226
extern int minibuffer_auto_raise;

227 228 229 230 231 232 233
/* 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.  */

234
static Lisp_Object Vinhibit_file_name_handlers;
235
static Lisp_Object Vinhibit_file_name_operation;
236

237
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
238
Lisp_Object Qexcl;
239 240
Lisp_Object Qfile_name_history;

241 242
Lisp_Object Qcar_less_than_car;

243 244 245
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 *);
246

247

248
void
249
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
250 251
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
252
  int errorno = errno;
253
  char *str;
Jim Blandy's avatar
Jim Blandy committed
254

255
  synchronize_system_messages_locale ();
256 257 258
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
259 260
					    Vlocale_coding_system, 0);

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

	    str = (char *) SDATA (errstring);
277
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
278
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
279
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
280

281
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
282 283
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
284
}
285

286
Lisp_Object
287
close_file_unwind (Lisp_Object fd)
288
{
289
  emacs_close (XFASTINT (fd));
290
  return Qnil;
291
}
292 293 294

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

Andreas Schwab's avatar
Andreas Schwab committed
295
Lisp_Object
296
restore_point_unwind (Lisp_Object location)
297
{
298
  Fgoto_char (location);
299
  Fset_marker (location, Qnil, Qnil);
300
  return Qnil;
301
}
302

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

339
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
340 341 342 343 344 345 346 347 348 349 350
       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.  */)
     (filename, operation)
     Lisp_Object filename, operation;
351
{
352
  /* This function must not munge the match data.  */
353
  Lisp_Object chain, inhibited_handlers, result;
354
  int pos = -1;
355

356
  result = Qnil;
357
  CHECK_STRING (filename);
358

359 360 361 362
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
363

364
  for (chain = Vfile_name_handler_alist; CONSP (chain);
365
       chain = XCDR (chain))
366 367
    {
      Lisp_Object elt;
368
      elt = XCAR (chain);
369
      if (CONSP (elt))
370
	{
371
	  Lisp_Object string = XCAR (elt);
372
	  int match_pos;
373
	  Lisp_Object handler = XCDR (elt);
374 375 376 377
	  Lisp_Object operations = Qnil;

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

379
	  if (STRINGP (string)
380 381
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
382
	    {
383
	      Lisp_Object tem;
384

385
	      handler = XCDR (elt);
386 387
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
388 389 390 391
		{
		  result = handler;
		  pos = match_pos;
		}
392
	    }
393
	}
394 395

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

417
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
418

419 420
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
421
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
422
  if (!NILP (handler))
423
    return call2 (handler, Qfile_name_directory, filename);
424

425
  filename = FILE_SYSTEM_CASE (filename);
426
#ifdef DOS_NT
427 428 429 430
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
  bcopy (SDATA (filename), beg, SBYTES (filename) + 1);
#else
  beg = SDATA (filename);
431
#endif
432
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
433

434 435
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
436 437 438 439 440
	 /* 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))))
441
#endif
Jim Blandy's avatar
Jim Blandy committed
442 443 444 445
	 ) p--;

  if (p == beg)
    return Qnil;
446
#ifdef DOS_NT
447
  /* Expansion of "c:" to drive and default directory.  */
448
  if (p[-1] == ':')
449 450
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
451
      unsigned char *res = alloca (MAXPATHLEN + 1);
452 453 454 455 456 457 458 459 460 461
      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))
462
	{
463
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
464 465 466 467 468
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
469
  dostounix_filename (beg);
470
#endif /* DOS_NT */
471

472
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
473 474
}

475 476
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
477 478 479 480 481
       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.  */)
     (filename)
482
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
483
{
484
  register const unsigned char *beg, *p, *end;
485
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
486

487
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
488

489 490
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
491
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
492
  if (!NILP (handler))
493
    return call2 (handler, Qfile_name_nondirectory, filename);
494

495 496
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
497

498 499 500
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
501 502 503
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
504
#endif
505 506
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
507

508
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
509
}
510

511 512
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
513 514 515 516 517
       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
518 519
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
520 521 522 523
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
     (filename)
     Lisp_Object filename;
524 525 526 527 528
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
529
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
530 531 532 533 534 535
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
536 537

char *
538
file_name_as_directory (char *out, char *in)
Jim Blandy's avatar
Jim Blandy committed
539 540 541 542 543
{
  int size = strlen (in) - 1;

  strcpy (out, in);

544 545
  if (size < 0)
    {
546 547 548
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
549 550 551
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
552
  /* For Unix syntax, Append a slash if necessary */
553
  if (!IS_DIRECTORY_SEP (out[size]))
554
    {
555
      out[size + 1] = DIRECTORY_SEP;
556 557
      out[size + 2] = '\0';
    }
558
#ifdef DOS_NT
559
  dostounix_filename (out);
560
#endif
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564 565
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
566
       doc: /* Return a string representing the file name FILE interpreted as a directory.
567 568 569 570
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
571
For a Unix-syntax file name, just appends a slash.  */)
572
     (file)
Jim Blandy's avatar
Jim Blandy committed
573 574 575
     Lisp_Object file;
{
  char *buf;
576
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
577

578
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
579
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
580
    return Qnil;
581 582 583

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
584
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
585 586 587
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

588
  buf = (char *) alloca (SBYTES (file) + 10);
589 590 591
  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
592 593 594 595
}

/*
 * Convert from directory name to filename.
596
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600

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

Andreas Schwab's avatar
Andreas Schwab committed
601
int
602
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606
{
  long slen;

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

Jim Blandy's avatar
Jim Blandy committed
608 609 610
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
611
  if (slen > 1
612
      && IS_DIRECTORY_SEP (dst[slen - 1])
613 614 615 616
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
617
    dst[slen - 1] = 0;
618
#ifdef DOS_NT
619
  dostounix_filename (dst);
620
#endif
Jim Blandy's avatar
Jim Blandy committed
621 622 623 624
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
625 626 627 628 629
       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
630
In Unix-syntax, this function just removes the final slash.  */)
631
     (directory)
Jim Blandy's avatar
Jim Blandy committed
632 633 634
     Lisp_Object directory;
{
  char *buf;
635
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
636

637
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
638

Jim Blandy's avatar
Jim Blandy committed
639
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
640
    return Qnil;
641 642 643

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
644
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
645 646 647
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

648 649
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
650 651
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
652 653
}

654
static const char make_temp_name_tbl[64] =
655 656 657 658 659 660 661 662 663 664
{
  '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','-','_'
};
665

666 667
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

668
/* Value is a temporary file name starting with PREFIX, a string.
669

670 671 672 673 674
   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.
675

676 677 678 679 680 681 682 683 684
   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
685
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
686 687
{
  Lisp_Object val;
688
  int len, clen;
689 690 691 692
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
693

694
  CHECK_STRING (prefix);
695 696 697 698 699 700 701 702

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

703 704 705 706 707 708 709 710 711
  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
    {
712
#ifdef HAVE_LONG_FILE_NAMES
713 714
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
715
#else
716 717 718 719
      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;
720
#endif
721
    }
722

723 724 725 726
  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);
727 728
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
729 730 731 732 733 734 735 736
  p = data + len;

  bcopy (pidbuf, p, pidlen);
  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
737 738 739 740 741 742
     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.  */

743 744 745 746 747 748 749 750 751
  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;
752
      unsigned num = make_temp_name_count;
753 754 755 756 757

      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;

758 759 760 761 762
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

763 764 765 766 767 768 769 770 771 772
      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
773 774 775
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
776
	    report_file_error ("Cannot create temporary name for prefix",
777 778 779 780 781 782
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
783
	 SDATA (prefix));
784
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
785
}
786

787 788

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
789 790 791 792 793 794 795 796 797 798
       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
799 800 801 802 803
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.  */)
804
     (prefix)
805 806 807 808 809 810
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
811 812

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
813 814
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
815
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
816
the current buffer's value of `default-directory' is used.
817 818 819 820 821 822
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
823 824 825 826 827 828 829
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).  */)
830
     (name, default_directory)
831
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
832
{
833 834 835 836 837
  /* 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;
838

Jim Blandy's avatar
Jim Blandy committed
839 840
  int tlen;
  struct passwd *pw;
841
#ifdef DOS_NT
842
  int drive = 0;
843
  int collapse_newdir = 1;
844
  int is_escaped = 0;
845
#endif /* DOS_NT */
846
  int length;
847
  Lisp_Object handler, result;
848
  int multibyte;
849
  Lisp_Object hdir;
850

851
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
852

853 854
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
855
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
856
  if (!NILP (handler))
857
    return call3 (handler, Qexpand_file_name, name, default_directory);
858

859 860 861
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
862
  if (! STRINGP (default_directory))
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
    {
#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.  */
      extern char *emacs_root_dir (void);

      default_directory = build_string (emacs_root_dir ());
#else
      default_directory = build_string ("/");
#endif
    }
880

881
  if (!NILP (default_directory))
882
    {
883
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
884
      if (!NILP (handler))
885
	return call3 (handler, Qexpand_file_name, name, default_directory);
886
    }
887

888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
  {
    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.  */
905
#ifdef DOS_NT
906 907 908
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
909
#ifdef WINDOWSNT
910 911
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
912
#endif
913 914 915
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
916
	&& ! (IS_DIRECTORY_SEP (o[0]))
917
#endif /* not DOS_NT */
918 919 920
	)
      {
	struct gcpro gcpro1;
921

922 923 924 925 926
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
927
  name = FILE_SYSTEM_CASE (name);
928
  multibyte = STRING_MULTIBYTE (name);
929 930 931 932 933 934 935 936 937 938 939
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

940
  /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
941 942
  nm = (unsigned char *) alloca (SBYTES (name) + 1);
  bcopy (SDATA (name), nm, SBYTES (name) + 1);
Richard M. Stallman's avatar