1 /* Process support for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1992, 1995, 1999-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 Drew Bliss Oct 14, 1993
21 Adapted from alarm.c by Tim Fleehart
33 /* must include CRT headers *before* config.h */
44 /* This definition is missing from mingw32 headers. */
45 extern BOOL WINAPI
IsValidLocale (LCID
, DWORD
);
48 #ifdef HAVE_LANGINFO_CODESET
59 #include "syssignal.h"
61 #include "dispextern.h" /* for xstrcasecmp */
64 #define RVA_TO_PTR(var,section,filedata) \
65 ((void *)((section)->PointerToRawData \
66 + ((DWORD)(var) - (section)->VirtualAddress) \
67 + (filedata).file_base))
69 Lisp_Object Qhigh
, Qlow
;
73 _DebPrint (const char *fmt
, ...)
79 vsprintf (buf
, fmt
, args
);
81 OutputDebugString (buf
);
85 typedef void (_CALLBACK_
*signal_handler
) (int);
87 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
88 static signal_handler sig_handlers
[NSIG
];
90 /* Fake signal implementation to record the SIGCHLD handler. */
92 sys_signal (int sig
, signal_handler handler
)
101 old
= sig_handlers
[sig
];
102 sig_handlers
[sig
] = handler
;
106 /* Defined in <process.h> which conflicts with the local copy */
109 /* Child process management list. */
110 int child_proc_count
= 0;
111 child_process child_procs
[ MAX_CHILDREN
];
112 child_process
*dead_child
= NULL
;
114 static DWORD WINAPI
reader_thread (void *arg
);
116 /* Find an unused process slot. */
123 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
124 if (!CHILD_ACTIVE (cp
))
126 if (child_proc_count
== MAX_CHILDREN
)
128 cp
= &child_procs
[child_proc_count
++];
131 memset (cp
, 0, sizeof (*cp
));
134 cp
->procinfo
.hProcess
= NULL
;
135 cp
->status
= STATUS_READ_ERROR
;
137 /* use manual reset event so that select() will function properly */
138 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
141 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
142 if (cp
->char_consumed
)
144 cp
->thrd
= CreateThread (NULL
, 1024, reader_thread
, cp
, 0, &id
);
154 delete_child (child_process
*cp
)
158 /* Should not be deleting a child that is still needed. */
159 for (i
= 0; i
< MAXDESC
; i
++)
160 if (fd_info
[i
].cp
== cp
)
163 if (!CHILD_ACTIVE (cp
))
166 /* reap thread if necessary */
171 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
173 /* let the thread exit cleanly if possible */
174 cp
->status
= STATUS_READ_ERROR
;
175 SetEvent (cp
->char_consumed
);
177 /* We used to forcibly terminate the thread here, but it
178 is normally unnecessary, and in abnormal cases, the worst that
179 will happen is we have an extra idle thread hanging around
180 waiting for the zombie process. */
181 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
183 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
184 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
185 TerminateThread (cp
->thrd
, 0);
189 CloseHandle (cp
->thrd
);
194 CloseHandle (cp
->char_avail
);
195 cp
->char_avail
= NULL
;
197 if (cp
->char_consumed
)
199 CloseHandle (cp
->char_consumed
);
200 cp
->char_consumed
= NULL
;
203 /* update child_proc_count (highest numbered slot in use plus one) */
204 if (cp
== child_procs
+ child_proc_count
- 1)
206 for (i
= child_proc_count
-1; i
>= 0; i
--)
207 if (CHILD_ACTIVE (&child_procs
[i
]))
209 child_proc_count
= i
+ 1;
214 child_proc_count
= 0;
217 /* Find a child by pid. */
218 static child_process
*
219 find_child_pid (DWORD pid
)
223 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
224 if (CHILD_ACTIVE (cp
) && pid
== cp
->pid
)
230 /* Thread proc for child process and socket reader threads. Each thread
231 is normally blocked until woken by select() to check for input by
232 reading one char. When the read completes, char_avail is signaled
233 to wake up the select emulator and the thread blocks itself again. */
235 reader_thread (void *arg
)
240 cp
= (child_process
*)arg
;
242 /* We have to wait for the go-ahead before we can start */
244 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
252 if (fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
253 rc
= _sys_wait_accept (cp
->fd
);
255 rc
= _sys_read_ahead (cp
->fd
);
257 /* The name char_avail is a misnomer - it really just means the
258 read-ahead has completed, whether successfully or not. */
259 if (!SetEvent (cp
->char_avail
))
261 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
262 GetLastError (), cp
->fd
));
266 if (rc
== STATUS_READ_ERROR
)
269 /* If the read died, the child has died so let the thread die */
270 if (rc
== STATUS_READ_FAILED
)
273 /* Wait until our input is acknowledged before reading again */
274 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
276 DebPrint (("reader_thread.WaitForSingleObject failed with "
277 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
284 /* To avoid Emacs changing directory, we just record here the directory
285 the new process should start in. This is set just before calling
286 sys_spawnve, and is not generally valid at any other time. */
287 static char * process_dir
;
290 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
291 int * pPid
, child_process
*cp
)
294 SECURITY_ATTRIBUTES sec_attrs
;
296 SECURITY_DESCRIPTOR sec_desc
;
299 char dir
[ MAXPATHLEN
];
301 if (cp
== NULL
) abort ();
303 memset (&start
, 0, sizeof (start
));
304 start
.cb
= sizeof (start
);
307 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
308 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
310 start
.dwFlags
= STARTF_USESTDHANDLES
;
311 start
.wShowWindow
= SW_HIDE
;
313 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
314 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
315 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
316 #endif /* HAVE_NTGUI */
319 /* Explicitly specify no security */
320 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
322 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
325 sec_attrs
.nLength
= sizeof (sec_attrs
);
326 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
327 sec_attrs
.bInheritHandle
= FALSE
;
329 strcpy (dir
, process_dir
);
330 unixtodos_filename (dir
);
332 flags
= (!NILP (Vw32_start_process_share_console
)
333 ? CREATE_NEW_PROCESS_GROUP
334 : CREATE_NEW_CONSOLE
);
335 if (NILP (Vw32_start_process_inherit_error_mode
))
336 flags
|= CREATE_DEFAULT_ERROR_MODE
;
337 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
338 flags
, env
, dir
, &start
, &cp
->procinfo
))
341 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
343 /* Hack for Windows 95, which assigns large (ie negative) pids */
347 /* pid must fit in a Lisp_Int */
348 cp
->pid
= cp
->pid
& INTMASK
;
355 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
359 /* create_child doesn't know what emacs' file handle will be for waiting
360 on output from the child, so we need to make this additional call
361 to register the handle with the process
362 This way the select emulator knows how to match file handles with
363 entries in child_procs. */
365 register_child (int pid
, int fd
)
369 cp
= find_child_pid (pid
);
372 DebPrint (("register_child unable to find pid %lu\n", pid
));
377 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
382 /* thread is initially blocked until select is called; set status so
383 that select will release thread */
384 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
386 /* attach child_process to fd_info */
387 if (fd_info
[fd
].cp
!= NULL
)
389 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
396 /* When a process dies its pipe will break so the reader thread will
397 signal failure to the select emulator.
398 The select emulator then calls this routine to clean up.
399 Since the thread signaled failure we can assume it is exiting. */
401 reap_subprocess (child_process
*cp
)
403 if (cp
->procinfo
.hProcess
)
405 /* Reap the process */
407 /* Process should have already died before we are called. */
408 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
409 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp
->fd
));
411 CloseHandle (cp
->procinfo
.hProcess
);
412 cp
->procinfo
.hProcess
= NULL
;
413 CloseHandle (cp
->procinfo
.hThread
);
414 cp
->procinfo
.hThread
= NULL
;
417 /* For asynchronous children, the child_proc resources will be freed
418 when the last pipe read descriptor is closed; for synchronous
419 children, we must explicitly free the resources now because
420 register_child has not been called. */
425 /* Wait for any of our existing child processes to die
426 When it does, close its handle
427 Return the pid and fill in the status if non-NULL. */
430 sys_wait (int *status
)
432 DWORD active
, retval
;
435 child_process
*cp
, *cps
[MAX_CHILDREN
];
436 HANDLE wait_hnd
[MAX_CHILDREN
];
439 if (dead_child
!= NULL
)
441 /* We want to wait for a specific child */
442 wait_hnd
[nh
] = dead_child
->procinfo
.hProcess
;
443 cps
[nh
] = dead_child
;
444 if (!wait_hnd
[nh
]) abort ();
451 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
452 /* some child_procs might be sockets; ignore them */
453 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
454 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
456 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
464 /* Nothing to wait on, so fail */
471 /* Check for quit about once a second. */
473 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, 1000);
474 } while (active
== WAIT_TIMEOUT
);
476 if (active
== WAIT_FAILED
)
481 else if (active
>= WAIT_OBJECT_0
482 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
484 active
-= WAIT_OBJECT_0
;
486 else if (active
>= WAIT_ABANDONED_0
487 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
489 active
-= WAIT_ABANDONED_0
;
495 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
497 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
501 if (retval
== STILL_ACTIVE
)
503 /* Should never happen */
504 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
509 /* Massage the exit code from the process to match the format expected
510 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
511 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
513 if (retval
== STATUS_CONTROL_C_EXIT
)
521 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
528 else if (synch_process_alive
)
530 synch_process_alive
= 0;
532 /* Report the status of the synchronous process. */
533 if (WIFEXITED (retval
))
534 synch_process_retcode
= WRETCODE (retval
);
535 else if (WIFSIGNALED (retval
))
537 int code
= WTERMSIG (retval
);
540 synchronize_system_messages_locale ();
541 signame
= strsignal (code
);
546 synch_process_death
= signame
;
549 reap_subprocess (cp
);
552 reap_subprocess (cp
);
557 /* Old versions of w32api headers don't have separate 32-bit and
558 64-bit defines, but the one they have matches the 32-bit variety. */
559 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
560 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
561 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
565 w32_executable_type (char * filename
,
570 file_data executable
;
573 /* Default values in case we can't tell for sure. */
575 *is_cygnus_app
= FALSE
;
578 if (!open_input_file (&executable
, filename
))
581 p
= strrchr (filename
, '.');
583 /* We can only identify DOS .com programs from the extension. */
584 if (p
&& xstrcasecmp (p
, ".com") == 0)
586 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
587 || xstrcasecmp (p
, ".cmd") == 0))
589 /* A DOS shell script - it appears that CreateProcess is happy to
590 accept this (somewhat surprisingly); presumably it looks at
591 COMSPEC to determine what executable to actually invoke.
592 Therefore, we have to do the same here as well. */
593 /* Actually, I think it uses the program association for that
594 extension, which is defined in the registry. */
595 p
= egetenv ("COMSPEC");
597 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
601 /* Look for DOS .exe signature - if found, we must also check that
602 it isn't really a 16- or 32-bit Windows exe, since both formats
603 start with a DOS program stub. Note that 16-bit Windows
604 executables use the OS/2 1.x format. */
606 IMAGE_DOS_HEADER
* dos_header
;
607 IMAGE_NT_HEADERS
* nt_header
;
609 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
610 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
613 nt_header
= (PIMAGE_NT_HEADERS
) ((char *) dos_header
+ dos_header
->e_lfanew
);
615 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
617 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
620 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
621 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
625 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
627 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
628 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
630 /* Ensure we are using the 32 bit structure. */
631 IMAGE_OPTIONAL_HEADER32
*opt
632 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
633 data_dir
= opt
->DataDirectory
;
634 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
636 /* MingW 3.12 has the required 64 bit structs, but in case older
637 versions don't, only check 64 bit exes if we know how. */
638 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
639 else if (nt_header
->OptionalHeader
.Magic
640 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
642 IMAGE_OPTIONAL_HEADER64
*opt
643 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
644 data_dir
= opt
->DataDirectory
;
645 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
650 /* Look for cygwin.dll in DLL import list. */
651 IMAGE_DATA_DIRECTORY import_dir
=
652 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
653 IMAGE_IMPORT_DESCRIPTOR
* imports
;
654 IMAGE_SECTION_HEADER
* section
;
656 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
657 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
660 for ( ; imports
->Name
; imports
++)
662 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
665 /* The exact name of the cygwin dll has changed with
666 various releases, but hopefully this will be reasonably
668 if (strncmp (dllname
, "cygwin", 6) == 0)
670 *is_cygnus_app
= TRUE
;
679 close_file_data (&executable
);
683 compare_env (const void *strp1
, const void *strp2
)
685 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
687 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
689 /* Sort order in command.com/cmd.exe is based on uppercasing
690 names, so do the same here. */
691 if (toupper (*str1
) > toupper (*str2
))
693 else if (toupper (*str1
) < toupper (*str2
))
698 if (*str1
== '=' && *str2
== '=')
700 else if (*str1
== '=')
707 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
723 qsort (new_envp
, num
, sizeof (char *), compare_env
);
728 /* When a new child process is created we need to register it in our list,
729 so intercept spawn requests. */
731 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
733 Lisp_Object program
, full
;
734 char *cmdline
, *env
, *parg
, **targ
;
738 int is_dos_app
, is_cygnus_app
, is_gui_app
;
741 /* We pass our process ID to our children by setting up an environment
742 variable in their environment. */
743 char ppid_env_var_buffer
[64];
744 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
745 /* These are the characters that cause an argument to need quoting.
746 Arguments with whitespace characters need quoting to prevent the
747 argument being split into two or more. Arguments with wildcards
748 are also quoted, for consistency with posix platforms, where wildcards
749 are not expanded if we run the program directly without a shell.
750 Some extra whitespace characters need quoting in Cygwin programs,
751 so this list is conditionally modified below. */
752 char *sepchars
= " \t*?";
754 /* We don't care about the other modes */
755 if (mode
!= _P_NOWAIT
)
761 /* Handle executable names without an executable suffix. */
762 program
= make_string (cmdname
, strlen (cmdname
));
763 if (NILP (Ffile_executable_p (program
)))
769 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
779 /* make sure argv[0] and cmdname are both in DOS format */
780 cmdname
= SDATA (program
);
781 unixtodos_filename (cmdname
);
784 /* Determine whether program is a 16-bit DOS executable, or a w32
785 executable that is implicitly linked to the Cygnus dll (implying it
786 was compiled with the Cygnus GNU toolchain and hence relies on
787 cygwin.dll to parse the command line - we use this to decide how to
788 escape quote chars in command line args that must be quoted).
790 Also determine whether it is a GUI app, so that we don't hide its
791 initial window unless specifically requested. */
792 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
794 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
795 application to start it by specifying the helper app as cmdname,
796 while leaving the real app name as argv[0]. */
799 cmdname
= alloca (MAXPATHLEN
);
800 if (egetenv ("CMDPROXY"))
801 strcpy (cmdname
, egetenv ("CMDPROXY"));
804 strcpy (cmdname
, SDATA (Vinvocation_directory
));
805 strcat (cmdname
, "cmdproxy.exe");
807 unixtodos_filename (cmdname
);
810 /* we have to do some conjuring here to put argv and envp into the
811 form CreateProcess wants... argv needs to be a space separated/null
812 terminated list of parameters, and envp is a null
813 separated/double-null terminated list of parameters.
815 Additionally, zero-length args and args containing whitespace or
816 quote chars need to be wrapped in double quotes - for this to work,
817 embedded quotes need to be escaped as well. The aim is to ensure
818 the child process reconstructs the argv array we start with
819 exactly, so we treat quotes at the beginning and end of arguments
822 The w32 GNU-based library from Cygnus doubles quotes to escape
823 them, while MSVC uses backslash for escaping. (Actually the MSVC
824 startup code does attempt to recognize doubled quotes and accept
825 them, but gets it wrong and ends up requiring three quotes to get a
826 single embedded quote!) So by default we decide whether to use
827 quote or backslash as the escape character based on whether the
828 binary is apparently a Cygnus compiled app.
830 Note that using backslash to escape embedded quotes requires
831 additional special handling if an embedded quote is already
832 preceded by backslash, or if an arg requiring quoting ends with
833 backslash. In such cases, the run of escape characters needs to be
834 doubled. For consistency, we apply this special handling as long
835 as the escape character is not quote.
837 Since we have no idea how large argv and envp are likely to be we
838 figure out list lengths on the fly and allocate them. */
840 if (!NILP (Vw32_quote_process_args
))
843 /* Override escape char by binding w32-quote-process-args to
844 desired character, or use t for auto-selection. */
845 if (INTEGERP (Vw32_quote_process_args
))
846 escape_char
= XINT (Vw32_quote_process_args
);
848 escape_char
= is_cygnus_app
? '"' : '\\';
851 /* Cygwin apps needs quoting a bit more often. */
852 if (escape_char
== '"')
853 sepchars
= "\r\n\t\f '";
862 int escape_char_run
= 0;
868 if (escape_char
== '"' && *p
== '\\')
869 /* If it's a Cygwin app, \ needs to be escaped. */
873 /* allow for embedded quotes to be escaped */
876 /* handle the case where the embedded quote is already escaped */
877 if (escape_char_run
> 0)
879 /* To preserve the arg exactly, we need to double the
880 preceding escape characters (plus adding one to
881 escape the quote character itself). */
882 arglen
+= escape_char_run
;
885 else if (strchr (sepchars
, *p
) != NULL
)
890 if (*p
== escape_char
&& escape_char
!= '"')
898 /* handle the case where the arg ends with an escape char - we
899 must not let the enclosing quote be escaped. */
900 if (escape_char_run
> 0)
901 arglen
+= escape_char_run
;
903 arglen
+= strlen (*targ
++) + 1;
905 cmdline
= alloca (arglen
);
919 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
924 int escape_char_run
= 0;
930 last
= p
+ strlen (p
) - 1;
933 /* This version does not escape quotes if they occur at the
934 beginning or end of the arg - this could lead to incorrect
935 behavior when the arg itself represents a command line
936 containing quoted args. I believe this was originally done
937 as a hack to make some things work, before
938 `w32-quote-process-args' was added. */
941 if (*p
== '"' && p
> first
&& p
< last
)
942 *parg
++ = escape_char
; /* escape embedded quotes */
950 /* double preceding escape chars if any */
951 while (escape_char_run
> 0)
953 *parg
++ = escape_char
;
956 /* escape all quote chars, even at beginning or end */
957 *parg
++ = escape_char
;
959 else if (escape_char
== '"' && *p
== '\\')
963 if (*p
== escape_char
&& escape_char
!= '"')
968 /* double escape chars before enclosing quote */
969 while (escape_char_run
> 0)
971 *parg
++ = escape_char
;
979 strcpy (parg
, *targ
);
980 parg
+= strlen (*targ
);
990 numenv
= 1; /* for end null */
993 arglen
+= strlen (*targ
++) + 1;
996 /* extra env vars... */
997 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%d",
998 GetCurrentProcessId ());
999 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1002 /* merge env passed in and extra env into one, and sort it. */
1003 targ
= (char **) alloca (numenv
* sizeof (char *));
1004 merge_and_sort_env (envp
, extra_env
, targ
);
1006 /* concatenate env entries. */
1007 env
= alloca (arglen
);
1011 strcpy (parg
, *targ
);
1012 parg
+= strlen (*targ
++);
1025 /* Now create the process. */
1026 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1036 /* Emulate the select call
1037 Wait for available input on any of the given rfds, or timeout if
1038 a timeout is given and no input is detected
1039 wfds and efds are not supported and must be NULL.
1041 For simplicity, we detect the death of child processes here and
1042 synchronously call the SIGCHLD handler. Since it is possible for
1043 children to be created without a corresponding pipe handle from which
1044 to read output, we wait separately on the process handles as well as
1045 the char_avail events for each process pipe. We only call
1046 wait/reap_process when the process actually terminates.
1048 To reduce the number of places in which Emacs can be hung such that
1049 C-g is not able to interrupt it, we always wait on interrupt_handle
1050 (which is signaled by the input thread when C-g is detected). If we
1051 detect that we were woken up by C-g, we return -1 with errno set to
1052 EINTR as on Unix. */
1054 /* From w32console.c */
1055 extern HANDLE keyboard_handle
;
1057 /* From w32xfns.c */
1058 extern HANDLE interrupt_handle
;
1060 /* From process.c */
1061 extern int proc_buffered_char
[];
1064 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1065 EMACS_TIME
*timeout
)
1068 DWORD timeout_ms
, start_time
;
1071 child_process
*cp
, *cps
[MAX_CHILDREN
];
1072 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1073 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1075 timeout_ms
= timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_usec
/ 1000) : INFINITE
;
1077 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1078 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1084 /* Otherwise, we only handle rfds, so fail otherwise. */
1085 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1095 /* Always wait on interrupt_handle, to detect C-g (quit). */
1096 wait_hnd
[0] = interrupt_handle
;
1099 /* Build a list of pipe handles to wait on. */
1101 for (i
= 0; i
< nfds
; i
++)
1102 if (FD_ISSET (i
, &orfds
))
1106 if (keyboard_handle
)
1108 /* Handle stdin specially */
1109 wait_hnd
[nh
] = keyboard_handle
;
1114 /* Check for any emacs-generated input in the queue since
1115 it won't be detected in the wait */
1116 if (detect_input_pending ())
1124 /* Child process and socket input */
1128 int current_status
= cp
->status
;
1130 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1132 /* Tell reader thread which file handle to use. */
1134 /* Wake up the reader thread for this process */
1135 cp
->status
= STATUS_READ_READY
;
1136 if (!SetEvent (cp
->char_consumed
))
1137 DebPrint (("nt_select.SetEvent failed with "
1138 "%lu for fd %ld\n", GetLastError (), i
));
1141 #ifdef CHECK_INTERLOCK
1142 /* slightly crude cross-checking of interlock between threads */
1144 current_status
= cp
->status
;
1145 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1147 /* char_avail has been signaled, so status (which may
1148 have changed) should indicate read has completed
1149 but has not been acknowledged. */
1150 current_status
= cp
->status
;
1151 if (current_status
!= STATUS_READ_SUCCEEDED
1152 && current_status
!= STATUS_READ_FAILED
)
1153 DebPrint (("char_avail set, but read not completed: status %d\n",
1158 /* char_avail has not been signaled, so status should
1159 indicate that read is in progress; small possibility
1160 that read has completed but event wasn't yet signaled
1161 when we tested it (because a context switch occurred
1162 or if running on separate CPUs). */
1163 if (current_status
!= STATUS_READ_READY
1164 && current_status
!= STATUS_READ_IN_PROGRESS
1165 && current_status
!= STATUS_READ_SUCCEEDED
1166 && current_status
!= STATUS_READ_FAILED
)
1167 DebPrint (("char_avail reset, but read status is bad: %d\n",
1171 wait_hnd
[nh
] = cp
->char_avail
;
1173 if (!wait_hnd
[nh
]) abort ();
1176 DebPrint (("select waiting on child %d fd %d\n",
1177 cp
-child_procs
, i
));
1182 /* Unable to find something to wait on for this fd, skip */
1184 /* Note that this is not a fatal error, and can in fact
1185 happen in unusual circumstances. Specifically, if
1186 sys_spawnve fails, eg. because the program doesn't
1187 exist, and debug-on-error is t so Fsignal invokes a
1188 nested input loop, then the process output pipe is
1189 still included in input_wait_mask with no child_proc
1190 associated with it. (It is removed when the debugger
1191 exits the nested input loop and the error is thrown.) */
1193 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
1199 /* Add handles of child processes. */
1201 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1202 /* Some child_procs might be sockets; ignore them. Also some
1203 children may have died already, but we haven't finished reading
1204 the process output; ignore them too. */
1205 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1207 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
1208 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1211 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
1216 /* Nothing to look for, so we didn't find anything */
1224 start_time
= GetTickCount ();
1226 /* Wait for input or child death to be signaled. If user input is
1227 allowed, then also accept window messages. */
1228 if (FD_ISSET (0, &orfds
))
1229 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
1232 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
1234 if (active
== WAIT_FAILED
)
1236 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1237 nh
+ nc
, timeout_ms
, GetLastError ()));
1238 /* don't return EBADF - this causes wait_reading_process_output to
1239 abort; WAIT_FAILED is returned when single-stepping under
1240 Windows 95 after switching thread focus in debugger, and
1241 possibly at other times. */
1245 else if (active
== WAIT_TIMEOUT
)
1249 else if (active
>= WAIT_OBJECT_0
1250 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1252 active
-= WAIT_OBJECT_0
;
1254 else if (active
>= WAIT_ABANDONED_0
1255 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1257 active
-= WAIT_ABANDONED_0
;
1262 /* Loop over all handles after active (now officially documented as
1263 being the first signaled handle in the array). We do this to
1264 ensure fairness, so that all channels with data available will be
1265 processed - otherwise higher numbered channels could be starved. */
1268 if (active
== nh
+ nc
)
1270 /* There are messages in the lisp thread's queue; we must
1271 drain the queue now to ensure they are processed promptly,
1272 because if we don't do so, we will not be woken again until
1273 further messages arrive.
1275 NB. If ever we allow window message procedures to callback
1276 into lisp, we will need to ensure messages are dispatched
1277 at a safe time for lisp code to be run (*), and we may also
1278 want to provide some hooks in the dispatch loop to cater
1279 for modeless dialogs created by lisp (ie. to register
1280 window handles to pass to IsDialogMessage).
1282 (*) Note that MsgWaitForMultipleObjects above is an
1283 internal dispatch point for messages that are sent to
1284 windows created by this thread. */
1285 drain_message_queue ();
1287 else if (active
>= nh
)
1289 cp
= cps
[active
- nh
];
1291 /* We cannot always signal SIGCHLD immediately; if we have not
1292 finished reading the process output, we must delay sending
1293 SIGCHLD until we do. */
1295 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
1296 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
1297 /* SIG_DFL for SIGCHLD is ignore */
1298 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
1299 sig_handlers
[SIGCHLD
] != SIG_IGN
)
1302 DebPrint (("select calling SIGCHLD handler for pid %d\n",
1306 sig_handlers
[SIGCHLD
] (SIGCHLD
);
1310 else if (fdindex
[active
] == -1)
1312 /* Quit (C-g) was detected. */
1316 else if (fdindex
[active
] == 0)
1318 /* Keyboard input available */
1324 /* must be a socket or pipe - read ahead should have
1325 completed, either succeeding or failing. */
1326 FD_SET (fdindex
[active
], rfds
);
1330 /* Even though wait_reading_process_output only reads from at most
1331 one channel, we must process all channels here so that we reap
1332 all children that have died. */
1333 while (++active
< nh
+ nc
)
1334 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
1336 } while (active
< nh
+ nc
);
1338 /* If no input has arrived and timeout hasn't expired, wait again. */
1341 DWORD elapsed
= GetTickCount () - start_time
;
1343 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
1345 if (timeout_ms
!= INFINITE
)
1346 timeout_ms
-= elapsed
;
1347 goto count_children
;
1354 /* Substitute for certain kill () operations */
1356 static BOOL CALLBACK
1357 find_child_console (HWND hwnd
, LPARAM arg
)
1359 child_process
* cp
= (child_process
*) arg
;
1363 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
1364 if (process_id
== cp
->procinfo
.dwProcessId
)
1366 char window_class
[32];
1368 GetClassName (hwnd
, window_class
, sizeof (window_class
));
1369 if (strcmp (window_class
,
1370 (os_subtype
== OS_WIN95
)
1372 : "ConsoleWindowClass") == 0)
1383 sys_kill (int pid
, int sig
)
1387 int need_to_free
= 0;
1390 /* Only handle signals that will result in the process dying */
1391 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
1397 cp
= find_child_pid (pid
);
1400 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
1401 if (proc_hand
== NULL
)
1410 proc_hand
= cp
->procinfo
.hProcess
;
1411 pid
= cp
->procinfo
.dwProcessId
;
1413 /* Try to locate console window for process. */
1414 EnumWindows (find_child_console
, (LPARAM
) cp
);
1417 if (sig
== SIGINT
|| sig
== SIGQUIT
)
1419 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
1421 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
1422 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
1423 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
1424 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
1425 HWND foreground_window
;
1427 if (break_scan_code
== 0)
1429 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
1430 vk_break_code
= 'C';
1431 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
1434 foreground_window
= GetForegroundWindow ();
1435 if (foreground_window
)
1437 /* NT 5.0, and apparently also Windows 98, will not allow
1438 a Window to be set to foreground directly without the
1439 user's involvement. The workaround is to attach
1440 ourselves to the thread that owns the foreground
1441 window, since that is the only thread that can set the
1442 foreground window. */
1443 DWORD foreground_thread
, child_thread
;
1445 GetWindowThreadProcessId (foreground_window
, NULL
);
1446 if (foreground_thread
== GetCurrentThreadId ()
1447 || !AttachThreadInput (GetCurrentThreadId (),
1448 foreground_thread
, TRUE
))
1449 foreground_thread
= 0;
1451 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
1452 if (child_thread
== GetCurrentThreadId ()
1453 || !AttachThreadInput (GetCurrentThreadId (),
1454 child_thread
, TRUE
))
1457 /* Set the foreground window to the child. */
1458 if (SetForegroundWindow (cp
->hwnd
))
1460 /* Generate keystrokes as if user had typed Ctrl-Break or
1462 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
1463 keybd_event (vk_break_code
, break_scan_code
,
1464 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
1465 keybd_event (vk_break_code
, break_scan_code
,
1466 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
1467 | KEYEVENTF_KEYUP
, 0);
1468 keybd_event (VK_CONTROL
, control_scan_code
,
1469 KEYEVENTF_KEYUP
, 0);
1471 /* Sleep for a bit to give time for Emacs frame to respond
1472 to focus change events (if Emacs was active app). */
1475 SetForegroundWindow (foreground_window
);
1477 /* Detach from the foreground and child threads now that
1478 the foreground switching is over. */
1479 if (foreground_thread
)
1480 AttachThreadInput (GetCurrentThreadId (),
1481 foreground_thread
, FALSE
);
1483 AttachThreadInput (GetCurrentThreadId (),
1484 child_thread
, FALSE
);
1487 /* Ctrl-Break is NT equivalent of SIGINT. */
1488 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
1490 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
1491 "for pid %lu\n", GetLastError (), pid
));
1498 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
1501 if (os_subtype
== OS_WIN95
)
1504 Another possibility is to try terminating the VDM out-right by
1505 calling the Shell VxD (id 0x17) V86 interface, function #4
1506 "SHELL_Destroy_VM", ie.
1512 First need to determine the current VM handle, and then arrange for
1513 the shellapi call to be made from the system vm (by using
1514 Switch_VM_and_callback).
1516 Could try to invoke DestroyVM through CallVxD.
1520 /* On Win95, posting WM_QUIT causes the 16-bit subsystem
1521 to hang when cmdproxy is used in conjunction with
1522 command.com for an interactive shell. Posting
1523 WM_CLOSE pops up a dialog that, when Yes is selected,
1524 does the same thing. TerminateProcess is also less
1525 than ideal in that subprocesses tend to stick around
1526 until the machine is shutdown, but at least it
1527 doesn't freeze the 16-bit subsystem. */
1528 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
1530 if (!TerminateProcess (proc_hand
, 0xff))
1532 DebPrint (("sys_kill.TerminateProcess returned %d "
1533 "for pid %lu\n", GetLastError (), pid
));
1540 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
1542 /* Kill the process. On W32 this doesn't kill child processes
1543 so it doesn't work very well for shells which is why it's not
1544 used in every case. */
1545 else if (!TerminateProcess (proc_hand
, 0xff))
1547 DebPrint (("sys_kill.TerminateProcess returned %d "
1548 "for pid %lu\n", GetLastError (), pid
));
1555 CloseHandle (proc_hand
);
1560 /* The following two routines are used to manipulate stdin, stdout, and
1561 stderr of our child processes.
1563 Assuming that in, out, and err are *not* inheritable, we make them
1564 stdin, stdout, and stderr of the child as follows:
1566 - Save the parent's current standard handles.
1567 - Set the std handles to inheritable duplicates of the ones being passed in.
1568 (Note that _get_osfhandle() is an io.h procedure that retrieves the
1569 NT file handle for a crt file descriptor.)
1570 - Spawn the child, which inherits in, out, and err as stdin,
1571 stdout, and stderr. (see Spawnve)
1572 - Close the std handles passed to the child.
1573 - Reset the parent's standard handles to the saved handles.
1574 (see reset_standard_handles)
1575 We assume that the caller closes in, out, and err after calling us. */
1578 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
1581 HANDLE newstdin
, newstdout
, newstderr
;
1583 parent
= GetCurrentProcess ();
1585 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
1586 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
1587 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
1589 /* make inheritable copies of the new handles */
1590 if (!DuplicateHandle (parent
,
1591 (HANDLE
) _get_osfhandle (in
),
1596 DUPLICATE_SAME_ACCESS
))
1597 report_file_error ("Duplicating input handle for child", Qnil
);
1599 if (!DuplicateHandle (parent
,
1600 (HANDLE
) _get_osfhandle (out
),
1605 DUPLICATE_SAME_ACCESS
))
1606 report_file_error ("Duplicating output handle for child", Qnil
);
1608 if (!DuplicateHandle (parent
,
1609 (HANDLE
) _get_osfhandle (err
),
1614 DUPLICATE_SAME_ACCESS
))
1615 report_file_error ("Duplicating error handle for child", Qnil
);
1617 /* and store them as our std handles */
1618 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
1619 report_file_error ("Changing stdin handle", Qnil
);
1621 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
1622 report_file_error ("Changing stdout handle", Qnil
);
1624 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
1625 report_file_error ("Changing stderr handle", Qnil
);
1629 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
1631 /* close the duplicated handles passed to the child */
1632 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
1633 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
1634 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
1636 /* now restore parent's saved std handles */
1637 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
1638 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
1639 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
1643 set_process_dir (char * dir
)
1648 /* To avoid problems with winsock implementations that work over dial-up
1649 connections causing or requiring a connection to exist while Emacs is
1650 running, Emacs no longer automatically loads winsock on startup if it
1651 is present. Instead, it will be loaded when open-network-stream is
1654 To allow full control over when winsock is loaded, we provide these
1655 two functions to dynamically load and unload winsock. This allows
1656 dial-up users to only be connected when they actually need to use
1660 extern HANDLE winsock_lib
;
1661 extern BOOL
term_winsock (void);
1662 extern BOOL
init_winsock (int load_now
);
1664 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
1665 doc
: /* Test for presence of the Windows socket library `winsock'.
1666 Returns non-nil if winsock support is present, nil otherwise.
1668 If the optional argument LOAD-NOW is non-nil, the winsock library is
1669 also loaded immediately if not already loaded. If winsock is loaded,
1670 the winsock local hostname is returned (since this may be different from
1671 the value of `system-name' and should supplant it), otherwise t is
1672 returned to indicate winsock support is present. */)
1673 (Lisp_Object load_now
)
1677 have_winsock
= init_winsock (!NILP (load_now
));
1680 if (winsock_lib
!= NULL
)
1682 /* Return new value for system-name. The best way to do this
1683 is to call init_system_name, saving and restoring the
1684 original value to avoid side-effects. */
1685 Lisp_Object orig_hostname
= Vsystem_name
;
1686 Lisp_Object hostname
;
1688 init_system_name ();
1689 hostname
= Vsystem_name
;
1690 Vsystem_name
= orig_hostname
;
1698 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
1700 doc
: /* Unload the Windows socket library `winsock' if loaded.
1701 This is provided to allow dial-up socket connections to be disconnected
1702 when no longer needed. Returns nil without unloading winsock if any
1703 socket connections still exist. */)
1706 return term_winsock () ? Qt
: Qnil
;
1710 /* Some miscellaneous functions that are Windows specific, but not GUI
1711 specific (ie. are applicable in terminal or batch mode as well). */
1713 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
1714 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
1715 If FILENAME does not exist, return nil.
1716 All path elements in FILENAME are converted to their short names. */)
1717 (Lisp_Object filename
)
1719 char shortname
[MAX_PATH
];
1721 CHECK_STRING (filename
);
1723 /* first expand it. */
1724 filename
= Fexpand_file_name (filename
, Qnil
);
1726 /* luckily, this returns the short version of each element in the path. */
1727 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
1730 dostounix_filename (shortname
);
1732 return build_string (shortname
);
1736 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
1738 doc
: /* Return the long file name version of the full path of FILENAME.
1739 If FILENAME does not exist, return nil.
1740 All path elements in FILENAME are converted to their long names. */)
1741 (Lisp_Object filename
)
1743 char longname
[ MAX_PATH
];
1746 CHECK_STRING (filename
);
1748 if (SBYTES (filename
) == 2
1749 && *(SDATA (filename
) + 1) == ':')
1752 /* first expand it. */
1753 filename
= Fexpand_file_name (filename
, Qnil
);
1755 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
1758 dostounix_filename (longname
);
1760 /* If we were passed only a drive, make sure that a slash is not appended
1761 for consistency with directories. Allow for drive mapping via SUBST
1762 in case expand-file-name is ever changed to expand those. */
1763 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
1766 return DECODE_FILE (build_string (longname
));
1769 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
1770 Sw32_set_process_priority
, 2, 2, 0,
1771 doc
: /* Set the priority of PROCESS to PRIORITY.
1772 If PROCESS is nil, the priority of Emacs is changed, otherwise the
1773 priority of the process whose pid is PROCESS is changed.
1774 PRIORITY should be one of the symbols high, normal, or low;
1775 any other symbol will be interpreted as normal.
1777 If successful, the return value is t, otherwise nil. */)
1778 (Lisp_Object process
, Lisp_Object priority
)
1780 HANDLE proc_handle
= GetCurrentProcess ();
1781 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
1782 Lisp_Object result
= Qnil
;
1784 CHECK_SYMBOL (priority
);
1786 if (!NILP (process
))
1791 CHECK_NUMBER (process
);
1793 /* Allow pid to be an internally generated one, or one obtained
1794 externally. This is necessary because real pids on Win95 are
1797 pid
= XINT (process
);
1798 cp
= find_child_pid (pid
);
1800 pid
= cp
->procinfo
.dwProcessId
;
1802 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
1805 if (EQ (priority
, Qhigh
))
1806 priority_class
= HIGH_PRIORITY_CLASS
;
1807 else if (EQ (priority
, Qlow
))
1808 priority_class
= IDLE_PRIORITY_CLASS
;
1810 if (proc_handle
!= NULL
)
1812 if (SetPriorityClass (proc_handle
, priority_class
))
1814 if (!NILP (process
))
1815 CloseHandle (proc_handle
);
1821 #ifdef HAVE_LANGINFO_CODESET
1822 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
1824 nl_langinfo (nl_item item
)
1826 /* Conversion of Posix item numbers to their Windows equivalents. */
1827 static const LCTYPE w32item
[] = {
1828 LOCALE_IDEFAULTANSICODEPAGE
,
1829 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
1830 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
1831 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
1832 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
1833 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
1834 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
1837 static char *nl_langinfo_buf
= NULL
;
1838 static int nl_langinfo_len
= 0;
1840 if (nl_langinfo_len
<= 0)
1841 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
1843 if (item
< 0 || item
>= _NL_NUM
)
1844 nl_langinfo_buf
[0] = 0;
1847 LCID cloc
= GetThreadLocale ();
1848 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
1852 nl_langinfo_buf
[0] = 0;
1855 if (item
== CODESET
)
1857 need_len
+= 2; /* for the "cp" prefix */
1858 if (need_len
< 8) /* for the case we call GetACP */
1861 if (nl_langinfo_len
<= need_len
)
1862 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
1863 nl_langinfo_len
= need_len
);
1864 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
1865 nl_langinfo_buf
, nl_langinfo_len
))
1866 nl_langinfo_buf
[0] = 0;
1867 else if (item
== CODESET
)
1869 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
1870 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
1871 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
1874 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
1875 strlen (nl_langinfo_buf
) + 1);
1876 nl_langinfo_buf
[0] = 'c';
1877 nl_langinfo_buf
[1] = 'p';
1882 return nl_langinfo_buf
;
1884 #endif /* HAVE_LANGINFO_CODESET */
1886 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
1887 Sw32_get_locale_info
, 1, 2, 0,
1888 doc
: /* Return information about the Windows locale LCID.
1889 By default, return a three letter locale code which encodes the default
1890 language as the first two characters, and the country or regional variant
1891 as the third letter. For example, ENU refers to `English (United States)',
1892 while ENC means `English (Canadian)'.
1894 If the optional argument LONGFORM is t, the long form of the locale
1895 name is returned, e.g. `English (United States)' instead; if LONGFORM
1896 is a number, it is interpreted as an LCTYPE constant and the corresponding
1897 locale information is returned.
1899 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
1900 (Lisp_Object lcid
, Lisp_Object longform
)
1904 char abbrev_name
[32] = { 0 };
1905 char full_name
[256] = { 0 };
1907 CHECK_NUMBER (lcid
);
1909 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
1912 if (NILP (longform
))
1914 got_abbrev
= GetLocaleInfo (XINT (lcid
),
1915 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
1916 abbrev_name
, sizeof (abbrev_name
));
1918 return build_string (abbrev_name
);
1920 else if (EQ (longform
, Qt
))
1922 got_full
= GetLocaleInfo (XINT (lcid
),
1923 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
1924 full_name
, sizeof (full_name
));
1926 return DECODE_SYSTEM (build_string (full_name
));
1928 else if (NUMBERP (longform
))
1930 got_full
= GetLocaleInfo (XINT (lcid
),
1932 full_name
, sizeof (full_name
));
1934 return make_unibyte_string (full_name
, got_full
);
1941 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
1942 Sw32_get_current_locale_id
, 0, 0, 0,
1943 doc
: /* Return Windows locale id for current locale setting.
1944 This is a numerical value; use `w32-get-locale-info' to convert to a
1945 human-readable form. */)
1948 return make_number (GetThreadLocale ());
1952 int_from_hex (char * s
)
1955 static char hex
[] = "0123456789abcdefABCDEF";
1958 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
1960 unsigned digit
= p
- hex
;
1963 val
= val
* 16 + digit
;
1969 /* We need to build a global list, since the EnumSystemLocale callback
1970 function isn't given a context pointer. */
1971 Lisp_Object Vw32_valid_locale_ids
;
1973 static BOOL CALLBACK
1974 enum_locale_fn (LPTSTR localeNum
)
1976 DWORD id
= int_from_hex (localeNum
);
1977 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
1981 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
1982 Sw32_get_valid_locale_ids
, 0, 0, 0,
1983 doc
: /* Return list of all valid Windows locale ids.
1984 Each id is a numerical value; use `w32-get-locale-info' to convert to a
1985 human-readable form. */)
1988 Vw32_valid_locale_ids
= Qnil
;
1990 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
1992 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
1993 return Vw32_valid_locale_ids
;
1997 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
1998 doc
: /* Return Windows locale id for default locale setting.
1999 By default, the system default locale setting is returned; if the optional
2000 parameter USERP is non-nil, the user default locale setting is returned.
2001 This is a numerical value; use `w32-get-locale-info' to convert to a
2002 human-readable form. */)
2006 return make_number (GetSystemDefaultLCID ());
2007 return make_number (GetUserDefaultLCID ());
2011 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2012 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2013 If successful, the new locale id is returned, otherwise nil. */)
2016 CHECK_NUMBER (lcid
);
2018 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2021 if (!SetThreadLocale (XINT (lcid
)))
2024 /* Need to set input thread locale if present. */
2025 if (dwWindowsThreadId
)
2026 /* Reply is not needed. */
2027 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2029 return make_number (GetThreadLocale ());
2033 /* We need to build a global list, since the EnumCodePages callback
2034 function isn't given a context pointer. */
2035 Lisp_Object Vw32_valid_codepages
;
2037 static BOOL CALLBACK
2038 enum_codepage_fn (LPTSTR codepageNum
)
2040 DWORD id
= atoi (codepageNum
);
2041 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2045 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2046 Sw32_get_valid_codepages
, 0, 0, 0,
2047 doc
: /* Return list of all valid Windows codepages. */)
2050 Vw32_valid_codepages
= Qnil
;
2052 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2054 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2055 return Vw32_valid_codepages
;
2059 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2060 Sw32_get_console_codepage
, 0, 0, 0,
2061 doc
: /* Return current Windows codepage for console input. */)
2064 return make_number (GetConsoleCP ());
2068 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2069 Sw32_set_console_codepage
, 1, 1, 0,
2070 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2071 This codepage setting affects keyboard input in tty mode.
2072 If successful, the new CP is returned, otherwise nil. */)
2077 if (!IsValidCodePage (XINT (cp
)))
2080 if (!SetConsoleCP (XINT (cp
)))
2083 return make_number (GetConsoleCP ());
2087 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2088 Sw32_get_console_output_codepage
, 0, 0, 0,
2089 doc
: /* Return current Windows codepage for console output. */)
2092 return make_number (GetConsoleOutputCP ());
2096 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2097 Sw32_set_console_output_codepage
, 1, 1, 0,
2098 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
2099 This codepage setting affects display in tty mode.
2100 If successful, the new CP is returned, otherwise nil. */)
2105 if (!IsValidCodePage (XINT (cp
)))
2108 if (!SetConsoleOutputCP (XINT (cp
)))
2111 return make_number (GetConsoleOutputCP ());
2115 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2116 Sw32_get_codepage_charset
, 1, 1, 0,
2117 doc
: /* Return charset ID corresponding to codepage CP.
2118 Returns nil if the codepage is not valid. */)
2125 if (!IsValidCodePage (XINT (cp
)))
2128 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2129 return make_number (info
.ciCharset
);
2135 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2136 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2137 doc
: /* Return list of Windows keyboard languages and layouts.
2138 The return value is a list of pairs of language id and layout id. */)
2141 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2142 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2143 Lisp_Object obj
= Qnil
;
2145 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2147 while (--num_layouts
>= 0)
2149 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2151 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2152 make_number ((kl
>> 16) & 0xffff)),
2161 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2162 Sw32_get_keyboard_layout
, 0, 0, 0,
2163 doc
: /* Return current Windows keyboard language and layout.
2164 The return value is the cons of the language id and the layout id. */)
2167 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
2169 return Fcons (make_number (kl
& 0xffff),
2170 make_number ((kl
>> 16) & 0xffff));
2174 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
2175 Sw32_set_keyboard_layout
, 1, 1, 0,
2176 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
2177 The keyboard layout setting affects interpretation of keyboard input.
2178 If successful, the new layout id is returned, otherwise nil. */)
2179 (Lisp_Object layout
)
2183 CHECK_CONS (layout
);
2184 CHECK_NUMBER_CAR (layout
);
2185 CHECK_NUMBER_CDR (layout
);
2187 kl
= (XINT (XCAR (layout
)) & 0xffff)
2188 | (XINT (XCDR (layout
)) << 16);
2190 /* Synchronize layout with input thread. */
2191 if (dwWindowsThreadId
)
2193 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
2197 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
2199 if (msg
.wParam
== 0)
2203 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
2206 return Fw32_get_keyboard_layout ();
2211 syms_of_ntproc (void)
2213 DEFSYM (Qhigh
, "high");
2214 DEFSYM (Qlow
, "low");
2216 defsubr (&Sw32_has_winsock
);
2217 defsubr (&Sw32_unload_winsock
);
2219 defsubr (&Sw32_short_file_name
);
2220 defsubr (&Sw32_long_file_name
);
2221 defsubr (&Sw32_set_process_priority
);
2222 defsubr (&Sw32_get_locale_info
);
2223 defsubr (&Sw32_get_current_locale_id
);
2224 defsubr (&Sw32_get_default_locale_id
);
2225 defsubr (&Sw32_get_valid_locale_ids
);
2226 defsubr (&Sw32_set_current_locale
);
2228 defsubr (&Sw32_get_console_codepage
);
2229 defsubr (&Sw32_set_console_codepage
);
2230 defsubr (&Sw32_get_console_output_codepage
);
2231 defsubr (&Sw32_set_console_output_codepage
);
2232 defsubr (&Sw32_get_valid_codepages
);
2233 defsubr (&Sw32_get_codepage_charset
);
2235 defsubr (&Sw32_get_valid_keyboard_layouts
);
2236 defsubr (&Sw32_get_keyboard_layout
);
2237 defsubr (&Sw32_set_keyboard_layout
);
2239 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
2240 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
2241 Because Windows does not directly pass argv arrays to child processes,
2242 programs have to reconstruct the argv array by parsing the command
2243 line string. For an argument to contain a space, it must be enclosed
2244 in double quotes or it will be parsed as multiple arguments.
2246 If the value is a character, that character will be used to escape any
2247 quote characters that appear, otherwise a suitable escape character
2248 will be chosen based on the type of the program. */);
2249 Vw32_quote_process_args
= Qt
;
2251 DEFVAR_LISP ("w32-start-process-show-window",
2252 Vw32_start_process_show_window
,
2253 doc
: /* When nil, new child processes hide their windows.
2254 When non-nil, they show their window in the method of their choice.
2255 This variable doesn't affect GUI applications, which will never be hidden. */);
2256 Vw32_start_process_show_window
= Qnil
;
2258 DEFVAR_LISP ("w32-start-process-share-console",
2259 Vw32_start_process_share_console
,
2260 doc
: /* When nil, new child processes are given a new console.
2261 When non-nil, they share the Emacs console; this has the limitation of
2262 allowing only one DOS subprocess to run at a time (whether started directly
2263 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
2264 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
2265 otherwise respond to interrupts from Emacs. */);
2266 Vw32_start_process_share_console
= Qnil
;
2268 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
2269 Vw32_start_process_inherit_error_mode
,
2270 doc
: /* When nil, new child processes revert to the default error mode.
2271 When non-nil, they inherit their error mode setting from Emacs, which stops
2272 them blocking when trying to access unmounted drives etc. */);
2273 Vw32_start_process_inherit_error_mode
= Qt
;
2275 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
2276 doc
: /* Forced delay before reading subprocess output.
2277 This is done to improve the buffering of subprocess output, by
2278 avoiding the inefficiency of frequently reading small amounts of data.
2280 If positive, the value is the number of milliseconds to sleep before
2281 reading the subprocess output. If negative, the magnitude is the number
2282 of time slices to wait (effectively boosting the priority of the child
2283 process temporarily). A value of zero disables waiting entirely. */);
2284 w32_pipe_read_delay
= 50;
2286 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
2287 doc
: /* Non-nil means convert all-upper case file names to lower case.
2288 This applies when performing completions and file name expansion.
2289 Note that the value of this setting also affects remote file names,
2290 so you probably don't want to set to non-nil if you use case-sensitive
2291 filesystems via ange-ftp. */);
2292 Vw32_downcase_file_names
= Qnil
;
2295 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
2296 doc
: /* Non-nil means attempt to fake realistic inode values.
2297 This works by hashing the truename of files, and should detect
2298 aliasing between long and short (8.3 DOS) names, but can have
2299 false positives because of hash collisions. Note that determining
2300 the truename of a file can be slow. */);
2301 Vw32_generate_fake_inodes
= Qnil
;
2304 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
2305 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
2306 This option controls whether to issue additional system calls to determine
2307 accurate link counts, file type, and ownership information. It is more
2308 useful for files on NTFS volumes, where hard links and file security are
2309 supported, than on volumes of the FAT family.
2311 Without these system calls, link count will always be reported as 1 and file
2312 ownership will be attributed to the current user.
2313 The default value `local' means only issue these system calls for files
2314 on local fixed drives. A value of nil means never issue them.
2315 Any other non-nil value means do this even on remote and removable drives
2316 where the performance impact may be noticeable even on modern hardware. */);
2317 Vw32_get_true_file_attributes
= Qlocal
;
2319 staticpro (&Vw32_valid_locale_ids
);
2320 staticpro (&Vw32_valid_codepages
);
2322 /* end of w32proc.c */