ncurses 5.7 - patch 20090228
[ncurses.git] / ncurses / trace / lib_trace.c
index 3e29f326f8f1083b43f5769d1a6acd43fc1a986c..0c733cd8307cd076e4e4032509e60559e1b40db8 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2008,2009 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            *
@@ -30,6 +30,7 @@
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  *     and: Thomas E. Dickey                        1996-on                 *
+ *     and: Juergen Pfeifer                                                 *
  ****************************************************************************/
 
 /*
 
 #include <ctype.h>
 
-MODULE_ID("$Id: lib_trace.c,v 1.61 2007/04/21 23:06:07 tom Exp $")
+MODULE_ID("$Id: lib_trace.c,v 1.72 2009/02/28 20:37:37 tom Exp $")
 
 NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
 
 #ifdef TRACE
+
+#if USE_REENTRANT
+NCURSES_EXPORT(const char *)
+NCURSES_PUBLIC_VAR(_nc_tputs_trace) (void)
+{
+    return CURRENT_SCREEN ? CURRENT_SCREEN->_tputs_trace : _nc_prescreen._tputs_trace;
+}
+NCURSES_EXPORT(long)
+NCURSES_PUBLIC_VAR(_nc_outchars) (void)
+{
+    return CURRENT_SCREEN ? CURRENT_SCREEN->_outchars : _nc_prescreen._outchars;
+}
+NCURSES_EXPORT(void)
+_nc_set_tputs_trace(const char *s)
+{
+    if (CURRENT_SCREEN)
+       CURRENT_SCREEN->_tputs_trace = s;
+    else
+       _nc_prescreen._tputs_trace = s;
+}
+NCURSES_EXPORT(void)
+_nc_count_outchars(long increment)
+{
+    if (CURRENT_SCREEN)
+       CURRENT_SCREEN->_outchars += increment;
+    else
+       _nc_prescreen._outchars += increment;
+}
+#else
 NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace = "";
 NCURSES_EXPORT_VAR(long) _nc_outchars = 0;
+#endif
 
 #define TraceFP                _nc_globals.trace_fp
 #define TracePath      _nc_globals.trace_fname
@@ -65,11 +96,17 @@ trace(const unsigned int tracelevel)
        const char *mode = _nc_globals.init_trace ? "ab" : "wb";
 
        if (TracePath[0] == '\0') {
-           if (getcwd(TracePath, sizeof(TracePath) - 10) == 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");
+           }
        }
 
        _nc_globals.init_trace = TRUE;
@@ -104,12 +141,12 @@ trace(const unsigned int tracelevel)
     }
 }
 
-NCURSES_EXPORT(void)
-_tracef(const char *fmt,...)
+static void
+_nc_va_tracef(const char *fmt, va_list ap)
 {
     static const char Called[] = T_CALLED("");
     static const char Return[] = T_RETURN("");
-    va_list ap;
+
     bool before = FALSE;
     bool after = FALSE;
     unsigned doit = _nc_tracing;
@@ -134,23 +171,47 @@ _tracef(const char *fmt,...)
     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);
        }
-       va_start(ap, fmt);
        vfprintf(TraceFP, fmt, ap);
        fputc('\n', TraceFP);
-       va_end(ap);
        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);
+}
+
 /* Trace 'bool' return-values */
 NCURSES_EXPORT(NCURSES_BOOL)
 _nc_retrace_bool(NCURSES_BOOL code)
@@ -222,4 +283,53 @@ _nc_retrace_win(WINDOW *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 */