Added cmake install command (ydb-platform#254)

Author: Gazizonoki

.github/actions/build/action.yaml

@@ -9,7 +9,7 @@ runs:
       run: |
         mkdir -p ../build
         rm -rf ../build/*
-        cmake --preset release
+        cmake -DYDB_SDK_TESTS=On -DYDB_SDK_EXAMPLES=On --preset release
     - name: Build
       shell: bash
       run: |

CMakeLists.txt

@@ -1,28 +1,82 @@
 cmake_minimum_required(VERSION 3.15)
 project(YDB-CPP-SDK LANGUAGES C CXX ASM)
 
+option(YDB_SDK_INSTALL "Install YDB C++ SDK" Off)
+option(YDB_SDK_TESTS "Build YDB C++ SDK tests" Off)
+option(YDB_SDK_EXAMPLES "Build YDB C++ SDK examples" On)
+set(YDB_SDK_GOOGLE_COMMON_PROTOS_TARGET "" CACHE STRING "Name of cmake target preparing google common proto library")
+option(YDB_SDK_USE_RAPID_JSON "Search for rapid json library in system" ON)
+
 set(BUILD_SHARED_LIBS Off)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED On)
 set(CMAKE_CXX_EXTENSIONS On)
 
 set(YDB_SDK_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(YDB_SDK_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(YDB-CPP-SDK_AVAILABLE_COMPONENTS "" CACHE INTERNAL "")
+set(YDB-CPP-SDK_COMPONENT_TARGETS "" CACHE INTERNAL "")
 
-list(APPEND CMAKE_MODULE_PATH ${YDB_SDK_BINARY_DIR} ${YDB_SDK_SOURCE_DIR}/cmake)
+list(APPEND CMAKE_MODULE_PATH ${YDB_SDK_SOURCE_DIR}/cmake)
 include_directories(${YDB_SDK_SOURCE_DIR} ${YDB_SDK_SOURCE_DIR}/include ${YDB_SDK_BINARY_DIR})
-enable_testing()
 
+if (YDB_SDK_INSTALL)
+  include(GNUInstallDirs)
+  include(CMakePackageConfigHelpers)
+endif()
+
+include(cmake/global_flags.cmake)
+include(cmake/global_vars.cmake)
+include(cmake/install.cmake)
 include(cmake/common.cmake)
 include(cmake/ccache.cmake)
-include(cmake/global_flags.cmake)
 include(cmake/protobuf.cmake)
-include(cmake/global_vars.cmake)
-include(cmake/external_libs.cmake)
 include(cmake/testing.cmake)
+include(cmake/external_libs.cmake)
 
 add_subdirectory(tools)
 add_subdirectory(contrib)
 add_subdirectory(src)
-add_subdirectory(examples)
-add_subdirectory(tests)
+
+if (YDB_SDK_EXAMPLES)
+  add_subdirectory(examples)
+endif()
+
+if (YDB_SDK_TESTS)
+  enable_testing()
+  add_subdirectory(tests)
+endif()
+
+if (${YDB_SDK_INSTALL})
+  _ydb_sdk_directory_install(DIRECTORY ${YDB_SDK_SOURCE_DIR}/include/ydb-cpp-sdk
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  )
+  _ydb_sdk_directory_install(DIRECTORY ${YDB_SDK_BINARY_DIR}/ydb-cpp-sdk
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    PATTERN "*.h"
+  )
+  install(EXPORT ydb-cpp-sdk-targets
+    FILE ydb-cpp-sdk-targets.cmake
+    CONFIGURATIONS RELEASE
+    NAMESPACE YDB-CPP-SDK::
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ydb-cpp-sdk/release
+  )
+  configure_package_config_file(
+    ${YDB_SDK_SOURCE_DIR}/cmake/ydb-cpp-sdk-config.cmake.in
+    ${CMAKE_CURRENT_BINARY_DIR}/ydb-cpp-sdk-config.cmake
+    INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ydb-cpp-sdk
+  )
+  _ydb_sdk_directory_install(FILES
+    ${CMAKE_CURRENT_BINARY_DIR}/ydb-cpp-sdk-config.cmake
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ydb-cpp-sdk
+  )
+  _ydb_sdk_directory_install(FILES
+    ${YDB_SDK_SOURCE_DIR}/cmake/FindBrotli.cmake
+    ${YDB_SDK_SOURCE_DIR}/cmake/FindgRPC.cmake
+    ${YDB_SDK_SOURCE_DIR}/cmake/FindIDN.cmake
+    ${YDB_SDK_SOURCE_DIR}/cmake/FindLZ4.cmake
+    ${YDB_SDK_SOURCE_DIR}/cmake/FindxxHash.cmake
+    ${YDB_SDK_SOURCE_DIR}/cmake/FindZSTD.cmake
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ydb-cpp-sdk/Modules
+  )
+endif()

cmake/common.cmake

@@ -114,28 +114,15 @@ function(generate_enum_serilization Tgt Input)
   target_sources(${Tgt} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${BaseName}_serialized.cpp)
 endfunction()
 
-
-if (MSVC AND (${CMAKE_VERSION} VERSION_LESS "3.21.0"))
-    message(FATAL_ERROR "Build with MSVC-compatible toolchain requires at least cmake 3.21.0 because of used TARGET_OBJECTS feature")
-endif()
-
 function(add_global_library_for TgtName MainName)
-  if (MSVC)
-    add_library(${TgtName} OBJECT ${ARGN})
-    add_dependencies(${TgtName} ${MainName}) # needed because object library can use some extra generated files in MainName
-    target_link_libraries(${MainName} INTERFACE ${TgtName} "$<TARGET_OBJECTS:${TgtName}>")
+  add_library(${TgtName} STATIC ${ARGN})
+  if(APPLE)
+    target_link_options(${MainName} INTERFACE "SHELL:-Wl,-force_load,$<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}>")
   else()
-    add_library(${TgtName} STATIC ${ARGN})
-    add_library(${TgtName}.wholearchive INTERFACE)
-    add_dependencies(${TgtName}.wholearchive ${TgtName})
-    add_dependencies(${TgtName} ${MainName})
-    if(APPLE)
-      target_link_options(${TgtName}.wholearchive INTERFACE "SHELL:-Wl,-force_load,$<TARGET_FILE:${TgtName}>")
-    else()
-      target_link_options(${TgtName}.wholearchive INTERFACE "SHELL:-Wl,--whole-archive $<TARGET_FILE:${TgtName}> -Wl,--no-whole-archive")
-    endif()
-    target_link_libraries(${MainName} INTERFACE ${TgtName}.wholearchive)
+    target_link_options(${MainName} INTERFACE "SHELL:-Wl,--whole-archive $<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}> -Wl,--no-whole-archive")
   endif()
+  add_dependencies(${MainName} ${TgtName})
+  target_link_libraries(${MainName} INTERFACE ${TgtName})
 endfunction()
 
 function(vcs_info Tgt)
@@ -184,3 +171,11 @@ function(resources Tgt Output)
     DEPENDS ${RESOURCE_ARGS_INPUTS} ${rescompiler_bin}
   )
 endfunction()
+
+function(_ydb_sdk_make_client_component CmpName Tgt)
+  add_library(YDB-CPP-SDK::${CmpName} ALIAS ${Tgt})
+
+  _ydb_sdk_install_targets(TARGETS ${Tgt} ${ARGN})
+  set(YDB-CPP-SDK_AVAILABLE_COMPONENTS ${YDB-CPP-SDK_AVAILABLE_COMPONENTS} ${CmpName} CACHE INTERNAL "")
+  set(YDB-CPP-SDK_COMPONENT_TARGETS ${YDB-CPP-SDK_COMPONENT_TARGETS} ${Tgt} CACHE INTERNAL "")
+endfunction()

cmake/external_libs.cmake

@@ -1,7 +1,3 @@
-set(YDB_SDK_GOOGLE_COMMON_PROTOS_TARGET "" CACHE STRING "Name of cmake target preparing google common proto library")
-option(YDB_SDK_USE_RAPID_JSON "" ON)
-option(YDB_SDK_GRPC_CONFIG_SEARCH "" OFF)
-
 find_package(IDN REQUIRED)
 find_package(Iconv REQUIRED)
 find_package(OpenSSL REQUIRED)
@@ -28,68 +24,50 @@ if (YDB_SDK_USE_RAPID_JSON)
   target_include_directories(RapidJSON::RapidJSON INTERFACE
     ${RAPIDJSON_INCLUDE_DIRS}
   )
-endif ()
+endif()
 
 # api-common-protos
 if (YDB_SDK_GOOGLE_COMMON_PROTOS_TARGET)
   add_library(api-common-protos ALIAS ${YDB_SDK_GOOGLE_COMMON_PROTOS_TARGET})
-else ()
-  add_library(api-common-protos)
-
-  set_property(TARGET api-common-protos PROPERTY
-    PROTOC_EXTRA_OUTS .grpc.pb.cc .grpc.pb.h
+else()
+  file(GLOB_RECURSE API_COMMON_PROTOS_SOURCES
+    ${YDB_SDK_SOURCE_DIR}/third_party/api-common-protos/google/*.proto
   )
 
+  _ydb_sdk_init_proto_library_impl(api-common-protos Off)
+
   set_property(TARGET api-common-protos PROPERTY
     PROTO_NAMESPACE third_party/api-common-protos
   )
 
-  target_include_directories(api-common-protos PUBLIC
-    ${YDB_SDK_BINARY_DIR}/third_party/api-common-protos
-  )
-
-  target_link_libraries(api-common-protos PUBLIC
-    gRPC::grpc++
-    protobuf::libprotobuf
-  )
-
-  file(GLOB_RECURSE SOURCES
-    ${YDB_SDK_SOURCE_DIR}/third_party/api-common-protos/google/*.proto
-  )
-
-  target_proto_messages(api-common-protos PRIVATE
-    ${SOURCES}
+  set_property(TARGET api-common-protos APPEND PROPERTY 
+    PROTO_ADDINCL 
+      ./third_party/api-common-protos
+      ${YDB_SDK_SOURCE_DIR}
   )
 
-  target_proto_addincls(api-common-protos
-    ./third_party/api-common-protos
-    ${YDB_SDK_BINARY_DIR}
-    ${YDB_SDK_SOURCE_DIR}
-    ${YDB_SDK_SOURCE_DIR}/third_party/api-common-protos
+  target_include_directories(api-common-protos PUBLIC
+    $<BUILD_INTERFACE:${YDB_SDK_BINARY_DIR}/third_party/api-common-protos>
   )
 
-  target_proto_outs(api-common-protos
-    --cpp_out=${YDB_SDK_BINARY_DIR}/third_party/api-common-protos
-  )
+  _ydb_sdk_gen_proto_messages(api-common-protos PRIVATE Off ${API_COMMON_PROTOS_SOURCES})
 
-  target_proto_plugin(api-common-protos
-    grpc_cpp
-    gRPC::grpc_cpp_plugin
-  )
-endif ()
+  _ydb_sdk_install_targets(TARGETS api-common-protos)
+endif()
 
 # FastLZ
 add_library(FastLZ 
-    ${YDB_SDK_SOURCE_DIR}/third_party/FastLZ/fastlz.c
+  ${YDB_SDK_SOURCE_DIR}/third_party/FastLZ/fastlz.c
+)
+
+target_include_directories(FastLZ PUBLIC
+  $<BUILD_INTERFACE:${YDB_SDK_SOURCE_DIR}/third_party/FastLZ>
 )
 
-target_include_directories(FastLZ PUBLIC ${YDB_SDK_SOURCE_DIR}/third_party/FastLZ)
+_ydb_sdk_install_targets(TARGETS FastLZ)
 
 # nayuki_md5
 add_library(nayuki_md5)
-target_link_libraries(nayuki_md5 PUBLIC
-  yutil
-)
 
 if (CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
 target_sources(nayuki_md5 PRIVATE 
@@ -101,5 +79,9 @@ target_sources(nayuki_md5 PRIVATE
 )
 endif()
 
-target_include_directories(nayuki_md5 PUBLIC ${YDB_SDK_SOURCE_DIR}/third_party/nayuki_md5)
- 
+target_include_directories(nayuki_md5 PUBLIC
+  $<BUILD_INTERFACE:${YDB_SDK_SOURCE_DIR}/third_party/nayuki_md5>
+  $<INSTALL_INTERFACE:third_party/nayuki_md5>
+)
+
+_ydb_sdk_install_targets(TARGETS nayuki_md5)

cmake/install.cmake

@@ -0,0 +1,56 @@
+function(_ydb_sdk_install_targets)
+  if (NOT YDB_SDK_INSTALL)
+    return()
+  endif()
+  set(multiValueArgs TARGETS)
+  cmake_parse_arguments(
+    ARG "${option}" "${oneValueArgs}" "${multiValueArgs}" "${ARGN}"
+  )
+  if (NOT ARG_TARGETS)
+    message(FATAL_ERROR "No TARGETS given for install")
+    return()
+  endif()
+  foreach (ITEM_TARGET IN LISTS ARG_TARGETS)
+    if(NOT TARGET ${ITEM_TARGET})
+      message(FATAL_ERROR "${ITEM_TARGET} is not target. You should use only targets")
+      return()
+    endif()
+  endforeach()
+  install(TARGETS ${ARG_TARGETS}
+    EXPORT ydb-cpp-sdk-targets
+    CONFIGURATIONS RELEASE
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  )
+endfunction()
+
+function(_ydb_sdk_directory_install)
+  if (NOT ${YDB_SDK_INSTALL})
+    return()
+  endif()
+  set(oneValueArgs DESTINATION PATTERN)
+  set(multiValueArgs FILES DIRECTORY)
+  cmake_parse_arguments(
+    ARG "${option}" "${oneValueArgs}" "${multiValueArgs}" "${ARGN}"
+  )
+  if (NOT ARG_DESTINATION)
+    message(FATAL_ERROR "No DESTINATION for install")
+  endif()
+  if (NOT ARG_FILES AND NOT ARG_DIRECTORY)
+    message(FATAL_ERROR "No FILES or DIRECTORY provided to install")
+  endif()
+  if (ARG_FILES AND ARG_DIRECTORY)
+    message(FATAL_ERROR "FILES and DIRECTORY are mutually exclusive install arguments")
+  endif()
+  if (ARG_FILES)
+    install(FILES ${ARG_FILES} DESTINATION ${ARG_DESTINATION})
+  else()
+    if (DEFINED ARG_PATTERN)
+      install(DIRECTORY ${ARG_DIRECTORY} DESTINATION ${ARG_DESTINATION} USE_SOURCE_PERMISSIONS FILES_MATCHING PATTERN ${ARG_PATTERN})
+    else()
+      install(DIRECTORY ${ARG_DIRECTORY} DESTINATION ${ARG_DESTINATION} USE_SOURCE_PERMISSIONS)
+    endif()
+  endif()
+endfunction()