Add util/git_info

Removes need to force-compile main and all report files to get updated
git revision info.

engine/Makefile

@@ -238,15 +238,9 @@ $(OBJ_DIR)$(PATHSEP)%.$(OBJ_EXT): %.cpp $(SRC_H)
 	-@echo [$(MODULE)] Compiling $(notdir $<)
 	$(CXX) $(CPP_FLAGS) $(OPTS) -S $< -o $@
 
-# Force regeneration of sc_main.o on every recompilation to potntially get the
+# Force regeneration of git_info.o on every recompilation to potntially get the
 # changed GIT shorthash into the binary
-sc_main.o: .FORCE
-
-report/sc_report_html_sim.o: .FORCE
-
-report/sc_report_json.o: .FORCE
-
-report/sc_report_xml.o: .FORCE
+util/git_info.o: .FORCE
 
 # cleanup targets
 mostlyclean:

engine/report/sc_report_html_sim.cpp

@@ -7,6 +7,7 @@
 #include "sc_report.hpp"
 #include "data/report_data.inc"
 #include "interfaces/sc_js.hpp"
+#include "util/git_info.hpp"
 
 // Experimental Raw Ability Output for Blizzard to do comparisons
 namespace raw_ability_summary
@@ -1054,28 +1055,31 @@ void print_html_masthead( report::sc_html_stream& os, const sim_t& sim )
 
   os.format(
       "<span id=\"logo\"></span>\n"
-      "<h1><a href=\"%s\">SimulationCraft %s</a></h1>\n"
-#if !defined( SC_GIT_REV )
-      "<h2>for World of Warcraft %s %s (wow build level %d)</h2>\n\n",
-#else
-      "<h2>for World of Warcraft %s %s (wow build level %d, git build <a "
-      "href=\"%s\">%s</a>)</h2>\n\n",
-#endif
-      "http://www.simulationcraft.org/", SC_VERSION, sim.dbc.wow_version(),
-      ( sim.dbc.ptr ?
+      "<h1><a href=\"%s\">SimulationCraft %s</a></h1>\n",
+      "http://www.simulationcraft.org/", SC_VERSION);
+
+  const char* type =       ( sim.dbc.ptr ?
 #if SC_BETA
                     "BETA"
 #else
                     "PTR"
 #endif
-                    : "Live" ),
-#if !defined( SC_GIT_REV )
-      sim.dbc.build_level() );
-#else
-      sim.dbc.build_level(),
-      "https://github.com/simulationcraft/simc/commit/" SC_GIT_REV,
-      SC_GIT_REV );
-#endif
+                    : "Live" );
+
+  if ( !git_info::available())
+  {
+  os.format(
+      "<h2>for World of Warcraft %s %s (wow build level %d)</h2>\n\n",
+      sim.dbc.wow_version(), type, sim.dbc.build_level());
+  }
+  else
+  {
+    std::string commit_link = "https://github.com/simulationcraft/simc/commit/";
+    commit_link += git_info::revision();
+    os.format("<h2>for World of Warcraft %s %s (wow build level %d, git build <a "
+        "href=\"%s\">%s</a>)</h2>\n\n",
+        sim.dbc.wow_version(), type, sim.dbc.build_level(), commit_link.c_str(), git_info::revision());
+  }
 
   time_t rawtime;
   time( &rawtime );

engine/report/sc_report_json.cpp

@@ -6,6 +6,7 @@
 #include "sc_report.hpp"
 #include "interfaces/sc_js.hpp"
 #include "simulationcraft.hpp"
+#include "util/git_info.hpp"
 
 #include "util/rapidjson/filewritestream.h"
 #include "util/rapidjson/document.h"
