build: Include Windows version information on produced binaries (AcademySoftwareFoundation#4696)

This change embeds version information into our Windows binaries. This
is done by ways of a `version_win32.rc` resource file[1] populated at
CMake configure time with our major.minor.patch version information.

This not only allows at a glance to discover what version a particular
OIIO binary is (see screenshot), but it also impacts certain MSI
installer behaviors. If this is a MSI install which updates a prior
installation, and the shared libs/dlls don't have version information,
then the installer assumes the binaries are equal and just skips them.
This can be problematic for applications that package OIIO etc.

Old on left, New on right:

![old-vs-new](https://github.com/user-attachments/assets/2ff354ab-54a9-4dfb-8d97-90b138472bd7)

[1]
https://learn.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource

---------

Signed-off-by: Jesse Yurkovich <[email protected]>

Author: jessey-git

src/build-scripts/version_win32.rc.in

@@ -0,0 +1,48 @@
+#include <winver.h>
+
+#define VER_FILEVERSION             @PROJECT_VERSION_MAJOR@,@PROJECT_VERSION_MINOR@,@PROJECT_VERSION_PATCH@,0
+#define VER_FILEVERSION_STR         "@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@[email protected]\0"
+
+#define VER_PRODUCTVERSION          @PROJECT_VERSION_MAJOR@,@PROJECT_VERSION_MINOR@,@PROJECT_VERSION_PATCH@,0
+#define VER_PRODUCTVERSION_STR      "@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@\0"
+
+#ifndef DEBUG
+#define VER_DEBUG                   0
+#else
+#define VER_DEBUG                   VS_FF_DEBUG
+#endif
+
+VS_VERSION_INFO VERSIONINFO
+FILEVERSION     VER_FILEVERSION
+PRODUCTVERSION  VER_PRODUCTVERSION
+FILEFLAGSMASK   VS_FFI_FILEFLAGSMASK
+FILEFLAGS       (VER_DEBUG)
+FILEOS          VOS__WINDOWS32
+FILETYPE        VFT_DLL
+FILESUBTYPE     VFT2_UNKNOWN
+BEGIN
+    BLOCK "StringFileInfo"
+    BEGIN
+        BLOCK "040904E4"
+        BEGIN
+            VALUE "FileDescription",  "OpenImageIO"
+            VALUE "FileVersion",      VER_FILEVERSION_STR
+            VALUE "InternalName",     "OpenImageIO"
+            VALUE "ProductName",      "OpenImageIO"
+            VALUE "ProductVersion",   VER_PRODUCTVERSION_STR
+        END
+    END
+
+    BLOCK "VarFileInfo"
+    BEGIN
+        /* The following line should only be modified for localized versions.     */
+        /* It consists of any number of WORD,WORD pairs, with each pair           */
+        /* describing a language,codepage combination supported by the file.      */
+        /*                                                                        */
+        /* For example, a file might have values "0x409,1252" indicating that it  */
+        /* supports English language (0x409) in the Windows ANSI codepage (1252). */
+
+        VALUE "Translation", 0x409, 1252
+
+    END
+END

src/libOpenImageIO/CMakeLists.txt

@@ -78,8 +78,12 @@ set (libOpenImageIO_srcs
                           ${libOpenImageIO_hdrs}
                          )
 
-
-add_library (OpenImageIO ${libOpenImageIO_srcs})
+if (WIN32)
+    configure_file(../build-scripts/version_win32.rc.in "${CMAKE_CURRENT_BINARY_DIR}/version_win32.rc" @ONLY)
+    add_library (OpenImageIO ${libOpenImageIO_srcs} ${CMAKE_CURRENT_BINARY_DIR}/version_win32.rc)
+else ()
+    add_library (OpenImageIO ${libOpenImageIO_srcs})
+endif ()
 
 # If the 'EMBEDPLUGINS' option is set, we want to compile the source for
 # all the plugins into libOpenImageIO.
@@ -290,4 +294,9 @@ if (OIIO_BUILD_TESTS AND BUILD_TESTING)
                           FOLDER "Unit Tests" NO_INSTALL)
     add_test (unit_compute ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/compute_test)
 
+    if (WIN32)
+        set (version_string "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}.0")
+        add_test (NAME win32_versioning COMMAND powershell ${CMAKE_SOURCE_DIR}/testsuite/win32/version_check.ps1 "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/" ${version_string})
+    endif ()
+
 endif ()

src/libutil/CMakeLists.txt

@@ -36,7 +36,13 @@ function (setup_oiio_util_library targetname)
     else ()
         set (libtype STATIC)
     endif ()
-    add_library (${targetname} ${libtype} ${libOpenImageIO_Util_srcs})
+    
+    if (WIN32)
+        configure_file(../build-scripts/version_win32.rc.in "${CMAKE_CURRENT_BINARY_DIR}/version_win32.rc" @ONLY)
+        add_library (${targetname} ${libtype} ${libOpenImageIO_Util_srcs} ${CMAKE_CURRENT_BINARY_DIR}/version_win32.rc)
+    else ()
+        add_library (${targetname} ${libtype} ${libOpenImageIO_Util_srcs})
+    endif ()
 
     target_compile_definitions(${targetname} PRIVATE
                                ${${PROJECT_NAME}_compile_definitions})

testsuite/win32/version_check.ps1

@@ -0,0 +1,26 @@
+Write-Host "Arguments : $args"
+$bin_path = $args[0]
+$file_version = $args[1]
+$product_version = [String]::Join(".", $file_version.Split(".")[0..1])
+
+# Extract version information from the relevant binaries
+$oiio = Join-Path $bin_path "OpenImageIO.dll"
+$oiio_util = Join-Path $bin_path "OpenImageIO_Util.dll"
+$ver_oiio = (Get-ItemProperty $oiio).VersionInfo
+$ver_oiio_util = (Get-ItemProperty $oiio_util).VersionInfo
+
+# Stringify the version info for easy comparison
+$expected = "OpenImageIO|$file_version|$product_version"
+$actual_oiio = [String]::Join("|", $ver_oiio.FileDescription, $ver_oiio.FileVersion, $ver_oiio.ProductVersion)
+$actual_oiio_util = [String]::Join("|", $ver_oiio_util.FileDescription, $ver_oiio_util.FileVersion, $ver_oiio_util.ProductVersion)
+
+Write-Host "Expected : $expected"
+Write-Host "Actual   : $actual_oiio"
+Write-Host "         : $actual_oiio_util"
+
+# Return 0 back to the shell if everything matches successfully
+if (($actual_oiio -eq $expected) -and ($actual_oiio_util -eq $expected)) {
+    exit 0 # success
+}
+
+exit -1