]> code.delx.au - gnu-emacs/blob - src/w32proc.c
(get_doc_string): New arg UNIBYTE
[gnu-emacs] / src / w32proc.c
1 /* Process support for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1992, 1995 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
20
21 Drew Bliss Oct 14, 1993
22 Adapted from alarm.c by Tim Fleehart
23 */
24
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <errno.h>
28 #include <io.h>
29 #include <fcntl.h>
30 #include <signal.h>
31
32 /* must include CRT headers *before* config.h */
33 #include "config.h"
34 #undef signal
35 #undef wait
36 #undef spawnve
37 #undef select
38 #undef kill
39
40 #include <windows.h>
41
42 #include "lisp.h"
43 #include "w32.h"
44 #include "w32heap.h"
45 #include "systime.h"
46 #include "syswait.h"
47 #include "process.h"
48 #include "w32term.h"
49
50 /* Control whether spawnve quotes arguments as necessary to ensure
51 correct parsing by child process. Because not all uses of spawnve
52 are careful about constructing argv arrays, we make this behaviour
53 conditional (off by default). */
54 Lisp_Object Vw32_quote_process_args;
55
56 /* Control whether create_child causes the process' window to be
57 hidden. The default is nil. */
58 Lisp_Object Vw32_start_process_show_window;
59
60 /* Control whether create_child causes the process to inherit Emacs'
61 console window, or be given a new one of its own. The default is
62 nil, to allow multiple DOS programs to run on Win95. Having separate
63 consoles also allows Emacs to cleanly terminate process groups. */
64 Lisp_Object Vw32_start_process_share_console;
65
66 /* Time to sleep before reading from a subprocess output pipe - this
67 avoids the inefficiency of frequently reading small amounts of data.
68 This is primarily necessary for handling DOS processes on Windows 95,
69 but is useful for W32 processes on both Windows 95 and NT as well. */
70 Lisp_Object Vw32_pipe_read_delay;
71
72 /* Control conversion of upper case file names to lower case.
73 nil means no, t means yes. */
74 Lisp_Object Vw32_downcase_file_names;
75
76 /* Control whether stat() attempts to generate fake but hopefully
77 "accurate" inode values, by hashing the absolute truenames of files.
78 This should detect aliasing between long and short names, but still
79 allows the possibility of hash collisions. */
80 Lisp_Object Vw32_generate_fake_inodes;
81
82 /* Control whether stat() attempts to determine file type and link count
83 exactly, at the expense of slower operation. Since true hard links
84 are supported on NTFS volumes, this is only relevant on NT. */
85 Lisp_Object Vw32_get_true_file_attributes;
86
87 Lisp_Object Qhigh, Qlow;
88
89 #ifndef SYS_SIGLIST_DECLARED
90 extern char *sys_siglist[];
91 #endif
92
93 #ifdef EMACSDEBUG
94 void _DebPrint (const char *fmt, ...)
95 {
96 char buf[1024];
97 va_list args;
98
99 va_start (args, fmt);
100 vsprintf (buf, fmt, args);
101 va_end (args);
102 OutputDebugString (buf);
103 }
104 #endif
105
106 typedef void (_CALLBACK_ *signal_handler)(int);
107
108 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
109 static signal_handler sig_handlers[NSIG];
110
111 /* Fake signal implementation to record the SIGCHLD handler. */
112 signal_handler
113 sys_signal (int sig, signal_handler handler)
114 {
115 signal_handler old;
116
117 if (sig != SIGCHLD)
118 {
119 errno = EINVAL;
120 return SIG_ERR;
121 }
122 old = sig_handlers[sig];
123 sig_handlers[sig] = handler;
124 return old;
125 }
126
127 /* Defined in <process.h> which conflicts with the local copy */
128 #define _P_NOWAIT 1
129
130 /* Child process management list. */
131 int child_proc_count = 0;
132 child_process child_procs[ MAX_CHILDREN ];
133 child_process *dead_child = NULL;
134
135 DWORD WINAPI reader_thread (void *arg);
136
137 /* Find an unused process slot. */
138 child_process *
139 new_child (void)
140 {
141 child_process *cp;
142 DWORD id;
143
144 for (cp = child_procs+(child_proc_count-1); cp >= child_procs; cp--)
145 if (!CHILD_ACTIVE (cp))
146 goto Initialise;
147 if (child_proc_count == MAX_CHILDREN)
148 return NULL;
149 cp = &child_procs[child_proc_count++];
150
151 Initialise:
152 memset (cp, 0, sizeof(*cp));
153 cp->fd = -1;
154 cp->pid = -1;
155 cp->procinfo.hProcess = NULL;
156 cp->status = STATUS_READ_ERROR;
157
158 /* use manual reset event so that select() will function properly */
159 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
160 if (cp->char_avail)
161 {
162 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
163 if (cp->char_consumed)
164 {
165 cp->thrd = CreateThread (NULL, 1024, reader_thread, cp, 0, &id);
166 if (cp->thrd)
167 return cp;
168 }
169 }
170 delete_child (cp);
171 return NULL;
172 }
173
174 void
175 delete_child (child_process *cp)
176 {
177 int i;
178
179 /* Should not be deleting a child that is still needed. */
180 for (i = 0; i < MAXDESC; i++)
181 if (fd_info[i].cp == cp)
182 abort ();
183
184 if (!CHILD_ACTIVE (cp))
185 return;
186
187 /* reap thread if necessary */
188 if (cp->thrd)
189 {
190 DWORD rc;
191
192 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
193 {
194 /* let the thread exit cleanly if possible */
195 cp->status = STATUS_READ_ERROR;
196 SetEvent (cp->char_consumed);
197 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
198 {
199 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
200 "with %lu for fd %ld\n", GetLastError (), cp->fd));
201 TerminateThread (cp->thrd, 0);
202 }
203 }
204 CloseHandle (cp->thrd);
205 cp->thrd = NULL;
206 }
207 if (cp->char_avail)
208 {
209 CloseHandle (cp->char_avail);
210 cp->char_avail = NULL;
211 }
212 if (cp->char_consumed)
213 {
214 CloseHandle (cp->char_consumed);
215 cp->char_consumed = NULL;
216 }
217
218 /* update child_proc_count (highest numbered slot in use plus one) */
219 if (cp == child_procs + child_proc_count - 1)
220 {
221 for (i = child_proc_count-1; i >= 0; i--)
222 if (CHILD_ACTIVE (&child_procs[i]))
223 {
224 child_proc_count = i + 1;
225 break;
226 }
227 }
228 if (i < 0)
229 child_proc_count = 0;
230 }
231
232 /* Find a child by pid. */
233 static child_process *
234 find_child_pid (DWORD pid)
235 {
236 child_process *cp;
237
238 for (cp = child_procs+(child_proc_count-1); cp >= child_procs; cp--)
239 if (CHILD_ACTIVE (cp) && pid == cp->pid)
240 return cp;
241 return NULL;
242 }
243
244
245 /* Thread proc for child process and socket reader threads. Each thread
246 is normally blocked until woken by select() to check for input by
247 reading one char. When the read completes, char_avail is signalled
248 to wake up the select emulator and the thread blocks itself again. */
249 DWORD WINAPI
250 reader_thread (void *arg)
251 {
252 child_process *cp;
253
254 /* Our identity */
255 cp = (child_process *)arg;
256
257 /* We have to wait for the go-ahead before we can start */
258 if (cp == NULL
259 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
260 return 1;
261
262 for (;;)
263 {
264 int rc;
265
266 rc = _sys_read_ahead (cp->fd);
267
268 /* The name char_avail is a misnomer - it really just means the
269 read-ahead has completed, whether successfully or not. */
270 if (!SetEvent (cp->char_avail))
271 {
272 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
273 GetLastError (), cp->fd));
274 return 1;
275 }
276
277 if (rc == STATUS_READ_ERROR)
278 return 1;
279
280 /* If the read died, the child has died so let the thread die */
281 if (rc == STATUS_READ_FAILED)
282 break;
283
284 /* Wait until our input is acknowledged before reading again */
285 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
286 {
287 DebPrint (("reader_thread.WaitForSingleObject failed with "
288 "%lu for fd %ld\n", GetLastError (), cp->fd));
289 break;
290 }
291 }
292 return 0;
293 }
294
295 /* To avoid Emacs changing directory, we just record here the directory
296 the new process should start in. This is set just before calling
297 sys_spawnve, and is not generally valid at any other time. */
298 static char * process_dir;
299
300 static BOOL
301 create_child (char *exe, char *cmdline, char *env,
302 int * pPid, child_process *cp)
303 {
304 STARTUPINFO start;
305 SECURITY_ATTRIBUTES sec_attrs;
306 SECURITY_DESCRIPTOR sec_desc;
307 char dir[ MAXPATHLEN ];
308
309 if (cp == NULL) abort ();
310
311 memset (&start, 0, sizeof (start));
312 start.cb = sizeof (start);
313
314 #ifdef HAVE_NTGUI
315 if (NILP (Vw32_start_process_show_window))
316 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
317 else
318 start.dwFlags = STARTF_USESTDHANDLES;
319 start.wShowWindow = SW_HIDE;
320
321 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
322 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
323 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
324 #endif /* HAVE_NTGUI */
325
326 /* Explicitly specify no security */
327 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
328 goto EH_Fail;
329 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
330 goto EH_Fail;
331 sec_attrs.nLength = sizeof (sec_attrs);
332 sec_attrs.lpSecurityDescriptor = &sec_desc;
333 sec_attrs.bInheritHandle = FALSE;
334
335 strcpy (dir, process_dir);
336 unixtodos_filename (dir);
337
338 if (!CreateProcess (exe, cmdline, &sec_attrs, NULL, TRUE,
339 (!NILP (Vw32_start_process_share_console)
340 ? CREATE_NEW_PROCESS_GROUP
341 : CREATE_NEW_CONSOLE),
342 env, dir,
343 &start, &cp->procinfo))
344 goto EH_Fail;
345
346 cp->pid = (int) cp->procinfo.dwProcessId;
347
348 /* Hack for Windows 95, which assigns large (ie negative) pids */
349 if (cp->pid < 0)
350 cp->pid = -cp->pid;
351
352 /* pid must fit in a Lisp_Int */
353 cp->pid = (cp->pid & VALMASK);
354
355 *pPid = cp->pid;
356
357 return TRUE;
358
359 EH_Fail:
360 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError()););
361 return FALSE;
362 }
363
364 /* create_child doesn't know what emacs' file handle will be for waiting
365 on output from the child, so we need to make this additional call
366 to register the handle with the process
367 This way the select emulator knows how to match file handles with
368 entries in child_procs. */
369 void
370 register_child (int pid, int fd)
371 {
372 child_process *cp;
373
374 cp = find_child_pid (pid);
375 if (cp == NULL)
376 {
377 DebPrint (("register_child unable to find pid %lu\n", pid));
378 return;
379 }
380
381 #ifdef FULL_DEBUG
382 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
383 #endif
384
385 cp->fd = fd;
386
387 /* thread is initially blocked until select is called; set status so
388 that select will release thread */
389 cp->status = STATUS_READ_ACKNOWLEDGED;
390
391 /* attach child_process to fd_info */
392 if (fd_info[fd].cp != NULL)
393 {
394 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
395 abort ();
396 }
397
398 fd_info[fd].cp = cp;
399 }
400
401 /* When a process dies its pipe will break so the reader thread will
402 signal failure to the select emulator.
403 The select emulator then calls this routine to clean up.
404 Since the thread signaled failure we can assume it is exiting. */
405 static void
406 reap_subprocess (child_process *cp)
407 {
408 if (cp->procinfo.hProcess)
409 {
410 /* Reap the process */
411 #ifdef FULL_DEBUG
412 /* Process should have already died before we are called. */
413 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
414 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp->fd));
415 #endif
416 CloseHandle (cp->procinfo.hProcess);
417 cp->procinfo.hProcess = NULL;
418 CloseHandle (cp->procinfo.hThread);
419 cp->procinfo.hThread = NULL;
420 }
421
422 /* For asynchronous children, the child_proc resources will be freed
423 when the last pipe read descriptor is closed; for synchronous
424 children, we must explicitly free the resources now because
425 register_child has not been called. */
426 if (cp->fd == -1)
427 delete_child (cp);
428 }
429
430 /* Wait for any of our existing child processes to die
431 When it does, close its handle
432 Return the pid and fill in the status if non-NULL. */
433
434 int
435 sys_wait (int *status)
436 {
437 DWORD active, retval;
438 int nh;
439 int pid;
440 child_process *cp, *cps[MAX_CHILDREN];
441 HANDLE wait_hnd[MAX_CHILDREN];
442
443 nh = 0;
444 if (dead_child != NULL)
445 {
446 /* We want to wait for a specific child */
447 wait_hnd[nh] = dead_child->procinfo.hProcess;
448 cps[nh] = dead_child;
449 if (!wait_hnd[nh]) abort ();
450 nh++;
451 active = 0;
452 goto get_result;
453 }
454 else
455 {
456 for (cp = child_procs+(child_proc_count-1); cp >= child_procs; cp--)
457 /* some child_procs might be sockets; ignore them */
458 if (CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
459 {
460 wait_hnd[nh] = cp->procinfo.hProcess;
461 cps[nh] = cp;
462 nh++;
463 }
464 }
465
466 if (nh == 0)
467 {
468 /* Nothing to wait on, so fail */
469 errno = ECHILD;
470 return -1;
471 }
472
473 do
474 {
475 /* Check for quit about once a second. */
476 QUIT;
477 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, 1000);
478 } while (active == WAIT_TIMEOUT);
479
480 if (active == WAIT_FAILED)
481 {
482 errno = EBADF;
483 return -1;
484 }
485 else if (active >= WAIT_OBJECT_0
486 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
487 {
488 active -= WAIT_OBJECT_0;
489 }
490 else if (active >= WAIT_ABANDONED_0
491 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
492 {
493 active -= WAIT_ABANDONED_0;
494 }
495 else
496 abort ();
497
498 get_result:
499 if (!GetExitCodeProcess (wait_hnd[active], &retval))
500 {
501 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
502 GetLastError ()));
503 retval = 1;
504 }
505 if (retval == STILL_ACTIVE)
506 {
507 /* Should never happen */
508 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
509 errno = EINVAL;
510 return -1;
511 }
512
513 /* Massage the exit code from the process to match the format expected
514 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
515 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
516
517 if (retval == STATUS_CONTROL_C_EXIT)
518 retval = SIGINT;
519 else
520 retval <<= 8;
521
522 cp = cps[active];
523 pid = cp->pid;
524 #ifdef FULL_DEBUG
525 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
526 #endif
527
528 if (status)
529 {
530 *status = retval;
531 }
532 else if (synch_process_alive)
533 {
534 synch_process_alive = 0;
535
536 /* Report the status of the synchronous process. */
537 if (WIFEXITED (retval))
538 synch_process_retcode = WRETCODE (retval);
539 else if (WIFSIGNALED (retval))
540 {
541 int code = WTERMSIG (retval);
542 char *signame = 0;
543
544 if (code < NSIG)
545 {
546 /* Suppress warning if the table has const char *. */
547 signame = (char *) sys_siglist[code];
548 }
549 if (signame == 0)
550 signame = "unknown";
551
552 synch_process_death = signame;
553 }
554
555 reap_subprocess (cp);
556 }
557
558 reap_subprocess (cp);
559
560 return pid;
561 }
562
563 void
564 w32_executable_type (char * filename, int * is_dos_app, int * is_cygnus_app)
565 {
566 file_data executable;
567 char * p;
568
569 /* Default values in case we can't tell for sure. */
570 *is_dos_app = FALSE;
571 *is_cygnus_app = FALSE;
572
573 if (!open_input_file (&executable, filename))
574 return;
575
576 p = strrchr (filename, '.');
577
578 /* We can only identify DOS .com programs from the extension. */
579 if (p && stricmp (p, ".com") == 0)
580 *is_dos_app = TRUE;
581 else if (p && (stricmp (p, ".bat") == 0
582 || stricmp (p, ".cmd") == 0))
583 {
584 /* A DOS shell script - it appears that CreateProcess is happy to
585 accept this (somewhat surprisingly); presumably it looks at
586 COMSPEC to determine what executable to actually invoke.
587 Therefore, we have to do the same here as well. */
588 /* Actually, I think it uses the program association for that
589 extension, which is defined in the registry. */
590 p = egetenv ("COMSPEC");
591 if (p)
592 w32_executable_type (p, is_dos_app, is_cygnus_app);
593 }
594 else
595 {
596 /* Look for DOS .exe signature - if found, we must also check that
597 it isn't really a 16- or 32-bit Windows exe, since both formats
598 start with a DOS program stub. Note that 16-bit Windows
599 executables use the OS/2 1.x format. */
600
601 IMAGE_DOS_HEADER * dos_header;
602 IMAGE_NT_HEADERS * nt_header;
603
604 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
605 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
606 goto unwind;
607
608 nt_header = (PIMAGE_NT_HEADERS) ((char *) dos_header + dos_header->e_lfanew);
609
610 if ((char *) nt_header > (char *) dos_header + executable.size)
611 {
612 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
613 *is_dos_app = TRUE;
614 }
615 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
616 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
617 {
618 *is_dos_app = TRUE;
619 }
620 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
621 {
622 /* Look for cygwin.dll in DLL import list. */
623 IMAGE_DATA_DIRECTORY import_dir =
624 nt_header->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT];
625 IMAGE_IMPORT_DESCRIPTOR * imports;
626 IMAGE_SECTION_HEADER * section;
627
628 section = rva_to_section (import_dir.VirtualAddress, nt_header);
629 imports = RVA_TO_PTR (import_dir.VirtualAddress, section, executable);
630
631 for ( ; imports->Name; imports++)
632 {
633 char * dllname = RVA_TO_PTR (imports->Name, section, executable);
634
635 if (strcmp (dllname, "cygwin.dll") == 0)
636 {
637 *is_cygnus_app = TRUE;
638 break;
639 }
640 }
641 }
642 }
643
644 unwind:
645 close_file_data (&executable);
646 }
647
648 int
649 compare_env (const char **strp1, const char **strp2)
650 {
651 const char *str1 = *strp1, *str2 = *strp2;
652
653 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
654 {
655 if (tolower (*str1) > tolower (*str2))
656 return 1;
657 else if (tolower (*str1) < tolower (*str2))
658 return -1;
659 str1++, str2++;
660 }
661
662 if (*str1 == '=' && *str2 == '=')
663 return 0;
664 else if (*str1 == '=')
665 return -1;
666 else
667 return 1;
668 }
669
670 void
671 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
672 {
673 char **optr, **nptr;
674 int num;
675
676 nptr = new_envp;
677 optr = envp1;
678 while (*optr)
679 *nptr++ = *optr++;
680 num = optr - envp1;
681
682 optr = envp2;
683 while (*optr)
684 *nptr++ = *optr++;
685 num += optr - envp2;
686
687 qsort (new_envp, num, sizeof (char *), compare_env);
688
689 *nptr = NULL;
690 }
691
692 /* When a new child process is created we need to register it in our list,
693 so intercept spawn requests. */
694 int
695 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
696 {
697 Lisp_Object program, full;
698 char *cmdline, *env, *parg, **targ;
699 int arglen, numenv;
700 int pid;
701 child_process *cp;
702 int is_dos_app, is_cygnus_app;
703 int do_quoting = 0;
704 char escape_char;
705 /* We pass our process ID to our children by setting up an environment
706 variable in their environment. */
707 char ppid_env_var_buffer[64];
708 char *extra_env[] = {ppid_env_var_buffer, NULL};
709
710 /* We don't care about the other modes */
711 if (mode != _P_NOWAIT)
712 {
713 errno = EINVAL;
714 return -1;
715 }
716
717 /* Handle executable names without an executable suffix. */
718 program = make_string (cmdname, strlen (cmdname));
719 if (NILP (Ffile_executable_p (program)))
720 {
721 struct gcpro gcpro1;
722
723 full = Qnil;
724 GCPRO1 (program);
725 openp (Vexec_path, program, EXEC_SUFFIXES, &full, 1);
726 UNGCPRO;
727 if (NILP (full))
728 {
729 errno = EINVAL;
730 return -1;
731 }
732 program = full;
733 }
734
735 /* make sure argv[0] and cmdname are both in DOS format */
736 cmdname = XSTRING (program)->data;
737 unixtodos_filename (cmdname);
738 argv[0] = cmdname;
739
740 /* Determine whether program is a 16-bit DOS executable, or a w32
741 executable that is implicitly linked to the Cygnus dll (implying it
742 was compiled with the Cygnus GNU toolchain and hence relies on
743 cygwin.dll to parse the command line - we use this to decide how to
744 escape quote chars in command line args that must be quoted). */
745 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app);
746
747 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
748 application to start it by specifying the helper app as cmdname,
749 while leaving the real app name as argv[0]. */
750 if (is_dos_app)
751 {
752 cmdname = alloca (MAXPATHLEN);
753 if (egetenv ("CMDPROXY"))
754 strcpy (cmdname, egetenv ("CMDPROXY"));
755 else
756 {
757 strcpy (cmdname, XSTRING (Vinvocation_directory)->data);
758 strcat (cmdname, "cmdproxy.exe");
759 }
760 unixtodos_filename (cmdname);
761 }
762
763 /* we have to do some conjuring here to put argv and envp into the
764 form CreateProcess wants... argv needs to be a space separated/null
765 terminated list of parameters, and envp is a null
766 separated/double-null terminated list of parameters.
767
768 Additionally, zero-length args and args containing whitespace or
769 quote chars need to be wrapped in double quotes - for this to work,
770 embedded quotes need to be escaped as well. The aim is to ensure
771 the child process reconstructs the argv array we start with
772 exactly, so we treat quotes at the beginning and end of arguments
773 as embedded quotes.
774
775 The w32 GNU-based library from Cygnus doubles quotes to escape
776 them, while MSVC uses backslash for escaping. (Actually the MSVC
777 startup code does attempt to recognise doubled quotes and accept
778 them, but gets it wrong and ends up requiring three quotes to get a
779 single embedded quote!) So by default we decide whether to use
780 quote or backslash as the escape character based on whether the
781 binary is apparently a Cygnus compiled app.
782
783 Note that using backslash to escape embedded quotes requires
784 additional special handling if an embedded quote is already
785 preceeded by backslash, or if an arg requiring quoting ends with
786 backslash. In such cases, the run of escape characters needs to be
787 doubled. For consistency, we apply this special handling as long
788 as the escape character is not quote.
789
790 Since we have no idea how large argv and envp are likely to be we
791 figure out list lengths on the fly and allocate them. */
792
793 if (!NILP (Vw32_quote_process_args))
794 {
795 do_quoting = 1;
796 /* Override escape char by binding w32-quote-process-args to
797 desired character, or use t for auto-selection. */
798 if (INTEGERP (Vw32_quote_process_args))
799 escape_char = XINT (Vw32_quote_process_args);
800 else
801 escape_char = is_cygnus_app ? '"' : '\\';
802 }
803
804 /* do argv... */
805 arglen = 0;
806 targ = argv;
807 while (*targ)
808 {
809 char * p = *targ;
810 int need_quotes = 0;
811 int escape_char_run = 0;
812
813 if (*p == 0)
814 need_quotes = 1;
815 for ( ; *p; p++)
816 {
817 if (*p == '"')
818 {
819 /* allow for embedded quotes to be escaped */
820 arglen++;
821 need_quotes = 1;
822 /* handle the case where the embedded quote is already escaped */
823 if (escape_char_run > 0)
824 {
825 /* To preserve the arg exactly, we need to double the
826 preceding escape characters (plus adding one to
827 escape the quote character itself). */
828 arglen += escape_char_run;
829 }
830 }
831 else if (*p == ' ' || *p == '\t')
832 {
833 need_quotes = 1;
834 }
835
836 if (*p == escape_char && escape_char != '"')
837 escape_char_run++;
838 else
839 escape_char_run = 0;
840 }
841 if (need_quotes)
842 {
843 arglen += 2;
844 /* handle the case where the arg ends with an escape char - we
845 must not let the enclosing quote be escaped. */
846 if (escape_char_run > 0)
847 arglen += escape_char_run;
848 }
849 arglen += strlen (*targ++) + 1;
850 }
851 cmdline = alloca (arglen);
852 targ = argv;
853 parg = cmdline;
854 while (*targ)
855 {
856 char * p = *targ;
857 int need_quotes = 0;
858
859 if (*p == 0)
860 need_quotes = 1;
861
862 if (do_quoting)
863 {
864 for ( ; *p; p++)
865 if (*p == ' ' || *p == '\t' || *p == '"')
866 need_quotes = 1;
867 }
868 if (need_quotes)
869 {
870 int escape_char_run = 0;
871 char * first;
872 char * last;
873
874 p = *targ;
875 first = p;
876 last = p + strlen (p) - 1;
877 *parg++ = '"';
878 #if 0
879 /* This version does not escape quotes if they occur at the
880 beginning or end of the arg - this could lead to incorrect
881 behaviour when the arg itself represents a command line
882 containing quoted args. I believe this was originally done
883 as a hack to make some things work, before
884 `w32-quote-process-args' was added. */
885 while (*p)
886 {
887 if (*p == '"' && p > first && p < last)
888 *parg++ = escape_char; /* escape embedded quotes */
889 *parg++ = *p++;
890 }
891 #else
892 for ( ; *p; p++)
893 {
894 if (*p == '"')
895 {
896 /* double preceding escape chars if any */
897 while (escape_char_run > 0)
898 {
899 *parg++ = escape_char;
900 escape_char_run--;
901 }
902 /* escape all quote chars, even at beginning or end */
903 *parg++ = escape_char;
904 }
905 *parg++ = *p;
906
907 if (*p == escape_char && escape_char != '"')
908 escape_char_run++;
909 else
910 escape_char_run = 0;
911 }
912 /* double escape chars before enclosing quote */
913 while (escape_char_run > 0)
914 {
915 *parg++ = escape_char;
916 escape_char_run--;
917 }
918 #endif
919 *parg++ = '"';
920 }
921 else
922 {
923 strcpy (parg, *targ);
924 parg += strlen (*targ);
925 }
926 *parg++ = ' ';
927 targ++;
928 }
929 *--parg = '\0';
930
931 /* and envp... */
932 arglen = 1;
933 targ = envp;
934 numenv = 1; /* for end null */
935 while (*targ)
936 {
937 arglen += strlen (*targ++) + 1;
938 numenv++;
939 }
940 /* extra env vars... */
941 sprintf (ppid_env_var_buffer, "__PARENT_PROCESS_ID=%d",
942 GetCurrentProcessId ());
943 arglen += strlen (ppid_env_var_buffer) + 1;
944 numenv++;
945
946 /* merge env passed in and extra env into one, and sort it. */
947 targ = (char **) alloca (numenv * sizeof (char *));
948 merge_and_sort_env (envp, extra_env, targ);
949
950 /* concatenate env entries. */
951 env = alloca (arglen);
952 parg = env;
953 while (*targ)
954 {
955 strcpy (parg, *targ);
956 parg += strlen (*targ++);
957 *parg++ = '\0';
958 }
959 *parg++ = '\0';
960 *parg = '\0';
961
962 cp = new_child ();
963 if (cp == NULL)
964 {
965 errno = EAGAIN;
966 return -1;
967 }
968
969 /* Now create the process. */
970 if (!create_child (cmdname, cmdline, env, &pid, cp))
971 {
972 delete_child (cp);
973 errno = ENOEXEC;
974 return -1;
975 }
976
977 return pid;
978 }
979
980 /* Emulate the select call
981 Wait for available input on any of the given rfds, or timeout if
982 a timeout is given and no input is detected
983 wfds and efds are not supported and must be NULL.
984
985 For simplicity, we detect the death of child processes here and
986 synchronously call the SIGCHLD handler. Since it is possible for
987 children to be created without a corresponding pipe handle from which
988 to read output, we wait separately on the process handles as well as
989 the char_avail events for each process pipe. We only call
990 wait/reap_process when the process actually terminates. */
991
992 /* From ntterm.c */
993 extern HANDLE keyboard_handle;
994 /* From process.c */
995 extern int proc_buffered_char[];
996
997 int
998 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
999 EMACS_TIME *timeout)
1000 {
1001 SELECT_TYPE orfds;
1002 DWORD timeout_ms, start_time;
1003 int i, nh, nc, nr;
1004 DWORD active;
1005 child_process *cp, *cps[MAX_CHILDREN];
1006 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1007 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1008
1009 timeout_ms = timeout ? (timeout->tv_sec * 1000 + timeout->tv_usec / 1000) : INFINITE;
1010
1011 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1012 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1013 {
1014 Sleep (timeout_ms);
1015 return 0;
1016 }
1017
1018 /* Otherwise, we only handle rfds, so fail otherwise. */
1019 if (rfds == NULL || wfds != NULL || efds != NULL)
1020 {
1021 errno = EINVAL;
1022 return -1;
1023 }
1024
1025 orfds = *rfds;
1026 FD_ZERO (rfds);
1027 nr = 0;
1028
1029 /* Build a list of pipe handles to wait on. */
1030 nh = 0;
1031 for (i = 0; i < nfds; i++)
1032 if (FD_ISSET (i, &orfds))
1033 {
1034 if (i == 0)
1035 {
1036 if (keyboard_handle)
1037 {
1038 /* Handle stdin specially */
1039 wait_hnd[nh] = keyboard_handle;
1040 fdindex[nh] = i;
1041 nh++;
1042 }
1043
1044 /* Check for any emacs-generated input in the queue since
1045 it won't be detected in the wait */
1046 if (detect_input_pending ())
1047 {
1048 FD_SET (i, rfds);
1049 return 1;
1050 }
1051 }
1052 else
1053 {
1054 /* Child process and socket input */
1055 cp = fd_info[i].cp;
1056 if (cp)
1057 {
1058 int current_status = cp->status;
1059
1060 if (current_status == STATUS_READ_ACKNOWLEDGED)
1061 {
1062 /* Tell reader thread which file handle to use. */
1063 cp->fd = i;
1064 /* Wake up the reader thread for this process */
1065 cp->status = STATUS_READ_READY;
1066 if (!SetEvent (cp->char_consumed))
1067 DebPrint (("nt_select.SetEvent failed with "
1068 "%lu for fd %ld\n", GetLastError (), i));
1069 }
1070
1071 #ifdef CHECK_INTERLOCK
1072 /* slightly crude cross-checking of interlock between threads */
1073
1074 current_status = cp->status;
1075 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
1076 {
1077 /* char_avail has been signalled, so status (which may
1078 have changed) should indicate read has completed
1079 but has not been acknowledged. */
1080 current_status = cp->status;
1081 if (current_status != STATUS_READ_SUCCEEDED
1082 && current_status != STATUS_READ_FAILED)
1083 DebPrint (("char_avail set, but read not completed: status %d\n",
1084 current_status));
1085 }
1086 else
1087 {
1088 /* char_avail has not been signalled, so status should
1089 indicate that read is in progress; small possibility
1090 that read has completed but event wasn't yet signalled
1091 when we tested it (because a context switch occurred
1092 or if running on separate CPUs). */
1093 if (current_status != STATUS_READ_READY
1094 && current_status != STATUS_READ_IN_PROGRESS
1095 && current_status != STATUS_READ_SUCCEEDED
1096 && current_status != STATUS_READ_FAILED)
1097 DebPrint (("char_avail reset, but read status is bad: %d\n",
1098 current_status));
1099 }
1100 #endif
1101 wait_hnd[nh] = cp->char_avail;
1102 fdindex[nh] = i;
1103 if (!wait_hnd[nh]) abort ();
1104 nh++;
1105 #ifdef FULL_DEBUG
1106 DebPrint (("select waiting on child %d fd %d\n",
1107 cp-child_procs, i));
1108 #endif
1109 }
1110 else
1111 {
1112 /* Unable to find something to wait on for this fd, skip */
1113
1114 /* Note that this is not a fatal error, and can in fact
1115 happen in unusual circumstances. Specifically, if
1116 sys_spawnve fails, eg. because the program doesn't
1117 exist, and debug-on-error is t so Fsignal invokes a
1118 nested input loop, then the process output pipe is
1119 still included in input_wait_mask with no child_proc
1120 associated with it. (It is removed when the debugger
1121 exits the nested input loop and the error is thrown.) */
1122
1123 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
1124 }
1125 }
1126 }
1127
1128 count_children:
1129 /* Add handles of child processes. */
1130 nc = 0;
1131 for (cp = child_procs+(child_proc_count-1); cp >= child_procs; cp--)
1132 /* Some child_procs might be sockets; ignore them. Also some
1133 children may have died already, but we haven't finished reading
1134 the process output; ignore them too. */
1135 if (CHILD_ACTIVE (cp) && cp->procinfo.hProcess
1136 && (cp->fd < 0
1137 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
1138 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1139 )
1140 {
1141 wait_hnd[nh + nc] = cp->procinfo.hProcess;
1142 cps[nc] = cp;
1143 nc++;
1144 }
1145
1146 /* Nothing to look for, so we didn't find anything */
1147 if (nh + nc == 0)
1148 {
1149 if (timeout)
1150 Sleep (timeout_ms);
1151 return 0;
1152 }
1153
1154 /* Wait for input or child death to be signalled. */
1155 start_time = GetTickCount ();
1156 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
1157
1158 if (active == WAIT_FAILED)
1159 {
1160 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1161 nh + nc, timeout_ms, GetLastError ()));
1162 /* don't return EBADF - this causes wait_reading_process_input to
1163 abort; WAIT_FAILED is returned when single-stepping under
1164 Windows 95 after switching thread focus in debugger, and
1165 possibly at other times. */
1166 errno = EINTR;
1167 return -1;
1168 }
1169 else if (active == WAIT_TIMEOUT)
1170 {
1171 return 0;
1172 }
1173 else if (active >= WAIT_OBJECT_0
1174 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1175 {
1176 active -= WAIT_OBJECT_0;
1177 }
1178 else if (active >= WAIT_ABANDONED_0
1179 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1180 {
1181 active -= WAIT_ABANDONED_0;
1182 }
1183 else
1184 abort ();
1185
1186 /* Loop over all handles after active (now officially documented as
1187 being the first signalled handle in the array). We do this to
1188 ensure fairness, so that all channels with data available will be
1189 processed - otherwise higher numbered channels could be starved. */
1190 do
1191 {
1192 if (active >= nh)
1193 {
1194 cp = cps[active - nh];
1195
1196 /* We cannot always signal SIGCHLD immediately; if we have not
1197 finished reading the process output, we must delay sending
1198 SIGCHLD until we do. */
1199
1200 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
1201 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
1202 /* SIG_DFL for SIGCHLD is ignore */
1203 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
1204 sig_handlers[SIGCHLD] != SIG_IGN)
1205 {
1206 #ifdef FULL_DEBUG
1207 DebPrint (("select calling SIGCHLD handler for pid %d\n",
1208 cp->pid));
1209 #endif
1210 dead_child = cp;
1211 sig_handlers[SIGCHLD] (SIGCHLD);
1212 dead_child = NULL;
1213 }
1214 }
1215 else if (fdindex[active] == 0)
1216 {
1217 /* Keyboard input available */
1218 FD_SET (0, rfds);
1219 nr++;
1220 }
1221 else
1222 {
1223 /* must be a socket or pipe - read ahead should have
1224 completed, either succeeding or failing. */
1225 FD_SET (fdindex[active], rfds);
1226 nr++;
1227 }
1228
1229 /* Even though wait_reading_process_output only reads from at most
1230 one channel, we must process all channels here so that we reap
1231 all children that have died. */
1232 while (++active < nh + nc)
1233 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
1234 break;
1235 } while (active < nh + nc);
1236
1237 /* If no input has arrived and timeout hasn't expired, wait again. */
1238 if (nr == 0)
1239 {
1240 DWORD elapsed = GetTickCount () - start_time;
1241
1242 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
1243 {
1244 if (timeout_ms != INFINITE)
1245 timeout_ms -= elapsed;
1246 goto count_children;
1247 }
1248 }
1249
1250 return nr;
1251 }
1252
1253 /* Substitute for certain kill () operations */
1254
1255 static BOOL CALLBACK
1256 find_child_console (HWND hwnd, child_process * cp)
1257 {
1258 DWORD thread_id;
1259 DWORD process_id;
1260
1261 thread_id = GetWindowThreadProcessId (hwnd, &process_id);
1262 if (process_id == cp->procinfo.dwProcessId)
1263 {
1264 char window_class[32];
1265
1266 GetClassName (hwnd, window_class, sizeof (window_class));
1267 if (strcmp (window_class,
1268 (os_subtype == OS_WIN95)
1269 ? "tty"
1270 : "ConsoleWindowClass") == 0)
1271 {
1272 cp->hwnd = hwnd;
1273 return FALSE;
1274 }
1275 }
1276 /* keep looking */
1277 return TRUE;
1278 }
1279
1280 int
1281 sys_kill (int pid, int sig)
1282 {
1283 child_process *cp;
1284 HANDLE proc_hand;
1285 int need_to_free = 0;
1286 int rc = 0;
1287
1288 /* Only handle signals that will result in the process dying */
1289 if (sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
1290 {
1291 errno = EINVAL;
1292 return -1;
1293 }
1294
1295 cp = find_child_pid (pid);
1296 if (cp == NULL)
1297 {
1298 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
1299 if (proc_hand == NULL)
1300 {
1301 errno = EPERM;
1302 return -1;
1303 }
1304 need_to_free = 1;
1305 }
1306 else
1307 {
1308 proc_hand = cp->procinfo.hProcess;
1309 pid = cp->procinfo.dwProcessId;
1310
1311 /* Try to locate console window for process. */
1312 EnumWindows (find_child_console, (LPARAM) cp);
1313 }
1314
1315 if (sig == SIGINT)
1316 {
1317 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
1318 {
1319 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
1320 BYTE vk_break_code = VK_CANCEL;
1321 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
1322 HWND foreground_window;
1323
1324 if (break_scan_code == 0)
1325 {
1326 /* Fake Ctrl-C if we can't manage Ctrl-Break. */
1327 vk_break_code = 'C';
1328 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
1329 }
1330
1331 foreground_window = GetForegroundWindow ();
1332 if (foreground_window && SetForegroundWindow (cp->hwnd))
1333 {
1334 /* Generate keystrokes as if user had typed Ctrl-Break or Ctrl-C. */
1335 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
1336 keybd_event (vk_break_code, break_scan_code, 0, 0);
1337 keybd_event (vk_break_code, break_scan_code, KEYEVENTF_KEYUP, 0);
1338 keybd_event (VK_CONTROL, control_scan_code, KEYEVENTF_KEYUP, 0);
1339
1340 /* Sleep for a bit to give time for Emacs frame to respond
1341 to focus change events (if Emacs was active app). */
1342 Sleep (10);
1343
1344 SetForegroundWindow (foreground_window);
1345 }
1346 }
1347 /* Ctrl-Break is NT equivalent of SIGINT. */
1348 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
1349 {
1350 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
1351 "for pid %lu\n", GetLastError (), pid));
1352 errno = EINVAL;
1353 rc = -1;
1354 }
1355 }
1356 else
1357 {
1358 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
1359 {
1360 #if 1
1361 if (os_subtype == OS_WIN95)
1362 {
1363 /*
1364 Another possibility is to try terminating the VDM out-right by
1365 calling the Shell VxD (id 0x17) V86 interface, function #4
1366 "SHELL_Destroy_VM", ie.
1367
1368 mov edx,4
1369 mov ebx,vm_handle
1370 call shellapi
1371
1372 First need to determine the current VM handle, and then arrange for
1373 the shellapi call to be made from the system vm (by using
1374 Switch_VM_and_callback).
1375
1376 Could try to invoke DestroyVM through CallVxD.
1377
1378 */
1379 #if 0
1380 /* On Win95, posting WM_QUIT causes the 16-bit subsystem
1381 to hang when cmdproxy is used in conjunction with
1382 command.com for an interactive shell. Posting
1383 WM_CLOSE pops up a dialog that, when Yes is selected,
1384 does the same thing. TerminateProcess is also less
1385 than ideal in that subprocesses tend to stick around
1386 until the machine is shutdown, but at least it
1387 doesn't freeze the 16-bit subsystem. */
1388 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
1389 #endif
1390 if (!TerminateProcess (proc_hand, 0xff))
1391 {
1392 DebPrint (("sys_kill.TerminateProcess returned %d "
1393 "for pid %lu\n", GetLastError (), pid));
1394 errno = EINVAL;
1395 rc = -1;
1396 }
1397 }
1398 else
1399 #endif
1400 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
1401 }
1402 /* Kill the process. On W32 this doesn't kill child processes
1403 so it doesn't work very well for shells which is why it's not
1404 used in every case. */
1405 else if (!TerminateProcess (proc_hand, 0xff))
1406 {
1407 DebPrint (("sys_kill.TerminateProcess returned %d "
1408 "for pid %lu\n", GetLastError (), pid));
1409 errno = EINVAL;
1410 rc = -1;
1411 }
1412 }
1413
1414 if (need_to_free)
1415 CloseHandle (proc_hand);
1416
1417 return rc;
1418 }
1419
1420 /* extern int report_file_error (char *, Lisp_Object); */
1421
1422 /* The following two routines are used to manipulate stdin, stdout, and
1423 stderr of our child processes.
1424
1425 Assuming that in, out, and err are *not* inheritable, we make them
1426 stdin, stdout, and stderr of the child as follows:
1427
1428 - Save the parent's current standard handles.
1429 - Set the std handles to inheritable duplicates of the ones being passed in.
1430 (Note that _get_osfhandle() is an io.h procedure that retrieves the
1431 NT file handle for a crt file descriptor.)
1432 - Spawn the child, which inherits in, out, and err as stdin,
1433 stdout, and stderr. (see Spawnve)
1434 - Close the std handles passed to the child.
1435 - Reset the parent's standard handles to the saved handles.
1436 (see reset_standard_handles)
1437 We assume that the caller closes in, out, and err after calling us. */
1438
1439 void
1440 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
1441 {
1442 HANDLE parent;
1443 HANDLE newstdin, newstdout, newstderr;
1444
1445 parent = GetCurrentProcess ();
1446
1447 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
1448 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
1449 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
1450
1451 /* make inheritable copies of the new handles */
1452 if (!DuplicateHandle (parent,
1453 (HANDLE) _get_osfhandle (in),
1454 parent,
1455 &newstdin,
1456 0,
1457 TRUE,
1458 DUPLICATE_SAME_ACCESS))
1459 report_file_error ("Duplicating input handle for child", Qnil);
1460
1461 if (!DuplicateHandle (parent,
1462 (HANDLE) _get_osfhandle (out),
1463 parent,
1464 &newstdout,
1465 0,
1466 TRUE,
1467 DUPLICATE_SAME_ACCESS))
1468 report_file_error ("Duplicating output handle for child", Qnil);
1469
1470 if (!DuplicateHandle (parent,
1471 (HANDLE) _get_osfhandle (err),
1472 parent,
1473 &newstderr,
1474 0,
1475 TRUE,
1476 DUPLICATE_SAME_ACCESS))
1477 report_file_error ("Duplicating error handle for child", Qnil);
1478
1479 /* and store them as our std handles */
1480 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
1481 report_file_error ("Changing stdin handle", Qnil);
1482
1483 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
1484 report_file_error ("Changing stdout handle", Qnil);
1485
1486 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
1487 report_file_error ("Changing stderr handle", Qnil);
1488 }
1489
1490 void
1491 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
1492 {
1493 /* close the duplicated handles passed to the child */
1494 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
1495 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
1496 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
1497
1498 /* now restore parent's saved std handles */
1499 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
1500 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
1501 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
1502 }
1503
1504 void
1505 set_process_dir (char * dir)
1506 {
1507 process_dir = dir;
1508 }
1509
1510 #ifdef HAVE_SOCKETS
1511
1512 /* To avoid problems with winsock implementations that work over dial-up
1513 connections causing or requiring a connection to exist while Emacs is
1514 running, Emacs no longer automatically loads winsock on startup if it
1515 is present. Instead, it will be loaded when open-network-stream is
1516 first called.
1517
1518 To allow full control over when winsock is loaded, we provide these
1519 two functions to dynamically load and unload winsock. This allows
1520 dial-up users to only be connected when they actually need to use
1521 socket services. */
1522
1523 /* From nt.c */
1524 extern HANDLE winsock_lib;
1525 extern BOOL term_winsock (void);
1526 extern BOOL init_winsock (int load_now);
1527
1528 extern Lisp_Object Vsystem_name;
1529
1530 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
1531 "Test for presence of the Windows socket library `winsock'.\n\
1532 Returns non-nil if winsock support is present, nil otherwise.\n\
1533 \n\
1534 If the optional argument LOAD-NOW is non-nil, the winsock library is\n\
1535 also loaded immediately if not already loaded. If winsock is loaded,\n\
1536 the winsock local hostname is returned (since this may be different from\n\
1537 the value of `system-name' and should supplant it), otherwise t is\n\
1538 returned to indicate winsock support is present.")
1539 (load_now)
1540 Lisp_Object load_now;
1541 {
1542 int have_winsock;
1543
1544 have_winsock = init_winsock (!NILP (load_now));
1545 if (have_winsock)
1546 {
1547 if (winsock_lib != NULL)
1548 {
1549 /* Return new value for system-name. The best way to do this
1550 is to call init_system_name, saving and restoring the
1551 original value to avoid side-effects. */
1552 Lisp_Object orig_hostname = Vsystem_name;
1553 Lisp_Object hostname;
1554
1555 init_system_name ();
1556 hostname = Vsystem_name;
1557 Vsystem_name = orig_hostname;
1558 return hostname;
1559 }
1560 return Qt;
1561 }
1562 return Qnil;
1563 }
1564
1565 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
1566 0, 0, 0,
1567 "Unload the Windows socket library `winsock' if loaded.\n\
1568 This is provided to allow dial-up socket connections to be disconnected\n\
1569 when no longer needed. Returns nil without unloading winsock if any\n\
1570 socket connections still exist.")
1571 ()
1572 {
1573 return term_winsock () ? Qt : Qnil;
1574 }
1575
1576 #endif /* HAVE_SOCKETS */
1577
1578 \f
1579 /* Some miscellaneous functions that are Windows specific, but not GUI
1580 specific (ie. are applicable in terminal or batch mode as well). */
1581
1582 /* lifted from fileio.c */
1583 #define CORRECT_DIR_SEPS(s) \
1584 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
1585 else unixtodos_filename (s); \
1586 } while (0)
1587
1588 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
1589 "Return the short file name version (8.3) of the full path of FILENAME.\n\
1590 If FILENAME does not exist, return nil.\n\
1591 All path elements in FILENAME are converted to their short names.")
1592 (filename)
1593 Lisp_Object filename;
1594 {
1595 char shortname[MAX_PATH];
1596
1597 CHECK_STRING (filename, 0);
1598
1599 /* first expand it. */
1600 filename = Fexpand_file_name (filename, Qnil);
1601
1602 /* luckily, this returns the short version of each element in the path. */
1603 if (GetShortPathName (XSTRING (filename)->data, shortname, MAX_PATH) == 0)
1604 return Qnil;
1605
1606 CORRECT_DIR_SEPS (shortname);
1607
1608 return build_string (shortname);
1609 }
1610
1611
1612 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
1613 1, 1, 0,
1614 "Return the long file name version of the full path of FILENAME.\n\
1615 If FILENAME does not exist, return nil.\n\
1616 All path elements in FILENAME are converted to their long names.")
1617 (filename)
1618 Lisp_Object filename;
1619 {
1620 char longname[ MAX_PATH ];
1621
1622 CHECK_STRING (filename, 0);
1623
1624 /* first expand it. */
1625 filename = Fexpand_file_name (filename, Qnil);
1626
1627 if (!w32_get_long_filename (XSTRING (filename)->data, longname, MAX_PATH))
1628 return Qnil;
1629
1630 CORRECT_DIR_SEPS (longname);
1631
1632 return build_string (longname);
1633 }
1634
1635 DEFUN ("w32-set-process-priority", Fw32_set_process_priority, Sw32_set_process_priority,
1636 2, 2, 0,
1637 "Set the priority of PROCESS to PRIORITY.\n\
1638 If PROCESS is nil, the priority of Emacs is changed, otherwise the\n\
1639 priority of the process whose pid is PROCESS is changed.\n\
1640 PRIORITY should be one of the symbols high, normal, or low;\n\
1641 any other symbol will be interpreted as normal.\n\
1642 \n\
1643 If successful, the return value is t, otherwise nil.")
1644 (process, priority)
1645 Lisp_Object process, priority;
1646 {
1647 HANDLE proc_handle = GetCurrentProcess ();
1648 DWORD priority_class = NORMAL_PRIORITY_CLASS;
1649 Lisp_Object result = Qnil;
1650
1651 CHECK_SYMBOL (priority, 0);
1652
1653 if (!NILP (process))
1654 {
1655 DWORD pid;
1656 child_process *cp;
1657
1658 CHECK_NUMBER (process, 0);
1659
1660 /* Allow pid to be an internally generated one, or one obtained
1661 externally. This is necessary because real pids on Win95 are
1662 negative. */
1663
1664 pid = XINT (process);
1665 cp = find_child_pid (pid);
1666 if (cp != NULL)
1667 pid = cp->procinfo.dwProcessId;
1668
1669 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
1670 }
1671
1672 if (EQ (priority, Qhigh))
1673 priority_class = HIGH_PRIORITY_CLASS;
1674 else if (EQ (priority, Qlow))
1675 priority_class = IDLE_PRIORITY_CLASS;
1676
1677 if (proc_handle != NULL)
1678 {
1679 if (SetPriorityClass (proc_handle, priority_class))
1680 result = Qt;
1681 if (!NILP (process))
1682 CloseHandle (proc_handle);
1683 }
1684
1685 return result;
1686 }
1687
1688
1689 DEFUN ("w32-get-locale-info", Fw32_get_locale_info, Sw32_get_locale_info, 1, 2, 0,
1690 "Return information about the Windows locale LCID.\n\
1691 By default, return a three letter locale code which encodes the default\n\
1692 language as the first two characters, and the country or regionial variant\n\
1693 as the third letter. For example, ENU refers to `English (United States)',\n\
1694 while ENC means `English (Canadian)'.\n\
1695 \n\
1696 If the optional argument LONGFORM is non-nil, the long form of the locale\n\
1697 name is returned, e.g. `English (United States)' instead.\n\
1698 \n\
1699 If LCID (a 16-bit number) is not a valid locale, the result is nil.")
1700 (lcid, longform)
1701 Lisp_Object lcid, longform;
1702 {
1703 int got_abbrev;
1704 int got_full;
1705 char abbrev_name[32] = { 0 };
1706 char full_name[256] = { 0 };
1707
1708 CHECK_NUMBER (lcid, 0);
1709
1710 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
1711 return Qnil;
1712
1713 if (NILP (longform))
1714 {
1715 got_abbrev = GetLocaleInfo (XINT (lcid),
1716 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
1717 abbrev_name, sizeof (abbrev_name));
1718 if (got_abbrev)
1719 return build_string (abbrev_name);
1720 }
1721 else
1722 {
1723 got_full = GetLocaleInfo (XINT (lcid),
1724 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
1725 full_name, sizeof (full_name));
1726 if (got_full)
1727 return build_string (full_name);
1728 }
1729
1730 return Qnil;
1731 }
1732
1733
1734 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id, Sw32_get_current_locale_id, 0, 0, 0,
1735 "Return Windows locale id for current locale setting.\n\
1736 This is a numerical value; use `w32-get-locale-info' to convert to a\n\
1737 human-readable form.")
1738 ()
1739 {
1740 return make_number (GetThreadLocale ());
1741 }
1742
1743 DWORD int_from_hex (char * s)
1744 {
1745 DWORD val = 0;
1746 static char hex[] = "0123456789abcdefABCDEF";
1747 char * p;
1748
1749 while (*s && (p = strchr(hex, *s)) != NULL)
1750 {
1751 unsigned digit = p - hex;
1752 if (digit > 15)
1753 digit -= 6;
1754 val = val * 16 + digit;
1755 s++;
1756 }
1757 return val;
1758 }
1759
1760 /* We need to build a global list, since the EnumSystemLocale callback
1761 function isn't given a context pointer. */
1762 Lisp_Object Vw32_valid_locale_ids;
1763
1764 BOOL CALLBACK enum_locale_fn (LPTSTR localeNum)
1765 {
1766 DWORD id = int_from_hex (localeNum);
1767 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
1768 return TRUE;
1769 }
1770
1771 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids, Sw32_get_valid_locale_ids, 0, 0, 0,
1772 "Return list of all valid Windows locale ids.\n\
1773 Each id is a numerical value; use `w32-get-locale-info' to convert to a\n\
1774 human-readable form.")
1775 ()
1776 {
1777 Vw32_valid_locale_ids = Qnil;
1778
1779 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
1780
1781 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
1782 return Vw32_valid_locale_ids;
1783 }
1784
1785
1786 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
1787 "Return Windows locale id for default locale setting.\n\
1788 By default, the system default locale setting is returned; if the optional\n\
1789 parameter USERP is non-nil, the user default locale setting is returned.\n\
1790 This is a numerical value; use `w32-get-locale-info' to convert to a\n\
1791 human-readable form.")
1792 (userp)
1793 Lisp_Object userp;
1794 {
1795 if (NILP (userp))
1796 return make_number (GetSystemDefaultLCID ());
1797 return make_number (GetUserDefaultLCID ());
1798 }
1799
1800
1801 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
1802 "Make Windows locale LCID be the current locale setting for Emacs.\n\
1803 If successful, the new locale id is returned, otherwise nil.")
1804 (lcid)
1805 Lisp_Object lcid;
1806 {
1807 CHECK_NUMBER (lcid, 0);
1808
1809 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
1810 return Qnil;
1811
1812 if (!SetThreadLocale (XINT (lcid)))
1813 return Qnil;
1814
1815 /* Need to set input thread locale if present. */
1816 if (dwWindowsThreadId)
1817 /* Reply is not needed. */
1818 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
1819
1820 return make_number (GetThreadLocale ());
1821 }
1822
1823 \f
1824 syms_of_ntproc ()
1825 {
1826 Qhigh = intern ("high");
1827 Qlow = intern ("low");
1828
1829 #ifdef HAVE_SOCKETS
1830 defsubr (&Sw32_has_winsock);
1831 defsubr (&Sw32_unload_winsock);
1832 #endif
1833 defsubr (&Sw32_short_file_name);
1834 defsubr (&Sw32_long_file_name);
1835 defsubr (&Sw32_set_process_priority);
1836 defsubr (&Sw32_get_locale_info);
1837 defsubr (&Sw32_get_current_locale_id);
1838 defsubr (&Sw32_get_default_locale_id);
1839 defsubr (&Sw32_get_valid_locale_ids);
1840 defsubr (&Sw32_set_current_locale);
1841
1842 DEFVAR_LISP ("w32-quote-process-args", &Vw32_quote_process_args,
1843 "Non-nil enables quoting of process arguments to ensure correct parsing.\n\
1844 Because Windows does not directly pass argv arrays to child processes,\n\
1845 programs have to reconstruct the argv array by parsing the command\n\
1846 line string. For an argument to contain a space, it must be enclosed\n\
1847 in double quotes or it will be parsed as multiple arguments.\n\
1848 \n\
1849 If the value is a character, that character will be used to escape any\n\
1850 quote characters that appear, otherwise a suitable escape character\n\
1851 will be chosen based on the type of the program.");
1852 Vw32_quote_process_args = Qt;
1853
1854 DEFVAR_LISP ("w32-start-process-show-window",
1855 &Vw32_start_process_show_window,
1856 "When nil, processes started via start-process hide their windows.\n\
1857 When non-nil, they show their window in the method of their choice.");
1858 Vw32_start_process_show_window = Qnil;
1859
1860 DEFVAR_LISP ("w32-start-process-share-console",
1861 &Vw32_start_process_share_console,
1862 "When nil, processes started via start-process are given a new console.\n\
1863 When non-nil, they share the Emacs console; this has the limitation of\n\
1864 allowing only only DOS subprocess to run at a time (whether started directly\n\
1865 or indirectly by Emacs), and preventing Emacs from cleanly terminating the\n\
1866 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't\n\
1867 otherwise respond to interrupts from Emacs.");
1868 Vw32_start_process_share_console = Qnil;
1869
1870 DEFVAR_INT ("w32-pipe-read-delay", &Vw32_pipe_read_delay,
1871 "Forced delay before reading subprocess output.\n\
1872 This is done to improve the buffering of subprocess output, by\n\
1873 avoiding the inefficiency of frequently reading small amounts of data.\n\
1874 \n\
1875 If positive, the value is the number of milliseconds to sleep before\n\
1876 reading the subprocess output. If negative, the magnitude is the number\n\
1877 of time slices to wait (effectively boosting the priority of the child\n\
1878 process temporarily). A value of zero disables waiting entirely.");
1879 Vw32_pipe_read_delay = 50;
1880
1881 DEFVAR_LISP ("w32-downcase-file-names", &Vw32_downcase_file_names,
1882 "Non-nil means convert all-upper case file names to lower case.\n\
1883 This applies when performing completions and file name expansion.");
1884 Vw32_downcase_file_names = Qnil;
1885
1886 #if 0
1887 DEFVAR_LISP ("w32-generate-fake-inodes", &Vw32_generate_fake_inodes,
1888 "Non-nil means attempt to fake realistic inode values.\n\
1889 This works by hashing the truename of files, and should detect \n\
1890 aliasing between long and short (8.3 DOS) names, but can have\n\
1891 false positives because of hash collisions. Note that determing\n\
1892 the truename of a file can be slow.");
1893 Vw32_generate_fake_inodes = Qnil;
1894 #endif
1895
1896 DEFVAR_LISP ("w32-get-true-file-attributes", &Vw32_get_true_file_attributes,
1897 "Non-nil means determine accurate link count in file-attributes.\n\
1898 This option slows down file-attributes noticeably, so is disabled by\n\
1899 default. Note that it is only useful for files on NTFS volumes,\n\
1900 where hard links are supported.");
1901 Vw32_get_true_file_attributes = Qnil;
1902 }
1903 /* end of ntproc.c */