module_generator/mod_tmpl.py

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