fileio.c 170 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,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008 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>
Jim Blandy's avatar
Jim Blandy committed
31

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
55
#ifndef vax11c
56
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
57 58
extern int errno;
#endif
59
#endif
Jim Blandy's avatar
Jim Blandy committed
60 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 85 86
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#if __DJGPP__ >= 2
#include <fcntl.h>
#include <string.h>
#endif
#endif

87 88 89 90 91 92 93 94 95 96 97 98 99
#ifdef DOS_NT
#define CORRECT_DIR_SEPS(s) \
  do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
       else unixtodos_filename (s); \
  } while (0)
/* 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
100 101 102 103
/* 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))
104 105
#endif

Jim Blandy's avatar
Jim Blandy committed
106
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
107 108 109

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

112 113
#include "commands.h"
extern int use_dialog_box;
Kenichi Handa's avatar
Kenichi Handa committed
114
extern int use_file_dialog;
115

Jim Blandy's avatar
Jim Blandy committed
116 117 118 119
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
120 121 122 123
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

124 125 126 127
#ifndef S_ISLNK
#  define lstat stat
#endif

128 129 130 131
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137 138
/* 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;

139 140 141
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

142 143 144 145 146 147 148
/* 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;

149 150 151
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

152 153 154 155
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

156
/* Alist of elements (REGEXP . HANDLER) for file names
157 158 159
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

160 161 162 163
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

164 165 166
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

167
/* Function to be called to decide a coding system of a reading file.  */
168
Lisp_Object Vset_auto_coding_function;
169

170 171 172
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

173
/* Lisp function for setting buffer-file-coding-system and the
174
   multibyteness of the current buffer after inserting a file.  */
175
Lisp_Object Qafter_insert_file_set_coding;
176

177 178
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
179
Lisp_Object Qwrite_region_annotate_functions;
180

181 182 183 184
/* 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;

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

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

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

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

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

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

207 208
extern Lisp_Object Vuser_login_name;

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

213 214
extern int minibuf_level;

215 216
extern int minibuffer_auto_raise;

217 218
extern int history_delete_duplicates;

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

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

226
static Lisp_Object Vinhibit_file_name_handlers;
227
static Lisp_Object Vinhibit_file_name_operation;
228

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

233 234
Lisp_Object Qcar_less_than_car;

235
static int a_write P_ ((int, Lisp_Object, int, int,
236
			Lisp_Object *, struct coding_system *));
237 238
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

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

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

Jim Blandy's avatar
Jim Blandy committed
255
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
256 257 258
    switch (errorno)
      {
      case EEXIST:
259
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
260 261 262 263
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
	   unless it is followed by a slash.  */
264 265 266 267 268 269 270 271
	if (! EQ (Faref (errstring, make_number (1)), make_number ('/')))
	  {
	    int c;

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

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

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

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

288
static Lisp_Object
289
restore_point_unwind (location)
290
     Lisp_Object location;
291
{
292
  Fgoto_char (location);
293
  Fset_marker (location, Qnil, Qnil);
294
  return Qnil;
295
}
296

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

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

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

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

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

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

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

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

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

409
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
410

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

417
  filename = FILE_SYSTEM_CASE (filename);
418
  beg = SDATA (filename);
419 420 421
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
422
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
423

424 425
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
426 427 428 429 430
	 /* only recognise drive specifier at the beginning */
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" and "/:foo" cases correctly  */
	      && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
		  || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
431
#endif
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435
	 ) p--;

  if (p == beg)
    return Qnil;
436
#ifdef DOS_NT
437
  /* Expansion of "c:" to drive and default directory.  */
438
  if (p[-1] == ':')
439 440
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
441
      unsigned char *res = alloca (MAXPATHLEN + 1);
442 443 444 445 446 447 448 449 450 451
      unsigned char *r = res;

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

      if (getdefdir (toupper (*beg) - 'A' + 1, r))
452
	{
453
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
454 455 456 457 458
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
459
  CORRECT_DIR_SEPS (beg);
460
#endif /* DOS_NT */
461

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

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

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

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

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

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

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

501 502
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
503 504 505 506 507
       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
508 509
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
510 511 512 513
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
     (filename)
     Lisp_Object filename;
514 515 516 517 518
{
  Lisp_Object handler;

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

  return Ffile_name_directory (filename);
}

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

  strcpy (out, in);

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

Jim Blandy's avatar
Jim Blandy committed
543
  /* For Unix syntax, Append a slash if necessary */
544
  if (!IS_DIRECTORY_SEP (out[size]))
545
    {
546 547
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
548 549
      out[size + 2] = '\0';
    }
550 551 552
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
553 554 555 556 557
  return out;
}

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

