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