Fix porting bug to older POSIXish platforms.
[emacs.git] / src / callproc.c
blobfacaac60f2ad3f5b600147a36facbc776f574f4d
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 list1 (BVAR (current_buffer, directory)));
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 list1 (DECODE_FILE (infile)));
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 int open_errno = errno;
423 output_file = DECODE_FILE (output_file);
424 report_file_errno ("Opening process output file",
425 list1 (output_file), open_errno);
427 if (STRINGP (error_file) || NILP (error_file))
428 output_to_buffer = 0;
431 /* Search for program; barf if not found. */
433 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
434 int ok;
436 GCPRO4 (infile, buffer, current_dir, error_file);
437 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
438 UNGCPRO;
439 if (ok < 0)
441 int openp_errno = errno;
442 emacs_close (filefd);
443 report_file_errno ("Searching for program",
444 list1 (args[0]), openp_errno);
448 /* If program file name starts with /: for quoting a magic name,
449 discard that. */
450 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
451 && SREF (path, 1) == ':')
452 path = Fsubstring (path, make_number (2), Qnil);
454 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
457 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
459 GCPRO5 (infile, buffer, current_dir, path, error_file);
460 if (nargs > 4)
462 ptrdiff_t i;
464 argument_coding.dst_multibyte = 0;
465 for (i = 4; i < nargs; i++)
467 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
468 if (CODING_REQUIRE_ENCODING (&argument_coding))
469 /* We must encode this argument. */
470 args[i] = encode_coding_string (&argument_coding, args[i], 1);
472 for (i = 4; i < nargs; i++)
473 new_argv[i - 3] = SSDATA (args[i]);
474 new_argv[i - 3] = 0;
476 else
477 new_argv[1] = 0;
478 if (STRING_MULTIBYTE (path))
479 path = ENCODE_FILE (path);
480 new_argv[0] = SSDATA (path);
481 UNGCPRO;
484 #ifdef MSDOS /* MW, July 1993 */
486 /* If we're redirecting STDOUT to a file, that file is already open
487 on fd_output. */
488 if (fd_output < 0)
490 if ((outf = egetenv ("TMPDIR")))
491 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
492 else
494 tempfile = alloca (20);
495 *tempfile = '\0';
497 dostounix_filename (tempfile, 0);
498 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
499 strcat (tempfile, "/");
500 strcat (tempfile, "detmp.XXX");
501 mktemp (tempfile);
502 outfilefd = emacs_open (tempfile, O_WRONLY | O_CREAT | O_TRUNC,
503 S_IREAD | S_IWRITE);
504 if (outfilefd < 0)
506 int open_errno = errno;
507 emacs_close (filefd);
508 report_file_errno ("Opening process output file",
509 list1 (build_string (tempfile)), open_errno);
512 else
513 outfilefd = fd_output;
514 fd0 = filefd;
515 fd1 = outfilefd;
516 #endif /* MSDOS */
518 if (INTEGERP (buffer))
520 fd0 = -1;
521 fd1 = emacs_open (NULL_DEVICE, O_WRONLY, 0);
523 else
525 #ifndef MSDOS
526 int fd[2];
527 if (emacs_pipe (fd) != 0)
529 int pipe_errno = errno;
530 emacs_close (filefd);
531 report_file_errno ("Creating process pipe", Qnil, pipe_errno);
533 fd0 = fd[0];
534 fd1 = fd[1];
535 #endif
539 int fd_error = fd1;
541 if (fd_output >= 0)
542 fd1 = fd_output;
544 if (NILP (error_file))
545 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
546 else if (STRINGP (error_file))
547 fd_error = emacs_open (SSDATA (error_file),
548 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
549 default_output_mode);
551 if (fd_error < 0)
553 int open_errno = errno;
554 emacs_close (filefd);
555 if (fd0 != filefd)
556 emacs_close (fd0);
557 if (fd1 >= 0)
558 emacs_close (fd1);
559 #ifdef MSDOS
560 unlink (tempfile);
561 #endif
562 if (NILP (error_file))
563 error_file = build_string (NULL_DEVICE);
564 else if (STRINGP (error_file))
565 error_file = DECODE_FILE (error_file);
566 report_file_errno ("Cannot redirect stderr",
567 list1 (error_file), open_errno);
570 #ifdef MSDOS /* MW, July 1993 */
571 /* Note that on MSDOS `child_setup' actually returns the child process
572 exit status, not its PID, so assign it to status below. */
573 pid = child_setup (filefd, outfilefd, fd_error, new_argv, 0, current_dir);
574 child_errno = errno;
576 emacs_close (outfilefd);
577 if (fd_error != outfilefd)
578 emacs_close (fd_error);
579 if (pid < 0)
581 synchronize_system_messages_locale ();
582 return
583 code_convert_string_norecord (build_string (strerror (child_errno)),
584 Vlocale_coding_system, 0);
586 status = pid;
587 fd1 = -1; /* No harm in closing that one! */
588 if (tempfile)
590 /* Since CRLF is converted to LF within `decode_coding', we
591 can always open a file with binary mode. */
592 fd0 = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
593 if (fd0 < 0)
595 int open_errno = errno;
596 unlink (tempfile);
597 emacs_close (filefd);
598 report_file_errno ("Cannot re-open temporary file",
599 list1 (build_string (tempfile)), open_errno);
602 else
603 fd0 = -1; /* We are not going to read from tempfile. */
604 #endif /* MSDOS */
606 /* Do the unwind-protect now, even though the pid is not known, so
607 that no storage allocation is done in the critical section.
608 The actual PID will be filled in during the critical section. */
609 synch_process_pid = 0;
610 synch_process_fd = fd0;
612 #ifdef MSDOS
613 /* MSDOS needs different cleanup information. */
614 record_unwind_protect (call_process_cleanup,
615 Fcons (Fcurrent_buffer (),
616 build_string (tempfile ? tempfile : "")));
617 #else
618 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
620 block_input ();
621 block_child_signal ();
623 #ifdef WINDOWSNT
624 pid = child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
625 /* We need to record the input file of this child, for when we are
626 called from call-process-region to create an async subprocess.
627 That's because call-process-region's unwind procedure will
628 attempt to delete the temporary input file, which will fail
629 because that file is still in use. Recording it with the child
630 will allow us to delete the file when the subprocess exits.
631 The second part of this is in delete_temp_file, q.v. */
632 if (pid > 0 && INTEGERP (buffer) && nargs >= 2 && !NILP (args[1]))
633 record_infile (pid, xstrdup (SSDATA (infile)));
634 #else /* not WINDOWSNT */
636 /* vfork, and prevent local vars from being clobbered by the vfork. */
638 Lisp_Object volatile buffer_volatile = buffer;
639 Lisp_Object volatile coding_systems_volatile = coding_systems;
640 Lisp_Object volatile current_dir_volatile = current_dir;
641 bool volatile display_p_volatile = display_p;
642 bool volatile output_to_buffer_volatile = output_to_buffer;
643 bool volatile sa_must_free_volatile = sa_must_free;
644 int volatile fd1_volatile = fd1;
645 int volatile fd_error_volatile = fd_error;
646 int volatile fd_output_volatile = fd_output;
647 int volatile filefd_volatile = filefd;
648 ptrdiff_t volatile count_volatile = count;
649 ptrdiff_t volatile sa_count_volatile = sa_count;
650 char **volatile new_argv_volatile = new_argv;
652 pid = vfork ();
653 child_errno = errno;
655 buffer = buffer_volatile;
656 coding_systems = coding_systems_volatile;
657 current_dir = current_dir_volatile;
658 display_p = display_p_volatile;
659 output_to_buffer = output_to_buffer_volatile;
660 sa_must_free = sa_must_free_volatile;
661 fd1 = fd1_volatile;
662 fd_error = fd_error_volatile;
663 fd_output = fd_output_volatile;
664 filefd = filefd_volatile;
665 count = count_volatile;
666 sa_count = sa_count_volatile;
667 new_argv = new_argv_volatile;
669 fd0 = synch_process_fd;
672 if (pid == 0)
674 unblock_child_signal ();
676 if (fd0 >= 0)
677 emacs_close (fd0);
679 setsid ();
681 /* Emacs ignores SIGPIPE, but the child should not. */
682 signal (SIGPIPE, SIG_DFL);
684 child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
687 #endif /* not WINDOWSNT */
689 child_errno = errno;
691 if (pid > 0)
693 if (INTEGERP (buffer))
694 record_deleted_pid (pid);
695 else
696 synch_process_pid = pid;
699 unblock_child_signal ();
700 unblock_input ();
702 /* The MSDOS case did this already. */
703 if (fd_error >= 0)
704 emacs_close (fd_error);
705 #endif /* not MSDOS */
707 /* Close most of our file descriptors, but not fd0
708 since we will use that to read input from. */
709 emacs_close (filefd);
710 if (fd_output >= 0)
711 emacs_close (fd_output);
712 if (fd1 >= 0 && fd1 != fd_error)
713 emacs_close (fd1);
716 if (pid < 0)
717 report_file_errno ("Doing vfork", Qnil, child_errno);
719 if (INTEGERP (buffer))
720 return unbind_to (count, Qnil);
722 if (BUFFERP (buffer))
723 Fset_buffer (buffer);
725 if (NILP (buffer))
727 /* If BUFFER is nil, we must read process output once and then
728 discard it, so setup coding system but with nil. */
729 setup_coding_system (Qnil, &process_coding);
730 process_coding.dst_multibyte = 0;
732 else
734 Lisp_Object val, *args2;
736 val = Qnil;
737 if (!NILP (Vcoding_system_for_read))
738 val = Vcoding_system_for_read;
739 else
741 if (EQ (coding_systems, Qt))
743 ptrdiff_t i;
745 SAFE_NALLOCA (args2, 1, nargs + 1);
746 args2[0] = Qcall_process;
747 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
748 coding_systems
749 = Ffind_operation_coding_system (nargs + 1, args2);
751 if (CONSP (coding_systems))
752 val = XCAR (coding_systems);
753 else if (CONSP (Vdefault_process_coding_system))
754 val = XCAR (Vdefault_process_coding_system);
755 else
756 val = Qnil;
758 Fcheck_coding_system (val);
759 /* In unibyte mode, character code conversion should not take
760 place but EOL conversion should. So, setup raw-text or one
761 of the subsidiary according to the information just setup. */
762 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
763 && !NILP (val))
764 val = raw_text_coding_system (val);
765 setup_coding_system (val, &process_coding);
766 process_coding.dst_multibyte
767 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
769 process_coding.src_multibyte = 0;
771 immediate_quit = 1;
772 QUIT;
774 if (output_to_buffer)
776 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
777 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
778 char buf[CALLPROC_BUFFER_SIZE_MAX];
779 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
780 int nread;
781 bool first = 1;
782 EMACS_INT total_read = 0;
783 int carryover = 0;
784 bool display_on_the_fly = display_p;
785 struct coding_system saved_coding;
787 saved_coding = process_coding;
788 while (1)
790 /* Repeatedly read until we've filled as much as possible
791 of the buffer size we have. But don't read
792 less than 1024--save that for the next bufferful. */
793 nread = carryover;
794 while (nread < bufsize - 1024)
796 int this_read = emacs_read (fd0, buf + nread,
797 bufsize - nread);
799 if (this_read < 0)
800 goto give_up;
802 if (this_read == 0)
804 process_coding.mode |= CODING_MODE_LAST_BLOCK;
805 break;
808 nread += this_read;
809 total_read += this_read;
811 if (display_on_the_fly)
812 break;
815 /* Now NREAD is the total amount of data in the buffer. */
816 immediate_quit = 0;
818 if (!NILP (buffer))
820 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
821 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
822 insert_1_both (buf, nread, nread, 0, 1, 0);
823 else
824 { /* We have to decode the input. */
825 Lisp_Object curbuf;
826 ptrdiff_t count1 = SPECPDL_INDEX ();
828 XSETBUFFER (curbuf, current_buffer);
829 /* We cannot allow after-change-functions be run
830 during decoding, because that might modify the
831 buffer, while we rely on process_coding.produced to
832 faithfully reflect inserted text until we
833 TEMP_SET_PT_BOTH below. */
834 specbind (Qinhibit_modification_hooks, Qt);
835 decode_coding_c_string (&process_coding,
836 (unsigned char *) buf, nread, curbuf);
837 unbind_to (count1, Qnil);
838 if (display_on_the_fly
839 && CODING_REQUIRE_DETECTION (&saved_coding)
840 && ! CODING_REQUIRE_DETECTION (&process_coding))
842 /* We have detected some coding system. But,
843 there's a possibility that the detection was
844 done by insufficient data. So, we give up
845 displaying on the fly. */
846 if (process_coding.produced > 0)
847 del_range_2 (process_coding.dst_pos,
848 process_coding.dst_pos_byte,
849 process_coding.dst_pos
850 + process_coding.produced_char,
851 process_coding.dst_pos_byte
852 + process_coding.produced, 0);
853 display_on_the_fly = 0;
854 process_coding = saved_coding;
855 carryover = nread;
856 /* This is to make the above condition always
857 fails in the future. */
858 saved_coding.common_flags
859 &= ~CODING_REQUIRE_DETECTION_MASK;
860 continue;
863 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
864 PT_BYTE + process_coding.produced);
865 carryover = process_coding.carryover_bytes;
866 if (carryover > 0)
867 memcpy (buf, process_coding.carryover,
868 process_coding.carryover_bytes);
872 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
873 break;
875 /* Make the buffer bigger as we continue to read more data,
876 but not past CALLPROC_BUFFER_SIZE_MAX. */
877 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
878 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
879 bufsize = CALLPROC_BUFFER_SIZE_MAX;
881 if (display_p)
883 if (first)
884 prepare_menu_bars ();
885 first = 0;
886 redisplay_preserve_echo_area (1);
887 /* This variable might have been set to 0 for code
888 detection. In that case, we set it back to 1 because
889 we should have already detected a coding system. */
890 display_on_the_fly = 1;
892 immediate_quit = 1;
893 QUIT;
895 give_up: ;
897 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
898 /* If the caller required, let the buffer inherit the
899 coding-system used to decode the process output. */
900 if (inherit_process_coding_system)
901 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
902 make_number (total_read));
905 #ifndef MSDOS
906 /* Wait for it to terminate, unless it already has. */
907 wait_for_termination (pid, &status, !output_to_buffer);
908 #endif
910 immediate_quit = 0;
912 /* Don't kill any children that the subprocess may have left behind
913 when exiting. */
914 synch_process_pid = 0;
916 SAFE_FREE ();
917 unbind_to (count, Qnil);
919 if (WIFSIGNALED (status))
921 const char *signame;
923 synchronize_system_messages_locale ();
924 signame = strsignal (WTERMSIG (status));
926 if (signame == 0)
927 signame = "unknown";
929 return code_convert_string_norecord (build_string (signame),
930 Vlocale_coding_system, 0);
933 eassert (WIFEXITED (status));
934 return make_number (WEXITSTATUS (status));
937 static Lisp_Object
938 delete_temp_file (Lisp_Object name)
940 /* Suppress jka-compr handling, etc. */
941 ptrdiff_t count = SPECPDL_INDEX ();
942 specbind (intern ("file-name-handler-alist"), Qnil);
943 #ifdef WINDOWSNT
944 /* If this is called when the subprocess didn't exit yet, the
945 attempt to delete its input file will fail. In that case, we
946 schedule the file for deletion when the subprocess exits. This
947 is the 2nd part of handling this situation; see the call to
948 record_infile in call-process above, for the first part. */
949 if (!internal_delete_file (name))
951 Lisp_Object encoded_file = ENCODE_FILE (name);
953 record_pending_deletion (SSDATA (encoded_file));
955 #else
956 internal_delete_file (name);
957 #endif
958 unbind_to (count, Qnil);
959 return Qnil;
962 /* Create a temporary file suitable for storing the input data of
963 call-process-region. NARGS and ARGS are the same as for
964 call-process-region. */
966 static Lisp_Object
967 create_temp_file (ptrdiff_t nargs, Lisp_Object *args)
969 struct gcpro gcpro1;
970 Lisp_Object filename_string;
971 Lisp_Object val, start, end;
972 Lisp_Object tmpdir;
974 if (STRINGP (Vtemporary_file_directory))
975 tmpdir = Vtemporary_file_directory;
976 else
978 char *outf;
979 #ifndef DOS_NT
980 outf = getenv ("TMPDIR");
981 tmpdir = build_string (outf ? outf : "/tmp/");
982 #else /* DOS_NT */
983 if ((outf = egetenv ("TMPDIR"))
984 || (outf = egetenv ("TMP"))
985 || (outf = egetenv ("TEMP")))
986 tmpdir = build_string (outf);
987 else
988 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
989 #endif
993 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
994 char *tempfile;
996 #ifdef WINDOWSNT
997 /* Cannot use the result of Fexpand_file_name, because it
998 downcases the XXXXXX part of the pattern, and mktemp then
999 doesn't recognize it. */
1000 if (!NILP (Vw32_downcase_file_names))
1002 Lisp_Object dirname = Ffile_name_directory (pattern);
1004 if (NILP (dirname))
1005 pattern = Vtemp_file_name_pattern;
1006 else
1007 pattern = concat2 (dirname, Vtemp_file_name_pattern);
1009 #endif
1011 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
1012 GCPRO1 (filename_string);
1013 tempfile = SSDATA (filename_string);
1016 int fd;
1018 #ifdef HAVE_MKOSTEMP
1019 fd = mkostemp (tempfile, O_CLOEXEC);
1020 #elif defined HAVE_MKSTEMP
1021 fd = mkstemp (tempfile);
1022 #else
1023 errno = EEXIST;
1024 mktemp (tempfile);
1025 /* INT_MAX denotes success, because close (INT_MAX) does nothing. */
1026 fd = *tempfile ? INT_MAX : -1;
1027 #endif
1028 if (fd < 0)
1029 report_file_error ("Failed to open temporary file using pattern",
1030 list1 (pattern));
1031 emacs_close (fd);
1034 record_unwind_protect (delete_temp_file, filename_string);
1037 start = args[0];
1038 end = args[1];
1039 /* Decide coding-system of the contents of the temporary file. */
1040 if (!NILP (Vcoding_system_for_write))
1041 val = Vcoding_system_for_write;
1042 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1043 val = Qraw_text;
1044 else
1046 Lisp_Object coding_systems;
1047 Lisp_Object *args2;
1048 USE_SAFE_ALLOCA;
1049 SAFE_NALLOCA (args2, 1, nargs + 1);
1050 args2[0] = Qcall_process_region;
1051 memcpy (args2 + 1, args, nargs * sizeof *args);
1052 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1053 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1054 SAFE_FREE ();
1056 val = complement_process_encoding_system (val);
1059 ptrdiff_t count1 = SPECPDL_INDEX ();
1061 specbind (intern ("coding-system-for-write"), val);
1062 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1063 happen to get a ".Z" suffix. */
1064 specbind (intern ("file-name-handler-alist"), Qnil);
1065 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1067 unbind_to (count1, Qnil);
1070 /* Note that Fcall_process takes care of binding
1071 coding-system-for-read. */
1073 RETURN_UNGCPRO (filename_string);
1076 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1077 3, MANY, 0,
1078 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1079 The remaining arguments are optional.
1080 Delete the text if fourth arg DELETE is non-nil.
1082 Insert output in BUFFER before point; t means current buffer; nil for
1083 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1084 FILE)', where FILE is a file name string, means that it should be
1085 written to that file (if the file already exists it is overwritten).
1086 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1087 REAL-BUFFER says what to do with standard output, as above,
1088 while STDERR-FILE says what to do with standard error in the child.
1089 STDERR-FILE may be nil (discard standard error output),
1090 t (mix it with ordinary output), or a file name string.
1092 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1093 Remaining args are passed to PROGRAM at startup as command args.
1095 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1096 Otherwise it waits for PROGRAM to terminate
1097 and returns a numeric exit status or a signal description string.
1098 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1100 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1101 (ptrdiff_t nargs, Lisp_Object *args)
1103 struct gcpro gcpro1;
1104 Lisp_Object filename_string;
1105 ptrdiff_t count = SPECPDL_INDEX ();
1106 Lisp_Object start = args[0];
1107 Lisp_Object end = args[1];
1108 bool empty_input;
1110 if (STRINGP (start))
1111 empty_input = SCHARS (start) == 0;
1112 else if (NILP (start))
1113 empty_input = BEG == Z;
1114 else
1116 validate_region (&args[0], &args[1]);
1117 start = args[0];
1118 end = args[1];
1119 empty_input = XINT (start) == XINT (end);
1122 filename_string = (empty_input
1123 ? build_string (NULL_DEVICE)
1124 : create_temp_file (nargs, args));
1125 GCPRO1 (filename_string);
1127 if (nargs > 3 && !NILP (args[3]))
1128 Fdelete_region (start, end);
1130 if (nargs > 3)
1132 args += 2;
1133 nargs -= 2;
1135 else
1137 args[0] = args[2];
1138 nargs = 2;
1140 args[1] = filename_string;
1142 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1145 #ifndef WINDOWSNT
1146 static int relocate_fd (int fd, int minfd);
1147 #endif
1149 static char **
1150 add_env (char **env, char **new_env, char *string)
1152 char **ep;
1153 bool ok = 1;
1154 if (string == NULL)
1155 return new_env;
1157 /* See if this string duplicates any string already in the env.
1158 If so, don't put it in.
1159 When an env var has multiple definitions,
1160 we keep the definition that comes first in process-environment. */
1161 for (ep = env; ok && ep != new_env; ep++)
1163 char *p = *ep, *q = string;
1164 while (ok)
1166 if (*q != *p)
1167 break;
1168 if (*q == 0)
1169 /* The string is a lone variable name; keep it for now, we
1170 will remove it later. It is a placeholder for a
1171 variable that is not to be included in the environment. */
1172 break;
1173 if (*q == '=')
1174 ok = 0;
1175 p++, q++;
1178 if (ok)
1179 *new_env++ = string;
1180 return new_env;
1183 /* This is the last thing run in a newly forked inferior
1184 either synchronous or asynchronous.
1185 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1186 Initialize inferior's priority, pgrp, connected dir and environment.
1187 then exec another program based on new_argv.
1189 If SET_PGRP, put the subprocess into a separate process group.
1191 CURRENT_DIR is an elisp string giving the path of the current
1192 directory the subprocess should have. Since we can't really signal
1193 a decent error from within the child, this should be verified as an
1194 executable directory by the parent. */
1197 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1198 Lisp_Object current_dir)
1200 char **env;
1201 char *pwd_var;
1202 #ifdef WINDOWSNT
1203 int cpid;
1204 HANDLE handles[3];
1205 #endif /* WINDOWSNT */
1207 pid_t pid = getpid ();
1209 /* Note that use of alloca is always safe here. It's obvious for systems
1210 that do not have true vfork or that have true (stack) alloca.
1211 If using vfork and C_ALLOCA (when Emacs used to include
1212 src/alloca.c) it is safe because that changes the superior's
1213 static variables as if the superior had done alloca and will be
1214 cleaned up in the usual way. */
1216 register char *temp;
1217 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1219 i = SBYTES (current_dir);
1220 #ifdef MSDOS
1221 /* MSDOS must have all environment variables malloc'ed, because
1222 low-level libc functions that launch subsidiary processes rely
1223 on that. */
1224 pwd_var = xmalloc (i + 6);
1225 #else
1226 pwd_var = alloca (i + 6);
1227 #endif
1228 temp = pwd_var + 4;
1229 memcpy (pwd_var, "PWD=", 4);
1230 memcpy (temp, SDATA (current_dir), i);
1231 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1232 temp[i] = 0;
1234 #ifndef DOS_NT
1235 /* We can't signal an Elisp error here; we're in a vfork. Since
1236 the callers check the current directory before forking, this
1237 should only return an error if the directory's permissions
1238 are changed between the check and this chdir, but we should
1239 at least check. */
1240 if (chdir (temp) < 0)
1241 _exit (EXIT_CANCELED);
1242 #else /* DOS_NT */
1243 /* Get past the drive letter, so that d:/ is left alone. */
1244 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1246 temp += 2;
1247 i -= 2;
1249 #endif /* DOS_NT */
1251 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1252 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1253 temp[--i] = 0;
1256 /* Set `env' to a vector of the strings in the environment. */
1258 register Lisp_Object tem;
1259 register char **new_env;
1260 char **p, **q;
1261 register int new_length;
1262 Lisp_Object display = Qnil;
1264 new_length = 0;
1266 for (tem = Vprocess_environment;
1267 CONSP (tem) && STRINGP (XCAR (tem));
1268 tem = XCDR (tem))
1270 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1271 && (SDATA (XCAR (tem)) [7] == '\0'
1272 || SDATA (XCAR (tem)) [7] == '='))
1273 /* DISPLAY is specified in process-environment. */
1274 display = Qt;
1275 new_length++;
1278 /* If not provided yet, use the frame's DISPLAY. */
1279 if (NILP (display))
1281 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1282 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1283 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1284 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1285 Vinitial_environment);
1286 if (STRINGP (tmp))
1288 display = tmp;
1289 new_length++;
1293 /* new_length + 2 to include PWD and terminating 0. */
1294 env = new_env = alloca ((new_length + 2) * sizeof *env);
1295 /* If we have a PWD envvar, pass one down,
1296 but with corrected value. */
1297 if (egetenv ("PWD"))
1298 *new_env++ = pwd_var;
1300 if (STRINGP (display))
1302 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1303 strcpy (vdata, "DISPLAY=");
1304 strcat (vdata, SSDATA (display));
1305 new_env = add_env (env, new_env, vdata);
1308 /* Overrides. */
1309 for (tem = Vprocess_environment;
1310 CONSP (tem) && STRINGP (XCAR (tem));
1311 tem = XCDR (tem))
1312 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1314 *new_env = 0;
1316 /* Remove variable names without values. */
1317 p = q = env;
1318 while (*p != 0)
1320 while (*q != 0 && strchr (*q, '=') == NULL)
1321 q++;
1322 *p = *q++;
1323 if (*p != 0)
1324 p++;
1329 #ifdef WINDOWSNT
1330 prepare_standard_handles (in, out, err, handles);
1331 set_process_dir (SDATA (current_dir));
1332 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1333 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1334 reset_standard_handles (in, out, err, handles);
1335 if (cpid == -1)
1336 /* An error occurred while trying to spawn the process. */
1337 report_file_error ("Spawning child process", Qnil);
1338 return cpid;
1340 #else /* not WINDOWSNT */
1341 /* Make sure that in, out, and err are not actually already in
1342 descriptors zero, one, or two; this could happen if Emacs is
1343 started with its standard in, out, or error closed, as might
1344 happen under X. */
1346 int oin = in, oout = out;
1348 /* We have to avoid relocating the same descriptor twice! */
1350 in = relocate_fd (in, 3);
1352 if (out == oin)
1353 out = in;
1354 else
1355 out = relocate_fd (out, 3);
1357 if (err == oin)
1358 err = in;
1359 else if (err == oout)
1360 err = out;
1361 else
1362 err = relocate_fd (err, 3);
1365 #ifndef MSDOS
1366 /* Redirect file descriptors and clear the close-on-exec flag on the
1367 redirected ones. IN, OUT, and ERR are close-on-exec so they
1368 need not be closed explicitly. */
1369 dup2 (in, 0);
1370 dup2 (out, 1);
1371 dup2 (err, 2);
1373 setpgid (0, 0);
1374 tcsetpgrp (0, pid);
1376 execve (new_argv[0], new_argv, env);
1378 /* Don't output the program name here, as it can be arbitrarily long,
1379 and a long write from a vforked child to its parent can cause a
1380 deadlock. */
1381 emacs_perror ("child process");
1383 _exit (errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1385 #else /* MSDOS */
1386 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1387 xfree (pwd_var);
1388 if (pid == -1)
1389 /* An error occurred while trying to run the subprocess. */
1390 report_file_error ("Spawning child process", Qnil);
1391 return pid;
1392 #endif /* MSDOS */
1393 #endif /* not WINDOWSNT */
1396 #ifndef WINDOWSNT
1397 /* Move the file descriptor FD so that its number is not less than MINFD.
1398 If the file descriptor is moved at all, the original is closed on MSDOS,
1399 but not elsewhere as the caller will close it anyway. */
1400 static int
1401 relocate_fd (int fd, int minfd)
1403 if (fd >= minfd)
1404 return fd;
1405 else
1407 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1408 if (new == -1)
1410 emacs_perror ("while setting up child");
1411 _exit (EXIT_CANCELED);
1413 #ifdef MSDOS
1414 emacs_close (fd);
1415 #endif
1416 return new;
1419 #endif /* not WINDOWSNT */
1421 static bool
1422 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1423 ptrdiff_t *valuelen, Lisp_Object env)
1425 for (; CONSP (env); env = XCDR (env))
1427 Lisp_Object entry = XCAR (env);
1428 if (STRINGP (entry)
1429 && SBYTES (entry) >= varlen
1430 #ifdef WINDOWSNT
1431 /* NT environment variables are case insensitive. */
1432 && ! strnicmp (SDATA (entry), var, varlen)
1433 #else /* not WINDOWSNT */
1434 && ! memcmp (SDATA (entry), var, varlen)
1435 #endif /* not WINDOWSNT */
1438 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1440 *value = SSDATA (entry) + (varlen + 1);
1441 *valuelen = SBYTES (entry) - (varlen + 1);
1442 return 1;
1444 else if (SBYTES (entry) == varlen)
1446 /* Lone variable names in Vprocess_environment mean that
1447 variable should be removed from the environment. */
1448 *value = NULL;
1449 return 1;
1453 return 0;
1456 static bool
1457 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1458 ptrdiff_t *valuelen, Lisp_Object frame)
1460 /* Try to find VAR in Vprocess_environment first. */
1461 if (getenv_internal_1 (var, varlen, value, valuelen,
1462 Vprocess_environment))
1463 return *value ? 1 : 0;
1465 /* For DISPLAY try to get the values from the frame or the initial env. */
1466 if (strcmp (var, "DISPLAY") == 0)
1468 Lisp_Object display
1469 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1470 if (STRINGP (display))
1472 *value = SSDATA (display);
1473 *valuelen = SBYTES (display);
1474 return 1;
1476 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1477 if (getenv_internal_1 (var, varlen, value, valuelen,
1478 Vinitial_environment))
1479 return *value ? 1 : 0;
1482 return 0;
1485 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1486 doc: /* Get the value of environment variable VARIABLE.
1487 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1488 the environment. Otherwise, value is a string.
1490 This function searches `process-environment' for VARIABLE.
1492 If optional parameter ENV is a list, then search this list instead of
1493 `process-environment', and return t when encountering a negative entry
1494 \(an entry for a variable with no value). */)
1495 (Lisp_Object variable, Lisp_Object env)
1497 char *value;
1498 ptrdiff_t valuelen;
1500 CHECK_STRING (variable);
1501 if (CONSP (env))
1503 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1504 &value, &valuelen, env))
1505 return value ? make_string (value, valuelen) : Qt;
1506 else
1507 return Qnil;
1509 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1510 &value, &valuelen, env))
1511 return make_string (value, valuelen);
1512 else
1513 return Qnil;
1516 /* A version of getenv that consults the Lisp environment lists,
1517 easily callable from C. */
1518 char *
1519 egetenv (const char *var)
1521 char *value;
1522 ptrdiff_t valuelen;
1524 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1525 return value;
1526 else
1527 return 0;
1531 /* This is run before init_cmdargs. */
1533 void
1534 init_callproc_1 (void)
1536 #ifdef HAVE_NS
1537 const char *etc_dir = ns_etc_directory ();
1538 const char *path_exec = ns_exec_path ();
1539 #endif
1541 Vdata_directory = decode_env_path ("EMACSDATA",
1542 #ifdef HAVE_NS
1543 etc_dir ? etc_dir :
1544 #endif
1545 PATH_DATA);
1546 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1548 Vdoc_directory = decode_env_path ("EMACSDOC",
1549 #ifdef HAVE_NS
1550 etc_dir ? etc_dir :
1551 #endif
1552 PATH_DOC);
1553 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1555 /* Check the EMACSPATH environment variable, defaulting to the
1556 PATH_EXEC path from epaths.h. */
1557 Vexec_path = decode_env_path ("EMACSPATH",
1558 #ifdef HAVE_NS
1559 path_exec ? path_exec :
1560 #endif
1561 PATH_EXEC);
1562 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1563 /* FIXME? For ns, path_exec should go at the front? */
1564 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1567 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1569 void
1570 init_callproc (void)
1572 char *data_dir = egetenv ("EMACSDATA");
1574 register char * sh;
1575 Lisp_Object tempdir;
1576 #ifdef HAVE_NS
1577 if (data_dir == 0)
1579 const char *etc_dir = ns_etc_directory ();
1580 if (etc_dir)
1582 data_dir = alloca (strlen (etc_dir) + 1);
1583 strcpy (data_dir, etc_dir);
1586 #endif
1588 if (!NILP (Vinstallation_directory))
1590 /* Add to the path the lib-src subdir of the installation dir. */
1591 Lisp_Object tem;
1592 tem = Fexpand_file_name (build_string ("lib-src"),
1593 Vinstallation_directory);
1594 #ifndef MSDOS
1595 /* MSDOS uses wrapped binaries, so don't do this. */
1596 if (NILP (Fmember (tem, Vexec_path)))
1598 #ifdef HAVE_NS
1599 const char *path_exec = ns_exec_path ();
1600 #endif
1601 Vexec_path = decode_env_path ("EMACSPATH",
1602 #ifdef HAVE_NS
1603 path_exec ? path_exec :
1604 #endif
1605 PATH_EXEC);
1606 Vexec_path = Fcons (tem, Vexec_path);
1607 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1610 Vexec_directory = Ffile_name_as_directory (tem);
1611 #endif /* not MSDOS */
1613 /* Maybe use ../etc as well as ../lib-src. */
1614 if (data_dir == 0)
1616 tem = Fexpand_file_name (build_string ("etc"),
1617 Vinstallation_directory);
1618 Vdoc_directory = Ffile_name_as_directory (tem);
1622 /* Look for the files that should be in etc. We don't use
1623 Vinstallation_directory, because these files are never installed
1624 near the executable, and they are never in the build
1625 directory when that's different from the source directory.
1627 Instead, if these files are not in the nominal place, we try the
1628 source directory. */
1629 if (data_dir == 0)
1631 Lisp_Object tem, tem1, srcdir;
1633 srcdir = Fexpand_file_name (build_string ("../src/"),
1634 build_string (PATH_DUMPLOADSEARCH));
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))
1639 Lisp_Object newdir;
1640 newdir = Fexpand_file_name (build_string ("../etc/"),
1641 build_string (PATH_DUMPLOADSEARCH));
1642 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1643 tem1 = Ffile_exists_p (tem);
1644 if (!NILP (tem1))
1645 Vdata_directory = newdir;
1649 #ifndef CANNOT_DUMP
1650 if (initialized)
1651 #endif
1653 tempdir = Fdirectory_file_name (Vexec_directory);
1654 if (! file_accessible_directory_p (SSDATA (tempdir)))
1655 dir_warning ("arch-dependent data dir", Vexec_directory);
1658 tempdir = Fdirectory_file_name (Vdata_directory);
1659 if (! file_accessible_directory_p (SSDATA (tempdir)))
1660 dir_warning ("arch-independent data dir", Vdata_directory);
1662 sh = getenv ("SHELL");
1663 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1665 #ifdef DOS_NT
1666 Vshared_game_score_directory = Qnil;
1667 #else
1668 Vshared_game_score_directory = build_string (PATH_GAME);
1669 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1670 Vshared_game_score_directory = Qnil;
1671 #endif
1674 void
1675 set_initial_environment (void)
1677 char **envp;
1678 for (envp = environ; *envp; envp++)
1679 Vprocess_environment = Fcons (build_string (*envp),
1680 Vprocess_environment);
1681 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1682 to use `delete' and friends on process-environment. */
1683 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1686 void
1687 syms_of_callproc (void)
1689 #ifndef DOS_NT
1690 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1691 #elif defined (WINDOWSNT)
1692 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1693 #else
1694 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1695 #endif
1696 staticpro (&Vtemp_file_name_pattern);
1698 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1699 doc: /* File name to load inferior shells from.
1700 Initialized from the SHELL environment variable, or to a system-dependent
1701 default if SHELL is not set. */);
1703 DEFVAR_LISP ("exec-path", Vexec_path,
1704 doc: /* List of directories to search programs to run in subprocesses.
1705 Each element is a string (directory name) or nil (try default directory). */);
1707 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1708 doc: /* List of suffixes to try to find executable file names.
1709 Each element is a string. */);
1710 Vexec_suffixes = Qnil;
1712 DEFVAR_LISP ("exec-directory", Vexec_directory,
1713 doc: /* Directory for executables for Emacs to invoke.
1714 More generally, this includes any architecture-dependent files
1715 that are built and installed from the Emacs distribution. */);
1717 DEFVAR_LISP ("data-directory", Vdata_directory,
1718 doc: /* Directory of machine-independent files that come with GNU Emacs.
1719 These are files intended for Emacs to use while it runs. */);
1721 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1722 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1723 This is usually the same as `data-directory'. */);
1725 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1726 doc: /* For internal use by the build procedure only.
1727 This is the name of the directory in which the build procedure installed
1728 Emacs's info files; the default value for `Info-default-directory-list'
1729 includes this. */);
1730 Vconfigure_info_directory = build_string (PATH_INFO);
1732 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1733 doc: /* Directory of score files for games which come with GNU Emacs.
1734 If this variable is nil, then Emacs is unable to use a shared directory. */);
1735 #ifdef DOS_NT
1736 Vshared_game_score_directory = Qnil;
1737 #else
1738 Vshared_game_score_directory = build_string (PATH_GAME);
1739 #endif
1741 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1742 doc: /* List of environment variables inherited from the parent process.
1743 Each element should be a string of the form ENVVARNAME=VALUE.
1744 The elements must normally be decoded (using `locale-coding-system') for use. */);
1745 Vinitial_environment = Qnil;
1747 DEFVAR_LISP ("process-environment", Vprocess_environment,
1748 doc: /* List of overridden environment variables for subprocesses to inherit.
1749 Each element should be a string of the form ENVVARNAME=VALUE.
1751 Entries in this list take precedence to those in the frame-local
1752 environments. Therefore, let-binding `process-environment' is an easy
1753 way to temporarily change the value of an environment variable,
1754 irrespective of where it comes from. To use `process-environment' to
1755 remove an environment variable, include only its name in the list,
1756 without "=VALUE".
1758 This variable is set to nil when Emacs starts.
1760 If multiple entries define the same variable, the first one always
1761 takes precedence.
1763 Non-ASCII characters are encoded according to the initial value of
1764 `locale-coding-system', i.e. the elements must normally be decoded for
1765 use.
1767 See `setenv' and `getenv'. */);
1768 Vprocess_environment = Qnil;
1770 defsubr (&Scall_process);
1771 defsubr (&Sgetenv_internal);
1772 defsubr (&Scall_process_region);