eliminate Sprintf warnings

src/modlunit/model.cpp

@@ -116,7 +116,7 @@ int main(int argc, char* argv[]) {
 static void openfiles(int argc, char* argv[]) {
     char *cp, modprefix[NRN_BUFSIZE - 5];
     if (argc > 1) {
-        assert(strlen(argv[1]) < NRN_BUFSIZE);
+        assert(strlen(argv[1]) < NRN_BUFSIZE - 5);
         Sprintf(modprefix, "%s", argv[1]);
         cp = strstr(modprefix, ".mod");
         if (cp) {

src/modlunit/model.h

@@ -224,6 +224,7 @@ extern Item* qlint;
 #define IGNORE(arg) arg
 #endif
 using neuron::Sprintf;
+using neuron::SprintfAsrt;
 
 /* model.h,v
  * Revision 1.2  1997/11/24  16:19:13  hines

src/nocmodl/io.cpp

@@ -216,15 +216,15 @@
 char* current_line() { /* assumes we actually want the previous line */
     static char buf[NRN_BUFSIZE];
     char* p;
-    Sprintf(buf,
-            "at line %d in file %s:\\n%s",
-            linenum - 1,
+    SprintfAsrt(buf,
+                "at line %d in file %s:\\n%s",
+                linenum - 1,
 #if !defined(NRN_AVOID_ABSOLUTE_PATHS)
-            finname,
+                finname,
 #else
-            fs::absolute(finname).filename().c_str(),
+                fs::absolute(finname).filename().c_str(),
 #endif
-            inlinebuf[whichbuf ? 0 : 1] + 30);
+                inlinebuf[whichbuf ? 0 : 1] + 30);
     for (p = buf; *p; ++p) {
         if (*p == '\n') {
             *p = '\0';
@@ -432,7 +432,7 @@
 }
 
 static void pop_file_stack() {
-    Sprintf(buf, ":::end INCLUDE %s\n", finname);
+    SprintfAsrt(buf, ":::end INCLUDE %s\n", finname);
     lappendstr(filetxtlist, buf);
     FileStackItem* fsi;
     fsi = (FileStackItem*) (SYM(filestack->prev));

src/nocmodl/kinetic.cpp

@@ -987,7 +987,7 @@
         Sprintf(eqstr, "%d(%d", fn, eqnum);
         eqnum++;
     }
-    Sprintf(buf, "_RHS%s) = %s;\n", eqstr, r->krate[0]);
+    SprintfAsrt(buf, "_RHS%s) = %s;\n", eqstr, r->krate[0]);
     Insertstr(q, buf);
     for (rt = r->rterm[0]; rt; rt = rt->rnext) {
         char buf1[NRN_BUFSIZE];
@@ -1004,19 +1004,19 @@
                 Sprintf(buf, "_i = %s;\n", rt->str);
                 Insertstr(q, buf);
             }
-            Sprintf(buf,
-                    "_MATELM%s, %d + %s) = %d%s;\n",
-                    eqstr,
-                    rt->sym->varnum,
-                    rt->str,
-                    rt->num,
-                    buf1);
+            SprintfAsrt(buf,
+                        "_MATELM%s, %d + %s) = %d%s;\n",
+                        eqstr,
+                        rt->sym->varnum,
+                        rt->str,
+                        rt->num,
+                        buf1);
             Insertstr(q, buf);
-            Sprintf(buf, "_RHS%s) -= %s[%s]%s", eqstr, rt->sym->name, rt->str, buf1);
+            SprintfAsrt(buf, "_RHS%s) -= %s[%s]%s", eqstr, rt->sym->name, rt->str, buf1);
         } else {
-            Sprintf(buf, "_MATELM%s, %d) = %d%s;\n", eqstr, rt->sym->varnum, rt->num, buf1);
+            SprintfAsrt(buf, "_MATELM%s, %d) = %d%s;\n", eqstr, rt->sym->varnum, rt->num, buf1);
             Insertstr(q, buf);
-            Sprintf(buf, "_RHS%s) -= %s%s", eqstr, rt->sym->name, buf1);
+            SprintfAsrt(buf, "_RHS%s) -= %s%s", eqstr, rt->sym->name, buf1);
         }
         Insertstr(q, buf);
         if (rt->num != 1) {

src/nocmodl/modl.h

@@ -330,6 +330,7 @@ extern Item* qlint;
 #define Free(arg)   free((void*) (arg))
 #endif
 using neuron::Sprintf;
+using neuron::SprintfAsrt;
 
 void verbatim_adjust(char* q);
 /** @} */  // end of hoc_functions

src/nocmodl/nocpout.cpp

@@ -1775,7 +1775,7 @@ void units_reg() {
         if (s->nrntype & NRNGLOBAL) {
             decode_ustr(s, &d1, &d2, u);
             if (u[0]) {
-                Sprintf(buf, "{\"%s%s\", \"%s\"},\n", s->name, suffix, u);
+                SprintfAsrt(buf, "{\"%s%s\", \"%s\"},\n", s->name, suffix, u);
                 lappendstr(defs_list, buf);
             }
         }
@@ -1784,31 +1784,31 @@ void units_reg() {
         s = SYM(q);
         decode_ustr(s, &d1, &d2, u);
         if (u[0]) {
-            Sprintf(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
+            SprintfAsrt(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
             lappendstr(defs_list, buf);
         }
     }
     ITERATE(q, rangestate) {
         s = SYM(q);
         decode_ustr(s, &d1, &d2, u);
         if (u[0]) {
-            Sprintf(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
+            SprintfAsrt(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
             lappendstr(defs_list, buf);
         }
     }
     ITERATE(q, rangedep) {
         s = SYM(q);
         decode_ustr(s, &d1, &d2, u);
         if (u[0]) {
-            Sprintf(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
+            SprintfAsrt(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
             lappendstr(defs_list, buf);
         }
     }
     ITERATE(q, nrnpointers) {
         s = SYM(q);
         decode_ustr(s, &d1, &d2, u);
         if (u[0]) {
-            Sprintf(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
+            SprintfAsrt(buf, "{\"%s%s\", \"%s\"},\n", s->name, rsuffix, u);
             lappendstr(defs_list, buf);
         }
     }

src/oc/hocdec.h

@@ -272,6 +272,7 @@ int ilint;
 #define Strncpy strncpy
 #endif
 using neuron::Sprintf;
+using neuron::SprintfAsrt;
 
 // No longer used because of clang format difficulty
 // #define IFGUI  if (hoc_usegui) {

src/oc/mk_hocusr_h.py

@@ -25,7 +25,7 @@ def processvar(a, names):
 
 def remove_multiline_comments(string):
     # remove all occurance comments (/*COMMENT */) from string
-    return re.sub(r"/\*.*?\*/", "", string, 0, re.DOTALL)
+    return re.sub(r"/\*.*?\*/", "", string, count=0, flags=re.DOTALL)
 
 
 types = {}

src/oc/wrap_sprintf.h

@@ -1,5 +1,7 @@
 #include <cstdio>
 #include <utility>  // std::forward
+#include <stdexcept>
+#include <assert.h>
 
 namespace neuron {
 /**
@@ -17,4 +19,20 @@ int Sprintf(char (&buf)[N], const char* fmt, Args&&... args) {
         return std::snprintf(buf, N, fmt, std::forward<Args>(args)...);
     }
 }
+
+/**
+ * @brief assert if the Sprintf format data does not fit into buf
+ */
+template <std::size_t N, typename... Args>
+void SprintfAsrt(char (&buf)[N], const char* fmt, Args&&... args) {
+    int sz = Sprintf(buf, fmt, std::forward<Args>(args)...);
+#ifdef UNIT_TESTING
+    if (sz < 0 || std::size_t(sz) >= N) {
+        throw std::runtime_error("SprintfAsrt buffer too small or snprintf error");
+    }
+#else
+    assert(sz >= 0 && std::size_t(sz) < N);
+#endif
+}
+
 }  // namespace neuron

test/CMakeLists.txt

@@ -24,6 +24,7 @@ add_executable(
   unit_tests/container/node.cpp
   unit_tests/node_order_optim/permutations.cpp
   unit_tests/utils/enumerate.cpp
+  unit_tests/utils/Sprintf.cpp
   unit_tests/oc/hoc_interpreter.cpp
   cover/unit_tests/cover.cpp)
 set(catch2_targets testneuron)

test/unit_tests/utils/Sprintf.cpp

@@ -0,0 +1,19 @@
+#include <catch2/catch_test_macros.hpp>
+
+#define UNIT_TESTING
+#include "oc/wrap_sprintf.h"
+
+using neuron::SprintfAsrt;
+
+TEST_CASE("buf fits", "[NEURON]") {
+    char buf[20];
+    SprintfAsrt(buf, "%s", "hello");
+    REQUIRE(strcmp(buf, "hello") == 0);
+}
+
+TEST_CASE("buf too small", "[NEURON]") {
+    char buf[5];
+    char* s = strdup("hello");
+    REQUIRE_THROWS(SprintfAsrt(buf, "%s", s));
+    free(s);
+}