module_generator/mod_tmpl.py

   1 # Copyright (C) 2009-2023  EDF
   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
  20 try:
  21   from string import Template
  22 except:
  23   from module_generator.compat import Template,set
  24
  25 application="""
  26 <application>
  27 <prerequisites path="${prerequisites}"/>
  28 <context path="${context}"/>
  29 ${resources}
  30 <env_modules>
  31 ${env_modules}
  32 </env_modules>
  33 <modules>
  34 ${modules}
  35 </modules>
  36 </application>
  37 """
  38 application=Template(application)
  39
  40 paco_configure="""\
  41 if test "x$$PaCO_ok" = "xno"; then
  42   AC_MSG_ERROR([PaCO++ is required],1)
  43 fi
  44 """
  45
  46 # CMakeLists.txt in root module directory
  47 # template parameters:
  48 #   module : name of the module
  49 #   module_min : module name with only lowercase
  50 #   compolibs : list of component libraries
  51 #   with_doc : ON|OFF
  52 #   with_gui : ON|OFF - module has its own GUI
  53 #   add_modules : code to find other modules
  54 #   major_version : major version of the module
  55 #   minor_version : minor version of the module
  56 #   patch_version : patch version of the module
  57 cmake_root_cpp = """
  58 CMAKE_MINIMUM_REQUIRED(VERSION 2.8.8 FATAL_ERROR)
  59
  60 # You can remove "Fortran" if you don't have any fortran component
  61 PROJECT(Salome${module} C CXX Fortran)
  62
  63 # Ensure a proper linker behavior:
  64 CMAKE_POLICY(SET CMP0003 NEW)
  65
  66 # Versioning
  67 # ===========
  68 # Project name, upper case
  69 STRING(TOUPPER $${PROJECT_NAME} PROJECT_NAME_UC)
  70
  71 SET($${PROJECT_NAME_UC}_MAJOR_VERSION ${major_version})
  72 SET($${PROJECT_NAME_UC}_MINOR_VERSION ${minor_version})
  73 SET($${PROJECT_NAME_UC}_PATCH_VERSION ${patch_version})
  74 SET($${PROJECT_NAME_UC}_VERSION
  75   $${$${PROJECT_NAME_UC}_MAJOR_VERSION}.$${$${PROJECT_NAME_UC}_MINOR_VERSION}.$${$${PROJECT_NAME_UC}_PATCH_VERSION})
  76 SET($${PROJECT_NAME_UC}_VERSION_DEV 1)
  77
  78 # ===================
  79 SET(CONFIGURATION_ROOT_DIR $$ENV{CONFIGURATION_ROOT_DIR} CACHE PATH "Path to the Salome CMake configuration files")
  80 IF(EXISTS $${CONFIGURATION_ROOT_DIR})
  81   LIST(APPEND CMAKE_MODULE_PATH "$${CONFIGURATION_ROOT_DIR}/cmake")
  82   INCLUDE(SalomeMacros)
  83 ELSE()
  84   MESSAGE(FATAL_ERROR "We absolutely need the Salome CMake configuration files, please define CONFIGURATION_ROOT_DIR !")
  85 ENDIF()
  86
  87 # Find KERNEL
  88 # ===========
  89 SET(KERNEL_ROOT_DIR $$ENV{KERNEL_ROOT_DIR} CACHE PATH "Path to the Salome KERNEL")
  90 IF(EXISTS $${KERNEL_ROOT_DIR})
  91   LIST(APPEND CMAKE_MODULE_PATH "$${KERNEL_ROOT_DIR}/salome_adm/cmake_files")
  92   FIND_PACKAGE(SalomeKERNEL REQUIRED)
  93 ELSE(EXISTS $${KERNEL_ROOT_DIR})
  94   MESSAGE(FATAL_ERROR "We absolutely need a Salome KERNEL, please define KERNEL_ROOT_DIR")
  95 ENDIF(EXISTS $${KERNEL_ROOT_DIR})
  96
  97 IF(SALOME_LIGHT_ONLY)
  98   MESSAGE(FATAL_ERROR "${module} module can't be built in Light mode (without CORBA)")
  99 ENDIF()
 100
 101 # Platform setup
 102 # ==============
 103 INCLUDE(SalomeSetupPlatform)   # From KERNEL
 104 # Always build libraries as shared objects:
 105 SET(BUILD_SHARED_LIBS TRUE)
 106 # Local macros:
 107 LIST(APPEND CMAKE_MODULE_PATH "$${PROJECT_SOURCE_DIR}/adm_local/cmake_files")
 108
 109 # User options
 110 # (some options have already been defined in KERNEL)
 111 # ============
 112 # OPTION(SALOME_BUILD_TESTS "Build SALOME tests" ON) #For use in the future
 113
 114 OPTION(SALOME_BUILD_DOC "Generate SALOME ${module} documentation" ${with_doc})
 115
 116 IF(SALOME_BUILD_DOC)
 117   FIND_PACKAGE(SalomeSphinx)
 118   SALOME_LOG_OPTIONAL_PACKAGE(Sphinx SALOME_BUILD_DOC)
 119   #FIND_PACKAGE(SalomeDoxygen)
 120   #SALOME_LOG_OPTIONAL_PACKAGE(Doxygen SALOME_BUILD_DOC)
 121 ENDIF()
 122
 123 ##
 124 ## From KERNEL:
 125 ##
 126 FIND_PACKAGE(SalomePythonInterp REQUIRED)
 127 FIND_PACKAGE(SalomePythonLibs REQUIRED)
 128
 129 FIND_PACKAGE(SalomeOmniORB REQUIRED)
 130 FIND_PACKAGE(SalomeOmniORBPy REQUIRED)
 131
 132 # Find GUI
 133 # ===========
 134 OPTION(SALOME_GUI_MODULE "Module ${module} has GUI." ${with_gui})
 135
 136 IF(SALOME_GUI_MODULE)
 137   SET(GUI_ROOT_DIR $$ENV{GUI_ROOT_DIR} CACHE PATH "Path to the Salome GUI")
 138   IF(EXISTS $${GUI_ROOT_DIR})
 139     LIST(APPEND CMAKE_MODULE_PATH "$${GUI_ROOT_DIR}/adm_local/cmake_files")
 140     FIND_PACKAGE(SalomeGUI REQUIRED)
 141     ADD_DEFINITIONS($${GUI_DEFINITIONS})
 142     INCLUDE_DIRECTORIES($${GUI_INCLUDE_DIRS})
 143   ELSE(EXISTS $${GUI_ROOT_DIR})
 144     MESSAGE(FATAL_ERROR "We absolutely need a Salome GUI, please define GUI_ROOT_DIR")
 145   ENDIF(EXISTS $${GUI_ROOT_DIR})
 146
 147   ##
 148   ## From GUI:
 149   ##
 150   FIND_PACKAGE(SalomeOpenCASCADE REQUIRED)
 151   # Qt5
 152   FIND_PACKAGE(SalomeQt5 REQUIRED)
 153 ENDIF(SALOME_GUI_MODULE)
 154
 155 ${add_modules}
 156
 157 # Detection summary:
 158 SALOME_PACKAGE_REPORT_AND_CHECK()
 159
 160 # Directories
 161 # (default values taken from KERNEL)
 162 # ===========
 163 SET(SALOME_INSTALL_BINS "$${SALOME_INSTALL_BINS}" CACHE PATH "Install path: SALOME binaries")
 164 SET(SALOME_INSTALL_LIBS "$${SALOME_INSTALL_LIBS}" CACHE PATH "Install path: SALOME libs")
 165 SET(SALOME_INSTALL_IDLS "$${SALOME_INSTALL_IDLS}" CACHE PATH "Install path: SALOME IDL files")
 166 SET(SALOME_INSTALL_HEADERS "$${SALOME_INSTALL_HEADERS}" CACHE PATH "Install path: SALOME headers")
 167 SET(SALOME_INSTALL_SCRIPT_SCRIPTS "$${SALOME_INSTALL_SCRIPT_SCRIPTS}" CACHE PATH
 168    "Install path: SALOME scripts")
 169 SET(SALOME_INSTALL_SCRIPT_DATA "$${SALOME_INSTALL_SCRIPT_DATA}" CACHE PATH
 170    "Install path: SALOME script data")
 171 SET(SALOME_INSTALL_SCRIPT_PYTHON "$${SALOME_INSTALL_SCRIPT_PYTHON}" CACHE PATH
 172    "Install path: SALOME Python scripts")
 173 SET(SALOME_INSTALL_APPLISKEL_SCRIPTS "$${SALOME_INSTALL_APPLISKEL_SCRIPTS}" CACHE PATH
 174    "Install path: SALOME application skeleton - scripts")
 175 SET(SALOME_INSTALL_APPLISKEL_PYTHON "$${SALOME_INSTALL_APPLISKEL_PYTHON}" CACHE PATH
 176    "Install path: SALOME application skeleton - Python")
 177 SET(SALOME_INSTALL_PYTHON "$${SALOME_INSTALL_PYTHON}" CACHE PATH "Install path: SALOME Python stuff")
 178 SET(SALOME_INSTALL_PYTHON_SHARED "$${SALOME_INSTALL_PYTHON_SHARED}" CACHE PATH
 179    "Install path: SALOME Python shared modules")
 180 SET(SALOME_INSTALL_CMAKE_LOCAL "$${SALOME_INSTALL_CMAKE_LOCAL}" CACHE PATH
 181     "Install path: local SALOME CMake files")
 182 #SET(SALOME_INSTALL_AMCONFIG_LOCAL "$${SALOME_INSTALL_AMCONFIG_LOCAL}" CACHE PATH
 183 #  "Install path: local SALOME config files (obsolete, to be removed)")
 184 SET(SALOME_INSTALL_RES "$${SALOME_INSTALL_RES}" CACHE PATH "Install path: SALOME resources")
 185 SET(SALOME_INSTALL_DOC "$${SALOME_INSTALL_DOC}" CACHE PATH "Install path: SALOME documentation")
 186
 187 # Specific to component:
 188 SET(SALOME_${module}_INSTALL_RES_DATA "$${SALOME_INSTALL_RES}/${module_min}" CACHE PATH
 189     "Install path: SALOME ${module} specific data")
 190
 191 MARK_AS_ADVANCED(SALOME_INSTALL_BINS SALOME_INSTALL_LIBS SALOME_INSTALL_IDLS SALOME_INSTALL_HEADERS)
 192 MARK_AS_ADVANCED(SALOME_INSTALL_SCRIPT_SCRIPTS SALOME_INSTALL_SCRIPT_DATA SALOME_INSTALL_SCRIPT_PYTHON)
 193 MARK_AS_ADVANCED(SALOME_INSTALL_APPLISKEL_SCRIPTS  SALOME_INSTALL_APPLISKEL_PYTHON SALOME_INSTALL_CMAKE_LOCAL SALOME_INSTALL_RES)
 194 MARK_AS_ADVANCED(SALOME_INSTALL_PYTHON SALOME_INSTALL_PYTHON_SHARED)
 195 MARK_AS_ADVANCED(SALOME_INSTALL_AMCONFIG_LOCAL SALOME_INSTALL_DOC)
 196 MARK_AS_ADVANCED(SALOME_${module}_INSTALL_RES_DATA)
 197
 198 # Accumulate environment variables for component module
 199 SALOME_ACCUMULATE_ENVIRONMENT(PYTHONPATH NOCHECK $${CMAKE_INSTALL_PREFIX}/$${SALOME_INSTALL_BINS}
 200                                                  $${CMAKE_INSTALL_PREFIX}/$${SALOME_INSTALL_PYTHON})
 201 SALOME_ACCUMULATE_ENVIRONMENT(LD_LIBRARY_PATH NOCHECK $${CMAKE_INSTALL_PREFIX}/$${SALOME_INSTALL_LIBS})
 202
 203 # Sources
 204 # ========
 205
 206 ADD_SUBDIRECTORY(idl)
 207 #ADD_SUBDIRECTORY(adm_local)
 208 ADD_SUBDIRECTORY(resources)
 209 ADD_SUBDIRECTORY(src)
 210 #ADD_SUBDIRECTORY(bin)
 211 IF(SALOME_BUILD_DOC)
 212   ADD_SUBDIRECTORY(doc)
 213 ENDIF()
 214
 215 # Header configuration
 216 # ====================
 217 SALOME_XVERSION($${PROJECT_NAME})
 218 #SALOME_CONFIGURE_FILE(HELLO_version.h.in HELLO_version.h INSTALL $${SALOME_INSTALL_HEADERS})
 219
 220 # Configuration export
 221 # (here only the level 1 prerequisites are exposed)
 222 # ====================
 223 INCLUDE(CMakePackageConfigHelpers)
 224
 225 # List of targets in this project we want to make visible to the rest of the world.
 226 # They all have to be INSTALL'd with the option "EXPORT $${PROJECT_NAME}TargetGroup"
 227 SET(_$${PROJECT_NAME}_exposed_targets
 228   ${compolibs} SalomeIDL${module}
 229 )
 230
 231 # Add all targets to the build-tree export set
 232 EXPORT(TARGETS $${_$${PROJECT_NAME}_exposed_targets}
 233   FILE $${PROJECT_BINARY_DIR}/$${PROJECT_NAME}Targets.cmake)
 234
 235 # Create the configuration files:
 236 #   - in the build tree:
 237
 238 # Ensure the variables are always defined for the configure:
 239 # !
 240 IF(SALOME_GUI_MODULE)
 241   SET(GUI_ROOT_DIR "$${GUI_ROOT_DIR}")
 242 ENDIF(SALOME_GUI_MODULE)
 243
 244 SET(CONF_INCLUDE_DIRS "$${PROJECT_SOURCE_DIR}/include" "$${PROJECT_BINARY_DIR}/include")
 245
 246 # Build variables that will be expanded when configuring Salome<MODULE>Config.cmake:
 247 # SALOME_CONFIGURE_PREPARE() #For use in the future
 248
 249 #CONFIGURE_PACKAGE_CONFIG_FILE($${PROJECT_NAME}Config.cmake.in
 250 #    $${PROJECT_BINARY_DIR}/$${PROJECT_NAME}Config.cmake
 251 #    INSTALL_DESTINATION "$${SALOME_INSTALL_CMAKE_LOCAL}"
 252 #    PATH_VARS CONF_INCLUDE_DIRS SALOME_INSTALL_CMAKE_LOCAL CMAKE_INSTALL_PREFIX
 253 #    )
 254
 255 #WRITE_BASIC_PACKAGE_VERSION_FILE($${PROJECT_BINARY_DIR}/$${PROJECT_NAME}ConfigVersion.cmake
 256 #    VERSION $${$${PROJECT_NAME_UC}_VERSION}
 257 #    COMPATIBILITY AnyNewerVersion)
 258
 259 # Install the CMake configuration files:
 260 #INSTALL(FILES
 261 #  "$${PROJECT_BINARY_DIR}/$${PROJECT_NAME}Config.cmake"
 262 #  "$${PROJECT_BINARY_DIR}/$${PROJECT_NAME}ConfigVersion.cmake"
 263 #  DESTINATION "$${SALOME_INSTALL_CMAKE_LOCAL}")
 264
 265 # Install the export set for use with the install-tree
 266 #INSTALL(EXPORT $${PROJECT_NAME}TargetGroup DESTINATION "$${SALOME_INSTALL_CMAKE_LOCAL}"
 267 #  FILE $${PROJECT_NAME}Targets.cmake)
 268 """
 269 cmake_root_cpp = Template(cmake_root_cpp)
 270
 271 # CMakeLists.txt in resources
 272 # template parameters:
 273 #   module : module name
 274 cmake_ressources = """
 275 SET(${module}_RESOURCES_FILES
 276   ${module}Catalog.xml
 277 )
 278
 279 INSTALL(FILES $${${module}_RESOURCES_FILES} DESTINATION $${SALOME_${module}_INSTALL_RES_DATA})
 280 """
 281 cmake_ressources = Template(cmake_ressources)
 282
 283 # CMakeLists.txt in src
 284 # template parameters:
 285 #   components : names of the components, separated by spaces or \n
 286 cmake_src = """
 287 SET(SUBDIRS
 288   ${components}
 289 )
 290
 291 FOREACH(dir $${SUBDIRS})
 292  ADD_SUBDIRECTORY($${dir})
 293 ENDFOREACH(dir $${SUBDIRS})
 294 """
 295 cmake_src = Template(cmake_src)
 296
 297 # CMakeLists.txt in idl
 298 # template parameters:
 299 #   module : module name
 300 #   extra_idl : additional idl files
 301 #   extra_include : additional include paths
 302 #   extra_link : additional include options
 303 cmake_idl = """
 304 INCLUDE(UseOmniORB)  # Provided by KERNEL
 305
 306 INCLUDE_DIRECTORIES(
 307   $${OMNIORB_INCLUDE_DIR}
 308   $${KERNEL_INCLUDE_DIRS}
 309   $${PROJECT_BINARY_DIR}/idl
 310 )
 311
 312 SET(SalomeIDL${module}_IDLSOURCES
 313   ${module}.idl
 314   ${extra_idl}
 315 )
 316
 317 SET(_idl_include_dirs
 318   $${KERNEL_ROOT_DIR}/idl/salome
 319   ${extra_include}
 320 )
 321
 322 SET(_idl_link_flags
 323   $${KERNEL_SalomeIDLKernel}
 324   ${extra_link}
 325 )
 326
 327 OMNIORB_ADD_MODULE(SalomeIDL${module} "$${SalomeIDL${module}_IDLSOURCES}" "$${_idl_include_dirs}" "$${_idl_link_flags}")
 328 INSTALL(TARGETS SalomeIDL${module} EXPORT $${PROJECT_NAME}TargetGroup DESTINATION $${SALOME_INSTALL_LIBS})
 329 """
 330 cmake_idl = Template(cmake_idl)
 331
 332 #cmake code to find a SALOME module
 333 # template parameters:
 334 #   module : module name (GEOM, SMESH, etc)
 335 cmake_find_module = """
 336
 337 #####################################
 338 # FIND ${module}
 339 #####################################
 340 SET(${module}_ROOT_DIR $$ENV{${module}_ROOT_DIR} CACHE PATH "Path to ${module} module")
 341 IF(EXISTS $${${module}_ROOT_DIR})
 342   LIST(APPEND CMAKE_MODULE_PATH "$${${module}_ROOT_DIR}/adm_local/cmake_files")
 343   FIND_PACKAGE(Salome${module} REQUIRED)
 344   ADD_DEFINITIONS($${${module}_DEFINITIONS})
 345   INCLUDE_DIRECTORIES($${${module}_INCLUDE_DIRS})
 346 ELSE(EXISTS $${${module}_ROOT_DIR})
 347   MESSAGE(FATAL_ERROR "We absolutely need ${module} module, please define ${module}_ROOT_DIR")
 348 ENDIF(EXISTS $${${module}_ROOT_DIR})
 349 #####################################
 350
 351 """
 352 cmake_find_module = Template(cmake_find_module)