logging: remove unused return value from LogPrintStr

practicalswift · practicalswift · commit 0bd4cd398b19 · 2018-05-02T11:25:20.000+02:00
`LogPrintStr` returns the number of characters printed. This number is doubled if both logging to console and logging to file is enabled. As the return value is never used, I've opted to remove it instead of try to fix it. Credit: @laanwj
diff --git a/src/logging.cpp b/src/logging.cpp
@@ -198,23 +198,20 @@ std::string BCLog::Logger::LogTimestampStr(const std::string &str)
     return strStamped;
 }
 
-int BCLog::Logger::LogPrintStr(const std::string &str)
+void BCLog::Logger::LogPrintStr(const std::string &str)
 {
-    int ret = 0; // Returns total number of characters written
-
     std::string strTimestamped = LogTimestampStr(str);
 
     if (m_print_to_console) {
         // print to console
-        ret = fwrite(strTimestamped.data(), 1, strTimestamped.size(), stdout);
+        fwrite(strTimestamped.data(), 1, strTimestamped.size(), stdout);
         fflush(stdout);
     }
     if (m_print_to_file) {
         std::lock_guard<std::mutex> scoped_lock(m_file_mutex);
 
         // buffer if we haven't opened the log yet
         if (m_fileout == nullptr) {
-            ret = strTimestamped.length();
             m_msgs_before_open.push_back(strTimestamped);
         }
         else
@@ -224,15 +221,14 @@ int BCLog::Logger::LogPrintStr(const std::string &str)
                 m_reopen_file = false;
                 m_fileout = fsbridge::freopen(m_file_path, "a", m_fileout);
                 if (!m_fileout) {
-                    return ret;
+                    return;
                 }
                 setbuf(m_fileout, nullptr); // unbuffered
             }
 
-            ret = FileWriteStr(strTimestamped, m_fileout);
+            FileWriteStr(strTimestamped, m_fileout);
         }
     }
-    return ret;
 }
 
 void BCLog::Logger::ShrinkDebugFile()
diff --git a/src/logging.h b/src/logging.h
@@ -86,7 +86,7 @@ namespace BCLog {
         std::atomic<bool> m_reopen_file{false};
 
         /** Send a string to the log output */
-        int LogPrintStr(const std::string &str);
+        void LogPrintStr(const std::string &str);
 
         /** Returns whether logs will be written to any output */
         bool Enabled() const { return m_print_to_console || m_print_to_file; }

Original file line number	Diff line number	Diff line change
`@@ -198,23 +198,20 @@ std::string BCLog::Logger::LogTimestampStr(const std::string &str)`
`198`	`198`	`return strStamped;`
`199`	`199`	`}`
`200`	`200`
`201`		`-int BCLog::Logger::LogPrintStr(const std::string &str)`
	`201`	`+void BCLog::Logger::LogPrintStr(const std::string &str)`
`202`	`202`	`{`
`203`		`- int ret = 0; // Returns total number of characters written`
`204`		`-`
`205`	`203`	`std::string strTimestamped = LogTimestampStr(str);`
`206`	`204`
`207`	`205`	`if (m_print_to_console) {`
`208`	`206`	`// print to console`
`209`		`- ret = fwrite(strTimestamped.data(), 1, strTimestamped.size(), stdout);`
	`207`	`+ fwrite(strTimestamped.data(), 1, strTimestamped.size(), stdout);`
`210`	`208`	`fflush(stdout);`
`211`	`209`	`}`
`212`	`210`	`if (m_print_to_file) {`
`213`	`211`	`std::lock_guard<std::mutex> scoped_lock(m_file_mutex);`
`214`	`212`
`215`	`213`	`// buffer if we haven't opened the log yet`
`216`	`214`	`if (m_fileout == nullptr) {`
`217`		`- ret = strTimestamped.length();`
`218`	`215`	`m_msgs_before_open.push_back(strTimestamped);`
`219`	`216`	`}`
`220`	`217`	`else`
`@@ -224,15 +221,14 @@ int BCLog::Logger::LogPrintStr(const std::string &str)`
`224`	`221`	`m_reopen_file = false;`
`225`	`222`	`m_fileout = fsbridge::freopen(m_file_path, "a", m_fileout);`
`226`	`223`	`if (!m_fileout) {`
`227`		`- return ret;`
	`224`	`+ return;`
`228`	`225`	`}`
`229`	`226`	`setbuf(m_fileout, nullptr); // unbuffered`
`230`	`227`	`}`
`231`	`228`
`232`		`- ret = FileWriteStr(strTimestamped, m_fileout);`
	`229`	`+ FileWriteStr(strTimestamped, m_fileout);`
`233`	`230`	`}`
`234`	`231`	`}`
`235`		`- return ret;`
`236`	`232`	`}`
`237`	`233`
`238`	`234`	`void BCLog::Logger::ShrinkDebugFile()`