annotate src/wsdebug.c @ 3002:7d4e5e31d8c1 v7.3.273

updated for version 7.3.273 Problem: A BOM in an error file is seen as text. (Aleksey Baibarin) Solution: Remove the BOM from the text before evaluating. (idea by Christian Brabandt)
author Bram Moolenaar <bram@vim.org>
date Wed, 10 Aug 2011 13:21:46 +0200
parents 82b5078be2dd
children 4aead6a9b7a9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 /* vi:set ts=8 sts=8 sw=8:
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 * WorkShop 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 wsdebug_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 * workshop 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 workshop is by attaching a debugger to it. Without this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 * tool all starup code will have completed before you can get the pid and
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 protocol log tool. The workshop editor server and gvim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 * pass information back and forth during a workshop session. Sometimes it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 * very important to peruse this conversation in order to understand what is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 * happening. The wsdebug_log_init() call sets up this protocol log tool and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 * wsdebug() and wstrace() calls output the information to the log.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 * This code must have WSDEBUG defined for it to be compiled into vim/gvim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 #ifdef WSDEBUG
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 #include "vim.h"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 FILE *ws_debug = NULL;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 u_int ws_dlevel = 0; /* ws_debug verbosity level */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 void wsdebug(char *, ...);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 void wstrace(char *, ...);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 static int lookup(char *);
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
43 #ifdef USE_WS_ERRORHANDLER
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 static int errorHandler(Display *, XErrorEvent *);
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
45 #endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 /*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 * wsdebug_wait - This function can be used to delay or stop execution of vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 * Its normally used to delay startup while attaching a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 * debugger to a running process. Since workshop starts gvim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 * from a background process this is the only way to debug
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 * startup problems.
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 void wsdebug_wait(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 u_int wait_flags, /* tells what to do */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 char *wait_var, /* wait environment variable */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 u_int wait_secs) /* how many seconds to wait */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 init_homedir(); /* not inited yet */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 #ifdef USE_WDDUMP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 WDDump(0, 0, 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 #endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 /* for debugging purposes only */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 if (wait_flags & WT_ENV && wait_var && getenv(wait_var) != NULL) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 sleep(atoi(getenv(wait_var)));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 } else if (wait_flags & WT_WAIT && lookup("~/.gvimwait")) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 sleep(wait_secs > 0 && wait_secs < 120 ? wait_secs : 20);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 } else if (wait_flags & WT_STOP && lookup("~/.gvimstop")) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 int w = 1;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 while (w) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 ;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 } /* end wsdebug_wait */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 void
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 wsdebug_log_init(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 char *log_var, /* env var with log file */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 char *level_var) /* env var with ws_debug level */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 char *file; /* possible ws_debug output file */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 char *cp; /* ws_dlevel pointer */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88
273
2463194c8cdd updated for version 7.0073
vimboss
parents: 7
diff changeset
89 if (log_var && (file = getenv(log_var)) != NULL)
2463194c8cdd updated for version 7.0073
vimboss
parents: 7
diff changeset
90 {
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 char buf[BUFSIZ];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92
273
2463194c8cdd updated for version 7.0073
vimboss
parents: 7
diff changeset
93 vim_snprintf(buf, sizeof(buf), "date > %s", file);
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 system(buf);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 ws_debug = fopen(file, "a");
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 if (level_var && (cp = getenv(level_var)) != NULL) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 ws_dlevel = strtoul(cp, NULL, 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 } else {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 ws_dlevel = WS_TRACE; /* default level */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 }
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
101 #ifdef USE_WS_ERRORHANDLER
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
102 XSetErrorHandler(errorHandler);
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
103 #endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 } /* end wsdebug_log_init */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 void
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 wstrace(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 char *fmt,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 ...)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 va_list ap;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 if (ws_debug!= NULL && (ws_dlevel & (WS_TRACE | WS_TRACE_VERBOSE))) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 va_start(ap, fmt);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 vfprintf(ws_debug, fmt, ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 va_end(ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 fflush(ws_debug);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 } /* end wstrace */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 void
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 wsdebug(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 char *fmt,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 ...)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 va_list ap;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 if (ws_debug != NULL) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 va_start(ap, fmt);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 vfprintf(ws_debug, fmt, ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 va_end(ap);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 fflush(ws_debug);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 } /* end wsdebug */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 static int
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 lookup(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 char *file)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 char buf[BUFSIZ];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 expand_env((char_u *) file, (char_u *) buf, BUFSIZ);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 return (access(buf, F_OK) == 0);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 } /* end lookup */
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
156 #ifdef USE_WS_ERRORHANDLER
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 static int
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 errorHandler(
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 Display *dpy,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 XErrorEvent *err)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161 {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162 char msg[256];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 char buf[256];
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 XGetErrorText(dpy, err->error_code, msg, sizeof(msg));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
166 wsdebug("\n\nWSDEBUG Vim: X Error of failed request: %s\n", msg);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
167
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
168 sprintf(buf, "%d", err->request_code);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 XGetErrorDatabaseText(dpy,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 "XRequest", buf, "Unknown", msg, sizeof(msg));
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171 wsdebug("\tMajor opcode of failed request: %d (%s)\n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 err->request_code, msg);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 if (err->request_code > 128) {
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 wsdebug("\tMinor opcode of failed request: %d\n",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 err->minor_code);
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 }
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 return 0;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 }
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 456
diff changeset
180 #endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184 #endif /* WSDEBUG */