blob: 2afe1ba936e5c3f53a74e46a6db8c31dce04f9c1 [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__
Bram Moolenaar4f974752019-02-17 17:44:42 +010047# ifndef MSWIN
Bram Moolenaar0d1498e2008-06-29 12:00:49 +000048# include <cygwin/version.h>
Bram Moolenaar0f873732019-12-05 20:28:46 +010049# include <sys/cygwin.h> // for cygwin_conv_to_posix_path() and/or
50 // for cygwin_conv_path()
Bram Moolenaar693e40c2013-02-26 14:56:42 +010051# ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
52# define WIN32_LEAN_AND_MEAN
53# include <windows.h>
54# include "winclip.pro"
55# endif
Bram Moolenaara2442432007-04-26 14:26:37 +000056# endif
57#endif
58
Bram Moolenaar071d4272004-06-13 20:20:40 +000059#ifdef FEAT_MOUSE_GPM
60# include <gpm.h>
Bram Moolenaar0f873732019-12-05 20:28:46 +010061// <linux/keyboard.h> contains defines conflicting with "keymap.h",
62// I just copied relevant defines here. A cleaner solution would be to put gpm
63// code into separate file and include there linux/keyboard.h
64// #include <linux/keyboard.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000065# define KG_SHIFT 0
66# define KG_CTRL 2
67# define KG_ALT 3
68# define KG_ALTGR 1
69# define KG_SHIFTL 4
70# define KG_SHIFTR 5
71# define KG_CTRLL 6
72# define KG_CTRLR 7
73# define KG_CAPSSHIFT 8
74
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010075static void gpm_close(void);
76static int gpm_open(void);
77static int mch_gpm_process(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000078#endif
79
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000080#ifdef FEAT_SYSMOUSE
81# include <sys/consio.h>
82# include <sys/fbio.h>
83
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010084static int sysmouse_open(void);
85static void sysmouse_close(void);
Bram Moolenaard99df422016-01-29 23:20:40 +010086static RETSIGTYPE sig_sysmouse SIGPROTOARG;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000087#endif
88
Bram Moolenaar071d4272004-06-13 20:20:40 +000089/*
90 * end of autoconf section. To be extended...
91 */
92
Bram Moolenaar0f873732019-12-05 20:28:46 +010093// Are the following #ifdefs still required? And why? Is that for X11?
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95#if defined(ESIX) || defined(M_UNIX) && !defined(SCO)
96# ifdef SIGWINCH
97# undef SIGWINCH
98# endif
99# ifdef TIOCGWINSZ
100# undef TIOCGWINSZ
101# endif
102#endif
103
Bram Moolenaar0f873732019-12-05 20:28:46 +0100104#if defined(SIGWINDOW) && !defined(SIGWINCH) // hpux 9.01 has it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105# define SIGWINCH SIGWINDOW
106#endif
107
108#ifdef FEAT_X11
109# include <X11/Xlib.h>
110# include <X11/Xutil.h>
111# include <X11/Xatom.h>
112# ifdef FEAT_XCLIPBOARD
113# include <X11/Intrinsic.h>
114# include <X11/Shell.h>
115# include <X11/StringDefs.h>
116static Widget xterm_Shell = (Widget)0;
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100117static void clip_update(void);
118static void xterm_update(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119# endif
120
121# if defined(FEAT_XCLIPBOARD) || defined(FEAT_TITLE)
122Window x11_window = 0;
123# endif
124Display *x11_display = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125#endif
126
Bram Moolenaar5c3128e2020-05-11 20:54:42 +0200127static int ignore_sigtstp = FALSE;
128
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129#ifdef FEAT_TITLE
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100130static int get_x11_title(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131
132static char_u *oldtitle = NULL;
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200133static volatile sig_atomic_t oldtitle_outdated = FALSE;
Bram Moolenaardac13472019-09-16 21:06:21 +0200134static int unix_did_set_title = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135static char_u *oldicon = NULL;
136static int did_set_icon = FALSE;
137#endif
138
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100139static void may_core_dump(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140
Bram Moolenaar205b8862011-09-07 15:04:31 +0200141#ifdef HAVE_UNION_WAIT
142typedef union wait waitstatus;
143#else
144typedef int waitstatus;
145#endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200146static int WaitForChar(long msec, int *interrupted, int ignore_input);
147static int WaitForCharOrMouse(long msec, int *interrupted, int ignore_input);
Bram Moolenaar041c7102020-05-30 18:14:57 +0200148#ifdef VMS
Bram Moolenaarcda77642016-06-04 13:32:35 +0200149int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150#else
Bram Moolenaarcda77642016-06-04 13:32:35 +0200151static int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152#endif
153
154#ifdef FEAT_XCLIPBOARD
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100155static int do_xterm_trace(void);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100156# define XT_TRACE_DELAY 50 // delay for xterm tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157#endif
158
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100159static void handle_resize(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160
161#if defined(SIGWINCH)
Bram Moolenaard99df422016-01-29 23:20:40 +0100162static RETSIGTYPE sig_winch SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163#endif
164#if defined(SIGINT)
Bram Moolenaard99df422016-01-29 23:20:40 +0100165static RETSIGTYPE catch_sigint SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200167#if defined(SIGUSR1)
168static RETSIGTYPE catch_sigusr1 SIGPROTOARG;
169#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170#if defined(SIGPWR)
Bram Moolenaard99df422016-01-29 23:20:40 +0100171static RETSIGTYPE catch_sigpwr SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172#endif
173#if defined(SIGALRM) && defined(FEAT_X11) \
174 && defined(FEAT_TITLE) && !defined(FEAT_GUI_GTK)
175# define SET_SIG_ALARM
Bram Moolenaard99df422016-01-29 23:20:40 +0100176static RETSIGTYPE sig_alarm SIGPROTOARG;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100177// volatile because it is used in signal handler sig_alarm().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200178static volatile sig_atomic_t sig_alarm_called;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179#endif
Bram Moolenaard99df422016-01-29 23:20:40 +0100180static RETSIGTYPE deathtrap SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100182static void catch_int_signal(void);
183static void set_signals(void);
184static void catch_signals(RETSIGTYPE (*func_deadly)(), RETSIGTYPE (*func_other)());
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +0200185#ifdef HAVE_SIGPROCMASK
186# define SIGSET_DECL(set) sigset_t set;
187# define BLOCK_SIGNALS(set) block_signals(set)
188# define UNBLOCK_SIGNALS(set) unblock_signals(set)
189#else
190# define SIGSET_DECL(set)
191# define BLOCK_SIGNALS(set) do { /**/ } while (0)
192# define UNBLOCK_SIGNALS(set) do { /**/ } while (0)
193#endif
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100194static int have_wildcard(int, char_u **);
195static int have_dollars(int, char_u **);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100197static int save_patterns(int num_pat, char_u **pat, int *num_file, char_u ***file);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
199#ifndef SIG_ERR
Bram Moolenaar8f0b2d42009-05-16 14:41:10 +0000200# define SIG_ERR ((RETSIGTYPE (*)())-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201#endif
202
Bram Moolenaar0f873732019-12-05 20:28:46 +0100203// volatile because it is used in signal handler sig_winch().
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200204static volatile sig_atomic_t do_resize = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205static char_u *extra_shell_arg = NULL;
206static int show_shell_mess = TRUE;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100207// volatile because it is used in signal handler deathtrap().
208static volatile sig_atomic_t deadly_signal = 0; // The signal we caught
209// volatile because it is used in signal handler deathtrap().
210static volatile sig_atomic_t in_mch_delay = FALSE; // sleeping in mch_delay()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +0100212#if defined(FEAT_JOB_CHANNEL) && !defined(USE_SYSTEM)
213static int dont_check_job_ended = 0;
214#endif
215
Bram Moolenaar26e86442020-05-17 14:06:16 +0200216// Current terminal mode from mch_settmode(). Can differ from cur_tmode.
217static tmode_T mch_cur_tmode = TMODE_COOK;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218
219#ifdef USE_XSMP
220typedef struct
221{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100222 SmcConn smcconn; // The SM connection ID
223 IceConn iceconn; // The ICE connection ID
224 char *clientid; // The client ID for the current smc session
225 Bool save_yourself; // If we're in the middle of a save_yourself
226 Bool shutdown; // If we're in shutdown mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227} xsmp_config_T;
228
229static xsmp_config_T xsmp;
230#endif
231
232#ifdef SYS_SIGLIST_DECLARED
233/*
234 * I have seen
235 * extern char *_sys_siglist[NSIG];
236 * on Irix, Linux, NetBSD and Solaris. It contains a nice list of strings
237 * that describe the signals. That is nearly what we want here. But
238 * autoconf does only check for sys_siglist (without the underscore), I
239 * do not want to change everything today.... jw.
Bram Moolenaar3f7d0902016-11-12 21:13:42 +0100240 * This is why AC_DECL_SYS_SIGLIST is commented out in configure.ac.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241 */
242#endif
243
244static struct signalinfo
245{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100246 int sig; // Signal number, eg. SIGSEGV etc
247 char *name; // Signal name (not char_u!).
248 char deadly; // Catch as a deadly signal?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249} signal_info[] =
250{
251#ifdef SIGHUP
252 {SIGHUP, "HUP", TRUE},
253#endif
254#ifdef SIGQUIT
255 {SIGQUIT, "QUIT", TRUE},
256#endif
257#ifdef SIGILL
258 {SIGILL, "ILL", TRUE},
259#endif
260#ifdef SIGTRAP
261 {SIGTRAP, "TRAP", TRUE},
262#endif
263#ifdef SIGABRT
264 {SIGABRT, "ABRT", TRUE},
265#endif
266#ifdef SIGEMT
267 {SIGEMT, "EMT", TRUE},
268#endif
269#ifdef SIGFPE
270 {SIGFPE, "FPE", TRUE},
271#endif
272#ifdef SIGBUS
273 {SIGBUS, "BUS", TRUE},
274#endif
Bram Moolenaar75676462013-01-30 14:55:42 +0100275#if defined(SIGSEGV) && !defined(FEAT_MZSCHEME)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100276 // MzScheme uses SEGV in its garbage collector
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 {SIGSEGV, "SEGV", TRUE},
278#endif
279#ifdef SIGSYS
280 {SIGSYS, "SYS", TRUE},
281#endif
282#ifdef SIGALRM
Bram Moolenaar0f873732019-12-05 20:28:46 +0100283 {SIGALRM, "ALRM", FALSE}, // Perl's alarm() can trigger it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284#endif
285#ifdef SIGTERM
286 {SIGTERM, "TERM", TRUE},
287#endif
Bram Moolenaarb292a2a2011-02-09 18:47:40 +0100288#if defined(SIGVTALRM) && !defined(FEAT_RUBY)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000289 {SIGVTALRM, "VTALRM", TRUE},
290#endif
Bram Moolenaar02f07e02008-03-12 12:17:28 +0000291#if defined(SIGPROF) && !defined(FEAT_MZSCHEME) && !defined(WE_ARE_PROFILING)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100292 // MzScheme uses SIGPROF for its own needs; On Linux with profiling
293 // this makes Vim exit. WE_ARE_PROFILING is defined in Makefile.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 {SIGPROF, "PROF", TRUE},
295#endif
296#ifdef SIGXCPU
297 {SIGXCPU, "XCPU", TRUE},
298#endif
299#ifdef SIGXFSZ
300 {SIGXFSZ, "XFSZ", TRUE},
301#endif
302#ifdef SIGUSR1
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200303 {SIGUSR1, "USR1", FALSE},
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000305#if defined(SIGUSR2) && !defined(FEAT_SYSMOUSE)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100306 // Used for sysmouse handling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 {SIGUSR2, "USR2", TRUE},
308#endif
309#ifdef SIGINT
310 {SIGINT, "INT", FALSE},
311#endif
312#ifdef SIGWINCH
313 {SIGWINCH, "WINCH", FALSE},
314#endif
315#ifdef SIGTSTP
316 {SIGTSTP, "TSTP", FALSE},
317#endif
318#ifdef SIGPIPE
319 {SIGPIPE, "PIPE", FALSE},
320#endif
321 {-1, "Unknown!", FALSE}
322};
323
Bram Moolenaar25724922009-07-14 15:38:41 +0000324 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100325mch_chdir(char *path)
Bram Moolenaar25724922009-07-14 15:38:41 +0000326{
327 if (p_verbose >= 5)
328 {
329 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100330 smsg("chdir(%s)", path);
Bram Moolenaar25724922009-07-14 15:38:41 +0000331 verbose_leave();
332 }
333# ifdef VMS
334 return chdir(vms_fixfilename(path));
335# else
336 return chdir(path);
337# endif
338}
339
Bram Moolenaar0f873732019-12-05 20:28:46 +0100340// Why is NeXT excluded here (and not in os_unixx.h)?
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +0100341#if defined(ECHOE) && defined(ICANON) \
342 && (defined(HAVE_TERMIO_H) || defined(HAVE_TERMIOS_H)) \
343 && !defined(__NeXT__)
Bram Moolenaar4f44b882017-08-13 20:06:18 +0200344# define NEW_TTY_SYSTEM
345#endif
346
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000347/*
Bram Moolenaard23a8232018-02-10 18:45:26 +0100348 * Write s[len] to the screen (stdout).
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000349 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100351mch_write(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352{
Bram Moolenaar42335f52018-09-13 15:33:43 +0200353 vim_ignored = (int)write(1, (char *)s, len);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100354 if (p_wd) // Unix is too fast, slow down a bit more
Bram Moolenaar8fdd7212016-03-26 19:41:48 +0100355 RealWaitForChar(read_cmd_fd, p_wd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356}
357
358/*
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100359 * Function passed to inchar_loop() to handle window resizing.
360 * If "check_only" is TRUE: Return whether there was a resize.
361 * If "check_only" is FALSE: Deal with the window resized.
362 */
363 static int
364resize_func(int check_only)
365{
366 if (check_only)
367 return do_resize;
368 while (do_resize)
369 handle_resize();
370 return FALSE;
371}
372
373/*
Bram Moolenaarc2a27c32007-12-01 16:19:33 +0000374 * mch_inchar(): low level input function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375 * Get a characters from the keyboard.
376 * Return the number of characters that are available.
377 * If wtime == 0 do not wait for characters.
378 * If wtime == n wait a short time for characters.
379 * If wtime == -1 wait forever for characters.
380 */
381 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100382mch_inchar(
383 char_u *buf,
384 int maxlen,
Bram Moolenaar0f873732019-12-05 20:28:46 +0100385 long wtime, // don't use "time", MIPS cannot handle it
Bram Moolenaar05540972016-01-30 20:31:25 +0100386 int tb_change_cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387{
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100388 return inchar_loop(buf, maxlen, wtime, tb_change_cnt,
389 WaitForChar, resize_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390}
391
392 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100393handle_resize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394{
395 do_resize = FALSE;
396 shell_resized();
397}
398
399/*
Bram Moolenaar40b1b542016-04-20 20:18:23 +0200400 * Return non-zero if a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401 */
402 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100403mch_char_avail(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404{
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200405 return WaitForChar(0L, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406}
407
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200408#if defined(FEAT_TERMINAL) || defined(PROTO)
409/*
410 * Check for any pending input or messages.
411 */
412 int
413mch_check_messages(void)
414{
415 return WaitForChar(0L, NULL, TRUE);
416}
417#endif
418
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419#if defined(HAVE_TOTAL_MEM) || defined(PROTO)
420# ifdef HAVE_SYS_RESOURCE_H
Bram Moolenaar8f0b2d42009-05-16 14:41:10 +0000421# include <sys/resource.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422# endif
423# if defined(HAVE_SYS_SYSCTL_H) && defined(HAVE_SYSCTL)
424# include <sys/sysctl.h>
425# endif
426# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
427# include <sys/sysinfo.h>
428# endif
Bram Moolenaar362dc332018-03-05 21:59:37 +0100429# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100430# include <mach/mach_host.h>
431# include <mach/mach_port.h>
Bram Moolenaar988615f2018-02-27 17:58:20 +0100432# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433
434/*
Bram Moolenaar914572a2007-05-01 11:37:47 +0000435 * Return total amount of memory available in Kbyte.
436 * Doesn't change when memory has been allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 long_u
Bram Moolenaar05540972016-01-30 20:31:25 +0100439mch_total_mem(int special UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441 long_u mem = 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100442 long_u shiftright = 10; // how much to shift "mem" right for Kbyte
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443
Bram Moolenaar362dc332018-03-05 21:59:37 +0100444# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100445 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100446 // Mac (Darwin) way of getting the amount of RAM available
Bram Moolenaar988615f2018-02-27 17:58:20 +0100447 mach_port_t host = mach_host_self();
448 kern_return_t kret;
449# ifdef HOST_VM_INFO64
450 struct vm_statistics64 vm_stat;
451 natural_t count = HOST_VM_INFO64_COUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452
Bram Moolenaar988615f2018-02-27 17:58:20 +0100453 kret = host_statistics64(host, HOST_VM_INFO64,
454 (host_info64_t)&vm_stat, &count);
455# else
456 struct vm_statistics vm_stat;
457 natural_t count = HOST_VM_INFO_COUNT;
458
459 kret = host_statistics(host, HOST_VM_INFO,
460 (host_info_t)&vm_stat, &count);
461# endif
462 if (kret == KERN_SUCCESS)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100463 // get the amount of user memory by summing each usage
Bram Moolenaar988615f2018-02-27 17:58:20 +0100464 mem = (long_u)(vm_stat.free_count + vm_stat.active_count
465 + vm_stat.inactive_count
466# ifdef MAC_OS_X_VERSION_10_9
467 + vm_stat.compressor_page_count
468# endif
Bram Moolenaar62b7f6a2018-03-22 21:44:07 +0100469 ) * sysconf(_SC_PAGESIZE);
Bram Moolenaar988615f2018-02-27 17:58:20 +0100470 mach_port_deallocate(mach_task_self(), host);
471 }
472# endif
473
474# ifdef HAVE_SYSCTL
475 if (mem == 0)
476 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100477 // BSD way of getting the amount of RAM available.
Bram Moolenaar988615f2018-02-27 17:58:20 +0100478 int mib[2];
479 size_t len = sizeof(long_u);
480# ifdef HW_USERMEM64
481 long_u physmem;
482# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100483 // sysctl() may return 32 bit or 64 bit, accept both
Bram Moolenaar988615f2018-02-27 17:58:20 +0100484 union {
485 int_u u32;
486 long_u u64;
487 } physmem;
488# endif
489
490 mib[0] = CTL_HW;
491# ifdef HW_USERMEM64
492 mib[1] = HW_USERMEM64;
493# else
494 mib[1] = HW_USERMEM;
495# endif
496 if (sysctl(mib, 2, &physmem, &len, NULL, 0) == 0)
497 {
498# ifdef HW_USERMEM64
499 mem = (long_u)physmem;
500# else
501 if (len == sizeof(physmem.u64))
502 mem = (long_u)physmem.u64;
503 else
504 mem = (long_u)physmem.u32;
505# endif
506 }
507 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200508# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200510# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511 if (mem == 0)
512 {
513 struct sysinfo sinfo;
514
Bram Moolenaar0f873732019-12-05 20:28:46 +0100515 // Linux way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516 if (sysinfo(&sinfo) == 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000517 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200518# ifdef HAVE_SYSINFO_MEM_UNIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100519 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000520 while (shiftright > 0 && (sinfo.mem_unit & 1) == 0)
521 {
522 sinfo.mem_unit = sinfo.mem_unit >> 1;
523 --shiftright;
524 }
525 mem = sinfo.totalram * sinfo.mem_unit;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200526# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527 mem = sinfo.totalram;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200528# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000529 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200531# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200533# ifdef HAVE_SYSCONF
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 if (mem == 0)
535 {
536 long pagesize, pagecount;
537
Bram Moolenaar0f873732019-12-05 20:28:46 +0100538 // Solaris way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 pagesize = sysconf(_SC_PAGESIZE);
540 pagecount = sysconf(_SC_PHYS_PAGES);
541 if (pagesize > 0 && pagecount > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000542 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100543 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000544 while (shiftright > 0 && (pagesize & 1) == 0)
545 {
Bram Moolenaar3d27a452007-05-10 17:44:18 +0000546 pagesize = (long_u)pagesize >> 1;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000547 --shiftright;
548 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 mem = (long_u)pagesize * pagecount;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000550 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200552# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
Bram Moolenaar0f873732019-12-05 20:28:46 +0100554 // Return the minimum of the physical memory and the user limit, because
555 // using more than the user limit may cause Vim to be terminated.
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200556# if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557 {
558 struct rlimit rlp;
559
560 if (getrlimit(RLIMIT_DATA, &rlp) == 0
561 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200562# ifdef RLIM_INFINITY
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 && rlp.rlim_cur != RLIM_INFINITY
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200564# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000565 && ((long_u)rlp.rlim_cur >> 10) < (mem >> shiftright)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 )
Bram Moolenaar914572a2007-05-01 11:37:47 +0000567 {
568 mem = (long_u)rlp.rlim_cur;
569 shiftright = 10;
570 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200572# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574 if (mem > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000575 return mem >> shiftright;
576 return (long_u)0x1fffff;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577}
578#endif
579
Bram Moolenaar0981c872020-08-23 14:28:37 +0200580/*
581 * "flags": MCH_DELAY_IGNOREINPUT - don't read input
582 * MCH_DELAY_SETTMODE - use settmode() even for short delays
583 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584 void
Bram Moolenaar0981c872020-08-23 14:28:37 +0200585mch_delay(long msec, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586{
Bram Moolenaar26e86442020-05-17 14:06:16 +0200587 tmode_T old_tmode;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200588 int call_settmode;
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000589#ifdef FEAT_MZSCHEME
Bram Moolenaar0f873732019-12-05 20:28:46 +0100590 long total = msec; // remember original value
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000591#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
Bram Moolenaar0981c872020-08-23 14:28:37 +0200593 if (flags & MCH_DELAY_IGNOREINPUT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100595 // Go to cooked mode without echo, to allow SIGINT interrupting us
596 // here. But we don't want QUIT to kill us (CTRL-\ used in a
597 // shell may produce SIGQUIT).
Bram Moolenaar26e86442020-05-17 14:06:16 +0200598 // Only do this if sleeping for more than half a second.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000599 in_mch_delay = TRUE;
Bram Moolenaar80361a52020-10-05 21:39:25 +0200600 call_settmode = mch_cur_tmode == TMODE_RAW
601 && (msec > 500 || (flags & MCH_DELAY_SETTMODE));
602 if (call_settmode)
603 {
604 old_tmode = mch_cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605 settmode(TMODE_SLEEP);
Bram Moolenaar80361a52020-10-05 21:39:25 +0200606 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607
608 /*
609 * Everybody sleeps in a different way...
610 * Prefer nanosleep(), some versions of usleep() can only sleep up to
611 * one second.
612 */
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000613#ifdef FEAT_MZSCHEME
614 do
615 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100616 // if total is large enough, wait by portions in p_mzq
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000617 if (total > p_mzq)
618 msec = p_mzq;
619 else
620 msec = total;
621 total -= msec;
622#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623#ifdef HAVE_NANOSLEEP
624 {
625 struct timespec ts;
626
627 ts.tv_sec = msec / 1000;
628 ts.tv_nsec = (msec % 1000) * 1000000;
629 (void)nanosleep(&ts, NULL);
630 }
631#else
632# ifdef HAVE_USLEEP
633 while (msec >= 1000)
634 {
635 usleep((unsigned int)(999 * 1000));
636 msec -= 999;
637 }
638 usleep((unsigned int)(msec * 1000));
639# else
640# ifndef HAVE_SELECT
641 poll(NULL, 0, (int)msec);
642# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643 {
644 struct timeval tv;
645
646 tv.tv_sec = msec / 1000;
647 tv.tv_usec = (msec % 1000) * 1000;
Bram Moolenaar0981c872020-08-23 14:28:37 +0200648 // NOTE: Solaris 2.6 has a bug that makes select() hang here. Get
649 // a patch from Sun to fix this. Reported by Gunnar Pedersen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 select(0, NULL, NULL, NULL, &tv);
651 }
Bram Moolenaar0f873732019-12-05 20:28:46 +0100652# endif // HAVE_SELECT
653# endif // HAVE_NANOSLEEP
654#endif // HAVE_USLEEP
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000655#ifdef FEAT_MZSCHEME
656 }
657 while (total > 0);
658#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659
Bram Moolenaar80361a52020-10-05 21:39:25 +0200660 if (call_settmode)
Bram Moolenaar26e86442020-05-17 14:06:16 +0200661 settmode(old_tmode);
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000662 in_mch_delay = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 }
664 else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200665 WaitForChar(msec, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666}
667
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000668#if defined(HAVE_STACK_LIMIT) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 || (!defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGSTACK))
670# define HAVE_CHECK_STACK_GROWTH
671/*
672 * Support for checking for an almost-out-of-stack-space situation.
673 */
674
675/*
676 * Return a pointer to an item on the stack. Used to find out if the stack
677 * grows up or down.
678 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679static int stack_grows_downwards;
680
681/*
682 * Find out if the stack grows upwards or downwards.
683 * "p" points to a variable on the stack of the caller.
684 */
685 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100686check_stack_growth(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687{
688 int i;
689
690 stack_grows_downwards = (p > (char *)&i);
691}
692#endif
693
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000694#if defined(HAVE_STACK_LIMIT) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695static char *stack_limit = NULL;
696
697#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
698# include <pthread.h>
699# include <pthread_np.h>
700#endif
701
702/*
703 * Find out until how var the stack can grow without getting into trouble.
704 * Called when starting up and when switching to the signal stack in
705 * deathtrap().
706 */
707 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100708get_stack_limit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709{
710 struct rlimit rlp;
711 int i;
712 long lim;
713
Bram Moolenaar0f873732019-12-05 20:28:46 +0100714 // Set the stack limit to 15/16 of the allowable size. Skip this when the
715 // limit doesn't fit in a long (rlim_cur might be "long long").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 if (getrlimit(RLIMIT_STACK, &rlp) == 0
717 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
718# ifdef RLIM_INFINITY
719 && rlp.rlim_cur != RLIM_INFINITY
720# endif
721 )
722 {
723 lim = (long)rlp.rlim_cur;
724#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
725 {
726 pthread_attr_t attr;
727 size_t size;
728
Bram Moolenaar0f873732019-12-05 20:28:46 +0100729 // On FreeBSD the initial thread always has a fixed stack size, no
730 // matter what the limits are set to. Normally it's 1 Mbyte.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 pthread_attr_init(&attr);
732 if (pthread_attr_get_np(pthread_self(), &attr) == 0)
733 {
734 pthread_attr_getstacksize(&attr, &size);
735 if (lim > (long)size)
736 lim = (long)size;
737 }
738 pthread_attr_destroy(&attr);
739 }
740#endif
741 if (stack_grows_downwards)
742 {
743 stack_limit = (char *)((long)&i - (lim / 16L * 15L));
744 if (stack_limit >= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100745 // overflow, set to 1/16 of current stack position
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 stack_limit = (char *)((long)&i / 16L);
747 }
748 else
749 {
750 stack_limit = (char *)((long)&i + (lim / 16L * 15L));
751 if (stack_limit <= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100752 stack_limit = NULL; // overflow
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 }
754 }
755}
756
757/*
758 * Return FAIL when running out of stack space.
759 * "p" must point to any variable local to the caller that's on the stack.
760 */
761 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100762mch_stackcheck(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763{
764 if (stack_limit != NULL)
765 {
766 if (stack_grows_downwards)
767 {
768 if (p < stack_limit)
769 return FAIL;
770 }
771 else if (p > stack_limit)
772 return FAIL;
773 }
774 return OK;
775}
776#endif
777
778#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
779/*
780 * Support for using the signal stack.
781 * This helps when we run out of stack space, which causes a SIGSEGV. The
782 * signal handler then must run on another stack, since the normal stack is
783 * completely full.
784 */
785
786#ifndef SIGSTKSZ
Bram Moolenaar0f873732019-12-05 20:28:46 +0100787# define SIGSTKSZ 8000 // just a guess of how much stack is needed...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788#endif
789
790# ifdef HAVE_SIGALTSTACK
Bram Moolenaar0f873732019-12-05 20:28:46 +0100791static stack_t sigstk; // for sigaltstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100793static struct sigstack sigstk; // for sigstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794# endif
795
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796static char *signal_stack;
797
798 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100799init_signal_stack(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800{
801 if (signal_stack != NULL)
802 {
803# ifdef HAVE_SIGALTSTACK
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804# ifdef HAVE_SS_BASE
805 sigstk.ss_base = signal_stack;
806# else
807 sigstk.ss_sp = signal_stack;
808# endif
809 sigstk.ss_size = SIGSTKSZ;
810 sigstk.ss_flags = 0;
811 (void)sigaltstack(&sigstk, NULL);
812# else
813 sigstk.ss_sp = signal_stack;
814 if (stack_grows_downwards)
815 sigstk.ss_sp += SIGSTKSZ - 1;
816 sigstk.ss_onstack = 0;
817 (void)sigstack(&sigstk, NULL);
818# endif
819 }
820}
821#endif
822
823/*
Bram Moolenaar76243bd2009-03-02 01:47:02 +0000824 * We need correct prototypes for a signal function, otherwise mean compilers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 * will barf when the second argument to signal() is ``wrong''.
826 * Let me try it with a few tricky defines from my own osdef.h (jw).
827 */
828#if defined(SIGWINCH)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 static RETSIGTYPE
830sig_winch SIGDEFARG(sigarg)
831{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100832 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 signal(SIGWINCH, (RETSIGTYPE (*)())sig_winch);
834 do_resize = TRUE;
835 SIGRETURN;
836}
837#endif
838
839#if defined(SIGINT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 static RETSIGTYPE
841catch_sigint SIGDEFARG(sigarg)
842{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100843 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 signal(SIGINT, (RETSIGTYPE (*)())catch_sigint);
845 got_int = TRUE;
846 SIGRETURN;
847}
848#endif
849
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200850#if defined(SIGUSR1)
851 static RETSIGTYPE
852catch_sigusr1 SIGDEFARG(sigarg)
853{
854 // this is not required on all systems, but it doesn't hurt anybody
855 signal(SIGUSR1, (RETSIGTYPE (*)())catch_sigusr1);
856 got_sigusr1 = TRUE;
857 SIGRETURN;
858}
859#endif
860
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861#if defined(SIGPWR)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 static RETSIGTYPE
863catch_sigpwr SIGDEFARG(sigarg)
864{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100865 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaard8b0cf12004-12-12 11:33:30 +0000866 signal(SIGPWR, (RETSIGTYPE (*)())catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 /*
868 * I'm not sure we get the SIGPWR signal when the system is really going
869 * down or when the batteries are almost empty. Just preserve the swap
870 * files and don't exit, that can't do any harm.
871 */
872 ml_sync_all(FALSE, FALSE);
873 SIGRETURN;
874}
875#endif
876
877#ifdef SET_SIG_ALARM
878/*
879 * signal function for alarm().
880 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 static RETSIGTYPE
882sig_alarm SIGDEFARG(sigarg)
883{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100884 // doesn't do anything, just to break a system call
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 sig_alarm_called = TRUE;
886 SIGRETURN;
887}
888#endif
889
Bram Moolenaaredce7422019-01-20 18:39:30 +0100890#if (defined(HAVE_SETJMP_H) \
891 && ((defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) \
892 || defined(FEAT_LIBCALL))) \
893 || defined(PROTO)
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100894# define USING_SETJMP 1
Bram Moolenaaredce7422019-01-20 18:39:30 +0100895
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100896// argument to SETJMP()
897static JMP_BUF lc_jump_env;
898
899# ifdef SIGHASARG
Bram Moolenaar32aa1022019-11-02 22:54:41 +0100900// Caught signal number, 0 when no signal was caught; used for mch_libcall().
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100901// Volatile because it is used in signal handlers.
902static volatile sig_atomic_t lc_signal;
903# endif
904
905// TRUE when lc_jump_env is valid.
906// Volatile because it is used in signal handler deathtrap().
907static volatile sig_atomic_t lc_active INIT(= FALSE);
908
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909/*
910 * A simplistic version of setjmp() that only allows one level of using.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100911 * Used to protect areas where we could crash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 * Don't call twice before calling mch_endjmp()!.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100913 *
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 * Usage:
915 * mch_startjmp();
916 * if (SETJMP(lc_jump_env) != 0)
917 * {
918 * mch_didjmp();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100919 * emsg("crash!");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 * }
921 * else
922 * {
923 * do_the_work;
924 * mch_endjmp();
925 * }
926 * Note: Can't move SETJMP() here, because a function calling setjmp() must
927 * not return before the saved environment is used.
928 * Returns OK for normal return, FAIL when the protected code caused a
929 * problem and LONGJMP() was used.
930 */
Bram Moolenaar113e1072019-01-20 15:30:40 +0100931 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100932mch_startjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933{
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100934# ifdef SIGHASARG
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 lc_signal = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100936# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 lc_active = TRUE;
938}
939
Bram Moolenaar113e1072019-01-20 15:30:40 +0100940 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100941mch_endjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942{
943 lc_active = FALSE;
944}
945
Bram Moolenaar113e1072019-01-20 15:30:40 +0100946 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100947mch_didjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948{
949# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100950 // On FreeBSD the signal stack has to be reset after using siglongjmp(),
951 // otherwise catching the signal only works once.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 init_signal_stack();
953# endif
954}
955#endif
956
957/*
958 * This function handles deadly signals.
Bram Moolenaarbec9c202013-09-05 21:41:39 +0200959 * It tries to preserve any swap files and exit properly.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960 * (partly from Elvis).
Bram Moolenaarbec9c202013-09-05 21:41:39 +0200961 * NOTE: Avoid unsafe functions, such as allocating memory, they can result in
962 * a deadlock.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 */
964 static RETSIGTYPE
965deathtrap SIGDEFARG(sigarg)
966{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100967 static int entered = 0; // count the number of times we got here.
968 // Note: when memory has been corrupted
969 // this may get an arbitrary value!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970#ifdef SIGHASARG
971 int i;
972#endif
973
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100974#if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 /*
976 * Catch a crash in protected code.
977 * Restores the environment saved in lc_jump_env, which looks like
978 * SETJMP() returns 1.
979 */
980 if (lc_active)
981 {
982# if defined(SIGHASARG)
983 lc_signal = sigarg;
984# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +0100985 lc_active = FALSE; // don't jump again
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 LONGJMP(lc_jump_env, 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100987 // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 }
989#endif
990
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000991#ifdef SIGHASARG
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000992# ifdef SIGQUIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100993 // While in mch_delay() we go to cooked mode to allow a CTRL-C to
994 // interrupt us. But in cooked mode we may also get SIGQUIT, e.g., when
995 // pressing CTRL-\, but we don't want Vim to exit then.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000996 if (in_mch_delay && sigarg == SIGQUIT)
997 SIGRETURN;
998# endif
999
Bram Moolenaar0f873732019-12-05 20:28:46 +01001000 // When SIGHUP, SIGQUIT, etc. are blocked: postpone the effect and return
1001 // here. This avoids that a non-reentrant function is interrupted, e.g.,
1002 // free(). Calling free() again may then cause a crash.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001003 if (entered == 0
1004 && (0
1005# ifdef SIGHUP
1006 || sigarg == SIGHUP
1007# endif
1008# ifdef SIGQUIT
1009 || sigarg == SIGQUIT
1010# endif
1011# ifdef SIGTERM
1012 || sigarg == SIGTERM
1013# endif
1014# ifdef SIGPWR
1015 || sigarg == SIGPWR
1016# endif
1017# ifdef SIGUSR1
1018 || sigarg == SIGUSR1
1019# endif
1020# ifdef SIGUSR2
1021 || sigarg == SIGUSR2
1022# endif
1023 )
Bram Moolenaar1f28b072005-07-12 22:42:41 +00001024 && !vim_handle_signal(sigarg))
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001025 SIGRETURN;
1026#endif
1027
Bram Moolenaar0f873732019-12-05 20:28:46 +01001028 // Remember how often we have been called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 ++entered;
1030
Bram Moolenaar0f873732019-12-05 20:28:46 +01001031 // Executing autocommands is likely to use more stack space than we have
1032 // available in the signal stack.
Bram Moolenaare429e702016-06-10 19:49:14 +02001033 block_autocmds();
Bram Moolenaare429e702016-06-10 19:49:14 +02001034
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035#ifdef FEAT_EVAL
Bram Moolenaar0f873732019-12-05 20:28:46 +01001036 // Set the v:dying variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 set_vim_var_nr(VV_DYING, (long)entered);
1038#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001039 v_dying = entered;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001041#ifdef HAVE_STACK_LIMIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001042 // Since we are now using the signal stack, need to reset the stack
1043 // limit. Otherwise using a regexp will fail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 get_stack_limit();
1045#endif
1046
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001047#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01001048 // This is for opening gdb the moment Vim crashes.
1049 // You need to manually adjust the file name and Vim executable name.
1050 // Suggested by SungHyun Nam.
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001051 {
1052# define VI_GDB_FILE "/tmp/vimgdb"
1053# define VIM_NAME "/usr/bin/vim"
1054 FILE *fp = fopen(VI_GDB_FILE, "w");
1055 if (fp)
1056 {
1057 fprintf(fp,
1058 "file %s\n"
1059 "attach %d\n"
1060 "set height 1000\n"
1061 "bt full\n"
1062 , VIM_NAME, getpid());
1063 fclose(fp);
1064 system("xterm -e gdb -x "VI_GDB_FILE);
1065 unlink(VI_GDB_FILE);
1066 }
1067 }
1068#endif
1069
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070#ifdef SIGHASARG
Bram Moolenaar0f873732019-12-05 20:28:46 +01001071 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 for (i = 0; signal_info[i].sig != -1; i++)
1073 if (sigarg == signal_info[i].sig)
1074 break;
1075 deadly_signal = sigarg;
1076#endif
1077
Bram Moolenaar0f873732019-12-05 20:28:46 +01001078 full_screen = FALSE; // don't write message to the GUI, it might be
1079 // part of the problem...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 /*
1081 * If something goes wrong after entering here, we may get here again.
1082 * When this happens, give a message and try to exit nicely (resetting the
1083 * terminal mode, etc.)
1084 * When this happens twice, just exit, don't even try to give a message,
1085 * stack may be corrupt or something weird.
1086 * When this still happens again (or memory was corrupted in such a way
1087 * that "entered" was clobbered) use _exit(), don't try freeing resources.
1088 */
1089 if (entered >= 3)
1090 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001091 reset_signals(); // don't catch any signals anymore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 may_core_dump();
1093 if (entered >= 4)
1094 _exit(8);
1095 exit(7);
1096 }
1097 if (entered == 2)
1098 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001099 // No translation, it may call malloc().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001100 OUT_STR("Vim: Double signal, exiting\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 out_flush();
1102 getout(1);
1103 }
1104
Bram Moolenaar0f873732019-12-05 20:28:46 +01001105 // No translation, it may call malloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106#ifdef SIGHASARG
Bram Moolenaar69212b12020-05-10 14:14:03 +02001107 sprintf((char *)IObuff, "Vim: Caught deadly signal %s\r\n",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 signal_info[i].name);
1109#else
Bram Moolenaar69212b12020-05-10 14:14:03 +02001110 sprintf((char *)IObuff, "Vim: Caught deadly signal\r\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111#endif
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001112
Bram Moolenaar0f873732019-12-05 20:28:46 +01001113 // Preserve files and exit. This sets the really_exiting flag to prevent
1114 // calling free().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001115 preserve_exit();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
Bram Moolenaar0f873732019-12-05 20:28:46 +01001117 // NOTREACHED
Bram Moolenaare429e702016-06-10 19:49:14 +02001118
Bram Moolenaar009b2592004-10-24 19:18:58 +00001119#ifdef NBDEBUG
1120 reset_signals();
1121 may_core_dump();
1122 abort();
1123#endif
1124
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 SIGRETURN;
1126}
1127
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02001129 * Invoked after receiving SIGCONT. We don't know what happened while
1130 * sleeping, deal with part of that.
1131 */
1132 static void
1133after_sigcont(void)
1134{
1135# ifdef FEAT_TITLE
1136 // Don't change "oldtitle" in a signal handler, set a flag to obtain it
1137 // again later.
1138 oldtitle_outdated = TRUE;
1139# endif
1140 settmode(TMODE_RAW);
1141 need_check_timestamps = TRUE;
1142 did_check_timestamps = FALSE;
1143}
1144
1145#if defined(SIGCONT)
1146static RETSIGTYPE sigcont_handler SIGPROTOARG;
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001147static volatile sig_atomic_t in_mch_suspend = FALSE;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001148
1149/*
1150 * With multi-threading, suspending might not work immediately. Catch the
1151 * SIGCONT signal, which will be used as an indication whether the suspending
1152 * has been done or not.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001153 *
1154 * On Linux, signal is not always handled immediately either.
1155 * See https://bugs.launchpad.net/bugs/291373
Bram Moolenaar2e310482018-08-21 13:09:10 +02001156 * Probably because the signal is handled in another thread.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001157 *
Bram Moolenaarb292a2a2011-02-09 18:47:40 +01001158 * volatile because it is used in signal handler sigcont_handler().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 */
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001160static volatile sig_atomic_t sigcont_received;
Bram Moolenaarf1883472018-08-20 21:58:57 +02001161static RETSIGTYPE sigcont_handler SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163/*
1164 * signal handler for SIGCONT
1165 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166 static RETSIGTYPE
1167sigcont_handler SIGDEFARG(sigarg)
1168{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001169 if (in_mch_suspend)
1170 {
1171 sigcont_received = TRUE;
1172 }
1173 else
1174 {
1175 // We didn't suspend ourselves, assume we were stopped by a SIGSTOP
1176 // signal (which can't be intercepted) and get a SIGCONT. Need to get
1177 // back to a sane mode. We should redraw, but we can't really do that
1178 // in a signal handler, do a redraw later.
1179 after_sigcont();
1180 redraw_later(CLEAR);
1181 cursor_on_force();
1182 out_flush();
1183 }
1184
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 SIGRETURN;
1186}
1187#endif
1188
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02001189#if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001190# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001191static void *clip_star_save = NULL;
1192static void *clip_plus_save = NULL;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001193# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001194
1195/*
1196 * Called when Vim is going to sleep or execute a shell command.
1197 * We can't respond to requests for the X selections. Lose them, otherwise
1198 * other applications will hang. But first copy the text to cut buffer 0.
1199 */
1200 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001201loose_clipboard(void)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001202{
1203 if (clip_star.owned || clip_plus.owned)
1204 {
1205 x11_export_final_selection();
1206 if (clip_star.owned)
1207 clip_lose_selection(&clip_star);
1208 if (clip_plus.owned)
1209 clip_lose_selection(&clip_plus);
1210 if (x11_display != NULL)
1211 XFlush(x11_display);
1212 }
1213}
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001214
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001215# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001216/*
1217 * Save clipboard text to restore later.
1218 */
1219 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001220save_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001221{
1222 if (clip_star.owned)
1223 clip_star_save = get_register('*', TRUE);
1224 if (clip_plus.owned)
1225 clip_plus_save = get_register('+', TRUE);
1226}
1227
1228/*
1229 * Restore clipboard text if no one own the X selection.
1230 */
1231 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001232restore_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001233{
1234 if (clip_star_save != NULL)
1235 {
1236 if (!clip_gen_owner_exists(&clip_star))
1237 put_register('*', clip_star_save);
1238 else
1239 free_register(clip_star_save);
1240 clip_star_save = NULL;
1241 }
1242 if (clip_plus_save != NULL)
1243 {
1244 if (!clip_gen_owner_exists(&clip_plus))
1245 put_register('+', clip_plus_save);
1246 else
1247 free_register(clip_plus_save);
1248 clip_plus_save = NULL;
1249 }
1250}
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001251# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001252#endif
1253
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254/*
1255 * If the machine has job control, use it to suspend the program,
1256 * otherwise fake it by starting a new shell.
1257 */
1258 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001259mch_suspend(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260{
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001261 if (ignore_sigtstp)
1262 return;
1263
Bram Moolenaar041c7102020-05-30 18:14:57 +02001264#if defined(SIGTSTP)
Bram Moolenaar2e310482018-08-21 13:09:10 +02001265 in_mch_suspend = TRUE;
1266
Bram Moolenaar0f873732019-12-05 20:28:46 +01001267 out_flush(); // needed to make cursor visible on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 settmode(TMODE_COOK);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001269 out_flush(); // needed to disable mouse on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
1271# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001272 loose_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001274# if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 sigcont_received = FALSE;
1276# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001277
Bram Moolenaar0f873732019-12-05 20:28:46 +01001278 kill(0, SIGTSTP); // send ourselves a STOP signal
Bram Moolenaar2e310482018-08-21 13:09:10 +02001279
1280# if defined(SIGCONT)
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001281 /*
1282 * Wait for the SIGCONT signal to be handled. It generally happens
Bram Moolenaar2e310482018-08-21 13:09:10 +02001283 * immediately, but somehow not all the time, probably because it's handled
1284 * in another thread. Do not call pause() because there would be race
1285 * condition which would hang Vim if signal happened in between the test of
1286 * sigcont_received and the call to pause(). If signal is not yet received,
1287 * sleep 0, 1, 2, 3 ms. Don't bother waiting further if signal is not
1288 * received after 1+2+3 ms (not expected to happen).
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001289 */
1290 {
Bram Moolenaar262735e2009-07-14 10:20:22 +00001291 long wait_time;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001292
Bram Moolenaar262735e2009-07-14 10:20:22 +00001293 for (wait_time = 0; !sigcont_received && wait_time <= 3L; wait_time++)
Bram Moolenaar0981c872020-08-23 14:28:37 +02001294 mch_delay(wait_time, 0);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001295 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001297 in_mch_suspend = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298
Bram Moolenaar2e310482018-08-21 13:09:10 +02001299 after_sigcont();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300#else
1301 suspend_shell();
1302#endif
1303}
1304
1305 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001306mch_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307{
1308 Columns = 80;
1309 Rows = 24;
1310
1311 out_flush();
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001312
1313#ifdef SIGTSTP
1314 // Check whether we were invoked with SIGTSTP set to be ignored. If it is
1315 // that indicates the shell (or program) that launched us does not support
1316 // tty job control and thus we should ignore that signal. If invoked as a
1317 // restricted editor (e.g., as "rvim") SIGTSTP is always ignored.
1318 ignore_sigtstp = restricted || SIG_IGN == signal(SIGTSTP, SIG_ERR);
1319#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 set_signals();
Bram Moolenaardf177f62005-02-22 08:39:57 +00001321
Bram Moolenaar56718732006-03-15 22:53:57 +00001322#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001323 mac_conv_init();
1324#endif
Bram Moolenaar693e40c2013-02-26 14:56:42 +01001325#ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
1326 win_clip_init();
1327#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328}
1329
1330 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001331set_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332{
1333#if defined(SIGWINCH)
1334 /*
1335 * WINDOW CHANGE signal is handled with sig_winch().
1336 */
1337 signal(SIGWINCH, (RETSIGTYPE (*)())sig_winch);
1338#endif
1339
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340#ifdef SIGTSTP
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001341 // See mch_init() for the conditions under which we ignore SIGTSTP.
1342 signal(SIGTSTP, ignore_sigtstp ? SIG_IGN : SIG_DFL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343#endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001344#if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 signal(SIGCONT, sigcont_handler);
1346#endif
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001347#ifdef SIGPIPE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 /*
1349 * We want to ignore breaking of PIPEs.
1350 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 signal(SIGPIPE, SIG_IGN);
1352#endif
1353
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354#ifdef SIGINT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001355 catch_int_signal();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356#endif
1357
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001358#ifdef SIGUSR1
1359 /*
1360 * Call user's handler on SIGUSR1
1361 */
1362 signal(SIGUSR1, (RETSIGTYPE (*)())catch_sigusr1);
1363#endif
1364
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 /*
1366 * Ignore alarm signals (Perl's alarm() generates it).
1367 */
1368#ifdef SIGALRM
1369 signal(SIGALRM, SIG_IGN);
1370#endif
1371
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001372#ifdef SIGPWR
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373 /*
1374 * Catch SIGPWR (power failure?) to preserve the swap files, so that no
1375 * work will be lost.
1376 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 signal(SIGPWR, (RETSIGTYPE (*)())catch_sigpwr);
1378#endif
1379
1380 /*
1381 * Arrange for other signals to gracefully shutdown Vim.
1382 */
1383 catch_signals(deathtrap, SIG_ERR);
1384
1385#if defined(FEAT_GUI) && defined(SIGHUP)
1386 /*
1387 * When the GUI is running, ignore the hangup signal.
1388 */
1389 if (gui.in_use)
1390 signal(SIGHUP, SIG_IGN);
1391#endif
1392}
1393
Bram Moolenaardf177f62005-02-22 08:39:57 +00001394#if defined(SIGINT) || defined(PROTO)
1395/*
1396 * Catch CTRL-C (only works while in Cooked mode).
1397 */
1398 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001399catch_int_signal(void)
Bram Moolenaardf177f62005-02-22 08:39:57 +00001400{
1401 signal(SIGINT, (RETSIGTYPE (*)())catch_sigint);
1402}
1403#endif
1404
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001406reset_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407{
1408 catch_signals(SIG_DFL, SIG_DFL);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001409#if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001410 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 signal(SIGCONT, SIG_DFL);
1412#endif
1413}
1414
1415 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001416catch_signals(
1417 RETSIGTYPE (*func_deadly)(),
1418 RETSIGTYPE (*func_other)())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419{
1420 int i;
1421
1422 for (i = 0; signal_info[i].sig != -1; i++)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001423 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 if (signal_info[i].deadly)
1425 {
1426#if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION)
1427 struct sigaction sa;
1428
Bram Moolenaar0f873732019-12-05 20:28:46 +01001429 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 sa.sa_handler = func_deadly;
1431 sigemptyset(&sa.sa_mask);
1432# if defined(__linux__) && defined(_REENTRANT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001433 // On Linux, with glibc compiled for kernel 2.2, there is a bug in
1434 // thread handling in combination with using the alternate stack:
1435 // pthread library functions try to use the stack pointer to
1436 // identify the current thread, causing a SEGV signal, which
1437 // recursively calls deathtrap() and hangs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 sa.sa_flags = 0;
1439# else
1440 sa.sa_flags = SA_ONSTACK;
1441# endif
1442 sigaction(signal_info[i].sig, &sa, NULL);
1443#else
1444# if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGVEC)
1445 struct sigvec sv;
1446
Bram Moolenaar0f873732019-12-05 20:28:46 +01001447 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 sv.sv_handler = func_deadly;
1449 sv.sv_mask = 0;
1450 sv.sv_flags = SV_ONSTACK;
1451 sigvec(signal_info[i].sig, &sv, NULL);
1452# else
1453 signal(signal_info[i].sig, func_deadly);
1454# endif
1455#endif
1456 }
1457 else if (func_other != SIG_ERR)
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001458 {
1459 // Deal with non-deadly signals.
1460#ifdef SIGTSTP
1461 signal(signal_info[i].sig,
1462 signal_info[i].sig == SIGTSTP && ignore_sigtstp
1463 ? SIG_IGN : func_other);
1464#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 signal(signal_info[i].sig, func_other);
Bram Moolenaar5c3128e2020-05-11 20:54:42 +02001466#endif
1467 }
1468 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469}
1470
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001471#ifdef HAVE_SIGPROCMASK
1472 static void
1473block_signals(sigset_t *set)
1474{
1475 sigset_t newset;
1476 int i;
1477
1478 sigemptyset(&newset);
1479
1480 for (i = 0; signal_info[i].sig != -1; i++)
1481 sigaddset(&newset, signal_info[i].sig);
1482
Bram Moolenaar2e310482018-08-21 13:09:10 +02001483# if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001484 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001485 sigaddset(&newset, SIGCONT);
1486# endif
1487
1488 sigprocmask(SIG_BLOCK, &newset, set);
1489}
1490
1491 static void
1492unblock_signals(sigset_t *set)
1493{
1494 sigprocmask(SIG_SETMASK, set, NULL);
1495}
1496#endif
1497
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498/*
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001499 * Handling of SIGHUP, SIGQUIT and SIGTERM:
Bram Moolenaar9e1d2832007-05-06 12:51:41 +00001500 * "when" == a signal: when busy, postpone and return FALSE, otherwise
1501 * return TRUE
1502 * "when" == SIGNAL_BLOCK: Going to be busy, block signals
1503 * "when" == SIGNAL_UNBLOCK: Going to wait, unblock signals, use postponed
Bram Moolenaar67c53842010-05-22 18:28:27 +02001504 * signal
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001505 * Returns TRUE when Vim should exit.
1506 */
1507 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001508vim_handle_signal(int sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001509{
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001510 static int got_signal = 0;
1511 static int blocked = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001512
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001513 switch (sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001514 {
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001515 case SIGNAL_BLOCK: blocked = TRUE;
1516 break;
1517
1518 case SIGNAL_UNBLOCK: blocked = FALSE;
1519 if (got_signal != 0)
1520 {
1521 kill(getpid(), got_signal);
1522 got_signal = 0;
1523 }
1524 break;
1525
1526 default: if (!blocked)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001527 return TRUE; // exit!
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001528 got_signal = sig;
1529#ifdef SIGPWR
1530 if (sig != SIGPWR)
1531#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001532 got_int = TRUE; // break any loops
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001533 break;
1534 }
1535 return FALSE;
1536}
1537
1538/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 * Check_win checks whether we have an interactive stdout.
1540 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001542mch_check_win(int argc UNUSED, char **argv UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 if (isatty(1))
1545 return OK;
1546 return FAIL;
1547}
1548
1549/*
1550 * Return TRUE if the input comes from a terminal, FALSE otherwise.
1551 */
1552 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001553mch_input_isatty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554{
1555 if (isatty(read_cmd_fd))
1556 return TRUE;
1557 return FALSE;
1558}
1559
1560#ifdef FEAT_X11
1561
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001562# if defined(ELAPSED_TIMEVAL) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 && (defined(FEAT_XCLIPBOARD) || defined(FEAT_TITLE))
1564
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565/*
1566 * Give a message about the elapsed time for opening the X window.
1567 */
1568 static void
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001569xopen_message(long elapsed_msec)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001571 smsg(_("Opening the X display took %ld msec"), elapsed_msec);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572}
1573# endif
1574#endif
1575
1576#if defined(FEAT_X11) && (defined(FEAT_TITLE) || defined(FEAT_XCLIPBOARD))
1577/*
1578 * A few functions shared by X11 title and clipboard code.
1579 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580
1581static int got_x_error = FALSE;
1582
1583/*
1584 * X Error handler, otherwise X just exits! (very rude) -- webb
1585 */
1586 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001587x_error_handler(Display *dpy, XErrorEvent *error_event)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588{
Bram Moolenaar843ee412004-06-30 16:16:41 +00001589 XGetErrorText(dpy, error_event->error_code, (char *)IObuff, IOSIZE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 STRCAT(IObuff, _("\nVim: Got X error\n"));
1591
Bram Moolenaarb1062eb2020-05-09 16:11:33 +02001592 // In the GUI we cannot print a message and continue, because no X calls
1593 // are allowed here (causes my system to hang). Silently continuing seems
1594 // like the best alternative. Do preserve files, in case we crash.
1595 ml_sync_all(FALSE, FALSE);
1596
1597#ifdef FEAT_GUI
1598 if (!gui.in_use)
1599#endif
1600 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601
Bram Moolenaar0f873732019-12-05 20:28:46 +01001602 return 0; // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603}
1604
1605/*
1606 * Another X Error handler, just used to check for errors.
1607 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001609x_error_check(Display *dpy UNUSED, XErrorEvent *error_event UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610{
1611 got_x_error = TRUE;
1612 return 0;
1613}
1614
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001615/*
1616 * Return TRUE when connection to the X server is desired.
1617 */
1618 static int
1619x_connect_to_server(void)
1620{
1621 // No point in connecting if we are exiting or dying.
1622 if (exiting || v_dying)
1623 return FALSE;
1624
1625#if defined(FEAT_CLIENTSERVER)
1626 if (x_force_connect)
1627 return TRUE;
1628#endif
1629 if (x_no_connect)
1630 return FALSE;
1631
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001632 // Check for a match with "exclude:" from 'clipboard'.
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001633 if (clip_exclude_prog != NULL)
1634 {
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001635 // Just in case we get called recursively, return FALSE. This could
1636 // happen if vpeekc() is used while executing the prog and it causes a
1637 // related callback to be invoked.
1638 if (regprog_in_use(clip_exclude_prog))
1639 return FALSE;
1640
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001641 if (vim_regexec_prog(&clip_exclude_prog, FALSE, T_NAME, (colnr_T)0))
1642 return FALSE;
1643 }
1644 return TRUE;
1645}
1646
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001648# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649/*
1650 * An X IO Error handler, used to catch error while opening the display.
1651 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001653x_IOerror_check(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001655 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 LONGJMP(lc_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001657# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001658 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001659# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660}
1661# endif
1662
1663/*
1664 * An X IO Error handler, used to catch terminal errors.
1665 */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001666static int xterm_dpy_retry_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001669x_IOerror_handler(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670{
1671 xterm_dpy = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001672 xterm_dpy_retry_count = 5; // Try reconnecting five times
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 x11_window = 0;
1674 x11_display = NULL;
1675 xterm_Shell = (Widget)0;
1676
Bram Moolenaar0f873732019-12-05 20:28:46 +01001677 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 LONGJMP(x_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001679# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001680 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001681# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682}
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001683
1684/*
1685 * If the X11 connection was lost try to restore it.
1686 * Helps when the X11 server was stopped and restarted while Vim was inactive
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01001687 * (e.g. through tmux).
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001688 */
1689 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001690may_restore_clipboard(void)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001691{
Bram Moolenaar01e51e52018-12-29 13:09:46 +01001692 // No point in restoring the connecting if we are exiting or dying.
1693 if (!exiting && !v_dying && xterm_dpy_retry_count > 0)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001694 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001695 --xterm_dpy_retry_count;
Bram Moolenaar527a6782014-12-17 17:59:31 +01001696
1697# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01001698 // This has been reported to avoid Vim getting stuck.
Bram Moolenaar527a6782014-12-17 17:59:31 +01001699 if (app_context != (XtAppContext)NULL)
1700 {
1701 XtDestroyApplicationContext(app_context);
1702 app_context = (XtAppContext)NULL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001703 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaar527a6782014-12-17 17:59:31 +01001704 }
1705# endif
1706
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001707 setup_term_clip();
1708 get_x11_title(FALSE);
1709 }
1710}
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001711
1712 void
1713ex_xrestore(exarg_T *eap)
1714{
1715 if (eap->arg != NULL && STRLEN(eap->arg) > 0)
1716 {
1717 if (xterm_display_allocated)
1718 vim_free(xterm_display);
1719 xterm_display = (char *)vim_strsave(eap->arg);
1720 xterm_display_allocated = TRUE;
1721 }
1722 smsg(_("restoring display %s"), xterm_display == NULL
Bram Moolenaar0c5c3fa2019-11-30 22:38:16 +01001723 ? (char *)mch_getenv((char_u *)"DISPLAY") : xterm_display);
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001724
1725 clear_xterm_clip();
1726 x11_window = 0;
1727 xterm_dpy_retry_count = 5; // Try reconnecting five times
1728 may_restore_clipboard();
1729}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730#endif
1731
1732/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 * Test if "dpy" and x11_window are valid by getting the window title.
1734 * I don't actually want it yet, so there may be a simpler call to use, but
1735 * this will cause the error handler x_error_check() to be called if anything
1736 * is wrong, such as the window pointer being invalid (as can happen when the
1737 * user changes his DISPLAY, but not his WINDOWID) -- webb
1738 */
1739 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001740test_x11_window(Display *dpy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741{
1742 int (*old_handler)();
1743 XTextProperty text_prop;
1744
1745 old_handler = XSetErrorHandler(x_error_check);
1746 got_x_error = FALSE;
1747 if (XGetWMName(dpy, x11_window, &text_prop))
1748 XFree((void *)text_prop.value);
1749 XSync(dpy, False);
1750 (void)XSetErrorHandler(old_handler);
1751
1752 if (p_verbose > 0 && got_x_error)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001753 verb_msg(_("Testing the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754
1755 return (got_x_error ? FAIL : OK);
1756}
1757#endif
1758
1759#ifdef FEAT_TITLE
1760
1761#ifdef FEAT_X11
1762
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01001763static int get_x11_thing(int get_title, int test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764
1765/*
1766 * try to get x11 window and display
1767 *
1768 * return FAIL for failure, OK otherwise
1769 */
1770 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001771get_x11_windis(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772{
1773 char *winid;
1774 static int result = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001775#define XD_NONE 0 // x11_display not set here
1776#define XD_HERE 1 // x11_display opened here
1777#define XD_GUI 2 // x11_display used from gui.dpy
1778#define XD_XTERM 3 // x11_display used from xterm_dpy
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 static int x11_display_from = XD_NONE;
1780 static int did_set_error_handler = FALSE;
1781
1782 if (!did_set_error_handler)
1783 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001784 // X just exits if it finds an error otherwise!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 (void)XSetErrorHandler(x_error_handler);
1786 did_set_error_handler = TRUE;
1787 }
1788
Bram Moolenaar9372a112005-12-06 19:59:18 +00001789#if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 if (gui.in_use)
1791 {
1792 /*
1793 * If the X11 display was opened here before, for the window where Vim
1794 * was started, close that one now to avoid a memory leak.
1795 */
1796 if (x11_display_from == XD_HERE && x11_display != NULL)
1797 {
1798 XCloseDisplay(x11_display);
1799 x11_display_from = XD_NONE;
1800 }
1801 if (gui_get_x11_windis(&x11_window, &x11_display) == OK)
1802 {
1803 x11_display_from = XD_GUI;
1804 return OK;
1805 }
1806 x11_display = NULL;
1807 return FAIL;
1808 }
1809 else if (x11_display_from == XD_GUI)
1810 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001811 // GUI must have stopped somehow, clear x11_display
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 x11_window = 0;
1813 x11_display = NULL;
1814 x11_display_from = XD_NONE;
1815 }
1816#endif
1817
Bram Moolenaar0f873732019-12-05 20:28:46 +01001818 // When started with the "-X" argument, don't try connecting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 if (!x_connect_to_server())
1820 return FAIL;
1821
1822 /*
1823 * If WINDOWID not set, should try another method to find out
1824 * what the current window number is. The only code I know for
1825 * this is very complicated.
1826 * We assume that zero is invalid for WINDOWID.
1827 */
1828 if (x11_window == 0 && (winid = getenv("WINDOWID")) != NULL)
1829 x11_window = (Window)atol(winid);
1830
1831#ifdef FEAT_XCLIPBOARD
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001832 if (xterm_dpy == x11_display)
1833 // x11_display may have been set to xterm_dpy elsewhere
1834 x11_display_from = XD_XTERM;
1835
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 if (xterm_dpy != NULL && x11_window != 0)
1837 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001838 // We may have checked it already, but Gnome terminal can move us to
1839 // another window, so we need to check every time.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00001840 if (x11_display_from != XD_XTERM)
1841 {
1842 /*
1843 * If the X11 display was opened here before, for the window where
1844 * Vim was started, close that one now to avoid a memory leak.
1845 */
1846 if (x11_display_from == XD_HERE && x11_display != NULL)
1847 XCloseDisplay(x11_display);
1848 x11_display = xterm_dpy;
1849 x11_display_from = XD_XTERM;
1850 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 if (test_x11_window(x11_display) == FAIL)
1852 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001853 // probably bad $WINDOWID
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 x11_window = 0;
1855 x11_display = NULL;
1856 x11_display_from = XD_NONE;
1857 return FAIL;
1858 }
1859 return OK;
1860 }
1861#endif
1862
1863 if (x11_window == 0 || x11_display == NULL)
1864 result = -1;
1865
Bram Moolenaar0f873732019-12-05 20:28:46 +01001866 if (result != -1) // Have already been here and set this
1867 return result; // Don't do all these X calls again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
1869 if (x11_window != 0 && x11_display == NULL)
1870 {
1871#ifdef SET_SIG_ALARM
1872 RETSIGTYPE (*sig_save)();
1873#endif
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001874#ifdef ELAPSED_FUNC
1875 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876
1877 if (p_verbose > 0)
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001878 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879#endif
1880
1881#ifdef SET_SIG_ALARM
1882 /*
1883 * Opening the Display may hang if the DISPLAY setting is wrong, or
1884 * the network connection is bad. Set an alarm timer to get out.
1885 */
1886 sig_alarm_called = FALSE;
1887 sig_save = (RETSIGTYPE (*)())signal(SIGALRM,
1888 (RETSIGTYPE (*)())sig_alarm);
1889 alarm(2);
1890#endif
1891 x11_display = XOpenDisplay(NULL);
1892
1893#ifdef SET_SIG_ALARM
1894 alarm(0);
1895 signal(SIGALRM, (RETSIGTYPE (*)())sig_save);
1896 if (p_verbose > 0 && sig_alarm_called)
Bram Moolenaar563bbea2019-01-22 21:45:40 +01001897 verb_msg(_("Opening the X display timed out"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898#endif
1899 if (x11_display != NULL)
1900 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001901# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001903 {
1904 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001905 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001906 verbose_leave();
1907 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908# endif
1909 if (test_x11_window(x11_display) == FAIL)
1910 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001911 // Maybe window id is bad
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 x11_window = 0;
1913 XCloseDisplay(x11_display);
1914 x11_display = NULL;
1915 }
1916 else
1917 x11_display_from = XD_HERE;
1918 }
1919 }
1920 if (x11_window == 0 || x11_display == NULL)
1921 return (result = FAIL);
Bram Moolenaar727c8762010-10-20 19:17:48 +02001922
1923# ifdef FEAT_EVAL
1924 set_vim_var_nr(VV_WINDOWID, (long)x11_window);
1925# endif
1926
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 return (result = OK);
1928}
1929
1930/*
1931 * Determine original x11 Window Title
1932 */
1933 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001934get_x11_title(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935{
Bram Moolenaar47136d72004-10-12 20:02:24 +00001936 return get_x11_thing(TRUE, test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937}
1938
1939/*
1940 * Determine original x11 Window icon
1941 */
1942 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001943get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944{
1945 int retval = FALSE;
1946
1947 retval = get_x11_thing(FALSE, test_only);
1948
Bram Moolenaar0f873732019-12-05 20:28:46 +01001949 // could not get old icon, use terminal name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 if (oldicon == NULL && !test_only)
1951 {
1952 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00001953 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00001955 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 }
1957
1958 return retval;
1959}
1960
1961 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001962get_x11_thing(
Bram Moolenaar0f873732019-12-05 20:28:46 +01001963 int get_title, // get title string
Bram Moolenaar05540972016-01-30 20:31:25 +01001964 int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965{
1966 XTextProperty text_prop;
1967 int retval = FALSE;
1968 Status status;
1969
1970 if (get_x11_windis() == OK)
1971 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001972 // Get window/icon name if any
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 if (get_title)
1974 status = XGetWMName(x11_display, x11_window, &text_prop);
1975 else
1976 status = XGetWMIconName(x11_display, x11_window, &text_prop);
1977
1978 /*
1979 * If terminal is xterm, then x11_window may be a child window of the
1980 * outer xterm window that actually contains the window/icon name, so
1981 * keep traversing up the tree until a window with a title/icon is
1982 * found.
1983 */
Bram Moolenaar4b96df52020-01-26 22:00:26 +01001984 // Previously this was only done for xterm and alike. I don't see a
Bram Moolenaar0f873732019-12-05 20:28:46 +01001985 // reason why it would fail for other terminal emulators.
1986 // if (term_is_xterm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 {
1988 Window root;
1989 Window parent;
1990 Window win = x11_window;
1991 Window *children;
1992 unsigned int num_children;
1993
1994 while (!status || text_prop.value == NULL)
1995 {
1996 if (!XQueryTree(x11_display, win, &root, &parent, &children,
1997 &num_children))
1998 break;
1999 if (children)
2000 XFree((void *)children);
2001 if (parent == root || parent == 0)
2002 break;
2003
2004 win = parent;
2005 if (get_title)
2006 status = XGetWMName(x11_display, win, &text_prop);
2007 else
2008 status = XGetWMIconName(x11_display, win, &text_prop);
2009 }
2010 }
2011 if (status && text_prop.value != NULL)
2012 {
2013 retval = TRUE;
2014 if (!test_only)
2015 {
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01002016 if (get_title)
2017 vim_free(oldtitle);
2018 else
2019 vim_free(oldicon);
Bram Moolenaara12a1612019-01-24 16:39:02 +01002020 if (text_prop.encoding == XA_STRING && !has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 if (get_title)
2023 oldtitle = vim_strsave((char_u *)text_prop.value);
2024 else
2025 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 }
2027 else
2028 {
2029 char **cl;
2030 Status transform_status;
2031 int n = 0;
2032
2033 transform_status = XmbTextPropertyToTextList(x11_display,
2034 &text_prop,
2035 &cl, &n);
2036 if (transform_status >= Success && n > 0 && cl[0])
2037 {
2038 if (get_title)
2039 oldtitle = vim_strsave((char_u *) cl[0]);
2040 else
2041 oldicon = vim_strsave((char_u *) cl[0]);
2042 XFreeStringList(cl);
2043 }
2044 else
2045 {
2046 if (get_title)
2047 oldtitle = vim_strsave((char_u *)text_prop.value);
2048 else
2049 oldicon = vim_strsave((char_u *)text_prop.value);
2050 }
2051 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 }
2053 XFree((void *)text_prop.value);
2054 }
2055 }
2056 return retval;
2057}
2058
Bram Moolenaar0f873732019-12-05 20:28:46 +01002059// Xutf8 functions are not available on older systems. Note that on some
2060// systems X_HAVE_UTF8_STRING may be defined in a header file but
2061// Xutf8SetWMProperties() is not in the X11 library. Configure checks for
2062// that and defines HAVE_XUTF8SETWMPROPERTIES.
Bram Moolenaara12a1612019-01-24 16:39:02 +01002063#if defined(X_HAVE_UTF8_STRING)
Bram Moolenaarcbc246a2014-10-11 14:47:26 +02002064# if X_HAVE_UTF8_STRING && HAVE_XUTF8SETWMPROPERTIES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065# define USE_UTF8_STRING
2066# endif
2067#endif
2068
2069/*
2070 * Set x11 Window Title
2071 *
2072 * get_x11_windis() must be called before this and have returned OK
2073 */
2074 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002075set_x11_title(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002077 // XmbSetWMProperties() and Xutf8SetWMProperties() should use a STRING
2078 // when possible, COMPOUND_TEXT otherwise. COMPOUND_TEXT isn't
2079 // supported everywhere and STRING doesn't work for multi-byte titles.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080#ifdef USE_UTF8_STRING
2081 if (enc_utf8)
2082 Xutf8SetWMProperties(x11_display, x11_window, (const char *)title,
2083 NULL, NULL, 0, NULL, NULL, NULL);
2084 else
2085#endif
2086 {
2087#if XtSpecificationRelease >= 4
2088# ifdef FEAT_XFONTSET
2089 XmbSetWMProperties(x11_display, x11_window, (const char *)title,
2090 NULL, NULL, 0, NULL, NULL, NULL);
2091# else
2092 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002093 char *c_title = (char *)title;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094
Bram Moolenaar0f873732019-12-05 20:28:46 +01002095 // directly from example 3-18 "basicwin" of Xlib Programming Manual
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002096 (void)XStringListToTextProperty(&c_title, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097 XSetWMProperties(x11_display, x11_window, &text_prop,
2098 NULL, NULL, 0, NULL, NULL, NULL);
2099# endif
2100#else
2101 XStoreName(x11_display, x11_window, (char *)title);
2102#endif
2103 }
2104 XFlush(x11_display);
2105}
2106
2107/*
2108 * Set x11 Window icon
2109 *
2110 * get_x11_windis() must be called before this and have returned OK
2111 */
2112 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002113set_x11_icon(char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002115 // See above for comments about using X*SetWMProperties().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116#ifdef USE_UTF8_STRING
2117 if (enc_utf8)
2118 Xutf8SetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2119 NULL, 0, NULL, NULL, NULL);
2120 else
2121#endif
2122 {
2123#if XtSpecificationRelease >= 4
2124# ifdef FEAT_XFONTSET
2125 XmbSetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2126 NULL, 0, NULL, NULL, NULL);
2127# else
2128 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002129 char *c_icon = (char *)icon;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002131 (void)XStringListToTextProperty(&c_icon, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 XSetWMProperties(x11_display, x11_window, NULL, &text_prop,
2133 NULL, 0, NULL, NULL, NULL);
2134# endif
2135#else
2136 XSetIconName(x11_display, x11_window, (char *)icon);
2137#endif
2138 }
2139 XFlush(x11_display);
2140}
2141
Bram Moolenaar0f873732019-12-05 20:28:46 +01002142#else // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002145get_x11_title(int test_only UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146{
2147 return FALSE;
2148}
2149
2150 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002151get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152{
2153 if (!test_only)
2154 {
2155 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002156 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002158 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 }
2160 return FALSE;
2161}
2162
Bram Moolenaar0f873732019-12-05 20:28:46 +01002163#endif // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164
2165 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002166mch_can_restore_title(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167{
2168 return get_x11_title(TRUE);
2169}
2170
2171 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002172mch_can_restore_icon(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173{
2174 return get_x11_icon(TRUE);
2175}
2176
2177/*
2178 * Set the window title and icon.
2179 */
2180 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002181mch_settitle(char_u *title, char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182{
2183 int type = 0;
2184 static int recursive = 0;
2185
Bram Moolenaar0f873732019-12-05 20:28:46 +01002186 if (T_NAME == NULL) // no terminal name (yet)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 return;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002188 if (title == NULL && icon == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 return;
2190
Bram Moolenaar0f873732019-12-05 20:28:46 +01002191 // When one of the X11 functions causes a deadly signal, we get here again
2192 // recursively. Avoid hanging then (something is probably locked).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 if (recursive)
2194 return;
2195 ++recursive;
2196
2197 /*
2198 * if the window ID and the display is known, we may use X11 calls
2199 */
2200#ifdef FEAT_X11
2201 if (get_x11_windis() == OK)
2202 type = 1;
2203#else
Bram Moolenaar097148e2020-08-11 21:58:20 +02002204# if defined(FEAT_GUI_PHOTON) \
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002205 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 if (gui.in_use)
2207 type = 1;
2208# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209#endif
2210
2211 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002212 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 * than x11 calls, because the x11 calls don't always work
2214 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 if ((type || *T_TS != NUL) && title != NULL)
2216 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002217 if (oldtitle_outdated)
2218 {
2219 oldtitle_outdated = FALSE;
2220 VIM_CLEAR(oldtitle);
2221 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 if (oldtitle == NULL
2223#ifdef FEAT_GUI
2224 && !gui.in_use
2225#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002226 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 (void)get_x11_title(FALSE);
2228
Bram Moolenaar0f873732019-12-05 20:28:46 +01002229 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 term_settitle(title);
2231#ifdef FEAT_X11
2232 else
2233# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002234 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002236 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002238#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar097148e2020-08-11 21:58:20 +02002239 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 else
2241 gui_mch_settitle(title, icon);
2242#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002243 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 }
2245
2246 if ((type || *T_CIS != NUL) && icon != NULL)
2247 {
2248 if (oldicon == NULL
2249#ifdef FEAT_GUI
2250 && !gui.in_use
2251#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002252 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 get_x11_icon(FALSE);
2254
2255 if (*T_CIS != NUL)
2256 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002257 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002259 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 out_flush();
2261 }
2262#ifdef FEAT_X11
2263 else
2264# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002265 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002267 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268#endif
2269 did_set_icon = TRUE;
2270 }
2271 --recursive;
2272}
2273
2274/*
2275 * Restore the window/icon title.
2276 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002277 * SAVE_RESTORE_TITLE only restore title
2278 * SAVE_RESTORE_ICON only restore icon
2279 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 */
2281 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002282mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283{
Bram Moolenaardac13472019-09-16 21:06:21 +02002284 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002285
Bram Moolenaar0f873732019-12-05 20:28:46 +01002286 // only restore the title or icon when it has been set
Bram Moolenaardac13472019-09-16 21:06:21 +02002287 mch_settitle(((which & SAVE_RESTORE_TITLE) && unix_did_set_title) ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 (oldtitle ? oldtitle : p_titleold) : NULL,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002289 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
2290
Bram Moolenaare5c83282019-05-03 23:15:37 +02002291 if (do_push_pop)
2292 {
2293 // pop and push from/to the stack
2294 term_pop_title(which);
2295 term_push_title(which);
2296 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297}
2298
Bram Moolenaar0f873732019-12-05 20:28:46 +01002299#endif // FEAT_TITLE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300
2301/*
2302 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002303 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 */
2305 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002306vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307{
2308 if (name == NULL)
2309 return FALSE;
2310 return (STRNICMP(name, "xterm", 5) == 0
2311 || STRNICMP(name, "nxterm", 6) == 0
2312 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002313 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002315 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 || STRCMP(name, "builtin_xterm") == 0);
2317}
2318
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002319#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2320/*
2321 * Return TRUE if "name" appears to be that of a terminal
2322 * known to support the xterm-style mouse protocol.
2323 * Relies on term_is_xterm having been set to its correct value.
2324 */
2325 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002326use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002327{
2328 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002329 && (term_is_xterm
2330 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002331 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002332 || STRICMP(name, "st") == 0
2333 || STRNICMP(name, "st-", 3) == 0
2334 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002335}
2336#endif
2337
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338/*
2339 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2340 * Return 1 for "xterm".
2341 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002342 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002343 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 */
2345 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002346use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002348 if (ttym_flags == TTYM_SGR)
2349 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002350 if (ttym_flags == TTYM_URXVT)
2351 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 if (ttym_flags == TTYM_XTERM2)
2353 return 2;
2354 if (ttym_flags == TTYM_XTERM)
2355 return 1;
2356 return 0;
2357}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358
2359 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002360vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361{
2362 if (name == NULL)
2363 return FALSE;
2364 return (STRNICMP(name, "iris-ansi", 9) == 0
2365 || STRCMP(name, "builtin_iris-ansi") == 0);
2366}
2367
2368 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002369vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370{
2371 if (name == NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002372 return FALSE; // actually all ANSI comp. terminals should be here
2373 // catch VT100 - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002374 return ((STRNICMP(name, "vt", 2) == 0
2375 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 || STRCMP(name, "builtin_vt320") == 0);
2377}
2378
2379/*
2380 * Return TRUE if "name" is a terminal for which 'ttyfast' should be set.
2381 * This should include all windowed terminal emulators.
2382 */
2383 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002384vim_is_fastterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385{
2386 if (name == NULL)
2387 return FALSE;
2388 if (vim_is_xterm(name) || vim_is_vt300(name) || vim_is_iris(name))
2389 return TRUE;
2390 return ( STRNICMP(name, "hpterm", 6) == 0
2391 || STRNICMP(name, "sun-cmd", 7) == 0
2392 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002393 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 || STRNICMP(name, "dtterm", 6) == 0);
2395}
2396
2397/*
2398 * Insert user name in s[len].
2399 * Return OK if a name found.
2400 */
2401 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002402mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403{
2404#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002405 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 return OK;
2407#else
2408 return mch_get_uname(getuid(), s, len);
2409#endif
2410}
2411
2412/*
2413 * Insert user name for "uid" in s[len].
2414 * Return OK if a name found.
2415 */
2416 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002417mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418{
2419#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2420 struct passwd *pw;
2421
2422 if ((pw = getpwuid(uid)) != NULL
2423 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2424 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002425 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 return OK;
2427 }
2428#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002429 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2430 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431}
2432
2433/*
2434 * Insert host name is s[len].
2435 */
2436
2437#ifdef HAVE_SYS_UTSNAME_H
2438 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002439mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440{
2441 struct utsname vutsname;
2442
2443 if (uname(&vutsname) < 0)
2444 *s = NUL;
2445 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002446 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002448#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449
2450# ifdef HAVE_SYS_SYSTEMINFO_H
2451# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2452# endif
2453
2454 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002455mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456{
2457# ifdef VAXC
2458 vaxc$gethostname((char *)s, len);
2459# else
2460 gethostname((char *)s, len);
2461# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002462 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002464#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465
2466/*
2467 * return process ID
2468 */
2469 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002470mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471{
2472 return (long)getpid();
2473}
2474
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002475/*
2476 * return TRUE if process "pid" is still running
2477 */
2478 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002479mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002480{
2481 // EMX kill() not working correctly, it seems
2482 return kill(pid, 0) == 0;
2483}
2484
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002487strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488{
2489 extern int sys_nerr;
2490 extern char *sys_errlist[];
2491 static char er[20];
2492
2493 if (err > 0 && err < sys_nerr)
2494 return (sys_errlist[err]);
2495 sprintf(er, "Error %d", err);
2496 return er;
2497}
2498#endif
2499
2500/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002501 * Get name of current directory into buffer "buf" of length "len" bytes.
2502 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 * Return OK for success, FAIL for failure.
2504 */
2505 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002506mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507{
2508#if defined(USE_GETCWD)
2509 if (getcwd((char *)buf, len) == NULL)
2510 {
2511 STRCPY(buf, strerror(errno));
2512 return FAIL;
2513 }
2514 return OK;
2515#else
2516 return (getwd((char *)buf) != NULL ? OK : FAIL);
2517#endif
2518}
2519
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002521 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 *
2523 * return FAIL for failure, OK for success
2524 */
2525 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002526mch_FullName(
2527 char_u *fname,
2528 char_u *buf,
2529 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002530 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531{
2532 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002533#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002535 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002536#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 char_u olddir[MAXPATHL];
2538 char_u *p;
2539 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002540#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002541 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2542 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002543#endif
2544
Bram Moolenaar38323e42007-03-06 19:22:53 +00002545#ifdef VMS
2546 fname = vms_fixfilename(fname);
2547#endif
2548
Bram Moolenaara2442432007-04-26 14:26:37 +00002549#ifdef __CYGWIN__
2550 /*
2551 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2552 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002553# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002554 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2555 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002556 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2557 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002558# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002559 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002560# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002561 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002562#endif
2563
Bram Moolenaar0f873732019-12-05 20:28:46 +01002564 // Expand it if forced or not an absolute path.
2565 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002566 if ((force || !mch_isFullName(fname))
2567 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 {
2569 /*
2570 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002571 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 * This will get the correct path name with "../" things.
2573 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002574 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002576#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 /*
2578 * Use fchdir() if possible, it's said to be faster and more
2579 * reliable. But on SunOS 4 it might not work. Check this by
2580 * doing a fchdir() right now.
2581 */
2582 if (!dont_fchdir)
2583 {
2584 fd = open(".", O_RDONLY | O_EXTRA, 0);
2585 if (fd >= 0 && fchdir(fd) < 0)
2586 {
2587 close(fd);
2588 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002589 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 }
2591 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002592#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
Bram Moolenaar0f873732019-12-05 20:28:46 +01002594 // Only change directory when we are sure we can return to where
2595 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002597#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002599#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 (mch_dirname(olddir, MAXPATHL) == FAIL
2601 || mch_chdir((char *)olddir) != 0))
2602 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002603 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 retval = FAIL;
2605 }
2606 else
2607 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002608 // The directory is copied into buf[], to be able to remove
2609 // the file name without changing it (could be a string in
2610 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 if (p - fname >= len)
2612 retval = FAIL;
2613 else
2614 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002615 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 if (mch_chdir((char *)buf))
2617 retval = FAIL;
2618 else
2619 fname = p + 1;
2620 *buf = NUL;
2621 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 }
2623 }
2624 if (mch_dirname(buf, len) == FAIL)
2625 {
2626 retval = FAIL;
2627 *buf = NUL;
2628 }
2629 if (p != NULL)
2630 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002631#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 if (fd >= 0)
2633 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002634 if (p_verbose >= 5)
2635 {
2636 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002637 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002638 verbose_leave();
2639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 l = fchdir(fd);
2641 close(fd);
2642 }
2643 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002644#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 l = mch_chdir((char *)olddir);
2646 if (l != 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002647 emsg(_(e_prev_dir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 }
2649
2650 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002651 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002652 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002653#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002654 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002656 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002657#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002659
Bram Moolenaar0f873732019-12-05 20:28:46 +01002660 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002661 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 return FAIL;
2663
Bram Moolenaar0f873732019-12-05 20:28:46 +01002664 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 if (STRCMP(fname, ".") != 0)
2666 STRCAT(buf, fname);
2667
2668 return OK;
2669}
2670
2671/*
2672 * Return TRUE if "fname" does not depend on the current directory.
2673 */
2674 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002675mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002677#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 return ( fname[0] == '/' || fname[0] == '.' ||
2679 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2680 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2681 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002682#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684#endif
2685}
2686
Bram Moolenaar24552be2005-12-10 20:17:30 +00002687#if defined(USE_FNAME_CASE) || defined(PROTO)
2688/*
2689 * Set the case of the file name, if it already exists. This will cause the
2690 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002691 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002692 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002693 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002694fname_case(
2695 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002696 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002697{
2698 struct stat st;
2699 char_u *slash, *tail;
2700 DIR *dirp;
2701 struct dirent *dp;
2702
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002703 if (mch_lstat((char *)name, &st) >= 0)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002704 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002705 // Open the directory where the file is located.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002706 slash = vim_strrchr(name, '/');
2707 if (slash == NULL)
2708 {
2709 dirp = opendir(".");
2710 tail = name;
2711 }
2712 else
2713 {
2714 *slash = NUL;
2715 dirp = opendir((char *)name);
2716 *slash = '/';
2717 tail = slash + 1;
2718 }
2719
2720 if (dirp != NULL)
2721 {
2722 while ((dp = readdir(dirp)) != NULL)
2723 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002724 // Only accept names that differ in case and are the same byte
2725 // length. TODO: accept different length name.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002726 if (STRICMP(tail, dp->d_name) == 0
2727 && STRLEN(tail) == STRLEN(dp->d_name))
2728 {
2729 char_u newname[MAXPATHL + 1];
2730 struct stat st2;
2731
Bram Moolenaar0f873732019-12-05 20:28:46 +01002732 // Verify the inode is equal.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002733 vim_strncpy(newname, name, MAXPATHL);
2734 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2735 MAXPATHL - (tail - name));
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002736 if (mch_lstat((char *)newname, &st2) >= 0
Bram Moolenaar24552be2005-12-10 20:17:30 +00002737 && st.st_ino == st2.st_ino
2738 && st.st_dev == st2.st_dev)
2739 {
2740 STRCPY(tail, dp->d_name);
2741 break;
2742 }
2743 }
2744 }
2745
2746 closedir(dirp);
2747 }
2748 }
2749}
2750#endif
2751
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752/*
2753 * Get file permissions for 'name'.
2754 * Returns -1 when it doesn't exist.
2755 */
2756 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002757mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758{
2759 struct stat statb;
2760
Bram Moolenaar0f873732019-12-05 20:28:46 +01002761 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762#ifdef VMS
2763 if (stat((char *)vms_fixfilename(name), &statb))
2764#else
2765 if (stat((char *)name, &statb))
2766#endif
2767 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002768#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002769 // The top bit makes the value negative, which means the file doesn't
2770 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002771 return statb.st_mode & ~S_ADDACE;
2772#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002774#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775}
2776
2777/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002778 * Set file permission for "name" to "perm".
2779 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 */
2781 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002782mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783{
2784 return (chmod((char *)
2785#ifdef VMS
2786 vms_fixfilename(name),
2787#else
2788 name,
2789#endif
2790 (mode_t)perm) == 0 ? OK : FAIL);
2791}
2792
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002793#if defined(HAVE_FCHMOD) || defined(PROTO)
2794/*
2795 * Set file permission for open file "fd" to "perm".
2796 * Return FAIL for failure, OK otherwise.
2797 */
2798 int
2799mch_fsetperm(int fd, long perm)
2800{
2801 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2802}
2803#endif
2804
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805#if defined(HAVE_ACL) || defined(PROTO)
2806# ifdef HAVE_SYS_ACL_H
2807# include <sys/acl.h>
2808# endif
2809# ifdef HAVE_SYS_ACCESS_H
2810# include <sys/access.h>
2811# endif
2812
2813# ifdef HAVE_SOLARIS_ACL
2814typedef struct vim_acl_solaris_T {
2815 int acl_cnt;
2816 aclent_t *acl_entry;
2817} vim_acl_solaris_T;
2818# endif
2819
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002820#if defined(HAVE_SELINUX) || defined(PROTO)
2821/*
2822 * Copy security info from "from_file" to "to_file".
2823 */
2824 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002825mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002826{
2827 if (from_file == NULL)
2828 return;
2829
2830 if (selinux_enabled == -1)
2831 selinux_enabled = is_selinux_enabled();
2832
2833 if (selinux_enabled > 0)
2834 {
2835 security_context_t from_context = NULL;
2836 security_context_t to_context = NULL;
2837
2838 if (getfilecon((char *)from_file, &from_context) < 0)
2839 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002840 // If the filesystem doesn't support extended attributes,
2841 // the original had no special security context and the
2842 // target cannot have one either.
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002843 if (errno == EOPNOTSUPP)
2844 return;
2845
Bram Moolenaar32526b32019-01-19 17:43:09 +01002846 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002847 msg_outtrans(from_file);
2848 msg_putchar('\n');
2849 return;
2850 }
2851 if (getfilecon((char *)to_file, &to_context) < 0)
2852 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002853 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002854 msg_outtrans(to_file);
2855 msg_putchar('\n');
2856 freecon (from_context);
2857 return ;
2858 }
2859 if (strcmp(from_context, to_context) != 0)
2860 {
2861 if (setfilecon((char *)to_file, from_context) < 0)
2862 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002863 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002864 msg_outtrans(to_file);
2865 msg_putchar('\n');
2866 }
2867 }
2868 freecon(to_context);
2869 freecon(from_context);
2870 }
2871}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002872#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002873
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002874#if defined(HAVE_SMACK) && !defined(PROTO)
2875/*
2876 * Copy security info from "from_file" to "to_file".
2877 */
2878 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002879mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002880{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002881 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002882 {
2883 XATTR_NAME_SMACK,
2884 XATTR_NAME_SMACKEXEC,
2885 XATTR_NAME_SMACKMMAP
2886 };
2887
2888 char buffer[SMACK_LABEL_LEN];
2889 const char *name;
2890 int index;
2891 int ret;
2892 ssize_t size;
2893
2894 if (from_file == NULL)
2895 return;
2896
2897 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2898 / sizeof(smack_copied_attributes)[0]) ; index++)
2899 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002900 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002901 name = smack_copied_attributes[index];
2902
Bram Moolenaar0f873732019-12-05 20:28:46 +01002903 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002904 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2905 if (size >= 0)
2906 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002907 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002908 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2909 if (ret < 0)
2910 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002911 vim_snprintf((char *)IObuff, IOSIZE,
2912 _("Could not set security context %s for %s"),
2913 name, to_file);
2914 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002915 msg_putchar('\n');
2916 }
2917 }
2918 else
2919 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002920 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002921 switch (errno)
2922 {
2923 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002924 // extended attributes aren't supported or enabled
2925 // should a message be echoed? not sure...
2926 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002927
2928 case ERANGE:
2929 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002930 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002931 vim_snprintf((char *)IObuff, IOSIZE,
2932 _("Could not get security context %s for %s. Removing it!"),
2933 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002934 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002935 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01002936 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002937
2938 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002939 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002940 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01002941 // Silently ignore errors, apparently this happens when
2942 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002943 break;
2944 }
2945 }
2946 }
2947}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002948#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002949
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950/*
2951 * Return a pointer to the ACL of file "fname" in allocated memory.
2952 * Return NULL if the ACL is not available for whatever reason.
2953 */
2954 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01002955mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956{
2957 vim_acl_T ret = NULL;
2958#ifdef HAVE_POSIX_ACL
2959 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
2960#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01002961#ifdef HAVE_SOLARIS_ZFS_ACL
2962 acl_t *aclent;
2963
2964 if (acl_get((char *)fname, 0, &aclent) < 0)
2965 return NULL;
2966 ret = (vim_acl_T)aclent;
2967#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968#ifdef HAVE_SOLARIS_ACL
2969 vim_acl_solaris_T *aclent;
2970
2971 aclent = malloc(sizeof(vim_acl_solaris_T));
2972 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
2973 {
2974 free(aclent);
2975 return NULL;
2976 }
2977 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
2978 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
2979 {
2980 free(aclent->acl_entry);
2981 free(aclent);
2982 return NULL;
2983 }
2984 ret = (vim_acl_T)aclent;
2985#else
2986#if defined(HAVE_AIX_ACL)
2987 int aclsize;
2988 struct acl *aclent;
2989
2990 aclsize = sizeof(struct acl);
2991 aclent = malloc(aclsize);
2992 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
2993 {
2994 if (errno == ENOSPC)
2995 {
2996 aclsize = aclent->acl_len;
2997 aclent = realloc(aclent, aclsize);
2998 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
2999 {
3000 free(aclent);
3001 return NULL;
3002 }
3003 }
3004 else
3005 {
3006 free(aclent);
3007 return NULL;
3008 }
3009 }
3010 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003011#endif // HAVE_AIX_ACL
3012#endif // HAVE_SOLARIS_ACL
3013#endif // HAVE_SOLARIS_ZFS_ACL
3014#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 return ret;
3016}
3017
3018/*
3019 * Set the ACL of file "fname" to "acl" (unless it's NULL).
3020 */
3021 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003022mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023{
3024 if (aclent == NULL)
3025 return;
3026#ifdef HAVE_POSIX_ACL
3027 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
3028#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003029#ifdef HAVE_SOLARIS_ZFS_ACL
3030 acl_set((char *)fname, (acl_t *)aclent);
3031#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032#ifdef HAVE_SOLARIS_ACL
3033 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
3034 ((vim_acl_solaris_T *)aclent)->acl_entry);
3035#else
3036#ifdef HAVE_AIX_ACL
3037 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003038#endif // HAVE_AIX_ACL
3039#endif // HAVE_SOLARIS_ACL
3040#endif // HAVE_SOLARIS_ZFS_ACL
3041#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042}
3043
3044 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003045mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046{
3047 if (aclent == NULL)
3048 return;
3049#ifdef HAVE_POSIX_ACL
3050 acl_free((acl_t)aclent);
3051#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003052#ifdef HAVE_SOLARIS_ZFS_ACL
3053 acl_free((acl_t *)aclent);
3054#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055#ifdef HAVE_SOLARIS_ACL
3056 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3057 free(aclent);
3058#else
3059#ifdef HAVE_AIX_ACL
3060 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003061#endif // HAVE_AIX_ACL
3062#endif // HAVE_SOLARIS_ACL
3063#endif // HAVE_SOLARIS_ZFS_ACL
3064#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065}
3066#endif
3067
3068/*
3069 * Set hidden flag for "name".
3070 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003072mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003074 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075}
3076
3077/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003078 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 * return FALSE if "name" is not a directory
3080 * return FALSE for error
3081 */
3082 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003083mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084{
3085 struct stat statb;
3086
Bram Moolenaar0f873732019-12-05 20:28:46 +01003087 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 return FALSE;
3089 if (stat((char *)name, &statb))
3090 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092}
3093
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003094/*
3095 * return TRUE if "name" is a directory, NOT a symlink to a directory
3096 * return FALSE if "name" is not a directory
3097 * return FALSE for error
3098 */
3099 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003100mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003101{
3102 struct stat statb;
3103
Bram Moolenaar0f873732019-12-05 20:28:46 +01003104 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003105 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003106 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003107 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003108 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003109}
3110
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111/*
3112 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3113 */
3114 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003115executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116{
3117 struct stat st;
3118
3119 if (stat((char *)name, &st))
3120 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003121#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003122 // Like on Unix system file can have executable rights but not necessarily
3123 // be an executable, but on Unix is not a default for an ordinary file to
3124 // have an executable flag - on VMS it is in most cases.
3125 // Therefore, this check does not have any sense - let keep us to the
3126 // conventions instead:
3127 // *.COM and *.EXE files are the executables - the rest are not. This is
3128 // not ideal but better then it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003129 int vms_executable = 0;
3130 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3131 {
3132 if (strstr(vms_tolower((char*)name),".exe") != NULL
3133 || strstr(vms_tolower((char*)name),".com")!= NULL)
3134 vms_executable = 1;
3135 }
3136 return vms_executable;
3137#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003139#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140}
3141
3142/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003143 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003144 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 * Return -1 if unknown.
3146 */
3147 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003148mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149{
3150 char_u *buf;
3151 char_u *p, *e;
3152 int retval;
3153
Bram Moolenaar0f873732019-12-05 20:28:46 +01003154 // When "use_path" is false and if it's an absolute or relative path don't
3155 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003156 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003157 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003158 // There must be a path separator, files in the current directory
3159 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003160 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003161 {
3162 if (path != NULL)
3163 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003164 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003165 *path = FullName_save(name, TRUE);
3166 else
3167 *path = vim_strsave(name);
3168 }
3169 return TRUE;
3170 }
3171 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003172 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173
3174 p = (char_u *)getenv("PATH");
3175 if (p == NULL || *p == NUL)
3176 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003177 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 if (buf == NULL)
3179 return -1;
3180
3181 /*
3182 * Walk through all entries in $PATH to check if "name" exists there and
3183 * is an executable file.
3184 */
3185 for (;;)
3186 {
3187 e = (char_u *)strchr((char *)p, ':');
3188 if (e == NULL)
3189 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003190 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 STRCPY(buf, "./");
3192 else
3193 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003194 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 add_pathsep(buf);
3196 }
3197 STRCAT(buf, name);
3198 retval = executable_file(buf);
3199 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003200 {
3201 if (path != NULL)
3202 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003203 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003204 *path = FullName_save(buf, TRUE);
3205 else
3206 *path = vim_strsave(buf);
3207 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003209 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210
3211 if (*e != ':')
3212 break;
3213 p = e + 1;
3214 }
3215
3216 vim_free(buf);
3217 return retval;
3218}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219
3220/*
3221 * Check what "name" is:
3222 * NODE_NORMAL: file or directory (or doesn't exist)
3223 * NODE_WRITABLE: writable device, socket, fifo, etc.
3224 * NODE_OTHER: non-writable things
3225 */
3226 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003227mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228{
3229 struct stat st;
3230
3231 if (stat((char *)name, &st))
3232 return NODE_NORMAL;
3233 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3234 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003235 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003237 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 return NODE_WRITABLE;
3239}
3240
3241 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003242mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243{
3244#ifdef HAVE_CHECK_STACK_GROWTH
3245 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 check_stack_growth((char *)&i);
3248
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003249# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 get_stack_limit();
3251# endif
3252
3253#endif
3254
3255 /*
3256 * Setup an alternative stack for signals. Helps to catch signals when
3257 * running out of stack space.
3258 * Use of sigaltstack() is preferred, it's more portable.
3259 * Ignore any errors.
3260 */
3261#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003262 signal_stack = alloc(SIGSTKSZ);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 init_signal_stack();
3264#endif
3265}
3266
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003267#if defined(EXITFREE) || defined(PROTO)
3268 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003269mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003270{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003271# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3272 if (clip_star.owned)
3273 clip_lose_selection(&clip_star);
3274 if (clip_plus.owned)
3275 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003276# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003277# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003278 if (xterm_Shell != (Widget)0)
3279 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003280# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003281 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003282 if (xterm_dpy != NULL)
3283 XtCloseDisplay(xterm_dpy);
3284 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003285 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003286 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003287# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003288 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003289# endif
3290 }
3291# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003292# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003293# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003294 if (x11_display != NULL
3295# ifdef FEAT_XCLIPBOARD
3296 && x11_display != xterm_dpy
3297# endif
3298 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003299 XCloseDisplay(x11_display);
3300# endif
3301# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003302 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003303# endif
3304# ifdef FEAT_TITLE
3305 vim_free(oldtitle);
3306 vim_free(oldicon);
3307# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003308}
3309#endif
3310
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311/*
3312 * Output a newline when exiting.
3313 * Make sure the newline goes to the same stream as the text.
3314 */
3315 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003316exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003318 if (silent_mode)
3319 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 if (newline_on_exit || msg_didout)
3321 {
3322 if (msg_use_printf())
3323 {
3324 if (info_message)
3325 mch_msg("\n");
3326 else
3327 mch_errmsg("\r\n");
3328 }
3329 else
3330 out_char('\n');
3331 }
3332 else
3333 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003334 restore_cterm_colors(); // get original colors back
3335 msg_clr_eos_force(); // clear the rest of the display
3336 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 }
3338}
3339
Bram Moolenaarb4151682020-05-11 22:13:28 +02003340#ifdef USE_GCOV_FLUSH
3341extern void __gcov_flush();
3342#endif
3343
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003345mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346{
3347 exiting = TRUE;
3348
3349#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3350 x11_export_final_selection();
3351#endif
3352
3353#ifdef FEAT_GUI
3354 if (!gui.in_use)
3355#endif
3356 {
3357 settmode(TMODE_COOK);
3358#ifdef FEAT_TITLE
Bram Moolenaar40385db2018-08-07 22:31:44 +02003359 // restore xterm title and icon name
3360 mch_restore_title(SAVE_RESTORE_BOTH);
3361 term_pop_title(SAVE_RESTORE_BOTH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362#endif
3363 /*
3364 * When t_ti is not empty but it doesn't cause swapping terminal
3365 * pages, need to output a newline when msg_didout is set. But when
3366 * t_ti does swap pages it should not go to the shell page. Do this
3367 * before stoptermcap().
3368 */
3369 if (swapping_screen() && !newline_on_exit)
3370 exit_scroll();
3371
Bram Moolenaar0f873732019-12-05 20:28:46 +01003372 // Stop termcap: May need to check for T_CRV response, which
3373 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 stoptermcap();
3375
3376 /*
3377 * A newline is only required after a message in the alternate screen.
3378 * This is set to TRUE by wait_return().
3379 */
3380 if (!swapping_screen() || newline_on_exit)
3381 exit_scroll();
3382
Bram Moolenaar0f873732019-12-05 20:28:46 +01003383 // Cursor may have been switched off without calling starttermcap()
3384 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 if (full_screen)
3386 cursor_on();
3387 }
3388 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003389 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaarb4151682020-05-11 22:13:28 +02003390
3391#ifdef USE_GCOV_FLUSH
3392 // Flush coverage info before possibly being killed by a deadly signal.
3393 __gcov_flush();
3394#endif
3395
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 may_core_dump();
3397#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 gui_exit(r);
3400#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003401
Bram Moolenaar56718732006-03-15 22:53:57 +00003402#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003403 mac_conv_cleanup();
3404#endif
3405
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003407 // A core dump won't be created if the signal handler
3408 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 if (deadly_signal != 0)
3410 return;
3411#endif
3412
Bram Moolenaar009b2592004-10-24 19:18:58 +00003413#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003414 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003415#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003416
3417#ifdef EXITFREE
3418 free_all_mem();
3419#endif
3420
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 exit(r);
3422}
3423
3424 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003425may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426{
3427 if (deadly_signal != 0)
3428 {
3429 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003430 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 }
3432}
3433
3434#ifndef VMS
3435
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003436/*
3437 * Get the file descriptor to use for tty operations.
3438 */
3439 static int
3440get_tty_fd(int fd)
3441{
3442 int tty_fd = fd;
3443
3444#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3445 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3446 // "fd" when it is a master device.
3447 if (mch_isatty(fd) > 1)
3448 {
3449 char *name;
3450
3451 name = ptsname(fd);
3452 if (name == NULL)
3453 return -1;
3454
3455 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3456 if (tty_fd < 0)
3457 return -1;
3458 }
3459#endif
3460 return tty_fd;
3461}
3462
3463 static int
3464mch_tcgetattr(int fd, void *term)
3465{
3466 int tty_fd;
3467 int retval = -1;
3468
3469 tty_fd = get_tty_fd(fd);
3470 if (tty_fd >= 0)
3471 {
3472#ifdef NEW_TTY_SYSTEM
3473# ifdef HAVE_TERMIOS_H
3474 retval = tcgetattr(tty_fd, (struct termios *)term);
3475# else
3476 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
3477# endif
3478#else
3479 // for "old" tty systems
3480 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
3481#endif
3482 if (tty_fd != fd)
3483 close(tty_fd);
3484 }
3485 return retval;
3486}
3487
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 void
Bram Moolenaar26e86442020-05-17 14:06:16 +02003489mch_settmode(tmode_T tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490{
3491 static int first = TRUE;
3492
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003493#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494# ifdef HAVE_TERMIOS_H
3495 static struct termios told;
3496 struct termios tnew;
3497# else
3498 static struct termio told;
3499 struct termio tnew;
3500# endif
3501
3502 if (first)
3503 {
3504 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003505 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 }
3507
3508 tnew = told;
3509 if (tmode == TMODE_RAW)
3510 {
Bram Moolenaar041c7102020-05-30 18:14:57 +02003511 // ~ICRNL enables typing ^V^M
Bram Moolenaar928eec62020-05-31 13:09:47 +02003512 // ~IXON disables CTRL-S stopping output, so that it can be mapped.
3513 tnew.c_iflag &= ~(ICRNL | IXON);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
Bram Moolenaare3f915d2020-07-14 23:02:44 +02003515# if defined(IEXTEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003516 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517# endif
3518 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003519# ifdef ONLCR
3520 // Don't map NL -> CR NL, we do it ourselves.
3521 // Also disable expanding tabs if possible.
3522# ifdef XTABS
3523 tnew.c_oflag &= ~(ONLCR | XTABS);
3524# else
3525# ifdef TAB3
3526 tnew.c_oflag &= ~(ONLCR | TAB3);
3527# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003529# endif
3530# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003532 tnew.c_cc[VMIN] = 1; // return after 1 char
3533 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 }
3535 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003536 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003537 // Also reset ICANON here, otherwise on Solaris select() won't see
3538 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003539 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003540 tnew.c_cc[VMIN] = 1; // return after 1 char
3541 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003542 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543
3544# if defined(HAVE_TERMIOS_H)
3545 {
3546 int n = 10;
3547
Bram Moolenaar0f873732019-12-05 20:28:46 +01003548 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3549 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3551 && errno == EINTR && n > 0)
3552 --n;
3553 }
3554# else
3555 ioctl(read_cmd_fd, TCSETA, &tnew);
3556# endif
3557
3558#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 /*
3560 * for "old" tty systems
3561 */
3562# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003563# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564# endif
3565 static struct sgttyb ttybold;
3566 struct sgttyb ttybnew;
3567
3568 if (first)
3569 {
3570 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003571 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 }
3573
3574 ttybnew = ttybold;
3575 if (tmode == TMODE_RAW)
3576 {
3577 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3578 ttybnew.sg_flags |= RAW;
3579 }
3580 else if (tmode == TMODE_SLEEP)
3581 ttybnew.sg_flags &= ~(ECHO);
3582 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3583#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02003584 mch_cur_tmode = tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585}
3586
3587/*
3588 * Try to get the code for "t_kb" from the stty setting
3589 *
3590 * Even if termcap claims a backspace key, the user's setting *should*
3591 * prevail. stty knows more about reality than termcap does, and if
3592 * somebody's usual erase key is DEL (which, for most BSD users, it will
3593 * be), they're going to get really annoyed if their erase key starts
3594 * doing forward deletes for no reason. (Eric Fischer)
3595 */
3596 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003597get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003599 ttyinfo_T info;
3600 char_u buf[2];
3601 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003603 if (get_tty_info(read_cmd_fd, &info) == OK)
3604 {
3605 intr_char = info.interrupt;
3606 buf[0] = info.backspace;
3607 buf[1] = NUL;
3608 add_termcode((char_u *)"kb", buf, FALSE);
3609
Bram Moolenaar0f873732019-12-05 20:28:46 +01003610 // If <BS> and <DEL> are now the same, redefine <DEL>.
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003611 p = find_termcode((char_u *)"kD");
3612 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3613 do_fixdel(NULL);
3614 }
3615}
3616
3617/*
3618 * Obtain the characters that Backspace and Enter produce on "fd".
3619 * Returns OK or FAIL.
3620 */
3621 int
3622get_tty_info(int fd, ttyinfo_T *info)
3623{
3624#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625# ifdef HAVE_TERMIOS_H
3626 struct termios keys;
3627# else
3628 struct termio keys;
3629# endif
3630
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003631 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003633 info->backspace = keys.c_cc[VERASE];
3634 info->interrupt = keys.c_cc[VINTR];
3635 if (keys.c_iflag & ICRNL)
3636 info->enter = NL;
3637 else
3638 info->enter = CAR;
3639 if (keys.c_oflag & ONLCR)
3640 info->nl_does_cr = TRUE;
3641 else
3642 info->nl_does_cr = FALSE;
3643 return OK;
3644 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003646 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 struct sgttyb keys;
3648
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003649 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003651 info->backspace = keys.sg_erase;
3652 info->interrupt = keys.sg_kill;
3653 info->enter = CAR;
3654 info->nl_does_cr = TRUE;
3655 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003658 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659}
3660
Bram Moolenaar0f873732019-12-05 20:28:46 +01003661#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003663static int mouse_ison = FALSE;
3664
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665/*
3666 * Set mouse clicks on or off.
3667 */
3668 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003669mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003671#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003672 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003673#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 int xterm_mouse_vers;
3675
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003676#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003677 if (!on)
3678 // Make sure not tracing mouse movements. Important when a button-down
3679 // was received but no release yet.
3680 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003681#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003682
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003683 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003684#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003685 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003686#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003687 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003688 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 return;
3690
3691 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003692
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003693#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003694 if (ttym_flags == TTYM_URXVT)
3695 {
Bram Moolenaarc8427482011-10-20 21:09:35 +02003696 out_str_nf((char_u *)
3697 (on
3698 ? IF_EB("\033[?1015h", ESC_STR "[?1015h")
3699 : IF_EB("\033[?1015l", ESC_STR "[?1015l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003700 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003701 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003702#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003703
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003704 if (ttym_flags == TTYM_SGR)
3705 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003706 // SGR mode supports columns above 223
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003707 out_str_nf((char_u *)
3708 (on
3709 ? IF_EB("\033[?1006h", ESC_STR "[?1006h")
3710 : IF_EB("\033[?1006l", ESC_STR "[?1006l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003711 mouse_ison = on;
3712 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003713
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003714#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003715 if (bevalterm_ison != (p_bevalterm && on))
3716 {
3717 bevalterm_ison = (p_bevalterm && on);
3718 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003719 // disable mouse movement events, enabling is below
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003720 out_str_nf((char_u *)
3721 (IF_EB("\033[?1003l", ESC_STR "[?1003l")));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003722 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003723#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003724
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 if (xterm_mouse_vers > 0)
3726 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003727 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 out_str_nf((char_u *)
3729 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003730 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003731#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003732 bevalterm_ison
3733 ? IF_EB("\033[?1003h", ESC_STR "[?1003h") :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003734#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003735 IF_EB("\033[?1002h", ESC_STR "[?1002h"))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 : IF_EB("\033[?1000h", ESC_STR "[?1000h")));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003737 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 out_str_nf((char_u *)
3739 (xterm_mouse_vers > 1
3740 ? IF_EB("\033[?1002l", ESC_STR "[?1002l")
3741 : IF_EB("\033[?1000l", ESC_STR "[?1000l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003742 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 }
3744
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003745#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 else if (ttym_flags == TTYM_DEC)
3747 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003748 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003750 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003752 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003754#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003756#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 else
3758 {
3759 if (on)
3760 {
3761 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003762 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 }
3764 else
3765 {
3766 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003767 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 }
3769 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003770#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003772#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003773 else
3774 {
3775 if (on)
3776 {
3777 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003778 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003779 }
3780 else
3781 {
3782 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003783 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003784 }
3785 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003786#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003787
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003788#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 else
3790 {
3791 if (on)
3792 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003793 // D - Enable Mouse up/down messages
3794 // L - Enable Left Button Reporting
3795 // M - Enable Middle Button Reporting
3796 // R - Enable Right Button Reporting
3797 // K - Enable SHIFT and CTRL key Reporting
3798 // + - Enable Advanced messaging of mouse moves and up/down messages
3799 // Q - Quiet No Ack
3800 // # - Numeric value of mouse pointer required
3801 // 0 = Multiview 2000 cursor, used as standard
3802 // 1 = Windows Arrow
3803 // 2 = Windows I Beam
3804 // 3 = Windows Hour Glass
3805 // 4 = Windows Cross Hair
3806 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003807# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003808 // Disables full feedback of pointer movements
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 out_str_nf((char_u *)IF_EB("\033[0~ZwLMRK1Q\033\\",
3810 ESC_STR "[0~ZwLMRK1Q" ESC_STR "\\"));
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003811# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 out_str_nf((char_u *)IF_EB("\033[0~ZwLMRK+1Q\033\\",
3813 ESC_STR "[0~ZwLMRK+1Q" ESC_STR "\\"));
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003814# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003815 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 }
3817 else
3818 {
3819 out_str_nf((char_u *)IF_EB("\033[0~ZwQ\033\\",
3820 ESC_STR "[0~ZwQ" ESC_STR "\\"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003821 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 }
3823 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003824#endif
3825#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 else
3827 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003828 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 if (on)
3830 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3831 else
3832 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003833 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003835#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836}
3837
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003838#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003839/*
3840 * Called when 'balloonevalterm' changed.
3841 */
3842 void
3843mch_bevalterm_changed(void)
3844{
3845 mch_setmouse(mouse_ison);
3846}
3847#endif
3848
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849/*
3850 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3851 */
3852 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003853check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854{
3855# ifdef FEAT_MOUSE_XTERM
3856 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003857# ifdef FEAT_MOUSE_URXVT
3858 && use_xterm_mouse() != 3
3859# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860# ifdef FEAT_GUI
3861 && !gui.in_use
3862# endif
3863 )
3864 {
3865 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003866 ? IF_EB("\233M", CSI_STR "M")
3867 : IF_EB("\033[M", ESC_STR "[M")));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 if (*p_mouse != NUL)
3869 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003870 // force mouse off and maybe on to send possibly new mouse
3871 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 mch_setmouse(FALSE);
3873 setmouse();
3874 }
3875 }
3876 else
3877 del_mouse_termcode(KS_MOUSE);
3878# endif
3879
3880# ifdef FEAT_MOUSE_GPM
3881 if (!use_xterm_mouse()
3882# ifdef FEAT_GUI
3883 && !gui.in_use
3884# endif
3885 )
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003886 set_mouse_termcode(KS_GPM_MOUSE,
3887 (char_u *)IF_EB("\033MG", ESC_STR "MG"));
3888 else
3889 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890# endif
3891
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003892# ifdef FEAT_SYSMOUSE
3893 if (!use_xterm_mouse()
3894# ifdef FEAT_GUI
3895 && !gui.in_use
3896# endif
3897 )
3898 set_mouse_termcode(KS_MOUSE, (char_u *)IF_EB("\033MS", ESC_STR "MS"));
3899# endif
3900
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003902 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 if (!use_xterm_mouse()
3904# ifdef FEAT_GUI
3905 && !gui.in_use
3906# endif
3907 )
3908 set_mouse_termcode(KS_JSBTERM_MOUSE,
3909 (char_u *)IF_EB("\033[0~zw", ESC_STR "[0~zw"));
3910 else
3911 del_mouse_termcode(KS_JSBTERM_MOUSE);
3912# endif
3913
3914# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003915 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3916 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 if (!use_xterm_mouse()
3918# ifdef FEAT_GUI
3919 && !gui.in_use
3920# endif
3921 )
3922 set_mouse_termcode(KS_NETTERM_MOUSE,
3923 (char_u *)IF_EB("\033}", ESC_STR "}"));
3924 else
3925 del_mouse_termcode(KS_NETTERM_MOUSE);
3926# endif
3927
3928# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01003929 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003930 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931# ifdef FEAT_GUI
3932 && !gui.in_use
3933# endif
3934 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003935 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
3936 ? IF_EB("\233", CSI_STR) : IF_EB("\033[", ESC_STR "[")));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 else
3938 del_mouse_termcode(KS_DEC_MOUSE);
3939# endif
3940# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01003941 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003942 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943# ifdef FEAT_GUI
3944 && !gui.in_use
3945# endif
3946 )
3947 set_mouse_termcode(KS_PTERM_MOUSE,
3948 (char_u *) IF_EB("\033[", ESC_STR "["));
3949 else
3950 del_mouse_termcode(KS_PTERM_MOUSE);
3951# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003952# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003953 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02003954# ifdef FEAT_GUI
3955 && !gui.in_use
3956# endif
3957 )
3958 {
3959 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaara529ce02017-06-22 22:37:57 +02003960 ? IF_EB("\233*M", CSI_STR "*M")
3961 : IF_EB("\033[*M", ESC_STR "[*M")));
Bram Moolenaarc8427482011-10-20 21:09:35 +02003962
3963 if (*p_mouse != NUL)
3964 {
3965 mch_setmouse(FALSE);
3966 setmouse();
3967 }
3968 }
3969 else
3970 del_mouse_termcode(KS_URXVT_MOUSE);
3971# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003972 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01003973# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003974 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01003975# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003976 )
3977 {
3978 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaara529ce02017-06-22 22:37:57 +02003979 ? IF_EB("\233<*M", CSI_STR "<*M")
3980 : IF_EB("\033[<*M", ESC_STR "[<*M")));
3981
3982 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
3983 ? IF_EB("\233<*m", CSI_STR "<*m")
3984 : IF_EB("\033[<*m", ESC_STR "[<*m")));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003985
3986 if (*p_mouse != NUL)
3987 {
3988 mch_setmouse(FALSE);
3989 setmouse();
3990 }
3991 }
3992 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02003993 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003994 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02003995 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
3996 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999#ifndef VMS
4000
4001/*
4002 * Try to get the current window size:
4003 * 1. with an ioctl(), most accurate method
4004 * 2. from the environment variables LINES and COLUMNS
4005 * 3. from the termcap
4006 * 4. keep using the old values
4007 * Return OK when size could be determined, FAIL otherwise.
4008 */
4009 int
Bram Moolenaar05540972016-01-30 20:31:25 +01004010mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011{
4012 long rows = 0;
4013 long columns = 0;
4014 char_u *p;
4015
4016 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 * 1. try using an ioctl. It is the most accurate method.
4018 *
4019 * Try using TIOCGWINSZ first, some systems that have it also define
4020 * TIOCGSIZE but don't have a struct ttysize.
4021 */
4022# ifdef TIOCGWINSZ
4023 {
4024 struct winsize ws;
4025 int fd = 1;
4026
Bram Moolenaar0f873732019-12-05 20:28:46 +01004027 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 if (!isatty(fd) && isatty(read_cmd_fd))
4029 fd = read_cmd_fd;
4030 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
4031 {
4032 columns = ws.ws_col;
4033 rows = ws.ws_row;
4034 }
4035 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004036# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037# ifdef TIOCGSIZE
4038 {
4039 struct ttysize ts;
4040 int fd = 1;
4041
Bram Moolenaar0f873732019-12-05 20:28:46 +01004042 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 if (!isatty(fd) && isatty(read_cmd_fd))
4044 fd = read_cmd_fd;
4045 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
4046 {
4047 columns = ts.ts_cols;
4048 rows = ts.ts_lines;
4049 }
4050 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004051# endif // TIOCGSIZE
4052# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053
4054 /*
4055 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004056 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
4057 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004059 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 {
4061 if ((p = (char_u *)getenv("LINES")))
4062 rows = atoi((char *)p);
4063 if ((p = (char_u *)getenv("COLUMNS")))
4064 columns = atoi((char *)p);
4065 }
4066
4067#ifdef HAVE_TGETENT
4068 /*
4069 * 3. try reading "co" and "li" entries from termcap
4070 */
4071 if (columns == 0 || rows == 0)
4072 getlinecol(&columns, &rows);
4073#endif
4074
4075 /*
4076 * 4. If everything fails, use the old values
4077 */
4078 if (columns <= 0 || rows <= 0)
4079 return FAIL;
4080
4081 Rows = rows;
4082 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004083 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 return OK;
4085}
4086
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004087#if defined(FEAT_TERMINAL) || defined(PROTO)
4088/*
4089 * Report the windows size "rows" and "cols" to tty "fd".
4090 */
4091 int
4092mch_report_winsize(int fd, int rows, int cols)
4093{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004094 int tty_fd;
4095 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004096
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004097 tty_fd = get_tty_fd(fd);
4098 if (tty_fd >= 0)
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004099 {
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004100# if defined(TIOCSWINSZ)
4101 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004102
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004103 ws.ws_col = cols;
4104 ws.ws_row = rows;
4105 ws.ws_xpixel = cols * 5;
4106 ws.ws_ypixel = rows * 10;
4107 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4108 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4109 retval == 0 ? "success" : "failed");
4110# elif defined(TIOCSSIZE)
4111 struct ttysize ts;
4112
4113 ts.ts_cols = cols;
4114 ts.ts_lines = rows;
4115 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4116 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4117 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004118# endif
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004119 if (tty_fd != fd)
4120 close(tty_fd);
4121 }
4122 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004123}
4124#endif
4125
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126/*
4127 * Try to set the window size to Rows and Columns.
4128 */
4129 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004130mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131{
4132 if (*T_CWS)
4133 {
4134 /*
4135 * NOTE: if you get an error here that term_set_winsize() is
4136 * undefined, check the output of configure. It could probably not
4137 * find a ncurses, termcap or termlib library.
4138 */
4139 term_set_winsize((int)Rows, (int)Columns);
4140 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004141 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 }
4143}
4144
Bram Moolenaar0f873732019-12-05 20:28:46 +01004145#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146
4147/*
4148 * Rows and/or Columns has changed.
4149 */
4150 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004151mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004153 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154}
4155
Bram Moolenaar205b8862011-09-07 15:04:31 +02004156/*
4157 * Wait for process "child" to end.
4158 * Return "child" if it exited properly, <= 0 on error.
4159 */
4160 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004161wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004162{
4163 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004164 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004165
4166 while (wait_pid != child)
4167 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004168 // When compiled with Python threads are probably used, in which case
4169 // wait() sometimes hangs for no obvious reason. Use waitpid()
4170 // instead and loop (like the GUI). Also needed for other interfaces,
4171 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004172# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004173 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004174# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004175 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004176# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004177 if (wait_pid == 0)
4178 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004179 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0981c872020-08-23 14:28:37 +02004180 mch_delay(delay_msec, MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004181 if (++delay_msec > 10)
4182 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004183 continue;
4184 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004185 if (wait_pid <= 0
4186# ifdef ECHILD
4187 && errno == ECHILD
4188# endif
4189 )
4190 break;
4191 }
4192 return wait_pid;
4193}
4194
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004195#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004196/*
4197 * Set the environment for a child process.
4198 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004199 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004200set_child_environment(
4201 long rows,
4202 long columns,
4203 char *term,
4204 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004205{
4206# ifdef HAVE_SETENV
4207 char envbuf[50];
4208# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004209 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004210 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004211 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004212 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004213 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004214# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004215 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004216# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004217# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004218 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004219# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004220# endif
4221
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004222# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004223 setenv("TERM", term, 1);
4224 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004225 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004226 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004227 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004228 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004229 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaar759d8152020-04-26 16:52:49 +02004230 sprintf((char *)envbuf, "%d", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004231 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004232# ifdef FEAT_TERMINAL
4233 if (is_terminal)
4234 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004235 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004236 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4237 }
4238# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004239# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004240 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004241# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004242# else
4243 /*
4244 * Putenv does not copy the string, it has to remain valid.
4245 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004246 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004247 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004248 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4249 putenv(envbuf_Term);
4250 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004251 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004252 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4253 putenv(envbuf_Lines);
4254 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4255 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004256 putenv(envbuf_Columns);
Bram Moolenaaraffc8fd2020-04-28 21:58:29 +02004257 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", t_colors);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004258 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004259# ifdef FEAT_TERMINAL
4260 if (is_terminal)
4261 {
4262 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004263 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004264 putenv(envbuf_Version);
4265 }
4266# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004267# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004268 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4269 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4270 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004271# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004272# endif
4273}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004274
4275 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004276set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004277{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004278 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004279}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004280#endif
4281
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004282#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004283/*
4284 * Open a PTY, with FD for the master and slave side.
4285 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004286 * When successful both file descriptors are stored and the allocated pty name
4287 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004288 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004289 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004290open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004291{
4292 char *tty_name;
4293
Bram Moolenaar59386482019-02-10 22:43:46 +01004294 if (name1 != NULL)
4295 *name1 = NULL;
4296 if (name2 != NULL)
4297 *name2 = NULL;
4298
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004299 *pty_master_fd = mch_openpty(&tty_name); // open pty
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004300 if (*pty_master_fd >= 0)
4301 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004302 // Leaving out O_NOCTTY may lead to waitpid() always returning
4303 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4304 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004305#ifdef O_NOCTTY
4306 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
4307#else
4308 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
4309#endif
4310 if (*pty_slave_fd < 0)
4311 {
4312 close(*pty_master_fd);
4313 *pty_master_fd = -1;
4314 }
Bram Moolenaar59386482019-02-10 22:43:46 +01004315 else
4316 {
4317 if (name1 != NULL)
4318 *name1 = vim_strsave((char_u *)tty_name);
4319 if (name2 != NULL)
4320 *name2 = vim_strsave((char_u *)tty_name);
4321 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004322 }
4323}
4324#endif
4325
Bram Moolenaarfae42832017-08-01 22:24:26 +02004326/*
4327 * Send SIGINT to a child process if "c" is an interrupt character.
4328 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004329 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004330may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4331{
4332# ifdef SIGINT
4333 if (c == Ctrl_C || c == intr_char)
4334 {
4335# ifdef HAVE_SETSID
4336 kill(-pid, SIGINT);
4337# else
4338 kill(0, SIGINT);
4339# endif
4340 if (wpid > 0)
4341 kill(wpid, SIGINT);
4342 }
4343# endif
4344}
4345
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004346#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004347
Bram Moolenaar0f873732019-12-05 20:28:46 +01004348/*
4349 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4350 * pointers, the last one is NULL.
4351 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4352 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004353 int
4354unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004355 char_u *cmd,
4356 char ***argvp,
4357 char_u **sh_tofree,
4358 char_u **shcf_tofree)
4359{
4360 char **argv = NULL;
4361 int argc;
4362
4363 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004364 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004365 return FAIL;
4366
4367 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4368 return FAIL;
4369 *argvp = argv;
4370
4371 if (cmd != NULL)
4372 {
4373 char_u *s;
4374 char_u *p;
4375
4376 if (extra_shell_arg != NULL)
4377 argv[argc++] = (char *)extra_shell_arg;
4378
Bram Moolenaar0f873732019-12-05 20:28:46 +01004379 // Break 'shellcmdflag' into white separated parts. This doesn't
4380 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004381 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004382 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004383 return FAIL;
4384 s = *shcf_tofree;
4385 p = p_shcf;
4386 while (*p != NUL)
4387 {
4388 argv[argc++] = (char *)s;
4389 while (*p && *p != ' ' && *p != TAB)
4390 *s++ = *p++;
4391 *s++ = NUL;
4392 p = skipwhite(p);
4393 }
4394
4395 argv[argc++] = (char *)cmd;
4396 }
4397 argv[argc] = NULL;
4398 return OK;
4399}
4400#endif
4401
4402#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4403/*
4404 * Use a terminal window to run a shell command in.
4405 */
4406 static int
4407mch_call_shell_terminal(
4408 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004409 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004410{
4411 jobopt_T opt;
4412 char **argv = NULL;
4413 char_u *tofree1 = NULL;
4414 char_u *tofree2 = NULL;
4415 int retval = -1;
4416 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004417 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004418 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004419 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004420
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004421 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004422 goto theend;
4423
4424 init_job_options(&opt);
4425 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4426 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004427 if (buf == NULL)
4428 goto theend;
4429
4430 job = term_getjob(buf->b_term);
4431 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004432
Bram Moolenaar0f873732019-12-05 20:28:46 +01004433 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004434 aucmd_prepbuf(&aco, buf);
4435
4436 clear_oparg(&oa);
4437 while (term_use_loop())
4438 {
4439 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4440 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004441 // If terminal_loop() returns OK we got a key that is handled
4442 // in Normal model. We don't do redrawing anyway.
Bram Moolenaar13568252018-03-16 20:46:58 +01004443 if (terminal_loop(TRUE) == OK)
4444 normal_cmd(&oa, TRUE);
4445 }
4446 else
4447 normal_cmd(&oa, TRUE);
4448 }
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004449 retval = job->jv_exitval;
Bram Moolenaar13568252018-03-16 20:46:58 +01004450 ch_log(NULL, "system command finished");
4451
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004452 job_unref(job);
4453
Bram Moolenaar0f873732019-12-05 20:28:46 +01004454 // restore curwin/curbuf and a few other things
Bram Moolenaar13568252018-03-16 20:46:58 +01004455 aucmd_restbuf(&aco);
4456
4457 wait_return(TRUE);
4458 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4459
4460theend:
4461 vim_free(argv);
4462 vim_free(tofree1);
4463 vim_free(tofree2);
4464 return retval;
4465}
4466#endif
4467
4468#ifdef USE_SYSTEM
4469/*
4470 * Use system() to start the shell: simple but slow.
4471 */
4472 static int
4473mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004474 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004475 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476{
4477#ifdef VMS
4478 char *ifn = NULL;
4479 char *ofn = NULL;
4480#endif
Bram Moolenaar26e86442020-05-17 14:06:16 +02004481 tmode_T tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004482 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004483 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484
4485 out_flush();
4486
4487 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004488 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
Bram Moolenaar62b42182010-09-21 22:09:37 +02004490# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004491 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004492 loose_clipboard();
4493# endif
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 if (cmd == NULL)
4496 x = system((char *)p_sh);
4497 else
4498 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004499# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 if (ofn = strchr((char *)cmd, '>'))
4501 *ofn++ = '\0';
4502 if (ifn = strchr((char *)cmd, '<'))
4503 {
4504 char *p;
4505
4506 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004507 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 if (p)
4509 *p = '\0';
4510 }
4511 if (ofn)
4512 x = vms_sys((char *)cmd, ofn, ifn);
4513 else
4514 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004515# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004516 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004518 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 if (newcmd == NULL)
4520 x = 0;
4521 else
4522 {
4523 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4524 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4525 (char *)p_shcf,
4526 (char *)cmd);
4527 x = system((char *)newcmd);
4528 vim_free(newcmd);
4529 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004530# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 }
4532# ifdef VMS
4533 x = vms_sys_status(x);
4534# endif
4535 if (emsg_silent)
4536 ;
4537 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004538 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 else if (x && !(options & SHELL_SILENT))
4540 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004541 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 msg_outnum((long)x);
4543 msg_putchar('\n');
4544 }
4545
4546 if (tmode == TMODE_RAW)
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004547 {
4548 // The shell may have messed with the mode, always set it.
4549 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004550 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004551 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552# ifdef FEAT_TITLE
4553 resettitle();
4554# endif
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004555# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4556 restore_clipboard();
4557# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004559}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
Bram Moolenaar0f873732019-12-05 20:28:46 +01004561#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
Bram Moolenaar0f873732019-12-05 20:28:46 +01004563# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4564 // 127, some shells use that already
4565# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566
Bram Moolenaar13568252018-03-16 20:46:58 +01004567/*
4568 * Don't use system(), use fork()/exec().
4569 */
4570 static int
4571mch_call_shell_fork(
4572 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004573 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004574{
Bram Moolenaar26e86442020-05-17 14:06:16 +02004575 tmode_T tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004577 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 pid_t wait_pid = 0;
4579# ifdef HAVE_UNION_WAIT
4580 union wait status;
4581# else
4582 int status = -1;
4583# endif
4584 int retval = -1;
4585 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004586 char_u *tofree1 = NULL;
4587 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004589 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004590# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004592# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004593 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 int fd_fromshell[2];
4595 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004596 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597
4598 out_flush();
4599 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004600 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar3b1f18f2020-05-16 23:15:08 +02004601 if (tmode == TMODE_RAW)
4602 // The shell may have messed with the mode, always set it later.
4603 cur_tmode = TMODE_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004605 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004606 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004607
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004609 * For the GUI, when writing the output into the buffer and when reading
4610 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4611 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004613 if ((options & (SHELL_READ|SHELL_WRITE))
4614# ifdef FEAT_GUI
4615 || (gui.in_use && show_shell_mess)
4616# endif
4617 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004619# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 /*
4621 * Try to open a master pty.
4622 * If this works, open the slave pty.
4623 * If the slave can't be opened, close the master pty.
4624 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004625 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004626 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 /*
4628 * If not opening a pty or it didn't work, try using pipes.
4629 */
4630 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004631# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 {
4633 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004634 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 {
4636 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004637 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 {
4639 close(fd_toshell[0]);
4640 close(fd_toshell[1]);
4641 }
4642 }
4643 if (pipe_error)
4644 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004645 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 out_flush();
4647 }
4648 }
4649 }
4650
Bram Moolenaar0f873732019-12-05 20:28:46 +01004651 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004653 SIGSET_DECL(curset)
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004654 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004655 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004656 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004658 UNBLOCK_SIGNALS(&curset);
4659
Bram Moolenaar32526b32019-01-19 17:43:09 +01004660 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004661 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004663 || (gui.in_use && show_shell_mess)
4664# endif
4665 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004667# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004668 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 {
4670 close(pty_master_fd);
4671 close(pty_slave_fd);
4672 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004673 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004674# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 {
4676 close(fd_toshell[0]);
4677 close(fd_toshell[1]);
4678 close(fd_fromshell[0]);
4679 close(fd_fromshell[1]);
4680 }
4681 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004683 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004685 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004686 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687
Bram Moolenaar819524702018-02-27 19:10:00 +01004688# ifdef FEAT_JOB_CHANNEL
4689 if (ch_log_active())
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004690 {
4691 ch_log(NULL, "closing channel log in the child process");
Bram Moolenaar819524702018-02-27 19:10:00 +01004692 ch_logfile((char_u *)"", (char_u *)"");
Bram Moolenaar76603ba2020-08-30 17:24:37 +02004693 }
Bram Moolenaar819524702018-02-27 19:10:00 +01004694# endif
4695
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 if (!show_shell_mess || (options & SHELL_EXPAND))
4697 {
4698 int fd;
4699
4700 /*
4701 * Don't want to show any message from the shell. Can't just
4702 * close stdout and stderr though, because some systems will
4703 * break if you try to write to them after that, so we must
4704 * use dup() to replace them with something else -- webb
4705 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4706 * waiting for input.
4707 */
4708 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4709 fclose(stdin);
4710 fclose(stdout);
4711 fclose(stderr);
4712
4713 /*
4714 * If any of these open()'s and dup()'s fail, we just continue
4715 * anyway. It's not fatal, and on most systems it will make
4716 * no difference at all. On a few it will cause the execvp()
4717 * to exit with a non-zero status even when the completion
4718 * could be done, which is nothing too serious. If the open()
4719 * or dup() failed we'd just do the same thing ourselves
4720 * anyway -- webb
4721 */
4722 if (fd >= 0)
4723 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004724 vim_ignored = dup(fd); // To replace stdin (fd 0)
4725 vim_ignored = dup(fd); // To replace stdout (fd 1)
4726 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727
Bram Moolenaar0f873732019-12-05 20:28:46 +01004728 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 close(fd);
4730 }
4731 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004732 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004734 || gui.in_use
4735# endif
4736 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 {
4738
Bram Moolenaardf177f62005-02-22 08:39:57 +00004739# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004740 // Create our own process group, so that the child and all its
4741 // children can be kill()ed. Don't do this when using pipes,
4742 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004743 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004744 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004745 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004746# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004747 // When doing "!xterm&" and 'shell' is bash: the shell
4748 // will exit and send SIGHUP to all processes in its
4749 // group, killing the just started process. Ignore SIGHUP
4750 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004751 signal(SIGHUP, SIG_IGN);
4752# endif
4753 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004754# endif
4755# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004756 if (pty_slave_fd >= 0)
4757 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004758 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004759 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004760 setup_slavepty(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01004762 // Try to become controlling tty (probably doesn't work,
4763 // unless run by root)
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004764 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004766 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004767# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004768 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769
Bram Moolenaara5792f52005-11-23 21:25:05 +00004770 /*
4771 * stderr is only redirected when using the GUI, so that a
4772 * program like gpg can still access the terminal to get a
4773 * passphrase using stderr.
4774 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004775# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 if (pty_master_fd >= 0)
4777 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004778 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779
Bram Moolenaar0f873732019-12-05 20:28:46 +01004780 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004782 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004784 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004785 if (gui.in_use)
4786 {
4787 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004788 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004789 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790
Bram Moolenaar0f873732019-12-05 20:28:46 +01004791 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 }
4793 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004794# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004796 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 close(fd_toshell[1]);
4798 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004799 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 close(fd_toshell[0]);
4801
Bram Moolenaar0f873732019-12-05 20:28:46 +01004802 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 close(fd_fromshell[0]);
4804 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004805 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 close(fd_fromshell[1]);
4807
Bram Moolenaara5792f52005-11-23 21:25:05 +00004808# ifdef FEAT_GUI
4809 if (gui.in_use)
4810 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004811 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004812 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004813 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004814 }
4815# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 }
4817 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004818
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 /*
4820 * There is no type cast for the argv, because the type may be
4821 * different on different machines. This may cause a warning
4822 * message with strict compilers, don't worry about it.
4823 * Call _exit() instead of exit() to avoid closing the connection
4824 * to the X server (esp. with GTK, which uses atexit()).
4825 */
4826 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004827 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004829 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 {
4831 /*
4832 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004833 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 */
4835 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004836 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004837 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004838# ifdef FEAT_JOB_CHANNEL
4839 ++dont_check_job_ended;
4840# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 /*
4842 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004843 * This is also used to pipe stdin/stdout to/from the external
4844 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004846 if ((options & (SHELL_READ|SHELL_WRITE))
4847# ifdef FEAT_GUI
4848 || (gui.in_use && show_shell_mess)
4849# endif
4850 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004852# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004854 int buffer_off = 0; // valid bytes in buffer[]
4855 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4856 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 int len;
4858 int p_more_save;
4859 int old_State;
4860 int c;
4861 int toshell_fd;
4862 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004863 garray_T ga;
4864 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004865# ifdef ELAPSED_FUNC
4866 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004867# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868
Bram Moolenaardf177f62005-02-22 08:39:57 +00004869# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 if (pty_master_fd >= 0)
4871 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 fromshell_fd = pty_master_fd;
4873 toshell_fd = dup(pty_master_fd);
4874 }
4875 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004876# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 {
4878 close(fd_toshell[0]);
4879 close(fd_fromshell[1]);
4880 toshell_fd = fd_toshell[1];
4881 fromshell_fd = fd_fromshell[0];
4882 }
4883
4884 /*
4885 * Write to the child if there are typed characters.
4886 * Read from the child if there are characters available.
4887 * Repeat the reading a few times if more characters are
4888 * available. Need to check for typed keys now and then, but
4889 * not too often (delays when no chars are available).
4890 * This loop is quit if no characters can be read from the pty
4891 * (WaitForChar detected special condition), or there are no
4892 * characters available and the child has exited.
4893 * Only check if the child has exited when there is no more
4894 * output. The child may exit before all the output has
4895 * been printed.
4896 *
4897 * Currently this busy loops!
4898 * This can probably dead-lock when the write blocks!
4899 */
4900 p_more_save = p_more;
4901 p_more = FALSE;
4902 old_State = State;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004903 State = EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004905 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004906 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004907 // Fork a process that will write the lines to the
4908 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004909 if ((wpid = fork()) == -1)
4910 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004911 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004912 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004913 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004914 {
4915 linenr_T lnum = curbuf->b_op_start.lnum;
4916 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004917 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004918 size_t l;
4919
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004920 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004921 for (;;)
4922 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00004923 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004924 if (l == 0)
4925 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004926 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004927 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00004928 len = write(toshell_fd, "", (size_t)1);
4929 else
4930 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01004931 char_u *s = vim_strchr(lp + written, NL);
4932
Bram Moolenaar89d40322006-08-29 15:30:07 +00004933 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00004934 s == NULL ? l
4935 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004936 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00004937 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004938 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004939 // Finished a line, add a NL, unless this line
4940 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004941 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02004942 || (!curbuf->b_p_bin
4943 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01004944 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaardf177f62005-02-22 08:39:57 +00004945 && (lnum !=
4946 curbuf->b_ml.ml_line_count
4947 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02004948 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004949 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004950 ++lnum;
4951 if (lnum > curbuf->b_op_end.lnum)
4952 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004953 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00004954 close(toshell_fd);
4955 toshell_fd = -1;
4956 break;
4957 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00004958 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004959 written = 0;
4960 }
4961 else if (len > 0)
4962 written += len;
4963 }
4964 _exit(0);
4965 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004966 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00004967 {
4968 close(toshell_fd);
4969 toshell_fd = -1;
4970 }
4971 }
4972
4973 if (options & SHELL_READ)
4974 ga_init2(&ga, 1, BUFLEN);
4975
4976 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01004977# ifdef ELAPSED_FUNC
4978 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004979# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 for (;;)
4981 {
4982 /*
4983 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004984 * if there are any.
4985 * Don't do this if we are expanding wild cards (would eat
4986 * typeahead).
4987 * Don't do this when filtering and terminal is in cooked
4988 * mode, the shell command will handle the I/O. Avoids
4989 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004990 * Don't get characters when the child has already
4991 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00004992 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004993 * while (noread_cnt > 4), avoids that ":r !ls" eats
4994 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 */
4996 len = 0;
4997 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004998 && ((options &
4999 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
5000 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005001# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005002 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005003# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00005004 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005005 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005006 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005008 if (ta_len == 0)
5009 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005010 // Get extra characters when we don't have any.
5011 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005012 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005013# ifdef ELAPSED_FUNC
5014 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005015# endif
5016 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
5017 }
5018 if (ta_len > 0 || len > 0)
5019 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 /*
5021 * For pipes:
5022 * Check for CTRL-C: send interrupt signal to child.
5023 * Check for CTRL-D: EOF, close pipe to child.
5024 */
5025 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
5026 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 /*
5028 * Send SIGINT to the child's group or all
5029 * processes in our group.
5030 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02005031 may_send_sigint(ta_buf[ta_len], pid, wpid);
5032
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 if (pty_master_fd < 0 && toshell_fd >= 0
5034 && ta_buf[ta_len] == Ctrl_D)
5035 {
5036 close(toshell_fd);
5037 toshell_fd = -1;
5038 }
5039 }
5040
Bram Moolenaarf4140482020-02-15 23:06:45 +01005041 term_replace_bs_del_keycode(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
5043 /*
5044 * For pipes: echo the typed characters.
5045 * For a pty this does not seem to work.
5046 */
5047 if (pty_master_fd < 0)
5048 {
5049 for (i = ta_len; i < ta_len + len; ++i)
5050 {
5051 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5052 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 else if (has_mbyte)
5054 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005055 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056
5057 msg_outtrans_len(ta_buf + i, l);
5058 i += l - 1;
5059 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 else
5061 msg_outtrans_len(ta_buf + i, 1);
5062 }
5063 windgoto(msg_row, msg_col);
5064 out_flush();
5065 }
5066
5067 ta_len += len;
5068
5069 /*
5070 * Write the characters to the child, unless EOF has
5071 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005072 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005073 * When writing buffer lines, drop the typed
5074 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005076 if (options & SHELL_WRITE)
5077 ta_len = 0;
5078 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 {
5080 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5081 if (len > 0)
5082 {
5083 ta_len -= len;
5084 mch_memmove(ta_buf, ta_buf + len, ta_len);
5085 }
5086 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005087 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 }
5089
Bram Moolenaardf177f62005-02-22 08:39:57 +00005090 if (got_int)
5091 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005092 // CTRL-C sends a signal to the child, we ignore it
5093 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005094# ifdef HAVE_SETSID
5095 kill(-pid, SIGINT);
5096# else
5097 kill(0, SIGINT);
5098# endif
5099 if (wpid > 0)
5100 kill(wpid, SIGINT);
5101 got_int = FALSE;
5102 }
5103
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 /*
5105 * Check if the child has any characters to be printed.
5106 * Read them and write them to our window. Repeat this as
5107 * long as there is something to do, avoid the 10ms wait
5108 * for mch_inchar(), or sending typeahead characters to
5109 * the external process.
5110 * TODO: This should handle escape sequences, compatible
5111 * to some terminal (vt52?).
5112 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005113 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005114 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005116 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005119 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005121
5122 noread_cnt = 0;
5123 if (options & SHELL_READ)
5124 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005125 // Do NUL -> NL translation, append NL separated
5126 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005127 for (i = 0; i < len; ++i)
5128 {
5129 if (buffer[i] == NL)
5130 append_ga_line(&ga);
5131 else if (buffer[i] == NUL)
5132 ga_append(&ga, NL);
5133 else
5134 ga_append(&ga, buffer[i]);
5135 }
5136 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005137 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 {
5139 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005140 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141
Bram Moolenaardf177f62005-02-22 08:39:57 +00005142 len += buffer_off;
5143 buffer[len] = NUL;
5144
Bram Moolenaar0f873732019-12-05 20:28:46 +01005145 // Check if the last character in buffer[] is
5146 // incomplete, keep these bytes for the next
5147 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 for (p = buffer; p < buffer + len; p += l)
5149 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005150 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005152 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 else if (MB_BYTE2LEN(*p) != l)
5154 break;
5155 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005156 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005158 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 if (len >= 12)
5160 ++p;
5161 else
5162 {
5163 buffer_off = len;
5164 continue;
5165 }
5166 }
5167 c = *p;
5168 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005169 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 if (p < buffer + len)
5171 {
5172 *p = c;
5173 buffer_off = (buffer + len) - p;
5174 mch_memmove(buffer, p, buffer_off);
5175 continue;
5176 }
5177 buffer_off = 0;
5178 }
5179 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 {
5181 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005182 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 }
5184
5185 windgoto(msg_row, msg_col);
5186 cursor_on();
5187 out_flush();
5188 if (got_int)
5189 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005190
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005191# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005192 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005193 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005194 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005195
Bram Moolenaar0f873732019-12-05 20:28:46 +01005196 // Avoid that we keep looping here without
5197 // checking for a CTRL-C for a long time. Don't
5198 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005199 if (msec > 2000)
5200 {
5201 noread_cnt = 5;
5202 break;
5203 }
5204 }
5205# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 }
5207
Bram Moolenaar0f873732019-12-05 20:28:46 +01005208 // If we already detected the child has finished, continue
5209 // reading output for a short while. Some text may be
5210 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005211 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005212 {
5213 if (noread_cnt < 5)
5214 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005215 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005216 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005217
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 /*
5219 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005220 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005222# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005223 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005224# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005226# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5228 || (wait_pid == pid && WIFEXITED(status)))
5229 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005230 // Don't break the loop yet, try reading more
5231 // characters from "fromshell_fd" first. When using
5232 // pipes there might still be something to read and
5233 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005236 else
5237 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005238
Bram Moolenaar95a51352013-03-21 22:53:50 +01005239# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005240 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005241 clip_update();
5242# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 }
5244finished:
5245 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005246 if (options & SHELL_READ)
5247 {
5248 if (ga.ga_len > 0)
5249 {
5250 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005251 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005252 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005253 }
5254 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005255 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005256 ga_clear(&ga);
5257 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 /*
5260 * Give all typeahead that wasn't used back to ui_inchar().
5261 */
5262 if (ta_len)
5263 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 State = old_State;
5265 if (toshell_fd >= 0)
5266 close(toshell_fd);
5267 close(fromshell_fd);
5268 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005269# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005270 else
5271 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005272 long delay_msec = 1;
5273
Bram Moolenaar0981c872020-08-23 14:28:37 +02005274 out_str(T_CTE); // possibly disables modifyOtherKeys, so that
5275 // the system can recognize CTRL-C
5276
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005277 /*
5278 * Similar to the loop above, but only handle X events, no
5279 * I/O.
5280 */
5281 for (;;)
5282 {
5283 if (got_int)
5284 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005285 // CTRL-C sends a signal to the child, we ignore it
5286 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005287# ifdef HAVE_SETSID
5288 kill(-pid, SIGINT);
5289# else
5290 kill(0, SIGINT);
5291# endif
5292 got_int = FALSE;
5293 }
5294# ifdef __NeXT__
5295 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5296# else
5297 wait_pid = waitpid(pid, &status, WNOHANG);
5298# endif
5299 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5300 || (wait_pid == pid && WIFEXITED(status)))
5301 {
5302 wait_pid = pid;
5303 break;
5304 }
5305
Bram Moolenaar0f873732019-12-05 20:28:46 +01005306 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005307 clip_update();
5308
Bram Moolenaar0f873732019-12-05 20:28:46 +01005309 // Wait for 1 to 10 msec. 1 is faster but gives the child
Bram Moolenaar0981c872020-08-23 14:28:37 +02005310 // less time, gradually wait longer.
5311 mch_delay(delay_msec,
5312 MCH_DELAY_IGNOREINPUT | MCH_DELAY_SETTMODE);
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005313 if (++delay_msec > 10)
5314 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005315 }
Bram Moolenaar0981c872020-08-23 14:28:37 +02005316
5317 out_str(T_CTI); // possibly enables modifyOtherKeys again
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005318 }
5319# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320
5321 /*
5322 * Wait until our child has exited.
5323 * Ignore wait() returning pids of other children and returning
5324 * because of some signal like SIGWINCH.
5325 * Don't wait if wait_pid was already set above, indicating the
5326 * child already exited.
5327 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005328 if (wait_pid != pid)
5329 wait_pid = wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
Bram Moolenaar624891f2010-10-13 16:22:09 +02005331# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005332 // Close slave side of pty. Only do this after the child has
5333 // exited, otherwise the child may hang when it tries to write on
5334 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005335 if (pty_master_fd >= 0)
5336 close(pty_slave_fd);
5337# endif
5338
Bram Moolenaar0f873732019-12-05 20:28:46 +01005339 // Make sure the child that writes to the external program is
5340 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005341 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005342 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005343 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005344 wait4pid(wpid, NULL);
5345 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005346
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005347# ifdef FEAT_JOB_CHANNEL
5348 --dont_check_job_ended;
5349# endif
5350
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 /*
5352 * Set to raw mode right now, otherwise a CTRL-C after
5353 * catch_signals() will kill Vim.
5354 */
5355 if (tmode == TMODE_RAW)
5356 settmode(TMODE_RAW);
5357 did_settmode = TRUE;
5358 set_signals();
5359
5360 if (WIFEXITED(status))
5361 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005362 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005364 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 {
5366 if (retval == EXEC_FAILED)
5367 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005368 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 msg_outtrans(p_sh);
5370 msg_putchar('\n');
5371 }
5372 else if (!(options & SHELL_SILENT))
5373 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005374 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 msg_outnum((long)retval);
5376 msg_putchar('\n');
5377 }
5378 }
5379 }
5380 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005381 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 }
5383 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384
5385error:
5386 if (!did_settmode)
5387 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005388 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389# ifdef FEAT_TITLE
5390 resettitle();
5391# endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005392 vim_free(argv);
5393 vim_free(tofree1);
5394 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395
5396 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005397}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005398#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005399
5400 int
5401mch_call_shell(
5402 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005403 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005404{
5405#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
5406 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
5407 return mch_call_shell_terminal(cmd, options);
5408#endif
5409#ifdef USE_SYSTEM
5410 return mch_call_shell_system(cmd, options);
5411#else
5412 return mch_call_shell_fork(cmd, options);
5413#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414}
5415
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005416#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005417 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005418mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005419{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005420 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005421 int fd_in[2] = {-1, -1}; // for stdin
5422 int fd_out[2] = {-1, -1}; // for stdout
5423 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005424 int pty_master_fd = -1;
5425 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005426 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005427 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5428 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5429 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005430 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005431 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5432 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005433 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005434 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005435 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005436
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005437 if (use_out_for_err && use_null_for_out)
5438 use_null_for_err = TRUE;
5439
Bram Moolenaar0f873732019-12-05 20:28:46 +01005440 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005441 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005442
Bram Moolenaarb2412082017-08-20 18:09:14 +02005443 if (options->jo_pty
5444 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005445 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005446 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005447 open_pty(&pty_master_fd, &pty_slave_fd,
5448 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005449
Bram Moolenaar0f873732019-12-05 20:28:46 +01005450 // TODO: without the channel feature connect the child to /dev/null?
5451 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005452 if (use_file_for_in)
5453 {
5454 char_u *fname = options->jo_io_name[PART_IN];
5455
5456 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5457 if (fd_in[0] < 0)
5458 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005459 semsg(_(e_notopen), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005460 goto failed;
5461 }
5462 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005463 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005464 // When writing buffer lines to the input don't use the pty, so that
5465 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005466 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5467 && pipe(fd_in) < 0)
5468 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005469
5470 if (use_file_for_out)
5471 {
5472 char_u *fname = options->jo_io_name[PART_OUT];
5473
5474 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5475 if (fd_out[1] < 0)
5476 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005477 semsg(_(e_notopen), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005478 goto failed;
5479 }
5480 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005481 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005482 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005483
5484 if (use_file_for_err)
5485 {
5486 char_u *fname = options->jo_io_name[PART_ERR];
5487
5488 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5489 if (fd_err[1] < 0)
5490 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005491 semsg(_(e_notopen), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005492 goto failed;
5493 }
5494 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005495 else if (!use_out_for_err && !use_null_for_err
5496 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005497 goto failed;
5498
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005499 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5500 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005501 if (options->jo_set & JO_CHANNEL)
5502 {
5503 channel = options->jo_channel;
5504 if (channel != NULL)
5505 ++channel->ch_refcount;
5506 }
5507 else
5508 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005509 if (channel == NULL)
5510 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005511 if (job->jv_tty_out != NULL)
5512 ch_log(channel, "using pty %s on fd %d",
5513 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005514 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005515
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005516 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005517 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005518 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005519 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005520 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005521 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005522 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005523 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005524 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005525 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005526 int null_fd = -1;
5527 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005528
Bram Moolenaar0f873732019-12-05 20:28:46 +01005529 // child
5530 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005531 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005532
Bram Moolenaar819524702018-02-27 19:10:00 +01005533# ifdef FEAT_JOB_CHANNEL
5534 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005535 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005536 ch_logfile((char_u *)"", (char_u *)"");
5537# endif
5538
Bram Moolenaar835dc632016-02-07 14:27:38 +01005539# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005540 // Create our own process group, so that the child and all its
5541 // children can be kill()ed. Don't do this when using pipes,
5542 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005543 (void)setsid();
5544# endif
5545
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005546# ifdef FEAT_TERMINAL
5547 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005548 {
5549 char *term = (char *)T_NAME;
5550
5551#ifdef FEAT_GUI
5552 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005553 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005554 term = getenv("TERM");
5555#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005556 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005557 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005558 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005559 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005560 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005561 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005562 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005563 else if (t_colors > 16)
5564 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005565 else
5566 term = "xterm";
5567 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005568 set_child_environment(
5569 (long)options->jo_term_rows,
5570 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005571 term,
5572 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005573 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005574 else
5575# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005576 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005577
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005578 if (options->jo_env != NULL)
5579 {
5580 dict_T *dict = options->jo_env;
5581 hashitem_T *hi;
5582 int todo = (int)dict->dv_hashtab.ht_used;
5583
5584 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5585 if (!HASHITEM_EMPTY(hi))
5586 {
5587 typval_T *item = &dict_lookup(hi)->di_tv;
5588
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005589 vim_setenv((char_u*)hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005590 --todo;
5591 }
5592 }
5593
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005594 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005595 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005596 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005597 if (null_fd < 0)
5598 {
5599 perror("opening /dev/null failed");
5600 _exit(OPEN_NULL_FAILED);
5601 }
5602 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005603
Bram Moolenaar223896d2017-08-02 22:33:28 +02005604 if (pty_slave_fd >= 0)
5605 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005606 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005607 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005608# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005609 // Try to become controlling tty (probably doesn't work,
5610 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005611 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5612# endif
5613 }
5614
Bram Moolenaar0f873732019-12-05 20:28:46 +01005615 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005616 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005617 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005618 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005619 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005620 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005621 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005622 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005623
Bram Moolenaar0f873732019-12-05 20:28:46 +01005624 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005625 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005626 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005627 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005628 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005629 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005630 }
5631 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005632 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005633 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005634 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005635 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005636 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005637
Bram Moolenaar0f873732019-12-05 20:28:46 +01005638 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005639 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005640 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005641 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005642 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005643 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005644 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005645 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005646
5647 if (fd_in[0] >= 0)
5648 close(fd_in[0]);
5649 if (fd_in[1] >= 0)
5650 close(fd_in[1]);
5651 if (fd_out[0] >= 0)
5652 close(fd_out[0]);
5653 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005654 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005655 if (fd_err[0] >= 0)
5656 close(fd_err[0]);
5657 if (fd_err[1] >= 0)
5658 close(fd_err[1]);
5659 if (pty_master_fd >= 0)
5660 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005661 close(pty_master_fd); // not used in the child
5662 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005663 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005664
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005665 if (null_fd >= 0)
5666 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005667
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005668 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5669 _exit(EXEC_FAILED);
5670
Bram Moolenaar0f873732019-12-05 20:28:46 +01005671 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005672 execvp(argv[0], argv);
5673
Bram Moolenaar4694a172016-04-21 14:05:23 +02005674 if (stderr_works)
5675 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005676# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005677 // calling free_all_mem() here causes problems. Ignore valgrind
5678 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005679# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005680 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005681 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005682
Bram Moolenaar0f873732019-12-05 20:28:46 +01005683 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005684 UNBLOCK_SIGNALS(&curset);
5685
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005686 job->jv_pid = pid;
5687 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005688 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005689
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005690 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005691 close(pty_slave_fd); // not used in the parent
5692 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005693 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005694 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005695 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005696 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005697 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005698 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005699 if (channel != NULL)
5700 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005701 int in_fd = INVALID_FD;
5702 int out_fd = INVALID_FD;
5703 int err_fd = INVALID_FD;
5704
5705 if (!(use_file_for_in || use_null_for_in))
5706 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5707
5708 if (!(use_file_for_out || use_null_for_out))
5709 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5710
5711 // When using pty_master_fd only set it for stdout, do not duplicate
5712 // it for stderr, it only needs to be read once.
5713 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5714 {
5715 if (fd_err[0] >= 0)
5716 err_fd = fd_err[0];
5717 else if (out_fd != pty_master_fd)
5718 err_fd = pty_master_fd;
5719 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005720
5721 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005722 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005723 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005724 else
5725 {
5726 if (fd_in[1] >= 0)
5727 close(fd_in[1]);
5728 if (fd_out[0] >= 0)
5729 close(fd_out[0]);
5730 if (fd_err[0] >= 0)
5731 close(fd_err[0]);
5732 if (pty_master_fd >= 0)
5733 close(pty_master_fd);
5734 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005735
Bram Moolenaar0f873732019-12-05 20:28:46 +01005736 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005737 return;
5738
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005739failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005740 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005741 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005742 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005743 if (fd_in[1] >= 0)
5744 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005745 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005746 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005747 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005748 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005749 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005750 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005751 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005752 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005753 if (pty_master_fd >= 0)
5754 close(pty_master_fd);
5755 if (pty_slave_fd >= 0)
5756 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005757}
5758
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005759 static char_u *
5760get_signal_name(int sig)
5761{
5762 int i;
5763 char_u numbuf[NUMBUFLEN];
5764
5765 if (sig == SIGKILL)
5766 return vim_strsave((char_u *)"kill");
5767
5768 for (i = 0; signal_info[i].sig != -1; i++)
5769 if (sig == signal_info[i].sig)
5770 return strlow_save((char_u *)signal_info[i].name);
5771
5772 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5773 return vim_strsave(numbuf);
5774}
5775
Bram Moolenaar835dc632016-02-07 14:27:38 +01005776 char *
5777mch_job_status(job_T *job)
5778{
5779# ifdef HAVE_UNION_WAIT
5780 union wait status;
5781# else
5782 int status = -1;
5783# endif
5784 pid_t wait_pid = 0;
5785
5786# ifdef __NeXT__
5787 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5788# else
5789 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5790# endif
5791 if (wait_pid == -1)
5792 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005793 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005794 if (job->jv_status < JOB_ENDED)
5795 ch_log(job->jv_channel, "Job no longer exists: %s",
5796 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005797 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005798 }
5799 if (wait_pid == 0)
5800 return "run";
5801 if (WIFEXITED(status))
5802 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005803 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005804 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005805 if (job->jv_status < JOB_ENDED)
5806 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005807 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005808 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005809 if (WIFSIGNALED(status))
5810 {
5811 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005812 job->jv_termsig = get_signal_name(WTERMSIG(status));
5813 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5814 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5815 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005816 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005817 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005818 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005819
5820return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005821 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005822 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005823 return "dead";
5824}
5825
5826 job_T *
5827mch_detect_ended_job(job_T *job_list)
5828{
5829# ifdef HAVE_UNION_WAIT
5830 union wait status;
5831# else
5832 int status = -1;
5833# endif
5834 pid_t wait_pid = 0;
5835 job_T *job;
5836
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005837# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005838 // Do not do this when waiting for a shell command to finish, we would get
5839 // the exit value here (and discard it), the exit value obtained there
5840 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005841 if (dont_check_job_ended > 0)
5842 return NULL;
5843# endif
5844
Bram Moolenaar97792de2016-10-15 18:36:49 +02005845# ifdef __NeXT__
5846 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5847# else
5848 wait_pid = waitpid(-1, &status, WNOHANG);
5849# endif
5850 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005851 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005852 return NULL;
5853 for (job = job_list; job != NULL; job = job->jv_next)
5854 {
5855 if (job->jv_pid == wait_pid)
5856 {
5857 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005858 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005859 job->jv_exitval = WEXITSTATUS(status);
5860 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005861 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005862 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005863 job->jv_termsig = get_signal_name(WTERMSIG(status));
5864 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005865 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005866 {
5867 ch_log(job->jv_channel, "Job ended");
5868 job->jv_status = JOB_ENDED;
5869 }
5870 return job;
5871 }
5872 }
5873 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005874}
5875
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005876/*
5877 * Send a (deadly) signal to "job".
5878 * Return FAIL if "how" is not a valid name.
5879 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005880 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005881mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005882{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005883 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005884
Bram Moolenaar923d9262016-02-25 20:56:01 +01005885 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005886 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005887 else if (STRCMP(how, "hup") == 0)
5888 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005889 else if (STRCMP(how, "quit") == 0)
5890 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005891 else if (STRCMP(how, "int") == 0)
5892 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005893 else if (STRCMP(how, "kill") == 0)
5894 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005895#ifdef SIGWINCH
5896 else if (STRCMP(how, "winch") == 0)
5897 sig = SIGWINCH;
5898#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005899 else if (isdigit(*how))
5900 sig = atoi((char *)how);
5901 else
5902 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005903
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005904 // Never kill ourselves!
5905 if (job->jv_pid != 0)
5906 {
5907 // TODO: have an option to only kill the process, not the group?
5908 kill(-job->jv_pid, sig);
5909 kill(job->jv_pid, sig);
5910 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005911
Bram Moolenaar835dc632016-02-07 14:27:38 +01005912 return OK;
5913}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005914
5915/*
5916 * Clear the data related to "job".
5917 */
5918 void
5919mch_clear_job(job_T *job)
5920{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005921 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01005922# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005923 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005924# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005925 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005926# endif
5927}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005928#endif
5929
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005930#if defined(FEAT_TERMINAL) || defined(PROTO)
5931 int
5932mch_create_pty_channel(job_T *job, jobopt_T *options)
5933{
5934 int pty_master_fd = -1;
5935 int pty_slave_fd = -1;
5936 channel_T *channel;
5937
Bram Moolenaar59386482019-02-10 22:43:46 +01005938 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaard0342202020-06-29 22:40:42 +02005939 if (pty_master_fd < 0 || pty_slave_fd < 0)
5940 return FAIL;
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005941 close(pty_slave_fd);
5942
5943 channel = add_channel();
5944 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02005945 {
5946 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005947 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02005948 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02005949 if (job->jv_tty_out != NULL)
5950 ch_log(channel, "using pty %s on fd %d",
5951 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005952 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005953 channel->ch_keep_open = TRUE;
5954
Bram Moolenaar0f873732019-12-05 20:28:46 +01005955 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
5956 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005957 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005958 channel_set_job(channel, job, options);
5959 return OK;
5960}
5961#endif
5962
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963/*
5964 * Check for CTRL-C typed by reading all available characters.
5965 * In cooked mode we should get SIGINT, no need to check.
5966 */
5967 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02005968mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969{
Bram Moolenaar26e86442020-05-17 14:06:16 +02005970 if ((mch_cur_tmode == TMODE_RAW || force)
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02005971 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 fill_input_buf(FALSE);
5973}
5974
5975/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005976 * Wait "msec" msec until a character is available from the mouse, keyboard,
5977 * from inbuf[].
5978 * "msec" == -1 will block forever.
5979 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005980 * When "ignore_input" is TRUE even check for pending input when input is
5981 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02005982 * "interrupted" (if not NULL) is set to TRUE when no character is available
5983 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02005984 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02005985 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 */
5987 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005988WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005990#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01005991 return ui_wait_for_chars_or_timer(
5992 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005993#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005994 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005995#endif
5996}
5997
5998/*
5999 * Wait "msec" msec until a character is available from the mouse or keyboard
6000 * or from inbuf[].
6001 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006002 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02006003 * "interrupted" (if not NULL) is set to TRUE when no character is available
6004 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006005 * When a GUI is being used, this will never get called -- webb
6006 */
6007 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006008WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01006009{
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010#ifdef FEAT_MOUSE_GPM
6011 int gpm_process_wanted;
6012#endif
6013#ifdef FEAT_XCLIPBOARD
6014 int rest;
6015#endif
6016 int avail;
6017
Bram Moolenaar0f873732019-12-05 20:28:46 +01006018 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 return 1;
6020
6021#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006022 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 if (WantQueryMouse)
6024 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00006025 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02006026 if (!no_query_mouse_for_testing)
6027 mch_write((char_u *)IF_EB("\033[1'|", ESC_STR "[1'|"), 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 }
6029#endif
6030
6031 /*
6032 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
6033 * events. This is a bit complicated, because they might both be defined.
6034 */
6035#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
6036# ifdef FEAT_XCLIPBOARD
6037 rest = 0;
6038 if (do_xterm_trace())
6039 rest = msec;
6040# endif
6041 do
6042 {
6043# ifdef FEAT_XCLIPBOARD
6044 if (rest != 0)
6045 {
6046 msec = XT_TRACE_DELAY;
6047 if (rest >= 0 && rest < XT_TRACE_DELAY)
6048 msec = rest;
6049 if (rest >= 0)
6050 rest -= msec;
6051 }
6052# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006053# ifdef FEAT_SOUND_CANBERRA
6054 // Invoke any pending sound callbacks.
6055 if (has_sound_callback_in_queue())
6056 invoke_sound_callback();
6057# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058# ifdef FEAT_MOUSE_GPM
6059 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006060 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006061 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006062 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006064 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006066# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006068 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 return 1;
6070# ifdef FEAT_XCLIPBOARD
6071 if (rest == 0 || !do_xterm_trace())
6072# endif
6073 break;
6074 }
6075 }
6076 while (FALSE
6077# ifdef FEAT_MOUSE_GPM
6078 || (gpm_process_wanted && mch_gpm_process() == 0)
6079# endif
6080# ifdef FEAT_XCLIPBOARD
6081 || (!avail && rest != 0)
6082# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006083 )
6084 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085
6086#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006087 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088#endif
6089 return avail;
6090}
6091
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006092#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093/*
6094 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006095 * "msec" == 0 will check for characters once.
6096 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006099 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006100 * "interrupted" (if not NULL) is set to TRUE when no character is available
6101 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 */
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006103 static int
Bram Moolenaarcda77642016-06-04 13:32:35 +02006104RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105{
6106 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006107 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006108#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 static int busy = FALSE;
6110
Bram Moolenaar0f873732019-12-05 20:28:46 +01006111 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112# define MAY_LOOP
6113
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006114# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006115 // Remember at what time we started, so that we know how much longer we
6116 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006117 long start_msec = msec;
6118 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006120 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006121 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122# endif
6123
Bram Moolenaar0f873732019-12-05 20:28:46 +01006124 // Handle being called recursively. This may happen for the session
6125 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 if (busy)
6127 return 0;
6128#endif
6129
6130#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006131 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132#endif
6133 {
6134#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006135 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006136# ifdef FEAT_MZSCHEME
6137 int mzquantum_used = FALSE;
6138# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139#endif
6140#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006141 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006142 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 int nfd;
6144# ifdef FEAT_XCLIPBOARD
6145 int xterm_idx = -1;
6146# endif
6147# ifdef FEAT_MOUSE_GPM
6148 int gpm_idx = -1;
6149# endif
6150# ifdef USE_XSMP
6151 int xsmp_idx = -1;
6152# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006153 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006155# ifdef FEAT_MZSCHEME
6156 mzvim_check_threads();
6157 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6158 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006159 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006160 mzquantum_used = TRUE;
6161 }
6162# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 fds[0].fd = fd;
6164 fds[0].events = POLLIN;
6165 nfd = 1;
6166
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006168 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 if (xterm_Shell != (Widget)0)
6170 {
6171 xterm_idx = nfd;
6172 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6173 fds[nfd].events = POLLIN;
6174 nfd++;
6175 }
6176# endif
6177# ifdef FEAT_MOUSE_GPM
6178 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6179 {
6180 gpm_idx = nfd;
6181 fds[nfd].fd = gpm_fd;
6182 fds[nfd].events = POLLIN;
6183 nfd++;
6184 }
6185# endif
6186# ifdef USE_XSMP
6187 if (xsmp_icefd != -1)
6188 {
6189 xsmp_idx = nfd;
6190 fds[nfd].fd = xsmp_icefd;
6191 fds[nfd].events = POLLIN;
6192 nfd++;
6193 }
6194# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006195#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006196 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006197#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006198 if (interrupted != NULL)
6199 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006201 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006202
6203 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006204 if (result == 0 && interrupted != NULL && ret > 0)
6205 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006206
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006207# ifdef FEAT_MZSCHEME
6208 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006209 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006210 finished = FALSE;
6211# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213# ifdef FEAT_XCLIPBOARD
6214 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6215 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006216 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006218 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 finished = FALSE;
6220 }
6221# endif
6222# ifdef FEAT_MOUSE_GPM
6223 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225# endif
6226# ifdef USE_XSMP
6227 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6228 {
6229 if (fds[xsmp_idx].revents & POLLIN)
6230 {
6231 busy = TRUE;
6232 xsmp_handle_requests();
6233 busy = FALSE;
6234 }
6235 else if (fds[xsmp_idx].revents & POLLHUP)
6236 {
6237 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006238 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 xsmp_close();
6240 }
6241 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006242 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 }
6244# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006245#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006246 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006247 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006248 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006249#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250
Bram Moolenaar0f873732019-12-05 20:28:46 +01006251#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252
6253 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006254 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006255 // These are static because they can take 8 Kbyte each and cause the
6256 // signal stack to run out with -O3.
6257 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006259 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006261# ifdef FEAT_MZSCHEME
6262 mzvim_check_threads();
6263 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6264 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006265 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006266 mzquantum_used = TRUE;
6267 }
6268# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006270 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006272 tv.tv_sec = towait / 1000;
6273 tv.tv_usec = (towait % 1000) * (1000000/1000);
6274 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006276 else
6277 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278
6279 /*
6280 * Select on ready for reading and exceptional condition (end of file).
6281 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006282select_eintr:
6283 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006284 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 FD_ZERO(&efds);
6286 FD_SET(fd, &rfds);
6287# if !defined(__QNX__) && !defined(__CYGWIN32__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006288 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 FD_SET(fd, &efds);
6290# endif
6291 maxfd = fd;
6292
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006294 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 if (xterm_Shell != (Widget)0)
6296 {
6297 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6298 if (maxfd < ConnectionNumber(xterm_dpy))
6299 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006300
Bram Moolenaar0f873732019-12-05 20:28:46 +01006301 // An event may have already been read but not handled. In
6302 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006303 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 }
6305# endif
6306# ifdef FEAT_MOUSE_GPM
6307 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6308 {
6309 FD_SET(gpm_fd, &rfds);
6310 FD_SET(gpm_fd, &efds);
6311 if (maxfd < gpm_fd)
6312 maxfd = gpm_fd;
6313 }
6314# endif
6315# ifdef USE_XSMP
6316 if (xsmp_icefd != -1)
6317 {
6318 FD_SET(xsmp_icefd, &rfds);
6319 FD_SET(xsmp_icefd, &efds);
6320 if (maxfd < xsmp_icefd)
6321 maxfd = xsmp_icefd;
6322 }
6323# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006324# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006325 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006326# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006327 if (interrupted != NULL)
6328 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329
Bram Moolenaar643b6142018-09-12 20:29:09 +02006330 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6331 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006332 result = ret > 0 && FD_ISSET(fd, &rfds);
6333 if (result)
6334 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006335 else if (interrupted != NULL && ret > 0)
6336 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006337
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006338# ifdef EINTR
6339 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006340 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006341 // Check whether window has been resized, EINTR may be caused by
6342 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006343 if (do_resize)
6344 handle_resize();
6345
Bram Moolenaar0f873732019-12-05 20:28:46 +01006346 // Interrupted by a signal, need to try again. We ignore msec
6347 // here, because we do want to check even after a timeout if
6348 // characters are available. Needed for reading output of an
6349 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006350 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006351 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006352# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006353# ifdef __TANDEM
6354 if (ret == -1 && errno == ENOTSUP)
6355 {
6356 FD_ZERO(&rfds);
6357 FD_ZERO(&efds);
6358 ret = 0;
6359 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006360# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006361# ifdef FEAT_MZSCHEME
6362 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006363 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006364 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365# endif
6366
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367# ifdef FEAT_XCLIPBOARD
6368 if (ret > 0 && xterm_Shell != (Widget)0
6369 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6370 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006371 xterm_update(); // Maybe we should hand out clipboard
6372 // continue looping when we only got the X event and the input
6373 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 if (--ret == 0 && !input_available())
6375 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006376 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 finished = FALSE;
6378 }
6379 }
6380# endif
6381# ifdef FEAT_MOUSE_GPM
6382 if (ret > 0 && gpm_flag && check_for_gpm != NULL && gpm_fd >= 0)
6383 {
6384 if (FD_ISSET(gpm_fd, &efds))
6385 gpm_close();
6386 else if (FD_ISSET(gpm_fd, &rfds))
6387 *check_for_gpm = 1;
6388 }
6389# endif
6390# ifdef USE_XSMP
6391 if (ret > 0 && xsmp_icefd != -1)
6392 {
6393 if (FD_ISSET(xsmp_icefd, &efds))
6394 {
6395 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006396 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 xsmp_close();
6398 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006399 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 }
6401 else if (FD_ISSET(xsmp_icefd, &rfds))
6402 {
6403 busy = TRUE;
6404 xsmp_handle_requests();
6405 busy = FALSE;
6406 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006407 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 }
6409 }
6410# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006411#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006412 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006413 if (ret >= 0)
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006414 ret = channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006415#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416
Bram Moolenaar0f873732019-12-05 20:28:46 +01006417#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418
6419#ifdef MAY_LOOP
6420 if (finished || msec == 0)
6421 break;
6422
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006423# ifdef FEAT_CLIENTSERVER
6424 if (server_waiting())
6425 break;
6426# endif
6427
Bram Moolenaar0f873732019-12-05 20:28:46 +01006428 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 if (msec > 0)
6430 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006431# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006432 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006433 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006435 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 msec = msec / 2;
6437# endif
6438 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006439 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 }
6441#endif
6442 }
6443
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006444 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445}
6446
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006448 * Expand a path into all matching files and/or directories. Handles "*",
6449 * "?", "[a-z]", "**", etc.
6450 * "path" has backslashes before chars that are not to be expanded.
6451 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 */
6453 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006454mch_expandpath(
6455 garray_T *gap,
6456 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006457 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458{
Bram Moolenaar02743632005-07-25 20:42:36 +00006459 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461
6462/*
6463 * mch_expand_wildcards() - this code does wild-card pattern matching using
6464 * the shell
6465 *
6466 * return OK for success, FAIL for error (you may lose some memory) and put
6467 * an error message in *file.
6468 *
6469 * num_pat is number of input patterns
6470 * pat is array of pointers to input patterns
6471 * num_file is pointer to number of matched file names
6472 * file is pointer to array of pointers to matched file names
6473 */
6474
6475#ifndef SEEK_SET
6476# define SEEK_SET 0
6477#endif
6478#ifndef SEEK_END
6479# define SEEK_END 2
6480#endif
6481
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006482#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006483
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006485mch_expand_wildcards(
6486 int num_pat,
6487 char_u **pat,
6488 int *num_file,
6489 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006490 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491{
6492 int i;
6493 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006494 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 char_u *p;
6496 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497
Bram Moolenaarc7247912008-01-13 12:54:11 +00006498 /*
6499 * This is the non-OS/2 implementation (really Unix).
6500 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 int j;
6502 char_u *tempname;
6503 char_u *command;
6504 FILE *fd;
6505 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006506#define STYLE_ECHO 0 // use "echo", the default
6507#define STYLE_GLOB 1 // use "glob", for csh
6508#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6509#define STYLE_PRINT 3 // use "print -N", for zsh
6510#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6511 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 int shell_style = STYLE_ECHO;
6513 int check_spaces;
6514 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006515 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006516 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006517 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518
Bram Moolenaar0f873732019-12-05 20:28:46 +01006519 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 *file = NULL;
6521
6522 /*
6523 * If there are no wildcards, just copy the names to allocated memory.
6524 * Saves a lot of time, because we don't have to start a new shell.
6525 */
6526 if (!have_wildcard(num_pat, pat))
6527 return save_patterns(num_pat, pat, num_file, file);
6528
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006529# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006530 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006531 if (sandbox != 0 && check_secure())
6532 return FAIL;
6533# endif
6534
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 /*
6536 * Don't allow the use of backticks in secure and restricted mode.
6537 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006538 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 for (i = 0; i < num_pat; ++i)
6540 if (vim_strchr(pat[i], '`') != NULL
6541 && (check_restricted() || check_secure()))
6542 return FAIL;
6543
6544 /*
6545 * get a name for the temp file
6546 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006547 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006549 emsg(_(e_notmp));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 return FAIL;
6551 }
6552
6553 /*
6554 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006555 * file.
6556 * STYLE_BT: NL separated
6557 * If expanding `cmd` execute it directly.
6558 * STYLE_GLOB: NUL separated
6559 * If we use *csh, "glob" will work better than "echo".
6560 * STYLE_PRINT: NL or NUL separated
6561 * If we use *zsh, "print -N" will work better than "glob".
6562 * STYLE_VIMGLOB: NL separated
6563 * If we use *sh*, we define "vimglob()".
6564 * STYLE_ECHO: space separated.
6565 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 */
6567 if (num_pat == 1 && *pat[0] == '`'
6568 && (len = STRLEN(pat[0])) > 2
6569 && *(pat[0] + len - 1) == '`')
6570 shell_style = STYLE_BT;
6571 else if ((len = STRLEN(p_sh)) >= 3)
6572 {
6573 if (STRCMP(p_sh + len - 3, "csh") == 0)
6574 shell_style = STYLE_GLOB;
6575 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6576 shell_style = STYLE_PRINT;
6577 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006578 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6579 "sh") != NULL)
6580 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581
Bram Moolenaar0f873732019-12-05 20:28:46 +01006582 // Compute the length of the command. We need 2 extra bytes: for the
6583 // optional '&' and for the NUL.
6584 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006586 if (shell_style == STYLE_VIMGLOB)
6587 len += STRLEN(sh_vimglob_func);
6588
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006589 for (i = 0; i < num_pat; ++i)
6590 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006591 // Count the length of the patterns in the same way as they are put in
6592 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006593#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006594 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006595#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006596 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006597 for (j = 0; pat[i][j] != NUL; ++j)
6598 {
6599 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006600 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006601 ++len;
6602 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006603#endif
6604 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 command = alloc(len);
6606 if (command == NULL)
6607 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006608 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 vim_free(tempname);
6610 return FAIL;
6611 }
6612
6613 /*
6614 * Build the shell command:
6615 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6616 * recognizes this).
6617 * - Add the shell command to print the expanded names.
6618 * - Add the temp file name.
6619 * - Add the file name patterns.
6620 */
6621 if (shell_style == STYLE_BT)
6622 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006623 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006624 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006625 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006627 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006628 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006630 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006632 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 *p = ' ';
6634 }
6635 STRCAT(command, ">");
6636 }
6637 else
6638 {
6639 if (flags & EW_NOTFOUND)
6640 STRCPY(command, "set nonomatch; ");
6641 else
6642 STRCPY(command, "unset nonomatch; ");
6643 if (shell_style == STYLE_GLOB)
6644 STRCAT(command, "glob >");
6645 else if (shell_style == STYLE_PRINT)
6646 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006647 else if (shell_style == STYLE_VIMGLOB)
6648 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 else
6650 STRCAT(command, "echo >");
6651 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006652
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006654
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 if (shell_style != STYLE_BT)
6656 for (i = 0; i < num_pat; ++i)
6657 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006658 // When using system() always add extra quotes, because the shell
6659 // is started twice. Otherwise put a backslash before special
6660 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661#ifdef USE_SYSTEM
6662 STRCAT(command, " \"");
6663 STRCAT(command, pat[i]);
6664 STRCAT(command, "\"");
6665#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006666 int intick = FALSE;
6667
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 p = command + STRLEN(command);
6669 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006670 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006671 {
6672 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006673 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006674 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6675 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006676 // Remove a backslash, take char literally. But keep
6677 // backslash inside backticks, before a special character
6678 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006679 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006680 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6681 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006682 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006683 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006684 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006685 else if (!intick
6686 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6687 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006688 // Put a backslash before a special character, but not
6689 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6690 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006691 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006692
Bram Moolenaar0f873732019-12-05 20:28:46 +01006693 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006694 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006695 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 *p = NUL;
6697#endif
6698 }
6699 if (flags & EW_SILENT)
6700 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006701 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006702 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703
6704 /*
6705 * Using zsh -G: If a pattern has no matches, it is just deleted from
6706 * the argument list, otherwise zsh gives an error message and doesn't
6707 * expand any other pattern.
6708 */
6709 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006710 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711
6712 /*
6713 * If we use -f then shell variables set in .cshrc won't get expanded.
6714 * vi can do it, so we will too, but it is only necessary if there is a "$"
6715 * in one of the patterns, otherwise we can still use the fast option.
6716 */
6717 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006718 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719
6720 /*
6721 * execute the shell command
6722 */
6723 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6724
Bram Moolenaar0f873732019-12-05 20:28:46 +01006725 // When running in the background, give it some time to create the temp
6726 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006727 if (ampersand)
Bram Moolenaar0981c872020-08-23 14:28:37 +02006728 mch_delay(10L, MCH_DELAY_IGNOREINPUT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729
Bram Moolenaar0f873732019-12-05 20:28:46 +01006730 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 show_shell_mess = TRUE;
6732 vim_free(command);
6733
Bram Moolenaar0f873732019-12-05 20:28:46 +01006734 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 {
6736 mch_remove(tempname);
6737 vim_free(tempname);
6738 /*
6739 * With interactive completion, the error message is not printed.
6740 * However with USE_SYSTEM, I don't know how to turn off error messages
6741 * from the shell, so screen may still get messed up -- webb.
6742 */
6743#ifndef USE_SYSTEM
6744 if (!(flags & EW_SILENT))
6745#endif
6746 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006747 redraw_later_clear(); // probably messed up screen
6748 msg_putchar('\n'); // clear bottom line quickly
6749 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750#ifdef USE_SYSTEM
6751 if (!(flags & EW_SILENT))
6752#endif
6753 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006754 msg(_(e_wildexpand));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006755 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 }
6757 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006758 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6759 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 if (shell_style == STYLE_BT)
6761 return FAIL;
6762 goto notfound;
6763 }
6764
6765 /*
6766 * read the names from the file into memory
6767 */
6768 fd = fopen((char *)tempname, READBIN);
6769 if (fd == NULL)
6770 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006771 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 if (!(flags & EW_SILENT))
6773 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006774 msg(_(e_wildexpand));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006775 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 }
6777 vim_free(tempname);
6778 goto notfound;
6779 }
6780 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006781 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006783 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006784 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006785 buffer = NULL;
6786 else
6787 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 if (buffer == NULL)
6789 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006790 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 mch_remove(tempname);
6792 vim_free(tempname);
6793 fclose(fd);
6794 return FAIL;
6795 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006796 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 i = fread((char *)buffer, 1, len, fd);
6798 fclose(fd);
6799 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006800 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006802 // unexpected read error
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006803 semsg(_(e_notread), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 vim_free(tempname);
6805 vim_free(buffer);
6806 return FAIL;
6807 }
6808 vim_free(tempname);
6809
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006810# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006811 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006813 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6815 *p++ = buffer[i];
6816 len = p - buffer;
6817# endif
6818
6819
Bram Moolenaar0f873732019-12-05 20:28:46 +01006820 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 if (shell_style == STYLE_ECHO)
6822 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006823 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006825 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 {
6827 while (*p != ' ' && *p != '\n')
6828 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006829 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 }
6831 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006832 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006833 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006835 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006837 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 {
6839 while (*p != '\n' && *p != NUL)
6840 ++p;
6841 if (*p != NUL)
6842 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006843 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 }
6845 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006846 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 else
6848 {
6849 /*
6850 * Some versions of zsh use spaces instead of NULs to separate
6851 * results. Only do this when there is no NUL before the end of the
6852 * buffer, otherwise we would never be able to use file names with
6853 * embedded spaces when zsh does use NULs.
6854 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6855 * don't check for spaces again.
6856 */
6857 check_spaces = FALSE;
6858 if (shell_style == STYLE_PRINT && !did_find_nul)
6859 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006860 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006861 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006862 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 did_find_nul = TRUE;
6864 else
6865 check_spaces = TRUE;
6866 }
6867
6868 /*
6869 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6870 * already is one, for STYLE_GLOB it needs to be added.
6871 */
6872 if (len && buffer[len - 1] == NUL)
6873 --len;
6874 else
6875 buffer[len] = NUL;
6876 i = 0;
6877 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006878 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 {
6880 ++i;
6881 *p = NUL;
6882 }
6883 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006884 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 }
6886 if (i == 0)
6887 {
6888 /*
6889 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6890 * /bin/sh will happily expand it to nothing rather than returning an
6891 * error; and hey, it's good to check anyway -- webb.
6892 */
6893 vim_free(buffer);
6894 goto notfound;
6895 }
6896 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006897 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 if (*file == NULL)
6899 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006900 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 vim_free(buffer);
6902 return FAIL;
6903 }
6904
6905 /*
6906 * Isolate the individual file names.
6907 */
6908 p = buffer;
6909 for (i = 0; i < *num_file; ++i)
6910 {
6911 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006912 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00006913 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
6914 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00006916 while (!(shell_style == STYLE_ECHO && *p == ' ')
6917 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006919 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 *p = NUL;
6921 else
6922 {
6923 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006924 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 }
6926 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006927 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006929 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006931 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 }
6933 }
6934
6935 /*
6936 * Move the file names to allocated memory.
6937 */
6938 for (j = 0, i = 0; i < *num_file; ++i)
6939 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006940 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
6942 continue;
6943
Bram Moolenaar0f873732019-12-05 20:28:46 +01006944 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 dir = (mch_isdir((*file)[i]));
6946 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
6947 continue;
6948
Bram Moolenaar0f873732019-12-05 20:28:46 +01006949 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01006950 if (!dir && (flags & EW_EXEC)
6951 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00006952 continue;
6953
Bram Moolenaar964b3742019-05-24 18:54:09 +02006954 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 if (p)
6956 {
6957 STRCPY(p, (*file)[i]);
6958 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006959 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 (*file)[j++] = p;
6961 }
6962 }
6963 vim_free(buffer);
6964 *num_file = j;
6965
Bram Moolenaar0f873732019-12-05 20:28:46 +01006966 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01006968 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 goto notfound;
6970 }
6971
6972 return OK;
6973
6974notfound:
6975 if (flags & EW_NOTFOUND)
6976 return save_patterns(num_pat, pat, num_file, file);
6977 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978}
6979
Bram Moolenaar0f873732019-12-05 20:28:46 +01006980#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01006983save_patterns(
6984 int num_pat,
6985 char_u **pat,
6986 int *num_file,
6987 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988{
6989 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00006990 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006992 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 if (*file == NULL)
6994 return FAIL;
6995 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00006996 {
6997 s = vim_strsave(pat[i]);
6998 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006999 // Be compatible with expand_filename(): halve the number of
7000 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007001 backslash_halve(s);
7002 (*file)[i] = s;
7003 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 *num_file = num_pat;
7005 return OK;
7006}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008/*
7009 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
7010 * expand.
7011 */
7012 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007013mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007015 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 if (*p == '\\' && p[1] != NUL)
7018 ++p;
7019 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 if (vim_strchr((char_u *)
7021#ifdef VMS
7022 "*?%"
7023#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025#endif
7026 , *p) != NULL)
7027 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 }
7029 return FALSE;
7030}
7031
7032/*
7033 * Return TRUE if the string "p" contains a wildcard.
7034 * Don't recognize '~' at the end as a wildcard.
7035 */
7036 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007037mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01007039 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 if (*p == '\\' && p[1] != NUL)
7042 ++p;
7043 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 if (vim_strchr((char_u *)
7045#ifdef VMS
7046 "*?%$"
7047#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049#endif
7050 , *p) != NULL
7051 || (*p == '~' && p[1] != NUL))
7052 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 }
7054 return FALSE;
7055}
7056
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007058have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059{
7060 int i;
7061
7062 for (i = 0; i < num; i++)
7063 if (mch_has_wildcard(file[i]))
7064 return 1;
7065 return 0;
7066}
7067
7068 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007069have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070{
7071 int i;
7072
7073 for (i = 0; i < num; i++)
7074 if (vim_strchr(file[i], '$') != NULL)
7075 return TRUE;
7076 return FALSE;
7077}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007079#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080/*
7081 * Scaled-down version of rename(), which is missing in Xenix.
7082 * This version can only move regular files and will fail if the
7083 * destination exists.
7084 */
7085 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007086mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087{
7088 struct stat st;
7089
Bram Moolenaar0f873732019-12-05 20:28:46 +01007090 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007092 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007094 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 return 0;
7096 return -1;
7097}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007098#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007100#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101/*
7102 * Initializes connection with gpm (if it isn't already opened)
7103 * Return 1 if succeeded (or connection already opened), 0 if failed
7104 */
7105 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007106gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007108 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109
7110 if (!gpm_flag)
7111 {
7112 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7113 gpm_connect.defaultMask = ~GPM_HARD;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007114 // Default handling for mouse move
7115 gpm_connect.minMod = 0; // Handle any modifier keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 gpm_connect.maxMod = 0xffff;
7117 if (Gpm_Open(&gpm_connect, 0) > 0)
7118 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007119 // gpm library tries to handling TSTP causes
7120 // problems. Anyways, we close connection to Gpm whenever
7121 // we are going to suspend or starting an external process
7122 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007123# ifdef SIGTSTP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 signal(SIGTSTP, restricted ? SIG_IGN : SIG_DFL);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007125# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007126 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 }
7128 if (gpm_fd == -2)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007129 Gpm_Close(); // We don't want to talk to xterm via gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 return 0;
7131 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007132 return 1; // already open
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133}
7134
7135/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007136 * Returns TRUE if the GPM mouse is enabled.
7137 */
7138 int
7139gpm_enabled(void)
7140{
7141 return gpm_flag && gpm_fd >= 0;
7142}
7143
7144/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 */
7147 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007148gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007150 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 Gpm_Close();
7152}
7153
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007154/*
7155 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007157 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 */
7159 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007160mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161{
7162 int button;
7163 static Gpm_Event gpm_event;
7164 char_u string[6];
7165 int_u vim_modifiers;
7166 int row,col;
7167 unsigned char buttons_mask;
7168 unsigned char gpm_modifiers;
7169 static unsigned char old_buttons = 0;
7170
7171 Gpm_GetEvent(&gpm_event);
7172
7173#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007174 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 if (hold_gui_events)
7176 return 0;
7177#endif
7178
7179 row = gpm_event.y - 1;
7180 col = gpm_event.x - 1;
7181
Bram Moolenaar0f873732019-12-05 20:28:46 +01007182 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 string[1] = 'M';
7184 string[2] = 'G';
7185 switch (GPM_BARE_EVENTS(gpm_event.type))
7186 {
7187 case GPM_DRAG:
7188 string[3] = MOUSE_DRAG;
7189 break;
7190 case GPM_DOWN:
7191 buttons_mask = gpm_event.buttons & ~old_buttons;
7192 old_buttons = gpm_event.buttons;
7193 switch (buttons_mask)
7194 {
7195 case GPM_B_LEFT:
7196 button = MOUSE_LEFT;
7197 break;
7198 case GPM_B_MIDDLE:
7199 button = MOUSE_MIDDLE;
7200 break;
7201 case GPM_B_RIGHT:
7202 button = MOUSE_RIGHT;
7203 break;
7204 default:
7205 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007206 // Don't know what to do. Can more than one button be
7207 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 }
7209 string[3] = (char_u)(button | 0x20);
7210 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7211 break;
7212 case GPM_UP:
7213 string[3] = MOUSE_RELEASE;
7214 old_buttons &= ~gpm_event.buttons;
7215 break;
7216 default:
7217 return 0;
7218 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007219 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 gpm_modifiers = gpm_event.modifiers;
7221 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007222 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7223 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7224 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7226 vim_modifiers |= MOUSE_SHIFT;
7227
7228 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7229 vim_modifiers |= MOUSE_CTRL;
7230 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7231 vim_modifiers |= MOUSE_ALT;
7232 string[3] |= vim_modifiers;
7233 string[4] = (char_u)(col + ' ' + 1);
7234 string[5] = (char_u)(row + ' ' + 1);
7235 add_to_input_buf(string, 6);
7236 return 6;
7237}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007238#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007240#ifdef FEAT_SYSMOUSE
7241/*
7242 * Initialize connection with sysmouse.
7243 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7244 * output, any sysmouse output than will be processed via sig_sysmouse().
7245 * Return OK if succeeded, FAIL if failed.
7246 */
7247 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007248sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007249{
7250 struct mouse_info mouse;
7251
7252 mouse.operation = MOUSE_MODE;
7253 mouse.u.mode.mode = 0;
7254 mouse.u.mode.signal = SIGUSR2;
7255 if (ioctl(1, CONS_MOUSECTL, &mouse) != -1)
7256 {
7257 signal(SIGUSR2, (RETSIGTYPE (*)())sig_sysmouse);
7258 mouse.operation = MOUSE_SHOW;
7259 ioctl(1, CONS_MOUSECTL, &mouse);
7260 return OK;
7261 }
7262 return FAIL;
7263}
7264
7265/*
7266 * Stop processing SIGUSR2 signals, and also make sure that
7267 * virtual console do not send us any sysmouse related signal.
7268 */
7269 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007270sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007271{
7272 struct mouse_info mouse;
7273
7274 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7275 mouse.operation = MOUSE_MODE;
7276 mouse.u.mode.mode = 0;
7277 mouse.u.mode.signal = 0;
7278 ioctl(1, CONS_MOUSECTL, &mouse);
7279}
7280
7281/*
7282 * Gets info from sysmouse and adds special keys to input buf.
7283 */
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007284 static RETSIGTYPE
7285sig_sysmouse SIGDEFARG(sigarg)
7286{
7287 struct mouse_info mouse;
7288 struct video_info video;
7289 char_u string[6];
7290 int row, col;
7291 int button;
7292 int buttons;
7293 static int oldbuttons = 0;
7294
7295#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007296 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007297 if (hold_gui_events)
7298 return;
7299#endif
7300
7301 mouse.operation = MOUSE_GETINFO;
7302 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7303 && ioctl(1, FBIO_MODEINFO, &video) != -1
7304 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7305 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7306 {
7307 row = mouse.u.data.y / video.vi_cheight;
7308 col = mouse.u.data.x / video.vi_cwidth;
7309 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007310 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007311 string[1] = 'M';
7312 string[2] = 'S';
7313 if (oldbuttons == buttons && buttons != 0)
7314 {
7315 button = MOUSE_DRAG;
7316 }
7317 else
7318 {
7319 switch (buttons)
7320 {
7321 case 0:
7322 button = MOUSE_RELEASE;
7323 break;
7324 case 1:
7325 button = MOUSE_LEFT;
7326 break;
7327 case 2:
7328 button = MOUSE_MIDDLE;
7329 break;
7330 case 4:
7331 button = MOUSE_RIGHT;
7332 break;
7333 default:
7334 return;
7335 }
7336 oldbuttons = buttons;
7337 }
7338 string[3] = (char_u)(button);
7339 string[4] = (char_u)(col + ' ' + 1);
7340 string[5] = (char_u)(row + ' ' + 1);
7341 add_to_input_buf(string, 6);
7342 }
7343 return;
7344}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007345#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007346
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007348typedef char_u * (*STRPROCSTR)(char_u *);
7349typedef char_u * (*INTPROCSTR)(int);
7350typedef int (*STRPROCINT)(char_u *);
7351typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352
7353/*
7354 * Call a DLL routine which takes either a string or int param
7355 * and returns an allocated string.
7356 */
7357 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007358mch_libcall(
7359 char_u *libname,
7360 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007361 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007362 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007363 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007364 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365{
7366# if defined(USE_DLOPEN)
7367 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007368 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369# else
7370 shl_t hinstLib;
7371# endif
7372 STRPROCSTR ProcAdd;
7373 INTPROCSTR ProcAddI;
7374 char_u *retval_str = NULL;
7375 int retval_int = 0;
7376 int success = FALSE;
7377
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007378 /*
7379 * Get a handle to the DLL module.
7380 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007382 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007383 (void)dlerror();
7384
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 hinstLib = dlopen((char *)libname, RTLD_LAZY
7386# ifdef RTLD_LOCAL
7387 | RTLD_LOCAL
7388# endif
7389 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007390 if (hinstLib == NULL)
7391 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007392 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007393 dlerr = (char *)dlerror();
7394 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007395 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007396 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397# else
7398 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7399# endif
7400
Bram Moolenaar0f873732019-12-05 20:28:46 +01007401 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 if (hinstLib != NULL)
7403 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007404# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 /*
7406 * Catch a crash when calling the library function. For example when
7407 * using a number where a string pointer is expected.
7408 */
7409 mch_startjmp();
7410 if (SETJMP(lc_jump_env) != 0)
7411 {
7412 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007413# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007414 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007415# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 mch_didjmp();
7417 }
7418 else
7419# endif
7420 {
7421 retval_str = NULL;
7422 retval_int = 0;
7423
7424 if (argstring != NULL)
7425 {
7426# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007427 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007428 dlerr = (char *)dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429# else
7430 if (shl_findsym(&hinstLib, (const char *)funcname,
7431 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7432 ProcAdd = NULL;
7433# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007434 if ((success = (ProcAdd != NULL
7435# if defined(USE_DLOPEN)
7436 && dlerr == NULL
7437# endif
7438 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 {
7440 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007441 retval_int = ((STRPROCINT)(void *)ProcAdd)(argstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 else
7443 retval_str = (ProcAdd)(argstring);
7444 }
7445 }
7446 else
7447 {
7448# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007449 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007450 dlerr = (char *)dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451# else
7452 if (shl_findsym(&hinstLib, (const char *)funcname,
7453 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7454 ProcAddI = NULL;
7455# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007456 if ((success = (ProcAddI != NULL
7457# if defined(USE_DLOPEN)
7458 && dlerr == NULL
7459# endif
7460 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 {
7462 if (string_result == NULL)
Bram Moolenaara4224862020-09-13 22:00:12 +02007463 retval_int = ((INTPROCINT)(void *)ProcAddI)(argint);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 else
7465 retval_str = (ProcAddI)(argint);
7466 }
7467 }
7468
Bram Moolenaar0f873732019-12-05 20:28:46 +01007469 // Save the string before we free the library.
7470 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 if (string_result == NULL)
7472 *number_result = retval_int;
7473 else if (retval_str != NULL
7474 && retval_str != (char_u *)1
7475 && retval_str != (char_u *)-1)
7476 *string_result = vim_strsave(retval_str);
7477 }
7478
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007479# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 mch_endjmp();
7481# ifdef SIGHASARG
7482 if (lc_signal != 0)
7483 {
7484 int i;
7485
Bram Moolenaar0f873732019-12-05 20:28:46 +01007486 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 for (i = 0; signal_info[i].sig != -1; i++)
7488 if (lc_signal == signal_info[i].sig)
7489 break;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007490 semsg("E368: got SIG%s in libcall()", signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 }
7492# endif
7493# endif
7494
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007496 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007497 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007498 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007499
Bram Moolenaar0f873732019-12-05 20:28:46 +01007500 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 (void)dlclose(hinstLib);
7502# else
7503 (void)shl_unload(hinstLib);
7504# endif
7505 }
7506
7507 if (!success)
7508 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007509 semsg(_(e_libcall), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 return FAIL;
7511 }
7512
7513 return OK;
7514}
7515#endif
7516
7517#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007518static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519static int xterm_button;
7520
7521/*
7522 * Setup a dummy window for X selections in a terminal.
7523 */
7524 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007525setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526{
7527 int z = 0;
7528 char *strp = "";
7529 Widget AppShell;
7530
7531 if (!x_connect_to_server())
7532 return;
7533
7534 open_app_context();
7535 if (app_context != NULL && xterm_Shell == (Widget)0)
7536 {
7537 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007538# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007540# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007541# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007542 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543
7544 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007545 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546# endif
7547
Bram Moolenaar0f873732019-12-05 20:28:46 +01007548 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 oldhandler = XSetErrorHandler(x_error_check);
7550
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007551# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007552 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7554 mch_startjmp();
7555 if (SETJMP(lc_jump_env) != 0)
7556 {
7557 mch_didjmp();
7558 xterm_dpy = NULL;
7559 }
7560 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007561# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 {
7563 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7564 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007565 if (xterm_dpy != NULL)
7566 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007567# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007569# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 }
7571
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007572# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007573 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007575# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007576 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 (void)XSetErrorHandler(oldhandler);
7578
7579 if (xterm_dpy == NULL)
7580 {
7581 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007582 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 return;
7584 }
7585
Bram Moolenaar0f873732019-12-05 20:28:46 +01007586 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 (void)XSetIOErrorHandler(x_IOerror_handler);
7588
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007589# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007591 {
7592 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007593 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007594 verbose_leave();
7595 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596# endif
7597
Bram Moolenaar0f873732019-12-05 20:28:46 +01007598 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7600 applicationShellWidgetClass, xterm_dpy,
7601 NULL);
7602 if (AppShell == (Widget)0)
7603 return;
7604 xterm_Shell = XtVaCreatePopupShell("VIM",
7605 topLevelShellWidgetClass, AppShell,
7606 XtNmappedWhenManaged, 0,
7607 XtNwidth, 1,
7608 XtNheight, 1,
7609 NULL);
7610 if (xterm_Shell == (Widget)0)
7611 return;
7612
7613 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007614 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 if (x11_display == NULL)
7616 x11_display = xterm_dpy;
7617
7618 XtRealizeWidget(xterm_Shell);
7619 XSync(xterm_dpy, False);
7620 xterm_update();
7621 }
7622 if (xterm_Shell != (Widget)0)
7623 {
7624 clip_init(TRUE);
7625 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7626 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007627 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 if (test_x11_window(xterm_dpy) == FAIL)
7629 x11_window = 0;
7630 if (x11_window != 0)
7631 xterm_trace = 0;
7632 }
7633}
7634
7635 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007636start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637{
7638 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7639 return;
7640 xterm_trace = 1;
7641 xterm_button = button;
7642 do_xterm_trace();
7643}
7644
7645
7646 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007647stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648{
7649 if (xterm_trace < 0)
7650 return;
7651 xterm_trace = 0;
7652}
7653
7654/*
7655 * Query the xterm pointer and generate mouse termcodes if necessary
7656 * return TRUE if dragging is active, else FALSE
7657 */
7658 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007659do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660{
7661 Window root, child;
7662 int root_x, root_y;
7663 int win_x, win_y;
7664 int row, col;
7665 int_u mask_return;
7666 char_u buf[50];
7667 char_u *strp;
7668 long got_hints;
7669 static char_u *mouse_code;
7670 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7671 static int prev_row = 0, prev_col = 0;
7672 static XSizeHints xterm_hints;
7673
7674 if (xterm_trace <= 0)
7675 return FALSE;
7676
7677 if (xterm_trace == 1)
7678 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007679 // Get the hints just before tracking starts. The font size might
7680 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007681 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7682 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 || xterm_hints.width_inc <= 1
7684 || xterm_hints.height_inc <= 1)
7685 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007686 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 return FALSE;
7688 }
7689
Bram Moolenaar0f873732019-12-05 20:28:46 +01007690 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 mouse_code = find_termcode(mouse_name);
7692 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007693 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 xterm_trace = 2;
7695
Bram Moolenaar0f873732019-12-05 20:28:46 +01007696 // Find the offset of the chars, there might be a scrollbar on the
7697 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7699 &win_x, &win_y, &mask_return);
7700 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7701 - (xterm_hints.height_inc / 2);
7702 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7703 xterm_hints.y = 2;
7704 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7705 - (xterm_hints.width_inc / 2);
7706 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7707 xterm_hints.x = 2;
7708 return TRUE;
7709 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007710 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 {
7712 xterm_trace = 0;
7713 return FALSE;
7714 }
7715
7716 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7717 &win_x, &win_y, &mask_return);
7718
7719 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7720 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7721 if (row == prev_row && col == prev_col)
7722 return TRUE;
7723
7724 STRCPY(buf, mouse_code);
7725 strp = buf + STRLEN(buf);
7726 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7727 *strp++ = (char_u)(col + ' ' + 1);
7728 *strp++ = (char_u)(row + ' ' + 1);
7729 *strp = 0;
7730 add_to_input_buf(buf, STRLEN(buf));
7731
7732 prev_row = row;
7733 prev_col = col;
7734 return TRUE;
7735}
7736
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007737# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738/*
7739 * Destroy the display, window and app_context. Required for GTK.
7740 */
7741 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007742clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743{
7744 if (xterm_Shell != (Widget)0)
7745 {
7746 XtDestroyWidget(xterm_Shell);
7747 xterm_Shell = (Widget)0;
7748 }
7749 if (xterm_dpy != NULL)
7750 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007751# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007752 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007754# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 if (x11_display == xterm_dpy)
7756 x11_display = NULL;
7757 xterm_dpy = NULL;
7758 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007759# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 if (app_context != (XtAppContext)NULL)
7761 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007762 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 XtDestroyApplicationContext(app_context);
7764 app_context = (XtAppContext)NULL;
7765 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007766# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767}
7768# endif
7769
7770/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007771 * Catch up with GUI or X events.
7772 */
7773 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007774clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007775{
7776# ifdef FEAT_GUI
7777 if (gui.in_use)
7778 gui_mch_update();
7779 else
7780# endif
7781 if (xterm_Shell != (Widget)0)
7782 xterm_update();
7783}
7784
7785/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 * Catch up with any queued X events. This may put keyboard input into the
7787 * input buffer, call resize call-backs, trigger timers etc. If there is
7788 * nothing in the X event queue (& no timers pending), then we return
7789 * immediately.
7790 */
7791 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007792xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793{
7794 XEvent event;
7795
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007796 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007798 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007800 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007801 break;
7802
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007803 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007804 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007805 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007806 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007807#ifdef FEAT_CLIENTSERVER
7808 {
7809 XPropertyEvent *e = (XPropertyEvent *)&event;
7810
7811 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007813 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007814 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007816 XtDispatchEvent(&event);
7817 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007818 else
7819 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007820 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007821 XtAppProcessEvent(app_context, mask);
7822 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 }
7824}
7825
7826 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007827clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828{
7829 if (xterm_Shell != (Widget)0)
7830 return clip_x11_own_selection(xterm_Shell, cbd);
7831 return FAIL;
7832}
7833
7834 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007835clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836{
7837 if (xterm_Shell != (Widget)0)
7838 clip_x11_lose_selection(xterm_Shell, cbd);
7839}
7840
7841 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007842clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843{
7844 if (xterm_Shell != (Widget)0)
7845 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7846}
7847
7848 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007849clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850{
7851 clip_x11_set_selection(cbd);
7852}
7853#endif
7854
7855
7856#if defined(USE_XSMP) || defined(PROTO)
7857/*
7858 * Code for X Session Management Protocol.
7859 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860
7861# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862/*
7863 * This is our chance to ask the user if they want to save,
7864 * or abort the logout
7865 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007867xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868{
7869 cmdmod_T save_cmdmod;
7870 int cancel_shutdown = False;
7871
7872 save_cmdmod = cmdmod;
7873 cmdmod.confirm = TRUE;
Bram Moolenaar027387f2016-01-02 22:25:52 +01007874 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01007875 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 cancel_shutdown = True;
7877 cmdmod = save_cmdmod;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007878 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 out_flush();
7880
Bram Moolenaar0f873732019-12-05 20:28:46 +01007881 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 SmcInteractDone(smc_conn, cancel_shutdown);
7883
Bram Moolenaar0f873732019-12-05 20:28:46 +01007884 // Finish off
7885 // Only end save-yourself here if we're not cancelling shutdown;
7886 // we'll get a cancelled callback later in which we'll end it.
7887 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 if (!cancel_shutdown)
7889 {
7890 xsmp.save_yourself = False;
7891 SmcSaveYourselfDone(smc_conn, True);
7892 }
7893}
7894# endif
7895
7896/*
7897 * Callback that starts save-yourself.
7898 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007900xsmp_handle_save_yourself(
7901 SmcConn smc_conn,
7902 SmPointer client_data UNUSED,
7903 int save_type UNUSED,
7904 Bool shutdown,
7905 int interact_style UNUSED,
7906 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007908 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 if (xsmp.save_yourself)
7910 SmcSaveYourselfDone(smc_conn, True);
7911 xsmp.save_yourself = True;
7912 xsmp.shutdown = shutdown;
7913
Bram Moolenaar0f873732019-12-05 20:28:46 +01007914 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01007916 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917
7918 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007919 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920
7921# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007922 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007924 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 SmcInteractRequest(smc_conn, SmDialogError,
7926 xsmp_handle_interaction, client_data);
7927 else
7928# endif
7929 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007930 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 SmcSaveYourselfDone(smc_conn, True);
7932 xsmp.save_yourself = False;
7933 }
7934}
7935
7936
7937/*
7938 * Callback to warn us of imminent death.
7939 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007941xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942{
7943 xsmp_close();
7944
Bram Moolenaar0f873732019-12-05 20:28:46 +01007945 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 getout_preserve_modified(0);
7947}
7948
7949
7950/*
7951 * Callback to tell us that save-yourself has completed.
7952 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007954xsmp_save_complete(
7955 SmcConn smc_conn UNUSED,
7956 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957{
7958 xsmp.save_yourself = False;
7959}
7960
7961
7962/*
7963 * Callback to tell us that an instigated shutdown was cancelled
7964 * (maybe even by us)
7965 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007967xsmp_shutdown_cancelled(
7968 SmcConn smc_conn,
7969 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970{
7971 if (xsmp.save_yourself)
7972 SmcSaveYourselfDone(smc_conn, True);
7973 xsmp.save_yourself = False;
7974 xsmp.shutdown = False;
7975}
7976
7977
7978/*
7979 * Callback to tell us that a new ICE connection has been established.
7980 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007982xsmp_ice_connection(
7983 IceConn iceConn,
7984 IcePointer clientData UNUSED,
7985 Bool opening,
7986 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007988 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 if (opening)
7990 {
7991 xsmp_icefd = IceConnectionNumber(iceConn);
7992 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
7993 }
7994}
7995
7996
Bram Moolenaar0f873732019-12-05 20:28:46 +01007997// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007999xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000{
8001 Bool rep;
8002
8003 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
8004 == IceProcessMessagesIOError)
8005 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01008006 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008008 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 xsmp_close();
8010 return FAIL;
8011 }
8012 else
8013 return OK;
8014}
8015
8016static int dummy;
8017
Bram Moolenaar0f873732019-12-05 20:28:46 +01008018// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 void
8020xsmp_init(void)
8021{
8022 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 SmcCallbacks smcallbacks;
8024#if 0
8025 SmPropValue smname;
8026 SmProp smnameprop;
8027 SmProp *smprops[1];
8028#endif
8029
8030 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008031 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032
8033 xsmp.save_yourself = xsmp.shutdown = False;
8034
Bram Moolenaar0f873732019-12-05 20:28:46 +01008035 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
8037 smcallbacks.save_yourself.client_data = NULL;
8038 smcallbacks.die.callback = xsmp_die;
8039 smcallbacks.die.client_data = NULL;
8040 smcallbacks.save_complete.callback = xsmp_save_complete;
8041 smcallbacks.save_complete.client_data = NULL;
8042 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
8043 smcallbacks.shutdown_cancelled.client_data = NULL;
8044
Bram Moolenaar0f873732019-12-05 20:28:46 +01008045 // Set up a watch on ICE connection creations. The "dummy" argument is
8046 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8048 {
8049 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008050 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 return;
8052 }
8053
Bram Moolenaar0f873732019-12-05 20:28:46 +01008054 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 xsmp.smcconn = SmcOpenConnection(
8056 NULL,
8057 NULL,
8058 SmProtoMajor,
8059 SmProtoMinor,
8060 SmcSaveYourselfProcMask | SmcDieProcMask
8061 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8062 &smcallbacks,
8063 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008064 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008065 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 errorstring);
8067 if (xsmp.smcconn == NULL)
8068 {
8069 char errorreport[132];
Bram Moolenaar051b7822005-05-19 21:00:46 +00008070
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008072 {
8073 vim_snprintf(errorreport, sizeof(errorreport),
8074 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008075 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008076 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 return;
8078 }
8079 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8080
8081#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008082 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 smname.value = "vim";
8084 smname.length = 3;
8085 smnameprop.name = "SmProgram";
8086 smnameprop.type = "SmARRAY8";
8087 smnameprop.num_vals = 1;
8088 smnameprop.vals = &smname;
8089
8090 smprops[0] = &smnameprop;
8091 SmcSetProperties(xsmp.smcconn, 1, smprops);
8092#endif
8093}
8094
8095
Bram Moolenaar0f873732019-12-05 20:28:46 +01008096// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008098xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099{
8100 if (xsmp_icefd != -1)
8101 {
8102 SmcCloseConnection(xsmp.smcconn, 0, NULL);
Bram Moolenaar5a221812008-11-12 12:08:45 +00008103 if (xsmp.clientid != NULL)
8104 free(xsmp.clientid);
Bram Moolenaare8208012008-06-20 09:59:25 +00008105 xsmp.clientid = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 xsmp_icefd = -1;
8107 }
8108}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008109#endif // USE_XSMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110
8111
8112#ifdef EBCDIC
Bram Moolenaar0f873732019-12-05 20:28:46 +01008113// Translate character to its CTRL- value
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114char CtrlTable[] =
8115{
8116/* 00 - 5E */
8117 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8118 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8119 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8120 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8121 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8122 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8123/* ^ */ 0x1E,
8124/* - */ 0x1F,
8125/* 61 - 6C */
8126 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8127/* _ */ 0x1F,
8128/* 6E - 80 */
8129 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8130/* a */ 0x01,
8131/* b */ 0x02,
8132/* c */ 0x03,
8133/* d */ 0x37,
8134/* e */ 0x2D,
8135/* f */ 0x2E,
8136/* g */ 0x2F,
8137/* h */ 0x16,
8138/* i */ 0x05,
8139/* 8A - 90 */
8140 0, 0, 0, 0, 0, 0, 0,
8141/* j */ 0x15,
8142/* k */ 0x0B,
8143/* l */ 0x0C,
8144/* m */ 0x0D,
8145/* n */ 0x0E,
8146/* o */ 0x0F,
8147/* p */ 0x10,
8148/* q */ 0x11,
8149/* r */ 0x12,
8150/* 9A - A1 */
8151 0, 0, 0, 0, 0, 0, 0, 0,
8152/* s */ 0x13,
8153/* t */ 0x3C,
8154/* u */ 0x3D,
8155/* v */ 0x32,
8156/* w */ 0x26,
8157/* x */ 0x18,
8158/* y */ 0x19,
8159/* z */ 0x3F,
8160/* AA - AC */
8161 0, 0, 0,
8162/* [ */ 0x27,
8163/* AE - BC */
8164 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8165/* ] */ 0x1D,
8166/* BE - C0 */ 0, 0, 0,
8167/* A */ 0x01,
8168/* B */ 0x02,
8169/* C */ 0x03,
8170/* D */ 0x37,
8171/* E */ 0x2D,
8172/* F */ 0x2E,
8173/* G */ 0x2F,
8174/* H */ 0x16,
8175/* I */ 0x05,
8176/* CA - D0 */ 0, 0, 0, 0, 0, 0, 0,
8177/* J */ 0x15,
8178/* K */ 0x0B,
8179/* L */ 0x0C,
8180/* M */ 0x0D,
8181/* N */ 0x0E,
8182/* O */ 0x0F,
8183/* P */ 0x10,
8184/* Q */ 0x11,
8185/* R */ 0x12,
8186/* DA - DF */ 0, 0, 0, 0, 0, 0,
8187/* \ */ 0x1C,
8188/* E1 */ 0,
8189/* S */ 0x13,
8190/* T */ 0x3C,
8191/* U */ 0x3D,
8192/* V */ 0x32,
8193/* W */ 0x26,
8194/* X */ 0x18,
8195/* Y */ 0x19,
8196/* Z */ 0x3F,
8197/* EA - FF*/ 0, 0, 0, 0, 0, 0,
8198 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8199};
8200
8201char MetaCharTable[]=
Bram Moolenaar0f873732019-12-05 20:28:46 +01008202{// 0 1 2 3 4 5 6 7 8 9 A B C D E F
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 0, 0, 0, 0,'\\', 0,'F', 0,'W','M','N', 0, 0, 0, 0, 0,
8204 0, 0, 0, 0,']', 0, 0,'G', 0, 0,'R','O', 0, 0, 0, 0,
8205 '@','A','B','C','D','E', 0, 0,'H','I','J','K','L', 0, 0, 0,
8206 'P','Q', 0,'S','T','U','V', 0,'X','Y','Z','[', 0, 0,'^', 0
8207};
8208
8209
Bram Moolenaar0f873732019-12-05 20:28:46 +01008210// TODO: Use characters NOT numbers!!!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211char CtrlCharTable[]=
Bram Moolenaar0f873732019-12-05 20:28:46 +01008212{// 0 1 2 3 4 5 6 7 8 9 A B C D E F
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213 124,193,194,195, 0,201, 0, 0, 0, 0, 0,210,211,212,213,214,
8214 215,216,217,226, 0,209,200, 0,231,232, 0, 0,224,189, 95,109,
8215 0, 0, 0, 0, 0, 0,230,173, 0, 0, 0, 0, 0,197,198,199,
8216 0, 0,229, 0, 0, 0, 0,196, 0, 0, 0, 0,227,228, 0,233,
8217};
8218
8219
8220#endif