570
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
571
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
572
    return Qnil;
573 574 575

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
576
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
577 578 579
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

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

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

Andreas Schwab's avatar
Andreas Schwab committed
593
int
Jim Blandy's avatar
Jim Blandy committed
594 595 596 597 598 599
directory_file_name (src, dst)
     char *src, *dst;
{
  long slen;

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

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

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
618 619 620 621 622
       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
623
In Unix-syntax, this function just removes the final slash.  */)
624
     (directory)
Jim Blandy's avatar
Jim Blandy committed
625 626 627
     Lisp_Object directory;
{
  char *buf;
628
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
629

630
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
631

Jim Blandy's avatar
Jim Blandy committed
632
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
633
    return Qnil;
634 635 636

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
637
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
638 639 640
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

641 642
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
643 644
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
645 646
}

647 648 649 650 651 652 653 654 655 656 657
static char make_temp_name_tbl[64] =
{
  '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','-','_'
};
658

659 660
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

661
/* Value is a temporary file name starting with PREFIX, a string.
662

663 664 665 666 667
   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.
668

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

689
  CHECK_STRING (prefix);
690 691 692 693 694 695 696 697

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

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

718 719 720 721
  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);
722 723
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
724 725 726 727 728 729 730 731
  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
732 733 734 735 736 737
     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.  */

738 739 740 741 742 743 744 745 746
  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;
747
      unsigned num = make_temp_name_count;
748 749 750 751 752

      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;

753 754 755 756 757
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

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

  error ("Cannot create temporary name for prefix `%s'",
778
	 SDATA (prefix));
779
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
780
}
781

782 783

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


Jim Blandy's avatar
Jim Blandy committed
806 807

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
808 809
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
810
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
811
the current buffer's value of `default-directory' is used.
812 813 814 815 816 817 818 819
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.
See also the function `substitute-in-file-name'.  */)
     (name, default_directory)
820
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
821
{
822 823 824
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
  unsigned char *nm, *newdir;
825
  int nm_in_name;
826 827
  /* This should only point to alloca'd data.  */
  unsigned char *target;
828

Jim Blandy's avatar
Jim Blandy committed
829 830
  int tlen;
  struct passwd *pw;
831
#ifdef DOS_NT
832
  int drive = 0;
833
  int collapse_newdir = 1;
834
  int is_escaped = 0;
835
#endif /* DOS_NT */
836
  int length;
837
  Lisp_Object handler, result;
838
  int multibyte;
839
  Lisp_Object hdir;
840

841
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
842

843 844
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
845
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
846
  if (!NILP (handler))
847
    return call3 (handler, Qexpand_file_name, name, default_directory);
848

849 850 851
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
852
  if (! STRINGP (default_directory))
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
    {
#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
    }
870

871
  if (!NILP (default_directory))
872
    {
873
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
874
      if (!NILP (handler))
875
	return call3 (handler, Qexpand_file_name, name, default_directory);
876
    }
877

878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
  {
    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.  */
895
#ifdef DOS_NT
896 897 898
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
899
#ifdef WINDOWSNT
900 901
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
902
#endif
903 904 905
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
906
	&& ! (IS_DIRECTORY_SEP (o[0]))
907
#endif /* not DOS_NT */
908 909 910
	)
      {
	struct gcpro gcpro1;
911

912 913 914 915 916
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
917
  name = FILE_SYSTEM_CASE (name);
918
  multibyte = STRING_MULTIBYTE (name);
919 920 921 922 923 924 925 926 927 928 929 930
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

  nm = SDATA (name);
931
  nm_in_name = 1;
932

933
#ifdef DOS_NT
934 935 936
  /* We will force directory separators to be either all \ or /, so make
     a local copy to modify, even if there ends up being no change. */
  nm = strcpy (alloca (strlen (nm) + 1), nm);
937
  nm_in_name = 0;
938

939 940 941 942 943 944 945
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

946
  /* Find and remove drive specifier if present; this makes nm absolute
947 948 949 950 951 952 953
     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;
    }
954 955 956 957 958 959 960

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

962 963 964 965 966
  /* 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;
    }
967 968
#endif /* WINDOWSNT */
#endif /* DOS_NT */