blob: 9356db0b75765dc1329d84ab98d6bd2ebca9f2e1 [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;
2323#else
Bram Moolenaar097148e2020-08-11 21:58:20 +02002324# 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;
2328# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329#endif
2330
2331 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002332 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 * than x11 calls, because the x11 calls don't always work
2334 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 if ((type || *T_TS != NUL) && title != NULL)
2336 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002337 if (oldtitle_outdated)
2338 {
2339 oldtitle_outdated = FALSE;
2340 VIM_CLEAR(oldtitle);
2341 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 if (oldtitle == NULL
2343#ifdef FEAT_GUI
2344 && !gui.in_use
2345#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002346 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 (void)get_x11_title(FALSE);
2348
Bram Moolenaar0f873732019-12-05 20:28:46 +01002349 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 term_settitle(title);
2351#ifdef FEAT_X11
2352 else
2353# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002354 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002356 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002358#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar097148e2020-08-11 21:58:20 +02002359 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 else
2361 gui_mch_settitle(title, icon);
2362#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002363 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 }
2365
2366 if ((type || *T_CIS != NUL) && icon != NULL)
2367 {
2368 if (oldicon == NULL
2369#ifdef FEAT_GUI
2370 && !gui.in_use
2371#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002372 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 get_x11_icon(FALSE);
2374
2375 if (*T_CIS != NUL)
2376 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002377 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002379 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 out_flush();
2381 }
2382#ifdef FEAT_X11
2383 else
2384# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002385 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002387 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388#endif
2389 did_set_icon = TRUE;
2390 }
2391 --recursive;
2392}
2393
2394/*
2395 * Restore the window/icon title.
2396 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002397 * SAVE_RESTORE_TITLE only restore title
2398 * SAVE_RESTORE_ICON only restore icon
2399 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 */
2401 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002402mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403{
Bram Moolenaardac13472019-09-16 21:06:21 +02002404 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002405
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002406 // Only restore the title or icon when it has been set.
2407 // When using "oldtitle" make a copy, it might be freed halfway.
2408 char_u *title = ((which & SAVE_RESTORE_TITLE) && unix_did_set_title)
2409 ? (oldtitle ? oldtitle : p_titleold) : NULL;
2410 char_u *tofree = NULL;
2411 if (title == oldtitle && oldtitle != NULL)
2412 {
2413 tofree = vim_strsave(title);
2414 if (tofree != NULL)
2415 title = tofree;
2416 }
2417 mch_settitle(title,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002418 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002419 vim_free(tofree);
Bram Moolenaar40385db2018-08-07 22:31:44 +02002420
Bram Moolenaare5c83282019-05-03 23:15:37 +02002421 if (do_push_pop)
2422 {
2423 // pop and push from/to the stack
2424 term_pop_title(which);
2425 term_push_title(which);
2426 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427}
2428
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429
2430/*
2431 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002432 * This matches "xterm.*", thus "xterm-256color", "xterm-kitty", etc.
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002433 * Do not consider "xterm-kitty" an xterm, it is not fully xterm compatible,
2434 * using the "xterm-kitty" terminfo entry should work better.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002435 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 */
2437 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002438vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439{
2440 if (name == NULL)
2441 return FALSE;
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002442 return ((STRNICMP(name, "xterm", 5) == 0
2443 && STRNICMP(name, "xterm-kitty", 11) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 || STRNICMP(name, "nxterm", 6) == 0
2445 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002446 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002448 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 || STRCMP(name, "builtin_xterm") == 0);
2450}
2451
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002452#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2453/*
2454 * Return TRUE if "name" appears to be that of a terminal
2455 * known to support the xterm-style mouse protocol.
2456 * Relies on term_is_xterm having been set to its correct value.
2457 */
2458 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002459use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002460{
2461 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002462 && (term_is_xterm
2463 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002464 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar48873ae2021-12-08 21:00:24 +00002465 || STRNICMP(name, "gnome", 5) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002466 || STRICMP(name, "st") == 0
2467 || STRNICMP(name, "st-", 3) == 0
2468 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002469}
2470#endif
2471
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472/*
2473 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2474 * Return 1 for "xterm".
2475 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002476 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002477 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 */
2479 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002480use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002482 if (ttym_flags == TTYM_SGR)
2483 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002484 if (ttym_flags == TTYM_URXVT)
2485 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 if (ttym_flags == TTYM_XTERM2)
2487 return 2;
2488 if (ttym_flags == TTYM_XTERM)
2489 return 1;
2490 return 0;
2491}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002493/*
2494 * Return TRUE if "name" is an iris-ansi terminal name.
2495 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002497vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498{
2499 if (name == NULL)
2500 return FALSE;
2501 return (STRNICMP(name, "iris-ansi", 9) == 0
2502 || STRCMP(name, "builtin_iris-ansi") == 0);
2503}
2504
Dominique Pellee764d1b2023-03-12 21:20:59 +00002505#if defined(VMS) || defined(PROTO)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002506/*
2507 * Return TRUE if "name" is a vt300-like terminal name.
2508 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002510vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511{
2512 if (name == NULL)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002513 return FALSE;
2514 // Actually all ANSI compatible terminals should be here.
2515 // Catch at least VT1xx - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002516 return ((STRNICMP(name, "vt", 2) == 0
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002517 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 || STRCMP(name, "builtin_vt320") == 0);
2519}
Dominique Pellee764d1b2023-03-12 21:20:59 +00002520#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521
2522/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 * Insert user name in s[len].
2524 * Return OK if a name found.
2525 */
2526 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002527mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528{
2529#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002530 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 return OK;
2532#else
2533 return mch_get_uname(getuid(), s, len);
2534#endif
2535}
2536
2537/*
2538 * Insert user name for "uid" in s[len].
2539 * Return OK if a name found.
2540 */
2541 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002542mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543{
2544#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2545 struct passwd *pw;
2546
2547 if ((pw = getpwuid(uid)) != NULL
2548 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2549 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002550 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 return OK;
2552 }
2553#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002554 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2555 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556}
2557
2558/*
2559 * Insert host name is s[len].
2560 */
2561
2562#ifdef HAVE_SYS_UTSNAME_H
2563 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002564mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565{
2566 struct utsname vutsname;
2567
2568 if (uname(&vutsname) < 0)
2569 *s = NUL;
2570 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002571 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002573#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574
2575# ifdef HAVE_SYS_SYSTEMINFO_H
2576# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2577# endif
2578
2579 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002580mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581{
2582# ifdef VAXC
2583 vaxc$gethostname((char *)s, len);
2584# else
2585 gethostname((char *)s, len);
2586# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002587 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002589#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590
2591/*
2592 * return process ID
2593 */
2594 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002595mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596{
2597 return (long)getpid();
2598}
2599
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002600/*
2601 * return TRUE if process "pid" is still running
2602 */
2603 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002604mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002605{
Bram Moolenaar44dea9d2021-06-23 21:13:20 +02002606 // If there is no error the process must be running.
2607 if (kill(pid, 0) == 0)
2608 return TRUE;
2609#ifdef ESRCH
2610 // If the error is ESRCH then the process is not running.
2611 if (errno == ESRCH)
2612 return FALSE;
2613#endif
2614 // If the process is running and owned by another user we get EPERM. With
2615 // other errors the process might be running, assuming it is then.
2616 return TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002617}
2618
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002621strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622{
2623 extern int sys_nerr;
2624 extern char *sys_errlist[];
2625 static char er[20];
2626
2627 if (err > 0 && err < sys_nerr)
2628 return (sys_errlist[err]);
2629 sprintf(er, "Error %d", err);
2630 return er;
2631}
2632#endif
2633
2634/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002635 * Get name of current directory into buffer "buf" of length "len" bytes.
2636 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 * Return OK for success, FAIL for failure.
2638 */
2639 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002640mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641{
2642#if defined(USE_GETCWD)
2643 if (getcwd((char *)buf, len) == NULL)
2644 {
2645 STRCPY(buf, strerror(errno));
2646 return FAIL;
2647 }
2648 return OK;
2649#else
2650 return (getwd((char *)buf) != NULL ? OK : FAIL);
2651#endif
2652}
2653
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002655 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 *
2657 * return FAIL for failure, OK for success
2658 */
2659 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002660mch_FullName(
2661 char_u *fname,
2662 char_u *buf,
2663 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002664 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665{
2666 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002667#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002669 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002670#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 char_u olddir[MAXPATHL];
2672 char_u *p;
2673 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002674#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002675 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2676 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002677#endif
2678
Bram Moolenaar38323e42007-03-06 19:22:53 +00002679#ifdef VMS
2680 fname = vms_fixfilename(fname);
2681#endif
2682
Bram Moolenaara2442432007-04-26 14:26:37 +00002683#ifdef __CYGWIN__
2684 /*
2685 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2686 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002687# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002688 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2689 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002690 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2691 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002692# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002693 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002694# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002695 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002696#endif
2697
Bram Moolenaar0f873732019-12-05 20:28:46 +01002698 // Expand it if forced or not an absolute path.
2699 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002700 if ((force || !mch_isFullName(fname))
2701 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 {
2703 /*
2704 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002705 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 * This will get the correct path name with "../" things.
2707 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002708 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 {
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002710 if (STRCMP(p, "/..") == 0)
2711 // for "/path/dir/.." include the "/.."
2712 p += 3;
2713
Bram Moolenaar38323e42007-03-06 19:22:53 +00002714#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 /*
2716 * Use fchdir() if possible, it's said to be faster and more
2717 * reliable. But on SunOS 4 it might not work. Check this by
2718 * doing a fchdir() right now.
2719 */
2720 if (!dont_fchdir)
2721 {
2722 fd = open(".", O_RDONLY | O_EXTRA, 0);
2723 if (fd >= 0 && fchdir(fd) < 0)
2724 {
2725 close(fd);
2726 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002727 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 }
2729 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002730#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
Bram Moolenaar0f873732019-12-05 20:28:46 +01002732 // Only change directory when we are sure we can return to where
2733 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002735#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002737#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 (mch_dirname(olddir, MAXPATHL) == FAIL
2739 || mch_chdir((char *)olddir) != 0))
2740 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002741 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 retval = FAIL;
2743 }
2744 else
2745 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002746 // The directory is copied into buf[], to be able to remove
2747 // the file name without changing it (could be a string in
2748 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 if (p - fname >= len)
2750 retval = FAIL;
2751 else
2752 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002753 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 if (mch_chdir((char *)buf))
Bram Moolenaarc6376c72021-10-03 19:29:48 +01002755 {
2756 // Path does not exist (yet). For a full path fail,
2757 // will use the path as-is. For a relative path use
2758 // the current directory and append the file name.
2759 if (mch_isFullName(fname))
2760 retval = FAIL;
2761 else
2762 p = NULL;
2763 }
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002764 else if (*p == '/')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 fname = p + 1;
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002766 else
2767 fname = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 *buf = NUL;
2769 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 }
2771 }
2772 if (mch_dirname(buf, len) == FAIL)
2773 {
2774 retval = FAIL;
2775 *buf = NUL;
2776 }
2777 if (p != NULL)
2778 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002779#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 if (fd >= 0)
2781 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002782 if (p_verbose >= 5)
2783 {
2784 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002785 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002786 verbose_leave();
2787 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 l = fchdir(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 }
2790 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002791#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 l = mch_chdir((char *)olddir);
2793 if (l != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002794 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 }
itchyny051a40c2021-10-20 10:00:05 +01002796#ifdef HAVE_FCHDIR
2797 if (fd >= 0)
2798 close(fd);
2799#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
2801 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002802 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002803 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002804#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002805 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002807 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002808#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002810
Bram Moolenaar0f873732019-12-05 20:28:46 +01002811 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002812 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 return FAIL;
2814
Bram Moolenaar0f873732019-12-05 20:28:46 +01002815 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 if (STRCMP(fname, ".") != 0)
2817 STRCAT(buf, fname);
2818
2819 return OK;
2820}
2821
2822/*
2823 * Return TRUE if "fname" does not depend on the current directory.
2824 */
2825 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002826mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002828#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 return ( fname[0] == '/' || fname[0] == '.' ||
2830 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2831 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2832 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002833#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835#endif
2836}
2837
Bram Moolenaar24552be2005-12-10 20:17:30 +00002838#if defined(USE_FNAME_CASE) || defined(PROTO)
2839/*
2840 * Set the case of the file name, if it already exists. This will cause the
2841 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002842 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002843 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002844 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002845fname_case(
2846 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002847 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002848{
2849 struct stat st;
2850 char_u *slash, *tail;
2851 DIR *dirp;
2852 struct dirent *dp;
2853
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002854 if (mch_lstat((char *)name, &st) < 0)
2855 return;
2856
2857 // Open the directory where the file is located.
2858 slash = vim_strrchr(name, '/');
2859 if (slash == NULL)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002860 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002861 dirp = opendir(".");
2862 tail = name;
2863 }
2864 else
2865 {
2866 *slash = NUL;
2867 dirp = opendir((char *)name);
2868 *slash = '/';
2869 tail = slash + 1;
2870 }
Bram Moolenaar24552be2005-12-10 20:17:30 +00002871
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002872 if (dirp == NULL)
2873 return;
2874
2875 while ((dp = readdir(dirp)) != NULL)
2876 {
2877 // Only accept names that differ in case and are the same byte
2878 // length. TODO: accept different length name.
2879 if (STRICMP(tail, dp->d_name) == 0
2880 && STRLEN(tail) == STRLEN(dp->d_name))
Bram Moolenaar24552be2005-12-10 20:17:30 +00002881 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002882 char_u newname[MAXPATHL + 1];
2883 struct stat st2;
2884
2885 // Verify the inode is equal.
2886 vim_strncpy(newname, name, MAXPATHL);
2887 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2888 MAXPATHL - (tail - name));
2889 if (mch_lstat((char *)newname, &st2) >= 0
2890 && st.st_ino == st2.st_ino
2891 && st.st_dev == st2.st_dev)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002892 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002893 STRCPY(tail, dp->d_name);
2894 break;
Bram Moolenaar24552be2005-12-10 20:17:30 +00002895 }
Bram Moolenaar24552be2005-12-10 20:17:30 +00002896 }
2897 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002898
2899 closedir(dirp);
Bram Moolenaar24552be2005-12-10 20:17:30 +00002900}
2901#endif
2902
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903/*
2904 * Get file permissions for 'name'.
2905 * Returns -1 when it doesn't exist.
2906 */
2907 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002908mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909{
2910 struct stat statb;
2911
Bram Moolenaar0f873732019-12-05 20:28:46 +01002912 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913#ifdef VMS
2914 if (stat((char *)vms_fixfilename(name), &statb))
2915#else
2916 if (stat((char *)name, &statb))
2917#endif
2918 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002919#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002920 // The top bit makes the value negative, which means the file doesn't
2921 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002922 return statb.st_mode & ~S_ADDACE;
2923#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002925#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926}
2927
2928/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002929 * Set file permission for "name" to "perm".
2930 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 */
2932 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002933mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934{
2935 return (chmod((char *)
2936#ifdef VMS
2937 vms_fixfilename(name),
2938#else
2939 name,
2940#endif
2941 (mode_t)perm) == 0 ? OK : FAIL);
2942}
2943
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002944#if defined(HAVE_FCHMOD) || defined(PROTO)
2945/*
2946 * Set file permission for open file "fd" to "perm".
2947 * Return FAIL for failure, OK otherwise.
2948 */
2949 int
2950mch_fsetperm(int fd, long perm)
2951{
2952 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2953}
2954#endif
2955
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956#if defined(HAVE_ACL) || defined(PROTO)
2957# ifdef HAVE_SYS_ACL_H
2958# include <sys/acl.h>
2959# endif
2960# ifdef HAVE_SYS_ACCESS_H
2961# include <sys/access.h>
2962# endif
2963
2964# ifdef HAVE_SOLARIS_ACL
2965typedef struct vim_acl_solaris_T {
2966 int acl_cnt;
2967 aclent_t *acl_entry;
2968} vim_acl_solaris_T;
2969# endif
2970
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002971#if defined(HAVE_SELINUX) || defined(PROTO)
2972/*
2973 * Copy security info from "from_file" to "to_file".
2974 */
2975 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002976mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002977{
2978 if (from_file == NULL)
2979 return;
2980
2981 if (selinux_enabled == -1)
2982 selinux_enabled = is_selinux_enabled();
2983
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002984 if (selinux_enabled <= 0)
2985 return;
2986
2987 // Use "char *" instead of "security_context_t" to avoid a deprecation
2988 // warning.
2989 char *from_context = NULL;
2990 char *to_context = NULL;
2991
2992 if (getfilecon((char *)from_file, &from_context) < 0)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002993 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002994 // If the filesystem doesn't support extended attributes,
2995 // the original had no special security context and the
2996 // target cannot have one either.
2997 if (errno == EOPNOTSUPP)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002998 return;
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002999
3000 msg_puts(_("\nCould not get security context for "));
3001 msg_outtrans(from_file);
3002 msg_putchar('\n');
3003 return;
3004 }
3005 if (getfilecon((char *)to_file, &to_context) < 0)
3006 {
3007 msg_puts(_("\nCould not get security context for "));
3008 msg_outtrans(to_file);
3009 msg_putchar('\n');
3010 freecon (from_context);
3011 return ;
3012 }
3013 if (strcmp(from_context, to_context) != 0)
3014 {
3015 if (setfilecon((char *)to_file, from_context) < 0)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003016 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003017 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003018 msg_outtrans(to_file);
3019 msg_putchar('\n');
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003020 }
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003021 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003022 freecon(to_context);
3023 freecon(from_context);
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003024}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003025#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00003026
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003027#if defined(HAVE_SMACK) && !defined(PROTO)
3028/*
3029 * Copy security info from "from_file" to "to_file".
3030 */
3031 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01003032mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003033{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02003034 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003035 {
3036 XATTR_NAME_SMACK,
3037 XATTR_NAME_SMACKEXEC,
3038 XATTR_NAME_SMACKMMAP
3039 };
3040
3041 char buffer[SMACK_LABEL_LEN];
3042 const char *name;
3043 int index;
3044 int ret;
3045 ssize_t size;
3046
3047 if (from_file == NULL)
3048 return;
3049
3050 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
3051 / sizeof(smack_copied_attributes)[0]) ; index++)
3052 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003053 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003054 name = smack_copied_attributes[index];
3055
Bram Moolenaar0f873732019-12-05 20:28:46 +01003056 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003057 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
3058 if (size >= 0)
3059 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003060 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003061 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
3062 if (ret < 0)
3063 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003064 vim_snprintf((char *)IObuff, IOSIZE,
3065 _("Could not set security context %s for %s"),
3066 name, to_file);
3067 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003068 msg_putchar('\n');
3069 }
3070 }
3071 else
3072 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003073 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003074 switch (errno)
3075 {
3076 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003077 // extended attributes aren't supported or enabled
3078 // should a message be echoed? not sure...
3079 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003080
3081 case ERANGE:
3082 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003083 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003084 vim_snprintf((char *)IObuff, IOSIZE,
3085 _("Could not get security context %s for %s. Removing it!"),
3086 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003087 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003088 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01003089 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003090
3091 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003092 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003093 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003094 // Silently ignore errors, apparently this happens when
3095 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003096 break;
3097 }
3098 }
3099 }
3100}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003101#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003102
Christian Brabandte085dfd2023-09-30 12:49:18 +02003103#ifdef FEAT_XATTR
3104/*
3105 * Copy extended attributes from_file to to_file
3106 */
3107 void
3108mch_copy_xattr(char_u *from_file, char_u *to_file)
3109{
3110 char *xattr_buf;
3111 size_t size;
3112 size_t tsize;
3113 ssize_t keylen, vallen, max_vallen = 0;
3114 char *key;
3115 char *val = NULL;
3116 char *errmsg = NULL;
3117
3118 if (from_file == NULL)
3119 return;
3120
3121 // get the length of the extended attributes
3122 size = listxattr((char *)from_file, NULL, 0);
3123 // not supported or no attributes to copy
3124 if (errno == ENOTSUP || size == 0)
3125 return;
3126 xattr_buf = (char*)alloc(size);
3127 if (xattr_buf == NULL)
3128 return;
3129 size = listxattr((char *)from_file, xattr_buf, size);
3130 tsize = size;
3131
3132 errno = 0;
3133
3134 for (int round = 0; round < 2; round++)
3135 {
3136
3137 key = xattr_buf;
3138 if (round == 1)
3139 size = tsize;
3140
3141 while (size > 0)
3142 {
3143 vallen = getxattr((char *)from_file, key,
3144 val, round ? max_vallen : 0);
3145 // only set the attribute in the second round
3146 if (vallen >= 0 && round &&
3147 setxattr((char *)to_file, key, val, vallen, 0) == 0)
3148 ;
3149 else if (errno)
3150 {
3151 switch (errno)
3152 {
3153 case E2BIG:
3154 errmsg = e_xattr_e2big;
3155 goto error_exit;
3156 case ENOTSUP:
3157 errmsg = e_xattr_enotsup;
3158 goto error_exit;
3159 case ERANGE:
3160 errmsg = e_xattr_erange;
3161 goto error_exit;
3162 default:
3163 errmsg = e_xattr_other;
3164 goto error_exit;
3165 }
3166 }
3167
3168 if (round == 0 && vallen > max_vallen)
3169 max_vallen = vallen;
3170
3171 // add one for terminating null
3172 keylen = STRLEN(key) + 1;
3173 size -= keylen;
3174 key += keylen;
3175 }
3176 if (round)
3177 break;
3178
3179 val = (char*)alloc(max_vallen + 1);
3180 if (val == NULL)
3181 goto error_exit;
3182
3183 }
3184error_exit:
3185 vim_free(xattr_buf);
3186 vim_free(val);
3187
3188 if (errmsg != NULL)
zeertzjq7ece0362023-10-01 09:07:14 +02003189 emsg(_(errmsg));
Christian Brabandte085dfd2023-09-30 12:49:18 +02003190}
3191#endif
3192
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193/*
3194 * Return a pointer to the ACL of file "fname" in allocated memory.
3195 * Return NULL if the ACL is not available for whatever reason.
3196 */
3197 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01003198mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199{
3200 vim_acl_T ret = NULL;
3201#ifdef HAVE_POSIX_ACL
3202 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
3203#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003204#ifdef HAVE_SOLARIS_ZFS_ACL
3205 acl_t *aclent;
3206
3207 if (acl_get((char *)fname, 0, &aclent) < 0)
3208 return NULL;
3209 ret = (vim_acl_T)aclent;
3210#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211#ifdef HAVE_SOLARIS_ACL
3212 vim_acl_solaris_T *aclent;
3213
3214 aclent = malloc(sizeof(vim_acl_solaris_T));
3215 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
3216 {
3217 free(aclent);
3218 return NULL;
3219 }
3220 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
3221 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
3222 {
3223 free(aclent->acl_entry);
3224 free(aclent);
3225 return NULL;
3226 }
3227 ret = (vim_acl_T)aclent;
3228#else
3229#if defined(HAVE_AIX_ACL)
3230 int aclsize;
3231 struct acl *aclent;
3232
3233 aclsize = sizeof(struct acl);
3234 aclent = malloc(aclsize);
3235 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3236 {
3237 if (errno == ENOSPC)
3238 {
3239 aclsize = aclent->acl_len;
3240 aclent = realloc(aclent, aclsize);
3241 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3242 {
3243 free(aclent);
3244 return NULL;
3245 }
3246 }
3247 else
3248 {
3249 free(aclent);
3250 return NULL;
3251 }
3252 }
3253 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003254#endif // HAVE_AIX_ACL
3255#endif // HAVE_SOLARIS_ACL
3256#endif // HAVE_SOLARIS_ZFS_ACL
3257#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 return ret;
3259}
3260
3261/*
3262 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3263 */
3264 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003265mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266{
3267 if (aclent == NULL)
3268 return;
3269#ifdef HAVE_POSIX_ACL
3270 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3271#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003272#ifdef HAVE_SOLARIS_ZFS_ACL
3273 acl_set((char *)fname, (acl_t *)aclent);
3274#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275#ifdef HAVE_SOLARIS_ACL
3276 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3277 ((vim_acl_solaris_T *)aclent)->acl_entry);
3278#else
3279#ifdef HAVE_AIX_ACL
3280 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003281#endif // HAVE_AIX_ACL
3282#endif // HAVE_SOLARIS_ACL
3283#endif // HAVE_SOLARIS_ZFS_ACL
3284#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285}
3286
3287 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003288mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289{
3290 if (aclent == NULL)
3291 return;
3292#ifdef HAVE_POSIX_ACL
3293 acl_free((acl_t)aclent);
3294#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003295#ifdef HAVE_SOLARIS_ZFS_ACL
3296 acl_free((acl_t *)aclent);
3297#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298#ifdef HAVE_SOLARIS_ACL
3299 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3300 free(aclent);
3301#else
3302#ifdef HAVE_AIX_ACL
3303 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003304#endif // HAVE_AIX_ACL
3305#endif // HAVE_SOLARIS_ACL
3306#endif // HAVE_SOLARIS_ZFS_ACL
3307#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308}
3309#endif
3310
3311/*
3312 * Set hidden flag for "name".
3313 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003315mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003317 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318}
3319
3320/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003321 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 * return FALSE if "name" is not a directory
3323 * return FALSE for error
3324 */
3325 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003326mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327{
3328 struct stat statb;
3329
Bram Moolenaar0f873732019-12-05 20:28:46 +01003330 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 return FALSE;
3332 if (stat((char *)name, &statb))
3333 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335}
3336
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003337/*
3338 * return TRUE if "name" is a directory, NOT a symlink to a directory
3339 * return FALSE if "name" is not a directory
3340 * return FALSE for error
3341 */
3342 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003343mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003344{
3345 struct stat statb;
3346
Bram Moolenaar0f873732019-12-05 20:28:46 +01003347 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003348 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003349 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003350 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003351 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003352}
3353
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354/*
3355 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3356 */
3357 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003358executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359{
3360 struct stat st;
3361
3362 if (stat((char *)name, &st))
3363 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003364#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003365 // Like on Unix system file can have executable rights but not necessarily
3366 // be an executable, but on Unix is not a default for an ordinary file to
3367 // have an executable flag - on VMS it is in most cases.
3368 // Therefore, this check does not have any sense - let keep us to the
3369 // conventions instead:
3370 // *.COM and *.EXE files are the executables - the rest are not. This is
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00003371 // not ideal but better than it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003372 int vms_executable = 0;
3373 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3374 {
3375 if (strstr(vms_tolower((char*)name),".exe") != NULL
3376 || strstr(vms_tolower((char*)name),".com")!= NULL)
3377 vms_executable = 1;
3378 }
3379 return vms_executable;
3380#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003382#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383}
3384
3385/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003386 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003387 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 * Return -1 if unknown.
3389 */
3390 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003391mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392{
3393 char_u *buf;
3394 char_u *p, *e;
3395 int retval;
3396
Bram Moolenaar0f873732019-12-05 20:28:46 +01003397 // When "use_path" is false and if it's an absolute or relative path don't
3398 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003399 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003400 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003401 // There must be a path separator, files in the current directory
3402 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003403 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003404 {
3405 if (path != NULL)
3406 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003407 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003408 *path = FullName_save(name, TRUE);
3409 else
3410 *path = vim_strsave(name);
3411 }
3412 return TRUE;
3413 }
3414 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003415 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416
3417 p = (char_u *)getenv("PATH");
3418 if (p == NULL || *p == NUL)
3419 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003420 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 if (buf == NULL)
3422 return -1;
3423
3424 /*
3425 * Walk through all entries in $PATH to check if "name" exists there and
3426 * is an executable file.
3427 */
3428 for (;;)
3429 {
3430 e = (char_u *)strchr((char *)p, ':');
3431 if (e == NULL)
3432 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003433 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 STRCPY(buf, "./");
3435 else
3436 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003437 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 add_pathsep(buf);
3439 }
3440 STRCAT(buf, name);
3441 retval = executable_file(buf);
3442 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003443 {
3444 if (path != NULL)
3445 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003446 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003447 *path = FullName_save(buf, TRUE);
3448 else
3449 *path = vim_strsave(buf);
3450 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003452 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453
3454 if (*e != ':')
3455 break;
3456 p = e + 1;
3457 }
3458
3459 vim_free(buf);
3460 return retval;
3461}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462
3463/*
3464 * Check what "name" is:
3465 * NODE_NORMAL: file or directory (or doesn't exist)
3466 * NODE_WRITABLE: writable device, socket, fifo, etc.
3467 * NODE_OTHER: non-writable things
3468 */
3469 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003470mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471{
3472 struct stat st;
3473
3474 if (stat((char *)name, &st))
3475 return NODE_NORMAL;
3476 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3477 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003478 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003480 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 return NODE_WRITABLE;
3482}
3483
3484 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003485mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486{
3487#ifdef HAVE_CHECK_STACK_GROWTH
3488 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 check_stack_growth((char *)&i);
3491
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003492# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 get_stack_limit();
3494# endif
3495
3496#endif
3497
3498 /*
3499 * Setup an alternative stack for signals. Helps to catch signals when
3500 * running out of stack space.
3501 * Use of sigaltstack() is preferred, it's more portable.
3502 * Ignore any errors.
3503 */
3504#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +02003505 signal_stack = alloc(get_signal_stack_size());
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 init_signal_stack();
3507#endif
3508}
3509
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003510#if defined(EXITFREE) || defined(PROTO)
3511 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003512mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003513{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003514# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3515 if (clip_star.owned)
3516 clip_lose_selection(&clip_star);
3517 if (clip_plus.owned)
3518 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003519# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003520# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003521 if (xterm_Shell != (Widget)0)
3522 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003523# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003524 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003525 if (xterm_dpy != NULL)
3526 XtCloseDisplay(xterm_dpy);
3527 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003528 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003529 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003530# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003531 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003532# endif
3533 }
3534# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003535# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003536# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003537 if (x11_display != NULL
3538# ifdef FEAT_XCLIPBOARD
3539 && x11_display != xterm_dpy
3540# endif
3541 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003542 XCloseDisplay(x11_display);
3543# endif
3544# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003545 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003546# endif
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003547 vim_free(oldtitle);
3548 vim_free(oldicon);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003549}
3550#endif
3551
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552/*
3553 * Output a newline when exiting.
3554 * Make sure the newline goes to the same stream as the text.
3555 */
3556 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003557exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003559 if (silent_mode)
3560 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 if (newline_on_exit || msg_didout)
3562 {
3563 if (msg_use_printf())
3564 {
3565 if (info_message)
3566 mch_msg("\n");
3567 else
3568 mch_errmsg("\r\n");
3569 }
3570 else
3571 out_char('\n');
3572 }
Bram Moolenaar7007e312021-03-27 12:11:33 +01003573 else if (!is_not_a_term())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003575 restore_cterm_colors(); // get original colors back
3576 msg_clr_eos_force(); // clear the rest of the display
3577 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 }
3579}
3580
Bram Moolenaarb4151682020-05-11 22:13:28 +02003581#ifdef USE_GCOV_FLUSH
ichizokdee78e12021-12-09 21:08:01 +00003582# if (defined(__GNUC__) \
3583 && ((__GNUC__ == 11 && __GNUC_MINOR__ >= 1) || (__GNUC__ >= 12))) \
3584 || (defined(__clang__) && (__clang_major__ >= 12))
3585extern void __gcov_dump(void);
3586extern void __gcov_reset(void);
3587# define __gcov_flush() do { __gcov_dump(); __gcov_reset(); } while (0)
3588# else
3589extern void __gcov_flush(void);
3590# endif
Bram Moolenaarb4151682020-05-11 22:13:28 +02003591#endif
3592
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003594mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595{
3596 exiting = TRUE;
3597
3598#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3599 x11_export_final_selection();
3600#endif
3601
3602#ifdef FEAT_GUI
3603 if (!gui.in_use)
3604#endif
3605 {
3606 settmode(TMODE_COOK);
Bram Moolenaar7007e312021-03-27 12:11:33 +01003607 if (!is_not_a_term())
3608 {
3609 // restore xterm title and icon name
3610 mch_restore_title(SAVE_RESTORE_BOTH);
3611 term_pop_title(SAVE_RESTORE_BOTH);
3612 }
Bram Moolenaar651fca82021-11-29 20:39:38 +00003613
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 /*
3615 * When t_ti is not empty but it doesn't cause swapping terminal
3616 * pages, need to output a newline when msg_didout is set. But when
3617 * t_ti does swap pages it should not go to the shell page. Do this
3618 * before stoptermcap().
3619 */
3620 if (swapping_screen() && !newline_on_exit)
3621 exit_scroll();
3622
Bram Moolenaar0f873732019-12-05 20:28:46 +01003623 // Stop termcap: May need to check for T_CRV response, which
3624 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 stoptermcap();
3626
3627 /*
3628 * A newline is only required after a message in the alternate screen.
3629 * This is set to TRUE by wait_return().
3630 */
3631 if (!swapping_screen() || newline_on_exit)
3632 exit_scroll();
3633
Bram Moolenaar0f873732019-12-05 20:28:46 +01003634 // Cursor may have been switched off without calling starttermcap()
3635 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 if (full_screen)
3637 cursor_on();
3638 }
3639 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003640 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003641
3642#ifdef USE_GCOV_FLUSH
3643 // Flush coverage info before possibly being killed by a deadly signal.
3644 __gcov_flush();
3645#endif
3646
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 may_core_dump();
3648#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 gui_exit(r);
3651#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003652
Bram Moolenaar56718732006-03-15 22:53:57 +00003653#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003654 mac_conv_cleanup();
3655#endif
3656
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003658 // A core dump won't be created if the signal handler
3659 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 if (deadly_signal != 0)
3661 return;
3662#endif
3663
Bram Moolenaar009b2592004-10-24 19:18:58 +00003664#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003665 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003666#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003667
3668#ifdef EXITFREE
3669 free_all_mem();
3670#endif
3671
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 exit(r);
3673}
3674
3675 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003676may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677{
3678 if (deadly_signal != 0)
3679 {
ichizok378447f2023-05-11 22:25:42 +01003680 mch_signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003681 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 }
3683}
3684
3685#ifndef VMS
3686
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003687/*
3688 * Get the file descriptor to use for tty operations.
3689 */
3690 static int
3691get_tty_fd(int fd)
3692{
3693 int tty_fd = fd;
3694
3695#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3696 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3697 // "fd" when it is a master device.
3698 if (mch_isatty(fd) > 1)
3699 {
3700 char *name;
3701
3702 name = ptsname(fd);
3703 if (name == NULL)
3704 return -1;
3705
3706 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3707 if (tty_fd < 0)
3708 return -1;
3709 }
3710#endif
3711 return tty_fd;
3712}
3713
3714 static int
3715mch_tcgetattr(int fd, void *term)
3716{
3717 int tty_fd;
3718 int retval = -1;
3719
3720 tty_fd = get_tty_fd(fd);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003721 if (tty_fd < 0)
3722 return -1;
3723
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003724#ifdef NEW_TTY_SYSTEM
3725# ifdef HAVE_TERMIOS_H
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003726 retval = tcgetattr(tty_fd, (struct termios *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003727# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003728 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003729# endif
3730#else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003731 // for "old" tty systems
3732 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003733#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003734 if (tty_fd != fd)
3735 close(tty_fd);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003736 return retval;
3737}
3738
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003740mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741{
3742 static int first = TRUE;
3743
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003744#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745# ifdef HAVE_TERMIOS_H
3746 static struct termios told;
3747 struct termios tnew;
3748# else
3749 static struct termio told;
3750 struct termio tnew;
3751# endif
3752
3753 if (first)
3754 {
3755 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003756 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 }
3758
3759 tnew = told;
3760 if (tmode == TMODE_RAW)
3761 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003762 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003763 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3764 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003766# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003767 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768# endif
3769 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003770# ifdef ONLCR
3771 // Don't map NL -> CR NL, we do it ourselves.
3772 // Also disable expanding tabs if possible.
3773# ifdef XTABS
3774 tnew.c_oflag &= ~(ONLCR | XTABS);
3775# else
3776# ifdef TAB3
3777 tnew.c_oflag &= ~(ONLCR | TAB3);
3778# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003780# endif
3781# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003783 tnew.c_cc[VMIN] = 1; // return after 1 char
3784 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 }
3786 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003787 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003788 // Also reset ICANON here, otherwise on Solaris select() won't see
3789 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003790 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003791 tnew.c_cc[VMIN] = 1; // return after 1 char
3792 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003793 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794
3795# if defined(HAVE_TERMIOS_H)
3796 {
3797 int n = 10;
3798
Bram Moolenaar0f873732019-12-05 20:28:46 +01003799 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3800 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3802 && errno == EINTR && n > 0)
3803 --n;
3804 }
3805# else
3806 ioctl(read_cmd_fd, TCSETA, &tnew);
3807# endif
3808
3809#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 /*
3811 * for "old" tty systems
3812 */
3813# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003814# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815# endif
3816 static struct sgttyb ttybold;
3817 struct sgttyb ttybnew;
3818
3819 if (first)
3820 {
3821 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003822 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 }
3824
3825 ttybnew = ttybold;
3826 if (tmode == TMODE_RAW)
3827 {
3828 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3829 ttybnew.sg_flags |= RAW;
3830 }
3831 else if (tmode == TMODE_SLEEP)
3832 ttybnew.sg_flags &= ~(ECHO);
3833 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3834#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003835 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836}
3837
3838/*
3839 * Try to get the code for "t_kb" from the stty setting
3840 *
3841 * Even if termcap claims a backspace key, the user's setting *should*
3842 * prevail. stty knows more about reality than termcap does, and if
3843 * somebody's usual erase key is DEL (which, for most BSD users, it will
3844 * be), they're going to get really annoyed if their erase key starts
3845 * doing forward deletes for no reason. (Eric Fischer)
3846 */
3847 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003848get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003850 ttyinfo_T info;
3851 char_u buf[2];
3852 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003854 if (get_tty_info(read_cmd_fd, &info) != OK)
3855 return;
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003856
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003857 intr_char = info.interrupt;
3858 buf[0] = info.backspace;
3859 buf[1] = NUL;
3860 add_termcode((char_u *)"kb", buf, FALSE);
3861
3862 // If <BS> and <DEL> are now the same, redefine <DEL>.
3863 p = find_termcode((char_u *)"kD");
3864 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3865 do_fixdel(NULL);
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003866}
3867
3868/*
3869 * Obtain the characters that Backspace and Enter produce on "fd".
3870 * Returns OK or FAIL.
3871 */
3872 int
3873get_tty_info(int fd, ttyinfo_T *info)
3874{
3875#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876# ifdef HAVE_TERMIOS_H
3877 struct termios keys;
3878# else
3879 struct termio keys;
3880# endif
3881
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003882 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003884 info->backspace = keys.c_cc[VERASE];
3885 info->interrupt = keys.c_cc[VINTR];
3886 if (keys.c_iflag & ICRNL)
3887 info->enter = NL;
3888 else
3889 info->enter = CAR;
3890 if (keys.c_oflag & ONLCR)
3891 info->nl_does_cr = TRUE;
3892 else
3893 info->nl_does_cr = FALSE;
3894 return OK;
3895 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003897 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 struct sgttyb keys;
3899
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003900 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003902 info->backspace = keys.sg_erase;
3903 info->interrupt = keys.sg_kill;
3904 info->enter = CAR;
3905 info->nl_does_cr = TRUE;
3906 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003909 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910}
3911
Bram Moolenaar0f873732019-12-05 20:28:46 +01003912#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003914static int mouse_ison = FALSE;
3915
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916/*
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003917 * Set mouse clicks on or off and possible enable mouse movement events.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 */
3919 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003920mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003922#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003923 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003924#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 int xterm_mouse_vers;
3926
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003927#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003928 if (!on)
3929 // Make sure not tracing mouse movements. Important when a button-down
3930 // was received but no release yet.
3931 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003932#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003933
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003934 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003935#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003936 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003937#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003938 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003939 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 return;
3941
3942 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003943
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003944#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003945 if (ttym_flags == TTYM_URXVT)
3946 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003947 out_str_nf((char_u *)(on ? "\033[?1015h" : "\033[?1015l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003948 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003949 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003950#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003951
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00003952 if (T_CXM != NULL && *T_CXM != NUL)
3953 {
3954 term_enable_mouse(on);
3955 }
3956 else if (ttym_flags == TTYM_SGR)
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003957 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003958 // SGR mode supports columns above 223
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003959 out_str_nf((char_u *)(on ? "\033[?1006h" : "\033[?1006l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003960 mouse_ison = on;
3961 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003962
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003963#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003964 if (bevalterm_ison != (p_bevalterm && on))
3965 {
3966 bevalterm_ison = (p_bevalterm && on);
3967 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003968 // disable mouse movement events, enabling is below
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003969 out_str_nf((char_u *)("\033[?1003l"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003970 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003971#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 if (xterm_mouse_vers > 0)
3974 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003975 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 out_str_nf((char_u *)
3977 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003978 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003979#ifdef FEAT_BEVAL_TERM
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003980 bevalterm_ison ? "\033[?1003h" :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003981#endif
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003982 "\033[?1002h")
3983 : "\033[?1000h"));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003984 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 out_str_nf((char_u *)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003986 (xterm_mouse_vers > 1 ? "\033[?1002l" : "\033[?1000l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003987 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 }
3989
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003990#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 else if (ttym_flags == TTYM_DEC)
3992 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003993 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003995 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003997 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003999#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004001#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 else
4003 {
4004 if (on)
4005 {
4006 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004007 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 }
4009 else
4010 {
4011 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004012 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 }
4014 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004015#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004017#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004018 else
4019 {
4020 if (on)
4021 {
4022 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004023 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004024 }
4025 else
4026 {
4027 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004028 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004029 }
4030 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004031#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004032
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004033#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 else
4035 {
4036 if (on)
4037 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004038 // D - Enable Mouse up/down messages
4039 // L - Enable Left Button Reporting
4040 // M - Enable Middle Button Reporting
4041 // R - Enable Right Button Reporting
4042 // K - Enable SHIFT and CTRL key Reporting
4043 // + - Enable Advanced messaging of mouse moves and up/down messages
4044 // Q - Quiet No Ack
4045 // # - Numeric value of mouse pointer required
4046 // 0 = Multiview 2000 cursor, used as standard
4047 // 1 = Windows Arrow
4048 // 2 = Windows I Beam
4049 // 3 = Windows Hour Glass
4050 // 4 = Windows Cross Hair
4051 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004052# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01004053 // Disables full feedback of pointer movements
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004054 out_str_nf((char_u *)"\033[0~ZwLMRK1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004055# else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004056 out_str_nf((char_u *)"\033[0~ZwLMRK+1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004057# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004058 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 }
4060 else
4061 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004062 out_str_nf((char_u *)"\033[0~ZwQ\033\\");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004063 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 }
4065 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004066#endif
4067#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 else
4069 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004070 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 if (on)
4072 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
4073 else
4074 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004075 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02004077#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078}
4079
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01004080#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004081/*
4082 * Called when 'balloonevalterm' changed.
4083 */
4084 void
4085mch_bevalterm_changed(void)
4086{
4087 mch_setmouse(mouse_ison);
4088}
4089#endif
4090
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091/*
4092 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
4093 */
4094 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004095check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096{
4097# ifdef FEAT_MOUSE_XTERM
4098 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02004099# ifdef FEAT_MOUSE_URXVT
4100 && use_xterm_mouse() != 3
4101# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102# ifdef FEAT_GUI
4103 && !gui.in_use
4104# endif
4105 )
4106 {
4107 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004108 ? "\233M" : "\033[M"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 if (*p_mouse != NUL)
4110 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004111 // force mouse off and maybe on to send possibly new mouse
4112 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 mch_setmouse(FALSE);
4114 setmouse();
4115 }
4116 }
4117 else
4118 del_mouse_termcode(KS_MOUSE);
4119# endif
4120
4121# ifdef FEAT_MOUSE_GPM
4122 if (!use_xterm_mouse()
4123# ifdef FEAT_GUI
4124 && !gui.in_use
4125# endif
4126 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004127 set_mouse_termcode(KS_GPM_MOUSE, (char_u *)"\033MG");
Bram Moolenaarbedf0912019-05-04 16:58:45 +02004128 else
4129 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130# endif
4131
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004132# ifdef FEAT_SYSMOUSE
4133 if (!use_xterm_mouse()
4134# ifdef FEAT_GUI
4135 && !gui.in_use
4136# endif
4137 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004138 set_mouse_termcode(KS_MOUSE, (char_u *)"\033MS");
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004139# endif
4140
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01004142 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 if (!use_xterm_mouse()
4144# ifdef FEAT_GUI
4145 && !gui.in_use
4146# endif
4147 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004148 set_mouse_termcode(KS_JSBTERM_MOUSE, (char_u *)"\033[0~zw");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 else
4150 del_mouse_termcode(KS_JSBTERM_MOUSE);
4151# endif
4152
4153# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01004154 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
4155 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 if (!use_xterm_mouse()
4157# ifdef FEAT_GUI
4158 && !gui.in_use
4159# endif
4160 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004161 set_mouse_termcode(KS_NETTERM_MOUSE, (char_u *)"\033}");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 else
4163 del_mouse_termcode(KS_NETTERM_MOUSE);
4164# endif
4165
4166# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01004167 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004168 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169# ifdef FEAT_GUI
4170 && !gui.in_use
4171# endif
4172 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004173 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004174 ? "\233" : "\033["));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 else
4176 del_mouse_termcode(KS_DEC_MOUSE);
4177# endif
4178# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01004179 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004180 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181# ifdef FEAT_GUI
4182 && !gui.in_use
4183# endif
4184 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004185 set_mouse_termcode(KS_PTERM_MOUSE, (char_u *)"\033[");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 else
4187 del_mouse_termcode(KS_PTERM_MOUSE);
4188# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02004189# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004190 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02004191# ifdef FEAT_GUI
4192 && !gui.in_use
4193# endif
4194 )
4195 {
4196 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004197 ? "\233*M" : "\033[*M"));
Bram Moolenaarc8427482011-10-20 21:09:35 +02004198
4199 if (*p_mouse != NUL)
4200 {
4201 mch_setmouse(FALSE);
4202 setmouse();
4203 }
4204 }
4205 else
4206 del_mouse_termcode(KS_URXVT_MOUSE);
4207# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004208 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004209# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004210 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004211# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004212 )
4213 {
4214 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004215 ? "\233<*M" : "\033[<*M"));
Bram Moolenaara529ce02017-06-22 22:37:57 +02004216
4217 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004218 ? "\233<*m" : "\033[<*m"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004219
4220 if (*p_mouse != NUL)
4221 {
4222 mch_setmouse(FALSE);
4223 setmouse();
4224 }
4225 }
4226 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02004227 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004228 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02004229 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
4230 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233#ifndef VMS
4234
4235/*
4236 * Try to get the current window size:
4237 * 1. with an ioctl(), most accurate method
4238 * 2. from the environment variables LINES and COLUMNS
4239 * 3. from the termcap
4240 * 4. keep using the old values
4241 * Return OK when size could be determined, FAIL otherwise.
4242 */
4243 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004244mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245{
4246 long rows = 0;
4247 long columns = 0;
4248 char_u *p;
4249
4250 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 * 1. try using an ioctl. It is the most accurate method.
4252 *
4253 * Try using TIOCGWINSZ first, some systems that have it also define
4254 * TIOCGSIZE but don't have a struct ttysize.
4255 */
4256# ifdef TIOCGWINSZ
4257 {
4258 struct winsize ws;
4259 int fd = 1;
4260
Bram Moolenaar0f873732019-12-05 20:28:46 +01004261 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 if (!isatty(fd) && isatty(read_cmd_fd))
4263 fd = read_cmd_fd;
4264 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4265 {
4266 columns = ws.ws_col;
4267 rows = ws.ws_row;
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004268# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004269 ch_log(NULL, "Got size with TIOCGWINSZ: %ld x %ld", columns, rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004270# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 }
4272 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004273# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274# ifdef TIOCGSIZE
4275 {
4276 struct ttysize ts;
4277 int fd = 1;
4278
Bram Moolenaar0f873732019-12-05 20:28:46 +01004279 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 if (!isatty(fd) && isatty(read_cmd_fd))
4281 fd = read_cmd_fd;
4282 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4283 {
4284 columns = ts.ts_cols;
4285 rows = ts.ts_lines;
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004286# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004287 ch_log(NULL, "Got size with TIOCGSIZE: %ld x %ld", columns, rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004288# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 }
4290 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004291# endif // TIOCGSIZE
4292# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293
4294 /*
4295 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004296 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4297 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004299 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 {
4301 if ((p = (char_u *)getenv("LINES")))
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004302 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 rows = atoi((char *)p);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004304# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004305 ch_log(NULL, "Got 'lines' from $LINES: %ld", rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004306# endif
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004307 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 if ((p = (char_u *)getenv("COLUMNS")))
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004309 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 columns = atoi((char *)p);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004311# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004312 ch_log(NULL, "Got 'columns' from $COLUMNS: %ld", columns);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004313# endif
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004314 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 }
4316
4317#ifdef HAVE_TGETENT
4318 /*
4319 * 3. try reading "co" and "li" entries from termcap
4320 */
4321 if (columns == 0 || rows == 0)
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004322 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 getlinecol(&columns, &rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004324# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004325 ch_log(NULL, "Got size from termcap: %ld x %ld", columns, rows);
Bram Moolenaar545c8a52023-06-21 15:51:47 +01004326# endif
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004327 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328#endif
4329
4330 /*
4331 * 4. If everything fails, use the old values
4332 */
4333 if (columns <= 0 || rows <= 0)
4334 return FAIL;
4335
4336 Rows = rows;
4337 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004338 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 return OK;
4340}
4341
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004342#if defined(FEAT_TERMINAL) || defined(PROTO)
4343/*
4344 * Report the windows size "rows" and "cols" to tty "fd".
4345 */
4346 int
4347mch_report_winsize(int fd, int rows, int cols)
4348{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004349 int tty_fd;
4350 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004351
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004352 tty_fd = get_tty_fd(fd);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004353 if (tty_fd < 0)
4354 return FAIL;
4355
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004356# if defined(TIOCSWINSZ)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004357 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004358
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004359 ws.ws_col = cols;
4360 ws.ws_row = rows;
4361 ws.ws_xpixel = cols * 5;
4362 ws.ws_ypixel = rows * 10;
4363 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004364 ch_log(NULL, "ioctl(TIOCSWINSZ) %s", retval == 0 ? "success" : "failed");
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004365# elif defined(TIOCSSIZE)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004366 struct ttysize ts;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004367
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004368 ts.ts_cols = cols;
4369 ts.ts_lines = rows;
4370 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
Bram Moolenaar55f1b822023-06-21 13:42:48 +01004371 ch_log(NULL, "ioctl(TIOCSSIZE) %s", retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004372# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004373 if (tty_fd != fd)
4374 close(tty_fd);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004375 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004376}
4377#endif
4378
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379/*
4380 * Try to set the window size to Rows and Columns.
4381 */
4382 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004383mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384{
4385 if (*T_CWS)
4386 {
4387 /*
4388 * NOTE: if you get an error here that term_set_winsize() is
4389 * undefined, check the output of configure. It could probably not
4390 * find a ncurses, termcap or termlib library.
4391 */
4392 term_set_winsize((int)Rows, (int)Columns);
4393 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004394 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 }
4396}
4397
Bram Moolenaar0f873732019-12-05 20:28:46 +01004398#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399
4400/*
4401 * Rows and/or Columns has changed.
4402 */
4403 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004404mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004406 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407}
4408
Bram Moolenaar205b8862011-09-07 15:04:31 +02004409/*
4410 * Wait for process "child" to end.
4411 * Return "child" if it exited properly, <= 0 on error.
4412 */
4413 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004414wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004415{
4416 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004417 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004418
4419 while (wait_pid != child)
4420 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004421 // When compiled with Python threads are probably used, in which case
4422 // wait() sometimes hangs for no obvious reason. Use waitpid()
4423 // instead and loop (like the GUI). Also needed for other interfaces,
4424 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004425# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004426 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004427# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004428 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004429# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004430 if (wait_pid == 0)
4431 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004432 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004433 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004434 if (++delay_msec > 10)
4435 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004436 continue;
4437 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004438 if (wait_pid <= 0
4439# ifdef ECHILD
4440 && errno == ECHILD
4441# endif
4442 )
4443 break;
4444 }
4445 return wait_pid;
4446}
4447
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004448#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004449/*
4450 * Set the environment for a child process.
4451 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004452 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004453set_child_environment(
4454 long rows,
4455 long columns,
4456 char *term,
4457 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004458{
4459# ifdef HAVE_SETENV
4460 char envbuf[50];
4461# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004462 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004463 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004464 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004465 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004466 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004467# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004468 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004469# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004470# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004471 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004472# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004473# endif
4474
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004475# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004476 setenv("TERM", term, 1);
4477 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004478 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004479 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004480 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004481 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004482 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004483 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004484 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004485# ifdef FEAT_TERMINAL
4486 if (is_terminal)
4487 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004488 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004489 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4490 }
4491# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004492# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004493 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004494# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004495# else
4496 /*
4497 * Putenv does not copy the string, it has to remain valid.
4498 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004499 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004500 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004501 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4502 putenv(envbuf_Term);
4503 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004504 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004505 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4506 putenv(envbuf_Lines);
4507 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4508 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004509 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004510 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004511 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004512# ifdef FEAT_TERMINAL
4513 if (is_terminal)
4514 {
4515 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004516 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004517 putenv(envbuf_Version);
4518 }
4519# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004520# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004521 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4522 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4523 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004524# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004525# endif
4526}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004527
4528 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004529set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004530{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004531 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004532}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004533#endif
4534
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004535#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004536/*
4537 * Open a PTY, with FD for the master and slave side.
4538 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004539 * When successful both file descriptors are stored and the allocated pty name
4540 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004541 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004542 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004543open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004544{
4545 char *tty_name;
4546
Bram Moolenaar59386482019-02-10 22:43:46 +01004547 if (name1 != NULL)
4548 *name1 = NULL;
4549 if (name2 != NULL)
4550 *name2 = NULL;
4551
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004552 *pty_master_fd = mch_openpty(&tty_name); // open pty
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004553 if (*pty_master_fd < 0)
4554 return;
4555
4556 // Leaving out O_NOCTTY may lead to waitpid() always returning
4557 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4558 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004559#ifdef O_NOCTTY
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004560 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004561#else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004562 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004563#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004564 if (*pty_slave_fd < 0)
4565 {
4566 close(*pty_master_fd);
4567 *pty_master_fd = -1;
4568 }
4569 else
4570 {
4571 if (name1 != NULL)
4572 *name1 = vim_strsave((char_u *)tty_name);
4573 if (name2 != NULL)
4574 *name2 = vim_strsave((char_u *)tty_name);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004575 }
4576}
4577#endif
4578
Bram Moolenaarfae42832017-08-01 22:24:26 +02004579/*
4580 * Send SIGINT to a child process if "c" is an interrupt character.
4581 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004582 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004583may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4584{
4585# ifdef SIGINT
4586 if (c == Ctrl_C || c == intr_char)
4587 {
4588# ifdef HAVE_SETSID
4589 kill(-pid, SIGINT);
4590# else
4591 kill(0, SIGINT);
4592# endif
4593 if (wpid > 0)
4594 kill(wpid, SIGINT);
4595 }
4596# endif
4597}
4598
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004599#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004600
Bram Moolenaar0f873732019-12-05 20:28:46 +01004601/*
4602 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4603 * pointers, the last one is NULL.
4604 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4605 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004606 int
4607unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004608 char_u *cmd,
4609 char ***argvp,
4610 char_u **sh_tofree,
4611 char_u **shcf_tofree)
4612{
4613 char **argv = NULL;
4614 int argc;
4615
4616 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004617 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004618 return FAIL;
4619
4620 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4621 return FAIL;
4622 *argvp = argv;
4623
4624 if (cmd != NULL)
4625 {
4626 char_u *s;
4627 char_u *p;
4628
4629 if (extra_shell_arg != NULL)
4630 argv[argc++] = (char *)extra_shell_arg;
4631
Bram Moolenaar0f873732019-12-05 20:28:46 +01004632 // Break 'shellcmdflag' into white separated parts. This doesn't
4633 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004634 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004635 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004636 return FAIL;
4637 s = *shcf_tofree;
4638 p = p_shcf;
4639 while (*p != NUL)
4640 {
4641 argv[argc++] = (char *)s;
4642 while (*p && *p != ' ' && *p != TAB)
4643 *s++ = *p++;
4644 *s++ = NUL;
4645 p = skipwhite(p);
4646 }
4647
4648 argv[argc++] = (char *)cmd;
4649 }
4650 argv[argc] = NULL;
4651 return OK;
4652}
4653#endif
4654
4655#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4656/*
4657 * Use a terminal window to run a shell command in.
4658 */
4659 static int
4660mch_call_shell_terminal(
4661 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004662 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004663{
4664 jobopt_T opt;
4665 char **argv = NULL;
4666 char_u *tofree1 = NULL;
4667 char_u *tofree2 = NULL;
4668 int retval = -1;
4669 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004670 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004671 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004672 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004673
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004674 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004675 goto theend;
4676
4677 init_job_options(&opt);
4678 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4679 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004680 if (buf == NULL)
4681 goto theend;
4682
4683 job = term_getjob(buf->b_term);
4684 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004685
Bram Moolenaar0f873732019-12-05 20:28:46 +01004686 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004687 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00004688 if (curbuf == buf)
Bram Moolenaar13568252018-03-16 20:46:58 +01004689 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004690 // Only when managed to find a window for "buf",
4691 clear_oparg(&oa);
4692 while (term_use_loop())
Bram Moolenaar13568252018-03-16 20:46:58 +01004693 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004694 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4695 {
4696 // If terminal_loop() returns OK we got a key that is handled
4697 // in Normal model. We don't do redrawing anyway.
4698 if (terminal_loop(TRUE) == OK)
4699 normal_cmd(&oa, TRUE);
4700 }
4701 else
Bram Moolenaar13568252018-03-16 20:46:58 +01004702 normal_cmd(&oa, TRUE);
4703 }
Bram Moolenaare76062c2022-11-28 18:51:43 +00004704 retval = job->jv_exitval;
4705 ch_log(NULL, "system command finished");
4706
4707 job_unref(job);
4708
4709 // restore curwin/curbuf and a few other things
4710 aucmd_restbuf(&aco);
Bram Moolenaar13568252018-03-16 20:46:58 +01004711 }
Bram Moolenaar13568252018-03-16 20:46:58 +01004712
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01004713 // Only require pressing Enter when redrawing, to avoid that system() gets
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004714 // the hit-enter prompt even though it didn't output anything.
Bram Moolenaar79cdf022023-05-20 14:07:00 +01004715 if (RedrawingDisabled == 0)
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004716 wait_return(TRUE);
Bram Moolenaar13568252018-03-16 20:46:58 +01004717 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4718
4719theend:
4720 vim_free(argv);
4721 vim_free(tofree1);
4722 vim_free(tofree2);
4723 return retval;
4724}
4725#endif
4726
4727#ifdef USE_SYSTEM
4728/*
4729 * Use system() to start the shell: simple but slow.
4730 */
4731 static int
4732mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004733 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004734 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735{
4736#ifdef VMS
4737 char *ifn = NULL;
4738 char *ofn = NULL;
4739#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004740 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004741 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004742 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743
4744 out_flush();
4745
4746 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004747 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748
Bram Moolenaar62b42182010-09-21 22:09:37 +02004749# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004750 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004751 loose_clipboard();
4752# endif
4753
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 if (cmd == NULL)
4755 x = system((char *)p_sh);
4756 else
4757 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004758# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 if (ofn = strchr((char *)cmd, '>'))
4760 *ofn++ = '\0';
4761 if (ifn = strchr((char *)cmd, '<'))
4762 {
4763 char *p;
4764
4765 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004766 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 if (p)
4768 *p = '\0';
4769 }
4770 if (ofn)
4771 x = vms_sys((char *)cmd, ofn, ifn);
4772 else
4773 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004774# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004775 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004777 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 if (newcmd == NULL)
4779 x = 0;
4780 else
4781 {
4782 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4783 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4784 (char *)p_shcf,
4785 (char *)cmd);
4786 x = system((char *)newcmd);
4787 vim_free(newcmd);
4788 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004789# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 }
4791# ifdef VMS
4792 x = vms_sys_status(x);
4793# endif
4794 if (emsg_silent)
4795 ;
4796 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004797 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 else if (x && !(options & SHELL_SILENT))
4799 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004800 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 msg_outnum((long)x);
4802 msg_putchar('\n');
4803 }
4804
4805 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004806 {
4807 // The shell may have messed with the mode, always set it.
4808 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004809 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004810 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 resettitle();
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004812# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4813 restore_clipboard();
4814# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004816}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817
Bram Moolenaar0f873732019-12-05 20:28:46 +01004818#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
Bram Moolenaar0f873732019-12-05 20:28:46 +01004820# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4821 // 127, some shells use that already
4822# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823
Bram Moolenaar13568252018-03-16 20:46:58 +01004824/*
4825 * Don't use system(), use fork()/exec().
4826 */
4827 static int
4828mch_call_shell_fork(
4829 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004830 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004831{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004832 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004834 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 pid_t wait_pid = 0;
4836# ifdef HAVE_UNION_WAIT
4837 union wait status;
4838# else
4839 int status = -1;
4840# endif
4841 int retval = -1;
4842 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004843 char_u *tofree1 = NULL;
4844 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004846 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004847# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004849# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004850 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 int fd_fromshell[2];
4852 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004853 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854
4855 out_flush();
4856 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004857 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004858 if (tmode == TMODE_RAW)
4859 // The shell may have messed with the mode, always set it later.
4860 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004862 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004863 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004864
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004866 * For the GUI, when writing the output into the buffer and when reading
4867 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4868 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004870 if ((options & (SHELL_READ|SHELL_WRITE))
4871# ifdef FEAT_GUI
4872 || (gui.in_use && show_shell_mess)
4873# endif
4874 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004876# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 /*
4878 * Try to open a master pty.
4879 * If this works, open the slave pty.
4880 * If the slave can't be opened, close the master pty.
4881 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004882 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004883 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 /*
4885 * If not opening a pty or it didn't work, try using pipes.
4886 */
4887 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004888# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 {
4890 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004891 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 {
4893 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004894 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 {
4896 close(fd_toshell[0]);
4897 close(fd_toshell[1]);
4898 }
4899 }
4900 if (pipe_error)
4901 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004902 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 out_flush();
4904 }
4905 }
4906 }
4907
Bram Moolenaar0f873732019-12-05 20:28:46 +01004908 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004910 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004911 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004912 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004913 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004915 UNBLOCK_SIGNALS(&curset);
4916
Bram Moolenaar32526b32019-01-19 17:43:09 +01004917 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004918 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004920 || (gui.in_use && show_shell_mess)
4921# endif
4922 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004924# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004925 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 {
4927 close(pty_master_fd);
4928 close(pty_slave_fd);
4929 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004930 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004931# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 {
4933 close(fd_toshell[0]);
4934 close(fd_toshell[1]);
4935 close(fd_fromshell[0]);
4936 close(fd_fromshell[1]);
4937 }
4938 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004940 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004942 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004943 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00004945# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01004946 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004947 {
4948 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004949 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004950 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004951# endif
4952
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 if (!show_shell_mess || (options & SHELL_EXPAND))
4954 {
4955 int fd;
4956
4957 /*
4958 * Don't want to show any message from the shell. Can't just
4959 * close stdout and stderr though, because some systems will
4960 * break if you try to write to them after that, so we must
4961 * use dup() to replace them with something else -- webb
4962 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4963 * waiting for input.
4964 */
4965 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4966 fclose(stdin);
4967 fclose(stdout);
4968 fclose(stderr);
4969
4970 /*
4971 * If any of these open()'s and dup()'s fail, we just continue
4972 * anyway. It's not fatal, and on most systems it will make
4973 * no difference at all. On a few it will cause the execvp()
4974 * to exit with a non-zero status even when the completion
4975 * could be done, which is nothing too serious. If the open()
4976 * or dup() failed we'd just do the same thing ourselves
4977 * anyway -- webb
4978 */
4979 if (fd >= 0)
4980 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004981 vim_ignored = dup(fd); // To replace stdin (fd 0)
4982 vim_ignored = dup(fd); // To replace stdout (fd 1)
4983 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984
Bram Moolenaar0f873732019-12-05 20:28:46 +01004985 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 close(fd);
4987 }
4988 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004989 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004991 || gui.in_use
4992# endif
4993 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 {
4995
Bram Moolenaardf177f62005-02-22 08:39:57 +00004996# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004997 // Create our own process group, so that the child and all its
4998 // children can be kill()ed. Don't do this when using pipes,
4999 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005000 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00005001 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005002 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00005003# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005004 // When doing "!xterm&" and 'shell' is bash: the shell
5005 // will exit and send SIGHUP to all processes in its
5006 // group, killing the just started process. Ignore SIGHUP
5007 // to avoid that. (suggested by Simon Schubert)
ichizok378447f2023-05-11 22:25:42 +01005008 mch_signal(SIGHUP, SIG_IGN);
Bram Moolenaar07256082009-02-04 13:19:42 +00005009# endif
5010 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005011# endif
5012# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005013 if (pty_slave_fd >= 0)
5014 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005015 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005016 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005017 setup_slavepty(pty_slave_fd);
Bram Moolenaarfff10d92021-10-13 10:05:30 +01005018# ifdef TIOCSCTTY
5019 // Try to become controlling tty (probably doesn't work,
5020 // unless run by root)
5021 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5022# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005023 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005024# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005025 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026
Bram Moolenaara5792f52005-11-23 21:25:05 +00005027 /*
5028 * stderr is only redirected when using the GUI, so that a
5029 * program like gpg can still access the terminal to get a
5030 * passphrase using stderr.
5031 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005032# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 if (pty_master_fd >= 0)
5034 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005035 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
Bram Moolenaar0f873732019-12-05 20:28:46 +01005037 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005039 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005041 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00005042 if (gui.in_use)
5043 {
5044 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005045 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00005046 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047
Bram Moolenaar0f873732019-12-05 20:28:46 +01005048 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 }
5050 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00005051# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005053 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 close(fd_toshell[1]);
5055 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005056 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 close(fd_toshell[0]);
5058
Bram Moolenaar0f873732019-12-05 20:28:46 +01005059 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 close(fd_fromshell[0]);
5061 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005062 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 close(fd_fromshell[1]);
5064
Bram Moolenaara5792f52005-11-23 21:25:05 +00005065# ifdef FEAT_GUI
5066 if (gui.in_use)
5067 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005068 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00005069 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02005070 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00005071 }
5072# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 }
5074 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005075
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 /*
5077 * There is no type cast for the argv, because the type may be
5078 * different on different machines. This may cause a warning
5079 * message with strict compilers, don't worry about it.
5080 * Call _exit() instead of exit() to avoid closing the connection
5081 * to the X server (esp. with GTK, which uses atexit()).
5082 */
5083 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005084 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005086 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 {
5088 /*
5089 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005090 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 */
5092 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005093 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005094 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005095# ifdef FEAT_JOB_CHANNEL
5096 ++dont_check_job_ended;
5097# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 /*
5099 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005100 * This is also used to pipe stdin/stdout to/from the external
5101 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005103 if ((options & (SHELL_READ|SHELL_WRITE))
5104# ifdef FEAT_GUI
5105 || (gui.in_use && show_shell_mess)
5106# endif
5107 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005109# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01005111 int buffer_off = 0; // valid bytes in buffer[]
5112 char_u ta_buf[BUFLEN + 1]; // TypeAHead
5113 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 int len;
5115 int p_more_save;
5116 int old_State;
5117 int c;
5118 int toshell_fd;
5119 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005120 garray_T ga;
5121 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01005122# ifdef ELAPSED_FUNC
5123 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005124# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125
Bram Moolenaardf177f62005-02-22 08:39:57 +00005126# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 if (pty_master_fd >= 0)
5128 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 fromshell_fd = pty_master_fd;
5130 toshell_fd = dup(pty_master_fd);
5131 }
5132 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00005133# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 {
5135 close(fd_toshell[0]);
5136 close(fd_fromshell[1]);
5137 toshell_fd = fd_toshell[1];
5138 fromshell_fd = fd_fromshell[0];
5139 }
5140
5141 /*
5142 * Write to the child if there are typed characters.
5143 * Read from the child if there are characters available.
5144 * Repeat the reading a few times if more characters are
5145 * available. Need to check for typed keys now and then, but
5146 * not too often (delays when no chars are available).
5147 * This loop is quit if no characters can be read from the pty
5148 * (WaitForChar detected special condition), or there are no
5149 * characters available and the child has exited.
5150 * Only check if the child has exited when there is no more
5151 * output. The child may exit before all the output has
5152 * been printed.
5153 *
5154 * Currently this busy loops!
5155 * This can probably dead-lock when the write blocks!
5156 */
5157 p_more_save = p_more;
5158 p_more = FALSE;
5159 old_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01005160 State = MODE_EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005162 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005163 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005164 // Fork a process that will write the lines to the
5165 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005166 if ((wpid = fork()) == -1)
5167 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005168 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005169 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005170 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00005171 {
5172 linenr_T lnum = curbuf->b_op_start.lnum;
5173 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00005174 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005175 size_t l;
5176
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00005177 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005178 for (;;)
5179 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00005180 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005181 if (l == 0)
5182 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00005183 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005184 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00005185 len = write(toshell_fd, "", (size_t)1);
5186 else
5187 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01005188 char_u *s = vim_strchr(lp + written, NL);
5189
Bram Moolenaar89d40322006-08-29 15:30:07 +00005190 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00005191 s == NULL ? l
5192 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005193 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00005194 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005195 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005196 // Finished a line, add a NL, unless this line
5197 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005198 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005199 || (!curbuf->b_p_bin
5200 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005201 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaar88456cd2022-11-18 22:14:09 +00005202 && (lnum != curbuf->b_ml.ml_line_count
Bram Moolenaardf177f62005-02-22 08:39:57 +00005203 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02005204 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005205 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005206 ++lnum;
5207 if (lnum > curbuf->b_op_end.lnum)
5208 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005209 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00005210 close(toshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005211 break;
5212 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00005213 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005214 written = 0;
5215 }
5216 else if (len > 0)
5217 written += len;
5218 }
5219 _exit(0);
5220 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005221 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00005222 {
5223 close(toshell_fd);
5224 toshell_fd = -1;
5225 }
5226 }
5227
5228 if (options & SHELL_READ)
5229 ga_init2(&ga, 1, BUFLEN);
5230
5231 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005232# ifdef ELAPSED_FUNC
5233 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005234# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 for (;;)
5236 {
5237 /*
5238 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005239 * if there are any.
5240 * Don't do this if we are expanding wild cards (would eat
5241 * typeahead).
5242 * Don't do this when filtering and terminal is in cooked
5243 * mode, the shell command will handle the I/O. Avoids
5244 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005245 * Don't get characters when the child has already
5246 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00005247 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005248 * while (noread_cnt > 4), avoids that ":r !ls" eats
5249 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 */
5251 len = 0;
5252 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005253 && ((options &
5254 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5255 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005256# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005257 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005258# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005259 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005260 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005261 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005263 if (ta_len == 0)
5264 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005265 // Get extra characters when we don't have any.
5266 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005267 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005268# ifdef ELAPSED_FUNC
5269 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005270# endif
5271 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5272 }
5273 if (ta_len > 0 || len > 0)
5274 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 /*
5276 * For pipes:
5277 * Check for CTRL-C: send interrupt signal to child.
5278 * Check for CTRL-D: EOF, close pipe to child.
5279 */
5280 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5281 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 /*
5283 * Send SIGINT to the child's group or all
5284 * processes in our group.
5285 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005286 may_send_sigint(ta_buf[ta_len], pid, wpid);
5287
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 if (pty_master_fd < 0 && toshell_fd >= 0
5289 && ta_buf[ta_len] == Ctrl_D)
5290 {
5291 close(toshell_fd);
5292 toshell_fd = -1;
5293 }
5294 }
5295
Bram Moolenaar2f7e1b82022-10-04 13:17:31 +01005296 // Remove Vim-specific codes from the input.
5297 len = term_replace_keycodes(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298
5299 /*
5300 * For pipes: echo the typed characters.
5301 * For a pty this does not seem to work.
5302 */
5303 if (pty_master_fd < 0)
5304 {
5305 for (i = ta_len; i < ta_len + len; ++i)
5306 {
5307 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5308 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 else if (has_mbyte)
5310 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005311 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312
5313 msg_outtrans_len(ta_buf + i, l);
5314 i += l - 1;
5315 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 else
5317 msg_outtrans_len(ta_buf + i, 1);
5318 }
5319 windgoto(msg_row, msg_col);
5320 out_flush();
5321 }
5322
5323 ta_len += len;
5324
5325 /*
5326 * Write the characters to the child, unless EOF has
5327 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005328 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005329 * When writing buffer lines, drop the typed
5330 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005332 if (options & SHELL_WRITE)
5333 ta_len = 0;
5334 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 {
5336 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5337 if (len > 0)
5338 {
5339 ta_len -= len;
5340 mch_memmove(ta_buf, ta_buf + len, ta_len);
5341 }
5342 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005343 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 }
5345
Bram Moolenaardf177f62005-02-22 08:39:57 +00005346 if (got_int)
5347 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005348 // CTRL-C sends a signal to the child, we ignore it
5349 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005350# ifdef HAVE_SETSID
5351 kill(-pid, SIGINT);
5352# else
5353 kill(0, SIGINT);
5354# endif
5355 if (wpid > 0)
5356 kill(wpid, SIGINT);
5357 got_int = FALSE;
5358 }
5359
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 /*
5361 * Check if the child has any characters to be printed.
5362 * Read them and write them to our window. Repeat this as
5363 * long as there is something to do, avoid the 10ms wait
5364 * for mch_inchar(), or sending typeahead characters to
5365 * the external process.
5366 * TODO: This should handle escape sequences, compatible
5367 * to some terminal (vt52?).
5368 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005369 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005370 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005372 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005375 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005377
5378 noread_cnt = 0;
5379 if (options & SHELL_READ)
5380 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005381 // Do NUL -> NL translation, append NL separated
5382 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005383 for (i = 0; i < len; ++i)
5384 {
5385 if (buffer[i] == NL)
5386 append_ga_line(&ga);
5387 else if (buffer[i] == NUL)
5388 ga_append(&ga, NL);
5389 else
5390 ga_append(&ga, buffer[i]);
5391 }
5392 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005393 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 {
5395 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005396 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397
Bram Moolenaardf177f62005-02-22 08:39:57 +00005398 len += buffer_off;
5399 buffer[len] = NUL;
5400
Bram Moolenaar0f873732019-12-05 20:28:46 +01005401 // Check if the last character in buffer[] is
5402 // incomplete, keep these bytes for the next
5403 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 for (p = buffer; p < buffer + len; p += l)
5405 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005406 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005408 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 else if (MB_BYTE2LEN(*p) != l)
5410 break;
5411 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005412 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005414 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 if (len >= 12)
5416 ++p;
5417 else
5418 {
5419 buffer_off = len;
5420 continue;
5421 }
5422 }
5423 c = *p;
5424 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005425 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 if (p < buffer + len)
5427 {
5428 *p = c;
5429 buffer_off = (buffer + len) - p;
5430 mch_memmove(buffer, p, buffer_off);
5431 continue;
5432 }
5433 buffer_off = 0;
5434 }
5435 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 {
5437 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005438 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 }
5440
5441 windgoto(msg_row, msg_col);
5442 cursor_on();
5443 out_flush();
5444 if (got_int)
5445 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005446
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005447# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005448 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005449 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005450 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005451
Bram Moolenaar0f873732019-12-05 20:28:46 +01005452 // Avoid that we keep looping here without
5453 // checking for a CTRL-C for a long time. Don't
5454 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005455 if (msec > 2000)
5456 {
5457 noread_cnt = 5;
5458 break;
5459 }
5460 }
5461# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 }
5463
Bram Moolenaar0f873732019-12-05 20:28:46 +01005464 // If we already detected the child has finished, continue
5465 // reading output for a short while. Some text may be
5466 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005467 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005468 {
5469 if (noread_cnt < 5)
5470 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005471 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005472 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005473
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 /*
5475 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005476 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005478# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005479 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005480# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005482# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5484 || (wait_pid == pid && WIFEXITED(status)))
5485 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005486 // Don't break the loop yet, try reading more
5487 // characters from "fromshell_fd" first. When using
5488 // pipes there might still be something to read and
5489 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005492 else
5493 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005494
Bram Moolenaar95a51352013-03-21 22:53:50 +01005495# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005496 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005497 clip_update();
5498# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 }
5500finished:
5501 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005502 if (options & SHELL_READ)
5503 {
5504 if (ga.ga_len > 0)
5505 {
5506 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005507 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005508 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005509 }
5510 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005511 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005512 ga_clear(&ga);
5513 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 /*
5516 * Give all typeahead that wasn't used back to ui_inchar().
5517 */
5518 if (ta_len)
5519 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 State = old_State;
5521 if (toshell_fd >= 0)
5522 close(toshell_fd);
5523 close(fromshell_fd);
5524 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005525# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005526 else
5527 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005528 long delay_msec = 1;
5529
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005530 if (tmode == TMODE_RAW)
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005531 // Possibly disables modifyOtherKeys, so that the system
5532 // can recognize CTRL-C.
5533 out_str_t_TE();
Bram Moolenaar0981c872020-08-23 14:28:37 +02005534
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005535 /*
5536 * Similar to the loop above, but only handle X events, no
5537 * I/O.
5538 */
5539 for (;;)
5540 {
5541 if (got_int)
5542 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005543 // CTRL-C sends a signal to the child, we ignore it
5544 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005545# ifdef HAVE_SETSID
5546 kill(-pid, SIGINT);
5547# else
5548 kill(0, SIGINT);
5549# endif
5550 got_int = FALSE;
5551 }
5552# ifdef __NeXT__
5553 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5554# else
5555 wait_pid = waitpid(pid, &status, WNOHANG);
5556# endif
5557 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5558 || (wait_pid == pid && WIFEXITED(status)))
5559 {
5560 wait_pid = pid;
5561 break;
5562 }
5563
Bram Moolenaar0f873732019-12-05 20:28:46 +01005564 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005565 clip_update();
5566
Bram Moolenaar0f873732019-12-05 20:28:46 +01005567 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005568 // less time, gradually wait longer.
5569 mch_delay(delay_msec,
5570 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005571 if (++delay_msec > 10)
5572 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005573 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005574
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005575 if (tmode == TMODE_RAW)
5576 // possibly enables modifyOtherKeys again
Bram Moolenaar733a69b2022-12-01 12:03:47 +00005577 out_str_t_TI();
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005578 }
5579# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580
5581 /*
5582 * Wait until our child has exited.
5583 * Ignore wait() returning pids of other children and returning
5584 * because of some signal like SIGWINCH.
5585 * Don't wait if wait_pid was already set above, indicating the
5586 * child already exited.
5587 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005588 if (wait_pid != pid)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01005589 (void)wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590
Bram Moolenaar624891f2010-10-13 16:22:09 +02005591# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005592 // Close slave side of pty. Only do this after the child has
5593 // exited, otherwise the child may hang when it tries to write on
5594 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005595 if (pty_master_fd >= 0)
5596 close(pty_slave_fd);
5597# endif
5598
Bram Moolenaar0f873732019-12-05 20:28:46 +01005599 // Make sure the child that writes to the external program is
5600 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005601 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005602 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005603 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005604 wait4pid(wpid, NULL);
5605 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005606
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005607# ifdef FEAT_JOB_CHANNEL
5608 --dont_check_job_ended;
5609# endif
5610
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 /*
5612 * Set to raw mode right now, otherwise a CTRL-C after
5613 * catch_signals() will kill Vim.
5614 */
5615 if (tmode == TMODE_RAW)
5616 settmode(TMODE_RAW);
5617 did_settmode = TRUE;
5618 set_signals();
5619
5620 if (WIFEXITED(status))
5621 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005622 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005624 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 {
5626 if (retval == EXEC_FAILED)
5627 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005628 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 msg_outtrans(p_sh);
5630 msg_putchar('\n');
5631 }
5632 else if (!(options & SHELL_SILENT))
5633 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005634 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 msg_outnum((long)retval);
5636 msg_putchar('\n');
5637 }
5638 }
5639 }
5640 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005641 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 }
5643 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644
5645error:
5646 if (!did_settmode)
5647 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005648 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 resettitle();
Bram Moolenaar13568252018-03-16 20:46:58 +01005650 vim_free(argv);
5651 vim_free(tofree1);
5652 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653
5654 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005655}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005656#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005657
5658 int
5659mch_call_shell(
5660 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005661 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005662{
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005663#ifdef FEAT_EVAL
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005664 ch_log(NULL, "executing shell command: %s", cmd);
5665#endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005666#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
Bram Moolenaar524c8532022-09-27 15:48:20 +01005667 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL
5668 && (options & SHELL_SILENT) == 0)
Bram Moolenaar13568252018-03-16 20:46:58 +01005669 return mch_call_shell_terminal(cmd, options);
5670#endif
5671#ifdef USE_SYSTEM
5672 return mch_call_shell_system(cmd, options);
5673#else
5674 return mch_call_shell_fork(cmd, options);
5675#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676}
5677
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005678#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005679 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005680mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005681{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005682 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005683 int fd_in[2] = {-1, -1}; // for stdin
5684 int fd_out[2] = {-1, -1}; // for stdout
5685 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005686 int pty_master_fd = -1;
5687 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005688 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005689 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5690 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5691 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005692 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005693 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5694 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005695 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005696 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005697 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005698
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005699 if (use_out_for_err && use_null_for_out)
5700 use_null_for_err = TRUE;
5701
Bram Moolenaar0f873732019-12-05 20:28:46 +01005702 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005703 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005704
Bram Moolenaarb2412082017-08-20 18:09:14 +02005705 if (options->jo_pty
5706 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005707 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005708 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005709 open_pty(&pty_master_fd, &pty_slave_fd,
5710 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005711
Bram Moolenaar0f873732019-12-05 20:28:46 +01005712 // TODO: without the channel feature connect the child to /dev/null?
5713 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005714 if (use_file_for_in)
5715 {
5716 char_u *fname = options->jo_io_name[PART_IN];
5717
5718 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5719 if (fd_in[0] < 0)
5720 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005721 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005722 goto failed;
5723 }
5724 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005725 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005726 // When writing buffer lines to the input don't use the pty, so that
5727 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005728 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5729 && pipe(fd_in) < 0)
5730 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005731
5732 if (use_file_for_out)
5733 {
5734 char_u *fname = options->jo_io_name[PART_OUT];
5735
5736 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5737 if (fd_out[1] < 0)
5738 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005739 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005740 goto failed;
5741 }
5742 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005743 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005744 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005745
5746 if (use_file_for_err)
5747 {
5748 char_u *fname = options->jo_io_name[PART_ERR];
5749
5750 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5751 if (fd_err[1] < 0)
5752 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005753 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005754 goto failed;
5755 }
5756 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005757 else if (!use_out_for_err && !use_null_for_err
5758 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005759 goto failed;
5760
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005761 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5762 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005763 if (options->jo_set & JO_CHANNEL)
5764 {
5765 channel = options->jo_channel;
5766 if (channel != NULL)
5767 ++channel->ch_refcount;
5768 }
5769 else
5770 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005771 if (channel == NULL)
5772 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005773 if (job->jv_tty_out != NULL)
5774 ch_log(channel, "using pty %s on fd %d",
5775 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005776 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005777
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005778 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005779 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005780 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005781 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005782 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005783 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005784 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005785 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005786 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005787 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005788 int null_fd = -1;
5789 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005790
Bram Moolenaar0f873732019-12-05 20:28:46 +01005791 // child
5792 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005793 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005794
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005795# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01005796 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005797 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005798 ch_logfile((char_u *)"", (char_u *)"");
5799# endif
5800
Bram Moolenaar835dc632016-02-07 14:27:38 +01005801# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005802 // Create our own process group, so that the child and all its
5803 // children can be kill()ed. Don't do this when using pipes,
5804 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005805 (void)setsid();
5806# endif
5807
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005808# ifdef FEAT_TERMINAL
5809 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005810 {
5811 char *term = (char *)T_NAME;
5812
5813#ifdef FEAT_GUI
5814 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005815 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005816 term = getenv("TERM");
5817#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005818 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005819 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005820 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005821 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005822 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005823 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005824 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005825 else if (t_colors > 16)
5826 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005827 else
5828 term = "xterm";
5829 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005830 set_child_environment(
5831 (long)options->jo_term_rows,
5832 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005833 term,
5834 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005835 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005836 else
5837# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005838 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005839
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005840 if (options->jo_env != NULL)
5841 {
5842 dict_T *dict = options->jo_env;
5843 hashitem_T *hi;
5844 int todo = (int)dict->dv_hashtab.ht_used;
5845
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00005846 FOR_ALL_HASHTAB_ITEMS(&dict->dv_hashtab, hi, todo)
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005847 if (!HASHITEM_EMPTY(hi))
5848 {
5849 typval_T *item = &dict_lookup(hi)->di_tv;
5850
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00005851 vim_setenv(hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005852 --todo;
5853 }
5854 }
5855
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005856 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005857 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005858 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005859 if (null_fd < 0)
5860 {
5861 perror("opening /dev/null failed");
5862 _exit(OPEN_NULL_FAILED);
5863 }
5864 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005865
Bram Moolenaar223896d2017-08-02 22:33:28 +02005866 if (pty_slave_fd >= 0)
5867 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005868 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005869 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005870# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005871 // Try to become controlling tty (probably doesn't work,
5872 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005873 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5874# endif
5875 }
5876
Bram Moolenaar0f873732019-12-05 20:28:46 +01005877 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005878 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005879 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005880 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005881 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005882 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005883 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005884 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005885
Bram Moolenaar0f873732019-12-05 20:28:46 +01005886 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005887 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005888 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005889 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005890 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005891 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005892 }
5893 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005894 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005895 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005896 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005897 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005898 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005899
Bram Moolenaar0f873732019-12-05 20:28:46 +01005900 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005901 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005902 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005903 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005904 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005905 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005906 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005907 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005908
5909 if (fd_in[0] >= 0)
5910 close(fd_in[0]);
5911 if (fd_in[1] >= 0)
5912 close(fd_in[1]);
5913 if (fd_out[0] >= 0)
5914 close(fd_out[0]);
5915 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005916 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005917 if (fd_err[0] >= 0)
5918 close(fd_err[0]);
5919 if (fd_err[1] >= 0)
5920 close(fd_err[1]);
5921 if (pty_master_fd >= 0)
5922 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005923 close(pty_master_fd); // not used in the child
5924 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005925 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005926
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005927 if (null_fd >= 0)
5928 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005929
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005930 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5931 _exit(EXEC_FAILED);
5932
Bram Moolenaar0f873732019-12-05 20:28:46 +01005933 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005934 execvp(argv[0], argv);
5935
Bram Moolenaar4694a172016-04-21 14:05:23 +02005936 if (stderr_works)
5937 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005938# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005939 // calling free_all_mem() here causes problems. Ignore valgrind
5940 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005941# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005942 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005943 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005944
Bram Moolenaar0f873732019-12-05 20:28:46 +01005945 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005946 UNBLOCK_SIGNALS(&curset);
5947
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005948 job->jv_pid = pid;
5949 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005950 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005951
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005952 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005953 close(pty_slave_fd); // not used in the parent
5954 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005955 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005956 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005957 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005958 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005959 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005960 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005961 if (channel != NULL)
5962 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005963 int in_fd = INVALID_FD;
5964 int out_fd = INVALID_FD;
5965 int err_fd = INVALID_FD;
5966
5967 if (!(use_file_for_in || use_null_for_in))
5968 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5969
5970 if (!(use_file_for_out || use_null_for_out))
5971 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5972
5973 // When using pty_master_fd only set it for stdout, do not duplicate
5974 // it for stderr, it only needs to be read once.
5975 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5976 {
5977 if (fd_err[0] >= 0)
5978 err_fd = fd_err[0];
5979 else if (out_fd != pty_master_fd)
5980 err_fd = pty_master_fd;
5981 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005982
5983 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005984 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005985 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005986 else
5987 {
5988 if (fd_in[1] >= 0)
5989 close(fd_in[1]);
5990 if (fd_out[0] >= 0)
5991 close(fd_out[0]);
5992 if (fd_err[0] >= 0)
5993 close(fd_err[0]);
5994 if (pty_master_fd >= 0)
5995 close(pty_master_fd);
5996 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005997
Bram Moolenaar0f873732019-12-05 20:28:46 +01005998 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005999 return;
6000
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006001failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01006002 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006003 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006004 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01006005 if (fd_in[1] >= 0)
6006 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006007 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006008 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01006009 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006010 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006011 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006012 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01006013 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006014 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02006015 if (pty_master_fd >= 0)
6016 close(pty_master_fd);
6017 if (pty_slave_fd >= 0)
6018 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01006019}
6020
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006021 static char_u *
6022get_signal_name(int sig)
6023{
6024 int i;
6025 char_u numbuf[NUMBUFLEN];
6026
6027 if (sig == SIGKILL)
6028 return vim_strsave((char_u *)"kill");
6029
6030 for (i = 0; signal_info[i].sig != -1; i++)
6031 if (sig == signal_info[i].sig)
6032 return strlow_save((char_u *)signal_info[i].name);
6033
6034 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
6035 return vim_strsave(numbuf);
6036}
6037
Bram Moolenaar835dc632016-02-07 14:27:38 +01006038 char *
6039mch_job_status(job_T *job)
6040{
6041# ifdef HAVE_UNION_WAIT
6042 union wait status;
6043# else
6044 int status = -1;
6045# endif
6046 pid_t wait_pid = 0;
6047
6048# ifdef __NeXT__
6049 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
6050# else
6051 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
6052# endif
6053 if (wait_pid == -1)
6054 {
Bram Moolenaar5c6a3c92023-03-04 13:23:26 +00006055 int waitpid_errno = errno;
6056 if (waitpid_errno == ECHILD && mch_process_running(job->jv_pid))
6057 // The process is alive, but it was probably reparented (for
6058 // example by ptrace called by a debugger like lldb or gdb).
6059 // Note: This assumes that process IDs are not reused.
6060 return "run";
6061
Bram Moolenaar0f873732019-12-05 20:28:46 +01006062 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006063 if (job->jv_status < JOB_ENDED)
6064 ch_log(job->jv_channel, "Job no longer exists: %s",
Bram Moolenaar5c6a3c92023-03-04 13:23:26 +00006065 strerror(waitpid_errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02006066 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006067 }
6068 if (wait_pid == 0)
6069 return "run";
6070 if (WIFEXITED(status))
6071 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006072 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01006073 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006074 if (job->jv_status < JOB_ENDED)
6075 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02006076 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006077 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01006078 if (WIFSIGNALED(status))
6079 {
6080 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006081 job->jv_termsig = get_signal_name(WTERMSIG(status));
6082 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
6083 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
6084 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02006085 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006086 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01006087 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02006088
6089return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01006090 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02006091 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02006092 return "dead";
6093}
6094
6095 job_T *
6096mch_detect_ended_job(job_T *job_list)
6097{
6098# ifdef HAVE_UNION_WAIT
6099 union wait status;
6100# else
6101 int status = -1;
6102# endif
6103 pid_t wait_pid = 0;
6104 job_T *job;
6105
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01006106# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006107 // Do not do this when waiting for a shell command to finish, we would get
6108 // the exit value here (and discard it), the exit value obtained there
6109 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01006110 if (dont_check_job_ended > 0)
6111 return NULL;
6112# endif
6113
Bram Moolenaar97792de2016-10-15 18:36:49 +02006114# ifdef __NeXT__
6115 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
6116# else
6117 wait_pid = waitpid(-1, &status, WNOHANG);
6118# endif
6119 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006120 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02006121 return NULL;
6122 for (job = job_list; job != NULL; job = job->jv_next)
6123 {
6124 if (job->jv_pid == wait_pid)
6125 {
6126 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006127 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02006128 job->jv_exitval = WEXITSTATUS(status);
6129 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006130 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02006131 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01006132 job->jv_termsig = get_signal_name(WTERMSIG(status));
6133 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01006134 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02006135 {
6136 ch_log(job->jv_channel, "Job ended");
6137 job->jv_status = JOB_ENDED;
6138 }
6139 return job;
6140 }
6141 }
6142 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006143}
6144
Bram Moolenaar3a117e12016-10-30 21:57:52 +01006145/*
6146 * Send a (deadly) signal to "job".
6147 * Return FAIL if "how" is not a valid name.
6148 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01006149 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02006150mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01006151{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006152 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006153
Bram Moolenaar923d9262016-02-25 20:56:01 +01006154 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01006155 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01006156 else if (STRCMP(how, "hup") == 0)
6157 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006158 else if (STRCMP(how, "quit") == 0)
6159 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01006160 else if (STRCMP(how, "int") == 0)
6161 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01006162 else if (STRCMP(how, "kill") == 0)
6163 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02006164#ifdef SIGWINCH
6165 else if (STRCMP(how, "winch") == 0)
6166 sig = SIGWINCH;
6167#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01006168 else if (isdigit(*how))
6169 sig = atoi((char *)how);
6170 else
6171 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01006172
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01006173 // Never kill ourselves!
6174 if (job->jv_pid != 0)
6175 {
6176 // TODO: have an option to only kill the process, not the group?
6177 kill(-job->jv_pid, sig);
6178 kill(job->jv_pid, sig);
6179 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01006180
Bram Moolenaar835dc632016-02-07 14:27:38 +01006181 return OK;
6182}
Bram Moolenaar76467df2016-02-12 19:30:26 +01006183
6184/*
6185 * Clear the data related to "job".
6186 */
6187 void
6188mch_clear_job(job_T *job)
6189{
Bram Moolenaar0f873732019-12-05 20:28:46 +01006190 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01006191# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01006192 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01006193# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01006194 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01006195# endif
6196}
Bram Moolenaar835dc632016-02-07 14:27:38 +01006197#endif
6198
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006199#if defined(FEAT_TERMINAL) || defined(PROTO)
6200 int
6201mch_create_pty_channel(job_T *job, jobopt_T *options)
6202{
6203 int pty_master_fd = -1;
6204 int pty_slave_fd = -1;
6205 channel_T *channel;
6206
Bram Moolenaar59386482019-02-10 22:43:46 +01006207 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02006208 if (pty_master_fd < 0 || pty_slave_fd < 0)
6209 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006210 close(pty_slave_fd);
6211
6212 channel = add_channel();
6213 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006214 {
6215 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006216 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006217 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02006218 if (job->jv_tty_out != NULL)
6219 ch_log(channel, "using pty %s on fd %d",
6220 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006221 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006222 channel->ch_keep_open = TRUE;
6223
Bram Moolenaar0f873732019-12-05 20:28:46 +01006224 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
6225 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006226 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006227 channel_set_job(channel, job, options);
6228 return OK;
6229}
6230#endif
6231
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232/*
6233 * Check for CTRL-C typed by reading all available characters.
6234 * In cooked mode we should get SIGINT, no need to check.
6235 */
6236 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006237mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238{
Bram Moolenaar26e86442020-05-17 14:06:16 +02006239 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006240 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 fill_input_buf(FALSE);
6242}
6243
6244/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006245 * Wait "msec" msec until a character is available from the mouse, keyboard,
6246 * from inbuf[].
6247 * "msec" == -1 will block forever.
6248 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006249 * When "ignore_input" is TRUE even check for pending input when input is
6250 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006251 * "interrupted" (if not NULL) is set to TRUE when no character is available
6252 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02006253 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006254 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 */
6256 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006257WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006259#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01006260 return ui_wait_for_chars_or_timer(
6261 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006262#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006263 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006264#endif
6265}
6266
6267/*
6268 * Wait "msec" msec until a character is available from the mouse or keyboard
6269 * or from inbuf[].
6270 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006271 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006272 * "interrupted" (if not NULL) is set to TRUE when no character is available
6273 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006274 * When a GUI is being used, this will never get called -- webb
6275 */
6276 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006277WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006278{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279#ifdef FEAT_MOUSE_GPM
6280 int gpm_process_wanted;
6281#endif
6282#ifdef FEAT_XCLIPBOARD
6283 int rest;
6284#endif
6285 int avail;
6286
Bram Moolenaar0f873732019-12-05 20:28:46 +01006287 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 return 1;
6289
6290#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006291 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 if (WantQueryMouse)
6293 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006294 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006295 if (!no_query_mouse_for_testing)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00006296 mch_write((char_u *)"\033[1'|", 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 }
6298#endif
6299
6300 /*
6301 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6302 * events. This is a bit complicated, because they might both be defined.
6303 */
6304#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6305# ifdef FEAT_XCLIPBOARD
6306 rest = 0;
6307 if (do_xterm_trace())
6308 rest = msec;
6309# endif
6310 do
6311 {
6312# ifdef FEAT_XCLIPBOARD
6313 if (rest != 0)
6314 {
6315 msec = XT_TRACE_DELAY;
6316 if (rest >= 0 && rest < XT_TRACE_DELAY)
6317 msec = rest;
6318 if (rest >= 0)
6319 rest -= msec;
6320 }
6321# endif
Yee Cheng Chin4314e4f2022-10-08 13:50:05 +01006322# ifdef FEAT_SOUND_MACOSX
6323 // Invoke any pending sound callbacks.
6324 process_cfrunloop();
6325# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006326# ifdef FEAT_SOUND_CANBERRA
6327 // Invoke any pending sound callbacks.
6328 if (has_sound_callback_in_queue())
6329 invoke_sound_callback();
6330# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331# ifdef FEAT_MOUSE_GPM
6332 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006333 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006334 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006335 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006337 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006339# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006341 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 return 1;
6343# ifdef FEAT_XCLIPBOARD
6344 if (rest == 0 || !do_xterm_trace())
6345# endif
6346 break;
6347 }
6348 }
6349 while (FALSE
6350# ifdef FEAT_MOUSE_GPM
6351 || (gpm_process_wanted && mch_gpm_process() == 0)
6352# endif
6353# ifdef FEAT_XCLIPBOARD
6354 || (!avail && rest != 0)
6355# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006356 )
6357 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358
6359#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006360 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361#endif
6362 return avail;
6363}
6364
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006365#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366/*
6367 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006368 * "msec" == 0 will check for characters once.
6369 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006372 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006373 * "interrupted" (if not NULL) is set to TRUE when no character is available
6374 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006376 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006377RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378{
6379 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006380 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006381#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 static int busy = FALSE;
6383
Bram Moolenaar0f873732019-12-05 20:28:46 +01006384 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385# define MAY_LOOP
6386
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006387# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006388 // Remember at what time we started, so that we know how much longer we
6389 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006390 long start_msec = msec;
6391 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006393 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006394 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395# endif
6396
Bram Moolenaar0f873732019-12-05 20:28:46 +01006397 // Handle being called recursively. This may happen for the session
6398 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 if (busy)
6400 return 0;
6401#endif
6402
6403#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006404 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405#endif
6406 {
6407#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006408 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006409# ifdef FEAT_MZSCHEME
6410 int mzquantum_used = FALSE;
6411# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412#endif
6413#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006414 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006415 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 int nfd;
6417# ifdef FEAT_XCLIPBOARD
6418 int xterm_idx = -1;
6419# endif
6420# ifdef FEAT_MOUSE_GPM
6421 int gpm_idx = -1;
6422# endif
6423# ifdef USE_XSMP
6424 int xsmp_idx = -1;
6425# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006426 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006428# ifdef FEAT_MZSCHEME
6429 mzvim_check_threads();
6430 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6431 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006432 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006433 mzquantum_used = TRUE;
6434 }
6435# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 fds[0].fd = fd;
6437 fds[0].events = POLLIN;
6438 nfd = 1;
6439
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006441 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 if (xterm_Shell != (Widget)0)
6443 {
6444 xterm_idx = nfd;
6445 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6446 fds[nfd].events = POLLIN;
6447 nfd++;
6448 }
6449# endif
6450# ifdef FEAT_MOUSE_GPM
6451 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6452 {
6453 gpm_idx = nfd;
6454 fds[nfd].fd = gpm_fd;
6455 fds[nfd].events = POLLIN;
6456 nfd++;
6457 }
6458# endif
6459# ifdef USE_XSMP
6460 if (xsmp_icefd != -1)
6461 {
6462 xsmp_idx = nfd;
6463 fds[nfd].fd = xsmp_icefd;
6464 fds[nfd].events = POLLIN;
6465 nfd++;
6466 }
6467# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006468#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006469 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006470#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006471 if (interrupted != NULL)
6472 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006474 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006475
6476 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006477 if (result == 0 && interrupted != NULL && ret > 0)
6478 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006479
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006480# ifdef FEAT_MZSCHEME
6481 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006482 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006483 finished = FALSE;
6484# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486# ifdef FEAT_XCLIPBOARD
6487 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6488 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006489 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006491 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 finished = FALSE;
6493 }
6494# endif
6495# ifdef FEAT_MOUSE_GPM
6496 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498# endif
6499# ifdef USE_XSMP
6500 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6501 {
6502 if (fds[xsmp_idx].revents & POLLIN)
6503 {
6504 busy = TRUE;
6505 xsmp_handle_requests();
6506 busy = FALSE;
6507 }
6508 else if (fds[xsmp_idx].revents & POLLHUP)
6509 {
6510 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006511 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 xsmp_close();
6513 }
6514 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006515 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 }
6517# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006518#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006519 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006520 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006521 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006522#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523
Bram Moolenaar0f873732019-12-05 20:28:46 +01006524#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525
6526 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006527 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006528 // These are static because they can take 8 Kbyte each and cause the
6529 // signal stack to run out with -O3.
6530 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006532 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006534# ifdef FEAT_MZSCHEME
6535 mzvim_check_threads();
6536 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6537 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006538 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006539 mzquantum_used = TRUE;
6540 }
6541# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006543 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006545 tv.tv_sec = towait / 1000;
6546 tv.tv_usec = (towait % 1000) * (1000000/1000);
6547 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006549 else
6550 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551
6552 /*
6553 * Select on ready for reading and exceptional condition (end of file).
6554 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006555select_eintr:
6556 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006557 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 FD_ZERO(&efds);
6559 FD_SET(fd, &rfds);
K.Takatab247e062022-02-07 10:45:23 +00006560# ifndef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006561 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 FD_SET(fd, &efds);
6563# endif
6564 maxfd = fd;
6565
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006567 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 if (xterm_Shell != (Widget)0)
6569 {
6570 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6571 if (maxfd < ConnectionNumber(xterm_dpy))
6572 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006573
Bram Moolenaar0f873732019-12-05 20:28:46 +01006574 // An event may have already been read but not handled. In
6575 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006576 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 }
6578# endif
6579# ifdef FEAT_MOUSE_GPM
6580 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6581 {
6582 FD_SET(gpm_fd, &rfds);
6583 FD_SET(gpm_fd, &efds);
6584 if (maxfd < gpm_fd)
6585 maxfd = gpm_fd;
6586 }
6587# endif
6588# ifdef USE_XSMP
6589 if (xsmp_icefd != -1)
6590 {
6591 FD_SET(xsmp_icefd, &rfds);
6592 FD_SET(xsmp_icefd, &efds);
6593 if (maxfd < xsmp_icefd)
6594 maxfd = xsmp_icefd;
6595 }
6596# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006597# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006598 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006599# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006600 if (interrupted != NULL)
6601 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602
Bram Moolenaar643b6142018-09-12 20:29:09 +02006603 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6604 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006605 result = ret > 0 && FD_ISSET(fd, &rfds);
6606 if (result)
6607 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006608 else if (interrupted != NULL && ret > 0)
6609 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006610
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006611# ifdef EINTR
6612 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006613 {
dbivolaruab16ad32021-12-29 19:41:47 +00006614 // Check whether the EINTR is caused by SIGTSTP
6615 if (got_tstp && !in_mch_suspend)
6616 {
6617 exarg_T ea;
dbivolaru79a6e252022-01-23 16:41:14 +00006618
dbivolaruab16ad32021-12-29 19:41:47 +00006619 ea.forceit = TRUE;
6620 ex_stop(&ea);
6621 got_tstp = FALSE;
6622 }
6623
Bram Moolenaar0f873732019-12-05 20:28:46 +01006624 // Check whether window has been resized, EINTR may be caused by
6625 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006626 if (do_resize)
Bram Moolenaar55f1b822023-06-21 13:42:48 +01006627 {
Bram Moolenaar545c8a52023-06-21 15:51:47 +01006628# ifdef FEAT_EVAL
Bram Moolenaar55f1b822023-06-21 13:42:48 +01006629 ch_log(NULL, "calling handle_resize() in RealWaitForChar()");
Bram Moolenaar545c8a52023-06-21 15:51:47 +01006630# endif
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006631 handle_resize();
Bram Moolenaar55f1b822023-06-21 13:42:48 +01006632 }
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006633
Bram Moolenaar0f873732019-12-05 20:28:46 +01006634 // Interrupted by a signal, need to try again. We ignore msec
6635 // here, because we do want to check even after a timeout if
6636 // characters are available. Needed for reading output of an
6637 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006638 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006639 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006640# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006641# ifdef __TANDEM
6642 if (ret == -1 && errno == ENOTSUP)
6643 {
6644 FD_ZERO(&rfds);
6645 FD_ZERO(&efds);
6646 ret = 0;
6647 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006648# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006649# ifdef FEAT_MZSCHEME
6650 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006651 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006652 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653# endif
6654
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655# ifdef FEAT_XCLIPBOARD
6656 if (ret > 0 && xterm_Shell != (Widget)0
6657 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6658 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006659 xterm_update(); // Maybe we should hand out clipboard
6660 // continue looping when we only got the X event and the input
6661 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 if (--ret == 0 && !input_available())
6663 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006664 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 finished = FALSE;
6666 }
6667 }
6668# endif
6669# ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00006670 if (ret > 0 && check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 {
6672 if (FD_ISSET(gpm_fd, &efds))
6673 gpm_close();
6674 else if (FD_ISSET(gpm_fd, &rfds))
6675 *check_for_gpm = 1;
6676 }
6677# endif
6678# ifdef USE_XSMP
6679 if (ret > 0 && xsmp_icefd != -1)
6680 {
6681 if (FD_ISSET(xsmp_icefd, &efds))
6682 {
6683 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006684 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 xsmp_close();
6686 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006687 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 }
6689 else if (FD_ISSET(xsmp_icefd, &rfds))
6690 {
6691 busy = TRUE;
6692 xsmp_handle_requests();
6693 busy = FALSE;
6694 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006695 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 }
6697 }
6698# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006699#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006700 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006701 if (ret >= 0)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01006702 (void)channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006703#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704
Bram Moolenaar0f873732019-12-05 20:28:46 +01006705#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706
6707#ifdef MAY_LOOP
6708 if (finished || msec == 0)
6709 break;
6710
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006711# ifdef FEAT_CLIENTSERVER
6712 if (server_waiting())
6713 break;
6714# endif
6715
Bram Moolenaar0f873732019-12-05 20:28:46 +01006716 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 if (msec > 0)
6718 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006719# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006720 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006721 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006723 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 msec = msec / 2;
6725# endif
6726 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006727 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 }
6729#endif
6730 }
6731
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006732 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733}
6734
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006736 * Expand a path into all matching files and/or directories. Handles "*",
6737 * "?", "[a-z]", "**", etc.
6738 * "path" has backslashes before chars that are not to be expanded.
6739 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 */
6741 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006742mch_expandpath(
6743 garray_T *gap,
6744 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006745 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746{
Bram Moolenaar02743632005-07-25 20:42:36 +00006747 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749
6750/*
6751 * mch_expand_wildcards() - this code does wild-card pattern matching using
6752 * the shell
6753 *
6754 * return OK for success, FAIL for error (you may lose some memory) and put
6755 * an error message in *file.
6756 *
6757 * num_pat is number of input patterns
6758 * pat is array of pointers to input patterns
6759 * num_file is pointer to number of matched file names
6760 * file is pointer to array of pointers to matched file names
6761 */
6762
6763#ifndef SEEK_SET
6764# define SEEK_SET 0
6765#endif
6766#ifndef SEEK_END
6767# define SEEK_END 2
6768#endif
6769
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006770#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006771
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006773mch_expand_wildcards(
6774 int num_pat,
6775 char_u **pat,
6776 int *num_file,
6777 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006778 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779{
6780 int i;
6781 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006782 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 char_u *p;
6784 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785
Bram Moolenaarc7247912008-01-13 12:54:11 +00006786 /*
6787 * This is the non-OS/2 implementation (really Unix).
6788 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 int j;
6790 char_u *tempname;
6791 char_u *command;
6792 FILE *fd;
6793 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006794#define STYLE_ECHO 0 // use "echo", the default
6795#define STYLE_GLOB 1 // use "glob", for csh
6796#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6797#define STYLE_PRINT 3 // use "print -N", for zsh
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006798#define STYLE_BT 4 // `cmd` expansion, execute the pattern directly
6799#define STYLE_GLOBSTAR 5 // use extended shell glob for bash (this uses extended
6800 // globbing functionality using globstar, needs bash > 4)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 int shell_style = STYLE_ECHO;
6802 int check_spaces;
6803 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006804 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006805 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006806 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006807 // vimglob() function with globstar setting enabled, only for bash >= 4.X
6808 static char *sh_globstar_opt = "[[ ${BASH_VERSINFO[0]} -ge 4 ]] && shopt -s globstar; ";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809
Bram Moolenaar0f873732019-12-05 20:28:46 +01006810 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 *file = NULL;
6812
6813 /*
6814 * If there are no wildcards, just copy the names to allocated memory.
6815 * Saves a lot of time, because we don't have to start a new shell.
6816 */
6817 if (!have_wildcard(num_pat, pat))
6818 return save_patterns(num_pat, pat, num_file, file);
6819
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006820# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006821 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006822 if (sandbox != 0 && check_secure())
6823 return FAIL;
6824# endif
6825
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 /*
6827 * Don't allow the use of backticks in secure and restricted mode.
6828 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006829 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 for (i = 0; i < num_pat; ++i)
6831 if (vim_strchr(pat[i], '`') != NULL
6832 && (check_restricted() || check_secure()))
6833 return FAIL;
6834
6835 /*
6836 * get a name for the temp file
6837 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006838 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006840 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 return FAIL;
6842 }
6843
6844 /*
6845 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006846 * file.
6847 * STYLE_BT: NL separated
6848 * If expanding `cmd` execute it directly.
6849 * STYLE_GLOB: NUL separated
6850 * If we use *csh, "glob" will work better than "echo".
6851 * STYLE_PRINT: NL or NUL separated
6852 * If we use *zsh, "print -N" will work better than "glob".
6853 * STYLE_VIMGLOB: NL separated
6854 * If we use *sh*, we define "vimglob()".
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006855 * STYLE_GLOBSTAR: NL separated
6856 * If we use *bash*, we define "vimglob() and enable globstar option".
Bram Moolenaarc7247912008-01-13 12:54:11 +00006857 * STYLE_ECHO: space separated.
6858 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 */
6860 if (num_pat == 1 && *pat[0] == '`'
6861 && (len = STRLEN(pat[0])) > 2
6862 && *(pat[0] + len - 1) == '`')
6863 shell_style = STYLE_BT;
6864 else if ((len = STRLEN(p_sh)) >= 3)
6865 {
6866 if (STRCMP(p_sh + len - 3, "csh") == 0)
6867 shell_style = STYLE_GLOB;
6868 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6869 shell_style = STYLE_PRINT;
6870 }
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006871 if (shell_style == STYLE_ECHO)
6872 {
6873 if (strstr((char *)gettail(p_sh), "bash") != NULL)
6874 shell_style = STYLE_GLOBSTAR;
6875 else if (strstr((char *)gettail(p_sh), "sh") != NULL)
6876 shell_style = STYLE_VIMGLOB;
6877 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878
Bram Moolenaar0f873732019-12-05 20:28:46 +01006879 // Compute the length of the command. We need 2 extra bytes: for the
6880 // optional '&' and for the NUL.
6881 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006883 if (shell_style == STYLE_VIMGLOB)
6884 len += STRLEN(sh_vimglob_func);
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006885 else if (shell_style == STYLE_GLOBSTAR)
6886 len += STRLEN(sh_vimglob_func)
6887 + STRLEN(sh_globstar_opt);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006888
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006889 for (i = 0; i < num_pat; ++i)
6890 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006891 // Count the length of the patterns in the same way as they are put in
6892 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006893#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006894 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006895#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006896 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006897 for (j = 0; pat[i][j] != NUL; ++j)
6898 {
6899 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006900 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006901 ++len;
6902 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006903#endif
6904 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 command = alloc(len);
6906 if (command == NULL)
6907 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006908 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 vim_free(tempname);
6910 return FAIL;
6911 }
6912
6913 /*
6914 * Build the shell command:
6915 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6916 * recognizes this).
6917 * - Add the shell command to print the expanded names.
6918 * - Add the temp file name.
6919 * - Add the file name patterns.
6920 */
6921 if (shell_style == STYLE_BT)
6922 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006923 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006924 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006925 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006927 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006928 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006930 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006932 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 *p = ' ';
6934 }
6935 STRCAT(command, ">");
6936 }
6937 else
6938 {
Christian Brabandt8b8d8292021-11-19 12:37:36 +00006939 STRCPY(command, "");
6940 if (shell_style == STYLE_GLOB)
6941 {
6942 // Assume the nonomatch option is valid only for csh like shells,
6943 // otherwise, this may set the positional parameters for the shell,
6944 // e.g. "$*".
6945 if (flags & EW_NOTFOUND)
6946 STRCAT(command, "set nonomatch; ");
6947 else
6948 STRCAT(command, "unset nonomatch; ");
6949 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 if (shell_style == STYLE_GLOB)
6951 STRCAT(command, "glob >");
6952 else if (shell_style == STYLE_PRINT)
6953 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006954 else if (shell_style == STYLE_VIMGLOB)
6955 STRCAT(command, sh_vimglob_func);
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02006956 else if (shell_style == STYLE_GLOBSTAR)
6957 {
6958 STRCAT(command, sh_globstar_opt);
6959 STRCAT(command, sh_vimglob_func);
6960 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 else
6962 STRCAT(command, "echo >");
6963 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006964
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006966
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 if (shell_style != STYLE_BT)
6968 for (i = 0; i < num_pat; ++i)
6969 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006970 // When using system() always add extra quotes, because the shell
6971 // is started twice. Otherwise put a backslash before special
6972 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973#ifdef USE_SYSTEM
6974 STRCAT(command, " \"");
6975 STRCAT(command, pat[i]);
6976 STRCAT(command, "\"");
6977#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006978 int intick = FALSE;
6979
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 p = command + STRLEN(command);
6981 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006982 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006983 {
6984 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006985 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006986 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6987 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006988 // Remove a backslash, take char literally. But keep
6989 // backslash inside backticks, before a special character
6990 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006991 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006992 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6993 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006994 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006995 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006996 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006997 else if (!intick
6998 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6999 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007000 // Put a backslash before a special character, but not
7001 // when inside ``. And not for $var when EW_KEEPDOLLAR is
7002 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00007003 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00007004
Bram Moolenaar0f873732019-12-05 20:28:46 +01007005 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00007006 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00007007 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 *p = NUL;
7009#endif
7010 }
7011 if (flags & EW_SILENT)
7012 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01007013 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007014 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015
7016 /*
7017 * Using zsh -G: If a pattern has no matches, it is just deleted from
7018 * the argument list, otherwise zsh gives an error message and doesn't
7019 * expand any other pattern.
7020 */
7021 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007022 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023
7024 /*
7025 * If we use -f then shell variables set in .cshrc won't get expanded.
7026 * vi can do it, so we will too, but it is only necessary if there is a "$"
7027 * in one of the patterns, otherwise we can still use the fast option.
7028 */
7029 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01007030 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031
7032 /*
7033 * execute the shell command
7034 */
7035 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
7036
Bram Moolenaar0f873732019-12-05 20:28:46 +01007037 // When running in the background, give it some time to create the temp
7038 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01007039 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02007040 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041
Bram Moolenaar0f873732019-12-05 20:28:46 +01007042 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 show_shell_mess = TRUE;
7044 vim_free(command);
7045
Bram Moolenaar0f873732019-12-05 20:28:46 +01007046 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 {
7048 mch_remove(tempname);
7049 vim_free(tempname);
7050 /*
7051 * With interactive completion, the error message is not printed.
7052 * However with USE_SYSTEM, I don't know how to turn off error messages
7053 * from the shell, so screen may still get messed up -- webb.
7054 */
7055#ifndef USE_SYSTEM
7056 if (!(flags & EW_SILENT))
7057#endif
7058 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007059 redraw_later_clear(); // probably messed up screen
7060 msg_putchar('\n'); // clear bottom line quickly
7061 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062#ifdef USE_SYSTEM
7063 if (!(flags & EW_SILENT))
7064#endif
7065 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00007066 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01007067 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 }
7069 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007070 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
7071 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 if (shell_style == STYLE_BT)
7073 return FAIL;
7074 goto notfound;
7075 }
7076
7077 /*
7078 * read the names from the file into memory
7079 */
7080 fd = fopen((char *)tempname, READBIN);
7081 if (fd == NULL)
7082 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007083 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 if (!(flags & EW_SILENT))
7085 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00007086 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01007087 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 }
7089 vim_free(tempname);
7090 goto notfound;
7091 }
7092 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007093 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02007095 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007096 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02007097 buffer = NULL;
7098 else
7099 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 if (buffer == NULL)
7101 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007102 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 mch_remove(tempname);
7104 vim_free(tempname);
7105 fclose(fd);
7106 return FAIL;
7107 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02007108 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 i = fread((char *)buffer, 1, len, fd);
7110 fclose(fd);
7111 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00007112 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007114 // unexpected read error
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007115 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 vim_free(tempname);
7117 vim_free(buffer);
7118 return FAIL;
7119 }
7120 vim_free(tempname);
7121
Bram Moolenaar1eed5322019-02-26 17:03:54 +01007122# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01007123 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02007125 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
7127 *p++ = buffer[i];
7128 len = p - buffer;
7129# endif
7130
7131
Bram Moolenaar0f873732019-12-05 20:28:46 +01007132 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 if (shell_style == STYLE_ECHO)
7134 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007135 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007137 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 {
7139 while (*p != ' ' && *p != '\n')
7140 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007141 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 }
7143 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007144 // file names are separated with NL
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02007145 else if (shell_style == STYLE_BT ||
7146 shell_style == STYLE_VIMGLOB ||
7147 shell_style == STYLE_GLOBSTAR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007149 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007151 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 {
7153 while (*p != '\n' && *p != NUL)
7154 ++p;
7155 if (*p != NUL)
7156 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007157 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 }
7159 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007160 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 else
7162 {
7163 /*
7164 * Some versions of zsh use spaces instead of NULs to separate
7165 * results. Only do this when there is no NUL before the end of the
7166 * buffer, otherwise we would never be able to use file names with
7167 * embedded spaces when zsh does use NULs.
7168 * When we found a NUL once, we know zsh is OK, set did_find_nul and
7169 * don't check for spaces again.
7170 */
7171 check_spaces = FALSE;
7172 if (shell_style == STYLE_PRINT && !did_find_nul)
7173 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007174 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007175 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01007176 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 did_find_nul = TRUE;
7178 else
7179 check_spaces = TRUE;
7180 }
7181
7182 /*
7183 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
7184 * already is one, for STYLE_GLOB it needs to be added.
7185 */
7186 if (len && buffer[len - 1] == NUL)
7187 --len;
7188 else
7189 buffer[len] = NUL;
7190 i = 0;
7191 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007192 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 {
7194 ++i;
7195 *p = NUL;
7196 }
7197 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007198 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 }
7200 if (i == 0)
7201 {
7202 /*
7203 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
7204 * /bin/sh will happily expand it to nothing rather than returning an
7205 * error; and hey, it's good to check anyway -- webb.
7206 */
7207 vim_free(buffer);
7208 goto notfound;
7209 }
7210 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007211 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 if (*file == NULL)
7213 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007214 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 vim_free(buffer);
7216 return FAIL;
7217 }
7218
7219 /*
7220 * Isolate the individual file names.
7221 */
7222 p = buffer;
7223 for (i = 0; i < *num_file; ++i)
7224 {
7225 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007226 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00007227 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
Christian Brabandt9eb1ce52023-09-27 19:08:25 +02007228 || shell_style == STYLE_VIMGLOB || shell_style == STYLE_GLOBSTAR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00007230 while (!(shell_style == STYLE_ECHO && *p == ' ')
7231 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007233 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 *p = NUL;
7235 else
7236 {
7237 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007238 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 }
7240 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007241 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007243 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007245 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 }
7247 }
7248
7249 /*
7250 * Move the file names to allocated memory.
7251 */
7252 for (j = 0, i = 0; i < *num_file; ++i)
7253 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007254 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
7256 continue;
7257
Bram Moolenaar0f873732019-12-05 20:28:46 +01007258 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 dir = (mch_isdir((*file)[i]));
7260 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
7261 continue;
7262
Bram Moolenaar0f873732019-12-05 20:28:46 +01007263 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01007264 if (!dir && (flags & EW_EXEC)
7265 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00007266 continue;
7267
Bram Moolenaar964b3742019-05-24 18:54:09 +02007268 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 if (p)
7270 {
7271 STRCPY(p, (*file)[i]);
7272 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007273 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 (*file)[j++] = p;
7275 }
7276 }
7277 vim_free(buffer);
7278 *num_file = j;
7279
Bram Moolenaar0f873732019-12-05 20:28:46 +01007280 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01007282 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 goto notfound;
7284 }
7285
7286 return OK;
7287
7288notfound:
7289 if (flags & EW_NOTFOUND)
7290 return save_patterns(num_pat, pat, num_file, file);
7291 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292}
7293
Bram Moolenaar0f873732019-12-05 20:28:46 +01007294#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007297save_patterns(
7298 int num_pat,
7299 char_u **pat,
7300 int *num_file,
7301 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302{
7303 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00007304 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007306 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 if (*file == NULL)
7308 return FAIL;
7309 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00007310 {
7311 s = vim_strsave(pat[i]);
7312 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007313 // Be compatible with expand_filename(): halve the number of
7314 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007315 backslash_halve(s);
7316 (*file)[i] = s;
7317 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 *num_file = num_pat;
7319 return OK;
7320}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322/*
7323 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7324 * expand.
7325 */
7326 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007327mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007329 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 if (*p == '\\' && p[1] != NUL)
7332 ++p;
7333 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 if (vim_strchr((char_u *)
7335#ifdef VMS
7336 "*?%"
7337#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339#endif
7340 , *p) != NULL)
7341 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 }
7343 return FALSE;
7344}
7345
7346/*
7347 * Return TRUE if the string "p" contains a wildcard.
7348 * Don't recognize '~' at the end as a wildcard.
7349 */
7350 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007351mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007353 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 if (*p == '\\' && p[1] != NUL)
7356 ++p;
7357 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 if (vim_strchr((char_u *)
7359#ifdef VMS
7360 "*?%$"
7361#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363#endif
7364 , *p) != NULL
7365 || (*p == '~' && p[1] != NUL))
7366 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 }
7368 return FALSE;
7369}
7370
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007372have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373{
7374 int i;
7375
7376 for (i = 0; i < num; i++)
7377 if (mch_has_wildcard(file[i]))
7378 return 1;
7379 return 0;
7380}
7381
7382 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007383have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384{
7385 int i;
7386
7387 for (i = 0; i < num; i++)
7388 if (vim_strchr(file[i], '$') != NULL)
7389 return TRUE;
7390 return FALSE;
7391}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007393#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394/*
7395 * Scaled-down version of rename(), which is missing in Xenix.
7396 * This version can only move regular files and will fail if the
7397 * destination exists.
7398 */
7399 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007400mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401{
7402 struct stat st;
7403
Bram Moolenaar0f873732019-12-05 20:28:46 +01007404 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007406 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007408 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 return 0;
7410 return -1;
7411}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007412#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007414#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007415# if defined(DYNAMIC_GPM) || defined(PROTO)
7416/*
7417 * Initialize Gpm's symbols for dynamic linking.
7418 * Must be called only if libgpm_hinst is NULL.
7419 */
7420 static int
7421load_libgpm(void)
7422{
7423 libgpm_hinst = dlopen("libgpm.so", RTLD_LAZY|RTLD_GLOBAL);
7424
7425 if (libgpm_hinst == NULL)
7426 {
7427 if (p_verbose > 0)
7428 smsg_attr(HL_ATTR(HLF_W),
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007429 _("Could not load gpm library: %s"), dlerror());
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007430 return FAIL;
7431 }
7432
7433 if (
7434 (dll_Gpm_Open = dlsym(libgpm_hinst, "Gpm_Open")) == NULL
7435 || (dll_Gpm_Close = dlsym(libgpm_hinst, "Gpm_Close")) == NULL
7436 || (dll_Gpm_GetEvent = dlsym(libgpm_hinst, "Gpm_GetEvent")) == NULL
7437 || (dll_gpm_flag = dlsym(libgpm_hinst, "gpm_flag")) == NULL
7438 || (dll_gpm_fd = dlsym(libgpm_hinst, "gpm_fd")) == NULL
7439 )
7440 {
7441 semsg(_(e_could_not_load_library_str_str), "gpm", dlerror());
7442 dlclose(libgpm_hinst);
7443 libgpm_hinst = NULL;
7444 dll_gpm_flag = NULL;
7445 dll_gpm_fd = NULL;
7446 return FAIL;
7447 }
7448 return OK;
7449}
7450
7451 int
7452gpm_available(void)
7453{
7454 return libgpm_hinst != NULL || load_libgpm() == OK;
7455}
7456# endif // DYNAMIC_GPM
7457
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458/*
7459 * Initializes connection with gpm (if it isn't already opened)
7460 * Return 1 if succeeded (or connection already opened), 0 if failed
7461 */
7462 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007463gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007465 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007467#ifdef DYNAMIC_GPM
7468 if (!gpm_available())
7469 return 0;
7470#endif
7471
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007472 if (gpm_flag)
7473 return 1; // already open
7474
7475 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7476 gpm_connect.defaultMask = ~GPM_HARD;
7477 // Default handling for mouse move
7478 gpm_connect.minMod = 0; // Handle any modifier keys
7479 gpm_connect.maxMod = 0xffff;
7480 if (Gpm_Open(&gpm_connect, 0) > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007482 // gpm library tries to handling TSTP causes
7483 // problems. Anyways, we close connection to Gpm whenever
7484 // we are going to suspend or starting an external process
7485 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007486# ifdef SIGTSTP
ichizok378447f2023-05-11 22:25:42 +01007487 mch_signal(SIGTSTP, restricted ? SIG_IGN : sig_tstp);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007488# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007489 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007491 if (gpm_fd == -2)
7492 Gpm_Close(); // We don't want to talk to xterm via gpm
7493 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494}
7495
7496/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007497 * Returns TRUE if the GPM mouse is enabled.
7498 */
7499 int
7500gpm_enabled(void)
7501{
7502 return gpm_flag && gpm_fd >= 0;
7503}
7504
7505/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 */
7508 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007509gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007511 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 Gpm_Close();
7513}
7514
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007515/*
7516 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007518 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 */
7520 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007521mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522{
7523 int button;
7524 static Gpm_Event gpm_event;
7525 char_u string[6];
7526 int_u vim_modifiers;
7527 int row,col;
7528 unsigned char buttons_mask;
7529 unsigned char gpm_modifiers;
7530 static unsigned char old_buttons = 0;
7531
7532 Gpm_GetEvent(&gpm_event);
7533
7534#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007535 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 if (hold_gui_events)
7537 return 0;
7538#endif
7539
7540 row = gpm_event.y - 1;
7541 col = gpm_event.x - 1;
7542
Bram Moolenaar0f873732019-12-05 20:28:46 +01007543 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 string[1] = 'M';
7545 string[2] = 'G';
7546 switch (GPM_BARE_EVENTS(gpm_event.type))
7547 {
7548 case GPM_DRAG:
7549 string[3] = MOUSE_DRAG;
7550 break;
7551 case GPM_DOWN:
7552 buttons_mask = gpm_event.buttons & ~old_buttons;
7553 old_buttons = gpm_event.buttons;
7554 switch (buttons_mask)
7555 {
7556 case GPM_B_LEFT:
7557 button = MOUSE_LEFT;
7558 break;
7559 case GPM_B_MIDDLE:
7560 button = MOUSE_MIDDLE;
7561 break;
7562 case GPM_B_RIGHT:
7563 button = MOUSE_RIGHT;
7564 break;
7565 default:
7566 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007567 // Don't know what to do. Can more than one button be
7568 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 }
7570 string[3] = (char_u)(button | 0x20);
7571 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7572 break;
7573 case GPM_UP:
7574 string[3] = MOUSE_RELEASE;
7575 old_buttons &= ~gpm_event.buttons;
7576 break;
7577 default:
7578 return 0;
7579 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007580 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 gpm_modifiers = gpm_event.modifiers;
7582 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007583 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7584 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7585 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7587 vim_modifiers |= MOUSE_SHIFT;
7588
7589 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7590 vim_modifiers |= MOUSE_CTRL;
7591 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7592 vim_modifiers |= MOUSE_ALT;
7593 string[3] |= vim_modifiers;
7594 string[4] = (char_u)(col + ' ' + 1);
7595 string[5] = (char_u)(row + ' ' + 1);
7596 add_to_input_buf(string, 6);
7597 return 6;
7598}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007599#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007601#ifdef FEAT_SYSMOUSE
7602/*
7603 * Initialize connection with sysmouse.
7604 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7605 * output, any sysmouse output than will be processed via sig_sysmouse().
7606 * Return OK if succeeded, FAIL if failed.
7607 */
7608 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007609sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007610{
7611 struct mouse_info mouse;
7612
7613 mouse.operation = MOUSE_MODE;
7614 mouse.u.mode.mode = 0;
7615 mouse.u.mode.signal = SIGUSR2;
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007616 if (ioctl(1, CONS_MOUSECTL, &mouse) == -1)
7617 return FAIL;
7618
ichizok378447f2023-05-11 22:25:42 +01007619 mch_signal(SIGUSR2, sig_sysmouse);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007620 mouse.operation = MOUSE_SHOW;
7621 ioctl(1, CONS_MOUSECTL, &mouse);
7622 return OK;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007623}
7624
7625/*
7626 * Stop processing SIGUSR2 signals, and also make sure that
7627 * virtual console do not send us any sysmouse related signal.
7628 */
7629 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007630sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007631{
7632 struct mouse_info mouse;
7633
ichizok378447f2023-05-11 22:25:42 +01007634 mch_signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007635 mouse.operation = MOUSE_MODE;
7636 mouse.u.mode.mode = 0;
7637 mouse.u.mode.signal = 0;
7638 ioctl(1, CONS_MOUSECTL, &mouse);
7639}
7640
7641/*
7642 * Gets info from sysmouse and adds special keys to input buf.
7643 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007644 static void
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007645sig_sysmouse SIGDEFARG(sigarg)
7646{
7647 struct mouse_info mouse;
7648 struct video_info video;
7649 char_u string[6];
7650 int row, col;
7651 int button;
7652 int buttons;
7653 static int oldbuttons = 0;
7654
7655#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007656 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007657 if (hold_gui_events)
7658 return;
7659#endif
7660
7661 mouse.operation = MOUSE_GETINFO;
7662 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7663 && ioctl(1, FBIO_MODEINFO, &video) != -1
7664 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7665 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7666 {
7667 row = mouse.u.data.y / video.vi_cheight;
7668 col = mouse.u.data.x / video.vi_cwidth;
7669 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007670 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007671 string[1] = 'M';
7672 string[2] = 'S';
7673 if (oldbuttons == buttons && buttons != 0)
7674 {
7675 button = MOUSE_DRAG;
7676 }
7677 else
7678 {
7679 switch (buttons)
7680 {
7681 case 0:
7682 button = MOUSE_RELEASE;
7683 break;
7684 case 1:
7685 button = MOUSE_LEFT;
7686 break;
7687 case 2:
7688 button = MOUSE_MIDDLE;
7689 break;
7690 case 4:
7691 button = MOUSE_RIGHT;
7692 break;
7693 default:
7694 return;
7695 }
7696 oldbuttons = buttons;
7697 }
7698 string[3] = (char_u)(button);
7699 string[4] = (char_u)(col + ' ' + 1);
7700 string[5] = (char_u)(row + ' ' + 1);
7701 add_to_input_buf(string, 6);
7702 }
7703 return;
7704}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007705#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007706
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007708typedef char_u * (*STRPROCSTR)(char_u *);
7709typedef char_u * (*INTPROCSTR)(int);
7710typedef int (*STRPROCINT)(char_u *);
7711typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712
7713/*
7714 * Call a DLL routine which takes either a string or int param
7715 * and returns an allocated string.
7716 */
7717 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007718mch_libcall(
7719 char_u *libname,
7720 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007721 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007722 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007723 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007724 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725{
7726# if defined(USE_DLOPEN)
7727 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007728 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729# else
7730 shl_t hinstLib;
7731# endif
7732 STRPROCSTR ProcAdd;
7733 INTPROCSTR ProcAddI;
7734 char_u *retval_str = NULL;
7735 int retval_int = 0;
7736 int success = FALSE;
7737
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007738 /*
7739 * Get a handle to the DLL module.
7740 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007742 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007743 (void)dlerror();
7744
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 hinstLib = dlopen((char *)libname, RTLD_LAZY
7746# ifdef RTLD_LOCAL
7747 | RTLD_LOCAL
7748# endif
7749 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007750 if (hinstLib == NULL)
7751 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007752 // "dlerr" must be used before dlclose()
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007753 dlerr = dlerror();
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007754 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007755 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007756 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757# else
7758 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7759# endif
7760
Bram Moolenaar0f873732019-12-05 20:28:46 +01007761 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 if (hinstLib != NULL)
7763 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007764# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 /*
7766 * Catch a crash when calling the library function. For example when
7767 * using a number where a string pointer is expected.
7768 */
7769 mch_startjmp();
7770 if (SETJMP(lc_jump_env) != 0)
7771 {
7772 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007773# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007774 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007775# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 mch_didjmp();
7777 }
7778 else
7779# endif
7780 {
7781 retval_str = NULL;
7782 retval_int = 0;
7783
7784 if (argstring != NULL)
7785 {
7786# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007787 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007788 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789# else
7790 if (shl_findsym(&hinstLib, (const char *)funcname,
7791 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7792 ProcAdd = NULL;
7793# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007794 if ((success = (ProcAdd != NULL
7795# if defined(USE_DLOPEN)
7796 && dlerr == NULL
7797# endif
7798 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 {
7800 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007801 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 else
7803 retval_str = (ProcAdd)(argstring);
7804 }
7805 }
7806 else
7807 {
7808# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007809 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007810 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811# else
7812 if (shl_findsym(&hinstLib, (const char *)funcname,
7813 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7814 ProcAddI = NULL;
7815# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007816 if ((success = (ProcAddI != NULL
7817# if defined(USE_DLOPEN)
7818 && dlerr == NULL
7819# endif
7820 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 {
7822 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007823 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 else
7825 retval_str = (ProcAddI)(argint);
7826 }
7827 }
7828
Bram Moolenaar0f873732019-12-05 20:28:46 +01007829 // Save the string before we free the library.
7830 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 if (string_result == NULL)
7832 *number_result = retval_int;
7833 else if (retval_str != NULL
7834 && retval_str != (char_u *)1
7835 && retval_str != (char_u *)-1)
7836 *string_result = vim_strsave(retval_str);
7837 }
7838
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007839# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 mch_endjmp();
7841# ifdef SIGHASARG
7842 if (lc_signal != 0)
7843 {
7844 int i;
7845
Bram Moolenaar0f873732019-12-05 20:28:46 +01007846 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 for (i = 0; signal_info[i].sig != -1; i++)
7848 if (lc_signal == signal_info[i].sig)
7849 break;
Bram Moolenaar50809a42023-05-20 16:39:07 +01007850 semsg(_(e_got_sig_str_in_libcall), signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 }
7852# endif
7853# endif
7854
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007856 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007857 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007858 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007859
Bram Moolenaar0f873732019-12-05 20:28:46 +01007860 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 (void)dlclose(hinstLib);
7862# else
7863 (void)shl_unload(hinstLib);
7864# endif
7865 }
7866
7867 if (!success)
7868 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007869 semsg(_(e_library_call_failed_for_str), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 return FAIL;
7871 }
7872
7873 return OK;
7874}
7875#endif
7876
7877#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007878static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879static int xterm_button;
7880
7881/*
7882 * Setup a dummy window for X selections in a terminal.
7883 */
7884 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007885setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886{
7887 int z = 0;
7888 char *strp = "";
7889 Widget AppShell;
7890
7891 if (!x_connect_to_server())
7892 return;
7893
7894 open_app_context();
7895 if (app_context != NULL && xterm_Shell == (Widget)0)
7896 {
Dominique Pellé4927bc72023-09-24 16:12:07 +02007897 int (*oldhandler)(Display*, XErrorEvent*);
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007898# if defined(USING_SETJMP)
Dominique Pellé4927bc72023-09-24 16:12:07 +02007899 int (*oldIOhandler)(Display*);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007900# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007901# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007902 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903
7904 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007905 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906# endif
7907
Bram Moolenaar0f873732019-12-05 20:28:46 +01007908 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 oldhandler = XSetErrorHandler(x_error_check);
7910
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007911# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007912 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7914 mch_startjmp();
7915 if (SETJMP(lc_jump_env) != 0)
7916 {
7917 mch_didjmp();
7918 xterm_dpy = NULL;
7919 }
7920 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007921# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 {
7923 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7924 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007925 if (xterm_dpy != NULL)
7926 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007927# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007929# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 }
7931
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007932# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007933 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007935# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007936 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 (void)XSetErrorHandler(oldhandler);
7938
7939 if (xterm_dpy == NULL)
7940 {
7941 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007942 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 return;
7944 }
7945
Bram Moolenaar0f873732019-12-05 20:28:46 +01007946 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 (void)XSetIOErrorHandler(x_IOerror_handler);
7948
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007949# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007951 {
7952 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007953 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007954 verbose_leave();
7955 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956# endif
7957
Bram Moolenaar0f873732019-12-05 20:28:46 +01007958 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7960 applicationShellWidgetClass, xterm_dpy,
7961 NULL);
7962 if (AppShell == (Widget)0)
7963 return;
7964 xterm_Shell = XtVaCreatePopupShell("VIM",
7965 topLevelShellWidgetClass, AppShell,
7966 XtNmappedWhenManaged, 0,
7967 XtNwidth, 1,
7968 XtNheight, 1,
7969 NULL);
7970 if (xterm_Shell == (Widget)0)
7971 return;
7972
7973 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007974 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 if (x11_display == NULL)
7976 x11_display = xterm_dpy;
7977
7978 XtRealizeWidget(xterm_Shell);
7979 XSync(xterm_dpy, False);
7980 xterm_update();
7981 }
7982 if (xterm_Shell != (Widget)0)
7983 {
7984 clip_init(TRUE);
7985 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7986 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007987 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 if (test_x11_window(xterm_dpy) == FAIL)
7989 x11_window = 0;
7990 if (x11_window != 0)
7991 xterm_trace = 0;
7992 }
7993}
7994
7995 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007996start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997{
7998 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7999 return;
8000 xterm_trace = 1;
8001 xterm_button = button;
8002 do_xterm_trace();
8003}
8004
8005
8006 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008007stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008{
8009 if (xterm_trace < 0)
8010 return;
8011 xterm_trace = 0;
8012}
8013
8014/*
8015 * Query the xterm pointer and generate mouse termcodes if necessary
8016 * return TRUE if dragging is active, else FALSE
8017 */
8018 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01008019do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020{
8021 Window root, child;
8022 int root_x, root_y;
8023 int win_x, win_y;
8024 int row, col;
8025 int_u mask_return;
8026 char_u buf[50];
8027 char_u *strp;
8028 long got_hints;
8029 static char_u *mouse_code;
8030 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
8031 static int prev_row = 0, prev_col = 0;
8032 static XSizeHints xterm_hints;
8033
8034 if (xterm_trace <= 0)
8035 return FALSE;
8036
8037 if (xterm_trace == 1)
8038 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008039 // Get the hints just before tracking starts. The font size might
8040 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00008041 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
8042 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 || xterm_hints.width_inc <= 1
8044 || xterm_hints.height_inc <= 1)
8045 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008046 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 return FALSE;
8048 }
8049
Bram Moolenaar0f873732019-12-05 20:28:46 +01008050 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 mouse_code = find_termcode(mouse_name);
8052 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02008053 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 xterm_trace = 2;
8055
Bram Moolenaar0f873732019-12-05 20:28:46 +01008056 // Find the offset of the chars, there might be a scrollbar on the
8057 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
8059 &win_x, &win_y, &mask_return);
8060 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
8061 - (xterm_hints.height_inc / 2);
8062 if (xterm_hints.y <= xterm_hints.height_inc / 2)
8063 xterm_hints.y = 2;
8064 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
8065 - (xterm_hints.width_inc / 2);
8066 if (xterm_hints.x <= xterm_hints.width_inc / 2)
8067 xterm_hints.x = 2;
8068 return TRUE;
8069 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02008070 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 {
8072 xterm_trace = 0;
8073 return FALSE;
8074 }
8075
8076 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
8077 &win_x, &win_y, &mask_return);
8078
8079 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
8080 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
8081 if (row == prev_row && col == prev_col)
8082 return TRUE;
8083
8084 STRCPY(buf, mouse_code);
8085 strp = buf + STRLEN(buf);
8086 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
8087 *strp++ = (char_u)(col + ' ' + 1);
8088 *strp++ = (char_u)(row + ' ' + 1);
8089 *strp = 0;
8090 add_to_input_buf(buf, STRLEN(buf));
8091
8092 prev_row = row;
8093 prev_col = col;
8094 return TRUE;
8095}
8096
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02008097# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098/*
8099 * Destroy the display, window and app_context. Required for GTK.
8100 */
8101 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008102clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103{
8104 if (xterm_Shell != (Widget)0)
8105 {
8106 XtDestroyWidget(xterm_Shell);
8107 xterm_Shell = (Widget)0;
8108 }
8109 if (xterm_dpy != NULL)
8110 {
Bram Moolenaare8208012008-06-20 09:59:25 +00008111# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008112 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00008114# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 if (x11_display == xterm_dpy)
8116 x11_display = NULL;
8117 xterm_dpy = NULL;
8118 }
Bram Moolenaare8208012008-06-20 09:59:25 +00008119# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 if (app_context != (XtAppContext)NULL)
8121 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008122 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 XtDestroyApplicationContext(app_context);
8124 app_context = (XtAppContext)NULL;
8125 }
Bram Moolenaare8208012008-06-20 09:59:25 +00008126# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127}
8128# endif
8129
8130/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01008131 * Catch up with GUI or X events.
8132 */
8133 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008134clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01008135{
8136# ifdef FEAT_GUI
8137 if (gui.in_use)
8138 gui_mch_update();
8139 else
8140# endif
8141 if (xterm_Shell != (Widget)0)
8142 xterm_update();
8143}
8144
8145/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 * Catch up with any queued X events. This may put keyboard input into the
8147 * input buffer, call resize call-backs, trigger timers etc. If there is
8148 * nothing in the X event queue (& no timers pending), then we return
8149 * immediately.
8150 */
8151 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008152xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153{
8154 XEvent event;
8155
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008156 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008158 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008160 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008161 break;
8162
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008163 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008164 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008165 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008166 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008167#ifdef FEAT_CLIENTSERVER
8168 {
8169 XPropertyEvent *e = (XPropertyEvent *)&event;
8170
8171 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008173 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008174 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008176 XtDispatchEvent(&event);
8177 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01008178 else
8179 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008180 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02008181 XtAppProcessEvent(app_context, mask);
8182 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 }
8184}
8185
8186 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008187clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188{
8189 if (xterm_Shell != (Widget)0)
8190 return clip_x11_own_selection(xterm_Shell, cbd);
8191 return FAIL;
8192}
8193
8194 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008195clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196{
8197 if (xterm_Shell != (Widget)0)
8198 clip_x11_lose_selection(xterm_Shell, cbd);
8199}
8200
8201 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008202clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203{
8204 if (xterm_Shell != (Widget)0)
8205 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
8206}
8207
8208 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008209clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210{
8211 clip_x11_set_selection(cbd);
8212}
8213#endif
8214
8215
8216#if defined(USE_XSMP) || defined(PROTO)
8217/*
8218 * Code for X Session Management Protocol.
8219 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220
8221# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222/*
8223 * This is our chance to ask the user if they want to save,
8224 * or abort the logout
8225 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008227xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008228{
Bram Moolenaare1004402020-10-24 20:49:43 +02008229 int save_cmod_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 int cancel_shutdown = False;
8231
Bram Moolenaare1004402020-10-24 20:49:43 +02008232 save_cmod_flags = cmdmod.cmod_flags;
8233 cmdmod.cmod_flags |= CMOD_CONFIRM;
Bram Moolenaar027387f2016-01-02 22:25:52 +01008234 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01008235 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 cancel_shutdown = True;
Bram Moolenaare1004402020-10-24 20:49:43 +02008237 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar0f873732019-12-05 20:28:46 +01008238 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 out_flush();
8240
Bram Moolenaar0f873732019-12-05 20:28:46 +01008241 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 SmcInteractDone(smc_conn, cancel_shutdown);
8243
Bram Moolenaar0f873732019-12-05 20:28:46 +01008244 // Finish off
8245 // Only end save-yourself here if we're not cancelling shutdown;
8246 // we'll get a cancelled callback later in which we'll end it.
8247 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 if (!cancel_shutdown)
8249 {
8250 xsmp.save_yourself = False;
8251 SmcSaveYourselfDone(smc_conn, True);
8252 }
8253}
8254# endif
8255
8256/*
8257 * Callback that starts save-yourself.
8258 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008260xsmp_handle_save_yourself(
8261 SmcConn smc_conn,
8262 SmPointer client_data UNUSED,
8263 int save_type UNUSED,
8264 Bool shutdown,
8265 int interact_style UNUSED,
8266 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008268 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 if (xsmp.save_yourself)
8270 SmcSaveYourselfDone(smc_conn, True);
8271 xsmp.save_yourself = True;
8272 xsmp.shutdown = shutdown;
8273
Bram Moolenaar0f873732019-12-05 20:28:46 +01008274 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01008276 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277
8278 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008279 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280
8281# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008282 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008284 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 SmcInteractRequest(smc_conn, SmDialogError,
8286 xsmp_handle_interaction, client_data);
8287 else
8288# endif
8289 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008290 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 SmcSaveYourselfDone(smc_conn, True);
8292 xsmp.save_yourself = False;
8293 }
8294}
8295
8296
8297/*
8298 * Callback to warn us of imminent death.
8299 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008301xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302{
8303 xsmp_close();
8304
Bram Moolenaar0f873732019-12-05 20:28:46 +01008305 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 getout_preserve_modified(0);
8307}
8308
8309
8310/*
8311 * Callback to tell us that save-yourself has completed.
8312 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008314xsmp_save_complete(
8315 SmcConn smc_conn UNUSED,
8316 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317{
8318 xsmp.save_yourself = False;
8319}
8320
8321
8322/*
8323 * Callback to tell us that an instigated shutdown was cancelled
8324 * (maybe even by us)
8325 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008327xsmp_shutdown_cancelled(
8328 SmcConn smc_conn,
8329 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330{
8331 if (xsmp.save_yourself)
8332 SmcSaveYourselfDone(smc_conn, True);
8333 xsmp.save_yourself = False;
8334 xsmp.shutdown = False;
8335}
8336
8337
8338/*
8339 * Callback to tell us that a new ICE connection has been established.
8340 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008342xsmp_ice_connection(
8343 IceConn iceConn,
8344 IcePointer clientData UNUSED,
8345 Bool opening,
8346 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008348 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 if (opening)
8350 {
8351 xsmp_icefd = IceConnectionNumber(iceConn);
8352 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
8353 }
8354}
8355
8356
Bram Moolenaar0f873732019-12-05 20:28:46 +01008357// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 int
Bram Moolenaar05540972016-01-30 20:31:25 +01008359xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360{
8361 Bool rep;
8362
8363 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8364 == IceProcessMessagesIOError)
8365 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008366 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008368 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 xsmp_close();
8370 return FAIL;
8371 }
8372 else
8373 return OK;
8374}
8375
8376static int dummy;
8377
Bram Moolenaar0f873732019-12-05 20:28:46 +01008378// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 void
8380xsmp_init(void)
8381{
8382 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 SmcCallbacks smcallbacks;
8384#if 0
8385 SmPropValue smname;
8386 SmProp smnameprop;
8387 SmProp *smprops[1];
8388#endif
8389
8390 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008391 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392
8393 xsmp.save_yourself = xsmp.shutdown = False;
8394
Bram Moolenaar0f873732019-12-05 20:28:46 +01008395 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8397 smcallbacks.save_yourself.client_data = NULL;
8398 smcallbacks.die.callback = xsmp_die;
8399 smcallbacks.die.client_data = NULL;
8400 smcallbacks.save_complete.callback = xsmp_save_complete;
8401 smcallbacks.save_complete.client_data = NULL;
8402 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8403 smcallbacks.shutdown_cancelled.client_data = NULL;
8404
Bram Moolenaar0f873732019-12-05 20:28:46 +01008405 // Set up a watch on ICE connection creations. The "dummy" argument is
8406 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8408 {
8409 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008410 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 return;
8412 }
8413
Bram Moolenaar0f873732019-12-05 20:28:46 +01008414 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 xsmp.smcconn = SmcOpenConnection(
8416 NULL,
8417 NULL,
8418 SmProtoMajor,
8419 SmProtoMinor,
8420 SmcSaveYourselfProcMask | SmcDieProcMask
8421 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8422 &smcallbacks,
8423 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008424 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008425 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 errorstring);
8427 if (xsmp.smcconn == NULL)
8428 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008430 {
Bram Moolenaare1be1182020-10-24 13:30:51 +02008431 char errorreport[132];
8432
8433 // If the message is too long it might not be NUL terminated. Add
8434 // a NUL at the end to make sure we don't go over the end.
8435 errorstring[sizeof(errorstring) - 1] = NUL;
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008436 vim_snprintf(errorreport, sizeof(errorreport),
8437 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008438 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008439 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 return;
8441 }
8442 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8443
8444#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008445 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 smname.value = "vim";
8447 smname.length = 3;
8448 smnameprop.name = "SmProgram";
8449 smnameprop.type = "SmARRAY8";
8450 smnameprop.num_vals = 1;
8451 smnameprop.vals = &smname;
8452
8453 smprops[0] = &smnameprop;
8454 SmcSetProperties(xsmp.smcconn, 1, smprops);
8455#endif
8456}
8457
8458
Bram Moolenaar0f873732019-12-05 20:28:46 +01008459// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008461xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008463 if (xsmp_icefd == -1)
8464 return;
8465
8466 SmcCloseConnection(xsmp.smcconn, 0, NULL);
8467 if (xsmp.clientid != NULL)
8468 free(xsmp.clientid);
8469 xsmp.clientid = NULL;
8470 xsmp_icefd = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008472#endif // USE_XSMP
Paul Ollis65745772022-06-05 16:55:54 +01008473
8474#if defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar08210f82023-04-13 19:15:54 +01008475# if defined(PROF_NSEC) || defined(PROTO)
Paul Ollis65745772022-06-05 16:55:54 +01008476/*
8477 * Implement timeout with timer_create() and timer_settime().
8478 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008479static volatile sig_atomic_t timeout_flag = FALSE;
8480static timer_t timer_id;
8481static int timer_created = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008482
8483/*
8484 * Callback for when the timer expires.
8485 */
8486 static void
8487set_flag(union sigval _unused UNUSED)
8488{
8489 timeout_flag = TRUE;
8490}
8491
8492/*
8493 * Stop any active timeout.
8494 */
8495 void
8496stop_timeout(void)
8497{
8498 static struct itimerspec disarm = {{0, 0}, {0, 0}};
8499
8500 if (timer_created)
8501 {
8502 int ret = timer_settime(timer_id, 0, &disarm, NULL);
8503
8504 if (ret < 0)
8505 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8506 }
8507
8508 // Clear the current timeout flag; any previous timeout should be
8509 // considered _not_ triggered.
8510 timeout_flag = FALSE;
8511}
8512
8513/*
8514 * Start the timeout timer.
8515 *
8516 * The return value is a pointer to a flag that is initialised to FALSE. If the
8517 * timeout expires, the flag is set to TRUE. This will only return pointers to
8518 * static memory; i.e. any pointer returned by this function may always be
8519 * safely dereferenced.
8520 *
8521 * This function is not expected to fail, but if it does it will still return a
8522 * valid flag pointer; the flag will remain stuck as FALSE .
8523 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008524 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008525start_timeout(long msec)
8526{
8527 struct itimerspec interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008528 {0, 0}, // Do not repeat.
8529 {msec / 1000, (msec % 1000) * 1000000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008530 int ret;
8531
8532 // This is really the caller's responsibility, but let's make sure the
8533 // previous timer has been stopped.
8534 stop_timeout();
Paul Ollis65745772022-06-05 16:55:54 +01008535
8536 if (!timer_created)
8537 {
8538 struct sigevent action = {0};
8539
8540 action.sigev_notify = SIGEV_THREAD;
8541 action.sigev_notify_function = set_flag;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008542 ret = timer_create(CLOCK_MONOTONIC, &action, &timer_id);
8543 if (ret < 0)
Paul Ollis65745772022-06-05 16:55:54 +01008544 {
8545 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8546 return &timeout_flag;
8547 }
8548 timer_created = TRUE;
8549 }
8550
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00008551# ifdef FEAT_EVAL
Bram Moolenaar616592e2022-06-17 15:17:10 +01008552 ch_log(NULL, "setting timeout timer to %d sec %ld nsec",
8553 (int)interval.it_value.tv_sec, (long)interval.it_value.tv_nsec);
Bram Moolenaar509ce032022-06-20 11:23:01 +01008554# endif
Paul Ollis65745772022-06-05 16:55:54 +01008555 ret = timer_settime(timer_id, 0, &interval, NULL);
8556 if (ret < 0)
8557 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8558
8559 return &timeout_flag;
8560}
8561
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008562/*
8563 * To be used before fork/exec: delete any created timer.
8564 */
8565 void
8566delete_timer(void)
8567{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008568 if (!timer_created)
8569 return;
8570
8571 timer_delete(timer_id);
8572 timer_created = FALSE;
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008573}
8574
Bram Moolenaar08210f82023-04-13 19:15:54 +01008575# else // PROF_NSEC
Paul Ollis65745772022-06-05 16:55:54 +01008576
8577/*
8578 * Implement timeout with setitimer()
8579 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008580static struct sigaction prev_sigaction;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008581static volatile sig_atomic_t timeout_flag = FALSE;
8582static int timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008583static int timer_handler_active = FALSE;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008584static volatile sig_atomic_t alarm_pending = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008585
8586/*
8587 * Handle SIGALRM for a timeout.
8588 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01008589 static void
Paul Ollis65745772022-06-05 16:55:54 +01008590set_flag SIGDEFARG(sigarg)
8591{
8592 if (alarm_pending)
8593 alarm_pending = FALSE;
8594 else
8595 timeout_flag = TRUE;
8596}
8597
8598/*
8599 * Stop any active timeout.
8600 */
8601 void
8602stop_timeout(void)
8603{
8604 static struct itimerval disarm = {{0, 0}, {0, 0}};
8605 int ret;
8606
8607 if (timer_active)
8608 {
8609 timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008610 ret = setitimer(ITIMER_REAL, &disarm, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008611 if (ret < 0)
8612 // Should only get here as a result of coding errors.
8613 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8614 }
8615
8616 if (timer_handler_active)
8617 {
8618 timer_handler_active = FALSE;
8619 ret = sigaction(SIGALRM, &prev_sigaction, NULL);
8620 if (ret < 0)
8621 // Should only get here as a result of coding errors.
8622 semsg(_(e_could_not_reset_handler_for_timeout_str),
8623 strerror(errno));
8624 }
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008625 timeout_flag = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008626}
8627
8628/*
8629 * Start the timeout timer.
8630 *
8631 * The return value is a pointer to a flag that is initialised to FALSE. If the
8632 * timeout expires, the flag is set to TRUE. This will only return pointers to
8633 * static memory; i.e. any pointer returned by this function may always be
8634 * safely dereferenced.
8635 *
8636 * This function is not expected to fail, but if it does it will still return a
8637 * valid flag pointer; the flag will remain stuck as FALSE .
8638 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008639 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008640start_timeout(long msec)
8641{
8642 struct itimerval interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008643 {0, 0}, // Do not repeat.
8644 {msec / 1000, (msec % 1000) * 1000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008645 struct sigaction handle_alarm;
8646 int ret;
8647 sigset_t sigs;
8648 sigset_t saved_sigs;
8649
8650 // This is really the caller's responsibility, but let's make sure the
8651 // previous timer has been stopped.
8652 stop_timeout();
8653
8654 // There is a small chance that SIGALRM is pending and so the handler must
8655 // ignore it on the first call.
8656 alarm_pending = FALSE;
8657 ret = sigemptyset(&sigs);
8658 ret = ret == 0 ? sigaddset(&sigs, SIGALRM) : ret;
8659 ret = ret == 0 ? sigprocmask(SIG_BLOCK, &sigs, &saved_sigs) : ret;
8660 timeout_flag = FALSE;
8661 ret = ret == 0 ? sigpending(&sigs) : ret;
8662 if (ret == 0)
8663 {
8664 alarm_pending = sigismember(&sigs, SIGALRM);
Bram Moolenaar1f89abf2022-06-06 10:07:01 +01008665 ret = sigprocmask(SIG_SETMASK, &saved_sigs, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008666 }
8667 if (unlikely(ret != 0 || alarm_pending < 0))
8668 {
8669 // Just catching coding errors. Write an error message, but carry on.
8670 semsg(_(e_could_not_check_for_pending_sigalrm_str), strerror(errno));
8671 alarm_pending = FALSE;
8672 }
8673
8674 // Set up the alarm handler first.
8675 ret = sigemptyset(&handle_alarm.sa_mask);
8676 handle_alarm.sa_handler = set_flag;
8677 handle_alarm.sa_flags = 0;
8678 ret = ret == 0 ? sigaction(SIGALRM, &handle_alarm, &prev_sigaction) : ret;
8679 if (ret < 0)
8680 {
8681 // Should only get here as a result of coding errors.
8682 semsg(_(e_could_not_set_handler_for_timeout_str), strerror(errno));
8683 return &timeout_flag;
8684 }
8685 timer_handler_active = TRUE;
8686
8687 // Set up the interval timer once the alarm handler is in place.
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008688 ret = setitimer(ITIMER_REAL, &interval, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008689 if (ret < 0)
8690 {
8691 // Should only get here as a result of coding errors.
8692 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8693 stop_timeout();
8694 return &timeout_flag;
8695 }
8696
8697 timer_active = TRUE;
8698 return &timeout_flag;
8699}
Bram Moolenaar08210f82023-04-13 19:15:54 +01008700# endif // PROF_NSEC
Paul Ollis65745772022-06-05 16:55:54 +01008701#endif // FEAT_RELTIME