blob: 0ba4eedb94dff033ae97a688e240772905b15b4a [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9/*
10 * os_win32.c
11 *
12 * Used for both the console version and the Win32 GUI. A lot of code is for
Bram Moolenaar4f974752019-02-17 17:44:42 +010013 * the console version only, so there is a lot of "#ifndef FEAT_GUI_MSWIN".
Bram Moolenaar071d4272004-06-13 20:20:40 +000014 *
Nir Lichtman563e8ec2024-09-30 19:42:28 +020015 * Win32 system-dependent routines.
Bram Moolenaar071d4272004-06-13 20:20:40 +000016 * Portions lifted from the Win32 SDK samples, the MSDOS-dependent code,
17 * NetHack 3.1.3, GNU Emacs 19.30, and Vile 5.5.
18 *
19 * George V. Reilly <george@reilly.org> wrote most of this.
20 * Roger Knobbe <rogerk@wonderware.com> did the initial port of Vim 3.0.
21 */
22
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#include "vim.h"
24
Bram Moolenaar325b7a22004-07-05 15:58:32 +000025#ifdef FEAT_MZSCHEME
26# include "if_mzsch.h"
27#endif
28
Bram Moolenaar071d4272004-06-13 20:20:40 +000029#include <sys/types.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000030#include <signal.h>
31#include <limits.h>
Bram Moolenaar82881492012-11-20 16:53:39 +010032
Bram Moolenaar0f873732019-12-05 20:28:46 +010033// cproto fails on missing include files
Bram Moolenaar82881492012-11-20 16:53:39 +010034#ifndef PROTO
35# include <process.h>
Bram Moolenaare7bebc42021-02-01 20:50:37 +010036# include <winternl.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000037# include <direct.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
Bram Moolenaar651fca82021-11-29 20:39:38 +000039# if !defined(FEAT_GUI_MSWIN)
Bram Moolenaar82881492012-11-20 16:53:39 +010040# include <shellapi.h>
41# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
K.Takata56f587b2024-06-19 19:56:03 +020043# ifdef FEAT_JOB_CHANNEL
44# include <tlhelp32.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000045# endif
46#endif
47
Bram Moolenaar0f873732019-12-05 20:28:46 +010048// Record all output and all keyboard & mouse input
49// #define MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51#ifdef MCH_WRITE_DUMP
52FILE* fdDump = NULL;
53#endif
54
55/*
56 * When generating prototypes for Win32 on Unix, these lines make the syntax
57 * errors disappear. They do not need to be correct.
58 */
59#ifdef PROTO
Bram Moolenaar912bc4a2019-12-01 18:58:11 +010060# define WINAPI
Bram Moolenaar071d4272004-06-13 20:20:40 +000061typedef char * LPCSTR;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +000062typedef char * LPWSTR;
Bram Moolenaar071d4272004-06-13 20:20:40 +000063typedef int ACCESS_MASK;
64typedef int BOOL;
Paul Ollis65745772022-06-05 16:55:54 +010065typedef int BOOLEAN;
66typedef int CALLBACK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000067typedef int COLORREF;
68typedef int CONSOLE_CURSOR_INFO;
69typedef int COORD;
70typedef int DWORD;
71typedef int HANDLE;
Bram Moolenaaref269542016-01-19 13:22:12 +010072typedef int LPHANDLE;
Bram Moolenaar071d4272004-06-13 20:20:40 +000073typedef int HDC;
74typedef int HFONT;
75typedef int HICON;
76typedef int HINSTANCE;
77typedef int HWND;
78typedef int INPUT_RECORD;
Bram Moolenaare0ab9792017-08-02 23:18:25 +020079typedef int INT;
Bram Moolenaar071d4272004-06-13 20:20:40 +000080typedef int KEY_EVENT_RECORD;
81typedef int LOGFONT;
82typedef int LPBOOL;
83typedef int LPCTSTR;
84typedef int LPDWORD;
85typedef int LPSTR;
86typedef int LPTSTR;
87typedef int LPVOID;
88typedef int MOUSE_EVENT_RECORD;
89typedef int PACL;
90typedef int PDWORD;
91typedef int PHANDLE;
92typedef int PRINTDLG;
93typedef int PSECURITY_DESCRIPTOR;
94typedef int PSID;
95typedef int SECURITY_INFORMATION;
96typedef int SHORT;
97typedef int SMALL_RECT;
98typedef int TEXTMETRIC;
99typedef int TOKEN_INFORMATION_CLASS;
100typedef int TRUSTEE;
101typedef int WORD;
102typedef int WCHAR;
103typedef void VOID;
Bram Moolenaar82881492012-11-20 16:53:39 +0100104typedef int BY_HANDLE_FILE_INFORMATION;
Bram Moolenaar32ac8cd2013-07-03 18:49:17 +0200105typedef int SE_OBJECT_TYPE;
106typedef int PSNSECINFO;
107typedef int PSNSECINFOW;
Bram Moolenaarb8e0bdb2014-11-12 16:10:48 +0100108typedef int STARTUPINFO;
109typedef int PROCESS_INFORMATION;
Bram Moolenaard90b6c02016-08-28 18:10:45 +0200110typedef int LPSECURITY_ATTRIBUTES;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100111# define __stdcall // empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000112#endif
113
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200114#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100115// Win32 Console handles for input and output
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116static HANDLE g_hConIn = INVALID_HANDLE_VALUE;
117static HANDLE g_hConOut = INVALID_HANDLE_VALUE;
118
Bram Moolenaar0f873732019-12-05 20:28:46 +0100119// Win32 Screen buffer,coordinate,console I/O information
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120static SMALL_RECT g_srScrollRegion;
Saleem Abdulrasool38bea302023-12-27 18:57:12 +0100121// This is explicitly initialised to work around a LTCG issue on Windows ARM64
122// (at least of 19.39.33321). This pushes this into the `.data` rather than
123// `.bss` which corrects code generation in `write_chars` (#13453).
124static COORD g_coord = {0, 0}; // 0-based, but external coords are 1-based
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125
Bram Moolenaar0f873732019-12-05 20:28:46 +0100126// The attribute of the screen when the editor was started
127static WORD g_attrDefault = 7; // lightgray text on black background
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128static WORD g_attrCurrent;
129
Bram Moolenaar0f873732019-12-05 20:28:46 +0100130static int g_fCBrkPressed = FALSE; // set by ctrl-break interrupt
131static int g_fCtrlCPressed = FALSE; // set when ctrl-C or ctrl-break detected
132static int g_fForceExit = FALSE; // set when forcefully exiting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134static void scroll(unsigned cLines);
135static void set_scroll_region(unsigned left, unsigned top,
136 unsigned right, unsigned bottom);
Bram Moolenaar6982f422019-02-16 16:48:01 +0100137static void set_scroll_region_tb(unsigned top, unsigned bottom);
138static void set_scroll_region_lr(unsigned left, unsigned right);
139static void insert_lines(unsigned cLines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140static void delete_lines(unsigned cLines);
141static void gotoxy(unsigned x, unsigned y);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142static void standout(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143static int s_cursor_visible = TRUE;
144static int did_create_conin = FALSE;
Christopher Plewright20b795e2022-12-20 20:01:58 +0000145// The 'input_record_buffer' is an internal dynamic fifo queue of MS-Windows
146// console INPUT_RECORD events that are normally read from the console input
147// buffer. This provides an injection point for testing the low-level handling
148// of INPUT_RECORDs.
149typedef struct input_record_buffer_node_S
150{
151 INPUT_RECORD ir;
152 struct input_record_buffer_node_S *next;
153} input_record_buffer_node_T;
154typedef struct input_record_buffer_S
155{
156 input_record_buffer_node_T *head;
157 input_record_buffer_node_T *tail;
158 int length;
159} input_record_buffer_T;
160static input_record_buffer_T input_record_buffer;
Christopher Plewright20b795e2022-12-20 20:01:58 +0000161static int read_input_record_buffer(INPUT_RECORD* irEvents, int nMaxLength);
162static int write_input_record_buffer(INPUT_RECORD* irEvents, int nLength);
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200163#endif
164#ifdef FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165static int s_dont_use_vimrun = TRUE;
166static int need_vimrun_warning = FALSE;
167static char *vimrun_path = "vimrun ";
168#endif
169
Bram Moolenaar12b559e2013-06-12 22:41:37 +0200170static int win32_getattrs(char_u *name);
171static int win32_setattrs(char_u *name, int attrs);
172static int win32_set_archive(char_u *name);
173
Bram Moolenaard9ef1b82019-02-13 19:23:10 +0100174static int conpty_working = 0;
Bram Moolenaar57da6982019-09-13 22:30:11 +0200175static int conpty_type = 0;
Bram Moolenaard9ef1b82019-02-13 19:23:10 +0100176static int conpty_stable = 0;
Bram Moolenaar7ed8f592020-04-28 20:44:42 +0200177static int conpty_fix_type = 0;
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +0100178static void vtp_flag_init();
179
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200180#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar6902c0e2019-02-16 14:07:37 +0100181static int vtp_working = 0;
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100182static void vtp_init();
183static void vtp_exit();
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100184static void vtp_sgr_bulk(int arg);
185static void vtp_sgr_bulks(int argc, int *argv);
186
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200187static int wt_working = 0;
Christopher Plewright1140b512022-11-12 18:46:05 +0000188static void wt_init(void);
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200189
Bram Moolenaarf6ceaf12018-08-30 17:47:05 +0200190static int g_color_index_bg = 0;
191static int g_color_index_fg = 7;
192
193# ifdef FEAT_TERMGUICOLORS
Christopher Plewright38804d62022-11-09 23:55:52 +0000194static guicolor_T save_console_bg_rgb;
195static guicolor_T save_console_fg_rgb;
196static guicolor_T store_console_bg_rgb;
197static guicolor_T store_console_fg_rgb;
Yasuhiro Matsumotoe42c8da2022-09-01 11:31:45 +0100198static int default_console_color_bg = 0x000000; // black
Bram Moolenaarf6ceaf12018-08-30 17:47:05 +0200199static int default_console_color_fg = 0xc0c0c0; // white
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +0000200# define USE_VTP (vtp_working && is_term_win32() \
201 && (p_tgc || t_colors >= 256))
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200202# define USE_WT (wt_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100203# else
204# define USE_VTP 0
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200205# define USE_WT 0
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100206# endif
207
208static void set_console_color_rgb(void);
209static void reset_console_color_rgb(void);
Bram Moolenaardf543822020-01-30 11:53:59 +0100210static void restore_console_color_rgb(void);
Christopher Plewright20b795e2022-12-20 20:01:58 +0000211#endif // !FEAT_GUI_MSWIN || VIMDLL
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100212
Bram Moolenaar0f873732019-12-05 20:28:46 +0100213// This flag is newly created from Windows 10
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100214#ifndef ENABLE_VIRTUAL_TERMINAL_PROCESSING
215# define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x0004
216#endif
217
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200218#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100219static int suppress_winsize = 1; // don't fiddle with console
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220#endif
221
K.Takatace3189d2023-02-15 19:13:43 +0000222static WCHAR *exe_pathw = NULL;
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200223
Bram Moolenaarf50eb782014-02-05 13:36:54 +0100224static BOOL win8_or_later = FALSE;
Christopher Plewrightc8b126d2022-12-22 13:45:23 +0000225static BOOL win10_22H2_or_later = FALSE;
Bram Moolenaar9fca1332022-12-22 21:06:41 +0000226#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Christopher Plewrightc8b126d2022-12-22 13:45:23 +0000227static BOOL use_alternate_screen_buffer = FALSE;
Bram Moolenaar9fca1332022-12-22 21:06:41 +0000228#endif
Bram Moolenaarf50eb782014-02-05 13:36:54 +0100229
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100230/*
231 * Get version number including build number
232 */
233typedef BOOL (WINAPI *PfnRtlGetVersion)(LPOSVERSIONINFOW);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +0100234#define MAKE_VER(major, minor, build) \
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100235 (((major) << 24) | ((minor) << 16) | (build))
236
237 static DWORD
238get_build_number(void)
239{
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100240 OSVERSIONINFOW osver;
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100241 HMODULE hNtdll;
242 PfnRtlGetVersion pRtlGetVersion;
243 DWORD ver = MAKE_VER(0, 0, 0);
244
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100245 osver.dwOSVersionInfoSize = sizeof(OSVERSIONINFOW);
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100246 hNtdll = GetModuleHandle("ntdll.dll");
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000247 if (hNtdll == NULL)
248 return ver;
249
250 pRtlGetVersion =
251 (PfnRtlGetVersion)GetProcAddress(hNtdll, "RtlGetVersion");
252 pRtlGetVersion(&osver);
253 ver = MAKE_VER(min(osver.dwMajorVersion, 255),
254 min(osver.dwMinorVersion, 255),
255 min(osver.dwBuildNumber, 32767));
Bram Moolenaarcafafb32018-02-22 21:07:09 +0100256 return ver;
257}
258
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200259#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200260 static BOOL
261is_ambiwidth_event(
262 INPUT_RECORD *ir)
263{
264 return ir->EventType == KEY_EVENT
265 && ir->Event.KeyEvent.bKeyDown
266 && ir->Event.KeyEvent.wRepeatCount == 1
267 && ir->Event.KeyEvent.wVirtualKeyCode == 0x12
268 && ir->Event.KeyEvent.wVirtualScanCode == 0x38
K.Takata972db232022-02-04 10:45:38 +0000269 && ir->Event.KeyEvent.uChar.UnicodeChar == 0
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200270 && ir->Event.KeyEvent.dwControlKeyState == 2;
271}
272
273 static void
274make_ambiwidth_event(
275 INPUT_RECORD *down,
276 INPUT_RECORD *up)
277{
278 down->Event.KeyEvent.wVirtualKeyCode = 0;
279 down->Event.KeyEvent.wVirtualScanCode = 0;
K.Takata972db232022-02-04 10:45:38 +0000280 down->Event.KeyEvent.uChar.UnicodeChar
281 = up->Event.KeyEvent.uChar.UnicodeChar;
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200282 down->Event.KeyEvent.dwControlKeyState = 0;
283}
284
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100285/*
286 * Version of ReadConsoleInput() that works with IME.
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100287 * Works around problems on Windows 8.
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100288 */
289 static BOOL
290read_console_input(
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100291 HANDLE hInput,
292 INPUT_RECORD *lpBuffer,
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100293 int nLength,
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100294 LPDWORD lpEvents)
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100295{
296 enum
297 {
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100298 IRSIZE = 10
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100299 };
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100300 static INPUT_RECORD s_irCache[IRSIZE];
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100301 static DWORD s_dwIndex = 0;
302 static DWORD s_dwMax = 0;
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100303 DWORD dwEvents;
Bram Moolenaardd415a62014-02-05 14:02:27 +0100304 int head;
305 int tail;
306 int i;
Bram Moolenaarbc970da2020-04-26 19:00:07 +0200307 static INPUT_RECORD s_irPseudo;
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100308
Christopher Plewright20b795e2022-12-20 20:01:58 +0000309 if (s_dwMax == 0 && input_record_buffer.length > 0)
310 {
311 dwEvents = read_input_record_buffer(s_irCache, IRSIZE);
312 s_dwIndex = 0;
313 s_dwMax = dwEvents;
314 }
315
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200316 if (nLength == -2)
317 return (s_dwMax > 0) ? TRUE : FALSE;
318
Bram Moolenaarf50eb782014-02-05 13:36:54 +0100319 if (!win8_or_later)
320 {
321 if (nLength == -1)
Bram Moolenaarac360bf2015-09-01 20:31:20 +0200322 return PeekConsoleInputW(hInput, lpBuffer, 1, lpEvents);
323 return ReadConsoleInputW(hInput, lpBuffer, 1, &dwEvents);
Bram Moolenaarf50eb782014-02-05 13:36:54 +0100324 }
325
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100326 if (s_dwMax == 0)
327 {
Christopher Plewright38804d62022-11-09 23:55:52 +0000328 if (!vtp_working && nLength == -1)
Bram Moolenaarac360bf2015-09-01 20:31:20 +0200329 return PeekConsoleInputW(hInput, lpBuffer, 1, lpEvents);
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200330 GetNumberOfConsoleInputEvents(hInput, &dwEvents);
331 if (dwEvents == 0 && nLength == -1)
332 return PeekConsoleInputW(hInput, lpBuffer, 1, lpEvents);
333 ReadConsoleInputW(hInput, s_irCache, IRSIZE, &dwEvents);
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100334 s_dwIndex = 0;
335 s_dwMax = dwEvents;
336 if (dwEvents == 0)
337 {
338 *lpEvents = 0;
339 return TRUE;
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100340 }
Bram Moolenaardd415a62014-02-05 14:02:27 +0100341
Bram Moolenaar06b7b582020-05-30 17:49:25 +0200342 for (i = s_dwIndex; i < (int)s_dwMax - 1; ++i)
343 if (is_ambiwidth_event(&s_irCache[i]))
344 make_ambiwidth_event(&s_irCache[i], &s_irCache[i + 1]);
345
Bram Moolenaardd415a62014-02-05 14:02:27 +0100346 if (s_dwMax > 1)
347 {
348 head = 0;
349 tail = s_dwMax - 1;
350 while (head != tail)
351 {
352 if (s_irCache[head].EventType == WINDOW_BUFFER_SIZE_EVENT
353 && s_irCache[head + 1].EventType
354 == WINDOW_BUFFER_SIZE_EVENT)
355 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100356 // Remove duplicate event to avoid flicker.
Bram Moolenaardd415a62014-02-05 14:02:27 +0100357 for (i = head; i < tail; ++i)
358 s_irCache[i] = s_irCache[i + 1];
359 --tail;
360 continue;
361 }
362 head++;
363 }
364 s_dwMax = tail + 1;
365 }
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100366 }
Bram Moolenaardd415a62014-02-05 14:02:27 +0100367
Bram Moolenaarbc970da2020-04-26 19:00:07 +0200368 if (s_irCache[s_dwIndex].EventType == KEY_EVENT)
369 {
370 if (s_irCache[s_dwIndex].Event.KeyEvent.wRepeatCount > 1)
371 {
372 s_irPseudo = s_irCache[s_dwIndex];
373 s_irPseudo.Event.KeyEvent.wRepeatCount = 1;
374 s_irCache[s_dwIndex].Event.KeyEvent.wRepeatCount--;
375 *lpBuffer = s_irPseudo;
376 *lpEvents = 1;
377 return TRUE;
378 }
379 }
380
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100381 *lpBuffer = s_irCache[s_dwIndex];
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200382 if (!(nLength == -1 || nLength == -2) && ++s_dwIndex >= s_dwMax)
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100383 s_dwMax = 0;
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100384 *lpEvents = 1;
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100385 return TRUE;
386}
387
388/*
389 * Version of PeekConsoleInput() that works with IME.
390 */
391 static BOOL
392peek_console_input(
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100393 HANDLE hInput,
394 INPUT_RECORD *lpBuffer,
Bram Moolenaarbd67aac2019-09-21 23:09:04 +0200395 DWORD nLength UNUSED,
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100396 LPDWORD lpEvents)
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100397{
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100398 return read_console_input(hInput, lpBuffer, -1, lpEvents);
Bram Moolenaar3a69e112014-01-10 13:51:42 +0100399}
400
Bram Moolenaar418f81b2016-02-16 20:12:02 +0100401# ifdef FEAT_CLIENTSERVER
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200402 static DWORD
403msg_wait_for_multiple_objects(
404 DWORD nCount,
405 LPHANDLE pHandles,
406 BOOL fWaitAll,
407 DWORD dwMilliseconds,
408 DWORD dwWakeMask)
409{
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100410 if (read_console_input(NULL, NULL, -2, NULL))
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200411 return WAIT_OBJECT_0;
412 return MsgWaitForMultipleObjects(nCount, pHandles, fWaitAll,
413 dwMilliseconds, dwWakeMask);
414}
Bram Moolenaar418f81b2016-02-16 20:12:02 +0100415# endif
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200416
Bram Moolenaar418f81b2016-02-16 20:12:02 +0100417# ifndef FEAT_CLIENTSERVER
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200418 static DWORD
419wait_for_single_object(
420 HANDLE hHandle,
421 DWORD dwMilliseconds)
422{
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100423 if (read_console_input(NULL, NULL, -2, NULL))
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200424 return WAIT_OBJECT_0;
425 return WaitForSingleObject(hHandle, dwMilliseconds);
426}
Bram Moolenaar418f81b2016-02-16 20:12:02 +0100427# endif
Christopher Plewright20b795e2022-12-20 20:01:58 +0000428#endif // !FEAT_GUI_MSWIN || VIMDLL
Bram Moolenaarbb86ebb2015-08-04 19:27:05 +0200429
K.Takatace3189d2023-02-15 19:13:43 +0000430 void
431mch_get_exe_name(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100433 // Maximum length of $PATH is more than MAXPATHL. 8191 is often mentioned
K.Takataf741e3e2023-05-15 16:41:40 +0100434 // as the maximum length that works. Add 1 for a NUL byte and 5 for
435 // "PATH=".
436#define MAX_ENV_PATH_LEN (8191 + 1 + 5)
437 WCHAR temp[MAX_ENV_PATH_LEN];
K.Takatace3189d2023-02-15 19:13:43 +0000438 WCHAR buf[MAX_PATH];
439 int updated = FALSE;
440 static int enc_prev = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441
K.Takatace3189d2023-02-15 19:13:43 +0000442 if (exe_name == NULL || exe_pathw == NULL || enc_prev != enc_codepage)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100444 // store the name of the executable, may be used for $VIM
K.Takatace3189d2023-02-15 19:13:43 +0000445 GetModuleFileNameW(NULL, buf, MAX_PATH);
446 if (*buf != NUL)
447 {
448 if (enc_codepage == -1)
449 enc_codepage = GetACP();
K.Takataf741e3e2023-05-15 16:41:40 +0100450 vim_free(exe_name);
K.Takatace3189d2023-02-15 19:13:43 +0000451 exe_name = utf16_to_enc(buf, NULL);
452 enc_prev = enc_codepage;
453
454 WCHAR *wp = wcsrchr(buf, '\\');
455 if (wp != NULL)
456 *wp = NUL;
K.Takataf741e3e2023-05-15 16:41:40 +0100457 vim_free(exe_pathw);
K.Takatace3189d2023-02-15 19:13:43 +0000458 exe_pathw = _wcsdup(buf);
459 updated = TRUE;
460 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000462
K.Takatace3189d2023-02-15 19:13:43 +0000463 if (exe_pathw == NULL || !updated)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000464 return;
465
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000466 // Append our starting directory to $PATH, so that when doing
467 // "!xxd" it's found in our starting directory. Needed because
468 // SearchPath() also looks there.
K.Takataf741e3e2023-05-15 16:41:40 +0100469 WCHAR *p = _wgetenv(L"PATH");
470 if (p == NULL || wcslen(p) + wcslen(exe_pathw) + 2 + 5 < MAX_ENV_PATH_LEN)
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000471 {
K.Takataf741e3e2023-05-15 16:41:40 +0100472 wcscpy(temp, L"PATH=");
473
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000474 if (p == NULL || *p == NUL)
K.Takataf741e3e2023-05-15 16:41:40 +0100475 wcscat(temp, exe_pathw);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000476 else
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000477 {
K.Takataf741e3e2023-05-15 16:41:40 +0100478 wcscat(temp, p);
479
480 // Check if exe_path is already included in $PATH.
481 if (wcsstr(temp, exe_pathw) == NULL)
482 {
483 // Append ';' if $PATH doesn't end with it.
484 size_t len = wcslen(temp);
485 if (temp[len - 1] != L';')
486 wcscat(temp, L";");
487
488 wcscat(temp, exe_pathw);
489 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000490 }
K.Takataf741e3e2023-05-15 16:41:40 +0100491 _wputenv(temp);
492#ifdef libintl_wputenv
493 libintl_wputenv(temp);
494#endif
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000495 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496}
497
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200498/*
Bram Moolenaar6b707b42012-02-21 21:22:44 +0100499 * Unescape characters in "p" that appear in "escaped".
500 */
501 static void
502unescape_shellxquote(char_u *p, char_u *escaped)
503{
Bram Moolenaar4336cdf2012-02-29 13:58:47 +0100504 int l = (int)STRLEN(p);
Bram Moolenaar6b707b42012-02-21 21:22:44 +0100505 int n;
506
507 while (*p != NUL)
508 {
509 if (*p == '^' && vim_strchr(escaped, p[1]) != NULL)
510 mch_memmove(p, p + 1, l--);
Bram Moolenaar6b707b42012-02-21 21:22:44 +0100511 n = (*mb_ptr2len)(p);
Bram Moolenaar6b707b42012-02-21 21:22:44 +0100512 p += n;
513 l -= n;
514 }
515}
516
517/*
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200518 * Load library "name".
519 */
520 HINSTANCE
K.Takatad68b2fc2022-02-12 11:18:37 +0000521vimLoadLib(const char *name)
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200522{
Bram Moolenaar17aa8cc2012-10-21 21:38:45 +0200523 HINSTANCE dll = NULL;
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200524
Bram Moolenaar3d0e7a92021-05-01 17:46:03 +0200525 // No need to load any library when registering OLE.
526 if (found_register_arg)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000527 return NULL;
Bram Moolenaar3d0e7a92021-05-01 17:46:03 +0200528
Bram Moolenaar0f873732019-12-05 20:28:46 +0100529 // NOTE: Do not use mch_dirname() and mch_chdir() here, they may call
530 // vimLoadLib() recursively, which causes a stack overflow.
K.Takatace3189d2023-02-15 19:13:43 +0000531 if (exe_pathw == NULL)
K.Takataf741e3e2023-05-15 16:41:40 +0100532 {
K.Takatace3189d2023-02-15 19:13:43 +0000533 mch_get_exe_name();
K.Takataf741e3e2023-05-15 16:41:40 +0100534 if (exe_pathw == NULL)
535 return NULL;
536 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000537
538 WCHAR old_dirw[MAXPATHL];
539
540 if (GetCurrentDirectoryW(MAXPATHL, old_dirw) == 0)
541 return NULL;
542
543 // Change directory to where the executable is, both to make
544 // sure we find a .dll there and to avoid looking for a .dll
545 // in the current directory.
K.Takatace3189d2023-02-15 19:13:43 +0000546 SetCurrentDirectoryW(exe_pathw);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000547 dll = LoadLibrary(name);
548 SetCurrentDirectoryW(old_dirw);
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200549 return dll;
550}
551
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200552#if defined(VIMDLL) || defined(PROTO)
553/*
554 * Check if the current executable file is for the GUI subsystem.
555 */
556 int
557mch_is_gui_executable(void)
558{
559 PBYTE pImage = (PBYTE)GetModuleHandle(NULL);
560 PIMAGE_DOS_HEADER pDOS = (PIMAGE_DOS_HEADER)pImage;
561 PIMAGE_NT_HEADERS pPE;
562
563 if (pDOS->e_magic != IMAGE_DOS_SIGNATURE)
564 return FALSE;
565 pPE = (PIMAGE_NT_HEADERS)(pImage + pDOS->e_lfanew);
566 if (pPE->Signature != IMAGE_NT_SIGNATURE)
567 return FALSE;
568 if (pPE->OptionalHeader.Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI)
569 return TRUE;
570 return FALSE;
571}
572#endif
573
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000574#if defined(DYNAMIC_ICONV) || defined(DYNAMIC_GETTEXT) \
575 || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100576/*
577 * Get related information about 'funcname' which is imported by 'hInst'.
578 * If 'info' is 0, return the function address.
579 * If 'info' is 1, return the module name which the function is imported from.
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000580 * If 'info' is 2, hook the function with 'ptr', and return the original
581 * function address.
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100582 */
583 static void *
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000584get_imported_func_info(HINSTANCE hInst, const char *funcname, int info,
585 const void *ptr)
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100586{
587 PBYTE pImage = (PBYTE)hInst;
588 PIMAGE_DOS_HEADER pDOS = (PIMAGE_DOS_HEADER)hInst;
589 PIMAGE_NT_HEADERS pPE;
590 PIMAGE_IMPORT_DESCRIPTOR pImpDesc;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100591 PIMAGE_THUNK_DATA pIAT; // Import Address Table
592 PIMAGE_THUNK_DATA pINT; // Import Name Table
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100593 PIMAGE_IMPORT_BY_NAME pImpName;
Ken Takata119fdd92023-10-04 20:05:05 +0200594 DWORD ImpVA;
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100595
596 if (pDOS->e_magic != IMAGE_DOS_SIGNATURE)
597 return NULL;
598 pPE = (PIMAGE_NT_HEADERS)(pImage + pDOS->e_lfanew);
599 if (pPE->Signature != IMAGE_NT_SIGNATURE)
600 return NULL;
Ken Takata119fdd92023-10-04 20:05:05 +0200601
602 ImpVA = pPE->OptionalHeader
603 .DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT].VirtualAddress;
604 if (ImpVA == 0)
605 return NULL; // No Import Table
606 pImpDesc = (PIMAGE_IMPORT_DESCRIPTOR)(pImage + ImpVA);
607
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100608 for (; pImpDesc->FirstThunk; ++pImpDesc)
609 {
610 if (!pImpDesc->OriginalFirstThunk)
611 continue;
612 pIAT = (PIMAGE_THUNK_DATA)(pImage + pImpDesc->FirstThunk);
613 pINT = (PIMAGE_THUNK_DATA)(pImage + pImpDesc->OriginalFirstThunk);
614 for (; pIAT->u1.Function; ++pIAT, ++pINT)
615 {
616 if (IMAGE_SNAP_BY_ORDINAL(pINT->u1.Ordinal))
617 continue;
618 pImpName = (PIMAGE_IMPORT_BY_NAME)(pImage
619 + (UINT_PTR)(pINT->u1.AddressOfData));
620 if (strcmp((char *)pImpName->Name, funcname) == 0)
621 {
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000622 void *original;
623 DWORD old, new = PAGE_READWRITE;
624
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100625 switch (info)
626 {
627 case 0:
628 return (void *)pIAT->u1.Function;
629 case 1:
630 return (void *)(pImage + pImpDesc->Name);
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000631 case 2:
632 original = (void *)pIAT->u1.Function;
633 VirtualProtect(&pIAT->u1.Function, sizeof(void *),
634 new, &old);
635 pIAT->u1.Function = (UINT_PTR)ptr;
636 VirtualProtect(&pIAT->u1.Function, sizeof(void *),
637 old, &new);
638 return original;
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100639 default:
640 return NULL;
641 }
642 }
643 }
644 }
645 return NULL;
646}
647
648/*
649 * Get the module handle which 'funcname' in 'hInst' is imported from.
650 */
651 HINSTANCE
652find_imported_module_by_funcname(HINSTANCE hInst, const char *funcname)
653{
654 char *modulename;
655
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000656 modulename = (char *)get_imported_func_info(hInst, funcname, 1, NULL);
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100657 if (modulename != NULL)
658 return GetModuleHandleA(modulename);
659 return NULL;
660}
661
662/*
663 * Get the address of 'funcname' which is imported by 'hInst' DLL.
664 */
665 void *
666get_dll_import_func(HINSTANCE hInst, const char *funcname)
667{
Bram Moolenaar63ff72a2022-02-07 13:54:01 +0000668 return get_imported_func_info(hInst, funcname, 0, NULL);
669}
670
671/*
672 * Hook the function named 'funcname' which is imported by 'hInst' DLL,
673 * and return the original function address.
674 */
675 void *
676hook_dll_import_func(HINSTANCE hInst, const char *funcname, const void *hook)
677{
678 return get_imported_func_info(hInst, funcname, 2, hook);
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100679}
680#endif
681
Ken Takata119fdd92023-10-04 20:05:05 +0200682#if defined(FEAT_PYTHON3) || defined(PROTO)
683/*
684 * Check if the specified DLL is a function forwarder.
685 * If yes, return the instance of the forwarded DLL.
686 * If no, return the specified DLL.
687 * If error, return NULL.
688 * This assumes that the DLL forwards all the function to a single DLL.
689 */
690 HINSTANCE
691get_forwarded_dll(HINSTANCE hInst)
692{
693 PBYTE pImage = (PBYTE)hInst;
694 PIMAGE_DOS_HEADER pDOS = (PIMAGE_DOS_HEADER)hInst;
695 PIMAGE_NT_HEADERS pPE;
696 PIMAGE_EXPORT_DIRECTORY pExpDir;
697 DWORD ExpVA;
698 DWORD ExpSize;
699 LPDWORD pFunctionTable;
700
701 if (pDOS->e_magic != IMAGE_DOS_SIGNATURE)
702 return NULL;
703 pPE = (PIMAGE_NT_HEADERS)(pImage + pDOS->e_lfanew);
704 if (pPE->Signature != IMAGE_NT_SIGNATURE)
705 return NULL;
706
707 ExpVA = pPE->OptionalHeader
708 .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].VirtualAddress;
709 ExpSize = pPE->OptionalHeader
710 .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].Size;
711 if (ExpVA == 0)
712 return hInst; // No Export Directory
713 pExpDir = (PIMAGE_EXPORT_DIRECTORY)(pImage + ExpVA);
714 pFunctionTable = (LPDWORD)(pImage + pExpDir->AddressOfFunctions);
715
716 if (pExpDir->NumberOfNames == 0)
717 return hInst; // No export names.
718
719 // Check only the first entry.
720 if ((pFunctionTable[0] < ExpVA) || (pFunctionTable[0] >= ExpVA + ExpSize))
721 // The first entry is not a function forwarder.
722 return hInst;
723
724 // The first entry is a function forwarder.
725 // The name is represented as "DllName.FunctionName".
726 const char *name = (const char *)(pImage + pFunctionTable[0]);
727 const char *p = strchr(name, '.');
728 if (p == NULL)
729 return hInst;
730
731 // Extract DllName.
732 char buf[MAX_PATH];
733 if (p - name + 1 > sizeof(buf))
734 return NULL;
735 strncpy(buf, name, p - name);
736 buf[p - name] = '\0';
737 return GetModuleHandleA(buf);
738}
739#endif
740
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741#if defined(DYNAMIC_GETTEXT) || defined(PROTO)
742# ifndef GETTEXT_DLL
743# define GETTEXT_DLL "libintl.dll"
Bram Moolenaar7554c542018-10-06 15:03:15 +0200744# define GETTEXT_DLL_ALT1 "libintl-8.dll"
745# define GETTEXT_DLL_ALT2 "intl.dll"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +0100747// Dummy functions
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000748static char *null_libintl_gettext(const char *);
Bram Moolenaaree695f72016-08-03 22:08:45 +0200749static char *null_libintl_ngettext(const char *, const char *, unsigned long n);
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000750static char *null_libintl_textdomain(const char *);
751static char *null_libintl_bindtextdomain(const char *, const char *);
752static char *null_libintl_bind_textdomain_codeset(const char *, const char *);
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +0100753static int null_libintl_wputenv(const wchar_t *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200755static HINSTANCE hLibintlDLL = NULL;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000756char *(*dyn_libintl_gettext)(const char *) = null_libintl_gettext;
Bram Moolenaaree695f72016-08-03 22:08:45 +0200757char *(*dyn_libintl_ngettext)(const char *, const char *, unsigned long n)
758 = null_libintl_ngettext;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000759char *(*dyn_libintl_textdomain)(const char *) = null_libintl_textdomain;
760char *(*dyn_libintl_bindtextdomain)(const char *, const char *)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 = null_libintl_bindtextdomain;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000762char *(*dyn_libintl_bind_textdomain_codeset)(const char *, const char *)
763 = null_libintl_bind_textdomain_codeset;
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +0100764int (*dyn_libintl_wputenv)(const wchar_t *) = null_libintl_wputenv;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765
766 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100767dyn_libintl_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768{
769 int i;
770 static struct
771 {
772 char *name;
773 FARPROC *ptr;
774 } libintl_entry[] =
775 {
776 {"gettext", (FARPROC*)&dyn_libintl_gettext},
Bram Moolenaaree695f72016-08-03 22:08:45 +0200777 {"ngettext", (FARPROC*)&dyn_libintl_ngettext},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 {"textdomain", (FARPROC*)&dyn_libintl_textdomain},
779 {"bindtextdomain", (FARPROC*)&dyn_libintl_bindtextdomain},
780 {NULL, NULL}
781 };
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100782 HINSTANCE hmsvcrt;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783
Bram Moolenaar7554c542018-10-06 15:03:15 +0200784 // No need to initialize twice.
785 if (hLibintlDLL != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 return 1;
Bram Moolenaar7554c542018-10-06 15:03:15 +0200787 // Load gettext library (libintl.dll and other names).
Bram Moolenaar923e43b2016-01-28 15:07:38 +0100788 hLibintlDLL = vimLoadLib(GETTEXT_DLL);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +0100789# ifdef GETTEXT_DLL_ALT1
Bram Moolenaar286eacd2016-01-16 18:05:50 +0100790 if (!hLibintlDLL)
Bram Moolenaar7554c542018-10-06 15:03:15 +0200791 hLibintlDLL = vimLoadLib(GETTEXT_DLL_ALT1);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +0100792# endif
793# ifdef GETTEXT_DLL_ALT2
Bram Moolenaar7554c542018-10-06 15:03:15 +0200794 if (!hLibintlDLL)
795 hLibintlDLL = vimLoadLib(GETTEXT_DLL_ALT2);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +0100796# endif
Bram Moolenaar938ee832016-01-24 15:36:03 +0100797 if (!hLibintlDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 {
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200799 if (p_verbose > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 {
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200801 verbose_enter();
Bram Moolenaar460ae5d2022-01-01 14:19:49 +0000802 semsg(_(e_could_not_load_library_str_str), GETTEXT_DLL, GetWin32Error());
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200803 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 }
Bram Moolenaarebbcb822010-10-23 14:02:54 +0200805 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 }
807 for (i = 0; libintl_entry[i].name != NULL
808 && libintl_entry[i].ptr != NULL; ++i)
809 {
K.Takata54119102022-02-03 13:33:03 +0000810 if ((*libintl_entry[i].ptr = GetProcAddress(hLibintlDLL,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 libintl_entry[i].name)) == NULL)
812 {
813 dyn_libintl_end();
814 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +0000815 {
816 verbose_enter();
Bram Moolenaar460ae5d2022-01-01 14:19:49 +0000817 semsg(_(e_could_not_load_library_function_str), libintl_entry[i].name);
Bram Moolenaara04f10b2005-05-31 22:09:46 +0000818 verbose_leave();
819 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 return 0;
821 }
822 }
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000823
Bram Moolenaar0f873732019-12-05 20:28:46 +0100824 // The bind_textdomain_codeset() function is optional.
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100825 dyn_libintl_bind_textdomain_codeset = (char *(*)(const char *, const char *))
826 GetProcAddress(hLibintlDLL, "bind_textdomain_codeset");
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000827 if (dyn_libintl_bind_textdomain_codeset == NULL)
828 dyn_libintl_bind_textdomain_codeset =
829 null_libintl_bind_textdomain_codeset;
830
Bram Moolenaar0f873732019-12-05 20:28:46 +0100831 // _wputenv() function for the libintl.dll is optional.
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100832 hmsvcrt = find_imported_module_by_funcname(hLibintlDLL, "getenv");
833 if (hmsvcrt != NULL)
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +0100834 dyn_libintl_wputenv = (int (*)(const wchar_t *))
835 GetProcAddress(hmsvcrt, "_wputenv");
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +0100836 if (dyn_libintl_wputenv == NULL || dyn_libintl_wputenv == _wputenv)
837 dyn_libintl_wputenv = null_libintl_wputenv;
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100838
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 return 1;
840}
841
842 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100843dyn_libintl_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844{
845 if (hLibintlDLL)
846 FreeLibrary(hLibintlDLL);
847 hLibintlDLL = NULL;
848 dyn_libintl_gettext = null_libintl_gettext;
Bram Moolenaaree695f72016-08-03 22:08:45 +0200849 dyn_libintl_ngettext = null_libintl_ngettext;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 dyn_libintl_textdomain = null_libintl_textdomain;
851 dyn_libintl_bindtextdomain = null_libintl_bindtextdomain;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000852 dyn_libintl_bind_textdomain_codeset = null_libintl_bind_textdomain_codeset;
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +0100853 dyn_libintl_wputenv = null_libintl_wputenv;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854}
855
856 static char *
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000857null_libintl_gettext(const char *msgid)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858{
859 return (char*)msgid;
860}
861
862 static char *
Bram Moolenaaree695f72016-08-03 22:08:45 +0200863null_libintl_ngettext(
864 const char *msgid,
865 const char *msgid_plural,
866 unsigned long n)
867{
Bram Moolenaarc90f2ae2016-08-04 22:00:15 +0200868 return (char *)(n == 1 ? msgid : msgid_plural);
Bram Moolenaaree695f72016-08-03 22:08:45 +0200869}
870
Bram Moolenaaree695f72016-08-03 22:08:45 +0200871 static char *
Bram Moolenaar1266d672017-02-01 13:43:36 +0100872null_libintl_bindtextdomain(
873 const char *domainname UNUSED,
874 const char *dirname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875{
876 return NULL;
877}
878
879 static char *
Bram Moolenaar1266d672017-02-01 13:43:36 +0100880null_libintl_bind_textdomain_codeset(
881 const char *domainname UNUSED,
882 const char *codeset UNUSED)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000883{
884 return NULL;
885}
886
887 static char *
Bram Moolenaar1266d672017-02-01 13:43:36 +0100888null_libintl_textdomain(const char *domainname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889{
890 return NULL;
891}
892
Bram Moolenaare0ab9792017-08-02 23:18:25 +0200893 static int
Bram Moolenaar1266d672017-02-01 13:43:36 +0100894null_libintl_wputenv(const wchar_t *envstring UNUSED)
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +0100895{
896 return 0;
897}
898
Bram Moolenaar0f873732019-12-05 20:28:46 +0100899#endif // DYNAMIC_GETTEXT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
Bram Moolenaar0f873732019-12-05 20:28:46 +0100901// This symbol is not defined in older versions of the SDK or Visual C++
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902
903#ifndef VER_PLATFORM_WIN32_WINDOWS
904# define VER_PLATFORM_WIN32_WINDOWS 1
905#endif
906
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907#ifdef HAVE_ACL
Bram Moolenaar82881492012-11-20 16:53:39 +0100908# ifndef PROTO
909# include <aclapi.h>
910# endif
Bram Moolenaar27515922013-06-29 15:36:26 +0200911# ifndef PROTECTED_DACL_SECURITY_INFORMATION
912# define PROTECTED_DACL_SECURITY_INFORMATION 0x80000000L
913# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914#endif
915
Bram Moolenaar27515922013-06-29 15:36:26 +0200916#ifdef HAVE_ACL
917/*
918 * Enables or disables the specified privilege.
919 */
920 static BOOL
Nir Lichtmanb5165982024-10-13 19:44:07 +0200921win32_enable_privilege(LPTSTR lpszPrivilege)
Bram Moolenaar27515922013-06-29 15:36:26 +0200922{
Bram Moolenaarb0d5c962014-01-12 13:24:51 +0100923 LUID luid;
924 HANDLE hToken;
925 TOKEN_PRIVILEGES tokenPrivileges;
Bram Moolenaar27515922013-06-29 15:36:26 +0200926
927 if (!OpenProcessToken(GetCurrentProcess(),
928 TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hToken))
929 return FALSE;
930
931 if (!LookupPrivilegeValue(NULL, lpszPrivilege, &luid))
932 {
933 CloseHandle(hToken);
934 return FALSE;
935 }
936
Bram Moolenaar45500912014-07-09 20:51:07 +0200937 tokenPrivileges.PrivilegeCount = 1;
Bram Moolenaar27515922013-06-29 15:36:26 +0200938 tokenPrivileges.Privileges[0].Luid = luid;
Nir Lichtmanb5165982024-10-13 19:44:07 +0200939 tokenPrivileges.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
Bram Moolenaar27515922013-06-29 15:36:26 +0200940
Nir Lichtmanb5165982024-10-13 19:44:07 +0200941 if (!AdjustTokenPrivileges(hToken, FALSE, &tokenPrivileges, 0, NULL, NULL))
942 {
943 CloseHandle(hToken);
944 return FALSE;
945 }
946
947 if (GetLastError() != ERROR_SUCCESS)
948 {
949 CloseHandle(hToken);
950 return FALSE;
951 }
Bram Moolenaar27515922013-06-29 15:36:26 +0200952
953 CloseHandle(hToken);
Nir Lichtmanb5165982024-10-13 19:44:07 +0200954 return TRUE;
Bram Moolenaar27515922013-06-29 15:36:26 +0200955}
956#endif
957
Bram Moolenaar29d2f452020-12-04 19:42:52 +0100958#ifdef _MSC_VER
959// Suppress the deprecation warning for using GetVersionEx().
960// It is needed for implementing "windowsversion()".
961# pragma warning(push)
962# pragma warning(disable: 4996)
963#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964/*
Bram Moolenaar1e1d2e82020-05-18 20:17:02 +0200965 * Set "win8_or_later" and fill in "windowsVersion" if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 */
967 void
968PlatformId(void)
969{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000970 OSVERSIONINFO ovi;
971
972 ovi.dwOSVersionInfoSize = sizeof(ovi);
Nir Lichtmanb5165982024-10-13 19:44:07 +0200973 if (!GetVersionEx(&ovi))
974 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975
Bram Moolenaar1e1d2e82020-05-18 20:17:02 +0200976#ifdef FEAT_EVAL
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000977 vim_snprintf(windowsVersion, sizeof(windowsVersion), "%d.%d",
978 (int)ovi.dwMajorVersion, (int)ovi.dwMinorVersion);
Bram Moolenaar1e1d2e82020-05-18 20:17:02 +0200979#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000980 if ((ovi.dwMajorVersion == 6 && ovi.dwMinorVersion >= 2)
981 || ovi.dwMajorVersion > 6)
982 win8_or_later = TRUE;
Bram Moolenaarf50eb782014-02-05 13:36:54 +0100983
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000984 if ((ovi.dwMajorVersion == 10 && ovi.dwBuildNumber >= 19045)
985 || ovi.dwMajorVersion > 10)
986 win10_22H2_or_later = TRUE;
Christopher Plewright1140b512022-11-12 18:46:05 +0000987
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988#ifdef HAVE_ACL
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000989 // Enable privilege for getting or setting SACLs.
Nir Lichtmanb5165982024-10-13 19:44:07 +0200990 if (!win32_enable_privilege(SE_SECURITY_NAME))
991 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993}
Bram Moolenaar29d2f452020-12-04 19:42:52 +0100994#ifdef _MSC_VER
995# pragma warning(pop)
996#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997
Bram Moolenaarafde13b2019-04-28 19:46:49 +0200998#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01001000# define SHIFT (SHIFT_PRESSED)
1001# define CTRL (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED)
1002# define ALT (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED)
1003# define ALT_GR (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004
1005
Bram Moolenaar0f873732019-12-05 20:28:46 +01001006// When uChar.AsciiChar is 0, then we need to look at wVirtualKeyCode.
1007// We map function keys to their ANSI terminal equivalents, as produced
1008// by ANSI.SYS, for compatibility with the MS-DOS version of Vim. Any
1009// ANSI key with a value >= '\300' is nonstandard, but provided anyway
1010// so that the user can have access to all SHIFT-, CTRL-, and ALT-
1011// combinations of function/arrow/etc keys.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012
Bram Moolenaard6f676d2005-06-01 21:51:55 +00001013static const struct
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014{
1015 WORD wVirtKey;
1016 BOOL fAnsiKey;
1017 int chAlone;
1018 int chShift;
1019 int chCtrl;
1020 int chAlt;
1021} VirtKeyMap[] =
1022{
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001023// Key ANSI alone shift ctrl alt
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024 { VK_ESCAPE,FALSE, ESC, ESC, ESC, ESC, },
1025
1026 { VK_F1, TRUE, ';', 'T', '^', 'h', },
1027 { VK_F2, TRUE, '<', 'U', '_', 'i', },
1028 { VK_F3, TRUE, '=', 'V', '`', 'j', },
1029 { VK_F4, TRUE, '>', 'W', 'a', 'k', },
1030 { VK_F5, TRUE, '?', 'X', 'b', 'l', },
1031 { VK_F6, TRUE, '@', 'Y', 'c', 'm', },
1032 { VK_F7, TRUE, 'A', 'Z', 'd', 'n', },
1033 { VK_F8, TRUE, 'B', '[', 'e', 'o', },
1034 { VK_F9, TRUE, 'C', '\\', 'f', 'p', },
1035 { VK_F10, TRUE, 'D', ']', 'g', 'q', },
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001036 { VK_F11, TRUE, '\205', '\207', '\211', '\213', },
1037 { VK_F12, TRUE, '\206', '\210', '\212', '\214', },
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001039 { VK_HOME, TRUE, 'G', '\302', 'w', '\303', },
1040 { VK_UP, TRUE, 'H', '\304', '\305', '\306', },
1041 { VK_PRIOR, TRUE, 'I', '\307', '\204', '\310', }, // PgUp
1042 { VK_LEFT, TRUE, 'K', '\311', 's', '\312', },
1043 { VK_RIGHT, TRUE, 'M', '\313', 't', '\314', },
1044 { VK_END, TRUE, 'O', '\315', 'u', '\316', },
1045 { VK_DOWN, TRUE, 'P', '\317', '\320', '\321', },
1046 { VK_NEXT, TRUE, 'Q', '\322', 'v', '\323', }, // PgDn
1047 { VK_INSERT,TRUE, 'R', '\324', '\325', '\326', },
1048 { VK_DELETE,TRUE, 'S', '\327', '\330', '\331', },
Bram Moolenaarb70a47b2019-03-30 22:11:21 +01001049 { VK_BACK, TRUE, 'x', 'y', 'z', '{', }, // Backspace
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001051 { VK_SNAPSHOT,TRUE, 0, 0, 0, 'r', }, // PrtScrn
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01001053# if 0
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001054 // Most people don't have F13-F20, but what the hell...
1055 { VK_F13, TRUE, '\332', '\333', '\334', '\335', },
1056 { VK_F14, TRUE, '\336', '\337', '\340', '\341', },
1057 { VK_F15, TRUE, '\342', '\343', '\344', '\345', },
1058 { VK_F16, TRUE, '\346', '\347', '\350', '\351', },
1059 { VK_F17, TRUE, '\352', '\353', '\354', '\355', },
1060 { VK_F18, TRUE, '\356', '\357', '\360', '\361', },
1061 { VK_F19, TRUE, '\362', '\363', '\364', '\365', },
1062 { VK_F20, TRUE, '\366', '\367', '\370', '\371', },
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01001063# endif
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001064 { VK_ADD, TRUE, 'N', 'N', 'N', 'N', }, // keyp '+'
1065 { VK_SUBTRACT, TRUE,'J', 'J', 'J', 'J', }, // keyp '-'
1066 // { VK_DIVIDE, TRUE,'N', 'N', 'N', 'N', }, // keyp '/'
1067 { VK_MULTIPLY, TRUE,'7', '7', '7', '7', }, // keyp '*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02001069 { VK_NUMPAD0,TRUE, '\332', '\333', '\334', '\335', },
1070 { VK_NUMPAD1,TRUE, '\336', '\337', '\340', '\341', },
1071 { VK_NUMPAD2,TRUE, '\342', '\343', '\344', '\345', },
1072 { VK_NUMPAD3,TRUE, '\346', '\347', '\350', '\351', },
1073 { VK_NUMPAD4,TRUE, '\352', '\353', '\354', '\355', },
1074 { VK_NUMPAD5,TRUE, '\356', '\357', '\360', '\361', },
1075 { VK_NUMPAD6,TRUE, '\362', '\363', '\364', '\365', },
1076 { VK_NUMPAD7,TRUE, '\366', '\367', '\370', '\371', },
1077 { VK_NUMPAD8,TRUE, '\372', '\373', '\374', '\375', },
1078 // Sorry, out of number space! <negri>
Bram Moolenaarb70a47b2019-03-30 22:11:21 +01001079 { VK_NUMPAD9,TRUE, '\376', '\377', '|', '}', },
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080};
1081
1082
Bram Moolenaar0f873732019-12-05 20:28:46 +01001083/*
1084 * The return code indicates key code size.
1085 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 static int
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087win32_kbd_patch_key(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001088 KEY_EVENT_RECORD *pker)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089{
1090 UINT uMods = pker->dwControlKeyState;
1091 static int s_iIsDead = 0;
1092 static WORD awAnsiCode[2];
1093 static BYTE abKeystate[256];
1094
1095
1096 if (s_iIsDead == 2)
1097 {
K.Takata972db232022-02-04 10:45:38 +00001098 pker->uChar.UnicodeChar = (WCHAR) awAnsiCode[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 s_iIsDead = 0;
1100 return 1;
1101 }
1102
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001103 // check if it already has a valid unicode character.
Christopher Plewright566f76e2023-01-10 13:43:04 +00001104 if (pker->uChar.UnicodeChar != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 return 1;
1106
Bram Moolenaara80faa82020-04-12 19:37:17 +02001107 CLEAR_FIELD(abKeystate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108
Bram Moolenaar0f873732019-12-05 20:28:46 +01001109 // Clear any pending dead keys
Bram Moolenaarac360bf2015-09-01 20:31:20 +02001110 ToUnicode(VK_SPACE, MapVirtualKey(VK_SPACE, 0), abKeystate, awAnsiCode, 2, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111
1112 if (uMods & SHIFT_PRESSED)
1113 abKeystate[VK_SHIFT] = 0x80;
1114 if (uMods & CAPSLOCK_ON)
1115 abKeystate[VK_CAPITAL] = 1;
1116
1117 if ((uMods & ALT_GR) == ALT_GR)
1118 {
1119 abKeystate[VK_CONTROL] = abKeystate[VK_LCONTROL] =
1120 abKeystate[VK_MENU] = abKeystate[VK_RMENU] = 0x80;
1121 }
1122
Bram Moolenaarac360bf2015-09-01 20:31:20 +02001123 s_iIsDead = ToUnicode(pker->wVirtualKeyCode, pker->wVirtualScanCode,
1124 abKeystate, awAnsiCode, 2, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
1126 if (s_iIsDead > 0)
K.Takata972db232022-02-04 10:45:38 +00001127 pker->uChar.UnicodeChar = (WCHAR) awAnsiCode[0];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
1129 return s_iIsDead;
1130}
1131
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132static BOOL g_fJustGotFocus = FALSE;
1133
1134/*
1135 * Decode a KEY_EVENT into one or two keystrokes
1136 */
1137 static BOOL
1138decode_key_event(
1139 KEY_EVENT_RECORD *pker,
Bram Moolenaarac360bf2015-09-01 20:31:20 +02001140 WCHAR *pch,
1141 WCHAR *pch2,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 int *pmodifiers,
Bram Moolenaarbd67aac2019-09-21 23:09:04 +02001143 BOOL fDoPost UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144{
1145 int i;
1146 const int nModifs = pker->dwControlKeyState & (SHIFT | ALT | CTRL);
1147
1148 *pch = *pch2 = NUL;
1149 g_fJustGotFocus = FALSE;
1150
Bram Moolenaar0f873732019-12-05 20:28:46 +01001151 // ignore key up events
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 if (!pker->bKeyDown)
1153 return FALSE;
1154
Bram Moolenaar0f873732019-12-05 20:28:46 +01001155 // ignore some keystrokes
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 switch (pker->wVirtualKeyCode)
1157 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001158 // modifiers
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 case VK_SHIFT:
1160 case VK_CONTROL:
Bram Moolenaar0f873732019-12-05 20:28:46 +01001161 case VK_MENU: // Alt key
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 return FALSE;
1163
1164 default:
1165 break;
1166 }
1167
Bram Moolenaar0f873732019-12-05 20:28:46 +01001168 // Shift-TAB
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 if (pker->wVirtualKeyCode == VK_TAB && (nModifs & SHIFT_PRESSED))
1170 {
1171 *pch = K_NUL;
1172 *pch2 = '\017';
1173 return TRUE;
1174 }
1175
K.Takataeeec2542021-06-02 13:28:16 +02001176 for (i = ARRAY_LENGTH(VirtKeyMap); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 {
1178 if (VirtKeyMap[i].wVirtKey == pker->wVirtualKeyCode)
1179 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001180 *pch = VirtKeyMap[i].chAlone;
1181 if ((nModifs & SHIFT) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 *pch = VirtKeyMap[i].chShift;
1183 else if ((nModifs & CTRL) != 0 && (nModifs & ~CTRL) == 0)
1184 *pch = VirtKeyMap[i].chCtrl;
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001185 else if ((nModifs & ALT) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 *pch = VirtKeyMap[i].chAlt;
1187
1188 if (*pch != 0)
1189 {
1190 if (VirtKeyMap[i].fAnsiKey)
1191 {
1192 *pch2 = *pch;
1193 *pch = K_NUL;
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001194 if (pmodifiers)
1195 {
1196 if (pker->wVirtualKeyCode >= VK_F1
1197 && pker->wVirtualKeyCode <= VK_F12)
1198 {
1199 if ((nModifs & ALT) != 0)
1200 {
1201 *pmodifiers |= MOD_MASK_ALT;
1202 if ((nModifs & SHIFT) == 0)
1203 *pch2 = VirtKeyMap[i].chAlone;
1204 }
1205 if ((nModifs & CTRL) != 0)
1206 {
1207 *pmodifiers |= MOD_MASK_CTRL;
1208 if ((nModifs & SHIFT) == 0)
1209 *pch2 = VirtKeyMap[i].chAlone;
1210 }
1211 }
1212 else if (pker->wVirtualKeyCode >= VK_END
1213 && pker->wVirtualKeyCode <= VK_DOWN)
1214 {
Christopher Plewright566f76e2023-01-10 13:43:04 +00001215 // (0x23 - 0x28): VK_END, VK_HOME,
1216 // VK_LEFT, VK_UP, VK_RIGHT, VK_DOWN
1217
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001218 *pmodifiers = 0;
1219 *pch2 = VirtKeyMap[i].chAlone;
1220 if ((nModifs & SHIFT) != 0
1221 && (nModifs & ~SHIFT) == 0)
1222 {
1223 *pch2 = VirtKeyMap[i].chShift;
1224 }
Christopher Plewright566f76e2023-01-10 13:43:04 +00001225 if ((nModifs & CTRL) != 0
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001226 && (nModifs & ~CTRL) == 0)
1227 {
1228 *pch2 = VirtKeyMap[i].chCtrl;
1229 if (pker->wVirtualKeyCode == VK_UP
1230 || pker->wVirtualKeyCode == VK_DOWN)
1231 {
1232 *pmodifiers |= MOD_MASK_CTRL;
1233 *pch2 = VirtKeyMap[i].chAlone;
1234 }
1235 }
Christopher Plewright566f76e2023-01-10 13:43:04 +00001236 if ((nModifs & SHIFT) != 0
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001237 && (nModifs & CTRL) != 0)
1238 {
1239 *pmodifiers |= MOD_MASK_CTRL;
1240 *pch2 = VirtKeyMap[i].chShift;
1241 }
Christopher Plewright566f76e2023-01-10 13:43:04 +00001242 if ((nModifs & ALT) != 0)
1243 {
1244 *pch2 = VirtKeyMap[i].chAlt;
1245 *pmodifiers |= MOD_MASK_ALT;
1246 if ((nModifs & ~ALT) == 0)
1247 {
1248 *pch2 = VirtKeyMap[i].chAlone;
1249 }
1250 else if ((nModifs & SHIFT) != 0)
1251 {
1252 *pch2 = VirtKeyMap[i].chShift;
1253 }
1254 else if ((nModifs & CTRL) != 0)
1255 {
1256 if (pker->wVirtualKeyCode == VK_UP
1257 || pker->wVirtualKeyCode == VK_DOWN)
1258 {
1259 *pmodifiers |= MOD_MASK_CTRL;
1260 *pch2 = VirtKeyMap[i].chAlone;
1261 }
1262 else
1263 {
1264 *pch2 = VirtKeyMap[i].chCtrl;
1265 }
1266 }
1267 }
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001268 }
Christopher Plewrightf5f69e82024-08-04 19:57:44 +02001269 else if (pker->wVirtualKeyCode == VK_INSERT
1270 && (nModifs & SHIFT) != 0
1271 && (nModifs & ~SHIFT) == 0)
1272 {
1273 *pmodifiers = 0;
1274 *pch2 = VirtKeyMap[i].chShift;
1275 }
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001276 else
1277 {
1278 *pch2 = VirtKeyMap[i].chAlone;
1279 if ((nModifs & SHIFT) != 0)
1280 *pmodifiers |= MOD_MASK_SHIFT;
1281 if ((nModifs & CTRL) != 0)
1282 *pmodifiers |= MOD_MASK_CTRL;
1283 if ((nModifs & ALT) != 0)
1284 *pmodifiers |= MOD_MASK_ALT;
1285 }
1286 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 }
1288
1289 return TRUE;
1290 }
1291 }
1292 }
1293
1294 i = win32_kbd_patch_key(pker);
1295
1296 if (i < 0)
1297 *pch = NUL;
1298 else
1299 {
K.Takata972db232022-02-04 10:45:38 +00001300 *pch = (i > 0) ? pker->uChar.UnicodeChar : NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301
1302 if (pmodifiers != NULL)
1303 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001304 // Pass on the ALT key as a modifier, but only when not combined
1305 // with CTRL (which is ALTGR).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 if ((nModifs & ALT) != 0 && (nModifs & CTRL) == 0)
1307 *pmodifiers |= MOD_MASK_ALT;
1308
Bram Moolenaar0f873732019-12-05 20:28:46 +01001309 // Pass on SHIFT only for special keys, because we don't know when
1310 // it's already included with the character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 if ((nModifs & SHIFT) != 0 && *pch <= 0x20)
1312 *pmodifiers |= MOD_MASK_SHIFT;
1313
Bram Moolenaar0f873732019-12-05 20:28:46 +01001314 // Pass on CTRL only for non-special keys, because we don't know
1315 // when it's already included with the character. And not when
1316 // combined with ALT (which is ALTGR).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 if ((nModifs & CTRL) != 0 && (nModifs & ALT) == 0
1318 && *pch >= 0x20 && *pch < 0x80)
1319 *pmodifiers |= MOD_MASK_CTRL;
1320 }
1321 }
1322
1323 return (*pch != NUL);
1324}
1325
Christopher Plewright20b795e2022-12-20 20:01:58 +00001326# if defined(FEAT_EVAL)
1327 static int
1328encode_key_event(dict_T *args, INPUT_RECORD *ir)
1329{
1330 static int s_dwMods = 0;
1331
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001332 char_u *action = dict_get_string(args, "event", TRUE);
1333 if (action && (STRICMP(action, "keydown") == 0
1334 || STRICMP(action, "keyup") == 0))
Christopher Plewright20b795e2022-12-20 20:01:58 +00001335 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001336 BOOL isKeyDown = STRICMP(action, "keydown") == 0;
Christopher Plewright20b795e2022-12-20 20:01:58 +00001337 WORD vkCode = dict_get_number_def(args, "keycode", 0);
1338 if (vkCode <= 0 || vkCode >= 0xFF)
1339 {
1340 semsg(_(e_invalid_argument_nr), (long)vkCode);
1341 return FALSE;
1342 }
1343
1344 ir->EventType = KEY_EVENT;
1345 KEY_EVENT_RECORD ker;
1346 ZeroMemory(&ker, sizeof(ker));
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001347 ker.bKeyDown = isKeyDown;
Christopher Plewright20b795e2022-12-20 20:01:58 +00001348 ker.wRepeatCount = 1;
1349 ker.wVirtualScanCode = 0;
1350 ker.dwControlKeyState = 0;
1351 int mods = (int)dict_get_number(args, "modifiers");
1352 // Encode the win32 console key modifiers from Vim keyboard modifiers.
1353 if (mods)
1354 {
1355 // If "modifiers" is explicitly set in the args, then we reset any
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00001356 // remembered modifier key state that may have been set from
1357 // earlier mod-key-down events, even if they are not yet unset by
1358 // earlier mod-key-up events.
Christopher Plewright20b795e2022-12-20 20:01:58 +00001359 s_dwMods = 0;
1360 if (mods & MOD_MASK_SHIFT)
1361 ker.dwControlKeyState |= SHIFT_PRESSED;
1362 if (mods & MOD_MASK_CTRL)
1363 ker.dwControlKeyState |= LEFT_CTRL_PRESSED;
1364 if (mods & MOD_MASK_ALT)
1365 ker.dwControlKeyState |= LEFT_ALT_PRESSED;
1366 }
1367
1368 if (vkCode == VK_LSHIFT || vkCode == VK_RSHIFT || vkCode == VK_SHIFT)
1369 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001370 if (isKeyDown)
Christopher Plewright20b795e2022-12-20 20:01:58 +00001371 s_dwMods |= SHIFT_PRESSED;
1372 else
1373 s_dwMods &= ~SHIFT_PRESSED;
1374 }
1375 else if (vkCode == VK_LCONTROL || vkCode == VK_CONTROL)
1376 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001377 if (isKeyDown)
Christopher Plewright20b795e2022-12-20 20:01:58 +00001378 s_dwMods |= LEFT_CTRL_PRESSED;
1379 else
1380 s_dwMods &= ~LEFT_CTRL_PRESSED;
1381 }
1382 else if (vkCode == VK_RCONTROL)
1383 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001384 if (isKeyDown)
Christopher Plewright20b795e2022-12-20 20:01:58 +00001385 s_dwMods |= RIGHT_CTRL_PRESSED;
1386 else
1387 s_dwMods &= ~RIGHT_CTRL_PRESSED;
1388 }
1389 else if (vkCode == VK_LMENU || vkCode == VK_MENU)
1390 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001391 if (isKeyDown)
Christopher Plewright20b795e2022-12-20 20:01:58 +00001392 s_dwMods |= LEFT_ALT_PRESSED;
1393 else
1394 s_dwMods &= ~LEFT_ALT_PRESSED;
1395 }
1396 else if (vkCode == VK_RMENU)
1397 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001398 if (isKeyDown)
Christopher Plewright20b795e2022-12-20 20:01:58 +00001399 s_dwMods |= RIGHT_ALT_PRESSED;
1400 else
1401 s_dwMods &= ~RIGHT_ALT_PRESSED;
1402 }
1403 ker.dwControlKeyState |= s_dwMods;
1404 ker.wVirtualKeyCode = vkCode;
Christopher Plewright566f76e2023-01-10 13:43:04 +00001405 ker.uChar.UnicodeChar = 0;
Christopher Plewright20b795e2022-12-20 20:01:58 +00001406 ir->Event.KeyEvent = ker;
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001407 vim_free(action);
Christopher Plewright20b795e2022-12-20 20:01:58 +00001408 }
1409 else
1410 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001411 if (action == NULL)
Christopher Plewright20b795e2022-12-20 20:01:58 +00001412 {
1413 semsg(_(e_missing_argument_str), "event");
1414 }
1415 else
1416 {
Christopher Plewrightc8b20492023-01-04 18:06:00 +00001417 semsg(_(e_invalid_value_for_argument_str_str), "event", action);
1418 vim_free(action);
Christopher Plewright20b795e2022-12-20 20:01:58 +00001419 }
1420 return FALSE;
1421 }
1422 return TRUE;
1423}
1424# endif // FEAT_EVAL
1425#endif // !FEAT_GUI_MSWIN || VIMDLL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426
1427
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428/*
1429 * For the GUI the mouse handling is in gui_w32.c.
1430 */
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001431#if defined(FEAT_GUI_MSWIN) && !defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 void
Bram Moolenaar1266d672017-02-01 13:43:36 +01001433mch_setmouse(int on UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434{
1435}
Christopher Plewright20b795e2022-12-20 20:01:58 +00001436#else // !FEAT_GUI_MSWIN || VIMDLL
Bram Moolenaar0f873732019-12-05 20:28:46 +01001437static int g_fMouseAvail = FALSE; // mouse present
1438static int g_fMouseActive = FALSE; // mouse enabled
1439static int g_nMouseClick = -1; // mouse status
1440static int g_xMouse; // mouse x coordinate
1441static int g_yMouse; // mouse y coordinate
Bram Moolenaar9f1983d2022-05-12 20:35:35 +01001442static DWORD g_cmodein = 0; // Original console input mode
1443static DWORD g_cmodeout = 0; // Original console output mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444
1445/*
1446 * Enable or disable mouse input
1447 */
1448 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001449mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450{
1451 DWORD cmodein;
1452
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001453# ifdef VIMDLL
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001454 if (gui.in_use)
1455 return;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001456# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 if (!g_fMouseAvail)
1458 return;
1459
1460 g_fMouseActive = on;
1461 GetConsoleMode(g_hConIn, &cmodein);
1462
1463 if (g_fMouseActive)
Wez Furlong6ef5ab52021-05-30 19:29:41 +02001464 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 cmodein |= ENABLE_MOUSE_INPUT;
Wez Furlong6ef5ab52021-05-30 19:29:41 +02001466 cmodein &= ~ENABLE_QUICK_EDIT_MODE;
1467 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 else
Wez Furlong6ef5ab52021-05-30 19:29:41 +02001469 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 cmodein &= ~ENABLE_MOUSE_INPUT;
Wez Furlong6ef5ab52021-05-30 19:29:41 +02001471 cmodein |= g_cmodein & ENABLE_QUICK_EDIT_MODE;
1472 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473
Wez Furlong6ef5ab52021-05-30 19:29:41 +02001474 SetConsoleMode(g_hConIn, cmodein | ENABLE_EXTENDED_FLAGS);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475}
1476
Bram Moolenaar157d8132018-03-06 17:09:20 +01001477
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001478# if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar157d8132018-03-06 17:09:20 +01001479/*
1480 * Called when 'balloonevalterm' changed.
1481 */
1482 void
1483mch_bevalterm_changed(void)
1484{
1485 mch_setmouse(g_fMouseActive);
1486}
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001487# endif
Bram Moolenaar157d8132018-03-06 17:09:20 +01001488
Christopher Plewright2a46f812022-10-16 19:47:45 +01001489/*
1490 * Win32 console mouse scroll event handler.
Christopher Plewright20b795e2022-12-20 20:01:58 +00001491 * Console version of the _OnMouseWheel() function in gui_w32.c
Christopher Plewright2a46f812022-10-16 19:47:45 +01001492 *
1493 * This encodes the mouse scroll direction and keyboard modifiers into
1494 * g_nMouseClick, and the mouse position into g_xMouse and g_yMouse
1495 *
1496 * The direction of the scroll is decoded from two fields of the win32 console
1497 * mouse event record;
Christopher Plewright20b795e2022-12-20 20:01:58 +00001498 * 1. The orientation - vertical or horizontal flag - from dwEventFlags
Christopher Plewright2a46f812022-10-16 19:47:45 +01001499 * 2. The sign - positive or negative (aka delta flag) - from dwButtonState
1500 *
Christopher Plewright20b795e2022-12-20 20:01:58 +00001501 * When scroll orientation is HORIZONTAL
Christopher Plewright2a46f812022-10-16 19:47:45 +01001502 * - If the high word of the dwButtonState member contains a positive
1503 * value, the wheel was rotated to the right.
1504 * - Otherwise, the wheel was rotated to the left.
Christopher Plewright20b795e2022-12-20 20:01:58 +00001505 * When scroll orientation is VERTICAL
Christopher Plewright2a46f812022-10-16 19:47:45 +01001506 * - If the high word of the dwButtonState member contains a positive value,
1507 * the wheel was rotated forward, away from the user.
1508 * - Otherwise, the wheel was rotated backward, toward the user.
1509 */
1510 static void
1511decode_mouse_wheel(MOUSE_EVENT_RECORD *pmer)
1512{
Christopher Plewright2a46f812022-10-16 19:47:45 +01001513 int horizontal = (pmer->dwEventFlags == MOUSE_HWHEELED);
1514 int zDelta = pmer->dwButtonState;
1515
1516 g_xMouse = pmer->dwMousePosition.X;
1517 g_yMouse = pmer->dwMousePosition.Y;
1518
K.Takata161b6ac2022-11-14 15:31:07 +00001519# ifdef FEAT_PROP_POPUP
Christopher Plewright605d02a2022-10-19 11:54:46 +01001520 int lcol = g_xMouse;
1521 int lrow = g_yMouse;
Christopher Plewright38804d62022-11-09 23:55:52 +00001522 win_T *wp = mouse_find_win(&lrow, &lcol, FIND_POPUP);
Christopher Plewright2a46f812022-10-16 19:47:45 +01001523 if (wp != NULL && popup_is_popup(wp))
1524 {
1525 g_nMouseClick = -1;
1526 cmdarg_T cap;
1527 oparg_T oa;
1528 CLEAR_FIELD(cap);
1529 clear_oparg(&oa);
1530 cap.oap = &oa;
1531 if (horizontal)
1532 {
1533 cap.arg = zDelta < 0 ? MSCR_LEFT : MSCR_RIGHT;
1534 cap.cmdchar = zDelta < 0 ? K_MOUSELEFT : K_MOUSERIGHT;
1535 }
1536 else
1537 {
1538 cap.cmdchar = zDelta < 0 ? K_MOUSEUP : K_MOUSEDOWN;
1539 cap.arg = zDelta < 0 ? MSCR_UP : MSCR_DOWN;
1540 }
1541
1542 // Mouse hovers over popup window, scroll it if possible.
1543 mouse_row = wp->w_winrow;
1544 mouse_col = wp->w_wincol;
1545 nv_mousescroll(&cap);
1546 update_screen(0);
1547 setcursor();
1548 out_flush();
1549 return;
1550 }
K.Takata161b6ac2022-11-14 15:31:07 +00001551# endif
Christopher Plewright2a46f812022-10-16 19:47:45 +01001552 mouse_col = g_xMouse;
1553 mouse_row = g_yMouse;
1554
1555 char_u modifiers = 0;
1556 char_u direction = 0;
1557
1558 // Decode the direction into an event that Vim can process
1559 if (horizontal)
1560 direction = zDelta >= 0 ? KE_MOUSELEFT : KE_MOUSERIGHT;
1561 else
1562 direction = zDelta >= 0 ? KE_MOUSEDOWN : KE_MOUSEUP;
1563
dundargocc57b5bc2022-11-02 13:30:51 +00001564 // Decode the win32 console key modifiers into Vim mouse modifiers.
Christopher Plewright2a46f812022-10-16 19:47:45 +01001565 if (pmer->dwControlKeyState & SHIFT_PRESSED)
Christopher Plewright605d02a2022-10-19 11:54:46 +01001566 modifiers |= MOD_MASK_SHIFT; // MOUSE_SHIFT;
Christopher Plewright2a46f812022-10-16 19:47:45 +01001567 if (pmer->dwControlKeyState & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
Christopher Plewright605d02a2022-10-19 11:54:46 +01001568 modifiers |= MOD_MASK_CTRL; // MOUSE_CTRL;
Christopher Plewright2a46f812022-10-16 19:47:45 +01001569 if (pmer->dwControlKeyState & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
1570 modifiers |= MOD_MASK_ALT; // MOUSE_ALT;
1571
1572 // add (bitwise or) the scroll direction and the key modifier chars
1573 // together.
1574 g_nMouseClick = ((direction << 8) | modifiers);
1575
1576 return;
1577}
1578
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579/*
1580 * Decode a MOUSE_EVENT. If it's a valid event, return MOUSE_LEFT,
1581 * MOUSE_MIDDLE, or MOUSE_RIGHT for a click; MOUSE_DRAG for a mouse
1582 * move with a button held down; and MOUSE_RELEASE after a MOUSE_DRAG
1583 * or a MOUSE_LEFT, _MIDDLE, or _RIGHT. We encode the button type,
1584 * the number of clicks, and the Shift/Ctrl/Alt modifiers in g_nMouseClick,
1585 * and we return the mouse position in g_xMouse and g_yMouse.
1586 *
1587 * Every MOUSE_LEFT, _MIDDLE, or _RIGHT will be followed by zero or more
1588 * MOUSE_DRAGs and one MOUSE_RELEASE. MOUSE_RELEASE will be followed only
1589 * by MOUSE_LEFT, _MIDDLE, or _RIGHT.
1590 *
1591 * For multiple clicks, we send, say, MOUSE_LEFT/1 click, MOUSE_RELEASE,
1592 * MOUSE_LEFT/2 clicks, MOUSE_RELEASE, MOUSE_LEFT/3 clicks, MOUSE_RELEASE, ....
1593 *
1594 * Windows will send us MOUSE_MOVED notifications whenever the mouse
1595 * moves, even if it stays within the same character cell. We ignore
1596 * all MOUSE_MOVED messages if the position hasn't really changed, and
1597 * we ignore all MOUSE_MOVED messages where no button is held down (i.e.,
1598 * we're only interested in MOUSE_DRAG).
1599 *
1600 * All of this is complicated by the code that fakes MOUSE_MIDDLE on
1601 * 2-button mouses by pressing the left & right buttons simultaneously.
1602 * In practice, it's almost impossible to click both at the same time,
1603 * so we need to delay a little. Also, we tend not to get MOUSE_RELEASE
1604 * in such cases, if the user is clicking quickly.
1605 */
1606 static BOOL
1607decode_mouse_event(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001608 MOUSE_EVENT_RECORD *pmer)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609{
1610 static int s_nOldButton = -1;
1611 static int s_nOldMouseClick = -1;
1612 static int s_xOldMouse = -1;
1613 static int s_yOldMouse = -1;
1614 static linenr_T s_old_topline = 0;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001615# ifdef FEAT_DIFF
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 static int s_old_topfill = 0;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001617# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 static int s_cClicks = 1;
1619 static BOOL s_fReleased = TRUE;
1620 static DWORD s_dwLastClickTime = 0;
1621 static BOOL s_fNextIsMiddle = FALSE;
1622
Bram Moolenaar0f873732019-12-05 20:28:46 +01001623 static DWORD cButtons = 0; // number of buttons supported
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624
1625 const DWORD LEFT = FROM_LEFT_1ST_BUTTON_PRESSED;
1626 const DWORD MIDDLE = FROM_LEFT_2ND_BUTTON_PRESSED;
1627 const DWORD RIGHT = RIGHTMOST_BUTTON_PRESSED;
1628 const DWORD LEFT_RIGHT = LEFT | RIGHT;
1629
1630 int nButton;
1631
1632 if (cButtons == 0 && !GetNumberOfConsoleMouseButtons(&cButtons))
1633 cButtons = 2;
1634
1635 if (!g_fMouseAvail || !g_fMouseActive)
1636 {
1637 g_nMouseClick = -1;
1638 return FALSE;
1639 }
1640
Bram Moolenaar0f873732019-12-05 20:28:46 +01001641 // get a spurious MOUSE_EVENT immediately after receiving focus; ignore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642 if (g_fJustGotFocus)
1643 {
1644 g_fJustGotFocus = FALSE;
1645 return FALSE;
1646 }
1647
Christopher Plewright605d02a2022-10-19 11:54:46 +01001648 // If there is an unprocessed mouse click drop this one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 if (g_nMouseClick != -1)
1650 return TRUE;
Christopher Plewright605d02a2022-10-19 11:54:46 +01001651
Christopher Plewright2a46f812022-10-16 19:47:45 +01001652 if (pmer->dwEventFlags == MOUSE_WHEELED
1653 || pmer->dwEventFlags == MOUSE_HWHEELED)
1654 {
1655 decode_mouse_wheel(pmer);
1656 return TRUE; // we now should have a mouse scroll in g_nMouseClick
1657 }
Christopher Plewright605d02a2022-10-19 11:54:46 +01001658
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 nButton = -1;
1660 g_xMouse = pmer->dwMousePosition.X;
1661 g_yMouse = pmer->dwMousePosition.Y;
1662
1663 if (pmer->dwEventFlags == MOUSE_MOVED)
1664 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001665 // Ignore MOUSE_MOVED events if (x, y) hasn't changed. (We get these
1666 // events even when the mouse moves only within a char cell.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 if (s_xOldMouse == g_xMouse && s_yOldMouse == g_yMouse)
1668 return FALSE;
1669 }
1670
Bram Moolenaar0f873732019-12-05 20:28:46 +01001671 // If no buttons are pressed...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 if ((pmer->dwButtonState & ((1 << cButtons) - 1)) == 0)
1673 {
Bram Moolenaar157d8132018-03-06 17:09:20 +01001674 nButton = MOUSE_RELEASE;
1675
Bram Moolenaar0f873732019-12-05 20:28:46 +01001676 // If the last thing returned was MOUSE_RELEASE, ignore this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 if (s_fReleased)
Bram Moolenaar157d8132018-03-06 17:09:20 +01001678 {
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001679# ifdef FEAT_BEVAL_TERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01001680 // do return mouse move events when we want them
Bram Moolenaar157d8132018-03-06 17:09:20 +01001681 if (p_bevalterm)
1682 nButton = MOUSE_DRAG;
1683 else
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001684# endif
Bram Moolenaar157d8132018-03-06 17:09:20 +01001685 return FALSE;
1686 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 s_fReleased = TRUE;
1689 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01001690 else // one or more buttons pressed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001692 // on a 2-button mouse, hold down left and right buttons
1693 // simultaneously to get MIDDLE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694
1695 if (cButtons == 2 && s_nOldButton != MOUSE_DRAG)
1696 {
1697 DWORD dwLR = (pmer->dwButtonState & LEFT_RIGHT);
1698
Bram Moolenaar0f873732019-12-05 20:28:46 +01001699 // if either left or right button only is pressed, see if the
1700 // next mouse event has both of them pressed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 if (dwLR == LEFT || dwLR == RIGHT)
1702 {
1703 for (;;)
1704 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001705 // wait a short time for next input event
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 if (WaitForSingleObject(g_hConIn, p_mouset / 3)
1707 != WAIT_OBJECT_0)
1708 break;
1709 else
1710 {
1711 DWORD cRecords = 0;
1712 INPUT_RECORD ir;
1713 MOUSE_EVENT_RECORD* pmer2 = &ir.Event.MouseEvent;
1714
Bram Moolenaar3a69e112014-01-10 13:51:42 +01001715 peek_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716
1717 if (cRecords == 0 || ir.EventType != MOUSE_EVENT
1718 || !(pmer2->dwButtonState & LEFT_RIGHT))
1719 break;
1720 else
1721 {
1722 if (pmer2->dwEventFlags != MOUSE_MOVED)
1723 {
Bram Moolenaar3a69e112014-01-10 13:51:42 +01001724 read_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725
1726 return decode_mouse_event(pmer2);
1727 }
1728 else if (s_xOldMouse == pmer2->dwMousePosition.X &&
1729 s_yOldMouse == pmer2->dwMousePosition.Y)
1730 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001731 // throw away spurious mouse move
Bram Moolenaar3a69e112014-01-10 13:51:42 +01001732 read_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733
Bram Moolenaar0f873732019-12-05 20:28:46 +01001734 // are there any more mouse events in queue?
Bram Moolenaar3a69e112014-01-10 13:51:42 +01001735 peek_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736
1737 if (cRecords==0 || ir.EventType != MOUSE_EVENT)
1738 break;
1739 }
1740 else
1741 break;
1742 }
1743 }
1744 }
1745 }
1746 }
1747
1748 if (s_fNextIsMiddle)
1749 {
1750 nButton = (pmer->dwEventFlags == MOUSE_MOVED)
1751 ? MOUSE_DRAG : MOUSE_MIDDLE;
1752 s_fNextIsMiddle = FALSE;
1753 }
1754 else if (cButtons == 2 &&
1755 ((pmer->dwButtonState & LEFT_RIGHT) == LEFT_RIGHT))
1756 {
1757 nButton = MOUSE_MIDDLE;
1758
1759 if (! s_fReleased && pmer->dwEventFlags != MOUSE_MOVED)
1760 {
1761 s_fNextIsMiddle = TRUE;
1762 nButton = MOUSE_RELEASE;
1763 }
1764 }
1765 else if ((pmer->dwButtonState & LEFT) == LEFT)
1766 nButton = MOUSE_LEFT;
1767 else if ((pmer->dwButtonState & MIDDLE) == MIDDLE)
1768 nButton = MOUSE_MIDDLE;
1769 else if ((pmer->dwButtonState & RIGHT) == RIGHT)
1770 nButton = MOUSE_RIGHT;
1771
1772 if (! s_fReleased && ! s_fNextIsMiddle
1773 && nButton != s_nOldButton && s_nOldButton != MOUSE_DRAG)
1774 return FALSE;
1775
1776 s_fReleased = s_fNextIsMiddle;
1777 }
1778
1779 if (pmer->dwEventFlags == 0 || pmer->dwEventFlags == DOUBLE_CLICK)
1780 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001781 // button pressed or released, without mouse moving
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 if (nButton != -1 && nButton != MOUSE_RELEASE)
1783 {
1784 DWORD dwCurrentTime = GetTickCount();
1785
1786 if (s_xOldMouse != g_xMouse
1787 || s_yOldMouse != g_yMouse
1788 || s_nOldButton != nButton
1789 || s_old_topline != curwin->w_topline
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001790# ifdef FEAT_DIFF
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 || s_old_topfill != curwin->w_topfill
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001792# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 || (int)(dwCurrentTime - s_dwLastClickTime) > p_mouset)
1794 {
1795 s_cClicks = 1;
1796 }
1797 else if (++s_cClicks > 4)
1798 {
1799 s_cClicks = 1;
1800 }
1801
1802 s_dwLastClickTime = dwCurrentTime;
1803 }
1804 }
1805 else if (pmer->dwEventFlags == MOUSE_MOVED)
1806 {
1807 if (nButton != -1 && nButton != MOUSE_RELEASE)
1808 nButton = MOUSE_DRAG;
1809
1810 s_cClicks = 1;
1811 }
1812
1813 if (nButton == -1)
1814 return FALSE;
1815
1816 if (nButton != MOUSE_RELEASE)
1817 s_nOldButton = nButton;
1818
1819 g_nMouseClick = nButton;
1820
1821 if (pmer->dwControlKeyState & SHIFT_PRESSED)
1822 g_nMouseClick |= MOUSE_SHIFT;
1823 if (pmer->dwControlKeyState & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
1824 g_nMouseClick |= MOUSE_CTRL;
1825 if (pmer->dwControlKeyState & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
1826 g_nMouseClick |= MOUSE_ALT;
1827
1828 if (nButton != MOUSE_DRAG && nButton != MOUSE_RELEASE)
1829 SET_NUM_MOUSE_CLICKS(g_nMouseClick, s_cClicks);
1830
Bram Moolenaar0f873732019-12-05 20:28:46 +01001831 // only pass on interesting (i.e., different) mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 if (s_xOldMouse == g_xMouse
1833 && s_yOldMouse == g_yMouse
1834 && s_nOldMouseClick == g_nMouseClick)
1835 {
1836 g_nMouseClick = -1;
1837 return FALSE;
1838 }
1839
1840 s_xOldMouse = g_xMouse;
1841 s_yOldMouse = g_yMouse;
1842 s_old_topline = curwin->w_topline;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001843# ifdef FEAT_DIFF
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 s_old_topfill = curwin->w_topfill;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001845# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 s_nOldMouseClick = g_nMouseClick;
1847
1848 return TRUE;
1849}
1850
Christopher Plewright20b795e2022-12-20 20:01:58 +00001851# ifdef FEAT_EVAL
1852 static int
1853encode_mouse_event(dict_T *args, INPUT_RECORD *ir)
1854{
1855 int button;
1856 int row;
1857 int col;
1858 int repeated_click;
Bram Moolenaar9b8a3652022-12-20 20:47:28 +00001859 int_u mods = 0;
Christopher Plewright20b795e2022-12-20 20:01:58 +00001860 int move;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861
Christopher Plewright20b795e2022-12-20 20:01:58 +00001862 if (!dict_has_key(args, "row") || !dict_has_key(args, "col"))
1863 return FALSE;
1864
1865 // Note: "move" is optional, requires fewer arguments
1866 move = (int)dict_get_bool(args, "move", FALSE);
1867 if (!move && (!dict_has_key(args, "button")
1868 || !dict_has_key(args, "multiclick")
1869 || !dict_has_key(args, "modifiers")))
1870 return FALSE;
1871
1872 row = (int)dict_get_number(args, "row") - 1;
1873 col = (int)dict_get_number(args, "col") - 1;
1874
1875 ir->EventType = MOUSE_EVENT;
1876 MOUSE_EVENT_RECORD mer;
1877 ZeroMemory(&mer, sizeof(mer));
1878 mer.dwMousePosition.X = col;
1879 mer.dwMousePosition.Y = row;
1880
1881 if (move)
1882 {
1883 mer.dwButtonState = 0;
1884 mer.dwEventFlags = MOUSE_MOVED;
1885 }
1886 else
1887 {
1888 button = (int)dict_get_number(args, "button");
1889 repeated_click = (int)dict_get_number(args, "multiclick");
1890 mods = (int)dict_get_number(args, "modifiers");
1891 // Reset the scroll values to known values.
1892 // XXX: Remove this when/if the scroll step is made configurable.
1893 mouse_set_hor_scroll_step(6);
1894 mouse_set_vert_scroll_step(3);
1895
1896 switch (button)
1897 {
1898 case MOUSE_LEFT:
1899 mer.dwButtonState = FROM_LEFT_1ST_BUTTON_PRESSED;
1900 mer.dwEventFlags = repeated_click == 1 ? DOUBLE_CLICK : 0;
1901 break;
1902 case MOUSE_MIDDLE:
1903 mer.dwButtonState = FROM_LEFT_2ND_BUTTON_PRESSED;
1904 mer.dwEventFlags = repeated_click == 1 ? DOUBLE_CLICK : 0;
1905 break;
1906 case MOUSE_RIGHT:
1907 mer.dwButtonState = RIGHTMOST_BUTTON_PRESSED;
1908 mer.dwEventFlags = repeated_click == 1 ? DOUBLE_CLICK : 0;
1909 break;
1910 case MOUSE_RELEASE:
1911 // umm? Assume Left Release?
1912 mer.dwEventFlags = 0;
1913
1914 case MOUSE_MOVE:
1915 mer.dwButtonState = 0;
1916 mer.dwEventFlags = MOUSE_MOVED;
1917 break;
1918 case MOUSE_X1:
1919 mer.dwButtonState = FROM_LEFT_3RD_BUTTON_PRESSED;
1920 break;
1921 case MOUSE_X2:
1922 mer.dwButtonState = FROM_LEFT_4TH_BUTTON_PRESSED;
1923 break;
1924 case MOUSE_4: // KE_MOUSEDOWN;
1925 mer.dwButtonState = -1;
1926 mer.dwEventFlags = MOUSE_WHEELED;
1927 break;
1928 case MOUSE_5: // KE_MOUSEUP;
1929 mer.dwButtonState = +1;
1930 mer.dwEventFlags = MOUSE_WHEELED;
1931 break;
1932 case MOUSE_6: // KE_MOUSELEFT;
1933 mer.dwButtonState = -1;
1934 mer.dwEventFlags = MOUSE_HWHEELED;
1935 break;
1936 case MOUSE_7: // KE_MOUSERIGHT;
1937 mer.dwButtonState = +1;
1938 mer.dwEventFlags = MOUSE_HWHEELED;
1939 break;
1940 default:
1941 semsg(_(e_invalid_argument_str), "button");
1942 return FALSE;
1943 }
1944 }
1945
1946 mer.dwControlKeyState = 0;
1947 if (mods != 0)
1948 {
1949 // Encode the win32 console key modifiers from Vim MOUSE modifiers.
1950 if (mods & MOUSE_SHIFT)
1951 mer.dwControlKeyState |= SHIFT_PRESSED;
1952 if (mods & MOUSE_CTRL)
1953 mer.dwControlKeyState |= LEFT_CTRL_PRESSED;
1954 if (mods & MOUSE_ALT)
1955 mer.dwControlKeyState |= LEFT_ALT_PRESSED;
1956 }
1957 ir->Event.MouseEvent = mer;
1958 return TRUE;
1959}
1960# endif // FEAT_EVAL
1961
1962 static int
1963write_input_record_buffer(INPUT_RECORD* irEvents, int nLength)
1964{
1965 int nCount = 0;
1966 while (nCount < nLength)
1967 {
1968 input_record_buffer.length++;
1969 input_record_buffer_node_T *event_node =
1970 malloc(sizeof(input_record_buffer_node_T));
1971 event_node->ir = irEvents[nCount++];
1972 event_node->next = NULL;
1973 if (input_record_buffer.tail == NULL)
1974 {
1975 input_record_buffer.head = event_node;
1976 input_record_buffer.tail = event_node;
1977 }
1978 else
1979 {
1980 input_record_buffer.tail->next = event_node;
1981 input_record_buffer.tail = input_record_buffer.tail->next;
1982 }
1983 }
1984 return nCount;
1985}
1986
1987 static int
1988read_input_record_buffer(INPUT_RECORD* irEvents, int nMaxLength)
1989{
1990 int nCount = 0;
1991 while (nCount < nMaxLength && input_record_buffer.head != NULL)
1992 {
1993 input_record_buffer.length--;
1994 input_record_buffer_node_T *pop_head = input_record_buffer.head;
1995 irEvents[nCount++] = pop_head->ir;
1996 input_record_buffer.head = pop_head->next;
1997 vim_free(pop_head);
1998 if (input_record_buffer.length == 0)
1999 input_record_buffer.tail = NULL;
2000 }
2001 return nCount;
2002}
Christopher Plewright20b795e2022-12-20 20:01:58 +00002003#endif // !FEAT_GUI_MSWIN || VIMDLL
2004
2005#ifdef FEAT_EVAL
2006/*
2007 * The 'test_mswin_event' function is for testing Vim's low-level handling of
2008 * user input events. ie, this manages the encoding of INPUT_RECORD events
2009 * so that we have a way to test how Vim decodes INPUT_RECORD events in Windows
2010 * consoles.
2011 *
2012 * The 'test_mswin_event' function is based on 'test_gui_event'. In fact, when
2013 * the Windows GUI is running, the arguments; 'event' and 'args', are the same.
2014 * So, it acts as an alias for 'test_gui_event' for the Windows GUI.
2015 *
2016 * When the Windows console is running, the arguments; 'event' and 'args', are
2017 * a subset of what 'test_gui_event' handles, ie, only "key" and "mouse"
2018 * events are encoded as INPUT_RECORD events.
2019 *
2020 * Note: INPUT_RECORDs are only used by the Windows console, not the GUI. The
2021 * GUI sends MSG structs instead.
2022 */
2023 int
2024test_mswin_event(char_u *event, dict_T *args)
2025{
2026 int lpEventsWritten = 0;
2027
2028# if defined(VIMDLL) || defined(FEAT_GUI_MSWIN)
2029 if (gui.in_use)
2030 return test_gui_w32_sendevent(event, args);
2031# endif
2032
2033# if defined(VIMDLL) || !defined(FEAT_GUI_MSWIN)
2034
2035// Currently implemented event record types are; KEY_EVENT and MOUSE_EVENT
2036// Potentially could also implement: FOCUS_EVENT and WINDOW_BUFFER_SIZE_EVENT
2037// Maybe also: MENU_EVENT
2038
2039 INPUT_RECORD ir;
2040 BOOL input_encoded = FALSE;
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002041 BOOL execute = FALSE;
Christopher Plewright20b795e2022-12-20 20:01:58 +00002042 if (STRCMP(event, "key") == 0)
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002043 {
2044 execute = dict_get_bool(args, "execute", FALSE);
2045 if (dict_has_key(args, "event"))
2046 input_encoded = encode_key_event(args, &ir);
2047 else if (!execute)
2048 {
2049 semsg(_(e_missing_argument_str), "event");
2050 return FALSE;
2051 }
2052 }
Christopher Plewright20b795e2022-12-20 20:01:58 +00002053 else if (STRCMP(event, "mouse") == 0)
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002054 {
2055 execute = TRUE;
Christopher Plewright20b795e2022-12-20 20:01:58 +00002056 input_encoded = encode_mouse_event(args, &ir);
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002057 }
Christopher Plewright20b795e2022-12-20 20:01:58 +00002058 else
2059 {
2060 semsg(_(e_invalid_value_for_argument_str_str), "event", event);
2061 return FALSE;
2062 }
2063
2064 // Ideally, WriteConsoleInput would be used to inject these low-level
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002065 // events. But, this doesn't work well in the CI test environment. So
Christopher Plewright20b795e2022-12-20 20:01:58 +00002066 // implementing an input_record_buffer instead.
2067 if (input_encoded)
2068 lpEventsWritten = write_input_record_buffer(&ir, 1);
2069
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002070 // Set flags to execute the event, ie. like feedkeys mode X.
2071 if (execute)
2072 {
2073 int save_msg_scroll = msg_scroll;
2074 // Avoid a 1 second delay when the keys start Insert mode.
2075 msg_scroll = FALSE;
2076 ch_log(NULL, "test_mswin_event() executing");
Christopher Plewright20b795e2022-12-20 20:01:58 +00002077 exec_normal(TRUE, TRUE, TRUE);
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002078 msg_scroll |= save_msg_scroll;
2079 }
Christopher Plewright20b795e2022-12-20 20:01:58 +00002080
2081# endif
2082 return lpEventsWritten;
2083}
2084#endif // FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085
2086#ifdef MCH_CURSOR_SHAPE
2087/*
2088 * Set the shape of the cursor.
2089 * 'thickness' can be from 1 (thin) to 99 (block)
2090 */
2091 static void
2092mch_set_cursor_shape(int thickness)
2093{
Christopher Plewright38804d62022-11-09 23:55:52 +00002094 if (vtp_working)
K.Takatadf5320c2022-09-01 13:20:16 +01002095 {
2096 if (*T_CSI == NUL)
2097 {
2098 // If 't_SI' is not set, use the default cursor styles.
2099 if (thickness < 50)
2100 vtp_printf("\033[3 q"); // underline
2101 else
2102 vtp_printf("\033[0 q"); // default
2103 }
2104 }
2105 else
2106 {
2107 CONSOLE_CURSOR_INFO ConsoleCursorInfo;
2108 ConsoleCursorInfo.dwSize = thickness;
2109 ConsoleCursorInfo.bVisible = s_cursor_visible;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
K.Takatadf5320c2022-09-01 13:20:16 +01002111 SetConsoleCursorInfo(g_hConOut, &ConsoleCursorInfo);
2112 if (s_cursor_visible)
2113 SetConsoleCursorPosition(g_hConOut, g_coord);
2114 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115}
2116
2117 void
2118mch_update_cursor(void)
2119{
2120 int idx;
2121 int thickness;
2122
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002123# ifdef VIMDLL
2124 if (gui.in_use)
2125 return;
2126# endif
2127
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 /*
2129 * How the cursor is drawn depends on the current mode.
2130 */
2131 idx = get_shape_idx(FALSE);
2132
2133 if (shape_table[idx].shape == SHAPE_BLOCK)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002134 thickness = 99; // 100 doesn't work on W95
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 else
2136 thickness = shape_table[idx].percentage;
2137 mch_set_cursor_shape(thickness);
2138}
2139#endif
2140
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002141#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142/*
2143 * Handle FOCUS_EVENT.
2144 */
2145 static void
2146handle_focus_event(INPUT_RECORD ir)
2147{
2148 g_fJustGotFocus = ir.Event.FocusEvent.bSetFocus;
2149 ui_focus_change((int)g_fJustGotFocus);
2150}
2151
Bram Moolenaar78d21da2019-02-17 15:00:52 +01002152static void ResizeConBuf(HANDLE hConsole, COORD coordScreen);
2153
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154/*
2155 * Wait until console input from keyboard or mouse is available,
2156 * or the time is up.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002157 * When "ignore_input" is TRUE even wait when input is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 * Return TRUE if something is available FALSE if not.
2159 */
2160 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002161WaitForChar(long msec, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162{
2163 DWORD dwNow = 0, dwEndTime = 0;
2164 INPUT_RECORD ir;
2165 DWORD cRecords;
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002166 WCHAR ch, ch2;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002167# ifdef FEAT_TIMERS
Bram Moolenaar40b1b542016-04-20 20:18:23 +02002168 int tb_change_cnt = typebuf.tb_change_cnt;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002169# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170
2171 if (msec > 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002172 // Wait until the specified time has elapsed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 dwEndTime = GetTickCount() + msec;
2174 else if (msec < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002175 // Wait forever.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 dwEndTime = INFINITE;
2177
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01002178 // We need to loop until the end of the time period, because
2179 // we might get multiple unusable mouse events in that time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 for (;;)
2181 {
Bram Moolenaared5a9d62018-09-06 13:14:43 +02002182 // Only process messages when waiting.
2183 if (msec != 0)
2184 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002185# ifdef MESSAGE_QUEUE
Bram Moolenaared5a9d62018-09-06 13:14:43 +02002186 parse_queued_messages();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002187# endif
2188# ifdef FEAT_MZSCHEME
Bram Moolenaared5a9d62018-09-06 13:14:43 +02002189 mzvim_check_threads();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002190# endif
2191# ifdef FEAT_CLIENTSERVER
Bram Moolenaared5a9d62018-09-06 13:14:43 +02002192 serverProcessPendingMessages();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002193# endif
Bram Moolenaared5a9d62018-09-06 13:14:43 +02002194 }
Bram Moolenaarf12d9832016-01-29 21:11:25 +01002195
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002196 if (g_nMouseClick != -1
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002197# ifdef FEAT_CLIENTSERVER
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002198 || (!ignore_input && input_available())
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002199# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 )
2201 return TRUE;
2202
2203 if (msec > 0)
2204 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002205 // If the specified wait time has passed, return. Beware that
2206 // GetTickCount() may wrap around (overflow).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 dwNow = GetTickCount();
Bram Moolenaarb7512b72013-08-10 12:45:09 +02002208 if ((int)(dwNow - dwEndTime) >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 break;
2210 }
2211 if (msec != 0)
2212 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002213 DWORD dwWaitTime = dwEndTime - dwNow;
2214
Bram Moolenaarc478ee32020-12-01 21:27:51 +01002215 // Don't wait for more than 11 msec to avoid dropping characters,
2216 // check channel while waiting for input and handle a callback from
2217 // 'balloonexpr'.
2218 if (dwWaitTime > 11)
2219 dwWaitTime = 11;
2220
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002221# ifdef FEAT_MZSCHEME
Bram Moolenaarc478ee32020-12-01 21:27:51 +01002222 if (mzthreads_allowed() && p_mzq > 0 && (long)dwWaitTime > p_mzq)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002223 dwWaitTime = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002224# endif
2225# ifdef FEAT_TIMERS
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002226 // When waiting very briefly don't trigger timers.
2227 if (dwWaitTime > 10)
Bram Moolenaar0e0b3dd2016-03-17 17:58:56 +01002228 {
2229 long due_time;
2230
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002231 // Trigger timers and then get the time in msec until the next
2232 // one is due. Wait up to that time.
2233 due_time = check_due_timer();
2234 if (typebuf.tb_change_cnt != tb_change_cnt)
Bram Moolenaar0e0b3dd2016-03-17 17:58:56 +01002235 {
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002236 // timer may have used feedkeys().
2237 return FALSE;
Bram Moolenaar0e0b3dd2016-03-17 17:58:56 +01002238 }
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002239 if (due_time > 0 && dwWaitTime > (DWORD)due_time)
2240 dwWaitTime = due_time;
Bram Moolenaar0e0b3dd2016-03-17 17:58:56 +01002241 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002242# endif
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002243 if (
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002244# ifdef FEAT_CLIENTSERVER
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002245 // Wait for either an event on the console input or a
2246 // message in the client-server window.
2247 msg_wait_for_multiple_objects(1, &g_hConIn, FALSE,
2248 dwWaitTime, QS_SENDMESSAGE) != WAIT_OBJECT_0
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002249# else
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002250 wait_for_single_object(g_hConIn, dwWaitTime)
2251 != WAIT_OBJECT_0
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002252# endif
Bram Moolenaar1f20daa2019-01-19 21:12:24 +01002253 )
2254 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 }
2256
2257 cRecords = 0;
Bram Moolenaar3a69e112014-01-10 13:51:42 +01002258 peek_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002260# ifdef FEAT_MBYTE_IME
matveyt4eb19142021-05-20 11:54:10 +02002261 // May have to redraw if the cursor ends up in the wrong place.
2262 // Only when not peeking.
Bram Moolenaar24959102022-05-07 20:01:16 +01002263 if (State == MODE_CMDLINE && msg_row == Rows - 1 && msec != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 {
2265 CONSOLE_SCREEN_BUFFER_INFO csbi;
2266
2267 if (GetConsoleScreenBufferInfo(g_hConOut, &csbi))
2268 {
2269 if (csbi.dwCursorPosition.Y != msg_row)
2270 {
matveyte08795e2021-05-07 15:00:17 +02002271 // The screen is now messed up, must redraw the command
2272 // line and later all the windows.
Bram Moolenaara4d158b2022-08-14 14:17:45 +01002273 redraw_all_later(UPD_CLEAR);
matveyte08795e2021-05-07 15:00:17 +02002274 compute_cmdrow();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 redrawcmd();
2276 }
2277 }
2278 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002279# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280
2281 if (cRecords > 0)
2282 {
2283 if (ir.EventType == KEY_EVENT && ir.Event.KeyEvent.bKeyDown)
2284 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002285# ifdef FEAT_MBYTE_IME
Bram Moolenaar0f873732019-12-05 20:28:46 +01002286 // Windows IME sends two '\n's with only one 'ENTER'. First:
2287 // wVirtualKeyCode == 13. second: wVirtualKeyCode == 0
K.Takata972db232022-02-04 10:45:38 +00002288 if (ir.Event.KeyEvent.uChar.UnicodeChar == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 && ir.Event.KeyEvent.wVirtualKeyCode == 13)
2290 {
Bram Moolenaar3a69e112014-01-10 13:51:42 +01002291 read_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 continue;
2293 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002294# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 if (decode_key_event(&ir.Event.KeyEvent, &ch, &ch2,
2296 NULL, FALSE))
2297 return TRUE;
2298 }
2299
Bram Moolenaar3a69e112014-01-10 13:51:42 +01002300 read_console_input(g_hConIn, &ir, 1, &cRecords);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301
2302 if (ir.EventType == FOCUS_EVENT)
2303 handle_focus_event(ir);
2304 else if (ir.EventType == WINDOW_BUFFER_SIZE_EVENT)
Bram Moolenaarc33ecb22018-02-11 16:40:45 +01002305 {
Bram Moolenaar78d21da2019-02-17 15:00:52 +01002306 COORD dwSize = ir.Event.WindowBufferSizeEvent.dwSize;
2307
Bram Moolenaar36698e32019-12-11 22:57:40 +01002308 // Only call shell_resized() when the size actually changed to
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002309 // avoid the screen is cleared.
Bram Moolenaar78d21da2019-02-17 15:00:52 +01002310 if (dwSize.X != Columns || dwSize.Y != Rows)
2311 {
2312 CONSOLE_SCREEN_BUFFER_INFO csbi;
2313 GetConsoleScreenBufferInfo(g_hConOut, &csbi);
Bram Moolenaar36698e32019-12-11 22:57:40 +01002314 dwSize.X = csbi.srWindow.Right - csbi.srWindow.Left + 1;
Bram Moolenaar78d21da2019-02-17 15:00:52 +01002315 dwSize.Y = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
Bram Moolenaar36698e32019-12-11 22:57:40 +01002316 if (dwSize.X != Columns || dwSize.Y != Rows)
2317 {
2318 ResizeConBuf(g_hConOut, dwSize);
2319 shell_resized();
2320 }
Bram Moolenaar78d21da2019-02-17 15:00:52 +01002321 }
Bram Moolenaarc33ecb22018-02-11 16:40:45 +01002322 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 else if (ir.EventType == MOUSE_EVENT
2324 && decode_mouse_event(&ir.Event.MouseEvent))
2325 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 }
2327 else if (msec == 0)
2328 break;
2329 }
2330
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002331# ifdef FEAT_CLIENTSERVER
Bram Moolenaar0f873732019-12-05 20:28:46 +01002332 // Something might have been received while we were waiting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 if (input_available())
2334 return TRUE;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002335# endif
Bram Moolenaarf12d9832016-01-29 21:11:25 +01002336
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 return FALSE;
2338}
2339
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340/*
2341 * return non-zero if a character is available
2342 */
2343 int
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002344mch_char_avail(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345{
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002346# ifdef VIMDLL
2347 if (gui.in_use)
2348 return TRUE;
2349# endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002350 return WaitForChar(0L, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351}
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002352
2353# if defined(FEAT_TERMINAL) || defined(PROTO)
2354/*
2355 * Check for any pending input or messages.
2356 */
2357 int
2358mch_check_messages(void)
2359{
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002360# ifdef VIMDLL
2361 if (gui.in_use)
2362 return TRUE;
2363# endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002364 return WaitForChar(0L, TRUE);
2365}
2366# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367
2368/*
2369 * Create the console input. Used when reading stdin doesn't work.
2370 */
2371 static void
2372create_conin(void)
2373{
2374 g_hConIn = CreateFile("CONIN$", GENERIC_READ|GENERIC_WRITE,
2375 FILE_SHARE_READ|FILE_SHARE_WRITE,
2376 (LPSECURITY_ATTRIBUTES) NULL,
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002377 OPEN_EXISTING, 0, (HANDLE)NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 did_create_conin = TRUE;
2379}
2380
2381/*
Bram Moolenaar0e0b3dd2016-03-17 17:58:56 +01002382 * Get a keystroke or a mouse event, use a blocking wait.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 */
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002384 static WCHAR
2385tgetch(int *pmodifiers, WCHAR *pch2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386{
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002387 WCHAR ch;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388
2389 for (;;)
2390 {
2391 INPUT_RECORD ir;
2392 DWORD cRecords = 0;
2393
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002394# ifdef FEAT_CLIENTSERVER
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002395 (void)WaitForChar(-1L, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 if (input_available())
2397 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 if (g_nMouseClick != -1)
2399 return 0;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002400# endif
Bram Moolenaar3a69e112014-01-10 13:51:42 +01002401 if (read_console_input(g_hConIn, &ir, 1, &cRecords) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 {
2403 if (did_create_conin)
2404 read_error_exit();
2405 create_conin();
2406 continue;
2407 }
2408
2409 if (ir.EventType == KEY_EVENT)
2410 {
2411 if (decode_key_event(&ir.Event.KeyEvent, &ch, pch2,
2412 pmodifiers, TRUE))
2413 return ch;
2414 }
2415 else if (ir.EventType == FOCUS_EVENT)
2416 handle_focus_event(ir);
2417 else if (ir.EventType == WINDOW_BUFFER_SIZE_EVENT)
2418 shell_resized();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 else if (ir.EventType == MOUSE_EVENT)
2420 {
2421 if (decode_mouse_event(&ir.Event.MouseEvent))
2422 return 0;
2423 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 }
2425}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002426#endif // !FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427
2428
2429/*
Bram Moolenaarf6a2b082012-06-29 13:14:03 +02002430 * mch_inchar(): low-level input function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 * Get one or more characters from the keyboard or the mouse.
2432 * If time == 0, do not wait for characters.
2433 * If time == n, wait a short time for characters.
2434 * If time == -1, wait forever for characters.
2435 * Returns the number of characters read into buf.
2436 */
2437 int
2438mch_inchar(
Bram Moolenaar1266d672017-02-01 13:43:36 +01002439 char_u *buf UNUSED,
2440 int maxlen UNUSED,
2441 long time UNUSED,
2442 int tb_change_cnt UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443{
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002444#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445
2446 int len;
2447 int c;
Bram Moolenaar8f027fe2020-03-04 23:21:35 +01002448# ifdef VIMDLL
2449// Extra space for maximum three CSIs. E.g. U+1B6DB -> 0xF0 0x9B 0x9B 0x9B.
2450# define TYPEAHEADSPACE 6
2451# else
2452# define TYPEAHEADSPACE 0
2453# endif
2454# define TYPEAHEADLEN (20 + TYPEAHEADSPACE)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002455 static char_u typeahead[TYPEAHEADLEN]; // previously typed bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 static int typeaheadlen = 0;
2457
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002458# ifdef VIMDLL
2459 if (gui.in_use)
2460 return 0;
2461# endif
2462
Bram Moolenaar0f873732019-12-05 20:28:46 +01002463 // First use any typeahead that was kept because "buf" was too small.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 if (typeaheadlen > 0)
2465 goto theend;
2466
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 if (time >= 0)
2468 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002469 if (!WaitForChar(time, FALSE)) // no character available
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01002472 else // time == -1, wait forever
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002474 mch_set_winsize_now(); // Allow winsize changes from now on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475
Bram Moolenaar3918c952005-03-15 22:34:55 +00002476 /*
2477 * If there is no character available within 2 seconds (default)
2478 * write the autoscript file to disk. Or cause the CursorHold event
2479 * to be triggered.
2480 */
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002481 if (!WaitForChar(p_ut, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 {
Bram Moolenaard35f9712005-12-18 22:02:33 +00002483 if (trigger_cursorhold() && maxlen >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 {
Bram Moolenaar3918c952005-03-15 22:34:55 +00002485 buf[0] = K_SPECIAL;
2486 buf[1] = KS_EXTRA;
2487 buf[2] = (int)KE_CURSORHOLD;
2488 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 }
Bram Moolenaar702517d2005-06-27 22:34:07 +00002490 before_blocking();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 }
2492 }
2493
2494 /*
2495 * Try to read as many characters as there are, until the buffer is full.
2496 */
2497
Bram Moolenaar0f873732019-12-05 20:28:46 +01002498 // we will get at least one key. Get more if they are available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 g_fCBrkPressed = FALSE;
2500
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002501# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 if (fdDump)
2503 fputc('[', fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002504# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505
Bram Moolenaar0f873732019-12-05 20:28:46 +01002506 // Keep looping until there is something in the typeahead buffer and more
2507 // to get and still room in the buffer (up to two bytes for a char and
2508 // three bytes for a modifier).
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02002509 while ((typeaheadlen == 0 || WaitForChar(0L, FALSE))
Bram Moolenaar9f1983d2022-05-12 20:35:35 +01002510 && typeaheadlen + 5 + TYPEAHEADSPACE <= TYPEAHEADLEN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 {
2512 if (typebuf_changed(tb_change_cnt))
2513 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002514 // "buf" may be invalid now if a client put something in the
2515 // typeahead buffer and "buf" is in the typeahead buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 typeaheadlen = 0;
2517 break;
2518 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 if (g_nMouseClick != -1)
2520 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002521# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 if (fdDump)
2523 fprintf(fdDump, "{%02x @ %d, %d}",
2524 g_nMouseClick, g_xMouse, g_yMouse);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002525# endif
Christopher Plewright2a46f812022-10-16 19:47:45 +01002526 char_u modifiers = ((char_u *)(&g_nMouseClick))[0];
2527 char_u scroll_dir = ((char_u *)(&g_nMouseClick))[1];
2528
2529 if (scroll_dir == KE_MOUSEDOWN
2530 || scroll_dir == KE_MOUSEUP
2531 || scroll_dir == KE_MOUSELEFT
2532 || scroll_dir == KE_MOUSERIGHT)
2533 {
2534 if (modifiers > 0)
2535 {
Christopher Plewright03193062022-11-22 12:58:27 +00002536 // use K_SPECIAL instead of CSI to make mappings work
2537 typeahead[typeaheadlen++] = K_SPECIAL;
Christopher Plewright2a46f812022-10-16 19:47:45 +01002538 typeahead[typeaheadlen++] = KS_MODIFIER;
2539 typeahead[typeaheadlen++] = modifiers;
2540 }
2541 typeahead[typeaheadlen++] = CSI;
2542 typeahead[typeaheadlen++] = KS_EXTRA;
2543 typeahead[typeaheadlen++] = scroll_dir;
Christopher Plewright2a46f812022-10-16 19:47:45 +01002544 }
2545 else
2546 {
2547 typeahead[typeaheadlen++] = ESC + 128;
2548 typeahead[typeaheadlen++] = 'M';
2549 typeahead[typeaheadlen++] = g_nMouseClick;
Christopher Plewright2a46f812022-10-16 19:47:45 +01002550 }
Christopher Plewright36446bb2022-11-23 22:28:08 +00002551
2552 // Pass the pointer coordinates of the mouse event in 2 bytes,
2553 // allowing for > 223 columns. Both for click and scroll events.
2554 // This is the same as what is used for the GUI.
2555 typeahead[typeaheadlen++] = (char_u)(g_xMouse / 128 + ' ' + 1);
2556 typeahead[typeaheadlen++] = (char_u)(g_xMouse % 128 + ' ' + 1);
2557 typeahead[typeaheadlen++] = (char_u)(g_yMouse / 128 + ' ' + 1);
2558 typeahead[typeaheadlen++] = (char_u)(g_yMouse % 128 + ' ' + 1);
2559
2560 g_nMouseClick = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 }
2562 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 {
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002564 WCHAR ch2 = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 int modifiers = 0;
2566
2567 c = tgetch(&modifiers, &ch2);
2568
Christopher Plewrightc8b20492023-01-04 18:06:00 +00002569 c = simplify_key(c, &modifiers);
2570
Christopher Plewright7b0afc12022-12-30 16:54:58 +00002571 // Some chars need adjustment when the Ctrl modifier is used.
2572 ++no_reduce_keys;
2573 c = may_adjust_key_for_ctrl(modifiers, c);
2574 --no_reduce_keys;
2575
2576 // remove the SHIFT modifier for keys where it's already included,
2577 // e.g., '(' and '*'
2578 modifiers = may_remove_shift_modifier(modifiers, c);
2579
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 if (typebuf_changed(tb_change_cnt))
2581 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002582 // "buf" may be invalid now if a client put something in the
2583 // typeahead buffer and "buf" is in the typeahead buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 typeaheadlen = 0;
2585 break;
2586 }
2587
2588 if (c == Ctrl_C && ctrl_c_interrupts)
2589 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002590# if defined(FEAT_CLIENTSERVER)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 trash_input_buf();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002592# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 got_int = TRUE;
2594 }
2595
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 if (g_nMouseClick == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 {
2598 int n = 1;
2599
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002600 if (ch2 == NUL)
2601 {
Bram Moolenaar8f027fe2020-03-04 23:21:35 +01002602 int i, j;
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002603 char_u *p;
2604 WCHAR ch[2];
2605
2606 ch[0] = c;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002607 if (c >= 0xD800 && c <= 0xDBFF) // High surrogate
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002608 {
2609 ch[1] = tgetch(&modifiers, &ch2);
2610 n++;
2611 }
2612 p = utf16_to_enc(ch, &n);
2613 if (p != NULL)
2614 {
Bram Moolenaar8f027fe2020-03-04 23:21:35 +01002615 for (i = 0, j = 0; i < n; i++)
2616 {
2617 typeahead[typeaheadlen + j++] = p[i];
2618# ifdef VIMDLL
2619 if (p[i] == CSI)
2620 {
2621 typeahead[typeaheadlen + j++] = KS_EXTRA;
2622 typeahead[typeaheadlen + j++] = KE_CSI;
2623 }
2624# endif
2625 }
2626 n = j;
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002627 vim_free(p);
2628 }
2629 }
2630 else
Bram Moolenaar8f027fe2020-03-04 23:21:35 +01002631 {
Bram Moolenaarac360bf2015-09-01 20:31:20 +02002632 typeahead[typeaheadlen] = c;
Bram Moolenaar8f027fe2020-03-04 23:21:35 +01002633# ifdef VIMDLL
2634 if (c == CSI)
2635 {
2636 typeahead[typeaheadlen + 1] = KS_EXTRA;
2637 typeahead[typeaheadlen + 2] = KE_CSI;
2638 n = 3;
2639 }
2640# endif
2641 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 if (ch2 != NUL)
2643 {
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02002644 if (c == K_NUL)
Bram Moolenaarfeeb4d02017-12-05 15:14:46 +01002645 {
Bram Moolenaar0cc7b2d2018-10-07 15:49:56 +02002646 switch (ch2)
2647 {
2648 case (WCHAR)'\324': // SHIFT+Insert
2649 case (WCHAR)'\325': // CTRL+Insert
2650 case (WCHAR)'\327': // SHIFT+Delete
2651 case (WCHAR)'\330': // CTRL+Delete
2652 typeahead[typeaheadlen + n] = (char_u)ch2;
2653 n++;
2654 break;
2655
2656 default:
2657 typeahead[typeaheadlen + n] = 3;
2658 typeahead[typeaheadlen + n + 1] = (char_u)ch2;
2659 n += 2;
2660 break;
2661 }
Bram Moolenaarfeeb4d02017-12-05 15:14:46 +01002662 }
2663 else
2664 {
2665 typeahead[typeaheadlen + n] = 3;
2666 typeahead[typeaheadlen + n + 1] = (char_u)ch2;
2667 n += 2;
2668 }
Bram Moolenaar45500912014-07-09 20:51:07 +02002669 }
2670
Bram Moolenaar0f873732019-12-05 20:28:46 +01002671 // Use the ALT key to set the 8th bit of the character
2672 // when it's one byte, the 8th bit isn't set yet and not
2673 // using a double-byte encoding (would become a lead
2674 // byte).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 if ((modifiers & MOD_MASK_ALT)
2676 && n == 1
2677 && (typeahead[typeaheadlen] & 0x80) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 && !enc_dbcs
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 )
2680 {
Bram Moolenaar85a3e5c2007-11-20 16:22:16 +00002681 n = (*mb_char2bytes)(typeahead[typeaheadlen] | 0x80,
2682 typeahead + typeaheadlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 modifiers &= ~MOD_MASK_ALT;
2684 }
2685
2686 if (modifiers != 0)
2687 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002688 // Prepend modifiers to the character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 mch_memmove(typeahead + typeaheadlen + 3,
2690 typeahead + typeaheadlen, n);
2691 typeahead[typeaheadlen++] = K_SPECIAL;
2692 typeahead[typeaheadlen++] = (char_u)KS_MODIFIER;
2693 typeahead[typeaheadlen++] = modifiers;
2694 }
2695
2696 typeaheadlen += n;
2697
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002698# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 if (fdDump)
2700 fputc(c, fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002701# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 }
2703 }
2704 }
2705
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002706# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 if (fdDump)
2708 {
2709 fputs("]\n", fdDump);
2710 fflush(fdDump);
2711 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002712# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714theend:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002715 // Move typeahead to "buf", as much as fits.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 len = 0;
2717 while (len < maxlen && typeaheadlen > 0)
2718 {
2719 buf[len++] = typeahead[0];
2720 mch_memmove(typeahead, typeahead + 1, --typeaheadlen);
2721 }
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00002722# ifdef FEAT_EVAL
Bram Moolenaar7ca86fe2020-09-03 19:25:11 +02002723 if (len > 0)
2724 {
2725 buf[len] = NUL;
2726 ch_log(NULL, "raw key input: \"%s\"", buf);
2727 }
K.Takata6e1d31e2022-02-03 13:05:32 +00002728# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 return len;
2730
Bram Moolenaar0f873732019-12-05 20:28:46 +01002731#else // FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002733#endif // FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734}
2735
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002736/*
Bram Moolenaar95da1362020-05-30 18:37:55 +02002737 * Return TRUE if "name" is an executable file, FALSE if not or it doesn't exist.
Bram Moolenaar43663192017-03-05 14:29:12 +01002738 * When returning TRUE and "path" is not NULL save the path and set "*path" to
2739 * the allocated memory.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002740 * TODO: Should somehow check if it's really executable.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002741 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 static int
Bram Moolenaar95da1362020-05-30 18:37:55 +02002743executable_file(char *name, char_u **path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744{
LemonBoy40fd7e62022-05-05 20:18:16 +01002745 int attrs = win32_getattrs((char_u *)name);
2746
2747 // The file doesn't exist or is a folder.
2748 if (attrs == -1 || (attrs & FILE_ATTRIBUTE_DIRECTORY))
2749 return FALSE;
2750 // Check if the file is an AppExecLink, a special alias used by Windows
2751 // Store for its apps.
2752 if (attrs & FILE_ATTRIBUTE_REPARSE_POINT)
Bram Moolenaar43663192017-03-05 14:29:12 +01002753 {
LemonBoy40fd7e62022-05-05 20:18:16 +01002754 char_u *res = resolve_appexeclink((char_u *)name);
2755 if (res == NULL)
AmberArrf5d0f542023-08-20 20:03:45 +02002756 res = resolve_reparse_point((char_u *)name);
2757 if (res == NULL)
LemonBoy40fd7e62022-05-05 20:18:16 +01002758 return FALSE;
2759 // The path is already absolute.
Bram Moolenaar95da1362020-05-30 18:37:55 +02002760 if (path != NULL)
LemonBoy40fd7e62022-05-05 20:18:16 +01002761 *path = res;
2762 else
2763 vim_free(res);
Bram Moolenaar95da1362020-05-30 18:37:55 +02002764 }
LemonBoy40fd7e62022-05-05 20:18:16 +01002765 else if (path != NULL)
2766 *path = FullName_save((char_u *)name, FALSE);
2767 return TRUE;
Bram Moolenaar95da1362020-05-30 18:37:55 +02002768}
2769
2770/*
2771 * If "use_path" is TRUE: Return TRUE if "name" is in $PATH.
2772 * If "use_path" is FALSE: Return TRUE if "name" exists.
2773 * If "use_pathext" is TRUE search "name" with extensions in $PATHEXT.
2774 * When returning TRUE and "path" is not NULL save the path and set "*path" to
2775 * the allocated memory.
2776 */
2777 static int
2778executable_exists(char *name, char_u **path, int use_path, int use_pathext)
2779{
2780 // WinNT and later can use _MAX_PATH wide characters for a pathname, which
2781 // means that the maximum pathname is _MAX_PATH * 3 bytes when 'enc' is
2782 // UTF-8.
2783 char_u buf[_MAX_PATH * 3];
2784 size_t len = STRLEN(name);
2785 size_t tmplen;
2786 char_u *p, *e, *e2;
2787 char_u *pathbuf = NULL;
2788 char_u *pathext = NULL;
2789 char_u *pathextbuf = NULL;
Mike Williamsa3d1b292021-06-30 20:56:00 +02002790 char_u *shname = NULL;
Bram Moolenaar95da1362020-05-30 18:37:55 +02002791 int noext = FALSE;
2792 int retval = FALSE;
2793
2794 if (len >= sizeof(buf)) // safety check
Bram Moolenaar43663192017-03-05 14:29:12 +01002795 return FALSE;
Bram Moolenaar95da1362020-05-30 18:37:55 +02002796
2797 // Using the name directly when a Unix-shell like 'shell'.
Mike Williamsa3d1b292021-06-30 20:56:00 +02002798 shname = gettail(p_sh);
2799 if (strstr((char *)shname, "sh") != NULL &&
2800 !(strstr((char *)shname, "powershell") != NULL
2801 || strstr((char *)shname, "pwsh") != NULL))
Bram Moolenaar95da1362020-05-30 18:37:55 +02002802 noext = TRUE;
2803
2804 if (use_pathext)
2805 {
2806 pathext = mch_getenv("PATHEXT");
2807 if (pathext == NULL)
2808 pathext = (char_u *)".com;.exe;.bat;.cmd";
2809
2810 if (noext == FALSE)
2811 {
2812 /*
2813 * Loop over all extensions in $PATHEXT.
2814 * Check "name" ends with extension.
2815 */
2816 p = pathext;
2817 while (*p)
2818 {
2819 if (p[0] == ';'
2820 || (p[0] == '.' && (p[1] == NUL || p[1] == ';')))
2821 {
2822 // Skip empty or single ".".
2823 ++p;
2824 continue;
2825 }
2826 e = vim_strchr(p, ';');
2827 if (e == NULL)
2828 e = p + STRLEN(p);
2829 tmplen = e - p;
2830
2831 if (_strnicoll(name + len - tmplen, (char *)p, tmplen) == 0)
2832 {
2833 noext = TRUE;
2834 break;
2835 }
2836
2837 p = e;
2838 }
2839 }
Bram Moolenaar43663192017-03-05 14:29:12 +01002840 }
2841
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00002842 // Prepend single "." to pathext, it means no extension added.
Bram Moolenaar95da1362020-05-30 18:37:55 +02002843 if (pathext == NULL)
2844 pathext = (char_u *)".";
2845 else if (noext == TRUE)
2846 {
2847 if (pathextbuf == NULL)
2848 pathextbuf = alloc(STRLEN(pathext) + 3);
2849 if (pathextbuf == NULL)
2850 {
2851 retval = FALSE;
2852 goto theend;
2853 }
2854 STRCPY(pathextbuf, ".;");
2855 STRCAT(pathextbuf, pathext);
2856 pathext = pathextbuf;
2857 }
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02002858
Bram Moolenaar95da1362020-05-30 18:37:55 +02002859 // Use $PATH when "use_path" is TRUE and "name" is basename.
2860 if (use_path && gettail((char_u *)name) == (char_u *)name)
2861 {
2862 p = mch_getenv("PATH");
2863 if (p != NULL)
2864 {
2865 pathbuf = alloc(STRLEN(p) + 3);
2866 if (pathbuf == NULL)
2867 {
2868 retval = FALSE;
2869 goto theend;
2870 }
Yasuhiro Matsumoto05cf63e2022-05-03 11:02:28 +01002871
2872 if (mch_getenv("NoDefaultCurrentDirectoryInExePath") == NULL)
2873 STRCPY(pathbuf, ".;");
2874 else
2875 *pathbuf = NUL;
Bram Moolenaar95da1362020-05-30 18:37:55 +02002876 STRCAT(pathbuf, p);
2877 }
2878 }
2879
2880 /*
2881 * Walk through all entries in $PATH to check if "name" exists there and
2882 * is an executable file.
2883 */
2884 p = (pathbuf != NULL) ? pathbuf : (char_u *)".";
2885 while (*p)
2886 {
2887 if (*p == ';') // Skip empty entry
2888 {
2889 ++p;
2890 continue;
2891 }
2892 e = vim_strchr(p, ';');
2893 if (e == NULL)
2894 e = p + STRLEN(p);
2895
2896 if (e - p + len + 2 > sizeof(buf))
2897 {
2898 retval = FALSE;
2899 goto theend;
2900 }
2901 // A single "." that means current dir.
2902 if (e - p == 1 && *p == '.')
2903 STRCPY(buf, name);
2904 else
2905 {
2906 vim_strncpy(buf, p, e - p);
2907 add_pathsep(buf);
2908 STRCAT(buf, name);
2909 }
2910 tmplen = STRLEN(buf);
2911
2912 /*
2913 * Loop over all extensions in $PATHEXT.
2914 * Check "name" with extension added.
2915 */
2916 p = pathext;
2917 while (*p)
2918 {
2919 if (*p == ';')
2920 {
2921 // Skip empty entry
2922 ++p;
2923 continue;
2924 }
2925 e2 = vim_strchr(p, (int)';');
2926 if (e2 == NULL)
2927 e2 = p + STRLEN(p);
2928
2929 if (!(p[0] == '.' && (p[1] == NUL || p[1] == ';')))
2930 {
2931 // Not a single "." that means no extension is added.
2932 if (e2 - p + tmplen + 1 > sizeof(buf))
2933 {
2934 retval = FALSE;
2935 goto theend;
2936 }
2937 vim_strncpy(buf + tmplen, p, e2 - p);
2938 }
2939 if (executable_file((char *)buf, path))
2940 {
2941 retval = TRUE;
2942 goto theend;
2943 }
2944
2945 p = e2;
2946 }
2947
2948 p = e;
2949 }
2950
2951theend:
2952 free(pathextbuf);
2953 free(pathbuf);
2954 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955}
2956
Bram Moolenaar1eed5322019-02-26 17:03:54 +01002957#if (defined(__MINGW32__) && __MSVCRT_VERSION__ >= 0x800) || \
2958 (defined(_MSC_VER) && _MSC_VER >= 1400)
Bram Moolenaard32a99a2010-09-21 17:29:23 +02002959/*
2960 * Bad parameter handler.
2961 *
2962 * Certain MS CRT functions will intentionally crash when passed invalid
2963 * parameters to highlight possible security holes. Setting this function as
2964 * the bad parameter handler will prevent the crash.
2965 *
2966 * In debug builds the parameters contain CRT information that might help track
2967 * down the source of a problem, but in non-debug builds the arguments are all
2968 * NULL/0. Debug builds will also produce assert dialogs from the CRT, it is
2969 * worth allowing these to make debugging of issues easier.
2970 */
2971 static void
Yegappan Lakshmanana34b4462022-06-11 10:43:26 +01002972bad_param_handler(const wchar_t *expression UNUSED,
2973 const wchar_t *function UNUSED,
2974 const wchar_t *file UNUSED,
2975 unsigned int line UNUSED,
2976 uintptr_t pReserved UNUSED)
Bram Moolenaard32a99a2010-09-21 17:29:23 +02002977{
2978}
2979
2980# define SET_INVALID_PARAM_HANDLER \
2981 ((void)_set_invalid_parameter_handler(bad_param_handler))
2982#else
2983# define SET_INVALID_PARAM_HANDLER
2984#endif
2985
Bram Moolenaar4f974752019-02-17 17:44:42 +01002986#ifdef FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987
2988/*
2989 * GUI version of mch_init().
2990 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002991 static void
2992mch_init_g(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993{
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002994# ifndef __MINGW32__
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 extern int _fmode;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01002996# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997
Bram Moolenaar0f873732019-12-05 20:28:46 +01002998 // Silently handle invalid parameters to CRT functions
Bram Moolenaard32a99a2010-09-21 17:29:23 +02002999 SET_INVALID_PARAM_HANDLER;
3000
Bram Moolenaar0f873732019-12-05 20:28:46 +01003001 // Let critical errors result in a failure, not in a dialog box. Required
3002 // for the timestamp test to work on removed floppies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 SetErrorMode(SEM_FAILCRITICALERRORS);
3004
Bram Moolenaar0f873732019-12-05 20:28:46 +01003005 _fmode = O_BINARY; // we do our own CR-LF translation
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006
Bram Moolenaar0f873732019-12-05 20:28:46 +01003007 // Specify window size. Is there a place to get the default from?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 Rows = 25;
3009 Columns = 80;
3010
Bram Moolenaar0f873732019-12-05 20:28:46 +01003011 // Look for 'vimrun'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 {
3013 char_u vimrun_location[_MAX_PATH + 4];
3014
Bram Moolenaar0f873732019-12-05 20:28:46 +01003015 // First try in same directory as gvim.exe
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 STRCPY(vimrun_location, exe_name);
3017 STRCPY(gettail(vimrun_location), "vimrun.exe");
3018 if (mch_getperm(vimrun_location) >= 0)
3019 {
3020 if (*skiptowhite(vimrun_location) != NUL)
3021 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003022 // Enclose path with white space in double quotes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 mch_memmove(vimrun_location + 1, vimrun_location,
3024 STRLEN(vimrun_location) + 1);
3025 *vimrun_location = '"';
3026 STRCPY(gettail(vimrun_location), "vimrun\" ");
3027 }
3028 else
3029 STRCPY(gettail(vimrun_location), "vimrun ");
3030
3031 vimrun_path = (char *)vim_strsave(vimrun_location);
3032 s_dont_use_vimrun = FALSE;
3033 }
Bram Moolenaar95da1362020-05-30 18:37:55 +02003034 else if (executable_exists("vimrun.exe", NULL, TRUE, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 s_dont_use_vimrun = FALSE;
3036
Bram Moolenaar0f873732019-12-05 20:28:46 +01003037 // Don't give the warning for a missing vimrun.exe right now, but only
3038 // when vimrun was supposed to be used. Don't bother people that do
3039 // not need vimrun.exe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 if (s_dont_use_vimrun)
3041 need_vimrun_warning = TRUE;
3042 }
3043
3044 /*
3045 * If "finstr.exe" doesn't exist, use "grep -n" for 'grepprg'.
3046 * Otherwise the default "findstr /n" is used.
3047 */
Bram Moolenaar95da1362020-05-30 18:37:55 +02003048 if (!executable_exists("findstr.exe", NULL, TRUE, FALSE))
Bram Moolenaar75ab5902022-04-18 15:36:40 +01003049 set_option_value_give_err((char_u *)"grepprg",
3050 0, (char_u *)"grep -n", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003052# ifdef FEAT_CLIPBOARD
Bram Moolenaar693e40c2013-02-26 14:56:42 +01003053 win_clip_init();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003054# endif
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01003055
3056 vtp_flag_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057}
3058
3059
Bram Moolenaar0f873732019-12-05 20:28:46 +01003060#endif // FEAT_GUI_MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003061
3062#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003064# define SRWIDTH(sr) ((sr).Right - (sr).Left + 1)
3065# define SRHEIGHT(sr) ((sr).Bottom - (sr).Top + 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066
3067/*
3068 * ClearConsoleBuffer()
3069 * Description:
3070 * Clears the entire contents of the console screen buffer, using the
3071 * specified attribute.
3072 * Returns:
3073 * TRUE on success
3074 */
3075 static BOOL
3076ClearConsoleBuffer(WORD wAttribute)
3077{
3078 CONSOLE_SCREEN_BUFFER_INFO csbi;
3079 COORD coord;
3080 DWORD NumCells, dummy;
3081
3082 if (!GetConsoleScreenBufferInfo(g_hConOut, &csbi))
3083 return FALSE;
3084
3085 NumCells = csbi.dwSize.X * csbi.dwSize.Y;
3086 coord.X = 0;
3087 coord.Y = 0;
3088 if (!FillConsoleOutputCharacter(g_hConOut, ' ', NumCells,
3089 coord, &dummy))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 if (!FillConsoleOutputAttribute(g_hConOut, wAttribute, NumCells,
3092 coord, &dummy))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094
3095 return TRUE;
3096}
3097
3098/*
3099 * FitConsoleWindow()
3100 * Description:
3101 * Checks if the console window will fit within given buffer dimensions.
3102 * Also, if requested, will shrink the window to fit.
3103 * Returns:
3104 * TRUE on success
3105 */
3106 static BOOL
3107FitConsoleWindow(
3108 COORD dwBufferSize,
3109 BOOL WantAdjust)
3110{
3111 CONSOLE_SCREEN_BUFFER_INFO csbi;
3112 COORD dwWindowSize;
3113 BOOL NeedAdjust = FALSE;
3114
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003115 if (!GetConsoleScreenBufferInfo(g_hConOut, &csbi))
3116 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003118 /*
3119 * A buffer resize will fail if the current console window does
3120 * not lie completely within that buffer. To avoid this, we might
3121 * have to move and possibly shrink the window.
3122 */
3123 if (csbi.srWindow.Right >= dwBufferSize.X)
3124 {
3125 dwWindowSize.X = SRWIDTH(csbi.srWindow);
3126 if (dwWindowSize.X > dwBufferSize.X)
3127 dwWindowSize.X = dwBufferSize.X;
3128 csbi.srWindow.Right = dwBufferSize.X - 1;
3129 csbi.srWindow.Left = dwBufferSize.X - dwWindowSize.X;
3130 NeedAdjust = TRUE;
3131 }
3132 if (csbi.srWindow.Bottom >= dwBufferSize.Y)
3133 {
3134 dwWindowSize.Y = SRHEIGHT(csbi.srWindow);
3135 if (dwWindowSize.Y > dwBufferSize.Y)
3136 dwWindowSize.Y = dwBufferSize.Y;
3137 csbi.srWindow.Bottom = dwBufferSize.Y - 1;
3138 csbi.srWindow.Top = dwBufferSize.Y - dwWindowSize.Y;
3139 NeedAdjust = TRUE;
3140 }
3141 if (NeedAdjust && WantAdjust)
3142 {
3143 if (!SetConsoleWindowInfo(g_hConOut, TRUE, &csbi.srWindow))
3144 return FALSE;
3145 }
3146 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147}
3148
3149typedef struct ConsoleBufferStruct
3150{
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003151 BOOL IsValid;
3152 CONSOLE_SCREEN_BUFFER_INFO Info;
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003153 PCHAR_INFO Buffer;
3154 COORD BufferSize;
Bram Moolenaar444fda22017-08-11 20:37:00 +02003155 PSMALL_RECT Regions;
3156 int NumRegions;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157} ConsoleBuffer;
3158
3159/*
3160 * SaveConsoleBuffer()
3161 * Description:
3162 * Saves important information about the console buffer, including the
3163 * actual buffer contents. The saved information is suitable for later
3164 * restoration by RestoreConsoleBuffer().
3165 * Returns:
3166 * TRUE if all information was saved; FALSE otherwise
3167 * If FALSE, still sets cb->IsValid if buffer characteristics were saved.
3168 */
3169 static BOOL
3170SaveConsoleBuffer(
3171 ConsoleBuffer *cb)
3172{
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003173 DWORD NumCells;
3174 COORD BufferCoord;
3175 SMALL_RECT ReadRegion;
3176 WORD Y, Y_incr;
Bram Moolenaar444fda22017-08-11 20:37:00 +02003177 int i, numregions;
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 if (cb == NULL)
3180 return FALSE;
3181
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003182 if (!GetConsoleScreenBufferInfo(g_hConOut, &cb->Info))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 {
3184 cb->IsValid = FALSE;
3185 return FALSE;
3186 }
3187 cb->IsValid = TRUE;
3188
Christopher Plewright1140b512022-11-12 18:46:05 +00003189 // VTP uses alternate screen buffer.
3190 // No need to save buffer contents for restoration.
Christopher Plewrightc8b126d2022-12-22 13:45:23 +00003191 if (use_alternate_screen_buffer)
Christopher Plewright1140b512022-11-12 18:46:05 +00003192 return TRUE;
3193
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003194 /*
3195 * Allocate a buffer large enough to hold the entire console screen
3196 * buffer. If this ConsoleBuffer structure has already been initialized
3197 * with a buffer of the correct size, then just use that one.
3198 */
3199 if (!cb->IsValid || cb->Buffer == NULL ||
3200 cb->BufferSize.X != cb->Info.dwSize.X ||
3201 cb->BufferSize.Y != cb->Info.dwSize.Y)
3202 {
3203 cb->BufferSize.X = cb->Info.dwSize.X;
3204 cb->BufferSize.Y = cb->Info.dwSize.Y;
3205 NumCells = cb->BufferSize.X * cb->BufferSize.Y;
3206 vim_free(cb->Buffer);
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003207 cb->Buffer = ALLOC_MULT(CHAR_INFO, NumCells);
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003208 if (cb->Buffer == NULL)
3209 return FALSE;
3210 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211
3212 /*
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003213 * We will now copy the console screen buffer into our buffer.
3214 * ReadConsoleOutput() seems to be limited as far as how much you
3215 * can read at a time. Empirically, this number seems to be about
3216 * 12000 cells (rows * columns). Start at position (0, 0) and copy
3217 * in chunks until it is all copied. The chunks will all have the
3218 * same horizontal characteristics, so initialize them now. The
3219 * height of each chunk will be (12000 / width).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 */
Bram Moolenaar61594242015-09-01 20:23:37 +02003221 BufferCoord.X = 0;
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003222 ReadRegion.Left = 0;
3223 ReadRegion.Right = cb->Info.dwSize.X - 1;
3224 Y_incr = 12000 / cb->Info.dwSize.X;
Bram Moolenaar444fda22017-08-11 20:37:00 +02003225
3226 numregions = (cb->Info.dwSize.Y + Y_incr - 1) / Y_incr;
3227 if (cb->Regions == NULL || numregions != cb->NumRegions)
3228 {
3229 cb->NumRegions = numregions;
3230 vim_free(cb->Regions);
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003231 cb->Regions = ALLOC_MULT(SMALL_RECT, cb->NumRegions);
Bram Moolenaar444fda22017-08-11 20:37:00 +02003232 if (cb->Regions == NULL)
3233 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01003234 VIM_CLEAR(cb->Buffer);
Bram Moolenaar444fda22017-08-11 20:37:00 +02003235 return FALSE;
3236 }
3237 }
3238
3239 for (i = 0, Y = 0; i < cb->NumRegions; i++, Y += Y_incr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 {
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003241 /*
3242 * Read into position (0, Y) in our buffer.
3243 */
3244 BufferCoord.Y = Y;
3245 /*
3246 * Read the region whose top left corner is (0, Y) and whose bottom
3247 * right corner is (width - 1, Y + Y_incr - 1). This should define
3248 * a region of size width by Y_incr. Don't worry if this region is
3249 * too large for the remaining buffer; it will be cropped.
3250 */
3251 ReadRegion.Top = Y;
3252 ReadRegion.Bottom = Y + Y_incr - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003253 if (!ReadConsoleOutputW(g_hConOut, // output handle
3254 cb->Buffer, // our buffer
3255 cb->BufferSize, // dimensions of our buffer
3256 BufferCoord, // offset in our buffer
3257 &ReadRegion)) // region to save
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003258 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01003259 VIM_CLEAR(cb->Buffer);
3260 VIM_CLEAR(cb->Regions);
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003261 return FALSE;
3262 }
Bram Moolenaar444fda22017-08-11 20:37:00 +02003263 cb->Regions[i] = ReadRegion;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 }
3265
3266 return TRUE;
3267}
3268
3269/*
3270 * RestoreConsoleBuffer()
3271 * Description:
3272 * Restores important information about the console buffer, including the
3273 * actual buffer contents, if desired. The information to restore is in
3274 * the same format used by SaveConsoleBuffer().
3275 * Returns:
3276 * TRUE on success
3277 */
3278 static BOOL
3279RestoreConsoleBuffer(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003280 ConsoleBuffer *cb,
3281 BOOL RestoreScreen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282{
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003283 COORD BufferCoord;
3284 SMALL_RECT WriteRegion;
Bram Moolenaar444fda22017-08-11 20:37:00 +02003285 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286
Christopher Plewright1140b512022-11-12 18:46:05 +00003287
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 if (cb == NULL || !cb->IsValid)
3289 return FALSE;
3290
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003291 /*
3292 * Before restoring the buffer contents, clear the current buffer, and
3293 * restore the cursor position and window information. Doing this now
3294 * prevents old buffer contents from "flashing" onto the screen.
3295 */
3296 if (RestoreScreen)
3297 ClearConsoleBuffer(cb->Info.wAttributes);
3298
3299 FitConsoleWindow(cb->Info.dwSize, TRUE);
3300 if (!SetConsoleScreenBufferSize(g_hConOut, cb->Info.dwSize))
3301 return FALSE;
3302 if (!SetConsoleTextAttribute(g_hConOut, cb->Info.wAttributes))
3303 return FALSE;
3304
3305 if (!RestoreScreen)
3306 {
3307 /*
3308 * No need to restore the screen buffer contents, so we're done.
3309 */
3310 return TRUE;
3311 }
3312
3313 if (!SetConsoleCursorPosition(g_hConOut, cb->Info.dwCursorPosition))
3314 return FALSE;
3315 if (!SetConsoleWindowInfo(g_hConOut, TRUE, &cb->Info.srWindow))
3316 return FALSE;
3317
Christopher Plewrightab281f82025-03-16 19:14:31 +01003318 // VTP uses alternate screen buffer.
3319 // No need to restore buffer contents.
3320 if (use_alternate_screen_buffer)
3321 return TRUE;
3322
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003323 /*
3324 * Restore the screen buffer contents.
3325 */
3326 if (cb->Buffer != NULL)
3327 {
Bram Moolenaar444fda22017-08-11 20:37:00 +02003328 for (i = 0; i < cb->NumRegions; i++)
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003329 {
Bram Moolenaar444fda22017-08-11 20:37:00 +02003330 BufferCoord.X = cb->Regions[i].Left;
3331 BufferCoord.Y = cb->Regions[i].Top;
3332 WriteRegion = cb->Regions[i];
Bram Moolenaar0f873732019-12-05 20:28:46 +01003333 if (!WriteConsoleOutputW(g_hConOut, // output handle
3334 cb->Buffer, // our buffer
3335 cb->BufferSize, // dimensions of our buffer
3336 BufferCoord, // offset in our buffer
3337 &WriteRegion)) // region to restore
Bram Moolenaar444fda22017-08-11 20:37:00 +02003338 return FALSE;
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003339 }
3340 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341
3342 return TRUE;
3343}
3344
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003345# define FEAT_RESTORE_ORIG_SCREEN
3346# ifdef FEAT_RESTORE_ORIG_SCREEN
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003347static ConsoleBuffer g_cbOrig = { 0 };
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003348# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349static ConsoleBuffer g_cbNonTermcap = { 0 };
3350static ConsoleBuffer g_cbTermcap = { 0 };
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352char g_szOrigTitle[256] = { 0 };
Bram Moolenaar0f873732019-12-05 20:28:46 +01003353HWND g_hWnd = NULL; // also used in os_mswin.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354static HICON g_hOrigIconSmall = NULL;
3355static HICON g_hOrigIcon = NULL;
3356static HICON g_hVimIcon = NULL;
3357static BOOL g_fCanChangeIcon = FALSE;
3358
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359/*
3360 * GetConsoleIcon()
3361 * Description:
3362 * Attempts to retrieve the small icon and/or the big icon currently in
3363 * use by a given window.
3364 * Returns:
3365 * TRUE on success
3366 */
3367 static BOOL
3368GetConsoleIcon(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003369 HWND hWnd,
3370 HICON *phIconSmall,
3371 HICON *phIcon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372{
3373 if (hWnd == NULL)
3374 return FALSE;
3375
3376 if (phIconSmall != NULL)
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003377 *phIconSmall = (HICON)SendMessage(hWnd, WM_GETICON,
3378 (WPARAM)ICON_SMALL, (LPARAM)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 if (phIcon != NULL)
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003380 *phIcon = (HICON)SendMessage(hWnd, WM_GETICON,
3381 (WPARAM)ICON_BIG, (LPARAM)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 return TRUE;
3383}
3384
3385/*
3386 * SetConsoleIcon()
3387 * Description:
3388 * Attempts to change the small icon and/or the big icon currently in
3389 * use by a given window.
3390 * Returns:
3391 * TRUE on success
3392 */
3393 static BOOL
3394SetConsoleIcon(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003395 HWND hWnd,
3396 HICON hIconSmall,
3397 HICON hIcon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 if (hWnd == NULL)
3400 return FALSE;
3401
3402 if (hIconSmall != NULL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01003403 SendMessage(hWnd, WM_SETICON,
3404 (WPARAM)ICON_SMALL, (LPARAM)hIconSmall);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 if (hIcon != NULL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01003406 SendMessage(hWnd, WM_SETICON,
3407 (WPARAM)ICON_BIG, (LPARAM) hIcon);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 return TRUE;
3409}
3410
3411/*
3412 * SaveConsoleTitleAndIcon()
3413 * Description:
3414 * Saves the current console window title in g_szOrigTitle, for later
3415 * restoration. Also, attempts to obtain a handle to the console window,
3416 * and use it to save the small and big icons currently in use by the
3417 * console window. This is not always possible on some versions of Windows;
3418 * nor is it possible when running Vim remotely using Telnet (since the
3419 * console window the user sees is owned by a remote process).
3420 */
3421 static void
3422SaveConsoleTitleAndIcon(void)
3423{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003424 // Save the original title.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 if (!GetConsoleTitle(g_szOrigTitle, sizeof(g_szOrigTitle)))
3426 return;
3427
3428 /*
3429 * Obtain a handle to the console window using GetConsoleWindow() from
3430 * KERNEL32.DLL; we need to handle in order to change the window icon.
3431 * This function only exists on NT-based Windows, starting with Windows
3432 * 2000. On older operating systems, we can't change the window icon
3433 * anyway.
3434 */
Bram Moolenaarcea912a2016-10-12 14:20:24 +02003435 g_hWnd = GetConsoleWindow();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 if (g_hWnd == NULL)
3437 return;
3438
Bram Moolenaar0f873732019-12-05 20:28:46 +01003439 // Save the original console window icon.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 GetConsoleIcon(g_hWnd, &g_hOrigIconSmall, &g_hOrigIcon);
3441 if (g_hOrigIconSmall == NULL || g_hOrigIcon == NULL)
3442 return;
3443
Bram Moolenaar0f873732019-12-05 20:28:46 +01003444 // Extract the first icon contained in the Vim executable.
K.Takata2da11a42022-09-10 13:03:12 +01003445 if (
3446# ifdef FEAT_LIBCALL
3447 mch_icon_load((HANDLE *)&g_hVimIcon) == FAIL ||
3448# endif
3449 g_hVimIcon == NULL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01003450 g_hVimIcon = ExtractIcon(NULL, (LPCSTR)exe_name, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 if (g_hVimIcon != NULL)
3452 g_fCanChangeIcon = TRUE;
3453}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454
3455static int g_fWindInitCalled = FALSE;
3456static int g_fTermcapMode = FALSE;
3457static CONSOLE_CURSOR_INFO g_cci;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458
3459/*
3460 * non-GUI version of mch_init().
3461 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003462 static void
3463mch_init_c(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464{
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003465# ifndef FEAT_RESTORE_ORIG_SCREEN
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003466 CONSOLE_SCREEN_BUFFER_INFO csbi;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003467# endif
3468# ifndef __MINGW32__
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 extern int _fmode;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003470# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471
Bram Moolenaar0f873732019-12-05 20:28:46 +01003472 // Silently handle invalid parameters to CRT functions
Bram Moolenaard32a99a2010-09-21 17:29:23 +02003473 SET_INVALID_PARAM_HANDLER;
3474
Bram Moolenaar0f873732019-12-05 20:28:46 +01003475 // Let critical errors result in a failure, not in a dialog box. Required
3476 // for the timestamp test to work on removed floppies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 SetErrorMode(SEM_FAILCRITICALERRORS);
3478
Bram Moolenaar0f873732019-12-05 20:28:46 +01003479 _fmode = O_BINARY; // we do our own CR-LF translation
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 out_flush();
3481
Bram Moolenaar0f873732019-12-05 20:28:46 +01003482 // Obtain handles for the standard Console I/O devices
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 if (read_cmd_fd == 0)
3484 g_hConIn = GetStdHandle(STD_INPUT_HANDLE);
3485 else
3486 create_conin();
3487 g_hConOut = GetStdHandle(STD_OUTPUT_HANDLE);
3488
Christopher Plewright38804d62022-11-09 23:55:52 +00003489 wt_init();
3490 vtp_flag_init();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003491# ifdef FEAT_RESTORE_ORIG_SCREEN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003492 // Save the initial console buffer for later restoration
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003493 SaveConsoleBuffer(&g_cbOrig);
3494 g_attrCurrent = g_attrDefault = g_cbOrig.Info.wAttributes;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003495# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003496 // Get current text attributes
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01003497 GetConsoleScreenBufferInfo(g_hConOut, &csbi);
3498 g_attrCurrent = g_attrDefault = csbi.wAttributes;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003499# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 if (cterm_normal_fg_color == 0)
3501 cterm_normal_fg_color = (g_attrCurrent & 0xf) + 1;
3502 if (cterm_normal_bg_color == 0)
3503 cterm_normal_bg_color = ((g_attrCurrent >> 4) & 0xf) + 1;
3504
Bram Moolenaarbdace832019-03-02 10:13:42 +01003505 // Fg and Bg color index number at startup
Bram Moolenaarf6ceaf12018-08-30 17:47:05 +02003506 g_color_index_fg = g_attrDefault & 0xf;
3507 g_color_index_bg = (g_attrDefault >> 4) & 0xf;
3508
Bram Moolenaar0f873732019-12-05 20:28:46 +01003509 // set termcap codes to current text attributes
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 update_tcap(g_attrCurrent);
3511
3512 GetConsoleCursorInfo(g_hConOut, &g_cci);
3513 GetConsoleMode(g_hConIn, &g_cmodein);
3514 GetConsoleMode(g_hConOut, &g_cmodeout);
3515
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 SaveConsoleTitleAndIcon();
3517 /*
3518 * Set both the small and big icons of the console window to Vim's icon.
3519 * Note that Vim presently only has one size of icon (32x32), but it
3520 * automatically gets scaled down to 16x16 when setting the small icon.
3521 */
3522 if (g_fCanChangeIcon)
3523 SetConsoleIcon(g_hWnd, g_hVimIcon, g_hVimIcon);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
3525 ui_get_shellsize();
3526
Christopher Plewrightd343c602023-01-22 18:58:30 +00003527 vtp_init();
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00003528 // Switch to a new alternate screen buffer.
3529 if (use_alternate_screen_buffer)
3530 vtp_printf("\033[?1049h");
Christopher Plewrightd343c602023-01-22 18:58:30 +00003531
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003532# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 fdDump = fopen("dump", "wt");
3534
3535 if (fdDump)
3536 {
3537 time_t t;
3538
3539 time(&t);
3540 fputs(ctime(&t), fdDump);
3541 fflush(fdDump);
3542 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003543# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
3545 g_fWindInitCalled = TRUE;
3546
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 g_fMouseAvail = GetSystemMetrics(SM_MOUSEPRESENT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003549# ifdef FEAT_CLIPBOARD
Bram Moolenaar693e40c2013-02-26 14:56:42 +01003550 win_clip_init();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003551# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552}
3553
3554/*
3555 * non-GUI version of mch_exit().
3556 * Shut down and exit with status `r'
3557 * Careful: mch_exit() may be called before mch_init()!
3558 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003559 static void
3560mch_exit_c(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561{
William Breslerded59132024-10-08 21:30:48 +02003562 // Copy flag since stoptermcap() will clear the flag.
3563 int fTermcapMode = g_fTermcapMode;
3564
Bram Moolenaar955f1982017-02-05 15:10:51 +01003565 exiting = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566
Bram Moolenaarcafafb32018-02-22 21:07:09 +01003567 vtp_exit();
3568
Bram Moolenaar955f1982017-02-05 15:10:51 +01003569 stoptermcap();
William Breslerded59132024-10-08 21:30:48 +02003570 // Switch back to main screen buffer if TermcapMode was not active.
3571 if (!fTermcapMode && use_alternate_screen_buffer)
Ken Takata568cbc92024-08-07 21:18:24 +02003572 vtp_printf("\033[?1049l");
3573
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 if (g_fWindInitCalled)
3575 settmode(TMODE_COOK);
3576
Bram Moolenaar0f873732019-12-05 20:28:46 +01003577 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578
3579 if (g_fWindInitCalled)
3580 {
Bram Moolenaar40385db2018-08-07 22:31:44 +02003581 mch_restore_title(SAVE_RESTORE_BOTH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 /*
3583 * Restore both the small and big icons of the console window to
3584 * what they were at startup. Don't do this when the window is
3585 * closed, Vim would hang here.
3586 */
3587 if (g_fCanChangeIcon && !g_fForceExit)
3588 SetConsoleIcon(g_hWnd, g_hOrigIconSmall, g_hOrigIcon);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003590# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 if (fdDump)
3592 {
3593 time_t t;
3594
3595 time(&t);
3596 fputs(ctime(&t), fdDump);
3597 fclose(fdDump);
3598 }
3599 fdDump = NULL;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003600# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 }
3602
3603 SetConsoleCursorInfo(g_hConOut, &g_cci);
Wez Furlong6ef5ab52021-05-30 19:29:41 +02003604 SetConsoleMode(g_hConIn, g_cmodein | ENABLE_EXTENDED_FLAGS);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 SetConsoleMode(g_hConOut, g_cmodeout);
3606
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003607# ifdef DYNAMIC_GETTEXT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 dyn_libintl_end();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01003609# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610
3611 exit(r);
3612}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003613#endif // !FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003615 void
3616mch_init(void)
3617{
3618#ifdef VIMDLL
3619 if (gui.starting)
3620 mch_init_g();
3621 else
3622 mch_init_c();
3623#elif defined(FEAT_GUI_MSWIN)
3624 mch_init_g();
3625#else
3626 mch_init_c();
3627#endif
3628}
3629
3630 void
3631mch_exit(int r)
3632{
Bram Moolenaar173d8412020-04-19 14:02:26 +02003633#ifdef FEAT_NETBEANS_INTG
3634 netbeans_send_disconnect();
3635#endif
3636
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003637#ifdef VIMDLL
Bram Moolenaar294d9bf2019-05-23 20:12:46 +02003638 if (gui.in_use || gui.starting)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003639 mch_exit_g(r);
3640 else
3641 mch_exit_c(r);
3642#elif defined(FEAT_GUI_MSWIN)
3643 mch_exit_g(r);
3644#else
3645 mch_exit_c(r);
3646#endif
3647}
3648
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649/*
3650 * Do we have an interactive window?
3651 */
3652 int
3653mch_check_win(
Bram Moolenaar1266d672017-02-01 13:43:36 +01003654 int argc UNUSED,
3655 char **argv UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656{
K.Takatace3189d2023-02-15 19:13:43 +00003657 mch_get_exe_name();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003659#if defined(FEAT_GUI_MSWIN) && !defined(VIMDLL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003660 return OK; // GUI always has a tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661#else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003662# ifdef VIMDLL
3663 if (gui.in_use)
3664 return OK;
3665# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 if (isatty(1))
3667 return OK;
3668 return FAIL;
3669#endif
3670}
3671
Bram Moolenaar65f04f62013-08-30 17:29:16 +02003672/*
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003673 * Set the case of the file name, if it already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 * When "len" is > 0, also expand short to long filenames.
3675 */
3676 void
3677fname_case(
3678 char_u *name,
3679 int len)
3680{
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003681 int flen;
3682 WCHAR *p;
3683 WCHAR buf[_MAX_PATH + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684
Bram Moolenaara3ffd9c2005-07-21 21:03:15 +00003685 flen = (int)STRLEN(name);
Bram Moolenaar65f04f62013-08-30 17:29:16 +02003686 if (flen == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 return;
3688
3689 slash_adjust(name);
3690
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003691 p = enc_to_utf16(name, NULL);
3692 if (p == NULL)
Bram Moolenaar65f04f62013-08-30 17:29:16 +02003693 return;
3694
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003695 if (GetLongPathNameW(p, buf, _MAX_PATH))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 {
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003697 char_u *q = utf16_to_enc(buf, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003699 if (q != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 {
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003701 if (len > 0 || flen >= (int)STRLEN(q))
3702 vim_strncpy(name, q, (len > 0) ? len - 1 : flen);
3703 vim_free(q);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 }
3705 }
Bram Moolenaar8bb41b32019-03-30 17:28:16 +01003706 vim_free(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707}
3708
3709
3710/*
3711 * Insert user name in s[len].
3712 */
3713 int
3714mch_get_user_name(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003715 char_u *s,
3716 int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003718 WCHAR wszUserName[256 + 1]; // UNLEN is 256
K.Takataeeec2542021-06-02 13:28:16 +02003719 DWORD wcch = ARRAY_LENGTH(wszUserName);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003721 if (GetUserNameW(wszUserName, &wcch))
Bram Moolenaarc8020ee2013-12-11 18:18:06 +01003722 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003723 char_u *p = utf16_to_enc(wszUserName, NULL);
Bram Moolenaarc8020ee2013-12-11 18:18:06 +01003724
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003725 if (p != NULL)
Bram Moolenaarc8020ee2013-12-11 18:18:06 +01003726 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003727 vim_strncpy(s, p, len - 1);
3728 vim_free(p);
3729 return OK;
Bram Moolenaarc8020ee2013-12-11 18:18:06 +01003730 }
Bram Moolenaarc8020ee2013-12-11 18:18:06 +01003731 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 s[0] = NUL;
3733 return FAIL;
3734}
3735
3736
3737/*
3738 * Insert host name in s[len].
3739 */
3740 void
3741mch_get_host_name(
3742 char_u *s,
3743 int len)
3744{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003745 WCHAR wszHostName[256 + 1];
K.Takataeeec2542021-06-02 13:28:16 +02003746 DWORD wcch = ARRAY_LENGTH(wszHostName);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003748 if (!GetComputerNameW(wszHostName, &wcch))
3749 return;
Bram Moolenaar2cc87382013-12-11 18:21:45 +01003750
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003751 char_u *p = utf16_to_enc(wszHostName, NULL);
3752 if (p == NULL)
3753 return;
3754
3755 vim_strncpy(s, p, len - 1);
3756 vim_free(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757}
3758
3759
3760/*
3761 * return process ID
3762 */
3763 long
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003764mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765{
3766 return (long)GetCurrentProcessId();
3767}
3768
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02003769/*
3770 * return TRUE if process "pid" is still running
3771 */
3772 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02003773mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02003774{
3775 HANDLE hProcess = OpenProcess(PROCESS_QUERY_INFORMATION, 0, (DWORD)pid);
3776 DWORD status = 0;
3777 int ret = FALSE;
3778
3779 if (hProcess == NULL)
3780 return FALSE; // might not have access
3781 if (GetExitCodeProcess(hProcess, &status) )
3782 ret = status == STILL_ACTIVE;
3783 CloseHandle(hProcess);
3784 return ret;
3785}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786
3787/*
3788 * Get name of current directory into buffer 'buf' of length 'len' bytes.
3789 * Return OK for success, FAIL for failure.
3790 */
3791 int
3792mch_dirname(
3793 char_u *buf,
3794 int len)
3795{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003796 WCHAR wbuf[_MAX_PATH + 1];
Bram Moolenaar3b9fcfc2018-08-18 20:20:27 +02003797
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 /*
3799 * Originally this was:
3800 * return (getcwd(buf, len) != NULL ? OK : FAIL);
3801 * But the Win32s known bug list says that getcwd() doesn't work
3802 * so use the Win32 system call instead. <Negri>
3803 */
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003804 if (GetCurrentDirectoryW(_MAX_PATH, wbuf) == 0)
3805 return FAIL;
3806
3807 WCHAR wcbuf[_MAX_PATH + 1];
3808 char_u *p = NULL;
3809
3810 if (GetLongPathNameW(wbuf, wcbuf, _MAX_PATH) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003812 p = utf16_to_enc(wcbuf, NULL);
3813 if (STRLEN(p) >= (size_t)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003815 // long path name is too long, fall back to short one
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00003816 VIM_CLEAR(p);
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003817 }
3818 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003819 if (p == NULL)
3820 p = utf16_to_enc(wbuf, NULL);
3821
3822 if (p == NULL)
3823 return FAIL;
3824
3825 vim_strncpy(buf, p, len - 1);
3826 vim_free(p);
3827 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828}
3829
3830/*
Bram Moolenaarffa22202013-11-21 12:34:11 +01003831 * Get file permissions for "name".
3832 * Return mode_t or -1 for error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 */
3834 long
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003835mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003837 stat_T st;
Bram Moolenaarffa22202013-11-21 12:34:11 +01003838 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01003840 n = mch_stat((char *)name, &st);
Bram Moolenaar78cf3f02014-01-10 18:16:07 +01003841 return n == 0 ? (long)(unsigned short)st.st_mode : -1L;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842}
3843
3844
3845/*
Bram Moolenaare24a9c02013-07-24 13:49:22 +02003846 * Set file permission for "name" to "perm".
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003847 *
Bram Moolenaare24a9c02013-07-24 13:49:22 +02003848 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 */
3850 int
Bram Moolenaare24a9c02013-07-24 13:49:22 +02003851mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003853 long n;
3854 WCHAR *p;
Bram Moolenaare24a9c02013-07-24 13:49:22 +02003855
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003856 p = enc_to_utf16(name, NULL);
3857 if (p == NULL)
3858 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003860 n = _wchmod(p, perm);
3861 vim_free(p);
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003862 if (n == -1)
3863 return FAIL;
3864
3865 win32_set_archive(name);
3866
3867 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868}
3869
3870/*
3871 * Set hidden flag for "name".
3872 */
3873 void
3874mch_hide(char_u *name)
3875{
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003876 int attrs = win32_getattrs(name);
3877 if (attrs == -1)
3878 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003880 attrs |= FILE_ATTRIBUTE_HIDDEN;
3881 win32_setattrs(name, attrs);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882}
3883
3884/*
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01003885 * Return TRUE if file "name" exists and is hidden.
3886 */
3887 int
3888mch_ishidden(char_u *name)
3889{
3890 int f = win32_getattrs(name);
3891
3892 if (f == -1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003893 return FALSE; // file does not exist at all
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01003894
3895 return (f & FILE_ATTRIBUTE_HIDDEN) != 0;
3896}
3897
3898/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 * return TRUE if "name" is a directory
3900 * return FALSE if "name" is not a directory or upon error
3901 */
3902 int
3903mch_isdir(char_u *name)
3904{
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003905 int f = win32_getattrs(name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906
3907 if (f == -1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003908 return FALSE; // file does not exist at all
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909
3910 return (f & FILE_ATTRIBUTE_DIRECTORY) != 0;
3911}
3912
3913/*
Bram Moolenaar203258c2016-01-17 22:15:16 +01003914 * return TRUE if "name" is a directory, NOT a symlink to a directory
3915 * return FALSE if "name" is not a directory
3916 * return FALSE for error
3917 */
3918 int
3919mch_isrealdir(char_u *name)
3920{
3921 return mch_isdir(name) && !mch_is_symbolic_link(name);
3922}
3923
3924/*
Bram Moolenaar3c9c99c2011-05-05 18:31:59 +02003925 * Create directory "name".
3926 * Return 0 on success, -1 on error.
3927 */
3928 int
3929mch_mkdir(char_u *name)
3930{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003931 WCHAR *p;
3932 int retval;
Bram Moolenaar3c9c99c2011-05-05 18:31:59 +02003933
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003934 p = enc_to_utf16(name, NULL);
3935 if (p == NULL)
3936 return -1;
3937 retval = _wmkdir(p);
3938 vim_free(p);
3939 return retval;
Bram Moolenaar3c9c99c2011-05-05 18:31:59 +02003940}
3941
3942/*
Bram Moolenaar4cf76792016-01-16 22:02:57 +01003943 * Delete directory "name".
3944 * Return 0 on success, -1 on error.
3945 */
3946 int
3947mch_rmdir(char_u *name)
3948{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003949 WCHAR *p;
3950 int retval;
Bram Moolenaar4cf76792016-01-16 22:02:57 +01003951
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003952 p = enc_to_utf16(name, NULL);
3953 if (p == NULL)
3954 return -1;
3955 retval = _wrmdir(p);
3956 vim_free(p);
3957 return retval;
Bram Moolenaar4cf76792016-01-16 22:02:57 +01003958}
3959
3960/*
Bram Moolenaar03f48552006-02-28 23:52:23 +00003961 * Return TRUE if file "fname" has more than one link.
3962 */
3963 int
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003964mch_is_hard_link(char_u *fname)
Bram Moolenaar03f48552006-02-28 23:52:23 +00003965{
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02003966 BY_HANDLE_FILE_INFORMATION info;
3967
3968 return win32_fileinfo(fname, &info) == FILEINFO_OK
3969 && info.nNumberOfLinks > 1;
3970}
3971
3972/*
Bram Moolenaar203258c2016-01-17 22:15:16 +01003973 * Return TRUE if "name" is a symbolic link (or a junction).
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003974 */
3975 int
Bram Moolenaar203258c2016-01-17 22:15:16 +01003976mch_is_symbolic_link(char_u *name)
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003977{
3978 HANDLE hFind;
3979 int res = FALSE;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003980 DWORD fileFlags = 0, reparseTag = 0;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003981 WCHAR *wn;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003982 WIN32_FIND_DATAW findDataW;
3983
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003984 wn = enc_to_utf16(name, NULL);
3985 if (wn == NULL)
3986 return FALSE;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003987
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003988 hFind = FindFirstFileW(wn, &findDataW);
3989 vim_free(wn);
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003990 if (hFind != INVALID_HANDLE_VALUE)
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003991 {
3992 fileFlags = findDataW.dwFileAttributes;
3993 reparseTag = findDataW.dwReserved0;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003994 FindClose(hFind);
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02003995 }
Bram Moolenaar12b559e2013-06-12 22:41:37 +02003996
3997 if ((fileFlags & FILE_ATTRIBUTE_REPARSE_POINT)
Bram Moolenaar203258c2016-01-17 22:15:16 +01003998 && (reparseTag == IO_REPARSE_TAG_SYMLINK
3999 || reparseTag == IO_REPARSE_TAG_MOUNT_POINT))
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004000 res = TRUE;
4001
4002 return res;
4003}
4004
4005/*
4006 * Return TRUE if file "fname" has more than one link or if it is a symbolic
4007 * link.
4008 */
4009 int
4010mch_is_linked(char_u *fname)
4011{
4012 if (mch_is_hard_link(fname) || mch_is_symbolic_link(fname))
4013 return TRUE;
4014 return FALSE;
4015}
4016
4017/*
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02004018 * Get the by-handle-file-information for "fname".
4019 * Returns FILEINFO_OK when OK.
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004020 * Returns FILEINFO_ENC_FAIL when enc_to_utf16() failed.
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02004021 * Returns FILEINFO_READ_FAIL when CreateFile() failed.
4022 * Returns FILEINFO_INFO_FAIL when GetFileInformationByHandle() failed.
4023 */
4024 int
4025win32_fileinfo(char_u *fname, BY_HANDLE_FILE_INFORMATION *info)
4026{
Bram Moolenaar03f48552006-02-28 23:52:23 +00004027 HANDLE hFile;
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02004028 int res = FILEINFO_READ_FAIL;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004029 WCHAR *wn;
Bram Moolenaar03f48552006-02-28 23:52:23 +00004030
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004031 wn = enc_to_utf16(fname, NULL);
4032 if (wn == NULL)
4033 return FILEINFO_ENC_FAIL;
4034
4035 hFile = CreateFileW(wn, // file name
4036 GENERIC_READ, // access mode
4037 FILE_SHARE_READ | FILE_SHARE_WRITE, // share mode
4038 NULL, // security descriptor
4039 OPEN_EXISTING, // creation disposition
4040 FILE_FLAG_BACKUP_SEMANTICS, // file attributes
4041 NULL); // handle to template file
4042 vim_free(wn);
Bram Moolenaar03f48552006-02-28 23:52:23 +00004043
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004044 if (hFile == INVALID_HANDLE_VALUE)
4045 return FILEINFO_READ_FAIL;
4046
4047 if (GetFileInformationByHandle(hFile, info) != 0)
4048 res = FILEINFO_OK;
4049 else
4050 res = FILEINFO_INFO_FAIL;
4051 CloseHandle(hFile);
Bram Moolenaar03f48552006-02-28 23:52:23 +00004052
Bram Moolenaar03f48552006-02-28 23:52:23 +00004053 return res;
4054}
4055
4056/*
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004057 * get file attributes for `name'
4058 * -1 : error
4059 * else FILE_ATTRIBUTE_* defined in winnt.h
4060 */
Bram Moolenaarffa22202013-11-21 12:34:11 +01004061 static int
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004062win32_getattrs(char_u *name)
4063{
4064 int attr;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004065 WCHAR *p;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004066
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004067 p = enc_to_utf16(name, NULL);
4068 if (p == NULL)
4069 return INVALID_FILE_ATTRIBUTES;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004070
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004071 attr = GetFileAttributesW(p);
4072 vim_free(p);
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004073
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004074 return attr;
4075}
4076
4077/*
4078 * set file attributes for `name' to `attrs'
4079 *
4080 * return -1 for failure, 0 otherwise
4081 */
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02004082 static int
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004083win32_setattrs(char_u *name, int attrs)
4084{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004085 int res;
4086 WCHAR *p;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004087
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004088 p = enc_to_utf16(name, NULL);
4089 if (p == NULL)
4090 return -1;
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004091
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004092 res = SetFileAttributesW(p, attrs);
4093 vim_free(p);
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004094
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004095 return res ? 0 : -1;
4096}
4097
4098/*
4099 * Set archive flag for "name".
4100 */
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02004101 static int
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004102win32_set_archive(char_u *name)
4103{
4104 int attrs = win32_getattrs(name);
4105 if (attrs == -1)
4106 return -1;
4107
4108 attrs |= FILE_ATTRIBUTE_ARCHIVE;
4109 return win32_setattrs(name, attrs);
4110}
4111
4112/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 * Return TRUE if file or directory "name" is writable (not readonly).
4114 * Strange semantics of Win32: a readonly directory is writable, but you can't
4115 * delete a file. Let's say this means it is writable.
4116 */
4117 int
4118mch_writable(char_u *name)
4119{
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004120 int attrs = win32_getattrs(name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121
Bram Moolenaar12b559e2013-06-12 22:41:37 +02004122 return (attrs != -1 && (!(attrs & FILE_ATTRIBUTE_READONLY)
4123 || (attrs & FILE_ATTRIBUTE_DIRECTORY)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124}
4125
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126/*
Bram Moolenaar43663192017-03-05 14:29:12 +01004127 * Return TRUE if "name" can be executed, FALSE if not.
Bram Moolenaar77b77102015-03-21 22:18:41 +01004128 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar43663192017-03-05 14:29:12 +01004129 * When returning TRUE and "path" is not NULL save the path and set "*path" to
4130 * the allocated memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 */
4132 int
Yegappan Lakshmananebb01bd2022-06-08 15:14:09 +01004133mch_can_exe(char_u *name, char_u **path, int use_path UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134{
Bram Moolenaar95da1362020-05-30 18:37:55 +02004135 return executable_exists((char *)name, path, TRUE, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137
4138/*
4139 * Check what "name" is:
4140 * NODE_NORMAL: file or directory (or doesn't exist)
4141 * NODE_WRITABLE: writable device, socket, fifo, etc.
4142 * NODE_OTHER: non-writable things
4143 */
4144 int
4145mch_nodetype(char_u *name)
4146{
4147 HANDLE hFile;
4148 int type;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004149 WCHAR *wn;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150
Bram Moolenaar0f873732019-12-05 20:28:46 +01004151 // We can't open a file with a name "\\.\con" or "\\.\prn" and trying to
4152 // read from it later will cause Vim to hang. Thus return NODE_WRITABLE
4153 // here.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004154 if (STRNCMP(name, "\\\\.\\", 4) == 0)
4155 return NODE_WRITABLE;
4156
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004157 wn = enc_to_utf16(name, NULL);
4158 if (wn == NULL)
4159 return NODE_NORMAL;
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004160
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004161 hFile = CreateFileW(wn, // file name
4162 GENERIC_WRITE, // access mode
4163 0, // share mode
4164 NULL, // security descriptor
4165 OPEN_EXISTING, // creation disposition
4166 0, // file attributes
4167 NULL); // handle to template file
4168 vim_free(wn);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 if (hFile == INVALID_HANDLE_VALUE)
4170 return NODE_NORMAL;
4171
4172 type = GetFileType(hFile);
4173 CloseHandle(hFile);
4174 if (type == FILE_TYPE_CHAR)
4175 return NODE_WRITABLE;
4176 if (type == FILE_TYPE_DISK)
4177 return NODE_NORMAL;
4178 return NODE_OTHER;
4179}
4180
4181#ifdef HAVE_ACL
4182struct my_acl
4183{
4184 PSECURITY_DESCRIPTOR pSecurityDescriptor;
4185 PSID pSidOwner;
4186 PSID pSidGroup;
4187 PACL pDacl;
4188 PACL pSacl;
4189};
4190#endif
4191
4192/*
4193 * Return a pointer to the ACL of file "fname" in allocated memory.
4194 * Return NULL if the ACL is not available for whatever reason.
4195 */
4196 vim_acl_T
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004197mch_get_acl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198{
4199#ifndef HAVE_ACL
4200 return (vim_acl_T)NULL;
4201#else
4202 struct my_acl *p = NULL;
Bram Moolenaar27515922013-06-29 15:36:26 +02004203 DWORD err;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004205 p = ALLOC_CLEAR_ONE(struct my_acl);
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004206 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004208 WCHAR *wn;
Bram Moolenaar27515922013-06-29 15:36:26 +02004209
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004210 wn = enc_to_utf16(fname, NULL);
4211 if (wn == NULL)
Bram Moolenaarbbf9f342020-11-10 22:03:40 +01004212 {
4213 vim_free(p);
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004214 return NULL;
Bram Moolenaarbbf9f342020-11-10 22:03:40 +01004215 }
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004216
4217 // Try to retrieve the entire security descriptor.
4218 err = GetNamedSecurityInfoW(
4219 wn, // Abstract filename
4220 SE_FILE_OBJECT, // File Object
4221 OWNER_SECURITY_INFORMATION |
4222 GROUP_SECURITY_INFORMATION |
4223 DACL_SECURITY_INFORMATION |
4224 SACL_SECURITY_INFORMATION,
4225 &p->pSidOwner, // Ownership information.
4226 &p->pSidGroup, // Group membership.
4227 &p->pDacl, // Discretionary information.
4228 &p->pSacl, // For auditing purposes.
4229 &p->pSecurityDescriptor);
4230 if (err == ERROR_ACCESS_DENIED ||
4231 err == ERROR_PRIVILEGE_NOT_HELD)
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004232 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004233 // Retrieve only DACL.
4234 (void)GetNamedSecurityInfoW(
4235 wn,
4236 SE_FILE_OBJECT,
4237 DACL_SECURITY_INFORMATION,
4238 NULL,
4239 NULL,
4240 &p->pDacl,
4241 NULL,
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004242 &p->pSecurityDescriptor);
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004243 }
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004244 if (p->pSecurityDescriptor == NULL)
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004245 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004246 mch_free_acl((vim_acl_T)p);
4247 p = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 }
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004249 vim_free(wn);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 }
4251
4252 return (vim_acl_T)p;
4253#endif
4254}
4255
Bram Moolenaar27515922013-06-29 15:36:26 +02004256#ifdef HAVE_ACL
4257/*
4258 * Check if "acl" contains inherited ACE.
4259 */
4260 static BOOL
4261is_acl_inherited(PACL acl)
4262{
4263 DWORD i;
4264 ACL_SIZE_INFORMATION acl_info;
4265 PACCESS_ALLOWED_ACE ace;
4266
4267 acl_info.AceCount = 0;
4268 GetAclInformation(acl, &acl_info, sizeof(acl_info), AclSizeInformation);
4269 for (i = 0; i < acl_info.AceCount; i++)
4270 {
4271 GetAce(acl, i, (LPVOID *)&ace);
4272 if (ace->Header.AceFlags & INHERITED_ACE)
4273 return TRUE;
4274 }
4275 return FALSE;
4276}
4277#endif
4278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279/*
4280 * Set the ACL of file "fname" to "acl" (unless it's NULL).
4281 * Errors are ignored.
4282 * This must only be called with "acl" equal to what mch_get_acl() returned.
4283 */
4284 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004285mch_set_acl(char_u *fname, vim_acl_T acl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286{
4287#ifdef HAVE_ACL
4288 struct my_acl *p = (struct my_acl *)acl;
Bram Moolenaar27515922013-06-29 15:36:26 +02004289 SECURITY_INFORMATION sec_info = 0;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004290 WCHAR *wn;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004292 if (p == NULL)
4293 return;
4294
4295 wn = enc_to_utf16(fname, NULL);
4296 if (wn == NULL)
4297 return;
4298
4299 // Set security flags
4300 if (p->pSidOwner)
4301 sec_info |= OWNER_SECURITY_INFORMATION;
4302 if (p->pSidGroup)
4303 sec_info |= GROUP_SECURITY_INFORMATION;
4304 if (p->pDacl)
Bram Moolenaar27515922013-06-29 15:36:26 +02004305 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004306 sec_info |= DACL_SECURITY_INFORMATION;
4307 // Do not inherit its parent's DACL.
4308 // If the DACL is inherited, Cygwin permissions would be changed.
4309 if (!is_acl_inherited(p->pDacl))
4310 sec_info |= PROTECTED_DACL_SECURITY_INFORMATION;
Bram Moolenaar27515922013-06-29 15:36:26 +02004311 }
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004312 if (p->pSacl)
4313 sec_info |= SACL_SECURITY_INFORMATION;
4314
4315 (void)SetNamedSecurityInfoW(
4316 wn, // Abstract filename
4317 SE_FILE_OBJECT, // File Object
4318 sec_info,
4319 p->pSidOwner, // Ownership information.
4320 p->pSidGroup, // Group membership.
4321 p->pDacl, // Discretionary information.
4322 p->pSacl // For auditing purposes.
4323 );
4324 vim_free(wn);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325#endif
4326}
4327
4328 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004329mch_free_acl(vim_acl_T acl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330{
4331#ifdef HAVE_ACL
4332 struct my_acl *p = (struct my_acl *)acl;
4333
4334 if (p != NULL)
4335 {
4336 LocalFree(p->pSecurityDescriptor); // Free the memory just in case
4337 vim_free(p);
4338 }
4339#endif
4340}
4341
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004342#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343
4344/*
4345 * handler for ctrl-break, ctrl-c interrupts, and fatal events.
4346 */
4347 static BOOL WINAPI
4348handler_routine(
4349 DWORD dwCtrlType)
4350{
Bram Moolenaar589b1102017-08-12 16:39:05 +02004351 INPUT_RECORD ir;
4352 DWORD out;
4353
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 switch (dwCtrlType)
4355 {
4356 case CTRL_C_EVENT:
4357 if (ctrl_c_interrupts)
4358 g_fCtrlCPressed = TRUE;
4359 return TRUE;
4360
4361 case CTRL_BREAK_EVENT:
4362 g_fCBrkPressed = TRUE;
Bram Moolenaar589b1102017-08-12 16:39:05 +02004363 ctrl_break_was_pressed = TRUE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004364 // ReadConsoleInput is blocking, send a key event to continue.
Bram Moolenaar589b1102017-08-12 16:39:05 +02004365 ir.EventType = KEY_EVENT;
4366 ir.Event.KeyEvent.bKeyDown = TRUE;
4367 ir.Event.KeyEvent.wRepeatCount = 1;
4368 ir.Event.KeyEvent.wVirtualKeyCode = VK_CANCEL;
4369 ir.Event.KeyEvent.wVirtualScanCode = 0;
4370 ir.Event.KeyEvent.dwControlKeyState = 0;
4371 ir.Event.KeyEvent.uChar.UnicodeChar = 0;
4372 WriteConsoleInput(g_hConIn, &ir, 1, &out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 return TRUE;
4374
Bram Moolenaar0f873732019-12-05 20:28:46 +01004375 // fatal events: shut down gracefully
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 case CTRL_CLOSE_EVENT:
4377 case CTRL_LOGOFF_EVENT:
4378 case CTRL_SHUTDOWN_EVENT:
4379 windgoto((int)Rows - 1, 0);
4380 g_fForceExit = TRUE;
4381
Bram Moolenaar0fde2902008-03-16 13:54:13 +00004382 vim_snprintf((char *)IObuff, IOSIZE, _("Vim: Caught %s event\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 (dwCtrlType == CTRL_CLOSE_EVENT
4384 ? _("close")
4385 : dwCtrlType == CTRL_LOGOFF_EVENT
4386 ? _("logoff")
4387 : _("shutdown")));
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004388# ifdef DEBUG
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 OutputDebugString(IObuff);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004390# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391
Bram Moolenaar0f873732019-12-05 20:28:46 +01004392 preserve_exit(); // output IObuff, preserve files and exit
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393
Bram Moolenaar0f873732019-12-05 20:28:46 +01004394 return TRUE; // not reached
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395
4396 default:
4397 return FALSE;
4398 }
4399}
4400
4401
4402/*
4403 * set the tty in (raw) ? "raw" : "cooked" mode
4404 */
4405 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02004406mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407{
4408 DWORD cmodein;
4409 DWORD cmodeout;
4410 BOOL bEnableHandler;
4411
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004412# ifdef VIMDLL
4413 if (gui.in_use)
4414 return;
4415# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 GetConsoleMode(g_hConIn, &cmodein);
4417 GetConsoleMode(g_hConOut, &cmodeout);
4418 if (tmode == TMODE_RAW)
4419 {
4420 cmodein &= ~(ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT |
4421 ENABLE_ECHO_INPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 if (g_fMouseActive)
Wez Furlong6ef5ab52021-05-30 19:29:41 +02004423 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 cmodein |= ENABLE_MOUSE_INPUT;
Wez Furlong6ef5ab52021-05-30 19:29:41 +02004425 cmodein &= ~ENABLE_QUICK_EDIT_MODE;
4426 }
4427 else
4428 {
4429 cmodein |= g_cmodein & ENABLE_QUICK_EDIT_MODE;
4430 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004431 cmodeout &= ~(
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004432# ifdef FEAT_TERMGUICOLORS
Bram Moolenaar0f873732019-12-05 20:28:46 +01004433 // Do not turn off the ENABLE_PROCESSED_OUTPUT flag when using
4434 // VTP.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004435 ((vtp_working) ? 0 : ENABLE_PROCESSED_OUTPUT) |
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004436# else
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004437 ENABLE_PROCESSED_OUTPUT |
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004438# endif
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004439 ENABLE_WRAP_AT_EOL_OUTPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 bEnableHandler = TRUE;
4441 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004442 else // cooked
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 {
4444 cmodein |= (ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT |
4445 ENABLE_ECHO_INPUT);
4446 cmodeout |= (ENABLE_PROCESSED_OUTPUT | ENABLE_WRAP_AT_EOL_OUTPUT);
4447 bEnableHandler = FALSE;
4448 }
Wez Furlong6ef5ab52021-05-30 19:29:41 +02004449 SetConsoleMode(g_hConIn, cmodein | ENABLE_EXTENDED_FLAGS);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 SetConsoleMode(g_hConOut, cmodeout);
4451 SetConsoleCtrlHandler(handler_routine, bEnableHandler);
4452
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004453# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 if (fdDump)
4455 {
4456 fprintf(fdDump, "mch_settmode(%s, in = %x, out = %x)\n",
4457 tmode == TMODE_RAW ? "raw" :
4458 tmode == TMODE_COOK ? "cooked" : "normal",
4459 cmodein, cmodeout);
4460 fflush(fdDump);
4461 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004462# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463}
4464
4465
4466/*
4467 * Get the size of the current window in `Rows' and `Columns'
4468 * Return OK when size could be determined, FAIL otherwise.
4469 */
4470 int
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004471mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472{
4473 CONSOLE_SCREEN_BUFFER_INFO csbi;
4474
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004475# ifdef VIMDLL
4476 if (gui.in_use)
4477 return OK;
4478# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 if (!g_fTermcapMode && g_cbTermcap.IsValid)
4480 {
4481 /*
4482 * For some reason, we are trying to get the screen dimensions
4483 * even though we are not in termcap mode. The 'Rows' and 'Columns'
4484 * variables are really intended to mean the size of Vim screen
4485 * while in termcap mode.
4486 */
4487 Rows = g_cbTermcap.Info.dwSize.Y;
4488 Columns = g_cbTermcap.Info.dwSize.X;
4489 }
4490 else if (GetConsoleScreenBufferInfo(g_hConOut, &csbi))
4491 {
4492 Rows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
4493 Columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
4494 }
4495 else
4496 {
4497 Rows = 25;
4498 Columns = 80;
4499 }
4500 return OK;
4501}
4502
4503/*
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004504 * Resize console buffer to 'COORD'
4505 */
4506 static void
4507ResizeConBuf(
4508 HANDLE hConsole,
4509 COORD coordScreen)
4510{
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00004511 if (use_alternate_screen_buffer)
4512 return;
4513
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004514 if (!SetConsoleScreenBufferSize(hConsole, coordScreen))
4515 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004516# ifdef MCH_WRITE_DUMP
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004517 if (fdDump)
4518 {
4519 fprintf(fdDump, "SetConsoleScreenBufferSize failed: %lx\n",
4520 GetLastError());
4521 fflush(fdDump);
4522 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004523# endif
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004524 }
4525}
4526
4527/*
4528 * Resize console window size to 'srWindowRect'
4529 */
4530 static void
4531ResizeWindow(
4532 HANDLE hConsole,
4533 SMALL_RECT srWindowRect)
4534{
4535 if (!SetConsoleWindowInfo(hConsole, TRUE, &srWindowRect))
4536 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004537# ifdef MCH_WRITE_DUMP
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004538 if (fdDump)
4539 {
4540 fprintf(fdDump, "SetConsoleWindowInfo failed: %lx\n",
4541 GetLastError());
4542 fflush(fdDump);
4543 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004544# endif
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004545 }
4546}
4547
4548/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 * Set a console window to `xSize' * `ySize'
4550 */
4551 static void
4552ResizeConBufAndWindow(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004553 HANDLE hConsole,
4554 int xSize,
4555 int ySize)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004557 CONSOLE_SCREEN_BUFFER_INFO csbi; // hold current console buffer info
4558 SMALL_RECT srWindowRect; // hold the new console size
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 COORD coordScreen;
Bram Moolenaarf49a6922019-07-15 20:37:05 +02004560 COORD cursor;
Bram Moolenaar2551c032018-08-23 22:38:31 +02004561 static int resized = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004563# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 if (fdDump)
4565 {
4566 fprintf(fdDump, "ResizeConBufAndWindow(%d, %d)\n", xSize, ySize);
4567 fflush(fdDump);
4568 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004569# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
Bram Moolenaar0f873732019-12-05 20:28:46 +01004571 // get the largest size we can size the console window to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 coordScreen = GetLargestConsoleWindowSize(hConsole);
4573
Bram Moolenaar0f873732019-12-05 20:28:46 +01004574 // define the new console window size and scroll position
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 srWindowRect.Left = srWindowRect.Top = (SHORT) 0;
4576 srWindowRect.Right = (SHORT) (min(xSize, coordScreen.X) - 1);
4577 srWindowRect.Bottom = (SHORT) (min(ySize, coordScreen.Y) - 1);
4578
4579 if (GetConsoleScreenBufferInfo(g_hConOut, &csbi))
4580 {
4581 int sx, sy;
4582
4583 sx = csbi.srWindow.Right - csbi.srWindow.Left + 1;
4584 sy = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
4585 if (sy < ySize || sx < xSize)
4586 {
4587 /*
4588 * Increasing number of lines/columns, do buffer first.
4589 * Use the maximal size in x and y direction.
4590 */
4591 if (sy < ySize)
4592 coordScreen.Y = ySize;
4593 else
4594 coordScreen.Y = sy;
4595 if (sx < xSize)
4596 coordScreen.X = xSize;
4597 else
4598 coordScreen.X = sx;
4599 SetConsoleScreenBufferSize(hConsole, coordScreen);
4600 }
4601 }
4602
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004603 // define the new console buffer size
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 coordScreen.X = xSize;
4605 coordScreen.Y = ySize;
4606
Bram Moolenaar2551c032018-08-23 22:38:31 +02004607 // In the new console call API, only the first time in reverse order
4608 if (!vtp_working || resized)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 {
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004610 ResizeWindow(hConsole, srWindowRect);
4611 ResizeConBuf(hConsole, coordScreen);
4612 }
4613 else
4614 {
Bram Moolenaarf49a6922019-07-15 20:37:05 +02004615 // Workaround for a Windows 10 bug
4616 cursor.X = srWindowRect.Left;
4617 cursor.Y = srWindowRect.Top;
4618 SetConsoleCursorPosition(hConsole, cursor);
4619
Bram Moolenaarb1cf1612018-08-07 20:47:16 +02004620 ResizeConBuf(hConsole, coordScreen);
4621 ResizeWindow(hConsole, srWindowRect);
Bram Moolenaar2551c032018-08-23 22:38:31 +02004622 resized = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 }
4624}
4625
4626
4627/*
4628 * Set the console window to `Rows' * `Columns'
4629 */
4630 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004631mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632{
4633 COORD coordScreen;
4634
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004635# ifdef VIMDLL
4636 if (gui.in_use)
4637 return;
4638# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004639 // Don't change window size while still starting up
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 if (suppress_winsize != 0)
4641 {
4642 suppress_winsize = 2;
4643 return;
4644 }
4645
4646 if (term_console)
4647 {
4648 coordScreen = GetLargestConsoleWindowSize(g_hConOut);
4649
Bram Moolenaar0f873732019-12-05 20:28:46 +01004650 // Clamp Rows and Columns to reasonable values
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 if (Rows > coordScreen.Y)
4652 Rows = coordScreen.Y;
4653 if (Columns > coordScreen.X)
4654 Columns = coordScreen.X;
4655
4656 ResizeConBufAndWindow(g_hConOut, Columns, Rows);
4657 }
4658}
4659
4660/*
4661 * Rows and/or Columns has changed.
4662 */
4663 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004664mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665{
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004666# ifdef VIMDLL
4667 if (gui.in_use)
4668 return;
4669# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 set_scroll_region(0, 0, Columns - 1, Rows - 1);
4671}
4672
4673
4674/*
4675 * Called when started up, to set the winsize that was delayed.
4676 */
4677 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00004678mch_set_winsize_now(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679{
4680 if (suppress_winsize == 2)
4681 {
4682 suppress_winsize = 0;
4683 mch_set_shellsize();
4684 shell_resized();
4685 }
4686 suppress_winsize = 0;
4687}
Bram Moolenaar0f873732019-12-05 20:28:46 +01004688#endif // FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004690 static BOOL
4691vim_create_process(
Bram Moolenaar36c85b22013-12-12 20:25:44 +01004692 char *cmd,
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004693 BOOL inherit_handles,
Bram Moolenaar3f1138e2014-01-05 13:29:26 +01004694 DWORD flags,
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004695 STARTUPINFO *si,
Bram Moolenaar05aafed2017-08-11 19:12:11 +02004696 PROCESS_INFORMATION *pi,
4697 LPVOID *env,
4698 char *cwd)
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004699{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004700 BOOL ret = FALSE;
4701 WCHAR *wcmd, *wcwd = NULL;
4702
4703 wcmd = enc_to_utf16((char_u *)cmd, NULL);
4704 if (wcmd == NULL)
4705 return FALSE;
4706 if (cwd != NULL)
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004707 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004708 wcwd = enc_to_utf16((char_u *)cwd, NULL);
4709 if (wcwd == NULL)
4710 goto theend;
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004711 }
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004712
4713 ret = CreateProcessW(
4714 NULL, // Executable name
4715 wcmd, // Command to execute
4716 NULL, // Process security attributes
4717 NULL, // Thread security attributes
4718 inherit_handles, // Inherit handles
4719 flags, // Creation flags
4720 env, // Environment
4721 wcwd, // Current directory
4722 (LPSTARTUPINFOW)si, // Startup information
4723 pi); // Process information
4724theend:
4725 vim_free(wcmd);
4726 vim_free(wcwd);
4727 return ret;
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004728}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729
4730
Bram Moolenaarb2964f22017-03-21 19:29:26 +01004731 static HINSTANCE
4732vim_shell_execute(
4733 char *cmd,
4734 INT n_show_cmd)
4735{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02004736 HINSTANCE ret;
4737 WCHAR *wcmd;
4738
4739 wcmd = enc_to_utf16((char_u *)cmd, NULL);
4740 if (wcmd == NULL)
4741 return (HINSTANCE) 0;
4742
4743 ret = ShellExecuteW(NULL, NULL, wcmd, NULL, NULL, n_show_cmd);
4744 vim_free(wcmd);
4745 return ret;
Bram Moolenaarb2964f22017-03-21 19:29:26 +01004746}
4747
4748
Bram Moolenaar4f974752019-02-17 17:44:42 +01004749#if defined(FEAT_GUI_MSWIN) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
4751/*
4752 * Specialised version of system() for Win32 GUI mode.
4753 * This version proceeds as follows:
4754 * 1. Create a console window for use by the subprocess
4755 * 2. Run the subprocess (it gets the allocated console by default)
4756 * 3. Wait for the subprocess to terminate and get its exit code
4757 * 4. Prompt the user to press a key to close the console window
4758 */
4759 static int
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004760mch_system_classic(char *cmd, int options)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761{
4762 STARTUPINFO si;
4763 PROCESS_INFORMATION pi;
4764 DWORD ret = 0;
4765 HWND hwnd = GetFocus();
4766
4767 si.cb = sizeof(si);
4768 si.lpReserved = NULL;
4769 si.lpDesktop = NULL;
4770 si.lpTitle = NULL;
4771 si.dwFlags = STARTF_USESHOWWINDOW;
4772 /*
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004773 * It's nicer to run a filter command in a minimized window.
Bram Moolenaar96e5cee2010-11-24 12:35:21 +01004774 * Don't activate the window to keep focus on Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 */
Bram Moolenaarcea912a2016-10-12 14:20:24 +02004776 if (options & SHELL_DOOUT)
Bram Moolenaar96e5cee2010-11-24 12:35:21 +01004777 si.wShowWindow = SW_SHOWMINNOACTIVE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 else
4779 si.wShowWindow = SW_SHOWNORMAL;
4780 si.cbReserved2 = 0;
4781 si.lpReserved2 = NULL;
4782
Bram Moolenaar0f873732019-12-05 20:28:46 +01004783 // Now, run the command
Bram Moolenaar910cffb2013-12-11 17:58:35 +01004784 vim_create_process(cmd, FALSE,
Bram Moolenaar05aafed2017-08-11 19:12:11 +02004785 CREATE_DEFAULT_ERROR_MODE | CREATE_NEW_CONSOLE,
4786 &si, &pi, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
Bram Moolenaar0f873732019-12-05 20:28:46 +01004788 // Wait for the command to terminate before continuing
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004790# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 int delay = 1;
4792
Bram Moolenaar0f873732019-12-05 20:28:46 +01004793 // Keep updating the window while waiting for the shell to finish.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 for (;;)
4795 {
4796 MSG msg;
4797
K.Takatab7057bd2022-01-21 11:37:07 +00004798 if (PeekMessageW(&msg, (HWND)NULL, 0, 0, PM_REMOVE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 {
4800 TranslateMessage(&msg);
K.Takatab7057bd2022-01-21 11:37:07 +00004801 DispatchMessageW(&msg);
Bram Moolenaare4195c52012-08-02 12:31:44 +02004802 delay = 1;
4803 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 }
4805 if (WaitForSingleObject(pi.hProcess, delay) != WAIT_TIMEOUT)
4806 break;
4807
Bram Moolenaar0f873732019-12-05 20:28:46 +01004808 // We start waiting for a very short time and then increase it, so
4809 // that we respond quickly when the process is quick, and don't
4810 // consume too much overhead when it's slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 if (delay < 50)
4812 delay += 10;
4813 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004814# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 WaitForSingleObject(pi.hProcess, INFINITE);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01004816# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817
Bram Moolenaar0f873732019-12-05 20:28:46 +01004818 // Get the command exit code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 GetExitCodeProcess(pi.hProcess, &ret);
4820 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821
Bram Moolenaar0f873732019-12-05 20:28:46 +01004822 // Close the handles to the subprocess, so that it goes away
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 CloseHandle(pi.hThread);
4824 CloseHandle(pi.hProcess);
4825
Bram Moolenaar0f873732019-12-05 20:28:46 +01004826 // Try to get input focus back. Doesn't always work though.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 PostMessage(hwnd, WM_SETFOCUS, 0, 0);
4828
4829 return ret;
4830}
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004831
4832/*
4833 * Thread launched by the gui to send the current buffer data to the
4834 * process. This way avoid to hang up vim totally if the children
4835 * process take a long time to process the lines.
4836 */
Bram Moolenaar4c38d662016-08-03 20:54:57 +02004837 static unsigned int __stdcall
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004838sub_process_writer(LPVOID param)
4839{
4840 HANDLE g_hChildStd_IN_Wr = param;
4841 linenr_T lnum = curbuf->b_op_start.lnum;
4842 DWORD len = 0;
4843 DWORD l;
4844 char_u *lp = ml_get(lnum);
4845 char_u *s;
4846 int written = 0;
4847
4848 for (;;)
4849 {
4850 l = (DWORD)STRLEN(lp + written);
4851 if (l == 0)
4852 len = 0;
4853 else if (lp[written] == NL)
4854 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004855 // NL -> NUL translation
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004856 WriteFile(g_hChildStd_IN_Wr, "", 1, &len, NULL);
4857 }
4858 else
4859 {
4860 s = vim_strchr(lp + written, NL);
4861 WriteFile(g_hChildStd_IN_Wr, (char *)lp + written,
4862 s == NULL ? l : (DWORD)(s - (lp + written)),
4863 &len, NULL);
4864 }
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +01004865 if (len == l)
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004866 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004867 // Finished a line, add a NL, unless this line should not have
4868 // one.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004869 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02004870 || (!curbuf->b_p_bin
4871 && curbuf->b_p_fixeol)
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004872 || (lnum != curbuf->b_no_eol_lnum
4873 && (lnum != curbuf->b_ml.ml_line_count
4874 || curbuf->b_p_eol)))
4875 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02004876 WriteFile(g_hChildStd_IN_Wr, "\n", 1,
4877 (LPDWORD)&vim_ignored, NULL);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004878 }
4879
4880 ++lnum;
4881 if (lnum > curbuf->b_op_end.lnum)
4882 break;
4883
4884 lp = ml_get(lnum);
4885 written = 0;
4886 }
4887 else if (len > 0)
4888 written += len;
4889 }
4890
Bram Moolenaar0f873732019-12-05 20:28:46 +01004891 // finished all the lines, close pipe
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004892 CloseHandle(g_hChildStd_IN_Wr);
Bram Moolenaar86f2cd52016-08-02 21:55:17 +02004893 return 0;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004894}
4895
4896
Bram Moolenaar0f873732019-12-05 20:28:46 +01004897# define BUFLEN 100 // length for buffer, stolen from unix version
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004898
4899/*
4900 * This function read from the children's stdout and write the
4901 * data on screen or in the buffer accordingly.
4902 */
4903 static void
4904dump_pipe(int options,
4905 HANDLE g_hChildStd_OUT_Rd,
4906 garray_T *ga,
4907 char_u buffer[],
4908 DWORD *buffer_off)
4909{
4910 DWORD availableBytes = 0;
4911 DWORD i;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004912 int ret;
4913 DWORD len;
4914 DWORD toRead;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004915
Bram Moolenaar0f873732019-12-05 20:28:46 +01004916 // we query the pipe to see if there is any data to read
4917 // to avoid to perform a blocking read
4918 ret = PeekNamedPipe(g_hChildStd_OUT_Rd, // pipe to query
4919 NULL, // optional buffer
4920 0, // buffer size
4921 NULL, // number of read bytes
4922 &availableBytes, // available bytes total
4923 NULL); // byteLeft
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004924
Bram Moolenaar0f873732019-12-05 20:28:46 +01004925 // We got real data in the pipe, read it
Bram Moolenaarf6a2b082012-06-29 13:14:03 +02004926 while (ret != 0 && availableBytes > 0)
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004927 {
Bram Moolenaara12a1612019-01-24 16:39:02 +01004928 toRead = (DWORD)(BUFLEN - *buffer_off);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004929 toRead = availableBytes < toRead ? availableBytes : toRead;
Bram Moolenaara12a1612019-01-24 16:39:02 +01004930 ReadFile(g_hChildStd_OUT_Rd, buffer + *buffer_off, toRead , &len, NULL);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004931
Bram Moolenaar0f873732019-12-05 20:28:46 +01004932 // If we haven't read anything, there is a problem
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004933 if (len == 0)
4934 break;
4935
4936 availableBytes -= len;
4937
4938 if (options & SHELL_READ)
4939 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004940 // Do NUL -> NL translation, append NL separated
4941 // lines to the current buffer.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004942 for (i = 0; i < len; ++i)
4943 {
4944 if (buffer[i] == NL)
4945 append_ga_line(ga);
4946 else if (buffer[i] == NUL)
4947 ga_append(ga, NL);
4948 else
4949 ga_append(ga, buffer[i]);
4950 }
4951 }
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004952 else if (has_mbyte)
4953 {
4954 int l;
Bram Moolenaar2eba1822011-08-27 15:10:04 +02004955 int c;
4956 char_u *p;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004957
4958 len += *buffer_off;
4959 buffer[len] = NUL;
4960
Bram Moolenaar0f873732019-12-05 20:28:46 +01004961 // Check if the last character in buffer[] is
4962 // incomplete, keep these bytes for the next
4963 // round.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004964 for (p = buffer; p < buffer + len; p += l)
4965 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02004966 l = MB_CPTR2LEN(p);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004967 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004968 l = 1; // NUL byte?
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004969 else if (MB_BYTE2LEN(*p) != l)
4970 break;
4971 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004972 if (p == buffer) // no complete character
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004973 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004974 // avoid getting stuck at an illegal byte
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004975 if (len >= 12)
4976 ++p;
4977 else
4978 {
4979 *buffer_off = len;
4980 return;
4981 }
4982 }
4983 c = *p;
4984 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01004985 msg_puts((char *)buffer);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004986 if (p < buffer + len)
4987 {
4988 *p = c;
4989 *buffer_off = (DWORD)((buffer + len) - p);
4990 mch_memmove(buffer, p, *buffer_off);
4991 return;
4992 }
4993 *buffer_off = 0;
4994 }
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004995 else
4996 {
4997 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01004998 msg_puts((char *)buffer);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02004999 }
5000
5001 windgoto(msg_row, msg_col);
5002 cursor_on();
5003 out_flush();
5004 }
5005}
5006
5007/*
5008 * Version of system to use for windows NT > 5.0 (Win2K), use pipe
5009 * for communication and doesn't open any new window.
5010 */
5011 static int
5012mch_system_piped(char *cmd, int options)
5013{
5014 STARTUPINFO si;
5015 PROCESS_INFORMATION pi;
5016 DWORD ret = 0;
5017
5018 HANDLE g_hChildStd_IN_Rd = NULL;
5019 HANDLE g_hChildStd_IN_Wr = NULL;
5020 HANDLE g_hChildStd_OUT_Rd = NULL;
5021 HANDLE g_hChildStd_OUT_Wr = NULL;
5022
Bram Moolenaar0f873732019-12-05 20:28:46 +01005023 char_u buffer[BUFLEN + 1]; // reading buffer + size
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005024 DWORD len;
5025
Bram Moolenaar0f873732019-12-05 20:28:46 +01005026 // buffer used to receive keys
5027 char_u ta_buf[BUFLEN + 1]; // TypeAHead
5028 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005029
5030 DWORD i;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005031 int noread_cnt = 0;
5032 garray_T ga;
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005033 int delay = 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005034 DWORD buffer_off = 0; // valid bytes in buffer[]
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005035 char *p = NULL;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005036
5037 SECURITY_ATTRIBUTES saAttr;
5038
Bram Moolenaar0f873732019-12-05 20:28:46 +01005039 // Set the bInheritHandle flag so pipe handles are inherited.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005040 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
5041 saAttr.bInheritHandle = TRUE;
5042 saAttr.lpSecurityDescriptor = NULL;
5043
5044 if ( ! CreatePipe(&g_hChildStd_OUT_Rd, &g_hChildStd_OUT_Wr, &saAttr, 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005045 // Ensure the read handle to the pipe for STDOUT is not inherited.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02005046 || ! SetHandleInformation(g_hChildStd_OUT_Rd, HANDLE_FLAG_INHERIT, 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005047 // Create a pipe for the child process's STDIN.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005048 || ! CreatePipe(&g_hChildStd_IN_Rd, &g_hChildStd_IN_Wr, &saAttr, 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005049 // Ensure the write handle to the pipe for STDIN is not inherited.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02005050 || ! SetHandleInformation(g_hChildStd_IN_Wr, HANDLE_FLAG_INHERIT, 0) )
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005051 {
5052 CloseHandle(g_hChildStd_IN_Rd);
5053 CloseHandle(g_hChildStd_IN_Wr);
5054 CloseHandle(g_hChildStd_OUT_Rd);
5055 CloseHandle(g_hChildStd_OUT_Wr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01005056 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005057 }
5058
5059 si.cb = sizeof(si);
5060 si.lpReserved = NULL;
5061 si.lpDesktop = NULL;
5062 si.lpTitle = NULL;
5063 si.dwFlags = STARTF_USESHOWWINDOW | STARTF_USESTDHANDLES;
5064
Bram Moolenaar0f873732019-12-05 20:28:46 +01005065 // set-up our file redirection
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005066 si.hStdError = g_hChildStd_OUT_Wr;
5067 si.hStdOutput = g_hChildStd_OUT_Wr;
5068 si.hStdInput = g_hChildStd_IN_Rd;
5069 si.wShowWindow = SW_HIDE;
5070 si.cbReserved2 = 0;
5071 si.lpReserved2 = NULL;
5072
5073 if (options & SHELL_READ)
5074 ga_init2(&ga, 1, BUFLEN);
5075
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005076 if (cmd != NULL)
5077 {
5078 p = (char *)vim_strsave((char_u *)cmd);
5079 if (p != NULL)
5080 unescape_shellxquote((char_u *)p, p_sxe);
5081 else
5082 p = cmd;
5083 }
5084
Bram Moolenaar0f873732019-12-05 20:28:46 +01005085 // Now, run the command.
5086 // About "Inherit handles" being TRUE: this command can be litigious,
5087 // handle inheritance was deactivated for pending temp file, but, if we
5088 // deactivate it, the pipes don't work for some reason.
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005089 vim_create_process(p, TRUE, CREATE_DEFAULT_ERROR_MODE,
5090 &si, &pi, NULL, NULL);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005091
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005092 if (p != cmd)
5093 vim_free(p);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005094
Bram Moolenaar0f873732019-12-05 20:28:46 +01005095 // Close our unused side of the pipes
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005096 CloseHandle(g_hChildStd_IN_Rd);
5097 CloseHandle(g_hChildStd_OUT_Wr);
5098
5099 if (options & SHELL_WRITE)
5100 {
Bram Moolenaar86f2cd52016-08-02 21:55:17 +02005101 HANDLE thread = (HANDLE)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005102 _beginthreadex(NULL, // security attributes
5103 0, // default stack size
5104 sub_process_writer, // function to be executed
5105 g_hChildStd_IN_Wr, // parameter
5106 0, // creation flag, start immediately
5107 NULL); // we don't care about thread id
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005108 CloseHandle(thread);
5109 g_hChildStd_IN_Wr = NULL;
5110 }
5111
Bram Moolenaar0f873732019-12-05 20:28:46 +01005112 // Keep updating the window while waiting for the shell to finish.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005113 for (;;)
5114 {
5115 MSG msg;
5116
K.Takatab7057bd2022-01-21 11:37:07 +00005117 if (PeekMessageW(&msg, (HWND)NULL, 0, 0, PM_REMOVE))
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005118 {
5119 TranslateMessage(&msg);
K.Takatab7057bd2022-01-21 11:37:07 +00005120 DispatchMessageW(&msg);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005121 }
5122
Bram Moolenaar0f873732019-12-05 20:28:46 +01005123 // write pipe information in the window
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005124 if ((options & (SHELL_READ|SHELL_WRITE))
5125# ifdef FEAT_GUI
5126 || gui.in_use
5127# endif
5128 )
5129 {
5130 len = 0;
GuyBrush52ecc762024-02-21 20:16:38 +01005131 if (((options &
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005132 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5133 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
5134# ifdef FEAT_GUI
5135 || gui.in_use
5136# endif
5137 )
5138 && (ta_len > 0 || noread_cnt > 4))
5139 {
5140 if (ta_len == 0)
5141 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005142 // Get extra characters when we don't have any. Reset the
5143 // counter and timer.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005144 noread_cnt = 0;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005145 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5146 }
5147 if (ta_len > 0 || len > 0)
5148 {
5149 /*
5150 * For pipes: Check for CTRL-C: send interrupt signal to
GuyBrush1f13fcc2024-01-14 20:08:40 +01005151 * child.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005152 */
5153 if (len == 1 && cmd != NULL)
5154 {
5155 if (ta_buf[ta_len] == Ctrl_C)
5156 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005157 // Learn what exit code is expected, for
5158 // now put 9 as SIGKILL
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005159 TerminateProcess(pi.hProcess, 9);
5160 }
GuyBrush1f13fcc2024-01-14 20:08:40 +01005161 }
5162
5163 /*
5164 * Check for CTRL-D: EOF, close pipe to child.
5165 * Ctrl_D may be decorated by _OnChar()
5166 */
5167 if ((len == 1 || len == 4 ) && cmd != NULL)
5168 {
5169 if (ta_buf[0] == Ctrl_D
5170 || (ta_buf[0] == CSI
5171 && ta_buf[1] == KS_MODIFIER
5172 && ta_buf[3] == Ctrl_D))
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005173 {
5174 CloseHandle(g_hChildStd_IN_Wr);
5175 g_hChildStd_IN_Wr = NULL;
GuyBrush1f13fcc2024-01-14 20:08:40 +01005176 len = 0;
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005177 }
5178 }
5179
Bram Moolenaar2f7e1b82022-10-04 13:17:31 +01005180 len = term_replace_keycodes(ta_buf, ta_len, len);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005181
5182 /*
5183 * For pipes: echo the typed characters. For a pty this
5184 * does not seem to work.
5185 */
5186 for (i = ta_len; i < ta_len + len; ++i)
5187 {
5188 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5189 msg_putchar(ta_buf[i]);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005190 else if (has_mbyte)
5191 {
5192 int l = (*mb_ptr2len)(ta_buf + i);
5193
5194 msg_outtrans_len(ta_buf + i, l);
5195 i += l - 1;
5196 }
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005197 else
5198 msg_outtrans_len(ta_buf + i, 1);
5199 }
5200 windgoto(msg_row, msg_col);
5201 out_flush();
5202
5203 ta_len += len;
5204
5205 /*
5206 * Write the characters to the child, unless EOF has been
5207 * typed for pipes. Write one character at a time, to
5208 * avoid losing too much typeahead. When writing buffer
5209 * lines, drop the typed characters (only check for
5210 * CTRL-C).
5211 */
5212 if (options & SHELL_WRITE)
5213 ta_len = 0;
5214 else if (g_hChildStd_IN_Wr != NULL)
5215 {
5216 WriteFile(g_hChildStd_IN_Wr, (char*)ta_buf,
5217 1, &len, NULL);
5218 // if we are typing in, we want to keep things reactive
5219 delay = 1;
5220 if (len > 0)
5221 {
5222 ta_len -= len;
5223 mch_memmove(ta_buf, ta_buf + len, ta_len);
5224 }
5225 }
5226 }
5227 }
5228 }
5229
5230 if (ta_len)
5231 ui_inchar_undo(ta_buf, ta_len);
5232
5233 if (WaitForSingleObject(pi.hProcess, delay) != WAIT_TIMEOUT)
5234 {
Bram Moolenaar2eba1822011-08-27 15:10:04 +02005235 dump_pipe(options, g_hChildStd_OUT_Rd, &ga, buffer, &buffer_off);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005236 break;
5237 }
5238
5239 ++noread_cnt;
Bram Moolenaar2eba1822011-08-27 15:10:04 +02005240 dump_pipe(options, g_hChildStd_OUT_Rd, &ga, buffer, &buffer_off);
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005241
Bram Moolenaar0f873732019-12-05 20:28:46 +01005242 // We start waiting for a very short time and then increase it, so
5243 // that we respond quickly when the process is quick, and don't
5244 // consume too much overhead when it's slow.
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005245 if (delay < 50)
5246 delay += 10;
5247 }
5248
Bram Moolenaar0f873732019-12-05 20:28:46 +01005249 // Close the pipe
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005250 CloseHandle(g_hChildStd_OUT_Rd);
5251 if (g_hChildStd_IN_Wr != NULL)
5252 CloseHandle(g_hChildStd_IN_Wr);
5253
5254 WaitForSingleObject(pi.hProcess, INFINITE);
5255
Bram Moolenaar0f873732019-12-05 20:28:46 +01005256 // Get the command exit code
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005257 GetExitCodeProcess(pi.hProcess, &ret);
5258
5259 if (options & SHELL_READ)
5260 {
5261 if (ga.ga_len > 0)
5262 {
5263 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005264 // remember that the NL was missing
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005265 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
5266 }
5267 else
5268 curbuf->b_no_eol_lnum = 0;
5269 ga_clear(&ga);
5270 }
5271
Bram Moolenaar0f873732019-12-05 20:28:46 +01005272 // Close the handles to the subprocess, so that it goes away
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005273 CloseHandle(pi.hThread);
5274 CloseHandle(pi.hProcess);
5275
5276 return ret;
5277}
5278
5279 static int
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005280mch_system_g(char *cmd, int options)
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005281{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005282 // if we can pipe and the shelltemp option is off
Bram Moolenaarcea912a2016-10-12 14:20:24 +02005283 if (!p_stmp)
Bram Moolenaar4b9669f2011-07-07 16:20:52 +02005284 return mch_system_piped(cmd, options);
5285 else
5286 return mch_system_classic(cmd, options);
5287}
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005288#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005290#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar910cffb2013-12-11 17:58:35 +01005291 static int
Bram Moolenaarbd67aac2019-09-21 23:09:04 +02005292mch_system_c(char *cmd, int options UNUSED)
Bram Moolenaar910cffb2013-12-11 17:58:35 +01005293{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005294 int ret;
5295 WCHAR *wcmd;
Bram Moolenaar2efc44b2019-10-05 12:09:32 +02005296 char_u *buf;
5297 size_t len;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005298
Bram Moolenaar2efc44b2019-10-05 12:09:32 +02005299 // If the command starts and ends with double quotes, enclose the command
5300 // in parentheses.
5301 len = STRLEN(cmd);
5302 if (len >= 2 && cmd[0] == '"' && cmd[len - 1] == '"')
5303 {
5304 len += 3;
5305 buf = alloc(len);
5306 if (buf == NULL)
5307 return -1;
5308 vim_snprintf((char *)buf, len, "(%s)", cmd);
5309 wcmd = enc_to_utf16(buf, NULL);
5310 free(buf);
5311 }
5312 else
5313 wcmd = enc_to_utf16((char_u *)cmd, NULL);
5314
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005315 if (wcmd == NULL)
5316 return -1;
5317
5318 ret = _wsystem(wcmd);
5319 vim_free(wcmd);
5320 return ret;
Bram Moolenaar910cffb2013-12-11 17:58:35 +01005321}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
5323#endif
5324
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005325 static int
5326mch_system(char *cmd, int options)
5327{
5328#ifdef VIMDLL
Bram Moolenaar294d9bf2019-05-23 20:12:46 +02005329 if (gui.in_use || gui.starting)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005330 return mch_system_g(cmd, options);
5331 else
5332 return mch_system_c(cmd, options);
5333#elif defined(FEAT_GUI_MSWIN)
5334 return mch_system_g(cmd, options);
5335#else
5336 return mch_system_c(cmd, options);
5337#endif
5338}
5339
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005340#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
5341/*
5342 * Use a terminal window to run a shell command in.
5343 */
5344 static int
5345mch_call_shell_terminal(
5346 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005347 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005348{
5349 jobopt_T opt;
5350 char_u *newcmd = NULL;
5351 typval_T argvar[2];
5352 long_u cmdlen;
5353 int retval = -1;
5354 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02005355 job_T *job;
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005356 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005357 oparg_T oa; // operator arguments
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005358
Bram Moolenaar42f652f2018-03-19 21:44:37 +01005359 if (cmd == NULL)
5360 cmdlen = STRLEN(p_sh) + 1;
5361 else
5362 cmdlen = STRLEN(p_sh) + STRLEN(p_shcf) + STRLEN(cmd) + 10;
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02005363 newcmd = alloc(cmdlen);
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005364 if (newcmd == NULL)
5365 return 255;
Bram Moolenaar42f652f2018-03-19 21:44:37 +01005366 if (cmd == NULL)
5367 {
5368 STRCPY(newcmd, p_sh);
5369 ch_log(NULL, "starting terminal to run a shell");
5370 }
5371 else
5372 {
5373 vim_snprintf((char *)newcmd, cmdlen, "%s %s %s", p_sh, p_shcf, cmd);
5374 ch_log(NULL, "starting terminal for system command '%s'", cmd);
5375 }
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005376
5377 init_job_options(&opt);
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005378
5379 argvar[0].v_type = VAR_STRING;
5380 argvar[0].vval.v_string = newcmd;
5381 argvar[1].v_type = VAR_UNKNOWN;
5382 buf = term_start(argvar, NULL, &opt, TERM_START_SYSTEM);
Bram Moolenaar81c3c89a2018-03-20 11:41:44 +01005383 if (buf == NULL)
Bram Moolenaar9029b912019-03-21 19:58:00 +01005384 {
5385 vim_free(newcmd);
Bram Moolenaar81c3c89a2018-03-20 11:41:44 +01005386 return 255;
Bram Moolenaar9029b912019-03-21 19:58:00 +01005387 }
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005388
Bram Moolenaarf9c38832018-06-19 19:59:20 +02005389 job = term_getjob(buf->b_term);
5390 ++job->jv_refcount;
5391
Bram Moolenaar0f873732019-12-05 20:28:46 +01005392 // Find a window to make "buf" curbuf.
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005393 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00005394 if (curbuf == buf)
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005395 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00005396 // Only do this when a window was found for "buf".
5397 clear_oparg(&oa);
5398 while (term_use_loop())
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005399 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00005400 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
5401 {
5402 // If terminal_loop() returns OK we got a key that is handled
5403 // in Normal model. We don't do redrawing anyway.
5404 if (terminal_loop(TRUE) == OK)
5405 normal_cmd(&oa, TRUE);
5406 }
5407 else
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005408 normal_cmd(&oa, TRUE);
5409 }
Bram Moolenaare76062c2022-11-28 18:51:43 +00005410 retval = job->jv_exitval;
5411 ch_log(NULL, "system command finished");
5412
5413 job_unref(job);
5414
5415 // restore curwin/curbuf and a few other things
5416 aucmd_restbuf(&aco);
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005417 }
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005418
5419 wait_return(TRUE);
5420 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
5421
5422 vim_free(newcmd);
5423 return retval;
5424}
5425#endif
5426
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427/*
5428 * Either execute a command by calling the shell or start a new shell
5429 */
5430 int
5431mch_call_shell(
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00005432 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005433 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434{
5435 int x = 0;
5436 int tmode = cur_tmode;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005437 WCHAR szShellTitle[512];
Bram Moolenaar799d6ab2014-10-16 16:16:37 +02005438
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005439#ifdef FEAT_EVAL
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005440 ch_log(NULL, "executing shell command: %s", cmd);
5441#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005442 // Change the title to reflect that we are in a subshell.
K.Takataeeec2542021-06-02 13:28:16 +02005443 if (GetConsoleTitleW(szShellTitle, ARRAY_LENGTH(szShellTitle) - 4) > 0)
Bram Moolenaar1df52d72014-10-15 22:50:10 +02005444 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005445 if (cmd == NULL)
5446 wcscat(szShellTitle, L" :sh");
5447 else
Bram Moolenaar1df52d72014-10-15 22:50:10 +02005448 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005449 WCHAR *wn = enc_to_utf16((char_u *)cmd, NULL);
Bram Moolenaar1df52d72014-10-15 22:50:10 +02005450
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005451 if (wn != NULL)
5452 {
5453 wcscat(szShellTitle, L" - !");
5454 if ((wcslen(szShellTitle) + wcslen(wn) <
K.Takataeeec2542021-06-02 13:28:16 +02005455 ARRAY_LENGTH(szShellTitle)))
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005456 wcscat(szShellTitle, wn);
5457 SetConsoleTitleW(szShellTitle);
5458 vim_free(wn);
Bram Moolenaar1df52d72014-10-15 22:50:10 +02005459 }
5460 }
5461 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462
5463 out_flush();
5464
5465#ifdef MCH_WRITE_DUMP
5466 if (fdDump)
5467 {
5468 fprintf(fdDump, "mch_call_shell(\"%s\", %d)\n", cmd, options);
5469 fflush(fdDump);
5470 }
5471#endif
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005472#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005473 // TODO: make the terminal window work with input or output redirected.
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005474 if (
5475# ifdef VIMDLL
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005476 gui.in_use &&
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005477# endif
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005478 vim_strchr(p_go, GO_TERMINAL) != NULL
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005479 && (options & (SHELL_FILTER|SHELL_DOOUT|SHELL_WRITE|SHELL_READ)) == 0)
5480 {
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005481 char_u *cmdbase = cmd;
5482
Bram Moolenaar4d5c1262019-09-20 17:20:02 +02005483 if (cmdbase != NULL)
5484 // Skip a leading quote and (.
5485 while (*cmdbase == '"' || *cmdbase == '(')
5486 ++cmdbase;
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005487
5488 // Check the command does not begin with "start "
Bram Moolenaar36e7a822019-11-13 21:49:24 +01005489 if (cmdbase == NULL || STRNICMP(cmdbase, "start", 5) != 0
5490 || !VIM_ISWHITE(cmdbase[5]))
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005491 {
5492 // Use a terminal window to run the command in.
5493 x = mch_call_shell_terminal(cmd, options);
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005494 resettitle();
Bram Moolenaar7c348bb2019-06-08 12:05:22 +02005495 return x;
5496 }
Bram Moolenaarf05fa372018-03-18 19:29:34 +01005497 }
5498#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499
5500 /*
5501 * Catch all deadly signals while running the external command, because a
5502 * CTRL-C, Ctrl-Break or illegal instruction might otherwise kill us.
5503 */
ichizok378447f2023-05-11 22:25:42 +01005504 mch_signal(SIGINT, SIG_IGN);
ichizok378447f2023-05-11 22:25:42 +01005505 mch_signal(SIGBREAK, SIG_IGN);
ichizok378447f2023-05-11 22:25:42 +01005506 mch_signal(SIGILL, SIG_IGN);
5507 mch_signal(SIGFPE, SIG_IGN);
5508 mch_signal(SIGSEGV, SIG_IGN);
5509 mch_signal(SIGTERM, SIG_IGN);
5510 mch_signal(SIGABRT, SIG_IGN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511
5512 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005513 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514
5515 if (cmd == NULL)
5516 {
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005517 x = mch_system((char *)p_sh, options);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 }
5519 else
5520 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005521 // we use "command" or "cmd" to start the shell; slow but easy
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005522 char_u *newcmd = NULL;
5523 char_u *cmdbase = cmd;
5524 long_u cmdlen;
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005525
Bram Moolenaar0f873732019-12-05 20:28:46 +01005526 // Skip a leading ", ( and "(.
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005527 if (*cmdbase == '"' )
5528 ++cmdbase;
5529 if (*cmdbase == '(')
5530 ++cmdbase;
5531
Bram Moolenaar1c465442017-03-12 20:10:05 +01005532 if ((STRNICMP(cmdbase, "start", 5) == 0) && VIM_ISWHITE(cmdbase[5]))
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005533 {
5534 STARTUPINFO si;
5535 PROCESS_INFORMATION pi;
5536 DWORD flags = CREATE_NEW_CONSOLE;
Bram Moolenaarb2964f22017-03-21 19:29:26 +01005537 INT n_show_cmd = SW_SHOWNORMAL;
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005538 char_u *p;
5539
Bram Moolenaarfcc3f462014-01-24 19:55:37 +01005540 ZeroMemory(&si, sizeof(si));
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005541 si.cb = sizeof(si);
5542 si.lpReserved = NULL;
5543 si.lpDesktop = NULL;
5544 si.lpTitle = NULL;
5545 si.dwFlags = 0;
5546 si.cbReserved2 = 0;
5547 si.lpReserved2 = NULL;
5548
5549 cmdbase = skipwhite(cmdbase + 5);
5550 if ((STRNICMP(cmdbase, "/min", 4) == 0)
Bram Moolenaar1c465442017-03-12 20:10:05 +01005551 && VIM_ISWHITE(cmdbase[4]))
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005552 {
5553 cmdbase = skipwhite(cmdbase + 4);
5554 si.dwFlags = STARTF_USESHOWWINDOW;
5555 si.wShowWindow = SW_SHOWMINNOACTIVE;
Bram Moolenaarb2964f22017-03-21 19:29:26 +01005556 n_show_cmd = SW_SHOWMINNOACTIVE;
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005557 }
5558 else if ((STRNICMP(cmdbase, "/b", 2) == 0)
Bram Moolenaar1c465442017-03-12 20:10:05 +01005559 && VIM_ISWHITE(cmdbase[2]))
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005560 {
5561 cmdbase = skipwhite(cmdbase + 2);
5562 flags = CREATE_NO_WINDOW;
5563 si.dwFlags = STARTF_USESTDHANDLES;
5564 si.hStdInput = CreateFile("\\\\.\\NUL", // File name
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005565 GENERIC_READ, // Access flags
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005566 0, // Share flags
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005567 NULL, // Security att.
5568 OPEN_EXISTING, // Open flags
5569 FILE_ATTRIBUTE_NORMAL, // File att.
5570 NULL); // Temp file
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005571 si.hStdOutput = si.hStdInput;
5572 si.hStdError = si.hStdInput;
5573 }
5574
Bram Moolenaar0f873732019-12-05 20:28:46 +01005575 // Remove a trailing ", ) and )" if they have a match
5576 // at the start of the command.
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005577 if (cmdbase > cmd)
5578 {
5579 p = cmdbase + STRLEN(cmdbase);
5580 if (p > cmdbase && p[-1] == '"' && *cmd == '"')
5581 *--p = NUL;
5582 if (p > cmdbase && p[-1] == ')'
5583 && (*cmd =='(' || cmd[1] == '('))
5584 *--p = NUL;
5585 }
5586
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005587 newcmd = cmdbase;
5588 unescape_shellxquote(cmdbase, p_sxe);
5589
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005590 /*
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005591 * If creating new console, arguments are passed to the
5592 * 'cmd.exe' as-is. If it's not, arguments are not treated
5593 * correctly for current 'cmd.exe'. So unescape characters in
5594 * shellxescape except '|' for avoiding to be treated as
5595 * argument to them. Pass the arguments to sub-shell.
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005596 */
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005597 if (flags != CREATE_NEW_CONSOLE)
5598 {
5599 char_u *subcmd;
Bram Moolenaaree7d1002012-02-22 15:34:08 +01005600 char_u *cmd_shell = mch_getenv("COMSPEC");
5601
5602 if (cmd_shell == NULL || *cmd_shell == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005603 cmd_shell = (char_u *)default_shell();
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005604
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005605 subcmd = vim_strsave_escaped_ext(cmdbase,
5606 (char_u *)"|", '^', FALSE);
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005607 if (subcmd != NULL)
5608 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005609 // make "cmd.exe /c arguments"
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005610 cmdlen = STRLEN(cmd_shell) + STRLEN(subcmd) + 5;
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02005611 newcmd = alloc(cmdlen);
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005612 if (newcmd != NULL)
5613 vim_snprintf((char *)newcmd, cmdlen, "%s /c %s",
Bram Moolenaaree7d1002012-02-22 15:34:08 +01005614 cmd_shell, subcmd);
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005615 else
5616 newcmd = cmdbase;
Bram Moolenaaree7d1002012-02-22 15:34:08 +01005617 vim_free(subcmd);
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005618 }
5619 }
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005620
5621 /*
5622 * Now, start the command as a process, so that it doesn't
5623 * inherit our handles which causes unpleasant dangling swap
5624 * files if we exit before the spawned process
5625 */
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005626 if (vim_create_process((char *)newcmd, FALSE, flags,
5627 &si, &pi, NULL, NULL))
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005628 x = 0;
Bram Moolenaarb2964f22017-03-21 19:29:26 +01005629 else if (vim_shell_execute((char *)newcmd, n_show_cmd)
5630 > (HINSTANCE)32)
5631 x = 0;
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005632 else
5633 {
5634 x = -1;
Bram Moolenaar4f974752019-02-17 17:44:42 +01005635#ifdef FEAT_GUI_MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005636# ifdef VIMDLL
5637 if (gui.in_use)
5638# endif
Bram Moolenaarac78dd42022-01-02 19:25:26 +00005639 emsg(_(e_command_not_found));
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005640#endif
5641 }
Bram Moolenaarfb7df7b2012-02-22 13:07:05 +01005642
5643 if (newcmd != cmdbase)
5644 vim_free(newcmd);
5645
Bram Moolenaarfcc3f462014-01-24 19:55:37 +01005646 if (si.dwFlags == STARTF_USESTDHANDLES && si.hStdInput != NULL)
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005647 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005648 // Close the handle to \\.\NUL created above.
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005649 CloseHandle(si.hStdInput);
5650 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005651 // Close the handles to the subprocess, so that it goes away
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005652 CloseHandle(pi.hThread);
5653 CloseHandle(pi.hProcess);
5654 }
5655 else
5656 {
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005657 cmdlen =
Bram Moolenaar4f974752019-02-17 17:44:42 +01005658#ifdef FEAT_GUI_MSWIN
Bram Moolenaar294d9bf2019-05-23 20:12:46 +02005659 ((gui.in_use || gui.starting) ?
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005660 (!s_dont_use_vimrun && p_stmp ?
5661 STRLEN(vimrun_path) : STRLEN(p_sh) + STRLEN(p_shcf))
5662 : 0) +
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663#endif
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005664 STRLEN(p_sh) + STRLEN(p_shcf) + STRLEN(cmd) + 10;
Bram Moolenaar0fde2902008-03-16 13:54:13 +00005665
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02005666 newcmd = alloc(cmdlen);
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005667 if (newcmd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01005669#if defined(FEAT_GUI_MSWIN)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005670 if (
5671# ifdef VIMDLL
Bram Moolenaar294d9bf2019-05-23 20:12:46 +02005672 (gui.in_use || gui.starting) &&
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005673# endif
5674 need_vimrun_warning)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 {
Bram Moolenaar63e43442016-11-19 17:28:44 +01005676 char *msg = _("VIMRUN.EXE not found in your $PATH.\n"
5677 "External commands will not pause after completion.\n"
5678 "See :help win32-vimrun for more information.");
5679 char *title = _("Vim Warning");
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005680 WCHAR *wmsg = enc_to_utf16((char_u *)msg, NULL);
5681 WCHAR *wtitle = enc_to_utf16((char_u *)title, NULL);
Bram Moolenaar63e43442016-11-19 17:28:44 +01005682
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005683 if (wmsg != NULL && wtitle != NULL)
5684 MessageBoxW(NULL, wmsg, wtitle, MB_ICONWARNING);
5685 vim_free(wmsg);
5686 vim_free(wtitle);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 need_vimrun_warning = FALSE;
5688 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005689 if (
5690# ifdef VIMDLL
Bram Moolenaar294d9bf2019-05-23 20:12:46 +02005691 (gui.in_use || gui.starting) &&
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005692# endif
5693 !s_dont_use_vimrun && p_stmp)
Bram Moolenaarfcc4d922019-05-24 13:32:36 +02005694 // Use vimrun to execute the command. It opens a console
5695 // window, which can be closed without killing Vim.
Bram Moolenaarcc448b32010-07-14 16:52:17 +02005696 vim_snprintf((char *)newcmd, cmdlen, "%s%s%s %s %s",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 vimrun_path,
5698 (msg_silent != 0 || (options & SHELL_DOOUT))
5699 ? "-s " : "",
5700 p_sh, p_shcf, cmd);
Bram Moolenaarfcc4d922019-05-24 13:32:36 +02005701 else if (
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005702# ifdef VIMDLL
Bram Moolenaarfcc4d922019-05-24 13:32:36 +02005703 (gui.in_use || gui.starting) &&
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005704# endif
Bram Moolenaar0e6bfb92019-07-31 20:53:56 +02005705 s_dont_use_vimrun && STRCMP(p_shcf, "/c") == 0)
Bram Moolenaarfcc4d922019-05-24 13:32:36 +02005706 // workaround for the case that "vimrun" does not exist
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005707 vim_snprintf((char *)newcmd, cmdlen, "%s %s %s %s %s",
5708 p_sh, p_shcf, p_sh, p_shcf, cmd);
Bram Moolenaar98ffe4c2019-05-07 23:01:39 +02005709 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710#endif
Bram Moolenaarcc448b32010-07-14 16:52:17 +02005711 vim_snprintf((char *)newcmd, cmdlen, "%s %s %s",
Bram Moolenaar0fde2902008-03-16 13:54:13 +00005712 p_sh, p_shcf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 x = mch_system((char *)newcmd, options);
Bram Moolenaar6b707b42012-02-21 21:22:44 +01005714 vim_free(newcmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 }
5717 }
5718
5719 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02005720 {
5721 // The shell may have messed with the mode, always set it.
5722 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005723 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02005724 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725
Bram Moolenaar0f873732019-12-05 20:28:46 +01005726 // Print the return value, unless "vimrun" was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 if (x != 0 && !(options & SHELL_SILENT) && !emsg_silent
Bram Moolenaar4f974752019-02-17 17:44:42 +01005728#if defined(FEAT_GUI_MSWIN)
Bram Moolenaar294d9bf2019-05-23 20:12:46 +02005729 && ((gui.in_use || gui.starting) ?
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005730 ((options & SHELL_DOOUT) || s_dont_use_vimrun || !p_stmp) : 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731#endif
5732 )
5733 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005734 smsg(_("shell returned %d"), x);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 msg_putchar('\n');
5736 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 resettitle();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738
ichizok378447f2023-05-11 22:25:42 +01005739 mch_signal(SIGINT, SIG_DFL);
ichizok378447f2023-05-11 22:25:42 +01005740 mch_signal(SIGBREAK, SIG_DFL);
ichizok378447f2023-05-11 22:25:42 +01005741 mch_signal(SIGILL, SIG_DFL);
5742 mch_signal(SIGFPE, SIG_DFL);
5743 mch_signal(SIGSEGV, SIG_DFL);
5744 mch_signal(SIGTERM, SIG_DFL);
5745 mch_signal(SIGABRT, SIG_DFL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746
5747 return x;
5748}
5749
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005750#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01005751 static HANDLE
5752job_io_file_open(
Bram Moolenaar972c3b82017-01-12 21:44:49 +01005753 char_u *fname,
5754 DWORD dwDesiredAccess,
5755 DWORD dwShareMode,
5756 LPSECURITY_ATTRIBUTES lpSecurityAttributes,
5757 DWORD dwCreationDisposition,
5758 DWORD dwFlagsAndAttributes)
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01005759{
5760 HANDLE h;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005761 WCHAR *wn;
Bram Moolenaara12a1612019-01-24 16:39:02 +01005762
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005763 wn = enc_to_utf16(fname, NULL);
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01005764 if (wn == NULL)
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02005765 return INVALID_HANDLE_VALUE;
5766
5767 h = CreateFileW(wn, dwDesiredAccess, dwShareMode,
5768 lpSecurityAttributes, dwCreationDisposition,
5769 dwFlagsAndAttributes, NULL);
5770 vim_free(wn);
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01005771 return h;
5772}
5773
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005774/*
5775 * Turn the dictionary "env" into a NUL separated list that can be used as the
5776 * environment argument of vim_create_process().
5777 */
Bram Moolenaarba6febd2017-10-30 21:56:23 +01005778 void
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005779win32_build_env(dict_T *env, garray_T *gap, int is_terminal)
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005780{
5781 hashitem_T *hi;
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005782 long_u todo = env != NULL ? env->dv_hashtab.ht_used : 0;
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005783 LPVOID base = GetEnvironmentStringsW();
5784
Bram Moolenaar0f873732019-12-05 20:28:46 +01005785 // for last \0
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005786 if (ga_grow(gap, 1) == FAIL)
5787 return;
5788
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005789 if (env != NULL)
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005790 {
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00005791 FOR_ALL_HASHTAB_ITEMS(&env->dv_hashtab, hi, todo)
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005792 {
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005793 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005794 {
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005795 typval_T *item = &dict_lookup(hi)->di_tv;
5796 WCHAR *wkey = enc_to_utf16((char_u *)hi->hi_key, NULL);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005797 WCHAR *wval = enc_to_utf16(tv_get_string(item), NULL);
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005798 --todo;
5799 if (wkey != NULL && wval != NULL)
5800 {
5801 size_t n;
5802 size_t lkey = wcslen(wkey);
5803 size_t lval = wcslen(wval);
Bram Moolenaar60104f12017-08-14 23:25:04 +02005804
Yegappan Lakshmananfadc02a2023-01-27 21:03:12 +00005805 if (ga_grow(gap, (int)(lkey + lval + 2)) == FAIL)
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005806 continue;
5807 for (n = 0; n < lkey; n++)
5808 *((WCHAR*)gap->ga_data + gap->ga_len++) = wkey[n];
5809 *((WCHAR*)gap->ga_data + gap->ga_len++) = L'=';
5810 for (n = 0; n < lval; n++)
5811 *((WCHAR*)gap->ga_data + gap->ga_len++) = wval[n];
5812 *((WCHAR*)gap->ga_data + gap->ga_len++) = L'\0';
5813 }
Bram Moolenaarbdace832019-03-02 10:13:42 +01005814 vim_free(wkey);
5815 vim_free(wval);
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005816 }
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005817 }
5818 }
5819
Bram Moolenaar355757a2020-02-10 22:06:32 +01005820 if (base)
5821 {
5822 WCHAR *p = (WCHAR*) base;
5823
5824 // for last \0
5825 if (ga_grow(gap, 1) == FAIL)
5826 return;
5827
5828 while (*p != 0 || *(p + 1) != 0)
5829 {
5830 if (ga_grow(gap, 1) == OK)
5831 *((WCHAR*)gap->ga_data + gap->ga_len++) = *p;
5832 p++;
5833 }
Ken Takataad29f6a2023-09-16 13:56:02 +02005834 FreeEnvironmentStringsW(base);
Bram Moolenaar355757a2020-02-10 22:06:32 +01005835 *((WCHAR*)gap->ga_data + gap->ga_len++) = L'\0';
5836 }
5837
Bram Moolenaar493359e2018-06-12 20:25:52 +02005838# if defined(FEAT_CLIENTSERVER) || defined(FEAT_TERMINAL)
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005839 {
Bram Moolenaar493359e2018-06-12 20:25:52 +02005840# ifdef FEAT_CLIENTSERVER
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005841 char_u *servername = get_vim_var_str(VV_SEND_SERVER);
Bram Moolenaard7a137f2018-06-12 18:05:24 +02005842 size_t servername_len = STRLEN(servername);
Bram Moolenaar493359e2018-06-12 20:25:52 +02005843# endif
5844# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02005845 char_u *version = get_vim_var_str(VV_VERSION);
5846 size_t version_len = STRLEN(version);
Bram Moolenaar493359e2018-06-12 20:25:52 +02005847# endif
Bram Moolenaard7a137f2018-06-12 18:05:24 +02005848 // size of "VIM_SERVERNAME=" and value,
5849 // plus "VIM_TERMINAL=" and value,
5850 // plus two terminating NULs
5851 size_t n = 0
Bram Moolenaar493359e2018-06-12 20:25:52 +02005852# ifdef FEAT_CLIENTSERVER
Bram Moolenaard7a137f2018-06-12 18:05:24 +02005853 + 15 + servername_len
Bram Moolenaar493359e2018-06-12 20:25:52 +02005854# endif
5855# ifdef FEAT_TERMINAL
5856 + 13 + version_len + 2
5857# endif
5858 ;
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005859
Bram Moolenaard7a137f2018-06-12 18:05:24 +02005860 if (ga_grow(gap, (int)n) == OK)
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005861 {
Bram Moolenaar493359e2018-06-12 20:25:52 +02005862# ifdef FEAT_CLIENTSERVER
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005863 for (n = 0; n < 15; n++)
5864 *((WCHAR*)gap->ga_data + gap->ga_len++) =
5865 (WCHAR)"VIM_SERVERNAME="[n];
Bram Moolenaard7a137f2018-06-12 18:05:24 +02005866 for (n = 0; n < servername_len; n++)
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005867 *((WCHAR*)gap->ga_data + gap->ga_len++) =
5868 (WCHAR)servername[n];
5869 *((WCHAR*)gap->ga_data + gap->ga_len++) = L'\0';
Bram Moolenaar493359e2018-06-12 20:25:52 +02005870# endif
5871# ifdef FEAT_TERMINAL
5872 if (is_terminal)
5873 {
5874 for (n = 0; n < 13; n++)
5875 *((WCHAR*)gap->ga_data + gap->ga_len++) =
5876 (WCHAR)"VIM_TERMINAL="[n];
5877 for (n = 0; n < version_len; n++)
5878 *((WCHAR*)gap->ga_data + gap->ga_len++) =
5879 (WCHAR)version[n];
5880 *((WCHAR*)gap->ga_data + gap->ga_len++) = L'\0';
5881 }
5882# endif
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005883 }
5884 }
Bram Moolenaar79c6b512018-06-12 21:11:12 +02005885# endif
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005886}
5887
Bram Moolenaarb091f302019-01-19 14:37:00 +01005888/*
5889 * Create a pair of pipes.
5890 * Return TRUE for success, FALSE for failure.
5891 */
5892 static BOOL
5893create_pipe_pair(HANDLE handles[2])
5894{
5895 static LONG s;
5896 char name[64];
5897 SECURITY_ATTRIBUTES sa;
5898
5899 sprintf(name, "\\\\?\\pipe\\vim-%08lx-%08lx",
5900 GetCurrentProcessId(),
5901 InterlockedIncrement(&s));
5902
5903 // Create named pipe. Max size of named pipe is 65535.
5904 handles[1] = CreateNamedPipe(
5905 name,
5906 PIPE_ACCESS_OUTBOUND | FILE_FLAG_OVERLAPPED,
5907 PIPE_TYPE_BYTE | PIPE_NOWAIT,
Bram Moolenaar24058382019-01-24 23:11:49 +01005908 1, MAX_NAMED_PIPE_SIZE, 0, 0, NULL);
Bram Moolenaarb091f302019-01-19 14:37:00 +01005909
5910 if (handles[1] == INVALID_HANDLE_VALUE)
5911 return FALSE;
5912
5913 sa.nLength = sizeof(sa);
5914 sa.bInheritHandle = TRUE;
5915 sa.lpSecurityDescriptor = NULL;
5916
5917 handles[0] = CreateFile(name,
5918 FILE_GENERIC_READ,
5919 FILE_SHARE_READ, &sa,
5920 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
5921
5922 if (handles[0] == INVALID_HANDLE_VALUE)
5923 {
Bram Moolenaar6982f422019-02-16 16:48:01 +01005924 CloseHandle(handles[1]);
Bram Moolenaarb091f302019-01-19 14:37:00 +01005925 return FALSE;
5926 }
5927
5928 return TRUE;
5929}
5930
Bram Moolenaar942d6b22016-02-07 19:57:16 +01005931 void
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005932mch_job_start(char *cmd, job_T *job, jobopt_T *options)
Bram Moolenaar942d6b22016-02-07 19:57:16 +01005933{
5934 STARTUPINFO si;
5935 PROCESS_INFORMATION pi;
Bram Moolenaar14207f42016-10-27 21:13:10 +02005936 HANDLE jo;
Bram Moolenaard5d3d302016-03-09 20:54:51 +01005937 SECURITY_ATTRIBUTES saAttr;
5938 channel_T *channel = NULL;
Bram Moolenaard8070362016-02-15 21:56:54 +01005939 HANDLE ifd[2];
5940 HANDLE ofd[2];
5941 HANDLE efd[2];
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005942 garray_T ga;
Bram Moolenaard5d3d302016-03-09 20:54:51 +01005943
5944 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5945 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5946 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
5947 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
5948 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5949 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
5950 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
5951
5952 if (use_out_for_err && use_null_for_out)
5953 use_null_for_err = TRUE;
Bram Moolenaard8070362016-02-15 21:56:54 +01005954
5955 ifd[0] = INVALID_HANDLE_VALUE;
5956 ifd[1] = INVALID_HANDLE_VALUE;
5957 ofd[0] = INVALID_HANDLE_VALUE;
5958 ofd[1] = INVALID_HANDLE_VALUE;
5959 efd[0] = INVALID_HANDLE_VALUE;
5960 efd[1] = INVALID_HANDLE_VALUE;
Bram Moolenaar04935fb2022-01-08 16:19:22 +00005961 ga_init2(&ga, sizeof(wchar_t), 500);
Bram Moolenaar942d6b22016-02-07 19:57:16 +01005962
Bram Moolenaar14207f42016-10-27 21:13:10 +02005963 jo = CreateJobObject(NULL, NULL);
5964 if (jo == NULL)
5965 {
5966 job->jv_status = JOB_FAILED;
5967 goto failed;
5968 }
5969
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005970 if (options->jo_env != NULL)
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +01005971 win32_build_env(options->jo_env, &ga, FALSE);
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005972
Bram Moolenaar76467df2016-02-12 19:30:26 +01005973 ZeroMemory(&pi, sizeof(pi));
Bram Moolenaar942d6b22016-02-07 19:57:16 +01005974 ZeroMemory(&si, sizeof(si));
5975 si.cb = sizeof(si);
Bram Moolenaard8070362016-02-15 21:56:54 +01005976 si.dwFlags |= STARTF_USESHOWWINDOW;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005977 si.wShowWindow = SW_HIDE;
Bram Moolenaar942d6b22016-02-07 19:57:16 +01005978
Bram Moolenaard8070362016-02-15 21:56:54 +01005979 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
5980 saAttr.bInheritHandle = TRUE;
5981 saAttr.lpSecurityDescriptor = NULL;
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01005982
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005983 if (use_file_for_in)
5984 {
5985 char_u *fname = options->jo_io_name[PART_IN];
5986
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01005987 ifd[0] = job_io_file_open(fname, GENERIC_READ,
5988 FILE_SHARE_READ | FILE_SHARE_WRITE,
5989 &saAttr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL);
5990 if (ifd[0] == INVALID_HANDLE_VALUE)
Bram Moolenaar94d01912016-03-08 13:48:51 +01005991 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005992 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaar94d01912016-03-08 13:48:51 +01005993 goto failed;
5994 }
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005995 }
Bram Moolenaarb091f302019-01-19 14:37:00 +01005996 else if (!use_null_for_in
5997 && (!create_pipe_pair(ifd)
5998 || !SetHandleInformation(ifd[1], HANDLE_FLAG_INHERIT, 0)))
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005999 goto failed;
6000
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006001 if (use_file_for_out)
6002 {
6003 char_u *fname = options->jo_io_name[PART_OUT];
6004
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01006005 ofd[1] = job_io_file_open(fname, GENERIC_WRITE,
6006 FILE_SHARE_READ | FILE_SHARE_WRITE,
6007 &saAttr, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL);
6008 if (ofd[1] == INVALID_HANDLE_VALUE)
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006009 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006010 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006011 goto failed;
6012 }
6013 }
Bram Moolenaard5d3d302016-03-09 20:54:51 +01006014 else if (!use_null_for_out &&
6015 (!CreatePipe(&ofd[0], &ofd[1], &saAttr, 0)
Bram Moolenaarcea912a2016-10-12 14:20:24 +02006016 || !SetHandleInformation(ofd[0], HANDLE_FLAG_INHERIT, 0)))
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01006017 goto failed;
6018
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006019 if (use_file_for_err)
6020 {
6021 char_u *fname = options->jo_io_name[PART_ERR];
6022
Bram Moolenaar7bffaa92016-03-10 21:46:03 +01006023 efd[1] = job_io_file_open(fname, GENERIC_WRITE,
6024 FILE_SHARE_READ | FILE_SHARE_WRITE,
6025 &saAttr, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL);
6026 if (efd[1] == INVALID_HANDLE_VALUE)
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006027 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006028 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006029 goto failed;
6030 }
6031 }
Bram Moolenaard5d3d302016-03-09 20:54:51 +01006032 else if (!use_out_for_err && !use_null_for_err &&
6033 (!CreatePipe(&efd[0], &efd[1], &saAttr, 0)
Bram Moolenaarcea912a2016-10-12 14:20:24 +02006034 || !SetHandleInformation(efd[0], HANDLE_FLAG_INHERIT, 0)))
Bram Moolenaard8070362016-02-15 21:56:54 +01006035 goto failed;
Bram Moolenaar13d6fb12016-03-08 18:40:52 +01006036
Bram Moolenaard8070362016-02-15 21:56:54 +01006037 si.dwFlags |= STARTF_USESTDHANDLES;
6038 si.hStdInput = ifd[0];
Bram Moolenaard5d3d302016-03-09 20:54:51 +01006039 si.hStdOutput = ofd[1];
6040 si.hStdError = use_out_for_err ? ofd[1] : efd[1];
6041
6042 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
6043 {
Bram Moolenaarde279892016-03-11 22:19:44 +01006044 if (options->jo_set & JO_CHANNEL)
6045 {
6046 channel = options->jo_channel;
6047 if (channel != NULL)
6048 ++channel->ch_refcount;
6049 }
6050 else
6051 channel = add_channel();
Bram Moolenaard5d3d302016-03-09 20:54:51 +01006052 if (channel == NULL)
6053 goto failed;
6054 }
Bram Moolenaard8070362016-02-15 21:56:54 +01006055
6056 if (!vim_create_process(cmd, TRUE,
Bram Moolenaar14207f42016-10-27 21:13:10 +02006057 CREATE_SUSPENDED |
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006058 CREATE_DEFAULT_ERROR_MODE |
6059 CREATE_NEW_PROCESS_GROUP |
Bram Moolenaar05aafed2017-08-11 19:12:11 +02006060 CREATE_UNICODE_ENVIRONMENT |
Bram Moolenaar76467df2016-02-12 19:30:26 +01006061 CREATE_NEW_CONSOLE,
Bram Moolenaar05aafed2017-08-11 19:12:11 +02006062 &si, &pi,
6063 ga.ga_data,
6064 (char *)options->jo_cwd))
Bram Moolenaar76467df2016-02-12 19:30:26 +01006065 {
Bram Moolenaar14207f42016-10-27 21:13:10 +02006066 CloseHandle(jo);
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006067 job->jv_status = JOB_FAILED;
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01006068 goto failed;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006069 }
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01006070
Bram Moolenaar05aafed2017-08-11 19:12:11 +02006071 ga_clear(&ga);
6072
Bram Moolenaar14207f42016-10-27 21:13:10 +02006073 if (!AssignProcessToJobObject(jo, pi.hProcess))
6074 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006075 // if failing, switch the way to terminate
6076 // process with TerminateProcess.
Bram Moolenaar14207f42016-10-27 21:13:10 +02006077 CloseHandle(jo);
6078 jo = NULL;
6079 }
6080 ResumeThread(pi.hThread);
Bram Moolenaar75578a32016-03-10 16:33:31 +01006081 CloseHandle(pi.hThread);
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01006082 job->jv_proc_info = pi;
Bram Moolenaar14207f42016-10-27 21:13:10 +02006083 job->jv_job_object = jo;
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01006084 job->jv_status = JOB_STARTED;
6085
Bram Moolenaar641ad6c2016-09-01 18:32:11 +02006086 CloseHandle(ifd[0]);
6087 CloseHandle(ofd[1]);
6088 if (!use_out_for_err && !use_null_for_err)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01006089 CloseHandle(efd[1]);
Bram Moolenaard8070362016-02-15 21:56:54 +01006090
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01006091 job->jv_channel = channel;
Bram Moolenaard5d3d302016-03-09 20:54:51 +01006092 if (channel != NULL)
6093 {
6094 channel_set_pipes(channel,
6095 use_file_for_in || use_null_for_in
6096 ? INVALID_FD : (sock_T)ifd[1],
6097 use_file_for_out || use_null_for_out
6098 ? INVALID_FD : (sock_T)ofd[0],
6099 use_out_for_err || use_file_for_err || use_null_for_err
6100 ? INVALID_FD : (sock_T)efd[0]);
6101 channel_set_job(channel, job, options);
Bram Moolenaard5d3d302016-03-09 20:54:51 +01006102 }
Bram Moolenaar7b3ca762016-02-14 19:13:43 +01006103 return;
6104
6105failed:
Bram Moolenaard8070362016-02-15 21:56:54 +01006106 CloseHandle(ifd[0]);
6107 CloseHandle(ofd[0]);
6108 CloseHandle(efd[0]);
6109 CloseHandle(ifd[1]);
6110 CloseHandle(ofd[1]);
6111 CloseHandle(efd[1]);
Bram Moolenaarde279892016-03-11 22:19:44 +01006112 channel_unref(channel);
Bram Moolenaar05aafed2017-08-11 19:12:11 +02006113 ga_clear(&ga);
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006114}
6115
6116 char *
6117mch_job_status(job_T *job)
6118{
6119 DWORD dwExitCode = 0;
6120
Bram Moolenaar76467df2016-02-12 19:30:26 +01006121 if (!GetExitCodeProcess(job->jv_proc_info.hProcess, &dwExitCode)
6122 || dwExitCode != STILL_ACTIVE)
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006123 {
Bram Moolenaareab089d2016-02-21 19:32:02 +01006124 job->jv_exitval = (int)dwExitCode;
Bram Moolenaar7df915d2016-11-17 17:25:32 +01006125 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02006126 {
6127 ch_log(job->jv_channel, "Job ended");
6128 job->jv_status = JOB_ENDED;
6129 }
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006130 return "dead";
6131 }
6132 return "run";
6133}
6134
Bram Moolenaar97792de2016-10-15 18:36:49 +02006135 job_T *
6136mch_detect_ended_job(job_T *job_list)
6137{
6138 HANDLE jobHandles[MAXIMUM_WAIT_OBJECTS];
6139 job_T *jobArray[MAXIMUM_WAIT_OBJECTS];
6140 job_T *job = job_list;
6141
6142 while (job != NULL)
6143 {
6144 DWORD n;
6145 DWORD result;
6146
6147 for (n = 0; n < MAXIMUM_WAIT_OBJECTS
6148 && job != NULL; job = job->jv_next)
6149 {
6150 if (job->jv_status == JOB_STARTED)
6151 {
6152 jobHandles[n] = job->jv_proc_info.hProcess;
6153 jobArray[n] = job;
6154 ++n;
6155 }
6156 }
6157 if (n == 0)
6158 continue;
6159 result = WaitForMultipleObjects(n, jobHandles, FALSE, 0);
6160 if (result >= WAIT_OBJECT_0 && result < WAIT_OBJECT_0 + n)
6161 {
6162 job_T *wait_job = jobArray[result - WAIT_OBJECT_0];
6163
6164 if (STRCMP(mch_job_status(wait_job), "dead") == 0)
6165 return wait_job;
6166 }
6167 }
6168 return NULL;
6169}
6170
Bram Moolenaarfb630902016-10-29 14:55:00 +02006171 static BOOL
6172terminate_all(HANDLE process, int code)
6173{
6174 PROCESSENTRY32 pe;
6175 HANDLE h = INVALID_HANDLE_VALUE;
6176 DWORD pid = GetProcessId(process);
6177
6178 if (pid != 0)
6179 {
6180 h = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
6181 if (h != INVALID_HANDLE_VALUE)
6182 {
6183 pe.dwSize = sizeof(PROCESSENTRY32);
6184 if (!Process32First(h, &pe))
6185 goto theend;
6186
6187 do
6188 {
6189 if (pe.th32ParentProcessID == pid)
6190 {
6191 HANDLE ph = OpenProcess(
6192 PROCESS_ALL_ACCESS, FALSE, pe.th32ProcessID);
6193 if (ph != NULL)
6194 {
6195 terminate_all(ph, code);
6196 CloseHandle(ph);
6197 }
6198 }
6199 } while (Process32Next(h, &pe));
6200
6201 CloseHandle(h);
6202 }
6203 }
6204
6205theend:
6206 return TerminateProcess(process, code);
6207}
6208
6209/*
6210 * Send a (deadly) signal to "job".
6211 * Return FAIL if it didn't work.
6212 */
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006213 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02006214mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006215{
Bram Moolenaar923d9262016-02-25 20:56:01 +01006216 int ret;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006217
Bram Moolenaar923d9262016-02-25 20:56:01 +01006218 if (STRCMP(how, "term") == 0 || STRCMP(how, "kill") == 0 || *how == NUL)
Bram Moolenaar76467df2016-02-12 19:30:26 +01006219 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006220 // deadly signal
Bram Moolenaar14207f42016-10-27 21:13:10 +02006221 if (job->jv_job_object != NULL)
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01006222 {
6223 if (job->jv_channel != NULL && job->jv_channel->ch_anonymous_pipe)
6224 job->jv_channel->ch_killing = TRUE;
K.Takata135e1522022-01-29 15:27:58 +00006225 return TerminateJobObject(job->jv_job_object, (UINT)-1) ? OK : FAIL;
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01006226 }
Bram Moolenaarb3e195c2020-02-10 21:32:19 +01006227 return terminate_all(job->jv_proc_info.hProcess, -1) ? OK : FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006228 }
6229
6230 if (!AttachConsole(job->jv_proc_info.dwProcessId))
6231 return FAIL;
6232 ret = GenerateConsoleCtrlEvent(
Bram Moolenaar923d9262016-02-25 20:56:01 +01006233 STRCMP(how, "int") == 0 ? CTRL_C_EVENT : CTRL_BREAK_EVENT,
6234 job->jv_proc_info.dwProcessId)
6235 ? OK : FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006236 FreeConsole();
6237 return ret;
6238}
6239
6240/*
6241 * Clear the data related to "job".
6242 */
6243 void
6244mch_clear_job(job_T *job)
6245{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00006246 if (job->jv_status == JOB_FAILED)
6247 return;
6248
6249 if (job->jv_job_object != NULL)
6250 CloseHandle(job->jv_job_object);
6251 CloseHandle(job->jv_proc_info.hProcess);
Bram Moolenaar942d6b22016-02-07 19:57:16 +01006252}
6253#endif
6254
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006256#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257
6258/*
6259 * Start termcap mode
6260 */
6261 static void
6262termcap_mode_start(void)
6263{
6264 DWORD cmodein;
6265
6266 if (g_fTermcapMode)
6267 return;
6268
6269 SaveConsoleBuffer(&g_cbNonTermcap);
6270
6271 if (g_cbTermcap.IsValid)
6272 {
6273 /*
6274 * We've been in termcap mode before. Restore certain screen
6275 * characteristics, including the buffer size and the window
6276 * size. Since we will be redrawing the screen, we don't need
6277 * to restore the actual contents of the buffer.
6278 */
6279 RestoreConsoleBuffer(&g_cbTermcap, FALSE);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006280 reset_console_color_rgb();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 SetConsoleWindowInfo(g_hConOut, TRUE, &g_cbTermcap.Info.srWindow);
6282 Rows = g_cbTermcap.Info.dwSize.Y;
6283 Columns = g_cbTermcap.Info.dwSize.X;
6284 }
6285 else
6286 {
6287 /*
6288 * This is our first time entering termcap mode. Clear the console
6289 * screen buffer, and resize the buffer to match the current window
6290 * size. We will use this as the size of our editing environment.
6291 */
6292 ClearConsoleBuffer(g_attrCurrent);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006293 set_console_color_rgb();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 ResizeConBufAndWindow(g_hConOut, Columns, Rows);
6295 }
6296
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 resettitle();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298
6299 GetConsoleMode(g_hConIn, &cmodein);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 if (g_fMouseActive)
Wez Furlong6ef5ab52021-05-30 19:29:41 +02006301 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 cmodein |= ENABLE_MOUSE_INPUT;
Wez Furlong6ef5ab52021-05-30 19:29:41 +02006303 cmodein &= ~ENABLE_QUICK_EDIT_MODE;
6304 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 else
Wez Furlong6ef5ab52021-05-30 19:29:41 +02006306 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 cmodein &= ~ENABLE_MOUSE_INPUT;
Wez Furlong6ef5ab52021-05-30 19:29:41 +02006308 cmodein |= g_cmodein & ENABLE_QUICK_EDIT_MODE;
6309 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 cmodein |= ENABLE_WINDOW_INPUT;
Wez Furlong6ef5ab52021-05-30 19:29:41 +02006311 SetConsoleMode(g_hConIn, cmodein | ENABLE_EXTENDED_FLAGS);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312
6313 redraw_later_clear();
6314 g_fTermcapMode = TRUE;
6315}
6316
6317
6318/*
6319 * End termcap mode
6320 */
6321 static void
6322termcap_mode_end(void)
6323{
6324 DWORD cmodein;
6325 ConsoleBuffer *cb;
6326 COORD coord;
6327 DWORD dwDummy;
6328
6329 if (!g_fTermcapMode)
6330 return;
6331
6332 SaveConsoleBuffer(&g_cbTermcap);
6333
6334 GetConsoleMode(g_hConIn, &cmodein);
6335 cmodein &= ~(ENABLE_MOUSE_INPUT | ENABLE_WINDOW_INPUT);
Wez Furlong6ef5ab52021-05-30 19:29:41 +02006336 cmodein |= g_cmodein & ENABLE_QUICK_EDIT_MODE;
6337 SetConsoleMode(g_hConIn, cmodein | ENABLE_EXTENDED_FLAGS);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006339# ifdef FEAT_RESTORE_ORIG_SCREEN
Bram Moolenaar4c0aac52015-10-30 16:46:55 +01006340 cb = exiting ? &g_cbOrig : &g_cbNonTermcap;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006341# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 cb = &g_cbNonTermcap;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006343# endif
Bram Moolenaar81ccbf12020-04-15 21:05:30 +02006344 RestoreConsoleBuffer(cb, p_rs);
Bram Moolenaardf543822020-01-30 11:53:59 +01006345 restore_console_color_rgb();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346
William Breslerded59132024-10-08 21:30:48 +02006347 // Switch back to main screen buffer.
6348 if (exiting && use_alternate_screen_buffer)
6349 vtp_printf("\033[?1049l");
6350
Christopher Plewright1140b512022-11-12 18:46:05 +00006351 if (!USE_WT && (p_rs || exiting))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 {
6353 /*
6354 * Clear anything that happens to be on the current line.
6355 */
6356 coord.X = 0;
6357 coord.Y = (SHORT) (p_rs ? cb->Info.dwCursorPosition.Y : (Rows - 1));
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00006358 FillConsoleOutputCharacter(g_hConOut, ' ',
6359 cb->Info.dwSize.X, coord, &dwDummy);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 /*
6361 * The following is just for aesthetics. If we are exiting without
6362 * restoring the screen, then we want to have a prompt string
6363 * appear at the bottom line. However, the command interpreter
6364 * seems to always advance the cursor one line before displaying
6365 * the prompt string, which causes the screen to scroll. To
6366 * counter this, move the cursor up one line before exiting.
6367 */
6368 if (exiting && !p_rs)
6369 coord.Y--;
6370 /*
6371 * Position the cursor at the leftmost column of the desired row.
6372 */
Bram Moolenaar81ccbf12020-04-15 21:05:30 +02006373 SetConsoleCursorPosition(g_hConOut, coord);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 }
Christopher Plewright1140b512022-11-12 18:46:05 +00006375 SetConsoleCursorInfo(g_hConOut, &g_cci);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 g_fTermcapMode = FALSE;
6377}
Christopher Plewright38804d62022-11-09 23:55:52 +00006378#endif // !FEAT_GUI_MSWIN || VIMDLL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379
6380
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006381#if defined(FEAT_GUI_MSWIN) && !defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 void
6383mch_write(
Bram Moolenaar1266d672017-02-01 13:43:36 +01006384 char_u *s UNUSED,
6385 int len UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386{
Bram Moolenaar0f873732019-12-05 20:28:46 +01006387 // never used
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388}
6389
6390#else
6391
6392/*
6393 * clear `n' chars, starting from `coord'
6394 */
6395 static void
6396clear_chars(
6397 COORD coord,
6398 DWORD n)
6399{
Christopher Plewright38804d62022-11-09 23:55:52 +00006400 if (!vtp_working)
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006401 {
6402 DWORD dwDummy;
6403
6404 FillConsoleOutputCharacter(g_hConOut, ' ', n, coord, &dwDummy);
6405 FillConsoleOutputAttribute(g_hConOut, g_attrCurrent, n, coord,
6406 &dwDummy);
6407 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006408 else
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02006409 {
6410 set_console_color_rgb();
6411 gotoxy(coord.X + 1, coord.Y + 1);
6412 vtp_printf("\033[%dX", n);
6413 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414}
6415
6416
6417/*
6418 * Clear the screen
6419 */
6420 static void
6421clear_screen(void)
6422{
6423 g_coord.X = g_coord.Y = 0;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006424
Christopher Plewright38804d62022-11-09 23:55:52 +00006425 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006426 clear_chars(g_coord, Rows * Columns);
6427 else
6428 {
6429 set_console_color_rgb();
6430 gotoxy(1, 1);
6431 vtp_printf("\033[2J");
6432 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433}
6434
6435
6436/*
6437 * Clear to end of display
6438 */
6439 static void
6440clear_to_end_of_display(void)
6441{
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006442 COORD save = g_coord;
6443
Christopher Plewright38804d62022-11-09 23:55:52 +00006444 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006445 clear_chars(g_coord, (Rows - g_coord.Y - 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 * Columns + (Columns - g_coord.X));
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006447 else
6448 {
6449 set_console_color_rgb();
6450 gotoxy(g_coord.X + 1, g_coord.Y + 1);
6451 vtp_printf("\033[0J");
6452
6453 gotoxy(save.X + 1, save.Y + 1);
6454 g_coord = save;
6455 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456}
6457
6458
6459/*
6460 * Clear to end of line
6461 */
6462 static void
6463clear_to_end_of_line(void)
6464{
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006465 COORD save = g_coord;
6466
Christopher Plewright38804d62022-11-09 23:55:52 +00006467 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006468 clear_chars(g_coord, Columns - g_coord.X);
6469 else
6470 {
6471 set_console_color_rgb();
6472 gotoxy(g_coord.X + 1, g_coord.Y + 1);
6473 vtp_printf("\033[0K");
6474
6475 gotoxy(save.X + 1, save.Y + 1);
6476 g_coord = save;
6477 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478}
6479
6480
6481/*
6482 * Scroll the scroll region up by `cLines' lines
6483 */
6484 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006485scroll(unsigned cLines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486{
6487 COORD oldcoord = g_coord;
6488
6489 gotoxy(g_srScrollRegion.Left + 1, g_srScrollRegion.Top + 1);
6490 delete_lines(cLines);
6491
6492 g_coord = oldcoord;
6493}
6494
6495
6496/*
6497 * Set the scroll region
6498 */
6499 static void
6500set_scroll_region(
6501 unsigned left,
6502 unsigned top,
6503 unsigned right,
6504 unsigned bottom)
6505{
6506 if (left >= right
6507 || top >= bottom
6508 || right > (unsigned) Columns - 1
6509 || bottom > (unsigned) Rows - 1)
6510 return;
6511
6512 g_srScrollRegion.Left = left;
6513 g_srScrollRegion.Top = top;
6514 g_srScrollRegion.Right = right;
6515 g_srScrollRegion.Bottom = bottom;
Bram Moolenaar6982f422019-02-16 16:48:01 +01006516}
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006517
Bram Moolenaar6982f422019-02-16 16:48:01 +01006518 static void
6519set_scroll_region_tb(
6520 unsigned top,
6521 unsigned bottom)
6522{
6523 if (top >= bottom || bottom > (unsigned)Rows - 1)
6524 return;
6525
6526 g_srScrollRegion.Top = top;
6527 g_srScrollRegion.Bottom = bottom;
6528}
6529
6530 static void
6531set_scroll_region_lr(
6532 unsigned left,
6533 unsigned right)
6534{
6535 if (left >= right || right > (unsigned)Columns - 1)
6536 return;
6537
6538 g_srScrollRegion.Left = left;
6539 g_srScrollRegion.Right = right;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540}
6541
6542
6543/*
6544 * Insert `cLines' lines at the current cursor position
6545 */
6546 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006547insert_lines(unsigned cLines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548{
Bram Moolenaar6982f422019-02-16 16:48:01 +01006549 SMALL_RECT source, clip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 COORD dest;
6551 CHAR_INFO fill;
6552
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006553 gotoxy(g_srScrollRegion.Left + 1, g_srScrollRegion.Top + 1);
6554
Bram Moolenaar6982f422019-02-16 16:48:01 +01006555 dest.X = g_srScrollRegion.Left;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 dest.Y = g_coord.Y + cLines;
6557
Bram Moolenaar6982f422019-02-16 16:48:01 +01006558 source.Left = g_srScrollRegion.Left;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 source.Top = g_coord.Y;
6560 source.Right = g_srScrollRegion.Right;
6561 source.Bottom = g_srScrollRegion.Bottom - cLines;
6562
Bram Moolenaar6982f422019-02-16 16:48:01 +01006563 clip.Left = g_srScrollRegion.Left;
6564 clip.Top = g_coord.Y;
6565 clip.Right = g_srScrollRegion.Right;
6566 clip.Bottom = g_srScrollRegion.Bottom;
6567
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006568 fill.Char.AsciiChar = ' ';
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00006569 if (!USE_VTP)
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006570 fill.Attributes = g_attrCurrent;
6571 else
6572 fill.Attributes = g_attrDefault;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006574 set_console_color_rgb();
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006575
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006576 ScrollConsoleScreenBuffer(g_hConOut, &source, &clip, dest, &fill);
6577
Bram Moolenaar6982f422019-02-16 16:48:01 +01006578 // Here we have to deal with a win32 console flake: If the scroll
6579 // region looks like abc and we scroll c to a and fill with d we get
6580 // cbd... if we scroll block c one line at a time to a, we get cdd...
6581 // vim expects cdd consistently... So we have to deal with that
6582 // here... (this also occurs scrolling the same way in the other
6583 // direction).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584
6585 if (source.Bottom < dest.Y)
6586 {
6587 COORD coord;
Bram Moolenaar6982f422019-02-16 16:48:01 +01006588 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589
Bram Moolenaar6982f422019-02-16 16:48:01 +01006590 coord.X = source.Left;
6591 for (i = clip.Top; i < dest.Y; ++i)
6592 {
6593 coord.Y = i;
6594 clear_chars(coord, source.Right - source.Left + 1);
6595 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 }
Bram Moolenaar06b7b582020-05-30 17:49:25 +02006597
Christopher Plewright38804d62022-11-09 23:55:52 +00006598 if (vtp_working)
Bram Moolenaar06b7b582020-05-30 17:49:25 +02006599 {
6600 COORD coord;
6601 int i;
6602
6603 coord.X = source.Left;
6604 for (i = source.Top; i < dest.Y; ++i)
6605 {
6606 coord.Y = i;
6607 clear_chars(coord, source.Right - source.Left + 1);
6608 }
6609 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610}
6611
6612
6613/*
6614 * Delete `cLines' lines at the current cursor position
6615 */
6616 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006617delete_lines(unsigned cLines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618{
Bram Moolenaar6982f422019-02-16 16:48:01 +01006619 SMALL_RECT source, clip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 COORD dest;
6621 CHAR_INFO fill;
6622 int nb;
6623
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006624 gotoxy(g_srScrollRegion.Left + 1, g_srScrollRegion.Top + 1);
6625
Bram Moolenaar6982f422019-02-16 16:48:01 +01006626 dest.X = g_srScrollRegion.Left;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 dest.Y = g_coord.Y;
6628
Bram Moolenaar6982f422019-02-16 16:48:01 +01006629 source.Left = g_srScrollRegion.Left;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 source.Top = g_coord.Y + cLines;
6631 source.Right = g_srScrollRegion.Right;
6632 source.Bottom = g_srScrollRegion.Bottom;
6633
Bram Moolenaar6982f422019-02-16 16:48:01 +01006634 clip.Left = g_srScrollRegion.Left;
6635 clip.Top = g_coord.Y;
6636 clip.Right = g_srScrollRegion.Right;
6637 clip.Bottom = g_srScrollRegion.Bottom;
6638
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006639 fill.Char.AsciiChar = ' ';
Christopher Plewright38804d62022-11-09 23:55:52 +00006640 if (!vtp_working)
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006641 fill.Attributes = g_attrCurrent;
6642 else
6643 fill.Attributes = g_attrDefault;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006645 set_console_color_rgb();
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006646
Bram Moolenaar3b5fef62019-03-17 14:54:53 +01006647 ScrollConsoleScreenBuffer(g_hConOut, &source, &clip, dest, &fill);
6648
Bram Moolenaar6982f422019-02-16 16:48:01 +01006649 // Here we have to deal with a win32 console flake; See insert_lines()
6650 // above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651
6652 nb = dest.Y + (source.Bottom - source.Top) + 1;
6653
6654 if (nb < source.Top)
6655 {
6656 COORD coord;
Bram Moolenaar6982f422019-02-16 16:48:01 +01006657 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658
Bram Moolenaar6982f422019-02-16 16:48:01 +01006659 coord.X = source.Left;
6660 for (i = nb; i < clip.Bottom; ++i)
6661 {
6662 coord.Y = i;
6663 clear_chars(coord, source.Right - source.Left + 1);
6664 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 }
Bram Moolenaar06b7b582020-05-30 17:49:25 +02006666
Christopher Plewright38804d62022-11-09 23:55:52 +00006667 if (vtp_working)
Bram Moolenaar06b7b582020-05-30 17:49:25 +02006668 {
6669 COORD coord;
6670 int i;
6671
6672 coord.X = source.Left;
6673 for (i = nb; i <= source.Bottom; ++i)
6674 {
6675 coord.Y = i;
6676 clear_chars(coord, source.Right - source.Left + 1);
6677 }
6678 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679}
6680
6681
6682/*
Bram Moolenaar2313b612019-09-27 14:14:32 +02006683 * Set the cursor position to (x,y) (1-based).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 */
6685 static void
6686gotoxy(
6687 unsigned x,
6688 unsigned y)
6689{
6690 if (x < 1 || x > (unsigned)Columns || y < 1 || y > (unsigned)Rows)
6691 return;
6692
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00006693 if (!USE_VTP)
Bram Moolenaar2313b612019-09-27 14:14:32 +02006694 {
Bram Moolenaar82e743c2020-03-26 15:39:53 +01006695 // There are reports of double-width characters not displayed
6696 // correctly. This workaround should fix it, similar to how it's done
6697 // for VTP.
6698 g_coord.X = 0;
6699 SetConsoleCursorPosition(g_hConOut, g_coord);
6700
Bram Moolenaar2313b612019-09-27 14:14:32 +02006701 // external cursor coords are 1-based; internal are 0-based
6702 g_coord.X = x - 1;
6703 g_coord.Y = y - 1;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006704 SetConsoleCursorPosition(g_hConOut, g_coord);
Bram Moolenaar2313b612019-09-27 14:14:32 +02006705 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006706 else
Bram Moolenaar2313b612019-09-27 14:14:32 +02006707 {
6708 // Move the cursor to the left edge of the screen to prevent screen
Bram Moolenaara1299742019-10-10 16:36:00 +02006709 // destruction. Insider build bug. Always enabled because it's cheap
6710 // and avoids mistakes with recognizing the build.
6711 vtp_printf("\033[%d;%dH", g_coord.Y + 1, 1);
Bram Moolenaar2313b612019-09-27 14:14:32 +02006712
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006713 vtp_printf("\033[%d;%dH", y, x);
Bram Moolenaar2313b612019-09-27 14:14:32 +02006714
6715 g_coord.X = x - 1;
6716 g_coord.Y = y - 1;
6717 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718}
6719
6720
6721/*
6722 * Set the current text attribute = (foreground | background)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02006723 * See ../runtime/doc/os_win32.txt for the numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 */
6725 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006726textattr(WORD wAttr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727{
Bram Moolenaar6383b922015-03-24 17:12:19 +01006728 g_attrCurrent = wAttr & 0xff;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729
6730 SetConsoleTextAttribute(g_hConOut, wAttr);
6731}
6732
6733
6734 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006735textcolor(WORD wAttr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736{
Bram Moolenaar6383b922015-03-24 17:12:19 +01006737 g_attrCurrent = (g_attrCurrent & 0xf0) + (wAttr & 0x0f);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738
Christopher Plewright38804d62022-11-09 23:55:52 +00006739 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006740 SetConsoleTextAttribute(g_hConOut, g_attrCurrent);
6741 else
6742 vtp_sgr_bulk(wAttr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743}
6744
6745
6746 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006747textbackground(WORD wAttr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748{
Bram Moolenaar6383b922015-03-24 17:12:19 +01006749 g_attrCurrent = (g_attrCurrent & 0x0f) + ((wAttr & 0x0f) << 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750
Christopher Plewright38804d62022-11-09 23:55:52 +00006751 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006752 SetConsoleTextAttribute(g_hConOut, g_attrCurrent);
6753 else
6754 vtp_sgr_bulk(wAttr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755}
6756
6757
6758/*
6759 * restore the default text attribute (whatever we started with)
6760 */
6761 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006762normvideo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763{
Christopher Plewright38804d62022-11-09 23:55:52 +00006764 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006765 textattr(g_attrDefault);
6766 else
6767 vtp_sgr_bulk(0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768}
6769
6770
6771static WORD g_attrPreStandout = 0;
6772
6773/*
6774 * Make the text standout, by brightening it
6775 */
6776 static void
6777standout(void)
6778{
6779 g_attrPreStandout = g_attrCurrent;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006780
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 textattr((WORD) (g_attrCurrent|FOREGROUND_INTENSITY|BACKGROUND_INTENSITY));
6782}
6783
6784
6785/*
6786 * Turn off standout mode
6787 */
6788 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006789standend(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790{
6791 if (g_attrPreStandout)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 textattr(g_attrPreStandout);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006793
6794 g_attrPreStandout = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795}
6796
6797
6798/*
Bram Moolenaarff1d0d42007-05-10 17:24:16 +00006799 * Set normal fg/bg color, based on T_ME. Called when t_me has been set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 */
6801 void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006802mch_set_normal_colors(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803{
6804 char_u *p;
6805 int n;
6806
6807 cterm_normal_fg_color = (g_attrDefault & 0xf) + 1;
6808 cterm_normal_bg_color = ((g_attrDefault >> 4) & 0xf) + 1;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006809 if (
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006810# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006811 !p_tgc &&
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006812# endif
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006813 T_ME[0] == ESC && T_ME[1] == '|')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 {
6815 p = T_ME + 2;
6816 n = getdigits(&p);
6817 if (*p == 'm' && n > 0)
6818 {
6819 cterm_normal_fg_color = (n & 0xf) + 1;
6820 cterm_normal_bg_color = ((n >> 4) & 0xf) + 1;
6821 }
6822 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006823# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006824 cterm_normal_fg_gui_color = INVALCOLOR;
6825 cterm_normal_bg_gui_color = INVALCOLOR;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006826# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827}
6828
6829
6830/*
6831 * visual bell: flash the screen
6832 */
6833 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006834visual_bell(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835{
6836 COORD coordOrigin = {0, 0};
6837 WORD attrFlash = ~g_attrCurrent & 0xff;
6838
6839 DWORD dwDummy;
Christopher Plewrightdc7179f2023-01-23 12:33:23 +00006840 LPWORD oldattrs = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841
Christopher Plewrightdc7179f2023-01-23 12:33:23 +00006842# ifdef FEAT_TERMGUICOLORS
6843 if (!(p_tgc || t_colors >= 256))
6844# endif
6845 {
6846 oldattrs = ALLOC_MULT(WORD, Rows * Columns);
6847 if (oldattrs == NULL)
6848 return;
6849 ReadConsoleOutputAttribute(g_hConOut, oldattrs, Rows * Columns,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 coordOrigin, &dwDummy);
Christopher Plewrightdc7179f2023-01-23 12:33:23 +00006851 }
6852
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 FillConsoleOutputAttribute(g_hConOut, attrFlash, Rows * Columns,
6854 coordOrigin, &dwDummy);
6855
Bram Moolenaar0f873732019-12-05 20:28:46 +01006856 Sleep(15); // wait for 15 msec
Christopher Plewrightdc7179f2023-01-23 12:33:23 +00006857
6858 if (oldattrs != NULL)
6859 {
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006860 WriteConsoleOutputAttribute(g_hConOut, oldattrs, Rows * Columns,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 coordOrigin, &dwDummy);
Christopher Plewrightdc7179f2023-01-23 12:33:23 +00006862 vim_free(oldattrs);
6863 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864}
6865
6866
6867/*
6868 * Make the cursor visible or invisible
6869 */
6870 static void
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00006871cursor_visible(BOOL fVisible)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872{
6873 s_cursor_visible = fVisible;
Bram Moolenaar2695de62020-04-17 21:13:01 +02006874
Christopher Plewright38804d62022-11-09 23:55:52 +00006875 if (vtp_working)
Bram Moolenaar2695de62020-04-17 21:13:01 +02006876 vtp_printf("\033[?25%c", fVisible ? 'h' : 'l');
6877
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006878# ifdef MCH_CURSOR_SHAPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 mch_update_cursor();
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01006880# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881}
6882
6883
6884/*
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006885 * Write "cbToWrite" bytes in `pchBuf' to the screen.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006886 * Returns the number of bytes actually written (at least one).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 */
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006888 static DWORD
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889write_chars(
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006890 char_u *pchBuf,
6891 DWORD cbToWrite)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006893 COORD coord = g_coord;
6894 DWORD written;
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006895 DWORD n, cchwritten;
6896 static DWORD cells;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006897 static WCHAR *unicodebuf = NULL;
6898 static int unibuflen = 0;
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006899 static int length;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006900 int cp = enc_utf8 ? CP_UTF8 : enc_codepage;
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006901 static WCHAR *utf8spbuf = NULL;
6902 static int utf8splength;
6903 static DWORD utf8spcells;
6904 static WCHAR **utf8usingbuf = &unicodebuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006906 if (cbToWrite != 1 || *pchBuf != ' ' || !enc_utf8)
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006907 {
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006908 utf8usingbuf = &unicodebuf;
6909 do
6910 {
6911 length = MultiByteToWideChar(cp, 0, (LPCSTR)pchBuf, cbToWrite,
6912 unicodebuf, unibuflen);
6913 if (length && length <= unibuflen)
6914 break;
6915 vim_free(unicodebuf);
6916 unicodebuf = length ? LALLOC_MULT(WCHAR, length) : NULL;
6917 unibuflen = unibuflen ? 0 : length;
Bram Moolenaarc9471b12023-05-09 15:00:00 +01006918 } while (TRUE);
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006919 cells = mb_string2cells(pchBuf, cbToWrite);
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006920 }
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006921 else // cbToWrite == 1 && *pchBuf == ' ' && enc_utf8
6922 {
6923 if (utf8usingbuf != &utf8spbuf)
6924 {
6925 if (utf8spbuf == NULL)
6926 {
6927 cells = mb_string2cells((char_u *)" ", 1);
6928 length = MultiByteToWideChar(CP_UTF8, 0, " ", 1, NULL, 0);
6929 utf8spbuf = LALLOC_MULT(WCHAR, length);
6930 if (utf8spbuf != NULL)
6931 {
6932 MultiByteToWideChar(CP_UTF8, 0, " ", 1, utf8spbuf, length);
6933 utf8usingbuf = &utf8spbuf;
6934 utf8splength = length;
6935 utf8spcells = cells;
6936 }
6937 }
6938 else
6939 {
6940 utf8usingbuf = &utf8spbuf;
6941 length = utf8splength;
6942 cells = utf8spcells;
6943 }
6944 }
6945 }
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006946
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00006947 if (!USE_VTP)
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006948 {
6949 FillConsoleOutputAttribute(g_hConOut, g_attrCurrent, cells,
6950 coord, &written);
6951 // When writing fails or didn't write a single character, pretend one
6952 // character was written, otherwise we get stuck.
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006953 if (WriteConsoleOutputCharacterW(g_hConOut, *utf8usingbuf, length,
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006954 coord, &cchwritten) == 0
6955 || cchwritten == 0 || cchwritten == (DWORD)-1)
6956 cchwritten = 1;
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006957 }
6958 else
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006959 {
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006960 if (WriteConsoleW(g_hConOut, *utf8usingbuf, length, &cchwritten,
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006961 NULL) == 0 || cchwritten == 0)
6962 cchwritten = 1;
6963 }
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006964
K.Takata135e1522022-01-29 15:27:58 +00006965 if (cchwritten == (DWORD)length)
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02006966 {
6967 written = cbToWrite;
6968 g_coord.X += (SHORT)cells;
6969 }
6970 else
6971 {
6972 char_u *p = pchBuf;
6973 for (n = 0; n < cchwritten; n++)
6974 MB_CPTR_ADV(p);
6975 written = p - pchBuf;
6976 g_coord.X += (SHORT)mb_string2cells(pchBuf, written);
Bram Moolenaarac360bf2015-09-01 20:31:20 +02006977 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978
6979 while (g_coord.X > g_srScrollRegion.Right)
6980 {
6981 g_coord.X -= (SHORT) Columns;
6982 if (g_coord.Y < g_srScrollRegion.Bottom)
6983 g_coord.Y++;
6984 }
6985
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006986 // Cursor under VTP is always in the correct position, no need to reset.
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00006987 if (!USE_VTP)
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006988 gotoxy(g_coord.X + 1, g_coord.Y + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989
6990 return written;
6991}
6992
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02006993 static char_u *
6994get_seq(
6995 int *args,
6996 int *count,
6997 char_u *head)
6998{
6999 int argc;
7000 char_u *p;
7001
7002 if (head == NULL || *head != '\033')
7003 return NULL;
7004
7005 argc = 0;
7006 p = head;
7007 ++p;
7008 do
7009 {
7010 ++p;
7011 args[argc] = getdigits(&p);
7012 argc += (argc < 15) ? 1 : 0;
7013 } while (*p == ';');
7014 *count = argc;
7015
7016 return p;
7017}
7018
7019 static char_u *
7020get_sgr(
7021 int *args,
7022 int *count,
7023 char_u *head)
7024{
7025 char_u *p = get_seq(args, count, head);
7026
7027 return (p && *p == 'm') ? ++p : NULL;
7028}
7029
7030/*
7031 * Pointer to next if SGR (^[[n;2;*;*;*m), NULL otherwise.
7032 */
7033 static char_u *
7034sgrn2(
7035 char_u *head,
7036 int n)
7037{
7038 int argc;
7039 int args[16];
7040 char_u *p = get_sgr(args, &argc, head);
7041
7042 return p && argc == 5 && args[0] == n && args[1] == 2 ? p : NULL;
7043}
7044
7045/*
7046 * Pointer to next if SGR(^[[nm)<space>ESC, NULL otherwise.
7047 */
7048 static char_u *
7049sgrnc(
7050 char_u *head,
7051 int n)
7052{
7053 int argc;
7054 int args[16];
7055 char_u *p = get_sgr(args, &argc, head);
7056
7057 return p && argc == 1 && args[0] == n && (p = skipwhite(p)) && *p == '\033'
7058 ? p : NULL;
7059}
7060
7061 static char_u *
7062skipblank(char_u *q)
7063{
7064 char_u *p = q;
7065
7066 while (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r')
7067 ++p;
7068 return p;
7069}
7070
7071/*
7072 * Pointer to the next if any whitespace that may follow SGR is ESC, otherwise
7073 * NULL.
7074 */
7075 static char_u *
7076sgrn2c(
7077 char_u *head,
7078 int n)
7079{
7080 char_u *p = sgrn2(head, n);
7081
7082 return p && *p != NUL && (p = skipblank(p)) && *p == '\033' ? p : NULL;
7083}
7084
7085/*
7086 * If there is only a newline between the sequence immediately following it,
7087 * a pointer to the character following the newline is returned.
7088 * Otherwise NULL.
7089 */
7090 static char_u *
7091sgrn2cn(
7092 char_u *head,
7093 int n)
7094{
7095 char_u *p = sgrn2(head, n);
7096
7097 return p && p[0] == 0x0a && p[1] == '\033' ? ++p : NULL;
7098}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099
7100/*
7101 * mch_write(): write the output buffer to the screen, translating ESC
7102 * sequences into calls to console output routines.
7103 */
7104 void
7105mch_write(
7106 char_u *s,
7107 int len)
7108{
Bram Moolenaard23f8bd2021-04-21 11:30:48 +02007109 char_u *end = s + len;
7110
Bram Moolenaarafde13b2019-04-28 19:46:49 +02007111# ifdef VIMDLL
7112 if (gui.in_use)
7113 return;
7114# endif
7115
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 if (!term_console)
7117 {
7118 write(1, s, (unsigned)len);
7119 return;
7120 }
7121
Bram Moolenaar0f873732019-12-05 20:28:46 +01007122 // translate ESC | sequences into faked bios calls
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 while (len--)
7124 {
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007125 int prefix = -1;
7126 char_u ch;
7127
7128 // While processing a sequence, on rare occasions it seems that another
7129 // sequence may be inserted asynchronously.
7130 if (len < 0)
7131 {
Bram Moolenaara4d158b2022-08-14 14:17:45 +01007132 redraw_all_later(UPD_CLEAR);
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007133 return;
7134 }
7135
Bram Moolenaard23f8bd2021-04-21 11:30:48 +02007136 while (s + ++prefix < end)
7137 {
7138 ch = s[prefix];
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007139 if (ch <= 0x1e && !(ch != '\n' && ch != '\r' && ch != '\b'
7140 && ch != '\a' && ch != '\033'))
7141 break;
Bram Moolenaard23f8bd2021-04-21 11:30:48 +02007142 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143
7144 if (p_wd)
7145 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02007146 WaitForChar(p_wd, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 if (prefix != 0)
7148 prefix = 1;
7149 }
7150
7151 if (prefix != 0)
7152 {
7153 DWORD nWritten;
7154
7155 nWritten = write_chars(s, prefix);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007156# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 if (fdDump)
7158 {
7159 fputc('>', fdDump);
7160 fwrite(s, sizeof(char_u), nWritten, fdDump);
7161 fputs("<\n", fdDump);
7162 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007163# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 len -= (nWritten - 1);
7165 s += nWritten;
7166 }
7167 else if (s[0] == '\n')
7168 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007169 // \n, newline: go to the beginning of the next line or scroll
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 if (g_coord.Y == g_srScrollRegion.Bottom)
7171 {
7172 scroll(1);
7173 gotoxy(g_srScrollRegion.Left + 1, g_srScrollRegion.Bottom + 1);
7174 }
7175 else
7176 {
7177 gotoxy(g_srScrollRegion.Left + 1, g_coord.Y + 2);
7178 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007179# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 if (fdDump)
7181 fputs("\\n\n", fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007182# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 s++;
7184 }
7185 else if (s[0] == '\r')
7186 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007187 // \r, carriage return: go to beginning of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 gotoxy(g_srScrollRegion.Left+1, g_coord.Y + 1);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007189# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 if (fdDump)
7191 fputs("\\r\n", fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007192# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 s++;
7194 }
7195 else if (s[0] == '\b')
7196 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007197 // \b, backspace: move cursor one position left
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 if (g_coord.X > g_srScrollRegion.Left)
7199 g_coord.X--;
7200 else if (g_coord.Y > g_srScrollRegion.Top)
7201 {
7202 g_coord.X = g_srScrollRegion.Right;
7203 g_coord.Y--;
7204 }
7205 gotoxy(g_coord.X + 1, g_coord.Y + 1);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007206# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 if (fdDump)
7208 fputs("\\b\n", fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007209# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 s++;
7211 }
7212 else if (s[0] == '\a')
7213 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007214 // \a, bell
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 MessageBeep(0xFFFFFFFF);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007216# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 if (fdDump)
7218 fputs("\\a\n", fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007219# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 s++;
7221 }
7222 else if (s[0] == ESC && len >= 3-1 && s[1] == '|')
7223 {
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007224# ifdef MCH_WRITE_DUMP
Bram Moolenaarc0197e22004-09-13 20:26:32 +00007225 char_u *old_s = s;
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007226# endif
Bram Moolenaarc0197e22004-09-13 20:26:32 +00007227 char_u *p;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007228 int arg1 = 0, arg2 = 0, argc = 0, args[16];
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007229 char_u *sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230
7231 switch (s[2])
7232 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 case '0': case '1': case '2': case '3': case '4':
7234 case '5': case '6': case '7': case '8': case '9':
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007235 if (*(p = get_seq(args, &argc, s)) != 'm')
7236 goto notsgr;
7237
7238 p = s;
7239
7240 // Handling frequent optional sequences. Output to the screen
7241 // takes too long, so do not output as much as possible.
7242
7243 // If resetFG,FG,BG,<cr>,BG,FG are connected, the preceding
7244 // resetFG,FG,BG are omitted.
7245 if (sgrn2(sgrn2(sgrn2cn(sgrn2(sgrnc(p, 39), 38), 48), 48), 38))
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007246 {
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007247 p = sgrn2(sgrn2(sgrnc(p, 39), 38), 48);
7248 len = len + 1 - (int)(p - s);
7249 s = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 break;
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007251 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007253 // If FG,BG,BG,FG of SGR are connected, the first FG can be
7254 // omitted.
7255 if (sgrn2(sgrn2(sgrn2c((sp = sgrn2(p, 38)), 48), 48), 38))
7256 p = sp;
7257
7258 // If FG,BG,FG,BG of SGR are connected, the first FG can be
7259 // omitted.
7260 if (sgrn2(sgrn2(sgrn2c((sp = sgrn2(p, 38)), 48), 38), 48))
7261 p = sp;
7262
7263 // If BG,BG of SGR are connected, the first BG can be omitted.
7264 if (sgrn2((sp = sgrn2(p, 48)), 48))
7265 p = sp;
7266
7267 // If restoreFG and FG are connected, the restoreFG can be
Bram Moolenaar9f1983d2022-05-12 20:35:35 +01007268 // omitted.
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02007269 if (sgrn2((sp = sgrnc(p, 39)), 38))
7270 p = sp;
7271
7272 p = get_seq(args, &argc, p);
7273
7274notsgr:
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007275 arg1 = args[0];
7276 arg2 = args[1];
7277 if (*p == 'm')
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 {
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007279 if (argc == 1 && args[0] == 0)
7280 normvideo();
7281 else if (argc == 1)
7282 {
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00007283 if (USE_VTP)
Christopher Plewright38804d62022-11-09 23:55:52 +00007284 textcolor((WORD)arg1);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007285 else
Christopher Plewright38804d62022-11-09 23:55:52 +00007286 textattr((WORD)arg1);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007287 }
Christopher Plewright38804d62022-11-09 23:55:52 +00007288 else if (vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007289 vtp_sgr_bulks(argc, args);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007291 else if (argc == 2 && *p == 'H')
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 {
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007293 gotoxy(arg2, arg1);
7294 }
7295 else if (argc == 2 && *p == 'r')
7296 {
7297 set_scroll_region(0, arg1 - 1, Columns - 1, arg2 - 1);
7298 }
Bram Moolenaar6982f422019-02-16 16:48:01 +01007299 else if (argc == 2 && *p == 'R')
7300 {
7301 set_scroll_region_tb(arg1, arg2);
7302 }
7303 else if (argc == 2 && *p == 'V')
7304 {
7305 set_scroll_region_lr(arg1, arg2);
7306 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007307 else if (argc == 1 && *p == 'A')
7308 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 gotoxy(g_coord.X + 1,
7310 max(g_srScrollRegion.Top, g_coord.Y - arg1) + 1);
7311 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007312 else if (argc == 1 && *p == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 {
7314 textbackground((WORD) arg1);
7315 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007316 else if (argc == 1 && *p == 'C')
7317 {
7318 gotoxy(min(g_srScrollRegion.Right, g_coord.X + arg1) + 1,
7319 g_coord.Y + 1);
7320 }
7321 else if (argc == 1 && *p == 'f')
7322 {
7323 textcolor((WORD) arg1);
7324 }
7325 else if (argc == 1 && *p == 'H')
7326 {
7327 gotoxy(1, arg1);
7328 }
7329 else if (argc == 1 && *p == 'L')
7330 {
7331 insert_lines(arg1);
7332 }
7333 else if (argc == 1 && *p == 'M')
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 {
7335 delete_lines(arg1);
7336 }
7337
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007338 len -= (int)(p - s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 s = p + 1;
7340 break;
7341
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 case 'A':
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 gotoxy(g_coord.X + 1,
7344 max(g_srScrollRegion.Top, g_coord.Y - 1) + 1);
7345 goto got3;
7346
7347 case 'B':
7348 visual_bell();
7349 goto got3;
7350
7351 case 'C':
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352 gotoxy(min(g_srScrollRegion.Right, g_coord.X + 1) + 1,
7353 g_coord.Y + 1);
7354 goto got3;
7355
7356 case 'E':
7357 termcap_mode_end();
7358 goto got3;
7359
7360 case 'F':
7361 standout();
7362 goto got3;
7363
7364 case 'f':
7365 standend();
7366 goto got3;
7367
7368 case 'H':
7369 gotoxy(1, 1);
7370 goto got3;
7371
7372 case 'j':
7373 clear_to_end_of_display();
7374 goto got3;
7375
7376 case 'J':
7377 clear_screen();
7378 goto got3;
7379
7380 case 'K':
7381 clear_to_end_of_line();
7382 goto got3;
7383
7384 case 'L':
7385 insert_lines(1);
7386 goto got3;
7387
7388 case 'M':
7389 delete_lines(1);
7390 goto got3;
7391
7392 case 'S':
7393 termcap_mode_start();
7394 goto got3;
7395
7396 case 'V':
7397 cursor_visible(TRUE);
7398 goto got3;
7399
7400 case 'v':
7401 cursor_visible(FALSE);
7402 goto got3;
7403
7404 got3:
7405 s += 3;
7406 len -= 2;
7407 }
7408
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007409# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 if (fdDump)
7411 {
7412 fputs("ESC | ", fdDump);
7413 fwrite(old_s + 2, sizeof(char_u), s - old_s - 2, fdDump);
7414 fputc('\n', fdDump);
7415 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007416# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 }
K.Takatadf5320c2022-09-01 13:20:16 +01007418 else if (s[0] == ESC && len >= 3-1 && s[1] == '[')
7419 {
7420 int l = 2;
7421
Keith Thompson184f71c2024-01-04 21:19:04 +01007422 if (SAFE_isdigit(s[l]))
K.Takatadf5320c2022-09-01 13:20:16 +01007423 l++;
7424 if (s[l] == ' ' && s[l + 1] == 'q')
7425 {
7426 // DECSCUSR (cursor style) sequences
Christopher Plewright38804d62022-11-09 23:55:52 +00007427 if (vtp_working)
K.Takatadf5320c2022-09-01 13:20:16 +01007428 vtp_printf("%.*s", l + 2, s); // Pass through
7429 s += l + 2;
7430 len -= l + 1;
7431 }
7432 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 else
7434 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007435 // Write a single character
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 DWORD nWritten;
7437
7438 nWritten = write_chars(s, 1);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007439# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 if (fdDump)
7441 {
7442 fputc('>', fdDump);
7443 fwrite(s, sizeof(char_u), nWritten, fdDump);
7444 fputs("<\n", fdDump);
7445 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007446# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447
7448 len -= (nWritten - 1);
7449 s += nWritten;
7450 }
7451 }
7452
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007453# ifdef MCH_WRITE_DUMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 if (fdDump)
7455 fflush(fdDump);
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01007456# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457}
7458
Bram Moolenaar0f873732019-12-05 20:28:46 +01007459#endif // FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460
7461
7462/*
Bram Moolenaar0e0b3dd2016-03-17 17:58:56 +01007463 * Delay for "msec" milliseconds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 */
7465 void
7466mch_delay(
7467 long msec,
Bram Moolenaar0981c872020-08-23 14:28:37 +02007468 int flags UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469{
Bram Moolenaarafde13b2019-04-28 19:46:49 +02007470#if defined(FEAT_GUI_MSWIN) && !defined(VIMDLL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007471 Sleep((int)msec); // never wait for input
7472#else // Console
Bram Moolenaarafde13b2019-04-28 19:46:49 +02007473# ifdef VIMDLL
7474 if (gui.in_use)
7475 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007476 Sleep((int)msec); // never wait for input
Bram Moolenaarafde13b2019-04-28 19:46:49 +02007477 return;
7478 }
7479# endif
Bram Moolenaar0981c872020-08-23 14:28:37 +02007480 if (flags & MCH_DELAY_IGNOREINPUT)
Bram Moolenaar325b7a22004-07-05 15:58:32 +00007481# ifdef FEAT_MZSCHEME
7482 if (mzthreads_allowed() && p_mzq > 0 && msec > p_mzq)
7483 {
7484 int towait = p_mzq;
7485
Bram Moolenaar0f873732019-12-05 20:28:46 +01007486 // if msec is large enough, wait by portions in p_mzq
Bram Moolenaar325b7a22004-07-05 15:58:32 +00007487 while (msec > 0)
7488 {
7489 mzvim_check_threads();
7490 if (msec < towait)
7491 towait = msec;
7492 Sleep(towait);
7493 msec -= towait;
7494 }
7495 }
7496 else
7497# endif
7498 Sleep((int)msec);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02007500 WaitForChar(msec, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501#endif
7502}
7503
7504
7505/*
Bram Moolenaar203258c2016-01-17 22:15:16 +01007506 * This version of remove is not scared by a readonly (backup) file.
7507 * This can also remove a symbolic link like Unix.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 * Return 0 for success, -1 for failure.
7509 */
7510 int
7511mch_remove(char_u *name)
7512{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007513 WCHAR *wn;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 int n;
7515
Bram Moolenaar203258c2016-01-17 22:15:16 +01007516 /*
7517 * On Windows, deleting a directory's symbolic link is done by
7518 * RemoveDirectory(): mch_rmdir. It seems unnatural, but it is fact.
7519 */
7520 if (mch_isdir(name) && mch_is_symbolic_link(name))
7521 return mch_rmdir(name);
7522
Bram Moolenaar12b559e2013-06-12 22:41:37 +02007523 win32_setattrs(name, FILE_ATTRIBUTE_NORMAL);
7524
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007525 wn = enc_to_utf16(name, NULL);
7526 if (wn == NULL)
7527 return -1;
7528
7529 n = DeleteFileW(wn) ? 0 : -1;
7530 vim_free(wn);
7531 return n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532}
7533
7534
7535/*
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02007536 * Check for an "interrupt signal": CTRL-break or CTRL-C.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 */
7538 void
Bram Moolenaarbd67aac2019-09-21 23:09:04 +02007539mch_breakcheck(int force UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540{
Bram Moolenaarafde13b2019-04-28 19:46:49 +02007541#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
7542# ifdef VIMDLL
7543 if (!gui.in_use)
7544# endif
7545 if (g_fCtrlCPressed || g_fCBrkPressed)
7546 {
7547 ctrl_break_was_pressed = g_fCBrkPressed;
7548 g_fCtrlCPressed = g_fCBrkPressed = FALSE;
7549 got_int = TRUE;
7550 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551#endif
7552}
7553
Bram Moolenaar0f873732019-12-05 20:28:46 +01007554// physical RAM to leave for the OS
Bram Moolenaaree273972016-01-02 21:11:51 +01007555#define WINNT_RESERVE_BYTES (256*1024*1024)
Bram Moolenaaree273972016-01-02 21:11:51 +01007556
7557/*
7558 * How much main memory in KiB that can be used by VIM.
7559 */
Bram Moolenaaree273972016-01-02 21:11:51 +01007560 long_u
Bram Moolenaar1266d672017-02-01 13:43:36 +01007561mch_total_mem(int special UNUSED)
Bram Moolenaaree273972016-01-02 21:11:51 +01007562{
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007563 MEMORYSTATUSEX ms;
7564
Bram Moolenaar0f873732019-12-05 20:28:46 +01007565 // Need to use GlobalMemoryStatusEx() when there is more memory than
7566 // what fits in 32 bits.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007567 ms.dwLength = sizeof(MEMORYSTATUSEX);
7568 GlobalMemoryStatusEx(&ms);
7569 if (ms.ullAvailVirtual < ms.ullTotalPhys)
Bram Moolenaaree273972016-01-02 21:11:51 +01007570 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007571 // Process address space fits in physical RAM, use all of it.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007572 return (long_u)(ms.ullAvailVirtual / 1024);
Bram Moolenaaree273972016-01-02 21:11:51 +01007573 }
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007574 if (ms.ullTotalPhys <= WINNT_RESERVE_BYTES)
Bram Moolenaaree273972016-01-02 21:11:51 +01007575 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007576 // Catch old NT box or perverse hardware setup.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007577 return (long_u)((ms.ullTotalPhys / 2) / 1024);
Bram Moolenaaree273972016-01-02 21:11:51 +01007578 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007579 // Use physical RAM less reserve for OS + data.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007580 return (long_u)((ms.ullTotalPhys - WINNT_RESERVE_BYTES) / 1024);
Bram Moolenaaree273972016-01-02 21:11:51 +01007581}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583/*
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007584 * mch_wrename() works around a bug in rename (aka MoveFile) in
Nir Lichtman563e8ec2024-09-30 19:42:28 +02007585 * Windows, the bug can be demonstrated with the following scenario:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 * When renaming "abcdef~1.txt" to "abcdef~1.txt~", the short name can be
Nir Lichtman563e8ec2024-09-30 19:42:28 +02007587 * "abcdef~1.txt" again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 *
7589 * Like rename(), returns 0 upon success, non-zero upon failure.
7590 * Should probably set errno appropriately when errors occur.
7591 */
7592 int
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007593mch_wrename(WCHAR *wold, WCHAR *wnew)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594{
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007595 WCHAR *p;
7596 int i;
7597 WCHAR szTempFile[_MAX_PATH + 1];
7598 WCHAR szNewPath[_MAX_PATH + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 HANDLE hf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007601 // No need to play tricks unless the file name contains a "~" as the
7602 // seventh character.
7603 p = wold;
7604 for (i = 0; wold[i] != NUL; ++i)
7605 if ((wold[i] == '/' || wold[i] == '\\' || wold[i] == ':')
7606 && wold[i + 1] != 0)
7607 p = wold + i + 1;
7608 if ((int)(wold + i - p) < 8 || p[6] != '~')
7609 return (MoveFileW(wold, wnew) == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007611 // Get base path of new file name. Undocumented feature: If pszNewFile is
7612 // a directory, no error is returned and pszFilePart will be NULL.
7613 if (GetFullPathNameW(wnew, _MAX_PATH, szNewPath, &p) == 0 || p == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 return -1;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007615 *p = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007617 // Get (and create) a unique temporary file name in directory of new file
7618 if (GetTempFileNameW(szNewPath, L"VIM", 0, szTempFile) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619 return -2;
7620
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007621 // blow the temp file away
7622 if (!DeleteFileW(szTempFile))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 return -3;
7624
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007625 // rename old file to the temp file
7626 if (!MoveFileW(wold, szTempFile))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 return -4;
7628
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007629 // now create an empty file called pszOldFile; this prevents the operating
7630 // system using pszOldFile as an alias (SFN) if we're renaming within the
7631 // same directory. For example, we're editing a file called
7632 // filename.asc.txt by its SFN, filena~1.txt. If we rename filena~1.txt
7633 // to filena~1.txt~ (i.e., we're making a backup while writing it), the
7634 // SFN for filena~1.txt~ will be filena~1.txt, by default, which will
7635 // cause all sorts of problems later in buf_write(). So, we create an
7636 // empty file called filena~1.txt and the system will have to find some
7637 // other SFN for filena~1.txt~, such as filena~2.txt
7638 if ((hf = CreateFileW(wold, GENERIC_WRITE, 0, NULL, CREATE_NEW,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 FILE_ATTRIBUTE_NORMAL, NULL)) == INVALID_HANDLE_VALUE)
7640 return -5;
7641 if (!CloseHandle(hf))
7642 return -6;
7643
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007644 // rename the temp file to the new file
7645 if (!MoveFileW(szTempFile, wnew))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 {
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007647 // Renaming failed. Rename the file back to its old name, so that it
7648 // looks like nothing happened.
7649 (void)MoveFileW(szTempFile, wold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 return -7;
7651 }
7652
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007653 // Seems to be left around on Novell filesystems
7654 DeleteFileW(szTempFile);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007656 // finally, remove the empty old file
7657 if (!DeleteFileW(wold))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 return -8;
7659
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007660 return 0;
7661}
7662
7663
7664/*
7665 * Converts the filenames to UTF-16, then call mch_wrename().
7666 * Like rename(), returns 0 upon success, non-zero upon failure.
7667 */
7668 int
7669mch_rename(
7670 const char *pszOldFile,
7671 const char *pszNewFile)
7672{
7673 WCHAR *wold = NULL;
7674 WCHAR *wnew = NULL;
7675 int retval = -1;
7676
7677 wold = enc_to_utf16((char_u *)pszOldFile, NULL);
7678 wnew = enc_to_utf16((char_u *)pszNewFile, NULL);
7679 if (wold != NULL && wnew != NULL)
7680 retval = mch_wrename(wold, wnew);
7681 vim_free(wold);
7682 vim_free(wnew);
7683 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684}
7685
7686/*
7687 * Get the default shell for the current hardware platform
7688 */
7689 char *
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007690default_shell(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691{
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007692 return "cmd.exe";
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693}
7694
7695/*
7696 * mch_access() extends access() to do more detailed check on network drives.
7697 * Returns 0 if file "n" has access rights according to "p", -1 otherwise.
7698 */
7699 int
7700mch_access(char *n, int p)
7701{
7702 HANDLE hFile;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007703 int retval = -1; // default: fail
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007704 WCHAR *wn;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007706 wn = enc_to_utf16((char_u *)n, NULL);
7707 if (wn == NULL)
7708 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01007710 if (mch_isdir((char_u *)n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 WCHAR TempNameW[_MAX_PATH + 16] = L"";
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713
7714 if (p & R_OK)
7715 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007716 // Read check is performed by seeing if we can do a find file on
7717 // the directory for any file.
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007718 int i;
7719 WIN32_FIND_DATAW d;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007721 for (i = 0; i < _MAX_PATH && wn[i] != 0; ++i)
7722 TempNameW[i] = wn[i];
7723 if (TempNameW[i - 1] != '\\' && TempNameW[i - 1] != '/')
7724 TempNameW[i++] = '\\';
7725 TempNameW[i++] = '*';
7726 TempNameW[i++] = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007728 hFile = FindFirstFileW(TempNameW, &d);
7729 if (hFile == INVALID_HANDLE_VALUE)
7730 goto getout;
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007731 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 (void)FindClose(hFile);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 }
7734
7735 if (p & W_OK)
7736 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007737 // Trying to create a temporary file in the directory should catch
7738 // directories on read-only network shares. However, in
7739 // directories whose ACL allows writes but denies deletes will end
7740 // up keeping the temporary file :-(.
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007741 if (!GetTempFileNameW(wn, L"VIM", 0, TempNameW))
7742 goto getout;
Bram Moolenaarcea912a2016-10-12 14:20:24 +02007743 else
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007744 DeleteFileW(TempNameW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 }
7746 }
7747 else
7748 {
Bram Moolenaar5aa98962018-05-06 17:09:38 +02007749 // Don't consider a file read-only if another process has opened it.
7750 DWORD share_mode = FILE_SHARE_READ | FILE_SHARE_WRITE;
7751
Bram Moolenaar0f873732019-12-05 20:28:46 +01007752 // Trying to open the file for the required access does ACL, read-only
7753 // network share, and file attribute checks.
Bram Moolenaar5aa98962018-05-06 17:09:38 +02007754 DWORD access_mode = ((p & W_OK) ? GENERIC_WRITE : 0)
7755 | ((p & R_OK) ? GENERIC_READ : 0);
7756
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007757 hFile = CreateFileW(wn, access_mode, share_mode,
7758 NULL, OPEN_EXISTING, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 if (hFile == INVALID_HANDLE_VALUE)
7760 goto getout;
7761 CloseHandle(hFile);
7762 }
7763
Bram Moolenaar0f873732019-12-05 20:28:46 +01007764 retval = 0; // success
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765getout:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 vim_free(wn);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 return retval;
7768}
7769
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770/*
Bram Moolenaar36f692d2008-11-20 16:10:17 +00007771 * Version of open() that may use UTF-16 file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 */
7773 int
Bram Moolenaarb6843a02017-08-02 22:07:12 +02007774mch_open(const char *name, int flags, int mode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775{
7776 WCHAR *wn;
7777 int f;
7778
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007779 wn = enc_to_utf16((char_u *)name, NULL);
7780 if (wn == NULL)
7781 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007783 f = _wopen(wn, flags, mode);
7784 vim_free(wn);
7785 return f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786}
7787
7788/*
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007789 * Version of fopen() that uses UTF-16 file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 */
7791 FILE *
Bram Moolenaarb6843a02017-08-02 22:07:12 +02007792mch_fopen(const char *name, const char *mode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793{
7794 WCHAR *wn, *wm;
7795 FILE *f = NULL;
7796
Bram Moolenaara12a1612019-01-24 16:39:02 +01007797#if defined(DEBUG) && _MSC_VER >= 1400
Bram Moolenaar0f873732019-12-05 20:28:46 +01007798 // Work around an annoying assertion in the Microsoft debug CRT
7799 // when mode's text/binary setting doesn't match _get_fmode().
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007800 char newMode = mode[strlen(mode) - 1];
7801 int oldMode = 0;
Bram Moolenaar0fde2902008-03-16 13:54:13 +00007802
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007803 _get_fmode(&oldMode);
7804 if (newMode == 't')
7805 _set_fmode(_O_TEXT);
7806 else if (newMode == 'b')
7807 _set_fmode(_O_BINARY);
Bram Moolenaara12a1612019-01-24 16:39:02 +01007808#endif
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007809 wn = enc_to_utf16((char_u *)name, NULL);
7810 wm = enc_to_utf16((char_u *)mode, NULL);
7811 if (wn != NULL && wm != NULL)
7812 f = _wfopen(wn, wm);
7813 vim_free(wn);
7814 vim_free(wm);
Bram Moolenaar0fde2902008-03-16 13:54:13 +00007815
Bram Moolenaara12a1612019-01-24 16:39:02 +01007816#if defined(DEBUG) && _MSC_VER >= 1400
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007817 _set_fmode(oldMode);
Bram Moolenaara12a1612019-01-24 16:39:02 +01007818#endif
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02007819 return f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822/*
7823 * SUB STREAM (aka info stream) handling:
7824 *
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01007825 * NTFS can have sub streams for each file. The normal contents of a file is
7826 * stored in the main stream, and extra contents (author information, title and
7827 * so on) can be stored in a sub stream. After Windows 2000, the user can
7828 * access and store this information in sub streams via an explorer's property
7829 * menu item in the right click menu. This information in sub streams was lost
7830 * when copying only the main stream. Therefore we have to copy sub streams.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 *
7832 * Incomplete explanation:
7833 * http://msdn.microsoft.com/library/en-us/dnw2k/html/ntfs5.asp
7834 * More useful info and an example:
7835 * http://www.sysinternals.com/ntw2k/source/misc.shtml#streams
7836 */
7837
7838/*
7839 * Copy info stream data "substream". Read from the file with BackupRead(sh)
7840 * and write to stream "substream" of file "to".
7841 * Errors are ignored.
7842 */
7843 static void
7844copy_substream(HANDLE sh, void *context, WCHAR *to, WCHAR *substream, long len)
7845{
7846 HANDLE hTo;
7847 WCHAR *to_name;
7848
7849 to_name = malloc((wcslen(to) + wcslen(substream) + 1) * sizeof(WCHAR));
7850 wcscpy(to_name, to);
7851 wcscat(to_name, substream);
7852
7853 hTo = CreateFileW(to_name, GENERIC_WRITE, 0, NULL, OPEN_ALWAYS,
7854 FILE_ATTRIBUTE_NORMAL, NULL);
7855 if (hTo != INVALID_HANDLE_VALUE)
7856 {
7857 long done;
7858 DWORD todo;
7859 DWORD readcnt, written;
7860 char buf[4096];
7861
Bram Moolenaar0f873732019-12-05 20:28:46 +01007862 // Copy block of bytes at a time. Abort when something goes wrong.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 for (done = 0; done < len; done += written)
7864 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007865 // (size_t) cast for Borland C 5.5
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007866 todo = (DWORD)((size_t)(len - done) > sizeof(buf) ? sizeof(buf)
7867 : (size_t)(len - done));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 if (!BackupRead(sh, (LPBYTE)buf, todo, &readcnt,
7869 FALSE, FALSE, context)
7870 || readcnt != todo
7871 || !WriteFile(hTo, buf, todo, &written, NULL)
7872 || written != todo)
7873 break;
7874 }
7875 CloseHandle(hTo);
7876 }
7877
7878 free(to_name);
7879}
7880
7881/*
7882 * Copy info streams from file "from" to file "to".
7883 */
7884 static void
7885copy_infostreams(char_u *from, char_u *to)
7886{
7887 WCHAR *fromw;
7888 WCHAR *tow;
7889 HANDLE sh;
7890 WIN32_STREAM_ID sid;
7891 int headersize;
7892 WCHAR streamname[_MAX_PATH];
7893 DWORD readcount;
7894 void *context = NULL;
7895 DWORD lo, hi;
7896 int len;
7897
Bram Moolenaar0f873732019-12-05 20:28:46 +01007898 // Convert the file names to wide characters.
Bram Moolenaar36f692d2008-11-20 16:10:17 +00007899 fromw = enc_to_utf16(from, NULL);
7900 tow = enc_to_utf16(to, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 if (fromw != NULL && tow != NULL)
7902 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007903 // Open the file for reading.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 sh = CreateFileW(fromw, GENERIC_READ, FILE_SHARE_READ, NULL,
7905 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
7906 if (sh != INVALID_HANDLE_VALUE)
7907 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007908 // Use BackupRead() to find the info streams. Repeat until we
7909 // have done them all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 for (;;)
7911 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007912 // Get the header to find the length of the stream name. If
7913 // the "readcount" is zero we have done all info streams.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 ZeroMemory(&sid, sizeof(WIN32_STREAM_ID));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007915 headersize = (int)((char *)&sid.cStreamName - (char *)&sid.dwStreamId);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 if (!BackupRead(sh, (LPBYTE)&sid, headersize,
7917 &readcount, FALSE, FALSE, &context)
7918 || readcount == 0)
7919 break;
7920
Bram Moolenaar0f873732019-12-05 20:28:46 +01007921 // We only deal with streams that have a name. The normal
7922 // file data appears to be without a name, even though docs
7923 // suggest it is called "::$DATA".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 if (sid.dwStreamNameSize > 0)
7925 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007926 // Read the stream name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 if (!BackupRead(sh, (LPBYTE)streamname,
7928 sid.dwStreamNameSize,
7929 &readcount, FALSE, FALSE, &context))
7930 break;
7931
Bram Moolenaar0f873732019-12-05 20:28:46 +01007932 // Copy an info stream with a name ":anything:$DATA".
7933 // Skip "::$DATA", it has no stream name (examples suggest
7934 // it might be used for the normal file contents).
7935 // Note that BackupRead() counts bytes, but the name is in
7936 // wide characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 len = readcount / sizeof(WCHAR);
7938 streamname[len] = 0;
7939 if (len > 7 && wcsicmp(streamname + len - 6,
7940 L":$DATA") == 0)
7941 {
7942 streamname[len - 6] = 0;
7943 copy_substream(sh, &context, tow, streamname,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007944 (long)sid.Size.u.LowPart);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 }
7946 }
7947
Bram Moolenaar0f873732019-12-05 20:28:46 +01007948 // Advance to the next stream. We might try seeking too far,
7949 // but BackupSeek() doesn't skip over stream borders, thus
7950 // that's OK.
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007951 (void)BackupSeek(sh, sid.Size.u.LowPart, sid.Size.u.HighPart,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 &lo, &hi, &context);
7953 }
7954
Bram Moolenaar0f873732019-12-05 20:28:46 +01007955 // Clear the context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 (void)BackupRead(sh, NULL, 0, &readcount, TRUE, FALSE, &context);
7957
7958 CloseHandle(sh);
7959 }
7960 }
7961 vim_free(fromw);
7962 vim_free(tow);
7963}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964
7965/*
Bram Moolenaare7bebc42021-02-01 20:50:37 +01007966 * ntdll.dll definitions
7967 */
7968#define FileEaInformation 7
7969#ifndef STATUS_SUCCESS
7970# define STATUS_SUCCESS ((NTSTATUS) 0x00000000L)
7971#endif
7972
7973typedef struct _FILE_FULL_EA_INFORMATION_ {
7974 ULONG NextEntryOffset;
7975 UCHAR Flags;
7976 UCHAR EaNameLength;
7977 USHORT EaValueLength;
7978 CHAR EaName[1];
7979} FILE_FULL_EA_INFORMATION_, *PFILE_FULL_EA_INFORMATION_;
7980
7981typedef struct _FILE_EA_INFORMATION_ {
7982 ULONG EaSize;
7983} FILE_EA_INFORMATION_, *PFILE_EA_INFORMATION_;
7984
Paul Ollis65745772022-06-05 16:55:54 +01007985#ifndef PROTO
Bram Moolenaare7bebc42021-02-01 20:50:37 +01007986typedef NTSTATUS (NTAPI *PfnNtOpenFile)(
7987 PHANDLE FileHandle,
7988 ACCESS_MASK DesiredAccess,
7989 POBJECT_ATTRIBUTES ObjectAttributes,
7990 PIO_STATUS_BLOCK IoStatusBlock,
7991 ULONG ShareAccess,
7992 ULONG OpenOptions);
7993typedef NTSTATUS (NTAPI *PfnNtClose)(
7994 HANDLE Handle);
7995typedef NTSTATUS (NTAPI *PfnNtSetEaFile)(
Bram Moolenaar9f1983d2022-05-12 20:35:35 +01007996 HANDLE FileHandle,
7997 PIO_STATUS_BLOCK IoStatusBlock,
7998 PVOID Buffer,
7999 ULONG Length);
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008000typedef NTSTATUS (NTAPI *PfnNtQueryEaFile)(
8001 HANDLE FileHandle,
8002 PIO_STATUS_BLOCK IoStatusBlock,
8003 PVOID Buffer,
8004 ULONG Length,
8005 BOOLEAN ReturnSingleEntry,
8006 PVOID EaList,
8007 ULONG EaListLength,
8008 PULONG EaIndex,
8009 BOOLEAN RestartScan);
8010typedef NTSTATUS (NTAPI *PfnNtQueryInformationFile)(
Bram Moolenaar9f1983d2022-05-12 20:35:35 +01008011 HANDLE FileHandle,
8012 PIO_STATUS_BLOCK IoStatusBlock,
8013 PVOID FileInformation,
8014 ULONG Length,
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008015 FILE_INFORMATION_CLASS FileInformationClass);
8016typedef VOID (NTAPI *PfnRtlInitUnicodeString)(
8017 PUNICODE_STRING DestinationString,
8018 PCWSTR SourceString);
8019
8020PfnNtOpenFile pNtOpenFile = NULL;
8021PfnNtClose pNtClose = NULL;
8022PfnNtSetEaFile pNtSetEaFile = NULL;
8023PfnNtQueryEaFile pNtQueryEaFile = NULL;
8024PfnNtQueryInformationFile pNtQueryInformationFile = NULL;
8025PfnRtlInitUnicodeString pRtlInitUnicodeString = NULL;
Paul Ollis65745772022-06-05 16:55:54 +01008026#endif
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008027
8028/*
8029 * Load ntdll.dll functions.
8030 */
8031 static BOOL
8032load_ntdll(void)
8033{
8034 static int loaded = -1;
8035
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008036 if (loaded != -1)
8037 return (BOOL) loaded;
8038
8039 HMODULE hNtdll = GetModuleHandle("ntdll.dll");
8040 if (hNtdll != NULL)
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008041 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008042 pNtOpenFile = (PfnNtOpenFile) GetProcAddress(hNtdll, "NtOpenFile");
8043 pNtClose = (PfnNtClose) GetProcAddress(hNtdll, "NtClose");
8044 pNtSetEaFile = (PfnNtSetEaFile)
8045 GetProcAddress(hNtdll, "NtSetEaFile");
8046 pNtQueryEaFile = (PfnNtQueryEaFile)
8047 GetProcAddress(hNtdll, "NtQueryEaFile");
8048 pNtQueryInformationFile = (PfnNtQueryInformationFile)
8049 GetProcAddress(hNtdll, "NtQueryInformationFile");
8050 pRtlInitUnicodeString = (PfnRtlInitUnicodeString)
8051 GetProcAddress(hNtdll, "RtlInitUnicodeString");
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008052 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008053 if (pNtOpenFile == NULL
8054 || pNtClose == NULL
8055 || pNtSetEaFile == NULL
8056 || pNtQueryEaFile == NULL
8057 || pNtQueryInformationFile == NULL
8058 || pRtlInitUnicodeString == NULL)
8059 loaded = FALSE;
8060 else
8061 loaded = TRUE;
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008062 return (BOOL) loaded;
8063}
8064
8065/*
8066 * Copy extended attributes (EA) from file "from" to file "to".
8067 */
8068 static void
8069copy_extattr(char_u *from, char_u *to)
8070{
8071 char_u *fromf = NULL;
8072 char_u *tof = NULL;
8073 WCHAR *fromw = NULL;
8074 WCHAR *tow = NULL;
8075 UNICODE_STRING u;
8076 HANDLE h;
8077 OBJECT_ATTRIBUTES oa;
8078 IO_STATUS_BLOCK iosb;
8079 FILE_EA_INFORMATION_ eainfo = {0};
8080 void *ea = NULL;
8081
8082 if (!load_ntdll())
8083 return;
8084
8085 // Convert the file names to the fully qualified object names.
8086 fromf = alloc(STRLEN(from) + 5);
8087 tof = alloc(STRLEN(to) + 5);
8088 if (fromf == NULL || tof == NULL)
8089 goto theend;
8090 STRCPY(fromf, "\\??\\");
8091 STRCAT(fromf, from);
8092 STRCPY(tof, "\\??\\");
8093 STRCAT(tof, to);
8094
8095 // Convert the names to wide characters.
8096 fromw = enc_to_utf16(fromf, NULL);
8097 tow = enc_to_utf16(tof, NULL);
8098 if (fromw == NULL || tow == NULL)
8099 goto theend;
8100
8101 // Get the EA.
8102 pRtlInitUnicodeString(&u, fromw);
8103 InitializeObjectAttributes(&oa, &u, 0, NULL, NULL);
8104 if (pNtOpenFile(&h, FILE_READ_EA, &oa, &iosb, 0,
8105 FILE_NON_DIRECTORY_FILE) != STATUS_SUCCESS)
8106 goto theend;
8107 pNtQueryInformationFile(h, &iosb, &eainfo, sizeof(eainfo),
8108 FileEaInformation);
8109 if (eainfo.EaSize != 0)
8110 {
8111 ea = alloc(eainfo.EaSize);
8112 if (ea != NULL)
8113 {
8114 if (pNtQueryEaFile(h, &iosb, ea, eainfo.EaSize, FALSE,
8115 NULL, 0, NULL, TRUE) != STATUS_SUCCESS)
8116 {
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00008117 VIM_CLEAR(ea);
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008118 }
8119 }
8120 }
8121 pNtClose(h);
8122
8123 // Set the EA.
8124 if (ea != NULL)
8125 {
8126 pRtlInitUnicodeString(&u, tow);
8127 InitializeObjectAttributes(&oa, &u, 0, NULL, NULL);
8128 if (pNtOpenFile(&h, FILE_WRITE_EA, &oa, &iosb, 0,
8129 FILE_NON_DIRECTORY_FILE) != STATUS_SUCCESS)
8130 goto theend;
8131
8132 pNtSetEaFile(h, &iosb, ea, eainfo.EaSize);
8133 pNtClose(h);
8134 }
8135
8136theend:
8137 vim_free(fromf);
8138 vim_free(tof);
8139 vim_free(fromw);
8140 vim_free(tow);
8141 vim_free(ea);
8142}
8143
8144/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 * Copy file attributes from file "from" to file "to".
8146 * For Windows NT and later we copy info streams.
8147 * Always returns zero, errors are ignored.
8148 */
8149 int
8150mch_copy_file_attribute(char_u *from, char_u *to)
8151{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008152 // File streams only work on Windows NT and later.
Bram Moolenaarcea912a2016-10-12 14:20:24 +02008153 copy_infostreams(from, to);
Bram Moolenaare7bebc42021-02-01 20:50:37 +01008154 copy_extattr(from, to);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 return 0;
8156}
8157
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008158
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008159/*
K.Takatadc73b4b2021-06-08 18:32:36 +02008160 * The command line arguments in UTF-16
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008161 */
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008162static int nArgsW = 0;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008163static LPWSTR *ArglistW = NULL;
8164static int global_argc = 0;
8165static char **global_argv;
8166
Bram Moolenaar0f873732019-12-05 20:28:46 +01008167static int used_file_argc = 0; // last argument in global_argv[] used
8168 // for the argument list.
8169static int *used_file_indexes = NULL; // indexes in global_argv[] for
8170 // command line arguments added to
8171 // the argument list
8172static int used_file_count = 0; // nr of entries in used_file_indexes
8173static int used_file_literal = FALSE; // take file names literally
8174static int used_file_full_path = FALSE; // file name was full path
8175static int used_file_diff_mode = FALSE; // file name was with diff mode
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008176static int used_alist_count = 0;
8177
8178
8179/*
8180 * Get the command line arguments. Unicode version.
8181 * Returns argc. Zero when something fails.
8182 */
8183 int
8184get_cmd_argsW(char ***argvp)
8185{
8186 char **argv = NULL;
8187 int argc = 0;
8188 int i;
8189
Bram Moolenaar14993322014-09-09 12:25:33 +02008190 free_cmd_argsW();
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008191 ArglistW = CommandLineToArgvW(GetCommandLineW(), &nArgsW);
8192 if (ArglistW != NULL)
8193 {
8194 argv = malloc((nArgsW + 1) * sizeof(char *));
8195 if (argv != NULL)
8196 {
8197 argc = nArgsW;
8198 argv[argc] = NULL;
8199 for (i = 0; i < argc; ++i)
8200 {
8201 int len;
8202
K.Takatadc73b4b2021-06-08 18:32:36 +02008203 // Convert each Unicode argument to UTF-8.
8204 WideCharToMultiByte_alloc(CP_UTF8, 0,
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00008205 ArglistW[i], (int)wcslen(ArglistW[i]) + 1,
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008206 (LPSTR *)&argv[i], &len, 0, 0);
8207 if (argv[i] == NULL)
8208 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008209 // Out of memory, clear everything.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008210 while (i > 0)
8211 free(argv[--i]);
8212 free(argv);
Bram Moolenaar73c61632013-12-07 14:48:10 +01008213 argv = NULL;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008214 argc = 0;
8215 }
8216 }
8217 }
8218 }
8219
8220 global_argc = argc;
8221 global_argv = argv;
8222 if (argc > 0)
Bram Moolenaar14993322014-09-09 12:25:33 +02008223 {
8224 if (used_file_indexes != NULL)
8225 free(used_file_indexes);
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008226 used_file_indexes = malloc(argc * sizeof(int));
Bram Moolenaar14993322014-09-09 12:25:33 +02008227 }
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008228
8229 if (argvp != NULL)
8230 *argvp = argv;
8231 return argc;
8232}
8233
8234 void
8235free_cmd_argsW(void)
8236{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008237 if (ArglistW == NULL)
8238 return;
8239
8240 GlobalFree(ArglistW);
8241 ArglistW = NULL;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008242}
8243
8244/*
8245 * Remember "name" is an argument that was added to the argument list.
8246 * This avoids that we have to re-parse the argument list when fix_arg_enc()
8247 * is called.
8248 */
8249 void
Bram Moolenaar910f66f2006-04-05 20:41:53 +00008250used_file_arg(char *name, int literal, int full_path, int diff_mode)
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008251{
8252 int i;
8253
8254 if (used_file_indexes == NULL)
8255 return;
8256 for (i = used_file_argc + 1; i < global_argc; ++i)
8257 if (STRCMP(global_argv[i], name) == 0)
8258 {
8259 used_file_argc = i;
8260 used_file_indexes[used_file_count++] = i;
8261 break;
8262 }
8263 used_file_literal = literal;
8264 used_file_full_path = full_path;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00008265 used_file_diff_mode = diff_mode;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008266}
8267
8268/*
8269 * Remember the length of the argument list as it was. If it changes then we
8270 * leave it alone when 'encoding' is set.
8271 */
8272 void
8273set_alist_count(void)
8274{
8275 used_alist_count = GARGCOUNT;
8276}
8277
8278/*
8279 * Fix the encoding of the command line arguments. Invoked when 'encoding'
K.Takatadc73b4b2021-06-08 18:32:36 +02008280 * has been changed while starting up. Use the UTF-16 command line arguments
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008281 * and convert them to 'encoding'.
8282 */
8283 void
8284fix_arg_enc(void)
8285{
8286 int i;
8287 int idx;
8288 char_u *str;
Bram Moolenaar86b68352004-12-27 21:59:20 +00008289 int *fnum_list;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008290
Bram Moolenaar0f873732019-12-05 20:28:46 +01008291 // Safety checks:
8292 // - if argument count differs between the wide and non-wide argument
8293 // list, something must be wrong.
8294 // - the file name arguments must have been located.
8295 // - the length of the argument list wasn't changed by the user.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008296 if (global_argc != nArgsW
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008297 || ArglistW == NULL
8298 || used_file_indexes == NULL
8299 || used_file_count == 0
8300 || used_alist_count != GARGCOUNT)
8301 return;
8302
Bram Moolenaar0f873732019-12-05 20:28:46 +01008303 // Remember the buffer numbers for the arguments.
Bram Moolenaarc799fe22019-05-28 23:08:19 +02008304 fnum_list = ALLOC_MULT(int, GARGCOUNT);
Bram Moolenaar86b68352004-12-27 21:59:20 +00008305 if (fnum_list == NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008306 return; // out of memory
Bram Moolenaar86b68352004-12-27 21:59:20 +00008307 for (i = 0; i < GARGCOUNT; ++i)
8308 fnum_list[i] = GARGLIST[i].ae_fnum;
8309
Bram Moolenaar0f873732019-12-05 20:28:46 +01008310 // Clear the argument list. Make room for the new arguments.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008311 alist_clear(&global_alist);
8312 if (ga_grow(&global_alist.al_ga, used_file_count) == FAIL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008313 return; // out of memory
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008314
8315 for (i = 0; i < used_file_count; ++i)
8316 {
8317 idx = used_file_indexes[i];
Bram Moolenaar36f692d2008-11-20 16:10:17 +00008318 str = utf16_to_enc(ArglistW[idx], NULL);
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008319 if (str != NULL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00008320 {
Bram Moolenaar39d21e32017-08-05 23:09:31 +02008321 int literal = used_file_literal;
8322
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01008323#ifdef FEAT_DIFF
Bram Moolenaar0f873732019-12-05 20:28:46 +01008324 // When using diff mode may need to concatenate file name to
8325 // directory name. Just like it's done in main().
Bram Moolenaar910f66f2006-04-05 20:41:53 +00008326 if (used_file_diff_mode && mch_isdir(str) && GARGCOUNT > 0
8327 && !mch_isdir(alist_name(&GARGLIST[0])))
8328 {
8329 char_u *r;
8330
8331 r = concat_fnames(str, gettail(alist_name(&GARGLIST[0])), TRUE);
8332 if (r != NULL)
8333 {
8334 vim_free(str);
8335 str = r;
8336 }
8337 }
Bram Moolenaar912bc4a2019-12-01 18:58:11 +01008338#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01008339 // Re-use the old buffer by renaming it. When not using literal
8340 // names it's done by alist_expand() below.
Bram Moolenaar86b68352004-12-27 21:59:20 +00008341 if (used_file_literal)
8342 buf_set_name(fnum_list[i], str);
8343
Bram Moolenaar0f873732019-12-05 20:28:46 +01008344 // Check backtick literal. backtick literal is already expanded in
8345 // main.c, so this part add str as literal.
Bram Moolenaar39d21e32017-08-05 23:09:31 +02008346 if (literal == FALSE)
8347 {
Bram Moolenaar116a0f82017-08-07 21:17:57 +02008348 size_t len = STRLEN(str);
8349
Bram Moolenaar39d21e32017-08-05 23:09:31 +02008350 if (len > 2 && *str == '`' && *(str + len - 1) == '`')
8351 literal = TRUE;
8352 }
8353 alist_add(&global_alist, str, literal ? 2 : 0);
Bram Moolenaar86b68352004-12-27 21:59:20 +00008354 }
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008355 }
8356
8357 if (!used_file_literal)
8358 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008359 // Now expand wildcards in the arguments.
8360 // Temporarily add '(' and ')' to 'isfname'. These are valid
8361 // filename characters but are excluded from 'isfname' to make
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00008362 // "gf" work on a file name in parentheses (e.g.: see vim.h).
Bram Moolenaar0f873732019-12-05 20:28:46 +01008363 // Also, unset wildignore to not be influenced by this option.
8364 // The arguments specified in command-line should be kept even if
8365 // encoding options were changed.
Christian Brabandtfd916d62021-11-01 22:44:33 +00008366 // Use :legacy so that it also works when in Vim9 script.
8367 do_cmdline_cmd((char_u *)":legacy let g:SaVe_ISF = &isf|set isf+=(,)");
8368 do_cmdline_cmd((char_u *)":legacy let g:SaVe_WIG = &wig|set wig=");
Bram Moolenaar86b68352004-12-27 21:59:20 +00008369 alist_expand(fnum_list, used_alist_count);
Christian Brabandtfd916d62021-11-01 22:44:33 +00008370 do_cmdline_cmd(
8371 (char_u *)":legacy let &isf = g:SaVe_ISF|unlet g:SaVe_ISF");
8372 do_cmdline_cmd(
8373 (char_u *)":legacy let &wig = g:SaVe_WIG|unlet g:SaVe_WIG");
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008374 }
8375
Bram Moolenaar0f873732019-12-05 20:28:46 +01008376 // If wildcard expansion failed, we are editing the first file of the
8377 // arglist and there is no file name: Edit the first argument now.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008378 if (curwin->w_arg_idx == 0 && curbuf->b_fname == NULL)
8379 {
8380 do_cmdline_cmd((char_u *)":rewind");
Bram Moolenaar05268152021-11-18 18:53:45 +00008381 if (GARGCOUNT == 1 && used_file_full_path
8382 && vim_chdirfile(alist_name(&GARGLIST[0]), "drop") == OK)
8383 last_chdir_reason = "drop";
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008384 }
Bram Moolenaar86b68352004-12-27 21:59:20 +00008385
8386 set_alist_count();
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00008387}
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +01008388
8389 int
Bram Moolenaarbd67aac2019-09-21 23:09:04 +02008390mch_setenv(char *var, char *value, int x UNUSED)
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +01008391{
8392 char_u *envbuf;
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02008393 WCHAR *p;
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +01008394
Bram Moolenaar964b3742019-05-24 18:54:09 +02008395 envbuf = alloc(STRLEN(var) + STRLEN(value) + 2);
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +01008396 if (envbuf == NULL)
8397 return -1;
8398
8399 sprintf((char *)envbuf, "%s=%s", var, value);
8400
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02008401 p = enc_to_utf16(envbuf, NULL);
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +01008402
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02008403 vim_free(envbuf);
8404 if (p == NULL)
8405 return -1;
8406 _wputenv(p);
Bram Moolenaara12a1612019-01-24 16:39:02 +01008407#ifdef libintl_wputenv
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02008408 libintl_wputenv(p);
Bram Moolenaara12a1612019-01-24 16:39:02 +01008409#endif
Bram Moolenaar0eb035c2019-04-02 22:15:55 +02008410 // Unlike Un*x systems, we can free the string for _wputenv().
8411 vim_free(p);
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +01008412
8413 return 0;
8414}
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008415
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008416/*
8417 * Support for 256 colors and 24-bit colors was added in Windows 10
8418 * version 1703 (Creators update).
8419 */
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008420#define VTP_FIRST_SUPPORT_BUILD MAKE_VER(10, 0, 15063)
8421
8422/*
8423 * Support for pseudo-console (ConPTY) was added in windows 10
Bram Moolenaar57da6982019-09-13 22:30:11 +02008424 * version 1809 (October 2018 update).
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008425 */
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008426#define CONPTY_FIRST_SUPPORT_BUILD MAKE_VER(10, 0, 17763)
Bram Moolenaar57da6982019-09-13 22:30:11 +02008427
8428/*
8429 * ConPTY differences between versions, need different logic.
8430 * version 1903 (May 2019 update).
8431 */
8432#define CONPTY_1903_BUILD MAKE_VER(10, 0, 18362)
8433
8434/*
Bram Moolenaar36e7a822019-11-13 21:49:24 +01008435 * version 1909 (November 2019 update).
8436 */
8437#define CONPTY_1909_BUILD MAKE_VER(10, 0, 18363)
8438
8439/*
Bram Moolenaar7ed8f592020-04-28 20:44:42 +02008440 * Stay ahead of the next update, and when it's done, fix this.
8441 * version ? (2020 update, temporarily use the build number of insider preview)
8442 */
8443#define CONPTY_NEXT_UPDATE_BUILD MAKE_VER(10, 0, 19587)
8444
8445/*
Bram Moolenaar57da6982019-09-13 22:30:11 +02008446 * Confirm until this version. Also the logic changes.
8447 * insider preview.
8448 */
Bram Moolenaar4c063dd2019-10-04 21:29:12 +02008449#define CONPTY_INSIDER_BUILD MAKE_VER(10, 0, 18995)
Bram Moolenaar57da6982019-09-13 22:30:11 +02008450
8451/*
8452 * Not stable now.
8453 */
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008454#define CONPTY_STABLE_BUILD MAKE_VER(10, 0, 32767) // T.B.D.
Christopher Plewright1140b512022-11-12 18:46:05 +00008455// Notes:
8456// Win 10 22H2 Final is build 19045, it's conpty is widely used.
8457// Strangely, 19045 is newer but is a lower build number than the 2020 insider
8458// preview which had a build 19587. And, not sure how stable that was?
8459// Win Server 2022 (May 10, 2022) is build 20348, its conpty is widely used.
8460// Win 11 starts from build 22000, even though the major version says 10!
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008461
8462 static void
8463vtp_flag_init(void)
8464{
8465 DWORD ver = get_build_number();
Bram Moolenaarafde13b2019-04-28 19:46:49 +02008466#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008467 DWORD mode;
8468 HANDLE out;
8469
Bram Moolenaarafde13b2019-04-28 19:46:49 +02008470# ifdef VIMDLL
8471 if (!gui.in_use)
8472# endif
8473 {
8474 out = GetStdHandle(STD_OUTPUT_HANDLE);
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008475
Bram Moolenaarafde13b2019-04-28 19:46:49 +02008476 vtp_working = (ver >= VTP_FIRST_SUPPORT_BUILD) ? 1 : 0;
8477 GetConsoleMode(out, &mode);
8478 mode |= (ENABLE_PROCESSED_OUTPUT | ENABLE_VIRTUAL_TERMINAL_PROCESSING);
8479 if (SetConsoleMode(out, mode) == 0)
8480 vtp_working = 0;
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00008481
8482 // VTP uses alternate screen buffer.
8483 // But, not if running in a nested terminal
8484 use_alternate_screen_buffer = win10_22H2_or_later && p_rs && vtp_working
8485 && !mch_getenv("VIM_TERMINAL");
Bram Moolenaarafde13b2019-04-28 19:46:49 +02008486 }
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008487#endif
8488
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008489 if (ver >= CONPTY_FIRST_SUPPORT_BUILD)
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008490 conpty_working = 1;
8491 if (ver >= CONPTY_STABLE_BUILD)
8492 conpty_stable = 1;
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008493
Bram Moolenaar57da6982019-09-13 22:30:11 +02008494 if (ver <= CONPTY_INSIDER_BUILD)
8495 conpty_type = 3;
Bram Moolenaar36e7a822019-11-13 21:49:24 +01008496 if (ver <= CONPTY_1909_BUILD)
8497 conpty_type = 2;
Bram Moolenaar57da6982019-09-13 22:30:11 +02008498 if (ver <= CONPTY_1903_BUILD)
8499 conpty_type = 2;
8500 if (ver < CONPTY_FIRST_SUPPORT_BUILD)
8501 conpty_type = 1;
Bram Moolenaar7ed8f592020-04-28 20:44:42 +02008502
8503 if (ver >= CONPTY_NEXT_UPDATE_BUILD)
8504 conpty_fix_type = 1;
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008505}
8506
Bram Moolenaarafde13b2019-04-28 19:46:49 +02008507#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL) || defined(PROTO)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008508
8509 static void
8510vtp_init(void)
8511{
Bram Moolenaarf6ceaf12018-08-30 17:47:05 +02008512# ifdef FEAT_TERMGUICOLORS
Christopher Plewrightd343c602023-01-22 18:58:30 +00008513 CONSOLE_SCREEN_BUFFER_INFOEX csbi;
8514 csbi.cbSize = sizeof(csbi);
8515 GetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
8516 save_console_bg_rgb = (guicolor_T)csbi.ColorTable[g_color_index_bg];
8517 save_console_fg_rgb = (guicolor_T)csbi.ColorTable[g_color_index_fg];
8518 store_console_bg_rgb = save_console_bg_rgb;
8519 store_console_fg_rgb = save_console_fg_rgb;
Christopher Plewright38804d62022-11-09 23:55:52 +00008520
Christopher Plewrightd343c602023-01-22 18:58:30 +00008521 COLORREF bg;
8522 bg = (COLORREF)csbi.ColorTable[g_color_index_bg];
8523 bg = (GetRValue(bg) << 16) | (GetGValue(bg) << 8) | GetBValue(bg);
8524 default_console_color_bg = bg;
Christopher Plewright38804d62022-11-09 23:55:52 +00008525
Christopher Plewrightd343c602023-01-22 18:58:30 +00008526 COLORREF fg;
8527 fg = (COLORREF)csbi.ColorTable[g_color_index_fg];
8528 fg = (GetRValue(fg) << 16) | (GetGValue(fg) << 8) | GetBValue(fg);
8529 default_console_color_fg = fg;
Bram Moolenaarc4568ab2018-11-16 16:21:05 +01008530# endif
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008531 set_console_color_rgb();
8532}
8533
8534 static void
8535vtp_exit(void)
8536{
Bram Moolenaardf543822020-01-30 11:53:59 +01008537 restore_console_color_rgb();
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008538}
8539
Bram Moolenaar06b7b582020-05-30 17:49:25 +02008540 int
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008541vtp_printf(
8542 char *format,
8543 ...)
8544{
8545 char_u buf[100];
8546 va_list list;
8547 DWORD result;
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008548 int len;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008549
Nir Lichtman6cd2d1d2023-11-11 11:27:41 +01008550 if (silent_mode)
8551 return 0;
8552
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008553 va_start(list, format);
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008554 len = vim_vsnprintf((char *)buf, 100, (char *)format, list);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008555 va_end(list);
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008556 WriteConsoleA(g_hConOut, buf, (DWORD)len, &result, NULL);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008557 return (int)result;
8558}
8559
8560 static void
8561vtp_sgr_bulk(
8562 int arg)
8563{
8564 int args[1];
8565
8566 args[0] = arg;
8567 vtp_sgr_bulks(1, args);
8568}
8569
K.Takata6e1d31e2022-02-03 13:05:32 +00008570# define FAST256(x) \
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008571 if ((*p-- = "0123456789"[(n = x % 10)]) \
8572 && x >= 10 && (*p-- = "0123456789"[((m = x % 100) - n) / 10]) \
8573 && x >= 100 && (*p-- = "012"[((x & 0xff) - m) / 100]));
8574
K.Takata6e1d31e2022-02-03 13:05:32 +00008575# define FAST256CASE(x) \
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008576 case x: \
8577 FAST256(newargs[x - 1]);
8578
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008579 static void
8580vtp_sgr_bulks(
8581 int argc,
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008582 int *args)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008583{
K.Takata6e1d31e2022-02-03 13:05:32 +00008584# define MAXSGR 16
8585# define SGRBUFSIZE 2 + 4 * MAXSGR + 1 // '\033[' + SGR + 'm'
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008586 char_u buf[SGRBUFSIZE];
8587 char_u *p;
8588 int in, out;
8589 int newargs[16];
8590 static int sgrfgr = -1, sgrfgg, sgrfgb;
8591 static int sgrbgr = -1, sgrbgg, sgrbgb;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008592
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008593 if (argc == 0)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008594 {
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008595 sgrfgr = sgrbgr = -1;
K.Takatadf5320c2022-09-01 13:20:16 +01008596 vtp_printf("\033[m");
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008597 return;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008598 }
Bram Moolenaar4e5534f2020-04-30 20:59:57 +02008599
8600 in = out = 0;
8601 while (in < argc)
8602 {
8603 int s = args[in];
8604 int copylen = 1;
8605
8606 if (s == 38)
8607 {
8608 if (argc - in >= 5 && args[in + 1] == 2)
8609 {
8610 if (sgrfgr == args[in + 2] && sgrfgg == args[in + 3]
8611 && sgrfgb == args[in + 4])
8612 {
8613 in += 5;
8614 copylen = 0;
8615 }
8616 else
8617 {
8618 sgrfgr = args[in + 2];
8619 sgrfgg = args[in + 3];
8620 sgrfgb = args[in + 4];
8621 copylen = 5;
8622 }
8623 }
8624 else if (argc - in >= 3 && args[in + 1] == 5)
8625 {
8626 sgrfgr = -1;
8627 copylen = 3;
8628 }
8629 }
8630 else if (s == 48)
8631 {
8632 if (argc - in >= 5 && args[in + 1] == 2)
8633 {
8634 if (sgrbgr == args[in + 2] && sgrbgg == args[in + 3]
8635 && sgrbgb == args[in + 4])
8636 {
8637 in += 5;
8638 copylen = 0;
8639 }
8640 else
8641 {
8642 sgrbgr = args[in + 2];
8643 sgrbgg = args[in + 3];
8644 sgrbgb = args[in + 4];
8645 copylen = 5;
8646 }
8647 }
8648 else if (argc - in >= 3 && args[in + 1] == 5)
8649 {
8650 sgrbgr = -1;
8651 copylen = 3;
8652 }
8653 }
8654 else if (30 <= s && s <= 39)
8655 sgrfgr = -1;
8656 else if (90 <= s && s <= 97)
8657 sgrfgr = -1;
8658 else if (40 <= s && s <= 49)
8659 sgrbgr = -1;
8660 else if (100 <= s && s <= 107)
8661 sgrbgr = -1;
8662 else if (s == 0)
8663 sgrfgr = sgrbgr = -1;
8664
8665 while (copylen--)
8666 newargs[out++] = args[in++];
8667 }
8668
8669 p = &buf[sizeof(buf) - 1];
8670 *p-- = 'm';
8671
8672 switch (out)
8673 {
8674 int n, m;
8675 DWORD r;
8676
8677 FAST256CASE(16);
8678 *p-- = ';';
8679 FAST256CASE(15);
8680 *p-- = ';';
8681 FAST256CASE(14);
8682 *p-- = ';';
8683 FAST256CASE(13);
8684 *p-- = ';';
8685 FAST256CASE(12);
8686 *p-- = ';';
8687 FAST256CASE(11);
8688 *p-- = ';';
8689 FAST256CASE(10);
8690 *p-- = ';';
8691 FAST256CASE(9);
8692 *p-- = ';';
8693 FAST256CASE(8);
8694 *p-- = ';';
8695 FAST256CASE(7);
8696 *p-- = ';';
8697 FAST256CASE(6);
8698 *p-- = ';';
8699 FAST256CASE(5);
8700 *p-- = ';';
8701 FAST256CASE(4);
8702 *p-- = ';';
8703 FAST256CASE(3);
8704 *p-- = ';';
8705 FAST256CASE(2);
8706 *p-- = ';';
8707 FAST256CASE(1);
8708 *p-- = '[';
8709 *p = '\033';
8710 WriteConsoleA(g_hConOut, p, (DWORD)(&buf[SGRBUFSIZE] - p), &r, NULL);
8711 default:
8712 break;
8713 }
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008714}
8715
Bram Moolenaar06b7b582020-05-30 17:49:25 +02008716 static void
8717wt_init(void)
8718{
Christopher Plewright1140b512022-11-12 18:46:05 +00008719 wt_working = mch_getenv("WT_SESSION") != NULL;
Bram Moolenaar06b7b582020-05-30 17:49:25 +02008720}
8721
Bram Moolenaar8a938af2018-05-01 17:30:41 +02008722# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02008723 static int
8724ctermtoxterm(
8725 int cterm)
8726{
Bram Moolenaar9894e392018-05-05 14:29:06 +02008727 char_u r, g, b, idx;
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02008728
8729 cterm_color2rgb(cterm, &r, &g, &b, &idx);
8730 return (((int)r << 16) | ((int)g << 8) | (int)b);
8731}
Bram Moolenaar8a938af2018-05-01 17:30:41 +02008732# endif
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02008733
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008734 static void
8735set_console_color_rgb(void)
8736{
8737# ifdef FEAT_TERMGUICOLORS
K.Takata27b53be2022-09-18 12:25:49 +01008738 CONSOLE_SCREEN_BUFFER_INFOEX csbi;
Bram Moolenaara050b942019-12-02 21:35:31 +01008739 guicolor_T fg, bg;
8740 int ctermfg, ctermbg;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008741
Christopher Plewright38804d62022-11-09 23:55:52 +00008742 if (!vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008743 return;
8744
Bram Moolenaara050b942019-12-02 21:35:31 +01008745 get_default_console_color(&ctermfg, &ctermbg, &fg, &bg);
8746
Christopher Plewright38804d62022-11-09 23:55:52 +00008747 if (p_tgc || t_colors >= 256)
Bram Moolenaar06b7b582020-05-30 17:49:25 +02008748 {
8749 term_fg_rgb_color(fg);
8750 term_bg_rgb_color(bg);
8751 return;
8752 }
8753
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00008754 if (use_alternate_screen_buffer)
8755 return;
8756
Christopher Plewrightd343c602023-01-22 18:58:30 +00008757 fg = (GetRValue(fg) << 16) | (GetGValue(fg) << 8) | GetBValue(fg);
8758 bg = (GetRValue(bg) << 16) | (GetGValue(bg) << 8) | GetBValue(bg);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008759
Christopher Plewrightd343c602023-01-22 18:58:30 +00008760 csbi.cbSize = sizeof(csbi);
8761 GetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008762
Christopher Plewrightd343c602023-01-22 18:58:30 +00008763 csbi.cbSize = sizeof(csbi);
8764 csbi.srWindow.Right += 1;
8765 csbi.srWindow.Bottom += 1;
8766 store_console_bg_rgb = csbi.ColorTable[g_color_index_bg];
8767 store_console_fg_rgb = csbi.ColorTable[g_color_index_fg];
8768 csbi.ColorTable[g_color_index_bg] = (COLORREF)bg;
8769 csbi.ColorTable[g_color_index_fg] = (COLORREF)fg;
8770 SetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008771# endif
8772}
8773
Bram Moolenaara050b942019-12-02 21:35:31 +01008774# if defined(FEAT_TERMGUICOLORS) || defined(PROTO)
8775 void
8776get_default_console_color(
8777 int *cterm_fg,
8778 int *cterm_bg,
8779 guicolor_T *gui_fg,
8780 guicolor_T *gui_bg)
8781{
8782 int id;
8783 guicolor_T guifg = INVALCOLOR;
8784 guicolor_T guibg = INVALCOLOR;
8785 int ctermfg = 0;
8786 int ctermbg = 0;
Christopher Plewright38804d62022-11-09 23:55:52 +00008787 int dummynull = 0;
Bram Moolenaara050b942019-12-02 21:35:31 +01008788
8789 id = syn_name2id((char_u *)"Normal");
8790 if (id > 0 && p_tgc)
8791 syn_id2colors(id, &guifg, &guibg);
8792 if (guifg == INVALCOLOR)
8793 {
8794 ctermfg = -1;
8795 if (id > 0)
Christopher Plewright38804d62022-11-09 23:55:52 +00008796 syn_id2cterm_bg(id, &ctermfg, &dummynull);
Christopher Plewrightd343c602023-01-22 18:58:30 +00008797 if (ctermfg != -1)
8798 guifg = ctermtoxterm(ctermfg);
Christopher Plewright38804d62022-11-09 23:55:52 +00008799 else
Christopher Plewrightd343c602023-01-22 18:58:30 +00008800 guifg = USE_WT ? INVALCOLOR : default_console_color_fg;
8801 cterm_normal_fg_gui_color = guifg;
8802 ctermfg = ctermfg < 0 ? 0 : ctermfg;
Bram Moolenaara050b942019-12-02 21:35:31 +01008803 }
8804 if (guibg == INVALCOLOR)
8805 {
8806 ctermbg = -1;
8807 if (id > 0)
Christopher Plewright38804d62022-11-09 23:55:52 +00008808 syn_id2cterm_bg(id, &dummynull, &ctermbg);
Christopher Plewrightd343c602023-01-22 18:58:30 +00008809 if (ctermbg != -1)
8810 guibg = ctermtoxterm(ctermbg);
K.Takatae53a0d42022-09-05 21:45:11 +01008811 else
Christopher Plewrightd343c602023-01-22 18:58:30 +00008812 guibg = USE_WT ? INVALCOLOR : default_console_color_bg;
8813 cterm_normal_bg_gui_color = guibg;
8814 ctermbg = ctermbg < 0 ? 0 : ctermbg;
Bram Moolenaara050b942019-12-02 21:35:31 +01008815 }
8816
8817 *cterm_fg = ctermfg;
8818 *cterm_bg = ctermbg;
8819 *gui_fg = guifg;
8820 *gui_bg = guibg;
8821}
8822# endif
8823
Bram Moolenaardf543822020-01-30 11:53:59 +01008824/*
8825 * Set the console colors to the original colors or the last set colors.
8826 */
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008827 static void
8828reset_console_color_rgb(void)
8829{
8830# ifdef FEAT_TERMGUICOLORS
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00008831 if (use_alternate_screen_buffer)
8832 return;
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008833
Christopher Plewright38804d62022-11-09 23:55:52 +00008834 CONSOLE_SCREEN_BUFFER_INFOEX csbi;
8835
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008836 csbi.cbSize = sizeof(csbi);
K.Takata27b53be2022-09-18 12:25:49 +01008837 GetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008838
8839 csbi.cbSize = sizeof(csbi);
8840 csbi.srWindow.Right += 1;
8841 csbi.srWindow.Bottom += 1;
Bram Moolenaardf543822020-01-30 11:53:59 +01008842 csbi.ColorTable[g_color_index_bg] = (COLORREF)store_console_bg_rgb;
8843 csbi.ColorTable[g_color_index_fg] = (COLORREF)store_console_fg_rgb;
K.Takata27b53be2022-09-18 12:25:49 +01008844 SetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
Bram Moolenaardf543822020-01-30 11:53:59 +01008845# endif
8846}
8847
8848/*
8849 * Set the console colors to the original colors.
8850 */
8851 static void
8852restore_console_color_rgb(void)
8853{
8854# ifdef FEAT_TERMGUICOLORS
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00008855 if (use_alternate_screen_buffer)
8856 return;
Christopher Plewright38804d62022-11-09 23:55:52 +00008857
K.Takata27b53be2022-09-18 12:25:49 +01008858 CONSOLE_SCREEN_BUFFER_INFOEX csbi;
Bram Moolenaardf543822020-01-30 11:53:59 +01008859
8860 csbi.cbSize = sizeof(csbi);
K.Takata27b53be2022-09-18 12:25:49 +01008861 GetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
Bram Moolenaardf543822020-01-30 11:53:59 +01008862
8863 csbi.cbSize = sizeof(csbi);
8864 csbi.srWindow.Right += 1;
8865 csbi.srWindow.Bottom += 1;
Bram Moolenaarf6ceaf12018-08-30 17:47:05 +02008866 csbi.ColorTable[g_color_index_bg] = (COLORREF)save_console_bg_rgb;
8867 csbi.ColorTable[g_color_index_fg] = (COLORREF)save_console_fg_rgb;
K.Takata27b53be2022-09-18 12:25:49 +01008868 SetConsoleScreenBufferInfoEx(g_hConOut, &csbi);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008869# endif
8870}
8871
8872 void
8873control_console_color_rgb(void)
8874{
Christopher Plewright38804d62022-11-09 23:55:52 +00008875 if (vtp_working)
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008876 set_console_color_rgb();
8877 else
8878 reset_console_color_rgb();
8879}
8880
8881 int
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008882use_vtp(void)
8883{
8884 return USE_VTP;
8885}
8886
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02008887 int
8888is_term_win32(void)
8889{
8890 return T_NAME != NULL && STRCMP(T_NAME, "win32") == 0;
8891}
8892
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01008893 int
8894has_vtp_working(void)
8895{
8896 return vtp_working;
8897}
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008898
Bram Moolenaar6902c0e2019-02-16 14:07:37 +01008899#endif
8900
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008901 int
8902has_conpty_working(void)
8903{
8904 return conpty_working;
8905}
8906
8907 int
Bram Moolenaar57da6982019-09-13 22:30:11 +02008908get_conpty_type(void)
8909{
8910 return conpty_type;
8911}
8912
8913 int
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008914is_conpty_stable(void)
8915{
8916 return conpty_stable;
8917}
Bram Moolenaar78d21da2019-02-17 15:00:52 +01008918
Bram Moolenaar7ed8f592020-04-28 20:44:42 +02008919 int
8920get_conpty_fix_type(void)
8921{
8922 return conpty_fix_type;
8923}
8924
Bram Moolenaarafde13b2019-04-28 19:46:49 +02008925#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL) || defined(PROTO)
Bram Moolenaar78d21da2019-02-17 15:00:52 +01008926 void
8927resize_console_buf(void)
8928{
Christopher Plewrightf75a2cb2023-01-28 10:28:09 +00008929 if (use_alternate_screen_buffer)
8930 return;
8931
Bram Moolenaar78d21da2019-02-17 15:00:52 +01008932 CONSOLE_SCREEN_BUFFER_INFO csbi;
8933 COORD coord;
8934 SMALL_RECT newsize;
8935
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008936 if (!GetConsoleScreenBufferInfo(g_hConOut, &csbi))
8937 return;
Bram Moolenaar78d21da2019-02-17 15:00:52 +01008938
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008939 coord.X = SRWIDTH(csbi.srWindow);
8940 coord.Y = SRHEIGHT(csbi.srWindow);
8941 SetConsoleScreenBufferSize(g_hConOut, coord);
Bram Moolenaar78d21da2019-02-17 15:00:52 +01008942
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008943 newsize.Left = 0;
8944 newsize.Top = 0;
8945 newsize.Right = coord.X - 1;
8946 newsize.Bottom = coord.Y - 1;
8947 SetConsoleWindowInfo(g_hConOut, TRUE, &newsize);
8948
8949 SetConsoleScreenBufferSize(g_hConOut, coord);
Bram Moolenaar78d21da2019-02-17 15:00:52 +01008950}
8951#endif
Martin Tournoij1a3e5742021-07-24 13:57:29 +02008952
8953 char *
8954GetWin32Error(void)
8955{
K.Takatad68b2fc2022-02-12 11:18:37 +00008956 static char *oldmsg = NULL;
Martin Tournoij1a3e5742021-07-24 13:57:29 +02008957 char *msg = NULL;
K.Takatad68b2fc2022-02-12 11:18:37 +00008958
Martin Tournoij1a3e5742021-07-24 13:57:29 +02008959 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
8960 NULL, GetLastError(), 0, (LPSTR)&msg, 0, NULL);
K.Takatad68b2fc2022-02-12 11:18:37 +00008961 if (oldmsg != NULL)
8962 LocalFree(oldmsg);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008963 if (msg == NULL)
8964 return NULL;
8965
8966 // remove trailing \r\n
8967 char *pcrlf = strstr(msg, "\r\n");
8968 if (pcrlf != NULL)
8969 *pcrlf = '\0';
8970 oldmsg = msg;
Martin Tournoij1a3e5742021-07-24 13:57:29 +02008971 return msg;
8972}
Paul Ollis65745772022-06-05 16:55:54 +01008973
8974#if defined(FEAT_RELTIME) || defined(PROTO)
8975static HANDLE timer_handle;
8976static int timer_active = FALSE;
8977
8978/*
8979 * Calls to start_timeout alternate the return value pointer between the two
8980 * entries in timeout_flags. If the previously active timeout is very close to
8981 * expiring when start_timeout() is called then a race condition means that the
8982 * set_flag() function may still be invoked after the previous timer is
8983 * deleted. Ping-ponging between the two flags prevents this causing 'fake'
8984 * timeouts.
8985 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008986static sig_atomic_t timeout_flags[2];
8987static int timeout_flag_idx = 0;
8988static sig_atomic_t *timeout_flag = &timeout_flags[0];
Paul Ollis65745772022-06-05 16:55:54 +01008989
8990
8991 static void CALLBACK
Bram Moolenaar35d7a2f2022-06-09 20:53:54 +01008992set_flag(void *param, BOOLEAN unused2 UNUSED)
Paul Ollis65745772022-06-05 16:55:54 +01008993{
8994 int *timeout_flag = (int *)param;
8995
8996 *timeout_flag = TRUE;
8997}
8998
8999/*
9000 * Stop any active timeout.
9001 */
9002 void
9003stop_timeout(void)
9004{
9005 if (timer_active)
9006 {
Christopher Plewright2a46f812022-10-16 19:47:45 +01009007 BOOL ret = DeleteTimerQueueTimer(NULL, timer_handle, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01009008 timer_active = FALSE;
9009 if (!ret && GetLastError() != ERROR_IO_PENDING)
9010 {
9011 semsg(_(e_could_not_clear_timeout_str), GetWin32Error());
9012 }
9013 }
9014 *timeout_flag = FALSE;
9015}
9016
9017/*
9018 * Start the timeout timer.
9019 *
9020 * The period is defined in milliseconds.
9021 *
9022 * The return value is a pointer to a flag that is initialised to 0. If the
9023 * timeout expires, the flag is set to 1. This will only return pointers to
9024 * static memory; i.e. any pointer returned by this function may always be
9025 * safely dereferenced.
9026 *
9027 * This function is not expected to fail, but if it does it still returns a
9028 * valid flag pointer; the flag will remain stuck at zero.
9029 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01009030 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01009031start_timeout(long msec)
9032{
Paul Ollis65745772022-06-05 16:55:54 +01009033 BOOL ret;
9034
Bram Moolenaar1f30caf2022-06-19 14:36:35 +01009035 timeout_flag = &timeout_flags[timeout_flag_idx];
Paul Ollis65745772022-06-05 16:55:54 +01009036
9037 stop_timeout();
9038 ret = CreateTimerQueueTimer(
9039 &timer_handle, NULL, set_flag, timeout_flag,
9040 (DWORD)msec, 0, WT_EXECUTEDEFAULT);
9041 if (!ret)
9042 {
9043 semsg(_(e_could_not_set_timeout_str), GetWin32Error());
9044 }
9045 else
9046 {
Bram Moolenaar1f30caf2022-06-19 14:36:35 +01009047 timeout_flag_idx = (timeout_flag_idx + 1) % 2;
Paul Ollis65745772022-06-05 16:55:54 +01009048 timer_active = TRUE;
9049 *timeout_flag = FALSE;
9050 }
9051 return timeout_flag;
9052}
9053#endif