Skip to content

Commit 026c09d

Browse files
authored
Merge pull request #105 from SYMSCAE/cmake-libdiffpy
build: vendor libdiffpy as cmake project
2 parents d0dc74b + b772992 commit 026c09d

7 files changed

Lines changed: 63 additions & 486 deletions

File tree

‎CMakeLists.txt‎

Lines changed: 36 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,42 @@
1-
cmake_minimum_required(VERSION 3.20)
1+
cmake_minimum_required(VERSION 3.22)
22
project(diffpy_srreal LANGUAGES NONE)
33

4-
# Keep this aligned with the pinned libdiffpy's src/SConscript.
4+
# Keep this aligned with the pinned libdiffpy's CMakeLists.txt.
55
set(CMAKE_CXX_STANDARD 23)
66
set(CMAKE_CXX_STANDARD_REQUIRED ON)
77
set(CMAKE_CXX_EXTENSIONS OFF)
88

99
set(LIBDIFFPY_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/extern/libdiffpy")
10-
if(NOT EXISTS "${LIBDIFFPY_SOURCE_DIR}/src/diffpy/version.tpl")
10+
if(NOT EXISTS "${LIBDIFFPY_SOURCE_DIR}/CMakeLists.txt")
1111
message(FATAL_ERROR
1212
"Missing libdiffpy sources. Initialize the submodule with "
1313
"'git submodule update --init --recursive', or use a source distribution "
1414
"that includes extern/libdiffpy."
1515
)
1616
endif()
1717

18-
# Read version information from the submodule; sdists carry the generated header.
19-
set(LIBDIFFPY_VERSION_HEADER "${CMAKE_CURRENT_BINARY_DIR}/include/diffpy/version.hpp")
20-
set(LIBDIFFPY_SDIST_VERSION_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/_build/libdiffpy-version.hpp")
21-
if(EXISTS "${LIBDIFFPY_SOURCE_DIR}/.git")
22-
file(STRINGS "${LIBDIFFPY_SOURCE_DIR}/site_scons/fallback_version.py"
23-
LIBDIFFPY_FALLBACK_VERSION REGEX "^FALLBACK_VERSION =")
24-
if(NOT LIBDIFFPY_FALLBACK_VERSION MATCHES "([0-9]+)\\.([0-9]+)\\.([0-9]+)")
25-
message(FATAL_ERROR "Cannot read the libdiffpy base version.")
26-
endif()
27-
set(DIFFPY_VERSION_MAJOR "${CMAKE_MATCH_1}")
28-
set(DIFFPY_VERSION_MINOR "${CMAKE_MATCH_2}")
29-
set(DIFFPY_VERSION_MICRO "${CMAKE_MATCH_3}")
30-
set(DIFFPY_VERSION_PATCH 0)
31-
set(DIFFPY_VERSION_STR "${DIFFPY_VERSION_MAJOR}.${DIFFPY_VERSION_MINOR}.${DIFFPY_VERSION_MICRO}")
32-
math(EXPR DIFFPY_VERSION "${DIFFPY_VERSION_MAJOR} * 1000000000 + ${DIFFPY_VERSION_MINOR} * 1000000 + ${DIFFPY_VERSION_MICRO} * 1000")
33-
set(DIFFPY_VERSION "${DIFFPY_VERSION}LL")
34-
find_package(Git REQUIRED)
35-
execute_process(
36-
COMMAND "${GIT_EXECUTABLE}" -C "${LIBDIFFPY_SOURCE_DIR}" log -1 "--format=%H;%ci"
37-
OUTPUT_VARIABLE LIBDIFFPY_COMMIT_INFO
38-
OUTPUT_STRIP_TRAILING_WHITESPACE
39-
COMMAND_ERROR_IS_FATAL ANY
40-
)
41-
list(GET LIBDIFFPY_COMMIT_INFO 0 DIFFPY_GIT_SHA)
42-
list(GET LIBDIFFPY_COMMIT_INFO 1 DIFFPY_VERSION_DATE)
43-
configure_file("${LIBDIFFPY_SOURCE_DIR}/src/diffpy/version.tpl"
44-
"${LIBDIFFPY_VERSION_HEADER}")
45-
else()
46-
configure_file("${LIBDIFFPY_SDIST_VERSION_HEADER}"
47-
"${LIBDIFFPY_VERSION_HEADER}" COPYONLY)
48-
endif()
18+
# libdiffpy resolves its version from git unless src/diffpy/version.hpp exists,
19+
# as in its own source distribution. The srreal sdist has no git, so write that
20+
# header here and ship it.
21+
set(LIBDIFFPY_SDIST_VERSION_HEADER "${LIBDIFFPY_SOURCE_DIR}/src/diffpy/version.hpp")
4922
if(SKBUILD_STATE STREQUAL "sdist")
50-
configure_file("${LIBDIFFPY_VERSION_HEADER}"
51-
"${LIBDIFFPY_SDIST_VERSION_HEADER}" COPYONLY)
23+
# Refresh git checkouts; preserve the header when repacking an sdist.
24+
if(EXISTS "${LIBDIFFPY_SOURCE_DIR}/.git" OR
25+
NOT EXISTS "${LIBDIFFPY_SDIST_VERSION_HEADER}")
26+
include("${LIBDIFFPY_SOURCE_DIR}/cmake/LibdiffpyVersion.cmake")
27+
libdiffpy_resolve_version()
28+
libdiffpy_write_version_header(
29+
"${LIBDIFFPY_SOURCE_DIR}/src/diffpy/version.tpl"
30+
"${LIBDIFFPY_SDIST_VERSION_HEADER}")
31+
endif()
5232
return()
5333
endif()
34+
# A header left over from a local sdist build would freeze the git checkout's
35+
# version, so remove it.
36+
if(EXISTS "${LIBDIFFPY_SOURCE_DIR}/.git" AND EXISTS "${LIBDIFFPY_SDIST_VERSION_HEADER}")
37+
message(STATUS "Removing stale ${LIBDIFFPY_SDIST_VERSION_HEADER}")
38+
file(REMOVE "${LIBDIFFPY_SDIST_VERSION_HEADER}")
39+
endif()
5440
enable_language(CXX)
5541

5642
# Conda is optional; system packages and CMAKE_PREFIX_PATH work as well.
@@ -95,40 +81,30 @@ if(DEFINED _srreal_saved_suffixes)
9581
endforeach()
9682
endif()
9783

98-
set(DIFFPY_HAS_OBJCRYST 0)
99-
configure_file("${LIBDIFFPY_SOURCE_DIR}/src/diffpy/features.tpl"
100-
"include/diffpy/features.hpp")
101-
102-
file(GLOB LIBDIFFPY_SOURCES CONFIGURE_DEPENDS
103-
"${LIBDIFFPY_SOURCE_DIR}/src/diffpy/*.cpp"
104-
"${LIBDIFFPY_SOURCE_DIR}/src/diffpy/srreal/*.cpp"
105-
)
84+
# Embed libdiffpy as an OBJECT library: every object is linked, so its static
85+
# factory/serialization registrars are kept.
86+
set(LIBDIFFPY_BUILD_OBJECT_LIB ON)
87+
set(LIBDIFFPY_INSTALL OFF)
10688
# ObjCryst conversion uses the public Python API, so it does not depend on
10789
# pyobjcryst's private static library, compiler, REAL precision, or nanobind ABI.
108-
list(FILTER LIBDIFFPY_SOURCES EXCLUDE REGEX "ObjCryst")
109-
# Include every object: libdiffpy has static factory/serialization registrars
110-
# that an ordinary static archive link can otherwise discard.
111-
add_library(diffpy_core OBJECT ${LIBDIFFPY_SOURCES})
112-
set_target_properties(diffpy_core PROPERTIES
90+
set(LIBDIFFPY_ENABLE_OBJCRYST OFF)
91+
set(LIBDIFFPY_BUILD_TESTS OFF)
92+
# Runtime data installs next to the extension, in diffpy/srreal/data.
93+
set(LIBDIFFPY_RUNTIME_RELPATH data)
94+
add_subdirectory("${LIBDIFFPY_SOURCE_DIR}" libdiffpy EXCLUDE_FROM_ALL)
95+
set_target_properties(diffpy PROPERTIES
11396
POSITION_INDEPENDENT_CODE ON
11497
CXX_VISIBILITY_PRESET hidden
11598
VISIBILITY_INLINES_HIDDEN ON
11699
)
117-
target_include_directories(diffpy_core PUBLIC
118-
"${CMAKE_CURRENT_BINARY_DIR}/include"
119-
"${LIBDIFFPY_SOURCE_DIR}/src"
120-
)
121-
target_compile_definitions(diffpy_core PRIVATE DIFFPYRUNTIMERELPATH=data)
122-
if(WIN32)
123-
# libdiffpy and its Python wrappers are compiled into the same extension.
124-
target_compile_definitions(diffpy_core PUBLIC BUILD_DLL _USE_MATH_DEFINES NOMINMAX)
125-
endif()
126-
target_link_libraries(diffpy_core PUBLIC Boost::serialization GSL::gsl GSL::gslcblas ${CMAKE_DL_LIBS})
127100

128101
file(GLOB SRREAL_SOURCES CONFIGURE_DEPENDS "src/extensions/*.cpp")
129102
# Retain CPython-specific wheels; stable-ABI packaging is a separate change.
130103
nanobind_add_module(srreal_ext NB_STATIC ${SRREAL_SOURCES})
131-
target_link_libraries(srreal_ext PRIVATE diffpy_core)
104+
target_link_libraries(srreal_ext PRIVATE libdiffpy::diffpy)
105+
if(WIN32)
106+
target_compile_definitions(srreal_ext PRIVATE NOMINMAX)
107+
endif()
132108
set_target_properties(srreal_ext PROPERTIES INSTALL_RPATH_USE_LINK_PATH ON)
133109
install(TARGETS srreal_ext LIBRARY DESTINATION diffpy/srreal)
134110
install(DIRECTORY "${LIBDIFFPY_SOURCE_DIR}/src/runtime/"

‎devutils/generate_legacy_pickle_fixtures.py‎

Lines changed: 0 additions & 136 deletions
This file was deleted.

‎extern/libdiffpy‎

Submodule libdiffpy updated 90 files

‎news/cmake-libdiffpy.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**Added:**
2+
3+
* <news item>
4+
5+
**Changed:**
6+
7+
* Build the embedded libdiffpy through its own CMake project
8+
(``add_subdirectory``) instead of duplicating its build logic.
9+
10+
**Deprecated:**
11+
12+
* <news item>
13+
14+
**Removed:**
15+
16+
* <news item>
17+
18+
**Fixed:**
19+
20+
* <news item>
21+
22+
**Security:**
23+
24+
* <news item>

‎pyproject.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ cmake.build-type = "Release"
4747
wheel.packages = ["src/diffpy"]
4848
sdist.cmake = true
4949
sdist.include = [
50-
"_build/libdiffpy-version.hpp",
50+
"extern/libdiffpy/CMakeLists.txt",
51+
"extern/libdiffpy/cmake/**",
5152
"extern/libdiffpy/src/diffpy/**",
5253
"extern/libdiffpy/src/runtime/**",
5354
"extern/libdiffpy/LICENSE.rst",

0 commit comments

Comments
 (0)