Open CASCADE Technology. Building OCCT with WOK CONTENTS

Size: px

Start display at page:

Download "Open CASCADE Technology. Building OCCT with WOK CONTENTS"

Vanessa Sparks
5 years ago
Views:

1 Open CASCADE Technology Building OCCT with WOK CONTENTS 1. INTRODUCTION 2 2. PRE-REQUISITES 2 3. INSTALL BINARY WOK PACKAGE Windows Linux Mac OS X 5 4. INITIALIZE A WORKBENCH 6 5. GENERATION OF BUILDING PROJECTS 6 6. GENERATION OF DOCUMENTATION 7 7. BUILDING MODULES Building on Windows with MS Visual Studio project files Building on Linux with autoconf, automake and libtool scripts Building with CMake Building on MAC OS X with Code::Blocks Building on MAC OS X with Xcode 9 OPEN CASCADE SAS Page 1 / 9

2 1. INTRODUCTION This document presents a short guide for installing a binary WOK package and for building OCCT from sources. Note that WOK is required to generate HXX and CXX files for OCCT classes defined using CDL language, and for project files. For the time being Binary WOK Package is available in the form of Install Wizard on Windows platform only. 2. PRE-REQUISITES Before installing and using WOK, make sure that you have installed a compiler (it is assumed that it is Visual Studio on Windows or gcc on Linux and MacOS) and third-party components required for building OCCT. 3. INSTALL BINARY WOK PACKAGE Download the latest version of WOK from Windows Run the installer. You will be prompted to read and accept the OCCT Public License to proceed: Click Next and proceed with the installation. At the end of the installation you will be prompted to specify the version and the location of Visual Studio to be used, and the location of third-party libraries: OPEN CASCADE SAS Page 2 / 9

You can change these settings at any time later. For this click on the item Customize environment (GUI tool) in the WOK group in the Windows Start menu.

3 You can change these settings at any time later. For this click on the item Customize environment (GUI tool) in the WOK group in the Windows Start menu. The shortcuts from this group provide two ways to run WOK: In command prompt window ( WOK TCL shell ). In Emacs editor ( WOK Emacs ). Using Emacs is convenient if you need to work within WOK environment. By default WOK installer creates a WOK factory with name LOC within workshop dev (WOK path :LOC:dev). OPEN CASCADE SAS Page 3 / 9

4 3.2. Linux 1. Unpack the.tgz archive containing WOK distributive into an installation directory <WOK_INSTALL_DIR>. 2. Perform the following commands assuming that you have unpacked WOK distributive archive into <WOK_INSTALL_DIR>: wok_confgui.sh Define all necessary paths to third-party products in the dialog window: 3. Run the following commands to create WOK LOC factory: wok_init.sh 4. Your installation procedure is over. To run WOK use one the following commands: wok_emacs.sh or wok_tclsh.sh OPEN CASCADE SAS Page 4 / 9

5 3.3. Mac OS X 1. In the Finder double click on woksetup.dmg file. This will open a new window. Drag and drop woksetup folder from this window at the location in the Finder where you want to install WOK, i.e. <WOK_INSTALL_DIR>. 2. Browse in the Finder to the folder <WOK_INSTALL_DIR>/site and double click on WokConfig. This will open a window with additional search path settings. Define all necessary paths to third-party products in the dialog window: 3. Run the following commands to create WOK LOC factory: wok_init.sh 4. Your installation procedure is over. To run WOK in Emacs navigate in the Finder to the folder <WOK_INSTALL_DIR>/site and double click on WokEmacs. OPEN CASCADE SAS Page 5 / 9

