Fix M-x hints on Mac port
[emacs.git] / src / callproc.c
blob76b5caa44656f60fe33defda7673d512821d497f
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 <sys/types.h>
26 #include <unistd.h>
28 #include <sys/file.h>
29 #include <fcntl.h>
31 #include "lisp.h"
33 #ifdef WINDOWSNT
34 #define NOMINMAX
35 #include <sys/socket.h> /* for fcntl */
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
46 #include "commands.h"
47 #include "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 immediate_quit = 1;
202 QUIT;
203 wait_for_termination (synch_process_pid, 0, 1);
204 synch_process_pid = 0;
205 immediate_quit = 0;
206 message1 ("Waiting for process to die...done");
208 #endif /* !MSDOS */
211 #ifdef DOS_NT
212 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
213 #else
214 static mode_t const default_output_mode = 0666;
215 #endif
217 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
218 doc: /* Call PROGRAM synchronously in separate process.
219 The remaining arguments are optional.
220 The program's input comes from file INFILE (nil means `/dev/null').
221 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
222 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
223 FILE is a file name string, means that it should be written to that file
224 (if the file already exists it is overwritten).
225 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
226 REAL-BUFFER says what to do with standard output, as above,
227 while STDERR-FILE says what to do with standard error in the child.
228 STDERR-FILE may be nil (discard standard error output),
229 t (mix it with ordinary output), or a file name string.
231 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
232 Remaining arguments are strings passed as command arguments to PROGRAM.
234 If executable PROGRAM can't be found as an executable, `call-process'
235 signals a Lisp error. `call-process' reports errors in execution of
236 the program only through its return and output.
238 If DESTINATION is 0, `call-process' returns immediately with value nil.
239 Otherwise it waits for PROGRAM to terminate
240 and returns a numeric exit status or a signal description string.
241 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
243 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
244 (ptrdiff_t nargs, Lisp_Object *args)
246 Lisp_Object infile, encoded_infile;
247 int filefd;
248 ptrdiff_t count = SPECPDL_INDEX ();
250 if (nargs >= 2 && ! NILP (args[1]))
252 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
253 CHECK_STRING (infile);
255 else
256 infile = build_string (NULL_DEVICE);
258 encoded_infile = ENCODE_FILE (infile);
260 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
261 if (filefd < 0)
262 report_file_error ("Opening process input file", infile);
263 record_unwind_protect_int (close_file_unwind, filefd);
264 return unbind_to (count, call_process (nargs, args, filefd, -1));
267 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
269 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
270 unwinder that is intended to remove the input temporary file; in
271 this case NARGS must be at least 2 and ARGS[1] is the file's name.
273 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
275 static Lisp_Object
276 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
277 ptrdiff_t tempfile_index)
279 Lisp_Object buffer, current_dir, path;
280 bool display_p;
281 int fd0;
282 int callproc_fd[CALLPROC_FDS];
283 int status;
284 ptrdiff_t i;
285 ptrdiff_t count = SPECPDL_INDEX ();
286 USE_SAFE_ALLOCA;
288 char **new_argv;
289 /* File to use for stderr in the child.
290 t means use same as standard output. */
291 Lisp_Object error_file;
292 Lisp_Object output_file = Qnil;
293 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
294 char *tempfile = NULL;
295 int pid;
296 #else
297 sigset_t oldset;
298 pid_t pid;
299 #endif
300 int child_errno;
301 int fd_output, fd_error;
302 struct coding_system process_coding; /* coding-system of process output */
303 struct coding_system argument_coding; /* coding-system of arguments */
304 /* Set to the return value of Ffind_operation_coding_system. */
305 Lisp_Object coding_systems;
306 bool discard_output;
308 if (synch_process_pid)
309 error ("call-process invoked recursively");
311 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
312 coding_systems = Qt;
314 CHECK_STRING (args[0]);
316 error_file = Qt;
318 #ifndef subprocesses
319 /* Without asynchronous processes we cannot have BUFFER == 0. */
320 if (nargs >= 3
321 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
322 error ("Operating system cannot handle asynchronous subprocesses");
323 #endif /* subprocesses */
325 /* Decide the coding-system for giving arguments. */
327 Lisp_Object val, *args2;
329 /* If arguments are supplied, we may have to encode them. */
330 if (nargs >= 5)
332 bool must_encode = 0;
333 Lisp_Object coding_attrs;
335 for (i = 4; i < nargs; i++)
336 CHECK_STRING (args[i]);
338 for (i = 4; i < nargs; i++)
339 if (STRING_MULTIBYTE (args[i]))
340 must_encode = 1;
342 if (!NILP (Vcoding_system_for_write))
343 val = Vcoding_system_for_write;
344 else if (! must_encode)
345 val = Qraw_text;
346 else
348 SAFE_NALLOCA (args2, 1, nargs + 1);
349 args2[0] = Qcall_process;
350 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
351 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
352 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
354 val = complement_process_encoding_system (val);
355 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
356 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
357 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
359 /* We should not use an ASCII incompatible coding system. */
360 val = raw_text_coding_system (val);
361 setup_coding_system (val, &argument_coding);
366 if (nargs < 3)
367 buffer = Qnil;
368 else
370 buffer = args[2];
372 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
373 FILE-FOR-STDERR), unless the first element is :file, in which case see
374 the next paragraph. */
375 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
377 if (CONSP (XCDR (buffer)))
379 Lisp_Object stderr_file;
380 stderr_file = XCAR (XCDR (buffer));
382 if (NILP (stderr_file) || EQ (Qt, stderr_file))
383 error_file = stderr_file;
384 else
385 error_file = Fexpand_file_name (stderr_file, Qnil);
388 buffer = XCAR (buffer);
391 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
392 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
394 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
395 BVAR (current_buffer, directory));
396 CHECK_STRING (output_file);
397 buffer = Qnil;
400 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
402 Lisp_Object spec_buffer;
403 spec_buffer = buffer;
404 buffer = Fget_buffer_create (buffer);
405 /* Mention the buffer name for a better error message. */
406 if (NILP (buffer))
407 CHECK_BUFFER (spec_buffer);
408 CHECK_BUFFER (buffer);
412 /* Make sure that the child will be able to chdir to the current
413 buffer's current directory, or its unhandled equivalent. We
414 can't just have the child check for an error when it does the
415 chdir, since it's in a vfork. */
416 current_dir = encode_current_directory ();
418 if (STRINGP (error_file))
419 error_file = ENCODE_FILE (error_file);
420 if (STRINGP (output_file))
421 output_file = ENCODE_FILE (output_file);
423 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
425 for (i = 0; i < CALLPROC_FDS; i++)
426 callproc_fd[i] = -1;
427 #ifdef MSDOS
428 synch_process_tempfile = make_number (0);
429 #endif
430 record_unwind_protect_ptr (call_process_kill, callproc_fd);
432 /* Search for program; barf if not found. */
434 int ok;
436 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
437 make_number (X_OK), false);
438 if (ok < 0)
439 report_file_error ("Searching for program", args[0]);
442 /* Remove "/:" from PATH. */
443 path = remove_slash_colon (path);
445 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
447 if (nargs > 4)
449 ptrdiff_t i;
451 argument_coding.dst_multibyte = 0;
452 for (i = 4; i < nargs; i++)
454 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
455 if (CODING_REQUIRE_ENCODING (&argument_coding))
456 /* We must encode this argument. */
457 args[i] = encode_coding_string (&argument_coding, args[i], 1);
459 for (i = 4; i < nargs; i++)
460 new_argv[i - 3] = SSDATA (args[i]);
461 new_argv[i - 3] = 0;
463 else
464 new_argv[1] = 0;
465 path = ENCODE_FILE (path);
466 new_argv[0] = SSDATA (path);
468 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
470 #ifdef MSDOS
471 if (! discard_output && ! STRINGP (output_file))
473 char const *tmpdir = egetenv ("TMPDIR");
474 char const *outf = tmpdir ? tmpdir : "";
475 tempfile = alloca (strlen (outf) + 20);
476 strcpy (tempfile, outf);
477 dostounix_filename (tempfile);
478 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
479 strcat (tempfile, "/");
480 strcat (tempfile, "emXXXXXX");
481 mktemp (tempfile);
482 if (!*tempfile)
483 report_file_error ("Opening process output file", Qnil);
484 output_file = build_string (tempfile);
485 synch_process_tempfile = output_file;
487 #endif
489 if (discard_output)
491 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
492 if (fd_output < 0)
493 report_file_error ("Opening null device", Qnil);
495 else if (STRINGP (output_file))
497 fd_output = emacs_open (SSDATA (output_file),
498 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
499 default_output_mode);
500 if (fd_output < 0)
502 int open_errno = errno;
503 output_file = DECODE_FILE (output_file);
504 report_file_errno ("Opening process output file",
505 output_file, open_errno);
508 else
510 int fd[2];
511 if (emacs_pipe (fd) != 0)
512 report_file_error ("Creating process pipe", Qnil);
513 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
514 fd_output = fd[1];
516 callproc_fd[CALLPROC_STDOUT] = fd_output;
518 fd_error = fd_output;
520 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
522 fd_error = emacs_open ((STRINGP (error_file)
523 ? SSDATA (error_file)
524 : NULL_DEVICE),
525 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
526 default_output_mode);
527 if (fd_error < 0)
529 int open_errno = errno;
530 report_file_errno ("Cannot redirect stderr",
531 (STRINGP (error_file)
532 ? DECODE_FILE (error_file)
533 : build_string (NULL_DEVICE)),
534 open_errno);
536 callproc_fd[CALLPROC_STDERR] = fd_error;
539 #ifdef MSDOS /* MW, July 1993 */
540 /* Note that on MSDOS `child_setup' actually returns the child process
541 exit status, not its PID, so assign it to status below. */
542 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
544 if (pid < 0)
546 child_errno = errno;
547 unbind_to (count, Qnil);
548 synchronize_system_messages_locale ();
549 return
550 code_convert_string_norecord (build_string (strerror (child_errno)),
551 Vlocale_coding_system, 0);
553 status = pid;
555 for (i = 0; i < CALLPROC_FDS; i++)
556 if (0 <= callproc_fd[i])
558 emacs_close (callproc_fd[i]);
559 callproc_fd[i] = -1;
561 emacs_close (filefd);
562 clear_unwind_protect (count - 1);
564 if (tempfile)
566 /* Since CRLF is converted to LF within `decode_coding', we
567 can always open a file with binary mode. */
568 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
569 O_RDONLY | O_BINARY, 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 #ifndef WINDOWSNT
1089 static int relocate_fd (int fd, int minfd);
1090 #endif
1092 static char **
1093 add_env (char **env, char **new_env, char *string)
1095 char **ep;
1096 bool ok = 1;
1097 if (string == NULL)
1098 return new_env;
1100 /* See if this string duplicates any string already in the env.
1101 If so, don't put it in.
1102 When an env var has multiple definitions,
1103 we keep the definition that comes first in process-environment. */
1104 for (ep = env; ok && ep != new_env; ep++)
1106 char *p = *ep, *q = string;
1107 while (ok)
1109 if (*p && *q != *p)
1110 break;
1111 if (*q == 0)
1112 /* The string is a lone variable name; keep it for now, we
1113 will remove it later. It is a placeholder for a
1114 variable that is not to be included in the environment. */
1115 break;
1116 if (*q == '=')
1117 ok = 0;
1118 p++, q++;
1121 if (ok)
1122 *new_env++ = string;
1123 return new_env;
1126 #ifndef DOS_NT
1128 /* 'exec' failed inside a child running NAME, with error number ERR.
1129 Possibly a vforked child needed to allocate a large vector on the
1130 stack; such a child cannot fall back on malloc because that might
1131 mess up the allocator's data structures in the parent.
1132 Report the error and exit the child. */
1134 static _Noreturn void
1135 exec_failed (char const *name, int err)
1137 /* Avoid deadlock if the child's perror writes to a full pipe; the
1138 pipe's reader is the parent, but with vfork the parent can't
1139 run until the child exits. Truncate the diagnostic instead. */
1140 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1142 errno = err;
1143 emacs_perror (name);
1144 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1147 #else
1149 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1150 fork and exec, and handle alloca exhaustion in a different way. */
1152 static void
1153 exec_failed (char const *name, int err)
1157 #endif
1159 /* This is the last thing run in a newly forked inferior
1160 either synchronous or asynchronous.
1161 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1162 Initialize inferior's priority, pgrp, connected dir and environment.
1163 then exec another program based on new_argv.
1165 If SET_PGRP, put the subprocess into a separate process group.
1167 CURRENT_DIR is an elisp string giving the path of the current
1168 directory the subprocess should have. Since we can't really signal
1169 a decent error from within the child, this should be verified as an
1170 executable directory by the parent. */
1173 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1174 Lisp_Object current_dir)
1176 char **env;
1177 char *pwd_var;
1178 #ifdef WINDOWSNT
1179 int cpid;
1180 HANDLE handles[3];
1181 #else
1182 pid_t pid = getpid ();
1183 #endif /* WINDOWSNT */
1185 /* Note that use of alloca is always safe here. It's obvious for systems
1186 that do not have true vfork or that have true (stack) alloca.
1187 If using vfork and C_ALLOCA (when Emacs used to include
1188 src/alloca.c) it is safe because that changes the superior's
1189 static variables as if the superior had done alloca and will be
1190 cleaned up in the usual way. */
1192 char *temp;
1193 ptrdiff_t i;
1195 i = SBYTES (current_dir);
1196 #ifdef MSDOS
1197 /* MSDOS must have all environment variables malloc'ed, because
1198 low-level libc functions that launch subsidiary processes rely
1199 on that. */
1200 pwd_var = xmalloc (i + 5);
1201 #else
1202 if (MAX_ALLOCA - 5 < i)
1203 exec_failed (new_argv[0], ENOMEM);
1204 pwd_var = alloca (i + 5);
1205 #endif
1206 temp = pwd_var + 4;
1207 memcpy (pwd_var, "PWD=", 4);
1208 lispstpcpy (temp, current_dir);
1210 #ifndef DOS_NT
1211 /* We can't signal an Elisp error here; we're in a vfork. Since
1212 the callers check the current directory before forking, this
1213 should only return an error if the directory's permissions
1214 are changed between the check and this chdir, but we should
1215 at least check. */
1216 if (chdir (temp) < 0)
1217 _exit (EXIT_CANCELED);
1218 #else /* DOS_NT */
1219 /* Get past the drive letter, so that d:/ is left alone. */
1220 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1222 temp += 2;
1223 i -= 2;
1225 #endif /* DOS_NT */
1227 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1228 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1229 temp[--i] = 0;
1232 /* Set `env' to a vector of the strings in the environment. */
1234 register Lisp_Object tem;
1235 register char **new_env;
1236 char **p, **q;
1237 register int new_length;
1238 Lisp_Object display = Qnil;
1240 new_length = 0;
1242 for (tem = Vprocess_environment;
1243 CONSP (tem) && STRINGP (XCAR (tem));
1244 tem = XCDR (tem))
1246 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1247 && (SDATA (XCAR (tem)) [7] == '\0'
1248 || SDATA (XCAR (tem)) [7] == '='))
1249 /* DISPLAY is specified in process-environment. */
1250 display = Qt;
1251 new_length++;
1254 /* If not provided yet, use the frame's DISPLAY. */
1255 if (NILP (display))
1257 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1258 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1259 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1260 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1261 Vinitial_environment);
1262 if (STRINGP (tmp))
1264 display = tmp;
1265 new_length++;
1269 /* new_length + 2 to include PWD and terminating 0. */
1270 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1271 exec_failed (new_argv[0], ENOMEM);
1272 env = new_env = alloca ((new_length + 2) * sizeof *env);
1273 /* If we have a PWD envvar, pass one down,
1274 but with corrected value. */
1275 if (egetenv ("PWD"))
1276 *new_env++ = pwd_var;
1278 if (STRINGP (display))
1280 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1281 exec_failed (new_argv[0], ENOMEM);
1282 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1283 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1284 new_env = add_env (env, new_env, vdata);
1287 /* Overrides. */
1288 for (tem = Vprocess_environment;
1289 CONSP (tem) && STRINGP (XCAR (tem));
1290 tem = XCDR (tem))
1291 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1293 *new_env = 0;
1295 /* Remove variable names without values. */
1296 p = q = env;
1297 while (*p != 0)
1299 while (*q != 0 && strchr (*q, '=') == NULL)
1300 q++;
1301 *p = *q++;
1302 if (*p != 0)
1303 p++;
1308 #ifdef WINDOWSNT
1309 prepare_standard_handles (in, out, err, handles);
1310 set_process_dir (SDATA (current_dir));
1311 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1312 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1313 reset_standard_handles (in, out, err, handles);
1314 if (cpid == -1)
1315 /* An error occurred while trying to spawn the process. */
1316 report_file_error ("Spawning child process", Qnil);
1317 return cpid;
1319 #else /* not WINDOWSNT */
1320 /* Make sure that in, out, and err are not actually already in
1321 descriptors zero, one, or two; this could happen if Emacs is
1322 started with its standard in, out, or error closed, as might
1323 happen under X. */
1325 int oin = in, oout = out;
1327 /* We have to avoid relocating the same descriptor twice! */
1329 in = relocate_fd (in, 3);
1331 if (out == oin)
1332 out = in;
1333 else
1334 out = relocate_fd (out, 3);
1336 if (err == oin)
1337 err = in;
1338 else if (err == oout)
1339 err = out;
1340 else
1341 err = relocate_fd (err, 3);
1344 #ifndef MSDOS
1345 /* Redirect file descriptors and clear the close-on-exec flag on the
1346 redirected ones. IN, OUT, and ERR are close-on-exec so they
1347 need not be closed explicitly. */
1348 dup2 (in, 0);
1349 dup2 (out, 1);
1350 dup2 (err, 2);
1352 setpgid (0, 0);
1353 tcsetpgrp (0, pid);
1355 execve (new_argv[0], new_argv, env);
1356 exec_failed (new_argv[0], errno);
1358 #else /* MSDOS */
1359 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1360 xfree (pwd_var);
1361 if (pid == -1)
1362 /* An error occurred while trying to run the subprocess. */
1363 report_file_error ("Spawning child process", Qnil);
1364 return pid;
1365 #endif /* MSDOS */
1366 #endif /* not WINDOWSNT */
1369 #ifndef WINDOWSNT
1370 /* Move the file descriptor FD so that its number is not less than MINFD.
1371 If the file descriptor is moved at all, the original is closed on MSDOS,
1372 but not elsewhere as the caller will close it anyway. */
1373 static int
1374 relocate_fd (int fd, int minfd)
1376 if (fd >= minfd)
1377 return fd;
1378 else
1380 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1381 if (new == -1)
1383 emacs_perror ("while setting up child");
1384 _exit (EXIT_CANCELED);
1386 #ifdef MSDOS
1387 emacs_close (fd);
1388 #endif
1389 return new;
1392 #endif /* not WINDOWSNT */
1394 static bool
1395 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1396 ptrdiff_t *valuelen, Lisp_Object env)
1398 for (; CONSP (env); env = XCDR (env))
1400 Lisp_Object entry = XCAR (env);
1401 if (STRINGP (entry)
1402 && SBYTES (entry) >= varlen
1403 #ifdef WINDOWSNT
1404 /* NT environment variables are case insensitive. */
1405 && ! strnicmp (SDATA (entry), var, varlen)
1406 #else /* not WINDOWSNT */
1407 && ! memcmp (SDATA (entry), var, varlen)
1408 #endif /* not WINDOWSNT */
1411 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1413 *value = SSDATA (entry) + (varlen + 1);
1414 *valuelen = SBYTES (entry) - (varlen + 1);
1415 return 1;
1417 else if (SBYTES (entry) == varlen)
1419 /* Lone variable names in Vprocess_environment mean that
1420 variable should be removed from the environment. */
1421 *value = NULL;
1422 return 1;
1426 return 0;
1429 static bool
1430 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1431 ptrdiff_t *valuelen, Lisp_Object frame)
1433 /* Try to find VAR in Vprocess_environment first. */
1434 if (getenv_internal_1 (var, varlen, value, valuelen,
1435 Vprocess_environment))
1436 return *value ? 1 : 0;
1438 /* For DISPLAY try to get the values from the frame or the initial env. */
1439 if (strcmp (var, "DISPLAY") == 0)
1441 Lisp_Object display
1442 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1443 if (STRINGP (display))
1445 *value = SSDATA (display);
1446 *valuelen = SBYTES (display);
1447 return 1;
1449 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1450 if (getenv_internal_1 (var, varlen, value, valuelen,
1451 Vinitial_environment))
1452 return *value ? 1 : 0;
1455 return 0;
1458 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1459 doc: /* Get the value of environment variable VARIABLE.
1460 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1461 the environment. Otherwise, value is a string.
1463 This function searches `process-environment' for VARIABLE.
1465 If optional parameter ENV is a list, then search this list instead of
1466 `process-environment', and return t when encountering a negative entry
1467 \(an entry for a variable with no value). */)
1468 (Lisp_Object variable, Lisp_Object env)
1470 char *value;
1471 ptrdiff_t valuelen;
1473 CHECK_STRING (variable);
1474 if (CONSP (env))
1476 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1477 &value, &valuelen, env))
1478 return value ? make_string (value, valuelen) : Qt;
1479 else
1480 return Qnil;
1482 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1483 &value, &valuelen, env))
1484 return make_string (value, valuelen);
1485 else
1486 return Qnil;
1489 /* A version of getenv that consults the Lisp environment lists,
1490 easily callable from C. This is usually called from egetenv. */
1491 char *
1492 egetenv_internal (const char *var, ptrdiff_t len)
1494 char *value;
1495 ptrdiff_t valuelen;
1497 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1498 return value;
1499 else
1500 return 0;
1504 /* This is run before init_cmdargs. */
1506 void
1507 init_callproc_1 (void)
1509 #ifdef HAVE_NS
1510 const char *etc_dir = ns_etc_directory ();
1511 const char *path_exec = ns_exec_path ();
1512 #endif
1514 Vdata_directory = decode_env_path ("EMACSDATA",
1515 #ifdef HAVE_NS
1516 etc_dir ? etc_dir :
1517 #endif
1518 PATH_DATA, 0);
1519 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1521 Vdoc_directory = decode_env_path ("EMACSDOC",
1522 #ifdef HAVE_NS
1523 etc_dir ? etc_dir :
1524 #endif
1525 PATH_DOC, 0);
1526 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1528 /* Check the EMACSPATH environment variable, defaulting to the
1529 PATH_EXEC path from epaths.h. */
1530 Vexec_path = decode_env_path ("EMACSPATH",
1531 #ifdef HAVE_NS
1532 path_exec ? path_exec :
1533 #endif
1534 PATH_EXEC, 0);
1535 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1536 /* FIXME? For ns, path_exec should go at the front? */
1537 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1540 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1542 void
1543 init_callproc (void)
1545 bool data_dir = egetenv ("EMACSDATA") != 0;
1547 char *sh;
1548 Lisp_Object tempdir;
1549 #ifdef HAVE_NS
1550 if (data_dir == 0)
1551 data_dir = ns_etc_directory () != 0;
1552 #endif
1554 if (!NILP (Vinstallation_directory))
1556 /* Add to the path the lib-src subdir of the installation dir. */
1557 Lisp_Object tem;
1558 tem = Fexpand_file_name (build_string ("lib-src"),
1559 Vinstallation_directory);
1560 #ifndef MSDOS
1561 /* MSDOS uses wrapped binaries, so don't do this. */
1562 if (NILP (Fmember (tem, Vexec_path)))
1564 #ifdef HAVE_NS
1565 const char *path_exec = ns_exec_path ();
1566 #endif
1567 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1568 Vexec_path = decode_env_path ("EMACSPATH",
1569 #ifdef HAVE_NS
1570 path_exec ? path_exec :
1571 #endif
1572 SSDATA (tem), 0);
1573 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1576 Vexec_directory = Ffile_name_as_directory (tem);
1577 #endif /* not MSDOS */
1579 /* Maybe use ../etc as well as ../lib-src. */
1580 if (data_dir == 0)
1582 tem = Fexpand_file_name (build_string ("etc"),
1583 Vinstallation_directory);
1584 Vdoc_directory = Ffile_name_as_directory (tem);
1588 /* Look for the files that should be in etc. We don't use
1589 Vinstallation_directory, because these files are never installed
1590 near the executable, and they are never in the build
1591 directory when that's different from the source directory.
1593 Instead, if these files are not in the nominal place, we try the
1594 source directory. */
1595 if (data_dir == 0)
1597 Lisp_Object tem, tem1, srcdir;
1598 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1600 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1602 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1603 tem1 = Ffile_exists_p (tem);
1604 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1606 Lisp_Object newdir;
1607 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1608 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1609 tem1 = Ffile_exists_p (tem);
1610 if (!NILP (tem1))
1611 Vdata_directory = newdir;
1615 #ifndef CANNOT_DUMP
1616 if (initialized)
1617 #endif
1619 tempdir = Fdirectory_file_name (Vexec_directory);
1620 if (! file_accessible_directory_p (tempdir))
1621 dir_warning ("arch-dependent data dir", Vexec_directory);
1624 tempdir = Fdirectory_file_name (Vdata_directory);
1625 if (! file_accessible_directory_p (tempdir))
1626 dir_warning ("arch-independent data dir", Vdata_directory);
1628 sh = getenv ("SHELL");
1629 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1631 #ifdef DOS_NT
1632 Vshared_game_score_directory = Qnil;
1633 #else
1634 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1635 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1636 Vshared_game_score_directory = Qnil;
1637 #endif
1640 void
1641 set_initial_environment (void)
1643 char **envp;
1644 for (envp = environ; *envp; envp++)
1645 Vprocess_environment = Fcons (build_string (*envp),
1646 Vprocess_environment);
1647 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1648 to use `delete' and friends on process-environment. */
1649 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1652 void
1653 syms_of_callproc (void)
1655 #ifndef DOS_NT
1656 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1657 #else /* DOS_NT */
1658 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1659 #endif
1660 staticpro (&Vtemp_file_name_pattern);
1662 #ifdef MSDOS
1663 synch_process_tempfile = make_number (0);
1664 staticpro (&synch_process_tempfile);
1665 #endif
1667 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1668 doc: /* File name to load inferior shells from.
1669 Initialized from the SHELL environment variable, or to a system-dependent
1670 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1672 DEFVAR_LISP ("exec-path", Vexec_path,
1673 doc: /* List of directories to search programs to run in subprocesses.
1674 Each element is a string (directory name) or nil (try default directory).
1676 By default the last element of this list is `exec-directory'. The
1677 last element is not always used, for example in shell completion
1678 \(`shell-dynamic-complete-command'). */);
1680 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1681 doc: /* List of suffixes to try to find executable file names.
1682 Each element is a string. */);
1683 Vexec_suffixes = Qnil;
1685 DEFVAR_LISP ("exec-directory", Vexec_directory,
1686 doc: /* Directory for executables for Emacs to invoke.
1687 More generally, this includes any architecture-dependent files
1688 that are built and installed from the Emacs distribution. */);
1690 DEFVAR_LISP ("data-directory", Vdata_directory,
1691 doc: /* Directory of machine-independent files that come with GNU Emacs.
1692 These are files intended for Emacs to use while it runs. */);
1694 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1695 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1696 This is usually the same as `data-directory'. */);
1698 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1699 doc: /* For internal use by the build procedure only.
1700 This is the name of the directory in which the build procedure installed
1701 Emacs's info files; the default value for `Info-default-directory-list'
1702 includes this. */);
1703 Vconfigure_info_directory = build_string (PATH_INFO);
1705 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1706 doc: /* Directory of score files for games which come with GNU Emacs.
1707 If this variable is nil, then Emacs is unable to use a shared directory. */);
1708 #ifdef DOS_NT
1709 Vshared_game_score_directory = Qnil;
1710 #else
1711 Vshared_game_score_directory = build_string (PATH_GAME);
1712 #endif
1714 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1715 doc: /* List of environment variables inherited from the parent process.
1716 Each element should be a string of the form ENVVARNAME=VALUE.
1717 The elements must normally be decoded (using `locale-coding-system') for use. */);
1718 Vinitial_environment = Qnil;
1720 DEFVAR_LISP ("process-environment", Vprocess_environment,
1721 doc: /* List of overridden environment variables for subprocesses to inherit.
1722 Each element should be a string of the form ENVVARNAME=VALUE.
1724 Entries in this list take precedence to those in the frame-local
1725 environments. Therefore, let-binding `process-environment' is an easy
1726 way to temporarily change the value of an environment variable,
1727 irrespective of where it comes from. To use `process-environment' to
1728 remove an environment variable, include only its name in the list,
1729 without "=VALUE".
1731 This variable is set to nil when Emacs starts.
1733 If multiple entries define the same variable, the first one always
1734 takes precedence.
1736 Non-ASCII characters are encoded according to the initial value of
1737 `locale-coding-system', i.e. the elements must normally be decoded for
1738 use.
1740 See `setenv' and `getenv'. */);
1741 Vprocess_environment = Qnil;
1743 defsubr (&Scall_process);
1744 defsubr (&Sgetenv_internal);
1745 defsubr (&Scall_process_region);