* lisp.h (eassert): Don't use 'assume'.
[emacs.git] / src / callproc.c
blobd4b4a26ec3ae3f16bc1b0113be2e0a4c74caa952
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2013
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <sys/types.h>
25 #include <unistd.h>
27 #include <sys/file.h>
28 #include <fcntl.h>
30 #include "lisp.h"
32 #ifdef WINDOWSNT
33 #define NOMINMAX
34 #include <sys/socket.h> /* for fcntl */
35 #include <windows.h>
36 #include "w32.h"
37 #define _P_NOWAIT 1 /* from process.h */
38 #endif
40 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
41 #include <sys/stat.h>
42 #include <sys/param.h>
43 #endif /* MSDOS */
45 #include "commands.h"
46 #include "character.h"
47 #include "buffer.h"
48 #include "ccl.h"
49 #include "coding.h"
50 #include "composite.h"
51 #include <epaths.h>
52 #include "process.h"
53 #include "syssignal.h"
54 #include "systty.h"
55 #include "syswait.h"
56 #include "blockinput.h"
57 #include "frame.h"
58 #include "termhooks.h"
60 #ifdef MSDOS
61 #include "msdos.h"
62 #endif
64 #ifdef HAVE_NS
65 #include "nsterm.h"
66 #endif
68 /* Pattern used by call-process-region to make temp files. */
69 static Lisp_Object Vtemp_file_name_pattern;
71 /* The next two variables are used while record-unwind-protect is in place
72 during call-process for a subprocess for which record_deleted_pid has
73 not yet been called. At other times, synch_process_pid is zero and
74 synch_process_tempfile's contents are irrelevant. Doing this via static
75 C variables is more convenient than putting them into the arguments
76 of record-unwind-protect, as they need to be updated at randomish
77 times in the code, and Lisp cannot always store these values as
78 Emacs integers. It's safe to use static variables here, as the
79 code is never invoked reentrantly. */
81 /* If nonzero, a process-ID that has not been reaped. */
82 static pid_t synch_process_pid;
84 /* If a string, the name of a temp file that has not been removed. */
85 #ifdef MSDOS
86 static Lisp_Object synch_process_tempfile;
87 #else
88 # define synch_process_tempfile make_number (0)
89 #endif
91 /* Indexes of file descriptors that need closing on call_process_kill. */
92 enum
94 /* The subsidiary process's stdout and stderr. stdin is handled
95 separately, in either Fcall_process_region or create_temp_file. */
96 CALLPROC_STDOUT, CALLPROC_STDERR,
98 /* How to read from a pipe (or substitute) from the subsidiary process. */
99 CALLPROC_PIPEREAD,
101 /* A bound on the number of file descriptors. */
102 CALLPROC_FDS
105 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
107 /* Block SIGCHLD. */
109 void
110 block_child_signal (void)
112 sigset_t blocked;
113 sigemptyset (&blocked);
114 sigaddset (&blocked, SIGCHLD);
115 pthread_sigmask (SIG_BLOCK, &blocked, 0);
118 /* Unblock SIGCHLD. */
120 void
121 unblock_child_signal (void)
123 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
126 /* Return the current buffer's working directory, or the home
127 directory if it's unreachable, as a string suitable for a system call.
128 Signal an error if the result would not be an accessible directory. */
130 Lisp_Object
131 encode_current_directory (void)
133 Lisp_Object dir;
134 struct gcpro gcpro1;
136 dir = BVAR (current_buffer, directory);
137 GCPRO1 (dir);
139 dir = Funhandled_file_name_directory (dir);
141 /* If the file name handler says that dir is unreachable, use
142 a sensible default. */
143 if (NILP (dir))
144 dir = build_string ("~");
146 dir = expand_and_dir_to_file (dir, Qnil);
148 if (STRING_MULTIBYTE (dir))
149 dir = ENCODE_FILE (dir);
150 if (! file_accessible_directory_p (SSDATA (dir)))
151 report_file_error ("Setting current directory",
152 BVAR (current_buffer, directory));
154 RETURN_UNGCPRO (dir);
157 /* If P is reapable, record it as a deleted process and kill it.
158 Do this in a critical section. Unless PID is wedged it will be
159 reaped on receipt of the first SIGCHLD after the critical section. */
161 void
162 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
164 block_child_signal ();
166 if (p->alive)
168 record_deleted_pid (p->pid, tempfile);
169 p->alive = 0;
170 kill (- p->pid, SIGKILL);
173 unblock_child_signal ();
176 /* Clean up files, file descriptors and processes created by Fcall_process. */
178 static void
179 delete_temp_file (Lisp_Object name)
181 unlink (SSDATA (name));
184 static void
185 call_process_kill (void *ptr)
187 int *callproc_fd = ptr;
188 int i;
189 for (i = 0; i < CALLPROC_FDS; i++)
190 if (0 <= callproc_fd[i])
191 emacs_close (callproc_fd[i]);
193 if (synch_process_pid)
195 struct Lisp_Process proc;
196 proc.alive = 1;
197 proc.pid = synch_process_pid;
198 record_kill_process (&proc, synch_process_tempfile);
199 synch_process_pid = 0;
201 else if (STRINGP (synch_process_tempfile))
202 delete_temp_file (synch_process_tempfile);
205 /* Clean up when exiting Fcall_process: restore the buffer, and
206 kill the subsidiary process group if the process still exists. */
208 static void
209 call_process_cleanup (Lisp_Object buffer)
211 Fset_buffer (buffer);
213 if (synch_process_pid)
215 kill (-synch_process_pid, SIGINT);
216 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
217 immediate_quit = 1;
218 QUIT;
219 wait_for_termination (synch_process_pid, 0, 1);
220 synch_process_pid = 0;
221 immediate_quit = 0;
222 message1 ("Waiting for process to die...done");
226 #ifdef DOS_NT
227 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
228 #else
229 static mode_t const default_output_mode = 0666;
230 #endif
232 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
233 doc: /* Call PROGRAM synchronously in separate process.
234 The remaining arguments are optional.
235 The program's input comes from file INFILE (nil means `/dev/null').
236 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
237 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
238 FILE is a file name string, means that it should be written to that file
239 \(if the file already exists it is overwritten).
240 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
241 REAL-BUFFER says what to do with standard output, as above,
242 while STDERR-FILE says what to do with standard error in the child.
243 STDERR-FILE may be nil (discard standard error output),
244 t (mix it with ordinary output), or a file name string.
246 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
247 Remaining arguments are strings passed as command arguments to PROGRAM.
249 If executable PROGRAM can't be found as an executable, `call-process'
250 signals a Lisp error. `call-process' reports errors in execution of
251 the program only through its return and output.
253 If DESTINATION is 0, `call-process' returns immediately with value nil.
254 Otherwise it waits for PROGRAM to terminate
255 and returns a numeric exit status or a signal description string.
256 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
258 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
259 (ptrdiff_t nargs, Lisp_Object *args)
261 Lisp_Object infile, encoded_infile;
262 int filefd;
263 struct gcpro gcpro1;
264 ptrdiff_t count = SPECPDL_INDEX ();
266 if (nargs >= 2 && ! NILP (args[1]))
268 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
269 CHECK_STRING (infile);
271 else
272 infile = build_string (NULL_DEVICE);
274 GCPRO1 (infile);
275 encoded_infile = STRING_MULTIBYTE (infile) ? ENCODE_FILE (infile) : infile;
277 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
278 if (filefd < 0)
279 report_file_error ("Opening process input file", infile);
280 record_unwind_protect_int (close_file_unwind, filefd);
281 UNGCPRO;
282 return unbind_to (count, call_process (nargs, args, filefd, -1));
285 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
287 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
288 unwinder that is intended to remove the input temporary file; in
289 this case NARGS must be at least 2 and ARGS[1] is the file's name.
291 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
293 static Lisp_Object
294 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
295 ptrdiff_t tempfile_index)
297 Lisp_Object buffer, current_dir, path;
298 bool display_p;
299 int fd0;
300 int callproc_fd[CALLPROC_FDS];
301 int status;
302 ptrdiff_t i;
303 ptrdiff_t count = SPECPDL_INDEX ();
304 USE_SAFE_ALLOCA;
306 char **new_argv;
307 /* File to use for stderr in the child.
308 t means use same as standard output. */
309 Lisp_Object error_file;
310 Lisp_Object output_file = Qnil;
311 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
312 char *tempfile = NULL;
313 int pid;
314 #else
315 pid_t pid;
316 #endif
317 int child_errno;
318 int fd_output, fd_error;
319 struct coding_system process_coding; /* coding-system of process output */
320 struct coding_system argument_coding; /* coding-system of arguments */
321 /* Set to the return value of Ffind_operation_coding_system. */
322 Lisp_Object coding_systems;
323 bool discard_output;
325 if (synch_process_pid)
326 error ("call-process invoked recursively");
328 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
329 coding_systems = Qt;
331 CHECK_STRING (args[0]);
333 error_file = Qt;
335 #ifndef subprocesses
336 /* Without asynchronous processes we cannot have BUFFER == 0. */
337 if (nargs >= 3
338 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
339 error ("Operating system cannot handle asynchronous subprocesses");
340 #endif /* subprocesses */
342 /* Decide the coding-system for giving arguments. */
344 Lisp_Object val, *args2;
346 /* If arguments are supplied, we may have to encode them. */
347 if (nargs >= 5)
349 bool must_encode = 0;
350 Lisp_Object coding_attrs;
352 for (i = 4; i < nargs; i++)
353 CHECK_STRING (args[i]);
355 for (i = 4; i < nargs; i++)
356 if (STRING_MULTIBYTE (args[i]))
357 must_encode = 1;
359 if (!NILP (Vcoding_system_for_write))
360 val = Vcoding_system_for_write;
361 else if (! must_encode)
362 val = Qraw_text;
363 else
365 SAFE_NALLOCA (args2, 1, nargs + 1);
366 args2[0] = Qcall_process;
367 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
368 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
369 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
371 val = complement_process_encoding_system (val);
372 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
373 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
374 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
376 /* We should not use an ASCII incompatible coding system. */
377 val = raw_text_coding_system (val);
378 setup_coding_system (val, &argument_coding);
383 if (nargs < 3)
384 buffer = Qnil;
385 else
387 buffer = args[2];
389 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
390 FILE-FOR-STDERR), unless the first element is :file, in which case see
391 the next paragraph. */
392 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
394 if (CONSP (XCDR (buffer)))
396 Lisp_Object stderr_file;
397 stderr_file = XCAR (XCDR (buffer));
399 if (NILP (stderr_file) || EQ (Qt, stderr_file))
400 error_file = stderr_file;
401 else
402 error_file = Fexpand_file_name (stderr_file, Qnil);
405 buffer = XCAR (buffer);
408 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
409 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
411 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
412 BVAR (current_buffer, directory));
413 CHECK_STRING (output_file);
414 buffer = Qnil;
417 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
419 Lisp_Object spec_buffer;
420 spec_buffer = buffer;
421 buffer = Fget_buffer_create (buffer);
422 /* Mention the buffer name for a better error message. */
423 if (NILP (buffer))
424 CHECK_BUFFER (spec_buffer);
425 CHECK_BUFFER (buffer);
429 /* Make sure that the child will be able to chdir to the current
430 buffer's current directory, or its unhandled equivalent. We
431 can't just have the child check for an error when it does the
432 chdir, since it's in a vfork.
434 We have to GCPRO around this because Fexpand_file_name,
435 Funhandled_file_name_directory, and Ffile_accessible_directory_p
436 might call a file name handling function. The argument list is
437 protected by the caller, so all we really have to worry about is
438 buffer. */
440 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
442 current_dir = encode_current_directory ();
444 GCPRO4 (buffer, current_dir, error_file, output_file);
446 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
447 error_file = ENCODE_FILE (error_file);
448 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
449 output_file = ENCODE_FILE (output_file);
450 UNGCPRO;
453 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
455 for (i = 0; i < CALLPROC_FDS; i++)
456 callproc_fd[i] = -1;
457 #ifdef MSDOS
458 synch_process_tempfile = make_number (0);
459 #endif
460 record_unwind_protect_ptr (call_process_kill, callproc_fd);
462 /* Search for program; barf if not found. */
464 struct gcpro gcpro1, gcpro2, gcpro3;
465 int ok;
467 GCPRO3 (buffer, current_dir, error_file);
468 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
469 UNGCPRO;
470 if (ok < 0)
471 report_file_error ("Searching for program", args[0]);
474 /* If program file name starts with /: for quoting a magic name,
475 discard that. */
476 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
477 && SREF (path, 1) == ':')
478 path = Fsubstring (path, make_number (2), Qnil);
480 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
483 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
485 GCPRO4 (buffer, current_dir, path, error_file);
486 if (nargs > 4)
488 ptrdiff_t i;
490 argument_coding.dst_multibyte = 0;
491 for (i = 4; i < nargs; i++)
493 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
494 if (CODING_REQUIRE_ENCODING (&argument_coding))
495 /* We must encode this argument. */
496 args[i] = encode_coding_string (&argument_coding, args[i], 1);
498 for (i = 4; i < nargs; i++)
499 new_argv[i - 3] = SSDATA (args[i]);
500 new_argv[i - 3] = 0;
502 else
503 new_argv[1] = 0;
504 if (STRING_MULTIBYTE (path))
505 path = ENCODE_FILE (path);
506 new_argv[0] = SSDATA (path);
507 UNGCPRO;
510 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
512 #ifdef MSDOS
513 if (! discard_output && ! STRINGP (output_file))
515 char const *tmpdir = egetenv ("TMPDIR");
516 char const *outf = tmpdir ? tmpdir : "";
517 tempfile = alloca (strlen (outf) + 20);
518 strcpy (tempfile, outf);
519 dostounix_filename (tempfile, 0);
520 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
521 strcat (tempfile, "/");
522 strcat (tempfile, "detmp.XXX");
523 mktemp (tempfile);
524 if (!*tempfile)
525 report_file_error ("Opening process output file", Qnil);
526 output_file = build_string (tempfile);
527 synch_process_tempfile = output_file;
529 #endif
531 if (discard_output)
533 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
534 if (fd_output < 0)
535 report_file_error ("Opening null device", Qnil);
537 else if (STRINGP (output_file))
539 fd_output = emacs_open (SSDATA (output_file),
540 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
541 default_output_mode);
542 if (fd_output < 0)
544 int open_errno = errno;
545 output_file = DECODE_FILE (output_file);
546 report_file_errno ("Opening process output file",
547 output_file, open_errno);
550 else
552 int fd[2];
553 if (emacs_pipe (fd) != 0)
554 report_file_error ("Creating process pipe", Qnil);
555 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
556 fd_output = fd[1];
558 callproc_fd[CALLPROC_STDOUT] = fd_output;
560 fd_error = fd_output;
562 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
564 fd_error = emacs_open ((STRINGP (error_file)
565 ? SSDATA (error_file)
566 : NULL_DEVICE),
567 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
568 default_output_mode);
569 if (fd_error < 0)
571 int open_errno = errno;
572 report_file_errno ("Cannot redirect stderr",
573 (STRINGP (error_file)
574 ? DECODE_FILE (error_file)
575 : build_string (NULL_DEVICE)),
576 open_errno);
578 callproc_fd[CALLPROC_STDERR] = fd_error;
581 #ifdef MSDOS /* MW, July 1993 */
582 /* Note that on MSDOS `child_setup' actually returns the child process
583 exit status, not its PID, so assign it to status below. */
584 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
586 if (pid < 0)
588 child_errno = errno;
589 unbind_to (count, Qnil);
590 synchronize_system_messages_locale ();
591 return
592 code_convert_string_norecord (build_string (strerror (child_errno)),
593 Vlocale_coding_system, 0);
595 status = pid;
597 for (i = 0; i < CALLPROC_FDS; i++)
598 if (0 <= callproc_fd[i])
600 emacs_close (callproc_fd[i]);
601 callproc_fd[i] = -1;
603 emacs_close (filefd);
604 clear_unwind_protect (count - 1);
606 if (tempfile)
608 /* Since CRLF is converted to LF within `decode_coding', we
609 can always open a file with binary mode. */
610 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
611 O_RDONLY | O_BINARY, 0);
612 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
614 int open_errno = errno;
615 report_file_errno ("Cannot re-open temporary file",
616 build_string (tempfile), open_errno);
620 #endif /* MSDOS */
622 /* Do the unwind-protect now, even though the pid is not known, so
623 that no storage allocation is done in the critical section.
624 The actual PID will be filled in during the critical section. */
625 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
627 #ifndef MSDOS
629 block_input ();
630 block_child_signal ();
632 #ifdef WINDOWSNT
633 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
634 #else /* not WINDOWSNT */
636 /* vfork, and prevent local vars from being clobbered by the vfork. */
638 Lisp_Object volatile buffer_volatile = buffer;
639 Lisp_Object volatile coding_systems_volatile = coding_systems;
640 Lisp_Object volatile current_dir_volatile = current_dir;
641 bool volatile display_p_volatile = display_p;
642 bool volatile sa_must_free_volatile = sa_must_free;
643 int volatile fd_error_volatile = fd_error;
644 int volatile filefd_volatile = filefd;
645 ptrdiff_t volatile count_volatile = count;
646 ptrdiff_t volatile sa_count_volatile = sa_count;
647 char **volatile new_argv_volatile = new_argv;
648 int volatile callproc_fd_volatile[CALLPROC_FDS];
649 for (i = 0; i < CALLPROC_FDS; i++)
650 callproc_fd_volatile[i] = callproc_fd[i];
652 pid = vfork ();
654 buffer = buffer_volatile;
655 coding_systems = coding_systems_volatile;
656 current_dir = current_dir_volatile;
657 display_p = display_p_volatile;
658 sa_must_free = sa_must_free_volatile;
659 fd_error = fd_error_volatile;
660 filefd = filefd_volatile;
661 count = count_volatile;
662 sa_count = sa_count_volatile;
663 new_argv = new_argv_volatile;
665 for (i = 0; i < CALLPROC_FDS; i++)
666 callproc_fd[i] = callproc_fd_volatile[i];
667 fd_output = callproc_fd[CALLPROC_STDOUT];
670 if (pid == 0)
672 unblock_child_signal ();
674 setsid ();
676 /* Emacs ignores SIGPIPE, but the child should not. */
677 signal (SIGPIPE, SIG_DFL);
679 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
682 #endif /* not WINDOWSNT */
684 child_errno = errno;
686 if (pid > 0)
688 synch_process_pid = pid;
690 if (INTEGERP (buffer))
692 if (tempfile_index < 0)
693 record_deleted_pid (pid, Qnil);
694 else
696 eassert (1 < nargs);
697 record_deleted_pid (pid, args[1]);
698 clear_unwind_protect (tempfile_index);
700 synch_process_pid = 0;
704 unblock_child_signal ();
705 unblock_input ();
707 #endif /* not MSDOS */
709 if (pid < 0)
710 report_file_errno ("Doing vfork", Qnil, child_errno);
712 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
713 since we will use that to read input from. */
714 for (i = 0; i < CALLPROC_FDS; i++)
715 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
717 emacs_close (callproc_fd[i]);
718 callproc_fd[i] = -1;
720 emacs_close (filefd);
721 clear_unwind_protect (count - 1);
723 if (INTEGERP (buffer))
724 return unbind_to (count, Qnil);
726 if (BUFFERP (buffer))
727 Fset_buffer (buffer);
729 fd0 = callproc_fd[CALLPROC_PIPEREAD];
731 if (0 <= fd0)
733 Lisp_Object val, *args2;
735 val = Qnil;
736 if (!NILP (Vcoding_system_for_read))
737 val = Vcoding_system_for_read;
738 else
740 if (EQ (coding_systems, Qt))
742 ptrdiff_t i;
744 SAFE_NALLOCA (args2, 1, nargs + 1);
745 args2[0] = Qcall_process;
746 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
747 coding_systems
748 = Ffind_operation_coding_system (nargs + 1, args2);
750 if (CONSP (coding_systems))
751 val = XCAR (coding_systems);
752 else if (CONSP (Vdefault_process_coding_system))
753 val = XCAR (Vdefault_process_coding_system);
754 else
755 val = Qnil;
757 Fcheck_coding_system (val);
758 /* In unibyte mode, character code conversion should not take
759 place but EOL conversion should. So, setup raw-text or one
760 of the subsidiary according to the information just setup. */
761 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
762 && !NILP (val))
763 val = raw_text_coding_system (val);
764 setup_coding_system (val, &process_coding);
765 process_coding.dst_multibyte
766 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
767 process_coding.src_multibyte = 0;
770 immediate_quit = 1;
771 QUIT;
773 if (0 <= fd0)
775 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
776 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
777 char buf[CALLPROC_BUFFER_SIZE_MAX];
778 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
779 int nread;
780 bool first = 1;
781 EMACS_INT total_read = 0;
782 int carryover = 0;
783 bool display_on_the_fly = display_p;
784 struct coding_system saved_coding = process_coding;
786 while (1)
788 /* Repeatedly read until we've filled as much as possible
789 of the buffer size we have. But don't read
790 less than 1024--save that for the next bufferful. */
791 nread = carryover;
792 while (nread < bufsize - 1024)
794 int this_read = emacs_read (fd0, buf + nread,
795 bufsize - nread);
797 if (this_read < 0)
798 goto give_up;
800 if (this_read == 0)
802 process_coding.mode |= CODING_MODE_LAST_BLOCK;
803 break;
806 nread += this_read;
807 total_read += this_read;
809 if (display_on_the_fly)
810 break;
813 /* Now NREAD is the total amount of data in the buffer. */
814 immediate_quit = 0;
816 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
817 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
818 insert_1_both (buf, nread, nread, 0, 1, 0);
819 else
820 { /* We have to decode the input. */
821 Lisp_Object curbuf;
822 ptrdiff_t count1 = SPECPDL_INDEX ();
824 XSETBUFFER (curbuf, current_buffer);
825 /* We cannot allow after-change-functions be run
826 during decoding, because that might modify the
827 buffer, while we rely on process_coding.produced to
828 faithfully reflect inserted text until we
829 TEMP_SET_PT_BOTH below. */
830 specbind (Qinhibit_modification_hooks, Qt);
831 decode_coding_c_string (&process_coding,
832 (unsigned char *) buf, nread, curbuf);
833 unbind_to (count1, Qnil);
834 if (display_on_the_fly
835 && CODING_REQUIRE_DETECTION (&saved_coding)
836 && ! CODING_REQUIRE_DETECTION (&process_coding))
838 /* We have detected some coding system, but the
839 detection may have been via insufficient data.
840 So give up displaying on the fly. */
841 if (process_coding.produced > 0)
842 del_range_2 (process_coding.dst_pos,
843 process_coding.dst_pos_byte,
844 (process_coding.dst_pos
845 + process_coding.produced_char),
846 (process_coding.dst_pos_byte
847 + process_coding.produced),
849 display_on_the_fly = 0;
850 process_coding = saved_coding;
851 carryover = nread;
852 /* Make the above condition always fail in the future. */
853 saved_coding.common_flags
854 &= ~CODING_REQUIRE_DETECTION_MASK;
855 continue;
858 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
859 PT_BYTE + process_coding.produced);
860 carryover = process_coding.carryover_bytes;
861 if (carryover > 0)
862 memcpy (buf, process_coding.carryover,
863 process_coding.carryover_bytes);
866 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
867 break;
869 /* Make the buffer bigger as we continue to read more data,
870 but not past CALLPROC_BUFFER_SIZE_MAX. */
871 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
872 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
873 bufsize = CALLPROC_BUFFER_SIZE_MAX;
875 if (display_p)
877 if (first)
878 prepare_menu_bars ();
879 first = 0;
880 redisplay_preserve_echo_area (1);
881 /* This variable might have been set to 0 for code
882 detection. In that case, set it back to 1 because
883 we should have already detected a coding system. */
884 display_on_the_fly = 1;
886 immediate_quit = 1;
887 QUIT;
889 give_up: ;
891 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
892 /* If the caller required, let the buffer inherit the
893 coding-system used to decode the process output. */
894 if (inherit_process_coding_system)
895 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
896 make_number (total_read));
899 #ifndef MSDOS
900 /* Wait for it to terminate, unless it already has. */
901 wait_for_termination (pid, &status, fd0 < 0);
902 #endif
904 immediate_quit = 0;
906 /* Don't kill any children that the subprocess may have left behind
907 when exiting. */
908 synch_process_pid = 0;
910 SAFE_FREE ();
911 unbind_to (count, Qnil);
913 if (WIFSIGNALED (status))
915 const char *signame;
917 synchronize_system_messages_locale ();
918 signame = strsignal (WTERMSIG (status));
920 if (signame == 0)
921 signame = "unknown";
923 return code_convert_string_norecord (build_string (signame),
924 Vlocale_coding_system, 0);
927 eassert (WIFEXITED (status));
928 return make_number (WEXITSTATUS (status));
931 /* Create a temporary file suitable for storing the input data of
932 call-process-region. NARGS and ARGS are the same as for
933 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
934 naming the file, and return a file descriptor for reading.
935 Unwind-protect the file, so that the file descriptor will be closed
936 and the file removed when the caller unwinds the specpdl stack. */
938 static int
939 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
940 Lisp_Object *filename_string_ptr)
942 int fd;
943 struct gcpro gcpro1;
944 Lisp_Object filename_string;
945 Lisp_Object val, start, end;
946 Lisp_Object tmpdir;
948 if (STRINGP (Vtemporary_file_directory))
949 tmpdir = Vtemporary_file_directory;
950 else
952 char *outf;
953 #ifndef DOS_NT
954 outf = getenv ("TMPDIR");
955 tmpdir = build_string (outf ? outf : "/tmp/");
956 #else /* DOS_NT */
957 if ((outf = egetenv ("TMPDIR"))
958 || (outf = egetenv ("TMP"))
959 || (outf = egetenv ("TEMP")))
960 tmpdir = build_string (outf);
961 else
962 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
963 #endif
967 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
968 char *tempfile;
969 ptrdiff_t count;
971 #ifdef WINDOWSNT
972 /* Cannot use the result of Fexpand_file_name, because it
973 downcases the XXXXXX part of the pattern, and mktemp then
974 doesn't recognize it. */
975 if (!NILP (Vw32_downcase_file_names))
977 Lisp_Object dirname = Ffile_name_directory (pattern);
979 if (NILP (dirname))
980 pattern = Vtemp_file_name_pattern;
981 else
982 pattern = concat2 (dirname, Vtemp_file_name_pattern);
984 #endif
986 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
987 GCPRO1 (filename_string);
988 tempfile = SSDATA (filename_string);
990 count = SPECPDL_INDEX ();
991 record_unwind_protect_nothing ();
992 fd = mkostemp (tempfile, O_CLOEXEC);
993 if (fd < 0)
994 report_file_error ("Failed to open temporary file using pattern",
995 pattern);
996 set_unwind_protect (count, delete_temp_file, filename_string);
997 record_unwind_protect_int (close_file_unwind, fd);
1000 start = args[0];
1001 end = args[1];
1002 /* Decide coding-system of the contents of the temporary file. */
1003 if (!NILP (Vcoding_system_for_write))
1004 val = Vcoding_system_for_write;
1005 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1006 val = Qraw_text;
1007 else
1009 Lisp_Object coding_systems;
1010 Lisp_Object *args2;
1011 USE_SAFE_ALLOCA;
1012 SAFE_NALLOCA (args2, 1, nargs + 1);
1013 args2[0] = Qcall_process_region;
1014 memcpy (args2 + 1, args, nargs * sizeof *args);
1015 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1016 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1017 SAFE_FREE ();
1019 val = complement_process_encoding_system (val);
1022 ptrdiff_t count1 = SPECPDL_INDEX ();
1024 specbind (intern ("coding-system-for-write"), val);
1025 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1026 happen to get a ".Z" suffix. */
1027 specbind (intern ("file-name-handler-alist"), Qnil);
1028 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
1030 unbind_to (count1, Qnil);
1033 if (lseek (fd, 0, SEEK_SET) < 0)
1034 report_file_error ("Setting file position", filename_string);
1036 /* Note that Fcall_process takes care of binding
1037 coding-system-for-read. */
1039 *filename_string_ptr = filename_string;
1040 UNGCPRO;
1041 return fd;
1044 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1045 3, MANY, 0,
1046 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1047 The remaining arguments are optional.
1048 Delete the text if fourth arg DELETE is non-nil.
1050 Insert output in BUFFER before point; t means current buffer; nil for
1051 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1052 FILE)', where FILE is a file name string, means that it should be
1053 written to that file (if the file already exists it is overwritten).
1054 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1055 REAL-BUFFER says what to do with standard output, as above,
1056 while STDERR-FILE says what to do with standard error in the child.
1057 STDERR-FILE may be nil (discard standard error output),
1058 t (mix it with ordinary output), or a file name string.
1060 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1061 Remaining args are passed to PROGRAM at startup as command args.
1063 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1064 Otherwise it waits for PROGRAM to terminate
1065 and returns a numeric exit status or a signal description string.
1066 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1068 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1069 (ptrdiff_t nargs, Lisp_Object *args)
1071 struct gcpro gcpro1;
1072 Lisp_Object infile, val;
1073 ptrdiff_t count = SPECPDL_INDEX ();
1074 Lisp_Object start = args[0];
1075 Lisp_Object end = args[1];
1076 bool empty_input;
1077 int fd;
1079 if (STRINGP (start))
1080 empty_input = SCHARS (start) == 0;
1081 else if (NILP (start))
1082 empty_input = BEG == Z;
1083 else
1085 validate_region (&args[0], &args[1]);
1086 start = args[0];
1087 end = args[1];
1088 empty_input = XINT (start) == XINT (end);
1091 if (!empty_input)
1092 fd = create_temp_file (nargs, args, &infile);
1093 else
1095 infile = Qnil;
1096 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1097 if (fd < 0)
1098 report_file_error ("Opening null device", Qnil);
1099 record_unwind_protect_int (close_file_unwind, fd);
1102 GCPRO1 (infile);
1104 if (nargs > 3 && !NILP (args[3]))
1105 Fdelete_region (start, end);
1107 if (nargs > 3)
1109 args += 2;
1110 nargs -= 2;
1112 else
1114 args[0] = args[2];
1115 nargs = 2;
1117 args[1] = infile;
1119 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1120 RETURN_UNGCPRO (unbind_to (count, val));
1123 #ifndef WINDOWSNT
1124 static int relocate_fd (int fd, int minfd);
1125 #endif
1127 static char **
1128 add_env (char **env, char **new_env, char *string)
1130 char **ep;
1131 bool ok = 1;
1132 if (string == NULL)
1133 return new_env;
1135 /* See if this string duplicates any string already in the env.
1136 If so, don't put it in.
1137 When an env var has multiple definitions,
1138 we keep the definition that comes first in process-environment. */
1139 for (ep = env; ok && ep != new_env; ep++)
1141 char *p = *ep, *q = string;
1142 while (ok)
1144 if (*q != *p)
1145 break;
1146 if (*q == 0)
1147 /* The string is a lone variable name; keep it for now, we
1148 will remove it later. It is a placeholder for a
1149 variable that is not to be included in the environment. */
1150 break;
1151 if (*q == '=')
1152 ok = 0;
1153 p++, q++;
1156 if (ok)
1157 *new_env++ = string;
1158 return new_env;
1161 /* This is the last thing run in a newly forked inferior
1162 either synchronous or asynchronous.
1163 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1164 Initialize inferior's priority, pgrp, connected dir and environment.
1165 then exec another program based on new_argv.
1167 If SET_PGRP, put the subprocess into a separate process group.
1169 CURRENT_DIR is an elisp string giving the path of the current
1170 directory the subprocess should have. Since we can't really signal
1171 a decent error from within the child, this should be verified as an
1172 executable directory by the parent. */
1175 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1176 Lisp_Object current_dir)
1178 char **env;
1179 char *pwd_var;
1180 #ifdef WINDOWSNT
1181 int cpid;
1182 HANDLE handles[3];
1183 #else
1184 int exec_errno;
1186 pid_t pid = getpid ();
1187 #endif /* WINDOWSNT */
1189 /* Note that use of alloca is always safe here. It's obvious for systems
1190 that do not have true vfork or that have true (stack) alloca.
1191 If using vfork and C_ALLOCA (when Emacs used to include
1192 src/alloca.c) it is safe because that changes the superior's
1193 static variables as if the superior had done alloca and will be
1194 cleaned up in the usual way. */
1196 char *temp;
1197 ptrdiff_t i;
1199 i = SBYTES (current_dir);
1200 #ifdef MSDOS
1201 /* MSDOS must have all environment variables malloc'ed, because
1202 low-level libc functions that launch subsidiary processes rely
1203 on that. */
1204 pwd_var = xmalloc (i + 5);
1205 #else
1206 pwd_var = alloca (i + 5);
1207 #endif
1208 temp = pwd_var + 4;
1209 memcpy (pwd_var, "PWD=", 4);
1210 strcpy (temp, SSDATA (current_dir));
1212 #ifndef DOS_NT
1213 /* We can't signal an Elisp error here; we're in a vfork. Since
1214 the callers check the current directory before forking, this
1215 should only return an error if the directory's permissions
1216 are changed between the check and this chdir, but we should
1217 at least check. */
1218 if (chdir (temp) < 0)
1219 _exit (EXIT_CANCELED);
1220 #else /* DOS_NT */
1221 /* Get past the drive letter, so that d:/ is left alone. */
1222 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1224 temp += 2;
1225 i -= 2;
1227 #endif /* DOS_NT */
1229 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1230 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1231 temp[--i] = 0;
1234 /* Set `env' to a vector of the strings in the environment. */
1236 register Lisp_Object tem;
1237 register char **new_env;
1238 char **p, **q;
1239 register int new_length;
1240 Lisp_Object display = Qnil;
1242 new_length = 0;
1244 for (tem = Vprocess_environment;
1245 CONSP (tem) && STRINGP (XCAR (tem));
1246 tem = XCDR (tem))
1248 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1249 && (SDATA (XCAR (tem)) [7] == '\0'
1250 || SDATA (XCAR (tem)) [7] == '='))
1251 /* DISPLAY is specified in process-environment. */
1252 display = Qt;
1253 new_length++;
1256 /* If not provided yet, use the frame's DISPLAY. */
1257 if (NILP (display))
1259 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1260 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1261 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1262 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1263 Vinitial_environment);
1264 if (STRINGP (tmp))
1266 display = tmp;
1267 new_length++;
1271 /* new_length + 2 to include PWD and terminating 0. */
1272 env = new_env = alloca ((new_length + 2) * sizeof *env);
1273 /* If we have a PWD envvar, pass one down,
1274 but with corrected value. */
1275 if (egetenv ("PWD"))
1276 *new_env++ = pwd_var;
1278 if (STRINGP (display))
1280 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1281 strcpy (vdata, "DISPLAY=");
1282 strcat (vdata, SSDATA (display));
1283 new_env = add_env (env, new_env, vdata);
1286 /* Overrides. */
1287 for (tem = Vprocess_environment;
1288 CONSP (tem) && STRINGP (XCAR (tem));
1289 tem = XCDR (tem))
1290 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1292 *new_env = 0;
1294 /* Remove variable names without values. */
1295 p = q = env;
1296 while (*p != 0)
1298 while (*q != 0 && strchr (*q, '=') == NULL)
1299 q++;
1300 *p = *q++;
1301 if (*p != 0)
1302 p++;
1307 #ifdef WINDOWSNT
1308 prepare_standard_handles (in, out, err, handles);
1309 set_process_dir (SDATA (current_dir));
1310 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1311 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1312 reset_standard_handles (in, out, err, handles);
1313 if (cpid == -1)
1314 /* An error occurred while trying to spawn the process. */
1315 report_file_error ("Spawning child process", Qnil);
1316 return cpid;
1318 #else /* not WINDOWSNT */
1319 /* Make sure that in, out, and err are not actually already in
1320 descriptors zero, one, or two; this could happen if Emacs is
1321 started with its standard in, out, or error closed, as might
1322 happen under X. */
1324 int oin = in, oout = out;
1326 /* We have to avoid relocating the same descriptor twice! */
1328 in = relocate_fd (in, 3);
1330 if (out == oin)
1331 out = in;
1332 else
1333 out = relocate_fd (out, 3);
1335 if (err == oin)
1336 err = in;
1337 else if (err == oout)
1338 err = out;
1339 else
1340 err = relocate_fd (err, 3);
1343 #ifndef MSDOS
1344 /* Redirect file descriptors and clear the close-on-exec flag on the
1345 redirected ones. IN, OUT, and ERR are close-on-exec so they
1346 need not be closed explicitly. */
1347 dup2 (in, 0);
1348 dup2 (out, 1);
1349 dup2 (err, 2);
1351 setpgid (0, 0);
1352 tcsetpgrp (0, pid);
1354 execve (new_argv[0], new_argv, env);
1355 exec_errno = errno;
1357 /* Avoid deadlock if the child's perror writes to a full pipe; the
1358 pipe's reader is the parent, but with vfork the parent can't
1359 run until the child exits. Truncate the diagnostic instead. */
1360 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1362 errno = exec_errno;
1363 emacs_perror (new_argv[0]);
1364 _exit (exec_errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1366 #else /* MSDOS */
1367 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1368 xfree (pwd_var);
1369 if (pid == -1)
1370 /* An error occurred while trying to run the subprocess. */
1371 report_file_error ("Spawning child process", Qnil);
1372 return pid;
1373 #endif /* MSDOS */
1374 #endif /* not WINDOWSNT */
1377 #ifndef WINDOWSNT
1378 /* Move the file descriptor FD so that its number is not less than MINFD.
1379 If the file descriptor is moved at all, the original is closed on MSDOS,
1380 but not elsewhere as the caller will close it anyway. */
1381 static int
1382 relocate_fd (int fd, int minfd)
1384 if (fd >= minfd)
1385 return fd;
1386 else
1388 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1389 if (new == -1)
1391 emacs_perror ("while setting up child");
1392 _exit (EXIT_CANCELED);
1394 #ifdef MSDOS
1395 emacs_close (fd);
1396 #endif
1397 return new;
1400 #endif /* not WINDOWSNT */
1402 static bool
1403 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1404 ptrdiff_t *valuelen, Lisp_Object env)
1406 for (; CONSP (env); env = XCDR (env))
1408 Lisp_Object entry = XCAR (env);
1409 if (STRINGP (entry)
1410 && SBYTES (entry) >= varlen
1411 #ifdef WINDOWSNT
1412 /* NT environment variables are case insensitive. */
1413 && ! strnicmp (SDATA (entry), var, varlen)
1414 #else /* not WINDOWSNT */
1415 && ! memcmp (SDATA (entry), var, varlen)
1416 #endif /* not WINDOWSNT */
1419 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1421 *value = SSDATA (entry) + (varlen + 1);
1422 *valuelen = SBYTES (entry) - (varlen + 1);
1423 return 1;
1425 else if (SBYTES (entry) == varlen)
1427 /* Lone variable names in Vprocess_environment mean that
1428 variable should be removed from the environment. */
1429 *value = NULL;
1430 return 1;
1434 return 0;
1437 static bool
1438 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1439 ptrdiff_t *valuelen, Lisp_Object frame)
1441 /* Try to find VAR in Vprocess_environment first. */
1442 if (getenv_internal_1 (var, varlen, value, valuelen,
1443 Vprocess_environment))
1444 return *value ? 1 : 0;
1446 /* For DISPLAY try to get the values from the frame or the initial env. */
1447 if (strcmp (var, "DISPLAY") == 0)
1449 Lisp_Object display
1450 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1451 if (STRINGP (display))
1453 *value = SSDATA (display);
1454 *valuelen = SBYTES (display);
1455 return 1;
1457 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1458 if (getenv_internal_1 (var, varlen, value, valuelen,
1459 Vinitial_environment))
1460 return *value ? 1 : 0;
1463 return 0;
1466 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1467 doc: /* Get the value of environment variable VARIABLE.
1468 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1469 the environment. Otherwise, value is a string.
1471 This function searches `process-environment' for VARIABLE.
1473 If optional parameter ENV is a list, then search this list instead of
1474 `process-environment', and return t when encountering a negative entry
1475 \(an entry for a variable with no value). */)
1476 (Lisp_Object variable, Lisp_Object env)
1478 char *value;
1479 ptrdiff_t valuelen;
1481 CHECK_STRING (variable);
1482 if (CONSP (env))
1484 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1485 &value, &valuelen, env))
1486 return value ? make_string (value, valuelen) : Qt;
1487 else
1488 return Qnil;
1490 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1491 &value, &valuelen, env))
1492 return make_string (value, valuelen);
1493 else
1494 return Qnil;
1497 /* A version of getenv that consults the Lisp environment lists,
1498 easily callable from C. */
1499 char *
1500 egetenv (const char *var)
1502 char *value;
1503 ptrdiff_t valuelen;
1505 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1506 return value;
1507 else
1508 return 0;
1512 /* This is run before init_cmdargs. */
1514 void
1515 init_callproc_1 (void)
1517 #ifdef HAVE_NS
1518 const char *etc_dir = ns_etc_directory ();
1519 const char *path_exec = ns_exec_path ();
1520 #endif
1522 Vdata_directory = decode_env_path ("EMACSDATA",
1523 #ifdef HAVE_NS
1524 etc_dir ? etc_dir :
1525 #endif
1526 PATH_DATA);
1527 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1529 Vdoc_directory = decode_env_path ("EMACSDOC",
1530 #ifdef HAVE_NS
1531 etc_dir ? etc_dir :
1532 #endif
1533 PATH_DOC);
1534 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1536 /* Check the EMACSPATH environment variable, defaulting to the
1537 PATH_EXEC path from epaths.h. */
1538 Vexec_path = decode_env_path ("EMACSPATH",
1539 #ifdef HAVE_NS
1540 path_exec ? path_exec :
1541 #endif
1542 PATH_EXEC);
1543 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1544 /* FIXME? For ns, path_exec should go at the front? */
1545 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1548 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1550 void
1551 init_callproc (void)
1553 char *data_dir = egetenv ("EMACSDATA");
1555 register char * sh;
1556 Lisp_Object tempdir;
1557 #ifdef HAVE_NS
1558 if (data_dir == 0)
1560 const char *etc_dir = ns_etc_directory ();
1561 if (etc_dir)
1563 data_dir = alloca (strlen (etc_dir) + 1);
1564 strcpy (data_dir, etc_dir);
1567 #endif
1569 if (!NILP (Vinstallation_directory))
1571 /* Add to the path the lib-src subdir of the installation dir. */
1572 Lisp_Object tem;
1573 tem = Fexpand_file_name (build_string ("lib-src"),
1574 Vinstallation_directory);
1575 #ifndef MSDOS
1576 /* MSDOS uses wrapped binaries, so don't do this. */
1577 if (NILP (Fmember (tem, Vexec_path)))
1579 #ifdef HAVE_NS
1580 const char *path_exec = ns_exec_path ();
1581 #endif
1582 Vexec_path = decode_env_path ("EMACSPATH",
1583 #ifdef HAVE_NS
1584 path_exec ? path_exec :
1585 #endif
1586 PATH_EXEC);
1587 Vexec_path = Fcons (tem, Vexec_path);
1588 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1591 Vexec_directory = Ffile_name_as_directory (tem);
1592 #endif /* not MSDOS */
1594 /* Maybe use ../etc as well as ../lib-src. */
1595 if (data_dir == 0)
1597 tem = Fexpand_file_name (build_string ("etc"),
1598 Vinstallation_directory);
1599 Vdoc_directory = Ffile_name_as_directory (tem);
1603 /* Look for the files that should be in etc. We don't use
1604 Vinstallation_directory, because these files are never installed
1605 near the executable, and they are never in the build
1606 directory when that's different from the source directory.
1608 Instead, if these files are not in the nominal place, we try the
1609 source directory. */
1610 if (data_dir == 0)
1612 Lisp_Object tem, tem1, srcdir;
1614 srcdir = Fexpand_file_name (build_string ("../src/"),
1615 build_string (PATH_DUMPLOADSEARCH));
1616 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1617 tem1 = Ffile_exists_p (tem);
1618 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1620 Lisp_Object newdir;
1621 newdir = Fexpand_file_name (build_string ("../etc/"),
1622 build_string (PATH_DUMPLOADSEARCH));
1623 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1624 tem1 = Ffile_exists_p (tem);
1625 if (!NILP (tem1))
1626 Vdata_directory = newdir;
1630 #ifndef CANNOT_DUMP
1631 if (initialized)
1632 #endif
1634 tempdir = Fdirectory_file_name (Vexec_directory);
1635 if (! file_accessible_directory_p (SSDATA (tempdir)))
1636 dir_warning ("arch-dependent data dir", Vexec_directory);
1639 tempdir = Fdirectory_file_name (Vdata_directory);
1640 if (! file_accessible_directory_p (SSDATA (tempdir)))
1641 dir_warning ("arch-independent data dir", Vdata_directory);
1643 sh = getenv ("SHELL");
1644 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1646 #ifdef DOS_NT
1647 Vshared_game_score_directory = Qnil;
1648 #else
1649 Vshared_game_score_directory = build_string (PATH_GAME);
1650 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1651 Vshared_game_score_directory = Qnil;
1652 #endif
1655 void
1656 set_initial_environment (void)
1658 char **envp;
1659 for (envp = environ; *envp; envp++)
1660 Vprocess_environment = Fcons (build_string (*envp),
1661 Vprocess_environment);
1662 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1663 to use `delete' and friends on process-environment. */
1664 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1667 void
1668 syms_of_callproc (void)
1670 #ifndef DOS_NT
1671 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1672 #elif defined (WINDOWSNT)
1673 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1674 #else
1675 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1676 #endif
1677 staticpro (&Vtemp_file_name_pattern);
1679 #ifdef MSDOS
1680 synch_process_tempfile = make_number (0);
1681 staticpro (&synch_process_tempfile);
1682 #endif
1684 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1685 doc: /* File name to load inferior shells from.
1686 Initialized from the SHELL environment variable, or to a system-dependent
1687 default if SHELL is not set. */);
1689 DEFVAR_LISP ("exec-path", Vexec_path,
1690 doc: /* List of directories to search programs to run in subprocesses.
1691 Each element is a string (directory name) or nil (try default directory). */);
1693 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1694 doc: /* List of suffixes to try to find executable file names.
1695 Each element is a string. */);
1696 Vexec_suffixes = Qnil;
1698 DEFVAR_LISP ("exec-directory", Vexec_directory,
1699 doc: /* Directory for executables for Emacs to invoke.
1700 More generally, this includes any architecture-dependent files
1701 that are built and installed from the Emacs distribution. */);
1703 DEFVAR_LISP ("data-directory", Vdata_directory,
1704 doc: /* Directory of machine-independent files that come with GNU Emacs.
1705 These are files intended for Emacs to use while it runs. */);
1707 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1708 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1709 This is usually the same as `data-directory'. */);
1711 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1712 doc: /* For internal use by the build procedure only.
1713 This is the name of the directory in which the build procedure installed
1714 Emacs's info files; the default value for `Info-default-directory-list'
1715 includes this. */);
1716 Vconfigure_info_directory = build_string (PATH_INFO);
1718 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1719 doc: /* Directory of score files for games which come with GNU Emacs.
1720 If this variable is nil, then Emacs is unable to use a shared directory. */);
1721 #ifdef DOS_NT
1722 Vshared_game_score_directory = Qnil;
1723 #else
1724 Vshared_game_score_directory = build_string (PATH_GAME);
1725 #endif
1727 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1728 doc: /* List of environment variables inherited from the parent process.
1729 Each element should be a string of the form ENVVARNAME=VALUE.
1730 The elements must normally be decoded (using `locale-coding-system') for use. */);
1731 Vinitial_environment = Qnil;
1733 DEFVAR_LISP ("process-environment", Vprocess_environment,
1734 doc: /* List of overridden environment variables for subprocesses to inherit.
1735 Each element should be a string of the form ENVVARNAME=VALUE.
1737 Entries in this list take precedence to those in the frame-local
1738 environments. Therefore, let-binding `process-environment' is an easy
1739 way to temporarily change the value of an environment variable,
1740 irrespective of where it comes from. To use `process-environment' to
1741 remove an environment variable, include only its name in the list,
1742 without "=VALUE".
1744 This variable is set to nil when Emacs starts.
1746 If multiple entries define the same variable, the first one always
1747 takes precedence.
1749 Non-ASCII characters are encoded according to the initial value of
1750 `locale-coding-system', i.e. the elements must normally be decoded for
1751 use.
1753 See `setenv' and `getenv'. */);
1754 Vprocess_environment = Qnil;
1756 defsubr (&Scall_process);
1757 defsubr (&Sgetenv_internal);
1758 defsubr (&Scall_process_region);