src/nbdebug.c

   1 /* vi:set ts=8 sts=8 sw=8:
   2  *
   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
  20  * tool all starup code will have completed before you can get the pid and
  21  * 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
  30 #include "vim.h"
  31
  32 FILE            *nb_debug = NULL;
  33 u_int            nb_dlevel = 0;         /* nb_debug verbosity level */
  34
  35 void             nbdb(char *, ...);
  36 void             nbtrace(char *, ...);
  37
  38 static int       lookup(char *);
  39 #ifdef USE_NB_ERRORHANDLER
  40 static int       errorHandler(Display *, XErrorEvent *);
  41 #endif
  42
  43 /*
  44  * nbdebug_wait -   This function can be used to delay or stop execution of vim.
  45  *                  Its normally used to delay startup while attaching a
  46  *                  debugger to a running process. Since workshop starts gvim
  47  *                  from a background process this is the only way to debug
  48  *                  startup problems.
  49  */
  50
  51 void nbdebug_wait(
  52         u_int            wait_flags,    /* tells what to do */
  53         char            *wait_var,      /* wait environment variable */
  54         u_int            wait_secs)     /* how many seconds to wait */
  55 {
  56
  57         init_homedir();                 /* not inited yet */
  58 #ifdef USE_WDDUMP
  59         WDDump(0, 0, 0);
  60 #endif
  61
  62         /* for debugging purposes only */
  63         if (wait_flags & WT_ENV && wait_var && getenv(wait_var) != NULL) {
  64                 sleep(atoi(getenv(wait_var)));
  65         } else if (wait_flags & WT_WAIT && lookup("~/.gvimwait")) {
  66                 sleep(wait_secs > 0 && wait_secs < 120 ? wait_secs : 20);
  67         } else if (wait_flags & WT_STOP && lookup("~/.gvimstop")) {
  68                 int w = 1;
  69                 while (w) {
  70                         ;
  71                 }
  72         }
  73 }    /* end nbdebug_wait */
  74
  75
  76 void
  77 nbdebug_log_init(
  78         char            *log_var,       /* env var with log file */
  79         char            *level_var)     /* env var with nb_debug level */
  80 {
  81         char            *file;          /* possible nb_debug output file */
  82         char            *cp;            /* nb_dlevel pointer */
  83
  84         if (log_var && (file = getenv(log_var)) != NULL) {
  85                 time_t now;
  86
  87                 nb_debug = fopen(file, "a");
  88                 time(&now);
  89                 fprintf(nb_debug, "%s", asctime(localtime(&now)));
  90                 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                 }
  95 #ifdef USE_NB_ERRORHANDLER
  96                 XSetErrorHandler(errorHandler);
  97 #endif
  98         }
  99
 100 }    /* end nbdebug_log_init */
 101
 102
 103
 104
 105 void
 106 nbtrace(
 107         char            *fmt,
 108         ...)
 109 {
 110         va_list          ap;
 111
 112         if (nb_debug!= NULL && (nb_dlevel & (NB_TRACE | NB_TRACE_VERBOSE))) {
 113                 va_start(ap, fmt);
 114                 vfprintf(nb_debug, fmt, ap);
 115                 va_end(ap);
 116                 fflush(nb_debug);
 117         }
 118
 119 }    /* end nbtrace */
 120
 121
 122 void
 123 nbdbg(
 124         char            *fmt,
 125         ...)
 126 {
 127         va_list          ap;
 128
 129         if (nb_debug != NULL && nb_dlevel & NB_TRACE) {
 130                 va_start(ap, fmt);
 131                 vfprintf(nb_debug, fmt, ap);
 132                 va_end(ap);
 133                 fflush(nb_debug);
 134         }
 135
 136 }    /* end nbdbg */
 137
 138
 139 void
 140 nbprt(
 141         char            *fmt,
 142         ...)
 143 {
 144         va_list          ap;
 145
 146         if (nb_debug != NULL && nb_dlevel & NB_PRINT) {
 147                 va_start(ap, fmt);
 148                 vfprintf(nb_debug, fmt, ap);
 149                 va_end(ap);
 150                 fflush(nb_debug);
 151         }
 152
 153 }    /* end nbprt */
 154
 155
 156 static int
 157 lookup(
 158         char            *file)
 159 {
 160         char             buf[BUFSIZ];
 161
 162         expand_env((char_u *) file, (char_u *) buf, BUFSIZ);
 163         return
 164 #ifndef FEAT_GUI_W32
 165                 (access(buf, F_OK) == 0);
 166 #else
 167                 (access(buf, 0) == 0);
 168 #endif
 169
 170 }    /* end lookup */
 171
 172 #ifdef USE_NB_ERRORHANDLER
 173 static int
 174 errorHandler(
 175         Display         *dpy,
 176         XErrorEvent     *err)
 177 {
 178         char             msg[256];
 179         char             buf[256];
 180
 181         XGetErrorText(dpy, err->error_code, msg, sizeof(msg));
 182         nbdbg("\n\nNBDEBUG Vim: X Error of failed request: %s\n", msg);
 183
 184         sprintf(buf, "%d", err->request_code);
 185         XGetErrorDatabaseText(dpy,
 186             "XRequest", buf, "Unknown", msg, sizeof(msg));
 187         nbdbg("\tMajor opcode of failed request: %d (%s)\n",
 188             err->request_code, msg);
 189         if (err->request_code > 128) {
 190                 nbdbg("\tMinor opcode of failed request: %d\n",
 191                     err->minor_code);
 192         }
 193
 194         return 0;
 195 }
 196 #endif
 197
 198
 199 #endif /* NBDEBUG */