0022859: Developers guide with code samples
[occt.git] / dox / dev_guides / building / cmake / cmake.md
1 Building with CMake {#occt_dev_guides__building_cmake}
2 ===================
3
4 @tableofcontents
5
6 This file describes the steps to build OCCT libraries from a complete source package
7 with **CMake**. CMake is free software that can create GNU Makefiles, KDevelop, 
8 XCode, Eclipse and Visual Studio project files. **CMake** version 3.0 or above is 
9 required.
10
11 If you build OCCT from bare sources (as in Git repository) or make some 
12 changes affecting CDL files, you need to use WOK to re-generate header files
13 and build scripts / projects. See \ref occt_dev_guides__building_wok for instructions.
14
15 Before building OCCT, you need to install the required third-party libraries; see the
16 instructions for your platform in @ref occt_dev_guides__building.
17
18 ## Define the location of build and install directories.
19
20 The build directory is where intermediate files (projects / makefiles, objects, binaries) will be created. Each built configuration should have its own build directory.
21
22 The install directory is where binaries will be installed after build, along with header files and resources required for OCCT use in applications. 
23 It is possible to install several configurations of OCCT (differentiated by platform, bitness, compiler, and build type) into the same directory.
24
25 It is recommended to separate build and install directories from OCCT source directory, for example:
26
27        /user/home/occt/                           - sources
28        /user/home/tmp/occt-build-vc10-x64-release - intermediate files
29        /user/home/occt-install                    - installed binaries
30
31 ## CMake usage
32
33 Run CMake indicating the path to OCCT sources <i>($CASROOT)</i> and selected build directory.
34
35 It is recommended to use GUI tools provided by CMake: *cmake-gui* on Windows, Mac and Linux (*ccmake* also can be used on Linux).
36
37 ### Windows:
38
39 Specify the root folder of OCCT (<i>$CASROOT</i>, which contains *CMakelists.txt* file) by clicking **Browse Source**.
40
41 @figure{/dev_guides/building/cmake/images/cmake_image001.png}
42
43 Specify the location (build folder) for Cmake generated project files by clicking **Browse Build**.
44
45 Each configuration of the project should be built in its own directory. When building multiple configurations it is recommended to indicate in the name of build directories the system, bitness, compiler, and build type (e.g., <i>d:/occt/build/win32-vc9-debug</i> ).
46
47 **Configure** opens the window with a drop-down list of generators supported by CMake project. Select the required generator (e.g., Visual Studio 2008) and click **Finish**.
48
49 @figure{/dev_guides/building/cmake/images/cmake_image002.png}
50
51 ### Linux (ccmake variant):
52
53 In the console, change to the build directory and call *ccmake* with the path to the source directory of the project:
54
55        > cd ~/occt/build/debug
56        > ccmake ~/occt
57
58 @figure{/dev_guides/building/cmake/images/cmake_image003.png}
59
60 Press *c* to configure.
61
62 *cmake-gui* is used in the same way as described above for Windows.
63
64 ### Mac OS:
65
66 Use *cmake-gui* **Applications -> CMake 2.8-10.app** to generate project files for the chosen build environment (e.g., XCode).
67
68 @figure{/dev_guides/building/cmake/images/cmake_image004.png}
69
70 ## OCCT Configuration
71
72 The error message, which appears at the end of configuration process, informs you about the required variables, 
73 which need to be defined. This error will appear until all required variables are defined correctly.
74
75 Note: In *cmake-gui* there is "grouped" option, which groups variables with a common prefix.
76
77 ### Selection of the components to be built
78
79 The variables with <i>BUILD_</i> prefix allow specifying OCCT components and
80 configuration to be built:
81
82 * *BUILD_CONFIGURATION* - defines configuration to be built (Release by default).
83 * <i>BUILD_<MODULE></i>      - specifies whether the corresponding OCCT module should be 
84                         built (all toolkits). Note that even if the whole module is not 
85                         selected for build, its toolkits used by other toolkits 
86                         selected for build will be included automatically.
87 * *BUILD_TOOLKITS*      - allows including additional toolkits from non-selected 
88                         modules (should be list of toolkit names separated by a 
89                         space or a semicolon).
90 * *BUILD_SAMPLES*       - specifies whether OCCT MFC samples should be built.
91 * *BUILD_PATCH_DIR*     - optionally specifies additional folder containing patched OCCT source files.
92                         The patch may contain arbitrary subset of OCCT source files (including CMake scripts, templates, etc.), organized in the same structure of folders as OCCT.
93                         The projects generated by CMake will use files found in the patch folder instead of the corresponding files of OCCT.
94
95 Check variables with <i>USE_</i> prefix (<i>USE_FREEIMAGE, USE_GL2PS, USE_TBB,</i> and 
96 <i>USE_OPENCL</i>) if you want to enable use of the corresponding optional 3rd-party 
97 library.
98
99 ### 3rd-party configuration (The variables with <i>3RDPARTY_</i> prefix)
100
101 If you have 3rd-party libraries in a non-default location 
102 (e.g., on Windows, binaries downloaded from http://www.opencascade.org/getocc/download/3rdparty/") 
103 *3RDPARTY_DIR* variable should be specified with the path to the folders where required 3rd-party libraries will be sought
104
105 The results of search for 3rd-party directories will be stored in *3RDPARTY_\<LIBRARY\>_DIR* variables. If *3RDPARTY_DIR* directory is defined, required libraries are sought in *3RDPARTY_DIR* location.
106
107 The procedure expects to find binary and header files of each 3rd-party library in its own sub-directory: *bin*, *lib* and *include*.
108
109 Press **Configure** (**c** key for ccmake).
110
111 The result of the search are recorded in the corresponding variables:
112
113 * *3RDPARTY_\<PRODUCT\>_DIR* - path to the 3rdparty directory (with directory name) (e.g. <i>D:/3rdparty/tcltk-86-32</i>)
114 * *3RDPARTY_\<PRODUCT\>_LIBRARY_DIR* - path to directory containing a library (e.g. <i>D:/3rdparty/tcltk-86-32/lib</i>). 
115 * *3RDPARTY_\<PRODUCT\>_INCLUDE_DIR* - path to the directory containing a header file (e.g., <i>D:/3rdparty/tcltk-86-32/include</i>)
116 * *3RDPARTY_\<PRODUCT\>_DLL_DIR* - path to the directory containing a shared library (e.g., <i>D:/3rdparty/tcltk-86-32/bin</i>) This variable is able just in windows case
117
118
119 Note: a libraries and include directories should be the children of product directory if the last one is defined.
120
121 The search process is as follows:
122
123 1. Common path: *3RDPARTY_DIR*
124 2. Path to a particular 3rd-party library: *3RDPARTY_\<PRODUCT\>_DIR*
125 3. Paths to headers and binaries:
126    1. *3RDPARTY_\<PRODUCT\>_INCLUDE_DIR*
127    2. *3RDPARTY_\<PRODUCT\>_LIBRARY_DIR*
128    3. *3RDPARTY_\<PRODUCT\>_DLL_DIR*
129
130 If a variable of any level is not defined (empty or <i> \<variable name\>-NOTFOUND </i>) 
131 and the upper level variable is defined, the content of the non-defined variable 
132 will be sought at the next configuration step. If search process at level 3 does not find the required files, it seeks in default places.
133
134 Important: If *BUILD_CONFIGURATION* variable is changed, at the next configuration 
135 *3RDPARTY_ variables* will be replaced by the search process result, except for the *3RDPARTY_DIR* variable.
136
137 **Note** : CMake will produce an error after the configuration step until all required variables are defined correctly.
138 If the search result (include path, or library path, or dll path) does not meet your expectations, 
139 you can  change *3RDPARTY_\<PRODUCT\>_*_DIR variable*, clear (if they are not empty) 
140 *3RDPARTY_\<PRODUCT\>_DLL_DIR, 3RDPARTY_\<PRODUCT\>_INCLUDE_DIR* and 3RDPARTY_\<PRODUCT\>_LIBRARY_DIR variables 
141 (or clear one of them) and run the configuration process again. 
142
143 At this time the search will be performed in the newly identified directory 
144 and the result will be recorded to corresponding variables (replace old value if it is necessary).
145
146 For example, (Linux case) *3RDPARTY_FREETYPE_DIR* variable 
147
148     /PRODUCTS/maintenance/Mandriva2010/freetype-2.4.10
149
150 can be changed to 
151
152     /PRODUCTS/maintenance/Mandriva2010/freetype-2.5.3
153
154 During the configuration process and the related variables (*3RDPARTY_FREETYPE_DLL_DIR*, *3RDPARTY_FREETYPE_INCLUDE_DIR* and *3RDPARTY_FREETYPE_LIBRARY_DIR*) will be filled with new found values
155
156 **Note**: The names of searched libraries and header files are hard-coded. If there is the need to change their names,
157 change appropriate cmake variables (edit CMakeCache.txt file or edit in cmake-gui in advance mode) without reconfiguration: *3RDPARTY_\<PRODUCT\>_INCLUDE* for include, *3RDPARTY_\<PRODUCT\>_LIB* for library and *3RDPARTY_\<PRODUCT\>_DLL* for shared library.
158
159 ###The variables with INSTALL_ prefix:
160
161 Define *INSTALL_DIR* variable as the path will be contain the built OCCT files (libraries, executables and headers)
162 If <i>INSTALL_\<PRODUCT\></i> variable is checked, 3rd-party products will be copied to the install directory.
163
164 At the end of the configuration process "configuring done" message will be shown and the generation process can be started.
165
166 ## OCCT Generation
167
168 This procedure will create makefiles or project files for your build system.
169
170 ### Windows
171
172 Click **Generate** button and wait until the generation process is finished. 
173 Then the project files will appear in the build folder (e.g. <i> d:/occt/build/win32-vc9-release </i>). 
174
175 ### Linux
176
177 Click **Generate** button (if you use cmake-gui) or press **g** (for ccmake) to start the generation process.
178
179 ### Mac OS X
180
181 Click **Generate** button and wait until the generation process is finished. 
182 Then the project files will appear in the build folder (e.g. <i> /Developer/occt/build/XCode </i>).
183
184 ## OCCT Building
185
186 The install folder contains the scripts to run *DRAWEXE* (*draw.bat* or *draw.sh*) and samples (if its were built; (see below **MFC samples**)); the directory structure is follow:
187 * **data**    - data files for OCCT (brep, iges, stp)
188 * **inc**     - header files
189 * **samples** - tcl sample files
190 * **src**     - all required source files for OCCT
191 * **tests**   - OCCT test suite
192 * **win32/vc10/bind**> - example relative directory tree of binary files (3rdparty and occt)
193 * **win32/vc9/lib**>   - example relative directory tree of libraries (3rdparty and occt)
194
195 ### Windows (Visual studio)
196
197 Go to the build folder, start the Visual Studio solution *OCCT.sln* and build it by clicking **Build -> Build Solution**.
198
199 When the building process is finished, build the *INSTALL* project (by default the build solution process skips the building of the INSTALL project) to move the above files to *INSTALL_DIR*. 
200
201 For this, right-click on the *INSTALL* project and select **Project Only -> Build Only** -> *INSTALL* in the solution explorer. 
202
203 ### Linux (make)
204
205 Change directory to the directory with binaries and run *make* command
206
207        > make 
208
209 To copy all libraries, executables and chosen 3rd-party libraries run *make* command with *install* argument
210
211        > make install
212
213 This command will move the above files to *INSTALL_DIR*.
214
215 ### Mac OS X (XCode)
216
217 Go to the build folder, start XCode solution *OCCT.xcodeproj* and build it by clicking **Build -> Build**. 
218 Please notice that XCode may lag because it processes sources at the first start.
219
220 When the building process has finished, build the *INSTALL* project (by default the build solution process skips the building of *INSTALL* project) to move the above files to *INSTALL_DIR*. 
221 Notice that *env.sh* (which configures *PATH* and *DYLD_LIBRARY_PATH* environment variables 
222 as well as Draw Harness extra variables) and *draw.sh* (to launch *DRAWEXE* ) will be created in the target directory. 
223
224 ### MFC samples
225
226 On Windows you can also build binaries of MFC samples together with OCCT. For this, activate **BUILD_Samples** check-box in CMake configuration dialog.
227
228 @figure{/dev_guides/building/cmake/images/cmake_image007.png}
229
230 Please take into account that MFC sample binaries will be installed  in the same folder as OCCT binaries during building of *INSTALL* project.
231 To run an MFC sample use *sample.bat* launcher. The command format is: <i>sample.bat *SampleName*</i> (e.g. <i>sample.bat ImportExport</i>).