]> code.delx.au - gnu-emacs/blob - src/callproc.c
Merge from emacs-24; up to 2012-11-20T20:06:17Z!monnier@iro.umontreal.ca
[gnu-emacs] / src / callproc.c
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2012
3 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <sys/types.h>
25 #include <unistd.h>
26
27 #include <sys/file.h>
28 #include <fcntl.h>
29
30 #include "lisp.h"
31
32 #ifdef WINDOWSNT
33 #define NOMINMAX
34 #include <windows.h>
35 #include "w32.h"
36 #define _P_NOWAIT 1 /* from process.h */
37 #endif
38
39 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
40 #include <sys/stat.h>
41 #include <sys/param.h>
42 #endif /* MSDOS */
43
44 #include "commands.h"
45 #include "character.h"
46 #include "buffer.h"
47 #include "ccl.h"
48 #include "coding.h"
49 #include "composite.h"
50 #include <epaths.h>
51 #include "process.h"
52 #include "syssignal.h"
53 #include "systty.h"
54 #include "syswait.h"
55 #include "blockinput.h"
56 #include "frame.h"
57 #include "termhooks.h"
58
59 #ifdef MSDOS
60 #include "msdos.h"
61 #endif
62
63 #ifdef HAVE_NS
64 #include "nsterm.h"
65 #endif
66
67 /* Pattern used by call-process-region to make temp files. */
68 static Lisp_Object Vtemp_file_name_pattern;
69
70 /* True if we are about to fork off a synchronous process or if we
71 are waiting for it. */
72 bool synch_process_alive;
73
74 /* Nonzero => this is a string explaining death of synchronous subprocess. */
75 const char *synch_process_death;
76
77 /* Nonzero => this is the signal number that terminated the subprocess. */
78 int synch_process_termsig;
79
80 /* If synch_process_death is zero,
81 this is exit code of synchronous subprocess. */
82 int synch_process_retcode;
83
84 \f
85 /* Clean up when exiting Fcall_process.
86 On MSDOS, delete the temporary file on any kind of termination.
87 On Unix, kill the process and any children on termination by signal. */
88
89 /* True if this is termination due to exit. */
90 static bool call_process_exited;
91
92 static Lisp_Object
93 call_process_kill (Lisp_Object fdpid)
94 {
95 int fd;
96 pid_t pid;
97 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
98 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
99 emacs_close (fd);
100 EMACS_KILLPG (pid, SIGKILL);
101 synch_process_alive = 0;
102 return Qnil;
103 }
104
105 static Lisp_Object
106 call_process_cleanup (Lisp_Object arg)
107 {
108 Lisp_Object fdpid = Fcdr (arg);
109 int fd;
110 #if defined (MSDOS)
111 Lisp_Object file;
112 #else
113 pid_t pid;
114 #endif
115
116 Fset_buffer (Fcar (arg));
117 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
118
119 #if defined (MSDOS)
120 /* for MSDOS fdpid is really (fd . tempfile) */
121 file = Fcdr (fdpid);
122 /* FD is -1 and FILE is "" when we didn't actually create a
123 temporary file in call-process. */
124 if (fd >= 0)
125 emacs_close (fd);
126 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
127 unlink (SDATA (file));
128 #else /* not MSDOS */
129 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
130
131 if (call_process_exited)
132 {
133 emacs_close (fd);
134 return Qnil;
135 }
136
137 if (EMACS_KILLPG (pid, SIGINT) == 0)
138 {
139 ptrdiff_t count = SPECPDL_INDEX ();
140 record_unwind_protect (call_process_kill, fdpid);
141 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
142 immediate_quit = 1;
143 QUIT;
144 wait_for_termination (pid);
145 immediate_quit = 0;
146 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
147 message1 ("Waiting for process to die...done");
148 }
149 synch_process_alive = 0;
150 emacs_close (fd);
151 #endif /* not MSDOS */
152 return Qnil;
153 }
154
155 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
156 doc: /* Call PROGRAM synchronously in separate process.
157 The remaining arguments are optional.
158 The program's input comes from file INFILE (nil means `/dev/null').
159 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
160 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
161 FILE is a file name string, means that it should be written to that file
162 \(if the file already exists it is overwritten).
163 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
164 REAL-BUFFER says what to do with standard output, as above,
165 while STDERR-FILE says what to do with standard error in the child.
166 STDERR-FILE may be nil (discard standard error output),
167 t (mix it with ordinary output), or a file name string.
168
169 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
170 Remaining arguments are strings passed as command arguments to PROGRAM.
171
172 If executable PROGRAM can't be found as an executable, `call-process'
173 signals a Lisp error. `call-process' reports errors in execution of
174 the program only through its return and output.
175
176 If BUFFER is 0, `call-process' returns immediately with value nil.
177 Otherwise it waits for PROGRAM to terminate
178 and returns a numeric exit status or a signal description string.
179 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
180
181 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
182 (ptrdiff_t nargs, Lisp_Object *args)
183 {
184 Lisp_Object infile, buffer, current_dir, path, cleanup_info_tail;
185 bool display_p;
186 int fd[2];
187 int filefd;
188 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
189 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
190 char buf[CALLPROC_BUFFER_SIZE_MAX];
191 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
192 ptrdiff_t count = SPECPDL_INDEX ();
193 USE_SAFE_ALLOCA;
194
195 register const unsigned char **new_argv;
196 /* File to use for stderr in the child.
197 t means use same as standard output. */
198 Lisp_Object error_file;
199 Lisp_Object output_file = Qnil;
200 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
201 char *outf, *tempfile = NULL;
202 int outfilefd;
203 int pid;
204 #else
205 pid_t pid;
206 #endif
207 int fd_output = -1;
208 struct coding_system process_coding; /* coding-system of process output */
209 struct coding_system argument_coding; /* coding-system of arguments */
210 /* Set to the return value of Ffind_operation_coding_system. */
211 Lisp_Object coding_systems;
212 bool output_to_buffer = 1;
213
214 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
215 coding_systems = Qt;
216
217 CHECK_STRING (args[0]);
218
219 error_file = Qt;
220
221 #ifndef subprocesses
222 /* Without asynchronous processes we cannot have BUFFER == 0. */
223 if (nargs >= 3
224 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
225 error ("Operating system cannot handle asynchronous subprocesses");
226 #endif /* subprocesses */
227
228 /* Decide the coding-system for giving arguments. */
229 {
230 Lisp_Object val, *args2;
231 ptrdiff_t i;
232
233 /* If arguments are supplied, we may have to encode them. */
234 if (nargs >= 5)
235 {
236 bool must_encode = 0;
237 Lisp_Object coding_attrs;
238
239 for (i = 4; i < nargs; i++)
240 CHECK_STRING (args[i]);
241
242 for (i = 4; i < nargs; i++)
243 if (STRING_MULTIBYTE (args[i]))
244 must_encode = 1;
245
246 if (!NILP (Vcoding_system_for_write))
247 val = Vcoding_system_for_write;
248 else if (! must_encode)
249 val = Qraw_text;
250 else
251 {
252 SAFE_NALLOCA (args2, 1, nargs + 1);
253 args2[0] = Qcall_process;
254 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
255 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
256 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
257 }
258 val = complement_process_encoding_system (val);
259 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
260 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
261 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
262 {
263 /* We should not use an ASCII incompatible coding system. */
264 val = raw_text_coding_system (val);
265 setup_coding_system (val, &argument_coding);
266 }
267 }
268 }
269
270 if (nargs >= 2 && ! NILP (args[1]))
271 {
272 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
273 CHECK_STRING (infile);
274 }
275 else
276 infile = build_string (NULL_DEVICE);
277
278 if (nargs >= 3)
279 {
280 buffer = args[2];
281
282 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
283 FILE-FOR-STDERR), unless the first element is :file, in which case see
284 the next paragraph. */
285 if (CONSP (buffer)
286 && (! SYMBOLP (XCAR (buffer))
287 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
288 {
289 if (CONSP (XCDR (buffer)))
290 {
291 Lisp_Object stderr_file;
292 stderr_file = XCAR (XCDR (buffer));
293
294 if (NILP (stderr_file) || EQ (Qt, stderr_file))
295 error_file = stderr_file;
296 else
297 error_file = Fexpand_file_name (stderr_file, Qnil);
298 }
299
300 buffer = XCAR (buffer);
301 }
302
303 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
304 if (CONSP (buffer)
305 && SYMBOLP (XCAR (buffer))
306 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
307 {
308 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
309 BVAR (current_buffer, directory));
310 CHECK_STRING (output_file);
311 buffer = Qnil;
312 }
313
314 if (!(EQ (buffer, Qnil)
315 || EQ (buffer, Qt)
316 || INTEGERP (buffer)))
317 {
318 Lisp_Object spec_buffer;
319 spec_buffer = buffer;
320 buffer = Fget_buffer_create (buffer);
321 /* Mention the buffer name for a better error message. */
322 if (NILP (buffer))
323 CHECK_BUFFER (spec_buffer);
324 CHECK_BUFFER (buffer);
325 }
326 }
327 else
328 buffer = Qnil;
329
330 /* Make sure that the child will be able to chdir to the current
331 buffer's current directory, or its unhandled equivalent. We
332 can't just have the child check for an error when it does the
333 chdir, since it's in a vfork.
334
335 We have to GCPRO around this because Fexpand_file_name,
336 Funhandled_file_name_directory, and Ffile_accessible_directory_p
337 might call a file name handling function. The argument list is
338 protected by the caller, so all we really have to worry about is
339 buffer. */
340 {
341 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
342
343 current_dir = BVAR (current_buffer, directory);
344
345 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
346
347 current_dir = Funhandled_file_name_directory (current_dir);
348 if (NILP (current_dir))
349 /* If the file name handler says that current_dir is unreachable, use
350 a sensible default. */
351 current_dir = build_string ("~/");
352 current_dir = expand_and_dir_to_file (current_dir, Qnil);
353 current_dir = Ffile_name_as_directory (current_dir);
354
355 if (NILP (Ffile_accessible_directory_p (current_dir)))
356 report_file_error ("Setting current directory",
357 Fcons (BVAR (current_buffer, directory), Qnil));
358
359 if (STRING_MULTIBYTE (infile))
360 infile = ENCODE_FILE (infile);
361 if (STRING_MULTIBYTE (current_dir))
362 current_dir = ENCODE_FILE (current_dir);
363 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
364 error_file = ENCODE_FILE (error_file);
365 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
366 output_file = ENCODE_FILE (output_file);
367 UNGCPRO;
368 }
369
370 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
371
372 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
373 if (filefd < 0)
374 {
375 infile = DECODE_FILE (infile);
376 report_file_error ("Opening process input file", Fcons (infile, Qnil));
377 }
378
379 if (STRINGP (output_file))
380 {
381 #ifdef DOS_NT
382 fd_output = emacs_open (SSDATA (output_file),
383 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
384 S_IREAD | S_IWRITE);
385 #else /* not DOS_NT */
386 fd_output = creat (SSDATA (output_file), 0666);
387 #endif /* not DOS_NT */
388 if (fd_output < 0)
389 {
390 output_file = DECODE_FILE (output_file);
391 report_file_error ("Opening process output file",
392 Fcons (output_file, Qnil));
393 }
394 if (STRINGP (error_file) || NILP (error_file))
395 output_to_buffer = 0;
396 }
397
398 /* Search for program; barf if not found. */
399 {
400 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
401
402 GCPRO4 (infile, buffer, current_dir, error_file);
403 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
404 UNGCPRO;
405 }
406 if (NILP (path))
407 {
408 emacs_close (filefd);
409 report_file_error ("Searching for program", Fcons (args[0], Qnil));
410 }
411
412 /* If program file name starts with /: for quoting a magic name,
413 discard that. */
414 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
415 && SREF (path, 1) == ':')
416 path = Fsubstring (path, make_number (2), Qnil);
417
418 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
419 if (nargs > 4)
420 {
421 ptrdiff_t i;
422 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
423
424 GCPRO5 (infile, buffer, current_dir, path, error_file);
425 argument_coding.dst_multibyte = 0;
426 for (i = 4; i < nargs; i++)
427 {
428 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
429 if (CODING_REQUIRE_ENCODING (&argument_coding))
430 /* We must encode this argument. */
431 args[i] = encode_coding_string (&argument_coding, args[i], 1);
432 }
433 UNGCPRO;
434 for (i = 4; i < nargs; i++)
435 new_argv[i - 3] = SDATA (args[i]);
436 new_argv[i - 3] = 0;
437 }
438 else
439 new_argv[1] = 0;
440 new_argv[0] = SDATA (path);
441
442 #ifdef MSDOS /* MW, July 1993 */
443
444 /* If we're redirecting STDOUT to a file, that file is already open
445 on fd_output. */
446 if (fd_output < 0)
447 {
448 if ((outf = egetenv ("TMPDIR")))
449 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
450 else
451 {
452 tempfile = alloca (20);
453 *tempfile = '\0';
454 }
455 dostounix_filename (tempfile);
456 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
457 strcat (tempfile, "/");
458 strcat (tempfile, "detmp.XXX");
459 mktemp (tempfile);
460 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
461 if (outfilefd < 0) {
462 emacs_close (filefd);
463 report_file_error ("Opening process output file",
464 Fcons (build_string (tempfile), Qnil));
465 }
466 }
467 else
468 outfilefd = fd_output;
469 fd[0] = filefd;
470 fd[1] = outfilefd;
471 #endif /* MSDOS */
472
473 if (INTEGERP (buffer))
474 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
475 else
476 {
477 #ifndef MSDOS
478 errno = 0;
479 if (pipe (fd) == -1)
480 {
481 emacs_close (filefd);
482 report_file_error ("Creating process pipe", Qnil);
483 }
484 #endif
485 }
486
487 {
488 /* child_setup must clobber environ in systems with true vfork.
489 Protect it from permanent change. */
490 register char **save_environ = environ;
491 register int fd1 = fd[1];
492 int fd_error = fd1;
493
494 if (fd_output >= 0)
495 fd1 = fd_output;
496
497 /* Record that we're about to create a synchronous process. */
498 synch_process_alive = 1;
499
500 /* These vars record information from process termination.
501 Clear them now before process can possibly terminate,
502 to avoid timing error if process terminates soon. */
503 synch_process_death = 0;
504 synch_process_retcode = 0;
505 synch_process_termsig = 0;
506
507 if (NILP (error_file))
508 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
509 else if (STRINGP (error_file))
510 {
511 #ifdef DOS_NT
512 fd_error = emacs_open (SSDATA (error_file),
513 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
514 S_IREAD | S_IWRITE);
515 #else /* not DOS_NT */
516 fd_error = creat (SSDATA (error_file), 0666);
517 #endif /* not DOS_NT */
518 }
519
520 if (fd_error < 0)
521 {
522 emacs_close (filefd);
523 if (fd[0] != filefd)
524 emacs_close (fd[0]);
525 if (fd1 >= 0)
526 emacs_close (fd1);
527 #ifdef MSDOS
528 unlink (tempfile);
529 #endif
530 if (NILP (error_file))
531 error_file = build_string (NULL_DEVICE);
532 else if (STRINGP (error_file))
533 error_file = DECODE_FILE (error_file);
534 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
535 }
536
537 #ifdef MSDOS /* MW, July 1993 */
538 /* Note that on MSDOS `child_setup' actually returns the child process
539 exit status, not its PID, so we assign it to `synch_process_retcode'
540 below. */
541 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
542 0, current_dir);
543
544 /* Record that the synchronous process exited and note its
545 termination status. */
546 synch_process_alive = 0;
547 synch_process_retcode = pid;
548 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
549 {
550 synchronize_system_messages_locale ();
551 synch_process_death = strerror (errno);
552 }
553
554 emacs_close (outfilefd);
555 if (fd_error != outfilefd)
556 emacs_close (fd_error);
557 fd1 = -1; /* No harm in closing that one! */
558 if (tempfile)
559 {
560 /* Since CRLF is converted to LF within `decode_coding', we
561 can always open a file with binary mode. */
562 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
563 if (fd[0] < 0)
564 {
565 unlink (tempfile);
566 emacs_close (filefd);
567 report_file_error ("Cannot re-open temporary file",
568 Fcons (build_string (tempfile), Qnil));
569 }
570 }
571 else
572 fd[0] = -1; /* We are not going to read from tempfile. */
573 #else /* not MSDOS */
574 #ifdef WINDOWSNT
575 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
576 0, current_dir);
577 #else /* not WINDOWSNT */
578
579 block_input ();
580
581 /* vfork, and prevent local vars from being clobbered by the vfork. */
582 {
583 Lisp_Object volatile buffer_volatile = buffer;
584 Lisp_Object volatile coding_systems_volatile = coding_systems;
585 Lisp_Object volatile current_dir_volatile = current_dir;
586 bool volatile display_p_volatile = display_p;
587 bool volatile output_to_buffer_volatile = output_to_buffer;
588 bool volatile sa_must_free_volatile = sa_must_free;
589 int volatile fd1_volatile = fd1;
590 int volatile fd_error_volatile = fd_error;
591 int volatile fd_output_volatile = fd_output;
592 ptrdiff_t volatile sa_count_volatile = sa_count;
593 unsigned char const **volatile new_argv_volatile = new_argv;
594
595 pid = vfork ();
596
597 buffer = buffer_volatile;
598 coding_systems = coding_systems_volatile;
599 current_dir = current_dir_volatile;
600 display_p = display_p_volatile;
601 fd1 = fd1_volatile;
602 fd_error = fd_error_volatile;
603 fd_output = fd_output_volatile;
604 output_to_buffer = output_to_buffer_volatile;
605 sa_must_free = sa_must_free_volatile;
606 sa_count = sa_count_volatile;
607 new_argv = new_argv_volatile;
608 }
609
610 if (pid == 0)
611 {
612 if (fd[0] >= 0)
613 emacs_close (fd[0]);
614
615 setsid ();
616
617 /* Emacs ignores SIGPIPE, but the child should not. */
618 signal (SIGPIPE, SIG_DFL);
619
620 child_setup (filefd, fd1, fd_error, (char **) new_argv,
621 0, current_dir);
622 }
623
624 unblock_input ();
625
626 #endif /* not WINDOWSNT */
627
628 /* The MSDOS case did this already. */
629 if (fd_error >= 0)
630 emacs_close (fd_error);
631 #endif /* not MSDOS */
632
633 environ = save_environ;
634
635 /* Close most of our fd's, but not fd[0]
636 since we will use that to read input from. */
637 emacs_close (filefd);
638 if (fd_output >= 0)
639 emacs_close (fd_output);
640 if (fd1 >= 0 && fd1 != fd_error)
641 emacs_close (fd1);
642 }
643
644 if (pid < 0)
645 {
646 if (fd[0] >= 0)
647 emacs_close (fd[0]);
648 report_file_error ("Doing vfork", Qnil);
649 }
650
651 if (INTEGERP (buffer))
652 {
653 if (fd[0] >= 0)
654 emacs_close (fd[0]);
655 return Qnil;
656 }
657
658 /* Enable sending signal if user quits below. */
659 call_process_exited = 0;
660
661 #if defined (MSDOS)
662 /* MSDOS needs different cleanup information. */
663 cleanup_info_tail = build_string (tempfile ? tempfile : "");
664 #else
665 cleanup_info_tail = INTEGER_TO_CONS (pid);
666 #endif /* not MSDOS */
667 record_unwind_protect (call_process_cleanup,
668 Fcons (Fcurrent_buffer (),
669 Fcons (INTEGER_TO_CONS (fd[0]),
670 cleanup_info_tail)));
671
672 if (BUFFERP (buffer))
673 Fset_buffer (buffer);
674
675 if (NILP (buffer))
676 {
677 /* If BUFFER is nil, we must read process output once and then
678 discard it, so setup coding system but with nil. */
679 setup_coding_system (Qnil, &process_coding);
680 process_coding.dst_multibyte = 0;
681 }
682 else
683 {
684 Lisp_Object val, *args2;
685
686 val = Qnil;
687 if (!NILP (Vcoding_system_for_read))
688 val = Vcoding_system_for_read;
689 else
690 {
691 if (EQ (coding_systems, Qt))
692 {
693 ptrdiff_t i;
694
695 SAFE_NALLOCA (args2, 1, nargs + 1);
696 args2[0] = Qcall_process;
697 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
698 coding_systems
699 = Ffind_operation_coding_system (nargs + 1, args2);
700 }
701 if (CONSP (coding_systems))
702 val = XCAR (coding_systems);
703 else if (CONSP (Vdefault_process_coding_system))
704 val = XCAR (Vdefault_process_coding_system);
705 else
706 val = Qnil;
707 }
708 Fcheck_coding_system (val);
709 /* In unibyte mode, character code conversion should not take
710 place but EOL conversion should. So, setup raw-text or one
711 of the subsidiary according to the information just setup. */
712 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
713 && !NILP (val))
714 val = raw_text_coding_system (val);
715 setup_coding_system (val, &process_coding);
716 process_coding.dst_multibyte
717 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
718 }
719 process_coding.src_multibyte = 0;
720
721 immediate_quit = 1;
722 QUIT;
723
724 if (output_to_buffer)
725 {
726 int nread;
727 bool first = 1;
728 EMACS_INT total_read = 0;
729 int carryover = 0;
730 bool display_on_the_fly = display_p;
731 struct coding_system saved_coding;
732
733 saved_coding = process_coding;
734 while (1)
735 {
736 /* Repeatedly read until we've filled as much as possible
737 of the buffer size we have. But don't read
738 less than 1024--save that for the next bufferful. */
739 nread = carryover;
740 while (nread < bufsize - 1024)
741 {
742 int this_read = emacs_read (fd[0], buf + nread,
743 bufsize - nread);
744
745 if (this_read < 0)
746 goto give_up;
747
748 if (this_read == 0)
749 {
750 process_coding.mode |= CODING_MODE_LAST_BLOCK;
751 break;
752 }
753
754 nread += this_read;
755 total_read += this_read;
756
757 if (display_on_the_fly)
758 break;
759 }
760
761 /* Now NREAD is the total amount of data in the buffer. */
762 immediate_quit = 0;
763
764 if (!NILP (buffer))
765 {
766 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
767 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
768 insert_1_both (buf, nread, nread, 0, 1, 0);
769 else
770 { /* We have to decode the input. */
771 Lisp_Object curbuf;
772 ptrdiff_t count1 = SPECPDL_INDEX ();
773
774 XSETBUFFER (curbuf, current_buffer);
775 /* We cannot allow after-change-functions be run
776 during decoding, because that might modify the
777 buffer, while we rely on process_coding.produced to
778 faithfully reflect inserted text until we
779 TEMP_SET_PT_BOTH below. */
780 specbind (Qinhibit_modification_hooks, Qt);
781 decode_coding_c_string (&process_coding,
782 (unsigned char *) buf, nread, curbuf);
783 unbind_to (count1, Qnil);
784 if (display_on_the_fly
785 && CODING_REQUIRE_DETECTION (&saved_coding)
786 && ! CODING_REQUIRE_DETECTION (&process_coding))
787 {
788 /* We have detected some coding system. But,
789 there's a possibility that the detection was
790 done by insufficient data. So, we give up
791 displaying on the fly. */
792 if (process_coding.produced > 0)
793 del_range_2 (process_coding.dst_pos,
794 process_coding.dst_pos_byte,
795 process_coding.dst_pos
796 + process_coding.produced_char,
797 process_coding.dst_pos_byte
798 + process_coding.produced, 0);
799 display_on_the_fly = 0;
800 process_coding = saved_coding;
801 carryover = nread;
802 /* This is to make the above condition always
803 fails in the future. */
804 saved_coding.common_flags
805 &= ~CODING_REQUIRE_DETECTION_MASK;
806 continue;
807 }
808
809 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
810 PT_BYTE + process_coding.produced);
811 carryover = process_coding.carryover_bytes;
812 if (carryover > 0)
813 memcpy (buf, process_coding.carryover,
814 process_coding.carryover_bytes);
815 }
816 }
817
818 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
819 break;
820
821 /* Make the buffer bigger as we continue to read more data,
822 but not past CALLPROC_BUFFER_SIZE_MAX. */
823 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
824 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
825 bufsize = CALLPROC_BUFFER_SIZE_MAX;
826
827 if (display_p)
828 {
829 if (first)
830 prepare_menu_bars ();
831 first = 0;
832 redisplay_preserve_echo_area (1);
833 /* This variable might have been set to 0 for code
834 detection. In that case, we set it back to 1 because
835 we should have already detected a coding system. */
836 display_on_the_fly = 1;
837 }
838 immediate_quit = 1;
839 QUIT;
840 }
841 give_up: ;
842
843 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
844 /* If the caller required, let the buffer inherit the
845 coding-system used to decode the process output. */
846 if (inherit_process_coding_system)
847 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
848 make_number (total_read));
849 }
850
851 #ifndef MSDOS
852 /* Wait for it to terminate, unless it already has. */
853 if (output_to_buffer)
854 wait_for_termination (pid);
855 else
856 interruptible_wait_for_termination (pid);
857 #endif
858
859 immediate_quit = 0;
860
861 /* Don't kill any children that the subprocess may have left behind
862 when exiting. */
863 call_process_exited = 1;
864
865 SAFE_FREE ();
866 unbind_to (count, Qnil);
867
868 if (synch_process_termsig)
869 {
870 const char *signame;
871
872 synchronize_system_messages_locale ();
873 signame = strsignal (synch_process_termsig);
874
875 if (signame == 0)
876 signame = "unknown";
877
878 synch_process_death = signame;
879 }
880
881 if (synch_process_death)
882 return code_convert_string_norecord (build_string (synch_process_death),
883 Vlocale_coding_system, 0);
884 return make_number (synch_process_retcode);
885 }
886 \f
887 static Lisp_Object
888 delete_temp_file (Lisp_Object name)
889 {
890 /* Suppress jka-compr handling, etc. */
891 ptrdiff_t count = SPECPDL_INDEX ();
892 specbind (intern ("file-name-handler-alist"), Qnil);
893 internal_delete_file (name);
894 unbind_to (count, Qnil);
895 return Qnil;
896 }
897
898 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
899 3, MANY, 0,
900 doc: /* Send text from START to END to a synchronous process running PROGRAM.
901 The remaining arguments are optional.
902 Delete the text if fourth arg DELETE is non-nil.
903
904 Insert output in BUFFER before point; t means current buffer; nil for
905 BUFFER means discard it; 0 means discard and don't wait; and `(:file
906 FILE)', where FILE is a file name string, means that it should be
907 written to that file (if the file already exists it is overwritten).
908 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
909 REAL-BUFFER says what to do with standard output, as above,
910 while STDERR-FILE says what to do with standard error in the child.
911 STDERR-FILE may be nil (discard standard error output),
912 t (mix it with ordinary output), or a file name string.
913
914 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
915 Remaining args are passed to PROGRAM at startup as command args.
916
917 If BUFFER is 0, `call-process-region' returns immediately with value nil.
918 Otherwise it waits for PROGRAM to terminate
919 and returns a numeric exit status or a signal description string.
920 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
921
922 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
923 (ptrdiff_t nargs, Lisp_Object *args)
924 {
925 struct gcpro gcpro1;
926 Lisp_Object filename_string;
927 register Lisp_Object start, end;
928 ptrdiff_t count = SPECPDL_INDEX ();
929 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
930 Lisp_Object coding_systems;
931 Lisp_Object val, *args2;
932 ptrdiff_t i;
933 Lisp_Object tmpdir;
934
935 if (STRINGP (Vtemporary_file_directory))
936 tmpdir = Vtemporary_file_directory;
937 else
938 {
939 #ifndef DOS_NT
940 if (getenv ("TMPDIR"))
941 tmpdir = build_string (getenv ("TMPDIR"));
942 else
943 tmpdir = build_string ("/tmp/");
944 #else /* DOS_NT */
945 char *outf;
946 if ((outf = egetenv ("TMPDIR"))
947 || (outf = egetenv ("TMP"))
948 || (outf = egetenv ("TEMP")))
949 tmpdir = build_string (outf);
950 else
951 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
952 #endif
953 }
954
955 {
956 USE_SAFE_ALLOCA;
957 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
958 char *tempfile = SAFE_ALLOCA (SBYTES (pattern) + 1);
959 memcpy (tempfile, SDATA (pattern), SBYTES (pattern) + 1);
960 coding_systems = Qt;
961
962 #ifdef HAVE_MKSTEMP
963 {
964 int fd;
965
966 block_input ();
967 fd = mkstemp (tempfile);
968 unblock_input ();
969 if (fd == -1)
970 report_file_error ("Failed to open temporary file",
971 Fcons (build_string (tempfile), Qnil));
972 else
973 close (fd);
974 }
975 #else
976 mktemp (tempfile);
977 #endif
978
979 filename_string = build_string (tempfile);
980 GCPRO1 (filename_string);
981 SAFE_FREE ();
982 }
983
984 start = args[0];
985 end = args[1];
986 /* Decide coding-system of the contents of the temporary file. */
987 if (!NILP (Vcoding_system_for_write))
988 val = Vcoding_system_for_write;
989 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
990 val = Qraw_text;
991 else
992 {
993 USE_SAFE_ALLOCA;
994 SAFE_NALLOCA (args2, 1, nargs + 1);
995 args2[0] = Qcall_process_region;
996 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
997 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
998 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
999 SAFE_FREE ();
1000 }
1001 val = complement_process_encoding_system (val);
1002
1003 {
1004 ptrdiff_t count1 = SPECPDL_INDEX ();
1005
1006 specbind (intern ("coding-system-for-write"), val);
1007 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1008 happen to get a ".Z" suffix. */
1009 specbind (intern ("file-name-handler-alist"), Qnil);
1010 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1011
1012 unbind_to (count1, Qnil);
1013 }
1014
1015 /* Note that Fcall_process takes care of binding
1016 coding-system-for-read. */
1017
1018 record_unwind_protect (delete_temp_file, filename_string);
1019
1020 if (nargs > 3 && !NILP (args[3]))
1021 Fdelete_region (start, end);
1022
1023 if (nargs > 3)
1024 {
1025 args += 2;
1026 nargs -= 2;
1027 }
1028 else
1029 {
1030 args[0] = args[2];
1031 nargs = 2;
1032 }
1033 args[1] = filename_string;
1034
1035 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1036 }
1037 \f
1038 #ifndef WINDOWSNT
1039 static int relocate_fd (int fd, int minfd);
1040 #endif
1041
1042 static char **
1043 add_env (char **env, char **new_env, char *string)
1044 {
1045 char **ep;
1046 bool ok = 1;
1047 if (string == NULL)
1048 return new_env;
1049
1050 /* See if this string duplicates any string already in the env.
1051 If so, don't put it in.
1052 When an env var has multiple definitions,
1053 we keep the definition that comes first in process-environment. */
1054 for (ep = env; ok && ep != new_env; ep++)
1055 {
1056 char *p = *ep, *q = string;
1057 while (ok)
1058 {
1059 if (*q != *p)
1060 break;
1061 if (*q == 0)
1062 /* The string is a lone variable name; keep it for now, we
1063 will remove it later. It is a placeholder for a
1064 variable that is not to be included in the environment. */
1065 break;
1066 if (*q == '=')
1067 ok = 0;
1068 p++, q++;
1069 }
1070 }
1071 if (ok)
1072 *new_env++ = string;
1073 return new_env;
1074 }
1075
1076 /* This is the last thing run in a newly forked inferior
1077 either synchronous or asynchronous.
1078 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1079 Initialize inferior's priority, pgrp, connected dir and environment.
1080 then exec another program based on new_argv.
1081
1082 This function may change environ for the superior process.
1083 Therefore, the superior process must save and restore the value
1084 of environ around the vfork and the call to this function.
1085
1086 If SET_PGRP, put the subprocess into a separate process group.
1087
1088 CURRENT_DIR is an elisp string giving the path of the current
1089 directory the subprocess should have. Since we can't really signal
1090 a decent error from within the child, this should be verified as an
1091 executable directory by the parent. */
1092
1093 int
1094 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1095 Lisp_Object current_dir)
1096 {
1097 char **env;
1098 char *pwd_var;
1099 #ifdef WINDOWSNT
1100 int cpid;
1101 HANDLE handles[3];
1102 #endif /* WINDOWSNT */
1103
1104 pid_t pid = getpid ();
1105
1106 /* Close Emacs's descriptors that this process should not have. */
1107 close_process_descs ();
1108
1109 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1110 we will lose if we call close_load_descs here. */
1111 #ifndef DOS_NT
1112 close_load_descs ();
1113 #endif
1114
1115 /* Note that use of alloca is always safe here. It's obvious for systems
1116 that do not have true vfork or that have true (stack) alloca.
1117 If using vfork and C_ALLOCA (when Emacs used to include
1118 src/alloca.c) it is safe because that changes the superior's
1119 static variables as if the superior had done alloca and will be
1120 cleaned up in the usual way. */
1121 {
1122 register char *temp;
1123 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1124
1125 i = SBYTES (current_dir);
1126 #ifdef MSDOS
1127 /* MSDOS must have all environment variables malloc'ed, because
1128 low-level libc functions that launch subsidiary processes rely
1129 on that. */
1130 pwd_var = xmalloc (i + 6);
1131 #else
1132 pwd_var = alloca (i + 6);
1133 #endif
1134 temp = pwd_var + 4;
1135 memcpy (pwd_var, "PWD=", 4);
1136 memcpy (temp, SDATA (current_dir), i);
1137 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1138 temp[i] = 0;
1139
1140 #ifndef DOS_NT
1141 /* We can't signal an Elisp error here; we're in a vfork. Since
1142 the callers check the current directory before forking, this
1143 should only return an error if the directory's permissions
1144 are changed between the check and this chdir, but we should
1145 at least check. */
1146 if (chdir (temp) < 0)
1147 _exit (errno);
1148 #else /* DOS_NT */
1149 /* Get past the drive letter, so that d:/ is left alone. */
1150 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1151 {
1152 temp += 2;
1153 i -= 2;
1154 }
1155 #endif /* DOS_NT */
1156
1157 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1158 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1159 temp[--i] = 0;
1160 }
1161
1162 /* Set `env' to a vector of the strings in the environment. */
1163 {
1164 register Lisp_Object tem;
1165 register char **new_env;
1166 char **p, **q;
1167 register int new_length;
1168 Lisp_Object display = Qnil;
1169
1170 new_length = 0;
1171
1172 for (tem = Vprocess_environment;
1173 CONSP (tem) && STRINGP (XCAR (tem));
1174 tem = XCDR (tem))
1175 {
1176 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1177 && (SDATA (XCAR (tem)) [7] == '\0'
1178 || SDATA (XCAR (tem)) [7] == '='))
1179 /* DISPLAY is specified in process-environment. */
1180 display = Qt;
1181 new_length++;
1182 }
1183
1184 /* If not provided yet, use the frame's DISPLAY. */
1185 if (NILP (display))
1186 {
1187 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1188 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1189 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1190 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1191 Vinitial_environment);
1192 if (STRINGP (tmp))
1193 {
1194 display = tmp;
1195 new_length++;
1196 }
1197 }
1198
1199 /* new_length + 2 to include PWD and terminating 0. */
1200 env = new_env = alloca ((new_length + 2) * sizeof *env);
1201 /* If we have a PWD envvar, pass one down,
1202 but with corrected value. */
1203 if (egetenv ("PWD"))
1204 *new_env++ = pwd_var;
1205
1206 if (STRINGP (display))
1207 {
1208 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1209 strcpy (vdata, "DISPLAY=");
1210 strcat (vdata, SSDATA (display));
1211 new_env = add_env (env, new_env, vdata);
1212 }
1213
1214 /* Overrides. */
1215 for (tem = Vprocess_environment;
1216 CONSP (tem) && STRINGP (XCAR (tem));
1217 tem = XCDR (tem))
1218 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1219
1220 *new_env = 0;
1221
1222 /* Remove variable names without values. */
1223 p = q = env;
1224 while (*p != 0)
1225 {
1226 while (*q != 0 && strchr (*q, '=') == NULL)
1227 q++;
1228 *p = *q++;
1229 if (*p != 0)
1230 p++;
1231 }
1232 }
1233
1234
1235 #ifdef WINDOWSNT
1236 prepare_standard_handles (in, out, err, handles);
1237 set_process_dir (SDATA (current_dir));
1238 /* Spawn the child. (See ntproc.c:Spawnve). */
1239 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1240 reset_standard_handles (in, out, err, handles);
1241 if (cpid == -1)
1242 /* An error occurred while trying to spawn the process. */
1243 report_file_error ("Spawning child process", Qnil);
1244 return cpid;
1245
1246 #else /* not WINDOWSNT */
1247 /* Make sure that in, out, and err are not actually already in
1248 descriptors zero, one, or two; this could happen if Emacs is
1249 started with its standard in, out, or error closed, as might
1250 happen under X. */
1251 {
1252 int oin = in, oout = out;
1253
1254 /* We have to avoid relocating the same descriptor twice! */
1255
1256 in = relocate_fd (in, 3);
1257
1258 if (out == oin)
1259 out = in;
1260 else
1261 out = relocate_fd (out, 3);
1262
1263 if (err == oin)
1264 err = in;
1265 else if (err == oout)
1266 err = out;
1267 else
1268 err = relocate_fd (err, 3);
1269 }
1270
1271 #ifndef MSDOS
1272 emacs_close (0);
1273 emacs_close (1);
1274 emacs_close (2);
1275
1276 dup2 (in, 0);
1277 dup2 (out, 1);
1278 dup2 (err, 2);
1279 emacs_close (in);
1280 if (out != in)
1281 emacs_close (out);
1282 if (err != in && err != out)
1283 emacs_close (err);
1284
1285 setpgid (0, 0);
1286 tcsetpgrp (0, pid);
1287
1288 /* execvp does not accept an environment arg so the only way
1289 to pass this environment is to set environ. Our caller
1290 is responsible for restoring the ambient value of environ. */
1291 environ = env;
1292 execvp (new_argv[0], new_argv);
1293
1294 emacs_write (1, "Can't exec program: ", 20);
1295 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1296 emacs_write (1, "\n", 1);
1297 _exit (1);
1298
1299 #else /* MSDOS */
1300 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1301 xfree (pwd_var);
1302 if (pid == -1)
1303 /* An error occurred while trying to run the subprocess. */
1304 report_file_error ("Spawning child process", Qnil);
1305 return pid;
1306 #endif /* MSDOS */
1307 #endif /* not WINDOWSNT */
1308 }
1309
1310 #ifndef WINDOWSNT
1311 /* Move the file descriptor FD so that its number is not less than MINFD.
1312 If the file descriptor is moved at all, the original is freed. */
1313 static int
1314 relocate_fd (int fd, int minfd)
1315 {
1316 if (fd >= minfd)
1317 return fd;
1318 else
1319 {
1320 int new = fcntl (fd, F_DUPFD, minfd);
1321 if (new == -1)
1322 {
1323 const char *message_1 = "Error while setting up child: ";
1324 const char *errmessage = strerror (errno);
1325 const char *message_2 = "\n";
1326 emacs_write (2, message_1, strlen (message_1));
1327 emacs_write (2, errmessage, strlen (errmessage));
1328 emacs_write (2, message_2, strlen (message_2));
1329 _exit (1);
1330 }
1331 emacs_close (fd);
1332 return new;
1333 }
1334 }
1335 #endif /* not WINDOWSNT */
1336
1337 static bool
1338 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1339 ptrdiff_t *valuelen, Lisp_Object env)
1340 {
1341 for (; CONSP (env); env = XCDR (env))
1342 {
1343 Lisp_Object entry = XCAR (env);
1344 if (STRINGP (entry)
1345 && SBYTES (entry) >= varlen
1346 #ifdef WINDOWSNT
1347 /* NT environment variables are case insensitive. */
1348 && ! strnicmp (SDATA (entry), var, varlen)
1349 #else /* not WINDOWSNT */
1350 && ! memcmp (SDATA (entry), var, varlen)
1351 #endif /* not WINDOWSNT */
1352 )
1353 {
1354 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1355 {
1356 *value = SSDATA (entry) + (varlen + 1);
1357 *valuelen = SBYTES (entry) - (varlen + 1);
1358 return 1;
1359 }
1360 else if (SBYTES (entry) == varlen)
1361 {
1362 /* Lone variable names in Vprocess_environment mean that
1363 variable should be removed from the environment. */
1364 *value = NULL;
1365 return 1;
1366 }
1367 }
1368 }
1369 return 0;
1370 }
1371
1372 static bool
1373 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1374 ptrdiff_t *valuelen, Lisp_Object frame)
1375 {
1376 /* Try to find VAR in Vprocess_environment first. */
1377 if (getenv_internal_1 (var, varlen, value, valuelen,
1378 Vprocess_environment))
1379 return *value ? 1 : 0;
1380
1381 /* For DISPLAY try to get the values from the frame or the initial env. */
1382 if (strcmp (var, "DISPLAY") == 0)
1383 {
1384 Lisp_Object display
1385 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1386 if (STRINGP (display))
1387 {
1388 *value = SSDATA (display);
1389 *valuelen = SBYTES (display);
1390 return 1;
1391 }
1392 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1393 if (getenv_internal_1 (var, varlen, value, valuelen,
1394 Vinitial_environment))
1395 return *value ? 1 : 0;
1396 }
1397
1398 return 0;
1399 }
1400
1401 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1402 doc: /* Get the value of environment variable VARIABLE.
1403 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1404 the environment. Otherwise, value is a string.
1405
1406 This function searches `process-environment' for VARIABLE.
1407
1408 If optional parameter ENV is a list, then search this list instead of
1409 `process-environment', and return t when encountering a negative entry
1410 \(an entry for a variable with no value). */)
1411 (Lisp_Object variable, Lisp_Object env)
1412 {
1413 char *value;
1414 ptrdiff_t valuelen;
1415
1416 CHECK_STRING (variable);
1417 if (CONSP (env))
1418 {
1419 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1420 &value, &valuelen, env))
1421 return value ? make_string (value, valuelen) : Qt;
1422 else
1423 return Qnil;
1424 }
1425 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1426 &value, &valuelen, env))
1427 return make_string (value, valuelen);
1428 else
1429 return Qnil;
1430 }
1431
1432 /* A version of getenv that consults the Lisp environment lists,
1433 easily callable from C. */
1434 char *
1435 egetenv (const char *var)
1436 {
1437 char *value;
1438 ptrdiff_t valuelen;
1439
1440 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1441 return value;
1442 else
1443 return 0;
1444 }
1445
1446 \f
1447 /* This is run before init_cmdargs. */
1448
1449 void
1450 init_callproc_1 (void)
1451 {
1452 #ifdef HAVE_NS
1453 const char *etc_dir = ns_etc_directory ();
1454 const char *path_exec = ns_exec_path ();
1455 #endif
1456
1457 Vdata_directory = decode_env_path ("EMACSDATA",
1458 #ifdef HAVE_NS
1459 etc_dir ? etc_dir :
1460 #endif
1461 PATH_DATA);
1462 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1463
1464 Vdoc_directory = decode_env_path ("EMACSDOC",
1465 #ifdef HAVE_NS
1466 etc_dir ? etc_dir :
1467 #endif
1468 PATH_DOC);
1469 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1470
1471 /* Check the EMACSPATH environment variable, defaulting to the
1472 PATH_EXEC path from epaths.h. */
1473 Vexec_path = decode_env_path ("EMACSPATH",
1474 #ifdef HAVE_NS
1475 path_exec ? path_exec :
1476 #endif
1477 PATH_EXEC);
1478 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1479 /* FIXME? For ns, path_exec should go at the front? */
1480 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1481 }
1482
1483 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1484
1485 void
1486 init_callproc (void)
1487 {
1488 char *data_dir = egetenv ("EMACSDATA");
1489
1490 register char * sh;
1491 Lisp_Object tempdir;
1492 #ifdef HAVE_NS
1493 if (data_dir == 0)
1494 {
1495 const char *etc_dir = ns_etc_directory ();
1496 if (etc_dir)
1497 {
1498 data_dir = alloca (strlen (etc_dir) + 1);
1499 strcpy (data_dir, etc_dir);
1500 }
1501 }
1502 #endif
1503
1504 if (!NILP (Vinstallation_directory))
1505 {
1506 /* Add to the path the lib-src subdir of the installation dir. */
1507 Lisp_Object tem;
1508 tem = Fexpand_file_name (build_string ("lib-src"),
1509 Vinstallation_directory);
1510 #ifndef MSDOS
1511 /* MSDOS uses wrapped binaries, so don't do this. */
1512 if (NILP (Fmember (tem, Vexec_path)))
1513 {
1514 #ifdef HAVE_NS
1515 const char *path_exec = ns_exec_path ();
1516 #endif
1517 Vexec_path = decode_env_path ("EMACSPATH",
1518 #ifdef HAVE_NS
1519 path_exec ? path_exec :
1520 #endif
1521 PATH_EXEC);
1522 Vexec_path = Fcons (tem, Vexec_path);
1523 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1524 }
1525
1526 Vexec_directory = Ffile_name_as_directory (tem);
1527 #endif /* not MSDOS */
1528
1529 /* Maybe use ../etc as well as ../lib-src. */
1530 if (data_dir == 0)
1531 {
1532 tem = Fexpand_file_name (build_string ("etc"),
1533 Vinstallation_directory);
1534 Vdoc_directory = Ffile_name_as_directory (tem);
1535 }
1536 }
1537
1538 /* Look for the files that should be in etc. We don't use
1539 Vinstallation_directory, because these files are never installed
1540 near the executable, and they are never in the build
1541 directory when that's different from the source directory.
1542
1543 Instead, if these files are not in the nominal place, we try the
1544 source directory. */
1545 if (data_dir == 0)
1546 {
1547 Lisp_Object tem, tem1, srcdir;
1548
1549 srcdir = Fexpand_file_name (build_string ("../src/"),
1550 build_string (PATH_DUMPLOADSEARCH));
1551 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1552 tem1 = Ffile_exists_p (tem);
1553 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1554 {
1555 Lisp_Object newdir;
1556 newdir = Fexpand_file_name (build_string ("../etc/"),
1557 build_string (PATH_DUMPLOADSEARCH));
1558 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1559 tem1 = Ffile_exists_p (tem);
1560 if (!NILP (tem1))
1561 Vdata_directory = newdir;
1562 }
1563 }
1564
1565 #ifndef CANNOT_DUMP
1566 if (initialized)
1567 #endif
1568 {
1569 tempdir = Fdirectory_file_name (Vexec_directory);
1570 if (! file_accessible_directory_p (SSDATA (tempdir)))
1571 dir_warning ("arch-dependent data dir", Vexec_directory);
1572 }
1573
1574 tempdir = Fdirectory_file_name (Vdata_directory);
1575 if (! file_accessible_directory_p (SSDATA (tempdir)))
1576 dir_warning ("arch-independent data dir", Vdata_directory);
1577
1578 sh = (char *) getenv ("SHELL");
1579 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1580
1581 #ifdef DOS_NT
1582 Vshared_game_score_directory = Qnil;
1583 #else
1584 Vshared_game_score_directory = build_string (PATH_GAME);
1585 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1586 Vshared_game_score_directory = Qnil;
1587 #endif
1588 }
1589
1590 void
1591 set_initial_environment (void)
1592 {
1593 char **envp;
1594 for (envp = environ; *envp; envp++)
1595 Vprocess_environment = Fcons (build_string (*envp),
1596 Vprocess_environment);
1597 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1598 to use `delete' and friends on process-environment. */
1599 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1600 }
1601
1602 void
1603 syms_of_callproc (void)
1604 {
1605 #ifndef DOS_NT
1606 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1607 #elif defined (WINDOWSNT)
1608 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1609 #else
1610 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1611 #endif
1612 staticpro (&Vtemp_file_name_pattern);
1613
1614 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1615 doc: /* File name to load inferior shells from.
1616 Initialized from the SHELL environment variable, or to a system-dependent
1617 default if SHELL is not set. */);
1618
1619 DEFVAR_LISP ("exec-path", Vexec_path,
1620 doc: /* List of directories to search programs to run in subprocesses.
1621 Each element is a string (directory name) or nil (try default directory). */);
1622
1623 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1624 doc: /* List of suffixes to try to find executable file names.
1625 Each element is a string. */);
1626 Vexec_suffixes = Qnil;
1627
1628 DEFVAR_LISP ("exec-directory", Vexec_directory,
1629 doc: /* Directory for executables for Emacs to invoke.
1630 More generally, this includes any architecture-dependent files
1631 that are built and installed from the Emacs distribution. */);
1632
1633 DEFVAR_LISP ("data-directory", Vdata_directory,
1634 doc: /* Directory of machine-independent files that come with GNU Emacs.
1635 These are files intended for Emacs to use while it runs. */);
1636
1637 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1638 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1639 This is usually the same as `data-directory'. */);
1640
1641 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1642 doc: /* For internal use by the build procedure only.
1643 This is the name of the directory in which the build procedure installed
1644 Emacs's info files; the default value for `Info-default-directory-list'
1645 includes this. */);
1646 Vconfigure_info_directory = build_string (PATH_INFO);
1647
1648 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1649 doc: /* Directory of score files for games which come with GNU Emacs.
1650 If this variable is nil, then Emacs is unable to use a shared directory. */);
1651 #ifdef DOS_NT
1652 Vshared_game_score_directory = Qnil;
1653 #else
1654 Vshared_game_score_directory = build_string (PATH_GAME);
1655 #endif
1656
1657 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1658 doc: /* List of environment variables inherited from the parent process.
1659 Each element should be a string of the form ENVVARNAME=VALUE.
1660 The elements must normally be decoded (using `locale-coding-system') for use. */);
1661 Vinitial_environment = Qnil;
1662
1663 DEFVAR_LISP ("process-environment", Vprocess_environment,
1664 doc: /* List of overridden environment variables for subprocesses to inherit.
1665 Each element should be a string of the form ENVVARNAME=VALUE.
1666
1667 Entries in this list take precedence to those in the frame-local
1668 environments. Therefore, let-binding `process-environment' is an easy
1669 way to temporarily change the value of an environment variable,
1670 irrespective of where it comes from. To use `process-environment' to
1671 remove an environment variable, include only its name in the list,
1672 without "=VALUE".
1673
1674 This variable is set to nil when Emacs starts.
1675
1676 If multiple entries define the same variable, the first one always
1677 takes precedence.
1678
1679 Non-ASCII characters are encoded according to the initial value of
1680 `locale-coding-system', i.e. the elements must normally be decoded for
1681 use.
1682
1683 See `setenv' and `getenv'. */);
1684 Vprocess_environment = Qnil;
1685
1686 defsubr (&Scall_process);
1687 defsubr (&Sgetenv_internal);
1688 defsubr (&Scall_process_region);
1689 }