Use fmt as backend for Printf/Fprintf (#3074)

* Move Fprintf and Printf in utils/logger.hpp
* Make sections.c a c++ file
* Remove nrnpy_pr for only Printf (same function)
* Use fmt::ptr everywhere this is needed

src/ivoc/ivocmain.cpp

@@ -42,7 +42,7 @@ void iv_display_scale(float);
 #include <IV-X11/ivx11_dynam.h>
 #endif
 
-#include <fmt/format.h>
+#include "utils/logger.hpp"
 
 #if 1
 void pr_profile();

src/ivoc/ivocvect.cpp

@@ -36,6 +36,8 @@
 
 #include "gui-redirect.h"
 
+#include "utils/logger.hpp"
+
 #ifndef PI
 #ifndef M_PI
 #define M_PI 3.14159265358979323846

src/ivoc/matrix.cpp

@@ -8,6 +8,8 @@
 #include "parse.hpp"
 #include "ivocvect.h"
 
+#include "utils/logger.hpp"
+
 #define EPS hoc_epsilon
 Symbol* nrn_matrix_sym;  // also used in oc/hoc_oop.cpp
 

src/ivoc/strfun.cpp

@@ -15,7 +15,7 @@
 #include <ocbox.h>
 #endif
 
-#include <fmt/format.h>
+#include "utils/logger.hpp"
 
 extern Objectdata* hoc_top_level_data;
 extern Symlist* hoc_built_in_symlist;

src/neuron/container/soa_identifier.hpp

@@ -11,7 +11,7 @@
 #include <ostream>
 #include <vector>
 
-#include <fmt/format.h>
+#include "utils/logger.hpp"
 
 #include "hocdec.h"
 

src/nrncvode/cvodeobj.cpp

@@ -1066,7 +1066,7 @@ int Cvode::cvode_init(double) {
         // printf("CVodeReInit\n");
         if (err != SUCCESS) {
             Printf("Cvode %p %s CVReInit error %d\n",
-                   this,
+                   fmt::ptr(this),
                    secname(ctd_[0].v_node_[ctd_[0].rootnodecount_]->sec),
                    err);
             return err;
@@ -1082,7 +1082,7 @@ int Cvode::cvode_init(double) {
         CVodeMalloc(mem_, pf_, t0_, y_, CV_SV, &ncv_->rtol_, atolnvec_);
         if (err != SUCCESS) {
             Printf("Cvode %p %s CVodeMalloc error %d\n",
-                   this,
+                   fmt::ptr(this),
                    secname(ctd_[0].v_node_[ctd_[0].rootnodecount_]->sec),
                    err);
             return err;
@@ -1302,7 +1302,7 @@ int Cvode::cvode_advance_tn(neuron::model_sorted_token const& sorted_token) {
 #if PRINT_EVENT
     if (net_cvode_instance->print_event_ > 1) {
         Printf("Cvode::cvode_advance_tn %p %d initialize_=%d tstop=%.20g t_=%.20g to ",
-               this,
+               fmt::ptr(this),
                nth_ ? nth_->id : 0,
                initialize_,
                tstop_,
@@ -1322,7 +1322,7 @@ int Cvode::cvode_advance_tn(neuron::model_sorted_token const& sorted_token) {
 #endif
     if (err < 0) {
         Printf("CVode %p %s advance_tn failed, err=%d.\n",
-               this,
+               fmt::ptr(this),
                secname(ctd_[0].v_node_[ctd_[0].rootnodecount_]->sec),
                err);
         pf_(t_, y_, nullptr, &opaque);
@@ -1344,7 +1344,7 @@ int Cvode::cvode_interpolate(double tout) {
 #if PRINT_EVENT
     if (net_cvode_instance->print_event_ > 1) {
         Printf("Cvode::cvode_interpolate %p %d initialize_%d t=%.20g to ",
-               this,
+               fmt::ptr(this),
                nth_ ? nth_->id : 0,
                initialize_,
                t_);
@@ -1365,7 +1365,7 @@ int Cvode::cvode_interpolate(double tout) {
 #endif
     if (err < 0) {
         Printf("CVode %p %s interpolate failed, err=%d.\n",
-               this,
+               fmt::ptr(this),
                secname(ctd_[0].v_node_[ctd_[0].rootnodecount_]->sec),
                err);
         return err;
@@ -1409,7 +1409,7 @@ N_Vector Cvode::acorvec() {
 void Cvode::statistics() {
 #if 1
     Printf("\nCvode instance %p %s statistics : %d %s states\n",
-           this,
+           fmt::ptr(this),
            secname(ctd_[0].v_node_[ctd_[0].rootnodecount_]->sec),
            neq_,
            (use_daspk_ ? "IDA" : "CVode"));

src/nrncvode/netcvode.cpp

@@ -3493,7 +3493,7 @@ void NetCvode::local_retreat(double t, Cvode* cv) {
         if (print_event_) {
             Printf("microstep local retreat from %g (cvode_%p is at %g) for event onset=%g\n",
                    cv->tqitem_->t_,
-                   cv,
+                   fmt::ptr(cv),
                    cv->t_,
                    t);
         }
@@ -3502,7 +3502,10 @@ void NetCvode::local_retreat(double t, Cvode* cv) {
         tq->move(cv->tqitem_, t);
 #if PRINT_EVENT
         if (print_event_ > 1) {
-            Printf("after target solve time for %p is %g , dt=%g\n", cv, cv->time(), nt_dt);
+            Printf("after target solve time for %p is %g , dt=%g\n",
+                   fmt::ptr(cv),
+                   cv->time(),
+                   nt_dt);
         }
 #endif
     } else {
@@ -3519,7 +3522,7 @@ void NetCvode::retreat(double t, Cvode* cv) {
     if (print_event_) {
         Printf("microstep retreat from %g (cvode_%p is at %g) for event onset=%g\n",
                tq ? cv->tqitem_->t_ : cv->t_,
-               cv,
+               fmt::ptr(cv),
                cv->t_,
                t);
     }
@@ -3530,7 +3533,7 @@ void NetCvode::retreat(double t, Cvode* cv) {
     }
 #if PRINT_EVENT
     if (print_event_ > 1) {
-        Printf("after target solve time for %p is %g , dt=%g\n", cv, cv->time(), dt);
+        Printf("after target solve time for %p is %g , dt=%g\n", fmt::ptr(cv), cv->time(), dt);
     }
 #endif
 }
@@ -5577,7 +5580,7 @@ static int trajec_buffered(NrnThread& nt,
         if (err) {
             Fprintf(stderr,
                     "Pointer %p of PlayRecord type %d ignored because not a Range Variable",
-                    static_cast<double*>(pd),
+                    fmt::ptr(static_cast<double*>(pd)),
                     pr->type());
         }
     }

src/nrncvode/tqueue.cpp

@@ -48,7 +48,12 @@ static void prnt(const TQItem* b, int level) {
     for (i = 0; i < level; ++i) {
         Printf("    ");
     }
-    Printf("%g %c %d Q=%p D=%p\n", b->t_, b->data_ ? 'x' : 'o', b->cnt_, b, b->data_);
+    Printf("%g %c %d Q=%p D=%p\n",
+           b->t_,
+           b->data_ ? 'x' : 'o',
+           b->cnt_,
+           fmt::ptr(b),
+           fmt::ptr(b->data_));
 }
 
 TQueue::TQueue(TQItemPool* tp, int mkmut) {

src/nrniv/multisplit.cpp

@@ -1872,20 +1872,23 @@ void MultiSplitControl::prstruct() {
                        m.tag_);
                 if (m.nnode_) {
                     Printf("    nodeindex=%p  nodeindex_buffer = %p\n",
-                           m.nodeindex_,
-                           nodeindex_buffer_);
+                           fmt::ptr(m.nodeindex_),
+                           fmt::ptr(nodeindex_buffer_));
                 }
             }
             Printf(" ndbsize=%d  i  nodeindex_buffer_=%p  nodeindex_rthost_=%p\n",
                    ndbsize,
-                   nodeindex_buffer_,
-                   nodeindex_rthost_);
+                   fmt::ptr(nodeindex_buffer_),
+                   fmt::ptr(nodeindex_rthost_));
             if (ndbsize) {
                 for (int i = 0; i < ndbsize; ++i) {
                     Printf("  %d %d %d\n", i, nodeindex_buffer_[i], nodeindex_rthost_[i]);
                 }
             }
-            Printf(" tbsize=%d trecvbuf_=%p tsendbuf_=%p\n", tbsize, trecvbuf_, tsendbuf_);
+            Printf(" tbsize=%d trecvbuf_=%p tsendbuf_=%p\n",
+                   tbsize,
+                   fmt::ptr(trecvbuf_),
+                   fmt::ptr(tsendbuf_));
             Printf("\n");
         }
     }

src/nrniv/nrncore_write/callbacks/nrncore_callbacks.cpp

@@ -1018,7 +1018,6 @@ static void set_info(TQItem* tqi,
         Fprintf(stderr,
                 "WARNING: CVode.event(...) for delivery at time step nearest %g discarded. "
                 "CoreNEURON cannot presently handle interpreter events (rank %d, thread %d).\n",
-                nrnmpi_myid,
                 tdeliver,
                 nrnmpi_myid,
                 tid);

src/nrnmpi/memory_usage.cpp

@@ -14,8 +14,7 @@
 
 #include <iostream>
 
-#include "hocdec.h"
-#include <fmt/format.h>
+#include "utils/logger.hpp"
 
 #include "neuron/container/memory_usage.hpp"
 

src/nrnmpi/nrnmpi_dynam.cpp

@@ -17,8 +17,7 @@
 
 #include "nrnmpi.h"
 
-#include "hocdec.h"
-#include <fmt/format.h>
+#include "utils/logger.hpp"
 
 extern char* cxx_char_alloc(size_t);
 extern std::string corenrn_mpi_library;

src/nrnpython/nrnpy_hoc.cpp

@@ -381,7 +381,7 @@ int hocobj_pushargs(PyObject* args, std::vector<char*>& s2free) {
             Py2NRNString str(po, /* disable_release */ true);
             if (str.err()) {
                 // Since Python error has been set, need to clear, or hoc_execerror
-                // printing with nrnpy_pr will generate a
+                // printing with Printf will generate a
                 // Exception ignored on calling ctypes callback function.
                 // So get the message, clear, and make the message
                 // part of the execerror.
@@ -399,7 +399,7 @@ int hocobj_pushargs(PyObject* args, std::vector<char*>& s2free) {
             // the object which can raise an error for nrn.Section, nrn.Segment,
             // etc. if the internal Section is invalid (Section.prop == NULL).
             // That, in consequence, will generate an
-            // Exception ignored on calling ctypes callback function: <function nrnpy_pr
+            // Exception ignored on calling ctypes callback function: <function Printf
             // thus obscuring the actual error, such as
             // nrn.Segment associated with deleted internal Section.
             PyHocObject* pho = (PyHocObject*) po;

src/oc/axis.cpp

@@ -136,6 +136,8 @@ axis.cpp,v
 #include <math.h>
 #include "gui-redirect.h"
 
+#include "utils/logger.hpp"
+
 #define CLIP 1e9
 #define XS   500.
 #define YS   400.

src/oc/code.cpp

@@ -2371,9 +2371,9 @@ int hoc_araypt(Symbol* sp, int type) {
 
 // pop top value from stack, print it
 void hoc_print() {
-    nrnpy_pr("\t");
+    Printf("\t");
     hoc_prexpr();
-    nrnpy_pr("\n");
+    Printf("\n");
 }
 
 // print numeric value

src/oc/code2.cpp

@@ -14,6 +14,8 @@
 #include "nrnfilewrap.h"
 #include <cstring>
 
+#include "utils/logger.hpp"
+
 
 int units_on_flag_;
 

src/oc/debug.cpp

@@ -5,9 +5,11 @@
 #include "equation.h"
 #include <stdio.h>
 
+#include "utils/logger.hpp"
+
 int hoc_zzdebug;
 
-#define prcod(c1, c2) else if (p->pf == c1) Printf("%p %p %s", p, p->pf, c2)
+#define prcod(c1, c2) else if (p->pf == c1) Printf("%p %p %s", fmt::ptr(p), fmt::ptr(p->pf), c2)
 
 void hoc_debug(void) /* print the machine */
 {

src/oc/fileio.cpp

@@ -15,7 +15,6 @@
 #include <errno.h>
 #include "nrnfilewrap.h"
 
-
 extern char* neuron_home;
 
 NrnFILEWrap* hoc_frin;
@@ -751,7 +750,7 @@ void hoc_Chdir(void) {
 }
 
 int nrn_is_python_extension;
-static int (*nrnpy_pr_stdoe_callback)(int, char*);
+int (*nrnpy_pr_stdoe_callback)(int, char*);
 static int (*nrnpy_pass_callback)();
 
 extern "C" void nrnpy_set_pr_etal(int (*cbpr_stdoe)(int, char*), int (*cbpass)()) {
@@ -762,78 +761,9 @@ extern "C" void nrnpy_set_pr_etal(int (*cbpr_stdoe)(int, char*), int (*cbpass)()
 void nrnpy_pass() {
     if (nrnpy_pass_callback) {
         if ((*nrnpy_pass_callback)() != 1) {
-            hoc_execerror("nrnpy_pass", 0);
-        }
-    }
-}
-
-static int vnrnpy_pr_stdoe(FILE* stream, const char* fmt, va_list ap) {
-    int size = 0;
-    char* p = NULL;
-
-    if (!nrnpy_pr_stdoe_callback || (stream != stderr && stream != stdout)) {
-        size = vfprintf(stream, fmt, ap);
-        return size;
-    }
-
-    /* Determine required size */
-    va_list apc;
-#ifndef va_copy
-#if defined(__GNUC__) || defined(__clang__)
-#define va_copy(dest, src) __builtin_va_copy(dest, src)
-#else
-#define va_copy(dest, src) (dest = src)
-#endif
-#endif
-    va_copy(apc, ap);
-    size = vsnprintf(p, size, fmt, apc);
-    va_end(apc);
-
-    if (size < 0)
-        return 0;
-
-    size++; /* For '\0' */
-    p = static_cast<char*>(malloc(size));
-    if (p == NULL)
-        return 0;
-
-    size = vsnprintf(p, size, fmt, ap);
-    if (size < 0) {
-        free(p);
-        return 0;
-    }
-
-    // if any non-ascii translate to '?' or nrnpy_pr will raise an exception.
-    if (stream == stderr) {
-        for (int i = 0; p[i] != '\0'; ++i) {
-            if (!isascii((unsigned char) p[i])) {
-                p[i] = '?';
-            }
+            hoc_execerror("nrnpy_pass", nullptr);
         }
     }
-
-    (*nrnpy_pr_stdoe_callback)((stream == stderr) ? 2 : 1, p);
-
-    free(p);
-    return size;
-}
-
-int nrnpy_pr(const char* fmt, ...) {
-    int n;
-    va_list ap;
-    va_start(ap, fmt);
-    n = vnrnpy_pr_stdoe(stdout, fmt, ap);
-    va_end(ap);
-    return n;
-}
-
-int Fprintf(FILE* stream, const char* fmt, ...) {
-    int n;
-    va_list ap;
-    va_start(ap, fmt);
-    n = vnrnpy_pr_stdoe(stream, fmt, ap);
-    va_end(ap);
-    return n;
 }
 
 /** printf style specification of hoc_execerror message. (512 char limit) **/

src/oc/hoc.cpp

@@ -32,7 +32,7 @@
 #include <thread>
 #include <utility>
 
-#include <fmt/format.h>
+#include "utils/logger.hpp"
 
 /* for eliminating "ignoreing return value" warnings. */
 int nrnignore;