blob: c6d386b92923231eb3c51f66191d3b929019c485 [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!!!
15 * Also for BeOS and Atari MiNT.
16 *
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 Moolenaar643b6142018-09-12 20:29:09 +020046#ifdef __BEOS__
Bram Moolenaar311d9822007-02-27 15:48:28 +000047# undef select
Bram Moolenaar643b6142018-09-12 20:29:09 +020048# define select beos_select
Bram Moolenaar071d4272004-06-13 20:20:40 +000049#endif
50
Bram Moolenaara2442432007-04-26 14:26:37 +000051#ifdef __CYGWIN__
Bram Moolenaar4f974752019-02-17 17:44:42 +010052# ifndef MSWIN
Bram Moolenaar0d1498e2008-06-29 12:00:49 +000053# include <cygwin/version.h>
Bram Moolenaar0f873732019-12-05 20:28:46 +010054# include <sys/cygwin.h> // for cygwin_conv_to_posix_path() and/or
55 // for cygwin_conv_path()
Bram Moolenaar693e40c2013-02-26 14:56:42 +010056# ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
57# define WIN32_LEAN_AND_MEAN
58# include <windows.h>
59# include "winclip.pro"
60# endif
Bram Moolenaara2442432007-04-26 14:26:37 +000061# endif
62#endif
63
Bram Moolenaar071d4272004-06-13 20:20:40 +000064#ifdef FEAT_MOUSE_GPM
65# include <gpm.h>
Bram Moolenaar0f873732019-12-05 20:28:46 +010066// <linux/keyboard.h> contains defines conflicting with "keymap.h",
67// I just copied relevant defines here. A cleaner solution would be to put gpm
68// code into separate file and include there linux/keyboard.h
69// #include <linux/keyboard.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +000070# define KG_SHIFT 0
71# define KG_CTRL 2
72# define KG_ALT 3
73# define KG_ALTGR 1
74# define KG_SHIFTL 4
75# define KG_SHIFTR 5
76# define KG_CTRLL 6
77# define KG_CTRLR 7
78# define KG_CAPSSHIFT 8
79
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010080static void gpm_close(void);
81static int gpm_open(void);
82static int mch_gpm_process(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000083#endif
84
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000085#ifdef FEAT_SYSMOUSE
86# include <sys/consio.h>
87# include <sys/fbio.h>
88
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010089static int sysmouse_open(void);
90static void sysmouse_close(void);
Bram Moolenaard99df422016-01-29 23:20:40 +010091static RETSIGTYPE sig_sysmouse SIGPROTOARG;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000092#endif
93
Bram Moolenaar071d4272004-06-13 20:20:40 +000094/*
95 * end of autoconf section. To be extended...
96 */
97
Bram Moolenaar0f873732019-12-05 20:28:46 +010098// Are the following #ifdefs still required? And why? Is that for X11?
Bram Moolenaar071d4272004-06-13 20:20:40 +000099
100#if defined(ESIX) || defined(M_UNIX) && !defined(SCO)
101# ifdef SIGWINCH
102# undef SIGWINCH
103# endif
104# ifdef TIOCGWINSZ
105# undef TIOCGWINSZ
106# endif
107#endif
108
Bram Moolenaar0f873732019-12-05 20:28:46 +0100109#if defined(SIGWINDOW) && !defined(SIGWINCH) // hpux 9.01 has it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110# define SIGWINCH SIGWINDOW
111#endif
112
113#ifdef FEAT_X11
114# include <X11/Xlib.h>
115# include <X11/Xutil.h>
116# include <X11/Xatom.h>
117# ifdef FEAT_XCLIPBOARD
118# include <X11/Intrinsic.h>
119# include <X11/Shell.h>
120# include <X11/StringDefs.h>
121static Widget xterm_Shell = (Widget)0;
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100122static void clip_update(void);
123static void xterm_update(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124# endif
125
126# if defined(FEAT_XCLIPBOARD) || defined(FEAT_TITLE)
127Window x11_window = 0;
128# endif
129Display *x11_display = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130#endif
131
132#ifdef FEAT_TITLE
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100133static int get_x11_title(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
135static char_u *oldtitle = NULL;
Bram Moolenaar8e82c052018-08-21 19:47:48 +0200136static volatile sig_atomic_t oldtitle_outdated = FALSE;
Bram Moolenaardac13472019-09-16 21:06:21 +0200137static int unix_did_set_title = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138static char_u *oldicon = NULL;
139static int did_set_icon = FALSE;
140#endif
141
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100142static void may_core_dump(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143
Bram Moolenaar205b8862011-09-07 15:04:31 +0200144#ifdef HAVE_UNION_WAIT
145typedef union wait waitstatus;
146#else
147typedef int waitstatus;
148#endif
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200149static int WaitForChar(long msec, int *interrupted, int ignore_input);
150static int WaitForCharOrMouse(long msec, int *interrupted, int ignore_input);
Bram Moolenaar4ffa0702013-12-11 17:12:37 +0100151#if defined(__BEOS__) || defined(VMS)
Bram Moolenaarcda77642016-06-04 13:32:35 +0200152int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153#else
Bram Moolenaarcda77642016-06-04 13:32:35 +0200154static int RealWaitForChar(int, long, int *, int *interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155#endif
156
157#ifdef FEAT_XCLIPBOARD
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100158static int do_xterm_trace(void);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100159# define XT_TRACE_DELAY 50 // delay for xterm tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160#endif
161
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100162static void handle_resize(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163
164#if defined(SIGWINCH)
Bram Moolenaard99df422016-01-29 23:20:40 +0100165static RETSIGTYPE sig_winch SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166#endif
167#if defined(SIGINT)
Bram Moolenaard99df422016-01-29 23:20:40 +0100168static RETSIGTYPE catch_sigint SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169#endif
170#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 Moolenaar0f873732019-12-05 20:28:46 +0100216static int curr_tmode = TMODE_COOK; // contains current terminal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
218#ifdef USE_XSMP
219typedef struct
220{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100221 SmcConn smcconn; // The SM connection ID
222 IceConn iceconn; // The ICE connection ID
223 char *clientid; // The client ID for the current smc session
224 Bool save_yourself; // If we're in the middle of a save_yourself
225 Bool shutdown; // If we're in shutdown mode
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226} xsmp_config_T;
227
228static xsmp_config_T xsmp;
229#endif
230
231#ifdef SYS_SIGLIST_DECLARED
232/*
233 * I have seen
234 * extern char *_sys_siglist[NSIG];
235 * on Irix, Linux, NetBSD and Solaris. It contains a nice list of strings
236 * that describe the signals. That is nearly what we want here. But
237 * autoconf does only check for sys_siglist (without the underscore), I
238 * do not want to change everything today.... jw.
Bram Moolenaar3f7d0902016-11-12 21:13:42 +0100239 * This is why AC_DECL_SYS_SIGLIST is commented out in configure.ac.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240 */
241#endif
242
243static struct signalinfo
244{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100245 int sig; // Signal number, eg. SIGSEGV etc
246 char *name; // Signal name (not char_u!).
247 char deadly; // Catch as a deadly signal?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248} signal_info[] =
249{
250#ifdef SIGHUP
251 {SIGHUP, "HUP", TRUE},
252#endif
253#ifdef SIGQUIT
254 {SIGQUIT, "QUIT", TRUE},
255#endif
256#ifdef SIGILL
257 {SIGILL, "ILL", TRUE},
258#endif
259#ifdef SIGTRAP
260 {SIGTRAP, "TRAP", TRUE},
261#endif
262#ifdef SIGABRT
263 {SIGABRT, "ABRT", TRUE},
264#endif
265#ifdef SIGEMT
266 {SIGEMT, "EMT", TRUE},
267#endif
268#ifdef SIGFPE
269 {SIGFPE, "FPE", TRUE},
270#endif
271#ifdef SIGBUS
272 {SIGBUS, "BUS", TRUE},
273#endif
Bram Moolenaar75676462013-01-30 14:55:42 +0100274#if defined(SIGSEGV) && !defined(FEAT_MZSCHEME)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100275 // MzScheme uses SEGV in its garbage collector
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 {SIGSEGV, "SEGV", TRUE},
277#endif
278#ifdef SIGSYS
279 {SIGSYS, "SYS", TRUE},
280#endif
281#ifdef SIGALRM
Bram Moolenaar0f873732019-12-05 20:28:46 +0100282 {SIGALRM, "ALRM", FALSE}, // Perl's alarm() can trigger it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283#endif
284#ifdef SIGTERM
285 {SIGTERM, "TERM", TRUE},
286#endif
Bram Moolenaarb292a2a2011-02-09 18:47:40 +0100287#if defined(SIGVTALRM) && !defined(FEAT_RUBY)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288 {SIGVTALRM, "VTALRM", TRUE},
289#endif
Bram Moolenaar02f07e02008-03-12 12:17:28 +0000290#if defined(SIGPROF) && !defined(FEAT_MZSCHEME) && !defined(WE_ARE_PROFILING)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100291 // MzScheme uses SIGPROF for its own needs; On Linux with profiling
292 // this makes Vim exit. WE_ARE_PROFILING is defined in Makefile.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293 {SIGPROF, "PROF", TRUE},
294#endif
295#ifdef SIGXCPU
296 {SIGXCPU, "XCPU", TRUE},
297#endif
298#ifdef SIGXFSZ
299 {SIGXFSZ, "XFSZ", TRUE},
300#endif
301#ifdef SIGUSR1
302 {SIGUSR1, "USR1", TRUE},
303#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000304#if defined(SIGUSR2) && !defined(FEAT_SYSMOUSE)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100305 // Used for sysmouse handling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 {SIGUSR2, "USR2", TRUE},
307#endif
308#ifdef SIGINT
309 {SIGINT, "INT", FALSE},
310#endif
311#ifdef SIGWINCH
312 {SIGWINCH, "WINCH", FALSE},
313#endif
314#ifdef SIGTSTP
315 {SIGTSTP, "TSTP", FALSE},
316#endif
317#ifdef SIGPIPE
318 {SIGPIPE, "PIPE", FALSE},
319#endif
320 {-1, "Unknown!", FALSE}
321};
322
Bram Moolenaar25724922009-07-14 15:38:41 +0000323 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100324mch_chdir(char *path)
Bram Moolenaar25724922009-07-14 15:38:41 +0000325{
326 if (p_verbose >= 5)
327 {
328 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100329 smsg("chdir(%s)", path);
Bram Moolenaar25724922009-07-14 15:38:41 +0000330 verbose_leave();
331 }
332# ifdef VMS
333 return chdir(vms_fixfilename(path));
334# else
335 return chdir(path);
336# endif
337}
338
Bram Moolenaar0f873732019-12-05 20:28:46 +0100339// Why is NeXT excluded here (and not in os_unixx.h)?
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +0100340#if defined(ECHOE) && defined(ICANON) \
341 && (defined(HAVE_TERMIO_H) || defined(HAVE_TERMIOS_H)) \
342 && !defined(__NeXT__)
Bram Moolenaar4f44b882017-08-13 20:06:18 +0200343# define NEW_TTY_SYSTEM
344#endif
345
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000346/*
Bram Moolenaard23a8232018-02-10 18:45:26 +0100347 * Write s[len] to the screen (stdout).
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +0000348 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100350mch_write(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351{
Bram Moolenaar42335f52018-09-13 15:33:43 +0200352 vim_ignored = (int)write(1, (char *)s, len);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100353 if (p_wd) // Unix is too fast, slow down a bit more
Bram Moolenaar8fdd7212016-03-26 19:41:48 +0100354 RealWaitForChar(read_cmd_fd, p_wd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355}
356
357/*
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100358 * Function passed to inchar_loop() to handle window resizing.
359 * If "check_only" is TRUE: Return whether there was a resize.
360 * If "check_only" is FALSE: Deal with the window resized.
361 */
362 static int
363resize_func(int check_only)
364{
365 if (check_only)
366 return do_resize;
367 while (do_resize)
368 handle_resize();
369 return FALSE;
370}
371
372/*
Bram Moolenaarc2a27c32007-12-01 16:19:33 +0000373 * mch_inchar(): low level input function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 * Get a characters from the keyboard.
375 * Return the number of characters that are available.
376 * If wtime == 0 do not wait for characters.
377 * If wtime == n wait a short time for characters.
378 * If wtime == -1 wait forever for characters.
379 */
380 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100381mch_inchar(
382 char_u *buf,
383 int maxlen,
Bram Moolenaar0f873732019-12-05 20:28:46 +0100384 long wtime, // don't use "time", MIPS cannot handle it
Bram Moolenaar05540972016-01-30 20:31:25 +0100385 int tb_change_cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386{
Bram Moolenaare40b9d42019-01-27 16:55:47 +0100387 return inchar_loop(buf, maxlen, wtime, tb_change_cnt,
388 WaitForChar, resize_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389}
390
391 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100392handle_resize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393{
394 do_resize = FALSE;
395 shell_resized();
396}
397
398/*
Bram Moolenaar40b1b542016-04-20 20:18:23 +0200399 * Return non-zero if a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400 */
401 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100402mch_char_avail(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403{
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200404 return WaitForChar(0L, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405}
406
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200407#if defined(FEAT_TERMINAL) || defined(PROTO)
408/*
409 * Check for any pending input or messages.
410 */
411 int
412mch_check_messages(void)
413{
414 return WaitForChar(0L, NULL, TRUE);
415}
416#endif
417
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418#if defined(HAVE_TOTAL_MEM) || defined(PROTO)
419# ifdef HAVE_SYS_RESOURCE_H
Bram Moolenaar8f0b2d42009-05-16 14:41:10 +0000420# include <sys/resource.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421# endif
422# if defined(HAVE_SYS_SYSCTL_H) && defined(HAVE_SYSCTL)
423# include <sys/sysctl.h>
424# endif
425# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
426# include <sys/sysinfo.h>
427# endif
Bram Moolenaar362dc332018-03-05 21:59:37 +0100428# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100429# include <mach/mach_host.h>
430# include <mach/mach_port.h>
Bram Moolenaar988615f2018-02-27 17:58:20 +0100431# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432
433/*
Bram Moolenaar914572a2007-05-01 11:37:47 +0000434 * Return total amount of memory available in Kbyte.
435 * Doesn't change when memory has been allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 long_u
Bram Moolenaar05540972016-01-30 20:31:25 +0100438mch_total_mem(int special UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440 long_u mem = 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +0100441 long_u shiftright = 10; // how much to shift "mem" right for Kbyte
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
Bram Moolenaar362dc332018-03-05 21:59:37 +0100443# ifdef MACOS_X
Bram Moolenaar988615f2018-02-27 17:58:20 +0100444 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100445 // Mac (Darwin) way of getting the amount of RAM available
Bram Moolenaar988615f2018-02-27 17:58:20 +0100446 mach_port_t host = mach_host_self();
447 kern_return_t kret;
448# ifdef HOST_VM_INFO64
449 struct vm_statistics64 vm_stat;
450 natural_t count = HOST_VM_INFO64_COUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451
Bram Moolenaar988615f2018-02-27 17:58:20 +0100452 kret = host_statistics64(host, HOST_VM_INFO64,
453 (host_info64_t)&vm_stat, &count);
454# else
455 struct vm_statistics vm_stat;
456 natural_t count = HOST_VM_INFO_COUNT;
457
458 kret = host_statistics(host, HOST_VM_INFO,
459 (host_info_t)&vm_stat, &count);
460# endif
461 if (kret == KERN_SUCCESS)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100462 // get the amount of user memory by summing each usage
Bram Moolenaar988615f2018-02-27 17:58:20 +0100463 mem = (long_u)(vm_stat.free_count + vm_stat.active_count
464 + vm_stat.inactive_count
465# ifdef MAC_OS_X_VERSION_10_9
466 + vm_stat.compressor_page_count
467# endif
Bram Moolenaar62b7f6a2018-03-22 21:44:07 +0100468 ) * sysconf(_SC_PAGESIZE);
Bram Moolenaar988615f2018-02-27 17:58:20 +0100469 mach_port_deallocate(mach_task_self(), host);
470 }
471# endif
472
473# ifdef HAVE_SYSCTL
474 if (mem == 0)
475 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100476 // BSD way of getting the amount of RAM available.
Bram Moolenaar988615f2018-02-27 17:58:20 +0100477 int mib[2];
478 size_t len = sizeof(long_u);
479# ifdef HW_USERMEM64
480 long_u physmem;
481# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100482 // sysctl() may return 32 bit or 64 bit, accept both
Bram Moolenaar988615f2018-02-27 17:58:20 +0100483 union {
484 int_u u32;
485 long_u u64;
486 } physmem;
487# endif
488
489 mib[0] = CTL_HW;
490# ifdef HW_USERMEM64
491 mib[1] = HW_USERMEM64;
492# else
493 mib[1] = HW_USERMEM;
494# endif
495 if (sysctl(mib, 2, &physmem, &len, NULL, 0) == 0)
496 {
497# ifdef HW_USERMEM64
498 mem = (long_u)physmem;
499# else
500 if (len == sizeof(physmem.u64))
501 mem = (long_u)physmem.u64;
502 else
503 mem = (long_u)physmem.u32;
504# endif
505 }
506 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200507# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200509# if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510 if (mem == 0)
511 {
512 struct sysinfo sinfo;
513
Bram Moolenaar0f873732019-12-05 20:28:46 +0100514 // Linux way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515 if (sysinfo(&sinfo) == 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000516 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200517# ifdef HAVE_SYSINFO_MEM_UNIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100518 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000519 while (shiftright > 0 && (sinfo.mem_unit & 1) == 0)
520 {
521 sinfo.mem_unit = sinfo.mem_unit >> 1;
522 --shiftright;
523 }
524 mem = sinfo.totalram * sinfo.mem_unit;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200525# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526 mem = sinfo.totalram;
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200527# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000528 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200530# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200532# ifdef HAVE_SYSCONF
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533 if (mem == 0)
534 {
535 long pagesize, pagecount;
536
Bram Moolenaar0f873732019-12-05 20:28:46 +0100537 // Solaris way of getting amount of RAM available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538 pagesize = sysconf(_SC_PAGESIZE);
539 pagecount = sysconf(_SC_PHYS_PAGES);
540 if (pagesize > 0 && pagecount > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000541 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100542 // avoid overflow as much as possible
Bram Moolenaar914572a2007-05-01 11:37:47 +0000543 while (shiftright > 0 && (pagesize & 1) == 0)
544 {
Bram Moolenaar3d27a452007-05-10 17:44:18 +0000545 pagesize = (long_u)pagesize >> 1;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000546 --shiftright;
547 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548 mem = (long_u)pagesize * pagecount;
Bram Moolenaar914572a2007-05-01 11:37:47 +0000549 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200551# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
Bram Moolenaar0f873732019-12-05 20:28:46 +0100553 // Return the minimum of the physical memory and the user limit, because
554 // using more than the user limit may cause Vim to be terminated.
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200555# if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 {
557 struct rlimit rlp;
558
559 if (getrlimit(RLIMIT_DATA, &rlp) == 0
560 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200561# ifdef RLIM_INFINITY
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562 && rlp.rlim_cur != RLIM_INFINITY
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200563# endif
Bram Moolenaar914572a2007-05-01 11:37:47 +0000564 && ((long_u)rlp.rlim_cur >> 10) < (mem >> shiftright)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 )
Bram Moolenaar914572a2007-05-01 11:37:47 +0000566 {
567 mem = (long_u)rlp.rlim_cur;
568 shiftright = 10;
569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200571# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
573 if (mem > 0)
Bram Moolenaar914572a2007-05-01 11:37:47 +0000574 return mem >> shiftright;
575 return (long_u)0x1fffff;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576}
577#endif
578
579 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100580mch_delay(long msec, int ignoreinput)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581{
582 int old_tmode;
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000583#ifdef FEAT_MZSCHEME
Bram Moolenaar0f873732019-12-05 20:28:46 +0100584 long total = msec; // remember original value
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000585#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
587 if (ignoreinput)
588 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100589 // Go to cooked mode without echo, to allow SIGINT interrupting us
590 // here. But we don't want QUIT to kill us (CTRL-\ used in a
591 // shell may produce SIGQUIT).
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000592 in_mch_delay = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593 old_tmode = curr_tmode;
594 if (curr_tmode == TMODE_RAW)
595 settmode(TMODE_SLEEP);
596
597 /*
598 * Everybody sleeps in a different way...
599 * Prefer nanosleep(), some versions of usleep() can only sleep up to
600 * one second.
601 */
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000602#ifdef FEAT_MZSCHEME
603 do
604 {
Bram Moolenaar0f873732019-12-05 20:28:46 +0100605 // if total is large enough, wait by portions in p_mzq
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000606 if (total > p_mzq)
607 msec = p_mzq;
608 else
609 msec = total;
610 total -= msec;
611#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612#ifdef HAVE_NANOSLEEP
613 {
614 struct timespec ts;
615
616 ts.tv_sec = msec / 1000;
617 ts.tv_nsec = (msec % 1000) * 1000000;
618 (void)nanosleep(&ts, NULL);
619 }
620#else
621# ifdef HAVE_USLEEP
622 while (msec >= 1000)
623 {
624 usleep((unsigned int)(999 * 1000));
625 msec -= 999;
626 }
627 usleep((unsigned int)(msec * 1000));
628# else
629# ifndef HAVE_SELECT
630 poll(NULL, 0, (int)msec);
631# else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 {
633 struct timeval tv;
634
635 tv.tv_sec = msec / 1000;
636 tv.tv_usec = (msec % 1000) * 1000;
637 /*
638 * NOTE: Solaris 2.6 has a bug that makes select() hang here. Get
639 * a patch from Sun to fix this. Reported by Gunnar Pedersen.
640 */
641 select(0, NULL, NULL, NULL, &tv);
642 }
Bram Moolenaar0f873732019-12-05 20:28:46 +0100643# endif // HAVE_SELECT
644# endif // HAVE_NANOSLEEP
645#endif // HAVE_USLEEP
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000646#ifdef FEAT_MZSCHEME
647 }
648 while (total > 0);
649#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651 settmode(old_tmode);
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000652 in_mch_delay = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 }
654 else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +0200655 WaitForChar(msec, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656}
657
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000658#if defined(HAVE_STACK_LIMIT) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 || (!defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGSTACK))
660# define HAVE_CHECK_STACK_GROWTH
661/*
662 * Support for checking for an almost-out-of-stack-space situation.
663 */
664
665/*
666 * Return a pointer to an item on the stack. Used to find out if the stack
667 * grows up or down.
668 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669static int stack_grows_downwards;
670
671/*
672 * Find out if the stack grows upwards or downwards.
673 * "p" points to a variable on the stack of the caller.
674 */
675 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100676check_stack_growth(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677{
678 int i;
679
680 stack_grows_downwards = (p > (char *)&i);
681}
682#endif
683
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000684#if defined(HAVE_STACK_LIMIT) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685static char *stack_limit = NULL;
686
687#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
688# include <pthread.h>
689# include <pthread_np.h>
690#endif
691
692/*
693 * Find out until how var the stack can grow without getting into trouble.
694 * Called when starting up and when switching to the signal stack in
695 * deathtrap().
696 */
697 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100698get_stack_limit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699{
700 struct rlimit rlp;
701 int i;
702 long lim;
703
Bram Moolenaar0f873732019-12-05 20:28:46 +0100704 // Set the stack limit to 15/16 of the allowable size. Skip this when the
705 // limit doesn't fit in a long (rlim_cur might be "long long").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 if (getrlimit(RLIMIT_STACK, &rlp) == 0
707 && rlp.rlim_cur < ((rlim_t)1 << (sizeof(long_u) * 8 - 1))
708# ifdef RLIM_INFINITY
709 && rlp.rlim_cur != RLIM_INFINITY
710# endif
711 )
712 {
713 lim = (long)rlp.rlim_cur;
714#if defined(_THREAD_SAFE) && defined(HAVE_PTHREAD_NP_H)
715 {
716 pthread_attr_t attr;
717 size_t size;
718
Bram Moolenaar0f873732019-12-05 20:28:46 +0100719 // On FreeBSD the initial thread always has a fixed stack size, no
720 // matter what the limits are set to. Normally it's 1 Mbyte.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 pthread_attr_init(&attr);
722 if (pthread_attr_get_np(pthread_self(), &attr) == 0)
723 {
724 pthread_attr_getstacksize(&attr, &size);
725 if (lim > (long)size)
726 lim = (long)size;
727 }
728 pthread_attr_destroy(&attr);
729 }
730#endif
731 if (stack_grows_downwards)
732 {
733 stack_limit = (char *)((long)&i - (lim / 16L * 15L));
734 if (stack_limit >= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100735 // overflow, set to 1/16 of current stack position
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 stack_limit = (char *)((long)&i / 16L);
737 }
738 else
739 {
740 stack_limit = (char *)((long)&i + (lim / 16L * 15L));
741 if (stack_limit <= (char *)&i)
Bram Moolenaar0f873732019-12-05 20:28:46 +0100742 stack_limit = NULL; // overflow
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 }
744 }
745}
746
747/*
748 * Return FAIL when running out of stack space.
749 * "p" must point to any variable local to the caller that's on the stack.
750 */
751 int
Bram Moolenaar05540972016-01-30 20:31:25 +0100752mch_stackcheck(char *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753{
754 if (stack_limit != NULL)
755 {
756 if (stack_grows_downwards)
757 {
758 if (p < stack_limit)
759 return FAIL;
760 }
761 else if (p > stack_limit)
762 return FAIL;
763 }
764 return OK;
765}
766#endif
767
768#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
769/*
770 * Support for using the signal stack.
771 * This helps when we run out of stack space, which causes a SIGSEGV. The
772 * signal handler then must run on another stack, since the normal stack is
773 * completely full.
774 */
775
776#ifndef SIGSTKSZ
Bram Moolenaar0f873732019-12-05 20:28:46 +0100777# define SIGSTKSZ 8000 // just a guess of how much stack is needed...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778#endif
779
780# ifdef HAVE_SIGALTSTACK
Bram Moolenaar0f873732019-12-05 20:28:46 +0100781static stack_t sigstk; // for sigaltstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782# else
Bram Moolenaar0f873732019-12-05 20:28:46 +0100783static struct sigstack sigstk; // for sigstack()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784# endif
785
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786static char *signal_stack;
787
788 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100789init_signal_stack(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790{
791 if (signal_stack != NULL)
792 {
793# ifdef HAVE_SIGALTSTACK
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794# ifdef HAVE_SS_BASE
795 sigstk.ss_base = signal_stack;
796# else
797 sigstk.ss_sp = signal_stack;
798# endif
799 sigstk.ss_size = SIGSTKSZ;
800 sigstk.ss_flags = 0;
801 (void)sigaltstack(&sigstk, NULL);
802# else
803 sigstk.ss_sp = signal_stack;
804 if (stack_grows_downwards)
805 sigstk.ss_sp += SIGSTKSZ - 1;
806 sigstk.ss_onstack = 0;
807 (void)sigstack(&sigstk, NULL);
808# endif
809 }
810}
811#endif
812
813/*
Bram Moolenaar76243bd2009-03-02 01:47:02 +0000814 * We need correct prototypes for a signal function, otherwise mean compilers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 * will barf when the second argument to signal() is ``wrong''.
816 * Let me try it with a few tricky defines from my own osdef.h (jw).
817 */
818#if defined(SIGWINCH)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 static RETSIGTYPE
820sig_winch SIGDEFARG(sigarg)
821{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100822 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 signal(SIGWINCH, (RETSIGTYPE (*)())sig_winch);
824 do_resize = TRUE;
825 SIGRETURN;
826}
827#endif
828
829#if defined(SIGINT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 static RETSIGTYPE
831catch_sigint SIGDEFARG(sigarg)
832{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100833 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 signal(SIGINT, (RETSIGTYPE (*)())catch_sigint);
835 got_int = TRUE;
836 SIGRETURN;
837}
838#endif
839
840#if defined(SIGPWR)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 static RETSIGTYPE
842catch_sigpwr SIGDEFARG(sigarg)
843{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100844 // this is not required on all systems, but it doesn't hurt anybody
Bram Moolenaard8b0cf12004-12-12 11:33:30 +0000845 signal(SIGPWR, (RETSIGTYPE (*)())catch_sigpwr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 /*
847 * I'm not sure we get the SIGPWR signal when the system is really going
848 * down or when the batteries are almost empty. Just preserve the swap
849 * files and don't exit, that can't do any harm.
850 */
851 ml_sync_all(FALSE, FALSE);
852 SIGRETURN;
853}
854#endif
855
856#ifdef SET_SIG_ALARM
857/*
858 * signal function for alarm().
859 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 static RETSIGTYPE
861sig_alarm SIGDEFARG(sigarg)
862{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100863 // doesn't do anything, just to break a system call
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 sig_alarm_called = TRUE;
865 SIGRETURN;
866}
867#endif
868
Bram Moolenaaredce7422019-01-20 18:39:30 +0100869#if (defined(HAVE_SETJMP_H) \
870 && ((defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) \
871 || defined(FEAT_LIBCALL))) \
872 || defined(PROTO)
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100873# define USING_SETJMP 1
Bram Moolenaaredce7422019-01-20 18:39:30 +0100874
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100875// argument to SETJMP()
876static JMP_BUF lc_jump_env;
877
878# ifdef SIGHASARG
Bram Moolenaar32aa1022019-11-02 22:54:41 +0100879// Caught signal number, 0 when no signal was caught; used for mch_libcall().
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100880// Volatile because it is used in signal handlers.
881static volatile sig_atomic_t lc_signal;
882# endif
883
884// TRUE when lc_jump_env is valid.
885// Volatile because it is used in signal handler deathtrap().
886static volatile sig_atomic_t lc_active INIT(= FALSE);
887
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888/*
889 * A simplistic version of setjmp() that only allows one level of using.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100890 * Used to protect areas where we could crash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 * Don't call twice before calling mch_endjmp()!.
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100892 *
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 * Usage:
894 * mch_startjmp();
895 * if (SETJMP(lc_jump_env) != 0)
896 * {
897 * mch_didjmp();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100898 * emsg("crash!");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 * }
900 * else
901 * {
902 * do_the_work;
903 * mch_endjmp();
904 * }
905 * Note: Can't move SETJMP() here, because a function calling setjmp() must
906 * not return before the saved environment is used.
907 * Returns OK for normal return, FAIL when the protected code caused a
908 * problem and LONGJMP() was used.
909 */
Bram Moolenaar113e1072019-01-20 15:30:40 +0100910 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100911mch_startjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912{
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100913# ifdef SIGHASARG
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 lc_signal = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100915# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 lc_active = TRUE;
917}
918
Bram Moolenaar113e1072019-01-20 15:30:40 +0100919 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100920mch_endjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921{
922 lc_active = FALSE;
923}
924
Bram Moolenaar113e1072019-01-20 15:30:40 +0100925 static void
Bram Moolenaar05540972016-01-30 20:31:25 +0100926mch_didjmp(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927{
928# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarb7a7e032018-12-28 17:01:59 +0100929 // On FreeBSD the signal stack has to be reset after using siglongjmp(),
930 // otherwise catching the signal only works once.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 init_signal_stack();
932# endif
933}
934#endif
935
936/*
937 * This function handles deadly signals.
Bram Moolenaarbec9c202013-09-05 21:41:39 +0200938 * It tries to preserve any swap files and exit properly.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 * (partly from Elvis).
Bram Moolenaarbec9c202013-09-05 21:41:39 +0200940 * NOTE: Avoid unsafe functions, such as allocating memory, they can result in
941 * a deadlock.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 */
943 static RETSIGTYPE
944deathtrap SIGDEFARG(sigarg)
945{
Bram Moolenaar0f873732019-12-05 20:28:46 +0100946 static int entered = 0; // count the number of times we got here.
947 // Note: when memory has been corrupted
948 // this may get an arbitrary value!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949#ifdef SIGHASARG
950 int i;
951#endif
952
Bram Moolenaarb2148f52019-01-20 23:43:57 +0100953#if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 /*
955 * Catch a crash in protected code.
956 * Restores the environment saved in lc_jump_env, which looks like
957 * SETJMP() returns 1.
958 */
959 if (lc_active)
960 {
961# if defined(SIGHASARG)
962 lc_signal = sigarg;
963# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +0100964 lc_active = FALSE; // don't jump again
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 LONGJMP(lc_jump_env, 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +0100966 // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 }
968#endif
969
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000970#ifdef SIGHASARG
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000971# ifdef SIGQUIT
Bram Moolenaar0f873732019-12-05 20:28:46 +0100972 // While in mch_delay() we go to cooked mode to allow a CTRL-C to
973 // interrupt us. But in cooked mode we may also get SIGQUIT, e.g., when
974 // pressing CTRL-\, but we don't want Vim to exit then.
Bram Moolenaarae0f2ca2008-02-10 21:25:55 +0000975 if (in_mch_delay && sigarg == SIGQUIT)
976 SIGRETURN;
977# endif
978
Bram Moolenaar0f873732019-12-05 20:28:46 +0100979 // When SIGHUP, SIGQUIT, etc. are blocked: postpone the effect and return
980 // here. This avoids that a non-reentrant function is interrupted, e.g.,
981 // free(). Calling free() again may then cause a crash.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +0000982 if (entered == 0
983 && (0
984# ifdef SIGHUP
985 || sigarg == SIGHUP
986# endif
987# ifdef SIGQUIT
988 || sigarg == SIGQUIT
989# endif
990# ifdef SIGTERM
991 || sigarg == SIGTERM
992# endif
993# ifdef SIGPWR
994 || sigarg == SIGPWR
995# endif
996# ifdef SIGUSR1
997 || sigarg == SIGUSR1
998# endif
999# ifdef SIGUSR2
1000 || sigarg == SIGUSR2
1001# endif
1002 )
Bram Moolenaar1f28b072005-07-12 22:42:41 +00001003 && !vim_handle_signal(sigarg))
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 SIGRETURN;
1005#endif
1006
Bram Moolenaar0f873732019-12-05 20:28:46 +01001007 // Remember how often we have been called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 ++entered;
1009
Bram Moolenaar0f873732019-12-05 20:28:46 +01001010 // Executing autocommands is likely to use more stack space than we have
1011 // available in the signal stack.
Bram Moolenaare429e702016-06-10 19:49:14 +02001012 block_autocmds();
Bram Moolenaare429e702016-06-10 19:49:14 +02001013
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014#ifdef FEAT_EVAL
Bram Moolenaar0f873732019-12-05 20:28:46 +01001015 // Set the v:dying variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 set_vim_var_nr(VV_DYING, (long)entered);
1017#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001018 v_dying = entered;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00001020#ifdef HAVE_STACK_LIMIT
Bram Moolenaar0f873732019-12-05 20:28:46 +01001021 // Since we are now using the signal stack, need to reset the stack
1022 // limit. Otherwise using a regexp will fail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 get_stack_limit();
1024#endif
1025
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001026#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01001027 // This is for opening gdb the moment Vim crashes.
1028 // You need to manually adjust the file name and Vim executable name.
1029 // Suggested by SungHyun Nam.
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001030 {
1031# define VI_GDB_FILE "/tmp/vimgdb"
1032# define VIM_NAME "/usr/bin/vim"
1033 FILE *fp = fopen(VI_GDB_FILE, "w");
1034 if (fp)
1035 {
1036 fprintf(fp,
1037 "file %s\n"
1038 "attach %d\n"
1039 "set height 1000\n"
1040 "bt full\n"
1041 , VIM_NAME, getpid());
1042 fclose(fp);
1043 system("xterm -e gdb -x "VI_GDB_FILE);
1044 unlink(VI_GDB_FILE);
1045 }
1046 }
1047#endif
1048
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049#ifdef SIGHASARG
Bram Moolenaar0f873732019-12-05 20:28:46 +01001050 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 for (i = 0; signal_info[i].sig != -1; i++)
1052 if (sigarg == signal_info[i].sig)
1053 break;
1054 deadly_signal = sigarg;
1055#endif
1056
Bram Moolenaar0f873732019-12-05 20:28:46 +01001057 full_screen = FALSE; // don't write message to the GUI, it might be
1058 // part of the problem...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 /*
1060 * If something goes wrong after entering here, we may get here again.
1061 * When this happens, give a message and try to exit nicely (resetting the
1062 * terminal mode, etc.)
1063 * When this happens twice, just exit, don't even try to give a message,
1064 * stack may be corrupt or something weird.
1065 * When this still happens again (or memory was corrupted in such a way
1066 * that "entered" was clobbered) use _exit(), don't try freeing resources.
1067 */
1068 if (entered >= 3)
1069 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001070 reset_signals(); // don't catch any signals anymore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 may_core_dump();
1072 if (entered >= 4)
1073 _exit(8);
1074 exit(7);
1075 }
1076 if (entered == 2)
1077 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001078 // No translation, it may call malloc().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001079 OUT_STR("Vim: Double signal, exiting\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 out_flush();
1081 getout(1);
1082 }
1083
Bram Moolenaar0f873732019-12-05 20:28:46 +01001084 // No translation, it may call malloc().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085#ifdef SIGHASARG
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001086 sprintf((char *)IObuff, "Vim: Caught deadly signal %s\n",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 signal_info[i].name);
1088#else
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001089 sprintf((char *)IObuff, "Vim: Caught deadly signal\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090#endif
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001091
Bram Moolenaar0f873732019-12-05 20:28:46 +01001092 // Preserve files and exit. This sets the really_exiting flag to prevent
1093 // calling free().
Bram Moolenaarbec9c202013-09-05 21:41:39 +02001094 preserve_exit();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
Bram Moolenaar0f873732019-12-05 20:28:46 +01001096 // NOTREACHED
Bram Moolenaare429e702016-06-10 19:49:14 +02001097
Bram Moolenaar009b2592004-10-24 19:18:58 +00001098#ifdef NBDEBUG
1099 reset_signals();
1100 may_core_dump();
1101 abort();
1102#endif
1103
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 SIGRETURN;
1105}
1106
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107/*
Bram Moolenaar2e310482018-08-21 13:09:10 +02001108 * Invoked after receiving SIGCONT. We don't know what happened while
1109 * sleeping, deal with part of that.
1110 */
1111 static void
1112after_sigcont(void)
1113{
1114# ifdef FEAT_TITLE
1115 // Don't change "oldtitle" in a signal handler, set a flag to obtain it
1116 // again later.
1117 oldtitle_outdated = TRUE;
1118# endif
1119 settmode(TMODE_RAW);
1120 need_check_timestamps = TRUE;
1121 did_check_timestamps = FALSE;
1122}
1123
1124#if defined(SIGCONT)
1125static RETSIGTYPE sigcont_handler SIGPROTOARG;
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001126static volatile sig_atomic_t in_mch_suspend = FALSE;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001127
1128/*
1129 * With multi-threading, suspending might not work immediately. Catch the
1130 * SIGCONT signal, which will be used as an indication whether the suspending
1131 * has been done or not.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001132 *
1133 * On Linux, signal is not always handled immediately either.
1134 * See https://bugs.launchpad.net/bugs/291373
Bram Moolenaar2e310482018-08-21 13:09:10 +02001135 * Probably because the signal is handled in another thread.
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001136 *
Bram Moolenaarb292a2a2011-02-09 18:47:40 +01001137 * volatile because it is used in signal handler sigcont_handler().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 */
Bram Moolenaar8e82c052018-08-21 19:47:48 +02001139static volatile sig_atomic_t sigcont_received;
Bram Moolenaarf1883472018-08-20 21:58:57 +02001140static RETSIGTYPE sigcont_handler SIGPROTOARG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141
1142/*
1143 * signal handler for SIGCONT
1144 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 static RETSIGTYPE
1146sigcont_handler SIGDEFARG(sigarg)
1147{
Bram Moolenaar2e310482018-08-21 13:09:10 +02001148 if (in_mch_suspend)
1149 {
1150 sigcont_received = TRUE;
1151 }
1152 else
1153 {
1154 // We didn't suspend ourselves, assume we were stopped by a SIGSTOP
1155 // signal (which can't be intercepted) and get a SIGCONT. Need to get
1156 // back to a sane mode. We should redraw, but we can't really do that
1157 // in a signal handler, do a redraw later.
1158 after_sigcont();
1159 redraw_later(CLEAR);
1160 cursor_on_force();
1161 out_flush();
1162 }
1163
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 SIGRETURN;
1165}
1166#endif
1167
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02001168#if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001169# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001170static void *clip_star_save = NULL;
1171static void *clip_plus_save = NULL;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001172# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001173
1174/*
1175 * Called when Vim is going to sleep or execute a shell command.
1176 * We can't respond to requests for the X selections. Lose them, otherwise
1177 * other applications will hang. But first copy the text to cut buffer 0.
1178 */
1179 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001180loose_clipboard(void)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001181{
1182 if (clip_star.owned || clip_plus.owned)
1183 {
1184 x11_export_final_selection();
1185 if (clip_star.owned)
1186 clip_lose_selection(&clip_star);
1187 if (clip_plus.owned)
1188 clip_lose_selection(&clip_plus);
1189 if (x11_display != NULL)
1190 XFlush(x11_display);
1191 }
1192}
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001193
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001194# ifdef USE_SYSTEM
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001195/*
1196 * Save clipboard text to restore later.
1197 */
1198 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001199save_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001200{
1201 if (clip_star.owned)
1202 clip_star_save = get_register('*', TRUE);
1203 if (clip_plus.owned)
1204 clip_plus_save = get_register('+', TRUE);
1205}
1206
1207/*
1208 * Restore clipboard text if no one own the X selection.
1209 */
1210 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001211restore_clipboard(void)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01001212{
1213 if (clip_star_save != NULL)
1214 {
1215 if (!clip_gen_owner_exists(&clip_star))
1216 put_register('*', clip_star_save);
1217 else
1218 free_register(clip_star_save);
1219 clip_star_save = NULL;
1220 }
1221 if (clip_plus_save != NULL)
1222 {
1223 if (!clip_gen_owner_exists(&clip_plus))
1224 put_register('+', clip_plus_save);
1225 else
1226 free_register(clip_plus_save);
1227 clip_plus_save = NULL;
1228 }
1229}
Bram Moolenaar090cfc12013-03-19 12:35:42 +01001230# endif
Bram Moolenaar62b42182010-09-21 22:09:37 +02001231#endif
1232
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233/*
1234 * If the machine has job control, use it to suspend the program,
1235 * otherwise fake it by starting a new shell.
1236 */
1237 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001238mch_suspend(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001240 // BeOS does have SIGTSTP, but it doesn't work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241#if defined(SIGTSTP) && !defined(__BEOS__)
Bram Moolenaar2e310482018-08-21 13:09:10 +02001242 in_mch_suspend = TRUE;
1243
Bram Moolenaar0f873732019-12-05 20:28:46 +01001244 out_flush(); // needed to make cursor visible on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 settmode(TMODE_COOK);
Bram Moolenaar0f873732019-12-05 20:28:46 +01001246 out_flush(); // needed to disable mouse on some systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247
1248# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar62b42182010-09-21 22:09:37 +02001249 loose_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001251# if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 sigcont_received = FALSE;
1253# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001254
Bram Moolenaar0f873732019-12-05 20:28:46 +01001255 kill(0, SIGTSTP); // send ourselves a STOP signal
Bram Moolenaar2e310482018-08-21 13:09:10 +02001256
1257# if defined(SIGCONT)
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001258 /*
1259 * Wait for the SIGCONT signal to be handled. It generally happens
Bram Moolenaar2e310482018-08-21 13:09:10 +02001260 * immediately, but somehow not all the time, probably because it's handled
1261 * in another thread. Do not call pause() because there would be race
1262 * condition which would hang Vim if signal happened in between the test of
1263 * sigcont_received and the call to pause(). If signal is not yet received,
1264 * sleep 0, 1, 2, 3 ms. Don't bother waiting further if signal is not
1265 * received after 1+2+3 ms (not expected to happen).
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001266 */
1267 {
Bram Moolenaar262735e2009-07-14 10:20:22 +00001268 long wait_time;
Bram Moolenaar2e310482018-08-21 13:09:10 +02001269
Bram Moolenaar262735e2009-07-14 10:20:22 +00001270 for (wait_time = 0; !sigcont_received && wait_time <= 3L; wait_time++)
Bram Moolenaar262735e2009-07-14 10:20:22 +00001271 mch_delay(wait_time, FALSE);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00001272 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273# endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001274 in_mch_suspend = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275
Bram Moolenaar2e310482018-08-21 13:09:10 +02001276 after_sigcont();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277#else
1278 suspend_shell();
1279#endif
1280}
1281
1282 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001283mch_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284{
1285 Columns = 80;
1286 Rows = 24;
1287
1288 out_flush();
1289 set_signals();
Bram Moolenaardf177f62005-02-22 08:39:57 +00001290
Bram Moolenaar56718732006-03-15 22:53:57 +00001291#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001292 mac_conv_init();
1293#endif
Bram Moolenaar693e40c2013-02-26 14:56:42 +01001294#ifdef FEAT_CYGWIN_WIN32_CLIPBOARD
1295 win_clip_init();
1296#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297}
1298
1299 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001300set_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301{
1302#if defined(SIGWINCH)
1303 /*
1304 * WINDOW CHANGE signal is handled with sig_winch().
1305 */
1306 signal(SIGWINCH, (RETSIGTYPE (*)())sig_winch);
1307#endif
1308
1309 /*
1310 * We want the STOP signal to work, to make mch_suspend() work.
1311 * For "rvim" the STOP signal is ignored.
1312 */
1313#ifdef SIGTSTP
1314 signal(SIGTSTP, restricted ? SIG_IGN : SIG_DFL);
1315#endif
Bram Moolenaar2e310482018-08-21 13:09:10 +02001316#if defined(SIGCONT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 signal(SIGCONT, sigcont_handler);
1318#endif
1319
1320 /*
1321 * We want to ignore breaking of PIPEs.
1322 */
1323#ifdef SIGPIPE
1324 signal(SIGPIPE, SIG_IGN);
1325#endif
1326
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327#ifdef SIGINT
Bram Moolenaardf177f62005-02-22 08:39:57 +00001328 catch_int_signal();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329#endif
1330
1331 /*
1332 * Ignore alarm signals (Perl's alarm() generates it).
1333 */
1334#ifdef SIGALRM
1335 signal(SIGALRM, SIG_IGN);
1336#endif
1337
1338 /*
1339 * Catch SIGPWR (power failure?) to preserve the swap files, so that no
1340 * work will be lost.
1341 */
1342#ifdef SIGPWR
1343 signal(SIGPWR, (RETSIGTYPE (*)())catch_sigpwr);
1344#endif
1345
1346 /*
1347 * Arrange for other signals to gracefully shutdown Vim.
1348 */
1349 catch_signals(deathtrap, SIG_ERR);
1350
1351#if defined(FEAT_GUI) && defined(SIGHUP)
1352 /*
1353 * When the GUI is running, ignore the hangup signal.
1354 */
1355 if (gui.in_use)
1356 signal(SIGHUP, SIG_IGN);
1357#endif
1358}
1359
Bram Moolenaardf177f62005-02-22 08:39:57 +00001360#if defined(SIGINT) || defined(PROTO)
1361/*
1362 * Catch CTRL-C (only works while in Cooked mode).
1363 */
1364 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001365catch_int_signal(void)
Bram Moolenaardf177f62005-02-22 08:39:57 +00001366{
1367 signal(SIGINT, (RETSIGTYPE (*)())catch_sigint);
1368}
1369#endif
1370
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001372reset_signals(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373{
1374 catch_signals(SIG_DFL, SIG_DFL);
Bram Moolenaar2e310482018-08-21 13:09:10 +02001375#if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001376 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 signal(SIGCONT, SIG_DFL);
1378#endif
1379}
1380
1381 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001382catch_signals(
1383 RETSIGTYPE (*func_deadly)(),
1384 RETSIGTYPE (*func_other)())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385{
1386 int i;
1387
1388 for (i = 0; signal_info[i].sig != -1; i++)
1389 if (signal_info[i].deadly)
1390 {
1391#if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION)
1392 struct sigaction sa;
1393
Bram Moolenaar0f873732019-12-05 20:28:46 +01001394 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 sa.sa_handler = func_deadly;
1396 sigemptyset(&sa.sa_mask);
1397# if defined(__linux__) && defined(_REENTRANT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001398 // On Linux, with glibc compiled for kernel 2.2, there is a bug in
1399 // thread handling in combination with using the alternate stack:
1400 // pthread library functions try to use the stack pointer to
1401 // identify the current thread, causing a SEGV signal, which
1402 // recursively calls deathtrap() and hangs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 sa.sa_flags = 0;
1404# else
1405 sa.sa_flags = SA_ONSTACK;
1406# endif
1407 sigaction(signal_info[i].sig, &sa, NULL);
1408#else
1409# if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGVEC)
1410 struct sigvec sv;
1411
Bram Moolenaar0f873732019-12-05 20:28:46 +01001412 // Setup to use the alternate stack for the signal function.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 sv.sv_handler = func_deadly;
1414 sv.sv_mask = 0;
1415 sv.sv_flags = SV_ONSTACK;
1416 sigvec(signal_info[i].sig, &sv, NULL);
1417# else
1418 signal(signal_info[i].sig, func_deadly);
1419# endif
1420#endif
1421 }
1422 else if (func_other != SIG_ERR)
1423 signal(signal_info[i].sig, func_other);
1424}
1425
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001426#ifdef HAVE_SIGPROCMASK
1427 static void
1428block_signals(sigset_t *set)
1429{
1430 sigset_t newset;
1431 int i;
1432
1433 sigemptyset(&newset);
1434
1435 for (i = 0; signal_info[i].sig != -1; i++)
1436 sigaddset(&newset, signal_info[i].sig);
1437
Bram Moolenaar2e310482018-08-21 13:09:10 +02001438# if defined(SIGCONT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001439 // SIGCONT isn't in the list, because its default action is ignore
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02001440 sigaddset(&newset, SIGCONT);
1441# endif
1442
1443 sigprocmask(SIG_BLOCK, &newset, set);
1444}
1445
1446 static void
1447unblock_signals(sigset_t *set)
1448{
1449 sigprocmask(SIG_SETMASK, set, NULL);
1450}
1451#endif
1452
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453/*
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001454 * Handling of SIGHUP, SIGQUIT and SIGTERM:
Bram Moolenaar9e1d2832007-05-06 12:51:41 +00001455 * "when" == a signal: when busy, postpone and return FALSE, otherwise
1456 * return TRUE
1457 * "when" == SIGNAL_BLOCK: Going to be busy, block signals
1458 * "when" == SIGNAL_UNBLOCK: Going to wait, unblock signals, use postponed
Bram Moolenaar67c53842010-05-22 18:28:27 +02001459 * signal
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001460 * Returns TRUE when Vim should exit.
1461 */
1462 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001463vim_handle_signal(int sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001464{
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001465 static int got_signal = 0;
1466 static int blocked = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001467
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001468 switch (sig)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001469 {
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001470 case SIGNAL_BLOCK: blocked = TRUE;
1471 break;
1472
1473 case SIGNAL_UNBLOCK: blocked = FALSE;
1474 if (got_signal != 0)
1475 {
1476 kill(getpid(), got_signal);
1477 got_signal = 0;
1478 }
1479 break;
1480
1481 default: if (!blocked)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001482 return TRUE; // exit!
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001483 got_signal = sig;
1484#ifdef SIGPWR
1485 if (sig != SIGPWR)
1486#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01001487 got_int = TRUE; // break any loops
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001488 break;
1489 }
1490 return FALSE;
1491}
1492
1493/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 * Check_win checks whether we have an interactive stdout.
1495 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001497mch_check_win(int argc UNUSED, char **argv UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 if (isatty(1))
1500 return OK;
1501 return FAIL;
1502}
1503
1504/*
1505 * Return TRUE if the input comes from a terminal, FALSE otherwise.
1506 */
1507 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001508mch_input_isatty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509{
1510 if (isatty(read_cmd_fd))
1511 return TRUE;
1512 return FALSE;
1513}
1514
1515#ifdef FEAT_X11
1516
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001517# if defined(ELAPSED_TIMEVAL) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 && (defined(FEAT_XCLIPBOARD) || defined(FEAT_TITLE))
1519
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520/*
1521 * Give a message about the elapsed time for opening the X window.
1522 */
1523 static void
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001524xopen_message(long elapsed_msec)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001526 smsg(_("Opening the X display took %ld msec"), elapsed_msec);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527}
1528# endif
1529#endif
1530
1531#if defined(FEAT_X11) && (defined(FEAT_TITLE) || defined(FEAT_XCLIPBOARD))
1532/*
1533 * A few functions shared by X11 title and clipboard code.
1534 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535
1536static int got_x_error = FALSE;
1537
1538/*
1539 * X Error handler, otherwise X just exits! (very rude) -- webb
1540 */
1541 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001542x_error_handler(Display *dpy, XErrorEvent *error_event)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543{
Bram Moolenaar843ee412004-06-30 16:16:41 +00001544 XGetErrorText(dpy, error_event->error_code, (char *)IObuff, IOSIZE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 STRCAT(IObuff, _("\nVim: Got X error\n"));
1546
Bram Moolenaar0f873732019-12-05 20:28:46 +01001547 // We cannot print a message and continue, because no X calls are allowed
1548 // here (causes my system to hang). Silently continuing might be an
1549 // alternative...
1550 preserve_exit(); // preserve files and exit
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551
Bram Moolenaar0f873732019-12-05 20:28:46 +01001552 return 0; // NOTREACHED
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553}
1554
1555/*
1556 * Another X Error handler, just used to check for errors.
1557 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001559x_error_check(Display *dpy UNUSED, XErrorEvent *error_event UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560{
1561 got_x_error = TRUE;
1562 return 0;
1563}
1564
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001565/*
1566 * Return TRUE when connection to the X server is desired.
1567 */
1568 static int
1569x_connect_to_server(void)
1570{
1571 // No point in connecting if we are exiting or dying.
1572 if (exiting || v_dying)
1573 return FALSE;
1574
1575#if defined(FEAT_CLIENTSERVER)
1576 if (x_force_connect)
1577 return TRUE;
1578#endif
1579 if (x_no_connect)
1580 return FALSE;
1581
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001582 // Check for a match with "exclude:" from 'clipboard'.
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001583 if (clip_exclude_prog != NULL)
1584 {
Bram Moolenaara8bfa172018-12-29 22:28:46 +01001585 // Just in case we get called recursively, return FALSE. This could
1586 // happen if vpeekc() is used while executing the prog and it causes a
1587 // related callback to be invoked.
1588 if (regprog_in_use(clip_exclude_prog))
1589 return FALSE;
1590
Bram Moolenaarc0c75492018-12-29 11:03:23 +01001591 if (vim_regexec_prog(&clip_exclude_prog, FALSE, T_NAME, (colnr_T)0))
1592 return FALSE;
1593 }
1594 return TRUE;
1595}
1596
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaarb2148f52019-01-20 23:43:57 +01001598# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599/*
1600 * An X IO Error handler, used to catch error while opening the display.
1601 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001603x_IOerror_check(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604{
Bram Moolenaar0f873732019-12-05 20:28:46 +01001605 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 LONGJMP(lc_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001607# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001608 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001609# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610}
1611# endif
1612
1613/*
1614 * An X IO Error handler, used to catch terminal errors.
1615 */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001616static int xterm_dpy_retry_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001619x_IOerror_handler(Display *dpy UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620{
1621 xterm_dpy = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001622 xterm_dpy_retry_count = 5; // Try reconnecting five times
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 x11_window = 0;
1624 x11_display = NULL;
1625 xterm_Shell = (Widget)0;
1626
Bram Moolenaar0f873732019-12-05 20:28:46 +01001627 // This function should not return, it causes exit(). Longjump instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 LONGJMP(x_jump_env, 1);
Bram Moolenaar1eed5322019-02-26 17:03:54 +01001629# if defined(VMS) || defined(__CYGWIN__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01001630 return 0; // avoid the compiler complains about missing return value
Bram Moolenaarb4990bf2010-02-11 18:19:38 +01001631# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632}
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001633
1634/*
1635 * If the X11 connection was lost try to restore it.
1636 * Helps when the X11 server was stopped and restarted while Vim was inactive
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01001637 * (e.g. through tmux).
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001638 */
1639 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001640may_restore_clipboard(void)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001641{
Bram Moolenaar01e51e52018-12-29 13:09:46 +01001642 // No point in restoring the connecting if we are exiting or dying.
1643 if (!exiting && !v_dying && xterm_dpy_retry_count > 0)
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001644 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001645 --xterm_dpy_retry_count;
Bram Moolenaar527a6782014-12-17 17:59:31 +01001646
1647# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01001648 // This has been reported to avoid Vim getting stuck.
Bram Moolenaar527a6782014-12-17 17:59:31 +01001649 if (app_context != (XtAppContext)NULL)
1650 {
1651 XtDestroyApplicationContext(app_context);
1652 app_context = (XtAppContext)NULL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001653 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaar527a6782014-12-17 17:59:31 +01001654 }
1655# endif
1656
Bram Moolenaarb1e26502014-11-19 18:48:46 +01001657 setup_term_clip();
1658 get_x11_title(FALSE);
1659 }
1660}
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001661
1662 void
1663ex_xrestore(exarg_T *eap)
1664{
1665 if (eap->arg != NULL && STRLEN(eap->arg) > 0)
1666 {
1667 if (xterm_display_allocated)
1668 vim_free(xterm_display);
1669 xterm_display = (char *)vim_strsave(eap->arg);
1670 xterm_display_allocated = TRUE;
1671 }
1672 smsg(_("restoring display %s"), xterm_display == NULL
Bram Moolenaar0c5c3fa2019-11-30 22:38:16 +01001673 ? (char *)mch_getenv((char_u *)"DISPLAY") : xterm_display);
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001674
1675 clear_xterm_clip();
1676 x11_window = 0;
1677 xterm_dpy_retry_count = 5; // Try reconnecting five times
1678 may_restore_clipboard();
1679}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680#endif
1681
1682/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 * Test if "dpy" and x11_window are valid by getting the window title.
1684 * I don't actually want it yet, so there may be a simpler call to use, but
1685 * this will cause the error handler x_error_check() to be called if anything
1686 * is wrong, such as the window pointer being invalid (as can happen when the
1687 * user changes his DISPLAY, but not his WINDOWID) -- webb
1688 */
1689 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001690test_x11_window(Display *dpy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691{
1692 int (*old_handler)();
1693 XTextProperty text_prop;
1694
1695 old_handler = XSetErrorHandler(x_error_check);
1696 got_x_error = FALSE;
1697 if (XGetWMName(dpy, x11_window, &text_prop))
1698 XFree((void *)text_prop.value);
1699 XSync(dpy, False);
1700 (void)XSetErrorHandler(old_handler);
1701
1702 if (p_verbose > 0 && got_x_error)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001703 verb_msg(_("Testing the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704
1705 return (got_x_error ? FAIL : OK);
1706}
1707#endif
1708
1709#ifdef FEAT_TITLE
1710
1711#ifdef FEAT_X11
1712
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +01001713static int get_x11_thing(int get_title, int test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714
1715/*
1716 * try to get x11 window and display
1717 *
1718 * return FAIL for failure, OK otherwise
1719 */
1720 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001721get_x11_windis(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722{
1723 char *winid;
1724 static int result = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01001725#define XD_NONE 0 // x11_display not set here
1726#define XD_HERE 1 // x11_display opened here
1727#define XD_GUI 2 // x11_display used from gui.dpy
1728#define XD_XTERM 3 // x11_display used from xterm_dpy
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 static int x11_display_from = XD_NONE;
1730 static int did_set_error_handler = FALSE;
1731
1732 if (!did_set_error_handler)
1733 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001734 // X just exits if it finds an error otherwise!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 (void)XSetErrorHandler(x_error_handler);
1736 did_set_error_handler = TRUE;
1737 }
1738
Bram Moolenaar9372a112005-12-06 19:59:18 +00001739#if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 if (gui.in_use)
1741 {
1742 /*
1743 * If the X11 display was opened here before, for the window where Vim
1744 * was started, close that one now to avoid a memory leak.
1745 */
1746 if (x11_display_from == XD_HERE && x11_display != NULL)
1747 {
1748 XCloseDisplay(x11_display);
1749 x11_display_from = XD_NONE;
1750 }
1751 if (gui_get_x11_windis(&x11_window, &x11_display) == OK)
1752 {
1753 x11_display_from = XD_GUI;
1754 return OK;
1755 }
1756 x11_display = NULL;
1757 return FAIL;
1758 }
1759 else if (x11_display_from == XD_GUI)
1760 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001761 // GUI must have stopped somehow, clear x11_display
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 x11_window = 0;
1763 x11_display = NULL;
1764 x11_display_from = XD_NONE;
1765 }
1766#endif
1767
Bram Moolenaar0f873732019-12-05 20:28:46 +01001768 // When started with the "-X" argument, don't try connecting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 if (!x_connect_to_server())
1770 return FAIL;
1771
1772 /*
1773 * If WINDOWID not set, should try another method to find out
1774 * what the current window number is. The only code I know for
1775 * this is very complicated.
1776 * We assume that zero is invalid for WINDOWID.
1777 */
1778 if (x11_window == 0 && (winid = getenv("WINDOWID")) != NULL)
1779 x11_window = (Window)atol(winid);
1780
1781#ifdef FEAT_XCLIPBOARD
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02001782 if (xterm_dpy == x11_display)
1783 // x11_display may have been set to xterm_dpy elsewhere
1784 x11_display_from = XD_XTERM;
1785
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 if (xterm_dpy != NULL && x11_window != 0)
1787 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001788 // We may have checked it already, but Gnome terminal can move us to
1789 // another window, so we need to check every time.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00001790 if (x11_display_from != XD_XTERM)
1791 {
1792 /*
1793 * If the X11 display was opened here before, for the window where
1794 * Vim was started, close that one now to avoid a memory leak.
1795 */
1796 if (x11_display_from == XD_HERE && x11_display != NULL)
1797 XCloseDisplay(x11_display);
1798 x11_display = xterm_dpy;
1799 x11_display_from = XD_XTERM;
1800 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 if (test_x11_window(x11_display) == FAIL)
1802 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001803 // probably bad $WINDOWID
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 x11_window = 0;
1805 x11_display = NULL;
1806 x11_display_from = XD_NONE;
1807 return FAIL;
1808 }
1809 return OK;
1810 }
1811#endif
1812
1813 if (x11_window == 0 || x11_display == NULL)
1814 result = -1;
1815
Bram Moolenaar0f873732019-12-05 20:28:46 +01001816 if (result != -1) // Have already been here and set this
1817 return result; // Don't do all these X calls again
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
1819 if (x11_window != 0 && x11_display == NULL)
1820 {
1821#ifdef SET_SIG_ALARM
1822 RETSIGTYPE (*sig_save)();
1823#endif
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001824#ifdef ELAPSED_FUNC
1825 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826
1827 if (p_verbose > 0)
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001828 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829#endif
1830
1831#ifdef SET_SIG_ALARM
1832 /*
1833 * Opening the Display may hang if the DISPLAY setting is wrong, or
1834 * the network connection is bad. Set an alarm timer to get out.
1835 */
1836 sig_alarm_called = FALSE;
1837 sig_save = (RETSIGTYPE (*)())signal(SIGALRM,
1838 (RETSIGTYPE (*)())sig_alarm);
1839 alarm(2);
1840#endif
1841 x11_display = XOpenDisplay(NULL);
1842
1843#ifdef SET_SIG_ALARM
1844 alarm(0);
1845 signal(SIGALRM, (RETSIGTYPE (*)())sig_save);
1846 if (p_verbose > 0 && sig_alarm_called)
Bram Moolenaar563bbea2019-01-22 21:45:40 +01001847 verb_msg(_("Opening the X display timed out"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848#endif
1849 if (x11_display != NULL)
1850 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001851# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001853 {
1854 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01001855 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00001856 verbose_leave();
1857 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858# endif
1859 if (test_x11_window(x11_display) == FAIL)
1860 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001861 // Maybe window id is bad
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 x11_window = 0;
1863 XCloseDisplay(x11_display);
1864 x11_display = NULL;
1865 }
1866 else
1867 x11_display_from = XD_HERE;
1868 }
1869 }
1870 if (x11_window == 0 || x11_display == NULL)
1871 return (result = FAIL);
Bram Moolenaar727c8762010-10-20 19:17:48 +02001872
1873# ifdef FEAT_EVAL
1874 set_vim_var_nr(VV_WINDOWID, (long)x11_window);
1875# endif
1876
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 return (result = OK);
1878}
1879
1880/*
1881 * Determine original x11 Window Title
1882 */
1883 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001884get_x11_title(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885{
Bram Moolenaar47136d72004-10-12 20:02:24 +00001886 return get_x11_thing(TRUE, test_only);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887}
1888
1889/*
1890 * Determine original x11 Window icon
1891 */
1892 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001893get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894{
1895 int retval = FALSE;
1896
1897 retval = get_x11_thing(FALSE, test_only);
1898
Bram Moolenaar0f873732019-12-05 20:28:46 +01001899 // could not get old icon, use terminal name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 if (oldicon == NULL && !test_only)
1901 {
1902 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00001903 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00001905 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 }
1907
1908 return retval;
1909}
1910
1911 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001912get_x11_thing(
Bram Moolenaar0f873732019-12-05 20:28:46 +01001913 int get_title, // get title string
Bram Moolenaar05540972016-01-30 20:31:25 +01001914 int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915{
1916 XTextProperty text_prop;
1917 int retval = FALSE;
1918 Status status;
1919
1920 if (get_x11_windis() == OK)
1921 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01001922 // Get window/icon name if any
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 if (get_title)
1924 status = XGetWMName(x11_display, x11_window, &text_prop);
1925 else
1926 status = XGetWMIconName(x11_display, x11_window, &text_prop);
1927
1928 /*
1929 * If terminal is xterm, then x11_window may be a child window of the
1930 * outer xterm window that actually contains the window/icon name, so
1931 * keep traversing up the tree until a window with a title/icon is
1932 * found.
1933 */
Bram Moolenaar4b96df52020-01-26 22:00:26 +01001934 // Previously this was only done for xterm and alike. I don't see a
Bram Moolenaar0f873732019-12-05 20:28:46 +01001935 // reason why it would fail for other terminal emulators.
1936 // if (term_is_xterm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 {
1938 Window root;
1939 Window parent;
1940 Window win = x11_window;
1941 Window *children;
1942 unsigned int num_children;
1943
1944 while (!status || text_prop.value == NULL)
1945 {
1946 if (!XQueryTree(x11_display, win, &root, &parent, &children,
1947 &num_children))
1948 break;
1949 if (children)
1950 XFree((void *)children);
1951 if (parent == root || parent == 0)
1952 break;
1953
1954 win = parent;
1955 if (get_title)
1956 status = XGetWMName(x11_display, win, &text_prop);
1957 else
1958 status = XGetWMIconName(x11_display, win, &text_prop);
1959 }
1960 }
1961 if (status && text_prop.value != NULL)
1962 {
1963 retval = TRUE;
1964 if (!test_only)
1965 {
Bram Moolenaar6b649ac2019-12-07 17:47:22 +01001966 if (get_title)
1967 vim_free(oldtitle);
1968 else
1969 vim_free(oldicon);
Bram Moolenaara12a1612019-01-24 16:39:02 +01001970 if (text_prop.encoding == XA_STRING && !has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 if (get_title)
1973 oldtitle = vim_strsave((char_u *)text_prop.value);
1974 else
1975 oldicon = vim_strsave((char_u *)text_prop.value);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 }
1977 else
1978 {
1979 char **cl;
1980 Status transform_status;
1981 int n = 0;
1982
1983 transform_status = XmbTextPropertyToTextList(x11_display,
1984 &text_prop,
1985 &cl, &n);
1986 if (transform_status >= Success && n > 0 && cl[0])
1987 {
1988 if (get_title)
1989 oldtitle = vim_strsave((char_u *) cl[0]);
1990 else
1991 oldicon = vim_strsave((char_u *) cl[0]);
1992 XFreeStringList(cl);
1993 }
1994 else
1995 {
1996 if (get_title)
1997 oldtitle = vim_strsave((char_u *)text_prop.value);
1998 else
1999 oldicon = vim_strsave((char_u *)text_prop.value);
2000 }
2001 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 }
2003 XFree((void *)text_prop.value);
2004 }
2005 }
2006 return retval;
2007}
2008
Bram Moolenaar0f873732019-12-05 20:28:46 +01002009// Xutf8 functions are not available on older systems. Note that on some
2010// systems X_HAVE_UTF8_STRING may be defined in a header file but
2011// Xutf8SetWMProperties() is not in the X11 library. Configure checks for
2012// that and defines HAVE_XUTF8SETWMPROPERTIES.
Bram Moolenaara12a1612019-01-24 16:39:02 +01002013#if defined(X_HAVE_UTF8_STRING)
Bram Moolenaarcbc246a2014-10-11 14:47:26 +02002014# if X_HAVE_UTF8_STRING && HAVE_XUTF8SETWMPROPERTIES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015# define USE_UTF8_STRING
2016# endif
2017#endif
2018
2019/*
2020 * Set x11 Window Title
2021 *
2022 * get_x11_windis() must be called before this and have returned OK
2023 */
2024 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002025set_x11_title(char_u *title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002027 // XmbSetWMProperties() and Xutf8SetWMProperties() should use a STRING
2028 // when possible, COMPOUND_TEXT otherwise. COMPOUND_TEXT isn't
2029 // supported everywhere and STRING doesn't work for multi-byte titles.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030#ifdef USE_UTF8_STRING
2031 if (enc_utf8)
2032 Xutf8SetWMProperties(x11_display, x11_window, (const char *)title,
2033 NULL, NULL, 0, NULL, NULL, NULL);
2034 else
2035#endif
2036 {
2037#if XtSpecificationRelease >= 4
2038# ifdef FEAT_XFONTSET
2039 XmbSetWMProperties(x11_display, x11_window, (const char *)title,
2040 NULL, NULL, 0, NULL, NULL, NULL);
2041# else
2042 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002043 char *c_title = (char *)title;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
Bram Moolenaar0f873732019-12-05 20:28:46 +01002045 // directly from example 3-18 "basicwin" of Xlib Programming Manual
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002046 (void)XStringListToTextProperty(&c_title, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 XSetWMProperties(x11_display, x11_window, &text_prop,
2048 NULL, NULL, 0, NULL, NULL, NULL);
2049# endif
2050#else
2051 XStoreName(x11_display, x11_window, (char *)title);
2052#endif
2053 }
2054 XFlush(x11_display);
2055}
2056
2057/*
2058 * Set x11 Window icon
2059 *
2060 * get_x11_windis() must be called before this and have returned OK
2061 */
2062 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002063set_x11_icon(char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064{
Bram Moolenaar0f873732019-12-05 20:28:46 +01002065 // See above for comments about using X*SetWMProperties().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066#ifdef USE_UTF8_STRING
2067 if (enc_utf8)
2068 Xutf8SetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2069 NULL, 0, NULL, NULL, NULL);
2070 else
2071#endif
2072 {
2073#if XtSpecificationRelease >= 4
2074# ifdef FEAT_XFONTSET
2075 XmbSetWMProperties(x11_display, x11_window, NULL, (const char *)icon,
2076 NULL, 0, NULL, NULL, NULL);
2077# else
2078 XTextProperty text_prop;
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002079 char *c_icon = (char *)icon;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080
Bram Moolenaar9d75c832005-01-25 21:57:23 +00002081 (void)XStringListToTextProperty(&c_icon, 1, &text_prop);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 XSetWMProperties(x11_display, x11_window, NULL, &text_prop,
2083 NULL, 0, NULL, NULL, NULL);
2084# endif
2085#else
2086 XSetIconName(x11_display, x11_window, (char *)icon);
2087#endif
2088 }
2089 XFlush(x11_display);
2090}
2091
Bram Moolenaar0f873732019-12-05 20:28:46 +01002092#else // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002095get_x11_title(int test_only UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096{
2097 return FALSE;
2098}
2099
2100 static int
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002101get_x11_icon(int test_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102{
2103 if (!test_only)
2104 {
2105 if (STRNCMP(T_NAME, "builtin_", 8) == 0)
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002106 oldicon = vim_strsave(T_NAME + 8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 else
Bram Moolenaar20de1c22009-07-22 11:28:11 +00002108 oldicon = vim_strsave(T_NAME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 }
2110 return FALSE;
2111}
2112
Bram Moolenaar0f873732019-12-05 20:28:46 +01002113#endif // FEAT_X11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114
2115 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002116mch_can_restore_title(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117{
2118 return get_x11_title(TRUE);
2119}
2120
2121 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002122mch_can_restore_icon(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123{
2124 return get_x11_icon(TRUE);
2125}
2126
2127/*
2128 * Set the window title and icon.
2129 */
2130 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002131mch_settitle(char_u *title, char_u *icon)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132{
2133 int type = 0;
2134 static int recursive = 0;
2135
Bram Moolenaar0f873732019-12-05 20:28:46 +01002136 if (T_NAME == NULL) // no terminal name (yet)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 return;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002138 if (title == NULL && icon == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 return;
2140
Bram Moolenaar0f873732019-12-05 20:28:46 +01002141 // When one of the X11 functions causes a deadly signal, we get here again
2142 // recursively. Avoid hanging then (something is probably locked).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 if (recursive)
2144 return;
2145 ++recursive;
2146
2147 /*
2148 * if the window ID and the display is known, we may use X11 calls
2149 */
2150#ifdef FEAT_X11
2151 if (get_x11_windis() == OK)
2152 type = 1;
2153#else
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002154# if defined(FEAT_GUI_PHOTON) || defined(FEAT_GUI_MAC) \
2155 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 if (gui.in_use)
2157 type = 1;
2158# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159#endif
2160
2161 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002162 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 * than x11 calls, because the x11 calls don't always work
2164 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 if ((type || *T_TS != NUL) && title != NULL)
2166 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002167 if (oldtitle_outdated)
2168 {
2169 oldtitle_outdated = FALSE;
2170 VIM_CLEAR(oldtitle);
2171 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 if (oldtitle == NULL
2173#ifdef FEAT_GUI
2174 && !gui.in_use
2175#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002176 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 (void)get_x11_title(FALSE);
2178
Bram Moolenaar0f873732019-12-05 20:28:46 +01002179 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 term_settitle(title);
2181#ifdef FEAT_X11
2182 else
2183# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002184 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002186 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187#endif
Bram Moolenaarb3f74062020-02-26 16:16:53 +01002188#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_HAIKU) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 || defined(FEAT_GUI_PHOTON) || defined(FEAT_GUI_MAC)
2190 else
2191 gui_mch_settitle(title, icon);
2192#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002193 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 }
2195
2196 if ((type || *T_CIS != NUL) && icon != NULL)
2197 {
2198 if (oldicon == NULL
2199#ifdef FEAT_GUI
2200 && !gui.in_use
2201#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002202 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 get_x11_icon(FALSE);
2204
2205 if (*T_CIS != NUL)
2206 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002207 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002209 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 out_flush();
2211 }
2212#ifdef FEAT_X11
2213 else
2214# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002215 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002217 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218#endif
2219 did_set_icon = TRUE;
2220 }
2221 --recursive;
2222}
2223
2224/*
2225 * Restore the window/icon title.
2226 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002227 * SAVE_RESTORE_TITLE only restore title
2228 * SAVE_RESTORE_ICON only restore icon
2229 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 */
2231 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002232mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233{
Bram Moolenaardac13472019-09-16 21:06:21 +02002234 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002235
Bram Moolenaar0f873732019-12-05 20:28:46 +01002236 // only restore the title or icon when it has been set
Bram Moolenaardac13472019-09-16 21:06:21 +02002237 mch_settitle(((which & SAVE_RESTORE_TITLE) && unix_did_set_title) ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 (oldtitle ? oldtitle : p_titleold) : NULL,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002239 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
2240
Bram Moolenaare5c83282019-05-03 23:15:37 +02002241 if (do_push_pop)
2242 {
2243 // pop and push from/to the stack
2244 term_pop_title(which);
2245 term_push_title(which);
2246 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247}
2248
Bram Moolenaar0f873732019-12-05 20:28:46 +01002249#endif // FEAT_TITLE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250
2251/*
2252 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002253 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 */
2255 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002256vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257{
2258 if (name == NULL)
2259 return FALSE;
2260 return (STRNICMP(name, "xterm", 5) == 0
2261 || STRNICMP(name, "nxterm", 6) == 0
2262 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002263 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002265 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 || STRCMP(name, "builtin_xterm") == 0);
2267}
2268
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002269#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2270/*
2271 * Return TRUE if "name" appears to be that of a terminal
2272 * known to support the xterm-style mouse protocol.
2273 * Relies on term_is_xterm having been set to its correct value.
2274 */
2275 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002276use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002277{
2278 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002279 && (term_is_xterm
2280 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002281 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002282 || STRICMP(name, "st") == 0
2283 || STRNICMP(name, "st-", 3) == 0
2284 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002285}
2286#endif
2287
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288/*
2289 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2290 * Return 1 for "xterm".
2291 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002292 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002293 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 */
2295 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002296use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002298 if (ttym_flags == TTYM_SGR)
2299 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002300 if (ttym_flags == TTYM_URXVT)
2301 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 if (ttym_flags == TTYM_XTERM2)
2303 return 2;
2304 if (ttym_flags == TTYM_XTERM)
2305 return 1;
2306 return 0;
2307}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308
2309 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002310vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311{
2312 if (name == NULL)
2313 return FALSE;
2314 return (STRNICMP(name, "iris-ansi", 9) == 0
2315 || STRCMP(name, "builtin_iris-ansi") == 0);
2316}
2317
2318 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002319vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320{
2321 if (name == NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002322 return FALSE; // actually all ANSI comp. terminals should be here
2323 // catch VT100 - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002324 return ((STRNICMP(name, "vt", 2) == 0
2325 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 || STRCMP(name, "builtin_vt320") == 0);
2327}
2328
2329/*
2330 * Return TRUE if "name" is a terminal for which 'ttyfast' should be set.
2331 * This should include all windowed terminal emulators.
2332 */
2333 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002334vim_is_fastterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335{
2336 if (name == NULL)
2337 return FALSE;
2338 if (vim_is_xterm(name) || vim_is_vt300(name) || vim_is_iris(name))
2339 return TRUE;
2340 return ( STRNICMP(name, "hpterm", 6) == 0
2341 || STRNICMP(name, "sun-cmd", 7) == 0
2342 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002343 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 || STRNICMP(name, "dtterm", 6) == 0);
2345}
2346
2347/*
2348 * Insert user name in s[len].
2349 * Return OK if a name found.
2350 */
2351 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002352mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353{
2354#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002355 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 return OK;
2357#else
2358 return mch_get_uname(getuid(), s, len);
2359#endif
2360}
2361
2362/*
2363 * Insert user name for "uid" in s[len].
2364 * Return OK if a name found.
2365 */
2366 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002367mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368{
2369#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2370 struct passwd *pw;
2371
2372 if ((pw = getpwuid(uid)) != NULL
2373 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2374 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002375 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 return OK;
2377 }
2378#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002379 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2380 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381}
2382
2383/*
2384 * Insert host name is s[len].
2385 */
2386
2387#ifdef HAVE_SYS_UTSNAME_H
2388 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002389mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390{
2391 struct utsname vutsname;
2392
2393 if (uname(&vutsname) < 0)
2394 *s = NUL;
2395 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002396 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002398#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399
2400# ifdef HAVE_SYS_SYSTEMINFO_H
2401# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2402# endif
2403
2404 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002405mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406{
2407# ifdef VAXC
2408 vaxc$gethostname((char *)s, len);
2409# else
2410 gethostname((char *)s, len);
2411# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002412 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002414#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415
2416/*
2417 * return process ID
2418 */
2419 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002420mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421{
2422 return (long)getpid();
2423}
2424
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002425/*
2426 * return TRUE if process "pid" is still running
2427 */
2428 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002429mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002430{
2431 // EMX kill() not working correctly, it seems
2432 return kill(pid, 0) == 0;
2433}
2434
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002437strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438{
2439 extern int sys_nerr;
2440 extern char *sys_errlist[];
2441 static char er[20];
2442
2443 if (err > 0 && err < sys_nerr)
2444 return (sys_errlist[err]);
2445 sprintf(er, "Error %d", err);
2446 return er;
2447}
2448#endif
2449
2450/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002451 * Get name of current directory into buffer "buf" of length "len" bytes.
2452 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 * Return OK for success, FAIL for failure.
2454 */
2455 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002456mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457{
2458#if defined(USE_GETCWD)
2459 if (getcwd((char *)buf, len) == NULL)
2460 {
2461 STRCPY(buf, strerror(errno));
2462 return FAIL;
2463 }
2464 return OK;
2465#else
2466 return (getwd((char *)buf) != NULL ? OK : FAIL);
2467#endif
2468}
2469
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002471 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 *
2473 * return FAIL for failure, OK for success
2474 */
2475 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002476mch_FullName(
2477 char_u *fname,
2478 char_u *buf,
2479 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002480 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481{
2482 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002483#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002485 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002486#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 char_u olddir[MAXPATHL];
2488 char_u *p;
2489 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002490#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002491 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2492 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002493#endif
2494
Bram Moolenaar38323e42007-03-06 19:22:53 +00002495#ifdef VMS
2496 fname = vms_fixfilename(fname);
2497#endif
2498
Bram Moolenaara2442432007-04-26 14:26:37 +00002499#ifdef __CYGWIN__
2500 /*
2501 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2502 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002503# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002504 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2505 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002506 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2507 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002508# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002509 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002510# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002511 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002512#endif
2513
Bram Moolenaar0f873732019-12-05 20:28:46 +01002514 // Expand it if forced or not an absolute path.
2515 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002516 if ((force || !mch_isFullName(fname))
2517 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 {
2519 /*
2520 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002521 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 * This will get the correct path name with "../" things.
2523 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002524 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002526#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 /*
2528 * Use fchdir() if possible, it's said to be faster and more
2529 * reliable. But on SunOS 4 it might not work. Check this by
2530 * doing a fchdir() right now.
2531 */
2532 if (!dont_fchdir)
2533 {
2534 fd = open(".", O_RDONLY | O_EXTRA, 0);
2535 if (fd >= 0 && fchdir(fd) < 0)
2536 {
2537 close(fd);
2538 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002539 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 }
2541 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002542#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543
Bram Moolenaar0f873732019-12-05 20:28:46 +01002544 // Only change directory when we are sure we can return to where
2545 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002547#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002549#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 (mch_dirname(olddir, MAXPATHL) == FAIL
2551 || mch_chdir((char *)olddir) != 0))
2552 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002553 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 retval = FAIL;
2555 }
2556 else
2557 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002558 // The directory is copied into buf[], to be able to remove
2559 // the file name without changing it (could be a string in
2560 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 if (p - fname >= len)
2562 retval = FAIL;
2563 else
2564 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002565 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 if (mch_chdir((char *)buf))
2567 retval = FAIL;
2568 else
2569 fname = p + 1;
2570 *buf = NUL;
2571 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 }
2573 }
2574 if (mch_dirname(buf, len) == FAIL)
2575 {
2576 retval = FAIL;
2577 *buf = NUL;
2578 }
2579 if (p != NULL)
2580 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002581#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 if (fd >= 0)
2583 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002584 if (p_verbose >= 5)
2585 {
2586 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002587 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002588 verbose_leave();
2589 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 l = fchdir(fd);
2591 close(fd);
2592 }
2593 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002594#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 l = mch_chdir((char *)olddir);
2596 if (l != 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002597 emsg(_(e_prev_dir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 }
2599
2600 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002601 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002602 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002603#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002604 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002606 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002607#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002609
Bram Moolenaar0f873732019-12-05 20:28:46 +01002610 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002611 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 return FAIL;
2613
Bram Moolenaar0f873732019-12-05 20:28:46 +01002614 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 if (STRCMP(fname, ".") != 0)
2616 STRCAT(buf, fname);
2617
2618 return OK;
2619}
2620
2621/*
2622 * Return TRUE if "fname" does not depend on the current directory.
2623 */
2624 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002625mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002627#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 return ( fname[0] == '/' || fname[0] == '.' ||
2629 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2630 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2631 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002632#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634#endif
2635}
2636
Bram Moolenaar24552be2005-12-10 20:17:30 +00002637#if defined(USE_FNAME_CASE) || defined(PROTO)
2638/*
2639 * Set the case of the file name, if it already exists. This will cause the
2640 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002641 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002642 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002643 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002644fname_case(
2645 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002646 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002647{
2648 struct stat st;
2649 char_u *slash, *tail;
2650 DIR *dirp;
2651 struct dirent *dp;
2652
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002653 if (mch_lstat((char *)name, &st) >= 0)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002654 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002655 // Open the directory where the file is located.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002656 slash = vim_strrchr(name, '/');
2657 if (slash == NULL)
2658 {
2659 dirp = opendir(".");
2660 tail = name;
2661 }
2662 else
2663 {
2664 *slash = NUL;
2665 dirp = opendir((char *)name);
2666 *slash = '/';
2667 tail = slash + 1;
2668 }
2669
2670 if (dirp != NULL)
2671 {
2672 while ((dp = readdir(dirp)) != NULL)
2673 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002674 // Only accept names that differ in case and are the same byte
2675 // length. TODO: accept different length name.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002676 if (STRICMP(tail, dp->d_name) == 0
2677 && STRLEN(tail) == STRLEN(dp->d_name))
2678 {
2679 char_u newname[MAXPATHL + 1];
2680 struct stat st2;
2681
Bram Moolenaar0f873732019-12-05 20:28:46 +01002682 // Verify the inode is equal.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002683 vim_strncpy(newname, name, MAXPATHL);
2684 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2685 MAXPATHL - (tail - name));
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002686 if (mch_lstat((char *)newname, &st2) >= 0
Bram Moolenaar24552be2005-12-10 20:17:30 +00002687 && st.st_ino == st2.st_ino
2688 && st.st_dev == st2.st_dev)
2689 {
2690 STRCPY(tail, dp->d_name);
2691 break;
2692 }
2693 }
2694 }
2695
2696 closedir(dirp);
2697 }
2698 }
2699}
2700#endif
2701
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702/*
2703 * Get file permissions for 'name'.
2704 * Returns -1 when it doesn't exist.
2705 */
2706 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002707mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708{
2709 struct stat statb;
2710
Bram Moolenaar0f873732019-12-05 20:28:46 +01002711 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712#ifdef VMS
2713 if (stat((char *)vms_fixfilename(name), &statb))
2714#else
2715 if (stat((char *)name, &statb))
2716#endif
2717 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002718#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002719 // The top bit makes the value negative, which means the file doesn't
2720 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002721 return statb.st_mode & ~S_ADDACE;
2722#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002724#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725}
2726
2727/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002728 * Set file permission for "name" to "perm".
2729 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 */
2731 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002732mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733{
2734 return (chmod((char *)
2735#ifdef VMS
2736 vms_fixfilename(name),
2737#else
2738 name,
2739#endif
2740 (mode_t)perm) == 0 ? OK : FAIL);
2741}
2742
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002743#if defined(HAVE_FCHMOD) || defined(PROTO)
2744/*
2745 * Set file permission for open file "fd" to "perm".
2746 * Return FAIL for failure, OK otherwise.
2747 */
2748 int
2749mch_fsetperm(int fd, long perm)
2750{
2751 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2752}
2753#endif
2754
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755#if defined(HAVE_ACL) || defined(PROTO)
2756# ifdef HAVE_SYS_ACL_H
2757# include <sys/acl.h>
2758# endif
2759# ifdef HAVE_SYS_ACCESS_H
2760# include <sys/access.h>
2761# endif
2762
2763# ifdef HAVE_SOLARIS_ACL
2764typedef struct vim_acl_solaris_T {
2765 int acl_cnt;
2766 aclent_t *acl_entry;
2767} vim_acl_solaris_T;
2768# endif
2769
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002770#if defined(HAVE_SELINUX) || defined(PROTO)
2771/*
2772 * Copy security info from "from_file" to "to_file".
2773 */
2774 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002775mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002776{
2777 if (from_file == NULL)
2778 return;
2779
2780 if (selinux_enabled == -1)
2781 selinux_enabled = is_selinux_enabled();
2782
2783 if (selinux_enabled > 0)
2784 {
2785 security_context_t from_context = NULL;
2786 security_context_t to_context = NULL;
2787
2788 if (getfilecon((char *)from_file, &from_context) < 0)
2789 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002790 // If the filesystem doesn't support extended attributes,
2791 // the original had no special security context and the
2792 // target cannot have one either.
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002793 if (errno == EOPNOTSUPP)
2794 return;
2795
Bram Moolenaar32526b32019-01-19 17:43:09 +01002796 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002797 msg_outtrans(from_file);
2798 msg_putchar('\n');
2799 return;
2800 }
2801 if (getfilecon((char *)to_file, &to_context) < 0)
2802 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002803 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002804 msg_outtrans(to_file);
2805 msg_putchar('\n');
2806 freecon (from_context);
2807 return ;
2808 }
2809 if (strcmp(from_context, to_context) != 0)
2810 {
2811 if (setfilecon((char *)to_file, from_context) < 0)
2812 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002813 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002814 msg_outtrans(to_file);
2815 msg_putchar('\n');
2816 }
2817 }
2818 freecon(to_context);
2819 freecon(from_context);
2820 }
2821}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002822#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002823
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002824#if defined(HAVE_SMACK) && !defined(PROTO)
2825/*
2826 * Copy security info from "from_file" to "to_file".
2827 */
2828 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002829mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002830{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002831 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002832 {
2833 XATTR_NAME_SMACK,
2834 XATTR_NAME_SMACKEXEC,
2835 XATTR_NAME_SMACKMMAP
2836 };
2837
2838 char buffer[SMACK_LABEL_LEN];
2839 const char *name;
2840 int index;
2841 int ret;
2842 ssize_t size;
2843
2844 if (from_file == NULL)
2845 return;
2846
2847 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2848 / sizeof(smack_copied_attributes)[0]) ; index++)
2849 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002850 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002851 name = smack_copied_attributes[index];
2852
Bram Moolenaar0f873732019-12-05 20:28:46 +01002853 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002854 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2855 if (size >= 0)
2856 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002857 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002858 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2859 if (ret < 0)
2860 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002861 vim_snprintf((char *)IObuff, IOSIZE,
2862 _("Could not set security context %s for %s"),
2863 name, to_file);
2864 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002865 msg_putchar('\n');
2866 }
2867 }
2868 else
2869 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002870 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002871 switch (errno)
2872 {
2873 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002874 // extended attributes aren't supported or enabled
2875 // should a message be echoed? not sure...
2876 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002877
2878 case ERANGE:
2879 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002880 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002881 vim_snprintf((char *)IObuff, IOSIZE,
2882 _("Could not get security context %s for %s. Removing it!"),
2883 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002884 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002885 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01002886 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002887
2888 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002889 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002890 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01002891 // Silently ignore errors, apparently this happens when
2892 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002893 break;
2894 }
2895 }
2896 }
2897}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002898#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002899
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900/*
2901 * Return a pointer to the ACL of file "fname" in allocated memory.
2902 * Return NULL if the ACL is not available for whatever reason.
2903 */
2904 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01002905mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906{
2907 vim_acl_T ret = NULL;
2908#ifdef HAVE_POSIX_ACL
2909 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
2910#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01002911#ifdef HAVE_SOLARIS_ZFS_ACL
2912 acl_t *aclent;
2913
2914 if (acl_get((char *)fname, 0, &aclent) < 0)
2915 return NULL;
2916 ret = (vim_acl_T)aclent;
2917#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918#ifdef HAVE_SOLARIS_ACL
2919 vim_acl_solaris_T *aclent;
2920
2921 aclent = malloc(sizeof(vim_acl_solaris_T));
2922 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
2923 {
2924 free(aclent);
2925 return NULL;
2926 }
2927 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
2928 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
2929 {
2930 free(aclent->acl_entry);
2931 free(aclent);
2932 return NULL;
2933 }
2934 ret = (vim_acl_T)aclent;
2935#else
2936#if defined(HAVE_AIX_ACL)
2937 int aclsize;
2938 struct acl *aclent;
2939
2940 aclsize = sizeof(struct acl);
2941 aclent = malloc(aclsize);
2942 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
2943 {
2944 if (errno == ENOSPC)
2945 {
2946 aclsize = aclent->acl_len;
2947 aclent = realloc(aclent, aclsize);
2948 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
2949 {
2950 free(aclent);
2951 return NULL;
2952 }
2953 }
2954 else
2955 {
2956 free(aclent);
2957 return NULL;
2958 }
2959 }
2960 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002961#endif // HAVE_AIX_ACL
2962#endif // HAVE_SOLARIS_ACL
2963#endif // HAVE_SOLARIS_ZFS_ACL
2964#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 return ret;
2966}
2967
2968/*
2969 * Set the ACL of file "fname" to "acl" (unless it's NULL).
2970 */
2971 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002972mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973{
2974 if (aclent == NULL)
2975 return;
2976#ifdef HAVE_POSIX_ACL
2977 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
2978#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01002979#ifdef HAVE_SOLARIS_ZFS_ACL
2980 acl_set((char *)fname, (acl_t *)aclent);
2981#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982#ifdef HAVE_SOLARIS_ACL
2983 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
2984 ((vim_acl_solaris_T *)aclent)->acl_entry);
2985#else
2986#ifdef HAVE_AIX_ACL
2987 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01002988#endif // HAVE_AIX_ACL
2989#endif // HAVE_SOLARIS_ACL
2990#endif // HAVE_SOLARIS_ZFS_ACL
2991#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992}
2993
2994 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002995mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996{
2997 if (aclent == NULL)
2998 return;
2999#ifdef HAVE_POSIX_ACL
3000 acl_free((acl_t)aclent);
3001#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003002#ifdef HAVE_SOLARIS_ZFS_ACL
3003 acl_free((acl_t *)aclent);
3004#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005#ifdef HAVE_SOLARIS_ACL
3006 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3007 free(aclent);
3008#else
3009#ifdef HAVE_AIX_ACL
3010 free(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}
3016#endif
3017
3018/*
3019 * Set hidden flag for "name".
3020 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003022mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003024 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025}
3026
3027/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003028 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 * return FALSE if "name" is not a directory
3030 * return FALSE for error
3031 */
3032 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003033mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034{
3035 struct stat statb;
3036
Bram Moolenaar0f873732019-12-05 20:28:46 +01003037 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 return FALSE;
3039 if (stat((char *)name, &statb))
3040 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042}
3043
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003044/*
3045 * return TRUE if "name" is a directory, NOT a symlink to a directory
3046 * return FALSE if "name" is not a directory
3047 * return FALSE for error
3048 */
3049 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003050mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003051{
3052 struct stat statb;
3053
Bram Moolenaar0f873732019-12-05 20:28:46 +01003054 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003055 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003056 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003057 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003058 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003059}
3060
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061/*
3062 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3063 */
3064 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003065executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066{
3067 struct stat st;
3068
3069 if (stat((char *)name, &st))
3070 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003071#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003072 // Like on Unix system file can have executable rights but not necessarily
3073 // be an executable, but on Unix is not a default for an ordinary file to
3074 // have an executable flag - on VMS it is in most cases.
3075 // Therefore, this check does not have any sense - let keep us to the
3076 // conventions instead:
3077 // *.COM and *.EXE files are the executables - the rest are not. This is
3078 // not ideal but better then it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003079 int vms_executable = 0;
3080 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3081 {
3082 if (strstr(vms_tolower((char*)name),".exe") != NULL
3083 || strstr(vms_tolower((char*)name),".com")!= NULL)
3084 vms_executable = 1;
3085 }
3086 return vms_executable;
3087#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003089#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090}
3091
3092/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003093 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003094 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 * Return -1 if unknown.
3096 */
3097 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003098mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099{
3100 char_u *buf;
3101 char_u *p, *e;
3102 int retval;
3103
Bram Moolenaar0f873732019-12-05 20:28:46 +01003104 // When "use_path" is false and if it's an absolute or relative path don't
3105 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003106 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003107 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003108 // There must be a path separator, files in the current directory
3109 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003110 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003111 {
3112 if (path != NULL)
3113 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003114 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003115 *path = FullName_save(name, TRUE);
3116 else
3117 *path = vim_strsave(name);
3118 }
3119 return TRUE;
3120 }
3121 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003122 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123
3124 p = (char_u *)getenv("PATH");
3125 if (p == NULL || *p == NUL)
3126 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003127 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 if (buf == NULL)
3129 return -1;
3130
3131 /*
3132 * Walk through all entries in $PATH to check if "name" exists there and
3133 * is an executable file.
3134 */
3135 for (;;)
3136 {
3137 e = (char_u *)strchr((char *)p, ':');
3138 if (e == NULL)
3139 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003140 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 STRCPY(buf, "./");
3142 else
3143 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003144 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 add_pathsep(buf);
3146 }
3147 STRCAT(buf, name);
3148 retval = executable_file(buf);
3149 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003150 {
3151 if (path != NULL)
3152 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003153 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003154 *path = FullName_save(buf, TRUE);
3155 else
3156 *path = vim_strsave(buf);
3157 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003159 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160
3161 if (*e != ':')
3162 break;
3163 p = e + 1;
3164 }
3165
3166 vim_free(buf);
3167 return retval;
3168}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169
3170/*
3171 * Check what "name" is:
3172 * NODE_NORMAL: file or directory (or doesn't exist)
3173 * NODE_WRITABLE: writable device, socket, fifo, etc.
3174 * NODE_OTHER: non-writable things
3175 */
3176 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003177mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178{
3179 struct stat st;
3180
3181 if (stat((char *)name, &st))
3182 return NODE_NORMAL;
3183 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3184 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003185 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003187 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 return NODE_WRITABLE;
3189}
3190
3191 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003192mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193{
3194#ifdef HAVE_CHECK_STACK_GROWTH
3195 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 check_stack_growth((char *)&i);
3198
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003199# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 get_stack_limit();
3201# endif
3202
3203#endif
3204
3205 /*
3206 * Setup an alternative stack for signals. Helps to catch signals when
3207 * running out of stack space.
3208 * Use of sigaltstack() is preferred, it's more portable.
3209 * Ignore any errors.
3210 */
3211#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003212 signal_stack = alloc(SIGSTKSZ);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 init_signal_stack();
3214#endif
3215}
3216
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003217#if defined(EXITFREE) || defined(PROTO)
3218 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003219mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003220{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003221# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3222 if (clip_star.owned)
3223 clip_lose_selection(&clip_star);
3224 if (clip_plus.owned)
3225 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003226# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003227# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003228 if (xterm_Shell != (Widget)0)
3229 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003230# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003231 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003232 if (xterm_dpy != NULL)
3233 XtCloseDisplay(xterm_dpy);
3234 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003235 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003236 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003237# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003238 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003239# endif
3240 }
3241# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003242# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003243# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003244 if (x11_display != NULL
3245# ifdef FEAT_XCLIPBOARD
3246 && x11_display != xterm_dpy
3247# endif
3248 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003249 XCloseDisplay(x11_display);
3250# endif
3251# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003252 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003253# endif
3254# ifdef FEAT_TITLE
3255 vim_free(oldtitle);
3256 vim_free(oldicon);
3257# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003258}
3259#endif
3260
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261/*
3262 * Output a newline when exiting.
3263 * Make sure the newline goes to the same stream as the text.
3264 */
3265 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003266exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003268 if (silent_mode)
3269 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 if (newline_on_exit || msg_didout)
3271 {
3272 if (msg_use_printf())
3273 {
3274 if (info_message)
3275 mch_msg("\n");
3276 else
3277 mch_errmsg("\r\n");
3278 }
3279 else
3280 out_char('\n');
3281 }
3282 else
3283 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003284 restore_cterm_colors(); // get original colors back
3285 msg_clr_eos_force(); // clear the rest of the display
3286 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 }
3288}
3289
3290 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003291mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292{
3293 exiting = TRUE;
3294
3295#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3296 x11_export_final_selection();
3297#endif
3298
3299#ifdef FEAT_GUI
3300 if (!gui.in_use)
3301#endif
3302 {
3303 settmode(TMODE_COOK);
3304#ifdef FEAT_TITLE
Bram Moolenaar40385db2018-08-07 22:31:44 +02003305 // restore xterm title and icon name
3306 mch_restore_title(SAVE_RESTORE_BOTH);
3307 term_pop_title(SAVE_RESTORE_BOTH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308#endif
3309 /*
3310 * When t_ti is not empty but it doesn't cause swapping terminal
3311 * pages, need to output a newline when msg_didout is set. But when
3312 * t_ti does swap pages it should not go to the shell page. Do this
3313 * before stoptermcap().
3314 */
3315 if (swapping_screen() && !newline_on_exit)
3316 exit_scroll();
3317
Bram Moolenaar0f873732019-12-05 20:28:46 +01003318 // Stop termcap: May need to check for T_CRV response, which
3319 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 stoptermcap();
3321
3322 /*
3323 * A newline is only required after a message in the alternate screen.
3324 * This is set to TRUE by wait_return().
3325 */
3326 if (!swapping_screen() || newline_on_exit)
3327 exit_scroll();
3328
Bram Moolenaar0f873732019-12-05 20:28:46 +01003329 // Cursor may have been switched off without calling starttermcap()
3330 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 if (full_screen)
3332 cursor_on();
3333 }
3334 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003335 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 may_core_dump();
3337#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 gui_exit(r);
3340#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003341
Bram Moolenaar56718732006-03-15 22:53:57 +00003342#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003343 mac_conv_cleanup();
3344#endif
3345
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003347 // A core dump won't be created if the signal handler
3348 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 if (deadly_signal != 0)
3350 return;
3351#endif
3352
Bram Moolenaar009b2592004-10-24 19:18:58 +00003353#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003354 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003355#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003356
3357#ifdef EXITFREE
3358 free_all_mem();
3359#endif
3360
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 exit(r);
3362}
3363
3364 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003365may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366{
3367 if (deadly_signal != 0)
3368 {
3369 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003370 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 }
3372}
3373
3374#ifndef VMS
3375
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003376/*
3377 * Get the file descriptor to use for tty operations.
3378 */
3379 static int
3380get_tty_fd(int fd)
3381{
3382 int tty_fd = fd;
3383
3384#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3385 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3386 // "fd" when it is a master device.
3387 if (mch_isatty(fd) > 1)
3388 {
3389 char *name;
3390
3391 name = ptsname(fd);
3392 if (name == NULL)
3393 return -1;
3394
3395 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3396 if (tty_fd < 0)
3397 return -1;
3398 }
3399#endif
3400 return tty_fd;
3401}
3402
3403 static int
3404mch_tcgetattr(int fd, void *term)
3405{
3406 int tty_fd;
3407 int retval = -1;
3408
3409 tty_fd = get_tty_fd(fd);
3410 if (tty_fd >= 0)
3411 {
3412#ifdef NEW_TTY_SYSTEM
3413# ifdef HAVE_TERMIOS_H
3414 retval = tcgetattr(tty_fd, (struct termios *)term);
3415# else
3416 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
3417# endif
3418#else
3419 // for "old" tty systems
3420 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
3421#endif
3422 if (tty_fd != fd)
3423 close(tty_fd);
3424 }
3425 return retval;
3426}
3427
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003429mch_settmode(int tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430{
3431 static int first = TRUE;
3432
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003433#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434# ifdef HAVE_TERMIOS_H
3435 static struct termios told;
3436 struct termios tnew;
3437# else
3438 static struct termio told;
3439 struct termio tnew;
3440# endif
3441
3442 if (first)
3443 {
3444 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003445 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 }
3447
3448 tnew = told;
3449 if (tmode == TMODE_RAW)
3450 {
3451 /*
3452 * ~ICRNL enables typing ^V^M
3453 */
3454 tnew.c_iflag &= ~ICRNL;
3455 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
3456# if defined(IEXTEN) && !defined(__MINT__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003457 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
3458 // but it breaks function keys on MINT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459# endif
3460 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003461# ifdef ONLCR
3462 // Don't map NL -> CR NL, we do it ourselves.
3463 // Also disable expanding tabs if possible.
3464# ifdef XTABS
3465 tnew.c_oflag &= ~(ONLCR | XTABS);
3466# else
3467# ifdef TAB3
3468 tnew.c_oflag &= ~(ONLCR | TAB3);
3469# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003471# endif
3472# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003474 tnew.c_cc[VMIN] = 1; // return after 1 char
3475 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 }
3477 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003478 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003479 // Also reset ICANON here, otherwise on Solaris select() won't see
3480 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003481 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003482 tnew.c_cc[VMIN] = 1; // return after 1 char
3483 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003484 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485
3486# if defined(HAVE_TERMIOS_H)
3487 {
3488 int n = 10;
3489
Bram Moolenaar0f873732019-12-05 20:28:46 +01003490 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3491 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3493 && errno == EINTR && n > 0)
3494 --n;
3495 }
3496# else
3497 ioctl(read_cmd_fd, TCSETA, &tnew);
3498# endif
3499
3500#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 /*
3502 * for "old" tty systems
3503 */
3504# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003505# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506# endif
3507 static struct sgttyb ttybold;
3508 struct sgttyb ttybnew;
3509
3510 if (first)
3511 {
3512 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003513 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 }
3515
3516 ttybnew = ttybold;
3517 if (tmode == TMODE_RAW)
3518 {
3519 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3520 ttybnew.sg_flags |= RAW;
3521 }
3522 else if (tmode == TMODE_SLEEP)
3523 ttybnew.sg_flags &= ~(ECHO);
3524 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3525#endif
3526 curr_tmode = tmode;
3527}
3528
3529/*
3530 * Try to get the code for "t_kb" from the stty setting
3531 *
3532 * Even if termcap claims a backspace key, the user's setting *should*
3533 * prevail. stty knows more about reality than termcap does, and if
3534 * somebody's usual erase key is DEL (which, for most BSD users, it will
3535 * be), they're going to get really annoyed if their erase key starts
3536 * doing forward deletes for no reason. (Eric Fischer)
3537 */
3538 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003539get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003541 ttyinfo_T info;
3542 char_u buf[2];
3543 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003545 if (get_tty_info(read_cmd_fd, &info) == OK)
3546 {
3547 intr_char = info.interrupt;
3548 buf[0] = info.backspace;
3549 buf[1] = NUL;
3550 add_termcode((char_u *)"kb", buf, FALSE);
3551
Bram Moolenaar0f873732019-12-05 20:28:46 +01003552 // If <BS> and <DEL> are now the same, redefine <DEL>.
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003553 p = find_termcode((char_u *)"kD");
3554 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3555 do_fixdel(NULL);
3556 }
3557}
3558
3559/*
3560 * Obtain the characters that Backspace and Enter produce on "fd".
3561 * Returns OK or FAIL.
3562 */
3563 int
3564get_tty_info(int fd, ttyinfo_T *info)
3565{
3566#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567# ifdef HAVE_TERMIOS_H
3568 struct termios keys;
3569# else
3570 struct termio keys;
3571# endif
3572
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003573 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003575 info->backspace = keys.c_cc[VERASE];
3576 info->interrupt = keys.c_cc[VINTR];
3577 if (keys.c_iflag & ICRNL)
3578 info->enter = NL;
3579 else
3580 info->enter = CAR;
3581 if (keys.c_oflag & ONLCR)
3582 info->nl_does_cr = TRUE;
3583 else
3584 info->nl_does_cr = FALSE;
3585 return OK;
3586 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003588 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 struct sgttyb keys;
3590
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003591 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003593 info->backspace = keys.sg_erase;
3594 info->interrupt = keys.sg_kill;
3595 info->enter = CAR;
3596 info->nl_does_cr = TRUE;
3597 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003600 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601}
3602
Bram Moolenaar0f873732019-12-05 20:28:46 +01003603#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003605static int mouse_ison = FALSE;
3606
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607/*
3608 * Set mouse clicks on or off.
3609 */
3610 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003611mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003613#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003614 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003615#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 int xterm_mouse_vers;
3617
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003618#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003619 if (!on)
3620 // Make sure not tracing mouse movements. Important when a button-down
3621 // was received but no release yet.
3622 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003623#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003624
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003625 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003626#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003627 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003628#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003629 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003630 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 return;
3632
3633 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003634
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003635#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003636 if (ttym_flags == TTYM_URXVT)
3637 {
Bram Moolenaarc8427482011-10-20 21:09:35 +02003638 out_str_nf((char_u *)
3639 (on
3640 ? IF_EB("\033[?1015h", ESC_STR "[?1015h")
3641 : IF_EB("\033[?1015l", ESC_STR "[?1015l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003642 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003643 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003644#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003645
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003646 if (ttym_flags == TTYM_SGR)
3647 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003648 // SGR mode supports columns above 223
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003649 out_str_nf((char_u *)
3650 (on
3651 ? IF_EB("\033[?1006h", ESC_STR "[?1006h")
3652 : IF_EB("\033[?1006l", ESC_STR "[?1006l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003653 mouse_ison = on;
3654 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003655
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003656#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003657 if (bevalterm_ison != (p_bevalterm && on))
3658 {
3659 bevalterm_ison = (p_bevalterm && on);
3660 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003661 // disable mouse movement events, enabling is below
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003662 out_str_nf((char_u *)
3663 (IF_EB("\033[?1003l", ESC_STR "[?1003l")));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003664 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003665#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003666
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 if (xterm_mouse_vers > 0)
3668 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003669 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 out_str_nf((char_u *)
3671 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003672 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003673#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003674 bevalterm_ison
3675 ? IF_EB("\033[?1003h", ESC_STR "[?1003h") :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003676#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003677 IF_EB("\033[?1002h", ESC_STR "[?1002h"))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 : IF_EB("\033[?1000h", ESC_STR "[?1000h")));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003679 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 out_str_nf((char_u *)
3681 (xterm_mouse_vers > 1
3682 ? IF_EB("\033[?1002l", ESC_STR "[?1002l")
3683 : IF_EB("\033[?1000l", ESC_STR "[?1000l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003684 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 }
3686
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003687#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 else if (ttym_flags == TTYM_DEC)
3689 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003690 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003692 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003694 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003696#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003698#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 else
3700 {
3701 if (on)
3702 {
3703 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003704 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 }
3706 else
3707 {
3708 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003709 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 }
3711 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003712#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003714#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003715 else
3716 {
3717 if (on)
3718 {
3719 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003720 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003721 }
3722 else
3723 {
3724 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003725 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003726 }
3727 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003728#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003729
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003730#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 else
3732 {
3733 if (on)
3734 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003735 // D - Enable Mouse up/down messages
3736 // L - Enable Left Button Reporting
3737 // M - Enable Middle Button Reporting
3738 // R - Enable Right Button Reporting
3739 // K - Enable SHIFT and CTRL key Reporting
3740 // + - Enable Advanced messaging of mouse moves and up/down messages
3741 // Q - Quiet No Ack
3742 // # - Numeric value of mouse pointer required
3743 // 0 = Multiview 2000 cursor, used as standard
3744 // 1 = Windows Arrow
3745 // 2 = Windows I Beam
3746 // 3 = Windows Hour Glass
3747 // 4 = Windows Cross Hair
3748 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003749# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003750 // Disables full feedback of pointer movements
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 out_str_nf((char_u *)IF_EB("\033[0~ZwLMRK1Q\033\\",
3752 ESC_STR "[0~ZwLMRK1Q" ESC_STR "\\"));
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003753# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 out_str_nf((char_u *)IF_EB("\033[0~ZwLMRK+1Q\033\\",
3755 ESC_STR "[0~ZwLMRK+1Q" ESC_STR "\\"));
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003756# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003757 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 }
3759 else
3760 {
3761 out_str_nf((char_u *)IF_EB("\033[0~ZwQ\033\\",
3762 ESC_STR "[0~ZwQ" ESC_STR "\\"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003763 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 }
3765 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003766#endif
3767#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 else
3769 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003770 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 if (on)
3772 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3773 else
3774 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003775 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003777#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778}
3779
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003780#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003781/*
3782 * Called when 'balloonevalterm' changed.
3783 */
3784 void
3785mch_bevalterm_changed(void)
3786{
3787 mch_setmouse(mouse_ison);
3788}
3789#endif
3790
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791/*
3792 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3793 */
3794 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003795check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796{
3797# ifdef FEAT_MOUSE_XTERM
3798 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003799# ifdef FEAT_MOUSE_URXVT
3800 && use_xterm_mouse() != 3
3801# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802# ifdef FEAT_GUI
3803 && !gui.in_use
3804# endif
3805 )
3806 {
3807 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003808 ? IF_EB("\233M", CSI_STR "M")
3809 : IF_EB("\033[M", ESC_STR "[M")));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 if (*p_mouse != NUL)
3811 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003812 // force mouse off and maybe on to send possibly new mouse
3813 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 mch_setmouse(FALSE);
3815 setmouse();
3816 }
3817 }
3818 else
3819 del_mouse_termcode(KS_MOUSE);
3820# endif
3821
3822# ifdef FEAT_MOUSE_GPM
3823 if (!use_xterm_mouse()
3824# ifdef FEAT_GUI
3825 && !gui.in_use
3826# endif
3827 )
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003828 set_mouse_termcode(KS_GPM_MOUSE,
3829 (char_u *)IF_EB("\033MG", ESC_STR "MG"));
3830 else
3831 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832# endif
3833
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003834# ifdef FEAT_SYSMOUSE
3835 if (!use_xterm_mouse()
3836# ifdef FEAT_GUI
3837 && !gui.in_use
3838# endif
3839 )
3840 set_mouse_termcode(KS_MOUSE, (char_u *)IF_EB("\033MS", ESC_STR "MS"));
3841# endif
3842
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003844 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 if (!use_xterm_mouse()
3846# ifdef FEAT_GUI
3847 && !gui.in_use
3848# endif
3849 )
3850 set_mouse_termcode(KS_JSBTERM_MOUSE,
3851 (char_u *)IF_EB("\033[0~zw", ESC_STR "[0~zw"));
3852 else
3853 del_mouse_termcode(KS_JSBTERM_MOUSE);
3854# endif
3855
3856# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003857 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3858 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 if (!use_xterm_mouse()
3860# ifdef FEAT_GUI
3861 && !gui.in_use
3862# endif
3863 )
3864 set_mouse_termcode(KS_NETTERM_MOUSE,
3865 (char_u *)IF_EB("\033}", ESC_STR "}"));
3866 else
3867 del_mouse_termcode(KS_NETTERM_MOUSE);
3868# endif
3869
3870# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01003871 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003872 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873# ifdef FEAT_GUI
3874 && !gui.in_use
3875# endif
3876 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003877 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
3878 ? IF_EB("\233", CSI_STR) : IF_EB("\033[", ESC_STR "[")));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 else
3880 del_mouse_termcode(KS_DEC_MOUSE);
3881# endif
3882# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01003883 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003884 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885# ifdef FEAT_GUI
3886 && !gui.in_use
3887# endif
3888 )
3889 set_mouse_termcode(KS_PTERM_MOUSE,
3890 (char_u *) IF_EB("\033[", ESC_STR "["));
3891 else
3892 del_mouse_termcode(KS_PTERM_MOUSE);
3893# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003894# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003895 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02003896# ifdef FEAT_GUI
3897 && !gui.in_use
3898# endif
3899 )
3900 {
3901 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaara529ce02017-06-22 22:37:57 +02003902 ? IF_EB("\233*M", CSI_STR "*M")
3903 : IF_EB("\033[*M", ESC_STR "[*M")));
Bram Moolenaarc8427482011-10-20 21:09:35 +02003904
3905 if (*p_mouse != NUL)
3906 {
3907 mch_setmouse(FALSE);
3908 setmouse();
3909 }
3910 }
3911 else
3912 del_mouse_termcode(KS_URXVT_MOUSE);
3913# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003914 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01003915# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003916 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01003917# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003918 )
3919 {
3920 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaara529ce02017-06-22 22:37:57 +02003921 ? IF_EB("\233<*M", CSI_STR "<*M")
3922 : IF_EB("\033[<*M", ESC_STR "[<*M")));
3923
3924 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
3925 ? IF_EB("\233<*m", CSI_STR "<*m")
3926 : IF_EB("\033[<*m", ESC_STR "[<*m")));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003927
3928 if (*p_mouse != NUL)
3929 {
3930 mch_setmouse(FALSE);
3931 setmouse();
3932 }
3933 }
3934 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02003935 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003936 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02003937 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
3938 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941#ifndef VMS
3942
3943/*
3944 * Try to get the current window size:
3945 * 1. with an ioctl(), most accurate method
3946 * 2. from the environment variables LINES and COLUMNS
3947 * 3. from the termcap
3948 * 4. keep using the old values
3949 * Return OK when size could be determined, FAIL otherwise.
3950 */
3951 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003952mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953{
3954 long rows = 0;
3955 long columns = 0;
3956 char_u *p;
3957
3958 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 * 1. try using an ioctl. It is the most accurate method.
3960 *
3961 * Try using TIOCGWINSZ first, some systems that have it also define
3962 * TIOCGSIZE but don't have a struct ttysize.
3963 */
3964# ifdef TIOCGWINSZ
3965 {
3966 struct winsize ws;
3967 int fd = 1;
3968
Bram Moolenaar0f873732019-12-05 20:28:46 +01003969 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 if (!isatty(fd) && isatty(read_cmd_fd))
3971 fd = read_cmd_fd;
3972 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
3973 {
3974 columns = ws.ws_col;
3975 rows = ws.ws_row;
3976 }
3977 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01003978# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979# ifdef TIOCGSIZE
3980 {
3981 struct ttysize ts;
3982 int fd = 1;
3983
Bram Moolenaar0f873732019-12-05 20:28:46 +01003984 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 if (!isatty(fd) && isatty(read_cmd_fd))
3986 fd = read_cmd_fd;
3987 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
3988 {
3989 columns = ts.ts_cols;
3990 rows = ts.ts_lines;
3991 }
3992 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01003993# endif // TIOCGSIZE
3994# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995
3996 /*
3997 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003998 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
3999 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004001 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 {
4003 if ((p = (char_u *)getenv("LINES")))
4004 rows = atoi((char *)p);
4005 if ((p = (char_u *)getenv("COLUMNS")))
4006 columns = atoi((char *)p);
4007 }
4008
4009#ifdef HAVE_TGETENT
4010 /*
4011 * 3. try reading "co" and "li" entries from termcap
4012 */
4013 if (columns == 0 || rows == 0)
4014 getlinecol(&columns, &rows);
4015#endif
4016
4017 /*
4018 * 4. If everything fails, use the old values
4019 */
4020 if (columns <= 0 || rows <= 0)
4021 return FAIL;
4022
4023 Rows = rows;
4024 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004025 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 return OK;
4027}
4028
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004029#if defined(FEAT_TERMINAL) || defined(PROTO)
4030/*
4031 * Report the windows size "rows" and "cols" to tty "fd".
4032 */
4033 int
4034mch_report_winsize(int fd, int rows, int cols)
4035{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004036 int tty_fd;
4037 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004038
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004039 tty_fd = get_tty_fd(fd);
4040 if (tty_fd >= 0)
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004041 {
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004042# if defined(TIOCSWINSZ)
4043 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004044
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004045 ws.ws_col = cols;
4046 ws.ws_row = rows;
4047 ws.ws_xpixel = cols * 5;
4048 ws.ws_ypixel = rows * 10;
4049 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4050 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4051 retval == 0 ? "success" : "failed");
4052# elif defined(TIOCSSIZE)
4053 struct ttysize ts;
4054
4055 ts.ts_cols = cols;
4056 ts.ts_lines = rows;
4057 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4058 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4059 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004060# endif
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004061 if (tty_fd != fd)
4062 close(tty_fd);
4063 }
4064 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004065}
4066#endif
4067
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068/*
4069 * Try to set the window size to Rows and Columns.
4070 */
4071 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004072mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073{
4074 if (*T_CWS)
4075 {
4076 /*
4077 * NOTE: if you get an error here that term_set_winsize() is
4078 * undefined, check the output of configure. It could probably not
4079 * find a ncurses, termcap or termlib library.
4080 */
4081 term_set_winsize((int)Rows, (int)Columns);
4082 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004083 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 }
4085}
4086
Bram Moolenaar0f873732019-12-05 20:28:46 +01004087#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088
4089/*
4090 * Rows and/or Columns has changed.
4091 */
4092 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004093mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004095 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096}
4097
Bram Moolenaar205b8862011-09-07 15:04:31 +02004098/*
4099 * Wait for process "child" to end.
4100 * Return "child" if it exited properly, <= 0 on error.
4101 */
4102 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004103wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004104{
4105 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004106 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004107
4108 while (wait_pid != child)
4109 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004110 // When compiled with Python threads are probably used, in which case
4111 // wait() sometimes hangs for no obvious reason. Use waitpid()
4112 // instead and loop (like the GUI). Also needed for other interfaces,
4113 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004114# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004115 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004116# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004117 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004118# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004119 if (wait_pid == 0)
4120 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004121 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004122 mch_delay(delay_msec, TRUE);
4123 if (++delay_msec > 10)
4124 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004125 continue;
4126 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004127 if (wait_pid <= 0
4128# ifdef ECHILD
4129 && errno == ECHILD
4130# endif
4131 )
4132 break;
4133 }
4134 return wait_pid;
4135}
4136
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004137#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004138/*
4139 * Set the environment for a child process.
4140 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004141 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004142set_child_environment(
4143 long rows,
4144 long columns,
4145 char *term,
4146 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004147{
4148# ifdef HAVE_SETENV
4149 char envbuf[50];
4150# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004151 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004152 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004153 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004154 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004155 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004156# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004157 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004158# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004159# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004160 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004161# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004162# endif
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004163 long colors =
4164# ifdef FEAT_GUI
4165 gui.in_use ? 256*256*256 :
4166# endif
4167 t_colors;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004168
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004169# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004170 setenv("TERM", term, 1);
4171 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004172 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004173 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004174 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004175 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004176 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004177 sprintf((char *)envbuf, "%ld", colors);
4178 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004179# ifdef FEAT_TERMINAL
4180 if (is_terminal)
4181 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004182 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004183 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4184 }
4185# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004186# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004187 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004188# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004189# else
4190 /*
4191 * Putenv does not copy the string, it has to remain valid.
4192 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004193 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004194 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004195 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4196 putenv(envbuf_Term);
4197 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004198 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004199 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4200 putenv(envbuf_Lines);
4201 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4202 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004203 putenv(envbuf_Columns);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004204 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", colors);
4205 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004206# ifdef FEAT_TERMINAL
4207 if (is_terminal)
4208 {
4209 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004210 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004211 putenv(envbuf_Version);
4212 }
4213# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004214# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004215 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4216 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4217 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004218# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004219# endif
4220}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004221
4222 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004223set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004224{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004225 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004226}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004227#endif
4228
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004229#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004230/*
4231 * Open a PTY, with FD for the master and slave side.
4232 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004233 * When successful both file descriptors are stored and the allocated pty name
4234 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004235 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004236 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004237open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004238{
4239 char *tty_name;
4240
Bram Moolenaar59386482019-02-10 22:43:46 +01004241 if (name1 != NULL)
4242 *name1 = NULL;
4243 if (name2 != NULL)
4244 *name2 = NULL;
4245
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004246 *pty_master_fd = mch_openpty(&tty_name); // open pty
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004247 if (*pty_master_fd >= 0)
4248 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004249 // Leaving out O_NOCTTY may lead to waitpid() always returning
4250 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4251 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004252#ifdef O_NOCTTY
4253 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
4254#else
4255 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
4256#endif
4257 if (*pty_slave_fd < 0)
4258 {
4259 close(*pty_master_fd);
4260 *pty_master_fd = -1;
4261 }
Bram Moolenaar59386482019-02-10 22:43:46 +01004262 else
4263 {
4264 if (name1 != NULL)
4265 *name1 = vim_strsave((char_u *)tty_name);
4266 if (name2 != NULL)
4267 *name2 = vim_strsave((char_u *)tty_name);
4268 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004269 }
4270}
4271#endif
4272
Bram Moolenaarfae42832017-08-01 22:24:26 +02004273/*
4274 * Send SIGINT to a child process if "c" is an interrupt character.
4275 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004276 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004277may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4278{
4279# ifdef SIGINT
4280 if (c == Ctrl_C || c == intr_char)
4281 {
4282# ifdef HAVE_SETSID
4283 kill(-pid, SIGINT);
4284# else
4285 kill(0, SIGINT);
4286# endif
4287 if (wpid > 0)
4288 kill(wpid, SIGINT);
4289 }
4290# endif
4291}
4292
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004293#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004294
Bram Moolenaar0f873732019-12-05 20:28:46 +01004295/*
4296 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4297 * pointers, the last one is NULL.
4298 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4299 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004300 int
4301unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004302 char_u *cmd,
4303 char ***argvp,
4304 char_u **sh_tofree,
4305 char_u **shcf_tofree)
4306{
4307 char **argv = NULL;
4308 int argc;
4309
4310 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004311 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004312 return FAIL;
4313
4314 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4315 return FAIL;
4316 *argvp = argv;
4317
4318 if (cmd != NULL)
4319 {
4320 char_u *s;
4321 char_u *p;
4322
4323 if (extra_shell_arg != NULL)
4324 argv[argc++] = (char *)extra_shell_arg;
4325
Bram Moolenaar0f873732019-12-05 20:28:46 +01004326 // Break 'shellcmdflag' into white separated parts. This doesn't
4327 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004328 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004329 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004330 return FAIL;
4331 s = *shcf_tofree;
4332 p = p_shcf;
4333 while (*p != NUL)
4334 {
4335 argv[argc++] = (char *)s;
4336 while (*p && *p != ' ' && *p != TAB)
4337 *s++ = *p++;
4338 *s++ = NUL;
4339 p = skipwhite(p);
4340 }
4341
4342 argv[argc++] = (char *)cmd;
4343 }
4344 argv[argc] = NULL;
4345 return OK;
4346}
4347#endif
4348
4349#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4350/*
4351 * Use a terminal window to run a shell command in.
4352 */
4353 static int
4354mch_call_shell_terminal(
4355 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004356 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004357{
4358 jobopt_T opt;
4359 char **argv = NULL;
4360 char_u *tofree1 = NULL;
4361 char_u *tofree2 = NULL;
4362 int retval = -1;
4363 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004364 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004365 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004366 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004367
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004368 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004369 goto theend;
4370
4371 init_job_options(&opt);
4372 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4373 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004374 if (buf == NULL)
4375 goto theend;
4376
4377 job = term_getjob(buf->b_term);
4378 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004379
Bram Moolenaar0f873732019-12-05 20:28:46 +01004380 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004381 aucmd_prepbuf(&aco, buf);
4382
4383 clear_oparg(&oa);
4384 while (term_use_loop())
4385 {
4386 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4387 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004388 // If terminal_loop() returns OK we got a key that is handled
4389 // in Normal model. We don't do redrawing anyway.
Bram Moolenaar13568252018-03-16 20:46:58 +01004390 if (terminal_loop(TRUE) == OK)
4391 normal_cmd(&oa, TRUE);
4392 }
4393 else
4394 normal_cmd(&oa, TRUE);
4395 }
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004396 retval = job->jv_exitval;
Bram Moolenaar13568252018-03-16 20:46:58 +01004397 ch_log(NULL, "system command finished");
4398
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004399 job_unref(job);
4400
Bram Moolenaar0f873732019-12-05 20:28:46 +01004401 // restore curwin/curbuf and a few other things
Bram Moolenaar13568252018-03-16 20:46:58 +01004402 aucmd_restbuf(&aco);
4403
4404 wait_return(TRUE);
4405 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4406
4407theend:
4408 vim_free(argv);
4409 vim_free(tofree1);
4410 vim_free(tofree2);
4411 return retval;
4412}
4413#endif
4414
4415#ifdef USE_SYSTEM
4416/*
4417 * Use system() to start the shell: simple but slow.
4418 */
4419 static int
4420mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004421 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004422 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423{
4424#ifdef VMS
4425 char *ifn = NULL;
4426 char *ofn = NULL;
4427#endif
4428 int tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004429 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004430 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431
4432 out_flush();
4433
4434 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004435 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436
Bram Moolenaar62b42182010-09-21 22:09:37 +02004437# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004438 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004439 loose_clipboard();
4440# endif
4441
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 if (cmd == NULL)
4443 x = system((char *)p_sh);
4444 else
4445 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004446# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 if (ofn = strchr((char *)cmd, '>'))
4448 *ofn++ = '\0';
4449 if (ifn = strchr((char *)cmd, '<'))
4450 {
4451 char *p;
4452
4453 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004454 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 if (p)
4456 *p = '\0';
4457 }
4458 if (ofn)
4459 x = vms_sys((char *)cmd, ofn, ifn);
4460 else
4461 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004462# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004463 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004465 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 if (newcmd == NULL)
4467 x = 0;
4468 else
4469 {
4470 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4471 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4472 (char *)p_shcf,
4473 (char *)cmd);
4474 x = system((char *)newcmd);
4475 vim_free(newcmd);
4476 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004477# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 }
4479# ifdef VMS
4480 x = vms_sys_status(x);
4481# endif
4482 if (emsg_silent)
4483 ;
4484 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004485 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 else if (x && !(options & SHELL_SILENT))
4487 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004488 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 msg_outnum((long)x);
4490 msg_putchar('\n');
4491 }
4492
4493 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004494 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495# ifdef FEAT_TITLE
4496 resettitle();
4497# endif
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004498# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4499 restore_clipboard();
4500# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004502}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503
Bram Moolenaar0f873732019-12-05 20:28:46 +01004504#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505
Bram Moolenaar0f873732019-12-05 20:28:46 +01004506# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4507 // 127, some shells use that already
4508# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509
Bram Moolenaar13568252018-03-16 20:46:58 +01004510/*
4511 * Don't use system(), use fork()/exec().
4512 */
4513 static int
4514mch_call_shell_fork(
4515 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004516 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004517{
4518 int tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004520 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 pid_t wait_pid = 0;
4522# ifdef HAVE_UNION_WAIT
4523 union wait status;
4524# else
4525 int status = -1;
4526# endif
4527 int retval = -1;
4528 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004529 char_u *tofree1 = NULL;
4530 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004532 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004533# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004535# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004536 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 int fd_fromshell[2];
4538 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004539 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540
4541 out_flush();
4542 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004543 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004545 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004546 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004547
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004549 * For the GUI, when writing the output into the buffer and when reading
4550 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4551 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004553 if ((options & (SHELL_READ|SHELL_WRITE))
4554# ifdef FEAT_GUI
4555 || (gui.in_use && show_shell_mess)
4556# endif
4557 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004559# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 /*
4561 * Try to open a master pty.
4562 * If this works, open the slave pty.
4563 * If the slave can't be opened, close the master pty.
4564 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004565 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004566 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 /*
4568 * If not opening a pty or it didn't work, try using pipes.
4569 */
4570 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004571# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 {
4573 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004574 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 {
4576 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004577 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 {
4579 close(fd_toshell[0]);
4580 close(fd_toshell[1]);
4581 }
4582 }
4583 if (pipe_error)
4584 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004585 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 out_flush();
4587 }
4588 }
4589 }
4590
Bram Moolenaar0f873732019-12-05 20:28:46 +01004591 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004593 SIGSET_DECL(curset)
4594
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004595# if defined(__BEOS__) && USE_THREAD_FOR_INPUT_WITH_TIMEOUT
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 beos_cleanup_read_thread();
4597# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004598
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004599 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004600 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004601 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004603 UNBLOCK_SIGNALS(&curset);
4604
Bram Moolenaar32526b32019-01-19 17:43:09 +01004605 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004606 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004608 || (gui.in_use && show_shell_mess)
4609# endif
4610 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004612# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004613 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 {
4615 close(pty_master_fd);
4616 close(pty_slave_fd);
4617 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004618 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004619# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 {
4621 close(fd_toshell[0]);
4622 close(fd_toshell[1]);
4623 close(fd_fromshell[0]);
4624 close(fd_fromshell[1]);
4625 }
4626 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004628 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004630 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004631 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632
Bram Moolenaar819524702018-02-27 19:10:00 +01004633# ifdef FEAT_JOB_CHANNEL
4634 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01004635 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01004636 ch_logfile((char_u *)"", (char_u *)"");
4637# endif
4638
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 if (!show_shell_mess || (options & SHELL_EXPAND))
4640 {
4641 int fd;
4642
4643 /*
4644 * Don't want to show any message from the shell. Can't just
4645 * close stdout and stderr though, because some systems will
4646 * break if you try to write to them after that, so we must
4647 * use dup() to replace them with something else -- webb
4648 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4649 * waiting for input.
4650 */
4651 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4652 fclose(stdin);
4653 fclose(stdout);
4654 fclose(stderr);
4655
4656 /*
4657 * If any of these open()'s and dup()'s fail, we just continue
4658 * anyway. It's not fatal, and on most systems it will make
4659 * no difference at all. On a few it will cause the execvp()
4660 * to exit with a non-zero status even when the completion
4661 * could be done, which is nothing too serious. If the open()
4662 * or dup() failed we'd just do the same thing ourselves
4663 * anyway -- webb
4664 */
4665 if (fd >= 0)
4666 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004667 vim_ignored = dup(fd); // To replace stdin (fd 0)
4668 vim_ignored = dup(fd); // To replace stdout (fd 1)
4669 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670
Bram Moolenaar0f873732019-12-05 20:28:46 +01004671 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 close(fd);
4673 }
4674 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004675 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004677 || gui.in_use
4678# endif
4679 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 {
4681
Bram Moolenaardf177f62005-02-22 08:39:57 +00004682# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004683 // Create our own process group, so that the child and all its
4684 // children can be kill()ed. Don't do this when using pipes,
4685 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004686 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004687 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004688 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004689# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004690 // When doing "!xterm&" and 'shell' is bash: the shell
4691 // will exit and send SIGHUP to all processes in its
4692 // group, killing the just started process. Ignore SIGHUP
4693 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004694 signal(SIGHUP, SIG_IGN);
4695# endif
4696 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004697# endif
4698# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004699 if (pty_slave_fd >= 0)
4700 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004701 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004702 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004703 setup_slavepty(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01004705 // Try to become controlling tty (probably doesn't work,
4706 // unless run by root)
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004707 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004709 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004710# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004711 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712
Bram Moolenaara5792f52005-11-23 21:25:05 +00004713 /*
4714 * stderr is only redirected when using the GUI, so that a
4715 * program like gpg can still access the terminal to get a
4716 * passphrase using stderr.
4717 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004718# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 if (pty_master_fd >= 0)
4720 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004721 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722
Bram Moolenaar0f873732019-12-05 20:28:46 +01004723 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004725 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004727 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004728 if (gui.in_use)
4729 {
4730 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004731 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004732 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733
Bram Moolenaar0f873732019-12-05 20:28:46 +01004734 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 }
4736 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004737# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004739 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 close(fd_toshell[1]);
4741 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004742 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 close(fd_toshell[0]);
4744
Bram Moolenaar0f873732019-12-05 20:28:46 +01004745 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 close(fd_fromshell[0]);
4747 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004748 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 close(fd_fromshell[1]);
4750
Bram Moolenaara5792f52005-11-23 21:25:05 +00004751# ifdef FEAT_GUI
4752 if (gui.in_use)
4753 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004754 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004755 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004756 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004757 }
4758# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 }
4760 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004761
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 /*
4763 * There is no type cast for the argv, because the type may be
4764 * different on different machines. This may cause a warning
4765 * message with strict compilers, don't worry about it.
4766 * Call _exit() instead of exit() to avoid closing the connection
4767 * to the X server (esp. with GTK, which uses atexit()).
4768 */
4769 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004770 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004772 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 {
4774 /*
4775 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004776 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 */
4778 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004779 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004780 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004781# ifdef FEAT_JOB_CHANNEL
4782 ++dont_check_job_ended;
4783# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 /*
4785 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004786 * This is also used to pipe stdin/stdout to/from the external
4787 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004789 if ((options & (SHELL_READ|SHELL_WRITE))
4790# ifdef FEAT_GUI
4791 || (gui.in_use && show_shell_mess)
4792# endif
4793 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004795# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004797 int buffer_off = 0; // valid bytes in buffer[]
4798 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4799 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 int len;
4801 int p_more_save;
4802 int old_State;
4803 int c;
4804 int toshell_fd;
4805 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004806 garray_T ga;
4807 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004808# ifdef ELAPSED_FUNC
4809 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004810# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811
Bram Moolenaardf177f62005-02-22 08:39:57 +00004812# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 if (pty_master_fd >= 0)
4814 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 fromshell_fd = pty_master_fd;
4816 toshell_fd = dup(pty_master_fd);
4817 }
4818 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004819# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 {
4821 close(fd_toshell[0]);
4822 close(fd_fromshell[1]);
4823 toshell_fd = fd_toshell[1];
4824 fromshell_fd = fd_fromshell[0];
4825 }
4826
4827 /*
4828 * Write to the child if there are typed characters.
4829 * Read from the child if there are characters available.
4830 * Repeat the reading a few times if more characters are
4831 * available. Need to check for typed keys now and then, but
4832 * not too often (delays when no chars are available).
4833 * This loop is quit if no characters can be read from the pty
4834 * (WaitForChar detected special condition), or there are no
4835 * characters available and the child has exited.
4836 * Only check if the child has exited when there is no more
4837 * output. The child may exit before all the output has
4838 * been printed.
4839 *
4840 * Currently this busy loops!
4841 * This can probably dead-lock when the write blocks!
4842 */
4843 p_more_save = p_more;
4844 p_more = FALSE;
4845 old_State = State;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004846 State = EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004848 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004849 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004850 // Fork a process that will write the lines to the
4851 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004852 if ((wpid = fork()) == -1)
4853 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004854 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004855 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004856 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004857 {
4858 linenr_T lnum = curbuf->b_op_start.lnum;
4859 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004860 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004861 size_t l;
4862
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004863 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004864 for (;;)
4865 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00004866 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004867 if (l == 0)
4868 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004869 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004870 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00004871 len = write(toshell_fd, "", (size_t)1);
4872 else
4873 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01004874 char_u *s = vim_strchr(lp + written, NL);
4875
Bram Moolenaar89d40322006-08-29 15:30:07 +00004876 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00004877 s == NULL ? l
4878 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004879 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00004880 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004881 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004882 // Finished a line, add a NL, unless this line
4883 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004884 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02004885 || (!curbuf->b_p_bin
4886 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01004887 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaardf177f62005-02-22 08:39:57 +00004888 && (lnum !=
4889 curbuf->b_ml.ml_line_count
4890 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02004891 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004892 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004893 ++lnum;
4894 if (lnum > curbuf->b_op_end.lnum)
4895 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004896 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00004897 close(toshell_fd);
4898 toshell_fd = -1;
4899 break;
4900 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00004901 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004902 written = 0;
4903 }
4904 else if (len > 0)
4905 written += len;
4906 }
4907 _exit(0);
4908 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004909 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00004910 {
4911 close(toshell_fd);
4912 toshell_fd = -1;
4913 }
4914 }
4915
4916 if (options & SHELL_READ)
4917 ga_init2(&ga, 1, BUFLEN);
4918
4919 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01004920# ifdef ELAPSED_FUNC
4921 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004922# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 for (;;)
4924 {
4925 /*
4926 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004927 * if there are any.
4928 * Don't do this if we are expanding wild cards (would eat
4929 * typeahead).
4930 * Don't do this when filtering and terminal is in cooked
4931 * mode, the shell command will handle the I/O. Avoids
4932 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004933 * Don't get characters when the child has already
4934 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00004935 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004936 * while (noread_cnt > 4), avoids that ":r !ls" eats
4937 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 */
4939 len = 0;
4940 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004941 && ((options &
4942 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
4943 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004944# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004945 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004946# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004947 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004948 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004949 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004951 if (ta_len == 0)
4952 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004953 // Get extra characters when we don't have any.
4954 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004955 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01004956# ifdef ELAPSED_FUNC
4957 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004958# endif
4959 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
4960 }
4961 if (ta_len > 0 || len > 0)
4962 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 /*
4964 * For pipes:
4965 * Check for CTRL-C: send interrupt signal to child.
4966 * Check for CTRL-D: EOF, close pipe to child.
4967 */
4968 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
4969 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 /*
4971 * Send SIGINT to the child's group or all
4972 * processes in our group.
4973 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02004974 may_send_sigint(ta_buf[ta_len], pid, wpid);
4975
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 if (pty_master_fd < 0 && toshell_fd >= 0
4977 && ta_buf[ta_len] == Ctrl_D)
4978 {
4979 close(toshell_fd);
4980 toshell_fd = -1;
4981 }
4982 }
4983
Bram Moolenaarf4140482020-02-15 23:06:45 +01004984 term_replace_bs_del_keycode(ta_buf, ta_len, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
4986 /*
4987 * For pipes: echo the typed characters.
4988 * For a pty this does not seem to work.
4989 */
4990 if (pty_master_fd < 0)
4991 {
4992 for (i = ta_len; i < ta_len + len; ++i)
4993 {
4994 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
4995 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 else if (has_mbyte)
4997 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004998 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999
5000 msg_outtrans_len(ta_buf + i, l);
5001 i += l - 1;
5002 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 else
5004 msg_outtrans_len(ta_buf + i, 1);
5005 }
5006 windgoto(msg_row, msg_col);
5007 out_flush();
5008 }
5009
5010 ta_len += len;
5011
5012 /*
5013 * Write the characters to the child, unless EOF has
5014 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005015 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005016 * When writing buffer lines, drop the typed
5017 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005019 if (options & SHELL_WRITE)
5020 ta_len = 0;
5021 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 {
5023 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5024 if (len > 0)
5025 {
5026 ta_len -= len;
5027 mch_memmove(ta_buf, ta_buf + len, ta_len);
5028 }
5029 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005030 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 }
5032
Bram Moolenaardf177f62005-02-22 08:39:57 +00005033 if (got_int)
5034 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005035 // CTRL-C sends a signal to the child, we ignore it
5036 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005037# ifdef HAVE_SETSID
5038 kill(-pid, SIGINT);
5039# else
5040 kill(0, SIGINT);
5041# endif
5042 if (wpid > 0)
5043 kill(wpid, SIGINT);
5044 got_int = FALSE;
5045 }
5046
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 /*
5048 * Check if the child has any characters to be printed.
5049 * Read them and write them to our window. Repeat this as
5050 * long as there is something to do, avoid the 10ms wait
5051 * for mch_inchar(), or sending typeahead characters to
5052 * the external process.
5053 * TODO: This should handle escape sequences, compatible
5054 * to some terminal (vt52?).
5055 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005056 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005057 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005059 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005062 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005064
5065 noread_cnt = 0;
5066 if (options & SHELL_READ)
5067 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005068 // Do NUL -> NL translation, append NL separated
5069 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005070 for (i = 0; i < len; ++i)
5071 {
5072 if (buffer[i] == NL)
5073 append_ga_line(&ga);
5074 else if (buffer[i] == NUL)
5075 ga_append(&ga, NL);
5076 else
5077 ga_append(&ga, buffer[i]);
5078 }
5079 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005080 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 {
5082 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005083 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084
Bram Moolenaardf177f62005-02-22 08:39:57 +00005085 len += buffer_off;
5086 buffer[len] = NUL;
5087
Bram Moolenaar0f873732019-12-05 20:28:46 +01005088 // Check if the last character in buffer[] is
5089 // incomplete, keep these bytes for the next
5090 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 for (p = buffer; p < buffer + len; p += l)
5092 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005093 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005095 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 else if (MB_BYTE2LEN(*p) != l)
5097 break;
5098 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005099 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005101 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 if (len >= 12)
5103 ++p;
5104 else
5105 {
5106 buffer_off = len;
5107 continue;
5108 }
5109 }
5110 c = *p;
5111 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005112 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 if (p < buffer + len)
5114 {
5115 *p = c;
5116 buffer_off = (buffer + len) - p;
5117 mch_memmove(buffer, p, buffer_off);
5118 continue;
5119 }
5120 buffer_off = 0;
5121 }
5122 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 {
5124 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005125 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 }
5127
5128 windgoto(msg_row, msg_col);
5129 cursor_on();
5130 out_flush();
5131 if (got_int)
5132 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005133
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005134# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005135 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005136 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005137 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005138
Bram Moolenaar0f873732019-12-05 20:28:46 +01005139 // Avoid that we keep looping here without
5140 // checking for a CTRL-C for a long time. Don't
5141 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005142 if (msec > 2000)
5143 {
5144 noread_cnt = 5;
5145 break;
5146 }
5147 }
5148# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 }
5150
Bram Moolenaar0f873732019-12-05 20:28:46 +01005151 // If we already detected the child has finished, continue
5152 // reading output for a short while. Some text may be
5153 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005154 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005155 {
5156 if (noread_cnt < 5)
5157 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005158 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005159 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005160
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 /*
5162 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005163 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005165# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005166 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005167# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005169# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5171 || (wait_pid == pid && WIFEXITED(status)))
5172 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005173 // Don't break the loop yet, try reading more
5174 // characters from "fromshell_fd" first. When using
5175 // pipes there might still be something to read and
5176 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005179 else
5180 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005181
Bram Moolenaar95a51352013-03-21 22:53:50 +01005182# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005183 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005184 clip_update();
5185# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 }
5187finished:
5188 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005189 if (options & SHELL_READ)
5190 {
5191 if (ga.ga_len > 0)
5192 {
5193 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005194 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005195 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005196 }
5197 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005198 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005199 ga_clear(&ga);
5200 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 /*
5203 * Give all typeahead that wasn't used back to ui_inchar().
5204 */
5205 if (ta_len)
5206 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 State = old_State;
5208 if (toshell_fd >= 0)
5209 close(toshell_fd);
5210 close(fromshell_fd);
5211 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005212# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005213 else
5214 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005215 long delay_msec = 1;
5216
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005217 /*
5218 * Similar to the loop above, but only handle X events, no
5219 * I/O.
5220 */
5221 for (;;)
5222 {
5223 if (got_int)
5224 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005225 // CTRL-C sends a signal to the child, we ignore it
5226 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005227# ifdef HAVE_SETSID
5228 kill(-pid, SIGINT);
5229# else
5230 kill(0, SIGINT);
5231# endif
5232 got_int = FALSE;
5233 }
5234# ifdef __NeXT__
5235 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5236# else
5237 wait_pid = waitpid(pid, &status, WNOHANG);
5238# endif
5239 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5240 || (wait_pid == pid && WIFEXITED(status)))
5241 {
5242 wait_pid = pid;
5243 break;
5244 }
5245
Bram Moolenaar0f873732019-12-05 20:28:46 +01005246 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005247 clip_update();
5248
Bram Moolenaar0f873732019-12-05 20:28:46 +01005249 // Wait for 1 to 10 msec. 1 is faster but gives the child
5250 // less time.
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005251 mch_delay(delay_msec, TRUE);
5252 if (++delay_msec > 10)
5253 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005254 }
5255 }
5256# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257
5258 /*
5259 * Wait until our child has exited.
5260 * Ignore wait() returning pids of other children and returning
5261 * because of some signal like SIGWINCH.
5262 * Don't wait if wait_pid was already set above, indicating the
5263 * child already exited.
5264 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005265 if (wait_pid != pid)
5266 wait_pid = wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267
Bram Moolenaar624891f2010-10-13 16:22:09 +02005268# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005269 // Close slave side of pty. Only do this after the child has
5270 // exited, otherwise the child may hang when it tries to write on
5271 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005272 if (pty_master_fd >= 0)
5273 close(pty_slave_fd);
5274# endif
5275
Bram Moolenaar0f873732019-12-05 20:28:46 +01005276 // Make sure the child that writes to the external program is
5277 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005278 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005279 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005280 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005281 wait4pid(wpid, NULL);
5282 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005283
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005284# ifdef FEAT_JOB_CHANNEL
5285 --dont_check_job_ended;
5286# endif
5287
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 /*
5289 * Set to raw mode right now, otherwise a CTRL-C after
5290 * catch_signals() will kill Vim.
5291 */
5292 if (tmode == TMODE_RAW)
5293 settmode(TMODE_RAW);
5294 did_settmode = TRUE;
5295 set_signals();
5296
5297 if (WIFEXITED(status))
5298 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005299 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005301 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 {
5303 if (retval == EXEC_FAILED)
5304 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005305 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 msg_outtrans(p_sh);
5307 msg_putchar('\n');
5308 }
5309 else if (!(options & SHELL_SILENT))
5310 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005311 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 msg_outnum((long)retval);
5313 msg_putchar('\n');
5314 }
5315 }
5316 }
5317 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005318 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 }
5320 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321
5322error:
5323 if (!did_settmode)
5324 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005325 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326# ifdef FEAT_TITLE
5327 resettitle();
5328# endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005329 vim_free(argv);
5330 vim_free(tofree1);
5331 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332
5333 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005334}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005335#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005336
5337 int
5338mch_call_shell(
5339 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005340 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005341{
5342#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
5343 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
5344 return mch_call_shell_terminal(cmd, options);
5345#endif
5346#ifdef USE_SYSTEM
5347 return mch_call_shell_system(cmd, options);
5348#else
5349 return mch_call_shell_fork(cmd, options);
5350#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351}
5352
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005353#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005354 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005355mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005356{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005357 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005358 int fd_in[2] = {-1, -1}; // for stdin
5359 int fd_out[2] = {-1, -1}; // for stdout
5360 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005361 int pty_master_fd = -1;
5362 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005363 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005364 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5365 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5366 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005367 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005368 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5369 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005370 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005371 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005372 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005373
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005374 if (use_out_for_err && use_null_for_out)
5375 use_null_for_err = TRUE;
5376
Bram Moolenaar0f873732019-12-05 20:28:46 +01005377 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005378 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005379
Bram Moolenaarb2412082017-08-20 18:09:14 +02005380 if (options->jo_pty
5381 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005382 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005383 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005384 open_pty(&pty_master_fd, &pty_slave_fd,
5385 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005386
Bram Moolenaar0f873732019-12-05 20:28:46 +01005387 // TODO: without the channel feature connect the child to /dev/null?
5388 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005389 if (use_file_for_in)
5390 {
5391 char_u *fname = options->jo_io_name[PART_IN];
5392
5393 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5394 if (fd_in[0] < 0)
5395 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005396 semsg(_(e_notopen), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005397 goto failed;
5398 }
5399 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005400 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005401 // When writing buffer lines to the input don't use the pty, so that
5402 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005403 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5404 && pipe(fd_in) < 0)
5405 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005406
5407 if (use_file_for_out)
5408 {
5409 char_u *fname = options->jo_io_name[PART_OUT];
5410
5411 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5412 if (fd_out[1] < 0)
5413 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005414 semsg(_(e_notopen), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005415 goto failed;
5416 }
5417 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005418 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005419 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005420
5421 if (use_file_for_err)
5422 {
5423 char_u *fname = options->jo_io_name[PART_ERR];
5424
5425 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5426 if (fd_err[1] < 0)
5427 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005428 semsg(_(e_notopen), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005429 goto failed;
5430 }
5431 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005432 else if (!use_out_for_err && !use_null_for_err
5433 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005434 goto failed;
5435
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005436 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5437 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005438 if (options->jo_set & JO_CHANNEL)
5439 {
5440 channel = options->jo_channel;
5441 if (channel != NULL)
5442 ++channel->ch_refcount;
5443 }
5444 else
5445 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005446 if (channel == NULL)
5447 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005448 if (job->jv_tty_out != NULL)
5449 ch_log(channel, "using pty %s on fd %d",
5450 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005451 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005452
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005453 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005454 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005455 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005456 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005457 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005458 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005459 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005460 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005461 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005462 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005463 int null_fd = -1;
5464 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005465
Bram Moolenaar0f873732019-12-05 20:28:46 +01005466 // child
5467 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005468 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005469
Bram Moolenaar819524702018-02-27 19:10:00 +01005470# ifdef FEAT_JOB_CHANNEL
5471 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005472 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005473 ch_logfile((char_u *)"", (char_u *)"");
5474# endif
5475
Bram Moolenaar835dc632016-02-07 14:27:38 +01005476# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005477 // Create our own process group, so that the child and all its
5478 // children can be kill()ed. Don't do this when using pipes,
5479 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005480 (void)setsid();
5481# endif
5482
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005483# ifdef FEAT_TERMINAL
5484 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005485 {
5486 char *term = (char *)T_NAME;
5487
5488#ifdef FEAT_GUI
5489 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005490 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005491 term = getenv("TERM");
5492#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005493 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005494 // back to "xterm" or "xterm-color".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005495 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005496 {
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005497 if (t_colors >= 256)
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005498 // TODO: should we check this name is supported?
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005499 term = "xterm-256color";
Bram Moolenaar4d5d0df2020-04-14 20:56:31 +02005500 else if (t_colors > 16)
5501 term = "xterm-color";
Bram Moolenaar5ba8d352020-04-05 21:42:12 +02005502 else
5503 term = "xterm";
5504 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005505 set_child_environment(
5506 (long)options->jo_term_rows,
5507 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005508 term,
5509 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005510 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005511 else
5512# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005513 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005514
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005515 if (options->jo_env != NULL)
5516 {
5517 dict_T *dict = options->jo_env;
5518 hashitem_T *hi;
5519 int todo = (int)dict->dv_hashtab.ht_used;
5520
5521 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5522 if (!HASHITEM_EMPTY(hi))
5523 {
5524 typval_T *item = &dict_lookup(hi)->di_tv;
5525
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005526 vim_setenv((char_u*)hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005527 --todo;
5528 }
5529 }
5530
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005531 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005532 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005533 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005534 if (null_fd < 0)
5535 {
5536 perror("opening /dev/null failed");
5537 _exit(OPEN_NULL_FAILED);
5538 }
5539 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005540
Bram Moolenaar223896d2017-08-02 22:33:28 +02005541 if (pty_slave_fd >= 0)
5542 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005543 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005544 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005545# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005546 // Try to become controlling tty (probably doesn't work,
5547 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005548 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5549# endif
5550 }
5551
Bram Moolenaar0f873732019-12-05 20:28:46 +01005552 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005553 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005554 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005555 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005556 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005557 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005558 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005559 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005560
Bram Moolenaar0f873732019-12-05 20:28:46 +01005561 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005562 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005563 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005564 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005565 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005566 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005567 }
5568 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005569 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005570 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005571 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005572 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005573 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005574
Bram Moolenaar0f873732019-12-05 20:28:46 +01005575 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005576 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005577 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005578 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005579 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005580 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005581 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005582 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005583
5584 if (fd_in[0] >= 0)
5585 close(fd_in[0]);
5586 if (fd_in[1] >= 0)
5587 close(fd_in[1]);
5588 if (fd_out[0] >= 0)
5589 close(fd_out[0]);
5590 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005591 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005592 if (fd_err[0] >= 0)
5593 close(fd_err[0]);
5594 if (fd_err[1] >= 0)
5595 close(fd_err[1]);
5596 if (pty_master_fd >= 0)
5597 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005598 close(pty_master_fd); // not used in the child
5599 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005600 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005601
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005602 if (null_fd >= 0)
5603 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005604
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005605 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5606 _exit(EXEC_FAILED);
5607
Bram Moolenaar0f873732019-12-05 20:28:46 +01005608 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005609 execvp(argv[0], argv);
5610
Bram Moolenaar4694a172016-04-21 14:05:23 +02005611 if (stderr_works)
5612 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005613# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005614 // calling free_all_mem() here causes problems. Ignore valgrind
5615 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005616# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005617 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005618 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005619
Bram Moolenaar0f873732019-12-05 20:28:46 +01005620 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005621 UNBLOCK_SIGNALS(&curset);
5622
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005623 job->jv_pid = pid;
5624 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005625 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005626
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005627 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005628 close(pty_slave_fd); // not used in the parent
5629 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005630 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005631 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005632 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005633 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005634 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005635 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005636 if (channel != NULL)
5637 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005638 int in_fd = INVALID_FD;
5639 int out_fd = INVALID_FD;
5640 int err_fd = INVALID_FD;
5641
5642 if (!(use_file_for_in || use_null_for_in))
5643 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5644
5645 if (!(use_file_for_out || use_null_for_out))
5646 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5647
5648 // When using pty_master_fd only set it for stdout, do not duplicate
5649 // it for stderr, it only needs to be read once.
5650 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5651 {
5652 if (fd_err[0] >= 0)
5653 err_fd = fd_err[0];
5654 else if (out_fd != pty_master_fd)
5655 err_fd = pty_master_fd;
5656 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005657
5658 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005659 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005660 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005661 else
5662 {
5663 if (fd_in[1] >= 0)
5664 close(fd_in[1]);
5665 if (fd_out[0] >= 0)
5666 close(fd_out[0]);
5667 if (fd_err[0] >= 0)
5668 close(fd_err[0]);
5669 if (pty_master_fd >= 0)
5670 close(pty_master_fd);
5671 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005672
Bram Moolenaar0f873732019-12-05 20:28:46 +01005673 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005674 return;
5675
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005676failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005677 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005678 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005679 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005680 if (fd_in[1] >= 0)
5681 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005682 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005683 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005684 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005685 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005686 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005687 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005688 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005689 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005690 if (pty_master_fd >= 0)
5691 close(pty_master_fd);
5692 if (pty_slave_fd >= 0)
5693 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005694}
5695
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005696 static char_u *
5697get_signal_name(int sig)
5698{
5699 int i;
5700 char_u numbuf[NUMBUFLEN];
5701
5702 if (sig == SIGKILL)
5703 return vim_strsave((char_u *)"kill");
5704
5705 for (i = 0; signal_info[i].sig != -1; i++)
5706 if (sig == signal_info[i].sig)
5707 return strlow_save((char_u *)signal_info[i].name);
5708
5709 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5710 return vim_strsave(numbuf);
5711}
5712
Bram Moolenaar835dc632016-02-07 14:27:38 +01005713 char *
5714mch_job_status(job_T *job)
5715{
5716# ifdef HAVE_UNION_WAIT
5717 union wait status;
5718# else
5719 int status = -1;
5720# endif
5721 pid_t wait_pid = 0;
5722
5723# ifdef __NeXT__
5724 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5725# else
5726 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5727# endif
5728 if (wait_pid == -1)
5729 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005730 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005731 if (job->jv_status < JOB_ENDED)
5732 ch_log(job->jv_channel, "Job no longer exists: %s",
5733 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005734 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005735 }
5736 if (wait_pid == 0)
5737 return "run";
5738 if (WIFEXITED(status))
5739 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005740 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005741 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005742 if (job->jv_status < JOB_ENDED)
5743 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005744 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005745 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005746 if (WIFSIGNALED(status))
5747 {
5748 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005749 job->jv_termsig = get_signal_name(WTERMSIG(status));
5750 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5751 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5752 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005753 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005754 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005755 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005756
5757return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005758 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005759 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005760 return "dead";
5761}
5762
5763 job_T *
5764mch_detect_ended_job(job_T *job_list)
5765{
5766# ifdef HAVE_UNION_WAIT
5767 union wait status;
5768# else
5769 int status = -1;
5770# endif
5771 pid_t wait_pid = 0;
5772 job_T *job;
5773
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005774# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005775 // Do not do this when waiting for a shell command to finish, we would get
5776 // the exit value here (and discard it), the exit value obtained there
5777 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005778 if (dont_check_job_ended > 0)
5779 return NULL;
5780# endif
5781
Bram Moolenaar97792de2016-10-15 18:36:49 +02005782# ifdef __NeXT__
5783 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5784# else
5785 wait_pid = waitpid(-1, &status, WNOHANG);
5786# endif
5787 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005788 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005789 return NULL;
5790 for (job = job_list; job != NULL; job = job->jv_next)
5791 {
5792 if (job->jv_pid == wait_pid)
5793 {
5794 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005795 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005796 job->jv_exitval = WEXITSTATUS(status);
5797 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005798 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005799 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005800 job->jv_termsig = get_signal_name(WTERMSIG(status));
5801 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005802 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005803 {
5804 ch_log(job->jv_channel, "Job ended");
5805 job->jv_status = JOB_ENDED;
5806 }
5807 return job;
5808 }
5809 }
5810 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005811}
5812
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005813/*
5814 * Send a (deadly) signal to "job".
5815 * Return FAIL if "how" is not a valid name.
5816 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005817 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005818mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005819{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005820 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005821
Bram Moolenaar923d9262016-02-25 20:56:01 +01005822 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005823 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005824 else if (STRCMP(how, "hup") == 0)
5825 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005826 else if (STRCMP(how, "quit") == 0)
5827 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005828 else if (STRCMP(how, "int") == 0)
5829 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005830 else if (STRCMP(how, "kill") == 0)
5831 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005832#ifdef SIGWINCH
5833 else if (STRCMP(how, "winch") == 0)
5834 sig = SIGWINCH;
5835#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005836 else if (isdigit(*how))
5837 sig = atoi((char *)how);
5838 else
5839 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005840
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005841 // Never kill ourselves!
5842 if (job->jv_pid != 0)
5843 {
5844 // TODO: have an option to only kill the process, not the group?
5845 kill(-job->jv_pid, sig);
5846 kill(job->jv_pid, sig);
5847 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005848
Bram Moolenaar835dc632016-02-07 14:27:38 +01005849 return OK;
5850}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005851
5852/*
5853 * Clear the data related to "job".
5854 */
5855 void
5856mch_clear_job(job_T *job)
5857{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005858 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01005859# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005860 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005861# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005862 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005863# endif
5864}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005865#endif
5866
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005867#if defined(FEAT_TERMINAL) || defined(PROTO)
5868 int
5869mch_create_pty_channel(job_T *job, jobopt_T *options)
5870{
5871 int pty_master_fd = -1;
5872 int pty_slave_fd = -1;
5873 channel_T *channel;
5874
Bram Moolenaar59386482019-02-10 22:43:46 +01005875 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005876 close(pty_slave_fd);
5877
5878 channel = add_channel();
5879 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02005880 {
5881 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005882 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02005883 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02005884 if (job->jv_tty_out != NULL)
5885 ch_log(channel, "using pty %s on fd %d",
5886 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005887 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005888 channel->ch_keep_open = TRUE;
5889
Bram Moolenaar0f873732019-12-05 20:28:46 +01005890 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
5891 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005892 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005893 channel_set_job(channel, job, options);
5894 return OK;
5895}
5896#endif
5897
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898/*
5899 * Check for CTRL-C typed by reading all available characters.
5900 * In cooked mode we should get SIGINT, no need to check.
5901 */
5902 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02005903mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904{
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02005905 if ((curr_tmode == TMODE_RAW || force)
5906 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 fill_input_buf(FALSE);
5908}
5909
5910/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005911 * Wait "msec" msec until a character is available from the mouse, keyboard,
5912 * from inbuf[].
5913 * "msec" == -1 will block forever.
5914 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005915 * When "ignore_input" is TRUE even check for pending input when input is
5916 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02005917 * "interrupted" (if not NULL) is set to TRUE when no character is available
5918 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02005919 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02005920 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 */
5922 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005923WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005925#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01005926 return ui_wait_for_chars_or_timer(
5927 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005928#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005929 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005930#endif
5931}
5932
5933/*
5934 * Wait "msec" msec until a character is available from the mouse or keyboard
5935 * or from inbuf[].
5936 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005937 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02005938 * "interrupted" (if not NULL) is set to TRUE when no character is available
5939 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005940 * When a GUI is being used, this will never get called -- webb
5941 */
5942 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005943WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005944{
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945#ifdef FEAT_MOUSE_GPM
5946 int gpm_process_wanted;
5947#endif
5948#ifdef FEAT_XCLIPBOARD
5949 int rest;
5950#endif
5951 int avail;
5952
Bram Moolenaar0f873732019-12-05 20:28:46 +01005953 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 return 1;
5955
5956#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005957 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 if (WantQueryMouse)
5959 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00005960 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02005961 if (!no_query_mouse_for_testing)
5962 mch_write((char_u *)IF_EB("\033[1'|", ESC_STR "[1'|"), 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 }
5964#endif
5965
5966 /*
5967 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
5968 * events. This is a bit complicated, because they might both be defined.
5969 */
5970#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
5971# ifdef FEAT_XCLIPBOARD
5972 rest = 0;
5973 if (do_xterm_trace())
5974 rest = msec;
5975# endif
5976 do
5977 {
5978# ifdef FEAT_XCLIPBOARD
5979 if (rest != 0)
5980 {
5981 msec = XT_TRACE_DELAY;
5982 if (rest >= 0 && rest < XT_TRACE_DELAY)
5983 msec = rest;
5984 if (rest >= 0)
5985 rest -= msec;
5986 }
5987# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02005988# ifdef FEAT_SOUND_CANBERRA
5989 // Invoke any pending sound callbacks.
5990 if (has_sound_callback_in_queue())
5991 invoke_sound_callback();
5992# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993# ifdef FEAT_MOUSE_GPM
5994 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005995 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02005996 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02005997 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02005999 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006001# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006003 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 return 1;
6005# ifdef FEAT_XCLIPBOARD
6006 if (rest == 0 || !do_xterm_trace())
6007# endif
6008 break;
6009 }
6010 }
6011 while (FALSE
6012# ifdef FEAT_MOUSE_GPM
6013 || (gpm_process_wanted && mch_gpm_process() == 0)
6014# endif
6015# ifdef FEAT_XCLIPBOARD
6016 || (!avail && rest != 0)
6017# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006018 )
6019 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
6021#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006022 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023#endif
6024 return avail;
6025}
6026
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006027#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028/*
6029 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006030 * "msec" == 0 will check for characters once.
6031 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006034 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006035 * "interrupted" (if not NULL) is set to TRUE when no character is available
6036 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038#if defined(__BEOS__)
6039 int
6040#else
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006041 static int
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006043RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044{
6045 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006046 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006047#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 static int busy = FALSE;
6049
Bram Moolenaar0f873732019-12-05 20:28:46 +01006050 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051# define MAY_LOOP
6052
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006053# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006054 // Remember at what time we started, so that we know how much longer we
6055 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006056 long start_msec = msec;
6057 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006059 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006060 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061# endif
6062
Bram Moolenaar0f873732019-12-05 20:28:46 +01006063 // Handle being called recursively. This may happen for the session
6064 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 if (busy)
6066 return 0;
6067#endif
6068
6069#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006070 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071#endif
6072 {
6073#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006074 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006075# ifdef FEAT_MZSCHEME
6076 int mzquantum_used = FALSE;
6077# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078#endif
6079#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006080 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006081 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 int nfd;
6083# ifdef FEAT_XCLIPBOARD
6084 int xterm_idx = -1;
6085# endif
6086# ifdef FEAT_MOUSE_GPM
6087 int gpm_idx = -1;
6088# endif
6089# ifdef USE_XSMP
6090 int xsmp_idx = -1;
6091# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006092 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006094# ifdef FEAT_MZSCHEME
6095 mzvim_check_threads();
6096 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6097 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006098 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006099 mzquantum_used = TRUE;
6100 }
6101# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 fds[0].fd = fd;
6103 fds[0].events = POLLIN;
6104 nfd = 1;
6105
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006107 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 if (xterm_Shell != (Widget)0)
6109 {
6110 xterm_idx = nfd;
6111 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6112 fds[nfd].events = POLLIN;
6113 nfd++;
6114 }
6115# endif
6116# ifdef FEAT_MOUSE_GPM
6117 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6118 {
6119 gpm_idx = nfd;
6120 fds[nfd].fd = gpm_fd;
6121 fds[nfd].events = POLLIN;
6122 nfd++;
6123 }
6124# endif
6125# ifdef USE_XSMP
6126 if (xsmp_icefd != -1)
6127 {
6128 xsmp_idx = nfd;
6129 fds[nfd].fd = xsmp_icefd;
6130 fds[nfd].events = POLLIN;
6131 nfd++;
6132 }
6133# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006134#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006135 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006136#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006137 if (interrupted != NULL)
6138 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006140 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006141
6142 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006143 if (result == 0 && interrupted != NULL && ret > 0)
6144 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006145
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006146# ifdef FEAT_MZSCHEME
6147 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006148 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006149 finished = FALSE;
6150# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152# ifdef FEAT_XCLIPBOARD
6153 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6154 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006155 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006157 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 finished = FALSE;
6159 }
6160# endif
6161# ifdef FEAT_MOUSE_GPM
6162 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164# endif
6165# ifdef USE_XSMP
6166 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6167 {
6168 if (fds[xsmp_idx].revents & POLLIN)
6169 {
6170 busy = TRUE;
6171 xsmp_handle_requests();
6172 busy = FALSE;
6173 }
6174 else if (fds[xsmp_idx].revents & POLLHUP)
6175 {
6176 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006177 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 xsmp_close();
6179 }
6180 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006181 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 }
6183# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006184#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006185 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006186 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006187 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006188#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189
Bram Moolenaar0f873732019-12-05 20:28:46 +01006190#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191
6192 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006193 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006194 // These are static because they can take 8 Kbyte each and cause the
6195 // signal stack to run out with -O3.
6196 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006198 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006200# ifdef FEAT_MZSCHEME
6201 mzvim_check_threads();
6202 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6203 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006204 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006205 mzquantum_used = TRUE;
6206 }
6207# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006209 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006211 tv.tv_sec = towait / 1000;
6212 tv.tv_usec = (towait % 1000) * (1000000/1000);
6213 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006215 else
6216 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217
6218 /*
6219 * Select on ready for reading and exceptional condition (end of file).
6220 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006221select_eintr:
6222 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006223 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 FD_ZERO(&efds);
6225 FD_SET(fd, &rfds);
6226# if !defined(__QNX__) && !defined(__CYGWIN32__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006227 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 FD_SET(fd, &efds);
6229# endif
6230 maxfd = fd;
6231
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006233 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 if (xterm_Shell != (Widget)0)
6235 {
6236 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6237 if (maxfd < ConnectionNumber(xterm_dpy))
6238 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006239
Bram Moolenaar0f873732019-12-05 20:28:46 +01006240 // An event may have already been read but not handled. In
6241 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006242 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 }
6244# endif
6245# ifdef FEAT_MOUSE_GPM
6246 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6247 {
6248 FD_SET(gpm_fd, &rfds);
6249 FD_SET(gpm_fd, &efds);
6250 if (maxfd < gpm_fd)
6251 maxfd = gpm_fd;
6252 }
6253# endif
6254# ifdef USE_XSMP
6255 if (xsmp_icefd != -1)
6256 {
6257 FD_SET(xsmp_icefd, &rfds);
6258 FD_SET(xsmp_icefd, &efds);
6259 if (maxfd < xsmp_icefd)
6260 maxfd = xsmp_icefd;
6261 }
6262# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006263# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006264 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006265# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006266 if (interrupted != NULL)
6267 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268
Bram Moolenaar643b6142018-09-12 20:29:09 +02006269 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6270 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006271 result = ret > 0 && FD_ISSET(fd, &rfds);
6272 if (result)
6273 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006274 else if (interrupted != NULL && ret > 0)
6275 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006276
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006277# ifdef EINTR
6278 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006279 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006280 // Check whether window has been resized, EINTR may be caused by
6281 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006282 if (do_resize)
6283 handle_resize();
6284
Bram Moolenaar0f873732019-12-05 20:28:46 +01006285 // Interrupted by a signal, need to try again. We ignore msec
6286 // here, because we do want to check even after a timeout if
6287 // characters are available. Needed for reading output of an
6288 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006289 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006290 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006291# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006292# ifdef __TANDEM
6293 if (ret == -1 && errno == ENOTSUP)
6294 {
6295 FD_ZERO(&rfds);
6296 FD_ZERO(&efds);
6297 ret = 0;
6298 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006299# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006300# ifdef FEAT_MZSCHEME
6301 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006302 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006303 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304# endif
6305
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306# ifdef FEAT_XCLIPBOARD
6307 if (ret > 0 && xterm_Shell != (Widget)0
6308 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6309 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006310 xterm_update(); // Maybe we should hand out clipboard
6311 // continue looping when we only got the X event and the input
6312 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 if (--ret == 0 && !input_available())
6314 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006315 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 finished = FALSE;
6317 }
6318 }
6319# endif
6320# ifdef FEAT_MOUSE_GPM
6321 if (ret > 0 && gpm_flag && check_for_gpm != NULL && gpm_fd >= 0)
6322 {
6323 if (FD_ISSET(gpm_fd, &efds))
6324 gpm_close();
6325 else if (FD_ISSET(gpm_fd, &rfds))
6326 *check_for_gpm = 1;
6327 }
6328# endif
6329# ifdef USE_XSMP
6330 if (ret > 0 && xsmp_icefd != -1)
6331 {
6332 if (FD_ISSET(xsmp_icefd, &efds))
6333 {
6334 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006335 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 xsmp_close();
6337 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006338 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 }
6340 else if (FD_ISSET(xsmp_icefd, &rfds))
6341 {
6342 busy = TRUE;
6343 xsmp_handle_requests();
6344 busy = FALSE;
6345 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006346 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 }
6348 }
6349# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006350#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006351 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006352 if (ret >= 0)
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006353 ret = channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006354#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355
Bram Moolenaar0f873732019-12-05 20:28:46 +01006356#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357
6358#ifdef MAY_LOOP
6359 if (finished || msec == 0)
6360 break;
6361
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006362# ifdef FEAT_CLIENTSERVER
6363 if (server_waiting())
6364 break;
6365# endif
6366
Bram Moolenaar0f873732019-12-05 20:28:46 +01006367 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 if (msec > 0)
6369 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006370# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006371 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006372 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006374 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 msec = msec / 2;
6376# endif
6377 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006378 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 }
6380#endif
6381 }
6382
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006383 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384}
6385
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006387 * Expand a path into all matching files and/or directories. Handles "*",
6388 * "?", "[a-z]", "**", etc.
6389 * "path" has backslashes before chars that are not to be expanded.
6390 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 */
6392 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006393mch_expandpath(
6394 garray_T *gap,
6395 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006396 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397{
Bram Moolenaar02743632005-07-25 20:42:36 +00006398 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400
6401/*
6402 * mch_expand_wildcards() - this code does wild-card pattern matching using
6403 * the shell
6404 *
6405 * return OK for success, FAIL for error (you may lose some memory) and put
6406 * an error message in *file.
6407 *
6408 * num_pat is number of input patterns
6409 * pat is array of pointers to input patterns
6410 * num_file is pointer to number of matched file names
6411 * file is pointer to array of pointers to matched file names
6412 */
6413
6414#ifndef SEEK_SET
6415# define SEEK_SET 0
6416#endif
6417#ifndef SEEK_END
6418# define SEEK_END 2
6419#endif
6420
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006421#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006422
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006424mch_expand_wildcards(
6425 int num_pat,
6426 char_u **pat,
6427 int *num_file,
6428 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006429 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430{
6431 int i;
6432 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006433 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 char_u *p;
6435 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436
Bram Moolenaarc7247912008-01-13 12:54:11 +00006437 /*
6438 * This is the non-OS/2 implementation (really Unix).
6439 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 int j;
6441 char_u *tempname;
6442 char_u *command;
6443 FILE *fd;
6444 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006445#define STYLE_ECHO 0 // use "echo", the default
6446#define STYLE_GLOB 1 // use "glob", for csh
6447#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6448#define STYLE_PRINT 3 // use "print -N", for zsh
6449#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6450 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 int shell_style = STYLE_ECHO;
6452 int check_spaces;
6453 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006454 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006455 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006456 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457
Bram Moolenaar0f873732019-12-05 20:28:46 +01006458 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 *file = NULL;
6460
6461 /*
6462 * If there are no wildcards, just copy the names to allocated memory.
6463 * Saves a lot of time, because we don't have to start a new shell.
6464 */
6465 if (!have_wildcard(num_pat, pat))
6466 return save_patterns(num_pat, pat, num_file, file);
6467
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006468# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006469 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006470 if (sandbox != 0 && check_secure())
6471 return FAIL;
6472# endif
6473
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 /*
6475 * Don't allow the use of backticks in secure and restricted mode.
6476 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006477 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 for (i = 0; i < num_pat; ++i)
6479 if (vim_strchr(pat[i], '`') != NULL
6480 && (check_restricted() || check_secure()))
6481 return FAIL;
6482
6483 /*
6484 * get a name for the temp file
6485 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006486 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006488 emsg(_(e_notmp));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 return FAIL;
6490 }
6491
6492 /*
6493 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006494 * file.
6495 * STYLE_BT: NL separated
6496 * If expanding `cmd` execute it directly.
6497 * STYLE_GLOB: NUL separated
6498 * If we use *csh, "glob" will work better than "echo".
6499 * STYLE_PRINT: NL or NUL separated
6500 * If we use *zsh, "print -N" will work better than "glob".
6501 * STYLE_VIMGLOB: NL separated
6502 * If we use *sh*, we define "vimglob()".
6503 * STYLE_ECHO: space separated.
6504 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 */
6506 if (num_pat == 1 && *pat[0] == '`'
6507 && (len = STRLEN(pat[0])) > 2
6508 && *(pat[0] + len - 1) == '`')
6509 shell_style = STYLE_BT;
6510 else if ((len = STRLEN(p_sh)) >= 3)
6511 {
6512 if (STRCMP(p_sh + len - 3, "csh") == 0)
6513 shell_style = STYLE_GLOB;
6514 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6515 shell_style = STYLE_PRINT;
6516 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006517 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6518 "sh") != NULL)
6519 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520
Bram Moolenaar0f873732019-12-05 20:28:46 +01006521 // Compute the length of the command. We need 2 extra bytes: for the
6522 // optional '&' and for the NUL.
6523 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006525 if (shell_style == STYLE_VIMGLOB)
6526 len += STRLEN(sh_vimglob_func);
6527
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006528 for (i = 0; i < num_pat; ++i)
6529 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006530 // Count the length of the patterns in the same way as they are put in
6531 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006532#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006533 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006534#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006535 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006536 for (j = 0; pat[i][j] != NUL; ++j)
6537 {
6538 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006539 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006540 ++len;
6541 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006542#endif
6543 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 command = alloc(len);
6545 if (command == NULL)
6546 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006547 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 vim_free(tempname);
6549 return FAIL;
6550 }
6551
6552 /*
6553 * Build the shell command:
6554 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6555 * recognizes this).
6556 * - Add the shell command to print the expanded names.
6557 * - Add the temp file name.
6558 * - Add the file name patterns.
6559 */
6560 if (shell_style == STYLE_BT)
6561 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006562 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006563 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006564 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006566 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006567 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006569 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006571 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 *p = ' ';
6573 }
6574 STRCAT(command, ">");
6575 }
6576 else
6577 {
6578 if (flags & EW_NOTFOUND)
6579 STRCPY(command, "set nonomatch; ");
6580 else
6581 STRCPY(command, "unset nonomatch; ");
6582 if (shell_style == STYLE_GLOB)
6583 STRCAT(command, "glob >");
6584 else if (shell_style == STYLE_PRINT)
6585 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006586 else if (shell_style == STYLE_VIMGLOB)
6587 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 else
6589 STRCAT(command, "echo >");
6590 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006591
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006593
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 if (shell_style != STYLE_BT)
6595 for (i = 0; i < num_pat; ++i)
6596 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006597 // When using system() always add extra quotes, because the shell
6598 // is started twice. Otherwise put a backslash before special
6599 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600#ifdef USE_SYSTEM
6601 STRCAT(command, " \"");
6602 STRCAT(command, pat[i]);
6603 STRCAT(command, "\"");
6604#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006605 int intick = FALSE;
6606
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 p = command + STRLEN(command);
6608 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006609 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006610 {
6611 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006612 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006613 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6614 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006615 // Remove a backslash, take char literally. But keep
6616 // backslash inside backticks, before a special character
6617 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006618 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006619 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6620 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006621 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006622 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006623 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006624 else if (!intick
6625 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6626 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006627 // Put a backslash before a special character, but not
6628 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6629 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006630 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006631
Bram Moolenaar0f873732019-12-05 20:28:46 +01006632 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006633 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006634 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 *p = NUL;
6636#endif
6637 }
6638 if (flags & EW_SILENT)
6639 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006640 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006641 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642
6643 /*
6644 * Using zsh -G: If a pattern has no matches, it is just deleted from
6645 * the argument list, otherwise zsh gives an error message and doesn't
6646 * expand any other pattern.
6647 */
6648 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006649 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650
6651 /*
6652 * If we use -f then shell variables set in .cshrc won't get expanded.
6653 * vi can do it, so we will too, but it is only necessary if there is a "$"
6654 * in one of the patterns, otherwise we can still use the fast option.
6655 */
6656 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006657 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658
6659 /*
6660 * execute the shell command
6661 */
6662 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6663
Bram Moolenaar0f873732019-12-05 20:28:46 +01006664 // When running in the background, give it some time to create the temp
6665 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006666 if (ampersand)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 mch_delay(10L, TRUE);
6668
Bram Moolenaar0f873732019-12-05 20:28:46 +01006669 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 show_shell_mess = TRUE;
6671 vim_free(command);
6672
Bram Moolenaar0f873732019-12-05 20:28:46 +01006673 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 {
6675 mch_remove(tempname);
6676 vim_free(tempname);
6677 /*
6678 * With interactive completion, the error message is not printed.
6679 * However with USE_SYSTEM, I don't know how to turn off error messages
6680 * from the shell, so screen may still get messed up -- webb.
6681 */
6682#ifndef USE_SYSTEM
6683 if (!(flags & EW_SILENT))
6684#endif
6685 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006686 redraw_later_clear(); // probably messed up screen
6687 msg_putchar('\n'); // clear bottom line quickly
6688 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689#ifdef USE_SYSTEM
6690 if (!(flags & EW_SILENT))
6691#endif
6692 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006693 msg(_(e_wildexpand));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006694 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 }
6696 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006697 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6698 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 if (shell_style == STYLE_BT)
6700 return FAIL;
6701 goto notfound;
6702 }
6703
6704 /*
6705 * read the names from the file into memory
6706 */
6707 fd = fopen((char *)tempname, READBIN);
6708 if (fd == NULL)
6709 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006710 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 if (!(flags & EW_SILENT))
6712 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006713 msg(_(e_wildexpand));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006714 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 }
6716 vim_free(tempname);
6717 goto notfound;
6718 }
6719 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006720 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006722 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006723 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006724 buffer = NULL;
6725 else
6726 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 if (buffer == NULL)
6728 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006729 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 mch_remove(tempname);
6731 vim_free(tempname);
6732 fclose(fd);
6733 return FAIL;
6734 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006735 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 i = fread((char *)buffer, 1, len, fd);
6737 fclose(fd);
6738 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006739 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006741 // unexpected read error
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006742 semsg(_(e_notread), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 vim_free(tempname);
6744 vim_free(buffer);
6745 return FAIL;
6746 }
6747 vim_free(tempname);
6748
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006749# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006750 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006752 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6754 *p++ = buffer[i];
6755 len = p - buffer;
6756# endif
6757
6758
Bram Moolenaar0f873732019-12-05 20:28:46 +01006759 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 if (shell_style == STYLE_ECHO)
6761 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006762 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006764 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 {
6766 while (*p != ' ' && *p != '\n')
6767 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006768 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 }
6770 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006771 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006772 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006774 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006776 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 {
6778 while (*p != '\n' && *p != NUL)
6779 ++p;
6780 if (*p != NUL)
6781 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006782 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 }
6784 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006785 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 else
6787 {
6788 /*
6789 * Some versions of zsh use spaces instead of NULs to separate
6790 * results. Only do this when there is no NUL before the end of the
6791 * buffer, otherwise we would never be able to use file names with
6792 * embedded spaces when zsh does use NULs.
6793 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6794 * don't check for spaces again.
6795 */
6796 check_spaces = FALSE;
6797 if (shell_style == STYLE_PRINT && !did_find_nul)
6798 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006799 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006800 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006801 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 did_find_nul = TRUE;
6803 else
6804 check_spaces = TRUE;
6805 }
6806
6807 /*
6808 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6809 * already is one, for STYLE_GLOB it needs to be added.
6810 */
6811 if (len && buffer[len - 1] == NUL)
6812 --len;
6813 else
6814 buffer[len] = NUL;
6815 i = 0;
6816 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006817 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 {
6819 ++i;
6820 *p = NUL;
6821 }
6822 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006823 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 }
6825 if (i == 0)
6826 {
6827 /*
6828 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6829 * /bin/sh will happily expand it to nothing rather than returning an
6830 * error; and hey, it's good to check anyway -- webb.
6831 */
6832 vim_free(buffer);
6833 goto notfound;
6834 }
6835 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006836 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 if (*file == NULL)
6838 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006839 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 vim_free(buffer);
6841 return FAIL;
6842 }
6843
6844 /*
6845 * Isolate the individual file names.
6846 */
6847 p = buffer;
6848 for (i = 0; i < *num_file; ++i)
6849 {
6850 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006851 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00006852 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
6853 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00006855 while (!(shell_style == STYLE_ECHO && *p == ' ')
6856 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006858 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 *p = NUL;
6860 else
6861 {
6862 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006863 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 }
6865 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006866 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006868 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006870 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 }
6872 }
6873
6874 /*
6875 * Move the file names to allocated memory.
6876 */
6877 for (j = 0, i = 0; i < *num_file; ++i)
6878 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006879 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
6881 continue;
6882
Bram Moolenaar0f873732019-12-05 20:28:46 +01006883 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 dir = (mch_isdir((*file)[i]));
6885 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
6886 continue;
6887
Bram Moolenaar0f873732019-12-05 20:28:46 +01006888 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01006889 if (!dir && (flags & EW_EXEC)
6890 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00006891 continue;
6892
Bram Moolenaar964b3742019-05-24 18:54:09 +02006893 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 if (p)
6895 {
6896 STRCPY(p, (*file)[i]);
6897 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006898 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 (*file)[j++] = p;
6900 }
6901 }
6902 vim_free(buffer);
6903 *num_file = j;
6904
Bram Moolenaar0f873732019-12-05 20:28:46 +01006905 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01006907 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 goto notfound;
6909 }
6910
6911 return OK;
6912
6913notfound:
6914 if (flags & EW_NOTFOUND)
6915 return save_patterns(num_pat, pat, num_file, file);
6916 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917}
6918
Bram Moolenaar0f873732019-12-05 20:28:46 +01006919#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01006922save_patterns(
6923 int num_pat,
6924 char_u **pat,
6925 int *num_file,
6926 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927{
6928 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00006929 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006931 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 if (*file == NULL)
6933 return FAIL;
6934 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00006935 {
6936 s = vim_strsave(pat[i]);
6937 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006938 // Be compatible with expand_filename(): halve the number of
6939 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00006940 backslash_halve(s);
6941 (*file)[i] = s;
6942 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 *num_file = num_pat;
6944 return OK;
6945}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947/*
6948 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
6949 * expand.
6950 */
6951 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006952mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006954 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 if (*p == '\\' && p[1] != NUL)
6957 ++p;
6958 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 if (vim_strchr((char_u *)
6960#ifdef VMS
6961 "*?%"
6962#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964#endif
6965 , *p) != NULL)
6966 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 }
6968 return FALSE;
6969}
6970
6971/*
6972 * Return TRUE if the string "p" contains a wildcard.
6973 * Don't recognize '~' at the end as a wildcard.
6974 */
6975 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006976mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006978 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 if (*p == '\\' && p[1] != NUL)
6981 ++p;
6982 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 if (vim_strchr((char_u *)
6984#ifdef VMS
6985 "*?%$"
6986#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988#endif
6989 , *p) != NULL
6990 || (*p == '~' && p[1] != NUL))
6991 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 }
6993 return FALSE;
6994}
6995
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01006997have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998{
6999 int i;
7000
7001 for (i = 0; i < num; i++)
7002 if (mch_has_wildcard(file[i]))
7003 return 1;
7004 return 0;
7005}
7006
7007 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007008have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009{
7010 int i;
7011
7012 for (i = 0; i < num; i++)
7013 if (vim_strchr(file[i], '$') != NULL)
7014 return TRUE;
7015 return FALSE;
7016}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007018#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019/*
7020 * Scaled-down version of rename(), which is missing in Xenix.
7021 * This version can only move regular files and will fail if the
7022 * destination exists.
7023 */
7024 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007025mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026{
7027 struct stat st;
7028
Bram Moolenaar0f873732019-12-05 20:28:46 +01007029 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007031 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007033 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 return 0;
7035 return -1;
7036}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007037#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007039#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040/*
7041 * Initializes connection with gpm (if it isn't already opened)
7042 * Return 1 if succeeded (or connection already opened), 0 if failed
7043 */
7044 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007045gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007047 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048
7049 if (!gpm_flag)
7050 {
7051 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7052 gpm_connect.defaultMask = ~GPM_HARD;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007053 // Default handling for mouse move
7054 gpm_connect.minMod = 0; // Handle any modifier keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 gpm_connect.maxMod = 0xffff;
7056 if (Gpm_Open(&gpm_connect, 0) > 0)
7057 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007058 // gpm library tries to handling TSTP causes
7059 // problems. Anyways, we close connection to Gpm whenever
7060 // we are going to suspend or starting an external process
7061 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007062# ifdef SIGTSTP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 signal(SIGTSTP, restricted ? SIG_IGN : SIG_DFL);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007064# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007065 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 }
7067 if (gpm_fd == -2)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007068 Gpm_Close(); // We don't want to talk to xterm via gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 return 0;
7070 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007071 return 1; // already open
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072}
7073
7074/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007075 * Returns TRUE if the GPM mouse is enabled.
7076 */
7077 int
7078gpm_enabled(void)
7079{
7080 return gpm_flag && gpm_fd >= 0;
7081}
7082
7083/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 */
7086 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007087gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007089 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 Gpm_Close();
7091}
7092
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007093/*
7094 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007096 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 */
7098 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007099mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100{
7101 int button;
7102 static Gpm_Event gpm_event;
7103 char_u string[6];
7104 int_u vim_modifiers;
7105 int row,col;
7106 unsigned char buttons_mask;
7107 unsigned char gpm_modifiers;
7108 static unsigned char old_buttons = 0;
7109
7110 Gpm_GetEvent(&gpm_event);
7111
7112#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007113 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 if (hold_gui_events)
7115 return 0;
7116#endif
7117
7118 row = gpm_event.y - 1;
7119 col = gpm_event.x - 1;
7120
Bram Moolenaar0f873732019-12-05 20:28:46 +01007121 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 string[1] = 'M';
7123 string[2] = 'G';
7124 switch (GPM_BARE_EVENTS(gpm_event.type))
7125 {
7126 case GPM_DRAG:
7127 string[3] = MOUSE_DRAG;
7128 break;
7129 case GPM_DOWN:
7130 buttons_mask = gpm_event.buttons & ~old_buttons;
7131 old_buttons = gpm_event.buttons;
7132 switch (buttons_mask)
7133 {
7134 case GPM_B_LEFT:
7135 button = MOUSE_LEFT;
7136 break;
7137 case GPM_B_MIDDLE:
7138 button = MOUSE_MIDDLE;
7139 break;
7140 case GPM_B_RIGHT:
7141 button = MOUSE_RIGHT;
7142 break;
7143 default:
7144 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007145 // Don't know what to do. Can more than one button be
7146 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 }
7148 string[3] = (char_u)(button | 0x20);
7149 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7150 break;
7151 case GPM_UP:
7152 string[3] = MOUSE_RELEASE;
7153 old_buttons &= ~gpm_event.buttons;
7154 break;
7155 default:
7156 return 0;
7157 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007158 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 gpm_modifiers = gpm_event.modifiers;
7160 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007161 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7162 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7163 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7165 vim_modifiers |= MOUSE_SHIFT;
7166
7167 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7168 vim_modifiers |= MOUSE_CTRL;
7169 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7170 vim_modifiers |= MOUSE_ALT;
7171 string[3] |= vim_modifiers;
7172 string[4] = (char_u)(col + ' ' + 1);
7173 string[5] = (char_u)(row + ' ' + 1);
7174 add_to_input_buf(string, 6);
7175 return 6;
7176}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007177#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007179#ifdef FEAT_SYSMOUSE
7180/*
7181 * Initialize connection with sysmouse.
7182 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7183 * output, any sysmouse output than will be processed via sig_sysmouse().
7184 * Return OK if succeeded, FAIL if failed.
7185 */
7186 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007187sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007188{
7189 struct mouse_info mouse;
7190
7191 mouse.operation = MOUSE_MODE;
7192 mouse.u.mode.mode = 0;
7193 mouse.u.mode.signal = SIGUSR2;
7194 if (ioctl(1, CONS_MOUSECTL, &mouse) != -1)
7195 {
7196 signal(SIGUSR2, (RETSIGTYPE (*)())sig_sysmouse);
7197 mouse.operation = MOUSE_SHOW;
7198 ioctl(1, CONS_MOUSECTL, &mouse);
7199 return OK;
7200 }
7201 return FAIL;
7202}
7203
7204/*
7205 * Stop processing SIGUSR2 signals, and also make sure that
7206 * virtual console do not send us any sysmouse related signal.
7207 */
7208 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007209sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007210{
7211 struct mouse_info mouse;
7212
7213 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7214 mouse.operation = MOUSE_MODE;
7215 mouse.u.mode.mode = 0;
7216 mouse.u.mode.signal = 0;
7217 ioctl(1, CONS_MOUSECTL, &mouse);
7218}
7219
7220/*
7221 * Gets info from sysmouse and adds special keys to input buf.
7222 */
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007223 static RETSIGTYPE
7224sig_sysmouse SIGDEFARG(sigarg)
7225{
7226 struct mouse_info mouse;
7227 struct video_info video;
7228 char_u string[6];
7229 int row, col;
7230 int button;
7231 int buttons;
7232 static int oldbuttons = 0;
7233
7234#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007235 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007236 if (hold_gui_events)
7237 return;
7238#endif
7239
7240 mouse.operation = MOUSE_GETINFO;
7241 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7242 && ioctl(1, FBIO_MODEINFO, &video) != -1
7243 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7244 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7245 {
7246 row = mouse.u.data.y / video.vi_cheight;
7247 col = mouse.u.data.x / video.vi_cwidth;
7248 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007249 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007250 string[1] = 'M';
7251 string[2] = 'S';
7252 if (oldbuttons == buttons && buttons != 0)
7253 {
7254 button = MOUSE_DRAG;
7255 }
7256 else
7257 {
7258 switch (buttons)
7259 {
7260 case 0:
7261 button = MOUSE_RELEASE;
7262 break;
7263 case 1:
7264 button = MOUSE_LEFT;
7265 break;
7266 case 2:
7267 button = MOUSE_MIDDLE;
7268 break;
7269 case 4:
7270 button = MOUSE_RIGHT;
7271 break;
7272 default:
7273 return;
7274 }
7275 oldbuttons = buttons;
7276 }
7277 string[3] = (char_u)(button);
7278 string[4] = (char_u)(col + ' ' + 1);
7279 string[5] = (char_u)(row + ' ' + 1);
7280 add_to_input_buf(string, 6);
7281 }
7282 return;
7283}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007284#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007285
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007287typedef char_u * (*STRPROCSTR)(char_u *);
7288typedef char_u * (*INTPROCSTR)(int);
7289typedef int (*STRPROCINT)(char_u *);
7290typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291
7292/*
7293 * Call a DLL routine which takes either a string or int param
7294 * and returns an allocated string.
7295 */
7296 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007297mch_libcall(
7298 char_u *libname,
7299 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007300 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007301 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007302 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007303 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304{
7305# if defined(USE_DLOPEN)
7306 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007307 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308# else
7309 shl_t hinstLib;
7310# endif
7311 STRPROCSTR ProcAdd;
7312 INTPROCSTR ProcAddI;
7313 char_u *retval_str = NULL;
7314 int retval_int = 0;
7315 int success = FALSE;
7316
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007317 /*
7318 * Get a handle to the DLL module.
7319 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007321 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007322 (void)dlerror();
7323
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 hinstLib = dlopen((char *)libname, RTLD_LAZY
7325# ifdef RTLD_LOCAL
7326 | RTLD_LOCAL
7327# endif
7328 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007329 if (hinstLib == NULL)
7330 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007331 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007332 dlerr = (char *)dlerror();
7333 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007334 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007335 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336# else
7337 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7338# endif
7339
Bram Moolenaar0f873732019-12-05 20:28:46 +01007340 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 if (hinstLib != NULL)
7342 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007343# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 /*
7345 * Catch a crash when calling the library function. For example when
7346 * using a number where a string pointer is expected.
7347 */
7348 mch_startjmp();
7349 if (SETJMP(lc_jump_env) != 0)
7350 {
7351 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007352# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007353 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007354# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 mch_didjmp();
7356 }
7357 else
7358# endif
7359 {
7360 retval_str = NULL;
7361 retval_int = 0;
7362
7363 if (argstring != NULL)
7364 {
7365# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007366 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007367 dlerr = (char *)dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368# else
7369 if (shl_findsym(&hinstLib, (const char *)funcname,
7370 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7371 ProcAdd = NULL;
7372# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007373 if ((success = (ProcAdd != NULL
7374# if defined(USE_DLOPEN)
7375 && dlerr == NULL
7376# endif
7377 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 {
7379 if (string_result == NULL)
7380 retval_int = ((STRPROCINT)ProcAdd)(argstring);
7381 else
7382 retval_str = (ProcAdd)(argstring);
7383 }
7384 }
7385 else
7386 {
7387# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007388 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007389 dlerr = (char *)dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390# else
7391 if (shl_findsym(&hinstLib, (const char *)funcname,
7392 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7393 ProcAddI = NULL;
7394# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007395 if ((success = (ProcAddI != NULL
7396# if defined(USE_DLOPEN)
7397 && dlerr == NULL
7398# endif
7399 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 {
7401 if (string_result == NULL)
7402 retval_int = ((INTPROCINT)ProcAddI)(argint);
7403 else
7404 retval_str = (ProcAddI)(argint);
7405 }
7406 }
7407
Bram Moolenaar0f873732019-12-05 20:28:46 +01007408 // Save the string before we free the library.
7409 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 if (string_result == NULL)
7411 *number_result = retval_int;
7412 else if (retval_str != NULL
7413 && retval_str != (char_u *)1
7414 && retval_str != (char_u *)-1)
7415 *string_result = vim_strsave(retval_str);
7416 }
7417
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007418# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 mch_endjmp();
7420# ifdef SIGHASARG
7421 if (lc_signal != 0)
7422 {
7423 int i;
7424
Bram Moolenaar0f873732019-12-05 20:28:46 +01007425 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 for (i = 0; signal_info[i].sig != -1; i++)
7427 if (lc_signal == signal_info[i].sig)
7428 break;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007429 semsg("E368: got SIG%s in libcall()", signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 }
7431# endif
7432# endif
7433
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007435 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007436 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007437 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007438
Bram Moolenaar0f873732019-12-05 20:28:46 +01007439 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 (void)dlclose(hinstLib);
7441# else
7442 (void)shl_unload(hinstLib);
7443# endif
7444 }
7445
7446 if (!success)
7447 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007448 semsg(_(e_libcall), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 return FAIL;
7450 }
7451
7452 return OK;
7453}
7454#endif
7455
7456#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007457static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458static int xterm_button;
7459
7460/*
7461 * Setup a dummy window for X selections in a terminal.
7462 */
7463 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007464setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465{
7466 int z = 0;
7467 char *strp = "";
7468 Widget AppShell;
7469
7470 if (!x_connect_to_server())
7471 return;
7472
7473 open_app_context();
7474 if (app_context != NULL && xterm_Shell == (Widget)0)
7475 {
7476 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007477# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007479# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007480# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007481 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482
7483 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007484 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485# endif
7486
Bram Moolenaar0f873732019-12-05 20:28:46 +01007487 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 oldhandler = XSetErrorHandler(x_error_check);
7489
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007490# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007491 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7493 mch_startjmp();
7494 if (SETJMP(lc_jump_env) != 0)
7495 {
7496 mch_didjmp();
7497 xterm_dpy = NULL;
7498 }
7499 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007500# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 {
7502 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7503 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007504 if (xterm_dpy != NULL)
7505 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007506# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007508# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 }
7510
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007511# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007512 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007514# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007515 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 (void)XSetErrorHandler(oldhandler);
7517
7518 if (xterm_dpy == NULL)
7519 {
7520 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007521 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 return;
7523 }
7524
Bram Moolenaar0f873732019-12-05 20:28:46 +01007525 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 (void)XSetIOErrorHandler(x_IOerror_handler);
7527
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007528# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007530 {
7531 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007532 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007533 verbose_leave();
7534 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535# endif
7536
Bram Moolenaar0f873732019-12-05 20:28:46 +01007537 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7539 applicationShellWidgetClass, xterm_dpy,
7540 NULL);
7541 if (AppShell == (Widget)0)
7542 return;
7543 xterm_Shell = XtVaCreatePopupShell("VIM",
7544 topLevelShellWidgetClass, AppShell,
7545 XtNmappedWhenManaged, 0,
7546 XtNwidth, 1,
7547 XtNheight, 1,
7548 NULL);
7549 if (xterm_Shell == (Widget)0)
7550 return;
7551
7552 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007553 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 if (x11_display == NULL)
7555 x11_display = xterm_dpy;
7556
7557 XtRealizeWidget(xterm_Shell);
7558 XSync(xterm_dpy, False);
7559 xterm_update();
7560 }
7561 if (xterm_Shell != (Widget)0)
7562 {
7563 clip_init(TRUE);
7564 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7565 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007566 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 if (test_x11_window(xterm_dpy) == FAIL)
7568 x11_window = 0;
7569 if (x11_window != 0)
7570 xterm_trace = 0;
7571 }
7572}
7573
7574 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007575start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576{
7577 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7578 return;
7579 xterm_trace = 1;
7580 xterm_button = button;
7581 do_xterm_trace();
7582}
7583
7584
7585 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007586stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587{
7588 if (xterm_trace < 0)
7589 return;
7590 xterm_trace = 0;
7591}
7592
7593/*
7594 * Query the xterm pointer and generate mouse termcodes if necessary
7595 * return TRUE if dragging is active, else FALSE
7596 */
7597 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007598do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599{
7600 Window root, child;
7601 int root_x, root_y;
7602 int win_x, win_y;
7603 int row, col;
7604 int_u mask_return;
7605 char_u buf[50];
7606 char_u *strp;
7607 long got_hints;
7608 static char_u *mouse_code;
7609 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7610 static int prev_row = 0, prev_col = 0;
7611 static XSizeHints xterm_hints;
7612
7613 if (xterm_trace <= 0)
7614 return FALSE;
7615
7616 if (xterm_trace == 1)
7617 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007618 // Get the hints just before tracking starts. The font size might
7619 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007620 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7621 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 || xterm_hints.width_inc <= 1
7623 || xterm_hints.height_inc <= 1)
7624 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007625 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 return FALSE;
7627 }
7628
Bram Moolenaar0f873732019-12-05 20:28:46 +01007629 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 mouse_code = find_termcode(mouse_name);
7631 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007632 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 xterm_trace = 2;
7634
Bram Moolenaar0f873732019-12-05 20:28:46 +01007635 // Find the offset of the chars, there might be a scrollbar on the
7636 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7638 &win_x, &win_y, &mask_return);
7639 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7640 - (xterm_hints.height_inc / 2);
7641 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7642 xterm_hints.y = 2;
7643 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7644 - (xterm_hints.width_inc / 2);
7645 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7646 xterm_hints.x = 2;
7647 return TRUE;
7648 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007649 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 {
7651 xterm_trace = 0;
7652 return FALSE;
7653 }
7654
7655 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7656 &win_x, &win_y, &mask_return);
7657
7658 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7659 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7660 if (row == prev_row && col == prev_col)
7661 return TRUE;
7662
7663 STRCPY(buf, mouse_code);
7664 strp = buf + STRLEN(buf);
7665 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7666 *strp++ = (char_u)(col + ' ' + 1);
7667 *strp++ = (char_u)(row + ' ' + 1);
7668 *strp = 0;
7669 add_to_input_buf(buf, STRLEN(buf));
7670
7671 prev_row = row;
7672 prev_col = col;
7673 return TRUE;
7674}
7675
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007676# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677/*
7678 * Destroy the display, window and app_context. Required for GTK.
7679 */
7680 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007681clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682{
7683 if (xterm_Shell != (Widget)0)
7684 {
7685 XtDestroyWidget(xterm_Shell);
7686 xterm_Shell = (Widget)0;
7687 }
7688 if (xterm_dpy != NULL)
7689 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007690# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007691 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007693# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 if (x11_display == xterm_dpy)
7695 x11_display = NULL;
7696 xterm_dpy = NULL;
7697 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007698# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 if (app_context != (XtAppContext)NULL)
7700 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007701 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 XtDestroyApplicationContext(app_context);
7703 app_context = (XtAppContext)NULL;
7704 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007705# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706}
7707# endif
7708
7709/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007710 * Catch up with GUI or X events.
7711 */
7712 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007713clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007714{
7715# ifdef FEAT_GUI
7716 if (gui.in_use)
7717 gui_mch_update();
7718 else
7719# endif
7720 if (xterm_Shell != (Widget)0)
7721 xterm_update();
7722}
7723
7724/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 * Catch up with any queued X events. This may put keyboard input into the
7726 * input buffer, call resize call-backs, trigger timers etc. If there is
7727 * nothing in the X event queue (& no timers pending), then we return
7728 * immediately.
7729 */
7730 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007731xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732{
7733 XEvent event;
7734
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007735 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007737 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007739 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007740 break;
7741
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007742 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007743 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007744 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007745 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007746#ifdef FEAT_CLIENTSERVER
7747 {
7748 XPropertyEvent *e = (XPropertyEvent *)&event;
7749
7750 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007752 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007753 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007755 XtDispatchEvent(&event);
7756 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007757 else
7758 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007759 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007760 XtAppProcessEvent(app_context, mask);
7761 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 }
7763}
7764
7765 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007766clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767{
7768 if (xterm_Shell != (Widget)0)
7769 return clip_x11_own_selection(xterm_Shell, cbd);
7770 return FAIL;
7771}
7772
7773 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007774clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775{
7776 if (xterm_Shell != (Widget)0)
7777 clip_x11_lose_selection(xterm_Shell, cbd);
7778}
7779
7780 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007781clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782{
7783 if (xterm_Shell != (Widget)0)
7784 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7785}
7786
7787 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007788clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789{
7790 clip_x11_set_selection(cbd);
7791}
7792#endif
7793
7794
7795#if defined(USE_XSMP) || defined(PROTO)
7796/*
7797 * Code for X Session Management Protocol.
7798 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799
7800# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801/*
7802 * This is our chance to ask the user if they want to save,
7803 * or abort the logout
7804 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007806xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807{
7808 cmdmod_T save_cmdmod;
7809 int cancel_shutdown = False;
7810
7811 save_cmdmod = cmdmod;
7812 cmdmod.confirm = TRUE;
Bram Moolenaar027387f2016-01-02 22:25:52 +01007813 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01007814 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 cancel_shutdown = True;
7816 cmdmod = save_cmdmod;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007817 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 out_flush();
7819
Bram Moolenaar0f873732019-12-05 20:28:46 +01007820 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 SmcInteractDone(smc_conn, cancel_shutdown);
7822
Bram Moolenaar0f873732019-12-05 20:28:46 +01007823 // Finish off
7824 // Only end save-yourself here if we're not cancelling shutdown;
7825 // we'll get a cancelled callback later in which we'll end it.
7826 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 if (!cancel_shutdown)
7828 {
7829 xsmp.save_yourself = False;
7830 SmcSaveYourselfDone(smc_conn, True);
7831 }
7832}
7833# endif
7834
7835/*
7836 * Callback that starts save-yourself.
7837 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007839xsmp_handle_save_yourself(
7840 SmcConn smc_conn,
7841 SmPointer client_data UNUSED,
7842 int save_type UNUSED,
7843 Bool shutdown,
7844 int interact_style UNUSED,
7845 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007847 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 if (xsmp.save_yourself)
7849 SmcSaveYourselfDone(smc_conn, True);
7850 xsmp.save_yourself = True;
7851 xsmp.shutdown = shutdown;
7852
Bram Moolenaar0f873732019-12-05 20:28:46 +01007853 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01007855 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856
7857 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007858 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859
7860# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007861 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007863 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 SmcInteractRequest(smc_conn, SmDialogError,
7865 xsmp_handle_interaction, client_data);
7866 else
7867# endif
7868 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007869 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 SmcSaveYourselfDone(smc_conn, True);
7871 xsmp.save_yourself = False;
7872 }
7873}
7874
7875
7876/*
7877 * Callback to warn us of imminent death.
7878 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007880xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881{
7882 xsmp_close();
7883
Bram Moolenaar0f873732019-12-05 20:28:46 +01007884 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 getout_preserve_modified(0);
7886}
7887
7888
7889/*
7890 * Callback to tell us that save-yourself has completed.
7891 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007893xsmp_save_complete(
7894 SmcConn smc_conn UNUSED,
7895 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896{
7897 xsmp.save_yourself = False;
7898}
7899
7900
7901/*
7902 * Callback to tell us that an instigated shutdown was cancelled
7903 * (maybe even by us)
7904 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007906xsmp_shutdown_cancelled(
7907 SmcConn smc_conn,
7908 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909{
7910 if (xsmp.save_yourself)
7911 SmcSaveYourselfDone(smc_conn, True);
7912 xsmp.save_yourself = False;
7913 xsmp.shutdown = False;
7914}
7915
7916
7917/*
7918 * Callback to tell us that a new ICE connection has been established.
7919 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007921xsmp_ice_connection(
7922 IceConn iceConn,
7923 IcePointer clientData UNUSED,
7924 Bool opening,
7925 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007927 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 if (opening)
7929 {
7930 xsmp_icefd = IceConnectionNumber(iceConn);
7931 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
7932 }
7933}
7934
7935
Bram Moolenaar0f873732019-12-05 20:28:46 +01007936// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007938xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939{
7940 Bool rep;
7941
7942 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
7943 == IceProcessMessagesIOError)
7944 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007945 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007947 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 xsmp_close();
7949 return FAIL;
7950 }
7951 else
7952 return OK;
7953}
7954
7955static int dummy;
7956
Bram Moolenaar0f873732019-12-05 20:28:46 +01007957// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 void
7959xsmp_init(void)
7960{
7961 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 SmcCallbacks smcallbacks;
7963#if 0
7964 SmPropValue smname;
7965 SmProp smnameprop;
7966 SmProp *smprops[1];
7967#endif
7968
7969 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007970 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971
7972 xsmp.save_yourself = xsmp.shutdown = False;
7973
Bram Moolenaar0f873732019-12-05 20:28:46 +01007974 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
7976 smcallbacks.save_yourself.client_data = NULL;
7977 smcallbacks.die.callback = xsmp_die;
7978 smcallbacks.die.client_data = NULL;
7979 smcallbacks.save_complete.callback = xsmp_save_complete;
7980 smcallbacks.save_complete.client_data = NULL;
7981 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
7982 smcallbacks.shutdown_cancelled.client_data = NULL;
7983
Bram Moolenaar0f873732019-12-05 20:28:46 +01007984 // Set up a watch on ICE connection creations. The "dummy" argument is
7985 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
7987 {
7988 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007989 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 return;
7991 }
7992
Bram Moolenaar0f873732019-12-05 20:28:46 +01007993 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 xsmp.smcconn = SmcOpenConnection(
7995 NULL,
7996 NULL,
7997 SmProtoMajor,
7998 SmProtoMinor,
7999 SmcSaveYourselfProcMask | SmcDieProcMask
8000 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8001 &smcallbacks,
8002 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008003 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008004 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 errorstring);
8006 if (xsmp.smcconn == NULL)
8007 {
8008 char errorreport[132];
Bram Moolenaar051b7822005-05-19 21:00:46 +00008009
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008011 {
8012 vim_snprintf(errorreport, sizeof(errorreport),
8013 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008014 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008015 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 return;
8017 }
8018 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8019
8020#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008021 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 smname.value = "vim";
8023 smname.length = 3;
8024 smnameprop.name = "SmProgram";
8025 smnameprop.type = "SmARRAY8";
8026 smnameprop.num_vals = 1;
8027 smnameprop.vals = &smname;
8028
8029 smprops[0] = &smnameprop;
8030 SmcSetProperties(xsmp.smcconn, 1, smprops);
8031#endif
8032}
8033
8034
Bram Moolenaar0f873732019-12-05 20:28:46 +01008035// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008037xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038{
8039 if (xsmp_icefd != -1)
8040 {
8041 SmcCloseConnection(xsmp.smcconn, 0, NULL);
Bram Moolenaar5a221812008-11-12 12:08:45 +00008042 if (xsmp.clientid != NULL)
8043 free(xsmp.clientid);
Bram Moolenaare8208012008-06-20 09:59:25 +00008044 xsmp.clientid = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 xsmp_icefd = -1;
8046 }
8047}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008048#endif // USE_XSMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049
8050
8051#ifdef EBCDIC
Bram Moolenaar0f873732019-12-05 20:28:46 +01008052// Translate character to its CTRL- value
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053char CtrlTable[] =
8054{
8055/* 00 - 5E */
8056 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8057 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8058 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8059 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8060 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8061 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8062/* ^ */ 0x1E,
8063/* - */ 0x1F,
8064/* 61 - 6C */
8065 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8066/* _ */ 0x1F,
8067/* 6E - 80 */
8068 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8069/* a */ 0x01,
8070/* b */ 0x02,
8071/* c */ 0x03,
8072/* d */ 0x37,
8073/* e */ 0x2D,
8074/* f */ 0x2E,
8075/* g */ 0x2F,
8076/* h */ 0x16,
8077/* i */ 0x05,
8078/* 8A - 90 */
8079 0, 0, 0, 0, 0, 0, 0,
8080/* j */ 0x15,
8081/* k */ 0x0B,
8082/* l */ 0x0C,
8083/* m */ 0x0D,
8084/* n */ 0x0E,
8085/* o */ 0x0F,
8086/* p */ 0x10,
8087/* q */ 0x11,
8088/* r */ 0x12,
8089/* 9A - A1 */
8090 0, 0, 0, 0, 0, 0, 0, 0,
8091/* s */ 0x13,
8092/* t */ 0x3C,
8093/* u */ 0x3D,
8094/* v */ 0x32,
8095/* w */ 0x26,
8096/* x */ 0x18,
8097/* y */ 0x19,
8098/* z */ 0x3F,
8099/* AA - AC */
8100 0, 0, 0,
8101/* [ */ 0x27,
8102/* AE - BC */
8103 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8104/* ] */ 0x1D,
8105/* BE - C0 */ 0, 0, 0,
8106/* A */ 0x01,
8107/* B */ 0x02,
8108/* C */ 0x03,
8109/* D */ 0x37,
8110/* E */ 0x2D,
8111/* F */ 0x2E,
8112/* G */ 0x2F,
8113/* H */ 0x16,
8114/* I */ 0x05,
8115/* CA - D0 */ 0, 0, 0, 0, 0, 0, 0,
8116/* J */ 0x15,
8117/* K */ 0x0B,
8118/* L */ 0x0C,
8119/* M */ 0x0D,
8120/* N */ 0x0E,
8121/* O */ 0x0F,
8122/* P */ 0x10,
8123/* Q */ 0x11,
8124/* R */ 0x12,
8125/* DA - DF */ 0, 0, 0, 0, 0, 0,
8126/* \ */ 0x1C,
8127/* E1 */ 0,
8128/* S */ 0x13,
8129/* T */ 0x3C,
8130/* U */ 0x3D,
8131/* V */ 0x32,
8132/* W */ 0x26,
8133/* X */ 0x18,
8134/* Y */ 0x19,
8135/* Z */ 0x3F,
8136/* EA - FF*/ 0, 0, 0, 0, 0, 0,
8137 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8138};
8139
8140char MetaCharTable[]=
Bram Moolenaar0f873732019-12-05 20:28:46 +01008141{// 0 1 2 3 4 5 6 7 8 9 A B C D E F
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 0, 0, 0, 0,'\\', 0,'F', 0,'W','M','N', 0, 0, 0, 0, 0,
8143 0, 0, 0, 0,']', 0, 0,'G', 0, 0,'R','O', 0, 0, 0, 0,
8144 '@','A','B','C','D','E', 0, 0,'H','I','J','K','L', 0, 0, 0,
8145 'P','Q', 0,'S','T','U','V', 0,'X','Y','Z','[', 0, 0,'^', 0
8146};
8147
8148
Bram Moolenaar0f873732019-12-05 20:28:46 +01008149// TODO: Use characters NOT numbers!!!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150char CtrlCharTable[]=
Bram Moolenaar0f873732019-12-05 20:28:46 +01008151{// 0 1 2 3 4 5 6 7 8 9 A B C D E F
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 124,193,194,195, 0,201, 0, 0, 0, 0, 0,210,211,212,213,214,
8153 215,216,217,226, 0,209,200, 0,231,232, 0, 0,224,189, 95,109,
8154 0, 0, 0, 0, 0, 0,230,173, 0, 0, 0, 0, 0,197,198,199,
8155 0, 0,229, 0, 0, 0, 0,196, 0, 0, 0, 0,227,228, 0,233,
8156};
8157
8158
8159#endif