lisp/progmodes/js.el: Silence byte-compiler warning.
[emacs.git] / src / callproc.c
blobcb11ee0cc53a9520da90b794ee0d8ea4b5b026fc
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2012
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 <windows.h>
35 #include "w32.h"
36 #define _P_NOWAIT 1 /* from process.h */
37 #endif
39 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
40 #include <sys/stat.h>
41 #include <sys/param.h>
42 #endif /* MSDOS */
44 #include "commands.h"
45 #include "character.h"
46 #include "buffer.h"
47 #include "ccl.h"
48 #include "coding.h"
49 #include "composite.h"
50 #include <epaths.h>
51 #include "process.h"
52 #include "syssignal.h"
53 #include "systty.h"
54 #include "syswait.h"
55 #include "blockinput.h"
56 #include "frame.h"
57 #include "termhooks.h"
59 #ifdef MSDOS
60 #include "msdos.h"
61 #endif
63 #ifdef HAVE_NS
64 #include "nsterm.h"
65 #endif
67 /* Pattern used by call-process-region to make temp files. */
68 static Lisp_Object Vtemp_file_name_pattern;
70 /* The next two variables are valid only while record-unwind-protect
71 is in place during call-process for a synchronous subprocess. At
72 other times, their contents are irrelevant. Doing this via static
73 C variables is more convenient than putting them into the arguments
74 of record-unwind-protect, as they need to be updated at randomish
75 times in the code, and Lisp cannot always store these values as
76 Emacs integers. It's safe to use static variables here, as the
77 code is never invoked reentrantly. */
79 /* If nonzero, a process-ID that has not been reaped. */
80 static pid_t synch_process_pid;
82 /* If nonnegative, a file descriptor that has not been closed. */
83 static int synch_process_fd;
85 /* Block SIGCHLD. */
87 static void
88 block_child_signal (void)
90 sigset_t blocked;
91 sigemptyset (&blocked);
92 sigaddset (&blocked, SIGCHLD);
93 pthread_sigmask (SIG_BLOCK, &blocked, 0);
96 /* Unblock SIGCHLD. */
98 static void
99 unblock_child_signal (void)
101 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
104 /* If P is reapable, record it as a deleted process and kill it.
105 Do this in a critical section. Unless PID is wedged it will be
106 reaped on receipt of the first SIGCHLD after the critical section. */
108 void
109 record_kill_process (struct Lisp_Process *p)
111 block_child_signal ();
113 if (p->alive)
115 p->alive = 0;
116 record_deleted_pid (p->pid);
117 kill (- p->pid, SIGKILL);
120 unblock_child_signal ();
123 /* Clean up when exiting call_process_cleanup. */
125 static Lisp_Object
126 call_process_kill (Lisp_Object ignored)
128 if (0 <= synch_process_fd)
129 emacs_close (synch_process_fd);
131 if (synch_process_pid)
133 struct Lisp_Process proc;
134 proc.alive = 1;
135 proc.pid = synch_process_pid;
136 record_kill_process (&proc);
139 return Qnil;
142 /* Clean up when exiting Fcall_process.
143 On MSDOS, delete the temporary file on any kind of termination.
144 On Unix, kill the process and any children on termination by signal. */
146 static Lisp_Object
147 call_process_cleanup (Lisp_Object arg)
149 #ifdef MSDOS
150 Lisp_Object buffer = Fcar (arg);
151 Lisp_Object file = Fcdr (arg);
152 #else
153 Lisp_Object buffer = arg;
154 #endif
156 Fset_buffer (buffer);
158 #ifndef MSDOS
159 /* If the process still exists, kill its process group. */
160 if (synch_process_pid)
162 ptrdiff_t count = SPECPDL_INDEX ();
163 kill (-synch_process_pid, SIGINT);
164 record_unwind_protect (call_process_kill, make_number (0));
165 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
166 immediate_quit = 1;
167 QUIT;
168 wait_for_termination (synch_process_pid, 0, 1);
169 synch_process_pid = 0;
170 immediate_quit = 0;
171 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
172 message1 ("Waiting for process to die...done");
174 #endif
176 if (0 <= synch_process_fd)
177 emacs_close (synch_process_fd);
179 #ifdef MSDOS
180 /* FILE is "" when we didn't actually create a temporary file in
181 call-process. */
182 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
183 unlink (SDATA (file));
184 #endif
186 return Qnil;
189 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
190 doc: /* Call PROGRAM synchronously in separate process.
191 The remaining arguments are optional.
192 The program's input comes from file INFILE (nil means `/dev/null').
193 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
194 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
195 FILE is a file name string, means that it should be written to that file
196 \(if the file already exists it is overwritten).
197 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
198 REAL-BUFFER says what to do with standard output, as above,
199 while STDERR-FILE says what to do with standard error in the child.
200 STDERR-FILE may be nil (discard standard error output),
201 t (mix it with ordinary output), or a file name string.
203 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
204 Remaining arguments are strings passed as command arguments to PROGRAM.
206 If executable PROGRAM can't be found as an executable, `call-process'
207 signals a Lisp error. `call-process' reports errors in execution of
208 the program only through its return and output.
210 If BUFFER is 0, `call-process' returns immediately with value nil.
211 Otherwise it waits for PROGRAM to terminate
212 and returns a numeric exit status or a signal description string.
213 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
215 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
216 (ptrdiff_t nargs, Lisp_Object *args)
218 Lisp_Object infile, buffer, current_dir, path;
219 bool display_p;
220 int fd0, fd1, filefd;
221 int status;
222 ptrdiff_t count = SPECPDL_INDEX ();
223 USE_SAFE_ALLOCA;
225 char **new_argv;
226 /* File to use for stderr in the child.
227 t means use same as standard output. */
228 Lisp_Object error_file;
229 Lisp_Object output_file = Qnil;
230 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
231 char *outf, *tempfile = NULL;
232 int outfilefd;
233 int pid;
234 #else
235 pid_t pid;
236 #endif
237 int child_errno;
238 int fd_output = -1;
239 struct coding_system process_coding; /* coding-system of process output */
240 struct coding_system argument_coding; /* coding-system of arguments */
241 /* Set to the return value of Ffind_operation_coding_system. */
242 Lisp_Object coding_systems;
243 bool output_to_buffer = 1;
245 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
246 coding_systems = Qt;
248 CHECK_STRING (args[0]);
250 error_file = Qt;
252 #ifndef subprocesses
253 /* Without asynchronous processes we cannot have BUFFER == 0. */
254 if (nargs >= 3
255 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
256 error ("Operating system cannot handle asynchronous subprocesses");
257 #endif /* subprocesses */
259 /* Decide the coding-system for giving arguments. */
261 Lisp_Object val, *args2;
262 ptrdiff_t i;
264 /* If arguments are supplied, we may have to encode them. */
265 if (nargs >= 5)
267 bool must_encode = 0;
268 Lisp_Object coding_attrs;
270 for (i = 4; i < nargs; i++)
271 CHECK_STRING (args[i]);
273 for (i = 4; i < nargs; i++)
274 if (STRING_MULTIBYTE (args[i]))
275 must_encode = 1;
277 if (!NILP (Vcoding_system_for_write))
278 val = Vcoding_system_for_write;
279 else if (! must_encode)
280 val = Qraw_text;
281 else
283 SAFE_NALLOCA (args2, 1, nargs + 1);
284 args2[0] = Qcall_process;
285 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
286 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
287 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
289 val = complement_process_encoding_system (val);
290 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
291 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
292 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
294 /* We should not use an ASCII incompatible coding system. */
295 val = raw_text_coding_system (val);
296 setup_coding_system (val, &argument_coding);
301 if (nargs >= 2 && ! NILP (args[1]))
303 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
304 CHECK_STRING (infile);
306 else
307 infile = build_string (NULL_DEVICE);
309 if (nargs >= 3)
311 buffer = args[2];
313 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
314 FILE-FOR-STDERR), unless the first element is :file, in which case see
315 the next paragraph. */
316 if (CONSP (buffer)
317 && (! SYMBOLP (XCAR (buffer))
318 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
320 if (CONSP (XCDR (buffer)))
322 Lisp_Object stderr_file;
323 stderr_file = XCAR (XCDR (buffer));
325 if (NILP (stderr_file) || EQ (Qt, stderr_file))
326 error_file = stderr_file;
327 else
328 error_file = Fexpand_file_name (stderr_file, Qnil);
331 buffer = XCAR (buffer);
334 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
335 if (CONSP (buffer)
336 && SYMBOLP (XCAR (buffer))
337 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
339 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
340 BVAR (current_buffer, directory));
341 CHECK_STRING (output_file);
342 buffer = Qnil;
345 if (!(EQ (buffer, Qnil)
346 || EQ (buffer, Qt)
347 || INTEGERP (buffer)))
349 Lisp_Object spec_buffer;
350 spec_buffer = buffer;
351 buffer = Fget_buffer_create (buffer);
352 /* Mention the buffer name for a better error message. */
353 if (NILP (buffer))
354 CHECK_BUFFER (spec_buffer);
355 CHECK_BUFFER (buffer);
358 else
359 buffer = Qnil;
361 /* Make sure that the child will be able to chdir to the current
362 buffer's current directory, or its unhandled equivalent. We
363 can't just have the child check for an error when it does the
364 chdir, since it's in a vfork.
366 We have to GCPRO around this because Fexpand_file_name,
367 Funhandled_file_name_directory, and Ffile_accessible_directory_p
368 might call a file name handling function. The argument list is
369 protected by the caller, so all we really have to worry about is
370 buffer. */
372 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
374 current_dir = BVAR (current_buffer, directory);
376 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
378 current_dir = Funhandled_file_name_directory (current_dir);
379 if (NILP (current_dir))
380 /* If the file name handler says that current_dir is unreachable, use
381 a sensible default. */
382 current_dir = build_string ("~/");
383 current_dir = expand_and_dir_to_file (current_dir, Qnil);
384 current_dir = Ffile_name_as_directory (current_dir);
386 if (NILP (Ffile_accessible_directory_p (current_dir)))
387 report_file_error ("Setting current directory",
388 Fcons (BVAR (current_buffer, directory), Qnil));
390 if (STRING_MULTIBYTE (infile))
391 infile = ENCODE_FILE (infile);
392 if (STRING_MULTIBYTE (current_dir))
393 current_dir = ENCODE_FILE (current_dir);
394 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
395 error_file = ENCODE_FILE (error_file);
396 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
397 output_file = ENCODE_FILE (output_file);
398 UNGCPRO;
401 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
403 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
404 if (filefd < 0)
405 report_file_error ("Opening process input file",
406 Fcons (DECODE_FILE (infile), Qnil));
408 if (STRINGP (output_file))
410 #ifdef DOS_NT
411 fd_output = emacs_open (SSDATA (output_file),
412 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
413 S_IREAD | S_IWRITE);
414 #else /* not DOS_NT */
415 fd_output = creat (SSDATA (output_file), 0666);
416 #endif /* not DOS_NT */
417 if (fd_output < 0)
419 output_file = DECODE_FILE (output_file);
420 report_file_error ("Opening process output file",
421 Fcons (output_file, Qnil));
423 if (STRINGP (error_file) || NILP (error_file))
424 output_to_buffer = 0;
427 /* Search for program; barf if not found. */
429 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
431 GCPRO4 (infile, buffer, current_dir, error_file);
432 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
433 UNGCPRO;
435 if (NILP (path))
437 emacs_close (filefd);
438 report_file_error ("Searching for program", Fcons (args[0], Qnil));
441 /* If program file name starts with /: for quoting a magic name,
442 discard that. */
443 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
444 && SREF (path, 1) == ':')
445 path = Fsubstring (path, make_number (2), Qnil);
447 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
450 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
452 GCPRO5 (infile, buffer, current_dir, path, error_file);
453 if (nargs > 4)
455 ptrdiff_t i;
457 argument_coding.dst_multibyte = 0;
458 for (i = 4; i < nargs; i++)
460 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
461 if (CODING_REQUIRE_ENCODING (&argument_coding))
462 /* We must encode this argument. */
463 args[i] = encode_coding_string (&argument_coding, args[i], 1);
465 for (i = 4; i < nargs; i++)
466 new_argv[i - 3] = SSDATA (args[i]);
467 new_argv[i - 3] = 0;
469 else
470 new_argv[1] = 0;
471 if (STRING_MULTIBYTE (path))
472 path = ENCODE_FILE (path);
473 new_argv[0] = SSDATA (path);
474 UNGCPRO;
477 #ifdef MSDOS /* MW, July 1993 */
479 /* If we're redirecting STDOUT to a file, that file is already open
480 on fd_output. */
481 if (fd_output < 0)
483 if ((outf = egetenv ("TMPDIR")))
484 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
485 else
487 tempfile = alloca (20);
488 *tempfile = '\0';
490 dostounix_filename (tempfile, 0);
491 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
492 strcat (tempfile, "/");
493 strcat (tempfile, "detmp.XXX");
494 mktemp (tempfile);
495 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
496 if (outfilefd < 0) {
497 emacs_close (filefd);
498 report_file_error ("Opening process output file",
499 Fcons (build_string (tempfile), Qnil));
502 else
503 outfilefd = fd_output;
504 fd0 = filefd;
505 fd1 = outfilefd;
506 #endif /* MSDOS */
508 if (INTEGERP (buffer))
510 fd0 = -1;
511 fd1 = emacs_open (NULL_DEVICE, O_WRONLY, 0);
513 else
515 #ifndef MSDOS
516 int fd[2];
517 if (pipe (fd) == -1)
519 int pipe_errno = errno;
520 emacs_close (filefd);
521 errno = pipe_errno;
522 report_file_error ("Creating process pipe", Qnil);
524 fd0 = fd[0];
525 fd1 = fd[1];
526 #endif
530 int fd_error = fd1;
532 if (fd_output >= 0)
533 fd1 = fd_output;
535 if (NILP (error_file))
536 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
537 else if (STRINGP (error_file))
539 #ifdef DOS_NT
540 fd_error = emacs_open (SSDATA (error_file),
541 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
542 S_IREAD | S_IWRITE);
543 #else /* not DOS_NT */
544 fd_error = creat (SSDATA (error_file), 0666);
545 #endif /* not DOS_NT */
548 if (fd_error < 0)
550 emacs_close (filefd);
551 if (fd0 != filefd)
552 emacs_close (fd0);
553 if (fd1 >= 0)
554 emacs_close (fd1);
555 #ifdef MSDOS
556 unlink (tempfile);
557 #endif
558 if (NILP (error_file))
559 error_file = build_string (NULL_DEVICE);
560 else if (STRINGP (error_file))
561 error_file = DECODE_FILE (error_file);
562 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
565 #ifdef MSDOS /* MW, July 1993 */
566 /* Note that on MSDOS `child_setup' actually returns the child process
567 exit status, not its PID, so assign it to status below. */
568 pid = child_setup (filefd, outfilefd, fd_error, new_argv, 0, current_dir);
569 child_errno = errno;
571 emacs_close (outfilefd);
572 if (fd_error != outfilefd)
573 emacs_close (fd_error);
574 if (pid < 0)
576 synchronize_system_messages_locale ();
577 return
578 code_convert_string_norecord (build_string (strerror (child_errno)),
579 Vlocale_coding_system, 0);
581 status = pid;
582 fd1 = -1; /* No harm in closing that one! */
583 if (tempfile)
585 /* Since CRLF is converted to LF within `decode_coding', we
586 can always open a file with binary mode. */
587 fd0 = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
588 if (fd0 < 0)
590 unlink (tempfile);
591 emacs_close (filefd);
592 report_file_error ("Cannot re-open temporary file",
593 Fcons (build_string (tempfile), Qnil));
596 else
597 fd0 = -1; /* We are not going to read from tempfile. */
598 #endif /* MSDOS */
600 /* Do the unwind-protect now, even though the pid is not known, so
601 that no storage allocation is done in the critical section.
602 The actual PID will be filled in during the critical section. */
603 synch_process_pid = 0;
604 synch_process_fd = fd0;
606 #ifdef MSDOS
607 /* MSDOS needs different cleanup information. */
608 record_unwind_protect (call_process_cleanup,
609 Fcons (Fcurrent_buffer (),
610 build_string (tempfile ? tempfile : "")));
611 #else
612 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
614 block_input ();
615 block_child_signal ();
617 #ifdef WINDOWSNT
618 pid = child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
619 /* We need to record the input file of this child, for when we are
620 called from call-process-region to create an async subprocess.
621 That's because call-process-region's unwind procedure will
622 attempt to delete the temporary input file, which will fail
623 because that file is still in use. Recording it with the child
624 will allow us to delete the file when the subprocess exits.
625 The second part of this is in delete_temp_file, q.v. */
626 if (pid > 0 && INTEGERP (buffer) && nargs >= 2 && !NILP (args[1]))
627 record_infile (pid, xstrdup (SSDATA (infile)));
628 #else /* not WINDOWSNT */
630 /* vfork, and prevent local vars from being clobbered by the vfork. */
632 Lisp_Object volatile buffer_volatile = buffer;
633 Lisp_Object volatile coding_systems_volatile = coding_systems;
634 Lisp_Object volatile current_dir_volatile = current_dir;
635 bool volatile display_p_volatile = display_p;
636 bool volatile output_to_buffer_volatile = output_to_buffer;
637 bool volatile sa_must_free_volatile = sa_must_free;
638 int volatile fd1_volatile = fd1;
639 int volatile fd_error_volatile = fd_error;
640 int volatile fd_output_volatile = fd_output;
641 int volatile filefd_volatile = filefd;
642 ptrdiff_t volatile count_volatile = count;
643 ptrdiff_t volatile sa_count_volatile = sa_count;
644 char **volatile new_argv_volatile = new_argv;
646 pid = vfork ();
647 child_errno = errno;
649 buffer = buffer_volatile;
650 coding_systems = coding_systems_volatile;
651 current_dir = current_dir_volatile;
652 display_p = display_p_volatile;
653 output_to_buffer = output_to_buffer_volatile;
654 sa_must_free = sa_must_free_volatile;
655 fd1 = fd1_volatile;
656 fd_error = fd_error_volatile;
657 fd_output = fd_output_volatile;
658 filefd = filefd_volatile;
659 count = count_volatile;
660 sa_count = sa_count_volatile;
661 new_argv = new_argv_volatile;
663 fd0 = synch_process_fd;
666 if (pid == 0)
668 unblock_child_signal ();
670 if (fd0 >= 0)
671 emacs_close (fd0);
673 setsid ();
675 /* Emacs ignores SIGPIPE, but the child should not. */
676 signal (SIGPIPE, SIG_DFL);
678 child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
681 #endif /* not WINDOWSNT */
683 child_errno = errno;
685 if (0 < pid)
687 if (INTEGERP (buffer))
688 record_deleted_pid (pid);
689 else
690 synch_process_pid = pid;
693 unblock_child_signal ();
694 unblock_input ();
696 /* The MSDOS case did this already. */
697 if (fd_error >= 0)
698 emacs_close (fd_error);
699 #endif /* not MSDOS */
701 /* Close most of our file descriptors, but not fd0
702 since we will use that to read input from. */
703 emacs_close (filefd);
704 if (fd_output >= 0)
705 emacs_close (fd_output);
706 if (fd1 >= 0 && fd1 != fd_error)
707 emacs_close (fd1);
710 if (pid < 0)
712 errno = child_errno;
713 report_file_error ("Doing vfork", Qnil);
716 if (INTEGERP (buffer))
717 return unbind_to (count, Qnil);
719 if (BUFFERP (buffer))
720 Fset_buffer (buffer);
722 if (NILP (buffer))
724 /* If BUFFER is nil, we must read process output once and then
725 discard it, so setup coding system but with nil. */
726 setup_coding_system (Qnil, &process_coding);
727 process_coding.dst_multibyte = 0;
729 else
731 Lisp_Object val, *args2;
733 val = Qnil;
734 if (!NILP (Vcoding_system_for_read))
735 val = Vcoding_system_for_read;
736 else
738 if (EQ (coding_systems, Qt))
740 ptrdiff_t i;
742 SAFE_NALLOCA (args2, 1, nargs + 1);
743 args2[0] = Qcall_process;
744 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
745 coding_systems
746 = Ffind_operation_coding_system (nargs + 1, args2);
748 if (CONSP (coding_systems))
749 val = XCAR (coding_systems);
750 else if (CONSP (Vdefault_process_coding_system))
751 val = XCAR (Vdefault_process_coding_system);
752 else
753 val = Qnil;
755 Fcheck_coding_system (val);
756 /* In unibyte mode, character code conversion should not take
757 place but EOL conversion should. So, setup raw-text or one
758 of the subsidiary according to the information just setup. */
759 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
760 && !NILP (val))
761 val = raw_text_coding_system (val);
762 setup_coding_system (val, &process_coding);
763 process_coding.dst_multibyte
764 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
766 process_coding.src_multibyte = 0;
768 immediate_quit = 1;
769 QUIT;
771 if (output_to_buffer)
773 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
774 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
775 char buf[CALLPROC_BUFFER_SIZE_MAX];
776 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
777 int nread;
778 bool first = 1;
779 EMACS_INT total_read = 0;
780 int carryover = 0;
781 bool display_on_the_fly = display_p;
782 struct coding_system saved_coding;
784 saved_coding = process_coding;
785 while (1)
787 /* Repeatedly read until we've filled as much as possible
788 of the buffer size we have. But don't read
789 less than 1024--save that for the next bufferful. */
790 nread = carryover;
791 while (nread < bufsize - 1024)
793 int this_read = emacs_read (fd0, buf + nread,
794 bufsize - nread);
796 if (this_read < 0)
797 goto give_up;
799 if (this_read == 0)
801 process_coding.mode |= CODING_MODE_LAST_BLOCK;
802 break;
805 nread += this_read;
806 total_read += this_read;
808 if (display_on_the_fly)
809 break;
812 /* Now NREAD is the total amount of data in the buffer. */
813 immediate_quit = 0;
815 if (!NILP (buffer))
817 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
818 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
819 insert_1_both (buf, nread, nread, 0, 1, 0);
820 else
821 { /* We have to decode the input. */
822 Lisp_Object curbuf;
823 ptrdiff_t count1 = SPECPDL_INDEX ();
825 XSETBUFFER (curbuf, current_buffer);
826 /* We cannot allow after-change-functions be run
827 during decoding, because that might modify the
828 buffer, while we rely on process_coding.produced to
829 faithfully reflect inserted text until we
830 TEMP_SET_PT_BOTH below. */
831 specbind (Qinhibit_modification_hooks, Qt);
832 decode_coding_c_string (&process_coding,
833 (unsigned char *) buf, nread, curbuf);
834 unbind_to (count1, Qnil);
835 if (display_on_the_fly
836 && CODING_REQUIRE_DETECTION (&saved_coding)
837 && ! CODING_REQUIRE_DETECTION (&process_coding))
839 /* We have detected some coding system. But,
840 there's a possibility that the detection was
841 done by insufficient data. So, we give up
842 displaying on the fly. */
843 if (process_coding.produced > 0)
844 del_range_2 (process_coding.dst_pos,
845 process_coding.dst_pos_byte,
846 process_coding.dst_pos
847 + process_coding.produced_char,
848 process_coding.dst_pos_byte
849 + process_coding.produced, 0);
850 display_on_the_fly = 0;
851 process_coding = saved_coding;
852 carryover = nread;
853 /* This is to make the above condition always
854 fails in the future. */
855 saved_coding.common_flags
856 &= ~CODING_REQUIRE_DETECTION_MASK;
857 continue;
860 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
861 PT_BYTE + process_coding.produced);
862 carryover = process_coding.carryover_bytes;
863 if (carryover > 0)
864 memcpy (buf, process_coding.carryover,
865 process_coding.carryover_bytes);
869 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
870 break;
872 /* Make the buffer bigger as we continue to read more data,
873 but not past CALLPROC_BUFFER_SIZE_MAX. */
874 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
875 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
876 bufsize = CALLPROC_BUFFER_SIZE_MAX;
878 if (display_p)
880 if (first)
881 prepare_menu_bars ();
882 first = 0;
883 redisplay_preserve_echo_area (1);
884 /* This variable might have been set to 0 for code
885 detection. In that case, we set it back to 1 because
886 we should have already detected a coding system. */
887 display_on_the_fly = 1;
889 immediate_quit = 1;
890 QUIT;
892 give_up: ;
894 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
895 /* If the caller required, let the buffer inherit the
896 coding-system used to decode the process output. */
897 if (inherit_process_coding_system)
898 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
899 make_number (total_read));
902 #ifndef MSDOS
903 /* Wait for it to terminate, unless it already has. */
904 wait_for_termination (pid, &status, !output_to_buffer);
905 #endif
907 immediate_quit = 0;
909 /* Don't kill any children that the subprocess may have left behind
910 when exiting. */
911 synch_process_pid = 0;
913 SAFE_FREE ();
914 unbind_to (count, Qnil);
916 if (WIFSIGNALED (status))
918 const char *signame;
920 synchronize_system_messages_locale ();
921 signame = strsignal (WTERMSIG (status));
923 if (signame == 0)
924 signame = "unknown";
926 return code_convert_string_norecord (build_string (signame),
927 Vlocale_coding_system, 0);
930 eassert (WIFEXITED (status));
931 return make_number (WEXITSTATUS (status));
934 static Lisp_Object
935 delete_temp_file (Lisp_Object name)
937 /* Suppress jka-compr handling, etc. */
938 ptrdiff_t count = SPECPDL_INDEX ();
939 specbind (intern ("file-name-handler-alist"), Qnil);
940 #ifdef WINDOWSNT
941 /* If this is called when the subprocess didn't exit yet, the
942 attempt to delete its input file will fail. In that case, we
943 schedule the file for deletion when the subprocess exits. This
944 is the 2nd part of handling this situation; see the call to
945 record_infile in call-process above, for the first part. */
946 if (!internal_delete_file (name))
948 Lisp_Object encoded_file = ENCODE_FILE (name);
950 record_pending_deletion (SSDATA (encoded_file));
952 #else
953 internal_delete_file (name);
954 #endif
955 unbind_to (count, Qnil);
956 return Qnil;
959 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
960 3, MANY, 0,
961 doc: /* Send text from START to END to a synchronous process running PROGRAM.
962 The remaining arguments are optional.
963 Delete the text if fourth arg DELETE is non-nil.
965 Insert output in BUFFER before point; t means current buffer; nil for
966 BUFFER means discard it; 0 means discard and don't wait; and `(:file
967 FILE)', where FILE is a file name string, means that it should be
968 written to that file (if the file already exists it is overwritten).
969 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
970 REAL-BUFFER says what to do with standard output, as above,
971 while STDERR-FILE says what to do with standard error in the child.
972 STDERR-FILE may be nil (discard standard error output),
973 t (mix it with ordinary output), or a file name string.
975 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
976 Remaining args are passed to PROGRAM at startup as command args.
978 If BUFFER is 0, `call-process-region' returns immediately with value nil.
979 Otherwise it waits for PROGRAM to terminate
980 and returns a numeric exit status or a signal description string.
981 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
983 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
984 (ptrdiff_t nargs, Lisp_Object *args)
986 struct gcpro gcpro1;
987 Lisp_Object filename_string;
988 register Lisp_Object start, end;
989 ptrdiff_t count = SPECPDL_INDEX ();
990 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
991 Lisp_Object coding_systems;
992 Lisp_Object val, *args2;
993 ptrdiff_t i;
994 Lisp_Object tmpdir;
996 if (STRINGP (Vtemporary_file_directory))
997 tmpdir = Vtemporary_file_directory;
998 else
1000 #ifndef DOS_NT
1001 if (getenv ("TMPDIR"))
1002 tmpdir = build_string (getenv ("TMPDIR"));
1003 else
1004 tmpdir = build_string ("/tmp/");
1005 #else /* DOS_NT */
1006 char *outf;
1007 if ((outf = egetenv ("TMPDIR"))
1008 || (outf = egetenv ("TMP"))
1009 || (outf = egetenv ("TEMP")))
1010 tmpdir = build_string (outf);
1011 else
1012 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
1013 #endif
1017 USE_SAFE_ALLOCA;
1018 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
1019 Lisp_Object encoded_tem;
1020 char *tempfile;
1022 #ifdef WINDOWSNT
1023 /* Cannot use the result of Fexpand_file_name, because it
1024 downcases the XXXXXX part of the pattern, and mktemp then
1025 doesn't recognize it. */
1026 if (!NILP (Vw32_downcase_file_names))
1028 Lisp_Object dirname = Ffile_name_directory (pattern);
1030 if (NILP (dirname))
1031 pattern = Vtemp_file_name_pattern;
1032 else
1033 pattern = concat2 (dirname, Vtemp_file_name_pattern);
1035 #endif
1037 encoded_tem = ENCODE_FILE (pattern);
1038 tempfile = SAFE_ALLOCA (SBYTES (encoded_tem) + 1);
1039 memcpy (tempfile, SDATA (encoded_tem), SBYTES (encoded_tem) + 1);
1040 coding_systems = Qt;
1042 #ifdef HAVE_MKSTEMP
1044 int fd;
1046 block_input ();
1047 fd = mkstemp (tempfile);
1048 unblock_input ();
1049 if (fd == -1)
1050 report_file_error ("Failed to open temporary file",
1051 Fcons (build_string (tempfile), Qnil));
1052 else
1053 close (fd);
1055 #else
1056 errno = 0;
1057 mktemp (tempfile);
1058 if (!*tempfile)
1060 if (!errno)
1061 errno = EEXIST;
1062 report_file_error ("Failed to open temporary file using pattern",
1063 Fcons (pattern, Qnil));
1065 #endif
1067 filename_string = build_string (tempfile);
1068 GCPRO1 (filename_string);
1069 SAFE_FREE ();
1072 start = args[0];
1073 end = args[1];
1074 /* Decide coding-system of the contents of the temporary file. */
1075 if (!NILP (Vcoding_system_for_write))
1076 val = Vcoding_system_for_write;
1077 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1078 val = Qraw_text;
1079 else
1081 USE_SAFE_ALLOCA;
1082 SAFE_NALLOCA (args2, 1, nargs + 1);
1083 args2[0] = Qcall_process_region;
1084 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1085 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1086 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1087 SAFE_FREE ();
1089 val = complement_process_encoding_system (val);
1092 ptrdiff_t count1 = SPECPDL_INDEX ();
1094 specbind (intern ("coding-system-for-write"), val);
1095 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1096 happen to get a ".Z" suffix. */
1097 specbind (intern ("file-name-handler-alist"), Qnil);
1098 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1100 unbind_to (count1, Qnil);
1103 /* Note that Fcall_process takes care of binding
1104 coding-system-for-read. */
1106 record_unwind_protect (delete_temp_file, filename_string);
1108 if (nargs > 3 && !NILP (args[3]))
1109 Fdelete_region (start, end);
1111 if (nargs > 3)
1113 args += 2;
1114 nargs -= 2;
1116 else
1118 args[0] = args[2];
1119 nargs = 2;
1121 args[1] = filename_string;
1123 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1126 #ifndef WINDOWSNT
1127 static int relocate_fd (int fd, int minfd);
1128 #endif
1130 static char **
1131 add_env (char **env, char **new_env, char *string)
1133 char **ep;
1134 bool ok = 1;
1135 if (string == NULL)
1136 return new_env;
1138 /* See if this string duplicates any string already in the env.
1139 If so, don't put it in.
1140 When an env var has multiple definitions,
1141 we keep the definition that comes first in process-environment. */
1142 for (ep = env; ok && ep != new_env; ep++)
1144 char *p = *ep, *q = string;
1145 while (ok)
1147 if (*q != *p)
1148 break;
1149 if (*q == 0)
1150 /* The string is a lone variable name; keep it for now, we
1151 will remove it later. It is a placeholder for a
1152 variable that is not to be included in the environment. */
1153 break;
1154 if (*q == '=')
1155 ok = 0;
1156 p++, q++;
1159 if (ok)
1160 *new_env++ = string;
1161 return new_env;
1164 /* This is the last thing run in a newly forked inferior
1165 either synchronous or asynchronous.
1166 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1167 Initialize inferior's priority, pgrp, connected dir and environment.
1168 then exec another program based on new_argv.
1170 If SET_PGRP, put the subprocess into a separate process group.
1172 CURRENT_DIR is an elisp string giving the path of the current
1173 directory the subprocess should have. Since we can't really signal
1174 a decent error from within the child, this should be verified as an
1175 executable directory by the parent. */
1178 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1179 Lisp_Object current_dir)
1181 char **env;
1182 char *pwd_var;
1183 #ifdef WINDOWSNT
1184 int cpid;
1185 HANDLE handles[3];
1186 #endif /* WINDOWSNT */
1188 pid_t pid = getpid ();
1190 /* Close Emacs's descriptors that this process should not have. */
1191 close_process_descs ();
1193 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1194 we will lose if we call close_load_descs here. */
1195 #ifndef DOS_NT
1196 close_load_descs ();
1197 #endif
1199 /* Note that use of alloca is always safe here. It's obvious for systems
1200 that do not have true vfork or that have true (stack) alloca.
1201 If using vfork and C_ALLOCA (when Emacs used to include
1202 src/alloca.c) it is safe because that changes the superior's
1203 static variables as if the superior had done alloca and will be
1204 cleaned up in the usual way. */
1206 register char *temp;
1207 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1209 i = SBYTES (current_dir);
1210 #ifdef MSDOS
1211 /* MSDOS must have all environment variables malloc'ed, because
1212 low-level libc functions that launch subsidiary processes rely
1213 on that. */
1214 pwd_var = xmalloc (i + 6);
1215 #else
1216 pwd_var = alloca (i + 6);
1217 #endif
1218 temp = pwd_var + 4;
1219 memcpy (pwd_var, "PWD=", 4);
1220 memcpy (temp, SDATA (current_dir), i);
1221 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1222 temp[i] = 0;
1224 #ifndef DOS_NT
1225 /* We can't signal an Elisp error here; we're in a vfork. Since
1226 the callers check the current directory before forking, this
1227 should only return an error if the directory's permissions
1228 are changed between the check and this chdir, but we should
1229 at least check. */
1230 if (chdir (temp) < 0)
1231 _exit (errno);
1232 #else /* DOS_NT */
1233 /* Get past the drive letter, so that d:/ is left alone. */
1234 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1236 temp += 2;
1237 i -= 2;
1239 #endif /* DOS_NT */
1241 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1242 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1243 temp[--i] = 0;
1246 /* Set `env' to a vector of the strings in the environment. */
1248 register Lisp_Object tem;
1249 register char **new_env;
1250 char **p, **q;
1251 register int new_length;
1252 Lisp_Object display = Qnil;
1254 new_length = 0;
1256 for (tem = Vprocess_environment;
1257 CONSP (tem) && STRINGP (XCAR (tem));
1258 tem = XCDR (tem))
1260 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1261 && (SDATA (XCAR (tem)) [7] == '\0'
1262 || SDATA (XCAR (tem)) [7] == '='))
1263 /* DISPLAY is specified in process-environment. */
1264 display = Qt;
1265 new_length++;
1268 /* If not provided yet, use the frame's DISPLAY. */
1269 if (NILP (display))
1271 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1272 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1273 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1274 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1275 Vinitial_environment);
1276 if (STRINGP (tmp))
1278 display = tmp;
1279 new_length++;
1283 /* new_length + 2 to include PWD and terminating 0. */
1284 env = new_env = alloca ((new_length + 2) * sizeof *env);
1285 /* If we have a PWD envvar, pass one down,
1286 but with corrected value. */
1287 if (egetenv ("PWD"))
1288 *new_env++ = pwd_var;
1290 if (STRINGP (display))
1292 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1293 strcpy (vdata, "DISPLAY=");
1294 strcat (vdata, SSDATA (display));
1295 new_env = add_env (env, new_env, vdata);
1298 /* Overrides. */
1299 for (tem = Vprocess_environment;
1300 CONSP (tem) && STRINGP (XCAR (tem));
1301 tem = XCDR (tem))
1302 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1304 *new_env = 0;
1306 /* Remove variable names without values. */
1307 p = q = env;
1308 while (*p != 0)
1310 while (*q != 0 && strchr (*q, '=') == NULL)
1311 q++;
1312 *p = *q++;
1313 if (*p != 0)
1314 p++;
1319 #ifdef WINDOWSNT
1320 prepare_standard_handles (in, out, err, handles);
1321 set_process_dir (SDATA (current_dir));
1322 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1323 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1324 reset_standard_handles (in, out, err, handles);
1325 if (cpid == -1)
1326 /* An error occurred while trying to spawn the process. */
1327 report_file_error ("Spawning child process", Qnil);
1328 return cpid;
1330 #else /* not WINDOWSNT */
1331 /* Make sure that in, out, and err are not actually already in
1332 descriptors zero, one, or two; this could happen if Emacs is
1333 started with its standard in, out, or error closed, as might
1334 happen under X. */
1336 int oin = in, oout = out;
1338 /* We have to avoid relocating the same descriptor twice! */
1340 in = relocate_fd (in, 3);
1342 if (out == oin)
1343 out = in;
1344 else
1345 out = relocate_fd (out, 3);
1347 if (err == oin)
1348 err = in;
1349 else if (err == oout)
1350 err = out;
1351 else
1352 err = relocate_fd (err, 3);
1355 #ifndef MSDOS
1356 emacs_close (0);
1357 emacs_close (1);
1358 emacs_close (2);
1360 dup2 (in, 0);
1361 dup2 (out, 1);
1362 dup2 (err, 2);
1363 emacs_close (in);
1364 if (out != in)
1365 emacs_close (out);
1366 if (err != in && err != out)
1367 emacs_close (err);
1369 setpgid (0, 0);
1370 tcsetpgrp (0, pid);
1372 execve (new_argv[0], new_argv, env);
1374 emacs_write (1, "Can't exec program: ", 20);
1375 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1376 emacs_write (1, "\n", 1);
1377 _exit (1);
1379 #else /* MSDOS */
1380 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1381 xfree (pwd_var);
1382 if (pid == -1)
1383 /* An error occurred while trying to run the subprocess. */
1384 report_file_error ("Spawning child process", Qnil);
1385 return pid;
1386 #endif /* MSDOS */
1387 #endif /* not WINDOWSNT */
1390 #ifndef WINDOWSNT
1391 /* Move the file descriptor FD so that its number is not less than MINFD.
1392 If the file descriptor is moved at all, the original is freed. */
1393 static int
1394 relocate_fd (int fd, int minfd)
1396 if (fd >= minfd)
1397 return fd;
1398 else
1400 int new = fcntl (fd, F_DUPFD, minfd);
1401 if (new == -1)
1403 const char *message_1 = "Error while setting up child: ";
1404 const char *errmessage = strerror (errno);
1405 const char *message_2 = "\n";
1406 emacs_write (2, message_1, strlen (message_1));
1407 emacs_write (2, errmessage, strlen (errmessage));
1408 emacs_write (2, message_2, strlen (message_2));
1409 _exit (1);
1411 emacs_close (fd);
1412 return new;
1415 #endif /* not WINDOWSNT */
1417 static bool
1418 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1419 ptrdiff_t *valuelen, Lisp_Object env)
1421 for (; CONSP (env); env = XCDR (env))
1423 Lisp_Object entry = XCAR (env);
1424 if (STRINGP (entry)
1425 && SBYTES (entry) >= varlen
1426 #ifdef WINDOWSNT
1427 /* NT environment variables are case insensitive. */
1428 && ! strnicmp (SDATA (entry), var, varlen)
1429 #else /* not WINDOWSNT */
1430 && ! memcmp (SDATA (entry), var, varlen)
1431 #endif /* not WINDOWSNT */
1434 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1436 *value = SSDATA (entry) + (varlen + 1);
1437 *valuelen = SBYTES (entry) - (varlen + 1);
1438 return 1;
1440 else if (SBYTES (entry) == varlen)
1442 /* Lone variable names in Vprocess_environment mean that
1443 variable should be removed from the environment. */
1444 *value = NULL;
1445 return 1;
1449 return 0;
1452 static bool
1453 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1454 ptrdiff_t *valuelen, Lisp_Object frame)
1456 /* Try to find VAR in Vprocess_environment first. */
1457 if (getenv_internal_1 (var, varlen, value, valuelen,
1458 Vprocess_environment))
1459 return *value ? 1 : 0;
1461 /* For DISPLAY try to get the values from the frame or the initial env. */
1462 if (strcmp (var, "DISPLAY") == 0)
1464 Lisp_Object display
1465 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1466 if (STRINGP (display))
1468 *value = SSDATA (display);
1469 *valuelen = SBYTES (display);
1470 return 1;
1472 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1473 if (getenv_internal_1 (var, varlen, value, valuelen,
1474 Vinitial_environment))
1475 return *value ? 1 : 0;
1478 return 0;
1481 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1482 doc: /* Get the value of environment variable VARIABLE.
1483 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1484 the environment. Otherwise, value is a string.
1486 This function searches `process-environment' for VARIABLE.
1488 If optional parameter ENV is a list, then search this list instead of
1489 `process-environment', and return t when encountering a negative entry
1490 \(an entry for a variable with no value). */)
1491 (Lisp_Object variable, Lisp_Object env)
1493 char *value;
1494 ptrdiff_t valuelen;
1496 CHECK_STRING (variable);
1497 if (CONSP (env))
1499 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1500 &value, &valuelen, env))
1501 return value ? make_string (value, valuelen) : Qt;
1502 else
1503 return Qnil;
1505 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1506 &value, &valuelen, env))
1507 return make_string (value, valuelen);
1508 else
1509 return Qnil;
1512 /* A version of getenv that consults the Lisp environment lists,
1513 easily callable from C. */
1514 char *
1515 egetenv (const char *var)
1517 char *value;
1518 ptrdiff_t valuelen;
1520 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1521 return value;
1522 else
1523 return 0;
1527 /* This is run before init_cmdargs. */
1529 void
1530 init_callproc_1 (void)
1532 #ifdef HAVE_NS
1533 const char *etc_dir = ns_etc_directory ();
1534 const char *path_exec = ns_exec_path ();
1535 #endif
1537 Vdata_directory = decode_env_path ("EMACSDATA",
1538 #ifdef HAVE_NS
1539 etc_dir ? etc_dir :
1540 #endif
1541 PATH_DATA);
1542 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1544 Vdoc_directory = decode_env_path ("EMACSDOC",
1545 #ifdef HAVE_NS
1546 etc_dir ? etc_dir :
1547 #endif
1548 PATH_DOC);
1549 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1551 /* Check the EMACSPATH environment variable, defaulting to the
1552 PATH_EXEC path from epaths.h. */
1553 Vexec_path = decode_env_path ("EMACSPATH",
1554 #ifdef HAVE_NS
1555 path_exec ? path_exec :
1556 #endif
1557 PATH_EXEC);
1558 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1559 /* FIXME? For ns, path_exec should go at the front? */
1560 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1563 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1565 void
1566 init_callproc (void)
1568 char *data_dir = egetenv ("EMACSDATA");
1570 register char * sh;
1571 Lisp_Object tempdir;
1572 #ifdef HAVE_NS
1573 if (data_dir == 0)
1575 const char *etc_dir = ns_etc_directory ();
1576 if (etc_dir)
1578 data_dir = alloca (strlen (etc_dir) + 1);
1579 strcpy (data_dir, etc_dir);
1582 #endif
1584 if (!NILP (Vinstallation_directory))
1586 /* Add to the path the lib-src subdir of the installation dir. */
1587 Lisp_Object tem;
1588 tem = Fexpand_file_name (build_string ("lib-src"),
1589 Vinstallation_directory);
1590 #ifndef MSDOS
1591 /* MSDOS uses wrapped binaries, so don't do this. */
1592 if (NILP (Fmember (tem, Vexec_path)))
1594 #ifdef HAVE_NS
1595 const char *path_exec = ns_exec_path ();
1596 #endif
1597 Vexec_path = decode_env_path ("EMACSPATH",
1598 #ifdef HAVE_NS
1599 path_exec ? path_exec :
1600 #endif
1601 PATH_EXEC);
1602 Vexec_path = Fcons (tem, Vexec_path);
1603 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1606 Vexec_directory = Ffile_name_as_directory (tem);
1607 #endif /* not MSDOS */
1609 /* Maybe use ../etc as well as ../lib-src. */
1610 if (data_dir == 0)
1612 tem = Fexpand_file_name (build_string ("etc"),
1613 Vinstallation_directory);
1614 Vdoc_directory = Ffile_name_as_directory (tem);
1618 /* Look for the files that should be in etc. We don't use
1619 Vinstallation_directory, because these files are never installed
1620 near the executable, and they are never in the build
1621 directory when that's different from the source directory.
1623 Instead, if these files are not in the nominal place, we try the
1624 source directory. */
1625 if (data_dir == 0)
1627 Lisp_Object tem, tem1, srcdir;
1629 srcdir = Fexpand_file_name (build_string ("../src/"),
1630 build_string (PATH_DUMPLOADSEARCH));
1631 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1632 tem1 = Ffile_exists_p (tem);
1633 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1635 Lisp_Object newdir;
1636 newdir = Fexpand_file_name (build_string ("../etc/"),
1637 build_string (PATH_DUMPLOADSEARCH));
1638 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1639 tem1 = Ffile_exists_p (tem);
1640 if (!NILP (tem1))
1641 Vdata_directory = newdir;
1645 #ifndef CANNOT_DUMP
1646 if (initialized)
1647 #endif
1649 tempdir = Fdirectory_file_name (Vexec_directory);
1650 if (! file_accessible_directory_p (SSDATA (tempdir)))
1651 dir_warning ("arch-dependent data dir", Vexec_directory);
1654 tempdir = Fdirectory_file_name (Vdata_directory);
1655 if (! file_accessible_directory_p (SSDATA (tempdir)))
1656 dir_warning ("arch-independent data dir", Vdata_directory);
1658 sh = (char *) getenv ("SHELL");
1659 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1661 #ifdef DOS_NT
1662 Vshared_game_score_directory = Qnil;
1663 #else
1664 Vshared_game_score_directory = build_string (PATH_GAME);
1665 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1666 Vshared_game_score_directory = Qnil;
1667 #endif
1670 void
1671 set_initial_environment (void)
1673 char **envp;
1674 for (envp = environ; *envp; envp++)
1675 Vprocess_environment = Fcons (build_string (*envp),
1676 Vprocess_environment);
1677 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1678 to use `delete' and friends on process-environment. */
1679 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1682 void
1683 syms_of_callproc (void)
1685 #ifndef DOS_NT
1686 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1687 #elif defined (WINDOWSNT)
1688 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1689 #else
1690 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1691 #endif
1692 staticpro (&Vtemp_file_name_pattern);
1694 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1695 doc: /* File name to load inferior shells from.
1696 Initialized from the SHELL environment variable, or to a system-dependent
1697 default if SHELL is not set. */);
1699 DEFVAR_LISP ("exec-path", Vexec_path,
1700 doc: /* List of directories to search programs to run in subprocesses.
1701 Each element is a string (directory name) or nil (try default directory). */);
1703 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1704 doc: /* List of suffixes to try to find executable file names.
1705 Each element is a string. */);
1706 Vexec_suffixes = Qnil;
1708 DEFVAR_LISP ("exec-directory", Vexec_directory,
1709 doc: /* Directory for executables for Emacs to invoke.
1710 More generally, this includes any architecture-dependent files
1711 that are built and installed from the Emacs distribution. */);
1713 DEFVAR_LISP ("data-directory", Vdata_directory,
1714 doc: /* Directory of machine-independent files that come with GNU Emacs.
1715 These are files intended for Emacs to use while it runs. */);
1717 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1718 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1719 This is usually the same as `data-directory'. */);
1721 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1722 doc: /* For internal use by the build procedure only.
1723 This is the name of the directory in which the build procedure installed
1724 Emacs's info files; the default value for `Info-default-directory-list'
1725 includes this. */);
1726 Vconfigure_info_directory = build_string (PATH_INFO);
1728 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1729 doc: /* Directory of score files for games which come with GNU Emacs.
1730 If this variable is nil, then Emacs is unable to use a shared directory. */);
1731 #ifdef DOS_NT
1732 Vshared_game_score_directory = Qnil;
1733 #else
1734 Vshared_game_score_directory = build_string (PATH_GAME);
1735 #endif
1737 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1738 doc: /* List of environment variables inherited from the parent process.
1739 Each element should be a string of the form ENVVARNAME=VALUE.
1740 The elements must normally be decoded (using `locale-coding-system') for use. */);
1741 Vinitial_environment = Qnil;
1743 DEFVAR_LISP ("process-environment", Vprocess_environment,
1744 doc: /* List of overridden environment variables for subprocesses to inherit.
1745 Each element should be a string of the form ENVVARNAME=VALUE.
1747 Entries in this list take precedence to those in the frame-local
1748 environments. Therefore, let-binding `process-environment' is an easy
1749 way to temporarily change the value of an environment variable,
1750 irrespective of where it comes from. To use `process-environment' to
1751 remove an environment variable, include only its name in the list,
1752 without "=VALUE".
1754 This variable is set to nil when Emacs starts.
1756 If multiple entries define the same variable, the first one always
1757 takes precedence.
1759 Non-ASCII characters are encoded according to the initial value of
1760 `locale-coding-system', i.e. the elements must normally be decoded for
1761 use.
1763 See `setenv' and `getenv'. */);
1764 Vprocess_environment = Qnil;
1766 defsubr (&Scall_process);
1767 defsubr (&Sgetenv_internal);
1768 defsubr (&Scall_process_region);