From 4d82ee992992251bcadf0097a4df60fe7c3b7ef8 Mon Sep 17 00:00:00 2001 From: Alexandru Croitor Date: Wed, 28 Nov 2018 14:57:31 +0100 Subject: Make it hard to use the create_pyside_module function incorrectly Rewrite the function to use keyword arguments instead of ordered arguments. Also add error detection when required arguments are not passed, or have a typo in them. Adjust all the module cmake files to use keyword arguments. Change-Id: I7bb0c6561d7dca1e7f673e29eb457da50ae5df04 Reviewed-by: Qt CI Bot Reviewed-by: Cristian Maureira-Fredes --- sources/pyside2/cmake/Macros/PySideModules.cmake | 136 ++++++++++++++--------- 1 file changed, 83 insertions(+), 53 deletions(-) (limited to 'sources/pyside2/cmake') diff --git a/sources/pyside2/cmake/Macros/PySideModules.cmake b/sources/pyside2/cmake/Macros/PySideModules.cmake index dd4845033..42ba8e8a0 100644 --- a/sources/pyside2/cmake/Macros/PySideModules.cmake +++ b/sources/pyside2/cmake/Macros/PySideModules.cmake @@ -1,3 +1,14 @@ +include(CMakeParseArguments) + +# A version of cmake_parse_arguments that makes sure all arguments are processed and errors out +# with a message about ${type} having received unknown arguments. +macro(pyside_parse_all_arguments prefix type flags options multiopts) + cmake_parse_arguments(${prefix} "${flags}" "${options}" "${multiopts}" ${ARGN}) + if(DEFINED ${prefix}_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "Unknown arguments were passed to ${type} (${${prefix}_UNPARSED_ARGUMENTS}).") + endif() +endmacro() + macro(make_path varname) # accepts any number of path variables string(REPLACE ";" "${PATH_SEP}" ${varname} "${ARGN}") @@ -7,40 +18,59 @@ macro(unmake_path varname) string(REPLACE "${PATH_SEP}" ";" ${varname} "${ARGN}") endmacro() -macro(create_pyside_module - module_name - module_include_dir - module_libraries - module_deps - module_typesystem_path - module_sources - module_static_sources - #module_typesystem_name - #module_dropped_entries - #module_glue_sources - ) - string(TOLOWER ${module_name} _module) - string(REGEX REPLACE ^qt "" _module ${_module}) - if(${ARGC} GREATER 7) - set (typesystem_name ${ARGV7}) - else() - set (typesystem_name "") +# Sample usage +# create_pyside_module(NAME QtGui +# INCLUDE_DIRS QtGui_include_dirs +# LIBRARIES QtGui_libraries +# DEPS QtGui_deps +# TYPESYSTEM_PATH QtGui_SOURCE_DIR +# SOURCES QtGui_SRC +# STATIC_SOURCES QtGui_static_sources +# TYPESYSTEM_NAME ${QtGui_BINARY_DIR}/typesystem_gui.xml +# DROPPED_ENTRIES QtGui_DROPPED_ENTRIES +# GLUE_SOURCES QtGui_glue_sources) +macro(create_pyside_module) + pyside_parse_all_arguments( + "module" # Prefix + "create_pyside_module" # Macro name + "" # Flags + "NAME;TYPESYSTEM_PATH;TYPESYSTEM_NAME" # Single value + "INCLUDE_DIRS;LIBRARIES;DEPS;SOURCES;STATIC_SOURCES;DROPPED_ENTRIES;GLUE_SOURCES" # Multival + ${ARGN} # Number of arguments given when the macros is called + ) + + if ("${module_NAME}" STREQUAL "") + message(FATAL_ERROR "create_pyside_module needs a NAME value.") + endif() + if ("${module_INCLUDE_DIRS}" STREQUAL "") + message(FATAL_ERROR "create_pyside_module needs at least one INCLUDE_DIRS value.") endif() - if(${ARGC} GREATER 8) - string(REPLACE ";" "\\;" dropped_entries "${${ARGV8}}") + if ("${module_TYPESYSTEM_PATH}" STREQUAL "") + message(FATAL_ERROR "create_pyside_module needs a TYPESYSTEM_PATH value.") + endif() + if ("${module_SOURCES}" STREQUAL "") + message(FATAL_ERROR "create_pyside_module needs at least one SOURCES value.") + endif() + + string(TOLOWER ${module_NAME} _module) + string(REGEX REPLACE ^qt "" _module ${_module}) + + if(${module_DROPPED_ENTRIES}) + string(REPLACE ";" "\\;" dropped_entries "${${module_DROPPED_ENTRIES}}") else() set (dropped_entries "") endif() - if(${ARGC} GREATER 9) - set (glue_sources "${${ARGV9}}") + + if(${module_GLUE_SOURCES}) + set (module_GLUE_SOURCES "${${module_GLUE_SOURCES}}") else() - set (glue_sources "") + set (module_GLUE_SOURCES "") endif() - if (NOT EXISTS ${typesystem_name}) + if (NOT EXISTS ${module_TYPESYSTEM_NAME}) set(typesystem_path ${CMAKE_CURRENT_SOURCE_DIR}/typesystem_${_module}.xml) else() - set(typesystem_path ${typesystem_name}) + set(typesystem_path ${module_TYPESYSTEM_NAME}) endif() # Create typesystem XML dependencies list, so that whenever they change, shiboken is invoked @@ -50,7 +80,7 @@ macro(create_pyside_module get_filename_component(typesystem_root "${CMAKE_CURRENT_SOURCE_DIR}" DIRECTORY) - set(deps ${module_name} ${${module_deps}}) + set(deps ${module_NAME} ${${module_DEPS}}) foreach(dep ${deps}) set(glob_expression "${typesystem_root}/${dep}/*.xml") file(GLOB type_system_files ${glob_expression}) @@ -75,73 +105,73 @@ macro(create_pyside_module get_filename_component(pyside_binary_dir ${CMAKE_CURRENT_BINARY_DIR} DIRECTORY) # Install module glue files. - string(TOLOWER ${module_name} lower_module_name) - set(${module_name}_glue "${CMAKE_CURRENT_SOURCE_DIR}/../glue/${lower_module_name}.cpp") + string(TOLOWER ${module_NAME} lower_module_name) + set(${module_NAME}_glue "${CMAKE_CURRENT_SOURCE_DIR}/../glue/${lower_module_name}.cpp") set(${module_name}_glue_dependency "") - if(EXISTS ${${module_name}_glue}) - install(FILES ${${module_name}_glue} DESTINATION share/PySide2${pyside2_SUFFIX}/glue) - set(${module_name}_glue_dependency ${${module_name}_glue}) + if(EXISTS ${${module_NAME}_glue}) + install(FILES ${${module_NAME}_glue} DESTINATION share/PySide2${pyside2_SUFFIX}/glue) + set(${module_NAME}_glue_dependency ${${module_NAME}_glue}) endif() # Install standalone glue files into typesystems subfolder, so that the resolved relative # paths remain correct. - if (glue_sources) - install(FILES ${glue_sources} DESTINATION share/PySide2${pyside2_SUFFIX}/typesystems/glue) + if (module_GLUE_SOURCES) + install(FILES ${module_GLUE_SOURCES} DESTINATION share/PySide2${pyside2_SUFFIX}/typesystems/glue) endif() add_custom_command( OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/mjb_rejected_classes.log" - BYPRODUCTS ${${module_sources}} + BYPRODUCTS ${${module_SOURCES}} COMMAND "${SHIBOKEN_BINARY}" ${GENERATOR_EXTRA_FLAGS} - "${pyside2_BINARY_DIR}/${module_name}_global.h" + "${pyside2_BINARY_DIR}/${module_NAME}_global.h" --include-paths=${shiboken_include_dirs} ${shiboken_framework_include_dirs_option} - --typesystem-paths=${pyside_binary_dir}${PATH_SEP}${pyside2_SOURCE_DIR}${PATH_SEP}${${module_typesystem_path}} + --typesystem-paths=${pyside_binary_dir}${PATH_SEP}${pyside2_SOURCE_DIR}${PATH_SEP}${${module_TYPESYSTEM_PATH}} --output-directory=${CMAKE_CURRENT_BINARY_DIR} --license-file=${CMAKE_CURRENT_SOURCE_DIR}/../licensecomment.txt ${typesystem_path} --api-version=${SUPPORTED_QT_VERSION} --drop-type-entries="${dropped_entries}" DEPENDS ${total_type_system_files} - ${glue_sources} - ${${module_name}_glue_dependency} + ${module_GLUE_SOURCES} + ${${module_NAME}_glue_dependency} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} - COMMENT "Running generator for ${module_name}...") + COMMENT "Running generator for ${module_NAME}...") - include_directories(${module_name} ${${module_include_dir}} ${pyside2_SOURCE_DIR}) - add_library(${module_name} MODULE ${${module_sources}} ${${module_static_sources}}) - set_target_properties(${module_name} PROPERTIES + include_directories(${module_NAME} ${${module_INCLUDE_DIRS}} ${pyside2_SOURCE_DIR}) + add_library(${module_NAME} MODULE ${${module_SOURCES}} + ${${module_STATIC_SOURCES}}) + set_target_properties(${module_NAME} PROPERTIES PREFIX "" - OUTPUT_NAME "${module_name}${PYTHON_EXTENSION_SUFFIX}" + OUTPUT_NAME "${module_NAME}${PYTHON_EXTENSION_SUFFIX}" LIBRARY_OUTPUT_DIRECTORY ${pyside2_BINARY_DIR}) if(WIN32) - set_target_properties(${module_name} PROPERTIES SUFFIX ".pyd") + set_target_properties(${module_NAME} PROPERTIES SUFFIX ".pyd") # Sanitize windows.h as pulled by gl.h to prevent clashes with QAbstract3dAxis::min(), etc. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DNOMINMAX") endif() - target_link_libraries(${module_name} ${${module_libraries}}) - if(${module_deps}) - add_dependencies(${module_name} ${${module_deps}}) + target_link_libraries(${module_NAME} ${${module_LIBRARIES}}) + if(${module_DEPS}) + add_dependencies(${module_NAME} ${${module_DEPS}}) endif() - create_generator_target(${module_name}) + create_generator_target(${module_NAME}) # build type hinting stubs - add_custom_command( TARGET ${module_name} POST_BUILD + add_custom_command( TARGET ${module_NAME} POST_BUILD COMMAND "${SHIBOKEN_PYTHON_INTERPRETER}" "${CMAKE_CURRENT_SOURCE_DIR}/../support/generate_pyi.py" run --skip --sys-path "${CMAKE_BINARY_DIR}" "${CMAKE_BINARY_DIR}/../shiboken2/shibokenmodule" --lib-path "${CMAKE_BINARY_DIR}/libpyside" "${CMAKE_BINARY_DIR}/../shiboken2/libshiboken" ) # install - install(TARGETS ${module_name} LIBRARY DESTINATION "${PYTHON_SITE_PACKAGES}/PySide2") + install(TARGETS ${module_NAME} LIBRARY DESTINATION "${PYTHON_SITE_PACKAGES}/PySide2") install(DIRECTORY "${CMAKE_BINARY_DIR}/" DESTINATION "${PYTHON_SITE_PACKAGES}" OPTIONAL FILES_MATCHING PATTERN "*.pyi") - string(TOLOWER ${module_name} lower_module_name) - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/PySide2/${module_name}/pyside2_${lower_module_name}_python.h - DESTINATION include/PySide2${pyside2_SUFFIX}/${module_name}/) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/PySide2/${module_NAME}/pyside2_${lower_module_name}_python.h + DESTINATION include/PySide2${pyside2_SUFFIX}/${module_NAME}/) file(GLOB typesystem_files ${CMAKE_CURRENT_SOURCE_DIR}/typesystem_*.xml ${typesystem_path}) # Copy typesystem files and remove module names from the element -- cgit v1.2.3