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>
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"

Jim Blandy's avatar
Jim Blandy committed
102 103 104 105
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
106 107 108 109
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

110 111 112 113
#ifndef S_ISLNK
#  define lstat stat
#endif

114 115 116 117
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
118 119 120 121 122 123 124
/* 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;

125 126 127
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

128 129 130 131 132 133 134
/* 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;

135 136 137
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

138 139 140 141
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

142
/* Alist of elements (REGEXP . HANDLER) for file names
143 144 145
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

146 147 148 149
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

150 151 152
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

153
/* Function to be called to decide a coding system of a reading file.  */
154
Lisp_Object Vset_auto_coding_function;
155

156 157 158
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

159
/* Lisp function for setting buffer-file-coding-system and the
160
   multibyteness of the current buffer after inserting a file.  */
161
Lisp_Object Qafter_insert_file_set_coding;
162

163 164
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
165
Lisp_Object Qwrite_region_annotate_functions;
166
Lisp_Object Vwrite_region_post_annotation_function;
167

168 169 170 171
/* 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;

172 173 174 175
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
Lisp_Object Vwrite_region_annotation_buffers;

176 177 178
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

179 180 181
/* Whether or not files are auto-saved into themselves.  */
Lisp_Object Vauto_save_visited_file_name;

182 183 184
/* Whether or not to continue auto-saving after a large deletion.  */
Lisp_Object Vauto_save_include_big_deletions;

185 186 187 188
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

189 190 191 192 193
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

194
/* Non-zero means call move-file-to-trash in Fdelete_file or
195
   Fdelete_directory_internal.  */
196 197
int delete_by_moving_to_trash;

198 199
Lisp_Object Qdelete_by_moving_to_trash;

200 201 202
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

203 204 205 206 207 208
/* Lisp function for recursively copying directories.  */
Lisp_Object Qcopy_directory;

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

209 210 211 212
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

213 214 215 216 217 218 219
/* 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.  */

220
static Lisp_Object Vinhibit_file_name_handlers;
221
static Lisp_Object Vinhibit_file_name_operation;
222

223
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
224
Lisp_Object Qexcl;
225 226
Lisp_Object Qfile_name_history;

227 228
Lisp_Object Qcar_less_than_car;

229 230 231
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 *);
232

233

234
void
235
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
236 237
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
238
  int errorno = errno;
239
  char *str;
Jim Blandy's avatar
Jim Blandy committed
240

241
  synchronize_system_messages_locale ();
242 243 244
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
245 246
					    Vlocale_coding_system, 0);

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

	    str = (char *) SDATA (errstring);
263
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
264
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
265
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
266

267
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
270
}
271

272
Lisp_Object
273
close_file_unwind (Lisp_Object fd)
274
{
275
  emacs_close (XFASTINT (fd));
276
  return Qnil;
277
}
278 279 280

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

Andreas Schwab's avatar
Andreas Schwab committed
281
Lisp_Object
282
restore_point_unwind (Lisp_Object location)
283
{
284
  Fgoto_char (location);
285
  Fset_marker (location, Qnil, Qnil);
286
  return Qnil;
287
}
288

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

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

341
  result = Qnil;
342
  CHECK_STRING (filename);
343

344 345 346 347
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
348

349
  for (chain = Vfile_name_handler_alist; CONSP (chain);
350
       chain = XCDR (chain))
