TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-10-04 10:54:24 -04:00
Code Issues Packages Projects Releases Wiki Activity
panda3d/cmake/macros/BuildMetalib.cmake

362 lines
12 KiB
CMake
Raw Blame History

# Filename: BuildMetalib.cmake
#
# Description: This file contains macros to build Panda3D's "metalibs" - these
# are special libraries that contain no unique code themselves and are
# instead just an agglomeration of the various component libraries that get
# linked into them. A library of libraries - a "metalibrary."
#
# Function: add_component_library(target [SYMBOL building_symbol]
# [SOURCES] [[NOINIT]/[INIT func [header]]])
#
# Used very similarly to add_library. You can specify a symbol with SYMBOL,
# which works like CMake's own DEFINE_SYMBOL property: it's defined when
# building the library, but not when building something that links against the
# library.
#
# INIT specifies the init function that should be called from a metalib's init
# function when this is added to a metalib. The header parameter can further
# clarify what header declares this function. By default, this is
# init_libTARGET and config_TARGET.h, respectively, where TARGET is the
# target name (with 'p3' stripped off, if applicable). The NOINIT keyword
# suppresses this default.
#
# Note that this function gets to decide whether the component library is
# OBJECT or SHARED, and whether the library is installed or not. Also, as
# a rule, component libraries may only be linked by other component libraries
# in the same metalib - outside of the metalib, you must link the metalib
# itself.
#
function(add_component_library target_name)
set(sources)
unset(symbol)
if(target_name MATCHES "^p3.*")
string(SUBSTRING "${target_name}" 2 -1 name_without_prefix)
else()
set(name_without_prefix "${target_name}")
endif()
set(init_func "init_lib${name_without_prefix}")
set(init_header "config_${name_without_prefix}.h")
set(symbol_keyword OFF)
set(init_keyword 0)
foreach(source ${ARGN})
if(source STREQUAL "SYMBOL")
set(symbol_keyword ON)
set(init_keyword 0)
elseif(source STREQUAL "INIT")
set(symbol_keyword OFF)
set(init_keyword 2)
elseif(source STREQUAL "NOINIT")
set(init_func)
set(init_header)
elseif(symbol_keyword)
set(symbol_keyword OFF)
set(symbol "${source}")
elseif(init_keyword EQUAL 2)
set(init_func "${source}")
set(init_keyword 1)
elseif(init_keyword EQUAL 1)
set(init_header "${source}")
set(init_keyword 0)
else()
list(APPEND sources "${source}")
endif()
endforeach()
if(BUILD_METALIBS)
# CMake 3.0.2 doesn't like .I/.N/.T files! We let it know that they're only
# headers.
foreach(source ${sources})
if(source MATCHES "\\.[INT]$")
set_source_files_properties(${source} PROPERTIES HEADER_FILE_ONLY ON)
endif()
endforeach(source)
add_library("${target_name}" OBJECT ${sources})
else()
add_library("${target_name}" ${sources})
endif()
set_target_properties("${target_name}" PROPERTIES
IS_COMPONENT ON
INIT_FUNCTION "${init_func}"
INIT_HEADER "${init_header}")
if(symbol)
set_property(TARGET "${target_name}" PROPERTY DEFINE_SYMBOL "${symbol}")
if(BUILD_METALIBS)
# ... DEFINE_SYMBOL is apparently not respected for object libraries?
set_property(TARGET "${target_name}" APPEND PROPERTY COMPILE_DEFINITIONS "${symbol}")
# Make sure other component libraries relying on this one inherit the
# symbol
set_property(TARGET "${target_name}" APPEND PROPERTY
INTERFACE_COMPILE_DEFINITIONS "$<$<BOOL:$<TARGET_PROPERTY:IS_COMPONENT>>:${symbol}>")
endif()
endif()
if(BUILD_METALIBS)
# Apparently neither is CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE?
set_property(TARGET "${target_name}" PROPERTY
INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}")
# If we're building dynamic libraries, the object library needs to be -fPIC
if(BUILD_SHARED_LIBS)
set_property(TARGET "${target_name}" PROPERTY
POSITION_INDEPENDENT_CODE ON)
endif()
endif()
endfunction(add_component_library)
#
# Function: add_metalib(target [source1 source2]
# [INCLUDE header1.h ...]
# [INIT initfunc [initheader.h] [EXPORT type name expr]]
# [COMPONENTS component1 ...])
#
# This is add_library, but for metalibs.
#
# The INIT keyword can specify an initialization function/header (which will be
# autogenerated by this function) that calls the underlying component libs'
# init functions.
#
# The EXPORT keyword exports the expression `expr`, which yields a value of
# type `type`, as the undecorated (extern "C") symbol `name`
#
# The INCLUDE keyword allows the init file to pull in additional headers, which
# may be useful for EXPORT.
#
function(add_metalib target_name)
set(components_keyword OFF)
set(init_keyword 0)
set(init_func)
set(init_header "${target_name}.h")
set(export_keyword 0)
set(export_declarations)
set(export_definitions)
set(component_init_headers)
set(components)
set(sources)
foreach(arg ${ARGN})
if(arg STREQUAL "COMPONENTS")
set(components_keyword ON)
set(include_keyword OFF)
set(init_keyword 0)
set(export_keyword 0)
elseif(arg STREQUAL "INCLUDE")
set(include_keyword ON)
set(components_keyword OFF)
set(init_keyword 0)
set(export_keyword 0)
elseif(arg STREQUAL "INIT")
set(init_keyword 2)
set(components_keyword OFF)
set(include_keyword OFF)
set(export_keyword 0)
elseif(arg STREQUAL "EXPORT")
if(NOT init_func)
message(FATAL_ERROR "EXPORT cannot be used before INIT")
endif()
set(export_keyword 3)
set(components_keyword OFF)
set(include_keyword OFF)
set(init_keyword 0)
elseif(components_keyword)
list(APPEND components "${arg}")
elseif(include_keyword)
set(component_init_headers
"${component_init_headers}#include \"${arg}\"\n")
elseif(init_keyword EQUAL 2)
set(init_func "${arg}")
set(init_keyword 1)
elseif(init_keyword EQUAL 1)
set(init_header "${arg}")
set(init_keyword 0)
elseif(export_keyword EQUAL 3)
set(_export_type "${arg}")
set(export_keyword 2)
elseif(export_keyword EQUAL 2)
set(_export_name "${arg}")
set(export_keyword 1)
elseif(export_keyword EQUAL 1)
set(export_declarations
"${export_declarations}\nextern \"C\" IMPORT_CLASS ${_export_type} ${_export_name}();")
set(export_definitions
"${export_definitions}\nextern \"C\" EXPORT_CLASS ${_export_type} ${_export_name}() { return ${arg}; }")
unset(_export_type)
unset(_export_name)
set(export_keyword 0)
else()
list(APPEND sources "${arg}")
endif()
endforeach()
string(REPLACE ";" "|" piped_components "${components}")
set(component_genex_regex ".*TARGET_PROPERTY:(${piped_components}),.*")
set(private_defines)
set(interface_defines)
set(includes)
set(libs)
set(link_options)
set(component_init_funcs "")
foreach(component ${components})
if(NOT TARGET "${component}")
message(FATAL_ERROR
"Missing component library ${component} referenced by metalib ${target_name}!
(Component library targets must be created BEFORE add_metalib.)")
endif()
get_target_property(is_component "${component}" IS_COMPONENT)
if(NOT is_component)
message(FATAL_ERROR
"Attempted to metalink non-component ${component} into ${target_name}!")
endif()
get_target_property(component_init_header "${component}" INIT_HEADER)
get_target_property(component_init_func "${component}" INIT_FUNCTION)
if(component_init_header)
set(component_init_headers
"${component_init_headers}#include \"${component_init_header}\"\n")
endif()
if(component_init_func)
set(component_init_funcs
"${component_init_funcs} ${component_init_func}();\n")
endif()
if(BUILD_METALIBS)
# This will be an object library we're pulling in; rather than link,
# let's try to "flatten" all of its properties into ours.
# Private defines: Just reference using a generator expression
list(APPEND private_defines "$<TARGET_PROPERTY:${component},COMPILE_DEFINITIONS>")
# Interface defines: Copy those, but filter out generator expressions
# referencing a component library
get_target_property(component_defines "${component}" INTERFACE_COMPILE_DEFINITIONS)
if(component_defines)
foreach(component_define ${component_defines})
if(component_define MATCHES "${component_genex_regex}")
# Filter, it's a genex referencing one of our components
elseif(component_define MATCHES ".*IS_COMPONENT.*")
# Filter, it's testing to see if the consumer is a component
else()
list(APPEND interface_defines ${component_define})
endif()
endforeach(component_define)
endif()
# Include directories: Filter out anything that references a component
# library or anything in the project path
get_target_property(component_includes "${component}" INTERFACE_INCLUDE_DIRECTORIES)
foreach(component_include ${component_includes})
if(component_include MATCHES "${component_genex_regex}")
# Ignore component references
elseif(component_include MATCHES "^${PROJECT_SOURCE_DIR}")
# Include path within project; should only be included when building
list(APPEND includes "$<BUILD_INTERFACE:${component_include}>")
else()
# Anything else gets included
list(APPEND includes "${component_include}")
endif()
endforeach(component_include)
# Link libraries: Filter out component libraries; we aren't linking
# against them, we're using their objects
get_target_property(component_libraries "${component}" INTERFACE_LINK_LIBRARIES)
foreach(component_library ${component_libraries})
if(NOT component_library)
# NOTFOUND - guess there are no INTERFACE_LINK_LIBRARIES
elseif(component_library MATCHES "${component_genex_regex}")
# Ignore component references
elseif(component_library MATCHES ".*(${piped_components}).*")
# Component library, ignore
else()
# Anything else gets included
list(APPEND libs "${component_library}")
endif()
endforeach(component_library)
# All the linker options applied to an individual component get applied
# when building the metalib (for things like --exclude-libs).
get_target_property(component_link_options "${component}" LINK_OPTIONS)
foreach(component_link_option ${component_link_options})
if(component_link_option)
list(APPEND link_options "${component_link_option}")
endif()
endforeach(component_link_option)
# Consume this component's objects
list(APPEND sources "$<TARGET_OBJECTS:${component}>")
else() # NOT BUILD_METALIBS
list(APPEND libs "${component}")
endif()
endforeach()
if(init_func)
set(init_source_path "${CMAKE_CURRENT_BINARY_DIR}/init_${target_name}.cxx")
set(init_header_path "${CMAKE_CURRENT_BINARY_DIR}/${init_header}")
configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/metalib_init.cxx.in"
"${init_source_path}")
list(APPEND sources "${init_source_path}")
configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/metalib_init.h.in"
"${init_header_path}")
install(FILES "${init_header_path}" DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/panda3d)
endif()
add_library("${target_name}" ${sources})
target_compile_definitions("${target_name}"
PRIVATE ${private_defines}
INTERFACE ${interface_defines})
target_link_libraries("${target_name}" ${libs})
target_link_options("${target_name}" PRIVATE ${link_options})
target_include_directories("${target_name}"
PUBLIC ${includes}
INTERFACE "$<INSTALL_INTERFACE:$<INSTALL_PREFIX>/${CMAKE_INSTALL_INCLUDEDIR}/panda3d>")
endfunction(add_metalib)
Reference in New Issue View Git Blame Copy Permalink