document until-condition
[emacs.git] / src / callproc.c
blob4bf1da04e1acde0eda4a916482eba8ce26a3b990
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 #ifdef HAVE_SETPGID
69 #if !defined (USG)
70 #undef setpgrp
71 #define setpgrp setpgid
72 #endif
73 #endif
75 /* Pattern used by call-process-region to make temp files. */
76 static Lisp_Object Vtemp_file_name_pattern;
78 /* True if we are about to fork off a synchronous process or if we
79 are waiting for it. */
80 int synch_process_alive;
82 /* Nonzero => this is a string explaining death of synchronous subprocess. */
83 const char *synch_process_death;
85 /* Nonzero => this is the signal number that terminated the subprocess. */
86 int synch_process_termsig;
88 /* If synch_process_death is zero,
89 this is exit code of synchronous subprocess. */
90 int synch_process_retcode;
93 /* Clean up when exiting Fcall_process.
94 On MSDOS, delete the temporary file on any kind of termination.
95 On Unix, kill the process and any children on termination by signal. */
97 /* Nonzero if this is termination due to exit. */
98 static int call_process_exited;
100 static Lisp_Object
101 call_process_kill (Lisp_Object fdpid)
103 int fd;
104 pid_t pid;
105 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
106 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
107 emacs_close (fd);
108 EMACS_KILLPG (pid, SIGKILL);
109 synch_process_alive = 0;
110 return Qnil;
113 static Lisp_Object
114 call_process_cleanup (Lisp_Object arg)
116 Lisp_Object fdpid = Fcdr (arg);
117 int fd;
118 #if defined (MSDOS)
119 Lisp_Object file;
120 #else
121 pid_t pid;
122 #endif
124 Fset_buffer (Fcar (arg));
125 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
127 #if defined (MSDOS)
128 /* for MSDOS fdpid is really (fd . tempfile) */
129 file = Fcdr (fdpid);
130 /* FD is -1 and FILE is "" when we didn't actually create a
131 temporary file in call-process. */
132 if (fd >= 0)
133 emacs_close (fd);
134 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
135 unlink (SDATA (file));
136 #else /* not MSDOS */
137 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
139 if (call_process_exited)
141 emacs_close (fd);
142 return Qnil;
145 if (EMACS_KILLPG (pid, SIGINT) == 0)
147 ptrdiff_t count = SPECPDL_INDEX ();
148 record_unwind_protect (call_process_kill, fdpid);
149 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
150 immediate_quit = 1;
151 QUIT;
152 wait_for_termination (pid);
153 immediate_quit = 0;
154 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
155 message1 ("Waiting for process to die...done");
157 synch_process_alive = 0;
158 emacs_close (fd);
159 #endif /* not MSDOS */
160 return Qnil;
163 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
164 doc: /* Call PROGRAM synchronously in separate process.
165 The remaining arguments are optional.
166 The program's input comes from file INFILE (nil means `/dev/null').
167 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
168 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
169 FILE is a file name string, means that it should be written to that file
170 \(if the file already exists it is overwritten).
171 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
172 REAL-BUFFER says what to do with standard output, as above,
173 while STDERR-FILE says what to do with standard error in the child.
174 STDERR-FILE may be nil (discard standard error output),
175 t (mix it with ordinary output), or a file name string.
177 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
178 Remaining arguments are strings passed as command arguments to PROGRAM.
180 If executable PROGRAM can't be found as an executable, `call-process'
181 signals a Lisp error. `call-process' reports errors in execution of
182 the program only through its return and output.
184 If BUFFER is 0, `call-process' returns immediately with value nil.
185 Otherwise it waits for PROGRAM to terminate
186 and returns a numeric exit status or a signal description string.
187 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
189 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
190 (ptrdiff_t nargs, Lisp_Object *args)
192 Lisp_Object infile, buffer, current_dir, path, cleanup_info_tail;
193 int display_p;
194 int fd[2];
195 int filefd;
196 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
197 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
198 char buf[CALLPROC_BUFFER_SIZE_MAX];
199 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
200 ptrdiff_t count = SPECPDL_INDEX ();
201 USE_SAFE_ALLOCA;
203 register const unsigned char **new_argv;
204 /* File to use for stderr in the child.
205 t means use same as standard output. */
206 Lisp_Object error_file;
207 Lisp_Object output_file = Qnil;
208 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
209 char *outf, *tempfile = NULL;
210 int outfilefd;
211 int pid;
212 #else
213 pid_t pid;
214 #endif
215 int fd_output = -1;
216 struct coding_system process_coding; /* coding-system of process output */
217 struct coding_system argument_coding; /* coding-system of arguments */
218 /* Set to the return value of Ffind_operation_coding_system. */
219 Lisp_Object coding_systems;
220 int output_to_buffer = 1;
222 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
223 coding_systems = Qt;
225 CHECK_STRING (args[0]);
227 error_file = Qt;
229 #ifndef subprocesses
230 /* Without asynchronous processes we cannot have BUFFER == 0. */
231 if (nargs >= 3
232 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
233 error ("Operating system cannot handle asynchronous subprocesses");
234 #endif /* subprocesses */
236 /* Decide the coding-system for giving arguments. */
238 Lisp_Object val, *args2;
239 ptrdiff_t i;
241 /* If arguments are supplied, we may have to encode them. */
242 if (nargs >= 5)
244 int must_encode = 0;
245 Lisp_Object coding_attrs;
247 for (i = 4; i < nargs; i++)
248 CHECK_STRING (args[i]);
250 for (i = 4; i < nargs; i++)
251 if (STRING_MULTIBYTE (args[i]))
252 must_encode = 1;
254 if (!NILP (Vcoding_system_for_write))
255 val = Vcoding_system_for_write;
256 else if (! must_encode)
257 val = Qraw_text;
258 else
260 SAFE_NALLOCA (args2, 1, nargs + 1);
261 args2[0] = Qcall_process;
262 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
263 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
264 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
266 val = complement_process_encoding_system (val);
267 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
268 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
269 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
271 /* We should not use an ASCII incompatible coding system. */
272 val = raw_text_coding_system (val);
273 setup_coding_system (val, &argument_coding);
278 if (nargs >= 2 && ! NILP (args[1]))
280 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
281 CHECK_STRING (infile);
283 else
284 infile = build_string (NULL_DEVICE);
286 if (nargs >= 3)
288 buffer = args[2];
290 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
291 FILE-FOR-STDERR), unless the first element is :file, in which case see
292 the next paragraph. */
293 if (CONSP (buffer)
294 && (! SYMBOLP (XCAR (buffer))
295 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
297 if (CONSP (XCDR (buffer)))
299 Lisp_Object stderr_file;
300 stderr_file = XCAR (XCDR (buffer));
302 if (NILP (stderr_file) || EQ (Qt, stderr_file))
303 error_file = stderr_file;
304 else
305 error_file = Fexpand_file_name (stderr_file, Qnil);
308 buffer = XCAR (buffer);
311 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
312 if (CONSP (buffer)
313 && SYMBOLP (XCAR (buffer))
314 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
316 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
317 BVAR (current_buffer, directory));
318 CHECK_STRING (output_file);
319 buffer = Qnil;
322 if (!(EQ (buffer, Qnil)
323 || EQ (buffer, Qt)
324 || INTEGERP (buffer)))
326 Lisp_Object spec_buffer;
327 spec_buffer = buffer;
328 buffer = Fget_buffer_create (buffer);
329 /* Mention the buffer name for a better error message. */
330 if (NILP (buffer))
331 CHECK_BUFFER (spec_buffer);
332 CHECK_BUFFER (buffer);
335 else
336 buffer = Qnil;
338 /* Make sure that the child will be able to chdir to the current
339 buffer's current directory, or its unhandled equivalent. We
340 can't just have the child check for an error when it does the
341 chdir, since it's in a vfork.
343 We have to GCPRO around this because Fexpand_file_name,
344 Funhandled_file_name_directory, and Ffile_accessible_directory_p
345 might call a file name handling function. The argument list is
346 protected by the caller, so all we really have to worry about is
347 buffer. */
349 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
351 current_dir = BVAR (current_buffer, directory);
353 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
355 current_dir = Funhandled_file_name_directory (current_dir);
356 if (NILP (current_dir))
357 /* If the file name handler says that current_dir is unreachable, use
358 a sensible default. */
359 current_dir = build_string ("~/");
360 current_dir = expand_and_dir_to_file (current_dir, Qnil);
361 current_dir = Ffile_name_as_directory (current_dir);
363 if (NILP (Ffile_accessible_directory_p (current_dir)))
364 report_file_error ("Setting current directory",
365 Fcons (BVAR (current_buffer, directory), Qnil));
367 if (STRING_MULTIBYTE (infile))
368 infile = ENCODE_FILE (infile);
369 if (STRING_MULTIBYTE (current_dir))
370 current_dir = ENCODE_FILE (current_dir);
371 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
372 error_file = ENCODE_FILE (error_file);
373 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
374 output_file = ENCODE_FILE (output_file);
375 UNGCPRO;
378 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
380 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
381 if (filefd < 0)
383 infile = DECODE_FILE (infile);
384 report_file_error ("Opening process input file", Fcons (infile, Qnil));
387 if (STRINGP (output_file))
389 #ifdef DOS_NT
390 fd_output = emacs_open (SSDATA (output_file),
391 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
392 S_IREAD | S_IWRITE);
393 #else /* not DOS_NT */
394 fd_output = creat (SSDATA (output_file), 0666);
395 #endif /* not DOS_NT */
396 if (fd_output < 0)
398 output_file = DECODE_FILE (output_file);
399 report_file_error ("Opening process output file",
400 Fcons (output_file, Qnil));
402 if (STRINGP (error_file) || NILP (error_file))
403 output_to_buffer = 0;
406 /* Search for program; barf if not found. */
408 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
410 GCPRO4 (infile, buffer, current_dir, error_file);
411 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
412 UNGCPRO;
414 if (NILP (path))
416 emacs_close (filefd);
417 report_file_error ("Searching for program", Fcons (args[0], Qnil));
420 /* If program file name starts with /: for quoting a magic name,
421 discard that. */
422 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
423 && SREF (path, 1) == ':')
424 path = Fsubstring (path, make_number (2), Qnil);
426 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
427 if (nargs > 4)
429 ptrdiff_t i;
430 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
432 GCPRO5 (infile, buffer, current_dir, path, error_file);
433 argument_coding.dst_multibyte = 0;
434 for (i = 4; i < nargs; i++)
436 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
437 if (CODING_REQUIRE_ENCODING (&argument_coding))
438 /* We must encode this argument. */
439 args[i] = encode_coding_string (&argument_coding, args[i], 1);
441 UNGCPRO;
442 for (i = 4; i < nargs; i++)
443 new_argv[i - 3] = SDATA (args[i]);
444 new_argv[i - 3] = 0;
446 else
447 new_argv[1] = 0;
448 new_argv[0] = SDATA (path);
450 #ifdef MSDOS /* MW, July 1993 */
452 /* If we're redirecting STDOUT to a file, that file is already open
453 on fd_output. */
454 if (fd_output < 0)
456 if ((outf = egetenv ("TMPDIR")))
457 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
458 else
460 tempfile = alloca (20);
461 *tempfile = '\0';
463 dostounix_filename (tempfile);
464 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
465 strcat (tempfile, "/");
466 strcat (tempfile, "detmp.XXX");
467 mktemp (tempfile);
468 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
469 if (outfilefd < 0) {
470 emacs_close (filefd);
471 report_file_error ("Opening process output file",
472 Fcons (build_string (tempfile), Qnil));
475 else
476 outfilefd = fd_output;
477 fd[0] = filefd;
478 fd[1] = outfilefd;
479 #endif /* MSDOS */
481 if (INTEGERP (buffer))
482 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
483 else
485 #ifndef MSDOS
486 errno = 0;
487 if (pipe (fd) == -1)
489 emacs_close (filefd);
490 report_file_error ("Creating process pipe", Qnil);
492 #endif
496 /* child_setup must clobber environ in systems with true vfork.
497 Protect it from permanent change. */
498 register char **save_environ = environ;
499 register int fd1 = fd[1];
500 int fd_error = fd1;
501 #ifdef HAVE_WORKING_VFORK
502 sigset_t procmask;
503 sigset_t blocked;
504 struct sigaction sigpipe_action;
505 #endif
507 if (fd_output >= 0)
508 fd1 = fd_output;
509 #if 0 /* Some systems don't have sigblock. */
510 mask = sigblock (sigmask (SIGCHLD));
511 #endif
513 /* Record that we're about to create a synchronous process. */
514 synch_process_alive = 1;
516 /* These vars record information from process termination.
517 Clear them now before process can possibly terminate,
518 to avoid timing error if process terminates soon. */
519 synch_process_death = 0;
520 synch_process_retcode = 0;
521 synch_process_termsig = 0;
523 if (NILP (error_file))
524 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
525 else if (STRINGP (error_file))
527 #ifdef DOS_NT
528 fd_error = emacs_open (SSDATA (error_file),
529 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
530 S_IREAD | S_IWRITE);
531 #else /* not DOS_NT */
532 fd_error = creat (SSDATA (error_file), 0666);
533 #endif /* not DOS_NT */
536 if (fd_error < 0)
538 emacs_close (filefd);
539 if (fd[0] != filefd)
540 emacs_close (fd[0]);
541 if (fd1 >= 0)
542 emacs_close (fd1);
543 #ifdef MSDOS
544 unlink (tempfile);
545 #endif
546 if (NILP (error_file))
547 error_file = build_string (NULL_DEVICE);
548 else if (STRINGP (error_file))
549 error_file = DECODE_FILE (error_file);
550 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
553 #ifdef MSDOS /* MW, July 1993 */
554 /* Note that on MSDOS `child_setup' actually returns the child process
555 exit status, not its PID, so we assign it to `synch_process_retcode'
556 below. */
557 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
558 0, current_dir);
560 /* Record that the synchronous process exited and note its
561 termination status. */
562 synch_process_alive = 0;
563 synch_process_retcode = pid;
564 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
566 synchronize_system_messages_locale ();
567 synch_process_death = strerror (errno);
570 emacs_close (outfilefd);
571 if (fd_error != outfilefd)
572 emacs_close (fd_error);
573 fd1 = -1; /* No harm in closing that one! */
574 if (tempfile)
576 /* Since CRLF is converted to LF within `decode_coding', we
577 can always open a file with binary mode. */
578 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
579 if (fd[0] < 0)
581 unlink (tempfile);
582 emacs_close (filefd);
583 report_file_error ("Cannot re-open temporary file",
584 Fcons (build_string (tempfile), Qnil));
587 else
588 fd[0] = -1; /* We are not going to read from tempfile. */
589 #else /* not MSDOS */
590 #ifdef WINDOWSNT
591 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
592 0, current_dir);
593 #else /* not WINDOWSNT */
595 #ifdef HAVE_WORKING_VFORK
596 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
597 this sets the parent's signal handlers as well as the child's.
598 So delay all interrupts whose handlers the child might munge,
599 and record the current handlers so they can be restored later. */
600 sigemptyset (&blocked);
601 sigaddset (&blocked, SIGPIPE);
602 sigaction (SIGPIPE, 0, &sigpipe_action);
603 pthread_sigmask (SIG_BLOCK, &blocked, &procmask);
604 #endif
606 BLOCK_INPUT;
608 /* vfork, and prevent local vars from being clobbered by the vfork. */
610 Lisp_Object volatile buffer_volatile = buffer;
611 Lisp_Object volatile coding_systems_volatile = coding_systems;
612 Lisp_Object volatile current_dir_volatile = current_dir;
613 int volatile display_p_volatile = display_p;
614 int volatile fd1_volatile = fd1;
615 int volatile fd_error_volatile = fd_error;
616 int volatile fd_output_volatile = fd_output;
617 int volatile output_to_buffer_volatile = output_to_buffer;
618 int volatile sa_must_free_volatile = sa_must_free;
619 ptrdiff_t volatile sa_count_volatile = sa_count;
620 unsigned char const **volatile new_argv_volatile = new_argv;
622 pid = vfork ();
624 buffer = buffer_volatile;
625 coding_systems = coding_systems_volatile;
626 current_dir = current_dir_volatile;
627 display_p = display_p_volatile;
628 fd1 = fd1_volatile;
629 fd_error = fd_error_volatile;
630 fd_output = fd_output_volatile;
631 output_to_buffer = output_to_buffer_volatile;
632 sa_must_free = sa_must_free_volatile;
633 sa_count = sa_count_volatile;
634 new_argv = new_argv_volatile;
637 if (pid == 0)
639 if (fd[0] >= 0)
640 emacs_close (fd[0]);
641 #ifdef HAVE_SETSID
642 setsid ();
643 #endif
644 #if defined (USG)
645 setpgrp ();
646 #else
647 setpgrp (pid, pid);
648 #endif /* USG */
650 /* GConf causes us to ignore SIGPIPE, make sure it is restored
651 in the child. */
652 signal (SIGPIPE, SIG_DFL);
653 #ifdef HAVE_WORKING_VFORK
654 pthread_sigmask (SIG_SETMASK, &procmask, 0);
655 #endif
657 child_setup (filefd, fd1, fd_error, (char **) new_argv,
658 0, current_dir);
661 UNBLOCK_INPUT;
663 #ifdef HAVE_WORKING_VFORK
664 /* Restore the signal state. */
665 sigaction (SIGPIPE, &sigpipe_action, 0);
666 pthread_sigmask (SIG_SETMASK, &procmask, 0);
667 #endif
669 #endif /* not WINDOWSNT */
671 /* The MSDOS case did this already. */
672 if (fd_error >= 0)
673 emacs_close (fd_error);
674 #endif /* not MSDOS */
676 environ = save_environ;
678 /* Close most of our fd's, but not fd[0]
679 since we will use that to read input from. */
680 emacs_close (filefd);
681 if (fd_output >= 0)
682 emacs_close (fd_output);
683 if (fd1 >= 0 && fd1 != fd_error)
684 emacs_close (fd1);
687 if (pid < 0)
689 if (fd[0] >= 0)
690 emacs_close (fd[0]);
691 report_file_error ("Doing vfork", Qnil);
694 if (INTEGERP (buffer))
696 if (fd[0] >= 0)
697 emacs_close (fd[0]);
698 return Qnil;
701 /* Enable sending signal if user quits below. */
702 call_process_exited = 0;
704 #if defined (MSDOS)
705 /* MSDOS needs different cleanup information. */
706 cleanup_info_tail = build_string (tempfile ? tempfile : "");
707 #else
708 cleanup_info_tail = INTEGER_TO_CONS (pid);
709 #endif /* not MSDOS */
710 record_unwind_protect (call_process_cleanup,
711 Fcons (Fcurrent_buffer (),
712 Fcons (INTEGER_TO_CONS (fd[0]),
713 cleanup_info_tail)));
715 if (BUFFERP (buffer))
716 Fset_buffer (buffer);
718 if (NILP (buffer))
720 /* If BUFFER is nil, we must read process output once and then
721 discard it, so setup coding system but with nil. */
722 setup_coding_system (Qnil, &process_coding);
723 process_coding.dst_multibyte = 0;
725 else
727 Lisp_Object val, *args2;
729 val = Qnil;
730 if (!NILP (Vcoding_system_for_read))
731 val = Vcoding_system_for_read;
732 else
734 if (EQ (coding_systems, Qt))
736 ptrdiff_t i;
738 SAFE_NALLOCA (args2, 1, nargs + 1);
739 args2[0] = Qcall_process;
740 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
741 coding_systems
742 = Ffind_operation_coding_system (nargs + 1, args2);
744 if (CONSP (coding_systems))
745 val = XCAR (coding_systems);
746 else if (CONSP (Vdefault_process_coding_system))
747 val = XCAR (Vdefault_process_coding_system);
748 else
749 val = Qnil;
751 Fcheck_coding_system (val);
752 /* In unibyte mode, character code conversion should not take
753 place but EOL conversion should. So, setup raw-text or one
754 of the subsidiary according to the information just setup. */
755 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
756 && !NILP (val))
757 val = raw_text_coding_system (val);
758 setup_coding_system (val, &process_coding);
759 process_coding.dst_multibyte
760 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
762 process_coding.src_multibyte = 0;
764 immediate_quit = 1;
765 QUIT;
767 if (output_to_buffer)
769 register int nread;
770 int first = 1;
771 EMACS_INT total_read = 0;
772 int carryover = 0;
773 int display_on_the_fly = display_p;
774 struct coding_system saved_coding;
776 saved_coding = process_coding;
777 while (1)
779 /* Repeatedly read until we've filled as much as possible
780 of the buffer size we have. But don't read
781 less than 1024--save that for the next bufferful. */
782 nread = carryover;
783 while (nread < bufsize - 1024)
785 int this_read = emacs_read (fd[0], buf + nread,
786 bufsize - nread);
788 if (this_read < 0)
789 goto give_up;
791 if (this_read == 0)
793 process_coding.mode |= CODING_MODE_LAST_BLOCK;
794 break;
797 nread += this_read;
798 total_read += this_read;
800 if (display_on_the_fly)
801 break;
804 /* Now NREAD is the total amount of data in the buffer. */
805 immediate_quit = 0;
807 if (!NILP (buffer))
809 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
810 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
811 insert_1_both (buf, nread, nread, 0, 1, 0);
812 else
813 { /* We have to decode the input. */
814 Lisp_Object curbuf;
815 ptrdiff_t count1 = SPECPDL_INDEX ();
817 XSETBUFFER (curbuf, current_buffer);
818 /* We cannot allow after-change-functions be run
819 during decoding, because that might modify the
820 buffer, while we rely on process_coding.produced to
821 faithfully reflect inserted text until we
822 TEMP_SET_PT_BOTH below. */
823 specbind (Qinhibit_modification_hooks, Qt);
824 decode_coding_c_string (&process_coding,
825 (unsigned char *) buf, nread, curbuf);
826 unbind_to (count1, Qnil);
827 if (display_on_the_fly
828 && CODING_REQUIRE_DETECTION (&saved_coding)
829 && ! CODING_REQUIRE_DETECTION (&process_coding))
831 /* We have detected some coding system. But,
832 there's a possibility that the detection was
833 done by insufficient data. So, we give up
834 displaying on the fly. */
835 if (process_coding.produced > 0)
836 del_range_2 (process_coding.dst_pos,
837 process_coding.dst_pos_byte,
838 process_coding.dst_pos
839 + process_coding.produced_char,
840 process_coding.dst_pos_byte
841 + process_coding.produced, 0);
842 display_on_the_fly = 0;
843 process_coding = saved_coding;
844 carryover = nread;
845 /* This is to make the above condition always
846 fails in the future. */
847 saved_coding.common_flags
848 &= ~CODING_REQUIRE_DETECTION_MASK;
849 continue;
852 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
853 PT_BYTE + process_coding.produced);
854 carryover = process_coding.carryover_bytes;
855 if (carryover > 0)
856 memcpy (buf, process_coding.carryover,
857 process_coding.carryover_bytes);
861 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
862 break;
864 /* Make the buffer bigger as we continue to read more data,
865 but not past CALLPROC_BUFFER_SIZE_MAX. */
866 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
867 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
868 bufsize = CALLPROC_BUFFER_SIZE_MAX;
870 if (display_p)
872 if (first)
873 prepare_menu_bars ();
874 first = 0;
875 redisplay_preserve_echo_area (1);
876 /* This variable might have been set to 0 for code
877 detection. In that case, we set it back to 1 because
878 we should have already detected a coding system. */
879 display_on_the_fly = 1;
881 immediate_quit = 1;
882 QUIT;
884 give_up: ;
886 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
887 /* If the caller required, let the buffer inherit the
888 coding-system used to decode the process output. */
889 if (inherit_process_coding_system)
890 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
891 make_number (total_read));
894 #ifndef MSDOS
895 /* Wait for it to terminate, unless it already has. */
896 if (output_to_buffer)
897 wait_for_termination (pid);
898 else
899 interruptible_wait_for_termination (pid);
900 #endif
902 immediate_quit = 0;
904 /* Don't kill any children that the subprocess may have left behind
905 when exiting. */
906 call_process_exited = 1;
908 SAFE_FREE ();
909 unbind_to (count, Qnil);
911 if (synch_process_termsig)
913 const char *signame;
915 synchronize_system_messages_locale ();
916 signame = strsignal (synch_process_termsig);
918 if (signame == 0)
919 signame = "unknown";
921 synch_process_death = signame;
924 if (synch_process_death)
925 return code_convert_string_norecord (build_string (synch_process_death),
926 Vlocale_coding_system, 0);
927 return make_number (synch_process_retcode);
930 static Lisp_Object
931 delete_temp_file (Lisp_Object name)
933 /* Suppress jka-compr handling, etc. */
934 ptrdiff_t count = SPECPDL_INDEX ();
935 specbind (intern ("file-name-handler-alist"), Qnil);
936 internal_delete_file (name);
937 unbind_to (count, Qnil);
938 return Qnil;
941 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
942 3, MANY, 0,
943 doc: /* Send text from START to END to a synchronous process running PROGRAM.
944 The remaining arguments are optional.
945 Delete the text if fourth arg DELETE is non-nil.
947 Insert output in BUFFER before point; t means current buffer; nil for
948 BUFFER means discard it; 0 means discard and don't wait; and `(:file
949 FILE)', where FILE is a file name string, means that it should be
950 written to that file (if the file already exists it is overwritten).
951 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
952 REAL-BUFFER says what to do with standard output, as above,
953 while STDERR-FILE says what to do with standard error in the child.
954 STDERR-FILE may be nil (discard standard error output),
955 t (mix it with ordinary output), or a file name string.
957 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
958 Remaining args are passed to PROGRAM at startup as command args.
960 If BUFFER is 0, `call-process-region' returns immediately with value nil.
961 Otherwise it waits for PROGRAM to terminate
962 and returns a numeric exit status or a signal description string.
963 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
965 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
966 (ptrdiff_t nargs, Lisp_Object *args)
968 struct gcpro gcpro1;
969 Lisp_Object filename_string;
970 register Lisp_Object start, end;
971 ptrdiff_t count = SPECPDL_INDEX ();
972 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
973 Lisp_Object coding_systems;
974 Lisp_Object val, *args2;
975 ptrdiff_t i;
976 Lisp_Object tmpdir;
978 if (STRINGP (Vtemporary_file_directory))
979 tmpdir = Vtemporary_file_directory;
980 else
982 #ifndef DOS_NT
983 if (getenv ("TMPDIR"))
984 tmpdir = build_string (getenv ("TMPDIR"));
985 else
986 tmpdir = build_string ("/tmp/");
987 #else /* DOS_NT */
988 char *outf;
989 if ((outf = egetenv ("TMPDIR"))
990 || (outf = egetenv ("TMP"))
991 || (outf = egetenv ("TEMP")))
992 tmpdir = build_string (outf);
993 else
994 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
995 #endif
999 USE_SAFE_ALLOCA;
1000 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
1001 char *tempfile = SAFE_ALLOCA (SBYTES (pattern) + 1);
1002 memcpy (tempfile, SDATA (pattern), SBYTES (pattern) + 1);
1003 coding_systems = Qt;
1005 #ifdef HAVE_MKSTEMP
1007 int fd;
1009 BLOCK_INPUT;
1010 fd = mkstemp (tempfile);
1011 UNBLOCK_INPUT;
1012 if (fd == -1)
1013 report_file_error ("Failed to open temporary file",
1014 Fcons (build_string (tempfile), Qnil));
1015 else
1016 close (fd);
1018 #else
1019 mktemp (tempfile);
1020 #endif
1022 filename_string = build_string (tempfile);
1023 GCPRO1 (filename_string);
1024 SAFE_FREE ();
1027 start = args[0];
1028 end = args[1];
1029 /* Decide coding-system of the contents of the temporary file. */
1030 if (!NILP (Vcoding_system_for_write))
1031 val = Vcoding_system_for_write;
1032 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1033 val = Qraw_text;
1034 else
1036 USE_SAFE_ALLOCA;
1037 SAFE_NALLOCA (args2, 1, nargs + 1);
1038 args2[0] = Qcall_process_region;
1039 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1040 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1041 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1042 SAFE_FREE ();
1044 val = complement_process_encoding_system (val);
1047 ptrdiff_t count1 = SPECPDL_INDEX ();
1049 specbind (intern ("coding-system-for-write"), val);
1050 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1051 happen to get a ".Z" suffix. */
1052 specbind (intern ("file-name-handler-alist"), Qnil);
1053 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1055 unbind_to (count1, Qnil);
1058 /* Note that Fcall_process takes care of binding
1059 coding-system-for-read. */
1061 record_unwind_protect (delete_temp_file, filename_string);
1063 if (nargs > 3 && !NILP (args[3]))
1064 Fdelete_region (start, end);
1066 if (nargs > 3)
1068 args += 2;
1069 nargs -= 2;
1071 else
1073 args[0] = args[2];
1074 nargs = 2;
1076 args[1] = filename_string;
1078 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1081 #ifndef WINDOWSNT
1082 static int relocate_fd (int fd, int minfd);
1083 #endif
1085 static char **
1086 add_env (char **env, char **new_env, char *string)
1088 char **ep;
1089 int ok = 1;
1090 if (string == NULL)
1091 return new_env;
1093 /* See if this string duplicates any string already in the env.
1094 If so, don't put it in.
1095 When an env var has multiple definitions,
1096 we keep the definition that comes first in process-environment. */
1097 for (ep = env; ok && ep != new_env; ep++)
1099 char *p = *ep, *q = string;
1100 while (ok)
1102 if (*q != *p)
1103 break;
1104 if (*q == 0)
1105 /* The string is a lone variable name; keep it for now, we
1106 will remove it later. It is a placeholder for a
1107 variable that is not to be included in the environment. */
1108 break;
1109 if (*q == '=')
1110 ok = 0;
1111 p++, q++;
1114 if (ok)
1115 *new_env++ = string;
1116 return new_env;
1119 /* This is the last thing run in a newly forked inferior
1120 either synchronous or asynchronous.
1121 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1122 Initialize inferior's priority, pgrp, connected dir and environment.
1123 then exec another program based on new_argv.
1125 This function may change environ for the superior process.
1126 Therefore, the superior process must save and restore the value
1127 of environ around the vfork and the call to this function.
1129 SET_PGRP is nonzero if we should put the subprocess into a separate
1130 process group.
1132 CURRENT_DIR is an elisp string giving the path of the current
1133 directory the subprocess should have. Since we can't really signal
1134 a decent error from within the child, this should be verified as an
1135 executable directory by the parent. */
1138 child_setup (int in, int out, int err, register char **new_argv, int set_pgrp, Lisp_Object current_dir)
1140 char **env;
1141 char *pwd_var;
1142 #ifdef WINDOWSNT
1143 int cpid;
1144 HANDLE handles[3];
1145 #endif /* WINDOWSNT */
1147 pid_t pid = getpid ();
1149 /* Close Emacs's descriptors that this process should not have. */
1150 close_process_descs ();
1152 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1153 we will lose if we call close_load_descs here. */
1154 #ifndef DOS_NT
1155 close_load_descs ();
1156 #endif
1158 /* Note that use of alloca is always safe here. It's obvious for systems
1159 that do not have true vfork or that have true (stack) alloca.
1160 If using vfork and C_ALLOCA (when Emacs used to include
1161 src/alloca.c) it is safe because that changes the superior's
1162 static variables as if the superior had done alloca and will be
1163 cleaned up in the usual way. */
1165 register char *temp;
1166 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1168 i = SBYTES (current_dir);
1169 #ifdef MSDOS
1170 /* MSDOS must have all environment variables malloc'ed, because
1171 low-level libc functions that launch subsidiary processes rely
1172 on that. */
1173 pwd_var = xmalloc (i + 6);
1174 #else
1175 pwd_var = alloca (i + 6);
1176 #endif
1177 temp = pwd_var + 4;
1178 memcpy (pwd_var, "PWD=", 4);
1179 memcpy (temp, SDATA (current_dir), i);
1180 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1181 temp[i] = 0;
1183 #ifndef DOS_NT
1184 /* We can't signal an Elisp error here; we're in a vfork. Since
1185 the callers check the current directory before forking, this
1186 should only return an error if the directory's permissions
1187 are changed between the check and this chdir, but we should
1188 at least check. */
1189 if (chdir (temp) < 0)
1190 _exit (errno);
1191 #else /* DOS_NT */
1192 /* Get past the drive letter, so that d:/ is left alone. */
1193 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1195 temp += 2;
1196 i -= 2;
1198 #endif /* DOS_NT */
1200 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1201 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1202 temp[--i] = 0;
1205 /* Set `env' to a vector of the strings in the environment. */
1207 register Lisp_Object tem;
1208 register char **new_env;
1209 char **p, **q;
1210 register int new_length;
1211 Lisp_Object display = Qnil;
1213 new_length = 0;
1215 for (tem = Vprocess_environment;
1216 CONSP (tem) && STRINGP (XCAR (tem));
1217 tem = XCDR (tem))
1219 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1220 && (SDATA (XCAR (tem)) [7] == '\0'
1221 || SDATA (XCAR (tem)) [7] == '='))
1222 /* DISPLAY is specified in process-environment. */
1223 display = Qt;
1224 new_length++;
1227 /* If not provided yet, use the frame's DISPLAY. */
1228 if (NILP (display))
1230 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1231 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1232 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1233 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1234 Vinitial_environment);
1235 if (STRINGP (tmp))
1237 display = tmp;
1238 new_length++;
1242 /* new_length + 2 to include PWD and terminating 0. */
1243 env = new_env = alloca ((new_length + 2) * sizeof *env);
1244 /* If we have a PWD envvar, pass one down,
1245 but with corrected value. */
1246 if (egetenv ("PWD"))
1247 *new_env++ = pwd_var;
1249 if (STRINGP (display))
1251 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1252 strcpy (vdata, "DISPLAY=");
1253 strcat (vdata, SSDATA (display));
1254 new_env = add_env (env, new_env, vdata);
1257 /* Overrides. */
1258 for (tem = Vprocess_environment;
1259 CONSP (tem) && STRINGP (XCAR (tem));
1260 tem = XCDR (tem))
1261 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1263 *new_env = 0;
1265 /* Remove variable names without values. */
1266 p = q = env;
1267 while (*p != 0)
1269 while (*q != 0 && strchr (*q, '=') == NULL)
1270 q++;
1271 *p = *q++;
1272 if (*p != 0)
1273 p++;
1278 #ifdef WINDOWSNT
1279 prepare_standard_handles (in, out, err, handles);
1280 set_process_dir (SDATA (current_dir));
1281 /* Spawn the child. (See ntproc.c:Spawnve). */
1282 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1283 reset_standard_handles (in, out, err, handles);
1284 if (cpid == -1)
1285 /* An error occurred while trying to spawn the process. */
1286 report_file_error ("Spawning child process", Qnil);
1287 return cpid;
1289 #else /* not WINDOWSNT */
1290 /* Make sure that in, out, and err are not actually already in
1291 descriptors zero, one, or two; this could happen if Emacs is
1292 started with its standard in, out, or error closed, as might
1293 happen under X. */
1295 int oin = in, oout = out;
1297 /* We have to avoid relocating the same descriptor twice! */
1299 in = relocate_fd (in, 3);
1301 if (out == oin)
1302 out = in;
1303 else
1304 out = relocate_fd (out, 3);
1306 if (err == oin)
1307 err = in;
1308 else if (err == oout)
1309 err = out;
1310 else
1311 err = relocate_fd (err, 3);
1314 #ifndef MSDOS
1315 emacs_close (0);
1316 emacs_close (1);
1317 emacs_close (2);
1319 dup2 (in, 0);
1320 dup2 (out, 1);
1321 dup2 (err, 2);
1322 emacs_close (in);
1323 if (out != in)
1324 emacs_close (out);
1325 if (err != in && err != out)
1326 emacs_close (err);
1328 #if defined (USG)
1329 #ifndef SETPGRP_RELEASES_CTTY
1330 setpgrp (); /* No arguments but equivalent in this case */
1331 #endif
1332 #else /* not USG */
1333 setpgrp (pid, pid);
1334 #endif /* not USG */
1336 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1337 tcsetpgrp (0, pid);
1339 /* execvp does not accept an environment arg so the only way
1340 to pass this environment is to set environ. Our caller
1341 is responsible for restoring the ambient value of environ. */
1342 environ = env;
1343 execvp (new_argv[0], new_argv);
1345 emacs_write (1, "Can't exec program: ", 20);
1346 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1347 emacs_write (1, "\n", 1);
1348 _exit (1);
1350 #else /* MSDOS */
1351 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1352 xfree (pwd_var);
1353 if (pid == -1)
1354 /* An error occurred while trying to run the subprocess. */
1355 report_file_error ("Spawning child process", Qnil);
1356 return pid;
1357 #endif /* MSDOS */
1358 #endif /* not WINDOWSNT */
1361 #ifndef WINDOWSNT
1362 /* Move the file descriptor FD so that its number is not less than MINFD.
1363 If the file descriptor is moved at all, the original is freed. */
1364 static int
1365 relocate_fd (int fd, int minfd)
1367 if (fd >= minfd)
1368 return fd;
1369 else
1371 int new;
1372 #ifdef F_DUPFD
1373 new = fcntl (fd, F_DUPFD, minfd);
1374 #else
1375 new = dup (fd);
1376 if (new != -1)
1377 /* Note that we hold the original FD open while we recurse,
1378 to guarantee we'll get a new FD if we need it. */
1379 new = relocate_fd (new, minfd);
1380 #endif
1381 if (new == -1)
1383 const char *message_1 = "Error while setting up child: ";
1384 const char *errmessage = strerror (errno);
1385 const char *message_2 = "\n";
1386 emacs_write (2, message_1, strlen (message_1));
1387 emacs_write (2, errmessage, strlen (errmessage));
1388 emacs_write (2, message_2, strlen (message_2));
1389 _exit (1);
1391 emacs_close (fd);
1392 return new;
1395 #endif /* not WINDOWSNT */
1397 static int
1398 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1399 ptrdiff_t *valuelen, Lisp_Object env)
1401 for (; CONSP (env); env = XCDR (env))
1403 Lisp_Object entry = XCAR (env);
1404 if (STRINGP (entry)
1405 && SBYTES (entry) >= varlen
1406 #ifdef WINDOWSNT
1407 /* NT environment variables are case insensitive. */
1408 && ! strnicmp (SDATA (entry), var, varlen)
1409 #else /* not WINDOWSNT */
1410 && ! memcmp (SDATA (entry), var, varlen)
1411 #endif /* not WINDOWSNT */
1414 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1416 *value = SSDATA (entry) + (varlen + 1);
1417 *valuelen = SBYTES (entry) - (varlen + 1);
1418 return 1;
1420 else if (SBYTES (entry) == varlen)
1422 /* Lone variable names in Vprocess_environment mean that
1423 variable should be removed from the environment. */
1424 *value = NULL;
1425 return 1;
1429 return 0;
1432 static int
1433 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1434 ptrdiff_t *valuelen, Lisp_Object frame)
1436 /* Try to find VAR in Vprocess_environment first. */
1437 if (getenv_internal_1 (var, varlen, value, valuelen,
1438 Vprocess_environment))
1439 return *value ? 1 : 0;
1441 /* For DISPLAY try to get the values from the frame or the initial env. */
1442 if (strcmp (var, "DISPLAY") == 0)
1444 Lisp_Object display
1445 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1446 if (STRINGP (display))
1448 *value = SSDATA (display);
1449 *valuelen = SBYTES (display);
1450 return 1;
1452 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1453 if (getenv_internal_1 (var, varlen, value, valuelen,
1454 Vinitial_environment))
1455 return *value ? 1 : 0;
1458 return 0;
1461 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1462 doc: /* Get the value of environment variable VARIABLE.
1463 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1464 the environment. Otherwise, value is a string.
1466 This function searches `process-environment' for VARIABLE.
1468 If optional parameter ENV is a list, then search this list instead of
1469 `process-environment', and return t when encountering a negative entry
1470 \(an entry for a variable with no value). */)
1471 (Lisp_Object variable, Lisp_Object env)
1473 char *value;
1474 ptrdiff_t valuelen;
1476 CHECK_STRING (variable);
1477 if (CONSP (env))
1479 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1480 &value, &valuelen, env))
1481 return value ? make_string (value, valuelen) : Qt;
1482 else
1483 return Qnil;
1485 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1486 &value, &valuelen, env))
1487 return make_string (value, valuelen);
1488 else
1489 return Qnil;
1492 /* A version of getenv that consults the Lisp environment lists,
1493 easily callable from C. */
1494 char *
1495 egetenv (const char *var)
1497 char *value;
1498 ptrdiff_t valuelen;
1500 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1501 return value;
1502 else
1503 return 0;
1507 /* This is run before init_cmdargs. */
1509 void
1510 init_callproc_1 (void)
1512 #ifdef HAVE_NS
1513 const char *etc_dir = ns_etc_directory ();
1514 const char *path_exec = ns_exec_path ();
1515 #endif
1517 Vdata_directory = decode_env_path ("EMACSDATA",
1518 #ifdef HAVE_NS
1519 etc_dir ? etc_dir :
1520 #endif
1521 PATH_DATA);
1522 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1524 Vdoc_directory = decode_env_path ("EMACSDOC",
1525 #ifdef HAVE_NS
1526 etc_dir ? etc_dir :
1527 #endif
1528 PATH_DOC);
1529 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1531 /* Check the EMACSPATH environment variable, defaulting to the
1532 PATH_EXEC path from epaths.h. */
1533 Vexec_path = decode_env_path ("EMACSPATH",
1534 #ifdef HAVE_NS
1535 path_exec ? path_exec :
1536 #endif
1537 PATH_EXEC);
1538 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1539 /* FIXME? For ns, path_exec should go at the front? */
1540 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1543 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1545 void
1546 init_callproc (void)
1548 char *data_dir = egetenv ("EMACSDATA");
1550 register char * sh;
1551 Lisp_Object tempdir;
1552 #ifdef HAVE_NS
1553 if (data_dir == 0)
1555 const char *etc_dir = ns_etc_directory ();
1556 if (etc_dir)
1558 data_dir = alloca (strlen (etc_dir) + 1);
1559 strcpy (data_dir, etc_dir);
1562 #endif
1564 if (!NILP (Vinstallation_directory))
1566 /* Add to the path the lib-src subdir of the installation dir. */
1567 Lisp_Object tem;
1568 tem = Fexpand_file_name (build_string ("lib-src"),
1569 Vinstallation_directory);
1570 #ifndef MSDOS
1571 /* MSDOS uses wrapped binaries, so don't do this. */
1572 if (NILP (Fmember (tem, Vexec_path)))
1574 #ifdef HAVE_NS
1575 const char *path_exec = ns_exec_path ();
1576 #endif
1577 Vexec_path = decode_env_path ("EMACSPATH",
1578 #ifdef HAVE_NS
1579 path_exec ? path_exec :
1580 #endif
1581 PATH_EXEC);
1582 Vexec_path = Fcons (tem, Vexec_path);
1583 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1586 Vexec_directory = Ffile_name_as_directory (tem);
1587 #endif /* not MSDOS */
1589 /* Maybe use ../etc as well as ../lib-src. */
1590 if (data_dir == 0)
1592 tem = Fexpand_file_name (build_string ("etc"),
1593 Vinstallation_directory);
1594 Vdoc_directory = Ffile_name_as_directory (tem);
1598 /* Look for the files that should be in etc. We don't use
1599 Vinstallation_directory, because these files are never installed
1600 near the executable, and they are never in the build
1601 directory when that's different from the source directory.
1603 Instead, if these files are not in the nominal place, we try the
1604 source directory. */
1605 if (data_dir == 0)
1607 Lisp_Object tem, tem1, srcdir;
1609 srcdir = Fexpand_file_name (build_string ("../src/"),
1610 build_string (PATH_DUMPLOADSEARCH));
1611 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1612 tem1 = Ffile_exists_p (tem);
1613 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1615 Lisp_Object newdir;
1616 newdir = Fexpand_file_name (build_string ("../etc/"),
1617 build_string (PATH_DUMPLOADSEARCH));
1618 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1619 tem1 = Ffile_exists_p (tem);
1620 if (!NILP (tem1))
1621 Vdata_directory = newdir;
1625 #ifndef CANNOT_DUMP
1626 if (initialized)
1627 #endif
1629 tempdir = Fdirectory_file_name (Vexec_directory);
1630 if (access (SSDATA (tempdir), 0) < 0)
1631 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1632 Vexec_directory);
1635 tempdir = Fdirectory_file_name (Vdata_directory);
1636 if (access (SSDATA (tempdir), 0) < 0)
1637 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1638 Vdata_directory);
1640 sh = (char *) getenv ("SHELL");
1641 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1643 #ifdef DOS_NT
1644 Vshared_game_score_directory = Qnil;
1645 #else
1646 Vshared_game_score_directory = build_string (PATH_GAME);
1647 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1648 Vshared_game_score_directory = Qnil;
1649 #endif
1652 void
1653 set_initial_environment (void)
1655 char **envp;
1656 for (envp = environ; *envp; envp++)
1657 Vprocess_environment = Fcons (build_string (*envp),
1658 Vprocess_environment);
1659 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1660 to use `delete' and friends on process-environment. */
1661 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1664 void
1665 syms_of_callproc (void)
1667 #ifndef DOS_NT
1668 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1669 #elif defined (WINDOWSNT)
1670 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1671 #else
1672 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1673 #endif
1674 staticpro (&Vtemp_file_name_pattern);
1676 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1677 doc: /* File name to load inferior shells from.
1678 Initialized from the SHELL environment variable, or to a system-dependent
1679 default if SHELL is not set. */);
1681 DEFVAR_LISP ("exec-path", Vexec_path,
1682 doc: /* List of directories to search programs to run in subprocesses.
1683 Each element is a string (directory name) or nil (try default directory). */);
1685 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1686 doc: /* List of suffixes to try to find executable file names.
1687 Each element is a string. */);
1688 Vexec_suffixes = Qnil;
1690 DEFVAR_LISP ("exec-directory", Vexec_directory,
1691 doc: /* Directory for executables for Emacs to invoke.
1692 More generally, this includes any architecture-dependent files
1693 that are built and installed from the Emacs distribution. */);
1695 DEFVAR_LISP ("data-directory", Vdata_directory,
1696 doc: /* Directory of machine-independent files that come with GNU Emacs.
1697 These are files intended for Emacs to use while it runs. */);
1699 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1700 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1701 This is usually the same as `data-directory'. */);
1703 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1704 doc: /* For internal use by the build procedure only.
1705 This is the name of the directory in which the build procedure installed
1706 Emacs's info files; the default value for `Info-default-directory-list'
1707 includes this. */);
1708 Vconfigure_info_directory = build_string (PATH_INFO);
1710 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1711 doc: /* Directory of score files for games which come with GNU Emacs.
1712 If this variable is nil, then Emacs is unable to use a shared directory. */);
1713 #ifdef DOS_NT
1714 Vshared_game_score_directory = Qnil;
1715 #else
1716 Vshared_game_score_directory = build_string (PATH_GAME);
1717 #endif
1719 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1720 doc: /* List of environment variables inherited from the parent process.
1721 Each element should be a string of the form ENVVARNAME=VALUE.
1722 The elements must normally be decoded (using `locale-coding-system') for use. */);
1723 Vinitial_environment = Qnil;
1725 DEFVAR_LISP ("process-environment", Vprocess_environment,
1726 doc: /* List of overridden environment variables for subprocesses to inherit.
1727 Each element should be a string of the form ENVVARNAME=VALUE.
1729 Entries in this list take precedence to those in the frame-local
1730 environments. Therefore, let-binding `process-environment' is an easy
1731 way to temporarily change the value of an environment variable,
1732 irrespective of where it comes from. To use `process-environment' to
1733 remove an environment variable, include only its name in the list,
1734 without "=VALUE".
1736 This variable is set to nil when Emacs starts.
1738 If multiple entries define the same variable, the first one always
1739 takes precedence.
1741 Non-ASCII characters are encoded according to the initial value of
1742 `locale-coding-system', i.e. the elements must normally be decoded for
1743 use.
1745 See `setenv' and `getenv'. */);
1746 Vprocess_environment = Qnil;
1748 defsubr (&Scall_process);
1749 defsubr (&Sgetenv_internal);
1750 defsubr (&Scall_process_region);