Salome HOME
Merge V8_4_BR branch.
[tools/configuration.git] / cmake / UsePyQt.cmake
1 # Copyright (C) 2012-2016  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
61 # NOTES:
62 #   - Input files are considered relative to the current source directory.
63 #   - Output files are generated in the current build directory.
64 #   - Macro automatically adds custom build target to generate output files
65
66 ####################################################################
67 MACRO(PYQT_WRAP_UIC outfiles)
68
69  PARSE_ARGUMENTS(PYQT_WRAP_UIC "TARGET_NAME" "" ${ARGN})
70
71  IF(NOT WIN32)
72
73   FOREACH(_input ${PYQT_WRAP_UIC_DEFAULT_ARGS})
74     GET_FILENAME_COMPONENT(_input_name ${_input} NAME)
75     STRING(REPLACE ".ui" "_ui.py" _input_name ${_input_name})
76     SET(_output ${CMAKE_CURRENT_BINARY_DIR}/${_input_name})
77     ADD_CUSTOM_COMMAND(
78       OUTPUT ${_output}
79       COMMAND ${PYQT_PYUIC_PATH} -o ${_output} ${CMAKE_CURRENT_SOURCE_DIR}/${_input}
80       MAIN_DEPENDENCY ${_input}
81       )
82     SET(${outfiles} ${${outfiles}} ${_output})
83   ENDFOREACH()
84   _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_UI_PY_FILES _uniqueTargetName)
85   ADD_CUSTOM_TARGET(${_uniqueTargetName} ALL DEPENDS ${${outfiles}})
86   IF(PYQT_WRAP_UIC_TARGET_NAME)
87     SET(${PYQT_WRAP_UIC_TARGET_NAME} ${_uniqueTargetName})
88   ENDIF(PYQT_WRAP_UIC_TARGET_NAME)
89
90  ELSE(NOT WIN32)
91
92 ####
93 # ANA: Workaround for the Microsoft Visual Studio 2010. Seems there is a bug in 
94 # the Microsoft Visual Studio 2010 or CMake 2.8.10.2: custom target doesn't work 
95 # for the list of the dependencies. It works only for the first dependency in the 
96 # list. So generate separate target for the each input file. This problem will be 
97 #investigated in the future.
98 ####
99
100   SET_PROPERTY(GLOBAL PROPERTY USE_FOLDERS ON)
101   _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_UI_PY_FILES _uniqueTargetName)
102   ADD_CUSTOM_TARGET(${_uniqueTargetName} ALL)
103   IF(PYQT_WRAP_UIC_TARGET_NAME)
104     SET(${PYQT_WRAP_UIC_TARGET_NAME} ${_uniqueTargetName})
105   ENDIF(PYQT_WRAP_UIC_TARGET_NAME)
106   SET_TARGET_PROPERTIES(${_uniqueTargetName} PROPERTIES FOLDER PYQT_WRAP_UIC_TARGETS)
107   FOREACH(_input ${PYQT_WRAP_UIC_DEFAULT_ARGS})
108     GET_FILENAME_COMPONENT(_input_name ${_input} NAME)
109     STRING(REPLACE ".ui" "_ui.py" _input_name ${_input_name})
110     SET(_output ${CMAKE_CURRENT_BINARY_DIR}/${_input_name})
111     _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_UI_PY_FILES _TgName)
112     ADD_CUSTOM_TARGET(${_TgName} ${PYQT_PYUIC_PATH} -o ${_output} ${CMAKE_CURRENT_SOURCE_DIR}/${_input}
113       DEPENDS ${_input}
114       )
115     SET_TARGET_PROPERTIES(${_TgName} PROPERTIES FOLDER PYQT_WRAP_UIC_TARGETS)
116     ADD_DEPENDENCIES(${_uniqueTargetName} ${_TgName})
117     SET(${outfiles} ${${outfiles}} ${_output})
118   ENDFOREACH()
119  ENDIF(NOT WIN32)
120 ENDMACRO(PYQT_WRAP_UIC)
121
122 ####################################################################
123 #
124 # PYQT_WRAP_SIP macro
125 #
126 # Generate C++ wrappings for *.sip files by processing them with sip.
127 #
128 # USAGE: PYQT_WRAP_SIP(output_files sip_file [sip_file...] [OPTIONS options] [SOURCES sources])
129 #
130 # NOTES: See SIP_WRAP_SIP macro from UseSIP.cmake for the usage description.
131
132 ####################################################################
133 MACRO(PYQT_WRAP_SIP outfiles)
134   SIP_WRAP_SIP(${outfiles} ${ARGN} OPTIONS ${PYQT_SIPFLAGS})
135 ENDMACRO(PYQT_WRAP_SIP)
136
137 ####################################################################
138 #
139 # PYQT_WRAP_QRC macro
140 #
141 # Generate Python wrappings for *.qrc files by processing them with pyrcc5.
142 #
143 # USAGE: PYQT_WRAP_QRC(output_files qrc_files)
144 #
145 # ARGUMENTS:
146 #   output_files [out] variable where output file names are listed to
147 #   qrc_files  [in]  list of *.qrc files
148
149 # NOTES:
150 #   - Input files are considered relative to the current source directory.
151 #   - Output files are generated in the current build directory.
152 #   - Macro automatically adds custom build target to generate output files
153
154 ####################################################################
155
156 MACRO(PYQT_WRAP_QRC outfiles)
157   FOREACH(_input ${ARGN})
158     GET_FILENAME_COMPONENT(_input_name ${_input} NAME)
159     STRING(REPLACE ".qrc" "_qrc.py" _input_name ${_input_name})
160     SET(_output ${CMAKE_CURRENT_BINARY_DIR}/${_input_name})
161     ADD_CUSTOM_COMMAND(
162       OUTPUT ${_output}
163       COMMAND ${PYQT_PYRCC_PATH} -o ${_output} ${CMAKE_CURRENT_SOURCE_DIR}/${_input}
164       MAIN_DEPENDENCY ${_input}
165       )
166     SET(${outfiles} ${${outfiles}} ${_output})
167   ENDFOREACH()
168   _PYQT_WRAP_GET_UNIQUE_TARGET_NAME(BUILD_QRC_PY_FILES _uniqueTargetName)
169   ADD_CUSTOM_TARGET(${_uniqueTargetName} ALL DEPENDS ${${outfiles}})
170 ENDMACRO(PYQT_WRAP_QRC)