Merge pull request #737 from Pulse-Eight/fix/windows-install-layout

windows: use the GNUInstallDirs layout so consumers need no patches

Author: opdenkamp

CLAUDE.md

@@ -55,7 +55,7 @@ python windows\create-installer.py -ni        # build libCEC + LibCecSharp, no i
 python windows\create-installer.py -vs         # generate Visual Studio project files for development
 ```
 
-Useful flags: `-a {x64,x86,arm,arm64}` (default x64), `-m {Release,Debug,RelWithDebInfo}` (default Release), `-t <toolchain>` (e.g. `2019c`, `2022`, `2026c`), `-nc` (no clean / incremental), `-ne` (skip EventGhost plugin), `-ni` (no installer). Build artifacts land in `build\<target>\<arch>\`. The orchestrator's structure is in `windows/toolchain.py` (toolchain/arch enums) and `windows/mixins.py` / `windows/pathbuilder.py` (helpers).
+Useful flags: `-a {x64,x86,arm,arm64}` (default x64), `-m {Release,Debug,RelWithDebInfo}` (default Release), `-t <toolchain>` (e.g. `2019c`, `2022`, `2026c`), `-nc` (no clean / incremental), `-ne` (skip EventGhost plugin), `-ni` (no installer). Build artifacts land in `build\<target>\<arch>\`, laid out per GNUInstallDirs like every other platform: `bin\` (cec.dll, cec-client.exe, cecc-client.exe, cec.pdb), `lib\` (the import library `cec.lib`, plus `cec-static.lib` and `cmake\libcec\`), `include\libcec\`. The NSIS scripts take their payload from those subdirectories; what the *installer* then lays down under `Program Files` is unchanged and still flat. Two things to keep in mind: the DLL's import library and the static library are both `cec.lib` by default, so the static target is renamed `cec-static` on Windows to stop it overwriting the import library in the build **and** install trees; and the Windows layout used to be flat (everything in the prefix root), which is what downstream consumers such as Kodi's `FindCEC.cmake` had to patch around — keep it GNUInstallDirs-conformant so they don't have to. The orchestrator's structure is in `windows/toolchain.py` (toolchain/arch enums) and `windows/mixins.py` / `windows/pathbuilder.py` (helpers).
 
 **Code signing** is Azure Artifact Signing (formerly Trusted Signing), driven by `windows/codesigner.py` and enabled by the presence of `AZURE_SIGNING_JSON` — the `/dmdf` metadata blob holding Endpoint, CodeSigningAccountName and CertificateProfileName. The dlib comes from the `Microsoft.ArtifactSigning.Client` NuGet package, found by globbing `C:\jenkins-deps\Microsoft.ArtifactSigning.Client*` (override with `AZURE_SIGNING_DLIB`), and it is native x64 so all signing goes through the x64 `signtool.exe`. Credentials are read from `AZURE_TENANT_ID`/`AZURE_CLIENT_ID`/`AZURE_CLIENT_SECRET` in the environment by the Azure SDK; nothing is stored in the repo. `create-installer.py` signs the payload before makensis packages it and the installer afterwards, and writes `support/private/sign-binary.cmd` (a gitignored path) that `project/libCEC.nsi` already looks for to sign the uninstaller. Without `AZURE_SIGNING_JSON` the build says so and produces unsigned output.
 

docs/README.windows.md

@@ -30,7 +30,7 @@ toolchain (`node-gyp`). Point it at libCEC's headers and import library with the
 ```
 cd src\nodejs
 set LIBCEC_INCLUDE_DIR=..\..\include
