Project

General

Profile

Start to build Scol using CMAKE » History » Version 41

lpousse, 10/14/2019 10:27 AM

1 1 arkeon
h1. Start to build Scol using CMAKE
2 1 arkeon
3 1 arkeon
4 20 brainsandwich
h2. Tools
5 1 arkeon
6 20 brainsandwich
h3. Common to all platforms
7 1 arkeon
8 39 lpousse
* "CMake":http://www.cmake.org/download/ (While installing, allow CMake to add the CMake directory to the PATH)
9 39 lpousse
* Visual Studio Community 2015 Update 3
10 20 brainsandwich
* "Tortoise SVN":http://tortoisesvn.net/ (or any SVN client)
11 20 brainsandwich
* "Tortoise git":https://code.google.com/p/tortoisegit/ (or any Git client too)
12 41 lpousse
* "Yasm":https://yasm.tortall.net/Download.html (download the exe version, rename it to "yasm.exe" and add its location to the PATH)
13 41 lpousse
* "Nasm":https://www.nasm.us/ (once installed, add its location to the PATH)
14 1 arkeon
15 1 arkeon
h3. Windows target
16 1 arkeon
17 41 lpousse
* "DirectX9 SDK":https://www.microsoft.com/en-us/download/details.aspx?id=6812
18 1 arkeon
If the installation fails: https://support.microsoft.com/fr-fr/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010
19 39 lpousse
* a Perl installation (such as "Strawberry Perl":http://strawberryperl.com/)
20 39 lpousse
Be careful not to let Perl add paths to c headers and executables to your path as it can mess with your build environnement
21 41 lpousse
* "MSYS2":https://www.msys2.org/ (once installed, launch an msys2.exe and install make with the command "pacman -S make")
22 39 lpousse
23 39 lpousse
The minimum compiler supported is the one in Visual Studio 2015.
24 20 brainsandwich
You can try with a newer version at your own risks !
25 1 arkeon
26 20 brainsandwich
h3. Android target
27 1 arkeon
28 20 brainsandwich
_With standard tools_
29 1 arkeon
30 20 brainsandwich
i.e. free tools found on the web or provided by Google
31 1 arkeon
32 20 brainsandwich
* "Java Development Kit (JDK)":http://www.oracle.com/technetwork/java/javase/downloads
33 20 brainsandwich
* "Android SDK":https://developer.android.com/sdk/installing
34 20 brainsandwich
* "Native Development Kit (NDK)":https://developer.android.com/tools/sdk/ndk
35 20 brainsandwich
* "Apache ANT":http://ant.apache.org/
36 1 arkeon
37 20 brainsandwich
_With Tegra Android Development Pack_
38 10 brainsandwich
39 20 brainsandwich
A package provided by Nvidia to build applications for Android. The download process requires authentication to the Nvidia Developper Network (it's free and not too spammy though)
40 20 brainsandwich
41 20 brainsandwich
* "TADP":https://developer.nvidia.com/gameworksdownload
42 20 brainsandwich
* On setup, let it download everything or at least the tools described in the previous section.
43 1 arkeon
44 20 brainsandwich
_SDK preparation_
45 20 brainsandwich
46 20 brainsandwich
You should launch the SDK to download other tools like emulators for each API you want to target.
47 39 lpousse
(Our target API is 19 so you can get any emulator above).
48 20 brainsandwich
49 20 brainsandwich
h3. Linux target
50 20 brainsandwich
51 30 arkeon
TODO.
52 20 brainsandwich
53 20 brainsandwich
h3. Mac OS target
54 20 brainsandwich
55 31 arkeon
TODO.
56 20 brainsandwich
57 7 brainsandwich
h2. Get the Scol sources
58 1 arkeon
59 20 brainsandwich
Scol uses Subversion for source control and you can use your SVN client to get the source code.
60 6 arkeon
61 1 arkeon
So first retrieve the sources from "https://svn.scolring.org/trunk/", accept the certificate and go take some coffee.
62 1 arkeon
The source directories contains most of the dependencies, and since some of them are modified they are provided in the sources.
63 7 brainsandwich
64 20 brainsandwich
Some sources like curl use Git as source control and are downloaded when building, so make sure it's installed before building the project
65 7 brainsandwich
66 20 brainsandwich
67 20 brainsandwich
68 1 arkeon
h2. Dependencies search paths
69 8 brainsandwich
70 1 arkeon
h3. Windows
71 1 arkeon
72 1 arkeon
Once you get the sources, you can execute "setWindowsSearchPaths.bat" in the dependencies directory.
73 1 arkeon
!!WARNING!! when you execute the bat file using the mouse the current directory is wrong.
74 1 arkeon
You need to start a DOS command line "cmd.exe" as administrator and go to the dependencies directory to start the bat file manually.
75 1 arkeon
 
76 1 arkeon
This will add needed environment variables and paths.
77 1 arkeon
78 40 lpousse
Additionally, you need to add the folders where you installed Nasm and Yasm to your Path environment variable
79 40 lpousse
80 1 arkeon
h3. Android
81 1 arkeon
82 20 brainsandwich
If you downloaded the TADP, the following variables are likely to be defined already (or they should look alike).
83 20 brainsandwich
If not, add these to the environment variables
84 1 arkeon
* ANDROID_HOME : path/to/sdk
85 1 arkeon
* ANDROID_SDK_HOME : path/to/sdk
86 1 arkeon
* ANDROID_SDK : path/to/sdk
87 1 arkeon
* ANDROID_NDK : path/to/ndk
88 1 arkeon
* ANT_HOME : path/to/ant
89 7 brainsandwich
* JAVA_HOME : path/to/jdk -- should be something like "C:\Progra~1\Java\<jdkfolder>"
90 1 arkeon
* CMAKE : path/to/cmake
91 7 brainsandwich
92 20 brainsandwich
Then you should add these variables into the PATH:
93 1 arkeon
94 20 brainsandwich
@%ANDROID_NDK%;%ANT_HOME%\bin;%ANDROID_SDK%\tools;%ANDROID_SDK%\platform-tools;%CMAKE%;%JAVA_HOME%\bin;@
95 1 arkeon
96 36 arkeon
97 36 arkeon
98 1 arkeon
99 36 arkeon
h2. Build needed dependencies
100 36 arkeon
101 32 arkeon
h3. From Windows, for Windows
102 1 arkeon
103 40 lpousse
The following instructions are written to compile for 32 bits Windows. To compile for 64 bits Windows, use the 64 bits toolchain for each CMake configuration, and replace every instance of "x86" by "x64" in the instructions below.
104 39 lpousse
105 1 arkeon
Launch cmake-gui from a Visual Studio command line (it configures the environment so you can build things correctly)
106 22 hector
# Specify the source folder to trunk/dependencies and the build to trunk/dependencies/build/windows/x86
107 40 lpousse
# Hit Configure. In the message box, select your Visual Studio version as generator, and select "Specify toolchain file for cross-compiling". On the next screen, select trunk/dependencies/CMake/toolchain/win32.toolchain.cmake as the toolchain (for 64 bits, select the 64 bits variant of your VS version, and select trunk/dependencies/CMake/toolchain/win64.toolchain.cmake as the toolchain). This first configure will take a long time since it will download and compile some of the basic dependencies (probably about an hour depending on the power.
108 1 arkeon
109 1 arkeon
You will see a list of categories, under which are variables to tweak build parameters.
110 1 arkeon
The category SCOLDEPS contains CMake variables that enable/disable the build of individual SCOL dependencies.
111 1 arkeon
Some of these dependencies depend on one or several others. Since CMake needs to detect these "sub-dependencies" when configuring,
112 21 hector
we need to make several build passes, in order to build said "sub-dependencies" before the dependencies that depend on them.
113 21 hector
114 21 hector
# Leave all variables at their default values.
115 21 hector
# Keep hitting Configure until no variables are highlighted in red.
116 1 arkeon
# Hit Generate to generate a Visual Studio project.
117 1 arkeon
# Build the project in Visual Studio (Build->Batch Build, check debug and release for "INSTALL" configuration).
118 39 lpousse
# When the build is done, in CMake, check HYDRAX and SKYX under SCOLDEPS (leave the other variables as they are).
119 21 hector
# Hit Configure again. When configuring is done, you will see new variables appear in red. Leave them at their default values.
120 1 arkeon
# Repeat steps 2 to 4.
121 1 arkeon
# HYDRAX / SKYX build might fail due to header conflicts. To solve them, in Visual Studio :
122 1 arkeon
## In the solution explorer, open the properties of the *RenderSystem_Direct3D11* project.
123 1 arkeon
## In the properties window, Select *All configurations*.
124 25 hector
## Under *Configuration Properties* > *C/C++* > *General*, modify the *Other include directories* entry.
125 39 lpousse
## In the directories list, move the directory at the bottom all the way to the top.
126 38 aurelio
## Save the changes.
127 39 lpousse
## Repeat the same steps for the *RenderSystem_Direct3D9* project.
128 39 lpousse
## Re-run the build.
129 39 lpousse
# Optionnal: Check SCOLDEPS_BUILD_TUIO and SCOLDEPS_BUILD_TUIO, hit configure and repeat steps 2 to 4.
130 39 lpousse
131 26 hector
Now every required dependency should be built. The ones that we left unchecked aren't needed.
132 26 hector
133 26 hector
h3. From Windows, for Android
134 26 hector
135 39 lpousse
Supported ABIs : armeabi-v7a, arm64-v8a, x86, x86_64
136 39 lpousse
Android API version : 19 (21 for 64 bits ABIs)
137 39 lpousse
138 7 brainsandwich
Do the same as for Windows target, but
139 39 lpousse
* If you did not already make a Windows build, run trunk/dependencies/boost/bootstrap.bat from a Visual Studio command line
140 20 brainsandwich
* Set source folder to trunk/dependencies and build folder to trunk/scol/build/android/<target ABI> (More generally, replace every instance of "windows/x86" in the build and install paths by "android/<target ABI>")
141 39 lpousse
* Specify the generator : "NMake"
142 39 lpousse
* The toolchain for crosscompile : trunk/dependencies/CMake/toolchain/android.<target ABI>.toolchain.cmake
143 39 lpousse
* When building the Scol dependencies uncheck CAUDIO_ENABLE_REROUTE_STL_ALLOCATIONS
144 39 lpousse
* Build dependencies with "nmake install" command from a Visual Studio command line.
145 13 brainsandwich
146 13 brainsandwich
147 19 brainsandwich
148 20 brainsandwich
149 1 arkeon
h2. Build the Scol project
150 19 brainsandwich
151 13 brainsandwich
As for the dependencies:
152 20 brainsandwich
153 13 brainsandwich
h3. Windows target
154 20 brainsandwich
155 3 arkeon
* Set source folder to trunk/scol and build folder to trunk/scol/build/windows/x86
156 40 lpousse
* Hit configure and provide the toolchain, the same as for the dependencies
157 40 lpousse
* Generate and build from Visual Studio
158 20 brainsandwich
159 20 brainsandwich
h3. Android target
160 20 brainsandwich
161 20 brainsandwich
* Set source folder to trunk/scol and build folder to trunk/scol/build/android/<target abi>
162 20 brainsandwich
* If you're using Nsight with Visual Studio (TADP), some build paramaters should be modified for each build if you want to install and test the project on a device :
163 20 brainsandwich
  - Open ScolLauncher subproject -> properties
164 20 brainsandwich
  - Configuration Properties -> General -> Configuration Type -> Make Application (ndk-build -> .apk|.so|.a)
165 20 brainsandwich
  - Configuration Properties -> Deployment -> Fast Deploy -> No
166 20 brainsandwich
  - Configuration Properties -> Ant Build -> Skip Ant Step -> No
167 20 brainsandwich
* Without TADP, after it's build, go to trunk/scol/build/android/<target abi>/App/bin, and run "ant debug install" if you wish to install the project on an emulator or your device  
168 1 arkeon
169 1 arkeon
h1. Start your new plugin
170 1 arkeon
171 1 arkeon
h2. Source paths
172 1 arkeon
173 1 arkeon
Start by creating a directory with your new plugin name in the trunk/scol/plugins folder.
174 1 arkeon
For example trunk/scol/plugins/myPlugin
175 4 arkeon
176 4 arkeon
Usually we prefer to separate the sources and the includes.
177 1 arkeon
So creates a "src" and "include" directory in your plugin folder.
178 1 arkeon
179 1 arkeon
Creates the empty files you will need for your project, usually :
180 1 arkeon
- include/myplugin.h for your classes declaration
181 1 arkeon
- src/myplugin.cpp for your classes definition
182 1 arkeon
- src/scolplugin.cpp for the Scol binding functions
183 1 arkeon
184 1 arkeon
h2. Dependencies
185 1 arkeon
186 1 arkeon
If your project need an external SDK or dependencies, add then in the trunk/dependencies directory.
187 1 arkeon
Then create a findMydepname.cmake file in trunk\scol\CMake\Packages.
188 1 arkeon
You can copy and change an existing Find.cmake file to make yours.
189 1 arkeon
Start from a simple one like FindMyo.cmake for example.
190 1 arkeon
191 1 arkeon
h2. Cmake files
192 1 arkeon
193 1 arkeon
It's time to creates the CMAKE script for your plugin.
194 1 arkeon
195 1 arkeon
Create a "CMakeLists.txt" file in the plugin directory.
196 1 arkeon
trunk/scol/plugins/myPlugin/CMakeLists.txt
197 1 arkeon
198 1 arkeon
And edit the file with a text editor.
199 1 arkeon
200 1 arkeon
<pre>
201 1 arkeon
#-------------------------------------------------------------------
202 1 arkeon
# This file is part of the CMake build system for Scol
203 1 arkeon
#
204 1 arkeon
# The contents of this file are placed in the public domain. Feel
205 1 arkeon
# free to make use of it in any way you like.
206 1 arkeon
#-------------------------------------------------------------------
207 1 arkeon
208 1 arkeon
############################################################
209 1 arkeon
# CmakeList file for Myplugin
210 1 arkeon
############################################################
211 1 arkeon
212 1 arkeon
#Your project name
213 1 arkeon
PROJECT(myPLugin)
214 1 arkeon
215 1 arkeon
# define header and source files for the library
216 1 arkeon
set (MYPLUGIN_HEADER_FILES
217 1 arkeon
  include/myplugin.h
218 1 arkeon
)
219 1 arkeon
220 1 arkeon
set (MYPLUGIN_SOURCE_FILES
221 1 arkeon
  src/myplugin.cpp
222 1 arkeon
  src/scolplugin.cpp
223 1 arkeon
)
224 1 arkeon
225 1 arkeon
# Add includes directories from dependencies
226 1 arkeon
#  include_directories(include ${MYDEP_INCLUDE_DIRS})
227 1 arkeon
228 1 arkeon
# Add definition for P4 optimizations, warnings removal.
229 1 arkeon
add_definitions(-DOPTI_P4 -D_CRT_SECURE_NO_WARNINGS -D)
230 1 arkeon
231 1 arkeon
# Add dependencies libraries
232 1 arkeon
#  set(LIBRARIES
233 1 arkeon
#    ${MYDEP_LIBRARIES}
234 1 arkeon
#    ${ZLIB_LIBRARIES}
235 1 arkeon
#    ${PNG_LIBRARIES}
236 1 arkeon
#  )
237 1 arkeon
238 1 arkeon
# setup Scol plugin target
239 1 arkeon
add_library(myPLugin
240 1 arkeon
  ${Scol_LIB_TYPE}
241 1 arkeon
  ${MYPLUGIN_HEADER_FILES}
242 1 arkeon
  ${MYPLUGIN_SOURCE_FILES}
243 1 arkeon
)
244 1 arkeon
add_dependencies(myPLugin kernel)
245 1 arkeon
246 1 arkeon
# set the dll version.
247 1 arkeon
set_target_properties(myPLugin PROPERTIES VERSION ${Scol_VERSION} SOVERSION ${Scol_VERSION_MAJOR})
248 1 arkeon
target_link_libraries(myPLugin ${LIBRARIES})
249 1 arkeon
250 1 arkeon
# install Scol
251 1 arkeon
scol_config_plugin(myPLugin)
252 1 arkeon
install(FILES ${MYPLUGIN_HEADER_FILES} DESTINATION include/SCOL/plugins/myPLugin)
253 1 arkeon
</pre>
254 1 arkeon
255 1 arkeon
Now we need to declare this new plugin in the common Scol cmake files.
256 1 arkeon
Edit the trunk/scol/CMakeLists.txt file and add your plugin definition like the following.
257 1 arkeon
258 1 arkeon
If you don't have dependencies.
259 1 arkeon
<pre>
260 1 arkeon
option(Scol_BUILD_MYPLUGIN "Build myPluginplugin, my library" TRUE)
261 1 arkeon
</pre>
262 1 arkeon
263 1 arkeon
If you have depencies
264 1 arkeon
<pre>
265 1 arkeon
cmake_dependent_option(Scol_BUILD_MYPLUGIN "Build myPlugin, my library." TRUE "MYDEP_FOUND;ZLIB_FOUND;PNG_FOUND" FALSE)
266 1 arkeon
</pre>
267 1 arkeon
268 1 arkeon
Now edit the trunk/scol/plugin/CMakeLists.txt file and add the following.
269 1 arkeon
<pre>
270 1 arkeon
# Configure myPlugin plugin build
271 1 arkeon
if (Scol_BUILD_MYPLUGIN)
272 1 arkeon
  add_subdirectory(myPlugin)
273 1 arkeon
endif ()
274 1 arkeon
</pre>
275 1 arkeon
276 1 arkeon
Only if you have dependencies, edit the trunk/scol/CMake/ScolDependencies.cmake file and add the dependencies resolution as the following
277 1 arkeon
278 1 arkeon
<pre>
279 1 arkeon
# Find MyDep
280 1 arkeon
find_package(MYDEP)
281 1 arkeon
macro_log_feature(MYDEP_FOUND "Mydep" "MydepLibrary" "http://Mydep.org/" FALSE "" "")
282 1 arkeon
</pre>
283 1 arkeon
284 1 arkeon
h2. Almost done
285 1 arkeon
286 1 arkeon
Open the CMAKE-gui again.
287 1 arkeon
Hit the "Configure button" and check if you found your plugin in the scol group.
288 1 arkeon
Then hit the generate button, and open the scol.sln project again.
289 1 arkeon
290 1 arkeon
You should have the project added in Visual Studio.