Improve build version information.

Author: thezbyg

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.10)
 project(gpick)
 option(ENABLE_NLS "compile with gettext support" true)
 option(USE_GTK3 "use GTK3 instead of GTK2" true)
@@ -14,6 +14,7 @@ file(GLOB SOURCES
 	source/lua/*.cpp source/lua/*.h
 	source/tools/*.cpp source/tools/*.h
 	source/transformation/*.cpp source/transformation/*.h
+	source/version/*.cpp source/version/*.h
 )
 list(REMOVE_ITEM SOURCES source/Color.cpp source/Color.h source/lua/Script.cpp source/lua/Script.h)
 include(Version)
@@ -30,7 +31,7 @@ if (PkgConfig_FOUND)
 	endif()
 	pkg_search_module(Lua lua5.4>=5.4 lua5>=5.4 lua5.3>=5.3 lua5>=5.3 lua>=5.3 lua5.2>=5.2 lua>=5.2)
 	pkg_check_modules(Expat expat>=1.0)
-endif (PkgConfig_FOUND)
+endif()
 set(THREADS_PREFER_PTHREAD_FLAG ON)
 find_package(Threads REQUIRED)
 find_package(Ragel 6.9 REQUIRED)

README.md

@@ -68,7 +68,7 @@ Using CMake:
 
 Using SCons:
 
-`scons` to compile all files and place executable file in `build/source/`.
+`scons` to compile all files and place executable file in `build/`.
 
 `scons install` to install executable and resources to `DESTDIR`. By default `DESTDIR` is `/usr/local`.
 

SConscript

@@ -3,7 +3,7 @@
 import os, string, sys, shutil, math
 from tools import *
 
-env = GpickEnvironment(ENV = os.environ, BUILDERS = {'WriteNsisVersion': Builder(action = WriteNsisVersion, suffix = ".nsi")})
+env = GpickEnvironment(ENV = os.environ)
 
 vars = Variables(os.path.join(env.GetLaunchDir(), 'user-config.py'))
 vars.Add('DESTDIR', 'Directory to install under', '/usr/local')
@@ -22,10 +22,6 @@ vars.Update(env)
 if env['LOCALEDIR'] == '':
 	env['LOCALEDIR'] = env['DESTDIR'] + '/share/locale'
 
-v = Variables(os.path.join(env.GetLaunchDir(), 'version.py'))
-v.Add('GPICK_BUILD_VERSION', '', '0.0')
-v.Update(env)
-
 if not env['BUILD_TARGET']:
 	env['BUILD_TARGET'] = sys.platform
 
@@ -150,13 +146,8 @@ env.Append(CPPPATH = ['#source'])
 
 def buildVersion(env):
 	version_env = env.Clone()
-	version_env.Append(CPPDEFINES = {
-		'BUILD_DATE': env['GPICK_BUILD_DATE'],
-		'BUILD_REVISION': env['GPICK_BUILD_REVISION'],
-		'BUILD_PLATFORM': sys.platform,
-		'BUILD_VERSION': env['GPICK_BUILD_VERSION'],
-	})
-	return version_env.StaticObject(version_env.Glob('source/version/*.cpp'))
+	sources = version_env.Template(version_env.Glob('source/version/*.in'), TEMPLATE_ENV_FILTER = ['GPICK_*'])
+	return version_env.StaticObject(version_env.Glob('#source/version/*.cpp') + sources)
 
 def buildLayout(env):
 	layout_env = env.Clone()
@@ -213,13 +204,7 @@ def buildColorNames(env):
 
 def buildWindowsResources(env):
 	resources_env = env.Clone()
-	resources_env.Append(RESOURCE_TEMPLATE_VARS = {
-		'VERSION': env['GPICK_BUILD_VERSION'],
-		'VERSION_COMMA': env['GPICK_BUILD_VERSION'].replace('.', ','),
-		'REVISION': env['GPICK_BUILD_REVISION'],
-		'BUILD_DATE': env['GPICK_BUILD_DATE'],
-	})
-	resources = resources_env.AlwaysBuild(resources_env.ResourceTemplate(resources_env.Glob('source/winres/*.rct')))
+	resources = resources_env.Template(resources_env.Glob('source/winres/*.rc.in'), TEMPLATE_ENV_FILTER = ['GPICK_*'])
 	objects = resources_env.RES(resources)
 	Command("source/winres/gpick-icon.ico", File("source/winres/gpick-icon.ico").srcnode(), Copy("$TARGET", "${SOURCE}"))
 	if not (env['TOOLCHAIN'] == 'msvc'):
@@ -379,12 +364,8 @@ env.Alias(target = "install", source = [
 	env.InstallDataAutoDir(dir = env['DESTDIR'] + '/share/locale/', relative_dir = 'share/locale/', source = [env.Glob('share/locale/*/LC_MESSAGES/gpick.mo')]),
 ])
 