@@ -1770,9 +1771,11 @@ js::sc_js_t get_root( const sim_t& sim )
 {
   js::sc_js_t root;
   root.set( "version", SC_VERSION );
-#if defined( SC_GIT_REV )
-  root.set( "git_rev", SC_GIT_REV );
-#endif
+  if ( git_info::available())
+  {
+    root.set( "git_branch", git_info::branch() );
+    root.set( "git_rev", git_info::revision() );
+  }
   root.set( "ptr_enabled", SC_USE_PTR );
   root.set( "beta_enabled", SC_BETA );
   root.set( "build_date", __DATE__ );
@@ -1794,9 +1797,11 @@ void print_json2_pretty( FILE* o, const sim_t& sim )
   root[ "beta_enabled" ] = SC_BETA;
   root[ "build_date" ] = __DATE__;
   root[ "build_time" ] = __TIME__;
-#if defined( SC_GIT_REV )
-  root[ "git_revision" ] = SC_GIT_REV;
-#endif
+  if ( git_info::available())
+  {
+    root[ "git_revision" ] = git_info::revision();
+    root[ "git_branch" ] = git_info::branch();
+  }
 
   to_json( root[ "sim" ], sim );
 

engine/report/sc_report_xml.cpp

@@ -6,6 +6,7 @@
 #include "sc_report.hpp"
 #include <stack>
 #include "simulationcraft.hpp"
+#include "util/git_info.hpp"
 
 namespace
 {  // UNNAMED NAMESPACE ==========================================
@@ -1524,9 +1525,11 @@ void print_xml( sim_t* sim )
   writer.print_attribute( "ptr", sim->dbc.ptr ? "true" : "false" );
   writer.print_attribute( "wow_build",
                           util::to_string( sim->dbc.build_level() ) );
-#if defined( SC_GIT_REV )
-  writer.print_attribute( "sc_git_build", SC_GIT_REV );
-#endif
+  if ( git_info::available())
+  {
+    writer.print_attribute( "sc_git_branch", git_info::branch() );
+    writer.print_attribute( "sc_git_build", git_info::revision() );
+  }
 
 #if SC_BETA
 

engine/sc_main.cpp

@@ -4,6 +4,7 @@
 // ==========================================================================
 
 #include "simulationcraft.hpp"
+#include "util/git_info.hpp"
 #include "sim/sc_profileset.hpp"
 #include <locale>
 
@@ -248,13 +249,16 @@ int sim_t::main( const std::vector<std::string>& args )
     setup_success = false;
   }
 
-#if ! defined( SC_GIT_REV )
+  if ( !git_info::available() )
+  {
   util::printf("SimulationCraft %s for World of Warcraft %s %s (wow build %s)\n",
       SC_VERSION, dbc.wow_version(), dbc.wow_ptr_status(), util::to_string(dbc.build_level()).c_str());
-#else
+  }
+  else
+  {
   util::printf("SimulationCraft %s for World of Warcraft %s %s (wow build %s, git build %s %s)\n",
-      SC_VERSION, dbc.wow_version(), dbc.wow_ptr_status(), util::to_string(dbc.build_level()).c_str(), SC_GIT_BRANCH, SC_GIT_REV);
-#endif
+      SC_VERSION, dbc.wow_version(), dbc.wow_ptr_status(), util::to_string(dbc.build_level()).c_str(), git_info::branch(), git_info::revision());
+  }
 
   if ( display_hotfixes )
   {

engine/util/git_info.cpp

@@ -0,0 +1,40 @@
+// ==========================================================================
+// Dedmonwakeen's Raid DPS/TPS Simulator.
+// Send questions to [email protected]
+// ==========================================================================
+
+#include "git_info.hpp"
+
+#if defined( SC_GIT_REV ) && defined( SC_GIT_BRANCH )
+
+bool git_info::available()
+{
+  return true;
+}
+const char* git_info::revision()
+{
+  return SC_GIT_REV;
+}
+
+const char* git_info::branch()
+{
+  return SC_GIT_BRANCH;
+}
+
+#else
+
+bool git_info::available()
+{
+  return false;
+}
+const char* git_info::revision()
+{
+  return "";
+}
+
+const char* git_info::branch()
+{
+  return "";
+}
+
+#endif

engine/util/git_info.hpp

@@ -0,0 +1,15 @@
+// ==========================================================================
+// Dedmonwakeen's Raid DPS/TPS Simulator.
+// Send questions to [email protected]
+// ==========================================================================
+
+#pragma once
+
+namespace git_info {
+  /// True if git revision information is available
+  bool available();
+  /// git revision in short form
+  const char* revision();
+  /// current git branch
+  const char* branch();
+}

qt/sc_window.cpp

@@ -14,6 +14,7 @@
 #include "sc_WelcomeTab.hpp"
 #include "sc_AddonImportTab.hpp"
 #include "util/sc_mainwindowcommandline.hpp"
+#include "util/git_info.hpp"
 #ifdef SC_PAPERDOLL
 #include "sc_PaperDoll.hpp"
 #endif
@@ -797,13 +798,18 @@ void SC_MainWindow::startSim()
 
   QString tab_name = std::get<0>( value );
   auto simc_gui_profile = std::get<1>( value );
-#if ! defined( SC_GIT_REV )
-  auto simc_version = QString("### SimulationCraft %1 for World of Warcraft %2 %3 (wow build %4) ###\n\n").
-      arg(SC_VERSION).arg(sim->dbc.wow_version()).arg(sim->dbc.wow_ptr_status()).arg(sim->dbc.build_level());
-#else
-  auto simc_version = QString("### SimulationCraft %1 for World of Warcraft %2 %3 (wow build %4, git build %5) ###\n\n").
-          arg(SC_VERSION).arg(sim->dbc.wow_version()).arg(sim->dbc.wow_ptr_status()).arg(sim->dbc.build_level()).arg(SC_GIT_REV);
-#endif
+  QString simc_version;
+  if ( !git_info::available())
+  {
+    simc_version = QString("### SimulationCraft %1 for World of Warcraft %2 %3 (wow build %4) ###\n\n").
+        arg(SC_VERSION).arg(sim->dbc.wow_version()).arg(sim->dbc.wow_ptr_status()).arg(sim->dbc.build_level());
+  }
+  else
+  {
+    simc_version = QString("### SimulationCraft %1 for World of Warcraft %2 %3 (wow build %4, git build %5 %6) ###\n\n").
+            arg(SC_VERSION).arg(sim->dbc.wow_version()).arg(sim->dbc.wow_ptr_status()).arg(sim->dbc.build_level()).
+            arg(git_info::branch()).arg(git_info::revision());
+  }
   simc_gui_profile = simc_version + simc_gui_profile;
   QByteArray utf8_profile = simc_gui_profile.toUtf8();
   QFile file( AppDataDir + QDir::separator() + "simc_gui.simc" );

source_files/QT_engine.pri

@@ -40,6 +40,7 @@
  SOURCES += engine/util/rng.cpp
  SOURCES += engine/util/io.cpp
  SOURCES += engine/util/concurrency.cpp
+ SOURCES += engine/util/git_info.cpp
  SOURCES += engine/sim/x7_pantheon.cpp
  SOURCES += engine/sim/sc_sim.cpp
  SOURCES += engine/sim/sc_scaling.cpp

source_files/VS_engine.props

@@ -54,6 +54,9 @@ To change the list of source files, update the QT_ files and run synchronize.py
 		<ClCompile Include="..\engine\util\concurrency.cpp">
 			<PrecompiledHeader>NotUsing</PrecompiledHeader>
 		</ClCompile>
+		<ClCompile Include="..\engine\util\git_info.cpp">
+			<PrecompiledHeader>NotUsing</PrecompiledHeader>
+		</ClCompile>
 		<ClCompile Include="..\engine\sim\x7_pantheon.cpp">
 
 		</ClCompile>

source_files/engine_make

@@ -8,6 +8,7 @@ SRC += \
     util$(PATHSEP)rng.cpp \
     util$(PATHSEP)io.cpp \
     util$(PATHSEP)concurrency.cpp \
+    util$(PATHSEP)git_info.cpp \
     sim$(PATHSEP)x7_pantheon.cpp \
     sim$(PATHSEP)sc_sim.cpp \
     sim$(PATHSEP)sc_scaling.cpp \