record_unwind_protect error handling
[bpt/emacs.git] / src / callproc.c
CommitLineData
80856e74 1/* Synchronous subprocess invocation for GNU Emacs.
17e0445b 2
ba318903
PE
3Copyright (C) 1985-1988, 1993-1995, 1999-2014 Free Software Foundation,
4Inc.
80856e74
JB
5
6This file is part of GNU Emacs.
7
9ec0b715 8GNU Emacs is free software: you can redistribute it and/or modify
80856e74 9it under the terms of the GNU General Public License as published by
9ec0b715
GM
10the Free Software Foundation, either version 3 of the License, or
11(at your option) any later version.
80856e74
JB
12
13GNU Emacs is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
9ec0b715 19along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
80856e74
JB
20
21
68c45bf0 22#include <config.h>
e576cab4 23#include <errno.h>
565620a5 24#include <stdio.h>
80856e74 25#include <sys/types.h>
3cbd6585 26#include <unistd.h>
3cbd6585 27
80856e74 28#include <sys/file.h>
80856e74 29#include <fcntl.h>
80856e74 30
0898ca10
JB
31#include "lisp.h"
32
bad95d8f
RS
33#ifdef WINDOWSNT
34#define NOMINMAX
1d442672 35#include <sys/socket.h> /* for fcntl */
bad95d8f 36#include <windows.h>
489f9371 37#include "w32.h"
bad95d8f
RS
38#define _P_NOWAIT 1 /* from process.h */
39#endif
40
7e6c2178 41#ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
7e6c2178
RS
42#include <sys/stat.h>
43#include <sys/param.h>
7e6c2178
RS
44#endif /* MSDOS */
45
80856e74 46#include "commands.h"
91183bfd 47#include "character.h"
e5560ff7 48#include "buffer.h"
edf496dd 49#include "ccl.h"
32d08644 50#include "coding.h"
f0b950cf 51#include "composite.h"
57bda87a 52#include <epaths.h>
80856e74 53#include "process.h"
d177f194 54#include "syssignal.h"
a129418f 55#include "systty.h"
afea8a8a 56#include "syswait.h"
aba637ec 57#include "blockinput.h"
f105f403
KL
58#include "frame.h"
59#include "termhooks.h"
80856e74 60
5f027cea
EZ
61#ifdef MSDOS
62#include "msdos.h"
63#endif
64
d01ba2f1
GM
65#ifdef HAVE_NS
66#include "nsterm.h"
67#endif
68
f92d51d8
CY
69/* Pattern used by call-process-region to make temp files. */
70static Lisp_Object Vtemp_file_name_pattern;
71
94fcd171
PE
72/* The next two variables are used while record-unwind-protect is in place
73 during call-process for a subprocess for which record_deleted_pid has
74 not yet been called. At other times, synch_process_pid is zero and
75 synch_process_tempfile's contents are irrelevant. Doing this via static
bb5f74ee
PE
76 C variables is more convenient than putting them into the arguments
77 of record-unwind-protect, as they need to be updated at randomish
78 times in the code, and Lisp cannot always store these values as
79 Emacs integers. It's safe to use static variables here, as the
80 code is never invoked reentrantly. */
81
82/* If nonzero, a process-ID that has not been reaped. */
83static pid_t synch_process_pid;
84
94fcd171 85static Lisp_Object synch_process_tempfile;
94fcd171
PE
86
87/* Indexes of file descriptors that need closing on call_process_kill. */
88enum
89 {
90 /* The subsidiary process's stdout and stderr. stdin is handled
91 separately, in either Fcall_process_region or create_temp_file. */
92 CALLPROC_STDOUT, CALLPROC_STDERR,
93
94 /* How to read from a pipe (or substitute) from the subsidiary process. */
95 CALLPROC_PIPEREAD,
96
97 /* A bound on the number of file descriptors. */
98 CALLPROC_FDS
99 };
100
5d1922cd 101static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int *, Lisp_Object *);
bb5f74ee 102\f
c365c355
PE
103/* Return the current buffer's working directory, or the home
104 directory if it's unreachable, as a string suitable for a system call.
105 Signal an error if the result would not be an accessible directory. */
106
107Lisp_Object
108encode_current_directory (void)
109{
110 Lisp_Object dir;
111 struct gcpro gcpro1;
112
113 dir = BVAR (current_buffer, directory);
114 GCPRO1 (dir);
115
116 dir = Funhandled_file_name_directory (dir);
117
118 /* If the file name handler says that dir is unreachable, use
119 a sensible default. */
120 if (NILP (dir))
121 dir = build_string ("~");
122
123 dir = expand_and_dir_to_file (dir, Qnil);
124
125 if (STRING_MULTIBYTE (dir))
126 dir = ENCODE_FILE (dir);
127 if (! file_accessible_directory_p (SSDATA (dir)))
128 report_file_error ("Setting current directory",
129 BVAR (current_buffer, directory));
130
131 RETURN_UNGCPRO (dir);
132}
133
35fb8050
PE
134/* If P is reapable, record it as a deleted process and kill it.
135 Do this in a critical section. Unless PID is wedged it will be
136 reaped on receipt of the first SIGCHLD after the critical section. */
137
138void
94fcd171 139record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
35fb8050 140{
bf6b4923 141#ifndef MSDOS
1e952f0a
PE
142 sigset_t oldset;
143 block_child_signal (&oldset);
35fb8050
PE
144
145 if (p->alive)
146 {
94fcd171 147 record_deleted_pid (p->pid, tempfile);
35fb8050 148 p->alive = 0;
d983a10b 149 kill (- p->pid, SIGKILL);
35fb8050
PE
150 }
151
1e952f0a 152 unblock_child_signal (&oldset);
bf6b4923 153#endif /* !MSDOS */
35fb8050
PE
154}
155
94fcd171
PE
156/* Clean up files, file descriptors and processes created by Fcall_process. */
157
158static void
5d1922cd 159delete_temp_file_ptr (Lisp_Object *name_ptr)
94fcd171 160{
5d1922cd
BT
161 Lisp_Object name = *name_ptr;
162 if (! NILP (name))
163 unlink (SSDATA (name));
94fcd171 164}
37d54121 165
27e498e6 166static void
94fcd171 167call_process_kill (void *ptr)
d177f194 168{
94fcd171
PE
169 int *callproc_fd = ptr;
170 int i;
171 for (i = 0; i < CALLPROC_FDS; i++)
172 if (0 <= callproc_fd[i])
173 emacs_close (callproc_fd[i]);
bb5f74ee 174
bb5f74ee
PE
175 if (synch_process_pid)
176 {
35fb8050
PE
177 struct Lisp_Process proc;
178 proc.alive = 1;
179 proc.pid = synch_process_pid;
94fcd171
PE
180 record_kill_process (&proc, synch_process_tempfile);
181 synch_process_pid = 0;
bb5f74ee 182 }
94fcd171 183 else if (STRINGP (synch_process_tempfile))
5d1922cd 184 delete_temp_file_ptr (&synch_process_tempfile);
d177f194
JB
185}
186
94fcd171
PE
187/* Clean up when exiting Fcall_process: restore the buffer, and
188 kill the subsidiary process group if the process still exists. */
bb5f74ee 189
27e498e6 190static void
94fcd171 191call_process_cleanup (Lisp_Object buffer)
80856e74 192{
bb5f74ee 193 Fset_buffer (buffer);
d177f194 194
bf6b4923 195#ifndef MSDOS
bb5f74ee 196 if (synch_process_pid)
d177f194 197 {
d983a10b 198 kill (-synch_process_pid, SIGINT);
d177f194
JB
199 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
200 immediate_quit = 1;
201 QUIT;
bb5f74ee
PE
202 wait_for_termination (synch_process_pid, 0, 1);
203 synch_process_pid = 0;
d177f194 204 immediate_quit = 0;
d177f194
JB
205 message1 ("Waiting for process to die...done");
206 }
bf6b4923 207#endif /* !MSDOS */
80856e74
JB
208}
209
406af475
PE
210#ifdef DOS_NT
211static mode_t const default_output_mode = S_IREAD | S_IWRITE;
212#else
213static mode_t const default_output_mode = 0666;
214#endif
215
a7ca3326 216DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
fdb82f93
PJ
217 doc: /* Call PROGRAM synchronously in separate process.
218The remaining arguments are optional.
219The program's input comes from file INFILE (nil means `/dev/null').
38cd43eb 220Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
1ef14cb4 221 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
1b9f60cc
GM
222 FILE is a file name string, means that it should be written to that file
223 \(if the file already exists it is overwritten).
38cd43eb 224DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
fdb82f93
PJ
225REAL-BUFFER says what to do with standard output, as above,
226while STDERR-FILE says what to do with standard error in the child.
227STDERR-FILE may be nil (discard standard error output),
228t (mix it with ordinary output), or a file name string.
229
230Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
231Remaining arguments are strings passed as command arguments to PROGRAM.
232
a4feb144
RS
233If executable PROGRAM can't be found as an executable, `call-process'
234signals a Lisp error. `call-process' reports errors in execution of
235the program only through its return and output.
236
38cd43eb 237If DESTINATION is 0, `call-process' returns immediately with value nil.
fdb82f93
PJ
238Otherwise it waits for PROGRAM to terminate
239and returns a numeric exit status or a signal description string.
d98b59b5
MB
240If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
241
38cd43eb 242usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
f66c7cf8 243 (ptrdiff_t nargs, Lisp_Object *args)
80856e74 244{
94fcd171
PE
245 Lisp_Object infile, encoded_infile;
246 int filefd;
247 struct gcpro gcpro1;
248 ptrdiff_t count = SPECPDL_INDEX ();
249
250 if (nargs >= 2 && ! NILP (args[1]))
251 {
252 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
253 CHECK_STRING (infile);
254 }
255 else
256 infile = build_string (NULL_DEVICE);
257
258 GCPRO1 (infile);
259 encoded_infile = STRING_MULTIBYTE (infile) ? ENCODE_FILE (infile) : infile;
260
261 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
262 if (filefd < 0)
263 report_file_error ("Opening process input file", infile);
5d1922cd 264 record_unwind_protect_ptr (close_file_ptr_unwind, &filefd);
94fcd171 265 UNGCPRO;
5d1922cd 266 return unbind_to (count, call_process (nargs, args, &filefd, NULL));
94fcd171
PE
267}
268
269/* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
4a88129a
PE
270
271 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
272 unwinder that is intended to remove the input temporary file; in
273 this case NARGS must be at least 2 and ARGS[1] is the file's name.
274
94fcd171
PE
275 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
276
277static Lisp_Object
5d1922cd 278call_process (ptrdiff_t nargs, Lisp_Object *args, int *filefd, Lisp_Object *tempfile_ptr)
94fcd171
PE
279{
280 Lisp_Object buffer, current_dir, path;
2f221583 281 bool display_p;
94fcd171
PE
282 int fd0;
283 int callproc_fd[CALLPROC_FDS];
bb5f74ee 284 int status;
94fcd171 285 ptrdiff_t i;
d311d28c
PE
286 ptrdiff_t count = SPECPDL_INDEX ();
287 USE_SAFE_ALLOCA;
2d607244 288
60aeceb8 289 char **new_argv;
39eaa782
RS
290 /* File to use for stderr in the child.
291 t means use same as standard output. */
292 Lisp_Object error_file;
1ef14cb4 293 Lisp_Object output_file = Qnil;
7e6c2178 294#ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
94fcd171 295 char *tempfile = NULL;
d311d28c
PE
296 int pid;
297#else
1e952f0a 298 sigset_t oldset;
d311d28c 299 pid_t pid;
80856e74 300#endif
bb5f74ee 301 int child_errno;
94fcd171 302 int fd_output, fd_error;
32d08644
KH
303 struct coding_system process_coding; /* coding-system of process output */
304 struct coding_system argument_coding; /* coding-system of arguments */
09494912
RS
305 /* Set to the return value of Ffind_operation_coding_system. */
306 Lisp_Object coding_systems;
94fcd171
PE
307 bool discard_output;
308
309 if (synch_process_pid)
310 error ("call-process invoked recursively");
09494912
RS
311
312 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
313 coding_systems = Qt;
32d08644 314
b7826503 315 CHECK_STRING (args[0]);
80856e74 316
39eaa782
RS
317 error_file = Qt;
318
7e6c2178
RS
319#ifndef subprocesses
320 /* Without asynchronous processes we cannot have BUFFER == 0. */
177c0ea7 321 if (nargs >= 3
09ffb8b5 322 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
7e6c2178
RS
323 error ("Operating system cannot handle asynchronous subprocesses");
324#endif /* subprocesses */
325
09494912 326 /* Decide the coding-system for giving arguments. */
32d08644
KH
327 {
328 Lisp_Object val, *args2;
32d08644
KH
329
330 /* If arguments are supplied, we may have to encode them. */
331 if (nargs >= 5)
332 {
2f221583 333 bool must_encode = 0;
6e50da0a 334 Lisp_Object coding_attrs;
30d57b8e 335
e7c1c20e 336 for (i = 4; i < nargs; i++)
b7826503 337 CHECK_STRING (args[i]);
e7c1c20e 338
a2286b5c 339 for (i = 4; i < nargs; i++)
30d57b8e
RS
340 if (STRING_MULTIBYTE (args[i]))
341 must_encode = 1;
342
beacaab3
KH
343 if (!NILP (Vcoding_system_for_write))
344 val = Vcoding_system_for_write;
30d57b8e 345 else if (! must_encode)
fcaf8878 346 val = Qraw_text;
beacaab3 347 else
32d08644 348 {
0065d054 349 SAFE_NALLOCA (args2, 1, nargs + 1);
32d08644
KH
350 args2[0] = Qcall_process;
351 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
08ee4e87 352 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
fcaf8878 353 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
32d08644 354 }
fcaf8878 355 val = complement_process_encoding_system (val);
32d08644 356 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
6e50da0a
KH
357 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
358 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
359 {
360 /* We should not use an ASCII incompatible coding system. */
361 val = raw_text_coding_system (val);
362 setup_coding_system (val, &argument_coding);
363 }
32d08644 364 }
32d08644
KH
365 }
366
94fcd171
PE
367 if (nargs < 3)
368 buffer = Qnil;
80856e74 369 else
e576cab4 370 {
39eaa782
RS
371 buffer = args[2];
372
1ef14cb4
LMI
373 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
374 FILE-FOR-STDERR), unless the first element is :file, in which case see
375 the next paragraph. */
94fcd171 376 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
39eaa782 377 {
70949dac 378 if (CONSP (XCDR (buffer)))
45be8a1e 379 {
a9d4f28a 380 Lisp_Object stderr_file;
70949dac 381 stderr_file = XCAR (XCDR (buffer));
45be8a1e
RS
382
383 if (NILP (stderr_file) || EQ (Qt, stderr_file))
384 error_file = stderr_file;
385 else
386 error_file = Fexpand_file_name (stderr_file, Qnil);
387 }
388
70949dac 389 buffer = XCAR (buffer);
39eaa782 390 }
044512ed 391
1ef14cb4 392 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
94fcd171 393 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
1ef14cb4
LMI
394 {
395 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
396 BVAR (current_buffer, directory));
397 CHECK_STRING (output_file);
398 buffer = Qnil;
399 }
400
94fcd171 401 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
e576cab4 402 {
39eaa782
RS
403 Lisp_Object spec_buffer;
404 spec_buffer = buffer;
50fe359b 405 buffer = Fget_buffer_create (buffer);
39eaa782
RS
406 /* Mention the buffer name for a better error message. */
407 if (NILP (buffer))
b7826503
PJ
408 CHECK_BUFFER (spec_buffer);
409 CHECK_BUFFER (buffer);
e576cab4
JB
410 }
411 }
80856e74 412
58616e67
JB
413 /* Make sure that the child will be able to chdir to the current
414 buffer's current directory, or its unhandled equivalent. We
415 can't just have the child check for an error when it does the
416 chdir, since it's in a vfork.
417
418 We have to GCPRO around this because Fexpand_file_name,
419 Funhandled_file_name_directory, and Ffile_accessible_directory_p
420 might call a file name handling function. The argument list is
421 protected by the caller, so all we really have to worry about is
422 buffer. */
423 {
94fcd171 424 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
58616e67 425
c365c355 426 current_dir = encode_current_directory ();
58616e67 427
94fcd171 428 GCPRO4 (buffer, current_dir, error_file, output_file);
58616e67 429
34b87689
KH
430 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
431 error_file = ENCODE_FILE (error_file);
1ef14cb4
LMI
432 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
433 output_file = ENCODE_FILE (output_file);
58616e67
JB
434 UNGCPRO;
435 }
436
d311d28c 437 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
80856e74 438
94fcd171
PE
439 for (i = 0; i < CALLPROC_FDS; i++)
440 callproc_fd[i] = -1;
441#ifdef MSDOS
442 synch_process_tempfile = make_number (0);
443#endif
444 record_unwind_protect_ptr (call_process_kill, callproc_fd);
1ef14cb4 445
80856e74 446 /* Search for program; barf if not found. */
c52b0b34 447 {
94fcd171 448 struct gcpro gcpro1, gcpro2, gcpro3;
a773ed9a 449 int ok;
c52b0b34 450
94fcd171 451 GCPRO3 (buffer, current_dir, error_file);
518c40a2
PE
452 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
453 make_number (X_OK), false);
c52b0b34 454 UNGCPRO;
a773ed9a 455 if (ok < 0)
94fcd171 456 report_file_error ("Searching for program", args[0]);
c52b0b34 457 }
8ee8f447
RS
458
459 /* If program file name starts with /: for quoting a magic name,
460 discard that. */
461 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
462 && SREF (path, 1) == ':')
463 path = Fsubstring (path, make_number (2), Qnil);
464
98c6f1e3 465 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
c364e618 466
e7c3fb06 467 {
94fcd171 468 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
e7c3fb06 469
94fcd171 470 GCPRO4 (buffer, current_dir, path, error_file);
e7c3fb06
EZ
471 if (nargs > 4)
472 {
473 ptrdiff_t i;
474
475 argument_coding.dst_multibyte = 0;
476 for (i = 4; i < nargs; i++)
477 {
478 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
479 if (CODING_REQUIRE_ENCODING (&argument_coding))
480 /* We must encode this argument. */
481 args[i] = encode_coding_string (&argument_coding, args[i], 1);
482 }
483 for (i = 4; i < nargs; i++)
94fbc901 484 new_argv[i - 3] = SSDATA (args[i]);
e7c3fb06
EZ
485 new_argv[i - 3] = 0;
486 }
487 else
488 new_argv[1] = 0;
489 if (STRING_MULTIBYTE (path))
490 path = ENCODE_FILE (path);
94fbc901 491 new_argv[0] = SSDATA (path);
e7c3fb06
EZ
492 UNGCPRO;
493 }
80856e74 494
94fcd171 495 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
7e6c2178 496
94fcd171
PE
497#ifdef MSDOS
498 if (! discard_output && ! STRINGP (output_file))
7e6c2178 499 {
94fcd171
PE
500 char const *tmpdir = egetenv ("TMPDIR");
501 char const *outf = tmpdir ? tmpdir : "";
502 tempfile = alloca (strlen (outf) + 20);
503 strcpy (tempfile, outf);
bf6b4923 504 dostounix_filename (tempfile);
888c9e86
EZ
505 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
506 strcat (tempfile, "/");
bf6b4923 507 strcat (tempfile, "emXXXXXX");
888c9e86 508 mktemp (tempfile);
94fcd171
PE
509 if (!*tempfile)
510 report_file_error ("Opening process output file", Qnil);
511 output_file = build_string (tempfile);
512 synch_process_tempfile = output_file;
513 }
514#endif
515
516 if (discard_output)
517 {
518 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
519 if (fd_output < 0)
520 report_file_error ("Opening null device", Qnil);
521 }
522 else if (STRINGP (output_file))
523 {
524 fd_output = emacs_open (SSDATA (output_file),
525 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
526 default_output_mode);
527 if (fd_output < 0)
a773ed9a
PE
528 {
529 int open_errno = errno;
94fcd171 530 output_file = DECODE_FILE (output_file);
a773ed9a 531 report_file_errno ("Opening process output file",
94fcd171 532 output_file, open_errno);
a773ed9a 533 }
7e6c2178 534 }
80856e74
JB
535 else
536 {
60aeceb8 537 int fd[2];
c7ddc792 538 if (emacs_pipe (fd) != 0)
94fcd171
PE
539 report_file_error ("Creating process pipe", Qnil);
540 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
541 fd_output = fd[1];
80856e74 542 }
94fcd171 543 callproc_fd[CALLPROC_STDOUT] = fd_output;
80856e74 544
94fcd171 545 fd_error = fd_output;
80856e74 546
94fcd171
PE
547 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
548 {
549 fd_error = emacs_open ((STRINGP (error_file)
550 ? SSDATA (error_file)
551 : NULL_DEVICE),
406af475
PE
552 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
553 default_output_mode);
94fcd171
PE
554 if (fd_error < 0)
555 {
556 int open_errno = errno;
557 report_file_errno ("Cannot redirect stderr",
558 (STRINGP (error_file)
559 ? DECODE_FILE (error_file)
560 : build_string (NULL_DEVICE)),
561 open_errno);
562 }
563 callproc_fd[CALLPROC_STDERR] = fd_error;
564 }
89e1ec1d 565
2610078a 566#ifdef MSDOS /* MW, July 1993 */
94fcd171
PE
567 /* Note that on MSDOS `child_setup' actually returns the child process
568 exit status, not its PID, so assign it to status below. */
5d1922cd 569 pid = child_setup (*filefd, fd_output, fd_error, new_argv, 0, current_dir);
94fcd171
PE
570
571 if (pid < 0)
572 {
573 child_errno = errno;
574 unbind_to (count, Qnil);
575 synchronize_system_messages_locale ();
576 return
577 code_convert_string_norecord (build_string (strerror (child_errno)),
578 Vlocale_coding_system, 0);
579 }
580 status = pid;
581
582 for (i = 0; i < CALLPROC_FDS; i++)
583 if (0 <= callproc_fd[i])
2610078a 584 {
94fcd171
PE
585 emacs_close (callproc_fd[i]);
586 callproc_fd[i] = -1;
2610078a 587 }
5d1922cd
BT
588 emacs_close (*filefd);
589 *filefd = -1;
94fcd171
PE
590
591 if (tempfile)
592 {
593 /* Since CRLF is converted to LF within `decode_coding', we
594 can always open a file with binary mode. */
595 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
596 O_RDONLY | O_BINARY, 0);
597 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
598 {
599 int open_errno = errno;
600 report_file_errno ("Cannot re-open temporary file",
601 build_string (tempfile), open_errno);
602 }
603 }
604
644d3f0d 605#endif /* MSDOS */
bb5f74ee 606
94fcd171
PE
607 /* Do the unwind-protect now, even though the pid is not known, so
608 that no storage allocation is done in the critical section.
609 The actual PID will be filled in during the critical section. */
610 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
644d3f0d 611
94fcd171 612#ifndef MSDOS
bb5f74ee 613
94fcd171 614 block_input ();
1e952f0a 615 block_child_signal (&oldset);
bb5f74ee 616
bad95d8f 617#ifdef WINDOWSNT
5d1922cd 618 pid = child_setup (*filefd, fd_output, fd_error, new_argv, 0, current_dir);
bad95d8f 619#else /* not WINDOWSNT */
c0ad4ea5 620
94fcd171
PE
621 /* vfork, and prevent local vars from being clobbered by the vfork. */
622 {
623 Lisp_Object volatile buffer_volatile = buffer;
624 Lisp_Object volatile coding_systems_volatile = coding_systems;
625 Lisp_Object volatile current_dir_volatile = current_dir;
626 bool volatile display_p_volatile = display_p;
94fcd171 627 int volatile fd_error_volatile = fd_error;
5d1922cd 628 int *volatile filefd_volatile = filefd;
94fcd171 629 ptrdiff_t volatile count_volatile = count;
94fcd171
PE
630 char **volatile new_argv_volatile = new_argv;
631 int volatile callproc_fd_volatile[CALLPROC_FDS];
632 for (i = 0; i < CALLPROC_FDS; i++)
633 callproc_fd_volatile[i] = callproc_fd[i];
634
635 pid = vfork ();
636
637 buffer = buffer_volatile;
638 coding_systems = coding_systems_volatile;
639 current_dir = current_dir_volatile;
640 display_p = display_p_volatile;
94fcd171
PE
641 fd_error = fd_error_volatile;
642 filefd = filefd_volatile;
643 count = count_volatile;
94fcd171
PE
644 new_argv = new_argv_volatile;
645
646 for (i = 0; i < CALLPROC_FDS; i++)
647 callproc_fd[i] = callproc_fd_volatile[i];
648 fd_output = callproc_fd[CALLPROC_STDOUT];
649 }
bb5f74ee 650
94fcd171
PE
651 if (pid == 0)
652 {
1e952f0a 653 unblock_child_signal (&oldset);
322aea6d 654
94fcd171 655 setsid ();
c0ad4ea5 656
94fcd171
PE
657 /* Emacs ignores SIGPIPE, but the child should not. */
658 signal (SIGPIPE, SIG_DFL);
507a173f
AS
659 /* Likewise for SIGPROF. */
660#ifdef SIGPROF
661 signal (SIGPROF, SIG_DFL);
662#endif
c0ad4ea5 663
5d1922cd 664 child_setup (*filefd, fd_output, fd_error, new_argv, 0, current_dir);
94fcd171 665 }
aba637ec 666
bad95d8f 667#endif /* not WINDOWSNT */
cd5f8f60 668
94fcd171 669 child_errno = errno;
bb5f74ee 670
94fcd171 671 if (pid > 0)
4a88129a
PE
672 {
673 synch_process_pid = pid;
674
675 if (INTEGERP (buffer))
676 {
5d1922cd
BT
677 if (tempfile_ptr)
678 {
679 record_deleted_pid (pid, *tempfile_ptr);
680 *tempfile_ptr = Qnil;
681 }
682 else
683 {
684 record_deleted_pid (pid, Qnil);
685 }
4a88129a
PE
686 synch_process_pid = 0;
687 }
688 }
bb5f74ee 689
1e952f0a 690 unblock_child_signal (&oldset);
94fcd171 691 unblock_input ();
bb5f74ee 692
80856e74 693 if (pid < 0)
a773ed9a 694 report_file_errno ("Doing vfork", Qnil, child_errno);
80856e74 695
94fcd171
PE
696 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
697 since we will use that to read input from. */
698 for (i = 0; i < CALLPROC_FDS; i++)
699 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
700 {
701 emacs_close (callproc_fd[i]);
702 callproc_fd[i] = -1;
703 }
5d1922cd
BT
704 emacs_close (*filefd);
705 *filefd = -1;
94fcd171 706
bf6b4923
EZ
707#endif /* not MSDOS */
708
d50d3dc8 709 if (INTEGERP (buffer))
644d3f0d 710 return unbind_to (count, Qnil);
80856e74 711
d50d3dc8 712 if (BUFFERP (buffer))
80856e74
JB
713 Fset_buffer (buffer);
714
94fcd171
PE
715 fd0 = callproc_fd[CALLPROC_PIPEREAD];
716
717 if (0 <= fd0)
09494912
RS
718 {
719 Lisp_Object val, *args2;
720
721 val = Qnil;
722 if (!NILP (Vcoding_system_for_read))
723 val = Vcoding_system_for_read;
724 else
725 {
726 if (EQ (coding_systems, Qt))
727 {
f66c7cf8 728 ptrdiff_t i;
09494912 729
0065d054 730 SAFE_NALLOCA (args2, 1, nargs + 1);
09494912
RS
731 args2[0] = Qcall_process;
732 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
733 coding_systems
734 = Ffind_operation_coding_system (nargs + 1, args2);
735 }
736 if (CONSP (coding_systems))
70949dac 737 val = XCAR (coding_systems);
09494912 738 else if (CONSP (Vdefault_process_coding_system))
70949dac 739 val = XCAR (Vdefault_process_coding_system);
09494912
RS
740 else
741 val = Qnil;
742 }
91183bfd 743 Fcheck_coding_system (val);
09494912
RS
744 /* In unibyte mode, character code conversion should not take
745 place but EOL conversion should. So, setup raw-text or one
746 of the subsidiary according to the information just setup. */
4b4deea2 747 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
09494912 748 && !NILP (val))
91183bfd
KH
749 val = raw_text_coding_system (val);
750 setup_coding_system (val, &process_coding);
659afede
KH
751 process_coding.dst_multibyte
752 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
94fcd171 753 process_coding.src_multibyte = 0;
09494912
RS
754 }
755
80856e74
JB
756 immediate_quit = 1;
757 QUIT;
758
94fcd171 759 if (0 <= fd0)
19ed11ba 760 {
60aeceb8
PE
761 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
762 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
763 char buf[CALLPROC_BUFFER_SIZE_MAX];
764 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
2f221583 765 int nread;
19ed11ba
AS
766 EMACS_INT total_read = 0;
767 int carryover = 0;
2f221583 768 bool display_on_the_fly = display_p;
94fcd171 769 struct coding_system saved_coding = process_coding;
19ed11ba 770
19ed11ba
AS
771 while (1)
772 {
773 /* Repeatedly read until we've filled as much as possible
774 of the buffer size we have. But don't read
775 less than 1024--save that for the next bufferful. */
776 nread = carryover;
777 while (nread < bufsize - 1024)
778 {
60aeceb8 779 int this_read = emacs_read (fd0, buf + nread,
19ed11ba 780 bufsize - nread);
60558b19 781
19ed11ba
AS
782 if (this_read < 0)
783 goto give_up;
60558b19 784
19ed11ba
AS
785 if (this_read == 0)
786 {
787 process_coding.mode |= CODING_MODE_LAST_BLOCK;
788 break;
789 }
60558b19 790
19ed11ba
AS
791 nread += this_read;
792 total_read += this_read;
60558b19 793
19ed11ba
AS
794 if (display_on_the_fly)
795 break;
796 }
60558b19 797
19ed11ba
AS
798 /* Now NREAD is the total amount of data in the buffer. */
799 immediate_quit = 0;
177c0ea7 800
c4e6b585
SM
801 if (!nread)
802 ;
803 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
804 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
94fcd171
PE
805 insert_1_both (buf, nread, nread, 0, 1, 0);
806 else
807 { /* We have to decode the input. */
808 Lisp_Object curbuf;
809 ptrdiff_t count1 = SPECPDL_INDEX ();
810
811 XSETBUFFER (curbuf, current_buffer);
c4e6b585 812 /* FIXME: Call signal_after_change! */
d57f4dde 813 prepare_to_modify_buffer (PT, PT, NULL);
94fcd171
PE
814 /* We cannot allow after-change-functions be run
815 during decoding, because that might modify the
816 buffer, while we rely on process_coding.produced to
817 faithfully reflect inserted text until we
818 TEMP_SET_PT_BOTH below. */
819 specbind (Qinhibit_modification_hooks, Qt);
820 decode_coding_c_string (&process_coding,
821 (unsigned char *) buf, nread, curbuf);
822 unbind_to (count1, Qnil);
823 if (display_on_the_fly
824 && CODING_REQUIRE_DETECTION (&saved_coding)
825 && ! CODING_REQUIRE_DETECTION (&process_coding))
826 {
827 /* We have detected some coding system, but the
828 detection may have been via insufficient data.
829 So give up displaying on the fly. */
830 if (process_coding.produced > 0)
831 del_range_2 (process_coding.dst_pos,
832 process_coding.dst_pos_byte,
833 (process_coding.dst_pos
834 + process_coding.produced_char),
835 (process_coding.dst_pos_byte
836 + process_coding.produced),
837 0);
838 display_on_the_fly = 0;
839 process_coding = saved_coding;
840 carryover = nread;
841 /* Make the above condition always fail in the future. */
842 saved_coding.common_flags
843 &= ~CODING_REQUIRE_DETECTION_MASK;
844 continue;
19ed11ba 845 }
94fcd171
PE
846
847 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
848 PT_BYTE + process_coding.produced);
849 carryover = process_coding.carryover_bytes;
850 if (carryover > 0)
851 memcpy (buf, process_coding.carryover,
852 process_coding.carryover_bytes);
19ed11ba 853 }
c5bfa12b 854
19ed11ba
AS
855 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
856 break;
6e3bfbb2 857
19ed11ba
AS
858 /* Make the buffer bigger as we continue to read more data,
859 but not past CALLPROC_BUFFER_SIZE_MAX. */
860 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
861 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
862 bufsize = CALLPROC_BUFFER_SIZE_MAX;
6e3bfbb2 863
19ed11ba
AS
864 if (display_p)
865 {
19ed11ba
AS
866 redisplay_preserve_echo_area (1);
867 /* This variable might have been set to 0 for code
94fcd171 868 detection. In that case, set it back to 1 because
19ed11ba
AS
869 we should have already detected a coding system. */
870 display_on_the_fly = 1;
871 }
872 immediate_quit = 1;
873 QUIT;
874 }
875 give_up: ;
876
877 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
878 /* If the caller required, let the buffer inherit the
879 coding-system used to decode the process output. */
880 if (inherit_process_coding_system)
881 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
882 make_number (total_read));
883 }
3b440bb5 884
77defa9a 885#ifndef MSDOS
80856e74 886 /* Wait for it to terminate, unless it already has. */
94fcd171 887 wait_for_termination (pid, &status, fd0 < 0);
77defa9a 888#endif
80856e74
JB
889
890 immediate_quit = 0;
891
37d54121
RS
892 /* Don't kill any children that the subprocess may have left behind
893 when exiting. */
bb5f74ee 894 synch_process_pid = 0;
37d54121 895
3c59b4c9 896 SAFE_FREE ();
80856e74
JB
897 unbind_to (count, Qnil);
898
bb5f74ee 899 if (WIFSIGNALED (status))
6b61353c 900 {
42ca4633 901 const char *signame;
6b61353c
KH
902
903 synchronize_system_messages_locale ();
bb5f74ee 904 signame = strsignal (WTERMSIG (status));
6b61353c
KH
905
906 if (signame == 0)
19ed11ba 907 signame = "unknown";
6b61353c 908
bb5f74ee
PE
909 return code_convert_string_norecord (build_string (signame),
910 Vlocale_coding_system, 0);
6b61353c
KH
911 }
912
bb5f74ee
PE
913 eassert (WIFEXITED (status));
914 return make_number (WEXITSTATUS (status));
80856e74 915}
80856e74 916\f
bafe80ce
PE
917/* Create a temporary file suitable for storing the input data of
918 call-process-region. NARGS and ARGS are the same as for
94fcd171
PE
919 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
920 naming the file, and return a file descriptor for reading.
921 Unwind-protect the file, so that the file descriptor will be closed
922 and the file removed when the caller unwinds the specpdl stack. */
fdb82f93 923
5d1922cd 924static void
94fcd171 925create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
5d1922cd 926 Lisp_Object *filename_string_ptr, int *fdp)
80856e74 927{
94fcd171 928 int fd;
39323a7e
KH
929 struct gcpro gcpro1;
930 Lisp_Object filename_string;
bafe80ce 931 Lisp_Object val, start, end;
98c6f1e3 932 Lisp_Object tmpdir;
7e6c2178 933
f92d51d8
CY
934 if (STRINGP (Vtemporary_file_directory))
935 tmpdir = Vtemporary_file_directory;
7e6c2178
RS
936 else
937 {
83be8524 938 char *outf;
f92d51d8 939#ifndef DOS_NT
83be8524
PE
940 outf = getenv ("TMPDIR");
941 tmpdir = build_string (outf ? outf : "/tmp/");
f92d51d8 942#else /* DOS_NT */
f92d51d8
CY
943 if ((outf = egetenv ("TMPDIR"))
944 || (outf = egetenv ("TMP"))
945 || (outf = egetenv ("TEMP")))
946 tmpdir = build_string (outf);
947 else
948 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
0774fcf8 949#endif
f92d51d8 950 }
7e6c2178 951
3c59b4c9 952 {
98c6f1e3 953 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
74ba1583 954 char *tempfile;
94fcd171 955 ptrdiff_t count;
74ba1583
EZ
956
957#ifdef WINDOWSNT
958 /* Cannot use the result of Fexpand_file_name, because it
959 downcases the XXXXXX part of the pattern, and mktemp then
960 doesn't recognize it. */
961 if (!NILP (Vw32_downcase_file_names))
962 {
963 Lisp_Object dirname = Ffile_name_directory (pattern);
964
965 if (NILP (dirname))
966 pattern = Vtemp_file_name_pattern;
967 else
968 pattern = concat2 (dirname, Vtemp_file_name_pattern);
969 }
970#endif
971
bafe80ce
PE
972 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
973 GCPRO1 (filename_string);
974 tempfile = SSDATA (filename_string);
09494912 975
94fcd171
PE
976 fd = mkostemp (tempfile, O_CLOEXEC);
977 if (fd < 0)
978 report_file_error ("Failed to open temporary file using pattern",
979 pattern);
5d1922cd
BT
980 *fdp = fd;
981 *filename_string_ptr = filename_string;
982 record_unwind_protect (delete_temp_file_ptr, filename_string_ptr);
983 record_unwind_protect_ptr (close_file_ptr_unwind, fdp);
3c59b4c9
PE
984 }
985
80856e74
JB
986 start = args[0];
987 end = args[1];
32d08644 988 /* Decide coding-system of the contents of the temporary file. */
91489411
RS
989 if (!NILP (Vcoding_system_for_write))
990 val = Vcoding_system_for_write;
4b4deea2 991 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
fcaf8878 992 val = Qraw_text;
32d08644 993 else
beacaab3 994 {
bafe80ce
PE
995 Lisp_Object coding_systems;
996 Lisp_Object *args2;
3c59b4c9 997 USE_SAFE_ALLOCA;
0065d054 998 SAFE_NALLOCA (args2, 1, nargs + 1);
91489411 999 args2[0] = Qcall_process_region;
bafe80ce 1000 memcpy (args2 + 1, args, nargs * sizeof *args);
91489411 1001 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
fcaf8878 1002 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
3c59b4c9 1003 SAFE_FREE ();
beacaab3 1004 }
fcaf8878 1005 val = complement_process_encoding_system (val);
32d08644 1006
168afdaa 1007 {
d311d28c 1008 ptrdiff_t count1 = SPECPDL_INDEX ();
168afdaa
RS
1009
1010 specbind (intern ("coding-system-for-write"), val);
bb951f0e
KR
1011 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1012 happen to get a ".Z" suffix. */
1013 specbind (intern ("file-name-handler-alist"), Qnil);
94fcd171 1014 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
168afdaa
RS
1015
1016 unbind_to (count1, Qnil);
1017 }
91489411 1018
94fcd171
PE
1019 if (lseek (fd, 0, SEEK_SET) < 0)
1020 report_file_error ("Setting file position", filename_string);
1021
177c0ea7 1022 /* Note that Fcall_process takes care of binding
91489411 1023 coding-system-for-read. */
093650fe 1024
94fcd171 1025 UNGCPRO;
bafe80ce
PE
1026}
1027
1028DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1029 3, MANY, 0,
1030 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1031The remaining arguments are optional.
1032Delete the text if fourth arg DELETE is non-nil.
1033
1034Insert output in BUFFER before point; t means current buffer; nil for
1035 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1036 FILE)', where FILE is a file name string, means that it should be
1037 written to that file (if the file already exists it is overwritten).
1038BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1039REAL-BUFFER says what to do with standard output, as above,
1040while STDERR-FILE says what to do with standard error in the child.
1041STDERR-FILE may be nil (discard standard error output),
1042t (mix it with ordinary output), or a file name string.
1043
1044Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1045Remaining args are passed to PROGRAM at startup as command args.
1046
1047If BUFFER is 0, `call-process-region' returns immediately with value nil.
1048Otherwise it waits for PROGRAM to terminate
1049and returns a numeric exit status or a signal description string.
1050If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1051
1052usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1053 (ptrdiff_t nargs, Lisp_Object *args)
1054{
4a88129a 1055 struct gcpro gcpro1;
94fcd171 1056 Lisp_Object infile, val;
bafe80ce
PE
1057 ptrdiff_t count = SPECPDL_INDEX ();
1058 Lisp_Object start = args[0];
1059 Lisp_Object end = args[1];
1060 bool empty_input;
94fcd171 1061 int fd;
bafe80ce
PE
1062
1063 if (STRINGP (start))
1064 empty_input = SCHARS (start) == 0;
1065 else if (NILP (start))
1066 empty_input = BEG == Z;
1067 else
1068 {
1069 validate_region (&args[0], &args[1]);
1070 start = args[0];
1071 end = args[1];
1072 empty_input = XINT (start) == XINT (end);
1073 }
1074
94fcd171 1075 if (!empty_input)
5d1922cd 1076 create_temp_file (nargs, args, &infile, &fd);
94fcd171
PE
1077 else
1078 {
1079 infile = Qnil;
1080 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1081 if (fd < 0)
1082 report_file_error ("Opening null device", Qnil);
5d1922cd 1083 record_unwind_protect_ptr (close_file_ptr_unwind, &fd);
94fcd171
PE
1084 }
1085
4a88129a 1086 GCPRO1 (infile);
80856e74 1087
edf496dd 1088 if (nargs > 3 && !NILP (args[3]))
80856e74
JB
1089 Fdelete_region (start, end);
1090
edf496dd
KH
1091 if (nargs > 3)
1092 {
1093 args += 2;
1094 nargs -= 2;
1095 }
1096 else
1097 {
1098 args[0] = args[2];
1099 nargs = 2;
1100 }
50a30cce 1101 args[1] = infile;
80856e74 1102
5d1922cd 1103 val = call_process (nargs, args, &fd, &infile);
94fcd171 1104 RETURN_UNGCPRO (unbind_to (count, val));
80856e74
JB
1105}
1106\f
361358ea 1107#ifndef WINDOWSNT
971de7fb 1108static int relocate_fd (int fd, int minfd);
361358ea 1109#endif
dfcf069d 1110
5990851d
KL
1111static char **
1112add_env (char **env, char **new_env, char *string)
1113{
1114 char **ep;
2f221583 1115 bool ok = 1;
5990851d
KL
1116 if (string == NULL)
1117 return new_env;
1118
1119 /* See if this string duplicates any string already in the env.
1120 If so, don't put it in.
1121 When an env var has multiple definitions,
1122 we keep the definition that comes first in process-environment. */
1123 for (ep = env; ok && ep != new_env; ep++)
1124 {
1125 char *p = *ep, *q = string;
1126 while (ok)
19ed11ba
AS
1127 {
1128 if (*q != *p)
1129 break;
1130 if (*q == 0)
1131 /* The string is a lone variable name; keep it for now, we
1132 will remove it later. It is a placeholder for a
1133 variable that is not to be included in the environment. */
1134 break;
1135 if (*q == '=')
1136 ok = 0;
1137 p++, q++;
1138 }
5990851d
KL
1139 }
1140 if (ok)
1141 *new_env++ = string;
1142 return new_env;
1143}
1144
80856e74
JB
1145/* This is the last thing run in a newly forked inferior
1146 either synchronous or asynchronous.
1147 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1148 Initialize inferior's priority, pgrp, connected dir and environment.
1149 then exec another program based on new_argv.
1150
2f221583 1151 If SET_PGRP, put the subprocess into a separate process group.
e576cab4
JB
1152
1153 CURRENT_DIR is an elisp string giving the path of the current
1154 directory the subprocess should have. Since we can't really signal
1155 a decent error from within the child, this should be verified as an
1156 executable directory by the parent. */
80856e74 1157
dfcf069d 1158int
2f221583
PE
1159child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1160 Lisp_Object current_dir)
80856e74 1161{
e576cab4 1162 char **env;
7fcf7f05 1163 char *pwd_var;
bad95d8f
RS
1164#ifdef WINDOWSNT
1165 int cpid;
4252a4bd 1166 HANDLE handles[3];
afacaa1b
JB
1167#else
1168 int exec_errno;
e576cab4 1169
d311d28c 1170 pid_t pid = getpid ();
afacaa1b 1171#endif /* WINDOWSNT */
80856e74 1172
80856e74
JB
1173 /* Note that use of alloca is always safe here. It's obvious for systems
1174 that do not have true vfork or that have true (stack) alloca.
caa01fe0
GM
1175 If using vfork and C_ALLOCA (when Emacs used to include
1176 src/alloca.c) it is safe because that changes the superior's
1177 static variables as if the superior had done alloca and will be
1178 cleaned up in the usual way. */
e576cab4 1179 {
c365c355
PE
1180 char *temp;
1181 ptrdiff_t i;
77d78be1 1182
d5db4077 1183 i = SBYTES (current_dir);
16425c4a
EZ
1184#ifdef MSDOS
1185 /* MSDOS must have all environment variables malloc'ed, because
1186 low-level libc functions that launch subsidiary processes rely
1187 on that. */
c365c355 1188 pwd_var = xmalloc (i + 5);
16425c4a 1189#else
c365c355 1190 pwd_var = alloca (i + 5);
16425c4a 1191#endif
7fcf7f05 1192 temp = pwd_var + 4;
72af86bd 1193 memcpy (pwd_var, "PWD=", 4);
c365c355 1194 strcpy (temp, SSDATA (current_dir));
e576cab4 1195
c17c4250 1196#ifndef DOS_NT
e576cab4
JB
1197 /* We can't signal an Elisp error here; we're in a vfork. Since
1198 the callers check the current directory before forking, this
1199 should only return an error if the directory's permissions
1200 are changed between the check and this chdir, but we should
1201 at least check. */
1202 if (chdir (temp) < 0)
4ebbdd67 1203 _exit (EXIT_CANCELED);
f8d23104 1204#else /* DOS_NT */
c17c4250
EZ
1205 /* Get past the drive letter, so that d:/ is left alone. */
1206 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1207 {
1208 temp += 2;
1209 i -= 2;
1210 }
f8d23104 1211#endif /* DOS_NT */
c17c4250 1212
7fcf7f05 1213 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
bad95d8f 1214 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
7fcf7f05 1215 temp[--i] = 0;
e576cab4 1216 }
80856e74 1217
5990851d 1218 /* Set `env' to a vector of the strings in the environment. */
80856e74
JB
1219 {
1220 register Lisp_Object tem;
1221 register char **new_env;
5990851d 1222 char **p, **q;
80856e74 1223 register int new_length;
d2bb6598 1224 Lisp_Object display = Qnil;
361358ea 1225
80856e74 1226 new_length = 0;
f105f403 1227
80856e74 1228 for (tem = Vprocess_environment;
19ed11ba
AS
1229 CONSP (tem) && STRINGP (XCAR (tem));
1230 tem = XCDR (tem))
d2bb6598 1231 {
42a5b22f 1232 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
d2bb6598
SM
1233 && (SDATA (XCAR (tem)) [7] == '\0'
1234 || SDATA (XCAR (tem)) [7] == '='))
1235 /* DISPLAY is specified in process-environment. */
1236 display = Qt;
1237 new_length++;
1238 }
de87fb59 1239
d2bb6598
SM
1240 /* If not provided yet, use the frame's DISPLAY. */
1241 if (NILP (display))
1242 {
1243 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1244 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1245 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1246 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1247 Vinitial_environment);
1248 if (STRINGP (tmp))
1249 {
1250 display = tmp;
1251 new_length++;
1252 }
1253 }
80856e74 1254
7fcf7f05 1255 /* new_length + 2 to include PWD and terminating 0. */
38182d90 1256 env = new_env = alloca ((new_length + 2) * sizeof *env);
7fcf7f05
RS
1257 /* If we have a PWD envvar, pass one down,
1258 but with corrected value. */
a13f8f50 1259 if (egetenv ("PWD"))
7fcf7f05 1260 *new_env++ = pwd_var;
361358ea 1261
6b8e474c 1262 if (STRINGP (display))
de87fb59 1263 {
38182d90 1264 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
de87fb59 1265 strcpy (vdata, "DISPLAY=");
42a5b22f 1266 strcat (vdata, SSDATA (display));
de87fb59
DN
1267 new_env = add_env (env, new_env, vdata);
1268 }
80856e74 1269
5990851d 1270 /* Overrides. */
80856e74 1271 for (tem = Vprocess_environment;
70949dac
KR
1272 CONSP (tem) && STRINGP (XCAR (tem));
1273 tem = XCDR (tem))
42a5b22f 1274 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
d2bb6598 1275
5990851d
KL
1276 *new_env = 0;
1277
1278 /* Remove variable names without values. */
1279 p = q = env;
1280 while (*p != 0)
cd9565ba 1281 {
19ed11ba
AS
1282 while (*q != 0 && strchr (*q, '=') == NULL)
1283 q++;
1284 *p = *q++;
1285 if (*p != 0)
1286 p++;
cd9565ba 1287 }
80856e74 1288 }
de87fb59 1289
361358ea 1290
bad95d8f
RS
1291#ifdef WINDOWSNT
1292 prepare_standard_handles (in, out, err, handles);
d5db4077 1293 set_process_dir (SDATA (current_dir));
d3d14b40 1294 /* Spawn the child. (See w32proc.c:sys_spawnve). */
67802943
DN
1295 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1296 reset_standard_handles (in, out, err, handles);
1297 if (cpid == -1)
1298 /* An error occurred while trying to spawn the process. */
1299 report_file_error ("Spawning child process", Qnil);
1300 return cpid;
1301
bad95d8f 1302#else /* not WINDOWSNT */
426b37ae
JB
1303 /* Make sure that in, out, and err are not actually already in
1304 descriptors zero, one, or two; this could happen if Emacs is
7e6c2178 1305 started with its standard in, out, or error closed, as might
426b37ae 1306 happen under X. */
f29f9e4a
RS
1307 {
1308 int oin = in, oout = out;
1309
1310 /* We have to avoid relocating the same descriptor twice! */
1311
1312 in = relocate_fd (in, 3);
1313
1314 if (out == oin)
1315 out = in;
1316 else
3e9367e7 1317 out = relocate_fd (out, 3);
f29f9e4a
RS
1318
1319 if (err == oin)
1320 err = in;
1321 else if (err == oout)
1322 err = out;
1323 else
3e9367e7 1324 err = relocate_fd (err, 3);
f29f9e4a 1325 }
426b37ae 1326
c17c4250 1327#ifndef MSDOS
4700b5a5
PE
1328 /* Redirect file descriptors and clear the close-on-exec flag on the
1329 redirected ones. IN, OUT, and ERR are close-on-exec so they
1330 need not be closed explicitly. */
80856e74
JB
1331 dup2 (in, 0);
1332 dup2 (out, 1);
1333 dup2 (err, 2);
067428c1 1334
dd0333b6 1335 setpgid (0, 0);
12e610e8 1336 tcsetpgrp (0, pid);
a7ebc409 1337
21e54a94 1338 execve (new_argv[0], new_argv, env);
ee010797 1339 exec_errno = errno;
80856e74 1340
ee010797
PE
1341 /* Avoid deadlock if the child's perror writes to a full pipe; the
1342 pipe's reader is the parent, but with vfork the parent can't
1343 run until the child exits. Truncate the diagnostic instead. */
1344 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
4ebbdd67 1345
ee010797
PE
1346 errno = exec_errno;
1347 emacs_perror (new_argv[0]);
1348 _exit (exec_errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
67802943
DN
1349
1350#else /* MSDOS */
1351 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1352 xfree (pwd_var);
1353 if (pid == -1)
1354 /* An error occurred while trying to run the subprocess. */
1355 report_file_error ("Spawning child process", Qnil);
1356 return pid;
1357#endif /* MSDOS */
ae76d9e1 1358#endif /* not WINDOWSNT */
80856e74
JB
1359}
1360
361358ea 1361#ifndef WINDOWSNT
a3833dfe 1362/* Move the file descriptor FD so that its number is not less than MINFD.
4700b5a5
PE
1363 If the file descriptor is moved at all, the original is closed on MSDOS,
1364 but not elsewhere as the caller will close it anyway. */
dfcf069d 1365static int
971de7fb 1366relocate_fd (int fd, int minfd)
426b37ae 1367{
a3833dfe 1368 if (fd >= minfd)
426b37ae
JB
1369 return fd;
1370 else
1371 {
067428c1 1372 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
426b37ae
JB
1373 if (new == -1)
1374 {
4ebbdd67
PE
1375 emacs_perror ("while setting up child");
1376 _exit (EXIT_CANCELED);
426b37ae 1377 }
4700b5a5 1378#ifdef MSDOS
68c45bf0 1379 emacs_close (fd);
4700b5a5 1380#endif
426b37ae
JB
1381 return new;
1382 }
1383}
361358ea 1384#endif /* not WINDOWSNT */
426b37ae 1385
2f221583 1386static bool
989f33ba
PE
1387getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1388 ptrdiff_t *valuelen, Lisp_Object env)
012c6fcb 1389{
db699fc6 1390 for (; CONSP (env); env = XCDR (env))
012c6fcb 1391 {
db699fc6 1392 Lisp_Object entry = XCAR (env);
d50d3dc8 1393 if (STRINGP (entry)
db699fc6 1394 && SBYTES (entry) >= varlen
bad95d8f
RS
1395#ifdef WINDOWSNT
1396 /* NT environment variables are case insensitive. */
d5db4077 1397 && ! strnicmp (SDATA (entry), var, varlen)
bad95d8f 1398#else /* not WINDOWSNT */
72af86bd 1399 && ! memcmp (SDATA (entry), var, varlen)
bad95d8f 1400#endif /* not WINDOWSNT */
a9971c6d 1401 )
012c6fcb 1402 {
db699fc6
SM
1403 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1404 {
51b59d79 1405 *value = SSDATA (entry) + (varlen + 1);
db699fc6
SM
1406 *valuelen = SBYTES (entry) - (varlen + 1);
1407 return 1;
1408 }
1409 else if (SBYTES (entry) == varlen)
1410 {
1411 /* Lone variable names in Vprocess_environment mean that
1412 variable should be removed from the environment. */
1413 *value = NULL;
1414 return 1;
1415 }
1416 }
1417 }
1418 return 0;
1419}
1420
2f221583 1421static bool
989f33ba
PE
1422getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1423 ptrdiff_t *valuelen, Lisp_Object frame)
012c6fcb 1424{
d2bb6598
SM
1425 /* Try to find VAR in Vprocess_environment first. */
1426 if (getenv_internal_1 (var, varlen, value, valuelen,
1427 Vprocess_environment))
1428 return *value ? 1 : 0;
f105f403 1429
d2bb6598 1430 /* For DISPLAY try to get the values from the frame or the initial env. */
de87fb59 1431 if (strcmp (var, "DISPLAY") == 0)
d2bb6598
SM
1432 {
1433 Lisp_Object display
1434 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1435 if (STRINGP (display))
1436 {
51b59d79 1437 *value = SSDATA (display);
de87fb59 1438 *valuelen = SBYTES (display);
012c6fcb
JA
1439 return 1;
1440 }
d2bb6598
SM
1441 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1442 if (getenv_internal_1 (var, varlen, value, valuelen,
1443 Vinitial_environment))
1444 return *value ? 1 : 0;
012c6fcb
JA
1445 }
1446
1447 return 0;
1448}
1449
f105f403 1450DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
5990851d
KL
1451 doc: /* Get the value of environment variable VARIABLE.
1452VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1453the environment. Otherwise, value is a string.
f105f403 1454
acf20901 1455This function searches `process-environment' for VARIABLE.
5990851d 1456
db699fc6 1457If optional parameter ENV is a list, then search this list instead of
acf20901
JB
1458`process-environment', and return t when encountering a negative entry
1459\(an entry for a variable with no value). */)
5842a27b 1460 (Lisp_Object variable, Lisp_Object env)
012c6fcb
JA
1461{
1462 char *value;
989f33ba 1463 ptrdiff_t valuelen;
012c6fcb 1464
5990851d 1465 CHECK_STRING (variable);
db699fc6
SM
1466 if (CONSP (env))
1467 {
42a5b22f 1468 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
db699fc6
SM
1469 &value, &valuelen, env))
1470 return value ? make_string (value, valuelen) : Qt;
1471 else
1472 return Qnil;
1473 }
42a5b22f 1474 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
d2bb6598 1475 &value, &valuelen, env))
012c6fcb
JA
1476 return make_string (value, valuelen);
1477 else
1478 return Qnil;
1479}
1480
5990851d
KL
1481/* A version of getenv that consults the Lisp environment lists,
1482 easily callable from C. */
012c6fcb 1483char *
a8fe7202 1484egetenv (const char *var)
012c6fcb
JA
1485{
1486 char *value;
25c7e41f 1487 ptrdiff_t valuelen;
012c6fcb 1488
f105f403 1489 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
012c6fcb
JA
1490 return value;
1491 else
1492 return 0;
1493}
1494
80856e74 1495\f
8de15d69 1496/* This is run before init_cmdargs. */
177c0ea7 1497
dfcf069d 1498void
971de7fb 1499init_callproc_1 (void)
8de15d69 1500{
d01ba2f1
GM
1501#ifdef HAVE_NS
1502 const char *etc_dir = ns_etc_directory ();
cbb31951 1503 const char *path_exec = ns_exec_path ();
d01ba2f1 1504#endif
35a2f4b8 1505
76151e2c 1506 Vdata_directory = decode_env_path ("EMACSDATA",
d01ba2f1 1507#ifdef HAVE_NS
76151e2c 1508 etc_dir ? etc_dir :
d01ba2f1 1509#endif
17e0445b 1510 PATH_DATA, 0);
76151e2c
EZ
1511 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1512
1513 Vdoc_directory = decode_env_path ("EMACSDOC",
d01ba2f1 1514#ifdef HAVE_NS
76151e2c 1515 etc_dir ? etc_dir :
d01ba2f1 1516#endif
17e0445b 1517 PATH_DOC, 0);
76151e2c 1518 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
9453ea7b 1519
e576cab4 1520 /* Check the EMACSPATH environment variable, defaulting to the
57bda87a 1521 PATH_EXEC path from epaths.h. */
cbb31951
GM
1522 Vexec_path = decode_env_path ("EMACSPATH",
1523#ifdef HAVE_NS
1524 path_exec ? path_exec :
1525#endif
17e0445b 1526 PATH_EXEC, 0);
80856e74 1527 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
cbb31951 1528 /* FIXME? For ns, path_exec should go at the front? */
17e0445b 1529 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
8de15d69
RS
1530}
1531
e17f7533 1532/* This is run after init_cmdargs, when Vinstallation_directory is valid. */
8de15d69 1533
dfcf069d 1534void
971de7fb 1535init_callproc (void)
8de15d69
RS
1536{
1537 char *data_dir = egetenv ("EMACSDATA");
177c0ea7 1538
8de15d69
RS
1539 register char * sh;
1540 Lisp_Object tempdir;
d01ba2f1
GM
1541#ifdef HAVE_NS
1542 if (data_dir == 0)
1543 {
1544 const char *etc_dir = ns_etc_directory ();
1545 if (etc_dir)
1546 {
1547 data_dir = alloca (strlen (etc_dir) + 1);
1548 strcpy (data_dir, etc_dir);
1549 }
1550 }
1551#endif
8de15d69 1552
9cc4fad5 1553 if (!NILP (Vinstallation_directory))
8de15d69 1554 {
05630743
RS
1555 /* Add to the path the lib-src subdir of the installation dir. */
1556 Lisp_Object tem;
1557 tem = Fexpand_file_name (build_string ("lib-src"),
1558 Vinstallation_directory);
76151e2c 1559#ifndef MSDOS
1a6640ec 1560 /* MSDOS uses wrapped binaries, so don't do this. */
0fa248bc 1561 if (NILP (Fmember (tem, Vexec_path)))
70ec1377 1562 {
cbb31951
GM
1563#ifdef HAVE_NS
1564 const char *path_exec = ns_exec_path ();
1565#endif
1566 Vexec_path = decode_env_path ("EMACSPATH",
1567#ifdef HAVE_NS
1568 path_exec ? path_exec :
1569#endif
17e0445b 1570 PATH_EXEC, 0);
70ec1377 1571 Vexec_path = Fcons (tem, Vexec_path);
17e0445b 1572 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
70ec1377 1573 }
177c0ea7 1574
0fa248bc 1575 Vexec_directory = Ffile_name_as_directory (tem);
76151e2c 1576#endif /* not MSDOS */
8de15d69 1577
e17f7533
RS
1578 /* Maybe use ../etc as well as ../lib-src. */
1579 if (data_dir == 0)
1580 {
1581 tem = Fexpand_file_name (build_string ("etc"),
1582 Vinstallation_directory);
1583 Vdoc_directory = Ffile_name_as_directory (tem);
8de15d69
RS
1584 }
1585 }
7e933683
RS
1586
1587 /* Look for the files that should be in etc. We don't use
1588 Vinstallation_directory, because these files are never installed
e17f7533 1589 near the executable, and they are never in the build
7e933683
RS
1590 directory when that's different from the source directory.
1591
1592 Instead, if these files are not in the nominal place, we try the
1593 source directory. */
1594 if (data_dir == 0)
1595 {
70ec1377 1596 Lisp_Object tem, tem1, srcdir;
624780f0
GM
1597 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1598
1599 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
7e933683 1600
00156f95 1601 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
7e933683 1602 tem1 = Ffile_exists_p (tem);
70ec1377 1603 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
7e933683 1604 {
70ec1377 1605 Lisp_Object newdir;
624780f0 1606 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
00156f95 1607 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
7e933683
RS
1608 tem1 = Ffile_exists_p (tem);
1609 if (!NILP (tem1))
1610 Vdata_directory = newdir;
1611 }
1612 }
80856e74 1613
d883eb62
RS
1614#ifndef CANNOT_DUMP
1615 if (initialized)
1616#endif
1617 {
1618 tempdir = Fdirectory_file_name (Vexec_directory);
73dcdb9f
PE
1619 if (! file_accessible_directory_p (SSDATA (tempdir)))
1620 dir_warning ("arch-dependent data dir", Vexec_directory);
d883eb62 1621 }
80856e74 1622
e576cab4 1623 tempdir = Fdirectory_file_name (Vdata_directory);
73dcdb9f
PE
1624 if (! file_accessible_directory_p (SSDATA (tempdir)))
1625 dir_warning ("arch-independent data dir", Vdata_directory);
e576cab4 1626
83be8524 1627 sh = getenv ("SHELL");
80856e74 1628 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
8abd035b 1629
40b49d4b
JB
1630#ifdef DOS_NT
1631 Vshared_game_score_directory = Qnil;
1632#else
d0065ff1 1633 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
73dcdb9f 1634 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
63789758 1635 Vshared_game_score_directory = Qnil;
40b49d4b 1636#endif
9fefd2ba
JB
1637}
1638
dfcf069d 1639void
971de7fb 1640set_initial_environment (void)
9fefd2ba 1641{
738db178
DN
1642 char **envp;
1643 for (envp = environ; *envp; envp++)
1644 Vprocess_environment = Fcons (build_string (*envp),
1645 Vprocess_environment);
1646 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1647 to use `delete' and friends on process-environment. */
1648 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
80856e74
JB
1649}
1650
dfcf069d 1651void
971de7fb 1652syms_of_callproc (void)
80856e74 1653{
fe6aa7a1
BT
1654#include "callproc.x"
1655
f92d51d8
CY
1656#ifndef DOS_NT
1657 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
bf6b4923 1658#else /* DOS_NT */
f92d51d8 1659 Vtemp_file_name_pattern = build_string ("emXXXXXX");
f92d51d8
CY
1660#endif
1661 staticpro (&Vtemp_file_name_pattern);
1662
94fcd171
PE
1663 synch_process_tempfile = make_number (0);
1664 staticpro (&synch_process_tempfile);
94fcd171 1665
29208e82 1666 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
fb7ada5f 1667 doc: /* File name to load inferior shells from.
b20b29be
EZ
1668Initialized from the SHELL environment variable, or to a system-dependent
1669default if SHELL is not set. */);
80856e74 1670
29208e82 1671 DEFVAR_LISP ("exec-path", Vexec_path,
fb7ada5f 1672 doc: /* List of directories to search programs to run in subprocesses.
fdadeb49
JC
1673Each element is a string (directory name) or nil (try default directory).
1674
1675By default the last element of this list is `exec-directory'. The
1676last element is not always used, for example in shell completion
1677(`shell-dynamic-complete-command'). */);
80856e74 1678
29208e82 1679 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
fb7ada5f 1680 doc: /* List of suffixes to try to find executable file names.
fdb82f93 1681Each element is a string. */);
33d5af99 1682 Vexec_suffixes = Qnil;
b81a1b72 1683
29208e82 1684 DEFVAR_LISP ("exec-directory", Vexec_directory,
fdb82f93
PJ
1685 doc: /* Directory for executables for Emacs to invoke.
1686More generally, this includes any architecture-dependent files
1687that are built and installed from the Emacs distribution. */);
e576cab4 1688
29208e82 1689 DEFVAR_LISP ("data-directory", Vdata_directory,
fdb82f93
PJ
1690 doc: /* Directory of machine-independent files that come with GNU Emacs.
1691These are files intended for Emacs to use while it runs. */);
80856e74 1692
29208e82 1693 DEFVAR_LISP ("doc-directory", Vdoc_directory,
fdb82f93 1694 doc: /* Directory containing the DOC file that comes with GNU Emacs.
ebf24b59 1695This is usually the same as `data-directory'. */);
35a2f4b8 1696
29208e82 1697 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
fdb82f93
PJ
1698 doc: /* For internal use by the build procedure only.
1699This is the name of the directory in which the build procedure installed
ebf24b59 1700Emacs's info files; the default value for `Info-default-directory-list'
fdb82f93 1701includes this. */);
ed61592a
JB
1702 Vconfigure_info_directory = build_string (PATH_INFO);
1703
29208e82 1704 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
b065672a
CW
1705 doc: /* Directory of score files for games which come with GNU Emacs.
1706If this variable is nil, then Emacs is unable to use a shared directory. */);
40b49d4b
JB
1707#ifdef DOS_NT
1708 Vshared_game_score_directory = Qnil;
1709#else
63789758 1710 Vshared_game_score_directory = build_string (PATH_GAME);
40b49d4b 1711#endif
b065672a 1712
29208e82 1713 DEFVAR_LISP ("initial-environment", Vinitial_environment,
6b8e474c
SM
1714 doc: /* List of environment variables inherited from the parent process.
1715Each element should be a string of the form ENVVARNAME=VALUE.
1716The elements must normally be decoded (using `locale-coding-system') for use. */);
1717 Vinitial_environment = Qnil;
1718
29208e82 1719 DEFVAR_LISP ("process-environment", Vprocess_environment,
5990851d 1720 doc: /* List of overridden environment variables for subprocesses to inherit.
fdb82f93 1721Each element should be a string of the form ENVVARNAME=VALUE.
5990851d 1722
a13f8f50
KL
1723Entries in this list take precedence to those in the frame-local
1724environments. Therefore, let-binding `process-environment' is an easy
1725way to temporarily change the value of an environment variable,
1726irrespective of where it comes from. To use `process-environment' to
1727remove an environment variable, include only its name in the list,
1728without "=VALUE".
5990851d
KL
1729
1730This variable is set to nil when Emacs starts.
1731
fdb82f93
PJ
1732If multiple entries define the same variable, the first one always
1733takes precedence.
5990851d 1734
776a24a1 1735Non-ASCII characters are encoded according to the initial value of
5990851d
KL
1736`locale-coding-system', i.e. the elements must normally be decoded for
1737use.
1738
776a24a1 1739See `setenv' and `getenv'. */);
86f5ca04 1740 Vprocess_environment = Qnil;
80856e74 1741}