1 /* Process support for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1992, 1995, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007 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 2, or (at your option)
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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
22 Drew Bliss Oct 14, 1993
23 Adapted from alarm.c by Tim Fleehart
34 /* must include CRT headers *before* config.h */
48 /* This definition is missing from mingw32 headers. */
49 extern BOOL WINAPI
IsValidLocale(LCID
, DWORD
);
52 #ifdef HAVE_LANGINFO_CODESET
58 #include "character.h"
64 #include "syssignal.h"
67 #define RVA_TO_PTR(var,section,filedata) \
68 ((void *)((section)->PointerToRawData \
69 + ((DWORD)(var) - (section)->VirtualAddress) \
70 + (filedata).file_base))
72 /* Control whether spawnve quotes arguments as necessary to ensure
73 correct parsing by child process. Because not all uses of spawnve
74 are careful about constructing argv arrays, we make this behaviour
75 conditional (off by default). */
76 Lisp_Object Vw32_quote_process_args
;
78 /* Control whether create_child causes the process' window to be
79 hidden. The default is nil. */
80 Lisp_Object Vw32_start_process_show_window
;
82 /* Control whether create_child causes the process to inherit Emacs'
83 console window, or be given a new one of its own. The default is
84 nil, to allow multiple DOS programs to run on Win95. Having separate
85 consoles also allows Emacs to cleanly terminate process groups. */
86 Lisp_Object Vw32_start_process_share_console
;
88 /* Control whether create_child cause the process to inherit Emacs'
89 error mode setting. The default is t, to minimize the possibility of
90 subprocesses blocking when accessing unmounted drives. */
91 Lisp_Object Vw32_start_process_inherit_error_mode
;
93 /* Time to sleep before reading from a subprocess output pipe - this
94 avoids the inefficiency of frequently reading small amounts of data.
95 This is primarily necessary for handling DOS processes on Windows 95,
96 but is useful for W32 processes on both Windows 95 and NT as well. */
97 int w32_pipe_read_delay
;
99 /* Control conversion of upper case file names to lower case.
100 nil means no, t means yes. */
101 Lisp_Object Vw32_downcase_file_names
;
103 /* Control whether stat() attempts to generate fake but hopefully
104 "accurate" inode values, by hashing the absolute truenames of files.
105 This should detect aliasing between long and short names, but still
106 allows the possibility of hash collisions. */
107 Lisp_Object Vw32_generate_fake_inodes
;
109 /* Control whether stat() attempts to determine file type and link count
110 exactly, at the expense of slower operation. Since true hard links
111 are supported on NTFS volumes, this is only relevant on NT. */
112 Lisp_Object Vw32_get_true_file_attributes
;
114 Lisp_Object Qhigh
, Qlow
;
117 void _DebPrint (const char *fmt
, ...)
122 va_start (args
, fmt
);
123 vsprintf (buf
, fmt
, args
);
125 OutputDebugString (buf
);
129 typedef void (_CALLBACK_
*signal_handler
)(int);
131 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
132 static signal_handler sig_handlers
[NSIG
];
134 /* Fake signal implementation to record the SIGCHLD handler. */
136 sys_signal (int sig
, signal_handler handler
)
145 old
= sig_handlers
[sig
];
146 sig_handlers
[sig
] = handler
;
150 /* Defined in <process.h> which conflicts with the local copy */
153 /* Child process management list. */
154 int child_proc_count
= 0;
155 child_process child_procs
[ MAX_CHILDREN
];
156 child_process
*dead_child
= NULL
;
158 DWORD WINAPI
reader_thread (void *arg
);
160 /* Find an unused process slot. */
167 for (cp
= child_procs
+(child_proc_count
-1); cp
>= child_procs
; cp
--)
168 if (!CHILD_ACTIVE (cp
))
170 if (child_proc_count
== MAX_CHILDREN
)
172 cp
= &child_procs
[child_proc_count
++];
175 memset (cp
, 0, sizeof(*cp
));
178 cp
->procinfo
.hProcess
= NULL
;
179 cp
->status
= STATUS_READ_ERROR
;
181 /* use manual reset event so that select() will function properly */
182 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
185 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
186 if (cp
->char_consumed
)
188 cp
->thrd
= CreateThread (NULL
, 1024, reader_thread
, cp
, 0, &id
);
198 delete_child (child_process
*cp
)
202 /* Should not be deleting a child that is still needed. */
203 for (i
= 0; i
< MAXDESC
; i
++)
204 if (fd_info
[i
].cp
== cp
)
207 if (!CHILD_ACTIVE (cp
))
210 /* reap thread if necessary */
215 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
217 /* let the thread exit cleanly if possible */
218 cp
->status
= STATUS_READ_ERROR
;
219 SetEvent (cp
->char_consumed
);
220 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
222 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
223 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
224 TerminateThread (cp
->thrd
, 0);
227 CloseHandle (cp
->thrd
);
232 CloseHandle (cp
->char_avail
);
233 cp
->char_avail
= NULL
;
235 if (cp
->char_consumed
)
237 CloseHandle (cp
->char_consumed
);
238 cp
->char_consumed
= NULL
;
241 /* update child_proc_count (highest numbered slot in use plus one) */
242 if (cp
== child_procs
+ child_proc_count
- 1)
244 for (i
= child_proc_count
-1; i
>= 0; i
--)
245 if (CHILD_ACTIVE (&child_procs
[i
]))
247 child_proc_count
= i
+ 1;
252 child_proc_count
= 0;
255 /* Find a child by pid. */
256 static child_process
*
257 find_child_pid (DWORD pid
)
261 for (cp
= child_procs
+(child_proc_count
-1); cp
>= child_procs
; cp
--)
262 if (CHILD_ACTIVE (cp
) && pid
== cp
->pid
)
268 /* Thread proc for child process and socket reader threads. Each thread
269 is normally blocked until woken by select() to check for input by
270 reading one char. When the read completes, char_avail is signalled
271 to wake up the select emulator and the thread blocks itself again. */
273 reader_thread (void *arg
)
278 cp
= (child_process
*)arg
;
280 /* We have to wait for the go-ahead before we can start */
282 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
289 if (fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
290 rc
= _sys_wait_accept (cp
->fd
);
292 rc
= _sys_read_ahead (cp
->fd
);
294 /* The name char_avail is a misnomer - it really just means the
295 read-ahead has completed, whether successfully or not. */
296 if (!SetEvent (cp
->char_avail
))
298 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
299 GetLastError (), cp
->fd
));
303 if (rc
== STATUS_READ_ERROR
)
306 /* If the read died, the child has died so let the thread die */
307 if (rc
== STATUS_READ_FAILED
)
310 /* Wait until our input is acknowledged before reading again */
311 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
313 DebPrint (("reader_thread.WaitForSingleObject failed with "
314 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
321 /* To avoid Emacs changing directory, we just record here the directory
322 the new process should start in. This is set just before calling
323 sys_spawnve, and is not generally valid at any other time. */
324 static char * process_dir
;
327 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
328 int * pPid
, child_process
*cp
)
331 SECURITY_ATTRIBUTES sec_attrs
;
333 SECURITY_DESCRIPTOR sec_desc
;
336 char dir
[ MAXPATHLEN
];
338 if (cp
== NULL
) abort ();
340 memset (&start
, 0, sizeof (start
));
341 start
.cb
= sizeof (start
);
344 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
345 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
347 start
.dwFlags
= STARTF_USESTDHANDLES
;
348 start
.wShowWindow
= SW_HIDE
;
350 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
351 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
352 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
353 #endif /* HAVE_NTGUI */
356 /* Explicitly specify no security */
357 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
359 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
362 sec_attrs
.nLength
= sizeof (sec_attrs
);
363 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
364 sec_attrs
.bInheritHandle
= FALSE
;
366 strcpy (dir
, process_dir
);
367 unixtodos_filename (dir
);
369 flags
= (!NILP (Vw32_start_process_share_console
)
370 ? CREATE_NEW_PROCESS_GROUP
371 : CREATE_NEW_CONSOLE
);
372 if (NILP (Vw32_start_process_inherit_error_mode
))
373 flags
|= CREATE_DEFAULT_ERROR_MODE
;
374 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
375 flags
, env
, dir
, &start
, &cp
->procinfo
))
378 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
380 /* Hack for Windows 95, which assigns large (ie negative) pids */
384 /* pid must fit in a Lisp_Int */
385 cp
->pid
= cp
->pid
& INTMASK
;
392 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError()););
396 /* create_child doesn't know what emacs' file handle will be for waiting
397 on output from the child, so we need to make this additional call
398 to register the handle with the process
399 This way the select emulator knows how to match file handles with
400 entries in child_procs. */
402 register_child (int pid
, int fd
)
406 cp
= find_child_pid (pid
);
409 DebPrint (("register_child unable to find pid %lu\n", pid
));
414 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
419 /* thread is initially blocked until select is called; set status so
420 that select will release thread */
421 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
423 /* attach child_process to fd_info */
424 if (fd_info
[fd
].cp
!= NULL
)
426 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
433 /* When a process dies its pipe will break so the reader thread will
434 signal failure to the select emulator.
435 The select emulator then calls this routine to clean up.
436 Since the thread signaled failure we can assume it is exiting. */
438 reap_subprocess (child_process
*cp
)
440 if (cp
->procinfo
.hProcess
)
442 /* Reap the process */
444 /* Process should have already died before we are called. */
445 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
446 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp
->fd
));
448 CloseHandle (cp
->procinfo
.hProcess
);
449 cp
->procinfo
.hProcess
= NULL
;
450 CloseHandle (cp
->procinfo
.hThread
);
451 cp
->procinfo
.hThread
= NULL
;
454 /* For asynchronous children, the child_proc resources will be freed
455 when the last pipe read descriptor is closed; for synchronous
456 children, we must explicitly free the resources now because
457 register_child has not been called. */
462 /* Wait for any of our existing child processes to die
463 When it does, close its handle
464 Return the pid and fill in the status if non-NULL. */
467 sys_wait (int *status
)
469 DWORD active
, retval
;
472 child_process
*cp
, *cps
[MAX_CHILDREN
];
473 HANDLE wait_hnd
[MAX_CHILDREN
];
476 if (dead_child
!= NULL
)
478 /* We want to wait for a specific child */
479 wait_hnd
[nh
] = dead_child
->procinfo
.hProcess
;
480 cps
[nh
] = dead_child
;
481 if (!wait_hnd
[nh
]) abort ();
488 for (cp
= child_procs
+(child_proc_count
-1); cp
>= child_procs
; cp
--)
489 /* some child_procs might be sockets; ignore them */
490 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
491 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
493 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
501 /* Nothing to wait on, so fail */
508 /* Check for quit about once a second. */
510 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, 1000);
511 } while (active
== WAIT_TIMEOUT
);
513 if (active
== WAIT_FAILED
)
518 else if (active
>= WAIT_OBJECT_0
519 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
521 active
-= WAIT_OBJECT_0
;
523 else if (active
>= WAIT_ABANDONED_0
524 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
526 active
-= WAIT_ABANDONED_0
;
532 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
534 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
538 if (retval
== STILL_ACTIVE
)
540 /* Should never happen */
541 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
546 /* Massage the exit code from the process to match the format expected
547 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
548 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
550 if (retval
== STATUS_CONTROL_C_EXIT
)
558 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
565 else if (synch_process_alive
)
567 synch_process_alive
= 0;
569 /* Report the status of the synchronous process. */
570 if (WIFEXITED (retval
))
571 synch_process_retcode
= WRETCODE (retval
);
572 else if (WIFSIGNALED (retval
))
574 int code
= WTERMSIG (retval
);
577 synchronize_system_messages_locale ();
578 signame
= strsignal (code
);
583 synch_process_death
= signame
;
586 reap_subprocess (cp
);
589 reap_subprocess (cp
);
594 /* Old versions of w32api headers don't have separate 32-bit and
595 64-bit defines, but the one they have matches the 32-bit variety. */
596 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
597 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
598 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
602 w32_executable_type (char * filename
, int * is_dos_app
, int * is_cygnus_app
, int * is_gui_app
)
604 file_data executable
;
607 /* Default values in case we can't tell for sure. */
609 *is_cygnus_app
= FALSE
;
612 if (!open_input_file (&executable
, filename
))
615 p
= strrchr (filename
, '.');
617 /* We can only identify DOS .com programs from the extension. */
618 if (p
&& stricmp (p
, ".com") == 0)
620 else if (p
&& (stricmp (p
, ".bat") == 0
621 || stricmp (p
, ".cmd") == 0))
623 /* A DOS shell script - it appears that CreateProcess is happy to
624 accept this (somewhat surprisingly); presumably it looks at
625 COMSPEC to determine what executable to actually invoke.
626 Therefore, we have to do the same here as well. */
627 /* Actually, I think it uses the program association for that
628 extension, which is defined in the registry. */
629 p
= egetenv ("COMSPEC");
631 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
635 /* Look for DOS .exe signature - if found, we must also check that
636 it isn't really a 16- or 32-bit Windows exe, since both formats
637 start with a DOS program stub. Note that 16-bit Windows
638 executables use the OS/2 1.x format. */
640 IMAGE_DOS_HEADER
* dos_header
;
641 IMAGE_NT_HEADERS
* nt_header
;
643 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
644 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
647 nt_header
= (PIMAGE_NT_HEADERS
) ((char *) dos_header
+ dos_header
->e_lfanew
);
649 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
651 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
654 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
655 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
659 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
661 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
662 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
664 /* Ensure we are using the 32 bit structure. */
665 IMAGE_OPTIONAL_HEADER32
*opt
666 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
667 data_dir
= opt
->DataDirectory
;
668 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
670 /* MingW 3.12 has the required 64 bit structs, but in case older
671 versions don't, only check 64 bit exes if we know how. */
672 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
673 else if (nt_header
->OptionalHeader
.Magic
674 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
676 IMAGE_OPTIONAL_HEADER64
*opt
677 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
678 data_dir
= opt
->DataDirectory
;
679 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
684 /* Look for cygwin.dll in DLL import list. */
685 IMAGE_DATA_DIRECTORY import_dir
=
686 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
687 IMAGE_IMPORT_DESCRIPTOR
* imports
;
688 IMAGE_SECTION_HEADER
* section
;
690 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
691 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
694 for ( ; imports
->Name
; imports
++)
696 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
699 /* The exact name of the cygwin dll has changed with
700 various releases, but hopefully this will be reasonably
702 if (strncmp (dllname
, "cygwin", 6) == 0)
704 *is_cygnus_app
= TRUE
;
713 close_file_data (&executable
);
717 compare_env (const void *strp1
, const void *strp2
)
719 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
721 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
723 /* Sort order in command.com/cmd.exe is based on uppercasing
724 names, so do the same here. */
725 if (toupper (*str1
) > toupper (*str2
))
727 else if (toupper (*str1
) < toupper (*str2
))
732 if (*str1
== '=' && *str2
== '=')
734 else if (*str1
== '=')
741 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
757 qsort (new_envp
, num
, sizeof (char *), compare_env
);
762 /* When a new child process is created we need to register it in our list,
763 so intercept spawn requests. */
765 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
767 Lisp_Object program
, full
;
768 char *cmdline
, *env
, *parg
, **targ
;
772 int is_dos_app
, is_cygnus_app
, is_gui_app
;
775 /* We pass our process ID to our children by setting up an environment
776 variable in their environment. */
777 char ppid_env_var_buffer
[64];
778 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
779 char *sepchars
= " \t";
781 /* We don't care about the other modes */
782 if (mode
!= _P_NOWAIT
)
788 /* Handle executable names without an executable suffix. */
789 program
= make_string (cmdname
, strlen (cmdname
));
790 if (NILP (Ffile_executable_p (program
)))
796 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
806 /* make sure argv[0] and cmdname are both in DOS format */
807 cmdname
= SDATA (program
);
808 unixtodos_filename (cmdname
);
811 /* Determine whether program is a 16-bit DOS executable, or a w32
812 executable that is implicitly linked to the Cygnus dll (implying it
813 was compiled with the Cygnus GNU toolchain and hence relies on
814 cygwin.dll to parse the command line - we use this to decide how to
815 escape quote chars in command line args that must be quoted).
817 Also determine whether it is a GUI app, so that we don't hide its
818 initial window unless specifically requested. */
819 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
821 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
822 application to start it by specifying the helper app as cmdname,
823 while leaving the real app name as argv[0]. */
826 cmdname
= alloca (MAXPATHLEN
);
827 if (egetenv ("CMDPROXY"))
828 strcpy (cmdname
, egetenv ("CMDPROXY"));
831 strcpy (cmdname
, SDATA (Vinvocation_directory
));
832 strcat (cmdname
, "cmdproxy.exe");
834 unixtodos_filename (cmdname
);
837 /* we have to do some conjuring here to put argv and envp into the
838 form CreateProcess wants... argv needs to be a space separated/null
839 terminated list of parameters, and envp is a null
840 separated/double-null terminated list of parameters.
842 Additionally, zero-length args and args containing whitespace or
843 quote chars need to be wrapped in double quotes - for this to work,
844 embedded quotes need to be escaped as well. The aim is to ensure
845 the child process reconstructs the argv array we start with
846 exactly, so we treat quotes at the beginning and end of arguments
849 The w32 GNU-based library from Cygnus doubles quotes to escape
850 them, while MSVC uses backslash for escaping. (Actually the MSVC
851 startup code does attempt to recognise doubled quotes and accept
852 them, but gets it wrong and ends up requiring three quotes to get a
853 single embedded quote!) So by default we decide whether to use
854 quote or backslash as the escape character based on whether the
855 binary is apparently a Cygnus compiled app.
857 Note that using backslash to escape embedded quotes requires
858 additional special handling if an embedded quote is already
859 preceeded by backslash, or if an arg requiring quoting ends with
860 backslash. In such cases, the run of escape characters needs to be
861 doubled. For consistency, we apply this special handling as long
862 as the escape character is not quote.
864 Since we have no idea how large argv and envp are likely to be we
865 figure out list lengths on the fly and allocate them. */
867 if (!NILP (Vw32_quote_process_args
))
870 /* Override escape char by binding w32-quote-process-args to
871 desired character, or use t for auto-selection. */
872 if (INTEGERP (Vw32_quote_process_args
))
873 escape_char
= XINT (Vw32_quote_process_args
);
875 escape_char
= is_cygnus_app
? '"' : '\\';
878 /* Cygwin apps needs quoting a bit more often */
879 if (escape_char
== '"')
880 sepchars
= "\r\n\t\f '";
889 int escape_char_run
= 0;
895 if (escape_char
== '"' && *p
== '\\')
896 /* If it's a Cygwin app, \ needs to be escaped. */
900 /* allow for embedded quotes to be escaped */
903 /* handle the case where the embedded quote is already escaped */
904 if (escape_char_run
> 0)
906 /* To preserve the arg exactly, we need to double the
907 preceding escape characters (plus adding one to
908 escape the quote character itself). */
909 arglen
+= escape_char_run
;
912 else if (strchr (sepchars
, *p
) != NULL
)
917 if (*p
== escape_char
&& escape_char
!= '"')
925 /* handle the case where the arg ends with an escape char - we
926 must not let the enclosing quote be escaped. */
927 if (escape_char_run
> 0)
928 arglen
+= escape_char_run
;
930 arglen
+= strlen (*targ
++) + 1;
932 cmdline
= alloca (arglen
);
946 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
951 int escape_char_run
= 0;
957 last
= p
+ strlen (p
) - 1;
960 /* This version does not escape quotes if they occur at the
961 beginning or end of the arg - this could lead to incorrect
962 behaviour when the arg itself represents a command line
963 containing quoted args. I believe this was originally done
964 as a hack to make some things work, before
965 `w32-quote-process-args' was added. */
968 if (*p
== '"' && p
> first
&& p
< last
)
969 *parg
++ = escape_char
; /* escape embedded quotes */
977 /* double preceding escape chars if any */
978 while (escape_char_run
> 0)
980 *parg
++ = escape_char
;
983 /* escape all quote chars, even at beginning or end */
984 *parg
++ = escape_char
;
986 else if (escape_char
== '"' && *p
== '\\')
990 if (*p
== escape_char
&& escape_char
!= '"')
995 /* double escape chars before enclosing quote */
996 while (escape_char_run
> 0)
998 *parg
++ = escape_char
;
1006 strcpy (parg
, *targ
);
1007 parg
+= strlen (*targ
);
1017 numenv
= 1; /* for end null */
1020 arglen
+= strlen (*targ
++) + 1;
1023 /* extra env vars... */
1024 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%d",
1025 GetCurrentProcessId ());
1026 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1029 /* merge env passed in and extra env into one, and sort it. */
1030 targ
= (char **) alloca (numenv
* sizeof (char *));
1031 merge_and_sort_env (envp
, extra_env
, targ
);
1033 /* concatenate env entries. */
1034 env
= alloca (arglen
);
1038 strcpy (parg
, *targ
);
1039 parg
+= strlen (*targ
++);
1052 /* Now create the process. */
1053 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1063 /* Emulate the select call
1064 Wait for available input on any of the given rfds, or timeout if
1065 a timeout is given and no input is detected
1066 wfds and efds are not supported and must be NULL.
1068 For simplicity, we detect the death of child processes here and
1069 synchronously call the SIGCHLD handler. Since it is possible for
1070 children to be created without a corresponding pipe handle from which
1071 to read output, we wait separately on the process handles as well as
1072 the char_avail events for each process pipe. We only call
1073 wait/reap_process when the process actually terminates.
1075 To reduce the number of places in which Emacs can be hung such that
1076 C-g is not able to interrupt it, we always wait on interrupt_handle
1077 (which is signalled by the input thread when C-g is detected). If we
1078 detect that we were woken up by C-g, we return -1 with errno set to
1079 EINTR as on Unix. */
1082 extern HANDLE keyboard_handle
;
1084 /* From w32xfns.c */
1085 extern HANDLE interrupt_handle
;
1087 /* From process.c */
1088 extern int proc_buffered_char
[];
1091 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1092 EMACS_TIME
*timeout
)
1095 DWORD timeout_ms
, start_time
;
1098 child_process
*cp
, *cps
[MAX_CHILDREN
];
1099 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1100 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1102 timeout_ms
= timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_usec
/ 1000) : INFINITE
;
1104 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1105 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1111 /* Otherwise, we only handle rfds, so fail otherwise. */
1112 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1122 /* Always wait on interrupt_handle, to detect C-g (quit). */
1123 wait_hnd
[0] = interrupt_handle
;
1126 /* Build a list of pipe handles to wait on. */
1128 for (i
= 0; i
< nfds
; i
++)
1129 if (FD_ISSET (i
, &orfds
))
1133 if (keyboard_handle
)
1135 /* Handle stdin specially */
1136 wait_hnd
[nh
] = keyboard_handle
;
1141 /* Check for any emacs-generated input in the queue since
1142 it won't be detected in the wait */
1143 if (detect_input_pending ())
1151 /* Child process and socket input */
1155 int current_status
= cp
->status
;
1157 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1159 /* Tell reader thread which file handle to use. */
1161 /* Wake up the reader thread for this process */
1162 cp
->status
= STATUS_READ_READY
;
1163 if (!SetEvent (cp
->char_consumed
))
1164 DebPrint (("nt_select.SetEvent failed with "
1165 "%lu for fd %ld\n", GetLastError (), i
));
1168 #ifdef CHECK_INTERLOCK
1169 /* slightly crude cross-checking of interlock between threads */
1171 current_status
= cp
->status
;
1172 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1174 /* char_avail has been signalled, so status (which may
1175 have changed) should indicate read has completed
1176 but has not been acknowledged. */
1177 current_status
= cp
->status
;
1178 if (current_status
!= STATUS_READ_SUCCEEDED
1179 && current_status
!= STATUS_READ_FAILED
)
1180 DebPrint (("char_avail set, but read not completed: status %d\n",
1185 /* char_avail has not been signalled, so status should
1186 indicate that read is in progress; small possibility
1187 that read has completed but event wasn't yet signalled
1188 when we tested it (because a context switch occurred
1189 or if running on separate CPUs). */
1190 if (current_status
!= STATUS_READ_READY
1191 && current_status
!= STATUS_READ_IN_PROGRESS
1192 && current_status
!= STATUS_READ_SUCCEEDED
1193 && current_status
!= STATUS_READ_FAILED
)
1194 DebPrint (("char_avail reset, but read status is bad: %d\n",
1198 wait_hnd
[nh
] = cp
->char_avail
;
1200 if (!wait_hnd
[nh
]) abort ();
1203 DebPrint (("select waiting on child %d fd %d\n",
1204 cp
-child_procs
, i
));
1209 /* Unable to find something to wait on for this fd, skip */
1211 /* Note that this is not a fatal error, and can in fact
1212 happen in unusual circumstances. Specifically, if
1213 sys_spawnve fails, eg. because the program doesn't
1214 exist, and debug-on-error is t so Fsignal invokes a
1215 nested input loop, then the process output pipe is
1216 still included in input_wait_mask with no child_proc
1217 associated with it. (It is removed when the debugger
1218 exits the nested input loop and the error is thrown.) */
1220 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
1226 /* Add handles of child processes. */
1228 for (cp
= child_procs
+(child_proc_count
-1); cp
>= child_procs
; cp
--)
1229 /* Some child_procs might be sockets; ignore them. Also some
1230 children may have died already, but we haven't finished reading
1231 the process output; ignore them too. */
1232 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1234 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
1235 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1238 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
1243 /* Nothing to look for, so we didn't find anything */
1251 start_time
= GetTickCount ();
1253 /* Wait for input or child death to be signalled. If user input is
1254 allowed, then also accept window messages. */
1255 if (FD_ISSET (0, &orfds
))
1256 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
1259 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
1261 if (active
== WAIT_FAILED
)
1263 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1264 nh
+ nc
, timeout_ms
, GetLastError ()));
1265 /* don't return EBADF - this causes wait_reading_process_output to
1266 abort; WAIT_FAILED is returned when single-stepping under
1267 Windows 95 after switching thread focus in debugger, and
1268 possibly at other times. */
1272 else if (active
== WAIT_TIMEOUT
)
1276 else if (active
>= WAIT_OBJECT_0
1277 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1279 active
-= WAIT_OBJECT_0
;
1281 else if (active
>= WAIT_ABANDONED_0
1282 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1284 active
-= WAIT_ABANDONED_0
;
1289 /* Loop over all handles after active (now officially documented as
1290 being the first signalled handle in the array). We do this to
1291 ensure fairness, so that all channels with data available will be
1292 processed - otherwise higher numbered channels could be starved. */
1295 if (active
== nh
+ nc
)
1297 /* There are messages in the lisp thread's queue; we must
1298 drain the queue now to ensure they are processed promptly,
1299 because if we don't do so, we will not be woken again until
1300 further messages arrive.
1302 NB. If ever we allow window message procedures to callback
1303 into lisp, we will need to ensure messages are dispatched
1304 at a safe time for lisp code to be run (*), and we may also
1305 want to provide some hooks in the dispatch loop to cater
1306 for modeless dialogs created by lisp (ie. to register
1307 window handles to pass to IsDialogMessage).
1309 (*) Note that MsgWaitForMultipleObjects above is an
1310 internal dispatch point for messages that are sent to
1311 windows created by this thread. */
1312 drain_message_queue ();
1314 else if (active
>= nh
)
1316 cp
= cps
[active
- nh
];
1318 /* We cannot always signal SIGCHLD immediately; if we have not
1319 finished reading the process output, we must delay sending
1320 SIGCHLD until we do. */
1322 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
1323 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
1324 /* SIG_DFL for SIGCHLD is ignore */
1325 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
1326 sig_handlers
[SIGCHLD
] != SIG_IGN
)
1329 DebPrint (("select calling SIGCHLD handler for pid %d\n",
1333 sig_handlers
[SIGCHLD
] (SIGCHLD
);
1337 else if (fdindex
[active
] == -1)
1339 /* Quit (C-g) was detected. */
1343 else if (fdindex
[active
] == 0)
1345 /* Keyboard input available */
1351 /* must be a socket or pipe - read ahead should have
1352 completed, either succeeding or failing. */
1353 FD_SET (fdindex
[active
], rfds
);
1357 /* Even though wait_reading_process_output only reads from at most
1358 one channel, we must process all channels here so that we reap
1359 all children that have died. */
1360 while (++active
< nh
+ nc
)
1361 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
1363 } while (active
< nh
+ nc
);
1365 /* If no input has arrived and timeout hasn't expired, wait again. */
1368 DWORD elapsed
= GetTickCount () - start_time
;
1370 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
1372 if (timeout_ms
!= INFINITE
)
1373 timeout_ms
-= elapsed
;
1374 goto count_children
;
1381 /* Substitute for certain kill () operations */
1383 static BOOL CALLBACK
1384 find_child_console (HWND hwnd
, LPARAM arg
)
1386 child_process
* cp
= (child_process
*) arg
;
1390 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
1391 if (process_id
== cp
->procinfo
.dwProcessId
)
1393 char window_class
[32];
1395 GetClassName (hwnd
, window_class
, sizeof (window_class
));
1396 if (strcmp (window_class
,
1397 (os_subtype
== OS_WIN95
)
1399 : "ConsoleWindowClass") == 0)
1410 sys_kill (int pid
, int sig
)
1414 int need_to_free
= 0;
1417 /* Only handle signals that will result in the process dying */
1418 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
1424 cp
= find_child_pid (pid
);
1427 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
1428 if (proc_hand
== NULL
)
1437 proc_hand
= cp
->procinfo
.hProcess
;
1438 pid
= cp
->procinfo
.dwProcessId
;
1440 /* Try to locate console window for process. */
1441 EnumWindows (find_child_console
, (LPARAM
) cp
);
1444 if (sig
== SIGINT
|| sig
== SIGQUIT
)
1446 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
1448 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
1449 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
1450 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
1451 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
1452 HWND foreground_window
;
1454 if (break_scan_code
== 0)
1456 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
1457 vk_break_code
= 'C';
1458 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
1461 foreground_window
= GetForegroundWindow ();
1462 if (foreground_window
)
1464 /* NT 5.0, and apparently also Windows 98, will not allow
1465 a Window to be set to foreground directly without the
1466 user's involvement. The workaround is to attach
1467 ourselves to the thread that owns the foreground
1468 window, since that is the only thread that can set the
1469 foreground window. */
1470 DWORD foreground_thread
, child_thread
;
1472 GetWindowThreadProcessId (foreground_window
, NULL
);
1473 if (foreground_thread
== GetCurrentThreadId ()
1474 || !AttachThreadInput (GetCurrentThreadId (),
1475 foreground_thread
, TRUE
))
1476 foreground_thread
= 0;
1478 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
1479 if (child_thread
== GetCurrentThreadId ()
1480 || !AttachThreadInput (GetCurrentThreadId (),
1481 child_thread
, TRUE
))
1484 /* Set the foreground window to the child. */
1485 if (SetForegroundWindow (cp
->hwnd
))
1487 /* Generate keystrokes as if user had typed Ctrl-Break or
1489 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
1490 keybd_event (vk_break_code
, break_scan_code
,
1491 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
1492 keybd_event (vk_break_code
, break_scan_code
,
1493 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
1494 | KEYEVENTF_KEYUP
, 0);
1495 keybd_event (VK_CONTROL
, control_scan_code
,
1496 KEYEVENTF_KEYUP
, 0);
1498 /* Sleep for a bit to give time for Emacs frame to respond
1499 to focus change events (if Emacs was active app). */
1502 SetForegroundWindow (foreground_window
);
1504 /* Detach from the foreground and child threads now that
1505 the foreground switching is over. */
1506 if (foreground_thread
)
1507 AttachThreadInput (GetCurrentThreadId (),
1508 foreground_thread
, FALSE
);
1510 AttachThreadInput (GetCurrentThreadId (),
1511 child_thread
, FALSE
);
1514 /* Ctrl-Break is NT equivalent of SIGINT. */
1515 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
1517 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
1518 "for pid %lu\n", GetLastError (), pid
));
1525 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
1528 if (os_subtype
== OS_WIN95
)
1531 Another possibility is to try terminating the VDM out-right by
1532 calling the Shell VxD (id 0x17) V86 interface, function #4
1533 "SHELL_Destroy_VM", ie.
1539 First need to determine the current VM handle, and then arrange for
1540 the shellapi call to be made from the system vm (by using
1541 Switch_VM_and_callback).
1543 Could try to invoke DestroyVM through CallVxD.
1547 /* On Win95, posting WM_QUIT causes the 16-bit subsystem
1548 to hang when cmdproxy is used in conjunction with
1549 command.com for an interactive shell. Posting
1550 WM_CLOSE pops up a dialog that, when Yes is selected,
1551 does the same thing. TerminateProcess is also less
1552 than ideal in that subprocesses tend to stick around
1553 until the machine is shutdown, but at least it
1554 doesn't freeze the 16-bit subsystem. */
1555 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
1557 if (!TerminateProcess (proc_hand
, 0xff))
1559 DebPrint (("sys_kill.TerminateProcess returned %d "
1560 "for pid %lu\n", GetLastError (), pid
));
1567 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
1569 /* Kill the process. On W32 this doesn't kill child processes
1570 so it doesn't work very well for shells which is why it's not
1571 used in every case. */
1572 else if (!TerminateProcess (proc_hand
, 0xff))
1574 DebPrint (("sys_kill.TerminateProcess returned %d "
1575 "for pid %lu\n", GetLastError (), pid
));
1582 CloseHandle (proc_hand
);
1587 /* extern int report_file_error (char *, Lisp_Object); */
1589 /* The following two routines are used to manipulate stdin, stdout, and
1590 stderr of our child processes.
1592 Assuming that in, out, and err are *not* inheritable, we make them
1593 stdin, stdout, and stderr of the child as follows:
1595 - Save the parent's current standard handles.
1596 - Set the std handles to inheritable duplicates of the ones being passed in.
1597 (Note that _get_osfhandle() is an io.h procedure that retrieves the
1598 NT file handle for a crt file descriptor.)
1599 - Spawn the child, which inherits in, out, and err as stdin,
1600 stdout, and stderr. (see Spawnve)
1601 - Close the std handles passed to the child.
1602 - Reset the parent's standard handles to the saved handles.
1603 (see reset_standard_handles)
1604 We assume that the caller closes in, out, and err after calling us. */
1607 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
1610 HANDLE newstdin
, newstdout
, newstderr
;
1612 parent
= GetCurrentProcess ();
1614 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
1615 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
1616 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
1618 /* make inheritable copies of the new handles */
1619 if (!DuplicateHandle (parent
,
1620 (HANDLE
) _get_osfhandle (in
),
1625 DUPLICATE_SAME_ACCESS
))
1626 report_file_error ("Duplicating input handle for child", Qnil
);
1628 if (!DuplicateHandle (parent
,
1629 (HANDLE
) _get_osfhandle (out
),
1634 DUPLICATE_SAME_ACCESS
))
1635 report_file_error ("Duplicating output handle for child", Qnil
);
1637 if (!DuplicateHandle (parent
,
1638 (HANDLE
) _get_osfhandle (err
),
1643 DUPLICATE_SAME_ACCESS
))
1644 report_file_error ("Duplicating error handle for child", Qnil
);
1646 /* and store them as our std handles */
1647 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
1648 report_file_error ("Changing stdin handle", Qnil
);
1650 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
1651 report_file_error ("Changing stdout handle", Qnil
);
1653 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
1654 report_file_error ("Changing stderr handle", Qnil
);
1658 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
1660 /* close the duplicated handles passed to the child */
1661 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
1662 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
1663 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
1665 /* now restore parent's saved std handles */
1666 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
1667 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
1668 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
1672 set_process_dir (char * dir
)
1679 /* To avoid problems with winsock implementations that work over dial-up
1680 connections causing or requiring a connection to exist while Emacs is
1681 running, Emacs no longer automatically loads winsock on startup if it
1682 is present. Instead, it will be loaded when open-network-stream is
1685 To allow full control over when winsock is loaded, we provide these
1686 two functions to dynamically load and unload winsock. This allows
1687 dial-up users to only be connected when they actually need to use
1691 extern HANDLE winsock_lib
;
1692 extern BOOL
term_winsock (void);
1693 extern BOOL
init_winsock (int load_now
);
1695 extern Lisp_Object Vsystem_name
;
1697 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
1698 doc
: /* Test for presence of the Windows socket library `winsock'.
1699 Returns non-nil if winsock support is present, nil otherwise.
1701 If the optional argument LOAD-NOW is non-nil, the winsock library is
1702 also loaded immediately if not already loaded. If winsock is loaded,
1703 the winsock local hostname is returned (since this may be different from
1704 the value of `system-name' and should supplant it), otherwise t is
1705 returned to indicate winsock support is present. */)
1707 Lisp_Object load_now
;
1711 have_winsock
= init_winsock (!NILP (load_now
));
1714 if (winsock_lib
!= NULL
)
1716 /* Return new value for system-name. The best way to do this
1717 is to call init_system_name, saving and restoring the
1718 original value to avoid side-effects. */
1719 Lisp_Object orig_hostname
= Vsystem_name
;
1720 Lisp_Object hostname
;
1722 init_system_name ();
1723 hostname
= Vsystem_name
;
1724 Vsystem_name
= orig_hostname
;
1732 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
1734 doc
: /* Unload the Windows socket library `winsock' if loaded.
1735 This is provided to allow dial-up socket connections to be disconnected
1736 when no longer needed. Returns nil without unloading winsock if any
1737 socket connections still exist. */)
1740 return term_winsock () ? Qt
: Qnil
;
1743 #endif /* HAVE_SOCKETS */
1746 /* Some miscellaneous functions that are Windows specific, but not GUI
1747 specific (ie. are applicable in terminal or batch mode as well). */
1749 /* lifted from fileio.c */
1750 #define CORRECT_DIR_SEPS(s) \
1751 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
1752 else unixtodos_filename (s); \
1755 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
1756 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
1757 If FILENAME does not exist, return nil.
1758 All path elements in FILENAME are converted to their short names. */)
1760 Lisp_Object filename
;
1762 char shortname
[MAX_PATH
];
1764 CHECK_STRING (filename
);
1766 /* first expand it. */
1767 filename
= Fexpand_file_name (filename
, Qnil
);
1769 /* luckily, this returns the short version of each element in the path. */
1770 if (GetShortPathName (SDATA (filename
), shortname
, MAX_PATH
) == 0)
1773 CORRECT_DIR_SEPS (shortname
);
1775 return build_string (shortname
);
1779 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
1781 doc
: /* Return the long file name version of the full path of FILENAME.
1782 If FILENAME does not exist, return nil.
1783 All path elements in FILENAME are converted to their long names. */)
1785 Lisp_Object filename
;
1787 char longname
[ MAX_PATH
];
1789 CHECK_STRING (filename
);
1791 /* first expand it. */
1792 filename
= Fexpand_file_name (filename
, Qnil
);
1794 if (!w32_get_long_filename (SDATA (filename
), longname
, MAX_PATH
))
1797 CORRECT_DIR_SEPS (longname
);
1799 return build_string (longname
);
1802 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
1803 Sw32_set_process_priority
, 2, 2, 0,
1804 doc
: /* Set the priority of PROCESS to PRIORITY.
1805 If PROCESS is nil, the priority of Emacs is changed, otherwise the
1806 priority of the process whose pid is PROCESS is changed.
1807 PRIORITY should be one of the symbols high, normal, or low;
1808 any other symbol will be interpreted as normal.
1810 If successful, the return value is t, otherwise nil. */)
1812 Lisp_Object process
, priority
;
1814 HANDLE proc_handle
= GetCurrentProcess ();
1815 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
1816 Lisp_Object result
= Qnil
;
1818 CHECK_SYMBOL (priority
);
1820 if (!NILP (process
))
1825 CHECK_NUMBER (process
);
1827 /* Allow pid to be an internally generated one, or one obtained
1828 externally. This is necessary because real pids on Win95 are
1831 pid
= XINT (process
);
1832 cp
= find_child_pid (pid
);
1834 pid
= cp
->procinfo
.dwProcessId
;
1836 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
1839 if (EQ (priority
, Qhigh
))
1840 priority_class
= HIGH_PRIORITY_CLASS
;
1841 else if (EQ (priority
, Qlow
))
1842 priority_class
= IDLE_PRIORITY_CLASS
;
1844 if (proc_handle
!= NULL
)
1846 if (SetPriorityClass (proc_handle
, priority_class
))
1848 if (!NILP (process
))
1849 CloseHandle (proc_handle
);
1855 #ifdef HAVE_LANGINFO_CODESET
1856 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
1857 char *nl_langinfo (nl_item item
)
1859 /* Conversion of Posix item numbers to their Windows equivalents. */
1860 static const LCTYPE w32item
[] = {
1861 LOCALE_IDEFAULTANSICODEPAGE
,
1862 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
1863 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
1864 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
1865 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
1866 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
1867 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
1870 static char *nl_langinfo_buf
= NULL
;
1871 static int nl_langinfo_len
= 0;
1873 if (nl_langinfo_len
<= 0)
1874 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
1876 if (item
< 0 || item
>= _NL_NUM
)
1877 nl_langinfo_buf
[0] = 0;
1880 LCID cloc
= GetThreadLocale ();
1881 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
1885 nl_langinfo_buf
[0] = 0;
1888 if (item
== CODESET
)
1890 need_len
+= 2; /* for the "cp" prefix */
1891 if (need_len
< 8) /* for the case we call GetACP */
1894 if (nl_langinfo_len
<= need_len
)
1895 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
1896 nl_langinfo_len
= need_len
);
1897 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
1898 nl_langinfo_buf
, nl_langinfo_len
))
1899 nl_langinfo_buf
[0] = 0;
1900 else if (item
== CODESET
)
1902 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
1903 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
1904 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
1907 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
1908 strlen (nl_langinfo_buf
) + 1);
1909 nl_langinfo_buf
[0] = 'c';
1910 nl_langinfo_buf
[1] = 'p';
1915 return nl_langinfo_buf
;
1917 #endif /* HAVE_LANGINFO_CODESET */
1919 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
1920 Sw32_get_locale_info
, 1, 2, 0,
1921 doc
: /* Return information about the Windows locale LCID.
1922 By default, return a three letter locale code which encodes the default
1923 language as the first two characters, and the country or regionial variant
1924 as the third letter. For example, ENU refers to `English (United States)',
1925 while ENC means `English (Canadian)'.
1927 If the optional argument LONGFORM is t, the long form of the locale
1928 name is returned, e.g. `English (United States)' instead; if LONGFORM
1929 is a number, it is interpreted as an LCTYPE constant and the corresponding
1930 locale information is returned.
1932 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
1934 Lisp_Object lcid
, longform
;
1938 char abbrev_name
[32] = { 0 };
1939 char full_name
[256] = { 0 };
1941 CHECK_NUMBER (lcid
);
1943 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
1946 if (NILP (longform
))
1948 got_abbrev
= GetLocaleInfo (XINT (lcid
),
1949 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
1950 abbrev_name
, sizeof (abbrev_name
));
1952 return build_string (abbrev_name
);
1954 else if (EQ (longform
, Qt
))
1956 got_full
= GetLocaleInfo (XINT (lcid
),
1957 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
1958 full_name
, sizeof (full_name
));
1960 return build_string (full_name
);
1962 else if (NUMBERP (longform
))
1964 got_full
= GetLocaleInfo (XINT (lcid
),
1966 full_name
, sizeof (full_name
));
1968 return make_unibyte_string (full_name
, got_full
);
1975 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
1976 Sw32_get_current_locale_id
, 0, 0, 0,
1977 doc
: /* Return Windows locale id for current locale setting.
1978 This is a numerical value; use `w32-get-locale-info' to convert to a
1979 human-readable form. */)
1982 return make_number (GetThreadLocale ());
1985 DWORD
int_from_hex (char * s
)
1988 static char hex
[] = "0123456789abcdefABCDEF";
1991 while (*s
&& (p
= strchr(hex
, *s
)) != NULL
)
1993 unsigned digit
= p
- hex
;
1996 val
= val
* 16 + digit
;
2002 /* We need to build a global list, since the EnumSystemLocale callback
2003 function isn't given a context pointer. */
2004 Lisp_Object Vw32_valid_locale_ids
;
2006 BOOL CALLBACK
enum_locale_fn (LPTSTR localeNum
)
2008 DWORD id
= int_from_hex (localeNum
);
2009 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2013 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2014 Sw32_get_valid_locale_ids
, 0, 0, 0,
2015 doc
: /* Return list of all valid Windows locale ids.
2016 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2017 human-readable form. */)
2020 Vw32_valid_locale_ids
= Qnil
;
2022 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2024 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2025 return Vw32_valid_locale_ids
;
2029 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2030 doc
: /* Return Windows locale id for default locale setting.
2031 By default, the system default locale setting is returned; if the optional
2032 parameter USERP is non-nil, the user default locale setting is returned.
2033 This is a numerical value; use `w32-get-locale-info' to convert to a
2034 human-readable form. */)
2039 return make_number (GetSystemDefaultLCID ());
2040 return make_number (GetUserDefaultLCID ());
2044 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2045 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2046 If successful, the new locale id is returned, otherwise nil. */)
2050 CHECK_NUMBER (lcid
);
2052 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2055 if (!SetThreadLocale (XINT (lcid
)))
2058 /* Need to set input thread locale if present. */
2059 if (dwWindowsThreadId
)
2060 /* Reply is not needed. */
2061 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2063 return make_number (GetThreadLocale ());
2067 /* We need to build a global list, since the EnumCodePages callback
2068 function isn't given a context pointer. */
2069 Lisp_Object Vw32_valid_codepages
;
2071 BOOL CALLBACK
enum_codepage_fn (LPTSTR codepageNum
)
2073 DWORD id
= atoi (codepageNum
);
2074 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2078 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2079 Sw32_get_valid_codepages
, 0, 0, 0,
2080 doc
: /* Return list of all valid Windows codepages. */)
2083 Vw32_valid_codepages
= Qnil
;
2085 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2087 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2088 return Vw32_valid_codepages
;
2092 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2093 Sw32_get_console_codepage
, 0, 0, 0,
2094 doc
: /* Return current Windows codepage for console input. */)
2097 return make_number (GetConsoleCP ());
2101 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2102 Sw32_set_console_codepage
, 1, 1, 0,
2103 doc
: /* Make Windows codepage CP be the current codepage setting for Emacs.
2104 The codepage setting affects keyboard input and display in tty mode.
2105 If successful, the new CP is returned, otherwise nil. */)
2111 if (!IsValidCodePage (XINT (cp
)))
2114 if (!SetConsoleCP (XINT (cp
)))
2117 return make_number (GetConsoleCP ());
2121 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2122 Sw32_get_console_output_codepage
, 0, 0, 0,
2123 doc
: /* Return current Windows codepage for console output. */)
2126 return make_number (GetConsoleOutputCP ());
2130 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2131 Sw32_set_console_output_codepage
, 1, 1, 0,
2132 doc
: /* Make Windows codepage CP be the current codepage setting for Emacs.
2133 The codepage setting affects keyboard input and display in tty mode.
2134 If successful, the new CP is returned, otherwise nil. */)
2140 if (!IsValidCodePage (XINT (cp
)))
2143 if (!SetConsoleOutputCP (XINT (cp
)))
2146 return make_number (GetConsoleOutputCP ());
2150 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2151 Sw32_get_codepage_charset
, 1, 1, 0,
2152 doc
: /* Return charset of codepage CP.
2153 Returns nil if the codepage is not valid. */)
2161 if (!IsValidCodePage (XINT (cp
)))
2164 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2165 return make_number (info
.ciCharset
);
2171 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2172 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2173 doc
: /* Return list of Windows keyboard languages and layouts.
2174 The return value is a list of pairs of language id and layout id. */)
2177 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2178 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2179 Lisp_Object obj
= Qnil
;
2181 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2183 while (--num_layouts
>= 0)
2185 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2187 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2188 make_number ((kl
>> 16) & 0xffff)),
2197 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2198 Sw32_get_keyboard_layout
, 0, 0, 0,
2199 doc
: /* Return current Windows keyboard language and layout.
2200 The return value is the cons of the language id and the layout id. */)
2203 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
2205 return Fcons (make_number (kl
& 0xffff),
2206 make_number ((kl
>> 16) & 0xffff));
2210 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
2211 Sw32_set_keyboard_layout
, 1, 1, 0,
2212 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
2213 The keyboard layout setting affects interpretation of keyboard input.
2214 If successful, the new layout id is returned, otherwise nil. */)
2220 CHECK_CONS (layout
);
2221 CHECK_NUMBER_CAR (layout
);
2222 CHECK_NUMBER_CDR (layout
);
2224 kl
= (XINT (XCAR (layout
)) & 0xffff)
2225 | (XINT (XCDR (layout
)) << 16);
2227 /* Synchronize layout with input thread. */
2228 if (dwWindowsThreadId
)
2230 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
2234 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
2236 if (msg
.wParam
== 0)
2240 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
2243 return Fw32_get_keyboard_layout ();
2249 DEFSYM (Qhigh
, "high");
2250 DEFSYM (Qlow
, "low");
2253 defsubr (&Sw32_has_winsock
);
2254 defsubr (&Sw32_unload_winsock
);
2256 defsubr (&Sw32_short_file_name
);
2257 defsubr (&Sw32_long_file_name
);
2258 defsubr (&Sw32_set_process_priority
);
2259 defsubr (&Sw32_get_locale_info
);
2260 defsubr (&Sw32_get_current_locale_id
);
2261 defsubr (&Sw32_get_default_locale_id
);
2262 defsubr (&Sw32_get_valid_locale_ids
);
2263 defsubr (&Sw32_set_current_locale
);
2265 defsubr (&Sw32_get_console_codepage
);
2266 defsubr (&Sw32_set_console_codepage
);
2267 defsubr (&Sw32_get_console_output_codepage
);
2268 defsubr (&Sw32_set_console_output_codepage
);
2269 defsubr (&Sw32_get_valid_codepages
);
2270 defsubr (&Sw32_get_codepage_charset
);
2272 defsubr (&Sw32_get_valid_keyboard_layouts
);
2273 defsubr (&Sw32_get_keyboard_layout
);
2274 defsubr (&Sw32_set_keyboard_layout
);
2276 DEFVAR_LISP ("w32-quote-process-args", &Vw32_quote_process_args
,
2277 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
2278 Because Windows does not directly pass argv arrays to child processes,
2279 programs have to reconstruct the argv array by parsing the command
2280 line string. For an argument to contain a space, it must be enclosed
2281 in double quotes or it will be parsed as multiple arguments.
2283 If the value is a character, that character will be used to escape any
2284 quote characters that appear, otherwise a suitable escape character
2285 will be chosen based on the type of the program. */);
2286 Vw32_quote_process_args
= Qt
;
2288 DEFVAR_LISP ("w32-start-process-show-window",
2289 &Vw32_start_process_show_window
,
2290 doc
: /* When nil, new child processes hide their windows.
2291 When non-nil, they show their window in the method of their choice.
2292 This variable doesn't affect GUI applications, which will never be hidden. */);
2293 Vw32_start_process_show_window
= Qnil
;
2295 DEFVAR_LISP ("w32-start-process-share-console",
2296 &Vw32_start_process_share_console
,
2297 doc
: /* When nil, new child processes are given a new console.
2298 When non-nil, they share the Emacs console; this has the limitation of
2299 allowing only one DOS subprocess to run at a time (whether started directly
2300 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
2301 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
2302 otherwise respond to interrupts from Emacs. */);
2303 Vw32_start_process_share_console
= Qnil
;
2305 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
2306 &Vw32_start_process_inherit_error_mode
,
2307 doc
: /* When nil, new child processes revert to the default error mode.
2308 When non-nil, they inherit their error mode setting from Emacs, which stops
2309 them blocking when trying to access unmounted drives etc. */);
2310 Vw32_start_process_inherit_error_mode
= Qt
;
2312 DEFVAR_INT ("w32-pipe-read-delay", &w32_pipe_read_delay
,
2313 doc
: /* Forced delay before reading subprocess output.
2314 This is done to improve the buffering of subprocess output, by
2315 avoiding the inefficiency of frequently reading small amounts of data.
2317 If positive, the value is the number of milliseconds to sleep before
2318 reading the subprocess output. If negative, the magnitude is the number
2319 of time slices to wait (effectively boosting the priority of the child
2320 process temporarily). A value of zero disables waiting entirely. */);
2321 w32_pipe_read_delay
= 50;
2323 DEFVAR_LISP ("w32-downcase-file-names", &Vw32_downcase_file_names
,
2324 doc
: /* Non-nil means convert all-upper case file names to lower case.
2325 This applies when performing completions and file name expansion.
2326 Note that the value of this setting also affects remote file names,
2327 so you probably don't want to set to non-nil if you use case-sensitive
2328 filesystems via ange-ftp. */);
2329 Vw32_downcase_file_names
= Qnil
;
2332 DEFVAR_LISP ("w32-generate-fake-inodes", &Vw32_generate_fake_inodes
,
2333 doc
: /* Non-nil means attempt to fake realistic inode values.
2334 This works by hashing the truename of files, and should detect
2335 aliasing between long and short (8.3 DOS) names, but can have
2336 false positives because of hash collisions. Note that determing
2337 the truename of a file can be slow. */);
2338 Vw32_generate_fake_inodes
= Qnil
;
2341 DEFVAR_LISP ("w32-get-true-file-attributes", &Vw32_get_true_file_attributes
,
2342 doc
: /* Non-nil means determine accurate link count in `file-attributes'.
2343 Note that this option is only useful for files on NTFS volumes, where hard links
2344 are supported. Moreover, it slows down `file-attributes' noticeably. */);
2345 Vw32_get_true_file_attributes
= Qt
;
2347 staticpro (&Vw32_valid_locale_ids
);
2348 staticpro (&Vw32_valid_codepages
);
2350 /* end of ntproc.c */
2352 /* arch-tag: 23d3a34c-06d2-48a1-833b-ac7609aa5250
2353 (do not change this comment) */