annotate src/nbdebug.c @ 18478:94223687df0e

Added tag v8.1.2233 for changeset e93cab5d0f0f27fad7882f1f412927df055b090d
author Bram Moolenaar <Bram@vim.org>
date Tue, 29 Oct 2019 04:30:05 +0100
parents 7ad3fc329e08
children 7982f65d8f54
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10042
4aead6a9b7a9 commit https://github.com/vim/vim/commit/edf3f97ae2af024708ebb4ac614227327033ca47
Christian Brabandt <cb@256bit.org>
parents: 4352
diff changeset
1 /* vi:set ts=8 sw=8 noet:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2 *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 * VIM - Vi IMproved by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 * Visual Workshop integration by Gordon Prieur
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5 *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6 * Do ":help uganda" in Vim to read copying and usage conditions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 * Do ":help credits" in Vim to see a list of people who contributed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8 * See README.txt for an overview of the Vim source code.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 /*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 * NetBeans Debugging Tools. What are these tools and why are they important?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 * There are two main tools here. The first tool is a tool for delaying or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 * stopping gvim during startup. The second tool is a protocol log tool.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 * The startup delay tool is called nbdebug_wait(). This is very important for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 * debugging startup problems because gvim will be started automatically from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 * netbeans and cannot be run directly from a debugger. The only way to debug
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 * a gvim started by netbeans is by attaching a debugger to it. Without this
4352
04736b4030ec updated for version 7.3.925
Bram Moolenaar <bram@vim.org>
parents: 1817
diff changeset
20 * tool all startup code will have completed before you can get the pid and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 * attach.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 * The second tool is a log tool.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 * This code must have NBDEBUG defined for it to be compiled into vim/gvim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 #ifdef NBDEBUG
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 #include "vim.h"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 FILE *nb_debug = NULL;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 u_int nb_dlevel = 0; /* nb_debug verbosity level */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 void nbdb(char *, ...);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 static int lookup(char *);
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
38 #ifdef USE_NB_ERRORHANDLER
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 static int errorHandler(Display *, XErrorEvent *);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 /*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 * nbdebug_wait - This function can be used to delay or stop execution of vim.
10226
7a4fb555c83a commit https://github.com/vim/vim/commit/9af418427652562384744648d7d173a4bfebba95
Christian Brabandt <cb@256bit.org>
parents: 10042
diff changeset
44 * It's normally used to delay startup while attaching a
15510
41fbbcea0f1b patch 8.1.0763: nobody is using the Sun Workshop support
Bram Moolenaar <Bram@vim.org>
parents: 10226
diff changeset
45 * debugger to a running process. Since NetBeans starts gvim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 * from a background process this is the only way to debug
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 * startup problems.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 void nbdebug_wait(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 u_int wait_flags, /* tells what to do */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 char *wait_var, /* wait environment variable */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 u_int wait_secs) /* how many seconds to wait */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 init_homedir(); /* not inited yet */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 #ifdef USE_WDDUMP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 WDDump(0, 0, 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 /* for debugging purposes only */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 if (wait_flags & WT_ENV && wait_var && getenv(wait_var) != NULL) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 sleep(atoi(getenv(wait_var)));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 } else if (wait_flags & WT_WAIT && lookup("~/.gvimwait")) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 sleep(wait_secs > 0 && wait_secs < 120 ? wait_secs : 20);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 } else if (wait_flags & WT_STOP && lookup("~/.gvimstop")) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 int w = 1;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 while (w) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 ;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 } /* end nbdebug_wait */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 void
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 nbdebug_log_init(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 char *log_var, /* env var with log file */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 char *level_var) /* env var with nb_debug level */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 char *file; /* possible nb_debug output file */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 char *cp; /* nb_dlevel pointer */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82
16621
7ad3fc329e08 patch 8.1.1313: warnings for using localtime() and ctime()
Bram Moolenaar <Bram@vim.org>
parents: 15868
diff changeset
83 if (log_var && (file = getenv(log_var)) != NULL)
7ad3fc329e08 patch 8.1.1313: warnings for using localtime() and ctime()
Bram Moolenaar <Bram@vim.org>
parents: 15868
diff changeset
84 {
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 time_t now;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 nb_debug = fopen(file, "a");
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 time(&now);
16621
7ad3fc329e08 patch 8.1.1313: warnings for using localtime() and ctime()
Bram Moolenaar <Bram@vim.org>
parents: 15868
diff changeset
89 fprintf(nb_debug, "%s", get_ctime(now, TRUE));
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 if (level_var && (cp = getenv(level_var)) != NULL) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 nb_dlevel = strtoul(cp, NULL, 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 } else {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 nb_dlevel = NB_TRACE; /* default level */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 }
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
95 #ifdef USE_NB_ERRORHANDLER
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
96 XSetErrorHandler(errorHandler);
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
97 #endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 } /* end nbdebug_log_init */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 void
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 nbdbg(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 char *fmt,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 ...)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 va_list ap;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 7
diff changeset
110 if (nb_debug != NULL && nb_dlevel & NB_TRACE) {
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 va_start(ap, fmt);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 vfprintf(nb_debug, fmt, ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 va_end(ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 fflush(nb_debug);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 } /* end nbdbg */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 static int
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 lookup(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 char *file)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124 char buf[BUFSIZ];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 expand_env((char_u *) file, (char_u *) buf, BUFSIZ);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 return
15868
7fad90423bd2 patch 8.1.0941: macros for MS-Windows are inconsistent
Bram Moolenaar <Bram@vim.org>
parents: 15510
diff changeset
128 #ifndef FEAT_GUI_MSWIN
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 (access(buf, F_OK) == 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 #else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 (access(buf, 0) == 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 } /* end lookup */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
136 #ifdef USE_NB_ERRORHANDLER
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 static int
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 errorHandler(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 Display *dpy,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 XErrorEvent *err)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 char msg[256];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 char buf[256];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 XGetErrorText(dpy, err->error_code, msg, sizeof(msg));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 nbdbg("\n\nNBDEBUG Vim: X Error of failed request: %s\n", msg);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 sprintf(buf, "%d", err->request_code);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 XGetErrorDatabaseText(dpy,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 "XRequest", buf, "Unknown", msg, sizeof(msg));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 nbdbg("\tMajor opcode of failed request: %d (%s)\n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 err->request_code, msg);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 if (err->request_code > 128) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 nbdbg("\tMinor opcode of failed request: %d\n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 err->minor_code);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 return 0;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 #endif /* NBDEBUG */