Adds functions so targets can define install directories/files
This commit is contained in:
Esteban Papp
GitHub
+110
-1
@@ -9,4 +9,113 @@
|
||||
if(NOT INSTALLED_ENGINE)
|
||||
ly_get_absolute_pal_filename(pal_dir ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Platform/${PAL_PLATFORM_NAME})
|
||||
include(${pal_dir}/Install_${PAL_PLATFORM_NAME_LOWERCASE}.cmake)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
#! ly_install_directory: specifies a directory to be copied to the install layout at install time
|
||||
#
|
||||
# \arg:DIRECTORIES directories to install
|
||||
# \arg:DESTINATION (optional) destination to install the directory to (relative to CMAKE_PREFIX_PATH)
|
||||
# \arg:EXCLUDE_PATTERNS (optional) patterns to exclude
|
||||
#
|
||||
# \notes:
|
||||
# - refer to cmake's install(DIRECTORY documentation for more information
|
||||
# - If the directory contains programs/scripts, exclude them from this call and add a specific ly_install_files with
|
||||
# PROGRAMS set. This is necessary to set the proper execution permissions.
|
||||
# - This function will automatically filter out __pycache__, *.egg-info, CMakeLists.txt, *.cmake files. If those files
|
||||
# need to be installed, use ly_install_files.
|
||||
#
|
||||
function(ly_install_directory)
|
||||
|
||||
set(options)
|
||||
set(oneValueArgs DESTINATION)
|
||||
set(multiValueArgs DIRECTORIES EXCLUDE_PATTERNS)
|
||||
|
||||
cmake_parse_arguments(ly_install_directory "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
||||
|
||||
if(NOT ly_install_directory_DIRECTORIES)
|
||||
message(FATAL_ERROR "You must provide at least a directory to install")
|
||||
endif()
|
||||
|
||||
foreach(directory ${ly_install_directory_DIRECTORIES})
|
||||
|
||||
cmake_path(ABSOLUTE_PATH directory)
|
||||
|
||||
if(NOT ly_install_directory_DESTINATION)
|
||||
# maintain the same structure relative to LY_ROOT_FOLDER
|
||||
set(ly_install_directory_DESTINATION ${directory})
|
||||
if(${ly_install_directory_DESTINATION} STREQUAL ".")
|
||||
set(ly_install_directory_DESTINATION ${CMAKE_CURRENT_LIST_DIR})
|
||||
else()
|
||||
cmake_path(ABSOLUTE_PATH ly_install_directory_DESTINATION BASE_DIRECTORY ${CMAKE_CURRENT_LIST_DIR})
|
||||
endif()
|
||||
# take out the last directory since install asks for the destination of the folder, without including the fodler itself
|
||||
cmake_path(GET ly_install_directory_DESTINATION PARENT_PATH ly_install_directory_DESTINATION)
|
||||
cmake_path(RELATIVE_PATH ly_install_directory_DESTINATION BASE_DIRECTORY ${LY_ROOT_FOLDER})
|
||||
endif()
|
||||
|
||||
unset(exclude_patterns)
|
||||
if(ly_install_directory_EXCLUDE_PATTERNS)
|
||||
foreach(exclude_pattern ${ly_install_directory_EXCLUDE_PATTERNS})
|
||||
list(APPEND exclude_patterns PATTERN ${exclude_pattern} EXCLUDE)
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
# Exclude cmake since that has to be generated
|
||||
list(APPEND exclude_patterns PATTERN CMakeLists.txt EXCLUDE)
|
||||
list(APPEND exclude_patterns PATTERN *.cmake EXCLUDE)
|
||||
|
||||
# Exclude python-related things that dont need to be installed
|
||||
list(APPEND exclude_patterns PATTERN __pycache__ EXCLUDE)
|
||||
list(APPEND exclude_patterns PATTERN *.egg-info EXCLUDE)
|
||||
|
||||
install(DIRECTORY ${directory}
|
||||
DESTINATION ${ly_install_directory_DESTINATION}
|
||||
COMPONENT ${CMAKE_INSTALL_DEFAULT_COMPONENT_NAME} # use the deafult for the time being
|
||||
${exclude_patterns}
|
||||
)
|
||||
endforeach()
|
||||
|
||||
endfunction()
|
||||
|
||||
#! ly_install_files: specifies files to be copied to the install layout at install time
|
||||
#
|
||||
# \arg:FILES files to install
|
||||
# \arg:DESTINATION destination to install the directory to (relative to CMAKE_PREFIX_PATH)
|
||||
# \arg:PROGRAMS (optional) indicates if the files are programs that should be installed with EXECUTE permissions
|
||||
#
|
||||
# \notes:
|
||||
# - refer to cmake's install(FILES/PROGRAMS documentation for more information
|
||||
#
|
||||
function(ly_install_files)
|
||||
|
||||
set(options PROGRAMS)
|
||||
set(oneValueArgs DESTINATION)
|
||||
set(multiValueArgs FILES)
|
||||
|
||||
cmake_parse_arguments(ly_install_files "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
||||
|
||||
if(NOT ly_install_files_FILES)
|
||||
message(FATAL_ERROR "You must provide a list of files to install")
|
||||
endif()
|
||||
if(NOT ly_install_files_DESTINATION)
|
||||
message(FATAL_ERROR "You must provide a destination to install files to")
|
||||
endif()
|
||||
|
||||
unset(files)
|
||||
foreach(file ${ly_install_files_FILES})
|
||||
cmake_path(ABSOLUTE_PATH file)
|
||||
list(APPEND files ${file})
|
||||
endforeach()
|
||||
|
||||
if(ly_install_files_PROGRAMS)
|
||||
set(install_type PROGRAMS)
|
||||
else()
|
||||
set(install_type FILES)
|
||||
endif()
|
||||
|
||||
install(${install_type} ${files}
|
||||
DESTINATION ${ly_install_files_DESTINATION}
|
||||
COMPONENT ${CMAKE_INSTALL_DEFAULT_COMPONENT_NAME} # use the default for the time being
|
||||
)
|
||||
|
||||
endfunction()
|
||||
@@ -355,9 +355,16 @@ function(ly_setup_o3de_install)
|
||||
|
||||
ly_setup_subdirectories()
|
||||
ly_setup_cmake_install()
|
||||
ly_setup_target_generator()
|
||||
ly_setup_runtime_dependencies()
|
||||
ly_setup_others()
|
||||
ly_setup_assets()
|
||||
|
||||
# Misc
|
||||
install(FILES
|
||||
${LY_ROOT_FOLDER}/ctest_pytest.ini
|
||||
${LY_ROOT_FOLDER}/LICENSE.txt
|
||||
${LY_ROOT_FOLDER}/README.md
|
||||
DESTINATION .
|
||||
)
|
||||
|
||||
endfunction()
|
||||
|
||||
@@ -488,75 +495,12 @@ endfunction()"
|
||||
|
||||
list(REMOVE_DUPLICATES runtime_commands)
|
||||
list(JOIN runtime_commands " " runtime_commands_str) # the spaces are just to see the right identation in the cmake_install.cmake file
|
||||
install(CODE "${runtime_commands_str}"
|
||||
)
|
||||
install(CODE "${runtime_commands_str}")
|
||||
|
||||
endfunction()
|
||||
|
||||
#! ly_setup_others: install directories required by the engine
|
||||
function(ly_setup_others)
|
||||
|
||||
# List of directories we want to install relative to engine root
|
||||
set(DIRECTORIES_TO_INSTALL Tools/LyTestTools Tools/RemoteConsole)
|
||||
foreach(dir ${DIRECTORIES_TO_INSTALL})
|
||||
|
||||
get_filename_component(install_path ${dir} DIRECTORY)
|
||||
if (NOT install_path)
|
||||
set(install_path .)
|
||||
endif()
|
||||
|
||||
install(DIRECTORY "${LY_ROOT_FOLDER}/${dir}"
|
||||
DESTINATION ${install_path}
|
||||
PATTERN "__pycache__" EXCLUDE
|
||||
)
|
||||
|
||||
endforeach()
|
||||
|
||||
# Scripts
|
||||
file(GLOB o3de_scripts "${LY_ROOT_FOLDER}/scripts/o3de.*")
|
||||
install(PROGRAMS
|
||||
${o3de_scripts}
|
||||
DESTINATION ./scripts
|
||||
)
|
||||
|
||||
install(DIRECTORY
|
||||
${LY_ROOT_FOLDER}/scripts/bundler
|
||||
${LY_ROOT_FOLDER}/scripts/o3de
|
||||
DESTINATION ./scripts
|
||||
PATTERN "__pycache__" EXCLUDE
|
||||
PATTERN "CMakeLists.txt" EXCLUDE
|
||||
PATTERN "tests" EXCLUDE
|
||||
)
|
||||
|
||||
install(DIRECTORY "${LY_ROOT_FOLDER}/python"
|
||||
DESTINATION .
|
||||
REGEX "downloaded_packages" EXCLUDE
|
||||
REGEX "runtime" EXCLUDE
|
||||
REGEX ".*$\.sh" EXCLUDE
|
||||
)
|
||||
|
||||
# For Mac/Linux shell scripts need to be installed as PROGRAMS to have execute permission
|
||||
file(GLOB python_scripts "${LY_ROOT_FOLDER}/python/*.sh")
|
||||
install(PROGRAMS
|
||||
${python_scripts}
|
||||
DESTINATION ./python
|
||||
)
|
||||
|
||||
# Registry
|
||||
install(DIRECTORY
|
||||
${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/Registry
|
||||
DESTINATION ./${runtime_output_directory}/${PAL_PLATFORM_NAME}/$<CONFIG>
|
||||
)
|
||||
install(DIRECTORY
|
||||
${LY_ROOT_FOLDER}/Registry
|
||||
DESTINATION .
|
||||
)
|
||||
|
||||
# Engine Source Assets
|
||||
install(DIRECTORY
|
||||
${LY_ROOT_FOLDER}/Assets
|
||||
DESTINATION .
|
||||
)
|
||||
#! ly_setup_assets: install asset directories required by the engine
|
||||
function(ly_setup_assets)
|
||||
|
||||
# Gem Source Assets and configuration files
|
||||
# Find all gem directories relative to the CMake Source Dir
|
||||
@@ -645,80 +589,4 @@ function(ly_setup_others)
|
||||
|
||||
endforeach()
|
||||
|
||||
# Templates
|
||||
install(DIRECTORY
|
||||
${LY_ROOT_FOLDER}/Templates
|
||||
DESTINATION .
|
||||
)
|
||||
|
||||
# Misc
|
||||
install(FILES
|
||||
${LY_ROOT_FOLDER}/ctest_pytest.ini
|
||||
${LY_ROOT_FOLDER}/LICENSE.txt
|
||||
${LY_ROOT_FOLDER}/README.md
|
||||
DESTINATION .
|
||||
)
|
||||
|
||||
endfunction()
|
||||
|
||||
#! ly_setup_target_generator: install source files needed for project launcher generation
|
||||
function(ly_setup_target_generator)
|
||||
|
||||
install(FILES
|
||||
${LY_ROOT_FOLDER}/Code/LauncherUnified/launcher_generator.cmake
|
||||
${LY_ROOT_FOLDER}/Code/LauncherUnified/launcher_project_files.cmake
|
||||
${LY_ROOT_FOLDER}/Code/LauncherUnified/LauncherProject.cpp
|
||||
${LY_ROOT_FOLDER}/Code/LauncherUnified/StaticModules.in
|
||||
DESTINATION LauncherGenerator
|
||||
)
|
||||
install(DIRECTORY ${LY_ROOT_FOLDER}/Code/LauncherUnified/Platform
|
||||
DESTINATION LauncherGenerator
|
||||
)
|
||||
install(FILES ${LY_ROOT_FOLDER}/Code/LauncherUnified/FindLauncherGenerator.cmake
|
||||
DESTINATION cmake
|
||||
)
|
||||
|
||||
endfunction()
|
||||
|
||||
#! ly_add_install_paths: Adds the list of path to copy to the install layout relative to the same folder
|
||||
# \arg:PATHS - Paths to copy over to the install layout. The DESTINATION sub argument is optional
|
||||
# The INPUT sub-argument is required
|
||||
# \arg:BASE_DIRECTORY(Optional) - Absolute path where a relative path from the each input path will be
|
||||
# based off of. Defaults to LY_ROOT_FOLDER if not supplied
|
||||
function(ly_add_install_paths)
|
||||
set(options)
|
||||
set(oneValueArgs BASE_DIRECTORY)
|
||||
set(multiValueArgs PATHS)
|
||||
cmake_parse_arguments(ly_add_install_paths "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
||||
if(NOT ly_add_install_paths_PATHS)
|
||||
message(FATAL_ERROR "ly_add_install_paths requires at least one input path to copy to the destination")
|
||||
endif()
|
||||
|
||||
# The default is the "." directory if not supplied
|
||||
if(NOT ly_add_install_paths_BASE_DIRECTORY)
|
||||
cmake_path(SET ly_add_install_paths_BASE_DIRECTORY ${LY_ROOT_FOLDER})
|
||||
endif()
|
||||
|
||||
# Separate each path into an INPUT and DESTINATION parameter
|
||||
set(options)
|
||||
set(oneValueArgs INPUT DESTINATION)
|
||||
set(multiValueArgs)
|
||||
foreach(install_path IN LISTS ly_add_install_paths_PATHS)
|
||||
string(REPLACE " " ";" install_path ${install_path})
|
||||
cmake_parse_arguments(install "${options}" "${oneValueArgs}" "${multiValueArgs}" ${install_path})
|
||||
if(NOT install_DESTINATION)
|
||||
ly_get_engine_relative_source_dir(${install_INPUT} rel_to_root_input_path
|
||||
BASE_DIRECTORY ${ly_add_install_paths_BASE_DIRECTORY})
|
||||
cmake_path(GET rel_to_root_input_path PARENT_PATH install_DESTINATION)
|
||||
endif()
|
||||
if(NOT install_DESTINATION)
|
||||
cmake_path(SET install_DESTINATION .)
|
||||
endif()
|
||||
if(IS_DIRECTORY ${install_INPUT})
|
||||
install(DIRECTORY ${install_INPUT} DESTINATION ${install_DESTINATION})
|
||||
elseif(EXISTS ${install_INPUT})
|
||||
install(FILES ${install_INPUT} DESTINATION ${install_DESTINATION})
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
endfunction()
|
||||
|
||||
Reference in New Issue
Block a user