cmake/UsePyQt.cmake

   1 # Copyright (C) 2012-2021  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19 # Author: Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  20
  21 INCLUDE(UseSIP)
  22
  23 ####################################################################
  24 #
  25 # _PYQT_WRAP_GET_UNIQUE_TARGET_NAME: internal function
  26 #
  27 # Used to generate unique custom target name for usage in
  28 # PYQT_WRAP_UIC macro.
  29 #
  30 # USAGE: _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(prefix unique_name)
  31 #
  32 # ARGUMENTS:
  33 #   prefix [in] prefix for the name
  34 #   unique_name [out] unique name generated by function
  35 #
  36 ####################################################################
  37 FUNCTION(_PYQT_WRAP_GET_UNIQUE_TARGET_NAME name unique_name)
  38    SET(_propertyName "_PYQT_WRAP_UNIQUE_COUNTER_${name}")
  39    GET_PROPERTY(_currentCounter GLOBAL PROPERTY "${_propertyName}")
  40    IF(NOT _currentCounter)
  41       SET(_currentCounter 1)
  42    ENDIF()
  43    SET(${unique_name} "${name}_${_currentCounter}" PARENT_SCOPE)
  44    MATH(EXPR _currentCounter "${_currentCounter} + 1")
  45    SET_PROPERTY(GLOBAL PROPERTY ${_propertyName} ${_currentCounter} )
  46 ENDFUNCTION()
  47
  48 ####################################################################
  49 #
  50 # PYQT_WRAP_UIC macro
  51 #
  52 # Create Python modules by processing input *.ui (Qt designer) files with
  53 # PyQt pyuic tool.
  54 #
  55 # USAGE: PYQT_WRAP_UIC(output_files pyuic_files)
  56 #
  57 # ARGUMENTS:
  58 #   output_files [out] variable where output file names are listed to
  59 #   pyuic_files  [in]  list of *.ui files
  60 #   options      [in]  additional options to be specified to pyuic
  61 #
  62 # NOTES:
  63 #   - Input files are considered relative to the current source directory.
  64 #   - Output files are generated in the current build directory.
  65 #   - Macro automatically adds custom build target to generate output files
  66 #
  67 ####################################################################
  68 MACRO(PYQT_WRAP_UIC outfiles)
  69  SET(_output)
  70
  71  PARSE_ARGUMENTS(PYQT_WRAP_UIC "TARGET_NAME;OPTIONS" "" ${ARGN})
  72
  73  IF(NOT WIN32)
  74   FOREACH(_input ${PYQT_WRAP_UIC_DEFAULT_ARGS})
  75     GET_FILENAME_COMPONENT(_input_name ${_input} NAME)
  76     STRING(REPLACE ".ui" "_ui.py" _input_name ${_input_name})
  77     SET(_output ${CMAKE_CURRENT_BINARY_DIR}/${_input_name})
  78     ADD_CUSTOM_COMMAND(
  79       OUTPUT ${_output}
  80       COMMAND ${PYQT_PYUIC_PATH} ${PYQT_WRAP_UIC_OPTIONS} -o ${_output} ${CMAKE_CURRENT_SOURCE_DIR}/${_input}
  81       MAIN_DEPENDENCY ${_input}
  82       )
  83     SET(${outfiles} ${${outfiles}} ${_output})
  84   ENDFOREACH()
  85   _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_UI_PY_FILES _uniqueTargetName)
  86   ADD_CUSTOM_TARGET(${_uniqueTargetName} ALL DEPENDS ${${outfiles}})
  87   IF(PYQT_WRAP_UIC_TARGET_NAME)
  88     SET(${PYQT_WRAP_UIC_TARGET_NAME} ${_uniqueTargetName})
  89   ENDIF(PYQT_WRAP_UIC_TARGET_NAME)
  90
  91  ELSE(NOT WIN32)
  92
  93 ####
  94 # ANA: Workaround for the Microsoft Visual Studio 2010. Seems there is a bug in
  95 # the Microsoft Visual Studio 2010 or CMake 2.8.10.2: custom target doesn't work
  96 # for the list of the dependencies. It works only for the first dependency in the
  97 # list. So generate separate target for the each input file. This problem will be
  98 #investigated in the future.
  99 ####
 100
 101   SET_PROPERTY(GLOBAL PROPERTY USE_FOLDERS ON)
 102   _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_UI_PY_FILES _uniqueTargetName)
 103   ADD_CUSTOM_TARGET(${_uniqueTargetName} ALL)
 104   IF(PYQT_WRAP_UIC_TARGET_NAME)
 105     SET(${PYQT_WRAP_UIC_TARGET_NAME} ${_uniqueTargetName})
 106   ENDIF(PYQT_WRAP_UIC_TARGET_NAME)
 107   SET_TARGET_PROPERTIES(${_uniqueTargetName} PROPERTIES FOLDER PYQT_WRAP_UIC_TARGETS)
 108   FOREACH(_input ${PYQT_WRAP_UIC_DEFAULT_ARGS})
 109     GET_FILENAME_COMPONENT(_input_name ${_input} NAME)
 110     STRING(REPLACE ".ui" "_ui.py" _input_name ${_input_name})
 111     SET(_output ${CMAKE_CURRENT_BINARY_DIR}/${_input_name})
 112     _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_UI_PY_FILES _TgName)
 113     ADD_CUSTOM_TARGET(${_TgName} ${PYQT_PYUIC_PATH} -o ${_output} ${CMAKE_CURRENT_SOURCE_DIR}/${_input}
 114       DEPENDS ${_input}
 115       )
 116     SET_TARGET_PROPERTIES(${_TgName} PROPERTIES FOLDER PYQT_WRAP_UIC_TARGETS)
 117     ADD_DEPENDENCIES(${_uniqueTargetName} ${_TgName})
 118     SET(${outfiles} ${${outfiles}} ${_output})
 119   ENDFOREACH()
 120  ENDIF(NOT WIN32)
 121 ENDMACRO(PYQT_WRAP_UIC)
 122
 123 ####################################################################
 124 #
 125 # PYQT_WRAP_SIP macro
 126 #
 127 # Generate C++ wrappings for *.sip files by processing them with sip.
 128 #
 129 # USAGE: PYQT_WRAP_SIP(output_files sip_file [sip_file...] [OPTIONS options] [SOURCES sources])
 130 #
 131 # NOTES: See SIP_WRAP_SIP macro from UseSIP.cmake for the usage description.
 132 #
 133 ####################################################################
 134 MACRO(PYQT_WRAP_SIP outfiles)
 135   SIP_WRAP_SIP(${outfiles} ${ARGN} OPTIONS ${PYQT_SIPFLAGS})
 136 ENDMACRO(PYQT_WRAP_SIP)
 137
 138 ####################################################################
 139 #
 140 # PYQT_WRAP_QRC macro
 141 #
 142 # Generate Python wrappings for *.qrc files by processing them with pyrcc5.
 143 #
 144 # USAGE: PYQT_WRAP_QRC(output_files qrc_files)
 145 #
 146 # ARGUMENTS:
 147 #   output_files [out] variable where output file names are listed to
 148 #   qrc_files  [in]  list of *.qrc files
 149 #
 150 # NOTES:
 151 #   - Input files are considered relative to the current source directory.
 152 #   - Output files are generated in the current build directory.
 153 #   - Macro automatically adds custom build target to generate output files
 154 #
 155 ####################################################################
 156
 157 MACRO(PYQT_WRAP_QRC outfiles)
 158   FOREACH(_input ${ARGN})
 159     GET_FILENAME_COMPONENT(_input_name ${_input} NAME)
 160     STRING(REPLACE ".qrc" "_qrc.py" _input_name ${_input_name})
 161     SET(_output ${CMAKE_CURRENT_BINARY_DIR}/${_input_name})
 162     ADD_CUSTOM_COMMAND(
 163       OUTPUT ${_output}
 164       COMMAND ${PYQT_PYRCC_PATH} -o ${_output} ${CMAKE_CURRENT_SOURCE_DIR}/${_input}
 165       MAIN_DEPENDENCY ${_input}
 166       )
 167     SET(${outfiles} ${${outfiles}} ${_output})
 168   ENDFOREACH()
 169   _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_QRC_PY_FILES _uniqueTargetName)
 170   ADD_CUSTOM_TARGET(${_uniqueTargetName} ALL DEPENDS ${${outfiles}})
 171 ENDMACRO(PYQT_WRAP_QRC)