module_generator/mod_tmpl.py

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