Distinguish log type

Author: stevschmid

src/Core.cpp

@@ -56,9 +56,9 @@ void Core::Tick() {
 
   if( wasGameRunning != mGameRunning ) {
     if( mGameRunning ) {
-      LOG("Hearthstone found");
+      INFO("Hearthstone found");
     } else {
-      LOG("Hearthstone was closed");
+      INFO("Hearthstone was closed");
       Hearthstone::Instance()->SetRestartRequired( false );
     }
   }
@@ -96,7 +96,7 @@ void Core::HandleMatchStart() {
 
 void Core::HandleMatchEnd( const ::CardHistoryList& cardHistoryList, bool wasSpectating ) {
   if( wasSpectating ) {
-    LOG( "Ignore spectated match" );
+    INFO( "Ignore spectated match" );
     ResetResult();
     return;
   }

src/Hearthstone.cpp

@@ -64,8 +64,8 @@ void Hearthstone::SetWindowCapture( WindowCapture *windowCapture ) {
 }
 
 void Hearthstone::EnableLogging() {
-  const int   NUM_LOG_MODULES = 4;
-  const char  LOG_MODULES[ NUM_LOG_MODULES ][ 32 ] = { "Zone", "Asset", "Bob", "Power" };
+  const int   NUM_INFO_MODULES = 4;
+  const char  INFO_MODULES[ NUM_INFO_MODULES ][ 32 ] = { "Zone", "Asset", "Bob", "Power" };
 
   string path = LogConfigPath();
   QFile file( path.c_str() );
@@ -82,17 +82,17 @@ void Hearthstone::EnableLogging() {
   }
 
   if( !file.open( QIODevice::WriteOnly | QIODevice::Append | QIODevice::Text ) ) {
-    LOG( "Couldn't create file %s", path.c_str() );
+    ERROR( "Couldn't create file %s", path.c_str() );
   } else {
     QTextStream out( &file );
-    for( int i = 0; i < NUM_LOG_MODULES; i++ ) {
-      const char *logModuleName = LOG_MODULES[ i ];
+    for( int i = 0; i < NUM_INFO_MODULES; i++ ) {
+      const char *logModuleName = INFO_MODULES[ i ];
       if( !contents.contains( QString( "[%1]" ).arg( logModuleName ) ) ) {
         out << "\n";
-        out << "[" << LOG_MODULES[i] << "]\n";
+        out << "[" << INFO_MODULES[i] << "]\n";
         out << "LogLevel=1\n";
         out << "ConsolePrinting=true\n";
-        LOG( "Enable Log Module %s", logModuleName );
+        INFO( "Enable Log Module %s", logModuleName );
 
         if( Running() ) {
           SetRestartRequired( true );
@@ -107,7 +107,7 @@ void Hearthstone::DisableLogging() {
   QFile file( LogConfigPath().c_str() );
   if( file.exists() ) {
     file.remove();
-    LOG( "Ingame log deactivated." );
+    INFO( "Ingame log deactivated." );
   }
 }
 
@@ -132,7 +132,7 @@ string Hearthstone::LogPath() {
   QSettings hsKey( "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Hearthstone", QSettings::NativeFormat );
   QString hsPath = hsKey.value( "InstallLocation" ).toString();
   if( hsPath.isEmpty() ) {
-    LOG( "LogPath Fallback" );
+    INFO( "LogPath Fallback" );
     QString programFiles( getenv( "PROGRAMFILES(X86)" ) );
     if( programFiles.isEmpty() ) {
       programFiles = getenv( "PROGRAMFILES" );

src/Local.h

@@ -137,10 +137,12 @@ typedef vector< CardHistoryItem > CardHistoryList;
 
 
 #include "Logger.h"
-#define LOG(str, ...) Logger::Instance()->Add(str, ##__VA_ARGS__)
+
+#define INFO(str, ...) Logger::Instance()->Add(LOG_INFO, str, ##__VA_ARGS__)
+#define ERROR(str, ...) Logger::Instance()->Add(LOG_ERROR, str, ##__VA_ARGS__)
 
 #ifdef _DEBUG
-#define DEBUG(str, ...) Logger::Instance()->Add("[DEBUG] "str, ##__VA_ARGS__)
+#define DEBUG(str, ...) Logger::Instance()->Add(LOG_DEBUG, str, ##__VA_ARGS__)
 #else
 #define DEBUG(str, ...)
 #endif

src/Logger.cpp

@@ -14,31 +14,31 @@ void Logger::SetLogPath( const string& path ) {
   mOf.open( path.c_str(), std::ios_base::app );
 }
 
-void Logger::Add( const char *fmt, ... ) {
+void Logger::Add( LogEventType type, const char *fmt, ... ) {
   char buffer[ 4096 ];
 
+  // Parse vargs
   va_list args;
   va_start( args, fmt );
   vsnprintf( buffer, sizeof(buffer), fmt, args );
   va_end( args );
 
-  Add( string( buffer ) );
-}
-
-void Logger::Add( const string& message ) {
   // Timestamp
   char timestamp[ 256 ];
   time_t t = time( 0 );
   struct tm *now = localtime( &t );
-  strftime( timestamp, sizeof( timestamp ), "[%H:%M:%S] ", now );
+  strftime( timestamp, sizeof( timestamp ), "%H:%M:%S", now );
 
-  string line = string( timestamp ) + message + "\n";
+  // Decorate
+  char decorated[ 4096 ];
+  sprintf( decorated, "[%s] %s: %s\n", timestamp, LOG_EVENT_TYPE_NAMES[ type ], buffer );
+  string line = string( decorated );
 
   // Add to file
   if( mOf.is_open() ) {
     mOf << line;
     mOf.flush();
   }
 
-  emit NewMessage( line );
+  emit NewMessage( type, line );
 }

src/Logger.h

@@ -9,6 +9,18 @@
 
 #include <QDebug>
 
+typedef enum {
+  LOG_DEBUG = 0,
+  LOG_INFO = 1,
+  LOG_ERROR = 2
+} LogEventType;
+
+const char LOG_EVENT_TYPE_NAMES[][128] = {
+  "DEBUG",
+  "INFO",
+  "ERROR"
+};
+
 class Logger : public QObject {
   Q_OBJECT;
 
@@ -17,12 +29,12 @@ DEFINE_SINGLETON( Logger )
 private:
   std::ofstream mOf;
 
+
 public:
   void SetLogPath( const string& path );
-  void Add( const char *fmt, ... );
-  void Add( const string& message );
+  void Add( LogEventType type, const char *fmt, ... );
 
 signals:
-  void NewMessage( const string& message );
+  void NewMessage( LogEventType type, const string& message );
 };
 

src/Main.cpp

@@ -69,7 +69,7 @@ int main( int argc, char **argv )
   Logger::Instance()->SetLogPath( logFilePath );
 
   // Start
-  LOG( "--> Launched v%s on %s", VERSION, QDate::currentDate().toString( Qt::ISODate ).toStdString().c_str() );
+  INFO( "--> Launched v%s on %s", VERSION, QDate::currentDate().toString( Qt::ISODate ).toStdString().c_str() );
 
 #if defined Q_OS_MAC
   CocoaInitializer cocoaInitializer;
@@ -91,7 +91,7 @@ int main( int argc, char **argv )
   int exitCode = app.exec();
 
   // Tear down
-  LOG( "<-- Shutdown" );
+  INFO( "<-- Shutdown" );
 
   return exitCode;
 }

src/Tracker.cpp

@@ -30,68 +30,59 @@ Tracker::~Tracker() {
 
 void Tracker::EnsureAccountIsSetUp() {
   if( !IsAccountSetUp() ) {
-    LOG( "No account setup. Creating one for you." );
+    INFO( "No account setup. Creating one for you." );
     CreateAndStoreAccount();
   } else {
-    LOG( "Account %s found", Username().toStdString().c_str() );
+    INFO( "Account %s found", Username().toStdString().c_str() );
   }
 }
 
 void Tracker::AddResult( GameMode mode, Outcome outcome, GoingOrder order, Class ownClass, Class opponentClass,
     const CardHistoryList& historyCardList, int durationInSeconds, int rank, int legend )
 {
   if( mode == MODE_SOLO_ADVENTURES ) {
-    LOG( "Ignore solo adventure" );
+    INFO( "Ignore solo adventure" );
     return;
   }
 
   if( mode == MODE_TAVERN_BRAWL ) {
-    LOG( "Ignore tavern brawl" );
+    INFO( "Ignore tavern brawl" );
     return;
   }
 
-#ifdef _DEBUG
-  string cardHistoryOutput;
-  for( CardHistoryList::const_iterator it = historyCardList.begin(); it != historyCardList.end(); ++it ) {
-    cardHistoryOutput += (*it).player == PLAYER_SELF ? "SELF " : "OPPONENT ";
-    cardHistoryOutput += (*it).cardId + "\n";
-  }
-  DEBUG( "Card History: %s", cardHistoryOutput.c_str() );
-#endif
-
   if( outcome == OUTCOME_UNKNOWN ) {
     mUnknownOutcomeCount++;
-    LOG( "Outcome unknown. Skip result" );
+    INFO( "Outcome unknown. Skip result" );
     return;
   }
 
   if( mode == MODE_UNKNOWN ) {
     mUnknownModeCount++;
-    LOG( "Mode unknown. Skip result" );
+    INFO( "Mode unknown. Skip result" );
     return;
   }
 
   if( order == ORDER_UNKNOWN ) {
     mUnknownOrderCount++;
-    LOG( "Order unknown. Skip result" );
+    INFO( "Order unknown. Skip result" );
     return;
   }
 
   if( ownClass == CLASS_UNKNOWN ) {
     mUnknownClassCount++;
-    LOG( "Own Class unknown. Skip result" );
+    INFO( "Own Class unknown. Skip result" );
     return;
   }
 
   if( opponentClass == CLASS_UNKNOWN ) {
     mUnknownOpponentCount++;
-    LOG( "Class of Opponent unknown. Skip result" );
+    INFO( "Class of Opponent unknown. Skip result" );
     return;
   }
 
   mSuccessfulResultCount++;
 
-  LOG( "Upload %s %s vs. %s as %s. Went %s",
+  INFO( "Upload %s %s vs. %s as %s. Went %s",
       MODE_NAMES[ mode ],
       OUTCOME_NAMES[ outcome ],
       CLASS_NAMES[ opponentClass ],
@@ -167,10 +158,10 @@ QNetworkRequest Tracker::CreateTrackerRequest( const QString& path ) {
 void Tracker::AddResultHandleReply() {
   QNetworkReply *reply = static_cast< QNetworkReply* >( sender() );
   if( reply->error() == QNetworkReply::NoError ) {
-    LOG( "Result was uploaded successfully!" );
+    INFO( "Result was uploaded successfully!" );
   } else {
     int statusCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt();
-    LOG( "There was a problem uploading the result. Error: %i HTTP Status Code: %i", reply->error(), statusCode );
+    ERROR( "There was a problem uploading the result. Error: %i HTTP Status Code: %i", reply->error(), statusCode );
   }
 }
 
@@ -183,17 +174,17 @@ void Tracker::CreateAndStoreAccount() {
 void Tracker::CreateAndStoreAccountHandleReply() {
   QNetworkReply *reply = static_cast< QNetworkReply* >( sender() );
   if( reply->error() == QNetworkReply::NoError ) {
-    LOG( "Account creation was successful!" );
+    INFO( "Account creation was successful!" );
 
     QByteArray jsonData = reply->readAll();
 
     bool ok;
     QtJson::JsonObject user = QtJson::parse( jsonData, ok ).toMap();
 
     if( !ok ) {
-      LOG( "Couldn't parse response" );
+      ERROR( "Couldn't parse response" );
     } else {
-      LOG( "Welcome %s", user[ "username" ].toString().toStdString().c_str() );
+      INFO( "Welcome %s", user[ "username" ].toString().toStdString().c_str() );
 
       SetUsername( user["username"].toString() );
       SetPassword( user["password"].toString() );
@@ -202,7 +193,7 @@ void Tracker::CreateAndStoreAccountHandleReply() {
     }
   } else {
     int statusCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt();
-    LOG( "There was a problem creating an account. Error: %i HTTP Status Code: %i", reply->error(), statusCode );
+    ERROR( "There was a problem creating an account. Error: %i HTTP Status Code: %i", reply->error(), statusCode );
   }
 }
 
@@ -220,14 +211,14 @@ void Tracker::OpenProfileHandleReply() {
     QtJson::JsonObject response = QtJson::parse( jsonData, ok ).toMap();
 
     if( !ok ) {
-      LOG( "Couldn't parse response" );
+      INFO( "Couldn't parse response" );
     } else {
       QString url = response[ "url" ].toString();
       QDesktopServices::openUrl( QUrl( url ) );
     }
   } else {
     int statusCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt();
-    LOG( "There was a problem creating an auth token. Error: %i HTTP Status Code: %i", reply->error(), statusCode );
+    ERROR( "There was a problem creating an auth token. Error: %i HTTP Status Code: %i", reply->error(), statusCode );
   }
 }
 

src/Window.cpp

@@ -51,7 +51,7 @@ void SettingsTab::ExportAccount() {
     out << Tracker::Instance()->Password();
     out << Tracker::Instance()->WebserviceURL();
 
-    LOG( "Account %s exported in %s", Tracker::Instance()->Username().toStdString().c_str(), fileName.toStdString().c_str() );
+    INFO( "Account %s exported in %s", Tracker::Instance()->Username().toStdString().c_str(), fileName.toStdString().c_str() );
   }
 }
 
@@ -87,10 +87,10 @@ void SettingsTab::ImportAccount() {
       Tracker::Instance()->SetPassword( password );
       Tracker::Instance()->SetWebserviceURL( webserviceUrl );
 
-      LOG( "Account %s imported from %s", username.toStdString().c_str(), fileName.toStdString().c_str() );
+      INFO( "Account %s imported from %s", username.toStdString().c_str(), fileName.toStdString().c_str() );
       LoadSettings();
     } else {
-      LOG( "Import failed" );
+      ERROR( "Import failed" );
     }
   }
 }
@@ -128,19 +128,32 @@ LogTab::LogTab( QWidget *parent )
 {
   mUI->setupUi( this );
 
-  QFont font( "Monospace" );
-  font.setStyleHint( QFont::TypeWriter );
-  mUI->logText->setFont( font );
+  QFont fixedFont = QFontDatabase::systemFont( QFontDatabase::FixedFont );
+  mUI->logText->setFont( fixedFont );
 
-  connect( Logger::Instance(), SIGNAL( NewMessage(const string&) ), this, SLOT( AddLogEntry(const string&) ) );
+  connect( Logger::Instance(), SIGNAL( NewMessage(LogEventType, const string&) ), this, SLOT( AddLogEntry(LogEventType, const string&) ) );
 }
 
 LogTab::~LogTab() {
   delete mUI;
 }
 
-void LogTab::AddLogEntry( const string& msg ) {
+void LogTab::AddLogEntry( LogEventType type, const string& msg ) {
   mUI->logText->moveCursor( QTextCursor::End );
+
+  switch( type ) {
+    case LOG_ERROR:
+      mUI->logText->setTextColor( Qt::red );
+      break;
+
+    case LOG_DEBUG:
+      mUI->logText->setTextColor( Qt::gray );
+      break;
+
+    default:
+      mUI->logText->setTextColor( QApplication::palette().text().color() );
+  }
+
   mUI->logText->insertPlainText( msg.c_str() );
   mUI->logText->moveCursor( QTextCursor::End );
 }

src/Window.h

@@ -57,7 +57,7 @@ class LogTab : public QWidget
   Ui::LogWidget *mUI;
 
 private slots:
-  void AddLogEntry( const string& message );
+  void AddLogEntry( LogEventType type, const string& message );
 
 public:
   explicit LogTab( QWidget *parent = 0 );