ncurses 6.2 - patch 20200404
[ncurses.git] / ncurses / trace / lib_trace.c
index 51260aec6b1737394e898ab1323d3e87a8ec8ed2..2c10b51d0170ab142e99807ea64c19638c8eb904 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 1998,1999,2000 Free Software Foundation, Inc.              *
+ * Copyright 2018-2019,2020 Thomas E. Dickey                                *
+ * Copyright 1998-2016,2017 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                 *
+ *     and: Juergen Pfeifer                                                 *
  ****************************************************************************/
 
 /*
  *     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 <ctype.h>
 
-MODULE_ID("$Id: lib_trace.c,v 1.34 2000/04/01 20:25:47 tom Exp $")
+MODULE_ID("$Id: lib_trace.c,v 1.95 2020/02/02 23:34:34 tom Exp $")
 
-unsigned _nc_tracing = 0;      /* always define this */
+NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
 
 #ifdef TRACE
-const char *_nc_tputs_trace = "";
-long _nc_outchars = 0;
 
-static FILE *tracefp;          /* default to writing to stderr */
-
-void
-trace(const unsigned int tracelevel GCC_UNUSED)
+#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)
 {
-    static bool been_here = FALSE;
-    static char my_name[] = "trace";
+    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
 
-    _nc_tracing = tracelevel;
-    if (!been_here && tracelevel) {
-       been_here = TRUE;
+#define MyFP           _nc_globals.trace_fp
+#define MyFD           _nc_globals.trace_fd
+#define MyInit         _nc_globals.trace_opened
+#define MyPath         _nc_globals.trace_fname
+#define MyLevel                _nc_globals.trace_level
+#define MyNested       _nc_globals.nested_tracef
+#endif /* TRACE */
 
-       if (_nc_access(my_name, W_OK) < 0
-           || (tracefp = fopen(my_name, "w")) == 0) {
-           perror("curses: Can't open 'trace' file: ");
-           exit(EXIT_FAILURE);
+NCURSES_EXPORT(unsigned)
+curses_trace(unsigned tracelevel)
+{
+    unsigned result;
+#if defined(TRACE)
+    result = _nc_tracing;
+    if ((MyFP == 0) && tracelevel) {
+       MyInit = TRUE;
+       if (MyFD >= 0) {
+           MyFP = fdopen(MyFD, BIN_W);
+       } else {
+           if (MyPath[0] == '\0') {
+               size_t size = sizeof(MyPath) - 12;
+               if (getcwd(MyPath, size) == 0) {
+                   perror("curses: Can't get working directory");
+                   exit(EXIT_FAILURE);
+               }
+               MyPath[size] = '\0';
+               assert(strlen(MyPath) <= size);
+               _nc_STRCAT(MyPath, "/trace", sizeof(MyPath));
+               if (_nc_is_dir_path(MyPath)) {
+                   _nc_STRCAT(MyPath, ".log", sizeof(MyPath));
+               }
+           }
+           if (_nc_access(MyPath, W_OK) < 0
+               || (MyFD = open(MyPath, O_CREAT | O_EXCL | O_RDWR, 0600)) < 0
+               || (MyFP = fdopen(MyFD, BIN_W)) == 0) {
+               ;               /* EMPTY */
+           }
        }
+       _nc_tracing = tracelevel;
        /* 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 (MyFP != 0) {
 #if HAVE_SETVBUF               /* ANSI */
-       (void) setvbuf(tracefp, (char *) 0, _IOLBF, 0);
-#elif HAVE_SETBUF              /* POSIX */
-       (void) setbuffer(tracefp, (char *) 0);
+           (void) setvbuf(MyFP, (char *) 0, _IOLBF, (size_t) 0);
+#elif HAVE_SETBUF /* POSIX */
+           (void) setbuffer(MyFP, (char *) 0);
 #endif
-       _tracef("TRACING NCURSES version %s (%d)",
-           NCURSES_VERSION, NCURSES_VERSION_PATCH);
+       }
+       _tracef("TRACING NCURSES version %s.%d (tracelevel=%#x)",
+               NCURSES_VERSION,
+               NCURSES_VERSION_PATCH,
+               tracelevel);
+    } else if (tracelevel == 0) {
+       if (MyFP != 0) {
+           MyFD = dup(MyFD);   /* allow reopen of same file */
+           fclose(MyFP);
+           MyFP = 0;
+       }
+       _nc_tracing = tracelevel;
+    } else if (_nc_tracing != tracelevel) {
+       _nc_tracing = tracelevel;
+       _tracef("tracelevel=%#x", tracelevel);
     }
-}
-#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)");
-
-#ifdef TRACE
-    tp = vbuf = _nc_trace_buf(bufnum, (strlen(buf) * 4) + 5);
 #else
-    {
-    static char *mybuf[2];
-    mybuf[bufnum] = _nc_doalloc(mybuf[bufnum], (strlen(buf) * 4) + 5);
-    tp = vbuf = mybuf[bufnum];
-    }
+    (void) tracelevel;
+    result = 0;
 #endif
-    *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);
-       }
-    }
-    *tp++ = '"';
-    *tp++ = '\0';
-    return (vbuf);
+    return result;
 }
 
