* lisp/select.el: Use lexical-binding.
[emacs.git] / src / callproc.c
blobe3dcc7bbccac254476230f9473091f2ad1797bf5
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2014 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <sys/types.h>
26 #include <unistd.h>
28 #include <sys/file.h>
29 #include <fcntl.h>
31 #include "lisp.h"
33 #ifdef WINDOWSNT
34 #define NOMINMAX
35 #include <sys/socket.h> /* for fcntl */
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
46 #include "commands.h"
47 #include "character.h"
48 #include "buffer.h"
49 #include "ccl.h"
50 #include "coding.h"
51 #include "composite.h"
52 #include <epaths.h>
53 #include "process.h"
54 #include "syssignal.h"
55 #include "systty.h"
56 #include "syswait.h"
57 #include "blockinput.h"
58 #include "frame.h"
59 #include "termhooks.h"
61 #ifdef MSDOS
62 #include "msdos.h"
63 #endif
65 #ifdef HAVE_NS
66 #include "nsterm.h"
67 #endif
69 /* Pattern used by call-process-region to make temp files. */
70 static Lisp_Object Vtemp_file_name_pattern;
72 /* The next two variables are used while record-unwind-protect is in place
73 during call-process for a subprocess for which record_deleted_pid has
74 not yet been called. At other times, synch_process_pid is zero and
75 synch_process_tempfile's contents are irrelevant. Doing this via static
76 C variables is more convenient than putting them into the arguments
77 of record-unwind-protect, as they need to be updated at randomish
78 times in the code, and Lisp cannot always store these values as
79 Emacs integers. It's safe to use static variables here, as the
80 code is never invoked reentrantly. */
82 /* If nonzero, a process-ID that has not been reaped. */
83 static pid_t synch_process_pid;
85 /* If a string, the name of a temp file that has not been removed. */
86 #ifdef MSDOS
87 static Lisp_Object synch_process_tempfile;
88 #else
89 # define synch_process_tempfile make_number (0)
90 #endif
92 /* Indexes of file descriptors that need closing on call_process_kill. */
93 enum
95 /* The subsidiary process's stdout and stderr. stdin is handled
96 separately, in either Fcall_process_region or create_temp_file. */
97 CALLPROC_STDOUT, CALLPROC_STDERR,
99 /* How to read from a pipe (or substitute) from the subsidiary process. */
100 CALLPROC_PIPEREAD,
102 /* A bound on the number of file descriptors. */
103 CALLPROC_FDS
106 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
108 /* Return the current buffer's working directory, or the home
109 directory if it's unreachable, as a string suitable for a system call.
110 Signal an error if the result would not be an accessible directory. */
112 Lisp_Object
113 encode_current_directory (void)
115 Lisp_Object dir;
116 struct gcpro gcpro1;
118 dir = BVAR (current_buffer, directory);
119 GCPRO1 (dir);
121 dir = Funhandled_file_name_directory (dir);
123 /* If the file name handler says that dir is unreachable, use
124 a sensible default. */
125 if (NILP (dir))
126 dir = build_string ("~");
128 dir = expand_and_dir_to_file (dir, Qnil);
130 if (STRING_MULTIBYTE (dir))
131 dir = ENCODE_FILE (dir);
132 if (! file_accessible_directory_p (dir))
133 report_file_error ("Setting current directory",
134 BVAR (current_buffer, directory));
136 RETURN_UNGCPRO (dir);
139 /* If P is reapable, record it as a deleted process and kill it.
140 Do this in a critical section. Unless PID is wedged it will be
141 reaped on receipt of the first SIGCHLD after the critical section. */
143 void
144 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
146 #ifndef MSDOS
147 sigset_t oldset;
148 block_child_signal (&oldset);
150 if (p->alive)
152 record_deleted_pid (p->pid, tempfile);
153 p->alive = 0;
154 kill (- p->pid, SIGKILL);
157 unblock_child_signal (&oldset);
158 #endif /* !MSDOS */
161 /* Clean up files, file descriptors and processes created by Fcall_process. */
163 static void
164 delete_temp_file (Lisp_Object name)
166 unlink (SSDATA (name));
169 static void
170 call_process_kill (void *ptr)
172 int *callproc_fd = ptr;
173 int i;
174 for (i = 0; i < CALLPROC_FDS; i++)
175 if (0 <= callproc_fd[i])
176 emacs_close (callproc_fd[i]);
178 if (synch_process_pid)
180 struct Lisp_Process proc;
181 proc.alive = 1;
182 proc.pid = synch_process_pid;
183 record_kill_process (&proc, synch_process_tempfile);
184 synch_process_pid = 0;
186 else if (STRINGP (synch_process_tempfile))
187 delete_temp_file (synch_process_tempfile);
190 /* Clean up when exiting Fcall_process: restore the buffer, and
191 kill the subsidiary process group if the process still exists. */
193 static void
194 call_process_cleanup (Lisp_Object buffer)
196 Fset_buffer (buffer);
198 #ifndef MSDOS
199 if (synch_process_pid)
201 kill (-synch_process_pid, SIGINT);
202 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
203 immediate_quit = 1;
204 QUIT;
205 wait_for_termination (synch_process_pid, 0, 1);
206 synch_process_pid = 0;
207 immediate_quit = 0;
208 message1 ("Waiting for process to die...done");
210 #endif /* !MSDOS */
213 #ifdef DOS_NT
214 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
215 #else
216 static mode_t const default_output_mode = 0666;
217 #endif
219 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
220 doc: /* Call PROGRAM synchronously in separate process.
221 The remaining arguments are optional.
222 The program's input comes from file INFILE (nil means `/dev/null').
223 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
224 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
225 FILE is a file name string, means that it should be written to that file
226 \(if the file already exists it is overwritten).
227 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
228 REAL-BUFFER says what to do with standard output, as above,
229 while STDERR-FILE says what to do with standard error in the child.
230 STDERR-FILE may be nil (discard standard error output),
231 t (mix it with ordinary output), or a file name string.
233 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
234 Remaining arguments are strings passed as command arguments to PROGRAM.
236 If executable PROGRAM can't be found as an executable, `call-process'
237 signals a Lisp error. `call-process' reports errors in execution of
238 the program only through its return and output.
240 If DESTINATION is 0, `call-process' returns immediately with value nil.
241 Otherwise it waits for PROGRAM to terminate
242 and returns a numeric exit status or a signal description string.
243 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
245 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
246 (ptrdiff_t nargs, Lisp_Object *args)
248 Lisp_Object infile, encoded_infile;
249 int filefd;
250 struct gcpro gcpro1;
251 ptrdiff_t count = SPECPDL_INDEX ();
253 if (nargs >= 2 && ! NILP (args[1]))
255 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
256 CHECK_STRING (infile);
258 else
259 infile = build_string (NULL_DEVICE);
261 GCPRO1 (infile);
262 encoded_infile = STRING_MULTIBYTE (infile) ? ENCODE_FILE (infile) : infile;
264 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
265 if (filefd < 0)
266 report_file_error ("Opening process input file", infile);
267 record_unwind_protect_int (close_file_unwind, filefd);
268 UNGCPRO;
269 return unbind_to (count, call_process (nargs, args, filefd, -1));
272 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
274 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
275 unwinder that is intended to remove the input temporary file; in
276 this case NARGS must be at least 2 and ARGS[1] is the file's name.
278 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
280 static Lisp_Object
281 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
282 ptrdiff_t tempfile_index)
284 Lisp_Object buffer, current_dir, path;
285 bool display_p;
286 int fd0;
287 int callproc_fd[CALLPROC_FDS];
288 int status;
289 ptrdiff_t i;
290 ptrdiff_t count = SPECPDL_INDEX ();
291 USE_SAFE_ALLOCA;
293 char **new_argv;
294 /* File to use for stderr in the child.
295 t means use same as standard output. */
296 Lisp_Object error_file;
297 Lisp_Object output_file = Qnil;
298 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
299 char *tempfile = NULL;
300 int pid;
301 #else
302 sigset_t oldset;
303 pid_t pid;
304 #endif
305 int child_errno;
306 int fd_output, fd_error;
307 struct coding_system process_coding; /* coding-system of process output */
308 struct coding_system argument_coding; /* coding-system of arguments */
309 /* Set to the return value of Ffind_operation_coding_system. */
310 Lisp_Object coding_systems;
311 bool discard_output;
313 if (synch_process_pid)
314 error ("call-process invoked recursively");
316 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
317 coding_systems = Qt;
319 CHECK_STRING (args[0]);
321 error_file = Qt;
323 #ifndef subprocesses
324 /* Without asynchronous processes we cannot have BUFFER == 0. */
325 if (nargs >= 3
326 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
327 error ("Operating system cannot handle asynchronous subprocesses");
328 #endif /* subprocesses */
330 /* Decide the coding-system for giving arguments. */
332 Lisp_Object val, *args2;
334 /* If arguments are supplied, we may have to encode them. */
335 if (nargs >= 5)
337 bool must_encode = 0;
338 Lisp_Object coding_attrs;
340 for (i = 4; i < nargs; i++)
341 CHECK_STRING (args[i]);
343 for (i = 4; i < nargs; i++)
344 if (STRING_MULTIBYTE (args[i]))
345 must_encode = 1;
347 if (!NILP (Vcoding_system_for_write))
348 val = Vcoding_system_for_write;
349 else if (! must_encode)
350 val = Qraw_text;
351 else
353 SAFE_NALLOCA (args2, 1, nargs + 1);
354 args2[0] = Qcall_process;
355 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
356 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
357 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
359 val = complement_process_encoding_system (val);
360 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
361 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
362 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
364 /* We should not use an ASCII incompatible coding system. */
365 val = raw_text_coding_system (val);
366 setup_coding_system (val, &argument_coding);
371 if (nargs < 3)
372 buffer = Qnil;
373 else
375 buffer = args[2];
377 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
378 FILE-FOR-STDERR), unless the first element is :file, in which case see
379 the next paragraph. */
380 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
382 if (CONSP (XCDR (buffer)))
384 Lisp_Object stderr_file;
385 stderr_file = XCAR (XCDR (buffer));
387 if (NILP (stderr_file) || EQ (Qt, stderr_file))
388 error_file = stderr_file;
389 else
390 error_file = Fexpand_file_name (stderr_file, Qnil);
393 buffer = XCAR (buffer);
396 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
397 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
399 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
400 BVAR (current_buffer, directory));
401 CHECK_STRING (output_file);
402 buffer = Qnil;
405 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
407 Lisp_Object spec_buffer;
408 spec_buffer = buffer;
409 buffer = Fget_buffer_create (buffer);
410 /* Mention the buffer name for a better error message. */
411 if (NILP (buffer))
412 CHECK_BUFFER (spec_buffer);
413 CHECK_BUFFER (buffer);
417 /* Make sure that the child will be able to chdir to the current
418 buffer's current directory, or its unhandled equivalent. We
419 can't just have the child check for an error when it does the
420 chdir, since it's in a vfork.
422 We have to GCPRO around this because Fexpand_file_name,
423 Funhandled_file_name_directory, and Ffile_accessible_directory_p
424 might call a file name handling function. The argument list is
425 protected by the caller, so all we really have to worry about is
426 buffer. */
428 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
430 current_dir = encode_current_directory ();
432 GCPRO4 (buffer, current_dir, error_file, output_file);
434 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
435 error_file = ENCODE_FILE (error_file);
436 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
437 output_file = ENCODE_FILE (output_file);
438 UNGCPRO;
441 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
443 for (i = 0; i < CALLPROC_FDS; i++)
444 callproc_fd[i] = -1;
445 #ifdef MSDOS
446 synch_process_tempfile = make_number (0);
447 #endif
448 record_unwind_protect_ptr (call_process_kill, callproc_fd);
450 /* Search for program; barf if not found. */
452 struct gcpro gcpro1, gcpro2, gcpro3;
453 int ok;
455 GCPRO3 (buffer, current_dir, error_file);
456 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
457 make_number (X_OK), false);
458 UNGCPRO;
459 if (ok < 0)
460 report_file_error ("Searching for program", args[0]);
463 /* If program file name starts with /: for quoting a magic name,
464 discard that. */
465 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
466 && SREF (path, 1) == ':')
467 path = Fsubstring (path, make_number (2), Qnil);
469 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
472 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
474 GCPRO4 (buffer, current_dir, path, error_file);
475 if (nargs > 4)
477 ptrdiff_t i;
479 argument_coding.dst_multibyte = 0;
480 for (i = 4; i < nargs; i++)
482 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
483 if (CODING_REQUIRE_ENCODING (&argument_coding))
484 /* We must encode this argument. */
485 args[i] = encode_coding_string (&argument_coding, args[i], 1);
487 for (i = 4; i < nargs; i++)
488 new_argv[i - 3] = SSDATA (args[i]);
489 new_argv[i - 3] = 0;
491 else
492 new_argv[1] = 0;
493 if (STRING_MULTIBYTE (path))
494 path = ENCODE_FILE (path);
495 new_argv[0] = SSDATA (path);
496 UNGCPRO;
499 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
501 #ifdef MSDOS
502 if (! discard_output && ! STRINGP (output_file))
504 char const *tmpdir = egetenv ("TMPDIR");
505 char const *outf = tmpdir ? tmpdir : "";
506 tempfile = alloca (strlen (outf) + 20);
507 strcpy (tempfile, outf);
508 dostounix_filename (tempfile);
509 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
510 strcat (tempfile, "/");
511 strcat (tempfile, "emXXXXXX");
512 mktemp (tempfile);
513 if (!*tempfile)
514 report_file_error ("Opening process output file", Qnil);
515 output_file = build_string (tempfile);
516 synch_process_tempfile = output_file;
518 #endif
520 if (discard_output)
522 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
523 if (fd_output < 0)
524 report_file_error ("Opening null device", Qnil);
526 else if (STRINGP (output_file))
528 fd_output = emacs_open (SSDATA (output_file),
529 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
530 default_output_mode);
531 if (fd_output < 0)
533 int open_errno = errno;
534 output_file = DECODE_FILE (output_file);
535 report_file_errno ("Opening process output file",
536 output_file, open_errno);
539 else
541 int fd[2];
542 if (emacs_pipe (fd) != 0)
543 report_file_error ("Creating process pipe", Qnil);
544 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
545 fd_output = fd[1];
547 callproc_fd[CALLPROC_STDOUT] = fd_output;
549 fd_error = fd_output;
551 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
553 fd_error = emacs_open ((STRINGP (error_file)
554 ? SSDATA (error_file)
555 : NULL_DEVICE),
556 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
557 default_output_mode);
558 if (fd_error < 0)
560 int open_errno = errno;
561 report_file_errno ("Cannot redirect stderr",
562 (STRINGP (error_file)
563 ? DECODE_FILE (error_file)
564 : build_string (NULL_DEVICE)),
565 open_errno);
567 callproc_fd[CALLPROC_STDERR] = fd_error;
570 #ifdef MSDOS /* MW, July 1993 */
571 /* Note that on MSDOS `child_setup' actually returns the child process
572 exit status, not its PID, so assign it to status below. */
573 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
575 if (pid < 0)
577 child_errno = errno;
578 unbind_to (count, Qnil);
579 synchronize_system_messages_locale ();
580 return
581 code_convert_string_norecord (build_string (strerror (child_errno)),
582 Vlocale_coding_system, 0);
584 status = pid;
586 for (i = 0; i < CALLPROC_FDS; i++)
587 if (0 <= callproc_fd[i])
589 emacs_close (callproc_fd[i]);
590 callproc_fd[i] = -1;
592 emacs_close (filefd);
593 clear_unwind_protect (count - 1);
595 if (tempfile)
597 /* Since CRLF is converted to LF within `decode_coding', we
598 can always open a file with binary mode. */
599 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
600 O_RDONLY | O_BINARY, 0);
601 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
603 int open_errno = errno;
604 report_file_errno ("Cannot re-open temporary file",
605 build_string (tempfile), open_errno);
609 #endif /* MSDOS */
611 /* Do the unwind-protect now, even though the pid is not known, so
612 that no storage allocation is done in the critical section.
613 The actual PID will be filled in during the critical section. */
614 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
616 #ifndef MSDOS
618 block_input ();
619 block_child_signal (&oldset);
621 #ifdef WINDOWSNT
622 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
623 #else /* not WINDOWSNT */
625 /* vfork, and prevent local vars from being clobbered by the vfork. */
627 Lisp_Object volatile buffer_volatile = buffer;
628 Lisp_Object volatile coding_systems_volatile = coding_systems;
629 Lisp_Object volatile current_dir_volatile = current_dir;
630 bool volatile display_p_volatile = display_p;
631 bool volatile sa_must_free_volatile = sa_must_free;
632 int volatile fd_error_volatile = fd_error;
633 int volatile filefd_volatile = filefd;
634 ptrdiff_t volatile count_volatile = count;
635 ptrdiff_t volatile sa_avail_volatile = sa_avail;
636 ptrdiff_t volatile sa_count_volatile = sa_count;
637 char **volatile new_argv_volatile = new_argv;
638 int volatile callproc_fd_volatile[CALLPROC_FDS];
639 for (i = 0; i < CALLPROC_FDS; i++)
640 callproc_fd_volatile[i] = callproc_fd[i];
642 pid = vfork ();
644 buffer = buffer_volatile;
645 coding_systems = coding_systems_volatile;
646 current_dir = current_dir_volatile;
647 display_p = display_p_volatile;
648 sa_must_free = sa_must_free_volatile;
649 fd_error = fd_error_volatile;
650 filefd = filefd_volatile;
651 count = count_volatile;
652 sa_avail = sa_avail_volatile;
653 sa_count = sa_count_volatile;
654 new_argv = new_argv_volatile;
656 for (i = 0; i < CALLPROC_FDS; i++)
657 callproc_fd[i] = callproc_fd_volatile[i];
658 fd_output = callproc_fd[CALLPROC_STDOUT];
661 if (pid == 0)
663 unblock_child_signal (&oldset);
665 setsid ();
667 /* Emacs ignores SIGPIPE, but the child should not. */
668 signal (SIGPIPE, SIG_DFL);
669 /* Likewise for SIGPROF. */
670 #ifdef SIGPROF
671 signal (SIGPROF, SIG_DFL);
672 #endif
674 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
677 #endif /* not WINDOWSNT */
679 child_errno = errno;
681 if (pid > 0)
683 synch_process_pid = pid;
685 if (INTEGERP (buffer))
687 if (tempfile_index < 0)
688 record_deleted_pid (pid, Qnil);
689 else
691 eassert (1 < nargs);
692 record_deleted_pid (pid, args[1]);
693 clear_unwind_protect (tempfile_index);
695 synch_process_pid = 0;
699 unblock_child_signal (&oldset);
700 unblock_input ();
702 if (pid < 0)
703 report_file_errno ("Doing vfork", Qnil, child_errno);
705 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
706 since we will use that to read input from. */
707 for (i = 0; i < CALLPROC_FDS; i++)
708 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
710 emacs_close (callproc_fd[i]);
711 callproc_fd[i] = -1;
713 emacs_close (filefd);
714 clear_unwind_protect (count - 1);
716 #endif /* not MSDOS */
718 if (INTEGERP (buffer))
719 return unbind_to (count, Qnil);
721 if (BUFFERP (buffer))
722 Fset_buffer (buffer);
724 fd0 = callproc_fd[CALLPROC_PIPEREAD];
726 if (0 <= fd0)
728 Lisp_Object val, *args2;
730 val = Qnil;
731 if (!NILP (Vcoding_system_for_read))
732 val = Vcoding_system_for_read;
733 else
735 if (EQ (coding_systems, Qt))
737 ptrdiff_t i;
739 SAFE_NALLOCA (args2, 1, nargs + 1);
740 args2[0] = Qcall_process;
741 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
742 coding_systems
743 = Ffind_operation_coding_system (nargs + 1, args2);
745 if (CONSP (coding_systems))
746 val = XCAR (coding_systems);
747 else if (CONSP (Vdefault_process_coding_system))
748 val = XCAR (Vdefault_process_coding_system);
749 else
750 val = Qnil;
752 Fcheck_coding_system (val);
753 /* In unibyte mode, character code conversion should not take
754 place but EOL conversion should. So, setup raw-text or one
755 of the subsidiary according to the information just setup. */
756 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
757 && !NILP (val))
758 val = raw_text_coding_system (val);
759 setup_coding_system (val, &process_coding);
760 process_coding.dst_multibyte
761 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
762 process_coding.src_multibyte = 0;
765 immediate_quit = 1;
766 QUIT;
768 if (0 <= fd0)
770 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
771 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
772 char buf[CALLPROC_BUFFER_SIZE_MAX];
773 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
774 int nread;
775 EMACS_INT total_read = 0;
776 int carryover = 0;
777 bool display_on_the_fly = display_p;
778 struct coding_system saved_coding = process_coding;
780 while (1)
782 /* Repeatedly read until we've filled as much as possible
783 of the buffer size we have. But don't read
784 less than 1024--save that for the next bufferful. */
785 nread = carryover;
786 while (nread < bufsize - 1024)
788 int this_read = emacs_read (fd0, buf + nread,
789 bufsize - nread);
791 if (this_read < 0)
792 goto give_up;
794 if (this_read == 0)
796 process_coding.mode |= CODING_MODE_LAST_BLOCK;
797 break;
800 nread += this_read;
801 total_read += this_read;
803 if (display_on_the_fly)
804 break;
807 /* Now NREAD is the total amount of data in the buffer. */
808 immediate_quit = 0;
810 if (!nread)
812 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
813 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
814 insert_1_both (buf, nread, nread, 0, 1, 0);
815 else
816 { /* We have to decode the input. */
817 Lisp_Object curbuf;
818 ptrdiff_t count1 = SPECPDL_INDEX ();
820 XSETBUFFER (curbuf, current_buffer);
821 /* FIXME: Call signal_after_change! */
822 prepare_to_modify_buffer (PT, PT, NULL);
823 /* We cannot allow after-change-functions be run
824 during decoding, because that might modify the
825 buffer, while we rely on process_coding.produced to
826 faithfully reflect inserted text until we
827 TEMP_SET_PT_BOTH below. */
828 specbind (Qinhibit_modification_hooks, Qt);
829 decode_coding_c_string (&process_coding,
830 (unsigned char *) buf, nread, curbuf);
831 unbind_to (count1, Qnil);
832 if (display_on_the_fly
833 && CODING_REQUIRE_DETECTION (&saved_coding)
834 && ! CODING_REQUIRE_DETECTION (&process_coding))
836 /* We have detected some coding system, but the
837 detection may have been via insufficient data.
838 So give up displaying on the fly. */
839 if (process_coding.produced > 0)
840 del_range_2 (process_coding.dst_pos,
841 process_coding.dst_pos_byte,
842 (process_coding.dst_pos
843 + process_coding.produced_char),
844 (process_coding.dst_pos_byte
845 + process_coding.produced),
847 display_on_the_fly = 0;
848 process_coding = saved_coding;
849 carryover = nread;
850 /* Make the above condition always fail in the future. */
851 saved_coding.common_flags
852 &= ~CODING_REQUIRE_DETECTION_MASK;
853 continue;
856 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
857 PT_BYTE + process_coding.produced);
858 carryover = process_coding.carryover_bytes;
859 if (carryover > 0)
860 memcpy (buf, process_coding.carryover,
861 process_coding.carryover_bytes);
864 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
865 break;
867 /* Make the buffer bigger as we continue to read more data,
868 but not past CALLPROC_BUFFER_SIZE_MAX. */
869 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
870 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
871 bufsize = CALLPROC_BUFFER_SIZE_MAX;
873 if (display_p)
875 redisplay_preserve_echo_area (1);
876 /* This variable might have been set to 0 for code
877 detection. In that case, set it back to 1 because
878 we should have already detected a coding system. */
879 display_on_the_fly = 1;
881 immediate_quit = 1;
882 QUIT;
884 give_up: ;
886 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
887 /* If the caller required, let the buffer inherit the
888 coding-system used to decode the process output. */
889 if (inherit_process_coding_system)
890 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
891 make_number (total_read));
894 #ifndef MSDOS
895 /* Wait for it to terminate, unless it already has. */
896 wait_for_termination (pid, &status, fd0 < 0);
897 #endif
899 immediate_quit = 0;
901 /* Don't kill any children that the subprocess may have left behind
902 when exiting. */
903 synch_process_pid = 0;
905 SAFE_FREE ();
906 unbind_to (count, Qnil);
908 if (WIFSIGNALED (status))
910 const char *signame;
912 synchronize_system_messages_locale ();
913 signame = strsignal (WTERMSIG (status));
915 if (signame == 0)
916 signame = "unknown";
918 return code_convert_string_norecord (build_string (signame),
919 Vlocale_coding_system, 0);
922 eassert (WIFEXITED (status));
923 return make_number (WEXITSTATUS (status));
926 /* Create a temporary file suitable for storing the input data of
927 call-process-region. NARGS and ARGS are the same as for
928 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
929 naming the file, and return a file descriptor for reading.
930 Unwind-protect the file, so that the file descriptor will be closed
931 and the file removed when the caller unwinds the specpdl stack. */
933 static int
934 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
935 Lisp_Object *filename_string_ptr)
937 int fd;
938 struct gcpro gcpro1;
939 Lisp_Object filename_string;
940 Lisp_Object val, start, end;
941 Lisp_Object tmpdir;
943 if (STRINGP (Vtemporary_file_directory))
944 tmpdir = Vtemporary_file_directory;
945 else
947 char *outf;
948 #ifndef DOS_NT
949 outf = getenv ("TMPDIR");
950 tmpdir = build_string (outf ? outf : "/tmp/");
951 #else /* DOS_NT */
952 if ((outf = egetenv ("TMPDIR"))
953 || (outf = egetenv ("TMP"))
954 || (outf = egetenv ("TEMP")))
955 tmpdir = build_string (outf);
956 else
957 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
958 #endif
962 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
963 char *tempfile;
964 ptrdiff_t count;
966 #ifdef WINDOWSNT
967 /* Cannot use the result of Fexpand_file_name, because it
968 downcases the XXXXXX part of the pattern, and mktemp then
969 doesn't recognize it. */
970 if (!NILP (Vw32_downcase_file_names))
972 Lisp_Object dirname = Ffile_name_directory (pattern);
974 if (NILP (dirname))
975 pattern = Vtemp_file_name_pattern;
976 else
977 pattern = concat2 (dirname, Vtemp_file_name_pattern);
979 #endif
981 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
982 GCPRO1 (filename_string);
983 tempfile = SSDATA (filename_string);
985 count = SPECPDL_INDEX ();
986 record_unwind_protect_nothing ();
987 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
988 if (fd < 0)
989 report_file_error ("Failed to open temporary file using pattern",
990 pattern);
991 set_unwind_protect (count, delete_temp_file, filename_string);
992 record_unwind_protect_int (close_file_unwind, fd);
995 start = args[0];
996 end = args[1];
997 /* Decide coding-system of the contents of the temporary file. */
998 if (!NILP (Vcoding_system_for_write))
999 val = Vcoding_system_for_write;
1000 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1001 val = Qraw_text;
1002 else
1004 Lisp_Object coding_systems;
1005 Lisp_Object *args2;
1006 USE_SAFE_ALLOCA;
1007 SAFE_NALLOCA (args2, 1, nargs + 1);
1008 args2[0] = Qcall_process_region;
1009 memcpy (args2 + 1, args, nargs * sizeof *args);
1010 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1011 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1012 SAFE_FREE ();
1014 val = complement_process_encoding_system (val);
1017 ptrdiff_t count1 = SPECPDL_INDEX ();
1019 specbind (intern ("coding-system-for-write"), val);
1020 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1021 happen to get a ".Z" suffix. */
1022 specbind (intern ("file-name-handler-alist"), Qnil);
1023 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
1025 unbind_to (count1, Qnil);
1028 if (lseek (fd, 0, SEEK_SET) < 0)
1029 report_file_error ("Setting file position", filename_string);
1031 /* Note that Fcall_process takes care of binding
1032 coding-system-for-read. */
1034 *filename_string_ptr = filename_string;
1035 UNGCPRO;
1036 return fd;
1039 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1040 3, MANY, 0,
1041 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1042 The remaining arguments are optional.
1043 Delete the text if fourth arg DELETE is non-nil.
1045 Insert output in BUFFER before point; t means current buffer; nil for
1046 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1047 FILE)', where FILE is a file name string, means that it should be
1048 written to that file (if the file already exists it is overwritten).
1049 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1050 REAL-BUFFER says what to do with standard output, as above,
1051 while STDERR-FILE says what to do with standard error in the child.
1052 STDERR-FILE may be nil (discard standard error output),
1053 t (mix it with ordinary output), or a file name string.
1055 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1056 Remaining args are passed to PROGRAM at startup as command args.
1058 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1059 Otherwise it waits for PROGRAM to terminate
1060 and returns a numeric exit status or a signal description string.
1061 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1063 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1064 (ptrdiff_t nargs, Lisp_Object *args)
1066 struct gcpro gcpro1;
1067 Lisp_Object infile, val;
1068 ptrdiff_t count = SPECPDL_INDEX ();
1069 Lisp_Object start = args[0];
1070 Lisp_Object end = args[1];
1071 bool empty_input;
1072 int fd;
1074 if (STRINGP (start))
1075 empty_input = SCHARS (start) == 0;
1076 else if (NILP (start))
1077 empty_input = BEG == Z;
1078 else
1080 validate_region (&args[0], &args[1]);
1081 start = args[0];
1082 end = args[1];
1083 empty_input = XINT (start) == XINT (end);
1086 if (!empty_input)
1087 fd = create_temp_file (nargs, args, &infile);
1088 else
1090 infile = Qnil;
1091 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1092 if (fd < 0)
1093 report_file_error ("Opening null device", Qnil);
1094 record_unwind_protect_int (close_file_unwind, fd);
1097 GCPRO1 (infile);
1099 if (nargs > 3 && !NILP (args[3]))
1100 Fdelete_region (start, end);
1102 if (nargs > 3)
1104 args += 2;
1105 nargs -= 2;
1107 else
1109 args[0] = args[2];
1110 nargs = 2;
1112 args[1] = infile;
1114 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1115 RETURN_UNGCPRO (unbind_to (count, val));
1118 #ifndef WINDOWSNT
1119 static int relocate_fd (int fd, int minfd);
1120 #endif
1122 static char **
1123 add_env (char **env, char **new_env, char *string)
1125 char **ep;
1126 bool ok = 1;
1127 if (string == NULL)
1128 return new_env;
1130 /* See if this string duplicates any string already in the env.
1131 If so, don't put it in.
1132 When an env var has multiple definitions,
1133 we keep the definition that comes first in process-environment. */
1134 for (ep = env; ok && ep != new_env; ep++)
1136 char *p = *ep, *q = string;
1137 while (ok)
1139 if (*q != *p)
1140 break;
1141 if (*q == 0)
1142 /* The string is a lone variable name; keep it for now, we
1143 will remove it later. It is a placeholder for a
1144 variable that is not to be included in the environment. */
1145 break;
1146 if (*q == '=')
1147 ok = 0;
1148 p++, q++;
1151 if (ok)
1152 *new_env++ = string;
1153 return new_env;
1156 #ifndef DOS_NT
1158 /* 'exec' failed inside a child running NAME, with error number ERR.
1159 Possibly a vforked child needed to allocate a large vector on the
1160 stack; such a child cannot fall back on malloc because that might
1161 mess up the allocator's data structures in the parent.
1162 Report the error and exit the child. */
1164 static _Noreturn void
1165 exec_failed (char const *name, int err)
1167 /* Avoid deadlock if the child's perror writes to a full pipe; the
1168 pipe's reader is the parent, but with vfork the parent can't
1169 run until the child exits. Truncate the diagnostic instead. */
1170 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1172 errno = err;
1173 emacs_perror (name);
1174 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1177 #else
1179 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1180 fork and exec, and handle alloca exhaustion in a different way. */
1182 static void
1183 exec_failed (char const *name, int err)
1187 #endif
1189 /* This is the last thing run in a newly forked inferior
1190 either synchronous or asynchronous.
1191 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1192 Initialize inferior's priority, pgrp, connected dir and environment.
1193 then exec another program based on new_argv.
1195 If SET_PGRP, put the subprocess into a separate process group.
1197 CURRENT_DIR is an elisp string giving the path of the current
1198 directory the subprocess should have. Since we can't really signal
1199 a decent error from within the child, this should be verified as an
1200 executable directory by the parent. */
1203 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1204 Lisp_Object current_dir)
1206 char **env;
1207 char *pwd_var;
1208 #ifdef WINDOWSNT
1209 int cpid;
1210 HANDLE handles[3];
1211 #else
1212 pid_t pid = getpid ();
1213 #endif /* WINDOWSNT */
1215 /* Note that use of alloca is always safe here. It's obvious for systems
1216 that do not have true vfork or that have true (stack) alloca.
1217 If using vfork and C_ALLOCA (when Emacs used to include
1218 src/alloca.c) it is safe because that changes the superior's
1219 static variables as if the superior had done alloca and will be
1220 cleaned up in the usual way. */
1222 char *temp;
1223 ptrdiff_t i;
1225 i = SBYTES (current_dir);
1226 #ifdef MSDOS
1227 /* MSDOS must have all environment variables malloc'ed, because
1228 low-level libc functions that launch subsidiary processes rely
1229 on that. */
1230 pwd_var = xmalloc (i + 5);
1231 #else
1232 if (MAX_ALLOCA - 5 < i)
1233 exec_failed (new_argv[0], ENOMEM);
1234 pwd_var = alloca (i + 5);
1235 #endif
1236 temp = pwd_var + 4;
1237 memcpy (pwd_var, "PWD=", 4);
1238 lispstpcpy (temp, current_dir);
1240 #ifndef DOS_NT
1241 /* We can't signal an Elisp error here; we're in a vfork. Since
1242 the callers check the current directory before forking, this
1243 should only return an error if the directory's permissions
1244 are changed between the check and this chdir, but we should
1245 at least check. */
1246 if (chdir (temp) < 0)
1247 _exit (EXIT_CANCELED);
1248 #else /* DOS_NT */
1249 /* Get past the drive letter, so that d:/ is left alone. */
1250 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1252 temp += 2;
1253 i -= 2;
1255 #endif /* DOS_NT */
1257 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1258 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1259 temp[--i] = 0;
1262 /* Set `env' to a vector of the strings in the environment. */
1264 register Lisp_Object tem;
1265 register char **new_env;
1266 char **p, **q;
1267 register int new_length;
1268 Lisp_Object display = Qnil;
1270 new_length = 0;
1272 for (tem = Vprocess_environment;
1273 CONSP (tem) && STRINGP (XCAR (tem));
1274 tem = XCDR (tem))
1276 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1277 && (SDATA (XCAR (tem)) [7] == '\0'
1278 || SDATA (XCAR (tem)) [7] == '='))
1279 /* DISPLAY is specified in process-environment. */
1280 display = Qt;
1281 new_length++;
1284 /* If not provided yet, use the frame's DISPLAY. */
1285 if (NILP (display))
1287 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1288 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1289 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1290 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1291 Vinitial_environment);
1292 if (STRINGP (tmp))
1294 display = tmp;
1295 new_length++;
1299 /* new_length + 2 to include PWD and terminating 0. */
1300 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1301 exec_failed (new_argv[0], ENOMEM);
1302 env = new_env = alloca ((new_length + 2) * sizeof *env);
1303 /* If we have a PWD envvar, pass one down,
1304 but with corrected value. */
1305 if (egetenv ("PWD"))
1306 *new_env++ = pwd_var;
1308 if (STRINGP (display))
1310 char *vdata;
1312 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1313 exec_failed (new_argv[0], ENOMEM);
1314 vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1315 strcpy (vdata, "DISPLAY=");
1316 strcat (vdata, SSDATA (display));
1317 new_env = add_env (env, new_env, vdata);
1320 /* Overrides. */
1321 for (tem = Vprocess_environment;
1322 CONSP (tem) && STRINGP (XCAR (tem));
1323 tem = XCDR (tem))
1324 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1326 *new_env = 0;
1328 /* Remove variable names without values. */
1329 p = q = env;
1330 while (*p != 0)
1332 while (*q != 0 && strchr (*q, '=') == NULL)
1333 q++;
1334 *p = *q++;
1335 if (*p != 0)
1336 p++;
1341 #ifdef WINDOWSNT
1342 prepare_standard_handles (in, out, err, handles);
1343 set_process_dir (SDATA (current_dir));
1344 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1345 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1346 reset_standard_handles (in, out, err, handles);
1347 if (cpid == -1)
1348 /* An error occurred while trying to spawn the process. */
1349 report_file_error ("Spawning child process", Qnil);
1350 return cpid;
1352 #else /* not WINDOWSNT */
1353 /* Make sure that in, out, and err are not actually already in
1354 descriptors zero, one, or two; this could happen if Emacs is
1355 started with its standard in, out, or error closed, as might
1356 happen under X. */
1358 int oin = in, oout = out;
1360 /* We have to avoid relocating the same descriptor twice! */
1362 in = relocate_fd (in, 3);
1364 if (out == oin)
1365 out = in;
1366 else
1367 out = relocate_fd (out, 3);
1369 if (err == oin)
1370 err = in;
1371 else if (err == oout)
1372 err = out;
1373 else
1374 err = relocate_fd (err, 3);
1377 #ifndef MSDOS
1378 /* Redirect file descriptors and clear the close-on-exec flag on the
1379 redirected ones. IN, OUT, and ERR are close-on-exec so they
1380 need not be closed explicitly. */
1381 dup2 (in, 0);
1382 dup2 (out, 1);
1383 dup2 (err, 2);
1385 setpgid (0, 0);
1386 tcsetpgrp (0, pid);
1388 execve (new_argv[0], new_argv, env);
1389 exec_failed (new_argv[0], errno);
1391 #else /* MSDOS */
1392 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1393 xfree (pwd_var);
1394 if (pid == -1)
1395 /* An error occurred while trying to run the subprocess. */
1396 report_file_error ("Spawning child process", Qnil);
1397 return pid;
1398 #endif /* MSDOS */
1399 #endif /* not WINDOWSNT */
1402 #ifndef WINDOWSNT
1403 /* Move the file descriptor FD so that its number is not less than MINFD.
1404 If the file descriptor is moved at all, the original is closed on MSDOS,
1405 but not elsewhere as the caller will close it anyway. */
1406 static int
1407 relocate_fd (int fd, int minfd)
1409 if (fd >= minfd)
1410 return fd;
1411 else
1413 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1414 if (new == -1)
1416 emacs_perror ("while setting up child");
1417 _exit (EXIT_CANCELED);
1419 #ifdef MSDOS
1420 emacs_close (fd);
1421 #endif
1422 return new;
1425 #endif /* not WINDOWSNT */
1427 static bool
1428 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1429 ptrdiff_t *valuelen, Lisp_Object env)
1431 for (; CONSP (env); env = XCDR (env))
1433 Lisp_Object entry = XCAR (env);
1434 if (STRINGP (entry)
1435 && SBYTES (entry) >= varlen
1436 #ifdef WINDOWSNT
1437 /* NT environment variables are case insensitive. */
1438 && ! strnicmp (SDATA (entry), var, varlen)
1439 #else /* not WINDOWSNT */
1440 && ! memcmp (SDATA (entry), var, varlen)
1441 #endif /* not WINDOWSNT */
1444 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1446 *value = SSDATA (entry) + (varlen + 1);
1447 *valuelen = SBYTES (entry) - (varlen + 1);
1448 return 1;
1450 else if (SBYTES (entry) == varlen)
1452 /* Lone variable names in Vprocess_environment mean that
1453 variable should be removed from the environment. */
1454 *value = NULL;
1455 return 1;
1459 return 0;
1462 static bool
1463 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1464 ptrdiff_t *valuelen, Lisp_Object frame)
1466 /* Try to find VAR in Vprocess_environment first. */
1467 if (getenv_internal_1 (var, varlen, value, valuelen,
1468 Vprocess_environment))
1469 return *value ? 1 : 0;
1471 /* For DISPLAY try to get the values from the frame or the initial env. */
1472 if (strcmp (var, "DISPLAY") == 0)
1474 Lisp_Object display
1475 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1476 if (STRINGP (display))
1478 *value = SSDATA (display);
1479 *valuelen = SBYTES (display);
1480 return 1;
1482 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1483 if (getenv_internal_1 (var, varlen, value, valuelen,
1484 Vinitial_environment))
1485 return *value ? 1 : 0;
1488 return 0;
1491 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1492 doc: /* Get the value of environment variable VARIABLE.
1493 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1494 the environment. Otherwise, value is a string.
1496 This function searches `process-environment' for VARIABLE.
1498 If optional parameter ENV is a list, then search this list instead of
1499 `process-environment', and return t when encountering a negative entry
1500 \(an entry for a variable with no value). */)
1501 (Lisp_Object variable, Lisp_Object env)
1503 char *value;
1504 ptrdiff_t valuelen;
1506 CHECK_STRING (variable);
1507 if (CONSP (env))
1509 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1510 &value, &valuelen, env))
1511 return value ? make_string (value, valuelen) : Qt;
1512 else
1513 return Qnil;
1515 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1516 &value, &valuelen, env))
1517 return make_string (value, valuelen);
1518 else
1519 return Qnil;
1522 /* A version of getenv that consults the Lisp environment lists,
1523 easily callable from C. This is usually called from egetenv. */
1524 char *
1525 egetenv_internal (const char *var, ptrdiff_t len)
1527 char *value;
1528 ptrdiff_t valuelen;
1530 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1531 return value;
1532 else
1533 return 0;
1537 /* This is run before init_cmdargs. */
1539 void
1540 init_callproc_1 (void)
1542 #ifdef HAVE_NS
1543 const char *etc_dir = ns_etc_directory ();
1544 const char *path_exec = ns_exec_path ();
1545 #endif
1547 Vdata_directory = decode_env_path ("EMACSDATA",
1548 #ifdef HAVE_NS
1549 etc_dir ? etc_dir :
1550 #endif
1551 PATH_DATA, 0);
1552 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1554 Vdoc_directory = decode_env_path ("EMACSDOC",
1555 #ifdef HAVE_NS
1556 etc_dir ? etc_dir :
1557 #endif
1558 PATH_DOC, 0);
1559 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1561 /* Check the EMACSPATH environment variable, defaulting to the
1562 PATH_EXEC path from epaths.h. */
1563 Vexec_path = decode_env_path ("EMACSPATH",
1564 #ifdef HAVE_NS
1565 path_exec ? path_exec :
1566 #endif
1567 PATH_EXEC, 0);
1568 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1569 /* FIXME? For ns, path_exec should go at the front? */
1570 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1573 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1575 void
1576 init_callproc (void)
1578 bool data_dir = egetenv ("EMACSDATA") != 0;
1580 char *sh;
1581 Lisp_Object tempdir;
1582 #ifdef HAVE_NS
1583 if (data_dir == 0)
1584 data_dir = ns_etc_directory () != 0;
1585 #endif
1587 if (!NILP (Vinstallation_directory))
1589 /* Add to the path the lib-src subdir of the installation dir. */
1590 Lisp_Object tem;
1591 tem = Fexpand_file_name (build_string ("lib-src"),
1592 Vinstallation_directory);
1593 #ifndef MSDOS
1594 /* MSDOS uses wrapped binaries, so don't do this. */
1595 if (NILP (Fmember (tem, Vexec_path)))
1597 #ifdef HAVE_NS
1598 const char *path_exec = ns_exec_path ();
1599 #endif
1600 Vexec_path = decode_env_path ("EMACSPATH",
1601 #ifdef HAVE_NS
1602 path_exec ? path_exec :
1603 #endif
1604 PATH_EXEC, 0);
1605 Vexec_path = Fcons (tem, Vexec_path);
1606 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1609 Vexec_directory = Ffile_name_as_directory (tem);
1610 #endif /* not MSDOS */
1612 /* Maybe use ../etc as well as ../lib-src. */
1613 if (data_dir == 0)
1615 tem = Fexpand_file_name (build_string ("etc"),
1616 Vinstallation_directory);
1617 Vdoc_directory = Ffile_name_as_directory (tem);
1621 /* Look for the files that should be in etc. We don't use
1622 Vinstallation_directory, because these files are never installed
1623 near the executable, and they are never in the build
1624 directory when that's different from the source directory.
1626 Instead, if these files are not in the nominal place, we try the
1627 source directory. */
1628 if (data_dir == 0)
1630 Lisp_Object tem, tem1, srcdir;
1631 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1633 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1635 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1636 tem1 = Ffile_exists_p (tem);
1637 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1639 Lisp_Object newdir;
1640 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1641 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1642 tem1 = Ffile_exists_p (tem);
1643 if (!NILP (tem1))
1644 Vdata_directory = newdir;
1648 #ifndef CANNOT_DUMP
1649 if (initialized)
1650 #endif
1652 tempdir = Fdirectory_file_name (Vexec_directory);
1653 if (! file_accessible_directory_p (tempdir))
1654 dir_warning ("arch-dependent data dir", Vexec_directory);
1657 tempdir = Fdirectory_file_name (Vdata_directory);
1658 if (! file_accessible_directory_p (tempdir))
1659 dir_warning ("arch-independent data dir", Vdata_directory);
1661 sh = getenv ("SHELL");
1662 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1664 #ifdef DOS_NT
1665 Vshared_game_score_directory = Qnil;
1666 #else
1667 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1668 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1669 Vshared_game_score_directory = Qnil;
1670 #endif
1673 void
1674 set_initial_environment (void)
1676 char **envp;
1677 for (envp = environ; *envp; envp++)
1678 Vprocess_environment = Fcons (build_string (*envp),
1679 Vprocess_environment);
1680 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1681 to use `delete' and friends on process-environment. */
1682 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1685 void
1686 syms_of_callproc (void)
1688 #ifndef DOS_NT
1689 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1690 #else /* DOS_NT */
1691 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1692 #endif
1693 staticpro (&Vtemp_file_name_pattern);
1695 #ifdef MSDOS
1696 synch_process_tempfile = make_number (0);
1697 staticpro (&synch_process_tempfile);
1698 #endif
1700 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1701 doc: /* File name to load inferior shells from.
1702 Initialized from the SHELL environment variable, or to a system-dependent
1703 default if SHELL is not set. */);
1705 DEFVAR_LISP ("exec-path", Vexec_path,
1706 doc: /* List of directories to search programs to run in subprocesses.
1707 Each element is a string (directory name) or nil (try default directory).
1709 By default the last element of this list is `exec-directory'. The
1710 last element is not always used, for example in shell completion
1711 (`shell-dynamic-complete-command'). */);
1713 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1714 doc: /* List of suffixes to try to find executable file names.
1715 Each element is a string. */);
1716 Vexec_suffixes = Qnil;
1718 DEFVAR_LISP ("exec-directory", Vexec_directory,
1719 doc: /* Directory for executables for Emacs to invoke.
1720 More generally, this includes any architecture-dependent files
1721 that are built and installed from the Emacs distribution. */);
1723 DEFVAR_LISP ("data-directory", Vdata_directory,
1724 doc: /* Directory of machine-independent files that come with GNU Emacs.
1725 These are files intended for Emacs to use while it runs. */);
1727 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1728 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1729 This is usually the same as `data-directory'. */);
1731 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1732 doc: /* For internal use by the build procedure only.
1733 This is the name of the directory in which the build procedure installed
1734 Emacs's info files; the default value for `Info-default-directory-list'
1735 includes this. */);
1736 Vconfigure_info_directory = build_string (PATH_INFO);
1738 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1739 doc: /* Directory of score files for games which come with GNU Emacs.
1740 If this variable is nil, then Emacs is unable to use a shared directory. */);
1741 #ifdef DOS_NT
1742 Vshared_game_score_directory = Qnil;
1743 #else
1744 Vshared_game_score_directory = build_string (PATH_GAME);
1745 #endif
1747 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1748 doc: /* List of environment variables inherited from the parent process.
1749 Each element should be a string of the form ENVVARNAME=VALUE.
1750 The elements must normally be decoded (using `locale-coding-system') for use. */);
1751 Vinitial_environment = Qnil;
1753 DEFVAR_LISP ("process-environment", Vprocess_environment,
1754 doc: /* List of overridden environment variables for subprocesses to inherit.
1755 Each element should be a string of the form ENVVARNAME=VALUE.
1757 Entries in this list take precedence to those in the frame-local
1758 environments. Therefore, let-binding `process-environment' is an easy
1759 way to temporarily change the value of an environment variable,
1760 irrespective of where it comes from. To use `process-environment' to
1761 remove an environment variable, include only its name in the list,
1762 without "=VALUE".
1764 This variable is set to nil when Emacs starts.
1766 If multiple entries define the same variable, the first one always
1767 takes precedence.
1769 Non-ASCII characters are encoded according to the initial value of
1770 `locale-coding-system', i.e. the elements must normally be decoded for
1771 use.
1773 See `setenv' and `getenv'. */);
1774 Vprocess_environment = Qnil;
1776 defsubr (&Scall_process);
1777 defsubr (&Sgetenv_internal);
1778 defsubr (&Scall_process_region);