Add Windows scripts to extract version information from base/version.h.

Author: c-lipka

source/base/version.h

@@ -54,6 +54,15 @@
 ///
 /// @name Primary Version and Copyright Information
 ///
+/// @note
+///     The macro definition in this section may be probed by external tools, and must therefore
+///     conform to the following rules:
+///       - The definitions must reside on a single line each.
+///       - The lines must not be disabled via conditional compilation or multi-line comments.
+///       - The lines must not contain any whitespace other than plain blanks (ASCII 0x20).
+///       - The macros must be defined as plain string literals, plain decimal integer literals,
+///         or plain empty, depending on their purpose.
+///
 /// @{
 
 /// Copyright string.
@@ -74,7 +83,7 @@
 /// or complex bugfixes that require thorough testing.
 #define POV_RAY_REVISION_INT        0
 
-/// Fourth numerical component of official source code version ("patch level") as integer.
+/// Fourth numerical component of official source code version ("maintenance patch level") as integer.
 /// Increment this field to indicate simple bugfixes.
 #define POV_RAY_PATCHLEVEL_INT      0
 
@@ -91,7 +100,7 @@
 /// where `N` is a serial number starting at 1 in each phase, `TIME` is the number of minutes
 /// since 2000-01-01 00:00, and `FEATURE` is an arbitrary alphanumeric moniker for a particular
 /// experimental feature.
-#define POV_RAY_PRERELEASE "alpha"
+#define POV_RAY_PRERELEASE          "alpha"
 
 /// @def POVRAY_IS_BETA
 /// Whether this version is a beta.

tools/windows/get-source-version.bat

@@ -0,0 +1,17 @@
+@echo off
+
+REM * Extract POV-Ray version information from `source/base/version.h`
+REM *
+REM * Run as follows:
+REM *
+REM *   call "tools/windows/get-source-version.bat" "source/base/version.h"
+REM *
+REM * This will cause the followng envionment variables to be set:
+REM *
+REM *   POV_SOURCE_GENERATION   First two fields of the version string (`X.Y`)
+REM *   POV_SOURCE_VERSION      Full version string (`X.Y.Z`[`.P`][`-PRE`])
+REM *   POV_SOURCE_PRERELEASE   Pre-release tag portion of the version string (`PRE`), or undefined if not applicable
+
+powershell -executionpolicy remotesigned -File "%~dp0get-source-version.ps1" "%~1" -bat version~.bat
+call version~.bat
+del version~.bat

tools/windows/get-source-version.ps1

@@ -0,0 +1,68 @@
+# Extract POV-Ray version information from `source/base/version.h`
+#
+# From PowerShell scripts, run as follows:
+#
+#   Set-ExecutionPolicy remotesigned -scope process -force
+#   ./tools/windows/get-source-version.ps1 ./source/base/version.h
+#
+# From batch files, run as follows:
+#
+#   powershell -executionpolicy remotesigned -File ./tools/windows/get-source-version.ps1 ./source/base/version.h -bat version~.bat
+#   call version~.bat
+#   del version~.bat
+#
+# Both procedures will cause the following envionment variables to be set:
+#
+#   POV_SOURCE_GENERATION   First two fields of the version string (`X.Y`)
+#   POV_SOURCE_VERSION      Full version string (`X.Y.Z`[`.P`][`-PRE`])
+#   POV_SOURCE_PRERELEASE   Pre-release tag portion of the version string (`PRE`), or empty[*] if not applicable
+#
+# [*In the batch version of the procedure, empty environment variables will be left undefined.]
+
+param ([string]$version_h, [string]$bat)
+
+function GetNumericMacro ([string]$file, [string]$macro) {
+    $regexp = '^\s*#define\s+' + $macro + '\s+[0-9]+\s*$'
+    $line = ( select-string -Path $file -Pattern $regexp | % { $_.Matches } | % { $_.Value } )
+    $string = ( select-string -InputObject $line -Pattern '\s+[0-9]+' | % { $_.Matches } | % { $_.Value } )
+    $value = ( select-string -InputObject $string -Pattern '[0-9]+' | % { $_.Matches } | % { $_.Value } )
+    return [string]$value
+}
+
+function GetStringMacro ([string]$file, [string]$macro) {
+    $regexp = '^\s*#define\s+' + $macro + '\s*"[^"]+"\s*$'
+    $line = ( select-string -Path $file -Pattern $regexp | % { $_.Matches } | % { $_.Value } )
+    $string = ( select-string -InputObject $line -Pattern '"[^"]+"' | % { $_.Matches } | % { $_.Value } )
+    $value = ( select-string -InputObject $string -Pattern '[^"]+' | % { $_.Matches } | % { $_.Value } )
+    return [string]$value
+}
+
+$major      = GetNumericMacro $version_h 'POV_RAY_MAJOR_VERSION_INT'
+$minor      = GetNumericMacro $version_h 'POV_RAY_MINOR_VERSION_INT'
+$revision   = GetNumericMacro $version_h 'POV_RAY_REVISION_INT'
+$patchlevel = GetNumericMacro $version_h 'POV_RAY_PATCHLEVEL_INT'
+
+$prerelease = GetStringMacro  $version_h 'POV_RAY_PRERELEASE'
+
+$generation = $major + "." + $minor
+if ([int]$patchlevel -eq 0) {
+    $release = $generation + "." + $revision
+} else {
+    $release = $generation + "." + $revision + "." + $patchlevel
+}
+if ($prerelease) {
+    $version = $release + '-' + $prerelease
+} else {
+    $version = $release
+}
+
+$env:POV_SOURCE_GENERATION = $generation
+$env:POV_SOURCE_VERSION    = $version
+$env:POV_SOURCE_PRERELEASE = $prerelease
+
+if ($bat) {
+    $text =  "set POV_SOURCE_GENERATION=" + $env:POV_SOURCE_GENERATION + "`n"
+    $text += "set POV_SOURCE_VERSION="    + $env:POV_SOURCE_VERSION + "`n"
+    $text += "set POV_SOURCE_PRERELEASE=" + $env:POV_SOURCE_PRERELEASE + "`n"
+    Out-File -LiteralPath $bat -Encoding ASCII -InputObject $text -NoNewline
+}