Rename project to microsoft-signalr and add find_package cmake support (#52)

Author: BrennanConroy

CMakeLists.txt

@@ -4,7 +4,7 @@ if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
   set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
 endif()
 
-project (signalrclient)
+project (microsoft-signalr)
 
 include(CTest)
 

README.md

@@ -110,11 +110,8 @@ stop_task.get_future().get();
 cmake_minimum_required (VERSION 3.5)
 project (signalrclient-sample)
 
-find_path(SIGNALR_INCLUDE_DIR signalrclient/hub_connection.h)
-include_directories(${SIGNALR_INCLUDE_DIR})
-
-find_library(SIGNALR_LIBRARY NAMES signalrclient PATHS {SIGNALR_INCLUDE_DIR} REQUIRED)
-link_libraries(${SIGNALR_LIBRARY})
+find_package(microsoft-signalr REQUIRED)
+link_libraries(microsoft-signalr::microsoft-signalr)
 
 add_executable (sample sample.cpp)
 ```

samples/HubConnectionSample/CMakeLists.txt

@@ -7,4 +7,4 @@ include_directories(
 
 add_executable (HubConnectionSample ${SOURCES})
 
-target_link_libraries(HubConnectionSample signalrclient)
+target_link_libraries(HubConnectionSample microsoft-signalr)

src/signalrclient/CMakeLists.txt

@@ -28,16 +28,16 @@ include_directories(
   ../../third_party_code/cpprestsdk
 )
 
-add_library (signalrclient ${SOURCES})
+add_library (microsoft-signalr ${SOURCES})
 
 if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
     if(WERROR)
-        target_compile_options(signalrclient PRIVATE /WX)
+        target_compile_options(microsoft-signalr PRIVATE /WX)
     endif()
     if(WALL)
-        target_compile_options(signalrclient PRIVATE /Wall)
+        target_compile_options(microsoft-signalr PRIVATE /Wall)
     endif()
-    target_compile_options(signalrclient PRIVATE
+    target_compile_options(microsoft-signalr PRIVATE
         /wd4820 # padding added after data member
         /wd4514 # unreferenced inline function removed
         /wd5045 # compiler will insert Spectre mitigation if /Qspectre switch is added
@@ -51,46 +51,62 @@ if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
     )
 else()
     if(WERROR)
-        target_compile_options(signalrclient PRIVATE -Werror)
+        target_compile_options(microsoft-signalr PRIVATE -Werror)
     endif()
     if(WALL)
-        target_compile_options(signalrclient PRIVATE -Wall)
+        target_compile_options(microsoft-signalr PRIVATE -Wall)
     endif()
 
-    target_compile_options(signalrclient PRIVATE -Wextra -Wpedantic -Wno-unknown-pragmas)
+    target_compile_options(microsoft-signalr PRIVATE -Wextra -Wpedantic -Wno-unknown-pragmas)
 endif()
 
 if(INCLUDE_JSONCPP)
-  target_sources(signalrclient PRIVATE ../../third_party_code/jsoncpp/jsoncpp.cpp)
-  target_include_directories(signalrclient PRIVATE ../../third_party_code/jsoncpp)
+  target_sources(microsoft-signalr PRIVATE ../../third_party_code/jsoncpp/jsoncpp.cpp)
+  target_include_directories(microsoft-signalr PRIVATE ../../third_party_code/jsoncpp)
 else()
-  target_link_libraries(signalrclient PUBLIC ${JSONCPP_LIB})
+  target_link_libraries(microsoft-signalr PUBLIC ${JSONCPP_LIB})
 endif()
 
 if(NOT USE_CPPRESTSDK)
-  target_link_libraries(signalrclient)
+  target_link_libraries(microsoft-signalr)
 else()
   if(APPLE)
-    target_link_libraries(signalrclient
+    target_link_libraries(microsoft-signalr
       PUBLIC ${CPPREST_LIB}
       PRIVATE OpenSSL::SSL Boost::boost Boost::system Boost::chrono Boost::thread
     )
   elseif(NOT WIN32)
-    target_link_libraries(signalrclient
+    target_link_libraries(microsoft-signalr
       PUBLIC ${CPPREST_LIB} Boost::system
       PRIVATE OpenSSL::SSL
     )
   else()
-    target_link_libraries(signalrclient
+    target_link_libraries(microsoft-signalr
       PUBLIC ${CPPREST_LIB}
     )
   endif()
 endif() # USE_CPPRESTSDK
 
 include(GNUInstallDirs)
 
-install(TARGETS signalrclient
+install(TARGETS microsoft-signalr
+  # Creates the microsoft-signalr-targets.cmake file which allows find_package() to work
+  EXPORT microsoft-signalr-targets
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
   LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
   ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+)
+
+# Create the microsoft-signalr-config.cmake with resolved values for variables used to build
+configure_file(microsoft-signalr-config.in.cmake "${CMAKE_CURRENT_BINARY_DIR}/microsoft-signalr-config.cmake" @ONLY)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/microsoft-signalr-config.cmake
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/share/microsoft-signalr
+)
+
+install(EXPORT microsoft-signalr-targets
+  FILE microsoft-signalr-targets.cmake
+  NAMESPACE microsoft-signalr::
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/share/microsoft-signalr
 )

src/signalrclient/microsoft-signalr-config.in.cmake

@@ -0,0 +1,11 @@
+include(CMakeFindDependencyMacro)
+
+if(@USE_CPPRESTSDK@)
+  find_dependency(cpprestsdk)
+endif()
+
+if(NOT @INCLUDE_JSONCPP@)
+  find_dependency(@JSONCPP_LIB@)
+endif()
+
+include("${CMAKE_CURRENT_LIST_DIR}/microsoft-signalr-targets.cmake")

test/signalrclienttests/CMakeLists.txt

@@ -25,5 +25,5 @@ include_directories(
 
 add_executable (signalrclienttests ${SOURCES})
 
-target_link_libraries(signalrclienttests gtest signalrclient)
+target_link_libraries(signalrclienttests gtest microsoft-signalr)
 add_test(NAME signalrclienttests COMMAND signalrclienttests)