6 4. INITIALIZE A WORKBENCH To start working with OCCT, clone the OCCT Git repository from the server (see for details) or unpack the source archive. Then create a WOK workbench (command wcreate) setting its Home to the directory, where the repository is created. The workbench should have the same name as that directory. For example, assuming that OCCT repository has been cloned into D:/occt folder: LOC:dev> wcreate occt -DHome=D:/occt Then you can work with this workbench using normal WOK functionality (wprocess, umake, etc.; see WOK User s Guide for details) or use it only for generation of derived sources and project files, and build OCCT with Visual Studio on Windows or make command on Linux, as described below. 5. GENERATION OF BUILDING PROJECTS Use command wgenproj in WOK to generate derived headers, source and building projects files: LOC:dev> wokcd occt LOC:dev> wokcd wgenprog [ -target=<target> ] [ -no_wprocess ] TARGET: vc8 - Visual Studio 2005 vc9 - Visual Studio 2008 vc10 - Visual Studio 2010 vc11 - Visual Studio 2012 cbp - CodeBlocks cmake - CMake amk - AutoMake xcd - Xcode -no_wprocess - skip generation of derived headers and source files Note that this command takes several minutes to complete at the first call. Re-execute this step to generate derived headers, source and building projects files if some CDL files in OCCT have been modified (either by you directly, or due to updates in the repository) Close Visual Studio before this operation. Note that WOK may fail to update correctly; in such case remove subdirectories drv and.adm and repeat the command. To regenerate derived headers and source files without regeneration of projects use command: LOC:dev> wokcd occt LOC:dev> wprocess -DGroups=Src,Xcpp OPEN CASCADE SAS Page 6 / 9

7 6. GENERATION OF DOCUMENTATION Use command wgendoc in WOK to generate reference documentation: :LOC:dev:> wokcd occt :LOC:dev:> wokcd wgendoc with the following options: wgendoc [-wb=<workbench name>] [-m=<list of modules>] [-outdir=<path>] [-chm] [-hhc=<path to hhc.exe>] [-qthelp=<path to Qt>] [-doxygen=<path to doxygen.exe>] [-dot=<path to dot.exe>], where -wb=<workbench name> is the name of OCCT workbench (the current one by default); -m=<list of modules>: the list of modules that will be contained in the documentation; -outdir=<path>: the output directory for the documentation; -chm: the option to generate CHM file; -hhc=<path>: the path to HTML Help Compiler (hhc.exe) or equivalent; -qthelp=<path>: the option to generate Qt Help file, it is necessary to specify the path to qthelpgenerator executable; -doxygen=<path>: the path to Doxygen executable -dot=<path>: the path to GraphViz dot executable 7. BUILDING MODULES 7.1. Building on Windows with MS Visual Studio project files When the projects are generated, start Visual Studio by script msvc.bat generated in the workbench home directory: > D:/occt/msvc.bat or directly from WOK prompt (note that WOK sets the current directory to the workbench home when switching to the workbench): LOC:dev:occt> msvc.bat Note that object files and binaries are built by VS projects and by WOK in different locations, hence binaries and executable environments are different! 7.2. Building on Linux with autoconf, automake and libtool scripts When the projects are generated, execute build_configure and configure generated in the workbench home directory and make install command after that:./build_configure./configure <FLAGS>, where <FLAGS> is a set of the following directives: --with-tcl= defines location of tclconfig.sh; --with-tk= defines location of tkconfig.sh; --with-freetype= defines location of installed FreeType product; --with-gl2ps= defines location of installed gl2ps product; --with-freeimage= defines location of installed FreeImage product; --with-tbb-include= defines location of tbb.h; --with-tbb-library= defines location of libtbb.so OPEN CASCADE SAS Page 7 / 9

