OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-04 18:06:22 +03:00
Code Packages Releases Activity

0024578: Typos in Developer Guide "Building OCCT from sources"

Browse Source 
Dev guides for building 3rd party products and "short guide" to WOK have been reviewed.
This commit is contained in:
ysn 2014-04-01 15:53:48 +04:00 committed by apn
parent 4ee1bdf4e9
commit 77906c4cef
6 changed files with 258 additions and 271 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
dox/dev_guides/building/3rdparty/3rdparty_linux.md vendored
View File

@ -14,8 +14,13 @@ http://www.opencascade.org/getocc/require/.
There are two types of third-party products, which are necessary to build OCCT: There are two types of third-party products, which are necessary to build OCCT:
* Mandatory products: Tcl/Tk 8.5 - 8.6 and  FreeType 2.4.10 - 2.4.11 * Mandatory products:
* Optional products: TBB 3.x - 4.x, gl2ps 1.3.5 - 1.3.8, FreeImage 3.14.1 - 3.15.4 * Tcl/Tk 8.5 - 8.6;  
* FreeType 2.4.10 - 2.4.11;
* Optional products:
* TBB 3.x - 4.x;
* gl2ps 1.3.5 - 1.3.8;
* FreeImage 3.14.1 - 3.15.4.
@section dev_guides__building_3rdparty_linux_2 Building Mandatory Third-party Products @section dev_guides__building_3rdparty_linux_2 Building Mandatory Third-party Products
@ -28,37 +33,37 @@ Tcl/Tk is required for DRAW test harness.
It is possible to download ready-to-install binaries from It is possible to download ready-to-install binaries from
http://www.activestate.com/activetcl/downloads http://www.activestate.com/activetcl/downloads
1. Download the binaries archive and unpack them to some TCL_SRC_DIR. 1. Download the binaries archive and unpack them to a directory, which is further referred to as *TCL_SRC_DIR*.
2. Enter the directory TCL_SRC_DIR. 2. Enter the directory *TCL_SRC_DIR*.
cd TCL_SRC_DIR cd TCL_SRC_DIR
3. Run the install command 3. Run the install command:
install.sh install.sh
and follow instructions. and follow the instructions.
@subsubsection dev_guides__building_3rdparty_linux_2_1_2 Installation from sources: Tcl @subsubsection dev_guides__building_3rdparty_linux_2_1_2 Installation from sources: Tcl
Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it. Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it.
1. Enter the unix sub-directory of the directory where the source files of Tcl are located (TCL_SRC_DIR). 1. Enter the unix sub-directory of the directory where the Tcl source files are located <i>(TCL_SRC_DIR)</i>.
cd TCL_SRC_DIR/unix cd TCL_SRC_DIR/unix
2. Run the configure command 2. Run the *configure* command:
configure --enable-gcc --enable-shared --enable-threads --prefix=TCL_INSTALL_DIR configure --enable-gcc --enable-shared --enable-threads --prefix=TCL_INSTALL_DIR
For a 64 bit platform also add --enable-64bit option to the command line. For a 64 bit platform also add <i>--enable-64bit</i> option to the command line.
3. If the configure command has finished successfully, start the building process 3. If the configure command has finished successfully, start the building process:
make make
4. If building is finished successfully, start the installation of Tcl. 4. If building is finished successfully, start the installation of Tcl.
All binary and service files of the product will be copied to the directory defined by TCL_INSTALL_DIR All binary and service files of the product will be copied to the directory defined by *TCL_INSTALL_DIR*
make install make install
@ -66,49 +71,47 @@ Download the necessary archive from http://www.tcl.tk/software/tcltk/download.ht
Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it. Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it.
1. Enter the unix sub-directory of the directory where the source files of Tk are located (TK_SRC_DIR). 1. Enter the unix sub-directory of the directory where the Tk source files are located <i>(TK_SRC_DIR)</i>
cd TK_SRC_DIR/unix cd TK_SRC_DIR/unix
2. Run the configure command, where TCL_LIB_DIR is TCL_INSTALL_DIR/lib 2. Run the configure command, where <i>TCL_LIB_DIR</i> is *TCL_INSTALL_DIR/lib*.
configure --enable-gcc --enable-shared --enable-threads --with-tcl=TCL_LIB_DIR --prefix=TK_INSTALL_DIR configure --enable-gcc --enable-shared --enable-threads --with-tcl=TCL_LIB_DIR --prefix=TK_INSTALL_DIR
where TCL_LIB_DIR is TCL_INSTALL_DIR/lib For a 64 bit platform also add <i>--enable-64bit</i> option to the command line.
For a 64 bit platform also add --enable-64bit option to the command line. 3. If the configure command has finished successfully, start the building process:
3. If the configure command has finished successfully, start the building process
make make
4. If building has finished successfully, start the installation of Tk. 4. If the building has finished successfully, start the installation of Tk.
All binary and service files of the product will be copied All binary and service files of the product will be copied
to the directory defined by TK_INSTALL_DIR (usually TK_INSTALL_DIR is TCL_INSTALL_DIR) to the directory defined by *TK_INSTALL_DIR* (usually it is *TCL_INSTALL_DIR*)
make install make install
@subsection dev_guides__building_3rdparty_linux_2_2 FreeType @subsection dev_guides__building_3rdparty_linux_2_2 FreeType
FreeType is required for display of text in 3D viewer. FreeType is required for text display in the 3D viewer.
Download the necessary archive from http://sourceforge.net/projects/freetype/files/ and unpack it. Download the necessary archive from http://sourceforge.net/projects/freetype/files/ and unpack it.
1. Enter the directory where the source files of FreeType are located (FREETYPE_SRC_DIR). 1. Enter the directory where the source files of FreeType are located <i>(FREETYPE_SRC_DIR)</i>.
cd FREETYPE_SRC_DIR cd FREETYPE_SRC_DIR
2. Run the configure command 2. Run the *configure* command:
configure --prefix=FREETYPE_INSTALL_DIR configure --prefix=FREETYPE_INSTALL_DIR
For a 64 bit platform also add CFLAGS='-m64 -fPIC' CPPFLAGS='-m64 -fPIC' option to the command line. For a 64 bit platform also add <i>CFLAGS='-m64 -fPIC' CPPFLAGS='-m64 -fPIC'</i> option to the command line.
3. If the configure command has finished successfully, start the building process 3. If the *configure* command has finished successfully, start the building process:
make make
4. If building has finished successfully, start the installation of FreeType. 4. If the building has finished successfully, start the installation of FreeType.
All binary and service files of the product will be copied to the directory defined by FREETYPE_INSTALL_DIR All binary and service files of the product will be copied to the directory defined by *FREETYPE_INSTALL_DIR*
make install make install
@ -117,46 +120,46 @@ Download the necessary archive from http://sourceforge.net/projects/freetype/fil
@subsection dev_guides__building_3rdparty_linux_3_1 TBB @subsection dev_guides__building_3rdparty_linux_3_1 TBB
This third-party product is installed with binaries from the archive that can be downloaded from http://threadingbuildingblocks.org. This third-party product is installed with binaries from the archive that can be downloaded from http://threadingbuildingblocks.org.
Go to \"Downloads page\", find the release version you need and pick the archive for Linux platform. Go to the **Download** page, find the release version you need and pick the archive for Linux platform.
To install, unpack the downloaded archive of TBB product. To install, unpack the downloaded archive of TBB product.
@subsection dev_guides__building_3rdparty_linux_3_2 gl2ps @subsection dev_guides__building_3rdparty_linux_3_2 gl2ps
Download the necessary archive from http://geuz.org/gl2ps/ and unpack it. Download the necessary archive from http://geuz.org/gl2ps/ and unpack it.
1. Install or build cmake product from source file. 1. Install or build *cmake* product from the source file.
2. Start cmake in GUI mode with the directory where the source files of gl2ps are located: 2. Start *cmake* in GUI mode with the directory where the source files of gl2ps are located:
ccmake GL2PS_SRC_DIR ccmake GL2PS_SRC_DIR
a. Press [c] to make the initial configuration * Press <i>[c]</i> to make the initial configuration;
b. Define the necessary options CMAKE_INSTALL_PREFIX * Define the necessary options in *CMAKE_INSTALL_PREFIX*
c. Press [c] to make the final configuration * Press <i>[c]</i> to make the final configuration
d. Press [g] to generate Makefile and exit * Press <i>[g]</i> to generate Makefile and exit
or just run the following command: or just run the following command:
cmake –DCMAKE_INSTALL_PREFIX=GL2PS_INSTALL_DIR –DCMAKE_BUILD_TYPE=Release cmake –DCMAKE_INSTALL_PREFIX=GL2PS_INSTALL_DIR –DCMAKE_BUILD_TYPE=Release
3. Start building of gl2ps 3. Start the building of gl2ps:
make make
4. Start the installation of gl2ps. Binaries will be installed according to the CMAKE_INSTALL_PREFIX option 4. Start the installation of gl2ps. Binaries will be installed according to the *CMAKE_INSTALL_PREFIX* option.
make install make install
@subsection dev_guides__building_3rdparty_linux_3_3 FreeImage @subsection dev_guides__building_3rdparty_linux_3_3 FreeImage
Download the necessary archive from http://sourceforge.net/projects/freeimage/files/Source%20Distribution/ Download the necessary archive from http://sourceforge.net/projects/freeimage/files/Source%20Distribution/
and unpack it. The directory with unpacked sources is further referred to as FREEIMAGE_SRC_DIR. and unpack it. The directory with unpacked sources is further referred to as *FREEIMAGE_SRC_DIR*.
1. Modify FREEIMAGE_SRC_DIR/Source/OpenEXR/Imath/ImathMatrix.h: 1. Modify *FREEIMAGE_SRC_DIR/Source/OpenEXR/Imath/ImathMatrix.h*:
In line 60 insert the following: In line 60 insert the following:
#include string.h #include string.h
2. Enter the directory where the source files of FreeImage are located (FREEIMAGE_SRC_DIR). 2. Enter the directory where the source files of FreeImage are located <i>(FREEIMAGE_SRC_DIR)</i>.
cd FREEIMAGE_SRC_DIR cd FREEIMAGE_SRC_DIR
@ -166,11 +169,10 @@ and unpack it. The directory with unpacked sources is further referred to as FR
4. Run the installation process 4. Run the installation process
a. If you have permissions to write to /usr/include and /usr/lib directories then run the following command: a. If you have the permission to write into directories <i>/usr/include</i> and <i>/usr/lib</i>, run the following command:
make install make install
b. If you don’t have permissions to write to /usr/include and b. If you do not have this permission, you need to modify file *FREEIMAGE_SRC_DIR/Makefile.gnu*:
/usr/lib directories then you need to modify the file FREEIMAGE_SRC_DIR/Makefile.gnu:
Change lines 7-9 from: Change lines 7-9 from:
@ -208,7 +210,7 @@ and unpack it. The directory with unpacked sources is further referred to as FR
make DESTDIR=FREEIMAGE_INSTALL_DIR install make DESTDIR=FREEIMAGE_INSTALL_DIR install
5. Clean the temporary files 5. Clean temporary files
make clean make clean
@ -226,15 +228,15 @@ ICD Loader version 1.2.11.0.
Khronos OpenCL Registry Khronos OpenCL Registry
http://www.khronos.org/registry/cl/ http://www.khronos.org/registry/cl/
2. Unpack the archive and put headers in **inc/CL** sub-folder 2. Unpack the archive and put headers in *inc/CL* sub-folder
3. Print **make** in root of unpacked archive to compile OpenCL libraries. 3. Print *make* in the root of the unpacked archive to compile OpenCL libraries.
4. Create installation folder for OpenCL IDL Loader package and put there: 4. Create installation folder for OpenCL IDL Loader package and put there:
1. OpenCL header files in **include/CL** subfolder 1. OpenCL header files in *include/CL* subfolder
2. **libOpenCL.so** (generated in **bin** subfolder of source package) in **lib** subfolder 2. *libOpenCL.so* (generated in *bin* subfolder of source package) in *lib* subfolder
@section dev_guides__building_3rdparty_linux_4 Installation From Official Repositories @section dev_guides__building_3rdparty_linux_4 Installation From Official Repositories
@ -252,13 +254,13 @@ from official repositories. You may install them from console using apt-get uti
libtbb-dev \ libtbb-dev \
libgl2ps-dev libgl2ps-dev
To launch WOK-prebuilt binaries you need install C shell and 32-bit libraries on x86_64 distributives: To launch binaries built with WOK you need to install C shell and 32-bit libraries on x86_64 distributives:
sudo apt-get install \ sudo apt-get install \
csh \ csh \
libstdc++5:i386 libxt6:i386 libstdc++5:i386 libxt6:i386
Any compliant C++ compiler is required for building anyway: Building is possible with any C++ compliant compiler :
sudo apt-get install \ sudo apt-get install \
g++ g++

