9ffa0bb5e539e2fe3de8758ac08bd1f891fc61a8
[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_WITH_DEBUG_DESCR
22 "Enables extended messages of many OCCT algorithms, usually printed to cout. 
23 These include messages on internal errors and special cases encountered, timing etc")
24
25 # install variables
26 set (INSTALL_DIR_DESCR 
27 "The place where built OCCT libraries, headers, test cases (INSTALL_TEST_CASES variable),
28 samples (INSTALL_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_GL2PS, INSTALL_TBB and
29 other similar variables) will be placed during the installation process (building INSTALL project)")
30
31 set (INSTALL_DIR_WITH_VERSION_DESCR
32 "Use OCCT version number as suffix for names of directories")
33
34 set (INSTALL_DIR_LAYOUT_DESCR
35 "Defines structure of OCCT files (binaries, resources, headers etc.) for the install directory.
36 Two variants are predefined: for Windows (standard OCCT layout) and for Unix operating systems (standard Linux layout).
37 If needed, layout can be customized with INSTALL_DIR_* variables.")
38
39 set (INSTALL_DIR_BIN_DESCR 
40 "Subdirectory of INSTALL_DIR where binaries will be installed")
41 set (INSTALL_DIR_INCLUDE_DESCR 
42 "Subdirectory of INSTALL_DIR where OCCT headers will be installed")
43 set (INSTALL_DIR_DATA_DESCR 
44 "Subdirectory of INSTALL_DIR where sample data files will be installed")
45 set (INSTALL_DIR_DOC_DESCR 
46 "Subdirectory of INSTALL_DIR where documentation will be installed")
47 set (INSTALL_DIR_LIB_DESCR 
48 "Subdirectory of INSTALL_DIR where libraries (.so on Linux, .lib on Windows) will be installed")
49 set (INSTALL_DIR_RESOURCE_DESCR 
50 "Subdirectory of INSTALL_DIR where OCCT resource files will be installed")
51 set (INSTALL_DIR_SAMPLES_DESCR 
52 "Subdirectory of INSTALL_DIR where samples will be installed")
53 set (INSTALL_DIR_TESTS_DESCR 
54 "Subdirectory of INSTALL_DIR where test scripts will be installed")
55 set (INSTALL_DIR_SCRIPT_DESCR 
56 "Subdirectory of INSTALL_DIR where scripts will be installed")
57 set (INSTALL_DIR_CMAKE_DESCR 
58 "Subdirectory of INSTALL_DIR where CMake configuration files will be installed.
59 Must be three levels below INSTALL_DIR")
60
61 macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
62 set (${INSTALL_TARGET_VARIABLE}_DESCR
63 "Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
64 project) into the installation directory (INSTALL_DIR variable)")
65 endmacro()
66
67 INSTALL_MESSAGE (INSTALL_SAMPLES          "OCCT samples")
68 INSTALL_MESSAGE (INSTALL_TEST_CASES       "non-regression OCCT test scripts")
69 INSTALL_MESSAGE (INSTALL_DOC_Overview     "OCCT overview documentation (HTML format)")
70 INSTALL_MESSAGE (INSTALL_FREEIMAGE        "FreeImage binaries")
71 INSTALL_MESSAGE (INSTALL_FREEIMAGEPLUS    "FreeImagePlus binaries")
72 INSTALL_MESSAGE (INSTALL_FREETYPE         "FreeType binaries")
73 INSTALL_MESSAGE (INSTALL_GL2PS            "GL2PS binaries")
74 INSTALL_MESSAGE (INSTALL_TBB              "TBB binaries")
75 INSTALL_MESSAGE (INSTALL_TCL              "TCL binaries")
76 INSTALL_MESSAGE (INSTALL_TK               "TK binaries")
77
78 #INSTALL_MESSAGE (INSTALL_VTK              "VTK binaries ")
79
80 # build variables
81 macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
82 set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
83 "Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
84 It should be noted that some toolkits of the module can be built even if this module
85 is not checked (this happens if some other modules depend on these toolkits)")
86 endmacro()
87
88 BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
89 BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange         "DataExchange")
90 BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw                 "Draw")
91 BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses    "FoundationClasses")
92 BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms   "ModelingAlgorithms")
93 BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData         "ModelingData")
94 BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization        "Visualization")
95
96
97 set (BUILD_ADDITIONAL_TOOLKITS_DESCR
98 "Semicolon-separated individual toolkits to include into build process. If you
99 want to build some particular libraries (toolkits) only, then you may uncheck
100 all modules in the corresponding BUILD_MODUE_* options and provide the list of
101 necessary libraries here. Of course, all dependencies will be resolved automatically")
102
103 set (BUILD_MODULE_MfcSamples_DESCR
104 "Indicates whether OCCT MFC samples should be built together with OCCT.
105 These samples show some possibilities of using OCCT and they can be executed
106 with script samples.bat from the installation directory (INSTALL_DIR)")
107
108 set (BUILD_DOC_Overview_DESCR
109 "Indicates whether OCCT overview documentation project (Markdown format) should be
110 created together with OCCT. It is not built together with OCCT. Checking this options
111 leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
112 to generate the documentation in HTML format. The documentation will be available in the
113 installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
114
115 set (3RDPARTY_DIR_DESCR
116 "The root directory where all required third-party products will be searched. If a
117 third-party product have been found - corresponding CMake variables will be specified
118 (VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
119
120 set (USE_FREEIMAGE_DESCR
121 "Indicates whether Freeimage product should be used in OCCT visualization
122 module for support of popular graphics image formats (PNG, BMP etc)")
123
124 set (USE_GL2PS_DESCR
125 "Indicates whether GL2PS product should be used in OCCT visualization
126 module for support of vector image formats (PS, EPS etc)")
127
128 set (USE_TBB_DESCR
129 "Indicates whether TBB is used or not. TBB stands for Threading Building Blocks,
130 the technology of Intel Corp, which comes with different mechanisms and patterns for
131 injecting parallelism into your application. OCCT remains parallel even without TBB product")
132
133 set (USE_VTK_DESCR
134 "Indicates whether VTK is used or not. VTK stands for Visualization
135 ToolKit, the technology of Kitware Inc intended for general-purpose scientific
136 visualization. OCCT comes with a bridge between CAD data representation and
137 VTK by means of its dedicated VIS component (VTK Integration Services).")
138
139 set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
140
141 set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
142
143 macro (BUILD_MODULE MODULE_NAME)
144   set (BUILD_MODULE_${MODULE_NAME} ON CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
145 endmacro()