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