-const char *
-_nc_visbuf(const char *buf)
+#if defined(TRACE)
+NCURSES_EXPORT(void)
+trace(const unsigned int tracelevel)
 {
-    return _nc_visbuf2(0, buf);
+    curses_trace(tracelevel);
 }
 
-#ifdef TRACE
-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("");
-    static int level;
-    va_list ap;
+
     bool before = FALSE;
     bool after = FALSE;
-    int doit = _nc_tracing;
+    unsigned doit = _nc_tracing;
     int save_err = errno;
+    FILE *fp = MyFP;
+
+#ifdef TRACE
+    /* verbose-trace in the command-line utilities relies on this */
+    if (fp == 0 && !MyInit && _nc_tracing >= DEBUG_LEVEL(1))
+       fp = stderr;
+#endif
 
     if (strlen(fmt) >= sizeof(Called) - 1) {
        if (!strncmp(fmt, Called, sizeof(Called) - 1)) {
            before = TRUE;
-           level++;
+           MyLevel++;
        } else if (!strncmp(fmt, Return, sizeof(Return) - 1)) {
            after = TRUE;
        }
        if (before || after) {
-           if ((level <= 1)
+           if ((MyLevel <= 1)
                || (doit & TRACE_ICALLS) != 0)
                doit &= (TRACE_CALLS | TRACE_CCALLS);
            else
@@ -170,47 +199,212 @@ _tracef(const char *fmt,...)
        }
     }
 
-    if (doit != 0) {
-       if (tracefp == 0)
-           tracefp = stderr;
+    if (doit != 0 && fp != 0) {
+#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
+#ifdef _WIN32
+           fprintf(fp, "%#lx:", (long) (intptr_t) pthread_self().p);
+#else
+           fprintf(fp, "%#lx:", (long) (intptr_t) pthread_self());
+#endif
+#endif
        if (before || after) {
            int n;
-           for (n = 1; n < level; n++)
-               fputs("+ ", tracefp);
+           for (n = 1; n < MyLevel; n++)
+               fputs("+ ", fp);
        }
-       va_start(ap, fmt);
-       vfprintf(tracefp, fmt, ap);
-       fputc('\n', tracefp);
-       va_end(ap);
-       fflush(tracefp);
+       vfprintf(fp, fmt, ap);
+       fputc('\n', fp);
+       fflush(fp);
     }
 
-    if (after && level)
-       level--;
+    if (after && MyLevel)
+       MyLevel--;
+
     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(int code)
+{
+    T((T_RETURN("%s"), code ? "TRUE" : "FALSE"));
+    return code;
+}
+
+/* Trace 'char' return-values */
+NCURSES_EXPORT(char)
+_nc_retrace_char(int code)
+{
+    T((T_RETURN("%c"), code));
+    return (char) code;
+}
+
 /* Trace 'int' return-values */
-int
+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("%#x"), code));
+    return code;
+}
+
 /* Trace 'char*' return-values */
-char *
+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("%p"), (void *) code));
+    return code;
+}
+
 /* Trace 'WINDOW *' return-values */
-WINDOW *
+NCURSES_EXPORT(WINDOW *)
 _nc_retrace_win(WINDOW *code)
 {
-    T((T_RETURN("%p"), code));
+    T((T_RETURN("%p"), (void *) code));
     return code;
 }
+
+NCURSES_EXPORT(char *)
+_nc_fmt_funcptr(char *target, const char *source, size_t size)
+{
+    size_t n;
+    char *dst = target;
+    bool leading = TRUE;
+
+    union {
+       int value;
+       char bytes[sizeof(int)];
+    } byteorder;
+
+    byteorder.value = 0x1234;
+
+    *dst++ = '0';
+    *dst++ = 'x';
+
+    for (n = 0; n < size; ++n) {
+       unsigned ch = ((byteorder.bytes[0] == 0x34)
+                      ? UChar(source[size - n - 1])
+                      : UChar(source[n]));
+       if (ch != 0 || (n + 1) >= size)
+           leading = FALSE;
+       if (!leading) {
+           _nc_SPRINTF(dst, _nc_SLIMIT(TR_FUNC_LEN - (dst - target))
+                       "%02x", ch & 0xff);
+           dst += 2;
+       }
+    }
+    *dst = '\0';
+    return target;
+}
+
+#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 (!MyNested++) {
+       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() */
+           MyNested = 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 (--(MyNested) == 0) {
+       _nc_unlock_global(tracef);
+    }
+}
+#endif /* USE_REENTRANT */
+
 #endif /* TRACE */