From baced535e32689a7b340623747c111c4e2e43c93 Mon Sep 17 00:00:00 2001
From: Andrew Johnson <anj@anl.gov>
Date: Wed, 28 Oct 2020 23:55:24 -0500
Subject: [PATCH] Add -v (verbose) flag to softIoc

Only display the startup steps taken if -v was given.
Show each step *before* running it, so error messages follow it.
---
 modules/database/src/std/softIoc/softMain.cpp | 42 +++++++++++++------
 1 file changed, 29 insertions(+), 13 deletions(-)

diff --git a/modules/database/src/std/softIoc/softMain.cpp b/modules/database/src/std/softIoc/softMain.cpp
index e38e7b8e8..97e0a9f4a 100644
--- a/modules/database/src/std/softIoc/softMain.cpp
+++ b/modules/database/src/std/softIoc/softMain.cpp
@@ -47,13 +47,15 @@ extern "C" int softIoc_registerRecordDeviceDriver(struct dbBase *pdbbase);
 
 namespace {
 
+bool verbose = false;
+
 static void exitSubroutine(subRecord *precord) {
     epicsExitLater((precord->a == 0.0) ? EXIT_SUCCESS : EXIT_FAILURE);
 }
 
 void usage(const char *arg0, const std::string& base_dbd) {
     std::cout<<"Usage: "<<arg0<<
-               " [-D softIoc.dbd] [-h] [-S] [-s] [-a ascf]\n"
+               " [-D softIoc.dbd] [-h] [-S] [-s] [-v] [-a ascf]\n"
                "[-m macro=value,macro2=value2] [-d file.db]\n"
                "[-x prefix] [st.cmd]\n"
                "\n"
@@ -66,6 +68,8 @@ void usage(const char *arg0, const std::string& base_dbd) {
                "\n"
                "    -s  Previously caused a shell to be started.  Now accepted and ignored.\n"
                "\n"
+               "    -v  Verbose, display steps taken during startup.\n"
+               "\n"
                "    -a <acf>  Access Security configuration file.  Macro substitution is\n"
                "        performed.\n"
                "\n"
@@ -103,12 +107,14 @@ void lazy_dbd(const std::string& dbd_file) {
     if(lazy_dbd_loaded) return;
     lazy_dbd_loaded = true;
 
+    if (verbose)
+        std::cout<<"dbLoadDatabase(\""<<dbd_file<<"\")\n";
     errIf(dbLoadDatabase(dbd_file.c_str(), NULL, NULL),
           std::string("Failed to load DBD file: ")+dbd_file);
-    std::cout<<"dbLoadDatabase(\""<<dbd_file<<"\")\n";
 
+    if (verbose)
+        std::cout<<"softIoc_registerRecordDeviceDriver(pdbbase)\n";
     softIoc_registerRecordDeviceDriver(pdbbase);
-    std::cout<<"softIoc_registerRecordDeviceDriver(pdbbase)\n";
     registryFunctionAdd("exit", (REGISTRYFUNCTION) exitSubroutine);
 }
 
@@ -144,7 +150,7 @@ int main(int argc, char *argv[])
 
         int opt;
 
-        while ((opt = getopt(argc, argv, "ha:D:d:m:Ssx:")) != -1) {
+        while ((opt = getopt(argc, argv, "ha:D:d:m:Ssx:v")) != -1) {
             switch (opt) {
             case 'h':               /* Print usage */
                 usage(argv[0], dbd_file);
@@ -158,13 +164,15 @@ int main(int argc, char *argv[])
             case 'a':
                 lazy_dbd(dbd_file);
                 if (!macros.empty()) {
+                    if (verbose)
+                        std::cout<<"asSetSubstitutions(\""<<macros<<"\")\n";
                     if(asSetSubstitutions(macros.c_str()))
                         throw std::bad_alloc();
-                    std::cout<<"asSetSubstitutions(\""<<macros<<"\")\n";
                 }
+                if (verbose)
+                    std::cout<<"asSetFilename(\""<<optarg<<"\")\n";
                 if(asSetFilename(optarg))
                     throw std::bad_alloc();
-                std::cout<<"asSetFilename(\""<<optarg<<"\")\n";
                 break;
             case 'D':
                 if(lazy_dbd_loaded) {
@@ -174,12 +182,14 @@ int main(int argc, char *argv[])
                 break;
             case 'd':
                 lazy_dbd(dbd_file);
+                if (verbose) {
+                    std::cout<<"dbLoadRecords(\""<<optarg<<"\"";
+                    if(!macros.empty())
+                        std::cout<<", \""<<macros<<"\"";
+                    std::cout<<")\n";
+                }
                 errIf(dbLoadRecords(optarg, macros.c_str()),
                       std::string("Failed to load: ")+optarg);
-                std::cout<<"dbLoadRecords(\""<<optarg<<"\"";
-                if(!macros.empty())
-                    std::cout<<", \""<<macros<<"\"";
-                std::cout<<")\n";
                 loadedDb = true;
                 break;
             case 'm':
@@ -190,6 +200,9 @@ int main(int argc, char *argv[])
                 break;
             case 's':
                 break; // historical
+            case 'v':
+                verbose = true;
+                break;
             case 'x':
                 lazy_dbd(dbd_file);
                 xmacro  = "IOC=";
@@ -207,17 +220,20 @@ int main(int argc, char *argv[])
             // run script
             // ignore any extra positional args (historical)
 
-            std::cout<<"# Begin "<<argv[optind]<<"\n";
+            if (verbose)
+                std::cout<<"# Begin "<<argv[optind]<<"\n";
             errIf(iocsh(argv[optind]),
                         std::string("Error in ")+argv[optind]);
-            std::cout<<"# End "<<argv[optind]<<"\n";
+            if (verbose)
+                std::cout<<"# End "<<argv[optind]<<"\n";
 
             epicsThreadSleep(0.2);
             loadedDb = true;    /* Give it the benefit of the doubt... */
         }
 
         if (loadedDb) {
-            std::cout<<"iocInit()\n";
+            if (verbose)
+                std::cout<<"iocInit()\n";
             iocInit();
             epicsThreadSleep(0.2);
         }