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