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
  58 macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
  59 set (${INSTALL_TARGET_VARIABLE}_DESCR
  60 "Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
  61 project) into the installation directory (INSTALL_DIR variable)")
  62 endmacro()
  63
  64 INSTALL_MESSAGE (INSTALL_SAMPLES          "OCCT samples")
  65 INSTALL_MESSAGE (INSTALL_TEST_CASES       "non-regression OCCT test scripts")
  66 INSTALL_MESSAGE (INSTALL_DOC_Overview     "OCCT overview documentation (HTML format)")
  67 INSTALL_MESSAGE (INSTALL_FREEIMAGE        "FreeImage binaries")
  68 INSTALL_MESSAGE (INSTALL_FREEIMAGEPLUS    "FreeImagePlus binaries")
  69 INSTALL_MESSAGE (INSTALL_FREETYPE         "FreeType binaries")
  70 INSTALL_MESSAGE (INSTALL_GL2PS            "GL2PS binaries")
  71 INSTALL_MESSAGE (INSTALL_TBB              "TBB binaries")
  72 INSTALL_MESSAGE (INSTALL_TCL              "TCL binaries")
  73 INSTALL_MESSAGE (INSTALL_TK               "TK binaries")
  74
  75 #INSTALL_MESSAGE (INSTALL_VTK              "VTK binaries ")
  76
  77 # build variables
  78 macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
  79 set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
  80 "Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
  81 It should be noted that some toolkits of the module can be built even if this module
  82 is not checked (this happens if some other modules depend on these toolkits)")
  83 endmacro()
  84
  85 BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
  86 BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange         "DataExchange")
  87 BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw                 "Draw")
  88 BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses    "FoundationClasses")
  89 BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms   "ModelingAlgorithms")
  90 BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData         "ModelingData")
  91 BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization        "Visualization")
  92
  93
  94 set (BUILD_ADDITIONAL_TOOLKITS_DESCR
  95 "Semicolon-separated individual toolkits to include into build process. If you
  96 want to build some particular libraries (toolkits) only, then you may uncheck
  97 all modules in the corresponding BUILD_MODUE_* options and provide the list of
  98 necessary libraries here. Of course, all dependencies will be resolved automatically")
  99
 100 set (BUILD_MODULE_MfcSamples_DESCR
 101 "Indicates whether OCCT MFC samples should be built together with OCCT.
 102 These samples show some possibilities of using OCCT and they can be executed
 103 with script samples.bat from the installation directory (INSTALL_DIR)")
 104
 105 set (BUILD_DOC_Overview_DESCR
 106 "Indicates whether OCCT overview documentation project (Markdown format) should be
 107 created together with OCCT. It is not built together with OCCT. Checking this options
 108 leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
 109 to generate the documentation in HTML format. The documentation will be available in the
 110 installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
 111
 112 set (3RDPARTY_DIR_DESCR
 113 "The root directory where all required 3-rd party products will be searched. If a
 114 3-rd party product have been found - corresponding CMake variables will be specified
 115 (VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
 116
 117 set (USE_FREEIMAGE_DESCR
 118 "Indicates whether Freeimage product should be used in OCCT visualization
 119 module for support of popular graphics image formats (PNG, BMP etc)")
 120
 121 set (USE_GL2PS_DESCR
 122 "Indicates whether GL2PS product should be used in OCCT visualization
 123 module for support of vector image formats (PS, EPS etc)")
 124
 125 set (USE_TBB_DESCR
 126 "Indicates whether TBB 3-rd party is used or not. TBB stands for Threading Building Blocks,
 127 the technology of Intel Corp, which comes with different mechanisms and patterns for
 128 injecting parallelism into your application. OCCT remains parallel even without TBB product")
 129
 130 set (USE_VTK_DESCR
 131 "Indicates whether VTK 3-rd party is used or not. VTK stands for Visualization
 132 ToolKit, the technology of Kitware Inc intended for general-purpose scientific
 133 visualization. OCCT comes with a bridge between CAD data representation and
 134 VTK by means of its dedicated VIS component (VTK Integration Services).")
 135
 136 set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
 137
 138 set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
 139
 140 macro (BUILD_MODULE MODULE_NAME)
 141   set (BUILD_MODULE_${MODULE_NAME} ON CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
 142 endmacro()