blob: 9d8d466507ca759a66ad8608ff7794ccd1a5de53 [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
Bram Moolenaar5bd32f42014-04-02 14:05:38 +020038#ifdef HAVE_SMACK
39# include <attr/xattr.h>
40# include <linux/xattr.h>
41# ifndef SMACK_LABEL_LEN
42# define SMACK_LABEL_LEN 1024
43# endif
44#endif
45
Bram Moolenaara2442432007-04-26 14:26:37 +000046#ifdef __CYGWIN__
K.Takata972db232022-02-04 10:45:38 +000047# include <cygwin/version.h>
48# include <sys/cygwin.h> // for cygwin_conv_to_posix_path() and/or
Bram Moolenaar0f873732019-12-05 20:28:46 +010049 // for cygwin_conv_path()
K.Takata972db232022-02-04 10:45:38 +000050# ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
51# define WIN32_LEAN_AND_MEAN
52# include <windows.h>
53# include "winclip.pro"
Bram Moolenaara2442432007-04-26 14:26:37 +000054# endif
55#endif
56
Bram Moolenaar071d4272004-06-13 20:20:40 +000057#ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +000058
Bram Moolenaar071d4272004-06-13 20:20:40 +000059# include <gpm.h>
Bram Moolenaar33fc4a62022-02-23 18:07:38 +000060
61# ifdef DYNAMIC_GPM
62# define Gpm_Open (*dll_Gpm_Open)
63# define Gpm_Close (*dll_Gpm_Close)
64# define Gpm_GetEvent (*dll_Gpm_GetEvent)
65# define gpm_flag (dll_gpm_flag != NULL ? *dll_gpm_flag : 0)
66# define gpm_fd (dll_gpm_fd != NULL ? *dll_gpm_fd : -1)
67
68static int (*dll_Gpm_Open) (Gpm_Connect *, int);
69static int (*dll_Gpm_Close) (void);
70static int (*dll_Gpm_GetEvent) (Gpm_Event *);
71static int *dll_gpm_flag;
72static int *dll_gpm_fd;
73
74static void *libgpm_hinst;
75# endif
76
Bram Moolenaar0f873732019-12-05 20:28:46 +010077// <linux/keyboard.h> contains defines conflicting with "keymap.h",
78// I just copied relevant defines here. A cleaner solution would be to put gpm
79// code into separate file and include there linux/keyboard.h
80// #include <linux/keyboard.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000081# define KG_SHIFT 0
82# define KG_CTRL 2
83# define KG_ALT 3
84# define KG_ALTGR 1
85# define KG_SHIFTL 4
86# define KG_SHIFTR 5
87# define KG_CTRLL 6
88# define KG_CTRLR 7
89# define KG_CAPSSHIFT 8
90
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010091static void gpm_close(void);
92static int gpm_open(void);
93static int mch_gpm_process(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000094#endif
95
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000096#ifdef FEAT_SYSMOUSE
97# include <sys/consio.h>
98# include <sys/fbio.h>
99
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100100static int sysmouse_open(void);
101static void sysmouse_close(void);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100102static void sig_sysmouse SIGPROTOARG;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000103#endif
104
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105/*
106 * end of autoconf section. To be extended...
107 */
108
Bram Moolenaar0f873732019-12-05 20:28:46 +0100109// Are the following #ifdefs still required? And why? Is that for X11?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110
111#if defined(ESIX) || defined(M_UNIX) && !defined(SCO)
112# ifdef SIGWINCH
113# undef SIGWINCH
114# endif
115# ifdef TIOCGWINSZ
116# undef TIOCGWINSZ
117# endif
118#endif
119
Bram Moolenaar0f873732019-12-05 20:28:46 +0100120#if defined(SIGWINDOW) && !defined(SIGWINCH) // hpux 9.01 has it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121# define SIGWINCH SIGWINDOW
122#endif
123
124#ifdef FEAT_X11
125# include <X11/Xlib.h>
126# include <X11/Xutil.h>
127# include <X11/Xatom.h>
128# ifdef FEAT_XCLIPBOARD
129# include <X11/Intrinsic.h>
130# include <X11/Shell.h>
131# include <X11/StringDefs.h>
132static Widget xterm_Shell = (Widget)0;
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100133static void clip_update(void);
134static void xterm_update(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135# endif
136
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137Window x11_window = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138Display *x11_display = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139#endif
140
Bram Moolenaar5c3128e2020-05-11 20:54:42 +0200141static int ignore_sigtstp = FALSE;
142
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100143static int get_x11_title(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
145static char_u *oldtitle = NULL;
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200146static volatile sig_atomic_t oldtitle_outdated = FALSE;
Bram Moolenaardac13472019-09-16 21:06:21 +0200147static int unix_did_set_title = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148static char_u *oldicon = NULL;
149static int did_set_icon = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100151static void may_core_dump(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152
Bram Moolenaar205b8862011-09-07 15:04:31 +0200153#ifdef HAVE_UNION_WAIT
154typedef union wait waitstatus;
155#else
156typedef int waitstatus;
157#endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200158static int WaitForChar(long msec, int *interrupted, int ignore_input);
159static int WaitForCharOrMouse(long msec, int *interrupted, int ignore_input);
Bram Moolenaar041c7102020-05-30 18:14:57 +0200160#ifdef VMS
Bram Moolenaarcda77642016-06-04 13:32:35 +0200161int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162#else
Bram Moolenaarcda77642016-06-04 13:32:35 +0200163static int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164#endif
165
166#ifdef FEAT_XCLIPBOARD
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100167static int do_xterm_trace(void);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100168# define XT_TRACE_DELAY 50 // delay for xterm tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169#endif
170
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100171static void handle_resize(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172
173#if defined(SIGWINCH)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100174static void sig_winch SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175#endif
dbivolaruab16ad32021-12-29 19:41:47 +0000176#if defined(SIGTSTP)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100177static void sig_tstp SIGPROTOARG;
Bram Moolenaarabd56da2022-06-23 20:46:27 +0100178// volatile because it is used in signal handler sig_tstp() and
179// sigcont_handler().
dbivolaruab16ad32021-12-29 19:41:47 +0000180static volatile sig_atomic_t in_mch_suspend = FALSE;
181#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182#if defined(SIGINT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100183static void catch_sigint SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200185#if defined(SIGUSR1)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100186static void catch_sigusr1 SIGPROTOARG;
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200187#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188#if defined(SIGPWR)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100189static void catch_sigpwr SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190#endif
Bram Moolenaar651fca82021-11-29 20:39:38 +0000191#if defined(SIGALRM) && defined(FEAT_X11) && !defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192# define SET_SIG_ALARM
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100193static void sig_alarm SIGPROTOARG;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100194// volatile because it is used in signal handler sig_alarm().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200195static volatile sig_atomic_t sig_alarm_called;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196#endif
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100197static void deathtrap SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100199static void catch_int_signal(void);
200static void set_signals(void);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100201static void catch_signals(void (*func_deadly)(), void (*func_other)());
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +0200202#ifdef HAVE_SIGPROCMASK
203# define SIGSET_DECL(set) sigset_t set;
204# define BLOCK_SIGNALS(set) block_signals(set)
205# define UNBLOCK_SIGNALS(set) unblock_signals(set)
206#else
207# define SIGSET_DECL(set)
208# define BLOCK_SIGNALS(set) do { /**/ } while (0)
209# define UNBLOCK_SIGNALS(set) do { /**/ } while (0)
210#endif
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100211static int have_wildcard(int, char_u **);
212static int have_dollars(int, char_u **);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100214static int save_patterns(int num_pat, char_u **pat, int *num_file, char_u ***file);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215
216#ifndef SIG_ERR
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100217# define SIG_ERR ((void (*)())-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218#endif
219
Bram Moolenaar0f873732019-12-05 20:28:46 +0100220// volatile because it is used in signal handler sig_winch().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200221static volatile sig_atomic_t do_resize = FALSE;
dbivolaruab16ad32021-12-29 19:41:47 +0000222// volatile because it is used in signal handler sig_tstp().
223static volatile sig_atomic_t got_tstp = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224static char_u *extra_shell_arg = NULL;
225static int show_shell_mess = TRUE;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100226// volatile because it is used in signal handler deathtrap().
227static volatile sig_atomic_t deadly_signal = 0; // The signal we caught
228// volatile because it is used in signal handler deathtrap().
229static volatile sig_atomic_t in_mch_delay = FALSE; // sleeping in mch_delay()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +0100231#if defined(FEAT_JOB_CHANNEL) && !defined(USE_SYSTEM)
232static int dont_check_job_ended = 0;
233#endif
234
Bram Moolenaar26e86442020-05-17 14:06:16 +0200235// Current terminal mode from mch_settmode(). Can differ from cur_tmode.
236static tmode_T mch_cur_tmode = TMODE_COOK;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237
238#ifdef USE_XSMP
239typedef struct
240{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100241 SmcConn smcconn; // The SM connection ID
242 IceConn iceconn; // The ICE connection ID
243 char *clientid; // The client ID for the current smc session
244 Bool save_yourself; // If we're in the middle of a save_yourself
245 Bool shutdown; // If we're in shutdown mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246} xsmp_config_T;
247
248static xsmp_config_T xsmp;
249#endif
250
251#ifdef SYS_SIGLIST_DECLARED
252/*
253 * I have seen
254 * extern char *_sys_siglist[NSIG];
Yegappan Lakshmananaebc6ef2022-08-27 21:24:26 +0100255 * on Linux, NetBSD and Solaris. It contains a nice list of strings
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256 * that describe the signals. That is nearly what we want here. But
257 * autoconf does only check for sys_siglist (without the underscore), I
258 * do not want to change everything today.... jw.
Bram Moolenaar3f7d0902016-11-12 21:13:42 +0100259 * This is why AC_DECL_SYS_SIGLIST is commented out in configure.ac.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 */
261#endif
262
263static struct signalinfo
264{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100265 int sig; // Signal number, eg. SIGSEGV etc
266 char *name; // Signal name (not char_u!).
267 char deadly; // Catch as a deadly signal?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268} signal_info[] =
269{
270#ifdef SIGHUP
271 {SIGHUP, "HUP", TRUE},
272#endif
273#ifdef SIGQUIT
274 {SIGQUIT, "QUIT", TRUE},
275#endif
276#ifdef SIGILL
277 {SIGILL, "ILL", TRUE},
278#endif
279#ifdef SIGTRAP
280 {SIGTRAP, "TRAP", TRUE},
281#endif
282#ifdef SIGABRT
283 {SIGABRT, "ABRT", TRUE},
284#endif
285#ifdef SIGEMT
286 {SIGEMT, "EMT", TRUE},
287#endif
288#ifdef SIGFPE
289 {SIGFPE, "FPE", TRUE},
290#endif
291#ifdef SIGBUS
292 {SIGBUS, "BUS", TRUE},
293#endif
Bram Moolenaar75676462013-01-30 14:55:42 +0100294#if defined(SIGSEGV) && !defined(FEAT_MZSCHEME)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100295 // MzScheme uses SEGV in its garbage collector
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 {SIGSEGV, "SEGV", TRUE},
297#endif
298#ifdef SIGSYS
299 {SIGSYS, "SYS", TRUE},
300#endif
301#ifdef SIGALRM
Bram Moolenaar0f873732019-12-05 20:28:46 +0100302 {SIGALRM, "ALRM", FALSE}, // Perl's alarm() can trigger it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303#endif
304#ifdef SIGTERM
305 {SIGTERM, "TERM", TRUE},
306#endif
Bram Moolenaarb292a2a2011-02-09 18:47:40 +0100307#if defined(SIGVTALRM) && !defined(FEAT_RUBY)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 {SIGVTALRM, "VTALRM", TRUE},
309#endif
Bram Moolenaar02f07e02008-03-12 12:17:28 +0000310#if defined(SIGPROF) && !defined(FEAT_MZSCHEME) && !defined(WE_ARE_PROFILING)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100311 // MzScheme uses SIGPROF for its own needs; On Linux with profiling
312 // this makes Vim exit. WE_ARE_PROFILING is defined in Makefile.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 {SIGPROF, "PROF", TRUE},
314#endif
315#ifdef SIGXCPU
316 {SIGXCPU, "XCPU", TRUE},
317#endif
318#ifdef SIGXFSZ
319 {SIGXFSZ, "XFSZ", TRUE},
320#endif
321#ifdef SIGUSR1
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200322 {SIGUSR1, "USR1", FALSE},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000324#if defined(SIGUSR2) && !defined(FEAT_SYSMOUSE)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100325 // Used for sysmouse handling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {SIGUSR2, "USR2", TRUE},
327#endif
328#ifdef SIGINT
329 {SIGINT, "INT", FALSE},
330#endif
331#ifdef SIGWINCH
332 {SIGWINCH, "WINCH", FALSE},
333#endif
334#ifdef SIGTSTP
335 {SIGTSTP, "TSTP", FALSE},
336#endif
337#ifdef SIGPIPE
338 {SIGPIPE, "PIPE", FALSE},
339#endif
340 {-1, "Unknown!", FALSE}
341};
342
Bram Moolenaar25724922009-07-14 15:38:41 +0000343 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100344mch_chdir(char *path)
Bram Moolenaar25724922009-07-14 15:38:41 +0000345{
346 if (p_verbose >= 5)
347 {
348 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100349 smsg("chdir(%s)", path);
Bram Moolenaar25724922009-07-14 15:38:41 +0000350 verbose_leave();
351 }
352# ifdef VMS
353 return chdir(vms_fixfilename(path));
354# else
355 return chdir(path);
356# endif
357}
358
Bram Moolenaar0f873732019-12-05 20:28:46 +0100359// Why is NeXT excluded here (and not in os_unixx.h)?
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +0100360#if defined(ECHOE) && defined(ICANON) \
361 && (defined(HAVE_TERMIO_H) || defined(HAVE_TERMIOS_H)) \
362 && !defined(__NeXT__)
Bram Moolenaar4f44b882017-08-13 20:06:18 +0200363# define NEW_TTY_SYSTEM
364#endif
365
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000366/*
Bram Moolenaard23a8232018-02-10 18:45:26 +0100367 * Write s[len] to the screen (stdout).
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000368 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100370mch_write(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371{
Bram Moolenaar42335f52018-09-13 15:33:43 +0200372 vim_ignored = (int)write(1, (char *)s, len);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100373 if (p_wd) // Unix is too fast, slow down a bit more
Bram Moolenaar8fdd7212016-03-26 19:41:48 +0100374 RealWaitForChar(read_cmd_fd, p_wd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375}
376
377/*
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100378 * Function passed to inchar_loop() to handle window resizing.
379 * If "check_only" is TRUE: Return whether there was a resize.
380 * If "check_only" is FALSE: Deal with the window resized.
381 */
382 static int
383resize_func(int check_only)
384{
385 if (check_only)
386 return do_resize;
387 while (do_resize)
388 handle_resize();
389 return FALSE;
390}
391
392/*
Bram Moolenaarc2a27c32007-12-01 16:19:33 +0000393 * mch_inchar(): low level input function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394 * Get a characters from the keyboard.
395 * Return the number of characters that are available.
396 * If wtime == 0 do not wait for characters.
397 * If wtime == n wait a short time for characters.
398 * If wtime == -1 wait forever for characters.
399 */
400 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100401mch_inchar(
402 char_u *buf,
403 int maxlen,
Bram Moolenaar0f873732019-12-05 20:28:46 +0100404 long wtime, // don't use "time", MIPS cannot handle it
Bram Moolenaar05540972016-01-30 20:31:25 +0100405 int tb_change_cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406{
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100407 return inchar_loop(buf, maxlen, wtime, tb_change_cnt,
408 WaitForChar, resize_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409}
410
411 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100412handle_resize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413{
414 do_resize = FALSE;
415 shell_resized();
416}
417
418/*
Bram Moolenaar40b1b542016-04-20 20:18:23 +0200419 * Return non-zero if a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420 */
421 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100422mch_char_avail(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423{
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200424 return WaitForChar(0L, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425}
426
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200427#if defined(FEAT_TERMINAL) || defined(PROTO)
428/*
429 * Check for any pending input or messages.
430 */
431 int
432mch_check_messages(void)
433{
434 return WaitForChar(0L, NULL, TRUE);
435}
436#endif
437
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438#if defined(HAVE_TOTAL_MEM) || defined(PROTO)
439# ifdef HAVE_SYS_RESOURCE_H
Bram Moolenaar8f0b2d42009-05-16 14:41:10 +0000440# include <sys/resource.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441# endif
442# if defined(HAVE_SYS_SYSCTL_H) && defined(HAVE_SYSCTL)
443# include <sys/sysctl.h>
444# endif
445# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
446# include <sys/sysinfo.h>
447# endif
Bram Moolenaar362dc332018-03-05 21:59:37 +0100448# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100449# include <mach/mach_host.h>
450# include <mach/mach_port.h>
Bram Moolenaar988615f2018-02-27 17:58:20 +0100451# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452
453/*
Bram Moolenaar914572a2007-05-01 11:37:47 +0000454 * Return total amount of memory available in Kbyte.
455 * Doesn't change when memory has been allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457 long_u
Bram Moolenaar05540972016-01-30 20:31:25 +0100458mch_total_mem(int special UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 long_u mem = 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100461 long_u shiftright = 10; // how much to shift "mem" right for Kbyte
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462
Bram Moolenaar362dc332018-03-05 21:59:37 +0100463# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100464 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100465 // Mac (Darwin) way of getting the amount of RAM available
Bram Moolenaar988615f2018-02-27 17:58:20 +0100466 mach_port_t host = mach_host_self();
467 kern_return_t kret;
468# ifdef HOST_VM_INFO64
469 struct vm_statistics64 vm_stat;
470 natural_t count = HOST_VM_INFO64_COUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471
Bram Moolenaar988615f2018-02-27 17:58:20 +0100472 kret = host_statistics64(host, HOST_VM_INFO64,
473 (host_info64_t)&vm_stat, &count);
474# else
475 struct vm_statistics vm_stat;
476 natural_t count = HOST_VM_INFO_COUNT;
477
478 kret = host_statistics(host, HOST_VM_INFO,
479 (host_info_t)&vm_stat, &count);
480# endif
481 if (kret == KERN_SUCCESS)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100482 // get the amount of user memory by summing each usage
Bram Moolenaar988615f2018-02-27 17:58:20 +0100483 mem = (long_u)(vm_stat.free_count + vm_stat.active_count
484 + vm_stat.inactive_count
485# ifdef MAC_OS_X_VERSION_10_9
486 + vm_stat.compressor_page_count
487# endif
Bram Moolenaar62b7f6a2018-03-22 21:44:07 +0100488 ) * sysconf(_SC_PAGESIZE);
Bram Moolenaar988615f2018-02-27 17:58:20 +0100489 mach_port_deallocate(mach_task_self(), host);
490 }
491# endif
492
493# ifdef HAVE_SYSCTL
494 if (mem == 0)
495 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100496 // BSD way of getting the amount of RAM available.
Bram Moolenaar988615f2018-02-27 17:58:20 +0100497 int mib[2];
498 size_t len = sizeof(long_u);
499# ifdef HW_USERMEM64
500 long_u physmem;
501# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100502 // sysctl() may return 32 bit or 64 bit, accept both
Bram Moolenaar988615f2018-02-27 17:58:20 +0100503 union {
504 int_u u32;
505 long_u u64;
506 } physmem;
507# endif
508
509 mib[0] = CTL_HW;
510# ifdef HW_USERMEM64
511 mib[1] = HW_USERMEM64;
512# else
513 mib[1] = HW_USERMEM;
514# endif
515 if (sysctl(mib, 2, &physmem, &len, NULL, 0) == 0)
516 {
517# ifdef HW_USERMEM64
518 mem = (long_u)physmem;
519# else
520 if (len == sizeof(physmem.u64))
521 mem = (long_u)physmem.u64;
522 else
523 mem = (long_u)physmem.u32;
524# endif
525 }
526 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200527# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200529# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 if (mem == 0)
531 {
532 struct sysinfo sinfo;
533
Bram Moolenaar0f873732019-12-05 20:28:46 +0100534 // Linux way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535 if (sysinfo(&sinfo) == 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000536 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200537# ifdef HAVE_SYSINFO_MEM_UNIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100538 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000539 while (shiftright > 0 && (sinfo.mem_unit & 1) == 0)
540 {
541 sinfo.mem_unit = sinfo.mem_unit >> 1;
542 --shiftright;
543 }
544 mem = sinfo.totalram * sinfo.mem_unit;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200545# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546 mem = sinfo.totalram;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200547# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000548 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200550# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200552# ifdef HAVE_SYSCONF
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 if (mem == 0)
554 {
555 long pagesize, pagecount;
556
Bram Moolenaar0f873732019-12-05 20:28:46 +0100557 // Solaris way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558 pagesize = sysconf(_SC_PAGESIZE);
559 pagecount = sysconf(_SC_PHYS_PAGES);
560 if (pagesize > 0 && pagecount > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000561 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100562 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000563 while (shiftright > 0 && (pagesize & 1) == 0)
564 {
Bram Moolenaar3d27a452007-05-10 17:44:18 +0000565 pagesize = (long_u)pagesize >> 1;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000566 --shiftright;
567 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 mem = (long_u)pagesize * pagecount;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200571# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
Bram Moolenaar0f873732019-12-05 20:28:46 +0100573 // Return the minimum of the physical memory and the user limit, because
574 // using more than the user limit may cause Vim to be terminated.
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200575# if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576 {
577 struct rlimit rlp;
578
579 if (getrlimit(RLIMIT_DATA, &rlp) == 0
580 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200581# ifdef RLIM_INFINITY
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 && rlp.rlim_cur != RLIM_INFINITY
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200583# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000584 && ((long_u)rlp.rlim_cur >> 10) < (mem >> shiftright)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585 )
Bram Moolenaar914572a2007-05-01 11:37:47 +0000586 {
587 mem = (long_u)rlp.rlim_cur;
588 shiftright = 10;
589 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200591# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593 if (mem > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000594 return mem >> shiftright;
595 return (long_u)0x1fffff;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596}
597#endif
598
Bram Moolenaar0981c872020-08-23 14:28:37 +0200599/*
600 * "flags": MCH_DELAY_IGNOREINPUT - don't read input
601 * MCH_DELAY_SETTMODE - use settmode() even for short delays
602 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603 void
Bram Moolenaar0981c872020-08-23 14:28:37 +0200604mch_delay(long msec, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605{
Bram Moolenaar26e86442020-05-17 14:06:16 +0200606 tmode_T old_tmode;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200607 int call_settmode;
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000608#ifdef FEAT_MZSCHEME
Bram Moolenaar0f873732019-12-05 20:28:46 +0100609 long total = msec; // remember original value
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000610#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611
Bram Moolenaar0981c872020-08-23 14:28:37 +0200612 if (flags & MCH_DELAY_IGNOREINPUT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100614 // Go to cooked mode without echo, to allow SIGINT interrupting us
615 // here. But we don't want QUIT to kill us (CTRL-\ used in a
616 // shell may produce SIGQUIT).
Bram Moolenaar26e86442020-05-17 14:06:16 +0200617 // Only do this if sleeping for more than half a second.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000618 in_mch_delay = TRUE;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200619 call_settmode = mch_cur_tmode == TMODE_RAW
620 && (msec > 500 || (flags & MCH_DELAY_SETTMODE));
621 if (call_settmode)
622 {
623 old_tmode = mch_cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 settmode(TMODE_SLEEP);
Bram Moolenaar80361a52020-10-05 21:39:25 +0200625 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627 /*
628 * Everybody sleeps in a different way...
629 * Prefer nanosleep(), some versions of usleep() can only sleep up to
630 * one second.
631 */
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000632#ifdef FEAT_MZSCHEME
633 do
634 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100635 // if total is large enough, wait by portions in p_mzq
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000636 if (total > p_mzq)
637 msec = p_mzq;
638 else
639 msec = total;
640 total -= msec;
641#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642#ifdef HAVE_NANOSLEEP
643 {
644 struct timespec ts;
645
646 ts.tv_sec = msec / 1000;
647 ts.tv_nsec = (msec % 1000) * 1000000;
648 (void)nanosleep(&ts, NULL);
649 }
650#else
651# ifdef HAVE_USLEEP
652 while (msec >= 1000)
653 {
654 usleep((unsigned int)(999 * 1000));
655 msec -= 999;
656 }
657 usleep((unsigned int)(msec * 1000));
658# else
659# ifndef HAVE_SELECT
660 poll(NULL, 0, (int)msec);
661# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {
663 struct timeval tv;
664
665 tv.tv_sec = msec / 1000;
666 tv.tv_usec = (msec % 1000) * 1000;
Bram Moolenaar0981c872020-08-23 14:28:37 +0200667 // NOTE: Solaris 2.6 has a bug that makes select() hang here. Get
668 // a patch from Sun to fix this. Reported by Gunnar Pedersen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 select(0, NULL, NULL, NULL, &tv);
670 }
Bram Moolenaar0f873732019-12-05 20:28:46 +0100671# endif // HAVE_SELECT
672# endif // HAVE_NANOSLEEP
673#endif // HAVE_USLEEP
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000674#ifdef FEAT_MZSCHEME
675 }
676 while (total > 0);
677#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678
Bram Moolenaar80361a52020-10-05 21:39:25 +0200679 if (call_settmode)
Bram Moolenaar26e86442020-05-17 14:06:16 +0200680 settmode(old_tmode);
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000681 in_mch_delay = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 }
683 else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200684 WaitForChar(msec, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685}
686
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000687#if defined(HAVE_STACK_LIMIT) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 || (!defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGSTACK))
689# define HAVE_CHECK_STACK_GROWTH
690/*
691 * Support for checking for an almost-out-of-stack-space situation.
692 */
693
694/*
695 * Return a pointer to an item on the stack. Used to find out if the stack
696 * grows up or down.
697 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698static int stack_grows_downwards;
699
700/*
701 * Find out if the stack grows upwards or downwards.
702 * "p" points to a variable on the stack of the caller.
703 */
704 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100705check_stack_growth(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706{
707 int i;
708
709 stack_grows_downwards = (p > (char *)&i);
710}
711#endif
712
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000713#if defined(HAVE_STACK_LIMIT) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714static char *stack_limit = NULL;
715
716#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
717# include <pthread.h>
718# include <pthread_np.h>
719#endif
720
721/*
722 * Find out until how var the stack can grow without getting into trouble.
723 * Called when starting up and when switching to the signal stack in
724 * deathtrap().
725 */
726 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100727get_stack_limit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728{
729 struct rlimit rlp;
730 int i;
731 long lim;
732
Bram Moolenaar0f873732019-12-05 20:28:46 +0100733 // Set the stack limit to 15/16 of the allowable size. Skip this when the
734 // limit doesn't fit in a long (rlim_cur might be "long long").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 if (getrlimit(RLIMIT_STACK, &rlp) == 0
736 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
737# ifdef RLIM_INFINITY
738 && rlp.rlim_cur != RLIM_INFINITY
739# endif
740 )
741 {
742 lim = (long)rlp.rlim_cur;
743#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
744 {
745 pthread_attr_t attr;
746 size_t size;
747
Bram Moolenaar0f873732019-12-05 20:28:46 +0100748 // On FreeBSD the initial thread always has a fixed stack size, no
749 // matter what the limits are set to. Normally it's 1 Mbyte.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 pthread_attr_init(&attr);
751 if (pthread_attr_get_np(pthread_self(), &attr) == 0)
752 {
753 pthread_attr_getstacksize(&attr, &size);
754 if (lim > (long)size)
755 lim = (long)size;
756 }
757 pthread_attr_destroy(&attr);
758 }
759#endif
760 if (stack_grows_downwards)
761 {
762 stack_limit = (char *)((long)&i - (lim / 16L * 15L));
763 if (stack_limit >= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100764 // overflow, set to 1/16 of current stack position
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 stack_limit = (char *)((long)&i / 16L);
766 }
767 else
768 {
769 stack_limit = (char *)((long)&i + (lim / 16L * 15L));
770 if (stack_limit <= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100771 stack_limit = NULL; // overflow
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 }
773 }
774}
775
776/*
777 * Return FAIL when running out of stack space.
778 * "p" must point to any variable local to the caller that's on the stack.
779 */
780 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100781mch_stackcheck(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782{
783 if (stack_limit != NULL)
784 {
785 if (stack_grows_downwards)
786 {
787 if (p < stack_limit)
788 return FAIL;
789 }
790 else if (p > stack_limit)
791 return FAIL;
792 }
793 return OK;
794}
795#endif
796
797#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
798/*
799 * Support for using the signal stack.
800 * This helps when we run out of stack space, which causes a SIGSEGV. The
801 * signal handler then must run on another stack, since the normal stack is
802 * completely full.
803 */
804
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805# ifdef HAVE_SIGALTSTACK
Bram Moolenaar0f873732019-12-05 20:28:46 +0100806static stack_t sigstk; // for sigaltstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100808static struct sigstack sigstk; // for sigstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809# endif
810
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200811/*
812 * Get a size of signal stack.
813 * Preference (if available): sysconf > SIGSTKSZ > guessed size
814 */
815static long int get_signal_stack_size()
816{
817# ifdef HAVE_SYSCONF_SIGSTKSZ
818 long int size = -1;
819
820 // return size only if sysconf doesn't return an error
821 if ((size = sysconf(_SC_SIGSTKSZ)) > -1)
822 return size;
823# endif
824
825# ifdef SIGSTKSZ
826 // if sysconf() isn't available or gives error, return SIGSTKSZ
827 // if defined
828 return SIGSTKSZ;
829# endif
830
831 // otherwise guess the size
832 return 8000;
833}
834
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835static char *signal_stack;
836
837 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100838init_signal_stack(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839{
840 if (signal_stack != NULL)
841 {
842# ifdef HAVE_SIGALTSTACK
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843# ifdef HAVE_SS_BASE
844 sigstk.ss_base = signal_stack;
845# else
846 sigstk.ss_sp = signal_stack;
847# endif
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200848 sigstk.ss_size = get_signal_stack_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 sigstk.ss_flags = 0;
850 (void)sigaltstack(&sigstk, NULL);
851# else
852 sigstk.ss_sp = signal_stack;
853 if (stack_grows_downwards)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200854 sigstk.ss_sp += get_signal_stack_size() - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 sigstk.ss_onstack = 0;
856 (void)sigstack(&sigstk, NULL);
857# endif
858 }
859}
860#endif
861
862/*
Bram Moolenaar76243bd2009-03-02 01:47:02 +0000863 * We need correct prototypes for a signal function, otherwise mean compilers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 * will barf when the second argument to signal() is ``wrong''.
865 * Let me try it with a few tricky defines from my own osdef.h (jw).
866 */
867#if defined(SIGWINCH)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100868 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869sig_winch SIGDEFARG(sigarg)
870{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100871 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100872 signal(SIGWINCH, (void (*)())sig_winch);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 do_resize = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874}
875#endif
876
dbivolaruab16ad32021-12-29 19:41:47 +0000877#if defined(SIGTSTP)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100878 static void
dbivolaruab16ad32021-12-29 19:41:47 +0000879sig_tstp SIGDEFARG(sigarg)
880{
881 // Second time we get called we actually need to suspend
882 if (in_mch_suspend)
883 {
884 signal(SIGTSTP, ignore_sigtstp ? SIG_IGN : SIG_DFL);
885 raise(sigarg);
886 }
dbivolaru79a6e252022-01-23 16:41:14 +0000887 else
888 got_tstp = TRUE;
dbivolaruab16ad32021-12-29 19:41:47 +0000889
ichizok5f823d12022-03-13 17:27:38 +0000890#if !defined(__ANDROID__) && !defined(__OpenBSD__) && !defined(__DragonFly__)
891 // This is not required on all systems. On some systems (at least Android,
892 // OpenBSD, and DragonFlyBSD) this breaks suspending with CTRL-Z.
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100893 signal(SIGTSTP, (void (*)())sig_tstp);
xtkobacbef12e2022-02-27 12:31:52 +0000894#endif
dbivolaruab16ad32021-12-29 19:41:47 +0000895}
896#endif
897
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898#if defined(SIGINT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100899 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900catch_sigint SIGDEFARG(sigarg)
901{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100902 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100903 signal(SIGINT, (void (*)())catch_sigint);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 got_int = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905}
906#endif
907
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200908#if defined(SIGUSR1)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100909 static void
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200910catch_sigusr1 SIGDEFARG(sigarg)
911{
912 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100913 signal(SIGUSR1, (void (*)())catch_sigusr1);
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200914 got_sigusr1 = TRUE;
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200915}
916#endif
917
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918#if defined(SIGPWR)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100919 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920catch_sigpwr SIGDEFARG(sigarg)
921{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100922 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100923 signal(SIGPWR, (void (*)())catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 /*
925 * I'm not sure we get the SIGPWR signal when the system is really going
926 * down or when the batteries are almost empty. Just preserve the swap
927 * files and don't exit, that can't do any harm.
928 */
929 ml_sync_all(FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930}
931#endif
932
933#ifdef SET_SIG_ALARM
934/*
935 * signal function for alarm().
936 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100937 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938sig_alarm SIGDEFARG(sigarg)
939{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100940 // doesn't do anything, just to break a system call
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 sig_alarm_called = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942}
943#endif
944
Bram Moolenaaredce7422019-01-20 18:39:30 +0100945#if (defined(HAVE_SETJMP_H) \
946 && ((defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) \
947 || defined(FEAT_LIBCALL))) \
948 || defined(PROTO)
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100949# define USING_SETJMP 1
Bram Moolenaaredce7422019-01-20 18:39:30 +0100950
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100951// argument to SETJMP()
952static JMP_BUF lc_jump_env;
953
954# ifdef SIGHASARG
Bram Moolenaar32aa1022019-11-02 22:54:41 +0100955// Caught signal number, 0 when no signal was caught; used for mch_libcall().
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100956// Volatile because it is used in signal handlers.
957static volatile sig_atomic_t lc_signal;
958# endif
959
960// TRUE when lc_jump_env is valid.
961// Volatile because it is used in signal handler deathtrap().
zeertzjq9b7d2a92022-08-26 10:33:54 +0100962static volatile sig_atomic_t lc_active = FALSE;
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100963
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964/*
965 * A simplistic version of setjmp() that only allows one level of using.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100966 * Used to protect areas where we could crash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 * Don't call twice before calling mch_endjmp()!.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100968 *
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 * Usage:
970 * mch_startjmp();
971 * if (SETJMP(lc_jump_env) != 0)
972 * {
973 * mch_didjmp();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100974 * emsg("crash!");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 * }
976 * else
977 * {
978 * do_the_work;
979 * mch_endjmp();
980 * }
981 * Note: Can't move SETJMP() here, because a function calling setjmp() must
982 * not return before the saved environment is used.
983 * Returns OK for normal return, FAIL when the protected code caused a
984 * problem and LONGJMP() was used.
985 */
Bram Moolenaar113e1072019-01-20 15:30:40 +0100986 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100987mch_startjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988{
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100989# ifdef SIGHASARG
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 lc_signal = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100991# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 lc_active = TRUE;
993}
994
Bram Moolenaar113e1072019-01-20 15:30:40 +0100995 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100996mch_endjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997{
998 lc_active = FALSE;
999}
1000
Bram Moolenaar113e1072019-01-20 15:30:40 +01001001 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001002mch_didjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003{
1004# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001005 // On FreeBSD the signal stack has to be reset after using siglongjmp(),
1006 // otherwise catching the signal only works once.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 init_signal_stack();
1008# endif
1009}
1010#endif
1011
1012/*
1013 * This function handles deadly signals.
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001014 * It tries to preserve any swap files and exit properly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 * (partly from Elvis).
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001016 * NOTE: Avoid unsafe functions, such as allocating memory, they can result in
1017 * a deadlock.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001019 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020deathtrap SIGDEFARG(sigarg)
1021{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001022 static int entered = 0; // count the number of times we got here.
1023 // Note: when memory has been corrupted
1024 // this may get an arbitrary value!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025#ifdef SIGHASARG
1026 int i;
1027#endif
1028
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001029#if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 /*
1031 * Catch a crash in protected code.
1032 * Restores the environment saved in lc_jump_env, which looks like
1033 * SETJMP() returns 1.
1034 */
1035 if (lc_active)
1036 {
1037# if defined(SIGHASARG)
1038 lc_signal = sigarg;
1039# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001040 lc_active = FALSE; // don't jump again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 LONGJMP(lc_jump_env, 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001042 // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 }
1044#endif
1045
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001046#ifdef SIGHASARG
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001047# ifdef SIGQUIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001048 // While in mch_delay() we go to cooked mode to allow a CTRL-C to
1049 // interrupt us. But in cooked mode we may also get SIGQUIT, e.g., when
1050 // pressing CTRL-\, but we don't want Vim to exit then.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001051 if (in_mch_delay && sigarg == SIGQUIT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001052 return;
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001053# endif
1054
Bram Moolenaar0f873732019-12-05 20:28:46 +01001055 // When SIGHUP, SIGQUIT, etc. are blocked: postpone the effect and return
1056 // here. This avoids that a non-reentrant function is interrupted, e.g.,
1057 // free(). Calling free() again may then cause a crash.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001058 if (entered == 0
1059 && (0
1060# ifdef SIGHUP
1061 || sigarg == SIGHUP
1062# endif
1063# ifdef SIGQUIT
1064 || sigarg == SIGQUIT
1065# endif
1066# ifdef SIGTERM
1067 || sigarg == SIGTERM
1068# endif
1069# ifdef SIGPWR
1070 || sigarg == SIGPWR
1071# endif
1072# ifdef SIGUSR1
1073 || sigarg == SIGUSR1
1074# endif
1075# ifdef SIGUSR2
1076 || sigarg == SIGUSR2
1077# endif
1078 )
Bram Moolenaar1f28b072005-07-12 22:42:41 +00001079 && !vim_handle_signal(sigarg))
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001080 return;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001081#endif
1082
Bram Moolenaar0f873732019-12-05 20:28:46 +01001083 // Remember how often we have been called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 ++entered;
1085
Bram Moolenaar0f873732019-12-05 20:28:46 +01001086 // Executing autocommands is likely to use more stack space than we have
1087 // available in the signal stack.
Bram Moolenaare429e702016-06-10 19:49:14 +02001088 block_autocmds();
Bram Moolenaare429e702016-06-10 19:49:14 +02001089
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090#ifdef FEAT_EVAL
Bram Moolenaar0f873732019-12-05 20:28:46 +01001091 // Set the v:dying variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 set_vim_var_nr(VV_DYING, (long)entered);
1093#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001094 v_dying = entered;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001096#ifdef HAVE_STACK_LIMIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001097 // Since we are now using the signal stack, need to reset the stack
1098 // limit. Otherwise using a regexp will fail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 get_stack_limit();
1100#endif
1101
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001102#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01001103 // This is for opening gdb the moment Vim crashes.
1104 // You need to manually adjust the file name and Vim executable name.
1105 // Suggested by SungHyun Nam.
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001106 {
1107# define VI_GDB_FILE "/tmp/vimgdb"
1108# define VIM_NAME "/usr/bin/vim"
1109 FILE *fp = fopen(VI_GDB_FILE, "w");
1110 if (fp)
1111 {
1112 fprintf(fp,
1113 "file %s\n"
1114 "attach %d\n"
1115 "set height 1000\n"
1116 "bt full\n"
1117 , VIM_NAME, getpid());
1118 fclose(fp);
1119 system("xterm -e gdb -x "VI_GDB_FILE);
1120 unlink(VI_GDB_FILE);
1121 }
1122 }
1123#endif
1124
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125#ifdef SIGHASARG
Bram Moolenaar0f873732019-12-05 20:28:46 +01001126 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 for (i = 0; signal_info[i].sig != -1; i++)
1128 if (sigarg == signal_info[i].sig)
1129 break;
1130 deadly_signal = sigarg;
1131#endif
1132
Bram Moolenaar0f873732019-12-05 20:28:46 +01001133 full_screen = FALSE; // don't write message to the GUI, it might be
1134 // part of the problem...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 /*
1136 * If something goes wrong after entering here, we may get here again.
1137 * When this happens, give a message and try to exit nicely (resetting the
1138 * terminal mode, etc.)
1139 * When this happens twice, just exit, don't even try to give a message,
1140 * stack may be corrupt or something weird.
1141 * When this still happens again (or memory was corrupted in such a way
1142 * that "entered" was clobbered) use _exit(), don't try freeing resources.
1143 */
1144 if (entered >= 3)
1145 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001146 reset_signals(); // don't catch any signals anymore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 may_core_dump();
1148 if (entered >= 4)
1149 _exit(8);
1150 exit(7);
1151 }
1152 if (entered == 2)
1153 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001154 // No translation, it may call malloc().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001155 OUT_STR("Vim: Double signal, exiting\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 out_flush();
1157 getout(1);
1158 }
1159
Bram Moolenaar0f873732019-12-05 20:28:46 +01001160 // No translation, it may call malloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161#ifdef SIGHASARG
Bram Moolenaar69212b12020-05-10 14:14:03 +02001162 sprintf((char *)IObuff, "Vim: Caught deadly signal %s\r\n",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 signal_info[i].name);
1164#else
Bram Moolenaar69212b12020-05-10 14:14:03 +02001165 sprintf((char *)IObuff, "Vim: Caught deadly signal\r\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166#endif
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001167
Bram Moolenaar0f873732019-12-05 20:28:46 +01001168 // Preserve files and exit. This sets the really_exiting flag to prevent
1169 // calling free().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001170 preserve_exit();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171
Bram Moolenaar0f873732019-12-05 20:28:46 +01001172 // NOTREACHED
Bram Moolenaare429e702016-06-10 19:49:14 +02001173
Bram Moolenaar009b2592004-10-24 19:18:58 +00001174#ifdef NBDEBUG
1175 reset_signals();
1176 may_core_dump();
1177 abort();
1178#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179}
1180
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02001182 * Invoked after receiving SIGCONT. We don't know what happened while
1183 * sleeping, deal with part of that.
1184 */
1185 static void
1186after_sigcont(void)
1187{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001188 // Don't change "oldtitle" in a signal handler, set a flag to obtain it
1189 // again later.
1190 oldtitle_outdated = TRUE;
Bram Moolenaar651fca82021-11-29 20:39:38 +00001191
Bram Moolenaar2e310482018-08-21 13:09:10 +02001192 settmode(TMODE_RAW);
1193 need_check_timestamps = TRUE;
1194 did_check_timestamps = FALSE;
1195}
1196
1197#if defined(SIGCONT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001198static void sigcont_handler SIGPROTOARG;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001199
1200/*
1201 * With multi-threading, suspending might not work immediately. Catch the
1202 * SIGCONT signal, which will be used as an indication whether the suspending
1203 * has been done or not.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001204 *
1205 * On Linux, signal is not always handled immediately either.
1206 * See https://bugs.launchpad.net/bugs/291373
Bram Moolenaar2e310482018-08-21 13:09:10 +02001207 * Probably because the signal is handled in another thread.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001208 *
Bram Moolenaarb292a2a2011-02-09 18:47:40 +01001209 * volatile because it is used in signal handler sigcont_handler().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 */
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001211static volatile sig_atomic_t sigcont_received;
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001212static void sigcont_handler SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213
1214/*
1215 * signal handler for SIGCONT
1216 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001217 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218sigcont_handler SIGDEFARG(sigarg)
1219{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001220 if (in_mch_suspend)
1221 {
1222 sigcont_received = TRUE;
1223 }
1224 else
1225 {
1226 // We didn't suspend ourselves, assume we were stopped by a SIGSTOP
1227 // signal (which can't be intercepted) and get a SIGCONT. Need to get
1228 // back to a sane mode. We should redraw, but we can't really do that
1229 // in a signal handler, do a redraw later.
1230 after_sigcont();
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001231 redraw_later(UPD_CLEAR);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001232 cursor_on_force();
1233 out_flush();
1234 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235}
1236#endif
1237
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02001238#if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001239# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001240static void *clip_star_save = NULL;
1241static void *clip_plus_save = NULL;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001242# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001243
1244/*
1245 * Called when Vim is going to sleep or execute a shell command.
1246 * We can't respond to requests for the X selections. Lose them, otherwise
1247 * other applications will hang. But first copy the text to cut buffer 0.
1248 */
1249 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001250loose_clipboard(void)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001251{
1252 if (clip_star.owned || clip_plus.owned)
1253 {
1254 x11_export_final_selection();
1255 if (clip_star.owned)
1256 clip_lose_selection(&clip_star);
1257 if (clip_plus.owned)
1258 clip_lose_selection(&clip_plus);
1259 if (x11_display != NULL)
1260 XFlush(x11_display);
1261 }
1262}
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001263
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001264# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001265/*
1266 * Save clipboard text to restore later.
1267 */
1268 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001269save_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001270{
1271 if (clip_star.owned)
1272 clip_star_save = get_register('*', TRUE);
1273 if (clip_plus.owned)
1274 clip_plus_save = get_register('+', TRUE);
1275}
1276
1277/*
1278 * Restore clipboard text if no one own the X selection.
1279 */
1280 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001281restore_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001282{
1283 if (clip_star_save != NULL)
1284 {
1285 if (!clip_gen_owner_exists(&clip_star))
1286 put_register('*', clip_star_save);
1287 else
1288 free_register(clip_star_save);
1289 clip_star_save = NULL;
1290 }
1291 if (clip_plus_save != NULL)
1292 {
1293 if (!clip_gen_owner_exists(&clip_plus))
1294 put_register('+', clip_plus_save);
1295 else
1296 free_register(clip_plus_save);
1297 clip_plus_save = NULL;
1298 }
1299}
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001300# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001301#endif
1302
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303/*
1304 * If the machine has job control, use it to suspend the program,
1305 * otherwise fake it by starting a new shell.
1306 */
1307 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001308mch_suspend(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309{
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001310 if (ignore_sigtstp)
1311 return;
1312
Bram Moolenaar041c7102020-05-30 18:14:57 +02001313#if defined(SIGTSTP)
Bram Moolenaar2e310482018-08-21 13:09:10 +02001314 in_mch_suspend = TRUE;
1315
Bram Moolenaar0f873732019-12-05 20:28:46 +01001316 out_flush(); // needed to make cursor visible on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 settmode(TMODE_COOK);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001318 out_flush(); // needed to disable mouse on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319
1320# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001321 loose_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001323# if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 sigcont_received = FALSE;
1325# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001326
Bram Moolenaar0f873732019-12-05 20:28:46 +01001327 kill(0, SIGTSTP); // send ourselves a STOP signal
Bram Moolenaar2e310482018-08-21 13:09:10 +02001328
1329# if defined(SIGCONT)
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001330 /*
1331 * Wait for the SIGCONT signal to be handled. It generally happens
Bram Moolenaar2e310482018-08-21 13:09:10 +02001332 * immediately, but somehow not all the time, probably because it's handled
1333 * in another thread. Do not call pause() because there would be race
1334 * condition which would hang Vim if signal happened in between the test of
1335 * sigcont_received and the call to pause(). If signal is not yet received,
1336 * sleep 0, 1, 2, 3 ms. Don't bother waiting further if signal is not
1337 * received after 1+2+3 ms (not expected to happen).
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001338 */
1339 {
Bram Moolenaar262735e2009-07-14 10:20:22 +00001340 long wait_time;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001341
Bram Moolenaar262735e2009-07-14 10:20:22 +00001342 for (wait_time = 0; !sigcont_received && wait_time <= 3L; wait_time++)
Bram Moolenaar0981c872020-08-23 14:28:37 +02001343 mch_delay(wait_time, 0);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001344 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001346 in_mch_suspend = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347
Bram Moolenaar2e310482018-08-21 13:09:10 +02001348 after_sigcont();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349#else
1350 suspend_shell();
1351#endif
1352}
1353
1354 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001355mch_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356{
1357 Columns = 80;
1358 Rows = 24;
1359
1360 out_flush();
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001361
1362#ifdef SIGTSTP
1363 // Check whether we were invoked with SIGTSTP set to be ignored. If it is
1364 // that indicates the shell (or program) that launched us does not support
1365 // tty job control and thus we should ignore that signal. If invoked as a
1366 // restricted editor (e.g., as "rvim") SIGTSTP is always ignored.
1367 ignore_sigtstp = restricted || SIG_IGN == signal(SIGTSTP, SIG_ERR);
1368#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 set_signals();
Bram Moolenaardf177f62005-02-22 08:39:57 +00001370
Bram Moolenaar56718732006-03-15 22:53:57 +00001371#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001372 mac_conv_init();
1373#endif
Bram Moolenaar693e40c2013-02-26 14:56:42 +01001374#ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
1375 win_clip_init();
1376#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377}
1378
1379 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001380set_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381{
1382#if defined(SIGWINCH)
1383 /*
1384 * WINDOW CHANGE signal is handled with sig_winch().
1385 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001386 signal(SIGWINCH, (void (*)())sig_winch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387#endif
1388
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389#ifdef SIGTSTP
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001390 // See mch_init() for the conditions under which we ignore SIGTSTP.
Bram Moolenaar8e4af852022-01-24 12:20:45 +00001391 // In the GUI default TSTP processing is OK.
1392 // Checking both gui.in_use and gui.starting because gui.in_use is not set
1393 // at this point (set after menus are displayed), but gui.starting is set.
1394 signal(SIGTSTP, ignore_sigtstp ? SIG_IGN
1395# ifdef FEAT_GUI
1396 : gui.in_use || gui.starting ? SIG_DFL
1397# endif
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001398 : (void (*)())sig_tstp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399#endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001400#if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 signal(SIGCONT, sigcont_handler);
1402#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001403#ifdef SIGPIPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 /*
1405 * We want to ignore breaking of PIPEs.
1406 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 signal(SIGPIPE, SIG_IGN);
1408#endif
1409
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410#ifdef SIGINT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001411 catch_int_signal();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412#endif
1413
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001414#ifdef SIGUSR1
1415 /*
1416 * Call user's handler on SIGUSR1
1417 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001418 signal(SIGUSR1, (void (*)())catch_sigusr1);
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001419#endif
1420
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 /*
1422 * Ignore alarm signals (Perl's alarm() generates it).
1423 */
1424#ifdef SIGALRM
1425 signal(SIGALRM, SIG_IGN);
1426#endif
1427
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001428#ifdef SIGPWR
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 /*
1430 * Catch SIGPWR (power failure?) to preserve the swap files, so that no
1431 * work will be lost.
1432 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001433 signal(SIGPWR, (void (*)())catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434#endif
1435
1436 /*
1437 * Arrange for other signals to gracefully shutdown Vim.
1438 */
1439 catch_signals(deathtrap, SIG_ERR);
1440
1441#if defined(FEAT_GUI) && defined(SIGHUP)
1442 /*
1443 * When the GUI is running, ignore the hangup signal.
1444 */
1445 if (gui.in_use)
1446 signal(SIGHUP, SIG_IGN);
1447#endif
1448}
1449
Bram Moolenaardf177f62005-02-22 08:39:57 +00001450#if defined(SIGINT) || defined(PROTO)
1451/*
1452 * Catch CTRL-C (only works while in Cooked mode).
1453 */
1454 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001455catch_int_signal(void)
Bram Moolenaardf177f62005-02-22 08:39:57 +00001456{
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001457 signal(SIGINT, (void (*)())catch_sigint);
Bram Moolenaardf177f62005-02-22 08:39:57 +00001458}
1459#endif
1460
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001462reset_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463{
1464 catch_signals(SIG_DFL, SIG_DFL);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001465#if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001466 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 signal(SIGCONT, SIG_DFL);
1468#endif
1469}
1470
1471 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001472catch_signals(
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001473 void (*func_deadly)(),
1474 void (*func_other)())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475{
1476 int i;
1477
1478 for (i = 0; signal_info[i].sig != -1; i++)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001479 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 if (signal_info[i].deadly)
1481 {
1482#if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION)
1483 struct sigaction sa;
1484
Bram Moolenaar0f873732019-12-05 20:28:46 +01001485 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 sa.sa_handler = func_deadly;
1487 sigemptyset(&sa.sa_mask);
1488# if defined(__linux__) && defined(_REENTRANT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001489 // On Linux, with glibc compiled for kernel 2.2, there is a bug in
1490 // thread handling in combination with using the alternate stack:
1491 // pthread library functions try to use the stack pointer to
1492 // identify the current thread, causing a SEGV signal, which
1493 // recursively calls deathtrap() and hangs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 sa.sa_flags = 0;
1495# else
1496 sa.sa_flags = SA_ONSTACK;
1497# endif
1498 sigaction(signal_info[i].sig, &sa, NULL);
1499#else
1500# if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGVEC)
1501 struct sigvec sv;
1502
Bram Moolenaar0f873732019-12-05 20:28:46 +01001503 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 sv.sv_handler = func_deadly;
1505 sv.sv_mask = 0;
1506 sv.sv_flags = SV_ONSTACK;
1507 sigvec(signal_info[i].sig, &sv, NULL);
1508# else
1509 signal(signal_info[i].sig, func_deadly);
1510# endif
1511#endif
1512 }
1513 else if (func_other != SIG_ERR)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001514 {
1515 // Deal with non-deadly signals.
1516#ifdef SIGTSTP
1517 signal(signal_info[i].sig,
1518 signal_info[i].sig == SIGTSTP && ignore_sigtstp
1519 ? SIG_IGN : func_other);
1520#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 signal(signal_info[i].sig, func_other);
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001522#endif
1523 }
1524 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525}
1526
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001527#ifdef HAVE_SIGPROCMASK
1528 static void
1529block_signals(sigset_t *set)
1530{
1531 sigset_t newset;
1532 int i;
1533
1534 sigemptyset(&newset);
1535
1536 for (i = 0; signal_info[i].sig != -1; i++)
1537 sigaddset(&newset, signal_info[i].sig);
1538
Bram Moolenaar2e310482018-08-21 13:09:10 +02001539# if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001540 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001541 sigaddset(&newset, SIGCONT);
1542# endif
1543
1544 sigprocmask(SIG_BLOCK, &newset, set);
1545}
1546
1547 static void
1548unblock_signals(sigset_t *set)
1549{
1550 sigprocmask(SIG_SETMASK, set, NULL);
1551}
1552#endif
1553
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554/*
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001555 * Handling of SIGHUP, SIGQUIT and SIGTERM:
Bram Moolenaar9e1d2832007-05-06 12:51:41 +00001556 * "when" == a signal: when busy, postpone and return FALSE, otherwise
1557 * return TRUE
1558 * "when" == SIGNAL_BLOCK: Going to be busy, block signals
1559 * "when" == SIGNAL_UNBLOCK: Going to wait, unblock signals, use postponed
Bram Moolenaar67c53842010-05-22 18:28:27 +02001560 * signal
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001561 * Returns TRUE when Vim should exit.
1562 */
1563 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001564vim_handle_signal(int sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001565{
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001566 static int got_signal = 0;
1567 static int blocked = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001568
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001569 switch (sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001570 {
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001571 case SIGNAL_BLOCK: blocked = TRUE;
1572 break;
1573
1574 case SIGNAL_UNBLOCK: blocked = FALSE;
1575 if (got_signal != 0)
1576 {
1577 kill(getpid(), got_signal);
1578 got_signal = 0;
1579 }
1580 break;
1581
1582 default: if (!blocked)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001583 return TRUE; // exit!
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001584 got_signal = sig;
1585#ifdef SIGPWR
1586 if (sig != SIGPWR)
1587#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001588 got_int = TRUE; // break any loops
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001589 break;
1590 }
1591 return FALSE;
1592}
1593
1594/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 * Check_win checks whether we have an interactive stdout.
1596 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001598mch_check_win(int argc UNUSED, char **argv UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 if (isatty(1))
1601 return OK;
1602 return FAIL;
1603}
1604
1605/*
1606 * Return TRUE if the input comes from a terminal, FALSE otherwise.
1607 */
1608 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001609mch_input_isatty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610{
1611 if (isatty(read_cmd_fd))
1612 return TRUE;
1613 return FALSE;
1614}
1615
1616#ifdef FEAT_X11
1617
Bram Moolenaar651fca82021-11-29 20:39:38 +00001618# if defined(ELAPSED_TIMEVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620/*
1621 * Give a message about the elapsed time for opening the X window.
1622 */
1623 static void
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001624xopen_message(long elapsed_msec)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001626 smsg(_("Opening the X display took %ld msec"), elapsed_msec);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627}
1628# endif
1629#endif
1630
Bram Moolenaar651fca82021-11-29 20:39:38 +00001631#if defined(FEAT_X11)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632/*
1633 * A few functions shared by X11 title and clipboard code.
1634 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635
1636static int got_x_error = FALSE;
1637
1638/*
1639 * X Error handler, otherwise X just exits! (very rude) -- webb
1640 */
1641 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001642x_error_handler(Display *dpy, XErrorEvent *error_event)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643{
Bram Moolenaar843ee412004-06-30 16:16:41 +00001644 XGetErrorText(dpy, error_event->error_code, (char *)IObuff, IOSIZE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 STRCAT(IObuff, _("\nVim: Got X error\n"));
1646
Bram Moolenaarb1062eb2020-05-09 16:11:33 +02001647 // In the GUI we cannot print a message and continue, because no X calls
1648 // are allowed here (causes my system to hang). Silently continuing seems
1649 // like the best alternative. Do preserve files, in case we crash.
1650 ml_sync_all(FALSE, FALSE);
1651
1652#ifdef FEAT_GUI
1653 if (!gui.in_use)
1654#endif
1655 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
Bram Moolenaar0f873732019-12-05 20:28:46 +01001657 return 0; // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658}
1659
1660/*
1661 * Another X Error handler, just used to check for errors.
1662 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001664x_error_check(Display *dpy UNUSED, XErrorEvent *error_event UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665{
1666 got_x_error = TRUE;
1667 return 0;
1668}
1669
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001670/*
1671 * Return TRUE when connection to the X server is desired.
1672 */
1673 static int
1674x_connect_to_server(void)
1675{
1676 // No point in connecting if we are exiting or dying.
1677 if (exiting || v_dying)
1678 return FALSE;
1679
1680#if defined(FEAT_CLIENTSERVER)
1681 if (x_force_connect)
1682 return TRUE;
1683#endif
1684 if (x_no_connect)
1685 return FALSE;
1686
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001687 // Check for a match with "exclude:" from 'clipboard'.
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001688 if (clip_exclude_prog != NULL)
1689 {
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001690 // Just in case we get called recursively, return FALSE. This could
1691 // happen if vpeekc() is used while executing the prog and it causes a
1692 // related callback to be invoked.
1693 if (regprog_in_use(clip_exclude_prog))
1694 return FALSE;
1695
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001696 if (vim_regexec_prog(&clip_exclude_prog, FALSE, T_NAME, (colnr_T)0))
1697 return FALSE;
1698 }
1699 return TRUE;
1700}
1701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001703# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704/*
1705 * An X IO Error handler, used to catch error while opening the display.
1706 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001708x_IOerror_check(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001710 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 LONGJMP(lc_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001712# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001713 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001714# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715}
1716# endif
1717
1718/*
1719 * An X IO Error handler, used to catch terminal errors.
1720 */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001721static int xterm_dpy_retry_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001724x_IOerror_handler(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725{
1726 xterm_dpy = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001727 xterm_dpy_retry_count = 5; // Try reconnecting five times
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 x11_window = 0;
1729 x11_display = NULL;
1730 xterm_Shell = (Widget)0;
1731
Bram Moolenaar0f873732019-12-05 20:28:46 +01001732 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 LONGJMP(x_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001734# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001735 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001736# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737}
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001738
1739/*
1740 * If the X11 connection was lost try to restore it.
1741 * Helps when the X11 server was stopped and restarted while Vim was inactive
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01001742 * (e.g. through tmux).
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001743 */
1744 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001745may_restore_clipboard(void)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001746{
Bram Moolenaar01e51e52018-12-29 13:09:46 +01001747 // No point in restoring the connecting if we are exiting or dying.
1748 if (!exiting && !v_dying && xterm_dpy_retry_count > 0)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001749 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001750 --xterm_dpy_retry_count;
Bram Moolenaar527a6782014-12-17 17:59:31 +01001751
1752# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01001753 // This has been reported to avoid Vim getting stuck.
Bram Moolenaar527a6782014-12-17 17:59:31 +01001754 if (app_context != (XtAppContext)NULL)
1755 {
1756 XtDestroyApplicationContext(app_context);
1757 app_context = (XtAppContext)NULL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001758 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaar527a6782014-12-17 17:59:31 +01001759 }
1760# endif
1761
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001762 setup_term_clip();
1763 get_x11_title(FALSE);
1764 }
1765}
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001766
1767 void
1768ex_xrestore(exarg_T *eap)
1769{
1770 if (eap->arg != NULL && STRLEN(eap->arg) > 0)
1771 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01001772 if (xterm_display_allocated)
1773 vim_free(xterm_display);
1774 xterm_display = (char *)vim_strsave(eap->arg);
1775 xterm_display_allocated = TRUE;
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001776 }
1777 smsg(_("restoring display %s"), xterm_display == NULL
Bram Moolenaar0c5c3fa2019-11-30 22:38:16 +01001778 ? (char *)mch_getenv((char_u *)"DISPLAY") : xterm_display);
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001779
1780 clear_xterm_clip();
1781 x11_window = 0;
1782 xterm_dpy_retry_count = 5; // Try reconnecting five times
1783 may_restore_clipboard();
1784}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785#endif
1786
1787/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 * Test if "dpy" and x11_window are valid by getting the window title.
1789 * I don't actually want it yet, so there may be a simpler call to use, but
1790 * this will cause the error handler x_error_check() to be called if anything
1791 * is wrong, such as the window pointer being invalid (as can happen when the
1792 * user changes his DISPLAY, but not his WINDOWID) -- webb
1793 */
1794 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001795test_x11_window(Display *dpy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796{
1797 int (*old_handler)();
1798 XTextProperty text_prop;
1799
1800 old_handler = XSetErrorHandler(x_error_check);
1801 got_x_error = FALSE;
1802 if (XGetWMName(dpy, x11_window, &text_prop))
1803 XFree((void *)text_prop.value);
1804 XSync(dpy, False);
1805 (void)XSetErrorHandler(old_handler);
1806
1807 if (p_verbose > 0 && got_x_error)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001808 verb_msg(_("Testing the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809
1810 return (got_x_error ? FAIL : OK);
1811}
1812#endif
1813
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814
1815#ifdef FEAT_X11
1816
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01001817static int get_x11_thing(int get_title, int test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
1819/*
1820 * try to get x11 window and display
1821 *
1822 * return FAIL for failure, OK otherwise
1823 */
1824 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001825get_x11_windis(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826{
1827 char *winid;
1828 static int result = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001829#define XD_NONE 0 // x11_display not set here
1830#define XD_HERE 1 // x11_display opened here
1831#define XD_GUI 2 // x11_display used from gui.dpy
1832#define XD_XTERM 3 // x11_display used from xterm_dpy
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 static int x11_display_from = XD_NONE;
1834 static int did_set_error_handler = FALSE;
1835
1836 if (!did_set_error_handler)
1837 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001838 // X just exits if it finds an error otherwise!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 (void)XSetErrorHandler(x_error_handler);
1840 did_set_error_handler = TRUE;
1841 }
1842
Bram Moolenaar9372a112005-12-06 19:59:18 +00001843#if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 if (gui.in_use)
1845 {
1846 /*
1847 * If the X11 display was opened here before, for the window where Vim
1848 * was started, close that one now to avoid a memory leak.
1849 */
1850 if (x11_display_from == XD_HERE && x11_display != NULL)
1851 {
1852 XCloseDisplay(x11_display);
1853 x11_display_from = XD_NONE;
1854 }
1855 if (gui_get_x11_windis(&x11_window, &x11_display) == OK)
1856 {
1857 x11_display_from = XD_GUI;
1858 return OK;
1859 }
1860 x11_display = NULL;
1861 return FAIL;
1862 }
1863 else if (x11_display_from == XD_GUI)
1864 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001865 // GUI must have stopped somehow, clear x11_display
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 x11_window = 0;
1867 x11_display = NULL;
1868 x11_display_from = XD_NONE;
1869 }
1870#endif
1871
Bram Moolenaar0f873732019-12-05 20:28:46 +01001872 // When started with the "-X" argument, don't try connecting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 if (!x_connect_to_server())
1874 return FAIL;
1875
1876 /*
1877 * If WINDOWID not set, should try another method to find out
1878 * what the current window number is. The only code I know for
1879 * this is very complicated.
1880 * We assume that zero is invalid for WINDOWID.
1881 */
1882 if (x11_window == 0 && (winid = getenv("WINDOWID")) != NULL)
1883 x11_window = (Window)atol(winid);
1884
1885#ifdef FEAT_XCLIPBOARD
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001886 if (xterm_dpy == x11_display)
1887 // x11_display may have been set to xterm_dpy elsewhere
1888 x11_display_from = XD_XTERM;
1889
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 if (xterm_dpy != NULL && x11_window != 0)
1891 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001892 // We may have checked it already, but Gnome terminal can move us to
1893 // another window, so we need to check every time.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00001894 if (x11_display_from != XD_XTERM)
1895 {
1896 /*
1897 * If the X11 display was opened here before, for the window where
1898 * Vim was started, close that one now to avoid a memory leak.
1899 */
1900 if (x11_display_from == XD_HERE && x11_display != NULL)
1901 XCloseDisplay(x11_display);
1902 x11_display = xterm_dpy;
1903 x11_display_from = XD_XTERM;
1904 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 if (test_x11_window(x11_display) == FAIL)
1906 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001907 // probably bad $WINDOWID
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 x11_window = 0;
1909 x11_display = NULL;
1910 x11_display_from = XD_NONE;
1911 return FAIL;
1912 }
1913 return OK;
1914 }
1915#endif
1916
1917 if (x11_window == 0 || x11_display == NULL)
1918 result = -1;
1919
Bram Moolenaar0f873732019-12-05 20:28:46 +01001920 if (result != -1) // Have already been here and set this
1921 return result; // Don't do all these X calls again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922
1923 if (x11_window != 0 && x11_display == NULL)
1924 {
1925#ifdef SET_SIG_ALARM
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001926 void (*sig_save)();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927#endif
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001928#ifdef ELAPSED_FUNC
1929 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930
1931 if (p_verbose > 0)
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001932 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933#endif
1934
1935#ifdef SET_SIG_ALARM
1936 /*
1937 * Opening the Display may hang if the DISPLAY setting is wrong, or
1938 * the network connection is bad. Set an alarm timer to get out.
1939 */
1940 sig_alarm_called = FALSE;
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001941 sig_save = (void (*)())signal(SIGALRM, (void (*)())sig_alarm);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 alarm(2);
1943#endif
1944 x11_display = XOpenDisplay(NULL);
1945
1946#ifdef SET_SIG_ALARM
1947 alarm(0);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001948 signal(SIGALRM, (void (*)())sig_save);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949 if (p_verbose > 0 && sig_alarm_called)
Bram Moolenaar563bbea2019-01-22 21:45:40 +01001950 verb_msg(_("Opening the X display timed out"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951#endif
1952 if (x11_display != NULL)
1953 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001954# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001956 {
1957 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001958 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001959 verbose_leave();
1960 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961# endif
1962 if (test_x11_window(x11_display) == FAIL)
1963 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001964 // Maybe window id is bad
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 x11_window = 0;
1966 XCloseDisplay(x11_display);
1967 x11_display = NULL;
1968 }
1969 else
1970 x11_display_from = XD_HERE;
1971 }
1972 }
1973 if (x11_window == 0 || x11_display == NULL)
1974 return (result = FAIL);
Bram Moolenaar727c8762010-10-20 19:17:48 +02001975
1976# ifdef FEAT_EVAL
1977 set_vim_var_nr(VV_WINDOWID, (long)x11_window);
1978# endif
1979
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 return (result = OK);
1981}
1982
1983/*
1984 * Determine original x11 Window Title
1985 */
1986 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001987get_x11_title(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988{
Bram Moolenaar47136d72004-10-12 20:02:24 +00001989 return get_x11_thing(TRUE, test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990}
1991
1992/*
1993 * Determine original x11 Window icon
1994 */
1995 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001996get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997{
1998 int retval = FALSE;
1999
2000 retval = get_x11_thing(FALSE, test_only);
2001
Bram Moolenaar0f873732019-12-05 20:28:46 +01002002 // could not get old icon, use terminal name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 if (oldicon == NULL && !test_only)
2004 {
2005 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002006 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002008 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 }
2010
2011 return retval;
2012}
2013
2014 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01002015get_x11_thing(
Bram Moolenaar0f873732019-12-05 20:28:46 +01002016 int get_title, // get title string
Bram Moolenaar05540972016-01-30 20:31:25 +01002017 int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018{
2019 XTextProperty text_prop;
2020 int retval = FALSE;
2021 Status status;
2022
2023 if (get_x11_windis() == OK)
2024 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002025 // Get window/icon name if any
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 if (get_title)
2027 status = XGetWMName(x11_display, x11_window, &text_prop);
2028 else
2029 status = XGetWMIconName(x11_display, x11_window, &text_prop);
2030
2031 /*
2032 * If terminal is xterm, then x11_window may be a child window of the
2033 * outer xterm window that actually contains the window/icon name, so
2034 * keep traversing up the tree until a window with a title/icon is
2035 * found.
2036 */
Bram Moolenaar4b96df52020-01-26 22:00:26 +01002037 // Previously this was only done for xterm and alike. I don't see a
Bram Moolenaar0f873732019-12-05 20:28:46 +01002038 // reason why it would fail for other terminal emulators.
2039 // if (term_is_xterm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 {
2041 Window root;
2042 Window parent;
2043 Window win = x11_window;
2044 Window *children;
2045 unsigned int num_children;
2046
2047 while (!status || text_prop.value == NULL)
2048 {
2049 if (!XQueryTree(x11_display, win, &root, &parent, &children,
2050 &num_children))
2051 break;
2052 if (children)
2053 XFree((void *)children);
2054 if (parent == root || parent == 0)
2055 break;
2056
2057 win = parent;
2058 if (get_title)
2059 status = XGetWMName(x11_display, win, &text_prop);
2060 else
2061 status = XGetWMIconName(x11_display, win, &text_prop);
2062 }
2063 }
2064 if (status && text_prop.value != NULL)
2065 {
2066 retval = TRUE;
2067 if (!test_only)
2068 {
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002069 if (get_title)
2070 vim_free(oldtitle);
2071 else
2072 vim_free(oldicon);
Bram Moolenaara12a1612019-01-24 16:39:02 +01002073 if (text_prop.encoding == XA_STRING && !has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 if (get_title)
2076 oldtitle = vim_strsave((char_u *)text_prop.value);
2077 else
2078 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 }
2080 else
2081 {
2082 char **cl;
2083 Status transform_status;
2084 int n = 0;
2085
2086 transform_status = XmbTextPropertyToTextList(x11_display,
2087 &text_prop,
2088 &cl, &n);
2089 if (transform_status >= Success && n > 0 && cl[0])
2090 {
2091 if (get_title)
2092 oldtitle = vim_strsave((char_u *) cl[0]);
2093 else
2094 oldicon = vim_strsave((char_u *) cl[0]);
2095 XFreeStringList(cl);
2096 }
2097 else
2098 {
2099 if (get_title)
2100 oldtitle = vim_strsave((char_u *)text_prop.value);
2101 else
2102 oldicon = vim_strsave((char_u *)text_prop.value);
2103 }
2104 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 }
2106 XFree((void *)text_prop.value);
2107 }
2108 }
2109 return retval;
2110}
2111
Bram Moolenaar0f873732019-12-05 20:28:46 +01002112// Xutf8 functions are not available on older systems. Note that on some
2113// systems X_HAVE_UTF8_STRING may be defined in a header file but
2114// Xutf8SetWMProperties() is not in the X11 library. Configure checks for
2115// that and defines HAVE_XUTF8SETWMPROPERTIES.
Bram Moolenaara12a1612019-01-24 16:39:02 +01002116#if defined(X_HAVE_UTF8_STRING)
Bram Moolenaarcbc246a2014-10-11 14:47:26 +02002117# if X_HAVE_UTF8_STRING && HAVE_XUTF8SETWMPROPERTIES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118# define USE_UTF8_STRING
2119# endif
2120#endif
2121
2122/*
2123 * Set x11 Window Title
2124 *
2125 * get_x11_windis() must be called before this and have returned OK
2126 */
2127 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002128set_x11_title(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002130 // XmbSetWMProperties() and Xutf8SetWMProperties() should use a STRING
2131 // when possible, COMPOUND_TEXT otherwise. COMPOUND_TEXT isn't
2132 // supported everywhere and STRING doesn't work for multi-byte titles.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133#ifdef USE_UTF8_STRING
2134 if (enc_utf8)
2135 Xutf8SetWMProperties(x11_display, x11_window, (const char *)title,
2136 NULL, NULL, 0, NULL, NULL, NULL);
2137 else
2138#endif
2139 {
2140#if XtSpecificationRelease >= 4
2141# ifdef FEAT_XFONTSET
2142 XmbSetWMProperties(x11_display, x11_window, (const char *)title,
2143 NULL, NULL, 0, NULL, NULL, NULL);
2144# else
2145 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002146 char *c_title = (char *)title;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147
Bram Moolenaar0f873732019-12-05 20:28:46 +01002148 // directly from example 3-18 "basicwin" of Xlib Programming Manual
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002149 (void)XStringListToTextProperty(&c_title, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 XSetWMProperties(x11_display, x11_window, &text_prop,
2151 NULL, NULL, 0, NULL, NULL, NULL);
2152# endif
2153#else
2154 XStoreName(x11_display, x11_window, (char *)title);
2155#endif
2156 }
2157 XFlush(x11_display);
2158}
2159
2160/*
2161 * Set x11 Window icon
2162 *
2163 * get_x11_windis() must be called before this and have returned OK
2164 */
2165 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002166set_x11_icon(char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002168 // See above for comments about using X*SetWMProperties().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169#ifdef USE_UTF8_STRING
2170 if (enc_utf8)
2171 Xutf8SetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2172 NULL, 0, NULL, NULL, NULL);
2173 else
2174#endif
2175 {
2176#if XtSpecificationRelease >= 4
2177# ifdef FEAT_XFONTSET
2178 XmbSetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2179 NULL, 0, NULL, NULL, NULL);
2180# else
2181 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002182 char *c_icon = (char *)icon;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002184 (void)XStringListToTextProperty(&c_icon, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 XSetWMProperties(x11_display, x11_window, NULL, &text_prop,
2186 NULL, 0, NULL, NULL, NULL);
2187# endif
2188#else
2189 XSetIconName(x11_display, x11_window, (char *)icon);
2190#endif
2191 }
2192 XFlush(x11_display);
2193}
2194
Bram Moolenaar0f873732019-12-05 20:28:46 +01002195#else // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002198get_x11_title(int test_only UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199{
2200 return FALSE;
2201}
2202
2203 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002204get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205{
2206 if (!test_only)
2207 {
2208 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002209 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002211 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 }
2213 return FALSE;
2214}
2215
Bram Moolenaar0f873732019-12-05 20:28:46 +01002216#endif // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
2218 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002219mch_can_restore_title(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220{
2221 return get_x11_title(TRUE);
2222}
2223
2224 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002225mch_can_restore_icon(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226{
2227 return get_x11_icon(TRUE);
2228}
2229
2230/*
2231 * Set the window title and icon.
2232 */
2233 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002234mch_settitle(char_u *title, char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235{
2236 int type = 0;
2237 static int recursive = 0;
2238
Bram Moolenaar0f873732019-12-05 20:28:46 +01002239 if (T_NAME == NULL) // no terminal name (yet)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 return;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002241 if (title == NULL && icon == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 return;
2243
Bram Moolenaar0f873732019-12-05 20:28:46 +01002244 // When one of the X11 functions causes a deadly signal, we get here again
2245 // recursively. Avoid hanging then (something is probably locked).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 if (recursive)
2247 return;
2248 ++recursive;
2249
2250 /*
2251 * if the window ID and the display is known, we may use X11 calls
2252 */
2253#ifdef FEAT_X11
2254 if (get_x11_windis() == OK)
2255 type = 1;
2256#else
Bram Moolenaar097148e2020-08-11 21:58:20 +02002257# if defined(FEAT_GUI_PHOTON) \
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002258 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 if (gui.in_use)
2260 type = 1;
2261# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262#endif
2263
2264 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002265 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 * than x11 calls, because the x11 calls don't always work
2267 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 if ((type || *T_TS != NUL) && title != NULL)
2269 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002270 if (oldtitle_outdated)
2271 {
2272 oldtitle_outdated = FALSE;
2273 VIM_CLEAR(oldtitle);
2274 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 if (oldtitle == NULL
2276#ifdef FEAT_GUI
2277 && !gui.in_use
2278#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002279 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 (void)get_x11_title(FALSE);
2281
Bram Moolenaar0f873732019-12-05 20:28:46 +01002282 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 term_settitle(title);
2284#ifdef FEAT_X11
2285 else
2286# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002287 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002289 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002291#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar097148e2020-08-11 21:58:20 +02002292 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 else
2294 gui_mch_settitle(title, icon);
2295#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002296 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 }
2298
2299 if ((type || *T_CIS != NUL) && icon != NULL)
2300 {
2301 if (oldicon == NULL
2302#ifdef FEAT_GUI
2303 && !gui.in_use
2304#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002305 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 get_x11_icon(FALSE);
2307
2308 if (*T_CIS != NUL)
2309 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002310 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002312 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 out_flush();
2314 }
2315#ifdef FEAT_X11
2316 else
2317# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002318 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002320 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321#endif
2322 did_set_icon = TRUE;
2323 }
2324 --recursive;
2325}
2326
2327/*
2328 * Restore the window/icon title.
2329 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002330 * SAVE_RESTORE_TITLE only restore title
2331 * SAVE_RESTORE_ICON only restore icon
2332 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 */
2334 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002335mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336{
Bram Moolenaardac13472019-09-16 21:06:21 +02002337 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002338
Bram Moolenaar0f873732019-12-05 20:28:46 +01002339 // only restore the title or icon when it has been set
Bram Moolenaardac13472019-09-16 21:06:21 +02002340 mch_settitle(((which & SAVE_RESTORE_TITLE) && unix_did_set_title) ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 (oldtitle ? oldtitle : p_titleold) : NULL,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002342 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
2343
Bram Moolenaare5c83282019-05-03 23:15:37 +02002344 if (do_push_pop)
2345 {
2346 // pop and push from/to the stack
2347 term_pop_title(which);
2348 term_push_title(which);
2349 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350}
2351
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352
2353/*
2354 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002355 * This matches "xterm.*", thus "xterm-256color", "xterm-kitty", etc.
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002356 * Do not consider "xterm-kitty" an xterm, it is not fully xterm compatible,
2357 * using the "xterm-kitty" terminfo entry should work better.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002358 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 */
2360 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002361vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362{
2363 if (name == NULL)
2364 return FALSE;
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002365 return ((STRNICMP(name, "xterm", 5) == 0
2366 && STRNICMP(name, "xterm-kitty", 11) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 || STRNICMP(name, "nxterm", 6) == 0
2368 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002369 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002371 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 || STRCMP(name, "builtin_xterm") == 0);
2373}
2374
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002375#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2376/*
2377 * Return TRUE if "name" appears to be that of a terminal
2378 * known to support the xterm-style mouse protocol.
2379 * Relies on term_is_xterm having been set to its correct value.
2380 */
2381 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002382use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002383{
2384 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002385 && (term_is_xterm
2386 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002387 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar48873ae2021-12-08 21:00:24 +00002388 || STRNICMP(name, "gnome", 5) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002389 || STRICMP(name, "st") == 0
2390 || STRNICMP(name, "st-", 3) == 0
2391 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002392}
2393#endif
2394
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395/*
2396 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2397 * Return 1 for "xterm".
2398 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002399 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002400 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 */
2402 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002403use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002405 if (ttym_flags == TTYM_SGR)
2406 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002407 if (ttym_flags == TTYM_URXVT)
2408 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 if (ttym_flags == TTYM_XTERM2)
2410 return 2;
2411 if (ttym_flags == TTYM_XTERM)
2412 return 1;
2413 return 0;
2414}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002416/*
2417 * Return TRUE if "name" is an iris-ansi terminal name.
2418 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002420vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421{
2422 if (name == NULL)
2423 return FALSE;
2424 return (STRNICMP(name, "iris-ansi", 9) == 0
2425 || STRCMP(name, "builtin_iris-ansi") == 0);
2426}
2427
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002428/*
2429 * Return TRUE if "name" is a vt300-like terminal name.
2430 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002432vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433{
2434 if (name == NULL)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002435 return FALSE;
2436 // Actually all ANSI compatible terminals should be here.
2437 // Catch at least VT1xx - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002438 return ((STRNICMP(name, "vt", 2) == 0
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002439 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 || STRCMP(name, "builtin_vt320") == 0);
2441}
2442
2443/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 * Insert user name in s[len].
2445 * Return OK if a name found.
2446 */
2447 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002448mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449{
2450#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002451 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 return OK;
2453#else
2454 return mch_get_uname(getuid(), s, len);
2455#endif
2456}
2457
2458/*
2459 * Insert user name for "uid" in s[len].
2460 * Return OK if a name found.
2461 */
2462 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002463mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464{
2465#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2466 struct passwd *pw;
2467
2468 if ((pw = getpwuid(uid)) != NULL
2469 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2470 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002471 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 return OK;
2473 }
2474#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002475 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2476 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477}
2478
2479/*
2480 * Insert host name is s[len].
2481 */
2482
2483#ifdef HAVE_SYS_UTSNAME_H
2484 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002485mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486{
2487 struct utsname vutsname;
2488
2489 if (uname(&vutsname) < 0)
2490 *s = NUL;
2491 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002492 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002494#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495
2496# ifdef HAVE_SYS_SYSTEMINFO_H
2497# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2498# endif
2499
2500 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002501mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502{
2503# ifdef VAXC
2504 vaxc$gethostname((char *)s, len);
2505# else
2506 gethostname((char *)s, len);
2507# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002508 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002510#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511
2512/*
2513 * return process ID
2514 */
2515 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002516mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517{
2518 return (long)getpid();
2519}
2520
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002521/*
2522 * return TRUE if process "pid" is still running
2523 */
2524 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002525mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002526{
Bram Moolenaar44dea9d2021-06-23 21:13:20 +02002527 // If there is no error the process must be running.
2528 if (kill(pid, 0) == 0)
2529 return TRUE;
2530#ifdef ESRCH
2531 // If the error is ESRCH then the process is not running.
2532 if (errno == ESRCH)
2533 return FALSE;
2534#endif
2535 // If the process is running and owned by another user we get EPERM. With
2536 // other errors the process might be running, assuming it is then.
2537 return TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002538}
2539
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002542strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543{
2544 extern int sys_nerr;
2545 extern char *sys_errlist[];
2546 static char er[20];
2547
2548 if (err > 0 && err < sys_nerr)
2549 return (sys_errlist[err]);
2550 sprintf(er, "Error %d", err);
2551 return er;
2552}
2553#endif
2554
2555/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002556 * Get name of current directory into buffer "buf" of length "len" bytes.
2557 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 * Return OK for success, FAIL for failure.
2559 */
2560 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002561mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562{
2563#if defined(USE_GETCWD)
2564 if (getcwd((char *)buf, len) == NULL)
2565 {
2566 STRCPY(buf, strerror(errno));
2567 return FAIL;
2568 }
2569 return OK;
2570#else
2571 return (getwd((char *)buf) != NULL ? OK : FAIL);
2572#endif
2573}
2574
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002576 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 *
2578 * return FAIL for failure, OK for success
2579 */
2580 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002581mch_FullName(
2582 char_u *fname,
2583 char_u *buf,
2584 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002585 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586{
2587 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002588#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002590 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002591#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 char_u olddir[MAXPATHL];
2593 char_u *p;
2594 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002595#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002596 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2597 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002598#endif
2599
Bram Moolenaar38323e42007-03-06 19:22:53 +00002600#ifdef VMS
2601 fname = vms_fixfilename(fname);
2602#endif
2603
Bram Moolenaara2442432007-04-26 14:26:37 +00002604#ifdef __CYGWIN__
2605 /*
2606 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2607 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002608# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002609 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2610 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002611 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2612 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002613# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002614 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002615# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002616 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002617#endif
2618
Bram Moolenaar0f873732019-12-05 20:28:46 +01002619 // Expand it if forced or not an absolute path.
2620 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002621 if ((force || !mch_isFullName(fname))
2622 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 {
2624 /*
2625 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002626 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 * This will get the correct path name with "../" things.
2628 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002629 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 {
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002631 if (STRCMP(p, "/..") == 0)
2632 // for "/path/dir/.." include the "/.."
2633 p += 3;
2634
Bram Moolenaar38323e42007-03-06 19:22:53 +00002635#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 /*
2637 * Use fchdir() if possible, it's said to be faster and more
2638 * reliable. But on SunOS 4 it might not work. Check this by
2639 * doing a fchdir() right now.
2640 */
2641 if (!dont_fchdir)
2642 {
2643 fd = open(".", O_RDONLY | O_EXTRA, 0);
2644 if (fd >= 0 && fchdir(fd) < 0)
2645 {
2646 close(fd);
2647 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002648 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 }
2650 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002651#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652
Bram Moolenaar0f873732019-12-05 20:28:46 +01002653 // Only change directory when we are sure we can return to where
2654 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002656#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002658#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 (mch_dirname(olddir, MAXPATHL) == FAIL
2660 || mch_chdir((char *)olddir) != 0))
2661 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002662 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 retval = FAIL;
2664 }
2665 else
2666 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002667 // The directory is copied into buf[], to be able to remove
2668 // the file name without changing it (could be a string in
2669 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 if (p - fname >= len)
2671 retval = FAIL;
2672 else
2673 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002674 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 if (mch_chdir((char *)buf))
Bram Moolenaarc6376c72021-10-03 19:29:48 +01002676 {
2677 // Path does not exist (yet). For a full path fail,
2678 // will use the path as-is. For a relative path use
2679 // the current directory and append the file name.
2680 if (mch_isFullName(fname))
2681 retval = FAIL;
2682 else
2683 p = NULL;
2684 }
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002685 else if (*p == '/')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 fname = p + 1;
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002687 else
2688 fname = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 *buf = NUL;
2690 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 }
2692 }
2693 if (mch_dirname(buf, len) == FAIL)
2694 {
2695 retval = FAIL;
2696 *buf = NUL;
2697 }
2698 if (p != NULL)
2699 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002700#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 if (fd >= 0)
2702 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002703 if (p_verbose >= 5)
2704 {
2705 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002706 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002707 verbose_leave();
2708 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 l = fchdir(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 }
2711 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002712#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 l = mch_chdir((char *)olddir);
2714 if (l != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002715 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 }
itchyny051a40c2021-10-20 10:00:05 +01002717#ifdef HAVE_FCHDIR
2718 if (fd >= 0)
2719 close(fd);
2720#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721
2722 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002723 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002724 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002725#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002726 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002728 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002729#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002731
Bram Moolenaar0f873732019-12-05 20:28:46 +01002732 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002733 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 return FAIL;
2735
Bram Moolenaar0f873732019-12-05 20:28:46 +01002736 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 if (STRCMP(fname, ".") != 0)
2738 STRCAT(buf, fname);
2739
2740 return OK;
2741}
2742
2743/*
2744 * Return TRUE if "fname" does not depend on the current directory.
2745 */
2746 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002747mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002749#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 return ( fname[0] == '/' || fname[0] == '.' ||
2751 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2752 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2753 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002754#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756#endif
2757}
2758
Bram Moolenaar24552be2005-12-10 20:17:30 +00002759#if defined(USE_FNAME_CASE) || defined(PROTO)
2760/*
2761 * Set the case of the file name, if it already exists. This will cause the
2762 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002763 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002764 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002765 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002766fname_case(
2767 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002768 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002769{
2770 struct stat st;
2771 char_u *slash, *tail;
2772 DIR *dirp;
2773 struct dirent *dp;
2774
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002775 if (mch_lstat((char *)name, &st) >= 0)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002776 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002777 // Open the directory where the file is located.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002778 slash = vim_strrchr(name, '/');
2779 if (slash == NULL)
2780 {
2781 dirp = opendir(".");
2782 tail = name;
2783 }
2784 else
2785 {
2786 *slash = NUL;
2787 dirp = opendir((char *)name);
2788 *slash = '/';
2789 tail = slash + 1;
2790 }
2791
2792 if (dirp != NULL)
2793 {
2794 while ((dp = readdir(dirp)) != NULL)
2795 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002796 // Only accept names that differ in case and are the same byte
2797 // length. TODO: accept different length name.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002798 if (STRICMP(tail, dp->d_name) == 0
2799 && STRLEN(tail) == STRLEN(dp->d_name))
2800 {
2801 char_u newname[MAXPATHL + 1];
2802 struct stat st2;
2803
Bram Moolenaar0f873732019-12-05 20:28:46 +01002804 // Verify the inode is equal.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002805 vim_strncpy(newname, name, MAXPATHL);
2806 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2807 MAXPATHL - (tail - name));
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002808 if (mch_lstat((char *)newname, &st2) >= 0
Bram Moolenaar24552be2005-12-10 20:17:30 +00002809 && st.st_ino == st2.st_ino
2810 && st.st_dev == st2.st_dev)
2811 {
2812 STRCPY(tail, dp->d_name);
2813 break;
2814 }
2815 }
2816 }
2817
2818 closedir(dirp);
2819 }
2820 }
2821}
2822#endif
2823
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824/*
2825 * Get file permissions for 'name'.
2826 * Returns -1 when it doesn't exist.
2827 */
2828 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002829mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830{
2831 struct stat statb;
2832
Bram Moolenaar0f873732019-12-05 20:28:46 +01002833 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834#ifdef VMS
2835 if (stat((char *)vms_fixfilename(name), &statb))
2836#else
2837 if (stat((char *)name, &statb))
2838#endif
2839 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002840#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002841 // The top bit makes the value negative, which means the file doesn't
2842 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002843 return statb.st_mode & ~S_ADDACE;
2844#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002846#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847}
2848
2849/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002850 * Set file permission for "name" to "perm".
2851 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 */
2853 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002854mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855{
2856 return (chmod((char *)
2857#ifdef VMS
2858 vms_fixfilename(name),
2859#else
2860 name,
2861#endif
2862 (mode_t)perm) == 0 ? OK : FAIL);
2863}
2864
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002865#if defined(HAVE_FCHMOD) || defined(PROTO)
2866/*
2867 * Set file permission for open file "fd" to "perm".
2868 * Return FAIL for failure, OK otherwise.
2869 */
2870 int
2871mch_fsetperm(int fd, long perm)
2872{
2873 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2874}
2875#endif
2876
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877#if defined(HAVE_ACL) || defined(PROTO)
2878# ifdef HAVE_SYS_ACL_H
2879# include <sys/acl.h>
2880# endif
2881# ifdef HAVE_SYS_ACCESS_H
2882# include <sys/access.h>
2883# endif
2884
2885# ifdef HAVE_SOLARIS_ACL
2886typedef struct vim_acl_solaris_T {
2887 int acl_cnt;
2888 aclent_t *acl_entry;
2889} vim_acl_solaris_T;
2890# endif
2891
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002892#if defined(HAVE_SELINUX) || defined(PROTO)
2893/*
2894 * Copy security info from "from_file" to "to_file".
2895 */
2896 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002897mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002898{
2899 if (from_file == NULL)
2900 return;
2901
2902 if (selinux_enabled == -1)
2903 selinux_enabled = is_selinux_enabled();
2904
2905 if (selinux_enabled > 0)
2906 {
Bram Moolenaar89560232020-10-09 23:04:47 +02002907 // Use "char *" instead of "security_context_t" to avoid a deprecation
2908 // warning.
2909 char *from_context = NULL;
2910 char *to_context = NULL;
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002911
2912 if (getfilecon((char *)from_file, &from_context) < 0)
2913 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002914 // If the filesystem doesn't support extended attributes,
2915 // the original had no special security context and the
2916 // target cannot have one either.
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002917 if (errno == EOPNOTSUPP)
2918 return;
2919
Bram Moolenaar32526b32019-01-19 17:43:09 +01002920 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002921 msg_outtrans(from_file);
2922 msg_putchar('\n');
2923 return;
2924 }
2925 if (getfilecon((char *)to_file, &to_context) < 0)
2926 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002927 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002928 msg_outtrans(to_file);
2929 msg_putchar('\n');
2930 freecon (from_context);
2931 return ;
2932 }
2933 if (strcmp(from_context, to_context) != 0)
2934 {
2935 if (setfilecon((char *)to_file, from_context) < 0)
2936 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002937 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002938 msg_outtrans(to_file);
2939 msg_putchar('\n');
2940 }
2941 }
2942 freecon(to_context);
2943 freecon(from_context);
2944 }
2945}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002946#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002947
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002948#if defined(HAVE_SMACK) && !defined(PROTO)
2949/*
2950 * Copy security info from "from_file" to "to_file".
2951 */
2952 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002953mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002954{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002955 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002956 {
2957 XATTR_NAME_SMACK,
2958 XATTR_NAME_SMACKEXEC,
2959 XATTR_NAME_SMACKMMAP
2960 };
2961
2962 char buffer[SMACK_LABEL_LEN];
2963 const char *name;
2964 int index;
2965 int ret;
2966 ssize_t size;
2967
2968 if (from_file == NULL)
2969 return;
2970
2971 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2972 / sizeof(smack_copied_attributes)[0]) ; index++)
2973 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002974 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002975 name = smack_copied_attributes[index];
2976
Bram Moolenaar0f873732019-12-05 20:28:46 +01002977 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002978 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2979 if (size >= 0)
2980 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002981 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002982 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2983 if (ret < 0)
2984 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002985 vim_snprintf((char *)IObuff, IOSIZE,
2986 _("Could not set security context %s for %s"),
2987 name, to_file);
2988 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002989 msg_putchar('\n');
2990 }
2991 }
2992 else
2993 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002994 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002995 switch (errno)
2996 {
2997 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002998 // extended attributes aren't supported or enabled
2999 // should a message be echoed? not sure...
3000 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003001
3002 case ERANGE:
3003 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003004 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003005 vim_snprintf((char *)IObuff, IOSIZE,
3006 _("Could not get security context %s for %s. Removing it!"),
3007 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003008 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003009 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01003010 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003011
3012 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003013 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003014 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003015 // Silently ignore errors, apparently this happens when
3016 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003017 break;
3018 }
3019 }
3020 }
3021}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003022#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003023
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024/*
3025 * Return a pointer to the ACL of file "fname" in allocated memory.
3026 * Return NULL if the ACL is not available for whatever reason.
3027 */
3028 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01003029mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030{
3031 vim_acl_T ret = NULL;
3032#ifdef HAVE_POSIX_ACL
3033 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
3034#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003035#ifdef HAVE_SOLARIS_ZFS_ACL
3036 acl_t *aclent;
3037
3038 if (acl_get((char *)fname, 0, &aclent) < 0)
3039 return NULL;
3040 ret = (vim_acl_T)aclent;
3041#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042#ifdef HAVE_SOLARIS_ACL
3043 vim_acl_solaris_T *aclent;
3044
3045 aclent = malloc(sizeof(vim_acl_solaris_T));
3046 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
3047 {
3048 free(aclent);
3049 return NULL;
3050 }
3051 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
3052 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
3053 {
3054 free(aclent->acl_entry);
3055 free(aclent);
3056 return NULL;
3057 }
3058 ret = (vim_acl_T)aclent;
3059#else
3060#if defined(HAVE_AIX_ACL)
3061 int aclsize;
3062 struct acl *aclent;
3063
3064 aclsize = sizeof(struct acl);
3065 aclent = malloc(aclsize);
3066 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3067 {
3068 if (errno == ENOSPC)
3069 {
3070 aclsize = aclent->acl_len;
3071 aclent = realloc(aclent, aclsize);
3072 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3073 {
3074 free(aclent);
3075 return NULL;
3076 }
3077 }
3078 else
3079 {
3080 free(aclent);
3081 return NULL;
3082 }
3083 }
3084 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003085#endif // HAVE_AIX_ACL
3086#endif // HAVE_SOLARIS_ACL
3087#endif // HAVE_SOLARIS_ZFS_ACL
3088#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 return ret;
3090}
3091
3092/*
3093 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3094 */
3095 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003096mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097{
3098 if (aclent == NULL)
3099 return;
3100#ifdef HAVE_POSIX_ACL
3101 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3102#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003103#ifdef HAVE_SOLARIS_ZFS_ACL
3104 acl_set((char *)fname, (acl_t *)aclent);
3105#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106#ifdef HAVE_SOLARIS_ACL
3107 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3108 ((vim_acl_solaris_T *)aclent)->acl_entry);
3109#else
3110#ifdef HAVE_AIX_ACL
3111 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003112#endif // HAVE_AIX_ACL
3113#endif // HAVE_SOLARIS_ACL
3114#endif // HAVE_SOLARIS_ZFS_ACL
3115#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116}
3117
3118 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003119mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120{
3121 if (aclent == NULL)
3122 return;
3123#ifdef HAVE_POSIX_ACL
3124 acl_free((acl_t)aclent);
3125#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003126#ifdef HAVE_SOLARIS_ZFS_ACL
3127 acl_free((acl_t *)aclent);
3128#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129#ifdef HAVE_SOLARIS_ACL
3130 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3131 free(aclent);
3132#else
3133#ifdef HAVE_AIX_ACL
3134 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003135#endif // HAVE_AIX_ACL
3136#endif // HAVE_SOLARIS_ACL
3137#endif // HAVE_SOLARIS_ZFS_ACL
3138#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139}
3140#endif
3141
3142/*
3143 * Set hidden flag for "name".
3144 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003146mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003148 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149}
3150
3151/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003152 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 * return FALSE if "name" is not a directory
3154 * return FALSE for error
3155 */
3156 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003157mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158{
3159 struct stat statb;
3160
Bram Moolenaar0f873732019-12-05 20:28:46 +01003161 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 return FALSE;
3163 if (stat((char *)name, &statb))
3164 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166}
3167
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003168/*
3169 * return TRUE if "name" is a directory, NOT a symlink to a directory
3170 * return FALSE if "name" is not a directory
3171 * return FALSE for error
3172 */
3173 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003174mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003175{
3176 struct stat statb;
3177
Bram Moolenaar0f873732019-12-05 20:28:46 +01003178 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003179 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003180 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003181 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003182 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003183}
3184
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185/*
3186 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3187 */
3188 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003189executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190{
3191 struct stat st;
3192
3193 if (stat((char *)name, &st))
3194 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003195#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003196 // Like on Unix system file can have executable rights but not necessarily
3197 // be an executable, but on Unix is not a default for an ordinary file to
3198 // have an executable flag - on VMS it is in most cases.
3199 // Therefore, this check does not have any sense - let keep us to the
3200 // conventions instead:
3201 // *.COM and *.EXE files are the executables - the rest are not. This is
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00003202 // not ideal but better than it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003203 int vms_executable = 0;
3204 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3205 {
3206 if (strstr(vms_tolower((char*)name),".exe") != NULL
3207 || strstr(vms_tolower((char*)name),".com")!= NULL)
3208 vms_executable = 1;
3209 }
3210 return vms_executable;
3211#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003213#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214}
3215
3216/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003217 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003218 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 * Return -1 if unknown.
3220 */
3221 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003222mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223{
3224 char_u *buf;
3225 char_u *p, *e;
3226 int retval;
3227
Bram Moolenaar0f873732019-12-05 20:28:46 +01003228 // When "use_path" is false and if it's an absolute or relative path don't
3229 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003230 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003231 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003232 // There must be a path separator, files in the current directory
3233 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003234 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003235 {
3236 if (path != NULL)
3237 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003238 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003239 *path = FullName_save(name, TRUE);
3240 else
3241 *path = vim_strsave(name);
3242 }
3243 return TRUE;
3244 }
3245 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003246 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247
3248 p = (char_u *)getenv("PATH");
3249 if (p == NULL || *p == NUL)
3250 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003251 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 if (buf == NULL)
3253 return -1;
3254
3255 /*
3256 * Walk through all entries in $PATH to check if "name" exists there and
3257 * is an executable file.
3258 */
3259 for (;;)
3260 {
3261 e = (char_u *)strchr((char *)p, ':');
3262 if (e == NULL)
3263 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003264 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 STRCPY(buf, "./");
3266 else
3267 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003268 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 add_pathsep(buf);
3270 }
3271 STRCAT(buf, name);
3272 retval = executable_file(buf);
3273 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003274 {
3275 if (path != NULL)
3276 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003277 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003278 *path = FullName_save(buf, TRUE);
3279 else
3280 *path = vim_strsave(buf);
3281 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003283 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284
3285 if (*e != ':')
3286 break;
3287 p = e + 1;
3288 }
3289
3290 vim_free(buf);
3291 return retval;
3292}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293
3294/*
3295 * Check what "name" is:
3296 * NODE_NORMAL: file or directory (or doesn't exist)
3297 * NODE_WRITABLE: writable device, socket, fifo, etc.
3298 * NODE_OTHER: non-writable things
3299 */
3300 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003301mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302{
3303 struct stat st;
3304
3305 if (stat((char *)name, &st))
3306 return NODE_NORMAL;
3307 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3308 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003309 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003311 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 return NODE_WRITABLE;
3313}
3314
3315 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003316mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317{
3318#ifdef HAVE_CHECK_STACK_GROWTH
3319 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 check_stack_growth((char *)&i);
3322
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003323# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 get_stack_limit();
3325# endif
3326
3327#endif
3328
3329 /*
3330 * Setup an alternative stack for signals. Helps to catch signals when
3331 * running out of stack space.
3332 * Use of sigaltstack() is preferred, it's more portable.
3333 * Ignore any errors.
3334 */
3335#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +02003336 signal_stack = alloc(get_signal_stack_size());
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 init_signal_stack();
3338#endif
3339}
3340
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003341#if defined(EXITFREE) || defined(PROTO)
3342 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003343mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003344{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003345# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3346 if (clip_star.owned)
3347 clip_lose_selection(&clip_star);
3348 if (clip_plus.owned)
3349 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003350# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003351# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003352 if (xterm_Shell != (Widget)0)
3353 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003354# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003355 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003356 if (xterm_dpy != NULL)
3357 XtCloseDisplay(xterm_dpy);
3358 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003359 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003360 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003361# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003362 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003363# endif
3364 }
3365# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003366# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003367# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003368 if (x11_display != NULL
3369# ifdef FEAT_XCLIPBOARD
3370 && x11_display != xterm_dpy
3371# endif
3372 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003373 XCloseDisplay(x11_display);
3374# endif
3375# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003376 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003377# endif
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003378 vim_free(oldtitle);
3379 vim_free(oldicon);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003380}
3381#endif
3382
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383/*
3384 * Output a newline when exiting.
3385 * Make sure the newline goes to the same stream as the text.
3386 */
3387 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003388exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003390 if (silent_mode)
3391 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 if (newline_on_exit || msg_didout)
3393 {
3394 if (msg_use_printf())
3395 {
3396 if (info_message)
3397 mch_msg("\n");
3398 else
3399 mch_errmsg("\r\n");
3400 }
3401 else
3402 out_char('\n');
3403 }
Bram Moolenaar7007e312021-03-27 12:11:33 +01003404 else if (!is_not_a_term())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003406 restore_cterm_colors(); // get original colors back
3407 msg_clr_eos_force(); // clear the rest of the display
3408 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 }
3410}
3411
Bram Moolenaarb4151682020-05-11 22:13:28 +02003412#ifdef USE_GCOV_FLUSH
ichizokdee78e12021-12-09 21:08:01 +00003413# if (defined(__GNUC__) \
3414 && ((__GNUC__ == 11 && __GNUC_MINOR__ >= 1) || (__GNUC__ >= 12))) \
3415 || (defined(__clang__) && (__clang_major__ >= 12))
3416extern void __gcov_dump(void);
3417extern void __gcov_reset(void);
3418# define __gcov_flush() do { __gcov_dump(); __gcov_reset(); } while (0)
3419# else
3420extern void __gcov_flush(void);
3421# endif
Bram Moolenaarb4151682020-05-11 22:13:28 +02003422#endif
3423
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003425mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426{
3427 exiting = TRUE;
3428
3429#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3430 x11_export_final_selection();
3431#endif
3432
3433#ifdef FEAT_GUI
3434 if (!gui.in_use)
3435#endif
3436 {
3437 settmode(TMODE_COOK);
Bram Moolenaar7007e312021-03-27 12:11:33 +01003438 if (!is_not_a_term())
3439 {
3440 // restore xterm title and icon name
3441 mch_restore_title(SAVE_RESTORE_BOTH);
3442 term_pop_title(SAVE_RESTORE_BOTH);
3443 }
Bram Moolenaar651fca82021-11-29 20:39:38 +00003444
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 /*
3446 * When t_ti is not empty but it doesn't cause swapping terminal
3447 * pages, need to output a newline when msg_didout is set. But when
3448 * t_ti does swap pages it should not go to the shell page. Do this
3449 * before stoptermcap().
3450 */
3451 if (swapping_screen() && !newline_on_exit)
3452 exit_scroll();
3453
Bram Moolenaar0f873732019-12-05 20:28:46 +01003454 // Stop termcap: May need to check for T_CRV response, which
3455 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 stoptermcap();
3457
3458 /*
3459 * A newline is only required after a message in the alternate screen.
3460 * This is set to TRUE by wait_return().
3461 */
3462 if (!swapping_screen() || newline_on_exit)
3463 exit_scroll();
3464
Bram Moolenaar0f873732019-12-05 20:28:46 +01003465 // Cursor may have been switched off without calling starttermcap()
3466 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 if (full_screen)
3468 cursor_on();
3469 }
3470 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003471 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003472
3473#ifdef USE_GCOV_FLUSH
3474 // Flush coverage info before possibly being killed by a deadly signal.
3475 __gcov_flush();
3476#endif
3477
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 may_core_dump();
3479#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 gui_exit(r);
3482#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003483
Bram Moolenaar56718732006-03-15 22:53:57 +00003484#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003485 mac_conv_cleanup();
3486#endif
3487
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003489 // A core dump won't be created if the signal handler
3490 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 if (deadly_signal != 0)
3492 return;
3493#endif
3494
Bram Moolenaar009b2592004-10-24 19:18:58 +00003495#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003496 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003497#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003498
3499#ifdef EXITFREE
3500 free_all_mem();
3501#endif
3502
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 exit(r);
3504}
3505
3506 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003507may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508{
3509 if (deadly_signal != 0)
3510 {
3511 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003512 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 }
3514}
3515
3516#ifndef VMS
3517
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003518/*
3519 * Get the file descriptor to use for tty operations.
3520 */
3521 static int
3522get_tty_fd(int fd)
3523{
3524 int tty_fd = fd;
3525
3526#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3527 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3528 // "fd" when it is a master device.
3529 if (mch_isatty(fd) > 1)
3530 {
3531 char *name;
3532
3533 name = ptsname(fd);
3534 if (name == NULL)
3535 return -1;
3536
3537 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3538 if (tty_fd < 0)
3539 return -1;
3540 }
3541#endif
3542 return tty_fd;
3543}
3544
3545 static int
3546mch_tcgetattr(int fd, void *term)
3547{
3548 int tty_fd;
3549 int retval = -1;
3550
3551 tty_fd = get_tty_fd(fd);
3552 if (tty_fd >= 0)
3553 {
3554#ifdef NEW_TTY_SYSTEM
3555# ifdef HAVE_TERMIOS_H
3556 retval = tcgetattr(tty_fd, (struct termios *)term);
3557# else
3558 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
3559# endif
3560#else
3561 // for "old" tty systems
3562 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
3563#endif
3564 if (tty_fd != fd)
3565 close(tty_fd);
3566 }
3567 return retval;
3568}
3569
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003571mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572{
3573 static int first = TRUE;
3574
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003575#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576# ifdef HAVE_TERMIOS_H
3577 static struct termios told;
3578 struct termios tnew;
3579# else
3580 static struct termio told;
3581 struct termio tnew;
3582# endif
3583
3584 if (first)
3585 {
3586 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003587 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 }
3589
3590 tnew = told;
3591 if (tmode == TMODE_RAW)
3592 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003593 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003594 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3595 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003597# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003598 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599# endif
3600 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003601# ifdef ONLCR
3602 // Don't map NL -> CR NL, we do it ourselves.
3603 // Also disable expanding tabs if possible.
3604# ifdef XTABS
3605 tnew.c_oflag &= ~(ONLCR | XTABS);
3606# else
3607# ifdef TAB3
3608 tnew.c_oflag &= ~(ONLCR | TAB3);
3609# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003611# endif
3612# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003614 tnew.c_cc[VMIN] = 1; // return after 1 char
3615 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 }
3617 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003618 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003619 // Also reset ICANON here, otherwise on Solaris select() won't see
3620 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003621 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003622 tnew.c_cc[VMIN] = 1; // return after 1 char
3623 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003624 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625
3626# if defined(HAVE_TERMIOS_H)
3627 {
3628 int n = 10;
3629
Bram Moolenaar0f873732019-12-05 20:28:46 +01003630 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3631 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3633 && errno == EINTR && n > 0)
3634 --n;
3635 }
3636# else
3637 ioctl(read_cmd_fd, TCSETA, &tnew);
3638# endif
3639
3640#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 /*
3642 * for "old" tty systems
3643 */
3644# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003645# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646# endif
3647 static struct sgttyb ttybold;
3648 struct sgttyb ttybnew;
3649
3650 if (first)
3651 {
3652 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003653 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 }
3655
3656 ttybnew = ttybold;
3657 if (tmode == TMODE_RAW)
3658 {
3659 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3660 ttybnew.sg_flags |= RAW;
3661 }
3662 else if (tmode == TMODE_SLEEP)
3663 ttybnew.sg_flags &= ~(ECHO);
3664 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3665#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003666 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667}
3668
3669/*
3670 * Try to get the code for "t_kb" from the stty setting
3671 *
3672 * Even if termcap claims a backspace key, the user's setting *should*
3673 * prevail. stty knows more about reality than termcap does, and if
3674 * somebody's usual erase key is DEL (which, for most BSD users, it will
3675 * be), they're going to get really annoyed if their erase key starts
3676 * doing forward deletes for no reason. (Eric Fischer)
3677 */
3678 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003679get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003681 ttyinfo_T info;
3682 char_u buf[2];
3683 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003685 if (get_tty_info(read_cmd_fd, &info) == OK)
3686 {
3687 intr_char = info.interrupt;
3688 buf[0] = info.backspace;
3689 buf[1] = NUL;
3690 add_termcode((char_u *)"kb", buf, FALSE);
3691
Bram Moolenaar0f873732019-12-05 20:28:46 +01003692 // If <BS> and <DEL> are now the same, redefine <DEL>.
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003693 p = find_termcode((char_u *)"kD");
3694 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3695 do_fixdel(NULL);
3696 }
3697}
3698
3699/*
3700 * Obtain the characters that Backspace and Enter produce on "fd".
3701 * Returns OK or FAIL.
3702 */
3703 int
3704get_tty_info(int fd, ttyinfo_T *info)
3705{
3706#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707# ifdef HAVE_TERMIOS_H
3708 struct termios keys;
3709# else
3710 struct termio keys;
3711# endif
3712
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003713 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003715 info->backspace = keys.c_cc[VERASE];
3716 info->interrupt = keys.c_cc[VINTR];
3717 if (keys.c_iflag & ICRNL)
3718 info->enter = NL;
3719 else
3720 info->enter = CAR;
3721 if (keys.c_oflag & ONLCR)
3722 info->nl_does_cr = TRUE;
3723 else
3724 info->nl_does_cr = FALSE;
3725 return OK;
3726 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003728 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 struct sgttyb keys;
3730
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003731 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003733 info->backspace = keys.sg_erase;
3734 info->interrupt = keys.sg_kill;
3735 info->enter = CAR;
3736 info->nl_does_cr = TRUE;
3737 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003740 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741}
3742
Bram Moolenaar0f873732019-12-05 20:28:46 +01003743#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003745static int mouse_ison = FALSE;
3746
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747/*
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003748 * Set mouse clicks on or off and possible enable mouse movement events.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 */
3750 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003751mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003753#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003754 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003755#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 int xterm_mouse_vers;
3757
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003758#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003759 if (!on)
3760 // Make sure not tracing mouse movements. Important when a button-down
3761 // was received but no release yet.
3762 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003763#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003764
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003765 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003766#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003767 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003768#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003769 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003770 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 return;
3772
3773 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003774
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003775#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003776 if (ttym_flags == TTYM_URXVT)
3777 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003778 out_str_nf((char_u *)(on ? "\033[?1015h" : "\033[?1015l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003779 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003780 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003781#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003782
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003783 if (ttym_flags == TTYM_SGR)
3784 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003785 // SGR mode supports columns above 223
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003786 out_str_nf((char_u *)(on ? "\033[?1006h" : "\033[?1006l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003787 mouse_ison = on;
3788 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003789
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003790#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003791 if (bevalterm_ison != (p_bevalterm && on))
3792 {
3793 bevalterm_ison = (p_bevalterm && on);
3794 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003795 // disable mouse movement events, enabling is below
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003796 out_str_nf((char_u *)("\033[?1003l"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003797 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003798#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003799
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 if (xterm_mouse_vers > 0)
3801 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003802 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 out_str_nf((char_u *)
3804 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003805 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003806#ifdef FEAT_BEVAL_TERM
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003807 bevalterm_ison ? "\033[?1003h" :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003808#endif
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003809 "\033[?1002h")
3810 : "\033[?1000h"));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003811 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 out_str_nf((char_u *)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003813 (xterm_mouse_vers > 1 ? "\033[?1002l" : "\033[?1000l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003814 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 }
3816
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003817#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 else if (ttym_flags == TTYM_DEC)
3819 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003820 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003822 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003824 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003826#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003828#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 else
3830 {
3831 if (on)
3832 {
3833 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003834 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 }
3836 else
3837 {
3838 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003839 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 }
3841 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003842#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003844#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003845 else
3846 {
3847 if (on)
3848 {
3849 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003850 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003851 }
3852 else
3853 {
3854 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003855 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003856 }
3857 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003858#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003859
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003860#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 else
3862 {
3863 if (on)
3864 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003865 // D - Enable Mouse up/down messages
3866 // L - Enable Left Button Reporting
3867 // M - Enable Middle Button Reporting
3868 // R - Enable Right Button Reporting
3869 // K - Enable SHIFT and CTRL key Reporting
3870 // + - Enable Advanced messaging of mouse moves and up/down messages
3871 // Q - Quiet No Ack
3872 // # - Numeric value of mouse pointer required
3873 // 0 = Multiview 2000 cursor, used as standard
3874 // 1 = Windows Arrow
3875 // 2 = Windows I Beam
3876 // 3 = Windows Hour Glass
3877 // 4 = Windows Cross Hair
3878 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003879# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003880 // Disables full feedback of pointer movements
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003881 out_str_nf((char_u *)"\033[0~ZwLMRK1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003882# else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003883 out_str_nf((char_u *)"\033[0~ZwLMRK+1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003884# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003885 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 }
3887 else
3888 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003889 out_str_nf((char_u *)"\033[0~ZwQ\033\\");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003890 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 }
3892 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003893#endif
3894#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 else
3896 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003897 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 if (on)
3899 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3900 else
3901 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003902 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003904#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905}
3906
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003907#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003908/*
3909 * Called when 'balloonevalterm' changed.
3910 */
3911 void
3912mch_bevalterm_changed(void)
3913{
3914 mch_setmouse(mouse_ison);
3915}
3916#endif
3917
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918/*
3919 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3920 */
3921 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003922check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923{
3924# ifdef FEAT_MOUSE_XTERM
3925 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003926# ifdef FEAT_MOUSE_URXVT
3927 && use_xterm_mouse() != 3
3928# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929# ifdef FEAT_GUI
3930 && !gui.in_use
3931# endif
3932 )
3933 {
3934 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003935 ? "\233M" : "\033[M"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 if (*p_mouse != NUL)
3937 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003938 // force mouse off and maybe on to send possibly new mouse
3939 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 mch_setmouse(FALSE);
3941 setmouse();
3942 }
3943 }
3944 else
3945 del_mouse_termcode(KS_MOUSE);
3946# endif
3947
3948# ifdef FEAT_MOUSE_GPM
3949 if (!use_xterm_mouse()
3950# ifdef FEAT_GUI
3951 && !gui.in_use
3952# endif
3953 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003954 set_mouse_termcode(KS_GPM_MOUSE, (char_u *)"\033MG");
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003955 else
3956 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957# endif
3958
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003959# ifdef FEAT_SYSMOUSE
3960 if (!use_xterm_mouse()
3961# ifdef FEAT_GUI
3962 && !gui.in_use
3963# endif
3964 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003965 set_mouse_termcode(KS_MOUSE, (char_u *)"\033MS");
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003966# endif
3967
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003969 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 if (!use_xterm_mouse()
3971# ifdef FEAT_GUI
3972 && !gui.in_use
3973# endif
3974 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003975 set_mouse_termcode(KS_JSBTERM_MOUSE, (char_u *)"\033[0~zw");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 else
3977 del_mouse_termcode(KS_JSBTERM_MOUSE);
3978# endif
3979
3980# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003981 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3982 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 if (!use_xterm_mouse()
3984# ifdef FEAT_GUI
3985 && !gui.in_use
3986# endif
3987 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003988 set_mouse_termcode(KS_NETTERM_MOUSE, (char_u *)"\033}");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 else
3990 del_mouse_termcode(KS_NETTERM_MOUSE);
3991# endif
3992
3993# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01003994 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003995 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996# ifdef FEAT_GUI
3997 && !gui.in_use
3998# endif
3999 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004000 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004001 ? "\233" : "\033["));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 else
4003 del_mouse_termcode(KS_DEC_MOUSE);
4004# endif
4005# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01004006 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004007 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008# ifdef FEAT_GUI
4009 && !gui.in_use
4010# endif
4011 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004012 set_mouse_termcode(KS_PTERM_MOUSE, (char_u *)"\033[");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 else
4014 del_mouse_termcode(KS_PTERM_MOUSE);
4015# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02004016# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004017 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02004018# ifdef FEAT_GUI
4019 && !gui.in_use
4020# endif
4021 )
4022 {
4023 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004024 ? "\233*M" : "\033[*M"));
Bram Moolenaarc8427482011-10-20 21:09:35 +02004025
4026 if (*p_mouse != NUL)
4027 {
4028 mch_setmouse(FALSE);
4029 setmouse();
4030 }
4031 }
4032 else
4033 del_mouse_termcode(KS_URXVT_MOUSE);
4034# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004035 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004036# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004037 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004038# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004039 )
4040 {
4041 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004042 ? "\233<*M" : "\033[<*M"));
Bram Moolenaara529ce02017-06-22 22:37:57 +02004043
4044 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004045 ? "\233<*m" : "\033[<*m"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004046
4047 if (*p_mouse != NUL)
4048 {
4049 mch_setmouse(FALSE);
4050 setmouse();
4051 }
4052 }
4053 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02004054 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004055 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02004056 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
4057 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060#ifndef VMS
4061
4062/*
4063 * Try to get the current window size:
4064 * 1. with an ioctl(), most accurate method
4065 * 2. from the environment variables LINES and COLUMNS
4066 * 3. from the termcap
4067 * 4. keep using the old values
4068 * Return OK when size could be determined, FAIL otherwise.
4069 */
4070 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004071mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072{
4073 long rows = 0;
4074 long columns = 0;
4075 char_u *p;
4076
4077 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 * 1. try using an ioctl. It is the most accurate method.
4079 *
4080 * Try using TIOCGWINSZ first, some systems that have it also define
4081 * TIOCGSIZE but don't have a struct ttysize.
4082 */
4083# ifdef TIOCGWINSZ
4084 {
4085 struct winsize ws;
4086 int fd = 1;
4087
Bram Moolenaar0f873732019-12-05 20:28:46 +01004088 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 if (!isatty(fd) && isatty(read_cmd_fd))
4090 fd = read_cmd_fd;
4091 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4092 {
4093 columns = ws.ws_col;
4094 rows = ws.ws_row;
4095 }
4096 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004097# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098# ifdef TIOCGSIZE
4099 {
4100 struct ttysize ts;
4101 int fd = 1;
4102
Bram Moolenaar0f873732019-12-05 20:28:46 +01004103 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 if (!isatty(fd) && isatty(read_cmd_fd))
4105 fd = read_cmd_fd;
4106 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4107 {
4108 columns = ts.ts_cols;
4109 rows = ts.ts_lines;
4110 }
4111 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004112# endif // TIOCGSIZE
4113# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114
4115 /*
4116 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004117 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4118 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004120 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 {
4122 if ((p = (char_u *)getenv("LINES")))
4123 rows = atoi((char *)p);
4124 if ((p = (char_u *)getenv("COLUMNS")))
4125 columns = atoi((char *)p);
4126 }
4127
4128#ifdef HAVE_TGETENT
4129 /*
4130 * 3. try reading "co" and "li" entries from termcap
4131 */
4132 if (columns == 0 || rows == 0)
4133 getlinecol(&columns, &rows);
4134#endif
4135
4136 /*
4137 * 4. If everything fails, use the old values
4138 */
4139 if (columns <= 0 || rows <= 0)
4140 return FAIL;
4141
4142 Rows = rows;
4143 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004144 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 return OK;
4146}
4147
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004148#if defined(FEAT_TERMINAL) || defined(PROTO)
4149/*
4150 * Report the windows size "rows" and "cols" to tty "fd".
4151 */
4152 int
4153mch_report_winsize(int fd, int rows, int cols)
4154{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004155 int tty_fd;
4156 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004157
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004158 tty_fd = get_tty_fd(fd);
4159 if (tty_fd >= 0)
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004160 {
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004161# if defined(TIOCSWINSZ)
4162 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004163
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004164 ws.ws_col = cols;
4165 ws.ws_row = rows;
4166 ws.ws_xpixel = cols * 5;
4167 ws.ws_ypixel = rows * 10;
4168 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4169 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4170 retval == 0 ? "success" : "failed");
4171# elif defined(TIOCSSIZE)
4172 struct ttysize ts;
4173
4174 ts.ts_cols = cols;
4175 ts.ts_lines = rows;
4176 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4177 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4178 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004179# endif
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004180 if (tty_fd != fd)
4181 close(tty_fd);
4182 }
4183 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004184}
4185#endif
4186
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187/*
4188 * Try to set the window size to Rows and Columns.
4189 */
4190 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004191mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192{
4193 if (*T_CWS)
4194 {
4195 /*
4196 * NOTE: if you get an error here that term_set_winsize() is
4197 * undefined, check the output of configure. It could probably not
4198 * find a ncurses, termcap or termlib library.
4199 */
4200 term_set_winsize((int)Rows, (int)Columns);
4201 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004202 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 }
4204}
4205
Bram Moolenaar0f873732019-12-05 20:28:46 +01004206#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207
4208/*
4209 * Rows and/or Columns has changed.
4210 */
4211 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004212mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004214 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215}
4216
Bram Moolenaar205b8862011-09-07 15:04:31 +02004217/*
4218 * Wait for process "child" to end.
4219 * Return "child" if it exited properly, <= 0 on error.
4220 */
4221 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004222wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004223{
4224 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004225 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004226
4227 while (wait_pid != child)
4228 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004229 // When compiled with Python threads are probably used, in which case
4230 // wait() sometimes hangs for no obvious reason. Use waitpid()
4231 // instead and loop (like the GUI). Also needed for other interfaces,
4232 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004233# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004234 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004235# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004236 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004237# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004238 if (wait_pid == 0)
4239 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004240 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004241 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004242 if (++delay_msec > 10)
4243 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004244 continue;
4245 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004246 if (wait_pid <= 0
4247# ifdef ECHILD
4248 && errno == ECHILD
4249# endif
4250 )
4251 break;
4252 }
4253 return wait_pid;
4254}
4255
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004256#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004257/*
4258 * Set the environment for a child process.
4259 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004260 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004261set_child_environment(
4262 long rows,
4263 long columns,
4264 char *term,
4265 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004266{
4267# ifdef HAVE_SETENV
4268 char envbuf[50];
4269# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004270 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004271 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004272 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004273 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004274 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004275# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004276 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004277# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004278# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004279 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004280# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004281# endif
4282
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004283# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004284 setenv("TERM", term, 1);
4285 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004286 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004287 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004288 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004289 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004290 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004291 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004292 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004293# ifdef FEAT_TERMINAL
4294 if (is_terminal)
4295 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004296 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004297 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4298 }
4299# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004300# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004301 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004302# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004303# else
4304 /*
4305 * Putenv does not copy the string, it has to remain valid.
4306 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004307 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004308 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004309 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4310 putenv(envbuf_Term);
4311 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004312 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004313 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4314 putenv(envbuf_Lines);
4315 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4316 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004317 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004318 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004319 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004320# ifdef FEAT_TERMINAL
4321 if (is_terminal)
4322 {
4323 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004324 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004325 putenv(envbuf_Version);
4326 }
4327# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004328# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004329 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4330 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4331 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004332# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004333# endif
4334}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004335
4336 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004337set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004338{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004339 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004340}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004341#endif
4342
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004343#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004344/*
4345 * Open a PTY, with FD for the master and slave side.
4346 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004347 * When successful both file descriptors are stored and the allocated pty name
4348 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004349 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004350 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004351open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004352{
4353 char *tty_name;
4354
Bram Moolenaar59386482019-02-10 22:43:46 +01004355 if (name1 != NULL)
4356 *name1 = NULL;
4357 if (name2 != NULL)
4358 *name2 = NULL;
4359
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004360 *pty_master_fd = mch_openpty(&tty_name); // open pty
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004361 if (*pty_master_fd >= 0)
4362 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004363 // Leaving out O_NOCTTY may lead to waitpid() always returning
4364 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4365 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004366#ifdef O_NOCTTY
4367 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
4368#else
4369 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
4370#endif
4371 if (*pty_slave_fd < 0)
4372 {
4373 close(*pty_master_fd);
4374 *pty_master_fd = -1;
4375 }
Bram Moolenaar59386482019-02-10 22:43:46 +01004376 else
4377 {
4378 if (name1 != NULL)
4379 *name1 = vim_strsave((char_u *)tty_name);
4380 if (name2 != NULL)
4381 *name2 = vim_strsave((char_u *)tty_name);
4382 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004383 }
4384}
4385#endif
4386
Bram Moolenaarfae42832017-08-01 22:24:26 +02004387/*
4388 * Send SIGINT to a child process if "c" is an interrupt character.
4389 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004390 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004391may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4392{
4393# ifdef SIGINT
4394 if (c == Ctrl_C || c == intr_char)
4395 {
4396# ifdef HAVE_SETSID
4397 kill(-pid, SIGINT);
4398# else
4399 kill(0, SIGINT);
4400# endif
4401 if (wpid > 0)
4402 kill(wpid, SIGINT);
4403 }
4404# endif
4405}
4406
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004407#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004408
Bram Moolenaar0f873732019-12-05 20:28:46 +01004409/*
4410 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4411 * pointers, the last one is NULL.
4412 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4413 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004414 int
4415unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004416 char_u *cmd,
4417 char ***argvp,
4418 char_u **sh_tofree,
4419 char_u **shcf_tofree)
4420{
4421 char **argv = NULL;
4422 int argc;
4423
4424 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004425 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004426 return FAIL;
4427
4428 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4429 return FAIL;
4430 *argvp = argv;
4431
4432 if (cmd != NULL)
4433 {
4434 char_u *s;
4435 char_u *p;
4436
4437 if (extra_shell_arg != NULL)
4438 argv[argc++] = (char *)extra_shell_arg;
4439
Bram Moolenaar0f873732019-12-05 20:28:46 +01004440 // Break 'shellcmdflag' into white separated parts. This doesn't
4441 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004442 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004443 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004444 return FAIL;
4445 s = *shcf_tofree;
4446 p = p_shcf;
4447 while (*p != NUL)
4448 {
4449 argv[argc++] = (char *)s;
4450 while (*p && *p != ' ' && *p != TAB)
4451 *s++ = *p++;
4452 *s++ = NUL;
4453 p = skipwhite(p);
4454 }
4455
4456 argv[argc++] = (char *)cmd;
4457 }
4458 argv[argc] = NULL;
4459 return OK;
4460}
4461#endif
4462
4463#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4464/*
4465 * Use a terminal window to run a shell command in.
4466 */
4467 static int
4468mch_call_shell_terminal(
4469 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004470 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004471{
4472 jobopt_T opt;
4473 char **argv = NULL;
4474 char_u *tofree1 = NULL;
4475 char_u *tofree2 = NULL;
4476 int retval = -1;
4477 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004478 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004479 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004480 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004481
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004482 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004483 goto theend;
4484
4485 init_job_options(&opt);
4486 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4487 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004488 if (buf == NULL)
4489 goto theend;
4490
4491 job = term_getjob(buf->b_term);
4492 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004493
Bram Moolenaar0f873732019-12-05 20:28:46 +01004494 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004495 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00004496 if (curbuf == buf)
Bram Moolenaar13568252018-03-16 20:46:58 +01004497 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004498 // Only when managed to find a window for "buf",
4499 clear_oparg(&oa);
4500 while (term_use_loop())
Bram Moolenaar13568252018-03-16 20:46:58 +01004501 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004502 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4503 {
4504 // If terminal_loop() returns OK we got a key that is handled
4505 // in Normal model. We don't do redrawing anyway.
4506 if (terminal_loop(TRUE) == OK)
4507 normal_cmd(&oa, TRUE);
4508 }
4509 else
Bram Moolenaar13568252018-03-16 20:46:58 +01004510 normal_cmd(&oa, TRUE);
4511 }
Bram Moolenaare76062c2022-11-28 18:51:43 +00004512 retval = job->jv_exitval;
4513 ch_log(NULL, "system command finished");
4514
4515 job_unref(job);
4516
4517 // restore curwin/curbuf and a few other things
4518 aucmd_restbuf(&aco);
Bram Moolenaar13568252018-03-16 20:46:58 +01004519 }
Bram Moolenaar13568252018-03-16 20:46:58 +01004520
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01004521 // Only require pressing Enter when redrawing, to avoid that system() gets
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004522 // the hit-enter prompt even though it didn't output anything.
4523 if (!RedrawingDisabled)
4524 wait_return(TRUE);
Bram Moolenaar13568252018-03-16 20:46:58 +01004525 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4526
4527theend:
4528 vim_free(argv);
4529 vim_free(tofree1);
4530 vim_free(tofree2);
4531 return retval;
4532}
4533#endif
4534
4535#ifdef USE_SYSTEM
4536/*
4537 * Use system() to start the shell: simple but slow.
4538 */
4539 static int
4540mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004541 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004542 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543{
4544#ifdef VMS
4545 char *ifn = NULL;
4546 char *ofn = NULL;
4547#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004548 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004549 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004550 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551
4552 out_flush();
4553
4554 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004555 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556
Bram Moolenaar62b42182010-09-21 22:09:37 +02004557# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004558 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004559 loose_clipboard();
4560# endif
4561
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 if (cmd == NULL)
4563 x = system((char *)p_sh);
4564 else
4565 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004566# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 if (ofn = strchr((char *)cmd, '>'))
4568 *ofn++ = '\0';
4569 if (ifn = strchr((char *)cmd, '<'))
4570 {
4571 char *p;
4572
4573 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004574 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 if (p)
4576 *p = '\0';
4577 }
4578 if (ofn)
4579 x = vms_sys((char *)cmd, ofn, ifn);
4580 else
4581 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004582# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004583 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004585 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 if (newcmd == NULL)
4587 x = 0;
4588 else
4589 {
4590 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4591 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4592 (char *)p_shcf,
4593 (char *)cmd);
4594 x = system((char *)newcmd);
4595 vim_free(newcmd);
4596 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004597# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 }
4599# ifdef VMS
4600 x = vms_sys_status(x);
4601# endif
4602 if (emsg_silent)
4603 ;
4604 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004605 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 else if (x && !(options & SHELL_SILENT))
4607 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004608 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 msg_outnum((long)x);
4610 msg_putchar('\n');
4611 }
4612
4613 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004614 {
4615 // The shell may have messed with the mode, always set it.
4616 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004617 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004618 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 resettitle();
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004620# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4621 restore_clipboard();
4622# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004624}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625
Bram Moolenaar0f873732019-12-05 20:28:46 +01004626#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627
Bram Moolenaar0f873732019-12-05 20:28:46 +01004628# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4629 // 127, some shells use that already
4630# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631
Bram Moolenaar13568252018-03-16 20:46:58 +01004632/*
4633 * Don't use system(), use fork()/exec().
4634 */
4635 static int
4636mch_call_shell_fork(
4637 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004638 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004639{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004640 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004642 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 pid_t wait_pid = 0;
4644# ifdef HAVE_UNION_WAIT
4645 union wait status;
4646# else
4647 int status = -1;
4648# endif
4649 int retval = -1;
4650 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004651 char_u *tofree1 = NULL;
4652 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004654 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004655# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004657# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004658 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 int fd_fromshell[2];
4660 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004661 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662
4663 out_flush();
4664 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004665 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004666 if (tmode == TMODE_RAW)
4667 // The shell may have messed with the mode, always set it later.
4668 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004670 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004671 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004672
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004674 * For the GUI, when writing the output into the buffer and when reading
4675 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4676 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004678 if ((options & (SHELL_READ|SHELL_WRITE))
4679# ifdef FEAT_GUI
4680 || (gui.in_use && show_shell_mess)
4681# endif
4682 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004684# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 /*
4686 * Try to open a master pty.
4687 * If this works, open the slave pty.
4688 * If the slave can't be opened, close the master pty.
4689 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004690 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004691 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 /*
4693 * If not opening a pty or it didn't work, try using pipes.
4694 */
4695 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004696# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 {
4698 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004699 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 {
4701 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004702 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 {
4704 close(fd_toshell[0]);
4705 close(fd_toshell[1]);
4706 }
4707 }
4708 if (pipe_error)
4709 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004710 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 out_flush();
4712 }
4713 }
4714 }
4715
Bram Moolenaar0f873732019-12-05 20:28:46 +01004716 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004718 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004719 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004720 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004721 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004723 UNBLOCK_SIGNALS(&curset);
4724
Bram Moolenaar32526b32019-01-19 17:43:09 +01004725 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004726 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004728 || (gui.in_use && show_shell_mess)
4729# endif
4730 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004732# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004733 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 {
4735 close(pty_master_fd);
4736 close(pty_slave_fd);
4737 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004738 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004739# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 {
4741 close(fd_toshell[0]);
4742 close(fd_toshell[1]);
4743 close(fd_fromshell[0]);
4744 close(fd_fromshell[1]);
4745 }
4746 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004748 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004750 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004751 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00004753# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01004754 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004755 {
4756 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004757 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004758 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004759# endif
4760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 if (!show_shell_mess || (options & SHELL_EXPAND))
4762 {
4763 int fd;
4764
4765 /*
4766 * Don't want to show any message from the shell. Can't just
4767 * close stdout and stderr though, because some systems will
4768 * break if you try to write to them after that, so we must
4769 * use dup() to replace them with something else -- webb
4770 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4771 * waiting for input.
4772 */
4773 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4774 fclose(stdin);
4775 fclose(stdout);
4776 fclose(stderr);
4777
4778 /*
4779 * If any of these open()'s and dup()'s fail, we just continue
4780 * anyway. It's not fatal, and on most systems it will make
4781 * no difference at all. On a few it will cause the execvp()
4782 * to exit with a non-zero status even when the completion
4783 * could be done, which is nothing too serious. If the open()
4784 * or dup() failed we'd just do the same thing ourselves
4785 * anyway -- webb
4786 */
4787 if (fd >= 0)
4788 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004789 vim_ignored = dup(fd); // To replace stdin (fd 0)
4790 vim_ignored = dup(fd); // To replace stdout (fd 1)
4791 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
Bram Moolenaar0f873732019-12-05 20:28:46 +01004793 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 close(fd);
4795 }
4796 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004797 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004799 || gui.in_use
4800# endif
4801 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 {
4803
Bram Moolenaardf177f62005-02-22 08:39:57 +00004804# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004805 // Create our own process group, so that the child and all its
4806 // children can be kill()ed. Don't do this when using pipes,
4807 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004808 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004809 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004810 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004811# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004812 // When doing "!xterm&" and 'shell' is bash: the shell
4813 // will exit and send SIGHUP to all processes in its
4814 // group, killing the just started process. Ignore SIGHUP
4815 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004816 signal(SIGHUP, SIG_IGN);
4817# endif
4818 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004819# endif
4820# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004821 if (pty_slave_fd >= 0)
4822 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004823 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004824 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004825 setup_slavepty(pty_slave_fd);
Bram Moolenaarfff10d92021-10-13 10:05:30 +01004826# ifdef TIOCSCTTY
4827 // Try to become controlling tty (probably doesn't work,
4828 // unless run by root)
4829 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
4830# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004831 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004832# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004833 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834
Bram Moolenaara5792f52005-11-23 21:25:05 +00004835 /*
4836 * stderr is only redirected when using the GUI, so that a
4837 * program like gpg can still access the terminal to get a
4838 * passphrase using stderr.
4839 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004840# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 if (pty_master_fd >= 0)
4842 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004843 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844
Bram Moolenaar0f873732019-12-05 20:28:46 +01004845 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004847 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004849 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004850 if (gui.in_use)
4851 {
4852 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004853 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004854 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855
Bram Moolenaar0f873732019-12-05 20:28:46 +01004856 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 }
4858 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004859# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004861 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 close(fd_toshell[1]);
4863 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004864 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 close(fd_toshell[0]);
4866
Bram Moolenaar0f873732019-12-05 20:28:46 +01004867 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 close(fd_fromshell[0]);
4869 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004870 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 close(fd_fromshell[1]);
4872
Bram Moolenaara5792f52005-11-23 21:25:05 +00004873# ifdef FEAT_GUI
4874 if (gui.in_use)
4875 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004876 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004877 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004878 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004879 }
4880# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 }
4882 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004883
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 /*
4885 * There is no type cast for the argv, because the type may be
4886 * different on different machines. This may cause a warning
4887 * message with strict compilers, don't worry about it.
4888 * Call _exit() instead of exit() to avoid closing the connection
4889 * to the X server (esp. with GTK, which uses atexit()).
4890 */
4891 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004892 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004894 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 {
4896 /*
4897 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004898 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 */
4900 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004901 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004902 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004903# ifdef FEAT_JOB_CHANNEL
4904 ++dont_check_job_ended;
4905# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 /*
4907 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004908 * This is also used to pipe stdin/stdout to/from the external
4909 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004911 if ((options & (SHELL_READ|SHELL_WRITE))
4912# ifdef FEAT_GUI
4913 || (gui.in_use && show_shell_mess)
4914# endif
4915 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004917# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004919 int buffer_off = 0; // valid bytes in buffer[]
4920 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4921 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 int len;
4923 int p_more_save;
4924 int old_State;
4925 int c;
4926 int toshell_fd;
4927 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004928 garray_T ga;
4929 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004930# ifdef ELAPSED_FUNC
4931 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004932# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
Bram Moolenaardf177f62005-02-22 08:39:57 +00004934# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 if (pty_master_fd >= 0)
4936 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 fromshell_fd = pty_master_fd;
4938 toshell_fd = dup(pty_master_fd);
4939 }
4940 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004941# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 {
4943 close(fd_toshell[0]);
4944 close(fd_fromshell[1]);
4945 toshell_fd = fd_toshell[1];
4946 fromshell_fd = fd_fromshell[0];
4947 }
4948
4949 /*
4950 * Write to the child if there are typed characters.
4951 * Read from the child if there are characters available.
4952 * Repeat the reading a few times if more characters are
4953 * available. Need to check for typed keys now and then, but
4954 * not too often (delays when no chars are available).
4955 * This loop is quit if no characters can be read from the pty
4956 * (WaitForChar detected special condition), or there are no
4957 * characters available and the child has exited.
4958 * Only check if the child has exited when there is no more
4959 * output. The child may exit before all the output has
4960 * been printed.
4961 *
4962 * Currently this busy loops!
4963 * This can probably dead-lock when the write blocks!
4964 */
4965 p_more_save = p_more;
4966 p_more = FALSE;
4967 old_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01004968 State = MODE_EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004970 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004971 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004972 // Fork a process that will write the lines to the
4973 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004974 if ((wpid = fork()) == -1)
4975 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004976 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004977 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004978 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004979 {
4980 linenr_T lnum = curbuf->b_op_start.lnum;
4981 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004982 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004983 size_t l;
4984
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004985 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004986 for (;;)
4987 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00004988 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004989 if (l == 0)
4990 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004991 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004992 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00004993 len = write(toshell_fd, "", (size_t)1);
4994 else
4995 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01004996 char_u *s = vim_strchr(lp + written, NL);
4997
Bram Moolenaar89d40322006-08-29 15:30:07 +00004998 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00004999 s == NULL ? l
5000 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005001 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00005002 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005003 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005004 // Finished a line, add a NL, unless this line
5005 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005006 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005007 || (!curbuf->b_p_bin
5008 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005009 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaar88456cd2022-11-18 22:14:09 +00005010 && (lnum != curbuf->b_ml.ml_line_count
Bram Moolenaardf177f62005-02-22 08:39:57 +00005011 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02005012 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005013 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005014 ++lnum;
5015 if (lnum > curbuf->b_op_end.lnum)
5016 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005017 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00005018 close(toshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005019 break;
5020 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00005021 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005022 written = 0;
5023 }
5024 else if (len > 0)
5025 written += len;
5026 }
5027 _exit(0);
5028 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005029 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00005030 {
5031 close(toshell_fd);
5032 toshell_fd = -1;
5033 }
5034 }
5035
5036 if (options & SHELL_READ)
5037 ga_init2(&ga, 1, BUFLEN);
5038
5039 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005040# ifdef ELAPSED_FUNC
5041 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005042# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 for (;;)
5044 {
5045 /*
5046 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005047 * if there are any.
5048 * Don't do this if we are expanding wild cards (would eat
5049 * typeahead).
5050 * Don't do this when filtering and terminal is in cooked
5051 * mode, the shell command will handle the I/O. Avoids
5052 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005053 * Don't get characters when the child has already
5054 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00005055 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005056 * while (noread_cnt > 4), avoids that ":r !ls" eats
5057 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 */
5059 len = 0;
5060 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005061 && ((options &
5062 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5063 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005064# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005065 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005066# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005067 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005068 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005069 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005071 if (ta_len == 0)
5072 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005073 // Get extra characters when we don't have any.
5074 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005075 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005076# ifdef ELAPSED_FUNC
5077 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005078# endif
5079 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5080 }
5081 if (ta_len > 0 || len > 0)
5082 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 /*
5084 * For pipes:
5085 * Check for CTRL-C: send interrupt signal to child.
5086 * Check for CTRL-D: EOF, close pipe to child.
5087 */
5088 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5089 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 /*
5091 * Send SIGINT to the child's group or all
5092 * processes in our group.
5093 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005094 may_send_sigint(ta_buf[ta_len], pid, wpid);
5095
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 if (pty_master_fd < 0 && toshell_fd >= 0
5097 && ta_buf[ta_len] == Ctrl_D)
5098 {
5099 close(toshell_fd);
5100 toshell_fd = -1;
5101 }
5102 }
5103
Bram Moolenaar2f7e1b82022-10-04 13:17:31 +01005104 // Remove Vim-specific codes from the input.
5105 len = term_replace_keycodes(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106
5107 /*
5108 * For pipes: echo the typed characters.
5109 * For a pty this does not seem to work.
5110 */
5111 if (pty_master_fd < 0)
5112 {
5113 for (i = ta_len; i < ta_len + len; ++i)
5114 {
5115 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5116 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 else if (has_mbyte)
5118 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005119 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
5121 msg_outtrans_len(ta_buf + i, l);
5122 i += l - 1;
5123 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 else
5125 msg_outtrans_len(ta_buf + i, 1);
5126 }
5127 windgoto(msg_row, msg_col);
5128 out_flush();
5129 }
5130
5131 ta_len += len;
5132
5133 /*
5134 * Write the characters to the child, unless EOF has
5135 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005136 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005137 * When writing buffer lines, drop the typed
5138 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005140 if (options & SHELL_WRITE)
5141 ta_len = 0;
5142 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 {
5144 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5145 if (len > 0)
5146 {
5147 ta_len -= len;
5148 mch_memmove(ta_buf, ta_buf + len, ta_len);
5149 }
5150 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005151 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 }
5153
Bram Moolenaardf177f62005-02-22 08:39:57 +00005154 if (got_int)
5155 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005156 // CTRL-C sends a signal to the child, we ignore it
5157 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005158# ifdef HAVE_SETSID
5159 kill(-pid, SIGINT);
5160# else
5161 kill(0, SIGINT);
5162# endif
5163 if (wpid > 0)
5164 kill(wpid, SIGINT);
5165 got_int = FALSE;
5166 }
5167
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 /*
5169 * Check if the child has any characters to be printed.
5170 * Read them and write them to our window. Repeat this as
5171 * long as there is something to do, avoid the 10ms wait
5172 * for mch_inchar(), or sending typeahead characters to
5173 * the external process.
5174 * TODO: This should handle escape sequences, compatible
5175 * to some terminal (vt52?).
5176 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005177 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005178 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005180 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005183 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005185
5186 noread_cnt = 0;
5187 if (options & SHELL_READ)
5188 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005189 // Do NUL -> NL translation, append NL separated
5190 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005191 for (i = 0; i < len; ++i)
5192 {
5193 if (buffer[i] == NL)
5194 append_ga_line(&ga);
5195 else if (buffer[i] == NUL)
5196 ga_append(&ga, NL);
5197 else
5198 ga_append(&ga, buffer[i]);
5199 }
5200 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005201 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 {
5203 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005204 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
Bram Moolenaardf177f62005-02-22 08:39:57 +00005206 len += buffer_off;
5207 buffer[len] = NUL;
5208
Bram Moolenaar0f873732019-12-05 20:28:46 +01005209 // Check if the last character in buffer[] is
5210 // incomplete, keep these bytes for the next
5211 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 for (p = buffer; p < buffer + len; p += l)
5213 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005214 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005216 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 else if (MB_BYTE2LEN(*p) != l)
5218 break;
5219 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005220 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005222 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 if (len >= 12)
5224 ++p;
5225 else
5226 {
5227 buffer_off = len;
5228 continue;
5229 }
5230 }
5231 c = *p;
5232 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005233 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 if (p < buffer + len)
5235 {
5236 *p = c;
5237 buffer_off = (buffer + len) - p;
5238 mch_memmove(buffer, p, buffer_off);
5239 continue;
5240 }
5241 buffer_off = 0;
5242 }
5243 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 {
5245 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005246 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 }
5248
5249 windgoto(msg_row, msg_col);
5250 cursor_on();
5251 out_flush();
5252 if (got_int)
5253 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005254
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005255# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005256 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005257 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005258 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005259
Bram Moolenaar0f873732019-12-05 20:28:46 +01005260 // Avoid that we keep looping here without
5261 // checking for a CTRL-C for a long time. Don't
5262 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005263 if (msec > 2000)
5264 {
5265 noread_cnt = 5;
5266 break;
5267 }
5268 }
5269# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 }
5271
Bram Moolenaar0f873732019-12-05 20:28:46 +01005272 // If we already detected the child has finished, continue
5273 // reading output for a short while. Some text may be
5274 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005275 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005276 {
5277 if (noread_cnt < 5)
5278 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005279 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005280 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005281
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 /*
5283 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005284 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005286# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005287 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005288# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005290# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5292 || (wait_pid == pid && WIFEXITED(status)))
5293 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005294 // Don't break the loop yet, try reading more
5295 // characters from "fromshell_fd" first. When using
5296 // pipes there might still be something to read and
5297 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005300 else
5301 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005302
Bram Moolenaar95a51352013-03-21 22:53:50 +01005303# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005304 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005305 clip_update();
5306# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 }
5308finished:
5309 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005310 if (options & SHELL_READ)
5311 {
5312 if (ga.ga_len > 0)
5313 {
5314 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005315 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005316 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005317 }
5318 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005319 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005320 ga_clear(&ga);
5321 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 /*
5324 * Give all typeahead that wasn't used back to ui_inchar().
5325 */
5326 if (ta_len)
5327 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 State = old_State;
5329 if (toshell_fd >= 0)
5330 close(toshell_fd);
5331 close(fromshell_fd);
5332 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005333# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005334 else
5335 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005336 long delay_msec = 1;
5337
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005338 if (tmode == TMODE_RAW)
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005339 // Possibly disables modifyOtherKeys, so that the system
5340 // can recognize CTRL-C.
5341 out_str_t_TE();
Bram Moolenaar0981c872020-08-23 14:28:37 +02005342
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005343 /*
5344 * Similar to the loop above, but only handle X events, no
5345 * I/O.
5346 */
5347 for (;;)
5348 {
5349 if (got_int)
5350 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005351 // CTRL-C sends a signal to the child, we ignore it
5352 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005353# ifdef HAVE_SETSID
5354 kill(-pid, SIGINT);
5355# else
5356 kill(0, SIGINT);
5357# endif
5358 got_int = FALSE;
5359 }
5360# ifdef __NeXT__
5361 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5362# else
5363 wait_pid = waitpid(pid, &status, WNOHANG);
5364# endif
5365 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5366 || (wait_pid == pid && WIFEXITED(status)))
5367 {
5368 wait_pid = pid;
5369 break;
5370 }
5371
Bram Moolenaar0f873732019-12-05 20:28:46 +01005372 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005373 clip_update();
5374
Bram Moolenaar0f873732019-12-05 20:28:46 +01005375 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005376 // less time, gradually wait longer.
5377 mch_delay(delay_msec,
5378 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005379 if (++delay_msec > 10)
5380 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005381 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005382
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005383 if (tmode == TMODE_RAW)
5384 // possibly enables modifyOtherKeys again
Bram Moolenaar733a69b2022-12-01 12:03:47 +00005385 out_str_t_TI();
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005386 }
5387# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388
5389 /*
5390 * Wait until our child has exited.
5391 * Ignore wait() returning pids of other children and returning
5392 * because of some signal like SIGWINCH.
5393 * Don't wait if wait_pid was already set above, indicating the
5394 * child already exited.
5395 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005396 if (wait_pid != pid)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01005397 (void)wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398
Bram Moolenaar624891f2010-10-13 16:22:09 +02005399# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005400 // Close slave side of pty. Only do this after the child has
5401 // exited, otherwise the child may hang when it tries to write on
5402 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005403 if (pty_master_fd >= 0)
5404 close(pty_slave_fd);
5405# endif
5406
Bram Moolenaar0f873732019-12-05 20:28:46 +01005407 // Make sure the child that writes to the external program is
5408 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005409 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005410 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005411 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005412 wait4pid(wpid, NULL);
5413 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005414
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005415# ifdef FEAT_JOB_CHANNEL
5416 --dont_check_job_ended;
5417# endif
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 /*
5420 * Set to raw mode right now, otherwise a CTRL-C after
5421 * catch_signals() will kill Vim.
5422 */
5423 if (tmode == TMODE_RAW)
5424 settmode(TMODE_RAW);
5425 did_settmode = TRUE;
5426 set_signals();
5427
5428 if (WIFEXITED(status))
5429 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005430 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005432 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 {
5434 if (retval == EXEC_FAILED)
5435 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005436 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 msg_outtrans(p_sh);
5438 msg_putchar('\n');
5439 }
5440 else if (!(options & SHELL_SILENT))
5441 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005442 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 msg_outnum((long)retval);
5444 msg_putchar('\n');
5445 }
5446 }
5447 }
5448 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005449 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 }
5451 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
5453error:
5454 if (!did_settmode)
5455 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005456 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 resettitle();
Bram Moolenaar13568252018-03-16 20:46:58 +01005458 vim_free(argv);
5459 vim_free(tofree1);
5460 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005463}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005464#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005465
5466 int
5467mch_call_shell(
5468 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005469 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005470{
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005471#ifdef FEAT_EVAL
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005472 ch_log(NULL, "executing shell command: %s", cmd);
5473#endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005474#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
Bram Moolenaar524c8532022-09-27 15:48:20 +01005475 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL
5476 && (options & SHELL_SILENT) == 0)
Bram Moolenaar13568252018-03-16 20:46:58 +01005477 return mch_call_shell_terminal(cmd, options);
5478#endif
5479#ifdef USE_SYSTEM
5480 return mch_call_shell_system(cmd, options);
5481#else
5482 return mch_call_shell_fork(cmd, options);
5483#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484}
5485
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005486#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005487 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005488mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005489{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005490 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005491 int fd_in[2] = {-1, -1}; // for stdin
5492 int fd_out[2] = {-1, -1}; // for stdout
5493 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005494 int pty_master_fd = -1;
5495 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005496 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005497 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5498 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5499 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005500 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005501 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5502 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005503 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005504 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005505 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005506
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005507 if (use_out_for_err && use_null_for_out)
5508 use_null_for_err = TRUE;
5509
Bram Moolenaar0f873732019-12-05 20:28:46 +01005510 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005511 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005512
Bram Moolenaarb2412082017-08-20 18:09:14 +02005513 if (options->jo_pty
5514 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005515 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005516 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005517 open_pty(&pty_master_fd, &pty_slave_fd,
5518 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005519
Bram Moolenaar0f873732019-12-05 20:28:46 +01005520 // TODO: without the channel feature connect the child to /dev/null?
5521 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005522 if (use_file_for_in)
5523 {
5524 char_u *fname = options->jo_io_name[PART_IN];
5525
5526 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5527 if (fd_in[0] < 0)
5528 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005529 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005530 goto failed;
5531 }
5532 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005533 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005534 // When writing buffer lines to the input don't use the pty, so that
5535 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005536 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5537 && pipe(fd_in) < 0)
5538 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005539
5540 if (use_file_for_out)
5541 {
5542 char_u *fname = options->jo_io_name[PART_OUT];
5543
5544 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5545 if (fd_out[1] < 0)
5546 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005547 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005548 goto failed;
5549 }
5550 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005551 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005552 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005553
5554 if (use_file_for_err)
5555 {
5556 char_u *fname = options->jo_io_name[PART_ERR];
5557
5558 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5559 if (fd_err[1] < 0)
5560 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005561 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005562 goto failed;
5563 }
5564 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005565 else if (!use_out_for_err && !use_null_for_err
5566 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005567 goto failed;
5568
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005569 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5570 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005571 if (options->jo_set & JO_CHANNEL)
5572 {
5573 channel = options->jo_channel;
5574 if (channel != NULL)
5575 ++channel->ch_refcount;
5576 }
5577 else
5578 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005579 if (channel == NULL)
5580 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005581 if (job->jv_tty_out != NULL)
5582 ch_log(channel, "using pty %s on fd %d",
5583 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005584 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005585
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005586 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005587 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005588 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005589 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005590 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005591 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005592 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005593 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005594 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005595 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005596 int null_fd = -1;
5597 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005598
Bram Moolenaar0f873732019-12-05 20:28:46 +01005599 // child
5600 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005601 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005602
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005603# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01005604 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005605 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005606 ch_logfile((char_u *)"", (char_u *)"");
5607# endif
5608
Bram Moolenaar835dc632016-02-07 14:27:38 +01005609# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005610 // Create our own process group, so that the child and all its
5611 // children can be kill()ed. Don't do this when using pipes,
5612 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005613 (void)setsid();
5614# endif
5615
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005616# ifdef FEAT_TERMINAL
5617 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005618 {
5619 char *term = (char *)T_NAME;
5620
5621#ifdef FEAT_GUI
5622 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005623 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005624 term = getenv("TERM");
5625#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005626 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005627 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005628 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005629 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005630 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005631 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005632 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005633 else if (t_colors > 16)
5634 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005635 else
5636 term = "xterm";
5637 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005638 set_child_environment(
5639 (long)options->jo_term_rows,
5640 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005641 term,
5642 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005643 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005644 else
5645# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005646 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005647
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005648 if (options->jo_env != NULL)
5649 {
5650 dict_T *dict = options->jo_env;
5651 hashitem_T *hi;
5652 int todo = (int)dict->dv_hashtab.ht_used;
5653
5654 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5655 if (!HASHITEM_EMPTY(hi))
5656 {
5657 typval_T *item = &dict_lookup(hi)->di_tv;
5658
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00005659 vim_setenv(hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005660 --todo;
5661 }
5662 }
5663
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005664 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005665 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005666 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005667 if (null_fd < 0)
5668 {
5669 perror("opening /dev/null failed");
5670 _exit(OPEN_NULL_FAILED);
5671 }
5672 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005673
Bram Moolenaar223896d2017-08-02 22:33:28 +02005674 if (pty_slave_fd >= 0)
5675 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005676 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005677 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005678# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005679 // Try to become controlling tty (probably doesn't work,
5680 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005681 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5682# endif
5683 }
5684
Bram Moolenaar0f873732019-12-05 20:28:46 +01005685 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005686 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005687 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005688 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005689 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005690 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005691 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005692 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005693
Bram Moolenaar0f873732019-12-05 20:28:46 +01005694 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005695 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005696 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005697 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005698 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005699 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005700 }
5701 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005702 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005703 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005704 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005705 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005706 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005707
Bram Moolenaar0f873732019-12-05 20:28:46 +01005708 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005709 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005710 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005711 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005712 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005713 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005714 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005715 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005716
5717 if (fd_in[0] >= 0)
5718 close(fd_in[0]);
5719 if (fd_in[1] >= 0)
5720 close(fd_in[1]);
5721 if (fd_out[0] >= 0)
5722 close(fd_out[0]);
5723 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005724 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005725 if (fd_err[0] >= 0)
5726 close(fd_err[0]);
5727 if (fd_err[1] >= 0)
5728 close(fd_err[1]);
5729 if (pty_master_fd >= 0)
5730 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005731 close(pty_master_fd); // not used in the child
5732 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005733 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005734
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005735 if (null_fd >= 0)
5736 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005737
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005738 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5739 _exit(EXEC_FAILED);
5740
Bram Moolenaar0f873732019-12-05 20:28:46 +01005741 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005742 execvp(argv[0], argv);
5743
Bram Moolenaar4694a172016-04-21 14:05:23 +02005744 if (stderr_works)
5745 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005746# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005747 // calling free_all_mem() here causes problems. Ignore valgrind
5748 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005749# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005750 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005751 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005752
Bram Moolenaar0f873732019-12-05 20:28:46 +01005753 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005754 UNBLOCK_SIGNALS(&curset);
5755
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005756 job->jv_pid = pid;
5757 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005758 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005759
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005760 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005761 close(pty_slave_fd); // not used in the parent
5762 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005763 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005764 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005765 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005766 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005767 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005768 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005769 if (channel != NULL)
5770 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005771 int in_fd = INVALID_FD;
5772 int out_fd = INVALID_FD;
5773 int err_fd = INVALID_FD;
5774
5775 if (!(use_file_for_in || use_null_for_in))
5776 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5777
5778 if (!(use_file_for_out || use_null_for_out))
5779 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5780
5781 // When using pty_master_fd only set it for stdout, do not duplicate
5782 // it for stderr, it only needs to be read once.
5783 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5784 {
5785 if (fd_err[0] >= 0)
5786 err_fd = fd_err[0];
5787 else if (out_fd != pty_master_fd)
5788 err_fd = pty_master_fd;
5789 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005790
5791 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005792 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005793 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005794 else
5795 {
5796 if (fd_in[1] >= 0)
5797 close(fd_in[1]);
5798 if (fd_out[0] >= 0)
5799 close(fd_out[0]);
5800 if (fd_err[0] >= 0)
5801 close(fd_err[0]);
5802 if (pty_master_fd >= 0)
5803 close(pty_master_fd);
5804 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005805
Bram Moolenaar0f873732019-12-05 20:28:46 +01005806 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005807 return;
5808
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005809failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005810 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005811 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005812 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005813 if (fd_in[1] >= 0)
5814 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005815 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005816 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005817 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005818 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005819 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005820 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005821 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005822 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005823 if (pty_master_fd >= 0)
5824 close(pty_master_fd);
5825 if (pty_slave_fd >= 0)
5826 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005827}
5828
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005829 static char_u *
5830get_signal_name(int sig)
5831{
5832 int i;
5833 char_u numbuf[NUMBUFLEN];
5834
5835 if (sig == SIGKILL)
5836 return vim_strsave((char_u *)"kill");
5837
5838 for (i = 0; signal_info[i].sig != -1; i++)
5839 if (sig == signal_info[i].sig)
5840 return strlow_save((char_u *)signal_info[i].name);
5841
5842 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5843 return vim_strsave(numbuf);
5844}
5845
Bram Moolenaar835dc632016-02-07 14:27:38 +01005846 char *
5847mch_job_status(job_T *job)
5848{
5849# ifdef HAVE_UNION_WAIT
5850 union wait status;
5851# else
5852 int status = -1;
5853# endif
5854 pid_t wait_pid = 0;
5855
5856# ifdef __NeXT__
5857 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5858# else
5859 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5860# endif
5861 if (wait_pid == -1)
5862 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005863 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005864 if (job->jv_status < JOB_ENDED)
5865 ch_log(job->jv_channel, "Job no longer exists: %s",
5866 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005867 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005868 }
5869 if (wait_pid == 0)
5870 return "run";
5871 if (WIFEXITED(status))
5872 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005873 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005874 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005875 if (job->jv_status < JOB_ENDED)
5876 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005877 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005878 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005879 if (WIFSIGNALED(status))
5880 {
5881 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005882 job->jv_termsig = get_signal_name(WTERMSIG(status));
5883 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5884 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5885 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005886 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005887 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005888 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005889
5890return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005891 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005892 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005893 return "dead";
5894}
5895
5896 job_T *
5897mch_detect_ended_job(job_T *job_list)
5898{
5899# ifdef HAVE_UNION_WAIT
5900 union wait status;
5901# else
5902 int status = -1;
5903# endif
5904 pid_t wait_pid = 0;
5905 job_T *job;
5906
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005907# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005908 // Do not do this when waiting for a shell command to finish, we would get
5909 // the exit value here (and discard it), the exit value obtained there
5910 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005911 if (dont_check_job_ended > 0)
5912 return NULL;
5913# endif
5914
Bram Moolenaar97792de2016-10-15 18:36:49 +02005915# ifdef __NeXT__
5916 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5917# else
5918 wait_pid = waitpid(-1, &status, WNOHANG);
5919# endif
5920 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005921 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005922 return NULL;
5923 for (job = job_list; job != NULL; job = job->jv_next)
5924 {
5925 if (job->jv_pid == wait_pid)
5926 {
5927 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005928 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005929 job->jv_exitval = WEXITSTATUS(status);
5930 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005931 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005932 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005933 job->jv_termsig = get_signal_name(WTERMSIG(status));
5934 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005935 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005936 {
5937 ch_log(job->jv_channel, "Job ended");
5938 job->jv_status = JOB_ENDED;
5939 }
5940 return job;
5941 }
5942 }
5943 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005944}
5945
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005946/*
5947 * Send a (deadly) signal to "job".
5948 * Return FAIL if "how" is not a valid name.
5949 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005950 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005951mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005952{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005953 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005954
Bram Moolenaar923d9262016-02-25 20:56:01 +01005955 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005956 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005957 else if (STRCMP(how, "hup") == 0)
5958 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005959 else if (STRCMP(how, "quit") == 0)
5960 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005961 else if (STRCMP(how, "int") == 0)
5962 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005963 else if (STRCMP(how, "kill") == 0)
5964 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005965#ifdef SIGWINCH
5966 else if (STRCMP(how, "winch") == 0)
5967 sig = SIGWINCH;
5968#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005969 else if (isdigit(*how))
5970 sig = atoi((char *)how);
5971 else
5972 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005973
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005974 // Never kill ourselves!
5975 if (job->jv_pid != 0)
5976 {
5977 // TODO: have an option to only kill the process, not the group?
5978 kill(-job->jv_pid, sig);
5979 kill(job->jv_pid, sig);
5980 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005981
Bram Moolenaar835dc632016-02-07 14:27:38 +01005982 return OK;
5983}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005984
5985/*
5986 * Clear the data related to "job".
5987 */
5988 void
5989mch_clear_job(job_T *job)
5990{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005991 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01005992# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005993 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005994# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005995 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005996# endif
5997}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005998#endif
5999
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006000#if defined(FEAT_TERMINAL) || defined(PROTO)
6001 int
6002mch_create_pty_channel(job_T *job, jobopt_T *options)
6003{
6004 int pty_master_fd = -1;
6005 int pty_slave_fd = -1;
6006 channel_T *channel;
6007
Bram Moolenaar59386482019-02-10 22:43:46 +01006008 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02006009 if (pty_master_fd < 0 || pty_slave_fd < 0)
6010 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006011 close(pty_slave_fd);
6012
6013 channel = add_channel();
6014 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006015 {
6016 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006017 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006018 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02006019 if (job->jv_tty_out != NULL)
6020 ch_log(channel, "using pty %s on fd %d",
6021 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006022 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006023 channel->ch_keep_open = TRUE;
6024
Bram Moolenaar0f873732019-12-05 20:28:46 +01006025 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
6026 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006027 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006028 channel_set_job(channel, job, options);
6029 return OK;
6030}
6031#endif
6032
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033/*
6034 * Check for CTRL-C typed by reading all available characters.
6035 * In cooked mode we should get SIGINT, no need to check.
6036 */
6037 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006038mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039{
Bram Moolenaar26e86442020-05-17 14:06:16 +02006040 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006041 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 fill_input_buf(FALSE);
6043}
6044
6045/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006046 * Wait "msec" msec until a character is available from the mouse, keyboard,
6047 * from inbuf[].
6048 * "msec" == -1 will block forever.
6049 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006050 * When "ignore_input" is TRUE even check for pending input when input is
6051 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006052 * "interrupted" (if not NULL) is set to TRUE when no character is available
6053 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02006054 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006055 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 */
6057 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006058WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006060#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01006061 return ui_wait_for_chars_or_timer(
6062 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006063#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006064 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006065#endif
6066}
6067
6068/*
6069 * Wait "msec" msec until a character is available from the mouse or keyboard
6070 * or from inbuf[].
6071 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006072 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006073 * "interrupted" (if not NULL) is set to TRUE when no character is available
6074 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006075 * When a GUI is being used, this will never get called -- webb
6076 */
6077 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006078WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006079{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080#ifdef FEAT_MOUSE_GPM
6081 int gpm_process_wanted;
6082#endif
6083#ifdef FEAT_XCLIPBOARD
6084 int rest;
6085#endif
6086 int avail;
6087
Bram Moolenaar0f873732019-12-05 20:28:46 +01006088 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 return 1;
6090
6091#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006092 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 if (WantQueryMouse)
6094 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006095 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006096 if (!no_query_mouse_for_testing)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00006097 mch_write((char_u *)"\033[1'|", 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 }
6099#endif
6100
6101 /*
6102 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6103 * events. This is a bit complicated, because they might both be defined.
6104 */
6105#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6106# ifdef FEAT_XCLIPBOARD
6107 rest = 0;
6108 if (do_xterm_trace())
6109 rest = msec;
6110# endif
6111 do
6112 {
6113# ifdef FEAT_XCLIPBOARD
6114 if (rest != 0)
6115 {
6116 msec = XT_TRACE_DELAY;
6117 if (rest >= 0 && rest < XT_TRACE_DELAY)
6118 msec = rest;
6119 if (rest >= 0)
6120 rest -= msec;
6121 }
6122# endif
Yee Cheng Chin4314e4f2022-10-08 13:50:05 +01006123# ifdef FEAT_SOUND_MACOSX
6124 // Invoke any pending sound callbacks.
6125 process_cfrunloop();
6126# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006127# ifdef FEAT_SOUND_CANBERRA
6128 // Invoke any pending sound callbacks.
6129 if (has_sound_callback_in_queue())
6130 invoke_sound_callback();
6131# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132# ifdef FEAT_MOUSE_GPM
6133 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006134 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006135 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006136 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006138 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006140# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006142 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 return 1;
6144# ifdef FEAT_XCLIPBOARD
6145 if (rest == 0 || !do_xterm_trace())
6146# endif
6147 break;
6148 }
6149 }
6150 while (FALSE
6151# ifdef FEAT_MOUSE_GPM
6152 || (gpm_process_wanted && mch_gpm_process() == 0)
6153# endif
6154# ifdef FEAT_XCLIPBOARD
6155 || (!avail && rest != 0)
6156# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006157 )
6158 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159
6160#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006161 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162#endif
6163 return avail;
6164}
6165
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006166#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167/*
6168 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006169 * "msec" == 0 will check for characters once.
6170 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006173 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006174 * "interrupted" (if not NULL) is set to TRUE when no character is available
6175 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006177 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006178RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179{
6180 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006181 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006182#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 static int busy = FALSE;
6184
Bram Moolenaar0f873732019-12-05 20:28:46 +01006185 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186# define MAY_LOOP
6187
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006188# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006189 // Remember at what time we started, so that we know how much longer we
6190 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006191 long start_msec = msec;
6192 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006194 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006195 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196# endif
6197
Bram Moolenaar0f873732019-12-05 20:28:46 +01006198 // Handle being called recursively. This may happen for the session
6199 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 if (busy)
6201 return 0;
6202#endif
6203
6204#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006205 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206#endif
6207 {
6208#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006209 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006210# ifdef FEAT_MZSCHEME
6211 int mzquantum_used = FALSE;
6212# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213#endif
6214#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006215 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006216 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 int nfd;
6218# ifdef FEAT_XCLIPBOARD
6219 int xterm_idx = -1;
6220# endif
6221# ifdef FEAT_MOUSE_GPM
6222 int gpm_idx = -1;
6223# endif
6224# ifdef USE_XSMP
6225 int xsmp_idx = -1;
6226# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006227 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006229# ifdef FEAT_MZSCHEME
6230 mzvim_check_threads();
6231 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6232 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006233 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006234 mzquantum_used = TRUE;
6235 }
6236# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 fds[0].fd = fd;
6238 fds[0].events = POLLIN;
6239 nfd = 1;
6240
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006242 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 if (xterm_Shell != (Widget)0)
6244 {
6245 xterm_idx = nfd;
6246 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6247 fds[nfd].events = POLLIN;
6248 nfd++;
6249 }
6250# endif
6251# ifdef FEAT_MOUSE_GPM
6252 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6253 {
6254 gpm_idx = nfd;
6255 fds[nfd].fd = gpm_fd;
6256 fds[nfd].events = POLLIN;
6257 nfd++;
6258 }
6259# endif
6260# ifdef USE_XSMP
6261 if (xsmp_icefd != -1)
6262 {
6263 xsmp_idx = nfd;
6264 fds[nfd].fd = xsmp_icefd;
6265 fds[nfd].events = POLLIN;
6266 nfd++;
6267 }
6268# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006269#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006270 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006271#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006272 if (interrupted != NULL)
6273 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006275 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006276
6277 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006278 if (result == 0 && interrupted != NULL && ret > 0)
6279 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006280
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006281# ifdef FEAT_MZSCHEME
6282 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006283 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006284 finished = FALSE;
6285# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287# ifdef FEAT_XCLIPBOARD
6288 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6289 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006290 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006292 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 finished = FALSE;
6294 }
6295# endif
6296# ifdef FEAT_MOUSE_GPM
6297 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299# endif
6300# ifdef USE_XSMP
6301 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6302 {
6303 if (fds[xsmp_idx].revents & POLLIN)
6304 {
6305 busy = TRUE;
6306 xsmp_handle_requests();
6307 busy = FALSE;
6308 }
6309 else if (fds[xsmp_idx].revents & POLLHUP)
6310 {
6311 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006312 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 xsmp_close();
6314 }
6315 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006316 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 }
6318# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006319#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006320 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006321 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006322 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006323#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324
Bram Moolenaar0f873732019-12-05 20:28:46 +01006325#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326
6327 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006328 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006329 // These are static because they can take 8 Kbyte each and cause the
6330 // signal stack to run out with -O3.
6331 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006333 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006335# ifdef FEAT_MZSCHEME
6336 mzvim_check_threads();
6337 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6338 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006339 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006340 mzquantum_used = TRUE;
6341 }
6342# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006344 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006346 tv.tv_sec = towait / 1000;
6347 tv.tv_usec = (towait % 1000) * (1000000/1000);
6348 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006350 else
6351 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352
6353 /*
6354 * Select on ready for reading and exceptional condition (end of file).
6355 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006356select_eintr:
6357 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006358 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 FD_ZERO(&efds);
6360 FD_SET(fd, &rfds);
K.Takatab247e062022-02-07 10:45:23 +00006361# ifndef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006362 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 FD_SET(fd, &efds);
6364# endif
6365 maxfd = fd;
6366
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006368 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 if (xterm_Shell != (Widget)0)
6370 {
6371 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6372 if (maxfd < ConnectionNumber(xterm_dpy))
6373 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006374
Bram Moolenaar0f873732019-12-05 20:28:46 +01006375 // An event may have already been read but not handled. In
6376 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006377 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 }
6379# endif
6380# ifdef FEAT_MOUSE_GPM
6381 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6382 {
6383 FD_SET(gpm_fd, &rfds);
6384 FD_SET(gpm_fd, &efds);
6385 if (maxfd < gpm_fd)
6386 maxfd = gpm_fd;
6387 }
6388# endif
6389# ifdef USE_XSMP
6390 if (xsmp_icefd != -1)
6391 {
6392 FD_SET(xsmp_icefd, &rfds);
6393 FD_SET(xsmp_icefd, &efds);
6394 if (maxfd < xsmp_icefd)
6395 maxfd = xsmp_icefd;
6396 }
6397# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006398# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006399 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006400# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006401 if (interrupted != NULL)
6402 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403
Bram Moolenaar643b6142018-09-12 20:29:09 +02006404 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6405 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006406 result = ret > 0 && FD_ISSET(fd, &rfds);
6407 if (result)
6408 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006409 else if (interrupted != NULL && ret > 0)
6410 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006411
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006412# ifdef EINTR
6413 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006414 {
dbivolaruab16ad32021-12-29 19:41:47 +00006415 // Check whether the EINTR is caused by SIGTSTP
6416 if (got_tstp && !in_mch_suspend)
6417 {
6418 exarg_T ea;
dbivolaru79a6e252022-01-23 16:41:14 +00006419
dbivolaruab16ad32021-12-29 19:41:47 +00006420 ea.forceit = TRUE;
6421 ex_stop(&ea);
6422 got_tstp = FALSE;
6423 }
6424
Bram Moolenaar0f873732019-12-05 20:28:46 +01006425 // Check whether window has been resized, EINTR may be caused by
6426 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006427 if (do_resize)
6428 handle_resize();
6429
Bram Moolenaar0f873732019-12-05 20:28:46 +01006430 // Interrupted by a signal, need to try again. We ignore msec
6431 // here, because we do want to check even after a timeout if
6432 // characters are available. Needed for reading output of an
6433 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006434 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006435 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006436# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006437# ifdef __TANDEM
6438 if (ret == -1 && errno == ENOTSUP)
6439 {
6440 FD_ZERO(&rfds);
6441 FD_ZERO(&efds);
6442 ret = 0;
6443 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006444# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006445# ifdef FEAT_MZSCHEME
6446 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006447 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006448 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449# endif
6450
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451# ifdef FEAT_XCLIPBOARD
6452 if (ret > 0 && xterm_Shell != (Widget)0
6453 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6454 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006455 xterm_update(); // Maybe we should hand out clipboard
6456 // continue looping when we only got the X event and the input
6457 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 if (--ret == 0 && !input_available())
6459 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006460 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 finished = FALSE;
6462 }
6463 }
6464# endif
6465# ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00006466 if (ret > 0 && check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 {
6468 if (FD_ISSET(gpm_fd, &efds))
6469 gpm_close();
6470 else if (FD_ISSET(gpm_fd, &rfds))
6471 *check_for_gpm = 1;
6472 }
6473# endif
6474# ifdef USE_XSMP
6475 if (ret > 0 && xsmp_icefd != -1)
6476 {
6477 if (FD_ISSET(xsmp_icefd, &efds))
6478 {
6479 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006480 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 xsmp_close();
6482 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006483 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 }
6485 else if (FD_ISSET(xsmp_icefd, &rfds))
6486 {
6487 busy = TRUE;
6488 xsmp_handle_requests();
6489 busy = FALSE;
6490 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006491 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 }
6493 }
6494# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006495#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006496 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006497 if (ret >= 0)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01006498 (void)channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006499#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500
Bram Moolenaar0f873732019-12-05 20:28:46 +01006501#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502
6503#ifdef MAY_LOOP
6504 if (finished || msec == 0)
6505 break;
6506
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006507# ifdef FEAT_CLIENTSERVER
6508 if (server_waiting())
6509 break;
6510# endif
6511
Bram Moolenaar0f873732019-12-05 20:28:46 +01006512 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 if (msec > 0)
6514 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006515# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006516 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006517 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006519 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 msec = msec / 2;
6521# endif
6522 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006523 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 }
6525#endif
6526 }
6527
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006528 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529}
6530
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006532 * Expand a path into all matching files and/or directories. Handles "*",
6533 * "?", "[a-z]", "**", etc.
6534 * "path" has backslashes before chars that are not to be expanded.
6535 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 */
6537 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006538mch_expandpath(
6539 garray_T *gap,
6540 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006541 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542{
Bram Moolenaar02743632005-07-25 20:42:36 +00006543 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545
6546/*
6547 * mch_expand_wildcards() - this code does wild-card pattern matching using
6548 * the shell
6549 *
6550 * return OK for success, FAIL for error (you may lose some memory) and put
6551 * an error message in *file.
6552 *
6553 * num_pat is number of input patterns
6554 * pat is array of pointers to input patterns
6555 * num_file is pointer to number of matched file names
6556 * file is pointer to array of pointers to matched file names
6557 */
6558
6559#ifndef SEEK_SET
6560# define SEEK_SET 0
6561#endif
6562#ifndef SEEK_END
6563# define SEEK_END 2
6564#endif
6565
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006566#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006567
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006569mch_expand_wildcards(
6570 int num_pat,
6571 char_u **pat,
6572 int *num_file,
6573 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006574 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575{
6576 int i;
6577 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006578 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 char_u *p;
6580 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581
Bram Moolenaarc7247912008-01-13 12:54:11 +00006582 /*
6583 * This is the non-OS/2 implementation (really Unix).
6584 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 int j;
6586 char_u *tempname;
6587 char_u *command;
6588 FILE *fd;
6589 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006590#define STYLE_ECHO 0 // use "echo", the default
6591#define STYLE_GLOB 1 // use "glob", for csh
6592#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6593#define STYLE_PRINT 3 // use "print -N", for zsh
6594#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6595 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 int shell_style = STYLE_ECHO;
6597 int check_spaces;
6598 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006599 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006600 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006601 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602
Bram Moolenaar0f873732019-12-05 20:28:46 +01006603 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 *file = NULL;
6605
6606 /*
6607 * If there are no wildcards, just copy the names to allocated memory.
6608 * Saves a lot of time, because we don't have to start a new shell.
6609 */
6610 if (!have_wildcard(num_pat, pat))
6611 return save_patterns(num_pat, pat, num_file, file);
6612
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006613# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006614 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006615 if (sandbox != 0 && check_secure())
6616 return FAIL;
6617# endif
6618
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 /*
6620 * Don't allow the use of backticks in secure and restricted mode.
6621 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006622 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 for (i = 0; i < num_pat; ++i)
6624 if (vim_strchr(pat[i], '`') != NULL
6625 && (check_restricted() || check_secure()))
6626 return FAIL;
6627
6628 /*
6629 * get a name for the temp file
6630 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006631 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006633 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 return FAIL;
6635 }
6636
6637 /*
6638 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006639 * file.
6640 * STYLE_BT: NL separated
6641 * If expanding `cmd` execute it directly.
6642 * STYLE_GLOB: NUL separated
6643 * If we use *csh, "glob" will work better than "echo".
6644 * STYLE_PRINT: NL or NUL separated
6645 * If we use *zsh, "print -N" will work better than "glob".
6646 * STYLE_VIMGLOB: NL separated
6647 * If we use *sh*, we define "vimglob()".
6648 * STYLE_ECHO: space separated.
6649 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 */
6651 if (num_pat == 1 && *pat[0] == '`'
6652 && (len = STRLEN(pat[0])) > 2
6653 && *(pat[0] + len - 1) == '`')
6654 shell_style = STYLE_BT;
6655 else if ((len = STRLEN(p_sh)) >= 3)
6656 {
6657 if (STRCMP(p_sh + len - 3, "csh") == 0)
6658 shell_style = STYLE_GLOB;
6659 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6660 shell_style = STYLE_PRINT;
6661 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006662 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6663 "sh") != NULL)
6664 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665
Bram Moolenaar0f873732019-12-05 20:28:46 +01006666 // Compute the length of the command. We need 2 extra bytes: for the
6667 // optional '&' and for the NUL.
6668 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006670 if (shell_style == STYLE_VIMGLOB)
6671 len += STRLEN(sh_vimglob_func);
6672
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006673 for (i = 0; i < num_pat; ++i)
6674 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006675 // Count the length of the patterns in the same way as they are put in
6676 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006677#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006678 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006679#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006680 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006681 for (j = 0; pat[i][j] != NUL; ++j)
6682 {
6683 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006684 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006685 ++len;
6686 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006687#endif
6688 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 command = alloc(len);
6690 if (command == NULL)
6691 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006692 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 vim_free(tempname);
6694 return FAIL;
6695 }
6696
6697 /*
6698 * Build the shell command:
6699 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6700 * recognizes this).
6701 * - Add the shell command to print the expanded names.
6702 * - Add the temp file name.
6703 * - Add the file name patterns.
6704 */
6705 if (shell_style == STYLE_BT)
6706 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006707 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006708 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006709 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006711 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006712 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006714 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006716 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 *p = ' ';
6718 }
6719 STRCAT(command, ">");
6720 }
6721 else
6722 {
Christian Brabandt8b8d8292021-11-19 12:37:36 +00006723 STRCPY(command, "");
6724 if (shell_style == STYLE_GLOB)
6725 {
6726 // Assume the nonomatch option is valid only for csh like shells,
6727 // otherwise, this may set the positional parameters for the shell,
6728 // e.g. "$*".
6729 if (flags & EW_NOTFOUND)
6730 STRCAT(command, "set nonomatch; ");
6731 else
6732 STRCAT(command, "unset nonomatch; ");
6733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 if (shell_style == STYLE_GLOB)
6735 STRCAT(command, "glob >");
6736 else if (shell_style == STYLE_PRINT)
6737 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006738 else if (shell_style == STYLE_VIMGLOB)
6739 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 else
6741 STRCAT(command, "echo >");
6742 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006743
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006745
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 if (shell_style != STYLE_BT)
6747 for (i = 0; i < num_pat; ++i)
6748 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006749 // When using system() always add extra quotes, because the shell
6750 // is started twice. Otherwise put a backslash before special
6751 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752#ifdef USE_SYSTEM
6753 STRCAT(command, " \"");
6754 STRCAT(command, pat[i]);
6755 STRCAT(command, "\"");
6756#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006757 int intick = FALSE;
6758
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 p = command + STRLEN(command);
6760 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006761 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006762 {
6763 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006764 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006765 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6766 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006767 // Remove a backslash, take char literally. But keep
6768 // backslash inside backticks, before a special character
6769 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006770 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006771 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6772 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006773 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006774 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006775 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006776 else if (!intick
6777 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6778 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006779 // Put a backslash before a special character, but not
6780 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6781 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006782 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006783
Bram Moolenaar0f873732019-12-05 20:28:46 +01006784 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006785 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006786 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 *p = NUL;
6788#endif
6789 }
6790 if (flags & EW_SILENT)
6791 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006792 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006793 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794
6795 /*
6796 * Using zsh -G: If a pattern has no matches, it is just deleted from
6797 * the argument list, otherwise zsh gives an error message and doesn't
6798 * expand any other pattern.
6799 */
6800 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006801 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802
6803 /*
6804 * If we use -f then shell variables set in .cshrc won't get expanded.
6805 * vi can do it, so we will too, but it is only necessary if there is a "$"
6806 * in one of the patterns, otherwise we can still use the fast option.
6807 */
6808 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006809 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810
6811 /*
6812 * execute the shell command
6813 */
6814 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6815
Bram Moolenaar0f873732019-12-05 20:28:46 +01006816 // When running in the background, give it some time to create the temp
6817 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006818 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02006819 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820
Bram Moolenaar0f873732019-12-05 20:28:46 +01006821 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 show_shell_mess = TRUE;
6823 vim_free(command);
6824
Bram Moolenaar0f873732019-12-05 20:28:46 +01006825 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 {
6827 mch_remove(tempname);
6828 vim_free(tempname);
6829 /*
6830 * With interactive completion, the error message is not printed.
6831 * However with USE_SYSTEM, I don't know how to turn off error messages
6832 * from the shell, so screen may still get messed up -- webb.
6833 */
6834#ifndef USE_SYSTEM
6835 if (!(flags & EW_SILENT))
6836#endif
6837 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006838 redraw_later_clear(); // probably messed up screen
6839 msg_putchar('\n'); // clear bottom line quickly
6840 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841#ifdef USE_SYSTEM
6842 if (!(flags & EW_SILENT))
6843#endif
6844 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006845 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006846 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 }
6848 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006849 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6850 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 if (shell_style == STYLE_BT)
6852 return FAIL;
6853 goto notfound;
6854 }
6855
6856 /*
6857 * read the names from the file into memory
6858 */
6859 fd = fopen((char *)tempname, READBIN);
6860 if (fd == NULL)
6861 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006862 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 if (!(flags & EW_SILENT))
6864 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006865 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006866 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 }
6868 vim_free(tempname);
6869 goto notfound;
6870 }
6871 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006872 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006874 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006875 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006876 buffer = NULL;
6877 else
6878 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 if (buffer == NULL)
6880 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006881 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 mch_remove(tempname);
6883 vim_free(tempname);
6884 fclose(fd);
6885 return FAIL;
6886 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006887 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 i = fread((char *)buffer, 1, len, fd);
6889 fclose(fd);
6890 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006891 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006893 // unexpected read error
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006894 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 vim_free(tempname);
6896 vim_free(buffer);
6897 return FAIL;
6898 }
6899 vim_free(tempname);
6900
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006901# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006902 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006904 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6906 *p++ = buffer[i];
6907 len = p - buffer;
6908# endif
6909
6910
Bram Moolenaar0f873732019-12-05 20:28:46 +01006911 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 if (shell_style == STYLE_ECHO)
6913 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006914 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006916 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 {
6918 while (*p != ' ' && *p != '\n')
6919 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006920 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 }
6922 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006923 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006924 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006926 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006928 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 {
6930 while (*p != '\n' && *p != NUL)
6931 ++p;
6932 if (*p != NUL)
6933 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006934 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 }
6936 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006937 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 else
6939 {
6940 /*
6941 * Some versions of zsh use spaces instead of NULs to separate
6942 * results. Only do this when there is no NUL before the end of the
6943 * buffer, otherwise we would never be able to use file names with
6944 * embedded spaces when zsh does use NULs.
6945 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6946 * don't check for spaces again.
6947 */
6948 check_spaces = FALSE;
6949 if (shell_style == STYLE_PRINT && !did_find_nul)
6950 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006951 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006952 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006953 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 did_find_nul = TRUE;
6955 else
6956 check_spaces = TRUE;
6957 }
6958
6959 /*
6960 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6961 * already is one, for STYLE_GLOB it needs to be added.
6962 */
6963 if (len && buffer[len - 1] == NUL)
6964 --len;
6965 else
6966 buffer[len] = NUL;
6967 i = 0;
6968 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006969 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 {
6971 ++i;
6972 *p = NUL;
6973 }
6974 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006975 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 }
6977 if (i == 0)
6978 {
6979 /*
6980 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6981 * /bin/sh will happily expand it to nothing rather than returning an
6982 * error; and hey, it's good to check anyway -- webb.
6983 */
6984 vim_free(buffer);
6985 goto notfound;
6986 }
6987 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006988 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 if (*file == NULL)
6990 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006991 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 vim_free(buffer);
6993 return FAIL;
6994 }
6995
6996 /*
6997 * Isolate the individual file names.
6998 */
6999 p = buffer;
7000 for (i = 0; i < *num_file; ++i)
7001 {
7002 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007003 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00007004 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
7005 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00007007 while (!(shell_style == STYLE_ECHO && *p == ' ')
7008 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007010 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 *p = NUL;
7012 else
7013 {
7014 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007015 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 }
7017 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007018 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007020 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007022 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 }
7024 }
7025
7026 /*
7027 * Move the file names to allocated memory.
7028 */
7029 for (j = 0, i = 0; i < *num_file; ++i)
7030 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007031 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
7033 continue;
7034
Bram Moolenaar0f873732019-12-05 20:28:46 +01007035 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 dir = (mch_isdir((*file)[i]));
7037 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
7038 continue;
7039
Bram Moolenaar0f873732019-12-05 20:28:46 +01007040 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01007041 if (!dir && (flags & EW_EXEC)
7042 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00007043 continue;
7044
Bram Moolenaar964b3742019-05-24 18:54:09 +02007045 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 if (p)
7047 {
7048 STRCPY(p, (*file)[i]);
7049 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007050 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 (*file)[j++] = p;
7052 }
7053 }
7054 vim_free(buffer);
7055 *num_file = j;
7056
Bram Moolenaar0f873732019-12-05 20:28:46 +01007057 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01007059 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 goto notfound;
7061 }
7062
7063 return OK;
7064
7065notfound:
7066 if (flags & EW_NOTFOUND)
7067 return save_patterns(num_pat, pat, num_file, file);
7068 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069}
7070
Bram Moolenaar0f873732019-12-05 20:28:46 +01007071#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007074save_patterns(
7075 int num_pat,
7076 char_u **pat,
7077 int *num_file,
7078 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079{
7080 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00007081 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007083 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 if (*file == NULL)
7085 return FAIL;
7086 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00007087 {
7088 s = vim_strsave(pat[i]);
7089 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007090 // Be compatible with expand_filename(): halve the number of
7091 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007092 backslash_halve(s);
7093 (*file)[i] = s;
7094 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 *num_file = num_pat;
7096 return OK;
7097}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099/*
7100 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7101 * expand.
7102 */
7103 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007104mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007106 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 if (*p == '\\' && p[1] != NUL)
7109 ++p;
7110 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 if (vim_strchr((char_u *)
7112#ifdef VMS
7113 "*?%"
7114#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116#endif
7117 , *p) != NULL)
7118 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 }
7120 return FALSE;
7121}
7122
7123/*
7124 * Return TRUE if the string "p" contains a wildcard.
7125 * Don't recognize '~' at the end as a wildcard.
7126 */
7127 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007128mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007130 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 if (*p == '\\' && p[1] != NUL)
7133 ++p;
7134 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 if (vim_strchr((char_u *)
7136#ifdef VMS
7137 "*?%$"
7138#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140#endif
7141 , *p) != NULL
7142 || (*p == '~' && p[1] != NUL))
7143 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 }
7145 return FALSE;
7146}
7147
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007149have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150{
7151 int i;
7152
7153 for (i = 0; i < num; i++)
7154 if (mch_has_wildcard(file[i]))
7155 return 1;
7156 return 0;
7157}
7158
7159 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007160have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161{
7162 int i;
7163
7164 for (i = 0; i < num; i++)
7165 if (vim_strchr(file[i], '$') != NULL)
7166 return TRUE;
7167 return FALSE;
7168}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007170#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171/*
7172 * Scaled-down version of rename(), which is missing in Xenix.
7173 * This version can only move regular files and will fail if the
7174 * destination exists.
7175 */
7176 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007177mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178{
7179 struct stat st;
7180
Bram Moolenaar0f873732019-12-05 20:28:46 +01007181 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007183 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007185 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 return 0;
7187 return -1;
7188}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007189#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007191#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007192# if defined(DYNAMIC_GPM) || defined(PROTO)
7193/*
7194 * Initialize Gpm's symbols for dynamic linking.
7195 * Must be called only if libgpm_hinst is NULL.
7196 */
7197 static int
7198load_libgpm(void)
7199{
7200 libgpm_hinst = dlopen("libgpm.so", RTLD_LAZY|RTLD_GLOBAL);
7201
7202 if (libgpm_hinst == NULL)
7203 {
7204 if (p_verbose > 0)
7205 smsg_attr(HL_ATTR(HLF_W),
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007206 _("Could not load gpm library: %s"), dlerror());
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007207 return FAIL;
7208 }
7209
7210 if (
7211 (dll_Gpm_Open = dlsym(libgpm_hinst, "Gpm_Open")) == NULL
7212 || (dll_Gpm_Close = dlsym(libgpm_hinst, "Gpm_Close")) == NULL
7213 || (dll_Gpm_GetEvent = dlsym(libgpm_hinst, "Gpm_GetEvent")) == NULL
7214 || (dll_gpm_flag = dlsym(libgpm_hinst, "gpm_flag")) == NULL
7215 || (dll_gpm_fd = dlsym(libgpm_hinst, "gpm_fd")) == NULL
7216 )
7217 {
7218 semsg(_(e_could_not_load_library_str_str), "gpm", dlerror());
7219 dlclose(libgpm_hinst);
7220 libgpm_hinst = NULL;
7221 dll_gpm_flag = NULL;
7222 dll_gpm_fd = NULL;
7223 return FAIL;
7224 }
7225 return OK;
7226}
7227
7228 int
7229gpm_available(void)
7230{
7231 return libgpm_hinst != NULL || load_libgpm() == OK;
7232}
7233# endif // DYNAMIC_GPM
7234
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235/*
7236 * Initializes connection with gpm (if it isn't already opened)
7237 * Return 1 if succeeded (or connection already opened), 0 if failed
7238 */
7239 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007240gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007242 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007244#ifdef DYNAMIC_GPM
7245 if (!gpm_available())
7246 return 0;
7247#endif
7248
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 if (!gpm_flag)
7250 {
7251 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7252 gpm_connect.defaultMask = ~GPM_HARD;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007253 // Default handling for mouse move
7254 gpm_connect.minMod = 0; // Handle any modifier keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 gpm_connect.maxMod = 0xffff;
7256 if (Gpm_Open(&gpm_connect, 0) > 0)
7257 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007258 // gpm library tries to handling TSTP causes
7259 // problems. Anyways, we close connection to Gpm whenever
7260 // we are going to suspend or starting an external process
7261 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007262# ifdef SIGTSTP
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007263 signal(SIGTSTP, restricted ? SIG_IGN : (void (*)())sig_tstp);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007264# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007265 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 }
7267 if (gpm_fd == -2)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007268 Gpm_Close(); // We don't want to talk to xterm via gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 return 0;
7270 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007271 return 1; // already open
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272}
7273
7274/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007275 * Returns TRUE if the GPM mouse is enabled.
7276 */
7277 int
7278gpm_enabled(void)
7279{
7280 return gpm_flag && gpm_fd >= 0;
7281}
7282
7283/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 */
7286 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007287gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007289 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 Gpm_Close();
7291}
7292
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007293/*
7294 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007296 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 */
7298 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007299mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300{
7301 int button;
7302 static Gpm_Event gpm_event;
7303 char_u string[6];
7304 int_u vim_modifiers;
7305 int row,col;
7306 unsigned char buttons_mask;
7307 unsigned char gpm_modifiers;
7308 static unsigned char old_buttons = 0;
7309
7310 Gpm_GetEvent(&gpm_event);
7311
7312#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007313 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 if (hold_gui_events)
7315 return 0;
7316#endif
7317
7318 row = gpm_event.y - 1;
7319 col = gpm_event.x - 1;
7320
Bram Moolenaar0f873732019-12-05 20:28:46 +01007321 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 string[1] = 'M';
7323 string[2] = 'G';
7324 switch (GPM_BARE_EVENTS(gpm_event.type))
7325 {
7326 case GPM_DRAG:
7327 string[3] = MOUSE_DRAG;
7328 break;
7329 case GPM_DOWN:
7330 buttons_mask = gpm_event.buttons & ~old_buttons;
7331 old_buttons = gpm_event.buttons;
7332 switch (buttons_mask)
7333 {
7334 case GPM_B_LEFT:
7335 button = MOUSE_LEFT;
7336 break;
7337 case GPM_B_MIDDLE:
7338 button = MOUSE_MIDDLE;
7339 break;
7340 case GPM_B_RIGHT:
7341 button = MOUSE_RIGHT;
7342 break;
7343 default:
7344 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007345 // Don't know what to do. Can more than one button be
7346 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 }
7348 string[3] = (char_u)(button | 0x20);
7349 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7350 break;
7351 case GPM_UP:
7352 string[3] = MOUSE_RELEASE;
7353 old_buttons &= ~gpm_event.buttons;
7354 break;
7355 default:
7356 return 0;
7357 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007358 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 gpm_modifiers = gpm_event.modifiers;
7360 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007361 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7362 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7363 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7365 vim_modifiers |= MOUSE_SHIFT;
7366
7367 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7368 vim_modifiers |= MOUSE_CTRL;
7369 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7370 vim_modifiers |= MOUSE_ALT;
7371 string[3] |= vim_modifiers;
7372 string[4] = (char_u)(col + ' ' + 1);
7373 string[5] = (char_u)(row + ' ' + 1);
7374 add_to_input_buf(string, 6);
7375 return 6;
7376}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007377#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007379#ifdef FEAT_SYSMOUSE
7380/*
7381 * Initialize connection with sysmouse.
7382 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7383 * output, any sysmouse output than will be processed via sig_sysmouse().
7384 * Return OK if succeeded, FAIL if failed.
7385 */
7386 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007387sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007388{
7389 struct mouse_info mouse;
7390
7391 mouse.operation = MOUSE_MODE;
7392 mouse.u.mode.mode = 0;
7393 mouse.u.mode.signal = SIGUSR2;
7394 if (ioctl(1, CONS_MOUSECTL, &mouse) != -1)
7395 {
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007396 signal(SIGUSR2, (void (*)())sig_sysmouse);
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007397 mouse.operation = MOUSE_SHOW;
7398 ioctl(1, CONS_MOUSECTL, &mouse);
7399 return OK;
7400 }
7401 return FAIL;
7402}
7403
7404/*
7405 * Stop processing SIGUSR2 signals, and also make sure that
7406 * virtual console do not send us any sysmouse related signal.
7407 */
7408 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007409sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007410{
7411 struct mouse_info mouse;
7412
7413 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7414 mouse.operation = MOUSE_MODE;
7415 mouse.u.mode.mode = 0;
7416 mouse.u.mode.signal = 0;
7417 ioctl(1, CONS_MOUSECTL, &mouse);
7418}
7419
7420/*
7421 * Gets info from sysmouse and adds special keys to input buf.
7422 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007423 static void
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007424sig_sysmouse SIGDEFARG(sigarg)
7425{
7426 struct mouse_info mouse;
7427 struct video_info video;
7428 char_u string[6];
7429 int row, col;
7430 int button;
7431 int buttons;
7432 static int oldbuttons = 0;
7433
7434#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007435 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007436 if (hold_gui_events)
7437 return;
7438#endif
7439
7440 mouse.operation = MOUSE_GETINFO;
7441 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7442 && ioctl(1, FBIO_MODEINFO, &video) != -1
7443 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7444 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7445 {
7446 row = mouse.u.data.y / video.vi_cheight;
7447 col = mouse.u.data.x / video.vi_cwidth;
7448 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007449 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007450 string[1] = 'M';
7451 string[2] = 'S';
7452 if (oldbuttons == buttons && buttons != 0)
7453 {
7454 button = MOUSE_DRAG;
7455 }
7456 else
7457 {
7458 switch (buttons)
7459 {
7460 case 0:
7461 button = MOUSE_RELEASE;
7462 break;
7463 case 1:
7464 button = MOUSE_LEFT;
7465 break;
7466 case 2:
7467 button = MOUSE_MIDDLE;
7468 break;
7469 case 4:
7470 button = MOUSE_RIGHT;
7471 break;
7472 default:
7473 return;
7474 }
7475 oldbuttons = buttons;
7476 }
7477 string[3] = (char_u)(button);
7478 string[4] = (char_u)(col + ' ' + 1);
7479 string[5] = (char_u)(row + ' ' + 1);
7480 add_to_input_buf(string, 6);
7481 }
7482 return;
7483}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007484#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007485
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007487typedef char_u * (*STRPROCSTR)(char_u *);
7488typedef char_u * (*INTPROCSTR)(int);
7489typedef int (*STRPROCINT)(char_u *);
7490typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491
7492/*
7493 * Call a DLL routine which takes either a string or int param
7494 * and returns an allocated string.
7495 */
7496 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007497mch_libcall(
7498 char_u *libname,
7499 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007500 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007501 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007502 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007503 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504{
7505# if defined(USE_DLOPEN)
7506 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007507 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508# else
7509 shl_t hinstLib;
7510# endif
7511 STRPROCSTR ProcAdd;
7512 INTPROCSTR ProcAddI;
7513 char_u *retval_str = NULL;
7514 int retval_int = 0;
7515 int success = FALSE;
7516
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007517 /*
7518 * Get a handle to the DLL module.
7519 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007521 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007522 (void)dlerror();
7523
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 hinstLib = dlopen((char *)libname, RTLD_LAZY
7525# ifdef RTLD_LOCAL
7526 | RTLD_LOCAL
7527# endif
7528 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007529 if (hinstLib == NULL)
7530 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007531 // "dlerr" must be used before dlclose()
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007532 dlerr = dlerror();
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007533 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007534 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007535 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536# else
7537 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7538# endif
7539
Bram Moolenaar0f873732019-12-05 20:28:46 +01007540 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 if (hinstLib != NULL)
7542 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007543# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 /*
7545 * Catch a crash when calling the library function. For example when
7546 * using a number where a string pointer is expected.
7547 */
7548 mch_startjmp();
7549 if (SETJMP(lc_jump_env) != 0)
7550 {
7551 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007552# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007553 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007554# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 mch_didjmp();
7556 }
7557 else
7558# endif
7559 {
7560 retval_str = NULL;
7561 retval_int = 0;
7562
7563 if (argstring != NULL)
7564 {
7565# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007566 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007567 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568# else
7569 if (shl_findsym(&hinstLib, (const char *)funcname,
7570 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7571 ProcAdd = NULL;
7572# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007573 if ((success = (ProcAdd != NULL
7574# if defined(USE_DLOPEN)
7575 && dlerr == NULL
7576# endif
7577 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 {
7579 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007580 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 else
7582 retval_str = (ProcAdd)(argstring);
7583 }
7584 }
7585 else
7586 {
7587# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007588 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007589 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590# else
7591 if (shl_findsym(&hinstLib, (const char *)funcname,
7592 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7593 ProcAddI = NULL;
7594# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007595 if ((success = (ProcAddI != NULL
7596# if defined(USE_DLOPEN)
7597 && dlerr == NULL
7598# endif
7599 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 {
7601 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007602 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 else
7604 retval_str = (ProcAddI)(argint);
7605 }
7606 }
7607
Bram Moolenaar0f873732019-12-05 20:28:46 +01007608 // Save the string before we free the library.
7609 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 if (string_result == NULL)
7611 *number_result = retval_int;
7612 else if (retval_str != NULL
7613 && retval_str != (char_u *)1
7614 && retval_str != (char_u *)-1)
7615 *string_result = vim_strsave(retval_str);
7616 }
7617
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007618# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619 mch_endjmp();
7620# ifdef SIGHASARG
7621 if (lc_signal != 0)
7622 {
7623 int i;
7624
Bram Moolenaar0f873732019-12-05 20:28:46 +01007625 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 for (i = 0; signal_info[i].sig != -1; i++)
7627 if (lc_signal == signal_info[i].sig)
7628 break;
Bram Moolenaarac78dd42022-01-02 19:25:26 +00007629 semsg(e_got_sig_str_in_libcall, signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 }
7631# endif
7632# endif
7633
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007635 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007636 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007637 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007638
Bram Moolenaar0f873732019-12-05 20:28:46 +01007639 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 (void)dlclose(hinstLib);
7641# else
7642 (void)shl_unload(hinstLib);
7643# endif
7644 }
7645
7646 if (!success)
7647 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007648 semsg(_(e_library_call_failed_for_str), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 return FAIL;
7650 }
7651
7652 return OK;
7653}
7654#endif
7655
7656#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007657static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658static int xterm_button;
7659
7660/*
7661 * Setup a dummy window for X selections in a terminal.
7662 */
7663 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007664setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665{
7666 int z = 0;
7667 char *strp = "";
7668 Widget AppShell;
7669
7670 if (!x_connect_to_server())
7671 return;
7672
7673 open_app_context();
7674 if (app_context != NULL && xterm_Shell == (Widget)0)
7675 {
7676 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007677# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007679# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007680# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007681 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682
7683 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007684 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685# endif
7686
Bram Moolenaar0f873732019-12-05 20:28:46 +01007687 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 oldhandler = XSetErrorHandler(x_error_check);
7689
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007690# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007691 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7693 mch_startjmp();
7694 if (SETJMP(lc_jump_env) != 0)
7695 {
7696 mch_didjmp();
7697 xterm_dpy = NULL;
7698 }
7699 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007700# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 {
7702 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7703 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007704 if (xterm_dpy != NULL)
7705 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007706# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007708# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 }
7710
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007711# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007712 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007714# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007715 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 (void)XSetErrorHandler(oldhandler);
7717
7718 if (xterm_dpy == NULL)
7719 {
7720 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007721 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 return;
7723 }
7724
Bram Moolenaar0f873732019-12-05 20:28:46 +01007725 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 (void)XSetIOErrorHandler(x_IOerror_handler);
7727
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007728# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007730 {
7731 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007732 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007733 verbose_leave();
7734 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735# endif
7736
Bram Moolenaar0f873732019-12-05 20:28:46 +01007737 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7739 applicationShellWidgetClass, xterm_dpy,
7740 NULL);
7741 if (AppShell == (Widget)0)
7742 return;
7743 xterm_Shell = XtVaCreatePopupShell("VIM",
7744 topLevelShellWidgetClass, AppShell,
7745 XtNmappedWhenManaged, 0,
7746 XtNwidth, 1,
7747 XtNheight, 1,
7748 NULL);
7749 if (xterm_Shell == (Widget)0)
7750 return;
7751
7752 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007753 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754 if (x11_display == NULL)
7755 x11_display = xterm_dpy;
7756
7757 XtRealizeWidget(xterm_Shell);
7758 XSync(xterm_dpy, False);
7759 xterm_update();
7760 }
7761 if (xterm_Shell != (Widget)0)
7762 {
7763 clip_init(TRUE);
7764 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7765 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007766 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 if (test_x11_window(xterm_dpy) == FAIL)
7768 x11_window = 0;
7769 if (x11_window != 0)
7770 xterm_trace = 0;
7771 }
7772}
7773
7774 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007775start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776{
7777 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7778 return;
7779 xterm_trace = 1;
7780 xterm_button = button;
7781 do_xterm_trace();
7782}
7783
7784
7785 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007786stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787{
7788 if (xterm_trace < 0)
7789 return;
7790 xterm_trace = 0;
7791}
7792
7793/*
7794 * Query the xterm pointer and generate mouse termcodes if necessary
7795 * return TRUE if dragging is active, else FALSE
7796 */
7797 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007798do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799{
7800 Window root, child;
7801 int root_x, root_y;
7802 int win_x, win_y;
7803 int row, col;
7804 int_u mask_return;
7805 char_u buf[50];
7806 char_u *strp;
7807 long got_hints;
7808 static char_u *mouse_code;
7809 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7810 static int prev_row = 0, prev_col = 0;
7811 static XSizeHints xterm_hints;
7812
7813 if (xterm_trace <= 0)
7814 return FALSE;
7815
7816 if (xterm_trace == 1)
7817 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007818 // Get the hints just before tracking starts. The font size might
7819 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007820 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7821 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 || xterm_hints.width_inc <= 1
7823 || xterm_hints.height_inc <= 1)
7824 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007825 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 return FALSE;
7827 }
7828
Bram Moolenaar0f873732019-12-05 20:28:46 +01007829 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 mouse_code = find_termcode(mouse_name);
7831 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007832 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 xterm_trace = 2;
7834
Bram Moolenaar0f873732019-12-05 20:28:46 +01007835 // Find the offset of the chars, there might be a scrollbar on the
7836 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7838 &win_x, &win_y, &mask_return);
7839 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7840 - (xterm_hints.height_inc / 2);
7841 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7842 xterm_hints.y = 2;
7843 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7844 - (xterm_hints.width_inc / 2);
7845 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7846 xterm_hints.x = 2;
7847 return TRUE;
7848 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007849 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 {
7851 xterm_trace = 0;
7852 return FALSE;
7853 }
7854
7855 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7856 &win_x, &win_y, &mask_return);
7857
7858 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7859 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7860 if (row == prev_row && col == prev_col)
7861 return TRUE;
7862
7863 STRCPY(buf, mouse_code);
7864 strp = buf + STRLEN(buf);
7865 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7866 *strp++ = (char_u)(col + ' ' + 1);
7867 *strp++ = (char_u)(row + ' ' + 1);
7868 *strp = 0;
7869 add_to_input_buf(buf, STRLEN(buf));
7870
7871 prev_row = row;
7872 prev_col = col;
7873 return TRUE;
7874}
7875
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007876# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877/*
7878 * Destroy the display, window and app_context. Required for GTK.
7879 */
7880 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007881clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882{
7883 if (xterm_Shell != (Widget)0)
7884 {
7885 XtDestroyWidget(xterm_Shell);
7886 xterm_Shell = (Widget)0;
7887 }
7888 if (xterm_dpy != NULL)
7889 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007890# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007891 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007893# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 if (x11_display == xterm_dpy)
7895 x11_display = NULL;
7896 xterm_dpy = NULL;
7897 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007898# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 if (app_context != (XtAppContext)NULL)
7900 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007901 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 XtDestroyApplicationContext(app_context);
7903 app_context = (XtAppContext)NULL;
7904 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007905# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906}
7907# endif
7908
7909/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007910 * Catch up with GUI or X events.
7911 */
7912 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007913clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007914{
7915# ifdef FEAT_GUI
7916 if (gui.in_use)
7917 gui_mch_update();
7918 else
7919# endif
7920 if (xterm_Shell != (Widget)0)
7921 xterm_update();
7922}
7923
7924/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 * Catch up with any queued X events. This may put keyboard input into the
7926 * input buffer, call resize call-backs, trigger timers etc. If there is
7927 * nothing in the X event queue (& no timers pending), then we return
7928 * immediately.
7929 */
7930 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007931xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932{
7933 XEvent event;
7934
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007935 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007937 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007939 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007940 break;
7941
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007942 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007943 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007944 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007945 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007946#ifdef FEAT_CLIENTSERVER
7947 {
7948 XPropertyEvent *e = (XPropertyEvent *)&event;
7949
7950 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007952 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007953 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007955 XtDispatchEvent(&event);
7956 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007957 else
7958 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007959 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007960 XtAppProcessEvent(app_context, mask);
7961 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 }
7963}
7964
7965 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007966clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967{
7968 if (xterm_Shell != (Widget)0)
7969 return clip_x11_own_selection(xterm_Shell, cbd);
7970 return FAIL;
7971}
7972
7973 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007974clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975{
7976 if (xterm_Shell != (Widget)0)
7977 clip_x11_lose_selection(xterm_Shell, cbd);
7978}
7979
7980 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007981clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982{
7983 if (xterm_Shell != (Widget)0)
7984 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7985}
7986
7987 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007988clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989{
7990 clip_x11_set_selection(cbd);
7991}
7992#endif
7993
7994
7995#if defined(USE_XSMP) || defined(PROTO)
7996/*
7997 * Code for X Session Management Protocol.
7998 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999
8000# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001/*
8002 * This is our chance to ask the user if they want to save,
8003 * or abort the logout
8004 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008006xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007{
Bram Moolenaare1004402020-10-24 20:49:43 +02008008 int save_cmod_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 int cancel_shutdown = False;
8010
Bram Moolenaare1004402020-10-24 20:49:43 +02008011 save_cmod_flags = cmdmod.cmod_flags;
8012 cmdmod.cmod_flags |= CMOD_CONFIRM;
Bram Moolenaar027387f2016-01-02 22:25:52 +01008013 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01008014 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 cancel_shutdown = True;
Bram Moolenaare1004402020-10-24 20:49:43 +02008016 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar0f873732019-12-05 20:28:46 +01008017 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 out_flush();
8019
Bram Moolenaar0f873732019-12-05 20:28:46 +01008020 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 SmcInteractDone(smc_conn, cancel_shutdown);
8022
Bram Moolenaar0f873732019-12-05 20:28:46 +01008023 // Finish off
8024 // Only end save-yourself here if we're not cancelling shutdown;
8025 // we'll get a cancelled callback later in which we'll end it.
8026 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 if (!cancel_shutdown)
8028 {
8029 xsmp.save_yourself = False;
8030 SmcSaveYourselfDone(smc_conn, True);
8031 }
8032}
8033# endif
8034
8035/*
8036 * Callback that starts save-yourself.
8037 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008039xsmp_handle_save_yourself(
8040 SmcConn smc_conn,
8041 SmPointer client_data UNUSED,
8042 int save_type UNUSED,
8043 Bool shutdown,
8044 int interact_style UNUSED,
8045 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008047 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 if (xsmp.save_yourself)
8049 SmcSaveYourselfDone(smc_conn, True);
8050 xsmp.save_yourself = True;
8051 xsmp.shutdown = shutdown;
8052
Bram Moolenaar0f873732019-12-05 20:28:46 +01008053 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01008055 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056
8057 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008058 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059
8060# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008061 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008063 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 SmcInteractRequest(smc_conn, SmDialogError,
8065 xsmp_handle_interaction, client_data);
8066 else
8067# endif
8068 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008069 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 SmcSaveYourselfDone(smc_conn, True);
8071 xsmp.save_yourself = False;
8072 }
8073}
8074
8075
8076/*
8077 * Callback to warn us of imminent death.
8078 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008080xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081{
8082 xsmp_close();
8083
Bram Moolenaar0f873732019-12-05 20:28:46 +01008084 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 getout_preserve_modified(0);
8086}
8087
8088
8089/*
8090 * Callback to tell us that save-yourself has completed.
8091 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008093xsmp_save_complete(
8094 SmcConn smc_conn UNUSED,
8095 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008096{
8097 xsmp.save_yourself = False;
8098}
8099
8100
8101/*
8102 * Callback to tell us that an instigated shutdown was cancelled
8103 * (maybe even by us)
8104 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008106xsmp_shutdown_cancelled(
8107 SmcConn smc_conn,
8108 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109{
8110 if (xsmp.save_yourself)
8111 SmcSaveYourselfDone(smc_conn, True);
8112 xsmp.save_yourself = False;
8113 xsmp.shutdown = False;
8114}
8115
8116
8117/*
8118 * Callback to tell us that a new ICE connection has been established.
8119 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008121xsmp_ice_connection(
8122 IceConn iceConn,
8123 IcePointer clientData UNUSED,
8124 Bool opening,
8125 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008127 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 if (opening)
8129 {
8130 xsmp_icefd = IceConnectionNumber(iceConn);
8131 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
8132 }
8133}
8134
8135
Bram Moolenaar0f873732019-12-05 20:28:46 +01008136// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 int
Bram Moolenaar05540972016-01-30 20:31:25 +01008138xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139{
8140 Bool rep;
8141
8142 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8143 == IceProcessMessagesIOError)
8144 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008145 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008147 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 xsmp_close();
8149 return FAIL;
8150 }
8151 else
8152 return OK;
8153}
8154
8155static int dummy;
8156
Bram Moolenaar0f873732019-12-05 20:28:46 +01008157// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 void
8159xsmp_init(void)
8160{
8161 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 SmcCallbacks smcallbacks;
8163#if 0
8164 SmPropValue smname;
8165 SmProp smnameprop;
8166 SmProp *smprops[1];
8167#endif
8168
8169 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008170 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171
8172 xsmp.save_yourself = xsmp.shutdown = False;
8173
Bram Moolenaar0f873732019-12-05 20:28:46 +01008174 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8176 smcallbacks.save_yourself.client_data = NULL;
8177 smcallbacks.die.callback = xsmp_die;
8178 smcallbacks.die.client_data = NULL;
8179 smcallbacks.save_complete.callback = xsmp_save_complete;
8180 smcallbacks.save_complete.client_data = NULL;
8181 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8182 smcallbacks.shutdown_cancelled.client_data = NULL;
8183
Bram Moolenaar0f873732019-12-05 20:28:46 +01008184 // Set up a watch on ICE connection creations. The "dummy" argument is
8185 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8187 {
8188 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008189 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 return;
8191 }
8192
Bram Moolenaar0f873732019-12-05 20:28:46 +01008193 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 xsmp.smcconn = SmcOpenConnection(
8195 NULL,
8196 NULL,
8197 SmProtoMajor,
8198 SmProtoMinor,
8199 SmcSaveYourselfProcMask | SmcDieProcMask
8200 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8201 &smcallbacks,
8202 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008203 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008204 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 errorstring);
8206 if (xsmp.smcconn == NULL)
8207 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008209 {
Bram Moolenaare1be1182020-10-24 13:30:51 +02008210 char errorreport[132];
8211
8212 // If the message is too long it might not be NUL terminated. Add
8213 // a NUL at the end to make sure we don't go over the end.
8214 errorstring[sizeof(errorstring) - 1] = NUL;
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008215 vim_snprintf(errorreport, sizeof(errorreport),
8216 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008217 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008218 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 return;
8220 }
8221 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8222
8223#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008224 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 smname.value = "vim";
8226 smname.length = 3;
8227 smnameprop.name = "SmProgram";
8228 smnameprop.type = "SmARRAY8";
8229 smnameprop.num_vals = 1;
8230 smnameprop.vals = &smname;
8231
8232 smprops[0] = &smnameprop;
8233 SmcSetProperties(xsmp.smcconn, 1, smprops);
8234#endif
8235}
8236
8237
Bram Moolenaar0f873732019-12-05 20:28:46 +01008238// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008240xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241{
8242 if (xsmp_icefd != -1)
8243 {
8244 SmcCloseConnection(xsmp.smcconn, 0, NULL);
Bram Moolenaar5a221812008-11-12 12:08:45 +00008245 if (xsmp.clientid != NULL)
8246 free(xsmp.clientid);
Bram Moolenaare8208012008-06-20 09:59:25 +00008247 xsmp.clientid = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 xsmp_icefd = -1;
8249 }
8250}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008251#endif // USE_XSMP
Paul Ollis65745772022-06-05 16:55:54 +01008252
8253#if defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008254# if defined(HAVE_TIMER_CREATE) || defined(PROTO)
Paul Ollis65745772022-06-05 16:55:54 +01008255/*
8256 * Implement timeout with timer_create() and timer_settime().
8257 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008258static volatile sig_atomic_t timeout_flag = FALSE;
8259static timer_t timer_id;
8260static int timer_created = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008261
8262/*
8263 * Callback for when the timer expires.
8264 */
8265 static void
8266set_flag(union sigval _unused UNUSED)
8267{
8268 timeout_flag = TRUE;
8269}
8270
8271/*
8272 * Stop any active timeout.
8273 */
8274 void
8275stop_timeout(void)
8276{
8277 static struct itimerspec disarm = {{0, 0}, {0, 0}};
8278
8279 if (timer_created)
8280 {
8281 int ret = timer_settime(timer_id, 0, &disarm, NULL);
8282
8283 if (ret < 0)
8284 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8285 }
8286
8287 // Clear the current timeout flag; any previous timeout should be
8288 // considered _not_ triggered.
8289 timeout_flag = FALSE;
8290}
8291
8292/*
8293 * Start the timeout timer.
8294 *
8295 * The return value is a pointer to a flag that is initialised to FALSE. If the
8296 * timeout expires, the flag is set to TRUE. This will only return pointers to
8297 * static memory; i.e. any pointer returned by this function may always be
8298 * safely dereferenced.
8299 *
8300 * This function is not expected to fail, but if it does it will still return a
8301 * valid flag pointer; the flag will remain stuck as FALSE .
8302 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008303 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008304start_timeout(long msec)
8305{
8306 struct itimerspec interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008307 {0, 0}, // Do not repeat.
8308 {msec / 1000, (msec % 1000) * 1000000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008309 int ret;
8310
8311 // This is really the caller's responsibility, but let's make sure the
8312 // previous timer has been stopped.
8313 stop_timeout();
Paul Ollis65745772022-06-05 16:55:54 +01008314
8315 if (!timer_created)
8316 {
8317 struct sigevent action = {0};
8318
8319 action.sigev_notify = SIGEV_THREAD;
8320 action.sigev_notify_function = set_flag;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008321 ret = timer_create(CLOCK_MONOTONIC, &action, &timer_id);
8322 if (ret < 0)
Paul Ollis65745772022-06-05 16:55:54 +01008323 {
8324 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8325 return &timeout_flag;
8326 }
8327 timer_created = TRUE;
8328 }
8329
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00008330# ifdef FEAT_EVAL
Bram Moolenaar616592e2022-06-17 15:17:10 +01008331 ch_log(NULL, "setting timeout timer to %d sec %ld nsec",
8332 (int)interval.it_value.tv_sec, (long)interval.it_value.tv_nsec);
Bram Moolenaar509ce032022-06-20 11:23:01 +01008333# endif
Paul Ollis65745772022-06-05 16:55:54 +01008334 ret = timer_settime(timer_id, 0, &interval, NULL);
8335 if (ret < 0)
8336 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8337
8338 return &timeout_flag;
8339}
8340
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008341/*
8342 * To be used before fork/exec: delete any created timer.
8343 */
8344 void
8345delete_timer(void)
8346{
8347 if (timer_created)
8348 {
8349 timer_delete(timer_id);
8350 timer_created = FALSE;
8351 }
8352}
8353
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008354# else // HAVE_TIMER_CREATE
Paul Ollis65745772022-06-05 16:55:54 +01008355
8356/*
8357 * Implement timeout with setitimer()
8358 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008359static struct sigaction prev_sigaction;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008360static volatile sig_atomic_t timeout_flag = FALSE;
8361static int timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008362static int timer_handler_active = FALSE;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008363static volatile sig_atomic_t alarm_pending = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008364
8365/*
8366 * Handle SIGALRM for a timeout.
8367 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01008368 static void
Paul Ollis65745772022-06-05 16:55:54 +01008369set_flag SIGDEFARG(sigarg)
8370{
8371 if (alarm_pending)
8372 alarm_pending = FALSE;
8373 else
8374 timeout_flag = TRUE;
8375}
8376
8377/*
8378 * Stop any active timeout.
8379 */
8380 void
8381stop_timeout(void)
8382{
8383 static struct itimerval disarm = {{0, 0}, {0, 0}};
8384 int ret;
8385
8386 if (timer_active)
8387 {
8388 timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008389 ret = setitimer(ITIMER_REAL, &disarm, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008390 if (ret < 0)
8391 // Should only get here as a result of coding errors.
8392 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8393 }
8394
8395 if (timer_handler_active)
8396 {
8397 timer_handler_active = FALSE;
8398 ret = sigaction(SIGALRM, &prev_sigaction, NULL);
8399 if (ret < 0)
8400 // Should only get here as a result of coding errors.
8401 semsg(_(e_could_not_reset_handler_for_timeout_str),
8402 strerror(errno));
8403 }
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008404 timeout_flag = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008405}
8406
8407/*
8408 * Start the timeout timer.
8409 *
8410 * The return value is a pointer to a flag that is initialised to FALSE. If the
8411 * timeout expires, the flag is set to TRUE. This will only return pointers to
8412 * static memory; i.e. any pointer returned by this function may always be
8413 * safely dereferenced.
8414 *
8415 * This function is not expected to fail, but if it does it will still return a
8416 * valid flag pointer; the flag will remain stuck as FALSE .
8417 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008418 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008419start_timeout(long msec)
8420{
8421 struct itimerval interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008422 {0, 0}, // Do not repeat.
8423 {msec / 1000, (msec % 1000) * 1000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008424 struct sigaction handle_alarm;
8425 int ret;
8426 sigset_t sigs;
8427 sigset_t saved_sigs;
8428
8429 // This is really the caller's responsibility, but let's make sure the
8430 // previous timer has been stopped.
8431 stop_timeout();
8432
8433 // There is a small chance that SIGALRM is pending and so the handler must
8434 // ignore it on the first call.
8435 alarm_pending = FALSE;
8436 ret = sigemptyset(&sigs);
8437 ret = ret == 0 ? sigaddset(&sigs, SIGALRM) : ret;
8438 ret = ret == 0 ? sigprocmask(SIG_BLOCK, &sigs, &saved_sigs) : ret;
8439 timeout_flag = FALSE;
8440 ret = ret == 0 ? sigpending(&sigs) : ret;
8441 if (ret == 0)
8442 {
8443 alarm_pending = sigismember(&sigs, SIGALRM);
Bram Moolenaar1f89abf2022-06-06 10:07:01 +01008444 ret = sigprocmask(SIG_SETMASK, &saved_sigs, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008445 }
8446 if (unlikely(ret != 0 || alarm_pending < 0))
8447 {
8448 // Just catching coding errors. Write an error message, but carry on.
8449 semsg(_(e_could_not_check_for_pending_sigalrm_str), strerror(errno));
8450 alarm_pending = FALSE;
8451 }
8452
8453 // Set up the alarm handler first.
8454 ret = sigemptyset(&handle_alarm.sa_mask);
8455 handle_alarm.sa_handler = set_flag;
8456 handle_alarm.sa_flags = 0;
8457 ret = ret == 0 ? sigaction(SIGALRM, &handle_alarm, &prev_sigaction) : ret;
8458 if (ret < 0)
8459 {
8460 // Should only get here as a result of coding errors.
8461 semsg(_(e_could_not_set_handler_for_timeout_str), strerror(errno));
8462 return &timeout_flag;
8463 }
8464 timer_handler_active = TRUE;
8465
8466 // Set up the interval timer once the alarm handler is in place.
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008467 ret = setitimer(ITIMER_REAL, &interval, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008468 if (ret < 0)
8469 {
8470 // Should only get here as a result of coding errors.
8471 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8472 stop_timeout();
8473 return &timeout_flag;
8474 }
8475
8476 timer_active = TRUE;
8477 return &timeout_flag;
8478}
8479# endif // HAVE_TIMER_CREATE
8480#endif // FEAT_RELTIME