ncurses 6.2 - patch 20200404
[ncurses.git] / ncurses / trace / lib_trace.c
index 202dc382b0b48b9b8ed86f2e6d3f8c2e47df37ac..2c10b51d0170ab142e99807ea64c19638c8eb904 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 1998-2007,2008 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            *
@@ -30,6 +31,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                                                 *
  ****************************************************************************/
 
 /*
@@ -46,7 +48,7 @@
 
 #include <ctype.h>
 
-MODULE_ID("$Id: lib_trace.c,v 1.70 2008/08/16 23:13:52 tom Exp $")
+MODULE_ID("$Id: lib_trace.c,v 1.95 2020/02/02 23:34:34 tom Exp $")
 
 NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
 
@@ -56,26 +58,26 @@ NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
 NCURSES_EXPORT(const char *)
 NCURSES_PUBLIC_VAR(_nc_tputs_trace) (void)
 {
-    return SP ? SP->_tputs_trace : _nc_prescreen._tputs_trace;
+    return CURRENT_SCREEN ? CURRENT_SCREEN->_tputs_trace : _nc_prescreen._tputs_trace;
 }
 NCURSES_EXPORT(long)
 NCURSES_PUBLIC_VAR(_nc_outchars) (void)
 {
-    return SP ? SP->_outchars : _nc_prescreen._outchars;
+    return CURRENT_SCREEN ? CURRENT_SCREEN->_outchars : _nc_prescreen._outchars;
 }
 NCURSES_EXPORT(void)
 _nc_set_tputs_trace(const char *s)
 {
-    if (SP)
-       SP->_tputs_trace = s;
+    if (CURRENT_SCREEN)
+       CURRENT_SCREEN->_tputs_trace = s;
     else
        _nc_prescreen._tputs_trace = s;
 }
 NCURSES_EXPORT(void)
 _nc_count_outchars(long increment)
 {
-    if (SP)
-       SP->_outchars += increment;
+    if (CURRENT_SCREEN)
+       CURRENT_SCREEN->_outchars += increment;
     else
        _nc_prescreen._outchars += increment;
 }
@@ -84,60 +86,83 @@ 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
-#define TraceLevel     _nc_globals.trace_level
+#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 */
 
-NCURSES_EXPORT(void)
-trace(const unsigned int tracelevel)
+NCURSES_EXPORT(unsigned)
+curses_trace(unsigned tracelevel)
 {
-    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);
+    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));
+               }
            }
-           TracePath[size] = '\0';
-           assert(strlen(TracePath) <= size);
-           strcat(TracePath, "/trace");
-           if (_nc_is_dir_path(TracePath)) {
-               strcat(TracePath, ".log");
+           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_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 (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 (tracelevel=%#x)",
                NCURSES_VERSION,
                NCURSES_VERSION_PATCH,
                tracelevel);
     } else if (tracelevel == 0) {
-       if (TraceFP != 0) {
-           fclose(TraceFP);
-           TraceFP = 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);
     }
+#else
+    (void) tracelevel;
+    result = 0;
+#endif
+    return result;
+}
+
+#if defined(TRACE)
+NCURSES_EXPORT(void)
+trace(const unsigned int tracelevel)
+{
+    curses_trace(tracelevel);
 }
 
 static void
@@ -150,16 +175,23 @@ _nc_va_tracef(const char *fmt, va_list ap)
     bool after = FALSE;
     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;
-           TraceLevel++;
+           MyLevel++;
        } else if (!strncmp(fmt, Return, sizeof(Return) - 1)) {
            after = TRUE;
        }
        if (before || after) {
-           if ((TraceLevel <= 1)
+           if ((MyLevel <= 1)
                || (doit & TRACE_ICALLS) != 0)
                doit &= (TRACE_CALLS | TRACE_CCALLS);
            else
@@ -167,9 +199,7 @@ _nc_va_tracef(const char *fmt, va_list ap)
        }
     }
 
-    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
@@ -183,26 +213,30 @@ _nc_va_tracef(const char *fmt, va_list ap)
 # if USE_WEAK_SYMBOLS
        if ((pthread_self))
 # endif
-           fprintf(TraceFP, "%#lx:", (long) pthread_self());
+#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 < TraceLevel; n++)
-               fputs("+ ", TraceFP);
+           for (n = 1; n < MyLevel; n++)
+               fputs("+ ", fp);
        }
-       vfprintf(TraceFP, fmt, ap);
-       fputc('\n', TraceFP);
-       fflush(TraceFP);
+       vfprintf(fp, fmt, ap);
+       fputc('\n', fp);
+       fflush(fp);
     }
 
-    if (after && TraceLevel)
-       TraceLevel--;
+    if (after && MyLevel)
+       MyLevel--;
 
     errno = save_err;
 }
 
 NCURSES_EXPORT(void)
-_tracef(const char *fmt,...)
+_tracef(const char *fmt, ...)
 {
     va_list ap;
 
@@ -213,12 +247,20 @@ _tracef(const char *fmt,...)
 
 /* Trace 'bool' return-values */
 NCURSES_EXPORT(NCURSES_BOOL)
-_nc_retrace_bool(NCURSES_BOOL code)
+_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 */
 NCURSES_EXPORT(int)
 _nc_retrace_int(int code)
@@ -271,7 +313,7 @@ _nc_retrace_void_ptr(void *code)
 NCURSES_EXPORT(SCREEN *)
 _nc_retrace_sp(SCREEN *code)
 {
-    T((T_RETURN("%p"), code));
+    T((T_RETURN("%p"), (void *) code));
     return code;
 }
 
@@ -279,10 +321,43 @@ _nc_retrace_sp(SCREEN *code)
 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.
@@ -297,13 +372,13 @@ _nc_use_tracef(unsigned mask)
     bool result = FALSE;
 
     _nc_lock_global(tst_tracef);
-    if (!_nc_globals.nested_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() */
-           _nc_globals.nested_tracef = 0;
+           MyNested = 0;
        }
     } else {
        /* we may call _nc_locked_tracef(), but with nested_tracef > 0 */
@@ -318,7 +393,7 @@ _nc_use_tracef(unsigned mask)
  * the tracef mutex.
  */
 NCURSES_EXPORT(void)
-_nc_locked_tracef(const char *fmt,...)
+_nc_locked_tracef(const char *fmt, ...)
 {
     va_list ap;
 
@@ -326,8 +401,9 @@ _nc_locked_tracef(const char *fmt,...)
     _nc_va_tracef(fmt, ap);
     va_end(ap);
 
-    if (--(_nc_globals.nested_tracef) == 0)
+    if (--(MyNested) == 0) {
        _nc_unlock_global(tracef);
+    }
 }
 #endif /* USE_REENTRANT */