README.md

   1 # AGL CMake template
   2
   3 Files used to build an application, or binding, project with the
   4 AGL Application Framework.
   5
   6 To build your AGL project using these templates, you have to install
   7 them within your project and adjust compilation option in `config.cmake`.
   8 For technical reasons, you also have to specify **cmake** target in
   9 sub CMakeLists.txt installed. Make a globbing search to find source files
  10 isn't recommended now to handle project build especially in a multiuser
  11 project because CMake will not be aware of new or removed source files.
  12
  13 You'll find usage samples here:
  14
  15 - [helloworld-service](https://github.com/iotbzh/helloworld-service)
  16 - [low-level-can-service](https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service)
  17 - [high-level-viwi-service](https://github.com/iotbzh/high-level-viwi-service)
  18 - [audio-binding](https://github.com/iotbzh/audio-binding)
  19 - [unicens2-binding](https://github.com/iotbzh/unicens2-binding)
  20
  21 ## Quickstart
  22
  23 ### Initialization
  24
  25 To use these templates files on your project just install the reference files using
  26 **git submodule** then use `config.cmake` file to configure your project specificities :
  27
  28 ```bash
  29 git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templatesconf.d/app-templates conf.d/app-templates
  30 mkdir conf.d/cmake
  31 cp conf.d/app-templates/cmake/config.cmake.sample conf.d/cmake/config.cmake
  32 ```
  33
  34 Edit the copied config.cmake file to fit your needs.
  35
  36 Now, create your top CMakeLists.txt file which include `config.cmake` file.
  37
  38 An example is available in **app-templates** submodule that you can copy and
  39 use:
  40
  41 ```bash
  42 cp conf.d/app-templates/cmake/CMakeLists.txt CMakeLists.txt
  43 ```
  44
  45 ### Create your CMake targets
  46
  47 For each target part of your project, you need to use ***PROJECT_TARGET_ADD***
  48 to include this target to your project.
  49
  50 Using it, make available the cmake variable ***TARGET_NAME*** until the next
  51 ***PROJECT_TARGET_ADD*** is invoked with a new target name.
  52
  53 So, typical usage defining a target is:
  54
  55 ```cmake
  56 PROJECT_TARGET_ADD(SuperExampleName) --> Adding target to your project
  57
  58 add_executable/add_library(${TARGET_NAME}.... --> defining your target sources
  59
  60 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
  61 for macros usage
  62
  63 INSTALL(TARGETS ${TARGET_NAME}....
  64 ```
  65
  66 ### Targets PROPERTIES
  67
  68 You should set properties on your targets that will be used to package your
  69 apps in a widget file that could be installed on an AGL system.
  70
  71 Specify what is the type of your targets that you want to be included in the
  72 widget package with the property **LABELS**:
  73
  74 Choose between:
  75
  76 - **BINDING**: Shared library that be loaded by the AGL Application Framework
  77 - **HTDOCS**: Root directory of a web app
  78 - **DATA**: Resources used by your application
  79 - **EXECUTABLE**: Entry point of your application executed by the AGL
  80  Application Framework
  81
  82 ```cmake
  83 SET_TARGET_PROPERTIES(${TARGET_NAME}
  84         PREFIX "afb-"
  85         LABELS "BINDING"
  86         OUTPUT_NAME "file_output_name")
  87 ```
  88
  89 > **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
  90 > stand for **Application Framework Binding**.
  91
  92 ## More details: Typical project architecture
  93
  94 A typical project architecture would be :
  95
  96 ```tree
  97 <project-root-path>
  98 │
  99 ├── conf.d/
 100 │   ├── autobuild/
 101 │   │   ├── agl
 102 │   │   │   └── autobuild
 103 │   │   ├── linux
 104 │   │   │   └── autobuild
 105 │   │   └── windows
 106 │   │       └── autobuild
 107 │   ├── app-templates/
 108 │   │   ├── README.md
 109 │   │   ├── autobuild/
 110 │   │   │   ├── agl
 111 │   │   │   │   └── autobuild.in
 112 │   │   │   ├── linux
 113 │   │   │   │   └── autobuild.in
 114 │   │   │   └── windows
 115 │   │   │       └── autobuild.in
 116 │   │   ├── cmake/
 117 │   │   │   ├── config.cmake.sample
 118 │   │   │   ├── export.map
 119 │   │   │   └── macros.cmake
 120 │   │   ├── deb/
 121 │   │   │   └── config.deb.in
 122 │   │   ├── rpm/
 123 │   │   │   └── config.spec.in
 124 │   │   └── wgt/
 125 │   │       ├── config.xml.in
 126 │   │       ├── config.xml.in.sample
 127 │   │       ├── icon-default.png
 128 │   │       ├── icon-html5.png
 129 │   │       ├── icon-native.png
 130 │   │       ├── icon-qml.png
 131 │   │       └── icon-service.png
 132 │   ├── packaging/
 133 │   │   ├── config.spec
 134 │   │   └── config.deb
 135 │   ├── cmake
 136 │   │   └── config.cmake
 137 │   └── wgt
 138 │      └── config.xml.in
 139 ├── <libs>
 140 ├── <target>
 141 │   └── <files>
 142 ├── <target>
 143 │   └── <file>
 144 └── <target>
 145     └── <files>
 146 ```
 147
 148 | # | Parent | Description |
 149 | - | -------| ----------- |
 150 | \<root-path\> | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. |
 151 | conf.d | \<root-path\> | Holds needed files to build, install, debug, package an AGL app project |
 152 | app-templates | conf.d | Git submodule to app-templates AGL repository which provides CMake helpers macros library, and build scripts. config.cmake is a copy of config.cmake.sample configured for the projects. SHOULD NOT BE MODIFIED MANUALLY !|
 153 | autobuild | conf.d | Scripts generated from app-templates to build packages the same way for differents platforms.|
 154 | cmake | conf.d | Contains at least config.cmake file modified from the sample provided in app-templates submodule. |
 155 | wgt | conf.d | Contains at least config.xml.in template file modified from the sample provided in app-templates submodule for the needs of project (See config.xml.in.sample file for more details). |
 156 | packaging | conf.d | Contains output files used to build packages. |
 157 | \<libs\> | \<root-path\> | External dependencies libraries. This isn't to be used to include header file but build and link statically specifics libraries. | Library sources files. Can be a decompressed library archive file or project fork. |
 158 | \<target\> | \<root-path\> | A target to build, typically library, executable, etc. |
 159
 160 ### Update app-templates submodule
 161
 162 You may have some news bug fixes or features available from app-templates
 163 repository that you want. To update your submodule proceed like the following:
 164
 165 ```bash
 166 git submodule update --remote
 167 git commit -s conf.d/app-templates
 168 ```
 169
 170 This will update the submodule to the HEAD of master branch repository.
 171
 172 You could just want to update at a specified repository tag or branch or commit
 173 , here are the method to do so:
 174
 175 ```bash
 176 cd conf.d/app-templates
 177 # Choose one of the following depending what you want
 178 git checkout <tag_name>
 179 git checkout --detach <branch_name>
 180 git checkout --detach <commit_id>
 181 # Then commit
 182 cd ../..
 183 git commit -s conf.d/app-templates
 184 ```
 185
 186 ### Build a widget
 187
 188 #### config.xml.in file
 189
 190 To build a widget you need a _config.xml_ file describing what is your apps and
 191 how Application Framework would launch it. This repo provide a simple default
 192 file _config.xml.in_ that should work for simple application without
 193 interactions with others bindings.
 194
 195 It is recommanded that you use the sample one which is more complete. You can
 196 find it at the same location under the name _config.xml.in.sample_ (stunning
 197 isn't it). Just copy the sample file to your _conf.d/wgt_ directory and name it
 198 _config.xml.in_, then edit it to fit your needs.
 199
 200 > ***CAUTION*** : The default file is only meant to be use for a
 201 > simple widget app, more complicated ones which needed to export
 202 > their api, or ship several app in one widget need to use the provided
 203 > _config.xml.in.sample_ which had all new Application Framework
 204 > features explained and examples.
 205
 206 #### Using cmake template macros
 207
 208 To leverage all cmake templates features, you have to specify ***properties***
 209 on your targets. Some macros will not works without specifying which is the
 210 target type.
 211
 212 As the type is not always specified for some custom targets, like an ***HTML5***
 213 application, macros make the difference using ***LABELS*** property.
 214
 215 Choose between:
 216
 217 - **BINDING**: Shared library that be loaded by the AGL Application Framework
 218 - **HTDOCS**: Root directory of a web app
 219 - **DATA**: Resources used by your application
 220 - **EXECUTABLE**: Entry point of your application executed by the AGL
 221  Application Framework
 222
 223 Example:
 224
 225 ```cmake
 226 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
 227                 LABELS "HTDOCS"
 228                 OUTPUT_NAME dist.prod
 229         )
 230 ```
 231
 232 If your target output is not named as the ***TARGET_NAME***, you need to specify
 233 ***OUTPUT_NAME*** property that will be used by the ***populate_widget*** macro.
 234
 235 Use the ***populate_widget*** macro as latest statement of your target
 236 definition. Then at the end of your project definition you should use the macro
 237 ***build_widget*** that make an archive from the populated widget tree using the
 238 `wgtpkg-pack` Application Framework tools.
 239
 240 ## Macro reference
 241
 242 ### PROJECT_TARGET_ADD
 243
 244 Typical usage would be to add the target to your project using macro
 245 `PROJECT_TARGET_ADD` with the name of your target as parameter.
 246
 247 Example:
 248
 249 ```cmake
 250 PROJECT_TARGET_ADD(low-can-demo)
 251 ```
 252
 253 > ***NOTE***: This will make available the variable `${TARGET_NAME}`
 254 > set with the specificied name. This variable will change at the next call
 255 > to this macros.
 256
 257 ### project_subdirs_add
 258
 259 This macro will search in all subfolder any `CMakeLists.txt` file. If found then
 260 it will be added to your project. This could be use in an hybrid application by
 261 example where the binding lay in a sub directory.
 262
 263 Usage :
 264
 265 ```cmake
 266 project_subdirs_add()
 267 ```
 268
 269 You also can specify a globbing pattern as argument to filter which folders
 270 will be looked for.
 271
 272 To filter all directories that begin with a number followed by a dash the
 273 anything:
 274
 275 ```cmake
 276 project_subdirs_add("[0-9]-*")
 277 ```
 278
 279 ## Advanced customization
 280
 281 ### Including additionnals cmake files
 282
 283 Advanced tuning is possible using addionnals cmake files that are included
 284 automatically from some specifics locations. They are included in that order:
 285
 286 - Project CMake files normaly located in _<project-root-path>/conf.d/app-templates/cmake/cmake.d_
 287 - Home CMake files located in _$HOME/.config/app-templates/cmake.d_
 288 - System CMake files located in _/etc/app-templates/cmake.d_
 289
 290 CMake files has to be named using the following convention: `XX-***.cmake`,
 291 where `XX` are numbers, `***` file name (ie. `99-my_customs.cmake`).
 292
 293 So, saying that you should be aware that every normal cmake variables used at
 294 project level could be overwrited by home or system located cmake files if
 295 variables got the same name. Exceptions are cached variables set using
 296 **CACHE** keyword:
 297
 298 Example:
 299
 300 ```cmake
 301 set(VARIABLE_NAME 'value string random' CACHE STRING 'docstring')
 302 ```
 303
 304 ### Include customs templated scripts
 305
 306 As well as for additionnals cmake files you can include your own templated
 307 scripts that will be passed to cmake command `configure_file`.
 308
 309 Just create your own script to the following directories:
 310
 311 - Home location in _$HOME/.config/app-templates/scripts_
 312 - System location in _/etc/app-templates/scripts_
 313
 314 Scripts only needs to use the extension `.in` to be parsed and configured by
 315 CMake command.
 316
 317 ## Autobuild script usage
 318
 319 ### Generation
 320
 321 To be integrated in the Yocto build workflow you have to generate `autobuild`
 322 scripts using _autobuild_ target.
 323
 324 To generate those scripts proceeds:
 325
 326 ```bash
 327 mkdir -p build
 328 cd build
 329 cmake .. && make autobuild
 330 ```
 331
 332 You should see _conf.d/autobuild/agl/autobuild_ file now.
 333
 334 ### Available targets
 335
 336 Here are the available targets available from _autobuild_ scripts:
 337
 338 - **clean** : clean build directory from object file and targets results.
 339 - **distclean** : delete build directory
 340 - **configure** : generate project Makefile from CMakeLists.txt files.
 341 - **build** : compile all project targets.
 342 - **package** : build and output a wgt package.
 343
 344 You can specify variables that modify the behavior of compilation using
 345 the following variables:
 346
 347 - **CONFIGURE_ARGS** : Variable used at **configure** time.
 348 - **BUILD_ARGS** : Variable used at **build** time.
 349 - **DEST** : Directory where to output ***wgt*** file.
 350
 351 Variable as to be in CMake format. (ie: BUILD_ARGS="-DC_FLAGS='-g -O2'")
 352
 353 Usage example:
 354
 355 ```bash
 356 ./conf.d/autobuild/wgt/autobuild package DEST=/tmp
 357 ```