Fix file:line logging in gamelogic

logs.writeSrcLocation.* cvars no longer emit warnings due to
duplicate registration, and are obeyed by the gamelogic.

Author: slipher

src/common/Log.cpp

@@ -40,6 +40,16 @@ static Cvar::Range<Cvar::Cvar<int>> suppressionCount(
     "logs.suppression.count", "Number of occurrences for a message to be considered log spam", Cvar::NONE, 10, 1, 1000000);
 static Cvar::Range<Cvar::Cvar<int>> suppressionBufSize(
     "logs.suppression.bufferSize", "How many distinct messages to track for log suppression", Cvar::NONE, 50, 1, 1000000);
+static Cvar::Cvar<bool> logExtendAll(
+    "logs.writeSrcLocation.all", "Always print source code location for logs", Cvar::NONE, false);
+static Cvar::Cvar<bool> logExtendWarn(
+    "logs.writeSrcLocation.warn", "Print source code location for Warn logs", Cvar::NONE, false);
+static Cvar::Cvar<bool> logExtendNotice(
+    "logs.writeSrcLocation.notice", "Print source code location for Notice logs", Cvar::NONE, false);
+static Cvar::Cvar<bool> logExtendVerbose(
+    "logs.writeSrcLocation.verbose", "Print source code location for Verbose logs", Cvar::NONE, false);
+static Cvar::Cvar<bool> logExtendDebug(
+    "logs.writeSrcLocation.debug", "Print source code location for Debug logs", Cvar::NONE, false);
 
 #define GET_LOG_CVAR(type, name, object) (object.Get())
 #else