-env.Alias(target = "nsis", source = [
-	env.WriteNsisVersion("version.py")
-])
-
 env.Alias(target = "version", source = [
-	env.Template(target = "#version.txt", source = "version.template"),
+	env.AlwaysBuild(env.Template(target = "#.version", source = None, TEMPLATE_ENV_FILTER = ['GPICK_*'], TEMPLATE_SOURCE = '@GPICK_BUILD_VERSION@\n@GPICK_BUILD_REVISION@\n@GPICK_BUILD_HASH@\n@GPICK_BUILD_DATE@\n'))
 ])
 
 tarFiles = env.GetSourceFiles("(" + RegexEscape(os.sep) + r"\.)|(" + RegexEscape(os.sep) + r"\.svn$)|(^" + RegexEscape(os.sep) + r"build$)", r"(^\.)|(\.pyc$)|(\.orig$)|(~$)|(\.log$)|(\.diff)|(\.mo$)|(\.patch)|(^gpick-.*\.tar\.gz$)|(^user-config\.py$)")
@@ -397,5 +378,5 @@ if 'TAR' in env:
 		env.Tar('gpick_' + str(env['GPICK_BUILD_VERSION']) + '.tar.gz', tarFiles)
 	])
 
-env.Default(executable, env.Install('source', executable))
+env.Default(executable, executable)
 

cmake/FindGettext.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 3.10)
 find_program(MSGMERGE_EXECUTABLE NAMES msgmerge)
 find_program(MSGFMT_EXECUTABLE NAMES msgfmt)
 find_program(MSGCAT_EXECUTABLE NAMES msgcat)

cmake/FindRagel.cmake

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 3.10)
 find_program(RAGEL_EXECUTABLE NAMES ragel DOC "path to the ragel executable")
 mark_as_advanced(RAGEL_EXECUTABLE)
 if (RAGEL_EXECUTABLE)

cmake/Version.cmake

@@ -1,50 +1,52 @@
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 3.10)
 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)
-find_file(VERSION_FILE NAMES version.py PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH)
-if (NOT VERSION_FILE)
-	message(SEND_ERROR "Missing version file \"version.py\"")
-endif()
-file(STRINGS "${VERSION_FILE}" GPICK_VERSION LIMIT_COUNT 1)
-string(FIND ${GPICK_VERSION} "=" position)
-string(LENGTH ${GPICK_VERSION} length)
-math(EXPR position "${position} + 2")
-math(EXPR length "${length} - ${position} - 1")
-string(SUBSTRING ${GPICK_VERSION} ${position} ${length} GPICK_VERSION)
-set(GPICK_BUILD_PLATFORM "${CMAKE_SYSTEM_NAME}")
 if (GIT_EXECUTABLE AND GITDIR)
 	set(old_tz $ENV{TZ})
 	set(ENV{TZ} UTC)
-	execute_process(COMMAND "${GIT_EXECUTABLE}" show --quiet "--date=format-local:%Y-%m-%d;%H:%M:%S" "--format=%H;%cd;"
+	execute_process(COMMAND "${GIT_EXECUTABLE}" describe "--match=gpick-*" "--match=v*" --always --long
+		WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+		OUTPUT_VARIABLE version
+		ERROR_VARIABLE version_error
+		OUTPUT_STRIP_TRAILING_WHITESPACE
+	)
+	if (version_error)
+		message(FATAL_ERROR "Failed to get version: ${version_error}")
+	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)
+	list(GET version_parts 1 GPICK_BUILD_REVISION)
+	execute_process(COMMAND "${GIT_EXECUTABLE}" show --quiet "--date=format-local:%Y-%m-%d" "--format=%H;%cd"
 		WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
 		OUTPUT_VARIABLE version_parts
 		ERROR_VARIABLE version_error
 		OUTPUT_STRIP_TRAILING_WHITESPACE
 	)
 	set(ENV{TZ} "${old_tz}")
 	if (version_error)
