Subject: Restore correct Gnus newsgroup name after sending message
[emacs.git] / src / callproc.c
blob301ccf383b5000a49c4edd65d4e2fe34418c496f
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2017 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 (at
11 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 <stdlib.h>
26 #include <sys/types.h>
27 #include <unistd.h>
29 #include <sys/file.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 #ifdef WINDOWSNT
35 #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 "buffer.h"
48 #include "coding.h"
49 #include <epaths.h>
50 #include "process.h"
51 #include "syssignal.h"
52 #include "syswait.h"
53 #include "blockinput.h"
54 #include "frame.h"
56 #ifdef MSDOS
57 #include "msdos.h"
58 #endif
60 #ifdef HAVE_NS
61 #include "nsterm.h"
62 #endif
64 /* Pattern used by call-process-region to make temp files. */
65 static Lisp_Object Vtemp_file_name_pattern;
67 /* The next two variables are used while record-unwind-protect is in place
68 during call-process for a subprocess for which record_deleted_pid has
69 not yet been called. At other times, synch_process_pid is zero and
70 synch_process_tempfile's contents are irrelevant. Doing this via static
71 C variables is more convenient than putting them into the arguments
72 of record-unwind-protect, as they need to be updated at randomish
73 times in the code, and Lisp cannot always store these values as
74 Emacs integers. It's safe to use static variables here, as the
75 code is never invoked reentrantly. */
77 /* If nonzero, a process-ID that has not been reaped. */
78 static pid_t synch_process_pid;
80 /* If a string, the name of a temp file that has not been removed. */
81 #ifdef MSDOS
82 static Lisp_Object synch_process_tempfile;
83 #else
84 # define synch_process_tempfile make_number (0)
85 #endif
87 /* Indexes of file descriptors that need closing on call_process_kill. */
88 enum
90 /* The subsidiary process's stdout and stderr. stdin is handled
91 separately, in either Fcall_process_region or create_temp_file. */
92 CALLPROC_STDOUT, CALLPROC_STDERR,
94 /* How to read from a pipe (or substitute) from the subsidiary process. */
95 CALLPROC_PIPEREAD,
97 /* A bound on the number of file descriptors. */
98 CALLPROC_FDS
101 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
103 /* Return the current buffer's working directory, or the home
104 directory if it's unreachable, as a string suitable for a system call.
105 Signal an error if the result would not be an accessible directory. */
107 Lisp_Object
108 encode_current_directory (void)
110 Lisp_Object dir;
112 dir = BVAR (current_buffer, directory);
114 dir = Funhandled_file_name_directory (dir);
116 /* If the file name handler says that dir is unreachable, use
117 a sensible default. */
118 if (NILP (dir))
119 dir = build_string ("~");
121 dir = expand_and_dir_to_file (dir, Qnil);
123 if (NILP (Ffile_accessible_directory_p (dir)))
124 report_file_error ("Setting current directory",
125 BVAR (current_buffer, directory));
127 /* Remove "/:" from DIR and encode it. */
128 dir = ENCODE_FILE (remove_slash_colon (dir));
130 if (! file_accessible_directory_p (dir))
131 report_file_error ("Setting current directory",
132 BVAR (current_buffer, directory));
134 return dir;
137 /* If P is reapable, record it as a deleted process and kill it.
138 Do this in a critical section. Unless PID is wedged it will be
139 reaped on receipt of the first SIGCHLD after the critical section. */
141 void
142 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
144 #ifndef MSDOS
145 sigset_t oldset;
146 block_child_signal (&oldset);
148 if (p->alive)
150 record_deleted_pid (p->pid, tempfile);
151 p->alive = 0;
152 kill (- p->pid, SIGKILL);
155 unblock_child_signal (&oldset);
156 #endif /* !MSDOS */
159 /* Clean up files, file descriptors and processes created by Fcall_process. */
161 static void
162 delete_temp_file (Lisp_Object name)
164 unlink (SSDATA (name));
167 static void
168 call_process_kill (void *ptr)
170 int *callproc_fd = ptr;
171 int i;
172 for (i = 0; i < CALLPROC_FDS; i++)
173 if (0 <= callproc_fd[i])
174 emacs_close (callproc_fd[i]);
176 if (synch_process_pid)
178 struct Lisp_Process proc;
179 proc.alive = 1;
180 proc.pid = synch_process_pid;
181 record_kill_process (&proc, synch_process_tempfile);
182 synch_process_pid = 0;
184 else if (STRINGP (synch_process_tempfile))
185 delete_temp_file (synch_process_tempfile);
188 /* Clean up when exiting Fcall_process: restore the buffer, and
189 kill the subsidiary process group if the process still exists. */
191 static void
192 call_process_cleanup (Lisp_Object buffer)
194 Fset_buffer (buffer);
196 #ifndef MSDOS
197 if (synch_process_pid)
199 kill (-synch_process_pid, SIGINT);
200 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
201 immediate_quit = true;
202 maybe_quit ();
203 wait_for_termination (synch_process_pid, 0, 1);
204 synch_process_pid = 0;
205 immediate_quit = false;
206 message1 ("Waiting for process to die...done");
208 #endif /* !MSDOS */
211 #ifdef DOS_NT
212 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
213 #else
214 static mode_t const default_output_mode = 0666;
215 #endif
217 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
218 doc: /* Call PROGRAM synchronously in separate process.
219 The remaining arguments are optional.
220 The program's input comes from file INFILE (nil means `/dev/null').
221 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
222 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
223 FILE is a file name string, means that it should be written to that file
224 (if the file already exists it is overwritten).
225 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
226 REAL-BUFFER says what to do with standard output, as above,
227 while STDERR-FILE says what to do with standard error in the child.
228 STDERR-FILE may be nil (discard standard error output),
229 t (mix it with ordinary output), or a file name string.
231 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
232 Remaining arguments are strings passed as command arguments to PROGRAM.
234 If executable PROGRAM can't be found as an executable, `call-process'
235 signals a Lisp error. `call-process' reports errors in execution of
236 the program only through its return and output.
238 If DESTINATION is 0, `call-process' returns immediately with value nil.
239 Otherwise it waits for PROGRAM to terminate
240 and returns a numeric exit status or a signal description string.
241 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
243 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
244 (ptrdiff_t nargs, Lisp_Object *args)
246 Lisp_Object infile, encoded_infile;
247 int filefd;
248 ptrdiff_t count = SPECPDL_INDEX ();
250 if (nargs >= 2 && ! NILP (args[1]))
252 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
253 CHECK_STRING (infile);
255 else
256 infile = build_string (NULL_DEVICE);
258 encoded_infile = ENCODE_FILE (infile);
260 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
261 if (filefd < 0)
262 report_file_error ("Opening process input file", infile);
263 record_unwind_protect_int (close_file_unwind, filefd);
264 return unbind_to (count, call_process (nargs, args, filefd, -1));
267 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
269 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
270 unwinder that is intended to remove the input temporary file; in
271 this case NARGS must be at least 2 and ARGS[1] is the file's name.
273 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
275 static Lisp_Object
276 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
277 ptrdiff_t tempfile_index)
279 Lisp_Object buffer, current_dir, path;
280 bool display_p;
281 int fd0;
282 int callproc_fd[CALLPROC_FDS];
283 int status;
284 ptrdiff_t i;
285 ptrdiff_t count = SPECPDL_INDEX ();
286 USE_SAFE_ALLOCA;
288 char **new_argv;
289 /* File to use for stderr in the child.
290 t means use same as standard output. */
291 Lisp_Object error_file;
292 Lisp_Object output_file = Qnil;
293 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
294 char *tempfile = NULL;
295 #else
296 sigset_t oldset;
297 pid_t pid;
298 #endif
299 int child_errno;
300 int fd_output, fd_error;
301 struct coding_system process_coding; /* coding-system of process output */
302 struct coding_system argument_coding; /* coding-system of arguments */
303 /* Set to the return value of Ffind_operation_coding_system. */
304 Lisp_Object coding_systems;
305 bool discard_output;
307 if (synch_process_pid)
308 error ("call-process invoked recursively");
310 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
311 coding_systems = Qt;
313 CHECK_STRING (args[0]);
315 error_file = Qt;
317 #ifndef subprocesses
318 /* Without asynchronous processes we cannot have BUFFER == 0. */
319 if (nargs >= 3
320 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
321 error ("Operating system cannot handle asynchronous subprocesses");
322 #endif /* subprocesses */
324 /* Decide the coding-system for giving arguments. */
326 Lisp_Object val, *args2;
328 /* If arguments are supplied, we may have to encode them. */
329 if (nargs >= 5)
331 bool must_encode = 0;
332 Lisp_Object coding_attrs;
334 for (i = 4; i < nargs; i++)
335 CHECK_STRING (args[i]);
337 for (i = 4; i < nargs; i++)
338 if (STRING_MULTIBYTE (args[i]))
339 must_encode = 1;
341 if (!NILP (Vcoding_system_for_write))
342 val = Vcoding_system_for_write;
343 else if (! must_encode)
344 val = Qraw_text;
345 else
347 SAFE_NALLOCA (args2, 1, nargs + 1);
348 args2[0] = Qcall_process;
349 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
350 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
351 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
353 val = complement_process_encoding_system (val);
354 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
355 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
356 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
358 /* We should not use an ASCII incompatible coding system. */
359 val = raw_text_coding_system (val);
360 setup_coding_system (val, &argument_coding);
365 if (nargs < 3)
366 buffer = Qnil;
367 else
369 buffer = args[2];
371 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
372 FILE-FOR-STDERR), unless the first element is :file, in which case see
373 the next paragraph. */
374 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
376 if (CONSP (XCDR (buffer)))
378 Lisp_Object stderr_file;
379 stderr_file = XCAR (XCDR (buffer));
381 if (NILP (stderr_file) || EQ (Qt, stderr_file))
382 error_file = stderr_file;
383 else
384 error_file = Fexpand_file_name (stderr_file, Qnil);
387 buffer = XCAR (buffer);
390 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
391 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
393 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
394 BVAR (current_buffer, directory));
395 CHECK_STRING (output_file);
396 buffer = Qnil;
399 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
401 Lisp_Object spec_buffer;
402 spec_buffer = buffer;
403 buffer = Fget_buffer_create (buffer);
404 /* Mention the buffer name for a better error message. */
405 if (NILP (buffer))
406 CHECK_BUFFER (spec_buffer);
407 CHECK_BUFFER (buffer);
411 /* Make sure that the child will be able to chdir to the current
412 buffer's current directory, or its unhandled equivalent. We
413 can't just have the child check for an error when it does the
414 chdir, since it's in a vfork. */
415 current_dir = encode_current_directory ();
417 if (STRINGP (error_file))
418 error_file = ENCODE_FILE (error_file);
419 if (STRINGP (output_file))
420 output_file = ENCODE_FILE (output_file);
422 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
424 for (i = 0; i < CALLPROC_FDS; i++)
425 callproc_fd[i] = -1;
426 #ifdef MSDOS
427 synch_process_tempfile = make_number (0);
428 #endif
429 record_unwind_protect_ptr (call_process_kill, callproc_fd);
431 /* Search for program; barf if not found. */
433 int ok;
435 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
436 make_number (X_OK), false);
437 if (ok < 0)
438 report_file_error ("Searching for program", args[0]);
441 /* Remove "/:" from PATH. */
442 path = remove_slash_colon (path);
444 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
446 if (nargs > 4)
448 ptrdiff_t i;
450 argument_coding.dst_multibyte = 0;
451 for (i = 4; i < nargs; i++)
453 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
454 if (CODING_REQUIRE_ENCODING (&argument_coding))
455 /* We must encode this argument. */
456 args[i] = encode_coding_string (&argument_coding, args[i], 1);
458 for (i = 4; i < nargs; i++)
459 new_argv[i - 3] = SSDATA (args[i]);
460 new_argv[i - 3] = 0;
462 else
463 new_argv[1] = 0;
464 path = ENCODE_FILE (path);
465 new_argv[0] = SSDATA (path);
467 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
469 #ifdef MSDOS
470 if (! discard_output && ! STRINGP (output_file))
472 char const *tmpdir = egetenv ("TMPDIR");
473 char const *outf = tmpdir ? tmpdir : "";
474 tempfile = alloca (strlen (outf) + 20);
475 strcpy (tempfile, outf);
476 dostounix_filename (tempfile);
477 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
478 strcat (tempfile, "/");
479 strcat (tempfile, "emXXXXXX");
480 mktemp (tempfile);
481 if (!*tempfile)
482 report_file_error ("Opening process output file", Qnil);
483 output_file = build_string (tempfile);
484 synch_process_tempfile = output_file;
486 #endif
488 if (discard_output)
490 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
491 if (fd_output < 0)
492 report_file_error ("Opening null device", Qnil);
494 else if (STRINGP (output_file))
496 fd_output = emacs_open (SSDATA (output_file),
497 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
498 default_output_mode);
499 if (fd_output < 0)
501 int open_errno = errno;
502 output_file = DECODE_FILE (output_file);
503 report_file_errno ("Opening process output file",
504 output_file, open_errno);
507 else
509 int fd[2];
510 if (emacs_pipe (fd) != 0)
511 report_file_error ("Creating process pipe", Qnil);
512 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
513 fd_output = fd[1];
515 callproc_fd[CALLPROC_STDOUT] = fd_output;
517 fd_error = fd_output;
519 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
521 fd_error = emacs_open ((STRINGP (error_file)
522 ? SSDATA (error_file)
523 : NULL_DEVICE),
524 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
525 default_output_mode);
526 if (fd_error < 0)
528 int open_errno = errno;
529 report_file_errno ("Cannot redirect stderr",
530 (STRINGP (error_file)
531 ? DECODE_FILE (error_file)
532 : build_string (NULL_DEVICE)),
533 open_errno);
535 callproc_fd[CALLPROC_STDERR] = fd_error;
538 #ifdef MSDOS /* MW, July 1993 */
539 status = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
541 if (status < 0)
543 child_errno = errno;
544 unbind_to (count, Qnil);
545 synchronize_system_messages_locale ();
546 return
547 code_convert_string_norecord (build_string (strerror (child_errno)),
548 Vlocale_coding_system, 0);
551 for (i = 0; i < CALLPROC_FDS; i++)
552 if (0 <= callproc_fd[i])
554 emacs_close (callproc_fd[i]);
555 callproc_fd[i] = -1;
557 emacs_close (filefd);
558 clear_unwind_protect (count - 1);
560 if (tempfile)
562 /* Since CRLF is converted to LF within `decode_coding', we
563 can always open a file with binary mode. */
564 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile, O_RDONLY, 0);
565 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
567 int open_errno = errno;
568 report_file_errno ("Cannot re-open temporary file",
569 build_string (tempfile), open_errno);
573 #endif /* MSDOS */
575 /* Do the unwind-protect now, even though the pid is not known, so
576 that no storage allocation is done in the critical section.
577 The actual PID will be filled in during the critical section. */
578 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
580 #ifndef MSDOS
582 block_input ();
583 block_child_signal (&oldset);
585 #ifdef WINDOWSNT
586 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
587 #else /* not WINDOWSNT */
589 /* vfork, and prevent local vars from being clobbered by the vfork. */
591 Lisp_Object volatile buffer_volatile = buffer;
592 Lisp_Object volatile coding_systems_volatile = coding_systems;
593 Lisp_Object volatile current_dir_volatile = current_dir;
594 bool volatile display_p_volatile = display_p;
595 bool volatile sa_must_free_volatile = sa_must_free;
596 int volatile fd_error_volatile = fd_error;
597 int volatile filefd_volatile = filefd;
598 ptrdiff_t volatile count_volatile = count;
599 ptrdiff_t volatile sa_avail_volatile = sa_avail;
600 ptrdiff_t volatile sa_count_volatile = sa_count;
601 char **volatile new_argv_volatile = new_argv;
602 int volatile callproc_fd_volatile[CALLPROC_FDS];
603 for (i = 0; i < CALLPROC_FDS; i++)
604 callproc_fd_volatile[i] = callproc_fd[i];
606 pid = vfork ();
608 buffer = buffer_volatile;
609 coding_systems = coding_systems_volatile;
610 current_dir = current_dir_volatile;
611 display_p = display_p_volatile;
612 sa_must_free = sa_must_free_volatile;
613 fd_error = fd_error_volatile;
614 filefd = filefd_volatile;
615 count = count_volatile;
616 sa_avail = sa_avail_volatile;
617 sa_count = sa_count_volatile;
618 new_argv = new_argv_volatile;
620 for (i = 0; i < CALLPROC_FDS; i++)
621 callproc_fd[i] = callproc_fd_volatile[i];
622 fd_output = callproc_fd[CALLPROC_STDOUT];
625 if (pid == 0)
627 unblock_child_signal (&oldset);
629 setsid ();
631 /* Emacs ignores SIGPIPE, but the child should not. */
632 signal (SIGPIPE, SIG_DFL);
633 /* Likewise for SIGPROF. */
634 #ifdef SIGPROF
635 signal (SIGPROF, SIG_DFL);
636 #endif
638 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
641 #endif /* not WINDOWSNT */
643 child_errno = errno;
645 if (pid > 0)
647 synch_process_pid = pid;
649 if (INTEGERP (buffer))
651 if (tempfile_index < 0)
652 record_deleted_pid (pid, Qnil);
653 else
655 eassert (1 < nargs);
656 record_deleted_pid (pid, args[1]);
657 clear_unwind_protect (tempfile_index);
659 synch_process_pid = 0;
663 unblock_child_signal (&oldset);
664 unblock_input ();
666 if (pid < 0)
667 report_file_errno ("Doing vfork", Qnil, child_errno);
669 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
670 since we will use that to read input from. */
671 for (i = 0; i < CALLPROC_FDS; i++)
672 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
674 emacs_close (callproc_fd[i]);
675 callproc_fd[i] = -1;
677 emacs_close (filefd);
678 clear_unwind_protect (count - 1);
680 #endif /* not MSDOS */
682 if (INTEGERP (buffer))
683 return unbind_to (count, Qnil);
685 if (BUFFERP (buffer))
686 Fset_buffer (buffer);
688 fd0 = callproc_fd[CALLPROC_PIPEREAD];
690 if (0 <= fd0)
692 Lisp_Object val, *args2;
694 val = Qnil;
695 if (!NILP (Vcoding_system_for_read))
696 val = Vcoding_system_for_read;
697 else
699 if (EQ (coding_systems, Qt))
701 ptrdiff_t i;
703 SAFE_NALLOCA (args2, 1, nargs + 1);
704 args2[0] = Qcall_process;
705 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
706 coding_systems
707 = Ffind_operation_coding_system (nargs + 1, args2);
709 if (CONSP (coding_systems))
710 val = XCAR (coding_systems);
711 else if (CONSP (Vdefault_process_coding_system))
712 val = XCAR (Vdefault_process_coding_system);
713 else
714 val = Qnil;
716 Fcheck_coding_system (val);
717 /* In unibyte mode, character code conversion should not take
718 place but EOL conversion should. So, setup raw-text or one
719 of the subsidiary according to the information just setup. */
720 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
721 && !NILP (val))
722 val = raw_text_coding_system (val);
723 setup_coding_system (val, &process_coding);
724 process_coding.dst_multibyte
725 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
726 process_coding.src_multibyte = 0;
729 immediate_quit = true;
730 maybe_quit ();
732 if (0 <= fd0)
734 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
735 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
736 char buf[CALLPROC_BUFFER_SIZE_MAX];
737 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
738 int nread;
739 EMACS_INT total_read = 0;
740 int carryover = 0;
741 bool display_on_the_fly = display_p;
742 struct coding_system saved_coding = process_coding;
744 while (1)
746 /* Repeatedly read until we've filled as much as possible
747 of the buffer size we have. But don't read
748 less than 1024--save that for the next bufferful. */
749 nread = carryover;
750 while (nread < bufsize - 1024)
752 int this_read = emacs_read (fd0, buf + nread,
753 bufsize - nread);
755 if (this_read < 0)
756 goto give_up;
758 if (this_read == 0)
760 process_coding.mode |= CODING_MODE_LAST_BLOCK;
761 break;
764 nread += this_read;
765 total_read += this_read;
767 if (display_on_the_fly)
768 break;
771 /* Now NREAD is the total amount of data in the buffer. */
772 immediate_quit = false;
774 if (!nread)
776 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
777 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
778 insert_1_both (buf, nread, nread, 0, 1, 0);
779 else
780 { /* We have to decode the input. */
781 Lisp_Object curbuf;
782 ptrdiff_t count1 = SPECPDL_INDEX ();
784 XSETBUFFER (curbuf, current_buffer);
785 /* FIXME: Call signal_after_change! */
786 prepare_to_modify_buffer (PT, PT, NULL);
787 /* We cannot allow after-change-functions be run
788 during decoding, because that might modify the
789 buffer, while we rely on process_coding.produced to
790 faithfully reflect inserted text until we
791 TEMP_SET_PT_BOTH below. */
792 specbind (Qinhibit_modification_hooks, Qt);
793 decode_coding_c_string (&process_coding,
794 (unsigned char *) buf, nread, curbuf);
795 unbind_to (count1, Qnil);
796 if (display_on_the_fly
797 && CODING_REQUIRE_DETECTION (&saved_coding)
798 && ! CODING_REQUIRE_DETECTION (&process_coding))
800 /* We have detected some coding system, but the
801 detection may have been via insufficient data.
802 So give up displaying on the fly. */
803 if (process_coding.produced > 0)
804 del_range_2 (process_coding.dst_pos,
805 process_coding.dst_pos_byte,
806 (process_coding.dst_pos
807 + process_coding.produced_char),
808 (process_coding.dst_pos_byte
809 + process_coding.produced),
811 display_on_the_fly = false;
812 process_coding = saved_coding;
813 carryover = nread;
814 /* Make the above condition always fail in the future. */
815 saved_coding.common_flags
816 &= ~CODING_REQUIRE_DETECTION_MASK;
817 continue;
820 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
821 PT_BYTE + process_coding.produced);
822 carryover = process_coding.carryover_bytes;
823 if (carryover > 0)
824 memcpy (buf, process_coding.carryover,
825 process_coding.carryover_bytes);
828 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
829 break;
831 /* Make the buffer bigger as we continue to read more data,
832 but not past CALLPROC_BUFFER_SIZE_MAX. */
833 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
834 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
835 bufsize = CALLPROC_BUFFER_SIZE_MAX;
837 if (display_p)
839 redisplay_preserve_echo_area (1);
840 /* This variable might have been set to 0 for code
841 detection. In that case, set it back to 1 because
842 we should have already detected a coding system. */
843 display_on_the_fly = true;
845 immediate_quit = true;
846 maybe_quit ();
848 give_up: ;
850 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
851 /* If the caller required, let the buffer inherit the
852 coding-system used to decode the process output. */
853 if (inherit_process_coding_system)
854 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
855 make_number (total_read));
858 #ifndef MSDOS
859 /* Wait for it to terminate, unless it already has. */
860 wait_for_termination (pid, &status, fd0 < 0);
861 #endif
863 immediate_quit = false;
865 /* Don't kill any children that the subprocess may have left behind
866 when exiting. */
867 synch_process_pid = 0;
869 SAFE_FREE ();
870 unbind_to (count, Qnil);
872 if (WIFSIGNALED (status))
874 const char *signame;
876 synchronize_system_messages_locale ();
877 signame = strsignal (WTERMSIG (status));
879 if (signame == 0)
880 signame = "unknown";
882 return code_convert_string_norecord (build_string (signame),
883 Vlocale_coding_system, 0);
886 eassert (WIFEXITED (status));
887 return make_number (WEXITSTATUS (status));
890 /* Create a temporary file suitable for storing the input data of
891 call-process-region. NARGS and ARGS are the same as for
892 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
893 naming the file, and return a file descriptor for reading.
894 Unwind-protect the file, so that the file descriptor will be closed
895 and the file removed when the caller unwinds the specpdl stack. */
897 static int
898 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
899 Lisp_Object *filename_string_ptr)
901 int fd;
902 Lisp_Object filename_string;
903 Lisp_Object val, start, end;
904 Lisp_Object tmpdir;
906 if (STRINGP (Vtemporary_file_directory))
907 tmpdir = Vtemporary_file_directory;
908 else
910 char *outf;
911 #ifndef DOS_NT
912 outf = getenv ("TMPDIR");
913 tmpdir = build_string (outf ? outf : "/tmp/");
914 #else /* DOS_NT */
915 if ((outf = egetenv ("TMPDIR"))
916 || (outf = egetenv ("TMP"))
917 || (outf = egetenv ("TEMP")))
918 tmpdir = build_string (outf);
919 else
920 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
921 #endif
925 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
926 char *tempfile;
927 ptrdiff_t count;
929 #ifdef WINDOWSNT
930 /* Cannot use the result of Fexpand_file_name, because it
931 downcases the XXXXXX part of the pattern, and mktemp then
932 doesn't recognize it. */
933 if (!NILP (Vw32_downcase_file_names))
935 Lisp_Object dirname = Ffile_name_directory (pattern);
937 if (NILP (dirname))
938 pattern = Vtemp_file_name_pattern;
939 else
940 pattern = concat2 (dirname, Vtemp_file_name_pattern);
942 #endif
944 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
945 tempfile = SSDATA (filename_string);
947 count = SPECPDL_INDEX ();
948 record_unwind_protect_nothing ();
949 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
950 if (fd < 0)
951 report_file_error ("Failed to open temporary file using pattern",
952 pattern);
953 set_unwind_protect (count, delete_temp_file, filename_string);
954 record_unwind_protect_int (close_file_unwind, fd);
957 start = args[0];
958 end = args[1];
959 /* Decide coding-system of the contents of the temporary file. */
960 if (!NILP (Vcoding_system_for_write))
961 val = Vcoding_system_for_write;
962 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
963 val = Qraw_text;
964 else
966 Lisp_Object coding_systems;
967 Lisp_Object *args2;
968 USE_SAFE_ALLOCA;
969 SAFE_NALLOCA (args2, 1, nargs + 1);
970 args2[0] = Qcall_process_region;
971 memcpy (args2 + 1, args, nargs * sizeof *args);
972 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
973 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
974 SAFE_FREE ();
976 val = complement_process_encoding_system (val);
979 ptrdiff_t count1 = SPECPDL_INDEX ();
981 specbind (intern ("coding-system-for-write"), val);
982 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
983 happen to get a ".Z" suffix. */
984 specbind (Qfile_name_handler_alist, Qnil);
985 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
987 unbind_to (count1, Qnil);
990 if (lseek (fd, 0, SEEK_SET) < 0)
991 report_file_error ("Setting file position", filename_string);
993 /* Note that Fcall_process takes care of binding
994 coding-system-for-read. */
996 *filename_string_ptr = filename_string;
997 return fd;
1000 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1001 3, MANY, 0,
1002 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1004 START and END are normally buffer positions specifying the part of the
1005 buffer to send to the process.
1006 If START is nil, that means to use the entire buffer contents; END is
1007 ignored.
1008 If START is a string, then send that string to the process
1009 instead of any buffer contents; END is ignored.
1010 The remaining arguments are optional.
1011 Delete the text if fourth arg DELETE is non-nil.
1013 Insert output in BUFFER before point; t means current buffer; nil for
1014 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1015 FILE)', where FILE is a file name string, means that it should be
1016 written to that file (if the file already exists it is overwritten).
1017 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1018 REAL-BUFFER says what to do with standard output, as above,
1019 while STDERR-FILE says what to do with standard error in the child.
1020 STDERR-FILE may be nil (discard standard error output),
1021 t (mix it with ordinary output), or a file name string.
1023 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1024 Remaining args are passed to PROGRAM at startup as command args.
1026 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1027 Otherwise it waits for PROGRAM to terminate
1028 and returns a numeric exit status or a signal description string.
1029 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1031 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1032 (ptrdiff_t nargs, Lisp_Object *args)
1034 Lisp_Object infile, val;
1035 ptrdiff_t count = SPECPDL_INDEX ();
1036 Lisp_Object start = args[0];
1037 Lisp_Object end = args[1];
1038 bool empty_input;
1039 int fd;
1041 if (STRINGP (start))
1042 empty_input = SCHARS (start) == 0;
1043 else if (NILP (start))
1044 empty_input = BEG == Z;
1045 else
1047 validate_region (&args[0], &args[1]);
1048 start = args[0];
1049 end = args[1];
1050 empty_input = XINT (start) == XINT (end);
1053 if (!empty_input)
1054 fd = create_temp_file (nargs, args, &infile);
1055 else
1057 infile = Qnil;
1058 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1059 if (fd < 0)
1060 report_file_error ("Opening null device", Qnil);
1061 record_unwind_protect_int (close_file_unwind, fd);
1064 if (nargs > 3 && !NILP (args[3]))
1065 Fdelete_region (start, end);
1067 if (nargs > 3)
1069 args += 2;
1070 nargs -= 2;
1072 else
1074 args[0] = args[2];
1075 nargs = 2;
1077 args[1] = infile;
1079 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1080 return unbind_to (count, val);
1083 static char **
1084 add_env (char **env, char **new_env, char *string)
1086 char **ep;
1087 bool ok = 1;
1088 if (string == NULL)
1089 return new_env;
1091 /* See if this string duplicates any string already in the env.
1092 If so, don't put it in.
1093 When an env var has multiple definitions,
1094 we keep the definition that comes first in process-environment. */
1095 for (ep = env; ok && ep != new_env; ep++)
1097 char *p = *ep, *q = string;
1098 while (ok)
1100 if (*p && *q != *p)
1101 break;
1102 if (*q == 0)
1103 /* The string is a lone variable name; keep it for now, we
1104 will remove it later. It is a placeholder for a
1105 variable that is not to be included in the environment. */
1106 break;
1107 if (*q == '=')
1108 ok = 0;
1109 p++, q++;
1112 if (ok)
1113 *new_env++ = string;
1114 return new_env;
1117 #ifndef DOS_NT
1119 /* 'exec' failed inside a child running NAME, with error number ERR.
1120 Possibly a vforked child needed to allocate a large vector on the
1121 stack; such a child cannot fall back on malloc because that might
1122 mess up the allocator's data structures in the parent.
1123 Report the error and exit the child. */
1125 static _Noreturn void
1126 exec_failed (char const *name, int err)
1128 /* Avoid deadlock if the child's perror writes to a full pipe; the
1129 pipe's reader is the parent, but with vfork the parent can't
1130 run until the child exits. Truncate the diagnostic instead. */
1131 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1133 errno = err;
1134 emacs_perror (name);
1135 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1138 #else
1140 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1141 fork and exec, and handle alloca exhaustion in a different way. */
1143 static void
1144 exec_failed (char const *name, int err)
1148 #endif
1150 /* This is the last thing run in a newly forked inferior
1151 either synchronous or asynchronous.
1152 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1153 Initialize inferior's priority, pgrp, connected dir and environment.
1154 then exec another program based on new_argv.
1156 If SET_PGRP, put the subprocess into a separate process group.
1158 CURRENT_DIR is an elisp string giving the path of the current
1159 directory the subprocess should have. Since we can't really signal
1160 a decent error from within the child, this should be verified as an
1161 executable directory by the parent.
1163 On GNUish hosts, either exec or return an error number.
1164 On MS-Windows, either return a pid or signal an error.
1165 On MS-DOS, either return an exit status or signal an error. */
1167 CHILD_SETUP_TYPE
1168 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1169 Lisp_Object current_dir)
1171 char **env;
1172 char *pwd_var;
1173 #ifdef WINDOWSNT
1174 int cpid;
1175 HANDLE handles[3];
1176 #else
1177 pid_t pid = getpid ();
1178 #endif /* WINDOWSNT */
1180 /* Note that use of alloca is always safe here. It's obvious for systems
1181 that do not have true vfork or that have true (stack) alloca.
1182 If using vfork and C_ALLOCA (when Emacs used to include
1183 src/alloca.c) it is safe because that changes the superior's
1184 static variables as if the superior had done alloca and will be
1185 cleaned up in the usual way. */
1187 char *temp;
1188 ptrdiff_t i;
1190 i = SBYTES (current_dir);
1191 #ifdef MSDOS
1192 /* MSDOS must have all environment variables malloc'ed, because
1193 low-level libc functions that launch subsidiary processes rely
1194 on that. */
1195 pwd_var = xmalloc (i + 5);
1196 #else
1197 if (MAX_ALLOCA - 5 < i)
1198 exec_failed (new_argv[0], ENOMEM);
1199 pwd_var = alloca (i + 5);
1200 #endif
1201 temp = pwd_var + 4;
1202 memcpy (pwd_var, "PWD=", 4);
1203 lispstpcpy (temp, current_dir);
1205 #ifndef DOS_NT
1206 /* We can't signal an Elisp error here; we're in a vfork. Since
1207 the callers check the current directory before forking, this
1208 should only return an error if the directory's permissions
1209 are changed between the check and this chdir, but we should
1210 at least check. */
1211 if (chdir (temp) < 0)
1212 _exit (EXIT_CANCELED);
1213 #else /* DOS_NT */
1214 /* Get past the drive letter, so that d:/ is left alone. */
1215 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1217 temp += 2;
1218 i -= 2;
1220 #endif /* DOS_NT */
1222 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1223 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1224 temp[--i] = 0;
1227 /* Set `env' to a vector of the strings in the environment. */
1229 register Lisp_Object tem;
1230 register char **new_env;
1231 char **p, **q;
1232 register int new_length;
1233 Lisp_Object display = Qnil;
1235 new_length = 0;
1237 for (tem = Vprocess_environment;
1238 CONSP (tem) && STRINGP (XCAR (tem));
1239 tem = XCDR (tem))
1241 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1242 && (SDATA (XCAR (tem)) [7] == '\0'
1243 || SDATA (XCAR (tem)) [7] == '='))
1244 /* DISPLAY is specified in process-environment. */
1245 display = Qt;
1246 new_length++;
1249 /* If not provided yet, use the frame's DISPLAY. */
1250 if (NILP (display))
1252 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1253 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1254 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1255 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1256 Vinitial_environment);
1257 if (STRINGP (tmp))
1259 display = tmp;
1260 new_length++;
1264 /* new_length + 2 to include PWD and terminating 0. */
1265 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1266 exec_failed (new_argv[0], ENOMEM);
1267 env = new_env = alloca ((new_length + 2) * sizeof *env);
1268 /* If we have a PWD envvar, pass one down,
1269 but with corrected value. */
1270 if (egetenv ("PWD"))
1271 *new_env++ = pwd_var;
1273 if (STRINGP (display))
1275 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1276 exec_failed (new_argv[0], ENOMEM);
1277 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1278 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1279 new_env = add_env (env, new_env, vdata);
1282 /* Overrides. */
1283 for (tem = Vprocess_environment;
1284 CONSP (tem) && STRINGP (XCAR (tem));
1285 tem = XCDR (tem))
1286 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1288 *new_env = 0;
1290 /* Remove variable names without values. */
1291 p = q = env;
1292 while (*p != 0)
1294 while (*q != 0 && strchr (*q, '=') == NULL)
1295 q++;
1296 *p = *q++;
1297 if (*p != 0)
1298 p++;
1303 #ifdef WINDOWSNT
1304 prepare_standard_handles (in, out, err, handles);
1305 set_process_dir (SSDATA (current_dir));
1306 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1307 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1308 reset_standard_handles (in, out, err, handles);
1309 if (cpid == -1)
1310 /* An error occurred while trying to spawn the process. */
1311 report_file_error ("Spawning child process", Qnil);
1312 return cpid;
1314 #else /* not WINDOWSNT */
1316 #ifndef MSDOS
1318 restore_nofile_limit ();
1320 /* Redirect file descriptors and clear the close-on-exec flag on the
1321 redirected ones. IN, OUT, and ERR are close-on-exec so they
1322 need not be closed explicitly. */
1323 dup2 (in, STDIN_FILENO);
1324 dup2 (out, STDOUT_FILENO);
1325 dup2 (err, STDERR_FILENO);
1327 setpgid (0, 0);
1328 tcsetpgrp (0, pid);
1330 int errnum = emacs_exec_file (new_argv[0], new_argv, env);
1331 exec_failed (new_argv[0], errnum);
1333 #else /* MSDOS */
1334 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1335 xfree (pwd_var);
1336 if (pid == -1)
1337 /* An error occurred while trying to run the subprocess. */
1338 report_file_error ("Spawning child process", Qnil);
1339 return pid;
1340 #endif /* MSDOS */
1341 #endif /* not WINDOWSNT */
1344 static bool
1345 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1346 ptrdiff_t *valuelen, Lisp_Object env)
1348 for (; CONSP (env); env = XCDR (env))
1350 Lisp_Object entry = XCAR (env);
1351 if (STRINGP (entry)
1352 && SBYTES (entry) >= varlen
1353 #ifdef WINDOWSNT
1354 /* NT environment variables are case insensitive. */
1355 && ! strnicmp (SSDATA (entry), var, varlen)
1356 #else /* not WINDOWSNT */
1357 && ! memcmp (SDATA (entry), var, varlen)
1358 #endif /* not WINDOWSNT */
1361 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1363 *value = SSDATA (entry) + (varlen + 1);
1364 *valuelen = SBYTES (entry) - (varlen + 1);
1365 return 1;
1367 else if (SBYTES (entry) == varlen)
1369 /* Lone variable names in Vprocess_environment mean that
1370 variable should be removed from the environment. */
1371 *value = NULL;
1372 return 1;
1376 return 0;
1379 static bool
1380 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1381 ptrdiff_t *valuelen, Lisp_Object frame)
1383 /* Try to find VAR in Vprocess_environment first. */
1384 if (getenv_internal_1 (var, varlen, value, valuelen,
1385 Vprocess_environment))
1386 return *value ? 1 : 0;
1388 /* On Windows we make some modifications to Emacs' environment
1389 without recording them in Vprocess_environment. */
1390 #ifdef WINDOWSNT
1392 char* tmpval = getenv (var);
1393 if (tmpval)
1395 *value = tmpval;
1396 *valuelen = strlen (tmpval);
1397 return 1;
1400 #endif
1402 /* For DISPLAY try to get the values from the frame or the initial env. */
1403 if (strcmp (var, "DISPLAY") == 0)
1405 Lisp_Object display
1406 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1407 if (STRINGP (display))
1409 *value = SSDATA (display);
1410 *valuelen = SBYTES (display);
1411 return 1;
1413 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1414 if (getenv_internal_1 (var, varlen, value, valuelen,
1415 Vinitial_environment))
1416 return *value ? 1 : 0;
1419 return 0;
1422 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1423 doc: /* Get the value of environment variable VARIABLE.
1424 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1425 the environment. Otherwise, value is a string.
1427 This function searches `process-environment' for VARIABLE.
1429 If optional parameter ENV is a list, then search this list instead of
1430 `process-environment', and return t when encountering a negative entry
1431 \(an entry for a variable with no value). */)
1432 (Lisp_Object variable, Lisp_Object env)
1434 char *value;
1435 ptrdiff_t valuelen;
1437 CHECK_STRING (variable);
1438 if (CONSP (env))
1440 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1441 &value, &valuelen, env))
1442 return value ? make_string (value, valuelen) : Qt;
1443 else
1444 return Qnil;
1446 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1447 &value, &valuelen, env))
1448 return make_string (value, valuelen);
1449 else
1450 return Qnil;
1453 /* A version of getenv that consults the Lisp environment lists,
1454 easily callable from C. This is usually called from egetenv. */
1455 char *
1456 egetenv_internal (const char *var, ptrdiff_t len)
1458 char *value;
1459 ptrdiff_t valuelen;
1461 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1462 return value;
1463 else
1464 return 0;
1468 /* This is run before init_cmdargs. */
1470 void
1471 init_callproc_1 (void)
1473 #ifdef HAVE_NS
1474 const char *etc_dir = ns_etc_directory ();
1475 const char *path_exec = ns_exec_path ();
1476 #endif
1478 Vdata_directory = decode_env_path ("EMACSDATA",
1479 #ifdef HAVE_NS
1480 etc_dir ? etc_dir :
1481 #endif
1482 PATH_DATA, 0);
1483 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1485 Vdoc_directory = decode_env_path ("EMACSDOC",
1486 #ifdef HAVE_NS
1487 etc_dir ? etc_dir :
1488 #endif
1489 PATH_DOC, 0);
1490 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1492 /* Check the EMACSPATH environment variable, defaulting to the
1493 PATH_EXEC path from epaths.h. */
1494 Vexec_path = decode_env_path ("EMACSPATH",
1495 #ifdef HAVE_NS
1496 path_exec ? path_exec :
1497 #endif
1498 PATH_EXEC, 0);
1499 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1500 /* FIXME? For ns, path_exec should go at the front? */
1501 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1504 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1506 void
1507 init_callproc (void)
1509 bool data_dir = egetenv ("EMACSDATA") != 0;
1511 char *sh;
1512 Lisp_Object tempdir;
1513 #ifdef HAVE_NS
1514 if (data_dir == 0)
1515 data_dir = ns_etc_directory () != 0;
1516 #endif
1518 if (!NILP (Vinstallation_directory))
1520 /* Add to the path the lib-src subdir of the installation dir. */
1521 Lisp_Object tem;
1522 tem = Fexpand_file_name (build_string ("lib-src"),
1523 Vinstallation_directory);
1524 #ifndef MSDOS
1525 /* MSDOS uses wrapped binaries, so don't do this. */
1526 if (NILP (Fmember (tem, Vexec_path)))
1528 #ifdef HAVE_NS
1529 const char *path_exec = ns_exec_path ();
1530 #endif
1531 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1532 Vexec_path = decode_env_path ("EMACSPATH",
1533 #ifdef HAVE_NS
1534 path_exec ? path_exec :
1535 #endif
1536 SSDATA (tem), 0);
1537 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1540 Vexec_directory = Ffile_name_as_directory (tem);
1541 #endif /* not MSDOS */
1543 /* Maybe use ../etc as well as ../lib-src. */
1544 if (data_dir == 0)
1546 tem = Fexpand_file_name (build_string ("etc"),
1547 Vinstallation_directory);
1548 Vdoc_directory = Ffile_name_as_directory (tem);
1552 /* Look for the files that should be in etc. We don't use
1553 Vinstallation_directory, because these files are never installed
1554 near the executable, and they are never in the build
1555 directory when that's different from the source directory.
1557 Instead, if these files are not in the nominal place, we try the
1558 source directory. */
1559 if (data_dir == 0)
1561 Lisp_Object tem, tem1, srcdir;
1562 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1564 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1566 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1567 tem1 = Ffile_exists_p (tem);
1568 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1570 Lisp_Object newdir;
1571 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1572 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1573 tem1 = Ffile_exists_p (tem);
1574 if (!NILP (tem1))
1575 Vdata_directory = newdir;
1579 #ifndef CANNOT_DUMP
1580 if (initialized)
1581 #endif
1583 tempdir = Fdirectory_file_name (Vexec_directory);
1584 if (! file_accessible_directory_p (tempdir))
1585 dir_warning ("arch-dependent data dir", Vexec_directory);
1588 tempdir = Fdirectory_file_name (Vdata_directory);
1589 if (! file_accessible_directory_p (tempdir))
1590 dir_warning ("arch-independent data dir", Vdata_directory);
1592 sh = getenv ("SHELL");
1593 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1595 #ifdef DOS_NT
1596 Vshared_game_score_directory = Qnil;
1597 #else
1598 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1599 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1600 Vshared_game_score_directory = Qnil;
1601 #endif
1604 void
1605 set_initial_environment (void)
1607 char **envp;
1608 for (envp = environ; *envp; envp++)
1609 Vprocess_environment = Fcons (build_string (*envp),
1610 Vprocess_environment);
1611 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1612 to use `delete' and friends on process-environment. */
1613 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1616 void
1617 syms_of_callproc (void)
1619 #ifndef DOS_NT
1620 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1621 #else /* DOS_NT */
1622 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1623 #endif
1624 staticpro (&Vtemp_file_name_pattern);
1626 #ifdef MSDOS
1627 synch_process_tempfile = make_number (0);
1628 staticpro (&synch_process_tempfile);
1629 #endif
1631 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1632 doc: /* File name to load inferior shells from.
1633 Initialized from the SHELL environment variable, or to a system-dependent
1634 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1636 DEFVAR_LISP ("exec-path", Vexec_path,
1637 doc: /* List of directories to search programs to run in subprocesses.
1638 Each element is a string (directory name) or nil (try default directory).
1640 By default the last element of this list is `exec-directory'. The
1641 last element is not always used, for example in shell completion
1642 \(`shell-dynamic-complete-command'). */);
1644 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1645 doc: /* List of suffixes to try to find executable file names.
1646 Each element is a string. */);
1647 Vexec_suffixes = Qnil;
1649 DEFVAR_LISP ("exec-directory", Vexec_directory,
1650 doc: /* Directory for executables for Emacs to invoke.
1651 More generally, this includes any architecture-dependent files
1652 that are built and installed from the Emacs distribution. */);
1654 DEFVAR_LISP ("data-directory", Vdata_directory,
1655 doc: /* Directory of machine-independent files that come with GNU Emacs.
1656 These are files intended for Emacs to use while it runs. */);
1658 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1659 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1660 This is usually the same as `data-directory'. */);
1662 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1663 doc: /* For internal use by the build procedure only.
1664 This is the name of the directory in which the build procedure installed
1665 Emacs's info files; the default value for `Info-default-directory-list'
1666 includes this. */);
1667 Vconfigure_info_directory = build_string (PATH_INFO);
1669 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1670 doc: /* Directory of score files for games which come with GNU Emacs.
1671 If this variable is nil, then Emacs is unable to use a shared directory. */);
1672 #ifdef DOS_NT
1673 Vshared_game_score_directory = Qnil;
1674 #else
1675 Vshared_game_score_directory = build_string (PATH_GAME);
1676 #endif
1678 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1679 doc: /* List of environment variables inherited from the parent process.
1680 Each element should be a string of the form ENVVARNAME=VALUE.
1681 The elements must normally be decoded (using `locale-coding-system') for use. */);
1682 Vinitial_environment = Qnil;
1684 DEFVAR_LISP ("process-environment", Vprocess_environment,
1685 doc: /* List of overridden environment variables for subprocesses to inherit.
1686 Each element should be a string of the form ENVVARNAME=VALUE.
1688 Entries in this list take precedence to those in the frame-local
1689 environments. Therefore, let-binding `process-environment' is an easy
1690 way to temporarily change the value of an environment variable,
1691 irrespective of where it comes from. To use `process-environment' to
1692 remove an environment variable, include only its name in the list,
1693 without "=VALUE".
1695 This variable is set to nil when Emacs starts.
1697 If multiple entries define the same variable, the first one always
1698 takes precedence.
1700 Non-ASCII characters are encoded according to the initial value of
1701 `locale-coding-system', i.e. the elements must normally be decoded for
1702 use.
1704 See `setenv' and `getenv'. */);
1705 Vprocess_environment = Qnil;
1707 defsubr (&Scall_process);
1708 defsubr (&Sgetenv_internal);
1709 defsubr (&Scall_process_region);