ncurses 5.7 - patch 20090117
[ncurses.git] / ncurses / trace / lib_trace.c
index aa4b887111a7cd7ac2c3b94d4acb270c19e55a51..743b1f64f1aeaf39476190b7a89f1e08bb7fc4cd 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
  ****************************************************************************/
 
 /*
  *     lib_trace.c - Tracing/Debugging routines
+ *
+ * The _tracef() function is originally from pcurses (by Pavel Curtis) in 1982. 
+ * pcurses allowed one to enable/disable tracing using traceon() and traceoff()
+ * functions.  ncurses provides a trace() function which allows one to
+ * selectively enable or disable several tracing features.
  */
 
 #include <curses.priv.h>
 #include <tic.h>
 
-MODULE_ID("$Id: lib_trace.c,v 1.30 1998/10/03 23:41:42 tom Exp $")
-
 #include <ctype.h>
-#if HAVE_FCNTL_H
-#include <fcntl.h>
-#endif
 
-unsigned _nc_tracing = 0;      /* always define this */
+MODULE_ID("$Id: lib_trace.c,v 1.71 2008/08/23 18:04:29 tom Exp $")
+
+NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
 
 #ifdef TRACE
-const char *_nc_tputs_trace = "";
-long _nc_outchars;
 
-static FILE *  tracefp;        /* default to writing to stderr */
+#if USE_REENTRANT
+NCURSES_EXPORT(const char *)
+NCURSES_PUBLIC_VAR(_nc_tputs_trace) (void)
+{
+    return SP ? SP->_tputs_trace : _nc_prescreen._tputs_trace;
+}
+NCURSES_EXPORT(long)
+NCURSES_PUBLIC_VAR(_nc_outchars) (void)
+{
+    return SP ? SP->_outchars : _nc_prescreen._outchars;
+}
+NCURSES_EXPORT(void)
+_nc_set_tputs_trace(const char *s)
+{
+    if (SP)
+       SP->_tputs_trace = s;
+    else
+       _nc_prescreen._tputs_trace = s;
+}
+NCURSES_EXPORT(void)
+_nc_count_outchars(long increment)
+{
+    if (SP)
+       SP->_outchars += increment;
+    else
+       _nc_prescreen._outchars += increment;
+}
+#else
+NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace = "";
+NCURSES_EXPORT_VAR(long) _nc_outchars = 0;
 #endif
 
