annotate src/nbdebug.c @ 31359:adb96415b5b7 v9.0.1013

patch 9.0.1013: suspend test often fails on Mac OS Commit: https://github.com/vim/vim/commit/0a2f891adfc52d8f29733817fca15a1b642af1df Author: Bram Moolenaar <Bram@vim.org> Date: Mon Dec 5 21:21:46 2022 +0000 patch 9.0.1013: suspend test often fails on Mac OS Problem: Suspend test often fails on Mac OS. Solution: Make t_RP empty.
author Bram Moolenaar <Bram@vim.org>
date Mon, 05 Dec 2022 22:30:04 +0100
parents 038eb6d9003a
children 50555279168b
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;
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
33 u_int nb_dlevel = 0; // nb_debug verbosity level
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
25475
038eb6d9003a patch 8.2.3274: macro for printf format check can be simplified
Bram Moolenaar <Bram@vim.org>
parents: 18808
diff changeset
35 void nbdb(char *, ...) ATTRIBUTE_FORMAT_PRINTF(1, 2);
7
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 */
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
49 void
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
50 nbdebug_wait(
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
51 u_int wait_flags, // tells what to do
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
52 char *wait_var, // wait environment variable
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
53 u_int wait_secs) // how many seconds to wait
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
56 init_homedir(); // not inited yet
7
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
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
61 // for debugging purposes only
7
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 }
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
72 }
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
74 void
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 nbdebug_log_init(
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
76 char *log_var, // env var with log file
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
77 char *level_var) // env var with nb_debug level
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 {
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
79 char *file; // possible nb_debug output file
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
80 char *cp; // nb_dlevel pointer
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81
16621
7ad3fc329e08 patch 8.1.1313: warnings for using localtime() and ctime()
Bram Moolenaar <Bram@vim.org>
parents: 15868
diff changeset
82 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
83 {
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 time_t now;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 nb_debug = fopen(file, "a");
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 time(&now);
16621
7ad3fc329e08 patch 8.1.1313: warnings for using localtime() and ctime()
Bram Moolenaar <Bram@vim.org>
parents: 15868
diff changeset
88 fprintf(nb_debug, "%s", get_ctime(now, TRUE));
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 if (level_var && (cp = getenv(level_var)) != NULL) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 nb_dlevel = strtoul(cp, NULL, 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 } else {
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
92 nb_dlevel = NB_TRACE; // default level
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 }
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
94 #ifdef USE_NB_ERRORHANDLER
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
95 XSetErrorHandler(errorHandler);
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
96 #endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
99 }
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
101 void
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
102 nbdbg(char *fmt, ...)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 va_list ap;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 7
diff changeset
106 if (nb_debug != NULL && nb_dlevel & NB_TRACE) {
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 va_start(ap, fmt);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 vfprintf(nb_debug, fmt, ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 va_end(ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 fflush(nb_debug);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
113 }
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
115 static int
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
116 lookup(char *file)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 char buf[BUFSIZ];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 expand_env((char_u *) file, (char_u *) buf, BUFSIZ);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 return
15868
7fad90423bd2 patch 8.1.0941: macros for MS-Windows are inconsistent
Bram Moolenaar <Bram@vim.org>
parents: 15510
diff changeset
122 #ifndef FEAT_GUI_MSWIN
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 (access(buf, F_OK) == 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124 #else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 (access(buf, 0) == 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
128 }
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
130 #ifdef USE_NB_ERRORHANDLER
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
131 static int
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 errorHandler(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 Display *dpy,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 XErrorEvent *err)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 char msg[256];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 char buf[256];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 XGetErrorText(dpy, err->error_code, msg, sizeof(msg));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 nbdbg("\n\nNBDEBUG Vim: X Error of failed request: %s\n", msg);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 sprintf(buf, "%d", err->request_code);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 XGetErrorDatabaseText(dpy,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 "XRequest", buf, "Unknown", msg, sizeof(msg));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 nbdbg("\tMajor opcode of failed request: %d (%s)\n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 err->request_code, msg);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 if (err->request_code > 128) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 nbdbg("\tMinor opcode of failed request: %d\n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 err->minor_code);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 return 0;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156
18808
7982f65d8f54 patch 8.1.2392: using old C style comments
Bram Moolenaar <Bram@vim.org>
parents: 16621
diff changeset
157 #endif // NBDEBUG