blob: 15d88f9e15a3cf697d07366f5158b937e04cb355 [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
2154# if defined(FEAT_GUI_PHOTON) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK)
2155 if (gui.in_use)
2156 type = 1;
2157# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158#endif
2159
2160 /*
Bram Moolenaarf82bac32010-07-25 22:30:20 +02002161 * Note: if "t_ts" is set, title is set with escape sequence rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 * than x11 calls, because the x11 calls don't always work
2163 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 if ((type || *T_TS != NUL) && title != NULL)
2165 {
Bram Moolenaard8f0cef2018-08-19 22:20:16 +02002166 if (oldtitle_outdated)
2167 {
2168 oldtitle_outdated = FALSE;
2169 VIM_CLEAR(oldtitle);
2170 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 if (oldtitle == NULL
2172#ifdef FEAT_GUI
2173 && !gui.in_use
2174#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002175 ) // first call but not in GUI, save title
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 (void)get_x11_title(FALSE);
2177
Bram Moolenaar0f873732019-12-05 20:28:46 +01002178 if (*T_TS != NUL) // it's OK if t_fs is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 term_settitle(title);
2180#ifdef FEAT_X11
2181 else
2182# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002183 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002185 set_x11_title(title); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186#endif
Bram Moolenaar2fa15e62005-01-04 21:23:48 +00002187#if defined(FEAT_GUI_GTK) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 || defined(FEAT_GUI_PHOTON) || defined(FEAT_GUI_MAC)
2189 else
2190 gui_mch_settitle(title, icon);
2191#endif
Bram Moolenaardac13472019-09-16 21:06:21 +02002192 unix_did_set_title = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 }
2194
2195 if ((type || *T_CIS != NUL) && icon != NULL)
2196 {
2197 if (oldicon == NULL
2198#ifdef FEAT_GUI
2199 && !gui.in_use
2200#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002201 ) // first call, save icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 get_x11_icon(FALSE);
2203
2204 if (*T_CIS != NUL)
2205 {
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002206 out_str(T_CIS); // set icon start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 out_str_nf(icon);
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02002208 out_str(T_CIE); // set icon end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 out_flush();
2210 }
2211#ifdef FEAT_X11
2212 else
2213# ifdef FEAT_GUI_GTK
Bram Moolenaar0f873732019-12-05 20:28:46 +01002214 if (!gui.in_use) // don't do this if GTK+ is running
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002216 set_x11_icon(icon); // x11
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217#endif
2218 did_set_icon = TRUE;
2219 }
2220 --recursive;
2221}
2222
2223/*
2224 * Restore the window/icon title.
2225 * "which" is one of:
Bram Moolenaar40385db2018-08-07 22:31:44 +02002226 * SAVE_RESTORE_TITLE only restore title
2227 * SAVE_RESTORE_ICON only restore icon
2228 * SAVE_RESTORE_BOTH restore title and icon
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 */
2230 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002231mch_restore_title(int which)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232{
Bram Moolenaardac13472019-09-16 21:06:21 +02002233 int do_push_pop = unix_did_set_title || did_set_icon;
Bram Moolenaare5c83282019-05-03 23:15:37 +02002234
Bram Moolenaar0f873732019-12-05 20:28:46 +01002235 // only restore the title or icon when it has been set
Bram Moolenaardac13472019-09-16 21:06:21 +02002236 mch_settitle(((which & SAVE_RESTORE_TITLE) && unix_did_set_title) ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 (oldtitle ? oldtitle : p_titleold) : NULL,
Bram Moolenaar40385db2018-08-07 22:31:44 +02002238 ((which & SAVE_RESTORE_ICON) && did_set_icon) ? oldicon : NULL);
2239
Bram Moolenaare5c83282019-05-03 23:15:37 +02002240 if (do_push_pop)
2241 {
2242 // pop and push from/to the stack
2243 term_pop_title(which);
2244 term_push_title(which);
2245 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246}
2247
Bram Moolenaar0f873732019-12-05 20:28:46 +01002248#endif // FEAT_TITLE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249
2250/*
2251 * Return TRUE if "name" looks like some xterm name.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002252 * Seiichi Sato mentioned that "mlterm" works like xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 */
2254 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002255vim_is_xterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256{
2257 if (name == NULL)
2258 return FALSE;
2259 return (STRNICMP(name, "xterm", 5) == 0
2260 || STRNICMP(name, "nxterm", 6) == 0
2261 || STRNICMP(name, "kterm", 5) == 0
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002262 || STRNICMP(name, "mlterm", 6) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 || STRNICMP(name, "rxvt", 4) == 0
Bram Moolenaar995e4af2017-09-01 20:24:03 +02002264 || STRNICMP(name, "screen.xterm", 12) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 || STRCMP(name, "builtin_xterm") == 0);
2266}
2267
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002268#if defined(FEAT_MOUSE_XTERM) || defined(PROTO)
2269/*
2270 * Return TRUE if "name" appears to be that of a terminal
2271 * known to support the xterm-style mouse protocol.
2272 * Relies on term_is_xterm having been set to its correct value.
2273 */
2274 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002275use_xterm_like_mouse(char_u *name)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002276{
2277 return (name != NULL
Bram Moolenaare56132b2016-08-14 18:23:21 +02002278 && (term_is_xterm
2279 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002280 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaare56132b2016-08-14 18:23:21 +02002281 || STRICMP(name, "st") == 0
2282 || STRNICMP(name, "st-", 3) == 0
2283 || STRNICMP(name, "stterm", 6) == 0));
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00002284}
2285#endif
2286
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287/*
2288 * Return non-zero when using an xterm mouse, according to 'ttymouse'.
2289 * Return 1 for "xterm".
2290 * Return 2 for "xterm2".
Bram Moolenaarc8427482011-10-20 21:09:35 +02002291 * Return 3 for "urxvt".
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002292 * Return 4 for "sgr".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 */
2294 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002295use_xterm_mouse(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296{
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02002297 if (ttym_flags == TTYM_SGR)
2298 return 4;
Bram Moolenaarc8427482011-10-20 21:09:35 +02002299 if (ttym_flags == TTYM_URXVT)
2300 return 3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 if (ttym_flags == TTYM_XTERM2)
2302 return 2;
2303 if (ttym_flags == TTYM_XTERM)
2304 return 1;
2305 return 0;
2306}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307
2308 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002309vim_is_iris(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310{
2311 if (name == NULL)
2312 return FALSE;
2313 return (STRNICMP(name, "iris-ansi", 9) == 0
2314 || STRCMP(name, "builtin_iris-ansi") == 0);
2315}
2316
2317 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002318vim_is_vt300(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319{
2320 if (name == NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002321 return FALSE; // actually all ANSI comp. terminals should be here
2322 // catch VT100 - VT5xx
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002323 return ((STRNICMP(name, "vt", 2) == 0
2324 && vim_strchr((char_u *)"12345", name[2]) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 || STRCMP(name, "builtin_vt320") == 0);
2326}
2327
2328/*
2329 * Return TRUE if "name" is a terminal for which 'ttyfast' should be set.
2330 * This should include all windowed terminal emulators.
2331 */
2332 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002333vim_is_fastterm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334{
2335 if (name == NULL)
2336 return FALSE;
2337 if (vim_is_xterm(name) || vim_is_vt300(name) || vim_is_iris(name))
2338 return TRUE;
2339 return ( STRNICMP(name, "hpterm", 6) == 0
2340 || STRNICMP(name, "sun-cmd", 7) == 0
2341 || STRNICMP(name, "screen", 6) == 0
Bram Moolenaar0ba40702016-10-12 14:50:54 +02002342 || STRNICMP(name, "tmux", 4) == 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343 || STRNICMP(name, "dtterm", 6) == 0);
2344}
2345
2346/*
2347 * Insert user name in s[len].
2348 * Return OK if a name found.
2349 */
2350 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002351mch_get_user_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352{
2353#ifdef VMS
Bram Moolenaarffb8ab02005-09-07 21:15:32 +00002354 vim_strncpy(s, (char_u *)cuserid(NULL), len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 return OK;
2356#else
2357 return mch_get_uname(getuid(), s, len);
2358#endif
2359}
2360
2361/*
2362 * Insert user name for "uid" in s[len].
2363 * Return OK if a name found.
2364 */
2365 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002366mch_get_uname(uid_t uid, char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367{
2368#if defined(HAVE_PWD_H) && defined(HAVE_GETPWUID)
2369 struct passwd *pw;
2370
2371 if ((pw = getpwuid(uid)) != NULL
2372 && pw->pw_name != NULL && *(pw->pw_name) != NUL)
2373 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002374 vim_strncpy(s, (char_u *)pw->pw_name, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 return OK;
2376 }
2377#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002378 sprintf((char *)s, "%d", (int)uid); // assumes s is long enough
2379 return FAIL; // a number is not a name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380}
2381
2382/*
2383 * Insert host name is s[len].
2384 */
2385
2386#ifdef HAVE_SYS_UTSNAME_H
2387 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002388mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389{
2390 struct utsname vutsname;
2391
2392 if (uname(&vutsname) < 0)
2393 *s = NUL;
2394 else
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002395 vim_strncpy(s, (char_u *)vutsname.nodename, len - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002397#else // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398
2399# ifdef HAVE_SYS_SYSTEMINFO_H
2400# define gethostname(nam, len) sysinfo(SI_HOSTNAME, nam, len)
2401# endif
2402
2403 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002404mch_get_host_name(char_u *s, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405{
2406# ifdef VAXC
2407 vaxc$gethostname((char *)s, len);
2408# else
2409 gethostname((char *)s, len);
2410# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01002411 s[len - 1] = NUL; // make sure it's terminated
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002413#endif // HAVE_SYS_UTSNAME_H
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414
2415/*
2416 * return process ID
2417 */
2418 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002419mch_get_pid(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420{
2421 return (long)getpid();
2422}
2423
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002424/*
2425 * return TRUE if process "pid" is still running
2426 */
2427 int
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002428mch_process_running(long pid)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002429{
2430 // EMX kill() not working correctly, it seems
2431 return kill(pid, 0) == 0;
2432}
2433
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434#if !defined(HAVE_STRERROR) && defined(USE_GETCWD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 static char *
Bram Moolenaar05540972016-01-30 20:31:25 +01002436strerror(int err)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437{
2438 extern int sys_nerr;
2439 extern char *sys_errlist[];
2440 static char er[20];
2441
2442 if (err > 0 && err < sys_nerr)
2443 return (sys_errlist[err]);
2444 sprintf(er, "Error %d", err);
2445 return er;
2446}
2447#endif
2448
2449/*
Bram Moolenaar964b3742019-05-24 18:54:09 +02002450 * Get name of current directory into buffer "buf" of length "len" bytes.
2451 * "len" must be at least PATH_MAX.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 * Return OK for success, FAIL for failure.
2453 */
2454 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002455mch_dirname(char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456{
2457#if defined(USE_GETCWD)
2458 if (getcwd((char *)buf, len) == NULL)
2459 {
2460 STRCPY(buf, strerror(errno));
2461 return FAIL;
2462 }
2463 return OK;
2464#else
2465 return (getwd((char *)buf) != NULL ? OK : FAIL);
2466#endif
2467}
2468
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469/*
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002470 * Get absolute file name into "buf[len]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 *
2472 * return FAIL for failure, OK for success
2473 */
2474 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002475mch_FullName(
2476 char_u *fname,
2477 char_u *buf,
2478 int len,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002479 int force) // also expand when already absolute path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480{
2481 int l;
Bram Moolenaar38323e42007-03-06 19:22:53 +00002482#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 int fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002484 static int dont_fchdir = FALSE; // TRUE when fchdir() doesn't work
Bram Moolenaar38323e42007-03-06 19:22:53 +00002485#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 char_u olddir[MAXPATHL];
2487 char_u *p;
2488 int retval = OK;
Bram Moolenaarbf820722008-06-21 11:12:49 +00002489#ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01002490 char_u posix_fname[MAXPATHL]; // Cygwin docs mention MAX_PATH, but
2491 // it's not always defined
Bram Moolenaarbf820722008-06-21 11:12:49 +00002492#endif
2493
Bram Moolenaar38323e42007-03-06 19:22:53 +00002494#ifdef VMS
2495 fname = vms_fixfilename(fname);
2496#endif
2497
Bram Moolenaara2442432007-04-26 14:26:37 +00002498#ifdef __CYGWIN__
2499 /*
2500 * This helps for when "/etc/hosts" is a symlink to "c:/something/hosts".
2501 */
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002502# if CYGWIN_VERSION_DLL_MAJOR >= 1007
Bram Moolenaar0f873732019-12-05 20:28:46 +01002503 // Use CCP_RELATIVE to avoid that it sometimes returns a path that ends in
2504 // a forward slash.
Bram Moolenaar06b07342015-12-31 22:26:28 +01002505 cygwin_conv_path(CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
2506 fname, posix_fname, MAXPATHL);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002507# else
Bram Moolenaarbf820722008-06-21 11:12:49 +00002508 cygwin_conv_to_posix_path(fname, posix_fname);
Bram Moolenaar0d1498e2008-06-29 12:00:49 +00002509# endif
Bram Moolenaarbf820722008-06-21 11:12:49 +00002510 fname = posix_fname;
Bram Moolenaara2442432007-04-26 14:26:37 +00002511#endif
2512
Bram Moolenaar0f873732019-12-05 20:28:46 +01002513 // Expand it if forced or not an absolute path.
2514 // Do not do it for "/file", the result is always "/".
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002515 if ((force || !mch_isFullName(fname))
2516 && ((p = vim_strrchr(fname, '/')) == NULL || p != fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 {
2518 /*
2519 * If the file name has a path, change to that directory for a moment,
Bram Moolenaar964b3742019-05-24 18:54:09 +02002520 * and then get the directory (and get back to where we were).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 * This will get the correct path name with "../" things.
2522 */
Bram Moolenaare3303cb2015-12-31 18:29:46 +01002523 if (p != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002525#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 /*
2527 * Use fchdir() if possible, it's said to be faster and more
2528 * reliable. But on SunOS 4 it might not work. Check this by
2529 * doing a fchdir() right now.
2530 */
2531 if (!dont_fchdir)
2532 {
2533 fd = open(".", O_RDONLY | O_EXTRA, 0);
2534 if (fd >= 0 && fchdir(fd) < 0)
2535 {
2536 close(fd);
2537 fd = -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002538 dont_fchdir = TRUE; // don't try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 }
2540 }
Bram Moolenaar38323e42007-03-06 19:22:53 +00002541#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542
Bram Moolenaar0f873732019-12-05 20:28:46 +01002543 // Only change directory when we are sure we can return to where
2544 // we are now. After doing "su" chdir(".") might not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 if (
Bram Moolenaar38323e42007-03-06 19:22:53 +00002546#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 fd < 0 &&
Bram Moolenaar38323e42007-03-06 19:22:53 +00002548#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 (mch_dirname(olddir, MAXPATHL) == FAIL
2550 || mch_chdir((char *)olddir) != 0))
2551 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002552 p = NULL; // can't get current dir: don't chdir
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 retval = FAIL;
2554 }
2555 else
2556 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002557 // The directory is copied into buf[], to be able to remove
2558 // the file name without changing it (could be a string in
2559 // read-only memory)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 if (p - fname >= len)
2561 retval = FAIL;
2562 else
2563 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00002564 vim_strncpy(buf, fname, p - fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 if (mch_chdir((char *)buf))
2566 retval = FAIL;
2567 else
2568 fname = p + 1;
2569 *buf = NUL;
2570 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 }
2572 }
2573 if (mch_dirname(buf, len) == FAIL)
2574 {
2575 retval = FAIL;
2576 *buf = NUL;
2577 }
2578 if (p != NULL)
2579 {
Bram Moolenaar38323e42007-03-06 19:22:53 +00002580#ifdef HAVE_FCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 if (fd >= 0)
2582 {
Bram Moolenaar25724922009-07-14 15:38:41 +00002583 if (p_verbose >= 5)
2584 {
2585 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01002586 msg("fchdir() to previous dir");
Bram Moolenaar25724922009-07-14 15:38:41 +00002587 verbose_leave();
2588 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 l = fchdir(fd);
2590 close(fd);
2591 }
2592 else
Bram Moolenaar38323e42007-03-06 19:22:53 +00002593#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 l = mch_chdir((char *)olddir);
2595 if (l != 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002596 emsg(_(e_prev_dir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 }
2598
2599 l = STRLEN(buf);
Bram Moolenaardac75692012-10-14 04:35:45 +02002600 if (l >= len - 1)
Bram Moolenaar0f873732019-12-05 20:28:46 +01002601 retval = FAIL; // no space for trailing "/"
Bram Moolenaar38323e42007-03-06 19:22:53 +00002602#ifndef VMS
Bram Moolenaardac75692012-10-14 04:35:45 +02002603 else if (l > 0 && buf[l - 1] != '/' && *fname != NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 && STRCMP(fname, ".") != 0)
Bram Moolenaardac75692012-10-14 04:35:45 +02002605 STRCAT(buf, "/");
Bram Moolenaar38323e42007-03-06 19:22:53 +00002606#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 }
Bram Moolenaar3d20ca12006-11-28 16:43:58 +00002608
Bram Moolenaar0f873732019-12-05 20:28:46 +01002609 // Catch file names which are too long.
Bram Moolenaar78a15312009-05-15 19:33:18 +00002610 if (retval == FAIL || (int)(STRLEN(buf) + STRLEN(fname)) >= len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 return FAIL;
2612
Bram Moolenaar0f873732019-12-05 20:28:46 +01002613 // Do not append ".", "/dir/." is equal to "/dir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 if (STRCMP(fname, ".") != 0)
2615 STRCAT(buf, fname);
2616
2617 return OK;
2618}
2619
2620/*
2621 * Return TRUE if "fname" does not depend on the current directory.
2622 */
2623 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002624mch_isFullName(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625{
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002626#ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 return ( fname[0] == '/' || fname[0] == '.' ||
2628 strchr((char *)fname,':') || strchr((char *)fname,'"') ||
2629 (strchr((char *)fname,'[') && strchr((char *)fname,']'))||
2630 (strchr((char *)fname,'<') && strchr((char *)fname,'>')) );
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002631#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 return (*fname == '/' || *fname == '~');
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633#endif
2634}
2635
Bram Moolenaar24552be2005-12-10 20:17:30 +00002636#if defined(USE_FNAME_CASE) || defined(PROTO)
2637/*
2638 * Set the case of the file name, if it already exists. This will cause the
2639 * file name to remain exactly the same.
Bram Moolenaarc2a27c32007-12-01 16:19:33 +00002640 * Only required for file systems where case is ignored and preserved.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002641 */
Bram Moolenaar24552be2005-12-10 20:17:30 +00002642 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002643fname_case(
2644 char_u *name,
Bram Moolenaar0f873732019-12-05 20:28:46 +01002645 int len UNUSED) // buffer size, only used when name gets longer
Bram Moolenaar24552be2005-12-10 20:17:30 +00002646{
2647 struct stat st;
2648 char_u *slash, *tail;
2649 DIR *dirp;
2650 struct dirent *dp;
2651
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002652 if (mch_lstat((char *)name, &st) >= 0)
Bram Moolenaar24552be2005-12-10 20:17:30 +00002653 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002654 // Open the directory where the file is located.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002655 slash = vim_strrchr(name, '/');
2656 if (slash == NULL)
2657 {
2658 dirp = opendir(".");
2659 tail = name;
2660 }
2661 else
2662 {
2663 *slash = NUL;
2664 dirp = opendir((char *)name);
2665 *slash = '/';
2666 tail = slash + 1;
2667 }
2668
2669 if (dirp != NULL)
2670 {
2671 while ((dp = readdir(dirp)) != NULL)
2672 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002673 // Only accept names that differ in case and are the same byte
2674 // length. TODO: accept different length name.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002675 if (STRICMP(tail, dp->d_name) == 0
2676 && STRLEN(tail) == STRLEN(dp->d_name))
2677 {
2678 char_u newname[MAXPATHL + 1];
2679 struct stat st2;
2680
Bram Moolenaar0f873732019-12-05 20:28:46 +01002681 // Verify the inode is equal.
Bram Moolenaar24552be2005-12-10 20:17:30 +00002682 vim_strncpy(newname, name, MAXPATHL);
2683 vim_strncpy(newname + (tail - name), (char_u *)dp->d_name,
2684 MAXPATHL - (tail - name));
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01002685 if (mch_lstat((char *)newname, &st2) >= 0
Bram Moolenaar24552be2005-12-10 20:17:30 +00002686 && st.st_ino == st2.st_ino
2687 && st.st_dev == st2.st_dev)
2688 {
2689 STRCPY(tail, dp->d_name);
2690 break;
2691 }
2692 }
2693 }
2694
2695 closedir(dirp);
2696 }
2697 }
2698}
2699#endif
2700
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701/*
2702 * Get file permissions for 'name'.
2703 * Returns -1 when it doesn't exist.
2704 */
2705 long
Bram Moolenaar05540972016-01-30 20:31:25 +01002706mch_getperm(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707{
2708 struct stat statb;
2709
Bram Moolenaar0f873732019-12-05 20:28:46 +01002710 // Keep the #ifdef outside of stat(), it may be a macro.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711#ifdef VMS
2712 if (stat((char *)vms_fixfilename(name), &statb))
2713#else
2714 if (stat((char *)name, &statb))
2715#endif
2716 return -1;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002717#ifdef __INTERIX
Bram Moolenaar0f873732019-12-05 20:28:46 +01002718 // The top bit makes the value negative, which means the file doesn't
2719 // exist. Remove the bit, we don't use it.
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002720 return statb.st_mode & ~S_ADDACE;
2721#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 return statb.st_mode;
Bram Moolenaar708f62c2007-08-11 20:24:10 +00002723#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724}
2725
2726/*
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002727 * Set file permission for "name" to "perm".
2728 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 */
2730 int
Bram Moolenaar05540972016-01-30 20:31:25 +01002731mch_setperm(char_u *name, long perm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732{
2733 return (chmod((char *)
2734#ifdef VMS
2735 vms_fixfilename(name),
2736#else
2737 name,
2738#endif
2739 (mode_t)perm) == 0 ? OK : FAIL);
2740}
2741
Bram Moolenaarcd142e32017-11-16 17:03:45 +01002742#if defined(HAVE_FCHMOD) || defined(PROTO)
2743/*
2744 * Set file permission for open file "fd" to "perm".
2745 * Return FAIL for failure, OK otherwise.
2746 */
2747 int
2748mch_fsetperm(int fd, long perm)
2749{
2750 return (fchmod(fd, (mode_t)perm) == 0 ? OK : FAIL);
2751}
2752#endif
2753
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754#if defined(HAVE_ACL) || defined(PROTO)
2755# ifdef HAVE_SYS_ACL_H
2756# include <sys/acl.h>
2757# endif
2758# ifdef HAVE_SYS_ACCESS_H
2759# include <sys/access.h>
2760# endif
2761
2762# ifdef HAVE_SOLARIS_ACL
2763typedef struct vim_acl_solaris_T {
2764 int acl_cnt;
2765 aclent_t *acl_entry;
2766} vim_acl_solaris_T;
2767# endif
2768
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002769#if defined(HAVE_SELINUX) || defined(PROTO)
2770/*
2771 * Copy security info from "from_file" to "to_file".
2772 */
2773 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002774mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002775{
2776 if (from_file == NULL)
2777 return;
2778
2779 if (selinux_enabled == -1)
2780 selinux_enabled = is_selinux_enabled();
2781
2782 if (selinux_enabled > 0)
2783 {
2784 security_context_t from_context = NULL;
2785 security_context_t to_context = NULL;
2786
2787 if (getfilecon((char *)from_file, &from_context) < 0)
2788 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002789 // If the filesystem doesn't support extended attributes,
2790 // the original had no special security context and the
2791 // target cannot have one either.
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002792 if (errno == EOPNOTSUPP)
2793 return;
2794
Bram Moolenaar32526b32019-01-19 17:43:09 +01002795 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002796 msg_outtrans(from_file);
2797 msg_putchar('\n');
2798 return;
2799 }
2800 if (getfilecon((char *)to_file, &to_context) < 0)
2801 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002802 msg_puts(_("\nCould not get security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002803 msg_outtrans(to_file);
2804 msg_putchar('\n');
2805 freecon (from_context);
2806 return ;
2807 }
2808 if (strcmp(from_context, to_context) != 0)
2809 {
2810 if (setfilecon((char *)to_file, from_context) < 0)
2811 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002812 msg_puts(_("\nCould not set security context for "));
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002813 msg_outtrans(to_file);
2814 msg_putchar('\n');
2815 }
2816 }
2817 freecon(to_context);
2818 freecon(from_context);
2819 }
2820}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002821#endif // HAVE_SELINUX
Bram Moolenaar588ebeb2008-05-07 17:09:24 +00002822
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002823#if defined(HAVE_SMACK) && !defined(PROTO)
2824/*
2825 * Copy security info from "from_file" to "to_file".
2826 */
2827 void
Bram Moolenaard14e00e2016-01-31 17:30:51 +01002828mch_copy_sec(char_u *from_file, char_u *to_file)
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002829{
Bram Moolenaar62f167f2014-04-23 12:52:40 +02002830 static const char * const smack_copied_attributes[] =
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002831 {
2832 XATTR_NAME_SMACK,
2833 XATTR_NAME_SMACKEXEC,
2834 XATTR_NAME_SMACKMMAP
2835 };
2836
2837 char buffer[SMACK_LABEL_LEN];
2838 const char *name;
2839 int index;
2840 int ret;
2841 ssize_t size;
2842
2843 if (from_file == NULL)
2844 return;
2845
2846 for (index = 0 ; index < (int)(sizeof(smack_copied_attributes)
2847 / sizeof(smack_copied_attributes)[0]) ; index++)
2848 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002849 // get the name of the attribute to copy
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002850 name = smack_copied_attributes[index];
2851
Bram Moolenaar0f873732019-12-05 20:28:46 +01002852 // get the value of the attribute in buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002853 size = getxattr((char*)from_file, name, buffer, sizeof(buffer));
2854 if (size >= 0)
2855 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002856 // copy the attribute value of buffer
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002857 ret = setxattr((char*)to_file, name, buffer, (size_t)size, 0);
2858 if (ret < 0)
2859 {
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002860 vim_snprintf((char *)IObuff, IOSIZE,
2861 _("Could not set security context %s for %s"),
2862 name, to_file);
2863 msg_outtrans(IObuff);
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002864 msg_putchar('\n');
2865 }
2866 }
2867 else
2868 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01002869 // what reason of not having the attribute value?
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002870 switch (errno)
2871 {
2872 case ENOTSUP:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002873 // extended attributes aren't supported or enabled
2874 // should a message be echoed? not sure...
2875 return; // leave because it isn't useful to continue
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002876
2877 case ERANGE:
2878 default:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002879 // no enough size OR unexpected error
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002880 vim_snprintf((char *)IObuff, IOSIZE,
2881 _("Could not get security context %s for %s. Removing it!"),
2882 name, from_file);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002883 msg_puts((char *)IObuff);
Bram Moolenaar4a1314c2016-01-27 20:47:18 +01002884 msg_putchar('\n');
Bram Moolenaar0f873732019-12-05 20:28:46 +01002885 // FALLTHROUGH to remove the attribute
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002886
2887 case ENODATA:
Bram Moolenaar0f873732019-12-05 20:28:46 +01002888 // no attribute of this name
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002889 ret = removexattr((char*)to_file, name);
Bram Moolenaar0f873732019-12-05 20:28:46 +01002890 // Silently ignore errors, apparently this happens when
2891 // smack is not actually being used.
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002892 break;
2893 }
2894 }
2895 }
2896}
Bram Moolenaar0f873732019-12-05 20:28:46 +01002897#endif // HAVE_SMACK
Bram Moolenaar5bd32f42014-04-02 14:05:38 +02002898
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899/*
2900 * Return a pointer to the ACL of file "fname" in allocated memory.
2901 * Return NULL if the ACL is not available for whatever reason.
2902 */
2903 vim_acl_T
Bram Moolenaar05540972016-01-30 20:31:25 +01002904mch_get_acl(char_u *fname UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905{
2906 vim_acl_T ret = NULL;
2907#ifdef HAVE_POSIX_ACL
2908 ret = (vim_acl_T)acl_get_file((char *)fname, ACL_TYPE_ACCESS);
2909#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01002910#ifdef HAVE_SOLARIS_ZFS_ACL
2911 acl_t *aclent;
2912
2913 if (acl_get((char *)fname, 0, &aclent) < 0)
2914 return NULL;
2915 ret = (vim_acl_T)aclent;
2916#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917#ifdef HAVE_SOLARIS_ACL
2918 vim_acl_solaris_T *aclent;
2919
2920 aclent = malloc(sizeof(vim_acl_solaris_T));
2921 if ((aclent->acl_cnt = acl((char *)fname, GETACLCNT, 0, NULL)) < 0)
2922 {
2923 free(aclent);
2924 return NULL;
2925 }
2926 aclent->acl_entry = malloc(aclent->acl_cnt * sizeof(aclent_t));
2927 if (acl((char *)fname, GETACL, aclent->acl_cnt, aclent->acl_entry) < 0)
2928 {
2929 free(aclent->acl_entry);
2930 free(aclent);
2931 return NULL;
2932 }
2933 ret = (vim_acl_T)aclent;
2934#else
2935#if defined(HAVE_AIX_ACL)
2936 int aclsize;
2937 struct acl *aclent;
2938
2939 aclsize = sizeof(struct acl);
2940 aclent = malloc(aclsize);
2941 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
2942 {
2943 if (errno == ENOSPC)
2944 {
2945 aclsize = aclent->acl_len;
2946 aclent = realloc(aclent, aclsize);
2947 if (statacl((char *)fname, STX_NORMAL, aclent, aclsize) < 0)
2948 {
2949 free(aclent);
2950 return NULL;
2951 }
2952 }
2953 else
2954 {
2955 free(aclent);
2956 return NULL;
2957 }
2958 }
2959 ret = (vim_acl_T)aclent;
Bram Moolenaar0f873732019-12-05 20:28:46 +01002960#endif // HAVE_AIX_ACL
2961#endif // HAVE_SOLARIS_ACL
2962#endif // HAVE_SOLARIS_ZFS_ACL
2963#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 return ret;
2965}
2966
2967/*
2968 * Set the ACL of file "fname" to "acl" (unless it's NULL).
2969 */
2970 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002971mch_set_acl(char_u *fname UNUSED, vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972{
2973 if (aclent == NULL)
2974 return;
2975#ifdef HAVE_POSIX_ACL
2976 acl_set_file((char *)fname, ACL_TYPE_ACCESS, (acl_t)aclent);
2977#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01002978#ifdef HAVE_SOLARIS_ZFS_ACL
2979 acl_set((char *)fname, (acl_t *)aclent);
2980#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981#ifdef HAVE_SOLARIS_ACL
2982 acl((char *)fname, SETACL, ((vim_acl_solaris_T *)aclent)->acl_cnt,
2983 ((vim_acl_solaris_T *)aclent)->acl_entry);
2984#else
2985#ifdef HAVE_AIX_ACL
2986 chacl((char *)fname, aclent, ((struct acl *)aclent)->acl_len);
Bram Moolenaar0f873732019-12-05 20:28:46 +01002987#endif // HAVE_AIX_ACL
2988#endif // HAVE_SOLARIS_ACL
2989#endif // HAVE_SOLARIS_ZFS_ACL
2990#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991}
2992
2993 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002994mch_free_acl(vim_acl_T aclent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995{
2996 if (aclent == NULL)
2997 return;
2998#ifdef HAVE_POSIX_ACL
2999 acl_free((acl_t)aclent);
3000#else
Bram Moolenaar8d462f92012-02-05 22:51:33 +01003001#ifdef HAVE_SOLARIS_ZFS_ACL
3002 acl_free((acl_t *)aclent);
3003#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004#ifdef HAVE_SOLARIS_ACL
3005 free(((vim_acl_solaris_T *)aclent)->acl_entry);
3006 free(aclent);
3007#else
3008#ifdef HAVE_AIX_ACL
3009 free(aclent);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003010#endif // HAVE_AIX_ACL
3011#endif // HAVE_SOLARIS_ACL
3012#endif // HAVE_SOLARIS_ZFS_ACL
3013#endif // HAVE_POSIX_ACL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014}
3015#endif
3016
3017/*
3018 * Set hidden flag for "name".
3019 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003021mch_hide(char_u *name UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022{
Bram Moolenaar0f873732019-12-05 20:28:46 +01003023 // can't hide a file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024}
3025
3026/*
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003027 * return TRUE if "name" is a directory or a symlink to a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 * return FALSE if "name" is not a directory
3029 * return FALSE for error
3030 */
3031 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003032mch_isdir(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033{
3034 struct stat statb;
3035
Bram Moolenaar0f873732019-12-05 20:28:46 +01003036 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 return FALSE;
3038 if (stat((char *)name, &statb))
3039 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041}
3042
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003043/*
3044 * return TRUE if "name" is a directory, NOT a symlink to a directory
3045 * return FALSE if "name" is not a directory
3046 * return FALSE for error
3047 */
3048 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003049mch_isrealdir(char_u *name)
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003050{
3051 struct stat statb;
3052
Bram Moolenaar0f873732019-12-05 20:28:46 +01003053 if (*name == NUL) // Some stat()s don't flag "" as an error.
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003054 return FALSE;
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01003055 if (mch_lstat((char *)name, &statb))
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003056 return FALSE;
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003057 return (S_ISDIR(statb.st_mode) ? TRUE : FALSE);
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003058}
3059
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060/*
3061 * Return 1 if "name" is an executable file, 0 if not or it doesn't exist.
3062 */
3063 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01003064executable_file(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065{
3066 struct stat st;
3067
3068 if (stat((char *)name, &st))
3069 return 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003070#ifdef VMS
Bram Moolenaar0f873732019-12-05 20:28:46 +01003071 // Like on Unix system file can have executable rights but not necessarily
3072 // be an executable, but on Unix is not a default for an ordinary file to
3073 // have an executable flag - on VMS it is in most cases.
3074 // Therefore, this check does not have any sense - let keep us to the
3075 // conventions instead:
3076 // *.COM and *.EXE files are the executables - the rest are not. This is
3077 // not ideal but better then it was.
Bram Moolenaar206f0112014-03-12 16:51:55 +01003078 int vms_executable = 0;
3079 if (S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0)
3080 {
3081 if (strstr(vms_tolower((char*)name),".exe") != NULL
3082 || strstr(vms_tolower((char*)name),".com")!= NULL)
3083 vms_executable = 1;
3084 }
3085 return vms_executable;
3086#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 return S_ISREG(st.st_mode) && mch_access((char *)name, X_OK) == 0;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003088#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089}
3090
3091/*
Bram Moolenaar2fcf6682017-03-11 20:03:42 +01003092 * Return TRUE if "name" can be found in $PATH and executed, FALSE if not.
Bram Moolenaarb5971142015-03-21 17:32:19 +01003093 * If "use_path" is FALSE only check if "name" is executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 * Return -1 if unknown.
3095 */
3096 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003097mch_can_exe(char_u *name, char_u **path, int use_path)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098{
3099 char_u *buf;
3100 char_u *p, *e;
3101 int retval;
3102
Bram Moolenaar0f873732019-12-05 20:28:46 +01003103 // When "use_path" is false and if it's an absolute or relative path don't
3104 // need to use $PATH.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003105 if (!use_path || gettail(name) != name)
Bram Moolenaar206f0112014-03-12 16:51:55 +01003106 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003107 // There must be a path separator, files in the current directory
3108 // can't be executed.
Bram Moolenaard08b8c42019-07-24 14:59:45 +02003109 if ((use_path || gettail(name) != name) && executable_file(name))
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003110 {
3111 if (path != NULL)
3112 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003113 if (name[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003114 *path = FullName_save(name, TRUE);
3115 else
3116 *path = vim_strsave(name);
3117 }
3118 return TRUE;
3119 }
3120 return FALSE;
Bram Moolenaar206f0112014-03-12 16:51:55 +01003121 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122
3123 p = (char_u *)getenv("PATH");
3124 if (p == NULL || *p == NUL)
3125 return -1;
Bram Moolenaar964b3742019-05-24 18:54:09 +02003126 buf = alloc(STRLEN(name) + STRLEN(p) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 if (buf == NULL)
3128 return -1;
3129
3130 /*
3131 * Walk through all entries in $PATH to check if "name" exists there and
3132 * is an executable file.
3133 */
3134 for (;;)
3135 {
3136 e = (char_u *)strchr((char *)p, ':');
3137 if (e == NULL)
3138 e = p + STRLEN(p);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003139 if (e - p <= 1) // empty entry means current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 STRCPY(buf, "./");
3141 else
3142 {
Bram Moolenaarbbebc852005-07-18 21:47:53 +00003143 vim_strncpy(buf, p, e - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 add_pathsep(buf);
3145 }
3146 STRCAT(buf, name);
3147 retval = executable_file(buf);
3148 if (retval == 1)
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003149 {
3150 if (path != NULL)
3151 {
Bram Moolenaar43663192017-03-05 14:29:12 +01003152 if (buf[0] != '/')
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003153 *path = FullName_save(buf, TRUE);
3154 else
3155 *path = vim_strsave(buf);
3156 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 break;
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003158 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159
3160 if (*e != ':')
3161 break;
3162 p = e + 1;
3163 }
3164
3165 vim_free(buf);
3166 return retval;
3167}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168
3169/*
3170 * Check what "name" is:
3171 * NODE_NORMAL: file or directory (or doesn't exist)
3172 * NODE_WRITABLE: writable device, socket, fifo, etc.
3173 * NODE_OTHER: non-writable things
3174 */
3175 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003176mch_nodetype(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177{
3178 struct stat st;
3179
3180 if (stat((char *)name, &st))
3181 return NODE_NORMAL;
3182 if (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode))
3183 return NODE_NORMAL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003184 if (S_ISBLK(st.st_mode)) // block device isn't writable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 return NODE_OTHER;
Bram Moolenaar0f873732019-12-05 20:28:46 +01003186 // Everything else is writable?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 return NODE_WRITABLE;
3188}
3189
3190 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003191mch_early_init(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192{
3193#ifdef HAVE_CHECK_STACK_GROWTH
3194 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 check_stack_growth((char *)&i);
3197
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003198# ifdef HAVE_STACK_LIMIT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 get_stack_limit();
3200# endif
3201
3202#endif
3203
3204 /*
3205 * Setup an alternative stack for signals. Helps to catch signals when
3206 * running out of stack space.
3207 * Use of sigaltstack() is preferred, it's more portable.
3208 * Ignore any errors.
3209 */
3210#if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003211 signal_stack = alloc(SIGSTKSZ);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 init_signal_stack();
3213#endif
3214}
3215
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003216#if defined(EXITFREE) || defined(PROTO)
3217 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003218mch_free_mem(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003219{
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003220# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
3221 if (clip_star.owned)
3222 clip_lose_selection(&clip_star);
3223 if (clip_plus.owned)
3224 clip_lose_selection(&clip_plus);
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003225# endif
Bram Moolenaare8208012008-06-20 09:59:25 +00003226# if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003227 if (xterm_Shell != (Widget)0)
3228 XtDestroyWidget(xterm_Shell);
Bram Moolenaare8208012008-06-20 09:59:25 +00003229# ifndef LESSTIF_VERSION
Bram Moolenaar0f873732019-12-05 20:28:46 +01003230 // Lesstif crashes here, lose some memory
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003231 if (xterm_dpy != NULL)
3232 XtCloseDisplay(xterm_dpy);
3233 if (app_context != (XtAppContext)NULL)
Bram Moolenaare8208012008-06-20 09:59:25 +00003234 {
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003235 XtDestroyApplicationContext(app_context);
Bram Moolenaare8208012008-06-20 09:59:25 +00003236# ifdef FEAT_X11
Bram Moolenaar0f873732019-12-05 20:28:46 +01003237 x11_display = NULL; // freed by XtDestroyApplicationContext()
Bram Moolenaare8208012008-06-20 09:59:25 +00003238# endif
3239 }
3240# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003241# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003242# if defined(FEAT_X11)
Bram Moolenaare8208012008-06-20 09:59:25 +00003243 if (x11_display != NULL
3244# ifdef FEAT_XCLIPBOARD
3245 && x11_display != xterm_dpy
3246# endif
3247 )
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003248 XCloseDisplay(x11_display);
3249# endif
3250# if defined(HAVE_SIGALTSTACK) || defined(HAVE_SIGSTACK)
Bram Moolenaard23a8232018-02-10 18:45:26 +01003251 VIM_CLEAR(signal_stack);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00003252# endif
3253# ifdef FEAT_TITLE
3254 vim_free(oldtitle);
3255 vim_free(oldicon);
3256# endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003257}
3258#endif
3259
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260/*
3261 * Output a newline when exiting.
3262 * Make sure the newline goes to the same stream as the text.
3263 */
3264 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003265exit_scroll(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266{
Bram Moolenaardf177f62005-02-22 08:39:57 +00003267 if (silent_mode)
3268 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 if (newline_on_exit || msg_didout)
3270 {
3271 if (msg_use_printf())
3272 {
3273 if (info_message)
3274 mch_msg("\n");
3275 else
3276 mch_errmsg("\r\n");
3277 }
3278 else
3279 out_char('\n');
3280 }
3281 else
3282 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003283 restore_cterm_colors(); // get original colors back
3284 msg_clr_eos_force(); // clear the rest of the display
3285 windgoto((int)Rows - 1, 0); // may have moved the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 }
3287}
3288
3289 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003290mch_exit(int r)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291{
3292 exiting = TRUE;
3293
3294#if defined(FEAT_X11) && defined(FEAT_CLIPBOARD)
3295 x11_export_final_selection();
3296#endif
3297
3298#ifdef FEAT_GUI
3299 if (!gui.in_use)
3300#endif
3301 {
3302 settmode(TMODE_COOK);
3303#ifdef FEAT_TITLE
Bram Moolenaar40385db2018-08-07 22:31:44 +02003304 // restore xterm title and icon name
3305 mch_restore_title(SAVE_RESTORE_BOTH);
3306 term_pop_title(SAVE_RESTORE_BOTH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307#endif
3308 /*
3309 * When t_ti is not empty but it doesn't cause swapping terminal
3310 * pages, need to output a newline when msg_didout is set. But when
3311 * t_ti does swap pages it should not go to the shell page. Do this
3312 * before stoptermcap().
3313 */
3314 if (swapping_screen() && !newline_on_exit)
3315 exit_scroll();
3316
Bram Moolenaar0f873732019-12-05 20:28:46 +01003317 // Stop termcap: May need to check for T_CRV response, which
3318 // requires RAW mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 stoptermcap();
3320
3321 /*
3322 * A newline is only required after a message in the alternate screen.
3323 * This is set to TRUE by wait_return().
3324 */
3325 if (!swapping_screen() || newline_on_exit)
3326 exit_scroll();
3327
Bram Moolenaar0f873732019-12-05 20:28:46 +01003328 // Cursor may have been switched off without calling starttermcap()
3329 // when doing "vim -u vimrc" and vimrc contains ":q".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 if (full_screen)
3331 cursor_on();
3332 }
3333 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01003334 ml_close_all(TRUE); // remove all memfiles
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 may_core_dump();
3336#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 if (gui.in_use)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 gui_exit(r);
3339#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00003340
Bram Moolenaar56718732006-03-15 22:53:57 +00003341#ifdef MACOS_CONVERT
Bram Moolenaardf177f62005-02-22 08:39:57 +00003342 mac_conv_cleanup();
3343#endif
3344
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345#ifdef __QNX__
Bram Moolenaar0f873732019-12-05 20:28:46 +01003346 // A core dump won't be created if the signal handler
3347 // doesn't return, so we can't call exit()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 if (deadly_signal != 0)
3349 return;
3350#endif
3351
Bram Moolenaar009b2592004-10-24 19:18:58 +00003352#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003353 netbeans_send_disconnect();
Bram Moolenaar009b2592004-10-24 19:18:58 +00003354#endif
Bram Moolenaar0a5fe212005-06-24 23:01:23 +00003355
3356#ifdef EXITFREE
3357 free_all_mem();
3358#endif
3359
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 exit(r);
3361}
3362
3363 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01003364may_core_dump(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365{
3366 if (deadly_signal != 0)
3367 {
3368 signal(deadly_signal, SIG_DFL);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003369 kill(getpid(), deadly_signal); // Die using the signal we caught
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 }
3371}
3372
3373#ifndef VMS
3374
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003375/*
3376 * Get the file descriptor to use for tty operations.
3377 */
3378 static int
3379get_tty_fd(int fd)
3380{
3381 int tty_fd = fd;
3382
3383#if defined(HAVE_SVR4_PTYS) && defined(SUN_SYSTEM)
3384 // On SunOS: Get the terminal parameters from "fd", or the slave device of
3385 // "fd" when it is a master device.
3386 if (mch_isatty(fd) > 1)
3387 {
3388 char *name;
3389
3390 name = ptsname(fd);
3391 if (name == NULL)
3392 return -1;
3393
3394 tty_fd = open(name, O_RDONLY | O_NOCTTY | O_EXTRA, 0);
3395 if (tty_fd < 0)
3396 return -1;
3397 }
3398#endif
3399 return tty_fd;
3400}
3401
3402 static int
3403mch_tcgetattr(int fd, void *term)
3404{
3405 int tty_fd;
3406 int retval = -1;
3407
3408 tty_fd = get_tty_fd(fd);
3409 if (tty_fd >= 0)
3410 {
3411#ifdef NEW_TTY_SYSTEM
3412# ifdef HAVE_TERMIOS_H
3413 retval = tcgetattr(tty_fd, (struct termios *)term);
3414# else
3415 retval = ioctl(tty_fd, TCGETA, (struct termio *)term);
3416# endif
3417#else
3418 // for "old" tty systems
3419 retval = ioctl(tty_fd, TIOCGETP, (struct sgttyb *)term);
3420#endif
3421 if (tty_fd != fd)
3422 close(tty_fd);
3423 }
3424 return retval;
3425}
3426
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003428mch_settmode(int tmode)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429{
3430 static int first = TRUE;
3431
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003432#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433# ifdef HAVE_TERMIOS_H
3434 static struct termios told;
3435 struct termios tnew;
3436# else
3437 static struct termio told;
3438 struct termio tnew;
3439# endif
3440
3441 if (first)
3442 {
3443 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003444 mch_tcgetattr(read_cmd_fd, &told);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 }
3446
3447 tnew = told;
3448 if (tmode == TMODE_RAW)
3449 {
3450 /*
3451 * ~ICRNL enables typing ^V^M
3452 */
3453 tnew.c_iflag &= ~ICRNL;
3454 tnew.c_lflag &= ~(ICANON | ECHO | ISIG | ECHOE
3455# if defined(IEXTEN) && !defined(__MINT__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003456 | IEXTEN // IEXTEN enables typing ^V on SOLARIS
3457 // but it breaks function keys on MINT
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458# endif
3459 );
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003460# ifdef ONLCR
3461 // Don't map NL -> CR NL, we do it ourselves.
3462 // Also disable expanding tabs if possible.
3463# ifdef XTABS
3464 tnew.c_oflag &= ~(ONLCR | XTABS);
3465# else
3466# ifdef TAB3
3467 tnew.c_oflag &= ~(ONLCR | TAB3);
3468# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 tnew.c_oflag &= ~ONLCR;
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003470# endif
3471# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472# endif
Bram Moolenaarfaf626e2019-10-24 17:43:25 +02003473 tnew.c_cc[VMIN] = 1; // return after 1 char
3474 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 }
3476 else if (tmode == TMODE_SLEEP)
Bram Moolenaar40de4562016-07-01 15:03:46 +02003477 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003478 // Also reset ICANON here, otherwise on Solaris select() won't see
3479 // typeahead characters.
Bram Moolenaar40de4562016-07-01 15:03:46 +02003480 tnew.c_lflag &= ~(ICANON | ECHO);
Bram Moolenaar0f873732019-12-05 20:28:46 +01003481 tnew.c_cc[VMIN] = 1; // return after 1 char
3482 tnew.c_cc[VTIME] = 0; // don't wait
Bram Moolenaar40de4562016-07-01 15:03:46 +02003483 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484
3485# if defined(HAVE_TERMIOS_H)
3486 {
3487 int n = 10;
3488
Bram Moolenaar0f873732019-12-05 20:28:46 +01003489 // A signal may cause tcsetattr() to fail (e.g., SIGCONT). Retry a
3490 // few times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 while (tcsetattr(read_cmd_fd, TCSANOW, &tnew) == -1
3492 && errno == EINTR && n > 0)
3493 --n;
3494 }
3495# else
3496 ioctl(read_cmd_fd, TCSETA, &tnew);
3497# endif
3498
3499#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 /*
3501 * for "old" tty systems
3502 */
3503# ifndef TIOCSETN
Bram Moolenaar0f873732019-12-05 20:28:46 +01003504# define TIOCSETN TIOCSETP // for hpux 9.0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505# endif
3506 static struct sgttyb ttybold;
3507 struct sgttyb ttybnew;
3508
3509 if (first)
3510 {
3511 first = FALSE;
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003512 mch_tcgetattr(read_cmd_fd, &ttybold);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 }
3514
3515 ttybnew = ttybold;
3516 if (tmode == TMODE_RAW)
3517 {
3518 ttybnew.sg_flags &= ~(CRMOD | ECHO);
3519 ttybnew.sg_flags |= RAW;
3520 }
3521 else if (tmode == TMODE_SLEEP)
3522 ttybnew.sg_flags &= ~(ECHO);
3523 ioctl(read_cmd_fd, TIOCSETN, &ttybnew);
3524#endif
3525 curr_tmode = tmode;
3526}
3527
3528/*
3529 * Try to get the code for "t_kb" from the stty setting
3530 *
3531 * Even if termcap claims a backspace key, the user's setting *should*
3532 * prevail. stty knows more about reality than termcap does, and if
3533 * somebody's usual erase key is DEL (which, for most BSD users, it will
3534 * be), they're going to get really annoyed if their erase key starts
3535 * doing forward deletes for no reason. (Eric Fischer)
3536 */
3537 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003538get_stty(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539{
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003540 ttyinfo_T info;
3541 char_u buf[2];
3542 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003544 if (get_tty_info(read_cmd_fd, &info) == OK)
3545 {
3546 intr_char = info.interrupt;
3547 buf[0] = info.backspace;
3548 buf[1] = NUL;
3549 add_termcode((char_u *)"kb", buf, FALSE);
3550
Bram Moolenaar0f873732019-12-05 20:28:46 +01003551 // If <BS> and <DEL> are now the same, redefine <DEL>.
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003552 p = find_termcode((char_u *)"kD");
3553 if (p != NULL && p[0] == buf[0] && p[1] == buf[1])
3554 do_fixdel(NULL);
3555 }
3556}
3557
3558/*
3559 * Obtain the characters that Backspace and Enter produce on "fd".
3560 * Returns OK or FAIL.
3561 */
3562 int
3563get_tty_info(int fd, ttyinfo_T *info)
3564{
3565#ifdef NEW_TTY_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566# ifdef HAVE_TERMIOS_H
3567 struct termios keys;
3568# else
3569 struct termio keys;
3570# endif
3571
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003572 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003574 info->backspace = keys.c_cc[VERASE];
3575 info->interrupt = keys.c_cc[VINTR];
3576 if (keys.c_iflag & ICRNL)
3577 info->enter = NL;
3578 else
3579 info->enter = CAR;
3580 if (keys.c_oflag & ONLCR)
3581 info->nl_does_cr = TRUE;
3582 else
3583 info->nl_does_cr = FALSE;
3584 return OK;
3585 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01003587 // for "old" tty systems
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 struct sgttyb keys;
3589
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01003590 if (mch_tcgetattr(fd, &keys) != -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 {
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003592 info->backspace = keys.sg_erase;
3593 info->interrupt = keys.sg_kill;
3594 info->enter = CAR;
3595 info->nl_does_cr = TRUE;
3596 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598#endif
Bram Moolenaar4f44b882017-08-13 20:06:18 +02003599 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600}
3601
Bram Moolenaar0f873732019-12-05 20:28:46 +01003602#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003604static int mouse_ison = FALSE;
3605
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606/*
3607 * Set mouse clicks on or off.
3608 */
3609 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003610mch_setmouse(int on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611{
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003612#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003613 static int bevalterm_ison = FALSE;
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003614#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 int xterm_mouse_vers;
3616
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003617#if defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)
Bram Moolenaara06afc72018-08-27 23:24:16 +02003618 if (!on)
3619 // Make sure not tracing mouse movements. Important when a button-down
3620 // was received but no release yet.
3621 stop_xterm_trace();
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003622#endif
Bram Moolenaara06afc72018-08-27 23:24:16 +02003623
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003624 if (on == mouse_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003625#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003626 && p_bevalterm == bevalterm_ison
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003627#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003628 )
Bram Moolenaar0f873732019-12-05 20:28:46 +01003629 // return quickly if nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 return;
3631
3632 xterm_mouse_vers = use_xterm_mouse();
Bram Moolenaarc8427482011-10-20 21:09:35 +02003633
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003634#ifdef FEAT_MOUSE_URXVT
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003635 if (ttym_flags == TTYM_URXVT)
3636 {
Bram Moolenaarc8427482011-10-20 21:09:35 +02003637 out_str_nf((char_u *)
3638 (on
3639 ? IF_EB("\033[?1015h", ESC_STR "[?1015h")
3640 : IF_EB("\033[?1015l", ESC_STR "[?1015l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003641 mouse_ison = on;
Bram Moolenaarc8427482011-10-20 21:09:35 +02003642 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003643#endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003644
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003645 if (ttym_flags == TTYM_SGR)
3646 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003647 // SGR mode supports columns above 223
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003648 out_str_nf((char_u *)
3649 (on
3650 ? IF_EB("\033[?1006h", ESC_STR "[?1006h")
3651 : IF_EB("\033[?1006l", ESC_STR "[?1006l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003652 mouse_ison = on;
3653 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003654
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003655#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003656 if (bevalterm_ison != (p_bevalterm && on))
3657 {
3658 bevalterm_ison = (p_bevalterm && on);
3659 if (xterm_mouse_vers > 1 && !bevalterm_ison)
Bram Moolenaar0f873732019-12-05 20:28:46 +01003660 // disable mouse movement events, enabling is below
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003661 out_str_nf((char_u *)
3662 (IF_EB("\033[?1003l", ESC_STR "[?1003l")));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003663 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003664#endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003665
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 if (xterm_mouse_vers > 0)
3667 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003668 if (on) // enable mouse events, use mouse tracking if available
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 out_str_nf((char_u *)
3670 (xterm_mouse_vers > 1
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003671 ? (
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003672#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003673 bevalterm_ison
3674 ? IF_EB("\033[?1003h", ESC_STR "[?1003h") :
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003675#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003676 IF_EB("\033[?1002h", ESC_STR "[?1002h"))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 : IF_EB("\033[?1000h", ESC_STR "[?1000h")));
Bram Moolenaar0f873732019-12-05 20:28:46 +01003678 else // disable mouse events, could probably always send the same
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 out_str_nf((char_u *)
3680 (xterm_mouse_vers > 1
3681 ? IF_EB("\033[?1002l", ESC_STR "[?1002l")
3682 : IF_EB("\033[?1000l", ESC_STR "[?1000l")));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003683 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 }
3685
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003686#ifdef FEAT_MOUSE_DEC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 else if (ttym_flags == TTYM_DEC)
3688 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003689 if (on) // enable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 out_str_nf((char_u *)"\033[1;2'z\033[1;3'{");
Bram Moolenaar0f873732019-12-05 20:28:46 +01003691 else // disable mouse events
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 out_str_nf((char_u *)"\033['z");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003693 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003695#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003697#ifdef FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 else
3699 {
3700 if (on)
3701 {
3702 if (gpm_open())
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003703 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 }
3705 else
3706 {
3707 gpm_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003708 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 }
3710 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003711#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003713#ifdef FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003714 else
3715 {
3716 if (on)
3717 {
3718 if (sysmouse_open() == OK)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003719 mouse_ison = TRUE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003720 }
3721 else
3722 {
3723 sysmouse_close();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003724 mouse_ison = FALSE;
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003725 }
3726 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003727#endif
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003728
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003729#ifdef FEAT_MOUSE_JSB
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 else
3731 {
3732 if (on)
3733 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003734 // D - Enable Mouse up/down messages
3735 // L - Enable Left Button Reporting
3736 // M - Enable Middle Button Reporting
3737 // R - Enable Right Button Reporting
3738 // K - Enable SHIFT and CTRL key Reporting
3739 // + - Enable Advanced messaging of mouse moves and up/down messages
3740 // Q - Quiet No Ack
3741 // # - Numeric value of mouse pointer required
3742 // 0 = Multiview 2000 cursor, used as standard
3743 // 1 = Windows Arrow
3744 // 2 = Windows I Beam
3745 // 3 = Windows Hour Glass
3746 // 4 = Windows Cross Hair
3747 // 5 = Windows UP Arrow
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003748# ifdef JSBTERM_MOUSE_NONADVANCED
Bram Moolenaar0f873732019-12-05 20:28:46 +01003749 // Disables full feedback of pointer movements
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 out_str_nf((char_u *)IF_EB("\033[0~ZwLMRK1Q\033\\",
3751 ESC_STR "[0~ZwLMRK1Q" ESC_STR "\\"));
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003752# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 out_str_nf((char_u *)IF_EB("\033[0~ZwLMRK+1Q\033\\",
3754 ESC_STR "[0~ZwLMRK+1Q" ESC_STR "\\"));
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003755# endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003756 mouse_ison = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 }
3758 else
3759 {
3760 out_str_nf((char_u *)IF_EB("\033[0~ZwQ\033\\",
3761 ESC_STR "[0~ZwQ" ESC_STR "\\"));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003762 mouse_ison = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 }
3764 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003765#endif
3766#ifdef FEAT_MOUSE_PTERM
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 else
3768 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003769 // 1 = button press, 6 = release, 7 = drag, 1h...9l = right button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 if (on)
3771 out_str_nf("\033[>1h\033[>6h\033[>7h\033[>1h\033[>9l");
3772 else
3773 out_str_nf("\033[>1l\033[>6l\033[>7l\033[>1l\033[>9h");
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003774 mouse_ison = on;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 }
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02003776#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777}
3778
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01003779#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003780/*
3781 * Called when 'balloonevalterm' changed.
3782 */
3783 void
3784mch_bevalterm_changed(void)
3785{
3786 mch_setmouse(mouse_ison);
3787}
3788#endif
3789
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790/*
3791 * Set the mouse termcode, depending on the 'term' and 'ttymouse' options.
3792 */
3793 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003794check_mouse_termcode(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795{
3796# ifdef FEAT_MOUSE_XTERM
3797 if (use_xterm_mouse()
Bram Moolenaarc8427482011-10-20 21:09:35 +02003798# ifdef FEAT_MOUSE_URXVT
3799 && use_xterm_mouse() != 3
3800# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801# ifdef FEAT_GUI
3802 && !gui.in_use
3803# endif
3804 )
3805 {
3806 set_mouse_termcode(KS_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003807 ? IF_EB("\233M", CSI_STR "M")
3808 : IF_EB("\033[M", ESC_STR "[M")));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 if (*p_mouse != NUL)
3810 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01003811 // force mouse off and maybe on to send possibly new mouse
3812 // activation sequence to the xterm, with(out) drag tracing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 mch_setmouse(FALSE);
3814 setmouse();
3815 }
3816 }
3817 else
3818 del_mouse_termcode(KS_MOUSE);
3819# endif
3820
3821# ifdef FEAT_MOUSE_GPM
3822 if (!use_xterm_mouse()
3823# ifdef FEAT_GUI
3824 && !gui.in_use
3825# endif
3826 )
Bram Moolenaarbedf0912019-05-04 16:58:45 +02003827 set_mouse_termcode(KS_GPM_MOUSE,
3828 (char_u *)IF_EB("\033MG", ESC_STR "MG"));
3829 else
3830 del_mouse_termcode(KS_GPM_MOUSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831# endif
3832
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003833# ifdef FEAT_SYSMOUSE
3834 if (!use_xterm_mouse()
3835# ifdef FEAT_GUI
3836 && !gui.in_use
3837# endif
3838 )
3839 set_mouse_termcode(KS_MOUSE, (char_u *)IF_EB("\033MS", ESC_STR "MS"));
3840# endif
3841
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842# ifdef FEAT_MOUSE_JSB
Bram Moolenaar0f873732019-12-05 20:28:46 +01003843 // Conflicts with xterm mouse: "\033[" and "\033[M" ???
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 if (!use_xterm_mouse()
3845# ifdef FEAT_GUI
3846 && !gui.in_use
3847# endif
3848 )
3849 set_mouse_termcode(KS_JSBTERM_MOUSE,
3850 (char_u *)IF_EB("\033[0~zw", ESC_STR "[0~zw"));
3851 else
3852 del_mouse_termcode(KS_JSBTERM_MOUSE);
3853# endif
3854
3855# ifdef FEAT_MOUSE_NET
Bram Moolenaar0f873732019-12-05 20:28:46 +01003856 // There is no conflict, but one may type "ESC }" from Insert mode. Don't
3857 // define it in the GUI or when using an xterm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 if (!use_xterm_mouse()
3859# ifdef FEAT_GUI
3860 && !gui.in_use
3861# endif
3862 )
3863 set_mouse_termcode(KS_NETTERM_MOUSE,
3864 (char_u *)IF_EB("\033}", ESC_STR "}"));
3865 else
3866 del_mouse_termcode(KS_NETTERM_MOUSE);
3867# endif
3868
3869# ifdef FEAT_MOUSE_DEC
Bram Moolenaar0f873732019-12-05 20:28:46 +01003870 // Conflicts with xterm mouse: "\033[" and "\033[M"
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003871 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872# ifdef FEAT_GUI
3873 && !gui.in_use
3874# endif
3875 )
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00003876 set_mouse_termcode(KS_DEC_MOUSE, (char_u *)(term_is_8bit(T_NAME)
3877 ? IF_EB("\233", CSI_STR) : IF_EB("\033[", ESC_STR "[")));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 else
3879 del_mouse_termcode(KS_DEC_MOUSE);
3880# endif
3881# ifdef FEAT_MOUSE_PTERM
Bram Moolenaar0f873732019-12-05 20:28:46 +01003882 // same conflict as the dec mouse
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003883 if (!use_xterm_mouse()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884# ifdef FEAT_GUI
3885 && !gui.in_use
3886# endif
3887 )
3888 set_mouse_termcode(KS_PTERM_MOUSE,
3889 (char_u *) IF_EB("\033[", ESC_STR "["));
3890 else
3891 del_mouse_termcode(KS_PTERM_MOUSE);
3892# endif
Bram Moolenaarc8427482011-10-20 21:09:35 +02003893# ifdef FEAT_MOUSE_URXVT
Bram Moolenaarcbc17d62014-05-22 21:22:19 +02003894 if (use_xterm_mouse() == 3
Bram Moolenaarc8427482011-10-20 21:09:35 +02003895# ifdef FEAT_GUI
3896 && !gui.in_use
3897# endif
3898 )
3899 {
3900 set_mouse_termcode(KS_URXVT_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaara529ce02017-06-22 22:37:57 +02003901 ? IF_EB("\233*M", CSI_STR "*M")
3902 : IF_EB("\033[*M", ESC_STR "[*M")));
Bram Moolenaarc8427482011-10-20 21:09:35 +02003903
3904 if (*p_mouse != NUL)
3905 {
3906 mch_setmouse(FALSE);
3907 setmouse();
3908 }
3909 }
3910 else
3911 del_mouse_termcode(KS_URXVT_MOUSE);
3912# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003913 if (use_xterm_mouse() == 4
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01003914# ifdef FEAT_GUI
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003915 && !gui.in_use
Bram Moolenaar2ace1bd2019-03-22 12:03:30 +01003916# endif
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003917 )
3918 {
3919 set_mouse_termcode(KS_SGR_MOUSE, (char_u *)(term_is_8bit(T_NAME)
Bram Moolenaara529ce02017-06-22 22:37:57 +02003920 ? IF_EB("\233<*M", CSI_STR "<*M")
3921 : IF_EB("\033[<*M", ESC_STR "[<*M")));
3922
3923 set_mouse_termcode(KS_SGR_MOUSE_RELEASE, (char_u *)(term_is_8bit(T_NAME)
3924 ? IF_EB("\233<*m", CSI_STR "<*m")
3925 : IF_EB("\033[<*m", ESC_STR "[<*m")));
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003926
3927 if (*p_mouse != NUL)
3928 {
3929 mch_setmouse(FALSE);
3930 setmouse();
3931 }
3932 }
3933 else
Bram Moolenaara529ce02017-06-22 22:37:57 +02003934 {
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02003935 del_mouse_termcode(KS_SGR_MOUSE);
Bram Moolenaara529ce02017-06-22 22:37:57 +02003936 del_mouse_termcode(KS_SGR_MOUSE_RELEASE);
3937 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940#ifndef VMS
3941
3942/*
3943 * Try to get the current window size:
3944 * 1. with an ioctl(), most accurate method
3945 * 2. from the environment variables LINES and COLUMNS
3946 * 3. from the termcap
3947 * 4. keep using the old values
3948 * Return OK when size could be determined, FAIL otherwise.
3949 */
3950 int
Bram Moolenaar05540972016-01-30 20:31:25 +01003951mch_get_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952{
3953 long rows = 0;
3954 long columns = 0;
3955 char_u *p;
3956
3957 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 * 1. try using an ioctl. It is the most accurate method.
3959 *
3960 * Try using TIOCGWINSZ first, some systems that have it also define
3961 * TIOCGSIZE but don't have a struct ttysize.
3962 */
3963# ifdef TIOCGWINSZ
3964 {
3965 struct winsize ws;
3966 int fd = 1;
3967
Bram Moolenaar0f873732019-12-05 20:28:46 +01003968 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 if (!isatty(fd) && isatty(read_cmd_fd))
3970 fd = read_cmd_fd;
3971 if (ioctl(fd, TIOCGWINSZ, &ws) == 0)
3972 {
3973 columns = ws.ws_col;
3974 rows = ws.ws_row;
3975 }
3976 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01003977# else // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978# ifdef TIOCGSIZE
3979 {
3980 struct ttysize ts;
3981 int fd = 1;
3982
Bram Moolenaar0f873732019-12-05 20:28:46 +01003983 // When stdout is not a tty, use stdin for the ioctl().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 if (!isatty(fd) && isatty(read_cmd_fd))
3985 fd = read_cmd_fd;
3986 if (ioctl(fd, TIOCGSIZE, &ts) == 0)
3987 {
3988 columns = ts.ts_cols;
3989 rows = ts.ts_lines;
3990 }
3991 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01003992# endif // TIOCGSIZE
3993# endif // TIOCGWINSZ
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994
3995 /*
3996 * 2. get size from environment
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003997 * When being POSIX compliant ('|' flag in 'cpoptions') this overrules
3998 * the ioctl() values!
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004000 if (columns == 0 || rows == 0 || vim_strchr(p_cpo, CPO_TSIZE) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 {
4002 if ((p = (char_u *)getenv("LINES")))
4003 rows = atoi((char *)p);
4004 if ((p = (char_u *)getenv("COLUMNS")))
4005 columns = atoi((char *)p);
4006 }
4007
4008#ifdef HAVE_TGETENT
4009 /*
4010 * 3. try reading "co" and "li" entries from termcap
4011 */
4012 if (columns == 0 || rows == 0)
4013 getlinecol(&columns, &rows);
4014#endif
4015
4016 /*
4017 * 4. If everything fails, use the old values
4018 */
4019 if (columns <= 0 || rows <= 0)
4020 return FAIL;
4021
4022 Rows = rows;
4023 Columns = columns;
Bram Moolenaare057d402013-06-30 17:51:51 +02004024 limit_screen_size();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 return OK;
4026}
4027
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004028#if defined(FEAT_TERMINAL) || defined(PROTO)
4029/*
4030 * Report the windows size "rows" and "cols" to tty "fd".
4031 */
4032 int
4033mch_report_winsize(int fd, int rows, int cols)
4034{
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004035 int tty_fd;
4036 int retval = -1;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004037
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004038 tty_fd = get_tty_fd(fd);
4039 if (tty_fd >= 0)
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004040 {
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004041# if defined(TIOCSWINSZ)
4042 struct winsize ws;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004043
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004044 ws.ws_col = cols;
4045 ws.ws_row = rows;
4046 ws.ws_xpixel = cols * 5;
4047 ws.ws_ypixel = rows * 10;
4048 retval = ioctl(tty_fd, TIOCSWINSZ, &ws);
4049 ch_log(NULL, "ioctl(TIOCSWINSZ) %s",
4050 retval == 0 ? "success" : "failed");
4051# elif defined(TIOCSSIZE)
4052 struct ttysize ts;
4053
4054 ts.ts_cols = cols;
4055 ts.ts_lines = rows;
4056 retval = ioctl(tty_fd, TIOCSSIZE, &ts);
4057 ch_log(NULL, "ioctl(TIOCSSIZE) %s",
4058 retval == 0 ? "success" : "failed");
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004059# endif
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004060 if (tty_fd != fd)
4061 close(tty_fd);
4062 }
4063 return retval == 0 ? OK : FAIL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02004064}
4065#endif
4066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067/*
4068 * Try to set the window size to Rows and Columns.
4069 */
4070 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004071mch_set_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072{
4073 if (*T_CWS)
4074 {
4075 /*
4076 * NOTE: if you get an error here that term_set_winsize() is
4077 * undefined, check the output of configure. It could probably not
4078 * find a ncurses, termcap or termlib library.
4079 */
4080 term_set_winsize((int)Rows, (int)Columns);
4081 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01004082 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 }
4084}
4085
Bram Moolenaar0f873732019-12-05 20:28:46 +01004086#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087
4088/*
4089 * Rows and/or Columns has changed.
4090 */
4091 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004092mch_new_shellsize(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093{
Bram Moolenaar0f873732019-12-05 20:28:46 +01004094 // Nothing to do.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095}
4096
Bram Moolenaar205b8862011-09-07 15:04:31 +02004097/*
4098 * Wait for process "child" to end.
4099 * Return "child" if it exited properly, <= 0 on error.
4100 */
4101 static pid_t
Bram Moolenaar05540972016-01-30 20:31:25 +01004102wait4pid(pid_t child, waitstatus *status)
Bram Moolenaar205b8862011-09-07 15:04:31 +02004103{
4104 pid_t wait_pid = 0;
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004105 long delay_msec = 1;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004106
4107 while (wait_pid != child)
4108 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004109 // When compiled with Python threads are probably used, in which case
4110 // wait() sometimes hangs for no obvious reason. Use waitpid()
4111 // instead and loop (like the GUI). Also needed for other interfaces,
4112 // they might call system().
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004113# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02004114 wait_pid = wait4(child, status, WNOHANG, (struct rusage *)0);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004115# else
Bram Moolenaar205b8862011-09-07 15:04:31 +02004116 wait_pid = waitpid(child, status, WNOHANG);
Bram Moolenaar6be120e2012-04-20 15:55:16 +02004117# endif
Bram Moolenaar205b8862011-09-07 15:04:31 +02004118 if (wait_pid == 0)
4119 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004120 // Wait for 1 to 10 msec before trying again.
Bram Moolenaar0abe0522016-08-28 16:53:12 +02004121 mch_delay(delay_msec, TRUE);
4122 if (++delay_msec > 10)
4123 delay_msec = 10;
Bram Moolenaar205b8862011-09-07 15:04:31 +02004124 continue;
4125 }
Bram Moolenaar205b8862011-09-07 15:04:31 +02004126 if (wait_pid <= 0
4127# ifdef ECHILD
4128 && errno == ECHILD
4129# endif
4130 )
4131 break;
4132 }
4133 return wait_pid;
4134}
4135
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01004136#if !defined(USE_SYSTEM) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar7da34602017-08-01 17:14:21 +02004137/*
4138 * Set the environment for a child process.
4139 */
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004140 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004141set_child_environment(
4142 long rows,
4143 long columns,
4144 char *term,
4145 int is_terminal UNUSED)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004146{
4147# ifdef HAVE_SETENV
4148 char envbuf[50];
4149# else
Bram Moolenaar5f7e7bd2017-07-22 14:08:43 +02004150 static char envbuf_Term[30];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004151 static char envbuf_Rows[20];
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004152 static char envbuf_Lines[20];
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004153 static char envbuf_Columns[20];
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004154 static char envbuf_Colors[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004155# ifdef FEAT_TERMINAL
Bram Moolenaard7a137f2018-06-12 18:05:24 +02004156 static char envbuf_Version[20];
Bram Moolenaar493359e2018-06-12 20:25:52 +02004157# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004158# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004159 static char envbuf_Servername[60];
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004160# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004161# endif
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004162 long colors =
4163# ifdef FEAT_GUI
4164 gui.in_use ? 256*256*256 :
4165# endif
4166 t_colors;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004167
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004168# ifdef HAVE_SETENV
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004169 setenv("TERM", term, 1);
4170 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004171 setenv("ROWS", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004172 sprintf((char *)envbuf, "%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004173 setenv("LINES", (char *)envbuf, 1);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004174 sprintf((char *)envbuf, "%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004175 setenv("COLUMNS", (char *)envbuf, 1);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004176 sprintf((char *)envbuf, "%ld", colors);
4177 setenv("COLORS", (char *)envbuf, 1);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004178# ifdef FEAT_TERMINAL
4179 if (is_terminal)
4180 {
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004181 sprintf((char *)envbuf, "%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004182 setenv("VIM_TERMINAL", (char *)envbuf, 1);
4183 }
4184# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004185# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004186 setenv("VIM_SERVERNAME", serverName == NULL ? "" : (char *)serverName, 1);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004187# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004188# else
4189 /*
4190 * Putenv does not copy the string, it has to remain valid.
4191 * Use a static array to avoid losing allocated memory.
Bram Moolenaar7da34602017-08-01 17:14:21 +02004192 * This won't work well when running multiple children...
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004193 */
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004194 vim_snprintf(envbuf_Term, sizeof(envbuf_Term), "TERM=%s", term);
4195 putenv(envbuf_Term);
4196 vim_snprintf(envbuf_Rows, sizeof(envbuf_Rows), "ROWS=%ld", rows);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004197 putenv(envbuf_Rows);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004198 vim_snprintf(envbuf_Lines, sizeof(envbuf_Lines), "LINES=%ld", rows);
4199 putenv(envbuf_Lines);
4200 vim_snprintf(envbuf_Columns, sizeof(envbuf_Columns),
4201 "COLUMNS=%ld", columns);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004202 putenv(envbuf_Columns);
Bram Moolenaarb7a8dfe2017-07-22 20:33:05 +02004203 vim_snprintf(envbuf_Colors, sizeof(envbuf_Colors), "COLORS=%ld", colors);
4204 putenv(envbuf_Colors);
Bram Moolenaar493359e2018-06-12 20:25:52 +02004205# ifdef FEAT_TERMINAL
4206 if (is_terminal)
4207 {
4208 vim_snprintf(envbuf_Version, sizeof(envbuf_Version),
Bram Moolenaar5ecdf962018-06-13 20:49:50 +02004209 "VIM_TERMINAL=%ld", (long)get_vim_var_nr(VV_VERSION));
Bram Moolenaar493359e2018-06-12 20:25:52 +02004210 putenv(envbuf_Version);
4211 }
4212# endif
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004213# ifdef FEAT_CLIENTSERVER
Bram Moolenaar7da34602017-08-01 17:14:21 +02004214 vim_snprintf(envbuf_Servername, sizeof(envbuf_Servername),
4215 "VIM_SERVERNAME=%s", serverName == NULL ? "" : (char *)serverName);
4216 putenv(envbuf_Servername);
Bram Moolenaar2a4f06f2017-08-01 18:44:29 +02004217# endif
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004218# endif
4219}
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004220
4221 static void
Bram Moolenaar493359e2018-06-12 20:25:52 +02004222set_default_child_environment(int is_terminal)
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004223{
Bram Moolenaar493359e2018-06-12 20:25:52 +02004224 set_child_environment(Rows, Columns, "dumb", is_terminal);
Bram Moolenaar58556cd2017-07-20 23:04:46 +02004225}
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004226#endif
4227
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004228#if defined(FEAT_GUI) || defined(FEAT_JOB_CHANNEL)
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004229/*
4230 * Open a PTY, with FD for the master and slave side.
4231 * When failing "pty_master_fd" and "pty_slave_fd" are -1.
Bram Moolenaar59386482019-02-10 22:43:46 +01004232 * When successful both file descriptors are stored and the allocated pty name
4233 * is stored in both "*name1" and "*name2".
Bram Moolenaar979e8c52017-08-01 15:08:07 +02004234 */
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004235 static void
Bram Moolenaar59386482019-02-10 22:43:46 +01004236open_pty(int *pty_master_fd, int *pty_slave_fd, char_u **name1, char_u **name2)
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004237{
4238 char *tty_name;
4239
Bram Moolenaar59386482019-02-10 22:43:46 +01004240 if (name1 != NULL)
4241 *name1 = NULL;
4242 if (name2 != NULL)
4243 *name2 = NULL;
4244
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004245 *pty_master_fd = mch_openpty(&tty_name); // open pty
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004246 if (*pty_master_fd >= 0)
4247 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004248 // Leaving out O_NOCTTY may lead to waitpid() always returning
4249 // 0 on Mac OS X 10.7 thereby causing freezes. Let's assume
4250 // adding O_NOCTTY always works when defined.
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004251#ifdef O_NOCTTY
4252 *pty_slave_fd = open(tty_name, O_RDWR | O_NOCTTY | O_EXTRA, 0);
4253#else
4254 *pty_slave_fd = open(tty_name, O_RDWR | O_EXTRA, 0);
4255#endif
4256 if (*pty_slave_fd < 0)
4257 {
4258 close(*pty_master_fd);
4259 *pty_master_fd = -1;
4260 }
Bram Moolenaar59386482019-02-10 22:43:46 +01004261 else
4262 {
4263 if (name1 != NULL)
4264 *name1 = vim_strsave((char_u *)tty_name);
4265 if (name2 != NULL)
4266 *name2 = vim_strsave((char_u *)tty_name);
4267 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02004268 }
4269}
4270#endif
4271
Bram Moolenaarfae42832017-08-01 22:24:26 +02004272/*
4273 * Send SIGINT to a child process if "c" is an interrupt character.
4274 */
Bram Moolenaar840d16f2019-09-10 21:27:18 +02004275 static void
Bram Moolenaarfae42832017-08-01 22:24:26 +02004276may_send_sigint(int c UNUSED, pid_t pid UNUSED, pid_t wpid UNUSED)
4277{
4278# ifdef SIGINT
4279 if (c == Ctrl_C || c == intr_char)
4280 {
4281# ifdef HAVE_SETSID
4282 kill(-pid, SIGINT);
4283# else
4284 kill(0, SIGINT);
4285# endif
4286 if (wpid > 0)
4287 kill(wpid, SIGINT);
4288 }
4289# endif
4290}
4291
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004292#if !defined(USE_SYSTEM) || defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaar13568252018-03-16 20:46:58 +01004293
Bram Moolenaar0f873732019-12-05 20:28:46 +01004294/*
4295 * Parse "cmd" and return the result in "argvp" which is an allocated array of
4296 * pointers, the last one is NULL.
4297 * The "sh_tofree" and "shcf_tofree" must be later freed by the caller.
4298 */
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004299 int
4300unix_build_argv(
Bram Moolenaar13568252018-03-16 20:46:58 +01004301 char_u *cmd,
4302 char ***argvp,
4303 char_u **sh_tofree,
4304 char_u **shcf_tofree)
4305{
4306 char **argv = NULL;
4307 int argc;
4308
4309 *sh_tofree = vim_strsave(p_sh);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004310 if (*sh_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004311 return FAIL;
4312
4313 if (mch_parse_cmd(*sh_tofree, TRUE, &argv, &argc) == FAIL)
4314 return FAIL;
4315 *argvp = argv;
4316
4317 if (cmd != NULL)
4318 {
4319 char_u *s;
4320 char_u *p;
4321
4322 if (extra_shell_arg != NULL)
4323 argv[argc++] = (char *)extra_shell_arg;
4324
Bram Moolenaar0f873732019-12-05 20:28:46 +01004325 // Break 'shellcmdflag' into white separated parts. This doesn't
4326 // handle quoted strings, they are very unlikely to appear.
Bram Moolenaar964b3742019-05-24 18:54:09 +02004327 *shcf_tofree = alloc(STRLEN(p_shcf) + 1);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004328 if (*shcf_tofree == NULL) // out of memory
Bram Moolenaar13568252018-03-16 20:46:58 +01004329 return FAIL;
4330 s = *shcf_tofree;
4331 p = p_shcf;
4332 while (*p != NUL)
4333 {
4334 argv[argc++] = (char *)s;
4335 while (*p && *p != ' ' && *p != TAB)
4336 *s++ = *p++;
4337 *s++ = NUL;
4338 p = skipwhite(p);
4339 }
4340
4341 argv[argc++] = (char *)cmd;
4342 }
4343 argv[argc] = NULL;
4344 return OK;
4345}
4346#endif
4347
4348#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
4349/*
4350 * Use a terminal window to run a shell command in.
4351 */
4352 static int
4353mch_call_shell_terminal(
4354 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004355 int options UNUSED) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004356{
4357 jobopt_T opt;
4358 char **argv = NULL;
4359 char_u *tofree1 = NULL;
4360 char_u *tofree2 = NULL;
4361 int retval = -1;
4362 buf_T *buf;
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004363 job_T *job;
Bram Moolenaar13568252018-03-16 20:46:58 +01004364 aco_save_T aco;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004365 oparg_T oa; // operator arguments
Bram Moolenaar13568252018-03-16 20:46:58 +01004366
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004367 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar13568252018-03-16 20:46:58 +01004368 goto theend;
4369
4370 init_job_options(&opt);
4371 ch_log(NULL, "starting terminal for system command '%s'", cmd);
4372 buf = term_start(NULL, argv, &opt, TERM_START_SYSTEM);
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004373 if (buf == NULL)
4374 goto theend;
4375
4376 job = term_getjob(buf->b_term);
4377 ++job->jv_refcount;
Bram Moolenaar13568252018-03-16 20:46:58 +01004378
Bram Moolenaar0f873732019-12-05 20:28:46 +01004379 // Find a window to make "buf" curbuf.
Bram Moolenaar13568252018-03-16 20:46:58 +01004380 aucmd_prepbuf(&aco, buf);
4381
4382 clear_oparg(&oa);
4383 while (term_use_loop())
4384 {
4385 if (oa.op_type == OP_NOP && oa.regname == NUL && !VIsual_active)
4386 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004387 // If terminal_loop() returns OK we got a key that is handled
4388 // in Normal model. We don't do redrawing anyway.
Bram Moolenaar13568252018-03-16 20:46:58 +01004389 if (terminal_loop(TRUE) == OK)
4390 normal_cmd(&oa, TRUE);
4391 }
4392 else
4393 normal_cmd(&oa, TRUE);
4394 }
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004395 retval = job->jv_exitval;
Bram Moolenaar13568252018-03-16 20:46:58 +01004396 ch_log(NULL, "system command finished");
4397
Bram Moolenaarf9c38832018-06-19 19:59:20 +02004398 job_unref(job);
4399
Bram Moolenaar0f873732019-12-05 20:28:46 +01004400 // restore curwin/curbuf and a few other things
Bram Moolenaar13568252018-03-16 20:46:58 +01004401 aucmd_restbuf(&aco);
4402
4403 wait_return(TRUE);
4404 do_buffer(DOBUF_WIPE, DOBUF_FIRST, FORWARD, buf->b_fnum, TRUE);
4405
4406theend:
4407 vim_free(argv);
4408 vim_free(tofree1);
4409 vim_free(tofree2);
4410 return retval;
4411}
4412#endif
4413
4414#ifdef USE_SYSTEM
4415/*
4416 * Use system() to start the shell: simple but slow.
4417 */
4418 static int
4419mch_call_shell_system(
Bram Moolenaar05540972016-01-30 20:31:25 +01004420 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004421 int options) // SHELL_*, see vim.h
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422{
4423#ifdef VMS
4424 char *ifn = NULL;
4425 char *ofn = NULL;
4426#endif
4427 int tmode = cur_tmode;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004428 char_u *newcmd; // only needed for unix
Bram Moolenaarde5e2c22016-11-04 20:35:31 +01004429 int x;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430
4431 out_flush();
4432
4433 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004434 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435
Bram Moolenaar62b42182010-09-21 22:09:37 +02004436# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004437 save_clipboard();
Bram Moolenaar62b42182010-09-21 22:09:37 +02004438 loose_clipboard();
4439# endif
4440
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 if (cmd == NULL)
4442 x = system((char *)p_sh);
4443 else
4444 {
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004445# ifdef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 if (ofn = strchr((char *)cmd, '>'))
4447 *ofn++ = '\0';
4448 if (ifn = strchr((char *)cmd, '<'))
4449 {
4450 char *p;
4451
4452 *ifn++ = '\0';
Bram Moolenaar0f873732019-12-05 20:28:46 +01004453 p = strchr(ifn,' '); // chop off any trailing spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 if (p)
4455 *p = '\0';
4456 }
4457 if (ofn)
4458 x = vms_sys((char *)cmd, ofn, ifn);
4459 else
4460 x = system((char *)cmd);
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004461# else
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004462 newcmd = alloc(STRLEN(p_sh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 + (extra_shell_arg == NULL ? 0 : STRLEN(extra_shell_arg))
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02004464 + STRLEN(p_shcf) + STRLEN(cmd) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 if (newcmd == NULL)
4466 x = 0;
4467 else
4468 {
4469 sprintf((char *)newcmd, "%s %s %s %s", p_sh,
4470 extra_shell_arg == NULL ? "" : (char *)extra_shell_arg,
4471 (char *)p_shcf,
4472 (char *)cmd);
4473 x = system((char *)newcmd);
4474 vim_free(newcmd);
4475 }
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004476# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 }
4478# ifdef VMS
4479 x = vms_sys_status(x);
4480# endif
4481 if (emsg_silent)
4482 ;
4483 else if (x == 127)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004484 msg_puts(_("\nCannot execute shell sh\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 else if (x && !(options & SHELL_SILENT))
4486 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004487 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 msg_outnum((long)x);
4489 msg_putchar('\n');
4490 }
4491
4492 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004493 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494# ifdef FEAT_TITLE
4495 resettitle();
4496# endif
Bram Moolenaar1a0316c2013-03-13 17:50:25 +01004497# if defined(FEAT_CLIPBOARD) && defined(FEAT_X11)
4498 restore_clipboard();
4499# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 return x;
Bram Moolenaar13568252018-03-16 20:46:58 +01004501}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502
Bram Moolenaar0f873732019-12-05 20:28:46 +01004503#else // USE_SYSTEM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504
Bram Moolenaar0f873732019-12-05 20:28:46 +01004505# define EXEC_FAILED 122 // Exit code when shell didn't execute. Don't use
4506 // 127, some shells use that already
4507# define OPEN_NULL_FAILED 123 // Exit code if /dev/null can't be opened
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
Bram Moolenaar13568252018-03-16 20:46:58 +01004509/*
4510 * Don't use system(), use fork()/exec().
4511 */
4512 static int
4513mch_call_shell_fork(
4514 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01004515 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01004516{
4517 int tmode = cur_tmode;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 pid_t pid;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004519 pid_t wpid = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 pid_t wait_pid = 0;
4521# ifdef HAVE_UNION_WAIT
4522 union wait status;
4523# else
4524 int status = -1;
4525# endif
4526 int retval = -1;
4527 char **argv = NULL;
Bram Moolenaar13568252018-03-16 20:46:58 +01004528 char_u *tofree1 = NULL;
4529 char_u *tofree2 = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 int i;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004531 int pty_master_fd = -1; // for pty's
Bram Moolenaardf177f62005-02-22 08:39:57 +00004532# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 int pty_slave_fd = -1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004534# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01004535 int fd_toshell[2]; // for pipes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 int fd_fromshell[2];
4537 int pipe_error = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004538 int did_settmode = FALSE; // settmode(TMODE_RAW) called
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539
4540 out_flush();
4541 if (options & SHELL_COOKED)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004542 settmode(TMODE_COOK); // set to normal mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543
Bram Moolenaar197c6b72019-11-03 23:37:12 +01004544 if (unix_build_argv(cmd, &argv, &tofree1, &tofree2) == FAIL)
Bram Moolenaar835dc632016-02-07 14:27:38 +01004545 goto error;
Bram Moolenaarea35ef62011-08-04 22:59:28 +02004546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 /*
Bram Moolenaardf177f62005-02-22 08:39:57 +00004548 * For the GUI, when writing the output into the buffer and when reading
4549 * input from the buffer: Try using a pseudo-tty to get the stdin/stdout
4550 * of the executed command into the Vim window. Or use a pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004552 if ((options & (SHELL_READ|SHELL_WRITE))
4553# ifdef FEAT_GUI
4554 || (gui.in_use && show_shell_mess)
4555# endif
4556 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004558# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 /*
4560 * Try to open a master pty.
4561 * If this works, open the slave pty.
4562 * If the slave can't be opened, close the master pty.
4563 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004564 if (p_guipty && !(options & (SHELL_READ|SHELL_WRITE)))
Bram Moolenaar59386482019-02-10 22:43:46 +01004565 open_pty(&pty_master_fd, &pty_slave_fd, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 /*
4567 * If not opening a pty or it didn't work, try using pipes.
4568 */
4569 if (pty_master_fd < 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004570# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 {
4572 pipe_error = (pipe(fd_toshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004573 if (!pipe_error) // pipe create OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 {
4575 pipe_error = (pipe(fd_fromshell) < 0);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004576 if (pipe_error) // pipe create failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 {
4578 close(fd_toshell[0]);
4579 close(fd_toshell[1]);
4580 }
4581 }
4582 if (pipe_error)
4583 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004584 msg_puts(_("\nCannot create pipes\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 out_flush();
4586 }
4587 }
4588 }
4589
Bram Moolenaar0f873732019-12-05 20:28:46 +01004590 if (!pipe_error) // pty or pipe opened or not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004592 SIGSET_DECL(curset)
4593
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594# ifdef __BEOS__
4595 beos_cleanup_read_thread();
4596# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004597
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004598 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004599 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004600 if (pid == -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 {
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004602 UNBLOCK_SIGNALS(&curset);
4603
Bram Moolenaar32526b32019-01-19 17:43:09 +01004604 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004605 if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004607 || (gui.in_use && show_shell_mess)
4608# endif
4609 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00004611# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01004612 if (pty_master_fd >= 0) // close the pseudo tty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 {
4614 close(pty_master_fd);
4615 close(pty_slave_fd);
4616 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004617 else // close the pipes
Bram Moolenaardf177f62005-02-22 08:39:57 +00004618# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 {
4620 close(fd_toshell[0]);
4621 close(fd_toshell[1]);
4622 close(fd_fromshell[0]);
4623 close(fd_fromshell[1]);
4624 }
4625 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004627 else if (pid == 0) // child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004629 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004630 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631
Bram Moolenaar819524702018-02-27 19:10:00 +01004632# ifdef FEAT_JOB_CHANNEL
4633 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01004634 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01004635 ch_logfile((char_u *)"", (char_u *)"");
4636# endif
4637
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 if (!show_shell_mess || (options & SHELL_EXPAND))
4639 {
4640 int fd;
4641
4642 /*
4643 * Don't want to show any message from the shell. Can't just
4644 * close stdout and stderr though, because some systems will
4645 * break if you try to write to them after that, so we must
4646 * use dup() to replace them with something else -- webb
4647 * Connect stdin to /dev/null too, so ":n `cat`" doesn't hang,
4648 * waiting for input.
4649 */
4650 fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
4651 fclose(stdin);
4652 fclose(stdout);
4653 fclose(stderr);
4654
4655 /*
4656 * If any of these open()'s and dup()'s fail, we just continue
4657 * anyway. It's not fatal, and on most systems it will make
4658 * no difference at all. On a few it will cause the execvp()
4659 * to exit with a non-zero status even when the completion
4660 * could be done, which is nothing too serious. If the open()
4661 * or dup() failed we'd just do the same thing ourselves
4662 * anyway -- webb
4663 */
4664 if (fd >= 0)
4665 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004666 vim_ignored = dup(fd); // To replace stdin (fd 0)
4667 vim_ignored = dup(fd); // To replace stdout (fd 1)
4668 vim_ignored = dup(fd); // To replace stderr (fd 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669
Bram Moolenaar0f873732019-12-05 20:28:46 +01004670 // Don't need this now that we've duplicated it
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 close(fd);
4672 }
4673 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004674 else if ((options & (SHELL_READ|SHELL_WRITE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675# ifdef FEAT_GUI
Bram Moolenaardf177f62005-02-22 08:39:57 +00004676 || gui.in_use
4677# endif
4678 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 {
4680
Bram Moolenaardf177f62005-02-22 08:39:57 +00004681# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01004682 // Create our own process group, so that the child and all its
4683 // children can be kill()ed. Don't do this when using pipes,
4684 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004685 if (p_stmp)
Bram Moolenaar07256082009-02-04 13:19:42 +00004686 {
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004687 (void)setsid();
Bram Moolenaar07256082009-02-04 13:19:42 +00004688# if defined(SIGHUP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004689 // When doing "!xterm&" and 'shell' is bash: the shell
4690 // will exit and send SIGHUP to all processes in its
4691 // group, killing the just started process. Ignore SIGHUP
4692 // to avoid that. (suggested by Simon Schubert)
Bram Moolenaar07256082009-02-04 13:19:42 +00004693 signal(SIGHUP, SIG_IGN);
4694# endif
4695 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004696# endif
4697# ifdef FEAT_GUI
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004698 if (pty_slave_fd >= 0)
4699 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004700 // push stream discipline modules
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004701 if (options & SHELL_COOKED)
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01004702 setup_slavepty(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01004704 // Try to become controlling tty (probably doesn't work,
4705 // unless run by root)
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004706 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707# endif
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004708 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004709# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02004710 set_default_child_environment(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711
Bram Moolenaara5792f52005-11-23 21:25:05 +00004712 /*
4713 * stderr is only redirected when using the GUI, so that a
4714 * program like gpg can still access the terminal to get a
4715 * passphrase using stderr.
4716 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004717# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 if (pty_master_fd >= 0)
4719 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004720 close(pty_master_fd); // close master side of pty
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721
Bram Moolenaar0f873732019-12-05 20:28:46 +01004722 // set up stdin/stdout/stderr for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004724 vim_ignored = dup(pty_slave_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004726 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004727 if (gui.in_use)
4728 {
4729 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004730 vim_ignored = dup(pty_slave_fd);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004731 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732
Bram Moolenaar0f873732019-12-05 20:28:46 +01004733 close(pty_slave_fd); // has been dupped, close it now
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 }
4735 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004736# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004738 // set up stdin for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 close(fd_toshell[1]);
4740 close(0);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004741 vim_ignored = dup(fd_toshell[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 close(fd_toshell[0]);
4743
Bram Moolenaar0f873732019-12-05 20:28:46 +01004744 // set up stdout for the child
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 close(fd_fromshell[0]);
4746 close(1);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004747 vim_ignored = dup(fd_fromshell[1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 close(fd_fromshell[1]);
4749
Bram Moolenaara5792f52005-11-23 21:25:05 +00004750# ifdef FEAT_GUI
4751 if (gui.in_use)
4752 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004753 // set up stderr for the child
Bram Moolenaara5792f52005-11-23 21:25:05 +00004754 close(2);
Bram Moolenaar42335f52018-09-13 15:33:43 +02004755 vim_ignored = dup(1);
Bram Moolenaara5792f52005-11-23 21:25:05 +00004756 }
4757# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 }
4759 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00004760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 /*
4762 * There is no type cast for the argv, because the type may be
4763 * different on different machines. This may cause a warning
4764 * message with strict compilers, don't worry about it.
4765 * Call _exit() instead of exit() to avoid closing the connection
4766 * to the X server (esp. with GTK, which uses atexit()).
4767 */
4768 execvp(argv[0], argv);
Bram Moolenaar0f873732019-12-05 20:28:46 +01004769 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004771 else // parent
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 {
4773 /*
4774 * While child is running, ignore terminating signals.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004775 * Do catch CTRL-C, so that "got_int" is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 */
4777 catch_signals(SIG_IGN, SIG_ERR);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004778 catch_int_signal();
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02004779 UNBLOCK_SIGNALS(&curset);
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01004780# ifdef FEAT_JOB_CHANNEL
4781 ++dont_check_job_ended;
4782# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 /*
4784 * For the GUI we redirect stdin, stdout and stderr to our window.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004785 * This is also used to pipe stdin/stdout to/from the external
4786 * command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00004788 if ((options & (SHELL_READ|SHELL_WRITE))
4789# ifdef FEAT_GUI
4790 || (gui.in_use && show_shell_mess)
4791# endif
4792 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004794# define BUFLEN 100 // length for buffer, pseudo tty limit is 128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 char_u buffer[BUFLEN + 1];
Bram Moolenaar0f873732019-12-05 20:28:46 +01004796 int buffer_off = 0; // valid bytes in buffer[]
4797 char_u ta_buf[BUFLEN + 1]; // TypeAHead
4798 int ta_len = 0; // valid bytes in ta_buf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 int len;
4800 int p_more_save;
4801 int old_State;
4802 int c;
4803 int toshell_fd;
4804 int fromshell_fd;
Bram Moolenaardf177f62005-02-22 08:39:57 +00004805 garray_T ga;
4806 int noread_cnt;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01004807# ifdef ELAPSED_FUNC
4808 elapsed_T start_tv;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004809# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810
Bram Moolenaardf177f62005-02-22 08:39:57 +00004811# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 if (pty_master_fd >= 0)
4813 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 fromshell_fd = pty_master_fd;
4815 toshell_fd = dup(pty_master_fd);
4816 }
4817 else
Bram Moolenaardf177f62005-02-22 08:39:57 +00004818# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 {
4820 close(fd_toshell[0]);
4821 close(fd_fromshell[1]);
4822 toshell_fd = fd_toshell[1];
4823 fromshell_fd = fd_fromshell[0];
4824 }
4825
4826 /*
4827 * Write to the child if there are typed characters.
4828 * Read from the child if there are characters available.
4829 * Repeat the reading a few times if more characters are
4830 * available. Need to check for typed keys now and then, but
4831 * not too often (delays when no chars are available).
4832 * This loop is quit if no characters can be read from the pty
4833 * (WaitForChar detected special condition), or there are no
4834 * characters available and the child has exited.
4835 * Only check if the child has exited when there is no more
4836 * output. The child may exit before all the output has
4837 * been printed.
4838 *
4839 * Currently this busy loops!
4840 * This can probably dead-lock when the write blocks!
4841 */
4842 p_more_save = p_more;
4843 p_more = FALSE;
4844 old_State = State;
Bram Moolenaar0f873732019-12-05 20:28:46 +01004845 State = EXTERNCMD; // don't redraw at window resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004847 if ((options & SHELL_WRITE) && toshell_fd >= 0)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004848 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004849 // Fork a process that will write the lines to the
4850 // external program.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004851 if ((wpid = fork()) == -1)
4852 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004853 msg_puts(_("\nCannot fork\n"));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004854 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004855 else if (wpid == 0) // child
Bram Moolenaardf177f62005-02-22 08:39:57 +00004856 {
4857 linenr_T lnum = curbuf->b_op_start.lnum;
4858 int written = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004859 char_u *lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004860 size_t l;
4861
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00004862 close(fromshell_fd);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004863 for (;;)
4864 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00004865 l = STRLEN(lp + written);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004866 if (l == 0)
4867 len = 0;
Bram Moolenaar89d40322006-08-29 15:30:07 +00004868 else if (lp[written] == NL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01004869 // NL -> NUL translation
Bram Moolenaardf177f62005-02-22 08:39:57 +00004870 len = write(toshell_fd, "", (size_t)1);
4871 else
4872 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01004873 char_u *s = vim_strchr(lp + written, NL);
4874
Bram Moolenaar89d40322006-08-29 15:30:07 +00004875 len = write(toshell_fd, (char *)lp + written,
Bram Moolenaar78a15312009-05-15 19:33:18 +00004876 s == NULL ? l
4877 : (size_t)(s - (lp + written)));
Bram Moolenaardf177f62005-02-22 08:39:57 +00004878 }
Bram Moolenaar78a15312009-05-15 19:33:18 +00004879 if (len == (int)l)
Bram Moolenaardf177f62005-02-22 08:39:57 +00004880 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004881 // Finished a line, add a NL, unless this line
4882 // should not have one.
Bram Moolenaardf177f62005-02-22 08:39:57 +00004883 if (lnum != curbuf->b_op_end.lnum
Bram Moolenaar34d72d42015-07-17 14:18:08 +02004884 || (!curbuf->b_p_bin
4885 && curbuf->b_p_fixeol)
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01004886 || (lnum != curbuf->b_no_eol_lnum
Bram Moolenaardf177f62005-02-22 08:39:57 +00004887 && (lnum !=
4888 curbuf->b_ml.ml_line_count
4889 || curbuf->b_p_eol)))
Bram Moolenaar42335f52018-09-13 15:33:43 +02004890 vim_ignored = write(toshell_fd, "\n",
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004891 (size_t)1);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004892 ++lnum;
4893 if (lnum > curbuf->b_op_end.lnum)
4894 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004895 // finished all the lines, close pipe
Bram Moolenaardf177f62005-02-22 08:39:57 +00004896 close(toshell_fd);
4897 toshell_fd = -1;
4898 break;
4899 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00004900 lp = ml_get(lnum);
Bram Moolenaardf177f62005-02-22 08:39:57 +00004901 written = 0;
4902 }
4903 else if (len > 0)
4904 written += len;
4905 }
4906 _exit(0);
4907 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01004908 else // parent
Bram Moolenaardf177f62005-02-22 08:39:57 +00004909 {
4910 close(toshell_fd);
4911 toshell_fd = -1;
4912 }
4913 }
4914
4915 if (options & SHELL_READ)
4916 ga_init2(&ga, 1, BUFLEN);
4917
4918 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01004919# ifdef ELAPSED_FUNC
4920 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004921# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 for (;;)
4923 {
4924 /*
4925 * Check if keys have been typed, write them to the child
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004926 * if there are any.
4927 * Don't do this if we are expanding wild cards (would eat
4928 * typeahead).
4929 * Don't do this when filtering and terminal is in cooked
4930 * mode, the shell command will handle the I/O. Avoids
4931 * that a typed password is echoed for ssh or gpg command.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004932 * Don't get characters when the child has already
4933 * finished (wait_pid == 0).
Bram Moolenaardf177f62005-02-22 08:39:57 +00004934 * Don't read characters unless we didn't get output for a
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004935 * while (noread_cnt > 4), avoids that ":r !ls" eats
4936 * typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 */
4938 len = 0;
4939 if (!(options & SHELL_EXPAND)
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004940 && ((options &
4941 (SHELL_READ|SHELL_WRITE|SHELL_COOKED))
4942 != (SHELL_READ|SHELL_WRITE|SHELL_COOKED)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004943# ifdef FEAT_GUI
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004944 || gui.in_use
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004945# endif
Bram Moolenaar5b962cf2005-12-12 21:58:40 +00004946 )
Bram Moolenaar12033fb2005-12-16 21:49:31 +00004947 && wait_pid == 0
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004948 && (ta_len > 0 || noread_cnt > 4))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 {
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004950 if (ta_len == 0)
4951 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01004952 // Get extra characters when we don't have any.
4953 // Reset the counter and timer.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004954 noread_cnt = 0;
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01004955# ifdef ELAPSED_FUNC
4956 ELAPSED_INIT(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00004957# endif
4958 len = ui_inchar(ta_buf, BUFLEN, 10L, 0);
4959 }
4960 if (ta_len > 0 || len > 0)
4961 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 /*
4963 * For pipes:
4964 * Check for CTRL-C: send interrupt signal to child.
4965 * Check for CTRL-D: EOF, close pipe to child.
4966 */
4967 if (len == 1 && (pty_master_fd < 0 || cmd != NULL))
4968 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 /*
4970 * Send SIGINT to the child's group or all
4971 * processes in our group.
4972 */
Bram Moolenaarfae42832017-08-01 22:24:26 +02004973 may_send_sigint(ta_buf[ta_len], pid, wpid);
4974
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 if (pty_master_fd < 0 && toshell_fd >= 0
4976 && ta_buf[ta_len] == Ctrl_D)
4977 {
4978 close(toshell_fd);
4979 toshell_fd = -1;
4980 }
4981 }
4982
Bram Moolenaar0f873732019-12-05 20:28:46 +01004983 // replace K_BS by <BS> and K_DEL by <DEL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 for (i = ta_len; i < ta_len + len; ++i)
4985 {
4986 if (ta_buf[i] == CSI && len - i > 2)
4987 {
4988 c = TERMCAP2KEY(ta_buf[i + 1], ta_buf[i + 2]);
4989 if (c == K_DEL || c == K_KDEL || c == K_BS)
4990 {
4991 mch_memmove(ta_buf + i + 1, ta_buf + i + 3,
4992 (size_t)(len - i - 2));
4993 if (c == K_DEL || c == K_KDEL)
4994 ta_buf[i] = DEL;
4995 else
4996 ta_buf[i] = Ctrl_H;
4997 len -= 2;
4998 }
4999 }
5000 else if (ta_buf[i] == '\r')
5001 ta_buf[i] = '\n';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 if (has_mbyte)
Bram Moolenaarfeba08b2009-06-16 13:12:07 +00005003 i += (*mb_ptr2len_len)(ta_buf + i,
5004 ta_len + len - i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 }
5006
5007 /*
5008 * For pipes: echo the typed characters.
5009 * For a pty this does not seem to work.
5010 */
5011 if (pty_master_fd < 0)
5012 {
5013 for (i = ta_len; i < ta_len + len; ++i)
5014 {
5015 if (ta_buf[i] == '\n' || ta_buf[i] == '\b')
5016 msg_putchar(ta_buf[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 else if (has_mbyte)
5018 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005019 int l = (*mb_ptr2len)(ta_buf + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020
5021 msg_outtrans_len(ta_buf + i, l);
5022 i += l - 1;
5023 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 else
5025 msg_outtrans_len(ta_buf + i, 1);
5026 }
5027 windgoto(msg_row, msg_col);
5028 out_flush();
5029 }
5030
5031 ta_len += len;
5032
5033 /*
5034 * Write the characters to the child, unless EOF has
5035 * been typed for pipes. Write one character at a
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005036 * time, to avoid losing too much typeahead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005037 * When writing buffer lines, drop the typed
5038 * characters (only check for CTRL-C).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005040 if (options & SHELL_WRITE)
5041 ta_len = 0;
5042 else if (toshell_fd >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 {
5044 len = write(toshell_fd, (char *)ta_buf, (size_t)1);
5045 if (len > 0)
5046 {
5047 ta_len -= len;
5048 mch_memmove(ta_buf, ta_buf + len, ta_len);
5049 }
5050 }
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005051 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 }
5053
Bram Moolenaardf177f62005-02-22 08:39:57 +00005054 if (got_int)
5055 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005056 // CTRL-C sends a signal to the child, we ignore it
5057 // ourselves
Bram Moolenaardf177f62005-02-22 08:39:57 +00005058# ifdef HAVE_SETSID
5059 kill(-pid, SIGINT);
5060# else
5061 kill(0, SIGINT);
5062# endif
5063 if (wpid > 0)
5064 kill(wpid, SIGINT);
5065 got_int = FALSE;
5066 }
5067
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 /*
5069 * Check if the child has any characters to be printed.
5070 * Read them and write them to our window. Repeat this as
5071 * long as there is something to do, avoid the 10ms wait
5072 * for mch_inchar(), or sending typeahead characters to
5073 * the external process.
5074 * TODO: This should handle escape sequences, compatible
5075 * to some terminal (vt52?).
5076 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005077 ++noread_cnt;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01005078 while (RealWaitForChar(fromshell_fd, 10L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005080 len = read_eintr(fromshell_fd, buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 + buffer_off, (size_t)(BUFLEN - buffer_off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 );
Bram Moolenaar0f873732019-12-05 20:28:46 +01005083 if (len <= 0) // end of file or error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 goto finished;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005085
5086 noread_cnt = 0;
5087 if (options & SHELL_READ)
5088 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005089 // Do NUL -> NL translation, append NL separated
5090 // lines to the current buffer.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005091 for (i = 0; i < len; ++i)
5092 {
5093 if (buffer[i] == NL)
5094 append_ga_line(&ga);
5095 else if (buffer[i] == NUL)
5096 ga_append(&ga, NL);
5097 else
5098 ga_append(&ga, buffer[i]);
5099 }
5100 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005101 else if (has_mbyte)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 {
5103 int l;
Bram Moolenaara2150ac2018-03-17 13:15:17 +01005104 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105
Bram Moolenaardf177f62005-02-22 08:39:57 +00005106 len += buffer_off;
5107 buffer[len] = NUL;
5108
Bram Moolenaar0f873732019-12-05 20:28:46 +01005109 // Check if the last character in buffer[] is
5110 // incomplete, keep these bytes for the next
5111 // round.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 for (p = buffer; p < buffer + len; p += l)
5113 {
Bram Moolenaard3c907b2016-08-17 21:32:09 +02005114 l = MB_CPTR2LEN(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 if (l == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005116 l = 1; // NUL byte?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 else if (MB_BYTE2LEN(*p) != l)
5118 break;
5119 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01005120 if (p == buffer) // no complete character
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005122 // avoid getting stuck at an illegal byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 if (len >= 12)
5124 ++p;
5125 else
5126 {
5127 buffer_off = len;
5128 continue;
5129 }
5130 }
5131 c = *p;
5132 *p = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005133 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 if (p < buffer + len)
5135 {
5136 *p = c;
5137 buffer_off = (buffer + len) - p;
5138 mch_memmove(buffer, p, buffer_off);
5139 continue;
5140 }
5141 buffer_off = 0;
5142 }
5143 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 {
5145 buffer[len] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01005146 msg_puts((char *)buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 }
5148
5149 windgoto(msg_row, msg_col);
5150 cursor_on();
5151 out_flush();
5152 if (got_int)
5153 break;
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005154
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005155# ifdef ELAPSED_FUNC
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005156 if (wait_pid == 0)
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005157 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01005158 long msec = ELAPSED_FUNC(start_tv);
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005159
Bram Moolenaar0f873732019-12-05 20:28:46 +01005160 // Avoid that we keep looping here without
5161 // checking for a CTRL-C for a long time. Don't
5162 // break out too often to avoid losing typeahead.
Bram Moolenaarb3dc8fd2009-02-22 01:52:59 +00005163 if (msec > 2000)
5164 {
5165 noread_cnt = 5;
5166 break;
5167 }
5168 }
5169# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 }
5171
Bram Moolenaar0f873732019-12-05 20:28:46 +01005172 // If we already detected the child has finished, continue
5173 // reading output for a short while. Some text may be
5174 // buffered.
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005175 if (wait_pid == pid)
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005176 {
5177 if (noread_cnt < 5)
5178 continue;
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005179 break;
Bram Moolenaar17fe5e12016-04-04 22:03:08 +02005180 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005181
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 /*
5183 * Check if the child still exists, before checking for
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005184 * typed characters (otherwise we would lose typeahead).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 */
Bram Moolenaardf177f62005-02-22 08:39:57 +00005186# ifdef __NeXT__
Bram Moolenaar205b8862011-09-07 15:04:31 +02005187 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005188# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 wait_pid = waitpid(pid, &status, WNOHANG);
Bram Moolenaardf177f62005-02-22 08:39:57 +00005190# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5192 || (wait_pid == pid && WIFEXITED(status)))
5193 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005194 // Don't break the loop yet, try reading more
5195 // characters from "fromshell_fd" first. When using
5196 // pipes there might still be something to read and
5197 // then we'll break the loop at the "break" above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 wait_pid = pid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 }
Bram Moolenaar12033fb2005-12-16 21:49:31 +00005200 else
5201 wait_pid = 0;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005202
Bram Moolenaar95a51352013-03-21 22:53:50 +01005203# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005204 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005205 clip_update();
5206# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 }
5208finished:
5209 p_more = p_more_save;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005210 if (options & SHELL_READ)
5211 {
5212 if (ga.ga_len > 0)
5213 {
5214 append_ga_line(&ga);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005215 // remember that the NL was missing
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005216 curbuf->b_no_eol_lnum = curwin->w_cursor.lnum;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005217 }
5218 else
Bram Moolenaarcab35ad2011-02-15 17:39:22 +01005219 curbuf->b_no_eol_lnum = 0;
Bram Moolenaardf177f62005-02-22 08:39:57 +00005220 ga_clear(&ga);
5221 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 /*
5224 * Give all typeahead that wasn't used back to ui_inchar().
5225 */
5226 if (ta_len)
5227 ui_inchar_undo(ta_buf, ta_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 State = old_State;
5229 if (toshell_fd >= 0)
5230 close(toshell_fd);
5231 close(fromshell_fd);
5232 }
Bram Moolenaar95a51352013-03-21 22:53:50 +01005233# if defined(FEAT_XCLIPBOARD) && defined(FEAT_X11)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005234 else
5235 {
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005236 long delay_msec = 1;
5237
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005238 /*
5239 * Similar to the loop above, but only handle X events, no
5240 * I/O.
5241 */
5242 for (;;)
5243 {
5244 if (got_int)
5245 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005246 // CTRL-C sends a signal to the child, we ignore it
5247 // ourselves
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005248# ifdef HAVE_SETSID
5249 kill(-pid, SIGINT);
5250# else
5251 kill(0, SIGINT);
5252# endif
5253 got_int = FALSE;
5254 }
5255# ifdef __NeXT__
5256 wait_pid = wait4(pid, &status, WNOHANG, (struct rusage *)0);
5257# else
5258 wait_pid = waitpid(pid, &status, WNOHANG);
5259# endif
5260 if ((wait_pid == (pid_t)-1 && errno == ECHILD)
5261 || (wait_pid == pid && WIFEXITED(status)))
5262 {
5263 wait_pid = pid;
5264 break;
5265 }
5266
Bram Moolenaar0f873732019-12-05 20:28:46 +01005267 // Handle any X events, e.g. serving the clipboard.
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005268 clip_update();
5269
Bram Moolenaar0f873732019-12-05 20:28:46 +01005270 // Wait for 1 to 10 msec. 1 is faster but gives the child
5271 // less time.
Bram Moolenaar0abe0522016-08-28 16:53:12 +02005272 mch_delay(delay_msec, TRUE);
5273 if (++delay_msec > 10)
5274 delay_msec = 10;
Bram Moolenaar090cfc12013-03-19 12:35:42 +01005275 }
5276 }
5277# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278
5279 /*
5280 * Wait until our child has exited.
5281 * Ignore wait() returning pids of other children and returning
5282 * because of some signal like SIGWINCH.
5283 * Don't wait if wait_pid was already set above, indicating the
5284 * child already exited.
5285 */
Bram Moolenaar205b8862011-09-07 15:04:31 +02005286 if (wait_pid != pid)
5287 wait_pid = wait4pid(pid, &status);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288
Bram Moolenaar624891f2010-10-13 16:22:09 +02005289# ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01005290 // Close slave side of pty. Only do this after the child has
5291 // exited, otherwise the child may hang when it tries to write on
5292 // the pty.
Bram Moolenaar624891f2010-10-13 16:22:09 +02005293 if (pty_master_fd >= 0)
5294 close(pty_slave_fd);
5295# endif
5296
Bram Moolenaar0f873732019-12-05 20:28:46 +01005297 // Make sure the child that writes to the external program is
5298 // dead.
Bram Moolenaardf177f62005-02-22 08:39:57 +00005299 if (wpid > 0)
Bram Moolenaar205b8862011-09-07 15:04:31 +02005300 {
Bram Moolenaardf177f62005-02-22 08:39:57 +00005301 kill(wpid, SIGKILL);
Bram Moolenaar205b8862011-09-07 15:04:31 +02005302 wait4pid(wpid, NULL);
5303 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00005304
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005305# ifdef FEAT_JOB_CHANNEL
5306 --dont_check_job_ended;
5307# endif
5308
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 /*
5310 * Set to raw mode right now, otherwise a CTRL-C after
5311 * catch_signals() will kill Vim.
5312 */
5313 if (tmode == TMODE_RAW)
5314 settmode(TMODE_RAW);
5315 did_settmode = TRUE;
5316 set_signals();
5317
5318 if (WIFEXITED(status))
5319 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005320 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 retval = WEXITSTATUS(status);
Bram Moolenaar75676462013-01-30 14:55:42 +01005322 if (retval != 0 && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 {
5324 if (retval == EXEC_FAILED)
5325 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005326 msg_puts(_("\nCannot execute shell "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 msg_outtrans(p_sh);
5328 msg_putchar('\n');
5329 }
5330 else if (!(options & SHELL_SILENT))
5331 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005332 msg_puts(_("\nshell returned "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 msg_outnum((long)retval);
5334 msg_putchar('\n');
5335 }
5336 }
5337 }
5338 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01005339 msg_puts(_("\nCommand terminated\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 }
5341 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
5343error:
5344 if (!did_settmode)
5345 if (tmode == TMODE_RAW)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005346 settmode(TMODE_RAW); // set to raw mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347# ifdef FEAT_TITLE
5348 resettitle();
5349# endif
Bram Moolenaar13568252018-03-16 20:46:58 +01005350 vim_free(argv);
5351 vim_free(tofree1);
5352 vim_free(tofree2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353
5354 return retval;
Bram Moolenaar13568252018-03-16 20:46:58 +01005355}
Bram Moolenaar0f873732019-12-05 20:28:46 +01005356#endif // USE_SYSTEM
Bram Moolenaar13568252018-03-16 20:46:58 +01005357
5358 int
5359mch_call_shell(
5360 char_u *cmd,
Bram Moolenaar0f873732019-12-05 20:28:46 +01005361 int options) // SHELL_*, see vim.h
Bram Moolenaar13568252018-03-16 20:46:58 +01005362{
5363#if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
5364 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
5365 return mch_call_shell_terminal(cmd, options);
5366#endif
5367#ifdef USE_SYSTEM
5368 return mch_call_shell_system(cmd, options);
5369#else
5370 return mch_call_shell_fork(cmd, options);
5371#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372}
5373
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005374#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005375 void
Bram Moolenaar493359e2018-06-12 20:25:52 +02005376mch_job_start(char **argv, job_T *job, jobopt_T *options, int is_terminal)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005377{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005378 pid_t pid;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005379 int fd_in[2] = {-1, -1}; // for stdin
5380 int fd_out[2] = {-1, -1}; // for stdout
5381 int fd_err[2] = {-1, -1}; // for stderr
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005382 int pty_master_fd = -1;
5383 int pty_slave_fd = -1;
Bram Moolenaar16eb4f82016-02-14 23:02:34 +01005384 channel_T *channel = NULL;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005385 int use_null_for_in = options->jo_io[PART_IN] == JIO_NULL;
5386 int use_null_for_out = options->jo_io[PART_OUT] == JIO_NULL;
5387 int use_null_for_err = options->jo_io[PART_ERR] == JIO_NULL;
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005388 int use_file_for_in = options->jo_io[PART_IN] == JIO_FILE;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005389 int use_file_for_out = options->jo_io[PART_OUT] == JIO_FILE;
5390 int use_file_for_err = options->jo_io[PART_ERR] == JIO_FILE;
Bram Moolenaarb2412082017-08-20 18:09:14 +02005391 int use_buffer_for_in = options->jo_io[PART_IN] == JIO_BUFFER;
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005392 int use_out_for_err = options->jo_io[PART_ERR] == JIO_OUT;
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005393 SIGSET_DECL(curset)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005394
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005395 if (use_out_for_err && use_null_for_out)
5396 use_null_for_err = TRUE;
5397
Bram Moolenaar0f873732019-12-05 20:28:46 +01005398 // default is to fail
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005399 job->jv_status = JOB_FAILED;
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005400
Bram Moolenaarb2412082017-08-20 18:09:14 +02005401 if (options->jo_pty
5402 && (!(use_file_for_in || use_null_for_in)
Bram Moolenaar59386482019-02-10 22:43:46 +01005403 || !(use_file_for_out || use_null_for_out)
Bram Moolenaarb2412082017-08-20 18:09:14 +02005404 || !(use_out_for_err || use_file_for_err || use_null_for_err)))
Bram Moolenaar59386482019-02-10 22:43:46 +01005405 open_pty(&pty_master_fd, &pty_slave_fd,
5406 &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005407
Bram Moolenaar0f873732019-12-05 20:28:46 +01005408 // TODO: without the channel feature connect the child to /dev/null?
5409 // Open pipes for stdin, stdout, stderr.
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005410 if (use_file_for_in)
5411 {
5412 char_u *fname = options->jo_io_name[PART_IN];
5413
5414 fd_in[0] = mch_open((char *)fname, O_RDONLY, 0);
5415 if (fd_in[0] < 0)
5416 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005417 semsg(_(e_notopen), fname);
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005418 goto failed;
5419 }
5420 }
Bram Moolenaarb2412082017-08-20 18:09:14 +02005421 else
Bram Moolenaar0f873732019-12-05 20:28:46 +01005422 // When writing buffer lines to the input don't use the pty, so that
5423 // the pipe can be closed when all lines were written.
Bram Moolenaarb2412082017-08-20 18:09:14 +02005424 if (!use_null_for_in && (pty_master_fd < 0 || use_buffer_for_in)
5425 && pipe(fd_in) < 0)
5426 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005427
5428 if (use_file_for_out)
5429 {
5430 char_u *fname = options->jo_io_name[PART_OUT];
5431
5432 fd_out[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0644);
5433 if (fd_out[1] < 0)
5434 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005435 semsg(_(e_notopen), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005436 goto failed;
5437 }
5438 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005439 else if (!use_null_for_out && pty_master_fd < 0 && pipe(fd_out) < 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005440 goto failed;
Bram Moolenaare98d1212016-03-08 15:37:41 +01005441
5442 if (use_file_for_err)
5443 {
5444 char_u *fname = options->jo_io_name[PART_ERR];
5445
5446 fd_err[1] = mch_open((char *)fname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
5447 if (fd_err[1] < 0)
5448 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005449 semsg(_(e_notopen), fname);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005450 goto failed;
5451 }
5452 }
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005453 else if (!use_out_for_err && !use_null_for_err
5454 && pty_master_fd < 0 && pipe(fd_err) < 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005455 goto failed;
5456
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005457 if (!use_null_for_in || !use_null_for_out || !use_null_for_err)
5458 {
Bram Moolenaarde279892016-03-11 22:19:44 +01005459 if (options->jo_set & JO_CHANNEL)
5460 {
5461 channel = options->jo_channel;
5462 if (channel != NULL)
5463 ++channel->ch_refcount;
5464 }
5465 else
5466 channel = add_channel();
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005467 if (channel == NULL)
5468 goto failed;
Bram Moolenaarf3360612017-10-01 16:21:31 +02005469 if (job->jv_tty_out != NULL)
5470 ch_log(channel, "using pty %s on fd %d",
5471 job->jv_tty_out, pty_master_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005472 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005473
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005474 BLOCK_SIGNALS(&curset);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005475 pid = fork(); // maybe we should use vfork()
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005476 if (pid == -1)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005477 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005478 // failed to fork
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005479 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005480 goto failed;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005481 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005482 if (pid == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005483 {
Bram Moolenaar4694a172016-04-21 14:05:23 +02005484 int null_fd = -1;
5485 int stderr_works = TRUE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005486
Bram Moolenaar0f873732019-12-05 20:28:46 +01005487 // child
5488 reset_signals(); // handle signals normally
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005489 UNBLOCK_SIGNALS(&curset);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005490
Bram Moolenaar819524702018-02-27 19:10:00 +01005491# ifdef FEAT_JOB_CHANNEL
5492 if (ch_log_active())
Bram Moolenaar0f873732019-12-05 20:28:46 +01005493 // close the log file in the child
Bram Moolenaar819524702018-02-27 19:10:00 +01005494 ch_logfile((char_u *)"", (char_u *)"");
5495# endif
5496
Bram Moolenaar835dc632016-02-07 14:27:38 +01005497# ifdef HAVE_SETSID
Bram Moolenaar0f873732019-12-05 20:28:46 +01005498 // Create our own process group, so that the child and all its
5499 // children can be kill()ed. Don't do this when using pipes,
5500 // because stdin is not a tty, we would lose /dev/tty.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005501 (void)setsid();
5502# endif
5503
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005504# ifdef FEAT_TERMINAL
5505 if (options->jo_term_rows > 0)
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005506 {
5507 char *term = (char *)T_NAME;
5508
5509#ifdef FEAT_GUI
5510 if (term_is_gui(T_NAME))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005511 // In the GUI 'term' is not what we want, use $TERM.
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005512 term = getenv("TERM");
5513#endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005514 // Use 'term' or $TERM if it starts with "xterm", otherwise fall
5515 // back to "xterm".
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005516 if (term == NULL || *term == NUL || STRNCMP(term, "xterm", 5) != 0)
5517 term = "xterm";
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005518 set_child_environment(
5519 (long)options->jo_term_rows,
5520 (long)options->jo_term_cols,
Bram Moolenaar493359e2018-06-12 20:25:52 +02005521 term,
5522 is_terminal);
Bram Moolenaar9a993e32018-04-05 22:15:22 +02005523 }
Bram Moolenaar58556cd2017-07-20 23:04:46 +02005524 else
5525# endif
Bram Moolenaar493359e2018-06-12 20:25:52 +02005526 set_default_child_environment(is_terminal);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005527
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005528 if (options->jo_env != NULL)
5529 {
5530 dict_T *dict = options->jo_env;
5531 hashitem_T *hi;
5532 int todo = (int)dict->dv_hashtab.ht_used;
5533
5534 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
5535 if (!HASHITEM_EMPTY(hi))
5536 {
5537 typval_T *item = &dict_lookup(hi)->di_tv;
5538
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005539 vim_setenv((char_u*)hi->hi_key, tv_get_string(item));
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005540 --todo;
5541 }
5542 }
5543
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005544 if (use_null_for_in || use_null_for_out || use_null_for_err)
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005545 {
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005546 null_fd = open("/dev/null", O_RDWR | O_EXTRA, 0);
Bram Moolenaarb109bb42017-08-21 21:07:29 +02005547 if (null_fd < 0)
5548 {
5549 perror("opening /dev/null failed");
5550 _exit(OPEN_NULL_FAILED);
5551 }
5552 }
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005553
Bram Moolenaar223896d2017-08-02 22:33:28 +02005554 if (pty_slave_fd >= 0)
5555 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005556 // push stream discipline modules
Bram Moolenaar1ecc5e42019-01-26 15:12:55 +01005557 setup_slavepty(pty_slave_fd);
Bram Moolenaar223896d2017-08-02 22:33:28 +02005558# ifdef TIOCSCTTY
Bram Moolenaar0f873732019-12-05 20:28:46 +01005559 // Try to become controlling tty (probably doesn't work,
5560 // unless run by root)
Bram Moolenaar223896d2017-08-02 22:33:28 +02005561 ioctl(pty_slave_fd, TIOCSCTTY, (char *)NULL);
5562# endif
5563 }
5564
Bram Moolenaar0f873732019-12-05 20:28:46 +01005565 // set up stdin for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005566 close(0);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005567 if (use_null_for_in && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005568 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005569 else if (fd_in[0] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005570 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005571 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005572 vim_ignored = dup(fd_in[0]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005573
Bram Moolenaar0f873732019-12-05 20:28:46 +01005574 // set up stderr for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005575 close(2);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005576 if (use_null_for_err && null_fd >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005577 {
Bram Moolenaar42335f52018-09-13 15:33:43 +02005578 vim_ignored = dup(null_fd);
Bram Moolenaar4694a172016-04-21 14:05:23 +02005579 stderr_works = FALSE;
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005580 }
5581 else if (use_out_for_err)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005582 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005583 else if (fd_err[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005584 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005585 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005586 vim_ignored = dup(fd_err[1]);
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005587
Bram Moolenaar0f873732019-12-05 20:28:46 +01005588 // set up stdout for the child
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005589 close(1);
Bram Moolenaarc0a1d7f2016-03-19 14:12:50 +01005590 if (use_null_for_out && null_fd >= 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005591 vim_ignored = dup(null_fd);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005592 else if (fd_out[1] < 0)
Bram Moolenaar42335f52018-09-13 15:33:43 +02005593 vim_ignored = dup(pty_slave_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005594 else
Bram Moolenaar42335f52018-09-13 15:33:43 +02005595 vim_ignored = dup(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005596
5597 if (fd_in[0] >= 0)
5598 close(fd_in[0]);
5599 if (fd_in[1] >= 0)
5600 close(fd_in[1]);
5601 if (fd_out[0] >= 0)
5602 close(fd_out[0]);
5603 if (fd_out[1] >= 0)
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005604 close(fd_out[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005605 if (fd_err[0] >= 0)
5606 close(fd_err[0]);
5607 if (fd_err[1] >= 0)
5608 close(fd_err[1]);
5609 if (pty_master_fd >= 0)
5610 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005611 close(pty_master_fd); // not used in the child
5612 close(pty_slave_fd); // was duped above
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005613 }
Bram Moolenaarea83bf02016-05-08 09:40:51 +02005614
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005615 if (null_fd >= 0)
5616 close(null_fd);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005617
Bram Moolenaar05aafed2017-08-11 19:12:11 +02005618 if (options->jo_cwd != NULL && mch_chdir((char *)options->jo_cwd) != 0)
5619 _exit(EXEC_FAILED);
5620
Bram Moolenaar0f873732019-12-05 20:28:46 +01005621 // See above for type of argv.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005622 execvp(argv[0], argv);
5623
Bram Moolenaar4694a172016-04-21 14:05:23 +02005624 if (stderr_works)
5625 perror("executing job failed");
Bram Moolenaarfae42832017-08-01 22:24:26 +02005626# ifdef EXITFREE
Bram Moolenaar0f873732019-12-05 20:28:46 +01005627 // calling free_all_mem() here causes problems. Ignore valgrind
5628 // reporting possibly leaked memory.
Bram Moolenaarfae42832017-08-01 22:24:26 +02005629# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01005630 _exit(EXEC_FAILED); // exec failed, return failure code
Bram Moolenaar835dc632016-02-07 14:27:38 +01005631 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005632
Bram Moolenaar0f873732019-12-05 20:28:46 +01005633 // parent
Bram Moolenaarbb09ceb2016-10-18 16:27:23 +02005634 UNBLOCK_SIGNALS(&curset);
5635
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005636 job->jv_pid = pid;
5637 job->jv_status = JOB_STARTED;
Bram Moolenaar0f873732019-12-05 20:28:46 +01005638 job->jv_channel = channel; // ch_refcount was set above
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005639
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005640 if (pty_master_fd >= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005641 close(pty_slave_fd); // not used in the parent
5642 // close child stdin, stdout and stderr
Bram Moolenaar819524702018-02-27 19:10:00 +01005643 if (fd_in[0] >= 0)
Bram Moolenaarb69fccf2016-03-06 23:06:25 +01005644 close(fd_in[0]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005645 if (fd_out[1] >= 0)
Bram Moolenaare98d1212016-03-08 15:37:41 +01005646 close(fd_out[1]);
Bram Moolenaar819524702018-02-27 19:10:00 +01005647 if (fd_err[1] >= 0)
Bram Moolenaarc25558b2016-03-03 21:02:23 +01005648 close(fd_err[1]);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005649 if (channel != NULL)
5650 {
Bram Moolenaar652de232019-04-04 20:13:09 +02005651 int in_fd = INVALID_FD;
5652 int out_fd = INVALID_FD;
5653 int err_fd = INVALID_FD;
5654
5655 if (!(use_file_for_in || use_null_for_in))
5656 in_fd = fd_in[1] >= 0 ? fd_in[1] : pty_master_fd;
5657
5658 if (!(use_file_for_out || use_null_for_out))
5659 out_fd = fd_out[0] >= 0 ? fd_out[0] : pty_master_fd;
5660
5661 // When using pty_master_fd only set it for stdout, do not duplicate
5662 // it for stderr, it only needs to be read once.
5663 if (!(use_out_for_err || use_file_for_err || use_null_for_err))
5664 {
5665 if (fd_err[0] >= 0)
5666 err_fd = fd_err[0];
5667 else if (out_fd != pty_master_fd)
5668 err_fd = pty_master_fd;
5669 }
Bram Moolenaar4e9d4432018-04-24 20:54:07 +02005670
5671 channel_set_pipes(channel, in_fd, out_fd, err_fd);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005672 channel_set_job(channel, job, options);
Bram Moolenaarf65333c2016-03-08 18:27:21 +01005673 }
Bram Moolenaar979e8c52017-08-01 15:08:07 +02005674 else
5675 {
5676 if (fd_in[1] >= 0)
5677 close(fd_in[1]);
5678 if (fd_out[0] >= 0)
5679 close(fd_out[0]);
5680 if (fd_err[0] >= 0)
5681 close(fd_err[0]);
5682 if (pty_master_fd >= 0)
5683 close(pty_master_fd);
5684 }
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005685
Bram Moolenaar0f873732019-12-05 20:28:46 +01005686 // success!
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005687 return;
5688
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005689failed:
Bram Moolenaarde279892016-03-11 22:19:44 +01005690 channel_unref(channel);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005691 if (fd_in[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005692 close(fd_in[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005693 if (fd_in[1] >= 0)
5694 close(fd_in[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005695 if (fd_out[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005696 close(fd_out[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005697 if (fd_out[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005698 close(fd_out[1]);
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005699 if (fd_err[0] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005700 close(fd_err[0]);
Bram Moolenaare98d1212016-03-08 15:37:41 +01005701 if (fd_err[1] >= 0)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005702 close(fd_err[1]);
Bram Moolenaar5a1feb82017-07-22 18:04:08 +02005703 if (pty_master_fd >= 0)
5704 close(pty_master_fd);
5705 if (pty_slave_fd >= 0)
5706 close(pty_slave_fd);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005707}
5708
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005709 static char_u *
5710get_signal_name(int sig)
5711{
5712 int i;
5713 char_u numbuf[NUMBUFLEN];
5714
5715 if (sig == SIGKILL)
5716 return vim_strsave((char_u *)"kill");
5717
5718 for (i = 0; signal_info[i].sig != -1; i++)
5719 if (sig == signal_info[i].sig)
5720 return strlow_save((char_u *)signal_info[i].name);
5721
5722 vim_snprintf((char *)numbuf, NUMBUFLEN, "%d", sig);
5723 return vim_strsave(numbuf);
5724}
5725
Bram Moolenaar835dc632016-02-07 14:27:38 +01005726 char *
5727mch_job_status(job_T *job)
5728{
5729# ifdef HAVE_UNION_WAIT
5730 union wait status;
5731# else
5732 int status = -1;
5733# endif
5734 pid_t wait_pid = 0;
5735
5736# ifdef __NeXT__
5737 wait_pid = wait4(job->jv_pid, &status, WNOHANG, (struct rusage *)0);
5738# else
5739 wait_pid = waitpid(job->jv_pid, &status, WNOHANG);
5740# endif
5741 if (wait_pid == -1)
5742 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005743 // process must have exited
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005744 if (job->jv_status < JOB_ENDED)
5745 ch_log(job->jv_channel, "Job no longer exists: %s",
5746 strerror(errno));
Bram Moolenaar97792de2016-10-15 18:36:49 +02005747 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005748 }
5749 if (wait_pid == 0)
5750 return "run";
5751 if (WIFEXITED(status))
5752 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01005753 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar835dc632016-02-07 14:27:38 +01005754 job->jv_exitval = WEXITSTATUS(status);
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005755 if (job->jv_status < JOB_ENDED)
5756 ch_log(job->jv_channel, "Job exited with %d", job->jv_exitval);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005757 goto return_dead;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005758 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005759 if (WIFSIGNALED(status))
5760 {
5761 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005762 job->jv_termsig = get_signal_name(WTERMSIG(status));
5763 if (job->jv_status < JOB_ENDED && job->jv_termsig != NULL)
5764 ch_log(job->jv_channel, "Job terminated by signal \"%s\"",
5765 job->jv_termsig);
Bram Moolenaar97792de2016-10-15 18:36:49 +02005766 goto return_dead;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005767 }
Bram Moolenaar835dc632016-02-07 14:27:38 +01005768 return "run";
Bram Moolenaar97792de2016-10-15 18:36:49 +02005769
5770return_dead:
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005771 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005772 job->jv_status = JOB_ENDED;
Bram Moolenaar97792de2016-10-15 18:36:49 +02005773 return "dead";
5774}
5775
5776 job_T *
5777mch_detect_ended_job(job_T *job_list)
5778{
5779# ifdef HAVE_UNION_WAIT
5780 union wait status;
5781# else
5782 int status = -1;
5783# endif
5784 pid_t wait_pid = 0;
5785 job_T *job;
5786
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005787# ifndef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01005788 // Do not do this when waiting for a shell command to finish, we would get
5789 // the exit value here (and discard it), the exit value obtained there
5790 // would then be wrong.
Bram Moolenaarc4d4ac22016-11-07 22:42:57 +01005791 if (dont_check_job_ended > 0)
5792 return NULL;
5793# endif
5794
Bram Moolenaar97792de2016-10-15 18:36:49 +02005795# ifdef __NeXT__
5796 wait_pid = wait4(-1, &status, WNOHANG, (struct rusage *)0);
5797# else
5798 wait_pid = waitpid(-1, &status, WNOHANG);
5799# endif
5800 if (wait_pid <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005801 // no process ended
Bram Moolenaar97792de2016-10-15 18:36:49 +02005802 return NULL;
5803 for (job = job_list; job != NULL; job = job->jv_next)
5804 {
5805 if (job->jv_pid == wait_pid)
5806 {
5807 if (WIFEXITED(status))
Bram Moolenaar0f873732019-12-05 20:28:46 +01005808 // LINTED avoid "bitwise operation on signed value"
Bram Moolenaar97792de2016-10-15 18:36:49 +02005809 job->jv_exitval = WEXITSTATUS(status);
5810 else if (WIFSIGNALED(status))
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005811 {
Bram Moolenaar97792de2016-10-15 18:36:49 +02005812 job->jv_exitval = -1;
Bram Moolenaarb3051ce2019-01-31 15:52:11 +01005813 job->jv_termsig = get_signal_name(WTERMSIG(status));
5814 }
Bram Moolenaar7df915d2016-11-17 17:25:32 +01005815 if (job->jv_status < JOB_ENDED)
Bram Moolenaar97792de2016-10-15 18:36:49 +02005816 {
5817 ch_log(job->jv_channel, "Job ended");
5818 job->jv_status = JOB_ENDED;
5819 }
5820 return job;
5821 }
5822 }
5823 return NULL;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005824}
5825
Bram Moolenaar3a117e12016-10-30 21:57:52 +01005826/*
5827 * Send a (deadly) signal to "job".
5828 * Return FAIL if "how" is not a valid name.
5829 */
Bram Moolenaar835dc632016-02-07 14:27:38 +01005830 int
Bram Moolenaar2d33e902017-08-11 16:31:54 +02005831mch_signal_job(job_T *job, char_u *how)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005832{
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005833 int sig = -1;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005834
Bram Moolenaar923d9262016-02-25 20:56:01 +01005835 if (*how == NUL || STRCMP(how, "term") == 0)
Bram Moolenaar835dc632016-02-07 14:27:38 +01005836 sig = SIGTERM;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005837 else if (STRCMP(how, "hup") == 0)
5838 sig = SIGHUP;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005839 else if (STRCMP(how, "quit") == 0)
5840 sig = SIGQUIT;
Bram Moolenaar923d9262016-02-25 20:56:01 +01005841 else if (STRCMP(how, "int") == 0)
5842 sig = SIGINT;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005843 else if (STRCMP(how, "kill") == 0)
5844 sig = SIGKILL;
Bram Moolenaarb13501f2017-07-22 22:32:56 +02005845#ifdef SIGWINCH
5846 else if (STRCMP(how, "winch") == 0)
5847 sig = SIGWINCH;
5848#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01005849 else if (isdigit(*how))
5850 sig = atoi((char *)how);
5851 else
5852 return FAIL;
Bram Moolenaar76467df2016-02-12 19:30:26 +01005853
Bram Moolenaar76ab4fd2018-12-08 14:39:05 +01005854 // Never kill ourselves!
5855 if (job->jv_pid != 0)
5856 {
5857 // TODO: have an option to only kill the process, not the group?
5858 kill(-job->jv_pid, sig);
5859 kill(job->jv_pid, sig);
5860 }
Bram Moolenaar76467df2016-02-12 19:30:26 +01005861
Bram Moolenaar835dc632016-02-07 14:27:38 +01005862 return OK;
5863}
Bram Moolenaar76467df2016-02-12 19:30:26 +01005864
5865/*
5866 * Clear the data related to "job".
5867 */
5868 void
5869mch_clear_job(job_T *job)
5870{
Bram Moolenaar0f873732019-12-05 20:28:46 +01005871 // call waitpid because child process may become zombie
Bram Moolenaar76467df2016-02-12 19:30:26 +01005872# ifdef __NeXT__
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005873 (void)wait4(job->jv_pid, NULL, WNOHANG, (struct rusage *)0);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005874# else
Bram Moolenaar4ca812b2016-03-02 21:51:16 +01005875 (void)waitpid(job->jv_pid, NULL, WNOHANG);
Bram Moolenaar76467df2016-02-12 19:30:26 +01005876# endif
5877}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005878#endif
5879
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005880#if defined(FEAT_TERMINAL) || defined(PROTO)
5881 int
5882mch_create_pty_channel(job_T *job, jobopt_T *options)
5883{
5884 int pty_master_fd = -1;
5885 int pty_slave_fd = -1;
5886 channel_T *channel;
5887
Bram Moolenaar59386482019-02-10 22:43:46 +01005888 open_pty(&pty_master_fd, &pty_slave_fd, &job->jv_tty_out, &job->jv_tty_in);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005889 close(pty_slave_fd);
5890
5891 channel = add_channel();
5892 if (channel == NULL)
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02005893 {
5894 close(pty_master_fd);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005895 return FAIL;
Bram Moolenaar1b9f9d32017-09-05 23:32:38 +02005896 }
Bram Moolenaarf3360612017-10-01 16:21:31 +02005897 if (job->jv_tty_out != NULL)
5898 ch_log(channel, "using pty %s on fd %d",
5899 job->jv_tty_out, pty_master_fd);
Bram Moolenaar0f873732019-12-05 20:28:46 +01005900 job->jv_channel = channel; // ch_refcount was set by add_channel()
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005901 channel->ch_keep_open = TRUE;
5902
Bram Moolenaar0f873732019-12-05 20:28:46 +01005903 // Only set the pty_master_fd for stdout, do not duplicate it for stderr,
5904 // it only needs to be read once.
Bram Moolenaarb0b98d52018-05-05 21:01:00 +02005905 channel_set_pipes(channel, pty_master_fd, pty_master_fd, INVALID_FD);
Bram Moolenaar13ebb032017-08-26 22:02:51 +02005906 channel_set_job(channel, job, options);
5907 return OK;
5908}
5909#endif
5910
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911/*
5912 * Check for CTRL-C typed by reading all available characters.
5913 * In cooked mode we should get SIGINT, no need to check.
5914 */
5915 void
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02005916mch_breakcheck(int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917{
Bram Moolenaarb9c31e72016-09-29 15:18:57 +02005918 if ((curr_tmode == TMODE_RAW || force)
5919 && RealWaitForChar(read_cmd_fd, 0L, NULL, NULL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 fill_input_buf(FALSE);
5921}
5922
5923/*
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005924 * Wait "msec" msec until a character is available from the mouse, keyboard,
5925 * from inbuf[].
5926 * "msec" == -1 will block forever.
5927 * Invokes timer callbacks when needed.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005928 * When "ignore_input" is TRUE even check for pending input when input is
5929 * already available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02005930 * "interrupted" (if not NULL) is set to TRUE when no character is available
5931 * but something else needs to be done.
Bram Moolenaar40b1b542016-04-20 20:18:23 +02005932 * Returns TRUE when a character is available.
Bram Moolenaarcda77642016-06-04 13:32:35 +02005933 * When a GUI is being used, this will never get called -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 */
5935 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005936WaitForChar(long msec, int *interrupted, int ignore_input)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937{
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005938#ifdef FEAT_TIMERS
Bram Moolenaarc9e649a2017-12-18 18:14:47 +01005939 return ui_wait_for_chars_or_timer(
5940 msec, WaitForCharOrMouse, interrupted, ignore_input) == OK;
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005941#else
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005942 return WaitForCharOrMouse(msec, interrupted, ignore_input);
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005943#endif
5944}
5945
5946/*
5947 * Wait "msec" msec until a character is available from the mouse or keyboard
5948 * or from inbuf[].
5949 * "msec" == -1 will block forever.
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005950 * for "ignore_input" see WaitForCharOr().
Bram Moolenaarcda77642016-06-04 13:32:35 +02005951 * "interrupted" (if not NULL) is set to TRUE when no character is available
5952 * but something else needs to be done.
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005953 * When a GUI is being used, this will never get called -- webb
5954 */
5955 static int
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02005956WaitForCharOrMouse(long msec, int *interrupted, int ignore_input)
Bram Moolenaar943bb2b2016-03-19 14:11:18 +01005957{
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958#ifdef FEAT_MOUSE_GPM
5959 int gpm_process_wanted;
5960#endif
5961#ifdef FEAT_XCLIPBOARD
5962 int rest;
5963#endif
5964 int avail;
5965
Bram Moolenaar0f873732019-12-05 20:28:46 +01005966 if (!ignore_input && input_available()) // something in inbuf[]
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 return 1;
5968
5969#if defined(FEAT_MOUSE_DEC)
Bram Moolenaar0f873732019-12-05 20:28:46 +01005970 // May need to query the mouse position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 if (WantQueryMouse)
5972 {
Bram Moolenaar6bb68362005-03-22 23:03:44 +00005973 WantQueryMouse = FALSE;
Bram Moolenaar92fd5992019-05-02 23:00:22 +02005974 if (!no_query_mouse_for_testing)
5975 mch_write((char_u *)IF_EB("\033[1'|", ESC_STR "[1'|"), 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 }
5977#endif
5978
5979 /*
5980 * For FEAT_MOUSE_GPM and FEAT_XCLIPBOARD we loop here to process mouse
5981 * events. This is a bit complicated, because they might both be defined.
5982 */
5983#if defined(FEAT_MOUSE_GPM) || defined(FEAT_XCLIPBOARD)
5984# ifdef FEAT_XCLIPBOARD
5985 rest = 0;
5986 if (do_xterm_trace())
5987 rest = msec;
5988# endif
5989 do
5990 {
5991# ifdef FEAT_XCLIPBOARD
5992 if (rest != 0)
5993 {
5994 msec = XT_TRACE_DELAY;
5995 if (rest >= 0 && rest < XT_TRACE_DELAY)
5996 msec = rest;
5997 if (rest >= 0)
5998 rest -= msec;
5999 }
6000# endif
Bram Moolenaar28e67e02019-08-15 23:05:49 +02006001# ifdef FEAT_SOUND_CANBERRA
6002 // Invoke any pending sound callbacks.
6003 if (has_sound_callback_in_queue())
6004 invoke_sound_callback();
6005# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006# ifdef FEAT_MOUSE_GPM
6007 gpm_process_wanted = 0;
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006008 avail = RealWaitForChar(read_cmd_fd, msec,
Bram Moolenaarcda77642016-06-04 13:32:35 +02006009 &gpm_process_wanted, interrupted);
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006010 if (!avail && !gpm_process_wanted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011# else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006012 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 if (!avail)
Bram Moolenaarb5432d82019-08-30 19:28:25 +02006014# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 {
Bram Moolenaare9c21ae2017-08-03 20:44:48 +02006016 if (!ignore_input && input_available())
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 return 1;
6018# ifdef FEAT_XCLIPBOARD
6019 if (rest == 0 || !do_xterm_trace())
6020# endif
6021 break;
6022 }
6023 }
6024 while (FALSE
6025# ifdef FEAT_MOUSE_GPM
6026 || (gpm_process_wanted && mch_gpm_process() == 0)
6027# endif
6028# ifdef FEAT_XCLIPBOARD
6029 || (!avail && rest != 0)
6030# endif
Bram Moolenaar8fdd7212016-03-26 19:41:48 +01006031 )
6032 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033
6034#else
Bram Moolenaarcda77642016-06-04 13:32:35 +02006035 avail = RealWaitForChar(read_cmd_fd, msec, NULL, interrupted);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036#endif
6037 return avail;
6038}
6039
Bram Moolenaar4ffa0702013-12-11 17:12:37 +01006040#ifndef VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041/*
6042 * Wait "msec" msec until a character is available from file descriptor "fd".
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006043 * "msec" == 0 will check for characters once.
6044 * "msec" == -1 will block until a character is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 * When a GUI is being used, this will not be used for input -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 * Or when a Linux GPM mouse event is waiting.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006047 * Or when a clientserver message is on the queue.
Bram Moolenaarcda77642016-06-04 13:32:35 +02006048 * "interrupted" (if not NULL) is set to TRUE when no character is available
6049 * but something else needs to be done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051#if defined(__BEOS__)
6052 int
6053#else
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006054 static int
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006056RealWaitForChar(int fd, long msec, int *check_for_gpm UNUSED, int *interrupted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057{
6058 int ret;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006059 int result;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006060#if defined(FEAT_XCLIPBOARD) || defined(USE_XSMP) || defined(FEAT_MZSCHEME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 static int busy = FALSE;
6062
Bram Moolenaar0f873732019-12-05 20:28:46 +01006063 // May retry getting characters after an event was handled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064# define MAY_LOOP
6065
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006066# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006067 // Remember at what time we started, so that we know how much longer we
6068 // should wait after being interrupted.
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01006069 long start_msec = msec;
6070 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071
Bram Moolenaar76b6dfe2016-06-04 14:37:22 +02006072 if (msec > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006073 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074# endif
6075
Bram Moolenaar0f873732019-12-05 20:28:46 +01006076 // Handle being called recursively. This may happen for the session
6077 // manager stuff, it may save the file, which does a breakcheck.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 if (busy)
6079 return 0;
6080#endif
6081
6082#ifdef MAY_LOOP
Bram Moolenaar35fdbb52005-07-09 21:08:57 +00006083 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084#endif
6085 {
6086#ifdef MAY_LOOP
Bram Moolenaar0f873732019-12-05 20:28:46 +01006087 int finished = TRUE; // default is to 'loop' just once
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006088# ifdef FEAT_MZSCHEME
6089 int mzquantum_used = FALSE;
6090# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091#endif
6092#ifndef HAVE_SELECT
Bram Moolenaar0f873732019-12-05 20:28:46 +01006093 // each channel may use in, out and err
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006094 struct pollfd fds[6 + 3 * MAX_OPEN_CHANNELS];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 int nfd;
6096# ifdef FEAT_XCLIPBOARD
6097 int xterm_idx = -1;
6098# endif
6099# ifdef FEAT_MOUSE_GPM
6100 int gpm_idx = -1;
6101# endif
6102# ifdef USE_XSMP
6103 int xsmp_idx = -1;
6104# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006105 int towait = (int)msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006107# ifdef FEAT_MZSCHEME
6108 mzvim_check_threads();
6109 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6110 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006111 towait = (int)p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006112 mzquantum_used = TRUE;
6113 }
6114# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 fds[0].fd = fd;
6116 fds[0].events = POLLIN;
6117 nfd = 1;
6118
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006120 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 if (xterm_Shell != (Widget)0)
6122 {
6123 xterm_idx = nfd;
6124 fds[nfd].fd = ConnectionNumber(xterm_dpy);
6125 fds[nfd].events = POLLIN;
6126 nfd++;
6127 }
6128# endif
6129# ifdef FEAT_MOUSE_GPM
6130 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6131 {
6132 gpm_idx = nfd;
6133 fds[nfd].fd = gpm_fd;
6134 fds[nfd].events = POLLIN;
6135 nfd++;
6136 }
6137# endif
6138# ifdef USE_XSMP
6139 if (xsmp_icefd != -1)
6140 {
6141 xsmp_idx = nfd;
6142 fds[nfd].fd = xsmp_icefd;
6143 fds[nfd].events = POLLIN;
6144 nfd++;
6145 }
6146# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006147#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006148 nfd = channel_poll_setup(nfd, &fds, &towait);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006149#endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006150 if (interrupted != NULL)
6151 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006153 ret = poll(fds, nfd, towait);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006154
6155 result = ret > 0 && (fds[0].revents & POLLIN);
Bram Moolenaarcda77642016-06-04 13:32:35 +02006156 if (result == 0 && interrupted != NULL && ret > 0)
6157 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006158
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006159# ifdef FEAT_MZSCHEME
6160 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006161 // MzThreads scheduling is required and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006162 finished = FALSE;
6163# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165# ifdef FEAT_XCLIPBOARD
6166 if (xterm_Shell != (Widget)0 && (fds[xterm_idx].revents & POLLIN))
6167 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006168 xterm_update(); // Maybe we should hand out clipboard
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 if (--ret == 0 && !input_available())
Bram Moolenaar0f873732019-12-05 20:28:46 +01006170 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 finished = FALSE;
6172 }
6173# endif
6174# ifdef FEAT_MOUSE_GPM
6175 if (gpm_idx >= 0 && (fds[gpm_idx].revents & POLLIN))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 *check_for_gpm = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177# endif
6178# ifdef USE_XSMP
6179 if (xsmp_idx >= 0 && (fds[xsmp_idx].revents & (POLLIN | POLLHUP)))
6180 {
6181 if (fds[xsmp_idx].revents & POLLIN)
6182 {
6183 busy = TRUE;
6184 xsmp_handle_requests();
6185 busy = FALSE;
6186 }
6187 else if (fds[xsmp_idx].revents & POLLHUP)
6188 {
6189 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006190 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 xsmp_close();
6192 }
6193 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006194 finished = FALSE; // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 }
6196# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006197#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006198 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006199 if (ret >= 0)
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01006200 channel_poll_check(ret, &fds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006201#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202
Bram Moolenaar0f873732019-12-05 20:28:46 +01006203#else // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204
6205 struct timeval tv;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006206 struct timeval *tvp;
Bram Moolenaar61fb8d82018-11-12 21:45:08 +01006207 // These are static because they can take 8 Kbyte each and cause the
6208 // signal stack to run out with -O3.
6209 static fd_set rfds, wfds, efds;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 int maxfd;
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006211 long towait = msec;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006213# ifdef FEAT_MZSCHEME
6214 mzvim_check_threads();
6215 if (mzthreads_allowed() && p_mzq > 0 && (msec < 0 || msec > p_mzq))
6216 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006217 towait = p_mzq; // don't wait longer than 'mzquantum'
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006218 mzquantum_used = TRUE;
6219 }
6220# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006222 if (towait >= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 {
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006224 tv.tv_sec = towait / 1000;
6225 tv.tv_usec = (towait % 1000) * (1000000/1000);
6226 tvp = &tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 }
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006228 else
6229 tvp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230
6231 /*
6232 * Select on ready for reading and exceptional condition (end of file).
6233 */
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006234select_eintr:
6235 FD_ZERO(&rfds);
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006236 FD_ZERO(&wfds);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 FD_ZERO(&efds);
6238 FD_SET(fd, &rfds);
6239# if !defined(__QNX__) && !defined(__CYGWIN32__)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006240 // For QNX select() always returns 1 if this is set. Why?
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 FD_SET(fd, &efds);
6242# endif
6243 maxfd = fd;
6244
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245# ifdef FEAT_XCLIPBOARD
Bram Moolenaarb1e26502014-11-19 18:48:46 +01006246 may_restore_clipboard();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 if (xterm_Shell != (Widget)0)
6248 {
6249 FD_SET(ConnectionNumber(xterm_dpy), &rfds);
6250 if (maxfd < ConnectionNumber(xterm_dpy))
6251 maxfd = ConnectionNumber(xterm_dpy);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006252
Bram Moolenaar0f873732019-12-05 20:28:46 +01006253 // An event may have already been read but not handled. In
6254 // particularly, XFlush may cause this.
Bram Moolenaardd82d692012-08-15 17:26:57 +02006255 xterm_update();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 }
6257# endif
6258# ifdef FEAT_MOUSE_GPM
6259 if (check_for_gpm != NULL && gpm_flag && gpm_fd >= 0)
6260 {
6261 FD_SET(gpm_fd, &rfds);
6262 FD_SET(gpm_fd, &efds);
6263 if (maxfd < gpm_fd)
6264 maxfd = gpm_fd;
6265 }
6266# endif
6267# ifdef USE_XSMP
6268 if (xsmp_icefd != -1)
6269 {
6270 FD_SET(xsmp_icefd, &rfds);
6271 FD_SET(xsmp_icefd, &efds);
6272 if (maxfd < xsmp_icefd)
6273 maxfd = xsmp_icefd;
6274 }
6275# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006276# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf3360612017-10-01 16:21:31 +02006277 maxfd = channel_select_setup(maxfd, &rfds, &wfds, &tv, &tvp);
Bram Moolenaardd82d692012-08-15 17:26:57 +02006278# endif
Bram Moolenaarcda77642016-06-04 13:32:35 +02006279 if (interrupted != NULL)
6280 *interrupted = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281
Bram Moolenaar643b6142018-09-12 20:29:09 +02006282 ret = select(maxfd + 1, SELECT_TYPE_ARG234 &rfds,
6283 SELECT_TYPE_ARG234 &wfds, SELECT_TYPE_ARG234 &efds, tvp);
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006284 result = ret > 0 && FD_ISSET(fd, &rfds);
6285 if (result)
6286 --ret;
Bram Moolenaarcda77642016-06-04 13:32:35 +02006287 else if (interrupted != NULL && ret > 0)
6288 *interrupted = TRUE;
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006289
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006290# ifdef EINTR
6291 if (ret == -1 && errno == EINTR)
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006292 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006293 // Check whether window has been resized, EINTR may be caused by
6294 // SIGWINCH.
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006295 if (do_resize)
6296 handle_resize();
6297
Bram Moolenaar0f873732019-12-05 20:28:46 +01006298 // Interrupted by a signal, need to try again. We ignore msec
6299 // here, because we do want to check even after a timeout if
6300 // characters are available. Needed for reading output of an
6301 // external command after the process has finished.
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006302 goto select_eintr;
Bram Moolenaar2e7b1df2011-10-12 21:04:20 +02006303 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006304# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +00006305# ifdef __TANDEM
6306 if (ret == -1 && errno == ENOTSUP)
6307 {
6308 FD_ZERO(&rfds);
6309 FD_ZERO(&efds);
6310 ret = 0;
6311 }
Bram Moolenaar493c7a82011-09-07 14:06:47 +02006312# endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006313# ifdef FEAT_MZSCHEME
6314 if (ret == 0 && mzquantum_used)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006315 // loop if MzThreads must be scheduled and timeout occurred
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006316 finished = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317# endif
6318
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319# ifdef FEAT_XCLIPBOARD
6320 if (ret > 0 && xterm_Shell != (Widget)0
6321 && FD_ISSET(ConnectionNumber(xterm_dpy), &rfds))
6322 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006323 xterm_update(); // Maybe we should hand out clipboard
6324 // continue looping when we only got the X event and the input
6325 // buffer is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 if (--ret == 0 && !input_available())
6327 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006328 // Try again
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 finished = FALSE;
6330 }
6331 }
6332# endif
6333# ifdef FEAT_MOUSE_GPM
6334 if (ret > 0 && gpm_flag && check_for_gpm != NULL && gpm_fd >= 0)
6335 {
6336 if (FD_ISSET(gpm_fd, &efds))
6337 gpm_close();
6338 else if (FD_ISSET(gpm_fd, &rfds))
6339 *check_for_gpm = 1;
6340 }
6341# endif
6342# ifdef USE_XSMP
6343 if (ret > 0 && xsmp_icefd != -1)
6344 {
6345 if (FD_ISSET(xsmp_icefd, &efds))
6346 {
6347 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006348 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 xsmp_close();
6350 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006351 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 }
6353 else if (FD_ISSET(xsmp_icefd, &rfds))
6354 {
6355 busy = TRUE;
6356 xsmp_handle_requests();
6357 busy = FALSE;
6358 if (--ret == 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006359 finished = FALSE; // keep going if event was only one
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 }
6361 }
6362# endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01006363#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar0f873732019-12-05 20:28:46 +01006364 // also call when ret == 0, we may be polling a keep-open channel
Bram Moolenaarf3360612017-10-01 16:21:31 +02006365 if (ret >= 0)
Bram Moolenaar8b877ac2016-03-28 19:16:20 +02006366 ret = channel_select_check(ret, &rfds, &wfds);
Bram Moolenaar67c53842010-05-22 18:28:27 +02006367#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368
Bram Moolenaar0f873732019-12-05 20:28:46 +01006369#endif // HAVE_SELECT
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370
6371#ifdef MAY_LOOP
6372 if (finished || msec == 0)
6373 break;
6374
Bram Moolenaar93c88e02015-09-15 14:12:05 +02006375# ifdef FEAT_CLIENTSERVER
6376 if (server_waiting())
6377 break;
6378# endif
6379
Bram Moolenaar0f873732019-12-05 20:28:46 +01006380 // We're going to loop around again, find out for how long
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 if (msec > 0)
6382 {
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006383# ifdef ELAPSED_FUNC
Bram Moolenaar0f873732019-12-05 20:28:46 +01006384 // Compute remaining wait time.
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01006385 msec = start_msec - ELAPSED_FUNC(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386# else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006387 // Guess we got interrupted halfway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 msec = msec / 2;
6389# endif
6390 if (msec <= 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006391 break; // waited long enough
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 }
6393#endif
6394 }
6395
Bram Moolenaarec70bdd2016-02-18 22:17:42 +01006396 return result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397}
6398
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399/*
Bram Moolenaar02743632005-07-25 20:42:36 +00006400 * Expand a path into all matching files and/or directories. Handles "*",
6401 * "?", "[a-z]", "**", etc.
6402 * "path" has backslashes before chars that are not to be expanded.
6403 * Returns the number of matches found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 */
6405 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006406mch_expandpath(
6407 garray_T *gap,
6408 char_u *path,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006409 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410{
Bram Moolenaar02743632005-07-25 20:42:36 +00006411 return unix_expandpath(gap, path, 0, flags, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413
6414/*
6415 * mch_expand_wildcards() - this code does wild-card pattern matching using
6416 * the shell
6417 *
6418 * return OK for success, FAIL for error (you may lose some memory) and put
6419 * an error message in *file.
6420 *
6421 * num_pat is number of input patterns
6422 * pat is array of pointers to input patterns
6423 * num_file is pointer to number of matched file names
6424 * file is pointer to array of pointers to matched file names
6425 */
6426
6427#ifndef SEEK_SET
6428# define SEEK_SET 0
6429#endif
6430#ifndef SEEK_END
6431# define SEEK_END 2
6432#endif
6433
Bram Moolenaar5555acc2006-04-07 21:33:12 +00006434#define SHELL_SPECIAL (char_u *)"\t \"&'$;<>()\\|"
Bram Moolenaar316059c2006-01-14 21:18:42 +00006435
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006437mch_expand_wildcards(
6438 int num_pat,
6439 char_u **pat,
6440 int *num_file,
6441 char_u ***file,
Bram Moolenaar0f873732019-12-05 20:28:46 +01006442 int flags) // EW_* flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443{
6444 int i;
6445 size_t len;
Bram Moolenaar85325f82017-03-30 21:18:45 +02006446 long llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 char_u *p;
6448 int dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449
Bram Moolenaarc7247912008-01-13 12:54:11 +00006450 /*
6451 * This is the non-OS/2 implementation (really Unix).
6452 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 int j;
6454 char_u *tempname;
6455 char_u *command;
6456 FILE *fd;
6457 char_u *buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006458#define STYLE_ECHO 0 // use "echo", the default
6459#define STYLE_GLOB 1 // use "glob", for csh
6460#define STYLE_VIMGLOB 2 // use "vimglob", for Posix sh
6461#define STYLE_PRINT 3 // use "print -N", for zsh
6462#define STYLE_BT 4 // `cmd` expansion, execute the pattern
6463 // directly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 int shell_style = STYLE_ECHO;
6465 int check_spaces;
6466 static int did_find_nul = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006467 int ampersand = FALSE;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006468 // vimglob() function to define for Posix shell
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006469 static char *sh_vimglob_func = "vimglob() { while [ $# -ge 1 ]; do echo \"$1\"; shift; done }; vimglob >";
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470
Bram Moolenaar0f873732019-12-05 20:28:46 +01006471 *num_file = 0; // default: no files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 *file = NULL;
6473
6474 /*
6475 * If there are no wildcards, just copy the names to allocated memory.
6476 * Saves a lot of time, because we don't have to start a new shell.
6477 */
6478 if (!have_wildcard(num_pat, pat))
6479 return save_patterns(num_pat, pat, num_file, file);
6480
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006481# ifdef HAVE_SANDBOX
Bram Moolenaar0f873732019-12-05 20:28:46 +01006482 // Don't allow any shell command in the sandbox.
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006483 if (sandbox != 0 && check_secure())
6484 return FAIL;
6485# endif
6486
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 /*
6488 * Don't allow the use of backticks in secure and restricted mode.
6489 */
Bram Moolenaar0e634da2005-07-20 21:57:28 +00006490 if (secure || restricted)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 for (i = 0; i < num_pat; ++i)
6492 if (vim_strchr(pat[i], '`') != NULL
6493 && (check_restricted() || check_secure()))
6494 return FAIL;
6495
6496 /*
6497 * get a name for the temp file
6498 */
Bram Moolenaare5c421c2015-03-31 13:33:08 +02006499 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006501 emsg(_(e_notmp));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 return FAIL;
6503 }
6504
6505 /*
6506 * Let the shell expand the patterns and write the result into the temp
Bram Moolenaarc7247912008-01-13 12:54:11 +00006507 * file.
6508 * STYLE_BT: NL separated
6509 * If expanding `cmd` execute it directly.
6510 * STYLE_GLOB: NUL separated
6511 * If we use *csh, "glob" will work better than "echo".
6512 * STYLE_PRINT: NL or NUL separated
6513 * If we use *zsh, "print -N" will work better than "glob".
6514 * STYLE_VIMGLOB: NL separated
6515 * If we use *sh*, we define "vimglob()".
6516 * STYLE_ECHO: space separated.
6517 * A shell we don't know, stay safe and use "echo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 */
6519 if (num_pat == 1 && *pat[0] == '`'
6520 && (len = STRLEN(pat[0])) > 2
6521 && *(pat[0] + len - 1) == '`')
6522 shell_style = STYLE_BT;
6523 else if ((len = STRLEN(p_sh)) >= 3)
6524 {
6525 if (STRCMP(p_sh + len - 3, "csh") == 0)
6526 shell_style = STYLE_GLOB;
6527 else if (STRCMP(p_sh + len - 3, "zsh") == 0)
6528 shell_style = STYLE_PRINT;
6529 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006530 if (shell_style == STYLE_ECHO && strstr((char *)gettail(p_sh),
6531 "sh") != NULL)
6532 shell_style = STYLE_VIMGLOB;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533
Bram Moolenaar0f873732019-12-05 20:28:46 +01006534 // Compute the length of the command. We need 2 extra bytes: for the
6535 // optional '&' and for the NUL.
6536 // Worst case: "unset nonomatch; print -N >" plus two is 29
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 len = STRLEN(tempname) + 29;
Bram Moolenaarc7247912008-01-13 12:54:11 +00006538 if (shell_style == STYLE_VIMGLOB)
6539 len += STRLEN(sh_vimglob_func);
6540
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006541 for (i = 0; i < num_pat; ++i)
6542 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006543 // Count the length of the patterns in the same way as they are put in
6544 // "command" below.
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006545#ifdef USE_SYSTEM
Bram Moolenaar0f873732019-12-05 20:28:46 +01006546 len += STRLEN(pat[i]) + 3; // add space and two quotes
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006547#else
Bram Moolenaar0f873732019-12-05 20:28:46 +01006548 ++len; // add space
Bram Moolenaar316059c2006-01-14 21:18:42 +00006549 for (j = 0; pat[i][j] != NUL; ++j)
6550 {
6551 if (vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006552 ++len; // may add a backslash
Bram Moolenaar316059c2006-01-14 21:18:42 +00006553 ++len;
6554 }
Bram Moolenaarb23c3382005-01-31 19:09:12 +00006555#endif
6556 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 command = alloc(len);
6558 if (command == NULL)
6559 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006560 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 vim_free(tempname);
6562 return FAIL;
6563 }
6564
6565 /*
6566 * Build the shell command:
6567 * - Set $nonomatch depending on EW_NOTFOUND (hopefully the shell
6568 * recognizes this).
6569 * - Add the shell command to print the expanded names.
6570 * - Add the temp file name.
6571 * - Add the file name patterns.
6572 */
6573 if (shell_style == STYLE_BT)
6574 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006575 // change `command; command& ` to (command; command )
Bram Moolenaar316059c2006-01-14 21:18:42 +00006576 STRCPY(command, "(");
Bram Moolenaar0f873732019-12-05 20:28:46 +01006577 STRCAT(command, pat[0] + 1); // exclude first backtick
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 p = command + STRLEN(command) - 1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006579 *p-- = ')'; // remove last backtick
Bram Moolenaar1c465442017-03-12 20:10:05 +01006580 while (p > command && VIM_ISWHITE(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 --p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006582 if (*p == '&') // remove trailing '&'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 {
Bram Moolenaarbdace832019-03-02 10:13:42 +01006584 ampersand = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 *p = ' ';
6586 }
6587 STRCAT(command, ">");
6588 }
6589 else
6590 {
6591 if (flags & EW_NOTFOUND)
6592 STRCPY(command, "set nonomatch; ");
6593 else
6594 STRCPY(command, "unset nonomatch; ");
6595 if (shell_style == STYLE_GLOB)
6596 STRCAT(command, "glob >");
6597 else if (shell_style == STYLE_PRINT)
6598 STRCAT(command, "print -N >");
Bram Moolenaarc7247912008-01-13 12:54:11 +00006599 else if (shell_style == STYLE_VIMGLOB)
6600 STRCAT(command, sh_vimglob_func);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 else
6602 STRCAT(command, "echo >");
6603 }
Bram Moolenaarc7247912008-01-13 12:54:11 +00006604
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 STRCAT(command, tempname);
Bram Moolenaarc7247912008-01-13 12:54:11 +00006606
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 if (shell_style != STYLE_BT)
6608 for (i = 0; i < num_pat; ++i)
6609 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006610 // When using system() always add extra quotes, because the shell
6611 // is started twice. Otherwise put a backslash before special
6612 // characters, except inside ``.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613#ifdef USE_SYSTEM
6614 STRCAT(command, " \"");
6615 STRCAT(command, pat[i]);
6616 STRCAT(command, "\"");
6617#else
Bram Moolenaar582fd852005-03-28 20:58:01 +00006618 int intick = FALSE;
6619
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 p = command + STRLEN(command);
6621 *p++ = ' ';
Bram Moolenaar316059c2006-01-14 21:18:42 +00006622 for (j = 0; pat[i][j] != NUL; ++j)
Bram Moolenaar582fd852005-03-28 20:58:01 +00006623 {
6624 if (pat[i][j] == '`')
Bram Moolenaar582fd852005-03-28 20:58:01 +00006625 intick = !intick;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006626 else if (pat[i][j] == '\\' && pat[i][j + 1] != NUL)
6627 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006628 // Remove a backslash, take char literally. But keep
6629 // backslash inside backticks, before a special character
6630 // and before a backtick.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006631 if (intick
Bram Moolenaar49315f62006-02-04 00:54:59 +00006632 || vim_strchr(SHELL_SPECIAL, pat[i][j + 1]) != NULL
6633 || pat[i][j + 1] == '`')
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006634 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006635 ++j;
Bram Moolenaar316059c2006-01-14 21:18:42 +00006636 }
Bram Moolenaare4df1642014-08-29 12:58:44 +02006637 else if (!intick
6638 && ((flags & EW_KEEPDOLLAR) == 0 || pat[i][j] != '$')
6639 && vim_strchr(SHELL_SPECIAL, pat[i][j]) != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006640 // Put a backslash before a special character, but not
6641 // when inside ``. And not for $var when EW_KEEPDOLLAR is
6642 // set.
Bram Moolenaar316059c2006-01-14 21:18:42 +00006643 *p++ = '\\';
Bram Moolenaar280f1262006-01-30 00:14:18 +00006644
Bram Moolenaar0f873732019-12-05 20:28:46 +01006645 // Copy one character.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006646 *p++ = pat[i][j];
Bram Moolenaar582fd852005-03-28 20:58:01 +00006647 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 *p = NUL;
6649#endif
6650 }
6651 if (flags & EW_SILENT)
6652 show_shell_mess = FALSE;
Bram Moolenaarbdace832019-03-02 10:13:42 +01006653 if (ampersand)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006654 STRCAT(command, "&"); // put the '&' after the redirection
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655
6656 /*
6657 * Using zsh -G: If a pattern has no matches, it is just deleted from
6658 * the argument list, otherwise zsh gives an error message and doesn't
6659 * expand any other pattern.
6660 */
6661 if (shell_style == STYLE_PRINT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006662 extra_shell_arg = (char_u *)"-G"; // Use zsh NULL_GLOB option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663
6664 /*
6665 * If we use -f then shell variables set in .cshrc won't get expanded.
6666 * vi can do it, so we will too, but it is only necessary if there is a "$"
6667 * in one of the patterns, otherwise we can still use the fast option.
6668 */
6669 else if (shell_style == STYLE_GLOB && !have_dollars(num_pat, pat))
Bram Moolenaar0f873732019-12-05 20:28:46 +01006670 extra_shell_arg = (char_u *)"-f"; // Use csh fast option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671
6672 /*
6673 * execute the shell command
6674 */
6675 i = call_shell(command, SHELL_EXPAND | SHELL_SILENT);
6676
Bram Moolenaar0f873732019-12-05 20:28:46 +01006677 // When running in the background, give it some time to create the temp
6678 // file, but don't wait for it to finish.
Bram Moolenaarbdace832019-03-02 10:13:42 +01006679 if (ampersand)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 mch_delay(10L, TRUE);
6681
Bram Moolenaar0f873732019-12-05 20:28:46 +01006682 extra_shell_arg = NULL; // cleanup
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 show_shell_mess = TRUE;
6684 vim_free(command);
6685
Bram Moolenaar0f873732019-12-05 20:28:46 +01006686 if (i != 0) // mch_call_shell() failed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 {
6688 mch_remove(tempname);
6689 vim_free(tempname);
6690 /*
6691 * With interactive completion, the error message is not printed.
6692 * However with USE_SYSTEM, I don't know how to turn off error messages
6693 * from the shell, so screen may still get messed up -- webb.
6694 */
6695#ifndef USE_SYSTEM
6696 if (!(flags & EW_SILENT))
6697#endif
6698 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006699 redraw_later_clear(); // probably messed up screen
6700 msg_putchar('\n'); // clear bottom line quickly
6701 cmdline_row = Rows - 1; // continue on last line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702#ifdef USE_SYSTEM
6703 if (!(flags & EW_SILENT))
6704#endif
6705 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006706 msg(_(e_wildexpand));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006707 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 }
6709 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006710 // If a `cmd` expansion failed, don't list `cmd` as a match, even when
6711 // EW_NOTFOUND is given
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 if (shell_style == STYLE_BT)
6713 return FAIL;
6714 goto notfound;
6715 }
6716
6717 /*
6718 * read the names from the file into memory
6719 */
6720 fd = fopen((char *)tempname, READBIN);
6721 if (fd == NULL)
6722 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006723 // Something went wrong, perhaps a file name with a special char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 if (!(flags & EW_SILENT))
6725 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01006726 msg(_(e_wildexpand));
Bram Moolenaar0f873732019-12-05 20:28:46 +01006727 msg_start(); // don't overwrite this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 }
6729 vim_free(tempname);
6730 goto notfound;
6731 }
6732 fseek(fd, 0L, SEEK_END);
Bram Moolenaar0f873732019-12-05 20:28:46 +01006733 llen = ftell(fd); // get size of temp file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 fseek(fd, 0L, SEEK_SET);
Bram Moolenaar85325f82017-03-30 21:18:45 +02006735 if (llen < 0)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006736 // just in case ftell() would fail
Bram Moolenaar85325f82017-03-30 21:18:45 +02006737 buffer = NULL;
6738 else
6739 buffer = alloc(llen + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 if (buffer == NULL)
6741 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006742 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 mch_remove(tempname);
6744 vim_free(tempname);
6745 fclose(fd);
6746 return FAIL;
6747 }
Bram Moolenaar85325f82017-03-30 21:18:45 +02006748 len = llen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 i = fread((char *)buffer, 1, len, fd);
6750 fclose(fd);
6751 mch_remove(tempname);
Bram Moolenaar78a15312009-05-15 19:33:18 +00006752 if (i != (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006754 // unexpected read error
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006755 semsg(_(e_notread), tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 vim_free(tempname);
6757 vim_free(buffer);
6758 return FAIL;
6759 }
6760 vim_free(tempname);
6761
Bram Moolenaar1eed5322019-02-26 17:03:54 +01006762# ifdef __CYGWIN__
Bram Moolenaar0f873732019-12-05 20:28:46 +01006763 // Translate <CR><NL> into <NL>. Caution, buffer may contain NUL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 p = buffer;
Bram Moolenaarfe17e762013-06-29 14:17:02 +02006765 for (i = 0; i < (int)len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 if (!(buffer[i] == CAR && buffer[i + 1] == NL))
6767 *p++ = buffer[i];
6768 len = p - buffer;
6769# endif
6770
6771
Bram Moolenaar0f873732019-12-05 20:28:46 +01006772 // file names are separated with Space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 if (shell_style == STYLE_ECHO)
6774 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006775 buffer[len] = '\n'; // make sure the buffer ends in NL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006777 for (i = 0; *p != '\n'; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 {
6779 while (*p != ' ' && *p != '\n')
6780 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006781 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 }
6783 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006784 // file names are separated with NL
Bram Moolenaarc7247912008-01-13 12:54:11 +00006785 else if (shell_style == STYLE_BT || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006787 buffer[len] = NUL; // make sure the buffer ends in NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 p = buffer;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006789 for (i = 0; *p != NUL; ++i) // count number of entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 {
6791 while (*p != '\n' && *p != NUL)
6792 ++p;
6793 if (*p != NUL)
6794 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006795 p = skipwhite(p); // skip leading white space
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 }
6797 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006798 // file names are separated with NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 else
6800 {
6801 /*
6802 * Some versions of zsh use spaces instead of NULs to separate
6803 * results. Only do this when there is no NUL before the end of the
6804 * buffer, otherwise we would never be able to use file names with
6805 * embedded spaces when zsh does use NULs.
6806 * When we found a NUL once, we know zsh is OK, set did_find_nul and
6807 * don't check for spaces again.
6808 */
6809 check_spaces = FALSE;
6810 if (shell_style == STYLE_PRINT && !did_find_nul)
6811 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006812 // If there is a NUL, set did_find_nul, else set check_spaces
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02006813 buffer[len] = NUL;
Bram Moolenaarb011af92013-12-11 13:21:51 +01006814 if (len && (int)STRLEN(buffer) < (int)len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 did_find_nul = TRUE;
6816 else
6817 check_spaces = TRUE;
6818 }
6819
6820 /*
6821 * Make sure the buffer ends with a NUL. For STYLE_PRINT there
6822 * already is one, for STYLE_GLOB it needs to be added.
6823 */
6824 if (len && buffer[len - 1] == NUL)
6825 --len;
6826 else
6827 buffer[len] = NUL;
6828 i = 0;
6829 for (p = buffer; p < buffer + len; ++p)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006830 if (*p == NUL || (*p == ' ' && check_spaces)) // count entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 {
6832 ++i;
6833 *p = NUL;
6834 }
6835 if (len)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006836 ++i; // count last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 }
6838 if (i == 0)
6839 {
6840 /*
6841 * Can happen when using /bin/sh and typing ":e $NO_SUCH_VAR^I".
6842 * /bin/sh will happily expand it to nothing rather than returning an
6843 * error; and hey, it's good to check anyway -- webb.
6844 */
6845 vim_free(buffer);
6846 goto notfound;
6847 }
6848 *num_file = i;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006849 *file = ALLOC_MULT(char_u *, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 if (*file == NULL)
6851 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006852 // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 vim_free(buffer);
6854 return FAIL;
6855 }
6856
6857 /*
6858 * Isolate the individual file names.
6859 */
6860 p = buffer;
6861 for (i = 0; i < *num_file; ++i)
6862 {
6863 (*file)[i] = p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006864 // Space or NL separates
Bram Moolenaarc7247912008-01-13 12:54:11 +00006865 if (shell_style == STYLE_ECHO || shell_style == STYLE_BT
6866 || shell_style == STYLE_VIMGLOB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 {
Bram Moolenaar49315f62006-02-04 00:54:59 +00006868 while (!(shell_style == STYLE_ECHO && *p == ' ')
6869 && *p != '\n' && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006871 if (p == buffer + len) // last entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 *p = NUL;
6873 else
6874 {
6875 *p++ = NUL;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006876 p = skipwhite(p); // skip to next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 }
6878 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01006879 else // NUL separates
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006881 while (*p && p < buffer + len) // skip entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 ++p;
Bram Moolenaar0f873732019-12-05 20:28:46 +01006883 ++p; // skip NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 }
6885 }
6886
6887 /*
6888 * Move the file names to allocated memory.
6889 */
6890 for (j = 0, i = 0; i < *num_file; ++i)
6891 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01006892 // Require the files to exist. Helps when using /bin/sh
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 if (!(flags & EW_NOTFOUND) && mch_getperm((*file)[i]) < 0)
6894 continue;
6895
Bram Moolenaar0f873732019-12-05 20:28:46 +01006896 // check if this entry should be included
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 dir = (mch_isdir((*file)[i]));
6898 if ((dir && !(flags & EW_DIR)) || (!dir && !(flags & EW_FILE)))
6899 continue;
6900
Bram Moolenaar0f873732019-12-05 20:28:46 +01006901 // Skip files that are not executable if we check for that.
Bram Moolenaarb5971142015-03-21 17:32:19 +01006902 if (!dir && (flags & EW_EXEC)
6903 && !mch_can_exe((*file)[i], NULL, !(flags & EW_SHELLCMD)))
Bram Moolenaara2031822006-03-07 22:29:51 +00006904 continue;
6905
Bram Moolenaar964b3742019-05-24 18:54:09 +02006906 p = alloc(STRLEN((*file)[i]) + 1 + dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 if (p)
6908 {
6909 STRCPY(p, (*file)[i]);
6910 if (dir)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006911 add_pathsep(p); // add '/' to a directory name
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 (*file)[j++] = p;
6913 }
6914 }
6915 vim_free(buffer);
6916 *num_file = j;
6917
Bram Moolenaar0f873732019-12-05 20:28:46 +01006918 if (*num_file == 0) // rejected all entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01006920 VIM_CLEAR(*file);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 goto notfound;
6922 }
6923
6924 return OK;
6925
6926notfound:
6927 if (flags & EW_NOTFOUND)
6928 return save_patterns(num_pat, pat, num_file, file);
6929 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930}
6931
Bram Moolenaar0f873732019-12-05 20:28:46 +01006932#endif // VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01006935save_patterns(
6936 int num_pat,
6937 char_u **pat,
6938 int *num_file,
6939 char_u ***file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940{
6941 int i;
Bram Moolenaard8b02732005-01-14 21:48:43 +00006942 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006944 *file = ALLOC_MULT(char_u *, num_pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 if (*file == NULL)
6946 return FAIL;
6947 for (i = 0; i < num_pat; i++)
Bram Moolenaard8b02732005-01-14 21:48:43 +00006948 {
6949 s = vim_strsave(pat[i]);
6950 if (s != NULL)
Bram Moolenaar0f873732019-12-05 20:28:46 +01006951 // Be compatible with expand_filename(): halve the number of
6952 // backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00006953 backslash_halve(s);
6954 (*file)[i] = s;
6955 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 *num_file = num_pat;
6957 return OK;
6958}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960/*
6961 * Return TRUE if the string "p" contains a wildcard that mch_expandpath() can
6962 * expand.
6963 */
6964 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006965mch_has_exp_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006967 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 if (*p == '\\' && p[1] != NUL)
6970 ++p;
6971 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 if (vim_strchr((char_u *)
6973#ifdef VMS
6974 "*?%"
6975#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 "*?[{'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977#endif
6978 , *p) != NULL)
6979 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 }
6981 return FALSE;
6982}
6983
6984/*
6985 * Return TRUE if the string "p" contains a wildcard.
6986 * Don't recognize '~' at the end as a wildcard.
6987 */
6988 int
Bram Moolenaar05540972016-01-30 20:31:25 +01006989mch_has_wildcard(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990{
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006991 for ( ; *p; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 if (*p == '\\' && p[1] != NUL)
6994 ++p;
6995 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 if (vim_strchr((char_u *)
6997#ifdef VMS
6998 "*?%$"
6999#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 "*?[{`'$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001#endif
7002 , *p) != NULL
7003 || (*p == '~' && p[1] != NUL))
7004 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 }
7006 return FALSE;
7007}
7008
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007010have_wildcard(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011{
7012 int i;
7013
7014 for (i = 0; i < num; i++)
7015 if (mch_has_wildcard(file[i]))
7016 return 1;
7017 return 0;
7018}
7019
7020 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007021have_dollars(int num, char_u **file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022{
7023 int i;
7024
7025 for (i = 0; i < num; i++)
7026 if (vim_strchr(file[i], '$') != NULL)
7027 return TRUE;
7028 return FALSE;
7029}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007031#if !defined(HAVE_RENAME) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032/*
7033 * Scaled-down version of rename(), which is missing in Xenix.
7034 * This version can only move regular files and will fail if the
7035 * destination exists.
7036 */
7037 int
Bram Moolenaarfdcc9af2016-02-29 12:52:39 +01007038mch_rename(const char *src, const char *dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039{
7040 struct stat st;
7041
Bram Moolenaar0f873732019-12-05 20:28:46 +01007042 if (stat(dest, &st) >= 0) // fail if destination exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007044 if (link(src, dest) != 0) // link file to new name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 return -1;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007046 if (mch_remove(src) == 0) // delete link to old name
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 return 0;
7048 return -1;
7049}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007050#endif // !HAVE_RENAME
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007052#if defined(FEAT_MOUSE_GPM) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053/*
7054 * Initializes connection with gpm (if it isn't already opened)
7055 * Return 1 if succeeded (or connection already opened), 0 if failed
7056 */
7057 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007058gpm_open(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007060 static Gpm_Connect gpm_connect; // Must it be kept till closing ?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061
7062 if (!gpm_flag)
7063 {
7064 gpm_connect.eventMask = (GPM_UP | GPM_DRAG | GPM_DOWN);
7065 gpm_connect.defaultMask = ~GPM_HARD;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007066 // Default handling for mouse move
7067 gpm_connect.minMod = 0; // Handle any modifier keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 gpm_connect.maxMod = 0xffff;
7069 if (Gpm_Open(&gpm_connect, 0) > 0)
7070 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007071 // gpm library tries to handling TSTP causes
7072 // problems. Anyways, we close connection to Gpm whenever
7073 // we are going to suspend or starting an external process
7074 // so we shouldn't have problem with this
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007075# ifdef SIGTSTP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 signal(SIGTSTP, restricted ? SIG_IGN : SIG_DFL);
Bram Moolenaar76243bd2009-03-02 01:47:02 +00007077# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007078 return 1; // succeed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 }
7080 if (gpm_fd == -2)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007081 Gpm_Close(); // We don't want to talk to xterm via gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 return 0;
7083 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007084 return 1; // already open
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085}
7086
7087/*
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007088 * Returns TRUE if the GPM mouse is enabled.
7089 */
7090 int
7091gpm_enabled(void)
7092{
7093 return gpm_flag && gpm_fd >= 0;
7094}
7095
7096/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 * Closes connection to gpm
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 */
7099 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007100gpm_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101{
Bram Moolenaar4b8366b2019-05-04 17:34:34 +02007102 if (gpm_enabled())
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 Gpm_Close();
7104}
7105
Bram Moolenaarbedf0912019-05-04 16:58:45 +02007106/*
7107 * Reads gpm event and adds special keys to input buf. Returns length of
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 * generated key sequence.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02007109 * This function is styled after gui_send_mouse_event().
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 */
7111 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007112mch_gpm_process(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113{
7114 int button;
7115 static Gpm_Event gpm_event;
7116 char_u string[6];
7117 int_u vim_modifiers;
7118 int row,col;
7119 unsigned char buttons_mask;
7120 unsigned char gpm_modifiers;
7121 static unsigned char old_buttons = 0;
7122
7123 Gpm_GetEvent(&gpm_event);
7124
7125#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007126 // Don't put events in the input queue now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 if (hold_gui_events)
7128 return 0;
7129#endif
7130
7131 row = gpm_event.y - 1;
7132 col = gpm_event.x - 1;
7133
Bram Moolenaar0f873732019-12-05 20:28:46 +01007134 string[0] = ESC; // Our termcode
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 string[1] = 'M';
7136 string[2] = 'G';
7137 switch (GPM_BARE_EVENTS(gpm_event.type))
7138 {
7139 case GPM_DRAG:
7140 string[3] = MOUSE_DRAG;
7141 break;
7142 case GPM_DOWN:
7143 buttons_mask = gpm_event.buttons & ~old_buttons;
7144 old_buttons = gpm_event.buttons;
7145 switch (buttons_mask)
7146 {
7147 case GPM_B_LEFT:
7148 button = MOUSE_LEFT;
7149 break;
7150 case GPM_B_MIDDLE:
7151 button = MOUSE_MIDDLE;
7152 break;
7153 case GPM_B_RIGHT:
7154 button = MOUSE_RIGHT;
7155 break;
7156 default:
7157 return 0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007158 // Don't know what to do. Can more than one button be
7159 // reported in one event?
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 }
7161 string[3] = (char_u)(button | 0x20);
7162 SET_NUM_MOUSE_CLICKS(string[3], gpm_event.clicks + 1);
7163 break;
7164 case GPM_UP:
7165 string[3] = MOUSE_RELEASE;
7166 old_buttons &= ~gpm_event.buttons;
7167 break;
7168 default:
7169 return 0;
7170 }
Bram Moolenaar0f873732019-12-05 20:28:46 +01007171 // This code is based on gui_x11_mouse_cb in gui_x11.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 gpm_modifiers = gpm_event.modifiers;
7173 vim_modifiers = 0x0;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007174 // I ignore capslock stats. Aren't we all just hate capslock mixing with
7175 // Vim commands ? Besides, gpm_event.modifiers is unsigned char, and
7176 // K_CAPSSHIFT is defined 8, so it probably isn't even reported
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 if (gpm_modifiers & ((1 << KG_SHIFT) | (1 << KG_SHIFTR) | (1 << KG_SHIFTL)))
7178 vim_modifiers |= MOUSE_SHIFT;
7179
7180 if (gpm_modifiers & ((1 << KG_CTRL) | (1 << KG_CTRLR) | (1 << KG_CTRLL)))
7181 vim_modifiers |= MOUSE_CTRL;
7182 if (gpm_modifiers & ((1 << KG_ALT) | (1 << KG_ALTGR)))
7183 vim_modifiers |= MOUSE_ALT;
7184 string[3] |= vim_modifiers;
7185 string[4] = (char_u)(col + ' ' + 1);
7186 string[5] = (char_u)(row + ' ' + 1);
7187 add_to_input_buf(string, 6);
7188 return 6;
7189}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007190#endif // FEAT_MOUSE_GPM
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007192#ifdef FEAT_SYSMOUSE
7193/*
7194 * Initialize connection with sysmouse.
7195 * Let virtual console inform us with SIGUSR2 for pending sysmouse
7196 * output, any sysmouse output than will be processed via sig_sysmouse().
7197 * Return OK if succeeded, FAIL if failed.
7198 */
7199 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007200sysmouse_open(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007201{
7202 struct mouse_info mouse;
7203
7204 mouse.operation = MOUSE_MODE;
7205 mouse.u.mode.mode = 0;
7206 mouse.u.mode.signal = SIGUSR2;
7207 if (ioctl(1, CONS_MOUSECTL, &mouse) != -1)
7208 {
7209 signal(SIGUSR2, (RETSIGTYPE (*)())sig_sysmouse);
7210 mouse.operation = MOUSE_SHOW;
7211 ioctl(1, CONS_MOUSECTL, &mouse);
7212 return OK;
7213 }
7214 return FAIL;
7215}
7216
7217/*
7218 * Stop processing SIGUSR2 signals, and also make sure that
7219 * virtual console do not send us any sysmouse related signal.
7220 */
7221 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007222sysmouse_close(void)
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007223{
7224 struct mouse_info mouse;
7225
7226 signal(SIGUSR2, restricted ? SIG_IGN : SIG_DFL);
7227 mouse.operation = MOUSE_MODE;
7228 mouse.u.mode.mode = 0;
7229 mouse.u.mode.signal = 0;
7230 ioctl(1, CONS_MOUSECTL, &mouse);
7231}
7232
7233/*
7234 * Gets info from sysmouse and adds special keys to input buf.
7235 */
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007236 static RETSIGTYPE
7237sig_sysmouse SIGDEFARG(sigarg)
7238{
7239 struct mouse_info mouse;
7240 struct video_info video;
7241 char_u string[6];
7242 int row, col;
7243 int button;
7244 int buttons;
7245 static int oldbuttons = 0;
7246
7247#ifdef FEAT_GUI
Bram Moolenaar0f873732019-12-05 20:28:46 +01007248 // Don't put events in the input queue now.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007249 if (hold_gui_events)
7250 return;
7251#endif
7252
7253 mouse.operation = MOUSE_GETINFO;
7254 if (ioctl(1, FBIO_GETMODE, &video.vi_mode) != -1
7255 && ioctl(1, FBIO_MODEINFO, &video) != -1
7256 && ioctl(1, CONS_MOUSECTL, &mouse) != -1
7257 && video.vi_cheight > 0 && video.vi_cwidth > 0)
7258 {
7259 row = mouse.u.data.y / video.vi_cheight;
7260 col = mouse.u.data.x / video.vi_cwidth;
7261 buttons = mouse.u.data.buttons;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007262 string[0] = ESC; // Our termcode
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007263 string[1] = 'M';
7264 string[2] = 'S';
7265 if (oldbuttons == buttons && buttons != 0)
7266 {
7267 button = MOUSE_DRAG;
7268 }
7269 else
7270 {
7271 switch (buttons)
7272 {
7273 case 0:
7274 button = MOUSE_RELEASE;
7275 break;
7276 case 1:
7277 button = MOUSE_LEFT;
7278 break;
7279 case 2:
7280 button = MOUSE_MIDDLE;
7281 break;
7282 case 4:
7283 button = MOUSE_RIGHT;
7284 break;
7285 default:
7286 return;
7287 }
7288 oldbuttons = buttons;
7289 }
7290 string[3] = (char_u)(button);
7291 string[4] = (char_u)(col + ' ' + 1);
7292 string[5] = (char_u)(row + ' ' + 1);
7293 add_to_input_buf(string, 6);
7294 }
7295 return;
7296}
Bram Moolenaar0f873732019-12-05 20:28:46 +01007297#endif // FEAT_SYSMOUSE
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00007298
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299#if defined(FEAT_LIBCALL) || defined(PROTO)
Bram Moolenaard99df422016-01-29 23:20:40 +01007300typedef char_u * (*STRPROCSTR)(char_u *);
7301typedef char_u * (*INTPROCSTR)(int);
7302typedef int (*STRPROCINT)(char_u *);
7303typedef int (*INTPROCINT)(int);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304
7305/*
7306 * Call a DLL routine which takes either a string or int param
7307 * and returns an allocated string.
7308 */
7309 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007310mch_libcall(
7311 char_u *libname,
7312 char_u *funcname,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007313 char_u *argstring, // NULL when using a argint
Bram Moolenaar05540972016-01-30 20:31:25 +01007314 int argint,
Bram Moolenaar0f873732019-12-05 20:28:46 +01007315 char_u **string_result, // NULL when using number_result
Bram Moolenaar05540972016-01-30 20:31:25 +01007316 int *number_result)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317{
7318# if defined(USE_DLOPEN)
7319 void *hinstLib;
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007320 char *dlerr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321# else
7322 shl_t hinstLib;
7323# endif
7324 STRPROCSTR ProcAdd;
7325 INTPROCSTR ProcAddI;
7326 char_u *retval_str = NULL;
7327 int retval_int = 0;
7328 int success = FALSE;
7329
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007330 /*
7331 * Get a handle to the DLL module.
7332 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007334 // First clear any error, it's not cleared by the dlopen() call.
Bram Moolenaarb39ef122006-06-22 16:19:31 +00007335 (void)dlerror();
7336
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 hinstLib = dlopen((char *)libname, RTLD_LAZY
7338# ifdef RTLD_LOCAL
7339 | RTLD_LOCAL
7340# endif
7341 );
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007342 if (hinstLib == NULL)
7343 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007344 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007345 dlerr = (char *)dlerror();
7346 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007347 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349# else
7350 hinstLib = shl_load((const char*)libname, BIND_IMMEDIATE|BIND_VERBOSE, 0L);
7351# endif
7352
Bram Moolenaar0f873732019-12-05 20:28:46 +01007353 // If the handle is valid, try to get the function address.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 if (hinstLib != NULL)
7355 {
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007356# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 /*
7358 * Catch a crash when calling the library function. For example when
7359 * using a number where a string pointer is expected.
7360 */
7361 mch_startjmp();
7362 if (SETJMP(lc_jump_env) != 0)
7363 {
7364 success = FALSE;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007365# if defined(USE_DLOPEN)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007366 dlerr = NULL;
Bram Moolenaard68071d2006-05-02 22:08:30 +00007367# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 mch_didjmp();
7369 }
7370 else
7371# endif
7372 {
7373 retval_str = NULL;
7374 retval_int = 0;
7375
7376 if (argstring != NULL)
7377 {
7378# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007379 *(void **)(&ProcAdd) = dlsym(hinstLib, (const char *)funcname);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007380 dlerr = (char *)dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381# else
7382 if (shl_findsym(&hinstLib, (const char *)funcname,
7383 TYPE_PROCEDURE, (void *)&ProcAdd) < 0)
7384 ProcAdd = NULL;
7385# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007386 if ((success = (ProcAdd != NULL
7387# if defined(USE_DLOPEN)
7388 && dlerr == NULL
7389# endif
7390 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 {
7392 if (string_result == NULL)
7393 retval_int = ((STRPROCINT)ProcAdd)(argstring);
7394 else
7395 retval_str = (ProcAdd)(argstring);
7396 }
7397 }
7398 else
7399 {
7400# if defined(USE_DLOPEN)
Bram Moolenaar6d721c72017-01-17 16:56:28 +01007401 *(void **)(&ProcAddI) = dlsym(hinstLib, (const char *)funcname);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007402 dlerr = (char *)dlerror();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403# else
7404 if (shl_findsym(&hinstLib, (const char *)funcname,
7405 TYPE_PROCEDURE, (void *)&ProcAddI) < 0)
7406 ProcAddI = NULL;
7407# endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007408 if ((success = (ProcAddI != NULL
7409# if defined(USE_DLOPEN)
7410 && dlerr == NULL
7411# endif
7412 )))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 {
7414 if (string_result == NULL)
7415 retval_int = ((INTPROCINT)ProcAddI)(argint);
7416 else
7417 retval_str = (ProcAddI)(argint);
7418 }
7419 }
7420
Bram Moolenaar0f873732019-12-05 20:28:46 +01007421 // Save the string before we free the library.
7422 // Assume that a "1" or "-1" result is an illegal pointer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 if (string_result == NULL)
7424 *number_result = retval_int;
7425 else if (retval_str != NULL
7426 && retval_str != (char_u *)1
7427 && retval_str != (char_u *)-1)
7428 *string_result = vim_strsave(retval_str);
7429 }
7430
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007431# ifdef USING_SETJMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 mch_endjmp();
7433# ifdef SIGHASARG
7434 if (lc_signal != 0)
7435 {
7436 int i;
7437
Bram Moolenaar0f873732019-12-05 20:28:46 +01007438 // try to find the name of this signal
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 for (i = 0; signal_info[i].sig != -1; i++)
7440 if (lc_signal == signal_info[i].sig)
7441 break;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007442 semsg("E368: got SIG%s in libcall()", signal_info[i].name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 }
7444# endif
7445# endif
7446
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447# if defined(USE_DLOPEN)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007448 // "dlerr" must be used before dlclose()
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007449 if (dlerr != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007450 semsg(_("dlerror = \"%s\""), dlerr);
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00007451
Bram Moolenaar0f873732019-12-05 20:28:46 +01007452 // Free the DLL module.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 (void)dlclose(hinstLib);
7454# else
7455 (void)shl_unload(hinstLib);
7456# endif
7457 }
7458
7459 if (!success)
7460 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007461 semsg(_(e_libcall), funcname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 return FAIL;
7463 }
7464
7465 return OK;
7466}
7467#endif
7468
7469#if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007470static int xterm_trace = -1; // default: disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471static int xterm_button;
7472
7473/*
7474 * Setup a dummy window for X selections in a terminal.
7475 */
7476 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007477setup_term_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478{
7479 int z = 0;
7480 char *strp = "";
7481 Widget AppShell;
7482
7483 if (!x_connect_to_server())
7484 return;
7485
7486 open_app_context();
7487 if (app_context != NULL && xterm_Shell == (Widget)0)
7488 {
7489 int (*oldhandler)();
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007490# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 int (*oldIOhandler)();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007492# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007493# ifdef ELAPSED_FUNC
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01007494 elapsed_T start_tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495
7496 if (p_verbose > 0)
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007497 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498# endif
7499
Bram Moolenaar0f873732019-12-05 20:28:46 +01007500 // Ignore X errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 oldhandler = XSetErrorHandler(x_error_check);
7502
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007503# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007504 // Ignore X IO errors while opening the display
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 oldIOhandler = XSetIOErrorHandler(x_IOerror_check);
7506 mch_startjmp();
7507 if (SETJMP(lc_jump_env) != 0)
7508 {
7509 mch_didjmp();
7510 xterm_dpy = NULL;
7511 }
7512 else
Bram Moolenaaredce7422019-01-20 18:39:30 +01007513# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 {
7515 xterm_dpy = XtOpenDisplay(app_context, xterm_display,
7516 "vim_xterm", "Vim_xterm", NULL, 0, &z, &strp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007517 if (xterm_dpy != NULL)
7518 xterm_dpy_retry_count = 0;
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007519# if defined(USING_SETJMP)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 mch_endjmp();
Bram Moolenaaredce7422019-01-20 18:39:30 +01007521# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 }
7523
Bram Moolenaarb2148f52019-01-20 23:43:57 +01007524# if defined(USING_SETJMP)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007525 // Now handle X IO errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 (void)XSetIOErrorHandler(oldIOhandler);
Bram Moolenaaredce7422019-01-20 18:39:30 +01007527# endif
Bram Moolenaar0f873732019-12-05 20:28:46 +01007528 // Now handle X errors normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 (void)XSetErrorHandler(oldhandler);
7530
7531 if (xterm_dpy == NULL)
7532 {
7533 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007534 verb_msg(_("Opening the X display failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 return;
7536 }
7537
Bram Moolenaar0f873732019-12-05 20:28:46 +01007538 // Catch terminating error of the X server connection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 (void)XSetIOErrorHandler(x_IOerror_handler);
7540
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007541# ifdef ELAPSED_FUNC
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007543 {
7544 verbose_enter();
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01007545 xopen_message(ELAPSED_FUNC(start_tv));
Bram Moolenaara04f10b2005-05-31 22:09:46 +00007546 verbose_leave();
7547 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548# endif
7549
Bram Moolenaar0f873732019-12-05 20:28:46 +01007550 // Create a Shell to make converters work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 AppShell = XtVaAppCreateShell("vim_xterm", "Vim_xterm",
7552 applicationShellWidgetClass, xterm_dpy,
7553 NULL);
7554 if (AppShell == (Widget)0)
7555 return;
7556 xterm_Shell = XtVaCreatePopupShell("VIM",
7557 topLevelShellWidgetClass, AppShell,
7558 XtNmappedWhenManaged, 0,
7559 XtNwidth, 1,
7560 XtNheight, 1,
7561 NULL);
7562 if (xterm_Shell == (Widget)0)
7563 return;
7564
7565 x11_setup_atoms(xterm_dpy);
Bram Moolenaar7cfea752010-06-22 06:07:12 +02007566 x11_setup_selection(xterm_Shell);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 if (x11_display == NULL)
7568 x11_display = xterm_dpy;
7569
7570 XtRealizeWidget(xterm_Shell);
7571 XSync(xterm_dpy, False);
7572 xterm_update();
7573 }
7574 if (xterm_Shell != (Widget)0)
7575 {
7576 clip_init(TRUE);
7577 if (x11_window == 0 && (strp = getenv("WINDOWID")) != NULL)
7578 x11_window = (Window)atol(strp);
Bram Moolenaar0f873732019-12-05 20:28:46 +01007579 // Check if $WINDOWID is valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 if (test_x11_window(xterm_dpy) == FAIL)
7581 x11_window = 0;
7582 if (x11_window != 0)
7583 xterm_trace = 0;
7584 }
7585}
7586
7587 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007588start_xterm_trace(int button)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589{
7590 if (x11_window == 0 || xterm_trace < 0 || xterm_Shell == (Widget)0)
7591 return;
7592 xterm_trace = 1;
7593 xterm_button = button;
7594 do_xterm_trace();
7595}
7596
7597
7598 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007599stop_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600{
7601 if (xterm_trace < 0)
7602 return;
7603 xterm_trace = 0;
7604}
7605
7606/*
7607 * Query the xterm pointer and generate mouse termcodes if necessary
7608 * return TRUE if dragging is active, else FALSE
7609 */
7610 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01007611do_xterm_trace(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612{
7613 Window root, child;
7614 int root_x, root_y;
7615 int win_x, win_y;
7616 int row, col;
7617 int_u mask_return;
7618 char_u buf[50];
7619 char_u *strp;
7620 long got_hints;
7621 static char_u *mouse_code;
7622 static char_u mouse_name[2] = {KS_MOUSE, KE_FILLER};
7623 static int prev_row = 0, prev_col = 0;
7624 static XSizeHints xterm_hints;
7625
7626 if (xterm_trace <= 0)
7627 return FALSE;
7628
7629 if (xterm_trace == 1)
7630 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007631 // Get the hints just before tracking starts. The font size might
7632 // have changed recently.
Bram Moolenaara6c2c912008-01-13 15:31:00 +00007633 if (!XGetWMNormalHints(xterm_dpy, x11_window, &xterm_hints, &got_hints)
7634 || !(got_hints & PResizeInc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 || xterm_hints.width_inc <= 1
7636 || xterm_hints.height_inc <= 1)
7637 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007638 xterm_trace = -1; // Not enough data -- disable tracing
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 return FALSE;
7640 }
7641
Bram Moolenaar0f873732019-12-05 20:28:46 +01007642 // Rely on the same mouse code for the duration of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 mouse_code = find_termcode(mouse_name);
7644 prev_row = mouse_row;
Bram Moolenaarcde88542015-08-11 19:14:00 +02007645 prev_col = mouse_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 xterm_trace = 2;
7647
Bram Moolenaar0f873732019-12-05 20:28:46 +01007648 // Find the offset of the chars, there might be a scrollbar on the
7649 // left of the window and/or a menu on the top (eterm etc.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7651 &win_x, &win_y, &mask_return);
7652 xterm_hints.y = win_y - (xterm_hints.height_inc * mouse_row)
7653 - (xterm_hints.height_inc / 2);
7654 if (xterm_hints.y <= xterm_hints.height_inc / 2)
7655 xterm_hints.y = 2;
7656 xterm_hints.x = win_x - (xterm_hints.width_inc * mouse_col)
7657 - (xterm_hints.width_inc / 2);
7658 if (xterm_hints.x <= xterm_hints.width_inc / 2)
7659 xterm_hints.x = 2;
7660 return TRUE;
7661 }
Bram Moolenaaref9d6aa2011-04-11 16:56:35 +02007662 if (mouse_code == NULL || STRLEN(mouse_code) > 45)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 {
7664 xterm_trace = 0;
7665 return FALSE;
7666 }
7667
7668 XQueryPointer(xterm_dpy, x11_window, &root, &child, &root_x, &root_y,
7669 &win_x, &win_y, &mask_return);
7670
7671 row = check_row((win_y - xterm_hints.y) / xterm_hints.height_inc);
7672 col = check_col((win_x - xterm_hints.x) / xterm_hints.width_inc);
7673 if (row == prev_row && col == prev_col)
7674 return TRUE;
7675
7676 STRCPY(buf, mouse_code);
7677 strp = buf + STRLEN(buf);
7678 *strp++ = (xterm_button | MOUSE_DRAG) & ~0x20;
7679 *strp++ = (char_u)(col + ' ' + 1);
7680 *strp++ = (char_u)(row + ' ' + 1);
7681 *strp = 0;
7682 add_to_input_buf(buf, STRLEN(buf));
7683
7684 prev_row = row;
7685 prev_col = col;
7686 return TRUE;
7687}
7688
Bram Moolenaard4aa83a2019-05-09 18:59:31 +02007689# if defined(FEAT_GUI) || defined(FEAT_XCLIPBOARD) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690/*
7691 * Destroy the display, window and app_context. Required for GTK.
7692 */
7693 void
Bram Moolenaar05540972016-01-30 20:31:25 +01007694clear_xterm_clip(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695{
7696 if (xterm_Shell != (Widget)0)
7697 {
7698 XtDestroyWidget(xterm_Shell);
7699 xterm_Shell = (Widget)0;
7700 }
7701 if (xterm_dpy != NULL)
7702 {
Bram Moolenaare8208012008-06-20 09:59:25 +00007703# if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01007704 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 XtCloseDisplay(xterm_dpy);
Bram Moolenaare8208012008-06-20 09:59:25 +00007706# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 if (x11_display == xterm_dpy)
7708 x11_display = NULL;
7709 xterm_dpy = NULL;
7710 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007711# if 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 if (app_context != (XtAppContext)NULL)
7713 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007714 // Lesstif and Solaris crash here, lose some memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 XtDestroyApplicationContext(app_context);
7716 app_context = (XtAppContext)NULL;
7717 }
Bram Moolenaare8208012008-06-20 09:59:25 +00007718# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719}
7720# endif
7721
7722/*
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007723 * Catch up with GUI or X events.
7724 */
7725 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007726clip_update(void)
Bram Moolenaar090cfc12013-03-19 12:35:42 +01007727{
7728# ifdef FEAT_GUI
7729 if (gui.in_use)
7730 gui_mch_update();
7731 else
7732# endif
7733 if (xterm_Shell != (Widget)0)
7734 xterm_update();
7735}
7736
7737/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 * Catch up with any queued X events. This may put keyboard input into the
7739 * input buffer, call resize call-backs, trigger timers etc. If there is
7740 * nothing in the X event queue (& no timers pending), then we return
7741 * immediately.
7742 */
7743 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007744xterm_update(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745{
7746 XEvent event;
7747
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007748 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 {
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007750 XtInputMask mask = XtAppPending(app_context);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007752 if (mask == 0 || vim_is_input_buf_full())
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007753 break;
7754
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007755 if (mask & XtIMXEvent)
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007756 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007757 // There is an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007758 XtAppNextEvent(app_context, &event);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007759#ifdef FEAT_CLIENTSERVER
7760 {
7761 XPropertyEvent *e = (XPropertyEvent *)&event;
7762
7763 if (e->type == PropertyNotify && e->window == commWindow
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 && e->atom == commProperty && e->state == PropertyNewValue)
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007765 serverEventProc(xterm_dpy, &event, 0);
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007766 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767#endif
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007768 XtDispatchEvent(&event);
7769 }
Bram Moolenaarb1fc2bf2015-03-20 16:26:54 +01007770 else
7771 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007772 // There is something else than an event to process.
Bram Moolenaar93c88e02015-09-15 14:12:05 +02007773 XtAppProcessEvent(app_context, mask);
7774 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 }
7776}
7777
7778 int
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007779clip_xterm_own_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780{
7781 if (xterm_Shell != (Widget)0)
7782 return clip_x11_own_selection(xterm_Shell, cbd);
7783 return FAIL;
7784}
7785
7786 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007787clip_xterm_lose_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788{
7789 if (xterm_Shell != (Widget)0)
7790 clip_x11_lose_selection(xterm_Shell, cbd);
7791}
7792
7793 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007794clip_xterm_request_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795{
7796 if (xterm_Shell != (Widget)0)
7797 clip_x11_request_selection(xterm_Shell, xterm_dpy, cbd);
7798}
7799
7800 void
Bram Moolenaar0554fa42019-06-14 21:36:54 +02007801clip_xterm_set_selection(Clipboard_T *cbd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802{
7803 clip_x11_set_selection(cbd);
7804}
7805#endif
7806
7807
7808#if defined(USE_XSMP) || defined(PROTO)
7809/*
7810 * Code for X Session Management Protocol.
7811 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812
7813# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814/*
7815 * This is our chance to ask the user if they want to save,
7816 * or abort the logout
7817 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007819xsmp_handle_interaction(SmcConn smc_conn, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820{
7821 cmdmod_T save_cmdmod;
7822 int cancel_shutdown = False;
7823
7824 save_cmdmod = cmdmod;
7825 cmdmod.confirm = TRUE;
Bram Moolenaar027387f2016-01-02 22:25:52 +01007826 if (check_changed_any(FALSE, FALSE))
Bram Moolenaar0f873732019-12-05 20:28:46 +01007827 // Mustn't logout
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 cancel_shutdown = True;
7829 cmdmod = save_cmdmod;
Bram Moolenaar0f873732019-12-05 20:28:46 +01007830 setcursor(); // position cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 out_flush();
7832
Bram Moolenaar0f873732019-12-05 20:28:46 +01007833 // Done interaction
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 SmcInteractDone(smc_conn, cancel_shutdown);
7835
Bram Moolenaar0f873732019-12-05 20:28:46 +01007836 // Finish off
7837 // Only end save-yourself here if we're not cancelling shutdown;
7838 // we'll get a cancelled callback later in which we'll end it.
7839 // Hopefully get around glitchy SMs (like GNOME-1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 if (!cancel_shutdown)
7841 {
7842 xsmp.save_yourself = False;
7843 SmcSaveYourselfDone(smc_conn, True);
7844 }
7845}
7846# endif
7847
7848/*
7849 * Callback that starts save-yourself.
7850 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007852xsmp_handle_save_yourself(
7853 SmcConn smc_conn,
7854 SmPointer client_data UNUSED,
7855 int save_type UNUSED,
7856 Bool shutdown,
7857 int interact_style UNUSED,
7858 Bool fast UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007860 // Handle already being in saveyourself
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 if (xsmp.save_yourself)
7862 SmcSaveYourselfDone(smc_conn, True);
7863 xsmp.save_yourself = True;
7864 xsmp.shutdown = shutdown;
7865
Bram Moolenaar0f873732019-12-05 20:28:46 +01007866 // First up, preserve all files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 out_flush();
Bram Moolenaar0f873732019-12-05 20:28:46 +01007868 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869
7870 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007871 verb_msg(_("XSMP handling save-yourself request"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872
7873# if defined(FEAT_GUI) && defined(USE_XSMP_INTERACT)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007874 // Now see if we can ask about unsaved files
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 if (shutdown && !fast && gui.in_use)
Bram Moolenaar0f873732019-12-05 20:28:46 +01007876 // Need to interact with user, but need SM's permission
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 SmcInteractRequest(smc_conn, SmDialogError,
7878 xsmp_handle_interaction, client_data);
7879 else
7880# endif
7881 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007882 // Can stop the cycle here
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 SmcSaveYourselfDone(smc_conn, True);
7884 xsmp.save_yourself = False;
7885 }
7886}
7887
7888
7889/*
7890 * Callback to warn us of imminent death.
7891 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007893xsmp_die(SmcConn smc_conn UNUSED, SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894{
7895 xsmp_close();
7896
Bram Moolenaar0f873732019-12-05 20:28:46 +01007897 // quit quickly leaving swapfiles for modified buffers behind
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 getout_preserve_modified(0);
7899}
7900
7901
7902/*
7903 * Callback to tell us that save-yourself has completed.
7904 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007906xsmp_save_complete(
7907 SmcConn smc_conn UNUSED,
7908 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909{
7910 xsmp.save_yourself = False;
7911}
7912
7913
7914/*
7915 * Callback to tell us that an instigated shutdown was cancelled
7916 * (maybe even by us)
7917 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007919xsmp_shutdown_cancelled(
7920 SmcConn smc_conn,
7921 SmPointer client_data UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922{
7923 if (xsmp.save_yourself)
7924 SmcSaveYourselfDone(smc_conn, True);
7925 xsmp.save_yourself = False;
7926 xsmp.shutdown = False;
7927}
7928
7929
7930/*
7931 * Callback to tell us that a new ICE connection has been established.
7932 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01007934xsmp_ice_connection(
7935 IceConn iceConn,
7936 IcePointer clientData UNUSED,
7937 Bool opening,
7938 IcePointer *watchData UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939{
Bram Moolenaar0f873732019-12-05 20:28:46 +01007940 // Intercept creation of ICE connection fd
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941 if (opening)
7942 {
7943 xsmp_icefd = IceConnectionNumber(iceConn);
7944 IceRemoveConnectionWatch(xsmp_ice_connection, NULL);
7945 }
7946}
7947
7948
Bram Moolenaar0f873732019-12-05 20:28:46 +01007949// Handle any ICE processing that's required; return FAIL if SM lost
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 int
Bram Moolenaar05540972016-01-30 20:31:25 +01007951xsmp_handle_requests(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952{
7953 Bool rep;
7954
7955 if (IceProcessMessages(xsmp.iceconn, NULL, &rep)
7956 == IceProcessMessagesIOError)
7957 {
Bram Moolenaar0f873732019-12-05 20:28:46 +01007958 // Lost ICE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007960 verb_msg(_("XSMP lost ICE connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 xsmp_close();
7962 return FAIL;
7963 }
7964 else
7965 return OK;
7966}
7967
7968static int dummy;
7969
Bram Moolenaar0f873732019-12-05 20:28:46 +01007970// Set up X Session Management Protocol
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 void
7972xsmp_init(void)
7973{
7974 char errorstring[80];
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 SmcCallbacks smcallbacks;
7976#if 0
7977 SmPropValue smname;
7978 SmProp smnameprop;
7979 SmProp *smprops[1];
7980#endif
7981
7982 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007983 verb_msg(_("XSMP opening connection"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984
7985 xsmp.save_yourself = xsmp.shutdown = False;
7986
Bram Moolenaar0f873732019-12-05 20:28:46 +01007987 // Set up SM callbacks - must have all, even if they're not used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 smcallbacks.save_yourself.callback = xsmp_handle_save_yourself;
7989 smcallbacks.save_yourself.client_data = NULL;
7990 smcallbacks.die.callback = xsmp_die;
7991 smcallbacks.die.client_data = NULL;
7992 smcallbacks.save_complete.callback = xsmp_save_complete;
7993 smcallbacks.save_complete.client_data = NULL;
7994 smcallbacks.shutdown_cancelled.callback = xsmp_shutdown_cancelled;
7995 smcallbacks.shutdown_cancelled.client_data = NULL;
7996
Bram Moolenaar0f873732019-12-05 20:28:46 +01007997 // Set up a watch on ICE connection creations. The "dummy" argument is
7998 // apparently required for FreeBSD (we get a BUS error when using NULL).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 if (IceAddConnectionWatch(xsmp_ice_connection, &dummy) == 0)
8000 {
8001 if (p_verbose > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008002 verb_msg(_("XSMP ICE connection watch failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 return;
8004 }
8005
Bram Moolenaar0f873732019-12-05 20:28:46 +01008006 // Create an SM connection
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 xsmp.smcconn = SmcOpenConnection(
8008 NULL,
8009 NULL,
8010 SmProtoMajor,
8011 SmProtoMinor,
8012 SmcSaveYourselfProcMask | SmcDieProcMask
8013 | SmcSaveCompleteProcMask | SmcShutdownCancelledProcMask,
8014 &smcallbacks,
8015 NULL,
Bram Moolenaare8208012008-06-20 09:59:25 +00008016 &xsmp.clientid,
Bram Moolenaar4841a7c2018-09-22 14:08:49 +02008017 sizeof(errorstring) - 1,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 errorstring);
8019 if (xsmp.smcconn == NULL)
8020 {
8021 char errorreport[132];
Bram Moolenaar051b7822005-05-19 21:00:46 +00008022
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 if (p_verbose > 0)
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008024 {
8025 vim_snprintf(errorreport, sizeof(errorreport),
8026 _("XSMP SmcOpenConnection failed: %s"), errorstring);
Bram Moolenaar32526b32019-01-19 17:43:09 +01008027 verb_msg(errorreport);
Bram Moolenaara04f10b2005-05-31 22:09:46 +00008028 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 return;
8030 }
8031 xsmp.iceconn = SmcGetIceConnection(xsmp.smcconn);
8032
8033#if 0
Bram Moolenaar0f873732019-12-05 20:28:46 +01008034 // ID ourselves
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 smname.value = "vim";
8036 smname.length = 3;
8037 smnameprop.name = "SmProgram";
8038 smnameprop.type = "SmARRAY8";
8039 smnameprop.num_vals = 1;
8040 smnameprop.vals = &smname;
8041
8042 smprops[0] = &smnameprop;
8043 SmcSetProperties(xsmp.smcconn, 1, smprops);
8044#endif
8045}
8046
8047
Bram Moolenaar0f873732019-12-05 20:28:46 +01008048// Shut down XSMP comms.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008050xsmp_close(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051{
8052 if (xsmp_icefd != -1)
8053 {
8054 SmcCloseConnection(xsmp.smcconn, 0, NULL);
Bram Moolenaar5a221812008-11-12 12:08:45 +00008055 if (xsmp.clientid != NULL)
8056 free(xsmp.clientid);
Bram Moolenaare8208012008-06-20 09:59:25 +00008057 xsmp.clientid = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 xsmp_icefd = -1;
8059 }
8060}
Bram Moolenaar0f873732019-12-05 20:28:46 +01008061#endif // USE_XSMP
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062
8063
8064#ifdef EBCDIC
Bram Moolenaar0f873732019-12-05 20:28:46 +01008065// Translate character to its CTRL- value
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066char CtrlTable[] =
8067{
8068/* 00 - 5E */
8069 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8070 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8071 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8072 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8073 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8074 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8075/* ^ */ 0x1E,
8076/* - */ 0x1F,
8077/* 61 - 6C */
8078 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8079/* _ */ 0x1F,
8080/* 6E - 80 */
8081 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8082/* a */ 0x01,
8083/* b */ 0x02,
8084/* c */ 0x03,
8085/* d */ 0x37,
8086/* e */ 0x2D,
8087/* f */ 0x2E,
8088/* g */ 0x2F,
8089/* h */ 0x16,
8090/* i */ 0x05,
8091/* 8A - 90 */
8092 0, 0, 0, 0, 0, 0, 0,
8093/* j */ 0x15,
8094/* k */ 0x0B,
8095/* l */ 0x0C,
8096/* m */ 0x0D,
8097/* n */ 0x0E,
8098/* o */ 0x0F,
8099/* p */ 0x10,
8100/* q */ 0x11,
8101/* r */ 0x12,
8102/* 9A - A1 */
8103 0, 0, 0, 0, 0, 0, 0, 0,
8104/* s */ 0x13,
8105/* t */ 0x3C,
8106/* u */ 0x3D,
8107/* v */ 0x32,
8108/* w */ 0x26,
8109/* x */ 0x18,
8110/* y */ 0x19,
8111/* z */ 0x3F,
8112/* AA - AC */
8113 0, 0, 0,
8114/* [ */ 0x27,
8115/* AE - BC */
8116 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8117/* ] */ 0x1D,
8118/* BE - C0 */ 0, 0, 0,
8119/* A */ 0x01,
8120/* B */ 0x02,
8121/* C */ 0x03,
8122/* D */ 0x37,
8123/* E */ 0x2D,
8124/* F */ 0x2E,
8125/* G */ 0x2F,
8126/* H */ 0x16,
8127/* I */ 0x05,
8128/* CA - D0 */ 0, 0, 0, 0, 0, 0, 0,
8129/* J */ 0x15,
8130/* K */ 0x0B,
8131/* L */ 0x0C,
8132/* M */ 0x0D,
8133/* N */ 0x0E,
8134/* O */ 0x0F,
8135/* P */ 0x10,
8136/* Q */ 0x11,
8137/* R */ 0x12,
8138/* DA - DF */ 0, 0, 0, 0, 0, 0,
8139/* \ */ 0x1C,
8140/* E1 */ 0,
8141/* S */ 0x13,
8142/* T */ 0x3C,
8143/* U */ 0x3D,
8144/* V */ 0x32,
8145/* W */ 0x26,
8146/* X */ 0x18,
8147/* Y */ 0x19,
8148/* Z */ 0x3F,
8149/* EA - FF*/ 0, 0, 0, 0, 0, 0,
8150 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
8151};
8152
8153char MetaCharTable[]=
Bram Moolenaar0f873732019-12-05 20:28:46 +01008154{// 0 1 2 3 4 5 6 7 8 9 A B C D E F
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 0, 0, 0, 0,'\\', 0,'F', 0,'W','M','N', 0, 0, 0, 0, 0,
8156 0, 0, 0, 0,']', 0, 0,'G', 0, 0,'R','O', 0, 0, 0, 0,
8157 '@','A','B','C','D','E', 0, 0,'H','I','J','K','L', 0, 0, 0,
8158 'P','Q', 0,'S','T','U','V', 0,'X','Y','Z','[', 0, 0,'^', 0
8159};
8160
8161
Bram Moolenaar0f873732019-12-05 20:28:46 +01008162// TODO: Use characters NOT numbers!!!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163char CtrlCharTable[]=
Bram Moolenaar0f873732019-12-05 20:28:46 +01008164{// 0 1 2 3 4 5 6 7 8 9 A B C D E F
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 124,193,194,195, 0,201, 0, 0, 0, 0, 0,210,211,212,213,214,
8166 215,216,217,226, 0,209,200, 0,231,232, 0, 0,224,189, 95,109,
8167 0, 0, 0, 0, 0, 0,230,173, 0, 0, 0, 0, 0,197,198,199,
8168 0, 0,229, 0, 0, 0, 0,196, 0, 0, 0, 0,227,228, 0,233,
8169};
8170
8171
8172#endif