8 --enable-debug= yes/no includes/excludes debug information; --enable-production= yes/no switches on/off code optimization; --prefix= defines the location for installation of OCCT binaries; For example:./configure prefix=/products/occt with-tcl=/products/tcltk /lib --with-tk=/products/tcltk-8.5.8/lib --withfreetype=/products/freetype with-ftgl=/products/ftgl with-gl2ps=/products/gl2ps with-freeimage=/products/freeimage with-tbb-include=/products/tbb30_018oss/include --with-tbblibrary=/products/tbb30_018oss/lib/ia32/cc4.1.0_libc2.4_kernel make j8 install 7.3. Building with CMake CMake is free software that can create GNU Makefiles, KDevelop, XCode and Visual Studio project files. To use it for building OCCT on different platforms, download and install the latest version of CMake software. The main meta-project CmakeListx.txt for the entire OCCT and one metafile for each OCCT toolkit are generated by WOK tool. The created files are located in <occt home>/adm/cmake/. Then proceed to the configuration of created meta-projects, configuration of 3rd-party project paths and finally OCCT project files generation. The entire procedure is described with instructions for all supported platforms in Building OCCT with CMake User s Guide Building on MAC OS X with Code::Blocks To build OCCT with Code::Blocks on Mac OS X, perform the following steps: 1. Add paths to the mandatory 3rd-party products (Tcl/Tk and FreeType) in file custom.sh located in <OCCT_ROOT_DIR>. For this: 1.1. Add paths to the includes in variable CSF_OPT_INC ; 1.2. Add paths to the binary libraries in variable CSF_OPT_LIB64 ; All paths should be separated by : symbol. 2. Add paths to the optional 3rd-party libraries (TBB, gl2ps and FreeImage) in the aforementioned environment variables CSF_OPT_INC and CSF_OPT_LIB64 from file custom.sh. If you want to build OCCT without the optional libraries perform the following steps: 2.1. Disable unnecessary library in custom.sh by setting the corresponding variable HAVE_<LIBRARY_NAME> to false : export HAVE_GL2PS=false; 2.2. Remove this library from Linker settings in Code::Blocks for each project that uses it: right click on the required project, choose Build options, go to Linker settings tab in the opened window, select unnecessary libraries and click Delete button. 3. Open Terminal application. 4. Enter <OCCT_ROOT_DIR>: cd <OCCT_ROOT_DIR>. 5. To start Code::Blocks, run the command /codeblocks.sh. 6. To build all toolkits, click Build->Build workspace in the menu bar. To start DRAWEXE, which has been built with Code::Blocks on Mac OS X, perform the following steps: 1. Open Terminal application; 2. Enter <OCCT_ROOT_DIR>: cd <OCCT_ROOT_DIR>; OPEN CASCADE SAS Page 8 / 9

9 3. Run script./draw_cbp.sh cbp [d]. Option d is used if OCCT has been built in Debug mode Building on MAC OS X with Xcode To build OCCT with Xcode on Mac OS X, perform the following steps: 1. Add paths to the mandatory 3rd-party products (Tcl/Tk and FreeType) in file custom.sh located in <OCCT_ROOT_DIR>. For this: 1.1. Add paths to the includes in variable CSF_OPT_INC ; 1.2. Add paths to the binary libraries in variable CSF_OPT_LIB64 ; All paths should be separated by : symbol. 2. Add paths to the optional 3rd-party libraries (TBB, gl2ps and FreeImage) in the aforementioned environment variables CSF_OPT_INC and CSF_OPT_LIB64 from file custom.sh. If you want to build OCCT without the optional libraries perform the following steps: 2.1. Disable unnecessary library in custom.sh by setting the corresponding variable HAVE_<LIBRARY_NAME> to false : export HAVE_GL2PS=false; 2.2. Remove this library from Project navigator in Xcode for each project that uses it: choose the required project, right click on the unnecessary library and select Delete button. 3. Open Terminal application. 4. Enter <OCCT_ROOT_DIR>: cd <OCCT_ROOT_DIR>. 5. To start Xcode, run the command /xcode.sh. 6. To build a certain toolkit, select it in Scheme drop-down list in Xcode toolbar, press Product in the menu and click Build button. To build the entire OCCT, create a new empty project (select File -> New -> Project-> "Empty project" in the menu. Input the project name, e.g. OCCT, click Next and Create buttons). Drag and drop the OCCT folder in the created "OCCT project in the Project navigator. Select File -> New -> Target -> Aggregate in the menu. Enter the project name (e.g. OCCT ) and click "Finish". The "Build Phases tab will open. Click + button to add the necessary toolkits to the target project. It is possible to select all toolkits by pressing Command+A combination. To start DRAWEXE, which has been built with Xcode on Mac OS X, perform the following steps: 1. Open Terminal application; 2. Enter <OCCT_ROOT_DIR>: cd <OCCT_ROOT_DIR>; 3. Run script./draw_cbp.sh cbp [d]. Option d is used if OCCT has been built in Debug mode. OPEN CASCADE SAS Page 9 / 9

Open CASCADE Technology. Building OCCT with WOK CONTENTS

Open CASCADE Technology. Building OCCT with WOK CONTENTS Open CASCADE Technlgy Building OCCT with WOK CONTENTS 1. INTRODUCTION 2 2. PRE-REQUISITES 2 3. INSTALL BINARY WOK PACKAGE 2 3.1. Windws 2 3.2. Linux 4 3.3. Mac OS X 5 4. INITIALIZE A WORKBENCH 5 5. GENERATION