Add PREFER_VERSION_FILE build option.

Improve CMake error on invalid version string.

Author: thezbyg

CMakeLists.txt

@@ -3,6 +3,7 @@ project(gpick)
 option(ENABLE_NLS "compile with gettext support" true)
 option(USE_GTK3 "use GTK3 instead of GTK2" true)
 option(DEV_BUILD "use development flags" false)
+option(PREFER_VERSION_FILE "read version information from file instead of using GIT" false)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 file(GLOB SOURCES
 	source/*.cpp source/*.h

README.md

@@ -54,17 +54,17 @@ gettext ([http://www.gnu.org/s/gettext](http://www.gnu.org/s/gettext)). Required
 
 ### Building
 
-Using CMake:
+#### Using CMake:
 
 `mkdir build && cd build` to create out-of-source build directory.
 
-`cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local` to prepare build files for installation to '/usr/local'.
+`cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local` to prepare build files for installation to `/usr/local`.
 
 `make` to compile all files.
 
 `make install` to install executable and resources to `DESTDIR`. Default `DESTDIR` value is set by `CMAKE_INSTALL_PREFIX` variable.
 
-Using SCons:
+#### Using SCons:
 
 `scons` to compile all files and place executable file in `build/`.
 
@@ -76,3 +76,4 @@ ENABLE\_NLS - compile with gettext support. Enabled by default.
 
 USE\_GTK3 - use GTK3 instead of GTK2. Enabled by default.
 
+PREFER\_VERSION\_FILE - read version information from file instead of using GIT. Disabled by default. This option enables unconditional `.version` file usage. `.version` file is included in release source archives and is a simple text file containing the following information in four lines: major/minor version, revision, commit hash and commit date.

SConscript

@@ -17,6 +17,7 @@ vars.Add('MSVS_VERSION', 'Visual Studio version', '11.0')
 vars.Add(BoolVariable('PREBUILD_GRAMMAR', 'Use prebuild grammar files', False))
 vars.Add(BoolVariable('USE_GTK3', 'Use GTK3 instead of GTK2', True))
 vars.Add(BoolVariable('DEV_BUILD', 'Use development flags', False))
+vars.Add(BoolVariable('PREFER_VERSION_FILE', 'Read version information from file instead of using GIT', False))
 vars.Update(env)
 
 if env['LOCALEDIR'] == '':
@@ -39,7 +40,7 @@ if env['BUILD_TARGET'] == 'win32':
 			env.Tool('mingw')
 
 env.AddCustomBuilders()
-env.GetVersionInfo()
+env.GetVersionInfo(env['PREFER_VERSION_FILE'])
 
 try:
 	umask = os.umask(0o022)

cmake/Version.cmake

@@ -1,8 +1,10 @@
 cmake_minimum_required(VERSION 3.12)
-find_program(GIT_EXECUTABLE git DOC "Git version control")
-mark_as_advanced(GIT_EXECUTABLE)
-find_file(GITDIR NAMES .git PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH NO_PACKAGE_ROOT_PATH)
-if (GIT_EXECUTABLE AND GITDIR)
+if (NOT PREFER_VERSION_FILE)
+	find_program(GIT_EXECUTABLE git DOC "Git version control")
+	mark_as_advanced(GIT_EXECUTABLE)
+	find_file(GITDIR NAMES .git PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH NO_PACKAGE_ROOT_PATH)
+endif()
+if (NOT PREFER_VERSION_FILE AND GIT_EXECUTABLE AND GITDIR)
 	set(old_tz $ENV{TZ})
 	set(ENV{TZ} UTC)
 	execute_process(COMMAND "${GIT_EXECUTABLE}" describe "--match=gpick-*" "--match=v*" --always --long
@@ -14,6 +16,10 @@ if (GIT_EXECUTABLE AND GITDIR)
 	if (version_error)
 		message(FATAL_ERROR "Failed to get version: ${version_error}")
 	endif()
+	string(REGEX MATCH "^(gpick-|v)([(0-9)]+\\.[(0-9)(a-z)]+(\\.[(0-9)(a-z)]+)?(-[(0-9)]+)?).*" version_good ${version})
+	if (NOT version_good)
+		message(FATAL_ERROR "Invalid version string: ${version}")
+	endif()
 	string(REGEX REPLACE "^(gpick-|v)([(0-9)]+\\.[(0-9)(a-z)]+(\\.[(0-9)(a-z)]+)?(-[(0-9)]+)?).*" "\\2" version_parts ${version})
 	string(REPLACE "-" ";" version_parts ${version_parts})
 	list(GET version_parts 0 GPICK_BUILD_VERSION)
@@ -41,10 +47,32 @@ else()
 		message(FATAL_ERROR "Version file \".version\" is required when GIT can not be used to get version information.")
 	endif()
 	file(STRINGS "${VERSION_FILE}" version_parts LIMIT_COUNT 4)
+	list(LENGTH version_parts version_part_count)
+	if (version_part_count LESS 1)
+		message(FATAL_ERROR "Version file \".version\" must contain version number in first line.")
+	endif()
 	list(GET version_parts 0 GPICK_BUILD_VERSION)
-	list(GET version_parts 1 GPICK_BUILD_REVISION)
-	list(GET version_parts 2 GPICK_BUILD_HASH)
-	list(GET version_parts 3 GPICK_BUILD_DATE)
+	if (NOT GPICK_BUILD_VERSION)
+		message(FATAL_ERROR "Version file \".version\" must contain version number in first line.")
+	endif()
+	if (version_part_count GREATER 1)
+		list(GET version_parts 1 GPICK_BUILD_REVISION)
+	endif()
+	if (version_part_count GREATER 2)
+		list(GET version_parts 2 GPICK_BUILD_HASH)
+	endif()
+	if (version_part_count GREATER 3)
+		list(GET version_parts 3 GPICK_BUILD_DATE)
+	endif()
+	if (NOT GPICK_BUILD_REVISION)
+		set(GPICK_BUILD_REVISION 0)
+	endif()
+	if (NOT GPICK_BUILD_HASH)
+		set(GPICK_BUILD_HASH "0")
+	endif()
+	if (NOT GPICK_BUILD_DATE)
+		set(GPICK_BUILD_DATE "-")
+	endif()
 endif()
 if (GPICK_BUILD_REVISION GREATER 0)
 	set(GPICK_BUILD_VERSION_FULL "${GPICK_BUILD_VERSION}-${GPICK_BUILD_REVISION}")

tools/gpick.py

@@ -151,10 +151,15 @@ def GetSourceFiles(self, dir_exclude_pattern, file_exclude_pattern):
 		MatchFiles(files, self.GetLaunchDir(), os.sep, dir_exclude_prog, file_exclude_prog)
 		return files
 
-	def GetVersionInfo(self):
-		try:
-			(version, revision, hash, date) = getVersionInfo()
-		except:
+	def GetVersionInfo(self, preferVersionFile):
+		haveVersionInfo = False
+		if not preferVersionFile:
+			try:
+				(version, revision, hash, date) = getVersionInfo()
+				haveVersionInfo = True
+			except:
+				pass
+		if not haveVersionInfo:
 			try:
 				with open("../.version", "r", encoding = 'utf-8') as version_file:
 					(version, revision, hash, date) = version_file.read().splitlines()