module_generator/mod_tmpl.py

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