-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathCMakeLists.txt
More file actions
320 lines (274 loc) · 14.5 KB
/
CMakeLists.txt
File metadata and controls
320 lines (274 loc) · 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
cmake_minimum_required(VERSION 3.6.0)
# CMake policy CM0074 must be set explicitly by any client project
# that wants to use find_package with a <PACKAGE>_ROOT variable.
# Therefore, we set this policy to enable support for the Matlab_ROOT
# flag with find_package(Matlab)
cmake_policy(SET CMP0074 NEW)
# Project metadata.
set(LIBMEXCLASS_PROJECT_NAME libmexclass)
project(${LIBMEXCLASS_PROJECT_NAME} VERSION 0.1.0)
# ################
# Helper Functions
# ################
# Install the runtime libraries of an IMPORTED target.
function(install_imported_target)
# TODO: Add required argument logic.
set(options)
set(oneValueArgs NAME DESTINATION)
set(multiValueArgs)
cmake_parse_arguments(LIBMEXCLASS_INSTALL_IMPORTED_TARGET "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
get_target_property(RUNTIME_LIBRARY ${LIBMEXCLASS_INSTALL_IMPORTED_TARGET_NAME} IMPORTED_LOCATION)
if (NOT ${RUNTIME_LIBRARY})
get_target_property(RUNTIME_LIBRARY ${LIBMEXCLASS_INSTALL_IMPORTED_TARGET_NAME} LOCATION)
endif()
get_filename_component(RUNTIME_LIBRARY_FILENAME_NO_EXT ${RUNTIME_LIBRARY} NAME_WE)
get_filename_component(RUNTIME_LIBRARY_DIRECTORY ${RUNTIME_LIBRARY} DIRECTORY)
set(RUNTIME_LIBRARY_BASE_FILENAME "${RUNTIME_LIBRARY_DIRECTORY}/${RUNTIME_LIBRARY_FILENAME_NO_EXT}${CMAKE_SHARED_LIBRARY_SUFFIX}")
# TODO: Consider alternate naming schemes for temporary directories.
set(RUNTIME_LIBRARY_TEMP_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/libmexclass_install_runtime_libraries/${RUNTIME_LIBRARY_FILENAME_NO_EXT}")
install(CODE "file(COPY ${RUNTIME_LIBRARY_BASE_FILENAME} DESTINATION ${RUNTIME_LIBRARY_TEMP_DIRECTORY} FOLLOW_SYMLINK_CHAIN)")
install(DIRECTORY ${RUNTIME_LIBRARY_TEMP_DIRECTORY}/ DESTINATION ${LIBMEXCLASS_INSTALL_IMPORTED_TARGET_DESTINATION})
endfunction()
# Set the given target's RPATH on Linux and macOS.
function(target_set_rpath_relocatable)
# TODO: Add required argument logic.
set(options)
set(oneValueArgs NAME)
set(multiValueArgs)
cmake_parse_arguments(LIBMEXCLASS_TARGET_SET_RPATH "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(APPLE)
set_target_properties(${LIBMEXCLASS_TARGET_SET_RPATH_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
else()
set_target_properties(${LIBMEXCLASS_TARGET_SET_RPATH_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
endif()
endfunction()
# Debugging utility function
macro(MatlabPrintVariables)
message(STATUS "Matlab_ROOT_DIR = ${Matlab_ROOT_DIR}")
message(STATUS "Matlab_VERSION_STRING = ${Matlab_VERSION_STRING}")
message(STATUS "Matlab_MX_LIBRARY = ${Matlab_MX_LIBRARY}")
message(STATUS "Matlab_MEX_LIBRARY = ${Matlab_MEX_LIBRARY}")
message(STATUS "Matlab_ENGINE_LIBRARY = ${Matlab_ENGINE_LIBRARY}")
message(STATUS "Matlab_DATAARRAY_LIBRARY = ${Matlab_DATAARRAY_LIBRARY}")
message(STATUS "Matlab_HAS_CPP_API = ${Matlab_HAS_CPP_API}")
message(STATUS "Matlab_MEX_EXTENSION = ${Matlab_MEX_EXTENSION}")
message(STATUS "Matlab_INCLUDE_DIRS = ${Matlab_INCLUDE_DIRS}")
message(STATUS "Matlab_EXTERN_LIBRARY_DIR = ${Matlab_EXTERN_LIBRARY_DIR}")
endmacro()
# Sets variables required by FindMatlab's matlab_add_mex function. These
# variables are normally configured by FindMatlab (i.e. find_package(MATLAB REQUIRED)),
# but FindMatlab sporadically fails to detect the MATLAB Release Version. If so,
# manually configure the required variables.
macro(MatlabConfigureVariables)
if(WIN32)
set(MATLAB_BIN_DIR "${Matlab_ROOT_DIR}/extern/lib/win64/microsoft")
set(MATLAB_EXTERN_BIN_DIR "${Matlab_ROOT_DIR}/extern/lib/win64/microsoft")
set(MATLAB_EXTERN_LIB_DIR "${Matlab_ROOT_DIR}/extern/lib/win64")
set(SHARED_LIB_SUFFIX "${CMAKE_LINK_LIBRARY_SUFFIX}")
else()
set(SHARED_LIB_SUFFIX "${CMAKE_SHARED_LIBRARY_SUFFIX}")
if(APPLE)
if (${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL "arm64")
set(PLATFORM_FOLDER "maca64")
else()
set(PLATFORM_FOLDER "maci64")
endif()
elseif(UNIX AND NOT CYGWIN)
set(PLATFORM_FOLDER "glnxa64")
else()
message(FATAL_ERROR "Unsupported platform")
endif()
set(MATLAB_BIN_DIR "${Matlab_ROOT_DIR}/bin/${PLATFORM_FOLDER}")
set(MATLAB_EXTERN_BIN_DIR "${Matlab_ROOT_DIR}/extern/bin/${PLATFORM_FOLDER}")
set(MATLAB_EXTERN_LIB_DIR "${Matlab_ROOT_DIR}/extern/lib/${PLATFORM_FOLDER}")
endif()
set(Matlab_HAS_CPP_API 1)
set(Matlab_VERSION_STRING "${MATLAB_RELEASE_VERSION}")
set(Matlab_INCLUDE_DIRS "${Matlab_ROOT_DIR}/extern/include")
set(Matlab_ENGINE_LIBRARY "${MATLAB_EXTERN_BIN_DIR}/libMatlabEngine${SHARED_LIB_SUFFIX}")
set(Matlab_DATAARRAY_LIBRARY "${MATLAB_BIN_DIR}/libMatlabDataArray${SHARED_LIB_SUFFIX}")
set(Matlab_MEX_LIBRARY "${MATLAB_BIN_DIR}/libmex${SHARED_LIB_SUFFIX}")
set(Matlab_MX_LIBRARY "${MATLAB_BIN_DIR}/libmx${SHARED_LIB_SUFFIX}")
set(Matlab_EXTERN_LIBRARY_DIR "${MATLAB_EXTERN_LIB_DIR}")
endmacro()
# Finds MATLAB and configures the variables necessary for building libmexclass,
# client proxy libraries, and client proxy mex gateway functions.
macro(MatlabConfigure)
find_package(Matlab REQUIRED)
message(STATUS "Matlab_VERSION_STRING = ${Matlab_VERSION_STRING}")
if (${Matlab_VERSION_STRING} STREQUAL "unknown")
# Derive the MATLAB Release Version Number from VersionInfo.xml.
# The matlab_add_mex function needs to know the MATLAB Release Version Number
# (i.e. Matlab_VERSION_STRING) in order to properly compile MEX functions.
set(VERSION_INFO_FILENAME "${Matlab_ROOT_DIR}/VersionInfo.xml")
file(READ ${VERSION_INFO_FILENAME} VERSION_INFO_TEXT)
string(REGEX MATCH "<version>([0-9]+[.])+[0-9]+</version>" VERSION_XML_NODE ${VERSION_INFO_TEXT})
string(REGEX MATCH "([0-9]+[.])+[0-9]+" LONG_VERSION_STRING ${VERSION_XML_NODE})
string(REGEX MATCH "^[0-9]+[.][0-9]+" MATLAB_RELEASE_VERSION ${LONG_VERSION_STRING})
message(STATUS "MATLAB_RELEASE_VERSION = ${MATLAB_RELEASE_VERSION}")
MatlabConfigureVariables()
endif()
endmacro()
# Find MATLAB.
MatlabConfigure()
# ###########
# libmexclass
# ###########
# Sources.
set(LIBMEXCLASS_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/source)
set(LIBMEXCLASS_SOURCES
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/action/TypeFactory.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/action/Unsupported.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/action/Create.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/action/Destroy.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/action/MethodCall.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/proxy/Proxy.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/proxy/ProxyManager.cpp
${LIBMEXCLASS_SOURCE_DIR}/libmexclass/error/Error.cpp
)
# Create libmexclass shared library target.
set(LIBMEXCLASS_LIBRARY_NAME mexclass)
add_library(${LIBMEXCLASS_LIBRARY_NAME} SHARED ${LIBMEXCLASS_SOURCES})
set_target_properties(${LIBMEXCLASS_LIBRARY_NAME} PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON)
# Set compiler features to require C++17.
target_compile_features(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE cxx_std_17)
# Include directories (i.e. header files).
set(LIBMEXCLASS_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/source/include)
target_include_directories(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE ${Matlab_INCLUDE_DIRS})
target_include_directories(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE ${LIBMEXCLASS_INCLUDE_DIR})
# Link against MEX shared library.
target_link_libraries(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE ${Matlab_MEX_LIBRARY})
# Link against MATLAB Data Array shared library.
target_link_libraries(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE ${Matlab_DATAARRAY_LIBRARY})
target_set_rpath_relocatable(NAME ${LIBMEXCLASS_LIBRARY_NAME})
# TODO: Use Imported targets. This requires a newer version of CMake.
# target_link_libraries(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE Matlab::mex)
# target_link_libraries(${LIBMEXCLASS_LIBRARY_NAME} PRIVATE Matlab::MatlabDataArray)
# #################
# libmexclassmatlab
# #################
add_custom_target(mexclassmatlab)
define_property(
TARGET
PROPERTY MATLAB_SOURCES
BRIEF_DOCS "Location of libmexclass MATLAB sources"
FULL_DOCS "The location of the libmexclass MATLAB sources (i.e. the location of the +libmexclass directory)."
)
set_property(
TARGET mexclassmatlab
PROPERTY MATLAB_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/../matlab/+libmexclass"
)
# #################
# libmexclassclient
# #################
macro(libmexclass_client_add_proxy_library)
# TODO: Add required argument logic.
set(options)
set(oneValueArgs NAME)
set(multiValueArgs SOURCES INCLUDE_DIRS LINK_LIBRARIES)
cmake_parse_arguments(LIBMEXCLASS_CLIENT_PROXY_LIBRARY "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
MatlabConfigure()
add_library(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} SHARED ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_SOURCES})
set_target_properties(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON)
target_include_directories(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_INCLUDE_DIRS})
get_target_property(LIBMEXCLASS_INCLUDE_DIRS mexclass INCLUDE_DIRECTORIES)
target_include_directories(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${Matlab_INCLUDE_DIRS})
target_include_directories(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${LIBMEXCLASS_INCLUDE_DIRS})
# Link against libmexclass shared library.
target_link_libraries(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE mexclass)
# Link against MATLAB Data Array shared library.
target_link_libraries(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${Matlab_DATAARRAY_LIBRARY})
# Link against MEX shared library.
target_link_libraries(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${Matlab_MEX_LIBRARY})
define_property(
TARGET
PROPERTY LIBMEXCLASS_CLIENT_PROXY_LIBRARY_LINK_LIBRARIES
BRIEF_DOCS "Additional link libraries for client Proxy library"
FULL_DOCS "Target names of additional shared libraries to link against the libmexclass client Proxy library."
)
if(DEFINED LIBMEXCLASS_CLIENT_PROXY_LIBRARY_LINK_LIBRARIES)
foreach(LINK_LIBRARY ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_LINK_LIBRARIES})
get_target_property(TARGET_INCLUDE_DIRECTORIES ${LINK_LIBRARY} INTERFACE_INCLUDE_DIRECTORIES)
target_include_directories(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${TARGET_INCLUDE_DIRECTORIES})
target_link_libraries(${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME} PRIVATE ${LINK_LIBRARY})
endforeach()
set_property(
TARGET ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME}
PROPERTY LIBMEXCLASS_CLIENT_PROXY_LIBRARY_LINK_LIBRARIES ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_LINK_LIBRARIES}
)
endif()
target_set_rpath_relocatable(NAME ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_NAME})
endmacro()
# ###########
# MEX gateway
# ###########
macro(libmexclass_client_add_mex_gateway)
# TODO: Add required argument logic.
set(options)
set(oneValueArgs NAME CLIENT_PROXY_LIBRARY_NAME)
set(multiValueArgs SOURCES)
cmake_parse_arguments(LIBMEXCLASS_CLIENT_MEX_GATEWAY "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
MatlabConfigure()
# By default matlab_add_mex automatically links the output MEX function
# against all MEX-related libraries.
#
# These include:
# - libmx
# - libmex
# - libMatlabDataArray
# - libMatlabEngine
#
# However, libMatlabEngine is only required for standalone C++ programs
# that utilize the MATLAB Engine.
#
# Avoid linking against libMatlabEngine by supplying the
# NO_IMPLICIT_LINK_TO_MATLAB_LIBRARIES flag and manually passing
# the required mex-related libraries as arguments for the LINK_TO parameter.
#
matlab_add_mex(NAME ${LIBMEXCLASS_CLIENT_MEX_GATEWAY_NAME}
SRC ${LIBMEXCLASS_CLIENT_MEX_GATEWAY_SOURCES}
OUTPUT_NAME "gateway"
NO_IMPLICIT_LINK_TO_MATLAB_LIBRARIES
LINK_TO mexclass
${LIBMEXCLASS_CLIENT_MEX_GATEWAY_CLIENT_PROXY_LIBRARY_NAME}
${Matlab_MX_LIBRARY}
${Matlab_MEX_LIBRARY}
${Matlab_DATAARRAY_LIBRARY})
# Set compiler features to require C++17.
target_compile_features(${LIBMEXCLASS_CLIENT_MEX_GATEWAY_NAME} PRIVATE cxx_std_17)
# Include directories (i.e. header files).
get_target_property(LIBMEXCLASS_INCLUDE_DIRS mexclass INCLUDE_DIRECTORIES)
target_include_directories(${LIBMEXCLASS_CLIENT_MEX_GATEWAY_NAME} PRIVATE ${LIBMEXCLASS_INCLUDE_DIRS})
# TODO: Decide whether to automatically add client library include directories.
get_target_property(LIBMEXCLASS_CLIENT_PROXY_LIBRARY_INCLUDE_DIRS ${LIBMEXCLASS_CLIENT_MEX_GATEWAY_CLIENT_PROXY_LIBRARY_NAME} INCLUDE_DIRECTORIES)
target_include_directories(${LIBMEXCLASS_CLIENT_MEX_GATEWAY_NAME} PRIVATE ${LIBMEXCLASS_CLIENT_PROXY_LIBRARY_INCLUDE_DIRS})
target_set_rpath_relocatable(NAME ${LIBMEXCLASS_CLIENT_MEX_GATEWAY_NAME})
endmacro()
# ############
# Installation
# ############
macro(libmexclass_client_install)
set(options)
set(oneValueArgs NAME CLIENT_PROXY_LIBRARY_NAME CLIENT_MEX_GATEWAY_NAME DESTINATION)
set(multiValueArgs SOURCES)
cmake_parse_arguments(LIBMEXCLASS_CLIENT_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
set(LIBMEXCLASS_PROXY_PACKAGE_DIRECTORY "+libmexclass/+proxy")
set(LIBMEXCLASS_CLIENT_INSTALL_PROXY_PACKAGE_DESTINATION ${LIBMEXCLASS_CLIENT_INSTALL_DESTINATION}/${LIBMEXCLASS_PROXY_PACKAGE_DIRECTORY})
install(TARGETS mexclass
${LIBMEXCLASS_CLIENT_INSTALL_CLIENT_PROXY_LIBRARY_NAME}
${LIBMEXCLASS_CLIENT_INSTALL_CLIENT_MEX_GATEWAY_NAME}
DESTINATION ${LIBMEXCLASS_CLIENT_INSTALL_PROXY_PACKAGE_DESTINATION})
get_target_property(MATLAB_SOURCE_DIR mexclassmatlab MATLAB_SOURCES)
install(DIRECTORY ${MATLAB_SOURCE_DIR} DESTINATION ${LIBMEXCLASS_CLIENT_INSTALL_DESTINATION})
get_target_property(LINK_LIBRARIES ${LIBMEXCLASS_CLIENT_INSTALL_CLIENT_PROXY_LIBRARY_NAME} LIBMEXCLASS_CLIENT_PROXY_LIBRARY_LINK_LIBRARIES)
if(LINK_LIBRARIES)
foreach(LINK_LIBRARY ${LINK_LIBRARIES})
get_target_property(LINK_LIBRARY_IS_IMPORTED ${LINK_LIBRARY} IMPORTED)
if(${LINK_LIBRARY_IS_IMPORTED})
install_imported_target(NAME ${LINK_LIBRARY} DESTINATION ${LIBMEXCLASS_CLIENT_INSTALL_PROXY_PACKAGE_DESTINATION})
else()
install(TARGETS ${LINK_LIBRARY} DESTINATION ${LIBMEXCLASS_CLIENT_INSTALL_PROXY_PACKAGE_DESTINATION})
endif()
endforeach()
endif()
endmacro()