Remove examples from primary build because they were relying on in-tree artifacts and thus were masking installation issues

Author: cboulay

.github/workflows/cppcmake.yml

@@ -62,7 +62,6 @@ jobs:
                 -DCMAKE_INSTALL_PREFIX=${PWD}/install \
                 -DLSL_UNITTESTS=ON \
                 -DLSL_BENCHMARKS=ON \
-                -DLSL_BUILD_EXAMPLES=ON \
                 -DCPACK_PACKAGE_DIRECTORY=${PWD}/package \
                 -Dlslgitrevision=${{ github.sha }} \
                 -Dlslgitbranch=${{ github.ref }} \
@@ -71,6 +70,13 @@ jobs:
             echo ${PWD}
     - name: make
       run: cmake --build build --target install --config Release -j
+
+    - name: test install using examples
+      run: |
+          # Test that the in-tree install was successful by building the examples
+          cmake -S examples -B examples/build -DLSL_INSTALL_ROOT=${PWD}/install -DCMAKE_INSTALL_PREFIX=examples/build/install -DLSL_COMFY_DEFAULTS=ON
+          cmake --build examples/build --target install --config Release -j
+          ./examples/build/install/bin/HandleMetaData
   
     - name: package
       run: |

.gitignore

@@ -13,3 +13,4 @@
 # CLion
 .idea/
 /cmake-build-*/
+/examples/build*/

CMakeLists.txt

@@ -23,11 +23,6 @@ if(LSL_UNITTESTS)
 	add_subdirectory(testing)
 endif()
 
-if(LSL_BUILD_EXAMPLES)
-    set(LSL_INSTALL_ROOT ${CMAKE_CURRENT_BINARY_DIR})
-	add_subdirectory(examples)
-endif()
-
 # Config for packaging
 # TODO: Config for packaging for the library itself is likely to diverge from config for packing applications. e.g.,
 # -> Optionally install to system directories

examples/CMakeLists.txt

@@ -1,15 +1,21 @@
-cmake_minimum_required(VERSION 3.12)
+cmake_minimum_required(VERSION 3.23)
 project(lslexamples
 	LANGUAGES C CXX
 	VERSION 0.2.0)
 find_package(LSL REQUIRED
-	HINTS ${LSL_INSTALL_ROOT}
-	"${CMAKE_CURRENT_LIST_DIR}/../build"
-	"${CMAKE_CURRENT_LIST_DIR}/../out/x64-Release"
-	PATH_SUFFIXES share/LSL)
+	HINTS
+        ${LSL_INSTALL_ROOT}
+        "${CMAKE_CURRENT_LIST_DIR}/../install"  # GHA scripts default install directory
+        "${CMAKE_CURRENT_LIST_DIR}/../cmake-build-release/install"  # CLion default if using -DCMAKE_INSTALL_PREFIX=install
+        "${CMAKE_CURRENT_LIST_DIR}/../out/x64-Release/install"  # MSVC default if using -DCMAKE_INSTALL_PREFIX=install  TODO: Check this
+	PATH_SUFFIXES share/LSL
+)
 get_filename_component(LSL_PATH ${LSL_CONFIG} DIRECTORY)
 message(STATUS "Found LSL lib in ${LSL_PATH}")
-message(STATUS "LSL BIN DIR: ${liblsl_BINARY_DIR} & ${LIBLSL_BINARY_DIR}")
+
+# Include the LSLCMake.cmake file, just for testing.
+# This doesn't do much for us now that we don't use installLSLApp() anymore.
+include("${LSL_PATH}/LSLCMake.cmake")
 
 # convenience function to add an example file
 # this creates a target, links the necessary libraries and
@@ -20,7 +26,39 @@ function(addlslexample name extension)
 	)
 	target_link_libraries(${name} PRIVATE LSL::lsl)
 	target_compile_features(${name} PRIVATE cxx_constexpr)
-	installLSLApp(${name})
+
+    # Set RPATH properties for macOS and Linux
+    set_target_properties(${name} PROPERTIES
+            INSTALL_RPATH_USE_LINK_PATH TRUE
+            BUILD_WITH_INSTALL_RPATH FALSE
+    )
+
+    # One might also want to do the following, to give the option of copying the
+    #  LSL library to the same directory or install tree as the executable.
+    # However, this is not necessary for the examples, as they are not intended to be relocated.
+#    if(APPLE)
+#        set_target_properties(${name} PROPERTIES
+#                INSTALL_RPATH "@loader_path;@loader_path/../lib"
+#        )
+#    elseif(UNIX)
+#        set_target_properties(${name} PROPERTIES
+#                INSTALL_RPATH "$ORIGIN:$ORIGIN/../lib"
+#        )
+#    endif()
+
+    install(TARGETS ${name}
+        COMPONENT ${PROJECT_NAME}
+        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    )
+    if(WIN32)
+        # On Windows, we need to copy the DLLs to the same directory as the executable
+        #  if we wish to run the example without putting the DLLs in the PATH.
+        install(
+            FILES $<TARGET_FILE:LSL::lsl>
+            DESTINATION ${CMAKE_INSTALL_BINDIR}
+            COMPONENT ${PROJECT_NAME}
+        )
+    endif(WIN32)
 endfunction()
 
 find_package(Threads)
@@ -46,4 +84,3 @@ addlslexample(SendStringMarkersC c)
 addlslexample(TestSyncWithoutData cpp)
 
 target_link_libraries(TestSyncWithoutData PRIVATE Threads::Threads)
-

examples/HandleMetaData.cpp

@@ -43,7 +43,7 @@ int main(int argc, char *argv[]) {
 		}
 
 	} catch (std::exception &e) { std::cerr << "Got an exception: " << e.what() << std::endl; }
-	std::cout << "Press any key to exit. " << std::endl;
-	std::cin.get();
+	// std::cout << "Press any key to exit. " << std::endl;
+	// std::cin.get();
 	return 0;
 }