mirror of
https://github.com/SFML/SFML.git
synced 2024-11-28 22:31:09 +08:00
30a986e632
https://cmake.org/cmake/help/v3.22/command/find_package.html https://cmake.org/cmake/help/v3.22/variable/PackageName_ROOT.html#variable:%3CPackageName%3E_ROOT SFML_DIR predates the existence of <PackageName>_ROOT which is now the preferred way to specify where to find a given package's config module. User reports have shown that SFML_DIR may be broken at least in certain circumstances so lets stop mentioning it.
160 lines
7.0 KiB
CMake
160 lines
7.0 KiB
CMake
# This script provides the SFML libraries as imported targets
|
|
# ------------------------------------
|
|
#
|
|
# Usage
|
|
# -----
|
|
#
|
|
# When you try to locate the SFML libraries, you must specify which modules you want to use (System, Window, Graphics, Network, Audio, Main).
|
|
# If none is given, no imported target will be created and you won't be able to link to SFML libraries.
|
|
# example:
|
|
# find_package(SFML COMPONENTS Graphics Window System) # find the graphics, window and system modules
|
|
#
|
|
# You can enforce a specific version, either MAJOR.MINOR or only MAJOR.
|
|
# If nothing is specified, the version won't be checked (i.e. any version will be accepted).
|
|
# example:
|
|
# find_package(SFML COMPONENTS ...) # no specific version required
|
|
# find_package(SFML 3 COMPONENTS ...) # any 3.x version
|
|
# find_package(SFML 2.6 COMPONENTS ...) # version 2.6 or greater with the same major version
|
|
#
|
|
# By default, the dynamic libraries of SFML will be found. To find the static ones instead,
|
|
# you must set the SFML_STATIC_LIBRARIES variable to TRUE before calling find_package(SFML ...).
|
|
# You don't need to deal with SFML's dependencies when linking your targets against SFML libraries,
|
|
# they will all be configured automatically, even if you use SFML static libraries.
|
|
# example:
|
|
# set(SFML_STATIC_LIBRARIES TRUE)
|
|
# find_package(SFML 3 COMPONENTS Network System)
|
|
#
|
|
# When searching for SFML with find_package(), keep in mind that it will also find versions which are
|
|
# in development (i.e. between two released versions), if you have them in your search path.
|
|
# If you want to make sure that a found SFML package corresponds to an official release, check the
|
|
# bool output variable SFML_VERSION_IS_RELEASE, which is true for official releases and false for development versions.
|
|
#
|
|
# If you want to use the latest features before a new SFML version is released, make sure to look for
|
|
# the upcoming version number. For example, if you want to use latest SFML 3 features before 3.0.0 is officially released,
|
|
# look for version 3 with find_package().
|
|
#
|
|
# On macOS by default CMake will search for frameworks. If you want to use static libraries and have installed
|
|
# both SFML frameworks and SFML static libraries, your must set CMAKE_FIND_FRAMEWORK to "NEVER" or "LAST"
|
|
# in addition to setting SFML_STATIC_LIBRARIES to TRUE. Otherwise CMake will check the frameworks bundle config and
|
|
# fail after finding out that it does not provide static libraries. Please refer to CMake documentation for more details.
|
|
#
|
|
# Additionally, keep in mind that SFML frameworks are only available as release libraries unlike dylibs which
|
|
# are available for both release and debug modes.
|
|
#
|
|
# If SFML is not installed in a standard path, you can use the SFML_ROOT CMake variable
|
|
# to tell CMake where SFML's config file is located (PREFIX/lib/cmake/SFML for a library-based installation,
|
|
# and PREFIX/SFML.framework/Resources/CMake on macOS for a framework-based installation).
|
|
#
|
|
# Output
|
|
# ------
|
|
#
|
|
# This script defines the following variables:
|
|
# - For each specified module XXX (System, Window, Graphics, Network, Audio, Main):
|
|
# - SFML_XXX_FOUND: true if either the debug or release library of the xxx module is found
|
|
# - SFML_FOUND: true if all the required modules are found
|
|
#
|
|
# And the following targets:
|
|
# - For each specified module XXX (System, Window, Graphics, Network, Audio, Main):
|
|
# - SFML::XXX
|
|
# The SFML targets are the same for both Debug and Release build configurations and will automatically provide
|
|
# correct settings based on your currently active build configuration. The SFML targets name also do not change
|
|
# when using dynamic or static SFML libraries.
|
|
#
|
|
# When linking against a SFML target, you do not need to specify indirect dependencies. For example, linking
|
|
# against SFML::Graphics will also automatically link against SFML::Window and SFML::System.
|
|
#
|
|
# example:
|
|
# find_package(SFML 3 COMPONENTS Graphics Audio REQUIRED)
|
|
# add_executable(myapp ...)
|
|
# target_link_libraries(myapp PRIVATE SFML::Graphics SFML::Audio)
|
|
|
|
if(NOT SFML_FIND_COMPONENTS)
|
|
message(FATAL_ERROR "find_package(SFML) called with no component")
|
|
endif()
|
|
|
|
set(FIND_SFML_PATHS
|
|
"${CMAKE_CURRENT_LIST_DIR}/../.."
|
|
${SFML_ROOT}
|
|
$ENV{SFML_ROOT}
|
|
~/Library/Frameworks
|
|
/Library/Frameworks
|
|
/usr/local
|
|
/usr
|
|
/sw
|
|
/opt/local
|
|
/opt/csw
|
|
/opt)
|
|
|
|
find_path(SFML_DOC_DIR SFML.tag
|
|
PATH_SUFFIXES SFML/doc share/doc/SFML
|
|
PATHS ${FIND_SFML_PATHS})
|
|
|
|
|
|
# Update requested components (eg. request window component if graphics component was requested)
|
|
set(FIND_SFML_SYSTEM_DEPENDENCIES "")
|
|
set(FIND_SFML_MAIN_DEPENDENCIES "")
|
|
set(FIND_SFML_AUDIO_DEPENDENCIES System)
|
|
set(FIND_SFML_NETWORK_DEPENDENCIES System)
|
|
set(FIND_SFML_WINDOW_DEPENDENCIES System)
|
|
set(FIND_SFML_GRAPHICS_DEPENDENCIES Window System)
|
|
set(FIND_SFML_ADDITIONAL_COMPONENTS "")
|
|
foreach(component ${SFML_FIND_COMPONENTS})
|
|
string(TOUPPER "${component}" UPPER_COMPONENT)
|
|
list(APPEND FIND_SFML_ADDITIONAL_COMPONENTS ${FIND_SFML_${UPPER_COMPONENT}_DEPENDENCIES})
|
|
endforeach()
|
|
list(APPEND SFML_FIND_COMPONENTS ${FIND_SFML_ADDITIONAL_COMPONENTS})
|
|
list(REMOVE_DUPLICATES SFML_FIND_COMPONENTS)
|
|
|
|
# Choose which target definitions must be imported
|
|
if(SFML_STATIC_LIBRARIES)
|
|
set(SFML_IS_FRAMEWORK_INSTALL "@SFML_BUILD_FRAMEWORKS@")
|
|
if(SFML_IS_FRAMEWORK_INSTALL)
|
|
message(WARNING "Static frameworks are not supported by SFML. Clear SFML_ROOT cache entry, \
|
|
and either change SFML_STATIC_LIBRARIES or CMAKE_FIND_FRAMEWORK before calling find_package(SFML)")
|
|
endif()
|
|
set(config_name "Static")
|
|
else()
|
|
set(config_name "Shared")
|
|
endif()
|
|
set(targets_config_file "${CMAKE_CURRENT_LIST_DIR}/SFML${config_name}Targets.cmake")
|
|
|
|
# Generate imported targets for SFML and its dependencies
|
|
if(EXISTS "${targets_config_file}")
|
|
# Set SFML_FOUND to TRUE by default, may be overwritten by one of the includes below
|
|
set(SFML_FOUND TRUE)
|
|
include("${targets_config_file}")
|
|
include("${CMAKE_CURRENT_LIST_DIR}/SFMLConfigDependencies.cmake")
|
|
|
|
if(SFML_FOUND)
|
|
set(SFML_VERSION_IS_RELEASE @VERSION_IS_RELEASE@)
|
|
|
|
foreach(component ${SFML_FIND_COMPONENTS})
|
|
string(TOUPPER "${component}" UPPER_COMPONENT)
|
|
set(SFML_${UPPER_COMPONENT}_FOUND FALSE)
|
|
if(TARGET SFML::${component})
|
|
set(SFML_${UPPER_COMPONENT}_FOUND TRUE)
|
|
elseif(SFML_FIND_REQUIRED_${component})
|
|
set(FIND_SFML_ERROR "Found SFML but requested component '${component}' is missing in the config defined in ${SFML_ROOT}.")
|
|
set(SFML_FOUND FALSE)
|
|
endif()
|
|
endforeach()
|
|
endif()
|
|
else()
|
|
set(FIND_SFML_ERROR "Requested SFML configuration (${config_name}) was not found")
|
|
set(SFML_FOUND FALSE)
|
|
endif()
|
|
|
|
if(NOT SFML_FOUND)
|
|
if(SFML_FIND_REQUIRED)
|
|
# fatal error
|
|
message(FATAL_ERROR "${FIND_SFML_ERROR}")
|
|
elseif(NOT SFML_FIND_QUIETLY)
|
|
# error but continue
|
|
message(STATUS "${FIND_SFML_ERROR}")
|
|
endif()
|
|
endif()
|
|
|
|
if(SFML_FOUND AND NOT SFML_FIND_QUIETLY)
|
|
message(STATUS "Found SFML @PROJECT_VERSION@ in ${CMAKE_CURRENT_LIST_DIR}")
|
|
endif()
|