351 352
    {
      Lisp_Object elt;
353
      elt = XCAR (chain);
354
      if (CONSP (elt))
355
	{
356
	  Lisp_Object string = XCAR (elt);
357
	  int match_pos;
358
	  Lisp_Object handler = XCDR (elt);
359 360 361 362
	  Lisp_Object operations = Qnil;

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

364
	  if (STRINGP (string)
365 366
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
367
	    {
368
	      Lisp_Object tem;
369

370
	      handler = XCDR (elt);
371 372
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
373 374 375 376
		{
		  result = handler;
		  pos = match_pos;
		}
377
	    }
378
	}
379 380

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

401
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
402

403 404
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
405
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
406
  if (!NILP (handler))
407
    return call2 (handler, Qfile_name_directory, filename);
408

409
  filename = FILE_SYSTEM_CASE (filename);
410
#ifdef DOS_NT
411
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
412
  memcpy (beg, SDATA (filename), SBYTES (filename) + 1);
413 414
#else
  beg = SDATA (filename);
415
#endif
416
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
417

418 419
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
420 421 422 423 424
	 /* 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))))
425
#endif
Jim Blandy's avatar
Jim Blandy committed
426 427 428 429
	 ) p--;

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

456
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
457 458
}

459 460
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
461 462 463 464
       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
465
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
466
{
467
  register const unsigned char *beg, *p, *end;
468
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
469

470
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
471

472 473
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
474
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
475
  if (!NILP (handler))
476
    return call2 (handler, Qfile_name_nondirectory, filename);
477

478 479
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
480

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

491
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
492
}
493

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

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
511
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
512 513 514 515 516 517
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
518 519

char *
520
file_name_as_directory (char *out, char *in)
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524 525
{
  int size = strlen (in) - 1;

  strcpy (out, in);

526 527
  if (size < 0)
    {
528 529 530
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
531 532 533
      return out;
    }

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

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

559
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
560
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
561
    return Qnil;
562 563 564

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
565
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
566 567 568
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

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

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

Andreas Schwab's avatar
Andreas Schwab committed
582
int
583
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587
{
  long slen;

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

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

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

617
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
618

Jim Blandy's avatar
Jim Blandy committed
619
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
620
    return Qnil;
621 622 623

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
624
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
625 626 627
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

628 629
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
630 631
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
632 633
}

634
static const char make_temp_name_tbl[64] =
635 636 637 638 639 640 641 642 643 644
{
  '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','-','_'
};
645

646 647
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

648
/* Value is a temporary file name starting with PREFIX, a string.
649

650 651 652 653 654
   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.
655

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

674
  CHECK_STRING (prefix);
675 676 677 678 679 680 681 682

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

683 684 685 686 687 688 689 690 691
  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
    {
692
#ifdef HAVE_LONG_FILE_NAMES
693 694
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
695
#else
696 697 698 699
      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;
700
#endif
701
    }
702

703 704 705 706
  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);
707
  data = SDATA (val);
708
  memcpy (data, SDATA (prefix), len);
709 710
  p = data + len;

711
  memcpy (p, pidbuf, pidlen);
712 713 714 715 716
  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
717 718 719 720 721 722
     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.  */

723 724 725 726 727 728 729 730 731
  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;
732
      unsigned num = make_temp_name_count;
733 734 735 736 737

      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;

738 739 740 741 742
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

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

  error ("Cannot create temporary name for prefix `%s'",
763
	 SDATA (prefix));
764
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
765
}
766

767 768

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
769 770 771 772 773 774 775 776 777 778
       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
779 780 781 782 783
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
784
  (Lisp_Object prefix)
785 786 787 788 789
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
790 791

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
792 793
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
794
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
795
the current buffer's value of `default-directory' is used.
796 797 798 799 800 801
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
802 803 804 805 806 807 808
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
809
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
810
{
811 812 813 814 815
  /* 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;
816

Jim Blandy's avatar
Jim Blandy committed
817 818
  int tlen;
  struct passwd *pw;
819
#ifdef DOS_NT
820
  int drive = 0;
821
  int collapse_newdir = 1;
822
  int is_escaped = 0;
823
#endif /* DOS_NT */
824
  int length;
825
  Lisp_Object handler, result;
826
  int multibyte;
827
  Lisp_Object hdir;
828

829
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
830

831 832
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
833
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
834
  if (!NILP (handler))
835
    return call3 (handler, Qexpand_file_name, name, default_directory);
836

837 838 839
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
840
  if (! STRINGP (default_directory))
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
    {
#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
    }
856

857
  if (!NILP (default_directory))
858
    {
859
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
860
      if (!NILP (handler))
861
	return call3 (handler, Qexpand_file_name, name, default_directory);
862
    }
863

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

898 899 900 901 902
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
903
  name = FILE_SYSTEM_CASE (name);
904
  multibyte = STRING_MULTIBYTE (name);
905 906 907 908 909 910 911 912 913 914 915
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

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

920
#ifdef DOS_NT
921 922 923 924 925 926 927
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

928
  /* Find and remove drive specifier if present; this makes nm absolute
929 930 931 932 933 934 935
     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;
    }
936 937 938 939 940 941 942

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

944 945 946 947 948
  /* 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;
    }
949 950
#endif /* WINDOWSNT */
#endif /* DOS_NT */
951

952 953 954
  /* 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
955
  if (
956
      IS_DIRECTORY_SEP (nm[0])
957
#ifdef MSDOS
958
      && drive && !is_escaped
959 960
#endif
#ifdef WINDOWSNT
961
      && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
962
#endif
Jim Blandy's avatar
Jim Blandy committed
963 964
      )
    {
965 966 967 968