@@ -56,16 +66,6 @@ static T GetCvarOrDie(Str::StringRef cvar) {
 #endif
 
 namespace Log {
-    Cvar::Cvar<bool> logExtendAll(
-        "logs.writeSrcLocation.all", "Always print source code location for logs", Cvar::NONE, false );
-    Cvar::Cvar<bool> logExtendWarn(
-        "logs.writeSrcLocation.warn", "Print source code location for Warn logs", Cvar::NONE, false );
-    Cvar::Cvar<bool> logExtendNotice(
-        "logs.writeSrcLocation.notice", "Print source code location for Notice logs", Cvar::NONE, false );
-    Cvar::Cvar<bool> logExtendVerbose(
-        "logs.writeSrcLocation.verbose", "Print source code location for Verbose logs", Cvar::NONE, false );
-    Cvar::Cvar<bool> logExtendDebug(
-        "logs.writeSrcLocation.debug", "Print source code location for Debug logs", Cvar::NONE, false );
 
     Logger::Logger(Str::StringRef name, std::string prefix, Level defaultLevel)
         : filterLevel(new Cvar::Cvar<Log::Level>(
@@ -82,7 +82,27 @@ namespace Log {
         return prefix + message;
     }
 
-    void Logger::Dispatch(std::string message, Log::Level level, Str::StringRef format) {
+    static bool WantLocationInfo(Log::Level level) {
+        if (GET_LOG_CVAR(bool, "logs.writeSrcLocation.all", logExtendAll)) {
+            return true;
+        }
+        switch (level) {
+        case Log::Level::DEBUG:
+            return GET_LOG_CVAR(bool, "logs.writeSrcLocation.debug", logExtendDebug);
+        case Log::Level::VERBOSE:
+            return GET_LOG_CVAR(bool, "logs.writeSrcLocation.verbose", logExtendVerbose);
+        case Log::Level::NOTICE:
+            return GET_LOG_CVAR(bool, "logs.writeSrcLocation.notice", logExtendNotice);
+        case Log::Level::WARNING:
+            return GET_LOG_CVAR(bool, "logs.writeSrcLocation.warn", logExtendWarn);
+        }
+        ASSERT_UNREACHABLE();
+    }
+
+    void Logger::Dispatch(std::string message, Log::Level level, Str::StringRef format, const char* file, const char* function, int line) {
+        if (WantLocationInfo(level)) {
+            message = Str::Format("%s ^F(%s:%u, %s)", message, file, line, function);
+        }
         if (enableSuppression) {
             Log::DispatchWithSuppression(std::move(message), level, format);
         } else {

src/common/Log.h

@@ -51,12 +51,6 @@ namespace Log {
     // The default filtering level
     const Level DEFAULT_FILTER_LEVEL = Level::WARNING;
 
-    extern Cvar::Cvar<bool> logExtendAll;
-    extern Cvar::Cvar<bool> logExtendWarn;
-    extern Cvar::Cvar<bool> logExtendNotice;
-    extern Cvar::Cvar<bool> logExtendVerbose;
-    extern Cvar::Cvar<bool> logExtendDebug;
-
     /*
      * Loggers are used to group logs by subsystems and allow logs
      * to be filtered by log level by subsystem. They are used like so
@@ -116,7 +110,8 @@ namespace Log {
             Logger WithoutSuppression();
 
         private:
-            void Dispatch(std::string message, Log::Level level, Str::StringRef format);
+            void Dispatch(std::string message, Log::Level level, Str::StringRef format,
+                          const char* file, const char* function, int line);
 
             std::string Prefix(Str::StringRef message) const;
 
@@ -203,62 +198,35 @@ namespace Log {
 
     // Logger
 
-    inline std::string AddSrcLocation( const std::string& message,
-        const char* file, const char* function, const int line,
-        const bool extend ) {
-        if ( logExtendAll.Get() || extend ) {
-            return message + Str::Format( " ^F(%s:%u, %s)",
-                file, line, function );
-        }
-
-        return message;
-    }
-
     template<typename ... Args>
     void Logger::WarnExt( const char* file, const char* function, const int line, Str::StringRef format, Args&& ... args ) {
         if ( filterLevel->Get() <= Level::WARNING ) {
-            this->Dispatch(
-                AddSrcLocation(
-                    Prefix( Str::Format( format, std::forward<Args>( args ) ... ) ),
-                    file, function, line, logExtendWarn.Get()
-                ),
-                Level::WARNING, format );
+            this->Dispatch(Prefix(Str::Format(format, std::forward<Args>(args)...)),
+                           Level::WARNING, format, file, function, line);
         }
     }
 
     template<typename ... Args>
     void Logger::NoticeExt( const char* file, const char* function, const int line, Str::StringRef format, Args&& ... args ) {
         if ( filterLevel->Get() <= Level::NOTICE ) {
-            this->Dispatch(
-                AddSrcLocation(
-                    Prefix( Str::Format( format, std::forward<Args>( args ) ... ) ),
-                    file, function, line, logExtendNotice.Get()
-                ),
-                Level::NOTICE, format );
+            this->Dispatch(Prefix(Str::Format(format, std::forward<Args>(args)...)),
+                           Level::NOTICE, format, file, function, line);
         }
     }
 
     template<typename ... Args>
     void Logger::VerboseExt( const char* file, const char* function, const int line, Str::StringRef format, Args&& ... args ) {
         if ( filterLevel->Get() <= Level::VERBOSE ) {
-            this->Dispatch(
-                AddSrcLocation(
-                    Prefix( Str::Format( format, std::forward<Args>( args ) ... ) ),
-                    file, function, line, logExtendVerbose.Get()
-                ),
-                Level::VERBOSE, format );
+            this->Dispatch(Prefix(Str::Format(format, std::forward<Args>(args)...)),
+                           Level::VERBOSE, format, file, function, line);
         }
     }
 
     template<typename ... Args>
     void Logger::DebugExt( const char* file, const char* function, const int line, Str::StringRef format, Args&& ... args ) {
         if ( filterLevel->Get() <= Level::DEBUG ) {
-            this->Dispatch(
-                AddSrcLocation(
-                    Prefix( Str::Format( format, std::forward<Args>( args ) ... ) ),
-                    file, function, line, logExtendDebug.Get()
-                ),
-                Level::DEBUG, format );
+            this->Dispatch(Prefix(Str::Format(format, std::forward<Args>(args)...)),
+                           Level::DEBUG, format, file, function, line);
         }
     }