* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Use mode function
[emacs.git] / src / w32proc.c
blob0b441d45186fd97d379dcfbf6c43b4a83b4b35f1
1 /* Process support for GNU Emacs on the Microsoft Windows API.
3 Copyright (C) 1992, 1995, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 Drew Bliss Oct 14, 1993
22 Adapted from alarm.c by Tim Fleehart
25 #include <mingw_time.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <errno.h>
29 #include <ctype.h>
30 #include <io.h>
31 #include <fcntl.h>
32 #include <signal.h>
33 #include <sys/file.h>
34 #include <mbstring.h>
35 #include <locale.h>
37 /* must include CRT headers *before* config.h */
38 #include <config.h>
40 #undef signal
41 #undef wait
42 #undef spawnve
43 #undef select
44 #undef kill
46 #include <windows.h>
47 #if defined(__GNUC__) && !defined(__MINGW64__)
48 /* This definition is missing from mingw.org headers, but not MinGW64
49 headers. */
50 extern BOOL WINAPI IsValidLocale (LCID, DWORD);
51 #endif
53 #ifdef HAVE_LANGINFO_CODESET
54 #include <nl_types.h>
55 #include <langinfo.h>
56 #endif
58 #include "lisp.h"
59 #include "w32.h"
60 #include "w32common.h"
61 #include "w32heap.h"
62 #include "systime.h"
63 #include "syswait.h"
64 #include "process.h"
65 #include "syssignal.h"
66 #include "w32term.h"
67 #include "dispextern.h" /* for xstrcasecmp */
68 #include "coding.h"
70 #define RVA_TO_PTR(var,section,filedata) \
71 ((void *)((section)->PointerToRawData \
72 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
73 + (filedata).file_base))
75 Lisp_Object Qhigh, Qlow;
77 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
78 static signal_handler sig_handlers[NSIG];
80 static sigset_t sig_mask;
82 static CRITICAL_SECTION crit_sig;
84 /* Improve on the CRT 'signal' implementation so that we could record
85 the SIGCHLD handler and fake interval timers. */
86 signal_handler
87 sys_signal (int sig, signal_handler handler)
89 signal_handler old;
91 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
92 below. SIGALRM and SIGPROF are used by setitimer. All the
93 others are the only ones supported by the MS runtime. */
94 if (!(sig == SIGCHLD || sig == SIGSEGV || sig == SIGILL
95 || sig == SIGFPE || sig == SIGABRT || sig == SIGTERM
96 || sig == SIGALRM || sig == SIGPROF))
98 errno = EINVAL;
99 return SIG_ERR;
101 old = sig_handlers[sig];
102 /* SIGABRT is treated specially because w32.c installs term_ntproc
103 as its handler, so we don't want to override that afterwards.
104 Aborting Emacs works specially anyway: either by calling
105 emacs_abort directly or through terminate_due_to_signal, which
106 calls emacs_abort through emacs_raise. */
107 if (!(sig == SIGABRT && old == term_ntproc))
109 sig_handlers[sig] = handler;
110 if (!(sig == SIGCHLD || sig == SIGALRM || sig == SIGPROF))
111 signal (sig, handler);
113 return old;
116 /* Emulate sigaction. */
118 sigaction (int sig, const struct sigaction *act, struct sigaction *oact)
120 signal_handler old = SIG_DFL;
121 int retval = 0;
123 if (act)
124 old = sys_signal (sig, act->sa_handler);
125 else if (oact)
126 old = sig_handlers[sig];
128 if (old == SIG_ERR)
130 errno = EINVAL;
131 retval = -1;
133 if (oact)
135 oact->sa_handler = old;
136 oact->sa_flags = 0;
137 oact->sa_mask = empty_mask;
139 return retval;
142 /* Emulate signal sets and blocking of signals used by timers. */
145 sigemptyset (sigset_t *set)
147 *set = 0;
148 return 0;
152 sigaddset (sigset_t *set, int signo)
154 if (!set)
156 errno = EINVAL;
157 return -1;
159 if (signo < 0 || signo >= NSIG)
161 errno = EINVAL;
162 return -1;
165 *set |= (1U << signo);
167 return 0;
171 sigfillset (sigset_t *set)
173 if (!set)
175 errno = EINVAL;
176 return -1;
179 *set = 0xFFFFFFFF;
180 return 0;
184 sigprocmask (int how, const sigset_t *set, sigset_t *oset)
186 if (!(how == SIG_BLOCK || how == SIG_UNBLOCK || how == SIG_SETMASK))
188 errno = EINVAL;
189 return -1;
192 if (oset)
193 *oset = sig_mask;
195 if (!set)
196 return 0;
198 switch (how)
200 case SIG_BLOCK:
201 sig_mask |= *set;
202 break;
203 case SIG_SETMASK:
204 sig_mask = *set;
205 break;
206 case SIG_UNBLOCK:
207 /* FIXME: Catch signals that are blocked and reissue them when
208 they are unblocked. Important for SIGALRM and SIGPROF only. */
209 sig_mask &= ~(*set);
210 break;
213 return 0;
217 pthread_sigmask (int how, const sigset_t *set, sigset_t *oset)
219 if (sigprocmask (how, set, oset) == -1)
220 return EINVAL;
221 return 0;
225 sigismember (const sigset_t *set, int signo)
227 if (signo < 0 || signo >= NSIG)
229 errno = EINVAL;
230 return -1;
232 if (signo > sizeof (*set) * BITS_PER_CHAR)
233 emacs_abort ();
235 return (*set & (1U << signo)) != 0;
238 pid_t
239 getpgrp (void)
241 return getpid ();
244 pid_t
245 tcgetpgrp (int fd)
247 return getpid ();
251 setpgid (pid_t pid, pid_t pgid)
253 return 0;
256 pid_t
257 setsid (void)
259 return getpid ();
262 /* Emulations of interval timers.
264 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
266 Implementation: a separate thread is started for each timer type,
267 the thread calls the appropriate signal handler when the timer
268 expires, after stopping the thread which installed the timer. */
270 struct itimer_data {
271 volatile ULONGLONG expire;
272 volatile ULONGLONG reload;
273 volatile int terminate;
274 int type;
275 HANDLE caller_thread;
276 HANDLE timer_thread;
279 static ULONGLONG ticks_now;
280 static struct itimer_data real_itimer, prof_itimer;
281 static ULONGLONG clocks_min;
282 /* If non-zero, itimers are disabled. Used during shutdown, when we
283 delete the critical sections used by the timer threads. */
284 static int disable_itimers;
286 static CRITICAL_SECTION crit_real, crit_prof;
288 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
289 typedef BOOL (WINAPI *GetThreadTimes_Proc) (
290 HANDLE hThread,
291 LPFILETIME lpCreationTime,
292 LPFILETIME lpExitTime,
293 LPFILETIME lpKernelTime,
294 LPFILETIME lpUserTime);
296 static GetThreadTimes_Proc s_pfn_Get_Thread_Times;
298 #define MAX_SINGLE_SLEEP 30
299 #define TIMER_TICKS_PER_SEC 1000
301 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
302 to a thread. If THREAD is NULL or an invalid handle, return the
303 current wall-clock time since January 1, 1601 (UTC). Otherwise,
304 return the sum of kernel and user times used by THREAD since it was
305 created, plus its creation time. */
306 static ULONGLONG
307 w32_get_timer_time (HANDLE thread)
309 ULONGLONG retval;
310 int use_system_time = 1;
311 /* The functions below return times in 100-ns units. */
312 const int tscale = 10 * TIMER_TICKS_PER_SEC;
314 if (thread && thread != INVALID_HANDLE_VALUE
315 && s_pfn_Get_Thread_Times != NULL)
317 FILETIME creation_ftime, exit_ftime, kernel_ftime, user_ftime;
318 ULARGE_INTEGER temp_creation, temp_kernel, temp_user;
320 if (s_pfn_Get_Thread_Times (thread, &creation_ftime, &exit_ftime,
321 &kernel_ftime, &user_ftime))
323 use_system_time = 0;
324 temp_creation.LowPart = creation_ftime.dwLowDateTime;
325 temp_creation.HighPart = creation_ftime.dwHighDateTime;
326 temp_kernel.LowPart = kernel_ftime.dwLowDateTime;
327 temp_kernel.HighPart = kernel_ftime.dwHighDateTime;
328 temp_user.LowPart = user_ftime.dwLowDateTime;
329 temp_user.HighPart = user_ftime.dwHighDateTime;
330 retval =
331 temp_creation.QuadPart / tscale + temp_kernel.QuadPart / tscale
332 + temp_user.QuadPart / tscale;
334 else
335 DebPrint (("GetThreadTimes failed with error code %lu\n",
336 GetLastError ()));
339 if (use_system_time)
341 FILETIME current_ftime;
342 ULARGE_INTEGER temp;
344 GetSystemTimeAsFileTime (&current_ftime);
346 temp.LowPart = current_ftime.dwLowDateTime;
347 temp.HighPart = current_ftime.dwHighDateTime;
349 retval = temp.QuadPart / tscale;
352 return retval;
355 /* Thread function for a timer thread. */
356 static DWORD WINAPI
357 timer_loop (LPVOID arg)
359 struct itimer_data *itimer = (struct itimer_data *)arg;
360 int which = itimer->type;
361 int sig = (which == ITIMER_REAL) ? SIGALRM : SIGPROF;
362 CRITICAL_SECTION *crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
363 const DWORD max_sleep = MAX_SINGLE_SLEEP * 1000 / TIMER_TICKS_PER_SEC;
364 HANDLE hth = (which == ITIMER_REAL) ? NULL : itimer->caller_thread;
366 while (1)
368 DWORD sleep_time;
369 signal_handler handler;
370 ULONGLONG now, expire, reload;
372 /* Load new values if requested by setitimer. */
373 EnterCriticalSection (crit);
374 expire = itimer->expire;
375 reload = itimer->reload;
376 LeaveCriticalSection (crit);
377 if (itimer->terminate)
378 return 0;
380 if (expire == 0)
382 /* We are idle. */
383 Sleep (max_sleep);
384 continue;
387 if (expire > (now = w32_get_timer_time (hth)))
388 sleep_time = expire - now;
389 else
390 sleep_time = 0;
391 /* Don't sleep too long at a time, to be able to see the
392 termination flag without too long a delay. */
393 while (sleep_time > max_sleep)
395 if (itimer->terminate)
396 return 0;
397 Sleep (max_sleep);
398 EnterCriticalSection (crit);
399 expire = itimer->expire;
400 LeaveCriticalSection (crit);
401 sleep_time =
402 (expire > (now = w32_get_timer_time (hth))) ? expire - now : 0;
404 if (itimer->terminate)
405 return 0;
406 if (sleep_time > 0)
408 Sleep (sleep_time * 1000 / TIMER_TICKS_PER_SEC);
409 /* Always sleep past the expiration time, to make sure we
410 never call the handler _before_ the expiration time,
411 always slightly after it. Sleep(5) makes sure we don't
412 hog the CPU by calling 'w32_get_timer_time' with high
413 frequency, and also let other threads work. */
414 while (w32_get_timer_time (hth) < expire)
415 Sleep (5);
418 EnterCriticalSection (crit);
419 expire = itimer->expire;
420 LeaveCriticalSection (crit);
421 if (expire == 0)
422 continue;
424 /* Time's up. */
425 handler = sig_handlers[sig];
426 if (!(handler == SIG_DFL || handler == SIG_IGN || handler == SIG_ERR)
427 /* FIXME: Don't ignore masked signals. Instead, record that
428 they happened and reissue them when the signal is
429 unblocked. */
430 && !sigismember (&sig_mask, sig)
431 /* Simulate masking of SIGALRM and SIGPROF when processing
432 fatal signals. */
433 && !fatal_error_in_progress
434 && itimer->caller_thread)
436 /* Simulate a signal delivered to the thread which installed
437 the timer, by suspending that thread while the handler
438 runs. */
439 HANDLE th = itimer->caller_thread;
440 DWORD result = SuspendThread (th);
442 if (result == (DWORD)-1)
443 return 2;
445 handler (sig);
446 ResumeThread (th);
449 /* Update expiration time and loop. */
450 EnterCriticalSection (crit);
451 expire = itimer->expire;
452 if (expire == 0)
454 LeaveCriticalSection (crit);
455 continue;
457 reload = itimer->reload;
458 if (reload > 0)
460 now = w32_get_timer_time (hth);
461 if (expire <= now)
463 ULONGLONG lag = now - expire;
465 /* If we missed some opportunities (presumably while
466 sleeping or while the signal handler ran), skip
467 them. */
468 if (lag > reload)
469 expire = now - (lag % reload);
471 expire += reload;
474 else
475 expire = 0; /* become idle */
476 itimer->expire = expire;
477 LeaveCriticalSection (crit);
479 return 0;
482 static void
483 stop_timer_thread (int which)
485 struct itimer_data *itimer =
486 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
487 int i;
488 DWORD err, exit_code = 255;
489 BOOL status;
491 /* Signal the thread that it should terminate. */
492 itimer->terminate = 1;
494 if (itimer->timer_thread == NULL)
495 return;
497 /* Wait for the timer thread to terminate voluntarily, then kill it
498 if it doesn't. This loop waits twice more than the maximum
499 amount of time a timer thread sleeps, see above. */
500 for (i = 0; i < MAX_SINGLE_SLEEP / 5; i++)
502 if (!((status = GetExitCodeThread (itimer->timer_thread, &exit_code))
503 && exit_code == STILL_ACTIVE))
504 break;
505 Sleep (10);
507 if ((status == FALSE && (err = GetLastError ()) == ERROR_INVALID_HANDLE)
508 || exit_code == STILL_ACTIVE)
510 if (!(status == FALSE && err == ERROR_INVALID_HANDLE))
511 TerminateThread (itimer->timer_thread, 0);
514 /* Clean up. */
515 CloseHandle (itimer->timer_thread);
516 itimer->timer_thread = NULL;
517 if (itimer->caller_thread)
519 CloseHandle (itimer->caller_thread);
520 itimer->caller_thread = NULL;
524 /* This is called at shutdown time from term_ntproc. */
525 void
526 term_timers (void)
528 if (real_itimer.timer_thread)
529 stop_timer_thread (ITIMER_REAL);
530 if (prof_itimer.timer_thread)
531 stop_timer_thread (ITIMER_PROF);
533 /* We are going to delete the critical sections, so timers cannot
534 work after this. */
535 disable_itimers = 1;
537 DeleteCriticalSection (&crit_real);
538 DeleteCriticalSection (&crit_prof);
539 DeleteCriticalSection (&crit_sig);
542 /* This is called at initialization time from init_ntproc. */
543 void
544 init_timers (void)
546 /* GetThreadTimes is not available on all versions of Windows, so
547 need to probe for its availability dynamically, and call it
548 through a pointer. */
549 s_pfn_Get_Thread_Times = NULL; /* in case dumped Emacs comes with a value */
550 if (os_subtype != OS_9X)
551 s_pfn_Get_Thread_Times =
552 (GetThreadTimes_Proc)GetProcAddress (GetModuleHandle ("kernel32.dll"),
553 "GetThreadTimes");
555 /* Make sure we start with zeroed out itimer structures, since
556 dumping may have left there traces of threads long dead. */
557 memset (&real_itimer, 0, sizeof real_itimer);
558 memset (&prof_itimer, 0, sizeof prof_itimer);
560 InitializeCriticalSection (&crit_real);
561 InitializeCriticalSection (&crit_prof);
562 InitializeCriticalSection (&crit_sig);
564 disable_itimers = 0;
567 static int
568 start_timer_thread (int which)
570 DWORD exit_code, tid;
571 HANDLE th;
572 struct itimer_data *itimer =
573 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
575 if (itimer->timer_thread
576 && GetExitCodeThread (itimer->timer_thread, &exit_code)
577 && exit_code == STILL_ACTIVE)
578 return 0;
580 /* Clean up after possibly exited thread. */
581 if (itimer->timer_thread)
583 CloseHandle (itimer->timer_thread);
584 itimer->timer_thread = NULL;
586 if (itimer->caller_thread)
588 CloseHandle (itimer->caller_thread);
589 itimer->caller_thread = NULL;
592 /* Start a new thread. */
593 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
594 GetCurrentProcess (), &th, 0, FALSE,
595 DUPLICATE_SAME_ACCESS))
597 errno = ESRCH;
598 return -1;
600 itimer->terminate = 0;
601 itimer->type = which;
602 itimer->caller_thread = th;
603 /* Request that no more than 64KB of stack be reserved for this
604 thread, to avoid reserving too much memory, which would get in
605 the way of threads we start to wait for subprocesses. See also
606 new_child below. */
607 itimer->timer_thread = CreateThread (NULL, 64 * 1024, timer_loop,
608 (void *)itimer, 0x00010000, &tid);
610 if (!itimer->timer_thread)
612 CloseHandle (itimer->caller_thread);
613 itimer->caller_thread = NULL;
614 errno = EAGAIN;
615 return -1;
618 /* This is needed to make sure that the timer thread running for
619 profiling gets CPU as soon as the Sleep call terminates. */
620 if (which == ITIMER_PROF)
621 SetThreadPriority (itimer->timer_thread, THREAD_PRIORITY_TIME_CRITICAL);
623 return 0;
626 /* Most of the code of getitimer and setitimer (but not of their
627 subroutines) was shamelessly stolen from itimer.c in the DJGPP
628 library, see www.delorie.com/djgpp. */
630 getitimer (int which, struct itimerval *value)
632 volatile ULONGLONG *t_expire;
633 volatile ULONGLONG *t_reload;
634 ULONGLONG expire, reload;
635 __int64 usecs;
636 CRITICAL_SECTION *crit;
637 struct itimer_data *itimer;
639 if (disable_itimers)
640 return -1;
642 if (!value)
644 errno = EFAULT;
645 return -1;
648 if (which != ITIMER_REAL && which != ITIMER_PROF)
650 errno = EINVAL;
651 return -1;
654 itimer = (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
656 ticks_now = w32_get_timer_time ((which == ITIMER_REAL)
657 ? NULL
658 : GetCurrentThread ());
660 t_expire = &itimer->expire;
661 t_reload = &itimer->reload;
662 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
664 EnterCriticalSection (crit);
665 reload = *t_reload;
666 expire = *t_expire;
667 LeaveCriticalSection (crit);
669 if (expire)
670 expire -= ticks_now;
672 value->it_value.tv_sec = expire / TIMER_TICKS_PER_SEC;
673 usecs =
674 (expire % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
675 value->it_value.tv_usec = usecs;
676 value->it_interval.tv_sec = reload / TIMER_TICKS_PER_SEC;
677 usecs =
678 (reload % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
679 value->it_interval.tv_usec= usecs;
681 return 0;
685 setitimer(int which, struct itimerval *value, struct itimerval *ovalue)
687 volatile ULONGLONG *t_expire, *t_reload;
688 ULONGLONG expire, reload, expire_old, reload_old;
689 __int64 usecs;
690 CRITICAL_SECTION *crit;
691 struct itimerval tem, *ptem;
693 if (disable_itimers)
694 return -1;
696 /* Posix systems expect timer values smaller than the resolution of
697 the system clock be rounded up to the clock resolution. First
698 time we are called, measure the clock tick resolution. */
699 if (!clocks_min)
701 ULONGLONG t1, t2;
703 for (t1 = w32_get_timer_time (NULL);
704 (t2 = w32_get_timer_time (NULL)) == t1; )
706 clocks_min = t2 - t1;
709 if (ovalue)
710 ptem = ovalue;
711 else
712 ptem = &tem;
714 if (getitimer (which, ptem)) /* also sets ticks_now */
715 return -1; /* errno already set */
717 t_expire =
718 (which == ITIMER_REAL) ? &real_itimer.expire : &prof_itimer.expire;
719 t_reload =
720 (which == ITIMER_REAL) ? &real_itimer.reload : &prof_itimer.reload;
722 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
724 if (!value
725 || (value->it_value.tv_sec == 0 && value->it_value.tv_usec == 0))
727 EnterCriticalSection (crit);
728 /* Disable the timer. */
729 *t_expire = 0;
730 *t_reload = 0;
731 LeaveCriticalSection (crit);
732 return 0;
735 reload = value->it_interval.tv_sec * TIMER_TICKS_PER_SEC;
737 usecs = value->it_interval.tv_usec;
738 if (value->it_interval.tv_sec == 0
739 && usecs && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
740 reload = clocks_min;
741 else
743 usecs *= TIMER_TICKS_PER_SEC;
744 reload += usecs / 1000000;
747 expire = value->it_value.tv_sec * TIMER_TICKS_PER_SEC;
748 usecs = value->it_value.tv_usec;
749 if (value->it_value.tv_sec == 0
750 && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
751 expire = clocks_min;
752 else
754 usecs *= TIMER_TICKS_PER_SEC;
755 expire += usecs / 1000000;
758 expire += ticks_now;
760 EnterCriticalSection (crit);
761 expire_old = *t_expire;
762 reload_old = *t_reload;
763 if (!(expire == expire_old && reload == reload_old))
765 *t_reload = reload;
766 *t_expire = expire;
768 LeaveCriticalSection (crit);
770 return start_timer_thread (which);
774 alarm (int seconds)
776 #ifdef HAVE_SETITIMER
777 struct itimerval new_values, old_values;
779 new_values.it_value.tv_sec = seconds;
780 new_values.it_value.tv_usec = 0;
781 new_values.it_interval.tv_sec = new_values.it_interval.tv_usec = 0;
783 if (setitimer (ITIMER_REAL, &new_values, &old_values) < 0)
784 return 0;
785 return old_values.it_value.tv_sec;
786 #else
787 return seconds;
788 #endif
791 /* Defined in <process.h> which conflicts with the local copy */
792 #define _P_NOWAIT 1
794 /* Child process management list. */
795 int child_proc_count = 0;
796 child_process child_procs[ MAX_CHILDREN ];
798 static DWORD WINAPI reader_thread (void *arg);
800 /* Find an unused process slot. */
801 child_process *
802 new_child (void)
804 child_process *cp;
805 DWORD id;
807 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
808 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
809 goto Initialize;
810 if (child_proc_count == MAX_CHILDREN)
812 int i = 0;
813 child_process *dead_cp = NULL;
815 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
816 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
817 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
819 DWORD status = 0;
821 if (!GetExitCodeProcess (cp->procinfo.hProcess, &status))
823 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
824 GetLastError (), cp->procinfo.dwProcessId));
825 status = STILL_ACTIVE;
827 if (status != STILL_ACTIVE
828 || WaitForSingleObject (cp->procinfo.hProcess, 0) == WAIT_OBJECT_0)
830 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
831 cp->procinfo.dwProcessId, cp->fd));
832 CloseHandle (cp->procinfo.hProcess);
833 cp->procinfo.hProcess = NULL;
834 CloseHandle (cp->procinfo.hThread);
835 cp->procinfo.hThread = NULL;
836 /* Free up to 2 dead slots at a time, so that if we
837 have a lot of them, they will eventually all be
838 freed when the tornado ends. */
839 if (i == 0)
840 dead_cp = cp;
841 else
842 break;
843 i++;
846 if (dead_cp)
848 cp = dead_cp;
849 goto Initialize;
852 if (child_proc_count == MAX_CHILDREN)
853 return NULL;
854 cp = &child_procs[child_proc_count++];
856 Initialize:
857 /* Last opportunity to avoid leaking handles before we forget them
858 for good. */
859 if (cp->procinfo.hProcess)
860 CloseHandle (cp->procinfo.hProcess);
861 if (cp->procinfo.hThread)
862 CloseHandle (cp->procinfo.hThread);
863 memset (cp, 0, sizeof (*cp));
864 cp->fd = -1;
865 cp->pid = -1;
866 cp->procinfo.hProcess = NULL;
867 cp->status = STATUS_READ_ERROR;
869 /* use manual reset event so that select() will function properly */
870 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
871 if (cp->char_avail)
873 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
874 if (cp->char_consumed)
876 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
877 It means that the 64K stack we are requesting in the 2nd
878 argument is how much memory should be reserved for the
879 stack. If we don't use this flag, the memory requested
880 by the 2nd argument is the amount actually _committed_,
881 but Windows reserves 8MB of memory for each thread's
882 stack. (The 8MB figure comes from the -stack
883 command-line argument we pass to the linker when building
884 Emacs, but that's because we need a large stack for
885 Emacs's main thread.) Since we request 2GB of reserved
886 memory at startup (see w32heap.c), which is close to the
887 maximum memory available for a 32-bit process on Windows,
888 the 8MB reservation for each thread causes failures in
889 starting subprocesses, because we create a thread running
890 reader_thread for each subprocess. As 8MB of stack is
891 way too much for reader_thread, forcing Windows to
892 reserve less wins the day. */
893 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
894 0x00010000, &id);
895 if (cp->thrd)
896 return cp;
899 delete_child (cp);
900 return NULL;
903 void
904 delete_child (child_process *cp)
906 int i;
908 /* Should not be deleting a child that is still needed. */
909 for (i = 0; i < MAXDESC; i++)
910 if (fd_info[i].cp == cp)
911 emacs_abort ();
913 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
914 return;
916 /* reap thread if necessary */
917 if (cp->thrd)
919 DWORD rc;
921 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
923 /* let the thread exit cleanly if possible */
924 cp->status = STATUS_READ_ERROR;
925 SetEvent (cp->char_consumed);
926 #if 0
927 /* We used to forcibly terminate the thread here, but it
928 is normally unnecessary, and in abnormal cases, the worst that
929 will happen is we have an extra idle thread hanging around
930 waiting for the zombie process. */
931 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
933 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
934 "with %lu for fd %ld\n", GetLastError (), cp->fd));
935 TerminateThread (cp->thrd, 0);
937 #endif
939 CloseHandle (cp->thrd);
940 cp->thrd = NULL;
942 if (cp->char_avail)
944 CloseHandle (cp->char_avail);
945 cp->char_avail = NULL;
947 if (cp->char_consumed)
949 CloseHandle (cp->char_consumed);
950 cp->char_consumed = NULL;
953 /* update child_proc_count (highest numbered slot in use plus one) */
954 if (cp == child_procs + child_proc_count - 1)
956 for (i = child_proc_count-1; i >= 0; i--)
957 if (CHILD_ACTIVE (&child_procs[i])
958 || child_procs[i].procinfo.hProcess != NULL)
960 child_proc_count = i + 1;
961 break;
964 if (i < 0)
965 child_proc_count = 0;
968 /* Find a child by pid. */
969 static child_process *
970 find_child_pid (DWORD pid)
972 child_process *cp;
974 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
975 if ((CHILD_ACTIVE (cp) || cp->procinfo.hProcess != NULL)
976 && pid == cp->pid)
977 return cp;
978 return NULL;
981 void
982 release_listen_threads (void)
984 int i;
986 for (i = child_proc_count - 1; i >= 0; i--)
988 if (CHILD_ACTIVE (&child_procs[i])
989 && (fd_info[child_procs[i].fd].flags & FILE_LISTEN))
990 child_procs[i].status = STATUS_READ_ERROR;
994 /* Thread proc for child process and socket reader threads. Each thread
995 is normally blocked until woken by select() to check for input by
996 reading one char. When the read completes, char_avail is signaled
997 to wake up the select emulator and the thread blocks itself again. */
998 static DWORD WINAPI
999 reader_thread (void *arg)
1001 child_process *cp;
1003 /* Our identity */
1004 cp = (child_process *)arg;
1006 /* We have to wait for the go-ahead before we can start */
1007 if (cp == NULL
1008 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
1009 || cp->fd < 0)
1010 return 1;
1012 for (;;)
1014 int rc;
1016 if (cp->fd >= 0 && fd_info[cp->fd].flags & FILE_LISTEN)
1017 rc = _sys_wait_accept (cp->fd);
1018 else
1019 rc = _sys_read_ahead (cp->fd);
1021 /* Don't bother waiting for the event if we already have been
1022 told to exit by delete_child. */
1023 if (cp->status == STATUS_READ_ERROR || !cp->char_avail)
1024 break;
1026 /* The name char_avail is a misnomer - it really just means the
1027 read-ahead has completed, whether successfully or not. */
1028 if (!SetEvent (cp->char_avail))
1030 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1031 (DWORD_PTR)cp->char_avail, GetLastError (),
1032 cp->fd, cp->pid));
1033 return 1;
1036 if (rc == STATUS_READ_ERROR)
1037 return 1;
1039 /* If the read died, the child has died so let the thread die */
1040 if (rc == STATUS_READ_FAILED)
1041 break;
1043 /* Don't bother waiting for the acknowledge if we already have
1044 been told to exit by delete_child. */
1045 if (cp->status == STATUS_READ_ERROR || !cp->char_consumed)
1046 break;
1048 /* Wait until our input is acknowledged before reading again */
1049 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
1051 DebPrint (("reader_thread.WaitForSingleObject failed with "
1052 "%lu for fd %ld\n", GetLastError (), cp->fd));
1053 break;
1055 /* delete_child sets status to STATUS_READ_ERROR when it wants
1056 us to exit. */
1057 if (cp->status == STATUS_READ_ERROR)
1058 break;
1060 return 0;
1063 /* To avoid Emacs changing directory, we just record here the
1064 directory the new process should start in. This is set just before
1065 calling sys_spawnve, and is not generally valid at any other time.
1066 Note that this directory's name is UTF-8 encoded. */
1067 static char * process_dir;
1069 static BOOL
1070 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
1071 pid_t * pPid, child_process *cp)
1073 STARTUPINFO start;
1074 SECURITY_ATTRIBUTES sec_attrs;
1075 #if 0
1076 SECURITY_DESCRIPTOR sec_desc;
1077 #endif
1078 DWORD flags;
1079 char dir[ MAX_PATH ];
1080 char *p;
1082 if (cp == NULL) emacs_abort ();
1084 memset (&start, 0, sizeof (start));
1085 start.cb = sizeof (start);
1087 #ifdef HAVE_NTGUI
1088 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1089 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1090 else
1091 start.dwFlags = STARTF_USESTDHANDLES;
1092 start.wShowWindow = SW_HIDE;
1094 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1095 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1096 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1097 #endif /* HAVE_NTGUI */
1099 #if 0
1100 /* Explicitly specify no security */
1101 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1102 goto EH_Fail;
1103 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1104 goto EH_Fail;
1105 #endif
1106 sec_attrs.nLength = sizeof (sec_attrs);
1107 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1108 sec_attrs.bInheritHandle = FALSE;
1110 filename_to_ansi (process_dir, dir);
1111 /* Can't use unixtodos_filename here, since that needs its file name
1112 argument encoded in UTF-8. OTOH, process_dir, which _is_ in
1113 UTF-8, points, to the directory computed by our caller, and we
1114 don't want to modify that, either. */
1115 for (p = dir; *p; p = CharNextA (p))
1116 if (*p == '/')
1117 *p = '\\';
1119 flags = (!NILP (Vw32_start_process_share_console)
1120 ? CREATE_NEW_PROCESS_GROUP
1121 : CREATE_NEW_CONSOLE);
1122 if (NILP (Vw32_start_process_inherit_error_mode))
1123 flags |= CREATE_DEFAULT_ERROR_MODE;
1124 if (!CreateProcessA (exe, cmdline, &sec_attrs, NULL, TRUE,
1125 flags, env, dir, &start, &cp->procinfo))
1126 goto EH_Fail;
1128 cp->pid = (int) cp->procinfo.dwProcessId;
1130 /* Hack for Windows 95, which assigns large (ie negative) pids */
1131 if (cp->pid < 0)
1132 cp->pid = -cp->pid;
1134 *pPid = cp->pid;
1136 return TRUE;
1138 EH_Fail:
1139 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1140 return FALSE;
1143 /* create_child doesn't know what emacs's file handle will be for waiting
1144 on output from the child, so we need to make this additional call
1145 to register the handle with the process
1146 This way the select emulator knows how to match file handles with
1147 entries in child_procs. */
1148 void
1149 register_child (pid_t pid, int fd)
1151 child_process *cp;
1153 cp = find_child_pid ((DWORD)pid);
1154 if (cp == NULL)
1156 DebPrint (("register_child unable to find pid %lu\n", pid));
1157 return;
1160 #ifdef FULL_DEBUG
1161 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1162 #endif
1164 cp->fd = fd;
1166 /* thread is initially blocked until select is called; set status so
1167 that select will release thread */
1168 cp->status = STATUS_READ_ACKNOWLEDGED;
1170 /* attach child_process to fd_info */
1171 if (fd_info[fd].cp != NULL)
1173 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1174 emacs_abort ();
1177 fd_info[fd].cp = cp;
1180 /* Called from waitpid when a process exits. */
1181 static void
1182 reap_subprocess (child_process *cp)
1184 if (cp->procinfo.hProcess)
1186 /* Reap the process */
1187 #ifdef FULL_DEBUG
1188 /* Process should have already died before we are called. */
1189 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1190 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp->fd));
1191 #endif
1192 CloseHandle (cp->procinfo.hProcess);
1193 cp->procinfo.hProcess = NULL;
1194 CloseHandle (cp->procinfo.hThread);
1195 cp->procinfo.hThread = NULL;
1198 /* If cp->fd was not closed yet, we might be still reading the
1199 process output, so don't free its resources just yet. The call
1200 to delete_child on behalf of this subprocess will be made by
1201 sys_read when the subprocess output is fully read. */
1202 if (cp->fd < 0)
1203 delete_child (cp);
1206 /* Wait for a child process specified by PID, or for any of our
1207 existing child processes (if PID is nonpositive) to die. When it
1208 does, close its handle. Return the pid of the process that died
1209 and fill in STATUS if non-NULL. */
1211 pid_t
1212 waitpid (pid_t pid, int *status, int options)
1214 DWORD active, retval;
1215 int nh;
1216 child_process *cp, *cps[MAX_CHILDREN];
1217 HANDLE wait_hnd[MAX_CHILDREN];
1218 DWORD timeout_ms;
1219 int dont_wait = (options & WNOHANG) != 0;
1221 nh = 0;
1222 /* According to Posix:
1224 PID = -1 means status is requested for any child process.
1226 PID > 0 means status is requested for a single child process
1227 whose pid is PID.
1229 PID = 0 means status is requested for any child process whose
1230 process group ID is equal to that of the calling process. But
1231 since Windows has only a limited support for process groups (only
1232 for console processes and only for the purposes of passing
1233 Ctrl-BREAK signal to them), and since we have no documented way
1234 of determining whether a given process belongs to our group, we
1235 treat 0 as -1.
1237 PID < -1 means status is requested for any child process whose
1238 process group ID is equal to the absolute value of PID. Again,
1239 since we don't support process groups, we treat that as -1. */
1240 if (pid > 0)
1242 int our_child = 0;
1244 /* We are requested to wait for a specific child. */
1245 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1247 /* Some child_procs might be sockets; ignore them. Also
1248 ignore subprocesses whose output is not yet completely
1249 read. */
1250 if (CHILD_ACTIVE (cp)
1251 && cp->procinfo.hProcess
1252 && cp->pid == pid)
1254 our_child = 1;
1255 break;
1258 if (our_child)
1260 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1262 wait_hnd[nh] = cp->procinfo.hProcess;
1263 cps[nh] = cp;
1264 nh++;
1266 else if (dont_wait)
1268 /* PID specifies our subprocess, but its status is not
1269 yet available. */
1270 return 0;
1273 if (nh == 0)
1275 /* No such child process, or nothing to wait for, so fail. */
1276 errno = ECHILD;
1277 return -1;
1280 else
1282 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1284 if (CHILD_ACTIVE (cp)
1285 && cp->procinfo.hProcess
1286 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1288 wait_hnd[nh] = cp->procinfo.hProcess;
1289 cps[nh] = cp;
1290 nh++;
1293 if (nh == 0)
1295 /* Nothing to wait on, so fail. */
1296 errno = ECHILD;
1297 return -1;
1301 if (dont_wait)
1302 timeout_ms = 0;
1303 else
1304 timeout_ms = 1000; /* check for quit about once a second. */
1308 QUIT;
1309 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1310 } while (active == WAIT_TIMEOUT && !dont_wait);
1312 if (active == WAIT_FAILED)
1314 errno = EBADF;
1315 return -1;
1317 else if (active == WAIT_TIMEOUT && dont_wait)
1319 /* PID specifies our subprocess, but it didn't exit yet, so its
1320 status is not yet available. */
1321 #ifdef FULL_DEBUG
1322 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1323 #endif
1324 return 0;
1326 else if (active >= WAIT_OBJECT_0
1327 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1329 active -= WAIT_OBJECT_0;
1331 else if (active >= WAIT_ABANDONED_0
1332 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1334 active -= WAIT_ABANDONED_0;
1336 else
1337 emacs_abort ();
1339 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1341 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1342 GetLastError ()));
1343 retval = 1;
1345 if (retval == STILL_ACTIVE)
1347 /* Should never happen. */
1348 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1349 if (pid > 0 && dont_wait)
1350 return 0;
1351 errno = EINVAL;
1352 return -1;
1355 /* Massage the exit code from the process to match the format expected
1356 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1357 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1359 if (retval == STATUS_CONTROL_C_EXIT)
1360 retval = SIGINT;
1361 else
1362 retval <<= 8;
1364 if (pid > 0 && active != 0)
1365 emacs_abort ();
1366 cp = cps[active];
1367 pid = cp->pid;
1368 #ifdef FULL_DEBUG
1369 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1370 #endif
1372 if (status)
1373 *status = retval;
1374 reap_subprocess (cp);
1376 return pid;
1379 /* Old versions of w32api headers don't have separate 32-bit and
1380 64-bit defines, but the one they have matches the 32-bit variety. */
1381 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1382 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1383 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1384 #endif
1386 /* Implementation note: This function works with file names encoded in
1387 the current ANSI codepage. */
1388 static void
1389 w32_executable_type (char * filename,
1390 int * is_dos_app,
1391 int * is_cygnus_app,
1392 int * is_gui_app)
1394 file_data executable;
1395 char * p;
1397 /* Default values in case we can't tell for sure. */
1398 *is_dos_app = FALSE;
1399 *is_cygnus_app = FALSE;
1400 *is_gui_app = FALSE;
1402 if (!open_input_file (&executable, filename))
1403 return;
1405 p = strrchr (filename, '.');
1407 /* We can only identify DOS .com programs from the extension. */
1408 if (p && xstrcasecmp (p, ".com") == 0)
1409 *is_dos_app = TRUE;
1410 else if (p && (xstrcasecmp (p, ".bat") == 0
1411 || xstrcasecmp (p, ".cmd") == 0))
1413 /* A DOS shell script - it appears that CreateProcess is happy to
1414 accept this (somewhat surprisingly); presumably it looks at
1415 COMSPEC to determine what executable to actually invoke.
1416 Therefore, we have to do the same here as well. */
1417 /* Actually, I think it uses the program association for that
1418 extension, which is defined in the registry. */
1419 p = egetenv ("COMSPEC");
1420 if (p)
1421 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1423 else
1425 /* Look for DOS .exe signature - if found, we must also check that
1426 it isn't really a 16- or 32-bit Windows exe, since both formats
1427 start with a DOS program stub. Note that 16-bit Windows
1428 executables use the OS/2 1.x format. */
1430 IMAGE_DOS_HEADER * dos_header;
1431 IMAGE_NT_HEADERS * nt_header;
1433 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1434 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1435 goto unwind;
1437 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1439 if ((char *) nt_header > (char *) dos_header + executable.size)
1441 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1442 *is_dos_app = TRUE;
1444 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1445 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1447 *is_dos_app = TRUE;
1449 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1451 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1452 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1454 /* Ensure we are using the 32 bit structure. */
1455 IMAGE_OPTIONAL_HEADER32 *opt
1456 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1457 data_dir = opt->DataDirectory;
1458 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1460 /* MingW 3.12 has the required 64 bit structs, but in case older
1461 versions don't, only check 64 bit exes if we know how. */
1462 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1463 else if (nt_header->OptionalHeader.Magic
1464 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1466 IMAGE_OPTIONAL_HEADER64 *opt
1467 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1468 data_dir = opt->DataDirectory;
1469 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1471 #endif
1472 if (data_dir)
1474 /* Look for cygwin.dll in DLL import list. */
1475 IMAGE_DATA_DIRECTORY import_dir =
1476 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1477 IMAGE_IMPORT_DESCRIPTOR * imports;
1478 IMAGE_SECTION_HEADER * section;
1480 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1481 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1482 executable);
1484 for ( ; imports->Name; imports++)
1486 char * dllname = RVA_TO_PTR (imports->Name, section,
1487 executable);
1489 /* The exact name of the cygwin dll has changed with
1490 various releases, but hopefully this will be reasonably
1491 future proof. */
1492 if (strncmp (dllname, "cygwin", 6) == 0)
1494 *is_cygnus_app = TRUE;
1495 break;
1502 unwind:
1503 close_file_data (&executable);
1506 static int
1507 compare_env (const void *strp1, const void *strp2)
1509 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1511 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1513 /* Sort order in command.com/cmd.exe is based on uppercasing
1514 names, so do the same here. */
1515 if (toupper (*str1) > toupper (*str2))
1516 return 1;
1517 else if (toupper (*str1) < toupper (*str2))
1518 return -1;
1519 str1++, str2++;
1522 if (*str1 == '=' && *str2 == '=')
1523 return 0;
1524 else if (*str1 == '=')
1525 return -1;
1526 else
1527 return 1;
1530 static void
1531 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1533 char **optr, **nptr;
1534 int num;
1536 nptr = new_envp;
1537 optr = envp1;
1538 while (*optr)
1539 *nptr++ = *optr++;
1540 num = optr - envp1;
1542 optr = envp2;
1543 while (*optr)
1544 *nptr++ = *optr++;
1545 num += optr - envp2;
1547 qsort (new_envp, num, sizeof (char *), compare_env);
1549 *nptr = NULL;
1552 /* When a new child process is created we need to register it in our list,
1553 so intercept spawn requests. */
1555 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1557 Lisp_Object program, full;
1558 char *cmdline, *env, *parg, **targ;
1559 int arglen, numenv;
1560 pid_t pid;
1561 child_process *cp;
1562 int is_dos_app, is_cygnus_app, is_gui_app;
1563 int do_quoting = 0;
1564 /* We pass our process ID to our children by setting up an environment
1565 variable in their environment. */
1566 char ppid_env_var_buffer[64];
1567 char *extra_env[] = {ppid_env_var_buffer, NULL};
1568 /* These are the characters that cause an argument to need quoting.
1569 Arguments with whitespace characters need quoting to prevent the
1570 argument being split into two or more. Arguments with wildcards
1571 are also quoted, for consistency with posix platforms, where wildcards
1572 are not expanded if we run the program directly without a shell.
1573 Some extra whitespace characters need quoting in Cygwin programs,
1574 so this list is conditionally modified below. */
1575 char *sepchars = " \t*?";
1576 /* This is for native w32 apps; modified below for Cygwin apps. */
1577 char escape_char = '\\';
1578 char cmdname_a[MAX_PATH];
1580 /* We don't care about the other modes */
1581 if (mode != _P_NOWAIT)
1583 errno = EINVAL;
1584 return -1;
1587 /* Handle executable names without an executable suffix. The caller
1588 already searched exec-path and verified the file is executable,
1589 but start-process doesn't do that for file names that are already
1590 absolute. So we double-check this here, just in case. */
1591 if (faccessat (AT_FDCWD, cmdname, X_OK, AT_EACCESS) != 0)
1593 struct gcpro gcpro1;
1595 program = build_string (cmdname);
1596 full = Qnil;
1597 GCPRO1 (program);
1598 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK), 0);
1599 UNGCPRO;
1600 if (NILP (full))
1602 errno = EINVAL;
1603 return -1;
1605 program = ENCODE_FILE (full);
1606 cmdname = SDATA (program);
1609 /* make sure argv[0] and cmdname are both in DOS format */
1610 unixtodos_filename (cmdname);
1611 /* argv[0] was encoded by caller using ENCODE_FILE, so it is in
1612 UTF-8. All the other arguments are encoded by ENCODE_SYSTEM or
1613 some such, and are in some ANSI codepage. We need to have
1614 argv[0] encoded in ANSI codepage. */
1615 filename_to_ansi (cmdname, cmdname_a);
1616 /* We explicitly require that the command's file name be encodable
1617 in the current ANSI codepage, because we will be invoking it via
1618 the ANSI APIs. */
1619 if (_mbspbrk (cmdname_a, "?"))
1621 errno = ENOENT;
1622 return -1;
1624 /* From here on, CMDNAME is an ANSI-encoded string. */
1625 cmdname = cmdname_a;
1626 argv[0] = cmdname;
1628 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1629 executable that is implicitly linked to the Cygnus dll (implying it
1630 was compiled with the Cygnus GNU toolchain and hence relies on
1631 cygwin.dll to parse the command line - we use this to decide how to
1632 escape quote chars in command line args that must be quoted).
1634 Also determine whether it is a GUI app, so that we don't hide its
1635 initial window unless specifically requested. */
1636 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1638 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1639 application to start it by specifying the helper app as cmdname,
1640 while leaving the real app name as argv[0]. */
1641 if (is_dos_app)
1643 char *p;
1645 cmdname = alloca (MAX_PATH);
1646 if (egetenv ("CMDPROXY"))
1647 strcpy (cmdname, egetenv ("CMDPROXY"));
1648 else
1650 strcpy (cmdname, SDATA (Vinvocation_directory));
1651 strcat (cmdname, "cmdproxy.exe");
1654 /* Can't use unixtodos_filename here, since that needs its file
1655 name argument encoded in UTF-8. */
1656 for (p = cmdname; *p; p = CharNextA (p))
1657 if (*p == '/')
1658 *p = '\\';
1661 /* we have to do some conjuring here to put argv and envp into the
1662 form CreateProcess wants... argv needs to be a space separated/null
1663 terminated list of parameters, and envp is a null
1664 separated/double-null terminated list of parameters.
1666 Additionally, zero-length args and args containing whitespace or
1667 quote chars need to be wrapped in double quotes - for this to work,
1668 embedded quotes need to be escaped as well. The aim is to ensure
1669 the child process reconstructs the argv array we start with
1670 exactly, so we treat quotes at the beginning and end of arguments
1671 as embedded quotes.
1673 The w32 GNU-based library from Cygnus doubles quotes to escape
1674 them, while MSVC uses backslash for escaping. (Actually the MSVC
1675 startup code does attempt to recognize doubled quotes and accept
1676 them, but gets it wrong and ends up requiring three quotes to get a
1677 single embedded quote!) So by default we decide whether to use
1678 quote or backslash as the escape character based on whether the
1679 binary is apparently a Cygnus compiled app.
1681 Note that using backslash to escape embedded quotes requires
1682 additional special handling if an embedded quote is already
1683 preceded by backslash, or if an arg requiring quoting ends with
1684 backslash. In such cases, the run of escape characters needs to be
1685 doubled. For consistency, we apply this special handling as long
1686 as the escape character is not quote.
1688 Since we have no idea how large argv and envp are likely to be we
1689 figure out list lengths on the fly and allocate them. */
1691 if (!NILP (Vw32_quote_process_args))
1693 do_quoting = 1;
1694 /* Override escape char by binding w32-quote-process-args to
1695 desired character, or use t for auto-selection. */
1696 if (INTEGERP (Vw32_quote_process_args))
1697 escape_char = XINT (Vw32_quote_process_args);
1698 else
1699 escape_char = is_cygnus_app ? '"' : '\\';
1702 /* Cygwin apps needs quoting a bit more often. */
1703 if (escape_char == '"')
1704 sepchars = "\r\n\t\f '";
1706 /* do argv... */
1707 arglen = 0;
1708 targ = argv;
1709 while (*targ)
1711 char * p = *targ;
1712 int need_quotes = 0;
1713 int escape_char_run = 0;
1715 if (*p == 0)
1716 need_quotes = 1;
1717 for ( ; *p; p++)
1719 if (escape_char == '"' && *p == '\\')
1720 /* If it's a Cygwin app, \ needs to be escaped. */
1721 arglen++;
1722 else if (*p == '"')
1724 /* allow for embedded quotes to be escaped */
1725 arglen++;
1726 need_quotes = 1;
1727 /* handle the case where the embedded quote is already escaped */
1728 if (escape_char_run > 0)
1730 /* To preserve the arg exactly, we need to double the
1731 preceding escape characters (plus adding one to
1732 escape the quote character itself). */
1733 arglen += escape_char_run;
1736 else if (strchr (sepchars, *p) != NULL)
1738 need_quotes = 1;
1741 if (*p == escape_char && escape_char != '"')
1742 escape_char_run++;
1743 else
1744 escape_char_run = 0;
1746 if (need_quotes)
1748 arglen += 2;
1749 /* handle the case where the arg ends with an escape char - we
1750 must not let the enclosing quote be escaped. */
1751 if (escape_char_run > 0)
1752 arglen += escape_char_run;
1754 arglen += strlen (*targ++) + 1;
1756 cmdline = alloca (arglen);
1757 targ = argv;
1758 parg = cmdline;
1759 while (*targ)
1761 char * p = *targ;
1762 int need_quotes = 0;
1764 if (*p == 0)
1765 need_quotes = 1;
1767 if (do_quoting)
1769 for ( ; *p; p++)
1770 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1771 need_quotes = 1;
1773 if (need_quotes)
1775 int escape_char_run = 0;
1776 /* char * first; */
1777 /* char * last; */
1779 p = *targ;
1780 /* first = p; */
1781 /* last = p + strlen (p) - 1; */
1782 *parg++ = '"';
1783 #if 0
1784 /* This version does not escape quotes if they occur at the
1785 beginning or end of the arg - this could lead to incorrect
1786 behavior when the arg itself represents a command line
1787 containing quoted args. I believe this was originally done
1788 as a hack to make some things work, before
1789 `w32-quote-process-args' was added. */
1790 while (*p)
1792 if (*p == '"' && p > first && p < last)
1793 *parg++ = escape_char; /* escape embedded quotes */
1794 *parg++ = *p++;
1796 #else
1797 for ( ; *p; p++)
1799 if (*p == '"')
1801 /* double preceding escape chars if any */
1802 while (escape_char_run > 0)
1804 *parg++ = escape_char;
1805 escape_char_run--;
1807 /* escape all quote chars, even at beginning or end */
1808 *parg++ = escape_char;
1810 else if (escape_char == '"' && *p == '\\')
1811 *parg++ = '\\';
1812 *parg++ = *p;
1814 if (*p == escape_char && escape_char != '"')
1815 escape_char_run++;
1816 else
1817 escape_char_run = 0;
1819 /* double escape chars before enclosing quote */
1820 while (escape_char_run > 0)
1822 *parg++ = escape_char;
1823 escape_char_run--;
1825 #endif
1826 *parg++ = '"';
1828 else
1830 strcpy (parg, *targ);
1831 parg += strlen (*targ);
1833 *parg++ = ' ';
1834 targ++;
1836 *--parg = '\0';
1838 /* and envp... */
1839 arglen = 1;
1840 targ = envp;
1841 numenv = 1; /* for end null */
1842 while (*targ)
1844 arglen += strlen (*targ++) + 1;
1845 numenv++;
1847 /* extra env vars... */
1848 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1849 GetCurrentProcessId ());
1850 arglen += strlen (ppid_env_var_buffer) + 1;
1851 numenv++;
1853 /* merge env passed in and extra env into one, and sort it. */
1854 targ = (char **) alloca (numenv * sizeof (char *));
1855 merge_and_sort_env (envp, extra_env, targ);
1857 /* concatenate env entries. */
1858 env = alloca (arglen);
1859 parg = env;
1860 while (*targ)
1862 strcpy (parg, *targ);
1863 parg += strlen (*targ++);
1864 *parg++ = '\0';
1866 *parg++ = '\0';
1867 *parg = '\0';
1869 cp = new_child ();
1870 if (cp == NULL)
1872 errno = EAGAIN;
1873 return -1;
1876 /* Now create the process. */
1877 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1879 delete_child (cp);
1880 errno = ENOEXEC;
1881 return -1;
1884 return pid;
1887 /* Emulate the select call
1888 Wait for available input on any of the given rfds, or timeout if
1889 a timeout is given and no input is detected
1890 wfds and efds are not supported and must be NULL.
1892 For simplicity, we detect the death of child processes here and
1893 synchronously call the SIGCHLD handler. Since it is possible for
1894 children to be created without a corresponding pipe handle from which
1895 to read output, we wait separately on the process handles as well as
1896 the char_avail events for each process pipe. We only call
1897 wait/reap_process when the process actually terminates.
1899 To reduce the number of places in which Emacs can be hung such that
1900 C-g is not able to interrupt it, we always wait on interrupt_handle
1901 (which is signaled by the input thread when C-g is detected). If we
1902 detect that we were woken up by C-g, we return -1 with errno set to
1903 EINTR as on Unix. */
1905 /* From w32console.c */
1906 extern HANDLE keyboard_handle;
1908 /* From w32xfns.c */
1909 extern HANDLE interrupt_handle;
1911 /* From process.c */
1912 extern int proc_buffered_char[];
1915 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1916 struct timespec *timeout, void *ignored)
1918 SELECT_TYPE orfds;
1919 DWORD timeout_ms, start_time;
1920 int i, nh, nc, nr;
1921 DWORD active;
1922 child_process *cp, *cps[MAX_CHILDREN];
1923 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1924 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1926 timeout_ms =
1927 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1929 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1930 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1932 Sleep (timeout_ms);
1933 return 0;
1936 /* Otherwise, we only handle rfds, so fail otherwise. */
1937 if (rfds == NULL || wfds != NULL || efds != NULL)
1939 errno = EINVAL;
1940 return -1;
1943 orfds = *rfds;
1944 FD_ZERO (rfds);
1945 nr = 0;
1947 /* If interrupt_handle is available and valid, always wait on it, to
1948 detect C-g (quit). */
1949 nh = 0;
1950 if (interrupt_handle && interrupt_handle != INVALID_HANDLE_VALUE)
1952 wait_hnd[0] = interrupt_handle;
1953 fdindex[0] = -1;
1954 nh++;
1957 /* Build a list of pipe handles to wait on. */
1958 for (i = 0; i < nfds; i++)
1959 if (FD_ISSET (i, &orfds))
1961 if (i == 0)
1963 if (keyboard_handle)
1965 /* Handle stdin specially */
1966 wait_hnd[nh] = keyboard_handle;
1967 fdindex[nh] = i;
1968 nh++;
1971 /* Check for any emacs-generated input in the queue since
1972 it won't be detected in the wait */
1973 if (detect_input_pending ())
1975 FD_SET (i, rfds);
1976 return 1;
1978 else if (noninteractive)
1980 if (handle_file_notifications (NULL))
1981 return 1;
1984 else
1986 /* Child process and socket/comm port input. */
1987 cp = fd_info[i].cp;
1988 if (cp)
1990 int current_status = cp->status;
1992 if (current_status == STATUS_READ_ACKNOWLEDGED)
1994 /* Tell reader thread which file handle to use. */
1995 cp->fd = i;
1996 /* Wake up the reader thread for this process */
1997 cp->status = STATUS_READ_READY;
1998 if (!SetEvent (cp->char_consumed))
1999 DebPrint (("sys_select.SetEvent failed with "
2000 "%lu for fd %ld\n", GetLastError (), i));
2003 #ifdef CHECK_INTERLOCK
2004 /* slightly crude cross-checking of interlock between threads */
2006 current_status = cp->status;
2007 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
2009 /* char_avail has been signaled, so status (which may
2010 have changed) should indicate read has completed
2011 but has not been acknowledged. */
2012 current_status = cp->status;
2013 if (current_status != STATUS_READ_SUCCEEDED
2014 && current_status != STATUS_READ_FAILED)
2015 DebPrint (("char_avail set, but read not completed: status %d\n",
2016 current_status));
2018 else
2020 /* char_avail has not been signaled, so status should
2021 indicate that read is in progress; small possibility
2022 that read has completed but event wasn't yet signaled
2023 when we tested it (because a context switch occurred
2024 or if running on separate CPUs). */
2025 if (current_status != STATUS_READ_READY
2026 && current_status != STATUS_READ_IN_PROGRESS
2027 && current_status != STATUS_READ_SUCCEEDED
2028 && current_status != STATUS_READ_FAILED)
2029 DebPrint (("char_avail reset, but read status is bad: %d\n",
2030 current_status));
2032 #endif
2033 wait_hnd[nh] = cp->char_avail;
2034 fdindex[nh] = i;
2035 if (!wait_hnd[nh]) emacs_abort ();
2036 nh++;
2037 #ifdef FULL_DEBUG
2038 DebPrint (("select waiting on child %d fd %d\n",
2039 cp-child_procs, i));
2040 #endif
2042 else
2044 /* Unable to find something to wait on for this fd, skip */
2046 /* Note that this is not a fatal error, and can in fact
2047 happen in unusual circumstances. Specifically, if
2048 sys_spawnve fails, eg. because the program doesn't
2049 exist, and debug-on-error is t so Fsignal invokes a
2050 nested input loop, then the process output pipe is
2051 still included in input_wait_mask with no child_proc
2052 associated with it. (It is removed when the debugger
2053 exits the nested input loop and the error is thrown.) */
2055 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
2060 count_children:
2061 /* Add handles of child processes. */
2062 nc = 0;
2063 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
2064 /* Some child_procs might be sockets; ignore them. Also some
2065 children may have died already, but we haven't finished reading
2066 the process output; ignore them too. */
2067 if ((CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
2068 && (cp->fd < 0
2069 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
2070 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
2073 wait_hnd[nh + nc] = cp->procinfo.hProcess;
2074 cps[nc] = cp;
2075 nc++;
2078 /* Nothing to look for, so we didn't find anything */
2079 if (nh + nc == 0)
2081 if (timeout)
2082 Sleep (timeout_ms);
2083 if (noninteractive)
2085 if (handle_file_notifications (NULL))
2086 return 1;
2088 return 0;
2091 start_time = GetTickCount ();
2093 /* Wait for input or child death to be signaled. If user input is
2094 allowed, then also accept window messages. */
2095 if (FD_ISSET (0, &orfds))
2096 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
2097 QS_ALLINPUT);
2098 else
2099 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
2101 if (active == WAIT_FAILED)
2103 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2104 nh + nc, timeout_ms, GetLastError ()));
2105 /* don't return EBADF - this causes wait_reading_process_output to
2106 abort; WAIT_FAILED is returned when single-stepping under
2107 Windows 95 after switching thread focus in debugger, and
2108 possibly at other times. */
2109 errno = EINTR;
2110 return -1;
2112 else if (active == WAIT_TIMEOUT)
2114 if (noninteractive)
2116 if (handle_file_notifications (NULL))
2117 return 1;
2119 return 0;
2121 else if (active >= WAIT_OBJECT_0
2122 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
2124 active -= WAIT_OBJECT_0;
2126 else if (active >= WAIT_ABANDONED_0
2127 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
2129 active -= WAIT_ABANDONED_0;
2131 else
2132 emacs_abort ();
2134 /* Loop over all handles after active (now officially documented as
2135 being the first signaled handle in the array). We do this to
2136 ensure fairness, so that all channels with data available will be
2137 processed - otherwise higher numbered channels could be starved. */
2140 if (active == nh + nc)
2142 /* There are messages in the lisp thread's queue; we must
2143 drain the queue now to ensure they are processed promptly,
2144 because if we don't do so, we will not be woken again until
2145 further messages arrive.
2147 NB. If ever we allow window message procedures to callback
2148 into lisp, we will need to ensure messages are dispatched
2149 at a safe time for lisp code to be run (*), and we may also
2150 want to provide some hooks in the dispatch loop to cater
2151 for modeless dialogs created by lisp (ie. to register
2152 window handles to pass to IsDialogMessage).
2154 (*) Note that MsgWaitForMultipleObjects above is an
2155 internal dispatch point for messages that are sent to
2156 windows created by this thread. */
2157 if (drain_message_queue ()
2158 /* If drain_message_queue returns non-zero, that means
2159 we received a WM_EMACS_FILENOTIFY message. If this
2160 is a TTY frame, we must signal the caller that keyboard
2161 input is available, so that w32_console_read_socket
2162 will be called to pick up the notifications. If we
2163 don't do that, file notifications will only work when
2164 the Emacs TTY frame has focus. */
2165 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2166 /* they asked for stdin reads */
2167 && FD_ISSET (0, &orfds)
2168 /* the stdin handle is valid */
2169 && keyboard_handle)
2171 FD_SET (0, rfds);
2172 if (nr == 0)
2173 nr = 1;
2176 else if (active >= nh)
2178 cp = cps[active - nh];
2180 /* We cannot always signal SIGCHLD immediately; if we have not
2181 finished reading the process output, we must delay sending
2182 SIGCHLD until we do. */
2184 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2185 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2186 /* SIG_DFL for SIGCHLD is ignore */
2187 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2188 sig_handlers[SIGCHLD] != SIG_IGN)
2190 #ifdef FULL_DEBUG
2191 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2192 cp->pid));
2193 #endif
2194 sig_handlers[SIGCHLD] (SIGCHLD);
2197 else if (fdindex[active] == -1)
2199 /* Quit (C-g) was detected. */
2200 errno = EINTR;
2201 return -1;
2203 else if (fdindex[active] == 0)
2205 /* Keyboard input available */
2206 FD_SET (0, rfds);
2207 nr++;
2209 else
2211 /* must be a socket or pipe - read ahead should have
2212 completed, either succeeding or failing. */
2213 FD_SET (fdindex[active], rfds);
2214 nr++;
2217 /* Even though wait_reading_process_output only reads from at most
2218 one channel, we must process all channels here so that we reap
2219 all children that have died. */
2220 while (++active < nh + nc)
2221 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2222 break;
2223 } while (active < nh + nc);
2225 if (noninteractive)
2227 if (handle_file_notifications (NULL))
2228 nr++;
2231 /* If no input has arrived and timeout hasn't expired, wait again. */
2232 if (nr == 0)
2234 DWORD elapsed = GetTickCount () - start_time;
2236 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2238 if (timeout_ms != INFINITE)
2239 timeout_ms -= elapsed;
2240 goto count_children;
2244 return nr;
2247 /* Substitute for certain kill () operations */
2249 static BOOL CALLBACK
2250 find_child_console (HWND hwnd, LPARAM arg)
2252 child_process * cp = (child_process *) arg;
2253 DWORD process_id;
2255 GetWindowThreadProcessId (hwnd, &process_id);
2256 if (process_id == cp->procinfo.dwProcessId)
2258 char window_class[32];
2260 GetClassName (hwnd, window_class, sizeof (window_class));
2261 if (strcmp (window_class,
2262 (os_subtype == OS_9X)
2263 ? "tty"
2264 : "ConsoleWindowClass") == 0)
2266 cp->hwnd = hwnd;
2267 return FALSE;
2270 /* keep looking */
2271 return TRUE;
2274 /* Emulate 'kill', but only for other processes. */
2276 sys_kill (pid_t pid, int sig)
2278 child_process *cp;
2279 HANDLE proc_hand;
2280 int need_to_free = 0;
2281 int rc = 0;
2283 /* Each process is in its own process group. */
2284 if (pid < 0)
2285 pid = -pid;
2287 /* Only handle signals that will result in the process dying */
2288 if (sig != 0
2289 && sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2291 errno = EINVAL;
2292 return -1;
2295 if (sig == 0)
2297 /* It will take _some_ time before PID 4 or less on Windows will
2298 be Emacs... */
2299 if (pid <= 4)
2301 errno = EPERM;
2302 return -1;
2304 proc_hand = OpenProcess (PROCESS_QUERY_INFORMATION, 0, pid);
2305 if (proc_hand == NULL)
2307 DWORD err = GetLastError ();
2309 switch (err)
2311 case ERROR_ACCESS_DENIED: /* existing process, but access denied */
2312 errno = EPERM;
2313 return -1;
2314 case ERROR_INVALID_PARAMETER: /* process PID does not exist */
2315 errno = ESRCH;
2316 return -1;
2319 else
2320 CloseHandle (proc_hand);
2321 return 0;
2324 cp = find_child_pid (pid);
2325 if (cp == NULL)
2327 /* We were passed a PID of something other than our subprocess.
2328 If that is our own PID, we will send to ourself a message to
2329 close the selected frame, which does not necessarily
2330 terminates Emacs. But then we are not supposed to call
2331 sys_kill with our own PID. */
2332 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2333 if (proc_hand == NULL)
2335 errno = EPERM;
2336 return -1;
2338 need_to_free = 1;
2340 else
2342 proc_hand = cp->procinfo.hProcess;
2343 pid = cp->procinfo.dwProcessId;
2345 /* Try to locate console window for process. */
2346 EnumWindows (find_child_console, (LPARAM) cp);
2349 if (sig == SIGINT || sig == SIGQUIT)
2351 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2353 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2354 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2355 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2356 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2357 HWND foreground_window;
2359 if (break_scan_code == 0)
2361 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2362 vk_break_code = 'C';
2363 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2366 foreground_window = GetForegroundWindow ();
2367 if (foreground_window)
2369 /* NT 5.0, and apparently also Windows 98, will not allow
2370 a Window to be set to foreground directly without the
2371 user's involvement. The workaround is to attach
2372 ourselves to the thread that owns the foreground
2373 window, since that is the only thread that can set the
2374 foreground window. */
2375 DWORD foreground_thread, child_thread;
2376 foreground_thread =
2377 GetWindowThreadProcessId (foreground_window, NULL);
2378 if (foreground_thread == GetCurrentThreadId ()
2379 || !AttachThreadInput (GetCurrentThreadId (),
2380 foreground_thread, TRUE))
2381 foreground_thread = 0;
2383 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2384 if (child_thread == GetCurrentThreadId ()
2385 || !AttachThreadInput (GetCurrentThreadId (),
2386 child_thread, TRUE))
2387 child_thread = 0;
2389 /* Set the foreground window to the child. */
2390 if (SetForegroundWindow (cp->hwnd))
2392 /* Generate keystrokes as if user had typed Ctrl-Break or
2393 Ctrl-C. */
2394 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2395 keybd_event (vk_break_code, break_scan_code,
2396 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2397 keybd_event (vk_break_code, break_scan_code,
2398 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2399 | KEYEVENTF_KEYUP, 0);
2400 keybd_event (VK_CONTROL, control_scan_code,
2401 KEYEVENTF_KEYUP, 0);
2403 /* Sleep for a bit to give time for Emacs frame to respond
2404 to focus change events (if Emacs was active app). */
2405 Sleep (100);
2407 SetForegroundWindow (foreground_window);
2409 /* Detach from the foreground and child threads now that
2410 the foreground switching is over. */
2411 if (foreground_thread)
2412 AttachThreadInput (GetCurrentThreadId (),
2413 foreground_thread, FALSE);
2414 if (child_thread)
2415 AttachThreadInput (GetCurrentThreadId (),
2416 child_thread, FALSE);
2419 /* Ctrl-Break is NT equivalent of SIGINT. */
2420 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2422 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2423 "for pid %lu\n", GetLastError (), pid));
2424 errno = EINVAL;
2425 rc = -1;
2428 else
2430 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2432 #if 1
2433 if (os_subtype == OS_9X)
2436 Another possibility is to try terminating the VDM out-right by
2437 calling the Shell VxD (id 0x17) V86 interface, function #4
2438 "SHELL_Destroy_VM", ie.
2440 mov edx,4
2441 mov ebx,vm_handle
2442 call shellapi
2444 First need to determine the current VM handle, and then arrange for
2445 the shellapi call to be made from the system vm (by using
2446 Switch_VM_and_callback).
2448 Could try to invoke DestroyVM through CallVxD.
2451 #if 0
2452 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2453 to hang when cmdproxy is used in conjunction with
2454 command.com for an interactive shell. Posting
2455 WM_CLOSE pops up a dialog that, when Yes is selected,
2456 does the same thing. TerminateProcess is also less
2457 than ideal in that subprocesses tend to stick around
2458 until the machine is shutdown, but at least it
2459 doesn't freeze the 16-bit subsystem. */
2460 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2461 #endif
2462 if (!TerminateProcess (proc_hand, 0xff))
2464 DebPrint (("sys_kill.TerminateProcess returned %d "
2465 "for pid %lu\n", GetLastError (), pid));
2466 errno = EINVAL;
2467 rc = -1;
2470 else
2471 #endif
2472 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2474 /* Kill the process. On W32 this doesn't kill child processes
2475 so it doesn't work very well for shells which is why it's not
2476 used in every case. */
2477 else if (!TerminateProcess (proc_hand, 0xff))
2479 DebPrint (("sys_kill.TerminateProcess returned %d "
2480 "for pid %lu\n", GetLastError (), pid));
2481 errno = EINVAL;
2482 rc = -1;
2486 if (need_to_free)
2487 CloseHandle (proc_hand);
2489 return rc;
2492 /* The following two routines are used to manipulate stdin, stdout, and
2493 stderr of our child processes.
2495 Assuming that in, out, and err are *not* inheritable, we make them
2496 stdin, stdout, and stderr of the child as follows:
2498 - Save the parent's current standard handles.
2499 - Set the std handles to inheritable duplicates of the ones being passed in.
2500 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2501 NT file handle for a crt file descriptor.)
2502 - Spawn the child, which inherits in, out, and err as stdin,
2503 stdout, and stderr. (see Spawnve)
2504 - Close the std handles passed to the child.
2505 - Reset the parent's standard handles to the saved handles.
2506 (see reset_standard_handles)
2507 We assume that the caller closes in, out, and err after calling us. */
2509 void
2510 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2512 HANDLE parent;
2513 HANDLE newstdin, newstdout, newstderr;
2515 parent = GetCurrentProcess ();
2517 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2518 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2519 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2521 /* make inheritable copies of the new handles */
2522 if (!DuplicateHandle (parent,
2523 (HANDLE) _get_osfhandle (in),
2524 parent,
2525 &newstdin,
2527 TRUE,
2528 DUPLICATE_SAME_ACCESS))
2529 report_file_error ("Duplicating input handle for child", Qnil);
2531 if (!DuplicateHandle (parent,
2532 (HANDLE) _get_osfhandle (out),
2533 parent,
2534 &newstdout,
2536 TRUE,
2537 DUPLICATE_SAME_ACCESS))
2538 report_file_error ("Duplicating output handle for child", Qnil);
2540 if (!DuplicateHandle (parent,
2541 (HANDLE) _get_osfhandle (err),
2542 parent,
2543 &newstderr,
2545 TRUE,
2546 DUPLICATE_SAME_ACCESS))
2547 report_file_error ("Duplicating error handle for child", Qnil);
2549 /* and store them as our std handles */
2550 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2551 report_file_error ("Changing stdin handle", Qnil);
2553 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2554 report_file_error ("Changing stdout handle", Qnil);
2556 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2557 report_file_error ("Changing stderr handle", Qnil);
2560 void
2561 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2563 /* close the duplicated handles passed to the child */
2564 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2565 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2566 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2568 /* now restore parent's saved std handles */
2569 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2570 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2571 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2574 void
2575 set_process_dir (char * dir)
2577 process_dir = dir;
2580 /* To avoid problems with winsock implementations that work over dial-up
2581 connections causing or requiring a connection to exist while Emacs is
2582 running, Emacs no longer automatically loads winsock on startup if it
2583 is present. Instead, it will be loaded when open-network-stream is
2584 first called.
2586 To allow full control over when winsock is loaded, we provide these
2587 two functions to dynamically load and unload winsock. This allows
2588 dial-up users to only be connected when they actually need to use
2589 socket services. */
2591 /* From w32.c */
2592 extern HANDLE winsock_lib;
2593 extern BOOL term_winsock (void);
2594 extern BOOL init_winsock (int load_now);
2596 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2597 doc: /* Test for presence of the Windows socket library `winsock'.
2598 Returns non-nil if winsock support is present, nil otherwise.
2600 If the optional argument LOAD-NOW is non-nil, the winsock library is
2601 also loaded immediately if not already loaded. If winsock is loaded,
2602 the winsock local hostname is returned (since this may be different from
2603 the value of `system-name' and should supplant it), otherwise t is
2604 returned to indicate winsock support is present. */)
2605 (Lisp_Object load_now)
2607 int have_winsock;
2609 have_winsock = init_winsock (!NILP (load_now));
2610 if (have_winsock)
2612 if (winsock_lib != NULL)
2614 /* Return new value for system-name. The best way to do this
2615 is to call init_system_name, saving and restoring the
2616 original value to avoid side-effects. */
2617 Lisp_Object orig_hostname = Vsystem_name;
2618 Lisp_Object hostname;
2620 init_system_name ();
2621 hostname = Vsystem_name;
2622 Vsystem_name = orig_hostname;
2623 return hostname;
2625 return Qt;
2627 return Qnil;
2630 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2631 0, 0, 0,
2632 doc: /* Unload the Windows socket library `winsock' if loaded.
2633 This is provided to allow dial-up socket connections to be disconnected
2634 when no longer needed. Returns nil without unloading winsock if any
2635 socket connections still exist. */)
2636 (void)
2638 return term_winsock () ? Qt : Qnil;
2642 /* Some miscellaneous functions that are Windows specific, but not GUI
2643 specific (ie. are applicable in terminal or batch mode as well). */
2645 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2646 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2647 If FILENAME does not exist, return nil.
2648 All path elements in FILENAME are converted to their short names. */)
2649 (Lisp_Object filename)
2651 char shortname[MAX_PATH];
2653 CHECK_STRING (filename);
2655 /* first expand it. */
2656 filename = Fexpand_file_name (filename, Qnil);
2658 /* luckily, this returns the short version of each element in the path. */
2659 if (w32_get_short_filename (SDATA (ENCODE_FILE (filename)),
2660 shortname, MAX_PATH) == 0)
2661 return Qnil;
2663 dostounix_filename (shortname);
2665 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2666 return build_string (shortname);
2670 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2671 1, 1, 0,
2672 doc: /* Return the long file name version of the full path of FILENAME.
2673 If FILENAME does not exist, return nil.
2674 All path elements in FILENAME are converted to their long names. */)
2675 (Lisp_Object filename)
2677 char longname[ MAX_UTF8_PATH ];
2678 int drive_only = 0;
2680 CHECK_STRING (filename);
2682 if (SBYTES (filename) == 2
2683 && *(SDATA (filename) + 1) == ':')
2684 drive_only = 1;
2686 /* first expand it. */
2687 filename = Fexpand_file_name (filename, Qnil);
2689 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname,
2690 MAX_UTF8_PATH))
2691 return Qnil;
2693 dostounix_filename (longname);
2695 /* If we were passed only a drive, make sure that a slash is not appended
2696 for consistency with directories. Allow for drive mapping via SUBST
2697 in case expand-file-name is ever changed to expand those. */
2698 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2699 longname[2] = '\0';
2701 return DECODE_FILE (build_unibyte_string (longname));
2704 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2705 Sw32_set_process_priority, 2, 2, 0,
2706 doc: /* Set the priority of PROCESS to PRIORITY.
2707 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2708 priority of the process whose pid is PROCESS is changed.
2709 PRIORITY should be one of the symbols high, normal, or low;
2710 any other symbol will be interpreted as normal.
2712 If successful, the return value is t, otherwise nil. */)
2713 (Lisp_Object process, Lisp_Object priority)
2715 HANDLE proc_handle = GetCurrentProcess ();
2716 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2717 Lisp_Object result = Qnil;
2719 CHECK_SYMBOL (priority);
2721 if (!NILP (process))
2723 DWORD pid;
2724 child_process *cp;
2726 CHECK_NUMBER (process);
2728 /* Allow pid to be an internally generated one, or one obtained
2729 externally. This is necessary because real pids on Windows 95 are
2730 negative. */
2732 pid = XINT (process);
2733 cp = find_child_pid (pid);
2734 if (cp != NULL)
2735 pid = cp->procinfo.dwProcessId;
2737 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2740 if (EQ (priority, Qhigh))
2741 priority_class = HIGH_PRIORITY_CLASS;
2742 else if (EQ (priority, Qlow))
2743 priority_class = IDLE_PRIORITY_CLASS;
2745 if (proc_handle != NULL)
2747 if (SetPriorityClass (proc_handle, priority_class))
2748 result = Qt;
2749 if (!NILP (process))
2750 CloseHandle (proc_handle);
2753 return result;
2756 #ifdef HAVE_LANGINFO_CODESET
2757 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2758 char *
2759 nl_langinfo (nl_item item)
2761 /* Conversion of Posix item numbers to their Windows equivalents. */
2762 static const LCTYPE w32item[] = {
2763 LOCALE_IDEFAULTANSICODEPAGE,
2764 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2765 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2766 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2767 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2768 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2769 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2772 static char *nl_langinfo_buf = NULL;
2773 static int nl_langinfo_len = 0;
2775 if (nl_langinfo_len <= 0)
2776 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2778 if (item < 0 || item >= _NL_NUM)
2779 nl_langinfo_buf[0] = 0;
2780 else
2782 LCID cloc = GetThreadLocale ();
2783 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2784 NULL, 0);
2786 if (need_len <= 0)
2787 nl_langinfo_buf[0] = 0;
2788 else
2790 if (item == CODESET)
2792 need_len += 2; /* for the "cp" prefix */
2793 if (need_len < 8) /* for the case we call GetACP */
2794 need_len = 8;
2796 if (nl_langinfo_len <= need_len)
2797 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2798 nl_langinfo_len = need_len);
2799 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2800 nl_langinfo_buf, nl_langinfo_len))
2801 nl_langinfo_buf[0] = 0;
2802 else if (item == CODESET)
2804 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2805 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2806 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2807 else
2809 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2810 strlen (nl_langinfo_buf) + 1);
2811 nl_langinfo_buf[0] = 'c';
2812 nl_langinfo_buf[1] = 'p';
2817 return nl_langinfo_buf;
2819 #endif /* HAVE_LANGINFO_CODESET */
2821 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2822 Sw32_get_locale_info, 1, 2, 0,
2823 doc: /* Return information about the Windows locale LCID.
2824 By default, return a three letter locale code which encodes the default
2825 language as the first two characters, and the country or regional variant
2826 as the third letter. For example, ENU refers to `English (United States)',
2827 while ENC means `English (Canadian)'.
2829 If the optional argument LONGFORM is t, the long form of the locale
2830 name is returned, e.g. `English (United States)' instead; if LONGFORM
2831 is a number, it is interpreted as an LCTYPE constant and the corresponding
2832 locale information is returned.
2834 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2835 (Lisp_Object lcid, Lisp_Object longform)
2837 int got_abbrev;
2838 int got_full;
2839 char abbrev_name[32] = { 0 };
2840 char full_name[256] = { 0 };
2842 CHECK_NUMBER (lcid);
2844 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2845 return Qnil;
2847 if (NILP (longform))
2849 got_abbrev = GetLocaleInfo (XINT (lcid),
2850 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2851 abbrev_name, sizeof (abbrev_name));
2852 if (got_abbrev)
2853 return build_string (abbrev_name);
2855 else if (EQ (longform, Qt))
2857 got_full = GetLocaleInfo (XINT (lcid),
2858 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2859 full_name, sizeof (full_name));
2860 if (got_full)
2861 return DECODE_SYSTEM (build_string (full_name));
2863 else if (NUMBERP (longform))
2865 got_full = GetLocaleInfo (XINT (lcid),
2866 XINT (longform),
2867 full_name, sizeof (full_name));
2868 /* GetLocaleInfo's return value includes the terminating null
2869 character, when the returned information is a string, whereas
2870 make_unibyte_string needs the string length without the
2871 terminating null. */
2872 if (got_full)
2873 return make_unibyte_string (full_name, got_full - 1);
2876 return Qnil;
2880 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2881 Sw32_get_current_locale_id, 0, 0, 0,
2882 doc: /* Return Windows locale id for current locale setting.
2883 This is a numerical value; use `w32-get-locale-info' to convert to a
2884 human-readable form. */)
2885 (void)
2887 return make_number (GetThreadLocale ());
2890 static DWORD
2891 int_from_hex (char * s)
2893 DWORD val = 0;
2894 static char hex[] = "0123456789abcdefABCDEF";
2895 char * p;
2897 while (*s && (p = strchr (hex, *s)) != NULL)
2899 unsigned digit = p - hex;
2900 if (digit > 15)
2901 digit -= 6;
2902 val = val * 16 + digit;
2903 s++;
2905 return val;
2908 /* We need to build a global list, since the EnumSystemLocale callback
2909 function isn't given a context pointer. */
2910 Lisp_Object Vw32_valid_locale_ids;
2912 static BOOL CALLBACK
2913 enum_locale_fn (LPTSTR localeNum)
2915 DWORD id = int_from_hex (localeNum);
2916 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2917 return TRUE;
2920 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2921 Sw32_get_valid_locale_ids, 0, 0, 0,
2922 doc: /* Return list of all valid Windows locale ids.
2923 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2924 human-readable form. */)
2925 (void)
2927 Vw32_valid_locale_ids = Qnil;
2929 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2931 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2932 return Vw32_valid_locale_ids;
2936 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2937 doc: /* Return Windows locale id for default locale setting.
2938 By default, the system default locale setting is returned; if the optional
2939 parameter USERP is non-nil, the user default locale setting is returned.
2940 This is a numerical value; use `w32-get-locale-info' to convert to a
2941 human-readable form. */)
2942 (Lisp_Object userp)
2944 if (NILP (userp))
2945 return make_number (GetSystemDefaultLCID ());
2946 return make_number (GetUserDefaultLCID ());
2950 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2951 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2952 If successful, the new locale id is returned, otherwise nil. */)
2953 (Lisp_Object lcid)
2955 CHECK_NUMBER (lcid);
2957 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2958 return Qnil;
2960 if (!SetThreadLocale (XINT (lcid)))
2961 return Qnil;
2963 /* Need to set input thread locale if present. */
2964 if (dwWindowsThreadId)
2965 /* Reply is not needed. */
2966 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2968 return make_number (GetThreadLocale ());
2972 /* We need to build a global list, since the EnumCodePages callback
2973 function isn't given a context pointer. */
2974 Lisp_Object Vw32_valid_codepages;
2976 static BOOL CALLBACK
2977 enum_codepage_fn (LPTSTR codepageNum)
2979 DWORD id = atoi (codepageNum);
2980 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2981 return TRUE;
2984 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
2985 Sw32_get_valid_codepages, 0, 0, 0,
2986 doc: /* Return list of all valid Windows codepages. */)
2987 (void)
2989 Vw32_valid_codepages = Qnil;
2991 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
2993 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
2994 return Vw32_valid_codepages;
2998 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
2999 Sw32_get_console_codepage, 0, 0, 0,
3000 doc: /* Return current Windows codepage for console input. */)
3001 (void)
3003 return make_number (GetConsoleCP ());
3007 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
3008 Sw32_set_console_codepage, 1, 1, 0,
3009 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
3010 This codepage setting affects keyboard input in tty mode.
3011 If successful, the new CP is returned, otherwise nil. */)
3012 (Lisp_Object cp)
3014 CHECK_NUMBER (cp);
3016 if (!IsValidCodePage (XINT (cp)))
3017 return Qnil;
3019 if (!SetConsoleCP (XINT (cp)))
3020 return Qnil;
3022 return make_number (GetConsoleCP ());
3026 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
3027 Sw32_get_console_output_codepage, 0, 0, 0,
3028 doc: /* Return current Windows codepage for console output. */)
3029 (void)
3031 return make_number (GetConsoleOutputCP ());
3035 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
3036 Sw32_set_console_output_codepage, 1, 1, 0,
3037 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
3038 This codepage setting affects display in tty mode.
3039 If successful, the new CP is returned, otherwise nil. */)
3040 (Lisp_Object cp)
3042 CHECK_NUMBER (cp);
3044 if (!IsValidCodePage (XINT (cp)))
3045 return Qnil;
3047 if (!SetConsoleOutputCP (XINT (cp)))
3048 return Qnil;
3050 return make_number (GetConsoleOutputCP ());
3054 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
3055 Sw32_get_codepage_charset, 1, 1, 0,
3056 doc: /* Return charset ID corresponding to codepage CP.
3057 Returns nil if the codepage is not valid. */)
3058 (Lisp_Object cp)
3060 CHARSETINFO info;
3062 CHECK_NUMBER (cp);
3064 if (!IsValidCodePage (XINT (cp)))
3065 return Qnil;
3067 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
3068 return make_number (info.ciCharset);
3070 return Qnil;
3074 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
3075 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
3076 doc: /* Return list of Windows keyboard languages and layouts.
3077 The return value is a list of pairs of language id and layout id. */)
3078 (void)
3080 int num_layouts = GetKeyboardLayoutList (0, NULL);
3081 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
3082 Lisp_Object obj = Qnil;
3084 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
3086 while (--num_layouts >= 0)
3088 HKL kl = layouts[num_layouts];
3090 obj = Fcons (Fcons (make_number (LOWORD (kl)),
3091 make_number (HIWORD (kl))),
3092 obj);
3096 return obj;
3100 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
3101 Sw32_get_keyboard_layout, 0, 0, 0,
3102 doc: /* Return current Windows keyboard language and layout.
3103 The return value is the cons of the language id and the layout id. */)
3104 (void)
3106 HKL kl = GetKeyboardLayout (dwWindowsThreadId);
3108 return Fcons (make_number (LOWORD (kl)),
3109 make_number (HIWORD (kl)));
3113 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
3114 Sw32_set_keyboard_layout, 1, 1, 0,
3115 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
3116 The keyboard layout setting affects interpretation of keyboard input.
3117 If successful, the new layout id is returned, otherwise nil. */)
3118 (Lisp_Object layout)
3120 HKL kl;
3122 CHECK_CONS (layout);
3123 CHECK_NUMBER_CAR (layout);
3124 CHECK_NUMBER_CDR (layout);
3126 kl = (HKL) ((XINT (XCAR (layout)) & 0xffff)
3127 | (XINT (XCDR (layout)) << 16));
3129 /* Synchronize layout with input thread. */
3130 if (dwWindowsThreadId)
3132 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
3133 (WPARAM) kl, 0))
3135 MSG msg;
3136 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3138 if (msg.wParam == 0)
3139 return Qnil;
3142 else if (!ActivateKeyboardLayout (kl, 0))
3143 return Qnil;
3145 return Fw32_get_keyboard_layout ();
3148 /* Two variables to interface between get_lcid and the EnumLocales
3149 callback function below. */
3150 #ifndef LOCALE_NAME_MAX_LENGTH
3151 # define LOCALE_NAME_MAX_LENGTH 85
3152 #endif
3153 static LCID found_lcid;
3154 static char lname[3 * LOCALE_NAME_MAX_LENGTH + 1 + 1];
3156 /* Callback function for EnumLocales. */
3157 static BOOL CALLBACK
3158 get_lcid_callback (LPTSTR locale_num_str)
3160 char *endp;
3161 char locval[2 * LOCALE_NAME_MAX_LENGTH + 1 + 1];
3162 LCID try_lcid = strtoul (locale_num_str, &endp, 16);
3164 if (GetLocaleInfo (try_lcid, LOCALE_SABBREVLANGNAME,
3165 locval, LOCALE_NAME_MAX_LENGTH))
3167 strcat (locval, "_");
3168 if (GetLocaleInfo (try_lcid, LOCALE_SABBREVCTRYNAME,
3169 locval + strlen (locval), LOCALE_NAME_MAX_LENGTH))
3171 size_t locval_len = strlen (locval);
3173 if (strnicmp (locval, lname, locval_len) == 0
3174 && (lname[locval_len] == '.'
3175 || lname[locval_len] == '\0'))
3177 found_lcid = try_lcid;
3178 return FALSE;
3182 return TRUE;
3185 /* Return the Locale ID (LCID) number given the locale's name, a
3186 string, in LOCALE_NAME. This works by enumerating all the locales
3187 supported by the system, until we find one whose name matches
3188 LOCALE_NAME. */
3189 static LCID
3190 get_lcid (const char *locale_name)
3192 /* A simple cache. */
3193 static LCID last_lcid;
3194 static char last_locale[1000];
3196 /* The code below is not thread-safe, as it uses static variables.
3197 But this function is called only from the Lisp thread. */
3198 if (last_lcid > 0 && strcmp (locale_name, last_locale) == 0)
3199 return last_lcid;
3201 strncpy (lname, locale_name, sizeof (lname) - 1);
3202 lname[sizeof (lname) - 1] = '\0';
3203 found_lcid = 0;
3204 EnumSystemLocales (get_lcid_callback, LCID_SUPPORTED);
3205 if (found_lcid > 0)
3207 last_lcid = found_lcid;
3208 strcpy (last_locale, locale_name);
3210 return found_lcid;
3213 #ifndef _NSLCMPERROR
3214 # define _NSLCMPERROR INT_MAX
3215 #endif
3216 #ifndef LINGUISTIC_IGNORECASE
3217 # define LINGUISTIC_IGNORECASE 0x00000010
3218 #endif
3221 w32_compare_strings (const char *s1, const char *s2, char *locname,
3222 int ignore_case)
3224 LCID lcid = GetThreadLocale ();
3225 wchar_t *string1_w, *string2_w;
3226 int val, needed;
3227 extern BOOL g_b_init_compare_string_w;
3228 static int (WINAPI *pCompareStringW)(LCID, DWORD, LPCWSTR, int, LPCWSTR, int);
3229 DWORD flags = 0;
3231 USE_SAFE_ALLOCA;
3233 if (!g_b_init_compare_string_w)
3235 if (os_subtype == OS_9X)
3237 pCompareStringW = GetProcAddress (LoadLibrary ("Unicows.dll"),
3238 "CompareStringW");
3239 if (!pCompareStringW)
3241 errno = EINVAL;
3242 /* This return value is compatible with wcscoll and
3243 other MS CRT functions. */
3244 return _NSLCMPERROR;
3247 else
3248 pCompareStringW = CompareStringW;
3250 g_b_init_compare_string_w = 1;
3253 needed = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s1, -1, NULL, 0);
3254 if (needed > 0)
3256 SAFE_NALLOCA (string1_w, 1, needed + 1);
3257 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s1, -1,
3258 string1_w, needed);
3260 else
3262 errno = EINVAL;
3263 return _NSLCMPERROR;
3266 needed = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s2, -1, NULL, 0);
3267 if (needed > 0)
3269 SAFE_NALLOCA (string2_w, 1, needed + 1);
3270 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s2, -1,
3271 string2_w, needed);
3273 else
3275 SAFE_FREE ();
3276 errno = EINVAL;
3277 return _NSLCMPERROR;
3280 if (locname)
3282 /* Convert locale name string to LCID. We don't want to use
3283 LocaleNameToLCID because (a) it is only available since
3284 Vista, and (b) it doesn't accept locale names returned by
3285 'setlocale' and 'GetLocaleInfo'. */
3286 LCID new_lcid = get_lcid (locname);
3288 if (new_lcid > 0)
3289 lcid = new_lcid;
3292 if (ignore_case)
3294 /* NORM_IGNORECASE ignores any tertiary distinction, not just
3295 case variants. LINGUISTIC_IGNORECASE is more selective, and
3296 is sensitive to the locale's language, but it is not
3297 available before Vista. */
3298 if (w32_major_version >= 6)
3299 flags |= LINGUISTIC_IGNORECASE;
3300 else
3301 flags |= NORM_IGNORECASE;
3303 /* This approximates what glibc collation functions do when the
3304 locale's codeset is UTF-8. */
3305 if (!NILP (Vw32_collate_ignore_punctuation))
3306 flags |= NORM_IGNORESYMBOLS;
3307 val = pCompareStringW (lcid, flags, string1_w, -1, string2_w, -1);
3308 SAFE_FREE ();
3309 if (!val)
3311 errno = EINVAL;
3312 return _NSLCMPERROR;
3314 return val - 2;
3318 void
3319 syms_of_ntproc (void)
3321 DEFSYM (Qhigh, "high");
3322 DEFSYM (Qlow, "low");
3324 defsubr (&Sw32_has_winsock);
3325 defsubr (&Sw32_unload_winsock);
3327 defsubr (&Sw32_short_file_name);
3328 defsubr (&Sw32_long_file_name);
3329 defsubr (&Sw32_set_process_priority);
3330 defsubr (&Sw32_get_locale_info);
3331 defsubr (&Sw32_get_current_locale_id);
3332 defsubr (&Sw32_get_default_locale_id);
3333 defsubr (&Sw32_get_valid_locale_ids);
3334 defsubr (&Sw32_set_current_locale);
3336 defsubr (&Sw32_get_console_codepage);
3337 defsubr (&Sw32_set_console_codepage);
3338 defsubr (&Sw32_get_console_output_codepage);
3339 defsubr (&Sw32_set_console_output_codepage);
3340 defsubr (&Sw32_get_valid_codepages);
3341 defsubr (&Sw32_get_codepage_charset);
3343 defsubr (&Sw32_get_valid_keyboard_layouts);
3344 defsubr (&Sw32_get_keyboard_layout);
3345 defsubr (&Sw32_set_keyboard_layout);
3347 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3348 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3349 Because Windows does not directly pass argv arrays to child processes,
3350 programs have to reconstruct the argv array by parsing the command
3351 line string. For an argument to contain a space, it must be enclosed
3352 in double quotes or it will be parsed as multiple arguments.
3354 If the value is a character, that character will be used to escape any
3355 quote characters that appear, otherwise a suitable escape character
3356 will be chosen based on the type of the program. */);
3357 Vw32_quote_process_args = Qt;
3359 DEFVAR_LISP ("w32-start-process-show-window",
3360 Vw32_start_process_show_window,
3361 doc: /* When nil, new child processes hide their windows.
3362 When non-nil, they show their window in the method of their choice.
3363 This variable doesn't affect GUI applications, which will never be hidden. */);
3364 Vw32_start_process_show_window = Qnil;
3366 DEFVAR_LISP ("w32-start-process-share-console",
3367 Vw32_start_process_share_console,
3368 doc: /* When nil, new child processes are given a new console.
3369 When non-nil, they share the Emacs console; this has the limitation of
3370 allowing only one DOS subprocess to run at a time (whether started directly
3371 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3372 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3373 otherwise respond to interrupts from Emacs. */);
3374 Vw32_start_process_share_console = Qnil;
3376 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3377 Vw32_start_process_inherit_error_mode,
3378 doc: /* When nil, new child processes revert to the default error mode.
3379 When non-nil, they inherit their error mode setting from Emacs, which stops
3380 them blocking when trying to access unmounted drives etc. */);
3381 Vw32_start_process_inherit_error_mode = Qt;
3383 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3384 doc: /* Forced delay before reading subprocess output.
3385 This is done to improve the buffering of subprocess output, by
3386 avoiding the inefficiency of frequently reading small amounts of data.
3388 If positive, the value is the number of milliseconds to sleep before
3389 reading the subprocess output. If negative, the magnitude is the number
3390 of time slices to wait (effectively boosting the priority of the child
3391 process temporarily). A value of zero disables waiting entirely. */);
3392 w32_pipe_read_delay = 50;
3394 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3395 doc: /* Non-nil means convert all-upper case file names to lower case.
3396 This applies when performing completions and file name expansion.
3397 Note that the value of this setting also affects remote file names,
3398 so you probably don't want to set to non-nil if you use case-sensitive
3399 filesystems via ange-ftp. */);
3400 Vw32_downcase_file_names = Qnil;
3402 #if 0
3403 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3404 doc: /* Non-nil means attempt to fake realistic inode values.
3405 This works by hashing the truename of files, and should detect
3406 aliasing between long and short (8.3 DOS) names, but can have
3407 false positives because of hash collisions. Note that determining
3408 the truename of a file can be slow. */);
3409 Vw32_generate_fake_inodes = Qnil;
3410 #endif
3412 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3413 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3414 This option controls whether to issue additional system calls to determine
3415 accurate link counts, file type, and ownership information. It is more
3416 useful for files on NTFS volumes, where hard links and file security are
3417 supported, than on volumes of the FAT family.
3419 Without these system calls, link count will always be reported as 1 and file
3420 ownership will be attributed to the current user.
3421 The default value `local' means only issue these system calls for files
3422 on local fixed drives. A value of nil means never issue them.
3423 Any other non-nil value means do this even on remote and removable drives
3424 where the performance impact may be noticeable even on modern hardware. */);
3425 Vw32_get_true_file_attributes = Qlocal;
3427 DEFVAR_LISP ("w32-collate-ignore-punctuation",
3428 Vw32_collate_ignore_punctuation,
3429 doc: /* Non-nil causes string collation functions ignore punctuation on MS-Windows.
3430 On Posix platforms, `string-collate-lessp' and `string-collate-equalp'
3431 ignore punctuation characters when they compare strings, if the
3432 locale's codeset is UTF-8, as in \"en_US.UTF-8\". Binding this option
3433 to a non-nil value will achieve a similar effect on MS-Windows, where
3434 locales with UTF-8 codeset are not supported.
3436 Note that setting this to non-nil will also ignore blanks and symbols
3437 in the strings. So do NOT use this option when comparing file names
3438 for equality, only when you need to sort them. */);
3439 Vw32_collate_ignore_punctuation = Qnil;
3441 staticpro (&Vw32_valid_locale_ids);
3442 staticpro (&Vw32_valid_codepages);
3444 /* end of w32proc.c */