]> code.delx.au - gnu-emacs/blob - src/w32proc.c
Merge from emacs-24; up to 2012-11-30T04:44:52Z!cyd@gnu.org
[gnu-emacs] / src / w32proc.c
1 /* Process support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1992, 1995, 1999-2012 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 3 of the License, or
9 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
18
19 /*
20 Drew Bliss Oct 14, 1993
21 Adapted from alarm.c by Tim Fleehart
22 */
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <errno.h>
27 #include <ctype.h>
28 #include <io.h>
29 #include <fcntl.h>
30 #include <signal.h>
31 #include <sys/file.h>
32
33 /* must include CRT headers *before* config.h */
34 #include <config.h>
35
36 #undef signal
37 #undef wait
38 #undef spawnve
39 #undef select
40 #undef kill
41
42 #include <windows.h>
43 #ifdef __GNUC__
44 /* This definition is missing from mingw32 headers. */
45 extern BOOL WINAPI IsValidLocale (LCID, DWORD);
46 #endif
47
48 #ifdef HAVE_LANGINFO_CODESET
49 #include <nl_types.h>
50 #include <langinfo.h>
51 #endif
52
53 #include "lisp.h"
54 #include "w32.h"
55 #include "w32common.h"
56 #include "w32heap.h"
57 #include "systime.h"
58 #include "syswait.h"
59 #include "process.h"
60 #include "syssignal.h"
61 #include "w32term.h"
62 #include "dispextern.h" /* for xstrcasecmp */
63 #include "coding.h"
64
65 #define RVA_TO_PTR(var,section,filedata) \
66 ((void *)((section)->PointerToRawData \
67 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
68 + (filedata).file_base))
69
70 Lisp_Object Qhigh, Qlow;
71
72 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
73 static signal_handler sig_handlers[NSIG];
74
75 static sigset_t sig_mask;
76
77 static CRITICAL_SECTION crit_sig;
78
79 /* Improve on the CRT 'signal' implementation so that we could record
80 the SIGCHLD handler and fake interval timers. */
81 signal_handler
82 sys_signal (int sig, signal_handler handler)
83 {
84 signal_handler old;
85
86 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
87 below. SIGALRM and SIGPROF are used by setitimer. All the
88 others are the only ones supported by the MS runtime. */
89 if (!(sig == SIGCHLD || sig == SIGSEGV || sig == SIGILL
90 || sig == SIGFPE || sig == SIGABRT || sig == SIGTERM
91 || sig == SIGALRM || sig == SIGPROF))
92 {
93 errno = EINVAL;
94 return SIG_ERR;
95 }
96 old = sig_handlers[sig];
97 /* SIGABRT is treated specially because w32.c installs term_ntproc
98 as its handler, so we don't want to override that afterwards.
99 Aborting Emacs works specially anyway: either by calling
100 emacs_abort directly or through terminate_due_to_signal, which
101 calls emacs_abort through emacs_raise. */
102 if (!(sig == SIGABRT && old == term_ntproc))
103 {
104 sig_handlers[sig] = handler;
105 if (!(sig == SIGCHLD || sig == SIGALRM || sig == SIGPROF))
106 signal (sig, handler);
107 }
108 return old;
109 }
110
111 /* Emulate sigaction. */
112 int
113 sigaction (int sig, const struct sigaction *act, struct sigaction *oact)
114 {
115 signal_handler old = SIG_DFL;
116 int retval = 0;
117
118 if (act)
119 old = sys_signal (sig, act->sa_handler);
120 else if (oact)
121 old = sig_handlers[sig];
122
123 if (old == SIG_ERR)
124 {
125 errno = EINVAL;
126 retval = -1;
127 }
128 if (oact)
129 {
130 oact->sa_handler = old;
131 oact->sa_flags = 0;
132 oact->sa_mask = empty_mask;
133 }
134 return retval;
135 }
136
137 /* Emulate signal sets and blocking of signals used by timers. */
138
139 int
140 sigemptyset (sigset_t *set)
141 {
142 *set = 0;
143 return 0;
144 }
145
146 int
147 sigaddset (sigset_t *set, int signo)
148 {
149 if (!set)
150 {
151 errno = EINVAL;
152 return -1;
153 }
154 if (signo < 0 || signo >= NSIG)
155 {
156 errno = EINVAL;
157 return -1;
158 }
159
160 *set |= (1U << signo);
161
162 return 0;
163 }
164
165 int
166 sigfillset (sigset_t *set)
167 {
168 if (!set)
169 {
170 errno = EINVAL;
171 return -1;
172 }
173
174 *set = 0xFFFFFFFF;
175 return 0;
176 }
177
178 int
179 sigprocmask (int how, const sigset_t *set, sigset_t *oset)
180 {
181 if (!(how == SIG_BLOCK || how == SIG_UNBLOCK || how == SIG_SETMASK))
182 {
183 errno = EINVAL;
184 return -1;
185 }
186
187 if (oset)
188 *oset = sig_mask;
189
190 if (!set)
191 return 0;
192
193 switch (how)
194 {
195 case SIG_BLOCK:
196 sig_mask |= *set;
197 break;
198 case SIG_SETMASK:
199 sig_mask = *set;
200 break;
201 case SIG_UNBLOCK:
202 /* FIXME: Catch signals that are blocked and reissue them when
203 they are unblocked. Important for SIGALRM and SIGPROF only. */
204 sig_mask &= ~(*set);
205 break;
206 }
207
208 return 0;
209 }
210
211 int
212 pthread_sigmask (int how, const sigset_t *set, sigset_t *oset)
213 {
214 if (sigprocmask (how, set, oset) == -1)
215 return EINVAL;
216 return 0;
217 }
218
219 int
220 sigismember (const sigset_t *set, int signo)
221 {
222 if (signo < 0 || signo >= NSIG)
223 {
224 errno = EINVAL;
225 return -1;
226 }
227 if (signo > sizeof (*set) * BITS_PER_CHAR)
228 emacs_abort ();
229
230 return (*set & (1U << signo)) != 0;
231 }
232
233 pid_t
234 getpgrp (void)
235 {
236 return getpid ();
237 }
238
239 pid_t
240 tcgetpgrp (int fd)
241 {
242 return getpid ();
243 }
244
245 int
246 setpgid (pid_t pid, pid_t pgid)
247 {
248 return 0;
249 }
250
251 pid_t
252 setsid (void)
253 {
254 return getpid ();
255 }
256
257 /* Emulations of interval timers.
258
259 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
260
261 Implementation: a separate thread is started for each timer type,
262 the thread calls the appropriate signal handler when the timer
263 expires, after stopping the thread which installed the timer. */
264
265 struct itimer_data {
266 volatile ULONGLONG expire;
267 volatile ULONGLONG reload;
268 volatile int terminate;
269 int type;
270 HANDLE caller_thread;
271 HANDLE timer_thread;
272 };
273
274 static ULONGLONG ticks_now;
275 static struct itimer_data real_itimer, prof_itimer;
276 static ULONGLONG clocks_min;
277 /* If non-zero, itimers are disabled. Used during shutdown, when we
278 delete the critical sections used by the timer threads. */
279 static int disable_itimers;
280
281 static CRITICAL_SECTION crit_real, crit_prof;
282
283 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
284 typedef BOOL (WINAPI *GetThreadTimes_Proc) (
285 HANDLE hThread,
286 LPFILETIME lpCreationTime,
287 LPFILETIME lpExitTime,
288 LPFILETIME lpKernelTime,
289 LPFILETIME lpUserTime);
290
291 static GetThreadTimes_Proc s_pfn_Get_Thread_Times;
292
293 #define MAX_SINGLE_SLEEP 30
294 #define TIMER_TICKS_PER_SEC 1000
295
296 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
297 to a thread. If THREAD is NULL or an invalid handle, return the
298 current wall-clock time since January 1, 1601 (UTC). Otherwise,
299 return the sum of kernel and user times used by THREAD since it was
300 created, plus its creation time. */
301 static ULONGLONG
302 w32_get_timer_time (HANDLE thread)
303 {
304 ULONGLONG retval;
305 int use_system_time = 1;
306 /* The functions below return times in 100-ns units. */
307 const int tscale = 10 * TIMER_TICKS_PER_SEC;
308
309 if (thread && thread != INVALID_HANDLE_VALUE
310 && s_pfn_Get_Thread_Times != NULL)
311 {
312 FILETIME creation_ftime, exit_ftime, kernel_ftime, user_ftime;
313 ULARGE_INTEGER temp_creation, temp_kernel, temp_user;
314
315 if (s_pfn_Get_Thread_Times (thread, &creation_ftime, &exit_ftime,
316 &kernel_ftime, &user_ftime))
317 {
318 use_system_time = 0;
319 temp_creation.LowPart = creation_ftime.dwLowDateTime;
320 temp_creation.HighPart = creation_ftime.dwHighDateTime;
321 temp_kernel.LowPart = kernel_ftime.dwLowDateTime;
322 temp_kernel.HighPart = kernel_ftime.dwHighDateTime;
323 temp_user.LowPart = user_ftime.dwLowDateTime;
324 temp_user.HighPart = user_ftime.dwHighDateTime;
325 retval =
326 temp_creation.QuadPart / tscale + temp_kernel.QuadPart / tscale
327 + temp_user.QuadPart / tscale;
328 }
329 else
330 DebPrint (("GetThreadTimes failed with error code %lu\n",
331 GetLastError ()));
332 }
333
334 if (use_system_time)
335 {
336 FILETIME current_ftime;
337 ULARGE_INTEGER temp;
338
339 GetSystemTimeAsFileTime (&current_ftime);
340
341 temp.LowPart = current_ftime.dwLowDateTime;
342 temp.HighPart = current_ftime.dwHighDateTime;
343
344 retval = temp.QuadPart / tscale;
345 }
346
347 return retval;
348 }
349
350 /* Thread function for a timer thread. */
351 static DWORD WINAPI
352 timer_loop (LPVOID arg)
353 {
354 struct itimer_data *itimer = (struct itimer_data *)arg;
355 int which = itimer->type;
356 int sig = (which == ITIMER_REAL) ? SIGALRM : SIGPROF;
357 CRITICAL_SECTION *crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
358 const DWORD max_sleep = MAX_SINGLE_SLEEP * 1000 / TIMER_TICKS_PER_SEC;
359 HANDLE hth = (which == ITIMER_REAL) ? NULL : itimer->caller_thread;
360
361 while (1)
362 {
363 DWORD sleep_time;
364 signal_handler handler;
365 ULONGLONG now, expire, reload;
366
367 /* Load new values if requested by setitimer. */
368 EnterCriticalSection (crit);
369 expire = itimer->expire;
370 reload = itimer->reload;
371 LeaveCriticalSection (crit);
372 if (itimer->terminate)
373 return 0;
374
375 if (expire == 0)
376 {
377 /* We are idle. */
378 Sleep (max_sleep);
379 continue;
380 }
381
382 if (expire > (now = w32_get_timer_time (hth)))
383 sleep_time = expire - now;
384 else
385 sleep_time = 0;
386 /* Don't sleep too long at a time, to be able to see the
387 termination flag without too long a delay. */
388 while (sleep_time > max_sleep)
389 {
390 if (itimer->terminate)
391 return 0;
392 Sleep (max_sleep);
393 EnterCriticalSection (crit);
394 expire = itimer->expire;
395 LeaveCriticalSection (crit);
396 sleep_time =
397 (expire > (now = w32_get_timer_time (hth))) ? expire - now : 0;
398 }
399 if (itimer->terminate)
400 return 0;
401 if (sleep_time > 0)
402 {
403 Sleep (sleep_time * 1000 / TIMER_TICKS_PER_SEC);
404 /* Always sleep past the expiration time, to make sure we
405 never call the handler _before_ the expiration time,
406 always slightly after it. Sleep(5) makes sure we don't
407 hog the CPU by calling 'w32_get_timer_time' with high
408 frequency, and also let other threads work. */
409 while (w32_get_timer_time (hth) < expire)
410 Sleep (5);
411 }
412
413 EnterCriticalSection (crit);
414 expire = itimer->expire;
415 LeaveCriticalSection (crit);
416 if (expire == 0)
417 continue;
418
419 /* Time's up. */
420 handler = sig_handlers[sig];
421 if (!(handler == SIG_DFL || handler == SIG_IGN || handler == SIG_ERR)
422 /* FIXME: Don't ignore masked signals. Instead, record that
423 they happened and reissue them when the signal is
424 unblocked. */
425 && !sigismember (&sig_mask, sig)
426 /* Simulate masking of SIGALRM and SIGPROF when processing
427 fatal signals. */
428 && !fatal_error_in_progress
429 && itimer->caller_thread)
430 {
431 /* Simulate a signal delivered to the thread which installed
432 the timer, by suspending that thread while the handler
433 runs. */
434 HANDLE th = itimer->caller_thread;
435 DWORD result = SuspendThread (th);
436
437 if (result == (DWORD)-1)
438 return 2;
439
440 handler (sig);
441 ResumeThread (th);
442 }
443
444 /* Update expiration time and loop. */
445 EnterCriticalSection (crit);
446 expire = itimer->expire;
447 if (expire == 0)
448 {
449 LeaveCriticalSection (crit);
450 continue;
451 }
452 reload = itimer->reload;
453 if (reload > 0)
454 {
455 now = w32_get_timer_time (hth);
456 if (expire <= now)
457 {
458 ULONGLONG lag = now - expire;
459
460 /* If we missed some opportunities (presumably while
461 sleeping or while the signal handler ran), skip
462 them. */
463 if (lag > reload)
464 expire = now - (lag % reload);
465
466 expire += reload;
467 }
468 }
469 else
470 expire = 0; /* become idle */
471 itimer->expire = expire;
472 LeaveCriticalSection (crit);
473 }
474 return 0;
475 }
476
477 static void
478 stop_timer_thread (int which)
479 {
480 struct itimer_data *itimer =
481 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
482 int i;
483 DWORD err, exit_code = 255;
484 BOOL status;
485
486 /* Signal the thread that it should terminate. */
487 itimer->terminate = 1;
488
489 if (itimer->timer_thread == NULL)
490 return;
491
492 /* Wait for the timer thread to terminate voluntarily, then kill it
493 if it doesn't. This loop waits twice more than the maximum
494 amount of time a timer thread sleeps, see above. */
495 for (i = 0; i < MAX_SINGLE_SLEEP / 5; i++)
496 {
497 if (!((status = GetExitCodeThread (itimer->timer_thread, &exit_code))
498 && exit_code == STILL_ACTIVE))
499 break;
500 Sleep (10);
501 }
502 if ((status == FALSE && (err = GetLastError ()) == ERROR_INVALID_HANDLE)
503 || exit_code == STILL_ACTIVE)
504 {
505 if (!(status == FALSE && err == ERROR_INVALID_HANDLE))
506 TerminateThread (itimer->timer_thread, 0);
507 }
508
509 /* Clean up. */
510 CloseHandle (itimer->timer_thread);
511 itimer->timer_thread = NULL;
512 if (itimer->caller_thread)
513 {
514 CloseHandle (itimer->caller_thread);
515 itimer->caller_thread = NULL;
516 }
517 }
518
519 /* This is called at shutdown time from term_ntproc. */
520 void
521 term_timers (void)
522 {
523 if (real_itimer.timer_thread)
524 stop_timer_thread (ITIMER_REAL);
525 if (prof_itimer.timer_thread)
526 stop_timer_thread (ITIMER_PROF);
527
528 /* We are going to delete the critical sections, so timers cannot
529 work after this. */
530 disable_itimers = 1;
531
532 DeleteCriticalSection (&crit_real);
533 DeleteCriticalSection (&crit_prof);
534 DeleteCriticalSection (&crit_sig);
535 }
536
537 /* This is called at initialization time from init_ntproc. */
538 void
539 init_timers (void)
540 {
541 /* GetThreadTimes is not available on all versions of Windows, so
542 need to probe for its availability dynamically, and call it
543 through a pointer. */
544 s_pfn_Get_Thread_Times = NULL; /* in case dumped Emacs comes with a value */
545 if (os_subtype != OS_9X)
546 s_pfn_Get_Thread_Times =
547 (GetThreadTimes_Proc)GetProcAddress (GetModuleHandle ("kernel32.dll"),
548 "GetThreadTimes");
549
550 /* Make sure we start with zeroed out itimer structures, since
551 dumping may have left there traces of threads long dead. */
552 memset (&real_itimer, 0, sizeof real_itimer);
553 memset (&prof_itimer, 0, sizeof prof_itimer);
554
555 InitializeCriticalSection (&crit_real);
556 InitializeCriticalSection (&crit_prof);
557 InitializeCriticalSection (&crit_sig);
558
559 disable_itimers = 0;
560 }
561
562 static int
563 start_timer_thread (int which)
564 {
565 DWORD exit_code;
566 HANDLE th;
567 struct itimer_data *itimer =
568 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
569
570 if (itimer->timer_thread
571 && GetExitCodeThread (itimer->timer_thread, &exit_code)
572 && exit_code == STILL_ACTIVE)
573 return 0;
574
575 /* Clean up after possibly exited thread. */
576 if (itimer->timer_thread)
577 {
578 CloseHandle (itimer->timer_thread);
579 itimer->timer_thread = NULL;
580 }
581 if (itimer->caller_thread)
582 {
583 CloseHandle (itimer->caller_thread);
584 itimer->caller_thread = NULL;
585 }
586
587 /* Start a new thread. */
588 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
589 GetCurrentProcess (), &th, 0, FALSE,
590 DUPLICATE_SAME_ACCESS))
591 {
592 errno = ESRCH;
593 return -1;
594 }
595 itimer->terminate = 0;
596 itimer->type = which;
597 itimer->caller_thread = th;
598 /* Request that no more than 64KB of stack be reserved for this
599 thread, to avoid reserving too much memory, which would get in
600 the way of threads we start to wait for subprocesses. See also
601 new_child below. */
602 itimer->timer_thread = CreateThread (NULL, 64 * 1024, timer_loop,
603 (void *)itimer, 0x00010000, NULL);
604
605 if (!itimer->timer_thread)
606 {
607 CloseHandle (itimer->caller_thread);
608 itimer->caller_thread = NULL;
609 errno = EAGAIN;
610 return -1;
611 }
612
613 /* This is needed to make sure that the timer thread running for
614 profiling gets CPU as soon as the Sleep call terminates. */
615 if (which == ITIMER_PROF)
616 SetThreadPriority (itimer->timer_thread, THREAD_PRIORITY_TIME_CRITICAL);
617
618 return 0;
619 }
620
621 /* Most of the code of getitimer and setitimer (but not of their
622 subroutines) was shamelessly stolen from itimer.c in the DJGPP
623 library, see www.delorie.com/djgpp. */
624 int
625 getitimer (int which, struct itimerval *value)
626 {
627 volatile ULONGLONG *t_expire;
628 volatile ULONGLONG *t_reload;
629 ULONGLONG expire, reload;
630 __int64 usecs;
631 CRITICAL_SECTION *crit;
632 struct itimer_data *itimer;
633
634 if (disable_itimers)
635 return -1;
636
637 if (!value)
638 {
639 errno = EFAULT;
640 return -1;
641 }
642
643 if (which != ITIMER_REAL && which != ITIMER_PROF)
644 {
645 errno = EINVAL;
646 return -1;
647 }
648
649 itimer = (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
650
651 ticks_now = w32_get_timer_time ((which == ITIMER_REAL)
652 ? NULL
653 : GetCurrentThread ());
654
655 t_expire = &itimer->expire;
656 t_reload = &itimer->reload;
657 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
658
659 EnterCriticalSection (crit);
660 reload = *t_reload;
661 expire = *t_expire;
662 LeaveCriticalSection (crit);
663
664 if (expire)
665 expire -= ticks_now;
666
667 value->it_value.tv_sec = expire / TIMER_TICKS_PER_SEC;
668 usecs =
669 (expire % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
670 value->it_value.tv_usec = usecs;
671 value->it_interval.tv_sec = reload / TIMER_TICKS_PER_SEC;
672 usecs =
673 (reload % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
674 value->it_interval.tv_usec= usecs;
675
676 return 0;
677 }
678
679 int
680 setitimer(int which, struct itimerval *value, struct itimerval *ovalue)
681 {
682 volatile ULONGLONG *t_expire, *t_reload;
683 ULONGLONG expire, reload, expire_old, reload_old;
684 __int64 usecs;
685 CRITICAL_SECTION *crit;
686 struct itimerval tem, *ptem;
687
688 if (disable_itimers)
689 return -1;
690
691 /* Posix systems expect timer values smaller than the resolution of
692 the system clock be rounded up to the clock resolution. First
693 time we are called, measure the clock tick resolution. */
694 if (!clocks_min)
695 {
696 ULONGLONG t1, t2;
697
698 for (t1 = w32_get_timer_time (NULL);
699 (t2 = w32_get_timer_time (NULL)) == t1; )
700 ;
701 clocks_min = t2 - t1;
702 }
703
704 if (ovalue)
705 ptem = ovalue;
706 else
707 ptem = &tem;
708
709 if (getitimer (which, ptem)) /* also sets ticks_now */
710 return -1; /* errno already set */
711
712 t_expire =
713 (which == ITIMER_REAL) ? &real_itimer.expire : &prof_itimer.expire;
714 t_reload =
715 (which == ITIMER_REAL) ? &real_itimer.reload : &prof_itimer.reload;
716
717 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
718
719 if (!value
720 || (value->it_value.tv_sec == 0 && value->it_value.tv_usec == 0))
721 {
722 EnterCriticalSection (crit);
723 /* Disable the timer. */
724 *t_expire = 0;
725 *t_reload = 0;
726 LeaveCriticalSection (crit);
727 return 0;
728 }
729
730 reload = value->it_interval.tv_sec * TIMER_TICKS_PER_SEC;
731
732 usecs = value->it_interval.tv_usec;
733 if (value->it_interval.tv_sec == 0
734 && usecs && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
735 reload = clocks_min;
736 else
737 {
738 usecs *= TIMER_TICKS_PER_SEC;
739 reload += usecs / 1000000;
740 }
741
742 expire = value->it_value.tv_sec * TIMER_TICKS_PER_SEC;
743 usecs = value->it_value.tv_usec;
744 if (value->it_value.tv_sec == 0
745 && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
746 expire = clocks_min;
747 else
748 {
749 usecs *= TIMER_TICKS_PER_SEC;
750 expire += usecs / 1000000;
751 }
752
753 expire += ticks_now;
754
755 EnterCriticalSection (crit);
756 expire_old = *t_expire;
757 reload_old = *t_reload;
758 if (!(expire == expire_old && reload == reload_old))
759 {
760 *t_reload = reload;
761 *t_expire = expire;
762 }
763 LeaveCriticalSection (crit);
764
765 return start_timer_thread (which);
766 }
767
768 int
769 alarm (int seconds)
770 {
771 #ifdef HAVE_SETITIMER
772 struct itimerval new_values, old_values;
773
774 new_values.it_value.tv_sec = seconds;
775 new_values.it_value.tv_usec = 0;
776 new_values.it_interval.tv_sec = new_values.it_interval.tv_usec = 0;
777
778 if (setitimer (ITIMER_REAL, &new_values, &old_values) < 0)
779 return 0;
780 return old_values.it_value.tv_sec;
781 #else
782 return seconds;
783 #endif
784 }
785
786 /* Defined in <process.h> which conflicts with the local copy */
787 #define _P_NOWAIT 1
788
789 /* Child process management list. */
790 int child_proc_count = 0;
791 child_process child_procs[ MAX_CHILDREN ];
792
793 static DWORD WINAPI reader_thread (void *arg);
794
795 /* Find an unused process slot. */
796 child_process *
797 new_child (void)
798 {
799 child_process *cp;
800 DWORD id;
801
802 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
803 if (!CHILD_ACTIVE (cp))
804 goto Initialize;
805 if (child_proc_count == MAX_CHILDREN)
806 return NULL;
807 cp = &child_procs[child_proc_count++];
808
809 Initialize:
810 memset (cp, 0, sizeof (*cp));
811 cp->fd = -1;
812 cp->pid = -1;
813 cp->procinfo.hProcess = NULL;
814 cp->status = STATUS_READ_ERROR;
815
816 /* use manual reset event so that select() will function properly */
817 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
818 if (cp->char_avail)
819 {
820 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
821 if (cp->char_consumed)
822 {
823 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
824 It means that the 64K stack we are requesting in the 2nd
825 argument is how much memory should be reserved for the
826 stack. If we don't use this flag, the memory requested
827 by the 2nd argument is the amount actually _committed_,
828 but Windows reserves 8MB of memory for each thread's
829 stack. (The 8MB figure comes from the -stack
830 command-line argument we pass to the linker when building
831 Emacs, but that's because we need a large stack for
832 Emacs's main thread.) Since we request 2GB of reserved
833 memory at startup (see w32heap.c), which is close to the
834 maximum memory available for a 32-bit process on Windows,
835 the 8MB reservation for each thread causes failures in
836 starting subprocesses, because we create a thread running
837 reader_thread for each subprocess. As 8MB of stack is
838 way too much for reader_thread, forcing Windows to
839 reserve less wins the day. */
840 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
841 0x00010000, &id);
842 if (cp->thrd)
843 return cp;
844 }
845 }
846 delete_child (cp);
847 return NULL;
848 }
849
850 void
851 delete_child (child_process *cp)
852 {
853 int i;
854
855 /* Should not be deleting a child that is still needed. */
856 for (i = 0; i < MAXDESC; i++)
857 if (fd_info[i].cp == cp)
858 emacs_abort ();
859
860 if (!CHILD_ACTIVE (cp))
861 return;
862
863 /* reap thread if necessary */
864 if (cp->thrd)
865 {
866 DWORD rc;
867
868 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
869 {
870 /* let the thread exit cleanly if possible */
871 cp->status = STATUS_READ_ERROR;
872 SetEvent (cp->char_consumed);
873 #if 0
874 /* We used to forcibly terminate the thread here, but it
875 is normally unnecessary, and in abnormal cases, the worst that
876 will happen is we have an extra idle thread hanging around
877 waiting for the zombie process. */
878 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
879 {
880 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
881 "with %lu for fd %ld\n", GetLastError (), cp->fd));
882 TerminateThread (cp->thrd, 0);
883 }
884 #endif
885 }
886 CloseHandle (cp->thrd);
887 cp->thrd = NULL;
888 }
889 if (cp->char_avail)
890 {
891 CloseHandle (cp->char_avail);
892 cp->char_avail = NULL;
893 }
894 if (cp->char_consumed)
895 {
896 CloseHandle (cp->char_consumed);
897 cp->char_consumed = NULL;
898 }
899
900 /* update child_proc_count (highest numbered slot in use plus one) */
901 if (cp == child_procs + child_proc_count - 1)
902 {
903 for (i = child_proc_count-1; i >= 0; i--)
904 if (CHILD_ACTIVE (&child_procs[i]))
905 {
906 child_proc_count = i + 1;
907 break;
908 }
909 }
910 if (i < 0)
911 child_proc_count = 0;
912 }
913
914 /* Find a child by pid. */
915 static child_process *
916 find_child_pid (DWORD pid)
917 {
918 child_process *cp;
919
920 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
921 if (CHILD_ACTIVE (cp) && pid == cp->pid)
922 return cp;
923 return NULL;
924 }
925
926
927 /* Thread proc for child process and socket reader threads. Each thread
928 is normally blocked until woken by select() to check for input by
929 reading one char. When the read completes, char_avail is signaled
930 to wake up the select emulator and the thread blocks itself again. */
931 static DWORD WINAPI
932 reader_thread (void *arg)
933 {
934 child_process *cp;
935
936 /* Our identity */
937 cp = (child_process *)arg;
938
939 /* We have to wait for the go-ahead before we can start */
940 if (cp == NULL
941 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
942 || cp->fd < 0)
943 return 1;
944
945 for (;;)
946 {
947 int rc;
948
949 if (fd_info[cp->fd].flags & FILE_LISTEN)
950 rc = _sys_wait_accept (cp->fd);
951 else
952 rc = _sys_read_ahead (cp->fd);
953
954 /* The name char_avail is a misnomer - it really just means the
955 read-ahead has completed, whether successfully or not. */
956 if (!SetEvent (cp->char_avail))
957 {
958 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
959 GetLastError (), cp->fd));
960 return 1;
961 }
962
963 if (rc == STATUS_READ_ERROR)
964 return 1;
965
966 /* If the read died, the child has died so let the thread die */
967 if (rc == STATUS_READ_FAILED)
968 break;
969
970 /* Wait until our input is acknowledged before reading again */
971 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
972 {
973 DebPrint (("reader_thread.WaitForSingleObject failed with "
974 "%lu for fd %ld\n", GetLastError (), cp->fd));
975 break;
976 }
977 }
978 return 0;
979 }
980
981 /* To avoid Emacs changing directory, we just record here the directory
982 the new process should start in. This is set just before calling
983 sys_spawnve, and is not generally valid at any other time. */
984 static char * process_dir;
985
986 static BOOL
987 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
988 int * pPid, child_process *cp)
989 {
990 STARTUPINFO start;
991 SECURITY_ATTRIBUTES sec_attrs;
992 #if 0
993 SECURITY_DESCRIPTOR sec_desc;
994 #endif
995 DWORD flags;
996 char dir[ MAXPATHLEN ];
997
998 if (cp == NULL) emacs_abort ();
999
1000 memset (&start, 0, sizeof (start));
1001 start.cb = sizeof (start);
1002
1003 #ifdef HAVE_NTGUI
1004 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1005 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1006 else
1007 start.dwFlags = STARTF_USESTDHANDLES;
1008 start.wShowWindow = SW_HIDE;
1009
1010 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1011 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1012 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1013 #endif /* HAVE_NTGUI */
1014
1015 #if 0
1016 /* Explicitly specify no security */
1017 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1018 goto EH_Fail;
1019 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1020 goto EH_Fail;
1021 #endif
1022 sec_attrs.nLength = sizeof (sec_attrs);
1023 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1024 sec_attrs.bInheritHandle = FALSE;
1025
1026 strcpy (dir, process_dir);
1027 unixtodos_filename (dir);
1028
1029 flags = (!NILP (Vw32_start_process_share_console)
1030 ? CREATE_NEW_PROCESS_GROUP
1031 : CREATE_NEW_CONSOLE);
1032 if (NILP (Vw32_start_process_inherit_error_mode))
1033 flags |= CREATE_DEFAULT_ERROR_MODE;
1034 if (!CreateProcess (exe, cmdline, &sec_attrs, NULL, TRUE,
1035 flags, env, dir, &start, &cp->procinfo))
1036 goto EH_Fail;
1037
1038 cp->pid = (int) cp->procinfo.dwProcessId;
1039
1040 /* Hack for Windows 95, which assigns large (ie negative) pids */
1041 if (cp->pid < 0)
1042 cp->pid = -cp->pid;
1043
1044 *pPid = cp->pid;
1045
1046 return TRUE;
1047
1048 EH_Fail:
1049 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1050 return FALSE;
1051 }
1052
1053 /* create_child doesn't know what emacs' file handle will be for waiting
1054 on output from the child, so we need to make this additional call
1055 to register the handle with the process
1056 This way the select emulator knows how to match file handles with
1057 entries in child_procs. */
1058 void
1059 register_child (int pid, int fd)
1060 {
1061 child_process *cp;
1062
1063 cp = find_child_pid (pid);
1064 if (cp == NULL)
1065 {
1066 DebPrint (("register_child unable to find pid %lu\n", pid));
1067 return;
1068 }
1069
1070 #ifdef FULL_DEBUG
1071 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1072 #endif
1073
1074 cp->fd = fd;
1075
1076 /* thread is initially blocked until select is called; set status so
1077 that select will release thread */
1078 cp->status = STATUS_READ_ACKNOWLEDGED;
1079
1080 /* attach child_process to fd_info */
1081 if (fd_info[fd].cp != NULL)
1082 {
1083 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1084 emacs_abort ();
1085 }
1086
1087 fd_info[fd].cp = cp;
1088 }
1089
1090 /* When a process dies its pipe will break so the reader thread will
1091 signal failure to the select emulator.
1092 The select emulator then calls this routine to clean up.
1093 Since the thread signaled failure we can assume it is exiting. */
1094 static void
1095 reap_subprocess (child_process *cp)
1096 {
1097 if (cp->procinfo.hProcess)
1098 {
1099 /* Reap the process */
1100 #ifdef FULL_DEBUG
1101 /* Process should have already died before we are called. */
1102 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1103 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp->fd));
1104 #endif
1105 CloseHandle (cp->procinfo.hProcess);
1106 cp->procinfo.hProcess = NULL;
1107 CloseHandle (cp->procinfo.hThread);
1108 cp->procinfo.hThread = NULL;
1109 }
1110
1111 /* For asynchronous children, the child_proc resources will be freed
1112 when the last pipe read descriptor is closed; for synchronous
1113 children, we must explicitly free the resources now because
1114 register_child has not been called. */
1115 if (cp->fd == -1)
1116 delete_child (cp);
1117 }
1118
1119 /* Wait for a child process specified by PID, or for any of our
1120 existing child processes (if PID is nonpositive) to die. When it
1121 does, close its handle. Return the pid of the process that died
1122 and fill in STATUS if non-NULL. */
1123
1124 pid_t
1125 waitpid (pid_t pid, int *status, int options)
1126 {
1127 DWORD active, retval;
1128 int nh;
1129 child_process *cp, *cps[MAX_CHILDREN];
1130 HANDLE wait_hnd[MAX_CHILDREN];
1131 DWORD timeout_ms;
1132 int dont_wait = (options & WNOHANG) != 0;
1133
1134 nh = 0;
1135 /* According to Posix:
1136
1137 PID = -1 means status is requested for any child process.
1138
1139 PID > 0 means status is requested for a single child process
1140 whose pid is PID.
1141
1142 PID = 0 means status is requested for any child process whose
1143 process group ID is equal to that of the calling process. But
1144 since Windows has only a limited support for process groups (only
1145 for console processes and only for the purposes of passing
1146 Ctrl-BREAK signal to them), and since we have no documented way
1147 of determining whether a given process belongs to our group, we
1148 treat 0 as -1.
1149
1150 PID < -1 means status is requested for any child process whose
1151 process group ID is equal to the absolute value of PID. Again,
1152 since we don't support process groups, we treat that as -1. */
1153 if (pid > 0)
1154 {
1155 int our_child = 0;
1156
1157 /* We are requested to wait for a specific child. */
1158 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1159 {
1160 /* Some child_procs might be sockets; ignore them. Also
1161 ignore subprocesses whose output is not yet completely
1162 read. */
1163 if (CHILD_ACTIVE (cp)
1164 && cp->procinfo.hProcess
1165 && cp->pid == pid)
1166 {
1167 our_child = 1;
1168 break;
1169 }
1170 }
1171 if (our_child)
1172 {
1173 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1174 {
1175 wait_hnd[nh] = cp->procinfo.hProcess;
1176 cps[nh] = cp;
1177 nh++;
1178 }
1179 else if (dont_wait)
1180 {
1181 /* PID specifies our subprocess, but its status is not
1182 yet available. */
1183 return 0;
1184 }
1185 }
1186 if (nh == 0)
1187 {
1188 /* No such child process, or nothing to wait for, so fail. */
1189 errno = ECHILD;
1190 return -1;
1191 }
1192 }
1193 else
1194 {
1195 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1196 {
1197 if (CHILD_ACTIVE (cp)
1198 && cp->procinfo.hProcess
1199 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1200 {
1201 wait_hnd[nh] = cp->procinfo.hProcess;
1202 cps[nh] = cp;
1203 nh++;
1204 }
1205 }
1206 if (nh == 0)
1207 {
1208 /* Nothing to wait on, so fail. */
1209 errno = ECHILD;
1210 return -1;
1211 }
1212 }
1213
1214 if (dont_wait)
1215 timeout_ms = 0;
1216 else
1217 timeout_ms = 1000; /* check for quit about once a second. */
1218
1219 do
1220 {
1221 QUIT;
1222 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1223 } while (active == WAIT_TIMEOUT && !dont_wait);
1224
1225 if (active == WAIT_FAILED)
1226 {
1227 errno = EBADF;
1228 return -1;
1229 }
1230 else if (active == WAIT_TIMEOUT && dont_wait)
1231 {
1232 /* PID specifies our subprocess, but it didn't exit yet, so its
1233 status is not yet available. */
1234 #ifdef FULL_DEBUG
1235 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1236 #endif
1237 return 0;
1238 }
1239 else if (active >= WAIT_OBJECT_0
1240 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1241 {
1242 active -= WAIT_OBJECT_0;
1243 }
1244 else if (active >= WAIT_ABANDONED_0
1245 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1246 {
1247 active -= WAIT_ABANDONED_0;
1248 }
1249 else
1250 emacs_abort ();
1251
1252 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1253 {
1254 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1255 GetLastError ()));
1256 retval = 1;
1257 }
1258 if (retval == STILL_ACTIVE)
1259 {
1260 /* Should never happen. */
1261 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1262 if (pid > 0 && dont_wait)
1263 return 0;
1264 errno = EINVAL;
1265 return -1;
1266 }
1267
1268 /* Massage the exit code from the process to match the format expected
1269 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1270 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1271
1272 if (retval == STATUS_CONTROL_C_EXIT)
1273 retval = SIGINT;
1274 else
1275 retval <<= 8;
1276
1277 if (pid > 0 && active != 0)
1278 emacs_abort ();
1279 cp = cps[active];
1280 pid = cp->pid;
1281 #ifdef FULL_DEBUG
1282 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1283 #endif
1284
1285 if (status)
1286 *status = retval;
1287 reap_subprocess (cp);
1288
1289 return pid;
1290 }
1291
1292 /* Old versions of w32api headers don't have separate 32-bit and
1293 64-bit defines, but the one they have matches the 32-bit variety. */
1294 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1295 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1296 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1297 #endif
1298
1299 static void
1300 w32_executable_type (char * filename,
1301 int * is_dos_app,
1302 int * is_cygnus_app,
1303 int * is_gui_app)
1304 {
1305 file_data executable;
1306 char * p;
1307
1308 /* Default values in case we can't tell for sure. */
1309 *is_dos_app = FALSE;
1310 *is_cygnus_app = FALSE;
1311 *is_gui_app = FALSE;
1312
1313 if (!open_input_file (&executable, filename))
1314 return;
1315
1316 p = strrchr (filename, '.');
1317
1318 /* We can only identify DOS .com programs from the extension. */
1319 if (p && xstrcasecmp (p, ".com") == 0)
1320 *is_dos_app = TRUE;
1321 else if (p && (xstrcasecmp (p, ".bat") == 0
1322 || xstrcasecmp (p, ".cmd") == 0))
1323 {
1324 /* A DOS shell script - it appears that CreateProcess is happy to
1325 accept this (somewhat surprisingly); presumably it looks at
1326 COMSPEC to determine what executable to actually invoke.
1327 Therefore, we have to do the same here as well. */
1328 /* Actually, I think it uses the program association for that
1329 extension, which is defined in the registry. */
1330 p = egetenv ("COMSPEC");
1331 if (p)
1332 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1333 }
1334 else
1335 {
1336 /* Look for DOS .exe signature - if found, we must also check that
1337 it isn't really a 16- or 32-bit Windows exe, since both formats
1338 start with a DOS program stub. Note that 16-bit Windows
1339 executables use the OS/2 1.x format. */
1340
1341 IMAGE_DOS_HEADER * dos_header;
1342 IMAGE_NT_HEADERS * nt_header;
1343
1344 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1345 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1346 goto unwind;
1347
1348 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1349
1350 if ((char *) nt_header > (char *) dos_header + executable.size)
1351 {
1352 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1353 *is_dos_app = TRUE;
1354 }
1355 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1356 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1357 {
1358 *is_dos_app = TRUE;
1359 }
1360 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1361 {
1362 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1363 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1364 {
1365 /* Ensure we are using the 32 bit structure. */
1366 IMAGE_OPTIONAL_HEADER32 *opt
1367 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1368 data_dir = opt->DataDirectory;
1369 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1370 }
1371 /* MingW 3.12 has the required 64 bit structs, but in case older
1372 versions don't, only check 64 bit exes if we know how. */
1373 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1374 else if (nt_header->OptionalHeader.Magic
1375 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1376 {
1377 IMAGE_OPTIONAL_HEADER64 *opt
1378 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1379 data_dir = opt->DataDirectory;
1380 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1381 }
1382 #endif
1383 if (data_dir)
1384 {
1385 /* Look for cygwin.dll in DLL import list. */
1386 IMAGE_DATA_DIRECTORY import_dir =
1387 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1388 IMAGE_IMPORT_DESCRIPTOR * imports;
1389 IMAGE_SECTION_HEADER * section;
1390
1391 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1392 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1393 executable);
1394
1395 for ( ; imports->Name; imports++)
1396 {
1397 char * dllname = RVA_TO_PTR (imports->Name, section,
1398 executable);
1399
1400 /* The exact name of the cygwin dll has changed with
1401 various releases, but hopefully this will be reasonably
1402 future proof. */
1403 if (strncmp (dllname, "cygwin", 6) == 0)
1404 {
1405 *is_cygnus_app = TRUE;
1406 break;
1407 }
1408 }
1409 }
1410 }
1411 }
1412
1413 unwind:
1414 close_file_data (&executable);
1415 }
1416
1417 static int
1418 compare_env (const void *strp1, const void *strp2)
1419 {
1420 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1421
1422 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1423 {
1424 /* Sort order in command.com/cmd.exe is based on uppercasing
1425 names, so do the same here. */
1426 if (toupper (*str1) > toupper (*str2))
1427 return 1;
1428 else if (toupper (*str1) < toupper (*str2))
1429 return -1;
1430 str1++, str2++;
1431 }
1432
1433 if (*str1 == '=' && *str2 == '=')
1434 return 0;
1435 else if (*str1 == '=')
1436 return -1;
1437 else
1438 return 1;
1439 }
1440
1441 static void
1442 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1443 {
1444 char **optr, **nptr;
1445 int num;
1446
1447 nptr = new_envp;
1448 optr = envp1;
1449 while (*optr)
1450 *nptr++ = *optr++;
1451 num = optr - envp1;
1452
1453 optr = envp2;
1454 while (*optr)
1455 *nptr++ = *optr++;
1456 num += optr - envp2;
1457
1458 qsort (new_envp, num, sizeof (char *), compare_env);
1459
1460 *nptr = NULL;
1461 }
1462
1463 /* When a new child process is created we need to register it in our list,
1464 so intercept spawn requests. */
1465 int
1466 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1467 {
1468 Lisp_Object program, full;
1469 char *cmdline, *env, *parg, **targ;
1470 int arglen, numenv;
1471 int pid;
1472 child_process *cp;
1473 int is_dos_app, is_cygnus_app, is_gui_app;
1474 int do_quoting = 0;
1475 char escape_char;
1476 /* We pass our process ID to our children by setting up an environment
1477 variable in their environment. */
1478 char ppid_env_var_buffer[64];
1479 char *extra_env[] = {ppid_env_var_buffer, NULL};
1480 /* These are the characters that cause an argument to need quoting.
1481 Arguments with whitespace characters need quoting to prevent the
1482 argument being split into two or more. Arguments with wildcards
1483 are also quoted, for consistency with posix platforms, where wildcards
1484 are not expanded if we run the program directly without a shell.
1485 Some extra whitespace characters need quoting in Cygwin programs,
1486 so this list is conditionally modified below. */
1487 char *sepchars = " \t*?";
1488
1489 /* We don't care about the other modes */
1490 if (mode != _P_NOWAIT)
1491 {
1492 errno = EINVAL;
1493 return -1;
1494 }
1495
1496 /* Handle executable names without an executable suffix. */
1497 program = build_string (cmdname);
1498 if (NILP (Ffile_executable_p (program)))
1499 {
1500 struct gcpro gcpro1;
1501
1502 full = Qnil;
1503 GCPRO1 (program);
1504 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK));
1505 UNGCPRO;
1506 if (NILP (full))
1507 {
1508 errno = EINVAL;
1509 return -1;
1510 }
1511 program = full;
1512 }
1513
1514 /* make sure argv[0] and cmdname are both in DOS format */
1515 cmdname = SDATA (program);
1516 unixtodos_filename (cmdname);
1517 argv[0] = cmdname;
1518
1519 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1520 executable that is implicitly linked to the Cygnus dll (implying it
1521 was compiled with the Cygnus GNU toolchain and hence relies on
1522 cygwin.dll to parse the command line - we use this to decide how to
1523 escape quote chars in command line args that must be quoted).
1524
1525 Also determine whether it is a GUI app, so that we don't hide its
1526 initial window unless specifically requested. */
1527 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1528
1529 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1530 application to start it by specifying the helper app as cmdname,
1531 while leaving the real app name as argv[0]. */
1532 if (is_dos_app)
1533 {
1534 cmdname = alloca (MAXPATHLEN);
1535 if (egetenv ("CMDPROXY"))
1536 strcpy (cmdname, egetenv ("CMDPROXY"));
1537 else
1538 {
1539 strcpy (cmdname, SDATA (Vinvocation_directory));
1540 strcat (cmdname, "cmdproxy.exe");
1541 }
1542 unixtodos_filename (cmdname);
1543 }
1544
1545 /* we have to do some conjuring here to put argv and envp into the
1546 form CreateProcess wants... argv needs to be a space separated/null
1547 terminated list of parameters, and envp is a null
1548 separated/double-null terminated list of parameters.
1549
1550 Additionally, zero-length args and args containing whitespace or
1551 quote chars need to be wrapped in double quotes - for this to work,
1552 embedded quotes need to be escaped as well. The aim is to ensure
1553 the child process reconstructs the argv array we start with
1554 exactly, so we treat quotes at the beginning and end of arguments
1555 as embedded quotes.
1556
1557 The w32 GNU-based library from Cygnus doubles quotes to escape
1558 them, while MSVC uses backslash for escaping. (Actually the MSVC
1559 startup code does attempt to recognize doubled quotes and accept
1560 them, but gets it wrong and ends up requiring three quotes to get a
1561 single embedded quote!) So by default we decide whether to use
1562 quote or backslash as the escape character based on whether the
1563 binary is apparently a Cygnus compiled app.
1564
1565 Note that using backslash to escape embedded quotes requires
1566 additional special handling if an embedded quote is already
1567 preceded by backslash, or if an arg requiring quoting ends with
1568 backslash. In such cases, the run of escape characters needs to be
1569 doubled. For consistency, we apply this special handling as long
1570 as the escape character is not quote.
1571
1572 Since we have no idea how large argv and envp are likely to be we
1573 figure out list lengths on the fly and allocate them. */
1574
1575 if (!NILP (Vw32_quote_process_args))
1576 {
1577 do_quoting = 1;
1578 /* Override escape char by binding w32-quote-process-args to
1579 desired character, or use t for auto-selection. */
1580 if (INTEGERP (Vw32_quote_process_args))
1581 escape_char = XINT (Vw32_quote_process_args);
1582 else
1583 escape_char = is_cygnus_app ? '"' : '\\';
1584 }
1585
1586 /* Cygwin apps needs quoting a bit more often. */
1587 if (escape_char == '"')
1588 sepchars = "\r\n\t\f '";
1589
1590 /* do argv... */
1591 arglen = 0;
1592 targ = argv;
1593 while (*targ)
1594 {
1595 char * p = *targ;
1596 int need_quotes = 0;
1597 int escape_char_run = 0;
1598
1599 if (*p == 0)
1600 need_quotes = 1;
1601 for ( ; *p; p++)
1602 {
1603 if (escape_char == '"' && *p == '\\')
1604 /* If it's a Cygwin app, \ needs to be escaped. */
1605 arglen++;
1606 else if (*p == '"')
1607 {
1608 /* allow for embedded quotes to be escaped */
1609 arglen++;
1610 need_quotes = 1;
1611 /* handle the case where the embedded quote is already escaped */
1612 if (escape_char_run > 0)
1613 {
1614 /* To preserve the arg exactly, we need to double the
1615 preceding escape characters (plus adding one to
1616 escape the quote character itself). */
1617 arglen += escape_char_run;
1618 }
1619 }
1620 else if (strchr (sepchars, *p) != NULL)
1621 {
1622 need_quotes = 1;
1623 }
1624
1625 if (*p == escape_char && escape_char != '"')
1626 escape_char_run++;
1627 else
1628 escape_char_run = 0;
1629 }
1630 if (need_quotes)
1631 {
1632 arglen += 2;
1633 /* handle the case where the arg ends with an escape char - we
1634 must not let the enclosing quote be escaped. */
1635 if (escape_char_run > 0)
1636 arglen += escape_char_run;
1637 }
1638 arglen += strlen (*targ++) + 1;
1639 }
1640 cmdline = alloca (arglen);
1641 targ = argv;
1642 parg = cmdline;
1643 while (*targ)
1644 {
1645 char * p = *targ;
1646 int need_quotes = 0;
1647
1648 if (*p == 0)
1649 need_quotes = 1;
1650
1651 if (do_quoting)
1652 {
1653 for ( ; *p; p++)
1654 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1655 need_quotes = 1;
1656 }
1657 if (need_quotes)
1658 {
1659 int escape_char_run = 0;
1660 char * first;
1661 char * last;
1662
1663 p = *targ;
1664 first = p;
1665 last = p + strlen (p) - 1;
1666 *parg++ = '"';
1667 #if 0
1668 /* This version does not escape quotes if they occur at the
1669 beginning or end of the arg - this could lead to incorrect
1670 behavior when the arg itself represents a command line
1671 containing quoted args. I believe this was originally done
1672 as a hack to make some things work, before
1673 `w32-quote-process-args' was added. */
1674 while (*p)
1675 {
1676 if (*p == '"' && p > first && p < last)
1677 *parg++ = escape_char; /* escape embedded quotes */
1678 *parg++ = *p++;
1679 }
1680 #else
1681 for ( ; *p; p++)
1682 {
1683 if (*p == '"')
1684 {
1685 /* double preceding escape chars if any */
1686 while (escape_char_run > 0)
1687 {
1688 *parg++ = escape_char;
1689 escape_char_run--;
1690 }
1691 /* escape all quote chars, even at beginning or end */
1692 *parg++ = escape_char;
1693 }
1694 else if (escape_char == '"' && *p == '\\')
1695 *parg++ = '\\';
1696 *parg++ = *p;
1697
1698 if (*p == escape_char && escape_char != '"')
1699 escape_char_run++;
1700 else
1701 escape_char_run = 0;
1702 }
1703 /* double escape chars before enclosing quote */
1704 while (escape_char_run > 0)
1705 {
1706 *parg++ = escape_char;
1707 escape_char_run--;
1708 }
1709 #endif
1710 *parg++ = '"';
1711 }
1712 else
1713 {
1714 strcpy (parg, *targ);
1715 parg += strlen (*targ);
1716 }
1717 *parg++ = ' ';
1718 targ++;
1719 }
1720 *--parg = '\0';
1721
1722 /* and envp... */
1723 arglen = 1;
1724 targ = envp;
1725 numenv = 1; /* for end null */
1726 while (*targ)
1727 {
1728 arglen += strlen (*targ++) + 1;
1729 numenv++;
1730 }
1731 /* extra env vars... */
1732 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1733 GetCurrentProcessId ());
1734 arglen += strlen (ppid_env_var_buffer) + 1;
1735 numenv++;
1736
1737 /* merge env passed in and extra env into one, and sort it. */
1738 targ = (char **) alloca (numenv * sizeof (char *));
1739 merge_and_sort_env (envp, extra_env, targ);
1740
1741 /* concatenate env entries. */
1742 env = alloca (arglen);
1743 parg = env;
1744 while (*targ)
1745 {
1746 strcpy (parg, *targ);
1747 parg += strlen (*targ++);
1748 *parg++ = '\0';
1749 }
1750 *parg++ = '\0';
1751 *parg = '\0';
1752
1753 cp = new_child ();
1754 if (cp == NULL)
1755 {
1756 errno = EAGAIN;
1757 return -1;
1758 }
1759
1760 /* Now create the process. */
1761 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1762 {
1763 delete_child (cp);
1764 errno = ENOEXEC;
1765 return -1;
1766 }
1767
1768 return pid;
1769 }
1770
1771 /* Emulate the select call
1772 Wait for available input on any of the given rfds, or timeout if
1773 a timeout is given and no input is detected
1774 wfds and efds are not supported and must be NULL.
1775
1776 For simplicity, we detect the death of child processes here and
1777 synchronously call the SIGCHLD handler. Since it is possible for
1778 children to be created without a corresponding pipe handle from which
1779 to read output, we wait separately on the process handles as well as
1780 the char_avail events for each process pipe. We only call
1781 wait/reap_process when the process actually terminates.
1782
1783 To reduce the number of places in which Emacs can be hung such that
1784 C-g is not able to interrupt it, we always wait on interrupt_handle
1785 (which is signaled by the input thread when C-g is detected). If we
1786 detect that we were woken up by C-g, we return -1 with errno set to
1787 EINTR as on Unix. */
1788
1789 /* From w32console.c */
1790 extern HANDLE keyboard_handle;
1791
1792 /* From w32xfns.c */
1793 extern HANDLE interrupt_handle;
1794
1795 /* From process.c */
1796 extern int proc_buffered_char[];
1797
1798 int
1799 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1800 EMACS_TIME *timeout, void *ignored)
1801 {
1802 SELECT_TYPE orfds;
1803 DWORD timeout_ms, start_time;
1804 int i, nh, nc, nr;
1805 DWORD active;
1806 child_process *cp, *cps[MAX_CHILDREN];
1807 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1808 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1809
1810 timeout_ms =
1811 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1812
1813 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1814 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1815 {
1816 Sleep (timeout_ms);
1817 return 0;
1818 }
1819
1820 /* Otherwise, we only handle rfds, so fail otherwise. */
1821 if (rfds == NULL || wfds != NULL || efds != NULL)
1822 {
1823 errno = EINVAL;
1824 return -1;
1825 }
1826
1827 orfds = *rfds;
1828 FD_ZERO (rfds);
1829 nr = 0;
1830
1831 /* Always wait on interrupt_handle, to detect C-g (quit). */
1832 wait_hnd[0] = interrupt_handle;
1833 fdindex[0] = -1;
1834
1835 /* Build a list of pipe handles to wait on. */
1836 nh = 1;
1837 for (i = 0; i < nfds; i++)
1838 if (FD_ISSET (i, &orfds))
1839 {
1840 if (i == 0)
1841 {
1842 if (keyboard_handle)
1843 {
1844 /* Handle stdin specially */
1845 wait_hnd[nh] = keyboard_handle;
1846 fdindex[nh] = i;
1847 nh++;
1848 }
1849
1850 /* Check for any emacs-generated input in the queue since
1851 it won't be detected in the wait */
1852 if (detect_input_pending ())
1853 {
1854 FD_SET (i, rfds);
1855 return 1;
1856 }
1857 }
1858 else
1859 {
1860 /* Child process and socket input */
1861 cp = fd_info[i].cp;
1862 if (cp)
1863 {
1864 int current_status = cp->status;
1865
1866 if (current_status == STATUS_READ_ACKNOWLEDGED)
1867 {
1868 /* Tell reader thread which file handle to use. */
1869 cp->fd = i;
1870 /* Wake up the reader thread for this process */
1871 cp->status = STATUS_READ_READY;
1872 if (!SetEvent (cp->char_consumed))
1873 DebPrint (("nt_select.SetEvent failed with "
1874 "%lu for fd %ld\n", GetLastError (), i));
1875 }
1876
1877 #ifdef CHECK_INTERLOCK
1878 /* slightly crude cross-checking of interlock between threads */
1879
1880 current_status = cp->status;
1881 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
1882 {
1883 /* char_avail has been signaled, so status (which may
1884 have changed) should indicate read has completed
1885 but has not been acknowledged. */
1886 current_status = cp->status;
1887 if (current_status != STATUS_READ_SUCCEEDED
1888 && current_status != STATUS_READ_FAILED)
1889 DebPrint (("char_avail set, but read not completed: status %d\n",
1890 current_status));
1891 }
1892 else
1893 {
1894 /* char_avail has not been signaled, so status should
1895 indicate that read is in progress; small possibility
1896 that read has completed but event wasn't yet signaled
1897 when we tested it (because a context switch occurred
1898 or if running on separate CPUs). */
1899 if (current_status != STATUS_READ_READY
1900 && current_status != STATUS_READ_IN_PROGRESS
1901 && current_status != STATUS_READ_SUCCEEDED
1902 && current_status != STATUS_READ_FAILED)
1903 DebPrint (("char_avail reset, but read status is bad: %d\n",
1904 current_status));
1905 }
1906 #endif
1907 wait_hnd[nh] = cp->char_avail;
1908 fdindex[nh] = i;
1909 if (!wait_hnd[nh]) emacs_abort ();
1910 nh++;
1911 #ifdef FULL_DEBUG
1912 DebPrint (("select waiting on child %d fd %d\n",
1913 cp-child_procs, i));
1914 #endif
1915 }
1916 else
1917 {
1918 /* Unable to find something to wait on for this fd, skip */
1919
1920 /* Note that this is not a fatal error, and can in fact
1921 happen in unusual circumstances. Specifically, if
1922 sys_spawnve fails, eg. because the program doesn't
1923 exist, and debug-on-error is t so Fsignal invokes a
1924 nested input loop, then the process output pipe is
1925 still included in input_wait_mask with no child_proc
1926 associated with it. (It is removed when the debugger
1927 exits the nested input loop and the error is thrown.) */
1928
1929 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
1930 }
1931 }
1932 }
1933
1934 count_children:
1935 /* Add handles of child processes. */
1936 nc = 0;
1937 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1938 /* Some child_procs might be sockets; ignore them. Also some
1939 children may have died already, but we haven't finished reading
1940 the process output; ignore them too. */
1941 if (CHILD_ACTIVE (cp) && cp->procinfo.hProcess
1942 && (cp->fd < 0
1943 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
1944 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1945 )
1946 {
1947 wait_hnd[nh + nc] = cp->procinfo.hProcess;
1948 cps[nc] = cp;
1949 nc++;
1950 }
1951
1952 /* Nothing to look for, so we didn't find anything */
1953 if (nh + nc == 0)
1954 {
1955 if (timeout)
1956 Sleep (timeout_ms);
1957 return 0;
1958 }
1959
1960 start_time = GetTickCount ();
1961
1962 /* Wait for input or child death to be signaled. If user input is
1963 allowed, then also accept window messages. */
1964 if (FD_ISSET (0, &orfds))
1965 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
1966 QS_ALLINPUT);
1967 else
1968 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
1969
1970 if (active == WAIT_FAILED)
1971 {
1972 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1973 nh + nc, timeout_ms, GetLastError ()));
1974 /* don't return EBADF - this causes wait_reading_process_output to
1975 abort; WAIT_FAILED is returned when single-stepping under
1976 Windows 95 after switching thread focus in debugger, and
1977 possibly at other times. */
1978 errno = EINTR;
1979 return -1;
1980 }
1981 else if (active == WAIT_TIMEOUT)
1982 {
1983 return 0;
1984 }
1985 else if (active >= WAIT_OBJECT_0
1986 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1987 {
1988 active -= WAIT_OBJECT_0;
1989 }
1990 else if (active >= WAIT_ABANDONED_0
1991 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1992 {
1993 active -= WAIT_ABANDONED_0;
1994 }
1995 else
1996 emacs_abort ();
1997
1998 /* Loop over all handles after active (now officially documented as
1999 being the first signaled handle in the array). We do this to
2000 ensure fairness, so that all channels with data available will be
2001 processed - otherwise higher numbered channels could be starved. */
2002 do
2003 {
2004 if (active == nh + nc)
2005 {
2006 /* There are messages in the lisp thread's queue; we must
2007 drain the queue now to ensure they are processed promptly,
2008 because if we don't do so, we will not be woken again until
2009 further messages arrive.
2010
2011 NB. If ever we allow window message procedures to callback
2012 into lisp, we will need to ensure messages are dispatched
2013 at a safe time for lisp code to be run (*), and we may also
2014 want to provide some hooks in the dispatch loop to cater
2015 for modeless dialogs created by lisp (ie. to register
2016 window handles to pass to IsDialogMessage).
2017
2018 (*) Note that MsgWaitForMultipleObjects above is an
2019 internal dispatch point for messages that are sent to
2020 windows created by this thread. */
2021 if (drain_message_queue ()
2022 /* If drain_message_queue returns non-zero, that means
2023 we received a WM_EMACS_FILENOTIFY message. If this
2024 is a TTY frame, we must signal the caller that keyboard
2025 input is available, so that w32_console_read_socket
2026 will be called to pick up the notifications. If we
2027 don't do that, file notifications will only work when
2028 the Emacs TTY frame has focus. */
2029 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2030 /* they asked for stdin reads */
2031 && FD_ISSET (0, &orfds)
2032 /* the stdin handle is valid */
2033 && keyboard_handle)
2034 {
2035 FD_SET (0, rfds);
2036 if (nr == 0)
2037 nr = 1;
2038 }
2039 }
2040 else if (active >= nh)
2041 {
2042 cp = cps[active - nh];
2043
2044 /* We cannot always signal SIGCHLD immediately; if we have not
2045 finished reading the process output, we must delay sending
2046 SIGCHLD until we do. */
2047
2048 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2049 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2050 /* SIG_DFL for SIGCHLD is ignore */
2051 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2052 sig_handlers[SIGCHLD] != SIG_IGN)
2053 {
2054 #ifdef FULL_DEBUG
2055 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2056 cp->pid));
2057 #endif
2058 sig_handlers[SIGCHLD] (SIGCHLD);
2059 }
2060 }
2061 else if (fdindex[active] == -1)
2062 {
2063 /* Quit (C-g) was detected. */
2064 errno = EINTR;
2065 return -1;
2066 }
2067 else if (fdindex[active] == 0)
2068 {
2069 /* Keyboard input available */
2070 FD_SET (0, rfds);
2071 nr++;
2072 }
2073 else
2074 {
2075 /* must be a socket or pipe - read ahead should have
2076 completed, either succeeding or failing. */
2077 FD_SET (fdindex[active], rfds);
2078 nr++;
2079 }
2080
2081 /* Even though wait_reading_process_output only reads from at most
2082 one channel, we must process all channels here so that we reap
2083 all children that have died. */
2084 while (++active < nh + nc)
2085 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2086 break;
2087 } while (active < nh + nc);
2088
2089 /* If no input has arrived and timeout hasn't expired, wait again. */
2090 if (nr == 0)
2091 {
2092 DWORD elapsed = GetTickCount () - start_time;
2093
2094 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2095 {
2096 if (timeout_ms != INFINITE)
2097 timeout_ms -= elapsed;
2098 goto count_children;
2099 }
2100 }
2101
2102 return nr;
2103 }
2104
2105 /* Substitute for certain kill () operations */
2106
2107 static BOOL CALLBACK
2108 find_child_console (HWND hwnd, LPARAM arg)
2109 {
2110 child_process * cp = (child_process *) arg;
2111 DWORD thread_id;
2112 DWORD process_id;
2113
2114 thread_id = GetWindowThreadProcessId (hwnd, &process_id);
2115 if (process_id == cp->procinfo.dwProcessId)
2116 {
2117 char window_class[32];
2118
2119 GetClassName (hwnd, window_class, sizeof (window_class));
2120 if (strcmp (window_class,
2121 (os_subtype == OS_9X)
2122 ? "tty"
2123 : "ConsoleWindowClass") == 0)
2124 {
2125 cp->hwnd = hwnd;
2126 return FALSE;
2127 }
2128 }
2129 /* keep looking */
2130 return TRUE;
2131 }
2132
2133 /* Emulate 'kill', but only for other processes. */
2134 int
2135 sys_kill (int pid, int sig)
2136 {
2137 child_process *cp;
2138 HANDLE proc_hand;
2139 int need_to_free = 0;
2140 int rc = 0;
2141
2142 /* Each process is in its own process group. */
2143 if (pid < 0)
2144 pid = -pid;
2145
2146 /* Only handle signals that will result in the process dying */
2147 if (sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2148 {
2149 errno = EINVAL;
2150 return -1;
2151 }
2152
2153 cp = find_child_pid (pid);
2154 if (cp == NULL)
2155 {
2156 /* We were passed a PID of something other than our subprocess.
2157 If that is our own PID, we will send to ourself a message to
2158 close the selected frame, which does not necessarily
2159 terminates Emacs. But then we are not supposed to call
2160 sys_kill with our own PID. */
2161 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2162 if (proc_hand == NULL)
2163 {
2164 errno = EPERM;
2165 return -1;
2166 }
2167 need_to_free = 1;
2168 }
2169 else
2170 {
2171 proc_hand = cp->procinfo.hProcess;
2172 pid = cp->procinfo.dwProcessId;
2173
2174 /* Try to locate console window for process. */
2175 EnumWindows (find_child_console, (LPARAM) cp);
2176 }
2177
2178 if (sig == SIGINT || sig == SIGQUIT)
2179 {
2180 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2181 {
2182 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2183 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2184 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2185 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2186 HWND foreground_window;
2187
2188 if (break_scan_code == 0)
2189 {
2190 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2191 vk_break_code = 'C';
2192 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2193 }
2194
2195 foreground_window = GetForegroundWindow ();
2196 if (foreground_window)
2197 {
2198 /* NT 5.0, and apparently also Windows 98, will not allow
2199 a Window to be set to foreground directly without the
2200 user's involvement. The workaround is to attach
2201 ourselves to the thread that owns the foreground
2202 window, since that is the only thread that can set the
2203 foreground window. */
2204 DWORD foreground_thread, child_thread;
2205 foreground_thread =
2206 GetWindowThreadProcessId (foreground_window, NULL);
2207 if (foreground_thread == GetCurrentThreadId ()
2208 || !AttachThreadInput (GetCurrentThreadId (),
2209 foreground_thread, TRUE))
2210 foreground_thread = 0;
2211
2212 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2213 if (child_thread == GetCurrentThreadId ()
2214 || !AttachThreadInput (GetCurrentThreadId (),
2215 child_thread, TRUE))
2216 child_thread = 0;
2217
2218 /* Set the foreground window to the child. */
2219 if (SetForegroundWindow (cp->hwnd))
2220 {
2221 /* Generate keystrokes as if user had typed Ctrl-Break or
2222 Ctrl-C. */
2223 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2224 keybd_event (vk_break_code, break_scan_code,
2225 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2226 keybd_event (vk_break_code, break_scan_code,
2227 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2228 | KEYEVENTF_KEYUP, 0);
2229 keybd_event (VK_CONTROL, control_scan_code,
2230 KEYEVENTF_KEYUP, 0);
2231
2232 /* Sleep for a bit to give time for Emacs frame to respond
2233 to focus change events (if Emacs was active app). */
2234 Sleep (100);
2235
2236 SetForegroundWindow (foreground_window);
2237 }
2238 /* Detach from the foreground and child threads now that
2239 the foreground switching is over. */
2240 if (foreground_thread)
2241 AttachThreadInput (GetCurrentThreadId (),
2242 foreground_thread, FALSE);
2243 if (child_thread)
2244 AttachThreadInput (GetCurrentThreadId (),
2245 child_thread, FALSE);
2246 }
2247 }
2248 /* Ctrl-Break is NT equivalent of SIGINT. */
2249 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2250 {
2251 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2252 "for pid %lu\n", GetLastError (), pid));
2253 errno = EINVAL;
2254 rc = -1;
2255 }
2256 }
2257 else
2258 {
2259 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2260 {
2261 #if 1
2262 if (os_subtype == OS_9X)
2263 {
2264 /*
2265 Another possibility is to try terminating the VDM out-right by
2266 calling the Shell VxD (id 0x17) V86 interface, function #4
2267 "SHELL_Destroy_VM", ie.
2268
2269 mov edx,4
2270 mov ebx,vm_handle
2271 call shellapi
2272
2273 First need to determine the current VM handle, and then arrange for
2274 the shellapi call to be made from the system vm (by using
2275 Switch_VM_and_callback).
2276
2277 Could try to invoke DestroyVM through CallVxD.
2278
2279 */
2280 #if 0
2281 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2282 to hang when cmdproxy is used in conjunction with
2283 command.com for an interactive shell. Posting
2284 WM_CLOSE pops up a dialog that, when Yes is selected,
2285 does the same thing. TerminateProcess is also less
2286 than ideal in that subprocesses tend to stick around
2287 until the machine is shutdown, but at least it
2288 doesn't freeze the 16-bit subsystem. */
2289 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2290 #endif
2291 if (!TerminateProcess (proc_hand, 0xff))
2292 {
2293 DebPrint (("sys_kill.TerminateProcess returned %d "
2294 "for pid %lu\n", GetLastError (), pid));
2295 errno = EINVAL;
2296 rc = -1;
2297 }
2298 }
2299 else
2300 #endif
2301 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2302 }
2303 /* Kill the process. On W32 this doesn't kill child processes
2304 so it doesn't work very well for shells which is why it's not
2305 used in every case. */
2306 else if (!TerminateProcess (proc_hand, 0xff))
2307 {
2308 DebPrint (("sys_kill.TerminateProcess returned %d "
2309 "for pid %lu\n", GetLastError (), pid));
2310 errno = EINVAL;
2311 rc = -1;
2312 }
2313 }
2314
2315 if (need_to_free)
2316 CloseHandle (proc_hand);
2317
2318 return rc;
2319 }
2320
2321 /* The following two routines are used to manipulate stdin, stdout, and
2322 stderr of our child processes.
2323
2324 Assuming that in, out, and err are *not* inheritable, we make them
2325 stdin, stdout, and stderr of the child as follows:
2326
2327 - Save the parent's current standard handles.
2328 - Set the std handles to inheritable duplicates of the ones being passed in.
2329 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2330 NT file handle for a crt file descriptor.)
2331 - Spawn the child, which inherits in, out, and err as stdin,
2332 stdout, and stderr. (see Spawnve)
2333 - Close the std handles passed to the child.
2334 - Reset the parent's standard handles to the saved handles.
2335 (see reset_standard_handles)
2336 We assume that the caller closes in, out, and err after calling us. */
2337
2338 void
2339 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2340 {
2341 HANDLE parent;
2342 HANDLE newstdin, newstdout, newstderr;
2343
2344 parent = GetCurrentProcess ();
2345
2346 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2347 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2348 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2349
2350 /* make inheritable copies of the new handles */
2351 if (!DuplicateHandle (parent,
2352 (HANDLE) _get_osfhandle (in),
2353 parent,
2354 &newstdin,
2355 0,
2356 TRUE,
2357 DUPLICATE_SAME_ACCESS))
2358 report_file_error ("Duplicating input handle for child", Qnil);
2359
2360 if (!DuplicateHandle (parent,
2361 (HANDLE) _get_osfhandle (out),
2362 parent,
2363 &newstdout,
2364 0,
2365 TRUE,
2366 DUPLICATE_SAME_ACCESS))
2367 report_file_error ("Duplicating output handle for child", Qnil);
2368
2369 if (!DuplicateHandle (parent,
2370 (HANDLE) _get_osfhandle (err),
2371 parent,
2372 &newstderr,
2373 0,
2374 TRUE,
2375 DUPLICATE_SAME_ACCESS))
2376 report_file_error ("Duplicating error handle for child", Qnil);
2377
2378 /* and store them as our std handles */
2379 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2380 report_file_error ("Changing stdin handle", Qnil);
2381
2382 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2383 report_file_error ("Changing stdout handle", Qnil);
2384
2385 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2386 report_file_error ("Changing stderr handle", Qnil);
2387 }
2388
2389 void
2390 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2391 {
2392 /* close the duplicated handles passed to the child */
2393 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2394 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2395 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2396
2397 /* now restore parent's saved std handles */
2398 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2399 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2400 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2401 }
2402
2403 void
2404 set_process_dir (char * dir)
2405 {
2406 process_dir = dir;
2407 }
2408
2409 /* To avoid problems with winsock implementations that work over dial-up
2410 connections causing or requiring a connection to exist while Emacs is
2411 running, Emacs no longer automatically loads winsock on startup if it
2412 is present. Instead, it will be loaded when open-network-stream is
2413 first called.
2414
2415 To allow full control over when winsock is loaded, we provide these
2416 two functions to dynamically load and unload winsock. This allows
2417 dial-up users to only be connected when they actually need to use
2418 socket services. */
2419
2420 /* From w32.c */
2421 extern HANDLE winsock_lib;
2422 extern BOOL term_winsock (void);
2423 extern BOOL init_winsock (int load_now);
2424
2425 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2426 doc: /* Test for presence of the Windows socket library `winsock'.
2427 Returns non-nil if winsock support is present, nil otherwise.
2428
2429 If the optional argument LOAD-NOW is non-nil, the winsock library is
2430 also loaded immediately if not already loaded. If winsock is loaded,
2431 the winsock local hostname is returned (since this may be different from
2432 the value of `system-name' and should supplant it), otherwise t is
2433 returned to indicate winsock support is present. */)
2434 (Lisp_Object load_now)
2435 {
2436 int have_winsock;
2437
2438 have_winsock = init_winsock (!NILP (load_now));
2439 if (have_winsock)
2440 {
2441 if (winsock_lib != NULL)
2442 {
2443 /* Return new value for system-name. The best way to do this
2444 is to call init_system_name, saving and restoring the
2445 original value to avoid side-effects. */
2446 Lisp_Object orig_hostname = Vsystem_name;
2447 Lisp_Object hostname;
2448
2449 init_system_name ();
2450 hostname = Vsystem_name;
2451 Vsystem_name = orig_hostname;
2452 return hostname;
2453 }
2454 return Qt;
2455 }
2456 return Qnil;
2457 }
2458
2459 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2460 0, 0, 0,
2461 doc: /* Unload the Windows socket library `winsock' if loaded.
2462 This is provided to allow dial-up socket connections to be disconnected
2463 when no longer needed. Returns nil without unloading winsock if any
2464 socket connections still exist. */)
2465 (void)
2466 {
2467 return term_winsock () ? Qt : Qnil;
2468 }
2469
2470 \f
2471 /* Some miscellaneous functions that are Windows specific, but not GUI
2472 specific (ie. are applicable in terminal or batch mode as well). */
2473
2474 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2475 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2476 If FILENAME does not exist, return nil.
2477 All path elements in FILENAME are converted to their short names. */)
2478 (Lisp_Object filename)
2479 {
2480 char shortname[MAX_PATH];
2481
2482 CHECK_STRING (filename);
2483
2484 /* first expand it. */
2485 filename = Fexpand_file_name (filename, Qnil);
2486
2487 /* luckily, this returns the short version of each element in the path. */
2488 if (GetShortPathName (SDATA (ENCODE_FILE (filename)), shortname, MAX_PATH) == 0)
2489 return Qnil;
2490
2491 dostounix_filename (shortname);
2492
2493 return build_string (shortname);
2494 }
2495
2496
2497 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2498 1, 1, 0,
2499 doc: /* Return the long file name version of the full path of FILENAME.
2500 If FILENAME does not exist, return nil.
2501 All path elements in FILENAME are converted to their long names. */)
2502 (Lisp_Object filename)
2503 {
2504 char longname[ MAX_PATH ];
2505 int drive_only = 0;
2506
2507 CHECK_STRING (filename);
2508
2509 if (SBYTES (filename) == 2
2510 && *(SDATA (filename) + 1) == ':')
2511 drive_only = 1;
2512
2513 /* first expand it. */
2514 filename = Fexpand_file_name (filename, Qnil);
2515
2516 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname, MAX_PATH))
2517 return Qnil;
2518
2519 dostounix_filename (longname);
2520
2521 /* If we were passed only a drive, make sure that a slash is not appended
2522 for consistency with directories. Allow for drive mapping via SUBST
2523 in case expand-file-name is ever changed to expand those. */
2524 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2525 longname[2] = '\0';
2526
2527 return DECODE_FILE (build_string (longname));
2528 }
2529
2530 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2531 Sw32_set_process_priority, 2, 2, 0,
2532 doc: /* Set the priority of PROCESS to PRIORITY.
2533 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2534 priority of the process whose pid is PROCESS is changed.
2535 PRIORITY should be one of the symbols high, normal, or low;
2536 any other symbol will be interpreted as normal.
2537
2538 If successful, the return value is t, otherwise nil. */)
2539 (Lisp_Object process, Lisp_Object priority)
2540 {
2541 HANDLE proc_handle = GetCurrentProcess ();
2542 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2543 Lisp_Object result = Qnil;
2544
2545 CHECK_SYMBOL (priority);
2546
2547 if (!NILP (process))
2548 {
2549 DWORD pid;
2550 child_process *cp;
2551
2552 CHECK_NUMBER (process);
2553
2554 /* Allow pid to be an internally generated one, or one obtained
2555 externally. This is necessary because real pids on Windows 95 are
2556 negative. */
2557
2558 pid = XINT (process);
2559 cp = find_child_pid (pid);
2560 if (cp != NULL)
2561 pid = cp->procinfo.dwProcessId;
2562
2563 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2564 }
2565
2566 if (EQ (priority, Qhigh))
2567 priority_class = HIGH_PRIORITY_CLASS;
2568 else if (EQ (priority, Qlow))
2569 priority_class = IDLE_PRIORITY_CLASS;
2570
2571 if (proc_handle != NULL)
2572 {
2573 if (SetPriorityClass (proc_handle, priority_class))
2574 result = Qt;
2575 if (!NILP (process))
2576 CloseHandle (proc_handle);
2577 }
2578
2579 return result;
2580 }
2581
2582 #ifdef HAVE_LANGINFO_CODESET
2583 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2584 char *
2585 nl_langinfo (nl_item item)
2586 {
2587 /* Conversion of Posix item numbers to their Windows equivalents. */
2588 static const LCTYPE w32item[] = {
2589 LOCALE_IDEFAULTANSICODEPAGE,
2590 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2591 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2592 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2593 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2594 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2595 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2596 };
2597
2598 static char *nl_langinfo_buf = NULL;
2599 static int nl_langinfo_len = 0;
2600
2601 if (nl_langinfo_len <= 0)
2602 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2603
2604 if (item < 0 || item >= _NL_NUM)
2605 nl_langinfo_buf[0] = 0;
2606 else
2607 {
2608 LCID cloc = GetThreadLocale ();
2609 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2610 NULL, 0);
2611
2612 if (need_len <= 0)
2613 nl_langinfo_buf[0] = 0;
2614 else
2615 {
2616 if (item == CODESET)
2617 {
2618 need_len += 2; /* for the "cp" prefix */
2619 if (need_len < 8) /* for the case we call GetACP */
2620 need_len = 8;
2621 }
2622 if (nl_langinfo_len <= need_len)
2623 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2624 nl_langinfo_len = need_len);
2625 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2626 nl_langinfo_buf, nl_langinfo_len))
2627 nl_langinfo_buf[0] = 0;
2628 else if (item == CODESET)
2629 {
2630 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2631 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2632 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2633 else
2634 {
2635 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2636 strlen (nl_langinfo_buf) + 1);
2637 nl_langinfo_buf[0] = 'c';
2638 nl_langinfo_buf[1] = 'p';
2639 }
2640 }
2641 }
2642 }
2643 return nl_langinfo_buf;
2644 }
2645 #endif /* HAVE_LANGINFO_CODESET */
2646
2647 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2648 Sw32_get_locale_info, 1, 2, 0,
2649 doc: /* Return information about the Windows locale LCID.
2650 By default, return a three letter locale code which encodes the default
2651 language as the first two characters, and the country or regional variant
2652 as the third letter. For example, ENU refers to `English (United States)',
2653 while ENC means `English (Canadian)'.
2654
2655 If the optional argument LONGFORM is t, the long form of the locale
2656 name is returned, e.g. `English (United States)' instead; if LONGFORM
2657 is a number, it is interpreted as an LCTYPE constant and the corresponding
2658 locale information is returned.
2659
2660 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2661 (Lisp_Object lcid, Lisp_Object longform)
2662 {
2663 int got_abbrev;
2664 int got_full;
2665 char abbrev_name[32] = { 0 };
2666 char full_name[256] = { 0 };
2667
2668 CHECK_NUMBER (lcid);
2669
2670 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2671 return Qnil;
2672
2673 if (NILP (longform))
2674 {
2675 got_abbrev = GetLocaleInfo (XINT (lcid),
2676 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2677 abbrev_name, sizeof (abbrev_name));
2678 if (got_abbrev)
2679 return build_string (abbrev_name);
2680 }
2681 else if (EQ (longform, Qt))
2682 {
2683 got_full = GetLocaleInfo (XINT (lcid),
2684 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2685 full_name, sizeof (full_name));
2686 if (got_full)
2687 return DECODE_SYSTEM (build_string (full_name));
2688 }
2689 else if (NUMBERP (longform))
2690 {
2691 got_full = GetLocaleInfo (XINT (lcid),
2692 XINT (longform),
2693 full_name, sizeof (full_name));
2694 /* GetLocaleInfo's return value includes the terminating null
2695 character, when the returned information is a string, whereas
2696 make_unibyte_string needs the string length without the
2697 terminating null. */
2698 if (got_full)
2699 return make_unibyte_string (full_name, got_full - 1);
2700 }
2701
2702 return Qnil;
2703 }
2704
2705
2706 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2707 Sw32_get_current_locale_id, 0, 0, 0,
2708 doc: /* Return Windows locale id for current locale setting.
2709 This is a numerical value; use `w32-get-locale-info' to convert to a
2710 human-readable form. */)
2711 (void)
2712 {
2713 return make_number (GetThreadLocale ());
2714 }
2715
2716 static DWORD
2717 int_from_hex (char * s)
2718 {
2719 DWORD val = 0;
2720 static char hex[] = "0123456789abcdefABCDEF";
2721 char * p;
2722
2723 while (*s && (p = strchr (hex, *s)) != NULL)
2724 {
2725 unsigned digit = p - hex;
2726 if (digit > 15)
2727 digit -= 6;
2728 val = val * 16 + digit;
2729 s++;
2730 }
2731 return val;
2732 }
2733
2734 /* We need to build a global list, since the EnumSystemLocale callback
2735 function isn't given a context pointer. */
2736 Lisp_Object Vw32_valid_locale_ids;
2737
2738 static BOOL CALLBACK
2739 enum_locale_fn (LPTSTR localeNum)
2740 {
2741 DWORD id = int_from_hex (localeNum);
2742 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2743 return TRUE;
2744 }
2745
2746 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2747 Sw32_get_valid_locale_ids, 0, 0, 0,
2748 doc: /* Return list of all valid Windows locale ids.
2749 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2750 human-readable form. */)
2751 (void)
2752 {
2753 Vw32_valid_locale_ids = Qnil;
2754
2755 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2756
2757 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2758 return Vw32_valid_locale_ids;
2759 }
2760
2761
2762 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2763 doc: /* Return Windows locale id for default locale setting.
2764 By default, the system default locale setting is returned; if the optional
2765 parameter USERP is non-nil, the user default locale setting is returned.
2766 This is a numerical value; use `w32-get-locale-info' to convert to a
2767 human-readable form. */)
2768 (Lisp_Object userp)
2769 {
2770 if (NILP (userp))
2771 return make_number (GetSystemDefaultLCID ());
2772 return make_number (GetUserDefaultLCID ());
2773 }
2774
2775
2776 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2777 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2778 If successful, the new locale id is returned, otherwise nil. */)
2779 (Lisp_Object lcid)
2780 {
2781 CHECK_NUMBER (lcid);
2782
2783 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2784 return Qnil;
2785
2786 if (!SetThreadLocale (XINT (lcid)))
2787 return Qnil;
2788
2789 /* Need to set input thread locale if present. */
2790 if (dwWindowsThreadId)
2791 /* Reply is not needed. */
2792 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2793
2794 return make_number (GetThreadLocale ());
2795 }
2796
2797
2798 /* We need to build a global list, since the EnumCodePages callback
2799 function isn't given a context pointer. */
2800 Lisp_Object Vw32_valid_codepages;
2801
2802 static BOOL CALLBACK
2803 enum_codepage_fn (LPTSTR codepageNum)
2804 {
2805 DWORD id = atoi (codepageNum);
2806 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2807 return TRUE;
2808 }
2809
2810 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
2811 Sw32_get_valid_codepages, 0, 0, 0,
2812 doc: /* Return list of all valid Windows codepages. */)
2813 (void)
2814 {
2815 Vw32_valid_codepages = Qnil;
2816
2817 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
2818
2819 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
2820 return Vw32_valid_codepages;
2821 }
2822
2823
2824 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
2825 Sw32_get_console_codepage, 0, 0, 0,
2826 doc: /* Return current Windows codepage for console input. */)
2827 (void)
2828 {
2829 return make_number (GetConsoleCP ());
2830 }
2831
2832
2833 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
2834 Sw32_set_console_codepage, 1, 1, 0,
2835 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2836 This codepage setting affects keyboard input in tty mode.
2837 If successful, the new CP is returned, otherwise nil. */)
2838 (Lisp_Object cp)
2839 {
2840 CHECK_NUMBER (cp);
2841
2842 if (!IsValidCodePage (XINT (cp)))
2843 return Qnil;
2844
2845 if (!SetConsoleCP (XINT (cp)))
2846 return Qnil;
2847
2848 return make_number (GetConsoleCP ());
2849 }
2850
2851
2852 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
2853 Sw32_get_console_output_codepage, 0, 0, 0,
2854 doc: /* Return current Windows codepage for console output. */)
2855 (void)
2856 {
2857 return make_number (GetConsoleOutputCP ());
2858 }
2859
2860
2861 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
2862 Sw32_set_console_output_codepage, 1, 1, 0,
2863 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
2864 This codepage setting affects display in tty mode.
2865 If successful, the new CP is returned, otherwise nil. */)
2866 (Lisp_Object cp)
2867 {
2868 CHECK_NUMBER (cp);
2869
2870 if (!IsValidCodePage (XINT (cp)))
2871 return Qnil;
2872
2873 if (!SetConsoleOutputCP (XINT (cp)))
2874 return Qnil;
2875
2876 return make_number (GetConsoleOutputCP ());
2877 }
2878
2879
2880 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
2881 Sw32_get_codepage_charset, 1, 1, 0,
2882 doc: /* Return charset ID corresponding to codepage CP.
2883 Returns nil if the codepage is not valid. */)
2884 (Lisp_Object cp)
2885 {
2886 CHARSETINFO info;
2887
2888 CHECK_NUMBER (cp);
2889
2890 if (!IsValidCodePage (XINT (cp)))
2891 return Qnil;
2892
2893 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
2894 return make_number (info.ciCharset);
2895
2896 return Qnil;
2897 }
2898
2899
2900 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
2901 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
2902 doc: /* Return list of Windows keyboard languages and layouts.
2903 The return value is a list of pairs of language id and layout id. */)
2904 (void)
2905 {
2906 int num_layouts = GetKeyboardLayoutList (0, NULL);
2907 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
2908 Lisp_Object obj = Qnil;
2909
2910 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
2911 {
2912 while (--num_layouts >= 0)
2913 {
2914 DWORD kl = (DWORD) layouts[num_layouts];
2915
2916 obj = Fcons (Fcons (make_number (kl & 0xffff),
2917 make_number ((kl >> 16) & 0xffff)),
2918 obj);
2919 }
2920 }
2921
2922 return obj;
2923 }
2924
2925
2926 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
2927 Sw32_get_keyboard_layout, 0, 0, 0,
2928 doc: /* Return current Windows keyboard language and layout.
2929 The return value is the cons of the language id and the layout id. */)
2930 (void)
2931 {
2932 DWORD kl = (DWORD) GetKeyboardLayout (dwWindowsThreadId);
2933
2934 return Fcons (make_number (kl & 0xffff),
2935 make_number ((kl >> 16) & 0xffff));
2936 }
2937
2938
2939 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
2940 Sw32_set_keyboard_layout, 1, 1, 0,
2941 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
2942 The keyboard layout setting affects interpretation of keyboard input.
2943 If successful, the new layout id is returned, otherwise nil. */)
2944 (Lisp_Object layout)
2945 {
2946 DWORD kl;
2947
2948 CHECK_CONS (layout);
2949 CHECK_NUMBER_CAR (layout);
2950 CHECK_NUMBER_CDR (layout);
2951
2952 kl = (XINT (XCAR (layout)) & 0xffff)
2953 | (XINT (XCDR (layout)) << 16);
2954
2955 /* Synchronize layout with input thread. */
2956 if (dwWindowsThreadId)
2957 {
2958 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
2959 (WPARAM) kl, 0))
2960 {
2961 MSG msg;
2962 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
2963
2964 if (msg.wParam == 0)
2965 return Qnil;
2966 }
2967 }
2968 else if (!ActivateKeyboardLayout ((HKL) kl, 0))
2969 return Qnil;
2970
2971 return Fw32_get_keyboard_layout ();
2972 }
2973
2974 \f
2975 void
2976 syms_of_ntproc (void)
2977 {
2978 DEFSYM (Qhigh, "high");
2979 DEFSYM (Qlow, "low");
2980
2981 defsubr (&Sw32_has_winsock);
2982 defsubr (&Sw32_unload_winsock);
2983
2984 defsubr (&Sw32_short_file_name);
2985 defsubr (&Sw32_long_file_name);
2986 defsubr (&Sw32_set_process_priority);
2987 defsubr (&Sw32_get_locale_info);
2988 defsubr (&Sw32_get_current_locale_id);
2989 defsubr (&Sw32_get_default_locale_id);
2990 defsubr (&Sw32_get_valid_locale_ids);
2991 defsubr (&Sw32_set_current_locale);
2992
2993 defsubr (&Sw32_get_console_codepage);
2994 defsubr (&Sw32_set_console_codepage);
2995 defsubr (&Sw32_get_console_output_codepage);
2996 defsubr (&Sw32_set_console_output_codepage);
2997 defsubr (&Sw32_get_valid_codepages);
2998 defsubr (&Sw32_get_codepage_charset);
2999
3000 defsubr (&Sw32_get_valid_keyboard_layouts);
3001 defsubr (&Sw32_get_keyboard_layout);
3002 defsubr (&Sw32_set_keyboard_layout);
3003
3004 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3005 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3006 Because Windows does not directly pass argv arrays to child processes,
3007 programs have to reconstruct the argv array by parsing the command
3008 line string. For an argument to contain a space, it must be enclosed
3009 in double quotes or it will be parsed as multiple arguments.
3010
3011 If the value is a character, that character will be used to escape any
3012 quote characters that appear, otherwise a suitable escape character
3013 will be chosen based on the type of the program. */);
3014 Vw32_quote_process_args = Qt;
3015
3016 DEFVAR_LISP ("w32-start-process-show-window",
3017 Vw32_start_process_show_window,
3018 doc: /* When nil, new child processes hide their windows.
3019 When non-nil, they show their window in the method of their choice.
3020 This variable doesn't affect GUI applications, which will never be hidden. */);
3021 Vw32_start_process_show_window = Qnil;
3022
3023 DEFVAR_LISP ("w32-start-process-share-console",
3024 Vw32_start_process_share_console,
3025 doc: /* When nil, new child processes are given a new console.
3026 When non-nil, they share the Emacs console; this has the limitation of
3027 allowing only one DOS subprocess to run at a time (whether started directly
3028 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3029 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3030 otherwise respond to interrupts from Emacs. */);
3031 Vw32_start_process_share_console = Qnil;
3032
3033 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3034 Vw32_start_process_inherit_error_mode,
3035 doc: /* When nil, new child processes revert to the default error mode.
3036 When non-nil, they inherit their error mode setting from Emacs, which stops
3037 them blocking when trying to access unmounted drives etc. */);
3038 Vw32_start_process_inherit_error_mode = Qt;
3039
3040 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3041 doc: /* Forced delay before reading subprocess output.
3042 This is done to improve the buffering of subprocess output, by
3043 avoiding the inefficiency of frequently reading small amounts of data.
3044
3045 If positive, the value is the number of milliseconds to sleep before
3046 reading the subprocess output. If negative, the magnitude is the number
3047 of time slices to wait (effectively boosting the priority of the child
3048 process temporarily). A value of zero disables waiting entirely. */);
3049 w32_pipe_read_delay = 50;
3050
3051 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3052 doc: /* Non-nil means convert all-upper case file names to lower case.
3053 This applies when performing completions and file name expansion.
3054 Note that the value of this setting also affects remote file names,
3055 so you probably don't want to set to non-nil if you use case-sensitive
3056 filesystems via ange-ftp. */);
3057 Vw32_downcase_file_names = Qnil;
3058
3059 #if 0
3060 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3061 doc: /* Non-nil means attempt to fake realistic inode values.
3062 This works by hashing the truename of files, and should detect
3063 aliasing between long and short (8.3 DOS) names, but can have
3064 false positives because of hash collisions. Note that determining
3065 the truename of a file can be slow. */);
3066 Vw32_generate_fake_inodes = Qnil;
3067 #endif
3068
3069 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3070 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3071 This option controls whether to issue additional system calls to determine
3072 accurate link counts, file type, and ownership information. It is more
3073 useful for files on NTFS volumes, where hard links and file security are
3074 supported, than on volumes of the FAT family.
3075
3076 Without these system calls, link count will always be reported as 1 and file
3077 ownership will be attributed to the current user.
3078 The default value `local' means only issue these system calls for files
3079 on local fixed drives. A value of nil means never issue them.
3080 Any other non-nil value means do this even on remote and removable drives
3081 where the performance impact may be noticeable even on modern hardware. */);
3082 Vw32_get_true_file_attributes = Qlocal;
3083
3084 staticpro (&Vw32_valid_locale_ids);
3085 staticpro (&Vw32_valid_codepages);
3086 }
3087 /* end of w32proc.c */