make package name matches namespace name (#307)

Co-authored-by: SidneyCogdill <no@localhost>

Author: SidneyCogdill

CMakeLists.txt

@@ -1,9 +1,9 @@
 cmake_minimum_required(VERSION 3.28)
 
-project(msft_proxy4 VERSION 3.3.0 LANGUAGES CXX)
+project(msft_proxy4 VERSION 4.0.0 LANGUAGES CXX)
 add_library(msft_proxy4 INTERFACE)
-set_target_properties(msft_proxy4 PROPERTIES EXPORT_NAME proxy4)
-add_library(msft_proxy::proxy4 ALIAS msft_proxy4)
+set_target_properties(msft_proxy4 PROPERTIES EXPORT_NAME proxy)
+add_library(msft_proxy4::proxy ALIAS msft_proxy4)
 
 # Do not enable building tests if proxy is consumed as
 # subdirectory (e.g. by CMake FetchContent_Declare).
@@ -42,53 +42,53 @@ target_include_directories(msft_proxy4 INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRE
 
 # Do not set the module target if proxy is consumed as a subdirectory.
 if(PROJECT_IS_TOP_LEVEL)
-  set(proxy4_INCLUDE_DIR include)
+  set(msft_proxy4_INCLUDE_DIR include)
   if(PROXY_BUILD_MODULES)
-    include(cmake/proxy4ModuleTargets.cmake)
+    include(cmake/msft_proxy4ModuleTargets.cmake)
   endif()
 else()
   # Propagate the variable to the parent project
-  set(proxy4_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include PARENT_SCOPE)
+  set(msft_proxy4_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include PARENT_SCOPE)
 endif()
 
 # install and export the project. project name - proxy
 
 include(GNUInstallDirs)
 
 install(TARGETS msft_proxy4
-        EXPORT proxy4Targets
+        EXPORT msft_proxy4Targets
         FILE_SET public_headers DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
 )
 
 install(
-  EXPORT proxy4Targets
-  NAMESPACE msft_proxy::
-  DESTINATION ${CMAKE_INSTALL_DATADIR}/proxy
+  EXPORT msft_proxy4Targets
+  NAMESPACE msft_proxy4::
+  DESTINATION ${CMAKE_INSTALL_DATADIR}/msft_proxy4
 )
 export(
   TARGETS msft_proxy4
-  NAMESPACE msft_proxy::
-  FILE proxy4Targets.cmake
+  NAMESPACE msft_proxy4::
+  FILE msft_proxy4Targets.cmake
 )
 
 include(CMakePackageConfigHelpers)
 configure_package_config_file(
-  cmake/proxy4Config.cmake.in
-  ${CMAKE_CURRENT_BINARY_DIR}/cmake/proxy4Config.cmake
-  INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/proxy
+  cmake/msft_proxy4Config.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/msft_proxy4Config.cmake
+  INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/msft_proxy4
   PATH_VARS CMAKE_INSTALL_INCLUDEDIR
 )
 
 include(CMakePackageConfigHelpers)
-write_basic_package_version_file(cmake/proxy4ConfigVersion.cmake
+write_basic_package_version_file(cmake/msft_proxy4ConfigVersion.cmake
                                  COMPATIBILITY SameMajorVersion
                                  ARCH_INDEPENDENT)
 
 install(
   FILES 
-    ${CMAKE_CURRENT_BINARY_DIR}/cmake/proxy4Config.cmake
-    ${CMAKE_CURRENT_BINARY_DIR}/cmake/proxy4ConfigVersion.cmake
-  DESTINATION ${CMAKE_INSTALL_DATADIR}/proxy
+    ${CMAKE_CURRENT_BINARY_DIR}/cmake/msft_proxy4Config.cmake
+    ${CMAKE_CURRENT_BINARY_DIR}/cmake/msft_proxy4ConfigVersion.cmake
+  DESTINATION ${CMAKE_INSTALL_DATADIR}/msft_proxy4
 )
 
 # build tests if BUILD_TESTING is ON

README.md

@@ -35,12 +35,12 @@ Please refer to the [Proxy's Frequently Asked Questions](https://microsoft.githu
 
     ```cmake
     CPMAddPackage(
-      NAME proxy4
+      NAME msft_proxy4
       GIT_TAG 4.0.0 # or above
       GIT_REPOSITORY https://github.com/microsoft/proxy.git
     )
 
-    target_link_libraries(main PRIVATE msft_proxy::proxy4)
+    target_link_libraries(main PRIVATE msft_proxy4::proxy)
     ```
 
 ### Hello World

benchmarks/CMakeLists.txt

@@ -22,7 +22,7 @@ add_executable(msft_proxy_benchmarks
   proxy_management_benchmark.cpp
 )
 target_include_directories(msft_proxy_benchmarks PRIVATE .)
-target_link_libraries(msft_proxy_benchmarks PRIVATE msft_proxy::proxy4 benchmark::benchmark benchmark::benchmark_main)
+target_link_libraries(msft_proxy_benchmarks PRIVATE msft_proxy4::proxy benchmark::benchmark benchmark::benchmark_main)
 
 if (MSVC)
   target_compile_options(msft_proxy_benchmarks PRIVATE /W4)

cmake/msft_proxy4Config.cmake.in

@@ -0,0 +1,5 @@
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/msft_proxy4Targets.cmake")
+
+set(msft_proxy4_INCLUDE_DIR "@PACKAGE_CMAKE_INSTALL_INCLUDEDIR@")

cmake/msft_proxy4ModuleTargets.cmake

@@ -0,0 +1,23 @@
+if(NOT DEFINED msft_proxy4_INCLUDE_DIR)
+    message(FATAL_ERROR "`msft_proxy4_INCLUDE_DIR` must be defined to use this script.")
+endif()
+
+message(STATUS "Declaring `msft_proxy4::proxy_module` target for include path `${msft_proxy4_INCLUDE_DIR}`")
+
+add_library(msft_proxy4_module)
+set_target_properties(
+  msft_proxy4_module
+  PROPERTIES
+    SYSTEM TRUE
+    EXCLUDE_FROM_ALL TRUE
+)
+
+add_library(msft_proxy4::proxy_module ALIAS msft_proxy4_module)
+target_sources(msft_proxy4_module PUBLIC
+  FILE_SET CXX_MODULES
+  BASE_DIRS ${msft_proxy4_INCLUDE_DIR}
+  FILES
+    ${msft_proxy4_INCLUDE_DIR}/proxy/v4/proxy.ixx
+)
+target_compile_features(msft_proxy4_module PUBLIC cxx_std_20)
+target_link_libraries(msft_proxy4_module PUBLIC msft_proxy4::proxy)

cmake/proxy4Config.cmake.in

@@ -17,7 +17,7 @@ set_source_files_properties(${EXAMPLE_SOURCES} PROPERTIES GENERATED TRUE)
 foreach(SOURCE ${EXAMPLE_SOURCES})
   get_filename_component(EXECUTABLE_NAME ${SOURCE} NAME_WE)
   add_executable(${EXECUTABLE_NAME} ${SOURCE})
-  target_link_libraries(${EXECUTABLE_NAME} PRIVATE msft_proxy::proxy4)
+  target_link_libraries(${EXECUTABLE_NAME} PRIVATE msft_proxy4::proxy)
   if (MSVC)
     target_compile_options(${EXECUTABLE_NAME} PRIVATE /W4)
   elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")

cmake/proxy4ModuleTargets.cmake

@@ -5,16 +5,16 @@ The "Proxy" library ships with `.ixx` files starting with version **4.0.0**. Com
 As of 2025-05-11, CMake lacks support for forward compatibility when consuming C++ modules, which causes consumers with newer C++ standard to be unable to use modules with older standard. Until this is implemented by CMake, a CMake target containing the module can be manually declared using the following CMake script:
 
 ```cmake
-find_package(proxy4 REQUIRED)
+find_package(msft_proxy4 REQUIRED)
 
-if(NOT DEFINED proxy4_INCLUDE_DIR) # (1)
-  if(NOT DEFINED proxy_SOURCE_DIR)
-    message(FATAL_ERROR "proxy4_INCLUDE_DIR or proxy_SOURCE_DIR must be defined to use this script.")
+if(NOT DEFINED msft_proxy4_INCLUDE_DIR) # (1)
+  if(NOT DEFINED msft_proxy4_SOURCE_DIR)
+    message(FATAL_ERROR "`msft_proxy4_INCLUDE_DIR` or `msft_proxy4_SOURCE_DIR` must be defined to use this script.")
   endif()
-  set(proxy4_INCLUDE_DIR ${proxy_SOURCE_DIR}/include)
+  set(msft_proxy4_INCLUDE_DIR ${msft_proxy4_SOURCE_DIR}/include)
 endif()
 
-message(STATUS "Declaring `msft_proxy::proxy4_module` target for include path ${proxy4_INCLUDE_DIR}")
+message(STATUS "Declaring `msft_proxy4::proxy_module` target for include path `${msft_proxy4_INCLUDE_DIR}`")
 
 add_library(msft_proxy4_module)
 set_target_properties(
@@ -24,24 +24,24 @@ set_target_properties(
     EXCLUDE_FROM_ALL TRUE
 )
 
-add_library(msft_proxy::proxy4_module ALIAS msft_proxy4_module)
+add_library(msft_proxy4::proxy_module ALIAS msft_proxy4_module)
 target_sources(msft_proxy4_module PUBLIC
   FILE_SET CXX_MODULES
-  BASE_DIRS ${proxy4_INCLUDE_DIR}
+  BASE_DIRS ${msft_proxy4_INCLUDE_DIR}
   FILES
-    ${proxy4_INCLUDE_DIR}/proxy/v4/proxy.ixx
+    ${msft_proxy4_INCLUDE_DIR}/proxy/v4/proxy.ixx
 )
 target_compile_features(msft_proxy4_module PUBLIC cxx_std_20) # (2)
-target_link_libraries(msft_proxy4_module PUBLIC msft_proxy::proxy4)
+target_link_libraries(msft_proxy4_module PUBLIC msft_proxy4::proxy)
 ```
 
-- (1) `proxy4_INCLUDE_DIR` is automatically declared after `find_package(proxy4)`. CPM uses a slightly different convention where `proxy_SOURCE_DIR` is declared after `CPMAddPackage`.
+- (1) `msft_proxy4_INCLUDE_DIR` is automatically declared after `find_package(msft_proxy4)`. CPM uses a slightly different convention where `msft_proxy4_SOURCE_DIR` is declared after `CPMAddPackage`.
 - (2) The C++ standard version for `msft_proxy4_module` target should be the same or higher than the consumer CMake target. For example if your project is using C++23 mode, this line should be changed to `cxx_std_23` or `cxx_std_26` / newer standards.
 
 It can then be consumed like this:
 
 ```cmake
-target_link_libraries(main PRIVATE msft_proxy::proxy4_module)
+target_link_libraries(main PRIVATE msft_proxy4::proxy_module)
 ```
 
 ## Example

docs/CMakeLists.txt

@@ -39,7 +39,7 @@ add_executable(msft_proxy_tests
   proxy_view_tests.cpp
 )
 target_include_directories(msft_proxy_tests PRIVATE .)
-target_link_libraries(msft_proxy_tests PRIVATE msft_proxy::proxy4 gtest_main fmt::fmt)
+target_link_libraries(msft_proxy_tests PRIVATE msft_proxy4::proxy gtest_main fmt::fmt)
 
 if(MSVC)
   target_compile_options(msft_proxy_tests PRIVATE /W4 /WX)
@@ -59,7 +59,7 @@ if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang
     target_compile_options(msft_proxy_freestanding_tests PRIVATE -ffreestanding -fno-exceptions -fno-rtti -Wall -Wextra -Wpedantic -Werror)
   endif()
   target_link_options(msft_proxy_freestanding_tests PRIVATE -nodefaultlibs -lc)
-  target_link_libraries(msft_proxy_freestanding_tests PRIVATE msft_proxy::proxy4)
+  target_link_libraries(msft_proxy_freestanding_tests PRIVATE msft_proxy4::proxy)
   add_test(NAME ProxyFreestandingTests COMMAND msft_proxy_freestanding_tests)
 endif()
 

docs/cpp20_modules_support.md

@@ -10,5 +10,5 @@ if(PROXY_BUILD_MODULES)
       foo.cpp
       impl.cpp
   )
-  target_link_libraries(msft_proxy_tests PRIVATE msft_proxy::proxy4_module)
+  target_link_libraries(msft_proxy_tests PRIVATE msft_proxy4::proxy_module)
 endif()