0027645: Data Exchange - access violation when reading STEP AP242 file
[occt.git] / adm / cmake / vardescr.cmake
CommitLineData
316d77d9 1# variable description
2
3#
109aa56e 4set (BUILD_PATCH_DESCR
f2e9c853 5"Points to the directory recognized as a 'patch' for OCCT. If specified,
6the files from this directory take precedence over the corresponding native
7OCCT sources. This way you are able to introduce patches to Open CASCADE
8Technology not affecting the original source distribution")
316d77d9 9
f2e9c853 10
11set (BUILD_LIBRARY_TYPE_DESCR
12"Specifies the type of library to be created. 'Shared' libraries
13are linked dynamically and loaded at runtime. 'Static' libraries
14are archives of object files for use when linking other targets")
15
109aa56e 16set (BUILD_YACCLEX_DESCR
f2e9c853 17"Enables Flex/Bison lexical analyzers. OCCT source files relating to STEP reader and
18ExprIntrp functionality are generated automatically with Flex/Bison. Checking this options
19leads to automatic search of Flex/Bison binaries and regeneration of the mentioned files")
316d77d9 20
109aa56e 21set (BUILD_WITH_DEBUG_DESCR
e13e5f39 22"Enables extended messages of many OCCT algorithms, usually printed to cout.
23These include messages on internal errors and special cases encountered, timing etc.
24Applies only for Debug configuration.")
898f6a92 25
46bd680a 26set (BUILD_SHARED_LIBRARY_NAME_POSTFIX_DESCR
27"Append the postfix to names of output libraries")
28
316d77d9 29# install variables
f2e9c853 30set (INSTALL_DIR_DESCR
0e617b05 31"The place where built OCCT libraries, headers, test cases (INSTALL_TEST_CASES variable),
32samples (INSTALL_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_GL2PS, INSTALL_TBB and
f2e9c853 33other similar variables) will be placed during the installation process (building INSTALL project)")
316d77d9 34
4b3541c6 35set (INSTALL_DIR_WITH_VERSION_DESCR
36"Use OCCT version number as suffix for names of directories")
37
38set (INSTALL_DIR_LAYOUT_DESCR
39"Defines structure of OCCT files (binaries, resources, headers etc.) for the install directory.
40Two variants are predefined: for Windows (standard OCCT layout) and for Unix operating systems (standard Linux layout).
41If needed, layout can be customized with INSTALL_DIR_* variables.")
42
43set (INSTALL_DIR_BIN_DESCR
44"Subdirectory of INSTALL_DIR where binaries will be installed")
45set (INSTALL_DIR_INCLUDE_DESCR
46"Subdirectory of INSTALL_DIR where OCCT headers will be installed")
47set (INSTALL_DIR_DATA_DESCR
48"Subdirectory of INSTALL_DIR where sample data files will be installed")
49set (INSTALL_DIR_DOC_DESCR
50"Subdirectory of INSTALL_DIR where documentation will be installed")
51set (INSTALL_DIR_LIB_DESCR
52"Subdirectory of INSTALL_DIR where libraries (.so on Linux, .lib on Windows) will be installed")
53set (INSTALL_DIR_RESOURCE_DESCR
54"Subdirectory of INSTALL_DIR where OCCT resource files will be installed")
55set (INSTALL_DIR_SAMPLES_DESCR
56"Subdirectory of INSTALL_DIR where samples will be installed")
57set (INSTALL_DIR_TESTS_DESCR
58"Subdirectory of INSTALL_DIR where test scripts will be installed")
59set (INSTALL_DIR_SCRIPT_DESCR
60"Subdirectory of INSTALL_DIR where scripts will be installed")
2e48c1cb 61set (INSTALL_DIR_CMAKE_DESCR
62"Subdirectory of INSTALL_DIR where CMake configuration files will be installed.
63Must be three levels below INSTALL_DIR")
4b3541c6 64
f2e9c853 65macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
66set (${INSTALL_TARGET_VARIABLE}_DESCR
67"Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
68project) into the installation directory (INSTALL_DIR variable)")
69endmacro()
316d77d9 70
0e617b05 71INSTALL_MESSAGE (INSTALL_SAMPLES "OCCT samples")
72INSTALL_MESSAGE (INSTALL_TEST_CASES "non-regression OCCT test scripts")
4b3541c6 73INSTALL_MESSAGE (INSTALL_DOC_Overview "OCCT overview documentation (HTML format)")
f2e9c853 74INSTALL_MESSAGE (INSTALL_FREEIMAGE "FreeImage binaries")
f2e9c853 75INSTALL_MESSAGE (INSTALL_FREETYPE "FreeType binaries")
76INSTALL_MESSAGE (INSTALL_GL2PS "GL2PS binaries")
77INSTALL_MESSAGE (INSTALL_TBB "TBB binaries")
78INSTALL_MESSAGE (INSTALL_TCL "TCL binaries")
82f443b6 79INSTALL_MESSAGE (INSTALL_TK "TK binaries")
4b3541c6 80
e713baee 81#INSTALL_MESSAGE (INSTALL_VTK "VTK binaries ")
316d77d9 82
83# build variables
f2e9c853 84macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
85set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
86"Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
87It should be noted that some toolkits of the module can be built even if this module
88is not checked (this happens if some other modules depend on these toolkits)")
89endmacro()
90
91BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
92BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange "DataExchange")
93BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw "Draw")
94BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses "FoundationClasses")
95BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms "ModelingAlgorithms")
96BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData "ModelingData")
97BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization "Visualization")
98
99
100set (BUILD_ADDITIONAL_TOOLKITS_DESCR
101"Semicolon-separated individual toolkits to include into build process. If you
102want to build some particular libraries (toolkits) only, then you may uncheck
103all modules in the corresponding BUILD_MODUE_* options and provide the list of
104necessary libraries here. Of course, all dependencies will be resolved automatically")
105
4b3541c6 106set (BUILD_MODULE_MfcSamples_DESCR
f2e9c853 107"Indicates whether OCCT MFC samples should be built together with OCCT.
108These samples show some possibilities of using OCCT and they can be executed
109with script samples.bat from the installation directory (INSTALL_DIR)")
110
4b3541c6 111set (BUILD_DOC_Overview_DESCR
f2e9c853 112"Indicates whether OCCT overview documentation project (Markdown format) should be
113created together with OCCT. It is not built together with OCCT. Checking this options
114leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
115to generate the documentation in HTML format. The documentation will be available in the
4b3541c6 116installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
f2e9c853 117
118set (3RDPARTY_DIR_DESCR
2e48c1cb 119"The root directory where all required third-party products will be searched. If a
120third-party product have been found - corresponding CMake variables will be specified
f2e9c853 121(VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
122
123set (USE_FREEIMAGE_DESCR
124"Indicates whether Freeimage product should be used in OCCT visualization
125module for support of popular graphics image formats (PNG, BMP etc)")
126
127set (USE_GL2PS_DESCR
128"Indicates whether GL2PS product should be used in OCCT visualization
129module for support of vector image formats (PS, EPS etc)")
130
131set (USE_TBB_DESCR
2e48c1cb 132"Indicates whether TBB is used or not. TBB stands for Threading Building Blocks,
f2e9c853 133the technology of Intel Corp, which comes with different mechanisms and patterns for
134injecting parallelism into your application. OCCT remains parallel even without TBB product")
135
136set (USE_VTK_DESCR
2e48c1cb 137"Indicates whether VTK is used or not. VTK stands for Visualization
f2e9c853 138ToolKit, the technology of Kitware Inc intended for general-purpose scientific
139visualization. OCCT comes with a bridge between CAD data representation and
140VTK by means of its dedicated VIS component (VTK Integration Services).")
141
142set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
316d77d9 143
f60111dc 144set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
145
316d77d9 146macro (BUILD_MODULE MODULE_NAME)
147 set (BUILD_MODULE_${MODULE_NAME} ON CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
148endmacro()