Merge from origin/emacs-25
[emacs.git] / src / callproc.c
blob8ed28556e0d25185cfe4d74472cb3c460fa17c3d
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2016 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 (at
11 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 <stdlib.h>
26 #include <sys/types.h>
27 #include <unistd.h>
29 #include <sys/file.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 #ifdef WINDOWSNT
35 #define NOMINMAX
36 #include <sys/socket.h> /* for fcntl */
37 #include <windows.h>
38 #include "w32.h"
39 #define _P_NOWAIT 1 /* from process.h */
40 #endif
42 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
43 #include <sys/stat.h>
44 #include <sys/param.h>
45 #endif /* MSDOS */
47 #include "commands.h"
48 #include "buffer.h"
49 #include "coding.h"
50 #include <epaths.h>
51 #include "process.h"
52 #include "syssignal.h"
53 #include "syswait.h"
54 #include "blockinput.h"
55 #include "frame.h"
57 #ifdef MSDOS
58 #include "msdos.h"
59 #endif
61 #ifdef HAVE_NS
62 #include "nsterm.h"
63 #endif
65 /* Pattern used by call-process-region to make temp files. */
66 static Lisp_Object Vtemp_file_name_pattern;
68 /* The next two variables are used while record-unwind-protect is in place
69 during call-process for a subprocess for which record_deleted_pid has
70 not yet been called. At other times, synch_process_pid is zero and
71 synch_process_tempfile's contents are irrelevant. Doing this via static
72 C variables is more convenient than putting them into the arguments
73 of record-unwind-protect, as they need to be updated at randomish
74 times in the code, and Lisp cannot always store these values as
75 Emacs integers. It's safe to use static variables here, as the
76 code is never invoked reentrantly. */
78 /* If nonzero, a process-ID that has not been reaped. */
79 static pid_t synch_process_pid;
81 /* If a string, the name of a temp file that has not been removed. */
82 #ifdef MSDOS
83 static Lisp_Object synch_process_tempfile;
84 #else
85 # define synch_process_tempfile make_number (0)
86 #endif
88 /* Indexes of file descriptors that need closing on call_process_kill. */
89 enum
91 /* The subsidiary process's stdout and stderr. stdin is handled
92 separately, in either Fcall_process_region or create_temp_file. */
93 CALLPROC_STDOUT, CALLPROC_STDERR,
95 /* How to read from a pipe (or substitute) from the subsidiary process. */
96 CALLPROC_PIPEREAD,
98 /* A bound on the number of file descriptors. */
99 CALLPROC_FDS
102 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
104 /* Return the current buffer's working directory, or the home
105 directory if it's unreachable, as a string suitable for a system call.
106 Signal an error if the result would not be an accessible directory. */
108 Lisp_Object
109 encode_current_directory (void)
111 Lisp_Object dir;
113 dir = BVAR (current_buffer, directory);
115 dir = Funhandled_file_name_directory (dir);
117 /* If the file name handler says that dir is unreachable, use
118 a sensible default. */
119 if (NILP (dir))
120 dir = build_string ("~");
122 dir = expand_and_dir_to_file (dir, Qnil);
124 if (NILP (Ffile_accessible_directory_p (dir)))
125 report_file_error ("Setting current directory",
126 BVAR (current_buffer, directory));
128 /* Remove "/:" from DIR and encode it. */
129 dir = ENCODE_FILE (remove_slash_colon (dir));
131 if (! file_accessible_directory_p (dir))
132 report_file_error ("Setting current directory",
133 BVAR (current_buffer, directory));
135 return dir;
138 /* If P is reapable, record it as a deleted process and kill it.
139 Do this in a critical section. Unless PID is wedged it will be
140 reaped on receipt of the first SIGCHLD after the critical section. */
142 void
143 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
145 #ifndef MSDOS
146 sigset_t oldset;
147 block_child_signal (&oldset);
149 if (p->alive)
151 record_deleted_pid (p->pid, tempfile);
152 p->alive = 0;
153 kill (- p->pid, SIGKILL);
156 unblock_child_signal (&oldset);
157 #endif /* !MSDOS */
160 /* Clean up files, file descriptors and processes created by Fcall_process. */
162 static void
163 delete_temp_file (Lisp_Object name)
165 unlink (SSDATA (name));
168 static void
169 call_process_kill (void *ptr)
171 int *callproc_fd = ptr;
172 int i;
173 for (i = 0; i < CALLPROC_FDS; i++)
174 if (0 <= callproc_fd[i])
175 emacs_close (callproc_fd[i]);
177 if (synch_process_pid)
179 struct Lisp_Process proc;
180 proc.alive = 1;
181 proc.pid = synch_process_pid;
182 record_kill_process (&proc, synch_process_tempfile);
183 synch_process_pid = 0;
185 else if (STRINGP (synch_process_tempfile))
186 delete_temp_file (synch_process_tempfile);
189 /* Clean up when exiting Fcall_process: restore the buffer, and
190 kill the subsidiary process group if the process still exists. */
192 static void
193 call_process_cleanup (Lisp_Object buffer)
195 Fset_buffer (buffer);
197 #ifndef MSDOS
198 if (synch_process_pid)
200 kill (-synch_process_pid, SIGINT);
201 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
202 immediate_quit = 1;
203 QUIT;
204 wait_for_termination (synch_process_pid, 0, 1);
205 synch_process_pid = 0;
206 immediate_quit = 0;
207 message1 ("Waiting for process to die...done");
209 #endif /* !MSDOS */
212 #ifdef DOS_NT
213 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
214 #else
215 static mode_t const default_output_mode = 0666;
216 #endif
218 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
219 doc: /* Call PROGRAM synchronously in separate process.
220 The remaining arguments are optional.
221 The program's input comes from file INFILE (nil means `/dev/null').
222 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
223 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
224 FILE is a file name string, means that it should be written to that file
225 (if the file already exists it is overwritten).
226 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
227 REAL-BUFFER says what to do with standard output, as above,
228 while STDERR-FILE says what to do with standard error in the child.
229 STDERR-FILE may be nil (discard standard error output),
230 t (mix it with ordinary output), or a file name string.
232 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
233 Remaining arguments are strings passed as command arguments to PROGRAM.
235 If executable PROGRAM can't be found as an executable, `call-process'
236 signals a Lisp error. `call-process' reports errors in execution of
237 the program only through its return and output.
239 If DESTINATION is 0, `call-process' returns immediately with value nil.
240 Otherwise it waits for PROGRAM to terminate
241 and returns a numeric exit status or a signal description string.
242 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
244 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
245 (ptrdiff_t nargs, Lisp_Object *args)
247 Lisp_Object infile, encoded_infile;
248 int filefd;
249 ptrdiff_t count = SPECPDL_INDEX ();
251 if (nargs >= 2 && ! NILP (args[1]))
253 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
254 CHECK_STRING (infile);
256 else
257 infile = build_string (NULL_DEVICE);
259 encoded_infile = ENCODE_FILE (infile);
261 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
262 if (filefd < 0)
263 report_file_error ("Opening process input file", infile);
264 record_unwind_protect_int (close_file_unwind, filefd);
265 return unbind_to (count, call_process (nargs, args, filefd, -1));
268 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
270 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
271 unwinder that is intended to remove the input temporary file; in
272 this case NARGS must be at least 2 and ARGS[1] is the file's name.
274 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
276 static Lisp_Object
277 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
278 ptrdiff_t tempfile_index)
280 Lisp_Object buffer, current_dir, path;
281 bool display_p;
282 int fd0;
283 int callproc_fd[CALLPROC_FDS];
284 int status;
285 ptrdiff_t i;
286 ptrdiff_t count = SPECPDL_INDEX ();
287 USE_SAFE_ALLOCA;
289 char **new_argv;
290 /* File to use for stderr in the child.
291 t means use same as standard output. */
292 Lisp_Object error_file;
293 Lisp_Object output_file = Qnil;
294 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
295 char *tempfile = NULL;
296 int pid;
297 #else
298 sigset_t oldset;
299 pid_t pid;
300 #endif
301 int child_errno;
302 int fd_output, fd_error;
303 struct coding_system process_coding; /* coding-system of process output */
304 struct coding_system argument_coding; /* coding-system of arguments */
305 /* Set to the return value of Ffind_operation_coding_system. */
306 Lisp_Object coding_systems;
307 bool discard_output;
309 if (synch_process_pid)
310 error ("call-process invoked recursively");
312 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
313 coding_systems = Qt;
315 CHECK_STRING (args[0]);
317 error_file = Qt;
319 #ifndef subprocesses
320 /* Without asynchronous processes we cannot have BUFFER == 0. */
321 if (nargs >= 3
322 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
323 error ("Operating system cannot handle asynchronous subprocesses");
324 #endif /* subprocesses */
326 /* Decide the coding-system for giving arguments. */
328 Lisp_Object val, *args2;
330 /* If arguments are supplied, we may have to encode them. */
331 if (nargs >= 5)
333 bool must_encode = 0;
334 Lisp_Object coding_attrs;
336 for (i = 4; i < nargs; i++)
337 CHECK_STRING (args[i]);
339 for (i = 4; i < nargs; i++)
340 if (STRING_MULTIBYTE (args[i]))
341 must_encode = 1;
343 if (!NILP (Vcoding_system_for_write))
344 val = Vcoding_system_for_write;
345 else if (! must_encode)
346 val = Qraw_text;
347 else
349 SAFE_NALLOCA (args2, 1, nargs + 1);
350 args2[0] = Qcall_process;
351 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
352 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
353 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
355 val = complement_process_encoding_system (val);
356 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
357 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
358 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
360 /* We should not use an ASCII incompatible coding system. */
361 val = raw_text_coding_system (val);
362 setup_coding_system (val, &argument_coding);
367 if (nargs < 3)
368 buffer = Qnil;
369 else
371 buffer = args[2];
373 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
374 FILE-FOR-STDERR), unless the first element is :file, in which case see
375 the next paragraph. */
376 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
378 if (CONSP (XCDR (buffer)))
380 Lisp_Object stderr_file;
381 stderr_file = XCAR (XCDR (buffer));
383 if (NILP (stderr_file) || EQ (Qt, stderr_file))
384 error_file = stderr_file;
385 else
386 error_file = Fexpand_file_name (stderr_file, Qnil);
389 buffer = XCAR (buffer);
392 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
393 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
395 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
396 BVAR (current_buffer, directory));
397 CHECK_STRING (output_file);
398 buffer = Qnil;
401 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
403 Lisp_Object spec_buffer;
404 spec_buffer = buffer;
405 buffer = Fget_buffer_create (buffer);
406 /* Mention the buffer name for a better error message. */
407 if (NILP (buffer))
408 CHECK_BUFFER (spec_buffer);
409 CHECK_BUFFER (buffer);
413 /* Make sure that the child will be able to chdir to the current
414 buffer's current directory, or its unhandled equivalent. We
415 can't just have the child check for an error when it does the
416 chdir, since it's in a vfork. */
417 current_dir = encode_current_directory ();
419 if (STRINGP (error_file))
420 error_file = ENCODE_FILE (error_file);
421 if (STRINGP (output_file))
422 output_file = ENCODE_FILE (output_file);
424 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
426 for (i = 0; i < CALLPROC_FDS; i++)
427 callproc_fd[i] = -1;
428 #ifdef MSDOS
429 synch_process_tempfile = make_number (0);
430 #endif
431 record_unwind_protect_ptr (call_process_kill, callproc_fd);
433 /* Search for program; barf if not found. */
435 int ok;
437 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
438 make_number (X_OK), false);
439 if (ok < 0)
440 report_file_error ("Searching for program", args[0]);
443 /* Remove "/:" from PATH. */
444 path = remove_slash_colon (path);
446 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
448 if (nargs > 4)
450 ptrdiff_t i;
452 argument_coding.dst_multibyte = 0;
453 for (i = 4; i < nargs; i++)
455 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
456 if (CODING_REQUIRE_ENCODING (&argument_coding))
457 /* We must encode this argument. */
458 args[i] = encode_coding_string (&argument_coding, args[i], 1);
460 for (i = 4; i < nargs; i++)
461 new_argv[i - 3] = SSDATA (args[i]);
462 new_argv[i - 3] = 0;
464 else
465 new_argv[1] = 0;
466 path = ENCODE_FILE (path);
467 new_argv[0] = SSDATA (path);
469 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
471 #ifdef MSDOS
472 if (! discard_output && ! STRINGP (output_file))
474 char const *tmpdir = egetenv ("TMPDIR");
475 char const *outf = tmpdir ? tmpdir : "";
476 tempfile = alloca (strlen (outf) + 20);
477 strcpy (tempfile, outf);
478 dostounix_filename (tempfile);
479 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
480 strcat (tempfile, "/");
481 strcat (tempfile, "emXXXXXX");
482 mktemp (tempfile);
483 if (!*tempfile)
484 report_file_error ("Opening process output file", Qnil);
485 output_file = build_string (tempfile);
486 synch_process_tempfile = output_file;
488 #endif
490 if (discard_output)
492 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
493 if (fd_output < 0)
494 report_file_error ("Opening null device", Qnil);
496 else if (STRINGP (output_file))
498 fd_output = emacs_open (SSDATA (output_file),
499 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
500 default_output_mode);
501 if (fd_output < 0)
503 int open_errno = errno;
504 output_file = DECODE_FILE (output_file);
505 report_file_errno ("Opening process output file",
506 output_file, open_errno);
509 else
511 int fd[2];
512 if (emacs_pipe (fd) != 0)
513 report_file_error ("Creating process pipe", Qnil);
514 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
515 fd_output = fd[1];
517 callproc_fd[CALLPROC_STDOUT] = fd_output;
519 fd_error = fd_output;
521 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
523 fd_error = emacs_open ((STRINGP (error_file)
524 ? SSDATA (error_file)
525 : NULL_DEVICE),
526 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
527 default_output_mode);
528 if (fd_error < 0)
530 int open_errno = errno;
531 report_file_errno ("Cannot redirect stderr",
532 (STRINGP (error_file)
533 ? DECODE_FILE (error_file)
534 : build_string (NULL_DEVICE)),
535 open_errno);
537 callproc_fd[CALLPROC_STDERR] = fd_error;
540 #ifdef MSDOS /* MW, July 1993 */
541 /* Note that on MSDOS `child_setup' actually returns the child process
542 exit status, not its PID, so assign it to status below. */
543 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
545 if (pid < 0)
547 child_errno = errno;
548 unbind_to (count, Qnil);
549 synchronize_system_messages_locale ();
550 return
551 code_convert_string_norecord (build_string (strerror (child_errno)),
552 Vlocale_coding_system, 0);
554 status = pid;
556 for (i = 0; i < CALLPROC_FDS; i++)
557 if (0 <= callproc_fd[i])
559 emacs_close (callproc_fd[i]);
560 callproc_fd[i] = -1;
562 emacs_close (filefd);
563 clear_unwind_protect (count - 1);
565 if (tempfile)
567 /* Since CRLF is converted to LF within `decode_coding', we
568 can always open a file with binary mode. */
569 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile, O_RDONLY, 0);
570 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
572 int open_errno = errno;
573 report_file_errno ("Cannot re-open temporary file",
574 build_string (tempfile), open_errno);
578 #endif /* MSDOS */
580 /* Do the unwind-protect now, even though the pid is not known, so
581 that no storage allocation is done in the critical section.
582 The actual PID will be filled in during the critical section. */
583 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
585 #ifndef MSDOS
587 block_input ();
588 block_child_signal (&oldset);
590 #ifdef WINDOWSNT
591 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
592 #else /* not WINDOWSNT */
594 /* vfork, and prevent local vars from being clobbered by the vfork. */
596 Lisp_Object volatile buffer_volatile = buffer;
597 Lisp_Object volatile coding_systems_volatile = coding_systems;
598 Lisp_Object volatile current_dir_volatile = current_dir;
599 bool volatile display_p_volatile = display_p;
600 bool volatile sa_must_free_volatile = sa_must_free;
601 int volatile fd_error_volatile = fd_error;
602 int volatile filefd_volatile = filefd;
603 ptrdiff_t volatile count_volatile = count;
604 ptrdiff_t volatile sa_avail_volatile = sa_avail;
605 ptrdiff_t volatile sa_count_volatile = sa_count;
606 char **volatile new_argv_volatile = new_argv;
607 int volatile callproc_fd_volatile[CALLPROC_FDS];
608 for (i = 0; i < CALLPROC_FDS; i++)
609 callproc_fd_volatile[i] = callproc_fd[i];
611 pid = vfork ();
613 buffer = buffer_volatile;
614 coding_systems = coding_systems_volatile;
615 current_dir = current_dir_volatile;
616 display_p = display_p_volatile;
617 sa_must_free = sa_must_free_volatile;
618 fd_error = fd_error_volatile;
619 filefd = filefd_volatile;
620 count = count_volatile;
621 sa_avail = sa_avail_volatile;
622 sa_count = sa_count_volatile;
623 new_argv = new_argv_volatile;
625 for (i = 0; i < CALLPROC_FDS; i++)
626 callproc_fd[i] = callproc_fd_volatile[i];
627 fd_output = callproc_fd[CALLPROC_STDOUT];
630 if (pid == 0)
632 unblock_child_signal (&oldset);
634 setsid ();
636 /* Emacs ignores SIGPIPE, but the child should not. */
637 signal (SIGPIPE, SIG_DFL);
638 /* Likewise for SIGPROF. */
639 #ifdef SIGPROF
640 signal (SIGPROF, SIG_DFL);
641 #endif
643 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
646 #endif /* not WINDOWSNT */
648 child_errno = errno;
650 if (pid > 0)
652 synch_process_pid = pid;
654 if (INTEGERP (buffer))
656 if (tempfile_index < 0)
657 record_deleted_pid (pid, Qnil);
658 else
660 eassert (1 < nargs);
661 record_deleted_pid (pid, args[1]);
662 clear_unwind_protect (tempfile_index);
664 synch_process_pid = 0;
668 unblock_child_signal (&oldset);
669 unblock_input ();
671 if (pid < 0)
672 report_file_errno ("Doing vfork", Qnil, child_errno);
674 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
675 since we will use that to read input from. */
676 for (i = 0; i < CALLPROC_FDS; i++)
677 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
679 emacs_close (callproc_fd[i]);
680 callproc_fd[i] = -1;
682 emacs_close (filefd);
683 clear_unwind_protect (count - 1);
685 #endif /* not MSDOS */
687 if (INTEGERP (buffer))
688 return unbind_to (count, Qnil);
690 if (BUFFERP (buffer))
691 Fset_buffer (buffer);
693 fd0 = callproc_fd[CALLPROC_PIPEREAD];
695 if (0 <= fd0)
697 Lisp_Object val, *args2;
699 val = Qnil;
700 if (!NILP (Vcoding_system_for_read))
701 val = Vcoding_system_for_read;
702 else
704 if (EQ (coding_systems, Qt))
706 ptrdiff_t i;
708 SAFE_NALLOCA (args2, 1, nargs + 1);
709 args2[0] = Qcall_process;
710 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
711 coding_systems
712 = Ffind_operation_coding_system (nargs + 1, args2);
714 if (CONSP (coding_systems))
715 val = XCAR (coding_systems);
716 else if (CONSP (Vdefault_process_coding_system))
717 val = XCAR (Vdefault_process_coding_system);
718 else
719 val = Qnil;
721 Fcheck_coding_system (val);
722 /* In unibyte mode, character code conversion should not take
723 place but EOL conversion should. So, setup raw-text or one
724 of the subsidiary according to the information just setup. */
725 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
726 && !NILP (val))
727 val = raw_text_coding_system (val);
728 setup_coding_system (val, &process_coding);
729 process_coding.dst_multibyte
730 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
731 process_coding.src_multibyte = 0;
734 immediate_quit = 1;
735 QUIT;
737 if (0 <= fd0)
739 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
740 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
741 char buf[CALLPROC_BUFFER_SIZE_MAX];
742 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
743 int nread;
744 EMACS_INT total_read = 0;
745 int carryover = 0;
746 bool display_on_the_fly = display_p;
747 struct coding_system saved_coding = process_coding;
749 while (1)
751 /* Repeatedly read until we've filled as much as possible
752 of the buffer size we have. But don't read
753 less than 1024--save that for the next bufferful. */
754 nread = carryover;
755 while (nread < bufsize - 1024)
757 int this_read = emacs_read (fd0, buf + nread,
758 bufsize - nread);
760 if (this_read < 0)
761 goto give_up;
763 if (this_read == 0)
765 process_coding.mode |= CODING_MODE_LAST_BLOCK;
766 break;
769 nread += this_read;
770 total_read += this_read;
772 if (display_on_the_fly)
773 break;
776 /* Now NREAD is the total amount of data in the buffer. */
777 immediate_quit = 0;
779 if (!nread)
781 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
782 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
783 insert_1_both (buf, nread, nread, 0, 1, 0);
784 else
785 { /* We have to decode the input. */
786 Lisp_Object curbuf;
787 ptrdiff_t count1 = SPECPDL_INDEX ();
789 XSETBUFFER (curbuf, current_buffer);
790 /* FIXME: Call signal_after_change! */
791 prepare_to_modify_buffer (PT, PT, NULL);
792 /* We cannot allow after-change-functions be run
793 during decoding, because that might modify the
794 buffer, while we rely on process_coding.produced to
795 faithfully reflect inserted text until we
796 TEMP_SET_PT_BOTH below. */
797 specbind (Qinhibit_modification_hooks, Qt);
798 decode_coding_c_string (&process_coding,
799 (unsigned char *) buf, nread, curbuf);
800 unbind_to (count1, Qnil);
801 if (display_on_the_fly
802 && CODING_REQUIRE_DETECTION (&saved_coding)
803 && ! CODING_REQUIRE_DETECTION (&process_coding))
805 /* We have detected some coding system, but the
806 detection may have been via insufficient data.
807 So give up displaying on the fly. */
808 if (process_coding.produced > 0)
809 del_range_2 (process_coding.dst_pos,
810 process_coding.dst_pos_byte,
811 (process_coding.dst_pos
812 + process_coding.produced_char),
813 (process_coding.dst_pos_byte
814 + process_coding.produced),
816 display_on_the_fly = false;
817 process_coding = saved_coding;
818 carryover = nread;
819 /* Make the above condition always fail in the future. */
820 saved_coding.common_flags
821 &= ~CODING_REQUIRE_DETECTION_MASK;
822 continue;
825 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
826 PT_BYTE + process_coding.produced);
827 carryover = process_coding.carryover_bytes;
828 if (carryover > 0)
829 memcpy (buf, process_coding.carryover,
830 process_coding.carryover_bytes);
833 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
834 break;
836 /* Make the buffer bigger as we continue to read more data,
837 but not past CALLPROC_BUFFER_SIZE_MAX. */
838 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
839 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
840 bufsize = CALLPROC_BUFFER_SIZE_MAX;
842 if (display_p)
844 redisplay_preserve_echo_area (1);
845 /* This variable might have been set to 0 for code
846 detection. In that case, set it back to 1 because
847 we should have already detected a coding system. */
848 display_on_the_fly = true;
850 immediate_quit = true;
851 QUIT;
853 give_up: ;
855 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
856 /* If the caller required, let the buffer inherit the
857 coding-system used to decode the process output. */
858 if (inherit_process_coding_system)
859 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
860 make_number (total_read));
863 #ifndef MSDOS
864 /* Wait for it to terminate, unless it already has. */
865 wait_for_termination (pid, &status, fd0 < 0);
866 #endif
868 immediate_quit = 0;
870 /* Don't kill any children that the subprocess may have left behind
871 when exiting. */
872 synch_process_pid = 0;
874 SAFE_FREE ();
875 unbind_to (count, Qnil);
877 if (WIFSIGNALED (status))
879 const char *signame;
881 synchronize_system_messages_locale ();
882 signame = strsignal (WTERMSIG (status));
884 if (signame == 0)
885 signame = "unknown";
887 return code_convert_string_norecord (build_string (signame),
888 Vlocale_coding_system, 0);
891 eassert (WIFEXITED (status));
892 return make_number (WEXITSTATUS (status));
895 /* Create a temporary file suitable for storing the input data of
896 call-process-region. NARGS and ARGS are the same as for
897 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
898 naming the file, and return a file descriptor for reading.
899 Unwind-protect the file, so that the file descriptor will be closed
900 and the file removed when the caller unwinds the specpdl stack. */
902 static int
903 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
904 Lisp_Object *filename_string_ptr)
906 int fd;
907 Lisp_Object filename_string;
908 Lisp_Object val, start, end;
909 Lisp_Object tmpdir;
911 if (STRINGP (Vtemporary_file_directory))
912 tmpdir = Vtemporary_file_directory;
913 else
915 char *outf;
916 #ifndef DOS_NT
917 outf = getenv ("TMPDIR");
918 tmpdir = build_string (outf ? outf : "/tmp/");
919 #else /* DOS_NT */
920 if ((outf = egetenv ("TMPDIR"))
921 || (outf = egetenv ("TMP"))
922 || (outf = egetenv ("TEMP")))
923 tmpdir = build_string (outf);
924 else
925 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
926 #endif
930 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
931 char *tempfile;
932 ptrdiff_t count;
934 #ifdef WINDOWSNT
935 /* Cannot use the result of Fexpand_file_name, because it
936 downcases the XXXXXX part of the pattern, and mktemp then
937 doesn't recognize it. */
938 if (!NILP (Vw32_downcase_file_names))
940 Lisp_Object dirname = Ffile_name_directory (pattern);
942 if (NILP (dirname))
943 pattern = Vtemp_file_name_pattern;
944 else
945 pattern = concat2 (dirname, Vtemp_file_name_pattern);
947 #endif
949 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
950 tempfile = SSDATA (filename_string);
952 count = SPECPDL_INDEX ();
953 record_unwind_protect_nothing ();
954 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
955 if (fd < 0)
956 report_file_error ("Failed to open temporary file using pattern",
957 pattern);
958 set_unwind_protect (count, delete_temp_file, filename_string);
959 record_unwind_protect_int (close_file_unwind, fd);
962 start = args[0];
963 end = args[1];
964 /* Decide coding-system of the contents of the temporary file. */
965 if (!NILP (Vcoding_system_for_write))
966 val = Vcoding_system_for_write;
967 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
968 val = Qraw_text;
969 else
971 Lisp_Object coding_systems;
972 Lisp_Object *args2;
973 USE_SAFE_ALLOCA;
974 SAFE_NALLOCA (args2, 1, nargs + 1);
975 args2[0] = Qcall_process_region;
976 memcpy (args2 + 1, args, nargs * sizeof *args);
977 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
978 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
979 SAFE_FREE ();
981 val = complement_process_encoding_system (val);
984 ptrdiff_t count1 = SPECPDL_INDEX ();
986 specbind (intern ("coding-system-for-write"), val);
987 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
988 happen to get a ".Z" suffix. */
989 specbind (Qfile_name_handler_alist, Qnil);
990 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
992 unbind_to (count1, Qnil);
995 if (lseek (fd, 0, SEEK_SET) < 0)
996 report_file_error ("Setting file position", filename_string);
998 /* Note that Fcall_process takes care of binding
999 coding-system-for-read. */
1001 *filename_string_ptr = filename_string;
1002 return fd;
1005 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1006 3, MANY, 0,
1007 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1009 START and END are normally buffer positions specifying the part of the
1010 buffer to send to the process.
1011 If START is nil, that means to use the entire buffer contents; END is
1012 ignored.
1013 If START is a string, then send that string to the process
1014 instead of any buffer contents; END is ignored.
1015 The remaining arguments are optional.
1016 Delete the text if fourth arg DELETE is non-nil.
1018 Insert output in BUFFER before point; t means current buffer; nil for
1019 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1020 FILE)', where FILE is a file name string, means that it should be
1021 written to that file (if the file already exists it is overwritten).
1022 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1023 REAL-BUFFER says what to do with standard output, as above,
1024 while STDERR-FILE says what to do with standard error in the child.
1025 STDERR-FILE may be nil (discard standard error output),
1026 t (mix it with ordinary output), or a file name string.
1028 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1029 Remaining args are passed to PROGRAM at startup as command args.
1031 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1032 Otherwise it waits for PROGRAM to terminate
1033 and returns a numeric exit status or a signal description string.
1034 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1036 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1037 (ptrdiff_t nargs, Lisp_Object *args)
1039 Lisp_Object infile, val;
1040 ptrdiff_t count = SPECPDL_INDEX ();
1041 Lisp_Object start = args[0];
1042 Lisp_Object end = args[1];
1043 bool empty_input;
1044 int fd;
1046 if (STRINGP (start))
1047 empty_input = SCHARS (start) == 0;
1048 else if (NILP (start))
1049 empty_input = BEG == Z;
1050 else
1052 validate_region (&args[0], &args[1]);
1053 start = args[0];
1054 end = args[1];
1055 empty_input = XINT (start) == XINT (end);
1058 if (!empty_input)
1059 fd = create_temp_file (nargs, args, &infile);
1060 else
1062 infile = Qnil;
1063 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1064 if (fd < 0)
1065 report_file_error ("Opening null device", Qnil);
1066 record_unwind_protect_int (close_file_unwind, fd);
1069 if (nargs > 3 && !NILP (args[3]))
1070 Fdelete_region (start, end);
1072 if (nargs > 3)
1074 args += 2;
1075 nargs -= 2;
1077 else
1079 args[0] = args[2];
1080 nargs = 2;
1082 args[1] = infile;
1084 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1085 return unbind_to (count, val);
1088 static char **
1089 add_env (char **env, char **new_env, char *string)
1091 char **ep;
1092 bool ok = 1;
1093 if (string == NULL)
1094 return new_env;
1096 /* See if this string duplicates any string already in the env.
1097 If so, don't put it in.
1098 When an env var has multiple definitions,
1099 we keep the definition that comes first in process-environment. */
1100 for (ep = env; ok && ep != new_env; ep++)
1102 char *p = *ep, *q = string;
1103 while (ok)
1105 if (*p && *q != *p)
1106 break;
1107 if (*q == 0)
1108 /* The string is a lone variable name; keep it for now, we
1109 will remove it later. It is a placeholder for a
1110 variable that is not to be included in the environment. */
1111 break;
1112 if (*q == '=')
1113 ok = 0;
1114 p++, q++;
1117 if (ok)
1118 *new_env++ = string;
1119 return new_env;
1122 #ifndef DOS_NT
1124 /* 'exec' failed inside a child running NAME, with error number ERR.
1125 Possibly a vforked child needed to allocate a large vector on the
1126 stack; such a child cannot fall back on malloc because that might
1127 mess up the allocator's data structures in the parent.
1128 Report the error and exit the child. */
1130 static _Noreturn void
1131 exec_failed (char const *name, int err)
1133 /* Avoid deadlock if the child's perror writes to a full pipe; the
1134 pipe's reader is the parent, but with vfork the parent can't
1135 run until the child exits. Truncate the diagnostic instead. */
1136 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1138 errno = err;
1139 emacs_perror (name);
1140 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1143 #else
1145 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1146 fork and exec, and handle alloca exhaustion in a different way. */
1148 static void
1149 exec_failed (char const *name, int err)
1153 #endif
1155 /* This is the last thing run in a newly forked inferior
1156 either synchronous or asynchronous.
1157 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1158 Initialize inferior's priority, pgrp, connected dir and environment.
1159 then exec another program based on new_argv.
1161 If SET_PGRP, put the subprocess into a separate process group.
1163 CURRENT_DIR is an elisp string giving the path of the current
1164 directory the subprocess should have. Since we can't really signal
1165 a decent error from within the child, this should be verified as an
1166 executable directory by the parent. */
1169 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1170 Lisp_Object current_dir)
1172 char **env;
1173 char *pwd_var;
1174 #ifdef WINDOWSNT
1175 int cpid;
1176 HANDLE handles[3];
1177 #else
1178 pid_t pid = getpid ();
1179 #endif /* WINDOWSNT */
1181 /* Note that use of alloca is always safe here. It's obvious for systems
1182 that do not have true vfork or that have true (stack) alloca.
1183 If using vfork and C_ALLOCA (when Emacs used to include
1184 src/alloca.c) it is safe because that changes the superior's
1185 static variables as if the superior had done alloca and will be
1186 cleaned up in the usual way. */
1188 char *temp;
1189 ptrdiff_t i;
1191 i = SBYTES (current_dir);
1192 #ifdef MSDOS
1193 /* MSDOS must have all environment variables malloc'ed, because
1194 low-level libc functions that launch subsidiary processes rely
1195 on that. */
1196 pwd_var = xmalloc (i + 5);
1197 #else
1198 if (MAX_ALLOCA - 5 < i)
1199 exec_failed (new_argv[0], ENOMEM);
1200 pwd_var = alloca (i + 5);
1201 #endif
1202 temp = pwd_var + 4;
1203 memcpy (pwd_var, "PWD=", 4);
1204 lispstpcpy (temp, current_dir);
1206 #ifndef DOS_NT
1207 /* We can't signal an Elisp error here; we're in a vfork. Since
1208 the callers check the current directory before forking, this
1209 should only return an error if the directory's permissions
1210 are changed between the check and this chdir, but we should
1211 at least check. */
1212 if (chdir (temp) < 0)
1213 _exit (EXIT_CANCELED);
1214 #else /* DOS_NT */
1215 /* Get past the drive letter, so that d:/ is left alone. */
1216 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1218 temp += 2;
1219 i -= 2;
1221 #endif /* DOS_NT */
1223 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1224 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1225 temp[--i] = 0;
1228 /* Set `env' to a vector of the strings in the environment. */
1230 register Lisp_Object tem;
1231 register char **new_env;
1232 char **p, **q;
1233 register int new_length;
1234 Lisp_Object display = Qnil;
1236 new_length = 0;
1238 for (tem = Vprocess_environment;
1239 CONSP (tem) && STRINGP (XCAR (tem));
1240 tem = XCDR (tem))
1242 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1243 && (SDATA (XCAR (tem)) [7] == '\0'
1244 || SDATA (XCAR (tem)) [7] == '='))
1245 /* DISPLAY is specified in process-environment. */
1246 display = Qt;
1247 new_length++;
1250 /* If not provided yet, use the frame's DISPLAY. */
1251 if (NILP (display))
1253 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1254 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1255 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1256 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1257 Vinitial_environment);
1258 if (STRINGP (tmp))
1260 display = tmp;
1261 new_length++;
1265 /* new_length + 2 to include PWD and terminating 0. */
1266 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1267 exec_failed (new_argv[0], ENOMEM);
1268 env = new_env = alloca ((new_length + 2) * sizeof *env);
1269 /* If we have a PWD envvar, pass one down,
1270 but with corrected value. */
1271 if (egetenv ("PWD"))
1272 *new_env++ = pwd_var;
1274 if (STRINGP (display))
1276 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1277 exec_failed (new_argv[0], ENOMEM);
1278 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1279 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1280 new_env = add_env (env, new_env, vdata);
1283 /* Overrides. */
1284 for (tem = Vprocess_environment;
1285 CONSP (tem) && STRINGP (XCAR (tem));
1286 tem = XCDR (tem))
1287 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1289 *new_env = 0;
1291 /* Remove variable names without values. */
1292 p = q = env;
1293 while (*p != 0)
1295 while (*q != 0 && strchr (*q, '=') == NULL)
1296 q++;
1297 *p = *q++;
1298 if (*p != 0)
1299 p++;
1304 #ifdef WINDOWSNT
1305 prepare_standard_handles (in, out, err, handles);
1306 set_process_dir (SSDATA (current_dir));
1307 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1308 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1309 reset_standard_handles (in, out, err, handles);
1310 if (cpid == -1)
1311 /* An error occurred while trying to spawn the process. */
1312 report_file_error ("Spawning child process", Qnil);
1313 return cpid;
1315 #else /* not WINDOWSNT */
1317 #ifndef MSDOS
1318 /* Redirect file descriptors and clear the close-on-exec flag on the
1319 redirected ones. IN, OUT, and ERR are close-on-exec so they
1320 need not be closed explicitly. */
1321 dup2 (in, STDIN_FILENO);
1322 dup2 (out, STDOUT_FILENO);
1323 dup2 (err, STDERR_FILENO);
1325 setpgid (0, 0);
1326 tcsetpgrp (0, pid);
1328 int errnum = emacs_exec_file (new_argv[0], new_argv, env);
1329 exec_failed (new_argv[0], errnum);
1331 #else /* MSDOS */
1332 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1333 xfree (pwd_var);
1334 if (pid == -1)
1335 /* An error occurred while trying to run the subprocess. */
1336 report_file_error ("Spawning child process", Qnil);
1337 return pid;
1338 #endif /* MSDOS */
1339 #endif /* not WINDOWSNT */
1342 static bool
1343 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1344 ptrdiff_t *valuelen, Lisp_Object env)
1346 for (; CONSP (env); env = XCDR (env))
1348 Lisp_Object entry = XCAR (env);
1349 if (STRINGP (entry)
1350 && SBYTES (entry) >= varlen
1351 #ifdef WINDOWSNT
1352 /* NT environment variables are case insensitive. */
1353 && ! strnicmp (SSDATA (entry), var, varlen)
1354 #else /* not WINDOWSNT */
1355 && ! memcmp (SDATA (entry), var, varlen)
1356 #endif /* not WINDOWSNT */
1359 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1361 *value = SSDATA (entry) + (varlen + 1);
1362 *valuelen = SBYTES (entry) - (varlen + 1);
1363 return 1;
1365 else if (SBYTES (entry) == varlen)
1367 /* Lone variable names in Vprocess_environment mean that
1368 variable should be removed from the environment. */
1369 *value = NULL;
1370 return 1;
1374 return 0;
1377 static bool
1378 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1379 ptrdiff_t *valuelen, Lisp_Object frame)
1381 /* Try to find VAR in Vprocess_environment first. */
1382 if (getenv_internal_1 (var, varlen, value, valuelen,
1383 Vprocess_environment))
1384 return *value ? 1 : 0;
1386 /* On Windows we make some modifications to Emacs' environment
1387 without recording them in Vprocess_environment. */
1388 #ifdef WINDOWSNT
1390 char* tmpval = getenv (var);
1391 if (tmpval)
1393 *value = tmpval;
1394 *valuelen = strlen (tmpval);
1395 return 1;
1398 #endif
1400 /* For DISPLAY try to get the values from the frame or the initial env. */
1401 if (strcmp (var, "DISPLAY") == 0)
1403 Lisp_Object display
1404 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1405 if (STRINGP (display))
1407 *value = SSDATA (display);
1408 *valuelen = SBYTES (display);
1409 return 1;
1411 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1412 if (getenv_internal_1 (var, varlen, value, valuelen,
1413 Vinitial_environment))
1414 return *value ? 1 : 0;
1417 return 0;
1420 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1421 doc: /* Get the value of environment variable VARIABLE.
1422 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1423 the environment. Otherwise, value is a string.
1425 This function searches `process-environment' for VARIABLE.
1427 If optional parameter ENV is a list, then search this list instead of
1428 `process-environment', and return t when encountering a negative entry
1429 \(an entry for a variable with no value). */)
1430 (Lisp_Object variable, Lisp_Object env)
1432 char *value;
1433 ptrdiff_t valuelen;
1435 CHECK_STRING (variable);
1436 if (CONSP (env))
1438 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1439 &value, &valuelen, env))
1440 return value ? make_string (value, valuelen) : Qt;
1441 else
1442 return Qnil;
1444 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1445 &value, &valuelen, env))
1446 return make_string (value, valuelen);
1447 else
1448 return Qnil;
1451 /* A version of getenv that consults the Lisp environment lists,
1452 easily callable from C. This is usually called from egetenv. */
1453 char *
1454 egetenv_internal (const char *var, ptrdiff_t len)
1456 char *value;
1457 ptrdiff_t valuelen;
1459 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1460 return value;
1461 else
1462 return 0;
1466 /* This is run before init_cmdargs. */
1468 void
1469 init_callproc_1 (void)
1471 #ifdef HAVE_NS
1472 const char *etc_dir = ns_etc_directory ();
1473 const char *path_exec = ns_exec_path ();
1474 #endif
1476 Vdata_directory = decode_env_path ("EMACSDATA",
1477 #ifdef HAVE_NS
1478 etc_dir ? etc_dir :
1479 #endif
1480 PATH_DATA, 0);
1481 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1483 Vdoc_directory = decode_env_path ("EMACSDOC",
1484 #ifdef HAVE_NS
1485 etc_dir ? etc_dir :
1486 #endif
1487 PATH_DOC, 0);
1488 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1490 /* Check the EMACSPATH environment variable, defaulting to the
1491 PATH_EXEC path from epaths.h. */
1492 Vexec_path = decode_env_path ("EMACSPATH",
1493 #ifdef HAVE_NS
1494 path_exec ? path_exec :
1495 #endif
1496 PATH_EXEC, 0);
1497 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1498 /* FIXME? For ns, path_exec should go at the front? */
1499 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1502 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1504 void
1505 init_callproc (void)
1507 bool data_dir = egetenv ("EMACSDATA") != 0;
1509 char *sh;
1510 Lisp_Object tempdir;
1511 #ifdef HAVE_NS
1512 if (data_dir == 0)
1513 data_dir = ns_etc_directory () != 0;
1514 #endif
1516 if (!NILP (Vinstallation_directory))
1518 /* Add to the path the lib-src subdir of the installation dir. */
1519 Lisp_Object tem;
1520 tem = Fexpand_file_name (build_string ("lib-src"),
1521 Vinstallation_directory);
1522 #ifndef MSDOS
1523 /* MSDOS uses wrapped binaries, so don't do this. */
1524 if (NILP (Fmember (tem, Vexec_path)))
1526 #ifdef HAVE_NS
1527 const char *path_exec = ns_exec_path ();
1528 #endif
1529 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1530 Vexec_path = decode_env_path ("EMACSPATH",
1531 #ifdef HAVE_NS
1532 path_exec ? path_exec :
1533 #endif
1534 SSDATA (tem), 0);
1535 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1538 Vexec_directory = Ffile_name_as_directory (tem);
1539 #endif /* not MSDOS */
1541 /* Maybe use ../etc as well as ../lib-src. */
1542 if (data_dir == 0)
1544 tem = Fexpand_file_name (build_string ("etc"),
1545 Vinstallation_directory);
1546 Vdoc_directory = Ffile_name_as_directory (tem);
1550 /* Look for the files that should be in etc. We don't use
1551 Vinstallation_directory, because these files are never installed
1552 near the executable, and they are never in the build
1553 directory when that's different from the source directory.
1555 Instead, if these files are not in the nominal place, we try the
1556 source directory. */
1557 if (data_dir == 0)
1559 Lisp_Object tem, tem1, srcdir;
1560 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1562 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1564 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1565 tem1 = Ffile_exists_p (tem);
1566 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1568 Lisp_Object newdir;
1569 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1570 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1571 tem1 = Ffile_exists_p (tem);
1572 if (!NILP (tem1))
1573 Vdata_directory = newdir;
1577 #ifndef CANNOT_DUMP
1578 if (initialized)
1579 #endif
1581 tempdir = Fdirectory_file_name (Vexec_directory);
1582 if (! file_accessible_directory_p (tempdir))
1583 dir_warning ("arch-dependent data dir", Vexec_directory);
1586 tempdir = Fdirectory_file_name (Vdata_directory);
1587 if (! file_accessible_directory_p (tempdir))
1588 dir_warning ("arch-independent data dir", Vdata_directory);
1590 sh = getenv ("SHELL");
1591 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1593 #ifdef DOS_NT
1594 Vshared_game_score_directory = Qnil;
1595 #else
1596 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1597 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1598 Vshared_game_score_directory = Qnil;
1599 #endif
1602 void
1603 set_initial_environment (void)
1605 char **envp;
1606 for (envp = environ; *envp; envp++)
1607 Vprocess_environment = Fcons (build_string (*envp),
1608 Vprocess_environment);
1609 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1610 to use `delete' and friends on process-environment. */
1611 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1614 void
1615 syms_of_callproc (void)
1617 #ifndef DOS_NT
1618 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1619 #else /* DOS_NT */
1620 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1621 #endif
1622 staticpro (&Vtemp_file_name_pattern);
1624 #ifdef MSDOS
1625 synch_process_tempfile = make_number (0);
1626 staticpro (&synch_process_tempfile);
1627 #endif
1629 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1630 doc: /* File name to load inferior shells from.
1631 Initialized from the SHELL environment variable, or to a system-dependent
1632 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1634 DEFVAR_LISP ("exec-path", Vexec_path,
1635 doc: /* List of directories to search programs to run in subprocesses.
1636 Each element is a string (directory name) or nil (try default directory).
1638 By default the last element of this list is `exec-directory'. The
1639 last element is not always used, for example in shell completion
1640 \(`shell-dynamic-complete-command'). */);
1642 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1643 doc: /* List of suffixes to try to find executable file names.
1644 Each element is a string. */);
1645 Vexec_suffixes = Qnil;
1647 DEFVAR_LISP ("exec-directory", Vexec_directory,
1648 doc: /* Directory for executables for Emacs to invoke.
1649 More generally, this includes any architecture-dependent files
1650 that are built and installed from the Emacs distribution. */);
1652 DEFVAR_LISP ("data-directory", Vdata_directory,
1653 doc: /* Directory of machine-independent files that come with GNU Emacs.
1654 These are files intended for Emacs to use while it runs. */);
1656 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1657 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1658 This is usually the same as `data-directory'. */);
1660 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1661 doc: /* For internal use by the build procedure only.
1662 This is the name of the directory in which the build procedure installed
1663 Emacs's info files; the default value for `Info-default-directory-list'
1664 includes this. */);
1665 Vconfigure_info_directory = build_string (PATH_INFO);
1667 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1668 doc: /* Directory of score files for games which come with GNU Emacs.
1669 If this variable is nil, then Emacs is unable to use a shared directory. */);
1670 #ifdef DOS_NT
1671 Vshared_game_score_directory = Qnil;
1672 #else
1673 Vshared_game_score_directory = build_string (PATH_GAME);
1674 #endif
1676 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1677 doc: /* List of environment variables inherited from the parent process.
1678 Each element should be a string of the form ENVVARNAME=VALUE.
1679 The elements must normally be decoded (using `locale-coding-system') for use. */);
1680 Vinitial_environment = Qnil;
1682 DEFVAR_LISP ("process-environment", Vprocess_environment,
1683 doc: /* List of overridden environment variables for subprocesses to inherit.
1684 Each element should be a string of the form ENVVARNAME=VALUE.
1686 Entries in this list take precedence to those in the frame-local
1687 environments. Therefore, let-binding `process-environment' is an easy
1688 way to temporarily change the value of an environment variable,
1689 irrespective of where it comes from. To use `process-environment' to
1690 remove an environment variable, include only its name in the list,
1691 without "=VALUE".
1693 This variable is set to nil when Emacs starts.
1695 If multiple entries define the same variable, the first one always
1696 takes precedence.
1698 Non-ASCII characters are encoded according to the initial value of
1699 `locale-coding-system', i.e. the elements must normally be decoded for
1700 use.
1702 See `setenv' and `getenv'. */);
1703 Vprocess_environment = Qnil;
1705 defsubr (&Scall_process);
1706 defsubr (&Sgetenv_internal);
1707 defsubr (&Scall_process_region);