blob: 1ac6e190bce1a1c4af20b86b04be56a529ad6994 [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 Moolenaar3a7c85b2005-02-05 21:39:53 +00002355 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 */
2357 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002358vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359{
2360 if (name == NULL)
2361 return FALSE;
2362 return (STRNICMP(name, "xterm", 5) == 0
2363 || STRNICMP(name, "nxterm", 6) == 0
2364 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002365 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002367 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 || STRCMP(name, "builtin_xterm") == 0);
2369}
2370
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002371#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2372/*
2373 * Return TRUE if "name" appears to be that of a terminal
2374 * known to support the xterm-style mouse protocol.
2375 * Relies on term_is_xterm having been set to its correct value.
2376 */
2377 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002378use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002379{
2380 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002381 && (term_is_xterm
2382 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002383 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar48873ae2021-12-08 21:00:24 +00002384 || STRNICMP(name, "gnome", 5) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002385 || STRICMP(name, "st") == 0
2386 || STRNICMP(name, "st-", 3) == 0
2387 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002388}
2389#endif
2390
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391/*
2392 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2393 * Return 1 for "xterm".
2394 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002395 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002396 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 */
2398 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002399use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002401 if (ttym_flags == TTYM_SGR)
2402 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002403 if (ttym_flags == TTYM_URXVT)
2404 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 if (ttym_flags == TTYM_XTERM2)
2406 return 2;
2407 if (ttym_flags == TTYM_XTERM)
2408 return 1;
2409 return 0;
2410}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411
2412 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002413vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414{
2415 if (name == NULL)
2416 return FALSE;
2417 return (STRNICMP(name, "iris-ansi", 9) == 0
2418 || STRCMP(name, "builtin_iris-ansi") == 0);
2419}
2420
2421 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002422vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423{
2424 if (name == NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002425 return FALSE; // actually all ANSI comp. terminals should be here
2426 // catch VT100 - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002427 return ((STRNICMP(name, "vt", 2) == 0
2428 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 || STRCMP(name, "builtin_vt320") == 0);
2430}
2431
2432/*
2433 * Return TRUE if "name" is a terminal for which 'ttyfast' should be set.
2434 * This should include all windowed terminal emulators.
2435 */
2436 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002437vim_is_fastterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438{
2439 if (name == NULL)
2440 return FALSE;
2441 if (vim_is_xterm(name) || vim_is_vt300(name) || vim_is_iris(name))
2442 return TRUE;
2443 return ( STRNICMP(name, "hpterm", 6) == 0
2444 || STRNICMP(name, "sun-cmd", 7) == 0
2445 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002446 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 || STRNICMP(name, "dtterm", 6) == 0);
2448}
2449
2450/*
2451 * Insert user name in s[len].
2452 * Return OK if a name found.
2453 */
2454 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002455mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456{
2457#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002458 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 return OK;
2460#else
2461 return mch_get_uname(getuid(), s, len);
2462#endif
2463}
2464
2465/*
2466 * Insert user name for "uid" in s[len].
2467 * Return OK if a name found.
2468 */
2469 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002470mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471{
2472#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2473 struct passwd *pw;
2474
2475 if ((pw = getpwuid(uid)) != NULL
2476 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2477 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002478 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 return OK;
2480 }
2481#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002482 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2483 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484}
2485
2486/*
2487 * Insert host name is s[len].
2488 */
2489
2490#ifdef HAVE_SYS_UTSNAME_H
2491 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002492mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493{
2494 struct utsname vutsname;
2495
2496 if (uname(&vutsname) < 0)
2497 *s = NUL;
2498 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002499 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002501#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502
2503# ifdef HAVE_SYS_SYSTEMINFO_H
2504# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2505# endif
2506
2507 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002508mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509{
2510# ifdef VAXC
2511 vaxc$gethostname((char *)s, len);
2512# else
2513 gethostname((char *)s, len);
2514# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002515 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002517#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518
2519/*
2520 * return process ID
2521 */
2522 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002523mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524{
2525 return (long)getpid();
2526}
2527
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002528/*
2529 * return TRUE if process "pid" is still running
2530 */
2531 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002532mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002533{
Bram Moolenaar44dea9d2021-06-23 21:13:20 +02002534 // If there is no error the process must be running.
2535 if (kill(pid, 0) == 0)
2536 return TRUE;
2537#ifdef ESRCH
2538 // If the error is ESRCH then the process is not running.
2539 if (errno == ESRCH)
2540 return FALSE;
2541#endif
2542 // If the process is running and owned by another user we get EPERM. With
2543 // other errors the process might be running, assuming it is then.
2544 return TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002545}
2546
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002549strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550{
2551 extern int sys_nerr;
2552 extern char *sys_errlist[];
2553 static char er[20];
2554
2555 if (err > 0 && err < sys_nerr)
2556 return (sys_errlist[err]);
2557 sprintf(er, "Error %d", err);
2558 return er;
2559}
2560#endif
2561
2562/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002563 * Get name of current directory into buffer "buf" of length "len" bytes.
2564 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 * Return OK for success, FAIL for failure.
2566 */
2567 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002568mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569{
2570#if defined(USE_GETCWD)
2571 if (getcwd((char *)buf, len) == NULL)
2572 {
2573 STRCPY(buf, strerror(errno));
2574 return FAIL;
2575 }
2576 return OK;
2577#else
2578 return (getwd((char *)buf) != NULL ? OK : FAIL);
2579#endif
2580}
2581
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002583 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 *
2585 * return FAIL for failure, OK for success
2586 */
2587 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002588mch_FullName(
2589 char_u *fname,
2590 char_u *buf,
2591 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002592 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593{
2594 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002595#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002597 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002598#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 char_u olddir[MAXPATHL];
2600 char_u *p;
2601 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002602#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002603 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2604 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002605#endif
2606
Bram Moolenaar38323e42007-03-06 19:22:53 +00002607#ifdef VMS
2608 fname = vms_fixfilename(fname);
2609#endif
2610
Bram Moolenaara2442432007-04-26 14:26:37 +00002611#ifdef __CYGWIN__
2612 /*
2613 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2614 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002615# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002616 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2617 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002618 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2619 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002620# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002621 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002622# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002623 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002624#endif
2625
Bram Moolenaar0f873732019-12-05 20:28:46 +01002626 // Expand it if forced or not an absolute path.
2627 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002628 if ((force || !mch_isFullName(fname))
2629 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 {
2631 /*
2632 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002633 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 * This will get the correct path name with "../" things.
2635 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002636 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 {
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002638 if (STRCMP(p, "/..") == 0)
2639 // for "/path/dir/.." include the "/.."
2640 p += 3;
2641
Bram Moolenaar38323e42007-03-06 19:22:53 +00002642#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 /*
2644 * Use fchdir() if possible, it's said to be faster and more
2645 * reliable. But on SunOS 4 it might not work. Check this by
2646 * doing a fchdir() right now.
2647 */
2648 if (!dont_fchdir)
2649 {
2650 fd = open(".", O_RDONLY | O_EXTRA, 0);
2651 if (fd >= 0 && fchdir(fd) < 0)
2652 {
2653 close(fd);
2654 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002655 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 }
2657 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002658#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659
Bram Moolenaar0f873732019-12-05 20:28:46 +01002660 // Only change directory when we are sure we can return to where
2661 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002663#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002665#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 (mch_dirname(olddir, MAXPATHL) == FAIL
2667 || mch_chdir((char *)olddir) != 0))
2668 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002669 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 retval = FAIL;
2671 }
2672 else
2673 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002674 // The directory is copied into buf[], to be able to remove
2675 // the file name without changing it (could be a string in
2676 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 if (p - fname >= len)
2678 retval = FAIL;
2679 else
2680 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002681 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 if (mch_chdir((char *)buf))
Bram Moolenaarc6376c72021-10-03 19:29:48 +01002683 {
2684 // Path does not exist (yet). For a full path fail,
2685 // will use the path as-is. For a relative path use
2686 // the current directory and append the file name.
2687 if (mch_isFullName(fname))
2688 retval = FAIL;
2689 else
2690 p = NULL;
2691 }
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002692 else if (*p == '/')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 fname = p + 1;
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002694 else
2695 fname = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 *buf = NUL;
2697 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 }
2699 }
2700 if (mch_dirname(buf, len) == FAIL)
2701 {
2702 retval = FAIL;
2703 *buf = NUL;
2704 }
2705 if (p != NULL)
2706 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002707#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 if (fd >= 0)
2709 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002710 if (p_verbose >= 5)
2711 {
2712 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002713 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002714 verbose_leave();
2715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 l = fchdir(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 }
2718 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002719#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 l = mch_chdir((char *)olddir);
2721 if (l != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002722 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 }
itchyny051a40c2021-10-20 10:00:05 +01002724#ifdef HAVE_FCHDIR
2725 if (fd >= 0)
2726 close(fd);
2727#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728
2729 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002730 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002731 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002732#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002733 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002735 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002736#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002738
Bram Moolenaar0f873732019-12-05 20:28:46 +01002739 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002740 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 return FAIL;
2742
Bram Moolenaar0f873732019-12-05 20:28:46 +01002743 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 if (STRCMP(fname, ".") != 0)
2745 STRCAT(buf, fname);
2746
2747 return OK;
2748}
2749
2750/*
2751 * Return TRUE if "fname" does not depend on the current directory.
2752 */
2753 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002754mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002756#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 return ( fname[0] == '/' || fname[0] == '.' ||
2758 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2759 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2760 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002761#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763#endif
2764}
2765
Bram Moolenaar24552be2005-12-10 20:17:30 +00002766#if defined(USE_FNAME_CASE) || defined(PROTO)
2767/*
2768 * Set the case of the file name, if it already exists. This will cause the
2769 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002770 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002771 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002772 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002773fname_case(
2774 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002775 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002776{
2777 struct stat st;
2778 char_u *slash, *tail;
2779 DIR *dirp;
2780 struct dirent *dp;
2781
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002782 if (mch_lstat((char *)name, &st) >= 0)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002783 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002784 // Open the directory where the file is located.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002785 slash = vim_strrchr(name, '/');
2786 if (slash == NULL)
2787 {
2788 dirp = opendir(".");
2789 tail = name;
2790 }
2791 else
2792 {
2793 *slash = NUL;
2794 dirp = opendir((char *)name);
2795 *slash = '/';
2796 tail = slash + 1;
2797 }
2798
2799 if (dirp != NULL)
2800 {
2801 while ((dp = readdir(dirp)) != NULL)
2802 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002803 // Only accept names that differ in case and are the same byte
2804 // length. TODO: accept different length name.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002805 if (STRICMP(tail, dp->d_name) == 0
2806 && STRLEN(tail) == STRLEN(dp->d_name))
2807 {
2808 char_u newname[MAXPATHL + 1];
2809 struct stat st2;
2810
Bram Moolenaar0f873732019-12-05 20:28:46 +01002811 // Verify the inode is equal.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002812 vim_strncpy(newname, name, MAXPATHL);
2813 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2814 MAXPATHL - (tail - name));
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002815 if (mch_lstat((char *)newname, &st2) >= 0
Bram Moolenaar24552be2005-12-10 20:17:30 +00002816 && st.st_ino == st2.st_ino
2817 && st.st_dev == st2.st_dev)
2818 {
2819 STRCPY(tail, dp->d_name);
2820 break;
2821 }
2822 }
2823 }
2824
2825 closedir(dirp);
2826 }
2827 }
2828}
2829#endif
2830
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831/*
2832 * Get file permissions for 'name'.
2833 * Returns -1 when it doesn't exist.
2834 */
2835 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002836mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837{
2838 struct stat statb;
2839
Bram Moolenaar0f873732019-12-05 20:28:46 +01002840 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841#ifdef VMS
2842 if (stat((char *)vms_fixfilename(name), &statb))
2843#else
2844 if (stat((char *)name, &statb))
2845#endif
2846 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002847#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002848 // The top bit makes the value negative, which means the file doesn't
2849 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002850 return statb.st_mode & ~S_ADDACE;
2851#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002853#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854}
2855
2856/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002857 * Set file permission for "name" to "perm".
2858 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 */
2860 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002861mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862{
2863 return (chmod((char *)
2864#ifdef VMS
2865 vms_fixfilename(name),
2866#else
2867 name,
2868#endif
2869 (mode_t)perm) == 0 ? OK : FAIL);
2870}
2871
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002872#if defined(HAVE_FCHMOD) || defined(PROTO)
2873/*
2874 * Set file permission for open file "fd" to "perm".
2875 * Return FAIL for failure, OK otherwise.
2876 */
2877 int
2878mch_fsetperm(int fd, long perm)
2879{
2880 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2881}
2882#endif
2883
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884#if defined(HAVE_ACL) || defined(PROTO)
2885# ifdef HAVE_SYS_ACL_H
2886# include <sys/acl.h>
2887# endif
2888# ifdef HAVE_SYS_ACCESS_H
2889# include <sys/access.h>
2890# endif
2891
2892# ifdef HAVE_SOLARIS_ACL
2893typedef struct vim_acl_solaris_T {
2894 int acl_cnt;
2895 aclent_t *acl_entry;
2896} vim_acl_solaris_T;
2897# endif
2898
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002899#if defined(HAVE_SELINUX) || defined(PROTO)
2900/*
2901 * Copy security info from "from_file" to "to_file".
2902 */
2903 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002904mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002905{
2906 if (from_file == NULL)
2907 return;
2908
2909 if (selinux_enabled == -1)
2910 selinux_enabled = is_selinux_enabled();
2911
2912 if (selinux_enabled > 0)
2913 {
Bram Moolenaar89560232020-10-09 23:04:47 +02002914 // Use "char *" instead of "security_context_t" to avoid a deprecation
2915 // warning.
2916 char *from_context = NULL;
2917 char *to_context = NULL;
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002918
2919 if (getfilecon((char *)from_file, &from_context) < 0)
2920 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002921 // If the filesystem doesn't support extended attributes,
2922 // the original had no special security context and the
2923 // target cannot have one either.
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002924 if (errno == EOPNOTSUPP)
2925 return;
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(from_file);
2929 msg_putchar('\n');
2930 return;
2931 }
2932 if (getfilecon((char *)to_file, &to_context) < 0)
2933 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002934 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002935 msg_outtrans(to_file);
2936 msg_putchar('\n');
2937 freecon (from_context);
2938 return ;
2939 }
2940 if (strcmp(from_context, to_context) != 0)
2941 {
2942 if (setfilecon((char *)to_file, from_context) < 0)
2943 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002944 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002945 msg_outtrans(to_file);
2946 msg_putchar('\n');
2947 }
2948 }
2949 freecon(to_context);
2950 freecon(from_context);
2951 }
2952}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002953#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002954
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002955#if defined(HAVE_SMACK) && !defined(PROTO)
2956/*
2957 * Copy security info from "from_file" to "to_file".
2958 */
2959 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002960mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002961{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002962 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002963 {
2964 XATTR_NAME_SMACK,
2965 XATTR_NAME_SMACKEXEC,
2966 XATTR_NAME_SMACKMMAP
2967 };
2968
2969 char buffer[SMACK_LABEL_LEN];
2970 const char *name;
2971 int index;
2972 int ret;
2973 ssize_t size;
2974
2975 if (from_file == NULL)
2976 return;
2977
2978 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2979 / sizeof(smack_copied_attributes)[0]) ; index++)
2980 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002981 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002982 name = smack_copied_attributes[index];
2983
Bram Moolenaar0f873732019-12-05 20:28:46 +01002984 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002985 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2986 if (size >= 0)
2987 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002988 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002989 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2990 if (ret < 0)
2991 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002992 vim_snprintf((char *)IObuff, IOSIZE,
2993 _("Could not set security context %s for %s"),
2994 name, to_file);
2995 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002996 msg_putchar('\n');
2997 }
2998 }
2999 else
3000 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003001 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003002 switch (errno)
3003 {
3004 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003005 // extended attributes aren't supported or enabled
3006 // should a message be echoed? not sure...
3007 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003008
3009 case ERANGE:
3010 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003011 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003012 vim_snprintf((char *)IObuff, IOSIZE,
3013 _("Could not get security context %s for %s. Removing it!"),
3014 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003015 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003016 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01003017 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003018
3019 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003020 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003021 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003022 // Silently ignore errors, apparently this happens when
3023 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003024 break;
3025 }
3026 }
3027 }
3028}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003029#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003030
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031/*
3032 * Return a pointer to the ACL of file "fname" in allocated memory.
3033 * Return NULL if the ACL is not available for whatever reason.
3034 */
3035 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01003036mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037{
3038 vim_acl_T ret = NULL;
3039#ifdef HAVE_POSIX_ACL
3040 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
3041#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003042#ifdef HAVE_SOLARIS_ZFS_ACL
3043 acl_t *aclent;
3044
3045 if (acl_get((char *)fname, 0, &aclent) < 0)
3046 return NULL;
3047 ret = (vim_acl_T)aclent;
3048#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049#ifdef HAVE_SOLARIS_ACL
3050 vim_acl_solaris_T *aclent;
3051
3052 aclent = malloc(sizeof(vim_acl_solaris_T));
3053 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
3054 {
3055 free(aclent);
3056 return NULL;
3057 }
3058 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
3059 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
3060 {
3061 free(aclent->acl_entry);
3062 free(aclent);
3063 return NULL;
3064 }
3065 ret = (vim_acl_T)aclent;
3066#else
3067#if defined(HAVE_AIX_ACL)
3068 int aclsize;
3069 struct acl *aclent;
3070
3071 aclsize = sizeof(struct acl);
3072 aclent = malloc(aclsize);
3073 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3074 {
3075 if (errno == ENOSPC)
3076 {
3077 aclsize = aclent->acl_len;
3078 aclent = realloc(aclent, aclsize);
3079 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3080 {
3081 free(aclent);
3082 return NULL;
3083 }
3084 }
3085 else
3086 {
3087 free(aclent);
3088 return NULL;
3089 }
3090 }
3091 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003092#endif // HAVE_AIX_ACL
3093#endif // HAVE_SOLARIS_ACL
3094#endif // HAVE_SOLARIS_ZFS_ACL
3095#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 return ret;
3097}
3098
3099/*
3100 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3101 */
3102 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003103mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104{
3105 if (aclent == NULL)
3106 return;
3107#ifdef HAVE_POSIX_ACL
3108 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3109#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003110#ifdef HAVE_SOLARIS_ZFS_ACL
3111 acl_set((char *)fname, (acl_t *)aclent);
3112#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113#ifdef HAVE_SOLARIS_ACL
3114 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3115 ((vim_acl_solaris_T *)aclent)->acl_entry);
3116#else
3117#ifdef HAVE_AIX_ACL
3118 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003119#endif // HAVE_AIX_ACL
3120#endif // HAVE_SOLARIS_ACL
3121#endif // HAVE_SOLARIS_ZFS_ACL
3122#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123}
3124
3125 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003126mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127{
3128 if (aclent == NULL)
3129 return;
3130#ifdef HAVE_POSIX_ACL
3131 acl_free((acl_t)aclent);
3132#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003133#ifdef HAVE_SOLARIS_ZFS_ACL
3134 acl_free((acl_t *)aclent);
3135#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136#ifdef HAVE_SOLARIS_ACL
3137 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3138 free(aclent);
3139#else
3140#ifdef HAVE_AIX_ACL
3141 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003142#endif // HAVE_AIX_ACL
3143#endif // HAVE_SOLARIS_ACL
3144#endif // HAVE_SOLARIS_ZFS_ACL
3145#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146}
3147#endif
3148
3149/*
3150 * Set hidden flag for "name".
3151 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003153mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003155 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156}
3157
3158/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003159 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 * return FALSE if "name" is not a directory
3161 * return FALSE for error
3162 */
3163 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003164mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165{
3166 struct stat statb;
3167
Bram Moolenaar0f873732019-12-05 20:28:46 +01003168 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 return FALSE;
3170 if (stat((char *)name, &statb))
3171 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173}
3174
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003175/*
3176 * return TRUE if "name" is a directory, NOT a symlink to a directory
3177 * return FALSE if "name" is not a directory
3178 * return FALSE for error
3179 */
3180 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003181mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003182{
3183 struct stat statb;
3184
Bram Moolenaar0f873732019-12-05 20:28:46 +01003185 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003186 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003187 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003188 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003189 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003190}
3191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192/*
3193 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3194 */
3195 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003196executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197{
3198 struct stat st;
3199
3200 if (stat((char *)name, &st))
3201 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003202#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003203 // Like on Unix system file can have executable rights but not necessarily
3204 // be an executable, but on Unix is not a default for an ordinary file to
3205 // have an executable flag - on VMS it is in most cases.
3206 // Therefore, this check does not have any sense - let keep us to the
3207 // conventions instead:
3208 // *.COM and *.EXE files are the executables - the rest are not. This is
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00003209 // not ideal but better than it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003210 int vms_executable = 0;
3211 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3212 {
3213 if (strstr(vms_tolower((char*)name),".exe") != NULL
3214 || strstr(vms_tolower((char*)name),".com")!= NULL)
3215 vms_executable = 1;
3216 }
3217 return vms_executable;
3218#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003220#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221}
3222
3223/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003224 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003225 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 * Return -1 if unknown.
3227 */
3228 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003229mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230{
3231 char_u *buf;
3232 char_u *p, *e;
3233 int retval;
3234
Bram Moolenaar0f873732019-12-05 20:28:46 +01003235 // When "use_path" is false and if it's an absolute or relative path don't
3236 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003237 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003238 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003239 // There must be a path separator, files in the current directory
3240 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003241 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003242 {
3243 if (path != NULL)
3244 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003245 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003246 *path = FullName_save(name, TRUE);
3247 else
3248 *path = vim_strsave(name);
3249 }
3250 return TRUE;
3251 }
3252 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003253 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254
3255 p = (char_u *)getenv("PATH");
3256 if (p == NULL || *p == NUL)
3257 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003258 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 if (buf == NULL)
3260 return -1;
3261
3262 /*
3263 * Walk through all entries in $PATH to check if "name" exists there and
3264 * is an executable file.
3265 */
3266 for (;;)
3267 {
3268 e = (char_u *)strchr((char *)p, ':');
3269 if (e == NULL)
3270 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003271 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 STRCPY(buf, "./");
3273 else
3274 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003275 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 add_pathsep(buf);
3277 }
3278 STRCAT(buf, name);
3279 retval = executable_file(buf);
3280 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003281 {
3282 if (path != NULL)
3283 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003284 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003285 *path = FullName_save(buf, TRUE);
3286 else
3287 *path = vim_strsave(buf);
3288 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003290 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291
3292 if (*e != ':')
3293 break;
3294 p = e + 1;
3295 }
3296
3297 vim_free(buf);
3298 return retval;
3299}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300
3301/*
3302 * Check what "name" is:
3303 * NODE_NORMAL: file or directory (or doesn't exist)
3304 * NODE_WRITABLE: writable device, socket, fifo, etc.
3305 * NODE_OTHER: non-writable things
3306 */
3307 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003308mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309{
3310 struct stat st;
3311
3312 if (stat((char *)name, &st))
3313 return NODE_NORMAL;
3314 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3315 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003316 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003318 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 return NODE_WRITABLE;
3320}
3321
3322 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003323mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324{
3325#ifdef HAVE_CHECK_STACK_GROWTH
3326 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 check_stack_growth((char *)&i);
3329
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003330# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 get_stack_limit();
3332# endif
3333
3334#endif
3335
3336 /*
3337 * Setup an alternative stack for signals. Helps to catch signals when
3338 * running out of stack space.
3339 * Use of sigaltstack() is preferred, it's more portable.
3340 * Ignore any errors.
3341 */
3342#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +02003343 signal_stack = alloc(get_signal_stack_size());
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 init_signal_stack();
3345#endif
3346}
3347
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003348#if defined(EXITFREE) || defined(PROTO)
3349 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003350mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003351{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003352# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3353 if (clip_star.owned)
3354 clip_lose_selection(&clip_star);
3355 if (clip_plus.owned)
3356 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003357# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003358# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003359 if (xterm_Shell != (Widget)0)
3360 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003361# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003362 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003363 if (xterm_dpy != NULL)
3364 XtCloseDisplay(xterm_dpy);
3365 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003366 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003367 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003368# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003369 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003370# endif
3371 }
3372# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003373# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003374# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003375 if (x11_display != NULL
3376# ifdef FEAT_XCLIPBOARD
3377 && x11_display != xterm_dpy
3378# endif
3379 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003380 XCloseDisplay(x11_display);
3381# endif
3382# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003383 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003384# endif
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003385 vim_free(oldtitle);
3386 vim_free(oldicon);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003387}
3388#endif
3389
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390/*
3391 * Output a newline when exiting.
3392 * Make sure the newline goes to the same stream as the text.
3393 */
3394 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003395exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003397 if (silent_mode)
3398 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 if (newline_on_exit || msg_didout)
3400 {
3401 if (msg_use_printf())
3402 {
3403 if (info_message)
3404 mch_msg("\n");
3405 else
3406 mch_errmsg("\r\n");
3407 }
3408 else
3409 out_char('\n');
3410 }
Bram Moolenaar7007e312021-03-27 12:11:33 +01003411 else if (!is_not_a_term())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003413 restore_cterm_colors(); // get original colors back
3414 msg_clr_eos_force(); // clear the rest of the display
3415 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 }
3417}
3418
Bram Moolenaarb4151682020-05-11 22:13:28 +02003419#ifdef USE_GCOV_FLUSH
ichizokdee78e12021-12-09 21:08:01 +00003420# if (defined(__GNUC__) \
3421 && ((__GNUC__ == 11 && __GNUC_MINOR__ >= 1) || (__GNUC__ >= 12))) \
3422 || (defined(__clang__) && (__clang_major__ >= 12))
3423extern void __gcov_dump(void);
3424extern void __gcov_reset(void);
3425# define __gcov_flush() do { __gcov_dump(); __gcov_reset(); } while (0)
3426# else
3427extern void __gcov_flush(void);
3428# endif
Bram Moolenaarb4151682020-05-11 22:13:28 +02003429#endif
3430
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003432mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433{
3434 exiting = TRUE;
3435
3436#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3437 x11_export_final_selection();
3438#endif
3439
3440#ifdef FEAT_GUI
3441 if (!gui.in_use)
3442#endif
3443 {
3444 settmode(TMODE_COOK);
Bram Moolenaar7007e312021-03-27 12:11:33 +01003445 if (!is_not_a_term())
3446 {
3447 // restore xterm title and icon name
3448 mch_restore_title(SAVE_RESTORE_BOTH);
3449 term_pop_title(SAVE_RESTORE_BOTH);
3450 }
Bram Moolenaar651fca82021-11-29 20:39:38 +00003451
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 /*
3453 * When t_ti is not empty but it doesn't cause swapping terminal
3454 * pages, need to output a newline when msg_didout is set. But when
3455 * t_ti does swap pages it should not go to the shell page. Do this
3456 * before stoptermcap().
3457 */
3458 if (swapping_screen() && !newline_on_exit)
3459 exit_scroll();
3460
Bram Moolenaar0f873732019-12-05 20:28:46 +01003461 // Stop termcap: May need to check for T_CRV response, which
3462 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 stoptermcap();
3464
3465 /*
3466 * A newline is only required after a message in the alternate screen.
3467 * This is set to TRUE by wait_return().
3468 */
3469 if (!swapping_screen() || newline_on_exit)
3470 exit_scroll();
3471
Bram Moolenaar0f873732019-12-05 20:28:46 +01003472 // Cursor may have been switched off without calling starttermcap()
3473 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 if (full_screen)
3475 cursor_on();
3476 }
3477 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003478 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003479
3480#ifdef USE_GCOV_FLUSH
3481 // Flush coverage info before possibly being killed by a deadly signal.
3482 __gcov_flush();
3483#endif
3484
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 may_core_dump();
3486#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 gui_exit(r);
3489#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003490
Bram Moolenaar56718732006-03-15 22:53:57 +00003491#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003492 mac_conv_cleanup();
3493#endif
3494
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003496 // A core dump won't be created if the signal handler
3497 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 if (deadly_signal != 0)
3499 return;
3500#endif
3501
Bram Moolenaar009b2592004-10-24 19:18:58 +00003502#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003503 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003504#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003505
3506#ifdef EXITFREE
3507 free_all_mem();
3508#endif
3509
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 exit(r);
3511}
3512
3513 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003514may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515{
3516 if (deadly_signal != 0)
3517 {
3518 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003519 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 }
3521}
3522
3523#ifndef VMS
3524
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003525/*
3526 * Get the file descriptor to use for tty operations.
3527 */
3528 static int
3529get_tty_fd(int fd)
3530{
3531 int tty_fd = fd;
3532
3533#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3534 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3535 // "fd" when it is a master device.
3536 if (mch_isatty(fd) > 1)
3537 {
3538 char *name;
3539
3540 name = ptsname(fd);
3541 if (name == NULL)
3542 return -1;
3543
3544 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3545 if (tty_fd < 0)
3546 return -1;
3547 }
3548#endif
3549 return tty_fd;
3550}
3551
3552 static int
3553mch_tcgetattr(int fd, void *term)
3554{
3555 int tty_fd;
3556 int retval = -1;
3557
3558 tty_fd = get_tty_fd(fd);
3559 if (tty_fd >= 0)
3560 {
3561#ifdef NEW_TTY_SYSTEM
3562# ifdef HAVE_TERMIOS_H
3563 retval = tcgetattr(tty_fd, (struct termios *)term);
3564# else
3565 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
3566# endif
3567#else
3568 // for "old" tty systems
3569 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
3570#endif
3571 if (tty_fd != fd)
3572 close(tty_fd);
3573 }
3574 return retval;
3575}
3576
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003578mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579{
3580 static int first = TRUE;
3581
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003582#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583# ifdef HAVE_TERMIOS_H
3584 static struct termios told;
3585 struct termios tnew;
3586# else
3587 static struct termio told;
3588 struct termio tnew;
3589# endif
3590
3591 if (first)
3592 {
3593 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003594 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 }
3596
3597 tnew = told;
3598 if (tmode == TMODE_RAW)
3599 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003600 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003601 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3602 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003604# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003605 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606# endif
3607 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003608# ifdef ONLCR
3609 // Don't map NL -> CR NL, we do it ourselves.
3610 // Also disable expanding tabs if possible.
3611# ifdef XTABS
3612 tnew.c_oflag &= ~(ONLCR | XTABS);
3613# else
3614# ifdef TAB3
3615 tnew.c_oflag &= ~(ONLCR | TAB3);
3616# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003618# endif
3619# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003621 tnew.c_cc[VMIN] = 1; // return after 1 char
3622 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 }
3624 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003625 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003626 // Also reset ICANON here, otherwise on Solaris select() won't see
3627 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003628 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003629 tnew.c_cc[VMIN] = 1; // return after 1 char
3630 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003631 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632
3633# if defined(HAVE_TERMIOS_H)
3634 {
3635 int n = 10;
3636
Bram Moolenaar0f873732019-12-05 20:28:46 +01003637 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3638 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3640 && errno == EINTR && n > 0)
3641 --n;
3642 }
3643# else
3644 ioctl(read_cmd_fd, TCSETA, &tnew);
3645# endif
3646
3647#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 /*
3649 * for "old" tty systems
3650 */
3651# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003652# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653# endif
3654 static struct sgttyb ttybold;
3655 struct sgttyb ttybnew;
3656
3657 if (first)
3658 {
3659 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003660 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 }
3662
3663 ttybnew = ttybold;
3664 if (tmode == TMODE_RAW)
3665 {
3666 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3667 ttybnew.sg_flags |= RAW;
3668 }
3669 else if (tmode == TMODE_SLEEP)
3670 ttybnew.sg_flags &= ~(ECHO);
3671 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3672#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003673 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674}
3675
3676/*
3677 * Try to get the code for "t_kb" from the stty setting
3678 *
3679 * Even if termcap claims a backspace key, the user's setting *should*
3680 * prevail. stty knows more about reality than termcap does, and if
3681 * somebody's usual erase key is DEL (which, for most BSD users, it will
3682 * be), they're going to get really annoyed if their erase key starts
3683 * doing forward deletes for no reason. (Eric Fischer)
3684 */
3685 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003686get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003688 ttyinfo_T info;
3689 char_u buf[2];
3690 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003692 if (get_tty_info(read_cmd_fd, &info) == OK)
3693 {
3694 intr_char = info.interrupt;
3695 buf[0] = info.backspace;
3696 buf[1] = NUL;
3697 add_termcode((char_u *)"kb", buf, FALSE);
3698
Bram Moolenaar0f873732019-12-05 20:28:46 +01003699 // If <BS> and <DEL> are now the same, redefine <DEL>.
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003700 p = find_termcode((char_u *)"kD");
3701 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3702 do_fixdel(NULL);
3703 }
3704}
3705
3706/*
3707 * Obtain the characters that Backspace and Enter produce on "fd".
3708 * Returns OK or FAIL.
3709 */
3710 int
3711get_tty_info(int fd, ttyinfo_T *info)
3712{
3713#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714# ifdef HAVE_TERMIOS_H
3715 struct termios keys;
3716# else
3717 struct termio keys;
3718# endif
3719
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003720 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003722 info->backspace = keys.c_cc[VERASE];
3723 info->interrupt = keys.c_cc[VINTR];
3724 if (keys.c_iflag & ICRNL)
3725 info->enter = NL;
3726 else
3727 info->enter = CAR;
3728 if (keys.c_oflag & ONLCR)
3729 info->nl_does_cr = TRUE;
3730 else
3731 info->nl_does_cr = FALSE;
3732 return OK;
3733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003735 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 struct sgttyb keys;
3737
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003738 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003740 info->backspace = keys.sg_erase;
3741 info->interrupt = keys.sg_kill;
3742 info->enter = CAR;
3743 info->nl_does_cr = TRUE;
3744 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003747 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748}
3749
Bram Moolenaar0f873732019-12-05 20:28:46 +01003750#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003752static int mouse_ison = FALSE;
3753
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754/*
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003755 * Set mouse clicks on or off and possible enable mouse movement events.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 */
3757 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003758mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003760#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003761 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003762#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 int xterm_mouse_vers;
3764
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003765#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003766 if (!on)
3767 // Make sure not tracing mouse movements. Important when a button-down
3768 // was received but no release yet.
3769 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003770#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003771
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003772 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003773#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003774 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003775#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003776 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003777 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 return;
3779
3780 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003781
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003782#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003783 if (ttym_flags == TTYM_URXVT)
3784 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003785 out_str_nf((char_u *)(on ? "\033[?1015h" : "\033[?1015l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003786 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003787 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003788#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003789
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003790 if (ttym_flags == TTYM_SGR)
3791 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003792 // SGR mode supports columns above 223
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003793 out_str_nf((char_u *)(on ? "\033[?1006h" : "\033[?1006l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003794 mouse_ison = on;
3795 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003796
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003797#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003798 if (bevalterm_ison != (p_bevalterm && on))
3799 {
3800 bevalterm_ison = (p_bevalterm && on);
3801 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003802 // disable mouse movement events, enabling is below
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003803 out_str_nf((char_u *)("\033[?1003l"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003804 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003805#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003806
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 if (xterm_mouse_vers > 0)
3808 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003809 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 out_str_nf((char_u *)
3811 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003812 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003813#ifdef FEAT_BEVAL_TERM
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003814 bevalterm_ison ? "\033[?1003h" :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003815#endif
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003816 "\033[?1002h")
3817 : "\033[?1000h"));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003818 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 out_str_nf((char_u *)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003820 (xterm_mouse_vers > 1 ? "\033[?1002l" : "\033[?1000l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003821 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 }
3823
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003824#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 else if (ttym_flags == TTYM_DEC)
3826 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003827 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003829 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003831 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003833#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003835#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 else
3837 {
3838 if (on)
3839 {
3840 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003841 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 }
3843 else
3844 {
3845 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003846 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 }
3848 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003849#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003851#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003852 else
3853 {
3854 if (on)
3855 {
3856 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003857 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003858 }
3859 else
3860 {
3861 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003862 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003863 }
3864 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003865#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003866
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003867#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 else
3869 {
3870 if (on)
3871 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003872 // D - Enable Mouse up/down messages
3873 // L - Enable Left Button Reporting
3874 // M - Enable Middle Button Reporting
3875 // R - Enable Right Button Reporting
3876 // K - Enable SHIFT and CTRL key Reporting
3877 // + - Enable Advanced messaging of mouse moves and up/down messages
3878 // Q - Quiet No Ack
3879 // # - Numeric value of mouse pointer required
3880 // 0 = Multiview 2000 cursor, used as standard
3881 // 1 = Windows Arrow
3882 // 2 = Windows I Beam
3883 // 3 = Windows Hour Glass
3884 // 4 = Windows Cross Hair
3885 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003886# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003887 // Disables full feedback of pointer movements
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003888 out_str_nf((char_u *)"\033[0~ZwLMRK1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003889# else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003890 out_str_nf((char_u *)"\033[0~ZwLMRK+1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003891# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003892 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 }
3894 else
3895 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003896 out_str_nf((char_u *)"\033[0~ZwQ\033\\");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003897 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 }
3899 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003900#endif
3901#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 else
3903 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003904 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 if (on)
3906 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3907 else
3908 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003909 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003911#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912}
3913
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003914#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003915/*
3916 * Called when 'balloonevalterm' changed.
3917 */
3918 void
3919mch_bevalterm_changed(void)
3920{
3921 mch_setmouse(mouse_ison);
3922}
3923#endif
3924
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925/*
3926 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3927 */
3928 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003929check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930{
3931# ifdef FEAT_MOUSE_XTERM
3932 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003933# ifdef FEAT_MOUSE_URXVT
3934 && use_xterm_mouse() != 3
3935# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936# ifdef FEAT_GUI
3937 && !gui.in_use
3938# endif
3939 )
3940 {
3941 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003942 ? "\233M" : "\033[M"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 if (*p_mouse != NUL)
3944 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003945 // force mouse off and maybe on to send possibly new mouse
3946 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 mch_setmouse(FALSE);
3948 setmouse();
3949 }
3950 }
3951 else
3952 del_mouse_termcode(KS_MOUSE);
3953# endif
3954
3955# ifdef FEAT_MOUSE_GPM
3956 if (!use_xterm_mouse()
3957# ifdef FEAT_GUI
3958 && !gui.in_use
3959# endif
3960 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003961 set_mouse_termcode(KS_GPM_MOUSE, (char_u *)"\033MG");
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003962 else
3963 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964# endif
3965
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003966# ifdef FEAT_SYSMOUSE
3967 if (!use_xterm_mouse()
3968# ifdef FEAT_GUI
3969 && !gui.in_use
3970# endif
3971 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003972 set_mouse_termcode(KS_MOUSE, (char_u *)"\033MS");
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003973# endif
3974
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003976 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 if (!use_xterm_mouse()
3978# ifdef FEAT_GUI
3979 && !gui.in_use
3980# endif
3981 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003982 set_mouse_termcode(KS_JSBTERM_MOUSE, (char_u *)"\033[0~zw");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 else
3984 del_mouse_termcode(KS_JSBTERM_MOUSE);
3985# endif
3986
3987# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003988 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3989 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 if (!use_xterm_mouse()
3991# ifdef FEAT_GUI
3992 && !gui.in_use
3993# endif
3994 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003995 set_mouse_termcode(KS_NETTERM_MOUSE, (char_u *)"\033}");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 else
3997 del_mouse_termcode(KS_NETTERM_MOUSE);
3998# endif
3999
4000# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01004001 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004002 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003# ifdef FEAT_GUI
4004 && !gui.in_use
4005# endif
4006 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004007 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004008 ? "\233" : "\033["));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 else
4010 del_mouse_termcode(KS_DEC_MOUSE);
4011# endif
4012# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01004013 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004014 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015# ifdef FEAT_GUI
4016 && !gui.in_use
4017# endif
4018 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004019 set_mouse_termcode(KS_PTERM_MOUSE, (char_u *)"\033[");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 else
4021 del_mouse_termcode(KS_PTERM_MOUSE);
4022# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02004023# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004024 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02004025# ifdef FEAT_GUI
4026 && !gui.in_use
4027# endif
4028 )
4029 {
4030 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004031 ? "\233*M" : "\033[*M"));
Bram Moolenaarc8427482011-10-20 21:09:35 +02004032
4033 if (*p_mouse != NUL)
4034 {
4035 mch_setmouse(FALSE);
4036 setmouse();
4037 }
4038 }
4039 else
4040 del_mouse_termcode(KS_URXVT_MOUSE);
4041# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004042 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004043# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004044 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004045# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004046 )
4047 {
4048 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004049 ? "\233<*M" : "\033[<*M"));
Bram Moolenaara529ce02017-06-22 22:37:57 +02004050
4051 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004052 ? "\233<*m" : "\033[<*m"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004053
4054 if (*p_mouse != NUL)
4055 {
4056 mch_setmouse(FALSE);
4057 setmouse();
4058 }
4059 }
4060 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02004061 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004062 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02004063 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
4064 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067#ifndef VMS
4068
4069/*
4070 * Try to get the current window size:
4071 * 1. with an ioctl(), most accurate method
4072 * 2. from the environment variables LINES and COLUMNS
4073 * 3. from the termcap
4074 * 4. keep using the old values
4075 * Return OK when size could be determined, FAIL otherwise.
4076 */
4077 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004078mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079{
4080 long rows = 0;
4081 long columns = 0;
4082 char_u *p;
4083
4084 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 * 1. try using an ioctl. It is the most accurate method.
4086 *
4087 * Try using TIOCGWINSZ first, some systems that have it also define
4088 * TIOCGSIZE but don't have a struct ttysize.
4089 */
4090# ifdef TIOCGWINSZ
4091 {
4092 struct winsize ws;
4093 int fd = 1;
4094
Bram Moolenaar0f873732019-12-05 20:28:46 +01004095 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 if (!isatty(fd) && isatty(read_cmd_fd))
4097 fd = read_cmd_fd;
4098 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4099 {
4100 columns = ws.ws_col;
4101 rows = ws.ws_row;
4102 }
4103 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004104# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105# ifdef TIOCGSIZE
4106 {
4107 struct ttysize ts;
4108 int fd = 1;
4109
Bram Moolenaar0f873732019-12-05 20:28:46 +01004110 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 if (!isatty(fd) && isatty(read_cmd_fd))
4112 fd = read_cmd_fd;
4113 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4114 {
4115 columns = ts.ts_cols;
4116 rows = ts.ts_lines;
4117 }
4118 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004119# endif // TIOCGSIZE
4120# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121
4122 /*
4123 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004124 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4125 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004127 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 {
4129 if ((p = (char_u *)getenv("LINES")))
4130 rows = atoi((char *)p);
4131 if ((p = (char_u *)getenv("COLUMNS")))
4132 columns = atoi((char *)p);
4133 }
4134
4135#ifdef HAVE_TGETENT
4136 /*
4137 * 3. try reading "co" and "li" entries from termcap
4138 */
4139 if (columns == 0 || rows == 0)
4140 getlinecol(&columns, &rows);
4141#endif
4142
4143 /*
4144 * 4. If everything fails, use the old values
4145 */
4146 if (columns <= 0 || rows <= 0)
4147 return FAIL;
4148
4149 Rows = rows;
4150 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004151 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 return OK;
4153}
4154
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004155#if defined(FEAT_TERMINAL) || defined(PROTO)
4156/*
4157 * Report the windows size "rows" and "cols" to tty "fd".
4158 */
4159 int
4160mch_report_winsize(int fd, int rows, int cols)
4161{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004162 int tty_fd;
4163 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004164
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004165 tty_fd = get_tty_fd(fd);
4166 if (tty_fd >= 0)
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004167 {
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004168# if defined(TIOCSWINSZ)
4169 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004170
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004171 ws.ws_col = cols;
4172 ws.ws_row = rows;
4173 ws.ws_xpixel = cols * 5;
4174 ws.ws_ypixel = rows * 10;
4175 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4176 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4177 retval == 0 ? "success" : "failed");
4178# elif defined(TIOCSSIZE)
4179 struct ttysize ts;
4180
4181 ts.ts_cols = cols;
4182 ts.ts_lines = rows;
4183 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4184 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4185 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004186# endif
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004187 if (tty_fd != fd)
4188 close(tty_fd);
4189 }
4190 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004191}
4192#endif
4193
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194/*
4195 * Try to set the window size to Rows and Columns.
4196 */
4197 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004198mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199{
4200 if (*T_CWS)
4201 {
4202 /*
4203 * NOTE: if you get an error here that term_set_winsize() is
4204 * undefined, check the output of configure. It could probably not
4205 * find a ncurses, termcap or termlib library.
4206 */
4207 term_set_winsize((int)Rows, (int)Columns);
4208 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004209 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 }
4211}
4212
Bram Moolenaar0f873732019-12-05 20:28:46 +01004213#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214
4215/*
4216 * Rows and/or Columns has changed.
4217 */
4218 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004219mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004221 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222}
4223
Bram Moolenaar205b8862011-09-07 15:04:31 +02004224/*
4225 * Wait for process "child" to end.
4226 * Return "child" if it exited properly, <= 0 on error.
4227 */
4228 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004229wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004230{
4231 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004232 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004233
4234 while (wait_pid != child)
4235 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004236 // When compiled with Python threads are probably used, in which case
4237 // wait() sometimes hangs for no obvious reason. Use waitpid()
4238 // instead and loop (like the GUI). Also needed for other interfaces,
4239 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004240# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004241 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004242# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004243 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004244# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004245 if (wait_pid == 0)
4246 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004247 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004248 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004249 if (++delay_msec > 10)
4250 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004251 continue;
4252 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004253 if (wait_pid <= 0
4254# ifdef ECHILD
4255 && errno == ECHILD
4256# endif
4257 )
4258 break;
4259 }
4260 return wait_pid;
4261}
4262
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004263#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004264/*
4265 * Set the environment for a child process.
4266 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004267 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004268set_child_environment(
4269 long rows,
4270 long columns,
4271 char *term,
4272 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004273{
4274# ifdef HAVE_SETENV
4275 char envbuf[50];
4276# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004277 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004278 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004279 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004280 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004281 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004282# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004283 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004284# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004285# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004286 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004287# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004288# endif
4289
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004290# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004291 setenv("TERM", term, 1);
4292 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004293 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004294 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004295 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004296 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004297 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004298 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004299 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004300# ifdef FEAT_TERMINAL
4301 if (is_terminal)
4302 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004303 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004304 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4305 }
4306# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004307# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004308 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004309# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004310# else
4311 /*
4312 * Putenv does not copy the string, it has to remain valid.
4313 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004314 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004315 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004316 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4317 putenv(envbuf_Term);
4318 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004319 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004320 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4321 putenv(envbuf_Lines);
4322 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4323 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004324 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004325 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004326 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004327# ifdef FEAT_TERMINAL
4328 if (is_terminal)
4329 {
4330 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004331 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004332 putenv(envbuf_Version);
4333 }
4334# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004335# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004336 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4337 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4338 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004339# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004340# endif
4341}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004342
4343 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004344set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004345{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004346 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004347}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004348#endif
4349
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004350#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004351/*
4352 * Open a PTY, with FD for the master and slave side.
4353 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004354 * When successful both file descriptors are stored and the allocated pty name
4355 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004356 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004357 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004358open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004359{
4360 char *tty_name;
4361
Bram Moolenaar59386482019-02-10 22:43:46 +01004362 if (name1 != NULL)
4363 *name1 = NULL;
4364 if (name2 != NULL)
4365 *name2 = NULL;
4366
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004367 *pty_master_fd = mch_openpty(&tty_name); // open pty
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004368 if (*pty_master_fd >= 0)
4369 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004370 // Leaving out O_NOCTTY may lead to waitpid() always returning
4371 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4372 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004373#ifdef O_NOCTTY
4374 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
4375#else
4376 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
4377#endif
4378 if (*pty_slave_fd < 0)
4379 {
4380 close(*pty_master_fd);
4381 *pty_master_fd = -1;
4382 }
Bram Moolenaar59386482019-02-10 22:43:46 +01004383 else
4384 {
4385 if (name1 != NULL)
4386 *name1 = vim_strsave((char_u *)tty_name);
4387 if (name2 != NULL)
4388 *name2 = vim_strsave((char_u *)tty_name);
4389 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004390 }
4391}
4392#endif
4393
Bram Moolenaarfae42832017-08-01 22:24:26 +02004394/*
4395 * Send SIGINT to a child process if "c" is an interrupt character.
4396 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004397 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004398may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4399{
4400# ifdef SIGINT
4401 if (c == Ctrl_C || c == intr_char)
4402 {
4403# ifdef HAVE_SETSID
4404 kill(-pid, SIGINT);
4405# else
4406 kill(0, SIGINT);
4407# endif
4408 if (wpid > 0)
4409 kill(wpid, SIGINT);
4410 }
4411# endif
4412}
4413
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004414#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004415
Bram Moolenaar0f873732019-12-05 20:28:46 +01004416/*
4417 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4418 * pointers, the last one is NULL.
4419 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4420 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004421 int
4422unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004423 char_u *cmd,
4424 char ***argvp,
4425 char_u **sh_tofree,
4426 char_u **shcf_tofree)
4427{
4428 char **argv = NULL;
4429 int argc;
4430
4431 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004432 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004433 return FAIL;
4434
4435 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4436 return FAIL;
4437 *argvp = argv;
4438
4439 if (cmd != NULL)
4440 {
4441 char_u *s;
4442 char_u *p;
4443
4444 if (extra_shell_arg != NULL)
4445 argv[argc++] = (char *)extra_shell_arg;
4446
Bram Moolenaar0f873732019-12-05 20:28:46 +01004447 // Break 'shellcmdflag' into white separated parts. This doesn't
4448 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004449 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004450 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004451 return FAIL;
4452 s = *shcf_tofree;
4453 p = p_shcf;
4454 while (*p != NUL)
4455 {
4456 argv[argc++] = (char *)s;
4457 while (*p && *p != ' ' && *p != TAB)
4458 *s++ = *p++;
4459 *s++ = NUL;
4460 p = skipwhite(p);
4461 }
4462
4463 argv[argc++] = (char *)cmd;
4464 }
4465 argv[argc] = NULL;
4466 return OK;
4467}
4468#endif
4469
4470#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4471/*
4472 * Use a terminal window to run a shell command in.
4473 */
4474 static int
4475mch_call_shell_terminal(
4476 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004477 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004478{
4479 jobopt_T opt;
4480 char **argv = NULL;
4481 char_u *tofree1 = NULL;
4482 char_u *tofree2 = NULL;
4483 int retval = -1;
4484 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004485 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004486 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004487 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004488
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004489 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004490 goto theend;
4491
4492 init_job_options(&opt);
4493 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4494 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004495 if (buf == NULL)
4496 goto theend;
4497
4498 job = term_getjob(buf->b_term);
4499 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004500
Bram Moolenaar0f873732019-12-05 20:28:46 +01004501 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004502 aucmd_prepbuf(&aco, buf);
4503
4504 clear_oparg(&oa);
4505 while (term_use_loop())
4506 {
4507 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4508 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004509 // If terminal_loop() returns OK we got a key that is handled
4510 // in Normal model. We don't do redrawing anyway.
Bram Moolenaar13568252018-03-16 20:46:58 +01004511 if (terminal_loop(TRUE) == OK)
4512 normal_cmd(&oa, TRUE);
4513 }
4514 else
4515 normal_cmd(&oa, TRUE);
4516 }
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004517 retval = job->jv_exitval;
Bram Moolenaar13568252018-03-16 20:46:58 +01004518 ch_log(NULL, "system command finished");
4519
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004520 job_unref(job);
4521
Bram Moolenaar0f873732019-12-05 20:28:46 +01004522 // restore curwin/curbuf and a few other things
Bram Moolenaar13568252018-03-16 20:46:58 +01004523 aucmd_restbuf(&aco);
4524
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01004525 // Only require pressing Enter when redrawing, to avoid that system() gets
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004526 // the hit-enter prompt even though it didn't output anything.
4527 if (!RedrawingDisabled)
4528 wait_return(TRUE);
Bram Moolenaar13568252018-03-16 20:46:58 +01004529 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4530
4531theend:
4532 vim_free(argv);
4533 vim_free(tofree1);
4534 vim_free(tofree2);
4535 return retval;
4536}
4537#endif
4538
4539#ifdef USE_SYSTEM
4540/*
4541 * Use system() to start the shell: simple but slow.
4542 */
4543 static int
4544mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004545 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004546 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547{
4548#ifdef VMS
4549 char *ifn = NULL;
4550 char *ofn = NULL;
4551#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004552 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004553 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004554 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555
4556 out_flush();
4557
4558 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004559 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
Bram Moolenaar62b42182010-09-21 22:09:37 +02004561# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004562 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004563 loose_clipboard();
4564# endif
4565
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 if (cmd == NULL)
4567 x = system((char *)p_sh);
4568 else
4569 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004570# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 if (ofn = strchr((char *)cmd, '>'))
4572 *ofn++ = '\0';
4573 if (ifn = strchr((char *)cmd, '<'))
4574 {
4575 char *p;
4576
4577 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004578 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 if (p)
4580 *p = '\0';
4581 }
4582 if (ofn)
4583 x = vms_sys((char *)cmd, ofn, ifn);
4584 else
4585 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004586# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004587 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004589 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 if (newcmd == NULL)
4591 x = 0;
4592 else
4593 {
4594 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4595 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4596 (char *)p_shcf,
4597 (char *)cmd);
4598 x = system((char *)newcmd);
4599 vim_free(newcmd);
4600 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004601# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 }
4603# ifdef VMS
4604 x = vms_sys_status(x);
4605# endif
4606 if (emsg_silent)
4607 ;
4608 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004609 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 else if (x && !(options & SHELL_SILENT))
4611 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004612 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 msg_outnum((long)x);
4614 msg_putchar('\n');
4615 }
4616
4617 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004618 {
4619 // The shell may have messed with the mode, always set it.
4620 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004621 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004622 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 resettitle();
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004624# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4625 restore_clipboard();
4626# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004628}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629
Bram Moolenaar0f873732019-12-05 20:28:46 +01004630#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631
Bram Moolenaar0f873732019-12-05 20:28:46 +01004632# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4633 // 127, some shells use that already
4634# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
Bram Moolenaar13568252018-03-16 20:46:58 +01004636/*
4637 * Don't use system(), use fork()/exec().
4638 */
4639 static int
4640mch_call_shell_fork(
4641 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004642 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004643{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004644 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004646 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 pid_t wait_pid = 0;
4648# ifdef HAVE_UNION_WAIT
4649 union wait status;
4650# else
4651 int status = -1;
4652# endif
4653 int retval = -1;
4654 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004655 char_u *tofree1 = NULL;
4656 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004658 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004659# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004661# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004662 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 int fd_fromshell[2];
4664 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004665 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666
4667 out_flush();
4668 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004669 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004670 if (tmode == TMODE_RAW)
4671 // The shell may have messed with the mode, always set it later.
4672 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004674 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004675 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004676
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004678 * For the GUI, when writing the output into the buffer and when reading
4679 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4680 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004682 if ((options & (SHELL_READ|SHELL_WRITE))
4683# ifdef FEAT_GUI
4684 || (gui.in_use && show_shell_mess)
4685# endif
4686 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004688# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 /*
4690 * Try to open a master pty.
4691 * If this works, open the slave pty.
4692 * If the slave can't be opened, close the master pty.
4693 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004694 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004695 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 /*
4697 * If not opening a pty or it didn't work, try using pipes.
4698 */
4699 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004700# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 {
4702 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004703 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 {
4705 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004706 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 {
4708 close(fd_toshell[0]);
4709 close(fd_toshell[1]);
4710 }
4711 }
4712 if (pipe_error)
4713 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004714 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 out_flush();
4716 }
4717 }
4718 }
4719
Bram Moolenaar0f873732019-12-05 20:28:46 +01004720 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004722 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004723 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004724 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004725 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004727 UNBLOCK_SIGNALS(&curset);
4728
Bram Moolenaar32526b32019-01-19 17:43:09 +01004729 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004730 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004732 || (gui.in_use && show_shell_mess)
4733# endif
4734 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004736# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004737 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 {
4739 close(pty_master_fd);
4740 close(pty_slave_fd);
4741 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004742 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004743# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 {
4745 close(fd_toshell[0]);
4746 close(fd_toshell[1]);
4747 close(fd_fromshell[0]);
4748 close(fd_fromshell[1]);
4749 }
4750 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004752 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004754 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004755 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756
Bram Moolenaar819524702018-02-27 19:10:00 +01004757# ifdef FEAT_JOB_CHANNEL
4758 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004759 {
4760 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004761 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004762 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004763# endif
4764
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 if (!show_shell_mess || (options & SHELL_EXPAND))
4766 {
4767 int fd;
4768
4769 /*
4770 * Don't want to show any message from the shell. Can't just
4771 * close stdout and stderr though, because some systems will
4772 * break if you try to write to them after that, so we must
4773 * use dup() to replace them with something else -- webb
4774 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4775 * waiting for input.
4776 */
4777 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4778 fclose(stdin);
4779 fclose(stdout);
4780 fclose(stderr);
4781
4782 /*
4783 * If any of these open()'s and dup()'s fail, we just continue
4784 * anyway. It's not fatal, and on most systems it will make
4785 * no difference at all. On a few it will cause the execvp()
4786 * to exit with a non-zero status even when the completion
4787 * could be done, which is nothing too serious. If the open()
4788 * or dup() failed we'd just do the same thing ourselves
4789 * anyway -- webb
4790 */
4791 if (fd >= 0)
4792 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004793 vim_ignored = dup(fd); // To replace stdin (fd 0)
4794 vim_ignored = dup(fd); // To replace stdout (fd 1)
4795 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
Bram Moolenaar0f873732019-12-05 20:28:46 +01004797 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 close(fd);
4799 }
4800 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004801 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004803 || gui.in_use
4804# endif
4805 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 {
4807
Bram Moolenaardf177f62005-02-22 08:39:57 +00004808# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004809 // Create our own process group, so that the child and all its
4810 // children can be kill()ed. Don't do this when using pipes,
4811 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004812 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004813 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004814 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004815# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004816 // When doing "!xterm&" and 'shell' is bash: the shell
4817 // will exit and send SIGHUP to all processes in its
4818 // group, killing the just started process. Ignore SIGHUP
4819 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004820 signal(SIGHUP, SIG_IGN);
4821# endif
4822 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004823# endif
4824# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004825 if (pty_slave_fd >= 0)
4826 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004827 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004828 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004829 setup_slavepty(pty_slave_fd);
Bram Moolenaarfff10d92021-10-13 10:05:30 +01004830# ifdef TIOCSCTTY
4831 // Try to become controlling tty (probably doesn't work,
4832 // unless run by root)
4833 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
4834# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004835 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004836# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004837 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838
Bram Moolenaara5792f52005-11-23 21:25:05 +00004839 /*
4840 * stderr is only redirected when using the GUI, so that a
4841 * program like gpg can still access the terminal to get a
4842 * passphrase using stderr.
4843 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004844# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 if (pty_master_fd >= 0)
4846 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004847 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848
Bram Moolenaar0f873732019-12-05 20:28:46 +01004849 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004851 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004853 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004854 if (gui.in_use)
4855 {
4856 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004857 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004858 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859
Bram Moolenaar0f873732019-12-05 20:28:46 +01004860 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 }
4862 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004863# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004865 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 close(fd_toshell[1]);
4867 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004868 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 close(fd_toshell[0]);
4870
Bram Moolenaar0f873732019-12-05 20:28:46 +01004871 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 close(fd_fromshell[0]);
4873 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004874 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 close(fd_fromshell[1]);
4876
Bram Moolenaara5792f52005-11-23 21:25:05 +00004877# ifdef FEAT_GUI
4878 if (gui.in_use)
4879 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004880 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004881 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004882 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004883 }
4884# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 }
4886 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004887
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 /*
4889 * There is no type cast for the argv, because the type may be
4890 * different on different machines. This may cause a warning
4891 * message with strict compilers, don't worry about it.
4892 * Call _exit() instead of exit() to avoid closing the connection
4893 * to the X server (esp. with GTK, which uses atexit()).
4894 */
4895 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004896 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004898 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 {
4900 /*
4901 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004902 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 */
4904 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004905 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004906 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004907# ifdef FEAT_JOB_CHANNEL
4908 ++dont_check_job_ended;
4909# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 /*
4911 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004912 * This is also used to pipe stdin/stdout to/from the external
4913 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004915 if ((options & (SHELL_READ|SHELL_WRITE))
4916# ifdef FEAT_GUI
4917 || (gui.in_use && show_shell_mess)
4918# endif
4919 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004921# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004923 int buffer_off = 0; // valid bytes in buffer[]
4924 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4925 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 int len;
4927 int p_more_save;
4928 int old_State;
4929 int c;
4930 int toshell_fd;
4931 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004932 garray_T ga;
4933 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004934# ifdef ELAPSED_FUNC
4935 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004936# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
Bram Moolenaardf177f62005-02-22 08:39:57 +00004938# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 if (pty_master_fd >= 0)
4940 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 fromshell_fd = pty_master_fd;
4942 toshell_fd = dup(pty_master_fd);
4943 }
4944 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004945# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 {
4947 close(fd_toshell[0]);
4948 close(fd_fromshell[1]);
4949 toshell_fd = fd_toshell[1];
4950 fromshell_fd = fd_fromshell[0];
4951 }
4952
4953 /*
4954 * Write to the child if there are typed characters.
4955 * Read from the child if there are characters available.
4956 * Repeat the reading a few times if more characters are
4957 * available. Need to check for typed keys now and then, but
4958 * not too often (delays when no chars are available).
4959 * This loop is quit if no characters can be read from the pty
4960 * (WaitForChar detected special condition), or there are no
4961 * characters available and the child has exited.
4962 * Only check if the child has exited when there is no more
4963 * output. The child may exit before all the output has
4964 * been printed.
4965 *
4966 * Currently this busy loops!
4967 * This can probably dead-lock when the write blocks!
4968 */
4969 p_more_save = p_more;
4970 p_more = FALSE;
4971 old_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01004972 State = MODE_EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004974 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004975 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004976 // Fork a process that will write the lines to the
4977 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004978 if ((wpid = fork()) == -1)
4979 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004980 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004981 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004982 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004983 {
4984 linenr_T lnum = curbuf->b_op_start.lnum;
4985 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004986 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004987 size_t l;
4988
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004989 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004990 for (;;)
4991 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00004992 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004993 if (l == 0)
4994 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004995 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004996 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00004997 len = write(toshell_fd, "", (size_t)1);
4998 else
4999 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01005000 char_u *s = vim_strchr(lp + written, NL);
5001
Bram Moolenaar89d40322006-08-29 15:30:07 +00005002 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00005003 s == NULL ? l
5004 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005005 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00005006 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005007 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005008 // Finished a line, add a NL, unless this line
5009 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005010 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005011 || (!curbuf->b_p_bin
5012 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005013 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaardf177f62005-02-22 08:39:57 +00005014 && (lnum !=
5015 curbuf->b_ml.ml_line_count
5016 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02005017 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005018 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005019 ++lnum;
5020 if (lnum > curbuf->b_op_end.lnum)
5021 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005022 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00005023 close(toshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005024 break;
5025 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00005026 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005027 written = 0;
5028 }
5029 else if (len > 0)
5030 written += len;
5031 }
5032 _exit(0);
5033 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005034 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00005035 {
5036 close(toshell_fd);
5037 toshell_fd = -1;
5038 }
5039 }
5040
5041 if (options & SHELL_READ)
5042 ga_init2(&ga, 1, BUFLEN);
5043
5044 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005045# ifdef ELAPSED_FUNC
5046 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005047# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 for (;;)
5049 {
5050 /*
5051 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005052 * if there are any.
5053 * Don't do this if we are expanding wild cards (would eat
5054 * typeahead).
5055 * Don't do this when filtering and terminal is in cooked
5056 * mode, the shell command will handle the I/O. Avoids
5057 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005058 * Don't get characters when the child has already
5059 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00005060 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005061 * while (noread_cnt > 4), avoids that ":r !ls" eats
5062 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 */
5064 len = 0;
5065 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005066 && ((options &
5067 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5068 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005069# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005070 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005071# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005072 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005073 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005074 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005076 if (ta_len == 0)
5077 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005078 // Get extra characters when we don't have any.
5079 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005080 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005081# ifdef ELAPSED_FUNC
5082 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005083# endif
5084 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5085 }
5086 if (ta_len > 0 || len > 0)
5087 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 /*
5089 * For pipes:
5090 * Check for CTRL-C: send interrupt signal to child.
5091 * Check for CTRL-D: EOF, close pipe to child.
5092 */
5093 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5094 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 /*
5096 * Send SIGINT to the child's group or all
5097 * processes in our group.
5098 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005099 may_send_sigint(ta_buf[ta_len], pid, wpid);
5100
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 if (pty_master_fd < 0 && toshell_fd >= 0
5102 && ta_buf[ta_len] == Ctrl_D)
5103 {
5104 close(toshell_fd);
5105 toshell_fd = -1;
5106 }
5107 }
5108
Bram Moolenaarf4140482020-02-15 23:06:45 +01005109 term_replace_bs_del_keycode(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110
5111 /*
5112 * For pipes: echo the typed characters.
5113 * For a pty this does not seem to work.
5114 */
5115 if (pty_master_fd < 0)
5116 {
5117 for (i = ta_len; i < ta_len + len; ++i)
5118 {
5119 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5120 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 else if (has_mbyte)
5122 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005123 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124
5125 msg_outtrans_len(ta_buf + i, l);
5126 i += l - 1;
5127 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 else
5129 msg_outtrans_len(ta_buf + i, 1);
5130 }
5131 windgoto(msg_row, msg_col);
5132 out_flush();
5133 }
5134
5135 ta_len += len;
5136
5137 /*
5138 * Write the characters to the child, unless EOF has
5139 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005140 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005141 * When writing buffer lines, drop the typed
5142 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005144 if (options & SHELL_WRITE)
5145 ta_len = 0;
5146 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 {
5148 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5149 if (len > 0)
5150 {
5151 ta_len -= len;
5152 mch_memmove(ta_buf, ta_buf + len, ta_len);
5153 }
5154 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005155 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 }
5157
Bram Moolenaardf177f62005-02-22 08:39:57 +00005158 if (got_int)
5159 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005160 // CTRL-C sends a signal to the child, we ignore it
5161 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005162# ifdef HAVE_SETSID
5163 kill(-pid, SIGINT);
5164# else
5165 kill(0, SIGINT);
5166# endif
5167 if (wpid > 0)
5168 kill(wpid, SIGINT);
5169 got_int = FALSE;
5170 }
5171
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 /*
5173 * Check if the child has any characters to be printed.
5174 * Read them and write them to our window. Repeat this as
5175 * long as there is something to do, avoid the 10ms wait
5176 * for mch_inchar(), or sending typeahead characters to
5177 * the external process.
5178 * TODO: This should handle escape sequences, compatible
5179 * to some terminal (vt52?).
5180 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005181 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005182 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005184 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005187 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005189
5190 noread_cnt = 0;
5191 if (options & SHELL_READ)
5192 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005193 // Do NUL -> NL translation, append NL separated
5194 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005195 for (i = 0; i < len; ++i)
5196 {
5197 if (buffer[i] == NL)
5198 append_ga_line(&ga);
5199 else if (buffer[i] == NUL)
5200 ga_append(&ga, NL);
5201 else
5202 ga_append(&ga, buffer[i]);
5203 }
5204 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005205 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 {
5207 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005208 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209
Bram Moolenaardf177f62005-02-22 08:39:57 +00005210 len += buffer_off;
5211 buffer[len] = NUL;
5212
Bram Moolenaar0f873732019-12-05 20:28:46 +01005213 // Check if the last character in buffer[] is
5214 // incomplete, keep these bytes for the next
5215 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 for (p = buffer; p < buffer + len; p += l)
5217 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005218 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005220 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 else if (MB_BYTE2LEN(*p) != l)
5222 break;
5223 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005224 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005226 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 if (len >= 12)
5228 ++p;
5229 else
5230 {
5231 buffer_off = len;
5232 continue;
5233 }
5234 }
5235 c = *p;
5236 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005237 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 if (p < buffer + len)
5239 {
5240 *p = c;
5241 buffer_off = (buffer + len) - p;
5242 mch_memmove(buffer, p, buffer_off);
5243 continue;
5244 }
5245 buffer_off = 0;
5246 }
5247 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 {
5249 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005250 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 }
5252
5253 windgoto(msg_row, msg_col);
5254 cursor_on();
5255 out_flush();
5256 if (got_int)
5257 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005258
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005259# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005260 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005261 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005262 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005263
Bram Moolenaar0f873732019-12-05 20:28:46 +01005264 // Avoid that we keep looping here without
5265 // checking for a CTRL-C for a long time. Don't
5266 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005267 if (msec > 2000)
5268 {
5269 noread_cnt = 5;
5270 break;
5271 }
5272 }
5273# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 }
5275
Bram Moolenaar0f873732019-12-05 20:28:46 +01005276 // If we already detected the child has finished, continue
5277 // reading output for a short while. Some text may be
5278 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005279 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005280 {
5281 if (noread_cnt < 5)
5282 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005283 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005284 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005285
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 /*
5287 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005288 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005290# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005291 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005292# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005294# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5296 || (wait_pid == pid && WIFEXITED(status)))
5297 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005298 // Don't break the loop yet, try reading more
5299 // characters from "fromshell_fd" first. When using
5300 // pipes there might still be something to read and
5301 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005304 else
5305 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005306
Bram Moolenaar95a51352013-03-21 22:53:50 +01005307# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005308 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005309 clip_update();
5310# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 }
5312finished:
5313 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005314 if (options & SHELL_READ)
5315 {
5316 if (ga.ga_len > 0)
5317 {
5318 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005319 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005320 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005321 }
5322 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005323 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005324 ga_clear(&ga);
5325 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 /*
5328 * Give all typeahead that wasn't used back to ui_inchar().
5329 */
5330 if (ta_len)
5331 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 State = old_State;
5333 if (toshell_fd >= 0)
5334 close(toshell_fd);
5335 close(fromshell_fd);
5336 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005337# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005338 else
5339 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005340 long delay_msec = 1;
5341
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005342 if (tmode == TMODE_RAW)
5343 // possibly disables modifyOtherKeys, so that the system
5344 // can recognize CTRL-C
5345 out_str(T_CTE);
Bram Moolenaar0981c872020-08-23 14:28:37 +02005346
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005347 /*
5348 * Similar to the loop above, but only handle X events, no
5349 * I/O.
5350 */
5351 for (;;)
5352 {
5353 if (got_int)
5354 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005355 // CTRL-C sends a signal to the child, we ignore it
5356 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005357# ifdef HAVE_SETSID
5358 kill(-pid, SIGINT);
5359# else
5360 kill(0, SIGINT);
5361# endif
5362 got_int = FALSE;
5363 }
5364# ifdef __NeXT__
5365 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5366# else
5367 wait_pid = waitpid(pid, &status, WNOHANG);
5368# endif
5369 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5370 || (wait_pid == pid && WIFEXITED(status)))
5371 {
5372 wait_pid = pid;
5373 break;
5374 }
5375
Bram Moolenaar0f873732019-12-05 20:28:46 +01005376 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005377 clip_update();
5378
Bram Moolenaar0f873732019-12-05 20:28:46 +01005379 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005380 // less time, gradually wait longer.
5381 mch_delay(delay_msec,
5382 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005383 if (++delay_msec > 10)
5384 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005385 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005386
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005387 if (tmode == TMODE_RAW)
5388 // possibly enables modifyOtherKeys again
5389 out_str(T_CTI);
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005390 }
5391# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
5393 /*
5394 * Wait until our child has exited.
5395 * Ignore wait() returning pids of other children and returning
5396 * because of some signal like SIGWINCH.
5397 * Don't wait if wait_pid was already set above, indicating the
5398 * child already exited.
5399 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005400 if (wait_pid != pid)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01005401 (void)wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402
Bram Moolenaar624891f2010-10-13 16:22:09 +02005403# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005404 // Close slave side of pty. Only do this after the child has
5405 // exited, otherwise the child may hang when it tries to write on
5406 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005407 if (pty_master_fd >= 0)
5408 close(pty_slave_fd);
5409# endif
5410
Bram Moolenaar0f873732019-12-05 20:28:46 +01005411 // Make sure the child that writes to the external program is
5412 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005413 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005414 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005415 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005416 wait4pid(wpid, NULL);
5417 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005418
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005419# ifdef FEAT_JOB_CHANNEL
5420 --dont_check_job_ended;
5421# endif
5422
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 /*
5424 * Set to raw mode right now, otherwise a CTRL-C after
5425 * catch_signals() will kill Vim.
5426 */
5427 if (tmode == TMODE_RAW)
5428 settmode(TMODE_RAW);
5429 did_settmode = TRUE;
5430 set_signals();
5431
5432 if (WIFEXITED(status))
5433 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005434 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005436 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 {
5438 if (retval == EXEC_FAILED)
5439 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005440 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 msg_outtrans(p_sh);
5442 msg_putchar('\n');
5443 }
5444 else if (!(options & SHELL_SILENT))
5445 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005446 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 msg_outnum((long)retval);
5448 msg_putchar('\n');
5449 }
5450 }
5451 }
5452 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005453 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 }
5455 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456
5457error:
5458 if (!did_settmode)
5459 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005460 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 resettitle();
Bram Moolenaar13568252018-03-16 20:46:58 +01005462 vim_free(argv);
5463 vim_free(tofree1);
5464 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465
5466 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005467}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005468#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005469
5470 int
5471mch_call_shell(
5472 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005473 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005474{
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005475#ifdef FEAT_JOB_CHANNEL
5476 ch_log(NULL, "executing shell command: %s", cmd);
5477#endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005478#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
5479 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
5480 return mch_call_shell_terminal(cmd, options);
5481#endif
5482#ifdef USE_SYSTEM
5483 return mch_call_shell_system(cmd, options);
5484#else
5485 return mch_call_shell_fork(cmd, options);
5486#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487}
5488
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005489#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005490 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005491mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005492{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005493 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005494 int fd_in[2] = {-1, -1}; // for stdin
5495 int fd_out[2] = {-1, -1}; // for stdout
5496 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005497 int pty_master_fd = -1;
5498 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005499 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005500 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5501 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5502 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005503 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005504 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5505 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005506 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005507 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005508 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005509
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005510 if (use_out_for_err && use_null_for_out)
5511 use_null_for_err = TRUE;
5512
Bram Moolenaar0f873732019-12-05 20:28:46 +01005513 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005514 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005515
Bram Moolenaarb2412082017-08-20 18:09:14 +02005516 if (options->jo_pty
5517 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005518 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005519 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005520 open_pty(&pty_master_fd, &pty_slave_fd,
5521 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005522
Bram Moolenaar0f873732019-12-05 20:28:46 +01005523 // TODO: without the channel feature connect the child to /dev/null?
5524 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005525 if (use_file_for_in)
5526 {
5527 char_u *fname = options->jo_io_name[PART_IN];
5528
5529 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5530 if (fd_in[0] < 0)
5531 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005532 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005533 goto failed;
5534 }
5535 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005536 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005537 // When writing buffer lines to the input don't use the pty, so that
5538 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005539 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5540 && pipe(fd_in) < 0)
5541 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005542
5543 if (use_file_for_out)
5544 {
5545 char_u *fname = options->jo_io_name[PART_OUT];
5546
5547 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5548 if (fd_out[1] < 0)
5549 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005550 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005551 goto failed;
5552 }
5553 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005554 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005555 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005556
5557 if (use_file_for_err)
5558 {
5559 char_u *fname = options->jo_io_name[PART_ERR];
5560
5561 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5562 if (fd_err[1] < 0)
5563 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005564 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005565 goto failed;
5566 }
5567 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005568 else if (!use_out_for_err && !use_null_for_err
5569 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005570 goto failed;
5571
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005572 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5573 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005574 if (options->jo_set & JO_CHANNEL)
5575 {
5576 channel = options->jo_channel;
5577 if (channel != NULL)
5578 ++channel->ch_refcount;
5579 }
5580 else
5581 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005582 if (channel == NULL)
5583 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005584 if (job->jv_tty_out != NULL)
5585 ch_log(channel, "using pty %s on fd %d",
5586 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005587 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005588
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005589 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005590 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005591 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005592 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005593 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005594 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005595 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005596 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005597 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005598 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005599 int null_fd = -1;
5600 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005601
Bram Moolenaar0f873732019-12-05 20:28:46 +01005602 // child
5603 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005604 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005605
Bram Moolenaar819524702018-02-27 19:10:00 +01005606# ifdef FEAT_JOB_CHANNEL
5607 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005608 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005609 ch_logfile((char_u *)"", (char_u *)"");
5610# endif
5611
Bram Moolenaar835dc632016-02-07 14:27:38 +01005612# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005613 // Create our own process group, so that the child and all its
5614 // children can be kill()ed. Don't do this when using pipes,
5615 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005616 (void)setsid();
5617# endif
5618
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005619# ifdef FEAT_TERMINAL
5620 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005621 {
5622 char *term = (char *)T_NAME;
5623
5624#ifdef FEAT_GUI
5625 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005626 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005627 term = getenv("TERM");
5628#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005629 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005630 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005631 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005632 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005633 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005634 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005635 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005636 else if (t_colors > 16)
5637 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005638 else
5639 term = "xterm";
5640 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005641 set_child_environment(
5642 (long)options->jo_term_rows,
5643 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005644 term,
5645 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005646 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005647 else
5648# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005649 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005650
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005651 if (options->jo_env != NULL)
5652 {
5653 dict_T *dict = options->jo_env;
5654 hashitem_T *hi;
5655 int todo = (int)dict->dv_hashtab.ht_used;
5656
5657 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5658 if (!HASHITEM_EMPTY(hi))
5659 {
5660 typval_T *item = &dict_lookup(hi)->di_tv;
5661
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00005662 vim_setenv(hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005663 --todo;
5664 }
5665 }
5666
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005667 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005668 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005669 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005670 if (null_fd < 0)
5671 {
5672 perror("opening /dev/null failed");
5673 _exit(OPEN_NULL_FAILED);
5674 }
5675 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005676
Bram Moolenaar223896d2017-08-02 22:33:28 +02005677 if (pty_slave_fd >= 0)
5678 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005679 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005680 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005681# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005682 // Try to become controlling tty (probably doesn't work,
5683 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005684 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5685# endif
5686 }
5687
Bram Moolenaar0f873732019-12-05 20:28:46 +01005688 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005689 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005690 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005691 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005692 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005693 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005694 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005695 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005696
Bram Moolenaar0f873732019-12-05 20:28:46 +01005697 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005698 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005699 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005700 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005701 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005702 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005703 }
5704 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005705 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005706 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005707 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005708 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005709 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005710
Bram Moolenaar0f873732019-12-05 20:28:46 +01005711 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005712 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005713 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005714 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005715 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005716 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005717 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005718 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005719
5720 if (fd_in[0] >= 0)
5721 close(fd_in[0]);
5722 if (fd_in[1] >= 0)
5723 close(fd_in[1]);
5724 if (fd_out[0] >= 0)
5725 close(fd_out[0]);
5726 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005727 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005728 if (fd_err[0] >= 0)
5729 close(fd_err[0]);
5730 if (fd_err[1] >= 0)
5731 close(fd_err[1]);
5732 if (pty_master_fd >= 0)
5733 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005734 close(pty_master_fd); // not used in the child
5735 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005736 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005737
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005738 if (null_fd >= 0)
5739 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005740
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005741 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5742 _exit(EXEC_FAILED);
5743
Bram Moolenaar0f873732019-12-05 20:28:46 +01005744 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005745 execvp(argv[0], argv);
5746
Bram Moolenaar4694a172016-04-21 14:05:23 +02005747 if (stderr_works)
5748 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005749# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005750 // calling free_all_mem() here causes problems. Ignore valgrind
5751 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005752# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005753 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005754 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005755
Bram Moolenaar0f873732019-12-05 20:28:46 +01005756 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005757 UNBLOCK_SIGNALS(&curset);
5758
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005759 job->jv_pid = pid;
5760 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005761 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005762
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005763 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005764 close(pty_slave_fd); // not used in the parent
5765 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005766 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005767 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005768 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005769 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005770 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005771 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005772 if (channel != NULL)
5773 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005774 int in_fd = INVALID_FD;
5775 int out_fd = INVALID_FD;
5776 int err_fd = INVALID_FD;
5777
5778 if (!(use_file_for_in || use_null_for_in))
5779 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5780
5781 if (!(use_file_for_out || use_null_for_out))
5782 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5783
5784 // When using pty_master_fd only set it for stdout, do not duplicate
5785 // it for stderr, it only needs to be read once.
5786 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5787 {
5788 if (fd_err[0] >= 0)
5789 err_fd = fd_err[0];
5790 else if (out_fd != pty_master_fd)
5791 err_fd = pty_master_fd;
5792 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005793
5794 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005795 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005796 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005797 else
5798 {
5799 if (fd_in[1] >= 0)
5800 close(fd_in[1]);
5801 if (fd_out[0] >= 0)
5802 close(fd_out[0]);
5803 if (fd_err[0] >= 0)
5804 close(fd_err[0]);
5805 if (pty_master_fd >= 0)
5806 close(pty_master_fd);
5807 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005808
Bram Moolenaar0f873732019-12-05 20:28:46 +01005809 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005810 return;
5811
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005812failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005813 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005814 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005815 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005816 if (fd_in[1] >= 0)
5817 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005818 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005819 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005820 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005821 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005822 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005823 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005824 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005825 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005826 if (pty_master_fd >= 0)
5827 close(pty_master_fd);
5828 if (pty_slave_fd >= 0)
5829 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005830}
5831
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005832 static char_u *
5833get_signal_name(int sig)
5834{
5835 int i;
5836 char_u numbuf[NUMBUFLEN];
5837
5838 if (sig == SIGKILL)
5839 return vim_strsave((char_u *)"kill");
5840
5841 for (i = 0; signal_info[i].sig != -1; i++)
5842 if (sig == signal_info[i].sig)
5843 return strlow_save((char_u *)signal_info[i].name);
5844
5845 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5846 return vim_strsave(numbuf);
5847}
5848
Bram Moolenaar835dc632016-02-07 14:27:38 +01005849 char *
5850mch_job_status(job_T *job)
5851{
5852# ifdef HAVE_UNION_WAIT
5853 union wait status;
5854# else
5855 int status = -1;
5856# endif
5857 pid_t wait_pid = 0;
5858
5859# ifdef __NeXT__
5860 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5861# else
5862 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5863# endif
5864 if (wait_pid == -1)
5865 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005866 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005867 if (job->jv_status < JOB_ENDED)
5868 ch_log(job->jv_channel, "Job no longer exists: %s",
5869 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005870 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005871 }
5872 if (wait_pid == 0)
5873 return "run";
5874 if (WIFEXITED(status))
5875 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005876 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005877 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005878 if (job->jv_status < JOB_ENDED)
5879 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005880 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005881 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005882 if (WIFSIGNALED(status))
5883 {
5884 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005885 job->jv_termsig = get_signal_name(WTERMSIG(status));
5886 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5887 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5888 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005889 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005890 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005891 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005892
5893return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005894 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005895 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005896 return "dead";
5897}
5898
5899 job_T *
5900mch_detect_ended_job(job_T *job_list)
5901{
5902# ifdef HAVE_UNION_WAIT
5903 union wait status;
5904# else
5905 int status = -1;
5906# endif
5907 pid_t wait_pid = 0;
5908 job_T *job;
5909
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005910# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005911 // Do not do this when waiting for a shell command to finish, we would get
5912 // the exit value here (and discard it), the exit value obtained there
5913 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005914 if (dont_check_job_ended > 0)
5915 return NULL;
5916# endif
5917
Bram Moolenaar97792de2016-10-15 18:36:49 +02005918# ifdef __NeXT__
5919 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5920# else
5921 wait_pid = waitpid(-1, &status, WNOHANG);
5922# endif
5923 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005924 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005925 return NULL;
5926 for (job = job_list; job != NULL; job = job->jv_next)
5927 {
5928 if (job->jv_pid == wait_pid)
5929 {
5930 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005931 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005932 job->jv_exitval = WEXITSTATUS(status);
5933 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005934 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005935 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005936 job->jv_termsig = get_signal_name(WTERMSIG(status));
5937 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005938 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005939 {
5940 ch_log(job->jv_channel, "Job ended");
5941 job->jv_status = JOB_ENDED;
5942 }
5943 return job;
5944 }
5945 }
5946 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005947}
5948
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005949/*
5950 * Send a (deadly) signal to "job".
5951 * Return FAIL if "how" is not a valid name.
5952 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005953 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005954mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005955{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005956 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005957
Bram Moolenaar923d9262016-02-25 20:56:01 +01005958 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005959 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005960 else if (STRCMP(how, "hup") == 0)
5961 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005962 else if (STRCMP(how, "quit") == 0)
5963 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005964 else if (STRCMP(how, "int") == 0)
5965 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005966 else if (STRCMP(how, "kill") == 0)
5967 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005968#ifdef SIGWINCH
5969 else if (STRCMP(how, "winch") == 0)
5970 sig = SIGWINCH;
5971#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005972 else if (isdigit(*how))
5973 sig = atoi((char *)how);
5974 else
5975 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005976
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005977 // Never kill ourselves!
5978 if (job->jv_pid != 0)
5979 {
5980 // TODO: have an option to only kill the process, not the group?
5981 kill(-job->jv_pid, sig);
5982 kill(job->jv_pid, sig);
5983 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005984
Bram Moolenaar835dc632016-02-07 14:27:38 +01005985 return OK;
5986}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005987
5988/*
5989 * Clear the data related to "job".
5990 */
5991 void
5992mch_clear_job(job_T *job)
5993{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005994 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01005995# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005996 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005997# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005998 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005999# endif
6000}
Bram Moolenaar835dc632016-02-07 14:27:38 +01006001#endif
6002
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006003#if defined(FEAT_TERMINAL) || defined(PROTO)
6004 int
6005mch_create_pty_channel(job_T *job, jobopt_T *options)
6006{
6007 int pty_master_fd = -1;
6008 int pty_slave_fd = -1;
6009 channel_T *channel;
6010
Bram Moolenaar59386482019-02-10 22:43:46 +01006011 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02006012 if (pty_master_fd < 0 || pty_slave_fd < 0)
6013 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006014 close(pty_slave_fd);
6015
6016 channel = add_channel();
6017 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006018 {
6019 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006020 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006021 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02006022 if (job->jv_tty_out != NULL)
6023 ch_log(channel, "using pty %s on fd %d",
6024 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006025 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006026 channel->ch_keep_open = TRUE;
6027
Bram Moolenaar0f873732019-12-05 20:28:46 +01006028 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
6029 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006030 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006031 channel_set_job(channel, job, options);
6032 return OK;
6033}
6034#endif
6035
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036/*
6037 * Check for CTRL-C typed by reading all available characters.
6038 * In cooked mode we should get SIGINT, no need to check.
6039 */
6040 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006041mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042{
Bram Moolenaar26e86442020-05-17 14:06:16 +02006043 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006044 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 fill_input_buf(FALSE);
6046}
6047
6048/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006049 * Wait "msec" msec until a character is available from the mouse, keyboard,
6050 * from inbuf[].
6051 * "msec" == -1 will block forever.
6052 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006053 * When "ignore_input" is TRUE even check for pending input when input is
6054 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006055 * "interrupted" (if not NULL) is set to TRUE when no character is available
6056 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02006057 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006058 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 */
6060 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006061WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006063#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01006064 return ui_wait_for_chars_or_timer(
6065 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006066#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006067 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006068#endif
6069}
6070
6071/*
6072 * Wait "msec" msec until a character is available from the mouse or keyboard
6073 * or from inbuf[].
6074 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006075 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006076 * "interrupted" (if not NULL) is set to TRUE when no character is available
6077 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006078 * When a GUI is being used, this will never get called -- webb
6079 */
6080 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006081WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006082{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083#ifdef FEAT_MOUSE_GPM
6084 int gpm_process_wanted;
6085#endif
6086#ifdef FEAT_XCLIPBOARD
6087 int rest;
6088#endif
6089 int avail;
6090
Bram Moolenaar0f873732019-12-05 20:28:46 +01006091 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 return 1;
6093
6094#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006095 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 if (WantQueryMouse)
6097 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006098 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006099 if (!no_query_mouse_for_testing)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00006100 mch_write((char_u *)"\033[1'|", 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 }
6102#endif
6103
6104 /*
6105 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6106 * events. This is a bit complicated, because they might both be defined.
6107 */
6108#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6109# ifdef FEAT_XCLIPBOARD
6110 rest = 0;
6111 if (do_xterm_trace())
6112 rest = msec;
6113# endif
6114 do
6115 {
6116# ifdef FEAT_XCLIPBOARD
6117 if (rest != 0)
6118 {
6119 msec = XT_TRACE_DELAY;
6120 if (rest >= 0 && rest < XT_TRACE_DELAY)
6121 msec = rest;
6122 if (rest >= 0)
6123 rest -= msec;
6124 }
6125# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006126# ifdef FEAT_SOUND_CANBERRA
6127 // Invoke any pending sound callbacks.
6128 if (has_sound_callback_in_queue())
6129 invoke_sound_callback();
6130# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131# ifdef FEAT_MOUSE_GPM
6132 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006133 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006134 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006135 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006137 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006139# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006141 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 return 1;
6143# ifdef FEAT_XCLIPBOARD
6144 if (rest == 0 || !do_xterm_trace())
6145# endif
6146 break;
6147 }
6148 }
6149 while (FALSE
6150# ifdef FEAT_MOUSE_GPM
6151 || (gpm_process_wanted && mch_gpm_process() == 0)
6152# endif
6153# ifdef FEAT_XCLIPBOARD
6154 || (!avail && rest != 0)
6155# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006156 )
6157 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158
6159#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006160 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161#endif
6162 return avail;
6163}
6164
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006165#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166/*
6167 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006168 * "msec" == 0 will check for characters once.
6169 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006172 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006173 * "interrupted" (if not NULL) is set to TRUE when no character is available
6174 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006176 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006177RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178{
6179 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006180 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006181#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 static int busy = FALSE;
6183
Bram Moolenaar0f873732019-12-05 20:28:46 +01006184 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185# define MAY_LOOP
6186
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006187# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006188 // Remember at what time we started, so that we know how much longer we
6189 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006190 long start_msec = msec;
6191 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006193 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006194 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195# endif
6196
Bram Moolenaar0f873732019-12-05 20:28:46 +01006197 // Handle being called recursively. This may happen for the session
6198 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 if (busy)
6200 return 0;
6201#endif
6202
6203#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006204 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205#endif
6206 {
6207#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006208 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006209# ifdef FEAT_MZSCHEME
6210 int mzquantum_used = FALSE;
6211# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212#endif
6213#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006214 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006215 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 int nfd;
6217# ifdef FEAT_XCLIPBOARD
6218 int xterm_idx = -1;
6219# endif
6220# ifdef FEAT_MOUSE_GPM
6221 int gpm_idx = -1;
6222# endif
6223# ifdef USE_XSMP
6224 int xsmp_idx = -1;
6225# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006226 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006228# ifdef FEAT_MZSCHEME
6229 mzvim_check_threads();
6230 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6231 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006232 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006233 mzquantum_used = TRUE;
6234 }
6235# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 fds[0].fd = fd;
6237 fds[0].events = POLLIN;
6238 nfd = 1;
6239
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006241 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 if (xterm_Shell != (Widget)0)
6243 {
6244 xterm_idx = nfd;
6245 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6246 fds[nfd].events = POLLIN;
6247 nfd++;
6248 }
6249# endif
6250# ifdef FEAT_MOUSE_GPM
6251 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6252 {
6253 gpm_idx = nfd;
6254 fds[nfd].fd = gpm_fd;
6255 fds[nfd].events = POLLIN;
6256 nfd++;
6257 }
6258# endif
6259# ifdef USE_XSMP
6260 if (xsmp_icefd != -1)
6261 {
6262 xsmp_idx = nfd;
6263 fds[nfd].fd = xsmp_icefd;
6264 fds[nfd].events = POLLIN;
6265 nfd++;
6266 }
6267# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006268#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006269 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006270#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006271 if (interrupted != NULL)
6272 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006274 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006275
6276 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006277 if (result == 0 && interrupted != NULL && ret > 0)
6278 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006279
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006280# ifdef FEAT_MZSCHEME
6281 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006282 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006283 finished = FALSE;
6284# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286# ifdef FEAT_XCLIPBOARD
6287 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6288 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006289 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006291 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 finished = FALSE;
6293 }
6294# endif
6295# ifdef FEAT_MOUSE_GPM
6296 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298# endif
6299# ifdef USE_XSMP
6300 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6301 {
6302 if (fds[xsmp_idx].revents & POLLIN)
6303 {
6304 busy = TRUE;
6305 xsmp_handle_requests();
6306 busy = FALSE;
6307 }
6308 else if (fds[xsmp_idx].revents & POLLHUP)
6309 {
6310 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006311 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 xsmp_close();
6313 }
6314 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006315 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 }
6317# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006318#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006319 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006320 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006321 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006322#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323
Bram Moolenaar0f873732019-12-05 20:28:46 +01006324#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325
6326 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006327 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006328 // These are static because they can take 8 Kbyte each and cause the
6329 // signal stack to run out with -O3.
6330 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006332 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006334# ifdef FEAT_MZSCHEME
6335 mzvim_check_threads();
6336 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6337 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006338 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006339 mzquantum_used = TRUE;
6340 }
6341# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006343 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006345 tv.tv_sec = towait / 1000;
6346 tv.tv_usec = (towait % 1000) * (1000000/1000);
6347 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006349 else
6350 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351
6352 /*
6353 * Select on ready for reading and exceptional condition (end of file).
6354 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006355select_eintr:
6356 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006357 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 FD_ZERO(&efds);
6359 FD_SET(fd, &rfds);
K.Takatab247e062022-02-07 10:45:23 +00006360# ifndef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006361 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 FD_SET(fd, &efds);
6363# endif
6364 maxfd = fd;
6365
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006367 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 if (xterm_Shell != (Widget)0)
6369 {
6370 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6371 if (maxfd < ConnectionNumber(xterm_dpy))
6372 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006373
Bram Moolenaar0f873732019-12-05 20:28:46 +01006374 // An event may have already been read but not handled. In
6375 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006376 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 }
6378# endif
6379# ifdef FEAT_MOUSE_GPM
6380 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6381 {
6382 FD_SET(gpm_fd, &rfds);
6383 FD_SET(gpm_fd, &efds);
6384 if (maxfd < gpm_fd)
6385 maxfd = gpm_fd;
6386 }
6387# endif
6388# ifdef USE_XSMP
6389 if (xsmp_icefd != -1)
6390 {
6391 FD_SET(xsmp_icefd, &rfds);
6392 FD_SET(xsmp_icefd, &efds);
6393 if (maxfd < xsmp_icefd)
6394 maxfd = xsmp_icefd;
6395 }
6396# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006397# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006398 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006399# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006400 if (interrupted != NULL)
6401 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402
Bram Moolenaar643b6142018-09-12 20:29:09 +02006403 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6404 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006405 result = ret > 0 && FD_ISSET(fd, &rfds);
6406 if (result)
6407 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006408 else if (interrupted != NULL && ret > 0)
6409 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006410
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006411# ifdef EINTR
6412 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006413 {
dbivolaruab16ad32021-12-29 19:41:47 +00006414 // Check whether the EINTR is caused by SIGTSTP
6415 if (got_tstp && !in_mch_suspend)
6416 {
6417 exarg_T ea;
dbivolaru79a6e252022-01-23 16:41:14 +00006418
dbivolaruab16ad32021-12-29 19:41:47 +00006419 ea.forceit = TRUE;
6420 ex_stop(&ea);
6421 got_tstp = FALSE;
6422 }
6423
Bram Moolenaar0f873732019-12-05 20:28:46 +01006424 // Check whether window has been resized, EINTR may be caused by
6425 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006426 if (do_resize)
6427 handle_resize();
6428
Bram Moolenaar0f873732019-12-05 20:28:46 +01006429 // Interrupted by a signal, need to try again. We ignore msec
6430 // here, because we do want to check even after a timeout if
6431 // characters are available. Needed for reading output of an
6432 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006433 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006434 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006435# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006436# ifdef __TANDEM
6437 if (ret == -1 && errno == ENOTSUP)
6438 {
6439 FD_ZERO(&rfds);
6440 FD_ZERO(&efds);
6441 ret = 0;
6442 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006443# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006444# ifdef FEAT_MZSCHEME
6445 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006446 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006447 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448# endif
6449
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450# ifdef FEAT_XCLIPBOARD
6451 if (ret > 0 && xterm_Shell != (Widget)0
6452 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6453 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006454 xterm_update(); // Maybe we should hand out clipboard
6455 // continue looping when we only got the X event and the input
6456 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 if (--ret == 0 && !input_available())
6458 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006459 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 finished = FALSE;
6461 }
6462 }
6463# endif
6464# ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00006465 if (ret > 0 && check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 {
6467 if (FD_ISSET(gpm_fd, &efds))
6468 gpm_close();
6469 else if (FD_ISSET(gpm_fd, &rfds))
6470 *check_for_gpm = 1;
6471 }
6472# endif
6473# ifdef USE_XSMP
6474 if (ret > 0 && xsmp_icefd != -1)
6475 {
6476 if (FD_ISSET(xsmp_icefd, &efds))
6477 {
6478 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006479 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 xsmp_close();
6481 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006482 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 }
6484 else if (FD_ISSET(xsmp_icefd, &rfds))
6485 {
6486 busy = TRUE;
6487 xsmp_handle_requests();
6488 busy = FALSE;
6489 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006490 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 }
6492 }
6493# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006494#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006495 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006496 if (ret >= 0)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01006497 (void)channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006498#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499
Bram Moolenaar0f873732019-12-05 20:28:46 +01006500#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501
6502#ifdef MAY_LOOP
6503 if (finished || msec == 0)
6504 break;
6505
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006506# ifdef FEAT_CLIENTSERVER
6507 if (server_waiting())
6508 break;
6509# endif
6510
Bram Moolenaar0f873732019-12-05 20:28:46 +01006511 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 if (msec > 0)
6513 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006514# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006515 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006516 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006518 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 msec = msec / 2;
6520# endif
6521 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006522 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 }
6524#endif
6525 }
6526
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006527 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528}
6529
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006531 * Expand a path into all matching files and/or directories. Handles "*",
6532 * "?", "[a-z]", "**", etc.
6533 * "path" has backslashes before chars that are not to be expanded.
6534 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 */
6536 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006537mch_expandpath(
6538 garray_T *gap,
6539 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006540 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541{
Bram Moolenaar02743632005-07-25 20:42:36 +00006542 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544
6545/*
6546 * mch_expand_wildcards() - this code does wild-card pattern matching using
6547 * the shell
6548 *
6549 * return OK for success, FAIL for error (you may lose some memory) and put
6550 * an error message in *file.
6551 *
6552 * num_pat is number of input patterns
6553 * pat is array of pointers to input patterns
6554 * num_file is pointer to number of matched file names
6555 * file is pointer to array of pointers to matched file names
6556 */
6557
6558#ifndef SEEK_SET
6559# define SEEK_SET 0
6560#endif
6561#ifndef SEEK_END
6562# define SEEK_END 2
6563#endif
6564
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006565#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006566
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006568mch_expand_wildcards(
6569 int num_pat,
6570 char_u **pat,
6571 int *num_file,
6572 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006573 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574{
6575 int i;
6576 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006577 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 char_u *p;
6579 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580
Bram Moolenaarc7247912008-01-13 12:54:11 +00006581 /*
6582 * This is the non-OS/2 implementation (really Unix).
6583 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 int j;
6585 char_u *tempname;
6586 char_u *command;
6587 FILE *fd;
6588 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006589#define STYLE_ECHO 0 // use "echo", the default
6590#define STYLE_GLOB 1 // use "glob", for csh
6591#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6592#define STYLE_PRINT 3 // use "print -N", for zsh
6593#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6594 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 int shell_style = STYLE_ECHO;
6596 int check_spaces;
6597 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006598 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006599 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006600 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601
Bram Moolenaar0f873732019-12-05 20:28:46 +01006602 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 *file = NULL;
6604
6605 /*
6606 * If there are no wildcards, just copy the names to allocated memory.
6607 * Saves a lot of time, because we don't have to start a new shell.
6608 */
6609 if (!have_wildcard(num_pat, pat))
6610 return save_patterns(num_pat, pat, num_file, file);
6611
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006612# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006613 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006614 if (sandbox != 0 && check_secure())
6615 return FAIL;
6616# endif
6617
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 /*
6619 * Don't allow the use of backticks in secure and restricted mode.
6620 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006621 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 for (i = 0; i < num_pat; ++i)
6623 if (vim_strchr(pat[i], '`') != NULL
6624 && (check_restricted() || check_secure()))
6625 return FAIL;
6626
6627 /*
6628 * get a name for the temp file
6629 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006630 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006632 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 return FAIL;
6634 }
6635
6636 /*
6637 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006638 * file.
6639 * STYLE_BT: NL separated
6640 * If expanding `cmd` execute it directly.
6641 * STYLE_GLOB: NUL separated
6642 * If we use *csh, "glob" will work better than "echo".
6643 * STYLE_PRINT: NL or NUL separated
6644 * If we use *zsh, "print -N" will work better than "glob".
6645 * STYLE_VIMGLOB: NL separated
6646 * If we use *sh*, we define "vimglob()".
6647 * STYLE_ECHO: space separated.
6648 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 */
6650 if (num_pat == 1 && *pat[0] == '`'
6651 && (len = STRLEN(pat[0])) > 2
6652 && *(pat[0] + len - 1) == '`')
6653 shell_style = STYLE_BT;
6654 else if ((len = STRLEN(p_sh)) >= 3)
6655 {
6656 if (STRCMP(p_sh + len - 3, "csh") == 0)
6657 shell_style = STYLE_GLOB;
6658 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6659 shell_style = STYLE_PRINT;
6660 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006661 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6662 "sh") != NULL)
6663 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664
Bram Moolenaar0f873732019-12-05 20:28:46 +01006665 // Compute the length of the command. We need 2 extra bytes: for the
6666 // optional '&' and for the NUL.
6667 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006669 if (shell_style == STYLE_VIMGLOB)
6670 len += STRLEN(sh_vimglob_func);
6671
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006672 for (i = 0; i < num_pat; ++i)
6673 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006674 // Count the length of the patterns in the same way as they are put in
6675 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006676#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006677 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006678#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006679 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006680 for (j = 0; pat[i][j] != NUL; ++j)
6681 {
6682 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006683 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006684 ++len;
6685 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006686#endif
6687 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 command = alloc(len);
6689 if (command == NULL)
6690 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006691 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 vim_free(tempname);
6693 return FAIL;
6694 }
6695
6696 /*
6697 * Build the shell command:
6698 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6699 * recognizes this).
6700 * - Add the shell command to print the expanded names.
6701 * - Add the temp file name.
6702 * - Add the file name patterns.
6703 */
6704 if (shell_style == STYLE_BT)
6705 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006706 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006707 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006708 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006710 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006711 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006713 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006715 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 *p = ' ';
6717 }
6718 STRCAT(command, ">");
6719 }
6720 else
6721 {
Christian Brabandt8b8d8292021-11-19 12:37:36 +00006722 STRCPY(command, "");
6723 if (shell_style == STYLE_GLOB)
6724 {
6725 // Assume the nonomatch option is valid only for csh like shells,
6726 // otherwise, this may set the positional parameters for the shell,
6727 // e.g. "$*".
6728 if (flags & EW_NOTFOUND)
6729 STRCAT(command, "set nonomatch; ");
6730 else
6731 STRCAT(command, "unset nonomatch; ");
6732 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 if (shell_style == STYLE_GLOB)
6734 STRCAT(command, "glob >");
6735 else if (shell_style == STYLE_PRINT)
6736 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006737 else if (shell_style == STYLE_VIMGLOB)
6738 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 else
6740 STRCAT(command, "echo >");
6741 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006742
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006744
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 if (shell_style != STYLE_BT)
6746 for (i = 0; i < num_pat; ++i)
6747 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006748 // When using system() always add extra quotes, because the shell
6749 // is started twice. Otherwise put a backslash before special
6750 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751#ifdef USE_SYSTEM
6752 STRCAT(command, " \"");
6753 STRCAT(command, pat[i]);
6754 STRCAT(command, "\"");
6755#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006756 int intick = FALSE;
6757
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 p = command + STRLEN(command);
6759 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006760 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006761 {
6762 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006763 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006764 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6765 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006766 // Remove a backslash, take char literally. But keep
6767 // backslash inside backticks, before a special character
6768 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006769 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006770 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6771 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006772 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006773 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006774 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006775 else if (!intick
6776 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6777 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006778 // Put a backslash before a special character, but not
6779 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6780 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006781 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006782
Bram Moolenaar0f873732019-12-05 20:28:46 +01006783 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006784 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006785 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 *p = NUL;
6787#endif
6788 }
6789 if (flags & EW_SILENT)
6790 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006791 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006792 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793
6794 /*
6795 * Using zsh -G: If a pattern has no matches, it is just deleted from
6796 * the argument list, otherwise zsh gives an error message and doesn't
6797 * expand any other pattern.
6798 */
6799 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006800 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801
6802 /*
6803 * If we use -f then shell variables set in .cshrc won't get expanded.
6804 * vi can do it, so we will too, but it is only necessary if there is a "$"
6805 * in one of the patterns, otherwise we can still use the fast option.
6806 */
6807 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006808 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809
6810 /*
6811 * execute the shell command
6812 */
6813 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6814
Bram Moolenaar0f873732019-12-05 20:28:46 +01006815 // When running in the background, give it some time to create the temp
6816 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006817 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02006818 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819
Bram Moolenaar0f873732019-12-05 20:28:46 +01006820 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 show_shell_mess = TRUE;
6822 vim_free(command);
6823
Bram Moolenaar0f873732019-12-05 20:28:46 +01006824 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 {
6826 mch_remove(tempname);
6827 vim_free(tempname);
6828 /*
6829 * With interactive completion, the error message is not printed.
6830 * However with USE_SYSTEM, I don't know how to turn off error messages
6831 * from the shell, so screen may still get messed up -- webb.
6832 */
6833#ifndef USE_SYSTEM
6834 if (!(flags & EW_SILENT))
6835#endif
6836 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006837 redraw_later_clear(); // probably messed up screen
6838 msg_putchar('\n'); // clear bottom line quickly
6839 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840#ifdef USE_SYSTEM
6841 if (!(flags & EW_SILENT))
6842#endif
6843 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006844 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006845 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 }
6847 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006848 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6849 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 if (shell_style == STYLE_BT)
6851 return FAIL;
6852 goto notfound;
6853 }
6854
6855 /*
6856 * read the names from the file into memory
6857 */
6858 fd = fopen((char *)tempname, READBIN);
6859 if (fd == NULL)
6860 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006861 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 if (!(flags & EW_SILENT))
6863 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006864 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006865 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 }
6867 vim_free(tempname);
6868 goto notfound;
6869 }
6870 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006871 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006873 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006874 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006875 buffer = NULL;
6876 else
6877 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 if (buffer == NULL)
6879 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006880 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 mch_remove(tempname);
6882 vim_free(tempname);
6883 fclose(fd);
6884 return FAIL;
6885 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006886 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 i = fread((char *)buffer, 1, len, fd);
6888 fclose(fd);
6889 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006890 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006892 // unexpected read error
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006893 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 vim_free(tempname);
6895 vim_free(buffer);
6896 return FAIL;
6897 }
6898 vim_free(tempname);
6899
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006900# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006901 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006903 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6905 *p++ = buffer[i];
6906 len = p - buffer;
6907# endif
6908
6909
Bram Moolenaar0f873732019-12-05 20:28:46 +01006910 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 if (shell_style == STYLE_ECHO)
6912 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006913 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006915 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 {
6917 while (*p != ' ' && *p != '\n')
6918 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006919 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 }
6921 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006922 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006923 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006925 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006927 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 {
6929 while (*p != '\n' && *p != NUL)
6930 ++p;
6931 if (*p != NUL)
6932 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006933 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 }
6935 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006936 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 else
6938 {
6939 /*
6940 * Some versions of zsh use spaces instead of NULs to separate
6941 * results. Only do this when there is no NUL before the end of the
6942 * buffer, otherwise we would never be able to use file names with
6943 * embedded spaces when zsh does use NULs.
6944 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6945 * don't check for spaces again.
6946 */
6947 check_spaces = FALSE;
6948 if (shell_style == STYLE_PRINT && !did_find_nul)
6949 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006950 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006951 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006952 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 did_find_nul = TRUE;
6954 else
6955 check_spaces = TRUE;
6956 }
6957
6958 /*
6959 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6960 * already is one, for STYLE_GLOB it needs to be added.
6961 */
6962 if (len && buffer[len - 1] == NUL)
6963 --len;
6964 else
6965 buffer[len] = NUL;
6966 i = 0;
6967 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006968 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 {
6970 ++i;
6971 *p = NUL;
6972 }
6973 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006974 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 }
6976 if (i == 0)
6977 {
6978 /*
6979 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6980 * /bin/sh will happily expand it to nothing rather than returning an
6981 * error; and hey, it's good to check anyway -- webb.
6982 */
6983 vim_free(buffer);
6984 goto notfound;
6985 }
6986 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006987 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 if (*file == NULL)
6989 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006990 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 vim_free(buffer);
6992 return FAIL;
6993 }
6994
6995 /*
6996 * Isolate the individual file names.
6997 */
6998 p = buffer;
6999 for (i = 0; i < *num_file; ++i)
7000 {
7001 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007002 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00007003 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
7004 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00007006 while (!(shell_style == STYLE_ECHO && *p == ' ')
7007 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007009 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 *p = NUL;
7011 else
7012 {
7013 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007014 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 }
7016 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007017 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007019 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007021 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 }
7023 }
7024
7025 /*
7026 * Move the file names to allocated memory.
7027 */
7028 for (j = 0, i = 0; i < *num_file; ++i)
7029 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007030 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
7032 continue;
7033
Bram Moolenaar0f873732019-12-05 20:28:46 +01007034 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 dir = (mch_isdir((*file)[i]));
7036 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
7037 continue;
7038
Bram Moolenaar0f873732019-12-05 20:28:46 +01007039 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01007040 if (!dir && (flags & EW_EXEC)
7041 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00007042 continue;
7043
Bram Moolenaar964b3742019-05-24 18:54:09 +02007044 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 if (p)
7046 {
7047 STRCPY(p, (*file)[i]);
7048 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007049 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 (*file)[j++] = p;
7051 }
7052 }
7053 vim_free(buffer);
7054 *num_file = j;
7055
Bram Moolenaar0f873732019-12-05 20:28:46 +01007056 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01007058 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 goto notfound;
7060 }
7061
7062 return OK;
7063
7064notfound:
7065 if (flags & EW_NOTFOUND)
7066 return save_patterns(num_pat, pat, num_file, file);
7067 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068}
7069
Bram Moolenaar0f873732019-12-05 20:28:46 +01007070#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007073save_patterns(
7074 int num_pat,
7075 char_u **pat,
7076 int *num_file,
7077 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078{
7079 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00007080 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007082 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 if (*file == NULL)
7084 return FAIL;
7085 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00007086 {
7087 s = vim_strsave(pat[i]);
7088 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007089 // Be compatible with expand_filename(): halve the number of
7090 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007091 backslash_halve(s);
7092 (*file)[i] = s;
7093 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 *num_file = num_pat;
7095 return OK;
7096}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098/*
7099 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7100 * expand.
7101 */
7102 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007103mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007105 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 if (*p == '\\' && p[1] != NUL)
7108 ++p;
7109 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 if (vim_strchr((char_u *)
7111#ifdef VMS
7112 "*?%"
7113#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115#endif
7116 , *p) != NULL)
7117 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 }
7119 return FALSE;
7120}
7121
7122/*
7123 * Return TRUE if the string "p" contains a wildcard.
7124 * Don't recognize '~' at the end as a wildcard.
7125 */
7126 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007127mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007129 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 if (*p == '\\' && p[1] != NUL)
7132 ++p;
7133 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 if (vim_strchr((char_u *)
7135#ifdef VMS
7136 "*?%$"
7137#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139#endif
7140 , *p) != NULL
7141 || (*p == '~' && p[1] != NUL))
7142 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 }
7144 return FALSE;
7145}
7146
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007148have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149{
7150 int i;
7151
7152 for (i = 0; i < num; i++)
7153 if (mch_has_wildcard(file[i]))
7154 return 1;
7155 return 0;
7156}
7157
7158 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007159have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160{
7161 int i;
7162
7163 for (i = 0; i < num; i++)
7164 if (vim_strchr(file[i], '$') != NULL)
7165 return TRUE;
7166 return FALSE;
7167}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007169#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170/*
7171 * Scaled-down version of rename(), which is missing in Xenix.
7172 * This version can only move regular files and will fail if the
7173 * destination exists.
7174 */
7175 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007176mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177{
7178 struct stat st;
7179
Bram Moolenaar0f873732019-12-05 20:28:46 +01007180 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007182 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007184 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 return 0;
7186 return -1;
7187}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007188#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007190#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007191# if defined(DYNAMIC_GPM) || defined(PROTO)
7192/*
7193 * Initialize Gpm's symbols for dynamic linking.
7194 * Must be called only if libgpm_hinst is NULL.
7195 */
7196 static int
7197load_libgpm(void)
7198{
7199 libgpm_hinst = dlopen("libgpm.so", RTLD_LAZY|RTLD_GLOBAL);
7200
7201 if (libgpm_hinst == NULL)
7202 {
7203 if (p_verbose > 0)
7204 smsg_attr(HL_ATTR(HLF_W),
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007205 _("Could not load gpm library: %s"), dlerror());
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007206 return FAIL;
7207 }
7208
7209 if (
7210 (dll_Gpm_Open = dlsym(libgpm_hinst, "Gpm_Open")) == NULL
7211 || (dll_Gpm_Close = dlsym(libgpm_hinst, "Gpm_Close")) == NULL
7212 || (dll_Gpm_GetEvent = dlsym(libgpm_hinst, "Gpm_GetEvent")) == NULL
7213 || (dll_gpm_flag = dlsym(libgpm_hinst, "gpm_flag")) == NULL
7214 || (dll_gpm_fd = dlsym(libgpm_hinst, "gpm_fd")) == NULL
7215 )
7216 {
7217 semsg(_(e_could_not_load_library_str_str), "gpm", dlerror());
7218 dlclose(libgpm_hinst);
7219 libgpm_hinst = NULL;
7220 dll_gpm_flag = NULL;
7221 dll_gpm_fd = NULL;
7222 return FAIL;
7223 }
7224 return OK;
7225}
7226
7227 int
7228gpm_available(void)
7229{
7230 return libgpm_hinst != NULL || load_libgpm() == OK;
7231}
7232# endif // DYNAMIC_GPM
7233
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234/*
7235 * Initializes connection with gpm (if it isn't already opened)
7236 * Return 1 if succeeded (or connection already opened), 0 if failed
7237 */
7238 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007239gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007241 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007243#ifdef DYNAMIC_GPM
7244 if (!gpm_available())
7245 return 0;
7246#endif
7247
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 if (!gpm_flag)
7249 {
7250 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7251 gpm_connect.defaultMask = ~GPM_HARD;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007252 // Default handling for mouse move
7253 gpm_connect.minMod = 0; // Handle any modifier keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 gpm_connect.maxMod = 0xffff;
7255 if (Gpm_Open(&gpm_connect, 0) > 0)
7256 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007257 // gpm library tries to handling TSTP causes
7258 // problems. Anyways, we close connection to Gpm whenever
7259 // we are going to suspend or starting an external process
7260 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007261# ifdef SIGTSTP
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007262 signal(SIGTSTP, restricted ? SIG_IGN : (void (*)())sig_tstp);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007263# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007264 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 }
7266 if (gpm_fd == -2)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007267 Gpm_Close(); // We don't want to talk to xterm via gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 return 0;
7269 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007270 return 1; // already open
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271}
7272
7273/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007274 * Returns TRUE if the GPM mouse is enabled.
7275 */
7276 int
7277gpm_enabled(void)
7278{
7279 return gpm_flag && gpm_fd >= 0;
7280}
7281
7282/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 */
7285 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007286gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007288 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 Gpm_Close();
7290}
7291
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007292/*
7293 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007295 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 */
7297 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007298mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299{
7300 int button;
7301 static Gpm_Event gpm_event;
7302 char_u string[6];
7303 int_u vim_modifiers;
7304 int row,col;
7305 unsigned char buttons_mask;
7306 unsigned char gpm_modifiers;
7307 static unsigned char old_buttons = 0;
7308
7309 Gpm_GetEvent(&gpm_event);
7310
7311#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007312 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 if (hold_gui_events)
7314 return 0;
7315#endif
7316
7317 row = gpm_event.y - 1;
7318 col = gpm_event.x - 1;
7319
Bram Moolenaar0f873732019-12-05 20:28:46 +01007320 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 string[1] = 'M';
7322 string[2] = 'G';
7323 switch (GPM_BARE_EVENTS(gpm_event.type))
7324 {
7325 case GPM_DRAG:
7326 string[3] = MOUSE_DRAG;
7327 break;
7328 case GPM_DOWN:
7329 buttons_mask = gpm_event.buttons & ~old_buttons;
7330 old_buttons = gpm_event.buttons;
7331 switch (buttons_mask)
7332 {
7333 case GPM_B_LEFT:
7334 button = MOUSE_LEFT;
7335 break;
7336 case GPM_B_MIDDLE:
7337 button = MOUSE_MIDDLE;
7338 break;
7339 case GPM_B_RIGHT:
7340 button = MOUSE_RIGHT;
7341 break;
7342 default:
7343 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007344 // Don't know what to do. Can more than one button be
7345 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 }
7347 string[3] = (char_u)(button | 0x20);
7348 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7349 break;
7350 case GPM_UP:
7351 string[3] = MOUSE_RELEASE;
7352 old_buttons &= ~gpm_event.buttons;
7353 break;
7354 default:
7355 return 0;
7356 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007357 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 gpm_modifiers = gpm_event.modifiers;
7359 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007360 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7361 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7362 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7364 vim_modifiers |= MOUSE_SHIFT;
7365
7366 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7367 vim_modifiers |= MOUSE_CTRL;
7368 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7369 vim_modifiers |= MOUSE_ALT;
7370 string[3] |= vim_modifiers;
7371 string[4] = (char_u)(col + ' ' + 1);
7372 string[5] = (char_u)(row + ' ' + 1);
7373 add_to_input_buf(string, 6);
7374 return 6;
7375}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007376#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007378#ifdef FEAT_SYSMOUSE
7379/*
7380 * Initialize connection with sysmouse.
7381 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7382 * output, any sysmouse output than will be processed via sig_sysmouse().
7383 * Return OK if succeeded, FAIL if failed.
7384 */
7385 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007386sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007387{
7388 struct mouse_info mouse;
7389
7390 mouse.operation = MOUSE_MODE;
7391 mouse.u.mode.mode = 0;
7392 mouse.u.mode.signal = SIGUSR2;
7393 if (ioctl(1, CONS_MOUSECTL, &mouse) != -1)
7394 {
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007395 signal(SIGUSR2, (void (*)())sig_sysmouse);
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007396 mouse.operation = MOUSE_SHOW;
7397 ioctl(1, CONS_MOUSECTL, &mouse);
7398 return OK;
7399 }
7400 return FAIL;
7401}
7402
7403/*
7404 * Stop processing SIGUSR2 signals, and also make sure that
7405 * virtual console do not send us any sysmouse related signal.
7406 */
7407 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007408sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007409{
7410 struct mouse_info mouse;
7411
7412 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7413 mouse.operation = MOUSE_MODE;
7414 mouse.u.mode.mode = 0;
7415 mouse.u.mode.signal = 0;
7416 ioctl(1, CONS_MOUSECTL, &mouse);
7417}
7418
7419/*
7420 * Gets info from sysmouse and adds special keys to input buf.
7421 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007422 static void
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007423sig_sysmouse SIGDEFARG(sigarg)
7424{
7425 struct mouse_info mouse;
7426 struct video_info video;
7427 char_u string[6];
7428 int row, col;
7429 int button;
7430 int buttons;
7431 static int oldbuttons = 0;
7432
7433#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007434 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007435 if (hold_gui_events)
7436 return;
7437#endif
7438
7439 mouse.operation = MOUSE_GETINFO;
7440 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7441 && ioctl(1, FBIO_MODEINFO, &video) != -1
7442 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7443 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7444 {
7445 row = mouse.u.data.y / video.vi_cheight;
7446 col = mouse.u.data.x / video.vi_cwidth;
7447 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007448 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007449 string[1] = 'M';
7450 string[2] = 'S';
7451 if (oldbuttons == buttons && buttons != 0)
7452 {
7453 button = MOUSE_DRAG;
7454 }
7455 else
7456 {
7457 switch (buttons)
7458 {
7459 case 0:
7460 button = MOUSE_RELEASE;
7461 break;
7462 case 1:
7463 button = MOUSE_LEFT;
7464 break;
7465 case 2:
7466 button = MOUSE_MIDDLE;
7467 break;
7468 case 4:
7469 button = MOUSE_RIGHT;
7470 break;
7471 default:
7472 return;
7473 }
7474 oldbuttons = buttons;
7475 }
7476 string[3] = (char_u)(button);
7477 string[4] = (char_u)(col + ' ' + 1);
7478 string[5] = (char_u)(row + ' ' + 1);
7479 add_to_input_buf(string, 6);
7480 }
7481 return;
7482}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007483#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007486typedef char_u * (*STRPROCSTR)(char_u *);
7487typedef char_u * (*INTPROCSTR)(int);
7488typedef int (*STRPROCINT)(char_u *);
7489typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490
7491/*
7492 * Call a DLL routine which takes either a string or int param
7493 * and returns an allocated string.
7494 */
7495 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007496mch_libcall(
7497 char_u *libname,
7498 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007499 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007500 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007501 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007502 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503{
7504# if defined(USE_DLOPEN)
7505 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007506 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507# else
7508 shl_t hinstLib;
7509# endif
7510 STRPROCSTR ProcAdd;
7511 INTPROCSTR ProcAddI;
7512 char_u *retval_str = NULL;
7513 int retval_int = 0;
7514 int success = FALSE;
7515
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007516 /*
7517 * Get a handle to the DLL module.
7518 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007520 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007521 (void)dlerror();
7522
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 hinstLib = dlopen((char *)libname, RTLD_LAZY
7524# ifdef RTLD_LOCAL
7525 | RTLD_LOCAL
7526# endif
7527 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007528 if (hinstLib == NULL)
7529 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007530 // "dlerr" must be used before dlclose()
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007531 dlerr = dlerror();
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007532 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007533 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007534 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535# else
7536 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7537# endif
7538
Bram Moolenaar0f873732019-12-05 20:28:46 +01007539 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 if (hinstLib != NULL)
7541 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007542# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 /*
7544 * Catch a crash when calling the library function. For example when
7545 * using a number where a string pointer is expected.
7546 */
7547 mch_startjmp();
7548 if (SETJMP(lc_jump_env) != 0)
7549 {
7550 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007551# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007552 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007553# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 mch_didjmp();
7555 }
7556 else
7557# endif
7558 {
7559 retval_str = NULL;
7560 retval_int = 0;
7561
7562 if (argstring != NULL)
7563 {
7564# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007565 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007566 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567# else
7568 if (shl_findsym(&hinstLib, (const char *)funcname,
7569 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7570 ProcAdd = NULL;
7571# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007572 if ((success = (ProcAdd != NULL
7573# if defined(USE_DLOPEN)
7574 && dlerr == NULL
7575# endif
7576 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 {
7578 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007579 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 else
7581 retval_str = (ProcAdd)(argstring);
7582 }
7583 }
7584 else
7585 {
7586# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007587 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007588 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589# else
7590 if (shl_findsym(&hinstLib, (const char *)funcname,
7591 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7592 ProcAddI = NULL;
7593# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007594 if ((success = (ProcAddI != NULL
7595# if defined(USE_DLOPEN)
7596 && dlerr == NULL
7597# endif
7598 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 {
7600 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007601 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 else
7603 retval_str = (ProcAddI)(argint);
7604 }
7605 }
7606
Bram Moolenaar0f873732019-12-05 20:28:46 +01007607 // Save the string before we free the library.
7608 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 if (string_result == NULL)
7610 *number_result = retval_int;
7611 else if (retval_str != NULL
7612 && retval_str != (char_u *)1
7613 && retval_str != (char_u *)-1)
7614 *string_result = vim_strsave(retval_str);
7615 }
7616
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007617# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 mch_endjmp();
7619# ifdef SIGHASARG
7620 if (lc_signal != 0)
7621 {
7622 int i;
7623
Bram Moolenaar0f873732019-12-05 20:28:46 +01007624 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 for (i = 0; signal_info[i].sig != -1; i++)
7626 if (lc_signal == signal_info[i].sig)
7627 break;
Bram Moolenaarac78dd42022-01-02 19:25:26 +00007628 semsg(e_got_sig_str_in_libcall, signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 }
7630# endif
7631# endif
7632
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007634 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007635 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007636 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007637
Bram Moolenaar0f873732019-12-05 20:28:46 +01007638 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 (void)dlclose(hinstLib);
7640# else
7641 (void)shl_unload(hinstLib);
7642# endif
7643 }
7644
7645 if (!success)
7646 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007647 semsg(_(e_library_call_failed_for_str), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 return FAIL;
7649 }
7650
7651 return OK;
7652}
7653#endif
7654
7655#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007656static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657static int xterm_button;
7658
7659/*
7660 * Setup a dummy window for X selections in a terminal.
7661 */
7662 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007663setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664{
7665 int z = 0;
7666 char *strp = "";
7667 Widget AppShell;
7668
7669 if (!x_connect_to_server())
7670 return;
7671
7672 open_app_context();
7673 if (app_context != NULL && xterm_Shell == (Widget)0)
7674 {
7675 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007676# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007678# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007679# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007680 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681
7682 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007683 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684# endif
7685
Bram Moolenaar0f873732019-12-05 20:28:46 +01007686 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 oldhandler = XSetErrorHandler(x_error_check);
7688
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007689# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007690 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7692 mch_startjmp();
7693 if (SETJMP(lc_jump_env) != 0)
7694 {
7695 mch_didjmp();
7696 xterm_dpy = NULL;
7697 }
7698 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007699# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 {
7701 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7702 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007703 if (xterm_dpy != NULL)
7704 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007705# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007707# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 }
7709
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007710# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007711 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007713# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007714 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 (void)XSetErrorHandler(oldhandler);
7716
7717 if (xterm_dpy == NULL)
7718 {
7719 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007720 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 return;
7722 }
7723
Bram Moolenaar0f873732019-12-05 20:28:46 +01007724 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 (void)XSetIOErrorHandler(x_IOerror_handler);
7726
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007727# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007729 {
7730 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007731 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007732 verbose_leave();
7733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734# endif
7735
Bram Moolenaar0f873732019-12-05 20:28:46 +01007736 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7738 applicationShellWidgetClass, xterm_dpy,
7739 NULL);
7740 if (AppShell == (Widget)0)
7741 return;
7742 xterm_Shell = XtVaCreatePopupShell("VIM",
7743 topLevelShellWidgetClass, AppShell,
7744 XtNmappedWhenManaged, 0,
7745 XtNwidth, 1,
7746 XtNheight, 1,
7747 NULL);
7748 if (xterm_Shell == (Widget)0)
7749 return;
7750
7751 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007752 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 if (x11_display == NULL)
7754 x11_display = xterm_dpy;
7755
7756 XtRealizeWidget(xterm_Shell);
7757 XSync(xterm_dpy, False);
7758 xterm_update();
7759 }
7760 if (xterm_Shell != (Widget)0)
7761 {
7762 clip_init(TRUE);
7763 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7764 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007765 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 if (test_x11_window(xterm_dpy) == FAIL)
7767 x11_window = 0;
7768 if (x11_window != 0)
7769 xterm_trace = 0;
7770 }
7771}
7772
7773 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007774start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775{
7776 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7777 return;
7778 xterm_trace = 1;
7779 xterm_button = button;
7780 do_xterm_trace();
7781}
7782
7783
7784 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007785stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786{
7787 if (xterm_trace < 0)
7788 return;
7789 xterm_trace = 0;
7790}
7791
7792/*
7793 * Query the xterm pointer and generate mouse termcodes if necessary
7794 * return TRUE if dragging is active, else FALSE
7795 */
7796 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007797do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798{
7799 Window root, child;
7800 int root_x, root_y;
7801 int win_x, win_y;
7802 int row, col;
7803 int_u mask_return;
7804 char_u buf[50];
7805 char_u *strp;
7806 long got_hints;
7807 static char_u *mouse_code;
7808 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7809 static int prev_row = 0, prev_col = 0;
7810 static XSizeHints xterm_hints;
7811
7812 if (xterm_trace <= 0)
7813 return FALSE;
7814
7815 if (xterm_trace == 1)
7816 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007817 // Get the hints just before tracking starts. The font size might
7818 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007819 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7820 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 || xterm_hints.width_inc <= 1
7822 || xterm_hints.height_inc <= 1)
7823 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007824 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 return FALSE;
7826 }
7827
Bram Moolenaar0f873732019-12-05 20:28:46 +01007828 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 mouse_code = find_termcode(mouse_name);
7830 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007831 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832 xterm_trace = 2;
7833
Bram Moolenaar0f873732019-12-05 20:28:46 +01007834 // Find the offset of the chars, there might be a scrollbar on the
7835 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7837 &win_x, &win_y, &mask_return);
7838 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7839 - (xterm_hints.height_inc / 2);
7840 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7841 xterm_hints.y = 2;
7842 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7843 - (xterm_hints.width_inc / 2);
7844 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7845 xterm_hints.x = 2;
7846 return TRUE;
7847 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007848 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 {
7850 xterm_trace = 0;
7851 return FALSE;
7852 }
7853
7854 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7855 &win_x, &win_y, &mask_return);
7856
7857 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7858 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7859 if (row == prev_row && col == prev_col)
7860 return TRUE;
7861
7862 STRCPY(buf, mouse_code);
7863 strp = buf + STRLEN(buf);
7864 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7865 *strp++ = (char_u)(col + ' ' + 1);
7866 *strp++ = (char_u)(row + ' ' + 1);
7867 *strp = 0;
7868 add_to_input_buf(buf, STRLEN(buf));
7869
7870 prev_row = row;
7871 prev_col = col;
7872 return TRUE;
7873}
7874
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007875# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876/*
7877 * Destroy the display, window and app_context. Required for GTK.
7878 */
7879 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007880clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881{
7882 if (xterm_Shell != (Widget)0)
7883 {
7884 XtDestroyWidget(xterm_Shell);
7885 xterm_Shell = (Widget)0;
7886 }
7887 if (xterm_dpy != NULL)
7888 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007889# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007890 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007892# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 if (x11_display == xterm_dpy)
7894 x11_display = NULL;
7895 xterm_dpy = NULL;
7896 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007897# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 if (app_context != (XtAppContext)NULL)
7899 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007900 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 XtDestroyApplicationContext(app_context);
7902 app_context = (XtAppContext)NULL;
7903 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007904# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905}
7906# endif
7907
7908/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007909 * Catch up with GUI or X events.
7910 */
7911 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007912clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007913{
7914# ifdef FEAT_GUI
7915 if (gui.in_use)
7916 gui_mch_update();
7917 else
7918# endif
7919 if (xterm_Shell != (Widget)0)
7920 xterm_update();
7921}
7922
7923/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 * Catch up with any queued X events. This may put keyboard input into the
7925 * input buffer, call resize call-backs, trigger timers etc. If there is
7926 * nothing in the X event queue (& no timers pending), then we return
7927 * immediately.
7928 */
7929 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007930xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931{
7932 XEvent event;
7933
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007934 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007936 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007938 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007939 break;
7940
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007941 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007942 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007943 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007944 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007945#ifdef FEAT_CLIENTSERVER
7946 {
7947 XPropertyEvent *e = (XPropertyEvent *)&event;
7948
7949 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007951 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007952 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007954 XtDispatchEvent(&event);
7955 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007956 else
7957 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007958 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007959 XtAppProcessEvent(app_context, mask);
7960 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 }
7962}
7963
7964 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007965clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966{
7967 if (xterm_Shell != (Widget)0)
7968 return clip_x11_own_selection(xterm_Shell, cbd);
7969 return FAIL;
7970}
7971
7972 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007973clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974{
7975 if (xterm_Shell != (Widget)0)
7976 clip_x11_lose_selection(xterm_Shell, cbd);
7977}
7978
7979 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007980clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981{
7982 if (xterm_Shell != (Widget)0)
7983 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7984}
7985
7986 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007987clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988{
7989 clip_x11_set_selection(cbd);
7990}
7991#endif
7992
7993
7994#if defined(USE_XSMP) || defined(PROTO)
7995/*
7996 * Code for X Session Management Protocol.
7997 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998
7999# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000/*
8001 * This is our chance to ask the user if they want to save,
8002 * or abort the logout
8003 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008005xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006{
Bram Moolenaare1004402020-10-24 20:49:43 +02008007 int save_cmod_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 int cancel_shutdown = False;
8009
Bram Moolenaare1004402020-10-24 20:49:43 +02008010 save_cmod_flags = cmdmod.cmod_flags;
8011 cmdmod.cmod_flags |= CMOD_CONFIRM;
Bram Moolenaar027387f2016-01-02 22:25:52 +01008012 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01008013 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 cancel_shutdown = True;
Bram Moolenaare1004402020-10-24 20:49:43 +02008015 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar0f873732019-12-05 20:28:46 +01008016 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 out_flush();
8018
Bram Moolenaar0f873732019-12-05 20:28:46 +01008019 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 SmcInteractDone(smc_conn, cancel_shutdown);
8021
Bram Moolenaar0f873732019-12-05 20:28:46 +01008022 // Finish off
8023 // Only end save-yourself here if we're not cancelling shutdown;
8024 // we'll get a cancelled callback later in which we'll end it.
8025 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 if (!cancel_shutdown)
8027 {
8028 xsmp.save_yourself = False;
8029 SmcSaveYourselfDone(smc_conn, True);
8030 }
8031}
8032# endif
8033
8034/*
8035 * Callback that starts save-yourself.
8036 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008038xsmp_handle_save_yourself(
8039 SmcConn smc_conn,
8040 SmPointer client_data UNUSED,
8041 int save_type UNUSED,
8042 Bool shutdown,
8043 int interact_style UNUSED,
8044 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008046 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 if (xsmp.save_yourself)
8048 SmcSaveYourselfDone(smc_conn, True);
8049 xsmp.save_yourself = True;
8050 xsmp.shutdown = shutdown;
8051
Bram Moolenaar0f873732019-12-05 20:28:46 +01008052 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01008054 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055
8056 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008057 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058
8059# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008060 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008062 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 SmcInteractRequest(smc_conn, SmDialogError,
8064 xsmp_handle_interaction, client_data);
8065 else
8066# endif
8067 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008068 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 SmcSaveYourselfDone(smc_conn, True);
8070 xsmp.save_yourself = False;
8071 }
8072}
8073
8074
8075/*
8076 * Callback to warn us of imminent death.
8077 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008079xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080{
8081 xsmp_close();
8082
Bram Moolenaar0f873732019-12-05 20:28:46 +01008083 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 getout_preserve_modified(0);
8085}
8086
8087
8088/*
8089 * Callback to tell us that save-yourself has completed.
8090 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008092xsmp_save_complete(
8093 SmcConn smc_conn UNUSED,
8094 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095{
8096 xsmp.save_yourself = False;
8097}
8098
8099
8100/*
8101 * Callback to tell us that an instigated shutdown was cancelled
8102 * (maybe even by us)
8103 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008105xsmp_shutdown_cancelled(
8106 SmcConn smc_conn,
8107 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108{
8109 if (xsmp.save_yourself)
8110 SmcSaveYourselfDone(smc_conn, True);
8111 xsmp.save_yourself = False;
8112 xsmp.shutdown = False;
8113}
8114
8115
8116/*
8117 * Callback to tell us that a new ICE connection has been established.
8118 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008120xsmp_ice_connection(
8121 IceConn iceConn,
8122 IcePointer clientData UNUSED,
8123 Bool opening,
8124 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008126 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 if (opening)
8128 {
8129 xsmp_icefd = IceConnectionNumber(iceConn);
8130 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
8131 }
8132}
8133
8134
Bram Moolenaar0f873732019-12-05 20:28:46 +01008135// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136 int
Bram Moolenaar05540972016-01-30 20:31:25 +01008137xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138{
8139 Bool rep;
8140
8141 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8142 == IceProcessMessagesIOError)
8143 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008144 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008146 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 xsmp_close();
8148 return FAIL;
8149 }
8150 else
8151 return OK;
8152}
8153
8154static int dummy;
8155
Bram Moolenaar0f873732019-12-05 20:28:46 +01008156// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 void
8158xsmp_init(void)
8159{
8160 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 SmcCallbacks smcallbacks;
8162#if 0
8163 SmPropValue smname;
8164 SmProp smnameprop;
8165 SmProp *smprops[1];
8166#endif
8167
8168 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008169 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170
8171 xsmp.save_yourself = xsmp.shutdown = False;
8172
Bram Moolenaar0f873732019-12-05 20:28:46 +01008173 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8175 smcallbacks.save_yourself.client_data = NULL;
8176 smcallbacks.die.callback = xsmp_die;
8177 smcallbacks.die.client_data = NULL;
8178 smcallbacks.save_complete.callback = xsmp_save_complete;
8179 smcallbacks.save_complete.client_data = NULL;
8180 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8181 smcallbacks.shutdown_cancelled.client_data = NULL;
8182
Bram Moolenaar0f873732019-12-05 20:28:46 +01008183 // Set up a watch on ICE connection creations. The "dummy" argument is
8184 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8186 {
8187 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008188 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 return;
8190 }
8191
Bram Moolenaar0f873732019-12-05 20:28:46 +01008192 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 xsmp.smcconn = SmcOpenConnection(
8194 NULL,
8195 NULL,
8196 SmProtoMajor,
8197 SmProtoMinor,
8198 SmcSaveYourselfProcMask | SmcDieProcMask
8199 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8200 &smcallbacks,
8201 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008202 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008203 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 errorstring);
8205 if (xsmp.smcconn == NULL)
8206 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008208 {
Bram Moolenaare1be1182020-10-24 13:30:51 +02008209 char errorreport[132];
8210
8211 // If the message is too long it might not be NUL terminated. Add
8212 // a NUL at the end to make sure we don't go over the end.
8213 errorstring[sizeof(errorstring) - 1] = NUL;
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008214 vim_snprintf(errorreport, sizeof(errorreport),
8215 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008216 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008217 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008218 return;
8219 }
8220 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8221
8222#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008223 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 smname.value = "vim";
8225 smname.length = 3;
8226 smnameprop.name = "SmProgram";
8227 smnameprop.type = "SmARRAY8";
8228 smnameprop.num_vals = 1;
8229 smnameprop.vals = &smname;
8230
8231 smprops[0] = &smnameprop;
8232 SmcSetProperties(xsmp.smcconn, 1, smprops);
8233#endif
8234}
8235
8236
Bram Moolenaar0f873732019-12-05 20:28:46 +01008237// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008239xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240{
8241 if (xsmp_icefd != -1)
8242 {
8243 SmcCloseConnection(xsmp.smcconn, 0, NULL);
Bram Moolenaar5a221812008-11-12 12:08:45 +00008244 if (xsmp.clientid != NULL)
8245 free(xsmp.clientid);
Bram Moolenaare8208012008-06-20 09:59:25 +00008246 xsmp.clientid = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 xsmp_icefd = -1;
8248 }
8249}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008250#endif // USE_XSMP
Paul Ollis65745772022-06-05 16:55:54 +01008251
8252#if defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008253# if defined(HAVE_TIMER_CREATE) || defined(PROTO)
Paul Ollis65745772022-06-05 16:55:54 +01008254/*
8255 * Implement timeout with timer_create() and timer_settime().
8256 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008257static volatile sig_atomic_t timeout_flag = FALSE;
8258static timer_t timer_id;
8259static int timer_created = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008260
8261/*
8262 * Callback for when the timer expires.
8263 */
8264 static void
8265set_flag(union sigval _unused UNUSED)
8266{
8267 timeout_flag = TRUE;
8268}
8269
8270/*
8271 * Stop any active timeout.
8272 */
8273 void
8274stop_timeout(void)
8275{
8276 static struct itimerspec disarm = {{0, 0}, {0, 0}};
8277
8278 if (timer_created)
8279 {
8280 int ret = timer_settime(timer_id, 0, &disarm, NULL);
8281
8282 if (ret < 0)
8283 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8284 }
8285
8286 // Clear the current timeout flag; any previous timeout should be
8287 // considered _not_ triggered.
8288 timeout_flag = FALSE;
8289}
8290
8291/*
8292 * Start the timeout timer.
8293 *
8294 * The return value is a pointer to a flag that is initialised to FALSE. If the
8295 * timeout expires, the flag is set to TRUE. This will only return pointers to
8296 * static memory; i.e. any pointer returned by this function may always be
8297 * safely dereferenced.
8298 *
8299 * This function is not expected to fail, but if it does it will still return a
8300 * valid flag pointer; the flag will remain stuck as FALSE .
8301 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008302 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008303start_timeout(long msec)
8304{
8305 struct itimerspec interval = {
8306 {0, 0}, // Do not repeat.
8307 {msec / 1000, (msec % 1000) * 1000000}}; // Timeout interval
8308 int ret;
8309
8310 // This is really the caller's responsibility, but let's make sure the
8311 // previous timer has been stopped.
8312 stop_timeout();
Paul Ollis65745772022-06-05 16:55:54 +01008313
8314 if (!timer_created)
8315 {
8316 struct sigevent action = {0};
8317
8318 action.sigev_notify = SIGEV_THREAD;
8319 action.sigev_notify_function = set_flag;
8320 ret = timer_create(CLOCK_MONOTONIC, &action, &timer_id);
8321 if (ret < 0)
8322 {
8323 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8324 return &timeout_flag;
8325 }
8326 timer_created = TRUE;
8327 }
8328
Bram Moolenaar509ce032022-06-20 11:23:01 +01008329# ifdef FEAT_JOB_CHANNEL
Bram Moolenaar616592e2022-06-17 15:17:10 +01008330 ch_log(NULL, "setting timeout timer to %d sec %ld nsec",
8331 (int)interval.it_value.tv_sec, (long)interval.it_value.tv_nsec);
Bram Moolenaar509ce032022-06-20 11:23:01 +01008332# endif
Paul Ollis65745772022-06-05 16:55:54 +01008333 ret = timer_settime(timer_id, 0, &interval, NULL);
8334 if (ret < 0)
8335 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8336
8337 return &timeout_flag;
8338}
8339
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008340/*
8341 * To be used before fork/exec: delete any created timer.
8342 */
8343 void
8344delete_timer(void)
8345{
8346 if (timer_created)
8347 {
8348 timer_delete(timer_id);
8349 timer_created = FALSE;
8350 }
8351}
8352
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008353# else // HAVE_TIMER_CREATE
Paul Ollis65745772022-06-05 16:55:54 +01008354
8355/*
8356 * Implement timeout with setitimer()
8357 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008358static struct sigaction prev_sigaction;
8359static volatile sig_atomic_t timeout_flag = FALSE;
8360static int timer_active = FALSE;
8361static int timer_handler_active = FALSE;
8362static volatile sig_atomic_t alarm_pending = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008363
8364/*
8365 * Handle SIGALRM for a timeout.
8366 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01008367 static void
Paul Ollis65745772022-06-05 16:55:54 +01008368set_flag SIGDEFARG(sigarg)
8369{
8370 if (alarm_pending)
8371 alarm_pending = FALSE;
8372 else
8373 timeout_flag = TRUE;
8374}
8375
8376/*
8377 * Stop any active timeout.
8378 */
8379 void
8380stop_timeout(void)
8381{
8382 static struct itimerval disarm = {{0, 0}, {0, 0}};
8383 int ret;
8384
8385 if (timer_active)
8386 {
8387 timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008388 ret = setitimer(ITIMER_REAL, &disarm, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008389 if (ret < 0)
8390 // Should only get here as a result of coding errors.
8391 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8392 }
8393
8394 if (timer_handler_active)
8395 {
8396 timer_handler_active = FALSE;
8397 ret = sigaction(SIGALRM, &prev_sigaction, NULL);
8398 if (ret < 0)
8399 // Should only get here as a result of coding errors.
8400 semsg(_(e_could_not_reset_handler_for_timeout_str),
8401 strerror(errno));
8402 }
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008403 timeout_flag = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008404}
8405
8406/*
8407 * Start the timeout timer.
8408 *
8409 * The return value is a pointer to a flag that is initialised to FALSE. If the
8410 * timeout expires, the flag is set to TRUE. This will only return pointers to
8411 * static memory; i.e. any pointer returned by this function may always be
8412 * safely dereferenced.
8413 *
8414 * This function is not expected to fail, but if it does it will still return a
8415 * valid flag pointer; the flag will remain stuck as FALSE .
8416 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008417 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008418start_timeout(long msec)
8419{
8420 struct itimerval interval = {
8421 {0, 0}, // Do not repeat.
8422 {msec / 1000, (msec % 1000) * 1000}}; // Timeout interval
8423 struct sigaction handle_alarm;
8424 int ret;
8425 sigset_t sigs;
8426 sigset_t saved_sigs;
8427
8428 // This is really the caller's responsibility, but let's make sure the
8429 // previous timer has been stopped.
8430 stop_timeout();
8431
8432 // There is a small chance that SIGALRM is pending and so the handler must
8433 // ignore it on the first call.
8434 alarm_pending = FALSE;
8435 ret = sigemptyset(&sigs);
8436 ret = ret == 0 ? sigaddset(&sigs, SIGALRM) : ret;
8437 ret = ret == 0 ? sigprocmask(SIG_BLOCK, &sigs, &saved_sigs) : ret;
8438 timeout_flag = FALSE;
8439 ret = ret == 0 ? sigpending(&sigs) : ret;
8440 if (ret == 0)
8441 {
8442 alarm_pending = sigismember(&sigs, SIGALRM);
Bram Moolenaar1f89abf2022-06-06 10:07:01 +01008443 ret = sigprocmask(SIG_SETMASK, &saved_sigs, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008444 }
8445 if (unlikely(ret != 0 || alarm_pending < 0))
8446 {
8447 // Just catching coding errors. Write an error message, but carry on.
8448 semsg(_(e_could_not_check_for_pending_sigalrm_str), strerror(errno));
8449 alarm_pending = FALSE;
8450 }
8451
8452 // Set up the alarm handler first.
8453 ret = sigemptyset(&handle_alarm.sa_mask);
8454 handle_alarm.sa_handler = set_flag;
8455 handle_alarm.sa_flags = 0;
8456 ret = ret == 0 ? sigaction(SIGALRM, &handle_alarm, &prev_sigaction) : ret;
8457 if (ret < 0)
8458 {
8459 // Should only get here as a result of coding errors.
8460 semsg(_(e_could_not_set_handler_for_timeout_str), strerror(errno));
8461 return &timeout_flag;
8462 }
8463 timer_handler_active = TRUE;
8464
8465 // Set up the interval timer once the alarm handler is in place.
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008466 ret = setitimer(ITIMER_REAL, &interval, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008467 if (ret < 0)
8468 {
8469 // Should only get here as a result of coding errors.
8470 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8471 stop_timeout();
8472 return &timeout_flag;
8473 }
8474
8475 timer_active = TRUE;
8476 return &timeout_flag;
8477}
8478# endif // HAVE_TIMER_CREATE
8479#endif // FEAT_RELTIME