91
dox/dev_guides/building/3rdparty/3rdparty_osx.md vendored
View File

@ -13,8 +13,14 @@ http://www.opencascade.org/getocc/require/</a>.
There are two types of third-party products, which are necessary to build OCCT: There are two types of third-party products, which are necessary to build OCCT:
* Mandatory products: Tcl 8.5, Tk 8.5, FreeType 2.4.10 * Mandatory products:
* Optional products: TBB 3.x or 4.x, gl2ps 1.3.5, FreeImage 3.14.1 or 3.15.x * Tcl 8.5,
* Tk 8.5,
* FreeType 2.4.10
* Optional products:
* TBB 3.x or 4.x,
* gl2ps 1.3.5,
* FreeImage 3.14.1 or 3.15.x
@section dev_guides__building_3rdparty_osx_2 Building Mandatory Third-party Products @section dev_guides__building_3rdparty_osx_2 Building Mandatory Third-party Products
@ -27,30 +33,30 @@ Tcl/Tk is required for DRAW test harness. Version 8.5 or 8.6 can be used with O
It is possible to download ready-to-install binaries from It is possible to download ready-to-install binaries from
http://www.activestate.com/activetcl/downloads http://www.activestate.com/activetcl/downloads
1. Download the disk image to some TCL_DOWNLOAD_DIR. 1. Download the disk image to a directory, which is further referred to as *TCL_DOWNLOAD_DIR*.
2. Open in Finder the directory TCL_DOWNLOAD_DIR. 2. Open the directory *TCL_DOWNLOAD_DIR* in the Finder .
3. Open disk image and follow instructions. 3. Open the disk image and follow the instructions.
@subsubsection dev_guides__building_3rdparty_osx_2_1_2 Installation from sources: Tcl 8.5 @subsubsection dev_guides__building_3rdparty_osx_2_1_2 Installation from sources: Tcl 8.5
Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it. Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it.
1. Enter the macosx sub-directory of the directory where the source files of Tcl are located (TCL_SRC_DIR). 1. Enter the *macosx* sub-directory of the directory where the Tcl source files are located <i>(TCL_SRC_DIR)</i>.
cd TCL_SRC_DIR/macosx cd TCL_SRC_DIR/macosx
2. Run the configure command 2. Run the *configure* command
configure --enable-gcc --enable-shared --enable-threads --prefix=TCL_INSTALL_DIR configure --enable-gcc --enable-shared --enable-threads --prefix=TCL_INSTALL_DIR
For a 64 bit platform also add --enable-64bit option to the command line. For a 64 bit platform also add <i>--enable-64bit</i> option to the command line.
3. If the configure command has finished successfully, start the building process 3. If the *configure* command has finished successfully, start the building process
make make
4. If building is finished successfully, start the installation of Tcl. 4. If building is finished successfully, start the installation of Tcl.
All binary and service files of the product will be copied to the directory defined by TCL_INSTALL_DIR All binary and service files of the product will be copied to the directory defined by *TCL_INSTALL_DIR*.
make install make install
@ -58,48 +64,46 @@ Download the necessary archive from http://www.tcl.tk/software/tcltk/download.ht
Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it. Download the necessary archive from http://www.tcl.tk/software/tcltk/download.html and unpack it.
1. Enter the macosx sub-directory of the directory where the source files of Tk are located (TK_SRC_DIR). 1. Enter the *macosx* sub-directory of the directory where the source files of Tk are located <i>(TK_SRC_DIR)</i>.
cd TK_SRC_DIR/macosx cd TK_SRC_DIR/macosx
2. Run the configure command, where TCL_LIB_DIR is TCL_INSTALL_DIR/lib 2. Run the *configure* command, where TCL_LIB_DIR is TCL_INSTALL_DIR/lib
configure --enable-gcc --enable-shared --enable-threads --with-tcl=TCL_LIB_DIR --prefix=TK_INSTALL_DIR configure --enable-gcc --enable-shared --enable-threads --with-tcl=TCL_LIB_DIR --prefix=TK_INSTALL_DIR
where TCL_LIB_DIR is TCL_INSTALL_DIR/lib. For a 64 bit platform also add --enable-64bit option to the command line. For a 64 bit platform also add <i>--enable-64bit</i> option to the command line.
3. If the configure command has finished successfully, start the building process 3. If the *configure* command has finished successfully, start the building process:
make make
4. If building has finished successfully, start the installation of Tk. 4. If the building has finished successfully, start the installation of Tk. All binary and service files of the product will be copied to the directory defined by *TK_INSTALL_DIR* (usually it is TCL_INSTALL_DIR)
All binary and service files of the product will be copied to the directory
defined by TK_INSTALL_DIR (usually TK_INSTALL_DIR is TCL_INSTALL_DIR)
make install make install
@subsection dev_guides__building_3rdparty_osx_2_2 FreeType 2.4.10 @subsection dev_guides__building_3rdparty_osx_2_2 FreeType 2.4.10
FreeType is required for display of text in 3D viewer. FreeType is required for text display in the 3D viewer.
Download the necessary archive from http://sourceforge.net/projects/freetype/files/ and unpack it. Download the necessary archive from http://sourceforge.net/projects/freetype/files/ and unpack it.
1. Enter the directory where the source files of FreeType are located (FREETYPE_SRC_DIR). 1. Enter the directory where the source files of FreeType are located <i>(FREETYPE_SRC_DIR)</i>.
cd FREETYPE_SRC_DIR cd FREETYPE_SRC_DIR
2. Run the configure command 2. Run the *configure* command
configure --prefix=FREETYPE_INSTALL_DIR configure --prefix=FREETYPE_INSTALL_DIR
For a 64 bit platform also add CFLAGS='-m64 -fPIC' CPPFLAGS='-m64 -fPIC' option to the command line. For a 64 bit platform also add <i>CFLAGS='-m64 -fPIC' CPPFLAGS='-m64 -fPIC'</i> option to the command line.
3. If the configure command has finished successfully, start the building process 3. If the *configure* command has finished successfully, start the building process
make make
4. If building has finished successfully, start the installation of FreeType. 4. If building has finished successfully, start the installation of FreeType.
All binary and service files of the product will be copied to the directory defined by FREETYPE_INSTALL_DIR All binary and service files of the product will be copied to the directory defined by *FREETYPE_INSTALL_DIR*.
make install make install
@ -109,7 +113,7 @@ Download the necessary archive from http://sourceforge.net/projects/freetype/fil
This third-party product is installed with binaries from the archive This third-party product is installed with binaries from the archive
that can be downloaded from http://threadingbuildingblocks.org/. that can be downloaded from http://threadingbuildingblocks.org/.
Go to \"Downloads / Commercial Aligned Release\", find the release version you need (e.g. tbb30_018oss) Go to the **Download** page, find the release version you need (e.g. *tbb30_018oss*)
and pick the archive for Mac OS X platform. and pick the archive for Mac OS X platform.
To install, unpack the downloaded archive of TBB 3.0 product (*tbb30_018oss_osx.tgz*). To install, unpack the downloaded archive of TBB 3.0 product (*tbb30_018oss_osx.tgz*).
@ -117,26 +121,26 @@ To install, unpack the downloaded archive of TBB 3.0 product (*tbb30_018oss_osx.
Download the necessary archive from http://geuz.org/gl2ps/ and unpack it. Download the necessary archive from http://geuz.org/gl2ps/ and unpack it.
1. Install or build cmake product from source file. 1. Install or build cmake product from the source file.
2. Start cmake in GUI mode with the directory where the source files of fl2ps are located 2. Start cmake in GUI mode with the directory, where the source files of *fl2ps* are located:
ccmake GL2PS_SRC_DIR ccmake GL2PS_SRC_DIR
1. Press [c] to make the initial configuration * Press <i>[c]</i> to make the initial configuration;
2. Define the necessary options CMAKE_INSTALL_PREFIX * Define the necessary options in *CMAKE_INSTALL_PREFIX*;
3. Press [c] to make the final configuration * Press <i>[c]</i> to make the final configuration;
4. Press [g] to generate Makefile and exit * Press <i>[g]</i> to generate Makefile and exit.
or just run the following command: or just run the following command:
cmake –DCMAKE_INSTALL_PREFIX=GL2PS_INSTALL_DIR –DCMAKE_BUILD_TYPE=Release cmake –DCMAKE_INSTALL_PREFIX=GL2PS_INSTALL_DIR –DCMAKE_BUILD_TYPE=Release
3. Start building of gl2ps 3. Start the building of gl2ps
make make
4. Start the installation of gl2ps. Binaries will be installed according to the CMAKE_INSTALL_PREFIX option 4. Start the installation of gl2ps. Binaries will be installed according to the *CMAKE_INSTALL_PREFIX* option
make install make install
@ -144,20 +148,20 @@ Download the necessary archive from http://geuz.org/gl2ps/ and unpack it.
Download the necessary archive from Download the necessary archive from
http://sourceforge.net/projects/freeimage/files/Source%20Distribution/ http://sourceforge.net/projects/freeimage/files/Source%20Distribution/
and unpack it. The directory with unpacked sources is further referred to as FREEIMAGE_SRC_DIR. and unpack it. The directory with unpacked sources is further referred to as *FREEIMAGE_SRC_DIR*.
Note that for building FreeImage on Mac OS X 10.7 you should replace Makefile.osx Note that for building FreeImage on Mac OS X 10.7 you should replace *Makefile.osx*
in FREEIMAGE_SRC_DIR by corrected one which you can find in attachment to issue #22811 in OCCT Mantis bug tracker in *FREEIMAGE_SRC_DIR* by the corrected file, which you can find in attachment to issue #22811 in OCCT Mantis bug tracker
(http://tracker.dev.opencascade.org/file_download.php?file_id=6937&type=bug) or elsewhere. (http://tracker.dev.opencascade.org/file_download.php?file_id=6937&type=bug).
1. If you are building FreeImage 3.15.x you can skip this step. 1. If you build FreeImage 3.15.x you can skip this step.
Modify FREEIMAGE_SRC_DIR/Source/OpenEXR/Imath/ImathMatrix.h: Modify <i>FREEIMAGE_SRC_DIR/Source/OpenEXR/Imath/ImathMatrix.h:</i>
In line 60 insert the following: In line 60 insert the following:
#include string.h #include string.h
Modify FREEIMAGE_SRC_DIR/Source/FreeImage/PluginTARGA.cpp: Modify <i>FREEIMAGE_SRC_DIR/Source/FreeImage/PluginTARGA.cpp:</i>
In line 320 replace: In line 320 replace:
@ -167,7 +171,7 @@ in FREEIMAGE_SRC_DIR by corrected one which you can find in attachment to issue
SwapShort(&value); SwapShort(&value);
2. Enter the directory where the source files of FreeImage are located (FREEIMAGE_SRC_DIR). 2. Enter the directory where the source files of FreeImage are located <i>(FREEIMAGE_SRC_DIR)</i>.
cd FREEIMAGE_SRC_DIR cd FREEIMAGE_SRC_DIR
@ -177,12 +181,11 @@ in FREEIMAGE_SRC_DIR by corrected one which you can find in attachment to issue
4. Run the installation process 4. Run the installation process
1. If you have permissions to write to /usr/local/include and /usr/local/lib directories then run the following command: 1. If you have the permission to write into <i>/usr/local/include</i> and <i>/usr/local/lib</i> directories, run the following command:
make install make install
2. If you do not have permissions to write to /usr/include and /usr/lib directories 2. If you do not have this permission, you need to modify file *FREEIMAGE_SRC_DIR/Makefile.osx*:
then you need to modify the file FREEIMAGE_SRC_DIR/Makefile.osx:
Change line 49 from:    Change line 49 from:   
@ -213,6 +216,6 @@ in FREEIMAGE_SRC_DIR by corrected one which you can find in attachment to issue
make PREFIX=FREEIMAGE_INSTALL_DIR install make PREFIX=FREEIMAGE_INSTALL_DIR install
5. Clean the temporary files 5. Clean temporary files
make clean make clean

241
dox/dev_guides/building/3rdparty/3rdparty_windows.md vendored
View File

@ -4,24 +4,21 @@
@section dev_guides__building_3rdparty_win_1 Introduction @section dev_guides__building_3rdparty_win_1 Introduction
This document presents guidelines for building third-party products This document presents guidelines for building third-party products used by Open CASCADE Technology (OCCT) and samples on Windows platform. It is assumed that you are already familiar with MS Visual Studio / Visual C++.
used by Open CASCADE Technology (OCCT) and samples on Windows platform.
This guide assumfamiliar with MS Visual Studio / Visual C++. You need to use the same version of MS Visual Studio for building all third-party products and OCCT itself, in order to receive a consistent set of run-time binaries.
You need to use the same version of MS Visual Studio for building The links for downloading the third-party products are available on the web site of OPEN CASCADE SAS at http://www.opencascade.org/getocc/require/. There are two types of third-party products used by OCCT:
all third-party products and OCCT itself, in order to receive a consistent set of run-time binaries.
The links for downloading the third-party products are available on the web site * Mandatory products:
of OPEN CASCADE SAS at http://www.opencascade.org/getocc/require/. * Tcl/Tk 8.5 - 8.6;
There are two types of third-party products which are used by OCCT: * FreeType 2.4.10 - 2.4.11.
* Optional products:
* TBB 3.x - 4.x;
* gl2ps 1.3.5 - 1.3.8;
* FreeImage 3.14.1 -3.15.4.
* Mandatory products: Tcl/Tk 8.5 - 8.6 and  FreeType 2.4.10 - 2.4.11 It is recommended to create a separate new folder on your workstation, where you will unpack the downloaded archives of the third-party products, and where you will build these products (for example, *c:\\occ3rdparty*).
* Optional products: TBB 3.x - 4.x, gl2ps 1.3.5 - 1.3.8, FreeImage 3.14.1 -3.15.4
It is recommended to create a separate new folder on your workstation where
you will unpack the downloaded archives of the third-party products,
and where you will build these products (for example, *c:\\occ3rdparty*).
Further in this document, this folder is referred to as *3rdparty*. Further in this document, this folder is referred to as *3rdparty*.
@ -29,39 +26,37 @@ Further in this document, this folder is referred to as *3rdparty*.
@subsection dev_guides__building_3rdparty_win_2_1 Tcl/Tk @subsection dev_guides__building_3rdparty_win_2_1 Tcl/Tk
Tcl/Tk is required for DRAW test harness.We recommend installing a binary distribution that could Tcl/Tk is required for DRAW test harness. We recommend installing a binary distribution that can be downloaded from http://www.activestate.com/activetcl.
be downloaded from http://www.activestate.com/activetcl.
Go to \"Free Downloads\" and pick the version of the Install Wizard Go to \"Free Downloads\" and pick the version of the Install Wizard
that matches your target platform – 32 bit (x86) or 64 bit (x64). that matches your target platform – 32 bit (x86) or 64 bit (x64).
The version of Visual Studio you use is irrelevant when choosing the Install Wizard. The version of Visual Studio you use is irrelevant when choosing the Install Wizard.
Run the Install Wizard you downloaded, and install Tcl/Tk products Run the downloaded Install Wizard and install Tcl/Tk products :
* to 3rdparty\\tcltk-win32 folder (for 32-bit platform) or * to *3rdparty\\tcltk-win32* folder (for 32-bit platform) or
* to 3rdparty\\tcltk-win64 folder (for 64-bit platform). * to *3rdparty\\tcltk-win64* folder (for 64-bit platform).
Further in this document, this folder is referred to as *tcltk*. Further in this document, this folder is referred to as *tcltk*.
@subsection dev_guides__building_3rdparty_win_2_2 FreeType @subsection dev_guides__building_3rdparty_win_2_2 FreeType
FreeType is required for display of text in 3D viewer. FreeType is required for text display in a 3D viewer. You can download its sources from http://sourceforge.net/projects/freetype/files/
You can download its sources from http://sourceforge.net/projects/freetype/files/
The building process is the following: ### The building procedure
1. Unpack the downloaded archive of FreeType product into the *3rdparty* folder. 1. Unpack the downloaded archive of FreeType product into the *3rdparty* folder. As a result, you will get a folder named, for example, *3rdparty\\freetype-2.4.10*. Further in this document, this folder is referred to as *freetype*.
2. Open the solution file *freetype\\builds\\win32\\vc20xx\\freetype.sln* in Visual Studio. Here *vc20xx* stands for your version of Visual Studio.
As a result, you should have a folder named for example, *3rdparty\\freetype-2.4.10*. Further in this document, this folder is referred to as *freetype*. 3. Select the configuration to build: either Debug or Release.
2. Open the solution file *freetype\\builds\\win32\\vc20xx\\freetype.sln* in Visual Studio, where vc20xx stands for the version of Visual Studio you are using.
3. Select a configuration to build: either Debug or Release.
4. Build the *freetype* project. 4. Build the *freetype* project.
As a result, you will get a freetype import library (.lib) in the *freetype\\obj\\win32\\vc20xx* folder. As a result, you will get a freetype import library (.lib) in the *freetype\\obj\\win32\\vc20xx* folder.
5. If you are building for 64 bit platform, start the Configuration Manager (Build - Configuration Manager),
and add *x64* platform to the solution configuration by copying the settings from Win32 platform: 5. If you build FreeType for a 64 bit platform, select in the main menu **Build - Configuration Manager** and add *x64* platform to the solution configuration by copying the settings from Win32 platform:
@image html /dev_guides/building/3rdparty/images/3rdparty_image001.png @image html /dev_guides/building/3rdparty/images/3rdparty_image001.png
@image latex /dev_guides/building/3rdparty/images/3rdparty_image001.png @image latex /dev_guides/building/3rdparty/images/3rdparty_image001.png
@ -73,63 +68,59 @@ The building process is the following:
Build the *freetype* project. Build the *freetype* project.
As a result, you should obtain a 64 bit import library (.lib) file in the *freetype\\x64\\vc20xx* folder. As a result, you will obtain a 64 bit import library (.lib) file in the *freetype\\x64\\vc20xx* folder.
If you want to build freetype as a dynamic library (.dll) follow items 6, 7 and 8 of this list. To build FreeType as a dynamic library (.dll) follow steps 6, 7 and 8 of this procedure.
6. Open Project-Properties-Configuration Properties-General and change option 'Configuration Type' to \"*Dynamic Library (.dll)*\". 6. Open menu Project-> Properties-> Configuration Properties-> General and change option **Configuration Type** to *Dynamic Library (.dll)*.
7. Edit file *freetype\\include\\freetype\\config\\ftoption.h*: 7. Edit file *freetype\\include\\freetype\\config\\ftoption.h*:
in line 255, uncomment the definition of macro FT_EXPORT and change it as follows: in line 255, uncomment the definition of macro *FT_EXPORT* and change it as follows:
#define FT_EXPORT(x) __declspec(dllexport) x #define FT_EXPORT(x) __declspec(dllexport) x
8. Build the *freetype* project. 8. Build the *freetype* project.
As a result, you should obtain import library (.lib) and dynamic library (.dll) As a result, you will obtain the files of the import library (.lib) and the dynamic library (.dll) in folders <i>freetype \\objs\\release</i> or <i>\\objs\\debug </i>.
files in *freetype \\objs\\release or \\objs\\debug folders.*
If you are building for a 64 bit platform, follow item 5 of this list. If you build for a 64 bit platform, follow step 5 of the procedure.
In order to facilitate use of the FreeType libraries in OCCT with minimal adjustment of its build procedures, To facilitate the use of FreeType libraries in OCCT with minimal adjustment of build procedures, it is recommended to copy the include files and libraries of FreeType into a separate folder, named according to the pattern: *freetype-compiler-bitness-building mode*, where:
it is recommended to copy the include files and libraries of FreeType to a separate folder, named according to the pattern: * **compiler** is *vc8* or *vc9* or *vc10* or *vc11*;
*freetype-compiler-bitness-building mode* * **bitness** is *32* or *64*;
where * **building mode** is *opt* (for Release) or *deb* (for Debug).
* compiler is vc8 or vc9 or vc10 or vc11; The *include* subfolder should be copied as is, while libraries should be renamed to *freetype.lib* and *freetype.dll* (suffixes removed) and placed to subdirectories *lib *and *bin*, respectively. If the Debug configuration is built, the Debug libraries should be put into subdirectories *libd* and *bind*.
* bitness is 32 or 64;
* building mode is opt (for Release) or deb (for Debug)
The include subfolder should be copied as is, while libraries should be renamed to
*freetype.lib* and *freetype.dll* (suffixes removed) and placed to subdirectories
*lib *and *bin*, respectively. If Debug configuration is built,
the Debug libraries should be put in subdirectories *libd* and *bind*.
@section dev_guides__building_3rdparty_win_3 Building Optional Third-party Products @section dev_guides__building_3rdparty_win_3 Building Optional Third-party Products
@subsection dev_guides__building_3rdparty_win_3_1 TBB @subsection dev_guides__building_3rdparty_win_3_1 TBB
This third-party product is installed with binaries This third-party product is installed with binaries
from the archive that can be downloaded from http://threadingbuildingblocks.org/. from the archive that can be downloaded from http://threadingbuildingblocks.org/.
Go to \"Downloads page\", find the release version you need (e.g. tbb30_018oss) and pick the archive for Windows platform. Go to the **Download** page, find the release version you need (e.g. *tbb30_018oss*) and pick the archive for Windows platform.
Unpack the downloaded archive of TBB product into the *3rdparty* folder. Unpack the downloaded archive of TBB product into the *3rdparty* folder.
Further in this document, this folder is referred to as *tbb*. Further in this document, this folder is referred to as *tbb*.
@subsection dev_guides__building_3rdparty_win_3_2 gl2ps @subsection dev_guides__building_3rdparty_win_3_2 gl2ps
This third-party product should be built as a dynamically loadable library (dll file). This third-party product should be built as a dynamically loadable library (dll file).
You can download its sources from http://geuz.org/gl2ps/src/ You can download its sources from http://geuz.org/gl2ps/src/.
The building process is the following: ### The building procedure
1. Unpack the downloaded archive of gl2ps product (e.g. *gl2ps-1.3.5.tgz*) into the *3rdparty* folder. 1. Unpack the downloaded archive of gl2ps product (e.g. *gl2ps-1.3.5.tgz*) into the *3rdparty* folder.
As a result, you should have a folder named for example, *3rdparty\\gl2ps-1.3.5-source*. As a result, you will get a folder named, for example, *3rdparty\\gl2ps-1.3.5-source*.
Rename it according to the rule: gl2ps-platform-compiler-building mode, where Rename it into <i>gl2ps-platform-compiler-building mode</i>, where
* **platform** is *win32* or *win64*;
* platform is win32 or win64; * **compiler** is *vc8*, *vc9* or *vc10*;
* compiler is vc8 or vc9 or vc10; * **building mode** - *opt* (for release) or *deb* (for debug).
* building mode - opt (for release) or deb (for debug)
For example, <i>gl2ps-win64-vc10-deb</i>
Further in this document, this folder is referred to as *gl2ps*. Further in this document, this folder is referred to as *gl2ps*.
@ -138,7 +129,7 @@ The building process is the following:
3. Edit the file *gl2ps\\CMakeLists.txt*. 3. Edit the file *gl2ps\\CMakeLists.txt*.
After line 113 in CMakeLists.txt: After line 113 in *CMakeLists.txt*:
set_target_properties(shared PROPERTIES COMPILE_FLAGS \"-DGL2PSDLL -DGL2PSDLL_EXPORTS\") set_target_properties(shared PROPERTIES COMPILE_FLAGS \"-DGL2PSDLL -DGL2PSDLL_EXPORTS\")
@ -146,10 +137,9 @@ The building process is the following:
add_definitions(-D_USE_MATH_DEFINES) add_definitions(-D_USE_MATH_DEFINES)
Attention: If cygwin was installed on your computer make sure that there is no path Attention: If Cygwin was installed on your computer, make sure that there is no path to it in the *PATH* variable to avoid possible conflicts during the configuration.
to the latter in the PATH variable in order to avoid possible conflicts during the configuration.
4. Launch CMake (cmake-gui.exe) using the Program menu. 4. Launch CMake <i>(cmake-gui.exe)</i> using the Program menu.
In CMake: In CMake:
@ -161,39 +151,41 @@ The building process is the following:
(for example, *gl2ps\\bin*). (for example, *gl2ps\\bin*).
Further in this document, this folder is referred to as *gl2ps_bin*. Further in this document, this folder is referred to as *gl2ps_bin*.
* Press the \"Configure\" button. * Press **Configure** button.
@image html /dev_guides/building/3rdparty/images/3rdparty_image004.png @image html /dev_guides/building/3rdparty/images/3rdparty_image004.png
@image latex /dev_guides/building/3rdparty/images/3rdparty_image004.png @image latex /dev_guides/building/3rdparty/images/3rdparty_image004.png
* Select the generator (the compiler and the target platform - 32 or 64 bit) in the pop-up window. * Select the generator (the compiler and the target platform - 32 or 64 bit) in the pop-up window.
@image html /dev_guides/building/3rdparty/images/3rdparty_image005.png @image html /dev_guides/building/3rdparty/images/3rdparty_image005.png
@image latex /dev_guides/building/3rdparty/images/3rdparty_image005.png @image latex /dev_guides/building/3rdparty/images/3rdparty_image005.png
* Then press the \"Finish\" button to return to the main CMake window. * Press **Finish** button to return to the main CMake window.
Expand the ENABLE group and uncheck ENABLE_PNG and ENABLE_ZLIB check boxes. Expand the ENABLE group and uncheck ENABLE_PNG and ENABLE_ZLIB check boxes.
@image html /dev_guides/building/3rdparty/images/3rdparty_image006.png @image html /dev_guides/building/3rdparty/images/3rdparty_image006.png
@image latex /dev_guides/building/3rdparty/images/3rdparty_image006.png @image latex /dev_guides/building/3rdparty/images/3rdparty_image006.png
* Expand the CMAKE group and define CMAKE_INSTALL_PREFIX * Expand the CMAKE group and define *CMAKE_INSTALL_PREFIX* which is the path where you want to install the build results, for example, *c:\\occ3rdparty\\gl2ps-1.3.5*.
(path where you want to install the build results, for example, *c:\\occ3rdparty\\gl2ps-1.3.5*).
@image html /dev_guides/building/3rdparty/images/3rdparty_image007.png @image html /dev_guides/building/3rdparty/images/3rdparty_image007.png
@image latex /dev_guides/building/3rdparty/images/3rdparty_image007.png @image latex /dev_guides/building/3rdparty/images/3rdparty_image007.png
* Press the \"Configure\" button again, and then the \"Generate\" button in order to generate * Press **Configure** button again, then press **Generate** button to generate Visual Studio projects. After completion, close CMake application.
Visual Studio projects. After completion, close CMake application.
5. Open the solution file *gl2ps_bin\\gl2ps.sln* in Visual Studio. 5. Open the solution file *gl2ps_bin\\gl2ps.sln* in Visual Studio.
* Select a configuration to build * Select a configuration to build
* Choose \"*Release*\" if you are building Release binaries. * Choose **Release** to build Release binaries.
* Choose \"*Debug*\" if you are building Debug binaries. * Choose **Debug** to build Debug binaries.
* Select a platform to build. * Select a platform to build.
* Choose \"*Win32*\" if you are building for a 32 bit platform. * Choose **Win32** to build for a 32 bit platform.
* Choose \"*x64*\" if you are building for a 64 bit platform. * Choose **x64** to build for a 64 bit platform.
* Build the solution. * Build the solution.
* Build the *INSTALL* project. * Build the *INSTALL* project.
As a result, you should have the installed gl2ps product in the *CMAKE_INSTALL_PREFIX* path. As a result, you should have the installed gl2ps product in the *CMAKE_INSTALL_PREFIX* path.
@subsection dev_guides__building_3rdparty_win_3_3 FreeImage @subsection dev_guides__building_3rdparty_win_3_3 FreeImage
@ -201,73 +193,70 @@ This third-party product should be built as a dynamically loadable library (.dll
You can download its sources from You can download its sources from
http://sourceforge.net/projects/freeimage/files/Source%20Distribution/ http://sourceforge.net/projects/freeimage/files/Source%20Distribution/
The building process is the following: ### The building procedure:
1. Unpack the downloaded archive of FreeImage product into *3rdparty* folder. 1. Unpack the downloaded archive of FreeImage product into *3rdparty* folder.
As a result, you should have a folder named *3rdparty\\FreeImage*. As a result, you should have a folder named *3rdparty\\FreeImage*.
Rename it according to the rule: freeimage-platform-compiler-building mode, where Rename it according to the rule: *freeimage-platform-compiler-building mode*, where
* platform is win32 or win64; * **platform** is *win32* or *win64*;
* compiler is vc8 or vc9 or vc10 or vc11; * **compiler** is *vc8* or *vc9* or *vc10* or *vc11*;
* building mode is opt (for release) or deb (for debug) * **building mode** is *opt* (for release) or *deb* (for debug)
Further in this document, this folder is referred to as *freeimage*. Further in this document, this folder is referred to as *freeimage*.
2. Open the solution file *freeimage\\FreeImage.*.sln* in Visual Studio that corresponds to the version of Visual Studio you use. 2. Open the solution file *freeimage\\FreeImage.*.sln* in your Visual Studio.
Since the version of Visual Studio you use is higher than VC++ 2008, apply conversion of the workspace. If you use a Visual Studio version higher than VC++ 2008, apply conversion of the workspace.
Such conversion should be suggested automatically by Visual Studio. Such conversion should be suggested automatically by Visual Studio.
3. Select a configuration to build. 3. Select a configuration to build.
- Choose \" *Release* \" if you are building Release binaries. - Choose **Release** if you are building Release binaries.
- Choose \" *Debug* \" if you are building Debug binaries. - Choose **Debug** if you are building Debug binaries.
*Note:* *Note:*
If you want to build a debug version of FreeImage binaries then you must rename If you want to build a debug version of FreeImage binaries then you need to rename the following files in FreeImage and FreeimagePlus projects:
the following files for projects FreeImage and FreeimagePlus:
Project -> Properties -> Configuration Properties -> Linker -> General -> Output File
Project-Properties-Configuration Properties-Linker-General-Output File FreeImage*d*.dll to FreeImage.dll
FreeImagePlus*d*.dll to FreeImagePlus.dll
from FreeImage*d*.dll to FreeImage.dll Project -> Properties -> Configuration Properties -> Linker -> Debugging-> Generate Program Database File
from FreeImagePlus*d*.dll to FreeImagePlus.dll
Project-Properties-Configuration Properties-Linker-Debugging-Generate Program Database File FreeImage*d*.pdb to FreeImage.pdb
FreeImagePlus*d*.pdb to FreeImagePlus.pdb
from FreeImage*d*.pdb to FreeImage.pdb Project -> Properties -> Configuration Properties -> Linker -> Advanced-Import Library
from FreeImagePlus*d*.pdb to FreeImagePlus.pdb
Project-Properties-Configuration Properties-Linker-Advanced-Import Library FreeImage*d*.lib to FreeImage.lib
FreeImagePlus*d*.lib to FreeImagePlus.lib
from FreeImage*d*.lib to FreeImage.lib Project -> Properties -> Configuration Properties -> Build Events -> Post -> Build Event -> Command Line
from FreeImagePlus*d*.lib to FreeImagePlus.lib
Project-Properties-Configuration Properties-Build Events-Post-Build Event-Comand Line FreeImage*d*.dll to FreeImage.dll
FreeImage*d*.lib to FreeImage.lib
FreeImagePlus*d*.dll to FreeImagePlus.dll
FreeImagePlus*d*.lib to FreeImagePlus.lib
from FreeImage*d*.dll to FreeImage.dll Additionally, rename in project FreeImagePlus
from FreeImage*d*.lib to FreeImage.lib
from FreeImagePlus*d*.dll to FreeImagePlus.dll Project -> Properties -> Configuration Properties -> Linker -> Input -> Additional Dependencies
from FreeImagePlus*d*.lib to FreeImagePlus.lib
Additionally, for project FreeImagePlus rename:
Project-Properties-Configuration Properties-Linker-Input-Additional Dependencies
from FreeImage*d*.lib to FreeImage.lib from FreeImage*d*.lib to FreeImage.lib
4. Select a platform to build. 4. Select a platform to build.
- Choose \" *Win32* \" if you are building for a 32 bit platform. - Choose *Win32* if you are building for a 32 bit platform.
- Choose \" *x64* \" if you are building for a 64 bit platform. - Choose *x64* if you are building for a 64 bit platform.
5. Start the building process. 5. Start the building process.
As a result, you should have the library files of FreeImage product in the As a result, you should have the library files of FreeImage product in *freeimage\\Dist* folder (*FreeImage.dll* and *FreeImage.lib*) and in *freeimage\\Wrapper\\FreeImagePlus\\dist* folder (*FreeImagePlus.dll* and *FreeImagePlus.lib*).
*freeimage\\Dist* folder (FreeImage.dll and FreeImage.lib files) and in the
*freeimage\\Wrapper\\FreeImagePlus\\dist* folder (FreeImagePlus.dll and
FreeImagePlus.lib files).
@subsection dev_guides__building_3rdparty_win_opencl OpenCL ICD Loader @subsection dev_guides__building_3rdparty_win_opencl OpenCL ICD Loader
@ -283,29 +272,21 @@ ICD Loader version 1.2.11.0.
Khronos OpenCL Registry Khronos OpenCL Registry
http://www.khronos.org/registry/cl/ http://www.khronos.org/registry/cl/
2. Unpack the archive and put headers in **inc/CL** sub-folder 2. Unpack the archive and put headers in *inc/CL* sub-folder
3. Use CMake to generate VS projects for building the library: 3. Use CMake to generate VS projects for building the library:
- Start CMake-GUI and select OpenCL ICD Loader folder as source path, - Start CMake-GUI and select OpenCL ICD Loader folder as source path, and the folder of your choice for VS project and intermediate build data;
and the folder of your choice for VS project and intermediate build data - Click **Generate**;
- Click Generate - Select the VS version to be used from the ones you have installed (we recommend using VS 2010) and the architecture (32- or 64-bit).
- Select VS version to be used (among the one you have installed; we
recommend using VS 2010), and architecture (32- or 64-bit)
4. Open solution **OPENCL_ICD_LOADER.sln** generated in the build folder. 4. Open solution *OPENCL_ICD_LOADER.sln* generated in the build folder.
Though not strictly necessary, we recommend making two changes in generated Though not strictly necessary, we recommend making two changes in the generated projects:
projects: - Add file *OpenCL.rc* to project OpenCL, to have version and Khronos copyright correctly embedded in DLL;
- Add file **OpenCL.rc** to project OpenCL, to have version and Khronos - Change **Runtime library** to **Multi-threaded(/MT)** in the properties of OpenCL project, on **C/C++ / Code Generation** page for Release configuration, to avoid dependency on run-time DLL.
copyright correctly embedded in DLL
- In properties of OpenCL project, on "C/C++ / Code Generation" page,
for Release configuration, change "Runtime library" to "Multi-threaded
(/MT)", to avoid dependency on run-time DLL.
5. Build project OpenCL in Release mode 5. Build project OpenCL in Release mode
6. Create installation folder for OpenCL IDL Loader package and put there: 6. Create the installation folder for OpenCL IDL Loader package and put there:
- OpenCL header files in **include/CL** subfolder - OpenCL header files in *include/CL* subfolder;
- OpenCL.dll (generated in **bin/Release** subfolder of source package) - *OpenCL.dll* (generated in *bin/Release* subfolder of the source package) in *bin* subfolder;
in **bin** subfolder - *OpenCL.lib* (generated in *Release* subfolder of the build directory) in *lib* subfolder.
- OpenCL.lib (generated in **Release** subfolder of build directory)
in **lib** subfolder

86
dox/dev_guides/building/wok/wok.md
View File

@ -28,25 +28,25 @@ and third-party components required for building OCCT.
@image html /dev_guides/building/wok/images/wok_image001.png @image html /dev_guides/building/wok/images/wok_image001.png
@image latex /dev_guides/building/wok/images/wok_image001.png @image latex /dev_guides/building/wok/images/wok_image001.png
Click Next and proceed with the installation. 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: 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:
@image html /dev_guides/building/wok/images/wok_image002.png @image html /dev_guides/building/wok/images/wok_image002.png
@image latex /dev_guides/building/wok/images/wok_image002.png @image latex /dev_guides/building/wok/images/wok_image002.png
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. 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: The shortcuts from this group provide two ways to run WOK:
* In command prompt window ("WOK TCL shell"). * In command prompt window using option *WOK TCL shell*.
* In Emacs editor ("WOK Emacs"). Using Emacs is convenient if you need to work within WOK environment. * In Emacs editor using option *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). By default WOK installer creates a WOK factory with name *LOC* within workshop *dev*. I.e. the WOK path is <i>:LOC:dev</i>.
@subsection wok12 Linux @subsection wok12 Linux
* Unpack the .tgz archive containing WOK distributive into an installation directory \<WOK_INSTALL_DIR\>. * Unpack the .tgz archive containing WOK distributive into the installation directory <i>\<WOK_INSTALL_DIR\></i>.
* Perform the following commands assuming that you have unpacked WOK distributive archive into \<WOK_INSTALL_DIR\>: * Perform the following commands assuming that you have unpacked WOK distributive archive into <i>\<WOK_INSTALL_DIR\></i>:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
cd \<WOK_INSTALL_DIR\>/site cd \<WOK_INSTALL_DIR\>/site
wok_confgui.sh wok_confgui.sh
@ -76,9 +76,9 @@ and third-party components required for building OCCT.
@subsection wok13 Mac OS X @subsection wok13 Mac OS X
* 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\>. * Double click on file *wokSetup.dmg* in the Finder. This opens 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. <i>\<WOK_INSTALL_DIR\></i>.
* 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: * Browse to the folder <i>\<WOK_INSTALL_DIR\>/site</i> and double click on *WokConfig*. This opens a window with additional search path settings. Define all necessary paths to third-party products in the dialog window:
@image html /dev_guides/building/wok/images/wok_image004.png @image html /dev_guides/building/wok/images/wok_image004.png
@image latex /dev_guides/building/wok/images/wok_image004.png @image latex /dev_guides/building/wok/images/wok_image004.png
@ -89,74 +89,74 @@ and third-party components required for building OCCT.
wok_init.sh wok_init.sh
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* 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. * Your installation procedure is over. To run WOK in Emacs navigate in the Finder to the folder <i>\<WOK_INSTALL_DIR\>/site</i> and double click on *WokEmacs*.
@section wok2 Initialization of Workbench @section wok2 Initialization of Workbench
To start working with OCCT, clone the OCCT Git repository from the server (see http://dev.opencascade.org/index.php?q=home/resources for details) or unpack the source archive. To start working with OCCT, clone the OCCT Git repository from the server (see http://dev.opencascade.org/index.php?q=home/resources 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 ($CASROOT variable). The workbench should have the same name as that directory. Then create a WOK workbench (command *wcreate*) setting its Home to the directory, where the repository is created (<i>$CASROOT</i> variable). The workbench should have the same name as that directory.
For example, assuming that OCCT repository has been cloned into D:/occt folder: For example, assuming that OCCT repository has been cloned into *D:/occt* folder:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
LOC:dev> wcreate occt -DHome=D:/occt LOC:dev> wcreate occt -DHome=D:/occt
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Note: $CASROOT is equal to D:/occt now Note that <i>$CASROOT</i> is equal to *D:/occt* now.
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. Then you can work with this workbench using normal WOK functionality (*wprocess, umake*, etc.; see @ref occt_dev_guides__wok "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.
@section wok3 Generation of building projects @section wok3 Generation of building projects
Use command wgenproj in WOK to generate derived headers, source and building projects files: Use command *wgenproj* in WOK to generate derived headers, source and building projects files:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
LOC:dev> wokcd occt LOC:dev> wokcd occt
LOC:dev:occt> wgenproj [ -target=<TARGET> ] [ -no_wprocess ] LOC:dev:occt> wgenproj [ -target=<TARGET> ] [ -no_wprocess ]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TARGET: TARGET:
* vc8 - Visual Studio 2005 * *vc8* - Visual Studio 2005;
* vc9 - Visual Studio 2008 * *vc9* - Visual Studio 2008;
* vc10 - Visual Studio 2010 * *vc10* - Visual Studio 2010;
* vc11 - Visual Studio 2012 * *vc11* - Visual Studio 2012;
* cbp - CodeBlocks * *cbp* - CodeBlocks;
* cmake - CMake * *cmake* - CMake;
* amk - AutoMake * *amk* - AutoMake;
* xcd - Xcode * *xcd* - Xcode;
-no_wprocess - skip generation of derived headers and source files * <i>-no_wprocess</i> option skips generation of derived headers and source files.
Note that this command takes several minutes to complete at the first call. 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). Note that in some cases WOK may fail to update correctly; in such case remove sub-directories drv and .adm and repeat the command. 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). Note that in some cases WOK may fail to update correctly; in such case remove sub-directories *drv* and <i>.adm</i> and repeat the command.
To regenerate derived headers and source files without regeneration of projects use command: To regenerate derived headers and source files without regeneration of projects use command:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
LOC:dev> wokcd occt LOC:dev> wokcd occt
LOC:dev:occt> wprocess -DGroups=Src,Xcpp LOC:dev:occt> wprocess -DGroups=Src,Xcpp
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The generated building project has been placed into $CASROOT/adm folder: The generated building project has been placed into <i>$CASROOT/adm</i> folder:
* for vc8 - $CASROOT/adm/msvc/vc8 * for vc8 - <i>$CASROOT/adm/msvc/vc8</i>;
* for vc9 - $CASROOT/adm/msvc/vc9 * for vc9 - <i>$CASROOT/adm/msvc/vc9</i>;
* for vc10 - $CASROOT/adm/msvc/vc10 * for vc10 - <i>$CASROOT/adm/msvc/vc10</i>;
* for vc11 - $CASROOT/adm/msvc/vc11 * for vc11 - <i>$CASROOT/adm/msvc/vc11</i>;
* for cbp - $CASROOT/adm/\<OS\>/cbp * for cbp - <i>$CASROOT/adm/\<OS\>/cbp</i>;
* for cmake - $CASROOT/adm/cmake * for cmake - <i>$CASROOT/adm/cmake</i>;
* for amk - $CASROOT/adm/lin/amk * for amk - <i>$CASROOT/adm/lin/amk</i>;
* xcd - $CASROOT/adm/\<OS\>/xcd * xcd - <i>$CASROOT/adm/\<OS\>/xcd</i>
@section wok4 Generation of documentation @section wok4 Generation of documentation
Use command wgendoc in WOK to generate reference documentation: Use command *wgendoc* in WOK to generate reference documentation:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
:LOC:dev> wokcd occt :LOC:dev> wokcd occt
:LOC:dev:occt> wgendoc :LOC:dev:occt> wgendoc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following options can be used: The following options can be used:
* -wb=< workbench name > the name of OCCT workbench (the current one by default); * <i>-wb=\<workbench name\></i> 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; * <i>-m=\<list of modules\></i> the list of modules that will be contained in the documentation;
* -outdir=< path > the output directory for the documentation; * <i>-outdir=\<path\></i> the output directory for the documentation;
* -chm the option to generate CHM file; * <i>-chm</i> the option to generate CHM file;
* -hhc=< path > the path to HTML Help Compiler (hhc.exe) or equivalent; * <i>-hhc=\<path\></i> 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; * <i>-qthelp=\<path\></i> the option to generate Qt Help file, where <i>\<path\></i> is the required path to *qthelpgenerator* executable;
* -doxygen=< path > the path to Doxygen executable * <i>-doxygen=\<path\></i> the path to Doxygen executable;
* -dot=< path > the path to GraphViz dot executable * <i>-dot=\<path\></i> the path to GraphViz dot executable.

3
dox/dev_guides/documentation/documentation.md
View File

@ -17,6 +17,9 @@ Version 8.5 or 8.6: http://www.tcl.tk/software/tcltk/download.html
**Doxygen** **Doxygen**
Version 1.8.4 or above: http://www.stack.nl/~dimitri/doxygen/download.html Version 1.8.4 or above: http://www.stack.nl/~dimitri/doxygen/download.html
**Dot**
Part of Graphviz software, used by Doxygen for generation of class diagrams in Reference Manual: http://www.graphviz.org/Download..php
**MiKTeX** or other package providing **pdflatex** command (only needed for generation of PDF documents): http://miktex.org/download **MiKTeX** or other package providing **pdflatex** command (only needed for generation of PDF documents): http://miktex.org/download
**Inkscape** (only needed for generation of PDF documents containing SVG images): http://www.inkscape.org/download **Inkscape** (only needed for generation of PDF documents containing SVG images): http://www.inkscape.org/download

10
dox/dev_guides/wok/wok.md
View File

@ -5,13 +5,11 @@ Workshop Organisation Kit {#occt_dev_guides__wok}
@section occt_wok_0 DEPRECATION WARNING @section occt_wok_0 DEPRECATION WARNING
Please note that this document describes use of WOK as comprehensive Please note that this document describes use of WOK as comprehensive build system. This use is outdated, and WOK is to be removed in one of the future OCCT releases.
build system. This use is outdated, and WOK is to be removed in
one of future releases of OCCT.
Currently only small subset of WOK capabilities described in this document Currently only a small subset of WOK capabilities described in this document
are actually necessary for building OCCT. See @ref occt_dev_guides__building_wok is actually necessary for building OCCT. See @ref occt_dev_guides__building_wok
for more practical guide. for a more practical guide.
@section occt_wok_1_ Introduction Glossary @section occt_wok_1_ Introduction Glossary