Merge from origin/emacs-24
[emacs.git] / src / callproc.c
blobf40ed3244a5b8ca7b60817f200373d461fd22d3d
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2014 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <sys/types.h>
26 #include <unistd.h>
28 #include <sys/file.h>
29 #include <fcntl.h>
31 #include "lisp.h"
33 #ifdef WINDOWSNT
34 #define NOMINMAX
35 #include <sys/socket.h> /* for fcntl */
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
46 #include "commands.h"
47 #include "character.h"
48 #include "buffer.h"
49 #include "ccl.h"
50 #include "coding.h"
51 #include "composite.h"
52 #include <epaths.h>
53 #include "process.h"
54 #include "syssignal.h"
55 #include "systty.h"
56 #include "syswait.h"
57 #include "blockinput.h"
58 #include "frame.h"
59 #include "termhooks.h"
61 #ifdef MSDOS
62 #include "msdos.h"
63 #endif
65 #ifdef HAVE_NS
66 #include "nsterm.h"
67 #endif
69 /* Pattern used by call-process-region to make temp files. */
70 static Lisp_Object Vtemp_file_name_pattern;
72 /* The next two variables are used while record-unwind-protect is in place
73 during call-process for a subprocess for which record_deleted_pid has
74 not yet been called. At other times, synch_process_pid is zero and
75 synch_process_tempfile's contents are irrelevant. Doing this via static
76 C variables is more convenient than putting them into the arguments
77 of record-unwind-protect, as they need to be updated at randomish
78 times in the code, and Lisp cannot always store these values as
79 Emacs integers. It's safe to use static variables here, as the
80 code is never invoked reentrantly. */
82 /* If nonzero, a process-ID that has not been reaped. */
83 static pid_t synch_process_pid;
85 /* If a string, the name of a temp file that has not been removed. */
86 #ifdef MSDOS
87 static Lisp_Object synch_process_tempfile;
88 #else
89 # define synch_process_tempfile make_number (0)
90 #endif
92 /* Indexes of file descriptors that need closing on call_process_kill. */
93 enum
95 /* The subsidiary process's stdout and stderr. stdin is handled
96 separately, in either Fcall_process_region or create_temp_file. */
97 CALLPROC_STDOUT, CALLPROC_STDERR,
99 /* How to read from a pipe (or substitute) from the subsidiary process. */
100 CALLPROC_PIPEREAD,
102 /* A bound on the number of file descriptors. */
103 CALLPROC_FDS
106 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
108 /* Return the current buffer's working directory, or the home
109 directory if it's unreachable, as a string suitable for a system call.
110 Signal an error if the result would not be an accessible directory. */
112 Lisp_Object
113 encode_current_directory (void)
115 Lisp_Object dir;
116 struct gcpro gcpro1;
118 dir = BVAR (current_buffer, directory);
119 GCPRO1 (dir);
121 dir = Funhandled_file_name_directory (dir);
123 /* If the file name handler says that dir is unreachable, use
124 a sensible default. */
125 if (NILP (dir))
126 dir = build_string ("~");
128 dir = expand_and_dir_to_file (dir, Qnil);
130 if (NILP (Ffile_accessible_directory_p (dir)))
131 report_file_error ("Setting current directory",
132 BVAR (current_buffer, directory));
134 /* Remove "/:" from dir. */
135 if (! NILP (Fstring_match (build_string ("^/:"), dir, Qnil)))
136 dir = Fsubstring (dir, make_number (2), Qnil);
138 if (STRING_MULTIBYTE (dir))
139 dir = ENCODE_FILE (dir);
140 if (! file_accessible_directory_p (dir))
141 report_file_error ("Setting current directory",
142 BVAR (current_buffer, directory));
144 RETURN_UNGCPRO (dir);
147 /* If P is reapable, record it as a deleted process and kill it.
148 Do this in a critical section. Unless PID is wedged it will be
149 reaped on receipt of the first SIGCHLD after the critical section. */
151 void
152 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
154 #ifndef MSDOS
155 sigset_t oldset;
156 block_child_signal (&oldset);
158 if (p->alive)
160 record_deleted_pid (p->pid, tempfile);
161 p->alive = 0;
162 kill (- p->pid, SIGKILL);
165 unblock_child_signal (&oldset);
166 #endif /* !MSDOS */
169 /* Clean up files, file descriptors and processes created by Fcall_process. */
171 static void
172 delete_temp_file (Lisp_Object name)
174 unlink (SSDATA (name));
177 static void
178 call_process_kill (void *ptr)
180 int *callproc_fd = ptr;
181 int i;
182 for (i = 0; i < CALLPROC_FDS; i++)
183 if (0 <= callproc_fd[i])
184 emacs_close (callproc_fd[i]);
186 if (synch_process_pid)
188 struct Lisp_Process proc;
189 proc.alive = 1;
190 proc.pid = synch_process_pid;
191 record_kill_process (&proc, synch_process_tempfile);
192 synch_process_pid = 0;
194 else if (STRINGP (synch_process_tempfile))
195 delete_temp_file (synch_process_tempfile);
198 /* Clean up when exiting Fcall_process: restore the buffer, and
199 kill the subsidiary process group if the process still exists. */
201 static void
202 call_process_cleanup (Lisp_Object buffer)
204 Fset_buffer (buffer);
206 #ifndef MSDOS
207 if (synch_process_pid)
209 kill (-synch_process_pid, SIGINT);
210 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
211 immediate_quit = 1;
212 QUIT;
213 wait_for_termination (synch_process_pid, 0, 1);
214 synch_process_pid = 0;
215 immediate_quit = 0;
216 message1 ("Waiting for process to die...done");
218 #endif /* !MSDOS */
221 #ifdef DOS_NT
222 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
223 #else
224 static mode_t const default_output_mode = 0666;
225 #endif
227 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
228 doc: /* Call PROGRAM synchronously in separate process.
229 The remaining arguments are optional.
230 The program's input comes from file INFILE (nil means `/dev/null').
231 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
232 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
233 FILE is a file name string, means that it should be written to that file
234 \(if the file already exists it is overwritten).
235 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
236 REAL-BUFFER says what to do with standard output, as above,
237 while STDERR-FILE says what to do with standard error in the child.
238 STDERR-FILE may be nil (discard standard error output),
239 t (mix it with ordinary output), or a file name string.
241 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
242 Remaining arguments are strings passed as command arguments to PROGRAM.
244 If executable PROGRAM can't be found as an executable, `call-process'
245 signals a Lisp error. `call-process' reports errors in execution of
246 the program only through its return and output.
248 If DESTINATION is 0, `call-process' returns immediately with value nil.
249 Otherwise it waits for PROGRAM to terminate
250 and returns a numeric exit status or a signal description string.
251 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
253 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
254 (ptrdiff_t nargs, Lisp_Object *args)
256 Lisp_Object infile, encoded_infile;
257 int filefd;
258 struct gcpro gcpro1;
259 ptrdiff_t count = SPECPDL_INDEX ();
261 if (nargs >= 2 && ! NILP (args[1]))
263 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
264 CHECK_STRING (infile);
266 else
267 infile = build_string (NULL_DEVICE);
269 GCPRO1 (infile);
270 encoded_infile = STRING_MULTIBYTE (infile) ? ENCODE_FILE (infile) : infile;
272 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
273 if (filefd < 0)
274 report_file_error ("Opening process input file", infile);
275 record_unwind_protect_int (close_file_unwind, filefd);
276 UNGCPRO;
277 return unbind_to (count, call_process (nargs, args, filefd, -1));
280 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
282 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
283 unwinder that is intended to remove the input temporary file; in
284 this case NARGS must be at least 2 and ARGS[1] is the file's name.
286 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
288 static Lisp_Object
289 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
290 ptrdiff_t tempfile_index)
292 Lisp_Object buffer, current_dir, path;
293 bool display_p;
294 int fd0;
295 int callproc_fd[CALLPROC_FDS];
296 int status;
297 ptrdiff_t i;
298 ptrdiff_t count = SPECPDL_INDEX ();
299 USE_SAFE_ALLOCA;
301 char **new_argv;
302 /* File to use for stderr in the child.
303 t means use same as standard output. */
304 Lisp_Object error_file;
305 Lisp_Object output_file = Qnil;
306 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
307 char *tempfile = NULL;
308 int pid;
309 #else
310 sigset_t oldset;
311 pid_t pid;
312 #endif
313 int child_errno;
314 int fd_output, fd_error;
315 struct coding_system process_coding; /* coding-system of process output */
316 struct coding_system argument_coding; /* coding-system of arguments */
317 /* Set to the return value of Ffind_operation_coding_system. */
318 Lisp_Object coding_systems;
319 bool discard_output;
321 if (synch_process_pid)
322 error ("call-process invoked recursively");
324 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
325 coding_systems = Qt;
327 CHECK_STRING (args[0]);
329 error_file = Qt;
331 #ifndef subprocesses
332 /* Without asynchronous processes we cannot have BUFFER == 0. */
333 if (nargs >= 3
334 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
335 error ("Operating system cannot handle asynchronous subprocesses");
336 #endif /* subprocesses */
338 /* Decide the coding-system for giving arguments. */
340 Lisp_Object val, *args2;
342 /* If arguments are supplied, we may have to encode them. */
343 if (nargs >= 5)
345 bool must_encode = 0;
346 Lisp_Object coding_attrs;
348 for (i = 4; i < nargs; i++)
349 CHECK_STRING (args[i]);
351 for (i = 4; i < nargs; i++)
352 if (STRING_MULTIBYTE (args[i]))
353 must_encode = 1;
355 if (!NILP (Vcoding_system_for_write))
356 val = Vcoding_system_for_write;
357 else if (! must_encode)
358 val = Qraw_text;
359 else
361 SAFE_NALLOCA (args2, 1, nargs + 1);
362 args2[0] = Qcall_process;
363 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
364 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
365 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
367 val = complement_process_encoding_system (val);
368 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
369 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
370 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
372 /* We should not use an ASCII incompatible coding system. */
373 val = raw_text_coding_system (val);
374 setup_coding_system (val, &argument_coding);
379 if (nargs < 3)
380 buffer = Qnil;
381 else
383 buffer = args[2];
385 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
386 FILE-FOR-STDERR), unless the first element is :file, in which case see
387 the next paragraph. */
388 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
390 if (CONSP (XCDR (buffer)))
392 Lisp_Object stderr_file;
393 stderr_file = XCAR (XCDR (buffer));
395 if (NILP (stderr_file) || EQ (Qt, stderr_file))
396 error_file = stderr_file;
397 else
398 error_file = Fexpand_file_name (stderr_file, Qnil);
401 buffer = XCAR (buffer);
404 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
405 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
407 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
408 BVAR (current_buffer, directory));
409 CHECK_STRING (output_file);
410 buffer = Qnil;
413 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
415 Lisp_Object spec_buffer;
416 spec_buffer = buffer;
417 buffer = Fget_buffer_create (buffer);
418 /* Mention the buffer name for a better error message. */
419 if (NILP (buffer))
420 CHECK_BUFFER (spec_buffer);
421 CHECK_BUFFER (buffer);
425 /* Make sure that the child will be able to chdir to the current
426 buffer's current directory, or its unhandled equivalent. We
427 can't just have the child check for an error when it does the
428 chdir, since it's in a vfork.
430 We have to GCPRO around this because Fexpand_file_name,
431 Funhandled_file_name_directory, and Ffile_accessible_directory_p
432 might call a file name handling function. The argument list is
433 protected by the caller, so all we really have to worry about is
434 buffer. */
436 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
438 current_dir = encode_current_directory ();
440 GCPRO4 (buffer, current_dir, error_file, output_file);
442 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
443 error_file = ENCODE_FILE (error_file);
444 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
445 output_file = ENCODE_FILE (output_file);
446 UNGCPRO;
449 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
451 for (i = 0; i < CALLPROC_FDS; i++)
452 callproc_fd[i] = -1;
453 #ifdef MSDOS
454 synch_process_tempfile = make_number (0);
455 #endif
456 record_unwind_protect_ptr (call_process_kill, callproc_fd);
458 /* Search for program; barf if not found. */
460 struct gcpro gcpro1, gcpro2, gcpro3;
461 int ok;
463 GCPRO3 (buffer, current_dir, error_file);
464 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
465 make_number (X_OK), false);
466 UNGCPRO;
467 if (ok < 0)
468 report_file_error ("Searching for program", args[0]);
471 /* If program file name starts with /: for quoting a magic name,
472 discard that. */
473 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
474 && SREF (path, 1) == ':')
475 path = Fsubstring (path, make_number (2), Qnil);
477 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
480 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
482 GCPRO4 (buffer, current_dir, path, error_file);
483 if (nargs > 4)
485 ptrdiff_t i;
487 argument_coding.dst_multibyte = 0;
488 for (i = 4; i < nargs; i++)
490 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
491 if (CODING_REQUIRE_ENCODING (&argument_coding))
492 /* We must encode this argument. */
493 args[i] = encode_coding_string (&argument_coding, args[i], 1);
495 for (i = 4; i < nargs; i++)
496 new_argv[i - 3] = SSDATA (args[i]);
497 new_argv[i - 3] = 0;
499 else
500 new_argv[1] = 0;
501 if (STRING_MULTIBYTE (path))
502 path = ENCODE_FILE (path);
503 new_argv[0] = SSDATA (path);
504 UNGCPRO;
507 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
509 #ifdef MSDOS
510 if (! discard_output && ! STRINGP (output_file))
512 char const *tmpdir = egetenv ("TMPDIR");
513 char const *outf = tmpdir ? tmpdir : "";
514 tempfile = alloca (strlen (outf) + 20);
515 strcpy (tempfile, outf);
516 dostounix_filename (tempfile);
517 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
518 strcat (tempfile, "/");
519 strcat (tempfile, "emXXXXXX");
520 mktemp (tempfile);
521 if (!*tempfile)
522 report_file_error ("Opening process output file", Qnil);
523 output_file = build_string (tempfile);
524 synch_process_tempfile = output_file;
526 #endif
528 if (discard_output)
530 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
531 if (fd_output < 0)
532 report_file_error ("Opening null device", Qnil);
534 else if (STRINGP (output_file))
536 fd_output = emacs_open (SSDATA (output_file),
537 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
538 default_output_mode);
539 if (fd_output < 0)
541 int open_errno = errno;
542 output_file = DECODE_FILE (output_file);
543 report_file_errno ("Opening process output file",
544 output_file, open_errno);
547 else
549 int fd[2];
550 if (emacs_pipe (fd) != 0)
551 report_file_error ("Creating process pipe", Qnil);
552 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
553 fd_output = fd[1];
555 callproc_fd[CALLPROC_STDOUT] = fd_output;
557 fd_error = fd_output;
559 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
561 fd_error = emacs_open ((STRINGP (error_file)
562 ? SSDATA (error_file)
563 : NULL_DEVICE),
564 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
565 default_output_mode);
566 if (fd_error < 0)
568 int open_errno = errno;
569 report_file_errno ("Cannot redirect stderr",
570 (STRINGP (error_file)
571 ? DECODE_FILE (error_file)
572 : build_string (NULL_DEVICE)),
573 open_errno);
575 callproc_fd[CALLPROC_STDERR] = fd_error;
578 #ifdef MSDOS /* MW, July 1993 */
579 /* Note that on MSDOS `child_setup' actually returns the child process
580 exit status, not its PID, so assign it to status below. */
581 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
583 if (pid < 0)
585 child_errno = errno;
586 unbind_to (count, Qnil);
587 synchronize_system_messages_locale ();
588 return
589 code_convert_string_norecord (build_string (strerror (child_errno)),
590 Vlocale_coding_system, 0);
592 status = pid;
594 for (i = 0; i < CALLPROC_FDS; i++)
595 if (0 <= callproc_fd[i])
597 emacs_close (callproc_fd[i]);
598 callproc_fd[i] = -1;
600 emacs_close (filefd);
601 clear_unwind_protect (count - 1);
603 if (tempfile)
605 /* Since CRLF is converted to LF within `decode_coding', we
606 can always open a file with binary mode. */
607 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
608 O_RDONLY | O_BINARY, 0);
609 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
611 int open_errno = errno;
612 report_file_errno ("Cannot re-open temporary file",
613 build_string (tempfile), open_errno);
617 #endif /* MSDOS */
619 /* Do the unwind-protect now, even though the pid is not known, so
620 that no storage allocation is done in the critical section.
621 The actual PID will be filled in during the critical section. */
622 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
624 #ifndef MSDOS
626 block_input ();
627 block_child_signal (&oldset);
629 #ifdef WINDOWSNT
630 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
631 #else /* not WINDOWSNT */
633 /* vfork, and prevent local vars from being clobbered by the vfork. */
635 Lisp_Object volatile buffer_volatile = buffer;
636 Lisp_Object volatile coding_systems_volatile = coding_systems;
637 Lisp_Object volatile current_dir_volatile = current_dir;
638 bool volatile display_p_volatile = display_p;
639 bool volatile sa_must_free_volatile = sa_must_free;
640 int volatile fd_error_volatile = fd_error;
641 int volatile filefd_volatile = filefd;
642 ptrdiff_t volatile count_volatile = count;
643 ptrdiff_t volatile sa_avail_volatile = sa_avail;
644 ptrdiff_t volatile sa_count_volatile = sa_count;
645 char **volatile new_argv_volatile = new_argv;
646 int volatile callproc_fd_volatile[CALLPROC_FDS];
647 for (i = 0; i < CALLPROC_FDS; i++)
648 callproc_fd_volatile[i] = callproc_fd[i];
650 pid = vfork ();
652 buffer = buffer_volatile;
653 coding_systems = coding_systems_volatile;
654 current_dir = current_dir_volatile;
655 display_p = display_p_volatile;
656 sa_must_free = sa_must_free_volatile;
657 fd_error = fd_error_volatile;
658 filefd = filefd_volatile;
659 count = count_volatile;
660 sa_avail = sa_avail_volatile;
661 sa_count = sa_count_volatile;
662 new_argv = new_argv_volatile;
664 for (i = 0; i < CALLPROC_FDS; i++)
665 callproc_fd[i] = callproc_fd_volatile[i];
666 fd_output = callproc_fd[CALLPROC_STDOUT];
669 if (pid == 0)
671 unblock_child_signal (&oldset);
673 setsid ();
675 /* Emacs ignores SIGPIPE, but the child should not. */
676 signal (SIGPIPE, SIG_DFL);
677 /* Likewise for SIGPROF. */
678 #ifdef SIGPROF
679 signal (SIGPROF, SIG_DFL);
680 #endif
682 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
685 #endif /* not WINDOWSNT */
687 child_errno = errno;
689 if (pid > 0)
691 synch_process_pid = pid;
693 if (INTEGERP (buffer))
695 if (tempfile_index < 0)
696 record_deleted_pid (pid, Qnil);
697 else
699 eassert (1 < nargs);
700 record_deleted_pid (pid, args[1]);
701 clear_unwind_protect (tempfile_index);
703 synch_process_pid = 0;
707 unblock_child_signal (&oldset);
708 unblock_input ();
710 if (pid < 0)
711 report_file_errno ("Doing vfork", Qnil, child_errno);
713 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
714 since we will use that to read input from. */
715 for (i = 0; i < CALLPROC_FDS; i++)
716 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
718 emacs_close (callproc_fd[i]);
719 callproc_fd[i] = -1;
721 emacs_close (filefd);
722 clear_unwind_protect (count - 1);
724 #endif /* not MSDOS */
726 if (INTEGERP (buffer))
727 return unbind_to (count, Qnil);
729 if (BUFFERP (buffer))
730 Fset_buffer (buffer);
732 fd0 = callproc_fd[CALLPROC_PIPEREAD];
734 if (0 <= fd0)
736 Lisp_Object val, *args2;
738 val = Qnil;
739 if (!NILP (Vcoding_system_for_read))
740 val = Vcoding_system_for_read;
741 else
743 if (EQ (coding_systems, Qt))
745 ptrdiff_t i;
747 SAFE_NALLOCA (args2, 1, nargs + 1);
748 args2[0] = Qcall_process;
749 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
750 coding_systems
751 = Ffind_operation_coding_system (nargs + 1, args2);
753 if (CONSP (coding_systems))
754 val = XCAR (coding_systems);
755 else if (CONSP (Vdefault_process_coding_system))
756 val = XCAR (Vdefault_process_coding_system);
757 else
758 val = Qnil;
760 Fcheck_coding_system (val);
761 /* In unibyte mode, character code conversion should not take
762 place but EOL conversion should. So, setup raw-text or one
763 of the subsidiary according to the information just setup. */
764 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
765 && !NILP (val))
766 val = raw_text_coding_system (val);
767 setup_coding_system (val, &process_coding);
768 process_coding.dst_multibyte
769 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
770 process_coding.src_multibyte = 0;
773 immediate_quit = 1;
774 QUIT;
776 if (0 <= fd0)
778 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
779 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
780 char buf[CALLPROC_BUFFER_SIZE_MAX];
781 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
782 int nread;
783 EMACS_INT total_read = 0;
784 int carryover = 0;
785 bool display_on_the_fly = display_p;
786 struct coding_system saved_coding = process_coding;
788 while (1)
790 /* Repeatedly read until we've filled as much as possible
791 of the buffer size we have. But don't read
792 less than 1024--save that for the next bufferful. */
793 nread = carryover;
794 while (nread < bufsize - 1024)
796 int this_read = emacs_read (fd0, buf + nread,
797 bufsize - nread);
799 if (this_read < 0)
800 goto give_up;
802 if (this_read == 0)
804 process_coding.mode |= CODING_MODE_LAST_BLOCK;
805 break;
808 nread += this_read;
809 total_read += this_read;
811 if (display_on_the_fly)
812 break;
815 /* Now NREAD is the total amount of data in the buffer. */
816 immediate_quit = 0;
818 if (!nread)
820 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
821 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
822 insert_1_both (buf, nread, nread, 0, 1, 0);
823 else
824 { /* We have to decode the input. */
825 Lisp_Object curbuf;
826 ptrdiff_t count1 = SPECPDL_INDEX ();
828 XSETBUFFER (curbuf, current_buffer);
829 /* FIXME: Call signal_after_change! */
830 prepare_to_modify_buffer (PT, PT, NULL);
831 /* We cannot allow after-change-functions be run
832 during decoding, because that might modify the
833 buffer, while we rely on process_coding.produced to
834 faithfully reflect inserted text until we
835 TEMP_SET_PT_BOTH below. */
836 specbind (Qinhibit_modification_hooks, Qt);
837 decode_coding_c_string (&process_coding,
838 (unsigned char *) buf, nread, curbuf);
839 unbind_to (count1, Qnil);
840 if (display_on_the_fly
841 && CODING_REQUIRE_DETECTION (&saved_coding)
842 && ! CODING_REQUIRE_DETECTION (&process_coding))
844 /* We have detected some coding system, but the
845 detection may have been via insufficient data.
846 So give up displaying on the fly. */
847 if (process_coding.produced > 0)
848 del_range_2 (process_coding.dst_pos,
849 process_coding.dst_pos_byte,
850 (process_coding.dst_pos
851 + process_coding.produced_char),
852 (process_coding.dst_pos_byte
853 + process_coding.produced),
855 display_on_the_fly = false;
856 process_coding = saved_coding;
857 carryover = nread;
858 /* Make the above condition always fail in the future. */
859 saved_coding.common_flags
860 &= ~CODING_REQUIRE_DETECTION_MASK;
861 continue;
864 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
865 PT_BYTE + process_coding.produced);
866 carryover = process_coding.carryover_bytes;
867 if (carryover > 0)
868 memcpy (buf, process_coding.carryover,
869 process_coding.carryover_bytes);
872 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
873 break;
875 /* Make the buffer bigger as we continue to read more data,
876 but not past CALLPROC_BUFFER_SIZE_MAX. */
877 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
878 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
879 bufsize = CALLPROC_BUFFER_SIZE_MAX;
881 if (display_p)
883 redisplay_preserve_echo_area (1);
884 /* This variable might have been set to 0 for code
885 detection. In that case, set it back to 1 because
886 we should have already detected a coding system. */
887 display_on_the_fly = true;
889 immediate_quit = true;
890 QUIT;
892 give_up: ;
894 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
895 /* If the caller required, let the buffer inherit the
896 coding-system used to decode the process output. */
897 if (inherit_process_coding_system)
898 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
899 make_number (total_read));
902 #ifndef MSDOS
903 /* Wait for it to terminate, unless it already has. */
904 wait_for_termination (pid, &status, fd0 < 0);
905 #endif
907 immediate_quit = 0;
909 /* Don't kill any children that the subprocess may have left behind
910 when exiting. */
911 synch_process_pid = 0;
913 SAFE_FREE ();
914 unbind_to (count, Qnil);
916 if (WIFSIGNALED (status))
918 const char *signame;
920 synchronize_system_messages_locale ();
921 signame = strsignal (WTERMSIG (status));
923 if (signame == 0)
924 signame = "unknown";
926 return code_convert_string_norecord (build_string (signame),
927 Vlocale_coding_system, 0);
930 eassert (WIFEXITED (status));
931 return make_number (WEXITSTATUS (status));
934 /* Create a temporary file suitable for storing the input data of
935 call-process-region. NARGS and ARGS are the same as for
936 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
937 naming the file, and return a file descriptor for reading.
938 Unwind-protect the file, so that the file descriptor will be closed
939 and the file removed when the caller unwinds the specpdl stack. */
941 static int
942 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
943 Lisp_Object *filename_string_ptr)
945 int fd;
946 struct gcpro gcpro1;
947 Lisp_Object filename_string;
948 Lisp_Object val, start, end;
949 Lisp_Object tmpdir;
951 if (STRINGP (Vtemporary_file_directory))
952 tmpdir = Vtemporary_file_directory;
953 else
955 char *outf;
956 #ifndef DOS_NT
957 outf = getenv ("TMPDIR");
958 tmpdir = build_string (outf ? outf : "/tmp/");
959 #else /* DOS_NT */
960 if ((outf = egetenv ("TMPDIR"))
961 || (outf = egetenv ("TMP"))
962 || (outf = egetenv ("TEMP")))
963 tmpdir = build_string (outf);
964 else
965 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
966 #endif
970 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
971 char *tempfile;
972 ptrdiff_t count;
974 #ifdef WINDOWSNT
975 /* Cannot use the result of Fexpand_file_name, because it
976 downcases the XXXXXX part of the pattern, and mktemp then
977 doesn't recognize it. */
978 if (!NILP (Vw32_downcase_file_names))
980 Lisp_Object dirname = Ffile_name_directory (pattern);
982 if (NILP (dirname))
983 pattern = Vtemp_file_name_pattern;
984 else
985 pattern = concat2 (dirname, Vtemp_file_name_pattern);
987 #endif
989 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
990 GCPRO1 (filename_string);
991 tempfile = SSDATA (filename_string);
993 count = SPECPDL_INDEX ();
994 record_unwind_protect_nothing ();
995 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
996 if (fd < 0)
997 report_file_error ("Failed to open temporary file using pattern",
998 pattern);
999 set_unwind_protect (count, delete_temp_file, filename_string);
1000 record_unwind_protect_int (close_file_unwind, fd);
1003 start = args[0];
1004 end = args[1];
1005 /* Decide coding-system of the contents of the temporary file. */
1006 if (!NILP (Vcoding_system_for_write))
1007 val = Vcoding_system_for_write;
1008 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1009 val = Qraw_text;
1010 else
1012 Lisp_Object coding_systems;
1013 Lisp_Object *args2;
1014 USE_SAFE_ALLOCA;
1015 SAFE_NALLOCA (args2, 1, nargs + 1);
1016 args2[0] = Qcall_process_region;
1017 memcpy (args2 + 1, args, nargs * sizeof *args);
1018 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1019 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1020 SAFE_FREE ();
1022 val = complement_process_encoding_system (val);
1025 ptrdiff_t count1 = SPECPDL_INDEX ();
1027 specbind (intern ("coding-system-for-write"), val);
1028 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1029 happen to get a ".Z" suffix. */
1030 specbind (intern ("file-name-handler-alist"), Qnil);
1031 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
1033 unbind_to (count1, Qnil);
1036 if (lseek (fd, 0, SEEK_SET) < 0)
1037 report_file_error ("Setting file position", filename_string);
1039 /* Note that Fcall_process takes care of binding
1040 coding-system-for-read. */
1042 *filename_string_ptr = filename_string;
1043 UNGCPRO;
1044 return fd;
1047 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1048 3, MANY, 0,
1049 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1050 The remaining arguments are optional.
1051 Delete the text if fourth arg DELETE is non-nil.
1053 Insert output in BUFFER before point; t means current buffer; nil for
1054 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1055 FILE)', where FILE is a file name string, means that it should be
1056 written to that file (if the file already exists it is overwritten).
1057 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1058 REAL-BUFFER says what to do with standard output, as above,
1059 while STDERR-FILE says what to do with standard error in the child.
1060 STDERR-FILE may be nil (discard standard error output),
1061 t (mix it with ordinary output), or a file name string.
1063 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1064 Remaining args are passed to PROGRAM at startup as command args.
1066 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1067 Otherwise it waits for PROGRAM to terminate
1068 and returns a numeric exit status or a signal description string.
1069 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1071 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1072 (ptrdiff_t nargs, Lisp_Object *args)
1074 struct gcpro gcpro1;
1075 Lisp_Object infile, val;
1076 ptrdiff_t count = SPECPDL_INDEX ();
1077 Lisp_Object start = args[0];
1078 Lisp_Object end = args[1];
1079 bool empty_input;
1080 int fd;
1082 if (STRINGP (start))
1083 empty_input = SCHARS (start) == 0;
1084 else if (NILP (start))
1085 empty_input = BEG == Z;
1086 else
1088 validate_region (&args[0], &args[1]);
1089 start = args[0];
1090 end = args[1];
1091 empty_input = XINT (start) == XINT (end);
1094 if (!empty_input)
1095 fd = create_temp_file (nargs, args, &infile);
1096 else
1098 infile = Qnil;
1099 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1100 if (fd < 0)
1101 report_file_error ("Opening null device", Qnil);
1102 record_unwind_protect_int (close_file_unwind, fd);
1105 GCPRO1 (infile);
1107 if (nargs > 3 && !NILP (args[3]))
1108 Fdelete_region (start, end);
1110 if (nargs > 3)
1112 args += 2;
1113 nargs -= 2;
1115 else
1117 args[0] = args[2];
1118 nargs = 2;
1120 args[1] = infile;
1122 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1123 RETURN_UNGCPRO (unbind_to (count, val));
1126 #ifndef WINDOWSNT
1127 static int relocate_fd (int fd, int minfd);
1128 #endif
1130 static char **
1131 add_env (char **env, char **new_env, char *string)
1133 char **ep;
1134 bool ok = 1;
1135 if (string == NULL)
1136 return new_env;
1138 /* See if this string duplicates any string already in the env.
1139 If so, don't put it in.
1140 When an env var has multiple definitions,
1141 we keep the definition that comes first in process-environment. */
1142 for (ep = env; ok && ep != new_env; ep++)
1144 char *p = *ep, *q = string;
1145 while (ok)
1147 if (*q != *p)
1148 break;
1149 if (*q == 0)
1150 /* The string is a lone variable name; keep it for now, we
1151 will remove it later. It is a placeholder for a
1152 variable that is not to be included in the environment. */
1153 break;
1154 if (*q == '=')
1155 ok = 0;
1156 p++, q++;
1159 if (ok)
1160 *new_env++ = string;
1161 return new_env;
1164 #ifndef DOS_NT
1166 /* 'exec' failed inside a child running NAME, with error number ERR.
1167 Possibly a vforked child needed to allocate a large vector on the
1168 stack; such a child cannot fall back on malloc because that might
1169 mess up the allocator's data structures in the parent.
1170 Report the error and exit the child. */
1172 static _Noreturn void
1173 exec_failed (char const *name, int err)
1175 /* Avoid deadlock if the child's perror writes to a full pipe; the
1176 pipe's reader is the parent, but with vfork the parent can't
1177 run until the child exits. Truncate the diagnostic instead. */
1178 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1180 errno = err;
1181 emacs_perror (name);
1182 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1185 #else
1187 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1188 fork and exec, and handle alloca exhaustion in a different way. */
1190 static void
1191 exec_failed (char const *name, int err)
1195 #endif
1197 /* This is the last thing run in a newly forked inferior
1198 either synchronous or asynchronous.
1199 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1200 Initialize inferior's priority, pgrp, connected dir and environment.
1201 then exec another program based on new_argv.
1203 If SET_PGRP, put the subprocess into a separate process group.
1205 CURRENT_DIR is an elisp string giving the path of the current
1206 directory the subprocess should have. Since we can't really signal
1207 a decent error from within the child, this should be verified as an
1208 executable directory by the parent. */
1211 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1212 Lisp_Object current_dir)
1214 char **env;
1215 char *pwd_var;
1216 #ifdef WINDOWSNT
1217 int cpid;
1218 HANDLE handles[3];
1219 #else
1220 pid_t pid = getpid ();
1221 #endif /* WINDOWSNT */
1223 /* Note that use of alloca is always safe here. It's obvious for systems
1224 that do not have true vfork or that have true (stack) alloca.
1225 If using vfork and C_ALLOCA (when Emacs used to include
1226 src/alloca.c) it is safe because that changes the superior's
1227 static variables as if the superior had done alloca and will be
1228 cleaned up in the usual way. */
1230 char *temp;
1231 ptrdiff_t i;
1233 i = SBYTES (current_dir);
1234 #ifdef MSDOS
1235 /* MSDOS must have all environment variables malloc'ed, because
1236 low-level libc functions that launch subsidiary processes rely
1237 on that. */
1238 pwd_var = xmalloc (i + 5);
1239 #else
1240 if (MAX_ALLOCA - 5 < i)
1241 exec_failed (new_argv[0], ENOMEM);
1242 pwd_var = alloca (i + 5);
1243 #endif
1244 temp = pwd_var + 4;
1245 memcpy (pwd_var, "PWD=", 4);
1246 lispstpcpy (temp, current_dir);
1248 #ifndef DOS_NT
1249 /* We can't signal an Elisp error here; we're in a vfork. Since
1250 the callers check the current directory before forking, this
1251 should only return an error if the directory's permissions
1252 are changed between the check and this chdir, but we should
1253 at least check. */
1254 if (chdir (temp) < 0)
1255 _exit (EXIT_CANCELED);
1256 #else /* DOS_NT */
1257 /* Get past the drive letter, so that d:/ is left alone. */
1258 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1260 temp += 2;
1261 i -= 2;
1263 #endif /* DOS_NT */
1265 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1266 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1267 temp[--i] = 0;
1270 /* Set `env' to a vector of the strings in the environment. */
1272 register Lisp_Object tem;
1273 register char **new_env;
1274 char **p, **q;
1275 register int new_length;
1276 Lisp_Object display = Qnil;
1278 new_length = 0;
1280 for (tem = Vprocess_environment;
1281 CONSP (tem) && STRINGP (XCAR (tem));
1282 tem = XCDR (tem))
1284 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1285 && (SDATA (XCAR (tem)) [7] == '\0'
1286 || SDATA (XCAR (tem)) [7] == '='))
1287 /* DISPLAY is specified in process-environment. */
1288 display = Qt;
1289 new_length++;
1292 /* If not provided yet, use the frame's DISPLAY. */
1293 if (NILP (display))
1295 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1296 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1297 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1298 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1299 Vinitial_environment);
1300 if (STRINGP (tmp))
1302 display = tmp;
1303 new_length++;
1307 /* new_length + 2 to include PWD and terminating 0. */
1308 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1309 exec_failed (new_argv[0], ENOMEM);
1310 env = new_env = alloca ((new_length + 2) * sizeof *env);
1311 /* If we have a PWD envvar, pass one down,
1312 but with corrected value. */
1313 if (egetenv ("PWD"))
1314 *new_env++ = pwd_var;
1316 if (STRINGP (display))
1318 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1319 exec_failed (new_argv[0], ENOMEM);
1320 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1321 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1322 new_env = add_env (env, new_env, vdata);
1325 /* Overrides. */
1326 for (tem = Vprocess_environment;
1327 CONSP (tem) && STRINGP (XCAR (tem));
1328 tem = XCDR (tem))
1329 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1331 *new_env = 0;
1333 /* Remove variable names without values. */
1334 p = q = env;
1335 while (*p != 0)
1337 while (*q != 0 && strchr (*q, '=') == NULL)
1338 q++;
1339 *p = *q++;
1340 if (*p != 0)
1341 p++;
1346 #ifdef WINDOWSNT
1347 prepare_standard_handles (in, out, err, handles);
1348 set_process_dir (SDATA (current_dir));
1349 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1350 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1351 reset_standard_handles (in, out, err, handles);
1352 if (cpid == -1)
1353 /* An error occurred while trying to spawn the process. */
1354 report_file_error ("Spawning child process", Qnil);
1355 return cpid;
1357 #else /* not WINDOWSNT */
1358 /* Make sure that in, out, and err are not actually already in
1359 descriptors zero, one, or two; this could happen if Emacs is
1360 started with its standard in, out, or error closed, as might
1361 happen under X. */
1363 int oin = in, oout = out;
1365 /* We have to avoid relocating the same descriptor twice! */
1367 in = relocate_fd (in, 3);
1369 if (out == oin)
1370 out = in;
1371 else
1372 out = relocate_fd (out, 3);
1374 if (err == oin)
1375 err = in;
1376 else if (err == oout)
1377 err = out;
1378 else
1379 err = relocate_fd (err, 3);
1382 #ifndef MSDOS
1383 /* Redirect file descriptors and clear the close-on-exec flag on the
1384 redirected ones. IN, OUT, and ERR are close-on-exec so they
1385 need not be closed explicitly. */
1386 dup2 (in, 0);
1387 dup2 (out, 1);
1388 dup2 (err, 2);
1390 setpgid (0, 0);
1391 tcsetpgrp (0, pid);
1393 execve (new_argv[0], new_argv, env);
1394 exec_failed (new_argv[0], errno);
1396 #else /* MSDOS */
1397 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1398 xfree (pwd_var);
1399 if (pid == -1)
1400 /* An error occurred while trying to run the subprocess. */
1401 report_file_error ("Spawning child process", Qnil);
1402 return pid;
1403 #endif /* MSDOS */
1404 #endif /* not WINDOWSNT */
1407 #ifndef WINDOWSNT
1408 /* Move the file descriptor FD so that its number is not less than MINFD.
1409 If the file descriptor is moved at all, the original is closed on MSDOS,
1410 but not elsewhere as the caller will close it anyway. */
1411 static int
1412 relocate_fd (int fd, int minfd)
1414 if (fd >= minfd)
1415 return fd;
1416 else
1418 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1419 if (new == -1)
1421 emacs_perror ("while setting up child");
1422 _exit (EXIT_CANCELED);
1424 #ifdef MSDOS
1425 emacs_close (fd);
1426 #endif
1427 return new;
1430 #endif /* not WINDOWSNT */
1432 static bool
1433 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1434 ptrdiff_t *valuelen, Lisp_Object env)
1436 for (; CONSP (env); env = XCDR (env))
1438 Lisp_Object entry = XCAR (env);
1439 if (STRINGP (entry)
1440 && SBYTES (entry) >= varlen
1441 #ifdef WINDOWSNT
1442 /* NT environment variables are case insensitive. */
1443 && ! strnicmp (SDATA (entry), var, varlen)
1444 #else /* not WINDOWSNT */
1445 && ! memcmp (SDATA (entry), var, varlen)
1446 #endif /* not WINDOWSNT */
1449 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1451 *value = SSDATA (entry) + (varlen + 1);
1452 *valuelen = SBYTES (entry) - (varlen + 1);
1453 return 1;
1455 else if (SBYTES (entry) == varlen)
1457 /* Lone variable names in Vprocess_environment mean that
1458 variable should be removed from the environment. */
1459 *value = NULL;
1460 return 1;
1464 return 0;
1467 static bool
1468 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1469 ptrdiff_t *valuelen, Lisp_Object frame)
1471 /* Try to find VAR in Vprocess_environment first. */
1472 if (getenv_internal_1 (var, varlen, value, valuelen,
1473 Vprocess_environment))
1474 return *value ? 1 : 0;
1476 /* For DISPLAY try to get the values from the frame or the initial env. */
1477 if (strcmp (var, "DISPLAY") == 0)
1479 Lisp_Object display
1480 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1481 if (STRINGP (display))
1483 *value = SSDATA (display);
1484 *valuelen = SBYTES (display);
1485 return 1;
1487 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1488 if (getenv_internal_1 (var, varlen, value, valuelen,
1489 Vinitial_environment))
1490 return *value ? 1 : 0;
1493 return 0;
1496 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1497 doc: /* Get the value of environment variable VARIABLE.
1498 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1499 the environment. Otherwise, value is a string.
1501 This function searches `process-environment' for VARIABLE.
1503 If optional parameter ENV is a list, then search this list instead of
1504 `process-environment', and return t when encountering a negative entry
1505 \(an entry for a variable with no value). */)
1506 (Lisp_Object variable, Lisp_Object env)
1508 char *value;
1509 ptrdiff_t valuelen;
1511 CHECK_STRING (variable);
1512 if (CONSP (env))
1514 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1515 &value, &valuelen, env))
1516 return value ? make_string (value, valuelen) : Qt;
1517 else
1518 return Qnil;
1520 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1521 &value, &valuelen, env))
1522 return make_string (value, valuelen);
1523 else
1524 return Qnil;
1527 /* A version of getenv that consults the Lisp environment lists,
1528 easily callable from C. This is usually called from egetenv. */
1529 char *
1530 egetenv_internal (const char *var, ptrdiff_t len)
1532 char *value;
1533 ptrdiff_t valuelen;
1535 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1536 return value;
1537 else
1538 return 0;
1542 /* This is run before init_cmdargs. */
1544 void
1545 init_callproc_1 (void)
1547 #ifdef HAVE_NS
1548 const char *etc_dir = ns_etc_directory ();
1549 const char *path_exec = ns_exec_path ();
1550 #endif
1552 Vdata_directory = decode_env_path ("EMACSDATA",
1553 #ifdef HAVE_NS
1554 etc_dir ? etc_dir :
1555 #endif
1556 PATH_DATA, 0);
1557 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1559 Vdoc_directory = decode_env_path ("EMACSDOC",
1560 #ifdef HAVE_NS
1561 etc_dir ? etc_dir :
1562 #endif
1563 PATH_DOC, 0);
1564 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1566 /* Check the EMACSPATH environment variable, defaulting to the
1567 PATH_EXEC path from epaths.h. */
1568 Vexec_path = decode_env_path ("EMACSPATH",
1569 #ifdef HAVE_NS
1570 path_exec ? path_exec :
1571 #endif
1572 PATH_EXEC, 0);
1573 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1574 /* FIXME? For ns, path_exec should go at the front? */
1575 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1578 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1580 void
1581 init_callproc (void)
1583 bool data_dir = egetenv ("EMACSDATA") != 0;
1585 char *sh;
1586 Lisp_Object tempdir;
1587 #ifdef HAVE_NS
1588 if (data_dir == 0)
1589 data_dir = ns_etc_directory () != 0;
1590 #endif
1592 if (!NILP (Vinstallation_directory))
1594 /* Add to the path the lib-src subdir of the installation dir. */
1595 Lisp_Object tem;
1596 tem = Fexpand_file_name (build_string ("lib-src"),
1597 Vinstallation_directory);
1598 #ifndef MSDOS
1599 /* MSDOS uses wrapped binaries, so don't do this. */
1600 if (NILP (Fmember (tem, Vexec_path)))
1602 #ifdef HAVE_NS
1603 const char *path_exec = ns_exec_path ();
1604 #endif
1605 Vexec_path = decode_env_path ("EMACSPATH",
1606 #ifdef HAVE_NS
1607 path_exec ? path_exec :
1608 #endif
1609 PATH_EXEC, 0);
1610 Vexec_path = Fcons (tem, Vexec_path);
1611 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1614 Vexec_directory = Ffile_name_as_directory (tem);
1615 #endif /* not MSDOS */
1617 /* Maybe use ../etc as well as ../lib-src. */
1618 if (data_dir == 0)
1620 tem = Fexpand_file_name (build_string ("etc"),
1621 Vinstallation_directory);
1622 Vdoc_directory = Ffile_name_as_directory (tem);
1626 /* Look for the files that should be in etc. We don't use
1627 Vinstallation_directory, because these files are never installed
1628 near the executable, and they are never in the build
1629 directory when that's different from the source directory.
1631 Instead, if these files are not in the nominal place, we try the
1632 source directory. */
1633 if (data_dir == 0)
1635 Lisp_Object tem, tem1, srcdir;
1636 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1638 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1640 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1641 tem1 = Ffile_exists_p (tem);
1642 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1644 Lisp_Object newdir;
1645 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1646 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1647 tem1 = Ffile_exists_p (tem);
1648 if (!NILP (tem1))
1649 Vdata_directory = newdir;
1653 #ifndef CANNOT_DUMP
1654 if (initialized)
1655 #endif
1657 tempdir = Fdirectory_file_name (Vexec_directory);
1658 if (! file_accessible_directory_p (tempdir))
1659 dir_warning ("arch-dependent data dir", Vexec_directory);
1662 tempdir = Fdirectory_file_name (Vdata_directory);
1663 if (! file_accessible_directory_p (tempdir))
1664 dir_warning ("arch-independent data dir", Vdata_directory);
1666 sh = getenv ("SHELL");
1667 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1669 #ifdef DOS_NT
1670 Vshared_game_score_directory = Qnil;
1671 #else
1672 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1673 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1674 Vshared_game_score_directory = Qnil;
1675 #endif
1678 void
1679 set_initial_environment (void)
1681 char **envp;
1682 for (envp = environ; *envp; envp++)
1683 Vprocess_environment = Fcons (build_string (*envp),
1684 Vprocess_environment);
1685 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1686 to use `delete' and friends on process-environment. */
1687 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1690 void
1691 syms_of_callproc (void)
1693 #ifndef DOS_NT
1694 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1695 #else /* DOS_NT */
1696 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1697 #endif
1698 staticpro (&Vtemp_file_name_pattern);
1700 #ifdef MSDOS
1701 synch_process_tempfile = make_number (0);
1702 staticpro (&synch_process_tempfile);
1703 #endif
1705 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1706 doc: /* File name to load inferior shells from.
1707 Initialized from the SHELL environment variable, or to a system-dependent
1708 default if SHELL is not set. */);
1710 DEFVAR_LISP ("exec-path", Vexec_path,
1711 doc: /* List of directories to search programs to run in subprocesses.
1712 Each element is a string (directory name) or nil (try default directory).
1714 By default the last element of this list is `exec-directory'. The
1715 last element is not always used, for example in shell completion
1716 (`shell-dynamic-complete-command'). */);
1718 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1719 doc: /* List of suffixes to try to find executable file names.
1720 Each element is a string. */);
1721 Vexec_suffixes = Qnil;
1723 DEFVAR_LISP ("exec-directory", Vexec_directory,
1724 doc: /* Directory for executables for Emacs to invoke.
1725 More generally, this includes any architecture-dependent files
1726 that are built and installed from the Emacs distribution. */);
1728 DEFVAR_LISP ("data-directory", Vdata_directory,
1729 doc: /* Directory of machine-independent files that come with GNU Emacs.
1730 These are files intended for Emacs to use while it runs. */);
1732 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1733 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1734 This is usually the same as `data-directory'. */);
1736 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1737 doc: /* For internal use by the build procedure only.
1738 This is the name of the directory in which the build procedure installed
1739 Emacs's info files; the default value for `Info-default-directory-list'
1740 includes this. */);
1741 Vconfigure_info_directory = build_string (PATH_INFO);
1743 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1744 doc: /* Directory of score files for games which come with GNU Emacs.
1745 If this variable is nil, then Emacs is unable to use a shared directory. */);
1746 #ifdef DOS_NT
1747 Vshared_game_score_directory = Qnil;
1748 #else
1749 Vshared_game_score_directory = build_string (PATH_GAME);
1750 #endif
1752 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1753 doc: /* List of environment variables inherited from the parent process.
1754 Each element should be a string of the form ENVVARNAME=VALUE.
1755 The elements must normally be decoded (using `locale-coding-system') for use. */);
1756 Vinitial_environment = Qnil;
1758 DEFVAR_LISP ("process-environment", Vprocess_environment,
1759 doc: /* List of overridden environment variables for subprocesses to inherit.
1760 Each element should be a string of the form ENVVARNAME=VALUE.
1762 Entries in this list take precedence to those in the frame-local
1763 environments. Therefore, let-binding `process-environment' is an easy
1764 way to temporarily change the value of an environment variable,
1765 irrespective of where it comes from. To use `process-environment' to
1766 remove an environment variable, include only its name in the list,
1767 without "=VALUE".
1769 This variable is set to nil when Emacs starts.
1771 If multiple entries define the same variable, the first one always
1772 takes precedence.
1774 Non-ASCII characters are encoded according to the initial value of
1775 `locale-coding-system', i.e. the elements must normally be decoded for
1776 use.
1778 See `setenv' and `getenv'. */);
1779 Vprocess_environment = Qnil;
1781 defsubr (&Scall_process);
1782 defsubr (&Sgetenv_internal);
1783 defsubr (&Scall_process_region);