* process.h (PSET): Remove.
[emacs.git] / src / callproc.c
blob10a80168fb2f7670c18ad621b3a906f490454592
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 <signal.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <setjmp.h>
26 #include <sys/types.h>
27 #include <unistd.h>
29 #include <sys/file.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 #ifdef WINDOWSNT
35 #define NOMINMAX
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
46 #include "commands.h"
47 #include "character.h"
48 #include "buffer.h"
49 #include "ccl.h"
50 #include "coding.h"
51 #include "composite.h"
52 #include <epaths.h>
53 #include "process.h"
54 #include "syssignal.h"
55 #include "systty.h"
56 #include "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 #ifndef USE_CRT_DLL
69 extern char **environ;
70 #endif
72 #ifdef HAVE_SETPGID
73 #if !defined (USG)
74 #undef setpgrp
75 #define setpgrp setpgid
76 #endif
77 #endif
79 /* Pattern used by call-process-region to make temp files. */
80 static Lisp_Object Vtemp_file_name_pattern;
82 /* True if we are about to fork off a synchronous process or if we
83 are waiting for it. */
84 int synch_process_alive;
86 /* Nonzero => this is a string explaining death of synchronous subprocess. */
87 const char *synch_process_death;
89 /* Nonzero => this is the signal number that terminated the subprocess. */
90 int synch_process_termsig;
92 /* If synch_process_death is zero,
93 this is exit code of synchronous subprocess. */
94 int synch_process_retcode;
97 /* Clean up when exiting Fcall_process.
98 On MSDOS, delete the temporary file on any kind of termination.
99 On Unix, kill the process and any children on termination by signal. */
101 /* Nonzero if this is termination due to exit. */
102 static int call_process_exited;
104 static Lisp_Object
105 call_process_kill (Lisp_Object fdpid)
107 int fd;
108 pid_t pid;
109 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
110 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
111 emacs_close (fd);
112 EMACS_KILLPG (pid, SIGKILL);
113 synch_process_alive = 0;
114 return Qnil;
117 static Lisp_Object
118 call_process_cleanup (Lisp_Object arg)
120 Lisp_Object fdpid = Fcdr (arg);
121 int fd;
122 #if defined (MSDOS)
123 Lisp_Object file;
124 #else
125 pid_t pid;
126 #endif
128 Fset_buffer (Fcar (arg));
129 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
131 #if defined (MSDOS)
132 /* for MSDOS fdpid is really (fd . tempfile) */
133 file = Fcdr (fdpid);
134 /* FD is -1 and FILE is "" when we didn't actually create a
135 temporary file in call-process. */
136 if (fd >= 0)
137 emacs_close (fd);
138 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
139 unlink (SDATA (file));
140 #else /* not MSDOS */
141 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
143 if (call_process_exited)
145 emacs_close (fd);
146 return Qnil;
149 if (EMACS_KILLPG (pid, SIGINT) == 0)
151 ptrdiff_t count = SPECPDL_INDEX ();
152 record_unwind_protect (call_process_kill, fdpid);
153 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
154 immediate_quit = 1;
155 QUIT;
156 wait_for_termination (pid);
157 immediate_quit = 0;
158 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
159 message1 ("Waiting for process to die...done");
161 synch_process_alive = 0;
162 emacs_close (fd);
163 #endif /* not MSDOS */
164 return Qnil;
167 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
168 doc: /* Call PROGRAM synchronously in separate process.
169 The remaining arguments are optional.
170 The program's input comes from file INFILE (nil means `/dev/null').
171 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
172 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
173 FILE is a file name string, means that it should be written to that file
174 \(if the file already exists it is overwritten).
175 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
176 REAL-BUFFER says what to do with standard output, as above,
177 while STDERR-FILE says what to do with standard error in the child.
178 STDERR-FILE may be nil (discard standard error output),
179 t (mix it with ordinary output), or a file name string.
181 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
182 Remaining arguments are strings passed as command arguments to PROGRAM.
184 If executable PROGRAM can't be found as an executable, `call-process'
185 signals a Lisp error. `call-process' reports errors in execution of
186 the program only through its return and output.
188 If BUFFER is 0, `call-process' returns immediately with value nil.
189 Otherwise it waits for PROGRAM to terminate
190 and returns a numeric exit status or a signal description string.
191 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
193 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
194 (ptrdiff_t nargs, Lisp_Object *args)
196 Lisp_Object infile, buffer, current_dir, path, cleanup_info_tail;
197 int display_p;
198 int fd[2];
199 int filefd;
200 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
201 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
202 char buf[CALLPROC_BUFFER_SIZE_MAX];
203 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
204 ptrdiff_t count = SPECPDL_INDEX ();
205 USE_SAFE_ALLOCA;
207 register const unsigned char **new_argv;
208 /* File to use for stderr in the child.
209 t means use same as standard output. */
210 Lisp_Object error_file;
211 Lisp_Object output_file = Qnil;
212 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
213 char *outf, *tempfile = NULL;
214 int outfilefd;
215 int pid;
216 #else
217 pid_t pid;
218 #endif
219 int fd_output = -1;
220 struct coding_system process_coding; /* coding-system of process output */
221 struct coding_system argument_coding; /* coding-system of arguments */
222 /* Set to the return value of Ffind_operation_coding_system. */
223 Lisp_Object coding_systems;
224 int output_to_buffer = 1;
226 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
227 coding_systems = Qt;
229 CHECK_STRING (args[0]);
231 error_file = Qt;
233 #ifndef subprocesses
234 /* Without asynchronous processes we cannot have BUFFER == 0. */
235 if (nargs >= 3
236 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
237 error ("Operating system cannot handle asynchronous subprocesses");
238 #endif /* subprocesses */
240 /* Decide the coding-system for giving arguments. */
242 Lisp_Object val, *args2;
243 ptrdiff_t i;
245 /* If arguments are supplied, we may have to encode them. */
246 if (nargs >= 5)
248 int must_encode = 0;
249 Lisp_Object coding_attrs;
251 for (i = 4; i < nargs; i++)
252 CHECK_STRING (args[i]);
254 for (i = 4; i < nargs; i++)
255 if (STRING_MULTIBYTE (args[i]))
256 must_encode = 1;
258 if (!NILP (Vcoding_system_for_write))
259 val = Vcoding_system_for_write;
260 else if (! must_encode)
261 val = Qraw_text;
262 else
264 SAFE_NALLOCA (args2, 1, nargs + 1);
265 args2[0] = Qcall_process;
266 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
267 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
268 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
270 val = complement_process_encoding_system (val);
271 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
272 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
273 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
275 /* We should not use an ASCII incompatible coding system. */
276 val = raw_text_coding_system (val);
277 setup_coding_system (val, &argument_coding);
282 if (nargs >= 2 && ! NILP (args[1]))
284 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
285 CHECK_STRING (infile);
287 else
288 infile = build_string (NULL_DEVICE);
290 if (nargs >= 3)
292 buffer = args[2];
294 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
295 FILE-FOR-STDERR), unless the first element is :file, in which case see
296 the next paragraph. */
297 if (CONSP (buffer)
298 && (! SYMBOLP (XCAR (buffer))
299 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
301 if (CONSP (XCDR (buffer)))
303 Lisp_Object stderr_file;
304 stderr_file = XCAR (XCDR (buffer));
306 if (NILP (stderr_file) || EQ (Qt, stderr_file))
307 error_file = stderr_file;
308 else
309 error_file = Fexpand_file_name (stderr_file, Qnil);
312 buffer = XCAR (buffer);
315 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
316 if (CONSP (buffer)
317 && SYMBOLP (XCAR (buffer))
318 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
320 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
321 BVAR (current_buffer, directory));
322 CHECK_STRING (output_file);
323 buffer = Qnil;
326 if (!(EQ (buffer, Qnil)
327 || EQ (buffer, Qt)
328 || INTEGERP (buffer)))
330 Lisp_Object spec_buffer;
331 spec_buffer = buffer;
332 buffer = Fget_buffer_create (buffer);
333 /* Mention the buffer name for a better error message. */
334 if (NILP (buffer))
335 CHECK_BUFFER (spec_buffer);
336 CHECK_BUFFER (buffer);
339 else
340 buffer = Qnil;
342 /* Make sure that the child will be able to chdir to the current
343 buffer's current directory, or its unhandled equivalent. We
344 can't just have the child check for an error when it does the
345 chdir, since it's in a vfork.
347 We have to GCPRO around this because Fexpand_file_name,
348 Funhandled_file_name_directory, and Ffile_accessible_directory_p
349 might call a file name handling function. The argument list is
350 protected by the caller, so all we really have to worry about is
351 buffer. */
353 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
355 current_dir = BVAR (current_buffer, directory);
357 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
359 current_dir = Funhandled_file_name_directory (current_dir);
360 if (NILP (current_dir))
361 /* If the file name handler says that current_dir is unreachable, use
362 a sensible default. */
363 current_dir = build_string ("~/");
364 current_dir = expand_and_dir_to_file (current_dir, Qnil);
365 current_dir = Ffile_name_as_directory (current_dir);
367 if (NILP (Ffile_accessible_directory_p (current_dir)))
368 report_file_error ("Setting current directory",
369 Fcons (BVAR (current_buffer, directory), Qnil));
371 if (STRING_MULTIBYTE (infile))
372 infile = ENCODE_FILE (infile);
373 if (STRING_MULTIBYTE (current_dir))
374 current_dir = ENCODE_FILE (current_dir);
375 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
376 error_file = ENCODE_FILE (error_file);
377 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
378 output_file = ENCODE_FILE (output_file);
379 UNGCPRO;
382 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
384 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
385 if (filefd < 0)
387 infile = DECODE_FILE (infile);
388 report_file_error ("Opening process input file", Fcons (infile, Qnil));
391 if (STRINGP (output_file))
393 #ifdef DOS_NT
394 fd_output = emacs_open (SSDATA (output_file),
395 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
396 S_IREAD | S_IWRITE);
397 #else /* not DOS_NT */
398 fd_output = creat (SSDATA (output_file), 0666);
399 #endif /* not DOS_NT */
400 if (fd_output < 0)
402 output_file = DECODE_FILE (output_file);
403 report_file_error ("Opening process output file",
404 Fcons (output_file, Qnil));
406 if (STRINGP (error_file) || NILP (error_file))
407 output_to_buffer = 0;
410 /* Search for program; barf if not found. */
412 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
414 GCPRO4 (infile, buffer, current_dir, error_file);
415 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
416 UNGCPRO;
418 if (NILP (path))
420 emacs_close (filefd);
421 report_file_error ("Searching for program", Fcons (args[0], Qnil));
424 /* If program file name starts with /: for quoting a magic name,
425 discard that. */
426 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
427 && SREF (path, 1) == ':')
428 path = Fsubstring (path, make_number (2), Qnil);
430 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
431 if (nargs > 4)
433 ptrdiff_t i;
434 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
436 GCPRO5 (infile, buffer, current_dir, path, error_file);
437 argument_coding.dst_multibyte = 0;
438 for (i = 4; i < nargs; i++)
440 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
441 if (CODING_REQUIRE_ENCODING (&argument_coding))
442 /* We must encode this argument. */
443 args[i] = encode_coding_string (&argument_coding, args[i], 1);
445 UNGCPRO;
446 for (i = 4; i < nargs; i++)
447 new_argv[i - 3] = SDATA (args[i]);
448 new_argv[i - 3] = 0;
450 else
451 new_argv[1] = 0;
452 new_argv[0] = SDATA (path);
454 #ifdef MSDOS /* MW, July 1993 */
456 /* If we're redirecting STDOUT to a file, that file is already open
457 on fd_output. */
458 if (fd_output < 0)
460 if ((outf = egetenv ("TMPDIR")))
461 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
462 else
464 tempfile = alloca (20);
465 *tempfile = '\0';
467 dostounix_filename (tempfile);
468 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
469 strcat (tempfile, "/");
470 strcat (tempfile, "detmp.XXX");
471 mktemp (tempfile);
472 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
473 if (outfilefd < 0) {
474 emacs_close (filefd);
475 report_file_error ("Opening process output file",
476 Fcons (build_string (tempfile), Qnil));
479 else
480 outfilefd = fd_output;
481 fd[0] = filefd;
482 fd[1] = outfilefd;
483 #endif /* MSDOS */
485 if (INTEGERP (buffer))
486 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
487 else
489 #ifndef MSDOS
490 errno = 0;
491 if (pipe (fd) == -1)
493 emacs_close (filefd);
494 report_file_error ("Creating process pipe", Qnil);
496 #endif
500 /* child_setup must clobber environ in systems with true vfork.
501 Protect it from permanent change. */
502 register char **save_environ = environ;
503 register int fd1 = fd[1];
504 int fd_error = fd1;
505 #ifdef HAVE_WORKING_VFORK
506 sigset_t procmask;
507 sigset_t blocked;
508 struct sigaction sigpipe_action;
509 #endif
511 if (fd_output >= 0)
512 fd1 = fd_output;
513 #if 0 /* Some systems don't have sigblock. */
514 mask = sigblock (sigmask (SIGCHLD));
515 #endif
517 /* Record that we're about to create a synchronous process. */
518 synch_process_alive = 1;
520 /* These vars record information from process termination.
521 Clear them now before process can possibly terminate,
522 to avoid timing error if process terminates soon. */
523 synch_process_death = 0;
524 synch_process_retcode = 0;
525 synch_process_termsig = 0;
527 if (NILP (error_file))
528 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
529 else if (STRINGP (error_file))
531 #ifdef DOS_NT
532 fd_error = emacs_open (SSDATA (error_file),
533 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
534 S_IREAD | S_IWRITE);
535 #else /* not DOS_NT */
536 fd_error = creat (SSDATA (error_file), 0666);
537 #endif /* not DOS_NT */
540 if (fd_error < 0)
542 emacs_close (filefd);
543 if (fd[0] != filefd)
544 emacs_close (fd[0]);
545 if (fd1 >= 0)
546 emacs_close (fd1);
547 #ifdef MSDOS
548 unlink (tempfile);
549 #endif
550 if (NILP (error_file))
551 error_file = build_string (NULL_DEVICE);
552 else if (STRINGP (error_file))
553 error_file = DECODE_FILE (error_file);
554 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
557 #ifdef MSDOS /* MW, July 1993 */
558 /* Note that on MSDOS `child_setup' actually returns the child process
559 exit status, not its PID, so we assign it to `synch_process_retcode'
560 below. */
561 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
562 0, current_dir);
564 /* Record that the synchronous process exited and note its
565 termination status. */
566 synch_process_alive = 0;
567 synch_process_retcode = pid;
568 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
570 synchronize_system_messages_locale ();
571 synch_process_death = strerror (errno);
574 emacs_close (outfilefd);
575 if (fd_error != outfilefd)
576 emacs_close (fd_error);
577 fd1 = -1; /* No harm in closing that one! */
578 if (tempfile)
580 /* Since CRLF is converted to LF within `decode_coding', we
581 can always open a file with binary mode. */
582 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
583 if (fd[0] < 0)
585 unlink (tempfile);
586 emacs_close (filefd);
587 report_file_error ("Cannot re-open temporary file",
588 Fcons (build_string (tempfile), Qnil));
591 else
592 fd[0] = -1; /* We are not going to read from tempfile. */
593 #else /* not MSDOS */
594 #ifdef WINDOWSNT
595 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
596 0, current_dir);
597 #else /* not WINDOWSNT */
599 #ifdef HAVE_WORKING_VFORK
600 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
601 this sets the parent's signal handlers as well as the child's.
602 So delay all interrupts whose handlers the child might munge,
603 and record the current handlers so they can be restored later. */
604 sigemptyset (&blocked);
605 sigaddset (&blocked, SIGPIPE);
606 sigaction (SIGPIPE, 0, &sigpipe_action);
607 pthread_sigmask (SIG_BLOCK, &blocked, &procmask);
608 #endif
610 BLOCK_INPUT;
612 /* vfork, and prevent local vars from being clobbered by the vfork. */
614 Lisp_Object volatile buffer_volatile = buffer;
615 Lisp_Object volatile coding_systems_volatile = coding_systems;
616 Lisp_Object volatile current_dir_volatile = current_dir;
617 int volatile display_p_volatile = display_p;
618 int volatile fd1_volatile = fd1;
619 int volatile fd_error_volatile = fd_error;
620 int volatile fd_output_volatile = fd_output;
621 int volatile output_to_buffer_volatile = output_to_buffer;
622 int volatile sa_must_free_volatile = sa_must_free;
623 ptrdiff_t volatile sa_count_volatile = sa_count;
624 unsigned char const **volatile new_argv_volatile = new_argv;
626 pid = vfork ();
628 buffer = buffer_volatile;
629 coding_systems = coding_systems_volatile;
630 current_dir = current_dir_volatile;
631 display_p = display_p_volatile;
632 fd1 = fd1_volatile;
633 fd_error = fd_error_volatile;
634 fd_output = fd_output_volatile;
635 output_to_buffer = output_to_buffer_volatile;
636 sa_must_free = sa_must_free_volatile;
637 sa_count = sa_count_volatile;
638 new_argv = new_argv_volatile;
641 if (pid == 0)
643 if (fd[0] >= 0)
644 emacs_close (fd[0]);
645 #ifdef HAVE_SETSID
646 setsid ();
647 #endif
648 #if defined (USG)
649 setpgrp ();
650 #else
651 setpgrp (pid, pid);
652 #endif /* USG */
654 /* GConf causes us to ignore SIGPIPE, make sure it is restored
655 in the child. */
656 signal (SIGPIPE, SIG_DFL);
657 #ifdef HAVE_WORKING_VFORK
658 pthread_sigmask (SIG_SETMASK, &procmask, 0);
659 #endif
661 child_setup (filefd, fd1, fd_error, (char **) new_argv,
662 0, current_dir);
665 UNBLOCK_INPUT;
667 #ifdef HAVE_WORKING_VFORK
668 /* Restore the signal state. */
669 sigaction (SIGPIPE, &sigpipe_action, 0);
670 pthread_sigmask (SIG_SETMASK, &procmask, 0);
671 #endif
673 #endif /* not WINDOWSNT */
675 /* The MSDOS case did this already. */
676 if (fd_error >= 0)
677 emacs_close (fd_error);
678 #endif /* not MSDOS */
680 environ = save_environ;
682 /* Close most of our fd's, but not fd[0]
683 since we will use that to read input from. */
684 emacs_close (filefd);
685 if (fd_output >= 0)
686 emacs_close (fd_output);
687 if (fd1 >= 0 && fd1 != fd_error)
688 emacs_close (fd1);
691 if (pid < 0)
693 if (fd[0] >= 0)
694 emacs_close (fd[0]);
695 report_file_error ("Doing vfork", Qnil);
698 if (INTEGERP (buffer))
700 if (fd[0] >= 0)
701 emacs_close (fd[0]);
702 return Qnil;
705 /* Enable sending signal if user quits below. */
706 call_process_exited = 0;
708 #if defined (MSDOS)
709 /* MSDOS needs different cleanup information. */
710 cleanup_info_tail = build_string (tempfile ? tempfile : "");
711 #else
712 cleanup_info_tail = INTEGER_TO_CONS (pid);
713 #endif /* not MSDOS */
714 record_unwind_protect (call_process_cleanup,
715 Fcons (Fcurrent_buffer (),
716 Fcons (INTEGER_TO_CONS (fd[0]),
717 cleanup_info_tail)));
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 register int nread;
774 int first = 1;
775 EMACS_INT total_read = 0;
776 int carryover = 0;
777 int display_on_the_fly = display_p;
778 struct coding_system saved_coding;
780 saved_coding = process_coding;
781 while (1)
783 /* Repeatedly read until we've filled as much as possible
784 of the buffer size we have. But don't read
785 less than 1024--save that for the next bufferful. */
786 nread = carryover;
787 while (nread < bufsize - 1024)
789 int this_read = emacs_read (fd[0], buf + nread,
790 bufsize - nread);
792 if (this_read < 0)
793 goto give_up;
795 if (this_read == 0)
797 process_coding.mode |= CODING_MODE_LAST_BLOCK;
798 break;
801 nread += this_read;
802 total_read += this_read;
804 if (display_on_the_fly)
805 break;
808 /* Now NREAD is the total amount of data in the buffer. */
809 immediate_quit = 0;
811 if (!NILP (buffer))
813 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
814 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
815 insert_1_both (buf, nread, nread, 0, 1, 0);
816 else
817 { /* We have to decode the input. */
818 Lisp_Object curbuf;
819 ptrdiff_t count1 = SPECPDL_INDEX ();
821 XSETBUFFER (curbuf, current_buffer);
822 /* We cannot allow after-change-functions be run
823 during decoding, because that might modify the
824 buffer, while we rely on process_coding.produced to
825 faithfully reflect inserted text until we
826 TEMP_SET_PT_BOTH below. */
827 specbind (Qinhibit_modification_hooks, Qt);
828 decode_coding_c_string (&process_coding,
829 (unsigned char *) buf, nread, curbuf);
830 unbind_to (count1, Qnil);
831 if (display_on_the_fly
832 && CODING_REQUIRE_DETECTION (&saved_coding)
833 && ! CODING_REQUIRE_DETECTION (&process_coding))
835 /* We have detected some coding system. But,
836 there's a possibility that the detection was
837 done by insufficient data. So, we give up
838 displaying on the fly. */
839 if (process_coding.produced > 0)
840 del_range_2 (process_coding.dst_pos,
841 process_coding.dst_pos_byte,
842 process_coding.dst_pos
843 + process_coding.produced_char,
844 process_coding.dst_pos_byte
845 + process_coding.produced, 0);
846 display_on_the_fly = 0;
847 process_coding = saved_coding;
848 carryover = nread;
849 /* This is to make the above condition always
850 fails in the future. */
851 saved_coding.common_flags
852 &= ~CODING_REQUIRE_DETECTION_MASK;
853 continue;
856 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
857 PT_BYTE + process_coding.produced);
858 carryover = process_coding.carryover_bytes;
859 if (carryover > 0)
860 memcpy (buf, process_coding.carryover,
861 process_coding.carryover_bytes);
865 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
866 break;
868 /* Make the buffer bigger as we continue to read more data,
869 but not past CALLPROC_BUFFER_SIZE_MAX. */
870 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
871 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
872 bufsize = CALLPROC_BUFFER_SIZE_MAX;
874 if (display_p)
876 if (first)
877 prepare_menu_bars ();
878 first = 0;
879 redisplay_preserve_echo_area (1);
880 /* This variable might have been set to 0 for code
881 detection. In that case, we set it back to 1 because
882 we should have already detected a coding system. */
883 display_on_the_fly = 1;
885 immediate_quit = 1;
886 QUIT;
888 give_up: ;
890 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
891 /* If the caller required, let the buffer inherit the
892 coding-system used to decode the process output. */
893 if (inherit_process_coding_system)
894 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
895 make_number (total_read));
898 #ifndef MSDOS
899 /* Wait for it to terminate, unless it already has. */
900 if (output_to_buffer)
901 wait_for_termination (pid);
902 else
903 interruptible_wait_for_termination (pid);
904 #endif
906 immediate_quit = 0;
908 /* Don't kill any children that the subprocess may have left behind
909 when exiting. */
910 call_process_exited = 1;
912 SAFE_FREE ();
913 unbind_to (count, Qnil);
915 if (synch_process_termsig)
917 const char *signame;
919 synchronize_system_messages_locale ();
920 signame = strsignal (synch_process_termsig);
922 if (signame == 0)
923 signame = "unknown";
925 synch_process_death = signame;
928 if (synch_process_death)
929 return code_convert_string_norecord (build_string (synch_process_death),
930 Vlocale_coding_system, 0);
931 return make_number (synch_process_retcode);
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 internal_delete_file (name);
941 unbind_to (count, Qnil);
942 return Qnil;
945 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
946 3, MANY, 0,
947 doc: /* Send text from START to END to a synchronous process running PROGRAM.
948 The remaining arguments are optional.
949 Delete the text if fourth arg DELETE is non-nil.
951 Insert output in BUFFER before point; t means current buffer; nil for
952 BUFFER means discard it; 0 means discard and don't wait; and `(:file
953 FILE)', where FILE is a file name string, means that it should be
954 written to that file (if the file already exists it is overwritten).
955 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
956 REAL-BUFFER says what to do with standard output, as above,
957 while STDERR-FILE says what to do with standard error in the child.
958 STDERR-FILE may be nil (discard standard error output),
959 t (mix it with ordinary output), or a file name string.
961 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
962 Remaining args are passed to PROGRAM at startup as command args.
964 If BUFFER is 0, `call-process-region' returns immediately with value nil.
965 Otherwise it waits for PROGRAM to terminate
966 and returns a numeric exit status or a signal description string.
967 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
969 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
970 (ptrdiff_t nargs, Lisp_Object *args)
972 struct gcpro gcpro1;
973 Lisp_Object filename_string;
974 register Lisp_Object start, end;
975 ptrdiff_t count = SPECPDL_INDEX ();
976 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
977 Lisp_Object coding_systems;
978 Lisp_Object val, *args2;
979 ptrdiff_t i;
980 Lisp_Object tmpdir;
982 if (STRINGP (Vtemporary_file_directory))
983 tmpdir = Vtemporary_file_directory;
984 else
986 #ifndef DOS_NT
987 if (getenv ("TMPDIR"))
988 tmpdir = build_string (getenv ("TMPDIR"));
989 else
990 tmpdir = build_string ("/tmp/");
991 #else /* DOS_NT */
992 char *outf;
993 if ((outf = egetenv ("TMPDIR"))
994 || (outf = egetenv ("TMP"))
995 || (outf = egetenv ("TEMP")))
996 tmpdir = build_string (outf);
997 else
998 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
999 #endif
1003 USE_SAFE_ALLOCA;
1004 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
1005 char *tempfile = SAFE_ALLOCA (SBYTES (pattern) + 1);
1006 memcpy (tempfile, SDATA (pattern), SBYTES (pattern) + 1);
1007 coding_systems = Qt;
1009 #ifdef HAVE_MKSTEMP
1011 int fd;
1013 BLOCK_INPUT;
1014 fd = mkstemp (tempfile);
1015 UNBLOCK_INPUT;
1016 if (fd == -1)
1017 report_file_error ("Failed to open temporary file",
1018 Fcons (build_string (tempfile), Qnil));
1019 else
1020 close (fd);
1022 #else
1023 mktemp (tempfile);
1024 #endif
1026 filename_string = build_string (tempfile);
1027 GCPRO1 (filename_string);
1028 SAFE_FREE ();
1031 start = args[0];
1032 end = args[1];
1033 /* Decide coding-system of the contents of the temporary file. */
1034 if (!NILP (Vcoding_system_for_write))
1035 val = Vcoding_system_for_write;
1036 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1037 val = Qraw_text;
1038 else
1040 USE_SAFE_ALLOCA;
1041 SAFE_NALLOCA (args2, 1, nargs + 1);
1042 args2[0] = Qcall_process_region;
1043 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1044 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1045 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1046 SAFE_FREE ();
1048 val = complement_process_encoding_system (val);
1051 ptrdiff_t count1 = SPECPDL_INDEX ();
1053 specbind (intern ("coding-system-for-write"), val);
1054 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1055 happen to get a ".Z" suffix. */
1056 specbind (intern ("file-name-handler-alist"), Qnil);
1057 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1059 unbind_to (count1, Qnil);
1062 /* Note that Fcall_process takes care of binding
1063 coding-system-for-read. */
1065 record_unwind_protect (delete_temp_file, filename_string);
1067 if (nargs > 3 && !NILP (args[3]))
1068 Fdelete_region (start, end);
1070 if (nargs > 3)
1072 args += 2;
1073 nargs -= 2;
1075 else
1077 args[0] = args[2];
1078 nargs = 2;
1080 args[1] = filename_string;
1082 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1085 #ifndef WINDOWSNT
1086 static int relocate_fd (int fd, int minfd);
1087 #endif
1089 static char **
1090 add_env (char **env, char **new_env, char *string)
1092 char **ep;
1093 int ok = 1;
1094 if (string == NULL)
1095 return new_env;
1097 /* See if this string duplicates any string already in the env.
1098 If so, don't put it in.
1099 When an env var has multiple definitions,
1100 we keep the definition that comes first in process-environment. */
1101 for (ep = env; ok && ep != new_env; ep++)
1103 char *p = *ep, *q = string;
1104 while (ok)
1106 if (*q != *p)
1107 break;
1108 if (*q == 0)
1109 /* The string is a lone variable name; keep it for now, we
1110 will remove it later. It is a placeholder for a
1111 variable that is not to be included in the environment. */
1112 break;
1113 if (*q == '=')
1114 ok = 0;
1115 p++, q++;
1118 if (ok)
1119 *new_env++ = string;
1120 return new_env;
1123 /* This is the last thing run in a newly forked inferior
1124 either synchronous or asynchronous.
1125 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1126 Initialize inferior's priority, pgrp, connected dir and environment.
1127 then exec another program based on new_argv.
1129 This function may change environ for the superior process.
1130 Therefore, the superior process must save and restore the value
1131 of environ around the vfork and the call to this function.
1133 SET_PGRP is nonzero if we should put the subprocess into a separate
1134 process group.
1136 CURRENT_DIR is an elisp string giving the path of the current
1137 directory the subprocess should have. Since we can't really signal
1138 a decent error from within the child, this should be verified as an
1139 executable directory by the parent. */
1142 child_setup (int in, int out, int err, register char **new_argv, int set_pgrp, Lisp_Object current_dir)
1144 char **env;
1145 char *pwd_var;
1146 #ifdef WINDOWSNT
1147 int cpid;
1148 HANDLE handles[3];
1149 #endif /* WINDOWSNT */
1151 pid_t pid = getpid ();
1153 /* Close Emacs's descriptors that this process should not have. */
1154 close_process_descs ();
1156 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1157 we will lose if we call close_load_descs here. */
1158 #ifndef DOS_NT
1159 close_load_descs ();
1160 #endif
1162 /* Note that use of alloca is always safe here. It's obvious for systems
1163 that do not have true vfork or that have true (stack) alloca.
1164 If using vfork and C_ALLOCA (when Emacs used to include
1165 src/alloca.c) it is safe because that changes the superior's
1166 static variables as if the superior had done alloca and will be
1167 cleaned up in the usual way. */
1169 register char *temp;
1170 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1172 i = SBYTES (current_dir);
1173 #ifdef MSDOS
1174 /* MSDOS must have all environment variables malloc'ed, because
1175 low-level libc functions that launch subsidiary processes rely
1176 on that. */
1177 pwd_var = xmalloc (i + 6);
1178 #else
1179 pwd_var = alloca (i + 6);
1180 #endif
1181 temp = pwd_var + 4;
1182 memcpy (pwd_var, "PWD=", 4);
1183 memcpy (temp, SDATA (current_dir), i);
1184 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1185 temp[i] = 0;
1187 #ifndef DOS_NT
1188 /* We can't signal an Elisp error here; we're in a vfork. Since
1189 the callers check the current directory before forking, this
1190 should only return an error if the directory's permissions
1191 are changed between the check and this chdir, but we should
1192 at least check. */
1193 if (chdir (temp) < 0)
1194 _exit (errno);
1195 #else /* DOS_NT */
1196 /* Get past the drive letter, so that d:/ is left alone. */
1197 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1199 temp += 2;
1200 i -= 2;
1202 #endif /* DOS_NT */
1204 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1205 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1206 temp[--i] = 0;
1209 /* Set `env' to a vector of the strings in the environment. */
1211 register Lisp_Object tem;
1212 register char **new_env;
1213 char **p, **q;
1214 register int new_length;
1215 Lisp_Object display = Qnil;
1217 new_length = 0;
1219 for (tem = Vprocess_environment;
1220 CONSP (tem) && STRINGP (XCAR (tem));
1221 tem = XCDR (tem))
1223 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1224 && (SDATA (XCAR (tem)) [7] == '\0'
1225 || SDATA (XCAR (tem)) [7] == '='))
1226 /* DISPLAY is specified in process-environment. */
1227 display = Qt;
1228 new_length++;
1231 /* If not provided yet, use the frame's DISPLAY. */
1232 if (NILP (display))
1234 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1235 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1236 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1237 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1238 Vinitial_environment);
1239 if (STRINGP (tmp))
1241 display = tmp;
1242 new_length++;
1246 /* new_length + 2 to include PWD and terminating 0. */
1247 env = new_env = alloca ((new_length + 2) * sizeof *env);
1248 /* If we have a PWD envvar, pass one down,
1249 but with corrected value. */
1250 if (egetenv ("PWD"))
1251 *new_env++ = pwd_var;
1253 if (STRINGP (display))
1255 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1256 strcpy (vdata, "DISPLAY=");
1257 strcat (vdata, SSDATA (display));
1258 new_env = add_env (env, new_env, vdata);
1261 /* Overrides. */
1262 for (tem = Vprocess_environment;
1263 CONSP (tem) && STRINGP (XCAR (tem));
1264 tem = XCDR (tem))
1265 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1267 *new_env = 0;
1269 /* Remove variable names without values. */
1270 p = q = env;
1271 while (*p != 0)
1273 while (*q != 0 && strchr (*q, '=') == NULL)
1274 q++;
1275 *p = *q++;
1276 if (*p != 0)
1277 p++;
1282 #ifdef WINDOWSNT
1283 prepare_standard_handles (in, out, err, handles);
1284 set_process_dir (SDATA (current_dir));
1285 /* Spawn the child. (See ntproc.c:Spawnve). */
1286 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1287 reset_standard_handles (in, out, err, handles);
1288 if (cpid == -1)
1289 /* An error occurred while trying to spawn the process. */
1290 report_file_error ("Spawning child process", Qnil);
1291 return cpid;
1293 #else /* not WINDOWSNT */
1294 /* Make sure that in, out, and err are not actually already in
1295 descriptors zero, one, or two; this could happen if Emacs is
1296 started with its standard in, out, or error closed, as might
1297 happen under X. */
1299 int oin = in, oout = out;
1301 /* We have to avoid relocating the same descriptor twice! */
1303 in = relocate_fd (in, 3);
1305 if (out == oin)
1306 out = in;
1307 else
1308 out = relocate_fd (out, 3);
1310 if (err == oin)
1311 err = in;
1312 else if (err == oout)
1313 err = out;
1314 else
1315 err = relocate_fd (err, 3);
1318 #ifndef MSDOS
1319 emacs_close (0);
1320 emacs_close (1);
1321 emacs_close (2);
1323 dup2 (in, 0);
1324 dup2 (out, 1);
1325 dup2 (err, 2);
1326 emacs_close (in);
1327 if (out != in)
1328 emacs_close (out);
1329 if (err != in && err != out)
1330 emacs_close (err);
1332 #if defined (USG)
1333 #ifndef SETPGRP_RELEASES_CTTY
1334 setpgrp (); /* No arguments but equivalent in this case */
1335 #endif
1336 #else /* not USG */
1337 setpgrp (pid, pid);
1338 #endif /* not USG */
1340 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1341 tcsetpgrp (0, pid);
1343 /* execvp does not accept an environment arg so the only way
1344 to pass this environment is to set environ. Our caller
1345 is responsible for restoring the ambient value of environ. */
1346 environ = env;
1347 execvp (new_argv[0], new_argv);
1349 emacs_write (1, "Can't exec program: ", 20);
1350 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1351 emacs_write (1, "\n", 1);
1352 _exit (1);
1354 #else /* MSDOS */
1355 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1356 xfree (pwd_var);
1357 if (pid == -1)
1358 /* An error occurred while trying to run the subprocess. */
1359 report_file_error ("Spawning child process", Qnil);
1360 return pid;
1361 #endif /* MSDOS */
1362 #endif /* not WINDOWSNT */
1365 #ifndef WINDOWSNT
1366 /* Move the file descriptor FD so that its number is not less than MINFD.
1367 If the file descriptor is moved at all, the original is freed. */
1368 static int
1369 relocate_fd (int fd, int minfd)
1371 if (fd >= minfd)
1372 return fd;
1373 else
1375 int new;
1376 #ifdef F_DUPFD
1377 new = fcntl (fd, F_DUPFD, minfd);
1378 #else
1379 new = dup (fd);
1380 if (new != -1)
1381 /* Note that we hold the original FD open while we recurse,
1382 to guarantee we'll get a new FD if we need it. */
1383 new = relocate_fd (new, minfd);
1384 #endif
1385 if (new == -1)
1387 const char *message_1 = "Error while setting up child: ";
1388 const char *errmessage = strerror (errno);
1389 const char *message_2 = "\n";
1390 emacs_write (2, message_1, strlen (message_1));
1391 emacs_write (2, errmessage, strlen (errmessage));
1392 emacs_write (2, message_2, strlen (message_2));
1393 _exit (1);
1395 emacs_close (fd);
1396 return new;
1399 #endif /* not WINDOWSNT */
1401 static int
1402 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1403 ptrdiff_t *valuelen, Lisp_Object env)
1405 for (; CONSP (env); env = XCDR (env))
1407 Lisp_Object entry = XCAR (env);
1408 if (STRINGP (entry)
1409 && SBYTES (entry) >= varlen
1410 #ifdef WINDOWSNT
1411 /* NT environment variables are case insensitive. */
1412 && ! strnicmp (SDATA (entry), var, varlen)
1413 #else /* not WINDOWSNT */
1414 && ! memcmp (SDATA (entry), var, varlen)
1415 #endif /* not WINDOWSNT */
1418 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1420 *value = SSDATA (entry) + (varlen + 1);
1421 *valuelen = SBYTES (entry) - (varlen + 1);
1422 return 1;
1424 else if (SBYTES (entry) == varlen)
1426 /* Lone variable names in Vprocess_environment mean that
1427 variable should be removed from the environment. */
1428 *value = NULL;
1429 return 1;
1433 return 0;
1436 static int
1437 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1438 ptrdiff_t *valuelen, Lisp_Object frame)
1440 /* Try to find VAR in Vprocess_environment first. */
1441 if (getenv_internal_1 (var, varlen, value, valuelen,
1442 Vprocess_environment))
1443 return *value ? 1 : 0;
1445 /* For DISPLAY try to get the values from the frame or the initial env. */
1446 if (strcmp (var, "DISPLAY") == 0)
1448 Lisp_Object display
1449 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1450 if (STRINGP (display))
1452 *value = SSDATA (display);
1453 *valuelen = SBYTES (display);
1454 return 1;
1456 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1457 if (getenv_internal_1 (var, varlen, value, valuelen,
1458 Vinitial_environment))
1459 return *value ? 1 : 0;
1462 return 0;
1465 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1466 doc: /* Get the value of environment variable VARIABLE.
1467 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1468 the environment. Otherwise, value is a string.
1470 This function searches `process-environment' for VARIABLE.
1472 If optional parameter ENV is a list, then search this list instead of
1473 `process-environment', and return t when encountering a negative entry
1474 \(an entry for a variable with no value). */)
1475 (Lisp_Object variable, Lisp_Object env)
1477 char *value;
1478 ptrdiff_t valuelen;
1480 CHECK_STRING (variable);
1481 if (CONSP (env))
1483 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1484 &value, &valuelen, env))
1485 return value ? make_string (value, valuelen) : Qt;
1486 else
1487 return Qnil;
1489 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1490 &value, &valuelen, env))
1491 return make_string (value, valuelen);
1492 else
1493 return Qnil;
1496 /* A version of getenv that consults the Lisp environment lists,
1497 easily callable from C. */
1498 char *
1499 egetenv (const char *var)
1501 char *value;
1502 ptrdiff_t valuelen;
1504 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1505 return value;
1506 else
1507 return 0;
1511 /* This is run before init_cmdargs. */
1513 void
1514 init_callproc_1 (void)
1516 #ifdef HAVE_NS
1517 const char *etc_dir = ns_etc_directory ();
1518 const char *path_exec = ns_exec_path ();
1519 #endif
1521 Vdata_directory = decode_env_path ("EMACSDATA",
1522 #ifdef HAVE_NS
1523 etc_dir ? etc_dir :
1524 #endif
1525 PATH_DATA);
1526 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1528 Vdoc_directory = decode_env_path ("EMACSDOC",
1529 #ifdef HAVE_NS
1530 etc_dir ? etc_dir :
1531 #endif
1532 PATH_DOC);
1533 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1535 /* Check the EMACSPATH environment variable, defaulting to the
1536 PATH_EXEC path from epaths.h. */
1537 Vexec_path = decode_env_path ("EMACSPATH",
1538 #ifdef HAVE_NS
1539 path_exec ? path_exec :
1540 #endif
1541 PATH_EXEC);
1542 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1543 /* FIXME? For ns, path_exec should go at the front? */
1544 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1547 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1549 void
1550 init_callproc (void)
1552 char *data_dir = egetenv ("EMACSDATA");
1554 register char * sh;
1555 Lisp_Object tempdir;
1556 #ifdef HAVE_NS
1557 if (data_dir == 0)
1559 const char *etc_dir = ns_etc_directory ();
1560 if (etc_dir)
1562 data_dir = alloca (strlen (etc_dir) + 1);
1563 strcpy (data_dir, etc_dir);
1566 #endif
1568 if (!NILP (Vinstallation_directory))
1570 /* Add to the path the lib-src subdir of the installation dir. */
1571 Lisp_Object tem;
1572 tem = Fexpand_file_name (build_string ("lib-src"),
1573 Vinstallation_directory);
1574 #ifndef MSDOS
1575 /* MSDOS uses wrapped binaries, so don't do this. */
1576 if (NILP (Fmember (tem, Vexec_path)))
1578 #ifdef HAVE_NS
1579 const char *path_exec = ns_exec_path ();
1580 #endif
1581 Vexec_path = decode_env_path ("EMACSPATH",
1582 #ifdef HAVE_NS
1583 path_exec ? path_exec :
1584 #endif
1585 PATH_EXEC);
1586 Vexec_path = Fcons (tem, Vexec_path);
1587 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1590 Vexec_directory = Ffile_name_as_directory (tem);
1591 #endif /* not MSDOS */
1593 /* Maybe use ../etc as well as ../lib-src. */
1594 if (data_dir == 0)
1596 tem = Fexpand_file_name (build_string ("etc"),
1597 Vinstallation_directory);
1598 Vdoc_directory = Ffile_name_as_directory (tem);
1602 /* Look for the files that should be in etc. We don't use
1603 Vinstallation_directory, because these files are never installed
1604 near the executable, and they are never in the build
1605 directory when that's different from the source directory.
1607 Instead, if these files are not in the nominal place, we try the
1608 source directory. */
1609 if (data_dir == 0)
1611 Lisp_Object tem, tem1, srcdir;
1613 srcdir = Fexpand_file_name (build_string ("../src/"),
1614 build_string (PATH_DUMPLOADSEARCH));
1615 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1616 tem1 = Ffile_exists_p (tem);
1617 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1619 Lisp_Object newdir;
1620 newdir = Fexpand_file_name (build_string ("../etc/"),
1621 build_string (PATH_DUMPLOADSEARCH));
1622 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1623 tem1 = Ffile_exists_p (tem);
1624 if (!NILP (tem1))
1625 Vdata_directory = newdir;
1629 #ifndef CANNOT_DUMP
1630 if (initialized)
1631 #endif
1633 tempdir = Fdirectory_file_name (Vexec_directory);
1634 if (access (SSDATA (tempdir), 0) < 0)
1635 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1636 Vexec_directory);
1639 tempdir = Fdirectory_file_name (Vdata_directory);
1640 if (access (SSDATA (tempdir), 0) < 0)
1641 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1642 Vdata_directory);
1644 sh = (char *) getenv ("SHELL");
1645 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1647 #ifdef DOS_NT
1648 Vshared_game_score_directory = Qnil;
1649 #else
1650 Vshared_game_score_directory = build_string (PATH_GAME);
1651 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1652 Vshared_game_score_directory = Qnil;
1653 #endif
1656 void
1657 set_initial_environment (void)
1659 char **envp;
1660 for (envp = environ; *envp; envp++)
1661 Vprocess_environment = Fcons (build_string (*envp),
1662 Vprocess_environment);
1663 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1664 to use `delete' and friends on process-environment. */
1665 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1668 void
1669 syms_of_callproc (void)
1671 #ifndef DOS_NT
1672 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1673 #elif defined (WINDOWSNT)
1674 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1675 #else
1676 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1677 #endif
1678 staticpro (&Vtemp_file_name_pattern);
1680 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1681 doc: /* File name to load inferior shells from.
1682 Initialized from the SHELL environment variable, or to a system-dependent
1683 default if SHELL is not set. */);
1685 DEFVAR_LISP ("exec-path", Vexec_path,
1686 doc: /* List of directories to search programs to run in subprocesses.
1687 Each element is a string (directory name) or nil (try default directory). */);
1689 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1690 doc: /* List of suffixes to try to find executable file names.
1691 Each element is a string. */);
1692 Vexec_suffixes = Qnil;
1694 DEFVAR_LISP ("exec-directory", Vexec_directory,
1695 doc: /* Directory for executables for Emacs to invoke.
1696 More generally, this includes any architecture-dependent files
1697 that are built and installed from the Emacs distribution. */);
1699 DEFVAR_LISP ("data-directory", Vdata_directory,
1700 doc: /* Directory of machine-independent files that come with GNU Emacs.
1701 These are files intended for Emacs to use while it runs. */);
1703 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1704 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1705 This is usually the same as `data-directory'. */);
1707 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1708 doc: /* For internal use by the build procedure only.
1709 This is the name of the directory in which the build procedure installed
1710 Emacs's info files; the default value for `Info-default-directory-list'
1711 includes this. */);
1712 Vconfigure_info_directory = build_string (PATH_INFO);
1714 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1715 doc: /* Directory of score files for games which come with GNU Emacs.
1716 If this variable is nil, then Emacs is unable to use a shared directory. */);
1717 #ifdef DOS_NT
1718 Vshared_game_score_directory = Qnil;
1719 #else
1720 Vshared_game_score_directory = build_string (PATH_GAME);
1721 #endif
1723 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1724 doc: /* List of environment variables inherited from the parent process.
1725 Each element should be a string of the form ENVVARNAME=VALUE.
1726 The elements must normally be decoded (using `locale-coding-system') for use. */);
1727 Vinitial_environment = Qnil;
1729 DEFVAR_LISP ("process-environment", Vprocess_environment,
1730 doc: /* List of overridden environment variables for subprocesses to inherit.
1731 Each element should be a string of the form ENVVARNAME=VALUE.
1733 Entries in this list take precedence to those in the frame-local
1734 environments. Therefore, let-binding `process-environment' is an easy
1735 way to temporarily change the value of an environment variable,
1736 irrespective of where it comes from. To use `process-environment' to
1737 remove an environment variable, include only its name in the list,
1738 without "=VALUE".
1740 This variable is set to nil when Emacs starts.
1742 If multiple entries define the same variable, the first one always
1743 takes precedence.
1745 Non-ASCII characters are encoded according to the initial value of
1746 `locale-coding-system', i.e. the elements must normally be decoded for
1747 use.
1749 See `setenv' and `getenv'. */);
1750 Vprocess_environment = Qnil;
1752 defsubr (&Scall_process);
1753 defsubr (&Sgetenv_internal);
1754 defsubr (&Scall_process_region);