a9638ad5f97c8c633d7808806e10affca6781d93
[occt.git] / adm / cmake / vardescr.cmake
1 # variable description
2
3
4 set (BUILD_PATCH_DESCR 
5 "Points to the directory recognized as a 'patch' for OCCT. If specified,
6 the files from this directory take precedence over the corresponding native
7 OCCT sources. This way you are able to introduce patches to Open CASCADE
8 Technology not affecting the original source distribution")
9
10
11 set (BUILD_LIBRARY_TYPE_DESCR 
12 "Specifies the type of library to be created. 'Shared' libraries
13 are linked dynamically and loaded at runtime. 'Static' libraries
14 are archives of object files for use when linking other targets")
15
16 set (BUILD_YACCLEX_DESCR 
17 "Enables Flex/Bison lexical analyzers. OCCT source files relating to STEP reader and
18 ExprIntrp functionality are generated automatically with Flex/Bison. Checking this options
19 leads to automatic search of Flex/Bison binaries and regeneration of the mentioned files")
20
21 set (BUILD_RESOURCES_DESCR "Enables regeneration of OCCT resource files")
22
23 set (BUILD_WITH_DEBUG_DESCR
24 "Enables extended messages of many OCCT algorithms, usually printed to cout.
25 These include messages on internal errors and special cases encountered, timing etc.
26 Applies only for Debug configuration.")
27
28 set (BUILD_SHARED_LIBRARY_NAME_POSTFIX_DESCR
29 "Append the postfix to names of output libraries")
30
31 set (BUILD_ENABLE_FPE_SIGNAL_HANDLER_DESCR
32 "Enable/Disable the floating point exceptions (FPE) during DRAW execution only.
33 Corresponding environment variable (CSF_FPE) can be changed manually
34 in custom.bat/sh scripts without regeneration by CMake.")
35
36 set (BUILD_USE_PCH_DESCR
37 "Use precompiled headers to accelerate the build.
38 Precompiled headers are generated automatically by Cotire tool.")
39
40 # install variables
41 set (INSTALL_DIR_DESCR 
42 "The place where built OCCT libraries, headers, test cases (INSTALL_TEST_CASES variable),
43 samples (INSTALL_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_GL2PS, INSTALL_TBB and
44 other similar variables) will be placed during the installation process (building INSTALL project)")
45
46 set (INSTALL_DIR_WITH_VERSION_DESCR
47 "Use OCCT version number as suffix for names of directories")
48
49 set (INSTALL_DIR_LAYOUT_DESCR
50 "Defines structure of OCCT files (binaries, resources, headers etc.) for the install directory.
51 Two variants are predefined: for Windows (standard OCCT layout) and for Unix operating systems (standard Linux layout).
52 If needed, layout can be customized with INSTALL_DIR_* variables.")
53
54 set (INSTALL_DIR_BIN_DESCR 
55 "Subdirectory of INSTALL_DIR where binaries will be installed")
56 set (INSTALL_DIR_INCLUDE_DESCR 
57 "Subdirectory of INSTALL_DIR where OCCT headers will be installed")
58 set (INSTALL_DIR_DATA_DESCR 
59 "Subdirectory of INSTALL_DIR where sample data files will be installed")
60 set (INSTALL_DIR_DOC_DESCR 
61 "Subdirectory of INSTALL_DIR where documentation will be installed")
62 set (INSTALL_DIR_LIB_DESCR 
63 "Subdirectory of INSTALL_DIR where libraries (.so on Linux, .lib on Windows) will be installed")
64 set (INSTALL_DIR_RESOURCE_DESCR 
65 "Subdirectory of INSTALL_DIR where OCCT resource files will be installed")
66 set (INSTALL_DIR_SAMPLES_DESCR 
67 "Subdirectory of INSTALL_DIR where samples will be installed")
68 set (INSTALL_DIR_TESTS_DESCR 
69 "Subdirectory of INSTALL_DIR where test scripts will be installed")
70 set (INSTALL_DIR_SCRIPT_DESCR 
71 "Subdirectory of INSTALL_DIR where scripts will be installed")
72 set (INSTALL_DIR_CMAKE_DESCR 
73 "Subdirectory of INSTALL_DIR where CMake configuration files will be installed.
74 Must be three levels below INSTALL_DIR")
75
76 macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
77 set (${INSTALL_TARGET_VARIABLE}_DESCR
78 "Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
79 project) into the installation directory (INSTALL_DIR variable)")
80 endmacro()
81
82 INSTALL_MESSAGE (INSTALL_SAMPLES          "OCCT samples")
83 INSTALL_MESSAGE (INSTALL_TEST_CASES       "non-regression OCCT test scripts")
84 INSTALL_MESSAGE (INSTALL_DOC_Overview     "OCCT overview documentation (HTML format)")
85 INSTALL_MESSAGE (INSTALL_FFMPEG           "FFmpeg binaries")
86 INSTALL_MESSAGE (INSTALL_FREEIMAGE        "FreeImage binaries")
87 INSTALL_MESSAGE (INSTALL_EIGEN            "EIGEN header files")
88 INSTALL_MESSAGE (INSTALL_EGL              "EGL binaries")
89 INSTALL_MESSAGE (INSTALL_GLES2            "OpenGL ES 2.0 binaries")
90 INSTALL_MESSAGE (INSTALL_FREETYPE         "FreeType binaries")
91 INSTALL_MESSAGE (INSTALL_GL2PS            "GL2PS binaries")
92 INSTALL_MESSAGE (INSTALL_TBB              "TBB binaries")
93 INSTALL_MESSAGE (INSTALL_TCL              "TCL binaries")
94 INSTALL_MESSAGE (INSTALL_TK               "TK binaries")
95 INSTALL_MESSAGE (INSTALL_VTK              "VTK binaries ")
96
97 # build variables
98 macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
99 set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
100 "Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
101 It should be noted that some toolkits of the module can be built even if this module
102 is not checked (this happens if some other modules depend on these toolkits)")
103 endmacro()
104
105 BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
106 BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange         "DataExchange")
107 BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw                 "Draw")
108 BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses    "FoundationClasses")
109 BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms   "ModelingAlgorithms")
110 BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData         "ModelingData")
111 BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization        "Visualization")
112
113
114 set (BUILD_ADDITIONAL_TOOLKITS_DESCR
115 "Semicolon-separated individual toolkits to include into build process. If you
116 want to build some particular libraries (toolkits) only, then you may uncheck
117 all modules in the corresponding BUILD_MODUE_* options and provide the list of
118 necessary libraries here. Of course, all dependencies will be resolved automatically")
119
120 set (BUILD_SAMPLES_MFC_DESCR
121 "Indicates whether OCCT MFC samples should be built together with OCCT.
122 These samples show some possibilities of using OCCT and they can be executed
123 with script samples.bat from the installation directory (INSTALL_DIR)")
124
125 set (BUILD_SAMPLES_QT_DESCR
126 "Indicates whether OCCT Qt samples should be built together with OCCT.
127 These samples show some possibilities of using OCCT and they can be executed
128 with script samples.bat from the installation directory (INSTALL_DIR)")
129
130 set (BUILD_Inspector_DESCR
131 "Indicates whether OCCT inspector should be built together with OCCT.
132 This inspector provides functionality to interactively inspect low-level content
133 of the OCAF data model, OCCT viewer, etc. have been introduced in OCCT.
134 It can be executed with script inspector.bat from the installation directory (INSTALL_DIR) or
135 using 'tinspector' command in DRAW interpretator")
136
137 set (BUILD_MODULE_UwpSample_DESCR
138 "Indicates whether OCCT UWP sample should be built together with OCCT.")
139
140 set (BUILD_DOC_Overview_DESCR
141 "Indicates whether OCCT overview documentation project (Markdown format) should be
142 created together with OCCT. It is not built together with OCCT. Checking this options
143 leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
144 to generate the documentation in HTML format. The documentation will be available in the
145 installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
146
147 set (3RDPARTY_DIR_DESCR
148 "The root directory where all required third-party products will be searched. If a
149 third-party product have been found - corresponding CMake variables will be specified
150 (VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
151
152 set (USE_FFMPEG_DESCR
153 "Indicates whether FFmpeg framework is used or not. FFmpeg stands for
154 multimedia data handling, open-source software libraries used for video encoding and decoding.")
155
156 set (USE_FREEIMAGE_DESCR
157 "Indicates whether Freeimage product should be used in OCCT visualization
158 module for support of popular graphics image formats (PNG, BMP etc)")
159
160 set (USE_EGL_DESCR
161 "Indicates whether EGL should be used in OCCT visualization
162 module instead of conventional OpenGL context creation APIs")
163
164 set (USE_GLES2_DESCR
165 "Indicates whether OpenGL ES 2.0 should be used in OCCT visualization
166 module instead of desktop OpenGL")
167
168 set (USE_GL2PS_DESCR
169 "Indicates whether GL2PS product should be used in OCCT visualization
170 module for support of vector image formats (PS, EPS etc)")
171
172 set (USE_TBB_DESCR
173 "Indicates whether TBB is used or not. TBB stands for Threading Building Blocks,
174 the technology of Intel Corp, which comes with different mechanisms and patterns for
175 injecting parallelism into your application. OCCT remains parallel even without TBB product")
176
177 set (USE_VTK_DESCR
178 "Indicates whether VTK is used or not. VTK stands for Visualization
179 ToolKit, the technology of Kitware Inc intended for general-purpose scientific
180 visualization. OCCT comes with a bridge between CAD data representation and
181 VTK by means of its dedicated VIS component (VTK Integration Services).")
182
183 set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
184
185 set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
186
187 macro (BUILD_MODULE MODULE_NAME)
188   set (ENABLE_MODULE TRUE)
189   set (BUILD_MODULE_${MODULE_NAME} ${ENABLE_MODULE} CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
190 endmacro()