ibuffer-decompose-filter: Avoid side effects on error
[emacs.git] / src / callproc.c
blob02db3483ff26b955cac96e2c84582b5997b37b89
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2016 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <sys/types.h>
27 #include <unistd.h>
29 #include <sys/file.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 #ifdef WINDOWSNT
35 #define NOMINMAX
36 #include <sys/socket.h> /* for fcntl */
37 #include <windows.h>
38 #include "w32.h"
39 #define _P_NOWAIT 1 /* from process.h */
40 #endif
42 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
43 #include <sys/stat.h>
44 #include <sys/param.h>
45 #endif /* MSDOS */
47 #include "commands.h"
48 #include "buffer.h"
49 #include "coding.h"
50 #include <epaths.h>
51 #include "process.h"
52 #include "syssignal.h"
53 #include "syswait.h"
54 #include "blockinput.h"
55 #include "frame.h"
57 #ifdef MSDOS
58 #include "msdos.h"
59 #endif
61 #ifdef HAVE_NS
62 #include "nsterm.h"
63 #endif
65 /* Pattern used by call-process-region to make temp files. */
66 static Lisp_Object Vtemp_file_name_pattern;
68 /* The next two variables are used while record-unwind-protect is in place
69 during call-process for a subprocess for which record_deleted_pid has
70 not yet been called. At other times, synch_process_pid is zero and
71 synch_process_tempfile's contents are irrelevant. Doing this via static
72 C variables is more convenient than putting them into the arguments
73 of record-unwind-protect, as they need to be updated at randomish
74 times in the code, and Lisp cannot always store these values as
75 Emacs integers. It's safe to use static variables here, as the
76 code is never invoked reentrantly. */
78 /* If nonzero, a process-ID that has not been reaped. */
79 static pid_t synch_process_pid;
81 /* If a string, the name of a temp file that has not been removed. */
82 #ifdef MSDOS
83 static Lisp_Object synch_process_tempfile;
84 #else
85 # define synch_process_tempfile make_number (0)
86 #endif
88 /* Indexes of file descriptors that need closing on call_process_kill. */
89 enum
91 /* The subsidiary process's stdout and stderr. stdin is handled
92 separately, in either Fcall_process_region or create_temp_file. */
93 CALLPROC_STDOUT, CALLPROC_STDERR,
95 /* How to read from a pipe (or substitute) from the subsidiary process. */
96 CALLPROC_PIPEREAD,
98 /* A bound on the number of file descriptors. */
99 CALLPROC_FDS
102 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
104 /* Return the current buffer's working directory, or the home
105 directory if it's unreachable, as a string suitable for a system call.
106 Signal an error if the result would not be an accessible directory. */
108 Lisp_Object
109 encode_current_directory (void)
111 Lisp_Object dir;
113 dir = BVAR (current_buffer, directory);
115 dir = Funhandled_file_name_directory (dir);
117 /* If the file name handler says that dir is unreachable, use
118 a sensible default. */
119 if (NILP (dir))
120 dir = build_string ("~");
122 dir = expand_and_dir_to_file (dir, Qnil);
124 if (NILP (Ffile_accessible_directory_p (dir)))
125 report_file_error ("Setting current directory",
126 BVAR (current_buffer, directory));
128 /* Remove "/:" from DIR and encode it. */
129 dir = ENCODE_FILE (remove_slash_colon (dir));
131 if (! file_accessible_directory_p (dir))
132 report_file_error ("Setting current directory",
133 BVAR (current_buffer, directory));
135 return dir;
138 /* If P is reapable, record it as a deleted process and kill it.
139 Do this in a critical section. Unless PID is wedged it will be
140 reaped on receipt of the first SIGCHLD after the critical section. */
142 void
143 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
145 #ifndef MSDOS
146 sigset_t oldset;
147 block_child_signal (&oldset);
149 if (p->alive)
151 record_deleted_pid (p->pid, tempfile);
152 p->alive = 0;
153 kill (- p->pid, SIGKILL);
156 unblock_child_signal (&oldset);
157 #endif /* !MSDOS */
160 /* Clean up files, file descriptors and processes created by Fcall_process. */
162 static void
163 delete_temp_file (Lisp_Object name)
165 unlink (SSDATA (name));
168 static void
169 call_process_kill (void *ptr)
171 int *callproc_fd = ptr;
172 int i;
173 for (i = 0; i < CALLPROC_FDS; i++)
174 if (0 <= callproc_fd[i])
175 emacs_close (callproc_fd[i]);
177 if (synch_process_pid)
179 struct Lisp_Process proc;
180 proc.alive = 1;
181 proc.pid = synch_process_pid;
182 record_kill_process (&proc, synch_process_tempfile);
183 synch_process_pid = 0;
185 else if (STRINGP (synch_process_tempfile))
186 delete_temp_file (synch_process_tempfile);
189 /* Clean up when exiting Fcall_process: restore the buffer, and
190 kill the subsidiary process group if the process still exists. */
192 static void
193 call_process_cleanup (Lisp_Object buffer)
195 Fset_buffer (buffer);
197 #ifndef MSDOS
198 if (synch_process_pid)
200 kill (-synch_process_pid, SIGINT);
201 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
202 immediate_quit = 1;
203 QUIT;
204 wait_for_termination (synch_process_pid, 0, 1);
205 synch_process_pid = 0;
206 immediate_quit = 0;
207 message1 ("Waiting for process to die...done");
209 #endif /* !MSDOS */
212 #ifdef DOS_NT
213 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
214 #else
215 static mode_t const default_output_mode = 0666;
216 #endif
218 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
219 doc: /* Call PROGRAM synchronously in separate process.
220 The remaining arguments are optional.
221 The program's input comes from file INFILE (nil means `/dev/null').
222 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
223 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
224 FILE is a file name string, means that it should be written to that file
225 (if the file already exists it is overwritten).
226 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
227 REAL-BUFFER says what to do with standard output, as above,
228 while STDERR-FILE says what to do with standard error in the child.
229 STDERR-FILE may be nil (discard standard error output),
230 t (mix it with ordinary output), or a file name string.
232 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
233 Remaining arguments are strings passed as command arguments to PROGRAM.
235 If executable PROGRAM can't be found as an executable, `call-process'
236 signals a Lisp error. `call-process' reports errors in execution of
237 the program only through its return and output.
239 If DESTINATION is 0, `call-process' returns immediately with value nil.
240 Otherwise it waits for PROGRAM to terminate
241 and returns a numeric exit status or a signal description string.
242 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
244 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
245 (ptrdiff_t nargs, Lisp_Object *args)
247 Lisp_Object infile, encoded_infile;
248 int filefd;
249 ptrdiff_t count = SPECPDL_INDEX ();
251 if (nargs >= 2 && ! NILP (args[1]))
253 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
254 CHECK_STRING (infile);
256 else
257 infile = build_string (NULL_DEVICE);
259 encoded_infile = ENCODE_FILE (infile);
261 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
262 if (filefd < 0)
263 report_file_error ("Opening process input file", infile);
264 record_unwind_protect_int (close_file_unwind, filefd);
265 return unbind_to (count, call_process (nargs, args, filefd, -1));
268 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
270 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
271 unwinder that is intended to remove the input temporary file; in
272 this case NARGS must be at least 2 and ARGS[1] is the file's name.
274 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
276 static Lisp_Object
277 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
278 ptrdiff_t tempfile_index)
280 Lisp_Object buffer, current_dir, path;
281 bool display_p;
282 int fd0;
283 int callproc_fd[CALLPROC_FDS];
284 int status;
285 ptrdiff_t i;
286 ptrdiff_t count = SPECPDL_INDEX ();
287 USE_SAFE_ALLOCA;
289 char **new_argv;
290 /* File to use for stderr in the child.
291 t means use same as standard output. */
292 Lisp_Object error_file;
293 Lisp_Object output_file = Qnil;
294 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
295 char *tempfile = NULL;
296 #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 status = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
542 if (status < 0)
544 child_errno = errno;
545 unbind_to (count, Qnil);
546 synchronize_system_messages_locale ();
547 return
548 code_convert_string_norecord (build_string (strerror (child_errno)),
549 Vlocale_coding_system, 0);
552 for (i = 0; i < CALLPROC_FDS; i++)
553 if (0 <= callproc_fd[i])
555 emacs_close (callproc_fd[i]);
556 callproc_fd[i] = -1;
558 emacs_close (filefd);
559 clear_unwind_protect (count - 1);
561 if (tempfile)
563 /* Since CRLF is converted to LF within `decode_coding', we
564 can always open a file with binary mode. */
565 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile, O_RDONLY, 0);
566 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
568 int open_errno = errno;
569 report_file_errno ("Cannot re-open temporary file",
570 build_string (tempfile), open_errno);
574 #endif /* MSDOS */
576 /* Do the unwind-protect now, even though the pid is not known, so
577 that no storage allocation is done in the critical section.
578 The actual PID will be filled in during the critical section. */
579 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
581 #ifndef MSDOS
583 block_input ();
584 block_child_signal (&oldset);
586 #ifdef WINDOWSNT
587 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
588 #else /* not WINDOWSNT */
590 /* vfork, and prevent local vars from being clobbered by the vfork. */
592 Lisp_Object volatile buffer_volatile = buffer;
593 Lisp_Object volatile coding_systems_volatile = coding_systems;
594 Lisp_Object volatile current_dir_volatile = current_dir;
595 bool volatile display_p_volatile = display_p;
596 bool volatile sa_must_free_volatile = sa_must_free;
597 int volatile fd_error_volatile = fd_error;
598 int volatile filefd_volatile = filefd;
599 ptrdiff_t volatile count_volatile = count;
600 ptrdiff_t volatile sa_avail_volatile = sa_avail;
601 ptrdiff_t volatile sa_count_volatile = sa_count;
602 char **volatile new_argv_volatile = new_argv;
603 int volatile callproc_fd_volatile[CALLPROC_FDS];
604 for (i = 0; i < CALLPROC_FDS; i++)
605 callproc_fd_volatile[i] = callproc_fd[i];
607 pid = vfork ();
609 buffer = buffer_volatile;
610 coding_systems = coding_systems_volatile;
611 current_dir = current_dir_volatile;
612 display_p = display_p_volatile;
613 sa_must_free = sa_must_free_volatile;
614 fd_error = fd_error_volatile;
615 filefd = filefd_volatile;
616 count = count_volatile;
617 sa_avail = sa_avail_volatile;
618 sa_count = sa_count_volatile;
619 new_argv = new_argv_volatile;
621 for (i = 0; i < CALLPROC_FDS; i++)
622 callproc_fd[i] = callproc_fd_volatile[i];
623 fd_output = callproc_fd[CALLPROC_STDOUT];
626 if (pid == 0)
628 unblock_child_signal (&oldset);
630 setsid ();
632 /* Emacs ignores SIGPIPE, but the child should not. */
633 signal (SIGPIPE, SIG_DFL);
634 /* Likewise for SIGPROF. */
635 #ifdef SIGPROF
636 signal (SIGPROF, SIG_DFL);
637 #endif
639 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
642 #endif /* not WINDOWSNT */
644 child_errno = errno;
646 if (pid > 0)
648 synch_process_pid = pid;
650 if (INTEGERP (buffer))
652 if (tempfile_index < 0)
653 record_deleted_pid (pid, Qnil);
654 else
656 eassert (1 < nargs);
657 record_deleted_pid (pid, args[1]);
658 clear_unwind_protect (tempfile_index);
660 synch_process_pid = 0;
664 unblock_child_signal (&oldset);
665 unblock_input ();
667 if (pid < 0)
668 report_file_errno ("Doing vfork", Qnil, child_errno);
670 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
671 since we will use that to read input from. */
672 for (i = 0; i < CALLPROC_FDS; i++)
673 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
675 emacs_close (callproc_fd[i]);
676 callproc_fd[i] = -1;
678 emacs_close (filefd);
679 clear_unwind_protect (count - 1);
681 #endif /* not MSDOS */
683 if (INTEGERP (buffer))
684 return unbind_to (count, Qnil);
686 if (BUFFERP (buffer))
687 Fset_buffer (buffer);
689 fd0 = callproc_fd[CALLPROC_PIPEREAD];
691 if (0 <= fd0)
693 Lisp_Object val, *args2;
695 val = Qnil;
696 if (!NILP (Vcoding_system_for_read))
697 val = Vcoding_system_for_read;
698 else
700 if (EQ (coding_systems, Qt))
702 ptrdiff_t i;
704 SAFE_NALLOCA (args2, 1, nargs + 1);
705 args2[0] = Qcall_process;
706 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
707 coding_systems
708 = Ffind_operation_coding_system (nargs + 1, args2);
710 if (CONSP (coding_systems))
711 val = XCAR (coding_systems);
712 else if (CONSP (Vdefault_process_coding_system))
713 val = XCAR (Vdefault_process_coding_system);
714 else
715 val = Qnil;
717 Fcheck_coding_system (val);
718 /* In unibyte mode, character code conversion should not take
719 place but EOL conversion should. So, setup raw-text or one
720 of the subsidiary according to the information just setup. */
721 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
722 && !NILP (val))
723 val = raw_text_coding_system (val);
724 setup_coding_system (val, &process_coding);
725 process_coding.dst_multibyte
726 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
727 process_coding.src_multibyte = 0;
730 immediate_quit = 1;
731 QUIT;
733 if (0 <= fd0)
735 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
736 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
737 char buf[CALLPROC_BUFFER_SIZE_MAX];
738 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
739 int nread;
740 EMACS_INT total_read = 0;
741 int carryover = 0;
742 bool display_on_the_fly = display_p;
743 struct coding_system saved_coding = process_coding;
745 while (1)
747 /* Repeatedly read until we've filled as much as possible
748 of the buffer size we have. But don't read
749 less than 1024--save that for the next bufferful. */
750 nread = carryover;
751 while (nread < bufsize - 1024)
753 int this_read = emacs_read (fd0, buf + nread,
754 bufsize - nread);
756 if (this_read < 0)
757 goto give_up;
759 if (this_read == 0)
761 process_coding.mode |= CODING_MODE_LAST_BLOCK;
762 break;
765 nread += this_read;
766 total_read += this_read;
768 if (display_on_the_fly)
769 break;
772 /* Now NREAD is the total amount of data in the buffer. */
773 immediate_quit = 0;
775 if (!nread)
777 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
778 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
779 insert_1_both (buf, nread, nread, 0, 1, 0);
780 else
781 { /* We have to decode the input. */
782 Lisp_Object curbuf;
783 ptrdiff_t count1 = SPECPDL_INDEX ();
785 XSETBUFFER (curbuf, current_buffer);
786 /* FIXME: Call signal_after_change! */
787 prepare_to_modify_buffer (PT, PT, NULL);
788 /* We cannot allow after-change-functions be run
789 during decoding, because that might modify the
790 buffer, while we rely on process_coding.produced to
791 faithfully reflect inserted text until we
792 TEMP_SET_PT_BOTH below. */
793 specbind (Qinhibit_modification_hooks, Qt);
794 decode_coding_c_string (&process_coding,
795 (unsigned char *) buf, nread, curbuf);
796 unbind_to (count1, Qnil);
797 if (display_on_the_fly
798 && CODING_REQUIRE_DETECTION (&saved_coding)
799 && ! CODING_REQUIRE_DETECTION (&process_coding))
801 /* We have detected some coding system, but the
802 detection may have been via insufficient data.
803 So give up displaying on the fly. */
804 if (process_coding.produced > 0)
805 del_range_2 (process_coding.dst_pos,
806 process_coding.dst_pos_byte,
807 (process_coding.dst_pos
808 + process_coding.produced_char),
809 (process_coding.dst_pos_byte
810 + process_coding.produced),
812 display_on_the_fly = false;
813 process_coding = saved_coding;
814 carryover = nread;
815 /* Make the above condition always fail in the future. */
816 saved_coding.common_flags
817 &= ~CODING_REQUIRE_DETECTION_MASK;
818 continue;
821 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
822 PT_BYTE + process_coding.produced);
823 carryover = process_coding.carryover_bytes;
824 if (carryover > 0)
825 memcpy (buf, process_coding.carryover,
826 process_coding.carryover_bytes);
829 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
830 break;
832 /* Make the buffer bigger as we continue to read more data,
833 but not past CALLPROC_BUFFER_SIZE_MAX. */
834 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
835 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
836 bufsize = CALLPROC_BUFFER_SIZE_MAX;
838 if (display_p)
840 redisplay_preserve_echo_area (1);
841 /* This variable might have been set to 0 for code
842 detection. In that case, set it back to 1 because
843 we should have already detected a coding system. */
844 display_on_the_fly = true;
846 immediate_quit = true;
847 QUIT;
849 give_up: ;
851 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
852 /* If the caller required, let the buffer inherit the
853 coding-system used to decode the process output. */
854 if (inherit_process_coding_system)
855 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
856 make_number (total_read));
859 #ifndef MSDOS
860 /* Wait for it to terminate, unless it already has. */
861 wait_for_termination (pid, &status, fd0 < 0);
862 #endif
864 immediate_quit = 0;
866 /* Don't kill any children that the subprocess may have left behind
867 when exiting. */
868 synch_process_pid = 0;
870 SAFE_FREE ();
871 unbind_to (count, Qnil);
873 if (WIFSIGNALED (status))
875 const char *signame;
877 synchronize_system_messages_locale ();
878 signame = strsignal (WTERMSIG (status));
880 if (signame == 0)
881 signame = "unknown";
883 return code_convert_string_norecord (build_string (signame),
884 Vlocale_coding_system, 0);
887 eassert (WIFEXITED (status));
888 return make_number (WEXITSTATUS (status));
891 /* Create a temporary file suitable for storing the input data of
892 call-process-region. NARGS and ARGS are the same as for
893 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
894 naming the file, and return a file descriptor for reading.
895 Unwind-protect the file, so that the file descriptor will be closed
896 and the file removed when the caller unwinds the specpdl stack. */
898 static int
899 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
900 Lisp_Object *filename_string_ptr)
902 int fd;
903 Lisp_Object filename_string;
904 Lisp_Object val, start, end;
905 Lisp_Object tmpdir;
907 if (STRINGP (Vtemporary_file_directory))
908 tmpdir = Vtemporary_file_directory;
909 else
911 char *outf;
912 #ifndef DOS_NT
913 outf = getenv ("TMPDIR");
914 tmpdir = build_string (outf ? outf : "/tmp/");
915 #else /* DOS_NT */
916 if ((outf = egetenv ("TMPDIR"))
917 || (outf = egetenv ("TMP"))
918 || (outf = egetenv ("TEMP")))
919 tmpdir = build_string (outf);
920 else
921 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
922 #endif
926 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
927 char *tempfile;
928 ptrdiff_t count;
930 #ifdef WINDOWSNT
931 /* Cannot use the result of Fexpand_file_name, because it
932 downcases the XXXXXX part of the pattern, and mktemp then
933 doesn't recognize it. */
934 if (!NILP (Vw32_downcase_file_names))
936 Lisp_Object dirname = Ffile_name_directory (pattern);
938 if (NILP (dirname))
939 pattern = Vtemp_file_name_pattern;
940 else
941 pattern = concat2 (dirname, Vtemp_file_name_pattern);
943 #endif
945 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
946 tempfile = SSDATA (filename_string);
948 count = SPECPDL_INDEX ();
949 record_unwind_protect_nothing ();
950 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
951 if (fd < 0)
952 report_file_error ("Failed to open temporary file using pattern",
953 pattern);
954 set_unwind_protect (count, delete_temp_file, filename_string);
955 record_unwind_protect_int (close_file_unwind, fd);
958 start = args[0];
959 end = args[1];
960 /* Decide coding-system of the contents of the temporary file. */
961 if (!NILP (Vcoding_system_for_write))
962 val = Vcoding_system_for_write;
963 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
964 val = Qraw_text;
965 else
967 Lisp_Object coding_systems;
968 Lisp_Object *args2;
969 USE_SAFE_ALLOCA;
970 SAFE_NALLOCA (args2, 1, nargs + 1);
971 args2[0] = Qcall_process_region;
972 memcpy (args2 + 1, args, nargs * sizeof *args);
973 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
974 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
975 SAFE_FREE ();
977 val = complement_process_encoding_system (val);
980 ptrdiff_t count1 = SPECPDL_INDEX ();
982 specbind (intern ("coding-system-for-write"), val);
983 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
984 happen to get a ".Z" suffix. */
985 specbind (Qfile_name_handler_alist, Qnil);
986 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
988 unbind_to (count1, Qnil);
991 if (lseek (fd, 0, SEEK_SET) < 0)
992 report_file_error ("Setting file position", filename_string);
994 /* Note that Fcall_process takes care of binding
995 coding-system-for-read. */
997 *filename_string_ptr = filename_string;
998 return fd;
1001 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1002 3, MANY, 0,
1003 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1005 START and END are normally buffer positions specifying the part of the
1006 buffer to send to the process.
1007 If START is nil, that means to use the entire buffer contents; END is
1008 ignored.
1009 If START is a string, then send that string to the process
1010 instead of any buffer contents; END is ignored.
1011 The remaining arguments are optional.
1012 Delete the text if fourth arg DELETE is non-nil.
1014 Insert output in BUFFER before point; t means current buffer; nil for
1015 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1016 FILE)', where FILE is a file name string, means that it should be
1017 written to that file (if the file already exists it is overwritten).
1018 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1019 REAL-BUFFER says what to do with standard output, as above,
1020 while STDERR-FILE says what to do with standard error in the child.
1021 STDERR-FILE may be nil (discard standard error output),
1022 t (mix it with ordinary output), or a file name string.
1024 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1025 Remaining args are passed to PROGRAM at startup as command args.
1027 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1028 Otherwise it waits for PROGRAM to terminate
1029 and returns a numeric exit status or a signal description string.
1030 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1032 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1033 (ptrdiff_t nargs, Lisp_Object *args)
1035 Lisp_Object infile, val;
1036 ptrdiff_t count = SPECPDL_INDEX ();
1037 Lisp_Object start = args[0];
1038 Lisp_Object end = args[1];
1039 bool empty_input;
1040 int fd;
1042 if (STRINGP (start))
1043 empty_input = SCHARS (start) == 0;
1044 else if (NILP (start))
1045 empty_input = BEG == Z;
1046 else
1048 validate_region (&args[0], &args[1]);
1049 start = args[0];
1050 end = args[1];
1051 empty_input = XINT (start) == XINT (end);
1054 if (!empty_input)
1055 fd = create_temp_file (nargs, args, &infile);
1056 else
1058 infile = Qnil;
1059 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1060 if (fd < 0)
1061 report_file_error ("Opening null device", Qnil);
1062 record_unwind_protect_int (close_file_unwind, fd);
1065 if (nargs > 3 && !NILP (args[3]))
1066 Fdelete_region (start, end);
1068 if (nargs > 3)
1070 args += 2;
1071 nargs -= 2;
1073 else
1075 args[0] = args[2];
1076 nargs = 2;
1078 args[1] = infile;
1080 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1081 return unbind_to (count, val);
1084 static char **
1085 add_env (char **env, char **new_env, char *string)
1087 char **ep;
1088 bool ok = 1;
1089 if (string == NULL)
1090 return new_env;
1092 /* See if this string duplicates any string already in the env.
1093 If so, don't put it in.
1094 When an env var has multiple definitions,
1095 we keep the definition that comes first in process-environment. */
1096 for (ep = env; ok && ep != new_env; ep++)
1098 char *p = *ep, *q = string;
1099 while (ok)
1101 if (*p && *q != *p)
1102 break;
1103 if (*q == 0)
1104 /* The string is a lone variable name; keep it for now, we
1105 will remove it later. It is a placeholder for a
1106 variable that is not to be included in the environment. */
1107 break;
1108 if (*q == '=')
1109 ok = 0;
1110 p++, q++;
1113 if (ok)
1114 *new_env++ = string;
1115 return new_env;
1118 #ifndef DOS_NT
1120 /* 'exec' failed inside a child running NAME, with error number ERR.
1121 Possibly a vforked child needed to allocate a large vector on the
1122 stack; such a child cannot fall back on malloc because that might
1123 mess up the allocator's data structures in the parent.
1124 Report the error and exit the child. */
1126 static _Noreturn void
1127 exec_failed (char const *name, int err)
1129 /* Avoid deadlock if the child's perror writes to a full pipe; the
1130 pipe's reader is the parent, but with vfork the parent can't
1131 run until the child exits. Truncate the diagnostic instead. */
1132 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1134 errno = err;
1135 emacs_perror (name);
1136 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1139 #else
1141 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1142 fork and exec, and handle alloca exhaustion in a different way. */
1144 static void
1145 exec_failed (char const *name, int err)
1149 #endif
1151 /* This is the last thing run in a newly forked inferior
1152 either synchronous or asynchronous.
1153 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1154 Initialize inferior's priority, pgrp, connected dir and environment.
1155 then exec another program based on new_argv.
1157 If SET_PGRP, put the subprocess into a separate process group.
1159 CURRENT_DIR is an elisp string giving the path of the current
1160 directory the subprocess should have. Since we can't really signal
1161 a decent error from within the child, this should be verified as an
1162 executable directory by the parent.
1164 On GNUish hosts, either exec or return an error number.
1165 On MS-Windows, either return a pid or signal an error.
1166 On MS-DOS, either return an exit status or signal an error. */
1168 CHILD_SETUP_TYPE
1169 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1170 Lisp_Object current_dir)
1172 char **env;
1173 char *pwd_var;
1174 #ifdef WINDOWSNT
1175 int cpid;
1176 HANDLE handles[3];
1177 #else
1178 pid_t pid = getpid ();
1179 #endif /* WINDOWSNT */
1181 /* Note that use of alloca is always safe here. It's obvious for systems
1182 that do not have true vfork or that have true (stack) alloca.
1183 If using vfork and C_ALLOCA (when Emacs used to include
1184 src/alloca.c) it is safe because that changes the superior's
1185 static variables as if the superior had done alloca and will be
1186 cleaned up in the usual way. */
1188 char *temp;
1189 ptrdiff_t i;
1191 i = SBYTES (current_dir);
1192 #ifdef MSDOS
1193 /* MSDOS must have all environment variables malloc'ed, because
1194 low-level libc functions that launch subsidiary processes rely
1195 on that. */
1196 pwd_var = xmalloc (i + 5);
1197 #else
1198 if (MAX_ALLOCA - 5 < i)
1199 exec_failed (new_argv[0], ENOMEM);
1200 pwd_var = alloca (i + 5);
1201 #endif
1202 temp = pwd_var + 4;
1203 memcpy (pwd_var, "PWD=", 4);
1204 lispstpcpy (temp, current_dir);
1206 #ifndef DOS_NT
1207 /* We can't signal an Elisp error here; we're in a vfork. Since
1208 the callers check the current directory before forking, this
1209 should only return an error if the directory's permissions
1210 are changed between the check and this chdir, but we should
1211 at least check. */
1212 if (chdir (temp) < 0)
1213 _exit (EXIT_CANCELED);
1214 #else /* DOS_NT */
1215 /* Get past the drive letter, so that d:/ is left alone. */
1216 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1218 temp += 2;
1219 i -= 2;
1221 #endif /* DOS_NT */
1223 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1224 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1225 temp[--i] = 0;
1228 /* Set `env' to a vector of the strings in the environment. */
1230 register Lisp_Object tem;
1231 register char **new_env;
1232 char **p, **q;
1233 register int new_length;
1234 Lisp_Object display = Qnil;
1236 new_length = 0;
1238 for (tem = Vprocess_environment;
1239 CONSP (tem) && STRINGP (XCAR (tem));
1240 tem = XCDR (tem))
1242 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1243 && (SDATA (XCAR (tem)) [7] == '\0'
1244 || SDATA (XCAR (tem)) [7] == '='))
1245 /* DISPLAY is specified in process-environment. */
1246 display = Qt;
1247 new_length++;
1250 /* If not provided yet, use the frame's DISPLAY. */
1251 if (NILP (display))
1253 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1254 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1255 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1256 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1257 Vinitial_environment);
1258 if (STRINGP (tmp))
1260 display = tmp;
1261 new_length++;
1265 /* new_length + 2 to include PWD and terminating 0. */
1266 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1267 exec_failed (new_argv[0], ENOMEM);
1268 env = new_env = alloca ((new_length + 2) * sizeof *env);
1269 /* If we have a PWD envvar, pass one down,
1270 but with corrected value. */
1271 if (egetenv ("PWD"))
1272 *new_env++ = pwd_var;
1274 if (STRINGP (display))
1276 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1277 exec_failed (new_argv[0], ENOMEM);
1278 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1279 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1280 new_env = add_env (env, new_env, vdata);
1283 /* Overrides. */
1284 for (tem = Vprocess_environment;
1285 CONSP (tem) && STRINGP (XCAR (tem));
1286 tem = XCDR (tem))
1287 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1289 *new_env = 0;
1291 /* Remove variable names without values. */
1292 p = q = env;
1293 while (*p != 0)
1295 while (*q != 0 && strchr (*q, '=') == NULL)
1296 q++;
1297 *p = *q++;
1298 if (*p != 0)
1299 p++;
1304 #ifdef WINDOWSNT
1305 prepare_standard_handles (in, out, err, handles);
1306 set_process_dir (SSDATA (current_dir));
1307 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1308 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1309 reset_standard_handles (in, out, err, handles);
1310 if (cpid == -1)
1311 /* An error occurred while trying to spawn the process. */
1312 report_file_error ("Spawning child process", Qnil);
1313 return cpid;
1315 #else /* not WINDOWSNT */
1317 #ifndef MSDOS
1319 restore_nofile_limit ();
1321 /* Redirect file descriptors and clear the close-on-exec flag on the
1322 redirected ones. IN, OUT, and ERR are close-on-exec so they
1323 need not be closed explicitly. */
1324 dup2 (in, STDIN_FILENO);
1325 dup2 (out, STDOUT_FILENO);
1326 dup2 (err, STDERR_FILENO);
1328 setpgid (0, 0);
1329 tcsetpgrp (0, pid);
1331 int errnum = emacs_exec_file (new_argv[0], new_argv, env);
1332 exec_failed (new_argv[0], errnum);
1334 #else /* MSDOS */
1335 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1336 xfree (pwd_var);
1337 if (pid == -1)
1338 /* An error occurred while trying to run the subprocess. */
1339 report_file_error ("Spawning child process", Qnil);
1340 return pid;
1341 #endif /* MSDOS */
1342 #endif /* not WINDOWSNT */
1345 static bool
1346 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1347 ptrdiff_t *valuelen, Lisp_Object env)
1349 for (; CONSP (env); env = XCDR (env))
1351 Lisp_Object entry = XCAR (env);
1352 if (STRINGP (entry)
1353 && SBYTES (entry) >= varlen
1354 #ifdef WINDOWSNT
1355 /* NT environment variables are case insensitive. */
1356 && ! strnicmp (SSDATA (entry), var, varlen)
1357 #else /* not WINDOWSNT */
1358 && ! memcmp (SDATA (entry), var, varlen)
1359 #endif /* not WINDOWSNT */
1362 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1364 *value = SSDATA (entry) + (varlen + 1);
1365 *valuelen = SBYTES (entry) - (varlen + 1);
1366 return 1;
1368 else if (SBYTES (entry) == varlen)
1370 /* Lone variable names in Vprocess_environment mean that
1371 variable should be removed from the environment. */
1372 *value = NULL;
1373 return 1;
1377 return 0;
1380 static bool
1381 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1382 ptrdiff_t *valuelen, Lisp_Object frame)
1384 /* Try to find VAR in Vprocess_environment first. */
1385 if (getenv_internal_1 (var, varlen, value, valuelen,
1386 Vprocess_environment))
1387 return *value ? 1 : 0;
1389 /* On Windows we make some modifications to Emacs' environment
1390 without recording them in Vprocess_environment. */
1391 #ifdef WINDOWSNT
1393 char* tmpval = getenv (var);
1394 if (tmpval)
1396 *value = tmpval;
1397 *valuelen = strlen (tmpval);
1398 return 1;
1401 #endif
1403 /* For DISPLAY try to get the values from the frame or the initial env. */
1404 if (strcmp (var, "DISPLAY") == 0)
1406 Lisp_Object display
1407 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1408 if (STRINGP (display))
1410 *value = SSDATA (display);
1411 *valuelen = SBYTES (display);
1412 return 1;
1414 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1415 if (getenv_internal_1 (var, varlen, value, valuelen,
1416 Vinitial_environment))
1417 return *value ? 1 : 0;
1420 return 0;
1423 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1424 doc: /* Get the value of environment variable VARIABLE.
1425 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1426 the environment. Otherwise, value is a string.
1428 This function searches `process-environment' for VARIABLE.
1430 If optional parameter ENV is a list, then search this list instead of
1431 `process-environment', and return t when encountering a negative entry
1432 \(an entry for a variable with no value). */)
1433 (Lisp_Object variable, Lisp_Object env)
1435 char *value;
1436 ptrdiff_t valuelen;
1438 CHECK_STRING (variable);
1439 if (CONSP (env))
1441 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1442 &value, &valuelen, env))
1443 return value ? make_string (value, valuelen) : Qt;
1444 else
1445 return Qnil;
1447 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1448 &value, &valuelen, env))
1449 return make_string (value, valuelen);
1450 else
1451 return Qnil;
1454 /* A version of getenv that consults the Lisp environment lists,
1455 easily callable from C. This is usually called from egetenv. */
1456 char *
1457 egetenv_internal (const char *var, ptrdiff_t len)
1459 char *value;
1460 ptrdiff_t valuelen;
1462 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1463 return value;
1464 else
1465 return 0;
1469 /* This is run before init_cmdargs. */
1471 void
1472 init_callproc_1 (void)
1474 #ifdef HAVE_NS
1475 const char *etc_dir = ns_etc_directory ();
1476 const char *path_exec = ns_exec_path ();
1477 #endif
1479 Vdata_directory = decode_env_path ("EMACSDATA",
1480 #ifdef HAVE_NS
1481 etc_dir ? etc_dir :
1482 #endif
1483 PATH_DATA, 0);
1484 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1486 Vdoc_directory = decode_env_path ("EMACSDOC",
1487 #ifdef HAVE_NS
1488 etc_dir ? etc_dir :
1489 #endif
1490 PATH_DOC, 0);
1491 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1493 /* Check the EMACSPATH environment variable, defaulting to the
1494 PATH_EXEC path from epaths.h. */
1495 Vexec_path = decode_env_path ("EMACSPATH",
1496 #ifdef HAVE_NS
1497 path_exec ? path_exec :
1498 #endif
1499 PATH_EXEC, 0);
1500 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1501 /* FIXME? For ns, path_exec should go at the front? */
1502 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1505 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1507 void
1508 init_callproc (void)
1510 bool data_dir = egetenv ("EMACSDATA") != 0;
1512 char *sh;
1513 Lisp_Object tempdir;
1514 #ifdef HAVE_NS
1515 if (data_dir == 0)
1516 data_dir = ns_etc_directory () != 0;
1517 #endif
1519 if (!NILP (Vinstallation_directory))
1521 /* Add to the path the lib-src subdir of the installation dir. */
1522 Lisp_Object tem;
1523 tem = Fexpand_file_name (build_string ("lib-src"),
1524 Vinstallation_directory);
1525 #ifndef MSDOS
1526 /* MSDOS uses wrapped binaries, so don't do this. */
1527 if (NILP (Fmember (tem, Vexec_path)))
1529 #ifdef HAVE_NS
1530 const char *path_exec = ns_exec_path ();
1531 #endif
1532 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1533 Vexec_path = decode_env_path ("EMACSPATH",
1534 #ifdef HAVE_NS
1535 path_exec ? path_exec :
1536 #endif
1537 SSDATA (tem), 0);
1538 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1541 Vexec_directory = Ffile_name_as_directory (tem);
1542 #endif /* not MSDOS */
1544 /* Maybe use ../etc as well as ../lib-src. */
1545 if (data_dir == 0)
1547 tem = Fexpand_file_name (build_string ("etc"),
1548 Vinstallation_directory);
1549 Vdoc_directory = Ffile_name_as_directory (tem);
1553 /* Look for the files that should be in etc. We don't use
1554 Vinstallation_directory, because these files are never installed
1555 near the executable, and they are never in the build
1556 directory when that's different from the source directory.
1558 Instead, if these files are not in the nominal place, we try the
1559 source directory. */
1560 if (data_dir == 0)
1562 Lisp_Object tem, tem1, srcdir;
1563 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1565 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1567 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1568 tem1 = Ffile_exists_p (tem);
1569 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1571 Lisp_Object newdir;
1572 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1573 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1574 tem1 = Ffile_exists_p (tem);
1575 if (!NILP (tem1))
1576 Vdata_directory = newdir;
1580 #ifndef CANNOT_DUMP
1581 if (initialized)
1582 #endif
1584 tempdir = Fdirectory_file_name (Vexec_directory);
1585 if (! file_accessible_directory_p (tempdir))
1586 dir_warning ("arch-dependent data dir", Vexec_directory);
1589 tempdir = Fdirectory_file_name (Vdata_directory);
1590 if (! file_accessible_directory_p (tempdir))
1591 dir_warning ("arch-independent data dir", Vdata_directory);
1593 sh = getenv ("SHELL");
1594 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1596 #ifdef DOS_NT
1597 Vshared_game_score_directory = Qnil;
1598 #else
1599 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1600 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1601 Vshared_game_score_directory = Qnil;
1602 #endif
1605 void
1606 set_initial_environment (void)
1608 char **envp;
1609 for (envp = environ; *envp; envp++)
1610 Vprocess_environment = Fcons (build_string (*envp),
1611 Vprocess_environment);
1612 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1613 to use `delete' and friends on process-environment. */
1614 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1617 void
1618 syms_of_callproc (void)
1620 #ifndef DOS_NT
1621 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1622 #else /* DOS_NT */
1623 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1624 #endif
1625 staticpro (&Vtemp_file_name_pattern);
1627 #ifdef MSDOS
1628 synch_process_tempfile = make_number (0);
1629 staticpro (&synch_process_tempfile);
1630 #endif
1632 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1633 doc: /* File name to load inferior shells from.
1634 Initialized from the SHELL environment variable, or to a system-dependent
1635 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1637 DEFVAR_LISP ("exec-path", Vexec_path,
1638 doc: /* List of directories to search programs to run in subprocesses.
1639 Each element is a string (directory name) or nil (try default directory).
1641 By default the last element of this list is `exec-directory'. The
1642 last element is not always used, for example in shell completion
1643 \(`shell-dynamic-complete-command'). */);
1645 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1646 doc: /* List of suffixes to try to find executable file names.
1647 Each element is a string. */);
1648 Vexec_suffixes = Qnil;
1650 DEFVAR_LISP ("exec-directory", Vexec_directory,
1651 doc: /* Directory for executables for Emacs to invoke.
1652 More generally, this includes any architecture-dependent files
1653 that are built and installed from the Emacs distribution. */);
1655 DEFVAR_LISP ("data-directory", Vdata_directory,
1656 doc: /* Directory of machine-independent files that come with GNU Emacs.
1657 These are files intended for Emacs to use while it runs. */);
1659 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1660 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1661 This is usually the same as `data-directory'. */);
1663 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1664 doc: /* For internal use by the build procedure only.
1665 This is the name of the directory in which the build procedure installed
1666 Emacs's info files; the default value for `Info-default-directory-list'
1667 includes this. */);
1668 Vconfigure_info_directory = build_string (PATH_INFO);
1670 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1671 doc: /* Directory of score files for games which come with GNU Emacs.
1672 If this variable is nil, then Emacs is unable to use a shared directory. */);
1673 #ifdef DOS_NT
1674 Vshared_game_score_directory = Qnil;
1675 #else
1676 Vshared_game_score_directory = build_string (PATH_GAME);
1677 #endif
1679 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1680 doc: /* List of environment variables inherited from the parent process.
1681 Each element should be a string of the form ENVVARNAME=VALUE.
1682 The elements must normally be decoded (using `locale-coding-system') for use. */);
1683 Vinitial_environment = Qnil;
1685 DEFVAR_LISP ("process-environment", Vprocess_environment,
1686 doc: /* List of overridden environment variables for subprocesses to inherit.
1687 Each element should be a string of the form ENVVARNAME=VALUE.
1689 Entries in this list take precedence to those in the frame-local
1690 environments. Therefore, let-binding `process-environment' is an easy
1691 way to temporarily change the value of an environment variable,
1692 irrespective of where it comes from. To use `process-environment' to
1693 remove an environment variable, include only its name in the list,
1694 without "=VALUE".
1696 This variable is set to nil when Emacs starts.
1698 If multiple entries define the same variable, the first one always
1699 takes precedence.
1701 Non-ASCII characters are encoded according to the initial value of
1702 `locale-coding-system', i.e. the elements must normally be decoded for
1703 use.
1705 See `setenv' and `getenv'. */);
1706 Vprocess_environment = Qnil;
1708 defsubr (&Scall_process);
1709 defsubr (&Sgetenv_internal);
1710 defsubr (&Scall_process_region);