Remove immediate_quit.
[emacs.git] / src / callproc.c
blob85674bb7d9b4020fc13674bcb66a2ccf63d1aede
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2017 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 #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 "buffer.h"
48 #include "coding.h"
49 #include <epaths.h>
50 #include "process.h"
51 #include "syssignal.h"
52 #include "syswait.h"
53 #include "blockinput.h"
54 #include "frame.h"
56 #ifdef MSDOS
57 #include "msdos.h"
58 #endif
60 #ifdef HAVE_NS
61 #include "nsterm.h"
62 #endif
64 /* Pattern used by call-process-region to make temp files. */
65 static Lisp_Object Vtemp_file_name_pattern;
67 /* The next two variables are used while record-unwind-protect is in place
68 during call-process for a subprocess for which record_deleted_pid has
69 not yet been called. At other times, synch_process_pid is zero and
70 synch_process_tempfile's contents are irrelevant. Doing this via static
71 C variables is more convenient than putting them into the arguments
72 of record-unwind-protect, as they need to be updated at randomish
73 times in the code, and Lisp cannot always store these values as
74 Emacs integers. It's safe to use static variables here, as the
75 code is never invoked reentrantly. */
77 /* If nonzero, a process-ID that has not been reaped. */
78 static pid_t synch_process_pid;
80 /* If a string, the name of a temp file that has not been removed. */
81 #ifdef MSDOS
82 static Lisp_Object synch_process_tempfile;
83 #else
84 # define synch_process_tempfile make_number (0)
85 #endif
87 /* Indexes of file descriptors that need closing on call_process_kill. */
88 enum
90 /* The subsidiary process's stdout and stderr. stdin is handled
91 separately, in either Fcall_process_region or create_temp_file. */
92 CALLPROC_STDOUT, CALLPROC_STDERR,
94 /* How to read from a pipe (or substitute) from the subsidiary process. */
95 CALLPROC_PIPEREAD,
97 /* A bound on the number of file descriptors. */
98 CALLPROC_FDS
101 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
103 /* Return the current buffer's working directory, or the home
104 directory if it's unreachable, as a string suitable for a system call.
105 Signal an error if the result would not be an accessible directory. */
107 Lisp_Object
108 encode_current_directory (void)
110 Lisp_Object dir;
112 dir = BVAR (current_buffer, directory);
114 dir = Funhandled_file_name_directory (dir);
116 /* If the file name handler says that dir is unreachable, use
117 a sensible default. */
118 if (NILP (dir))
119 dir = build_string ("~");
121 dir = expand_and_dir_to_file (dir, Qnil);
123 if (NILP (Ffile_accessible_directory_p (dir)))
124 report_file_error ("Setting current directory",
125 BVAR (current_buffer, directory));
127 /* Remove "/:" from DIR and encode it. */
128 dir = ENCODE_FILE (remove_slash_colon (dir));
130 if (! file_accessible_directory_p (dir))
131 report_file_error ("Setting current directory",
132 BVAR (current_buffer, directory));
134 return dir;
137 /* If P is reapable, record it as a deleted process and kill it.
138 Do this in a critical section. Unless PID is wedged it will be
139 reaped on receipt of the first SIGCHLD after the critical section. */
141 void
142 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
144 #ifndef MSDOS
145 sigset_t oldset;
146 block_child_signal (&oldset);
148 if (p->alive)
150 record_deleted_pid (p->pid, tempfile);
151 p->alive = 0;
152 kill (- p->pid, SIGKILL);
155 unblock_child_signal (&oldset);
156 #endif /* !MSDOS */
159 /* Clean up files, file descriptors and processes created by Fcall_process. */
161 static void
162 delete_temp_file (Lisp_Object name)
164 unlink (SSDATA (name));
167 static void
168 call_process_kill (void *ptr)
170 int *callproc_fd = ptr;
171 int i;
172 for (i = 0; i < CALLPROC_FDS; i++)
173 if (0 <= callproc_fd[i])
174 emacs_close (callproc_fd[i]);
176 if (synch_process_pid)
178 struct Lisp_Process proc;
179 proc.alive = 1;
180 proc.pid = synch_process_pid;
181 record_kill_process (&proc, synch_process_tempfile);
182 synch_process_pid = 0;
184 else if (STRINGP (synch_process_tempfile))
185 delete_temp_file (synch_process_tempfile);
188 /* Clean up when exiting Fcall_process: restore the buffer, and
189 kill the subsidiary process group if the process still exists. */
191 static void
192 call_process_cleanup (Lisp_Object buffer)
194 Fset_buffer (buffer);
196 #ifndef MSDOS
197 if (synch_process_pid)
199 kill (-synch_process_pid, SIGINT);
200 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
201 maybe_quit ();
202 wait_for_termination (synch_process_pid, 0, 1);
203 synch_process_pid = 0;
204 message1 ("Waiting for process to die...done");
206 #endif /* !MSDOS */
209 #ifdef DOS_NT
210 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
211 #else
212 static mode_t const default_output_mode = 0666;
213 #endif
215 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
216 doc: /* Call PROGRAM synchronously in separate process.
217 The remaining arguments are optional.
218 The program's input comes from file INFILE (nil means `/dev/null').
219 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
220 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
221 FILE is a file name string, means that it should be written to that file
222 (if the file already exists it is overwritten).
223 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
224 REAL-BUFFER says what to do with standard output, as above,
225 while STDERR-FILE says what to do with standard error in the child.
226 STDERR-FILE may be nil (discard standard error output),
227 t (mix it with ordinary output), or a file name string.
229 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
230 Remaining arguments are strings passed as command arguments to PROGRAM.
232 If executable PROGRAM can't be found as an executable, `call-process'
233 signals a Lisp error. `call-process' reports errors in execution of
234 the program only through its return and output.
236 If DESTINATION is 0, `call-process' returns immediately with value nil.
237 Otherwise it waits for PROGRAM to terminate
238 and returns a numeric exit status or a signal description string.
239 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
241 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
242 (ptrdiff_t nargs, Lisp_Object *args)
244 Lisp_Object infile, encoded_infile;
245 int filefd;
246 ptrdiff_t count = SPECPDL_INDEX ();
248 if (nargs >= 2 && ! NILP (args[1]))
250 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
251 CHECK_STRING (infile);
253 else
254 infile = build_string (NULL_DEVICE);
256 encoded_infile = ENCODE_FILE (infile);
258 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
259 if (filefd < 0)
260 report_file_error ("Opening process input file", infile);
261 record_unwind_protect_int (close_file_unwind, filefd);
262 return unbind_to (count, call_process (nargs, args, filefd, -1));
265 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
267 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
268 unwinder that is intended to remove the input temporary file; in
269 this case NARGS must be at least 2 and ARGS[1] is the file's name.
271 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
273 static Lisp_Object
274 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
275 ptrdiff_t tempfile_index)
277 Lisp_Object buffer, current_dir, path;
278 bool display_p;
279 int fd0;
280 int callproc_fd[CALLPROC_FDS];
281 int status;
282 ptrdiff_t i;
283 ptrdiff_t count = SPECPDL_INDEX ();
284 USE_SAFE_ALLOCA;
286 char **new_argv;
287 /* File to use for stderr in the child.
288 t means use same as standard output. */
289 Lisp_Object error_file;
290 Lisp_Object output_file = Qnil;
291 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
292 char *tempfile = NULL;
293 #else
294 sigset_t oldset;
295 pid_t pid;
296 #endif
297 int child_errno;
298 int fd_output, fd_error;
299 struct coding_system process_coding; /* coding-system of process output */
300 struct coding_system argument_coding; /* coding-system of arguments */
301 /* Set to the return value of Ffind_operation_coding_system. */
302 Lisp_Object coding_systems;
303 bool discard_output;
305 if (synch_process_pid)
306 error ("call-process invoked recursively");
308 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
309 coding_systems = Qt;
311 CHECK_STRING (args[0]);
313 error_file = Qt;
315 #ifndef subprocesses
316 /* Without asynchronous processes we cannot have BUFFER == 0. */
317 if (nargs >= 3
318 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
319 error ("Operating system cannot handle asynchronous subprocesses");
320 #endif /* subprocesses */
322 /* Decide the coding-system for giving arguments. */
324 Lisp_Object val, *args2;
326 /* If arguments are supplied, we may have to encode them. */
327 if (nargs >= 5)
329 bool must_encode = 0;
330 Lisp_Object coding_attrs;
332 for (i = 4; i < nargs; i++)
333 CHECK_STRING (args[i]);
335 for (i = 4; i < nargs; i++)
336 if (STRING_MULTIBYTE (args[i]))
337 must_encode = 1;
339 if (!NILP (Vcoding_system_for_write))
340 val = Vcoding_system_for_write;
341 else if (! must_encode)
342 val = Qraw_text;
343 else
345 SAFE_NALLOCA (args2, 1, nargs + 1);
346 args2[0] = Qcall_process;
347 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
348 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
349 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
351 val = complement_process_encoding_system (val);
352 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
353 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
354 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
356 /* We should not use an ASCII incompatible coding system. */
357 val = raw_text_coding_system (val);
358 setup_coding_system (val, &argument_coding);
363 if (nargs < 3)
364 buffer = Qnil;
365 else
367 buffer = args[2];
369 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
370 FILE-FOR-STDERR), unless the first element is :file, in which case see
371 the next paragraph. */
372 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
374 if (CONSP (XCDR (buffer)))
376 Lisp_Object stderr_file;
377 stderr_file = XCAR (XCDR (buffer));
379 if (NILP (stderr_file) || EQ (Qt, stderr_file))
380 error_file = stderr_file;
381 else
382 error_file = Fexpand_file_name (stderr_file, Qnil);
385 buffer = XCAR (buffer);
388 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
389 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
391 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
392 BVAR (current_buffer, directory));
393 CHECK_STRING (output_file);
394 buffer = Qnil;
397 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
399 Lisp_Object spec_buffer;
400 spec_buffer = buffer;
401 buffer = Fget_buffer_create (buffer);
402 /* Mention the buffer name for a better error message. */
403 if (NILP (buffer))
404 CHECK_BUFFER (spec_buffer);
405 CHECK_BUFFER (buffer);
409 /* Make sure that the child will be able to chdir to the current
410 buffer's current directory, or its unhandled equivalent. We
411 can't just have the child check for an error when it does the
412 chdir, since it's in a vfork. */
413 current_dir = encode_current_directory ();
415 if (STRINGP (error_file))
416 error_file = ENCODE_FILE (error_file);
417 if (STRINGP (output_file))
418 output_file = ENCODE_FILE (output_file);
420 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
422 for (i = 0; i < CALLPROC_FDS; i++)
423 callproc_fd[i] = -1;
424 #ifdef MSDOS
425 synch_process_tempfile = make_number (0);
426 #endif
427 record_unwind_protect_ptr (call_process_kill, callproc_fd);
429 /* Search for program; barf if not found. */
431 int ok;
433 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
434 make_number (X_OK), false);
435 if (ok < 0)
436 report_file_error ("Searching for program", args[0]);
439 /* Remove "/:" from PATH. */
440 path = remove_slash_colon (path);
442 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
444 if (nargs > 4)
446 ptrdiff_t i;
448 argument_coding.dst_multibyte = 0;
449 for (i = 4; i < nargs; i++)
451 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
452 if (CODING_REQUIRE_ENCODING (&argument_coding))
453 /* We must encode this argument. */
454 args[i] = encode_coding_string (&argument_coding, args[i], 1);
456 for (i = 4; i < nargs; i++)
457 new_argv[i - 3] = SSDATA (args[i]);
458 new_argv[i - 3] = 0;
460 else
461 new_argv[1] = 0;
462 path = ENCODE_FILE (path);
463 new_argv[0] = SSDATA (path);
465 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
467 #ifdef MSDOS
468 if (! discard_output && ! STRINGP (output_file))
470 char const *tmpdir = egetenv ("TMPDIR");
471 char const *outf = tmpdir ? tmpdir : "";
472 tempfile = alloca (strlen (outf) + 20);
473 strcpy (tempfile, outf);
474 dostounix_filename (tempfile);
475 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
476 strcat (tempfile, "/");
477 strcat (tempfile, "emXXXXXX");
478 mktemp (tempfile);
479 if (!*tempfile)
480 report_file_error ("Opening process output file", Qnil);
481 output_file = build_string (tempfile);
482 synch_process_tempfile = output_file;
484 #endif
486 if (discard_output)
488 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
489 if (fd_output < 0)
490 report_file_error ("Opening null device", Qnil);
492 else if (STRINGP (output_file))
494 fd_output = emacs_open (SSDATA (output_file),
495 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
496 default_output_mode);
497 if (fd_output < 0)
499 int open_errno = errno;
500 output_file = DECODE_FILE (output_file);
501 report_file_errno ("Opening process output file",
502 output_file, open_errno);
505 else
507 int fd[2];
508 if (emacs_pipe (fd) != 0)
509 report_file_error ("Creating process pipe", Qnil);
510 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
511 fd_output = fd[1];
513 callproc_fd[CALLPROC_STDOUT] = fd_output;
515 fd_error = fd_output;
517 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
519 fd_error = emacs_open ((STRINGP (error_file)
520 ? SSDATA (error_file)
521 : NULL_DEVICE),
522 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
523 default_output_mode);
524 if (fd_error < 0)
526 int open_errno = errno;
527 report_file_errno ("Cannot redirect stderr",
528 (STRINGP (error_file)
529 ? DECODE_FILE (error_file)
530 : build_string (NULL_DEVICE)),
531 open_errno);
533 callproc_fd[CALLPROC_STDERR] = fd_error;
536 #ifdef MSDOS /* MW, July 1993 */
537 status = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
539 if (status < 0)
541 child_errno = errno;
542 unbind_to (count, Qnil);
543 synchronize_system_messages_locale ();
544 return
545 code_convert_string_norecord (build_string (strerror (child_errno)),
546 Vlocale_coding_system, 0);
549 for (i = 0; i < CALLPROC_FDS; i++)
550 if (0 <= callproc_fd[i])
552 emacs_close (callproc_fd[i]);
553 callproc_fd[i] = -1;
555 emacs_close (filefd);
556 clear_unwind_protect (count - 1);
558 if (tempfile)
560 /* Since CRLF is converted to LF within `decode_coding', we
561 can always open a file with binary mode. */
562 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile, O_RDONLY, 0);
563 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
565 int open_errno = errno;
566 report_file_errno ("Cannot re-open temporary file",
567 build_string (tempfile), open_errno);
571 #endif /* MSDOS */
573 /* Do the unwind-protect now, even though the pid is not known, so
574 that no storage allocation is done in the critical section.
575 The actual PID will be filled in during the critical section. */
576 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
578 #ifndef MSDOS
580 block_input ();
581 block_child_signal (&oldset);
583 #ifdef WINDOWSNT
584 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
585 #else /* not WINDOWSNT */
587 /* vfork, and prevent local vars from being clobbered by the vfork. */
589 Lisp_Object volatile buffer_volatile = buffer;
590 Lisp_Object volatile coding_systems_volatile = coding_systems;
591 Lisp_Object volatile current_dir_volatile = current_dir;
592 bool volatile display_p_volatile = display_p;
593 bool volatile sa_must_free_volatile = sa_must_free;
594 int volatile fd_error_volatile = fd_error;
595 int volatile filefd_volatile = filefd;
596 ptrdiff_t volatile count_volatile = count;
597 ptrdiff_t volatile sa_avail_volatile = sa_avail;
598 ptrdiff_t volatile sa_count_volatile = sa_count;
599 char **volatile new_argv_volatile = new_argv;
600 int volatile callproc_fd_volatile[CALLPROC_FDS];
601 for (i = 0; i < CALLPROC_FDS; i++)
602 callproc_fd_volatile[i] = callproc_fd[i];
604 pid = vfork ();
606 buffer = buffer_volatile;
607 coding_systems = coding_systems_volatile;
608 current_dir = current_dir_volatile;
609 display_p = display_p_volatile;
610 sa_must_free = sa_must_free_volatile;
611 fd_error = fd_error_volatile;
612 filefd = filefd_volatile;
613 count = count_volatile;
614 sa_avail = sa_avail_volatile;
615 sa_count = sa_count_volatile;
616 new_argv = new_argv_volatile;
618 for (i = 0; i < CALLPROC_FDS; i++)
619 callproc_fd[i] = callproc_fd_volatile[i];
620 fd_output = callproc_fd[CALLPROC_STDOUT];
623 if (pid == 0)
625 unblock_child_signal (&oldset);
627 setsid ();
629 /* Emacs ignores SIGPIPE, but the child should not. */
630 signal (SIGPIPE, SIG_DFL);
631 /* Likewise for SIGPROF. */
632 #ifdef SIGPROF
633 signal (SIGPROF, SIG_DFL);
634 #endif
636 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
639 #endif /* not WINDOWSNT */
641 child_errno = errno;
643 if (pid > 0)
645 synch_process_pid = pid;
647 if (INTEGERP (buffer))
649 if (tempfile_index < 0)
650 record_deleted_pid (pid, Qnil);
651 else
653 eassert (1 < nargs);
654 record_deleted_pid (pid, args[1]);
655 clear_unwind_protect (tempfile_index);
657 synch_process_pid = 0;
661 unblock_child_signal (&oldset);
662 unblock_input ();
664 if (pid < 0)
665 report_file_errno ("Doing vfork", Qnil, child_errno);
667 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
668 since we will use that to read input from. */
669 for (i = 0; i < CALLPROC_FDS; i++)
670 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
672 emacs_close (callproc_fd[i]);
673 callproc_fd[i] = -1;
675 emacs_close (filefd);
676 clear_unwind_protect (count - 1);
678 #endif /* not MSDOS */
680 if (INTEGERP (buffer))
681 return unbind_to (count, Qnil);
683 if (BUFFERP (buffer))
684 Fset_buffer (buffer);
686 fd0 = callproc_fd[CALLPROC_PIPEREAD];
688 if (0 <= fd0)
690 Lisp_Object val, *args2;
692 val = Qnil;
693 if (!NILP (Vcoding_system_for_read))
694 val = Vcoding_system_for_read;
695 else
697 if (EQ (coding_systems, Qt))
699 ptrdiff_t i;
701 SAFE_NALLOCA (args2, 1, nargs + 1);
702 args2[0] = Qcall_process;
703 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
704 coding_systems
705 = Ffind_operation_coding_system (nargs + 1, args2);
707 if (CONSP (coding_systems))
708 val = XCAR (coding_systems);
709 else if (CONSP (Vdefault_process_coding_system))
710 val = XCAR (Vdefault_process_coding_system);
711 else
712 val = Qnil;
714 Fcheck_coding_system (val);
715 /* In unibyte mode, character code conversion should not take
716 place but EOL conversion should. So, setup raw-text or one
717 of the subsidiary according to the information just setup. */
718 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
719 && !NILP (val))
720 val = raw_text_coding_system (val);
721 setup_coding_system (val, &process_coding);
722 process_coding.dst_multibyte
723 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
724 process_coding.src_multibyte = 0;
727 maybe_quit ();
729 if (0 <= fd0)
731 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
732 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
733 char buf[CALLPROC_BUFFER_SIZE_MAX];
734 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
735 int nread;
736 EMACS_INT total_read = 0;
737 int carryover = 0;
738 bool display_on_the_fly = display_p;
739 struct coding_system saved_coding = process_coding;
741 while (1)
743 /* Repeatedly read until we've filled as much as possible
744 of the buffer size we have. But don't read
745 less than 1024--save that for the next bufferful. */
746 nread = carryover;
747 while (nread < bufsize - 1024)
749 int this_read = emacs_read (fd0, buf + nread,
750 bufsize - nread);
752 if (this_read < 0)
753 goto give_up;
755 if (this_read == 0)
757 process_coding.mode |= CODING_MODE_LAST_BLOCK;
758 break;
761 nread += this_read;
762 total_read += this_read;
764 if (display_on_the_fly)
765 break;
768 /* Now NREAD is the total amount of data in the buffer. */
770 if (!nread)
772 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
773 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
774 insert_1_both (buf, nread, nread, 0, 1, 0);
775 else
776 { /* We have to decode the input. */
777 Lisp_Object curbuf;
778 ptrdiff_t count1 = SPECPDL_INDEX ();
780 XSETBUFFER (curbuf, current_buffer);
781 /* FIXME: Call signal_after_change! */
782 prepare_to_modify_buffer (PT, PT, NULL);
783 /* We cannot allow after-change-functions be run
784 during decoding, because that might modify the
785 buffer, while we rely on process_coding.produced to
786 faithfully reflect inserted text until we
787 TEMP_SET_PT_BOTH below. */
788 specbind (Qinhibit_modification_hooks, Qt);
789 decode_coding_c_string (&process_coding,
790 (unsigned char *) buf, nread, curbuf);
791 unbind_to (count1, Qnil);
792 if (display_on_the_fly
793 && CODING_REQUIRE_DETECTION (&saved_coding)
794 && ! CODING_REQUIRE_DETECTION (&process_coding))
796 /* We have detected some coding system, but the
797 detection may have been via insufficient data.
798 So give up displaying on the fly. */
799 if (process_coding.produced > 0)
800 del_range_2 (process_coding.dst_pos,
801 process_coding.dst_pos_byte,
802 (process_coding.dst_pos
803 + process_coding.produced_char),
804 (process_coding.dst_pos_byte
805 + process_coding.produced),
807 display_on_the_fly = false;
808 process_coding = saved_coding;
809 carryover = nread;
810 /* Make the above condition always fail in the future. */
811 saved_coding.common_flags
812 &= ~CODING_REQUIRE_DETECTION_MASK;
813 continue;
816 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
817 PT_BYTE + process_coding.produced);
818 carryover = process_coding.carryover_bytes;
819 if (carryover > 0)
820 memcpy (buf, process_coding.carryover,
821 process_coding.carryover_bytes);
824 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
825 break;
827 /* Make the buffer bigger as we continue to read more data,
828 but not past CALLPROC_BUFFER_SIZE_MAX. */
829 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
830 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
831 bufsize = CALLPROC_BUFFER_SIZE_MAX;
833 if (display_p)
835 redisplay_preserve_echo_area (1);
836 /* This variable might have been set to 0 for code
837 detection. In that case, set it back to 1 because
838 we should have already detected a coding system. */
839 display_on_the_fly = true;
842 maybe_quit ();
844 give_up: ;
846 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
847 /* If the caller required, let the buffer inherit the
848 coding-system used to decode the process output. */
849 if (inherit_process_coding_system)
850 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
851 make_number (total_read));
854 #ifndef MSDOS
855 /* Wait for it to terminate, unless it already has. */
856 wait_for_termination (pid, &status, fd0 < 0);
857 #endif
859 /* Don't kill any children that the subprocess may have left behind
860 when exiting. */
861 synch_process_pid = 0;
863 SAFE_FREE ();
864 unbind_to (count, Qnil);
866 if (WIFSIGNALED (status))
868 const char *signame;
870 synchronize_system_messages_locale ();
871 signame = strsignal (WTERMSIG (status));
873 if (signame == 0)
874 signame = "unknown";
876 return code_convert_string_norecord (build_string (signame),
877 Vlocale_coding_system, 0);
880 eassert (WIFEXITED (status));
881 return make_number (WEXITSTATUS (status));
884 /* Create a temporary file suitable for storing the input data of
885 call-process-region. NARGS and ARGS are the same as for
886 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
887 naming the file, and return a file descriptor for reading.
888 Unwind-protect the file, so that the file descriptor will be closed
889 and the file removed when the caller unwinds the specpdl stack. */
891 static int
892 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
893 Lisp_Object *filename_string_ptr)
895 int fd;
896 Lisp_Object filename_string;
897 Lisp_Object val, start, end;
898 Lisp_Object tmpdir;
900 if (STRINGP (Vtemporary_file_directory))
901 tmpdir = Vtemporary_file_directory;
902 else
904 char *outf;
905 #ifndef DOS_NT
906 outf = getenv ("TMPDIR");
907 tmpdir = build_string (outf ? outf : "/tmp/");
908 #else /* DOS_NT */
909 if ((outf = egetenv ("TMPDIR"))
910 || (outf = egetenv ("TMP"))
911 || (outf = egetenv ("TEMP")))
912 tmpdir = build_string (outf);
913 else
914 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
915 #endif
919 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
920 char *tempfile;
921 ptrdiff_t count;
923 #ifdef WINDOWSNT
924 /* Cannot use the result of Fexpand_file_name, because it
925 downcases the XXXXXX part of the pattern, and mktemp then
926 doesn't recognize it. */
927 if (!NILP (Vw32_downcase_file_names))
929 Lisp_Object dirname = Ffile_name_directory (pattern);
931 if (NILP (dirname))
932 pattern = Vtemp_file_name_pattern;
933 else
934 pattern = concat2 (dirname, Vtemp_file_name_pattern);
936 #endif
938 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
939 tempfile = SSDATA (filename_string);
941 count = SPECPDL_INDEX ();
942 record_unwind_protect_nothing ();
943 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
944 if (fd < 0)
945 report_file_error ("Failed to open temporary file using pattern",
946 pattern);
947 set_unwind_protect (count, delete_temp_file, filename_string);
948 record_unwind_protect_int (close_file_unwind, fd);
951 start = args[0];
952 end = args[1];
953 /* Decide coding-system of the contents of the temporary file. */
954 if (!NILP (Vcoding_system_for_write))
955 val = Vcoding_system_for_write;
956 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
957 val = Qraw_text;
958 else
960 Lisp_Object coding_systems;
961 Lisp_Object *args2;
962 USE_SAFE_ALLOCA;
963 SAFE_NALLOCA (args2, 1, nargs + 1);
964 args2[0] = Qcall_process_region;
965 memcpy (args2 + 1, args, nargs * sizeof *args);
966 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
967 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
968 SAFE_FREE ();
970 val = complement_process_encoding_system (val);
973 ptrdiff_t count1 = SPECPDL_INDEX ();
975 specbind (intern ("coding-system-for-write"), val);
976 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
977 happen to get a ".Z" suffix. */
978 specbind (Qfile_name_handler_alist, Qnil);
979 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
981 unbind_to (count1, Qnil);
984 if (lseek (fd, 0, SEEK_SET) < 0)
985 report_file_error ("Setting file position", filename_string);
987 /* Note that Fcall_process takes care of binding
988 coding-system-for-read. */
990 *filename_string_ptr = filename_string;
991 return fd;
994 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
995 3, MANY, 0,
996 doc: /* Send text from START to END to a synchronous process running PROGRAM.
998 START and END are normally buffer positions specifying the part of the
999 buffer to send to the process.
1000 If START is nil, that means to use the entire buffer contents; END is
1001 ignored.
1002 If START is a string, then send that string to the process
1003 instead of any buffer contents; END is ignored.
1004 The remaining arguments are optional.
1005 Delete the text if fourth arg DELETE is non-nil.
1007 Insert output in BUFFER before point; t means current buffer; nil for
1008 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1009 FILE)', where FILE is a file name string, means that it should be
1010 written to that file (if the file already exists it is overwritten).
1011 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1012 REAL-BUFFER says what to do with standard output, as above,
1013 while STDERR-FILE says what to do with standard error in the child.
1014 STDERR-FILE may be nil (discard standard error output),
1015 t (mix it with ordinary output), or a file name string.
1017 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1018 Remaining args are passed to PROGRAM at startup as command args.
1020 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1021 Otherwise it waits for PROGRAM to terminate
1022 and returns a numeric exit status or a signal description string.
1023 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1025 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1026 (ptrdiff_t nargs, Lisp_Object *args)
1028 Lisp_Object infile, val;
1029 ptrdiff_t count = SPECPDL_INDEX ();
1030 Lisp_Object start = args[0];
1031 Lisp_Object end = args[1];
1032 bool empty_input;
1033 int fd;
1035 if (STRINGP (start))
1036 empty_input = SCHARS (start) == 0;
1037 else if (NILP (start))
1038 empty_input = BEG == Z;
1039 else
1041 validate_region (&args[0], &args[1]);
1042 start = args[0];
1043 end = args[1];
1044 empty_input = XINT (start) == XINT (end);
1047 if (!empty_input)
1048 fd = create_temp_file (nargs, args, &infile);
1049 else
1051 infile = Qnil;
1052 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1053 if (fd < 0)
1054 report_file_error ("Opening null device", Qnil);
1055 record_unwind_protect_int (close_file_unwind, fd);
1058 if (nargs > 3 && !NILP (args[3]))
1059 Fdelete_region (start, end);
1061 if (nargs > 3)
1063 args += 2;
1064 nargs -= 2;
1066 else
1068 args[0] = args[2];
1069 nargs = 2;
1071 args[1] = infile;
1073 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1074 return unbind_to (count, val);
1077 static char **
1078 add_env (char **env, char **new_env, char *string)
1080 char **ep;
1081 bool ok = 1;
1082 if (string == NULL)
1083 return new_env;
1085 /* See if this string duplicates any string already in the env.
1086 If so, don't put it in.
1087 When an env var has multiple definitions,
1088 we keep the definition that comes first in process-environment. */
1089 for (ep = env; ok && ep != new_env; ep++)
1091 char *p = *ep, *q = string;
1092 while (ok)
1094 if (*p && *q != *p)
1095 break;
1096 if (*q == 0)
1097 /* The string is a lone variable name; keep it for now, we
1098 will remove it later. It is a placeholder for a
1099 variable that is not to be included in the environment. */
1100 break;
1101 if (*q == '=')
1102 ok = 0;
1103 p++, q++;
1106 if (ok)
1107 *new_env++ = string;
1108 return new_env;
1111 #ifndef DOS_NT
1113 /* 'exec' failed inside a child running NAME, with error number ERR.
1114 Possibly a vforked child needed to allocate a large vector on the
1115 stack; such a child cannot fall back on malloc because that might
1116 mess up the allocator's data structures in the parent.
1117 Report the error and exit the child. */
1119 static _Noreturn void
1120 exec_failed (char const *name, int err)
1122 /* Avoid deadlock if the child's perror writes to a full pipe; the
1123 pipe's reader is the parent, but with vfork the parent can't
1124 run until the child exits. Truncate the diagnostic instead. */
1125 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1127 errno = err;
1128 emacs_perror (name);
1129 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1132 #else
1134 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1135 fork and exec, and handle alloca exhaustion in a different way. */
1137 static void
1138 exec_failed (char const *name, int err)
1142 #endif
1144 /* This is the last thing run in a newly forked inferior
1145 either synchronous or asynchronous.
1146 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1147 Initialize inferior's priority, pgrp, connected dir and environment.
1148 then exec another program based on new_argv.
1150 If SET_PGRP, put the subprocess into a separate process group.
1152 CURRENT_DIR is an elisp string giving the path of the current
1153 directory the subprocess should have. Since we can't really signal
1154 a decent error from within the child, this should be verified as an
1155 executable directory by the parent.
1157 On GNUish hosts, either exec or return an error number.
1158 On MS-Windows, either return a pid or signal an error.
1159 On MS-DOS, either return an exit status or signal an error. */
1161 CHILD_SETUP_TYPE
1162 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1163 Lisp_Object current_dir)
1165 char **env;
1166 char *pwd_var;
1167 #ifdef WINDOWSNT
1168 int cpid;
1169 HANDLE handles[3];
1170 #else
1171 pid_t pid = getpid ();
1172 #endif /* WINDOWSNT */
1174 /* Note that use of alloca is always safe here. It's obvious for systems
1175 that do not have true vfork or that have true (stack) alloca.
1176 If using vfork and C_ALLOCA (when Emacs used to include
1177 src/alloca.c) it is safe because that changes the superior's
1178 static variables as if the superior had done alloca and will be
1179 cleaned up in the usual way. */
1181 char *temp;
1182 ptrdiff_t i;
1184 i = SBYTES (current_dir);
1185 #ifdef MSDOS
1186 /* MSDOS must have all environment variables malloc'ed, because
1187 low-level libc functions that launch subsidiary processes rely
1188 on that. */
1189 pwd_var = xmalloc (i + 5);
1190 #else
1191 if (MAX_ALLOCA - 5 < i)
1192 exec_failed (new_argv[0], ENOMEM);
1193 pwd_var = alloca (i + 5);
1194 #endif
1195 temp = pwd_var + 4;
1196 memcpy (pwd_var, "PWD=", 4);
1197 lispstpcpy (temp, current_dir);
1199 #ifndef DOS_NT
1200 /* We can't signal an Elisp error here; we're in a vfork. Since
1201 the callers check the current directory before forking, this
1202 should only return an error if the directory's permissions
1203 are changed between the check and this chdir, but we should
1204 at least check. */
1205 if (chdir (temp) < 0)
1206 _exit (EXIT_CANCELED);
1207 #else /* DOS_NT */
1208 /* Get past the drive letter, so that d:/ is left alone. */
1209 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1211 temp += 2;
1212 i -= 2;
1214 #endif /* DOS_NT */
1216 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1217 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1218 temp[--i] = 0;
1221 /* Set `env' to a vector of the strings in the environment. */
1223 register Lisp_Object tem;
1224 register char **new_env;
1225 char **p, **q;
1226 register int new_length;
1227 Lisp_Object display = Qnil;
1229 new_length = 0;
1231 for (tem = Vprocess_environment;
1232 CONSP (tem) && STRINGP (XCAR (tem));
1233 tem = XCDR (tem))
1235 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1236 && (SDATA (XCAR (tem)) [7] == '\0'
1237 || SDATA (XCAR (tem)) [7] == '='))
1238 /* DISPLAY is specified in process-environment. */
1239 display = Qt;
1240 new_length++;
1243 /* If not provided yet, use the frame's DISPLAY. */
1244 if (NILP (display))
1246 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1247 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1248 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1249 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1250 Vinitial_environment);
1251 if (STRINGP (tmp))
1253 display = tmp;
1254 new_length++;
1258 /* new_length + 2 to include PWD and terminating 0. */
1259 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1260 exec_failed (new_argv[0], ENOMEM);
1261 env = new_env = alloca ((new_length + 2) * sizeof *env);
1262 /* If we have a PWD envvar, pass one down,
1263 but with corrected value. */
1264 if (egetenv ("PWD"))
1265 *new_env++ = pwd_var;
1267 if (STRINGP (display))
1269 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1270 exec_failed (new_argv[0], ENOMEM);
1271 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1272 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1273 new_env = add_env (env, new_env, vdata);
1276 /* Overrides. */
1277 for (tem = Vprocess_environment;
1278 CONSP (tem) && STRINGP (XCAR (tem));
1279 tem = XCDR (tem))
1280 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1282 *new_env = 0;
1284 /* Remove variable names without values. */
1285 p = q = env;
1286 while (*p != 0)
1288 while (*q != 0 && strchr (*q, '=') == NULL)
1289 q++;
1290 *p = *q++;
1291 if (*p != 0)
1292 p++;
1297 #ifdef WINDOWSNT
1298 prepare_standard_handles (in, out, err, handles);
1299 set_process_dir (SSDATA (current_dir));
1300 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1301 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1302 reset_standard_handles (in, out, err, handles);
1303 if (cpid == -1)
1304 /* An error occurred while trying to spawn the process. */
1305 report_file_error ("Spawning child process", Qnil);
1306 return cpid;
1308 #else /* not WINDOWSNT */
1310 #ifndef MSDOS
1312 restore_nofile_limit ();
1314 /* Redirect file descriptors and clear the close-on-exec flag on the
1315 redirected ones. IN, OUT, and ERR are close-on-exec so they
1316 need not be closed explicitly. */
1317 dup2 (in, STDIN_FILENO);
1318 dup2 (out, STDOUT_FILENO);
1319 dup2 (err, STDERR_FILENO);
1321 setpgid (0, 0);
1322 tcsetpgrp (0, pid);
1324 int errnum = emacs_exec_file (new_argv[0], new_argv, env);
1325 exec_failed (new_argv[0], errnum);
1327 #else /* MSDOS */
1328 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1329 xfree (pwd_var);
1330 if (pid == -1)
1331 /* An error occurred while trying to run the subprocess. */
1332 report_file_error ("Spawning child process", Qnil);
1333 return pid;
1334 #endif /* MSDOS */
1335 #endif /* not WINDOWSNT */
1338 static bool
1339 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1340 ptrdiff_t *valuelen, Lisp_Object env)
1342 for (; CONSP (env); env = XCDR (env))
1344 Lisp_Object entry = XCAR (env);
1345 if (STRINGP (entry)
1346 && SBYTES (entry) >= varlen
1347 #ifdef WINDOWSNT
1348 /* NT environment variables are case insensitive. */
1349 && ! strnicmp (SSDATA (entry), var, varlen)
1350 #else /* not WINDOWSNT */
1351 && ! memcmp (SDATA (entry), var, varlen)
1352 #endif /* not WINDOWSNT */
1355 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1357 *value = SSDATA (entry) + (varlen + 1);
1358 *valuelen = SBYTES (entry) - (varlen + 1);
1359 return 1;
1361 else if (SBYTES (entry) == varlen)
1363 /* Lone variable names in Vprocess_environment mean that
1364 variable should be removed from the environment. */
1365 *value = NULL;
1366 return 1;
1370 return 0;
1373 static bool
1374 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1375 ptrdiff_t *valuelen, Lisp_Object frame)
1377 /* Try to find VAR in Vprocess_environment first. */
1378 if (getenv_internal_1 (var, varlen, value, valuelen,
1379 Vprocess_environment))
1380 return *value ? 1 : 0;
1382 /* On Windows we make some modifications to Emacs' environment
1383 without recording them in Vprocess_environment. */
1384 #ifdef WINDOWSNT
1386 char* tmpval = getenv (var);
1387 if (tmpval)
1389 *value = tmpval;
1390 *valuelen = strlen (tmpval);
1391 return 1;
1394 #endif
1396 /* For DISPLAY try to get the values from the frame or the initial env. */
1397 if (strcmp (var, "DISPLAY") == 0)
1399 Lisp_Object display
1400 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1401 if (STRINGP (display))
1403 *value = SSDATA (display);
1404 *valuelen = SBYTES (display);
1405 return 1;
1407 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1408 if (getenv_internal_1 (var, varlen, value, valuelen,
1409 Vinitial_environment))
1410 return *value ? 1 : 0;
1413 return 0;
1416 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1417 doc: /* Get the value of environment variable VARIABLE.
1418 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1419 the environment. Otherwise, value is a string.
1421 This function searches `process-environment' for VARIABLE.
1423 If optional parameter ENV is a list, then search this list instead of
1424 `process-environment', and return t when encountering a negative entry
1425 \(an entry for a variable with no value). */)
1426 (Lisp_Object variable, Lisp_Object env)
1428 char *value;
1429 ptrdiff_t valuelen;
1431 CHECK_STRING (variable);
1432 if (CONSP (env))
1434 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1435 &value, &valuelen, env))
1436 return value ? make_string (value, valuelen) : Qt;
1437 else
1438 return Qnil;
1440 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1441 &value, &valuelen, env))
1442 return make_string (value, valuelen);
1443 else
1444 return Qnil;
1447 /* A version of getenv that consults the Lisp environment lists,
1448 easily callable from C. This is usually called from egetenv. */
1449 char *
1450 egetenv_internal (const char *var, ptrdiff_t len)
1452 char *value;
1453 ptrdiff_t valuelen;
1455 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1456 return value;
1457 else
1458 return 0;
1462 /* This is run before init_cmdargs. */
1464 void
1465 init_callproc_1 (void)
1467 #ifdef HAVE_NS
1468 const char *etc_dir = ns_etc_directory ();
1469 const char *path_exec = ns_exec_path ();
1470 #endif
1472 Vdata_directory = decode_env_path ("EMACSDATA",
1473 #ifdef HAVE_NS
1474 etc_dir ? etc_dir :
1475 #endif
1476 PATH_DATA, 0);
1477 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1479 Vdoc_directory = decode_env_path ("EMACSDOC",
1480 #ifdef HAVE_NS
1481 etc_dir ? etc_dir :
1482 #endif
1483 PATH_DOC, 0);
1484 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1486 /* Check the EMACSPATH environment variable, defaulting to the
1487 PATH_EXEC path from epaths.h. */
1488 Vexec_path = decode_env_path ("EMACSPATH",
1489 #ifdef HAVE_NS
1490 path_exec ? path_exec :
1491 #endif
1492 PATH_EXEC, 0);
1493 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1494 /* FIXME? For ns, path_exec should go at the front? */
1495 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1498 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1500 void
1501 init_callproc (void)
1503 bool data_dir = egetenv ("EMACSDATA") != 0;
1505 char *sh;
1506 Lisp_Object tempdir;
1507 #ifdef HAVE_NS
1508 if (data_dir == 0)
1509 data_dir = ns_etc_directory () != 0;
1510 #endif
1512 if (!NILP (Vinstallation_directory))
1514 /* Add to the path the lib-src subdir of the installation dir. */
1515 Lisp_Object tem;
1516 tem = Fexpand_file_name (build_string ("lib-src"),
1517 Vinstallation_directory);
1518 #ifndef MSDOS
1519 /* MSDOS uses wrapped binaries, so don't do this. */
1520 if (NILP (Fmember (tem, Vexec_path)))
1522 #ifdef HAVE_NS
1523 const char *path_exec = ns_exec_path ();
1524 #endif
1525 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1526 Vexec_path = decode_env_path ("EMACSPATH",
1527 #ifdef HAVE_NS
1528 path_exec ? path_exec :
1529 #endif
1530 SSDATA (tem), 0);
1531 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1534 Vexec_directory = Ffile_name_as_directory (tem);
1535 #endif /* not MSDOS */
1537 /* Maybe use ../etc as well as ../lib-src. */
1538 if (data_dir == 0)
1540 tem = Fexpand_file_name (build_string ("etc"),
1541 Vinstallation_directory);
1542 Vdoc_directory = Ffile_name_as_directory (tem);
1546 /* Look for the files that should be in etc. We don't use
1547 Vinstallation_directory, because these files are never installed
1548 near the executable, and they are never in the build
1549 directory when that's different from the source directory.
1551 Instead, if these files are not in the nominal place, we try the
1552 source directory. */
1553 if (data_dir == 0)
1555 Lisp_Object tem, tem1, srcdir;
1556 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1558 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1560 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1561 tem1 = Ffile_exists_p (tem);
1562 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1564 Lisp_Object newdir;
1565 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1566 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1567 tem1 = Ffile_exists_p (tem);
1568 if (!NILP (tem1))
1569 Vdata_directory = newdir;
1573 #ifndef CANNOT_DUMP
1574 if (initialized)
1575 #endif
1577 tempdir = Fdirectory_file_name (Vexec_directory);
1578 if (! file_accessible_directory_p (tempdir))
1579 dir_warning ("arch-dependent data dir", Vexec_directory);
1582 tempdir = Fdirectory_file_name (Vdata_directory);
1583 if (! file_accessible_directory_p (tempdir))
1584 dir_warning ("arch-independent data dir", Vdata_directory);
1586 sh = getenv ("SHELL");
1587 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1589 #ifdef DOS_NT
1590 Vshared_game_score_directory = Qnil;
1591 #else
1592 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1593 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1594 Vshared_game_score_directory = Qnil;
1595 #endif
1598 void
1599 set_initial_environment (void)
1601 char **envp;
1602 for (envp = environ; *envp; envp++)
1603 Vprocess_environment = Fcons (build_string (*envp),
1604 Vprocess_environment);
1605 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1606 to use `delete' and friends on process-environment. */
1607 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1610 void
1611 syms_of_callproc (void)
1613 #ifndef DOS_NT
1614 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1615 #else /* DOS_NT */
1616 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1617 #endif
1618 staticpro (&Vtemp_file_name_pattern);
1620 #ifdef MSDOS
1621 synch_process_tempfile = make_number (0);
1622 staticpro (&synch_process_tempfile);
1623 #endif
1625 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1626 doc: /* File name to load inferior shells from.
1627 Initialized from the SHELL environment variable, or to a system-dependent
1628 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1630 DEFVAR_LISP ("exec-path", Vexec_path,
1631 doc: /* List of directories to search programs to run in subprocesses.
1632 Each element is a string (directory name) or nil (try default directory).
1634 By default the last element of this list is `exec-directory'. The
1635 last element is not always used, for example in shell completion
1636 \(`shell-dynamic-complete-command'). */);
1638 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1639 doc: /* List of suffixes to try to find executable file names.
1640 Each element is a string. */);
1641 Vexec_suffixes = Qnil;
1643 DEFVAR_LISP ("exec-directory", Vexec_directory,
1644 doc: /* Directory for executables for Emacs to invoke.
1645 More generally, this includes any architecture-dependent files
1646 that are built and installed from the Emacs distribution. */);
1648 DEFVAR_LISP ("data-directory", Vdata_directory,
1649 doc: /* Directory of machine-independent files that come with GNU Emacs.
1650 These are files intended for Emacs to use while it runs. */);
1652 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1653 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1654 This is usually the same as `data-directory'. */);
1656 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1657 doc: /* For internal use by the build procedure only.
1658 This is the name of the directory in which the build procedure installed
1659 Emacs's info files; the default value for `Info-default-directory-list'
1660 includes this. */);
1661 Vconfigure_info_directory = build_string (PATH_INFO);
1663 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1664 doc: /* Directory of score files for games which come with GNU Emacs.
1665 If this variable is nil, then Emacs is unable to use a shared directory. */);
1666 #ifdef DOS_NT
1667 Vshared_game_score_directory = Qnil;
1668 #else
1669 Vshared_game_score_directory = build_string (PATH_GAME);
1670 #endif
1672 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1673 doc: /* List of environment variables inherited from the parent process.
1674 Each element should be a string of the form ENVVARNAME=VALUE.
1675 The elements must normally be decoded (using `locale-coding-system') for use. */);
1676 Vinitial_environment = Qnil;
1678 DEFVAR_LISP ("process-environment", Vprocess_environment,
1679 doc: /* List of overridden environment variables for subprocesses to inherit.
1680 Each element should be a string of the form ENVVARNAME=VALUE.
1682 Entries in this list take precedence to those in the frame-local
1683 environments. Therefore, let-binding `process-environment' is an easy
1684 way to temporarily change the value of an environment variable,
1685 irrespective of where it comes from. To use `process-environment' to
1686 remove an environment variable, include only its name in the list,
1687 without "=VALUE".
1689 This variable is set to nil when Emacs starts.
1691 If multiple entries define the same variable, the first one always
1692 takes precedence.
1694 Non-ASCII characters are encoded according to the initial value of
1695 `locale-coding-system', i.e. the elements must normally be decoded for
1696 use.
1698 See `setenv' and `getenv'. */);
1699 Vprocess_environment = Qnil;
1701 defsubr (&Scall_process);
1702 defsubr (&Sgetenv_internal);
1703 defsubr (&Scall_process_region);