Minor EBADF fixes.
[emacs.git] / src / callproc.c
blobac9477bff10c9ae8495ba9da20acd9828c7644a7
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2013
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <sys/types.h>
25 #include <unistd.h>
27 #include <sys/file.h>
28 #include <fcntl.h>
30 #include "lisp.h"
32 #ifdef WINDOWSNT
33 #define NOMINMAX
34 #include <sys/socket.h> /* for fcntl */
35 #include <windows.h>
36 #include "w32.h"
37 #define _P_NOWAIT 1 /* from process.h */
38 #endif
40 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
41 #include <sys/stat.h>
42 #include <sys/param.h>
43 #endif /* MSDOS */
45 #include "commands.h"
46 #include "character.h"
47 #include "buffer.h"
48 #include "ccl.h"
49 #include "coding.h"
50 #include "composite.h"
51 #include <epaths.h>
52 #include "process.h"
53 #include "syssignal.h"
54 #include "systty.h"
55 #include "syswait.h"
56 #include "blockinput.h"
57 #include "frame.h"
58 #include "termhooks.h"
60 #ifdef MSDOS
61 #include "msdos.h"
62 #endif
64 #ifdef HAVE_NS
65 #include "nsterm.h"
66 #endif
68 /* Pattern used by call-process-region to make temp files. */
69 static Lisp_Object Vtemp_file_name_pattern;
71 /* The next two variables are valid only while record-unwind-protect
72 is in place during call-process for a synchronous subprocess. At
73 other times, their contents are irrelevant. Doing this via static
74 C variables is more convenient than putting them into the arguments
75 of record-unwind-protect, as they need to be updated at randomish
76 times in the code, and Lisp cannot always store these values as
77 Emacs integers. It's safe to use static variables here, as the
78 code is never invoked reentrantly. */
80 /* If nonzero, a process-ID that has not been reaped. */
81 static pid_t synch_process_pid;
83 /* If nonnegative, a file descriptor that has not been closed. */
84 static int synch_process_fd;
86 /* Block SIGCHLD. */
88 void
89 block_child_signal (void)
91 sigset_t blocked;
92 sigemptyset (&blocked);
93 sigaddset (&blocked, SIGCHLD);
94 pthread_sigmask (SIG_BLOCK, &blocked, 0);
97 /* Unblock SIGCHLD. */
99 void
100 unblock_child_signal (void)
102 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
105 /* If P is reapable, record it as a deleted process and kill it.
106 Do this in a critical section. Unless PID is wedged it will be
107 reaped on receipt of the first SIGCHLD after the critical section. */
109 void
110 record_kill_process (struct Lisp_Process *p)
112 block_child_signal ();
114 if (p->alive)
116 p->alive = 0;
117 record_deleted_pid (p->pid);
118 kill (- p->pid, SIGKILL);
121 unblock_child_signal ();
124 /* Clean up when exiting call_process_cleanup. */
126 static Lisp_Object
127 call_process_kill (Lisp_Object ignored)
129 if (synch_process_fd >= 0)
130 emacs_close (synch_process_fd);
132 if (synch_process_pid)
134 struct Lisp_Process proc;
135 proc.alive = 1;
136 proc.pid = synch_process_pid;
137 record_kill_process (&proc);
140 return Qnil;
143 /* Clean up when exiting Fcall_process.
144 On MSDOS, delete the temporary file on any kind of termination.
145 On Unix, kill the process and any children on termination by signal. */
147 static Lisp_Object
148 call_process_cleanup (Lisp_Object arg)
150 #ifdef MSDOS
151 Lisp_Object buffer = Fcar (arg);
152 Lisp_Object file = Fcdr (arg);
153 #else
154 Lisp_Object buffer = arg;
155 #endif
157 Fset_buffer (buffer);
159 #ifndef MSDOS
160 /* If the process still exists, kill its process group. */
161 if (synch_process_pid)
163 ptrdiff_t count = SPECPDL_INDEX ();
164 kill (-synch_process_pid, SIGINT);
165 record_unwind_protect (call_process_kill, make_number (0));
166 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
167 immediate_quit = 1;
168 QUIT;
169 wait_for_termination (synch_process_pid, 0, 1);
170 synch_process_pid = 0;
171 immediate_quit = 0;
172 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
173 message1 ("Waiting for process to die...done");
175 #endif
177 if (synch_process_fd >= 0)
178 emacs_close (synch_process_fd);
180 #ifdef MSDOS
181 /* FILE is "" when we didn't actually create a temporary file in
182 call-process. */
183 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
184 unlink (SDATA (file));
185 #endif
187 return Qnil;
190 #ifdef DOS_NT
191 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
192 #else
193 static mode_t const default_output_mode = 0666;
194 #endif
196 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
197 doc: /* Call PROGRAM synchronously in separate process.
198 The remaining arguments are optional.
199 The program's input comes from file INFILE (nil means `/dev/null').
200 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
201 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
202 FILE is a file name string, means that it should be written to that file
203 \(if the file already exists it is overwritten).
204 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
205 REAL-BUFFER says what to do with standard output, as above,
206 while STDERR-FILE says what to do with standard error in the child.
207 STDERR-FILE may be nil (discard standard error output),
208 t (mix it with ordinary output), or a file name string.
210 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
211 Remaining arguments are strings passed as command arguments to PROGRAM.
213 If executable PROGRAM can't be found as an executable, `call-process'
214 signals a Lisp error. `call-process' reports errors in execution of
215 the program only through its return and output.
217 If DESTINATION is 0, `call-process' returns immediately with value nil.
218 Otherwise it waits for PROGRAM to terminate
219 and returns a numeric exit status or a signal description string.
220 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
222 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
223 (ptrdiff_t nargs, Lisp_Object *args)
225 Lisp_Object infile, buffer, current_dir, path;
226 bool display_p;
227 int fd0, fd1, filefd;
228 int status;
229 ptrdiff_t count = SPECPDL_INDEX ();
230 USE_SAFE_ALLOCA;
232 char **new_argv;
233 /* File to use for stderr in the child.
234 t means use same as standard output. */
235 Lisp_Object error_file;
236 Lisp_Object output_file = Qnil;
237 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
238 char *outf, *tempfile = NULL;
239 int outfilefd;
240 int pid;
241 #else
242 pid_t pid;
243 #endif
244 int child_errno;
245 int fd_output = -1;
246 struct coding_system process_coding; /* coding-system of process output */
247 struct coding_system argument_coding; /* coding-system of arguments */
248 /* Set to the return value of Ffind_operation_coding_system. */
249 Lisp_Object coding_systems;
250 bool output_to_buffer = 1;
252 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
253 coding_systems = Qt;
255 CHECK_STRING (args[0]);
257 error_file = Qt;
259 #ifndef subprocesses
260 /* Without asynchronous processes we cannot have BUFFER == 0. */
261 if (nargs >= 3
262 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
263 error ("Operating system cannot handle asynchronous subprocesses");
264 #endif /* subprocesses */
266 /* Decide the coding-system for giving arguments. */
268 Lisp_Object val, *args2;
269 ptrdiff_t i;
271 /* If arguments are supplied, we may have to encode them. */
272 if (nargs >= 5)
274 bool must_encode = 0;
275 Lisp_Object coding_attrs;
277 for (i = 4; i < nargs; i++)
278 CHECK_STRING (args[i]);
280 for (i = 4; i < nargs; i++)
281 if (STRING_MULTIBYTE (args[i]))
282 must_encode = 1;
284 if (!NILP (Vcoding_system_for_write))
285 val = Vcoding_system_for_write;
286 else if (! must_encode)
287 val = Qraw_text;
288 else
290 SAFE_NALLOCA (args2, 1, nargs + 1);
291 args2[0] = Qcall_process;
292 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
293 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
294 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
296 val = complement_process_encoding_system (val);
297 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
298 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
299 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
301 /* We should not use an ASCII incompatible coding system. */
302 val = raw_text_coding_system (val);
303 setup_coding_system (val, &argument_coding);
308 if (nargs >= 2 && ! NILP (args[1]))
310 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
311 CHECK_STRING (infile);
313 else
314 infile = build_string (NULL_DEVICE);
316 if (nargs >= 3)
318 buffer = args[2];
320 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
321 FILE-FOR-STDERR), unless the first element is :file, in which case see
322 the next paragraph. */
323 if (CONSP (buffer)
324 && (! SYMBOLP (XCAR (buffer))
325 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
327 if (CONSP (XCDR (buffer)))
329 Lisp_Object stderr_file;
330 stderr_file = XCAR (XCDR (buffer));
332 if (NILP (stderr_file) || EQ (Qt, stderr_file))
333 error_file = stderr_file;
334 else
335 error_file = Fexpand_file_name (stderr_file, Qnil);
338 buffer = XCAR (buffer);
341 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
342 if (CONSP (buffer)
343 && SYMBOLP (XCAR (buffer))
344 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
346 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
347 BVAR (current_buffer, directory));
348 CHECK_STRING (output_file);
349 buffer = Qnil;
352 if (!(EQ (buffer, Qnil)
353 || EQ (buffer, Qt)
354 || INTEGERP (buffer)))
356 Lisp_Object spec_buffer;
357 spec_buffer = buffer;
358 buffer = Fget_buffer_create (buffer);
359 /* Mention the buffer name for a better error message. */
360 if (NILP (buffer))
361 CHECK_BUFFER (spec_buffer);
362 CHECK_BUFFER (buffer);
365 else
366 buffer = Qnil;
368 /* Make sure that the child will be able to chdir to the current
369 buffer's current directory, or its unhandled equivalent. We
370 can't just have the child check for an error when it does the
371 chdir, since it's in a vfork.
373 We have to GCPRO around this because Fexpand_file_name,
374 Funhandled_file_name_directory, and Ffile_accessible_directory_p
375 might call a file name handling function. The argument list is
376 protected by the caller, so all we really have to worry about is
377 buffer. */
379 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
381 current_dir = BVAR (current_buffer, directory);
383 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
385 current_dir = Funhandled_file_name_directory (current_dir);
386 if (NILP (current_dir))
387 /* If the file name handler says that current_dir is unreachable, use
388 a sensible default. */
389 current_dir = build_string ("~/");
390 current_dir = expand_and_dir_to_file (current_dir, Qnil);
391 current_dir = Ffile_name_as_directory (current_dir);
393 if (NILP (Ffile_accessible_directory_p (current_dir)))
394 report_file_error ("Setting current directory",
395 Fcons (BVAR (current_buffer, directory), Qnil));
397 if (STRING_MULTIBYTE (infile))
398 infile = ENCODE_FILE (infile);
399 if (STRING_MULTIBYTE (current_dir))
400 current_dir = ENCODE_FILE (current_dir);
401 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
402 error_file = ENCODE_FILE (error_file);
403 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
404 output_file = ENCODE_FILE (output_file);
405 UNGCPRO;
408 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
410 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
411 if (filefd < 0)
412 report_file_error ("Opening process input file",
413 Fcons (DECODE_FILE (infile), Qnil));
415 if (STRINGP (output_file))
417 fd_output = emacs_open (SSDATA (output_file),
418 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
419 default_output_mode);
420 if (fd_output < 0)
422 output_file = DECODE_FILE (output_file);
423 report_file_error ("Opening process output file",
424 Fcons (output_file, Qnil));
426 if (STRINGP (error_file) || NILP (error_file))
427 output_to_buffer = 0;
430 /* Search for program; barf if not found. */
432 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
434 GCPRO4 (infile, buffer, current_dir, error_file);
435 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
436 UNGCPRO;
438 if (NILP (path))
440 int openp_errno = errno;
441 emacs_close (filefd);
442 errno = openp_errno;
443 report_file_error ("Searching for program", Fcons (args[0], Qnil));
446 /* If program file name starts with /: for quoting a magic name,
447 discard that. */
448 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
449 && SREF (path, 1) == ':')
450 path = Fsubstring (path, make_number (2), Qnil);
452 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
455 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
457 GCPRO5 (infile, buffer, current_dir, path, error_file);
458 if (nargs > 4)
460 ptrdiff_t i;
462 argument_coding.dst_multibyte = 0;
463 for (i = 4; i < nargs; i++)
465 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
466 if (CODING_REQUIRE_ENCODING (&argument_coding))
467 /* We must encode this argument. */
468 args[i] = encode_coding_string (&argument_coding, args[i], 1);
470 for (i = 4; i < nargs; i++)
471 new_argv[i - 3] = SSDATA (args[i]);
472 new_argv[i - 3] = 0;
474 else
475 new_argv[1] = 0;
476 if (STRING_MULTIBYTE (path))
477 path = ENCODE_FILE (path);
478 new_argv[0] = SSDATA (path);
479 UNGCPRO;
482 #ifdef MSDOS /* MW, July 1993 */
484 /* If we're redirecting STDOUT to a file, that file is already open
485 on fd_output. */
486 if (fd_output < 0)
488 if ((outf = egetenv ("TMPDIR")))
489 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
490 else
492 tempfile = alloca (20);
493 *tempfile = '\0';
495 dostounix_filename (tempfile, 0);
496 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
497 strcat (tempfile, "/");
498 strcat (tempfile, "detmp.XXX");
499 mktemp (tempfile);
500 outfilefd = emacs_open (tempfile, O_WRONLY | O_CREAT | O_TRUNC,
501 S_IREAD | S_IWRITE);
502 if (outfilefd < 0) {
503 emacs_close (filefd);
504 report_file_error ("Opening process output file",
505 Fcons (build_string (tempfile), Qnil));
508 else
509 outfilefd = fd_output;
510 fd0 = filefd;
511 fd1 = outfilefd;
512 #endif /* MSDOS */
514 if (INTEGERP (buffer))
516 fd0 = -1;
517 fd1 = emacs_open (NULL_DEVICE, O_WRONLY, 0);
519 else
521 #ifndef MSDOS
522 int fd[2];
523 if (pipe2 (fd, O_CLOEXEC) != 0)
525 int pipe_errno = errno;
526 emacs_close (filefd);
527 errno = pipe_errno;
528 report_file_error ("Creating process pipe", Qnil);
530 fd0 = fd[0];
531 fd1 = fd[1];
532 #endif
536 int fd_error = fd1;
538 if (fd_output >= 0)
539 fd1 = fd_output;
541 if (NILP (error_file))
542 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
543 else if (STRINGP (error_file))
544 fd_error = emacs_open (SSDATA (error_file),
545 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
546 default_output_mode);
548 if (fd_error < 0)
550 emacs_close (filefd);
551 if (fd0 != filefd)
552 emacs_close (fd0);
553 if (fd1 >= 0)
554 emacs_close (fd1);
555 #ifdef MSDOS
556 unlink (tempfile);
557 #endif
558 if (NILP (error_file))
559 error_file = build_string (NULL_DEVICE);
560 else if (STRINGP (error_file))
561 error_file = DECODE_FILE (error_file);
562 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
565 #ifdef MSDOS /* MW, July 1993 */
566 /* Note that on MSDOS `child_setup' actually returns the child process
567 exit status, not its PID, so assign it to status below. */
568 pid = child_setup (filefd, outfilefd, fd_error, new_argv, 0, current_dir);
569 child_errno = errno;
571 emacs_close (outfilefd);
572 if (fd_error != outfilefd)
573 emacs_close (fd_error);
574 if (pid < 0)
576 synchronize_system_messages_locale ();
577 return
578 code_convert_string_norecord (build_string (strerror (child_errno)),
579 Vlocale_coding_system, 0);
581 status = pid;
582 fd1 = -1; /* No harm in closing that one! */
583 if (tempfile)
585 /* Since CRLF is converted to LF within `decode_coding', we
586 can always open a file with binary mode. */
587 fd0 = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
588 if (fd0 < 0)
590 unlink (tempfile);
591 emacs_close (filefd);
592 report_file_error ("Cannot re-open temporary file",
593 Fcons (build_string (tempfile), Qnil));
596 else
597 fd0 = -1; /* We are not going to read from tempfile. */
598 #endif /* MSDOS */
600 /* Do the unwind-protect now, even though the pid is not known, so
601 that no storage allocation is done in the critical section.
602 The actual PID will be filled in during the critical section. */
603 synch_process_pid = 0;
604 synch_process_fd = fd0;
606 #ifdef MSDOS
607 /* MSDOS needs different cleanup information. */
608 record_unwind_protect (call_process_cleanup,
609 Fcons (Fcurrent_buffer (),
610 build_string (tempfile ? tempfile : "")));
611 #else
612 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
614 block_input ();
615 block_child_signal ();
617 #ifdef WINDOWSNT
618 pid = child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
619 /* We need to record the input file of this child, for when we are
620 called from call-process-region to create an async subprocess.
621 That's because call-process-region's unwind procedure will
622 attempt to delete the temporary input file, which will fail
623 because that file is still in use. Recording it with the child
624 will allow us to delete the file when the subprocess exits.
625 The second part of this is in delete_temp_file, q.v. */
626 if (pid > 0 && INTEGERP (buffer) && nargs >= 2 && !NILP (args[1]))
627 record_infile (pid, xstrdup (SSDATA (infile)));
628 #else /* not WINDOWSNT */
630 /* vfork, and prevent local vars from being clobbered by the vfork. */
632 Lisp_Object volatile buffer_volatile = buffer;
633 Lisp_Object volatile coding_systems_volatile = coding_systems;
634 Lisp_Object volatile current_dir_volatile = current_dir;
635 bool volatile display_p_volatile = display_p;
636 bool volatile output_to_buffer_volatile = output_to_buffer;
637 bool volatile sa_must_free_volatile = sa_must_free;
638 int volatile fd1_volatile = fd1;
639 int volatile fd_error_volatile = fd_error;
640 int volatile fd_output_volatile = fd_output;
641 int volatile filefd_volatile = filefd;
642 ptrdiff_t volatile count_volatile = count;
643 ptrdiff_t volatile sa_count_volatile = sa_count;
644 char **volatile new_argv_volatile = new_argv;
646 pid = vfork ();
647 child_errno = errno;
649 buffer = buffer_volatile;
650 coding_systems = coding_systems_volatile;
651 current_dir = current_dir_volatile;
652 display_p = display_p_volatile;
653 output_to_buffer = output_to_buffer_volatile;
654 sa_must_free = sa_must_free_volatile;
655 fd1 = fd1_volatile;
656 fd_error = fd_error_volatile;
657 fd_output = fd_output_volatile;
658 filefd = filefd_volatile;
659 count = count_volatile;
660 sa_count = sa_count_volatile;
661 new_argv = new_argv_volatile;
663 fd0 = synch_process_fd;
666 if (pid == 0)
668 unblock_child_signal ();
670 if (fd0 >= 0)
671 emacs_close (fd0);
673 setsid ();
675 /* Emacs ignores SIGPIPE, but the child should not. */
676 signal (SIGPIPE, SIG_DFL);
678 child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
681 #endif /* not WINDOWSNT */
683 child_errno = errno;
685 if (pid > 0)
687 if (INTEGERP (buffer))
688 record_deleted_pid (pid);
689 else
690 synch_process_pid = pid;
693 unblock_child_signal ();
694 unblock_input ();
696 /* The MSDOS case did this already. */
697 if (fd_error >= 0)
698 emacs_close (fd_error);
699 #endif /* not MSDOS */
701 /* Close most of our file descriptors, but not fd0
702 since we will use that to read input from. */
703 emacs_close (filefd);
704 if (fd_output >= 0)
705 emacs_close (fd_output);
706 if (fd1 >= 0 && fd1 != fd_error)
707 emacs_close (fd1);
710 if (pid < 0)
712 errno = child_errno;
713 report_file_error ("Doing vfork", Qnil);
716 if (INTEGERP (buffer))
717 return unbind_to (count, Qnil);
719 if (BUFFERP (buffer))
720 Fset_buffer (buffer);
722 if (NILP (buffer))
724 /* If BUFFER is nil, we must read process output once and then
725 discard it, so setup coding system but with nil. */
726 setup_coding_system (Qnil, &process_coding);
727 process_coding.dst_multibyte = 0;
729 else
731 Lisp_Object val, *args2;
733 val = Qnil;
734 if (!NILP (Vcoding_system_for_read))
735 val = Vcoding_system_for_read;
736 else
738 if (EQ (coding_systems, Qt))
740 ptrdiff_t i;
742 SAFE_NALLOCA (args2, 1, nargs + 1);
743 args2[0] = Qcall_process;
744 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
745 coding_systems
746 = Ffind_operation_coding_system (nargs + 1, args2);
748 if (CONSP (coding_systems))
749 val = XCAR (coding_systems);
750 else if (CONSP (Vdefault_process_coding_system))
751 val = XCAR (Vdefault_process_coding_system);
752 else
753 val = Qnil;
755 Fcheck_coding_system (val);
756 /* In unibyte mode, character code conversion should not take
757 place but EOL conversion should. So, setup raw-text or one
758 of the subsidiary according to the information just setup. */
759 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
760 && !NILP (val))
761 val = raw_text_coding_system (val);
762 setup_coding_system (val, &process_coding);
763 process_coding.dst_multibyte
764 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
766 process_coding.src_multibyte = 0;
768 immediate_quit = 1;
769 QUIT;
771 if (output_to_buffer)
773 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
774 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
775 char buf[CALLPROC_BUFFER_SIZE_MAX];
776 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
777 int nread;
778 bool first = 1;
779 EMACS_INT total_read = 0;
780 int carryover = 0;
781 bool display_on_the_fly = display_p;
782 struct coding_system saved_coding;
784 saved_coding = process_coding;
785 while (1)
787 /* Repeatedly read until we've filled as much as possible
788 of the buffer size we have. But don't read
789 less than 1024--save that for the next bufferful. */
790 nread = carryover;
791 while (nread < bufsize - 1024)
793 int this_read = emacs_read (fd0, buf + nread,
794 bufsize - nread);
796 if (this_read < 0)
797 goto give_up;
799 if (this_read == 0)
801 process_coding.mode |= CODING_MODE_LAST_BLOCK;
802 break;
805 nread += this_read;
806 total_read += this_read;
808 if (display_on_the_fly)
809 break;
812 /* Now NREAD is the total amount of data in the buffer. */
813 immediate_quit = 0;
815 if (!NILP (buffer))
817 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
818 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
819 insert_1_both (buf, nread, nread, 0, 1, 0);
820 else
821 { /* We have to decode the input. */
822 Lisp_Object curbuf;
823 ptrdiff_t count1 = SPECPDL_INDEX ();
825 XSETBUFFER (curbuf, current_buffer);
826 /* We cannot allow after-change-functions be run
827 during decoding, because that might modify the
828 buffer, while we rely on process_coding.produced to
829 faithfully reflect inserted text until we
830 TEMP_SET_PT_BOTH below. */
831 specbind (Qinhibit_modification_hooks, Qt);
832 decode_coding_c_string (&process_coding,
833 (unsigned char *) buf, nread, curbuf);
834 unbind_to (count1, Qnil);
835 if (display_on_the_fly
836 && CODING_REQUIRE_DETECTION (&saved_coding)
837 && ! CODING_REQUIRE_DETECTION (&process_coding))
839 /* We have detected some coding system. But,
840 there's a possibility that the detection was
841 done by insufficient data. So, we give up
842 displaying on the fly. */
843 if (process_coding.produced > 0)
844 del_range_2 (process_coding.dst_pos,
845 process_coding.dst_pos_byte,
846 process_coding.dst_pos
847 + process_coding.produced_char,
848 process_coding.dst_pos_byte
849 + process_coding.produced, 0);
850 display_on_the_fly = 0;
851 process_coding = saved_coding;
852 carryover = nread;
853 /* This is to make the above condition always
854 fails in the future. */
855 saved_coding.common_flags
856 &= ~CODING_REQUIRE_DETECTION_MASK;
857 continue;
860 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
861 PT_BYTE + process_coding.produced);
862 carryover = process_coding.carryover_bytes;
863 if (carryover > 0)
864 memcpy (buf, process_coding.carryover,
865 process_coding.carryover_bytes);
869 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
870 break;
872 /* Make the buffer bigger as we continue to read more data,
873 but not past CALLPROC_BUFFER_SIZE_MAX. */
874 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
875 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
876 bufsize = CALLPROC_BUFFER_SIZE_MAX;
878 if (display_p)
880 if (first)
881 prepare_menu_bars ();
882 first = 0;
883 redisplay_preserve_echo_area (1);
884 /* This variable might have been set to 0 for code
885 detection. In that case, we set it back to 1 because
886 we should have already detected a coding system. */
887 display_on_the_fly = 1;
889 immediate_quit = 1;
890 QUIT;
892 give_up: ;
894 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
895 /* If the caller required, let the buffer inherit the
896 coding-system used to decode the process output. */
897 if (inherit_process_coding_system)
898 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
899 make_number (total_read));
902 #ifndef MSDOS
903 /* Wait for it to terminate, unless it already has. */
904 wait_for_termination (pid, &status, !output_to_buffer);
905 #endif
907 immediate_quit = 0;
909 /* Don't kill any children that the subprocess may have left behind
910 when exiting. */
911 synch_process_pid = 0;
913 SAFE_FREE ();
914 unbind_to (count, Qnil);
916 if (WIFSIGNALED (status))
918 const char *signame;
920 synchronize_system_messages_locale ();
921 signame = strsignal (WTERMSIG (status));
923 if (signame == 0)
924 signame = "unknown";
926 return code_convert_string_norecord (build_string (signame),
927 Vlocale_coding_system, 0);
930 eassert (WIFEXITED (status));
931 return make_number (WEXITSTATUS (status));
934 static Lisp_Object
935 delete_temp_file (Lisp_Object name)
937 /* Suppress jka-compr handling, etc. */
938 ptrdiff_t count = SPECPDL_INDEX ();
939 specbind (intern ("file-name-handler-alist"), Qnil);
940 #ifdef WINDOWSNT
941 /* If this is called when the subprocess didn't exit yet, the
942 attempt to delete its input file will fail. In that case, we
943 schedule the file for deletion when the subprocess exits. This
944 is the 2nd part of handling this situation; see the call to
945 record_infile in call-process above, for the first part. */
946 if (!internal_delete_file (name))
948 Lisp_Object encoded_file = ENCODE_FILE (name);
950 record_pending_deletion (SSDATA (encoded_file));
952 #else
953 internal_delete_file (name);
954 #endif
955 unbind_to (count, Qnil);
956 return Qnil;
959 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
960 3, MANY, 0,
961 doc: /* Send text from START to END to a synchronous process running PROGRAM.
962 The remaining arguments are optional.
963 Delete the text if fourth arg DELETE is non-nil.
965 Insert output in BUFFER before point; t means current buffer; nil for
966 BUFFER means discard it; 0 means discard and don't wait; and `(:file
967 FILE)', where FILE is a file name string, means that it should be
968 written to that file (if the file already exists it is overwritten).
969 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
970 REAL-BUFFER says what to do with standard output, as above,
971 while STDERR-FILE says what to do with standard error in the child.
972 STDERR-FILE may be nil (discard standard error output),
973 t (mix it with ordinary output), or a file name string.
975 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
976 Remaining args are passed to PROGRAM at startup as command args.
978 If BUFFER is 0, `call-process-region' returns immediately with value nil.
979 Otherwise it waits for PROGRAM to terminate
980 and returns a numeric exit status or a signal description string.
981 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
983 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
984 (ptrdiff_t nargs, Lisp_Object *args)
986 struct gcpro gcpro1;
987 Lisp_Object filename_string;
988 register Lisp_Object start, end;
989 ptrdiff_t count = SPECPDL_INDEX ();
990 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
991 Lisp_Object coding_systems;
992 Lisp_Object val, *args2;
993 ptrdiff_t i;
994 Lisp_Object tmpdir;
996 if (STRINGP (Vtemporary_file_directory))
997 tmpdir = Vtemporary_file_directory;
998 else
1000 char *outf;
1001 #ifndef DOS_NT
1002 outf = getenv ("TMPDIR");
1003 tmpdir = build_string (outf ? outf : "/tmp/");
1004 #else /* DOS_NT */
1005 if ((outf = egetenv ("TMPDIR"))
1006 || (outf = egetenv ("TMP"))
1007 || (outf = egetenv ("TEMP")))
1008 tmpdir = build_string (outf);
1009 else
1010 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
1011 #endif
1015 USE_SAFE_ALLOCA;
1016 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
1017 Lisp_Object encoded_tem;
1018 char *tempfile;
1020 #ifdef WINDOWSNT
1021 /* Cannot use the result of Fexpand_file_name, because it
1022 downcases the XXXXXX part of the pattern, and mktemp then
1023 doesn't recognize it. */
1024 if (!NILP (Vw32_downcase_file_names))
1026 Lisp_Object dirname = Ffile_name_directory (pattern);
1028 if (NILP (dirname))
1029 pattern = Vtemp_file_name_pattern;
1030 else
1031 pattern = concat2 (dirname, Vtemp_file_name_pattern);
1033 #endif
1035 encoded_tem = ENCODE_FILE (pattern);
1036 tempfile = SAFE_ALLOCA (SBYTES (encoded_tem) + 1);
1037 memcpy (tempfile, SDATA (encoded_tem), SBYTES (encoded_tem) + 1);
1038 coding_systems = Qt;
1040 #if defined HAVE_MKOSTEMP || defined HAVE_MKSTEMP
1042 int fd;
1044 block_input ();
1045 # ifdef HAVE_MKOSTEMP
1046 fd = mkostemp (tempfile, O_CLOEXEC);
1047 # else
1048 fd = mkstemp (tempfile);
1049 # endif
1050 unblock_input ();
1051 if (fd == -1)
1052 report_file_error ("Failed to open temporary file",
1053 Fcons (build_string (tempfile), Qnil));
1054 else
1055 emacs_close (fd);
1057 #else
1058 errno = 0;
1059 mktemp (tempfile);
1060 if (!*tempfile)
1062 if (!errno)
1063 errno = EEXIST;
1064 report_file_error ("Failed to open temporary file using pattern",
1065 Fcons (pattern, Qnil));
1067 #endif
1069 filename_string = build_string (tempfile);
1070 GCPRO1 (filename_string);
1071 SAFE_FREE ();
1074 start = args[0];
1075 end = args[1];
1076 /* Decide coding-system of the contents of the temporary file. */
1077 if (!NILP (Vcoding_system_for_write))
1078 val = Vcoding_system_for_write;
1079 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1080 val = Qraw_text;
1081 else
1083 USE_SAFE_ALLOCA;
1084 SAFE_NALLOCA (args2, 1, nargs + 1);
1085 args2[0] = Qcall_process_region;
1086 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1087 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1088 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1089 SAFE_FREE ();
1091 val = complement_process_encoding_system (val);
1094 ptrdiff_t count1 = SPECPDL_INDEX ();
1096 specbind (intern ("coding-system-for-write"), val);
1097 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1098 happen to get a ".Z" suffix. */
1099 specbind (intern ("file-name-handler-alist"), Qnil);
1100 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1102 unbind_to (count1, Qnil);
1105 /* Note that Fcall_process takes care of binding
1106 coding-system-for-read. */
1108 record_unwind_protect (delete_temp_file, filename_string);
1110 if (nargs > 3 && !NILP (args[3]))
1111 Fdelete_region (start, end);
1113 if (nargs > 3)
1115 args += 2;
1116 nargs -= 2;
1118 else
1120 args[0] = args[2];
1121 nargs = 2;
1123 args[1] = filename_string;
1125 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1128 #ifndef WINDOWSNT
1129 static int relocate_fd (int fd, int minfd);
1130 #endif
1132 static char **
1133 add_env (char **env, char **new_env, char *string)
1135 char **ep;
1136 bool ok = 1;
1137 if (string == NULL)
1138 return new_env;
1140 /* See if this string duplicates any string already in the env.
1141 If so, don't put it in.
1142 When an env var has multiple definitions,
1143 we keep the definition that comes first in process-environment. */
1144 for (ep = env; ok && ep != new_env; ep++)
1146 char *p = *ep, *q = string;
1147 while (ok)
1149 if (*q != *p)
1150 break;
1151 if (*q == 0)
1152 /* The string is a lone variable name; keep it for now, we
1153 will remove it later. It is a placeholder for a
1154 variable that is not to be included in the environment. */
1155 break;
1156 if (*q == '=')
1157 ok = 0;
1158 p++, q++;
1161 if (ok)
1162 *new_env++ = string;
1163 return new_env;
1166 /* This is the last thing run in a newly forked inferior
1167 either synchronous or asynchronous.
1168 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1169 Initialize inferior's priority, pgrp, connected dir and environment.
1170 then exec another program based on new_argv.
1172 If SET_PGRP, put the subprocess into a separate process group.
1174 CURRENT_DIR is an elisp string giving the path of the current
1175 directory the subprocess should have. Since we can't really signal
1176 a decent error from within the child, this should be verified as an
1177 executable directory by the parent. */
1180 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1181 Lisp_Object current_dir)
1183 char **env;
1184 char *pwd_var;
1185 #ifdef WINDOWSNT
1186 int cpid;
1187 HANDLE handles[3];
1188 #endif /* WINDOWSNT */
1190 pid_t pid = getpid ();
1192 /* Note that use of alloca is always safe here. It's obvious for systems
1193 that do not have true vfork or that have true (stack) alloca.
1194 If using vfork and C_ALLOCA (when Emacs used to include
1195 src/alloca.c) it is safe because that changes the superior's
1196 static variables as if the superior had done alloca and will be
1197 cleaned up in the usual way. */
1199 register char *temp;
1200 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1202 i = SBYTES (current_dir);
1203 #ifdef MSDOS
1204 /* MSDOS must have all environment variables malloc'ed, because
1205 low-level libc functions that launch subsidiary processes rely
1206 on that. */
1207 pwd_var = xmalloc (i + 6);
1208 #else
1209 pwd_var = alloca (i + 6);
1210 #endif
1211 temp = pwd_var + 4;
1212 memcpy (pwd_var, "PWD=", 4);
1213 memcpy (temp, SDATA (current_dir), i);
1214 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1215 temp[i] = 0;
1217 #ifndef DOS_NT
1218 /* We can't signal an Elisp error here; we're in a vfork. Since
1219 the callers check the current directory before forking, this
1220 should only return an error if the directory's permissions
1221 are changed between the check and this chdir, but we should
1222 at least check. */
1223 if (chdir (temp) < 0)
1224 _exit (EXIT_CANCELED);
1225 #else /* DOS_NT */
1226 /* Get past the drive letter, so that d:/ is left alone. */
1227 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1229 temp += 2;
1230 i -= 2;
1232 #endif /* DOS_NT */
1234 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1235 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1236 temp[--i] = 0;
1239 /* Set `env' to a vector of the strings in the environment. */
1241 register Lisp_Object tem;
1242 register char **new_env;
1243 char **p, **q;
1244 register int new_length;
1245 Lisp_Object display = Qnil;
1247 new_length = 0;
1249 for (tem = Vprocess_environment;
1250 CONSP (tem) && STRINGP (XCAR (tem));
1251 tem = XCDR (tem))
1253 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1254 && (SDATA (XCAR (tem)) [7] == '\0'
1255 || SDATA (XCAR (tem)) [7] == '='))
1256 /* DISPLAY is specified in process-environment. */
1257 display = Qt;
1258 new_length++;
1261 /* If not provided yet, use the frame's DISPLAY. */
1262 if (NILP (display))
1264 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1265 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1266 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1267 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1268 Vinitial_environment);
1269 if (STRINGP (tmp))
1271 display = tmp;
1272 new_length++;
1276 /* new_length + 2 to include PWD and terminating 0. */
1277 env = new_env = alloca ((new_length + 2) * sizeof *env);
1278 /* If we have a PWD envvar, pass one down,
1279 but with corrected value. */
1280 if (egetenv ("PWD"))
1281 *new_env++ = pwd_var;
1283 if (STRINGP (display))
1285 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1286 strcpy (vdata, "DISPLAY=");
1287 strcat (vdata, SSDATA (display));
1288 new_env = add_env (env, new_env, vdata);
1291 /* Overrides. */
1292 for (tem = Vprocess_environment;
1293 CONSP (tem) && STRINGP (XCAR (tem));
1294 tem = XCDR (tem))
1295 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1297 *new_env = 0;
1299 /* Remove variable names without values. */
1300 p = q = env;
1301 while (*p != 0)
1303 while (*q != 0 && strchr (*q, '=') == NULL)
1304 q++;
1305 *p = *q++;
1306 if (*p != 0)
1307 p++;
1312 #ifdef WINDOWSNT
1313 prepare_standard_handles (in, out, err, handles);
1314 set_process_dir (SDATA (current_dir));
1315 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1316 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1317 reset_standard_handles (in, out, err, handles);
1318 if (cpid == -1)
1319 /* An error occurred while trying to spawn the process. */
1320 report_file_error ("Spawning child process", Qnil);
1321 return cpid;
1323 #else /* not WINDOWSNT */
1324 /* Make sure that in, out, and err are not actually already in
1325 descriptors zero, one, or two; this could happen if Emacs is
1326 started with its standard in, out, or error closed, as might
1327 happen under X. */
1329 int oin = in, oout = out;
1331 /* We have to avoid relocating the same descriptor twice! */
1333 in = relocate_fd (in, 3);
1335 if (out == oin)
1336 out = in;
1337 else
1338 out = relocate_fd (out, 3);
1340 if (err == oin)
1341 err = in;
1342 else if (err == oout)
1343 err = out;
1344 else
1345 err = relocate_fd (err, 3);
1348 #ifndef MSDOS
1349 emacs_close (0);
1350 emacs_close (1);
1351 emacs_close (2);
1353 /* Redirect file descriptors and clear FD_CLOEXEC on the redirected ones. */
1354 dup2 (in, 0);
1355 dup2 (out, 1);
1356 dup2 (err, 2);
1358 emacs_close (in);
1359 if (out != in)
1360 emacs_close (out);
1361 if (err != in && err != out)
1362 emacs_close (err);
1364 setpgid (0, 0);
1365 tcsetpgrp (0, pid);
1367 execve (new_argv[0], new_argv, env);
1369 /* Don't output the program name here, as it can be arbitrarily long,
1370 and a long write from a vforked child to its parent can cause a
1371 deadlock. */
1372 emacs_perror ("child process");
1374 _exit (errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1376 #else /* MSDOS */
1377 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1378 xfree (pwd_var);
1379 if (pid == -1)
1380 /* An error occurred while trying to run the subprocess. */
1381 report_file_error ("Spawning child process", Qnil);
1382 return pid;
1383 #endif /* MSDOS */
1384 #endif /* not WINDOWSNT */
1387 #ifndef WINDOWSNT
1388 /* Move the file descriptor FD so that its number is not less than MINFD.
1389 If the file descriptor is moved at all, the original is freed. */
1390 static int
1391 relocate_fd (int fd, int minfd)
1393 if (fd >= minfd)
1394 return fd;
1395 else
1397 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1398 if (new == -1)
1400 emacs_perror ("while setting up child");
1401 _exit (EXIT_CANCELED);
1403 emacs_close (fd);
1404 return new;
1407 #endif /* not WINDOWSNT */
1409 static bool
1410 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1411 ptrdiff_t *valuelen, Lisp_Object env)
1413 for (; CONSP (env); env = XCDR (env))
1415 Lisp_Object entry = XCAR (env);
1416 if (STRINGP (entry)
1417 && SBYTES (entry) >= varlen
1418 #ifdef WINDOWSNT
1419 /* NT environment variables are case insensitive. */
1420 && ! strnicmp (SDATA (entry), var, varlen)
1421 #else /* not WINDOWSNT */
1422 && ! memcmp (SDATA (entry), var, varlen)
1423 #endif /* not WINDOWSNT */
1426 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1428 *value = SSDATA (entry) + (varlen + 1);
1429 *valuelen = SBYTES (entry) - (varlen + 1);
1430 return 1;
1432 else if (SBYTES (entry) == varlen)
1434 /* Lone variable names in Vprocess_environment mean that
1435 variable should be removed from the environment. */
1436 *value = NULL;
1437 return 1;
1441 return 0;
1444 static bool
1445 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1446 ptrdiff_t *valuelen, Lisp_Object frame)
1448 /* Try to find VAR in Vprocess_environment first. */
1449 if (getenv_internal_1 (var, varlen, value, valuelen,
1450 Vprocess_environment))
1451 return *value ? 1 : 0;
1453 /* For DISPLAY try to get the values from the frame or the initial env. */
1454 if (strcmp (var, "DISPLAY") == 0)
1456 Lisp_Object display
1457 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1458 if (STRINGP (display))
1460 *value = SSDATA (display);
1461 *valuelen = SBYTES (display);
1462 return 1;
1464 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1465 if (getenv_internal_1 (var, varlen, value, valuelen,
1466 Vinitial_environment))
1467 return *value ? 1 : 0;
1470 return 0;
1473 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1474 doc: /* Get the value of environment variable VARIABLE.
1475 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1476 the environment. Otherwise, value is a string.
1478 This function searches `process-environment' for VARIABLE.
1480 If optional parameter ENV is a list, then search this list instead of
1481 `process-environment', and return t when encountering a negative entry
1482 \(an entry for a variable with no value). */)
1483 (Lisp_Object variable, Lisp_Object env)
1485 char *value;
1486 ptrdiff_t valuelen;
1488 CHECK_STRING (variable);
1489 if (CONSP (env))
1491 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1492 &value, &valuelen, env))
1493 return value ? make_string (value, valuelen) : Qt;
1494 else
1495 return Qnil;
1497 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1498 &value, &valuelen, env))
1499 return make_string (value, valuelen);
1500 else
1501 return Qnil;
1504 /* A version of getenv that consults the Lisp environment lists,
1505 easily callable from C. */
1506 char *
1507 egetenv (const char *var)
1509 char *value;
1510 ptrdiff_t valuelen;
1512 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1513 return value;
1514 else
1515 return 0;
1519 /* This is run before init_cmdargs. */
1521 void
1522 init_callproc_1 (void)
1524 #ifdef HAVE_NS
1525 const char *etc_dir = ns_etc_directory ();
1526 const char *path_exec = ns_exec_path ();
1527 #endif
1529 Vdata_directory = decode_env_path ("EMACSDATA",
1530 #ifdef HAVE_NS
1531 etc_dir ? etc_dir :
1532 #endif
1533 PATH_DATA);
1534 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1536 Vdoc_directory = decode_env_path ("EMACSDOC",
1537 #ifdef HAVE_NS
1538 etc_dir ? etc_dir :
1539 #endif
1540 PATH_DOC);
1541 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1543 /* Check the EMACSPATH environment variable, defaulting to the
1544 PATH_EXEC path from epaths.h. */
1545 Vexec_path = decode_env_path ("EMACSPATH",
1546 #ifdef HAVE_NS
1547 path_exec ? path_exec :
1548 #endif
1549 PATH_EXEC);
1550 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1551 /* FIXME? For ns, path_exec should go at the front? */
1552 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1555 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1557 void
1558 init_callproc (void)
1560 char *data_dir = egetenv ("EMACSDATA");
1562 register char * sh;
1563 Lisp_Object tempdir;
1564 #ifdef HAVE_NS
1565 if (data_dir == 0)
1567 const char *etc_dir = ns_etc_directory ();
1568 if (etc_dir)
1570 data_dir = alloca (strlen (etc_dir) + 1);
1571 strcpy (data_dir, etc_dir);
1574 #endif
1576 if (!NILP (Vinstallation_directory))
1578 /* Add to the path the lib-src subdir of the installation dir. */
1579 Lisp_Object tem;
1580 tem = Fexpand_file_name (build_string ("lib-src"),
1581 Vinstallation_directory);
1582 #ifndef MSDOS
1583 /* MSDOS uses wrapped binaries, so don't do this. */
1584 if (NILP (Fmember (tem, Vexec_path)))
1586 #ifdef HAVE_NS
1587 const char *path_exec = ns_exec_path ();
1588 #endif
1589 Vexec_path = decode_env_path ("EMACSPATH",
1590 #ifdef HAVE_NS
1591 path_exec ? path_exec :
1592 #endif
1593 PATH_EXEC);
1594 Vexec_path = Fcons (tem, Vexec_path);
1595 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1598 Vexec_directory = Ffile_name_as_directory (tem);
1599 #endif /* not MSDOS */
1601 /* Maybe use ../etc as well as ../lib-src. */
1602 if (data_dir == 0)
1604 tem = Fexpand_file_name (build_string ("etc"),
1605 Vinstallation_directory);
1606 Vdoc_directory = Ffile_name_as_directory (tem);
1610 /* Look for the files that should be in etc. We don't use
1611 Vinstallation_directory, because these files are never installed
1612 near the executable, and they are never in the build
1613 directory when that's different from the source directory.
1615 Instead, if these files are not in the nominal place, we try the
1616 source directory. */
1617 if (data_dir == 0)
1619 Lisp_Object tem, tem1, srcdir;
1621 srcdir = Fexpand_file_name (build_string ("../src/"),
1622 build_string (PATH_DUMPLOADSEARCH));
1623 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1624 tem1 = Ffile_exists_p (tem);
1625 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1627 Lisp_Object newdir;
1628 newdir = Fexpand_file_name (build_string ("../etc/"),
1629 build_string (PATH_DUMPLOADSEARCH));
1630 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1631 tem1 = Ffile_exists_p (tem);
1632 if (!NILP (tem1))
1633 Vdata_directory = newdir;
1637 #ifndef CANNOT_DUMP
1638 if (initialized)
1639 #endif
1641 tempdir = Fdirectory_file_name (Vexec_directory);
1642 if (! file_accessible_directory_p (SSDATA (tempdir)))
1643 dir_warning ("arch-dependent data dir", Vexec_directory);
1646 tempdir = Fdirectory_file_name (Vdata_directory);
1647 if (! file_accessible_directory_p (SSDATA (tempdir)))
1648 dir_warning ("arch-independent data dir", Vdata_directory);
1650 sh = getenv ("SHELL");
1651 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1653 #ifdef DOS_NT
1654 Vshared_game_score_directory = Qnil;
1655 #else
1656 Vshared_game_score_directory = build_string (PATH_GAME);
1657 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1658 Vshared_game_score_directory = Qnil;
1659 #endif
1662 void
1663 set_initial_environment (void)
1665 char **envp;
1666 for (envp = environ; *envp; envp++)
1667 Vprocess_environment = Fcons (build_string (*envp),
1668 Vprocess_environment);
1669 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1670 to use `delete' and friends on process-environment. */
1671 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1674 void
1675 syms_of_callproc (void)
1677 #ifndef DOS_NT
1678 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1679 #elif defined (WINDOWSNT)
1680 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1681 #else
1682 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1683 #endif
1684 staticpro (&Vtemp_file_name_pattern);
1686 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1687 doc: /* File name to load inferior shells from.
1688 Initialized from the SHELL environment variable, or to a system-dependent
1689 default if SHELL is not set. */);
1691 DEFVAR_LISP ("exec-path", Vexec_path,
1692 doc: /* List of directories to search programs to run in subprocesses.
1693 Each element is a string (directory name) or nil (try default directory). */);
1695 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1696 doc: /* List of suffixes to try to find executable file names.
1697 Each element is a string. */);
1698 Vexec_suffixes = Qnil;
1700 DEFVAR_LISP ("exec-directory", Vexec_directory,
1701 doc: /* Directory for executables for Emacs to invoke.
1702 More generally, this includes any architecture-dependent files
1703 that are built and installed from the Emacs distribution. */);
1705 DEFVAR_LISP ("data-directory", Vdata_directory,
1706 doc: /* Directory of machine-independent files that come with GNU Emacs.
1707 These are files intended for Emacs to use while it runs. */);
1709 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1710 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1711 This is usually the same as `data-directory'. */);
1713 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1714 doc: /* For internal use by the build procedure only.
1715 This is the name of the directory in which the build procedure installed
1716 Emacs's info files; the default value for `Info-default-directory-list'
1717 includes this. */);
1718 Vconfigure_info_directory = build_string (PATH_INFO);
1720 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1721 doc: /* Directory of score files for games which come with GNU Emacs.
1722 If this variable is nil, then Emacs is unable to use a shared directory. */);
1723 #ifdef DOS_NT
1724 Vshared_game_score_directory = Qnil;
1725 #else
1726 Vshared_game_score_directory = build_string (PATH_GAME);
1727 #endif
1729 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1730 doc: /* List of environment variables inherited from the parent process.
1731 Each element should be a string of the form ENVVARNAME=VALUE.
1732 The elements must normally be decoded (using `locale-coding-system') for use. */);
1733 Vinitial_environment = Qnil;
1735 DEFVAR_LISP ("process-environment", Vprocess_environment,
1736 doc: /* List of overridden environment variables for subprocesses to inherit.
1737 Each element should be a string of the form ENVVARNAME=VALUE.
1739 Entries in this list take precedence to those in the frame-local
1740 environments. Therefore, let-binding `process-environment' is an easy
1741 way to temporarily change the value of an environment variable,
1742 irrespective of where it comes from. To use `process-environment' to
1743 remove an environment variable, include only its name in the list,
1744 without "=VALUE".
1746 This variable is set to nil when Emacs starts.
1748 If multiple entries define the same variable, the first one always
1749 takes precedence.
1751 Non-ASCII characters are encoded according to the initial value of
1752 `locale-coding-system', i.e. the elements must normally be decoded for
1753 use.
1755 See `setenv' and `getenv'. */);
1756 Vprocess_environment = Qnil;
1758 defsubr (&Scall_process);
1759 defsubr (&Sgetenv_internal);
1760 defsubr (&Scall_process_region);