blob: 0dfbd497704920060029822c13bd492b32e543f8 [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{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000783 if (stack_limit == NULL)
784 return OK;
785
786 if (stack_grows_downwards)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000788 if (p < stack_limit)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 return FAIL;
790 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000791 else if (p > stack_limit)
792 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793 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{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000840 if (signal_stack == NULL)
841 return;
842
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843# ifdef HAVE_SIGALTSTACK
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844# ifdef HAVE_SS_BASE
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000845 sigstk.ss_base = signal_stack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000847 sigstk.ss_sp = signal_stack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000849 sigstk.ss_size = get_signal_stack_size();
850 sigstk.ss_flags = 0;
851 (void)sigaltstack(&sigstk, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +0000853 sigstk.ss_sp = signal_stack;
854 if (stack_grows_downwards)
855 sigstk.ss_sp += get_signal_stack_size() - 1;
856 sigstk.ss_onstack = 0;
857 (void)sigstack(&sigstk, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859}
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
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002023 if (get_x11_windis() != OK)
2024 return FALSE;
2025
2026 // Get window/icon name if any
2027 if (get_title)
2028 status = XGetWMName(x11_display, x11_window, &text_prop);
2029 else
2030 status = XGetWMIconName(x11_display, x11_window, &text_prop);
2031
2032 /*
2033 * If terminal is xterm, then x11_window may be a child window of the
2034 * outer xterm window that actually contains the window/icon name, so
2035 * keep traversing up the tree until a window with a title/icon is
2036 * found.
2037 */
2038 // Previously this was only done for xterm and alike. I don't see a
2039 // reason why it would fail for other terminal emulators.
2040 // if (term_is_xterm)
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)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002049 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;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 if (get_title)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002059 status = XGetWMName(x11_display, win, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002061 status = XGetWMIconName(x11_display, win, &text_prop);
2062 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002064 if (status && text_prop.value != NULL)
2065 {
2066 retval = TRUE;
2067 if (!test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002069 if (get_title)
2070 vim_free(oldtitle);
2071 else
2072 vim_free(oldicon);
2073 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)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002076 oldtitle = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002078 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002080 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002082 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 }
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002097 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 if (get_title)
2100 oldtitle = vim_strsave((char_u *)text_prop.value);
2101 else
2102 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002106 XFree((void *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 }
2108 return retval;
2109}
2110
Bram Moolenaar0f873732019-12-05 20:28:46 +01002111// Xutf8 functions are not available on older systems. Note that on some
2112// systems X_HAVE_UTF8_STRING may be defined in a header file but
2113// Xutf8SetWMProperties() is not in the X11 library. Configure checks for
2114// that and defines HAVE_XUTF8SETWMPROPERTIES.
Bram Moolenaara12a1612019-01-24 16:39:02 +01002115#if defined(X_HAVE_UTF8_STRING)
Bram Moolenaarcbc246a2014-10-11 14:47:26 +02002116# if X_HAVE_UTF8_STRING && HAVE_XUTF8SETWMPROPERTIES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117# define USE_UTF8_STRING
2118# endif
2119#endif
2120
2121/*
2122 * Set x11 Window Title
2123 *
2124 * get_x11_windis() must be called before this and have returned OK
2125 */
2126 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002127set_x11_title(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002129 // XmbSetWMProperties() and Xutf8SetWMProperties() should use a STRING
2130 // when possible, COMPOUND_TEXT otherwise. COMPOUND_TEXT isn't
2131 // supported everywhere and STRING doesn't work for multi-byte titles.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132#ifdef USE_UTF8_STRING
2133 if (enc_utf8)
2134 Xutf8SetWMProperties(x11_display, x11_window, (const char *)title,
2135 NULL, NULL, 0, NULL, NULL, NULL);
2136 else
2137#endif
2138 {
2139#if XtSpecificationRelease >= 4
2140# ifdef FEAT_XFONTSET
2141 XmbSetWMProperties(x11_display, x11_window, (const char *)title,
2142 NULL, NULL, 0, NULL, NULL, NULL);
2143# else
2144 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002145 char *c_title = (char *)title;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146
Bram Moolenaar0f873732019-12-05 20:28:46 +01002147 // directly from example 3-18 "basicwin" of Xlib Programming Manual
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002148 (void)XStringListToTextProperty(&c_title, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 XSetWMProperties(x11_display, x11_window, &text_prop,
2150 NULL, NULL, 0, NULL, NULL, NULL);
2151# endif
2152#else
2153 XStoreName(x11_display, x11_window, (char *)title);
2154#endif
2155 }
2156 XFlush(x11_display);
2157}
2158
2159/*
2160 * Set x11 Window icon
2161 *
2162 * get_x11_windis() must be called before this and have returned OK
2163 */
2164 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002165set_x11_icon(char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002167 // See above for comments about using X*SetWMProperties().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168#ifdef USE_UTF8_STRING
2169 if (enc_utf8)
2170 Xutf8SetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2171 NULL, 0, NULL, NULL, NULL);
2172 else
2173#endif
2174 {
2175#if XtSpecificationRelease >= 4
2176# ifdef FEAT_XFONTSET
2177 XmbSetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2178 NULL, 0, NULL, NULL, NULL);
2179# else
2180 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002181 char *c_icon = (char *)icon;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002183 (void)XStringListToTextProperty(&c_icon, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 XSetWMProperties(x11_display, x11_window, NULL, &text_prop,
2185 NULL, 0, NULL, NULL, NULL);
2186# endif
2187#else
2188 XSetIconName(x11_display, x11_window, (char *)icon);
2189#endif
2190 }
2191 XFlush(x11_display);
2192}
2193
Bram Moolenaar0f873732019-12-05 20:28:46 +01002194#else // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002197get_x11_title(int test_only UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198{
2199 return FALSE;
2200}
2201
2202 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002203get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204{
2205 if (!test_only)
2206 {
2207 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002208 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002210 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 }
2212 return FALSE;
2213}
2214
Bram Moolenaar0f873732019-12-05 20:28:46 +01002215#endif // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216
2217 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002218mch_can_restore_title(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219{
2220 return get_x11_title(TRUE);
2221}
2222
2223 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002224mch_can_restore_icon(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225{
2226 return get_x11_icon(TRUE);
2227}
2228
2229/*
2230 * Set the window title and icon.
2231 */
2232 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002233mch_settitle(char_u *title, char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234{
2235 int type = 0;
2236 static int recursive = 0;
2237
Bram Moolenaar0f873732019-12-05 20:28:46 +01002238 if (T_NAME == NULL) // no terminal name (yet)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 return;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002240 if (title == NULL && icon == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 return;
2242
Bram Moolenaar0f873732019-12-05 20:28:46 +01002243 // When one of the X11 functions causes a deadly signal, we get here again
2244 // recursively. Avoid hanging then (something is probably locked).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 if (recursive)
2246 return;
2247 ++recursive;
2248
2249 /*
2250 * if the window ID and the display is known, we may use X11 calls
2251 */
2252#ifdef FEAT_X11
2253 if (get_x11_windis() == OK)
2254 type = 1;
2255#else
Bram Moolenaar097148e2020-08-11 21:58:20 +02002256# if defined(FEAT_GUI_PHOTON) \
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002257 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 if (gui.in_use)
2259 type = 1;
2260# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261#endif
2262
2263 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002264 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 * than x11 calls, because the x11 calls don't always work
2266 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 if ((type || *T_TS != NUL) && title != NULL)
2268 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002269 if (oldtitle_outdated)
2270 {
2271 oldtitle_outdated = FALSE;
2272 VIM_CLEAR(oldtitle);
2273 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 if (oldtitle == NULL
2275#ifdef FEAT_GUI
2276 && !gui.in_use
2277#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002278 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 (void)get_x11_title(FALSE);
2280
Bram Moolenaar0f873732019-12-05 20:28:46 +01002281 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 term_settitle(title);
2283#ifdef FEAT_X11
2284 else
2285# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002286 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002288 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002290#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar097148e2020-08-11 21:58:20 +02002291 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 else
2293 gui_mch_settitle(title, icon);
2294#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002295 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 }
2297
2298 if ((type || *T_CIS != NUL) && icon != NULL)
2299 {
2300 if (oldicon == NULL
2301#ifdef FEAT_GUI
2302 && !gui.in_use
2303#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002304 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 get_x11_icon(FALSE);
2306
2307 if (*T_CIS != NUL)
2308 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002309 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002311 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 out_flush();
2313 }
2314#ifdef FEAT_X11
2315 else
2316# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002317 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002319 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320#endif
2321 did_set_icon = TRUE;
2322 }
2323 --recursive;
2324}
2325
2326/*
2327 * Restore the window/icon title.
2328 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002329 * SAVE_RESTORE_TITLE only restore title
2330 * SAVE_RESTORE_ICON only restore icon
2331 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 */
2333 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002334mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335{
Bram Moolenaardac13472019-09-16 21:06:21 +02002336 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002337
Bram Moolenaar0f873732019-12-05 20:28:46 +01002338 // only restore the title or icon when it has been set
Bram Moolenaardac13472019-09-16 21:06:21 +02002339 mch_settitle(((which & SAVE_RESTORE_TITLE) && unix_did_set_title) ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 (oldtitle ? oldtitle : p_titleold) : NULL,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002341 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
2342
Bram Moolenaare5c83282019-05-03 23:15:37 +02002343 if (do_push_pop)
2344 {
2345 // pop and push from/to the stack
2346 term_pop_title(which);
2347 term_push_title(which);
2348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349}
2350
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351
2352/*
2353 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002354 * This matches "xterm.*", thus "xterm-256color", "xterm-kitty", etc.
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002355 * Do not consider "xterm-kitty" an xterm, it is not fully xterm compatible,
2356 * using the "xterm-kitty" terminfo entry should work better.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002357 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 */
2359 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002360vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361{
2362 if (name == NULL)
2363 return FALSE;
Bram Moolenaarafa3f1c2022-12-19 18:56:48 +00002364 return ((STRNICMP(name, "xterm", 5) == 0
2365 && STRNICMP(name, "xterm-kitty", 11) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 || STRNICMP(name, "nxterm", 6) == 0
2367 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002368 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002370 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 || STRCMP(name, "builtin_xterm") == 0);
2372}
2373
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002374#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2375/*
2376 * Return TRUE if "name" appears to be that of a terminal
2377 * known to support the xterm-style mouse protocol.
2378 * Relies on term_is_xterm having been set to its correct value.
2379 */
2380 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002381use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002382{
2383 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002384 && (term_is_xterm
2385 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002386 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar48873ae2021-12-08 21:00:24 +00002387 || STRNICMP(name, "gnome", 5) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002388 || STRICMP(name, "st") == 0
2389 || STRNICMP(name, "st-", 3) == 0
2390 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002391}
2392#endif
2393
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394/*
2395 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2396 * Return 1 for "xterm".
2397 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002398 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002399 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 */
2401 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002402use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002404 if (ttym_flags == TTYM_SGR)
2405 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002406 if (ttym_flags == TTYM_URXVT)
2407 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 if (ttym_flags == TTYM_XTERM2)
2409 return 2;
2410 if (ttym_flags == TTYM_XTERM)
2411 return 1;
2412 return 0;
2413}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002415/*
2416 * Return TRUE if "name" is an iris-ansi terminal name.
2417 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002419vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420{
2421 if (name == NULL)
2422 return FALSE;
2423 return (STRNICMP(name, "iris-ansi", 9) == 0
2424 || STRCMP(name, "builtin_iris-ansi") == 0);
2425}
2426
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002427/*
2428 * Return TRUE if "name" is a vt300-like terminal name.
2429 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002431vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432{
2433 if (name == NULL)
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002434 return FALSE;
2435 // Actually all ANSI compatible terminals should be here.
2436 // Catch at least VT1xx - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002437 return ((STRNICMP(name, "vt", 2) == 0
Bram Moolenaar88456cd2022-11-18 22:14:09 +00002438 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 || STRCMP(name, "builtin_vt320") == 0);
2440}
2441
2442/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 * Insert user name in s[len].
2444 * Return OK if a name found.
2445 */
2446 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002447mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448{
2449#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002450 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 return OK;
2452#else
2453 return mch_get_uname(getuid(), s, len);
2454#endif
2455}
2456
2457/*
2458 * Insert user name for "uid" in s[len].
2459 * Return OK if a name found.
2460 */
2461 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002462mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463{
2464#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2465 struct passwd *pw;
2466
2467 if ((pw = getpwuid(uid)) != NULL
2468 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2469 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002470 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 return OK;
2472 }
2473#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002474 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2475 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476}
2477
2478/*
2479 * Insert host name is s[len].
2480 */
2481
2482#ifdef HAVE_SYS_UTSNAME_H
2483 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002484mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485{
2486 struct utsname vutsname;
2487
2488 if (uname(&vutsname) < 0)
2489 *s = NUL;
2490 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002491 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002493#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494
2495# ifdef HAVE_SYS_SYSTEMINFO_H
2496# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2497# endif
2498
2499 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002500mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501{
2502# ifdef VAXC
2503 vaxc$gethostname((char *)s, len);
2504# else
2505 gethostname((char *)s, len);
2506# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002507 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002509#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510
2511/*
2512 * return process ID
2513 */
2514 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002515mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516{
2517 return (long)getpid();
2518}
2519
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002520/*
2521 * return TRUE if process "pid" is still running
2522 */
2523 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002524mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002525{
Bram Moolenaar44dea9d2021-06-23 21:13:20 +02002526 // If there is no error the process must be running.
2527 if (kill(pid, 0) == 0)
2528 return TRUE;
2529#ifdef ESRCH
2530 // If the error is ESRCH then the process is not running.
2531 if (errno == ESRCH)
2532 return FALSE;
2533#endif
2534 // If the process is running and owned by another user we get EPERM. With
2535 // other errors the process might be running, assuming it is then.
2536 return TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002537}
2538
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002541strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542{
2543 extern int sys_nerr;
2544 extern char *sys_errlist[];
2545 static char er[20];
2546
2547 if (err > 0 && err < sys_nerr)
2548 return (sys_errlist[err]);
2549 sprintf(er, "Error %d", err);
2550 return er;
2551}
2552#endif
2553
2554/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002555 * Get name of current directory into buffer "buf" of length "len" bytes.
2556 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 * Return OK for success, FAIL for failure.
2558 */
2559 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002560mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561{
2562#if defined(USE_GETCWD)
2563 if (getcwd((char *)buf, len) == NULL)
2564 {
2565 STRCPY(buf, strerror(errno));
2566 return FAIL;
2567 }
2568 return OK;
2569#else
2570 return (getwd((char *)buf) != NULL ? OK : FAIL);
2571#endif
2572}
2573
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002575 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 *
2577 * return FAIL for failure, OK for success
2578 */
2579 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002580mch_FullName(
2581 char_u *fname,
2582 char_u *buf,
2583 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002584 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585{
2586 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002587#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002589 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002590#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 char_u olddir[MAXPATHL];
2592 char_u *p;
2593 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002594#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002595 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2596 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002597#endif
2598
Bram Moolenaar38323e42007-03-06 19:22:53 +00002599#ifdef VMS
2600 fname = vms_fixfilename(fname);
2601#endif
2602
Bram Moolenaara2442432007-04-26 14:26:37 +00002603#ifdef __CYGWIN__
2604 /*
2605 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2606 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002607# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002608 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2609 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002610 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2611 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002612# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002613 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002614# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002615 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002616#endif
2617
Bram Moolenaar0f873732019-12-05 20:28:46 +01002618 // Expand it if forced or not an absolute path.
2619 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002620 if ((force || !mch_isFullName(fname))
2621 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 {
2623 /*
2624 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002625 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 * This will get the correct path name with "../" things.
2627 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002628 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 {
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002630 if (STRCMP(p, "/..") == 0)
2631 // for "/path/dir/.." include the "/.."
2632 p += 3;
2633
Bram Moolenaar38323e42007-03-06 19:22:53 +00002634#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 /*
2636 * Use fchdir() if possible, it's said to be faster and more
2637 * reliable. But on SunOS 4 it might not work. Check this by
2638 * doing a fchdir() right now.
2639 */
2640 if (!dont_fchdir)
2641 {
2642 fd = open(".", O_RDONLY | O_EXTRA, 0);
2643 if (fd >= 0 && fchdir(fd) < 0)
2644 {
2645 close(fd);
2646 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002647 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 }
2649 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002650#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651
Bram Moolenaar0f873732019-12-05 20:28:46 +01002652 // Only change directory when we are sure we can return to where
2653 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002655#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002657#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 (mch_dirname(olddir, MAXPATHL) == FAIL
2659 || mch_chdir((char *)olddir) != 0))
2660 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002661 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 retval = FAIL;
2663 }
2664 else
2665 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002666 // The directory is copied into buf[], to be able to remove
2667 // the file name without changing it (could be a string in
2668 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 if (p - fname >= len)
2670 retval = FAIL;
2671 else
2672 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002673 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 if (mch_chdir((char *)buf))
Bram Moolenaarc6376c72021-10-03 19:29:48 +01002675 {
2676 // Path does not exist (yet). For a full path fail,
2677 // will use the path as-is. For a relative path use
2678 // the current directory and append the file name.
2679 if (mch_isFullName(fname))
2680 retval = FAIL;
2681 else
2682 p = NULL;
2683 }
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002684 else if (*p == '/')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 fname = p + 1;
Bram Moolenaar4eaef992021-08-30 21:26:16 +02002686 else
2687 fname = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 *buf = NUL;
2689 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 }
2691 }
2692 if (mch_dirname(buf, len) == FAIL)
2693 {
2694 retval = FAIL;
2695 *buf = NUL;
2696 }
2697 if (p != NULL)
2698 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002699#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 if (fd >= 0)
2701 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002702 if (p_verbose >= 5)
2703 {
2704 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002705 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002706 verbose_leave();
2707 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 l = fchdir(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 }
2710 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002711#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 l = mch_chdir((char *)olddir);
2713 if (l != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002714 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 }
itchyny051a40c2021-10-20 10:00:05 +01002716#ifdef HAVE_FCHDIR
2717 if (fd >= 0)
2718 close(fd);
2719#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720
2721 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002722 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002723 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002724#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002725 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002727 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002728#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002730
Bram Moolenaar0f873732019-12-05 20:28:46 +01002731 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002732 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 return FAIL;
2734
Bram Moolenaar0f873732019-12-05 20:28:46 +01002735 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 if (STRCMP(fname, ".") != 0)
2737 STRCAT(buf, fname);
2738
2739 return OK;
2740}
2741
2742/*
2743 * Return TRUE if "fname" does not depend on the current directory.
2744 */
2745 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002746mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002748#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 return ( fname[0] == '/' || fname[0] == '.' ||
2750 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2751 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2752 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002753#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755#endif
2756}
2757
Bram Moolenaar24552be2005-12-10 20:17:30 +00002758#if defined(USE_FNAME_CASE) || defined(PROTO)
2759/*
2760 * Set the case of the file name, if it already exists. This will cause the
2761 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002762 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002763 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002764 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002765fname_case(
2766 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002767 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002768{
2769 struct stat st;
2770 char_u *slash, *tail;
2771 DIR *dirp;
2772 struct dirent *dp;
2773
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002774 if (mch_lstat((char *)name, &st) < 0)
2775 return;
2776
2777 // Open the directory where the file is located.
2778 slash = vim_strrchr(name, '/');
2779 if (slash == NULL)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002780 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002781 dirp = opendir(".");
2782 tail = name;
2783 }
2784 else
2785 {
2786 *slash = NUL;
2787 dirp = opendir((char *)name);
2788 *slash = '/';
2789 tail = slash + 1;
2790 }
Bram Moolenaar24552be2005-12-10 20:17:30 +00002791
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002792 if (dirp == NULL)
2793 return;
2794
2795 while ((dp = readdir(dirp)) != NULL)
2796 {
2797 // Only accept names that differ in case and are the same byte
2798 // length. TODO: accept different length name.
2799 if (STRICMP(tail, dp->d_name) == 0
2800 && STRLEN(tail) == STRLEN(dp->d_name))
Bram Moolenaar24552be2005-12-10 20:17:30 +00002801 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002802 char_u newname[MAXPATHL + 1];
2803 struct stat st2;
2804
2805 // Verify the inode is equal.
2806 vim_strncpy(newname, name, MAXPATHL);
2807 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2808 MAXPATHL - (tail - name));
2809 if (mch_lstat((char *)newname, &st2) >= 0
2810 && st.st_ino == st2.st_ino
2811 && st.st_dev == st2.st_dev)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002812 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002813 STRCPY(tail, dp->d_name);
2814 break;
Bram Moolenaar24552be2005-12-10 20:17:30 +00002815 }
Bram Moolenaar24552be2005-12-10 20:17:30 +00002816 }
2817 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002818
2819 closedir(dirp);
Bram Moolenaar24552be2005-12-10 20:17:30 +00002820}
2821#endif
2822
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823/*
2824 * Get file permissions for 'name'.
2825 * Returns -1 when it doesn't exist.
2826 */
2827 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002828mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829{
2830 struct stat statb;
2831
Bram Moolenaar0f873732019-12-05 20:28:46 +01002832 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833#ifdef VMS
2834 if (stat((char *)vms_fixfilename(name), &statb))
2835#else
2836 if (stat((char *)name, &statb))
2837#endif
2838 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002839#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002840 // The top bit makes the value negative, which means the file doesn't
2841 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002842 return statb.st_mode & ~S_ADDACE;
2843#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002845#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846}
2847
2848/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002849 * Set file permission for "name" to "perm".
2850 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 */
2852 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002853mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854{
2855 return (chmod((char *)
2856#ifdef VMS
2857 vms_fixfilename(name),
2858#else
2859 name,
2860#endif
2861 (mode_t)perm) == 0 ? OK : FAIL);
2862}
2863
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002864#if defined(HAVE_FCHMOD) || defined(PROTO)
2865/*
2866 * Set file permission for open file "fd" to "perm".
2867 * Return FAIL for failure, OK otherwise.
2868 */
2869 int
2870mch_fsetperm(int fd, long perm)
2871{
2872 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2873}
2874#endif
2875
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876#if defined(HAVE_ACL) || defined(PROTO)
2877# ifdef HAVE_SYS_ACL_H
2878# include <sys/acl.h>
2879# endif
2880# ifdef HAVE_SYS_ACCESS_H
2881# include <sys/access.h>
2882# endif
2883
2884# ifdef HAVE_SOLARIS_ACL
2885typedef struct vim_acl_solaris_T {
2886 int acl_cnt;
2887 aclent_t *acl_entry;
2888} vim_acl_solaris_T;
2889# endif
2890
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002891#if defined(HAVE_SELINUX) || defined(PROTO)
2892/*
2893 * Copy security info from "from_file" to "to_file".
2894 */
2895 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002896mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002897{
2898 if (from_file == NULL)
2899 return;
2900
2901 if (selinux_enabled == -1)
2902 selinux_enabled = is_selinux_enabled();
2903
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002904 if (selinux_enabled <= 0)
2905 return;
2906
2907 // Use "char *" instead of "security_context_t" to avoid a deprecation
2908 // warning.
2909 char *from_context = NULL;
2910 char *to_context = NULL;
2911
2912 if (getfilecon((char *)from_file, &from_context) < 0)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002913 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002914 // If the filesystem doesn't support extended attributes,
2915 // the original had no special security context and the
2916 // target cannot have one either.
2917 if (errno == EOPNOTSUPP)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002918 return;
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002919
2920 msg_puts(_("\nCould not get security context for "));
2921 msg_outtrans(from_file);
2922 msg_putchar('\n');
2923 return;
2924 }
2925 if (getfilecon((char *)to_file, &to_context) < 0)
2926 {
2927 msg_puts(_("\nCould not get security context for "));
2928 msg_outtrans(to_file);
2929 msg_putchar('\n');
2930 freecon (from_context);
2931 return ;
2932 }
2933 if (strcmp(from_context, to_context) != 0)
2934 {
2935 if (setfilecon((char *)to_file, from_context) < 0)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002936 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002937 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002938 msg_outtrans(to_file);
2939 msg_putchar('\n');
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002940 }
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002941 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00002942 freecon(to_context);
2943 freecon(from_context);
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002944}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002945#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002946
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002947#if defined(HAVE_SMACK) && !defined(PROTO)
2948/*
2949 * Copy security info from "from_file" to "to_file".
2950 */
2951 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002952mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002953{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002954 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002955 {
2956 XATTR_NAME_SMACK,
2957 XATTR_NAME_SMACKEXEC,
2958 XATTR_NAME_SMACKMMAP
2959 };
2960
2961 char buffer[SMACK_LABEL_LEN];
2962 const char *name;
2963 int index;
2964 int ret;
2965 ssize_t size;
2966
2967 if (from_file == NULL)
2968 return;
2969
2970 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2971 / sizeof(smack_copied_attributes)[0]) ; index++)
2972 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002973 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002974 name = smack_copied_attributes[index];
2975
Bram Moolenaar0f873732019-12-05 20:28:46 +01002976 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002977 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2978 if (size >= 0)
2979 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002980 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002981 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2982 if (ret < 0)
2983 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002984 vim_snprintf((char *)IObuff, IOSIZE,
2985 _("Could not set security context %s for %s"),
2986 name, to_file);
2987 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002988 msg_putchar('\n');
2989 }
2990 }
2991 else
2992 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002993 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002994 switch (errno)
2995 {
2996 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002997 // extended attributes aren't supported or enabled
2998 // should a message be echoed? not sure...
2999 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003000
3001 case ERANGE:
3002 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003003 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003004 vim_snprintf((char *)IObuff, IOSIZE,
3005 _("Could not get security context %s for %s. Removing it!"),
3006 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003007 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01003008 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01003009 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003010
3011 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01003012 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003013 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003014 // Silently ignore errors, apparently this happens when
3015 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003016 break;
3017 }
3018 }
3019 }
3020}
Bram Moolenaar0f873732019-12-05 20:28:46 +01003021#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02003022
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023/*
3024 * Return a pointer to the ACL of file "fname" in allocated memory.
3025 * Return NULL if the ACL is not available for whatever reason.
3026 */
3027 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01003028mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029{
3030 vim_acl_T ret = NULL;
3031#ifdef HAVE_POSIX_ACL
3032 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
3033#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003034#ifdef HAVE_SOLARIS_ZFS_ACL
3035 acl_t *aclent;
3036
3037 if (acl_get((char *)fname, 0, &aclent) < 0)
3038 return NULL;
3039 ret = (vim_acl_T)aclent;
3040#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041#ifdef HAVE_SOLARIS_ACL
3042 vim_acl_solaris_T *aclent;
3043
3044 aclent = malloc(sizeof(vim_acl_solaris_T));
3045 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
3046 {
3047 free(aclent);
3048 return NULL;
3049 }
3050 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
3051 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
3052 {
3053 free(aclent->acl_entry);
3054 free(aclent);
3055 return NULL;
3056 }
3057 ret = (vim_acl_T)aclent;
3058#else
3059#if defined(HAVE_AIX_ACL)
3060 int aclsize;
3061 struct acl *aclent;
3062
3063 aclsize = sizeof(struct acl);
3064 aclent = malloc(aclsize);
3065 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3066 {
3067 if (errno == ENOSPC)
3068 {
3069 aclsize = aclent->acl_len;
3070 aclent = realloc(aclent, aclsize);
3071 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
3072 {
3073 free(aclent);
3074 return NULL;
3075 }
3076 }
3077 else
3078 {
3079 free(aclent);
3080 return NULL;
3081 }
3082 }
3083 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003084#endif // HAVE_AIX_ACL
3085#endif // HAVE_SOLARIS_ACL
3086#endif // HAVE_SOLARIS_ZFS_ACL
3087#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 return ret;
3089}
3090
3091/*
3092 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3093 */
3094 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003095mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096{
3097 if (aclent == NULL)
3098 return;
3099#ifdef HAVE_POSIX_ACL
3100 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3101#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003102#ifdef HAVE_SOLARIS_ZFS_ACL
3103 acl_set((char *)fname, (acl_t *)aclent);
3104#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105#ifdef HAVE_SOLARIS_ACL
3106 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3107 ((vim_acl_solaris_T *)aclent)->acl_entry);
3108#else
3109#ifdef HAVE_AIX_ACL
3110 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003111#endif // HAVE_AIX_ACL
3112#endif // HAVE_SOLARIS_ACL
3113#endif // HAVE_SOLARIS_ZFS_ACL
3114#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115}
3116
3117 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003118mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119{
3120 if (aclent == NULL)
3121 return;
3122#ifdef HAVE_POSIX_ACL
3123 acl_free((acl_t)aclent);
3124#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003125#ifdef HAVE_SOLARIS_ZFS_ACL
3126 acl_free((acl_t *)aclent);
3127#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128#ifdef HAVE_SOLARIS_ACL
3129 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3130 free(aclent);
3131#else
3132#ifdef HAVE_AIX_ACL
3133 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003134#endif // HAVE_AIX_ACL
3135#endif // HAVE_SOLARIS_ACL
3136#endif // HAVE_SOLARIS_ZFS_ACL
3137#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138}
3139#endif
3140
3141/*
3142 * Set hidden flag for "name".
3143 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003145mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003147 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148}
3149
3150/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003151 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 * return FALSE if "name" is not a directory
3153 * return FALSE for error
3154 */
3155 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003156mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157{
3158 struct stat statb;
3159
Bram Moolenaar0f873732019-12-05 20:28:46 +01003160 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 return FALSE;
3162 if (stat((char *)name, &statb))
3163 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165}
3166
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003167/*
3168 * return TRUE if "name" is a directory, NOT a symlink to a directory
3169 * return FALSE if "name" is not a directory
3170 * return FALSE for error
3171 */
3172 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003173mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003174{
3175 struct stat statb;
3176
Bram Moolenaar0f873732019-12-05 20:28:46 +01003177 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003178 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003179 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003180 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003181 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003182}
3183
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184/*
3185 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3186 */
3187 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003188executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189{
3190 struct stat st;
3191
3192 if (stat((char *)name, &st))
3193 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003194#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003195 // Like on Unix system file can have executable rights but not necessarily
3196 // be an executable, but on Unix is not a default for an ordinary file to
3197 // have an executable flag - on VMS it is in most cases.
3198 // Therefore, this check does not have any sense - let keep us to the
3199 // conventions instead:
3200 // *.COM and *.EXE files are the executables - the rest are not. This is
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00003201 // not ideal but better than it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003202 int vms_executable = 0;
3203 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3204 {
3205 if (strstr(vms_tolower((char*)name),".exe") != NULL
3206 || strstr(vms_tolower((char*)name),".com")!= NULL)
3207 vms_executable = 1;
3208 }
3209 return vms_executable;
3210#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003212#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213}
3214
3215/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003216 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003217 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 * Return -1 if unknown.
3219 */
3220 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003221mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222{
3223 char_u *buf;
3224 char_u *p, *e;
3225 int retval;
3226
Bram Moolenaar0f873732019-12-05 20:28:46 +01003227 // When "use_path" is false and if it's an absolute or relative path don't
3228 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003229 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003230 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003231 // There must be a path separator, files in the current directory
3232 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003233 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003234 {
3235 if (path != NULL)
3236 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003237 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003238 *path = FullName_save(name, TRUE);
3239 else
3240 *path = vim_strsave(name);
3241 }
3242 return TRUE;
3243 }
3244 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003245 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246
3247 p = (char_u *)getenv("PATH");
3248 if (p == NULL || *p == NUL)
3249 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003250 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 if (buf == NULL)
3252 return -1;
3253
3254 /*
3255 * Walk through all entries in $PATH to check if "name" exists there and
3256 * is an executable file.
3257 */
3258 for (;;)
3259 {
3260 e = (char_u *)strchr((char *)p, ':');
3261 if (e == NULL)
3262 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003263 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 STRCPY(buf, "./");
3265 else
3266 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003267 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 add_pathsep(buf);
3269 }
3270 STRCAT(buf, name);
3271 retval = executable_file(buf);
3272 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003273 {
3274 if (path != NULL)
3275 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003276 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003277 *path = FullName_save(buf, TRUE);
3278 else
3279 *path = vim_strsave(buf);
3280 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003282 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283
3284 if (*e != ':')
3285 break;
3286 p = e + 1;
3287 }
3288
3289 vim_free(buf);
3290 return retval;
3291}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292
3293/*
3294 * Check what "name" is:
3295 * NODE_NORMAL: file or directory (or doesn't exist)
3296 * NODE_WRITABLE: writable device, socket, fifo, etc.
3297 * NODE_OTHER: non-writable things
3298 */
3299 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003300mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301{
3302 struct stat st;
3303
3304 if (stat((char *)name, &st))
3305 return NODE_NORMAL;
3306 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3307 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003308 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003310 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 return NODE_WRITABLE;
3312}
3313
3314 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003315mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316{
3317#ifdef HAVE_CHECK_STACK_GROWTH
3318 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 check_stack_growth((char *)&i);
3321
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003322# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 get_stack_limit();
3324# endif
3325
3326#endif
3327
3328 /*
3329 * Setup an alternative stack for signals. Helps to catch signals when
3330 * running out of stack space.
3331 * Use of sigaltstack() is preferred, it's more portable.
3332 * Ignore any errors.
3333 */
3334#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Zdenek Dohnalba9c23e2021-08-11 14:20:05 +02003335 signal_stack = alloc(get_signal_stack_size());
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 init_signal_stack();
3337#endif
3338}
3339
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003340#if defined(EXITFREE) || defined(PROTO)
3341 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003342mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003343{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003344# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3345 if (clip_star.owned)
3346 clip_lose_selection(&clip_star);
3347 if (clip_plus.owned)
3348 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003349# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003350# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003351 if (xterm_Shell != (Widget)0)
3352 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003353# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003354 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003355 if (xterm_dpy != NULL)
3356 XtCloseDisplay(xterm_dpy);
3357 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003358 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003359 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003360# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003361 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003362# endif
3363 }
3364# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003365# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003366# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003367 if (x11_display != NULL
3368# ifdef FEAT_XCLIPBOARD
3369 && x11_display != xterm_dpy
3370# endif
3371 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003372 XCloseDisplay(x11_display);
3373# endif
3374# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003375 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003376# endif
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003377 vim_free(oldtitle);
3378 vim_free(oldicon);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003379}
3380#endif
3381
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382/*
3383 * Output a newline when exiting.
3384 * Make sure the newline goes to the same stream as the text.
3385 */
3386 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003387exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003389 if (silent_mode)
3390 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 if (newline_on_exit || msg_didout)
3392 {
3393 if (msg_use_printf())
3394 {
3395 if (info_message)
3396 mch_msg("\n");
3397 else
3398 mch_errmsg("\r\n");
3399 }
3400 else
3401 out_char('\n');
3402 }
Bram Moolenaar7007e312021-03-27 12:11:33 +01003403 else if (!is_not_a_term())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003405 restore_cterm_colors(); // get original colors back
3406 msg_clr_eos_force(); // clear the rest of the display
3407 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 }
3409}
3410
Bram Moolenaarb4151682020-05-11 22:13:28 +02003411#ifdef USE_GCOV_FLUSH
ichizokdee78e12021-12-09 21:08:01 +00003412# if (defined(__GNUC__) \
3413 && ((__GNUC__ == 11 && __GNUC_MINOR__ >= 1) || (__GNUC__ >= 12))) \
3414 || (defined(__clang__) && (__clang_major__ >= 12))
3415extern void __gcov_dump(void);
3416extern void __gcov_reset(void);
3417# define __gcov_flush() do { __gcov_dump(); __gcov_reset(); } while (0)
3418# else
3419extern void __gcov_flush(void);
3420# endif
Bram Moolenaarb4151682020-05-11 22:13:28 +02003421#endif
3422
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003424mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425{
3426 exiting = TRUE;
3427
3428#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3429 x11_export_final_selection();
3430#endif
3431
3432#ifdef FEAT_GUI
3433 if (!gui.in_use)
3434#endif
3435 {
3436 settmode(TMODE_COOK);
Bram Moolenaar7007e312021-03-27 12:11:33 +01003437 if (!is_not_a_term())
3438 {
3439 // restore xterm title and icon name
3440 mch_restore_title(SAVE_RESTORE_BOTH);
3441 term_pop_title(SAVE_RESTORE_BOTH);
3442 }
Bram Moolenaar651fca82021-11-29 20:39:38 +00003443
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 /*
3445 * When t_ti is not empty but it doesn't cause swapping terminal
3446 * pages, need to output a newline when msg_didout is set. But when
3447 * t_ti does swap pages it should not go to the shell page. Do this
3448 * before stoptermcap().
3449 */
3450 if (swapping_screen() && !newline_on_exit)
3451 exit_scroll();
3452
Bram Moolenaar0f873732019-12-05 20:28:46 +01003453 // Stop termcap: May need to check for T_CRV response, which
3454 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 stoptermcap();
3456
3457 /*
3458 * A newline is only required after a message in the alternate screen.
3459 * This is set to TRUE by wait_return().
3460 */
3461 if (!swapping_screen() || newline_on_exit)
3462 exit_scroll();
3463
Bram Moolenaar0f873732019-12-05 20:28:46 +01003464 // Cursor may have been switched off without calling starttermcap()
3465 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 if (full_screen)
3467 cursor_on();
3468 }
3469 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003470 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003471
3472#ifdef USE_GCOV_FLUSH
3473 // Flush coverage info before possibly being killed by a deadly signal.
3474 __gcov_flush();
3475#endif
3476
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 may_core_dump();
3478#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 gui_exit(r);
3481#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003482
Bram Moolenaar56718732006-03-15 22:53:57 +00003483#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003484 mac_conv_cleanup();
3485#endif
3486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003488 // A core dump won't be created if the signal handler
3489 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 if (deadly_signal != 0)
3491 return;
3492#endif
3493
Bram Moolenaar009b2592004-10-24 19:18:58 +00003494#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003495 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003496#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003497
3498#ifdef EXITFREE
3499 free_all_mem();
3500#endif
3501
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 exit(r);
3503}
3504
3505 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003506may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507{
3508 if (deadly_signal != 0)
3509 {
3510 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003511 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 }
3513}
3514
3515#ifndef VMS
3516
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003517/*
3518 * Get the file descriptor to use for tty operations.
3519 */
3520 static int
3521get_tty_fd(int fd)
3522{
3523 int tty_fd = fd;
3524
3525#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3526 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3527 // "fd" when it is a master device.
3528 if (mch_isatty(fd) > 1)
3529 {
3530 char *name;
3531
3532 name = ptsname(fd);
3533 if (name == NULL)
3534 return -1;
3535
3536 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3537 if (tty_fd < 0)
3538 return -1;
3539 }
3540#endif
3541 return tty_fd;
3542}
3543
3544 static int
3545mch_tcgetattr(int fd, void *term)
3546{
3547 int tty_fd;
3548 int retval = -1;
3549
3550 tty_fd = get_tty_fd(fd);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003551 if (tty_fd < 0)
3552 return -1;
3553
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003554#ifdef NEW_TTY_SYSTEM
3555# ifdef HAVE_TERMIOS_H
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003556 retval = tcgetattr(tty_fd, (struct termios *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003557# else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003558 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003559# endif
3560#else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003561 // for "old" tty systems
3562 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003563#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003564 if (tty_fd != fd)
3565 close(tty_fd);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003566 return retval;
3567}
3568
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003570mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571{
3572 static int first = TRUE;
3573
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003574#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575# ifdef HAVE_TERMIOS_H
3576 static struct termios told;
3577 struct termios tnew;
3578# else
3579 static struct termio told;
3580 struct termio tnew;
3581# endif
3582
3583 if (first)
3584 {
3585 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003586 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 }
3588
3589 tnew = told;
3590 if (tmode == TMODE_RAW)
3591 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003592 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003593 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3594 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003596# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003597 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598# endif
3599 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003600# ifdef ONLCR
3601 // Don't map NL -> CR NL, we do it ourselves.
3602 // Also disable expanding tabs if possible.
3603# ifdef XTABS
3604 tnew.c_oflag &= ~(ONLCR | XTABS);
3605# else
3606# ifdef TAB3
3607 tnew.c_oflag &= ~(ONLCR | TAB3);
3608# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003610# endif
3611# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003613 tnew.c_cc[VMIN] = 1; // return after 1 char
3614 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 }
3616 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003617 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003618 // Also reset ICANON here, otherwise on Solaris select() won't see
3619 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003620 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003621 tnew.c_cc[VMIN] = 1; // return after 1 char
3622 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003623 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
3625# if defined(HAVE_TERMIOS_H)
3626 {
3627 int n = 10;
3628
Bram Moolenaar0f873732019-12-05 20:28:46 +01003629 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3630 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3632 && errno == EINTR && n > 0)
3633 --n;
3634 }
3635# else
3636 ioctl(read_cmd_fd, TCSETA, &tnew);
3637# endif
3638
3639#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 /*
3641 * for "old" tty systems
3642 */
3643# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003644# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645# endif
3646 static struct sgttyb ttybold;
3647 struct sgttyb ttybnew;
3648
3649 if (first)
3650 {
3651 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003652 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 }
3654
3655 ttybnew = ttybold;
3656 if (tmode == TMODE_RAW)
3657 {
3658 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3659 ttybnew.sg_flags |= RAW;
3660 }
3661 else if (tmode == TMODE_SLEEP)
3662 ttybnew.sg_flags &= ~(ECHO);
3663 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3664#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003665 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666}
3667
3668/*
3669 * Try to get the code for "t_kb" from the stty setting
3670 *
3671 * Even if termcap claims a backspace key, the user's setting *should*
3672 * prevail. stty knows more about reality than termcap does, and if
3673 * somebody's usual erase key is DEL (which, for most BSD users, it will
3674 * be), they're going to get really annoyed if their erase key starts
3675 * doing forward deletes for no reason. (Eric Fischer)
3676 */
3677 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003678get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003680 ttyinfo_T info;
3681 char_u buf[2];
3682 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003684 if (get_tty_info(read_cmd_fd, &info) != OK)
3685 return;
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003686
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00003687 intr_char = info.interrupt;
3688 buf[0] = info.backspace;
3689 buf[1] = NUL;
3690 add_termcode((char_u *)"kb", buf, FALSE);
3691
3692 // If <BS> and <DEL> are now the same, redefine <DEL>.
3693 p = find_termcode((char_u *)"kD");
3694 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3695 do_fixdel(NULL);
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003696}
3697
3698/*
3699 * Obtain the characters that Backspace and Enter produce on "fd".
3700 * Returns OK or FAIL.
3701 */
3702 int
3703get_tty_info(int fd, ttyinfo_T *info)
3704{
3705#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706# ifdef HAVE_TERMIOS_H
3707 struct termios keys;
3708# else
3709 struct termio keys;
3710# endif
3711
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003712 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003714 info->backspace = keys.c_cc[VERASE];
3715 info->interrupt = keys.c_cc[VINTR];
3716 if (keys.c_iflag & ICRNL)
3717 info->enter = NL;
3718 else
3719 info->enter = CAR;
3720 if (keys.c_oflag & ONLCR)
3721 info->nl_does_cr = TRUE;
3722 else
3723 info->nl_does_cr = FALSE;
3724 return OK;
3725 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003727 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 struct sgttyb keys;
3729
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003730 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003732 info->backspace = keys.sg_erase;
3733 info->interrupt = keys.sg_kill;
3734 info->enter = CAR;
3735 info->nl_does_cr = TRUE;
3736 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003739 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740}
3741
Bram Moolenaar0f873732019-12-05 20:28:46 +01003742#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003744static int mouse_ison = FALSE;
3745
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746/*
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003747 * Set mouse clicks on or off and possible enable mouse movement events.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 */
3749 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003750mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003752#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003753 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003754#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 int xterm_mouse_vers;
3756
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003757#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003758 if (!on)
3759 // Make sure not tracing mouse movements. Important when a button-down
3760 // was received but no release yet.
3761 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003762#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003763
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003764 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003765#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003766 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003767#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003768 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003769 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 return;
3771
3772 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003773
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003774#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003775 if (ttym_flags == TTYM_URXVT)
3776 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003777 out_str_nf((char_u *)(on ? "\033[?1015h" : "\033[?1015l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003778 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003779 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003780#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003781
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00003782 if (T_CXM != NULL && *T_CXM != NUL)
3783 {
3784 term_enable_mouse(on);
3785 }
3786 else if (ttym_flags == TTYM_SGR)
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003787 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003788 // SGR mode supports columns above 223
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003789 out_str_nf((char_u *)(on ? "\033[?1006h" : "\033[?1006l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003790 mouse_ison = on;
3791 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003792
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003793#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003794 if (bevalterm_ison != (p_bevalterm && on))
3795 {
3796 bevalterm_ison = (p_bevalterm && on);
3797 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003798 // disable mouse movement events, enabling is below
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003799 out_str_nf((char_u *)("\033[?1003l"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003800 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003801#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003802
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 if (xterm_mouse_vers > 0)
3804 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003805 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 out_str_nf((char_u *)
3807 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003808 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003809#ifdef FEAT_BEVAL_TERM
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003810 bevalterm_ison ? "\033[?1003h" :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003811#endif
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003812 "\033[?1002h")
3813 : "\033[?1000h"));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003814 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 out_str_nf((char_u *)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003816 (xterm_mouse_vers > 1 ? "\033[?1002l" : "\033[?1000l"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003817 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 }
3819
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003820#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 else if (ttym_flags == TTYM_DEC)
3822 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003823 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003825 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003827 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003829#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003831#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 else
3833 {
3834 if (on)
3835 {
3836 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003837 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 }
3839 else
3840 {
3841 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003842 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 }
3844 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003845#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003847#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003848 else
3849 {
3850 if (on)
3851 {
3852 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003853 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003854 }
3855 else
3856 {
3857 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003858 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003859 }
3860 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003861#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003862
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003863#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 else
3865 {
3866 if (on)
3867 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003868 // D - Enable Mouse up/down messages
3869 // L - Enable Left Button Reporting
3870 // M - Enable Middle Button Reporting
3871 // R - Enable Right Button Reporting
3872 // K - Enable SHIFT and CTRL key Reporting
3873 // + - Enable Advanced messaging of mouse moves and up/down messages
3874 // Q - Quiet No Ack
3875 // # - Numeric value of mouse pointer required
3876 // 0 = Multiview 2000 cursor, used as standard
3877 // 1 = Windows Arrow
3878 // 2 = Windows I Beam
3879 // 3 = Windows Hour Glass
3880 // 4 = Windows Cross Hair
3881 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003882# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003883 // Disables full feedback of pointer movements
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003884 out_str_nf((char_u *)"\033[0~ZwLMRK1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003885# else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003886 out_str_nf((char_u *)"\033[0~ZwLMRK+1Q\033\\");
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003887# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003888 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 }
3890 else
3891 {
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003892 out_str_nf((char_u *)"\033[0~ZwQ\033\\");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003893 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 }
3895 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003896#endif
3897#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 else
3899 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003900 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 if (on)
3902 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3903 else
3904 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003905 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003907#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908}
3909
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003910#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003911/*
3912 * Called when 'balloonevalterm' changed.
3913 */
3914 void
3915mch_bevalterm_changed(void)
3916{
3917 mch_setmouse(mouse_ison);
3918}
3919#endif
3920
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921/*
3922 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3923 */
3924 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003925check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926{
3927# ifdef FEAT_MOUSE_XTERM
3928 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003929# ifdef FEAT_MOUSE_URXVT
3930 && use_xterm_mouse() != 3
3931# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932# ifdef FEAT_GUI
3933 && !gui.in_use
3934# endif
3935 )
3936 {
3937 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003938 ? "\233M" : "\033[M"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 if (*p_mouse != NUL)
3940 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003941 // force mouse off and maybe on to send possibly new mouse
3942 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 mch_setmouse(FALSE);
3944 setmouse();
3945 }
3946 }
3947 else
3948 del_mouse_termcode(KS_MOUSE);
3949# endif
3950
3951# ifdef FEAT_MOUSE_GPM
3952 if (!use_xterm_mouse()
3953# ifdef FEAT_GUI
3954 && !gui.in_use
3955# endif
3956 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003957 set_mouse_termcode(KS_GPM_MOUSE, (char_u *)"\033MG");
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003958 else
3959 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960# endif
3961
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003962# ifdef FEAT_SYSMOUSE
3963 if (!use_xterm_mouse()
3964# ifdef FEAT_GUI
3965 && !gui.in_use
3966# endif
3967 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003968 set_mouse_termcode(KS_MOUSE, (char_u *)"\033MS");
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003969# endif
3970
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003972 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 if (!use_xterm_mouse()
3974# ifdef FEAT_GUI
3975 && !gui.in_use
3976# endif
3977 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003978 set_mouse_termcode(KS_JSBTERM_MOUSE, (char_u *)"\033[0~zw");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 else
3980 del_mouse_termcode(KS_JSBTERM_MOUSE);
3981# endif
3982
3983# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003984 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3985 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 if (!use_xterm_mouse()
3987# ifdef FEAT_GUI
3988 && !gui.in_use
3989# endif
3990 )
Bram Moolenaar424bcae2022-01-31 14:59:41 +00003991 set_mouse_termcode(KS_NETTERM_MOUSE, (char_u *)"\033}");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 else
3993 del_mouse_termcode(KS_NETTERM_MOUSE);
3994# endif
3995
3996# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01003997 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003998 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999# ifdef FEAT_GUI
4000 && !gui.in_use
4001# endif
4002 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004003 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004004 ? "\233" : "\033["));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 else
4006 del_mouse_termcode(KS_DEC_MOUSE);
4007# endif
4008# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01004009 // same conflict as the dec mouse
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 Moolenaar424bcae2022-01-31 14:59:41 +00004015 set_mouse_termcode(KS_PTERM_MOUSE, (char_u *)"\033[");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 else
4017 del_mouse_termcode(KS_PTERM_MOUSE);
4018# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02004019# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02004020 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02004021# ifdef FEAT_GUI
4022 && !gui.in_use
4023# endif
4024 )
4025 {
4026 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004027 ? "\233*M" : "\033[*M"));
Bram Moolenaarc8427482011-10-20 21:09:35 +02004028
4029 if (*p_mouse != NUL)
4030 {
4031 mch_setmouse(FALSE);
4032 setmouse();
4033 }
4034 }
4035 else
4036 del_mouse_termcode(KS_URXVT_MOUSE);
4037# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004038 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004039# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004040 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01004041# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004042 )
4043 {
4044 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004045 ? "\233<*M" : "\033[<*M"));
Bram Moolenaara529ce02017-06-22 22:37:57 +02004046
4047 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00004048 ? "\233<*m" : "\033[<*m"));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004049
4050 if (*p_mouse != NUL)
4051 {
4052 mch_setmouse(FALSE);
4053 setmouse();
4054 }
4055 }
4056 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02004057 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02004058 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02004059 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
4060 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063#ifndef VMS
4064
4065/*
4066 * Try to get the current window size:
4067 * 1. with an ioctl(), most accurate method
4068 * 2. from the environment variables LINES and COLUMNS
4069 * 3. from the termcap
4070 * 4. keep using the old values
4071 * Return OK when size could be determined, FAIL otherwise.
4072 */
4073 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004074mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075{
4076 long rows = 0;
4077 long columns = 0;
4078 char_u *p;
4079
4080 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 * 1. try using an ioctl. It is the most accurate method.
4082 *
4083 * Try using TIOCGWINSZ first, some systems that have it also define
4084 * TIOCGSIZE but don't have a struct ttysize.
4085 */
4086# ifdef TIOCGWINSZ
4087 {
4088 struct winsize ws;
4089 int fd = 1;
4090
Bram Moolenaar0f873732019-12-05 20:28:46 +01004091 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 if (!isatty(fd) && isatty(read_cmd_fd))
4093 fd = read_cmd_fd;
4094 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4095 {
4096 columns = ws.ws_col;
4097 rows = ws.ws_row;
4098 }
4099 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004100# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101# ifdef TIOCGSIZE
4102 {
4103 struct ttysize ts;
4104 int fd = 1;
4105
Bram Moolenaar0f873732019-12-05 20:28:46 +01004106 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 if (!isatty(fd) && isatty(read_cmd_fd))
4108 fd = read_cmd_fd;
4109 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4110 {
4111 columns = ts.ts_cols;
4112 rows = ts.ts_lines;
4113 }
4114 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004115# endif // TIOCGSIZE
4116# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117
4118 /*
4119 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004120 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4121 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004123 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 {
4125 if ((p = (char_u *)getenv("LINES")))
4126 rows = atoi((char *)p);
4127 if ((p = (char_u *)getenv("COLUMNS")))
4128 columns = atoi((char *)p);
4129 }
4130
4131#ifdef HAVE_TGETENT
4132 /*
4133 * 3. try reading "co" and "li" entries from termcap
4134 */
4135 if (columns == 0 || rows == 0)
4136 getlinecol(&columns, &rows);
4137#endif
4138
4139 /*
4140 * 4. If everything fails, use the old values
4141 */
4142 if (columns <= 0 || rows <= 0)
4143 return FAIL;
4144
4145 Rows = rows;
4146 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004147 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 return OK;
4149}
4150
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004151#if defined(FEAT_TERMINAL) || defined(PROTO)
4152/*
4153 * Report the windows size "rows" and "cols" to tty "fd".
4154 */
4155 int
4156mch_report_winsize(int fd, int rows, int cols)
4157{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004158 int tty_fd;
4159 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004160
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004161 tty_fd = get_tty_fd(fd);
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004162 if (tty_fd < 0)
4163 return FAIL;
4164
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004165# if defined(TIOCSWINSZ)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004166 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004167
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004168 ws.ws_col = cols;
4169 ws.ws_row = rows;
4170 ws.ws_xpixel = cols * 5;
4171 ws.ws_ypixel = rows * 10;
4172 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4173 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4174 retval == 0 ? "success" : "failed");
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004175# elif defined(TIOCSSIZE)
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004176 struct ttysize ts;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004177
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004178 ts.ts_cols = cols;
4179 ts.ts_lines = rows;
4180 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4181 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4182 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004183# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004184 if (tty_fd != fd)
4185 close(tty_fd);
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004186 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004187}
4188#endif
4189
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190/*
4191 * Try to set the window size to Rows and Columns.
4192 */
4193 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004194mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195{
4196 if (*T_CWS)
4197 {
4198 /*
4199 * NOTE: if you get an error here that term_set_winsize() is
4200 * undefined, check the output of configure. It could probably not
4201 * find a ncurses, termcap or termlib library.
4202 */
4203 term_set_winsize((int)Rows, (int)Columns);
4204 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004205 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 }
4207}
4208
Bram Moolenaar0f873732019-12-05 20:28:46 +01004209#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210
4211/*
4212 * Rows and/or Columns has changed.
4213 */
4214 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004215mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004217 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218}
4219
Bram Moolenaar205b8862011-09-07 15:04:31 +02004220/*
4221 * Wait for process "child" to end.
4222 * Return "child" if it exited properly, <= 0 on error.
4223 */
4224 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004225wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004226{
4227 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004228 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004229
4230 while (wait_pid != child)
4231 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004232 // When compiled with Python threads are probably used, in which case
4233 // wait() sometimes hangs for no obvious reason. Use waitpid()
4234 // instead and loop (like the GUI). Also needed for other interfaces,
4235 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004236# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004237 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004238# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004239 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004240# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004241 if (wait_pid == 0)
4242 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004243 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004244 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004245 if (++delay_msec > 10)
4246 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004247 continue;
4248 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004249 if (wait_pid <= 0
4250# ifdef ECHILD
4251 && errno == ECHILD
4252# endif
4253 )
4254 break;
4255 }
4256 return wait_pid;
4257}
4258
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004259#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004260/*
4261 * Set the environment for a child process.
4262 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004263 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004264set_child_environment(
4265 long rows,
4266 long columns,
4267 char *term,
4268 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004269{
4270# ifdef HAVE_SETENV
4271 char envbuf[50];
4272# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004273 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004274 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004275 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004276 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004277 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004278# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004279 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004280# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004281# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004282 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004283# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004284# endif
4285
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004286# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004287 setenv("TERM", term, 1);
4288 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004289 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004290 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004291 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004292 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004293 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004294 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004295 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004296# ifdef FEAT_TERMINAL
4297 if (is_terminal)
4298 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004299 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004300 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4301 }
4302# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004303# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004304 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004305# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004306# else
4307 /*
4308 * Putenv does not copy the string, it has to remain valid.
4309 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004310 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004311 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004312 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4313 putenv(envbuf_Term);
4314 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004315 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004316 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4317 putenv(envbuf_Lines);
4318 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4319 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004320 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004321 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004322 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004323# ifdef FEAT_TERMINAL
4324 if (is_terminal)
4325 {
4326 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004327 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004328 putenv(envbuf_Version);
4329 }
4330# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004331# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004332 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4333 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4334 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004335# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004336# endif
4337}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004338
4339 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004340set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004341{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004342 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004343}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004344#endif
4345
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004346#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004347/*
4348 * Open a PTY, with FD for the master and slave side.
4349 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004350 * When successful both file descriptors are stored and the allocated pty name
4351 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004352 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004353 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004354open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004355{
4356 char *tty_name;
4357
Bram Moolenaar59386482019-02-10 22:43:46 +01004358 if (name1 != NULL)
4359 *name1 = NULL;
4360 if (name2 != NULL)
4361 *name2 = NULL;
4362
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004363 *pty_master_fd = mch_openpty(&tty_name); // open pty
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004364 if (*pty_master_fd < 0)
4365 return;
4366
4367 // Leaving out O_NOCTTY may lead to waitpid() always returning
4368 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4369 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004370#ifdef O_NOCTTY
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004371 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004372#else
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004373 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004374#endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00004375 if (*pty_slave_fd < 0)
4376 {
4377 close(*pty_master_fd);
4378 *pty_master_fd = -1;
4379 }
4380 else
4381 {
4382 if (name1 != NULL)
4383 *name1 = vim_strsave((char_u *)tty_name);
4384 if (name2 != NULL)
4385 *name2 = vim_strsave((char_u *)tty_name);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004386 }
4387}
4388#endif
4389
Bram Moolenaarfae42832017-08-01 22:24:26 +02004390/*
4391 * Send SIGINT to a child process if "c" is an interrupt character.
4392 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004393 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004394may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4395{
4396# ifdef SIGINT
4397 if (c == Ctrl_C || c == intr_char)
4398 {
4399# ifdef HAVE_SETSID
4400 kill(-pid, SIGINT);
4401# else
4402 kill(0, SIGINT);
4403# endif
4404 if (wpid > 0)
4405 kill(wpid, SIGINT);
4406 }
4407# endif
4408}
4409
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004410#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004411
Bram Moolenaar0f873732019-12-05 20:28:46 +01004412/*
4413 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4414 * pointers, the last one is NULL.
4415 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4416 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004417 int
4418unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004419 char_u *cmd,
4420 char ***argvp,
4421 char_u **sh_tofree,
4422 char_u **shcf_tofree)
4423{
4424 char **argv = NULL;
4425 int argc;
4426
4427 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004428 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004429 return FAIL;
4430
4431 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4432 return FAIL;
4433 *argvp = argv;
4434
4435 if (cmd != NULL)
4436 {
4437 char_u *s;
4438 char_u *p;
4439
4440 if (extra_shell_arg != NULL)
4441 argv[argc++] = (char *)extra_shell_arg;
4442
Bram Moolenaar0f873732019-12-05 20:28:46 +01004443 // Break 'shellcmdflag' into white separated parts. This doesn't
4444 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004445 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004446 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004447 return FAIL;
4448 s = *shcf_tofree;
4449 p = p_shcf;
4450 while (*p != NUL)
4451 {
4452 argv[argc++] = (char *)s;
4453 while (*p && *p != ' ' && *p != TAB)
4454 *s++ = *p++;
4455 *s++ = NUL;
4456 p = skipwhite(p);
4457 }
4458
4459 argv[argc++] = (char *)cmd;
4460 }
4461 argv[argc] = NULL;
4462 return OK;
4463}
4464#endif
4465
4466#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4467/*
4468 * Use a terminal window to run a shell command in.
4469 */
4470 static int
4471mch_call_shell_terminal(
4472 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004473 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004474{
4475 jobopt_T opt;
4476 char **argv = NULL;
4477 char_u *tofree1 = NULL;
4478 char_u *tofree2 = NULL;
4479 int retval = -1;
4480 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004481 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004482 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004483 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004484
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004485 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004486 goto theend;
4487
4488 init_job_options(&opt);
4489 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4490 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004491 if (buf == NULL)
4492 goto theend;
4493
4494 job = term_getjob(buf->b_term);
4495 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004496
Bram Moolenaar0f873732019-12-05 20:28:46 +01004497 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004498 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00004499 if (curbuf == buf)
Bram Moolenaar13568252018-03-16 20:46:58 +01004500 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004501 // Only when managed to find a window for "buf",
4502 clear_oparg(&oa);
4503 while (term_use_loop())
Bram Moolenaar13568252018-03-16 20:46:58 +01004504 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00004505 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4506 {
4507 // If terminal_loop() returns OK we got a key that is handled
4508 // in Normal model. We don't do redrawing anyway.
4509 if (terminal_loop(TRUE) == OK)
4510 normal_cmd(&oa, TRUE);
4511 }
4512 else
Bram Moolenaar13568252018-03-16 20:46:58 +01004513 normal_cmd(&oa, TRUE);
4514 }
Bram Moolenaare76062c2022-11-28 18:51:43 +00004515 retval = job->jv_exitval;
4516 ch_log(NULL, "system command finished");
4517
4518 job_unref(job);
4519
4520 // restore curwin/curbuf and a few other things
4521 aucmd_restbuf(&aco);
Bram Moolenaar13568252018-03-16 20:46:58 +01004522 }
Bram Moolenaar13568252018-03-16 20:46:58 +01004523
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01004524 // Only require pressing Enter when redrawing, to avoid that system() gets
Bram Moolenaarcb5ed4d2022-07-28 12:54:08 +01004525 // the hit-enter prompt even though it didn't output anything.
4526 if (!RedrawingDisabled)
4527 wait_return(TRUE);
Bram Moolenaar13568252018-03-16 20:46:58 +01004528 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4529
4530theend:
4531 vim_free(argv);
4532 vim_free(tofree1);
4533 vim_free(tofree2);
4534 return retval;
4535}
4536#endif
4537
4538#ifdef USE_SYSTEM
4539/*
4540 * Use system() to start the shell: simple but slow.
4541 */
4542 static int
4543mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004544 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004545 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546{
4547#ifdef VMS
4548 char *ifn = NULL;
4549 char *ofn = NULL;
4550#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004551 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004552 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004553 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554
4555 out_flush();
4556
4557 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004558 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559
Bram Moolenaar62b42182010-09-21 22:09:37 +02004560# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004561 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004562 loose_clipboard();
4563# endif
4564
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 if (cmd == NULL)
4566 x = system((char *)p_sh);
4567 else
4568 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004569# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 if (ofn = strchr((char *)cmd, '>'))
4571 *ofn++ = '\0';
4572 if (ifn = strchr((char *)cmd, '<'))
4573 {
4574 char *p;
4575
4576 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004577 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 if (p)
4579 *p = '\0';
4580 }
4581 if (ofn)
4582 x = vms_sys((char *)cmd, ofn, ifn);
4583 else
4584 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004585# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004586 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004588 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 if (newcmd == NULL)
4590 x = 0;
4591 else
4592 {
4593 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4594 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4595 (char *)p_shcf,
4596 (char *)cmd);
4597 x = system((char *)newcmd);
4598 vim_free(newcmd);
4599 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004600# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 }
4602# ifdef VMS
4603 x = vms_sys_status(x);
4604# endif
4605 if (emsg_silent)
4606 ;
4607 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004608 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 else if (x && !(options & SHELL_SILENT))
4610 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004611 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 msg_outnum((long)x);
4613 msg_putchar('\n');
4614 }
4615
4616 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004617 {
4618 // The shell may have messed with the mode, always set it.
4619 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004620 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004621 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 resettitle();
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004623# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4624 restore_clipboard();
4625# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004627}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628
Bram Moolenaar0f873732019-12-05 20:28:46 +01004629#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630
Bram Moolenaar0f873732019-12-05 20:28:46 +01004631# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4632 // 127, some shells use that already
4633# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634
Bram Moolenaar13568252018-03-16 20:46:58 +01004635/*
4636 * Don't use system(), use fork()/exec().
4637 */
4638 static int
4639mch_call_shell_fork(
4640 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004641 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004642{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004643 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004645 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 pid_t wait_pid = 0;
4647# ifdef HAVE_UNION_WAIT
4648 union wait status;
4649# else
4650 int status = -1;
4651# endif
4652 int retval = -1;
4653 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004654 char_u *tofree1 = NULL;
4655 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004657 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004658# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004660# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004661 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 int fd_fromshell[2];
4663 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004664 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665
4666 out_flush();
4667 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004668 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004669 if (tmode == TMODE_RAW)
4670 // The shell may have messed with the mode, always set it later.
4671 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004673 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004674 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004675
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004677 * For the GUI, when writing the output into the buffer and when reading
4678 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4679 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004681 if ((options & (SHELL_READ|SHELL_WRITE))
4682# ifdef FEAT_GUI
4683 || (gui.in_use && show_shell_mess)
4684# endif
4685 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004687# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 /*
4689 * Try to open a master pty.
4690 * If this works, open the slave pty.
4691 * If the slave can't be opened, close the master pty.
4692 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004693 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004694 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 /*
4696 * If not opening a pty or it didn't work, try using pipes.
4697 */
4698 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004699# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 {
4701 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004702 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 {
4704 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004705 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 {
4707 close(fd_toshell[0]);
4708 close(fd_toshell[1]);
4709 }
4710 }
4711 if (pipe_error)
4712 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004713 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 out_flush();
4715 }
4716 }
4717 }
4718
Bram Moolenaar0f873732019-12-05 20:28:46 +01004719 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004721 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004722 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004723 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004724 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004726 UNBLOCK_SIGNALS(&curset);
4727
Bram Moolenaar32526b32019-01-19 17:43:09 +01004728 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004729 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004731 || (gui.in_use && show_shell_mess)
4732# endif
4733 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004735# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004736 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 {
4738 close(pty_master_fd);
4739 close(pty_slave_fd);
4740 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004741 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004742# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 {
4744 close(fd_toshell[0]);
4745 close(fd_toshell[1]);
4746 close(fd_fromshell[0]);
4747 close(fd_fromshell[1]);
4748 }
4749 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004751 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004753 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004754 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00004756# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01004757 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004758 {
4759 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004760 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004761 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004762# endif
4763
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 if (!show_shell_mess || (options & SHELL_EXPAND))
4765 {
4766 int fd;
4767
4768 /*
4769 * Don't want to show any message from the shell. Can't just
4770 * close stdout and stderr though, because some systems will
4771 * break if you try to write to them after that, so we must
4772 * use dup() to replace them with something else -- webb
4773 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4774 * waiting for input.
4775 */
4776 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4777 fclose(stdin);
4778 fclose(stdout);
4779 fclose(stderr);
4780
4781 /*
4782 * If any of these open()'s and dup()'s fail, we just continue
4783 * anyway. It's not fatal, and on most systems it will make
4784 * no difference at all. On a few it will cause the execvp()
4785 * to exit with a non-zero status even when the completion
4786 * could be done, which is nothing too serious. If the open()
4787 * or dup() failed we'd just do the same thing ourselves
4788 * anyway -- webb
4789 */
4790 if (fd >= 0)
4791 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004792 vim_ignored = dup(fd); // To replace stdin (fd 0)
4793 vim_ignored = dup(fd); // To replace stdout (fd 1)
4794 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795
Bram Moolenaar0f873732019-12-05 20:28:46 +01004796 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 close(fd);
4798 }
4799 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004800 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004802 || gui.in_use
4803# endif
4804 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 {
4806
Bram Moolenaardf177f62005-02-22 08:39:57 +00004807# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004808 // Create our own process group, so that the child and all its
4809 // children can be kill()ed. Don't do this when using pipes,
4810 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004811 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004812 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004813 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004814# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004815 // When doing "!xterm&" and 'shell' is bash: the shell
4816 // will exit and send SIGHUP to all processes in its
4817 // group, killing the just started process. Ignore SIGHUP
4818 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004819 signal(SIGHUP, SIG_IGN);
4820# endif
4821 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004822# endif
4823# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004824 if (pty_slave_fd >= 0)
4825 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004826 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004827 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004828 setup_slavepty(pty_slave_fd);
Bram Moolenaarfff10d92021-10-13 10:05:30 +01004829# ifdef TIOCSCTTY
4830 // Try to become controlling tty (probably doesn't work,
4831 // unless run by root)
4832 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
4833# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004834 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004835# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004836 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
Bram Moolenaara5792f52005-11-23 21:25:05 +00004838 /*
4839 * stderr is only redirected when using the GUI, so that a
4840 * program like gpg can still access the terminal to get a
4841 * passphrase using stderr.
4842 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004843# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 if (pty_master_fd >= 0)
4845 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004846 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
Bram Moolenaar0f873732019-12-05 20:28:46 +01004848 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004850 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004852 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004853 if (gui.in_use)
4854 {
4855 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004856 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004857 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858
Bram Moolenaar0f873732019-12-05 20:28:46 +01004859 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 }
4861 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004862# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004864 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 close(fd_toshell[1]);
4866 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004867 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 close(fd_toshell[0]);
4869
Bram Moolenaar0f873732019-12-05 20:28:46 +01004870 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 close(fd_fromshell[0]);
4872 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004873 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 close(fd_fromshell[1]);
4875
Bram Moolenaara5792f52005-11-23 21:25:05 +00004876# ifdef FEAT_GUI
4877 if (gui.in_use)
4878 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004879 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004880 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004881 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004882 }
4883# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 }
4885 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004886
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 /*
4888 * There is no type cast for the argv, because the type may be
4889 * different on different machines. This may cause a warning
4890 * message with strict compilers, don't worry about it.
4891 * Call _exit() instead of exit() to avoid closing the connection
4892 * to the X server (esp. with GTK, which uses atexit()).
4893 */
4894 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004895 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004897 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 {
4899 /*
4900 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004901 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 */
4903 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004904 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004905 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004906# ifdef FEAT_JOB_CHANNEL
4907 ++dont_check_job_ended;
4908# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 /*
4910 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004911 * This is also used to pipe stdin/stdout to/from the external
4912 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004914 if ((options & (SHELL_READ|SHELL_WRITE))
4915# ifdef FEAT_GUI
4916 || (gui.in_use && show_shell_mess)
4917# endif
4918 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004920# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004922 int buffer_off = 0; // valid bytes in buffer[]
4923 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4924 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 int len;
4926 int p_more_save;
4927 int old_State;
4928 int c;
4929 int toshell_fd;
4930 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004931 garray_T ga;
4932 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004933# ifdef ELAPSED_FUNC
4934 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004935# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936
Bram Moolenaardf177f62005-02-22 08:39:57 +00004937# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 if (pty_master_fd >= 0)
4939 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 fromshell_fd = pty_master_fd;
4941 toshell_fd = dup(pty_master_fd);
4942 }
4943 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004944# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 {
4946 close(fd_toshell[0]);
4947 close(fd_fromshell[1]);
4948 toshell_fd = fd_toshell[1];
4949 fromshell_fd = fd_fromshell[0];
4950 }
4951
4952 /*
4953 * Write to the child if there are typed characters.
4954 * Read from the child if there are characters available.
4955 * Repeat the reading a few times if more characters are
4956 * available. Need to check for typed keys now and then, but
4957 * not too often (delays when no chars are available).
4958 * This loop is quit if no characters can be read from the pty
4959 * (WaitForChar detected special condition), or there are no
4960 * characters available and the child has exited.
4961 * Only check if the child has exited when there is no more
4962 * output. The child may exit before all the output has
4963 * been printed.
4964 *
4965 * Currently this busy loops!
4966 * This can probably dead-lock when the write blocks!
4967 */
4968 p_more_save = p_more;
4969 p_more = FALSE;
4970 old_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01004971 State = MODE_EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004973 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004974 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004975 // Fork a process that will write the lines to the
4976 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004977 if ((wpid = fork()) == -1)
4978 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004979 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004980 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004981 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004982 {
4983 linenr_T lnum = curbuf->b_op_start.lnum;
4984 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004985 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004986 size_t l;
4987
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004988 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004989 for (;;)
4990 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00004991 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004992 if (l == 0)
4993 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004994 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004995 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00004996 len = write(toshell_fd, "", (size_t)1);
4997 else
4998 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01004999 char_u *s = vim_strchr(lp + written, NL);
5000
Bram Moolenaar89d40322006-08-29 15:30:07 +00005001 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00005002 s == NULL ? l
5003 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00005004 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00005005 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00005006 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005007 // Finished a line, add a NL, unless this line
5008 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005009 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005010 || (!curbuf->b_p_bin
5011 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005012 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaar88456cd2022-11-18 22:14:09 +00005013 && (lnum != curbuf->b_ml.ml_line_count
Bram Moolenaardf177f62005-02-22 08:39:57 +00005014 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02005015 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005016 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005017 ++lnum;
5018 if (lnum > curbuf->b_op_end.lnum)
5019 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005020 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00005021 close(toshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005022 break;
5023 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00005024 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005025 written = 0;
5026 }
5027 else if (len > 0)
5028 written += len;
5029 }
5030 _exit(0);
5031 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005032 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00005033 {
5034 close(toshell_fd);
5035 toshell_fd = -1;
5036 }
5037 }
5038
5039 if (options & SHELL_READ)
5040 ga_init2(&ga, 1, BUFLEN);
5041
5042 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005043# ifdef ELAPSED_FUNC
5044 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005045# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 for (;;)
5047 {
5048 /*
5049 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005050 * if there are any.
5051 * Don't do this if we are expanding wild cards (would eat
5052 * typeahead).
5053 * Don't do this when filtering and terminal is in cooked
5054 * mode, the shell command will handle the I/O. Avoids
5055 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005056 * Don't get characters when the child has already
5057 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00005058 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005059 * while (noread_cnt > 4), avoids that ":r !ls" eats
5060 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 */
5062 len = 0;
5063 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005064 && ((options &
5065 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5066 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005067# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005068 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005069# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005070 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005071 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005072 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005074 if (ta_len == 0)
5075 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005076 // Get extra characters when we don't have any.
5077 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005078 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005079# ifdef ELAPSED_FUNC
5080 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005081# endif
5082 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5083 }
5084 if (ta_len > 0 || len > 0)
5085 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 /*
5087 * For pipes:
5088 * Check for CTRL-C: send interrupt signal to child.
5089 * Check for CTRL-D: EOF, close pipe to child.
5090 */
5091 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5092 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 /*
5094 * Send SIGINT to the child's group or all
5095 * processes in our group.
5096 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005097 may_send_sigint(ta_buf[ta_len], pid, wpid);
5098
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 if (pty_master_fd < 0 && toshell_fd >= 0
5100 && ta_buf[ta_len] == Ctrl_D)
5101 {
5102 close(toshell_fd);
5103 toshell_fd = -1;
5104 }
5105 }
5106
Bram Moolenaar2f7e1b82022-10-04 13:17:31 +01005107 // Remove Vim-specific codes from the input.
5108 len = term_replace_keycodes(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109
5110 /*
5111 * For pipes: echo the typed characters.
5112 * For a pty this does not seem to work.
5113 */
5114 if (pty_master_fd < 0)
5115 {
5116 for (i = ta_len; i < ta_len + len; ++i)
5117 {
5118 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5119 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 else if (has_mbyte)
5121 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005122 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123
5124 msg_outtrans_len(ta_buf + i, l);
5125 i += l - 1;
5126 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 else
5128 msg_outtrans_len(ta_buf + i, 1);
5129 }
5130 windgoto(msg_row, msg_col);
5131 out_flush();
5132 }
5133
5134 ta_len += len;
5135
5136 /*
5137 * Write the characters to the child, unless EOF has
5138 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005139 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005140 * When writing buffer lines, drop the typed
5141 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005143 if (options & SHELL_WRITE)
5144 ta_len = 0;
5145 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 {
5147 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5148 if (len > 0)
5149 {
5150 ta_len -= len;
5151 mch_memmove(ta_buf, ta_buf + len, ta_len);
5152 }
5153 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005154 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 }
5156
Bram Moolenaardf177f62005-02-22 08:39:57 +00005157 if (got_int)
5158 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005159 // CTRL-C sends a signal to the child, we ignore it
5160 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005161# ifdef HAVE_SETSID
5162 kill(-pid, SIGINT);
5163# else
5164 kill(0, SIGINT);
5165# endif
5166 if (wpid > 0)
5167 kill(wpid, SIGINT);
5168 got_int = FALSE;
5169 }
5170
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 /*
5172 * Check if the child has any characters to be printed.
5173 * Read them and write them to our window. Repeat this as
5174 * long as there is something to do, avoid the 10ms wait
5175 * for mch_inchar(), or sending typeahead characters to
5176 * the external process.
5177 * TODO: This should handle escape sequences, compatible
5178 * to some terminal (vt52?).
5179 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005180 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005181 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005183 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005186 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005188
5189 noread_cnt = 0;
5190 if (options & SHELL_READ)
5191 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005192 // Do NUL -> NL translation, append NL separated
5193 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005194 for (i = 0; i < len; ++i)
5195 {
5196 if (buffer[i] == NL)
5197 append_ga_line(&ga);
5198 else if (buffer[i] == NUL)
5199 ga_append(&ga, NL);
5200 else
5201 ga_append(&ga, buffer[i]);
5202 }
5203 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005204 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 {
5206 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005207 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208
Bram Moolenaardf177f62005-02-22 08:39:57 +00005209 len += buffer_off;
5210 buffer[len] = NUL;
5211
Bram Moolenaar0f873732019-12-05 20:28:46 +01005212 // Check if the last character in buffer[] is
5213 // incomplete, keep these bytes for the next
5214 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 for (p = buffer; p < buffer + len; p += l)
5216 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005217 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005219 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 else if (MB_BYTE2LEN(*p) != l)
5221 break;
5222 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005223 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005225 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 if (len >= 12)
5227 ++p;
5228 else
5229 {
5230 buffer_off = len;
5231 continue;
5232 }
5233 }
5234 c = *p;
5235 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005236 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 if (p < buffer + len)
5238 {
5239 *p = c;
5240 buffer_off = (buffer + len) - p;
5241 mch_memmove(buffer, p, buffer_off);
5242 continue;
5243 }
5244 buffer_off = 0;
5245 }
5246 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 {
5248 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005249 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 }
5251
5252 windgoto(msg_row, msg_col);
5253 cursor_on();
5254 out_flush();
5255 if (got_int)
5256 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005257
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005258# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005259 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005260 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005261 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005262
Bram Moolenaar0f873732019-12-05 20:28:46 +01005263 // Avoid that we keep looping here without
5264 // checking for a CTRL-C for a long time. Don't
5265 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005266 if (msec > 2000)
5267 {
5268 noread_cnt = 5;
5269 break;
5270 }
5271 }
5272# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 }
5274
Bram Moolenaar0f873732019-12-05 20:28:46 +01005275 // If we already detected the child has finished, continue
5276 // reading output for a short while. Some text may be
5277 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005278 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005279 {
5280 if (noread_cnt < 5)
5281 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005282 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005283 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005284
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 /*
5286 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005287 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005289# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005290 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005291# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005293# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5295 || (wait_pid == pid && WIFEXITED(status)))
5296 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005297 // Don't break the loop yet, try reading more
5298 // characters from "fromshell_fd" first. When using
5299 // pipes there might still be something to read and
5300 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005303 else
5304 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005305
Bram Moolenaar95a51352013-03-21 22:53:50 +01005306# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005307 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005308 clip_update();
5309# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 }
5311finished:
5312 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005313 if (options & SHELL_READ)
5314 {
5315 if (ga.ga_len > 0)
5316 {
5317 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005318 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005319 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005320 }
5321 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005322 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005323 ga_clear(&ga);
5324 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 /*
5327 * Give all typeahead that wasn't used back to ui_inchar().
5328 */
5329 if (ta_len)
5330 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 State = old_State;
5332 if (toshell_fd >= 0)
5333 close(toshell_fd);
5334 close(fromshell_fd);
5335 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005336# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005337 else
5338 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005339 long delay_msec = 1;
5340
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005341 if (tmode == TMODE_RAW)
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005342 // Possibly disables modifyOtherKeys, so that the system
5343 // can recognize CTRL-C.
5344 out_str_t_TE();
Bram Moolenaar0981c872020-08-23 14:28:37 +02005345
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005346 /*
5347 * Similar to the loop above, but only handle X events, no
5348 * I/O.
5349 */
5350 for (;;)
5351 {
5352 if (got_int)
5353 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005354 // CTRL-C sends a signal to the child, we ignore it
5355 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005356# ifdef HAVE_SETSID
5357 kill(-pid, SIGINT);
5358# else
5359 kill(0, SIGINT);
5360# endif
5361 got_int = FALSE;
5362 }
5363# ifdef __NeXT__
5364 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5365# else
5366 wait_pid = waitpid(pid, &status, WNOHANG);
5367# endif
5368 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5369 || (wait_pid == pid && WIFEXITED(status)))
5370 {
5371 wait_pid = pid;
5372 break;
5373 }
5374
Bram Moolenaar0f873732019-12-05 20:28:46 +01005375 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005376 clip_update();
5377
Bram Moolenaar0f873732019-12-05 20:28:46 +01005378 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005379 // less time, gradually wait longer.
5380 mch_delay(delay_msec,
5381 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005382 if (++delay_msec > 10)
5383 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005384 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005385
Bram Moolenaar8a3da6a2020-12-08 19:18:37 +01005386 if (tmode == TMODE_RAW)
5387 // possibly enables modifyOtherKeys again
Bram Moolenaar733a69b2022-12-01 12:03:47 +00005388 out_str_t_TI();
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005389 }
5390# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391
5392 /*
5393 * Wait until our child has exited.
5394 * Ignore wait() returning pids of other children and returning
5395 * because of some signal like SIGWINCH.
5396 * Don't wait if wait_pid was already set above, indicating the
5397 * child already exited.
5398 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005399 if (wait_pid != pid)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01005400 (void)wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401
Bram Moolenaar624891f2010-10-13 16:22:09 +02005402# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005403 // Close slave side of pty. Only do this after the child has
5404 // exited, otherwise the child may hang when it tries to write on
5405 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005406 if (pty_master_fd >= 0)
5407 close(pty_slave_fd);
5408# endif
5409
Bram Moolenaar0f873732019-12-05 20:28:46 +01005410 // Make sure the child that writes to the external program is
5411 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005412 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005413 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005414 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005415 wait4pid(wpid, NULL);
5416 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005417
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005418# ifdef FEAT_JOB_CHANNEL
5419 --dont_check_job_ended;
5420# endif
5421
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 /*
5423 * Set to raw mode right now, otherwise a CTRL-C after
5424 * catch_signals() will kill Vim.
5425 */
5426 if (tmode == TMODE_RAW)
5427 settmode(TMODE_RAW);
5428 did_settmode = TRUE;
5429 set_signals();
5430
5431 if (WIFEXITED(status))
5432 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005433 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005435 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 {
5437 if (retval == EXEC_FAILED)
5438 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005439 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 msg_outtrans(p_sh);
5441 msg_putchar('\n');
5442 }
5443 else if (!(options & SHELL_SILENT))
5444 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005445 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 msg_outnum((long)retval);
5447 msg_putchar('\n');
5448 }
5449 }
5450 }
5451 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005452 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 }
5454 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
5456error:
5457 if (!did_settmode)
5458 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005459 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 resettitle();
Bram Moolenaar13568252018-03-16 20:46:58 +01005461 vim_free(argv);
5462 vim_free(tofree1);
5463 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464
5465 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005466}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005467#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005468
5469 int
5470mch_call_shell(
5471 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005472 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005473{
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005474#ifdef FEAT_EVAL
Bram Moolenaarc9a9a0a2022-04-12 15:09:23 +01005475 ch_log(NULL, "executing shell command: %s", cmd);
5476#endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005477#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
Bram Moolenaar524c8532022-09-27 15:48:20 +01005478 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL
5479 && (options & SHELL_SILENT) == 0)
Bram Moolenaar13568252018-03-16 20:46:58 +01005480 return mch_call_shell_terminal(cmd, options);
5481#endif
5482#ifdef USE_SYSTEM
5483 return mch_call_shell_system(cmd, options);
5484#else
5485 return mch_call_shell_fork(cmd, options);
5486#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487}
5488
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005489#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005490 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005491mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005492{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005493 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005494 int fd_in[2] = {-1, -1}; // for stdin
5495 int fd_out[2] = {-1, -1}; // for stdout
5496 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005497 int pty_master_fd = -1;
5498 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005499 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005500 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5501 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5502 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005503 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005504 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5505 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005506 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005507 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005508 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005509
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005510 if (use_out_for_err && use_null_for_out)
5511 use_null_for_err = TRUE;
5512
Bram Moolenaar0f873732019-12-05 20:28:46 +01005513 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005514 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005515
Bram Moolenaarb2412082017-08-20 18:09:14 +02005516 if (options->jo_pty
5517 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005518 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005519 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005520 open_pty(&pty_master_fd, &pty_slave_fd,
5521 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005522
Bram Moolenaar0f873732019-12-05 20:28:46 +01005523 // TODO: without the channel feature connect the child to /dev/null?
5524 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005525 if (use_file_for_in)
5526 {
5527 char_u *fname = options->jo_io_name[PART_IN];
5528
5529 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5530 if (fd_in[0] < 0)
5531 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005532 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005533 goto failed;
5534 }
5535 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005536 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005537 // When writing buffer lines to the input don't use the pty, so that
5538 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005539 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5540 && pipe(fd_in) < 0)
5541 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005542
5543 if (use_file_for_out)
5544 {
5545 char_u *fname = options->jo_io_name[PART_OUT];
5546
5547 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5548 if (fd_out[1] < 0)
5549 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005550 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005551 goto failed;
5552 }
5553 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005554 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005555 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005556
5557 if (use_file_for_err)
5558 {
5559 char_u *fname = options->jo_io_name[PART_ERR];
5560
5561 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5562 if (fd_err[1] < 0)
5563 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005564 semsg(_(e_cant_open_file_str), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005565 goto failed;
5566 }
5567 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005568 else if (!use_out_for_err && !use_null_for_err
5569 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005570 goto failed;
5571
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005572 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5573 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005574 if (options->jo_set & JO_CHANNEL)
5575 {
5576 channel = options->jo_channel;
5577 if (channel != NULL)
5578 ++channel->ch_refcount;
5579 }
5580 else
5581 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005582 if (channel == NULL)
5583 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005584 if (job->jv_tty_out != NULL)
5585 ch_log(channel, "using pty %s on fd %d",
5586 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005587 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005588
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005589 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005590 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005591 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005592 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005593 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005594 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005595 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005596 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005597 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005598 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005599 int null_fd = -1;
5600 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005601
Bram Moolenaar0f873732019-12-05 20:28:46 +01005602 // child
5603 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005604 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005605
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00005606# ifdef FEAT_EVAL
Bram Moolenaar819524702018-02-27 19:10:00 +01005607 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005608 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005609 ch_logfile((char_u *)"", (char_u *)"");
5610# endif
5611
Bram Moolenaar835dc632016-02-07 14:27:38 +01005612# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005613 // Create our own process group, so that the child and all its
5614 // children can be kill()ed. Don't do this when using pipes,
5615 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005616 (void)setsid();
5617# endif
5618
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005619# ifdef FEAT_TERMINAL
5620 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005621 {
5622 char *term = (char *)T_NAME;
5623
5624#ifdef FEAT_GUI
5625 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005626 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005627 term = getenv("TERM");
5628#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005629 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005630 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005631 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005632 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005633 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005634 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005635 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005636 else if (t_colors > 16)
5637 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005638 else
5639 term = "xterm";
5640 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005641 set_child_environment(
5642 (long)options->jo_term_rows,
5643 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005644 term,
5645 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005646 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005647 else
5648# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005649 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005650
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005651 if (options->jo_env != NULL)
5652 {
5653 dict_T *dict = options->jo_env;
5654 hashitem_T *hi;
5655 int todo = (int)dict->dv_hashtab.ht_used;
5656
5657 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5658 if (!HASHITEM_EMPTY(hi))
5659 {
5660 typval_T *item = &dict_lookup(hi)->di_tv;
5661
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00005662 vim_setenv(hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005663 --todo;
5664 }
5665 }
5666
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005667 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005668 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005669 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005670 if (null_fd < 0)
5671 {
5672 perror("opening /dev/null failed");
5673 _exit(OPEN_NULL_FAILED);
5674 }
5675 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005676
Bram Moolenaar223896d2017-08-02 22:33:28 +02005677 if (pty_slave_fd >= 0)
5678 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005679 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005680 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005681# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005682 // Try to become controlling tty (probably doesn't work,
5683 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005684 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5685# endif
5686 }
5687
Bram Moolenaar0f873732019-12-05 20:28:46 +01005688 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005689 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005690 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005691 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005692 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005693 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005694 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005695 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005696
Bram Moolenaar0f873732019-12-05 20:28:46 +01005697 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005698 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005699 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005700 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005701 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005702 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005703 }
5704 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005705 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005706 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005707 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005708 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005709 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005710
Bram Moolenaar0f873732019-12-05 20:28:46 +01005711 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005712 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005713 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005714 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005715 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005716 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005717 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005718 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005719
5720 if (fd_in[0] >= 0)
5721 close(fd_in[0]);
5722 if (fd_in[1] >= 0)
5723 close(fd_in[1]);
5724 if (fd_out[0] >= 0)
5725 close(fd_out[0]);
5726 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005727 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005728 if (fd_err[0] >= 0)
5729 close(fd_err[0]);
5730 if (fd_err[1] >= 0)
5731 close(fd_err[1]);
5732 if (pty_master_fd >= 0)
5733 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005734 close(pty_master_fd); // not used in the child
5735 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005736 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005737
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005738 if (null_fd >= 0)
5739 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005740
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005741 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5742 _exit(EXEC_FAILED);
5743
Bram Moolenaar0f873732019-12-05 20:28:46 +01005744 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005745 execvp(argv[0], argv);
5746
Bram Moolenaar4694a172016-04-21 14:05:23 +02005747 if (stderr_works)
5748 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005749# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005750 // calling free_all_mem() here causes problems. Ignore valgrind
5751 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005752# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005753 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005754 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005755
Bram Moolenaar0f873732019-12-05 20:28:46 +01005756 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005757 UNBLOCK_SIGNALS(&curset);
5758
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005759 job->jv_pid = pid;
5760 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005761 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005762
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005763 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005764 close(pty_slave_fd); // not used in the parent
5765 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005766 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005767 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005768 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005769 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005770 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005771 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005772 if (channel != NULL)
5773 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005774 int in_fd = INVALID_FD;
5775 int out_fd = INVALID_FD;
5776 int err_fd = INVALID_FD;
5777
5778 if (!(use_file_for_in || use_null_for_in))
5779 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5780
5781 if (!(use_file_for_out || use_null_for_out))
5782 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5783
5784 // When using pty_master_fd only set it for stdout, do not duplicate
5785 // it for stderr, it only needs to be read once.
5786 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5787 {
5788 if (fd_err[0] >= 0)
5789 err_fd = fd_err[0];
5790 else if (out_fd != pty_master_fd)
5791 err_fd = pty_master_fd;
5792 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005793
5794 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005795 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005796 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005797 else
5798 {
5799 if (fd_in[1] >= 0)
5800 close(fd_in[1]);
5801 if (fd_out[0] >= 0)
5802 close(fd_out[0]);
5803 if (fd_err[0] >= 0)
5804 close(fd_err[0]);
5805 if (pty_master_fd >= 0)
5806 close(pty_master_fd);
5807 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005808
Bram Moolenaar0f873732019-12-05 20:28:46 +01005809 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005810 return;
5811
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005812failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005813 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005814 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005815 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005816 if (fd_in[1] >= 0)
5817 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005818 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005819 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005820 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005821 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005822 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005823 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005824 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005825 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005826 if (pty_master_fd >= 0)
5827 close(pty_master_fd);
5828 if (pty_slave_fd >= 0)
5829 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005830}
5831
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005832 static char_u *
5833get_signal_name(int sig)
5834{
5835 int i;
5836 char_u numbuf[NUMBUFLEN];
5837
5838 if (sig == SIGKILL)
5839 return vim_strsave((char_u *)"kill");
5840
5841 for (i = 0; signal_info[i].sig != -1; i++)
5842 if (sig == signal_info[i].sig)
5843 return strlow_save((char_u *)signal_info[i].name);
5844
5845 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5846 return vim_strsave(numbuf);
5847}
5848
Bram Moolenaar835dc632016-02-07 14:27:38 +01005849 char *
5850mch_job_status(job_T *job)
5851{
5852# ifdef HAVE_UNION_WAIT
5853 union wait status;
5854# else
5855 int status = -1;
5856# endif
5857 pid_t wait_pid = 0;
5858
5859# ifdef __NeXT__
5860 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5861# else
5862 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5863# endif
5864 if (wait_pid == -1)
5865 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005866 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005867 if (job->jv_status < JOB_ENDED)
5868 ch_log(job->jv_channel, "Job no longer exists: %s",
5869 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005870 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005871 }
5872 if (wait_pid == 0)
5873 return "run";
5874 if (WIFEXITED(status))
5875 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005876 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005877 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005878 if (job->jv_status < JOB_ENDED)
5879 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005880 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005881 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005882 if (WIFSIGNALED(status))
5883 {
5884 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005885 job->jv_termsig = get_signal_name(WTERMSIG(status));
5886 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5887 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5888 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005889 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005890 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005891 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005892
5893return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005894 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005895 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005896 return "dead";
5897}
5898
5899 job_T *
5900mch_detect_ended_job(job_T *job_list)
5901{
5902# ifdef HAVE_UNION_WAIT
5903 union wait status;
5904# else
5905 int status = -1;
5906# endif
5907 pid_t wait_pid = 0;
5908 job_T *job;
5909
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005910# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005911 // Do not do this when waiting for a shell command to finish, we would get
5912 // the exit value here (and discard it), the exit value obtained there
5913 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005914 if (dont_check_job_ended > 0)
5915 return NULL;
5916# endif
5917
Bram Moolenaar97792de2016-10-15 18:36:49 +02005918# ifdef __NeXT__
5919 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5920# else
5921 wait_pid = waitpid(-1, &status, WNOHANG);
5922# endif
5923 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005924 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005925 return NULL;
5926 for (job = job_list; job != NULL; job = job->jv_next)
5927 {
5928 if (job->jv_pid == wait_pid)
5929 {
5930 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005931 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005932 job->jv_exitval = WEXITSTATUS(status);
5933 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005934 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005935 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005936 job->jv_termsig = get_signal_name(WTERMSIG(status));
5937 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005938 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005939 {
5940 ch_log(job->jv_channel, "Job ended");
5941 job->jv_status = JOB_ENDED;
5942 }
5943 return job;
5944 }
5945 }
5946 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005947}
5948
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005949/*
5950 * Send a (deadly) signal to "job".
5951 * Return FAIL if "how" is not a valid name.
5952 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005953 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005954mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005955{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005956 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005957
Bram Moolenaar923d9262016-02-25 20:56:01 +01005958 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005959 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005960 else if (STRCMP(how, "hup") == 0)
5961 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005962 else if (STRCMP(how, "quit") == 0)
5963 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005964 else if (STRCMP(how, "int") == 0)
5965 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005966 else if (STRCMP(how, "kill") == 0)
5967 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005968#ifdef SIGWINCH
5969 else if (STRCMP(how, "winch") == 0)
5970 sig = SIGWINCH;
5971#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005972 else if (isdigit(*how))
5973 sig = atoi((char *)how);
5974 else
5975 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005976
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005977 // Never kill ourselves!
5978 if (job->jv_pid != 0)
5979 {
5980 // TODO: have an option to only kill the process, not the group?
5981 kill(-job->jv_pid, sig);
5982 kill(job->jv_pid, sig);
5983 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005984
Bram Moolenaar835dc632016-02-07 14:27:38 +01005985 return OK;
5986}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005987
5988/*
5989 * Clear the data related to "job".
5990 */
5991 void
5992mch_clear_job(job_T *job)
5993{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005994 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01005995# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005996 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005997# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005998 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005999# endif
6000}
Bram Moolenaar835dc632016-02-07 14:27:38 +01006001#endif
6002
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006003#if defined(FEAT_TERMINAL) || defined(PROTO)
6004 int
6005mch_create_pty_channel(job_T *job, jobopt_T *options)
6006{
6007 int pty_master_fd = -1;
6008 int pty_slave_fd = -1;
6009 channel_T *channel;
6010
Bram Moolenaar59386482019-02-10 22:43:46 +01006011 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02006012 if (pty_master_fd < 0 || pty_slave_fd < 0)
6013 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006014 close(pty_slave_fd);
6015
6016 channel = add_channel();
6017 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006018 {
6019 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006020 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02006021 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02006022 if (job->jv_tty_out != NULL)
6023 ch_log(channel, "using pty %s on fd %d",
6024 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006025 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006026 channel->ch_keep_open = TRUE;
6027
Bram Moolenaar0f873732019-12-05 20:28:46 +01006028 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
6029 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02006030 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02006031 channel_set_job(channel, job, options);
6032 return OK;
6033}
6034#endif
6035
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036/*
6037 * Check for CTRL-C typed by reading all available characters.
6038 * In cooked mode we should get SIGINT, no need to check.
6039 */
6040 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006041mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042{
Bram Moolenaar26e86442020-05-17 14:06:16 +02006043 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02006044 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 fill_input_buf(FALSE);
6046}
6047
6048/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006049 * Wait "msec" msec until a character is available from the mouse, keyboard,
6050 * from inbuf[].
6051 * "msec" == -1 will block forever.
6052 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006053 * When "ignore_input" is TRUE even check for pending input when input is
6054 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006055 * "interrupted" (if not NULL) is set to TRUE when no character is available
6056 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02006057 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006058 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 */
6060 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006061WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006063#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01006064 return ui_wait_for_chars_or_timer(
6065 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006066#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006067 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006068#endif
6069}
6070
6071/*
6072 * Wait "msec" msec until a character is available from the mouse or keyboard
6073 * or from inbuf[].
6074 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006075 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006076 * "interrupted" (if not NULL) is set to TRUE when no character is available
6077 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006078 * When a GUI is being used, this will never get called -- webb
6079 */
6080 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006081WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006082{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083#ifdef FEAT_MOUSE_GPM
6084 int gpm_process_wanted;
6085#endif
6086#ifdef FEAT_XCLIPBOARD
6087 int rest;
6088#endif
6089 int avail;
6090
Bram Moolenaar0f873732019-12-05 20:28:46 +01006091 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 return 1;
6093
6094#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006095 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 if (WantQueryMouse)
6097 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006098 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006099 if (!no_query_mouse_for_testing)
Bram Moolenaar424bcae2022-01-31 14:59:41 +00006100 mch_write((char_u *)"\033[1'|", 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 }
6102#endif
6103
6104 /*
6105 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6106 * events. This is a bit complicated, because they might both be defined.
6107 */
6108#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6109# ifdef FEAT_XCLIPBOARD
6110 rest = 0;
6111 if (do_xterm_trace())
6112 rest = msec;
6113# endif
6114 do
6115 {
6116# ifdef FEAT_XCLIPBOARD
6117 if (rest != 0)
6118 {
6119 msec = XT_TRACE_DELAY;
6120 if (rest >= 0 && rest < XT_TRACE_DELAY)
6121 msec = rest;
6122 if (rest >= 0)
6123 rest -= msec;
6124 }
6125# endif
Yee Cheng Chin4314e4f2022-10-08 13:50:05 +01006126# ifdef FEAT_SOUND_MACOSX
6127 // Invoke any pending sound callbacks.
6128 process_cfrunloop();
6129# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006130# ifdef FEAT_SOUND_CANBERRA
6131 // Invoke any pending sound callbacks.
6132 if (has_sound_callback_in_queue())
6133 invoke_sound_callback();
6134# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135# ifdef FEAT_MOUSE_GPM
6136 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006137 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006138 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006139 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006141 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006143# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006145 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 return 1;
6147# ifdef FEAT_XCLIPBOARD
6148 if (rest == 0 || !do_xterm_trace())
6149# endif
6150 break;
6151 }
6152 }
6153 while (FALSE
6154# ifdef FEAT_MOUSE_GPM
6155 || (gpm_process_wanted && mch_gpm_process() == 0)
6156# endif
6157# ifdef FEAT_XCLIPBOARD
6158 || (!avail && rest != 0)
6159# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006160 )
6161 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162
6163#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006164 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165#endif
6166 return avail;
6167}
6168
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006169#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170/*
6171 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006172 * "msec" == 0 will check for characters once.
6173 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006176 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006177 * "interrupted" (if not NULL) is set to TRUE when no character is available
6178 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006180 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006181RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182{
6183 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006184 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006185#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 static int busy = FALSE;
6187
Bram Moolenaar0f873732019-12-05 20:28:46 +01006188 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189# define MAY_LOOP
6190
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006191# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006192 // Remember at what time we started, so that we know how much longer we
6193 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006194 long start_msec = msec;
6195 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006197 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006198 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199# endif
6200
Bram Moolenaar0f873732019-12-05 20:28:46 +01006201 // Handle being called recursively. This may happen for the session
6202 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 if (busy)
6204 return 0;
6205#endif
6206
6207#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006208 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209#endif
6210 {
6211#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006212 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006213# ifdef FEAT_MZSCHEME
6214 int mzquantum_used = FALSE;
6215# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216#endif
6217#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006218 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006219 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 int nfd;
6221# ifdef FEAT_XCLIPBOARD
6222 int xterm_idx = -1;
6223# endif
6224# ifdef FEAT_MOUSE_GPM
6225 int gpm_idx = -1;
6226# endif
6227# ifdef USE_XSMP
6228 int xsmp_idx = -1;
6229# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006230 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006232# ifdef FEAT_MZSCHEME
6233 mzvim_check_threads();
6234 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6235 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006236 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006237 mzquantum_used = TRUE;
6238 }
6239# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 fds[0].fd = fd;
6241 fds[0].events = POLLIN;
6242 nfd = 1;
6243
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006245 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 if (xterm_Shell != (Widget)0)
6247 {
6248 xterm_idx = nfd;
6249 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6250 fds[nfd].events = POLLIN;
6251 nfd++;
6252 }
6253# endif
6254# ifdef FEAT_MOUSE_GPM
6255 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6256 {
6257 gpm_idx = nfd;
6258 fds[nfd].fd = gpm_fd;
6259 fds[nfd].events = POLLIN;
6260 nfd++;
6261 }
6262# endif
6263# ifdef USE_XSMP
6264 if (xsmp_icefd != -1)
6265 {
6266 xsmp_idx = nfd;
6267 fds[nfd].fd = xsmp_icefd;
6268 fds[nfd].events = POLLIN;
6269 nfd++;
6270 }
6271# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006272#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006273 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006274#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006275 if (interrupted != NULL)
6276 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006278 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006279
6280 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006281 if (result == 0 && interrupted != NULL && ret > 0)
6282 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006283
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006284# ifdef FEAT_MZSCHEME
6285 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006286 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006287 finished = FALSE;
6288# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290# ifdef FEAT_XCLIPBOARD
6291 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6292 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006293 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006295 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 finished = FALSE;
6297 }
6298# endif
6299# ifdef FEAT_MOUSE_GPM
6300 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302# endif
6303# ifdef USE_XSMP
6304 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6305 {
6306 if (fds[xsmp_idx].revents & POLLIN)
6307 {
6308 busy = TRUE;
6309 xsmp_handle_requests();
6310 busy = FALSE;
6311 }
6312 else if (fds[xsmp_idx].revents & POLLHUP)
6313 {
6314 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006315 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 xsmp_close();
6317 }
6318 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006319 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 }
6321# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006322#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006323 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006324 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006325 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006326#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327
Bram Moolenaar0f873732019-12-05 20:28:46 +01006328#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329
6330 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006331 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006332 // These are static because they can take 8 Kbyte each and cause the
6333 // signal stack to run out with -O3.
6334 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006336 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006338# ifdef FEAT_MZSCHEME
6339 mzvim_check_threads();
6340 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6341 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006342 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006343 mzquantum_used = TRUE;
6344 }
6345# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006347 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006349 tv.tv_sec = towait / 1000;
6350 tv.tv_usec = (towait % 1000) * (1000000/1000);
6351 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006353 else
6354 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355
6356 /*
6357 * Select on ready for reading and exceptional condition (end of file).
6358 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006359select_eintr:
6360 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006361 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 FD_ZERO(&efds);
6363 FD_SET(fd, &rfds);
K.Takatab247e062022-02-07 10:45:23 +00006364# ifndef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006365 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 FD_SET(fd, &efds);
6367# endif
6368 maxfd = fd;
6369
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006371 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 if (xterm_Shell != (Widget)0)
6373 {
6374 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6375 if (maxfd < ConnectionNumber(xterm_dpy))
6376 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006377
Bram Moolenaar0f873732019-12-05 20:28:46 +01006378 // An event may have already been read but not handled. In
6379 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006380 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 }
6382# endif
6383# ifdef FEAT_MOUSE_GPM
6384 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6385 {
6386 FD_SET(gpm_fd, &rfds);
6387 FD_SET(gpm_fd, &efds);
6388 if (maxfd < gpm_fd)
6389 maxfd = gpm_fd;
6390 }
6391# endif
6392# ifdef USE_XSMP
6393 if (xsmp_icefd != -1)
6394 {
6395 FD_SET(xsmp_icefd, &rfds);
6396 FD_SET(xsmp_icefd, &efds);
6397 if (maxfd < xsmp_icefd)
6398 maxfd = xsmp_icefd;
6399 }
6400# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006401# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006402 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006403# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006404 if (interrupted != NULL)
6405 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406
Bram Moolenaar643b6142018-09-12 20:29:09 +02006407 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6408 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006409 result = ret > 0 && FD_ISSET(fd, &rfds);
6410 if (result)
6411 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006412 else if (interrupted != NULL && ret > 0)
6413 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006414
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006415# ifdef EINTR
6416 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006417 {
dbivolaruab16ad32021-12-29 19:41:47 +00006418 // Check whether the EINTR is caused by SIGTSTP
6419 if (got_tstp && !in_mch_suspend)
6420 {
6421 exarg_T ea;
dbivolaru79a6e252022-01-23 16:41:14 +00006422
dbivolaruab16ad32021-12-29 19:41:47 +00006423 ea.forceit = TRUE;
6424 ex_stop(&ea);
6425 got_tstp = FALSE;
6426 }
6427
Bram Moolenaar0f873732019-12-05 20:28:46 +01006428 // Check whether window has been resized, EINTR may be caused by
6429 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006430 if (do_resize)
6431 handle_resize();
6432
Bram Moolenaar0f873732019-12-05 20:28:46 +01006433 // Interrupted by a signal, need to try again. We ignore msec
6434 // here, because we do want to check even after a timeout if
6435 // characters are available. Needed for reading output of an
6436 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006437 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006438 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006439# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006440# ifdef __TANDEM
6441 if (ret == -1 && errno == ENOTSUP)
6442 {
6443 FD_ZERO(&rfds);
6444 FD_ZERO(&efds);
6445 ret = 0;
6446 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006447# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006448# ifdef FEAT_MZSCHEME
6449 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006450 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006451 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452# endif
6453
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454# ifdef FEAT_XCLIPBOARD
6455 if (ret > 0 && xterm_Shell != (Widget)0
6456 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6457 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006458 xterm_update(); // Maybe we should hand out clipboard
6459 // continue looping when we only got the X event and the input
6460 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 if (--ret == 0 && !input_available())
6462 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006463 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 finished = FALSE;
6465 }
6466 }
6467# endif
6468# ifdef FEAT_MOUSE_GPM
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00006469 if (ret > 0 && check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 {
6471 if (FD_ISSET(gpm_fd, &efds))
6472 gpm_close();
6473 else if (FD_ISSET(gpm_fd, &rfds))
6474 *check_for_gpm = 1;
6475 }
6476# endif
6477# ifdef USE_XSMP
6478 if (ret > 0 && xsmp_icefd != -1)
6479 {
6480 if (FD_ISSET(xsmp_icefd, &efds))
6481 {
6482 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006483 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 xsmp_close();
6485 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006486 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 }
6488 else if (FD_ISSET(xsmp_icefd, &rfds))
6489 {
6490 busy = TRUE;
6491 xsmp_handle_requests();
6492 busy = FALSE;
6493 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006494 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 }
6496 }
6497# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006498#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006499 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006500 if (ret >= 0)
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01006501 (void)channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006502#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503
Bram Moolenaar0f873732019-12-05 20:28:46 +01006504#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505
6506#ifdef MAY_LOOP
6507 if (finished || msec == 0)
6508 break;
6509
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006510# ifdef FEAT_CLIENTSERVER
6511 if (server_waiting())
6512 break;
6513# endif
6514
Bram Moolenaar0f873732019-12-05 20:28:46 +01006515 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 if (msec > 0)
6517 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006518# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006519 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006520 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006522 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 msec = msec / 2;
6524# endif
6525 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006526 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 }
6528#endif
6529 }
6530
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006531 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532}
6533
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006535 * Expand a path into all matching files and/or directories. Handles "*",
6536 * "?", "[a-z]", "**", etc.
6537 * "path" has backslashes before chars that are not to be expanded.
6538 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 */
6540 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006541mch_expandpath(
6542 garray_T *gap,
6543 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006544 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545{
Bram Moolenaar02743632005-07-25 20:42:36 +00006546 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548
6549/*
6550 * mch_expand_wildcards() - this code does wild-card pattern matching using
6551 * the shell
6552 *
6553 * return OK for success, FAIL for error (you may lose some memory) and put
6554 * an error message in *file.
6555 *
6556 * num_pat is number of input patterns
6557 * pat is array of pointers to input patterns
6558 * num_file is pointer to number of matched file names
6559 * file is pointer to array of pointers to matched file names
6560 */
6561
6562#ifndef SEEK_SET
6563# define SEEK_SET 0
6564#endif
6565#ifndef SEEK_END
6566# define SEEK_END 2
6567#endif
6568
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006569#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006570
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006572mch_expand_wildcards(
6573 int num_pat,
6574 char_u **pat,
6575 int *num_file,
6576 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006577 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578{
6579 int i;
6580 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006581 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 char_u *p;
6583 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584
Bram Moolenaarc7247912008-01-13 12:54:11 +00006585 /*
6586 * This is the non-OS/2 implementation (really Unix).
6587 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 int j;
6589 char_u *tempname;
6590 char_u *command;
6591 FILE *fd;
6592 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006593#define STYLE_ECHO 0 // use "echo", the default
6594#define STYLE_GLOB 1 // use "glob", for csh
6595#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6596#define STYLE_PRINT 3 // use "print -N", for zsh
6597#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6598 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 int shell_style = STYLE_ECHO;
6600 int check_spaces;
6601 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006602 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006603 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006604 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605
Bram Moolenaar0f873732019-12-05 20:28:46 +01006606 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 *file = NULL;
6608
6609 /*
6610 * If there are no wildcards, just copy the names to allocated memory.
6611 * Saves a lot of time, because we don't have to start a new shell.
6612 */
6613 if (!have_wildcard(num_pat, pat))
6614 return save_patterns(num_pat, pat, num_file, file);
6615
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006616# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006617 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006618 if (sandbox != 0 && check_secure())
6619 return FAIL;
6620# endif
6621
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 /*
6623 * Don't allow the use of backticks in secure and restricted mode.
6624 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006625 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 for (i = 0; i < num_pat; ++i)
6627 if (vim_strchr(pat[i], '`') != NULL
6628 && (check_restricted() || check_secure()))
6629 return FAIL;
6630
6631 /*
6632 * get a name for the temp file
6633 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006634 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006636 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 return FAIL;
6638 }
6639
6640 /*
6641 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006642 * file.
6643 * STYLE_BT: NL separated
6644 * If expanding `cmd` execute it directly.
6645 * STYLE_GLOB: NUL separated
6646 * If we use *csh, "glob" will work better than "echo".
6647 * STYLE_PRINT: NL or NUL separated
6648 * If we use *zsh, "print -N" will work better than "glob".
6649 * STYLE_VIMGLOB: NL separated
6650 * If we use *sh*, we define "vimglob()".
6651 * STYLE_ECHO: space separated.
6652 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 */
6654 if (num_pat == 1 && *pat[0] == '`'
6655 && (len = STRLEN(pat[0])) > 2
6656 && *(pat[0] + len - 1) == '`')
6657 shell_style = STYLE_BT;
6658 else if ((len = STRLEN(p_sh)) >= 3)
6659 {
6660 if (STRCMP(p_sh + len - 3, "csh") == 0)
6661 shell_style = STYLE_GLOB;
6662 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6663 shell_style = STYLE_PRINT;
6664 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006665 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6666 "sh") != NULL)
6667 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668
Bram Moolenaar0f873732019-12-05 20:28:46 +01006669 // Compute the length of the command. We need 2 extra bytes: for the
6670 // optional '&' and for the NUL.
6671 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006673 if (shell_style == STYLE_VIMGLOB)
6674 len += STRLEN(sh_vimglob_func);
6675
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006676 for (i = 0; i < num_pat; ++i)
6677 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006678 // Count the length of the patterns in the same way as they are put in
6679 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006680#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006681 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006682#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006683 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006684 for (j = 0; pat[i][j] != NUL; ++j)
6685 {
6686 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006687 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006688 ++len;
6689 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006690#endif
6691 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 command = alloc(len);
6693 if (command == NULL)
6694 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006695 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 vim_free(tempname);
6697 return FAIL;
6698 }
6699
6700 /*
6701 * Build the shell command:
6702 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6703 * recognizes this).
6704 * - Add the shell command to print the expanded names.
6705 * - Add the temp file name.
6706 * - Add the file name patterns.
6707 */
6708 if (shell_style == STYLE_BT)
6709 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006710 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006711 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006712 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006714 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006715 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006717 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006719 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 *p = ' ';
6721 }
6722 STRCAT(command, ">");
6723 }
6724 else
6725 {
Christian Brabandt8b8d8292021-11-19 12:37:36 +00006726 STRCPY(command, "");
6727 if (shell_style == STYLE_GLOB)
6728 {
6729 // Assume the nonomatch option is valid only for csh like shells,
6730 // otherwise, this may set the positional parameters for the shell,
6731 // e.g. "$*".
6732 if (flags & EW_NOTFOUND)
6733 STRCAT(command, "set nonomatch; ");
6734 else
6735 STRCAT(command, "unset nonomatch; ");
6736 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 if (shell_style == STYLE_GLOB)
6738 STRCAT(command, "glob >");
6739 else if (shell_style == STYLE_PRINT)
6740 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006741 else if (shell_style == STYLE_VIMGLOB)
6742 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 else
6744 STRCAT(command, "echo >");
6745 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006746
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006748
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 if (shell_style != STYLE_BT)
6750 for (i = 0; i < num_pat; ++i)
6751 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006752 // When using system() always add extra quotes, because the shell
6753 // is started twice. Otherwise put a backslash before special
6754 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755#ifdef USE_SYSTEM
6756 STRCAT(command, " \"");
6757 STRCAT(command, pat[i]);
6758 STRCAT(command, "\"");
6759#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006760 int intick = FALSE;
6761
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 p = command + STRLEN(command);
6763 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006764 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006765 {
6766 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006767 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006768 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6769 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006770 // Remove a backslash, take char literally. But keep
6771 // backslash inside backticks, before a special character
6772 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006773 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006774 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6775 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006776 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006777 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006778 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006779 else if (!intick
6780 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6781 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006782 // Put a backslash before a special character, but not
6783 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6784 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006785 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006786
Bram Moolenaar0f873732019-12-05 20:28:46 +01006787 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006788 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006789 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 *p = NUL;
6791#endif
6792 }
6793 if (flags & EW_SILENT)
6794 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006795 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006796 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797
6798 /*
6799 * Using zsh -G: If a pattern has no matches, it is just deleted from
6800 * the argument list, otherwise zsh gives an error message and doesn't
6801 * expand any other pattern.
6802 */
6803 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006804 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805
6806 /*
6807 * If we use -f then shell variables set in .cshrc won't get expanded.
6808 * vi can do it, so we will too, but it is only necessary if there is a "$"
6809 * in one of the patterns, otherwise we can still use the fast option.
6810 */
6811 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006812 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813
6814 /*
6815 * execute the shell command
6816 */
6817 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6818
Bram Moolenaar0f873732019-12-05 20:28:46 +01006819 // When running in the background, give it some time to create the temp
6820 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006821 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02006822 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823
Bram Moolenaar0f873732019-12-05 20:28:46 +01006824 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 show_shell_mess = TRUE;
6826 vim_free(command);
6827
Bram Moolenaar0f873732019-12-05 20:28:46 +01006828 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 {
6830 mch_remove(tempname);
6831 vim_free(tempname);
6832 /*
6833 * With interactive completion, the error message is not printed.
6834 * However with USE_SYSTEM, I don't know how to turn off error messages
6835 * from the shell, so screen may still get messed up -- webb.
6836 */
6837#ifndef USE_SYSTEM
6838 if (!(flags & EW_SILENT))
6839#endif
6840 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006841 redraw_later_clear(); // probably messed up screen
6842 msg_putchar('\n'); // clear bottom line quickly
6843 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844#ifdef USE_SYSTEM
6845 if (!(flags & EW_SILENT))
6846#endif
6847 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006848 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006849 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 }
6851 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006852 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6853 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 if (shell_style == STYLE_BT)
6855 return FAIL;
6856 goto notfound;
6857 }
6858
6859 /*
6860 * read the names from the file into memory
6861 */
6862 fd = fopen((char *)tempname, READBIN);
6863 if (fd == NULL)
6864 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006865 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 if (!(flags & EW_SILENT))
6867 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00006868 msg(_(e_cannot_expand_wildcards));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006869 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 }
6871 vim_free(tempname);
6872 goto notfound;
6873 }
6874 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006875 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006877 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006878 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006879 buffer = NULL;
6880 else
6881 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 if (buffer == NULL)
6883 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006884 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 mch_remove(tempname);
6886 vim_free(tempname);
6887 fclose(fd);
6888 return FAIL;
6889 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006890 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 i = fread((char *)buffer, 1, len, fd);
6892 fclose(fd);
6893 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006894 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006896 // unexpected read error
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006897 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 vim_free(tempname);
6899 vim_free(buffer);
6900 return FAIL;
6901 }
6902 vim_free(tempname);
6903
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006904# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006905 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006907 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6909 *p++ = buffer[i];
6910 len = p - buffer;
6911# endif
6912
6913
Bram Moolenaar0f873732019-12-05 20:28:46 +01006914 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 if (shell_style == STYLE_ECHO)
6916 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006917 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006919 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 {
6921 while (*p != ' ' && *p != '\n')
6922 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006923 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 }
6925 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006926 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006927 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006929 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006931 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 {
6933 while (*p != '\n' && *p != NUL)
6934 ++p;
6935 if (*p != NUL)
6936 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006937 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 }
6939 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006940 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 else
6942 {
6943 /*
6944 * Some versions of zsh use spaces instead of NULs to separate
6945 * results. Only do this when there is no NUL before the end of the
6946 * buffer, otherwise we would never be able to use file names with
6947 * embedded spaces when zsh does use NULs.
6948 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6949 * don't check for spaces again.
6950 */
6951 check_spaces = FALSE;
6952 if (shell_style == STYLE_PRINT && !did_find_nul)
6953 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006954 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006955 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006956 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 did_find_nul = TRUE;
6958 else
6959 check_spaces = TRUE;
6960 }
6961
6962 /*
6963 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6964 * already is one, for STYLE_GLOB it needs to be added.
6965 */
6966 if (len && buffer[len - 1] == NUL)
6967 --len;
6968 else
6969 buffer[len] = NUL;
6970 i = 0;
6971 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006972 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 {
6974 ++i;
6975 *p = NUL;
6976 }
6977 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006978 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 }
6980 if (i == 0)
6981 {
6982 /*
6983 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6984 * /bin/sh will happily expand it to nothing rather than returning an
6985 * error; and hey, it's good to check anyway -- webb.
6986 */
6987 vim_free(buffer);
6988 goto notfound;
6989 }
6990 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006991 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 if (*file == NULL)
6993 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006994 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 vim_free(buffer);
6996 return FAIL;
6997 }
6998
6999 /*
7000 * Isolate the individual file names.
7001 */
7002 p = buffer;
7003 for (i = 0; i < *num_file; ++i)
7004 {
7005 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007006 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00007007 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
7008 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00007010 while (!(shell_style == STYLE_ECHO && *p == ' ')
7011 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007013 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 *p = NUL;
7015 else
7016 {
7017 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007018 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 }
7020 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007021 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007023 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007025 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 }
7027 }
7028
7029 /*
7030 * Move the file names to allocated memory.
7031 */
7032 for (j = 0, i = 0; i < *num_file; ++i)
7033 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007034 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
7036 continue;
7037
Bram Moolenaar0f873732019-12-05 20:28:46 +01007038 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 dir = (mch_isdir((*file)[i]));
7040 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
7041 continue;
7042
Bram Moolenaar0f873732019-12-05 20:28:46 +01007043 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01007044 if (!dir && (flags & EW_EXEC)
7045 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00007046 continue;
7047
Bram Moolenaar964b3742019-05-24 18:54:09 +02007048 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 if (p)
7050 {
7051 STRCPY(p, (*file)[i]);
7052 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007053 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 (*file)[j++] = p;
7055 }
7056 }
7057 vim_free(buffer);
7058 *num_file = j;
7059
Bram Moolenaar0f873732019-12-05 20:28:46 +01007060 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01007062 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 goto notfound;
7064 }
7065
7066 return OK;
7067
7068notfound:
7069 if (flags & EW_NOTFOUND)
7070 return save_patterns(num_pat, pat, num_file, file);
7071 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072}
7073
Bram Moolenaar0f873732019-12-05 20:28:46 +01007074#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007077save_patterns(
7078 int num_pat,
7079 char_u **pat,
7080 int *num_file,
7081 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082{
7083 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00007084 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085
Bram Moolenaarc799fe22019-05-28 23:08:19 +02007086 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 if (*file == NULL)
7088 return FAIL;
7089 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00007090 {
7091 s = vim_strsave(pat[i]);
7092 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007093 // Be compatible with expand_filename(): halve the number of
7094 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007095 backslash_halve(s);
7096 (*file)[i] = s;
7097 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 *num_file = num_pat;
7099 return OK;
7100}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102/*
7103 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7104 * expand.
7105 */
7106 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007107mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007109 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 if (*p == '\\' && p[1] != NUL)
7112 ++p;
7113 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 if (vim_strchr((char_u *)
7115#ifdef VMS
7116 "*?%"
7117#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119#endif
7120 , *p) != NULL)
7121 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 }
7123 return FALSE;
7124}
7125
7126/*
7127 * Return TRUE if the string "p" contains a wildcard.
7128 * Don't recognize '~' at the end as a wildcard.
7129 */
7130 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007131mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007133 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 if (*p == '\\' && p[1] != NUL)
7136 ++p;
7137 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 if (vim_strchr((char_u *)
7139#ifdef VMS
7140 "*?%$"
7141#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143#endif
7144 , *p) != NULL
7145 || (*p == '~' && p[1] != NUL))
7146 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 }
7148 return FALSE;
7149}
7150
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007152have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153{
7154 int i;
7155
7156 for (i = 0; i < num; i++)
7157 if (mch_has_wildcard(file[i]))
7158 return 1;
7159 return 0;
7160}
7161
7162 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007163have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164{
7165 int i;
7166
7167 for (i = 0; i < num; i++)
7168 if (vim_strchr(file[i], '$') != NULL)
7169 return TRUE;
7170 return FALSE;
7171}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007173#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174/*
7175 * Scaled-down version of rename(), which is missing in Xenix.
7176 * This version can only move regular files and will fail if the
7177 * destination exists.
7178 */
7179 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007180mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181{
7182 struct stat st;
7183
Bram Moolenaar0f873732019-12-05 20:28:46 +01007184 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007186 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007188 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 return 0;
7190 return -1;
7191}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007192#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007194#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007195# if defined(DYNAMIC_GPM) || defined(PROTO)
7196/*
7197 * Initialize Gpm's symbols for dynamic linking.
7198 * Must be called only if libgpm_hinst is NULL.
7199 */
7200 static int
7201load_libgpm(void)
7202{
7203 libgpm_hinst = dlopen("libgpm.so", RTLD_LAZY|RTLD_GLOBAL);
7204
7205 if (libgpm_hinst == NULL)
7206 {
7207 if (p_verbose > 0)
7208 smsg_attr(HL_ATTR(HLF_W),
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007209 _("Could not load gpm library: %s"), dlerror());
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007210 return FAIL;
7211 }
7212
7213 if (
7214 (dll_Gpm_Open = dlsym(libgpm_hinst, "Gpm_Open")) == NULL
7215 || (dll_Gpm_Close = dlsym(libgpm_hinst, "Gpm_Close")) == NULL
7216 || (dll_Gpm_GetEvent = dlsym(libgpm_hinst, "Gpm_GetEvent")) == NULL
7217 || (dll_gpm_flag = dlsym(libgpm_hinst, "gpm_flag")) == NULL
7218 || (dll_gpm_fd = dlsym(libgpm_hinst, "gpm_fd")) == NULL
7219 )
7220 {
7221 semsg(_(e_could_not_load_library_str_str), "gpm", dlerror());
7222 dlclose(libgpm_hinst);
7223 libgpm_hinst = NULL;
7224 dll_gpm_flag = NULL;
7225 dll_gpm_fd = NULL;
7226 return FAIL;
7227 }
7228 return OK;
7229}
7230
7231 int
7232gpm_available(void)
7233{
7234 return libgpm_hinst != NULL || load_libgpm() == OK;
7235}
7236# endif // DYNAMIC_GPM
7237
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238/*
7239 * Initializes connection with gpm (if it isn't already opened)
7240 * Return 1 if succeeded (or connection already opened), 0 if failed
7241 */
7242 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007243gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007245 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246
Bram Moolenaar33fc4a62022-02-23 18:07:38 +00007247#ifdef DYNAMIC_GPM
7248 if (!gpm_available())
7249 return 0;
7250#endif
7251
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007252 if (gpm_flag)
7253 return 1; // already open
7254
7255 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7256 gpm_connect.defaultMask = ~GPM_HARD;
7257 // Default handling for mouse move
7258 gpm_connect.minMod = 0; // Handle any modifier keys
7259 gpm_connect.maxMod = 0xffff;
7260 if (Gpm_Open(&gpm_connect, 0) > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 {
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007262 // gpm library tries to handling TSTP causes
7263 // problems. Anyways, we close connection to Gpm whenever
7264 // we are going to suspend or starting an external process
7265 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007266# ifdef SIGTSTP
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007267 signal(SIGTSTP, restricted ? SIG_IGN : (void (*)())sig_tstp);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007268# endif
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007269 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 }
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007271 if (gpm_fd == -2)
7272 Gpm_Close(); // We don't want to talk to xterm via gpm
7273 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274}
7275
7276/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007277 * Returns TRUE if the GPM mouse is enabled.
7278 */
7279 int
7280gpm_enabled(void)
7281{
7282 return gpm_flag && gpm_fd >= 0;
7283}
7284
7285/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 */
7288 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007289gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007291 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 Gpm_Close();
7293}
7294
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007295/*
7296 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007298 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 */
7300 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007301mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302{
7303 int button;
7304 static Gpm_Event gpm_event;
7305 char_u string[6];
7306 int_u vim_modifiers;
7307 int row,col;
7308 unsigned char buttons_mask;
7309 unsigned char gpm_modifiers;
7310 static unsigned char old_buttons = 0;
7311
7312 Gpm_GetEvent(&gpm_event);
7313
7314#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007315 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 if (hold_gui_events)
7317 return 0;
7318#endif
7319
7320 row = gpm_event.y - 1;
7321 col = gpm_event.x - 1;
7322
Bram Moolenaar0f873732019-12-05 20:28:46 +01007323 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 string[1] = 'M';
7325 string[2] = 'G';
7326 switch (GPM_BARE_EVENTS(gpm_event.type))
7327 {
7328 case GPM_DRAG:
7329 string[3] = MOUSE_DRAG;
7330 break;
7331 case GPM_DOWN:
7332 buttons_mask = gpm_event.buttons & ~old_buttons;
7333 old_buttons = gpm_event.buttons;
7334 switch (buttons_mask)
7335 {
7336 case GPM_B_LEFT:
7337 button = MOUSE_LEFT;
7338 break;
7339 case GPM_B_MIDDLE:
7340 button = MOUSE_MIDDLE;
7341 break;
7342 case GPM_B_RIGHT:
7343 button = MOUSE_RIGHT;
7344 break;
7345 default:
7346 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007347 // Don't know what to do. Can more than one button be
7348 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 }
7350 string[3] = (char_u)(button | 0x20);
7351 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7352 break;
7353 case GPM_UP:
7354 string[3] = MOUSE_RELEASE;
7355 old_buttons &= ~gpm_event.buttons;
7356 break;
7357 default:
7358 return 0;
7359 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007360 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 gpm_modifiers = gpm_event.modifiers;
7362 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007363 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7364 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7365 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7367 vim_modifiers |= MOUSE_SHIFT;
7368
7369 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7370 vim_modifiers |= MOUSE_CTRL;
7371 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7372 vim_modifiers |= MOUSE_ALT;
7373 string[3] |= vim_modifiers;
7374 string[4] = (char_u)(col + ' ' + 1);
7375 string[5] = (char_u)(row + ' ' + 1);
7376 add_to_input_buf(string, 6);
7377 return 6;
7378}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007379#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007381#ifdef FEAT_SYSMOUSE
7382/*
7383 * Initialize connection with sysmouse.
7384 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7385 * output, any sysmouse output than will be processed via sig_sysmouse().
7386 * Return OK if succeeded, FAIL if failed.
7387 */
7388 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007389sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007390{
7391 struct mouse_info mouse;
7392
7393 mouse.operation = MOUSE_MODE;
7394 mouse.u.mode.mode = 0;
7395 mouse.u.mode.signal = SIGUSR2;
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00007396 if (ioctl(1, CONS_MOUSECTL, &mouse) == -1)
7397 return FAIL;
7398
7399 signal(SIGUSR2, (void (*)())sig_sysmouse);
7400 mouse.operation = MOUSE_SHOW;
7401 ioctl(1, CONS_MOUSECTL, &mouse);
7402 return OK;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007403}
7404
7405/*
7406 * Stop processing SIGUSR2 signals, and also make sure that
7407 * virtual console do not send us any sysmouse related signal.
7408 */
7409 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007410sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007411{
7412 struct mouse_info mouse;
7413
7414 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7415 mouse.operation = MOUSE_MODE;
7416 mouse.u.mode.mode = 0;
7417 mouse.u.mode.signal = 0;
7418 ioctl(1, CONS_MOUSECTL, &mouse);
7419}
7420
7421/*
7422 * Gets info from sysmouse and adds special keys to input buf.
7423 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01007424 static void
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007425sig_sysmouse SIGDEFARG(sigarg)
7426{
7427 struct mouse_info mouse;
7428 struct video_info video;
7429 char_u string[6];
7430 int row, col;
7431 int button;
7432 int buttons;
7433 static int oldbuttons = 0;
7434
7435#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007436 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007437 if (hold_gui_events)
7438 return;
7439#endif
7440
7441 mouse.operation = MOUSE_GETINFO;
7442 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7443 && ioctl(1, FBIO_MODEINFO, &video) != -1
7444 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7445 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7446 {
7447 row = mouse.u.data.y / video.vi_cheight;
7448 col = mouse.u.data.x / video.vi_cwidth;
7449 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007450 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007451 string[1] = 'M';
7452 string[2] = 'S';
7453 if (oldbuttons == buttons && buttons != 0)
7454 {
7455 button = MOUSE_DRAG;
7456 }
7457 else
7458 {
7459 switch (buttons)
7460 {
7461 case 0:
7462 button = MOUSE_RELEASE;
7463 break;
7464 case 1:
7465 button = MOUSE_LEFT;
7466 break;
7467 case 2:
7468 button = MOUSE_MIDDLE;
7469 break;
7470 case 4:
7471 button = MOUSE_RIGHT;
7472 break;
7473 default:
7474 return;
7475 }
7476 oldbuttons = buttons;
7477 }
7478 string[3] = (char_u)(button);
7479 string[4] = (char_u)(col + ' ' + 1);
7480 string[5] = (char_u)(row + ' ' + 1);
7481 add_to_input_buf(string, 6);
7482 }
7483 return;
7484}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007485#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007486
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007488typedef char_u * (*STRPROCSTR)(char_u *);
7489typedef char_u * (*INTPROCSTR)(int);
7490typedef int (*STRPROCINT)(char_u *);
7491typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492
7493/*
7494 * Call a DLL routine which takes either a string or int param
7495 * and returns an allocated string.
7496 */
7497 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007498mch_libcall(
7499 char_u *libname,
7500 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007501 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007502 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007503 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007504 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505{
7506# if defined(USE_DLOPEN)
7507 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007508 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509# else
7510 shl_t hinstLib;
7511# endif
7512 STRPROCSTR ProcAdd;
7513 INTPROCSTR ProcAddI;
7514 char_u *retval_str = NULL;
7515 int retval_int = 0;
7516 int success = FALSE;
7517
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007518 /*
7519 * Get a handle to the DLL module.
7520 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007522 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007523 (void)dlerror();
7524
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 hinstLib = dlopen((char *)libname, RTLD_LAZY
7526# ifdef RTLD_LOCAL
7527 | RTLD_LOCAL
7528# endif
7529 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007530 if (hinstLib == NULL)
7531 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007532 // "dlerr" must be used before dlclose()
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007533 dlerr = dlerror();
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007534 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007535 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007536 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537# else
7538 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7539# endif
7540
Bram Moolenaar0f873732019-12-05 20:28:46 +01007541 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 if (hinstLib != NULL)
7543 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007544# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 /*
7546 * Catch a crash when calling the library function. For example when
7547 * using a number where a string pointer is expected.
7548 */
7549 mch_startjmp();
7550 if (SETJMP(lc_jump_env) != 0)
7551 {
7552 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007553# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007554 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007555# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 mch_didjmp();
7557 }
7558 else
7559# endif
7560 {
7561 retval_str = NULL;
7562 retval_int = 0;
7563
7564 if (argstring != NULL)
7565 {
7566# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007567 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007568 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569# else
7570 if (shl_findsym(&hinstLib, (const char *)funcname,
7571 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7572 ProcAdd = NULL;
7573# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007574 if ((success = (ProcAdd != NULL
7575# if defined(USE_DLOPEN)
7576 && dlerr == NULL
7577# endif
7578 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 {
7580 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007581 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 else
7583 retval_str = (ProcAdd)(argstring);
7584 }
7585 }
7586 else
7587 {
7588# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007589 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00007590 dlerr = dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591# else
7592 if (shl_findsym(&hinstLib, (const char *)funcname,
7593 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7594 ProcAddI = NULL;
7595# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007596 if ((success = (ProcAddI != NULL
7597# if defined(USE_DLOPEN)
7598 && dlerr == NULL
7599# endif
7600 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 {
7602 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007603 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 else
7605 retval_str = (ProcAddI)(argint);
7606 }
7607 }
7608
Bram Moolenaar0f873732019-12-05 20:28:46 +01007609 // Save the string before we free the library.
7610 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 if (string_result == NULL)
7612 *number_result = retval_int;
7613 else if (retval_str != NULL
7614 && retval_str != (char_u *)1
7615 && retval_str != (char_u *)-1)
7616 *string_result = vim_strsave(retval_str);
7617 }
7618
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007619# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 mch_endjmp();
7621# ifdef SIGHASARG
7622 if (lc_signal != 0)
7623 {
7624 int i;
7625
Bram Moolenaar0f873732019-12-05 20:28:46 +01007626 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 for (i = 0; signal_info[i].sig != -1; i++)
7628 if (lc_signal == signal_info[i].sig)
7629 break;
Bram Moolenaarac78dd42022-01-02 19:25:26 +00007630 semsg(e_got_sig_str_in_libcall, signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 }
7632# endif
7633# endif
7634
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007636 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007637 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007638 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007639
Bram Moolenaar0f873732019-12-05 20:28:46 +01007640 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 (void)dlclose(hinstLib);
7642# else
7643 (void)shl_unload(hinstLib);
7644# endif
7645 }
7646
7647 if (!success)
7648 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00007649 semsg(_(e_library_call_failed_for_str), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 return FAIL;
7651 }
7652
7653 return OK;
7654}
7655#endif
7656
7657#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007658static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659static int xterm_button;
7660
7661/*
7662 * Setup a dummy window for X selections in a terminal.
7663 */
7664 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007665setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666{
7667 int z = 0;
7668 char *strp = "";
7669 Widget AppShell;
7670
7671 if (!x_connect_to_server())
7672 return;
7673
7674 open_app_context();
7675 if (app_context != NULL && xterm_Shell == (Widget)0)
7676 {
7677 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007678# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007680# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007681# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007682 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683
7684 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007685 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686# endif
7687
Bram Moolenaar0f873732019-12-05 20:28:46 +01007688 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 oldhandler = XSetErrorHandler(x_error_check);
7690
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007691# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007692 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7694 mch_startjmp();
7695 if (SETJMP(lc_jump_env) != 0)
7696 {
7697 mch_didjmp();
7698 xterm_dpy = NULL;
7699 }
7700 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007701# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 {
7703 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7704 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007705 if (xterm_dpy != NULL)
7706 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007707# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007709# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 }
7711
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007712# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007713 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007715# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007716 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 (void)XSetErrorHandler(oldhandler);
7718
7719 if (xterm_dpy == NULL)
7720 {
7721 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007722 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 return;
7724 }
7725
Bram Moolenaar0f873732019-12-05 20:28:46 +01007726 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 (void)XSetIOErrorHandler(x_IOerror_handler);
7728
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007729# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007731 {
7732 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007733 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007734 verbose_leave();
7735 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736# endif
7737
Bram Moolenaar0f873732019-12-05 20:28:46 +01007738 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7740 applicationShellWidgetClass, xterm_dpy,
7741 NULL);
7742 if (AppShell == (Widget)0)
7743 return;
7744 xterm_Shell = XtVaCreatePopupShell("VIM",
7745 topLevelShellWidgetClass, AppShell,
7746 XtNmappedWhenManaged, 0,
7747 XtNwidth, 1,
7748 XtNheight, 1,
7749 NULL);
7750 if (xterm_Shell == (Widget)0)
7751 return;
7752
7753 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007754 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 if (x11_display == NULL)
7756 x11_display = xterm_dpy;
7757
7758 XtRealizeWidget(xterm_Shell);
7759 XSync(xterm_dpy, False);
7760 xterm_update();
7761 }
7762 if (xterm_Shell != (Widget)0)
7763 {
7764 clip_init(TRUE);
7765 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7766 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007767 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 if (test_x11_window(xterm_dpy) == FAIL)
7769 x11_window = 0;
7770 if (x11_window != 0)
7771 xterm_trace = 0;
7772 }
7773}
7774
7775 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007776start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777{
7778 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7779 return;
7780 xterm_trace = 1;
7781 xterm_button = button;
7782 do_xterm_trace();
7783}
7784
7785
7786 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007787stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788{
7789 if (xterm_trace < 0)
7790 return;
7791 xterm_trace = 0;
7792}
7793
7794/*
7795 * Query the xterm pointer and generate mouse termcodes if necessary
7796 * return TRUE if dragging is active, else FALSE
7797 */
7798 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007799do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800{
7801 Window root, child;
7802 int root_x, root_y;
7803 int win_x, win_y;
7804 int row, col;
7805 int_u mask_return;
7806 char_u buf[50];
7807 char_u *strp;
7808 long got_hints;
7809 static char_u *mouse_code;
7810 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7811 static int prev_row = 0, prev_col = 0;
7812 static XSizeHints xterm_hints;
7813
7814 if (xterm_trace <= 0)
7815 return FALSE;
7816
7817 if (xterm_trace == 1)
7818 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007819 // Get the hints just before tracking starts. The font size might
7820 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007821 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7822 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 || xterm_hints.width_inc <= 1
7824 || xterm_hints.height_inc <= 1)
7825 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007826 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 return FALSE;
7828 }
7829
Bram Moolenaar0f873732019-12-05 20:28:46 +01007830 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 mouse_code = find_termcode(mouse_name);
7832 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007833 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 xterm_trace = 2;
7835
Bram Moolenaar0f873732019-12-05 20:28:46 +01007836 // Find the offset of the chars, there might be a scrollbar on the
7837 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7839 &win_x, &win_y, &mask_return);
7840 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7841 - (xterm_hints.height_inc / 2);
7842 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7843 xterm_hints.y = 2;
7844 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7845 - (xterm_hints.width_inc / 2);
7846 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7847 xterm_hints.x = 2;
7848 return TRUE;
7849 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007850 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 {
7852 xterm_trace = 0;
7853 return FALSE;
7854 }
7855
7856 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7857 &win_x, &win_y, &mask_return);
7858
7859 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7860 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7861 if (row == prev_row && col == prev_col)
7862 return TRUE;
7863
7864 STRCPY(buf, mouse_code);
7865 strp = buf + STRLEN(buf);
7866 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7867 *strp++ = (char_u)(col + ' ' + 1);
7868 *strp++ = (char_u)(row + ' ' + 1);
7869 *strp = 0;
7870 add_to_input_buf(buf, STRLEN(buf));
7871
7872 prev_row = row;
7873 prev_col = col;
7874 return TRUE;
7875}
7876
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007877# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878/*
7879 * Destroy the display, window and app_context. Required for GTK.
7880 */
7881 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007882clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883{
7884 if (xterm_Shell != (Widget)0)
7885 {
7886 XtDestroyWidget(xterm_Shell);
7887 xterm_Shell = (Widget)0;
7888 }
7889 if (xterm_dpy != NULL)
7890 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007891# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007892 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007894# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895 if (x11_display == xterm_dpy)
7896 x11_display = NULL;
7897 xterm_dpy = NULL;
7898 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007899# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 if (app_context != (XtAppContext)NULL)
7901 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007902 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 XtDestroyApplicationContext(app_context);
7904 app_context = (XtAppContext)NULL;
7905 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007906# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907}
7908# endif
7909
7910/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007911 * Catch up with GUI or X events.
7912 */
7913 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007914clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007915{
7916# ifdef FEAT_GUI
7917 if (gui.in_use)
7918 gui_mch_update();
7919 else
7920# endif
7921 if (xterm_Shell != (Widget)0)
7922 xterm_update();
7923}
7924
7925/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 * Catch up with any queued X events. This may put keyboard input into the
7927 * input buffer, call resize call-backs, trigger timers etc. If there is
7928 * nothing in the X event queue (& no timers pending), then we return
7929 * immediately.
7930 */
7931 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007932xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933{
7934 XEvent event;
7935
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007936 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007938 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007940 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007941 break;
7942
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007943 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007944 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007945 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007946 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007947#ifdef FEAT_CLIENTSERVER
7948 {
7949 XPropertyEvent *e = (XPropertyEvent *)&event;
7950
7951 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007953 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007954 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007956 XtDispatchEvent(&event);
7957 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007958 else
7959 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007960 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007961 XtAppProcessEvent(app_context, mask);
7962 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 }
7964}
7965
7966 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007967clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968{
7969 if (xterm_Shell != (Widget)0)
7970 return clip_x11_own_selection(xterm_Shell, cbd);
7971 return FAIL;
7972}
7973
7974 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007975clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976{
7977 if (xterm_Shell != (Widget)0)
7978 clip_x11_lose_selection(xterm_Shell, cbd);
7979}
7980
7981 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007982clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983{
7984 if (xterm_Shell != (Widget)0)
7985 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7986}
7987
7988 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007989clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990{
7991 clip_x11_set_selection(cbd);
7992}
7993#endif
7994
7995
7996#if defined(USE_XSMP) || defined(PROTO)
7997/*
7998 * Code for X Session Management Protocol.
7999 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000
8001# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002/*
8003 * This is our chance to ask the user if they want to save,
8004 * or abort the logout
8005 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008007xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008{
Bram Moolenaare1004402020-10-24 20:49:43 +02008009 int save_cmod_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 int cancel_shutdown = False;
8011
Bram Moolenaare1004402020-10-24 20:49:43 +02008012 save_cmod_flags = cmdmod.cmod_flags;
8013 cmdmod.cmod_flags |= CMOD_CONFIRM;
Bram Moolenaar027387f2016-01-02 22:25:52 +01008014 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01008015 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 cancel_shutdown = True;
Bram Moolenaare1004402020-10-24 20:49:43 +02008017 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar0f873732019-12-05 20:28:46 +01008018 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 out_flush();
8020
Bram Moolenaar0f873732019-12-05 20:28:46 +01008021 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 SmcInteractDone(smc_conn, cancel_shutdown);
8023
Bram Moolenaar0f873732019-12-05 20:28:46 +01008024 // Finish off
8025 // Only end save-yourself here if we're not cancelling shutdown;
8026 // we'll get a cancelled callback later in which we'll end it.
8027 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 if (!cancel_shutdown)
8029 {
8030 xsmp.save_yourself = False;
8031 SmcSaveYourselfDone(smc_conn, True);
8032 }
8033}
8034# endif
8035
8036/*
8037 * Callback that starts save-yourself.
8038 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008040xsmp_handle_save_yourself(
8041 SmcConn smc_conn,
8042 SmPointer client_data UNUSED,
8043 int save_type UNUSED,
8044 Bool shutdown,
8045 int interact_style UNUSED,
8046 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008048 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 if (xsmp.save_yourself)
8050 SmcSaveYourselfDone(smc_conn, True);
8051 xsmp.save_yourself = True;
8052 xsmp.shutdown = shutdown;
8053
Bram Moolenaar0f873732019-12-05 20:28:46 +01008054 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01008056 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057
8058 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008059 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060
8061# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008062 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01008064 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 SmcInteractRequest(smc_conn, SmDialogError,
8066 xsmp_handle_interaction, client_data);
8067 else
8068# endif
8069 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008070 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 SmcSaveYourselfDone(smc_conn, True);
8072 xsmp.save_yourself = False;
8073 }
8074}
8075
8076
8077/*
8078 * Callback to warn us of imminent death.
8079 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008081xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082{
8083 xsmp_close();
8084
Bram Moolenaar0f873732019-12-05 20:28:46 +01008085 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 getout_preserve_modified(0);
8087}
8088
8089
8090/*
8091 * Callback to tell us that save-yourself has completed.
8092 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008094xsmp_save_complete(
8095 SmcConn smc_conn UNUSED,
8096 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097{
8098 xsmp.save_yourself = False;
8099}
8100
8101
8102/*
8103 * Callback to tell us that an instigated shutdown was cancelled
8104 * (maybe even by us)
8105 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008107xsmp_shutdown_cancelled(
8108 SmcConn smc_conn,
8109 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110{
8111 if (xsmp.save_yourself)
8112 SmcSaveYourselfDone(smc_conn, True);
8113 xsmp.save_yourself = False;
8114 xsmp.shutdown = False;
8115}
8116
8117
8118/*
8119 * Callback to tell us that a new ICE connection has been established.
8120 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01008122xsmp_ice_connection(
8123 IceConn iceConn,
8124 IcePointer clientData UNUSED,
8125 Bool opening,
8126 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127{
Bram Moolenaar0f873732019-12-05 20:28:46 +01008128 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 if (opening)
8130 {
8131 xsmp_icefd = IceConnectionNumber(iceConn);
8132 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
8133 }
8134}
8135
8136
Bram Moolenaar0f873732019-12-05 20:28:46 +01008137// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 int
Bram Moolenaar05540972016-01-30 20:31:25 +01008139xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140{
8141 Bool rep;
8142
8143 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8144 == IceProcessMessagesIOError)
8145 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008146 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008148 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 xsmp_close();
8150 return FAIL;
8151 }
8152 else
8153 return OK;
8154}
8155
8156static int dummy;
8157
Bram Moolenaar0f873732019-12-05 20:28:46 +01008158// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 void
8160xsmp_init(void)
8161{
8162 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 SmcCallbacks smcallbacks;
8164#if 0
8165 SmPropValue smname;
8166 SmProp smnameprop;
8167 SmProp *smprops[1];
8168#endif
8169
8170 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008171 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172
8173 xsmp.save_yourself = xsmp.shutdown = False;
8174
Bram Moolenaar0f873732019-12-05 20:28:46 +01008175 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8177 smcallbacks.save_yourself.client_data = NULL;
8178 smcallbacks.die.callback = xsmp_die;
8179 smcallbacks.die.client_data = NULL;
8180 smcallbacks.save_complete.callback = xsmp_save_complete;
8181 smcallbacks.save_complete.client_data = NULL;
8182 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8183 smcallbacks.shutdown_cancelled.client_data = NULL;
8184
Bram Moolenaar0f873732019-12-05 20:28:46 +01008185 // Set up a watch on ICE connection creations. The "dummy" argument is
8186 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8188 {
8189 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008190 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 return;
8192 }
8193
Bram Moolenaar0f873732019-12-05 20:28:46 +01008194 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 xsmp.smcconn = SmcOpenConnection(
8196 NULL,
8197 NULL,
8198 SmProtoMajor,
8199 SmProtoMinor,
8200 SmcSaveYourselfProcMask | SmcDieProcMask
8201 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8202 &smcallbacks,
8203 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008204 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008205 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 errorstring);
8207 if (xsmp.smcconn == NULL)
8208 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008210 {
Bram Moolenaare1be1182020-10-24 13:30:51 +02008211 char errorreport[132];
8212
8213 // If the message is too long it might not be NUL terminated. Add
8214 // a NUL at the end to make sure we don't go over the end.
8215 errorstring[sizeof(errorstring) - 1] = NUL;
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008216 vim_snprintf(errorreport, sizeof(errorreport),
8217 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008218 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008219 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 return;
8221 }
8222 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8223
8224#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008225 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 smname.value = "vim";
8227 smname.length = 3;
8228 smnameprop.name = "SmProgram";
8229 smnameprop.type = "SmARRAY8";
8230 smnameprop.num_vals = 1;
8231 smnameprop.vals = &smname;
8232
8233 smprops[0] = &smnameprop;
8234 SmcSetProperties(xsmp.smcconn, 1, smprops);
8235#endif
8236}
8237
8238
Bram Moolenaar0f873732019-12-05 20:28:46 +01008239// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008241xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008243 if (xsmp_icefd == -1)
8244 return;
8245
8246 SmcCloseConnection(xsmp.smcconn, 0, NULL);
8247 if (xsmp.clientid != NULL)
8248 free(xsmp.clientid);
8249 xsmp.clientid = NULL;
8250 xsmp_icefd = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008252#endif // USE_XSMP
Paul Ollis65745772022-06-05 16:55:54 +01008253
8254#if defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008255# if defined(HAVE_TIMER_CREATE) || defined(PROTO)
Paul Ollis65745772022-06-05 16:55:54 +01008256/*
8257 * Implement timeout with timer_create() and timer_settime().
8258 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008259static volatile sig_atomic_t timeout_flag = FALSE;
8260static timer_t timer_id;
8261static int timer_created = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008262
8263/*
8264 * Callback for when the timer expires.
8265 */
8266 static void
8267set_flag(union sigval _unused UNUSED)
8268{
8269 timeout_flag = TRUE;
8270}
8271
8272/*
8273 * Stop any active timeout.
8274 */
8275 void
8276stop_timeout(void)
8277{
8278 static struct itimerspec disarm = {{0, 0}, {0, 0}};
8279
8280 if (timer_created)
8281 {
8282 int ret = timer_settime(timer_id, 0, &disarm, NULL);
8283
8284 if (ret < 0)
8285 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8286 }
8287
8288 // Clear the current timeout flag; any previous timeout should be
8289 // considered _not_ triggered.
8290 timeout_flag = FALSE;
8291}
8292
8293/*
8294 * Start the timeout timer.
8295 *
8296 * The return value is a pointer to a flag that is initialised to FALSE. If the
8297 * timeout expires, the flag is set to TRUE. This will only return pointers to
8298 * static memory; i.e. any pointer returned by this function may always be
8299 * safely dereferenced.
8300 *
8301 * This function is not expected to fail, but if it does it will still return a
8302 * valid flag pointer; the flag will remain stuck as FALSE .
8303 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008304 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008305start_timeout(long msec)
8306{
8307 struct itimerspec interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008308 {0, 0}, // Do not repeat.
8309 {msec / 1000, (msec % 1000) * 1000000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008310 int ret;
8311
8312 // This is really the caller's responsibility, but let's make sure the
8313 // previous timer has been stopped.
8314 stop_timeout();
Paul Ollis65745772022-06-05 16:55:54 +01008315
8316 if (!timer_created)
8317 {
8318 struct sigevent action = {0};
8319
8320 action.sigev_notify = SIGEV_THREAD;
8321 action.sigev_notify_function = set_flag;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008322 ret = timer_create(CLOCK_MONOTONIC, &action, &timer_id);
8323 if (ret < 0)
Paul Ollis65745772022-06-05 16:55:54 +01008324 {
8325 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8326 return &timeout_flag;
8327 }
8328 timer_created = TRUE;
8329 }
8330
Bram Moolenaar4c5678f2022-11-30 18:12:19 +00008331# ifdef FEAT_EVAL
Bram Moolenaar616592e2022-06-17 15:17:10 +01008332 ch_log(NULL, "setting timeout timer to %d sec %ld nsec",
8333 (int)interval.it_value.tv_sec, (long)interval.it_value.tv_nsec);
Bram Moolenaar509ce032022-06-20 11:23:01 +01008334# endif
Paul Ollis65745772022-06-05 16:55:54 +01008335 ret = timer_settime(timer_id, 0, &interval, NULL);
8336 if (ret < 0)
8337 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8338
8339 return &timeout_flag;
8340}
8341
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008342/*
8343 * To be used before fork/exec: delete any created timer.
8344 */
8345 void
8346delete_timer(void)
8347{
Yegappan Lakshmanana41e2212023-01-16 18:19:05 +00008348 if (!timer_created)
8349 return;
8350
8351 timer_delete(timer_id);
8352 timer_created = FALSE;
Bram Moolenaarc72e31d2022-06-16 18:47:20 +01008353}
8354
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008355# else // HAVE_TIMER_CREATE
Paul Ollis65745772022-06-05 16:55:54 +01008356
8357/*
8358 * Implement timeout with setitimer()
8359 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008360static struct sigaction prev_sigaction;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008361static volatile sig_atomic_t timeout_flag = FALSE;
8362static int timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008363static int timer_handler_active = FALSE;
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008364static volatile sig_atomic_t alarm_pending = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008365
8366/*
8367 * Handle SIGALRM for a timeout.
8368 */
Bram Moolenaar99c48fe2022-06-05 22:05:19 +01008369 static void
Paul Ollis65745772022-06-05 16:55:54 +01008370set_flag SIGDEFARG(sigarg)
8371{
8372 if (alarm_pending)
8373 alarm_pending = FALSE;
8374 else
8375 timeout_flag = TRUE;
8376}
8377
8378/*
8379 * Stop any active timeout.
8380 */
8381 void
8382stop_timeout(void)
8383{
8384 static struct itimerval disarm = {{0, 0}, {0, 0}};
8385 int ret;
8386
8387 if (timer_active)
8388 {
8389 timer_active = FALSE;
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008390 ret = setitimer(ITIMER_REAL, &disarm, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008391 if (ret < 0)
8392 // Should only get here as a result of coding errors.
8393 semsg(_(e_could_not_clear_timeout_str), strerror(errno));
8394 }
8395
8396 if (timer_handler_active)
8397 {
8398 timer_handler_active = FALSE;
8399 ret = sigaction(SIGALRM, &prev_sigaction, NULL);
8400 if (ret < 0)
8401 // Should only get here as a result of coding errors.
8402 semsg(_(e_could_not_reset_handler_for_timeout_str),
8403 strerror(errno));
8404 }
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008405 timeout_flag = FALSE;
Paul Ollis65745772022-06-05 16:55:54 +01008406}
8407
8408/*
8409 * Start the timeout timer.
8410 *
8411 * The return value is a pointer to a flag that is initialised to FALSE. If the
8412 * timeout expires, the flag is set to TRUE. This will only return pointers to
8413 * static memory; i.e. any pointer returned by this function may always be
8414 * safely dereferenced.
8415 *
8416 * This function is not expected to fail, but if it does it will still return a
8417 * valid flag pointer; the flag will remain stuck as FALSE .
8418 */
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008419 volatile sig_atomic_t *
Paul Ollis65745772022-06-05 16:55:54 +01008420start_timeout(long msec)
8421{
8422 struct itimerval interval = {
Bram Moolenaar88456cd2022-11-18 22:14:09 +00008423 {0, 0}, // Do not repeat.
8424 {msec / 1000, (msec % 1000) * 1000}}; // Timeout interval
Paul Ollis65745772022-06-05 16:55:54 +01008425 struct sigaction handle_alarm;
8426 int ret;
8427 sigset_t sigs;
8428 sigset_t saved_sigs;
8429
8430 // This is really the caller's responsibility, but let's make sure the
8431 // previous timer has been stopped.
8432 stop_timeout();
8433
8434 // There is a small chance that SIGALRM is pending and so the handler must
8435 // ignore it on the first call.
8436 alarm_pending = FALSE;
8437 ret = sigemptyset(&sigs);
8438 ret = ret == 0 ? sigaddset(&sigs, SIGALRM) : ret;
8439 ret = ret == 0 ? sigprocmask(SIG_BLOCK, &sigs, &saved_sigs) : ret;
8440 timeout_flag = FALSE;
8441 ret = ret == 0 ? sigpending(&sigs) : ret;
8442 if (ret == 0)
8443 {
8444 alarm_pending = sigismember(&sigs, SIGALRM);
Bram Moolenaar1f89abf2022-06-06 10:07:01 +01008445 ret = sigprocmask(SIG_SETMASK, &saved_sigs, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008446 }
8447 if (unlikely(ret != 0 || alarm_pending < 0))
8448 {
8449 // Just catching coding errors. Write an error message, but carry on.
8450 semsg(_(e_could_not_check_for_pending_sigalrm_str), strerror(errno));
8451 alarm_pending = FALSE;
8452 }
8453
8454 // Set up the alarm handler first.
8455 ret = sigemptyset(&handle_alarm.sa_mask);
8456 handle_alarm.sa_handler = set_flag;
8457 handle_alarm.sa_flags = 0;
8458 ret = ret == 0 ? sigaction(SIGALRM, &handle_alarm, &prev_sigaction) : ret;
8459 if (ret < 0)
8460 {
8461 // Should only get here as a result of coding errors.
8462 semsg(_(e_could_not_set_handler_for_timeout_str), strerror(errno));
8463 return &timeout_flag;
8464 }
8465 timer_handler_active = TRUE;
8466
8467 // Set up the interval timer once the alarm handler is in place.
Bram Moolenaar155f2d12022-06-20 13:38:33 +01008468 ret = setitimer(ITIMER_REAL, &interval, NULL);
Paul Ollis65745772022-06-05 16:55:54 +01008469 if (ret < 0)
8470 {
8471 // Should only get here as a result of coding errors.
8472 semsg(_(e_could_not_set_timeout_str), strerror(errno));
8473 stop_timeout();
8474 return &timeout_flag;
8475 }
8476
8477 timer_active = TRUE;
8478 return &timeout_flag;
8479}
8480# endif // HAVE_TIMER_CREATE
8481#endif // FEAT_RELTIME