blob: db57902dc3f6c655361f95542a6ba47f0c9b8c4e [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 * OS/2 port by Paul Slootman
5 * VMS merge by Zoltan Arpadffy
6 *
7 * Do ":help uganda" in Vim to read copying and usage conditions.
8 * Do ":help credits" in Vim to see a list of people who contributed.
9 * See README.txt for an overview of the Vim source code.
10 */
11
12/*
13 * os_unix.c -- code for all flavors of Unix (BSD, SYSV, SVR4, POSIX, ...)
14 * Also for OS/2, using the excellent EMX package!!!
Bram Moolenaar041c7102020-05-30 18:14:57 +020015 * Also for Atari MiNT.
Bram Moolenaar071d4272004-06-13 20:20:40 +000016 *
17 * A lot of this file was originally written by Juergen Weigert and later
18 * changed beyond recognition.
19 */
20
Bram Moolenaar071d4272004-06-13 20:20:40 +000021#include "vim.h"
22
Bram Moolenaar325b7a22004-07-05 15:58:32 +000023#ifdef FEAT_MZSCHEME
24# include "if_mzsch.h"
25#endif
26
Bram Moolenaar0f873732019-12-05 20:28:46 +010027#include "os_unixx.h" // unix includes for os_unix.c only
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
29#ifdef USE_XSMP
30# include <X11/SM/SMlib.h>
31#endif
32
Bram Moolenaar588ebeb2008-05-07 17:09:24 +000033#ifdef HAVE_SELINUX
34# include <selinux/selinux.h>
35static int selinux_enabled = -1;
36#endif
37
Bram Moolenaar5bd32f42014-04-02 14:05:38 +020038#ifdef HAVE_SMACK
39# include <attr/xattr.h>
40# include <linux/xattr.h>
41# ifndef SMACK_LABEL_LEN
42# define SMACK_LABEL_LEN 1024
43# endif
44#endif
45
Bram Moolenaara2442432007-04-26 14:26:37 +000046#ifdef __CYGWIN__
K.Takata972db232022-02-04 10:45:38 +000047# include <cygwin/version.h>
48# include <sys/cygwin.h> // for cygwin_conv_to_posix_path() and/or
Bram Moolenaar0f873732019-12-05 20:28:46 +010049 // for cygwin_conv_path()
K.Takata972db232022-02-04 10:45:38 +000050# ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
51# define WIN32_LEAN_AND_MEAN
52# include <windows.h>
53# include "winclip.pro"
Bram Moolenaara2442432007-04-26 14:26:37 +000054# endif
55#endif
56
Bram Moolenaar071d4272004-06-13 20:20:40 +000057#ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +000058
Bram Moolenaar071d4272004-06-13 20:20:40 +000059# include <gpm.h>
Bram Moolenaar33fc4a62022-02-23 18:07:38 +000060
61# ifdef DYNAMIC_GPM
62# define Gpm_Open (*dll_Gpm_Open)
63# define Gpm_Close (*dll_Gpm_Close)
64# define Gpm_GetEvent (*dll_Gpm_GetEvent)
65# define gpm_flag (dll_gpm_flag != NULL ? *dll_gpm_flag : 0)
66# define gpm_fd (dll_gpm_fd != NULL ? *dll_gpm_fd : -1)
67
68static int (*dll_Gpm_Open) (Gpm_Connect *, int);
69static int (*dll_Gpm_Close) (void);
70static int (*dll_Gpm_GetEvent) (Gpm_Event *);
71static int *dll_gpm_flag;
72static int *dll_gpm_fd;
73
74static void *libgpm_hinst;
75# endif
76
Bram Moolenaar0f873732019-12-05 20:28:46 +010077// <linux/keyboard.h> contains defines conflicting with "keymap.h",
78// I just copied relevant defines here. A cleaner solution would be to put gpm
79// code into separate file and include there linux/keyboard.h
80// #include <linux/keyboard.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000081# define KG_SHIFT 0
82# define KG_CTRL 2
83# define KG_ALT 3
84# define KG_ALTGR 1
85# define KG_SHIFTL 4
86# define KG_SHIFTR 5
87# define KG_CTRLL 6
88# define KG_CTRLR 7
89# define KG_CAPSSHIFT 8
90
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010091static void gpm_close(void);
92static int gpm_open(void);
93static int mch_gpm_process(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000094#endif
95
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000096#ifdef FEAT_SYSMOUSE
97# include <sys/consio.h>
98# include <sys/fbio.h>
99
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100100static int sysmouse_open(void);
101static void sysmouse_close(void);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100102static void sig_sysmouse SIGPROTOARG;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000103#endif
104
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105/*
106 * end of autoconf section. To be extended...
107 */
108
Bram Moolenaar0f873732019-12-05 20:28:46 +0100109// Are the following #ifdefs still required? And why? Is that for X11?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110
111#if defined(ESIX) || defined(M_UNIX) && !defined(SCO)
112# ifdef SIGWINCH
113# undef SIGWINCH
114# endif
115# ifdef TIOCGWINSZ
116# undef TIOCGWINSZ
117# endif
118#endif
119
Bram Moolenaar0f873732019-12-05 20:28:46 +0100120#if defined(SIGWINDOW) && !defined(SIGWINCH) // hpux 9.01 has it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121# define SIGWINCH SIGWINDOW
122#endif
123
124#ifdef FEAT_X11
125# include <X11/Xlib.h>
126# include <X11/Xutil.h>
127# include <X11/Xatom.h>
128# ifdef FEAT_XCLIPBOARD
129# include <X11/Intrinsic.h>
130# include <X11/Shell.h>
131# include <X11/StringDefs.h>
132static Widget xterm_Shell = (Widget)0;
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100133static void clip_update(void);
134static void xterm_update(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135# endif
136
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137Window x11_window = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138Display *x11_display = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139#endif
140
Bram Moolenaar5c3128e2020-05-11 20:54:42 +0200141static int ignore_sigtstp = FALSE;
142
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100143static int get_x11_title(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
145static char_u *oldtitle = NULL;
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200146static volatile sig_atomic_t oldtitle_outdated = FALSE;
Bram Moolenaardac13472019-09-16 21:06:21 +0200147static int unix_did_set_title = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148static char_u *oldicon = NULL;
149static int did_set_icon = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100151static void may_core_dump(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152
Bram Moolenaar205b8862011-09-07 15:04:31 +0200153#ifdef HAVE_UNION_WAIT
154typedef union wait waitstatus;
155#else
156typedef int waitstatus;
157#endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200158static int WaitForChar(long msec, int *interrupted, int ignore_input);
159static int WaitForCharOrMouse(long msec, int *interrupted, int ignore_input);
Bram Moolenaar041c7102020-05-30 18:14:57 +0200160#ifdef VMS
Bram Moolenaarcda77642016-06-04 13:32:35 +0200161int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162#else
Bram Moolenaarcda77642016-06-04 13:32:35 +0200163static int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164#endif
165
166#ifdef FEAT_XCLIPBOARD
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100167static int do_xterm_trace(void);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100168# define XT_TRACE_DELAY 50 // delay for xterm tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169#endif
170
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100171static void handle_resize(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172
173#if defined(SIGWINCH)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100174static void sig_winch SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175#endif
dbivolaruab16ad32021-12-29 19:41:47 +0000176#if defined(SIGTSTP)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100177static void sig_tstp SIGPROTOARG;
Bram Moolenaarabd56da2022-06-23 20:46:27 +0100178// volatile because it is used in signal handler sig_tstp() and
179// sigcont_handler().
dbivolaruab16ad32021-12-29 19:41:47 +0000180static volatile sig_atomic_t in_mch_suspend = FALSE;
181#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182#if defined(SIGINT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100183static void catch_sigint SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200185#if defined(SIGUSR1)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100186static void catch_sigusr1 SIGPROTOARG;
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200187#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188#if defined(SIGPWR)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100189static void catch_sigpwr SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190#endif
Bram Moolenaar651fca82021-11-29 20:39:38 +0000191#if defined(SIGALRM) && defined(FEAT_X11) && !defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192# define SET_SIG_ALARM
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100193static void sig_alarm SIGPROTOARG;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100194// volatile because it is used in signal handler sig_alarm().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200195static volatile sig_atomic_t sig_alarm_called;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196#endif
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100197static void deathtrap SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100199static void catch_int_signal(void);
200static void set_signals(void);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100201static void catch_signals(void (*func_deadly)(), void (*func_other)());
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +0200202#ifdef HAVE_SIGPROCMASK
203# define SIGSET_DECL(set) sigset_t set;
204# define BLOCK_SIGNALS(set) block_signals(set)
205# define UNBLOCK_SIGNALS(set) unblock_signals(set)
206#else
207# define SIGSET_DECL(set)
208# define BLOCK_SIGNALS(set) do { /**/ } while (0)
209# define UNBLOCK_SIGNALS(set) do { /**/ } while (0)
210#endif
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100211static int have_wildcard(int, char_u **);
212static int have_dollars(int, char_u **);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100214static int save_patterns(int num_pat, char_u **pat, int *num_file, char_u ***file);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215
216#ifndef SIG_ERR
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100217# define SIG_ERR ((void (*)())-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218#endif
219
Bram Moolenaar0f873732019-12-05 20:28:46 +0100220// volatile because it is used in signal handler sig_winch().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200221static volatile sig_atomic_t do_resize = FALSE;
dbivolaruab16ad32021-12-29 19:41:47 +0000222// volatile because it is used in signal handler sig_tstp().
223static volatile sig_atomic_t got_tstp = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224static char_u *extra_shell_arg = NULL;
225static int show_shell_mess = TRUE;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100226// volatile because it is used in signal handler deathtrap().
227static volatile sig_atomic_t deadly_signal = 0; // The signal we caught
228// volatile because it is used in signal handler deathtrap().
229static volatile sig_atomic_t in_mch_delay = FALSE; // sleeping in mch_delay()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +0100231#if defined(FEAT_JOB_CHANNEL) && !defined(USE_SYSTEM)
232static int dont_check_job_ended = 0;
233#endif
234
Bram Moolenaar26e86442020-05-17 14:06:16 +0200235// Current terminal mode from mch_settmode(). Can differ from cur_tmode.
236static tmode_T mch_cur_tmode = TMODE_COOK;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237
238#ifdef USE_XSMP
239typedef struct
240{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100241 SmcConn smcconn; // The SM connection ID
242 IceConn iceconn; // The ICE connection ID
243 char *clientid; // The client ID for the current smc session
244 Bool save_yourself; // If we're in the middle of a save_yourself
245 Bool shutdown; // If we're in shutdown mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246} xsmp_config_T;
247
248static xsmp_config_T xsmp;
249#endif
250
251#ifdef SYS_SIGLIST_DECLARED
252/*
253 * I have seen
254 * extern char *_sys_siglist[NSIG];
Yegappan Lakshmananaebc6ef2022-08-27 21:24:26 +0100255 * on Linux, NetBSD and Solaris. It contains a nice list of strings
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256 * that describe the signals. That is nearly what we want here. But
257 * autoconf does only check for sys_siglist (without the underscore), I
258 * do not want to change everything today.... jw.
Bram Moolenaar3f7d0902016-11-12 21:13:42 +0100259 * This is why AC_DECL_SYS_SIGLIST is commented out in configure.ac.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 */
261#endif
262
263static struct signalinfo
264{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100265 int sig; // Signal number, eg. SIGSEGV etc
266 char *name; // Signal name (not char_u!).
267 char deadly; // Catch as a deadly signal?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268} signal_info[] =
269{
270#ifdef SIGHUP
271 {SIGHUP, "HUP", TRUE},
272#endif
273#ifdef SIGQUIT
274 {SIGQUIT, "QUIT", TRUE},
275#endif
276#ifdef SIGILL
277 {SIGILL, "ILL", TRUE},
278#endif
279#ifdef SIGTRAP
280 {SIGTRAP, "TRAP", TRUE},
281#endif
282#ifdef SIGABRT
283 {SIGABRT, "ABRT", TRUE},
284#endif
285#ifdef SIGEMT
286 {SIGEMT, "EMT", TRUE},
287#endif
288#ifdef SIGFPE
289 {SIGFPE, "FPE", TRUE},
290#endif
291#ifdef SIGBUS
292 {SIGBUS, "BUS", TRUE},
293#endif
Bram Moolenaar75676462013-01-30 14:55:42 +0100294#if defined(SIGSEGV) && !defined(FEAT_MZSCHEME)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100295 // MzScheme uses SEGV in its garbage collector
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 {SIGSEGV, "SEGV", TRUE},
297#endif
298#ifdef SIGSYS
299 {SIGSYS, "SYS", TRUE},
300#endif
301#ifdef SIGALRM
Bram Moolenaar0f873732019-12-05 20:28:46 +0100302 {SIGALRM, "ALRM", FALSE}, // Perl's alarm() can trigger it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303#endif
304#ifdef SIGTERM
305 {SIGTERM, "TERM", TRUE},
306#endif
Bram Moolenaarb292a2a2011-02-09 18:47:40 +0100307#if defined(SIGVTALRM) && !defined(FEAT_RUBY)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 {SIGVTALRM, "VTALRM", TRUE},
309#endif
Bram Moolenaar02f07e02008-03-12 12:17:28 +0000310#if defined(SIGPROF) && !defined(FEAT_MZSCHEME) && !defined(WE_ARE_PROFILING)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100311 // MzScheme uses SIGPROF for its own needs; On Linux with profiling
312 // this makes Vim exit. WE_ARE_PROFILING is defined in Makefile.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 {SIGPROF, "PROF", TRUE},
314#endif
315#ifdef SIGXCPU
316 {SIGXCPU, "XCPU", TRUE},
317#endif
318#ifdef SIGXFSZ
319 {SIGXFSZ, "XFSZ", TRUE},
320#endif
321#ifdef SIGUSR1
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200322 {SIGUSR1, "USR1", FALSE},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000324#if defined(SIGUSR2) && !defined(FEAT_SYSMOUSE)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100325 // Used for sysmouse handling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {SIGUSR2, "USR2", TRUE},
327#endif
328#ifdef SIGINT
329 {SIGINT, "INT", FALSE},
330#endif
331#ifdef SIGWINCH
332 {SIGWINCH, "WINCH", FALSE},
333#endif
334#ifdef SIGTSTP
335 {SIGTSTP, "TSTP", FALSE},
336#endif
337#ifdef SIGPIPE
338 {SIGPIPE, "PIPE", FALSE},
339#endif
340 {-1, "Unknown!", FALSE}
341};
342
Bram Moolenaar25724922009-07-14 15:38:41 +0000343 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100344mch_chdir(char *path)
Bram Moolenaar25724922009-07-14 15:38:41 +0000345{
346 if (p_verbose >= 5)
347 {
348 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100349 smsg("chdir(%s)", path);
Bram Moolenaar25724922009-07-14 15:38:41 +0000350 verbose_leave();
351 }
352# ifdef VMS
353 return chdir(vms_fixfilename(path));
354# else
355 return chdir(path);
356# endif
357}
358
Bram Moolenaar0f873732019-12-05 20:28:46 +0100359// Why is NeXT excluded here (and not in os_unixx.h)?
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +0100360#if defined(ECHOE) && defined(ICANON) \
361 && (defined(HAVE_TERMIO_H) || defined(HAVE_TERMIOS_H)) \
362 && !defined(__NeXT__)
Bram Moolenaar4f44b882017-08-13 20:06:18 +0200363# define NEW_TTY_SYSTEM
364#endif
365
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000366/*
Bram Moolenaard23a8232018-02-10 18:45:26 +0100367 * Write s[len] to the screen (stdout).
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000368 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100370mch_write(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371{
Bram Moolenaar42335f52018-09-13 15:33:43 +0200372 vim_ignored = (int)write(1, (char *)s, len);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100373 if (p_wd) // Unix is too fast, slow down a bit more
Bram Moolenaar8fdd7212016-03-26 19:41:48 +0100374 RealWaitForChar(read_cmd_fd, p_wd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375}
376
377/*
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100378 * Function passed to inchar_loop() to handle window resizing.
379 * If "check_only" is TRUE: Return whether there was a resize.
380 * If "check_only" is FALSE: Deal with the window resized.
381 */
382 static int
383resize_func(int check_only)
384{
385 if (check_only)
386 return do_resize;
387 while (do_resize)
388 handle_resize();
389 return FALSE;
390}
391
392/*
Bram Moolenaarc2a27c32007-12-01 16:19:33 +0000393 * mch_inchar(): low level input function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394 * Get a characters from the keyboard.
395 * Return the number of characters that are available.
396 * If wtime == 0 do not wait for characters.
397 * If wtime == n wait a short time for characters.
398 * If wtime == -1 wait forever for characters.
399 */
400 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100401mch_inchar(
402 char_u *buf,
403 int maxlen,
Bram Moolenaar0f873732019-12-05 20:28:46 +0100404 long wtime, // don't use "time", MIPS cannot handle it
Bram Moolenaar05540972016-01-30 20:31:25 +0100405 int tb_change_cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406{
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100407 return inchar_loop(buf, maxlen, wtime, tb_change_cnt,
408 WaitForChar, resize_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409}
410
411 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100412handle_resize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413{
414 do_resize = FALSE;
415 shell_resized();
416}
417
418/*
Bram Moolenaar40b1b542016-04-20 20:18:23 +0200419 * Return non-zero if a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420 */
421 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100422mch_char_avail(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423{
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200424 return WaitForChar(0L, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425}
426
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200427#if defined(FEAT_TERMINAL) || defined(PROTO)
428/*
429 * Check for any pending input or messages.
430 */
431 int
432mch_check_messages(void)
433{
434 return WaitForChar(0L, NULL, TRUE);
435}
436#endif
437
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438#if defined(HAVE_TOTAL_MEM) || defined(PROTO)
439# ifdef HAVE_SYS_RESOURCE_H
Bram Moolenaar8f0b2d42009-05-16 14:41:10 +0000440# include <sys/resource.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441# endif
442# if defined(HAVE_SYS_SYSCTL_H) && defined(HAVE_SYSCTL)
443# include <sys/sysctl.h>
444# endif
445# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
446# include <sys/sysinfo.h>
447# endif
Bram Moolenaar362dc332018-03-05 21:59:37 +0100448# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100449# include <mach/mach_host.h>
450# include <mach/mach_port.h>
Bram Moolenaar988615f2018-02-27 17:58:20 +0100451# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452
453/*
Bram Moolenaar914572a2007-05-01 11:37:47 +0000454 * Return total amount of memory available in Kbyte.
455 * Doesn't change when memory has been allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457 long_u
Bram Moolenaar05540972016-01-30 20:31:25 +0100458mch_total_mem(int special UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 long_u mem = 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100461 long_u shiftright = 10; // how much to shift "mem" right for Kbyte
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462
Bram Moolenaar362dc332018-03-05 21:59:37 +0100463# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100464 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100465 // Mac (Darwin) way of getting the amount of RAM available
Bram Moolenaar988615f2018-02-27 17:58:20 +0100466 mach_port_t host = mach_host_self();
467 kern_return_t kret;
468# ifdef HOST_VM_INFO64
469 struct vm_statistics64 vm_stat;
470 natural_t count = HOST_VM_INFO64_COUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471
Bram Moolenaar988615f2018-02-27 17:58:20 +0100472 kret = host_statistics64(host, HOST_VM_INFO64,
473 (host_info64_t)&vm_stat, &count);
474# else
475 struct vm_statistics vm_stat;
476 natural_t count = HOST_VM_INFO_COUNT;
477
478 kret = host_statistics(host, HOST_VM_INFO,
479 (host_info_t)&vm_stat, &count);
480# endif
481 if (kret == KERN_SUCCESS)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100482 // get the amount of user memory by summing each usage
Bram Moolenaar988615f2018-02-27 17:58:20 +0100483 mem = (long_u)(vm_stat.free_count + vm_stat.active_count
484 + vm_stat.inactive_count
485# ifdef MAC_OS_X_VERSION_10_9
486 + vm_stat.compressor_page_count
487# endif
Bram Moolenaar62b7f6a2018-03-22 21:44:07 +0100488 ) * sysconf(_SC_PAGESIZE);
Bram Moolenaar988615f2018-02-27 17:58:20 +0100489 mach_port_deallocate(mach_task_self(), host);
490 }
491# endif
492
493# ifdef HAVE_SYSCTL
494 if (mem == 0)
495 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100496 // BSD way of getting the amount of RAM available.
Bram Moolenaar988615f2018-02-27 17:58:20 +0100497 int mib[2];
498 size_t len = sizeof(long_u);
499# ifdef HW_USERMEM64
500 long_u physmem;
501# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100502 // sysctl() may return 32 bit or 64 bit, accept both
Bram Moolenaar988615f2018-02-27 17:58:20 +0100503 union {
504 int_u u32;
505 long_u u64;
506 } physmem;
507# endif
508
509 mib[0] = CTL_HW;
510# ifdef HW_USERMEM64
511 mib[1] = HW_USERMEM64;
512# else
513 mib[1] = HW_USERMEM;
514# endif
515 if (sysctl(mib, 2, &physmem, &len, NULL, 0) == 0)
516 {
517# ifdef HW_USERMEM64
518 mem = (long_u)physmem;
519# else
520 if (len == sizeof(physmem.u64))
521 mem = (long_u)physmem.u64;
522 else
523 mem = (long_u)physmem.u32;
524# endif
525 }
526 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200527# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200529# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 if (mem == 0)
531 {
532 struct sysinfo sinfo;
533
Bram Moolenaar0f873732019-12-05 20:28:46 +0100534 // Linux way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535 if (sysinfo(&sinfo) == 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000536 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200537# ifdef HAVE_SYSINFO_MEM_UNIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100538 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000539 while (shiftright > 0 && (sinfo.mem_unit & 1) == 0)
540 {
541 sinfo.mem_unit = sinfo.mem_unit >> 1;
542 --shiftright;
543 }
544 mem = sinfo.totalram * sinfo.mem_unit;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200545# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546 mem = sinfo.totalram;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200547# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000548 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200550# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200552# ifdef HAVE_SYSCONF
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 if (mem == 0)
554 {
555 long pagesize, pagecount;
556
Bram Moolenaar0f873732019-12-05 20:28:46 +0100557 // Solaris way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558 pagesize = sysconf(_SC_PAGESIZE);
559 pagecount = sysconf(_SC_PHYS_PAGES);
560 if (pagesize > 0 && pagecount > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000561 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100562 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000563 while (shiftright > 0 && (pagesize & 1) == 0)
564 {
Bram Moolenaar3d27a452007-05-10 17:44:18 +0000565 pagesize = (long_u)pagesize >> 1;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000566 --shiftright;
567 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 mem = (long_u)pagesize * pagecount;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200571# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
Bram Moolenaar0f873732019-12-05 20:28:46 +0100573 // Return the minimum of the physical memory and the user limit, because
574 // using more than the user limit may cause Vim to be terminated.
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200575# if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576 {
577 struct rlimit rlp;
578
579 if (getrlimit(RLIMIT_DATA, &rlp) == 0
580 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200581# ifdef RLIM_INFINITY
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 && rlp.rlim_cur != RLIM_INFINITY
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200583# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000584 && ((long_u)rlp.rlim_cur >> 10) < (mem >> shiftright)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585 )
Bram Moolenaar914572a2007-05-01 11:37:47 +0000586 {
587 mem = (long_u)rlp.rlim_cur;
588 shiftright = 10;
589 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200591# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593 if (mem > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000594 return mem >> shiftright;
595 return (long_u)0x1fffff;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596}
597#endif
598
Bram Moolenaar0981c872020-08-23 14:28:37 +0200599/*
600 * "flags": MCH_DELAY_IGNOREINPUT - don't read input
601 * MCH_DELAY_SETTMODE - use settmode() even for short delays
602 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603 void
Bram Moolenaar0981c872020-08-23 14:28:37 +0200604mch_delay(long msec, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605{
Bram Moolenaar26e86442020-05-17 14:06:16 +0200606 tmode_T old_tmode;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200607 int call_settmode;
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000608#ifdef FEAT_MZSCHEME
Bram Moolenaar0f873732019-12-05 20:28:46 +0100609 long total = msec; // remember original value
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000610#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611
Bram Moolenaar0981c872020-08-23 14:28:37 +0200612 if (flags & MCH_DELAY_IGNOREINPUT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100614 // Go to cooked mode without echo, to allow SIGINT interrupting us
615 // here. But we don't want QUIT to kill us (CTRL-\ used in a
616 // shell may produce SIGQUIT).
Bram Moolenaar26e86442020-05-17 14:06:16 +0200617 // Only do this if sleeping for more than half a second.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000618 in_mch_delay = TRUE;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200619 call_settmode = mch_cur_tmode == TMODE_RAW
620 && (msec > 500 || (flags & MCH_DELAY_SETTMODE));
621 if (call_settmode)
622 {
623 old_tmode = mch_cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 settmode(TMODE_SLEEP);
Bram Moolenaar80361a52020-10-05 21:39:25 +0200625 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627 /*
628 * Everybody sleeps in a different way...
629 * Prefer nanosleep(), some versions of usleep() can only sleep up to
630 * one second.
631 */
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000632#ifdef FEAT_MZSCHEME
633 do
634 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100635 // if total is large enough, wait by portions in p_mzq
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000636 if (total > p_mzq)
637 msec = p_mzq;
638 else
639 msec = total;
640 total -= msec;
641#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642#ifdef HAVE_NANOSLEEP
643 {
644 struct timespec ts;
645
646 ts.tv_sec = msec / 1000;
647 ts.tv_nsec = (msec % 1000) * 1000000;
648 (void)nanosleep(&ts, NULL);
649 }
650#else
651# ifdef HAVE_USLEEP
652 while (msec >= 1000)
653 {
654 usleep((unsigned int)(999 * 1000));
655 msec -= 999;
656 }
657 usleep((unsigned int)(msec * 1000));
658# else
659# ifndef HAVE_SELECT
660 poll(NULL, 0, (int)msec);
661# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {
663 struct timeval tv;
664
665 tv.tv_sec = msec / 1000;
666 tv.tv_usec = (msec % 1000) * 1000;
Bram Moolenaar0981c872020-08-23 14:28:37 +0200667 // NOTE: Solaris 2.6 has a bug that makes select() hang here. Get
668 // a patch from Sun to fix this. Reported by Gunnar Pedersen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 select(0, NULL, NULL, NULL, &tv);
670 }
Bram Moolenaar0f873732019-12-05 20:28:46 +0100671# endif // HAVE_SELECT
672# endif // HAVE_NANOSLEEP
673#endif // HAVE_USLEEP
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000674#ifdef FEAT_MZSCHEME
675 }
676 while (total > 0);
677#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678
Bram Moolenaar80361a52020-10-05 21:39:25 +0200679 if (call_settmode)
Bram Moolenaar26e86442020-05-17 14:06:16 +0200680 settmode(old_tmode);
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000681 in_mch_delay = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 }
683 else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200684 WaitForChar(msec, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685}
686
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000687#if defined(HAVE_STACK_LIMIT) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 || (!defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGSTACK))
689# define HAVE_CHECK_STACK_GROWTH
690/*
691 * Support for checking for an almost-out-of-stack-space situation.
692 */
693
694/*
695 * Return a pointer to an item on the stack. Used to find out if the stack
696 * grows up or down.
697 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698static int stack_grows_downwards;
699
700/*
701 * Find out if the stack grows upwards or downwards.
702 * "p" points to a variable on the stack of the caller.
703 */
704 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100705check_stack_growth(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706{
707 int i;
708
709 stack_grows_downwards = (p > (char *)&i);
710}
711#endif
712
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000713#if defined(HAVE_STACK_LIMIT) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714static char *stack_limit = NULL;
715
716#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
717# include <pthread.h>
718# include <pthread_np.h>
719#endif
720
721/*
722 * Find out until how var the stack can grow without getting into trouble.
723 * Called when starting up and when switching to the signal stack in
724 * deathtrap().
725 */
726 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100727get_stack_limit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728{
729 struct rlimit rlp;
730 int i;
731 long lim;
732
Bram Moolenaar0f873732019-12-05 20:28:46 +0100733 // Set the stack limit to 15/16 of the allowable size. Skip this when the
734 // limit doesn't fit in a long (rlim_cur might be "long long").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 if (getrlimit(RLIMIT_STACK, &rlp) == 0
736 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
737# ifdef RLIM_INFINITY
738 && rlp.rlim_cur != RLIM_INFINITY
739# endif
740 )
741 {
742 lim = (long)rlp.rlim_cur;
743#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
744 {
745 pthread_attr_t attr;
746 size_t size;
747
Bram Moolenaar0f873732019-12-05 20:28:46 +0100748 // On FreeBSD the initial thread always has a fixed stack size, no
749 // matter what the limits are set to. Normally it's 1 Mbyte.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 pthread_attr_init(&attr);
751 if (pthread_attr_get_np(pthread_self(), &attr) == 0)
752 {
753 pthread_attr_getstacksize(&attr, &size);
754 if (lim > (long)size)
755 lim = (long)size;
756 }
757 pthread_attr_destroy(&attr);
758 }
759#endif
760 if (stack_grows_downwards)
761 {
762 stack_limit = (char *)((long)&i - (lim / 16L * 15L));
763 if (stack_limit >= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100764 // overflow, set to 1/16 of current stack position
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 stack_limit = (char *)((long)&i / 16L);
766 }
767 else
768 {
769 stack_limit = (char *)((long)&i + (lim / 16L * 15L));
770 if (stack_limit <= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100771 stack_limit = NULL; // overflow
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 }
773 }
774}
775
776/*
777 * Return FAIL when running out of stack space.
778 * "p" must point to any variable local to the caller that's on the stack.
779 */
780 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100781mch_stackcheck(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782{
783 if (stack_limit != NULL)
784 {
785 if (stack_grows_downwards)
786 {
787 if (p < stack_limit)
788 return FAIL;
789 }
790 else if (p > stack_limit)
791 return FAIL;
792 }
793 return OK;
794}
795#endif
796
797#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
798/*
799 * Support for using the signal stack.
800 * This helps when we run out of stack space, which causes a SIGSEGV. The
801 * signal handler then must run on another stack, since the normal stack is
802 * completely full.
803 */
804
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805# ifdef HAVE_SIGALTSTACK
Bram Moolenaar0f873732019-12-05 20:28:46 +0100806static stack_t sigstk; // for sigaltstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100808static struct sigstack sigstk; // for sigstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809# endif
810
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200811/*
812 * Get a size of signal stack.
813 * Preference (if available): sysconf > SIGSTKSZ > guessed size
814 */
815static long int get_signal_stack_size()
816{
817# ifdef HAVE_SYSCONF_SIGSTKSZ
818 long int size = -1;
819
820 // return size only if sysconf doesn't return an error
821 if ((size = sysconf(_SC_SIGSTKSZ)) > -1)
822 return size;
823# endif
824
825# ifdef SIGSTKSZ
826 // if sysconf() isn't available or gives error, return SIGSTKSZ
827 // if defined
828 return SIGSTKSZ;
829# endif
830
831 // otherwise guess the size
832 return 8000;
833}
834
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835static char *signal_stack;
836
837 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100838init_signal_stack(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839{
840 if (signal_stack != NULL)
841 {
842# ifdef HAVE_SIGALTSTACK
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843# ifdef HAVE_SS_BASE
844 sigstk.ss_base = signal_stack;
845# else
846 sigstk.ss_sp = signal_stack;
847# endif
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200848 sigstk.ss_size = get_signal_stack_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 sigstk.ss_flags = 0;
850 (void)sigaltstack(&sigstk, NULL);
851# else
852 sigstk.ss_sp = signal_stack;
853 if (stack_grows_downwards)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +0200854 sigstk.ss_sp += get_signal_stack_size() - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 sigstk.ss_onstack = 0;
856 (void)sigstack(&sigstk, NULL);
857# endif
858 }
859}
860#endif
861
862/*
Bram Moolenaar76243bd2009-03-02 01:47:02 +0000863 * We need correct prototypes for a signal function, otherwise mean compilers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 * will barf when the second argument to signal() is ``wrong''.
865 * Let me try it with a few tricky defines from my own osdef.h (jw).
866 */
867#if defined(SIGWINCH)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100868 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869sig_winch SIGDEFARG(sigarg)
870{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100871 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100872 signal(SIGWINCH, (void (*)())sig_winch);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 do_resize = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874}
875#endif
876
dbivolaruab16ad32021-12-29 19:41:47 +0000877#if defined(SIGTSTP)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100878 static void
dbivolaruab16ad32021-12-29 19:41:47 +0000879sig_tstp SIGDEFARG(sigarg)
880{
881 // Second time we get called we actually need to suspend
882 if (in_mch_suspend)
883 {
884 signal(SIGTSTP, ignore_sigtstp ? SIG_IGN : SIG_DFL);
885 raise(sigarg);
886 }
dbivolaru79a6e252022-01-23 16:41:14 +0000887 else
888 got_tstp = TRUE;
dbivolaruab16ad32021-12-29 19:41:47 +0000889
ichizok5f823d12022-03-13 17:27:38 +0000890#if !defined(__ANDROID__) && !defined(__OpenBSD__) && !defined(__DragonFly__)
891 // This is not required on all systems. On some systems (at least Android,
892 // OpenBSD, and DragonFlyBSD) this breaks suspending with CTRL-Z.
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100893 signal(SIGTSTP, (void (*)())sig_tstp);
xtkobacbef12e2022-02-27 12:31:52 +0000894#endif
dbivolaruab16ad32021-12-29 19:41:47 +0000895}
896#endif
897
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898#if defined(SIGINT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100899 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900catch_sigint SIGDEFARG(sigarg)
901{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100902 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100903 signal(SIGINT, (void (*)())catch_sigint);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 got_int = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905}
906#endif
907
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200908#if defined(SIGUSR1)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100909 static void
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200910catch_sigusr1 SIGDEFARG(sigarg)
911{
912 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100913 signal(SIGUSR1, (void (*)())catch_sigusr1);
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200914 got_sigusr1 = TRUE;
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200915}
916#endif
917
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918#if defined(SIGPWR)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100919 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920catch_sigpwr SIGDEFARG(sigarg)
921{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100922 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100923 signal(SIGPWR, (void (*)())catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 /*
925 * I'm not sure we get the SIGPWR signal when the system is really going
926 * down or when the batteries are almost empty. Just preserve the swap
927 * files and don't exit, that can't do any harm.
928 */
929 ml_sync_all(FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930}
931#endif
932
933#ifdef SET_SIG_ALARM
934/*
935 * signal function for alarm().
936 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +0100937 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938sig_alarm SIGDEFARG(sigarg)
939{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100940 // doesn't do anything, just to break a system call
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 sig_alarm_called = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942}
943#endif
944
Bram Moolenaaredce7422019-01-20 18:39:30 +0100945#if (defined(HAVE_SETJMP_H) \
946 && ((defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) \
947 || defined(FEAT_LIBCALL))) \
948 || defined(PROTO)
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100949# define USING_SETJMP 1
Bram Moolenaaredce7422019-01-20 18:39:30 +0100950
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100951// argument to SETJMP()
952static JMP_BUF lc_jump_env;
953
954# ifdef SIGHASARG
Bram Moolenaar32aa1022019-11-02 22:54:41 +0100955// Caught signal number, 0 when no signal was caught; used for mch_libcall().
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100956// Volatile because it is used in signal handlers.
957static volatile sig_atomic_t lc_signal;
958# endif
959
960// TRUE when lc_jump_env is valid.
961// Volatile because it is used in signal handler deathtrap().
zeertzjq9b7d2a92022-08-26 10:33:54 +0100962static volatile sig_atomic_t lc_active = FALSE;
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100963
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964/*
965 * A simplistic version of setjmp() that only allows one level of using.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100966 * Used to protect areas where we could crash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 * Don't call twice before calling mch_endjmp()!.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100968 *
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 * Usage:
970 * mch_startjmp();
971 * if (SETJMP(lc_jump_env) != 0)
972 * {
973 * mch_didjmp();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100974 * emsg("crash!");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 * }
976 * else
977 * {
978 * do_the_work;
979 * mch_endjmp();
980 * }
981 * Note: Can't move SETJMP() here, because a function calling setjmp() must
982 * not return before the saved environment is used.
983 * Returns OK for normal return, FAIL when the protected code caused a
984 * problem and LONGJMP() was used.
985 */
Bram Moolenaar113e1072019-01-20 15:30:40 +0100986 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100987mch_startjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988{
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100989# ifdef SIGHASARG
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 lc_signal = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100991# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 lc_active = TRUE;
993}
994
Bram Moolenaar113e1072019-01-20 15:30:40 +0100995 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100996mch_endjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997{
998 lc_active = FALSE;
999}
1000
Bram Moolenaar113e1072019-01-20 15:30:40 +01001001 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001002mch_didjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003{
1004# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarb7a7e032018-12-28 17:01:59 +01001005 // On FreeBSD the signal stack has to be reset after using siglongjmp(),
1006 // otherwise catching the signal only works once.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 init_signal_stack();
1008# endif
1009}
1010#endif
1011
1012/*
1013 * This function handles deadly signals.
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001014 * It tries to preserve any swap files and exit properly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 * (partly from Elvis).
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001016 * NOTE: Avoid unsafe functions, such as allocating memory, they can result in
1017 * a deadlock.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001019 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020deathtrap SIGDEFARG(sigarg)
1021{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001022 static int entered = 0; // count the number of times we got here.
1023 // Note: when memory has been corrupted
1024 // this may get an arbitrary value!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025#ifdef SIGHASARG
1026 int i;
1027#endif
1028
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001029#if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 /*
1031 * Catch a crash in protected code.
1032 * Restores the environment saved in lc_jump_env, which looks like
1033 * SETJMP() returns 1.
1034 */
1035 if (lc_active)
1036 {
1037# if defined(SIGHASARG)
1038 lc_signal = sigarg;
1039# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001040 lc_active = FALSE; // don't jump again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 LONGJMP(lc_jump_env, 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001042 // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 }
1044#endif
1045
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001046#ifdef SIGHASARG
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001047# ifdef SIGQUIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001048 // While in mch_delay() we go to cooked mode to allow a CTRL-C to
1049 // interrupt us. But in cooked mode we may also get SIGQUIT, e.g., when
1050 // pressing CTRL-\, but we don't want Vim to exit then.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001051 if (in_mch_delay && sigarg == SIGQUIT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001052 return;
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +00001053# endif
1054
Bram Moolenaar0f873732019-12-05 20:28:46 +01001055 // When SIGHUP, SIGQUIT, etc. are blocked: postpone the effect and return
1056 // here. This avoids that a non-reentrant function is interrupted, e.g.,
1057 // free(). Calling free() again may then cause a crash.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001058 if (entered == 0
1059 && (0
1060# ifdef SIGHUP
1061 || sigarg == SIGHUP
1062# endif
1063# ifdef SIGQUIT
1064 || sigarg == SIGQUIT
1065# endif
1066# ifdef SIGTERM
1067 || sigarg == SIGTERM
1068# endif
1069# ifdef SIGPWR
1070 || sigarg == SIGPWR
1071# endif
1072# ifdef SIGUSR1
1073 || sigarg == SIGUSR1
1074# endif
1075# ifdef SIGUSR2
1076 || sigarg == SIGUSR2
1077# endif
1078 )
Bram Moolenaar1f28b072005-07-12 22:42:41 +00001079 && !vim_handle_signal(sigarg))
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001080 return;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001081#endif
1082
Bram Moolenaar0f873732019-12-05 20:28:46 +01001083 // Remember how often we have been called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 ++entered;
1085
Bram Moolenaar0f873732019-12-05 20:28:46 +01001086 // Executing autocommands is likely to use more stack space than we have
1087 // available in the signal stack.
Bram Moolenaare429e702016-06-10 19:49:14 +02001088 block_autocmds();
Bram Moolenaare429e702016-06-10 19:49:14 +02001089
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090#ifdef FEAT_EVAL
Bram Moolenaar0f873732019-12-05 20:28:46 +01001091 // Set the v:dying variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 set_vim_var_nr(VV_DYING, (long)entered);
1093#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001094 v_dying = entered;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001096#ifdef HAVE_STACK_LIMIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001097 // Since we are now using the signal stack, need to reset the stack
1098 // limit. Otherwise using a regexp will fail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 get_stack_limit();
1100#endif
1101
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001102#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01001103 // This is for opening gdb the moment Vim crashes.
1104 // You need to manually adjust the file name and Vim executable name.
1105 // Suggested by SungHyun Nam.
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001106 {
1107# define VI_GDB_FILE "/tmp/vimgdb"
1108# define VIM_NAME "/usr/bin/vim"
1109 FILE *fp = fopen(VI_GDB_FILE, "w");
1110 if (fp)
1111 {
1112 fprintf(fp,
1113 "file %s\n"
1114 "attach %d\n"
1115 "set height 1000\n"
1116 "bt full\n"
1117 , VIM_NAME, getpid());
1118 fclose(fp);
1119 system("xterm -e gdb -x "VI_GDB_FILE);
1120 unlink(VI_GDB_FILE);
1121 }
1122 }
1123#endif
1124
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125#ifdef SIGHASARG
Bram Moolenaar0f873732019-12-05 20:28:46 +01001126 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 for (i = 0; signal_info[i].sig != -1; i++)
1128 if (sigarg == signal_info[i].sig)
1129 break;
1130 deadly_signal = sigarg;
1131#endif
1132
Bram Moolenaar0f873732019-12-05 20:28:46 +01001133 full_screen = FALSE; // don't write message to the GUI, it might be
1134 // part of the problem...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 /*
1136 * If something goes wrong after entering here, we may get here again.
1137 * When this happens, give a message and try to exit nicely (resetting the
1138 * terminal mode, etc.)
1139 * When this happens twice, just exit, don't even try to give a message,
1140 * stack may be corrupt or something weird.
1141 * When this still happens again (or memory was corrupted in such a way
1142 * that "entered" was clobbered) use _exit(), don't try freeing resources.
1143 */
1144 if (entered >= 3)
1145 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001146 reset_signals(); // don't catch any signals anymore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 may_core_dump();
1148 if (entered >= 4)
1149 _exit(8);
1150 exit(7);
1151 }
1152 if (entered == 2)
1153 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001154 // No translation, it may call malloc().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001155 OUT_STR("Vim: Double signal, exiting\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 out_flush();
1157 getout(1);
1158 }
1159
Bram Moolenaar0f873732019-12-05 20:28:46 +01001160 // No translation, it may call malloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161#ifdef SIGHASARG
Bram Moolenaar69212b12020-05-10 14:14:03 +02001162 sprintf((char *)IObuff, "Vim: Caught deadly signal %s\r\n",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 signal_info[i].name);
1164#else
Bram Moolenaar69212b12020-05-10 14:14:03 +02001165 sprintf((char *)IObuff, "Vim: Caught deadly signal\r\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166#endif
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001167
Bram Moolenaar0f873732019-12-05 20:28:46 +01001168 // Preserve files and exit. This sets the really_exiting flag to prevent
1169 // calling free().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001170 preserve_exit();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171
Bram Moolenaar0f873732019-12-05 20:28:46 +01001172 // NOTREACHED
Bram Moolenaare429e702016-06-10 19:49:14 +02001173
Bram Moolenaar009b2592004-10-24 19:18:58 +00001174#ifdef NBDEBUG
1175 reset_signals();
1176 may_core_dump();
1177 abort();
1178#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179}
1180
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02001182 * Invoked after receiving SIGCONT. We don't know what happened while
1183 * sleeping, deal with part of that.
1184 */
1185 static void
1186after_sigcont(void)
1187{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001188 // Don't change "oldtitle" in a signal handler, set a flag to obtain it
1189 // again later.
1190 oldtitle_outdated = TRUE;
Bram Moolenaar651fca82021-11-29 20:39:38 +00001191
Bram Moolenaar2e310482018-08-21 13:09:10 +02001192 settmode(TMODE_RAW);
1193 need_check_timestamps = TRUE;
1194 did_check_timestamps = FALSE;
1195}
1196
1197#if defined(SIGCONT)
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001198static void sigcont_handler SIGPROTOARG;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001199
1200/*
1201 * With multi-threading, suspending might not work immediately. Catch the
1202 * SIGCONT signal, which will be used as an indication whether the suspending
1203 * has been done or not.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001204 *
1205 * On Linux, signal is not always handled immediately either.
1206 * See https://bugs.launchpad.net/bugs/291373
Bram Moolenaar2e310482018-08-21 13:09:10 +02001207 * Probably because the signal is handled in another thread.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001208 *
Bram Moolenaarb292a2a2011-02-09 18:47:40 +01001209 * volatile because it is used in signal handler sigcont_handler().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 */
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001211static volatile sig_atomic_t sigcont_received;
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001212static void sigcont_handler SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213
1214/*
1215 * signal handler for SIGCONT
1216 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001217 static void
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218sigcont_handler SIGDEFARG(sigarg)
1219{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001220 if (in_mch_suspend)
1221 {
1222 sigcont_received = TRUE;
1223 }
1224 else
1225 {
1226 // We didn't suspend ourselves, assume we were stopped by a SIGSTOP
1227 // signal (which can't be intercepted) and get a SIGCONT. Need to get
1228 // back to a sane mode. We should redraw, but we can't really do that
1229 // in a signal handler, do a redraw later.
1230 after_sigcont();
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001231 redraw_later(UPD_CLEAR);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001232 cursor_on_force();
1233 out_flush();
1234 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235}
1236#endif
1237
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02001238#if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001239# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001240static void *clip_star_save = NULL;
1241static void *clip_plus_save = NULL;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001242# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001243
1244/*
1245 * Called when Vim is going to sleep or execute a shell command.
1246 * We can't respond to requests for the X selections. Lose them, otherwise
1247 * other applications will hang. But first copy the text to cut buffer 0.
1248 */
1249 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001250loose_clipboard(void)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001251{
1252 if (clip_star.owned || clip_plus.owned)
1253 {
1254 x11_export_final_selection();
1255 if (clip_star.owned)
1256 clip_lose_selection(&clip_star);
1257 if (clip_plus.owned)
1258 clip_lose_selection(&clip_plus);
1259 if (x11_display != NULL)
1260 XFlush(x11_display);
1261 }
1262}
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001263
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001264# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001265/*
1266 * Save clipboard text to restore later.
1267 */
1268 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001269save_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001270{
1271 if (clip_star.owned)
1272 clip_star_save = get_register('*', TRUE);
1273 if (clip_plus.owned)
1274 clip_plus_save = get_register('+', TRUE);
1275}
1276
1277/*
1278 * Restore clipboard text if no one own the X selection.
1279 */
1280 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001281restore_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001282{
1283 if (clip_star_save != NULL)
1284 {
1285 if (!clip_gen_owner_exists(&clip_star))
1286 put_register('*', clip_star_save);
1287 else
1288 free_register(clip_star_save);
1289 clip_star_save = NULL;
1290 }
1291 if (clip_plus_save != NULL)
1292 {
1293 if (!clip_gen_owner_exists(&clip_plus))
1294 put_register('+', clip_plus_save);
1295 else
1296 free_register(clip_plus_save);
1297 clip_plus_save = NULL;
1298 }
1299}
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001300# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001301#endif
1302
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303/*
1304 * If the machine has job control, use it to suspend the program,
1305 * otherwise fake it by starting a new shell.
1306 */
1307 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001308mch_suspend(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309{
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001310 if (ignore_sigtstp)
1311 return;
1312
Bram Moolenaar041c7102020-05-30 18:14:57 +02001313#if defined(SIGTSTP)
Bram Moolenaar2e310482018-08-21 13:09:10 +02001314 in_mch_suspend = TRUE;
1315
Bram Moolenaar0f873732019-12-05 20:28:46 +01001316 out_flush(); // needed to make cursor visible on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 settmode(TMODE_COOK);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001318 out_flush(); // needed to disable mouse on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319
1320# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001321 loose_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001323# if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 sigcont_received = FALSE;
1325# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001326
Bram Moolenaar0f873732019-12-05 20:28:46 +01001327 kill(0, SIGTSTP); // send ourselves a STOP signal
Bram Moolenaar2e310482018-08-21 13:09:10 +02001328
1329# if defined(SIGCONT)
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001330 /*
1331 * Wait for the SIGCONT signal to be handled. It generally happens
Bram Moolenaar2e310482018-08-21 13:09:10 +02001332 * immediately, but somehow not all the time, probably because it's handled
1333 * in another thread. Do not call pause() because there would be race
1334 * condition which would hang Vim if signal happened in between the test of
1335 * sigcont_received and the call to pause(). If signal is not yet received,
1336 * sleep 0, 1, 2, 3 ms. Don't bother waiting further if signal is not
1337 * received after 1+2+3 ms (not expected to happen).
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001338 */
1339 {
Bram Moolenaar262735e2009-07-14 10:20:22 +00001340 long wait_time;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001341
Bram Moolenaar262735e2009-07-14 10:20:22 +00001342 for (wait_time = 0; !sigcont_received && wait_time <= 3L; wait_time++)
Bram Moolenaar0981c872020-08-23 14:28:37 +02001343 mch_delay(wait_time, 0);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001344 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001346 in_mch_suspend = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347
Bram Moolenaar2e310482018-08-21 13:09:10 +02001348 after_sigcont();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349#else
1350 suspend_shell();
1351#endif
1352}
1353
1354 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001355mch_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356{
1357 Columns = 80;
1358 Rows = 24;
1359
1360 out_flush();
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001361
1362#ifdef SIGTSTP
1363 // Check whether we were invoked with SIGTSTP set to be ignored. If it is
1364 // that indicates the shell (or program) that launched us does not support
1365 // tty job control and thus we should ignore that signal. If invoked as a
1366 // restricted editor (e.g., as "rvim") SIGTSTP is always ignored.
1367 ignore_sigtstp = restricted || SIG_IGN == signal(SIGTSTP, SIG_ERR);
1368#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 set_signals();
Bram Moolenaardf177f62005-02-22 08:39:57 +00001370
Bram Moolenaar56718732006-03-15 22:53:57 +00001371#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001372 mac_conv_init();
1373#endif
Bram Moolenaar693e40c2013-02-26 14:56:42 +01001374#ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
1375 win_clip_init();
1376#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377}
1378
1379 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001380set_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381{
1382#if defined(SIGWINCH)
1383 /*
1384 * WINDOW CHANGE signal is handled with sig_winch().
1385 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001386 signal(SIGWINCH, (void (*)())sig_winch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387#endif
1388
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389#ifdef SIGTSTP
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001390 // See mch_init() for the conditions under which we ignore SIGTSTP.
Bram Moolenaar8e4af852022-01-24 12:20:45 +00001391 // In the GUI default TSTP processing is OK.
1392 // Checking both gui.in_use and gui.starting because gui.in_use is not set
1393 // at this point (set after menus are displayed), but gui.starting is set.
1394 signal(SIGTSTP, ignore_sigtstp ? SIG_IGN
1395# ifdef FEAT_GUI
1396 : gui.in_use || gui.starting ? SIG_DFL
1397# endif
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001398 : (void (*)())sig_tstp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399#endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001400#if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 signal(SIGCONT, sigcont_handler);
1402#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001403#ifdef SIGPIPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 /*
1405 * We want to ignore breaking of PIPEs.
1406 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 signal(SIGPIPE, SIG_IGN);
1408#endif
1409
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410#ifdef SIGINT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001411 catch_int_signal();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412#endif
1413
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001414#ifdef SIGUSR1
1415 /*
1416 * Call user's handler on SIGUSR1
1417 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001418 signal(SIGUSR1, (void (*)())catch_sigusr1);
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001419#endif
1420
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 /*
1422 * Ignore alarm signals (Perl's alarm() generates it).
1423 */
1424#ifdef SIGALRM
1425 signal(SIGALRM, SIG_IGN);
1426#endif
1427
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001428#ifdef SIGPWR
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 /*
1430 * Catch SIGPWR (power failure?) to preserve the swap files, so that no
1431 * work will be lost.
1432 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001433 signal(SIGPWR, (void (*)())catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434#endif
1435
1436 /*
1437 * Arrange for other signals to gracefully shutdown Vim.
1438 */
1439 catch_signals(deathtrap, SIG_ERR);
1440
1441#if defined(FEAT_GUI) && defined(SIGHUP)
1442 /*
1443 * When the GUI is running, ignore the hangup signal.
1444 */
1445 if (gui.in_use)
1446 signal(SIGHUP, SIG_IGN);
1447#endif
1448}
1449
Bram Moolenaardf177f62005-02-22 08:39:57 +00001450#if defined(SIGINT) || defined(PROTO)
1451/*
1452 * Catch CTRL-C (only works while in Cooked mode).
1453 */
1454 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001455catch_int_signal(void)
Bram Moolenaardf177f62005-02-22 08:39:57 +00001456{
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001457 signal(SIGINT, (void (*)())catch_sigint);
Bram Moolenaardf177f62005-02-22 08:39:57 +00001458}
1459#endif
1460
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001462reset_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463{
1464 catch_signals(SIG_DFL, SIG_DFL);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001465#if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001466 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 signal(SIGCONT, SIG_DFL);
1468#endif
1469}
1470
1471 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001472catch_signals(
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001473 void (*func_deadly)(),
1474 void (*func_other)())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475{
1476 int i;
1477
1478 for (i = 0; signal_info[i].sig != -1; i++)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001479 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 if (signal_info[i].deadly)
1481 {
1482#if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION)
1483 struct sigaction sa;
1484
Bram Moolenaar0f873732019-12-05 20:28:46 +01001485 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 sa.sa_handler = func_deadly;
1487 sigemptyset(&sa.sa_mask);
1488# if defined(__linux__) && defined(_REENTRANT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001489 // On Linux, with glibc compiled for kernel 2.2, there is a bug in
1490 // thread handling in combination with using the alternate stack:
1491 // pthread library functions try to use the stack pointer to
1492 // identify the current thread, causing a SEGV signal, which
1493 // recursively calls deathtrap() and hangs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 sa.sa_flags = 0;
1495# else
1496 sa.sa_flags = SA_ONSTACK;
1497# endif
1498 sigaction(signal_info[i].sig, &sa, NULL);
1499#else
1500# if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGVEC)
1501 struct sigvec sv;
1502
Bram Moolenaar0f873732019-12-05 20:28:46 +01001503 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 sv.sv_handler = func_deadly;
1505 sv.sv_mask = 0;
1506 sv.sv_flags = SV_ONSTACK;
1507 sigvec(signal_info[i].sig, &sv, NULL);
1508# else
1509 signal(signal_info[i].sig, func_deadly);
1510# endif
1511#endif
1512 }
1513 else if (func_other != SIG_ERR)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001514 {
1515 // Deal with non-deadly signals.
1516#ifdef SIGTSTP
1517 signal(signal_info[i].sig,
1518 signal_info[i].sig == SIGTSTP && ignore_sigtstp
1519 ? SIG_IGN : func_other);
1520#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 signal(signal_info[i].sig, func_other);
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001522#endif
1523 }
1524 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525}
1526
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001527#ifdef HAVE_SIGPROCMASK
1528 static void
1529block_signals(sigset_t *set)
1530{
1531 sigset_t newset;
1532 int i;
1533
1534 sigemptyset(&newset);
1535
1536 for (i = 0; signal_info[i].sig != -1; i++)
1537 sigaddset(&newset, signal_info[i].sig);
1538
Bram Moolenaar2e310482018-08-21 13:09:10 +02001539# if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001540 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001541 sigaddset(&newset, SIGCONT);
1542# endif
1543
1544 sigprocmask(SIG_BLOCK, &newset, set);
1545}
1546
1547 static void
1548unblock_signals(sigset_t *set)
1549{
1550 sigprocmask(SIG_SETMASK, set, NULL);
1551}
1552#endif
1553
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554/*
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001555 * Handling of SIGHUP, SIGQUIT and SIGTERM:
Bram Moolenaar9e1d2832007-05-06 12:51:41 +00001556 * "when" == a signal: when busy, postpone and return FALSE, otherwise
1557 * return TRUE
1558 * "when" == SIGNAL_BLOCK: Going to be busy, block signals
1559 * "when" == SIGNAL_UNBLOCK: Going to wait, unblock signals, use postponed
Bram Moolenaar67c53842010-05-22 18:28:27 +02001560 * signal
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001561 * Returns TRUE when Vim should exit.
1562 */
1563 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001564vim_handle_signal(int sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001565{
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001566 static int got_signal = 0;
1567 static int blocked = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001568
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001569 switch (sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001570 {
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001571 case SIGNAL_BLOCK: blocked = TRUE;
1572 break;
1573
1574 case SIGNAL_UNBLOCK: blocked = FALSE;
1575 if (got_signal != 0)
1576 {
1577 kill(getpid(), got_signal);
1578 got_signal = 0;
1579 }
1580 break;
1581
1582 default: if (!blocked)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001583 return TRUE; // exit!
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001584 got_signal = sig;
1585#ifdef SIGPWR
1586 if (sig != SIGPWR)
1587#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001588 got_int = TRUE; // break any loops
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001589 break;
1590 }
1591 return FALSE;
1592}
1593
1594/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 * Check_win checks whether we have an interactive stdout.
1596 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001598mch_check_win(int argc UNUSED, char **argv UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 if (isatty(1))
1601 return OK;
1602 return FAIL;
1603}
1604
1605/*
1606 * Return TRUE if the input comes from a terminal, FALSE otherwise.
1607 */
1608 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001609mch_input_isatty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610{
1611 if (isatty(read_cmd_fd))
1612 return TRUE;
1613 return FALSE;
1614}
1615
1616#ifdef FEAT_X11
1617
Bram Moolenaar651fca82021-11-29 20:39:38 +00001618# if defined(ELAPSED_TIMEVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620/*
1621 * Give a message about the elapsed time for opening the X window.
1622 */
1623 static void
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001624xopen_message(long elapsed_msec)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001626 smsg(_("Opening the X display took %ld msec"), elapsed_msec);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627}
1628# endif
1629#endif
1630
Bram Moolenaar651fca82021-11-29 20:39:38 +00001631#if defined(FEAT_X11)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632/*
1633 * A few functions shared by X11 title and clipboard code.
1634 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635
1636static int got_x_error = FALSE;
1637
1638/*
1639 * X Error handler, otherwise X just exits! (very rude) -- webb
1640 */
1641 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001642x_error_handler(Display *dpy, XErrorEvent *error_event)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643{
Bram Moolenaar843ee412004-06-30 16:16:41 +00001644 XGetErrorText(dpy, error_event->error_code, (char *)IObuff, IOSIZE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 STRCAT(IObuff, _("\nVim: Got X error\n"));
1646
Bram Moolenaarb1062eb2020-05-09 16:11:33 +02001647 // In the GUI we cannot print a message and continue, because no X calls
1648 // are allowed here (causes my system to hang). Silently continuing seems
1649 // like the best alternative. Do preserve files, in case we crash.
1650 ml_sync_all(FALSE, FALSE);
1651
1652#ifdef FEAT_GUI
1653 if (!gui.in_use)
1654#endif
1655 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
Bram Moolenaar0f873732019-12-05 20:28:46 +01001657 return 0; // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658}
1659
1660/*
1661 * Another X Error handler, just used to check for errors.
1662 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001664x_error_check(Display *dpy UNUSED, XErrorEvent *error_event UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665{
1666 got_x_error = TRUE;
1667 return 0;
1668}
1669
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001670/*
1671 * Return TRUE when connection to the X server is desired.
1672 */
1673 static int
1674x_connect_to_server(void)
1675{
1676 // No point in connecting if we are exiting or dying.
1677 if (exiting || v_dying)
1678 return FALSE;
1679
1680#if defined(FEAT_CLIENTSERVER)
1681 if (x_force_connect)
1682 return TRUE;
1683#endif
1684 if (x_no_connect)
1685 return FALSE;
1686
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001687 // Check for a match with "exclude:" from 'clipboard'.
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001688 if (clip_exclude_prog != NULL)
1689 {
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001690 // Just in case we get called recursively, return FALSE. This could
1691 // happen if vpeekc() is used while executing the prog and it causes a
1692 // related callback to be invoked.
1693 if (regprog_in_use(clip_exclude_prog))
1694 return FALSE;
1695
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001696 if (vim_regexec_prog(&clip_exclude_prog, FALSE, T_NAME, (colnr_T)0))
1697 return FALSE;
1698 }
1699 return TRUE;
1700}
1701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001703# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704/*
1705 * An X IO Error handler, used to catch error while opening the display.
1706 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001708x_IOerror_check(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001710 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 LONGJMP(lc_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001712# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001713 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001714# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715}
1716# endif
1717
1718/*
1719 * An X IO Error handler, used to catch terminal errors.
1720 */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001721static int xterm_dpy_retry_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001724x_IOerror_handler(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725{
1726 xterm_dpy = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001727 xterm_dpy_retry_count = 5; // Try reconnecting five times
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 x11_window = 0;
1729 x11_display = NULL;
1730 xterm_Shell = (Widget)0;
1731
Bram Moolenaar0f873732019-12-05 20:28:46 +01001732 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 LONGJMP(x_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001734# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001735 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001736# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737}
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001738
1739/*
1740 * If the X11 connection was lost try to restore it.
1741 * Helps when the X11 server was stopped and restarted while Vim was inactive
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01001742 * (e.g. through tmux).
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001743 */
1744 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001745may_restore_clipboard(void)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001746{
Bram Moolenaar01e51e52018-12-29 13:09:46 +01001747 // No point in restoring the connecting if we are exiting or dying.
1748 if (!exiting && !v_dying && xterm_dpy_retry_count > 0)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001749 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001750 --xterm_dpy_retry_count;
Bram Moolenaar527a6782014-12-17 17:59:31 +01001751
1752# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01001753 // This has been reported to avoid Vim getting stuck.
Bram Moolenaar527a6782014-12-17 17:59:31 +01001754 if (app_context != (XtAppContext)NULL)
1755 {
1756 XtDestroyApplicationContext(app_context);
1757 app_context = (XtAppContext)NULL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001758 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaar527a6782014-12-17 17:59:31 +01001759 }
1760# endif
1761
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001762 setup_term_clip();
1763 get_x11_title(FALSE);
1764 }
1765}
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001766
1767 void
1768ex_xrestore(exarg_T *eap)
1769{
1770 if (eap->arg != NULL && STRLEN(eap->arg) > 0)
1771 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01001772 if (xterm_display_allocated)
1773 vim_free(xterm_display);
1774 xterm_display = (char *)vim_strsave(eap->arg);
1775 xterm_display_allocated = TRUE;
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001776 }
1777 smsg(_("restoring display %s"), xterm_display == NULL
Bram Moolenaar0c5c3fa2019-11-30 22:38:16 +01001778 ? (char *)mch_getenv((char_u *)"DISPLAY") : xterm_display);
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001779
1780 clear_xterm_clip();
1781 x11_window = 0;
1782 xterm_dpy_retry_count = 5; // Try reconnecting five times
1783 may_restore_clipboard();
1784}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785#endif
1786
1787/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 * Test if "dpy" and x11_window are valid by getting the window title.
1789 * I don't actually want it yet, so there may be a simpler call to use, but
1790 * this will cause the error handler x_error_check() to be called if anything
1791 * is wrong, such as the window pointer being invalid (as can happen when the
1792 * user changes his DISPLAY, but not his WINDOWID) -- webb
1793 */
1794 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001795test_x11_window(Display *dpy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796{
1797 int (*old_handler)();
1798 XTextProperty text_prop;
1799
1800 old_handler = XSetErrorHandler(x_error_check);
1801 got_x_error = FALSE;
1802 if (XGetWMName(dpy, x11_window, &text_prop))
1803 XFree((void *)text_prop.value);
1804 XSync(dpy, False);
1805 (void)XSetErrorHandler(old_handler);
1806
1807 if (p_verbose > 0 && got_x_error)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001808 verb_msg(_("Testing the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809
1810 return (got_x_error ? FAIL : OK);
1811}
1812#endif
1813
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814
1815#ifdef FEAT_X11
1816
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01001817static int get_x11_thing(int get_title, int test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
1819/*
1820 * try to get x11 window and display
1821 *
1822 * return FAIL for failure, OK otherwise
1823 */
1824 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001825get_x11_windis(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826{
1827 char *winid;
1828 static int result = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001829#define XD_NONE 0 // x11_display not set here
1830#define XD_HERE 1 // x11_display opened here
1831#define XD_GUI 2 // x11_display used from gui.dpy
1832#define XD_XTERM 3 // x11_display used from xterm_dpy
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 static int x11_display_from = XD_NONE;
1834 static int did_set_error_handler = FALSE;
1835
1836 if (!did_set_error_handler)
1837 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001838 // X just exits if it finds an error otherwise!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 (void)XSetErrorHandler(x_error_handler);
1840 did_set_error_handler = TRUE;
1841 }
1842
Bram Moolenaar9372a112005-12-06 19:59:18 +00001843#if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 if (gui.in_use)
1845 {
1846 /*
1847 * If the X11 display was opened here before, for the window where Vim
1848 * was started, close that one now to avoid a memory leak.
1849 */
1850 if (x11_display_from == XD_HERE && x11_display != NULL)
1851 {
1852 XCloseDisplay(x11_display);
1853 x11_display_from = XD_NONE;
1854 }
1855 if (gui_get_x11_windis(&x11_window, &x11_display) == OK)
1856 {
1857 x11_display_from = XD_GUI;
1858 return OK;
1859 }
1860 x11_display = NULL;
1861 return FAIL;
1862 }
1863 else if (x11_display_from == XD_GUI)
1864 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001865 // GUI must have stopped somehow, clear x11_display
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 x11_window = 0;
1867 x11_display = NULL;
1868 x11_display_from = XD_NONE;
1869 }
1870#endif
1871
Bram Moolenaar0f873732019-12-05 20:28:46 +01001872 // When started with the "-X" argument, don't try connecting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 if (!x_connect_to_server())
1874 return FAIL;
1875
1876 /*
1877 * If WINDOWID not set, should try another method to find out
1878 * what the current window number is. The only code I know for
1879 * this is very complicated.
1880 * We assume that zero is invalid for WINDOWID.
1881 */
1882 if (x11_window == 0 && (winid = getenv("WINDOWID")) != NULL)
1883 x11_window = (Window)atol(winid);
1884
1885#ifdef FEAT_XCLIPBOARD
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001886 if (xterm_dpy == x11_display)
1887 // x11_display may have been set to xterm_dpy elsewhere
1888 x11_display_from = XD_XTERM;
1889
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 if (xterm_dpy != NULL && x11_window != 0)
1891 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001892 // We may have checked it already, but Gnome terminal can move us to
1893 // another window, so we need to check every time.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00001894 if (x11_display_from != XD_XTERM)
1895 {
1896 /*
1897 * If the X11 display was opened here before, for the window where
1898 * Vim was started, close that one now to avoid a memory leak.
1899 */
1900 if (x11_display_from == XD_HERE && x11_display != NULL)
1901 XCloseDisplay(x11_display);
1902 x11_display = xterm_dpy;
1903 x11_display_from = XD_XTERM;
1904 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 if (test_x11_window(x11_display) == FAIL)
1906 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001907 // probably bad $WINDOWID
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 x11_window = 0;
1909 x11_display = NULL;
1910 x11_display_from = XD_NONE;
1911 return FAIL;
1912 }
1913 return OK;
1914 }
1915#endif
1916
1917 if (x11_window == 0 || x11_display == NULL)
1918 result = -1;
1919
Bram Moolenaar0f873732019-12-05 20:28:46 +01001920 if (result != -1) // Have already been here and set this
1921 return result; // Don't do all these X calls again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922
1923 if (x11_window != 0 && x11_display == NULL)
1924 {
1925#ifdef SET_SIG_ALARM
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001926 void (*sig_save)();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927#endif
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001928#ifdef ELAPSED_FUNC
1929 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930
1931 if (p_verbose > 0)
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001932 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933#endif
1934
1935#ifdef SET_SIG_ALARM
1936 /*
1937 * Opening the Display may hang if the DISPLAY setting is wrong, or
1938 * the network connection is bad. Set an alarm timer to get out.
1939 */
1940 sig_alarm_called = FALSE;
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001941 sig_save = (void (*)())signal(SIGALRM, (void (*)())sig_alarm);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 alarm(2);
1943#endif
1944 x11_display = XOpenDisplay(NULL);
1945
1946#ifdef SET_SIG_ALARM
1947 alarm(0);
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01001948 signal(SIGALRM, (void (*)())sig_save);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949 if (p_verbose > 0 && sig_alarm_called)
Bram Moolenaar563bbea2019-01-22 21:45:40 +01001950 verb_msg(_("Opening the X display timed out"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951#endif
1952 if (x11_display != NULL)
1953 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001954# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001956 {
1957 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001958 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001959 verbose_leave();
1960 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961# endif
1962 if (test_x11_window(x11_display) == FAIL)
1963 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001964 // Maybe window id is bad
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 x11_window = 0;
1966 XCloseDisplay(x11_display);
1967 x11_display = NULL;
1968 }
1969 else
1970 x11_display_from = XD_HERE;
1971 }
1972 }
1973 if (x11_window == 0 || x11_display == NULL)
1974 return (result = FAIL);
Bram Moolenaar727c8762010-10-20 19:17:48 +02001975
1976# ifdef FEAT_EVAL
1977 set_vim_var_nr(VV_WINDOWID, (long)x11_window);
1978# endif
1979
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 return (result = OK);
1981}
1982
1983/*
1984 * Determine original x11 Window Title
1985 */
1986 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001987get_x11_title(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988{
Bram Moolenaar47136d72004-10-12 20:02:24 +00001989 return get_x11_thing(TRUE, test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990}
1991
1992/*
1993 * Determine original x11 Window icon
1994 */
1995 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001996get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997{
1998 int retval = FALSE;
1999
2000 retval = get_x11_thing(FALSE, test_only);
2001
Bram Moolenaar0f873732019-12-05 20:28:46 +01002002 // could not get old icon, use terminal name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 if (oldicon == NULL && !test_only)
2004 {
2005 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002006 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002008 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 }
2010
2011 return retval;
2012}
2013
2014 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01002015get_x11_thing(
Bram Moolenaar0f873732019-12-05 20:28:46 +01002016 int get_title, // get title string
Bram Moolenaar05540972016-01-30 20:31:25 +01002017 int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018{
2019 XTextProperty text_prop;
2020 int retval = FALSE;
2021 Status status;
2022
2023 if (get_x11_windis() == OK)
2024 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002025 // Get window/icon name if any
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 if (get_title)
2027 status = XGetWMName(x11_display, x11_window, &text_prop);
2028 else
2029 status = XGetWMIconName(x11_display, x11_window, &text_prop);
2030
2031 /*
2032 * If terminal is xterm, then x11_window may be a child window of the
2033 * outer xterm window that actually contains the window/icon name, so
2034 * keep traversing up the tree until a window with a title/icon is
2035 * found.
2036 */
Bram Moolenaar4b96df52020-01-26 22:00:26 +01002037 // Previously this was only done for xterm and alike. I don't see a
Bram Moolenaar0f873732019-12-05 20:28:46 +01002038 // reason why it would fail for other terminal emulators.
2039 // if (term_is_xterm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 {
2041 Window root;
2042 Window parent;
2043 Window win = x11_window;
2044 Window *children;
2045 unsigned int num_children;
2046
2047 while (!status || text_prop.value == NULL)
2048 {
2049 if (!XQueryTree(x11_display, win, &root, &parent, &children,
2050 &num_children))
2051 break;
2052 if (children)
2053 XFree((void *)children);
2054 if (parent == root || parent == 0)
2055 break;
2056
2057 win = parent;
2058 if (get_title)
2059 status = XGetWMName(x11_display, win, &text_prop);
2060 else
2061 status = XGetWMIconName(x11_display, win, &text_prop);
2062 }
2063 }
2064 if (status && text_prop.value != NULL)
2065 {
2066 retval = TRUE;
2067 if (!test_only)
2068 {
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002069 if (get_title)
2070 vim_free(oldtitle);
2071 else
2072 vim_free(oldicon);
Bram Moolenaara12a1612019-01-24 16:39:02 +01002073 if (text_prop.encoding == XA_STRING && !has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 if (get_title)
2076 oldtitle = vim_strsave((char_u *)text_prop.value);
2077 else
2078 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 }
2080 else
2081 {
2082 char **cl;
2083 Status transform_status;
2084 int n = 0;
2085
2086 transform_status = XmbTextPropertyToTextList(x11_display,
2087 &text_prop,
2088 &cl, &n);
2089 if (transform_status >= Success && n > 0 && cl[0])
2090 {
2091 if (get_title)
2092 oldtitle = vim_strsave((char_u *) cl[0]);
2093 else
2094 oldicon = vim_strsave((char_u *) cl[0]);
2095 XFreeStringList(cl);
2096 }
2097 else
2098 {
2099 if (get_title)
2100 oldtitle = vim_strsave((char_u *)text_prop.value);
2101 else
2102 oldicon = vim_strsave((char_u *)text_prop.value);
2103 }
2104 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 }
2106 XFree((void *)text_prop.value);
2107 }
2108 }
2109 return retval;
2110}
2111
Bram Moolenaar0f873732019-12-05 20:28:46 +01002112// Xutf8 functions are not available on older systems. Note that on some
2113// systems X_HAVE_UTF8_STRING may be defined in a header file but
2114// Xutf8SetWMProperties() is not in the X11 library. Configure checks for
2115// that and defines HAVE_XUTF8SETWMPROPERTIES.
Bram Moolenaara12a1612019-01-24 16:39:02 +01002116#if defined(X_HAVE_UTF8_STRING)
Bram Moolenaarcbc246a2014-10-11 14:47:26 +02002117# if X_HAVE_UTF8_STRING && HAVE_XUTF8SETWMPROPERTIES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118# define USE_UTF8_STRING
2119# endif
2120#endif
2121
2122/*
2123 * Set x11 Window Title
2124 *
2125 * get_x11_windis() must be called before this and have returned OK
2126 */
2127 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002128set_x11_title(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002130 // XmbSetWMProperties() and Xutf8SetWMProperties() should use a STRING
2131 // when possible, COMPOUND_TEXT otherwise. COMPOUND_TEXT isn't
2132 // supported everywhere and STRING doesn't work for multi-byte titles.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133#ifdef USE_UTF8_STRING
2134 if (enc_utf8)
2135 Xutf8SetWMProperties(x11_display, x11_window, (const char *)title,
2136 NULL, NULL, 0, NULL, NULL, NULL);
2137 else
2138#endif
2139 {
2140#if XtSpecificationRelease >= 4
2141# ifdef FEAT_XFONTSET
2142 XmbSetWMProperties(x11_display, x11_window, (const char *)title,
2143 NULL, NULL, 0, NULL, NULL, NULL);
2144# else
2145 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002146 char *c_title = (char *)title;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147
Bram Moolenaar0f873732019-12-05 20:28:46 +01002148 // directly from example 3-18 "basicwin" of Xlib Programming Manual
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002149 (void)XStringListToTextProperty(&c_title, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 XSetWMProperties(x11_display, x11_window, &text_prop,
2151 NULL, NULL, 0, NULL, NULL, NULL);
2152# endif
2153#else
2154 XStoreName(x11_display, x11_window, (char *)title);
2155#endif
2156 }
2157 XFlush(x11_display);
2158}
2159
2160/*
2161 * Set x11 Window icon
2162 *
2163 * get_x11_windis() must be called before this and have returned OK
2164 */
2165 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002166set_x11_icon(char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002168 // See above for comments about using X*SetWMProperties().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169#ifdef USE_UTF8_STRING
2170 if (enc_utf8)
2171 Xutf8SetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2172 NULL, 0, NULL, NULL, NULL);
2173 else
2174#endif
2175 {
2176#if XtSpecificationRelease >= 4
2177# ifdef FEAT_XFONTSET
2178 XmbSetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2179 NULL, 0, NULL, NULL, NULL);
2180# else
2181 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002182 char *c_icon = (char *)icon;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002184 (void)XStringListToTextProperty(&c_icon, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 XSetWMProperties(x11_display, x11_window, NULL, &text_prop,
2186 NULL, 0, NULL, NULL, NULL);
2187# endif
2188#else
2189 XSetIconName(x11_display, x11_window, (char *)icon);
2190#endif
2191 }
2192 XFlush(x11_display);
2193}
2194
Bram Moolenaar0f873732019-12-05 20:28:46 +01002195#else // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002198get_x11_title(int test_only UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199{
2200 return FALSE;
2201}
2202
2203 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002204get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205{
2206 if (!test_only)
2207 {
2208 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002209 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002211 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 }
2213 return FALSE;
2214}
2215
Bram Moolenaar0f873732019-12-05 20:28:46 +01002216#endif // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
2218 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002219mch_can_restore_title(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220{
2221 return get_x11_title(TRUE);
2222}
2223
2224 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002225mch_can_restore_icon(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226{
2227 return get_x11_icon(TRUE);
2228}
2229
2230/*
2231 * Set the window title and icon.
2232 */
2233 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002234mch_settitle(char_u *title, char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235{
2236 int type = 0;
2237 static int recursive = 0;
2238
Bram Moolenaar0f873732019-12-05 20:28:46 +01002239 if (T_NAME == NULL) // no terminal name (yet)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 return;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002241 if (title == NULL && icon == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 return;
2243
Bram Moolenaar0f873732019-12-05 20:28:46 +01002244 // When one of the X11 functions causes a deadly signal, we get here again
2245 // recursively. Avoid hanging then (something is probably locked).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 if (recursive)
2247 return;
2248 ++recursive;
2249
2250 /*
2251 * if the window ID and the display is known, we may use X11 calls
2252 */
2253#ifdef FEAT_X11
2254 if (get_x11_windis() == OK)
2255 type = 1;
2256#else
Bram Moolenaar097148e2020-08-11 21:58:20 +02002257# if defined(FEAT_GUI_PHOTON) \
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002258 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 if (gui.in_use)
2260 type = 1;
2261# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262#endif
2263
2264 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002265 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 * than x11 calls, because the x11 calls don't always work
2267 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 if ((type || *T_TS != NUL) && title != NULL)
2269 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002270 if (oldtitle_outdated)
2271 {
2272 oldtitle_outdated = FALSE;
2273 VIM_CLEAR(oldtitle);
2274 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 if (oldtitle == NULL
2276#ifdef FEAT_GUI
2277 && !gui.in_use
2278#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002279 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 (void)get_x11_title(FALSE);
2281
Bram Moolenaar0f873732019-12-05 20:28:46 +01002282 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 term_settitle(title);
2284#ifdef FEAT_X11
2285 else
2286# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002287 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002289 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002291#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar097148e2020-08-11 21:58:20 +02002292 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 else
2294 gui_mch_settitle(title, icon);
2295#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002296 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 }
2298
2299 if ((type || *T_CIS != NUL) && icon != NULL)
2300 {
2301 if (oldicon == NULL
2302#ifdef FEAT_GUI
2303 && !gui.in_use
2304#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002305 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 get_x11_icon(FALSE);
2307
2308 if (*T_CIS != NUL)
2309 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002310 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002312 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 out_flush();
2314 }
2315#ifdef FEAT_X11
2316 else
2317# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002318 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002320 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321#endif
2322 did_set_icon = TRUE;
2323 }
2324 --recursive;
2325}
2326
2327/*
2328 * Restore the window/icon title.
2329 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002330 * SAVE_RESTORE_TITLE only restore title
2331 * SAVE_RESTORE_ICON only restore icon
2332 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 */
2334 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002335mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336{
Bram Moolenaardac13472019-09-16 21:06:21 +02002337 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002338
Bram Moolenaar0f873732019-12-05 20:28:46 +01002339 // only restore the title or icon when it has been set
Bram Moolenaardac13472019-09-16 21:06:21 +02002340 mch_settitle(((which & SAVE_RESTORE_TITLE) && unix_did_set_title) ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 (oldtitle ? oldtitle : p_titleold) : NULL,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002342 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
2343
Bram Moolenaare5c83282019-05-03 23:15:37 +02002344 if (do_push_pop)
2345 {
2346 // pop and push from/to the stack
2347 term_pop_title(which);
2348 term_push_title(which);
2349 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350}
2351
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352
2353/*
2354 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002355 * This matches "xterm.*", thus "xterm-256color", "xterm-kitty", etc.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002356 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 */
2358 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002359vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360{
2361 if (name == NULL)
2362 return FALSE;
2363 return (STRNICMP(name, "xterm", 5) == 0
2364 || STRNICMP(name, "nxterm", 6) == 0
2365 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002366 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002368 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 || STRCMP(name, "builtin_xterm") == 0);
2370}
2371
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002372#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2373/*
2374 * Return TRUE if "name" appears to be that of a terminal
2375 * known to support the xterm-style mouse protocol.
2376 * Relies on term_is_xterm having been set to its correct value.
2377 */
2378 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002379use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002380{
2381 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002382 && (term_is_xterm
2383 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002384 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar48873ae2021-12-08 21:00:24 +00002385 || STRNICMP(name, "gnome", 5) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002386 || STRICMP(name, "st") == 0
2387 || STRNICMP(name, "st-", 3) == 0
2388 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002389}
2390#endif
2391
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392/*
2393 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2394 * Return 1 for "xterm".
2395 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002396 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002397 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 */
2399 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002400use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002402 if (ttym_flags == TTYM_SGR)
2403 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002404 if (ttym_flags == TTYM_URXVT)
2405 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 if (ttym_flags == TTYM_XTERM2)
2407 return 2;
2408 if (ttym_flags == TTYM_XTERM)
2409 return 1;
2410 return 0;
2411}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002413/*
2414 * Return TRUE if "name" is an iris-ansi terminal name.
2415 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002417vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418{
2419 if (name == NULL)
2420 return FALSE;
2421 return (STRNICMP(name, "iris-ansi", 9) == 0
2422 || STRCMP(name, "builtin_iris-ansi") == 0);
2423}
2424
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002425/*
2426 * Return TRUE if "name" is a vt300-like terminal name.
2427 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002429vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430{
2431 if (name == NULL)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002432 return FALSE;
2433 // Actually all ANSI compatible terminals should be here.
2434 // Catch at least VT1xx - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002435 return ((STRNICMP(name, "vt", 2) == 0
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002436 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 || STRCMP(name, "builtin_vt320") == 0);
2438}
2439
2440/*
2441 * Return TRUE if "name" is a terminal for which 'ttyfast' should be set.
2442 * This should include all windowed terminal emulators.
2443 */
2444 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002445vim_is_fastterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446{
2447 if (name == NULL)
2448 return FALSE;
2449 if (vim_is_xterm(name) || vim_is_vt300(name) || vim_is_iris(name))
2450 return TRUE;
2451 return ( STRNICMP(name, "hpterm", 6) == 0
2452 || STRNICMP(name, "sun-cmd", 7) == 0
2453 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002454 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 || STRNICMP(name, "dtterm", 6) == 0);
2456}
2457
2458/*
2459 * Insert user name in s[len].
2460 * Return OK if a name found.
2461 */
2462 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002463mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464{
2465#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002466 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 return OK;
2468#else
2469 return mch_get_uname(getuid(), s, len);
2470#endif
2471}
2472
2473/*
2474 * Insert user name for "uid" in s[len].
2475 * Return OK if a name found.
2476 */
2477 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002478mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479{
2480#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2481 struct passwd *pw;
2482
2483 if ((pw = getpwuid(uid)) != NULL
2484 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2485 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002486 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 return OK;
2488 }
2489#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002490 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2491 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492}
2493
2494/*
2495 * Insert host name is s[len].
2496 */
2497
2498#ifdef HAVE_SYS_UTSNAME_H
2499 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002500mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501{
2502 struct utsname vutsname;
2503
2504 if (uname(&vutsname) < 0)
2505 *s = NUL;
2506 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002507 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002509#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510
2511# ifdef HAVE_SYS_SYSTEMINFO_H
2512# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2513# endif
2514
2515 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002516mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517{
2518# ifdef VAXC
2519 vaxc$gethostname((char *)s, len);
2520# else
2521 gethostname((char *)s, len);
2522# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002523 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002525#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526
2527/*
2528 * return process ID
2529 */
2530 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002531mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532{
2533 return (long)getpid();
2534}
2535
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002536/*
2537 * return TRUE if process "pid" is still running
2538 */
2539 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002540mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002541{
Bram Moolenaar44dea9d2021-06-23 21:13:20 +02002542 // If there is no error the process must be running.
2543 if (kill(pid, 0) == 0)
2544 return TRUE;
2545#ifdef ESRCH
2546 // If the error is ESRCH then the process is not running.
2547 if (errno == ESRCH)
2548 return FALSE;
2549#endif
2550 // If the process is running and owned by another user we get EPERM. With
2551 // other errors the process might be running, assuming it is then.
2552 return TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002553}
2554
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002557strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558{
2559 extern int sys_nerr;
2560 extern char *sys_errlist[];
2561 static char er[20];
2562
2563 if (err > 0 && err < sys_nerr)
2564 return (sys_errlist[err]);
2565 sprintf(er, "Error %d", err);
2566 return er;
2567}
2568#endif
2569
2570/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002571 * Get name of current directory into buffer "buf" of length "len" bytes.
2572 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 * Return OK for success, FAIL for failure.
2574 */
2575 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002576mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577{
2578#if defined(USE_GETCWD)
2579 if (getcwd((char *)buf, len) == NULL)
2580 {
2581 STRCPY(buf, strerror(errno));
2582 return FAIL;
2583 }
2584 return OK;
2585#else
2586 return (getwd((char *)buf) != NULL ? OK : FAIL);
2587#endif
2588}
2589
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002591 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 *
2593 * return FAIL for failure, OK for success
2594 */
2595 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002596mch_FullName(
2597 char_u *fname,
2598 char_u *buf,
2599 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002600 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601{
2602 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002603#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002605 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002606#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 char_u olddir[MAXPATHL];
2608 char_u *p;
2609 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002610#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002611 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2612 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002613#endif
2614
Bram Moolenaar38323e42007-03-06 19:22:53 +00002615#ifdef VMS
2616 fname = vms_fixfilename(fname);
2617#endif
2618
Bram Moolenaara2442432007-04-26 14:26:37 +00002619#ifdef __CYGWIN__
2620 /*
2621 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2622 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002623# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002624 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2625 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002626 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2627 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002628# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002629 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002630# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002631 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002632#endif
2633
Bram Moolenaar0f873732019-12-05 20:28:46 +01002634 // Expand it if forced or not an absolute path.
2635 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002636 if ((force || !mch_isFullName(fname))
2637 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 {
2639 /*
2640 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002641 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 * This will get the correct path name with "../" things.
2643 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002644 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 {
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002646 if (STRCMP(p, "/..") == 0)
2647 // for "/path/dir/.." include the "/.."
2648 p += 3;
2649
Bram Moolenaar38323e42007-03-06 19:22:53 +00002650#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 /*
2652 * Use fchdir() if possible, it's said to be faster and more
2653 * reliable. But on SunOS 4 it might not work. Check this by
2654 * doing a fchdir() right now.
2655 */
2656 if (!dont_fchdir)
2657 {
2658 fd = open(".", O_RDONLY | O_EXTRA, 0);
2659 if (fd >= 0 && fchdir(fd) < 0)
2660 {
2661 close(fd);
2662 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002663 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 }
2665 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002666#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667
Bram Moolenaar0f873732019-12-05 20:28:46 +01002668 // Only change directory when we are sure we can return to where
2669 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002671#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002673#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 (mch_dirname(olddir, MAXPATHL) == FAIL
2675 || mch_chdir((char *)olddir) != 0))
2676 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002677 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 retval = FAIL;
2679 }
2680 else
2681 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002682 // The directory is copied into buf[], to be able to remove
2683 // the file name without changing it (could be a string in
2684 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 if (p - fname >= len)
2686 retval = FAIL;
2687 else
2688 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002689 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 if (mch_chdir((char *)buf))
Bram Moolenaarc6376c72021-10-03 19:29:48 +01002691 {
2692 // Path does not exist (yet). For a full path fail,
2693 // will use the path as-is. For a relative path use
2694 // the current directory and append the file name.
2695 if (mch_isFullName(fname))
2696 retval = FAIL;
2697 else
2698 p = NULL;
2699 }
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002700 else if (*p == '/')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 fname = p + 1;
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002702 else
2703 fname = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 *buf = NUL;
2705 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 }
2707 }
2708 if (mch_dirname(buf, len) == FAIL)
2709 {
2710 retval = FAIL;
2711 *buf = NUL;
2712 }
2713 if (p != NULL)
2714 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002715#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 if (fd >= 0)
2717 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002718 if (p_verbose >= 5)
2719 {
2720 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002721 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002722 verbose_leave();
2723 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 l = fchdir(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 }
2726 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002727#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 l = mch_chdir((char *)olddir);
2729 if (l != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002730 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 }
itchyny051a40c2021-10-20 10:00:05 +01002732#ifdef HAVE_FCHDIR
2733 if (fd >= 0)
2734 close(fd);
2735#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736
2737 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002738 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002739 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002740#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002741 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002743 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002744#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002746
Bram Moolenaar0f873732019-12-05 20:28:46 +01002747 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002748 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 return FAIL;
2750
Bram Moolenaar0f873732019-12-05 20:28:46 +01002751 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 if (STRCMP(fname, ".") != 0)
2753 STRCAT(buf, fname);
2754
2755 return OK;
2756}
2757
2758/*
2759 * Return TRUE if "fname" does not depend on the current directory.
2760 */
2761 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002762mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002764#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 return ( fname[0] == '/' || fname[0] == '.' ||
2766 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2767 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2768 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002769#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771#endif
2772}
2773
Bram Moolenaar24552be2005-12-10 20:17:30 +00002774#if defined(USE_FNAME_CASE) || defined(PROTO)
2775/*
2776 * Set the case of the file name, if it already exists. This will cause the
2777 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002778 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002779 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002780 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002781fname_case(
2782 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002783 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002784{
2785 struct stat st;
2786 char_u *slash, *tail;
2787 DIR *dirp;
2788 struct dirent *dp;
2789
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002790 if (mch_lstat((char *)name, &st) >= 0)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002791 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002792 // Open the directory where the file is located.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002793 slash = vim_strrchr(name, '/');
2794 if (slash == NULL)
2795 {
2796 dirp = opendir(".");
2797 tail = name;
2798 }
2799 else
2800 {
2801 *slash = NUL;
2802 dirp = opendir((char *)name);
2803 *slash = '/';
2804 tail = slash + 1;
2805 }
2806
2807 if (dirp != NULL)
2808 {
2809 while ((dp = readdir(dirp)) != NULL)
2810 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002811 // Only accept names that differ in case and are the same byte
2812 // length. TODO: accept different length name.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002813 if (STRICMP(tail, dp->d_name) == 0
2814 && STRLEN(tail) == STRLEN(dp->d_name))
2815 {
2816 char_u newname[MAXPATHL + 1];
2817 struct stat st2;
2818
Bram Moolenaar0f873732019-12-05 20:28:46 +01002819 // Verify the inode is equal.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002820 vim_strncpy(newname, name, MAXPATHL);
2821 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2822 MAXPATHL - (tail - name));
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002823 if (mch_lstat((char *)newname, &st2) >= 0
Bram Moolenaar24552be2005-12-10 20:17:30 +00002824 && st.st_ino == st2.st_ino
2825 && st.st_dev == st2.st_dev)
2826 {
2827 STRCPY(tail, dp->d_name);
2828 break;
2829 }
2830 }
2831 }
2832
2833 closedir(dirp);
2834 }
2835 }
2836}
2837#endif
2838
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839/*
2840 * Get file permissions for 'name'.
2841 * Returns -1 when it doesn't exist.
2842 */
2843 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002844mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845{
2846 struct stat statb;
2847
Bram Moolenaar0f873732019-12-05 20:28:46 +01002848 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849#ifdef VMS
2850 if (stat((char *)vms_fixfilename(name), &statb))
2851#else
2852 if (stat((char *)name, &statb))
2853#endif
2854 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002855#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002856 // The top bit makes the value negative, which means the file doesn't
2857 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002858 return statb.st_mode & ~S_ADDACE;
2859#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002861#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862}
2863
2864/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002865 * Set file permission for "name" to "perm".
2866 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 */
2868 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002869mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870{
2871 return (chmod((char *)
2872#ifdef VMS
2873 vms_fixfilename(name),
2874#else
2875 name,
2876#endif
2877 (mode_t)perm) == 0 ? OK : FAIL);
2878}
2879
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002880#if defined(HAVE_FCHMOD) || defined(PROTO)
2881/*
2882 * Set file permission for open file "fd" to "perm".
2883 * Return FAIL for failure, OK otherwise.
2884 */
2885 int
2886mch_fsetperm(int fd, long perm)
2887{
2888 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2889}
2890#endif
2891
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892#if defined(HAVE_ACL) || defined(PROTO)
2893# ifdef HAVE_SYS_ACL_H
2894# include <sys/acl.h>
2895# endif
2896# ifdef HAVE_SYS_ACCESS_H
2897# include <sys/access.h>
2898# endif
2899
2900# ifdef HAVE_SOLARIS_ACL
2901typedef struct vim_acl_solaris_T {
2902 int acl_cnt;
2903 aclent_t *acl_entry;
2904} vim_acl_solaris_T;
2905# endif
2906
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002907#if defined(HAVE_SELINUX) || defined(PROTO)
2908/*
2909 * Copy security info from "from_file" to "to_file".
2910 */
2911 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002912mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002913{
2914 if (from_file == NULL)
2915 return;
2916
2917 if (selinux_enabled == -1)
2918 selinux_enabled = is_selinux_enabled();
2919
2920 if (selinux_enabled > 0)
2921 {
Bram Moolenaar89560232020-10-09 23:04:47 +02002922 // Use "char *" instead of "security_context_t" to avoid a deprecation
2923 // warning.
2924 char *from_context = NULL;
2925 char *to_context = NULL;
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002926
2927 if (getfilecon((char *)from_file, &from_context) < 0)
2928 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002929 // If the filesystem doesn't support extended attributes,
2930 // the original had no special security context and the
2931 // target cannot have one either.
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002932 if (errno == EOPNOTSUPP)
2933 return;
2934
Bram Moolenaar32526b32019-01-19 17:43:09 +01002935 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002936 msg_outtrans(from_file);
2937 msg_putchar('\n');
2938 return;
2939 }
2940 if (getfilecon((char *)to_file, &to_context) < 0)
2941 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002942 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002943 msg_outtrans(to_file);
2944 msg_putchar('\n');
2945 freecon (from_context);
2946 return ;
2947 }
2948 if (strcmp(from_context, to_context) != 0)
2949 {
2950 if (setfilecon((char *)to_file, from_context) < 0)
2951 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002952 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002953 msg_outtrans(to_file);
2954 msg_putchar('\n');
2955 }
2956 }
2957 freecon(to_context);
2958 freecon(from_context);
2959 }
2960}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002961#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002962
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002963#if defined(HAVE_SMACK) && !defined(PROTO)
2964/*
2965 * Copy security info from "from_file" to "to_file".
2966 */
2967 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002968mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002969{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002970 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002971 {
2972 XATTR_NAME_SMACK,
2973 XATTR_NAME_SMACKEXEC,
2974 XATTR_NAME_SMACKMMAP
2975 };
2976
2977 char buffer[SMACK_LABEL_LEN];
2978 const char *name;
2979 int index;
2980 int ret;
2981 ssize_t size;
2982
2983 if (from_file == NULL)
2984 return;
2985
2986 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2987 / sizeof(smack_copied_attributes)[0]) ; index++)
2988 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002989 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002990 name = smack_copied_attributes[index];
2991
Bram Moolenaar0f873732019-12-05 20:28:46 +01002992 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002993 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2994 if (size >= 0)
2995 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002996 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002997 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2998 if (ret < 0)
2999 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003000 vim_snprintf((char *)IObuff, IOSIZE,
3001 _("Could not set security context %s for %s"),
3002 name, to_file);
3003 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003004 msg_putchar('\n');
3005 }
3006 }
3007 else
3008 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003009 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003010 switch (errno)
3011 {
3012 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003013 // extended attributes aren't supported or enabled
3014 // should a message be echoed? not sure...
3015 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003016
3017 case ERANGE:
3018 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003019 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003020 vim_snprintf((char *)IObuff, IOSIZE,
3021 _("Could not get security context %s for %s. Removing it!"),
3022 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003023 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003024 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01003025 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003026
3027 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003028 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003029 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003030 // Silently ignore errors, apparently this happens when
3031 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003032 break;
3033 }
3034 }
3035 }
3036}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003037#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003038
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039/*
3040 * Return a pointer to the ACL of file "fname" in allocated memory.
3041 * Return NULL if the ACL is not available for whatever reason.
3042 */
3043 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01003044mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045{
3046 vim_acl_T ret = NULL;
3047#ifdef HAVE_POSIX_ACL
3048 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
3049#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003050#ifdef HAVE_SOLARIS_ZFS_ACL
3051 acl_t *aclent;
3052
3053 if (acl_get((char *)fname, 0, &aclent) < 0)
3054 return NULL;
3055 ret = (vim_acl_T)aclent;
3056#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057#ifdef HAVE_SOLARIS_ACL
3058 vim_acl_solaris_T *aclent;
3059
3060 aclent = malloc(sizeof(vim_acl_solaris_T));
3061 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
3062 {
3063 free(aclent);
3064 return NULL;
3065 }
3066 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
3067 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
3068 {
3069 free(aclent->acl_entry);
3070 free(aclent);
3071 return NULL;
3072 }
3073 ret = (vim_acl_T)aclent;
3074#else
3075#if defined(HAVE_AIX_ACL)
3076 int aclsize;
3077 struct acl *aclent;
3078
3079 aclsize = sizeof(struct acl);
3080 aclent = malloc(aclsize);
3081 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3082 {
3083 if (errno == ENOSPC)
3084 {
3085 aclsize = aclent->acl_len;
3086 aclent = realloc(aclent, aclsize);
3087 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3088 {
3089 free(aclent);
3090 return NULL;
3091 }
3092 }
3093 else
3094 {
3095 free(aclent);
3096 return NULL;
3097 }
3098 }
3099 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003100#endif // HAVE_AIX_ACL
3101#endif // HAVE_SOLARIS_ACL
3102#endif // HAVE_SOLARIS_ZFS_ACL
3103#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 return ret;
3105}
3106
3107/*
3108 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3109 */
3110 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003111mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112{
3113 if (aclent == NULL)
3114 return;
3115#ifdef HAVE_POSIX_ACL
3116 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3117#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003118#ifdef HAVE_SOLARIS_ZFS_ACL
3119 acl_set((char *)fname, (acl_t *)aclent);
3120#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121#ifdef HAVE_SOLARIS_ACL
3122 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3123 ((vim_acl_solaris_T *)aclent)->acl_entry);
3124#else
3125#ifdef HAVE_AIX_ACL
3126 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003127#endif // HAVE_AIX_ACL
3128#endif // HAVE_SOLARIS_ACL
3129#endif // HAVE_SOLARIS_ZFS_ACL
3130#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131}
3132
3133 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003134mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135{
3136 if (aclent == NULL)
3137 return;
3138#ifdef HAVE_POSIX_ACL
3139 acl_free((acl_t)aclent);
3140#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003141#ifdef HAVE_SOLARIS_ZFS_ACL
3142 acl_free((acl_t *)aclent);
3143#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144#ifdef HAVE_SOLARIS_ACL
3145 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3146 free(aclent);
3147#else
3148#ifdef HAVE_AIX_ACL
3149 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003150#endif // HAVE_AIX_ACL
3151#endif // HAVE_SOLARIS_ACL
3152#endif // HAVE_SOLARIS_ZFS_ACL
3153#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154}
3155#endif
3156
3157/*
3158 * Set hidden flag for "name".
3159 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003161mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003163 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164}
3165
3166/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003167 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 * return FALSE if "name" is not a directory
3169 * return FALSE for error
3170 */
3171 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003172mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173{
3174 struct stat statb;
3175
Bram Moolenaar0f873732019-12-05 20:28:46 +01003176 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 return FALSE;
3178 if (stat((char *)name, &statb))
3179 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181}
3182
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003183/*
3184 * return TRUE if "name" is a directory, NOT a symlink to a directory
3185 * return FALSE if "name" is not a directory
3186 * return FALSE for error
3187 */
3188 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003189mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003190{
3191 struct stat statb;
3192
Bram Moolenaar0f873732019-12-05 20:28:46 +01003193 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003194 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003195 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003196 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003197 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003198}
3199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200/*
3201 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3202 */
3203 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003204executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205{
3206 struct stat st;
3207
3208 if (stat((char *)name, &st))
3209 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003210#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003211 // Like on Unix system file can have executable rights but not necessarily
3212 // be an executable, but on Unix is not a default for an ordinary file to
3213 // have an executable flag - on VMS it is in most cases.
3214 // Therefore, this check does not have any sense - let keep us to the
3215 // conventions instead:
3216 // *.COM and *.EXE files are the executables - the rest are not. This is
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00003217 // not ideal but better than it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003218 int vms_executable = 0;
3219 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3220 {
3221 if (strstr(vms_tolower((char*)name),".exe") != NULL
3222 || strstr(vms_tolower((char*)name),".com")!= NULL)
3223 vms_executable = 1;
3224 }
3225 return vms_executable;
3226#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003228#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229}
3230
3231/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003232 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003233 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 * Return -1 if unknown.
3235 */
3236 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003237mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238{
3239 char_u *buf;
3240 char_u *p, *e;
3241 int retval;
3242
Bram Moolenaar0f873732019-12-05 20:28:46 +01003243 // When "use_path" is false and if it's an absolute or relative path don't
3244 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003245 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003246 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003247 // There must be a path separator, files in the current directory
3248 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003249 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003250 {
3251 if (path != NULL)
3252 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003253 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003254 *path = FullName_save(name, TRUE);
3255 else
3256 *path = vim_strsave(name);
3257 }
3258 return TRUE;
3259 }
3260 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003261 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
3263 p = (char_u *)getenv("PATH");
3264 if (p == NULL || *p == NUL)
3265 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003266 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 if (buf == NULL)
3268 return -1;
3269
3270 /*
3271 * Walk through all entries in $PATH to check if "name" exists there and
3272 * is an executable file.
3273 */
3274 for (;;)
3275 {
3276 e = (char_u *)strchr((char *)p, ':');
3277 if (e == NULL)
3278 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003279 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 STRCPY(buf, "./");
3281 else
3282 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003283 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 add_pathsep(buf);
3285 }
3286 STRCAT(buf, name);
3287 retval = executable_file(buf);
3288 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003289 {
3290 if (path != NULL)
3291 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003292 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003293 *path = FullName_save(buf, TRUE);
3294 else
3295 *path = vim_strsave(buf);
3296 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003298 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299
3300 if (*e != ':')
3301 break;
3302 p = e + 1;
3303 }
3304
3305 vim_free(buf);
3306 return retval;
3307}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308
3309/*
3310 * Check what "name" is:
3311 * NODE_NORMAL: file or directory (or doesn't exist)
3312 * NODE_WRITABLE: writable device, socket, fifo, etc.
3313 * NODE_OTHER: non-writable things
3314 */
3315 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003316mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317{
3318 struct stat st;
3319
3320 if (stat((char *)name, &st))
3321 return NODE_NORMAL;
3322 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3323 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003324 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003326 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 return NODE_WRITABLE;
3328}
3329
3330 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003331mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332{
3333#ifdef HAVE_CHECK_STACK_GROWTH
3334 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 check_stack_growth((char *)&i);
3337
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003338# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 get_stack_limit();
3340# endif
3341
3342#endif
3343
3344 /*
3345 * Setup an alternative stack for signals. Helps to catch signals when
3346 * running out of stack space.
3347 * Use of sigaltstack() is preferred, it's more portable.
3348 * Ignore any errors.
3349 */
3350#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +02003351 signal_stack = alloc(get_signal_stack_size());
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 init_signal_stack();
3353#endif
3354}
3355
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003356#if defined(EXITFREE) || defined(PROTO)
3357 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003358mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003359{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003360# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3361 if (clip_star.owned)
3362 clip_lose_selection(&clip_star);
3363 if (clip_plus.owned)
3364 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003365# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003366# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003367 if (xterm_Shell != (Widget)0)
3368 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003369# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003370 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003371 if (xterm_dpy != NULL)
3372 XtCloseDisplay(xterm_dpy);
3373 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003374 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003375 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003376# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003377 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003378# endif
3379 }
3380# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003381# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003382# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003383 if (x11_display != NULL
3384# ifdef FEAT_XCLIPBOARD
3385 && x11_display != xterm_dpy
3386# endif
3387 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003388 XCloseDisplay(x11_display);
3389# endif
3390# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003391 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003392# endif
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003393 vim_free(oldtitle);
3394 vim_free(oldicon);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003395}
3396#endif
3397
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398/*
3399 * Output a newline when exiting.
3400 * Make sure the newline goes to the same stream as the text.
3401 */
3402 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003403exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003405 if (silent_mode)
3406 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 if (newline_on_exit || msg_didout)
3408 {
3409 if (msg_use_printf())
3410 {
3411 if (info_message)
3412 mch_msg("\n");
3413 else
3414 mch_errmsg("\r\n");
3415 }
3416 else
3417 out_char('\n');
3418 }
Bram Moolenaar7007e312021-03-27 12:11:33 +01003419 else if (!is_not_a_term())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003421 restore_cterm_colors(); // get original colors back
3422 msg_clr_eos_force(); // clear the rest of the display
3423 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 }
3425}
3426
Bram Moolenaarb4151682020-05-11 22:13:28 +02003427#ifdef USE_GCOV_FLUSH
ichizokdee78e12021-12-09 21:08:01 +00003428# if (defined(__GNUC__) \
3429 && ((__GNUC__ == 11 && __GNUC_MINOR__ >= 1) || (__GNUC__ >= 12))) \
3430 || (defined(__clang__) && (__clang_major__ >= 12))
3431extern void __gcov_dump(void);
3432extern void __gcov_reset(void);
3433# define __gcov_flush() do { __gcov_dump(); __gcov_reset(); } while (0)
3434# else
3435extern void __gcov_flush(void);
3436# endif
Bram Moolenaarb4151682020-05-11 22:13:28 +02003437#endif
3438
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003440mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441{
3442 exiting = TRUE;
3443
3444#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3445 x11_export_final_selection();
3446#endif
3447
3448#ifdef FEAT_GUI
3449 if (!gui.in_use)
3450#endif
3451 {
3452 settmode(TMODE_COOK);
Bram Moolenaar7007e312021-03-27 12:11:33 +01003453 if (!is_not_a_term())
3454 {
3455 // restore xterm title and icon name
3456 mch_restore_title(SAVE_RESTORE_BOTH);
3457 term_pop_title(SAVE_RESTORE_BOTH);
3458 }
Bram Moolenaar651fca82021-11-29 20:39:38 +00003459
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 /*
3461 * When t_ti is not empty but it doesn't cause swapping terminal
3462 * pages, need to output a newline when msg_didout is set. But when
3463 * t_ti does swap pages it should not go to the shell page. Do this
3464 * before stoptermcap().
3465 */
3466 if (swapping_screen() && !newline_on_exit)
3467 exit_scroll();
3468
Bram Moolenaar0f873732019-12-05 20:28:46 +01003469 // Stop termcap: May need to check for T_CRV response, which
3470 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 stoptermcap();
3472
3473 /*
3474 * A newline is only required after a message in the alternate screen.
3475 * This is set to TRUE by wait_return().
3476 */
3477 if (!swapping_screen() || newline_on_exit)
3478 exit_scroll();
3479
Bram Moolenaar0f873732019-12-05 20:28:46 +01003480 // Cursor may have been switched off without calling starttermcap()
3481 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 if (full_screen)
3483 cursor_on();
3484 }
3485 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003486 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003487
3488#ifdef USE_GCOV_FLUSH
3489 // Flush coverage info before possibly being killed by a deadly signal.
3490 __gcov_flush();
3491#endif
3492
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 may_core_dump();
3494#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 gui_exit(r);
3497#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003498
Bram Moolenaar56718732006-03-15 22:53:57 +00003499#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003500 mac_conv_cleanup();
3501#endif
3502
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003504 // A core dump won't be created if the signal handler
3505 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 if (deadly_signal != 0)
3507 return;
3508#endif
3509
Bram Moolenaar009b2592004-10-24 19:18:58 +00003510#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003511 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003512#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003513
3514#ifdef EXITFREE
3515 free_all_mem();
3516#endif
3517
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 exit(r);
3519}
3520
3521 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003522may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523{
3524 if (deadly_signal != 0)
3525 {
3526 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003527 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 }
3529}
3530
3531#ifndef VMS
3532
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003533/*
3534 * Get the file descriptor to use for tty operations.
3535 */
3536 static int
3537get_tty_fd(int fd)
3538{
3539 int tty_fd = fd;
3540
3541#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3542 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3543 // "fd" when it is a master device.
3544 if (mch_isatty(fd) > 1)
3545 {
3546 char *name;
3547
3548 name = ptsname(fd);
3549 if (name == NULL)
3550 return -1;
3551
3552 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3553 if (tty_fd < 0)
3554 return -1;
3555 }
3556#endif
3557 return tty_fd;
3558}
3559
3560 static int
3561mch_tcgetattr(int fd, void *term)
3562{
3563 int tty_fd;
3564 int retval = -1;
3565
3566 tty_fd = get_tty_fd(fd);
3567 if (tty_fd >= 0)
3568 {
3569#ifdef NEW_TTY_SYSTEM
3570# ifdef HAVE_TERMIOS_H
3571 retval = tcgetattr(tty_fd, (struct termios *)term);
3572# else
3573 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
3574# endif
3575#else
3576 // for "old" tty systems
3577 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
3578#endif
3579 if (tty_fd != fd)
3580 close(tty_fd);
3581 }
3582 return retval;
3583}
3584
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003586mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587{
3588 static int first = TRUE;
3589
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003590#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591# ifdef HAVE_TERMIOS_H
3592 static struct termios told;
3593 struct termios tnew;
3594# else
3595 static struct termio told;
3596 struct termio tnew;
3597# endif
3598
3599 if (first)
3600 {
3601 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003602 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 }
3604
3605 tnew = told;
3606 if (tmode == TMODE_RAW)
3607 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003608 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003609 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3610 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003612# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003613 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614# endif
3615 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003616# ifdef ONLCR
3617 // Don't map NL -> CR NL, we do it ourselves.
3618 // Also disable expanding tabs if possible.
3619# ifdef XTABS
3620 tnew.c_oflag &= ~(ONLCR | XTABS);
3621# else
3622# ifdef TAB3
3623 tnew.c_oflag &= ~(ONLCR | TAB3);
3624# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003626# endif
3627# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003629 tnew.c_cc[VMIN] = 1; // return after 1 char
3630 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 }
3632 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003633 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003634 // Also reset ICANON here, otherwise on Solaris select() won't see
3635 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003636 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003637 tnew.c_cc[VMIN] = 1; // return after 1 char
3638 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640
3641# if defined(HAVE_TERMIOS_H)
3642 {
3643 int n = 10;
3644
Bram Moolenaar0f873732019-12-05 20:28:46 +01003645 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3646 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3648 && errno == EINTR && n > 0)
3649 --n;
3650 }
3651# else
3652 ioctl(read_cmd_fd, TCSETA, &tnew);
3653# endif
3654
3655#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 /*
3657 * for "old" tty systems
3658 */
3659# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003660# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661# endif
3662 static struct sgttyb ttybold;
3663 struct sgttyb ttybnew;
3664
3665 if (first)
3666 {
3667 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003668 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 }
3670
3671 ttybnew = ttybold;
3672 if (tmode == TMODE_RAW)
3673 {
3674 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3675 ttybnew.sg_flags |= RAW;
3676 }
3677 else if (tmode == TMODE_SLEEP)
3678 ttybnew.sg_flags &= ~(ECHO);
3679 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3680#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003681 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682}
3683
3684/*
3685 * Try to get the code for "t_kb" from the stty setting
3686 *
3687 * Even if termcap claims a backspace key, the user's setting *should*
3688 * prevail. stty knows more about reality than termcap does, and if
3689 * somebody's usual erase key is DEL (which, for most BSD users, it will
3690 * be), they're going to get really annoyed if their erase key starts
3691 * doing forward deletes for no reason. (Eric Fischer)
3692 */
3693 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003694get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003696 ttyinfo_T info;
3697 char_u buf[2];
3698 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003700 if (get_tty_info(read_cmd_fd, &info) == OK)
3701 {
3702 intr_char = info.interrupt;
3703 buf[0] = info.backspace;
3704 buf[1] = NUL;
3705 add_termcode((char_u *)"kb", buf, FALSE);
3706
Bram Moolenaar0f873732019-12-05 20:28:46 +01003707 // If <BS> and <DEL> are now the same, redefine <DEL>.
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003708 p = find_termcode((char_u *)"kD");
3709 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3710 do_fixdel(NULL);
3711 }
3712}
3713
3714/*
3715 * Obtain the characters that Backspace and Enter produce on "fd".
3716 * Returns OK or FAIL.
3717 */
3718 int
3719get_tty_info(int fd, ttyinfo_T *info)
3720{
3721#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722# ifdef HAVE_TERMIOS_H
3723 struct termios keys;
3724# else
3725 struct termio keys;
3726# endif
3727
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003728 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003730 info->backspace = keys.c_cc[VERASE];
3731 info->interrupt = keys.c_cc[VINTR];
3732 if (keys.c_iflag & ICRNL)
3733 info->enter = NL;
3734 else
3735 info->enter = CAR;
3736 if (keys.c_oflag & ONLCR)
3737 info->nl_does_cr = TRUE;
3738 else
3739 info->nl_does_cr = FALSE;
3740 return OK;
3741 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003743 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 struct sgttyb keys;
3745
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003746 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003748 info->backspace = keys.sg_erase;
3749 info->interrupt = keys.sg_kill;
3750 info->enter = CAR;
3751 info->nl_does_cr = TRUE;
3752 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003755 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756}
3757
Bram Moolenaar0f873732019-12-05 20:28:46 +01003758#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003760static int mouse_ison = FALSE;
3761
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762/*
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003763 * Set mouse clicks on or off and possible enable mouse movement events.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 */
3765 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003766mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003768#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003769 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003770#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 int xterm_mouse_vers;
3772
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003773#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003774 if (!on)
3775 // Make sure not tracing mouse movements. Important when a button-down
3776 // was received but no release yet.
3777 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003778#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003779
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003780 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003781#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003782 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003783#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003784 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003785 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 return;
3787
3788 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003789
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003790#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003791 if (ttym_flags == TTYM_URXVT)
3792 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003793 out_str_nf((char_u *)(on ? "\033[?1015h" : "\033[?1015l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003794 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003795 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003796#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003797
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003798 if (ttym_flags == TTYM_SGR)
3799 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003800 // SGR mode supports columns above 223
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003801 out_str_nf((char_u *)(on ? "\033[?1006h" : "\033[?1006l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003802 mouse_ison = on;
3803 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003804
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003805#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003806 if (bevalterm_ison != (p_bevalterm && on))
3807 {
3808 bevalterm_ison = (p_bevalterm && on);
3809 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003810 // disable mouse movement events, enabling is below
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003811 out_str_nf((char_u *)("\033[?1003l"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003812 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003813#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003814
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 if (xterm_mouse_vers > 0)
3816 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003817 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 out_str_nf((char_u *)
3819 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003820 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003821#ifdef FEAT_BEVAL_TERM
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003822 bevalterm_ison ? "\033[?1003h" :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003823#endif
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003824 "\033[?1002h")
3825 : "\033[?1000h"));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003826 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 out_str_nf((char_u *)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003828 (xterm_mouse_vers > 1 ? "\033[?1002l" : "\033[?1000l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003829 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 }
3831
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003832#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 else if (ttym_flags == TTYM_DEC)
3834 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003835 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003837 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003839 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003841#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003843#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 else
3845 {
3846 if (on)
3847 {
3848 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003849 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 }
3851 else
3852 {
3853 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003854 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 }
3856 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003857#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003859#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003860 else
3861 {
3862 if (on)
3863 {
3864 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003865 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003866 }
3867 else
3868 {
3869 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003870 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003871 }
3872 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003873#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003874
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003875#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 else
3877 {
3878 if (on)
3879 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003880 // D - Enable Mouse up/down messages
3881 // L - Enable Left Button Reporting
3882 // M - Enable Middle Button Reporting
3883 // R - Enable Right Button Reporting
3884 // K - Enable SHIFT and CTRL key Reporting
3885 // + - Enable Advanced messaging of mouse moves and up/down messages
3886 // Q - Quiet No Ack
3887 // # - Numeric value of mouse pointer required
3888 // 0 = Multiview 2000 cursor, used as standard
3889 // 1 = Windows Arrow
3890 // 2 = Windows I Beam
3891 // 3 = Windows Hour Glass
3892 // 4 = Windows Cross Hair
3893 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003894# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003895 // Disables full feedback of pointer movements
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003896 out_str_nf((char_u *)"\033[0~ZwLMRK1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003897# else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003898 out_str_nf((char_u *)"\033[0~ZwLMRK+1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003899# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003900 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 }
3902 else
3903 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003904 out_str_nf((char_u *)"\033[0~ZwQ\033\\");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003905 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 }
3907 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003908#endif
3909#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 else
3911 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003912 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 if (on)
3914 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3915 else
3916 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003917 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003919#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920}
3921
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003922#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003923/*
3924 * Called when 'balloonevalterm' changed.
3925 */
3926 void
3927mch_bevalterm_changed(void)
3928{
3929 mch_setmouse(mouse_ison);
3930}
3931#endif
3932
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933/*
3934 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3935 */
3936 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003937check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938{
3939# ifdef FEAT_MOUSE_XTERM
3940 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003941# ifdef FEAT_MOUSE_URXVT
3942 && use_xterm_mouse() != 3
3943# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944# ifdef FEAT_GUI
3945 && !gui.in_use
3946# endif
3947 )
3948 {
3949 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003950 ? "\233M" : "\033[M"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 if (*p_mouse != NUL)
3952 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003953 // force mouse off and maybe on to send possibly new mouse
3954 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 mch_setmouse(FALSE);
3956 setmouse();
3957 }
3958 }
3959 else
3960 del_mouse_termcode(KS_MOUSE);
3961# endif
3962
3963# ifdef FEAT_MOUSE_GPM
3964 if (!use_xterm_mouse()
3965# ifdef FEAT_GUI
3966 && !gui.in_use
3967# endif
3968 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003969 set_mouse_termcode(KS_GPM_MOUSE, (char_u *)"\033MG");
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003970 else
3971 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972# endif
3973
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003974# ifdef FEAT_SYSMOUSE
3975 if (!use_xterm_mouse()
3976# ifdef FEAT_GUI
3977 && !gui.in_use
3978# endif
3979 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003980 set_mouse_termcode(KS_MOUSE, (char_u *)"\033MS");
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003981# endif
3982
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003984 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 if (!use_xterm_mouse()
3986# ifdef FEAT_GUI
3987 && !gui.in_use
3988# endif
3989 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003990 set_mouse_termcode(KS_JSBTERM_MOUSE, (char_u *)"\033[0~zw");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 else
3992 del_mouse_termcode(KS_JSBTERM_MOUSE);
3993# endif
3994
3995# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003996 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3997 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 if (!use_xterm_mouse()
3999# ifdef FEAT_GUI
4000 && !gui.in_use
4001# endif
4002 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004003 set_mouse_termcode(KS_NETTERM_MOUSE, (char_u *)"\033}");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 else
4005 del_mouse_termcode(KS_NETTERM_MOUSE);
4006# endif
4007
4008# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01004009 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004010 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011# ifdef FEAT_GUI
4012 && !gui.in_use
4013# endif
4014 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004015 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004016 ? "\233" : "\033["));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 else
4018 del_mouse_termcode(KS_DEC_MOUSE);
4019# endif
4020# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01004021 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004022 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023# ifdef FEAT_GUI
4024 && !gui.in_use
4025# endif
4026 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004027 set_mouse_termcode(KS_PTERM_MOUSE, (char_u *)"\033[");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 else
4029 del_mouse_termcode(KS_PTERM_MOUSE);
4030# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02004031# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004032 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02004033# ifdef FEAT_GUI
4034 && !gui.in_use
4035# endif
4036 )
4037 {
4038 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004039 ? "\233*M" : "\033[*M"));
Bram Moolenaarc8427482011-10-20 21:09:35 +02004040
4041 if (*p_mouse != NUL)
4042 {
4043 mch_setmouse(FALSE);
4044 setmouse();
4045 }
4046 }
4047 else
4048 del_mouse_termcode(KS_URXVT_MOUSE);
4049# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004050 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004051# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004052 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004053# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004054 )
4055 {
4056 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004057 ? "\233<*M" : "\033[<*M"));
Bram Moolenaara529ce02017-06-22 22:37:57 +02004058
4059 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004060 ? "\233<*m" : "\033[<*m"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004061
4062 if (*p_mouse != NUL)
4063 {
4064 mch_setmouse(FALSE);
4065 setmouse();
4066 }
4067 }
4068 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02004069 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004070 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02004071 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
4072 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075#ifndef VMS
4076
4077/*
4078 * Try to get the current window size:
4079 * 1. with an ioctl(), most accurate method
4080 * 2. from the environment variables LINES and COLUMNS
4081 * 3. from the termcap
4082 * 4. keep using the old values
4083 * Return OK when size could be determined, FAIL otherwise.
4084 */
4085 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004086mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087{
4088 long rows = 0;
4089 long columns = 0;
4090 char_u *p;
4091
4092 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 * 1. try using an ioctl. It is the most accurate method.
4094 *
4095 * Try using TIOCGWINSZ first, some systems that have it also define
4096 * TIOCGSIZE but don't have a struct ttysize.
4097 */
4098# ifdef TIOCGWINSZ
4099 {
4100 struct winsize ws;
4101 int fd = 1;
4102
Bram Moolenaar0f873732019-12-05 20:28:46 +01004103 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 if (!isatty(fd) && isatty(read_cmd_fd))
4105 fd = read_cmd_fd;
4106 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4107 {
4108 columns = ws.ws_col;
4109 rows = ws.ws_row;
4110 }
4111 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004112# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113# ifdef TIOCGSIZE
4114 {
4115 struct ttysize ts;
4116 int fd = 1;
4117
Bram Moolenaar0f873732019-12-05 20:28:46 +01004118 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 if (!isatty(fd) && isatty(read_cmd_fd))
4120 fd = read_cmd_fd;
4121 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4122 {
4123 columns = ts.ts_cols;
4124 rows = ts.ts_lines;
4125 }
4126 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004127# endif // TIOCGSIZE
4128# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129
4130 /*
4131 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004132 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4133 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004135 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 {
4137 if ((p = (char_u *)getenv("LINES")))
4138 rows = atoi((char *)p);
4139 if ((p = (char_u *)getenv("COLUMNS")))
4140 columns = atoi((char *)p);
4141 }
4142
4143#ifdef HAVE_TGETENT
4144 /*
4145 * 3. try reading "co" and "li" entries from termcap
4146 */
4147 if (columns == 0 || rows == 0)
4148 getlinecol(&columns, &rows);
4149#endif
4150
4151 /*
4152 * 4. If everything fails, use the old values
4153 */
4154 if (columns <= 0 || rows <= 0)
4155 return FAIL;
4156
4157 Rows = rows;
4158 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004159 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 return OK;
4161}
4162
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004163#if defined(FEAT_TERMINAL) || defined(PROTO)
4164/*
4165 * Report the windows size "rows" and "cols" to tty "fd".
4166 */
4167 int
4168mch_report_winsize(int fd, int rows, int cols)
4169{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004170 int tty_fd;
4171 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004172
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004173 tty_fd = get_tty_fd(fd);
4174 if (tty_fd >= 0)
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004175 {
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004176# if defined(TIOCSWINSZ)
4177 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004178
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004179 ws.ws_col = cols;
4180 ws.ws_row = rows;
4181 ws.ws_xpixel = cols * 5;
4182 ws.ws_ypixel = rows * 10;
4183 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4184 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4185 retval == 0 ? "success" : "failed");
4186# elif defined(TIOCSSIZE)
4187 struct ttysize ts;
4188
4189 ts.ts_cols = cols;
4190 ts.ts_lines = rows;
4191 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4192 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4193 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004194# endif
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004195 if (tty_fd != fd)
4196 close(tty_fd);
4197 }
4198 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004199}
4200#endif
4201
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202/*
4203 * Try to set the window size to Rows and Columns.
4204 */
4205 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004206mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207{
4208 if (*T_CWS)
4209 {
4210 /*
4211 * NOTE: if you get an error here that term_set_winsize() is
4212 * undefined, check the output of configure. It could probably not
4213 * find a ncurses, termcap or termlib library.
4214 */
4215 term_set_winsize((int)Rows, (int)Columns);
4216 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004217 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 }
4219}
4220
Bram Moolenaar0f873732019-12-05 20:28:46 +01004221#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222
4223/*
4224 * Rows and/or Columns has changed.
4225 */
4226 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004227mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004229 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230}
4231
Bram Moolenaar205b8862011-09-07 15:04:31 +02004232/*
4233 * Wait for process "child" to end.
4234 * Return "child" if it exited properly, <= 0 on error.
4235 */
4236 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004237wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004238{
4239 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004240 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004241
4242 while (wait_pid != child)
4243 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004244 // When compiled with Python threads are probably used, in which case
4245 // wait() sometimes hangs for no obvious reason. Use waitpid()
4246 // instead and loop (like the GUI). Also needed for other interfaces,
4247 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004248# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004249 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004250# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004251 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004252# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004253 if (wait_pid == 0)
4254 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004255 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004256 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004257 if (++delay_msec > 10)
4258 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004259 continue;
4260 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004261 if (wait_pid <= 0
4262# ifdef ECHILD
4263 && errno == ECHILD
4264# endif
4265 )
4266 break;
4267 }
4268 return wait_pid;
4269}
4270
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004271#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004272/*
4273 * Set the environment for a child process.
4274 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004275 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004276set_child_environment(
4277 long rows,
4278 long columns,
4279 char *term,
4280 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004281{
4282# ifdef HAVE_SETENV
4283 char envbuf[50];
4284# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004285 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004286 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004287 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004288 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004289 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004290# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004291 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004292# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004293# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004294 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004295# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004296# endif
4297
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004298# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004299 setenv("TERM", term, 1);
4300 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004301 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004302 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004303 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004304 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004305 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004306 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004307 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004308# ifdef FEAT_TERMINAL
4309 if (is_terminal)
4310 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004311 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004312 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4313 }
4314# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004315# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004316 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004317# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004318# else
4319 /*
4320 * Putenv does not copy the string, it has to remain valid.
4321 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004322 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004323 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004324 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4325 putenv(envbuf_Term);
4326 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004327 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004328 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4329 putenv(envbuf_Lines);
4330 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4331 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004332 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004333 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004334 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004335# ifdef FEAT_TERMINAL
4336 if (is_terminal)
4337 {
4338 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004339 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004340 putenv(envbuf_Version);
4341 }
4342# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004343# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004344 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4345 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4346 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004347# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004348# endif
4349}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004350
4351 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004352set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004353{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004354 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004355}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004356#endif
4357
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004358#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004359/*
4360 * Open a PTY, with FD for the master and slave side.
4361 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004362 * When successful both file descriptors are stored and the allocated pty name
4363 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004364 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004365 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004366open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004367{
4368 char *tty_name;
4369
Bram Moolenaar59386482019-02-10 22:43:46 +01004370 if (name1 != NULL)
4371 *name1 = NULL;
4372 if (name2 != NULL)
4373 *name2 = NULL;
4374
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004375 *pty_master_fd = mch_openpty(&tty_name); // open pty
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004376 if (*pty_master_fd >= 0)
4377 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004378 // Leaving out O_NOCTTY may lead to waitpid() always returning
4379 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4380 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004381#ifdef O_NOCTTY
4382 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
4383#else
4384 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
4385#endif
4386 if (*pty_slave_fd < 0)
4387 {
4388 close(*pty_master_fd);
4389 *pty_master_fd = -1;
4390 }
Bram Moolenaar59386482019-02-10 22:43:46 +01004391 else
4392 {
4393 if (name1 != NULL)
4394 *name1 = vim_strsave((char_u *)tty_name);
4395 if (name2 != NULL)
4396 *name2 = vim_strsave((char_u *)tty_name);
4397 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004398 }
4399}
4400#endif
4401
Bram Moolenaarfae42832017-08-01 22:24:26 +02004402/*
4403 * Send SIGINT to a child process if "c" is an interrupt character.
4404 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004405 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004406may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4407{
4408# ifdef SIGINT
4409 if (c == Ctrl_C || c == intr_char)
4410 {
4411# ifdef HAVE_SETSID
4412 kill(-pid, SIGINT);
4413# else
4414 kill(0, SIGINT);
4415# endif
4416 if (wpid > 0)
4417 kill(wpid, SIGINT);
4418 }
4419# endif
4420}
4421
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004422#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004423
Bram Moolenaar0f873732019-12-05 20:28:46 +01004424/*
4425 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4426 * pointers, the last one is NULL.
4427 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4428 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004429 int
4430unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004431 char_u *cmd,
4432 char ***argvp,
4433 char_u **sh_tofree,
4434 char_u **shcf_tofree)
4435{
4436 char **argv = NULL;
4437 int argc;
4438
4439 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004440 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004441 return FAIL;
4442
4443 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4444 return FAIL;
4445 *argvp = argv;
4446
4447 if (cmd != NULL)
4448 {
4449 char_u *s;
4450 char_u *p;
4451
4452 if (extra_shell_arg != NULL)
4453 argv[argc++] = (char *)extra_shell_arg;
4454
Bram Moolenaar0f873732019-12-05 20:28:46 +01004455 // Break 'shellcmdflag' into white separated parts. This doesn't
4456 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004457 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004458 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004459 return FAIL;
4460 s = *shcf_tofree;
4461 p = p_shcf;
4462 while (*p != NUL)
4463 {
4464 argv[argc++] = (char *)s;
4465 while (*p && *p != ' ' && *p != TAB)
4466 *s++ = *p++;
4467 *s++ = NUL;
4468 p = skipwhite(p);
4469 }
4470
4471 argv[argc++] = (char *)cmd;
4472 }
4473 argv[argc] = NULL;
4474 return OK;
4475}
4476#endif
4477
4478#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4479/*
4480 * Use a terminal window to run a shell command in.
4481 */
4482 static int
4483mch_call_shell_terminal(
4484 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004485 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004486{
4487 jobopt_T opt;
4488 char **argv = NULL;
4489 char_u *tofree1 = NULL;
4490 char_u *tofree2 = NULL;
4491 int retval = -1;
4492 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004493 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004494 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004495 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004496
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004497 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004498 goto theend;
4499
4500 init_job_options(&opt);
4501 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4502 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004503 if (buf == NULL)
4504 goto theend;
4505
4506 job = term_getjob(buf->b_term);
4507 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004508
Bram Moolenaar0f873732019-12-05 20:28:46 +01004509 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004510 aucmd_prepbuf(&aco, buf);
4511
4512 clear_oparg(&oa);
4513 while (term_use_loop())
4514 {
4515 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4516 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004517 // If terminal_loop() returns OK we got a key that is handled
4518 // in Normal model. We don't do redrawing anyway.
Bram Moolenaar13568252018-03-16 20:46:58 +01004519 if (terminal_loop(TRUE) == OK)
4520 normal_cmd(&oa, TRUE);
4521 }
4522 else
4523 normal_cmd(&oa, TRUE);
4524 }
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004525 retval = job->jv_exitval;
Bram Moolenaar13568252018-03-16 20:46:58 +01004526 ch_log(NULL, "system command finished");
4527
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004528 job_unref(job);
4529
Bram Moolenaar0f873732019-12-05 20:28:46 +01004530 // restore curwin/curbuf and a few other things
Bram Moolenaar13568252018-03-16 20:46:58 +01004531 aucmd_restbuf(&aco);
4532
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01004533 // Only require pressing Enter when redrawing, to avoid that system() gets
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004534 // the hit-enter prompt even though it didn't output anything.
4535 if (!RedrawingDisabled)
4536 wait_return(TRUE);
Bram Moolenaar13568252018-03-16 20:46:58 +01004537 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4538
4539theend:
4540 vim_free(argv);
4541 vim_free(tofree1);
4542 vim_free(tofree2);
4543 return retval;
4544}
4545#endif
4546
4547#ifdef USE_SYSTEM
4548/*
4549 * Use system() to start the shell: simple but slow.
4550 */
4551 static int
4552mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004553 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004554 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555{
4556#ifdef VMS
4557 char *ifn = NULL;
4558 char *ofn = NULL;
4559#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004560 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004561 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004562 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563
4564 out_flush();
4565
4566 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004567 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568
Bram Moolenaar62b42182010-09-21 22:09:37 +02004569# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004570 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004571 loose_clipboard();
4572# endif
4573
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 if (cmd == NULL)
4575 x = system((char *)p_sh);
4576 else
4577 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004578# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 if (ofn = strchr((char *)cmd, '>'))
4580 *ofn++ = '\0';
4581 if (ifn = strchr((char *)cmd, '<'))
4582 {
4583 char *p;
4584
4585 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004586 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 if (p)
4588 *p = '\0';
4589 }
4590 if (ofn)
4591 x = vms_sys((char *)cmd, ofn, ifn);
4592 else
4593 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004594# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004595 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004597 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 if (newcmd == NULL)
4599 x = 0;
4600 else
4601 {
4602 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4603 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4604 (char *)p_shcf,
4605 (char *)cmd);
4606 x = system((char *)newcmd);
4607 vim_free(newcmd);
4608 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004609# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 }
4611# ifdef VMS
4612 x = vms_sys_status(x);
4613# endif
4614 if (emsg_silent)
4615 ;
4616 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004617 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 else if (x && !(options & SHELL_SILENT))
4619 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004620 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 msg_outnum((long)x);
4622 msg_putchar('\n');
4623 }
4624
4625 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004626 {
4627 // The shell may have messed with the mode, always set it.
4628 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004629 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004630 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 resettitle();
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004632# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4633 restore_clipboard();
4634# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004636}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
Bram Moolenaar0f873732019-12-05 20:28:46 +01004638#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639
Bram Moolenaar0f873732019-12-05 20:28:46 +01004640# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4641 // 127, some shells use that already
4642# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643
Bram Moolenaar13568252018-03-16 20:46:58 +01004644/*
4645 * Don't use system(), use fork()/exec().
4646 */
4647 static int
4648mch_call_shell_fork(
4649 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004650 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004651{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004652 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004654 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 pid_t wait_pid = 0;
4656# ifdef HAVE_UNION_WAIT
4657 union wait status;
4658# else
4659 int status = -1;
4660# endif
4661 int retval = -1;
4662 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004663 char_u *tofree1 = NULL;
4664 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004666 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004667# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004669# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004670 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 int fd_fromshell[2];
4672 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004673 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674
4675 out_flush();
4676 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004677 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004678 if (tmode == TMODE_RAW)
4679 // The shell may have messed with the mode, always set it later.
4680 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004682 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004683 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004684
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004686 * For the GUI, when writing the output into the buffer and when reading
4687 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4688 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004690 if ((options & (SHELL_READ|SHELL_WRITE))
4691# ifdef FEAT_GUI
4692 || (gui.in_use && show_shell_mess)
4693# endif
4694 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004696# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 /*
4698 * Try to open a master pty.
4699 * If this works, open the slave pty.
4700 * If the slave can't be opened, close the master pty.
4701 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004702 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004703 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 /*
4705 * If not opening a pty or it didn't work, try using pipes.
4706 */
4707 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004708# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 {
4710 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004711 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 {
4713 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004714 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 {
4716 close(fd_toshell[0]);
4717 close(fd_toshell[1]);
4718 }
4719 }
4720 if (pipe_error)
4721 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004722 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 out_flush();
4724 }
4725 }
4726 }
4727
Bram Moolenaar0f873732019-12-05 20:28:46 +01004728 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004730 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004731 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004732 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004733 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004735 UNBLOCK_SIGNALS(&curset);
4736
Bram Moolenaar32526b32019-01-19 17:43:09 +01004737 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004738 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004740 || (gui.in_use && show_shell_mess)
4741# endif
4742 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004744# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004745 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 {
4747 close(pty_master_fd);
4748 close(pty_slave_fd);
4749 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004750 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004751# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 {
4753 close(fd_toshell[0]);
4754 close(fd_toshell[1]);
4755 close(fd_fromshell[0]);
4756 close(fd_fromshell[1]);
4757 }
4758 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004760 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004762 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004763 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
Bram Moolenaar819524702018-02-27 19:10:00 +01004765# ifdef FEAT_JOB_CHANNEL
4766 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004767 {
4768 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004769 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004770 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004771# endif
4772
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 if (!show_shell_mess || (options & SHELL_EXPAND))
4774 {
4775 int fd;
4776
4777 /*
4778 * Don't want to show any message from the shell. Can't just
4779 * close stdout and stderr though, because some systems will
4780 * break if you try to write to them after that, so we must
4781 * use dup() to replace them with something else -- webb
4782 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4783 * waiting for input.
4784 */
4785 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4786 fclose(stdin);
4787 fclose(stdout);
4788 fclose(stderr);
4789
4790 /*
4791 * If any of these open()'s and dup()'s fail, we just continue
4792 * anyway. It's not fatal, and on most systems it will make
4793 * no difference at all. On a few it will cause the execvp()
4794 * to exit with a non-zero status even when the completion
4795 * could be done, which is nothing too serious. If the open()
4796 * or dup() failed we'd just do the same thing ourselves
4797 * anyway -- webb
4798 */
4799 if (fd >= 0)
4800 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004801 vim_ignored = dup(fd); // To replace stdin (fd 0)
4802 vim_ignored = dup(fd); // To replace stdout (fd 1)
4803 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804
Bram Moolenaar0f873732019-12-05 20:28:46 +01004805 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 close(fd);
4807 }
4808 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004809 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004811 || gui.in_use
4812# endif
4813 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 {
4815
Bram Moolenaardf177f62005-02-22 08:39:57 +00004816# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004817 // Create our own process group, so that the child and all its
4818 // children can be kill()ed. Don't do this when using pipes,
4819 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004820 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004821 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004822 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004823# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004824 // When doing "!xterm&" and 'shell' is bash: the shell
4825 // will exit and send SIGHUP to all processes in its
4826 // group, killing the just started process. Ignore SIGHUP
4827 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004828 signal(SIGHUP, SIG_IGN);
4829# endif
4830 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004831# endif
4832# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004833 if (pty_slave_fd >= 0)
4834 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004835 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004836 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004837 setup_slavepty(pty_slave_fd);
Bram Moolenaarfff10d92021-10-13 10:05:30 +01004838# ifdef TIOCSCTTY
4839 // Try to become controlling tty (probably doesn't work,
4840 // unless run by root)
4841 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
4842# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004843 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004844# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004845 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846
Bram Moolenaara5792f52005-11-23 21:25:05 +00004847 /*
4848 * stderr is only redirected when using the GUI, so that a
4849 * program like gpg can still access the terminal to get a
4850 * passphrase using stderr.
4851 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004852# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 if (pty_master_fd >= 0)
4854 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004855 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856
Bram Moolenaar0f873732019-12-05 20:28:46 +01004857 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004859 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004861 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004862 if (gui.in_use)
4863 {
4864 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004865 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004866 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
Bram Moolenaar0f873732019-12-05 20:28:46 +01004868 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 }
4870 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004871# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004873 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 close(fd_toshell[1]);
4875 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004876 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 close(fd_toshell[0]);
4878
Bram Moolenaar0f873732019-12-05 20:28:46 +01004879 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 close(fd_fromshell[0]);
4881 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004882 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 close(fd_fromshell[1]);
4884
Bram Moolenaara5792f52005-11-23 21:25:05 +00004885# ifdef FEAT_GUI
4886 if (gui.in_use)
4887 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004888 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004889 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004890 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004891 }
4892# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 }
4894 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004895
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 /*
4897 * There is no type cast for the argv, because the type may be
4898 * different on different machines. This may cause a warning
4899 * message with strict compilers, don't worry about it.
4900 * Call _exit() instead of exit() to avoid closing the connection
4901 * to the X server (esp. with GTK, which uses atexit()).
4902 */
4903 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004904 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004906 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 {
4908 /*
4909 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004910 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 */
4912 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004913 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004914 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004915# ifdef FEAT_JOB_CHANNEL
4916 ++dont_check_job_ended;
4917# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 /*
4919 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004920 * This is also used to pipe stdin/stdout to/from the external
4921 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004923 if ((options & (SHELL_READ|SHELL_WRITE))
4924# ifdef FEAT_GUI
4925 || (gui.in_use && show_shell_mess)
4926# endif
4927 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004929# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004931 int buffer_off = 0; // valid bytes in buffer[]
4932 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4933 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 int len;
4935 int p_more_save;
4936 int old_State;
4937 int c;
4938 int toshell_fd;
4939 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004940 garray_T ga;
4941 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004942# ifdef ELAPSED_FUNC
4943 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004944# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945
Bram Moolenaardf177f62005-02-22 08:39:57 +00004946# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 if (pty_master_fd >= 0)
4948 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 fromshell_fd = pty_master_fd;
4950 toshell_fd = dup(pty_master_fd);
4951 }
4952 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004953# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 {
4955 close(fd_toshell[0]);
4956 close(fd_fromshell[1]);
4957 toshell_fd = fd_toshell[1];
4958 fromshell_fd = fd_fromshell[0];
4959 }
4960
4961 /*
4962 * Write to the child if there are typed characters.
4963 * Read from the child if there are characters available.
4964 * Repeat the reading a few times if more characters are
4965 * available. Need to check for typed keys now and then, but
4966 * not too often (delays when no chars are available).
4967 * This loop is quit if no characters can be read from the pty
4968 * (WaitForChar detected special condition), or there are no
4969 * characters available and the child has exited.
4970 * Only check if the child has exited when there is no more
4971 * output. The child may exit before all the output has
4972 * been printed.
4973 *
4974 * Currently this busy loops!
4975 * This can probably dead-lock when the write blocks!
4976 */
4977 p_more_save = p_more;
4978 p_more = FALSE;
4979 old_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01004980 State = MODE_EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004982 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004983 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004984 // Fork a process that will write the lines to the
4985 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004986 if ((wpid = fork()) == -1)
4987 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004988 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004989 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004990 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004991 {
4992 linenr_T lnum = curbuf->b_op_start.lnum;
4993 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004994 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004995 size_t l;
4996
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004997 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004998 for (;;)
4999 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00005000 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005001 if (l == 0)
5002 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00005003 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005004 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00005005 len = write(toshell_fd, "", (size_t)1);
5006 else
5007 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01005008 char_u *s = vim_strchr(lp + written, NL);
5009
Bram Moolenaar89d40322006-08-29 15:30:07 +00005010 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00005011 s == NULL ? l
5012 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005013 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00005014 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005015 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005016 // Finished a line, add a NL, unless this line
5017 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005018 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005019 || (!curbuf->b_p_bin
5020 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005021 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaar88456cd2022-11-18 22:14:09 +00005022 && (lnum != curbuf->b_ml.ml_line_count
Bram Moolenaardf177f62005-02-22 08:39:57 +00005023 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02005024 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005025 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005026 ++lnum;
5027 if (lnum > curbuf->b_op_end.lnum)
5028 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005029 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00005030 close(toshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005031 break;
5032 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00005033 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005034 written = 0;
5035 }
5036 else if (len > 0)
5037 written += len;
5038 }
5039 _exit(0);
5040 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005041 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00005042 {
5043 close(toshell_fd);
5044 toshell_fd = -1;
5045 }
5046 }
5047
5048 if (options & SHELL_READ)
5049 ga_init2(&ga, 1, BUFLEN);
5050
5051 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005052# ifdef ELAPSED_FUNC
5053 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005054# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 for (;;)
5056 {
5057 /*
5058 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005059 * if there are any.
5060 * Don't do this if we are expanding wild cards (would eat
5061 * typeahead).
5062 * Don't do this when filtering and terminal is in cooked
5063 * mode, the shell command will handle the I/O. Avoids
5064 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005065 * Don't get characters when the child has already
5066 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00005067 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005068 * while (noread_cnt > 4), avoids that ":r !ls" eats
5069 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 */
5071 len = 0;
5072 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005073 && ((options &
5074 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5075 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005076# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005077 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005078# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005079 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005080 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005081 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005083 if (ta_len == 0)
5084 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005085 // Get extra characters when we don't have any.
5086 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005087 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005088# ifdef ELAPSED_FUNC
5089 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005090# endif
5091 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5092 }
5093 if (ta_len > 0 || len > 0)
5094 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 /*
5096 * For pipes:
5097 * Check for CTRL-C: send interrupt signal to child.
5098 * Check for CTRL-D: EOF, close pipe to child.
5099 */
5100 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5101 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 /*
5103 * Send SIGINT to the child's group or all
5104 * processes in our group.
5105 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005106 may_send_sigint(ta_buf[ta_len], pid, wpid);
5107
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 if (pty_master_fd < 0 && toshell_fd >= 0
5109 && ta_buf[ta_len] == Ctrl_D)
5110 {
5111 close(toshell_fd);
5112 toshell_fd = -1;
5113 }
5114 }
5115
Bram Moolenaar2f7e1b82022-10-04 13:17:31 +01005116 // Remove Vim-specific codes from the input.
5117 len = term_replace_keycodes(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118
5119 /*
5120 * For pipes: echo the typed characters.
5121 * For a pty this does not seem to work.
5122 */
5123 if (pty_master_fd < 0)
5124 {
5125 for (i = ta_len; i < ta_len + len; ++i)
5126 {
5127 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5128 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 else if (has_mbyte)
5130 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005131 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132
5133 msg_outtrans_len(ta_buf + i, l);
5134 i += l - 1;
5135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 else
5137 msg_outtrans_len(ta_buf + i, 1);
5138 }
5139 windgoto(msg_row, msg_col);
5140 out_flush();
5141 }
5142
5143 ta_len += len;
5144
5145 /*
5146 * Write the characters to the child, unless EOF has
5147 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005148 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005149 * When writing buffer lines, drop the typed
5150 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005152 if (options & SHELL_WRITE)
5153 ta_len = 0;
5154 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 {
5156 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5157 if (len > 0)
5158 {
5159 ta_len -= len;
5160 mch_memmove(ta_buf, ta_buf + len, ta_len);
5161 }
5162 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005163 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 }
5165
Bram Moolenaardf177f62005-02-22 08:39:57 +00005166 if (got_int)
5167 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005168 // CTRL-C sends a signal to the child, we ignore it
5169 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005170# ifdef HAVE_SETSID
5171 kill(-pid, SIGINT);
5172# else
5173 kill(0, SIGINT);
5174# endif
5175 if (wpid > 0)
5176 kill(wpid, SIGINT);
5177 got_int = FALSE;
5178 }
5179
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 /*
5181 * Check if the child has any characters to be printed.
5182 * Read them and write them to our window. Repeat this as
5183 * long as there is something to do, avoid the 10ms wait
5184 * for mch_inchar(), or sending typeahead characters to
5185 * the external process.
5186 * TODO: This should handle escape sequences, compatible
5187 * to some terminal (vt52?).
5188 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005189 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005190 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005192 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005195 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005197
5198 noread_cnt = 0;
5199 if (options & SHELL_READ)
5200 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005201 // Do NUL -> NL translation, append NL separated
5202 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005203 for (i = 0; i < len; ++i)
5204 {
5205 if (buffer[i] == NL)
5206 append_ga_line(&ga);
5207 else if (buffer[i] == NUL)
5208 ga_append(&ga, NL);
5209 else
5210 ga_append(&ga, buffer[i]);
5211 }
5212 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005213 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 {
5215 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005216 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217
Bram Moolenaardf177f62005-02-22 08:39:57 +00005218 len += buffer_off;
5219 buffer[len] = NUL;
5220
Bram Moolenaar0f873732019-12-05 20:28:46 +01005221 // Check if the last character in buffer[] is
5222 // incomplete, keep these bytes for the next
5223 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 for (p = buffer; p < buffer + len; p += l)
5225 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005226 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005228 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 else if (MB_BYTE2LEN(*p) != l)
5230 break;
5231 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005232 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005234 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 if (len >= 12)
5236 ++p;
5237 else
5238 {
5239 buffer_off = len;
5240 continue;
5241 }
5242 }
5243 c = *p;
5244 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005245 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 if (p < buffer + len)
5247 {
5248 *p = c;
5249 buffer_off = (buffer + len) - p;
5250 mch_memmove(buffer, p, buffer_off);
5251 continue;
5252 }
5253 buffer_off = 0;
5254 }
5255 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 {
5257 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005258 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 }
5260
5261 windgoto(msg_row, msg_col);
5262 cursor_on();
5263 out_flush();
5264 if (got_int)
5265 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005266
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005267# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005268 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005269 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005270 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005271
Bram Moolenaar0f873732019-12-05 20:28:46 +01005272 // Avoid that we keep looping here without
5273 // checking for a CTRL-C for a long time. Don't
5274 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005275 if (msec > 2000)
5276 {
5277 noread_cnt = 5;
5278 break;
5279 }
5280 }
5281# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 }
5283
Bram Moolenaar0f873732019-12-05 20:28:46 +01005284 // If we already detected the child has finished, continue
5285 // reading output for a short while. Some text may be
5286 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005287 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005288 {
5289 if (noread_cnt < 5)
5290 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005291 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005292 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005293
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 /*
5295 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005296 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005298# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005299 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005300# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005302# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5304 || (wait_pid == pid && WIFEXITED(status)))
5305 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005306 // Don't break the loop yet, try reading more
5307 // characters from "fromshell_fd" first. When using
5308 // pipes there might still be something to read and
5309 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005312 else
5313 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005314
Bram Moolenaar95a51352013-03-21 22:53:50 +01005315# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005316 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005317 clip_update();
5318# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 }
5320finished:
5321 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005322 if (options & SHELL_READ)
5323 {
5324 if (ga.ga_len > 0)
5325 {
5326 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005327 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005328 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005329 }
5330 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005331 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005332 ga_clear(&ga);
5333 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 /*
5336 * Give all typeahead that wasn't used back to ui_inchar().
5337 */
5338 if (ta_len)
5339 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 State = old_State;
5341 if (toshell_fd >= 0)
5342 close(toshell_fd);
5343 close(fromshell_fd);
5344 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005345# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005346 else
5347 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005348 long delay_msec = 1;
5349
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005350 if (tmode == TMODE_RAW)
5351 // possibly disables modifyOtherKeys, so that the system
5352 // can recognize CTRL-C
5353 out_str(T_CTE);
Bram Moolenaar0981c872020-08-23 14:28:37 +02005354
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005355 /*
5356 * Similar to the loop above, but only handle X events, no
5357 * I/O.
5358 */
5359 for (;;)
5360 {
5361 if (got_int)
5362 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005363 // CTRL-C sends a signal to the child, we ignore it
5364 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005365# ifdef HAVE_SETSID
5366 kill(-pid, SIGINT);
5367# else
5368 kill(0, SIGINT);
5369# endif
5370 got_int = FALSE;
5371 }
5372# ifdef __NeXT__
5373 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5374# else
5375 wait_pid = waitpid(pid, &status, WNOHANG);
5376# endif
5377 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5378 || (wait_pid == pid && WIFEXITED(status)))
5379 {
5380 wait_pid = pid;
5381 break;
5382 }
5383
Bram Moolenaar0f873732019-12-05 20:28:46 +01005384 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005385 clip_update();
5386
Bram Moolenaar0f873732019-12-05 20:28:46 +01005387 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005388 // less time, gradually wait longer.
5389 mch_delay(delay_msec,
5390 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005391 if (++delay_msec > 10)
5392 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005393 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005394
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005395 if (tmode == TMODE_RAW)
5396 // possibly enables modifyOtherKeys again
5397 out_str(T_CTI);
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005398 }
5399# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400
5401 /*
5402 * Wait until our child has exited.
5403 * Ignore wait() returning pids of other children and returning
5404 * because of some signal like SIGWINCH.
5405 * Don't wait if wait_pid was already set above, indicating the
5406 * child already exited.
5407 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005408 if (wait_pid != pid)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01005409 (void)wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410
Bram Moolenaar624891f2010-10-13 16:22:09 +02005411# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005412 // Close slave side of pty. Only do this after the child has
5413 // exited, otherwise the child may hang when it tries to write on
5414 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005415 if (pty_master_fd >= 0)
5416 close(pty_slave_fd);
5417# endif
5418
Bram Moolenaar0f873732019-12-05 20:28:46 +01005419 // Make sure the child that writes to the external program is
5420 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005421 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005422 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005423 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005424 wait4pid(wpid, NULL);
5425 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005426
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005427# ifdef FEAT_JOB_CHANNEL
5428 --dont_check_job_ended;
5429# endif
5430
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 /*
5432 * Set to raw mode right now, otherwise a CTRL-C after
5433 * catch_signals() will kill Vim.
5434 */
5435 if (tmode == TMODE_RAW)
5436 settmode(TMODE_RAW);
5437 did_settmode = TRUE;
5438 set_signals();
5439
5440 if (WIFEXITED(status))
5441 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005442 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005444 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 {
5446 if (retval == EXEC_FAILED)
5447 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005448 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 msg_outtrans(p_sh);
5450 msg_putchar('\n');
5451 }
5452 else if (!(options & SHELL_SILENT))
5453 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005454 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 msg_outnum((long)retval);
5456 msg_putchar('\n');
5457 }
5458 }
5459 }
5460 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005461 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 }
5463 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464
5465error:
5466 if (!did_settmode)
5467 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005468 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 resettitle();
Bram Moolenaar13568252018-03-16 20:46:58 +01005470 vim_free(argv);
5471 vim_free(tofree1);
5472 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473
5474 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005475}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005476#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005477
5478 int
5479mch_call_shell(
5480 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005481 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005482{
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005483#ifdef FEAT_JOB_CHANNEL
5484 ch_log(NULL, "executing shell command: %s", cmd);
5485#endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005486#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
Bram Moolenaar524c8532022-09-27 15:48:20 +01005487 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL
5488 && (options & SHELL_SILENT) == 0)
Bram Moolenaar13568252018-03-16 20:46:58 +01005489 return mch_call_shell_terminal(cmd, options);
5490#endif
5491#ifdef USE_SYSTEM
5492 return mch_call_shell_system(cmd, options);
5493#else
5494 return mch_call_shell_fork(cmd, options);
5495#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496}
5497
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005498#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005499 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005500mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005501{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005502 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005503 int fd_in[2] = {-1, -1}; // for stdin
5504 int fd_out[2] = {-1, -1}; // for stdout
5505 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005506 int pty_master_fd = -1;
5507 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005508 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005509 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5510 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5511 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005512 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005513 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5514 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005515 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005516 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005517 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005518
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005519 if (use_out_for_err && use_null_for_out)
5520 use_null_for_err = TRUE;
5521
Bram Moolenaar0f873732019-12-05 20:28:46 +01005522 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005523 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005524
Bram Moolenaarb2412082017-08-20 18:09:14 +02005525 if (options->jo_pty
5526 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005527 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005528 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005529 open_pty(&pty_master_fd, &pty_slave_fd,
5530 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005531
Bram Moolenaar0f873732019-12-05 20:28:46 +01005532 // TODO: without the channel feature connect the child to /dev/null?
5533 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005534 if (use_file_for_in)
5535 {
5536 char_u *fname = options->jo_io_name[PART_IN];
5537
5538 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5539 if (fd_in[0] < 0)
5540 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005541 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005542 goto failed;
5543 }
5544 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005545 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005546 // When writing buffer lines to the input don't use the pty, so that
5547 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005548 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5549 && pipe(fd_in) < 0)
5550 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005551
5552 if (use_file_for_out)
5553 {
5554 char_u *fname = options->jo_io_name[PART_OUT];
5555
5556 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5557 if (fd_out[1] < 0)
5558 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005559 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005560 goto failed;
5561 }
5562 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005563 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005564 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005565
5566 if (use_file_for_err)
5567 {
5568 char_u *fname = options->jo_io_name[PART_ERR];
5569
5570 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5571 if (fd_err[1] < 0)
5572 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005573 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005574 goto failed;
5575 }
5576 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005577 else if (!use_out_for_err && !use_null_for_err
5578 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005579 goto failed;
5580
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005581 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5582 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005583 if (options->jo_set & JO_CHANNEL)
5584 {
5585 channel = options->jo_channel;
5586 if (channel != NULL)
5587 ++channel->ch_refcount;
5588 }
5589 else
5590 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005591 if (channel == NULL)
5592 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005593 if (job->jv_tty_out != NULL)
5594 ch_log(channel, "using pty %s on fd %d",
5595 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005596 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005597
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005598 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005599 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005600 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005601 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005602 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005603 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005604 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005605 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005606 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005607 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005608 int null_fd = -1;
5609 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005610
Bram Moolenaar0f873732019-12-05 20:28:46 +01005611 // child
5612 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005613 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005614
Bram Moolenaar819524702018-02-27 19:10:00 +01005615# ifdef FEAT_JOB_CHANNEL
5616 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005617 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005618 ch_logfile((char_u *)"", (char_u *)"");
5619# endif
5620
Bram Moolenaar835dc632016-02-07 14:27:38 +01005621# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005622 // Create our own process group, so that the child and all its
5623 // children can be kill()ed. Don't do this when using pipes,
5624 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005625 (void)setsid();
5626# endif
5627
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005628# ifdef FEAT_TERMINAL
5629 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005630 {
5631 char *term = (char *)T_NAME;
5632
5633#ifdef FEAT_GUI
5634 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005635 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005636 term = getenv("TERM");
5637#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005638 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005639 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005640 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005641 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005642 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005643 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005644 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005645 else if (t_colors > 16)
5646 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005647 else
5648 term = "xterm";
5649 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005650 set_child_environment(
5651 (long)options->jo_term_rows,
5652 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005653 term,
5654 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005655 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005656 else
5657# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005658 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005659
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005660 if (options->jo_env != NULL)
5661 {
5662 dict_T *dict = options->jo_env;
5663 hashitem_T *hi;
5664 int todo = (int)dict->dv_hashtab.ht_used;
5665
5666 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5667 if (!HASHITEM_EMPTY(hi))
5668 {
5669 typval_T *item = &dict_lookup(hi)->di_tv;
5670
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00005671 vim_setenv(hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005672 --todo;
5673 }
5674 }
5675
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005676 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005677 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005678 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005679 if (null_fd < 0)
5680 {
5681 perror("opening /dev/null failed");
5682 _exit(OPEN_NULL_FAILED);
5683 }
5684 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005685
Bram Moolenaar223896d2017-08-02 22:33:28 +02005686 if (pty_slave_fd >= 0)
5687 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005688 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005689 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005690# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005691 // Try to become controlling tty (probably doesn't work,
5692 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005693 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5694# endif
5695 }
5696
Bram Moolenaar0f873732019-12-05 20:28:46 +01005697 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005698 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005699 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005700 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005701 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005702 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005703 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005704 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005705
Bram Moolenaar0f873732019-12-05 20:28:46 +01005706 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005707 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005708 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005709 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005710 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005711 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005712 }
5713 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005714 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005715 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005716 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005717 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005718 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005719
Bram Moolenaar0f873732019-12-05 20:28:46 +01005720 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005721 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005722 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005723 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005724 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005725 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005726 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005727 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005728
5729 if (fd_in[0] >= 0)
5730 close(fd_in[0]);
5731 if (fd_in[1] >= 0)
5732 close(fd_in[1]);
5733 if (fd_out[0] >= 0)
5734 close(fd_out[0]);
5735 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005736 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005737 if (fd_err[0] >= 0)
5738 close(fd_err[0]);
5739 if (fd_err[1] >= 0)
5740 close(fd_err[1]);
5741 if (pty_master_fd >= 0)
5742 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005743 close(pty_master_fd); // not used in the child
5744 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005745 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005746
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005747 if (null_fd >= 0)
5748 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005749
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005750 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5751 _exit(EXEC_FAILED);
5752
Bram Moolenaar0f873732019-12-05 20:28:46 +01005753 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005754 execvp(argv[0], argv);
5755
Bram Moolenaar4694a172016-04-21 14:05:23 +02005756 if (stderr_works)
5757 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005758# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005759 // calling free_all_mem() here causes problems. Ignore valgrind
5760 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005761# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005762 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005763 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005764
Bram Moolenaar0f873732019-12-05 20:28:46 +01005765 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005766 UNBLOCK_SIGNALS(&curset);
5767
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005768 job->jv_pid = pid;
5769 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005770 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005771
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005772 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005773 close(pty_slave_fd); // not used in the parent
5774 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005775 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005776 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005777 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005778 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005779 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005780 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005781 if (channel != NULL)
5782 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005783 int in_fd = INVALID_FD;
5784 int out_fd = INVALID_FD;
5785 int err_fd = INVALID_FD;
5786
5787 if (!(use_file_for_in || use_null_for_in))
5788 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5789
5790 if (!(use_file_for_out || use_null_for_out))
5791 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5792
5793 // When using pty_master_fd only set it for stdout, do not duplicate
5794 // it for stderr, it only needs to be read once.
5795 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5796 {
5797 if (fd_err[0] >= 0)
5798 err_fd = fd_err[0];
5799 else if (out_fd != pty_master_fd)
5800 err_fd = pty_master_fd;
5801 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005802
5803 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005804 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005805 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005806 else
5807 {
5808 if (fd_in[1] >= 0)
5809 close(fd_in[1]);
5810 if (fd_out[0] >= 0)
5811 close(fd_out[0]);
5812 if (fd_err[0] >= 0)
5813 close(fd_err[0]);
5814 if (pty_master_fd >= 0)
5815 close(pty_master_fd);
5816 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005817
Bram Moolenaar0f873732019-12-05 20:28:46 +01005818 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005819 return;
5820
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005821failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005822 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005823 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005824 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005825 if (fd_in[1] >= 0)
5826 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005827 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005828 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005829 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005830 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005831 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005832 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005833 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005834 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005835 if (pty_master_fd >= 0)
5836 close(pty_master_fd);
5837 if (pty_slave_fd >= 0)
5838 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005839}
5840
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005841 static char_u *
5842get_signal_name(int sig)
5843{
5844 int i;
5845 char_u numbuf[NUMBUFLEN];
5846
5847 if (sig == SIGKILL)
5848 return vim_strsave((char_u *)"kill");
5849
5850 for (i = 0; signal_info[i].sig != -1; i++)
5851 if (sig == signal_info[i].sig)
5852 return strlow_save((char_u *)signal_info[i].name);
5853
5854 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5855 return vim_strsave(numbuf);
5856}
5857
Bram Moolenaar835dc632016-02-07 14:27:38 +01005858 char *
5859mch_job_status(job_T *job)
5860{
5861# ifdef HAVE_UNION_WAIT
5862 union wait status;
5863# else
5864 int status = -1;
5865# endif
5866 pid_t wait_pid = 0;
5867
5868# ifdef __NeXT__
5869 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5870# else
5871 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5872# endif
5873 if (wait_pid == -1)
5874 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005875 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005876 if (job->jv_status < JOB_ENDED)
5877 ch_log(job->jv_channel, "Job no longer exists: %s",
5878 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005879 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005880 }
5881 if (wait_pid == 0)
5882 return "run";
5883 if (WIFEXITED(status))
5884 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005885 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005886 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005887 if (job->jv_status < JOB_ENDED)
5888 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005889 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005890 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005891 if (WIFSIGNALED(status))
5892 {
5893 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005894 job->jv_termsig = get_signal_name(WTERMSIG(status));
5895 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5896 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5897 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005898 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005899 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005900 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005901
5902return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005903 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005904 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005905 return "dead";
5906}
5907
5908 job_T *
5909mch_detect_ended_job(job_T *job_list)
5910{
5911# ifdef HAVE_UNION_WAIT
5912 union wait status;
5913# else
5914 int status = -1;
5915# endif
5916 pid_t wait_pid = 0;
5917 job_T *job;
5918
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005919# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005920 // Do not do this when waiting for a shell command to finish, we would get
5921 // the exit value here (and discard it), the exit value obtained there
5922 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005923 if (dont_check_job_ended > 0)
5924 return NULL;
5925# endif
5926
Bram Moolenaar97792de2016-10-15 18:36:49 +02005927# ifdef __NeXT__
5928 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5929# else
5930 wait_pid = waitpid(-1, &status, WNOHANG);
5931# endif
5932 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005933 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005934 return NULL;
5935 for (job = job_list; job != NULL; job = job->jv_next)
5936 {
5937 if (job->jv_pid == wait_pid)
5938 {
5939 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005940 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005941 job->jv_exitval = WEXITSTATUS(status);
5942 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005943 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005944 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005945 job->jv_termsig = get_signal_name(WTERMSIG(status));
5946 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005947 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005948 {
5949 ch_log(job->jv_channel, "Job ended");
5950 job->jv_status = JOB_ENDED;
5951 }
5952 return job;
5953 }
5954 }
5955 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005956}
5957
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005958/*
5959 * Send a (deadly) signal to "job".
5960 * Return FAIL if "how" is not a valid name.
5961 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005962 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005963mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005964{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005965 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005966
Bram Moolenaar923d9262016-02-25 20:56:01 +01005967 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005968 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005969 else if (STRCMP(how, "hup") == 0)
5970 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005971 else if (STRCMP(how, "quit") == 0)
5972 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005973 else if (STRCMP(how, "int") == 0)
5974 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005975 else if (STRCMP(how, "kill") == 0)
5976 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005977#ifdef SIGWINCH
5978 else if (STRCMP(how, "winch") == 0)
5979 sig = SIGWINCH;
5980#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005981 else if (isdigit(*how))
5982 sig = atoi((char *)how);
5983 else
5984 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005985
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005986 // Never kill ourselves!
5987 if (job->jv_pid != 0)
5988 {
5989 // TODO: have an option to only kill the process, not the group?
5990 kill(-job->jv_pid, sig);
5991 kill(job->jv_pid, sig);
5992 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005993
Bram Moolenaar835dc632016-02-07 14:27:38 +01005994 return OK;
5995}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005996
5997/*
5998 * Clear the data related to "job".
5999 */
6000 void
6001mch_clear_job(job_T *job)
6002{
Bram Moolenaar0f873732019-12-05 20:28:46 +01006003 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01006004# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01006005 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01006006# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01006007 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01006008# endif
6009}
Bram Moolenaar835dc632016-02-07 14:27:38 +01006010#endif
6011
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006012#if defined(FEAT_TERMINAL) || defined(PROTO)
6013 int
6014mch_create_pty_channel(job_T *job, jobopt_T *options)
6015{
6016 int pty_master_fd = -1;
6017 int pty_slave_fd = -1;
6018 channel_T *channel;
6019
Bram Moolenaar59386482019-02-10 22:43:46 +01006020 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02006021 if (pty_master_fd < 0 || pty_slave_fd < 0)
6022 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006023 close(pty_slave_fd);
6024
6025 channel = add_channel();
6026 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006027 {
6028 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006029 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006030 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02006031 if (job->jv_tty_out != NULL)
6032 ch_log(channel, "using pty %s on fd %d",
6033 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006034 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006035 channel->ch_keep_open = TRUE;
6036
Bram Moolenaar0f873732019-12-05 20:28:46 +01006037 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
6038 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006039 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006040 channel_set_job(channel, job, options);
6041 return OK;
6042}
6043#endif
6044
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045/*
6046 * Check for CTRL-C typed by reading all available characters.
6047 * In cooked mode we should get SIGINT, no need to check.
6048 */
6049 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006050mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051{
Bram Moolenaar26e86442020-05-17 14:06:16 +02006052 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006053 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 fill_input_buf(FALSE);
6055}
6056
6057/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006058 * Wait "msec" msec until a character is available from the mouse, keyboard,
6059 * from inbuf[].
6060 * "msec" == -1 will block forever.
6061 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006062 * When "ignore_input" is TRUE even check for pending input when input is
6063 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006064 * "interrupted" (if not NULL) is set to TRUE when no character is available
6065 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02006066 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006067 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 */
6069 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006070WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006072#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01006073 return ui_wait_for_chars_or_timer(
6074 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006075#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006076 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006077#endif
6078}
6079
6080/*
6081 * Wait "msec" msec until a character is available from the mouse or keyboard
6082 * or from inbuf[].
6083 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006084 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006085 * "interrupted" (if not NULL) is set to TRUE when no character is available
6086 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006087 * When a GUI is being used, this will never get called -- webb
6088 */
6089 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006090WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006091{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092#ifdef FEAT_MOUSE_GPM
6093 int gpm_process_wanted;
6094#endif
6095#ifdef FEAT_XCLIPBOARD
6096 int rest;
6097#endif
6098 int avail;
6099
Bram Moolenaar0f873732019-12-05 20:28:46 +01006100 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 return 1;
6102
6103#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006104 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 if (WantQueryMouse)
6106 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006107 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006108 if (!no_query_mouse_for_testing)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00006109 mch_write((char_u *)"\033[1'|", 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 }
6111#endif
6112
6113 /*
6114 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6115 * events. This is a bit complicated, because they might both be defined.
6116 */
6117#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6118# ifdef FEAT_XCLIPBOARD
6119 rest = 0;
6120 if (do_xterm_trace())
6121 rest = msec;
6122# endif
6123 do
6124 {
6125# ifdef FEAT_XCLIPBOARD
6126 if (rest != 0)
6127 {
6128 msec = XT_TRACE_DELAY;
6129 if (rest >= 0 && rest < XT_TRACE_DELAY)
6130 msec = rest;
6131 if (rest >= 0)
6132 rest -= msec;
6133 }
6134# endif
Yee Cheng Chin4314e4f2022-10-08 13:50:05 +01006135# ifdef FEAT_SOUND_MACOSX
6136 // Invoke any pending sound callbacks.
6137 process_cfrunloop();
6138# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006139# ifdef FEAT_SOUND_CANBERRA
6140 // Invoke any pending sound callbacks.
6141 if (has_sound_callback_in_queue())
6142 invoke_sound_callback();
6143# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144# ifdef FEAT_MOUSE_GPM
6145 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006146 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006147 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006148 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006150 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006152# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006154 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 return 1;
6156# ifdef FEAT_XCLIPBOARD
6157 if (rest == 0 || !do_xterm_trace())
6158# endif
6159 break;
6160 }
6161 }
6162 while (FALSE
6163# ifdef FEAT_MOUSE_GPM
6164 || (gpm_process_wanted && mch_gpm_process() == 0)
6165# endif
6166# ifdef FEAT_XCLIPBOARD
6167 || (!avail && rest != 0)
6168# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006169 )
6170 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171
6172#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006173 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174#endif
6175 return avail;
6176}
6177
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006178#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179/*
6180 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006181 * "msec" == 0 will check for characters once.
6182 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006185 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006186 * "interrupted" (if not NULL) is set to TRUE when no character is available
6187 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006189 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006190RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191{
6192 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006193 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006194#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 static int busy = FALSE;
6196
Bram Moolenaar0f873732019-12-05 20:28:46 +01006197 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198# define MAY_LOOP
6199
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006200# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006201 // Remember at what time we started, so that we know how much longer we
6202 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006203 long start_msec = msec;
6204 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006206 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006207 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208# endif
6209
Bram Moolenaar0f873732019-12-05 20:28:46 +01006210 // Handle being called recursively. This may happen for the session
6211 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 if (busy)
6213 return 0;
6214#endif
6215
6216#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006217 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218#endif
6219 {
6220#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006221 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006222# ifdef FEAT_MZSCHEME
6223 int mzquantum_used = FALSE;
6224# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225#endif
6226#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006227 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006228 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 int nfd;
6230# ifdef FEAT_XCLIPBOARD
6231 int xterm_idx = -1;
6232# endif
6233# ifdef FEAT_MOUSE_GPM
6234 int gpm_idx = -1;
6235# endif
6236# ifdef USE_XSMP
6237 int xsmp_idx = -1;
6238# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006239 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006241# ifdef FEAT_MZSCHEME
6242 mzvim_check_threads();
6243 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6244 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006245 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006246 mzquantum_used = TRUE;
6247 }
6248# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 fds[0].fd = fd;
6250 fds[0].events = POLLIN;
6251 nfd = 1;
6252
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006254 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 if (xterm_Shell != (Widget)0)
6256 {
6257 xterm_idx = nfd;
6258 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6259 fds[nfd].events = POLLIN;
6260 nfd++;
6261 }
6262# endif
6263# ifdef FEAT_MOUSE_GPM
6264 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6265 {
6266 gpm_idx = nfd;
6267 fds[nfd].fd = gpm_fd;
6268 fds[nfd].events = POLLIN;
6269 nfd++;
6270 }
6271# endif
6272# ifdef USE_XSMP
6273 if (xsmp_icefd != -1)
6274 {
6275 xsmp_idx = nfd;
6276 fds[nfd].fd = xsmp_icefd;
6277 fds[nfd].events = POLLIN;
6278 nfd++;
6279 }
6280# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006281#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006282 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006283#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006284 if (interrupted != NULL)
6285 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006287 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006288
6289 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006290 if (result == 0 && interrupted != NULL && ret > 0)
6291 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006292
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006293# ifdef FEAT_MZSCHEME
6294 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006295 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006296 finished = FALSE;
6297# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299# ifdef FEAT_XCLIPBOARD
6300 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6301 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006302 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006304 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 finished = FALSE;
6306 }
6307# endif
6308# ifdef FEAT_MOUSE_GPM
6309 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311# endif
6312# ifdef USE_XSMP
6313 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6314 {
6315 if (fds[xsmp_idx].revents & POLLIN)
6316 {
6317 busy = TRUE;
6318 xsmp_handle_requests();
6319 busy = FALSE;
6320 }
6321 else if (fds[xsmp_idx].revents & POLLHUP)
6322 {
6323 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006324 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 xsmp_close();
6326 }
6327 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006328 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 }
6330# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006331#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006332 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006333 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006334 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006335#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336
Bram Moolenaar0f873732019-12-05 20:28:46 +01006337#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338
6339 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006340 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006341 // These are static because they can take 8 Kbyte each and cause the
6342 // signal stack to run out with -O3.
6343 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006345 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006347# ifdef FEAT_MZSCHEME
6348 mzvim_check_threads();
6349 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6350 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006351 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006352 mzquantum_used = TRUE;
6353 }
6354# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006356 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006358 tv.tv_sec = towait / 1000;
6359 tv.tv_usec = (towait % 1000) * (1000000/1000);
6360 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006362 else
6363 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364
6365 /*
6366 * Select on ready for reading and exceptional condition (end of file).
6367 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006368select_eintr:
6369 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006370 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 FD_ZERO(&efds);
6372 FD_SET(fd, &rfds);
K.Takatab247e062022-02-07 10:45:23 +00006373# ifndef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006374 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 FD_SET(fd, &efds);
6376# endif
6377 maxfd = fd;
6378
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006380 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 if (xterm_Shell != (Widget)0)
6382 {
6383 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6384 if (maxfd < ConnectionNumber(xterm_dpy))
6385 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006386
Bram Moolenaar0f873732019-12-05 20:28:46 +01006387 // An event may have already been read but not handled. In
6388 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006389 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 }
6391# endif
6392# ifdef FEAT_MOUSE_GPM
6393 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6394 {
6395 FD_SET(gpm_fd, &rfds);
6396 FD_SET(gpm_fd, &efds);
6397 if (maxfd < gpm_fd)
6398 maxfd = gpm_fd;
6399 }
6400# endif
6401# ifdef USE_XSMP
6402 if (xsmp_icefd != -1)
6403 {
6404 FD_SET(xsmp_icefd, &rfds);
6405 FD_SET(xsmp_icefd, &efds);
6406 if (maxfd < xsmp_icefd)
6407 maxfd = xsmp_icefd;
6408 }
6409# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006410# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006411 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006412# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006413 if (interrupted != NULL)
6414 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415
Bram Moolenaar643b6142018-09-12 20:29:09 +02006416 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6417 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006418 result = ret > 0 && FD_ISSET(fd, &rfds);
6419 if (result)
6420 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006421 else if (interrupted != NULL && ret > 0)
6422 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006423
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006424# ifdef EINTR
6425 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006426 {
dbivolaruab16ad32021-12-29 19:41:47 +00006427 // Check whether the EINTR is caused by SIGTSTP
6428 if (got_tstp && !in_mch_suspend)
6429 {
6430 exarg_T ea;
dbivolaru79a6e252022-01-23 16:41:14 +00006431
dbivolaruab16ad32021-12-29 19:41:47 +00006432 ea.forceit = TRUE;
6433 ex_stop(&ea);
6434 got_tstp = FALSE;
6435 }
6436
Bram Moolenaar0f873732019-12-05 20:28:46 +01006437 // Check whether window has been resized, EINTR may be caused by
6438 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006439 if (do_resize)
6440 handle_resize();
6441
Bram Moolenaar0f873732019-12-05 20:28:46 +01006442 // Interrupted by a signal, need to try again. We ignore msec
6443 // here, because we do want to check even after a timeout if
6444 // characters are available. Needed for reading output of an
6445 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006446 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006447 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006448# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006449# ifdef __TANDEM
6450 if (ret == -1 && errno == ENOTSUP)
6451 {
6452 FD_ZERO(&rfds);
6453 FD_ZERO(&efds);
6454 ret = 0;
6455 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006456# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006457# ifdef FEAT_MZSCHEME
6458 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006459 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006460 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461# endif
6462
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463# ifdef FEAT_XCLIPBOARD
6464 if (ret > 0 && xterm_Shell != (Widget)0
6465 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6466 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006467 xterm_update(); // Maybe we should hand out clipboard
6468 // continue looping when we only got the X event and the input
6469 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 if (--ret == 0 && !input_available())
6471 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006472 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 finished = FALSE;
6474 }
6475 }
6476# endif
6477# ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00006478 if (ret > 0 && check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 {
6480 if (FD_ISSET(gpm_fd, &efds))
6481 gpm_close();
6482 else if (FD_ISSET(gpm_fd, &rfds))
6483 *check_for_gpm = 1;
6484 }
6485# endif
6486# ifdef USE_XSMP
6487 if (ret > 0 && xsmp_icefd != -1)
6488 {
6489 if (FD_ISSET(xsmp_icefd, &efds))
6490 {
6491 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006492 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 xsmp_close();
6494 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006495 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 }
6497 else if (FD_ISSET(xsmp_icefd, &rfds))
6498 {
6499 busy = TRUE;
6500 xsmp_handle_requests();
6501 busy = FALSE;
6502 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006503 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 }
6505 }
6506# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006507#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006508 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006509 if (ret >= 0)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01006510 (void)channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006511#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512
Bram Moolenaar0f873732019-12-05 20:28:46 +01006513#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514
6515#ifdef MAY_LOOP
6516 if (finished || msec == 0)
6517 break;
6518
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006519# ifdef FEAT_CLIENTSERVER
6520 if (server_waiting())
6521 break;
6522# endif
6523
Bram Moolenaar0f873732019-12-05 20:28:46 +01006524 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 if (msec > 0)
6526 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006527# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006528 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006529 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006531 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 msec = msec / 2;
6533# endif
6534 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006535 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 }
6537#endif
6538 }
6539
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006540 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541}
6542
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006544 * Expand a path into all matching files and/or directories. Handles "*",
6545 * "?", "[a-z]", "**", etc.
6546 * "path" has backslashes before chars that are not to be expanded.
6547 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 */
6549 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006550mch_expandpath(
6551 garray_T *gap,
6552 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006553 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554{
Bram Moolenaar02743632005-07-25 20:42:36 +00006555 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557
6558/*
6559 * mch_expand_wildcards() - this code does wild-card pattern matching using
6560 * the shell
6561 *
6562 * return OK for success, FAIL for error (you may lose some memory) and put
6563 * an error message in *file.
6564 *
6565 * num_pat is number of input patterns
6566 * pat is array of pointers to input patterns
6567 * num_file is pointer to number of matched file names
6568 * file is pointer to array of pointers to matched file names
6569 */
6570
6571#ifndef SEEK_SET
6572# define SEEK_SET 0
6573#endif
6574#ifndef SEEK_END
6575# define SEEK_END 2
6576#endif
6577
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006578#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006579
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006581mch_expand_wildcards(
6582 int num_pat,
6583 char_u **pat,
6584 int *num_file,
6585 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006586 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587{
6588 int i;
6589 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006590 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 char_u *p;
6592 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593
Bram Moolenaarc7247912008-01-13 12:54:11 +00006594 /*
6595 * This is the non-OS/2 implementation (really Unix).
6596 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 int j;
6598 char_u *tempname;
6599 char_u *command;
6600 FILE *fd;
6601 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006602#define STYLE_ECHO 0 // use "echo", the default
6603#define STYLE_GLOB 1 // use "glob", for csh
6604#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6605#define STYLE_PRINT 3 // use "print -N", for zsh
6606#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6607 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 int shell_style = STYLE_ECHO;
6609 int check_spaces;
6610 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006611 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006612 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006613 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614
Bram Moolenaar0f873732019-12-05 20:28:46 +01006615 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 *file = NULL;
6617
6618 /*
6619 * If there are no wildcards, just copy the names to allocated memory.
6620 * Saves a lot of time, because we don't have to start a new shell.
6621 */
6622 if (!have_wildcard(num_pat, pat))
6623 return save_patterns(num_pat, pat, num_file, file);
6624
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006625# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006626 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006627 if (sandbox != 0 && check_secure())
6628 return FAIL;
6629# endif
6630
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 /*
6632 * Don't allow the use of backticks in secure and restricted mode.
6633 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006634 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 for (i = 0; i < num_pat; ++i)
6636 if (vim_strchr(pat[i], '`') != NULL
6637 && (check_restricted() || check_secure()))
6638 return FAIL;
6639
6640 /*
6641 * get a name for the temp file
6642 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006643 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006645 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 return FAIL;
6647 }
6648
6649 /*
6650 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006651 * file.
6652 * STYLE_BT: NL separated
6653 * If expanding `cmd` execute it directly.
6654 * STYLE_GLOB: NUL separated
6655 * If we use *csh, "glob" will work better than "echo".
6656 * STYLE_PRINT: NL or NUL separated
6657 * If we use *zsh, "print -N" will work better than "glob".
6658 * STYLE_VIMGLOB: NL separated
6659 * If we use *sh*, we define "vimglob()".
6660 * STYLE_ECHO: space separated.
6661 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 */
6663 if (num_pat == 1 && *pat[0] == '`'
6664 && (len = STRLEN(pat[0])) > 2
6665 && *(pat[0] + len - 1) == '`')
6666 shell_style = STYLE_BT;
6667 else if ((len = STRLEN(p_sh)) >= 3)
6668 {
6669 if (STRCMP(p_sh + len - 3, "csh") == 0)
6670 shell_style = STYLE_GLOB;
6671 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6672 shell_style = STYLE_PRINT;
6673 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006674 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6675 "sh") != NULL)
6676 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677
Bram Moolenaar0f873732019-12-05 20:28:46 +01006678 // Compute the length of the command. We need 2 extra bytes: for the
6679 // optional '&' and for the NUL.
6680 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006682 if (shell_style == STYLE_VIMGLOB)
6683 len += STRLEN(sh_vimglob_func);
6684
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006685 for (i = 0; i < num_pat; ++i)
6686 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006687 // Count the length of the patterns in the same way as they are put in
6688 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006689#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006690 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006691#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006692 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006693 for (j = 0; pat[i][j] != NUL; ++j)
6694 {
6695 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006696 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006697 ++len;
6698 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006699#endif
6700 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 command = alloc(len);
6702 if (command == NULL)
6703 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006704 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 vim_free(tempname);
6706 return FAIL;
6707 }
6708
6709 /*
6710 * Build the shell command:
6711 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6712 * recognizes this).
6713 * - Add the shell command to print the expanded names.
6714 * - Add the temp file name.
6715 * - Add the file name patterns.
6716 */
6717 if (shell_style == STYLE_BT)
6718 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006719 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006720 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006721 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006723 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006724 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006726 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006728 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 *p = ' ';
6730 }
6731 STRCAT(command, ">");
6732 }
6733 else
6734 {
Christian Brabandt8b8d8292021-11-19 12:37:36 +00006735 STRCPY(command, "");
6736 if (shell_style == STYLE_GLOB)
6737 {
6738 // Assume the nonomatch option is valid only for csh like shells,
6739 // otherwise, this may set the positional parameters for the shell,
6740 // e.g. "$*".
6741 if (flags & EW_NOTFOUND)
6742 STRCAT(command, "set nonomatch; ");
6743 else
6744 STRCAT(command, "unset nonomatch; ");
6745 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 if (shell_style == STYLE_GLOB)
6747 STRCAT(command, "glob >");
6748 else if (shell_style == STYLE_PRINT)
6749 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006750 else if (shell_style == STYLE_VIMGLOB)
6751 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 else
6753 STRCAT(command, "echo >");
6754 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006755
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006757
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 if (shell_style != STYLE_BT)
6759 for (i = 0; i < num_pat; ++i)
6760 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006761 // When using system() always add extra quotes, because the shell
6762 // is started twice. Otherwise put a backslash before special
6763 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764#ifdef USE_SYSTEM
6765 STRCAT(command, " \"");
6766 STRCAT(command, pat[i]);
6767 STRCAT(command, "\"");
6768#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006769 int intick = FALSE;
6770
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 p = command + STRLEN(command);
6772 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006773 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006774 {
6775 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006776 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006777 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6778 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006779 // Remove a backslash, take char literally. But keep
6780 // backslash inside backticks, before a special character
6781 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006782 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006783 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6784 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006785 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006786 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006787 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006788 else if (!intick
6789 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6790 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006791 // Put a backslash before a special character, but not
6792 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6793 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006794 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006795
Bram Moolenaar0f873732019-12-05 20:28:46 +01006796 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006797 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006798 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 *p = NUL;
6800#endif
6801 }
6802 if (flags & EW_SILENT)
6803 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006804 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006805 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806
6807 /*
6808 * Using zsh -G: If a pattern has no matches, it is just deleted from
6809 * the argument list, otherwise zsh gives an error message and doesn't
6810 * expand any other pattern.
6811 */
6812 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006813 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814
6815 /*
6816 * If we use -f then shell variables set in .cshrc won't get expanded.
6817 * vi can do it, so we will too, but it is only necessary if there is a "$"
6818 * in one of the patterns, otherwise we can still use the fast option.
6819 */
6820 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006821 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822
6823 /*
6824 * execute the shell command
6825 */
6826 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6827
Bram Moolenaar0f873732019-12-05 20:28:46 +01006828 // When running in the background, give it some time to create the temp
6829 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006830 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02006831 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832
Bram Moolenaar0f873732019-12-05 20:28:46 +01006833 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 show_shell_mess = TRUE;
6835 vim_free(command);
6836
Bram Moolenaar0f873732019-12-05 20:28:46 +01006837 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 {
6839 mch_remove(tempname);
6840 vim_free(tempname);
6841 /*
6842 * With interactive completion, the error message is not printed.
6843 * However with USE_SYSTEM, I don't know how to turn off error messages
6844 * from the shell, so screen may still get messed up -- webb.
6845 */
6846#ifndef USE_SYSTEM
6847 if (!(flags & EW_SILENT))
6848#endif
6849 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006850 redraw_later_clear(); // probably messed up screen
6851 msg_putchar('\n'); // clear bottom line quickly
6852 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853#ifdef USE_SYSTEM
6854 if (!(flags & EW_SILENT))
6855#endif
6856 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006857 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006858 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 }
6860 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006861 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6862 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 if (shell_style == STYLE_BT)
6864 return FAIL;
6865 goto notfound;
6866 }
6867
6868 /*
6869 * read the names from the file into memory
6870 */
6871 fd = fopen((char *)tempname, READBIN);
6872 if (fd == NULL)
6873 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006874 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 if (!(flags & EW_SILENT))
6876 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006877 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006878 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 }
6880 vim_free(tempname);
6881 goto notfound;
6882 }
6883 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006884 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006886 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006887 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006888 buffer = NULL;
6889 else
6890 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 if (buffer == NULL)
6892 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006893 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 mch_remove(tempname);
6895 vim_free(tempname);
6896 fclose(fd);
6897 return FAIL;
6898 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006899 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 i = fread((char *)buffer, 1, len, fd);
6901 fclose(fd);
6902 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006903 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006905 // unexpected read error
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006906 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 vim_free(tempname);
6908 vim_free(buffer);
6909 return FAIL;
6910 }
6911 vim_free(tempname);
6912
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006913# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006914 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006916 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6918 *p++ = buffer[i];
6919 len = p - buffer;
6920# endif
6921
6922
Bram Moolenaar0f873732019-12-05 20:28:46 +01006923 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 if (shell_style == STYLE_ECHO)
6925 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006926 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006928 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 {
6930 while (*p != ' ' && *p != '\n')
6931 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006932 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 }
6934 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006935 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006936 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006938 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006940 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 {
6942 while (*p != '\n' && *p != NUL)
6943 ++p;
6944 if (*p != NUL)
6945 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006946 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 }
6948 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006949 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 else
6951 {
6952 /*
6953 * Some versions of zsh use spaces instead of NULs to separate
6954 * results. Only do this when there is no NUL before the end of the
6955 * buffer, otherwise we would never be able to use file names with
6956 * embedded spaces when zsh does use NULs.
6957 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6958 * don't check for spaces again.
6959 */
6960 check_spaces = FALSE;
6961 if (shell_style == STYLE_PRINT && !did_find_nul)
6962 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006963 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006964 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006965 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 did_find_nul = TRUE;
6967 else
6968 check_spaces = TRUE;
6969 }
6970
6971 /*
6972 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6973 * already is one, for STYLE_GLOB it needs to be added.
6974 */
6975 if (len && buffer[len - 1] == NUL)
6976 --len;
6977 else
6978 buffer[len] = NUL;
6979 i = 0;
6980 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006981 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 {
6983 ++i;
6984 *p = NUL;
6985 }
6986 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006987 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 }
6989 if (i == 0)
6990 {
6991 /*
6992 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6993 * /bin/sh will happily expand it to nothing rather than returning an
6994 * error; and hey, it's good to check anyway -- webb.
6995 */
6996 vim_free(buffer);
6997 goto notfound;
6998 }
6999 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007000 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 if (*file == NULL)
7002 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007003 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 vim_free(buffer);
7005 return FAIL;
7006 }
7007
7008 /*
7009 * Isolate the individual file names.
7010 */
7011 p = buffer;
7012 for (i = 0; i < *num_file; ++i)
7013 {
7014 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007015 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00007016 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
7017 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00007019 while (!(shell_style == STYLE_ECHO && *p == ' ')
7020 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007022 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 *p = NUL;
7024 else
7025 {
7026 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007027 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 }
7029 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007030 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007032 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007034 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 }
7036 }
7037
7038 /*
7039 * Move the file names to allocated memory.
7040 */
7041 for (j = 0, i = 0; i < *num_file; ++i)
7042 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007043 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
7045 continue;
7046
Bram Moolenaar0f873732019-12-05 20:28:46 +01007047 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 dir = (mch_isdir((*file)[i]));
7049 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
7050 continue;
7051
Bram Moolenaar0f873732019-12-05 20:28:46 +01007052 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01007053 if (!dir && (flags & EW_EXEC)
7054 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00007055 continue;
7056
Bram Moolenaar964b3742019-05-24 18:54:09 +02007057 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 if (p)
7059 {
7060 STRCPY(p, (*file)[i]);
7061 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007062 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 (*file)[j++] = p;
7064 }
7065 }
7066 vim_free(buffer);
7067 *num_file = j;
7068
Bram Moolenaar0f873732019-12-05 20:28:46 +01007069 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01007071 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 goto notfound;
7073 }
7074
7075 return OK;
7076
7077notfound:
7078 if (flags & EW_NOTFOUND)
7079 return save_patterns(num_pat, pat, num_file, file);
7080 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081}
7082
Bram Moolenaar0f873732019-12-05 20:28:46 +01007083#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007086save_patterns(
7087 int num_pat,
7088 char_u **pat,
7089 int *num_file,
7090 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091{
7092 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00007093 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007095 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 if (*file == NULL)
7097 return FAIL;
7098 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00007099 {
7100 s = vim_strsave(pat[i]);
7101 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007102 // Be compatible with expand_filename(): halve the number of
7103 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007104 backslash_halve(s);
7105 (*file)[i] = s;
7106 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 *num_file = num_pat;
7108 return OK;
7109}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111/*
7112 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7113 * expand.
7114 */
7115 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007116mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007118 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 if (*p == '\\' && p[1] != NUL)
7121 ++p;
7122 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 if (vim_strchr((char_u *)
7124#ifdef VMS
7125 "*?%"
7126#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128#endif
7129 , *p) != NULL)
7130 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 }
7132 return FALSE;
7133}
7134
7135/*
7136 * Return TRUE if the string "p" contains a wildcard.
7137 * Don't recognize '~' at the end as a wildcard.
7138 */
7139 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007140mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007142 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 if (*p == '\\' && p[1] != NUL)
7145 ++p;
7146 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 if (vim_strchr((char_u *)
7148#ifdef VMS
7149 "*?%$"
7150#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152#endif
7153 , *p) != NULL
7154 || (*p == '~' && p[1] != NUL))
7155 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 }
7157 return FALSE;
7158}
7159
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007161have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162{
7163 int i;
7164
7165 for (i = 0; i < num; i++)
7166 if (mch_has_wildcard(file[i]))
7167 return 1;
7168 return 0;
7169}
7170
7171 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007172have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173{
7174 int i;
7175
7176 for (i = 0; i < num; i++)
7177 if (vim_strchr(file[i], '$') != NULL)
7178 return TRUE;
7179 return FALSE;
7180}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007182#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183/*
7184 * Scaled-down version of rename(), which is missing in Xenix.
7185 * This version can only move regular files and will fail if the
7186 * destination exists.
7187 */
7188 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007189mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190{
7191 struct stat st;
7192
Bram Moolenaar0f873732019-12-05 20:28:46 +01007193 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007195 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007197 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 return 0;
7199 return -1;
7200}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007201#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007203#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007204# if defined(DYNAMIC_GPM) || defined(PROTO)
7205/*
7206 * Initialize Gpm's symbols for dynamic linking.
7207 * Must be called only if libgpm_hinst is NULL.
7208 */
7209 static int
7210load_libgpm(void)
7211{
7212 libgpm_hinst = dlopen("libgpm.so", RTLD_LAZY|RTLD_GLOBAL);
7213
7214 if (libgpm_hinst == NULL)
7215 {
7216 if (p_verbose > 0)
7217 smsg_attr(HL_ATTR(HLF_W),
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007218 _("Could not load gpm library: %s"), dlerror());
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007219 return FAIL;
7220 }
7221
7222 if (
7223 (dll_Gpm_Open = dlsym(libgpm_hinst, "Gpm_Open")) == NULL
7224 || (dll_Gpm_Close = dlsym(libgpm_hinst, "Gpm_Close")) == NULL
7225 || (dll_Gpm_GetEvent = dlsym(libgpm_hinst, "Gpm_GetEvent")) == NULL
7226 || (dll_gpm_flag = dlsym(libgpm_hinst, "gpm_flag")) == NULL
7227 || (dll_gpm_fd = dlsym(libgpm_hinst, "gpm_fd")) == NULL
7228 )
7229 {
7230 semsg(_(e_could_not_load_library_str_str), "gpm", dlerror());
7231 dlclose(libgpm_hinst);
7232 libgpm_hinst = NULL;
7233 dll_gpm_flag = NULL;
7234 dll_gpm_fd = NULL;
7235 return FAIL;
7236 }
7237 return OK;
7238}
7239
7240 int
7241gpm_available(void)
7242{
7243 return libgpm_hinst != NULL || load_libgpm() == OK;
7244}
7245# endif // DYNAMIC_GPM
7246
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247/*
7248 * Initializes connection with gpm (if it isn't already opened)
7249 * Return 1 if succeeded (or connection already opened), 0 if failed
7250 */
7251 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007252gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007254 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007256#ifdef DYNAMIC_GPM
7257 if (!gpm_available())
7258 return 0;
7259#endif
7260
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 if (!gpm_flag)
7262 {
7263 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7264 gpm_connect.defaultMask = ~GPM_HARD;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007265 // Default handling for mouse move
7266 gpm_connect.minMod = 0; // Handle any modifier keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 gpm_connect.maxMod = 0xffff;
7268 if (Gpm_Open(&gpm_connect, 0) > 0)
7269 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007270 // gpm library tries to handling TSTP causes
7271 // problems. Anyways, we close connection to Gpm whenever
7272 // we are going to suspend or starting an external process
7273 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007274# ifdef SIGTSTP
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007275 signal(SIGTSTP, restricted ? SIG_IGN : (void (*)())sig_tstp);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007276# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007277 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 }
7279 if (gpm_fd == -2)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007280 Gpm_Close(); // We don't want to talk to xterm via gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 return 0;
7282 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007283 return 1; // already open
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284}
7285
7286/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007287 * Returns TRUE if the GPM mouse is enabled.
7288 */
7289 int
7290gpm_enabled(void)
7291{
7292 return gpm_flag && gpm_fd >= 0;
7293}
7294
7295/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 */
7298 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007299gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007301 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 Gpm_Close();
7303}
7304
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007305/*
7306 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007308 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 */
7310 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007311mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312{
7313 int button;
7314 static Gpm_Event gpm_event;
7315 char_u string[6];
7316 int_u vim_modifiers;
7317 int row,col;
7318 unsigned char buttons_mask;
7319 unsigned char gpm_modifiers;
7320 static unsigned char old_buttons = 0;
7321
7322 Gpm_GetEvent(&gpm_event);
7323
7324#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007325 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 if (hold_gui_events)
7327 return 0;
7328#endif
7329
7330 row = gpm_event.y - 1;
7331 col = gpm_event.x - 1;
7332
Bram Moolenaar0f873732019-12-05 20:28:46 +01007333 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 string[1] = 'M';
7335 string[2] = 'G';
7336 switch (GPM_BARE_EVENTS(gpm_event.type))
7337 {
7338 case GPM_DRAG:
7339 string[3] = MOUSE_DRAG;
7340 break;
7341 case GPM_DOWN:
7342 buttons_mask = gpm_event.buttons & ~old_buttons;
7343 old_buttons = gpm_event.buttons;
7344 switch (buttons_mask)
7345 {
7346 case GPM_B_LEFT:
7347 button = MOUSE_LEFT;
7348 break;
7349 case GPM_B_MIDDLE:
7350 button = MOUSE_MIDDLE;
7351 break;
7352 case GPM_B_RIGHT:
7353 button = MOUSE_RIGHT;
7354 break;
7355 default:
7356 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007357 // Don't know what to do. Can more than one button be
7358 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 }
7360 string[3] = (char_u)(button | 0x20);
7361 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7362 break;
7363 case GPM_UP:
7364 string[3] = MOUSE_RELEASE;
7365 old_buttons &= ~gpm_event.buttons;
7366 break;
7367 default:
7368 return 0;
7369 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007370 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 gpm_modifiers = gpm_event.modifiers;
7372 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007373 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7374 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7375 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7377 vim_modifiers |= MOUSE_SHIFT;
7378
7379 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7380 vim_modifiers |= MOUSE_CTRL;
7381 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7382 vim_modifiers |= MOUSE_ALT;
7383 string[3] |= vim_modifiers;
7384 string[4] = (char_u)(col + ' ' + 1);
7385 string[5] = (char_u)(row + ' ' + 1);
7386 add_to_input_buf(string, 6);
7387 return 6;
7388}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007389#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007391#ifdef FEAT_SYSMOUSE
7392/*
7393 * Initialize connection with sysmouse.
7394 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7395 * output, any sysmouse output than will be processed via sig_sysmouse().
7396 * Return OK if succeeded, FAIL if failed.
7397 */
7398 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007399sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007400{
7401 struct mouse_info mouse;
7402
7403 mouse.operation = MOUSE_MODE;
7404 mouse.u.mode.mode = 0;
7405 mouse.u.mode.signal = SIGUSR2;
7406 if (ioctl(1, CONS_MOUSECTL, &mouse) != -1)
7407 {
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007408 signal(SIGUSR2, (void (*)())sig_sysmouse);
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007409 mouse.operation = MOUSE_SHOW;
7410 ioctl(1, CONS_MOUSECTL, &mouse);
7411 return OK;
7412 }
7413 return FAIL;
7414}
7415
7416/*
7417 * Stop processing SIGUSR2 signals, and also make sure that
7418 * virtual console do not send us any sysmouse related signal.
7419 */
7420 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007421sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007422{
7423 struct mouse_info mouse;
7424
7425 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7426 mouse.operation = MOUSE_MODE;
7427 mouse.u.mode.mode = 0;
7428 mouse.u.mode.signal = 0;
7429 ioctl(1, CONS_MOUSECTL, &mouse);
7430}
7431
7432/*
7433 * Gets info from sysmouse and adds special keys to input buf.
7434 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007435 static void
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007436sig_sysmouse SIGDEFARG(sigarg)
7437{
7438 struct mouse_info mouse;
7439 struct video_info video;
7440 char_u string[6];
7441 int row, col;
7442 int button;
7443 int buttons;
7444 static int oldbuttons = 0;
7445
7446#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007447 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007448 if (hold_gui_events)
7449 return;
7450#endif
7451
7452 mouse.operation = MOUSE_GETINFO;
7453 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7454 && ioctl(1, FBIO_MODEINFO, &video) != -1
7455 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7456 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7457 {
7458 row = mouse.u.data.y / video.vi_cheight;
7459 col = mouse.u.data.x / video.vi_cwidth;
7460 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007461 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007462 string[1] = 'M';
7463 string[2] = 'S';
7464 if (oldbuttons == buttons && buttons != 0)
7465 {
7466 button = MOUSE_DRAG;
7467 }
7468 else
7469 {
7470 switch (buttons)
7471 {
7472 case 0:
7473 button = MOUSE_RELEASE;
7474 break;
7475 case 1:
7476 button = MOUSE_LEFT;
7477 break;
7478 case 2:
7479 button = MOUSE_MIDDLE;
7480 break;
7481 case 4:
7482 button = MOUSE_RIGHT;
7483 break;
7484 default:
7485 return;
7486 }
7487 oldbuttons = buttons;
7488 }
7489 string[3] = (char_u)(button);
7490 string[4] = (char_u)(col + ' ' + 1);
7491 string[5] = (char_u)(row + ' ' + 1);
7492 add_to_input_buf(string, 6);
7493 }
7494 return;
7495}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007496#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007497
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007499typedef char_u * (*STRPROCSTR)(char_u *);
7500typedef char_u * (*INTPROCSTR)(int);
7501typedef int (*STRPROCINT)(char_u *);
7502typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503
7504/*
7505 * Call a DLL routine which takes either a string or int param
7506 * and returns an allocated string.
7507 */
7508 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007509mch_libcall(
7510 char_u *libname,
7511 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007512 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007513 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007514 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007515 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516{
7517# if defined(USE_DLOPEN)
7518 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007519 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520# else
7521 shl_t hinstLib;
7522# endif
7523 STRPROCSTR ProcAdd;
7524 INTPROCSTR ProcAddI;
7525 char_u *retval_str = NULL;
7526 int retval_int = 0;
7527 int success = FALSE;
7528
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007529 /*
7530 * Get a handle to the DLL module.
7531 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007533 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007534 (void)dlerror();
7535
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 hinstLib = dlopen((char *)libname, RTLD_LAZY
7537# ifdef RTLD_LOCAL
7538 | RTLD_LOCAL
7539# endif
7540 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007541 if (hinstLib == NULL)
7542 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007543 // "dlerr" must be used before dlclose()
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007544 dlerr = dlerror();
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007545 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007546 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007547 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548# else
7549 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7550# endif
7551
Bram Moolenaar0f873732019-12-05 20:28:46 +01007552 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 if (hinstLib != NULL)
7554 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007555# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 /*
7557 * Catch a crash when calling the library function. For example when
7558 * using a number where a string pointer is expected.
7559 */
7560 mch_startjmp();
7561 if (SETJMP(lc_jump_env) != 0)
7562 {
7563 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007564# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007565 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007566# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 mch_didjmp();
7568 }
7569 else
7570# endif
7571 {
7572 retval_str = NULL;
7573 retval_int = 0;
7574
7575 if (argstring != NULL)
7576 {
7577# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007578 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007579 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580# else
7581 if (shl_findsym(&hinstLib, (const char *)funcname,
7582 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7583 ProcAdd = NULL;
7584# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007585 if ((success = (ProcAdd != NULL
7586# if defined(USE_DLOPEN)
7587 && dlerr == NULL
7588# endif
7589 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 {
7591 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007592 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 else
7594 retval_str = (ProcAdd)(argstring);
7595 }
7596 }
7597 else
7598 {
7599# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007600 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007601 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602# else
7603 if (shl_findsym(&hinstLib, (const char *)funcname,
7604 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7605 ProcAddI = NULL;
7606# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007607 if ((success = (ProcAddI != NULL
7608# if defined(USE_DLOPEN)
7609 && dlerr == NULL
7610# endif
7611 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 {
7613 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007614 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 else
7616 retval_str = (ProcAddI)(argint);
7617 }
7618 }
7619
Bram Moolenaar0f873732019-12-05 20:28:46 +01007620 // Save the string before we free the library.
7621 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 if (string_result == NULL)
7623 *number_result = retval_int;
7624 else if (retval_str != NULL
7625 && retval_str != (char_u *)1
7626 && retval_str != (char_u *)-1)
7627 *string_result = vim_strsave(retval_str);
7628 }
7629
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007630# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 mch_endjmp();
7632# ifdef SIGHASARG
7633 if (lc_signal != 0)
7634 {
7635 int i;
7636
Bram Moolenaar0f873732019-12-05 20:28:46 +01007637 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 for (i = 0; signal_info[i].sig != -1; i++)
7639 if (lc_signal == signal_info[i].sig)
7640 break;
Bram Moolenaarac78dd42022-01-02 19:25:26 +00007641 semsg(e_got_sig_str_in_libcall, signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 }
7643# endif
7644# endif
7645
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007647 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007648 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007649 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007650
Bram Moolenaar0f873732019-12-05 20:28:46 +01007651 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 (void)dlclose(hinstLib);
7653# else
7654 (void)shl_unload(hinstLib);
7655# endif
7656 }
7657
7658 if (!success)
7659 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007660 semsg(_(e_library_call_failed_for_str), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 return FAIL;
7662 }
7663
7664 return OK;
7665}
7666#endif
7667
7668#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007669static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670static int xterm_button;
7671
7672/*
7673 * Setup a dummy window for X selections in a terminal.
7674 */
7675 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007676setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677{
7678 int z = 0;
7679 char *strp = "";
7680 Widget AppShell;
7681
7682 if (!x_connect_to_server())
7683 return;
7684
7685 open_app_context();
7686 if (app_context != NULL && xterm_Shell == (Widget)0)
7687 {
7688 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007689# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007691# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007692# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007693 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694
7695 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007696 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697# endif
7698
Bram Moolenaar0f873732019-12-05 20:28:46 +01007699 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 oldhandler = XSetErrorHandler(x_error_check);
7701
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007702# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007703 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7705 mch_startjmp();
7706 if (SETJMP(lc_jump_env) != 0)
7707 {
7708 mch_didjmp();
7709 xterm_dpy = NULL;
7710 }
7711 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007712# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 {
7714 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7715 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007716 if (xterm_dpy != NULL)
7717 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007718# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007720# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 }
7722
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007723# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007724 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007726# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007727 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 (void)XSetErrorHandler(oldhandler);
7729
7730 if (xterm_dpy == NULL)
7731 {
7732 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007733 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 return;
7735 }
7736
Bram Moolenaar0f873732019-12-05 20:28:46 +01007737 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 (void)XSetIOErrorHandler(x_IOerror_handler);
7739
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007740# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007742 {
7743 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007744 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007745 verbose_leave();
7746 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747# endif
7748
Bram Moolenaar0f873732019-12-05 20:28:46 +01007749 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7751 applicationShellWidgetClass, xterm_dpy,
7752 NULL);
7753 if (AppShell == (Widget)0)
7754 return;
7755 xterm_Shell = XtVaCreatePopupShell("VIM",
7756 topLevelShellWidgetClass, AppShell,
7757 XtNmappedWhenManaged, 0,
7758 XtNwidth, 1,
7759 XtNheight, 1,
7760 NULL);
7761 if (xterm_Shell == (Widget)0)
7762 return;
7763
7764 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007765 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 if (x11_display == NULL)
7767 x11_display = xterm_dpy;
7768
7769 XtRealizeWidget(xterm_Shell);
7770 XSync(xterm_dpy, False);
7771 xterm_update();
7772 }
7773 if (xterm_Shell != (Widget)0)
7774 {
7775 clip_init(TRUE);
7776 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7777 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007778 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 if (test_x11_window(xterm_dpy) == FAIL)
7780 x11_window = 0;
7781 if (x11_window != 0)
7782 xterm_trace = 0;
7783 }
7784}
7785
7786 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007787start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788{
7789 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7790 return;
7791 xterm_trace = 1;
7792 xterm_button = button;
7793 do_xterm_trace();
7794}
7795
7796
7797 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007798stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799{
7800 if (xterm_trace < 0)
7801 return;
7802 xterm_trace = 0;
7803}
7804
7805/*
7806 * Query the xterm pointer and generate mouse termcodes if necessary
7807 * return TRUE if dragging is active, else FALSE
7808 */
7809 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007810do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811{
7812 Window root, child;
7813 int root_x, root_y;
7814 int win_x, win_y;
7815 int row, col;
7816 int_u mask_return;
7817 char_u buf[50];
7818 char_u *strp;
7819 long got_hints;
7820 static char_u *mouse_code;
7821 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7822 static int prev_row = 0, prev_col = 0;
7823 static XSizeHints xterm_hints;
7824
7825 if (xterm_trace <= 0)
7826 return FALSE;
7827
7828 if (xterm_trace == 1)
7829 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007830 // Get the hints just before tracking starts. The font size might
7831 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007832 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7833 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 || xterm_hints.width_inc <= 1
7835 || xterm_hints.height_inc <= 1)
7836 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007837 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 return FALSE;
7839 }
7840
Bram Moolenaar0f873732019-12-05 20:28:46 +01007841 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 mouse_code = find_termcode(mouse_name);
7843 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007844 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 xterm_trace = 2;
7846
Bram Moolenaar0f873732019-12-05 20:28:46 +01007847 // Find the offset of the chars, there might be a scrollbar on the
7848 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7850 &win_x, &win_y, &mask_return);
7851 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7852 - (xterm_hints.height_inc / 2);
7853 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7854 xterm_hints.y = 2;
7855 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7856 - (xterm_hints.width_inc / 2);
7857 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7858 xterm_hints.x = 2;
7859 return TRUE;
7860 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007861 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 {
7863 xterm_trace = 0;
7864 return FALSE;
7865 }
7866
7867 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7868 &win_x, &win_y, &mask_return);
7869
7870 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7871 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7872 if (row == prev_row && col == prev_col)
7873 return TRUE;
7874
7875 STRCPY(buf, mouse_code);
7876 strp = buf + STRLEN(buf);
7877 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7878 *strp++ = (char_u)(col + ' ' + 1);
7879 *strp++ = (char_u)(row + ' ' + 1);
7880 *strp = 0;
7881 add_to_input_buf(buf, STRLEN(buf));
7882
7883 prev_row = row;
7884 prev_col = col;
7885 return TRUE;
7886}
7887
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007888# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889/*
7890 * Destroy the display, window and app_context. Required for GTK.
7891 */
7892 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007893clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894{
7895 if (xterm_Shell != (Widget)0)
7896 {
7897 XtDestroyWidget(xterm_Shell);
7898 xterm_Shell = (Widget)0;
7899 }
7900 if (xterm_dpy != NULL)
7901 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007902# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007903 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007905# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 if (x11_display == xterm_dpy)
7907 x11_display = NULL;
7908 xterm_dpy = NULL;
7909 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007910# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 if (app_context != (XtAppContext)NULL)
7912 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007913 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 XtDestroyApplicationContext(app_context);
7915 app_context = (XtAppContext)NULL;
7916 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007917# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918}
7919# endif
7920
7921/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007922 * Catch up with GUI or X events.
7923 */
7924 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007925clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007926{
7927# ifdef FEAT_GUI
7928 if (gui.in_use)
7929 gui_mch_update();
7930 else
7931# endif
7932 if (xterm_Shell != (Widget)0)
7933 xterm_update();
7934}
7935
7936/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 * Catch up with any queued X events. This may put keyboard input into the
7938 * input buffer, call resize call-backs, trigger timers etc. If there is
7939 * nothing in the X event queue (& no timers pending), then we return
7940 * immediately.
7941 */
7942 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007943xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944{
7945 XEvent event;
7946
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007947 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007949 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007951 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007952 break;
7953
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007954 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007955 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007956 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007957 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007958#ifdef FEAT_CLIENTSERVER
7959 {
7960 XPropertyEvent *e = (XPropertyEvent *)&event;
7961
7962 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007964 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007965 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007967 XtDispatchEvent(&event);
7968 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007969 else
7970 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007971 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007972 XtAppProcessEvent(app_context, mask);
7973 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 }
7975}
7976
7977 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007978clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979{
7980 if (xterm_Shell != (Widget)0)
7981 return clip_x11_own_selection(xterm_Shell, cbd);
7982 return FAIL;
7983}
7984
7985 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007986clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987{
7988 if (xterm_Shell != (Widget)0)
7989 clip_x11_lose_selection(xterm_Shell, cbd);
7990}
7991
7992 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007993clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994{
7995 if (xterm_Shell != (Widget)0)
7996 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7997}
7998
7999 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02008000clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001{
8002 clip_x11_set_selection(cbd);
8003}
8004#endif
8005
8006
8007#if defined(USE_XSMP) || defined(PROTO)
8008/*
8009 * Code for X Session Management Protocol.
8010 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011
8012# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013/*
8014 * This is our chance to ask the user if they want to save,
8015 * or abort the logout
8016 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008018xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019{
Bram Moolenaare1004402020-10-24 20:49:43 +02008020 int save_cmod_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 int cancel_shutdown = False;
8022
Bram Moolenaare1004402020-10-24 20:49:43 +02008023 save_cmod_flags = cmdmod.cmod_flags;
8024 cmdmod.cmod_flags |= CMOD_CONFIRM;
Bram Moolenaar027387f2016-01-02 22:25:52 +01008025 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01008026 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 cancel_shutdown = True;
Bram Moolenaare1004402020-10-24 20:49:43 +02008028 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar0f873732019-12-05 20:28:46 +01008029 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030 out_flush();
8031
Bram Moolenaar0f873732019-12-05 20:28:46 +01008032 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 SmcInteractDone(smc_conn, cancel_shutdown);
8034
Bram Moolenaar0f873732019-12-05 20:28:46 +01008035 // Finish off
8036 // Only end save-yourself here if we're not cancelling shutdown;
8037 // we'll get a cancelled callback later in which we'll end it.
8038 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 if (!cancel_shutdown)
8040 {
8041 xsmp.save_yourself = False;
8042 SmcSaveYourselfDone(smc_conn, True);
8043 }
8044}
8045# endif
8046
8047/*
8048 * Callback that starts save-yourself.
8049 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008051xsmp_handle_save_yourself(
8052 SmcConn smc_conn,
8053 SmPointer client_data UNUSED,
8054 int save_type UNUSED,
8055 Bool shutdown,
8056 int interact_style UNUSED,
8057 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008059 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 if (xsmp.save_yourself)
8061 SmcSaveYourselfDone(smc_conn, True);
8062 xsmp.save_yourself = True;
8063 xsmp.shutdown = shutdown;
8064
Bram Moolenaar0f873732019-12-05 20:28:46 +01008065 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01008067 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068
8069 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008070 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071
8072# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008073 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008075 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076 SmcInteractRequest(smc_conn, SmDialogError,
8077 xsmp_handle_interaction, client_data);
8078 else
8079# endif
8080 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008081 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 SmcSaveYourselfDone(smc_conn, True);
8083 xsmp.save_yourself = False;
8084 }
8085}
8086
8087
8088/*
8089 * Callback to warn us of imminent death.
8090 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008092xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093{
8094 xsmp_close();
8095
Bram Moolenaar0f873732019-12-05 20:28:46 +01008096 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 getout_preserve_modified(0);
8098}
8099
8100
8101/*
8102 * Callback to tell us that save-yourself has completed.
8103 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008105xsmp_save_complete(
8106 SmcConn smc_conn UNUSED,
8107 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108{
8109 xsmp.save_yourself = False;
8110}
8111
8112
8113/*
8114 * Callback to tell us that an instigated shutdown was cancelled
8115 * (maybe even by us)
8116 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008118xsmp_shutdown_cancelled(
8119 SmcConn smc_conn,
8120 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121{
8122 if (xsmp.save_yourself)
8123 SmcSaveYourselfDone(smc_conn, True);
8124 xsmp.save_yourself = False;
8125 xsmp.shutdown = False;
8126}
8127
8128
8129/*
8130 * Callback to tell us that a new ICE connection has been established.
8131 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008133xsmp_ice_connection(
8134 IceConn iceConn,
8135 IcePointer clientData UNUSED,
8136 Bool opening,
8137 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008139 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 if (opening)
8141 {
8142 xsmp_icefd = IceConnectionNumber(iceConn);
8143 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
8144 }
8145}
8146
8147
Bram Moolenaar0f873732019-12-05 20:28:46 +01008148// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 int
Bram Moolenaar05540972016-01-30 20:31:25 +01008150xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151{
8152 Bool rep;
8153
8154 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8155 == IceProcessMessagesIOError)
8156 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008157 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008159 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 xsmp_close();
8161 return FAIL;
8162 }
8163 else
8164 return OK;
8165}
8166
8167static int dummy;
8168
Bram Moolenaar0f873732019-12-05 20:28:46 +01008169// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 void
8171xsmp_init(void)
8172{
8173 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 SmcCallbacks smcallbacks;
8175#if 0
8176 SmPropValue smname;
8177 SmProp smnameprop;
8178 SmProp *smprops[1];
8179#endif
8180
8181 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008182 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183
8184 xsmp.save_yourself = xsmp.shutdown = False;
8185
Bram Moolenaar0f873732019-12-05 20:28:46 +01008186 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8188 smcallbacks.save_yourself.client_data = NULL;
8189 smcallbacks.die.callback = xsmp_die;
8190 smcallbacks.die.client_data = NULL;
8191 smcallbacks.save_complete.callback = xsmp_save_complete;
8192 smcallbacks.save_complete.client_data = NULL;
8193 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8194 smcallbacks.shutdown_cancelled.client_data = NULL;
8195
Bram Moolenaar0f873732019-12-05 20:28:46 +01008196 // Set up a watch on ICE connection creations. The "dummy" argument is
8197 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8199 {
8200 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008201 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 return;
8203 }
8204
Bram Moolenaar0f873732019-12-05 20:28:46 +01008205 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 xsmp.smcconn = SmcOpenConnection(
8207 NULL,
8208 NULL,
8209 SmProtoMajor,
8210 SmProtoMinor,
8211 SmcSaveYourselfProcMask | SmcDieProcMask
8212 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8213 &smcallbacks,
8214 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008215 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008216 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 errorstring);
8218 if (xsmp.smcconn == NULL)
8219 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008221 {
Bram Moolenaare1be1182020-10-24 13:30:51 +02008222 char errorreport[132];
8223
8224 // If the message is too long it might not be NUL terminated. Add
8225 // a NUL at the end to make sure we don't go over the end.
8226 errorstring[sizeof(errorstring) - 1] = NUL;
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008227 vim_snprintf(errorreport, sizeof(errorreport),
8228 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008229 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008230 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 return;
8232 }
8233 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8234
8235#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008236 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237 smname.value = "vim";
8238 smname.length = 3;
8239 smnameprop.name = "SmProgram";
8240 smnameprop.type = "SmARRAY8";
8241 smnameprop.num_vals = 1;
8242 smnameprop.vals = &smname;
8243
8244 smprops[0] = &smnameprop;
8245 SmcSetProperties(xsmp.smcconn, 1, smprops);
8246#endif
8247}
8248
8249
Bram Moolenaar0f873732019-12-05 20:28:46 +01008250// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008252xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253{
8254 if (xsmp_icefd != -1)
8255 {
8256 SmcCloseConnection(xsmp.smcconn, 0, NULL);
Bram Moolenaar5a221812008-11-12 12:08:45 +00008257 if (xsmp.clientid != NULL)
8258 free(xsmp.clientid);
Bram Moolenaare8208012008-06-20 09:59:25 +00008259 xsmp.clientid = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 xsmp_icefd = -1;
8261 }
8262}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008263#endif // USE_XSMP
Paul Ollis65745772022-06-05 16:55:54 +01008264
8265#if defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008266# if defined(HAVE_TIMER_CREATE) || defined(PROTO)
Paul Ollis65745772022-06-05 16:55:54 +01008267/*
8268 * Implement timeout with timer_create() and timer_settime().
8269 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008270static volatile sig_atomic_t timeout_flag = FALSE;
8271static timer_t timer_id;
8272static int timer_created = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008273
8274/*
8275 * Callback for when the timer expires.
8276 */
8277 static void
8278set_flag(union sigval _unused UNUSED)
8279{
8280 timeout_flag = TRUE;
8281}
8282
8283/*
8284 * Stop any active timeout.
8285 */
8286 void
8287stop_timeout(void)
8288{
8289 static struct itimerspec disarm = {{0, 0}, {0, 0}};
8290
8291 if (timer_created)
8292 {
8293 int ret = timer_settime(timer_id, 0, &disarm, NULL);
8294
8295 if (ret < 0)
8296 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8297 }
8298
8299 // Clear the current timeout flag; any previous timeout should be
8300 // considered _not_ triggered.
8301 timeout_flag = FALSE;
8302}
8303
8304/*
8305 * Start the timeout timer.
8306 *
8307 * The return value is a pointer to a flag that is initialised to FALSE. If the
8308 * timeout expires, the flag is set to TRUE. This will only return pointers to
8309 * static memory; i.e. any pointer returned by this function may always be
8310 * safely dereferenced.
8311 *
8312 * This function is not expected to fail, but if it does it will still return a
8313 * valid flag pointer; the flag will remain stuck as FALSE .
8314 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008315 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008316start_timeout(long msec)
8317{
8318 struct itimerspec interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008319 {0, 0}, // Do not repeat.
8320 {msec / 1000, (msec % 1000) * 1000000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008321 int ret;
8322
8323 // This is really the caller's responsibility, but let's make sure the
8324 // previous timer has been stopped.
8325 stop_timeout();
Paul Ollis65745772022-06-05 16:55:54 +01008326
8327 if (!timer_created)
8328 {
8329 struct sigevent action = {0};
8330
8331 action.sigev_notify = SIGEV_THREAD;
8332 action.sigev_notify_function = set_flag;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008333 ret = timer_create(CLOCK_MONOTONIC, &action, &timer_id);
8334 if (ret < 0)
Paul Ollis65745772022-06-05 16:55:54 +01008335 {
8336 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8337 return &timeout_flag;
8338 }
8339 timer_created = TRUE;
8340 }
8341
Bram Moolenaar509ce032022-06-20 11:23:01 +01008342# ifdef FEAT_JOB_CHANNEL
Bram Moolenaar616592e2022-06-17 15:17:10 +01008343 ch_log(NULL, "setting timeout timer to %d sec %ld nsec",
8344 (int)interval.it_value.tv_sec, (long)interval.it_value.tv_nsec);
Bram Moolenaar509ce032022-06-20 11:23:01 +01008345# endif
Paul Ollis65745772022-06-05 16:55:54 +01008346 ret = timer_settime(timer_id, 0, &interval, NULL);
8347 if (ret < 0)
8348 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8349
8350 return &timeout_flag;
8351}
8352
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008353/*
8354 * To be used before fork/exec: delete any created timer.
8355 */
8356 void
8357delete_timer(void)
8358{
8359 if (timer_created)
8360 {
8361 timer_delete(timer_id);
8362 timer_created = FALSE;
8363 }
8364}
8365
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008366# else // HAVE_TIMER_CREATE
Paul Ollis65745772022-06-05 16:55:54 +01008367
8368/*
8369 * Implement timeout with setitimer()
8370 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008371static struct sigaction prev_sigaction;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008372static volatile sig_atomic_t timeout_flag = FALSE;
8373static int timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008374static int timer_handler_active = FALSE;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008375static volatile sig_atomic_t alarm_pending = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008376
8377/*
8378 * Handle SIGALRM for a timeout.
8379 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01008380 static void
Paul Ollis65745772022-06-05 16:55:54 +01008381set_flag SIGDEFARG(sigarg)
8382{
8383 if (alarm_pending)
8384 alarm_pending = FALSE;
8385 else
8386 timeout_flag = TRUE;
8387}
8388
8389/*
8390 * Stop any active timeout.
8391 */
8392 void
8393stop_timeout(void)
8394{
8395 static struct itimerval disarm = {{0, 0}, {0, 0}};
8396 int ret;
8397
8398 if (timer_active)
8399 {
8400 timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008401 ret = setitimer(ITIMER_REAL, &disarm, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008402 if (ret < 0)
8403 // Should only get here as a result of coding errors.
8404 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8405 }
8406
8407 if (timer_handler_active)
8408 {
8409 timer_handler_active = FALSE;
8410 ret = sigaction(SIGALRM, &prev_sigaction, NULL);
8411 if (ret < 0)
8412 // Should only get here as a result of coding errors.
8413 semsg(_(e_could_not_reset_handler_for_timeout_str),
8414 strerror(errno));
8415 }
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008416 timeout_flag = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008417}
8418
8419/*
8420 * Start the timeout timer.
8421 *
8422 * The return value is a pointer to a flag that is initialised to FALSE. If the
8423 * timeout expires, the flag is set to TRUE. This will only return pointers to
8424 * static memory; i.e. any pointer returned by this function may always be
8425 * safely dereferenced.
8426 *
8427 * This function is not expected to fail, but if it does it will still return a
8428 * valid flag pointer; the flag will remain stuck as FALSE .
8429 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008430 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008431start_timeout(long msec)
8432{
8433 struct itimerval interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008434 {0, 0}, // Do not repeat.
8435 {msec / 1000, (msec % 1000) * 1000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008436 struct sigaction handle_alarm;
8437 int ret;
8438 sigset_t sigs;
8439 sigset_t saved_sigs;
8440
8441 // This is really the caller's responsibility, but let's make sure the
8442 // previous timer has been stopped.
8443 stop_timeout();
8444
8445 // There is a small chance that SIGALRM is pending and so the handler must
8446 // ignore it on the first call.
8447 alarm_pending = FALSE;
8448 ret = sigemptyset(&sigs);
8449 ret = ret == 0 ? sigaddset(&sigs, SIGALRM) : ret;
8450 ret = ret == 0 ? sigprocmask(SIG_BLOCK, &sigs, &saved_sigs) : ret;
8451 timeout_flag = FALSE;
8452 ret = ret == 0 ? sigpending(&sigs) : ret;
8453 if (ret == 0)
8454 {
8455 alarm_pending = sigismember(&sigs, SIGALRM);
Bram Moolenaar1f89abf2022-06-06 10:07:01 +01008456 ret = sigprocmask(SIG_SETMASK, &saved_sigs, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008457 }
8458 if (unlikely(ret != 0 || alarm_pending < 0))
8459 {
8460 // Just catching coding errors. Write an error message, but carry on.
8461 semsg(_(e_could_not_check_for_pending_sigalrm_str), strerror(errno));
8462 alarm_pending = FALSE;
8463 }
8464
8465 // Set up the alarm handler first.
8466 ret = sigemptyset(&handle_alarm.sa_mask);
8467 handle_alarm.sa_handler = set_flag;
8468 handle_alarm.sa_flags = 0;
8469 ret = ret == 0 ? sigaction(SIGALRM, &handle_alarm, &prev_sigaction) : ret;
8470 if (ret < 0)
8471 {
8472 // Should only get here as a result of coding errors.
8473 semsg(_(e_could_not_set_handler_for_timeout_str), strerror(errno));
8474 return &timeout_flag;
8475 }
8476 timer_handler_active = TRUE;
8477
8478 // Set up the interval timer once the alarm handler is in place.
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008479 ret = setitimer(ITIMER_REAL, &interval, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008480 if (ret < 0)
8481 {
8482 // Should only get here as a result of coding errors.
8483 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8484 stop_timeout();
8485 return &timeout_flag;
8486 }
8487
8488 timer_active = TRUE;
8489 return &timeout_flag;
8490}
8491# endif // HAVE_TIMER_CREATE
8492#endif // FEAT_RELTIME