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