blob: da7f56a67521090597cce782e5efbbb5e039a6c9 [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 * OS/2 port by Paul Slootman
5 * VMS merge by Zoltan Arpadffy
6 *
7 * Do ":help uganda" in Vim to read copying and usage conditions.
8 * Do ":help credits" in Vim to see a list of people who contributed.
9 * See README.txt for an overview of the Vim source code.
10 */
11
12/*
13 * os_unix.c -- code for all flavors of Unix (BSD, SYSV, SVR4, POSIX, ...)
14 * Also for OS/2, using the excellent EMX package!!!
Bram Moolenaar041c7102020-05-30 18:14:57 +020015 * Also for Atari MiNT.
Bram Moolenaar071d4272004-06-13 20:20:40 +000016 *
17 * A lot of this file was originally written by Juergen Weigert and later
18 * changed beyond recognition.
19 */
20
Bram Moolenaar071d4272004-06-13 20:20:40 +000021#include "vim.h"
22
Bram Moolenaar325b7a22004-07-05 15:58:32 +000023#ifdef FEAT_MZSCHEME
24# include "if_mzsch.h"
25#endif
26
Bram Moolenaar0f873732019-12-05 20:28:46 +010027#include "os_unixx.h" // unix includes for os_unix.c only
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
29#ifdef USE_XSMP
30# include <X11/SM/SMlib.h>
31#endif
32
Bram Moolenaar588ebeb2008-05-07 17:09:24 +000033#ifdef HAVE_SELINUX
34# include <selinux/selinux.h>
35static int selinux_enabled = -1;
36#endif
37
Christian Brabandte085dfd2023-09-30 12:49:18 +020038#ifdef FEAT_XATTR
zeertzjq6de4e582023-09-30 14:19:14 +020039# include <sys/xattr.h>
Christian Brabandte085dfd2023-09-30 12:49:18 +020040#endif
41
Bram Moolenaar5bd32f42014-04-02 14:05:38 +020042#ifdef HAVE_SMACK
zeertzjq6de4e582023-09-30 14:19:14 +020043# include <sys/xattr.h>
Bram Moolenaar5bd32f42014-04-02 14:05:38 +020044# include <linux/xattr.h>
45# ifndef SMACK_LABEL_LEN
46# define SMACK_LABEL_LEN 1024
47# endif
48#endif
49
Bram Moolenaara2442432007-04-26 14:26:37 +000050#ifdef __CYGWIN__
K.Takata972db232022-02-04 10:45:38 +000051# include <cygwin/version.h>
52# include <sys/cygwin.h> // for cygwin_conv_to_posix_path() and/or
Bram Moolenaar0f873732019-12-05 20:28:46 +010053 // for cygwin_conv_path()
K.Takata972db232022-02-04 10:45:38 +000054# ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
55# define WIN32_LEAN_AND_MEAN
56# include <windows.h>
57# include "winclip.pro"
Bram Moolenaara2442432007-04-26 14:26:37 +000058# endif
59#endif
60
Bram Moolenaar071d4272004-06-13 20:20:40 +000061#ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +000062
Bram Moolenaar071d4272004-06-13 20:20:40 +000063# include <gpm.h>
Bram Moolenaar33fc4a62022-02-23 18:07:38 +000064
65# ifdef DYNAMIC_GPM
66# define Gpm_Open (*dll_Gpm_Open)
67# define Gpm_Close (*dll_Gpm_Close)
68# define Gpm_GetEvent (*dll_Gpm_GetEvent)
69# define gpm_flag (dll_gpm_flag != NULL ? *dll_gpm_flag : 0)
70# define gpm_fd (dll_gpm_fd != NULL ? *dll_gpm_fd : -1)
71
72static int (*dll_Gpm_Open) (Gpm_Connect *, int);
73static int (*dll_Gpm_Close) (void);
74static int (*dll_Gpm_GetEvent) (Gpm_Event *);
75static int *dll_gpm_flag;
76static int *dll_gpm_fd;
77
78static void *libgpm_hinst;
79# endif
80
Bram Moolenaar0f873732019-12-05 20:28:46 +010081// <linux/keyboard.h> contains defines conflicting with "keymap.h",
82// I just copied relevant defines here. A cleaner solution would be to put gpm
83// code into separate file and include there linux/keyboard.h
84// #include <linux/keyboard.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000085# define KG_SHIFT 0
86# define KG_CTRL 2
87# define KG_ALT 3
88# define KG_ALTGR 1
89# define KG_SHIFTL 4
90# define KG_SHIFTR 5
91# define KG_CTRLL 6
92# define KG_CTRLR 7
93# define KG_CAPSSHIFT 8
94
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010095static void gpm_close(void);
96static int gpm_open(void);
97static int mch_gpm_process(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000098#endif
99
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000100#ifdef FEAT_SYSMOUSE
101# include <sys/consio.h>
102# include <sys/fbio.h>
103
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100104static int sysmouse_open(void);
105static void sysmouse_close(void);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100106static void sig_sysmouse SIGPROTOARG;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000107#endif
108
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109/*
110 * end of autoconf section. To be extended...
111 */
112
Bram Moolenaar0f873732019-12-05 20:28:46 +0100113// Are the following #ifdefs still required? And why? Is that for X11?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114
115#if defined(ESIX) || defined(M_UNIX) && !defined(SCO)
116# ifdef SIGWINCH
117# undef SIGWINCH
118# endif
119# ifdef TIOCGWINSZ
120# undef TIOCGWINSZ
121# endif
122#endif
123
Bram Moolenaar0f873732019-12-05 20:28:46 +0100124#if defined(SIGWINDOW) && !defined(SIGWINCH) // hpux 9.01 has it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125# define SIGWINCH SIGWINDOW
126#endif
127
128#ifdef FEAT_X11
129# include <X11/Xlib.h>
130# include <X11/Xutil.h>
131# include <X11/Xatom.h>
132# ifdef FEAT_XCLIPBOARD
133# include <X11/Intrinsic.h>
134# include <X11/Shell.h>
135# include <X11/StringDefs.h>
136static Widget xterm_Shell = (Widget)0;
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100137static void clip_update(void);
138static void xterm_update(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139# endif
140
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141Window x11_window = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142Display *x11_display = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143#endif
144
Bram Moolenaar5c3128e2020-05-11 20:54:42 +0200145static int ignore_sigtstp = FALSE;
146
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100147static int get_x11_title(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148
149static char_u *oldtitle = NULL;
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200150static volatile sig_atomic_t oldtitle_outdated = FALSE;
Bram Moolenaardac13472019-09-16 21:06:21 +0200151static int unix_did_set_title = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152static char_u *oldicon = NULL;
153static int did_set_icon = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100155static void may_core_dump(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156
Bram Moolenaar205b8862011-09-07 15:04:31 +0200157#ifdef HAVE_UNION_WAIT
158typedef union wait waitstatus;
159#else
160typedef int waitstatus;
161#endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200162static int WaitForChar(long msec, int *interrupted, int ignore_input);
163static int WaitForCharOrMouse(long msec, int *interrupted, int ignore_input);
Bram Moolenaar041c7102020-05-30 18:14:57 +0200164#ifdef VMS
Bram Moolenaarcda77642016-06-04 13:32:35 +0200165int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166#else
Bram Moolenaarcda77642016-06-04 13:32:35 +0200167static int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168#endif
169
170#ifdef FEAT_XCLIPBOARD
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100171static int do_xterm_trace(void);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100172# define XT_TRACE_DELAY 50 // delay for xterm tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173#endif
174
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100175static void handle_resize(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176
177#if defined(SIGWINCH)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100178static void sig_winch SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179#endif
dbivolaruab16ad32021-12-29 19:41:47 +0000180#if defined(SIGTSTP)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100181static void sig_tstp SIGPROTOARG;
Bram Moolenaarabd56da2022-06-23 20:46:27 +0100182// volatile because it is used in signal handler sig_tstp() and
183// sigcont_handler().
dbivolaruab16ad32021-12-29 19:41:47 +0000184static volatile sig_atomic_t in_mch_suspend = FALSE;
185#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186#if defined(SIGINT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100187static void catch_sigint SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200189#if defined(SIGUSR1)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100190static void catch_sigusr1 SIGPROTOARG;
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200191#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192#if defined(SIGPWR)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100193static void catch_sigpwr SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194#endif
Bram Moolenaar651fca82021-11-29 20:39:38 +0000195#if defined(SIGALRM) && defined(FEAT_X11) && !defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196# define SET_SIG_ALARM
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100197static void sig_alarm SIGPROTOARG;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100198// volatile because it is used in signal handler sig_alarm().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200199static volatile sig_atomic_t sig_alarm_called;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200#endif
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100201static void deathtrap SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000202
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100203static void catch_int_signal(void);
204static void set_signals(void);
Michael Jarvisbe9624e2023-04-19 20:28:48 +0100205static void catch_signals(void (*func_deadly)(int), void (*func_other)(int));
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +0200206#ifdef HAVE_SIGPROCMASK
207# define SIGSET_DECL(set) sigset_t set;
208# define BLOCK_SIGNALS(set) block_signals(set)
209# define UNBLOCK_SIGNALS(set) unblock_signals(set)
210#else
211# define SIGSET_DECL(set)
212# define BLOCK_SIGNALS(set) do { /**/ } while (0)
213# define UNBLOCK_SIGNALS(set) do { /**/ } while (0)
214#endif
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100215static int have_wildcard(int, char_u **);
216static int have_dollars(int, char_u **);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100218static int save_patterns(int num_pat, char_u **pat, int *num_file, char_u ***file);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219
220#ifndef SIG_ERR
ichizok378447f2023-05-11 22:25:42 +0100221# define SIG_ERR ((sighandler_T)-1)
222#endif
223#ifndef SIG_HOLD
224# define SIG_HOLD ((sighandler_T)-2)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225#endif
226
Bram Moolenaar0f873732019-12-05 20:28:46 +0100227// volatile because it is used in signal handler sig_winch().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200228static volatile sig_atomic_t do_resize = FALSE;
dbivolaruab16ad32021-12-29 19:41:47 +0000229// volatile because it is used in signal handler sig_tstp().
230static volatile sig_atomic_t got_tstp = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231static char_u *extra_shell_arg = NULL;
232static int show_shell_mess = TRUE;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100233// volatile because it is used in signal handler deathtrap().
234static volatile sig_atomic_t deadly_signal = 0; // The signal we caught
235// volatile because it is used in signal handler deathtrap().
236static volatile sig_atomic_t in_mch_delay = FALSE; // sleeping in mch_delay()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +0100238#if defined(FEAT_JOB_CHANNEL) && !defined(USE_SYSTEM)
239static int dont_check_job_ended = 0;
240#endif
241
Bram Moolenaar26e86442020-05-17 14:06:16 +0200242// Current terminal mode from mch_settmode(). Can differ from cur_tmode.
243static tmode_T mch_cur_tmode = TMODE_COOK;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244
245#ifdef USE_XSMP
246typedef struct
247{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100248 SmcConn smcconn; // The SM connection ID
249 IceConn iceconn; // The ICE connection ID
250 char *clientid; // The client ID for the current smc session
251 Bool save_yourself; // If we're in the middle of a save_yourself
252 Bool shutdown; // If we're in shutdown mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253} xsmp_config_T;
254
255static xsmp_config_T xsmp;
256#endif
257
258#ifdef SYS_SIGLIST_DECLARED
259/*
260 * I have seen
261 * extern char *_sys_siglist[NSIG];
Yegappan Lakshmananaebc6ef2022-08-27 21:24:26 +0100262 * on Linux, NetBSD and Solaris. It contains a nice list of strings
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263 * that describe the signals. That is nearly what we want here. But
264 * autoconf does only check for sys_siglist (without the underscore), I
265 * do not want to change everything today.... jw.
Bram Moolenaar3f7d0902016-11-12 21:13:42 +0100266 * This is why AC_DECL_SYS_SIGLIST is commented out in configure.ac.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267 */
268#endif
269
270static struct signalinfo
271{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100272 int sig; // Signal number, eg. SIGSEGV etc
273 char *name; // Signal name (not char_u!).
274 char deadly; // Catch as a deadly signal?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275} signal_info[] =
276{
277#ifdef SIGHUP
278 {SIGHUP, "HUP", TRUE},
279#endif
280#ifdef SIGQUIT
281 {SIGQUIT, "QUIT", TRUE},
282#endif
283#ifdef SIGILL
284 {SIGILL, "ILL", TRUE},
285#endif
286#ifdef SIGTRAP
287 {SIGTRAP, "TRAP", TRUE},
288#endif
289#ifdef SIGABRT
290 {SIGABRT, "ABRT", TRUE},
291#endif
292#ifdef SIGEMT
293 {SIGEMT, "EMT", TRUE},
294#endif
295#ifdef SIGFPE
296 {SIGFPE, "FPE", TRUE},
297#endif
298#ifdef SIGBUS
299 {SIGBUS, "BUS", TRUE},
300#endif
Bram Moolenaar75676462013-01-30 14:55:42 +0100301#if defined(SIGSEGV) && !defined(FEAT_MZSCHEME)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100302 // MzScheme uses SEGV in its garbage collector
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 {SIGSEGV, "SEGV", TRUE},
304#endif
305#ifdef SIGSYS
306 {SIGSYS, "SYS", TRUE},
307#endif
308#ifdef SIGALRM
Bram Moolenaar0f873732019-12-05 20:28:46 +0100309 {SIGALRM, "ALRM", FALSE}, // Perl's alarm() can trigger it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310#endif
311#ifdef SIGTERM
312 {SIGTERM, "TERM", TRUE},
313#endif
Bram Moolenaarb292a2a2011-02-09 18:47:40 +0100314#if defined(SIGVTALRM) && !defined(FEAT_RUBY)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315 {SIGVTALRM, "VTALRM", TRUE},
316#endif
Bram Moolenaar02f07e02008-03-12 12:17:28 +0000317#if defined(SIGPROF) && !defined(FEAT_MZSCHEME) && !defined(WE_ARE_PROFILING)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100318 // MzScheme uses SIGPROF for its own needs; On Linux with profiling
319 // this makes Vim exit. WE_ARE_PROFILING is defined in Makefile.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 {SIGPROF, "PROF", TRUE},
321#endif
322#ifdef SIGXCPU
323 {SIGXCPU, "XCPU", TRUE},
324#endif
325#ifdef SIGXFSZ
326 {SIGXFSZ, "XFSZ", TRUE},
327#endif
328#ifdef SIGUSR1
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200329 {SIGUSR1, "USR1", FALSE},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000331#if defined(SIGUSR2) && !defined(FEAT_SYSMOUSE)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100332 // Used for sysmouse handling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 {SIGUSR2, "USR2", TRUE},
334#endif
335#ifdef SIGINT
336 {SIGINT, "INT", FALSE},
337#endif
338#ifdef SIGWINCH
339 {SIGWINCH, "WINCH", FALSE},
340#endif
341#ifdef SIGTSTP
342 {SIGTSTP, "TSTP", FALSE},
343#endif
344#ifdef SIGPIPE
345 {SIGPIPE, "PIPE", FALSE},
346#endif
347 {-1, "Unknown!", FALSE}
348};
349
ichizok378447f2023-05-11 22:25:42 +0100350 sighandler_T
351mch_signal(int sig, sighandler_T func)
352{
353#if defined(HAVE_SIGACTION) && defined(HAVE_SIGPROCMASK)
354 // Modern implementation: use sigaction().
355 struct sigaction sa, old;
356 sigset_t curset;
357 int blocked;
358
359 if (sigprocmask(SIG_BLOCK, NULL, &curset) == -1)
360 return SIG_ERR;
361
362 blocked = sigismember(&curset, sig);
363
364 if (func == SIG_HOLD)
365 {
366 if (blocked)
367 return SIG_HOLD;
368
369 sigemptyset(&curset);
370 sigaddset(&curset, sig);
371
372 if (sigaction(sig, NULL, &old) == -1
373 || sigprocmask(SIG_BLOCK, &curset, NULL) == -1)
374 return SIG_ERR;
375 return old.sa_handler;
376 }
377
378 if (blocked)
379 {
380 sigemptyset(&curset);
381 sigaddset(&curset, sig);
382
383 if (sigprocmask(SIG_UNBLOCK, &curset, NULL) == -1)
384 return SIG_ERR;
385 }
386
387 sa.sa_handler = func;
388 sigemptyset(&sa.sa_mask);
389# ifdef SA_RESTART
390 sa.sa_flags = SA_RESTART;
391# else
392 sa.sa_flags = 0;
393# endif
394 if (sigaction(sig, &sa, &old) == -1)
395 return SIG_ERR;
396 return blocked ? SIG_HOLD: old.sa_handler;
397#elif defined(HAVE_SIGSET)
398 // Using sigset() is preferred above signal().
399 return sigset(sig, func);
400#else
401 // Oldest and most compatible solution.
402 return signal(sig, func);
403#endif
404}
405
Bram Moolenaar25724922009-07-14 15:38:41 +0000406 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100407mch_chdir(char *path)
Bram Moolenaar25724922009-07-14 15:38:41 +0000408{
409 if (p_verbose >= 5)
410 {
411 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100412 smsg("chdir(%s)", path);
Bram Moolenaar25724922009-07-14 15:38:41 +0000413 verbose_leave();
414 }
ichizok378447f2023-05-11 22:25:42 +0100415#ifdef VMS
Bram Moolenaar25724922009-07-14 15:38:41 +0000416 return chdir(vms_fixfilename(path));
ichizok378447f2023-05-11 22:25:42 +0100417#else
Bram Moolenaar25724922009-07-14 15:38:41 +0000418 return chdir(path);
ichizok378447f2023-05-11 22:25:42 +0100419#endif
Bram Moolenaar25724922009-07-14 15:38:41 +0000420}
421
Bram Moolenaar0f873732019-12-05 20:28:46 +0100422// Why is NeXT excluded here (and not in os_unixx.h)?
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +0100423#if defined(ECHOE) && defined(ICANON) \
424 && (defined(HAVE_TERMIO_H) || defined(HAVE_TERMIOS_H)) \
425 && !defined(__NeXT__)
Bram Moolenaar4f44b882017-08-13 20:06:18 +0200426# define NEW_TTY_SYSTEM
427#endif
428
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000429/*
Bram Moolenaard23a8232018-02-10 18:45:26 +0100430 * Write s[len] to the screen (stdout).
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000431 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100433mch_write(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434{
Bram Moolenaar42335f52018-09-13 15:33:43 +0200435 vim_ignored = (int)write(1, (char *)s, len);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100436 if (p_wd) // Unix is too fast, slow down a bit more
Bram Moolenaar8fdd7212016-03-26 19:41:48 +0100437 RealWaitForChar(read_cmd_fd, p_wd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438}
439
440/*
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100441 * Function passed to inchar_loop() to handle window resizing.
442 * If "check_only" is TRUE: Return whether there was a resize.
443 * If "check_only" is FALSE: Deal with the window resized.
444 */
445 static int
446resize_func(int check_only)
447{
448 if (check_only)
449 return do_resize;
450 while (do_resize)
Bram Moolenaar55f1b822023-06-21 13:42:48 +0100451 {
Bram Moolenaar545c8a52023-06-21 15:51:47 +0100452#ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +0100453 ch_log(NULL, "calling handle_resize() in resize_func()");
Bram Moolenaar545c8a52023-06-21 15:51:47 +0100454#endif
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100455 handle_resize();
Bram Moolenaar55f1b822023-06-21 13:42:48 +0100456 }
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100457 return FALSE;
458}
459
460/*
Bram Moolenaarc2a27c32007-12-01 16:19:33 +0000461 * mch_inchar(): low level input function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462 * Get a characters from the keyboard.
463 * Return the number of characters that are available.
464 * If wtime == 0 do not wait for characters.
465 * If wtime == n wait a short time for characters.
466 * If wtime == -1 wait forever for characters.
467 */
468 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100469mch_inchar(
470 char_u *buf,
471 int maxlen,
Bram Moolenaar0f873732019-12-05 20:28:46 +0100472 long wtime, // don't use "time", MIPS cannot handle it
Bram Moolenaar05540972016-01-30 20:31:25 +0100473 int tb_change_cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474{
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100475 return inchar_loop(buf, maxlen, wtime, tb_change_cnt,
476 WaitForChar, resize_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477}
478
479 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100480handle_resize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481{
482 do_resize = FALSE;
483 shell_resized();
484}
485
486/*
Bram Moolenaar40b1b542016-04-20 20:18:23 +0200487 * Return non-zero if a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488 */
489 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100490mch_char_avail(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491{
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200492 return WaitForChar(0L, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493}
494
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200495#if defined(FEAT_TERMINAL) || defined(PROTO)
496/*
497 * Check for any pending input or messages.
498 */
499 int
500mch_check_messages(void)
501{
502 return WaitForChar(0L, NULL, TRUE);
503}
504#endif
505
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506#if defined(HAVE_TOTAL_MEM) || defined(PROTO)
507# ifdef HAVE_SYS_RESOURCE_H
Bram Moolenaar8f0b2d42009-05-16 14:41:10 +0000508# include <sys/resource.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509# endif
510# if defined(HAVE_SYS_SYSCTL_H) && defined(HAVE_SYSCTL)
511# include <sys/sysctl.h>
512# endif
513# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
514# include <sys/sysinfo.h>
515# endif
Bram Moolenaar362dc332018-03-05 21:59:37 +0100516# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100517# include <mach/mach_host.h>
518# include <mach/mach_port.h>
Bram Moolenaar988615f2018-02-27 17:58:20 +0100519# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520
521/*
Bram Moolenaar914572a2007-05-01 11:37:47 +0000522 * Return total amount of memory available in Kbyte.
523 * Doesn't change when memory has been allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000525 long_u
Bram Moolenaar05540972016-01-30 20:31:25 +0100526mch_total_mem(int special UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528 long_u mem = 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100529 long_u shiftright = 10; // how much to shift "mem" right for Kbyte
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530
Bram Moolenaar362dc332018-03-05 21:59:37 +0100531# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100532 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100533 // Mac (Darwin) way of getting the amount of RAM available
Bram Moolenaar988615f2018-02-27 17:58:20 +0100534 mach_port_t host = mach_host_self();
535 kern_return_t kret;
536# ifdef HOST_VM_INFO64
537 struct vm_statistics64 vm_stat;
538 natural_t count = HOST_VM_INFO64_COUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
Bram Moolenaar988615f2018-02-27 17:58:20 +0100540 kret = host_statistics64(host, HOST_VM_INFO64,
541 (host_info64_t)&vm_stat, &count);
542# else
543 struct vm_statistics vm_stat;
544 natural_t count = HOST_VM_INFO_COUNT;
545
546 kret = host_statistics(host, HOST_VM_INFO,
547 (host_info_t)&vm_stat, &count);
548# endif
549 if (kret == KERN_SUCCESS)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100550 // get the amount of user memory by summing each usage
Bram Moolenaar988615f2018-02-27 17:58:20 +0100551 mem = (long_u)(vm_stat.free_count + vm_stat.active_count
552 + vm_stat.inactive_count
553# ifdef MAC_OS_X_VERSION_10_9
554 + vm_stat.compressor_page_count
555# endif
Bram Moolenaar62b7f6a2018-03-22 21:44:07 +0100556 ) * sysconf(_SC_PAGESIZE);
Bram Moolenaar988615f2018-02-27 17:58:20 +0100557 mach_port_deallocate(mach_task_self(), host);
558 }
559# endif
560
561# ifdef HAVE_SYSCTL
562 if (mem == 0)
563 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100564 // BSD way of getting the amount of RAM available.
Bram Moolenaar988615f2018-02-27 17:58:20 +0100565 int mib[2];
566 size_t len = sizeof(long_u);
567# ifdef HW_USERMEM64
568 long_u physmem;
569# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100570 // sysctl() may return 32 bit or 64 bit, accept both
Bram Moolenaar988615f2018-02-27 17:58:20 +0100571 union {
572 int_u u32;
573 long_u u64;
574 } physmem;
575# endif
576
577 mib[0] = CTL_HW;
578# ifdef HW_USERMEM64
579 mib[1] = HW_USERMEM64;
580# else
581 mib[1] = HW_USERMEM;
582# endif
583 if (sysctl(mib, 2, &physmem, &len, NULL, 0) == 0)
584 {
585# ifdef HW_USERMEM64
586 mem = (long_u)physmem;
587# else
588 if (len == sizeof(physmem.u64))
589 mem = (long_u)physmem.u64;
590 else
591 mem = (long_u)physmem.u32;
592# endif
593 }
594 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200595# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200597# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 if (mem == 0)
599 {
600 struct sysinfo sinfo;
601
Bram Moolenaar0f873732019-12-05 20:28:46 +0100602 // Linux way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603 if (sysinfo(&sinfo) == 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000604 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200605# ifdef HAVE_SYSINFO_MEM_UNIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100606 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000607 while (shiftright > 0 && (sinfo.mem_unit & 1) == 0)
608 {
609 sinfo.mem_unit = sinfo.mem_unit >> 1;
610 --shiftright;
611 }
612 mem = sinfo.totalram * sinfo.mem_unit;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200613# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 mem = sinfo.totalram;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200615# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000616 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200618# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200620# ifdef HAVE_SYSCONF
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621 if (mem == 0)
622 {
623 long pagesize, pagecount;
624
Bram Moolenaar0f873732019-12-05 20:28:46 +0100625 // Solaris way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 pagesize = sysconf(_SC_PAGESIZE);
627 pagecount = sysconf(_SC_PHYS_PAGES);
628 if (pagesize > 0 && pagecount > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000629 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100630 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000631 while (shiftright > 0 && (pagesize & 1) == 0)
632 {
Bram Moolenaar3d27a452007-05-10 17:44:18 +0000633 pagesize = (long_u)pagesize >> 1;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000634 --shiftright;
635 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 mem = (long_u)pagesize * pagecount;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000637 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200639# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
Bram Moolenaar0f873732019-12-05 20:28:46 +0100641 // Return the minimum of the physical memory and the user limit, because
642 // using more than the user limit may cause Vim to be terminated.
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200643# if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 {
645 struct rlimit rlp;
646
647 if (getrlimit(RLIMIT_DATA, &rlp) == 0
648 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200649# ifdef RLIM_INFINITY
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 && rlp.rlim_cur != RLIM_INFINITY
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200651# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000652 && ((long_u)rlp.rlim_cur >> 10) < (mem >> shiftright)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 )
Bram Moolenaar914572a2007-05-01 11:37:47 +0000654 {
655 mem = (long_u)rlp.rlim_cur;
656 shiftright = 10;
657 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200659# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660
661 if (mem > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000662 return mem >> shiftright;
663 return (long_u)0x1fffff;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664}
665#endif
666
Bram Moolenaar0981c872020-08-23 14:28:37 +0200667/*
668 * "flags": MCH_DELAY_IGNOREINPUT - don't read input
669 * MCH_DELAY_SETTMODE - use settmode() even for short delays
670 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 void
Bram Moolenaar0981c872020-08-23 14:28:37 +0200672mch_delay(long msec, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673{
Bram Moolenaar26e86442020-05-17 14:06:16 +0200674 tmode_T old_tmode;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200675 int call_settmode;
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000676#ifdef FEAT_MZSCHEME
Bram Moolenaar0f873732019-12-05 20:28:46 +0100677 long total = msec; // remember original value
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000678#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679
Bram Moolenaar0981c872020-08-23 14:28:37 +0200680 if (flags & MCH_DELAY_IGNOREINPUT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100682 // Go to cooked mode without echo, to allow SIGINT interrupting us
683 // here. But we don't want QUIT to kill us (CTRL-\ used in a
684 // shell may produce SIGQUIT).
Bram Moolenaar26e86442020-05-17 14:06:16 +0200685 // Only do this if sleeping for more than half a second.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000686 in_mch_delay = TRUE;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200687 call_settmode = mch_cur_tmode == TMODE_RAW
688 && (msec > 500 || (flags & MCH_DELAY_SETTMODE));
689 if (call_settmode)
690 {
691 old_tmode = mch_cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 settmode(TMODE_SLEEP);
Bram Moolenaar80361a52020-10-05 21:39:25 +0200693 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694
695 /*
696 * Everybody sleeps in a different way...
697 * Prefer nanosleep(), some versions of usleep() can only sleep up to
698 * one second.
699 */
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000700#ifdef FEAT_MZSCHEME
701 do
702 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100703 // if total is large enough, wait by portions in p_mzq
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000704 if (total > p_mzq)
705 msec = p_mzq;
706 else
707 msec = total;
708 total -= msec;
709#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710#ifdef HAVE_NANOSLEEP
711 {
712 struct timespec ts;
713
714 ts.tv_sec = msec / 1000;
715 ts.tv_nsec = (msec % 1000) * 1000000;
716 (void)nanosleep(&ts, NULL);
717 }
718#else
719# ifdef HAVE_USLEEP
720 while (msec >= 1000)
721 {
722 usleep((unsigned int)(999 * 1000));
723 msec -= 999;
724 }
725 usleep((unsigned int)(msec * 1000));
726# else
727# ifndef HAVE_SELECT
728 poll(NULL, 0, (int)msec);
729# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730 {
731 struct timeval tv;
732
733 tv.tv_sec = msec / 1000;
734 tv.tv_usec = (msec % 1000) * 1000;
Bram Moolenaar0981c872020-08-23 14:28:37 +0200735 // NOTE: Solaris 2.6 has a bug that makes select() hang here. Get
736 // a patch from Sun to fix this. Reported by Gunnar Pedersen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 select(0, NULL, NULL, NULL, &tv);
738 }
Michael Jarvisbe9624e2023-04-19 20:28:48 +0100739# endif
740# endif
741#endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000742#ifdef FEAT_MZSCHEME
743 }
744 while (total > 0);
745#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746
Bram Moolenaar80361a52020-10-05 21:39:25 +0200747 if (call_settmode)
Bram Moolenaar26e86442020-05-17 14:06:16 +0200748 settmode(old_tmode);
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000749 in_mch_delay = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 }
751 else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200752 WaitForChar(msec, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753}
754
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000755#if defined(HAVE_STACK_LIMIT) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756 || (!defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGSTACK))
757# define HAVE_CHECK_STACK_GROWTH
758/*
759 * Support for checking for an almost-out-of-stack-space situation.
760 */
761
762/*
763 * Return a pointer to an item on the stack. Used to find out if the stack
764 * grows up or down.
765 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766static int stack_grows_downwards;
767
768/*
769 * Find out if the stack grows upwards or downwards.
770 * "p" points to a variable on the stack of the caller.
771 */
772 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100773check_stack_growth(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774{
775 int i;
776
777 stack_grows_downwards = (p > (char *)&i);
778}
779#endif
780
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000781#if defined(HAVE_STACK_LIMIT) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782static char *stack_limit = NULL;
783
784#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
785# include <pthread.h>
786# include <pthread_np.h>
787#endif
788
789/*
790 * Find out until how var the stack can grow without getting into trouble.
791 * Called when starting up and when switching to the signal stack in
792 * deathtrap().
793 */
794 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100795get_stack_limit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796{
797 struct rlimit rlp;
798 int i;
799 long lim;
800
Bram Moolenaar0f873732019-12-05 20:28:46 +0100801 // Set the stack limit to 15/16 of the allowable size. Skip this when the
802 // limit doesn't fit in a long (rlim_cur might be "long long").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 if (getrlimit(RLIMIT_STACK, &rlp) == 0
804 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
805# ifdef RLIM_INFINITY
806 && rlp.rlim_cur != RLIM_INFINITY
807# endif
808 )
809 {
810 lim = (long)rlp.rlim_cur;
811#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
812 {
813 pthread_attr_t attr;
814 size_t size;
815
Bram Moolenaar0f873732019-12-05 20:28:46 +0100816 // On FreeBSD the initial thread always has a fixed stack size, no
817 // matter what the limits are set to. Normally it's 1 Mbyte.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 pthread_attr_init(&attr);
819 if (pthread_attr_get_np(pthread_self(), &attr) == 0)
820 {
821 pthread_attr_getstacksize(&attr, &size);
822 if (lim > (long)size)
823 lim = (long)size;
824 }
825 pthread_attr_destroy(&attr);
826 }
827#endif
828 if (stack_grows_downwards)
829 {
830 stack_limit = (char *)((long)&i - (lim / 16L * 15L));
831 if (stack_limit >= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100832 // overflow, set to 1/16 of current stack position
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 stack_limit = (char *)((long)&i / 16L);
834 }
835 else
836 {
837 stack_limit = (char *)((long)&i + (lim / 16L * 15L));
838 if (stack_limit <= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100839 stack_limit = NULL; // overflow
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 }
841 }
842}
843
844/*
845 * Return FAIL when running out of stack space.
846 * "p" must point to any variable local to the caller that's on the stack.
847 */
848 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100849mch_stackcheck(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000851 if (stack_limit == NULL)
852 return OK;
853
854 if (stack_grows_downwards)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000856 if (p < stack_limit)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857 return FAIL;
858 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000859 else if (p > stack_limit)
860 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 return OK;
862}
863#endif
864
865#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
866/*
867 * Support for using the signal stack.
868 * This helps when we run out of stack space, which causes a SIGSEGV. The
869 * signal handler then must run on another stack, since the normal stack is
870 * completely full.
871 */
872
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873# ifdef HAVE_SIGALTSTACK
Bram Moolenaar0f873732019-12-05 20:28:46 +0100874static stack_t sigstk; // for sigaltstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100876static struct sigstack sigstk; // for sigstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877# endif
878
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200879/*
880 * Get a size of signal stack.
881 * Preference (if available): sysconf > SIGSTKSZ > guessed size
882 */
Michael Jarvisbe9624e2023-04-19 20:28:48 +0100883static long int get_signal_stack_size(void)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200884{
885# ifdef HAVE_SYSCONF_SIGSTKSZ
886 long int size = -1;
887
888 // return size only if sysconf doesn't return an error
889 if ((size = sysconf(_SC_SIGSTKSZ)) > -1)
890 return size;
891# endif
892
893# ifdef SIGSTKSZ
894 // if sysconf() isn't available or gives error, return SIGSTKSZ
895 // if defined
896 return SIGSTKSZ;
897# endif
898
899 // otherwise guess the size
900 return 8000;
901}
902
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903static char *signal_stack;
904
905 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100906init_signal_stack(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000908 if (signal_stack == NULL)
909 return;
910
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911# ifdef HAVE_SIGALTSTACK
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912# ifdef HAVE_SS_BASE
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000913 sigstk.ss_base = signal_stack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000915 sigstk.ss_sp = signal_stack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000917 sigstk.ss_size = get_signal_stack_size();
918 sigstk.ss_flags = 0;
919 (void)sigaltstack(&sigstk, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000921 sigstk.ss_sp = signal_stack;
922 if (stack_grows_downwards)
923 sigstk.ss_sp += get_signal_stack_size() - 1;
924 sigstk.ss_onstack = 0;
925 (void)sigstack(&sigstk, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927}
928#endif
929
930/*
Bram Moolenaar76243bd2009-03-02 01:47:02 +0000931 * We need correct prototypes for a signal function, otherwise mean compilers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 * will barf when the second argument to signal() is ``wrong''.
933 * Let me try it with a few tricky defines from my own osdef.h (jw).
934 */
935#if defined(SIGWINCH)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100936 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937sig_winch SIGDEFARG(sigarg)
938{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100939 // this is not required on all systems, but it doesn't hurt anybody
ichizok378447f2023-05-11 22:25:42 +0100940 mch_signal(SIGWINCH, sig_winch);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 do_resize = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942}
943#endif
944
dbivolaruab16ad32021-12-29 19:41:47 +0000945#if defined(SIGTSTP)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100946 static void
dbivolaruab16ad32021-12-29 19:41:47 +0000947sig_tstp SIGDEFARG(sigarg)
948{
949 // Second time we get called we actually need to suspend
950 if (in_mch_suspend)
951 {
ichizok378447f2023-05-11 22:25:42 +0100952 mch_signal(SIGTSTP, ignore_sigtstp ? SIG_IGN : SIG_DFL);
dbivolaruab16ad32021-12-29 19:41:47 +0000953 raise(sigarg);
954 }
dbivolaru79a6e252022-01-23 16:41:14 +0000955 else
956 got_tstp = TRUE;
dbivolaruab16ad32021-12-29 19:41:47 +0000957
ichizok5f823d12022-03-13 17:27:38 +0000958#if !defined(__ANDROID__) && !defined(__OpenBSD__) && !defined(__DragonFly__)
959 // This is not required on all systems. On some systems (at least Android,
960 // OpenBSD, and DragonFlyBSD) this breaks suspending with CTRL-Z.
ichizok378447f2023-05-11 22:25:42 +0100961 mch_signal(SIGTSTP, sig_tstp);
xtkobacbef12e2022-02-27 12:31:52 +0000962#endif
dbivolaruab16ad32021-12-29 19:41:47 +0000963}
964#endif
965
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966#if defined(SIGINT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100967 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968catch_sigint SIGDEFARG(sigarg)
969{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100970 // this is not required on all systems, but it doesn't hurt anybody
ichizok378447f2023-05-11 22:25:42 +0100971 mch_signal(SIGINT, catch_sigint);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 got_int = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973}
974#endif
975
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200976#if defined(SIGUSR1)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100977 static void
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200978catch_sigusr1 SIGDEFARG(sigarg)
979{
980 // this is not required on all systems, but it doesn't hurt anybody
ichizok378447f2023-05-11 22:25:42 +0100981 mch_signal(SIGUSR1, catch_sigusr1);
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200982 got_sigusr1 = TRUE;
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200983}
984#endif
985
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986#if defined(SIGPWR)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100987 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988catch_sigpwr SIGDEFARG(sigarg)
989{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100990 // this is not required on all systems, but it doesn't hurt anybody
ichizok378447f2023-05-11 22:25:42 +0100991 mch_signal(SIGPWR, catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 /*
993 * I'm not sure we get the SIGPWR signal when the system is really going
994 * down or when the batteries are almost empty. Just preserve the swap
995 * files and don't exit, that can't do any harm.
996 */
997 ml_sync_all(FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998}
999#endif
1000
1001#ifdef SET_SIG_ALARM
1002/*
1003 * signal function for alarm().
1004 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001005 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006sig_alarm SIGDEFARG(sigarg)
1007{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001008 // doesn't do anything, just to break a system call
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 sig_alarm_called = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010}
1011#endif
1012
Bram Moolenaaredce7422019-01-20 18:39:30 +01001013#if (defined(HAVE_SETJMP_H) \
1014 && ((defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) \
1015 || defined(FEAT_LIBCALL))) \
1016 || defined(PROTO)
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001017# define USING_SETJMP 1
Bram Moolenaaredce7422019-01-20 18:39:30 +01001018
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001019// argument to SETJMP()
1020static JMP_BUF lc_jump_env;
1021
1022# ifdef SIGHASARG
Bram Moolenaar32aa1022019-11-02 22:54:41 +01001023// Caught signal number, 0 when no signal was caught; used for mch_libcall().
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001024// Volatile because it is used in signal handlers.
1025static volatile sig_atomic_t lc_signal;
1026# endif
1027
1028// TRUE when lc_jump_env is valid.
1029// Volatile because it is used in signal handler deathtrap().
zeertzjq9b7d2a92022-08-26 10:33:54 +01001030static volatile sig_atomic_t lc_active = FALSE;
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001031
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032/*
1033 * A simplistic version of setjmp() that only allows one level of using.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001034 * Used to protect areas where we could crash.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 * Don't call twice before calling mch_endjmp()!.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001036 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 * Usage:
1038 * mch_startjmp();
1039 * if (SETJMP(lc_jump_env) != 0)
1040 * {
1041 * mch_didjmp();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001042 * emsg("crash!");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 * }
1044 * else
1045 * {
1046 * do_the_work;
1047 * mch_endjmp();
1048 * }
1049 * Note: Can't move SETJMP() here, because a function calling setjmp() must
1050 * not return before the saved environment is used.
1051 * Returns OK for normal return, FAIL when the protected code caused a
1052 * problem and LONGJMP() was used.
1053 */
Bram Moolenaar113e1072019-01-20 15:30:40 +01001054 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001055mch_startjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056{
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001057# ifdef SIGHASARG
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 lc_signal = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001059# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 lc_active = TRUE;
1061}
1062
Bram Moolenaar113e1072019-01-20 15:30:40 +01001063 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001064mch_endjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065{
1066 lc_active = FALSE;
1067}
1068
Bram Moolenaar113e1072019-01-20 15:30:40 +01001069 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001070mch_didjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071{
1072# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001073 // On FreeBSD the signal stack has to be reset after using siglongjmp(),
1074 // otherwise catching the signal only works once.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 init_signal_stack();
1076# endif
1077}
1078#endif
1079
1080/*
1081 * This function handles deadly signals.
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001082 * It tries to preserve any swap files and exit properly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 * (partly from Elvis).
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001084 * NOTE: Avoid unsafe functions, such as allocating memory, they can result in
1085 * a deadlock.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001087 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088deathtrap SIGDEFARG(sigarg)
1089{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001090 static int entered = 0; // count the number of times we got here.
1091 // Note: when memory has been corrupted
1092 // this may get an arbitrary value!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093#ifdef SIGHASARG
1094 int i;
1095#endif
1096
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001097#if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098 /*
1099 * Catch a crash in protected code.
1100 * Restores the environment saved in lc_jump_env, which looks like
1101 * SETJMP() returns 1.
1102 */
1103 if (lc_active)
1104 {
1105# if defined(SIGHASARG)
1106 lc_signal = sigarg;
1107# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001108 lc_active = FALSE; // don't jump again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 LONGJMP(lc_jump_env, 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001110 // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 }
1112#endif
1113
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001114#ifdef SIGHASARG
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001115# ifdef SIGQUIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001116 // While in mch_delay() we go to cooked mode to allow a CTRL-C to
1117 // interrupt us. But in cooked mode we may also get SIGQUIT, e.g., when
1118 // pressing CTRL-\, but we don't want Vim to exit then.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001119 if (in_mch_delay && sigarg == SIGQUIT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001120 return;
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001121# endif
1122
Bram Moolenaar0f873732019-12-05 20:28:46 +01001123 // When SIGHUP, SIGQUIT, etc. are blocked: postpone the effect and return
1124 // here. This avoids that a non-reentrant function is interrupted, e.g.,
1125 // free(). Calling free() again may then cause a crash.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001126 if (entered == 0
1127 && (0
1128# ifdef SIGHUP
1129 || sigarg == SIGHUP
1130# endif
1131# ifdef SIGQUIT
1132 || sigarg == SIGQUIT
1133# endif
1134# ifdef SIGTERM
1135 || sigarg == SIGTERM
1136# endif
1137# ifdef SIGPWR
1138 || sigarg == SIGPWR
1139# endif
1140# ifdef SIGUSR1
1141 || sigarg == SIGUSR1
1142# endif
1143# ifdef SIGUSR2
1144 || sigarg == SIGUSR2
1145# endif
1146 )
Bram Moolenaar1f28b072005-07-12 22:42:41 +00001147 && !vim_handle_signal(sigarg))
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001148 return;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001149#endif
1150
Bram Moolenaar0f873732019-12-05 20:28:46 +01001151 // Remember how often we have been called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 ++entered;
1153
Bram Moolenaar0f873732019-12-05 20:28:46 +01001154 // Executing autocommands is likely to use more stack space than we have
1155 // available in the signal stack.
Bram Moolenaare429e702016-06-10 19:49:14 +02001156 block_autocmds();
Bram Moolenaare429e702016-06-10 19:49:14 +02001157
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158#ifdef FEAT_EVAL
Bram Moolenaar0f873732019-12-05 20:28:46 +01001159 // Set the v:dying variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160 set_vim_var_nr(VV_DYING, (long)entered);
1161#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001162 v_dying = entered;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001164#ifdef HAVE_STACK_LIMIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001165 // Since we are now using the signal stack, need to reset the stack
1166 // limit. Otherwise using a regexp will fail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 get_stack_limit();
1168#endif
1169
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001170#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01001171 // This is for opening gdb the moment Vim crashes.
1172 // You need to manually adjust the file name and Vim executable name.
1173 // Suggested by SungHyun Nam.
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001174 {
1175# define VI_GDB_FILE "/tmp/vimgdb"
1176# define VIM_NAME "/usr/bin/vim"
1177 FILE *fp = fopen(VI_GDB_FILE, "w");
1178 if (fp)
1179 {
1180 fprintf(fp,
1181 "file %s\n"
1182 "attach %d\n"
1183 "set height 1000\n"
1184 "bt full\n"
1185 , VIM_NAME, getpid());
1186 fclose(fp);
1187 system("xterm -e gdb -x "VI_GDB_FILE);
1188 unlink(VI_GDB_FILE);
1189 }
1190 }
1191#endif
1192
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193#ifdef SIGHASARG
Bram Moolenaar0f873732019-12-05 20:28:46 +01001194 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 for (i = 0; signal_info[i].sig != -1; i++)
1196 if (sigarg == signal_info[i].sig)
1197 break;
1198 deadly_signal = sigarg;
1199#endif
1200
Bram Moolenaar0f873732019-12-05 20:28:46 +01001201 full_screen = FALSE; // don't write message to the GUI, it might be
1202 // part of the problem...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 /*
1204 * If something goes wrong after entering here, we may get here again.
1205 * When this happens, give a message and try to exit nicely (resetting the
1206 * terminal mode, etc.)
1207 * When this happens twice, just exit, don't even try to give a message,
1208 * stack may be corrupt or something weird.
1209 * When this still happens again (or memory was corrupted in such a way
1210 * that "entered" was clobbered) use _exit(), don't try freeing resources.
1211 */
1212 if (entered >= 3)
1213 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001214 reset_signals(); // don't catch any signals anymore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 may_core_dump();
1216 if (entered >= 4)
1217 _exit(8);
1218 exit(7);
1219 }
1220 if (entered == 2)
1221 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001222 // No translation, it may call malloc().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001223 OUT_STR("Vim: Double signal, exiting\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 out_flush();
1225 getout(1);
1226 }
1227
Bram Moolenaar0f873732019-12-05 20:28:46 +01001228 // No translation, it may call malloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229#ifdef SIGHASARG
Bram Moolenaar69212b12020-05-10 14:14:03 +02001230 sprintf((char *)IObuff, "Vim: Caught deadly signal %s\r\n",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 signal_info[i].name);
1232#else
Bram Moolenaar69212b12020-05-10 14:14:03 +02001233 sprintf((char *)IObuff, "Vim: Caught deadly signal\r\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234#endif
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001235
Bram Moolenaar0f873732019-12-05 20:28:46 +01001236 // Preserve files and exit. This sets the really_exiting flag to prevent
1237 // calling free().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001238 preserve_exit();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar0f873732019-12-05 20:28:46 +01001240 // NOTREACHED
Bram Moolenaare429e702016-06-10 19:49:14 +02001241
Bram Moolenaar009b2592004-10-24 19:18:58 +00001242#ifdef NBDEBUG
1243 reset_signals();
1244 may_core_dump();
1245 abort();
1246#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247}
1248
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02001250 * Invoked after receiving SIGCONT. We don't know what happened while
1251 * sleeping, deal with part of that.
1252 */
1253 static void
1254after_sigcont(void)
1255{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001256 // Don't change "oldtitle" in a signal handler, set a flag to obtain it
1257 // again later.
1258 oldtitle_outdated = TRUE;
Bram Moolenaar651fca82021-11-29 20:39:38 +00001259
Bram Moolenaar2e310482018-08-21 13:09:10 +02001260 settmode(TMODE_RAW);
1261 need_check_timestamps = TRUE;
1262 did_check_timestamps = FALSE;
1263}
1264
1265#if defined(SIGCONT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001266static void sigcont_handler SIGPROTOARG;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001267
1268/*
1269 * With multi-threading, suspending might not work immediately. Catch the
1270 * SIGCONT signal, which will be used as an indication whether the suspending
1271 * has been done or not.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001272 *
1273 * On Linux, signal is not always handled immediately either.
1274 * See https://bugs.launchpad.net/bugs/291373
Bram Moolenaar2e310482018-08-21 13:09:10 +02001275 * Probably because the signal is handled in another thread.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001276 *
Bram Moolenaarb292a2a2011-02-09 18:47:40 +01001277 * volatile because it is used in signal handler sigcont_handler().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 */
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001279static volatile sig_atomic_t sigcont_received;
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001280static void sigcont_handler SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281
1282/*
1283 * signal handler for SIGCONT
1284 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001285 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286sigcont_handler SIGDEFARG(sigarg)
1287{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001288 if (in_mch_suspend)
1289 {
1290 sigcont_received = TRUE;
1291 }
1292 else
1293 {
1294 // We didn't suspend ourselves, assume we were stopped by a SIGSTOP
1295 // signal (which can't be intercepted) and get a SIGCONT. Need to get
1296 // back to a sane mode. We should redraw, but we can't really do that
1297 // in a signal handler, do a redraw later.
1298 after_sigcont();
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001299 redraw_later(UPD_CLEAR);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001300 cursor_on_force();
1301 out_flush();
1302 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303}
1304#endif
1305
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02001306#if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001307# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001308static void *clip_star_save = NULL;
1309static void *clip_plus_save = NULL;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001310# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001311
1312/*
1313 * Called when Vim is going to sleep or execute a shell command.
1314 * We can't respond to requests for the X selections. Lose them, otherwise
1315 * other applications will hang. But first copy the text to cut buffer 0.
1316 */
1317 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001318loose_clipboard(void)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001319{
1320 if (clip_star.owned || clip_plus.owned)
1321 {
1322 x11_export_final_selection();
1323 if (clip_star.owned)
1324 clip_lose_selection(&clip_star);
1325 if (clip_plus.owned)
1326 clip_lose_selection(&clip_plus);
1327 if (x11_display != NULL)
1328 XFlush(x11_display);
1329 }
1330}
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001331
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001332# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001333/*
1334 * Save clipboard text to restore later.
1335 */
1336 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001337save_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001338{
1339 if (clip_star.owned)
1340 clip_star_save = get_register('*', TRUE);
1341 if (clip_plus.owned)
1342 clip_plus_save = get_register('+', TRUE);
1343}
1344
1345/*
1346 * Restore clipboard text if no one own the X selection.
1347 */
1348 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001349restore_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001350{
1351 if (clip_star_save != NULL)
1352 {
1353 if (!clip_gen_owner_exists(&clip_star))
1354 put_register('*', clip_star_save);
1355 else
1356 free_register(clip_star_save);
1357 clip_star_save = NULL;
1358 }
1359 if (clip_plus_save != NULL)
1360 {
1361 if (!clip_gen_owner_exists(&clip_plus))
1362 put_register('+', clip_plus_save);
1363 else
1364 free_register(clip_plus_save);
1365 clip_plus_save = NULL;
1366 }
1367}
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001368# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001369#endif
1370
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371/*
1372 * If the machine has job control, use it to suspend the program,
1373 * otherwise fake it by starting a new shell.
1374 */
1375 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001376mch_suspend(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377{
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001378 if (ignore_sigtstp)
1379 return;
1380
Bram Moolenaar041c7102020-05-30 18:14:57 +02001381#if defined(SIGTSTP)
Bram Moolenaar2e310482018-08-21 13:09:10 +02001382 in_mch_suspend = TRUE;
1383
Bram Moolenaar0f873732019-12-05 20:28:46 +01001384 out_flush(); // needed to make cursor visible on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 settmode(TMODE_COOK);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001386 out_flush(); // needed to disable mouse on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387
1388# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001389 loose_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001391# if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 sigcont_received = FALSE;
1393# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001394
Bram Moolenaar0f873732019-12-05 20:28:46 +01001395 kill(0, SIGTSTP); // send ourselves a STOP signal
Bram Moolenaar2e310482018-08-21 13:09:10 +02001396
1397# if defined(SIGCONT)
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001398 /*
1399 * Wait for the SIGCONT signal to be handled. It generally happens
Bram Moolenaar2e310482018-08-21 13:09:10 +02001400 * immediately, but somehow not all the time, probably because it's handled
1401 * in another thread. Do not call pause() because there would be race
1402 * condition which would hang Vim if signal happened in between the test of
1403 * sigcont_received and the call to pause(). If signal is not yet received,
1404 * sleep 0, 1, 2, 3 ms. Don't bother waiting further if signal is not
1405 * received after 1+2+3 ms (not expected to happen).
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001406 */
1407 {
Bram Moolenaar262735e2009-07-14 10:20:22 +00001408 long wait_time;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001409
Bram Moolenaar262735e2009-07-14 10:20:22 +00001410 for (wait_time = 0; !sigcont_received && wait_time <= 3L; wait_time++)
Bram Moolenaar0981c872020-08-23 14:28:37 +02001411 mch_delay(wait_time, 0);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001412 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001414 in_mch_suspend = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
Bram Moolenaar2e310482018-08-21 13:09:10 +02001416 after_sigcont();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417#else
1418 suspend_shell();
1419#endif
1420}
1421
1422 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001423mch_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424{
1425 Columns = 80;
1426 Rows = 24;
1427
1428 out_flush();
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001429
1430#ifdef SIGTSTP
1431 // Check whether we were invoked with SIGTSTP set to be ignored. If it is
1432 // that indicates the shell (or program) that launched us does not support
1433 // tty job control and thus we should ignore that signal. If invoked as a
1434 // restricted editor (e.g., as "rvim") SIGTSTP is always ignored.
ichizok378447f2023-05-11 22:25:42 +01001435 ignore_sigtstp = restricted || SIG_IGN == mch_signal(SIGTSTP, SIG_ERR);
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001436#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 set_signals();
Bram Moolenaardf177f62005-02-22 08:39:57 +00001438
Bram Moolenaar56718732006-03-15 22:53:57 +00001439#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001440 mac_conv_init();
1441#endif
Bram Moolenaar693e40c2013-02-26 14:56:42 +01001442#ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
1443 win_clip_init();
1444#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445}
1446
1447 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001448set_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449{
1450#if defined(SIGWINCH)
1451 /*
1452 * WINDOW CHANGE signal is handled with sig_winch().
1453 */
ichizok378447f2023-05-11 22:25:42 +01001454 mch_signal(SIGWINCH, sig_winch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455#endif
1456
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457#ifdef SIGTSTP
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001458 // See mch_init() for the conditions under which we ignore SIGTSTP.
Bram Moolenaar8e4af852022-01-24 12:20:45 +00001459 // In the GUI default TSTP processing is OK.
1460 // Checking both gui.in_use and gui.starting because gui.in_use is not set
1461 // at this point (set after menus are displayed), but gui.starting is set.
ichizok378447f2023-05-11 22:25:42 +01001462 mch_signal(SIGTSTP, ignore_sigtstp ? SIG_IGN
Bram Moolenaar8e4af852022-01-24 12:20:45 +00001463# ifdef FEAT_GUI
1464 : gui.in_use || gui.starting ? SIG_DFL
1465# endif
ichizok378447f2023-05-11 22:25:42 +01001466 : sig_tstp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467#endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001468#if defined(SIGCONT)
ichizok378447f2023-05-11 22:25:42 +01001469 mch_signal(SIGCONT, sigcont_handler);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001471#ifdef SIGPIPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 /*
1473 * We want to ignore breaking of PIPEs.
1474 */
ichizok378447f2023-05-11 22:25:42 +01001475 mch_signal(SIGPIPE, SIG_IGN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476#endif
1477
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478#ifdef SIGINT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001479 catch_int_signal();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480#endif
1481
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001482#ifdef SIGUSR1
1483 /*
1484 * Call user's handler on SIGUSR1
1485 */
ichizok378447f2023-05-11 22:25:42 +01001486 mch_signal(SIGUSR1, catch_sigusr1);
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001487#endif
1488
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 /*
1490 * Ignore alarm signals (Perl's alarm() generates it).
1491 */
1492#ifdef SIGALRM
ichizok378447f2023-05-11 22:25:42 +01001493 mch_signal(SIGALRM, SIG_IGN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494#endif
1495
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001496#ifdef SIGPWR
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 /*
1498 * Catch SIGPWR (power failure?) to preserve the swap files, so that no
1499 * work will be lost.
1500 */
ichizok378447f2023-05-11 22:25:42 +01001501 mch_signal(SIGPWR, catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502#endif
1503
1504 /*
1505 * Arrange for other signals to gracefully shutdown Vim.
1506 */
1507 catch_signals(deathtrap, SIG_ERR);
1508
1509#if defined(FEAT_GUI) && defined(SIGHUP)
1510 /*
1511 * When the GUI is running, ignore the hangup signal.
1512 */
1513 if (gui.in_use)
ichizok378447f2023-05-11 22:25:42 +01001514 mch_signal(SIGHUP, SIG_IGN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515#endif
1516}
1517
Bram Moolenaardf177f62005-02-22 08:39:57 +00001518#if defined(SIGINT) || defined(PROTO)
1519/*
1520 * Catch CTRL-C (only works while in Cooked mode).
1521 */
1522 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001523catch_int_signal(void)
Bram Moolenaardf177f62005-02-22 08:39:57 +00001524{
ichizok378447f2023-05-11 22:25:42 +01001525 mch_signal(SIGINT, catch_sigint);
Bram Moolenaardf177f62005-02-22 08:39:57 +00001526}
1527#endif
1528
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001530reset_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531{
1532 catch_signals(SIG_DFL, SIG_DFL);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001533#if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001534 // SIGCONT isn't in the list, because its default action is ignore
ichizok378447f2023-05-11 22:25:42 +01001535 mch_signal(SIGCONT, SIG_DFL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536#endif
1537}
1538
1539 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001540catch_signals(
Michael Jarvisbe9624e2023-04-19 20:28:48 +01001541 void (*func_deadly)(int),
1542 void (*func_other)(int))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543{
1544 int i;
1545
1546 for (i = 0; signal_info[i].sig != -1; i++)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001547 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 if (signal_info[i].deadly)
1549 {
1550#if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION)
1551 struct sigaction sa;
1552
Bram Moolenaar0f873732019-12-05 20:28:46 +01001553 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 sa.sa_handler = func_deadly;
1555 sigemptyset(&sa.sa_mask);
1556# if defined(__linux__) && defined(_REENTRANT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001557 // On Linux, with glibc compiled for kernel 2.2, there is a bug in
1558 // thread handling in combination with using the alternate stack:
1559 // pthread library functions try to use the stack pointer to
1560 // identify the current thread, causing a SEGV signal, which
1561 // recursively calls deathtrap() and hangs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 sa.sa_flags = 0;
1563# else
1564 sa.sa_flags = SA_ONSTACK;
1565# endif
1566 sigaction(signal_info[i].sig, &sa, NULL);
1567#else
1568# if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGVEC)
1569 struct sigvec sv;
1570
Bram Moolenaar0f873732019-12-05 20:28:46 +01001571 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 sv.sv_handler = func_deadly;
1573 sv.sv_mask = 0;
1574 sv.sv_flags = SV_ONSTACK;
1575 sigvec(signal_info[i].sig, &sv, NULL);
1576# else
ichizok378447f2023-05-11 22:25:42 +01001577 mch_signal(signal_info[i].sig, func_deadly);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578# endif
1579#endif
1580 }
1581 else if (func_other != SIG_ERR)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001582 {
1583 // Deal with non-deadly signals.
1584#ifdef SIGTSTP
ichizok378447f2023-05-11 22:25:42 +01001585 mch_signal(signal_info[i].sig,
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001586 signal_info[i].sig == SIGTSTP && ignore_sigtstp
1587 ? SIG_IGN : func_other);
1588#else
ichizok378447f2023-05-11 22:25:42 +01001589 mch_signal(signal_info[i].sig, func_other);
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001590#endif
1591 }
1592 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593}
1594
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001595#ifdef HAVE_SIGPROCMASK
1596 static void
1597block_signals(sigset_t *set)
1598{
1599 sigset_t newset;
1600 int i;
1601
1602 sigemptyset(&newset);
1603
1604 for (i = 0; signal_info[i].sig != -1; i++)
1605 sigaddset(&newset, signal_info[i].sig);
1606
Bram Moolenaar2e310482018-08-21 13:09:10 +02001607# if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001608 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001609 sigaddset(&newset, SIGCONT);
1610# endif
1611
1612 sigprocmask(SIG_BLOCK, &newset, set);
1613}
1614
1615 static void
1616unblock_signals(sigset_t *set)
1617{
1618 sigprocmask(SIG_SETMASK, set, NULL);
1619}
1620#endif
1621
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622/*
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001623 * Handling of SIGHUP, SIGQUIT and SIGTERM:
Bram Moolenaar9e1d2832007-05-06 12:51:41 +00001624 * "when" == a signal: when busy, postpone and return FALSE, otherwise
1625 * return TRUE
1626 * "when" == SIGNAL_BLOCK: Going to be busy, block signals
1627 * "when" == SIGNAL_UNBLOCK: Going to wait, unblock signals, use postponed
Bram Moolenaar67c53842010-05-22 18:28:27 +02001628 * signal
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001629 * Returns TRUE when Vim should exit.
1630 */
1631 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001632vim_handle_signal(int sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001633{
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001634 static int got_signal = 0;
1635 static int blocked = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001636
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001637 switch (sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001638 {
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001639 case SIGNAL_BLOCK: blocked = TRUE;
1640 break;
1641
1642 case SIGNAL_UNBLOCK: blocked = FALSE;
1643 if (got_signal != 0)
1644 {
1645 kill(getpid(), got_signal);
1646 got_signal = 0;
1647 }
1648 break;
1649
1650 default: if (!blocked)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001651 return TRUE; // exit!
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001652 got_signal = sig;
1653#ifdef SIGPWR
1654 if (sig != SIGPWR)
1655#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001656 got_int = TRUE; // break any loops
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001657 break;
1658 }
1659 return FALSE;
1660}
1661
1662/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 * Check_win checks whether we have an interactive stdout.
1664 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001666mch_check_win(int argc UNUSED, char **argv UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 if (isatty(1))
1669 return OK;
1670 return FAIL;
1671}
1672
1673/*
1674 * Return TRUE if the input comes from a terminal, FALSE otherwise.
1675 */
1676 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001677mch_input_isatty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678{
1679 if (isatty(read_cmd_fd))
1680 return TRUE;
1681 return FALSE;
1682}
1683
1684#ifdef FEAT_X11
1685
Bram Moolenaar651fca82021-11-29 20:39:38 +00001686# if defined(ELAPSED_TIMEVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688/*
1689 * Give a message about the elapsed time for opening the X window.
1690 */
1691 static void
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001692xopen_message(long elapsed_msec)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001694 smsg(_("Opening the X display took %ld msec"), elapsed_msec);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695}
1696# endif
1697#endif
1698
Bram Moolenaar651fca82021-11-29 20:39:38 +00001699#if defined(FEAT_X11)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700/*
1701 * A few functions shared by X11 title and clipboard code.
1702 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703
1704static int got_x_error = FALSE;
1705
1706/*
1707 * X Error handler, otherwise X just exits! (very rude) -- webb
1708 */
1709 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001710x_error_handler(Display *dpy, XErrorEvent *error_event)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711{
Bram Moolenaar843ee412004-06-30 16:16:41 +00001712 XGetErrorText(dpy, error_event->error_code, (char *)IObuff, IOSIZE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 STRCAT(IObuff, _("\nVim: Got X error\n"));
1714
Bram Moolenaarb1062eb2020-05-09 16:11:33 +02001715 // In the GUI we cannot print a message and continue, because no X calls
1716 // are allowed here (causes my system to hang). Silently continuing seems
1717 // like the best alternative. Do preserve files, in case we crash.
1718 ml_sync_all(FALSE, FALSE);
1719
1720#ifdef FEAT_GUI
1721 if (!gui.in_use)
1722#endif
1723 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
Bram Moolenaar0f873732019-12-05 20:28:46 +01001725 return 0; // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726}
1727
1728/*
1729 * Another X Error handler, just used to check for errors.
1730 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001732x_error_check(Display *dpy UNUSED, XErrorEvent *error_event UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733{
1734 got_x_error = TRUE;
1735 return 0;
1736}
1737
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001738/*
1739 * Return TRUE when connection to the X server is desired.
1740 */
1741 static int
1742x_connect_to_server(void)
1743{
1744 // No point in connecting if we are exiting or dying.
1745 if (exiting || v_dying)
1746 return FALSE;
1747
1748#if defined(FEAT_CLIENTSERVER)
1749 if (x_force_connect)
1750 return TRUE;
1751#endif
1752 if (x_no_connect)
1753 return FALSE;
1754
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001755 // Check for a match with "exclude:" from 'clipboard'.
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001756 if (clip_exclude_prog != NULL)
1757 {
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001758 // Just in case we get called recursively, return FALSE. This could
1759 // happen if vpeekc() is used while executing the prog and it causes a
1760 // related callback to be invoked.
1761 if (regprog_in_use(clip_exclude_prog))
1762 return FALSE;
1763
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001764 if (vim_regexec_prog(&clip_exclude_prog, FALSE, T_NAME, (colnr_T)0))
1765 return FALSE;
1766 }
1767 return TRUE;
1768}
1769
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001771# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772/*
1773 * An X IO Error handler, used to catch error while opening the display.
1774 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001776x_IOerror_check(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001778 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 LONGJMP(lc_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001780# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001781 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001782# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783}
1784# endif
1785
1786/*
1787 * An X IO Error handler, used to catch terminal errors.
1788 */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001789static int xterm_dpy_retry_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001792x_IOerror_handler(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793{
1794 xterm_dpy = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001795 xterm_dpy_retry_count = 5; // Try reconnecting five times
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 x11_window = 0;
1797 x11_display = NULL;
1798 xterm_Shell = (Widget)0;
1799
Bram Moolenaar0f873732019-12-05 20:28:46 +01001800 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 LONGJMP(x_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001802# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001803 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001804# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805}
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001806
1807/*
1808 * If the X11 connection was lost try to restore it.
1809 * Helps when the X11 server was stopped and restarted while Vim was inactive
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01001810 * (e.g. through tmux).
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001811 */
1812 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001813may_restore_clipboard(void)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001814{
Bram Moolenaar01e51e52018-12-29 13:09:46 +01001815 // No point in restoring the connecting if we are exiting or dying.
1816 if (!exiting && !v_dying && xterm_dpy_retry_count > 0)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001817 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001818 --xterm_dpy_retry_count;
Bram Moolenaar527a6782014-12-17 17:59:31 +01001819
1820# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01001821 // This has been reported to avoid Vim getting stuck.
Bram Moolenaar527a6782014-12-17 17:59:31 +01001822 if (app_context != (XtAppContext)NULL)
1823 {
1824 XtDestroyApplicationContext(app_context);
1825 app_context = (XtAppContext)NULL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001826 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaar527a6782014-12-17 17:59:31 +01001827 }
1828# endif
1829
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001830 setup_term_clip();
1831 get_x11_title(FALSE);
1832 }
1833}
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001834
1835 void
1836ex_xrestore(exarg_T *eap)
1837{
1838 if (eap->arg != NULL && STRLEN(eap->arg) > 0)
1839 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01001840 if (xterm_display_allocated)
1841 vim_free(xterm_display);
1842 xterm_display = (char *)vim_strsave(eap->arg);
1843 xterm_display_allocated = TRUE;
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001844 }
1845 smsg(_("restoring display %s"), xterm_display == NULL
Bram Moolenaar0c5c3fa2019-11-30 22:38:16 +01001846 ? (char *)mch_getenv((char_u *)"DISPLAY") : xterm_display);
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001847
1848 clear_xterm_clip();
1849 x11_window = 0;
1850 xterm_dpy_retry_count = 5; // Try reconnecting five times
1851 may_restore_clipboard();
1852}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853#endif
1854
1855/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 * Test if "dpy" and x11_window are valid by getting the window title.
1857 * I don't actually want it yet, so there may be a simpler call to use, but
1858 * this will cause the error handler x_error_check() to be called if anything
1859 * is wrong, such as the window pointer being invalid (as can happen when the
1860 * user changes his DISPLAY, but not his WINDOWID) -- webb
1861 */
1862 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001863test_x11_window(Display *dpy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864{
Dominique Pellé4927bc72023-09-24 16:12:07 +02001865 int (*old_handler)(Display*, XErrorEvent*);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 XTextProperty text_prop;
1867
1868 old_handler = XSetErrorHandler(x_error_check);
1869 got_x_error = FALSE;
1870 if (XGetWMName(dpy, x11_window, &text_prop))
1871 XFree((void *)text_prop.value);
1872 XSync(dpy, False);
1873 (void)XSetErrorHandler(old_handler);
1874
1875 if (p_verbose > 0 && got_x_error)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001876 verb_msg(_("Testing the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877
1878 return (got_x_error ? FAIL : OK);
1879}
1880#endif
1881
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882
1883#ifdef FEAT_X11
1884
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01001885static int get_x11_thing(int get_title, int test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886
1887/*
1888 * try to get x11 window and display
1889 *
1890 * return FAIL for failure, OK otherwise
1891 */
1892 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001893get_x11_windis(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894{
1895 char *winid;
1896 static int result = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001897#define XD_NONE 0 // x11_display not set here
1898#define XD_HERE 1 // x11_display opened here
1899#define XD_GUI 2 // x11_display used from gui.dpy
1900#define XD_XTERM 3 // x11_display used from xterm_dpy
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 static int x11_display_from = XD_NONE;
1902 static int did_set_error_handler = FALSE;
1903
1904 if (!did_set_error_handler)
1905 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001906 // X just exits if it finds an error otherwise!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 (void)XSetErrorHandler(x_error_handler);
1908 did_set_error_handler = TRUE;
1909 }
1910
Bram Moolenaar9372a112005-12-06 19:59:18 +00001911#if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 if (gui.in_use)
1913 {
1914 /*
1915 * If the X11 display was opened here before, for the window where Vim
1916 * was started, close that one now to avoid a memory leak.
1917 */
1918 if (x11_display_from == XD_HERE && x11_display != NULL)
1919 {
1920 XCloseDisplay(x11_display);
1921 x11_display_from = XD_NONE;
1922 }
1923 if (gui_get_x11_windis(&x11_window, &x11_display) == OK)
1924 {
1925 x11_display_from = XD_GUI;
1926 return OK;
1927 }
1928 x11_display = NULL;
1929 return FAIL;
1930 }
1931 else if (x11_display_from == XD_GUI)
1932 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001933 // GUI must have stopped somehow, clear x11_display
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 x11_window = 0;
1935 x11_display = NULL;
1936 x11_display_from = XD_NONE;
1937 }
1938#endif
1939
Bram Moolenaar0f873732019-12-05 20:28:46 +01001940 // When started with the "-X" argument, don't try connecting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 if (!x_connect_to_server())
1942 return FAIL;
1943
1944 /*
1945 * If WINDOWID not set, should try another method to find out
1946 * what the current window number is. The only code I know for
1947 * this is very complicated.
1948 * We assume that zero is invalid for WINDOWID.
1949 */
1950 if (x11_window == 0 && (winid = getenv("WINDOWID")) != NULL)
1951 x11_window = (Window)atol(winid);
1952
1953#ifdef FEAT_XCLIPBOARD
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001954 if (xterm_dpy == x11_display)
1955 // x11_display may have been set to xterm_dpy elsewhere
1956 x11_display_from = XD_XTERM;
1957
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 if (xterm_dpy != NULL && x11_window != 0)
1959 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001960 // We may have checked it already, but Gnome terminal can move us to
1961 // another window, so we need to check every time.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00001962 if (x11_display_from != XD_XTERM)
1963 {
1964 /*
1965 * If the X11 display was opened here before, for the window where
1966 * Vim was started, close that one now to avoid a memory leak.
1967 */
1968 if (x11_display_from == XD_HERE && x11_display != NULL)
1969 XCloseDisplay(x11_display);
1970 x11_display = xterm_dpy;
1971 x11_display_from = XD_XTERM;
1972 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 if (test_x11_window(x11_display) == FAIL)
1974 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001975 // probably bad $WINDOWID
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 x11_window = 0;
1977 x11_display = NULL;
1978 x11_display_from = XD_NONE;
1979 return FAIL;
1980 }
1981 return OK;
1982 }
1983#endif
1984
1985 if (x11_window == 0 || x11_display == NULL)
1986 result = -1;
1987
Bram Moolenaar0f873732019-12-05 20:28:46 +01001988 if (result != -1) // Have already been here and set this
1989 return result; // Don't do all these X calls again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
1991 if (x11_window != 0 && x11_display == NULL)
1992 {
1993#ifdef SET_SIG_ALARM
ichizok378447f2023-05-11 22:25:42 +01001994 sighandler_T sig_save;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995#endif
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001996#ifdef ELAPSED_FUNC
1997 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998
1999 if (p_verbose > 0)
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01002000 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001#endif
2002
2003#ifdef SET_SIG_ALARM
2004 /*
2005 * Opening the Display may hang if the DISPLAY setting is wrong, or
2006 * the network connection is bad. Set an alarm timer to get out.
2007 */
2008 sig_alarm_called = FALSE;
ichizok378447f2023-05-11 22:25:42 +01002009 sig_save = mch_signal(SIGALRM, sig_alarm);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 alarm(2);
2011#endif
2012 x11_display = XOpenDisplay(NULL);
2013
2014#ifdef SET_SIG_ALARM
2015 alarm(0);
ichizok378447f2023-05-11 22:25:42 +01002016 mch_signal(SIGALRM, sig_save);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 if (p_verbose > 0 && sig_alarm_called)
Bram Moolenaar563bbea2019-01-22 21:45:40 +01002018 verb_msg(_("Opening the X display timed out"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019#endif
2020 if (x11_display != NULL)
2021 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01002022# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00002024 {
2025 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01002026 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00002027 verbose_leave();
2028 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029# endif
2030 if (test_x11_window(x11_display) == FAIL)
2031 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002032 // Maybe window id is bad
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 x11_window = 0;
2034 XCloseDisplay(x11_display);
2035 x11_display = NULL;
2036 }
2037 else
2038 x11_display_from = XD_HERE;
2039 }
2040 }
2041 if (x11_window == 0 || x11_display == NULL)
2042 return (result = FAIL);
Bram Moolenaar727c8762010-10-20 19:17:48 +02002043
2044# ifdef FEAT_EVAL
2045 set_vim_var_nr(VV_WINDOWID, (long)x11_window);
2046# endif
2047
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 return (result = OK);
2049}
2050
2051/*
2052 * Determine original x11 Window Title
2053 */
2054 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01002055get_x11_title(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056{
Bram Moolenaar47136d72004-10-12 20:02:24 +00002057 return get_x11_thing(TRUE, test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058}
2059
2060/*
2061 * Determine original x11 Window icon
2062 */
2063 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01002064get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065{
2066 int retval = FALSE;
2067
2068 retval = get_x11_thing(FALSE, test_only);
2069
Bram Moolenaar0f873732019-12-05 20:28:46 +01002070 // could not get old icon, use terminal name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 if (oldicon == NULL && !test_only)
2072 {
2073 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002074 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002076 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 }
2078
2079 return retval;
2080}
2081
2082 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01002083get_x11_thing(
Bram Moolenaar0f873732019-12-05 20:28:46 +01002084 int get_title, // get title string
Bram Moolenaar05540972016-01-30 20:31:25 +01002085 int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086{
2087 XTextProperty text_prop;
2088 int retval = FALSE;
2089 Status status;
2090
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002091 if (get_x11_windis() != OK)
2092 return FALSE;
2093
2094 // Get window/icon name if any
2095 if (get_title)
2096 status = XGetWMName(x11_display, x11_window, &text_prop);
2097 else
2098 status = XGetWMIconName(x11_display, x11_window, &text_prop);
2099
2100 /*
2101 * If terminal is xterm, then x11_window may be a child window of the
2102 * outer xterm window that actually contains the window/icon name, so
2103 * keep traversing up the tree until a window with a title/icon is
2104 * found.
2105 */
2106 // Previously this was only done for xterm and alike. I don't see a
2107 // reason why it would fail for other terminal emulators.
2108 // if (term_is_xterm)
2109 Window root;
2110 Window parent;
2111 Window win = x11_window;
2112 Window *children;
2113 unsigned int num_children;
2114
2115 while (!status || text_prop.value == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002117 if (!XQueryTree(x11_display, win, &root, &parent, &children,
2118 &num_children))
2119 break;
2120 if (children)
2121 XFree((void *)children);
2122 if (parent == root || parent == 0)
2123 break;
2124
2125 win = parent;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 if (get_title)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002127 status = XGetWMName(x11_display, win, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002129 status = XGetWMIconName(x11_display, win, &text_prop);
2130 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002132 if (status && text_prop.value != NULL)
2133 {
2134 retval = TRUE;
2135 if (!test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002137 if (get_title)
2138 vim_free(oldtitle);
2139 else
2140 vim_free(oldicon);
2141 if (text_prop.encoding == XA_STRING && !has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 if (get_title)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002144 oldtitle = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002146 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002148 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002150 char **cl;
2151 Status transform_status;
2152 int n = 0;
2153
2154 transform_status = XmbTextPropertyToTextList(x11_display,
2155 &text_prop,
2156 &cl, &n);
2157 if (transform_status >= Success && n > 0 && cl[0])
2158 {
2159 if (get_title)
2160 oldtitle = vim_strsave((char_u *) cl[0]);
2161 else
2162 oldicon = vim_strsave((char_u *) cl[0]);
2163 XFreeStringList(cl);
2164 }
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002165 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 if (get_title)
2168 oldtitle = vim_strsave((char_u *)text_prop.value);
2169 else
2170 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002174 XFree((void *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 }
2176 return retval;
2177}
2178
Bram Moolenaar0f873732019-12-05 20:28:46 +01002179// Xutf8 functions are not available on older systems. Note that on some
2180// systems X_HAVE_UTF8_STRING may be defined in a header file but
2181// Xutf8SetWMProperties() is not in the X11 library. Configure checks for
2182// that and defines HAVE_XUTF8SETWMPROPERTIES.
Bram Moolenaara12a1612019-01-24 16:39:02 +01002183#if defined(X_HAVE_UTF8_STRING)
Bram Moolenaarcbc246a2014-10-11 14:47:26 +02002184# if X_HAVE_UTF8_STRING && HAVE_XUTF8SETWMPROPERTIES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185# define USE_UTF8_STRING
2186# endif
2187#endif
2188
2189/*
2190 * Set x11 Window Title
2191 *
2192 * get_x11_windis() must be called before this and have returned OK
2193 */
2194 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002195set_x11_title(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002197 // XmbSetWMProperties() and Xutf8SetWMProperties() should use a STRING
2198 // when possible, COMPOUND_TEXT otherwise. COMPOUND_TEXT isn't
2199 // supported everywhere and STRING doesn't work for multi-byte titles.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200#ifdef USE_UTF8_STRING
2201 if (enc_utf8)
2202 Xutf8SetWMProperties(x11_display, x11_window, (const char *)title,
2203 NULL, NULL, 0, NULL, NULL, NULL);
2204 else
2205#endif
2206 {
2207#if XtSpecificationRelease >= 4
2208# ifdef FEAT_XFONTSET
2209 XmbSetWMProperties(x11_display, x11_window, (const char *)title,
2210 NULL, NULL, 0, NULL, NULL, NULL);
2211# else
2212 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002213 char *c_title = (char *)title;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214
Bram Moolenaar0f873732019-12-05 20:28:46 +01002215 // directly from example 3-18 "basicwin" of Xlib Programming Manual
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002216 (void)XStringListToTextProperty(&c_title, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 XSetWMProperties(x11_display, x11_window, &text_prop,
2218 NULL, NULL, 0, NULL, NULL, NULL);
2219# endif
2220#else
2221 XStoreName(x11_display, x11_window, (char *)title);
2222#endif
2223 }
2224 XFlush(x11_display);
2225}
2226
2227/*
2228 * Set x11 Window icon
2229 *
2230 * get_x11_windis() must be called before this and have returned OK
2231 */
2232 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002233set_x11_icon(char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002235 // See above for comments about using X*SetWMProperties().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236#ifdef USE_UTF8_STRING
2237 if (enc_utf8)
2238 Xutf8SetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2239 NULL, 0, NULL, NULL, NULL);
2240 else
2241#endif
2242 {
2243#if XtSpecificationRelease >= 4
2244# ifdef FEAT_XFONTSET
2245 XmbSetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2246 NULL, 0, NULL, NULL, NULL);
2247# else
2248 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002249 char *c_icon = (char *)icon;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002251 (void)XStringListToTextProperty(&c_icon, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 XSetWMProperties(x11_display, x11_window, NULL, &text_prop,
2253 NULL, 0, NULL, NULL, NULL);
2254# endif
2255#else
2256 XSetIconName(x11_display, x11_window, (char *)icon);
2257#endif
2258 }
2259 XFlush(x11_display);
2260}
2261
Bram Moolenaar0f873732019-12-05 20:28:46 +01002262#else // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002265get_x11_title(int test_only UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266{
2267 return FALSE;
2268}
2269
2270 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002271get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272{
2273 if (!test_only)
2274 {
2275 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002276 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002278 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 }
2280 return FALSE;
2281}
2282
Bram Moolenaar0f873732019-12-05 20:28:46 +01002283#endif // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284
2285 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002286mch_can_restore_title(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287{
2288 return get_x11_title(TRUE);
2289}
2290
2291 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002292mch_can_restore_icon(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293{
2294 return get_x11_icon(TRUE);
2295}
2296
2297/*
2298 * Set the window title and icon.
2299 */
2300 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002301mch_settitle(char_u *title, char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302{
2303 int type = 0;
2304 static int recursive = 0;
2305
Bram Moolenaar0f873732019-12-05 20:28:46 +01002306 if (T_NAME == NULL) // no terminal name (yet)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 return;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002308 if (title == NULL && icon == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 return;
2310
Bram Moolenaar0f873732019-12-05 20:28:46 +01002311 // When one of the X11 functions causes a deadly signal, we get here again
2312 // recursively. Avoid hanging then (something is probably locked).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 if (recursive)
2314 return;
2315 ++recursive;
2316
2317 /*
2318 * if the window ID and the display is known, we may use X11 calls
2319 */
2320#ifdef FEAT_X11
2321 if (get_x11_windis() == OK)
2322 type = 1;
lilydjwg6e0a18f2024-01-29 20:54:28 +01002323#endif
2324#if defined(FEAT_GUI_PHOTON) \
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002325 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 if (gui.in_use)
2327 type = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328#endif
2329
2330 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002331 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 * than x11 calls, because the x11 calls don't always work
2333 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 if ((type || *T_TS != NUL) && title != NULL)
2335 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002336 if (oldtitle_outdated)
2337 {
2338 oldtitle_outdated = FALSE;
2339 VIM_CLEAR(oldtitle);
2340 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 if (oldtitle == NULL
2342#ifdef FEAT_GUI
2343 && !gui.in_use
2344#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002345 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 (void)get_x11_title(FALSE);
2347
Bram Moolenaar0f873732019-12-05 20:28:46 +01002348 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 term_settitle(title);
2350#ifdef FEAT_X11
2351 else
2352# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002353 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002355 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002357#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar097148e2020-08-11 21:58:20 +02002358 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 else
2360 gui_mch_settitle(title, icon);
2361#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002362 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 }
2364
2365 if ((type || *T_CIS != NUL) && icon != NULL)
2366 {
2367 if (oldicon == NULL
2368#ifdef FEAT_GUI
2369 && !gui.in_use
2370#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002371 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 get_x11_icon(FALSE);
2373
2374 if (*T_CIS != NUL)
2375 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002376 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002378 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 out_flush();
2380 }
2381#ifdef FEAT_X11
2382 else
2383# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002384 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002386 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387#endif
2388 did_set_icon = TRUE;
2389 }
2390 --recursive;
2391}
2392
2393/*
2394 * Restore the window/icon title.
2395 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002396 * SAVE_RESTORE_TITLE only restore title
2397 * SAVE_RESTORE_ICON only restore icon
2398 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 */
2400 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002401mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402{
Bram Moolenaardac13472019-09-16 21:06:21 +02002403 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002404
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002405 // Only restore the title or icon when it has been set.
2406 // When using "oldtitle" make a copy, it might be freed halfway.
2407 char_u *title = ((which & SAVE_RESTORE_TITLE) && unix_did_set_title)
2408 ? (oldtitle ? oldtitle : p_titleold) : NULL;
2409 char_u *tofree = NULL;
2410 if (title == oldtitle && oldtitle != NULL)
2411 {
2412 tofree = vim_strsave(title);
2413 if (tofree != NULL)
2414 title = tofree;
2415 }
2416 mch_settitle(title,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002417 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002418 vim_free(tofree);
Bram Moolenaar40385db2018-08-07 22:31:44 +02002419
Bram Moolenaare5c83282019-05-03 23:15:37 +02002420 if (do_push_pop)
2421 {
2422 // pop and push from/to the stack
2423 term_pop_title(which);
2424 term_push_title(which);
2425 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426}
2427
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428
2429/*
2430 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002431 * This matches "xterm.*", thus "xterm-256color", "xterm-kitty", etc.
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002432 * Do not consider "xterm-kitty" an xterm, it is not fully xterm compatible,
2433 * using the "xterm-kitty" terminfo entry should work better.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002434 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 */
2436 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002437vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438{
2439 if (name == NULL)
2440 return FALSE;
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002441 return ((STRNICMP(name, "xterm", 5) == 0
2442 && STRNICMP(name, "xterm-kitty", 11) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 || STRNICMP(name, "nxterm", 6) == 0
2444 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002445 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002447 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 || STRCMP(name, "builtin_xterm") == 0);
2449}
2450
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002451#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2452/*
2453 * Return TRUE if "name" appears to be that of a terminal
2454 * known to support the xterm-style mouse protocol.
2455 * Relies on term_is_xterm having been set to its correct value.
2456 */
2457 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002458use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002459{
2460 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002461 && (term_is_xterm
2462 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002463 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar48873ae2021-12-08 21:00:24 +00002464 || STRNICMP(name, "gnome", 5) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002465 || STRICMP(name, "st") == 0
2466 || STRNICMP(name, "st-", 3) == 0
2467 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002468}
2469#endif
2470
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471/*
2472 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2473 * Return 1 for "xterm".
2474 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002475 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002476 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 */
2478 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002479use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002481 if (ttym_flags == TTYM_SGR)
2482 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002483 if (ttym_flags == TTYM_URXVT)
2484 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 if (ttym_flags == TTYM_XTERM2)
2486 return 2;
2487 if (ttym_flags == TTYM_XTERM)
2488 return 1;
2489 return 0;
2490}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002492/*
2493 * Return TRUE if "name" is an iris-ansi terminal name.
2494 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002496vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497{
2498 if (name == NULL)
2499 return FALSE;
2500 return (STRNICMP(name, "iris-ansi", 9) == 0
2501 || STRCMP(name, "builtin_iris-ansi") == 0);
2502}
2503
Dominique Pellee764d1b2023-03-12 21:20:59 +00002504#if defined(VMS) || defined(PROTO)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002505/*
2506 * Return TRUE if "name" is a vt300-like terminal name.
2507 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002509vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510{
2511 if (name == NULL)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002512 return FALSE;
2513 // Actually all ANSI compatible terminals should be here.
2514 // Catch at least VT1xx - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002515 return ((STRNICMP(name, "vt", 2) == 0
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002516 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 || STRCMP(name, "builtin_vt320") == 0);
2518}
Dominique Pellee764d1b2023-03-12 21:20:59 +00002519#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520
2521/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 * Insert user name in s[len].
2523 * Return OK if a name found.
2524 */
2525 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002526mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527{
2528#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002529 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 return OK;
2531#else
2532 return mch_get_uname(getuid(), s, len);
2533#endif
2534}
2535
2536/*
2537 * Insert user name for "uid" in s[len].
2538 * Return OK if a name found.
2539 */
2540 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002541mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542{
2543#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2544 struct passwd *pw;
2545
2546 if ((pw = getpwuid(uid)) != NULL
2547 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2548 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002549 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 return OK;
2551 }
2552#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002553 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2554 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555}
2556
2557/*
2558 * Insert host name is s[len].
2559 */
2560
2561#ifdef HAVE_SYS_UTSNAME_H
2562 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002563mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564{
2565 struct utsname vutsname;
2566
2567 if (uname(&vutsname) < 0)
2568 *s = NUL;
2569 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002570 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002572#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573
2574# ifdef HAVE_SYS_SYSTEMINFO_H
2575# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2576# endif
2577
2578 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002579mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580{
2581# ifdef VAXC
2582 vaxc$gethostname((char *)s, len);
2583# else
2584 gethostname((char *)s, len);
2585# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002586 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002588#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589
2590/*
2591 * return process ID
2592 */
2593 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002594mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595{
2596 return (long)getpid();
2597}
2598
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002599/*
2600 * return TRUE if process "pid" is still running
2601 */
2602 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002603mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002604{
Bram Moolenaar44dea9d2021-06-23 21:13:20 +02002605 // If there is no error the process must be running.
2606 if (kill(pid, 0) == 0)
2607 return TRUE;
2608#ifdef ESRCH
2609 // If the error is ESRCH then the process is not running.
2610 if (errno == ESRCH)
2611 return FALSE;
2612#endif
2613 // If the process is running and owned by another user we get EPERM. With
2614 // other errors the process might be running, assuming it is then.
2615 return TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002616}
2617
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002620strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621{
2622 extern int sys_nerr;
2623 extern char *sys_errlist[];
2624 static char er[20];
2625
2626 if (err > 0 && err < sys_nerr)
2627 return (sys_errlist[err]);
2628 sprintf(er, "Error %d", err);
2629 return er;
2630}
2631#endif
2632
2633/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002634 * Get name of current directory into buffer "buf" of length "len" bytes.
2635 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 * Return OK for success, FAIL for failure.
2637 */
2638 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002639mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640{
2641#if defined(USE_GETCWD)
2642 if (getcwd((char *)buf, len) == NULL)
2643 {
2644 STRCPY(buf, strerror(errno));
2645 return FAIL;
2646 }
2647 return OK;
2648#else
2649 return (getwd((char *)buf) != NULL ? OK : FAIL);
2650#endif
2651}
2652
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002654 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 *
2656 * return FAIL for failure, OK for success
2657 */
2658 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002659mch_FullName(
2660 char_u *fname,
2661 char_u *buf,
2662 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002663 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664{
2665 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002666#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002668 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002669#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 char_u olddir[MAXPATHL];
2671 char_u *p;
2672 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002673#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002674 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2675 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002676#endif
2677
Bram Moolenaar38323e42007-03-06 19:22:53 +00002678#ifdef VMS
2679 fname = vms_fixfilename(fname);
2680#endif
2681
Bram Moolenaara2442432007-04-26 14:26:37 +00002682#ifdef __CYGWIN__
2683 /*
2684 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2685 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002686# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002687 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2688 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002689 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2690 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002691# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002692 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002693# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002694 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002695#endif
2696
Bram Moolenaar0f873732019-12-05 20:28:46 +01002697 // Expand it if forced or not an absolute path.
2698 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002699 if ((force || !mch_isFullName(fname))
2700 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 {
2702 /*
2703 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002704 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 * This will get the correct path name with "../" things.
2706 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002707 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 {
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002709 if (STRCMP(p, "/..") == 0)
2710 // for "/path/dir/.." include the "/.."
2711 p += 3;
2712
Bram Moolenaar38323e42007-03-06 19:22:53 +00002713#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 /*
2715 * Use fchdir() if possible, it's said to be faster and more
2716 * reliable. But on SunOS 4 it might not work. Check this by
2717 * doing a fchdir() right now.
2718 */
2719 if (!dont_fchdir)
2720 {
2721 fd = open(".", O_RDONLY | O_EXTRA, 0);
2722 if (fd >= 0 && fchdir(fd) < 0)
2723 {
2724 close(fd);
2725 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002726 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 }
2728 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002729#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730
Bram Moolenaar0f873732019-12-05 20:28:46 +01002731 // Only change directory when we are sure we can return to where
2732 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002734#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002736#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 (mch_dirname(olddir, MAXPATHL) == FAIL
2738 || mch_chdir((char *)olddir) != 0))
2739 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002740 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 retval = FAIL;
2742 }
2743 else
2744 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002745 // The directory is copied into buf[], to be able to remove
2746 // the file name without changing it (could be a string in
2747 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 if (p - fname >= len)
2749 retval = FAIL;
2750 else
2751 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002752 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 if (mch_chdir((char *)buf))
Bram Moolenaarc6376c72021-10-03 19:29:48 +01002754 {
2755 // Path does not exist (yet). For a full path fail,
2756 // will use the path as-is. For a relative path use
2757 // the current directory and append the file name.
2758 if (mch_isFullName(fname))
2759 retval = FAIL;
2760 else
2761 p = NULL;
2762 }
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002763 else if (*p == '/')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 fname = p + 1;
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002765 else
2766 fname = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 *buf = NUL;
2768 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 }
2770 }
2771 if (mch_dirname(buf, len) == FAIL)
2772 {
2773 retval = FAIL;
2774 *buf = NUL;
2775 }
2776 if (p != NULL)
2777 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002778#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 if (fd >= 0)
2780 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002781 if (p_verbose >= 5)
2782 {
2783 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002784 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002785 verbose_leave();
2786 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 l = fchdir(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 }
2789 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002790#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 l = mch_chdir((char *)olddir);
2792 if (l != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002793 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 }
itchyny051a40c2021-10-20 10:00:05 +01002795#ifdef HAVE_FCHDIR
2796 if (fd >= 0)
2797 close(fd);
2798#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799
2800 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002801 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002802 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002803#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002804 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002806 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002807#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002809
Bram Moolenaar0f873732019-12-05 20:28:46 +01002810 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002811 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 return FAIL;
2813
Bram Moolenaar0f873732019-12-05 20:28:46 +01002814 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 if (STRCMP(fname, ".") != 0)
2816 STRCAT(buf, fname);
2817
2818 return OK;
2819}
2820
2821/*
2822 * Return TRUE if "fname" does not depend on the current directory.
2823 */
2824 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002825mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002827#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 return ( fname[0] == '/' || fname[0] == '.' ||
2829 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2830 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2831 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002832#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834#endif
2835}
2836
Bram Moolenaar24552be2005-12-10 20:17:30 +00002837#if defined(USE_FNAME_CASE) || defined(PROTO)
2838/*
2839 * Set the case of the file name, if it already exists. This will cause the
2840 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002841 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002842 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002843 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002844fname_case(
2845 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002846 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002847{
2848 struct stat st;
2849 char_u *slash, *tail;
2850 DIR *dirp;
2851 struct dirent *dp;
2852
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002853 if (mch_lstat((char *)name, &st) < 0)
2854 return;
2855
2856 // Open the directory where the file is located.
2857 slash = vim_strrchr(name, '/');
2858 if (slash == NULL)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002859 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002860 dirp = opendir(".");
2861 tail = name;
2862 }
2863 else
2864 {
2865 *slash = NUL;
2866 dirp = opendir((char *)name);
2867 *slash = '/';
2868 tail = slash + 1;
2869 }
Bram Moolenaar24552be2005-12-10 20:17:30 +00002870
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002871 if (dirp == NULL)
2872 return;
2873
2874 while ((dp = readdir(dirp)) != NULL)
2875 {
2876 // Only accept names that differ in case and are the same byte
2877 // length. TODO: accept different length name.
2878 if (STRICMP(tail, dp->d_name) == 0
2879 && STRLEN(tail) == STRLEN(dp->d_name))
Bram Moolenaar24552be2005-12-10 20:17:30 +00002880 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002881 char_u newname[MAXPATHL + 1];
2882 struct stat st2;
2883
2884 // Verify the inode is equal.
2885 vim_strncpy(newname, name, MAXPATHL);
2886 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2887 MAXPATHL - (tail - name));
2888 if (mch_lstat((char *)newname, &st2) >= 0
2889 && st.st_ino == st2.st_ino
2890 && st.st_dev == st2.st_dev)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002891 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002892 STRCPY(tail, dp->d_name);
2893 break;
Bram Moolenaar24552be2005-12-10 20:17:30 +00002894 }
Bram Moolenaar24552be2005-12-10 20:17:30 +00002895 }
2896 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002897
2898 closedir(dirp);
Bram Moolenaar24552be2005-12-10 20:17:30 +00002899}
2900#endif
2901
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902/*
2903 * Get file permissions for 'name'.
2904 * Returns -1 when it doesn't exist.
2905 */
2906 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002907mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908{
2909 struct stat statb;
2910
Bram Moolenaar0f873732019-12-05 20:28:46 +01002911 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912#ifdef VMS
2913 if (stat((char *)vms_fixfilename(name), &statb))
2914#else
2915 if (stat((char *)name, &statb))
2916#endif
2917 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002918#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002919 // The top bit makes the value negative, which means the file doesn't
2920 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002921 return statb.st_mode & ~S_ADDACE;
2922#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002924#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925}
2926
2927/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002928 * Set file permission for "name" to "perm".
2929 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 */
2931 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002932mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933{
2934 return (chmod((char *)
2935#ifdef VMS
2936 vms_fixfilename(name),
2937#else
2938 name,
2939#endif
2940 (mode_t)perm) == 0 ? OK : FAIL);
2941}
2942
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002943#if defined(HAVE_FCHMOD) || defined(PROTO)
2944/*
2945 * Set file permission for open file "fd" to "perm".
2946 * Return FAIL for failure, OK otherwise.
2947 */
2948 int
2949mch_fsetperm(int fd, long perm)
2950{
2951 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2952}
2953#endif
2954
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955#if defined(HAVE_ACL) || defined(PROTO)
2956# ifdef HAVE_SYS_ACL_H
2957# include <sys/acl.h>
2958# endif
2959# ifdef HAVE_SYS_ACCESS_H
2960# include <sys/access.h>
2961# endif
2962
2963# ifdef HAVE_SOLARIS_ACL
2964typedef struct vim_acl_solaris_T {
2965 int acl_cnt;
2966 aclent_t *acl_entry;
2967} vim_acl_solaris_T;
2968# endif
2969
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002970#if defined(HAVE_SELINUX) || defined(PROTO)
2971/*
2972 * Copy security info from "from_file" to "to_file".
2973 */
2974 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002975mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002976{
2977 if (from_file == NULL)
2978 return;
2979
2980 if (selinux_enabled == -1)
2981 selinux_enabled = is_selinux_enabled();
2982
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002983 if (selinux_enabled <= 0)
2984 return;
2985
2986 // Use "char *" instead of "security_context_t" to avoid a deprecation
2987 // warning.
2988 char *from_context = NULL;
2989 char *to_context = NULL;
2990
2991 if (getfilecon((char *)from_file, &from_context) < 0)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002992 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002993 // If the filesystem doesn't support extended attributes,
2994 // the original had no special security context and the
2995 // target cannot have one either.
2996 if (errno == EOPNOTSUPP)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002997 return;
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002998
2999 msg_puts(_("\nCould not get security context for "));
3000 msg_outtrans(from_file);
3001 msg_putchar('\n');
3002 return;
3003 }
3004 if (getfilecon((char *)to_file, &to_context) < 0)
3005 {
3006 msg_puts(_("\nCould not get security context for "));
3007 msg_outtrans(to_file);
3008 msg_putchar('\n');
3009 freecon (from_context);
3010 return ;
3011 }
3012 if (strcmp(from_context, to_context) != 0)
3013 {
3014 if (setfilecon((char *)to_file, from_context) < 0)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003015 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003016 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003017 msg_outtrans(to_file);
3018 msg_putchar('\n');
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003019 }
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003020 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003021 freecon(to_context);
3022 freecon(from_context);
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003023}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003024#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003025
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003026#if defined(HAVE_SMACK) && !defined(PROTO)
3027/*
3028 * Copy security info from "from_file" to "to_file".
3029 */
3030 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01003031mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003032{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02003033 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003034 {
3035 XATTR_NAME_SMACK,
3036 XATTR_NAME_SMACKEXEC,
3037 XATTR_NAME_SMACKMMAP
3038 };
3039
3040 char buffer[SMACK_LABEL_LEN];
3041 const char *name;
3042 int index;
3043 int ret;
3044 ssize_t size;
3045
3046 if (from_file == NULL)
3047 return;
3048
Christian Brabandt5a679b22023-10-16 10:17:13 +02003049 size = listxattr((char *)from_file, NULL, 0);
3050 // not supported or no attributes to copy
Paul R. Tagliamonte14759de2024-03-10 08:35:10 +01003051 if (size <= 0)
Christian Brabandt5a679b22023-10-16 10:17:13 +02003052 return;
3053
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003054 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
3055 / sizeof(smack_copied_attributes)[0]) ; index++)
3056 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003057 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003058 name = smack_copied_attributes[index];
3059
Bram Moolenaar0f873732019-12-05 20:28:46 +01003060 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003061 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
3062 if (size >= 0)
3063 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003064 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003065 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
3066 if (ret < 0)
3067 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003068 vim_snprintf((char *)IObuff, IOSIZE,
3069 _("Could not set security context %s for %s"),
3070 name, to_file);
3071 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003072 msg_putchar('\n');
3073 }
3074 }
3075 else
3076 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003077 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003078 switch (errno)
3079 {
3080 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003081 // extended attributes aren't supported or enabled
3082 // should a message be echoed? not sure...
3083 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003084
3085 case ERANGE:
3086 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003087 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003088 vim_snprintf((char *)IObuff, IOSIZE,
3089 _("Could not get security context %s for %s. Removing it!"),
3090 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003091 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003092 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01003093 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003094
3095 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003096 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003097 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003098 // Silently ignore errors, apparently this happens when
3099 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003100 break;
3101 }
3102 }
3103 }
3104}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003105#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003106
Christian Brabandte085dfd2023-09-30 12:49:18 +02003107#ifdef FEAT_XATTR
3108/*
3109 * Copy extended attributes from_file to to_file
3110 */
3111 void
3112mch_copy_xattr(char_u *from_file, char_u *to_file)
3113{
3114 char *xattr_buf;
Paul R. Tagliamonte14759de2024-03-10 08:35:10 +01003115 ssize_t size;
3116 ssize_t tsize;
Christian Brabandte085dfd2023-09-30 12:49:18 +02003117 ssize_t keylen, vallen, max_vallen = 0;
3118 char *key;
3119 char *val = NULL;
3120 char *errmsg = NULL;
3121
3122 if (from_file == NULL)
3123 return;
3124
3125 // get the length of the extended attributes
3126 size = listxattr((char *)from_file, NULL, 0);
3127 // not supported or no attributes to copy
Paul R. Tagliamonte14759de2024-03-10 08:35:10 +01003128 if (size <= 0)
Christian Brabandte085dfd2023-09-30 12:49:18 +02003129 return;
3130 xattr_buf = (char*)alloc(size);
3131 if (xattr_buf == NULL)
3132 return;
3133 size = listxattr((char *)from_file, xattr_buf, size);
3134 tsize = size;
3135
3136 errno = 0;
3137
3138 for (int round = 0; round < 2; round++)
3139 {
3140
3141 key = xattr_buf;
3142 if (round == 1)
3143 size = tsize;
3144
3145 while (size > 0)
3146 {
3147 vallen = getxattr((char *)from_file, key,
3148 val, round ? max_vallen : 0);
3149 // only set the attribute in the second round
3150 if (vallen >= 0 && round &&
3151 setxattr((char *)to_file, key, val, vallen, 0) == 0)
3152 ;
3153 else if (errno)
3154 {
3155 switch (errno)
3156 {
3157 case E2BIG:
3158 errmsg = e_xattr_e2big;
3159 goto error_exit;
3160 case ENOTSUP:
Gene C993b1752023-10-02 22:42:26 +02003161 case EACCES:
3162 case EPERM:
3163 break;
Christian Brabandte085dfd2023-09-30 12:49:18 +02003164 case ERANGE:
3165 errmsg = e_xattr_erange;
3166 goto error_exit;
3167 default:
3168 errmsg = e_xattr_other;
3169 goto error_exit;
3170 }
3171 }
3172
3173 if (round == 0 && vallen > max_vallen)
3174 max_vallen = vallen;
3175
3176 // add one for terminating null
3177 keylen = STRLEN(key) + 1;
3178 size -= keylen;
3179 key += keylen;
3180 }
3181 if (round)
3182 break;
3183
3184 val = (char*)alloc(max_vallen + 1);
3185 if (val == NULL)
3186 goto error_exit;
3187
3188 }
3189error_exit:
3190 vim_free(xattr_buf);
3191 vim_free(val);
3192
3193 if (errmsg != NULL)
zeertzjq7ece0362023-10-01 09:07:14 +02003194 emsg(_(errmsg));
Christian Brabandte085dfd2023-09-30 12:49:18 +02003195}
3196#endif
3197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198/*
3199 * Return a pointer to the ACL of file "fname" in allocated memory.
3200 * Return NULL if the ACL is not available for whatever reason.
3201 */
3202 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01003203mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204{
3205 vim_acl_T ret = NULL;
3206#ifdef HAVE_POSIX_ACL
3207 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
3208#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003209#ifdef HAVE_SOLARIS_ZFS_ACL
3210 acl_t *aclent;
3211
3212 if (acl_get((char *)fname, 0, &aclent) < 0)
3213 return NULL;
3214 ret = (vim_acl_T)aclent;
3215#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216#ifdef HAVE_SOLARIS_ACL
3217 vim_acl_solaris_T *aclent;
3218
3219 aclent = malloc(sizeof(vim_acl_solaris_T));
3220 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
3221 {
3222 free(aclent);
3223 return NULL;
3224 }
3225 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
3226 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
3227 {
3228 free(aclent->acl_entry);
3229 free(aclent);
3230 return NULL;
3231 }
3232 ret = (vim_acl_T)aclent;
3233#else
3234#if defined(HAVE_AIX_ACL)
3235 int aclsize;
3236 struct acl *aclent;
3237
3238 aclsize = sizeof(struct acl);
3239 aclent = malloc(aclsize);
3240 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3241 {
3242 if (errno == ENOSPC)
3243 {
3244 aclsize = aclent->acl_len;
3245 aclent = realloc(aclent, aclsize);
3246 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3247 {
3248 free(aclent);
3249 return NULL;
3250 }
3251 }
3252 else
3253 {
3254 free(aclent);
3255 return NULL;
3256 }
3257 }
3258 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003259#endif // HAVE_AIX_ACL
3260#endif // HAVE_SOLARIS_ACL
3261#endif // HAVE_SOLARIS_ZFS_ACL
3262#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 return ret;
3264}
3265
3266/*
3267 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3268 */
3269 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003270mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271{
3272 if (aclent == NULL)
3273 return;
3274#ifdef HAVE_POSIX_ACL
3275 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3276#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003277#ifdef HAVE_SOLARIS_ZFS_ACL
3278 acl_set((char *)fname, (acl_t *)aclent);
3279#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280#ifdef HAVE_SOLARIS_ACL
3281 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3282 ((vim_acl_solaris_T *)aclent)->acl_entry);
3283#else
3284#ifdef HAVE_AIX_ACL
3285 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003286#endif // HAVE_AIX_ACL
3287#endif // HAVE_SOLARIS_ACL
3288#endif // HAVE_SOLARIS_ZFS_ACL
3289#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290}
3291
3292 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003293mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294{
3295 if (aclent == NULL)
3296 return;
3297#ifdef HAVE_POSIX_ACL
3298 acl_free((acl_t)aclent);
3299#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003300#ifdef HAVE_SOLARIS_ZFS_ACL
3301 acl_free((acl_t *)aclent);
3302#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303#ifdef HAVE_SOLARIS_ACL
3304 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3305 free(aclent);
3306#else
3307#ifdef HAVE_AIX_ACL
3308 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003309#endif // HAVE_AIX_ACL
3310#endif // HAVE_SOLARIS_ACL
3311#endif // HAVE_SOLARIS_ZFS_ACL
3312#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313}
3314#endif
3315
3316/*
3317 * Set hidden flag for "name".
3318 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003320mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003322 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323}
3324
3325/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003326 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 * return FALSE if "name" is not a directory
3328 * return FALSE for error
3329 */
3330 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003331mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332{
3333 struct stat statb;
3334
Bram Moolenaar0f873732019-12-05 20:28:46 +01003335 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 return FALSE;
3337 if (stat((char *)name, &statb))
3338 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340}
3341
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003342/*
3343 * return TRUE if "name" is a directory, NOT a symlink to a directory
3344 * return FALSE if "name" is not a directory
3345 * return FALSE for error
3346 */
3347 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003348mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003349{
3350 struct stat statb;
3351
Bram Moolenaar0f873732019-12-05 20:28:46 +01003352 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003353 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003354 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003355 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003356 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003357}
3358
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359/*
3360 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3361 */
3362 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003363executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364{
3365 struct stat st;
3366
3367 if (stat((char *)name, &st))
3368 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003369#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003370 // Like on Unix system file can have executable rights but not necessarily
3371 // be an executable, but on Unix is not a default for an ordinary file to
3372 // have an executable flag - on VMS it is in most cases.
3373 // Therefore, this check does not have any sense - let keep us to the
3374 // conventions instead:
3375 // *.COM and *.EXE files are the executables - the rest are not. This is
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00003376 // not ideal but better than it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003377 int vms_executable = 0;
3378 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3379 {
3380 if (strstr(vms_tolower((char*)name),".exe") != NULL
3381 || strstr(vms_tolower((char*)name),".com")!= NULL)
3382 vms_executable = 1;
3383 }
3384 return vms_executable;
3385#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003387#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388}
3389
3390/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003391 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003392 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 * Return -1 if unknown.
3394 */
3395 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003396mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397{
3398 char_u *buf;
3399 char_u *p, *e;
3400 int retval;
3401
Bram Moolenaar0f873732019-12-05 20:28:46 +01003402 // When "use_path" is false and if it's an absolute or relative path don't
3403 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003404 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003405 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003406 // There must be a path separator, files in the current directory
3407 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003408 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003409 {
3410 if (path != NULL)
3411 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003412 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003413 *path = FullName_save(name, TRUE);
3414 else
3415 *path = vim_strsave(name);
3416 }
3417 return TRUE;
3418 }
3419 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003420 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421
3422 p = (char_u *)getenv("PATH");
3423 if (p == NULL || *p == NUL)
3424 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003425 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 if (buf == NULL)
3427 return -1;
3428
3429 /*
3430 * Walk through all entries in $PATH to check if "name" exists there and
3431 * is an executable file.
3432 */
3433 for (;;)
3434 {
3435 e = (char_u *)strchr((char *)p, ':');
3436 if (e == NULL)
3437 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003438 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 STRCPY(buf, "./");
3440 else
3441 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003442 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 add_pathsep(buf);
3444 }
3445 STRCAT(buf, name);
3446 retval = executable_file(buf);
3447 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003448 {
3449 if (path != NULL)
3450 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003451 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003452 *path = FullName_save(buf, TRUE);
3453 else
3454 *path = vim_strsave(buf);
3455 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003457 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458
3459 if (*e != ':')
3460 break;
3461 p = e + 1;
3462 }
3463
3464 vim_free(buf);
3465 return retval;
3466}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467
3468/*
3469 * Check what "name" is:
3470 * NODE_NORMAL: file or directory (or doesn't exist)
3471 * NODE_WRITABLE: writable device, socket, fifo, etc.
3472 * NODE_OTHER: non-writable things
3473 */
3474 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003475mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476{
3477 struct stat st;
3478
3479 if (stat((char *)name, &st))
3480 return NODE_NORMAL;
3481 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3482 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003483 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003485 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 return NODE_WRITABLE;
3487}
3488
3489 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003490mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491{
3492#ifdef HAVE_CHECK_STACK_GROWTH
3493 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 check_stack_growth((char *)&i);
3496
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003497# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 get_stack_limit();
3499# endif
3500
3501#endif
3502
3503 /*
3504 * Setup an alternative stack for signals. Helps to catch signals when
3505 * running out of stack space.
3506 * Use of sigaltstack() is preferred, it's more portable.
3507 * Ignore any errors.
3508 */
3509#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +02003510 signal_stack = alloc(get_signal_stack_size());
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 init_signal_stack();
3512#endif
3513}
3514
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003515#if defined(EXITFREE) || defined(PROTO)
3516 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003517mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003518{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003519# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3520 if (clip_star.owned)
3521 clip_lose_selection(&clip_star);
3522 if (clip_plus.owned)
3523 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003524# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003525# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003526 if (xterm_Shell != (Widget)0)
3527 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003528# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003529 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003530 if (xterm_dpy != NULL)
3531 XtCloseDisplay(xterm_dpy);
3532 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003533 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003534 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003535# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003536 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003537# endif
3538 }
3539# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003540# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003541# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003542 if (x11_display != NULL
3543# ifdef FEAT_XCLIPBOARD
3544 && x11_display != xterm_dpy
3545# endif
3546 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003547 XCloseDisplay(x11_display);
3548# endif
3549# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003550 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003551# endif
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003552 vim_free(oldtitle);
3553 vim_free(oldicon);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003554}
3555#endif
3556
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557/*
3558 * Output a newline when exiting.
3559 * Make sure the newline goes to the same stream as the text.
3560 */
3561 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003562exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003564 if (silent_mode)
3565 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 if (newline_on_exit || msg_didout)
3567 {
3568 if (msg_use_printf())
3569 {
3570 if (info_message)
3571 mch_msg("\n");
3572 else
3573 mch_errmsg("\r\n");
3574 }
3575 else
3576 out_char('\n');
3577 }
Bram Moolenaar7007e312021-03-27 12:11:33 +01003578 else if (!is_not_a_term())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003580 restore_cterm_colors(); // get original colors back
3581 msg_clr_eos_force(); // clear the rest of the display
3582 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 }
3584}
3585
Bram Moolenaarb4151682020-05-11 22:13:28 +02003586#ifdef USE_GCOV_FLUSH
ichizokdee78e12021-12-09 21:08:01 +00003587# if (defined(__GNUC__) \
3588 && ((__GNUC__ == 11 && __GNUC_MINOR__ >= 1) || (__GNUC__ >= 12))) \
3589 || (defined(__clang__) && (__clang_major__ >= 12))
3590extern void __gcov_dump(void);
3591extern void __gcov_reset(void);
3592# define __gcov_flush() do { __gcov_dump(); __gcov_reset(); } while (0)
3593# else
3594extern void __gcov_flush(void);
3595# endif
Bram Moolenaarb4151682020-05-11 22:13:28 +02003596#endif
3597
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003599mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600{
3601 exiting = TRUE;
3602
3603#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3604 x11_export_final_selection();
3605#endif
3606
3607#ifdef FEAT_GUI
3608 if (!gui.in_use)
3609#endif
3610 {
3611 settmode(TMODE_COOK);
Bram Moolenaar7007e312021-03-27 12:11:33 +01003612 if (!is_not_a_term())
3613 {
3614 // restore xterm title and icon name
3615 mch_restore_title(SAVE_RESTORE_BOTH);
3616 term_pop_title(SAVE_RESTORE_BOTH);
3617 }
Bram Moolenaar651fca82021-11-29 20:39:38 +00003618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 /*
3620 * When t_ti is not empty but it doesn't cause swapping terminal
3621 * pages, need to output a newline when msg_didout is set. But when
3622 * t_ti does swap pages it should not go to the shell page. Do this
3623 * before stoptermcap().
3624 */
3625 if (swapping_screen() && !newline_on_exit)
3626 exit_scroll();
3627
Bram Moolenaar0f873732019-12-05 20:28:46 +01003628 // Stop termcap: May need to check for T_CRV response, which
3629 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 stoptermcap();
3631
3632 /*
3633 * A newline is only required after a message in the alternate screen.
3634 * This is set to TRUE by wait_return().
3635 */
3636 if (!swapping_screen() || newline_on_exit)
3637 exit_scroll();
3638
Bram Moolenaar0f873732019-12-05 20:28:46 +01003639 // Cursor may have been switched off without calling starttermcap()
3640 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 if (full_screen)
3642 cursor_on();
3643 }
3644 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003645 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003646
3647#ifdef USE_GCOV_FLUSH
3648 // Flush coverage info before possibly being killed by a deadly signal.
3649 __gcov_flush();
3650#endif
3651
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 may_core_dump();
3653#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 gui_exit(r);
3656#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003657
Bram Moolenaar56718732006-03-15 22:53:57 +00003658#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003659 mac_conv_cleanup();
3660#endif
3661
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003663 // A core dump won't be created if the signal handler
3664 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 if (deadly_signal != 0)
3666 return;
3667#endif
3668
Bram Moolenaar009b2592004-10-24 19:18:58 +00003669#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003670 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003671#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003672
3673#ifdef EXITFREE
3674 free_all_mem();
3675#endif
3676
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 exit(r);
3678}
3679
3680 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003681may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682{
3683 if (deadly_signal != 0)
3684 {
ichizok378447f2023-05-11 22:25:42 +01003685 mch_signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003686 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 }
3688}
3689
3690#ifndef VMS
3691
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003692/*
3693 * Get the file descriptor to use for tty operations.
3694 */
3695 static int
3696get_tty_fd(int fd)
3697{
3698 int tty_fd = fd;
3699
3700#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3701 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3702 // "fd" when it is a master device.
3703 if (mch_isatty(fd) > 1)
3704 {
3705 char *name;
3706
3707 name = ptsname(fd);
3708 if (name == NULL)
3709 return -1;
3710
3711 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3712 if (tty_fd < 0)
3713 return -1;
3714 }
3715#endif
3716 return tty_fd;
3717}
3718
3719 static int
3720mch_tcgetattr(int fd, void *term)
3721{
3722 int tty_fd;
3723 int retval = -1;
3724
3725 tty_fd = get_tty_fd(fd);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003726 if (tty_fd < 0)
3727 return -1;
3728
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003729#ifdef NEW_TTY_SYSTEM
3730# ifdef HAVE_TERMIOS_H
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003731 retval = tcgetattr(tty_fd, (struct termios *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003732# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003733 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003734# endif
3735#else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003736 // for "old" tty systems
3737 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003738#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003739 if (tty_fd != fd)
3740 close(tty_fd);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003741 return retval;
3742}
3743
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003745mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746{
3747 static int first = TRUE;
3748
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003749#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750# ifdef HAVE_TERMIOS_H
3751 static struct termios told;
3752 struct termios tnew;
3753# else
3754 static struct termio told;
3755 struct termio tnew;
3756# endif
3757
3758 if (first)
3759 {
3760 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003761 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 }
3763
3764 tnew = told;
3765 if (tmode == TMODE_RAW)
3766 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003767 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003768 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3769 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003771# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003772 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773# endif
3774 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003775# ifdef ONLCR
3776 // Don't map NL -> CR NL, we do it ourselves.
3777 // Also disable expanding tabs if possible.
3778# ifdef XTABS
3779 tnew.c_oflag &= ~(ONLCR | XTABS);
3780# else
3781# ifdef TAB3
3782 tnew.c_oflag &= ~(ONLCR | TAB3);
3783# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003785# endif
3786# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003788 tnew.c_cc[VMIN] = 1; // return after 1 char
3789 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 }
3791 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003792 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003793 // Also reset ICANON here, otherwise on Solaris select() won't see
3794 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003795 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003796 tnew.c_cc[VMIN] = 1; // return after 1 char
3797 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003798 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799
3800# if defined(HAVE_TERMIOS_H)
3801 {
3802 int n = 10;
3803
Bram Moolenaar0f873732019-12-05 20:28:46 +01003804 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3805 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3807 && errno == EINTR && n > 0)
3808 --n;
3809 }
3810# else
3811 ioctl(read_cmd_fd, TCSETA, &tnew);
3812# endif
3813
3814#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 /*
3816 * for "old" tty systems
3817 */
3818# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003819# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820# endif
3821 static struct sgttyb ttybold;
3822 struct sgttyb ttybnew;
3823
3824 if (first)
3825 {
3826 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003827 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 }
3829
3830 ttybnew = ttybold;
3831 if (tmode == TMODE_RAW)
3832 {
3833 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3834 ttybnew.sg_flags |= RAW;
3835 }
3836 else if (tmode == TMODE_SLEEP)
3837 ttybnew.sg_flags &= ~(ECHO);
3838 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3839#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003840 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841}
3842
3843/*
3844 * Try to get the code for "t_kb" from the stty setting
3845 *
3846 * Even if termcap claims a backspace key, the user's setting *should*
3847 * prevail. stty knows more about reality than termcap does, and if
3848 * somebody's usual erase key is DEL (which, for most BSD users, it will
3849 * be), they're going to get really annoyed if their erase key starts
3850 * doing forward deletes for no reason. (Eric Fischer)
3851 */
3852 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003853get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003855 ttyinfo_T info;
3856 char_u buf[2];
3857 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003859 if (get_tty_info(read_cmd_fd, &info) != OK)
3860 return;
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003861
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003862 intr_char = info.interrupt;
3863 buf[0] = info.backspace;
3864 buf[1] = NUL;
3865 add_termcode((char_u *)"kb", buf, FALSE);
3866
3867 // If <BS> and <DEL> are now the same, redefine <DEL>.
3868 p = find_termcode((char_u *)"kD");
3869 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3870 do_fixdel(NULL);
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003871}
3872
3873/*
3874 * Obtain the characters that Backspace and Enter produce on "fd".
3875 * Returns OK or FAIL.
3876 */
3877 int
3878get_tty_info(int fd, ttyinfo_T *info)
3879{
3880#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881# ifdef HAVE_TERMIOS_H
3882 struct termios keys;
3883# else
3884 struct termio keys;
3885# endif
3886
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003887 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003889 info->backspace = keys.c_cc[VERASE];
3890 info->interrupt = keys.c_cc[VINTR];
3891 if (keys.c_iflag & ICRNL)
3892 info->enter = NL;
3893 else
3894 info->enter = CAR;
3895 if (keys.c_oflag & ONLCR)
3896 info->nl_does_cr = TRUE;
3897 else
3898 info->nl_does_cr = FALSE;
3899 return OK;
3900 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003902 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 struct sgttyb keys;
3904
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003905 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003907 info->backspace = keys.sg_erase;
3908 info->interrupt = keys.sg_kill;
3909 info->enter = CAR;
3910 info->nl_does_cr = TRUE;
3911 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003914 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915}
3916
Bram Moolenaar0f873732019-12-05 20:28:46 +01003917#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003919static int mouse_ison = FALSE;
3920
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921/*
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003922 * Set mouse clicks on or off and possible enable mouse movement events.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 */
3924 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003925mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003927#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003928 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003929#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 int xterm_mouse_vers;
3931
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003932#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003933 if (!on)
3934 // Make sure not tracing mouse movements. Important when a button-down
3935 // was received but no release yet.
3936 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003937#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003938
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003939 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003940#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003941 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003942#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003943 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003944 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 return;
3946
3947 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003948
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003949#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003950 if (ttym_flags == TTYM_URXVT)
3951 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003952 out_str_nf((char_u *)(on ? "\033[?1015h" : "\033[?1015l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003953 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003954 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003955#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003956
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00003957 if (T_CXM != NULL && *T_CXM != NUL)
3958 {
3959 term_enable_mouse(on);
3960 }
3961 else if (ttym_flags == TTYM_SGR)
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003962 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003963 // SGR mode supports columns above 223
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003964 out_str_nf((char_u *)(on ? "\033[?1006h" : "\033[?1006l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003965 mouse_ison = on;
3966 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003967
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003968#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003969 if (bevalterm_ison != (p_bevalterm && on))
3970 {
3971 bevalterm_ison = (p_bevalterm && on);
3972 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003973 // disable mouse movement events, enabling is below
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003974 out_str_nf((char_u *)("\033[?1003l"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003975 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003976#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003977
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 if (xterm_mouse_vers > 0)
3979 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003980 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 out_str_nf((char_u *)
3982 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003983 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003984#ifdef FEAT_BEVAL_TERM
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003985 bevalterm_ison ? "\033[?1003h" :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003986#endif
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003987 "\033[?1002h")
3988 : "\033[?1000h"));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003989 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 out_str_nf((char_u *)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003991 (xterm_mouse_vers > 1 ? "\033[?1002l" : "\033[?1000l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003992 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 }
3994
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003995#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 else if (ttym_flags == TTYM_DEC)
3997 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003998 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01004000 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004002 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004004#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004006#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 else
4008 {
4009 if (on)
4010 {
4011 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004012 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 }
4014 else
4015 {
4016 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004017 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 }
4019 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004020#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004022#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004023 else
4024 {
4025 if (on)
4026 {
4027 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004028 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004029 }
4030 else
4031 {
4032 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004033 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004034 }
4035 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004036#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004037
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004038#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 else
4040 {
4041 if (on)
4042 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004043 // D - Enable Mouse up/down messages
4044 // L - Enable Left Button Reporting
4045 // M - Enable Middle Button Reporting
4046 // R - Enable Right Button Reporting
4047 // K - Enable SHIFT and CTRL key Reporting
4048 // + - Enable Advanced messaging of mouse moves and up/down messages
4049 // Q - Quiet No Ack
4050 // # - Numeric value of mouse pointer required
4051 // 0 = Multiview 2000 cursor, used as standard
4052 // 1 = Windows Arrow
4053 // 2 = Windows I Beam
4054 // 3 = Windows Hour Glass
4055 // 4 = Windows Cross Hair
4056 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004057# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01004058 // Disables full feedback of pointer movements
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004059 out_str_nf((char_u *)"\033[0~ZwLMRK1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004060# else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004061 out_str_nf((char_u *)"\033[0~ZwLMRK+1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004062# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004063 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 }
4065 else
4066 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004067 out_str_nf((char_u *)"\033[0~ZwQ\033\\");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004068 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 }
4070 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004071#endif
4072#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 else
4074 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004075 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 if (on)
4077 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
4078 else
4079 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004080 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004082#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083}
4084
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01004085#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004086/*
4087 * Called when 'balloonevalterm' changed.
4088 */
4089 void
4090mch_bevalterm_changed(void)
4091{
4092 mch_setmouse(mouse_ison);
4093}
4094#endif
4095
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096/*
4097 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
4098 */
4099 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004100check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101{
4102# ifdef FEAT_MOUSE_XTERM
4103 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02004104# ifdef FEAT_MOUSE_URXVT
4105 && use_xterm_mouse() != 3
4106# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107# ifdef FEAT_GUI
4108 && !gui.in_use
4109# endif
4110 )
4111 {
4112 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004113 ? "\233M" : "\033[M"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 if (*p_mouse != NUL)
4115 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004116 // force mouse off and maybe on to send possibly new mouse
4117 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 mch_setmouse(FALSE);
4119 setmouse();
4120 }
4121 }
4122 else
4123 del_mouse_termcode(KS_MOUSE);
4124# endif
4125
4126# ifdef FEAT_MOUSE_GPM
4127 if (!use_xterm_mouse()
4128# ifdef FEAT_GUI
4129 && !gui.in_use
4130# endif
4131 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004132 set_mouse_termcode(KS_GPM_MOUSE, (char_u *)"\033MG");
Bram Moolenaarbedf0912019-05-04 16:58:45 +02004133 else
4134 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135# endif
4136
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004137# ifdef FEAT_SYSMOUSE
4138 if (!use_xterm_mouse()
4139# ifdef FEAT_GUI
4140 && !gui.in_use
4141# endif
4142 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004143 set_mouse_termcode(KS_MOUSE, (char_u *)"\033MS");
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004144# endif
4145
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01004147 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 if (!use_xterm_mouse()
4149# ifdef FEAT_GUI
4150 && !gui.in_use
4151# endif
4152 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004153 set_mouse_termcode(KS_JSBTERM_MOUSE, (char_u *)"\033[0~zw");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 else
4155 del_mouse_termcode(KS_JSBTERM_MOUSE);
4156# endif
4157
4158# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01004159 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
4160 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 if (!use_xterm_mouse()
4162# ifdef FEAT_GUI
4163 && !gui.in_use
4164# endif
4165 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004166 set_mouse_termcode(KS_NETTERM_MOUSE, (char_u *)"\033}");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 else
4168 del_mouse_termcode(KS_NETTERM_MOUSE);
4169# endif
4170
4171# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01004172 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004173 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174# ifdef FEAT_GUI
4175 && !gui.in_use
4176# endif
4177 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004178 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004179 ? "\233" : "\033["));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 else
4181 del_mouse_termcode(KS_DEC_MOUSE);
4182# endif
4183# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01004184 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004185 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186# ifdef FEAT_GUI
4187 && !gui.in_use
4188# endif
4189 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004190 set_mouse_termcode(KS_PTERM_MOUSE, (char_u *)"\033[");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 else
4192 del_mouse_termcode(KS_PTERM_MOUSE);
4193# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02004194# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004195 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02004196# ifdef FEAT_GUI
4197 && !gui.in_use
4198# endif
4199 )
4200 {
4201 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004202 ? "\233*M" : "\033[*M"));
Bram Moolenaarc8427482011-10-20 21:09:35 +02004203
4204 if (*p_mouse != NUL)
4205 {
4206 mch_setmouse(FALSE);
4207 setmouse();
4208 }
4209 }
4210 else
4211 del_mouse_termcode(KS_URXVT_MOUSE);
4212# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004213 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004214# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004215 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004216# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004217 )
4218 {
4219 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004220 ? "\233<*M" : "\033[<*M"));
Bram Moolenaara529ce02017-06-22 22:37:57 +02004221
4222 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004223 ? "\233<*m" : "\033[<*m"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004224
4225 if (*p_mouse != NUL)
4226 {
4227 mch_setmouse(FALSE);
4228 setmouse();
4229 }
4230 }
4231 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02004232 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004233 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02004234 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
4235 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238#ifndef VMS
4239
4240/*
4241 * Try to get the current window size:
4242 * 1. with an ioctl(), most accurate method
4243 * 2. from the environment variables LINES and COLUMNS
4244 * 3. from the termcap
4245 * 4. keep using the old values
4246 * Return OK when size could be determined, FAIL otherwise.
4247 */
4248 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004249mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250{
4251 long rows = 0;
4252 long columns = 0;
4253 char_u *p;
4254
4255 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 * 1. try using an ioctl. It is the most accurate method.
4257 *
4258 * Try using TIOCGWINSZ first, some systems that have it also define
4259 * TIOCGSIZE but don't have a struct ttysize.
4260 */
4261# ifdef TIOCGWINSZ
4262 {
4263 struct winsize ws;
4264 int fd = 1;
4265
Bram Moolenaar0f873732019-12-05 20:28:46 +01004266 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 if (!isatty(fd) && isatty(read_cmd_fd))
4268 fd = read_cmd_fd;
4269 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4270 {
4271 columns = ws.ws_col;
4272 rows = ws.ws_row;
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004273# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004274 ch_log(NULL, "Got size with TIOCGWINSZ: %ld x %ld", columns, rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004275# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 }
4277 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004278# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279# ifdef TIOCGSIZE
4280 {
4281 struct ttysize ts;
4282 int fd = 1;
4283
Bram Moolenaar0f873732019-12-05 20:28:46 +01004284 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 if (!isatty(fd) && isatty(read_cmd_fd))
4286 fd = read_cmd_fd;
4287 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4288 {
4289 columns = ts.ts_cols;
4290 rows = ts.ts_lines;
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004291# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004292 ch_log(NULL, "Got size with TIOCGSIZE: %ld x %ld", columns, rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004293# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 }
4295 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004296# endif // TIOCGSIZE
4297# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298
4299 /*
4300 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004301 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4302 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004304 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 {
4306 if ((p = (char_u *)getenv("LINES")))
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004307 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 rows = atoi((char *)p);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004309# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004310 ch_log(NULL, "Got 'lines' from $LINES: %ld", rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004311# endif
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004312 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 if ((p = (char_u *)getenv("COLUMNS")))
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004314 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 columns = atoi((char *)p);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004316# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004317 ch_log(NULL, "Got 'columns' from $COLUMNS: %ld", columns);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004318# endif
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004319 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 }
4321
4322#ifdef HAVE_TGETENT
4323 /*
4324 * 3. try reading "co" and "li" entries from termcap
4325 */
4326 if (columns == 0 || rows == 0)
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004327 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 getlinecol(&columns, &rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004329# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004330 ch_log(NULL, "Got size from termcap: %ld x %ld", columns, rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004331# endif
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004332 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333#endif
4334
4335 /*
4336 * 4. If everything fails, use the old values
4337 */
4338 if (columns <= 0 || rows <= 0)
4339 return FAIL;
4340
4341 Rows = rows;
4342 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004343 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 return OK;
4345}
4346
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004347#if defined(FEAT_TERMINAL) || defined(PROTO)
4348/*
4349 * Report the windows size "rows" and "cols" to tty "fd".
4350 */
4351 int
4352mch_report_winsize(int fd, int rows, int cols)
4353{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004354 int tty_fd;
4355 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004356
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004357 tty_fd = get_tty_fd(fd);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004358 if (tty_fd < 0)
4359 return FAIL;
4360
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004361# if defined(TIOCSWINSZ)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004362 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004363
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004364 ws.ws_col = cols;
4365 ws.ws_row = rows;
4366 ws.ws_xpixel = cols * 5;
4367 ws.ws_ypixel = rows * 10;
4368 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004369 ch_log(NULL, "ioctl(TIOCSWINSZ) %s", retval == 0 ? "success" : "failed");
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004370# elif defined(TIOCSSIZE)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004371 struct ttysize ts;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004372
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004373 ts.ts_cols = cols;
4374 ts.ts_lines = rows;
4375 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004376 ch_log(NULL, "ioctl(TIOCSSIZE) %s", retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004377# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004378 if (tty_fd != fd)
4379 close(tty_fd);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004380 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004381}
4382#endif
4383
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384/*
4385 * Try to set the window size to Rows and Columns.
4386 */
4387 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004388mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389{
4390 if (*T_CWS)
4391 {
4392 /*
4393 * NOTE: if you get an error here that term_set_winsize() is
4394 * undefined, check the output of configure. It could probably not
4395 * find a ncurses, termcap or termlib library.
4396 */
4397 term_set_winsize((int)Rows, (int)Columns);
4398 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004399 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 }
4401}
4402
Bram Moolenaar0f873732019-12-05 20:28:46 +01004403#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404
4405/*
4406 * Rows and/or Columns has changed.
4407 */
4408 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004409mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004411 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412}
4413
Bram Moolenaar205b8862011-09-07 15:04:31 +02004414/*
4415 * Wait for process "child" to end.
4416 * Return "child" if it exited properly, <= 0 on error.
4417 */
4418 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004419wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004420{
4421 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004422 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004423
4424 while (wait_pid != child)
4425 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004426 // When compiled with Python threads are probably used, in which case
4427 // wait() sometimes hangs for no obvious reason. Use waitpid()
4428 // instead and loop (like the GUI). Also needed for other interfaces,
4429 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004430# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004431 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004432# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004433 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004434# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004435 if (wait_pid == 0)
4436 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004437 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004438 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004439 if (++delay_msec > 10)
4440 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004441 continue;
4442 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004443 if (wait_pid <= 0
4444# ifdef ECHILD
4445 && errno == ECHILD
4446# endif
4447 )
4448 break;
4449 }
4450 return wait_pid;
4451}
4452
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004453#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004454/*
4455 * Set the environment for a child process.
4456 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004457 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004458set_child_environment(
4459 long rows,
4460 long columns,
4461 char *term,
4462 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004463{
4464# ifdef HAVE_SETENV
4465 char envbuf[50];
4466# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004467 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004468 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004469 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004470 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004471 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004472# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004473 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004474# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004475# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004476 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004477# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004478# endif
4479
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004480# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004481 setenv("TERM", term, 1);
4482 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004483 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004484 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004485 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004486 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004487 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004488 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004489 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004490# ifdef FEAT_TERMINAL
4491 if (is_terminal)
4492 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004493 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004494 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4495 }
4496# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004497# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004498 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004499# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004500# else
4501 /*
4502 * Putenv does not copy the string, it has to remain valid.
4503 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004504 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004505 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004506 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4507 putenv(envbuf_Term);
4508 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004509 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004510 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4511 putenv(envbuf_Lines);
4512 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4513 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004514 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004515 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004516 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004517# ifdef FEAT_TERMINAL
4518 if (is_terminal)
4519 {
4520 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004521 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004522 putenv(envbuf_Version);
4523 }
4524# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004525# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004526 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4527 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4528 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004529# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004530# endif
4531}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004532
4533 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004534set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004535{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004536 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004537}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004538#endif
4539
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004540#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004541/*
4542 * Open a PTY, with FD for the master and slave side.
4543 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004544 * When successful both file descriptors are stored and the allocated pty name
4545 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004546 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004547 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004548open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004549{
4550 char *tty_name;
4551
Bram Moolenaar59386482019-02-10 22:43:46 +01004552 if (name1 != NULL)
4553 *name1 = NULL;
4554 if (name2 != NULL)
4555 *name2 = NULL;
4556
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004557 *pty_master_fd = mch_openpty(&tty_name); // open pty
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004558 if (*pty_master_fd < 0)
4559 return;
4560
4561 // Leaving out O_NOCTTY may lead to waitpid() always returning
4562 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4563 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004564#ifdef O_NOCTTY
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004565 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004566#else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004567 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004568#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004569 if (*pty_slave_fd < 0)
4570 {
4571 close(*pty_master_fd);
4572 *pty_master_fd = -1;
4573 }
4574 else
4575 {
4576 if (name1 != NULL)
4577 *name1 = vim_strsave((char_u *)tty_name);
4578 if (name2 != NULL)
4579 *name2 = vim_strsave((char_u *)tty_name);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004580 }
4581}
4582#endif
4583
Bram Moolenaarfae42832017-08-01 22:24:26 +02004584/*
4585 * Send SIGINT to a child process if "c" is an interrupt character.
4586 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004587 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004588may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4589{
4590# ifdef SIGINT
4591 if (c == Ctrl_C || c == intr_char)
4592 {
4593# ifdef HAVE_SETSID
4594 kill(-pid, SIGINT);
4595# else
4596 kill(0, SIGINT);
4597# endif
4598 if (wpid > 0)
4599 kill(wpid, SIGINT);
4600 }
4601# endif
4602}
4603
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004604#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004605
Bram Moolenaar0f873732019-12-05 20:28:46 +01004606/*
4607 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4608 * pointers, the last one is NULL.
4609 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4610 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004611 int
4612unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004613 char_u *cmd,
4614 char ***argvp,
4615 char_u **sh_tofree,
4616 char_u **shcf_tofree)
4617{
4618 char **argv = NULL;
4619 int argc;
4620
4621 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004622 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004623 return FAIL;
4624
4625 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4626 return FAIL;
4627 *argvp = argv;
4628
4629 if (cmd != NULL)
4630 {
4631 char_u *s;
4632 char_u *p;
4633
4634 if (extra_shell_arg != NULL)
4635 argv[argc++] = (char *)extra_shell_arg;
4636
Bram Moolenaar0f873732019-12-05 20:28:46 +01004637 // Break 'shellcmdflag' into white separated parts. This doesn't
4638 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004639 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004640 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004641 return FAIL;
4642 s = *shcf_tofree;
4643 p = p_shcf;
4644 while (*p != NUL)
4645 {
4646 argv[argc++] = (char *)s;
4647 while (*p && *p != ' ' && *p != TAB)
4648 *s++ = *p++;
4649 *s++ = NUL;
4650 p = skipwhite(p);
4651 }
4652
4653 argv[argc++] = (char *)cmd;
4654 }
4655 argv[argc] = NULL;
4656 return OK;
4657}
4658#endif
4659
4660#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4661/*
4662 * Use a terminal window to run a shell command in.
4663 */
4664 static int
4665mch_call_shell_terminal(
4666 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004667 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004668{
4669 jobopt_T opt;
4670 char **argv = NULL;
4671 char_u *tofree1 = NULL;
4672 char_u *tofree2 = NULL;
4673 int retval = -1;
4674 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004675 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004676 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004677 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004678
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004679 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004680 goto theend;
4681
4682 init_job_options(&opt);
4683 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4684 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004685 if (buf == NULL)
4686 goto theend;
4687
4688 job = term_getjob(buf->b_term);
4689 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004690
Bram Moolenaar0f873732019-12-05 20:28:46 +01004691 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004692 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00004693 if (curbuf == buf)
Bram Moolenaar13568252018-03-16 20:46:58 +01004694 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004695 // Only when managed to find a window for "buf",
4696 clear_oparg(&oa);
4697 while (term_use_loop())
Bram Moolenaar13568252018-03-16 20:46:58 +01004698 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004699 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4700 {
4701 // If terminal_loop() returns OK we got a key that is handled
4702 // in Normal model. We don't do redrawing anyway.
4703 if (terminal_loop(TRUE) == OK)
4704 normal_cmd(&oa, TRUE);
4705 }
4706 else
Bram Moolenaar13568252018-03-16 20:46:58 +01004707 normal_cmd(&oa, TRUE);
4708 }
Bram Moolenaare76062c2022-11-28 18:51:43 +00004709 retval = job->jv_exitval;
4710 ch_log(NULL, "system command finished");
4711
4712 job_unref(job);
4713
4714 // restore curwin/curbuf and a few other things
4715 aucmd_restbuf(&aco);
Bram Moolenaar13568252018-03-16 20:46:58 +01004716 }
Bram Moolenaar13568252018-03-16 20:46:58 +01004717
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01004718 // Only require pressing Enter when redrawing, to avoid that system() gets
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004719 // the hit-enter prompt even though it didn't output anything.
Bram Moolenaar79cdf022023-05-20 14:07:00 +01004720 if (RedrawingDisabled == 0)
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004721 wait_return(TRUE);
Bram Moolenaar13568252018-03-16 20:46:58 +01004722 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4723
4724theend:
4725 vim_free(argv);
4726 vim_free(tofree1);
4727 vim_free(tofree2);
4728 return retval;
4729}
4730#endif
4731
4732#ifdef USE_SYSTEM
4733/*
4734 * Use system() to start the shell: simple but slow.
4735 */
4736 static int
4737mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004738 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004739 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740{
4741#ifdef VMS
4742 char *ifn = NULL;
4743 char *ofn = NULL;
4744#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004745 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004746 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004747 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748
4749 out_flush();
4750
4751 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004752 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
Bram Moolenaar62b42182010-09-21 22:09:37 +02004754# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004755 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004756 loose_clipboard();
4757# endif
4758
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 if (cmd == NULL)
4760 x = system((char *)p_sh);
4761 else
4762 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004763# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 if (ofn = strchr((char *)cmd, '>'))
4765 *ofn++ = '\0';
4766 if (ifn = strchr((char *)cmd, '<'))
4767 {
4768 char *p;
4769
4770 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004771 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 if (p)
4773 *p = '\0';
4774 }
4775 if (ofn)
4776 x = vms_sys((char *)cmd, ofn, ifn);
4777 else
4778 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004779# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004780 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004782 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 if (newcmd == NULL)
4784 x = 0;
4785 else
4786 {
4787 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4788 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4789 (char *)p_shcf,
4790 (char *)cmd);
4791 x = system((char *)newcmd);
4792 vim_free(newcmd);
4793 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004794# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 }
4796# ifdef VMS
4797 x = vms_sys_status(x);
4798# endif
4799 if (emsg_silent)
4800 ;
4801 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004802 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 else if (x && !(options & SHELL_SILENT))
4804 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004805 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 msg_outnum((long)x);
4807 msg_putchar('\n');
4808 }
4809
4810 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004811 {
4812 // The shell may have messed with the mode, always set it.
4813 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004814 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004815 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 resettitle();
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004817# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4818 restore_clipboard();
4819# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004821}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822
Bram Moolenaar0f873732019-12-05 20:28:46 +01004823#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824
Bram Moolenaar0f873732019-12-05 20:28:46 +01004825# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4826 // 127, some shells use that already
4827# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
Bram Moolenaar13568252018-03-16 20:46:58 +01004829/*
4830 * Don't use system(), use fork()/exec().
4831 */
4832 static int
4833mch_call_shell_fork(
4834 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004835 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004836{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004837 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004839 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 pid_t wait_pid = 0;
4841# ifdef HAVE_UNION_WAIT
4842 union wait status;
4843# else
4844 int status = -1;
4845# endif
4846 int retval = -1;
4847 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004848 char_u *tofree1 = NULL;
4849 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004851 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004852# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004854# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004855 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 int fd_fromshell[2];
4857 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004858 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859
4860 out_flush();
4861 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004862 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004863 if (tmode == TMODE_RAW)
4864 // The shell may have messed with the mode, always set it later.
4865 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004867 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004868 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004869
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004871 * For the GUI, when writing the output into the buffer and when reading
4872 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4873 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004875 if ((options & (SHELL_READ|SHELL_WRITE))
4876# ifdef FEAT_GUI
4877 || (gui.in_use && show_shell_mess)
4878# endif
4879 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004881# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 /*
4883 * Try to open a master pty.
4884 * If this works, open the slave pty.
4885 * If the slave can't be opened, close the master pty.
4886 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004887 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004888 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 /*
4890 * If not opening a pty or it didn't work, try using pipes.
4891 */
4892 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004893# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 {
4895 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004896 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 {
4898 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004899 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 {
4901 close(fd_toshell[0]);
4902 close(fd_toshell[1]);
4903 }
4904 }
4905 if (pipe_error)
4906 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004907 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 out_flush();
4909 }
4910 }
4911 }
4912
Bram Moolenaar0f873732019-12-05 20:28:46 +01004913 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004915 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004916 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004917 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004918 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004920 UNBLOCK_SIGNALS(&curset);
4921
Bram Moolenaar32526b32019-01-19 17:43:09 +01004922 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004923 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004925 || (gui.in_use && show_shell_mess)
4926# endif
4927 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004929# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004930 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 {
4932 close(pty_master_fd);
4933 close(pty_slave_fd);
4934 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004935 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004936# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 {
4938 close(fd_toshell[0]);
4939 close(fd_toshell[1]);
4940 close(fd_fromshell[0]);
4941 close(fd_fromshell[1]);
4942 }
4943 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004945 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004947 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004948 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00004950# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01004951 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004952 {
4953 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004954 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004955 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004956# endif
4957
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 if (!show_shell_mess || (options & SHELL_EXPAND))
4959 {
4960 int fd;
4961
4962 /*
4963 * Don't want to show any message from the shell. Can't just
4964 * close stdout and stderr though, because some systems will
4965 * break if you try to write to them after that, so we must
4966 * use dup() to replace them with something else -- webb
4967 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4968 * waiting for input.
4969 */
4970 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4971 fclose(stdin);
4972 fclose(stdout);
4973 fclose(stderr);
4974
4975 /*
4976 * If any of these open()'s and dup()'s fail, we just continue
4977 * anyway. It's not fatal, and on most systems it will make
4978 * no difference at all. On a few it will cause the execvp()
4979 * to exit with a non-zero status even when the completion
4980 * could be done, which is nothing too serious. If the open()
4981 * or dup() failed we'd just do the same thing ourselves
4982 * anyway -- webb
4983 */
4984 if (fd >= 0)
4985 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004986 vim_ignored = dup(fd); // To replace stdin (fd 0)
4987 vim_ignored = dup(fd); // To replace stdout (fd 1)
4988 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989
Bram Moolenaar0f873732019-12-05 20:28:46 +01004990 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 close(fd);
4992 }
4993 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004994 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004996 || gui.in_use
4997# endif
4998 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 {
5000
Bram Moolenaardf177f62005-02-22 08:39:57 +00005001# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005002 // Create our own process group, so that the child and all its
5003 // children can be kill()ed. Don't do this when using pipes,
5004 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005005 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00005006 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005007 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00005008# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005009 // When doing "!xterm&" and 'shell' is bash: the shell
5010 // will exit and send SIGHUP to all processes in its
5011 // group, killing the just started process. Ignore SIGHUP
5012 // to avoid that. (suggested by Simon Schubert)
ichizok378447f2023-05-11 22:25:42 +01005013 mch_signal(SIGHUP, SIG_IGN);
Bram Moolenaar07256082009-02-04 13:19:42 +00005014# endif
5015 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005016# endif
5017# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005018 if (pty_slave_fd >= 0)
5019 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005020 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005021 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005022 setup_slavepty(pty_slave_fd);
Bram Moolenaarfff10d92021-10-13 10:05:30 +01005023# ifdef TIOCSCTTY
5024 // Try to become controlling tty (probably doesn't work,
5025 // unless run by root)
5026 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5027# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005028 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005029# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005030 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031
Bram Moolenaara5792f52005-11-23 21:25:05 +00005032 /*
5033 * stderr is only redirected when using the GUI, so that a
5034 * program like gpg can still access the terminal to get a
5035 * passphrase using stderr.
5036 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005037# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 if (pty_master_fd >= 0)
5039 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005040 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041
Bram Moolenaar0f873732019-12-05 20:28:46 +01005042 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005044 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005046 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00005047 if (gui.in_use)
5048 {
5049 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005050 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00005051 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052
Bram Moolenaar0f873732019-12-05 20:28:46 +01005053 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 }
5055 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00005056# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005058 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 close(fd_toshell[1]);
5060 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005061 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 close(fd_toshell[0]);
5063
Bram Moolenaar0f873732019-12-05 20:28:46 +01005064 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 close(fd_fromshell[0]);
5066 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005067 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 close(fd_fromshell[1]);
5069
Bram Moolenaara5792f52005-11-23 21:25:05 +00005070# ifdef FEAT_GUI
5071 if (gui.in_use)
5072 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005073 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00005074 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005075 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00005076 }
5077# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 }
5079 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005080
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 /*
5082 * There is no type cast for the argv, because the type may be
5083 * different on different machines. This may cause a warning
5084 * message with strict compilers, don't worry about it.
5085 * Call _exit() instead of exit() to avoid closing the connection
5086 * to the X server (esp. with GTK, which uses atexit()).
5087 */
5088 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005089 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005091 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 {
5093 /*
5094 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005095 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 */
5097 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005098 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005099 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005100# ifdef FEAT_JOB_CHANNEL
5101 ++dont_check_job_ended;
5102# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 /*
5104 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005105 * This is also used to pipe stdin/stdout to/from the external
5106 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005108 if ((options & (SHELL_READ|SHELL_WRITE))
5109# ifdef FEAT_GUI
5110 || (gui.in_use && show_shell_mess)
5111# endif
5112 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005114# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01005116 int buffer_off = 0; // valid bytes in buffer[]
5117 char_u ta_buf[BUFLEN + 1]; // TypeAHead
5118 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 int len;
5120 int p_more_save;
5121 int old_State;
5122 int c;
5123 int toshell_fd;
5124 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005125 garray_T ga;
5126 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01005127# ifdef ELAPSED_FUNC
5128 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005129# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130
Bram Moolenaardf177f62005-02-22 08:39:57 +00005131# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 if (pty_master_fd >= 0)
5133 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 fromshell_fd = pty_master_fd;
5135 toshell_fd = dup(pty_master_fd);
5136 }
5137 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00005138# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 {
5140 close(fd_toshell[0]);
5141 close(fd_fromshell[1]);
5142 toshell_fd = fd_toshell[1];
5143 fromshell_fd = fd_fromshell[0];
5144 }
5145
5146 /*
5147 * Write to the child if there are typed characters.
5148 * Read from the child if there are characters available.
5149 * Repeat the reading a few times if more characters are
5150 * available. Need to check for typed keys now and then, but
5151 * not too often (delays when no chars are available).
5152 * This loop is quit if no characters can be read from the pty
5153 * (WaitForChar detected special condition), or there are no
5154 * characters available and the child has exited.
5155 * Only check if the child has exited when there is no more
5156 * output. The child may exit before all the output has
5157 * been printed.
5158 *
5159 * Currently this busy loops!
5160 * This can probably dead-lock when the write blocks!
5161 */
5162 p_more_save = p_more;
5163 p_more = FALSE;
5164 old_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01005165 State = MODE_EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005167 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005168 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005169 // Fork a process that will write the lines to the
5170 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005171 if ((wpid = fork()) == -1)
5172 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005173 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005174 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005175 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00005176 {
5177 linenr_T lnum = curbuf->b_op_start.lnum;
5178 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00005179 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005180 size_t l;
5181
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00005182 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005183 for (;;)
5184 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00005185 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005186 if (l == 0)
5187 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00005188 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005189 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00005190 len = write(toshell_fd, "", (size_t)1);
5191 else
5192 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01005193 char_u *s = vim_strchr(lp + written, NL);
5194
Bram Moolenaar89d40322006-08-29 15:30:07 +00005195 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00005196 s == NULL ? l
5197 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005198 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00005199 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005200 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005201 // Finished a line, add a NL, unless this line
5202 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005203 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005204 || (!curbuf->b_p_bin
5205 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005206 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaar88456cd2022-11-18 22:14:09 +00005207 && (lnum != curbuf->b_ml.ml_line_count
Bram Moolenaardf177f62005-02-22 08:39:57 +00005208 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02005209 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005210 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005211 ++lnum;
5212 if (lnum > curbuf->b_op_end.lnum)
5213 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005214 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00005215 close(toshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005216 break;
5217 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00005218 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005219 written = 0;
5220 }
5221 else if (len > 0)
5222 written += len;
5223 }
5224 _exit(0);
5225 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005226 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00005227 {
5228 close(toshell_fd);
5229 toshell_fd = -1;
5230 }
5231 }
5232
5233 if (options & SHELL_READ)
5234 ga_init2(&ga, 1, BUFLEN);
5235
5236 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005237# ifdef ELAPSED_FUNC
5238 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005239# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 for (;;)
5241 {
5242 /*
5243 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005244 * if there are any.
5245 * Don't do this if we are expanding wild cards (would eat
5246 * typeahead).
5247 * Don't do this when filtering and terminal is in cooked
5248 * mode, the shell command will handle the I/O. Avoids
5249 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005250 * Don't get characters when the child has already
5251 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00005252 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005253 * while (noread_cnt > 4), avoids that ":r !ls" eats
5254 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 */
5256 len = 0;
5257 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005258 && ((options &
5259 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5260 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005261# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005262 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005263# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005264 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005265 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005266 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005268 if (ta_len == 0)
5269 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005270 // Get extra characters when we don't have any.
5271 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005272 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005273# ifdef ELAPSED_FUNC
5274 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005275# endif
5276 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5277 }
5278 if (ta_len > 0 || len > 0)
5279 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 /*
5281 * For pipes:
5282 * Check for CTRL-C: send interrupt signal to child.
5283 * Check for CTRL-D: EOF, close pipe to child.
5284 */
5285 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5286 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 /*
5288 * Send SIGINT to the child's group or all
5289 * processes in our group.
5290 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005291 may_send_sigint(ta_buf[ta_len], pid, wpid);
5292
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 if (pty_master_fd < 0 && toshell_fd >= 0
5294 && ta_buf[ta_len] == Ctrl_D)
5295 {
5296 close(toshell_fd);
5297 toshell_fd = -1;
5298 }
5299 }
5300
Bram Moolenaar2f7e1b82022-10-04 13:17:31 +01005301 // Remove Vim-specific codes from the input.
5302 len = term_replace_keycodes(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303
5304 /*
5305 * For pipes: echo the typed characters.
5306 * For a pty this does not seem to work.
5307 */
5308 if (pty_master_fd < 0)
5309 {
5310 for (i = ta_len; i < ta_len + len; ++i)
5311 {
5312 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5313 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 else if (has_mbyte)
5315 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005316 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
5318 msg_outtrans_len(ta_buf + i, l);
5319 i += l - 1;
5320 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 else
5322 msg_outtrans_len(ta_buf + i, 1);
5323 }
5324 windgoto(msg_row, msg_col);
5325 out_flush();
5326 }
5327
5328 ta_len += len;
5329
5330 /*
5331 * Write the characters to the child, unless EOF has
5332 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005333 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005334 * When writing buffer lines, drop the typed
5335 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005337 if (options & SHELL_WRITE)
5338 ta_len = 0;
5339 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 {
5341 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5342 if (len > 0)
5343 {
5344 ta_len -= len;
5345 mch_memmove(ta_buf, ta_buf + len, ta_len);
5346 }
5347 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 }
5350
Bram Moolenaardf177f62005-02-22 08:39:57 +00005351 if (got_int)
5352 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005353 // CTRL-C sends a signal to the child, we ignore it
5354 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005355# ifdef HAVE_SETSID
5356 kill(-pid, SIGINT);
5357# else
5358 kill(0, SIGINT);
5359# endif
5360 if (wpid > 0)
5361 kill(wpid, SIGINT);
5362 got_int = FALSE;
5363 }
5364
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 /*
5366 * Check if the child has any characters to be printed.
5367 * Read them and write them to our window. Repeat this as
5368 * long as there is something to do, avoid the 10ms wait
5369 * for mch_inchar(), or sending typeahead characters to
5370 * the external process.
5371 * TODO: This should handle escape sequences, compatible
5372 * to some terminal (vt52?).
5373 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005374 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005375 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005377 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005380 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005382
5383 noread_cnt = 0;
5384 if (options & SHELL_READ)
5385 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005386 // Do NUL -> NL translation, append NL separated
5387 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005388 for (i = 0; i < len; ++i)
5389 {
5390 if (buffer[i] == NL)
5391 append_ga_line(&ga);
5392 else if (buffer[i] == NUL)
5393 ga_append(&ga, NL);
5394 else
5395 ga_append(&ga, buffer[i]);
5396 }
5397 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005398 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 {
5400 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005401 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402
Bram Moolenaardf177f62005-02-22 08:39:57 +00005403 len += buffer_off;
5404 buffer[len] = NUL;
5405
Bram Moolenaar0f873732019-12-05 20:28:46 +01005406 // Check if the last character in buffer[] is
5407 // incomplete, keep these bytes for the next
5408 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 for (p = buffer; p < buffer + len; p += l)
5410 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005411 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005413 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 else if (MB_BYTE2LEN(*p) != l)
5415 break;
5416 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005417 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005419 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 if (len >= 12)
5421 ++p;
5422 else
5423 {
5424 buffer_off = len;
5425 continue;
5426 }
5427 }
5428 c = *p;
5429 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005430 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 if (p < buffer + len)
5432 {
5433 *p = c;
5434 buffer_off = (buffer + len) - p;
5435 mch_memmove(buffer, p, buffer_off);
5436 continue;
5437 }
5438 buffer_off = 0;
5439 }
5440 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 {
5442 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005443 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 }
5445
5446 windgoto(msg_row, msg_col);
5447 cursor_on();
5448 out_flush();
5449 if (got_int)
5450 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005451
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005452# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005453 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005454 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005455 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005456
Bram Moolenaar0f873732019-12-05 20:28:46 +01005457 // Avoid that we keep looping here without
5458 // checking for a CTRL-C for a long time. Don't
5459 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005460 if (msec > 2000)
5461 {
5462 noread_cnt = 5;
5463 break;
5464 }
5465 }
5466# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 }
5468
Bram Moolenaar0f873732019-12-05 20:28:46 +01005469 // If we already detected the child has finished, continue
5470 // reading output for a short while. Some text may be
5471 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005472 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005473 {
5474 if (noread_cnt < 5)
5475 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005476 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005477 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005478
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 /*
5480 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005481 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005483# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005484 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005485# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005487# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5489 || (wait_pid == pid && WIFEXITED(status)))
5490 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005491 // Don't break the loop yet, try reading more
5492 // characters from "fromshell_fd" first. When using
5493 // pipes there might still be something to read and
5494 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005497 else
5498 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005499
Bram Moolenaar95a51352013-03-21 22:53:50 +01005500# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005501 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005502 clip_update();
5503# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 }
5505finished:
5506 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005507 if (options & SHELL_READ)
5508 {
5509 if (ga.ga_len > 0)
5510 {
5511 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005512 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005513 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005514 }
5515 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005516 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005517 ga_clear(&ga);
5518 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 /*
5521 * Give all typeahead that wasn't used back to ui_inchar().
5522 */
5523 if (ta_len)
5524 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 State = old_State;
5526 if (toshell_fd >= 0)
5527 close(toshell_fd);
5528 close(fromshell_fd);
5529 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005530# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005531 else
5532 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005533 long delay_msec = 1;
5534
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005535 if (tmode == TMODE_RAW)
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005536 // Possibly disables modifyOtherKeys, so that the system
5537 // can recognize CTRL-C.
5538 out_str_t_TE();
Bram Moolenaar0981c872020-08-23 14:28:37 +02005539
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005540 /*
5541 * Similar to the loop above, but only handle X events, no
5542 * I/O.
5543 */
5544 for (;;)
5545 {
5546 if (got_int)
5547 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005548 // CTRL-C sends a signal to the child, we ignore it
5549 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005550# ifdef HAVE_SETSID
5551 kill(-pid, SIGINT);
5552# else
5553 kill(0, SIGINT);
5554# endif
5555 got_int = FALSE;
5556 }
5557# ifdef __NeXT__
5558 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5559# else
5560 wait_pid = waitpid(pid, &status, WNOHANG);
5561# endif
5562 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5563 || (wait_pid == pid && WIFEXITED(status)))
5564 {
5565 wait_pid = pid;
5566 break;
5567 }
5568
Bram Moolenaar0f873732019-12-05 20:28:46 +01005569 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005570 clip_update();
5571
Bram Moolenaar0f873732019-12-05 20:28:46 +01005572 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005573 // less time, gradually wait longer.
5574 mch_delay(delay_msec,
5575 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005576 if (++delay_msec > 10)
5577 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005578 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005579
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005580 if (tmode == TMODE_RAW)
5581 // possibly enables modifyOtherKeys again
Bram Moolenaar733a69b2022-12-01 12:03:47 +00005582 out_str_t_TI();
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005583 }
5584# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585
5586 /*
5587 * Wait until our child has exited.
5588 * Ignore wait() returning pids of other children and returning
5589 * because of some signal like SIGWINCH.
5590 * Don't wait if wait_pid was already set above, indicating the
5591 * child already exited.
5592 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005593 if (wait_pid != pid)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01005594 (void)wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595
Bram Moolenaar624891f2010-10-13 16:22:09 +02005596# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005597 // Close slave side of pty. Only do this after the child has
5598 // exited, otherwise the child may hang when it tries to write on
5599 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005600 if (pty_master_fd >= 0)
5601 close(pty_slave_fd);
5602# endif
5603
Bram Moolenaar0f873732019-12-05 20:28:46 +01005604 // Make sure the child that writes to the external program is
5605 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005606 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005607 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005608 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005609 wait4pid(wpid, NULL);
5610 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005611
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005612# ifdef FEAT_JOB_CHANNEL
5613 --dont_check_job_ended;
5614# endif
5615
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 /*
5617 * Set to raw mode right now, otherwise a CTRL-C after
5618 * catch_signals() will kill Vim.
5619 */
5620 if (tmode == TMODE_RAW)
5621 settmode(TMODE_RAW);
5622 did_settmode = TRUE;
5623 set_signals();
5624
5625 if (WIFEXITED(status))
5626 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005627 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005629 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 {
5631 if (retval == EXEC_FAILED)
5632 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005633 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 msg_outtrans(p_sh);
5635 msg_putchar('\n');
5636 }
5637 else if (!(options & SHELL_SILENT))
5638 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005639 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 msg_outnum((long)retval);
5641 msg_putchar('\n');
5642 }
5643 }
5644 }
5645 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005646 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 }
5648 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
5650error:
5651 if (!did_settmode)
5652 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005653 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 resettitle();
Bram Moolenaar13568252018-03-16 20:46:58 +01005655 vim_free(argv);
5656 vim_free(tofree1);
5657 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658
5659 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005660}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005661#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005662
5663 int
5664mch_call_shell(
5665 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005666 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005667{
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005668#ifdef FEAT_EVAL
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005669 ch_log(NULL, "executing shell command: %s", cmd);
5670#endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005671#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
Bram Moolenaar524c8532022-09-27 15:48:20 +01005672 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL
5673 && (options & SHELL_SILENT) == 0)
Bram Moolenaar13568252018-03-16 20:46:58 +01005674 return mch_call_shell_terminal(cmd, options);
5675#endif
5676#ifdef USE_SYSTEM
5677 return mch_call_shell_system(cmd, options);
5678#else
5679 return mch_call_shell_fork(cmd, options);
5680#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681}
5682
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005683#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005684 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005685mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005686{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005687 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005688 int fd_in[2] = {-1, -1}; // for stdin
5689 int fd_out[2] = {-1, -1}; // for stdout
5690 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005691 int pty_master_fd = -1;
5692 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005693 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005694 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5695 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5696 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005697 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005698 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5699 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005700 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005701 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005702 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005703
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005704 if (use_out_for_err && use_null_for_out)
5705 use_null_for_err = TRUE;
5706
Bram Moolenaar0f873732019-12-05 20:28:46 +01005707 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005708 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005709
Bram Moolenaarb2412082017-08-20 18:09:14 +02005710 if (options->jo_pty
5711 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005712 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005713 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005714 open_pty(&pty_master_fd, &pty_slave_fd,
5715 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005716
Bram Moolenaar0f873732019-12-05 20:28:46 +01005717 // TODO: without the channel feature connect the child to /dev/null?
5718 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005719 if (use_file_for_in)
5720 {
5721 char_u *fname = options->jo_io_name[PART_IN];
5722
5723 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5724 if (fd_in[0] < 0)
5725 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005726 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005727 goto failed;
5728 }
5729 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005730 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005731 // When writing buffer lines to the input don't use the pty, so that
5732 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005733 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5734 && pipe(fd_in) < 0)
5735 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005736
5737 if (use_file_for_out)
5738 {
5739 char_u *fname = options->jo_io_name[PART_OUT];
5740
5741 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5742 if (fd_out[1] < 0)
5743 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005744 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005745 goto failed;
5746 }
5747 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005748 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005749 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005750
5751 if (use_file_for_err)
5752 {
5753 char_u *fname = options->jo_io_name[PART_ERR];
5754
5755 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5756 if (fd_err[1] < 0)
5757 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005758 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005759 goto failed;
5760 }
5761 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005762 else if (!use_out_for_err && !use_null_for_err
5763 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005764 goto failed;
5765
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005766 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5767 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005768 if (options->jo_set & JO_CHANNEL)
5769 {
5770 channel = options->jo_channel;
5771 if (channel != NULL)
5772 ++channel->ch_refcount;
5773 }
5774 else
5775 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005776 if (channel == NULL)
5777 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005778 if (job->jv_tty_out != NULL)
5779 ch_log(channel, "using pty %s on fd %d",
5780 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005781 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005782
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005783 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005784 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005785 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005786 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005787 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005788 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005789 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005790 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005791 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005792 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005793 int null_fd = -1;
5794 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005795
Bram Moolenaar0f873732019-12-05 20:28:46 +01005796 // child
5797 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005798 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005799
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005800# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01005801 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005802 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005803 ch_logfile((char_u *)"", (char_u *)"");
5804# endif
5805
Bram Moolenaar835dc632016-02-07 14:27:38 +01005806# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005807 // Create our own process group, so that the child and all its
5808 // children can be kill()ed. Don't do this when using pipes,
5809 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005810 (void)setsid();
5811# endif
5812
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005813# ifdef FEAT_TERMINAL
5814 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005815 {
5816 char *term = (char *)T_NAME;
5817
5818#ifdef FEAT_GUI
5819 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005820 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005821 term = getenv("TERM");
5822#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005823 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005824 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005825 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005826 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005827 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005828 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005829 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005830 else if (t_colors > 16)
5831 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005832 else
5833 term = "xterm";
5834 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005835 set_child_environment(
5836 (long)options->jo_term_rows,
5837 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005838 term,
5839 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005840 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005841 else
5842# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005843 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005844
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005845 if (options->jo_env != NULL)
5846 {
5847 dict_T *dict = options->jo_env;
5848 hashitem_T *hi;
5849 int todo = (int)dict->dv_hashtab.ht_used;
5850
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00005851 FOR_ALL_HASHTAB_ITEMS(&dict->dv_hashtab, hi, todo)
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005852 if (!HASHITEM_EMPTY(hi))
5853 {
5854 typval_T *item = &dict_lookup(hi)->di_tv;
5855
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00005856 vim_setenv(hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005857 --todo;
5858 }
5859 }
5860
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005861 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005862 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005863 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005864 if (null_fd < 0)
5865 {
5866 perror("opening /dev/null failed");
5867 _exit(OPEN_NULL_FAILED);
5868 }
5869 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005870
Bram Moolenaar223896d2017-08-02 22:33:28 +02005871 if (pty_slave_fd >= 0)
5872 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005873 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005874 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005875# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005876 // Try to become controlling tty (probably doesn't work,
5877 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005878 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5879# endif
5880 }
5881
Bram Moolenaar0f873732019-12-05 20:28:46 +01005882 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005883 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005884 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005885 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005886 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005887 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005888 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005889 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005890
Bram Moolenaar0f873732019-12-05 20:28:46 +01005891 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005892 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005893 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005894 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005895 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005896 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005897 }
5898 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005899 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005900 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005901 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005902 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005903 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005904
Bram Moolenaar0f873732019-12-05 20:28:46 +01005905 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005906 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005907 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005908 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005909 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005910 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005911 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005912 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005913
5914 if (fd_in[0] >= 0)
5915 close(fd_in[0]);
5916 if (fd_in[1] >= 0)
5917 close(fd_in[1]);
5918 if (fd_out[0] >= 0)
5919 close(fd_out[0]);
5920 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005921 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005922 if (fd_err[0] >= 0)
5923 close(fd_err[0]);
5924 if (fd_err[1] >= 0)
5925 close(fd_err[1]);
5926 if (pty_master_fd >= 0)
5927 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005928 close(pty_master_fd); // not used in the child
5929 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005930 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005931
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005932 if (null_fd >= 0)
5933 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005934
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005935 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5936 _exit(EXEC_FAILED);
5937
Bram Moolenaar0f873732019-12-05 20:28:46 +01005938 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005939 execvp(argv[0], argv);
5940
Bram Moolenaar4694a172016-04-21 14:05:23 +02005941 if (stderr_works)
5942 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005943# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005944 // calling free_all_mem() here causes problems. Ignore valgrind
5945 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005946# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005947 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005948 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005949
Bram Moolenaar0f873732019-12-05 20:28:46 +01005950 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005951 UNBLOCK_SIGNALS(&curset);
5952
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005953 job->jv_pid = pid;
5954 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005955 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005956
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005957 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005958 close(pty_slave_fd); // not used in the parent
5959 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005960 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005961 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005962 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005963 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005964 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005965 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005966 if (channel != NULL)
5967 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005968 int in_fd = INVALID_FD;
5969 int out_fd = INVALID_FD;
5970 int err_fd = INVALID_FD;
5971
5972 if (!(use_file_for_in || use_null_for_in))
5973 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5974
5975 if (!(use_file_for_out || use_null_for_out))
5976 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5977
5978 // When using pty_master_fd only set it for stdout, do not duplicate
5979 // it for stderr, it only needs to be read once.
5980 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5981 {
5982 if (fd_err[0] >= 0)
5983 err_fd = fd_err[0];
5984 else if (out_fd != pty_master_fd)
5985 err_fd = pty_master_fd;
5986 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005987
5988 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005989 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005990 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005991 else
5992 {
5993 if (fd_in[1] >= 0)
5994 close(fd_in[1]);
5995 if (fd_out[0] >= 0)
5996 close(fd_out[0]);
5997 if (fd_err[0] >= 0)
5998 close(fd_err[0]);
5999 if (pty_master_fd >= 0)
6000 close(pty_master_fd);
6001 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006002
Bram Moolenaar0f873732019-12-05 20:28:46 +01006003 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006004 return;
6005
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006006failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01006007 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006008 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006009 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01006010 if (fd_in[1] >= 0)
6011 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006012 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006013 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01006014 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006015 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006016 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006017 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01006018 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006019 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02006020 if (pty_master_fd >= 0)
6021 close(pty_master_fd);
6022 if (pty_slave_fd >= 0)
6023 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01006024}
6025
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006026 static char_u *
6027get_signal_name(int sig)
6028{
6029 int i;
6030 char_u numbuf[NUMBUFLEN];
6031
6032 if (sig == SIGKILL)
6033 return vim_strsave((char_u *)"kill");
6034
6035 for (i = 0; signal_info[i].sig != -1; i++)
6036 if (sig == signal_info[i].sig)
6037 return strlow_save((char_u *)signal_info[i].name);
6038
6039 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
6040 return vim_strsave(numbuf);
6041}
6042
Bram Moolenaar835dc632016-02-07 14:27:38 +01006043 char *
6044mch_job_status(job_T *job)
6045{
6046# ifdef HAVE_UNION_WAIT
6047 union wait status;
6048# else
6049 int status = -1;
6050# endif
6051 pid_t wait_pid = 0;
6052
6053# ifdef __NeXT__
6054 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
6055# else
6056 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
6057# endif
6058 if (wait_pid == -1)
6059 {
Bram Moolenaar5c6a3c92023-03-04 13:23:26 +00006060 int waitpid_errno = errno;
6061 if (waitpid_errno == ECHILD && mch_process_running(job->jv_pid))
6062 // The process is alive, but it was probably reparented (for
6063 // example by ptrace called by a debugger like lldb or gdb).
6064 // Note: This assumes that process IDs are not reused.
6065 return "run";
6066
Bram Moolenaar0f873732019-12-05 20:28:46 +01006067 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006068 if (job->jv_status < JOB_ENDED)
6069 ch_log(job->jv_channel, "Job no longer exists: %s",
Bram Moolenaar5c6a3c92023-03-04 13:23:26 +00006070 strerror(waitpid_errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02006071 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006072 }
6073 if (wait_pid == 0)
6074 return "run";
6075 if (WIFEXITED(status))
6076 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006077 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01006078 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006079 if (job->jv_status < JOB_ENDED)
6080 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02006081 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006082 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01006083 if (WIFSIGNALED(status))
6084 {
6085 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006086 job->jv_termsig = get_signal_name(WTERMSIG(status));
6087 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
6088 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
6089 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02006090 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006091 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01006092 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02006093
6094return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01006095 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02006096 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02006097 return "dead";
6098}
6099
6100 job_T *
6101mch_detect_ended_job(job_T *job_list)
6102{
6103# ifdef HAVE_UNION_WAIT
6104 union wait status;
6105# else
6106 int status = -1;
6107# endif
6108 pid_t wait_pid = 0;
6109 job_T *job;
6110
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01006111# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006112 // Do not do this when waiting for a shell command to finish, we would get
6113 // the exit value here (and discard it), the exit value obtained there
6114 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01006115 if (dont_check_job_ended > 0)
6116 return NULL;
6117# endif
6118
Bram Moolenaar97792de2016-10-15 18:36:49 +02006119# ifdef __NeXT__
6120 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
6121# else
6122 wait_pid = waitpid(-1, &status, WNOHANG);
6123# endif
6124 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006125 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02006126 return NULL;
6127 for (job = job_list; job != NULL; job = job->jv_next)
6128 {
6129 if (job->jv_pid == wait_pid)
6130 {
6131 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006132 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02006133 job->jv_exitval = WEXITSTATUS(status);
6134 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006135 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02006136 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006137 job->jv_termsig = get_signal_name(WTERMSIG(status));
6138 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01006139 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02006140 {
6141 ch_log(job->jv_channel, "Job ended");
6142 job->jv_status = JOB_ENDED;
6143 }
6144 return job;
6145 }
6146 }
6147 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006148}
6149
Bram Moolenaar3a117e12016-10-30 21:57:52 +01006150/*
6151 * Send a (deadly) signal to "job".
6152 * Return FAIL if "how" is not a valid name.
6153 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01006154 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02006155mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01006156{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006157 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006158
Bram Moolenaar923d9262016-02-25 20:56:01 +01006159 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01006160 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01006161 else if (STRCMP(how, "hup") == 0)
6162 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006163 else if (STRCMP(how, "quit") == 0)
6164 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01006165 else if (STRCMP(how, "int") == 0)
6166 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006167 else if (STRCMP(how, "kill") == 0)
6168 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02006169#ifdef SIGWINCH
6170 else if (STRCMP(how, "winch") == 0)
6171 sig = SIGWINCH;
6172#endif
Keith Thompson184f71c2024-01-04 21:19:04 +01006173 else if (SAFE_isdigit(*how))
Bram Moolenaar835dc632016-02-07 14:27:38 +01006174 sig = atoi((char *)how);
6175 else
6176 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006177
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01006178 // Never kill ourselves!
6179 if (job->jv_pid != 0)
6180 {
6181 // TODO: have an option to only kill the process, not the group?
6182 kill(-job->jv_pid, sig);
6183 kill(job->jv_pid, sig);
6184 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01006185
Bram Moolenaar835dc632016-02-07 14:27:38 +01006186 return OK;
6187}
Bram Moolenaar76467df2016-02-12 19:30:26 +01006188
6189/*
6190 * Clear the data related to "job".
6191 */
6192 void
6193mch_clear_job(job_T *job)
6194{
Bram Moolenaar0f873732019-12-05 20:28:46 +01006195 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01006196# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01006197 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01006198# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01006199 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01006200# endif
6201}
Bram Moolenaar835dc632016-02-07 14:27:38 +01006202#endif
6203
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006204#if defined(FEAT_TERMINAL) || defined(PROTO)
6205 int
6206mch_create_pty_channel(job_T *job, jobopt_T *options)
6207{
6208 int pty_master_fd = -1;
6209 int pty_slave_fd = -1;
6210 channel_T *channel;
6211
Bram Moolenaar59386482019-02-10 22:43:46 +01006212 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02006213 if (pty_master_fd < 0 || pty_slave_fd < 0)
6214 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006215 close(pty_slave_fd);
6216
6217 channel = add_channel();
6218 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006219 {
6220 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006221 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006222 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02006223 if (job->jv_tty_out != NULL)
6224 ch_log(channel, "using pty %s on fd %d",
6225 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006226 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006227 channel->ch_keep_open = TRUE;
6228
Bram Moolenaar0f873732019-12-05 20:28:46 +01006229 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
6230 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006231 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006232 channel_set_job(channel, job, options);
6233 return OK;
6234}
6235#endif
6236
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237/*
6238 * Check for CTRL-C typed by reading all available characters.
6239 * In cooked mode we should get SIGINT, no need to check.
6240 */
6241 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006242mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243{
Bram Moolenaar26e86442020-05-17 14:06:16 +02006244 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006245 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 fill_input_buf(FALSE);
6247}
6248
6249/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006250 * Wait "msec" msec until a character is available from the mouse, keyboard,
6251 * from inbuf[].
6252 * "msec" == -1 will block forever.
6253 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006254 * When "ignore_input" is TRUE even check for pending input when input is
6255 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006256 * "interrupted" (if not NULL) is set to TRUE when no character is available
6257 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02006258 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006259 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 */
6261 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006262WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006264#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01006265 return ui_wait_for_chars_or_timer(
6266 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006267#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006268 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006269#endif
6270}
6271
6272/*
6273 * Wait "msec" msec until a character is available from the mouse or keyboard
6274 * or from inbuf[].
6275 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006276 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006277 * "interrupted" (if not NULL) is set to TRUE when no character is available
6278 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006279 * When a GUI is being used, this will never get called -- webb
6280 */
6281 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006282WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006283{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284#ifdef FEAT_MOUSE_GPM
6285 int gpm_process_wanted;
6286#endif
6287#ifdef FEAT_XCLIPBOARD
6288 int rest;
6289#endif
6290 int avail;
6291
Bram Moolenaar0f873732019-12-05 20:28:46 +01006292 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 return 1;
6294
6295#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006296 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 if (WantQueryMouse)
6298 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006299 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006300 if (!no_query_mouse_for_testing)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00006301 mch_write((char_u *)"\033[1'|", 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 }
6303#endif
6304
6305 /*
6306 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6307 * events. This is a bit complicated, because they might both be defined.
6308 */
6309#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6310# ifdef FEAT_XCLIPBOARD
6311 rest = 0;
6312 if (do_xterm_trace())
6313 rest = msec;
6314# endif
6315 do
6316 {
6317# ifdef FEAT_XCLIPBOARD
6318 if (rest != 0)
6319 {
6320 msec = XT_TRACE_DELAY;
6321 if (rest >= 0 && rest < XT_TRACE_DELAY)
6322 msec = rest;
6323 if (rest >= 0)
6324 rest -= msec;
6325 }
6326# endif
Yee Cheng Chin4314e4f2022-10-08 13:50:05 +01006327# ifdef FEAT_SOUND_MACOSX
6328 // Invoke any pending sound callbacks.
6329 process_cfrunloop();
6330# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006331# ifdef FEAT_SOUND_CANBERRA
6332 // Invoke any pending sound callbacks.
6333 if (has_sound_callback_in_queue())
6334 invoke_sound_callback();
6335# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336# ifdef FEAT_MOUSE_GPM
6337 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006338 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006339 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006340 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006342 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006344# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006346 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 return 1;
6348# ifdef FEAT_XCLIPBOARD
6349 if (rest == 0 || !do_xterm_trace())
6350# endif
6351 break;
6352 }
6353 }
6354 while (FALSE
6355# ifdef FEAT_MOUSE_GPM
6356 || (gpm_process_wanted && mch_gpm_process() == 0)
6357# endif
6358# ifdef FEAT_XCLIPBOARD
6359 || (!avail && rest != 0)
6360# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006361 )
6362 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363
6364#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006365 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366#endif
6367 return avail;
6368}
6369
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006370#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371/*
6372 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006373 * "msec" == 0 will check for characters once.
6374 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006377 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006378 * "interrupted" (if not NULL) is set to TRUE when no character is available
6379 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006381 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006382RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383{
6384 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006385 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006386#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 static int busy = FALSE;
6388
Bram Moolenaar0f873732019-12-05 20:28:46 +01006389 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390# define MAY_LOOP
6391
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006392# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006393 // Remember at what time we started, so that we know how much longer we
6394 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006395 long start_msec = msec;
6396 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006398 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006399 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400# endif
6401
Bram Moolenaar0f873732019-12-05 20:28:46 +01006402 // Handle being called recursively. This may happen for the session
6403 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 if (busy)
6405 return 0;
6406#endif
6407
6408#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006409 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410#endif
6411 {
6412#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006413 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006414# ifdef FEAT_MZSCHEME
6415 int mzquantum_used = FALSE;
6416# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417#endif
6418#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006419 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006420 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 int nfd;
6422# ifdef FEAT_XCLIPBOARD
6423 int xterm_idx = -1;
6424# endif
6425# ifdef FEAT_MOUSE_GPM
6426 int gpm_idx = -1;
6427# endif
6428# ifdef USE_XSMP
6429 int xsmp_idx = -1;
6430# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006431 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006433# ifdef FEAT_MZSCHEME
6434 mzvim_check_threads();
6435 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6436 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006437 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006438 mzquantum_used = TRUE;
6439 }
6440# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 fds[0].fd = fd;
6442 fds[0].events = POLLIN;
6443 nfd = 1;
6444
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006446 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 if (xterm_Shell != (Widget)0)
6448 {
6449 xterm_idx = nfd;
6450 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6451 fds[nfd].events = POLLIN;
6452 nfd++;
6453 }
6454# endif
6455# ifdef FEAT_MOUSE_GPM
6456 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6457 {
6458 gpm_idx = nfd;
6459 fds[nfd].fd = gpm_fd;
6460 fds[nfd].events = POLLIN;
6461 nfd++;
6462 }
6463# endif
6464# ifdef USE_XSMP
6465 if (xsmp_icefd != -1)
6466 {
6467 xsmp_idx = nfd;
6468 fds[nfd].fd = xsmp_icefd;
6469 fds[nfd].events = POLLIN;
6470 nfd++;
6471 }
6472# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006473#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006474 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006475#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006476 if (interrupted != NULL)
6477 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006479 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006480
6481 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006482 if (result == 0 && interrupted != NULL && ret > 0)
6483 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006484
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006485# ifdef FEAT_MZSCHEME
6486 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006487 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006488 finished = FALSE;
6489# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491# ifdef FEAT_XCLIPBOARD
6492 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6493 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006494 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006496 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 finished = FALSE;
6498 }
6499# endif
6500# ifdef FEAT_MOUSE_GPM
6501 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503# endif
6504# ifdef USE_XSMP
6505 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6506 {
6507 if (fds[xsmp_idx].revents & POLLIN)
6508 {
6509 busy = TRUE;
6510 xsmp_handle_requests();
6511 busy = FALSE;
6512 }
6513 else if (fds[xsmp_idx].revents & POLLHUP)
6514 {
6515 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006516 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 xsmp_close();
6518 }
6519 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006520 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 }
6522# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006523#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006524 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006525 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006526 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006527#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528
Bram Moolenaar0f873732019-12-05 20:28:46 +01006529#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530
6531 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006532 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006533 // These are static because they can take 8 Kbyte each and cause the
6534 // signal stack to run out with -O3.
6535 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006537 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006539# ifdef FEAT_MZSCHEME
6540 mzvim_check_threads();
6541 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6542 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006543 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006544 mzquantum_used = TRUE;
6545 }
6546# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006548 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006550 tv.tv_sec = towait / 1000;
6551 tv.tv_usec = (towait % 1000) * (1000000/1000);
6552 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006554 else
6555 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556
6557 /*
6558 * Select on ready for reading and exceptional condition (end of file).
6559 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006560select_eintr:
6561 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006562 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 FD_ZERO(&efds);
6564 FD_SET(fd, &rfds);
K.Takatab247e062022-02-07 10:45:23 +00006565# ifndef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006566 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 FD_SET(fd, &efds);
6568# endif
6569 maxfd = fd;
6570
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006572 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 if (xterm_Shell != (Widget)0)
6574 {
6575 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6576 if (maxfd < ConnectionNumber(xterm_dpy))
6577 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006578
Bram Moolenaar0f873732019-12-05 20:28:46 +01006579 // An event may have already been read but not handled. In
6580 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006581 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 }
6583# endif
6584# ifdef FEAT_MOUSE_GPM
6585 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6586 {
6587 FD_SET(gpm_fd, &rfds);
6588 FD_SET(gpm_fd, &efds);
6589 if (maxfd < gpm_fd)
6590 maxfd = gpm_fd;
6591 }
6592# endif
6593# ifdef USE_XSMP
6594 if (xsmp_icefd != -1)
6595 {
6596 FD_SET(xsmp_icefd, &rfds);
6597 FD_SET(xsmp_icefd, &efds);
6598 if (maxfd < xsmp_icefd)
6599 maxfd = xsmp_icefd;
6600 }
6601# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006602# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006603 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006604# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006605 if (interrupted != NULL)
6606 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607
Bram Moolenaar643b6142018-09-12 20:29:09 +02006608 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6609 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006610 result = ret > 0 && FD_ISSET(fd, &rfds);
6611 if (result)
6612 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006613 else if (interrupted != NULL && ret > 0)
6614 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006615
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006616# ifdef EINTR
6617 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006618 {
dbivolaruab16ad32021-12-29 19:41:47 +00006619 // Check whether the EINTR is caused by SIGTSTP
6620 if (got_tstp && !in_mch_suspend)
6621 {
6622 exarg_T ea;
dbivolaru79a6e252022-01-23 16:41:14 +00006623
dbivolaruab16ad32021-12-29 19:41:47 +00006624 ea.forceit = TRUE;
6625 ex_stop(&ea);
6626 got_tstp = FALSE;
6627 }
6628
Bram Moolenaar0f873732019-12-05 20:28:46 +01006629 // Check whether window has been resized, EINTR may be caused by
6630 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006631 if (do_resize)
Bram Moolenaar55f1b822023-06-21 13:42:48 +01006632 {
Bram Moolenaar545c8a52023-06-21 15:51:47 +01006633# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01006634 ch_log(NULL, "calling handle_resize() in RealWaitForChar()");
Bram Moolenaar545c8a52023-06-21 15:51:47 +01006635# endif
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006636 handle_resize();
Bram Moolenaar55f1b822023-06-21 13:42:48 +01006637 }
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006638
Bram Moolenaar0f873732019-12-05 20:28:46 +01006639 // Interrupted by a signal, need to try again. We ignore msec
6640 // here, because we do want to check even after a timeout if
6641 // characters are available. Needed for reading output of an
6642 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006643 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006644 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006645# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006646# ifdef __TANDEM
6647 if (ret == -1 && errno == ENOTSUP)
6648 {
6649 FD_ZERO(&rfds);
6650 FD_ZERO(&efds);
6651 ret = 0;
6652 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006653# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006654# ifdef FEAT_MZSCHEME
6655 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006656 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006657 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658# endif
6659
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660# ifdef FEAT_XCLIPBOARD
6661 if (ret > 0 && xterm_Shell != (Widget)0
6662 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6663 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006664 xterm_update(); // Maybe we should hand out clipboard
6665 // continue looping when we only got the X event and the input
6666 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 if (--ret == 0 && !input_available())
6668 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006669 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 finished = FALSE;
6671 }
6672 }
6673# endif
6674# ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00006675 if (ret > 0 && check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 {
6677 if (FD_ISSET(gpm_fd, &efds))
6678 gpm_close();
6679 else if (FD_ISSET(gpm_fd, &rfds))
6680 *check_for_gpm = 1;
6681 }
6682# endif
6683# ifdef USE_XSMP
6684 if (ret > 0 && xsmp_icefd != -1)
6685 {
6686 if (FD_ISSET(xsmp_icefd, &efds))
6687 {
6688 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006689 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 xsmp_close();
6691 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006692 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 }
6694 else if (FD_ISSET(xsmp_icefd, &rfds))
6695 {
6696 busy = TRUE;
6697 xsmp_handle_requests();
6698 busy = FALSE;
6699 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006700 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 }
6702 }
6703# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006704#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006705 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006706 if (ret >= 0)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01006707 (void)channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006708#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709
Bram Moolenaar0f873732019-12-05 20:28:46 +01006710#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711
6712#ifdef MAY_LOOP
6713 if (finished || msec == 0)
6714 break;
6715
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006716# ifdef FEAT_CLIENTSERVER
6717 if (server_waiting())
6718 break;
6719# endif
6720
Bram Moolenaar0f873732019-12-05 20:28:46 +01006721 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 if (msec > 0)
6723 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006724# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006725 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006726 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006728 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 msec = msec / 2;
6730# endif
6731 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006732 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 }
6734#endif
6735 }
6736
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006737 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738}
6739
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006741 * Expand a path into all matching files and/or directories. Handles "*",
6742 * "?", "[a-z]", "**", etc.
6743 * "path" has backslashes before chars that are not to be expanded.
6744 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 */
6746 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006747mch_expandpath(
6748 garray_T *gap,
6749 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006750 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751{
Bram Moolenaar02743632005-07-25 20:42:36 +00006752 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754
6755/*
6756 * mch_expand_wildcards() - this code does wild-card pattern matching using
6757 * the shell
6758 *
6759 * return OK for success, FAIL for error (you may lose some memory) and put
6760 * an error message in *file.
6761 *
6762 * num_pat is number of input patterns
6763 * pat is array of pointers to input patterns
6764 * num_file is pointer to number of matched file names
6765 * file is pointer to array of pointers to matched file names
6766 */
6767
6768#ifndef SEEK_SET
6769# define SEEK_SET 0
6770#endif
6771#ifndef SEEK_END
6772# define SEEK_END 2
6773#endif
6774
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006775#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006776
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006778mch_expand_wildcards(
6779 int num_pat,
6780 char_u **pat,
6781 int *num_file,
6782 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006783 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784{
6785 int i;
6786 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006787 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 char_u *p;
6789 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790
Bram Moolenaarc7247912008-01-13 12:54:11 +00006791 /*
6792 * This is the non-OS/2 implementation (really Unix).
6793 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 int j;
6795 char_u *tempname;
6796 char_u *command;
6797 FILE *fd;
6798 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006799#define STYLE_ECHO 0 // use "echo", the default
6800#define STYLE_GLOB 1 // use "glob", for csh
6801#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6802#define STYLE_PRINT 3 // use "print -N", for zsh
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006803#define STYLE_BT 4 // `cmd` expansion, execute the pattern directly
6804#define STYLE_GLOBSTAR 5 // use extended shell glob for bash (this uses extended
6805 // globbing functionality using globstar, needs bash > 4)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 int shell_style = STYLE_ECHO;
6807 int check_spaces;
6808 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006809 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006810 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006811 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006812 // vimglob() function with globstar setting enabled, only for bash >= 4.X
6813 static char *sh_globstar_opt = "[[ ${BASH_VERSINFO[0]} -ge 4 ]] && shopt -s globstar; ";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814
Bram Moolenaar0f873732019-12-05 20:28:46 +01006815 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 *file = NULL;
6817
6818 /*
6819 * If there are no wildcards, just copy the names to allocated memory.
6820 * Saves a lot of time, because we don't have to start a new shell.
6821 */
6822 if (!have_wildcard(num_pat, pat))
6823 return save_patterns(num_pat, pat, num_file, file);
6824
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006825# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006826 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006827 if (sandbox != 0 && check_secure())
6828 return FAIL;
6829# endif
6830
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 /*
6832 * Don't allow the use of backticks in secure and restricted mode.
6833 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006834 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 for (i = 0; i < num_pat; ++i)
6836 if (vim_strchr(pat[i], '`') != NULL
6837 && (check_restricted() || check_secure()))
6838 return FAIL;
6839
6840 /*
6841 * get a name for the temp file
6842 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006843 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006845 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 return FAIL;
6847 }
6848
6849 /*
6850 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006851 * file.
6852 * STYLE_BT: NL separated
6853 * If expanding `cmd` execute it directly.
6854 * STYLE_GLOB: NUL separated
6855 * If we use *csh, "glob" will work better than "echo".
6856 * STYLE_PRINT: NL or NUL separated
6857 * If we use *zsh, "print -N" will work better than "glob".
6858 * STYLE_VIMGLOB: NL separated
6859 * If we use *sh*, we define "vimglob()".
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006860 * STYLE_GLOBSTAR: NL separated
6861 * If we use *bash*, we define "vimglob() and enable globstar option".
Bram Moolenaarc7247912008-01-13 12:54:11 +00006862 * STYLE_ECHO: space separated.
6863 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 */
6865 if (num_pat == 1 && *pat[0] == '`'
6866 && (len = STRLEN(pat[0])) > 2
6867 && *(pat[0] + len - 1) == '`')
6868 shell_style = STYLE_BT;
6869 else if ((len = STRLEN(p_sh)) >= 3)
6870 {
6871 if (STRCMP(p_sh + len - 3, "csh") == 0)
6872 shell_style = STYLE_GLOB;
6873 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6874 shell_style = STYLE_PRINT;
6875 }
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006876 if (shell_style == STYLE_ECHO)
6877 {
6878 if (strstr((char *)gettail(p_sh), "bash") != NULL)
6879 shell_style = STYLE_GLOBSTAR;
6880 else if (strstr((char *)gettail(p_sh), "sh") != NULL)
6881 shell_style = STYLE_VIMGLOB;
6882 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883
Bram Moolenaar0f873732019-12-05 20:28:46 +01006884 // Compute the length of the command. We need 2 extra bytes: for the
6885 // optional '&' and for the NUL.
6886 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006888 if (shell_style == STYLE_VIMGLOB)
6889 len += STRLEN(sh_vimglob_func);
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006890 else if (shell_style == STYLE_GLOBSTAR)
6891 len += STRLEN(sh_vimglob_func)
6892 + STRLEN(sh_globstar_opt);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006893
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006894 for (i = 0; i < num_pat; ++i)
6895 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006896 // Count the length of the patterns in the same way as they are put in
6897 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006898#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006899 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006900#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006901 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006902 for (j = 0; pat[i][j] != NUL; ++j)
6903 {
6904 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006905 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006906 ++len;
6907 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006908#endif
6909 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 command = alloc(len);
6911 if (command == NULL)
6912 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006913 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 vim_free(tempname);
6915 return FAIL;
6916 }
6917
6918 /*
6919 * Build the shell command:
6920 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6921 * recognizes this).
6922 * - Add the shell command to print the expanded names.
6923 * - Add the temp file name.
6924 * - Add the file name patterns.
6925 */
6926 if (shell_style == STYLE_BT)
6927 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006928 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006929 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006930 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006932 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006933 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006935 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006937 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 *p = ' ';
6939 }
6940 STRCAT(command, ">");
6941 }
6942 else
6943 {
Christian Brabandt8b8d8292021-11-19 12:37:36 +00006944 STRCPY(command, "");
6945 if (shell_style == STYLE_GLOB)
6946 {
6947 // Assume the nonomatch option is valid only for csh like shells,
6948 // otherwise, this may set the positional parameters for the shell,
6949 // e.g. "$*".
6950 if (flags & EW_NOTFOUND)
6951 STRCAT(command, "set nonomatch; ");
6952 else
6953 STRCAT(command, "unset nonomatch; ");
6954 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 if (shell_style == STYLE_GLOB)
6956 STRCAT(command, "glob >");
6957 else if (shell_style == STYLE_PRINT)
6958 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006959 else if (shell_style == STYLE_VIMGLOB)
6960 STRCAT(command, sh_vimglob_func);
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006961 else if (shell_style == STYLE_GLOBSTAR)
6962 {
6963 STRCAT(command, sh_globstar_opt);
6964 STRCAT(command, sh_vimglob_func);
6965 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 else
6967 STRCAT(command, "echo >");
6968 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006969
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006971
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 if (shell_style != STYLE_BT)
6973 for (i = 0; i < num_pat; ++i)
6974 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006975 // When using system() always add extra quotes, because the shell
6976 // is started twice. Otherwise put a backslash before special
6977 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978#ifdef USE_SYSTEM
6979 STRCAT(command, " \"");
6980 STRCAT(command, pat[i]);
6981 STRCAT(command, "\"");
6982#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006983 int intick = FALSE;
6984
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 p = command + STRLEN(command);
6986 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006987 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006988 {
6989 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006990 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006991 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6992 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006993 // Remove a backslash, take char literally. But keep
6994 // backslash inside backticks, before a special character
6995 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006996 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006997 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6998 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006999 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00007000 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00007001 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02007002 else if (!intick
7003 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
7004 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007005 // Put a backslash before a special character, but not
7006 // when inside ``. And not for $var when EW_KEEPDOLLAR is
7007 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00007008 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00007009
Bram Moolenaar0f873732019-12-05 20:28:46 +01007010 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00007011 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00007012 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 *p = NUL;
7014#endif
7015 }
7016 if (flags & EW_SILENT)
7017 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01007018 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007019 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020
7021 /*
7022 * Using zsh -G: If a pattern has no matches, it is just deleted from
7023 * the argument list, otherwise zsh gives an error message and doesn't
7024 * expand any other pattern.
7025 */
7026 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007027 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028
7029 /*
7030 * If we use -f then shell variables set in .cshrc won't get expanded.
7031 * vi can do it, so we will too, but it is only necessary if there is a "$"
7032 * in one of the patterns, otherwise we can still use the fast option.
7033 */
7034 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01007035 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036
7037 /*
7038 * execute the shell command
7039 */
7040 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
7041
Bram Moolenaar0f873732019-12-05 20:28:46 +01007042 // When running in the background, give it some time to create the temp
7043 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01007044 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02007045 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046
Bram Moolenaar0f873732019-12-05 20:28:46 +01007047 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 show_shell_mess = TRUE;
7049 vim_free(command);
7050
Bram Moolenaar0f873732019-12-05 20:28:46 +01007051 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 {
7053 mch_remove(tempname);
7054 vim_free(tempname);
7055 /*
7056 * With interactive completion, the error message is not printed.
7057 * However with USE_SYSTEM, I don't know how to turn off error messages
7058 * from the shell, so screen may still get messed up -- webb.
7059 */
7060#ifndef USE_SYSTEM
7061 if (!(flags & EW_SILENT))
7062#endif
7063 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007064 redraw_later_clear(); // probably messed up screen
7065 msg_putchar('\n'); // clear bottom line quickly
7066 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067#ifdef USE_SYSTEM
7068 if (!(flags & EW_SILENT))
7069#endif
7070 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00007071 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01007072 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 }
7074 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007075 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
7076 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 if (shell_style == STYLE_BT)
7078 return FAIL;
7079 goto notfound;
7080 }
7081
7082 /*
7083 * read the names from the file into memory
7084 */
7085 fd = fopen((char *)tempname, READBIN);
7086 if (fd == NULL)
7087 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007088 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 if (!(flags & EW_SILENT))
7090 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00007091 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01007092 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 }
7094 vim_free(tempname);
7095 goto notfound;
7096 }
7097 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007098 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02007100 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007101 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02007102 buffer = NULL;
7103 else
7104 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 if (buffer == NULL)
7106 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007107 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 mch_remove(tempname);
7109 vim_free(tempname);
7110 fclose(fd);
7111 return FAIL;
7112 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02007113 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 i = fread((char *)buffer, 1, len, fd);
7115 fclose(fd);
7116 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00007117 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007119 // unexpected read error
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007120 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 vim_free(tempname);
7122 vim_free(buffer);
7123 return FAIL;
7124 }
7125 vim_free(tempname);
7126
Bram Moolenaar1eed5322019-02-26 17:03:54 +01007127# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01007128 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02007130 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
7132 *p++ = buffer[i];
7133 len = p - buffer;
7134# endif
7135
7136
Bram Moolenaar0f873732019-12-05 20:28:46 +01007137 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 if (shell_style == STYLE_ECHO)
7139 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007140 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007142 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 {
7144 while (*p != ' ' && *p != '\n')
7145 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007146 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 }
7148 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007149 // file names are separated with NL
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02007150 else if (shell_style == STYLE_BT ||
7151 shell_style == STYLE_VIMGLOB ||
7152 shell_style == STYLE_GLOBSTAR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007154 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007156 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 {
7158 while (*p != '\n' && *p != NUL)
7159 ++p;
7160 if (*p != NUL)
7161 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007162 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 }
7164 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007165 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 else
7167 {
7168 /*
7169 * Some versions of zsh use spaces instead of NULs to separate
7170 * results. Only do this when there is no NUL before the end of the
7171 * buffer, otherwise we would never be able to use file names with
7172 * embedded spaces when zsh does use NULs.
7173 * When we found a NUL once, we know zsh is OK, set did_find_nul and
7174 * don't check for spaces again.
7175 */
7176 check_spaces = FALSE;
7177 if (shell_style == STYLE_PRINT && !did_find_nul)
7178 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007179 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007180 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01007181 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 did_find_nul = TRUE;
7183 else
7184 check_spaces = TRUE;
7185 }
7186
7187 /*
7188 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
7189 * already is one, for STYLE_GLOB it needs to be added.
7190 */
7191 if (len && buffer[len - 1] == NUL)
7192 --len;
7193 else
7194 buffer[len] = NUL;
7195 i = 0;
7196 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007197 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 {
7199 ++i;
7200 *p = NUL;
7201 }
7202 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007203 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 }
7205 if (i == 0)
7206 {
7207 /*
7208 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
7209 * /bin/sh will happily expand it to nothing rather than returning an
7210 * error; and hey, it's good to check anyway -- webb.
7211 */
7212 vim_free(buffer);
7213 goto notfound;
7214 }
7215 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007216 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 if (*file == NULL)
7218 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007219 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 vim_free(buffer);
7221 return FAIL;
7222 }
7223
7224 /*
7225 * Isolate the individual file names.
7226 */
7227 p = buffer;
7228 for (i = 0; i < *num_file; ++i)
7229 {
7230 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007231 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00007232 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02007233 || shell_style == STYLE_VIMGLOB || shell_style == STYLE_GLOBSTAR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00007235 while (!(shell_style == STYLE_ECHO && *p == ' ')
7236 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007238 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 *p = NUL;
7240 else
7241 {
7242 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007243 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 }
7245 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007246 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007248 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007250 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 }
7252 }
7253
7254 /*
7255 * Move the file names to allocated memory.
7256 */
7257 for (j = 0, i = 0; i < *num_file; ++i)
7258 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007259 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
7261 continue;
7262
Bram Moolenaar0f873732019-12-05 20:28:46 +01007263 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 dir = (mch_isdir((*file)[i]));
7265 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
7266 continue;
7267
Bram Moolenaar0f873732019-12-05 20:28:46 +01007268 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01007269 if (!dir && (flags & EW_EXEC)
7270 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00007271 continue;
7272
Bram Moolenaar964b3742019-05-24 18:54:09 +02007273 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 if (p)
7275 {
7276 STRCPY(p, (*file)[i]);
7277 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007278 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 (*file)[j++] = p;
7280 }
7281 }
7282 vim_free(buffer);
7283 *num_file = j;
7284
Bram Moolenaar0f873732019-12-05 20:28:46 +01007285 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01007287 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 goto notfound;
7289 }
7290
7291 return OK;
7292
7293notfound:
7294 if (flags & EW_NOTFOUND)
7295 return save_patterns(num_pat, pat, num_file, file);
7296 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297}
7298
Bram Moolenaar0f873732019-12-05 20:28:46 +01007299#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007302save_patterns(
7303 int num_pat,
7304 char_u **pat,
7305 int *num_file,
7306 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307{
7308 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00007309 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007311 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 if (*file == NULL)
7313 return FAIL;
7314 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00007315 {
7316 s = vim_strsave(pat[i]);
7317 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007318 // Be compatible with expand_filename(): halve the number of
7319 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007320 backslash_halve(s);
7321 (*file)[i] = s;
7322 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 *num_file = num_pat;
7324 return OK;
7325}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327/*
7328 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7329 * expand.
7330 */
7331 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007332mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007334 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 if (*p == '\\' && p[1] != NUL)
7337 ++p;
7338 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 if (vim_strchr((char_u *)
7340#ifdef VMS
7341 "*?%"
7342#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344#endif
7345 , *p) != NULL)
7346 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 }
7348 return FALSE;
7349}
7350
7351/*
7352 * Return TRUE if the string "p" contains a wildcard.
7353 * Don't recognize '~' at the end as a wildcard.
7354 */
7355 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007356mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007358 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 if (*p == '\\' && p[1] != NUL)
7361 ++p;
7362 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 if (vim_strchr((char_u *)
7364#ifdef VMS
7365 "*?%$"
7366#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368#endif
7369 , *p) != NULL
7370 || (*p == '~' && p[1] != NUL))
7371 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 }
7373 return FALSE;
7374}
7375
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007377have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378{
7379 int i;
7380
7381 for (i = 0; i < num; i++)
7382 if (mch_has_wildcard(file[i]))
7383 return 1;
7384 return 0;
7385}
7386
7387 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007388have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389{
7390 int i;
7391
7392 for (i = 0; i < num; i++)
7393 if (vim_strchr(file[i], '$') != NULL)
7394 return TRUE;
7395 return FALSE;
7396}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007398#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399/*
7400 * Scaled-down version of rename(), which is missing in Xenix.
7401 * This version can only move regular files and will fail if the
7402 * destination exists.
7403 */
7404 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007405mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406{
7407 struct stat st;
7408
Bram Moolenaar0f873732019-12-05 20:28:46 +01007409 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007411 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007413 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 return 0;
7415 return -1;
7416}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007417#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007419#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007420# if defined(DYNAMIC_GPM) || defined(PROTO)
7421/*
7422 * Initialize Gpm's symbols for dynamic linking.
7423 * Must be called only if libgpm_hinst is NULL.
7424 */
7425 static int
7426load_libgpm(void)
7427{
7428 libgpm_hinst = dlopen("libgpm.so", RTLD_LAZY|RTLD_GLOBAL);
7429
7430 if (libgpm_hinst == NULL)
7431 {
7432 if (p_verbose > 0)
7433 smsg_attr(HL_ATTR(HLF_W),
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007434 _("Could not load gpm library: %s"), dlerror());
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007435 return FAIL;
7436 }
7437
7438 if (
7439 (dll_Gpm_Open = dlsym(libgpm_hinst, "Gpm_Open")) == NULL
7440 || (dll_Gpm_Close = dlsym(libgpm_hinst, "Gpm_Close")) == NULL
7441 || (dll_Gpm_GetEvent = dlsym(libgpm_hinst, "Gpm_GetEvent")) == NULL
7442 || (dll_gpm_flag = dlsym(libgpm_hinst, "gpm_flag")) == NULL
7443 || (dll_gpm_fd = dlsym(libgpm_hinst, "gpm_fd")) == NULL
7444 )
7445 {
7446 semsg(_(e_could_not_load_library_str_str), "gpm", dlerror());
7447 dlclose(libgpm_hinst);
7448 libgpm_hinst = NULL;
7449 dll_gpm_flag = NULL;
7450 dll_gpm_fd = NULL;
7451 return FAIL;
7452 }
7453 return OK;
7454}
7455
7456 int
7457gpm_available(void)
7458{
7459 return libgpm_hinst != NULL || load_libgpm() == OK;
7460}
7461# endif // DYNAMIC_GPM
7462
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463/*
7464 * Initializes connection with gpm (if it isn't already opened)
7465 * Return 1 if succeeded (or connection already opened), 0 if failed
7466 */
7467 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007468gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007470 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007472#ifdef DYNAMIC_GPM
7473 if (!gpm_available())
7474 return 0;
7475#endif
7476
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007477 if (gpm_flag)
7478 return 1; // already open
7479
7480 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7481 gpm_connect.defaultMask = ~GPM_HARD;
7482 // Default handling for mouse move
7483 gpm_connect.minMod = 0; // Handle any modifier keys
7484 gpm_connect.maxMod = 0xffff;
7485 if (Gpm_Open(&gpm_connect, 0) > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007487 // gpm library tries to handling TSTP causes
7488 // problems. Anyways, we close connection to Gpm whenever
7489 // we are going to suspend or starting an external process
7490 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007491# ifdef SIGTSTP
ichizok378447f2023-05-11 22:25:42 +01007492 mch_signal(SIGTSTP, restricted ? SIG_IGN : sig_tstp);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007493# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007494 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007496 if (gpm_fd == -2)
Julio Bcc59d622024-04-04 21:55:10 +02007497 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007498 Gpm_Close(); // We don't want to talk to xterm via gpm
Julio Bcc59d622024-04-04 21:55:10 +02007499
7500 // Gpm_Close fails to properly restore the WINCH and TSTP handlers,
7501 // leading to Vim ignoring resize signals. We have to re-initialize
7502 // these handlers again here.
7503# ifdef SIGWINCH
7504 mch_signal(SIGWINCH, sig_winch);
7505# endif
7506# ifdef SIGTSTP
7507 mch_signal(SIGTSTP, restricted ? SIG_IGN : sig_tstp);
7508# endif
7509 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007510 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511}
7512
7513/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007514 * Returns TRUE if the GPM mouse is enabled.
7515 */
7516 int
7517gpm_enabled(void)
7518{
7519 return gpm_flag && gpm_fd >= 0;
7520}
7521
7522/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 */
7525 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007526gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007528 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 Gpm_Close();
7530}
7531
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007532/*
7533 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007535 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 */
7537 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007538mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539{
7540 int button;
7541 static Gpm_Event gpm_event;
7542 char_u string[6];
7543 int_u vim_modifiers;
7544 int row,col;
7545 unsigned char buttons_mask;
7546 unsigned char gpm_modifiers;
7547 static unsigned char old_buttons = 0;
7548
7549 Gpm_GetEvent(&gpm_event);
7550
7551#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007552 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 if (hold_gui_events)
7554 return 0;
7555#endif
7556
7557 row = gpm_event.y - 1;
7558 col = gpm_event.x - 1;
7559
Bram Moolenaar0f873732019-12-05 20:28:46 +01007560 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 string[1] = 'M';
7562 string[2] = 'G';
7563 switch (GPM_BARE_EVENTS(gpm_event.type))
7564 {
7565 case GPM_DRAG:
7566 string[3] = MOUSE_DRAG;
7567 break;
7568 case GPM_DOWN:
7569 buttons_mask = gpm_event.buttons & ~old_buttons;
7570 old_buttons = gpm_event.buttons;
7571 switch (buttons_mask)
7572 {
7573 case GPM_B_LEFT:
7574 button = MOUSE_LEFT;
7575 break;
7576 case GPM_B_MIDDLE:
7577 button = MOUSE_MIDDLE;
7578 break;
7579 case GPM_B_RIGHT:
7580 button = MOUSE_RIGHT;
7581 break;
7582 default:
7583 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007584 // Don't know what to do. Can more than one button be
7585 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 }
7587 string[3] = (char_u)(button | 0x20);
7588 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7589 break;
7590 case GPM_UP:
7591 string[3] = MOUSE_RELEASE;
7592 old_buttons &= ~gpm_event.buttons;
7593 break;
7594 default:
7595 return 0;
7596 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007597 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 gpm_modifiers = gpm_event.modifiers;
7599 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007600 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7601 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7602 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7604 vim_modifiers |= MOUSE_SHIFT;
7605
7606 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7607 vim_modifiers |= MOUSE_CTRL;
7608 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7609 vim_modifiers |= MOUSE_ALT;
7610 string[3] |= vim_modifiers;
7611 string[4] = (char_u)(col + ' ' + 1);
7612 string[5] = (char_u)(row + ' ' + 1);
7613 add_to_input_buf(string, 6);
7614 return 6;
7615}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007616#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007618#ifdef FEAT_SYSMOUSE
7619/*
7620 * Initialize connection with sysmouse.
7621 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7622 * output, any sysmouse output than will be processed via sig_sysmouse().
7623 * Return OK if succeeded, FAIL if failed.
7624 */
7625 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007626sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007627{
7628 struct mouse_info mouse;
7629
7630 mouse.operation = MOUSE_MODE;
7631 mouse.u.mode.mode = 0;
7632 mouse.u.mode.signal = SIGUSR2;
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007633 if (ioctl(1, CONS_MOUSECTL, &mouse) == -1)
7634 return FAIL;
7635
ichizok378447f2023-05-11 22:25:42 +01007636 mch_signal(SIGUSR2, sig_sysmouse);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007637 mouse.operation = MOUSE_SHOW;
7638 ioctl(1, CONS_MOUSECTL, &mouse);
7639 return OK;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007640}
7641
7642/*
7643 * Stop processing SIGUSR2 signals, and also make sure that
7644 * virtual console do not send us any sysmouse related signal.
7645 */
7646 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007647sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007648{
7649 struct mouse_info mouse;
7650
ichizok378447f2023-05-11 22:25:42 +01007651 mch_signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007652 mouse.operation = MOUSE_MODE;
7653 mouse.u.mode.mode = 0;
7654 mouse.u.mode.signal = 0;
7655 ioctl(1, CONS_MOUSECTL, &mouse);
7656}
7657
7658/*
7659 * Gets info from sysmouse and adds special keys to input buf.
7660 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007661 static void
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007662sig_sysmouse SIGDEFARG(sigarg)
7663{
7664 struct mouse_info mouse;
7665 struct video_info video;
7666 char_u string[6];
7667 int row, col;
7668 int button;
7669 int buttons;
7670 static int oldbuttons = 0;
7671
7672#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007673 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007674 if (hold_gui_events)
7675 return;
7676#endif
7677
7678 mouse.operation = MOUSE_GETINFO;
7679 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7680 && ioctl(1, FBIO_MODEINFO, &video) != -1
7681 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7682 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7683 {
7684 row = mouse.u.data.y / video.vi_cheight;
7685 col = mouse.u.data.x / video.vi_cwidth;
7686 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007687 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007688 string[1] = 'M';
7689 string[2] = 'S';
7690 if (oldbuttons == buttons && buttons != 0)
7691 {
7692 button = MOUSE_DRAG;
7693 }
7694 else
7695 {
7696 switch (buttons)
7697 {
7698 case 0:
7699 button = MOUSE_RELEASE;
7700 break;
7701 case 1:
7702 button = MOUSE_LEFT;
7703 break;
7704 case 2:
7705 button = MOUSE_MIDDLE;
7706 break;
7707 case 4:
7708 button = MOUSE_RIGHT;
7709 break;
7710 default:
7711 return;
7712 }
7713 oldbuttons = buttons;
7714 }
7715 string[3] = (char_u)(button);
7716 string[4] = (char_u)(col + ' ' + 1);
7717 string[5] = (char_u)(row + ' ' + 1);
7718 add_to_input_buf(string, 6);
7719 }
7720 return;
7721}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007722#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007723
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007725typedef char_u * (*STRPROCSTR)(char_u *);
7726typedef char_u * (*INTPROCSTR)(int);
7727typedef int (*STRPROCINT)(char_u *);
7728typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729
7730/*
7731 * Call a DLL routine which takes either a string or int param
7732 * and returns an allocated string.
7733 */
7734 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007735mch_libcall(
7736 char_u *libname,
7737 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007738 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007739 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007740 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007741 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742{
7743# if defined(USE_DLOPEN)
7744 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007745 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746# else
7747 shl_t hinstLib;
7748# endif
7749 STRPROCSTR ProcAdd;
7750 INTPROCSTR ProcAddI;
7751 char_u *retval_str = NULL;
7752 int retval_int = 0;
7753 int success = FALSE;
7754
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007755 /*
7756 * Get a handle to the DLL module.
7757 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007759 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007760 (void)dlerror();
7761
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 hinstLib = dlopen((char *)libname, RTLD_LAZY
7763# ifdef RTLD_LOCAL
7764 | RTLD_LOCAL
7765# endif
7766 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007767 if (hinstLib == NULL)
7768 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007769 // "dlerr" must be used before dlclose()
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007770 dlerr = dlerror();
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007771 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007772 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007773 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774# else
7775 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7776# endif
7777
Bram Moolenaar0f873732019-12-05 20:28:46 +01007778 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 if (hinstLib != NULL)
7780 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007781# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 /*
7783 * Catch a crash when calling the library function. For example when
7784 * using a number where a string pointer is expected.
7785 */
7786 mch_startjmp();
7787 if (SETJMP(lc_jump_env) != 0)
7788 {
7789 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007790# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007791 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007792# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 mch_didjmp();
7794 }
7795 else
7796# endif
7797 {
7798 retval_str = NULL;
7799 retval_int = 0;
7800
7801 if (argstring != NULL)
7802 {
7803# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007804 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007805 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806# else
7807 if (shl_findsym(&hinstLib, (const char *)funcname,
7808 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7809 ProcAdd = NULL;
7810# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007811 if ((success = (ProcAdd != NULL
7812# if defined(USE_DLOPEN)
7813 && dlerr == NULL
7814# endif
7815 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 {
7817 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007818 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 else
7820 retval_str = (ProcAdd)(argstring);
7821 }
7822 }
7823 else
7824 {
7825# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007826 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007827 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828# else
7829 if (shl_findsym(&hinstLib, (const char *)funcname,
7830 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7831 ProcAddI = NULL;
7832# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007833 if ((success = (ProcAddI != NULL
7834# if defined(USE_DLOPEN)
7835 && dlerr == NULL
7836# endif
7837 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 {
7839 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007840 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 else
7842 retval_str = (ProcAddI)(argint);
7843 }
7844 }
7845
Bram Moolenaar0f873732019-12-05 20:28:46 +01007846 // Save the string before we free the library.
7847 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 if (string_result == NULL)
7849 *number_result = retval_int;
7850 else if (retval_str != NULL
7851 && retval_str != (char_u *)1
7852 && retval_str != (char_u *)-1)
7853 *string_result = vim_strsave(retval_str);
7854 }
7855
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007856# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 mch_endjmp();
7858# ifdef SIGHASARG
7859 if (lc_signal != 0)
7860 {
7861 int i;
7862
Bram Moolenaar0f873732019-12-05 20:28:46 +01007863 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 for (i = 0; signal_info[i].sig != -1; i++)
7865 if (lc_signal == signal_info[i].sig)
7866 break;
Bram Moolenaar50809a42023-05-20 16:39:07 +01007867 semsg(_(e_got_sig_str_in_libcall), signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 }
7869# endif
7870# endif
7871
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007873 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007874 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007875 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007876
Bram Moolenaar0f873732019-12-05 20:28:46 +01007877 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 (void)dlclose(hinstLib);
7879# else
7880 (void)shl_unload(hinstLib);
7881# endif
7882 }
7883
7884 if (!success)
7885 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007886 semsg(_(e_library_call_failed_for_str), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 return FAIL;
7888 }
7889
7890 return OK;
7891}
7892#endif
7893
7894#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007895static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896static int xterm_button;
7897
7898/*
7899 * Setup a dummy window for X selections in a terminal.
7900 */
7901 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007902setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903{
7904 int z = 0;
7905 char *strp = "";
7906 Widget AppShell;
7907
7908 if (!x_connect_to_server())
7909 return;
7910
7911 open_app_context();
7912 if (app_context != NULL && xterm_Shell == (Widget)0)
7913 {
Dominique Pellé4927bc72023-09-24 16:12:07 +02007914 int (*oldhandler)(Display*, XErrorEvent*);
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007915# if defined(USING_SETJMP)
Dominique Pellé4927bc72023-09-24 16:12:07 +02007916 int (*oldIOhandler)(Display*);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007917# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007918# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007919 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920
7921 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007922 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923# endif
7924
Bram Moolenaar0f873732019-12-05 20:28:46 +01007925 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 oldhandler = XSetErrorHandler(x_error_check);
7927
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007928# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007929 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7931 mch_startjmp();
7932 if (SETJMP(lc_jump_env) != 0)
7933 {
7934 mch_didjmp();
7935 xterm_dpy = NULL;
7936 }
7937 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007938# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 {
7940 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7941 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007942 if (xterm_dpy != NULL)
7943 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007944# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007946# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 }
7948
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007949# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007950 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007952# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007953 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 (void)XSetErrorHandler(oldhandler);
7955
7956 if (xterm_dpy == NULL)
7957 {
7958 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007959 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 return;
7961 }
7962
Bram Moolenaar0f873732019-12-05 20:28:46 +01007963 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 (void)XSetIOErrorHandler(x_IOerror_handler);
7965
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007966# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007968 {
7969 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007970 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007971 verbose_leave();
7972 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973# endif
7974
Bram Moolenaar0f873732019-12-05 20:28:46 +01007975 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7977 applicationShellWidgetClass, xterm_dpy,
7978 NULL);
7979 if (AppShell == (Widget)0)
7980 return;
7981 xterm_Shell = XtVaCreatePopupShell("VIM",
7982 topLevelShellWidgetClass, AppShell,
7983 XtNmappedWhenManaged, 0,
7984 XtNwidth, 1,
7985 XtNheight, 1,
7986 NULL);
7987 if (xterm_Shell == (Widget)0)
7988 return;
7989
7990 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007991 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992 if (x11_display == NULL)
7993 x11_display = xterm_dpy;
7994
7995 XtRealizeWidget(xterm_Shell);
7996 XSync(xterm_dpy, False);
7997 xterm_update();
7998 }
7999 if (xterm_Shell != (Widget)0)
8000 {
8001 clip_init(TRUE);
8002 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
8003 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01008004 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 if (test_x11_window(xterm_dpy) == FAIL)
8006 x11_window = 0;
8007 if (x11_window != 0)
8008 xterm_trace = 0;
8009 }
8010}
8011
8012 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008013start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014{
8015 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
8016 return;
8017 xterm_trace = 1;
8018 xterm_button = button;
8019 do_xterm_trace();
8020}
8021
8022
8023 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008024stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025{
8026 if (xterm_trace < 0)
8027 return;
8028 xterm_trace = 0;
8029}
8030
8031/*
8032 * Query the xterm pointer and generate mouse termcodes if necessary
8033 * return TRUE if dragging is active, else FALSE
8034 */
8035 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01008036do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037{
8038 Window root, child;
8039 int root_x, root_y;
8040 int win_x, win_y;
8041 int row, col;
8042 int_u mask_return;
8043 char_u buf[50];
8044 char_u *strp;
8045 long got_hints;
8046 static char_u *mouse_code;
8047 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
8048 static int prev_row = 0, prev_col = 0;
8049 static XSizeHints xterm_hints;
8050
8051 if (xterm_trace <= 0)
8052 return FALSE;
8053
8054 if (xterm_trace == 1)
8055 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008056 // Get the hints just before tracking starts. The font size might
8057 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00008058 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
8059 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 || xterm_hints.width_inc <= 1
8061 || xterm_hints.height_inc <= 1)
8062 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008063 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 return FALSE;
8065 }
8066
Bram Moolenaar0f873732019-12-05 20:28:46 +01008067 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 mouse_code = find_termcode(mouse_name);
8069 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02008070 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 xterm_trace = 2;
8072
Bram Moolenaar0f873732019-12-05 20:28:46 +01008073 // Find the offset of the chars, there might be a scrollbar on the
8074 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
8076 &win_x, &win_y, &mask_return);
8077 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
8078 - (xterm_hints.height_inc / 2);
8079 if (xterm_hints.y <= xterm_hints.height_inc / 2)
8080 xterm_hints.y = 2;
8081 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
8082 - (xterm_hints.width_inc / 2);
8083 if (xterm_hints.x <= xterm_hints.width_inc / 2)
8084 xterm_hints.x = 2;
8085 return TRUE;
8086 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02008087 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 {
8089 xterm_trace = 0;
8090 return FALSE;
8091 }
8092
8093 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
8094 &win_x, &win_y, &mask_return);
8095
8096 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
8097 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
8098 if (row == prev_row && col == prev_col)
8099 return TRUE;
8100
8101 STRCPY(buf, mouse_code);
8102 strp = buf + STRLEN(buf);
8103 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
8104 *strp++ = (char_u)(col + ' ' + 1);
8105 *strp++ = (char_u)(row + ' ' + 1);
8106 *strp = 0;
8107 add_to_input_buf(buf, STRLEN(buf));
8108
8109 prev_row = row;
8110 prev_col = col;
8111 return TRUE;
8112}
8113
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02008114# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115/*
8116 * Destroy the display, window and app_context. Required for GTK.
8117 */
8118 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008119clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120{
8121 if (xterm_Shell != (Widget)0)
8122 {
8123 XtDestroyWidget(xterm_Shell);
8124 xterm_Shell = (Widget)0;
8125 }
8126 if (xterm_dpy != NULL)
8127 {
Bram Moolenaare8208012008-06-20 09:59:25 +00008128# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008129 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00008131# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 if (x11_display == xterm_dpy)
8133 x11_display = NULL;
8134 xterm_dpy = NULL;
8135 }
Bram Moolenaare8208012008-06-20 09:59:25 +00008136# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 if (app_context != (XtAppContext)NULL)
8138 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008139 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 XtDestroyApplicationContext(app_context);
8141 app_context = (XtAppContext)NULL;
8142 }
Bram Moolenaare8208012008-06-20 09:59:25 +00008143# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144}
8145# endif
8146
8147/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01008148 * Catch up with GUI or X events.
8149 */
8150 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008151clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01008152{
8153# ifdef FEAT_GUI
8154 if (gui.in_use)
8155 gui_mch_update();
8156 else
8157# endif
8158 if (xterm_Shell != (Widget)0)
8159 xterm_update();
8160}
8161
8162/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 * Catch up with any queued X events. This may put keyboard input into the
8164 * input buffer, call resize call-backs, trigger timers etc. If there is
8165 * nothing in the X event queue (& no timers pending), then we return
8166 * immediately.
8167 */
8168 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008169xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170{
8171 XEvent event;
8172
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008173 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008175 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008177 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008178 break;
8179
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008180 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008181 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008182 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008183 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008184#ifdef FEAT_CLIENTSERVER
8185 {
8186 XPropertyEvent *e = (XPropertyEvent *)&event;
8187
8188 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008190 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008191 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008193 XtDispatchEvent(&event);
8194 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008195 else
8196 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008197 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008198 XtAppProcessEvent(app_context, mask);
8199 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 }
8201}
8202
8203 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008204clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205{
8206 if (xterm_Shell != (Widget)0)
8207 return clip_x11_own_selection(xterm_Shell, cbd);
8208 return FAIL;
8209}
8210
8211 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008212clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213{
8214 if (xterm_Shell != (Widget)0)
8215 clip_x11_lose_selection(xterm_Shell, cbd);
8216}
8217
8218 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008219clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220{
8221 if (xterm_Shell != (Widget)0)
8222 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
8223}
8224
8225 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008226clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227{
8228 clip_x11_set_selection(cbd);
8229}
8230#endif
8231
8232
8233#if defined(USE_XSMP) || defined(PROTO)
8234/*
8235 * Code for X Session Management Protocol.
8236 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237
8238# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239/*
8240 * This is our chance to ask the user if they want to save,
8241 * or abort the logout
8242 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008244xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245{
Bram Moolenaare1004402020-10-24 20:49:43 +02008246 int save_cmod_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 int cancel_shutdown = False;
8248
Bram Moolenaare1004402020-10-24 20:49:43 +02008249 save_cmod_flags = cmdmod.cmod_flags;
8250 cmdmod.cmod_flags |= CMOD_CONFIRM;
Bram Moolenaar027387f2016-01-02 22:25:52 +01008251 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01008252 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 cancel_shutdown = True;
Bram Moolenaare1004402020-10-24 20:49:43 +02008254 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar0f873732019-12-05 20:28:46 +01008255 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 out_flush();
8257
Bram Moolenaar0f873732019-12-05 20:28:46 +01008258 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 SmcInteractDone(smc_conn, cancel_shutdown);
8260
Bram Moolenaar0f873732019-12-05 20:28:46 +01008261 // Finish off
8262 // Only end save-yourself here if we're not cancelling shutdown;
8263 // we'll get a cancelled callback later in which we'll end it.
8264 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 if (!cancel_shutdown)
8266 {
8267 xsmp.save_yourself = False;
8268 SmcSaveYourselfDone(smc_conn, True);
8269 }
8270}
8271# endif
8272
8273/*
8274 * Callback that starts save-yourself.
8275 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008277xsmp_handle_save_yourself(
8278 SmcConn smc_conn,
8279 SmPointer client_data UNUSED,
8280 int save_type UNUSED,
8281 Bool shutdown,
8282 int interact_style UNUSED,
8283 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008285 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 if (xsmp.save_yourself)
8287 SmcSaveYourselfDone(smc_conn, True);
8288 xsmp.save_yourself = True;
8289 xsmp.shutdown = shutdown;
8290
Bram Moolenaar0f873732019-12-05 20:28:46 +01008291 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01008293 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294
8295 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008296 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297
8298# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008299 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008301 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 SmcInteractRequest(smc_conn, SmDialogError,
8303 xsmp_handle_interaction, client_data);
8304 else
8305# endif
8306 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008307 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 SmcSaveYourselfDone(smc_conn, True);
8309 xsmp.save_yourself = False;
8310 }
8311}
8312
8313
8314/*
8315 * Callback to warn us of imminent death.
8316 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008318xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319{
8320 xsmp_close();
8321
Bram Moolenaar0f873732019-12-05 20:28:46 +01008322 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 getout_preserve_modified(0);
8324}
8325
8326
8327/*
8328 * Callback to tell us that save-yourself has completed.
8329 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008331xsmp_save_complete(
8332 SmcConn smc_conn UNUSED,
8333 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334{
8335 xsmp.save_yourself = False;
8336}
8337
8338
8339/*
8340 * Callback to tell us that an instigated shutdown was cancelled
8341 * (maybe even by us)
8342 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008344xsmp_shutdown_cancelled(
8345 SmcConn smc_conn,
8346 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347{
8348 if (xsmp.save_yourself)
8349 SmcSaveYourselfDone(smc_conn, True);
8350 xsmp.save_yourself = False;
8351 xsmp.shutdown = False;
8352}
8353
8354
8355/*
8356 * Callback to tell us that a new ICE connection has been established.
8357 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008359xsmp_ice_connection(
8360 IceConn iceConn,
8361 IcePointer clientData UNUSED,
8362 Bool opening,
8363 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008365 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 if (opening)
8367 {
8368 xsmp_icefd = IceConnectionNumber(iceConn);
8369 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
8370 }
8371}
8372
8373
Bram Moolenaar0f873732019-12-05 20:28:46 +01008374// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 int
Bram Moolenaar05540972016-01-30 20:31:25 +01008376xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377{
8378 Bool rep;
8379
8380 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8381 == IceProcessMessagesIOError)
8382 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008383 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008385 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 xsmp_close();
8387 return FAIL;
8388 }
8389 else
8390 return OK;
8391}
8392
8393static int dummy;
8394
Bram Moolenaar0f873732019-12-05 20:28:46 +01008395// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 void
8397xsmp_init(void)
8398{
8399 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 SmcCallbacks smcallbacks;
8401#if 0
8402 SmPropValue smname;
8403 SmProp smnameprop;
8404 SmProp *smprops[1];
8405#endif
8406
8407 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008408 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409
8410 xsmp.save_yourself = xsmp.shutdown = False;
8411
Bram Moolenaar0f873732019-12-05 20:28:46 +01008412 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8414 smcallbacks.save_yourself.client_data = NULL;
8415 smcallbacks.die.callback = xsmp_die;
8416 smcallbacks.die.client_data = NULL;
8417 smcallbacks.save_complete.callback = xsmp_save_complete;
8418 smcallbacks.save_complete.client_data = NULL;
8419 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8420 smcallbacks.shutdown_cancelled.client_data = NULL;
8421
Bram Moolenaar0f873732019-12-05 20:28:46 +01008422 // Set up a watch on ICE connection creations. The "dummy" argument is
8423 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8425 {
8426 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008427 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 return;
8429 }
8430
Bram Moolenaar0f873732019-12-05 20:28:46 +01008431 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 xsmp.smcconn = SmcOpenConnection(
8433 NULL,
8434 NULL,
8435 SmProtoMajor,
8436 SmProtoMinor,
8437 SmcSaveYourselfProcMask | SmcDieProcMask
8438 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8439 &smcallbacks,
8440 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008441 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008442 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 errorstring);
8444 if (xsmp.smcconn == NULL)
8445 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008447 {
Bram Moolenaare1be1182020-10-24 13:30:51 +02008448 char errorreport[132];
8449
8450 // If the message is too long it might not be NUL terminated. Add
8451 // a NUL at the end to make sure we don't go over the end.
8452 errorstring[sizeof(errorstring) - 1] = NUL;
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008453 vim_snprintf(errorreport, sizeof(errorreport),
8454 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008455 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008456 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 return;
8458 }
8459 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8460
8461#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008462 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 smname.value = "vim";
8464 smname.length = 3;
8465 smnameprop.name = "SmProgram";
8466 smnameprop.type = "SmARRAY8";
8467 smnameprop.num_vals = 1;
8468 smnameprop.vals = &smname;
8469
8470 smprops[0] = &smnameprop;
8471 SmcSetProperties(xsmp.smcconn, 1, smprops);
8472#endif
8473}
8474
8475
Bram Moolenaar0f873732019-12-05 20:28:46 +01008476// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008478xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008480 if (xsmp_icefd == -1)
8481 return;
8482
8483 SmcCloseConnection(xsmp.smcconn, 0, NULL);
8484 if (xsmp.clientid != NULL)
8485 free(xsmp.clientid);
8486 xsmp.clientid = NULL;
8487 xsmp_icefd = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008489#endif // USE_XSMP
Paul Ollis65745772022-06-05 16:55:54 +01008490
8491#if defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar08210f82023-04-13 19:15:54 +01008492# if defined(PROF_NSEC) || defined(PROTO)
Paul Ollis65745772022-06-05 16:55:54 +01008493/*
8494 * Implement timeout with timer_create() and timer_settime().
8495 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008496static volatile sig_atomic_t timeout_flag = FALSE;
8497static timer_t timer_id;
8498static int timer_created = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008499
8500/*
8501 * Callback for when the timer expires.
8502 */
8503 static void
8504set_flag(union sigval _unused UNUSED)
8505{
8506 timeout_flag = TRUE;
8507}
8508
8509/*
8510 * Stop any active timeout.
8511 */
8512 void
8513stop_timeout(void)
8514{
8515 static struct itimerspec disarm = {{0, 0}, {0, 0}};
8516
8517 if (timer_created)
8518 {
8519 int ret = timer_settime(timer_id, 0, &disarm, NULL);
8520
8521 if (ret < 0)
8522 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8523 }
8524
8525 // Clear the current timeout flag; any previous timeout should be
8526 // considered _not_ triggered.
8527 timeout_flag = FALSE;
8528}
8529
8530/*
8531 * Start the timeout timer.
8532 *
8533 * The return value is a pointer to a flag that is initialised to FALSE. If the
8534 * timeout expires, the flag is set to TRUE. This will only return pointers to
8535 * static memory; i.e. any pointer returned by this function may always be
8536 * safely dereferenced.
8537 *
8538 * This function is not expected to fail, but if it does it will still return a
8539 * valid flag pointer; the flag will remain stuck as FALSE .
8540 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008541 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008542start_timeout(long msec)
8543{
8544 struct itimerspec interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008545 {0, 0}, // Do not repeat.
8546 {msec / 1000, (msec % 1000) * 1000000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008547 int ret;
8548
8549 // This is really the caller's responsibility, but let's make sure the
8550 // previous timer has been stopped.
8551 stop_timeout();
Paul Ollis65745772022-06-05 16:55:54 +01008552
8553 if (!timer_created)
8554 {
8555 struct sigevent action = {0};
8556
8557 action.sigev_notify = SIGEV_THREAD;
8558 action.sigev_notify_function = set_flag;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008559 ret = timer_create(CLOCK_MONOTONIC, &action, &timer_id);
8560 if (ret < 0)
Paul Ollis65745772022-06-05 16:55:54 +01008561 {
8562 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8563 return &timeout_flag;
8564 }
8565 timer_created = TRUE;
8566 }
8567
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00008568# ifdef FEAT_EVAL
Bram Moolenaar616592e2022-06-17 15:17:10 +01008569 ch_log(NULL, "setting timeout timer to %d sec %ld nsec",
8570 (int)interval.it_value.tv_sec, (long)interval.it_value.tv_nsec);
Bram Moolenaar509ce032022-06-20 11:23:01 +01008571# endif
Paul Ollis65745772022-06-05 16:55:54 +01008572 ret = timer_settime(timer_id, 0, &interval, NULL);
8573 if (ret < 0)
8574 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8575
8576 return &timeout_flag;
8577}
8578
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008579/*
8580 * To be used before fork/exec: delete any created timer.
8581 */
8582 void
8583delete_timer(void)
8584{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008585 if (!timer_created)
8586 return;
8587
8588 timer_delete(timer_id);
8589 timer_created = FALSE;
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008590}
8591
Bram Moolenaar08210f82023-04-13 19:15:54 +01008592# else // PROF_NSEC
Paul Ollis65745772022-06-05 16:55:54 +01008593
8594/*
8595 * Implement timeout with setitimer()
8596 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008597static struct sigaction prev_sigaction;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008598static volatile sig_atomic_t timeout_flag = FALSE;
8599static int timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008600static int timer_handler_active = FALSE;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008601static volatile sig_atomic_t alarm_pending = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008602
8603/*
8604 * Handle SIGALRM for a timeout.
8605 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01008606 static void
Paul Ollis65745772022-06-05 16:55:54 +01008607set_flag SIGDEFARG(sigarg)
8608{
8609 if (alarm_pending)
8610 alarm_pending = FALSE;
8611 else
8612 timeout_flag = TRUE;
8613}
8614
8615/*
8616 * Stop any active timeout.
8617 */
8618 void
8619stop_timeout(void)
8620{
8621 static struct itimerval disarm = {{0, 0}, {0, 0}};
8622 int ret;
8623
8624 if (timer_active)
8625 {
8626 timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008627 ret = setitimer(ITIMER_REAL, &disarm, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008628 if (ret < 0)
8629 // Should only get here as a result of coding errors.
8630 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8631 }
8632
8633 if (timer_handler_active)
8634 {
8635 timer_handler_active = FALSE;
8636 ret = sigaction(SIGALRM, &prev_sigaction, NULL);
8637 if (ret < 0)
8638 // Should only get here as a result of coding errors.
8639 semsg(_(e_could_not_reset_handler_for_timeout_str),
8640 strerror(errno));
8641 }
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008642 timeout_flag = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008643}
8644
8645/*
8646 * Start the timeout timer.
8647 *
8648 * The return value is a pointer to a flag that is initialised to FALSE. If the
8649 * timeout expires, the flag is set to TRUE. This will only return pointers to
8650 * static memory; i.e. any pointer returned by this function may always be
8651 * safely dereferenced.
8652 *
8653 * This function is not expected to fail, but if it does it will still return a
8654 * valid flag pointer; the flag will remain stuck as FALSE .
8655 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008656 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008657start_timeout(long msec)
8658{
8659 struct itimerval interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008660 {0, 0}, // Do not repeat.
8661 {msec / 1000, (msec % 1000) * 1000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008662 struct sigaction handle_alarm;
8663 int ret;
8664 sigset_t sigs;
8665 sigset_t saved_sigs;
8666
8667 // This is really the caller's responsibility, but let's make sure the
8668 // previous timer has been stopped.
8669 stop_timeout();
8670
8671 // There is a small chance that SIGALRM is pending and so the handler must
8672 // ignore it on the first call.
8673 alarm_pending = FALSE;
8674 ret = sigemptyset(&sigs);
8675 ret = ret == 0 ? sigaddset(&sigs, SIGALRM) : ret;
8676 ret = ret == 0 ? sigprocmask(SIG_BLOCK, &sigs, &saved_sigs) : ret;
8677 timeout_flag = FALSE;
8678 ret = ret == 0 ? sigpending(&sigs) : ret;
8679 if (ret == 0)
8680 {
8681 alarm_pending = sigismember(&sigs, SIGALRM);
Bram Moolenaar1f89abf2022-06-06 10:07:01 +01008682 ret = sigprocmask(SIG_SETMASK, &saved_sigs, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008683 }
8684 if (unlikely(ret != 0 || alarm_pending < 0))
8685 {
8686 // Just catching coding errors. Write an error message, but carry on.
8687 semsg(_(e_could_not_check_for_pending_sigalrm_str), strerror(errno));
8688 alarm_pending = FALSE;
8689 }
8690
8691 // Set up the alarm handler first.
8692 ret = sigemptyset(&handle_alarm.sa_mask);
8693 handle_alarm.sa_handler = set_flag;
8694 handle_alarm.sa_flags = 0;
8695 ret = ret == 0 ? sigaction(SIGALRM, &handle_alarm, &prev_sigaction) : ret;
8696 if (ret < 0)
8697 {
8698 // Should only get here as a result of coding errors.
8699 semsg(_(e_could_not_set_handler_for_timeout_str), strerror(errno));
8700 return &timeout_flag;
8701 }
8702 timer_handler_active = TRUE;
8703
8704 // Set up the interval timer once the alarm handler is in place.
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008705 ret = setitimer(ITIMER_REAL, &interval, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008706 if (ret < 0)
8707 {
8708 // Should only get here as a result of coding errors.
8709 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8710 stop_timeout();
8711 return &timeout_flag;
8712 }
8713
8714 timer_active = TRUE;
8715 return &timeout_flag;
8716}
Bram Moolenaar08210f82023-04-13 19:15:54 +01008717# endif // PROF_NSEC
Paul Ollis65745772022-06-05 16:55:54 +01008718#endif // FEAT_RELTIME