-set LIBCEC_LIB_DIR=..\..\build\Release\x64
+set LIBCEC_LIB_DIR=..\..\build\Release\x64\lib
 npm install
 ```
 `create-installer.py` does exactly this and stages the result (for x64 builds

project/nsis/libcec-pdb.nsh

@@ -3,7 +3,7 @@ Section "libCEC debug symbols" SecPDB
 	SectionIn 1
 
 	SetOutPath "$INSTDIR"
-	File "${BINARY_SOURCE_DIR}\cec.pdb"
+	File "${BINARY_SOURCE_DIR}\bin\cec.pdb"
 
 	SetOutPath "$INSTDIR\net8.0"
 	File /nonfatal "${BINARY_SOURCE_DIR}\net8.0\cec-tray.pdb"

project/nsis/nodejs.nsh

@@ -7,7 +7,7 @@ Section "libCEC for Node.js" SecNodeJs
 	; its own directory without the install dir being on PATH.
 	SetOutPath "$INSTDIR\nodejs\build\Release"
 	File "${BINARY_SOURCE_DIR}\nodejs\build\Release\cec_native.node"
-	File "${BINARY_SOURCE_DIR}\cec.dll"
+	File "${BINARY_SOURCE_DIR}\bin\cec.dll"
 
 	SetOutPath "$INSTDIR\nodejs\lib"
 	File "${BINARY_SOURCE_DIR}\nodejs\lib\*.js"

project/nsis/sections.nsh

@@ -51,7 +51,7 @@ Section "libCEC" SecLibCec
 	File "..\docs\README.windows.md"
 	File "..\support\windows\tv_on.cmd"
 	File "..\support\windows\tv_off.cmd"
-	File "${BINARY_SOURCE_DIR}\cec.dll"
+	File "${BINARY_SOURCE_DIR}\bin\cec.dll"
 	File "/oname=p8-logo.ico" "favicon.ico"
 
 	; Copy the headers
@@ -106,7 +106,7 @@ Section "libCEC for Python" SecPythonCec
 	; Copy binaries
 	SetOutPath "$INSTDIR\python\cec"
 
-	File "${BINARY_SOURCE_DIR}\cec.dll"
+	File "${BINARY_SOURCE_DIR}\bin\cec.dll"
 	File "${BINARY_SOURCE_DIR}\python\cec\_pycec.pyd"
 	File "${BINARY_SOURCE_DIR}\python\cec\cec.py"
 	!ifdef NSIS_X86
@@ -122,7 +122,7 @@ Section "libCEC for .Net" SecDotNetCore
 
 	; Copy binaries (pure C# LibCecSharp; no Ijwhost.dll / runtimeconfig for the library)
 	SetOutPath "$INSTDIR\net8.0"
-	File "${BINARY_SOURCE_DIR}\cec.dll"
+	File "${BINARY_SOURCE_DIR}\bin\cec.dll"
 	File "${BINARY_SOURCE_DIR}\net8.0\LibCecSharp.deps.json"
 	File "${BINARY_SOURCE_DIR}\net8.0\LibCecSharp.dll"
 	File "${BINARY_SOURCE_DIR}\net8.0\LibCecSharp.xml"
@@ -145,8 +145,8 @@ Section "libCEC client (cec-client)" SecCecClient
 
 	; Copy binaries
 	SetOutPath "$INSTDIR"
-	File "${BINARY_SOURCE_DIR}\cec-client.exe"
-	File "${BINARY_SOURCE_DIR}\cecc-client.exe"
+	File "${BINARY_SOURCE_DIR}\bin\cec-client.exe"
+	File "${BINARY_SOURCE_DIR}\bin\cecc-client.exe"
 
 	; Start menu item
 	!insertmacro MUI_STARTMENU_WRITE_BEGIN Application

src/cec-client/CMakeLists.txt

@@ -76,10 +76,7 @@ include_directories(${PROJECT_SOURCE_DIR}
 # write env.h
 CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/env.h.in ${CMAKE_CURRENT_SOURCE_DIR}/env.h)
 
-if (WIN32)
-  install(TARGETS     cec-client
-          DESTINATION .)
-else()
-  install(TARGETS     cec-client
-          DESTINATION ${CMAKE_INSTALL_BINDIR})
-endif()
+# bin/ on every platform: Windows used to drop executables in the prefix root,
+# which left the install tree half GNUInstallDirs and half flat
+install(TARGETS     cec-client
+        DESTINATION ${CMAKE_INSTALL_BINDIR})

src/cecc-client/CMakeLists.txt

@@ -45,10 +45,6 @@ include_directories(${PROJECT_SOURCE_DIR}
 # write env.h
 CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/env.h.in ${CMAKE_CURRENT_SOURCE_DIR}/env.h)
 
-if (WIN32)
-  install(TARGETS     cecc-client
-          DESTINATION .)
-else()
-  install(TARGETS     cecc-client
-          DESTINATION ${CMAKE_INSTALL_BINDIR})
-endif()
+# bin/ on every platform, as for cec-client
+install(TARGETS     cecc-client
+        DESTINATION ${CMAKE_INSTALL_BINDIR})

src/libcec/CMakeLists.txt

@@ -213,11 +213,21 @@ target_link_libraries(cec-shared ${cec_depends})
 
 
 if(NOT DISABLE_STATIC)
+  # Windows names the DLL's import library cec.lib too, so a static library
+  # called cec overwrites it - in the build tree and again on install, with
+  # whichever target links last winning. Anything then linking the install tree
+  # gets unresolved __imp_libcec_* symbols, or silently links libCEC statically.
+  # Unix has no such clash: libcec.a next to libcec.so.
+  set(CEC_STATIC_NAME cec)
+  if(WIN32)
+    set(CEC_STATIC_NAME cec-static)
+  endif()
+
   add_library(cec-static STATIC $<TARGET_OBJECTS:libobj>)
   set_target_properties(cec-static PROPERTIES
       VERSION   ${LIBCEC_VERSION_MAJOR}.${LIBCEC_VERSION_MINOR}.${LIBCEC_VERSION_PATCH}
       SOVERSION ${LIBCEC_VERSION_MAJOR}
-      OUTPUT_NAME cec)
+      OUTPUT_NAME ${CEC_STATIC_NAME})
   target_link_libraries(cec-static ${cec_depends})
 endif()
 
@@ -248,10 +258,13 @@ if(NOT DISABLE_STATIC)
   list(APPEND CEC_INSTALL_TARGETS cec-static)
 endif()
 
+# ARCHIVE is its own destination rather than LIB_DESTINATION: on Windows that is
+# bin/, which is where the .dll belongs but not the import library. Everywhere
+# else the two are the same value, so this only moves the Windows .lib.
 install(TARGETS ${CEC_INSTALL_TARGETS}
         EXPORT libcec
         RUNTIME DESTINATION ${LIB_DESTINATION}
-        ARCHIVE DESTINATION ${LIB_DESTINATION}
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
         LIBRARY DESTINATION ${LIB_DESTINATION})
 
 include(CMakePackageConfigHelpers)

src/libcec/cmake/CheckPlatformSupport.cmake

@@ -40,7 +40,11 @@ set(RPI_LIB_DIR          ""  CACHE FILEPATH "path to Raspberry Pi libs")
 if(WIN32)
   # Windows
   add_definitions(-DTARGET_WINDOWS -DNOMINMAX -D_CRT_SECURE_NO_WARNINGS -D_WINSOCKAPI_)
-  set(LIB_DESTINATION ".")
+  # cec.dll goes to bin/, matching the include/ and lib/cmake/libcec the rest of
+  # the install already uses. It used to land in the prefix root, which every
+  # consumer expecting the GNUInstallDirs layout had to patch around.
+  # GNUInstallDirs is included before this file, so this is "bin" by default.
+  set(LIB_DESTINATION "${CMAKE_INSTALL_BINDIR}")
 
   set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
 

src/nodejs/README.md

@@ -38,7 +38,7 @@ installed *USB-CEC Adapter* SDK). From a repo build:
 
 ```
 set LIBCEC_INCLUDE_DIR=..\..\include
-set LIBCEC_LIB_DIR=..\..\build\Release\x64
+set LIBCEC_LIB_DIR=..\..\build\Release\x64\lib
 npm install
 ```