Add git revision info to player version

[carstene1ns]

Replaces #2070, fixes #87.

Works both on git checkouts and release tarballs.
A checked out git tag behaves the same like a release tarball.
make distcheck works

For our builds we can easily inject a tag (like CI, PR, AUR, OBS) with
-DPLAYER_VERSION_APPEND for cmake or --enable-append-version for autotools.

[Ghabry]

Great work!

What doesn't work is regenerating the Git-Stuff in CMake after a commit happened or a tag was added. This uses then the stale data. Though this is probably hard to fix. Not sure how to do this properly. So can be omitted for now.

---

Minor improvement idea (see patch): GetVersionString could be added to version.cpp/.h and then used in Player. This makes GetFullVersionString so simple that PrintVersionString can be removed. (Maybe also move GetFullVersionString to version.cpp/.h?

Also added the git-version to Window_About. The append-part does currently not fit. Can be solved later by changing the layout of that scene (moving the menu to the top and using a horizontal menu).

diff --git a/src/player.cpp b/src/player.cpp
index 56458492..2fe1a69b 100644
--- a/src/player.cpp
+++ b/src/player.cpp
@@ -690,7 +690,7 @@ Game_Config Player::ParseCommandLine(int argc, char *argv[]) {
 		}
 #endif
 		if (cp.ParseNext(arg, 0, "--version", 'v')) {
-			PrintVersion();
+			std::cout << GetFullVersionString() << "\n";
 			exit(0);
 			break;
 		}
@@ -1321,19 +1321,7 @@ std::string Player::GetEncoding() {
 }
 
 std::string Player::GetFullVersionString() {
-	std::stringstream version;
-	version << "EasyRPG Player " << Version::STRING;
-	if (std::strlen(Version::GIT) > 0) {
-		version << " " << Version::GIT;
-	}
-	if (std::strlen(Version::APPEND) > 0) {
-		version << " " << Version::APPEND;
-	}
-	return version.str();
-}
-
-void Player::PrintVersion() {
-	std::cout << GetFullVersionString() << std::endl;
+	return std::string(GAME_TITLE) + " " + Version::GetVersionString();
 }
 
 void Player::PrintUsage() {
diff --git a/src/player.h b/src/player.h
index da4b43f8..4010d820 100644
--- a/src/player.h
+++ b/src/player.h
@@ -267,9 +267,6 @@ namespace Player {
 	/** @return full version string */
 	std::string GetFullVersionString();
 
-	/** Output program version on stdout */
-	void PrintVersion();
-
 	/** Output program usage information on stdout */
 	void PrintUsage();
 
diff --git a/src/version.cpp b/src/version.cpp
index 2b16a27f..696cef0a 100644
--- a/src/version.cpp
+++ b/src/version.cpp
@@ -47,4 +47,14 @@ namespace Version {
 	const char GIT[] = EP_VERSION_GIT;
 	const char APPEND[] = EP_VERSION_APPEND;
 
+	std::string GetVersionString(bool with_git, bool with_append) {
+		std::string ver = Version::STRING;
+		if (with_git && std::strlen(GIT) > 0) {
+			ver += std::string(" ") + GIT;
+		}
+		if (with_append && std::strlen(APPEND) > 0) {
+			ver += std::string(" ") + APPEND;
+		}
+		return ver;
+	}
 }
diff --git a/src/version.h b/src/version.h
index 063995a6..7b42a2d6 100644
--- a/src/version.h
+++ b/src/version.h
@@ -18,6 +18,9 @@
 #ifndef EP_VERSION_H
 #define EP_VERSION_H
 
+#include <cstring>
+#include <string>
+
 /**
  * Version of Player.
  */
@@ -30,6 +33,13 @@ namespace Version {
 	extern const char GIT[];
 	extern const char APPEND[];
 
+	/**
+	 * Generates a version string.
+	 *
+	 * @param with_git Append git information (if available)
+	 * @param with_append Append additional information (if available, by default the build date)
+	 */
+	std::string GetVersionString(bool with_git = true, bool with_append = true);
 }
 
 /**
diff --git a/src/window_about.cpp b/src/window_about.cpp
index 9eb0bf3d..d3191a72 100644
--- a/src/window_about.cpp
+++ b/src/window_about.cpp
@@ -36,7 +36,7 @@ void Window_About::Refresh() {
 		"interpreter.",
 		"Licensed under the GPLv3",
 		"",
-		"Version: " + std::string(Version::STRING),
+		"Version: " + Version::GetVersionString(true, false),
 		"Website: easyrpg.org",
 		"",
 		"Contact us:",
-- 
2.35.1

0001-Bla.zip

[carstene1ns]

Do not merge yet.

[carstene1ns]

This has been successively broken in 2016 and 2018 m(

doxygen used the version of the expat package here (because of config file providing PACKAGE_VERSION)

[carstene1ns]

This is ready now.

[Ghabry]

Not a full review due to lack of time.
Wow you really pushed this forward. Even updates all the version information in all of the resource files etc. Great job!

Also the oldest issue closed 🎉