-		message(SEND_ERROR "Failed to get version: ${version_error}")
+		message(FATAL_ERROR "Failed to get version: ${version_error}")
 	endif()
 	list(LENGTH version_parts length)
 	if (length LESS 2)
-		message(SEND_ERROR "Invalid version string ${version_parts}")
+		message(FATAL_ERROR "Invalid version string ${version_parts}")
 	endif()
-	list(GET version_parts 0 GPICK_REVISION)
+	list(GET version_parts 0 GPICK_BUILD_HASH)
 	list(GET version_parts 1 GPICK_BUILD_DATE)
-	list(GET version_parts 2 GPICK_BUILD_TIME)
-	string(SUBSTRING ${GPICK_REVISION} 0 10 GPICK_REVISION)
+	file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/.version" "${GPICK_BUILD_VERSION}\n${GPICK_BUILD_REVISION}\n${GPICK_BUILD_HASH}\n${GPICK_BUILD_DATE}")
 else()
-	find_file(VERSION_TXT_FILE NAMES version.txt PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH)
-	if (VERSION_TXT_FILE)
-		file(STRINGS "${VERSION_TXT_FILE}" version_parts LIMIT_COUNT 3)
-		list(GET version_parts 0 GPICK_REVISION)
-		list(GET version_parts 1 GPICK_BUILD_DATE)
-		list(GET version_parts 2 GPICK_BUILD_TIME)
-		string(SUBSTRING ${GPICK_REVISION} 0 10 GPICK_REVISION)
-		return()
+	find_file(VERSION_FILE NAMES .version PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH)
+	if (NOT VERSION_FILE)
+		message(FATAL_ERROR "Version file \".version\" is required when GIT can not be used to get version information.")
 	endif()
-	set(GPICK_REVISION "unknown")
-	set(GPICK_BUILD_DATE "")
-	set(GPICK_BUILD_TIME "")
+	file(STRINGS "${VERSION_FILE}" version_parts LIMIT_COUNT 4)
+	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)
 endif()
+set(GPICK_BUILD_VERSION_FULL "${GPICK_BUILD_VERSION}-${GPICK_BUILD_REVISION}")
+string(REGEX REPLACE "([(0-9)]+)[^\\.]*" "\\1" version_part ${GPICK_BUILD_VERSION})
+string(REPLACE "." "," GPICK_BUILD_VERSION_FULL_COMMA "${version_part},${GPICK_BUILD_REVISION}")
+string(SUBSTRING ${GPICK_BUILD_HASH} 0 10 GPICK_BUILD_HASH)

installer/Makefile

@@ -20,7 +20,7 @@ DEPFILES= files/Gpick.exe
 .SUFFIXES: .wxs .wixobj .xstl
 
 all: $(MSI).msi
-  
+
 $(MSI).msi: $(OBJS) $(DEPFILES) $(HEAT_SRCS)
 	$(LIGHT) -nologo $(LIGHT_FLAGS) -out $@ $(OBJS)
 

installer/getversion.py

@@ -1,14 +1,12 @@
-import os,sys,re
+import os, re
 parentdir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-sys.path.insert(0,parentdir) 
-import version
 
 def getversion(style):
+	with open(os.path.join(parentdir, ".version"), "r") as file:
+		lines = file.read().splitlines()
+		version = lines[0]
+		revision = lines[1]
 	if style == "full":
-		print version.GPICK_BUILD_VERSION
+		print(version + '-' + revision)
 	else:
-		result = re.match(r"^(\d+\.\d+\.\d+)(.*)$", version.GPICK_BUILD_VERSION)
-		if result:
-			print result.group(1) 
-		else:
-			print "invalid_version"
+		print(re.sub(r'(\d+)[^\.]*', '\\1', version) + '.' + revision)