Salome HOME
832b027dc9a4002ebf0e013de15bf952be442fad
[tools/configuration.git] / cmake / FindSalomeGUI.cmake
1 # Copyright (C) 2007-2022  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: Adrien Bruneton
20 #
21
22 # GUI detection for Salome - this is typically called by dependent modules
23 # (PARAVIS, etc ...)
24 #
25 # The detection is simpler than for other prerequisites.
26 # See explanation in FindSalomeKERNEL.cmake.
27 #
28
29 IF(NOT SalomeGUI_FIND_QUIETLY)
30   MESSAGE(STATUS "Looking for Salome GUI ...")
31 ENDIF()
32
33 SET(CMAKE_PREFIX_PATH "${GUI_ROOT_DIR}")
34 SALOME_FIND_PACKAGE(SalomeGUI SalomeGUI CONFIG)
35
36 IF(NOT SalomeGUI_FIND_QUIETLY)
37   MESSAGE(STATUS "Found Salome GUI: ${GUI_ROOT_DIR}")
38 ENDIF()
39
40 FOREACH(_res ${SalomeGUI_EXTRA_ENV})
41   SALOME_ACCUMULATE_ENVIRONMENT(${_res} "${SalomeGUI_EXTRA_ENV_${_res}}")
42 ENDFOREACH()
43
44 #----------------------------------------------------------------------------
45 # SALOME_GUI_WITH_CORBA is a macro useful for determining whether a SALOME GUI module 
46 # is built in not light mode (with CORBA)
47 #----------------------------------------------------------------------------
48 MACRO(SALOME_GUI_WITH_CORBA)
49   IF(SALOME_GUI_LIGHT_ONLY)
50     MESSAGE(FATAL_ERROR "\nWe absolutely need a Salome GUI module with CORBA.\nPlease set option SALOME_LIGHT_ONLY to OFF when building GUI module.")
51   ENDIF()
52 ENDMACRO(SALOME_GUI_WITH_CORBA)
53
54
55 #----------------------------------------------------------------------------
56 # SALOME_GUI_MODE is a macro useful for determining whether a GUI module
57 # builded in particular mode 
58 #----------------------------------------------------------------------------
59 #########################################################################
60 # SALOME_GUI_MODE()
61
62 # USAGE: SALOME_GUI_MODE(_options)
63 #
64 # ARGUMENTS:
65 #   _options [input] List - The list of CMake options given to SALOME GUI
66 #
67 # Notes:
68 # - The arguments list can include "OPTIONAL" keywords:
69 #   * All arguments preceded by "OPTIONAL" keyword are mandatory for current module.
70 #     If GUI module was compiled without this functionality, further installation 
71 #     of the current module becomes impossible.
72 #   * All arguments following "OPTIONAL" keyword are optional for current module, which
73 #     uses this functionality, but can be installed without it.
74 #
75 # - At present there are next options in the GUI module:
76 #   SALOME_USE_OCCVIEWER, SALOME_USE_VTKVIEWER, SALOME_USE_GLVIEWER, SALOME_USE_PLOT2DVIEWER,
77 #   SALOME_USE_GRAPHICSVIEW, SALOME_USE_QXGRAPHVIEWER, SALOME_USE_PVVIEWER, SALOME_USE_PYVIEWER,
78 #   SALOME_USE_PYCONSOLE, SALOME_USE_SALOMEOBJECT
79 #
80 # Example of usage:
81 #   SALOME_GUI_MODE(SALOME_USE_OCCVIEWER SALOME_USE_SALOMEOBJECT OPTIONAL SALOME_USE_PYCONSOLE)
82 #
83 MACRO(SALOME_GUI_MODE)
84   MESSAGE(STATUS "")
85   MESSAGE(STATUS "  Checking status of GUI options")
86   MESSAGE(STATUS "  ==================================== ")
87   MESSAGE(STATUS "")
88   SET(_message)
89   SET(_length 25)   
90   SET(_is_optional OFF)
91   FOREACH(_option ${ARGN})
92     IF(${_option} STREQUAL "OPTIONAL")
93       SET(_is_optional ON)
94       MESSAGE(STATUS "  Optional:")
95     ELSE()
96       SALOME_JUSTIFY_STRING(${_option} ${_length} _option_name)
97       MESSAGE(STATUS "  * ${_option_name}  ->  ${${_option}}")
98       IF(NOT ${_option} AND NOT ${_is_optional})
99         LIST(APPEND _message ${_option})
100       ENDIF()
101     ENDIF()
102   ENDFOREACH()
103   MESSAGE(STATUS "")
104   
105   IF(_message)
106     SET(_message "We absolutely need a Salome GUI module in special mode. The following options should be set to ON when building GUI module: \n${_message}\n")
107     MESSAGE(FATAL_ERROR "${_message}")
108   ENDIF()
109 ENDMACRO(SALOME_GUI_MODE)