Add xref-pulse-on-jump
[emacs.git] / src / callproc.c
blob12c81439fe4f8dfaf62c63ab66d45818456db0ac
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2015 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 and encode it. */
135 dir = ENCODE_FILE (remove_slash_colon (dir));
137 if (! file_accessible_directory_p (dir))
138 report_file_error ("Setting current directory",
139 BVAR (current_buffer, directory));
141 RETURN_UNGCPRO (dir);
144 /* If P is reapable, record it as a deleted process and kill it.
145 Do this in a critical section. Unless PID is wedged it will be
146 reaped on receipt of the first SIGCHLD after the critical section. */
148 void
149 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
151 #ifndef MSDOS
152 sigset_t oldset;
153 block_child_signal (&oldset);
155 if (p->alive)
157 record_deleted_pid (p->pid, tempfile);
158 p->alive = 0;
159 kill (- p->pid, SIGKILL);
162 unblock_child_signal (&oldset);
163 #endif /* !MSDOS */
166 /* Clean up files, file descriptors and processes created by Fcall_process. */
168 static void
169 delete_temp_file (Lisp_Object name)
171 unlink (SSDATA (name));
174 static void
175 call_process_kill (void *ptr)
177 int *callproc_fd = ptr;
178 int i;
179 for (i = 0; i < CALLPROC_FDS; i++)
180 if (0 <= callproc_fd[i])
181 emacs_close (callproc_fd[i]);
183 if (synch_process_pid)
185 struct Lisp_Process proc;
186 proc.alive = 1;
187 proc.pid = synch_process_pid;
188 record_kill_process (&proc, synch_process_tempfile);
189 synch_process_pid = 0;
191 else if (STRINGP (synch_process_tempfile))
192 delete_temp_file (synch_process_tempfile);
195 /* Clean up when exiting Fcall_process: restore the buffer, and
196 kill the subsidiary process group if the process still exists. */
198 static void
199 call_process_cleanup (Lisp_Object buffer)
201 Fset_buffer (buffer);
203 #ifndef MSDOS
204 if (synch_process_pid)
206 kill (-synch_process_pid, SIGINT);
207 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
208 immediate_quit = 1;
209 QUIT;
210 wait_for_termination (synch_process_pid, 0, 1);
211 synch_process_pid = 0;
212 immediate_quit = 0;
213 message1 ("Waiting for process to die...done");
215 #endif /* !MSDOS */
218 #ifdef DOS_NT
219 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
220 #else
221 static mode_t const default_output_mode = 0666;
222 #endif
224 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
225 doc: /* Call PROGRAM synchronously in separate process.
226 The remaining arguments are optional.
227 The program's input comes from file INFILE (nil means `/dev/null').
228 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
229 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
230 FILE is a file name string, means that it should be written to that file
231 \(if the file already exists it is overwritten).
232 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
233 REAL-BUFFER says what to do with standard output, as above,
234 while STDERR-FILE says what to do with standard error in the child.
235 STDERR-FILE may be nil (discard standard error output),
236 t (mix it with ordinary output), or a file name string.
238 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
239 Remaining arguments are strings passed as command arguments to PROGRAM.
241 If executable PROGRAM can't be found as an executable, `call-process'
242 signals a Lisp error. `call-process' reports errors in execution of
243 the program only through its return and output.
245 If DESTINATION is 0, `call-process' returns immediately with value nil.
246 Otherwise it waits for PROGRAM to terminate
247 and returns a numeric exit status or a signal description string.
248 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
250 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
251 (ptrdiff_t nargs, Lisp_Object *args)
253 Lisp_Object infile, encoded_infile;
254 int filefd;
255 struct gcpro gcpro1;
256 ptrdiff_t count = SPECPDL_INDEX ();
258 if (nargs >= 2 && ! NILP (args[1]))
260 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
261 CHECK_STRING (infile);
263 else
264 infile = build_string (NULL_DEVICE);
266 GCPRO1 (infile);
267 encoded_infile = ENCODE_FILE (infile);
269 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
270 if (filefd < 0)
271 report_file_error ("Opening process input file", infile);
272 record_unwind_protect_int (close_file_unwind, filefd);
273 UNGCPRO;
274 return unbind_to (count, call_process (nargs, args, filefd, -1));
277 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
279 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
280 unwinder that is intended to remove the input temporary file; in
281 this case NARGS must be at least 2 and ARGS[1] is the file's name.
283 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
285 static Lisp_Object
286 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
287 ptrdiff_t tempfile_index)
289 Lisp_Object buffer, current_dir, path;
290 bool display_p;
291 int fd0;
292 int callproc_fd[CALLPROC_FDS];
293 int status;
294 ptrdiff_t i;
295 ptrdiff_t count = SPECPDL_INDEX ();
296 USE_SAFE_ALLOCA;
298 char **new_argv;
299 /* File to use for stderr in the child.
300 t means use same as standard output. */
301 Lisp_Object error_file;
302 Lisp_Object output_file = Qnil;
303 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
304 char *tempfile = NULL;
305 int pid;
306 #else
307 sigset_t oldset;
308 pid_t pid;
309 #endif
310 int child_errno;
311 int fd_output, fd_error;
312 struct coding_system process_coding; /* coding-system of process output */
313 struct coding_system argument_coding; /* coding-system of arguments */
314 /* Set to the return value of Ffind_operation_coding_system. */
315 Lisp_Object coding_systems;
316 bool discard_output;
318 if (synch_process_pid)
319 error ("call-process invoked recursively");
321 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
322 coding_systems = Qt;
324 CHECK_STRING (args[0]);
326 error_file = Qt;
328 #ifndef subprocesses
329 /* Without asynchronous processes we cannot have BUFFER == 0. */
330 if (nargs >= 3
331 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
332 error ("Operating system cannot handle asynchronous subprocesses");
333 #endif /* subprocesses */
335 /* Decide the coding-system for giving arguments. */
337 Lisp_Object val, *args2;
339 /* If arguments are supplied, we may have to encode them. */
340 if (nargs >= 5)
342 bool must_encode = 0;
343 Lisp_Object coding_attrs;
345 for (i = 4; i < nargs; i++)
346 CHECK_STRING (args[i]);
348 for (i = 4; i < nargs; i++)
349 if (STRING_MULTIBYTE (args[i]))
350 must_encode = 1;
352 if (!NILP (Vcoding_system_for_write))
353 val = Vcoding_system_for_write;
354 else if (! must_encode)
355 val = Qraw_text;
356 else
358 SAFE_NALLOCA (args2, 1, nargs + 1);
359 args2[0] = Qcall_process;
360 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
361 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
362 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
364 val = complement_process_encoding_system (val);
365 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
366 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
367 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
369 /* We should not use an ASCII incompatible coding system. */
370 val = raw_text_coding_system (val);
371 setup_coding_system (val, &argument_coding);
376 if (nargs < 3)
377 buffer = Qnil;
378 else
380 buffer = args[2];
382 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
383 FILE-FOR-STDERR), unless the first element is :file, in which case see
384 the next paragraph. */
385 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
387 if (CONSP (XCDR (buffer)))
389 Lisp_Object stderr_file;
390 stderr_file = XCAR (XCDR (buffer));
392 if (NILP (stderr_file) || EQ (Qt, stderr_file))
393 error_file = stderr_file;
394 else
395 error_file = Fexpand_file_name (stderr_file, Qnil);
398 buffer = XCAR (buffer);
401 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
402 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
404 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
405 BVAR (current_buffer, directory));
406 CHECK_STRING (output_file);
407 buffer = Qnil;
410 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
412 Lisp_Object spec_buffer;
413 spec_buffer = buffer;
414 buffer = Fget_buffer_create (buffer);
415 /* Mention the buffer name for a better error message. */
416 if (NILP (buffer))
417 CHECK_BUFFER (spec_buffer);
418 CHECK_BUFFER (buffer);
422 /* Make sure that the child will be able to chdir to the current
423 buffer's current directory, or its unhandled equivalent. We
424 can't just have the child check for an error when it does the
425 chdir, since it's in a vfork.
427 We have to GCPRO around this because Fexpand_file_name,
428 Funhandled_file_name_directory, and Ffile_accessible_directory_p
429 might call a file name handling function. The argument list is
430 protected by the caller, so all we really have to worry about is
431 buffer. */
433 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
435 current_dir = encode_current_directory ();
437 GCPRO4 (buffer, current_dir, error_file, output_file);
439 if (STRINGP (error_file))
440 error_file = ENCODE_FILE (error_file);
441 if (STRINGP (output_file))
442 output_file = ENCODE_FILE (output_file);
443 UNGCPRO;
446 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
448 for (i = 0; i < CALLPROC_FDS; i++)
449 callproc_fd[i] = -1;
450 #ifdef MSDOS
451 synch_process_tempfile = make_number (0);
452 #endif
453 record_unwind_protect_ptr (call_process_kill, callproc_fd);
455 /* Search for program; barf if not found. */
457 struct gcpro gcpro1, gcpro2, gcpro3;
458 int ok;
460 GCPRO3 (buffer, current_dir, error_file);
461 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
462 make_number (X_OK), false);
463 UNGCPRO;
464 if (ok < 0)
465 report_file_error ("Searching for program", args[0]);
468 /* Remove "/:" from PATH. */
469 path = remove_slash_colon (path);
471 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
474 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
476 GCPRO4 (buffer, current_dir, path, error_file);
477 if (nargs > 4)
479 ptrdiff_t i;
481 argument_coding.dst_multibyte = 0;
482 for (i = 4; i < nargs; i++)
484 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
485 if (CODING_REQUIRE_ENCODING (&argument_coding))
486 /* We must encode this argument. */
487 args[i] = encode_coding_string (&argument_coding, args[i], 1);
489 for (i = 4; i < nargs; i++)
490 new_argv[i - 3] = SSDATA (args[i]);
491 new_argv[i - 3] = 0;
493 else
494 new_argv[1] = 0;
495 path = ENCODE_FILE (path);
496 new_argv[0] = SSDATA (path);
497 UNGCPRO;
500 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
502 #ifdef MSDOS
503 if (! discard_output && ! STRINGP (output_file))
505 char const *tmpdir = egetenv ("TMPDIR");
506 char const *outf = tmpdir ? tmpdir : "";
507 tempfile = alloca (strlen (outf) + 20);
508 strcpy (tempfile, outf);
509 dostounix_filename (tempfile);
510 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
511 strcat (tempfile, "/");
512 strcat (tempfile, "emXXXXXX");
513 mktemp (tempfile);
514 if (!*tempfile)
515 report_file_error ("Opening process output file", Qnil);
516 output_file = build_string (tempfile);
517 synch_process_tempfile = output_file;
519 #endif
521 if (discard_output)
523 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
524 if (fd_output < 0)
525 report_file_error ("Opening null device", Qnil);
527 else if (STRINGP (output_file))
529 fd_output = emacs_open (SSDATA (output_file),
530 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
531 default_output_mode);
532 if (fd_output < 0)
534 int open_errno = errno;
535 output_file = DECODE_FILE (output_file);
536 report_file_errno ("Opening process output file",
537 output_file, open_errno);
540 else
542 int fd[2];
543 if (emacs_pipe (fd) != 0)
544 report_file_error ("Creating process pipe", Qnil);
545 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
546 fd_output = fd[1];
548 callproc_fd[CALLPROC_STDOUT] = fd_output;
550 fd_error = fd_output;
552 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
554 fd_error = emacs_open ((STRINGP (error_file)
555 ? SSDATA (error_file)
556 : NULL_DEVICE),
557 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
558 default_output_mode);
559 if (fd_error < 0)
561 int open_errno = errno;
562 report_file_errno ("Cannot redirect stderr",
563 (STRINGP (error_file)
564 ? DECODE_FILE (error_file)
565 : build_string (NULL_DEVICE)),
566 open_errno);
568 callproc_fd[CALLPROC_STDERR] = fd_error;
571 #ifdef MSDOS /* MW, July 1993 */
572 /* Note that on MSDOS `child_setup' actually returns the child process
573 exit status, not its PID, so assign it to status below. */
574 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
576 if (pid < 0)
578 child_errno = errno;
579 unbind_to (count, Qnil);
580 synchronize_system_messages_locale ();
581 return
582 code_convert_string_norecord (build_string (strerror (child_errno)),
583 Vlocale_coding_system, 0);
585 status = pid;
587 for (i = 0; i < CALLPROC_FDS; i++)
588 if (0 <= callproc_fd[i])
590 emacs_close (callproc_fd[i]);
591 callproc_fd[i] = -1;
593 emacs_close (filefd);
594 clear_unwind_protect (count - 1);
596 if (tempfile)
598 /* Since CRLF is converted to LF within `decode_coding', we
599 can always open a file with binary mode. */
600 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
601 O_RDONLY | O_BINARY, 0);
602 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
604 int open_errno = errno;
605 report_file_errno ("Cannot re-open temporary file",
606 build_string (tempfile), open_errno);
610 #endif /* MSDOS */
612 /* Do the unwind-protect now, even though the pid is not known, so
613 that no storage allocation is done in the critical section.
614 The actual PID will be filled in during the critical section. */
615 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
617 #ifndef MSDOS
619 block_input ();
620 block_child_signal (&oldset);
622 #ifdef WINDOWSNT
623 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
624 #else /* not WINDOWSNT */
626 /* vfork, and prevent local vars from being clobbered by the vfork. */
628 Lisp_Object volatile buffer_volatile = buffer;
629 Lisp_Object volatile coding_systems_volatile = coding_systems;
630 Lisp_Object volatile current_dir_volatile = current_dir;
631 bool volatile display_p_volatile = display_p;
632 bool volatile sa_must_free_volatile = sa_must_free;
633 int volatile fd_error_volatile = fd_error;
634 int volatile filefd_volatile = filefd;
635 ptrdiff_t volatile count_volatile = count;
636 ptrdiff_t volatile sa_avail_volatile = sa_avail;
637 ptrdiff_t volatile sa_count_volatile = sa_count;
638 char **volatile new_argv_volatile = new_argv;
639 int volatile callproc_fd_volatile[CALLPROC_FDS];
640 for (i = 0; i < CALLPROC_FDS; i++)
641 callproc_fd_volatile[i] = callproc_fd[i];
643 pid = vfork ();
645 buffer = buffer_volatile;
646 coding_systems = coding_systems_volatile;
647 current_dir = current_dir_volatile;
648 display_p = display_p_volatile;
649 sa_must_free = sa_must_free_volatile;
650 fd_error = fd_error_volatile;
651 filefd = filefd_volatile;
652 count = count_volatile;
653 sa_avail = sa_avail_volatile;
654 sa_count = sa_count_volatile;
655 new_argv = new_argv_volatile;
657 for (i = 0; i < CALLPROC_FDS; i++)
658 callproc_fd[i] = callproc_fd_volatile[i];
659 fd_output = callproc_fd[CALLPROC_STDOUT];
662 if (pid == 0)
664 unblock_child_signal (&oldset);
666 setsid ();
668 /* Emacs ignores SIGPIPE, but the child should not. */
669 signal (SIGPIPE, SIG_DFL);
670 /* Likewise for SIGPROF. */
671 #ifdef SIGPROF
672 signal (SIGPROF, SIG_DFL);
673 #endif
675 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
678 #endif /* not WINDOWSNT */
680 child_errno = errno;
682 if (pid > 0)
684 synch_process_pid = pid;
686 if (INTEGERP (buffer))
688 if (tempfile_index < 0)
689 record_deleted_pid (pid, Qnil);
690 else
692 eassert (1 < nargs);
693 record_deleted_pid (pid, args[1]);
694 clear_unwind_protect (tempfile_index);
696 synch_process_pid = 0;
700 unblock_child_signal (&oldset);
701 unblock_input ();
703 if (pid < 0)
704 report_file_errno ("Doing vfork", Qnil, child_errno);
706 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
707 since we will use that to read input from. */
708 for (i = 0; i < CALLPROC_FDS; i++)
709 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
711 emacs_close (callproc_fd[i]);
712 callproc_fd[i] = -1;
714 emacs_close (filefd);
715 clear_unwind_protect (count - 1);
717 #endif /* not MSDOS */
719 if (INTEGERP (buffer))
720 return unbind_to (count, Qnil);
722 if (BUFFERP (buffer))
723 Fset_buffer (buffer);
725 fd0 = callproc_fd[CALLPROC_PIPEREAD];
727 if (0 <= fd0)
729 Lisp_Object val, *args2;
731 val = Qnil;
732 if (!NILP (Vcoding_system_for_read))
733 val = Vcoding_system_for_read;
734 else
736 if (EQ (coding_systems, Qt))
738 ptrdiff_t i;
740 SAFE_NALLOCA (args2, 1, nargs + 1);
741 args2[0] = Qcall_process;
742 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
743 coding_systems
744 = Ffind_operation_coding_system (nargs + 1, args2);
746 if (CONSP (coding_systems))
747 val = XCAR (coding_systems);
748 else if (CONSP (Vdefault_process_coding_system))
749 val = XCAR (Vdefault_process_coding_system);
750 else
751 val = Qnil;
753 Fcheck_coding_system (val);
754 /* In unibyte mode, character code conversion should not take
755 place but EOL conversion should. So, setup raw-text or one
756 of the subsidiary according to the information just setup. */
757 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
758 && !NILP (val))
759 val = raw_text_coding_system (val);
760 setup_coding_system (val, &process_coding);
761 process_coding.dst_multibyte
762 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
763 process_coding.src_multibyte = 0;
766 immediate_quit = 1;
767 QUIT;
769 if (0 <= fd0)
771 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
772 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
773 char buf[CALLPROC_BUFFER_SIZE_MAX];
774 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
775 int nread;
776 EMACS_INT total_read = 0;
777 int carryover = 0;
778 bool display_on_the_fly = display_p;
779 struct coding_system saved_coding = process_coding;
781 while (1)
783 /* Repeatedly read until we've filled as much as possible
784 of the buffer size we have. But don't read
785 less than 1024--save that for the next bufferful. */
786 nread = carryover;
787 while (nread < bufsize - 1024)
789 int this_read = emacs_read (fd0, buf + nread,
790 bufsize - nread);
792 if (this_read < 0)
793 goto give_up;
795 if (this_read == 0)
797 process_coding.mode |= CODING_MODE_LAST_BLOCK;
798 break;
801 nread += this_read;
802 total_read += this_read;
804 if (display_on_the_fly)
805 break;
808 /* Now NREAD is the total amount of data in the buffer. */
809 immediate_quit = 0;
811 if (!nread)
813 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
814 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
815 insert_1_both (buf, nread, nread, 0, 1, 0);
816 else
817 { /* We have to decode the input. */
818 Lisp_Object curbuf;
819 ptrdiff_t count1 = SPECPDL_INDEX ();
821 XSETBUFFER (curbuf, current_buffer);
822 /* FIXME: Call signal_after_change! */
823 prepare_to_modify_buffer (PT, PT, NULL);
824 /* We cannot allow after-change-functions be run
825 during decoding, because that might modify the
826 buffer, while we rely on process_coding.produced to
827 faithfully reflect inserted text until we
828 TEMP_SET_PT_BOTH below. */
829 specbind (Qinhibit_modification_hooks, Qt);
830 decode_coding_c_string (&process_coding,
831 (unsigned char *) buf, nread, curbuf);
832 unbind_to (count1, Qnil);
833 if (display_on_the_fly
834 && CODING_REQUIRE_DETECTION (&saved_coding)
835 && ! CODING_REQUIRE_DETECTION (&process_coding))
837 /* We have detected some coding system, but the
838 detection may have been via insufficient data.
839 So give up displaying on the fly. */
840 if (process_coding.produced > 0)
841 del_range_2 (process_coding.dst_pos,
842 process_coding.dst_pos_byte,
843 (process_coding.dst_pos
844 + process_coding.produced_char),
845 (process_coding.dst_pos_byte
846 + process_coding.produced),
848 display_on_the_fly = false;
849 process_coding = saved_coding;
850 carryover = nread;
851 /* Make the above condition always fail in the future. */
852 saved_coding.common_flags
853 &= ~CODING_REQUIRE_DETECTION_MASK;
854 continue;
857 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
858 PT_BYTE + process_coding.produced);
859 carryover = process_coding.carryover_bytes;
860 if (carryover > 0)
861 memcpy (buf, process_coding.carryover,
862 process_coding.carryover_bytes);
865 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
866 break;
868 /* Make the buffer bigger as we continue to read more data,
869 but not past CALLPROC_BUFFER_SIZE_MAX. */
870 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
871 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
872 bufsize = CALLPROC_BUFFER_SIZE_MAX;
874 if (display_p)
876 redisplay_preserve_echo_area (1);
877 /* This variable might have been set to 0 for code
878 detection. In that case, set it back to 1 because
879 we should have already detected a coding system. */
880 display_on_the_fly = true;
882 immediate_quit = true;
883 QUIT;
885 give_up: ;
887 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
888 /* If the caller required, let the buffer inherit the
889 coding-system used to decode the process output. */
890 if (inherit_process_coding_system)
891 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
892 make_number (total_read));
895 #ifndef MSDOS
896 /* Wait for it to terminate, unless it already has. */
897 wait_for_termination (pid, &status, fd0 < 0);
898 #endif
900 immediate_quit = 0;
902 /* Don't kill any children that the subprocess may have left behind
903 when exiting. */
904 synch_process_pid = 0;
906 SAFE_FREE ();
907 unbind_to (count, Qnil);
909 if (WIFSIGNALED (status))
911 const char *signame;
913 synchronize_system_messages_locale ();
914 signame = strsignal (WTERMSIG (status));
916 if (signame == 0)
917 signame = "unknown";
919 return code_convert_string_norecord (build_string (signame),
920 Vlocale_coding_system, 0);
923 eassert (WIFEXITED (status));
924 return make_number (WEXITSTATUS (status));
927 /* Create a temporary file suitable for storing the input data of
928 call-process-region. NARGS and ARGS are the same as for
929 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
930 naming the file, and return a file descriptor for reading.
931 Unwind-protect the file, so that the file descriptor will be closed
932 and the file removed when the caller unwinds the specpdl stack. */
934 static int
935 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
936 Lisp_Object *filename_string_ptr)
938 int fd;
939 struct gcpro gcpro1;
940 Lisp_Object filename_string;
941 Lisp_Object val, start, end;
942 Lisp_Object tmpdir;
944 if (STRINGP (Vtemporary_file_directory))
945 tmpdir = Vtemporary_file_directory;
946 else
948 char *outf;
949 #ifndef DOS_NT
950 outf = getenv ("TMPDIR");
951 tmpdir = build_string (outf ? outf : "/tmp/");
952 #else /* DOS_NT */
953 if ((outf = egetenv ("TMPDIR"))
954 || (outf = egetenv ("TMP"))
955 || (outf = egetenv ("TEMP")))
956 tmpdir = build_string (outf);
957 else
958 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
959 #endif
963 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
964 char *tempfile;
965 ptrdiff_t count;
967 #ifdef WINDOWSNT
968 /* Cannot use the result of Fexpand_file_name, because it
969 downcases the XXXXXX part of the pattern, and mktemp then
970 doesn't recognize it. */
971 if (!NILP (Vw32_downcase_file_names))
973 Lisp_Object dirname = Ffile_name_directory (pattern);
975 if (NILP (dirname))
976 pattern = Vtemp_file_name_pattern;
977 else
978 pattern = concat2 (dirname, Vtemp_file_name_pattern);
980 #endif
982 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
983 GCPRO1 (filename_string);
984 tempfile = SSDATA (filename_string);
986 count = SPECPDL_INDEX ();
987 record_unwind_protect_nothing ();
988 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
989 if (fd < 0)
990 report_file_error ("Failed to open temporary file using pattern",
991 pattern);
992 set_unwind_protect (count, delete_temp_file, filename_string);
993 record_unwind_protect_int (close_file_unwind, fd);
996 start = args[0];
997 end = args[1];
998 /* Decide coding-system of the contents of the temporary file. */
999 if (!NILP (Vcoding_system_for_write))
1000 val = Vcoding_system_for_write;
1001 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1002 val = Qraw_text;
1003 else
1005 Lisp_Object coding_systems;
1006 Lisp_Object *args2;
1007 USE_SAFE_ALLOCA;
1008 SAFE_NALLOCA (args2, 1, nargs + 1);
1009 args2[0] = Qcall_process_region;
1010 memcpy (args2 + 1, args, nargs * sizeof *args);
1011 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1012 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1013 SAFE_FREE ();
1015 val = complement_process_encoding_system (val);
1018 ptrdiff_t count1 = SPECPDL_INDEX ();
1020 specbind (intern ("coding-system-for-write"), val);
1021 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1022 happen to get a ".Z" suffix. */
1023 specbind (Qfile_name_handler_alist, Qnil);
1024 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
1026 unbind_to (count1, Qnil);
1029 if (lseek (fd, 0, SEEK_SET) < 0)
1030 report_file_error ("Setting file position", filename_string);
1032 /* Note that Fcall_process takes care of binding
1033 coding-system-for-read. */
1035 *filename_string_ptr = filename_string;
1036 UNGCPRO;
1037 return fd;
1040 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1041 3, MANY, 0,
1042 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1043 The remaining arguments are optional.
1044 Delete the text if fourth arg DELETE is non-nil.
1046 Insert output in BUFFER before point; t means current buffer; nil for
1047 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1048 FILE)', where FILE is a file name string, means that it should be
1049 written to that file (if the file already exists it is overwritten).
1050 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1051 REAL-BUFFER says what to do with standard output, as above,
1052 while STDERR-FILE says what to do with standard error in the child.
1053 STDERR-FILE may be nil (discard standard error output),
1054 t (mix it with ordinary output), or a file name string.
1056 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1057 Remaining args are passed to PROGRAM at startup as command args.
1059 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1060 Otherwise it waits for PROGRAM to terminate
1061 and returns a numeric exit status or a signal description string.
1062 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1064 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1065 (ptrdiff_t nargs, Lisp_Object *args)
1067 struct gcpro gcpro1;
1068 Lisp_Object infile, val;
1069 ptrdiff_t count = SPECPDL_INDEX ();
1070 Lisp_Object start = args[0];
1071 Lisp_Object end = args[1];
1072 bool empty_input;
1073 int fd;
1075 if (STRINGP (start))
1076 empty_input = SCHARS (start) == 0;
1077 else if (NILP (start))
1078 empty_input = BEG == Z;
1079 else
1081 validate_region (&args[0], &args[1]);
1082 start = args[0];
1083 end = args[1];
1084 empty_input = XINT (start) == XINT (end);
1087 if (!empty_input)
1088 fd = create_temp_file (nargs, args, &infile);
1089 else
1091 infile = Qnil;
1092 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1093 if (fd < 0)
1094 report_file_error ("Opening null device", Qnil);
1095 record_unwind_protect_int (close_file_unwind, fd);
1098 GCPRO1 (infile);
1100 if (nargs > 3 && !NILP (args[3]))
1101 Fdelete_region (start, end);
1103 if (nargs > 3)
1105 args += 2;
1106 nargs -= 2;
1108 else
1110 args[0] = args[2];
1111 nargs = 2;
1113 args[1] = infile;
1115 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1116 RETURN_UNGCPRO (unbind_to (count, val));
1119 #ifndef WINDOWSNT
1120 static int relocate_fd (int fd, int minfd);
1121 #endif
1123 static char **
1124 add_env (char **env, char **new_env, char *string)
1126 char **ep;
1127 bool ok = 1;
1128 if (string == NULL)
1129 return new_env;
1131 /* See if this string duplicates any string already in the env.
1132 If so, don't put it in.
1133 When an env var has multiple definitions,
1134 we keep the definition that comes first in process-environment. */
1135 for (ep = env; ok && ep != new_env; ep++)
1137 char *p = *ep, *q = string;
1138 while (ok)
1140 if (*q != *p)
1141 break;
1142 if (*q == 0)
1143 /* The string is a lone variable name; keep it for now, we
1144 will remove it later. It is a placeholder for a
1145 variable that is not to be included in the environment. */
1146 break;
1147 if (*q == '=')
1148 ok = 0;
1149 p++, q++;
1152 if (ok)
1153 *new_env++ = string;
1154 return new_env;
1157 #ifndef DOS_NT
1159 /* 'exec' failed inside a child running NAME, with error number ERR.
1160 Possibly a vforked child needed to allocate a large vector on the
1161 stack; such a child cannot fall back on malloc because that might
1162 mess up the allocator's data structures in the parent.
1163 Report the error and exit the child. */
1165 static _Noreturn void
1166 exec_failed (char const *name, int err)
1168 /* Avoid deadlock if the child's perror writes to a full pipe; the
1169 pipe's reader is the parent, but with vfork the parent can't
1170 run until the child exits. Truncate the diagnostic instead. */
1171 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1173 errno = err;
1174 emacs_perror (name);
1175 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1178 #else
1180 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1181 fork and exec, and handle alloca exhaustion in a different way. */
1183 static void
1184 exec_failed (char const *name, int err)
1188 #endif
1190 /* This is the last thing run in a newly forked inferior
1191 either synchronous or asynchronous.
1192 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1193 Initialize inferior's priority, pgrp, connected dir and environment.
1194 then exec another program based on new_argv.
1196 If SET_PGRP, put the subprocess into a separate process group.
1198 CURRENT_DIR is an elisp string giving the path of the current
1199 directory the subprocess should have. Since we can't really signal
1200 a decent error from within the child, this should be verified as an
1201 executable directory by the parent. */
1204 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1205 Lisp_Object current_dir)
1207 char **env;
1208 char *pwd_var;
1209 #ifdef WINDOWSNT
1210 int cpid;
1211 HANDLE handles[3];
1212 #else
1213 pid_t pid = getpid ();
1214 #endif /* WINDOWSNT */
1216 /* Note that use of alloca is always safe here. It's obvious for systems
1217 that do not have true vfork or that have true (stack) alloca.
1218 If using vfork and C_ALLOCA (when Emacs used to include
1219 src/alloca.c) it is safe because that changes the superior's
1220 static variables as if the superior had done alloca and will be
1221 cleaned up in the usual way. */
1223 char *temp;
1224 ptrdiff_t i;
1226 i = SBYTES (current_dir);
1227 #ifdef MSDOS
1228 /* MSDOS must have all environment variables malloc'ed, because
1229 low-level libc functions that launch subsidiary processes rely
1230 on that. */
1231 pwd_var = xmalloc (i + 5);
1232 #else
1233 if (MAX_ALLOCA - 5 < i)
1234 exec_failed (new_argv[0], ENOMEM);
1235 pwd_var = alloca (i + 5);
1236 #endif
1237 temp = pwd_var + 4;
1238 memcpy (pwd_var, "PWD=", 4);
1239 lispstpcpy (temp, current_dir);
1241 #ifndef DOS_NT
1242 /* We can't signal an Elisp error here; we're in a vfork. Since
1243 the callers check the current directory before forking, this
1244 should only return an error if the directory's permissions
1245 are changed between the check and this chdir, but we should
1246 at least check. */
1247 if (chdir (temp) < 0)
1248 _exit (EXIT_CANCELED);
1249 #else /* DOS_NT */
1250 /* Get past the drive letter, so that d:/ is left alone. */
1251 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1253 temp += 2;
1254 i -= 2;
1256 #endif /* DOS_NT */
1258 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1259 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1260 temp[--i] = 0;
1263 /* Set `env' to a vector of the strings in the environment. */
1265 register Lisp_Object tem;
1266 register char **new_env;
1267 char **p, **q;
1268 register int new_length;
1269 Lisp_Object display = Qnil;
1271 new_length = 0;
1273 for (tem = Vprocess_environment;
1274 CONSP (tem) && STRINGP (XCAR (tem));
1275 tem = XCDR (tem))
1277 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1278 && (SDATA (XCAR (tem)) [7] == '\0'
1279 || SDATA (XCAR (tem)) [7] == '='))
1280 /* DISPLAY is specified in process-environment. */
1281 display = Qt;
1282 new_length++;
1285 /* If not provided yet, use the frame's DISPLAY. */
1286 if (NILP (display))
1288 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1289 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1290 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1291 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1292 Vinitial_environment);
1293 if (STRINGP (tmp))
1295 display = tmp;
1296 new_length++;
1300 /* new_length + 2 to include PWD and terminating 0. */
1301 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1302 exec_failed (new_argv[0], ENOMEM);
1303 env = new_env = alloca ((new_length + 2) * sizeof *env);
1304 /* If we have a PWD envvar, pass one down,
1305 but with corrected value. */
1306 if (egetenv ("PWD"))
1307 *new_env++ = pwd_var;
1309 if (STRINGP (display))
1311 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1312 exec_failed (new_argv[0], ENOMEM);
1313 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1314 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1315 new_env = add_env (env, new_env, vdata);
1318 /* Overrides. */
1319 for (tem = Vprocess_environment;
1320 CONSP (tem) && STRINGP (XCAR (tem));
1321 tem = XCDR (tem))
1322 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1324 *new_env = 0;
1326 /* Remove variable names without values. */
1327 p = q = env;
1328 while (*p != 0)
1330 while (*q != 0 && strchr (*q, '=') == NULL)
1331 q++;
1332 *p = *q++;
1333 if (*p != 0)
1334 p++;
1339 #ifdef WINDOWSNT
1340 prepare_standard_handles (in, out, err, handles);
1341 set_process_dir (SDATA (current_dir));
1342 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1343 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1344 reset_standard_handles (in, out, err, handles);
1345 if (cpid == -1)
1346 /* An error occurred while trying to spawn the process. */
1347 report_file_error ("Spawning child process", Qnil);
1348 return cpid;
1350 #else /* not WINDOWSNT */
1351 /* Make sure that in, out, and err are not actually already in
1352 descriptors zero, one, or two; this could happen if Emacs is
1353 started with its standard in, out, or error closed, as might
1354 happen under X. */
1356 int oin = in, oout = out;
1358 /* We have to avoid relocating the same descriptor twice! */
1360 in = relocate_fd (in, 3);
1362 if (out == oin)
1363 out = in;
1364 else
1365 out = relocate_fd (out, 3);
1367 if (err == oin)
1368 err = in;
1369 else if (err == oout)
1370 err = out;
1371 else
1372 err = relocate_fd (err, 3);
1375 #ifndef MSDOS
1376 /* Redirect file descriptors and clear the close-on-exec flag on the
1377 redirected ones. IN, OUT, and ERR are close-on-exec so they
1378 need not be closed explicitly. */
1379 dup2 (in, 0);
1380 dup2 (out, 1);
1381 dup2 (err, 2);
1383 setpgid (0, 0);
1384 tcsetpgrp (0, pid);
1386 execve (new_argv[0], new_argv, env);
1387 exec_failed (new_argv[0], errno);
1389 #else /* MSDOS */
1390 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1391 xfree (pwd_var);
1392 if (pid == -1)
1393 /* An error occurred while trying to run the subprocess. */
1394 report_file_error ("Spawning child process", Qnil);
1395 return pid;
1396 #endif /* MSDOS */
1397 #endif /* not WINDOWSNT */
1400 #ifndef WINDOWSNT
1401 /* Move the file descriptor FD so that its number is not less than MINFD.
1402 If the file descriptor is moved at all, the original is closed on MSDOS,
1403 but not elsewhere as the caller will close it anyway. */
1404 static int
1405 relocate_fd (int fd, int minfd)
1407 if (fd >= minfd)
1408 return fd;
1409 else
1411 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1412 if (new == -1)
1414 emacs_perror ("while setting up child");
1415 _exit (EXIT_CANCELED);
1417 #ifdef MSDOS
1418 emacs_close (fd);
1419 #endif
1420 return new;
1423 #endif /* not WINDOWSNT */
1425 static bool
1426 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1427 ptrdiff_t *valuelen, Lisp_Object env)
1429 for (; CONSP (env); env = XCDR (env))
1431 Lisp_Object entry = XCAR (env);
1432 if (STRINGP (entry)
1433 && SBYTES (entry) >= varlen
1434 #ifdef WINDOWSNT
1435 /* NT environment variables are case insensitive. */
1436 && ! strnicmp (SDATA (entry), var, varlen)
1437 #else /* not WINDOWSNT */
1438 && ! memcmp (SDATA (entry), var, varlen)
1439 #endif /* not WINDOWSNT */
1442 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1444 *value = SSDATA (entry) + (varlen + 1);
1445 *valuelen = SBYTES (entry) - (varlen + 1);
1446 return 1;
1448 else if (SBYTES (entry) == varlen)
1450 /* Lone variable names in Vprocess_environment mean that
1451 variable should be removed from the environment. */
1452 *value = NULL;
1453 return 1;
1457 return 0;
1460 static bool
1461 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1462 ptrdiff_t *valuelen, Lisp_Object frame)
1464 /* Try to find VAR in Vprocess_environment first. */
1465 if (getenv_internal_1 (var, varlen, value, valuelen,
1466 Vprocess_environment))
1467 return *value ? 1 : 0;
1469 /* For DISPLAY try to get the values from the frame or the initial env. */
1470 if (strcmp (var, "DISPLAY") == 0)
1472 Lisp_Object display
1473 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1474 if (STRINGP (display))
1476 *value = SSDATA (display);
1477 *valuelen = SBYTES (display);
1478 return 1;
1480 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1481 if (getenv_internal_1 (var, varlen, value, valuelen,
1482 Vinitial_environment))
1483 return *value ? 1 : 0;
1486 return 0;
1489 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1490 doc: /* Get the value of environment variable VARIABLE.
1491 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1492 the environment. Otherwise, value is a string.
1494 This function searches `process-environment' for VARIABLE.
1496 If optional parameter ENV is a list, then search this list instead of
1497 `process-environment', and return t when encountering a negative entry
1498 \(an entry for a variable with no value). */)
1499 (Lisp_Object variable, Lisp_Object env)
1501 char *value;
1502 ptrdiff_t valuelen;
1504 CHECK_STRING (variable);
1505 if (CONSP (env))
1507 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1508 &value, &valuelen, env))
1509 return value ? make_string (value, valuelen) : Qt;
1510 else
1511 return Qnil;
1513 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1514 &value, &valuelen, env))
1515 return make_string (value, valuelen);
1516 else
1517 return Qnil;
1520 /* A version of getenv that consults the Lisp environment lists,
1521 easily callable from C. This is usually called from egetenv. */
1522 char *
1523 egetenv_internal (const char *var, ptrdiff_t len)
1525 char *value;
1526 ptrdiff_t valuelen;
1528 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1529 return value;
1530 else
1531 return 0;
1535 /* This is run before init_cmdargs. */
1537 void
1538 init_callproc_1 (void)
1540 #ifdef HAVE_NS
1541 const char *etc_dir = ns_etc_directory ();
1542 const char *path_exec = ns_exec_path ();
1543 #endif
1545 Vdata_directory = decode_env_path ("EMACSDATA",
1546 #ifdef HAVE_NS
1547 etc_dir ? etc_dir :
1548 #endif
1549 PATH_DATA, 0);
1550 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1552 Vdoc_directory = decode_env_path ("EMACSDOC",
1553 #ifdef HAVE_NS
1554 etc_dir ? etc_dir :
1555 #endif
1556 PATH_DOC, 0);
1557 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1559 /* Check the EMACSPATH environment variable, defaulting to the
1560 PATH_EXEC path from epaths.h. */
1561 Vexec_path = decode_env_path ("EMACSPATH",
1562 #ifdef HAVE_NS
1563 path_exec ? path_exec :
1564 #endif
1565 PATH_EXEC, 0);
1566 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1567 /* FIXME? For ns, path_exec should go at the front? */
1568 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1571 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1573 void
1574 init_callproc (void)
1576 bool data_dir = egetenv ("EMACSDATA") != 0;
1578 char *sh;
1579 Lisp_Object tempdir;
1580 #ifdef HAVE_NS
1581 if (data_dir == 0)
1582 data_dir = ns_etc_directory () != 0;
1583 #endif
1585 if (!NILP (Vinstallation_directory))
1587 /* Add to the path the lib-src subdir of the installation dir. */
1588 Lisp_Object tem;
1589 tem = Fexpand_file_name (build_string ("lib-src"),
1590 Vinstallation_directory);
1591 #ifndef MSDOS
1592 /* MSDOS uses wrapped binaries, so don't do this. */
1593 if (NILP (Fmember (tem, Vexec_path)))
1595 #ifdef HAVE_NS
1596 const char *path_exec = ns_exec_path ();
1597 #endif
1598 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1599 Vexec_path = decode_env_path ("EMACSPATH",
1600 #ifdef HAVE_NS
1601 path_exec ? path_exec :
1602 #endif
1603 SSDATA (tem), 0);
1604 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1607 Vexec_directory = Ffile_name_as_directory (tem);
1608 #endif /* not MSDOS */
1610 /* Maybe use ../etc as well as ../lib-src. */
1611 if (data_dir == 0)
1613 tem = Fexpand_file_name (build_string ("etc"),
1614 Vinstallation_directory);
1615 Vdoc_directory = Ffile_name_as_directory (tem);
1619 /* Look for the files that should be in etc. We don't use
1620 Vinstallation_directory, because these files are never installed
1621 near the executable, and they are never in the build
1622 directory when that's different from the source directory.
1624 Instead, if these files are not in the nominal place, we try the
1625 source directory. */
1626 if (data_dir == 0)
1628 Lisp_Object tem, tem1, srcdir;
1629 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1631 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1633 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1634 tem1 = Ffile_exists_p (tem);
1635 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1637 Lisp_Object newdir;
1638 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1639 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1640 tem1 = Ffile_exists_p (tem);
1641 if (!NILP (tem1))
1642 Vdata_directory = newdir;
1646 #ifndef CANNOT_DUMP
1647 if (initialized)
1648 #endif
1650 tempdir = Fdirectory_file_name (Vexec_directory);
1651 if (! file_accessible_directory_p (tempdir))
1652 dir_warning ("arch-dependent data dir", Vexec_directory);
1655 tempdir = Fdirectory_file_name (Vdata_directory);
1656 if (! file_accessible_directory_p (tempdir))
1657 dir_warning ("arch-independent data dir", Vdata_directory);
1659 sh = getenv ("SHELL");
1660 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1662 #ifdef DOS_NT
1663 Vshared_game_score_directory = Qnil;
1664 #else
1665 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1666 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1667 Vshared_game_score_directory = Qnil;
1668 #endif
1671 void
1672 set_initial_environment (void)
1674 char **envp;
1675 for (envp = environ; *envp; envp++)
1676 Vprocess_environment = Fcons (build_string (*envp),
1677 Vprocess_environment);
1678 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1679 to use `delete' and friends on process-environment. */
1680 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1683 void
1684 syms_of_callproc (void)
1686 #ifndef DOS_NT
1687 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1688 #else /* DOS_NT */
1689 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1690 #endif
1691 staticpro (&Vtemp_file_name_pattern);
1693 #ifdef MSDOS
1694 synch_process_tempfile = make_number (0);
1695 staticpro (&synch_process_tempfile);
1696 #endif
1698 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1699 doc: /* File name to load inferior shells from.
1700 Initialized from the SHELL environment variable, or to a system-dependent
1701 default if SHELL is not set. */);
1703 DEFVAR_LISP ("exec-path", Vexec_path,
1704 doc: /* List of directories to search programs to run in subprocesses.
1705 Each element is a string (directory name) or nil (try default directory).
1707 By default the last element of this list is `exec-directory'. The
1708 last element is not always used, for example in shell completion
1709 (`shell-dynamic-complete-command'). */);
1711 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1712 doc: /* List of suffixes to try to find executable file names.
1713 Each element is a string. */);
1714 Vexec_suffixes = Qnil;
1716 DEFVAR_LISP ("exec-directory", Vexec_directory,
1717 doc: /* Directory for executables for Emacs to invoke.
1718 More generally, this includes any architecture-dependent files
1719 that are built and installed from the Emacs distribution. */);
1721 DEFVAR_LISP ("data-directory", Vdata_directory,
1722 doc: /* Directory of machine-independent files that come with GNU Emacs.
1723 These are files intended for Emacs to use while it runs. */);
1725 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1726 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1727 This is usually the same as `data-directory'. */);
1729 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1730 doc: /* For internal use by the build procedure only.
1731 This is the name of the directory in which the build procedure installed
1732 Emacs's info files; the default value for `Info-default-directory-list'
1733 includes this. */);
1734 Vconfigure_info_directory = build_string (PATH_INFO);
1736 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1737 doc: /* Directory of score files for games which come with GNU Emacs.
1738 If this variable is nil, then Emacs is unable to use a shared directory. */);
1739 #ifdef DOS_NT
1740 Vshared_game_score_directory = Qnil;
1741 #else
1742 Vshared_game_score_directory = build_string (PATH_GAME);
1743 #endif
1745 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1746 doc: /* List of environment variables inherited from the parent process.
1747 Each element should be a string of the form ENVVARNAME=VALUE.
1748 The elements must normally be decoded (using `locale-coding-system') for use. */);
1749 Vinitial_environment = Qnil;
1751 DEFVAR_LISP ("process-environment", Vprocess_environment,
1752 doc: /* List of overridden environment variables for subprocesses to inherit.
1753 Each element should be a string of the form ENVVARNAME=VALUE.
1755 Entries in this list take precedence to those in the frame-local
1756 environments. Therefore, let-binding `process-environment' is an easy
1757 way to temporarily change the value of an environment variable,
1758 irrespective of where it comes from. To use `process-environment' to
1759 remove an environment variable, include only its name in the list,
1760 without "=VALUE".
1762 This variable is set to nil when Emacs starts.
1764 If multiple entries define the same variable, the first one always
1765 takes precedence.
1767 Non-ASCII characters are encoded according to the initial value of
1768 `locale-coding-system', i.e. the elements must normally be decoded for
1769 use.
1771 See `setenv' and `getenv'. */);
1772 Vprocess_environment = Qnil;
1774 defsubr (&Scall_process);
1775 defsubr (&Sgetenv_internal);
1776 defsubr (&Scall_process_region);