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