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