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