-void trace(const unsigned int tracelevel GCC_UNUSED)
+#define TraceFP                _nc_globals.trace_fp
+#define TracePath      _nc_globals.trace_fname
+#define TraceLevel     _nc_globals.trace_level
+
+NCURSES_EXPORT(void)
+trace(const unsigned int tracelevel)
 {
-#ifdef TRACE
-static bool    been_here = FALSE;
-static char    my_name[] = "trace";
-
-       _nc_tracing = tracelevel;
-       if (! been_here && tracelevel) {
-               been_here = TRUE;
-
-               if (_nc_access(my_name, W_OK) < 0
-                || (tracefp = fopen(my_name, "w")) == 0) {
-                       perror("curses: Can't open 'trace' file: ");
-                       exit(EXIT_FAILURE);
-               }
-               /* Try to set line-buffered mode, or (failing that) unbuffered,
-                * so that the trace-output gets flushed automatically at the
-                * end of each line.  This is useful in case the program dies. 
-                */
-#if HAVE_SETVBUF       /* ANSI */
-               (void) setvbuf(tracefp, (char *)0, _IOLBF, 0);
-#elif HAVE_SETBUF      /* POSIX */
-               (void) setbuffer(tracefp, (char *)0);
-#endif
-               _tracef("TRACING NCURSES version %s (%d)",
-                       NCURSES_VERSION, NCURSES_VERSION_PATCH);
+    if ((TraceFP == 0) && tracelevel) {
+       const char *mode = _nc_globals.init_trace ? "ab" : "wb";
+
+       if (TracePath[0] == '\0') {
+           int size = sizeof(TracePath) - 12;
+           if (getcwd(TracePath, size) == 0) {
+               perror("curses: Can't get working directory");
+               exit(EXIT_FAILURE);
+           }
+           TracePath[size] = '\0';
+           assert(strlen(TracePath) <= size);
+           strcat(TracePath, "/trace");
+           if (_nc_is_dir_path(TracePath)) {
+               strcat(TracePath, ".log");
+           }
        }
-#endif
-}
 
-const char *_nc_visbuf2(int bufnum, const char *buf)
-/* visibilize a given string */
-{
-char *vbuf;
-char *tp;
-int c;
-
-       if (buf == 0)
-           return("(null)");
-       if (buf == CANCELLED_STRING)
-           return("(cancelled)");
-
-       tp = vbuf = _nc_trace_buf(bufnum, (strlen(buf) * 4) + 5);
-       *tp++ = '"';
-       while ((c = *buf++) != '\0') {
-               if (c == '"') {
-                       *tp++ = '\\'; *tp++ = '"';
-               } else if (is7bits(c) && (isgraph(c) || c == ' ')) {
-                       *tp++ = c;
-               } else if (c == '\n') {
-                       *tp++ = '\\'; *tp++ = 'n';
-               } else if (c == '\r') {
-                       *tp++ = '\\'; *tp++ = 'r';
-               } else if (c == '\b') {
-                       *tp++ = '\\'; *tp++ = 'b';
-               } else if (c == '\033') {
-                       *tp++ = '\\'; *tp++ = 'e';
-               } else if (is7bits(c) && iscntrl(c)) {
-                       *tp++ = '\\'; *tp++ = '^'; *tp++ = '@' + c;
-               } else {
-                       sprintf(tp, "\\%03o", c & 0xff);
-                       tp += strlen(tp);
-               }
+       _nc_globals.init_trace = TRUE;
+       _nc_tracing = tracelevel;
+       if (_nc_access(TracePath, W_OK) < 0
+           || (TraceFP = fopen(TracePath, mode)) == 0) {
+           perror("curses: Can't open 'trace' file");
+           exit(EXIT_FAILURE);
+       }
+       /* Try to set line-buffered mode, or (failing that) unbuffered,
+        * so that the trace-output gets flushed automatically at the
+        * end of each line.  This is useful in case the program dies. 
+        */
+#if HAVE_SETVBUF               /* ANSI */
+       (void) setvbuf(TraceFP, (char *) 0, _IOLBF, 0);
+#elif HAVE_SETBUF              /* POSIX */
+       (void) setbuffer(TraceFP, (char *) 0);
+#endif
+       _tracef("TRACING NCURSES version %s.%d (tracelevel=%#x)",
+               NCURSES_VERSION,
+               NCURSES_VERSION_PATCH,
+               tracelevel);
+    } else if (tracelevel == 0) {
+       if (TraceFP != 0) {
+           fclose(TraceFP);
+           TraceFP = 0;
        }
-       *tp++ = '"';
-       *tp++ = '\0';
-       return(vbuf);
+       _nc_tracing = tracelevel;
+    } else if (_nc_tracing != tracelevel) {
+       _nc_tracing = tracelevel;
+       _tracef("tracelevel=%#x", tracelevel);
+    }
 }
 
-const char *_nc_visbuf(const char *buf)
+static void
+_nc_va_tracef(const char *fmt, va_list ap)
 {
-       return _nc_visbuf2(0, buf);
-}
+    static const char Called[] = T_CALLED("");
+    static const char Return[] = T_RETURN("");
 
-#ifdef TRACE
-void
-_tracef(const char *fmt, ...)
-{
-static const char Called[] = T_CALLED("");
-static const char Return[] = T_RETURN("");
-static int level;
-va_list ap;
-bool   before = FALSE;
-bool   after = FALSE;
-int    doit = _nc_tracing;
-int    save_err = errno;
-
-       if (strlen(fmt) >= sizeof(Called) - 1) {
-               if (!strncmp(fmt, Called, sizeof(Called)-1)) {
-                       before = TRUE;
-                       level++;
-               } else if (!strncmp(fmt, Return, sizeof(Return)-1)) {
-                       after = TRUE;
-               }
-               if (before || after) {
-                       if ((level <= 1)
-                        || (doit & TRACE_ICALLS) != 0)
-                               doit &= (TRACE_CALLS|TRACE_CCALLS);
-                       else
-                               doit = 0;
-               }
+    bool before = FALSE;
+    bool after = FALSE;
+    unsigned doit = _nc_tracing;
+    int save_err = errno;
+
+    if (strlen(fmt) >= sizeof(Called) - 1) {
+       if (!strncmp(fmt, Called, sizeof(Called) - 1)) {
+           before = TRUE;
+           TraceLevel++;
+       } else if (!strncmp(fmt, Return, sizeof(Return) - 1)) {
+           after = TRUE;
        }
+       if (before || after) {
+           if ((TraceLevel <= 1)
+               || (doit & TRACE_ICALLS) != 0)
+               doit &= (TRACE_CALLS | TRACE_CCALLS);
+           else
+               doit = 0;
+       }
+    }
 
-       if (doit != 0) {
-               if (tracefp == 0)
-                       tracefp = stderr;
-               if (before || after) {
-                       int n;
-                       for (n = 1; n < level; n++)
-                               fputs("+ ", tracefp);
-               }
-               va_start(ap, fmt);
-               vfprintf(tracefp, fmt, ap);
-               fputc('\n', tracefp);
-               va_end(ap);
-               fflush(tracefp);
+    if (doit != 0) {
+       if (TraceFP == 0)
+           TraceFP = stderr;
+#ifdef USE_PTHREADS
+       /*
+        * TRACE_ICALLS is "really" needed to show normal use with threaded
+        * applications, since anything can be running during a napms(),
+        * making it appear in the hierarchical trace as it other functions
+        * are being called.
+        *
+        * Rather than add the complication of a per-thread stack, just
+        * show the thread-id in each line of the trace.
+        */
+# if USE_WEAK_SYMBOLS
+       if ((pthread_self))
+# endif
+           fprintf(TraceFP, "%#lx:", (long) (void *) pthread_self());
+#endif
+       if (before || after) {
+           int n;
+           for (n = 1; n < TraceLevel; n++)
+               fputs("+ ", TraceFP);
        }
+       vfprintf(TraceFP, fmt, ap);
+       fputc('\n', TraceFP);
+       fflush(TraceFP);
+    }
+
+    if (after && TraceLevel)
+       TraceLevel--;
+
+    errno = save_err;
+}
+
+NCURSES_EXPORT(void)
+_tracef(const char *fmt,...)
+{
+    va_list ap;
+
+    va_start(ap, fmt);
+    _nc_va_tracef(fmt, ap);
+    va_end(ap);
+}
 
-       if (after && level)
-               level--;
-       errno = save_err;
+/* Trace 'bool' return-values */
+NCURSES_EXPORT(NCURSES_BOOL)
+_nc_retrace_bool(NCURSES_BOOL code)
+{
+    T((T_RETURN("%s"), code ? "TRUE" : "FALSE"));
+    return code;
 }
 
 /* Trace 'int' return-values */
-int _nc_retrace_int(int code)
+NCURSES_EXPORT(int)
+_nc_retrace_int(int code)
+{
+    T((T_RETURN("%d"), code));
+    return code;
+}
+
+/* Trace 'unsigned' return-values */
+NCURSES_EXPORT(unsigned)
+_nc_retrace_unsigned(unsigned code)
 {
-       T((T_RETURN("%d"), code));
-       return code;
+    T((T_RETURN("%#x"), code));
+    return code;
 }
 
 /* Trace 'char*' return-values */
-char * _nc_retrace_ptr(char * code)
+NCURSES_EXPORT(char *)
+_nc_retrace_ptr(char *code)
+{
+    T((T_RETURN("%s"), _nc_visbuf(code)));
+    return code;
+}
+
+/* Trace 'const char*' return-values */
+NCURSES_EXPORT(const char *)
+_nc_retrace_cptr(const char *code)
+{
+    T((T_RETURN("%s"), _nc_visbuf(code)));
+    return code;
+}
+
+/* Trace 'NCURSES_CONST void*' return-values */
+NCURSES_EXPORT(NCURSES_CONST void *)
+_nc_retrace_cvoid_ptr(NCURSES_CONST void *code)
+{
+    T((T_RETURN("%p"), code));
+    return code;
+}
+
+/* Trace 'void*' return-values */
+NCURSES_EXPORT(void *)
+_nc_retrace_void_ptr(void *code)
+{
+    T((T_RETURN("%p"), code));
+    return code;
+}
+
+/* Trace 'SCREEN *' return-values */
+NCURSES_EXPORT(SCREEN *)
+_nc_retrace_sp(SCREEN *code)
 {
-       T((T_RETURN("%s"), _nc_visbuf(code)));
-       return code;
+    T((T_RETURN("%p"), code));
+    return code;
 }
 
 /* Trace 'WINDOW *' return-values */
-WINDOW *_nc_retrace_win(WINDOW *code)
+NCURSES_EXPORT(WINDOW *)
+_nc_retrace_win(WINDOW *code)
 {
-       T((T_RETURN("%p"), code));
-       return code;
+    T((T_RETURN("%p"), code));
+    return code;
 }
+
+#if USE_REENTRANT
+/*
+ * Check if the given trace-mask is enabled.
+ *
+ * This function may be called from within one of the functions that fills
+ * in parameters for _tracef(), but in that case we do not want to lock the
+ * mutex, since it is already locked.
+ */
+NCURSES_EXPORT(int)
+_nc_use_tracef(unsigned mask)
+{
+    bool result = FALSE;
+
+    _nc_lock_global(tst_tracef);
+    if (!_nc_globals.nested_tracef++) {
+       if ((result = (_nc_tracing & (mask))) != 0
+           && _nc_try_global(tracef) == 0) {
+           /* we will call _nc_locked_tracef(), no nesting so far */
+       } else {
+           /* we will not call _nc_locked_tracef() */
+           _nc_globals.nested_tracef = 0;
+       }
+    } else {
+       /* we may call _nc_locked_tracef(), but with nested_tracef > 0 */
+       result = (_nc_tracing & (mask));
+    }
+    _nc_unlock_global(tst_tracef);
+    return result;
+}
+
+/*
+ * We call this if _nc_use_tracef() returns true, which means we must unlock
+ * the tracef mutex.
+ */
+NCURSES_EXPORT(void)
+_nc_locked_tracef(const char *fmt,...)
+{
+    va_list ap;
+
+    va_start(ap, fmt);
+    _nc_va_tracef(fmt, ap);
+    va_end(ap);
+
+    if (--(_nc_globals.nested_tracef) == 0)
+       _nc_unlock_global(tracef);
+}
+#endif /* USE_REENTRANT */
+
 #endif /* TRACE */