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