blob: 2af0288ce4938dbc150382b11b64f1281012ded2 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sw=8 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 * Visual Workshop integration by Gordon Prieur
5 *
6 * Do ":help uganda" in Vim to read copying and usage conditions.
7 * Do ":help credits" in Vim to see a list of people who contributed.
8 * See README.txt for an overview of the Vim source code.
9 */
10
11/*
12 * NetBeans Debugging Tools. What are these tools and why are they important?
13 * There are two main tools here. The first tool is a tool for delaying or
14 * stopping gvim during startup. The second tool is a protocol log tool.
15 *
16 * The startup delay tool is called nbdebug_wait(). This is very important for
17 * debugging startup problems because gvim will be started automatically from
18 * netbeans and cannot be run directly from a debugger. The only way to debug
19 * a gvim started by netbeans is by attaching a debugger to it. Without this
Bram Moolenaar84a05ac2013-05-06 04:24:17 +020020 * tool all startup code will have completed before you can get the pid and
Bram Moolenaar071d4272004-06-13 20:20:40 +000021 * attach.
22 *
23 * The second tool is a log tool.
24 *
25 * This code must have NBDEBUG defined for it to be compiled into vim/gvim.
26 */
27
28#ifdef NBDEBUG
29
Bram Moolenaar071d4272004-06-13 20:20:40 +000030#include "vim.h"
31
32FILE *nb_debug = NULL;
33u_int nb_dlevel = 0; /* nb_debug verbosity level */
34
35void nbdb(char *, ...);
Bram Moolenaar071d4272004-06-13 20:20:40 +000036
37static int lookup(char *);
Bram Moolenaar446cb832008-06-24 21:56:24 +000038#ifdef USE_NB_ERRORHANDLER
Bram Moolenaar071d4272004-06-13 20:20:40 +000039static int errorHandler(Display *, XErrorEvent *);
40#endif
41
42/*
43 * nbdebug_wait - This function can be used to delay or stop execution of vim.
Bram Moolenaar9af41842016-09-25 21:45:05 +020044 * It's normally used to delay startup while attaching a
Bram Moolenaarbb1969b2019-01-17 15:45:25 +010045 * debugger to a running process. Since NetBeans starts gvim
Bram Moolenaar071d4272004-06-13 20:20:40 +000046 * from a background process this is the only way to debug
47 * startup problems.
48 */
49
50void nbdebug_wait(
51 u_int wait_flags, /* tells what to do */
52 char *wait_var, /* wait environment variable */
53 u_int wait_secs) /* how many seconds to wait */
54{
55
56 init_homedir(); /* not inited yet */
57#ifdef USE_WDDUMP
58 WDDump(0, 0, 0);
59#endif
60
61 /* for debugging purposes only */
62 if (wait_flags & WT_ENV && wait_var && getenv(wait_var) != NULL) {
63 sleep(atoi(getenv(wait_var)));
64 } else if (wait_flags & WT_WAIT && lookup("~/.gvimwait")) {
65 sleep(wait_secs > 0 && wait_secs < 120 ? wait_secs : 20);
66 } else if (wait_flags & WT_STOP && lookup("~/.gvimstop")) {
67 int w = 1;
68 while (w) {
69 ;
70 }
71 }
72} /* end nbdebug_wait */
73
74
75void
76nbdebug_log_init(
77 char *log_var, /* env var with log file */
78 char *level_var) /* env var with nb_debug level */
79{
80 char *file; /* possible nb_debug output file */
81 char *cp; /* nb_dlevel pointer */
82
Bram Moolenaar63d25552019-05-10 21:28:38 +020083 if (log_var && (file = getenv(log_var)) != NULL)
84 {
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 time_t now;
86
87 nb_debug = fopen(file, "a");
88 time(&now);
Bram Moolenaar63d25552019-05-10 21:28:38 +020089 fprintf(nb_debug, "%s", get_ctime(now, TRUE));
Bram Moolenaar071d4272004-06-13 20:20:40 +000090 if (level_var && (cp = getenv(level_var)) != NULL) {
91 nb_dlevel = strtoul(cp, NULL, 0);
92 } else {
93 nb_dlevel = NB_TRACE; /* default level */
94 }
Bram Moolenaar446cb832008-06-24 21:56:24 +000095#ifdef USE_NB_ERRORHANDLER
96 XSetErrorHandler(errorHandler);
97#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000098 }
99
100} /* end nbdebug_log_init */
101
102
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103void
104nbdbg(
105 char *fmt,
106 ...)
107{
108 va_list ap;
109
Bram Moolenaar009b2592004-10-24 19:18:58 +0000110 if (nb_debug != NULL && nb_dlevel & NB_TRACE) {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 va_start(ap, fmt);
112 vfprintf(nb_debug, fmt, ap);
113 va_end(ap);
114 fflush(nb_debug);
115 }
116
117} /* end nbdbg */
118
119
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120static int
121lookup(
122 char *file)
123{
124 char buf[BUFSIZ];
125
126 expand_env((char_u *) file, (char_u *) buf, BUFSIZ);
127 return
Bram Moolenaar4f974752019-02-17 17:44:42 +0100128#ifndef FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129 (access(buf, F_OK) == 0);
130#else
131 (access(buf, 0) == 0);
132#endif
133
134} /* end lookup */
135
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136#ifdef USE_NB_ERRORHANDLER
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137static int
138errorHandler(
139 Display *dpy,
140 XErrorEvent *err)
141{
142 char msg[256];
143 char buf[256];
144
145 XGetErrorText(dpy, err->error_code, msg, sizeof(msg));
146 nbdbg("\n\nNBDEBUG Vim: X Error of failed request: %s\n", msg);
147
148 sprintf(buf, "%d", err->request_code);
149 XGetErrorDatabaseText(dpy,
150 "XRequest", buf, "Unknown", msg, sizeof(msg));
151 nbdbg("\tMajor opcode of failed request: %d (%s)\n",
152 err->request_code, msg);
153 if (err->request_code > 128) {
154 nbdbg("\tMinor opcode of failed request: %d\n",
155 err->minor_code);
156 }
157
158 return 0;
159}
160#endif
161
162
163#endif /* NBDEBUG */