0027351: Custom OCCT DLL name suffixes
[occt.git] / adm / cmake / vardescr.cmake
index a16e83c..0c49d40 100644 (file)
@@ -1,7 +1,7 @@
 # variable description
 
 # 
-set (APPLY_OCCT_PATCH_DIR_DESCR 
+set (BUILD_PATCH_DESCR 
 "Points to the directory recognized as a 'patch' for OCCT. If specified,
 the files from this directory take precedence over the corresponding native
 OCCT sources. This way you are able to introduce patches to Open CASCADE
@@ -13,33 +13,72 @@ set (BUILD_LIBRARY_TYPE_DESCR
 are linked dynamically and loaded at runtime. 'Static' libraries
 are archives of object files for use when linking other targets")
 
-set (REBUILD_PLATFORM_DEPENDENT_CODE_DESCR 
+set (BUILD_YACCLEX_DESCR 
 "Enables Flex/Bison lexical analyzers. OCCT source files relating to STEP reader and
 ExprIntrp functionality are generated automatically with Flex/Bison. Checking this options
 leads to automatic search of Flex/Bison binaries and regeneration of the mentioned files")
 
+set (BUILD_WITH_DEBUG_DESCR
+"Enables extended messages of many OCCT algorithms, usually printed to cout. 
+These include messages on internal errors and special cases encountered, timing etc")
+
+set (BUILD_SHARED_LIBRARY_NAME_POSTFIX_DESCR
+"Append the postfix to names of output libraries")
+
 # install variables
 set (INSTALL_DIR_DESCR 
-"The place where built OCCT libraries, headers, test cases (INSTALL_OCCT_TEST_CASES variable),
-samples (INSTALL_OCCT_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_GL2PS, INSTALL_TBB and
+"The place where built OCCT libraries, headers, test cases (INSTALL_TEST_CASES variable),
+samples (INSTALL_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_GL2PS, INSTALL_TBB and
 other similar variables) will be placed during the installation process (building INSTALL project)")
 
+set (INSTALL_DIR_WITH_VERSION_DESCR
+"Use OCCT version number as suffix for names of directories")
+
+set (INSTALL_DIR_LAYOUT_DESCR
+"Defines structure of OCCT files (binaries, resources, headers etc.) for the install directory.
+Two variants are predefined: for Windows (standard OCCT layout) and for Unix operating systems (standard Linux layout).
+If needed, layout can be customized with INSTALL_DIR_* variables.")
+
+set (INSTALL_DIR_BIN_DESCR 
+"Subdirectory of INSTALL_DIR where binaries will be installed")
+set (INSTALL_DIR_INCLUDE_DESCR 
+"Subdirectory of INSTALL_DIR where OCCT headers will be installed")
+set (INSTALL_DIR_DATA_DESCR 
+"Subdirectory of INSTALL_DIR where sample data files will be installed")
+set (INSTALL_DIR_DOC_DESCR 
+"Subdirectory of INSTALL_DIR where documentation will be installed")
+set (INSTALL_DIR_LIB_DESCR 
+"Subdirectory of INSTALL_DIR where libraries (.so on Linux, .lib on Windows) will be installed")
+set (INSTALL_DIR_RESOURCE_DESCR 
+"Subdirectory of INSTALL_DIR where OCCT resource files will be installed")
+set (INSTALL_DIR_SAMPLES_DESCR 
+"Subdirectory of INSTALL_DIR where samples will be installed")
+set (INSTALL_DIR_TESTS_DESCR 
+"Subdirectory of INSTALL_DIR where test scripts will be installed")
+set (INSTALL_DIR_SCRIPT_DESCR 
+"Subdirectory of INSTALL_DIR where scripts will be installed")
+set (INSTALL_DIR_CMAKE_DESCR 
+"Subdirectory of INSTALL_DIR where CMake configuration files will be installed.
+Must be three levels below INSTALL_DIR")
+
 macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
 set (${INSTALL_TARGET_VARIABLE}_DESCR
 "Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
 project) into the installation directory (INSTALL_DIR variable)")
 endmacro()
 
-INSTALL_MESSAGE (INSTALL_OCCT_SAMPLES     "OCCT samples")
-INSTALL_MESSAGE (INSTALL_OCCT_TEST_CASES  "non-regression OCCT test scripts")
-INSTALL_MESSAGE (INSTALL_DOC_OcctOverview "OCCT overview documentation (HTML format)")
+INSTALL_MESSAGE (INSTALL_SAMPLES          "OCCT samples")
+INSTALL_MESSAGE (INSTALL_TEST_CASES       "non-regression OCCT test scripts")
+INSTALL_MESSAGE (INSTALL_DOC_Overview     "OCCT overview documentation (HTML format)")
 INSTALL_MESSAGE (INSTALL_FREEIMAGE        "FreeImage binaries")
 INSTALL_MESSAGE (INSTALL_FREEIMAGEPLUS    "FreeImagePlus binaries")
 INSTALL_MESSAGE (INSTALL_FREETYPE         "FreeType binaries")
 INSTALL_MESSAGE (INSTALL_GL2PS            "GL2PS binaries")
 INSTALL_MESSAGE (INSTALL_TBB              "TBB binaries")
 INSTALL_MESSAGE (INSTALL_TCL              "TCL binaries")
-INSTALL_MESSAGE (INSTALL_VTK              "VTK binaries ")
+INSTALL_MESSAGE (INSTALL_TK               "TK binaries")
+
+#INSTALL_MESSAGE (INSTALL_VTK              "VTK binaries ")
 
 # build variables
 macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
@@ -64,21 +103,21 @@ want to build some particular libraries (toolkits) only, then you may uncheck
 all modules in the corresponding BUILD_MODUE_* options and provide the list of
 necessary libraries here. Of course, all dependencies will be resolved automatically")
 
-set (BUILD_MODULE_OcctMfcSamples_DESCR
+set (BUILD_MODULE_MfcSamples_DESCR
 "Indicates whether OCCT MFC samples should be built together with OCCT.
 These samples show some possibilities of using OCCT and they can be executed
 with script samples.bat from the installation directory (INSTALL_DIR)")
 
-set (BUILD_DOC_OcctOverview_DESCR
+set (BUILD_DOC_Overview_DESCR
 "Indicates whether OCCT overview documentation project (Markdown format) should be
 created together with OCCT. It is not built together with OCCT. Checking this options
 leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
 to generate the documentation in HTML format. The documentation will be available in the
-installation directory (overview.bat script) if INSTALL_DOC_OcctOverview variable is checked")
+installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
 
 set (3RDPARTY_DIR_DESCR
-"The root directory where all required 3-rd party products will be searched. If a
-3-rd party product have been found - corresponding CMake variables will be specified
+"The root directory where all required third-party products will be searched. If a
+third-party product have been found - corresponding CMake variables will be specified
 (VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
 
 set (USE_FREEIMAGE_DESCR
@@ -90,18 +129,20 @@ set (USE_GL2PS_DESCR
 module for support of vector image formats (PS, EPS etc)")
 
 set (USE_TBB_DESCR
-"Indicates whether TBB 3-rd party is used or not. TBB stands for Threading Building Blocks,
+"Indicates whether TBB is used or not. TBB stands for Threading Building Blocks,
 the technology of Intel Corp, which comes with different mechanisms and patterns for
 injecting parallelism into your application. OCCT remains parallel even without TBB product")
 
 set (USE_VTK_DESCR
-"Indicates whether VTK 3-rd party is used or not. VTK stands for Visualization
+"Indicates whether VTK is used or not. VTK stands for Visualization
 ToolKit, the technology of Kitware Inc intended for general-purpose scientific
 visualization. OCCT comes with a bridge between CAD data representation and
 VTK by means of its dedicated VIS component (VTK Integration Services).")
 
 set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
 
+set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
+
 macro (BUILD_MODULE MODULE_NAME)
   set (BUILD_MODULE_${MODULE_NAME} ON CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
 endmacro()